/common/include/funcs/PEAR/Zip.php

Large files files are truncated, but you can click here to view the full file

<?php
/* vim: set ts=4 sw=4: */
// +----------------------------------------------------------------------+
// | PHP Version 4                                                        |
// +----------------------------------------------------------------------+
// | Copyright (c) 1997-2003 The PHP Group                                |
// +----------------------------------------------------------------------+
// | This library is free software; you can redistribute it and/or        |
// | modify it under the terms of the GNU Lesser General Public           |
// | License as published by the Free Software Foundation; either         |
// | version 2.1 of the License, or (at your option) any later version.   |
// |                                                                      |
// | This library 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    |
// | Lesser General Public License for more details.                      |
// |                                                                      |
// | You should have received a copy of the GNU Lesser General Public     |
// | License along with this library; if not, write to the Free Software  |
// | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,           |
// | MA  02110-1301  USA                                                  |
// +----------------------------------------------------------------------+
// | Author: Vincent Blavet <vincent@phpconcept.net>                      |
// +----------------------------------------------------------------------+
//
// $Id: Zip.php 302924 2010-08-31 14:45:47Z clockwerx $

require_once 'PEAR.php';

// ----- Constants
define('ARCHIVE_ZIP_READ_BLOCK_SIZE', 2048);

// ----- File list separator
define('ARCHIVE_ZIP_SEPARATOR', ',');

// ----- Optional static temporary directory
//       By default temporary files are generated in the script current
//       path.
//       If defined :
//       - MUST BE terminated by a '/'.
//       - MUST be a valid, already created directory
//       Samples :
// define('ARCHIVE_ZIP_TEMPORARY_DIR', '/temp/');
// define('ARCHIVE_ZIP_TEMPORARY_DIR', 'C:/Temp/');
define('ARCHIVE_ZIP_TEMPORARY_DIR', '');

// ----- Error codes
define('ARCHIVE_ZIP_ERR_NO_ERROR', 0);
define('ARCHIVE_ZIP_ERR_WRITE_OPEN_FAIL', -1);
define('ARCHIVE_ZIP_ERR_READ_OPEN_FAIL', -2);
define('ARCHIVE_ZIP_ERR_INVALID_PARAMETER', -3);
define('ARCHIVE_ZIP_ERR_MISSING_FILE', -4);
define('ARCHIVE_ZIP_ERR_FILENAME_TOO_LONG', -5);
define('ARCHIVE_ZIP_ERR_INVALID_ZIP', -6);
define('ARCHIVE_ZIP_ERR_BAD_EXTRACTED_FILE', -7);
define('ARCHIVE_ZIP_ERR_DIR_CREATE_FAIL', -8);
define('ARCHIVE_ZIP_ERR_BAD_EXTENSION', -9);
define('ARCHIVE_ZIP_ERR_BAD_FORMAT', -10);
define('ARCHIVE_ZIP_ERR_DELETE_FILE_FAIL', -11);
define('ARCHIVE_ZIP_ERR_RENAME_FILE_FAIL', -12);
define('ARCHIVE_ZIP_ERR_BAD_CHECKSUM', -13);
define('ARCHIVE_ZIP_ERR_INVALID_ARCHIVE_ZIP', -14);
define('ARCHIVE_ZIP_ERR_MISSING_OPTION_VALUE', -15);
define('ARCHIVE_ZIP_ERR_INVALID_PARAM_VALUE', -16);

// ----- Warning codes
define('ARCHIVE_ZIP_WARN_NO_WARNING', 0);
define('ARCHIVE_ZIP_WARN_FILE_EXIST', 1);

// ----- Methods parameters
define('ARCHIVE_ZIP_PARAM_PATH', 'path');
define('ARCHIVE_ZIP_PARAM_ADD_PATH', 'add_path');
define('ARCHIVE_ZIP_PARAM_REMOVE_PATH', 'remove_path');
define('ARCHIVE_ZIP_PARAM_REMOVE_ALL_PATH', 'remove_all_path');
define('ARCHIVE_ZIP_PARAM_SET_CHMOD', 'set_chmod');
define('ARCHIVE_ZIP_PARAM_EXTRACT_AS_STRING', 'extract_as_string');
define('ARCHIVE_ZIP_PARAM_NO_COMPRESSION', 'no_compression');
define('ARCHIVE_ZIP_PARAM_BY_NAME', 'by_name');
define('ARCHIVE_ZIP_PARAM_BY_INDEX', 'by_index');
define('ARCHIVE_ZIP_PARAM_BY_PREG', 'by_preg');

define('ARCHIVE_ZIP_PARAM_PRE_EXTRACT', 'callback_pre_extract');
define('ARCHIVE_ZIP_PARAM_POST_EXTRACT', 'callback_post_extract');
define('ARCHIVE_ZIP_PARAM_PRE_ADD', 'callback_pre_add');
define('ARCHIVE_ZIP_PARAM_POST_ADD', 'callback_post_add');



/**
* Class for manipulating zip archive files
*
* A class which provided common methods to manipulate ZIP formatted
* archive files.
* It provides creation, extraction, deletion and add features.
*
* @author   Vincent Blavet <vincent@blavet.net>
* @version  $Revision: 302924 $
* @package  Archive_Zip
* @category Archive
*/
class Archive_Zip
{
    /**
     * The filename of the zip archive.
     *
     * @var string Name of the Zip file
     */
    var $_zipname = '';

    /**
     * File descriptor of the opened Zip file.
     *
     * @var int Internal zip file descriptor
     */
    var $_zip_fd = 0;

