WB 2.11.0

<?php

// --------------------------------------------------------------------------------

// PhpConcept Library - Zip Module 2.8.2

// --------------------------------------------------------------------------------

// License GNU/LGPL - Vincent Blavet - August 2009

// http://www.phpconcept.net

// --------------------------------------------------------------------------------

//

// Presentation :

//   PclZip is a PHP library that manage ZIP archives.

//   So far tests show that archives generated by PclZip are readable by

//   WinZip application and other tools.

//

// Description :

//   See readme.txt and http://www.phpconcept.net

//

// Warning :

//   This library and the associated files are non commercial, non professional

//   work.

//   It should not have unexpected results. However if any damage is caused by

//   this software the author can not be responsible.

//   The use of this software is at the risk of the user.

//

// --------------------------------------------------------------------------------

// $Id$

// --------------------------------------------------------------------------------

// --------------------------------------------------------------------------------

// ***** UNDER THIS LINE NOTHING NEEDS TO BE MODIFIED *****

// --------------------------------------------------------------------------------

    // Global variables

    $g_pclzip_version = "2.8.2";

/* --- include global constants definitions if realy needed --------------------------- */

/* this part is set deprecated and for compatibility only                               */

    if (!defined('PCLZIP_ERR_NO_ERROR')) {

        include __DIR__.'/Constants.php';

    }

/* --- zlib compatibility for 32bit Ubuntu -------------------------------------------- */

/* this part is never needed on 64bit servers                                           */

    if (!function_exists('gzopen')) {

        if (!function_exists('gzopen64')) {

            throw new Exception('Loading '.basename(__FILE__).' aborted: Missing zlib extensions');

        } else {

            function gzopen($sfn,$m)

            {

                return gzopen64($sfn,$m);

            }

        }

    }

/* ==================================================================================== */

/** --------------------------------------------------------------------------------------

 * Class : PclZip

 * Description :

 *   PclZip is the class that represent a Zip archive.

 *   The public methods allow the manipulation of the archive.

 * Attributes :

 *   Attributes must not be accessed directly.

 * Methods :

 *   PclZip() : Object creator

 *   create() : Creates the Zip archive

 *   listContent() : List the content of the Zip archive

 *   extract() : Extract the content of the archive

 *   properties() : List the properties of the archive

 */

class PclZip

{

  // Constants

    const READ_BLOCK_SIZE = 2048;

  // File list separator

  // In version 1.x of PclZip, the separator for file list is a space

  // (which is not a very smart choice, specifically for windows paths !).

  // A better separator should be a comma (,). This constant gives you the

  // abilty to change that.

  // However notice that changing this value, may have impact on existing

  // scripts, using space separated filenames.

  // Recommanded values for compatibility with older versions :

  // const SEPARATOR = ' ';

  // Recommanded values for smart separation of filenames.

    const SEPARATOR = ',';

  // Error configuration

  // 0 : PclZip Class integrated error handling

  // 1 : PclError external library error handling. By enabling this

  //     you must ensure that you have included PclError library.

  // [2,...] : reserved for futur use

    const ERROR_EXTERNAL = 0;

  // 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 :

  //       - const TEMPORARY_DIR = '/temp/';

  //       - const TEMPORARY_DIR = 'C:/Temp/';

    const TEMPORARY_DIR = '';

  // Optional threshold ratio for use of temporary files

  //       Pclzip sense the size of the file to add/extract and decide to

  //       use or not temporary file. The algorythm is looking for

  //       memory_limit of PHP and apply a ratio.

  //       threshold = memory_limit * ratio.

  //       Recommended values are under 0.5. Default 0.47.

  //       Samples :

  //       - const TEMPORARY_FILE_RATIO = 0.5;

    const TEMPORARY_FILE_RATIO = 0.47;

// Error codes ---------------------------------------------------------------------

//    -1 : Unable to open file in binary write mode

//    -2 : Unable to open file in binary read mode

//    -3 : Invalid parameters

//    -4 : File does not exist

//    -5 : Filename is too long (max. 255)

//    -6 : Not a valid zip file

//    -7 : Invalid extracted file size

//    -8 : Unable to create directory

//    -9 : Invalid archive extension

//    -10 : Invalid archive format

//    -11 : Unable to delete file (unlink)

//    -12 : Unable to rename file (rename)

//    -13 : Invalid header checksum

//    -14 : Invalid archive size

