Source for file swc_archive_content.inc.php

<?php
/* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
SVN Web Control
Copyright ©2006 by sTEFANs
Created on 23.02.2006
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
 
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*/
 
/**
 * Provides user interface for creating, downloading and deleting archives.
 * 
 * @package Swc
 * @subpackage Inc
 * @author Stefan Schraml
 * @copyright Copyright ©2006 by sTEFANs
 * @license http://opensource.org/licenses/lgpl-license.php GNU General Public License
 * @version v1.1.0
 * @since v1.1.0
 */
 
/** Common definitions */
require_once('var.inc.php');
/** ZIP archive creation library */
require_once('zip.inc.php');
/** HTML generation library */
require_once('page.inc.php');
/** Useful routines library */
require_once('utils.inc.php');
 
/** Common filename for spaceball hint file. */
define('SPACEBALL_HINT_FILE', '.spaceball.hints');
/** Section name for revision map section in hint file. */
define('SECTION_REV_MAP', 'Revision map');
    
    /** 
     * Prints the complete content of the archive page
     * including archive creation form and archive list.
     * 
     * @since v1.1.0
     */
    function SwcArchivePrintPage(){
        $config = GetSelectedConfig();
        if ($config == NULL){
            echo '<span class="text_low_bold_red">'.T(TK_DETAILS_DEFAULT_TEXT).'</span><br/>';
            return;
        }
        
        echo '<br/>';
        OpenTable(1, 2, 0, 'result');
            PrintTableCell(T(TK_ARCHIVE_PAGE_TITLE), 'text_low_bold_red');
        NewTableRow();
            SwcArchivePrintCreationFormCell($config);
        NewTableRow();
            SwcArchivePrintFileListCell($config);
        CloseTable();
    }
    
    /** 
     * Prints a cell containing the form to create an archive.
     * @param SwcConfig $config Configuration for the concrete project.
     * @since v1.1.0
     */
    function SwcArchivePrintCreationFormCell($config){            
        $sel_frame = (isset($_POST[IDX_MAIN_FRAME_SRC]) ? $_POST[IDX_MAIN_FRAME_SRC] : '');
        $sel_action = (isset($_POST[IDX_ACTION]) ? $_POST[IDX_ACTION] : '');
        $actions = array(
            array(IDX_MAIN_FRAME_SRC, STD_ARCHIVE_CONTENT), 
            array(IDX_ACTION, ACTION_CREATE_ARCHIVE));
            
        $sel_go_button = strcmp($sel_frame, STD_ARCHIVE_CONTENT) == 0 && strcmp($sel_action, ACTION_CREATE_ARCHIVE) == 0;
        $text = '';
        if(isset($_POST[IDX_ACTION_CREATE_ARCHIVE])){
            $text = $_POST[IDX_ACTION_CREATE_ARCHIVE];
        } else {
            $text = $config->GetProjectName();
            $text .= '_r'.GetWebspaceRevision($config);
            $text = CreateSystemFriendlyString($text);
        }
        
        OpenTableCell();
            OpenTable();
                OpenFormCell($_SESSION[IDX_ROOT_URL]);
                    OpenTable();
                        OpenTableCell('text_low_bold');                                                        
                            PrintFormTextField(T(TK_CTRL_LABEL_CREATE_ARCHIVE), IDX_ACTION_CREATE_ARCHIVE, 50, $text);
                        CloseTableCell();
                        OpenTableCell();
                            PrintFormButton(T(TK_CTRL_ACTION_CREATE_ARCHIVE), $actions, $sel_go_button);
                        CloseTableCell();
                        $hints = array(IDX_REUSE_SESSION, '1');
                        $overwrite_file = (isset($_POST[OPT_OVERWRITE_ARCHIVE]) && $_POST[OPT_OVERWRITE_ARCHIVE]);
                        PrintTableCheckboxCells(T(TK_CTRL_LABEL_OVERWRITE_ARCHIVE), OPT_OVERWRITE_ARCHIVE,
                                                                    $_SESSION[IDX_ROOT_URL], $hints, 'text_low', 
                                                                    'text_low', $overwrite_file, NULL, NULL, true);
                    CloseTable();
                CloseFormCell();
        
        if (isset($_POST[IDX_ACTION]) && $_POST[IDX_ACTION] == ACTION_CREATE_ARCHIVE){
            ob_flush();
            NewTableRow();
                OpenTableCell('text_red', 2);
                    $result_msg = CreateSpaceball($config, $_POST[IDX_ACTION_CREATE_ARCHIVE], $overwrite_file);
                    echo $result_msg;
                CloseTableCell();
        } 
            CloseTable();
        CloseTableCell();
    }    
    
    /** 
     * Prints a cell containing the list of existing archives including
     * file selection.
     * @param SwcConfig $config Configuration for the concrete project.
     * @since v1.1.0
     */
    function SwcArchivePrintFileListCell($config){
        $path = $config->GetSpaceballDir();
        $url = $config->GetSpaceballUrl();
        if (!file_exists($path)){
            mkdir($path, 0777);
        }
        $files = array();
        GetFiles($path, $files, true);
        if (isset($files[IDX_EXEC_RES])){
            PrintTableCell($files[IDX_EXEC_RES], 'text_bold_red');
        } else if (empty($files)){
            PrintTableCell(T(TK_RESULT_NO_SPACEBALLS));
        } else {
            natsort($files);
            $spaceball_hints = parse_ini_file($path.'/'.SPACEBALL_HINT_FILE, true);
            $revision_map = (isset($spaceball_hints[SECTION_REV_MAP]) ? $spaceball_hints[SECTION_REV_MAP] : array());
    
            OpenTableCell();
                OpenTable();
                    PrintTableCell(T(TK_SB_LIST_LABEL_SPACEBALLS), 'text_low_bold');
                    PrintTableCell(T(TK_SB_LIST_LABEL_REVISION), 'text_low_bold');
                    PrintTableCell(T(TK_SB_LIST_LABEL_TIMESTAMP), 'text_low_bold');
                    PrintTableCell(T(TK_SB_LIST_LABEL_FILESIZE), 'text_low_bold');
                    foreach($files as $file){
                            NewTableRow();
                            $abs_path = $path.'/'.$file;
                            $timestamp = filemtime($abs_path);
                            $filetime = GetLocalizedTimestamp($timestamp, true);
                            $filesize = filesize($abs_path);
                            $size_unit_prefix = '';
                            if ($filesize > (10 * 1024 - 1)){
                                $size_unit_prefix = 'k';
                                $filesize /= 1024;
                            }
                            if ($filesize > (10 * 1024 - 1)){
                                $size_unit_prefix = 'M';
                                $filesize /= 1024;
                            }
                            $filesize = number_format($filesize, 0, ',', ' ');
                            $rev = (isset($revision_map[$file]) ? $revision_map[$file] : '?');
                            PrintTableLinkCell($url.'/'.$file, $file, '_blank', 'explicit_link');
                            PrintTableCell('&nbsp;'.$rev, 'text_low');
                            PrintTableCell('&nbsp;'.$filetime, 'text_low');
                            PrintTableCell('&nbsp;'.$filesize.' '.$size_unit_prefix.'B', 'text_low');
                    }
                CloseTable();
            CloseTableCell();
        }
    }    
        
    /** 
     * Creates a file archive of the current webspace called "Spaceball".
     * @param SwcConfig $config Configuration for the concrete project.
     * @param string $file_name Name of the Spaceball file. It is stored within
     *  archive path as set in SwcConfig.
     * @param boolean $overwrite Whether or not an existing Spaceball should
     *  be overwritten.
     * @return string Textual result of the operation.
     * @since v1.1.0
     */
    function CreateSpaceball($config, $file_name, $overwrite){
        $sb_dir = $config->GetSpaceballDir();
        $file_name .= '.zip';
        $spaceball_file = $sb_dir.'/'.$file_name;
        // Check if file exists and can be overwritten
        if (file_exists($spaceball_file)){
            if ($overwrite){
                if (!unlink($spaceball_file)){
                    $msg = T(TK_ERROR_SPACEBALL_EXISTS);
                    return $msg;
                }
            } else {
                $msg = T(TK_ERROR_SPACEBALL_EXISTS_NO_OVERWRITE);
                return $msg;
            }
        }
                
        $webspace = $config->GetWebspaceRootDir();
        $msg = sprintf(T(TK_SB_MSG_SPACEBALL_CREATION_SUCCESSFULL__NAME), $file_name); 
        $file_list = array();
        GetFiles($webspace, $file_list);
        if (count($file_list) == 0){
            $msg = T(TK_ERROR_SPACEBALL_EMPTY_WEBSPACE);
            return $msg;
        }
        
        // Process zip file
        $zip = new zipfile();
        foreach($file_list as $file){
            $path = $webspace.$file;
            // check if it is not an spaceball
            if (strlen($path) < strlen($sb_dir) ||
                    substr_compare($path, $sb_dir, 0, strlen($sb_dir), true) != 0){
                $content = file_get_contents($path);
                $filetime = filemtime($path);
                $zip->addFile($content, $file, $filetime);
            }
        }
        // Save the spaceball and create path if necessary.
        $spaceball = str_replace('\\', '/', $file_name);
        $path = dirname($file_name);
        if (strlen($path) > 1){
            $path = $sb_dir.'/'.$path;
            if (!file_exists($path)){
                if (!mkdir($path)){
                    $msg = T(TK_ERROR_SPACEBALL_GENERAL_ERROR);
                    return $msg;
                }
            }
        }
        if (!$zip->store($spaceball_file)){
            $msg = T(TK_ERROR_SPACEBALL_GENERAL_ERROR);
            return $msg;
        }
        
        // Update revision map
        $revision = GetWebspaceRevision($config);
        $spaceball_hint_file = $sb_dir.'/'.SPACEBALL_HINT_FILE;
        $spaceball_hints = array();
        if (file_exists($spaceball_hint_file)){
            $spaceball_hints = parse_ini_file($spaceball_hint_file, true);
        }
        $spaceball_hints[SECTION_REV_MAP][$file_name] = $revision;
        $hint_content = "; Simple file that contains hints about generated Spaceballs.\n".
                                        "; This file is automatically generated.\n".
                                        "; PLEASE DO NOT EDIT IT MANUALLY!\n\n";    
        foreach($spaceball_hints as $group => $data){
            $hint_content .= '['.$group."]\n";
            foreach($data as $key => $val){
                $hint_content .= $key.' = '.$val."\n";
            }
            $hint_content .= "\n";
        }
        file_put_contents($spaceball_hint_file, $hint_content);    
        return $msg;
    }
    
    /**
     * Returns the files recursively including subdirectory starting with the
     * given path. Hidden files and directories can be ignored,
     * <i>.svn</i> directories are always ignored. If an error occurs,
     * it is returned as only array entry.
     * @param string $path Absolute path of the dirctory to start with.
     * @param array $files Array in which the file structure or
     *  translated error message in index <i>IDX_EXEC_RES</i> is returned.
     * @param string $rel_path Relative path for files, empty per default.
     * @since v1.1.0
     */
    function GetFiles($path, &$files, $ignore_hidden = false, $rel_path = ''){
        clearstatcache();
        if (!file_exists($path)){
            $files[IDX_EXEC_RES] = (T(TK_ERROR_ARCHIVE_DIR_NOT_EXIST__PATH, $path));
            return;
        }
        if (!is_dir($path)){
            $files[IDX_EXEC_RES] = (T(TK_ERROR_ARCHIVE_DIR_IS_FILE_NOT_DIR__PATH, $path));
            return;
        }
        
        $src_dh  = opendir($path);
        $filename = readdir($src_dh);
        while ($filename !== false){
            if ($filename != '.' && $filename != '..' && $filename != '.svn' &&
                    (!$ignore_hidden || strpos($filename, '.') !== 0)){
                if (is_dir($path.'/'.$filename)){
                    GetFiles($path.'/'.$filename, $files, $ignore_hidden, $rel_path.($rel_path != '' ? '/' : '').$filename);                    
                } else {
                    $files[] = $rel_path.($rel_path != '' ? '/' : '').$filename;
                }
            }        
            $filename = readdir($src_dh);        
        }
    }
?>