    /**
     * @var int last error code
     */
    var $_error_code = 1;

    /**
     * @var string Last error description
     */
    var $_error_string = '';

    // {{{ constructor
    /**
     * Archive_Zip Class constructor. This flavour of the constructor only
     * declare a new Archive_Zip object, identifying it by the name of the
     * zip file.
     *
     * @param string $p_zipname The name of the zip archive to create
     *
     * @access public
     */
    function Archive_Zip($p_zipname)
    {

        // ----- Check the zlib
        if (!extension_loaded('zlib')) {
            PEAR::loadExtension('zlib');
        }
        if (!extension_loaded('zlib')) {
            die("The extension 'zlib' couldn't be found.\n".
                "Please make sure your version of PHP was built ".
                "with 'zlib' support.\n");
            return false;
        }

        // ----- Set the attributes
        $this->_zipname = $p_zipname;
        $this->_zip_fd  = 0;

        return;
    }
    // }}}

    // {{{ create()
    /**
     * This method creates a Zip Archive with the filename set with
     * the constructor.
     * The files and directories indicated in $p_filelist
     * are added in the archive.
     * When a directory is in the list, the directory and its content is added
     * in the archive.
     * The methods takes a variable list of parameters in $p_params.
     * The supported parameters for this method are :
     *   'add_path' : Add a path to the archived files.
     *   'remove_path' : Remove the specified 'root' path of the archived files.
     *   'remove_all_path' : Remove all the path of the archived files.
     *   'no_compression' : The archived files will not be compressed.
     *
     *
     * @param mixed $p_filelist The list of the files or folders to add.
     *                             It can be a string with filenames separated
     *                             by a comma, or an array of filenames.
     * @param mixed $p_params   An array of variable parameters and values.
     *
     * @return mixed An array of file description on success,
     *               an error code on error
     */
    function create($p_filelist, $p_params = 0)
    {
        $this->_errorReset();

        // ----- Set default values
        if ($p_params === 0) {
            $p_params = array();
        }
        if ($this->_check_parameters($p_params,
                                     array('no_compression' => false,
                                           'add_path' => "",
                                           'remove_path' => "",
                                           'remove_all_path' => false)) != 1) {
            return 0;
        }

        // ----- Look if the $p_filelist is really an array
        $p_result_list = array();
        if (is_array($p_filelist)) {
            $v_result = $this->_create($p_filelist, $p_result_list, $p_params);
        } else if (is_string($p_filelist)) {
            // ----- Create a list with the elements from the string
            $v_list = explode(ARCHIVE_ZIP_SEPARATOR, $p_filelist);

            $v_result = $this->_create($v_list, $p_result_list, $p_params);
        } else {
            $this->_errorLog(ARCHIVE_ZIP_ERR_INVALID_PARAMETER,
                             'Invalid variable type p_filelist');
            $v_result = ARCHIVE_ZIP_ERR_INVALID_PARAMETER;
        }

        if ($v_result != 1) {
            return 0;
        }

        return $p_result_list;
    }
    // }}}

    // {{{ add()
    /**
     * This method add files or directory in an existing Zip Archive.
     * If the Zip Archive does not exist it is created.
     * The files and directories to add are indicated in $p_filelist.
     * When a directory is in the list, the directory and its content is added
     * in the archive.
     * The methods takes a variable list of parameters in $p_params.
     * The supported parameters for this method are :
     *   'add_path' : Add a path to the archived files.
     *   'remove_path' : Remove the specified 'root' path of the archived files.
     *   'remove_all_path' : Remove all the path of the archived files.
     *   'no_compression' : The archived files will not be compressed.
     *   'callback_pre_add' : A callback function that will be called before
     *                        each entry archiving.
     *   'callback_post_add' : A callback function that will be called after
     *                         each entry archiving.
     *
     * @param mixed $p_filelist The list of the files or folders to add.
     *                               It can be a string with filenames separated
     *                               by a comma, or an array of filenames.
     * @param mixed $p_params   An array of variable parameters and values.
     *
     * @return mixed An array of file description on success,
     *               0 on an unrecoverable failure, an error code is logged.
     * @access public
     */
    function add($p_filelist, $p_params = 0)
    {
        $this->_errorReset();

        // ----- Set default values
        if ($p_params === 0) {
            $p_params = array();
        }
        if ($this->_check_parameters($p_params,
                                     array ('no_compression' => false,
                                            'add_path' => '',
                                            'remove_path' => '',
                                            'remove_all_path' => false,
                                             'callback_pre_add' => '',
                                            'callback_post_add' => '')) != 1) {
            return 0;
        }

        // ----- Look if the $p_filelist is really an array
        $p_result_list = array();
        if (is_array($p_filelist)) {
            // ----- Call the create fct
            $v_result = $this->_add($p_filelist, $p_result_list, $p_params);
        } else if (is_string($p_filelist)) {
            // ----- Create a list with the elements from the string
            $v_list = explode(ARCHIVE_ZIP_SEPARATOR, $p_filelist);

            // ----- Call the create fct
            $v_result = $this->_add($v_list, $p_result_list, $p_params);
        } else {
            $this->_errorLog(ARCHIVE_ZIP_ERR_INVALID_PARAMETER,
                             "add() : Invalid variable type p_filelist");
            $v_result = ARCHIVE_ZIP_ERR_INVALID_PARAMETER;
        }

        if ($v_result != 1) {
            return 0;
        }

        return $p_result_list;
    }
    // }}}