    const ERR_USER_ABORTED            =     2;

    const ERR_NO_ERROR                =     0;

    const ERR_WRITE_OPEN_FAIL         =    -1;

    const ERR_READ_OPEN_FAIL          =    -2;

    const ERR_INVALID_PARAMETER       =    -3;

    const ERR_MISSING_FILE            =    -4;

    const ERR_FILENAME_TOO_LONG       =    -5;

    const ERR_INVALID_ZIP             =    -6;

    const ERR_BAD_EXTRACTED_FILE      =    -7;

    const ERR_DIR_CREATE_FAIL         =    -8;

    const ERR_BAD_EXTENSION           =    -9;

    const ERR_BAD_FORMAT              =   -10;

    const ERR_DELETE_FILE_FAIL        =   -11;

    const ERR_RENAME_FILE_FAIL        =   -12;

    const ERR_BAD_CHECKSUM            =   -13;

    const ERR_INVALID_ARCHIVE_ZIP     =   -14;

    const ERR_MISSING_OPTION_VALUE    =   -15;

    const ERR_INVALID_OPTION_VALUE    =   -16;

    const ERR_ALREADY_A_DIRECTORY     =   -17;

    const ERR_UNSUPPORTED_COMPRESSION =   -18;

    const ERR_UNSUPPORTED_ENCRYPTION  =   -19;

    const ERR_INVALID_ATTRIBUTE_VALUE =   -20;

    const ERR_DIRECTORY_RESTRICTION   =   -21;

    // Options values --------------------------------------------------------------

    const OPT_PATH                    = 77001;

    const OPT_ADD_PATH                = 77002;

    const OPT_REMOVE_PATH             = 77003;

    const OPT_REMOVE_ALL_PATH         = 77004;

    const OPT_SET_CHMOD               = 77005;

    const OPT_EXTRACT_AS_STRING       = 77006;

    const OPT_NO_COMPRESSION          = 77007;

    const OPT_BY_NAME                 = 77008;

    const OPT_BY_INDEX                = 77009;

    const OPT_BY_EREG                 = 77010;

    const OPT_BY_PREG                 = 77011;

    const OPT_COMMENT                 = 77012;

    const OPT_ADD_COMMENT             = 77013;

    const OPT_PREPEND_COMMENT         = 77014;

    const OPT_EXTRACT_IN_OUTPUT       = 77015;

    const OPT_REPLACE_NEWER           = 77016;

    const OPT_STOP_ON_ERROR           = 77017;

//    Having big trouble with crypt. Need to multiply 2 long int

//    which is not correctly supported by PHP ...

//    const OPT_CRYPT', 77018 );

    const OPT_EXTRACT_DIR_RESTRICTION = 77019;

    const OPT_TEMP_FILE_THRESHOLD     = 77020;

    const OPT_ADD_TEMP_FILE_THRESHOLD = 77020; // alias for OPT_TEMP_FILE_THRESHOLD

    const OPT_TEMP_FILE_ON            = 77021;

    const OPT_ADD_TEMP_FILE_ON        = 77021; // alias for OPT_TEMP_FILE_ON

    const OPT_TEMP_FILE_OFF           = 77022;

    const OPT_ADD_TEMP_FILE_OFF       = 77022; // alias for OPT_TEMP_FILE_OFF

// File description attributes -----------------------------------------------------

    const ATT_FILE_NAME               = 79001;

    const ATT_FILE_NEW_SHORT_NAME     = 79002;

    const ATT_FILE_NEW_FULL_NAME      = 79003;

    const ATT_FILE_MTIME              = 79004;

    const ATT_FILE_CONTENT            = 79005;

    const ATT_FILE_COMMENT            = 79006;

// Call backs values ---------------------------------------------------------------

    const CB_PRE_EXTRACT              = 78001;

    const CB_POST_EXTRACT             = 78002;

    const CB_PRE_ADD                  = 78003;

    const CB_POST_ADD                 = 78004;

// For futur use -------------------------------------------------------------------

//    const CB_PRE_LIST    = 78005;

//    const CB_POST_LIST   = 78006;

//    const CB_PRE_DELETE  = 78007;

//    const CB_POST_DELETE = 78008;

/** @var string  Filename of the zip file */

    protected $zipname      = '';

/** @var integer  File descriptor of the zip file */

    protected $zip_fd       = 0;

/** @var integer  Internal error handling */

    protected $error_code   = 1;

/** @var string  Internal error message */