    // {{{ listContent()
    /**
     * This method gives the names and properties of the files and directories
     * which are present in the zip archive.
     * The properties of each entries in the list are :
     *   filename : Name of the file.
     *              For create() or add() it's the filename given by the user.
     *              For an extract() it's the filename of the extracted file.
     *   stored_filename : Name of the file / directory stored in the archive.
     *   size : Size of the stored file.
     *   compressed_size : Size of the file's data compressed in the archive
     *                     (without the zip headers overhead)
     *   mtime : Last known modification date of the file (UNIX timestamp)
     *   comment : Comment associated with the file
     *   folder : true | false (indicates if the entry is a folder)
     *   index : index of the file in the archive (-1 when not available)
     *   status : status of the action on the entry (depending of the action) :
     *            Values are :
     *              ok : OK !
     *              filtered : the file/dir was not extracted (filtered by user)
     *              already_a_directory : the file can't be extracted because a
     *                                    directory with the same name already
     *                                    exists
     *              write_protected : the file can't be extracted because a file
     *                                with the same name already exists and is
     *                                write protected
     *              newer_exist : the file was not extracted because a newer
     *                            file already exists
     *              path_creation_fail : the file is not extracted because the
     *                                   folder does not exists and can't be
     *                                   created
     *              write_error : the file was not extracted because there was a
     *                            error while writing the file
     *              read_error : the file was not extracted because there was a
     *                           error while reading the file
     *              invalid_header : the file was not extracted because of an
     *                               archive format error (bad file header)
     * Note that each time a method can continue operating when there
     * is an error on a single file, the error is only logged in the file status.
     *
     * @access public
     * @return mixed An array of file description on success,
     *               0 on an unrecoverable failure, an error code is logged.
     */
    function listContent()
    {
        $this->_errorReset();

        // ----- Check archive
        if (!$this->_checkFormat()) {
            return(0);
        }

        $v_list = array();
        if ($this->_list($v_list) != 1) {
            unset($v_list);
            return(0);
        }

        return $v_list;
    }
    // }}}

    // {{{ extract()
    /**
     * This method extract the files and folders which are in the zip archive.
     * It can extract all the archive or a part of the archive by using filter
     * feature (extract by name, by index, by preg). The extraction
     * can occur in the current path or an other path.
     * All the advanced features are activated by the use of variable
     * parameters.
     * The return value is an array of entry descriptions which gives
     * information on extracted files (See listContent()).
     * The method may return a success value (an array) even if some files
     * are not correctly extracted (see the file status in listContent()).
     * The supported variable parameters for this method are :
     *   'add_path' : Path where the files and directories are to be extracted
     *   'remove_path' : First part ('root' part) of the memorized path
     *                   (if similar) to remove while extracting.
     *   'remove_all_path' : Remove all the memorized path while extracting.
     *   'extract_as_string' :
     *   'set_chmod' : After the extraction of the file the indicated mode
     *                 will be set.
     *   'by_name' : It can be a string with file/dir names separated by ',',
     *               or an array of file/dir names to extract from the archive.
     *   'by_index' : A string with range of indexes separated by ',',
     *                (sample "1,3-5,12").
     *   'by_preg' : A regular expression (preg) that must match the extracted
     *               filename.
     *   'callback_pre_extract' : A callback function that will be called before
     *                            each entry extraction.
     *   'callback_post_extract' : A callback function that will be called after
     *                            each entry extraction.
     *
     * @param mixed $p_params An array of variable parameters and values.
     *
     * @return mixed An array of file description on success,
     *               0 on an unrecoverable failure, an error code is logged.
     */
    function extract($p_params = 0)
    {

        $this->_errorReset();

        // ----- Check archive
        if (!$this->_checkFormat()) {
            return(0);
        }

        // ----- Set default values
        if ($p_params === 0) {
            $p_params = array();
        }

        if ($this->_check_parameters($p_params,
                                     array ('extract_as_string' => false,
                                            'add_path' => '',
                                            'remove_path' => '',
                                            'remove_all_path' => false,
                                             'callback_pre_extract' => '',
                                            'callback_post_extract' => '',
                                            'set_chmod' => 0,
                                            'by_name' => '',
                                            'by_index' => '',
                                            'by_preg' => '') ) != 1) {
            return 0;
        }

        // ----- Call the extracting fct
        $v_list = array();
        if ($this->_extractByRule($v_list, $p_params) != 1) {
            unset($v_list);
            return(0);
        }

        return $v_list;
    }
    // }}}


    // {{{ delete()
    /**
     * This methods delete archive entries in the zip archive.
     * Notice that at least one filtering rule (set by the variable parameter
     * list) must be set.
     * Also notice that if you delete a folder entry, only the folder entry
     * is deleted, not all the files bellonging to this folder.
     * The supported variable parameters for this method are :
     *   'by_name' : It can be a string with file/dir names separated by ',',
     *               or an array of file/dir names to delete from the archive.
     *   'by_index' : A string with range of indexes separated by ',',
     *                (sample "1,3-5,12").
     *   'by_preg' : A regular expression (preg) that must match the extracted
     *               filename.
     *
     * @param mixed $p_params An array of variable parameters and values.
     *
     * @return mixed An array of file description on success,
     *               0 on an unrecoverable failure, an error code is logged.
     */
    function delete($p_params)
    {
        $this->_errorReset();

        // ----- Check archive
        if (!$this->_checkFormat()) {
            return(0);
        }

        // ----- Set default values
        if ($this->_check_parameters($p_params,
                                     array ('by_name' => '',
                                            'by_index' => '',
                                            'by_preg' => '') ) != 1) {
            return 0;
        }

        // ----- Check that at least one rule is set
        if (($p_params['by_name'] == '')
            && ($p_params['by_index'] == '')
            && ($p_params['by_preg'] == '')) {
            $this->_errorLog(ARCHIVE_ZIP_ERR_INVALID_PARAMETER,
                             'At least one filtering rule must'
                             .' be set as parameter');
            return 0;
        }

        // ----- Call the delete fct
        $v_list = array();
        if ($this->_deleteByRule($v_list, $p_params) != 1) {
            unset($v_list);
            return(0);
        }

        return $v_list;
    }
    // }}}

    // {{{ properties()
    /**
     * This method gives the global properties of the archive.
     *  The properties are :
     *    nb : Number of files in the archive
     *    comment : Comment associated with the archive file
     *    status : not_exist, ok
     *
     * @return mixed An array with the global properties or 0 on error.
     */
    function properties()
    {
        $this->_errorReset();

        // ----- Check archive
        if (!$this->_checkFormat()) {
            return(0);
        }

        // ----- Default properties
        $v_prop            = array();
        $v_prop['comment'] = '';
        $v_prop['nb']      = 0;
        $v_prop['status']  = 'not_exist';

        // ----- Look if file exists
        if (@is_file($this->_zipname)) {
            // ----- Open the zip file
            if (($this->_zip_fd = @fopen($this->_zipname, 'rb')) == 0) {
                $this->_errorLog(ARCHIVE_ZIP_ERR_READ_OPEN_FAIL,
                                 'Unable to open archive \''.$this->_zipname
                                 .'\' in binary read mode');
                return 0;
            }

            // ----- Read the central directory informations
            $v_central_dir = array();
            if (($v_result = $this->_readEndCentralDir($v_central_dir)) != 1) {
                return 0;
            }

            $this->_closeFd();

            // ----- Set the user attributes
            $v_prop['comment'] = $v_central_dir['comment'];
            $v_prop['nb']      = $v_central_dir['entries'];
            $v_prop['status']  = 'ok';
        }

        return $v_prop;
    }
    // }}}


    // {{{ duplicate()
    /**
     * This method creates an archive by copying the content of an other one.
     * If the archive already exist, it is replaced by the new one without
     * any warning.
     *
     *
     * @param mixed $p_archive It can be a valid Archive_Zip object or
     *                            the filename of a valid zip archive.
     *
     * @return integer 1 on success, 0 on failure.
     */
    function duplicate($p_archive)
    {
        $this->_errorReset();

        // ----- Look if the $p_archive is a Archive_Zip object
        if ((is_object($p_archive))
            && (strtolower(get_class($p_archive)) == 'archive_zip')) {
            $v_result = $this->_duplicate($p_archive->_zipname);
        } else if (is_string($p_archive)) {
            // ----- Check that $p_archive is a valid zip file
            // TBC : Should also check the archive format
            if (!is_file($p_archive)) {
                $this->_errorLog(ARCHIVE_ZIP_ERR_MISSING_FILE,
                                 "No file with filename '".$p_archive."'");
                $v_result = ARCHIVE_ZIP_ERR_MISSING_FILE;
            } else {
                $v_result = $this->_duplicate($p_archive);
            }
        } else {
            $this->_errorLog(ARCHIVE_ZIP_ERR_INVALID_PARAMETER,
                             "Invalid variable type p_archive_to_add");
            $v_result = ARCHIVE_ZIP_ERR_INVALID_PARAMETER;
        }

        return $v_result;
    }
    // }}}

    // {{{ merge()
    /**
     *  This method merge a valid zip archive at the end of the
     *  archive identified by the Archive_Zip object.
     *  If the archive ($this) does not exist, the merge becomes a duplicate.
     *  If the archive to add does not exist, the merge is a success.
     *
     * @param mixed $p_archive_to_add It can be a valid Archive_Zip object or
     *                                 the filename of a valid zip archive.
     *
     * @return integer 1 on success, 0 on failure.
     */
    function merge($p_archive_to_add)
    {
        $v_result = 1;
        $this->_errorReset();

        // ----- Check archive
        if (!$this->_checkFormat()) {
            return(0);
        }

        // ----- Look if the $p_archive_to_add is a Archive_Zip object
        if ((is_object($p_archive_to_add))
            && (strtolower(get_class($p_archive_to_add)) == 'archive_zip')) {
            $v_result = $this->_merge($p_archive_to_add);
        } else if (is_string($p_archive_to_add)) {
            // ----- Create a temporary archive
            $v_object_archive = new Archive_Zip($p_archive_to_add);

            // ----- Merge the archive
            $v_result = $this->_merge($v_object_archive);
        } else {
            $this->_errorLog(ARCHIVE_ZIP_ERR_INVALID_PARAMETER,
                             "Invalid variable type p_archive_to_add");
            $v_result = ARCHIVE_ZIP_ERR_INVALID_PARAMETER;
        }

        return $v_result;
    }
    // }}}

    // {{{ errorCode()
    /**
     * Method that gives the lastest error code.
     *
     * @access public
     * @return integer The error code value.
     */
    function errorCode()
    {
        return($this->_error_code);
    }
    // }}}