    protected $error_string = '';

/**

 *  @var integer  Current status of the magic_quotes_runtime

 *  @description  This value store the php configuration for magic_quotes

 *                  The class can then disable the magic_quotes and reset it after

 */

    protected $magic_quotes_status = -1;

  // --------------------------------------------------------------------------------

  // Function : PclZip()

  // Description :

  //   Creates a PclZip object and set the name of the associated Zip archive

  //   filename.

  //   Note that no real action is taken, if the archive does not exist it is not

  //   created. Use create() for that.

  // --------------------------------------------------------------------------------

    public function __construct($p_zipname)

    {

        // Set the attributes

        $this->zipname             = $p_zipname;

        $this->zip_fd              = 0;

        $this->magic_quotes_status = -1;

    }

  // --------------------------------------------------------------------------------

  // Function :

  //   create($p_filelist, $p_add_dir="", $p_remove_dir="")

  //   create($p_filelist, $p_option, $p_option_value, ...)

  // Description :

  //   This method supports two different synopsis. The first one is historical.

  //   This method creates a Zip Archive. The Zip file is created in the

  //   filesystem. The files and directories indicated in $p_filelist

  //   are added in the archive. See the parameters description for the

  //   supported format of $p_filelist.

  //   When a directory is in the list, the directory and its content is added

  //   in the archive.

  //   In this synopsis, the function takes an optional variable list of

  //   options. See bellow the supported options.

  // Parameters :

  //   $p_filelist : An array containing file or directory names, or

  //                 a string containing one filename or one directory name, or

  //                 a string containing a list of filenames and/or directory

  //                 names separated by spaces.

  //   $p_add_dir : A path to add before the real path of the archived file,

  //                in order to have it memorized in the archive.

  //   $p_remove_dir : A path to remove from the real path of the file to archive,

  //                   in order to have a shorter path memorized in the archive.

  //                   When $p_add_dir and $p_remove_dir are set, $p_remove_dir

  //                   is removed first, before $p_add_dir is added.

  // Options :

  //   OPT_ADD_PATH :

  //   OPT_REMOVE_PATH :

  //   OPT_REMOVE_ALL_PATH :

  //   OPT_COMMENT :

  //   CB_PRE_ADD :

  //   CB_POST_ADD :

  // Return Values :

  //   0 on failure,

  //   The list of the added files, with a status of the add action.

  //   (see PclZip::listContent() for list entry format)

  // --------------------------------------------------------------------------------

    public function create($p_filelist)