    // {{{ errorName()
    /**
     * This method gives the latest error code name.
     *
     * @param boolean $p_with_code If true, gives the name and the int value.
     *
     * @access public
     * @return string The error name.
     */
    function errorName($p_with_code = false)
    {
        $v_const_list = get_defined_constants();

        // ----- Extract error constants from all const.
        for (reset($v_const_list);
            list($v_key, $v_value) = each($v_const_list);) {
            if (substr($v_key, 0, strlen('ARCHIVE_ZIP_ERR_')) =='ARCHIVE_ZIP_ERR_') {
                $v_error_list[$v_key] = $v_value;
            }
        }

        // ----- Search the name form the code value
        $v_key = array_search($this->_error_code, $v_error_list, true);
        if ($v_key!=false) {
            $v_value = $v_key;
        } else {
            $v_value = 'NoName';
        }

        if ($p_with_code) {
            return($v_value.' ('.$this->_error_code.')');
        } else {
            return($v_value);
        }
    }
    // }}}

    // {{{ errorInfo()
    /**
     * This method returns the description associated with the latest error.
     *
     * @param boolean $p_full If set to true gives the description with the
     *                         error code, the name and the description.
     *                         If set to false gives only the description
     *                         and the error code.
     *
     * @access public
     * @return string The error description.
     */
    function errorInfo($p_full = false)
    {
        if ($p_full) {
            return($this->errorName(true)." : ".$this->_error_string);
        } else {
            return($this->_error_string." [code ".$this->_error_code."]");
        }
    }
    // }}}


    // -----------------------------------------------------------------------------
    // ***** UNDER THIS LINE ARE DEFINED PRIVATE INTERNAL FUNCTIONS *****
    // *****                                                        *****
    // *****       THESES FUNCTIONS MUST NOT BE USED DIRECTLY       *****
    // -----------------------------------------------------------------------------

    // ---------------------------------------------------------------------------
    // Function : _checkFormat()
    // Description :
    //   This method check that the archive exists and is a valid zip archive.
    //   Several level of check exists. (futur)
    // Parameters :
    //   $p_level : Level of check. Default 0.
    //              0 : Check the first bytes (magic codes) (default value))
    //              1 : 0 + Check the central directory (futur)
    //              2 : 1 + Check each file header (futur)
    // Return Values :
    //   true on success,
    //   false on error, the error code is set.
    // ---------------------------------------------------------------------------
    /**
     * Archive_Zip::_checkFormat()
     *
     * { Description }
     *
     * @param integer $p_level
     *
     * @return bool
     */
    function _checkFormat($p_level = 0)
    {
        $v_result = true;

        // ----- Reset the error handler
        $this->_errorReset();

        // ----- Look if the file exits
        if (!is_file($this->_zipname)) {
            // ----- Error log
            $this->_errorLog(ARCHIVE_ZIP_ERR_MISSING_FILE,
                             "Missing archive file '".$this->_zipname."'");
            return(false);
        }

        // ----- Check that the file is readeable
        if (!is_readable($this->_zipname)) {
            // ----- Error log
            $this->_errorLog(ARCHIVE_ZIP_ERR_READ_OPEN_FAIL,
                             "Unable to read archive '".$this->_zipname."'");
            return(false);
        }

        // ----- Check the magic code
        // TBC

        // ----- Check the central header
        // TBC

        // ----- Check each file header
        // TBC


        return $v_result;
    }
    // ---------------------------------------------------------------------------

    // ---------------------------------------------------------------------------
    // Function : _create()
    // Description :
    // Parameters :
    // Return Values :
    // ---------------------------------------------------------------------------
    /**
     * Archive_Zip::_create()
     *
     * { Description }
     *
     * @return int
     */
    function _create($p_list, &$p_result_list, &$p_params)
    {
        $v_result = 1;

        $v_list_detail = array();

        $p_add_dir        = $p_params['add_path'];
        $p_remove_dir     = $p_params['remove_path'];
        $p_remove_all_dir = $p_params['remove_all_path'];

        // ----- Open the file in write mode
        if (($v_result = $this->_openFd('wb')) != 1) {

            return $v_result;
        }

        // ----- Add the list of files
        $v_result = $this->_addList($p_list, $p_result_list, $p_add_dir, $p_remove_dir, $p_remove_all_dir, $p_params);

        // ----- Close
        $this->_closeFd();


        return $v_result;
    }
    // ---------------------------------------------------------------------------