    {

        $v_result=1;

        // Reset the error handler

        $this->privErrorReset();

        // Set default values

        $v_options = array();

        $v_options[self::OPT_NO_COMPRESSION] = false;

        // Look for variable options arguments

        $v_size = func_num_args();

        // Look for arguments

        if ($v_size > 1) {

            // Get the arguments

            $v_arg_list = func_get_args();

            // Remove from the options list the first argument

            array_shift($v_arg_list);

            $v_size--;

            // Look for first arg

            if ((is_integer($v_arg_list[0])) && ($v_arg_list[0] > 77000)) {

                // Parse the options

                $v_result = $this->privParseOptions(

                    $v_arg_list,

                    $v_size,

                    $v_options,

                    array (

                        self::OPT_REMOVE_PATH => 'optional',

                        self::OPT_REMOVE_ALL_PATH => 'optional',

                        self::OPT_ADD_PATH => 'optional',

                        self::CB_PRE_ADD => 'optional',

                        self::CB_POST_ADD => 'optional',

                        self::OPT_NO_COMPRESSION => 'optional',

                        self::OPT_COMMENT => 'optional',

                        self::OPT_TEMP_FILE_THRESHOLD => 'optional',

                        self::OPT_TEMP_FILE_ON => 'optional',

                        // self::OPT_CRYPT => 'optional',

                        self::OPT_TEMP_FILE_OFF => 'optional'

                    )

                );

                if ($v_result != 1) {

                    return 0;

                }

            } else {

            // Look for 2 args

            // Here we need to support the first historic synopsis of the

            // method.

                // Get the first argument

                $v_options[self::OPT_ADD_PATH] = $v_arg_list[0];

                // Look for the optional second argument

                if ($v_size == 2) {

                    $v_options[self::OPT_REMOVE_PATH] = $v_arg_list[1];

                } else if ($v_size > 2) {

                    $this->privErrorLog(

                        self::ERR_INVALID_PARAMETER,

                        "Invalid number / type of arguments"

                    );

                    return 0;

                }

            }

        }

        // Look for default option values

        $this->privOptionDefaultThreshold($v_options);

        // Init

        $v_string_list    = array();

        $v_att_list       = array();

        $v_filedescr_list = array();

        $p_result_list    = array();

        // Look if the $p_filelist is really an array

        if (is_array($p_filelist)) {

            // Look if the first element is also an array

            // This will mean that this is a file description entry

            if (isset($p_filelist[0]) && is_array($p_filelist[0])) {

                $v_att_list = $p_filelist;

            } else {

                // The list is a list of string names

                $v_string_list = $p_filelist;

            }

        } else if (is_string($p_filelist)) {

            // Look if the $p_filelist is a string

            // Create a list from the string

            $v_string_list = explode(self::SEPARATOR, $p_filelist);

        } else {

            // Invalid variable type for $p_filelist

            $this->privErrorLog(self::ERR_INVALID_PARAMETER, "Invalid variable type p_filelist");

            return 0;

        }

        // Reformat the string list

        if (sizeof($v_string_list) != 0) {

            foreach ($v_string_list as $v_string) {

                if ($v_string != '') {

                  $v_att_list[][self::ATT_FILE_NAME] = $v_string;

                } else { }

            }

        }

        // For each file in the list check the attributes

        $v_supported_attributes = array (

            self::ATT_FILE_NAME           => 'mandatory',

            self::ATT_FILE_NEW_SHORT_NAME => 'optional',

            self::ATT_FILE_NEW_FULL_NAME  => 'optional',

            self::ATT_FILE_MTIME          => 'optional',

            self::ATT_FILE_CONTENT        => 'optional',

            self::ATT_FILE_COMMENT        => 'optional',

        );

        foreach ($v_att_list as $v_entry) {

            $v_result = $this->privFileDescrParseAtt(

                $v_entry,

                $v_filedescr_list[],

                $v_options,

                $v_supported_attributes

            );

            if ($v_result != 1) {

                return 0;

            }

        }

        // Expand the filelist (expand directories)

        $v_result = $this->privFileDescrExpand($v_filedescr_list, $v_options);

        if ($v_result != 1) {

            return 0;

        }

        // Call the create fct

        $v_result = $this->privCreate($v_filedescr_list, $p_result_list, $v_options);

        if ($v_result != 1) {

            return 0;

        }

        return $p_result_list;

    }

  // --------------------------------------------------------------------------------

  // --------------------------------------------------------------------------------

  // Function :

  //   add($p_filelist, $p_add_dir="", $p_remove_dir="")

  //   add($p_filelist, $p_option, $p_option_value, ...)

  // Description :

  //   This method supports two synopsis. The first one is historical.

  //   This methods add the list of files in an existing archive.

  //   If a file with the same name already exists, it is added at the end of the

  //   archive, the first one is still present.

  //   If the archive does not exist, it is created.

  // Parameters :

  //   $p_filelist : An array containing file or directory names, or

  //                 a string containing one filename or one directory name, or

  //                 a string containing a list of filenames and/or directory

  //                 names separated by spaces.

  //   $p_add_dir : A path to add before the real path of the archived file,

  //                in order to have it memorized in the archive.

  //   $p_remove_dir : A path to remove from the real path of the file to archive,

  //                   in order to have a shorter path memorized in the archive.

  //                   When $p_add_dir and $p_remove_dir are set, $p_remove_dir

  //                   is removed first, before $p_add_dir is added.

  // Options :

  //   self::OPT_ADD_PATH :

  //   self::OPT_REMOVE_PATH :

  //   self::OPT_REMOVE_ALL_PATH :

  //   self::OPT_COMMENT :

  //   self::OPT_ADD_COMMENT :

  //   self::OPT_PREPEND_COMMENT :

  //   self::CB_PRE_ADD :

  //   self::CB_POST_ADD :

  // Return Values :

  //   0 on failure,

  //   The list of the added files, with a status of the add action.

  //   (see self::listContent() for list entry format)

  // --------------------------------------------------------------------------------

    public function add($p_filelist)