    // ---------------------------------------------------------------------------
    // Function : _add()
    // Description :
    // Parameters :
    // Return Values :
    // ---------------------------------------------------------------------------
    /**
     * Archive_Zip::_add()
     *
     * { Description }
     *
     * @return int
     */
    function _add($p_list, &$p_result_list, &$p_params)
    {
        $v_result = 1;

        $v_list_detail = array();

        $p_add_dir        = $p_params['add_path'];
        $p_remove_dir     = $p_params['remove_path'];
        $p_remove_all_dir = $p_params['remove_all_path'];

        // ----- Look if the archive exists or is empty and need to be created
        if ((!is_file($this->_zipname)) || (filesize($this->_zipname) == 0)) {
            $v_result = $this->_create($p_list, $p_result_list, $p_params);
            return $v_result;
        }

        // ----- Open the zip file
        if (($v_result = $this->_openFd('rb')) != 1) {
            return $v_result;
        }

        // ----- Read the central directory informations
        $v_central_dir = array();
        if (($v_result = $this->_readEndCentralDir($v_central_dir)) != 1) {
            $this->_closeFd();
            return $v_result;
        }

        // ----- Go to beginning of File
        @rewind($this->_zip_fd);

        // ----- Creates a temporay file
        $v_zip_temp_name = ARCHIVE_ZIP_TEMPORARY_DIR.uniqid('archive_zip-').'.tmp';

        // ----- Open the temporary file in write mode
        if (($v_zip_temp_fd = @fopen($v_zip_temp_name, 'wb')) == 0) {
            $this->_closeFd();

            $this->_errorLog(ARCHIVE_ZIP_ERR_READ_OPEN_FAIL,
                           'Unable to open temporary file \''
                           .$v_zip_temp_name.'\' in binary write mode');
            return Archive_Zip::errorCode();
        }

        // ----- Copy the files from the archive to the temporary file
        // TBC : Here I should better append the file and go back to erase the
        // central dir
        $v_size = $v_central_dir['offset'];
        while ($v_size != 0) {
            $v_read_size = ($v_size < ARCHIVE_ZIP_READ_BLOCK_SIZE
                            ? $v_size : ARCHIVE_ZIP_READ_BLOCK_SIZE);

            $v_buffer = fread($this->_zip_fd, $v_read_size);

            @fwrite($v_zip_temp_fd, $v_buffer, $v_read_size);
            $v_size -= $v_read_size;
        }

        // ----- Swap the file descriptor
        // Here is a trick : I swap the temporary fd with the zip fd, in order to
        // use the following methods on the temporary fil and not the real archive
        $v_swap = $this->_zip_fd;

        $this->_zip_fd = $v_zip_temp_fd;
        $v_zip_temp_fd = $v_swap;

        // ----- Add the files
        $v_header_list = array();
        if (($v_result = $this->_addFileList($p_list, $v_header_list,
                                             $p_add_dir, $p_remove_dir,
                                             $p_remove_all_dir, $p_params)) != 1) {
            fclose($v_zip_temp_fd);
            $this->_closeFd();
            @unlink($v_zip_temp_name);


            return $v_result;
        }

        // ----- Store the offset of the central dir
        $v_offset = @ftell($this->_zip_fd);

        // ----- Copy the block of file headers from the old archive
        $v_size = $v_central_dir['size'];
        while ($v_size != 0) {
            $v_read_size = ($v_size < ARCHIVE_ZIP_READ_BLOCK_SIZE
                            ? $v_size : ARCHIVE_ZIP_READ_BLOCK_SIZE);

            $v_buffer = @fread($v_zip_temp_fd, $v_read_size);

            @fwrite($this->_zip_fd, $v_buffer, $v_read_size);
            $v_size -= $v_read_size;
        }

        // ----- Create the Central Dir files header
        for ($i = 0, $v_count = 0; $i<sizeof($v_header_list); $i++) {
            // ----- Create the file header
            if ($v_header_list[$i]['status'] == 'ok') {
                if (($v_result = $this->_writeCentralFileHeader($v_header_list[$i]))!=1) {
                    fclose($v_zip_temp_fd);
                    $this->_closeFd();
                    @unlink($v_zip_temp_name);


                    return $v_result;
                }
                $v_count++;
            }

            // ----- Transform the header to a 'usable' info
            $this->_convertHeader2FileInfo($v_header_list[$i], $p_result_list[$i]);
        }

        // ----- Zip file comment
        $v_comment = '';

        // ----- Calculate the size of the central header
        $v_size = @ftell($this->_zip_fd)-$v_offset;

        // ----- Create the central dir footer
        if (($v_result = $this->_writeCentralHeader($v_count
                                                      +$v_central_dir['entries'],
                                                    $v_size, $v_offset,
                                                    $v_comment)) != 1) {
            // ----- Reset the file list
            unset($v_header_list);


            return $v_result;
        }

        // ----- Swap back the file descriptor
        $v_swap = $this->_zip_fd;

        $this->_zip_fd = $v_zip_temp_fd;
        $v_zip_temp_fd = $v_swap;

        // ----- Close
        $this->_closeFd();

        // ----- Close the temporary file
        @fclose($v_zip_temp_fd);

        // ----- Delete the zip file
        // TBC : I should test the result ...
        @unlink($this->_zipname);

        // ----- Rename the temporary file
        // TBC : I should test the result ...
        //@rename($v_zip_temp_name, $this->_zipname);
        $this->_tool_Rename($v_zip_temp_name, $this->_zipname);


        return $v_result;
    }
    // ---------------------------------------------------------------------------

    // ---------------------------------------------------------------------------
    // Function : _openFd()
    // Description :
    // Parameters :
    // ---------------------------------------------------------------------------
    /**
     * Archive_Zip::_openFd()
     *
     * { Description }
     *
     * @return int
     */
    function _openFd($p_mode)
    {
        $v_result = 1;

        // ----- Look if already open
        if ($this->_zip_fd != 0) {
            $this->_errorLog(ARCHIVE_ZIP_ERR_READ_OPEN_FAIL,
                             'Zip file \''.$this->_zipname.'\' already open');
            return Archive_Zip::errorCode();
        }

        // ----- Open the zip file
        if (($this->_zip_fd = @fopen($this->_zipname, $p_mode)) == 0) {
            $this->_errorLog(ARCHIVE_ZIP_ERR_READ_OPEN_FAIL,
                             'Unable to open archive \''.$this->_zipname
                             .'\' in '.$p_mode.' mode');
            return Archive_Zip::errorCode();
        }


        return $v_result;
    }
    // ---------------------------------------------------------------------------

    // ---------------------------------------------------------------------------
    // Function : _closeFd()
    // Description :
    // Parameters :
    // ---------------------------------------------------------------------------
    /**
     * Archive_Zip::_closeFd()
     *
     * { Description }
     *
     * @return int
     */
    function _closeFd()
    {
        $v_result = 1;

        if ($this->_zip_fd != 0) {
            @fclose($this->_zip_fd);
        }
        $this->_zip_fd = 0;


        return $v_result;
    }
    // ---------------------------------------------------------------------------

    // ---------------------------------------------------------------------------
    // Function : _addList()
    // Description :
    //   $p_add_dir and $p_remove_dir will give the ability to memorize a path which is
    //   different from the real path of the file. This is usefull if you want to have PclTar
    //   running in any directory, and memorize relative path from an other directory.
    // Parameters :
    //   $p_list : An array containing the file or directory names to add in the tar
    //   $p_result_list : list of added files with their properties (specially the status field)
    //   $p_add_dir : Path to add in the filename path archived
    //   $p_remove_dir : Path to remove in the filename path archived
    // Return Values :
    // ---------------------------------------------------------------------------
    /**
     * Archive_Zip::_addList()
     *
     * { Description }
     *
     * @return int
     */
    function _addList($p_list, &$p_result_list,
                    $p_add_dir, $p_remove_dir, $p_remove_all_dir, &$p_params)
    {
        $v_result = 1;

        // ----- Add the files
        $v_header_list = array();
        if (($v_result = $this->_addFileList($p_list, $v_header_list,
                                             $p_add_dir, $p_remove_dir,
                                             $p_remove_all_dir, $p_params)) != 1) {
            return $v_result;
        }

        // ----- Store the offset of the central dir
        $v_offset = @ftell($this->_zip_fd);

        // ----- Create the Central Dir files header
        for ($i = 0, $v_count = 0; $i<sizeof($v_header_list); $i++) {
            // ----- Create the file header
            if ($v_header_list[$i]['status'] == 'ok') {
                if (($v_result = $this->_writeCentralFileHeader($v_header_list[$i])) != 1) {
                    return $v_result;
                }
                $v_count++;
            }

            // ----- Transform the header to a 'usable' info
            $this->_convertHeader2FileInfo($v_header_list[$i], $p_result_list[$i]);
        }

        // ----- Zip file comment
        $v_comment = '';

        // ----- Calculate the size of the central header
        $v_size = @ftell($this->_zip_fd)-$v_offset;

        // ----- Create the central dir footer
        if (($v_result = $this->_writeCentralHeader($v_count, $v_size, $v_offset,
                                                    $v_comment)) != 1) {
            // ----- Reset the file list
            unset($v_header_list);


            return $v_result;
        }


        return $v_result;
    }
    // ---------------------------------------------------------------------------

    // ---------------------------------------------------------------------------
    // Function : _addFileList()
    // Description :
    //   $p_add_dir and $p_remove_dir will give the ability to memorize a path which is
    //   different from the real path of the file. This is usefull if you want to
    //   run the lib in any directory, and memorize relative path from an other directory.
    // Parameters :
    //   $p_list : An array containing the file or directory names to add in the tar
    //   $p_result_list : list of added files with their properties (specially the status field)
    //   $p_add_dir : Path to add in the filename path archived
    //   $p_remove_dir : Path to remove in the filename path archived
    // Return Values :
    // ---------------------------------------------------------------------------
    /**
     * Archive_Zip::_addFileList()
     *
     * { Description }
     *
     * @return int
     */
    function _addFileList($p_list, &$p_result_list,
                        $p_add_dir, $p_remove_dir, $p_remove_all_dir,
                        &$p_params)
    {
        $v_result = 1;
        $v_header = array();

        // ----- Recuperate the current number of elt in list
        $v_nb = sizeof($p_result_list);

        // ----- Loop on the files
        for ($j = 0; ($j<count($p_list)) && ($v_result == 1); $j++) {
            // ----- Recuperate the filename
            $p_filename = $this->_tool_TranslateWinPath($p_list[$j], false);

            // ----- Skip empty file names
            if ($p_filename == "") {
                continue;
            }

            // ----- Check the filename
            if (!file_exists($p_filename)) {
                $this->_errorLog(ARCHIVE_ZIP_ERR_MISSING_FILE,
                                 "File '$p_filename' does not exists");
                return Archive_Zip::errorCode();
            }

            // ----- Look if it is a file or a dir with no all pathnre move
            if ((is_file($p_filename)) || ((is_dir($p_filename)) && !$p_remove_all_dir)) {
                // ----- Add the file
                if (($v_result = $this->_addFile($p_filename, $v_header, $p_add_dir, $p_remove_dir, $p_remove_all_dir, $p_params)) != 1) {
                    return $v_result;
                }

                // ----- Store the file infos
                $p_result_list[$v_nb++] = $v_header;
            }

            // ----- Look for directory
            if (is_dir($p_filename)) {

                // ----- Look for path
                if ($p_filename != ".") {
                    $v_path = $p_filename."/";
                } else {
                    $v_path = "";
                }

                // ----- Read the directory for files and sub-directories
                $p_hdir  = opendir($p_filename);
                $p_hitem = readdir($p_hdir); // '.' directory
                $p_hitem = readdir($p_hdir); // '..' directory

                while ($p_hitem = readdir($p_hdir)) {

                    // ----- Look for a file
                    if (is_file($v_path.$p_hitem)) {

                        // ----- Add the file
                        if (($v_result = $this->_addFile($v_path.$p_hitem, $v_header, $p_add_dir, $p_remove_dir, $p_remove_all_dir, $p_params)) != 1) {
                            return $v_result;
                        }

                        // ----- Store the file infos
                        $p_result_list[$v_nb++] = $v_header;
                    } else {
                        // ----- Recursive call to _addFileList()
                        // ----- Need an array as parameter
                        $p_temp_list[0] = $v_path.$p_hitem;

                        $v_result = $this->_addFileList($p_temp_list, $p_result_list, $p_add_dir, $p_remove_dir, $p_remove_all_dir, $p_params);

                        // ----- Update the number of elements of the list
                        $v_nb = sizeof($p_result_list);
                    }
                }

                // ----- Free memory for the recursive loop
                unset($p_temp_list);
                unset($p_hdir);
                unset($p_hitem);
            }
        }

        return $v_result;
    }
    // ---------------------------------------------------------------------------