    {

        $v_result = 1;

        // Reset the error handler

        $this->privErrorReset();

        // Set default values

        $v_options = array();

        $v_options[self::OPT_NO_COMPRESSION] = false;

        // Look for variable options arguments

        $v_size = func_num_args();

        // Look for arguments

        if ($v_size > 1) {

            // Get the arguments

            $v_arg_list = func_get_args();

            // Remove form the options list the first argument

            array_shift($v_arg_list);

            $v_size--;

            // Look for first arg

            if ((is_integer($v_arg_list[0])) && ($v_arg_list[0] > 77000)) {

                // Parse the options

                $v_result = $this->privParseOptions(

                    $v_arg_list,

                    $v_size,

                    $v_options,

                    array (

                        self::OPT_REMOVE_PATH         => 'optional',

                        self::OPT_REMOVE_ALL_PATH     => 'optional',

                        self::OPT_ADD_PATH            => 'optional',

                        self::CB_PRE_ADD              => 'optional',

                        self::CB_POST_ADD             => 'optional',

                        self::OPT_NO_COMPRESSION      => 'optional',

                        self::OPT_COMMENT             => 'optional',

                        self::OPT_ADD_COMMENT         => 'optional',

                        self::OPT_PREPEND_COMMENT     => 'optional',

                        self::OPT_TEMP_FILE_THRESHOLD => 'optional',

                        self::OPT_TEMP_FILE_ON        => 'optional',

                        //self::OPT_CRYPT               => 'optional',

                        self::OPT_TEMP_FILE_OFF       => 'optional'

                    )

                );

                if ($v_result != 1) {

                    return 0;

                }

            } else {

                // Look for 2 args

                // Here we need to support the first historic synopsis of the

                // method.

                // Get the first argument

                $v_options[self::OPT_ADD_PATH] = $v_add_path = $v_arg_list[0];

                // Look for the optional second argument

                if ($v_size == 2) {

                    $v_options[self::OPT_REMOVE_PATH] = $v_arg_list[1];

                } else if ($v_size > 2) {

                    // Error log

                    $this->privErrorLog(self::ERR_INVALID_PARAMETER, "Invalid number / type of arguments");

                    return 0;

                }

            }

        }

        // Look for default option values

        $this->privOptionDefaultThreshold($v_options);

        // Init

        $v_string_list = array();

        $v_att_list = array();

        $v_filedescr_list = array();

        $p_result_list = array();

        // Look if the $p_filelist is really an array

        if (is_array($p_filelist)) {

            // Look if the first element is also an array

            // This will mean that this is a file description entry

            if (isset($p_filelist[0]) && is_array($p_filelist[0])) {

                $v_att_list = $p_filelist;

            } else {

                // The list is a list of string names

                $v_string_list = $p_filelist;

            }

        } else if (is_string($p_filelist)) {

            // Look if the $p_filelist is a string

            // Create a list from the string

            $v_string_list = explode(self::SEPARATOR, $p_filelist);

        } else {

        // Invalid variable type for $p_filelist

            $this->privErrorLog(self::ERR_INVALID_PARAMETER, "Invalid variable type '".gettype($p_filelist)."' for p_filelist");

            return 0;

        }

        // Reformat the string list

        if (sizeof($v_string_list) != 0) {

            foreach ($v_string_list as $v_string) {

                $v_att_list[][self::ATT_FILE_NAME] = $v_string;

            }

        }

        // For each file in the list check the attributes

        $v_supported_attributes = array(

            self::ATT_FILE_NAME           => 'mandatory',

            self::ATT_FILE_NEW_SHORT_NAME => 'optional',

            self::ATT_FILE_NEW_FULL_NAME  => 'optional',

            self::ATT_FILE_MTIME          => 'optional',

            self::ATT_FILE_CONTENT        => 'optional',

            self::ATT_FILE_COMMENT        => 'optional'

        );

        foreach ($v_att_list as $v_entry) {

            $v_result = $this->privFileDescrParseAtt(

                $v_entry,

                $v_filedescr_list[],

                $v_options,

                $v_supported_attributes

            );

            if ($v_result != 1) {

                return 0;

            }

        }

        // Expand the filelist (expand directories)

        $v_result = $this->privFileDescrExpand($v_filedescr_list, $v_options);

        if ($v_result != 1) {

            return 0;

        }

        // Call the create fct

        $v_result = $this->privAdd($v_filedescr_list, $p_result_list, $v_options);

        if ($v_result != 1) {

            return 0;

        }

        return $p_result_list;

    }

  // --------------------------------------------------------------------------------

  // --------------------------------------------------------------------------------

  // Function : listContent()

  // Description :

  //   This public method, gives the list of the files and directories, with their

  //   properties.

  //   The properties of each entries in the list are (used also in other functions) :

  //     filename : Name of the file. For a create or add action it is the filename

  //                given by the user. For an extract function it is 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 headers overhead)

  //     mtime : Last known modification date of the file (UNIX timestamp)

  //     comment : Comment associated with the file

  //     folder : true | false

  //     index : index of the file in the archive

  //     status : status of the action (depending of the action) :

  //              Values are :

  //                ok : OK !

  //                filtered : the file / dir is not extracted (filtered by user)

  //                already_a_directory : the file can not be extracted because a

  //                                      directory with the same name already exists

  //                write_protected : the file can not 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 exists

  //                path_creation_fail : the file is not extracted because the folder

  //                                     does not exist and can not 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 action error on a file, the error is only logged in the file status.

  // Return Values :

  //   0 on an unrecoverable failure,

  //   The list of the files in the archive.

  // --------------------------------------------------------------------------------

    public function listContent()

    {

        $v_result = 1;

        // Reset the error handler

        $this->privErrorReset();

        // Check archive

        if (!$this->privCheckFormat()) {

            return(0);

        }

        // Call the extracting fct

        $p_list = array();

        if (($v_result = $this->privList($p_list)) != 1) {

            unset($p_list);

            return(0);

        }

        return $p_list;

    }

  // --------------------------------------------------------------------------------

  // --------------------------------------------------------------------------------

  // Function :

  //   extract($p_path="./", $p_remove_path="")

  //   extract([$p_option, $p_option_value, ...])

  // Description :

  //   This method supports two synopsis. The first one is historical.

  //   This method extract all the files / directories from the archive to the

  //   folder indicated in $p_path.

  //   If you want to ignore the 'root' part of path of the memorized files

  //   you can indicate this in the optional $p_remove_path parameter.

  //   By default, if a newer file with the same name already exists, the

  //   file is not extracted.

  //

  //   If both PCLZIP_OPT_PATH and PCLZIP_OPT_ADD_PATH aoptions

  //   are used, the path indicated in PCLZIP_OPT_ADD_PATH is append

  //   at the end of the path value of PCLZIP_OPT_PATH.

  // Parameters :

  //   $p_path : Path where the files and directories are to be extracted

  //   $p_remove_path : First part ('root' part) of the memorized path

  //                    (if any similar) to remove while extracting.

  // Options :

  //   PCLZIP_OPT_PATH :

  //   PCLZIP_OPT_ADD_PATH :

  //   PCLZIP_OPT_REMOVE_PATH :

  //   PCLZIP_OPT_REMOVE_ALL_PATH :

  //   PCLZIP_CB_PRE_EXTRACT :

  //   PCLZIP_CB_POST_EXTRACT :

  // Return Values :

  //   0 or a negative value on failure,

  //   The list of the extracted files, with a status of the action.

  //   (see PclZip::listContent() for list entry format)

  // --------------------------------------------------------------------------------

    public function extract()