    // ---------------------------------------------------------------------------
    // Function : _addFile()
    // Description :
    // Parameters :
    // Return Values :
    // ---------------------------------------------------------------------------
    /**
     * Archive_Zip::_addFile()
     *
     * { Description }
     *
     * @return int
     */
    function _addFile($p_filename, &$p_header, $p_add_dir, $p_remove_dir, $p_remove_all_dir, &$p_params)
    {
        $v_result = 1;

        if ($p_filename == "") {
            // ----- Error log
            $this->_errorLog(ARCHIVE_ZIP_ERR_INVALID_PARAMETER, "Invalid file list parameter (invalid or empty list)");


            return Archive_Zip::errorCode();
        }

        // ----- Calculate the stored filename
        $v_stored_filename = $p_filename;

        // ----- Look for all path to remove
        if ($p_remove_all_dir) {
            $v_stored_filename = basename($p_filename);
        } else if ($p_remove_dir != "") {
            if (substr($p_remove_dir, -1) != '/') {
                $p_remove_dir .= "/";
            }

            if ((substr($p_filename, 0, 2) == "./") || (substr($p_remove_dir, 0, 2) == "./")) {
                if ((substr($p_filename, 0, 2) == "./") && (substr($p_remove_dir, 0, 2) != "./")) {
                    $p_remove_dir = "./".$p_remove_dir;
                }
                if ((substr($p_filename, 0, 2) != "./") && (substr($p_remove_dir, 0, 2) == "./")) {
                    $p_remove_dir = substr($p_remove_dir, 2);
                }
            }

            $v_compare = $this->_tool_PathInclusion($p_remove_dir, $p_filename);
            if ($v_compare > 0) {
                if ($v_compare == 2) {
                    $v_stored_filename = "";
                } else {
                    $v_stored_filename = substr($p_filename, strlen($p_remove_dir));
                }
            }
        }
        // ----- Look for path to add
        if ($p_add_dir != "") {
            if (substr($p_add_dir, -1) == "/") {
                $v_stored_filename = $p_add_dir.$v_stored_filename;
            } else {
                $v_stored_filename = $p_add_dir."/".$v_stored_filename;
            }
        }

        // ----- Filename (reduce the path of stored name)
        $v_stored_filename = $this->_tool_PathReduction($v_stored_filename);


            /* filename length moved after call-back in release 1.3
            // ----- Check the path length
                if (strlen($v_stored_filename) > 0xFF) {
                    // ----- Error log
                    $this->_errorLog(-5, "Stored file name is too long (max. 255) : '$v_stored_filename'");

                    return Archive_Zip::errorCode();
                }
             */

        // ----- Set the file properties
        clearstatcache();
        $p_header['comment']           = '';
        $p_header['comment_len']       = 0;
        $p_header['compressed_size']   = 0;
        $p_header['compression']       = 0;
        $p_header['crc']               = 0;
        $p_header['disk']              = 0;
        $p_header['external']          = (is_file($p_filename)?0xFE49FFE0:0x41FF0010);
        $p_header['extra']             = '';
        $p_header['extra_len']         = 0;
        $p_header['filename']          = $p_filename;
        $p_header['filename_len']      = strlen($p_filename);
        $p_header['flag']              = 0;
        $p_header['index']             = -1;
        $p_header['internal']          = 0;
        $p_header['mtime']             = filemtime($p_filename);
        $p_header['offset']            = 0;
        $p_header['size']              = filesize($p_filename);
        $p_header['status']            = 'ok';
        $p_header['stored_filename']   = $v_stored_filename;
        $p_header['version']           = 20;
        $p_header['version_extracted'] = 10;

        // ----- Look for pre-add callback
        if ((isset($p_params[ARCHIVE_ZIP_PARAM_PRE_ADD]))
            && ($p_params[ARCHIVE_ZIP_PARAM_PRE_ADD] != '')) {

            // ----- Generate a local information
            $v_local_header = array();
            $this->_convertHeader2FileInfo($p_header, $v_local_header);

            // ----- Call the callback
            // Here I do not use call_user_func() because I need to send a reference to the
            // header.
            eval('$v_result = '.$p_params[ARCHIVE_ZIP_PARAM_PRE_ADD].'(ARCHIVE_ZIP_PARAM_PRE_ADD, $v_local_header);');
            if ($v_result == 0) {
                // ----- Change the file status
                $p_header['status'] = "skipped";

                $v_result = 1;
            }

            // ----- Update the informations
            // Only some fields can be modified
            if ($p_header['stored_filename'] != $v_local_header['stored_filename']) {
                $p_header['stored_filename'] = $this->_tool_PathReduction($v_local_header['stored_filename']);
            }
        }

        // ----- Look for empty stored filename
        if ($p_header['stored_filename'] == "") {
            $p_header['status'] = "filtered";
        }

        // ----- Check the path length
        if (strlen($p_header['stored_filename']) > 0xFF) {
            $p_header['status'] = 'filename_too_long';
        }

        // ----- Look if no error, or file not skipped
        if ($p_header['status'] == 'ok') {

            // ----- Look for a file
            if (is_file($p_filename)) {
                // ----- Open the source file…

Large files files are truncated, but you can click here to view the full file