    {

        $v_result = 1;

        // Reset the error handler

        $this->privErrorReset();

        // Check archive

        if (!$this->privCheckFormat()) {

            return(0);

        }

        // Set default values

        $v_options         = array();

        $v_path            = '';

        $v_remove_path     = "";

        $v_remove_all_path = false;

        // Look for variable options arguments

        $v_size = func_num_args();

        // Default values for option

        $v_options[self::OPT_EXTRACT_AS_STRING] = false;

        // Look for arguments

        if ($v_size > 0) {

            // Get the arguments

            $v_arg_list = func_get_args();

            // Look for first arg

            if ((is_integer($v_arg_list[0])) && ($v_arg_list[0] > 77000)) {

                // Parse the options

                $v_result = $this->privParseOptions(

                    $v_arg_list,

                    $v_size,

                    $v_options,

                    array (

                        self::OPT_PATH                    => 'optional',

                        self::OPT_REMOVE_PATH             => 'optional',

                        self::OPT_REMOVE_ALL_PATH         => 'optional',

                        self::OPT_ADD_PATH                => 'optional',

                        self::CB_PRE_EXTRACT              => 'optional',

                        self::CB_POST_EXTRACT             => 'optional',

                        self::OPT_SET_CHMOD               => 'optional',

                        self::OPT_BY_NAME                 => 'optional',

                        self::OPT_BY_EREG                 => 'optional',

                        self::OPT_BY_PREG                 => 'optional',

                        self::OPT_BY_INDEX                => 'optional',

                        self::OPT_EXTRACT_AS_STRING       => 'optional',

                        self::OPT_EXTRACT_IN_OUTPUT       => 'optional',

                        self::OPT_REPLACE_NEWER           => 'optional',

                        self::OPT_STOP_ON_ERROR           => 'optional',

                        self::OPT_EXTRACT_DIR_RESTRICTION => 'optional',

                        self::OPT_TEMP_FILE_THRESHOLD     => 'optional',

                        self::OPT_TEMP_FILE_ON            => 'optional',

                        self::OPT_TEMP_FILE_OFF           => 'optional'

                    )

                );

                if ($v_result != 1) {

                    return 0;

                }

                // Set the arguments

                if (isset($v_options[self::OPT_PATH])) {

                    $v_path = $v_options[self::OPT_PATH];

                }

                if (isset($v_options[self::OPT_REMOVE_PATH])) {

                    $v_remove_path = $v_options[self::OPT_REMOVE_PATH];

                }

                if (isset($v_options[self::OPT_REMOVE_ALL_PATH])) {

                    $v_remove_all_path = $v_options[self::OPT_REMOVE_ALL_PATH];

                }

                if (isset($v_options[self::OPT_ADD_PATH])) {

                    // Check for '/' in last path char

                    if ((strlen($v_path) > 0) && (substr($v_path, -1) != '/')) {

                        $v_path .= '/';

                    }

                    $v_path .= $v_options[self::OPT_ADD_PATH];

                }

            } else {

                // Look for 2 args

                // Here we need to support the first historic synopsis of the

                // method.

                // Get the first argument

                $v_path = $v_arg_list[0];

                // Look for the optional second argument

                if ($v_size == 2) {

                    $v_remove_path = $v_arg_list[1];

                } else if ($v_size > 2) {

                    // Error log

                    $this->privErrorLog(self::ERR_INVALID_PARAMETER, "Invalid number / type of arguments");

                    return 0;

                }

            }

        }

        // Look for default option values

        $this->privOptionDefaultThreshold($v_options);

        // Trace

        // Call the extracting fct

        $p_list = array();

        $v_result = $this->privExtractByRule(

            $p_list,

            $v_path,

            $v_remove_path,

            $v_remove_all_path,

            $v_options

        );

        if ($v_result < 1) {

            unset($p_list);

            return(0);

        }

        return $p_list;

    }

  // --------------------------------------------------------------------------------

  // --------------------------------------------------------------------------------

  // Function :

  //   extractByIndex($p_index, $p_path="./", $p_remove_path="")

  //   extractByIndex($p_index, [$p_option, $p_option_value, ...])

  // Description :

  //   This method supports two synopsis. The first one is historical.

  //   This method is doing a partial extract of the archive.

  //   The extracted files or folders are identified by their index in the

  //   archive (from 0 to n).

  //   Note that if the index identify a folder, only the folder entry is

  //   extracted, not all the files included in the archive.

  // Parameters :

  //   $p_index : A single index (integer) or a string of indexes of files to

  //              extract. The form of the string is "0,4-6,8-12" with only numbers

  //              and '-' for range or ',' to separate ranges. No spaces or ';'

  //              are allowed.

  //   $p_path : Path where the files and directories are to be extracted

  //   $p_remove_path : First part ('root' part) of the memorized path

  //                    (if any similar) to remove while extracting.

  // Options :

  //   OPT_PATH :

  //   OPT_ADD_PATH :

  //   OPT_REMOVE_PATH :

  //   OPT_REMOVE_ALL_PATH :

  //   OPT_EXTRACT_AS_STRING : The files are extracted as strings and

  //     not as files.

  //     The resulting content is in a new field 'content' in the file

  //     structure.

  //     This option must be used alone (any other options are ignored).

  //   CB_PRE_EXTRACT :

  //   CB_POST_EXTRACT :

  // Return Values :

  //   0 on failure,

  //   The list of the extracted files, with a status of the action.

  //   (see PclZip::listContent() for list entry format)

  // --------------------------------------------------------------------------------

  //function extractByIndex($p_index, options...)

    public function extractByIndex($p_index)

    {

        $v_result = 1;

        // Reset the error handler

        $this->privErrorReset();

        // Check archive

        if (!$this->privCheckFormat()) {