2 // --------------------------------------------------------------------------------
3 // PhpConcept Library - Zip Module 2.8.2
4 // --------------------------------------------------------------------------------
5 // License GNU/LGPL - Vincent Blavet - August 2009
6 // http://www.phpconcept.net
7 // --------------------------------------------------------------------------------
10 // PclZip is a PHP library that manage ZIP archives.
11 // So far tests show that archives generated by PclZip are readable by
12 // WinZip application and other tools.
15 // See readme.txt and http://www.phpconcept.net
18 // This library and the associated files are non commercial, non professional
20 // It should not have unexpected results. However if any damage is caused by
21 // this software the author can not be responsible.
22 // The use of this software is at the risk of the user.
24 // --------------------------------------------------------------------------------
25 // $Id: pclzip.lib.php,v 1.60 2009/09/30 21:01:04 vblavet Exp $
26 // --------------------------------------------------------------------------------
29 if (!defined('PCLZIP_READ_BLOCK_SIZE')) {
30 define( 'PCLZIP_READ_BLOCK_SIZE', 2048 );
33 // ----- File list separator
34 // In version 1.x of PclZip, the separator for file list is a space
35 // (which is not a very smart choice, specifically for windows paths !).
36 // A better separator should be a comma (,). This constant gives you the
37 // abilty to change that.
38 // However notice that changing this value, may have impact on existing
39 // scripts, using space separated filenames.
40 // Recommanded values for compatibility with older versions :
41 //define( 'PCLZIP_SEPARATOR', ' ' );
42 // Recommanded values for smart separation of filenames.
43 if (!defined('PCLZIP_SEPARATOR')) {
44 define( 'PCLZIP_SEPARATOR', ',' );
47 // ----- Error configuration
48 // 0 : PclZip Class integrated error handling
49 // 1 : PclError external library error handling. By enabling this
50 // you must ensure that you have included PclError library.
51 // [2,...] : reserved for futur use
52 if (!defined('PCLZIP_ERROR_EXTERNAL')) {
53 define( 'PCLZIP_ERROR_EXTERNAL', 0 );
56 // ----- Optional static temporary directory
57 // By default temporary files are generated in the script current
60 // - MUST BE terminated by a '/'.
61 // - MUST be a valid, already created directory
63 // define( 'PCLZIP_TEMPORARY_DIR', '/temp/' );
64 // define( 'PCLZIP_TEMPORARY_DIR', 'C:/Temp/' );
65 if (!defined('PCLZIP_TEMPORARY_DIR')) {
66 define( 'PCLZIP_TEMPORARY_DIR', '' );
69 // ----- Optional threshold ratio for use of temporary files
70 // Pclzip sense the size of the file to add/extract and decide to
71 // use or not temporary file. The algorythm is looking for
72 // memory_limit of PHP and apply a ratio.
73 // threshold = memory_limit * ratio.
74 // Recommended values are under 0.5. Default 0.47.
76 // define( 'PCLZIP_TEMPORARY_FILE_RATIO', 0.5 );
77 if (!defined('PCLZIP_TEMPORARY_FILE_RATIO')) {
78 define( 'PCLZIP_TEMPORARY_FILE_RATIO', 0.47 );
81 // --------------------------------------------------------------------------------
82 // ***** UNDER THIS LINE NOTHING NEEDS TO BE MODIFIED *****
83 // --------------------------------------------------------------------------------
85 // ----- Global variables
86 $g_pclzip_version = "2.8.2";
89 // -1 : Unable to open file in binary write mode
90 // -2 : Unable to open file in binary read mode
91 // -3 : Invalid parameters
92 // -4 : File does not exist
93 // -5 : Filename is too long (max. 255)
94 // -6 : Not a valid zip file
95 // -7 : Invalid extracted file size
96 // -8 : Unable to create directory
97 // -9 : Invalid archive extension
98 // -10 : Invalid archive format
99 // -11 : Unable to delete file (unlink)
100 // -12 : Unable to rename file (rename)
101 // -13 : Invalid header checksum
102 // -14 : Invalid archive size
103 define( 'PCLZIP_ERR_USER_ABORTED', 2 );
104 define( 'PCLZIP_ERR_NO_ERROR', 0 );
105 define( 'PCLZIP_ERR_WRITE_OPEN_FAIL', -1 );
106 define( 'PCLZIP_ERR_READ_OPEN_FAIL', -2 );
107 define( 'PCLZIP_ERR_INVALID_PARAMETER', -3 );
108 define( 'PCLZIP_ERR_MISSING_FILE', -4 );
109 define( 'PCLZIP_ERR_FILENAME_TOO_LONG', -5 );
110 define( 'PCLZIP_ERR_INVALID_ZIP', -6 );
111 define( 'PCLZIP_ERR_BAD_EXTRACTED_FILE', -7 );
112 define( 'PCLZIP_ERR_DIR_CREATE_FAIL', -8 );
113 define( 'PCLZIP_ERR_BAD_EXTENSION', -9 );
114 define( 'PCLZIP_ERR_BAD_FORMAT', -10 );
115 define( 'PCLZIP_ERR_DELETE_FILE_FAIL', -11 );
116 define( 'PCLZIP_ERR_RENAME_FILE_FAIL', -12 );
117 define( 'PCLZIP_ERR_BAD_CHECKSUM', -13 );
118 define( 'PCLZIP_ERR_INVALID_ARCHIVE_ZIP', -14 );
119 define( 'PCLZIP_ERR_MISSING_OPTION_VALUE', -15 );
120 define( 'PCLZIP_ERR_INVALID_OPTION_VALUE', -16 );
121 define( 'PCLZIP_ERR_ALREADY_A_DIRECTORY', -17 );
122 define( 'PCLZIP_ERR_UNSUPPORTED_COMPRESSION', -18 );
123 define( 'PCLZIP_ERR_UNSUPPORTED_ENCRYPTION', -19 );
124 define( 'PCLZIP_ERR_INVALID_ATTRIBUTE_VALUE', -20 );
125 define( 'PCLZIP_ERR_DIRECTORY_RESTRICTION', -21 );
127 // ----- Options values
128 define( 'PCLZIP_OPT_PATH', 77001 );
129 define( 'PCLZIP_OPT_ADD_PATH', 77002 );
130 define( 'PCLZIP_OPT_REMOVE_PATH', 77003 );
131 define( 'PCLZIP_OPT_REMOVE_ALL_PATH', 77004 );
132 define( 'PCLZIP_OPT_SET_CHMOD', 77005 );
133 define( 'PCLZIP_OPT_EXTRACT_AS_STRING', 77006 );
134 define( 'PCLZIP_OPT_NO_COMPRESSION', 77007 );
135 define( 'PCLZIP_OPT_BY_NAME', 77008 );
136 define( 'PCLZIP_OPT_BY_INDEX', 77009 );
137 define( 'PCLZIP_OPT_BY_EREG', 77010 );
138 define( 'PCLZIP_OPT_BY_PREG', 77011 );
139 define( 'PCLZIP_OPT_COMMENT', 77012 );
140 define( 'PCLZIP_OPT_ADD_COMMENT', 77013 );
141 define( 'PCLZIP_OPT_PREPEND_COMMENT', 77014 );
142 define( 'PCLZIP_OPT_EXTRACT_IN_OUTPUT', 77015 );
143 define( 'PCLZIP_OPT_REPLACE_NEWER', 77016 );
144 define( 'PCLZIP_OPT_STOP_ON_ERROR', 77017 );
145 // Having big trouble with crypt. Need to multiply 2 long int
146 // which is not correctly supported by PHP ...
147 //define( 'PCLZIP_OPT_CRYPT', 77018 );
148 define( 'PCLZIP_OPT_EXTRACT_DIR_RESTRICTION', 77019 );
149 define( 'PCLZIP_OPT_TEMP_FILE_THRESHOLD', 77020 );
150 define( 'PCLZIP_OPT_ADD_TEMP_FILE_THRESHOLD', 77020 ); // alias
151 define( 'PCLZIP_OPT_TEMP_FILE_ON', 77021 );
152 define( 'PCLZIP_OPT_ADD_TEMP_FILE_ON', 77021 ); // alias
153 define( 'PCLZIP_OPT_TEMP_FILE_OFF', 77022 );
154 define( 'PCLZIP_OPT_ADD_TEMP_FILE_OFF', 77022 ); // alias
156 // ----- File description attributes
157 define( 'PCLZIP_ATT_FILE_NAME', 79001 );
158 define( 'PCLZIP_ATT_FILE_NEW_SHORT_NAME', 79002 );
159 define( 'PCLZIP_ATT_FILE_NEW_FULL_NAME', 79003 );
160 define( 'PCLZIP_ATT_FILE_MTIME', 79004 );
161 define( 'PCLZIP_ATT_FILE_CONTENT', 79005 );
162 define( 'PCLZIP_ATT_FILE_COMMENT', 79006 );
164 // ----- Call backs values
165 define( 'PCLZIP_CB_PRE_EXTRACT', 78001 );
166 define( 'PCLZIP_CB_POST_EXTRACT', 78002 );
167 define( 'PCLZIP_CB_PRE_ADD', 78003 );
168 define( 'PCLZIP_CB_POST_ADD', 78004 );
170 define( 'PCLZIP_CB_PRE_LIST', 78005 );
171 define( 'PCLZIP_CB_POST_LIST', 78006 );
172 define( 'PCLZIP_CB_PRE_DELETE', 78007 );
173 define( 'PCLZIP_CB_POST_DELETE', 78008 );
176 // --------------------------------------------------------------------------------
179 // PclZip is the class that represent a Zip archive.
180 // The public methods allow the manipulation of the archive.
182 // Attributes must not be accessed directly.
184 // PclZip() : Object creator
185 // create() : Creates the Zip archive
186 // listContent() : List the content of the Zip archive
187 // extract() : Extract the content of the archive
188 // properties() : List the properties of the archive
189 // --------------------------------------------------------------------------------
192 // ----- Filename of the zip file
195 // ----- File descriptor of the zip file
198 // ----- Internal error handling
200 var $error_string = '';
202 // ----- Current status of the magic_quotes_runtime
203 // This value store the php configuration for magic_quotes
204 // The class can then disable the magic_quotes and reset it after
205 var $magic_quotes_status;
207 // --------------------------------------------------------------------------------
208 // Function : PclZip()
210 // Creates a PclZip object and set the name of the associated Zip archive
212 // Note that no real action is taken, if the archive does not exist it is not
213 // created. Use create() for that.
214 // --------------------------------------------------------------------------------
215 function __construct($p_zipname)
218 // ----- Tests the zlib
219 if (!function_exists('gzopen'))
221 die('Abort '.basename(__FILE__).' : Missing zlib extensions');
224 // ----- Set the attributes
225 $this->zipname = $p_zipname;
227 $this->magic_quotes_status = -1;
233 public function PclZip($p_zipname) {
234 self::__construct($p_zipname);
236 // --------------------------------------------------------------------------------
238 // --------------------------------------------------------------------------------
240 // create($p_filelist, $p_add_dir="", $p_remove_dir="")
241 // create($p_filelist, $p_option, $p_option_value, ...)
243 // This method supports two different synopsis. The first one is historical.
244 // This method creates a Zip Archive. The Zip file is created in the
245 // filesystem. The files and directories indicated in $p_filelist
246 // are added in the archive. See the parameters description for the
247 // supported format of $p_filelist.
248 // When a directory is in the list, the directory and its content is added
250 // In this synopsis, the function takes an optional variable list of
251 // options. See bellow the supported options.
253 // $p_filelist : An array containing file or directory names, or
254 // a string containing one filename or one directory name, or
255 // a string containing a list of filenames and/or directory
256 // names separated by spaces.
257 // $p_add_dir : A path to add before the real path of the archived file,
258 // in order to have it memorized in the archive.
259 // $p_remove_dir : A path to remove from the real path of the file to archive,
260 // in order to have a shorter path memorized in the archive.
261 // When $p_add_dir and $p_remove_dir are set, $p_remove_dir
262 // is removed first, before $p_add_dir is added.
264 // PCLZIP_OPT_ADD_PATH :
265 // PCLZIP_OPT_REMOVE_PATH :
266 // PCLZIP_OPT_REMOVE_ALL_PATH :
267 // PCLZIP_OPT_COMMENT :
268 // PCLZIP_CB_PRE_ADD :
269 // PCLZIP_CB_POST_ADD :
272 // The list of the added files, with a status of the add action.
273 // (see PclZip::listContent() for list entry format)
274 // --------------------------------------------------------------------------------
275 function create($p_filelist)
279 // ----- Reset the error handler
280 $this->privErrorReset();
282 // ----- Set default values
283 $v_options = array();
284 $v_options[PCLZIP_OPT_NO_COMPRESSION] = FALSE;
286 // ----- Look for variable options arguments
287 $v_size = func_num_args();
289 // ----- Look for arguments
291 // ----- Get the arguments
292 $v_arg_list = func_get_args();
294 // ----- Remove from the options list the first argument
295 array_shift($v_arg_list);
298 // ----- Look for first arg
299 if ((is_integer($v_arg_list[0])) && ($v_arg_list[0] > 77000)) {
301 // ----- Parse the options
302 $v_result = $this->privParseOptions($v_arg_list, $v_size, $v_options,
303 array (PCLZIP_OPT_REMOVE_PATH => 'optional',
304 PCLZIP_OPT_REMOVE_ALL_PATH => 'optional',
305 PCLZIP_OPT_ADD_PATH => 'optional',
306 PCLZIP_CB_PRE_ADD => 'optional',
307 PCLZIP_CB_POST_ADD => 'optional',
308 PCLZIP_OPT_NO_COMPRESSION => 'optional',
309 PCLZIP_OPT_COMMENT => 'optional',
310 PCLZIP_OPT_TEMP_FILE_THRESHOLD => 'optional',
311 PCLZIP_OPT_TEMP_FILE_ON => 'optional',
312 PCLZIP_OPT_TEMP_FILE_OFF => 'optional'
313 //, PCLZIP_OPT_CRYPT => 'optional'
315 if ($v_result != 1) {
320 // ----- Look for 2 args
321 // Here we need to support the first historic synopsis of the
325 // ----- Get the first argument
326 $v_options[PCLZIP_OPT_ADD_PATH] = $v_arg_list[0];
328 // ----- Look for the optional second argument
330 $v_options[PCLZIP_OPT_REMOVE_PATH] = $v_arg_list[1];
332 else if ($v_size > 2) {
333 PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER,
334 "Invalid number / type of arguments");
340 // ----- Look for default option values
341 $this->privOptionDefaultThreshold($v_options);
344 $v_string_list = array();
345 $v_att_list = array();
346 $v_filedescr_list = array();
347 $p_result_list = array();
349 // ----- Look if the $p_filelist is really an array
350 if (is_array($p_filelist)) {
352 // ----- Look if the first element is also an array
353 // This will mean that this is a file description entry
354 if (isset($p_filelist[0]) && is_array($p_filelist[0])) {
355 $v_att_list = $p_filelist;
358 // ----- The list is a list of string names
360 $v_string_list = $p_filelist;
364 // ----- Look if the $p_filelist is a string
365 else if (is_string($p_filelist)) {
366 // ----- Create a list from the string
367 $v_string_list = explode(PCLZIP_SEPARATOR, $p_filelist);
370 // ----- Invalid variable type for $p_filelist
372 PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Invalid variable type p_filelist");
376 // ----- Reformat the string list
377 if (sizeof($v_string_list) != 0) {
378 foreach ($v_string_list as $v_string) {
379 if ($v_string != '') {
380 $v_att_list[][PCLZIP_ATT_FILE_NAME] = $v_string;
387 // ----- For each file in the list check the attributes
388 $v_supported_attributes
389 = array ( PCLZIP_ATT_FILE_NAME => 'mandatory'
390 ,PCLZIP_ATT_FILE_NEW_SHORT_NAME => 'optional'
391 ,PCLZIP_ATT_FILE_NEW_FULL_NAME => 'optional'
392 ,PCLZIP_ATT_FILE_MTIME => 'optional'
393 ,PCLZIP_ATT_FILE_CONTENT => 'optional'
394 ,PCLZIP_ATT_FILE_COMMENT => 'optional'
396 foreach ($v_att_list as $v_entry) {
397 $v_result = $this->privFileDescrParseAtt($v_entry,
400 $v_supported_attributes);
401 if ($v_result != 1) {
406 // ----- Expand the filelist (expand directories)
407 $v_result = $this->privFileDescrExpand($v_filedescr_list, $v_options);
408 if ($v_result != 1) {
412 // ----- Call the create fct
413 $v_result = $this->privCreate($v_filedescr_list, $p_result_list, $v_options);
414 if ($v_result != 1) {
419 return $p_result_list;
421 // --------------------------------------------------------------------------------
423 // --------------------------------------------------------------------------------
425 // add($p_filelist, $p_add_dir="", $p_remove_dir="")
426 // add($p_filelist, $p_option, $p_option_value, ...)
428 // This method supports two synopsis. The first one is historical.
429 // This methods add the list of files in an existing archive.
430 // If a file with the same name already exists, it is added at the end of the
431 // archive, the first one is still present.
432 // If the archive does not exist, it is created.
434 // $p_filelist : An array containing file or directory names, or
435 // a string containing one filename or one directory name, or
436 // a string containing a list of filenames and/or directory
437 // names separated by spaces.
438 // $p_add_dir : A path to add before the real path of the archived file,
439 // in order to have it memorized in the archive.
440 // $p_remove_dir : A path to remove from the real path of the file to archive,
441 // in order to have a shorter path memorized in the archive.
442 // When $p_add_dir and $p_remove_dir are set, $p_remove_dir
443 // is removed first, before $p_add_dir is added.
445 // PCLZIP_OPT_ADD_PATH :
446 // PCLZIP_OPT_REMOVE_PATH :
447 // PCLZIP_OPT_REMOVE_ALL_PATH :
448 // PCLZIP_OPT_COMMENT :
449 // PCLZIP_OPT_ADD_COMMENT :
450 // PCLZIP_OPT_PREPEND_COMMENT :
451 // PCLZIP_CB_PRE_ADD :
452 // PCLZIP_CB_POST_ADD :
455 // The list of the added files, with a status of the add action.
456 // (see PclZip::listContent() for list entry format)
457 // --------------------------------------------------------------------------------
458 function add($p_filelist)
462 // ----- Reset the error handler
463 $this->privErrorReset();
465 // ----- Set default values
466 $v_options = array();
467 $v_options[PCLZIP_OPT_NO_COMPRESSION] = FALSE;
469 // ----- Look for variable options arguments
470 $v_size = func_num_args();
472 // ----- Look for arguments
474 // ----- Get the arguments
475 $v_arg_list = func_get_args();
477 // ----- Remove form the options list the first argument
478 array_shift($v_arg_list);
481 // ----- Look for first arg
482 if ((is_integer($v_arg_list[0])) && ($v_arg_list[0] > 77000)) {
484 // ----- Parse the options
485 $v_result = $this->privParseOptions($v_arg_list, $v_size, $v_options,
486 array (PCLZIP_OPT_REMOVE_PATH => 'optional',
487 PCLZIP_OPT_REMOVE_ALL_PATH => 'optional',
488 PCLZIP_OPT_ADD_PATH => 'optional',
489 PCLZIP_CB_PRE_ADD => 'optional',
490 PCLZIP_CB_POST_ADD => 'optional',
491 PCLZIP_OPT_NO_COMPRESSION => 'optional',
492 PCLZIP_OPT_COMMENT => 'optional',
493 PCLZIP_OPT_ADD_COMMENT => 'optional',
494 PCLZIP_OPT_PREPEND_COMMENT => 'optional',
495 PCLZIP_OPT_TEMP_FILE_THRESHOLD => 'optional',
496 PCLZIP_OPT_TEMP_FILE_ON => 'optional',
497 PCLZIP_OPT_TEMP_FILE_OFF => 'optional'
498 //, PCLZIP_OPT_CRYPT => 'optional'
500 if ($v_result != 1) {
505 // ----- Look for 2 args
506 // Here we need to support the first historic synopsis of the
510 // ----- Get the first argument
511 $v_options[PCLZIP_OPT_ADD_PATH] = $v_add_path = $v_arg_list[0];
513 // ----- Look for the optional second argument
515 $v_options[PCLZIP_OPT_REMOVE_PATH] = $v_arg_list[1];
517 else if ($v_size > 2) {
519 PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Invalid number / type of arguments");
527 // ----- Look for default option values
528 $this->privOptionDefaultThreshold($v_options);
531 $v_string_list = array();
532 $v_att_list = array();
533 $v_filedescr_list = array();
534 $p_result_list = array();
536 // ----- Look if the $p_filelist is really an array
537 if (is_array($p_filelist)) {
539 // ----- Look if the first element is also an array
540 // This will mean that this is a file description entry
541 if (isset($p_filelist[0]) && is_array($p_filelist[0])) {
542 $v_att_list = $p_filelist;
545 // ----- The list is a list of string names
547 $v_string_list = $p_filelist;
551 // ----- Look if the $p_filelist is a string
552 else if (is_string($p_filelist)) {
553 // ----- Create a list from the string
554 $v_string_list = explode(PCLZIP_SEPARATOR, $p_filelist);
557 // ----- Invalid variable type for $p_filelist
559 PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Invalid variable type '".gettype($p_filelist)."' for p_filelist");
563 // ----- Reformat the string list
564 if (sizeof($v_string_list) != 0) {
565 foreach ($v_string_list as $v_string) {
566 $v_att_list[][PCLZIP_ATT_FILE_NAME] = $v_string;
570 // ----- For each file in the list check the attributes
571 $v_supported_attributes
572 = array ( PCLZIP_ATT_FILE_NAME => 'mandatory'
573 ,PCLZIP_ATT_FILE_NEW_SHORT_NAME => 'optional'
574 ,PCLZIP_ATT_FILE_NEW_FULL_NAME => 'optional'
575 ,PCLZIP_ATT_FILE_MTIME => 'optional'
576 ,PCLZIP_ATT_FILE_CONTENT => 'optional'
577 ,PCLZIP_ATT_FILE_COMMENT => 'optional'
579 foreach ($v_att_list as $v_entry) {
580 $v_result = $this->privFileDescrParseAtt($v_entry,
583 $v_supported_attributes);
584 if ($v_result != 1) {
589 // ----- Expand the filelist (expand directories)
590 $v_result = $this->privFileDescrExpand($v_filedescr_list, $v_options);
591 if ($v_result != 1) {
595 // ----- Call the create fct
596 $v_result = $this->privAdd($v_filedescr_list, $p_result_list, $v_options);
597 if ($v_result != 1) {
602 return $p_result_list;
604 // --------------------------------------------------------------------------------
606 // --------------------------------------------------------------------------------
607 // Function : listContent()
609 // This public method, gives the list of the files and directories, with their
611 // The properties of each entries in the list are (used also in other functions) :
612 // filename : Name of the file. For a create or add action it is the filename
613 // given by the user. For an extract function it is the filename
614 // of the extracted file.
615 // stored_filename : Name of the file / directory stored in the archive.
616 // size : Size of the stored file.
617 // compressed_size : Size of the file's data compressed in the archive
618 // (without the headers overhead)
619 // mtime : Last known modification date of the file (UNIX timestamp)
620 // comment : Comment associated with the file
621 // folder : true | false
622 // index : index of the file in the archive
623 // status : status of the action (depending of the action) :
626 // filtered : the file / dir is not extracted (filtered by user)
627 // already_a_directory : the file can not be extracted because a
628 // directory with the same name already exists
629 // write_protected : the file can not be extracted because a file
630 // with the same name already exists and is
632 // newer_exist : the file was not extracted because a newer file exists
633 // path_creation_fail : the file is not extracted because the folder
634 // does not exist and can not be created
635 // write_error : the file was not extracted because there was a
636 // error while writing the file
637 // read_error : the file was not extracted because there was a error
638 // while reading the file
639 // invalid_header : the file was not extracted because of an archive
640 // format error (bad file header)
641 // Note that each time a method can continue operating when there
642 // is an action error on a file, the error is only logged in the file status.
644 // 0 on an unrecoverable failure,
645 // The list of the files in the archive.
646 // --------------------------------------------------------------------------------
647 function listContent()
651 // ----- Reset the error handler
652 $this->privErrorReset();
654 // ----- Check archive
655 if (!$this->privCheckFormat()) {
659 // ----- Call the extracting fct
661 if (($v_result = $this->privList($p_list)) != 1)
670 // --------------------------------------------------------------------------------
672 // --------------------------------------------------------------------------------
674 // extract($p_path="./", $p_remove_path="")
675 // extract([$p_option, $p_option_value, ...])
677 // This method supports two synopsis. The first one is historical.
678 // This method extract all the files / directories from the archive to the
679 // folder indicated in $p_path.
680 // If you want to ignore the 'root' part of path of the memorized files
681 // you can indicate this in the optional $p_remove_path parameter.
682 // By default, if a newer file with the same name already exists, the
683 // file is not extracted.
685 // If both PCLZIP_OPT_PATH and PCLZIP_OPT_ADD_PATH aoptions
686 // are used, the path indicated in PCLZIP_OPT_ADD_PATH is append
687 // at the end of the path value of PCLZIP_OPT_PATH.
689 // $p_path : Path where the files and directories are to be extracted
690 // $p_remove_path : First part ('root' part) of the memorized path
691 // (if any similar) to remove while extracting.
694 // PCLZIP_OPT_ADD_PATH :
695 // PCLZIP_OPT_REMOVE_PATH :
696 // PCLZIP_OPT_REMOVE_ALL_PATH :
697 // PCLZIP_CB_PRE_EXTRACT :
698 // PCLZIP_CB_POST_EXTRACT :
700 // 0 or a negative value on failure,
701 // The list of the extracted files, with a status of the action.
702 // (see PclZip::listContent() for list entry format)
703 // --------------------------------------------------------------------------------
708 // ----- Reset the error handler
709 $this->privErrorReset();
711 // ----- Check archive
712 if (!$this->privCheckFormat()) {
716 // ----- Set default values
717 $v_options = array();
721 $v_remove_all_path = false;
723 // ----- Look for variable options arguments
724 $v_size = func_num_args();
726 // ----- Default values for option
727 $v_options[PCLZIP_OPT_EXTRACT_AS_STRING] = FALSE;
729 // ----- Look for arguments
731 // ----- Get the arguments
732 $v_arg_list = func_get_args();
734 // ----- Look for first arg
735 if ((is_integer($v_arg_list[0])) && ($v_arg_list[0] > 77000)) {
737 // ----- Parse the options
738 $v_result = $this->privParseOptions($v_arg_list, $v_size, $v_options,
739 array (PCLZIP_OPT_PATH => 'optional',
740 PCLZIP_OPT_REMOVE_PATH => 'optional',
741 PCLZIP_OPT_REMOVE_ALL_PATH => 'optional',
742 PCLZIP_OPT_ADD_PATH => 'optional',
743 PCLZIP_CB_PRE_EXTRACT => 'optional',
744 PCLZIP_CB_POST_EXTRACT => 'optional',
745 PCLZIP_OPT_SET_CHMOD => 'optional',
746 PCLZIP_OPT_BY_NAME => 'optional',
747 PCLZIP_OPT_BY_EREG => 'optional',
748 PCLZIP_OPT_BY_PREG => 'optional',
749 PCLZIP_OPT_BY_INDEX => 'optional',
750 PCLZIP_OPT_EXTRACT_AS_STRING => 'optional',
751 PCLZIP_OPT_EXTRACT_IN_OUTPUT => 'optional',
752 PCLZIP_OPT_REPLACE_NEWER => 'optional'
753 ,PCLZIP_OPT_STOP_ON_ERROR => 'optional'
754 ,PCLZIP_OPT_EXTRACT_DIR_RESTRICTION => 'optional',
755 PCLZIP_OPT_TEMP_FILE_THRESHOLD => 'optional',
756 PCLZIP_OPT_TEMP_FILE_ON => 'optional',
757 PCLZIP_OPT_TEMP_FILE_OFF => 'optional'
759 if ($v_result != 1) {
763 // ----- Set the arguments
764 if (isset($v_options[PCLZIP_OPT_PATH])) {
765 $v_path = $v_options[PCLZIP_OPT_PATH];
767 if (isset($v_options[PCLZIP_OPT_REMOVE_PATH])) {
768 $v_remove_path = $v_options[PCLZIP_OPT_REMOVE_PATH];
770 if (isset($v_options[PCLZIP_OPT_REMOVE_ALL_PATH])) {
771 $v_remove_all_path = $v_options[PCLZIP_OPT_REMOVE_ALL_PATH];
773 if (isset($v_options[PCLZIP_OPT_ADD_PATH])) {
774 // ----- Check for '/' in last path char
775 if ((strlen($v_path) > 0) && (substr($v_path, -1) != '/')) {
778 $v_path .= $v_options[PCLZIP_OPT_ADD_PATH];
782 // ----- Look for 2 args
783 // Here we need to support the first historic synopsis of the
787 // ----- Get the first argument
788 $v_path = $v_arg_list[0];
790 // ----- Look for the optional second argument
792 $v_remove_path = $v_arg_list[1];
794 else if ($v_size > 2) {
796 PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Invalid number / type of arguments");
804 // ----- Look for default option values
805 $this->privOptionDefaultThreshold($v_options);
809 // ----- Call the extracting fct
811 $v_result = $this->privExtractByRule($p_list, $v_path, $v_remove_path,
812 $v_remove_all_path, $v_options);
821 // --------------------------------------------------------------------------------
824 // --------------------------------------------------------------------------------
826 // extractByIndex($p_index, $p_path="./", $p_remove_path="")
827 // extractByIndex($p_index, [$p_option, $p_option_value, ...])
829 // This method supports two synopsis. The first one is historical.
830 // This method is doing a partial extract of the archive.
831 // The extracted files or folders are identified by their index in the
832 // archive (from 0 to n).
833 // Note that if the index identify a folder, only the folder entry is
834 // extracted, not all the files included in the archive.
836 // $p_index : A single index (integer) or a string of indexes of files to
837 // extract. The form of the string is "0,4-6,8-12" with only numbers
838 // and '-' for range or ',' to separate ranges. No spaces or ';'
840 // $p_path : Path where the files and directories are to be extracted
841 // $p_remove_path : First part ('root' part) of the memorized path
842 // (if any similar) to remove while extracting.
845 // PCLZIP_OPT_ADD_PATH :
846 // PCLZIP_OPT_REMOVE_PATH :
847 // PCLZIP_OPT_REMOVE_ALL_PATH :
848 // PCLZIP_OPT_EXTRACT_AS_STRING : The files are extracted as strings and
850 // The resulting content is in a new field 'content' in the file
852 // This option must be used alone (any other options are ignored).
853 // PCLZIP_CB_PRE_EXTRACT :
854 // PCLZIP_CB_POST_EXTRACT :
857 // The list of the extracted files, with a status of the action.
858 // (see PclZip::listContent() for list entry format)
859 // --------------------------------------------------------------------------------
860 //function extractByIndex($p_index, options...)
861 function extractByIndex($p_index)
865 // ----- Reset the error handler
866 $this->privErrorReset();
868 // ----- Check archive
869 if (!$this->privCheckFormat()) {
873 // ----- Set default values
874 $v_options = array();
878 $v_remove_all_path = false;
880 // ----- Look for variable options arguments
881 $v_size = func_num_args();
883 // ----- Default values for option
884 $v_options[PCLZIP_OPT_EXTRACT_AS_STRING] = FALSE;
886 // ----- Look for arguments
888 // ----- Get the arguments
889 $v_arg_list = func_get_args();
891 // ----- Remove form the options list the first argument
892 array_shift($v_arg_list);
895 // ----- Look for first arg
896 if ((is_integer($v_arg_list[0])) && ($v_arg_list[0] > 77000)) {
898 // ----- Parse the options
899 $v_result = $this->privParseOptions($v_arg_list, $v_size, $v_options,
900 array (PCLZIP_OPT_PATH => 'optional',
901 PCLZIP_OPT_REMOVE_PATH => 'optional',
902 PCLZIP_OPT_REMOVE_ALL_PATH => 'optional',
903 PCLZIP_OPT_EXTRACT_AS_STRING => 'optional',
904 PCLZIP_OPT_ADD_PATH => 'optional',
905 PCLZIP_CB_PRE_EXTRACT => 'optional',
906 PCLZIP_CB_POST_EXTRACT => 'optional',
907 PCLZIP_OPT_SET_CHMOD => 'optional',
908 PCLZIP_OPT_REPLACE_NEWER => 'optional'
909 ,PCLZIP_OPT_STOP_ON_ERROR => 'optional'
910 ,PCLZIP_OPT_EXTRACT_DIR_RESTRICTION => 'optional',
911 PCLZIP_OPT_TEMP_FILE_THRESHOLD => 'optional',
912 PCLZIP_OPT_TEMP_FILE_ON => 'optional',
913 PCLZIP_OPT_TEMP_FILE_OFF => 'optional'
915 if ($v_result != 1) {
919 // ----- Set the arguments
920 if (isset($v_options[PCLZIP_OPT_PATH])) {
921 $v_path = $v_options[PCLZIP_OPT_PATH];
923 if (isset($v_options[PCLZIP_OPT_REMOVE_PATH])) {
924 $v_remove_path = $v_options[PCLZIP_OPT_REMOVE_PATH];
926 if (isset($v_options[PCLZIP_OPT_REMOVE_ALL_PATH])) {
927 $v_remove_all_path = $v_options[PCLZIP_OPT_REMOVE_ALL_PATH];
929 if (isset($v_options[PCLZIP_OPT_ADD_PATH])) {
930 // ----- Check for '/' in last path char
931 if ((strlen($v_path) > 0) && (substr($v_path, -1) != '/')) {
934 $v_path .= $v_options[PCLZIP_OPT_ADD_PATH];
936 if (!isset($v_options[PCLZIP_OPT_EXTRACT_AS_STRING])) {
937 $v_options[PCLZIP_OPT_EXTRACT_AS_STRING] = FALSE;
943 // ----- Look for 2 args
944 // Here we need to support the first historic synopsis of the
948 // ----- Get the first argument
949 $v_path = $v_arg_list[0];
951 // ----- Look for the optional second argument
953 $v_remove_path = $v_arg_list[1];
955 else if ($v_size > 2) {
957 PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Invalid number / type of arguments");
968 // Here I want to reuse extractByRule(), so I need to parse the $p_index
969 // with privParseOptions()
970 $v_arg_trick = array (PCLZIP_OPT_BY_INDEX, $p_index);
971 $v_options_trick = array();
972 $v_result = $this->privParseOptions($v_arg_trick, sizeof($v_arg_trick), $v_options_trick,
973 array (PCLZIP_OPT_BY_INDEX => 'optional' ));
974 if ($v_result != 1) {
977 $v_options[PCLZIP_OPT_BY_INDEX] = $v_options_trick[PCLZIP_OPT_BY_INDEX];
979 // ----- Look for default option values
980 $this->privOptionDefaultThreshold($v_options);
982 // ----- Call the extracting fct
983 if (($v_result = $this->privExtractByRule($p_list, $v_path, $v_remove_path, $v_remove_all_path, $v_options)) < 1) {
990 // --------------------------------------------------------------------------------
992 // --------------------------------------------------------------------------------
994 // delete([$p_option, $p_option_value, ...])
996 // This method removes files from the archive.
997 // If no parameters are given, then all the archive is emptied.
999 // None or optional arguments.
1001 // PCLZIP_OPT_BY_INDEX :
1002 // PCLZIP_OPT_BY_NAME :
1003 // PCLZIP_OPT_BY_EREG :
1004 // PCLZIP_OPT_BY_PREG :
1007 // The list of the files which are still present in the archive.
1008 // (see PclZip::listContent() for list entry format)
1009 // --------------------------------------------------------------------------------
1014 // ----- Reset the error handler
1015 $this->privErrorReset();
1017 // ----- Check archive
1018 if (!$this->privCheckFormat()) {
1022 // ----- Set default values
1023 $v_options = array();
1025 // ----- Look for variable options arguments
1026 $v_size = func_num_args();
1028 // ----- Look for arguments
1030 // ----- Get the arguments
1031 $v_arg_list = func_get_args();
1033 // ----- Parse the options
1034 $v_result = $this->privParseOptions($v_arg_list, $v_size, $v_options,
1035 array (PCLZIP_OPT_BY_NAME => 'optional',
1036 PCLZIP_OPT_BY_EREG => 'optional',
1037 PCLZIP_OPT_BY_PREG => 'optional',
1038 PCLZIP_OPT_BY_INDEX => 'optional' ));
1039 if ($v_result != 1) {
1044 // ----- Magic quotes trick
1045 $this->privDisableMagicQuotes();
1047 // ----- Call the delete fct
1049 if (($v_result = $this->privDeleteByRule($v_list, $v_options)) != 1) {
1050 $this->privSwapBackMagicQuotes();
1055 // ----- Magic quotes trick
1056 $this->privSwapBackMagicQuotes();
1061 // --------------------------------------------------------------------------------
1063 // --------------------------------------------------------------------------------
1064 // Function : deleteByIndex()
1066 // ***** Deprecated *****
1067 // delete(PCLZIP_OPT_BY_INDEX, $p_index) should be prefered.
1068 // --------------------------------------------------------------------------------
1069 function deleteByIndex($p_index)
1072 $p_list = $this->delete(PCLZIP_OPT_BY_INDEX, $p_index);
1077 // --------------------------------------------------------------------------------
1079 // --------------------------------------------------------------------------------
1080 // Function : properties()
1082 // This method gives the properties of the archive.
1083 // The properties are :
1084 // nb : Number of files in the archive
1085 // comment : Comment associated with the archive file
1086 // status : not_exist, ok
1091 // An array with the archive properties.
1092 // --------------------------------------------------------------------------------
1093 function properties()
1096 // ----- Reset the error handler
1097 $this->privErrorReset();
1099 // ----- Magic quotes trick
1100 $this->privDisableMagicQuotes();
1102 // ----- Check archive
1103 if (!$this->privCheckFormat()) {
1104 $this->privSwapBackMagicQuotes();
1108 // ----- Default properties
1110 $v_prop['comment'] = '';
1112 $v_prop['status'] = 'not_exist';
1114 // ----- Look if file exists
1115 if (@is_file($this->zipname))
1117 // ----- Open the zip file
1118 if (($this->zip_fd = @fopen($this->zipname, 'rb')) == 0)
1120 $this->privSwapBackMagicQuotes();
1123 PclZip::privErrorLog(PCLZIP_ERR_READ_OPEN_FAIL, 'Unable to open archive \''.$this->zipname.'\' in binary read mode');
1129 // ----- Read the central directory informations
1130 $v_central_dir = array();
1131 if (($v_result = $this->privReadEndCentralDir($v_central_dir)) != 1)
1133 $this->privSwapBackMagicQuotes();
1137 // ----- Close the zip file
1138 $this->privCloseFd();
1140 // ----- Set the user attributes
1141 $v_prop['comment'] = $v_central_dir['comment'];
1142 $v_prop['nb'] = $v_central_dir['entries'];
1143 $v_prop['status'] = 'ok';
1146 // ----- Magic quotes trick
1147 $this->privSwapBackMagicQuotes();
1152 // --------------------------------------------------------------------------------
1154 // --------------------------------------------------------------------------------
1155 // Function : duplicate()
1157 // This method creates an archive by copying the content of an other one. If
1158 // the archive already exist, it is replaced by the new one without any warning.
1160 // $p_archive : The filename of a valid archive, or
1161 // a valid PclZip object.
1164 // 0 or a negative value on error (error code).
1165 // --------------------------------------------------------------------------------
1166 function duplicate($p_archive)
1170 // ----- Reset the error handler
1171 $this->privErrorReset();
1173 // ----- Look if the $p_archive is a PclZip object
1174 if ((is_object($p_archive)) && (get_class($p_archive) == 'pclzip'))
1177 // ----- Duplicate the archive
1178 $v_result = $this->privDuplicate($p_archive->zipname);
1181 // ----- Look if the $p_archive is a string (so a filename)
1182 else if (is_string($p_archive))
1185 // ----- Check that $p_archive is a valid zip file
1186 // TBC : Should also check the archive format
1187 if (!is_file($p_archive)) {
1189 PclZip::privErrorLog(PCLZIP_ERR_MISSING_FILE, "No file with filename '".$p_archive."'");
1190 $v_result = PCLZIP_ERR_MISSING_FILE;
1193 // ----- Duplicate the archive
1194 $v_result = $this->privDuplicate($p_archive);
1198 // ----- Invalid variable
1202 PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Invalid variable type p_archive_to_add");
1203 $v_result = PCLZIP_ERR_INVALID_PARAMETER;
1209 // --------------------------------------------------------------------------------
1211 // --------------------------------------------------------------------------------
1212 // Function : merge()
1214 // This method merge the $p_archive_to_add archive at the end of the current
1216 // If the archive ($this) does not exist, the merge becomes a duplicate.
1217 // If the $p_archive_to_add archive does not exist, the merge is a success.
1219 // $p_archive_to_add : It can be directly the filename of a valid zip archive,
1220 // or a PclZip object archive.
1223 // 0 or negative values on error (see below).
1224 // --------------------------------------------------------------------------------
1225 function merge($p_archive_to_add)
1229 // ----- Reset the error handler
1230 $this->privErrorReset();
1232 // ----- Check archive
1233 if (!$this->privCheckFormat()) {
1237 // ----- Look if the $p_archive_to_add is a PclZip object
1238 if ((is_object($p_archive_to_add)) && (get_class($p_archive_to_add) == 'pclzip'))
1241 // ----- Merge the archive
1242 $v_result = $this->privMerge($p_archive_to_add);
1245 // ----- Look if the $p_archive_to_add is a string (so a filename)
1246 else if (is_string($p_archive_to_add))
1249 // ----- Create a temporary archive
1250 $v_object_archive = new PclZip($p_archive_to_add);
1252 // ----- Merge the archive
1253 $v_result = $this->privMerge($v_object_archive);
1256 // ----- Invalid variable
1260 PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Invalid variable type p_archive_to_add");
1261 $v_result = PCLZIP_ERR_INVALID_PARAMETER;
1267 // --------------------------------------------------------------------------------
1271 // --------------------------------------------------------------------------------
1272 // Function : errorCode()
1275 // --------------------------------------------------------------------------------
1276 function errorCode()
1278 if (PCLZIP_ERROR_EXTERNAL == 1) {
1279 return(PclErrorCode());
1282 return($this->error_code);
1285 // --------------------------------------------------------------------------------
1287 // --------------------------------------------------------------------------------
1288 // Function : errorName()
1291 // --------------------------------------------------------------------------------
1292 function errorName($p_with_code=false)
1294 $v_name = array ( PCLZIP_ERR_NO_ERROR => 'PCLZIP_ERR_NO_ERROR',
1295 PCLZIP_ERR_WRITE_OPEN_FAIL => 'PCLZIP_ERR_WRITE_OPEN_FAIL',
1296 PCLZIP_ERR_READ_OPEN_FAIL => 'PCLZIP_ERR_READ_OPEN_FAIL',
1297 PCLZIP_ERR_INVALID_PARAMETER => 'PCLZIP_ERR_INVALID_PARAMETER',
1298 PCLZIP_ERR_MISSING_FILE => 'PCLZIP_ERR_MISSING_FILE',
1299 PCLZIP_ERR_FILENAME_TOO_LONG => 'PCLZIP_ERR_FILENAME_TOO_LONG',
1300 PCLZIP_ERR_INVALID_ZIP => 'PCLZIP_ERR_INVALID_ZIP',
1301 PCLZIP_ERR_BAD_EXTRACTED_FILE => 'PCLZIP_ERR_BAD_EXTRACTED_FILE',
1302 PCLZIP_ERR_DIR_CREATE_FAIL => 'PCLZIP_ERR_DIR_CREATE_FAIL',
1303 PCLZIP_ERR_BAD_EXTENSION => 'PCLZIP_ERR_BAD_EXTENSION',
1304 PCLZIP_ERR_BAD_FORMAT => 'PCLZIP_ERR_BAD_FORMAT',
1305 PCLZIP_ERR_DELETE_FILE_FAIL => 'PCLZIP_ERR_DELETE_FILE_FAIL',
1306 PCLZIP_ERR_RENAME_FILE_FAIL => 'PCLZIP_ERR_RENAME_FILE_FAIL',
1307 PCLZIP_ERR_BAD_CHECKSUM => 'PCLZIP_ERR_BAD_CHECKSUM',
1308 PCLZIP_ERR_INVALID_ARCHIVE_ZIP => 'PCLZIP_ERR_INVALID_ARCHIVE_ZIP',
1309 PCLZIP_ERR_MISSING_OPTION_VALUE => 'PCLZIP_ERR_MISSING_OPTION_VALUE',
1310 PCLZIP_ERR_INVALID_OPTION_VALUE => 'PCLZIP_ERR_INVALID_OPTION_VALUE',
1311 PCLZIP_ERR_UNSUPPORTED_COMPRESSION => 'PCLZIP_ERR_UNSUPPORTED_COMPRESSION',
1312 PCLZIP_ERR_UNSUPPORTED_ENCRYPTION => 'PCLZIP_ERR_UNSUPPORTED_ENCRYPTION'
1313 ,PCLZIP_ERR_INVALID_ATTRIBUTE_VALUE => 'PCLZIP_ERR_INVALID_ATTRIBUTE_VALUE'
1314 ,PCLZIP_ERR_DIRECTORY_RESTRICTION => 'PCLZIP_ERR_DIRECTORY_RESTRICTION'
1317 if (isset($v_name[$this->error_code])) {
1318 $v_value = $v_name[$this->error_code];
1321 $v_value = 'NoName';
1325 return($v_value.' ('.$this->error_code.')');
1331 // --------------------------------------------------------------------------------
1333 // --------------------------------------------------------------------------------
1334 // Function : errorInfo()
1337 // --------------------------------------------------------------------------------
1338 function errorInfo($p_full=false)
1340 if (PCLZIP_ERROR_EXTERNAL == 1) {
1341 return(PclErrorString());
1345 return($this->errorName(true)." : ".$this->error_string);
1348 return($this->error_string." [code ".$this->error_code."]");
1352 // --------------------------------------------------------------------------------
1355 // --------------------------------------------------------------------------------
1356 // ***** UNDER THIS LINE ARE DEFINED PRIVATE INTERNAL FUNCTIONS *****
1358 // ***** THESES FUNCTIONS MUST NOT BE USED DIRECTLY *****
1359 // --------------------------------------------------------------------------------
1363 // --------------------------------------------------------------------------------
1364 // Function : privCheckFormat()
1366 // This method check that the archive exists and is a valid zip archive.
1367 // Several level of check exists. (futur)
1369 // $p_level : Level of check. Default 0.
1370 // 0 : Check the first bytes (magic codes) (default value))
1371 // 1 : 0 + Check the central directory (futur)
1372 // 2 : 1 + Check each file header (futur)
1375 // false on error, the error code is set.
1376 // --------------------------------------------------------------------------------
1377 function privCheckFormat($p_level=0)
1381 // ----- Reset the file system cache
1384 // ----- Reset the error handler
1385 $this->privErrorReset();
1387 // ----- Look if the file exits
1388 if (!is_file($this->zipname)) {
1390 PclZip::privErrorLog(PCLZIP_ERR_MISSING_FILE, "Missing archive file '".$this->zipname."'");
1394 // ----- Check that the file is readeable
1395 if (!is_readable($this->zipname)) {
1397 PclZip::privErrorLog(PCLZIP_ERR_READ_OPEN_FAIL, "Unable to read archive '".$this->zipname."'");
1401 // ----- Check the magic code
1404 // ----- Check the central header
1407 // ----- Check each file header
1413 // --------------------------------------------------------------------------------
1415 // --------------------------------------------------------------------------------
1416 // Function : privParseOptions()
1418 // This internal methods reads the variable list of arguments ($p_options_list,
1419 // $p_size) and generate an array with the options and values ($v_result_list).
1420 // $v_requested_options contains the options that can be present and those that
1422 // $v_requested_options is an array, with the option value as key, and 'optional',
1423 // or 'mandatory' as value.
1429 // --------------------------------------------------------------------------------
1430 function privParseOptions(&$p_options_list, $p_size, &$v_result_list, $v_requested_options=false)
1434 // ----- Read the options
1436 while ($i<$p_size) {
1438 // ----- Check if the option is supported
1439 if (!isset($v_requested_options[$p_options_list[$i]])) {
1441 PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Invalid optional parameter '".$p_options_list[$i]."' for this method");
1444 return PclZip::errorCode();
1447 // ----- Look for next option
1448 switch ($p_options_list[$i]) {
1449 // ----- Look for options that request a path value
1450 case PCLZIP_OPT_PATH :
1451 case PCLZIP_OPT_REMOVE_PATH :
1452 case PCLZIP_OPT_ADD_PATH :
1453 // ----- Check the number of parameters
1454 if (($i+1) >= $p_size) {
1456 PclZip::privErrorLog(PCLZIP_ERR_MISSING_OPTION_VALUE, "Missing parameter value for option '".PclZipUtilOptionText($p_options_list[$i])."'");
1459 return PclZip::errorCode();
1462 // ----- Get the value
1463 $v_result_list[$p_options_list[$i]] = PclZipUtilTranslateWinPath($p_options_list[$i+1], FALSE);
1467 case PCLZIP_OPT_TEMP_FILE_THRESHOLD :
1468 // ----- Check the number of parameters
1469 if (($i+1) >= $p_size) {
1470 PclZip::privErrorLog(PCLZIP_ERR_MISSING_OPTION_VALUE, "Missing parameter value for option '".PclZipUtilOptionText($p_options_list[$i])."'");
1471 return PclZip::errorCode();
1474 // ----- Check for incompatible options
1475 if (isset($v_result_list[PCLZIP_OPT_TEMP_FILE_OFF])) {
1476 PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Option '".PclZipUtilOptionText($p_options_list[$i])."' can not be used with option 'PCLZIP_OPT_TEMP_FILE_OFF'");
1477 return PclZip::errorCode();
1480 // ----- Check the value
1481 $v_value = $p_options_list[$i+1];
1482 if ((!is_integer($v_value)) || ($v_value<0)) {
1483 PclZip::privErrorLog(PCLZIP_ERR_INVALID_OPTION_VALUE, "Integer expected for option '".PclZipUtilOptionText($p_options_list[$i])."'");
1484 return PclZip::errorCode();
1487 // ----- Get the value (and convert it in bytes)
1488 $v_result_list[$p_options_list[$i]] = $v_value*1048576;
1492 case PCLZIP_OPT_TEMP_FILE_ON :
1493 // ----- Check for incompatible options
1494 if (isset($v_result_list[PCLZIP_OPT_TEMP_FILE_OFF])) {
1495 PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Option '".PclZipUtilOptionText($p_options_list[$i])."' can not be used with option 'PCLZIP_OPT_TEMP_FILE_OFF'");
1496 return PclZip::errorCode();
1499 $v_result_list[$p_options_list[$i]] = true;
1502 case PCLZIP_OPT_TEMP_FILE_OFF :
1503 // ----- Check for incompatible options
1504 if (isset($v_result_list[PCLZIP_OPT_TEMP_FILE_ON])) {
1505 PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Option '".PclZipUtilOptionText($p_options_list[$i])."' can not be used with option 'PCLZIP_OPT_TEMP_FILE_ON'");
1506 return PclZip::errorCode();
1508 // ----- Check for incompatible options
1509 if (isset($v_result_list[PCLZIP_OPT_TEMP_FILE_THRESHOLD])) {
1510 PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Option '".PclZipUtilOptionText($p_options_list[$i])."' can not be used with option 'PCLZIP_OPT_TEMP_FILE_THRESHOLD'");
1511 return PclZip::errorCode();
1514 $v_result_list[$p_options_list[$i]] = true;
1517 case PCLZIP_OPT_EXTRACT_DIR_RESTRICTION :
1518 // ----- Check the number of parameters
1519 if (($i+1) >= $p_size) {
1521 PclZip::privErrorLog(PCLZIP_ERR_MISSING_OPTION_VALUE, "Missing parameter value for option '".PclZipUtilOptionText($p_options_list[$i])."'");
1524 return PclZip::errorCode();
1527 // ----- Get the value
1528 if ( is_string($p_options_list[$i+1])
1529 && ($p_options_list[$i+1] != '')) {
1530 $v_result_list[$p_options_list[$i]] = PclZipUtilTranslateWinPath($p_options_list[$i+1], FALSE);
1537 // ----- Look for options that request an array of string for value
1538 case PCLZIP_OPT_BY_NAME :
1539 // ----- Check the number of parameters
1540 if (($i+1) >= $p_size) {
1542 PclZip::privErrorLog(PCLZIP_ERR_MISSING_OPTION_VALUE, "Missing parameter value for option '".PclZipUtilOptionText($p_options_list[$i])."'");
1545 return PclZip::errorCode();
1548 // ----- Get the value
1549 if (is_string($p_options_list[$i+1])) {
1550 $v_result_list[$p_options_list[$i]][0] = $p_options_list[$i+1];
1552 else if (is_array($p_options_list[$i+1])) {
1553 $v_result_list[$p_options_list[$i]] = $p_options_list[$i+1];
1557 PclZip::privErrorLog(PCLZIP_ERR_INVALID_OPTION_VALUE, "Wrong parameter value for option '".PclZipUtilOptionText($p_options_list[$i])."'");
1560 return PclZip::errorCode();
1565 // ----- Look for options that request an EREG or PREG expression
1566 case PCLZIP_OPT_BY_EREG :
1567 // ereg() is deprecated starting with PHP 5.3. Move PCLZIP_OPT_BY_EREG
1568 // to PCLZIP_OPT_BY_PREG
1569 $p_options_list[$i] = PCLZIP_OPT_BY_PREG;
1570 case PCLZIP_OPT_BY_PREG :
1571 //case PCLZIP_OPT_CRYPT :
1572 // ----- Check the number of parameters
1573 if (($i+1) >= $p_size) {
1575 PclZip::privErrorLog(PCLZIP_ERR_MISSING_OPTION_VALUE, "Missing parameter value for option '".PclZipUtilOptionText($p_options_list[$i])."'");
1578 return PclZip::errorCode();
1581 // ----- Get the value
1582 if (is_string($p_options_list[$i+1])) {
1583 $v_result_list[$p_options_list[$i]] = $p_options_list[$i+1];
1587 PclZip::privErrorLog(PCLZIP_ERR_INVALID_OPTION_VALUE, "Wrong parameter value for option '".PclZipUtilOptionText($p_options_list[$i])."'");
1590 return PclZip::errorCode();
1595 // ----- Look for options that takes a string
1596 case PCLZIP_OPT_COMMENT :
1597 case PCLZIP_OPT_ADD_COMMENT :
1598 case PCLZIP_OPT_PREPEND_COMMENT :
1599 // ----- Check the number of parameters
1600 if (($i+1) >= $p_size) {
1602 PclZip::privErrorLog(PCLZIP_ERR_MISSING_OPTION_VALUE,
1603 "Missing parameter value for option '"
1604 .PclZipUtilOptionText($p_options_list[$i])
1608 return PclZip::errorCode();
1611 // ----- Get the value
1612 if (is_string($p_options_list[$i+1])) {
1613 $v_result_list[$p_options_list[$i]] = $p_options_list[$i+1];
1617 PclZip::privErrorLog(PCLZIP_ERR_INVALID_OPTION_VALUE,
1618 "Wrong parameter value for option '"
1619 .PclZipUtilOptionText($p_options_list[$i])
1623 return PclZip::errorCode();
1628 // ----- Look for options that request an array of index
1629 case PCLZIP_OPT_BY_INDEX :
1630 // ----- Check the number of parameters
1631 if (($i+1) >= $p_size) {
1633 PclZip::privErrorLog(PCLZIP_ERR_MISSING_OPTION_VALUE, "Missing parameter value for option '".PclZipUtilOptionText($p_options_list[$i])."'");
1636 return PclZip::errorCode();
1639 // ----- Get the value
1640 $v_work_list = array();
1641 if (is_string($p_options_list[$i+1])) {
1643 // ----- Remove spaces
1644 $p_options_list[$i+1] = strtr($p_options_list[$i+1], ' ', '');
1646 // ----- Parse items
1647 $v_work_list = explode(",", $p_options_list[$i+1]);
1649 else if (is_integer($p_options_list[$i+1])) {
1650 $v_work_list[0] = $p_options_list[$i+1].'-'.$p_options_list[$i+1];
1652 else if (is_array($p_options_list[$i+1])) {
1653 $v_work_list = $p_options_list[$i+1];
1657 PclZip::privErrorLog(PCLZIP_ERR_INVALID_OPTION_VALUE, "Value must be integer, string or array for option '".PclZipUtilOptionText($p_options_list[$i])."'");
1660 return PclZip::errorCode();
1663 // ----- Reduce the index list
1664 // each index item in the list must be a couple with a start and
1665 // an end value : [0,3], [5-5], [8-10], ...
1666 // ----- Check the format of each item
1669 for ($j=0; $j<sizeof($v_work_list); $j++) {
1670 // ----- Explode the item
1671 $v_item_list = explode("-", $v_work_list[$j]);
1672 $v_size_item_list = sizeof($v_item_list);
1674 // ----- TBC : Here we might check that each item is a
1677 // ----- Look for single value
1678 if ($v_size_item_list == 1) {
1679 // ----- Set the option value
1680 $v_result_list[$p_options_list[$i]][$j]['start'] = $v_item_list[0];
1681 $v_result_list[$p_options_list[$i]][$j]['end'] = $v_item_list[0];
1683 elseif ($v_size_item_list == 2) {
1684 // ----- Set the option value
1685 $v_result_list[$p_options_list[$i]][$j]['start'] = $v_item_list[0];
1686 $v_result_list[$p_options_list[$i]][$j]['end'] = $v_item_list[1];
1690 PclZip::privErrorLog(PCLZIP_ERR_INVALID_OPTION_VALUE, "Too many values in index range for option '".PclZipUtilOptionText($p_options_list[$i])."'");
1693 return PclZip::errorCode();
1697 // ----- Look for list sort
1698 if ($v_result_list[$p_options_list[$i]][$j]['start'] < $v_sort_value) {
1701 // ----- TBC : An automatic sort should be writen ...
1703 PclZip::privErrorLog(PCLZIP_ERR_INVALID_OPTION_VALUE, "Invalid order of index range for option '".PclZipUtilOptionText($p_options_list[$i])."'");
1706 return PclZip::errorCode();
1708 $v_sort_value = $v_result_list[$p_options_list[$i]][$j]['start'];
1711 // ----- Sort the items
1713 // TBC : To Be Completed
1716 // ----- Next option
1720 // ----- Look for options that request no value
1721 case PCLZIP_OPT_REMOVE_ALL_PATH :
1722 case PCLZIP_OPT_EXTRACT_AS_STRING :
1723 case PCLZIP_OPT_NO_COMPRESSION :
1724 case PCLZIP_OPT_EXTRACT_IN_OUTPUT :
1725 case PCLZIP_OPT_REPLACE_NEWER :
1726 case PCLZIP_OPT_STOP_ON_ERROR :
1727 $v_result_list[$p_options_list[$i]] = true;
1730 // ----- Look for options that request an octal value
1731 case PCLZIP_OPT_SET_CHMOD :
1732 // ----- Check the number of parameters
1733 if (($i+1) >= $p_size) {
1735 PclZip::privErrorLog(PCLZIP_ERR_MISSING_OPTION_VALUE, "Missing parameter value for option '".PclZipUtilOptionText($p_options_list[$i])."'");
1738 return PclZip::errorCode();
1741 // ----- Get the value
1742 $v_result_list[$p_options_list[$i]] = $p_options_list[$i+1];
1746 // ----- Look for options that request a call-back
1747 case PCLZIP_CB_PRE_EXTRACT :
1748 case PCLZIP_CB_POST_EXTRACT :
1749 case PCLZIP_CB_PRE_ADD :
1750 case PCLZIP_CB_POST_ADD :
1752 case PCLZIP_CB_PRE_DELETE :
1753 case PCLZIP_CB_POST_DELETE :
1754 case PCLZIP_CB_PRE_LIST :
1755 case PCLZIP_CB_POST_LIST :
1757 // ----- Check the number of parameters
1758 if (($i+1) >= $p_size) {
1760 PclZip::privErrorLog(PCLZIP_ERR_MISSING_OPTION_VALUE, "Missing parameter value for option '".PclZipUtilOptionText($p_options_list[$i])."'");
1763 return PclZip::errorCode();
1766 // ----- Get the value
1767 $v_function_name = $p_options_list[$i+1];
1769 // ----- Check that the value is a valid existing function
1770 if (!function_exists($v_function_name)) {
1772 PclZip::privErrorLog(PCLZIP_ERR_INVALID_OPTION_VALUE, "Function '".$v_function_name."()' is not an existing function for option '".PclZipUtilOptionText($p_options_list[$i])."'");
1775 return PclZip::errorCode();
1778 // ----- Set the attribute
1779 $v_result_list[$p_options_list[$i]] = $v_function_name;
1785 PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER,
1786 "Unknown parameter '"
1787 .$p_options_list[$i]."'");
1790 return PclZip::errorCode();
1793 // ----- Next options
1797 // ----- Look for mandatory options
1798 if ($v_requested_options !== false) {
1799 for ($key=reset($v_requested_options); $key=key($v_requested_options); $key=next($v_requested_options)) {
1800 // ----- Look for mandatory option
1801 if ($v_requested_options[$key] == 'mandatory') {
1802 // ----- Look if present
1803 if (!isset($v_result_list[$key])) {
1805 PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Missing mandatory parameter ".PclZipUtilOptionText($key)."(".$key.")");
1808 return PclZip::errorCode();
1814 // ----- Look for default values
1815 if (!isset($v_result_list[PCLZIP_OPT_TEMP_FILE_THRESHOLD])) {
1822 // --------------------------------------------------------------------------------
1824 // --------------------------------------------------------------------------------
1825 // Function : privOptionDefaultThreshold()
1829 // --------------------------------------------------------------------------------
1830 function privOptionDefaultThreshold(&$p_options)
1834 if (isset($p_options[PCLZIP_OPT_TEMP_FILE_THRESHOLD])
1835 || isset($p_options[PCLZIP_OPT_TEMP_FILE_OFF])) {
1839 // ----- Get 'memory_limit' configuration value
1840 $v_memory_limit = ini_get('memory_limit');
1841 $v_memory_limit = trim($v_memory_limit);
1842 $v_memory_limit_int = (int) $v_memory_limit;
1843 $last = strtolower(substr($v_memory_limit, -1));
1846 //$v_memory_limit_int = $v_memory_limit_int*1024*1024*1024;
1847 $v_memory_limit_int = $v_memory_limit_int*1073741824;
1849 //$v_memory_limit_int = $v_memory_limit_int*1024*1024;
1850 $v_memory_limit_int = $v_memory_limit_int*1048576;
1852 $v_memory_limit_int = $v_memory_limit_int*1024;
1854 $p_options[PCLZIP_OPT_TEMP_FILE_THRESHOLD] = floor($v_memory_limit_int*PCLZIP_TEMPORARY_FILE_RATIO);
1857 // ----- Sanity check : No threshold if value lower than 1M
1858 if ($p_options[PCLZIP_OPT_TEMP_FILE_THRESHOLD] < 1048576) {
1859 unset($p_options[PCLZIP_OPT_TEMP_FILE_THRESHOLD]);
1865 // --------------------------------------------------------------------------------
1867 // --------------------------------------------------------------------------------
1868 // Function : privFileDescrParseAtt()
1874 // --------------------------------------------------------------------------------
1875 function privFileDescrParseAtt(&$p_file_list, &$p_filedescr, $v_options, $v_requested_options=false)
1879 // ----- For each file in the list check the attributes
1880 foreach ($p_file_list as $v_key => $v_value) {
1882 // ----- Check if the option is supported
1883 if (!isset($v_requested_options[$v_key])) {
1885 PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Invalid file attribute '".$v_key."' for this file");
1888 return PclZip::errorCode();
1891 // ----- Look for attribute
1893 case PCLZIP_ATT_FILE_NAME :
1894 if (!is_string($v_value)) {
1895 PclZip::privErrorLog(PCLZIP_ERR_INVALID_ATTRIBUTE_VALUE, "Invalid type ".gettype($v_value).". String expected for attribute '".PclZipUtilOptionText($v_key)."'");
1896 return PclZip::errorCode();
1899 $p_filedescr['filename'] = PclZipUtilPathReduction($v_value);
1901 if ($p_filedescr['filename'] == '') {
1902 PclZip::privErrorLog(PCLZIP_ERR_INVALID_ATTRIBUTE_VALUE, "Invalid empty filename for attribute '".PclZipUtilOptionText($v_key)."'");
1903 return PclZip::errorCode();
1908 case PCLZIP_ATT_FILE_NEW_SHORT_NAME :
1909 if (!is_string($v_value)) {
1910 PclZip::privErrorLog(PCLZIP_ERR_INVALID_ATTRIBUTE_VALUE, "Invalid type ".gettype($v_value).". String expected for attribute '".PclZipUtilOptionText($v_key)."'");
1911 return PclZip::errorCode();
1914 $p_filedescr['new_short_name'] = PclZipUtilPathReduction($v_value);
1916 if ($p_filedescr['new_short_name'] == '') {
1917 PclZip::privErrorLog(PCLZIP_ERR_INVALID_ATTRIBUTE_VALUE, "Invalid empty short filename for attribute '".PclZipUtilOptionText($v_key)."'");
1918 return PclZip::errorCode();
1922 case PCLZIP_ATT_FILE_NEW_FULL_NAME :
1923 if (!is_string($v_value)) {
1924 PclZip::privErrorLog(PCLZIP_ERR_INVALID_ATTRIBUTE_VALUE, "Invalid type ".gettype($v_value).". String expected for attribute '".PclZipUtilOptionText($v_key)."'");
1925 return PclZip::errorCode();
1928 $p_filedescr['new_full_name'] = PclZipUtilPathReduction($v_value);
1930 if ($p_filedescr['new_full_name'] == '') {
1931 PclZip::privErrorLog(PCLZIP_ERR_INVALID_ATTRIBUTE_VALUE, "Invalid empty full filename for attribute '".PclZipUtilOptionText($v_key)."'");
1932 return PclZip::errorCode();
1936 // ----- Look for options that takes a string
1937 case PCLZIP_ATT_FILE_COMMENT :
1938 if (!is_string($v_value)) {
1939 PclZip::privErrorLog(PCLZIP_ERR_INVALID_ATTRIBUTE_VALUE, "Invalid type ".gettype($v_value).". String expected for attribute '".PclZipUtilOptionText($v_key)."'");
1940 return PclZip::errorCode();
1943 $p_filedescr['comment'] = $v_value;
1946 case PCLZIP_ATT_FILE_MTIME :
1947 if (!is_integer($v_value)) {
1948 PclZip::privErrorLog(PCLZIP_ERR_INVALID_ATTRIBUTE_VALUE, "Invalid type ".gettype($v_value).". Integer expected for attribute '".PclZipUtilOptionText($v_key)."'");
1949 return PclZip::errorCode();
1952 $p_filedescr['mtime'] = $v_value;
1955 case PCLZIP_ATT_FILE_CONTENT :
1956 $p_filedescr['content'] = $v_value;
1961 PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER,
1962 "Unknown parameter '".$v_key."'");
1965 return PclZip::errorCode();
1968 // ----- Look for mandatory options
1969 if ($v_requested_options !== false) {
1970 for ($key=reset($v_requested_options); $key=key($v_requested_options); $key=next($v_requested_options)) {
1971 // ----- Look for mandatory option
1972 if ($v_requested_options[$key] == 'mandatory') {
1973 // ----- Look if present
1974 if (!isset($p_file_list[$key])) {
1975 PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Missing mandatory parameter ".PclZipUtilOptionText($key)."(".$key.")");
1976 return PclZip::errorCode();
1988 // --------------------------------------------------------------------------------
1990 // --------------------------------------------------------------------------------
1991 // Function : privFileDescrExpand()
1993 // This method look for each item of the list to see if its a file, a folder
1994 // or a string to be added as file. For any other type of files (link, other)
1995 // just ignore the item.
1996 // Then prepare the information that will be stored for that file.
1997 // When its a folder, expand the folder with all the files that are in that
1998 // folder (recursively).
2003 // --------------------------------------------------------------------------------
2004 function privFileDescrExpand(&$p_filedescr_list, &$p_options)
2008 // ----- Create a result list
2009 $v_result_list = array();
2011 // ----- Look each entry
2012 for ($i=0; $i<sizeof($p_filedescr_list); $i++) {
2014 // ----- Get filedescr
2015 $v_descr = $p_filedescr_list[$i];
2017 // ----- Reduce the filename
2018 $v_descr['filename'] = PclZipUtilTranslateWinPath($v_descr['filename'], false);
2019 $v_descr['filename'] = PclZipUtilPathReduction($v_descr['filename']);
2021 // ----- Look for real file or folder
2022 if (file_exists($v_descr['filename'])) {
2023 if (@is_file($v_descr['filename'])) {
2024 $v_descr['type'] = 'file';
2026 else if (@is_dir($v_descr['filename'])) {
2027 $v_descr['type'] = 'folder';
2029 else if (@is_link($v_descr['filename'])) {
2039 // ----- Look for string added as file
2040 else if (isset($v_descr['content'])) {
2041 $v_descr['type'] = 'virtual_file';
2044 // ----- Missing file
2047 PclZip::privErrorLog(PCLZIP_ERR_MISSING_FILE, "File '".$v_descr['filename']."' does not exist");
2050 return PclZip::errorCode();
2053 // ----- Calculate the stored filename
2054 $this->privCalculateStoredFilename($v_descr, $p_options);
2056 // ----- Add the descriptor in result list
2057 $v_result_list[sizeof($v_result_list)] = $v_descr;
2059 // ----- Look for folder
2060 if ($v_descr['type'] == 'folder') {
2061 // ----- List of items in folder
2062 $v_dirlist_descr = array();
2064 if ($v_folder_handler = @opendir($v_descr['filename'])) {
2065 while (($v_item_handler = @readdir($v_folder_handler)) !== false) {
2067 // ----- Skip '.' and '..'
2068 if (($v_item_handler == '.') || ($v_item_handler == '..')) {
2072 // ----- Compose the full filename
2073 $v_dirlist_descr[$v_dirlist_nb]['filename'] = $v_descr['filename'].'/'.$v_item_handler;
2075 // ----- Look for different stored filename
2076 // Because the name of the folder was changed, the name of the
2077 // files/sub-folders also change
2078 if (($v_descr['stored_filename'] != $v_descr['filename'])
2079 && (!isset($p_options[PCLZIP_OPT_REMOVE_ALL_PATH]))) {
2080 if ($v_descr['stored_filename'] != '') {
2081 $v_dirlist_descr[$v_dirlist_nb]['new_full_name'] = $v_descr['stored_filename'].'/'.$v_item_handler;
2084 $v_dirlist_descr[$v_dirlist_nb]['new_full_name'] = $v_item_handler;
2091 @closedir($v_folder_handler);
2094 // TBC : unable to open folder in read mode
2097 // ----- Expand each element of the list
2098 if ($v_dirlist_nb != 0) {
2100 if (($v_result = $this->privFileDescrExpand($v_dirlist_descr, $p_options)) != 1) {
2104 // ----- Concat the resulting list
2105 $v_result_list = array_merge($v_result_list, $v_dirlist_descr);
2110 // ----- Free local array
2111 unset($v_dirlist_descr);
2115 // ----- Get the result list
2116 $p_filedescr_list = $v_result_list;
2121 // --------------------------------------------------------------------------------
2123 // --------------------------------------------------------------------------------
2124 // Function : privCreate()
2128 // --------------------------------------------------------------------------------
2129 function privCreate($p_filedescr_list, &$p_result_list, &$p_options)
2132 $v_list_detail = array();
2134 // ----- Magic quotes trick
2135 $this->privDisableMagicQuotes();
2137 // ----- Open the file in write mode
2138 if (($v_result = $this->privOpenFd('wb')) != 1)
2144 // ----- Add the list of files
2145 $v_result = $this->privAddList($p_filedescr_list, $p_result_list, $p_options);
2148 $this->privCloseFd();
2150 // ----- Magic quotes trick
2151 $this->privSwapBackMagicQuotes();
2156 // --------------------------------------------------------------------------------
2158 // --------------------------------------------------------------------------------
2159 // Function : privAdd()
2163 // --------------------------------------------------------------------------------
2164 function privAdd($p_filedescr_list, &$p_result_list, &$p_options)
2167 $v_list_detail = array();
2169 // ----- Look if the archive exists or is empty
2170 if ((!is_file($this->zipname)) || (filesize($this->zipname) == 0))
2173 // ----- Do a create
2174 $v_result = $this->privCreate($p_filedescr_list, $p_result_list, $p_options);
2179 // ----- Magic quotes trick
2180 $this->privDisableMagicQuotes();
2182 // ----- Open the zip file
2183 if (($v_result=$this->privOpenFd('rb')) != 1)
2185 // ----- Magic quotes trick
2186 $this->privSwapBackMagicQuotes();
2192 // ----- Read the central directory informations
2193 $v_central_dir = array();
2194 if (($v_result = $this->privReadEndCentralDir($v_central_dir)) != 1)
2196 $this->privCloseFd();
2197 $this->privSwapBackMagicQuotes();
2201 // ----- Go to beginning of File
2202 @rewind($this->zip_fd);
2204 // ----- Creates a temporay file
2205 $v_zip_temp_name = PCLZIP_TEMPORARY_DIR.uniqid('pclzip-').'.tmp';
2207 // ----- Open the temporary file in write mode
2208 if (($v_zip_temp_fd = @fopen($v_zip_temp_name, 'wb')) == 0)
2210 $this->privCloseFd();
2211 $this->privSwapBackMagicQuotes();
2213 PclZip::privErrorLog(PCLZIP_ERR_READ_OPEN_FAIL, 'Unable to open temporary file \''.$v_zip_temp_name.'\' in binary write mode');
2216 return PclZip::errorCode();
2219 // ----- Copy the files from the archive to the temporary file
2220 // TBC : Here I should better append the file and go back to erase the central dir
2221 $v_size = $v_central_dir['offset'];
2222 while ($v_size != 0)
2224 $v_read_size = ($v_size < PCLZIP_READ_BLOCK_SIZE ? $v_size : PCLZIP_READ_BLOCK_SIZE);
2225 $v_buffer = fread($this->zip_fd, $v_read_size);
2226 @fwrite($v_zip_temp_fd, $v_buffer, $v_read_size);
2227 $v_size -= $v_read_size;
2230 // ----- Swap the file descriptor
2231 // Here is a trick : I swap the temporary fd with the zip fd, in order to use
2232 // the following methods on the temporary fil and not the real archive
2233 $v_swap = $this->zip_fd;
2234 $this->zip_fd = $v_zip_temp_fd;
2235 $v_zip_temp_fd = $v_swap;
2237 // ----- Add the files
2238 $v_header_list = array();
2239 if (($v_result = $this->privAddFileList($p_filedescr_list, $v_header_list, $p_options)) != 1)
2241 fclose($v_zip_temp_fd);
2242 $this->privCloseFd();
2243 @unlink($v_zip_temp_name);
2244 $this->privSwapBackMagicQuotes();
2250 // ----- Store the offset of the central dir
2251 $v_offset = @ftell($this->zip_fd);
2253 // ----- Copy the block of file headers from the old archive
2254 $v_size = $v_central_dir['size'];
2255 while ($v_size != 0)
2257 $v_read_size = ($v_size < PCLZIP_READ_BLOCK_SIZE ? $v_size : PCLZIP_READ_BLOCK_SIZE);
2258 $v_buffer = @fread($v_zip_temp_fd, $v_read_size);
2259 @fwrite($this->zip_fd, $v_buffer, $v_read_size);
2260 $v_size -= $v_read_size;
2263 // ----- Create the Central Dir files header
2264 for ($i=0, $v_count=0; $i<sizeof($v_header_list); $i++)
2266 // ----- Create the file header
2267 if ($v_header_list[$i]['status'] == 'ok') {
2268 if (($v_result = $this->privWriteCentralFileHeader($v_header_list[$i])) != 1) {
2269 fclose($v_zip_temp_fd);
2270 $this->privCloseFd();
2271 @unlink($v_zip_temp_name);
2272 $this->privSwapBackMagicQuotes();
2280 // ----- Transform the header to a 'usable' info
2281 $this->privConvertHeader2FileInfo($v_header_list[$i], $p_result_list[$i]);
2284 // ----- Zip file comment
2285 $v_comment = $v_central_dir['comment'];
2286 if (isset($p_options[PCLZIP_OPT_COMMENT])) {
2287 $v_comment = $p_options[PCLZIP_OPT_COMMENT];
2289 if (isset($p_options[PCLZIP_OPT_ADD_COMMENT])) {
2290 $v_comment = $v_comment.$p_options[PCLZIP_OPT_ADD_COMMENT];
2292 if (isset($p_options[PCLZIP_OPT_PREPEND_COMMENT])) {
2293 $v_comment = $p_options[PCLZIP_OPT_PREPEND_COMMENT].$v_comment;
2296 // ----- Calculate the size of the central header
2297 $v_size = @ftell($this->zip_fd)-$v_offset;
2299 // ----- Create the central dir footer
2300 if (($v_result = $this->privWriteCentralHeader($v_count+$v_central_dir['entries'], $v_size, $v_offset, $v_comment)) != 1)
2302 // ----- Reset the file list
2303 unset($v_header_list);
2304 $this->privSwapBackMagicQuotes();
2310 // ----- Swap back the file descriptor
2311 $v_swap = $this->zip_fd;
2312 $this->zip_fd = $v_zip_temp_fd;
2313 $v_zip_temp_fd = $v_swap;
2316 $this->privCloseFd();
2318 // ----- Close the temporary file
2319 @fclose($v_zip_temp_fd);
2321 // ----- Magic quotes trick
2322 $this->privSwapBackMagicQuotes();
2324 // ----- Delete the zip file
2325 // TBC : I should test the result ...
2326 @unlink($this->zipname);
2328 // ----- Rename the temporary file
2329 // TBC : I should test the result ...
2330 //@rename($v_zip_temp_name, $this->zipname);
2331 PclZipUtilRename($v_zip_temp_name, $this->zipname);
2336 // --------------------------------------------------------------------------------
2338 // --------------------------------------------------------------------------------
2339 // Function : privOpenFd()
2342 // --------------------------------------------------------------------------------
2343 function privOpenFd($p_mode)
2347 // ----- Look if already open
2348 if ($this->zip_fd != 0)
2351 PclZip::privErrorLog(PCLZIP_ERR_READ_OPEN_FAIL, 'Zip file \''.$this->zipname.'\' already open');
2354 return PclZip::errorCode();
2357 // ----- Open the zip file
2358 if (($this->zip_fd = @fopen($this->zipname, $p_mode)) == 0)
2361 PclZip::privErrorLog(PCLZIP_ERR_READ_OPEN_FAIL, 'Unable to open archive \''.$this->zipname.'\' in '.$p_mode.' mode');
2364 return PclZip::errorCode();
2370 // --------------------------------------------------------------------------------
2372 // --------------------------------------------------------------------------------
2373 // Function : privCloseFd()
2376 // --------------------------------------------------------------------------------
2377 function privCloseFd()
2381 if ($this->zip_fd != 0)
2382 @fclose($this->zip_fd);
2388 // --------------------------------------------------------------------------------
2390 // --------------------------------------------------------------------------------
2391 // Function : privAddList()
2393 // $p_add_dir and $p_remove_dir will give the ability to memorize a path which is
2394 // different from the real path of the file. This is usefull if you want to have PclTar
2395 // running in any directory, and memorize relative path from an other directory.
2397 // $p_list : An array containing the file or directory names to add in the tar
2398 // $p_result_list : list of added files with their properties (specially the status field)
2399 // $p_add_dir : Path to add in the filename path archived
2400 // $p_remove_dir : Path to remove in the filename path archived
2402 // --------------------------------------------------------------------------------
2403 // function privAddList($p_list, &$p_result_list, $p_add_dir, $p_remove_dir, $p_remove_all_dir, &$p_options)
2404 function privAddList($p_filedescr_list, &$p_result_list, &$p_options)
2408 // ----- Add the files
2409 $v_header_list = array();
2410 if (($v_result = $this->privAddFileList($p_filedescr_list, $v_header_list, $p_options)) != 1)
2416 // ----- Store the offset of the central dir
2417 $v_offset = @ftell($this->zip_fd);
2419 // ----- Create the Central Dir files header
2420 for ($i=0,$v_count=0; $i<sizeof($v_header_list); $i++)
2422 // ----- Create the file header
2423 if ($v_header_list[$i]['status'] == 'ok') {
2424 if (($v_result = $this->privWriteCentralFileHeader($v_header_list[$i])) != 1) {
2431 // ----- Transform the header to a 'usable' info
2432 $this->privConvertHeader2FileInfo($v_header_list[$i], $p_result_list[$i]);
2435 // ----- Zip file comment
2437 if (isset($p_options[PCLZIP_OPT_COMMENT])) {
2438 $v_comment = $p_options[PCLZIP_OPT_COMMENT];
2441 // ----- Calculate the size of the central header
2442 $v_size = @ftell($this->zip_fd)-$v_offset;
2444 // ----- Create the central dir footer
2445 if (($v_result = $this->privWriteCentralHeader($v_count, $v_size, $v_offset, $v_comment)) != 1)
2447 // ----- Reset the file list
2448 unset($v_header_list);
2457 // --------------------------------------------------------------------------------
2459 // --------------------------------------------------------------------------------
2460 // Function : privAddFileList()
2463 // $p_filedescr_list : An array containing the file description
2464 // or directory names to add in the zip
2465 // $p_result_list : list of added files with their properties (specially the status field)
2467 // --------------------------------------------------------------------------------
2468 function privAddFileList($p_filedescr_list, &$p_result_list, &$p_options)
2471 $v_header = array();
2473 // ----- Recuperate the current number of elt in list
2474 $v_nb = sizeof($p_result_list);
2476 // ----- Loop on the files
2477 for ($j=0; ($j<sizeof($p_filedescr_list)) && ($v_result==1); $j++) {
2478 // ----- Format the filename
2479 $p_filedescr_list[$j]['filename']
2480 = PclZipUtilTranslateWinPath($p_filedescr_list[$j]['filename'], false);
2483 // ----- Skip empty file names
2484 // TBC : Can this be possible ? not checked in DescrParseAtt ?
2485 if ($p_filedescr_list[$j]['filename'] == "") {
2489 // ----- Check the filename
2490 if ( ($p_filedescr_list[$j]['type'] != 'virtual_file')
2491 && (!file_exists($p_filedescr_list[$j]['filename']))) {
2492 PclZip::privErrorLog(PCLZIP_ERR_MISSING_FILE, "File '".$p_filedescr_list[$j]['filename']."' does not exist");
2493 return PclZip::errorCode();
2496 // ----- Look if it is a file or a dir with no all path remove option
2497 // or a dir with all its path removed
2498 // if ( (is_file($p_filedescr_list[$j]['filename']))
2499 // || ( is_dir($p_filedescr_list[$j]['filename'])
2500 if ( ($p_filedescr_list[$j]['type'] == 'file')
2501 || ($p_filedescr_list[$j]['type'] == 'virtual_file')
2502 || ( ($p_filedescr_list[$j]['type'] == 'folder')
2503 && ( !isset($p_options[PCLZIP_OPT_REMOVE_ALL_PATH])
2504 || !$p_options[PCLZIP_OPT_REMOVE_ALL_PATH]))
2507 // ----- Add the file
2508 $v_result = $this->privAddFile($p_filedescr_list[$j], $v_header,
2510 if ($v_result != 1) {
2514 // ----- Store the file infos
2515 $p_result_list[$v_nb++] = $v_header;
2522 // --------------------------------------------------------------------------------
2524 // --------------------------------------------------------------------------------
2525 // Function : privAddFile()
2529 // --------------------------------------------------------------------------------
2530 function privAddFile($p_filedescr, &$p_header, &$p_options)
2534 // ----- Working variable
2535 $p_filename = $p_filedescr['filename'];
2537 // TBC : Already done in the fileAtt check ... ?
2538 if ($p_filename == "") {
2540 PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Invalid file list parameter (invalid or empty list)");
2543 return PclZip::errorCode();
2546 // ----- Look for a stored different filename
2548 if (isset($p_filedescr['stored_filename'])) {
2549 $v_stored_filename = $p_filedescr['stored_filename'];
2552 $v_stored_filename = $p_filedescr['stored_filename'];
2556 // ----- Set the file properties
2558 $p_header['version'] = 20;
2559 $p_header['version_extracted'] = 10;
2560 $p_header['flag'] = 0;
2561 $p_header['compression'] = 0;
2562 $p_header['crc'] = 0;
2563 $p_header['compressed_size'] = 0;
2564 $p_header['filename_len'] = strlen($p_filename);
2565 $p_header['extra_len'] = 0;
2566 $p_header['disk'] = 0;
2567 $p_header['internal'] = 0;
2568 $p_header['offset'] = 0;
2569 $p_header['filename'] = $p_filename;
2570 // TBC : Removed $p_header['stored_filename'] = $v_stored_filename;
2571 $p_header['stored_filename'] = $p_filedescr['stored_filename'];
2572 $p_header['extra'] = '';
2573 $p_header['status'] = 'ok';
2574 $p_header['index'] = -1;
2576 // ----- Look for regular file
2577 if ($p_filedescr['type']=='file') {
2578 $p_header['external'] = 0x00000000;
2579 $p_header['size'] = filesize($p_filename);
2582 // ----- Look for regular folder
2583 else if ($p_filedescr['type']=='folder') {
2584 $p_header['external'] = 0x00000010;
2585 $p_header['mtime'] = filemtime($p_filename);
2586 $p_header['size'] = filesize($p_filename);
2589 // ----- Look for virtual file
2590 else if ($p_filedescr['type'] == 'virtual_file') {
2591 $p_header['external'] = 0x00000000;
2592 $p_header['size'] = strlen($p_filedescr['content']);
2596 // ----- Look for filetime
2597 if (isset($p_filedescr['mtime'])) {
2598 $p_header['mtime'] = $p_filedescr['mtime'];
2600 else if ($p_filedescr['type'] == 'virtual_file') {
2601 $p_header['mtime'] = time();
2604 $p_header['mtime'] = filemtime($p_filename);
2607 // ------ Look for file comment
2608 if (isset($p_filedescr['comment'])) {
2609 $p_header['comment_len'] = strlen($p_filedescr['comment']);
2610 $p_header['comment'] = $p_filedescr['comment'];
2613 $p_header['comment_len'] = 0;
2614 $p_header['comment'] = '';
2617 // ----- Look for pre-add callback
2618 if (isset($p_options[PCLZIP_CB_PRE_ADD])) {
2620 // ----- Generate a local information
2621 $v_local_header = array();
2622 $this->privConvertHeader2FileInfo($p_header, $v_local_header);
2624 // ----- Call the callback
2625 // Here I do not use call_user_func() because I need to send a reference to the
2627 $v_result = $p_options[PCLZIP_CB_PRE_ADD](PCLZIP_CB_PRE_ADD, $v_local_header);
2628 if ($v_result == 0) {
2629 // ----- Change the file status
2630 $p_header['status'] = "skipped";
2634 // ----- Update the informations
2635 // Only some fields can be modified
2636 if ($p_header['stored_filename'] != $v_local_header['stored_filename']) {
2637 $p_header['stored_filename'] = PclZipUtilPathReduction($v_local_header['stored_filename']);
2641 // ----- Look for empty stored filename
2642 if ($p_header['stored_filename'] == "") {
2643 $p_header['status'] = "filtered";
2646 // ----- Check the path length
2647 if (strlen($p_header['stored_filename']) > 0xFF) {
2648 $p_header['status'] = 'filename_too_long';
2651 // ----- Look if no error, or file not skipped
2652 if ($p_header['status'] == 'ok') {
2654 // ----- Look for a file
2655 if ($p_filedescr['type'] == 'file') {
2656 // ----- Look for using temporary file to zip
2657 if ( (!isset($p_options[PCLZIP_OPT_TEMP_FILE_OFF]))
2658 && (isset($p_options[PCLZIP_OPT_TEMP_FILE_ON])
2659 || (isset($p_options[PCLZIP_OPT_TEMP_FILE_THRESHOLD])
2660 && ($p_options[PCLZIP_OPT_TEMP_FILE_THRESHOLD] <= $p_header['size'])) ) ) {
2661 $v_result = $this->privAddFileUsingTempFile($p_filedescr, $p_header, $p_options);
2662 if ($v_result < PCLZIP_ERR_NO_ERROR) {
2667 // ----- Use "in memory" zip algo
2670 // ----- Open the source file
2671 if (($v_file = @fopen($p_filename, "rb")) == 0) {
2672 PclZip::privErrorLog(PCLZIP_ERR_READ_OPEN_FAIL, "Unable to open file '$p_filename' in binary read mode");
2673 return PclZip::errorCode();
2676 // ----- Read the file content
2677 $v_content = @fread($v_file, $p_header['size']);
2679 // ----- Close the file
2682 // ----- Calculate the CRC
2683 $p_header['crc'] = @crc32($v_content);
2685 // ----- Look for no compression
2686 if ($p_options[PCLZIP_OPT_NO_COMPRESSION]) {
2687 // ----- Set header parameters
2688 $p_header['compressed_size'] = $p_header['size'];
2689 $p_header['compression'] = 0;
2692 // ----- Look for normal compression
2694 // ----- Compress the content
2695 $v_content = @gzdeflate($v_content);
2697 // ----- Set header parameters
2698 $p_header['compressed_size'] = strlen($v_content);
2699 $p_header['compression'] = 8;
2702 // ----- Call the header generation
2703 if (($v_result = $this->privWriteFileHeader($p_header)) != 1) {
2708 // ----- Write the compressed (or not) content
2709 @fwrite($this->zip_fd, $v_content, $p_header['compressed_size']);
2715 // ----- Look for a virtual file (a file from string)
2716 else if ($p_filedescr['type'] == 'virtual_file') {
2718 $v_content = $p_filedescr['content'];
2720 // ----- Calculate the CRC
2721 $p_header['crc'] = @crc32($v_content);
2723 // ----- Look for no compression
2724 if ($p_options[PCLZIP_OPT_NO_COMPRESSION]) {
2725 // ----- Set header parameters
2726 $p_header['compressed_size'] = $p_header['size'];
2727 $p_header['compression'] = 0;
2730 // ----- Look for normal compression
2732 // ----- Compress the content
2733 $v_content = @gzdeflate($v_content);
2735 // ----- Set header parameters
2736 $p_header['compressed_size'] = strlen($v_content);
2737 $p_header['compression'] = 8;
2740 // ----- Call the header generation
2741 if (($v_result = $this->privWriteFileHeader($p_header)) != 1) {
2746 // ----- Write the compressed (or not) content
2747 @fwrite($this->zip_fd, $v_content, $p_header['compressed_size']);
2750 // ----- Look for a directory
2751 else if ($p_filedescr['type'] == 'folder') {
2752 // ----- Look for directory last '/'
2753 if (@substr($p_header['stored_filename'], -1) != '/') {
2754 $p_header['stored_filename'] .= '/';
2757 // ----- Set the file properties
2758 $p_header['size'] = 0;
2759 //$p_header['external'] = 0x41FF0010; // Value for a folder : to be checked
2760 $p_header['external'] = 0x00000010; // Value for a folder : to be checked
2762 // ----- Call the header generation
2763 if (($v_result = $this->privWriteFileHeader($p_header)) != 1)
2770 // ----- Look for post-add callback
2771 if (isset($p_options[PCLZIP_CB_POST_ADD])) {
2773 // ----- Generate a local information
2774 $v_local_header = array();
2775 $this->privConvertHeader2FileInfo($p_header, $v_local_header);
2777 // ----- Call the callback
2778 // Here I do not use call_user_func() because I need to send a reference to the
2780 $v_result = $p_options[PCLZIP_CB_POST_ADD](PCLZIP_CB_POST_ADD, $v_local_header);
2781 if ($v_result == 0) {
2786 // ----- Update the informations
2787 // Nothing can be modified
2793 // --------------------------------------------------------------------------------
2795 // --------------------------------------------------------------------------------
2796 // Function : privAddFileUsingTempFile()
2800 // --------------------------------------------------------------------------------
2801 function privAddFileUsingTempFile($p_filedescr, &$p_header, &$p_options)
2803 $v_result=PCLZIP_ERR_NO_ERROR;
2805 // ----- Working variable
2806 $p_filename = $p_filedescr['filename'];
2809 // ----- Open the source file
2810 if (($v_file = @fopen($p_filename, "rb")) == 0) {
2811 PclZip::privErrorLog(PCLZIP_ERR_READ_OPEN_FAIL, "Unable to open file '$p_filename' in binary read mode");
2812 return PclZip::errorCode();
2815 // ----- Creates a compressed temporary file
2816 $v_gzip_temp_name = PCLZIP_TEMPORARY_DIR.uniqid('pclzip-').'.gz';
2817 if (($v_file_compressed = @gzopen($v_gzip_temp_name, "wb")) == 0) {
2819 PclZip::privErrorLog(PCLZIP_ERR_WRITE_OPEN_FAIL, 'Unable to open temporary file \''.$v_gzip_temp_name.'\' in binary write mode');
2820 return PclZip::errorCode();
2823 // ----- Read the file by PCLZIP_READ_BLOCK_SIZE octets blocks
2824 $v_size = filesize($p_filename);
2825 while ($v_size != 0) {
2826 $v_read_size = ($v_size < PCLZIP_READ_BLOCK_SIZE ? $v_size : PCLZIP_READ_BLOCK_SIZE);
2827 $v_buffer = @fread($v_file, $v_read_size);
2828 //$v_binary_data = pack('a'.$v_read_size, $v_buffer);
2829 @gzputs($v_file_compressed, $v_buffer, $v_read_size);
2830 $v_size -= $v_read_size;
2833 // ----- Close the file
2835 @gzclose($v_file_compressed);
2837 // ----- Check the minimum file size
2838 if (filesize($v_gzip_temp_name) < 18) {
2839 PclZip::privErrorLog(PCLZIP_ERR_BAD_FORMAT, 'gzip temporary file \''.$v_gzip_temp_name.'\' has invalid filesize - should be minimum 18 bytes');
2840 return PclZip::errorCode();
2843 // ----- Extract the compressed attributes
2844 if (($v_file_compressed = @fopen($v_gzip_temp_name, "rb")) == 0) {
2845 PclZip::privErrorLog(PCLZIP_ERR_READ_OPEN_FAIL, 'Unable to open temporary file \''.$v_gzip_temp_name.'\' in binary read mode');
2846 return PclZip::errorCode();
2849 // ----- Read the gzip file header
2850 $v_binary_data = @fread($v_file_compressed, 10);
2851 $v_data_header = unpack('a1id1/a1id2/a1cm/a1flag/Vmtime/a1xfl/a1os', $v_binary_data);
2853 // ----- Check some parameters
2854 $v_data_header['os'] = bin2hex($v_data_header['os']);
2856 // ----- Read the gzip file footer
2857 @fseek($v_file_compressed, filesize($v_gzip_temp_name)-8);
2858 $v_binary_data = @fread($v_file_compressed, 8);
2859 $v_data_footer = unpack('Vcrc/Vcompressed_size', $v_binary_data);
2861 // ----- Set the attributes
2862 $p_header['compression'] = ord($v_data_header['cm']);
2863 //$p_header['mtime'] = $v_data_header['mtime'];
2864 $p_header['crc'] = $v_data_footer['crc'];
2865 $p_header['compressed_size'] = filesize($v_gzip_temp_name)-18;
2867 // ----- Close the file
2868 @fclose($v_file_compressed);
2870 // ----- Call the header generation
2871 if (($v_result = $this->privWriteFileHeader($p_header)) != 1) {
2875 // ----- Add the compressed data
2876 if (($v_file_compressed = @fopen($v_gzip_temp_name, "rb")) == 0)
2878 PclZip::privErrorLog(PCLZIP_ERR_READ_OPEN_FAIL, 'Unable to open temporary file \''.$v_gzip_temp_name.'\' in binary read mode');
2879 return PclZip::errorCode();
2882 // ----- Read the file by PCLZIP_READ_BLOCK_SIZE octets blocks
2883 fseek($v_file_compressed, 10);
2884 $v_size = $p_header['compressed_size'];
2885 while ($v_size != 0)
2887 $v_read_size = ($v_size < PCLZIP_READ_BLOCK_SIZE ? $v_size : PCLZIP_READ_BLOCK_SIZE);
2888 $v_buffer = @fread($v_file_compressed, $v_read_size);
2889 //$v_binary_data = pack('a'.$v_read_size, $v_buffer);
2890 @fwrite($this->zip_fd, $v_buffer, $v_read_size);
2891 $v_size -= $v_read_size;
2894 // ----- Close the file
2895 @fclose($v_file_compressed);
2897 // ----- Unlink the temporary file
2898 @unlink($v_gzip_temp_name);
2903 // --------------------------------------------------------------------------------
2905 // --------------------------------------------------------------------------------
2906 // Function : privCalculateStoredFilename()
2908 // Based on file descriptor properties and global options, this method
2909 // calculate the filename that will be stored in the archive.
2912 // --------------------------------------------------------------------------------
2913 function privCalculateStoredFilename(&$p_filedescr, &$p_options)
2917 // ----- Working variables
2918 $p_filename = $p_filedescr['filename'];
2919 if (isset($p_options[PCLZIP_OPT_ADD_PATH])) {
2920 $p_add_dir = $p_options[PCLZIP_OPT_ADD_PATH];
2925 if (isset($p_options[PCLZIP_OPT_REMOVE_PATH])) {
2926 $p_remove_dir = $p_options[PCLZIP_OPT_REMOVE_PATH];
2931 if (isset($p_options[PCLZIP_OPT_REMOVE_ALL_PATH])) {
2932 $p_remove_all_dir = $p_options[PCLZIP_OPT_REMOVE_ALL_PATH];
2935 $p_remove_all_dir = 0;
2939 // ----- Look for full name change
2940 if (isset($p_filedescr['new_full_name'])) {
2941 // ----- Remove drive letter if any
2942 $v_stored_filename = PclZipUtilTranslateWinPath($p_filedescr['new_full_name']);
2945 // ----- Look for path and/or short name change
2948 // ----- Look for short name change
2949 // Its when we cahnge just the filename but not the path
2950 if (isset($p_filedescr['new_short_name'])) {
2951 $v_path_info = pathinfo($p_filename);
2953 if ($v_path_info['dirname'] != '') {
2954 $v_dir = $v_path_info['dirname'].'/';
2956 $v_stored_filename = $v_dir.$p_filedescr['new_short_name'];
2959 // ----- Calculate the stored filename
2960 $v_stored_filename = $p_filename;
2963 // ----- Look for all path to remove
2964 if ($p_remove_all_dir) {
2965 $v_stored_filename = basename($p_filename);
2967 // ----- Look for partial path remove
2968 else if ($p_remove_dir != "") {
2969 if (substr($p_remove_dir, -1) != '/')
2970 $p_remove_dir .= "/";
2972 if ( (substr($p_filename, 0, 2) == "./")
2973 || (substr($p_remove_dir, 0, 2) == "./")) {
2975 if ( (substr($p_filename, 0, 2) == "./")
2976 && (substr($p_remove_dir, 0, 2) != "./")) {
2977 $p_remove_dir = "./".$p_remove_dir;
2979 if ( (substr($p_filename, 0, 2) != "./")
2980 && (substr($p_remove_dir, 0, 2) == "./")) {
2981 $p_remove_dir = substr($p_remove_dir, 2);
2985 $v_compare = PclZipUtilPathInclusion($p_remove_dir,
2986 $v_stored_filename);
2987 if ($v_compare > 0) {
2988 if ($v_compare == 2) {
2989 $v_stored_filename = "";
2992 $v_stored_filename = substr($v_stored_filename,
2993 strlen($p_remove_dir));
2998 // ----- Remove drive letter if any
2999 $v_stored_filename = PclZipUtilTranslateWinPath($v_stored_filename);
3001 // ----- Look for path to add
3002 if ($p_add_dir != "") {
3003 if (substr($p_add_dir, -1) == "/")
3004 $v_stored_filename = $p_add_dir.$v_stored_filename;
3006 $v_stored_filename = $p_add_dir."/".$v_stored_filename;
3010 // ----- Filename (reduce the path of stored name)
3011 $v_stored_filename = PclZipUtilPathReduction($v_stored_filename);
3012 $p_filedescr['stored_filename'] = $v_stored_filename;
3017 // --------------------------------------------------------------------------------
3019 // --------------------------------------------------------------------------------
3020 // Function : privWriteFileHeader()
3024 // --------------------------------------------------------------------------------
3025 function privWriteFileHeader(&$p_header)
3029 // ----- Store the offset position of the file
3030 $p_header['offset'] = ftell($this->zip_fd);
3032 // ----- Transform UNIX mtime to DOS format mdate/mtime
3033 $v_date = getdate($p_header['mtime']);
3034 $v_mtime = ($v_date['hours']<<11) + ($v_date['minutes']<<5) + $v_date['seconds']/2;
3035 $v_mdate = (($v_date['year']-1980)<<9) + ($v_date['mon']<<5) + $v_date['mday'];
3037 // ----- Packed data
3038 $v_binary_data = pack("VvvvvvVVVvv", 0x04034b50,
3039 $p_header['version_extracted'], $p_header['flag'],
3040 $p_header['compression'], $v_mtime, $v_mdate,
3041 $p_header['crc'], $p_header['compressed_size'],
3043 strlen($p_header['stored_filename']),
3044 $p_header['extra_len']);
3046 // ----- Write the first 148 bytes of the header in the archive
3047 fputs($this->zip_fd, $v_binary_data, 30);
3049 // ----- Write the variable fields
3050 if (strlen($p_header['stored_filename']) != 0)
3052 fputs($this->zip_fd, $p_header['stored_filename'], strlen($p_header['stored_filename']));
3054 if ($p_header['extra_len'] != 0)
3056 fputs($this->zip_fd, $p_header['extra'], $p_header['extra_len']);
3062 // --------------------------------------------------------------------------------
3064 // --------------------------------------------------------------------------------
3065 // Function : privWriteCentralFileHeader()
3069 // --------------------------------------------------------------------------------
3070 function privWriteCentralFileHeader(&$p_header)
3075 //for(reset($p_header); $key = key($p_header); next($p_header)) {
3078 // ----- Transform UNIX mtime to DOS format mdate/mtime
3079 $v_date = getdate($p_header['mtime']);
3080 $v_mtime = ($v_date['hours']<<11) + ($v_date['minutes']<<5) + $v_date['seconds']/2;
3081 $v_mdate = (($v_date['year']-1980)<<9) + ($v_date['mon']<<5) + $v_date['mday'];
3084 // ----- Packed data
3085 $v_binary_data = pack("VvvvvvvVVVvvvvvVV", 0x02014b50,
3086 $p_header['version'], $p_header['version_extracted'],
3087 $p_header['flag'], $p_header['compression'],
3088 $v_mtime, $v_mdate, $p_header['crc'],
3089 $p_header['compressed_size'], $p_header['size'],
3090 strlen($p_header['stored_filename']),
3091 $p_header['extra_len'], $p_header['comment_len'],
3092 $p_header['disk'], $p_header['internal'],
3093 $p_header['external'], $p_header['offset']);
3095 // ----- Write the 42 bytes of the header in the zip file
3096 fputs($this->zip_fd, $v_binary_data, 46);
3098 // ----- Write the variable fields
3099 if (strlen($p_header['stored_filename']) != 0)
3101 fputs($this->zip_fd, $p_header['stored_filename'], strlen($p_header['stored_filename']));
3103 if ($p_header['extra_len'] != 0)
3105 fputs($this->zip_fd, $p_header['extra'], $p_header['extra_len']);
3107 if ($p_header['comment_len'] != 0)
3109 fputs($this->zip_fd, $p_header['comment'], $p_header['comment_len']);
3115 // --------------------------------------------------------------------------------
3117 // --------------------------------------------------------------------------------
3118 // Function : privWriteCentralHeader()
3122 // --------------------------------------------------------------------------------
3123 function privWriteCentralHeader($p_nb_entries, $p_size, $p_offset, $p_comment)
3127 // ----- Packed data
3128 $v_binary_data = pack("VvvvvVVv", 0x06054b50, 0, 0, $p_nb_entries,
3129 $p_nb_entries, $p_size,
3130 $p_offset, strlen($p_comment));
3132 // ----- Write the 22 bytes of the header in the zip file
3133 fputs($this->zip_fd, $v_binary_data, 22);
3135 // ----- Write the variable fields
3136 if (strlen($p_comment) != 0)
3138 fputs($this->zip_fd, $p_comment, strlen($p_comment));
3144 // --------------------------------------------------------------------------------
3146 // --------------------------------------------------------------------------------
3147 // Function : privList()
3151 // --------------------------------------------------------------------------------
3152 function privList(&$p_list)
3156 // ----- Magic quotes trick
3157 $this->privDisableMagicQuotes();
3159 // ----- Open the zip file
3160 if (($this->zip_fd = @fopen($this->zipname, 'rb')) == 0)
3162 // ----- Magic quotes trick
3163 $this->privSwapBackMagicQuotes();
3166 PclZip::privErrorLog(PCLZIP_ERR_READ_OPEN_FAIL, 'Unable to open archive \''.$this->zipname.'\' in binary read mode');
3169 return PclZip::errorCode();
3172 // ----- Read the central directory informations
3173 $v_central_dir = array();
3174 if (($v_result = $this->privReadEndCentralDir($v_central_dir)) != 1)
3176 $this->privSwapBackMagicQuotes();
3180 // ----- Go to beginning of Central Dir
3181 @rewind($this->zip_fd);
3182 if (@fseek($this->zip_fd, $v_central_dir['offset']))
3184 $this->privSwapBackMagicQuotes();
3187 PclZip::privErrorLog(PCLZIP_ERR_INVALID_ARCHIVE_ZIP, 'Invalid archive size');
3190 return PclZip::errorCode();
3193 // ----- Read each entry
3194 for ($i=0; $i<$v_central_dir['entries']; $i++)
3196 // ----- Read the file header
3197 if (($v_result = $this->privReadCentralFileHeader($v_header)) != 1)
3199 $this->privSwapBackMagicQuotes();
3202 $v_header['index'] = $i;
3204 // ----- Get the only interesting attributes
3205 $this->privConvertHeader2FileInfo($v_header, $p_list[$i]);
3209 // ----- Close the zip file
3210 $this->privCloseFd();
3212 // ----- Magic quotes trick
3213 $this->privSwapBackMagicQuotes();
3218 // --------------------------------------------------------------------------------
3220 // --------------------------------------------------------------------------------
3221 // Function : privConvertHeader2FileInfo()
3223 // This function takes the file informations from the central directory
3224 // entries and extract the interesting parameters that will be given back.
3225 // The resulting file infos are set in the array $p_info
3226 // $p_info['filename'] : Filename with full path. Given by user (add),
3227 // extracted in the filesystem (extract).
3228 // $p_info['stored_filename'] : Stored filename in the archive.
3229 // $p_info['size'] = Size of the file.
3230 // $p_info['compressed_size'] = Compressed size of the file.
3231 // $p_info['mtime'] = Last modification date of the file.
3232 // $p_info['comment'] = Comment associated with the file.
3233 // $p_info['folder'] = true/false : indicates if the entry is a folder or not.
3234 // $p_info['status'] = status of the action on the file.
3235 // $p_info['crc'] = CRC of the file content.
3238 // --------------------------------------------------------------------------------
3239 function privConvertHeader2FileInfo($p_header, &$p_info)
3243 // ----- Get the interesting attributes
3244 $v_temp_path = PclZipUtilPathReduction($p_header['filename']);
3245 $p_info['filename'] = $v_temp_path;
3246 $v_temp_path = PclZipUtilPathReduction($p_header['stored_filename']);
3247 $p_info['stored_filename'] = $v_temp_path;
3248 $p_info['size'] = $p_header['size'];
3249 $p_info['compressed_size'] = $p_header['compressed_size'];
3250 $p_info['mtime'] = $p_header['mtime'];
3251 $p_info['comment'] = $p_header['comment'];
3252 $p_info['folder'] = (($p_header['external']&0x00000010)==0x00000010);
3253 $p_info['index'] = $p_header['index'];
3254 $p_info['status'] = $p_header['status'];
3255 $p_info['crc'] = $p_header['crc'];
3260 // --------------------------------------------------------------------------------
3262 // --------------------------------------------------------------------------------
3263 // Function : privExtractByRule()
3265 // Extract a file or directory depending of rules (by index, by name, ...)
3267 // $p_file_list : An array where will be placed the properties of each
3269 // $p_path : Path to add while writing the extracted files
3270 // $p_remove_path : Path to remove (from the file memorized path) while writing the
3271 // extracted files. If the path does not match the file path,
3272 // the file is extracted with its memorized path.
3273 // $p_remove_path does not apply to 'list' mode.
3274 // $p_path and $p_remove_path are commulative.
3276 // 1 on success,0 or less on error (see error code list)
3277 // --------------------------------------------------------------------------------
3278 function privExtractByRule(&$p_file_list, $p_path, $p_remove_path, $p_remove_all_path, &$p_options)
3282 // ----- Magic quotes trick
3283 $this->privDisableMagicQuotes();
3285 // ----- Check the path
3286 if ( ($p_path == "")
3287 || ( (substr($p_path, 0, 1) != "/")
3288 && (substr($p_path, 0, 3) != "../")
3289 && (substr($p_path,1,2)!=":/")))
3290 $p_path = "./".$p_path;
3292 // ----- Reduce the path last (and duplicated) '/'
3293 if (($p_path != "./") && ($p_path != "/"))
3295 // ----- Look for the path end '/'
3296 while (substr($p_path, -1) == "/")
3298 $p_path = substr($p_path, 0, strlen($p_path)-1);
3302 // ----- Look for path to remove format (should end by /)
3303 if (($p_remove_path != "") && (substr($p_remove_path, -1) != '/'))
3305 $p_remove_path .= '/';
3307 $p_remove_path_size = strlen($p_remove_path);
3309 // ----- Open the zip file
3310 if (($v_result = $this->privOpenFd('rb')) != 1)
3312 $this->privSwapBackMagicQuotes();
3316 // ----- Read the central directory informations
3317 $v_central_dir = array();
3318 if (($v_result = $this->privReadEndCentralDir($v_central_dir)) != 1)
3320 // ----- Close the zip file
3321 $this->privCloseFd();
3322 $this->privSwapBackMagicQuotes();
3327 // ----- Start at beginning of Central Dir
3328 $v_pos_entry = $v_central_dir['offset'];
3330 // ----- Read each entry
3332 for ($i=0, $v_nb_extracted=0; $i<$v_central_dir['entries']; $i++)
3335 // ----- Read next Central dir entry
3336 @rewind($this->zip_fd);
3337 if (@fseek($this->zip_fd, $v_pos_entry))
3339 // ----- Close the zip file
3340 $this->privCloseFd();
3341 $this->privSwapBackMagicQuotes();
3344 PclZip::privErrorLog(PCLZIP_ERR_INVALID_ARCHIVE_ZIP, 'Invalid archive size');
3347 return PclZip::errorCode();
3350 // ----- Read the file header
3351 $v_header = array();
3352 if (($v_result = $this->privReadCentralFileHeader($v_header)) != 1)
3354 // ----- Close the zip file
3355 $this->privCloseFd();
3356 $this->privSwapBackMagicQuotes();
3361 // ----- Store the index
3362 $v_header['index'] = $i;
3364 // ----- Store the file position
3365 $v_pos_entry = ftell($this->zip_fd);
3367 // ----- Look for the specific extract rules
3370 // ----- Look for extract by name rule
3371 if ( (isset($p_options[PCLZIP_OPT_BY_NAME]))
3372 && ($p_options[PCLZIP_OPT_BY_NAME] != 0)) {
3374 // ----- Look if the filename is in the list
3375 for ($j=0; ($j<sizeof($p_options[PCLZIP_OPT_BY_NAME])) && (!$v_extract); $j++) {
3377 // ----- Look for a directory
3378 if (substr($p_options[PCLZIP_OPT_BY_NAME][$j], -1) == "/") {
3380 // ----- Look if the directory is in the filename path
3381 if ( (strlen($v_header['stored_filename']) > strlen($p_options[PCLZIP_OPT_BY_NAME][$j]))
3382 && (substr($v_header['stored_filename'], 0, strlen($p_options[PCLZIP_OPT_BY_NAME][$j])) == $p_options[PCLZIP_OPT_BY_NAME][$j])) {
3386 // ----- Look for a filename
3387 elseif ($v_header['stored_filename'] == $p_options[PCLZIP_OPT_BY_NAME][$j]) {
3393 // ----- Look for extract by ereg rule
3394 // ereg() is deprecated with PHP 5.3
3396 else if ( (isset($p_options[PCLZIP_OPT_BY_EREG]))
3397 && ($p_options[PCLZIP_OPT_BY_EREG] != "")) {
3399 if (ereg($p_options[PCLZIP_OPT_BY_EREG], $v_header['stored_filename'])) {
3405 // ----- Look for extract by preg rule
3406 else if ( (isset($p_options[PCLZIP_OPT_BY_PREG]))
3407 && ($p_options[PCLZIP_OPT_BY_PREG] != "")) {
3409 if (preg_match($p_options[PCLZIP_OPT_BY_PREG], $v_header['stored_filename'])) {
3414 // ----- Look for extract by index rule
3415 else if ( (isset($p_options[PCLZIP_OPT_BY_INDEX]))
3416 && ($p_options[PCLZIP_OPT_BY_INDEX] != 0)) {
3418 // ----- Look if the index is in the list
3419 for ($j=$j_start; ($j<sizeof($p_options[PCLZIP_OPT_BY_INDEX])) && (!$v_extract); $j++) {
3421 if (($i>=$p_options[PCLZIP_OPT_BY_INDEX][$j]['start']) && ($i<=$p_options[PCLZIP_OPT_BY_INDEX][$j]['end'])) {
3424 if ($i>=$p_options[PCLZIP_OPT_BY_INDEX][$j]['end']) {
3428 if ($p_options[PCLZIP_OPT_BY_INDEX][$j]['start']>$i) {
3434 // ----- Look for no rule, which means extract all the archive
3439 // ----- Check compression method
3441 && ( ($v_header['compression'] != 8)
3442 && ($v_header['compression'] != 0))) {
3443 $v_header['status'] = 'unsupported_compression';
3445 // ----- Look for PCLZIP_OPT_STOP_ON_ERROR
3446 if ( (isset($p_options[PCLZIP_OPT_STOP_ON_ERROR]))
3447 && ($p_options[PCLZIP_OPT_STOP_ON_ERROR]===true)) {
3449 $this->privSwapBackMagicQuotes();
3451 PclZip::privErrorLog(PCLZIP_ERR_UNSUPPORTED_COMPRESSION,
3452 "Filename '".$v_header['stored_filename']."' is "
3453 ."compressed by an unsupported compression "
3454 ."method (".$v_header['compression'].") ");
3456 return PclZip::errorCode();
3460 // ----- Check encrypted files
3461 if (($v_extract) && (($v_header['flag'] & 1) == 1)) {
3462 $v_header['status'] = 'unsupported_encryption';
3464 // ----- Look for PCLZIP_OPT_STOP_ON_ERROR
3465 if ( (isset($p_options[PCLZIP_OPT_STOP_ON_ERROR]))
3466 && ($p_options[PCLZIP_OPT_STOP_ON_ERROR]===true)) {
3468 $this->privSwapBackMagicQuotes();
3470 PclZip::privErrorLog(PCLZIP_ERR_UNSUPPORTED_ENCRYPTION,
3471 "Unsupported encryption for "
3472 ." filename '".$v_header['stored_filename']
3475 return PclZip::errorCode();
3479 // ----- Look for real extraction
3480 if (($v_extract) && ($v_header['status'] != 'ok')) {
3481 $v_result = $this->privConvertHeader2FileInfo($v_header,
3482 $p_file_list[$v_nb_extracted++]);
3483 if ($v_result != 1) {
3484 $this->privCloseFd();
3485 $this->privSwapBackMagicQuotes();
3492 // ----- Look for real extraction
3496 // ----- Go to the file position
3497 @rewind($this->zip_fd);
3498 if (@fseek($this->zip_fd, $v_header['offset']))
3500 // ----- Close the zip file
3501 $this->privCloseFd();
3503 $this->privSwapBackMagicQuotes();
3506 PclZip::privErrorLog(PCLZIP_ERR_INVALID_ARCHIVE_ZIP, 'Invalid archive size');
3509 return PclZip::errorCode();
3512 // ----- Look for extraction as string
3513 if ($p_options[PCLZIP_OPT_EXTRACT_AS_STRING]) {
3517 // ----- Extracting the file
3518 $v_result1 = $this->privExtractFileAsString($v_header, $v_string, $p_options);
3519 if ($v_result1 < 1) {
3520 $this->privCloseFd();
3521 $this->privSwapBackMagicQuotes();
3525 // ----- Get the only interesting attributes
3526 if (($v_result = $this->privConvertHeader2FileInfo($v_header, $p_file_list[$v_nb_extracted])) != 1)
3528 // ----- Close the zip file
3529 $this->privCloseFd();
3530 $this->privSwapBackMagicQuotes();
3535 // ----- Set the file content
3536 $p_file_list[$v_nb_extracted]['content'] = $v_string;
3538 // ----- Next extracted file
3541 // ----- Look for user callback abort
3542 if ($v_result1 == 2) {
3546 // ----- Look for extraction in standard output
3547 elseif ( (isset($p_options[PCLZIP_OPT_EXTRACT_IN_OUTPUT]))
3548 && ($p_options[PCLZIP_OPT_EXTRACT_IN_OUTPUT])) {
3549 // ----- Extracting the file in standard output
3550 $v_result1 = $this->privExtractFileInOutput($v_header, $p_options);
3551 if ($v_result1 < 1) {
3552 $this->privCloseFd();
3553 $this->privSwapBackMagicQuotes();
3557 // ----- Get the only interesting attributes
3558 if (($v_result = $this->privConvertHeader2FileInfo($v_header, $p_file_list[$v_nb_extracted++])) != 1) {
3559 $this->privCloseFd();
3560 $this->privSwapBackMagicQuotes();
3564 // ----- Look for user callback abort
3565 if ($v_result1 == 2) {
3569 // ----- Look for normal extraction
3571 // ----- Extracting the file
3572 $v_result1 = $this->privExtractFile($v_header,
3573 $p_path, $p_remove_path,
3576 if ($v_result1 < 1) {
3577 $this->privCloseFd();
3578 $this->privSwapBackMagicQuotes();
3582 // ----- Get the only interesting attributes
3583 if (($v_result = $this->privConvertHeader2FileInfo($v_header, $p_file_list[$v_nb_extracted++])) != 1)
3585 // ----- Close the zip file
3586 $this->privCloseFd();
3587 $this->privSwapBackMagicQuotes();
3592 // ----- Look for user callback abort
3593 if ($v_result1 == 2) {
3600 // ----- Close the zip file
3601 $this->privCloseFd();
3602 $this->privSwapBackMagicQuotes();
3607 // --------------------------------------------------------------------------------
3609 // --------------------------------------------------------------------------------
3610 // Function : privExtractFile()
3616 // PCLZIP_ERR_USER_ABORTED(2) : User ask for extraction stop in callback
3617 // --------------------------------------------------------------------------------
3618 function privExtractFile(&$p_entry, $p_path, $p_remove_path, $p_remove_all_path, &$p_options)
3622 // ----- Read the file header
3623 if (($v_result = $this->privReadFileHeader($v_header)) != 1)
3630 // ----- Check that the file header is coherent with $p_entry info
3631 if ($this->privCheckFileHeaders($v_header, $p_entry) != 1) {
3635 // ----- Look for all path to remove
3636 if ($p_remove_all_path == true) {
3637 // ----- Look for folder entry that not need to be extracted
3638 if (($p_entry['external']&0x00000010)==0x00000010) {
3640 $p_entry['status'] = "filtered";
3645 // ----- Get the basename of the path
3646 $p_entry['filename'] = basename($p_entry['filename']);
3649 // ----- Look for path to remove
3650 else if ($p_remove_path != "")
3652 if (PclZipUtilPathInclusion($p_remove_path, $p_entry['filename']) == 2)
3655 // ----- Change the file status
3656 $p_entry['status'] = "filtered";
3662 $p_remove_path_size = strlen($p_remove_path);
3663 if (substr($p_entry['filename'], 0, $p_remove_path_size) == $p_remove_path)
3666 // ----- Remove the path
3667 $p_entry['filename'] = substr($p_entry['filename'], $p_remove_path_size);
3672 // ----- Add the path
3673 if ($p_path != '') {
3674 $p_entry['filename'] = $p_path."/".$p_entry['filename'];
3677 // ----- Check a base_dir_restriction
3678 if (isset($p_options[PCLZIP_OPT_EXTRACT_DIR_RESTRICTION])) {
3680 = PclZipUtilPathInclusion($p_options[PCLZIP_OPT_EXTRACT_DIR_RESTRICTION],
3681 $p_entry['filename']);
3682 if ($v_inclusion == 0) {
3684 PclZip::privErrorLog(PCLZIP_ERR_DIRECTORY_RESTRICTION,
3685 "Filename '".$p_entry['filename']."' is "
3686 ."outside PCLZIP_OPT_EXTRACT_DIR_RESTRICTION");
3688 return PclZip::errorCode();
3692 // ----- Look for pre-extract callback
3693 if (isset($p_options[PCLZIP_CB_PRE_EXTRACT])) {
3695 // ----- Generate a local information
3696 $v_local_header = array();
3697 $this->privConvertHeader2FileInfo($p_entry, $v_local_header);
3699 // ----- Call the callback
3700 // Here I do not use call_user_func() because I need to send a reference to the
3702 $v_result = $p_options[PCLZIP_CB_PRE_EXTRACT](PCLZIP_CB_PRE_EXTRACT, $v_local_header);
3703 if ($v_result == 0) {
3704 // ----- Change the file status
3705 $p_entry['status'] = "skipped";
3709 // ----- Look for abort result
3710 if ($v_result == 2) {
3711 // ----- This status is internal and will be changed in 'skipped'
3712 $p_entry['status'] = "aborted";
3713 $v_result = PCLZIP_ERR_USER_ABORTED;
3716 // ----- Update the informations
3717 // Only some fields can be modified
3718 $p_entry['filename'] = $v_local_header['filename'];
3722 // ----- Look if extraction should be done
3723 if ($p_entry['status'] == 'ok') {
3725 // ----- Look for specific actions while the file exist
3726 if (file_exists($p_entry['filename']))
3729 // ----- Look if file is a directory
3730 if (is_dir($p_entry['filename']))
3733 // ----- Change the file status
3734 $p_entry['status'] = "already_a_directory";
3736 // ----- Look for PCLZIP_OPT_STOP_ON_ERROR
3737 // For historical reason first PclZip implementation does not stop
3738 // when this kind of error occurs.
3739 if ( (isset($p_options[PCLZIP_OPT_STOP_ON_ERROR]))
3740 && ($p_options[PCLZIP_OPT_STOP_ON_ERROR]===true)) {
3742 PclZip::privErrorLog(PCLZIP_ERR_ALREADY_A_DIRECTORY,
3743 "Filename '".$p_entry['filename']."' is "
3744 ."already used by an existing directory");
3746 return PclZip::errorCode();
3749 // ----- Look if file is write protected
3750 else if (!is_writeable($p_entry['filename']))
3753 // ----- Change the file status
3754 $p_entry['status'] = "write_protected";
3756 // ----- Look for PCLZIP_OPT_STOP_ON_ERROR
3757 // For historical reason first PclZip implementation does not stop
3758 // when this kind of error occurs.
3759 if ( (isset($p_options[PCLZIP_OPT_STOP_ON_ERROR]))
3760 && ($p_options[PCLZIP_OPT_STOP_ON_ERROR]===true)) {
3762 PclZip::privErrorLog(PCLZIP_ERR_WRITE_OPEN_FAIL,
3763 "Filename '".$p_entry['filename']."' exists "
3764 ."and is write protected");
3766 return PclZip::errorCode();
3770 // ----- Look if the extracted file is older
3771 else if (filemtime($p_entry['filename']) > $p_entry['mtime'])
3773 // ----- Change the file status
3774 if ( (isset($p_options[PCLZIP_OPT_REPLACE_NEWER]))
3775 && ($p_options[PCLZIP_OPT_REPLACE_NEWER]===true)) {
3778 $p_entry['status'] = "newer_exist";
3780 // ----- Look for PCLZIP_OPT_STOP_ON_ERROR
3781 // For historical reason first PclZip implementation does not stop
3782 // when this kind of error occurs.
3783 if ( (isset($p_options[PCLZIP_OPT_STOP_ON_ERROR]))
3784 && ($p_options[PCLZIP_OPT_STOP_ON_ERROR]===true)) {
3786 PclZip::privErrorLog(PCLZIP_ERR_WRITE_OPEN_FAIL,
3787 "Newer version of '".$p_entry['filename']."' exists "
3788 ."and option PCLZIP_OPT_REPLACE_NEWER is not selected");
3790 return PclZip::errorCode();
3798 // ----- Check the directory availability and create it if necessary
3800 if ((($p_entry['external']&0x00000010)==0x00000010) || (substr($p_entry['filename'], -1) == '/'))
3801 $v_dir_to_check = $p_entry['filename'];
3802 else if (!strstr($p_entry['filename'], "/"))
3803 $v_dir_to_check = "";
3805 $v_dir_to_check = dirname($p_entry['filename']);
3807 if (($v_result = $this->privDirCheck($v_dir_to_check, (($p_entry['external']&0x00000010)==0x00000010))) != 1) {
3809 // ----- Change the file status
3810 $p_entry['status'] = "path_creation_fail";
3819 // ----- Look if extraction should be done
3820 if ($p_entry['status'] == 'ok') {
3822 // ----- Do the extraction (if not a folder)
3823 if (!(($p_entry['external']&0x00000010)==0x00000010))
3825 // ----- Look for not compressed file
3826 if ($p_entry['compression'] == 0) {
3828 // ----- Opening destination file
3829 if (($v_dest_file = @fopen($p_entry['filename'], 'wb')) == 0)
3832 // ----- Change the file status
3833 $p_entry['status'] = "write_error";
3840 // ----- Read the file by PCLZIP_READ_BLOCK_SIZE octets blocks
3841 $v_size = $p_entry['compressed_size'];
3842 while ($v_size != 0)
3844 $v_read_size = ($v_size < PCLZIP_READ_BLOCK_SIZE ? $v_size : PCLZIP_READ_BLOCK_SIZE);
3845 $v_buffer = @fread($this->zip_fd, $v_read_size);
3846 /* Try to speed up the code
3847 $v_binary_data = pack('a'.$v_read_size, $v_buffer);
3848 @fwrite($v_dest_file, $v_binary_data, $v_read_size);
3850 @fwrite($v_dest_file, $v_buffer, $v_read_size);
3851 $v_size -= $v_read_size;
3854 // ----- Closing the destination file
3855 fclose($v_dest_file);
3857 // ----- Change the file mtime
3858 touch($p_entry['filename'], $p_entry['mtime']);
3864 // Need to be finished
3865 if (($p_entry['flag'] & 1) == 1) {
3866 PclZip::privErrorLog(PCLZIP_ERR_UNSUPPORTED_ENCRYPTION, 'File \''.$p_entry['filename'].'\' is encrypted. Encrypted files are not supported.');
3867 return PclZip::errorCode();
3871 // ----- Look for using temporary file to unzip
3872 if ( (!isset($p_options[PCLZIP_OPT_TEMP_FILE_OFF]))
3873 && (isset($p_options[PCLZIP_OPT_TEMP_FILE_ON])
3874 || (isset($p_options[PCLZIP_OPT_TEMP_FILE_THRESHOLD])
3875 && ($p_options[PCLZIP_OPT_TEMP_FILE_THRESHOLD] <= $p_entry['size'])) ) ) {
3876 $v_result = $this->privExtractFileUsingTempFile($p_entry, $p_options);
3877 if ($v_result < PCLZIP_ERR_NO_ERROR) {
3882 // ----- Look for extract in memory
3886 // ----- Read the compressed file in a buffer (one shot)
3887 $v_buffer = @fread($this->zip_fd, $p_entry['compressed_size']);
3889 // ----- Decompress the file
3890 $v_file_content = @gzinflate($v_buffer);
3892 if ($v_file_content === FALSE) {
3894 // ----- Change the file status
3896 $p_entry['status'] = "error";
3901 // ----- Opening destination file
3902 if (($v_dest_file = @fopen($p_entry['filename'], 'wb')) == 0) {
3904 // ----- Change the file status
3905 $p_entry['status'] = "write_error";
3910 // ----- Write the uncompressed data
3911 @fwrite($v_dest_file, $v_file_content, $p_entry['size']);
3912 unset($v_file_content);
3914 // ----- Closing the destination file
3915 @fclose($v_dest_file);
3919 // ----- Change the file mtime
3920 @touch($p_entry['filename'], $p_entry['mtime']);
3923 // ----- Look for chmod option
3924 if (isset($p_options[PCLZIP_OPT_SET_CHMOD])) {
3926 // ----- Change the mode of the file
3927 @chmod($p_entry['filename'], $p_options[PCLZIP_OPT_SET_CHMOD]);
3933 // ----- Change abort status
3934 if ($p_entry['status'] == "aborted") {
3935 $p_entry['status'] = "skipped";
3938 // ----- Look for post-extract callback
3939 elseif (isset($p_options[PCLZIP_CB_POST_EXTRACT])) {
3941 // ----- Generate a local information
3942 $v_local_header = array();
3943 $this->privConvertHeader2FileInfo($p_entry, $v_local_header);
3945 // ----- Call the callback
3946 // Here I do not use call_user_func() because I need to send a reference to the
3948 $v_result = $p_options[PCLZIP_CB_POST_EXTRACT](PCLZIP_CB_POST_EXTRACT, $v_local_header);
3950 // ----- Look for abort result
3951 if ($v_result == 2) {
3952 $v_result = PCLZIP_ERR_USER_ABORTED;
3959 // --------------------------------------------------------------------------------
3961 // --------------------------------------------------------------------------------
3962 // Function : privExtractFileUsingTempFile()
3966 // --------------------------------------------------------------------------------
3967 function privExtractFileUsingTempFile(&$p_entry, &$p_options)
3971 // ----- Creates a temporary file
3972 $v_gzip_temp_name = PCLZIP_TEMPORARY_DIR.uniqid('pclzip-').'.gz';
3973 if (($v_dest_file = @fopen($v_gzip_temp_name, "wb")) == 0) {
3975 PclZip::privErrorLog(PCLZIP_ERR_WRITE_OPEN_FAIL, 'Unable to open temporary file \''.$v_gzip_temp_name.'\' in binary write mode');
3976 return PclZip::errorCode();
3980 // ----- Write gz file format header
3981 $v_binary_data = pack('va1a1Va1a1', 0x8b1f, Chr($p_entry['compression']), Chr(0x00), time(), Chr(0x00), Chr(3));
3982 @fwrite($v_dest_file, $v_binary_data, 10);
3984 // ----- Read the file by PCLZIP_READ_BLOCK_SIZE octets blocks
3985 $v_size = $p_entry['compressed_size'];
3986 while ($v_size != 0)
3988 $v_read_size = ($v_size < PCLZIP_READ_BLOCK_SIZE ? $v_size : PCLZIP_READ_BLOCK_SIZE);
3989 $v_buffer = @fread($this->zip_fd, $v_read_size);
3990 //$v_binary_data = pack('a'.$v_read_size, $v_buffer);
3991 @fwrite($v_dest_file, $v_buffer, $v_read_size);
3992 $v_size -= $v_read_size;
3995 // ----- Write gz file format footer
3996 $v_binary_data = pack('VV', $p_entry['crc'], $p_entry['size']);
3997 @fwrite($v_dest_file, $v_binary_data, 8);
3999 // ----- Close the temporary file
4000 @fclose($v_dest_file);
4002 // ----- Opening destination file
4003 if (($v_dest_file = @fopen($p_entry['filename'], 'wb')) == 0) {
4004 $p_entry['status'] = "write_error";
4008 // ----- Open the temporary gz file
4009 if (($v_src_file = @gzopen($v_gzip_temp_name, 'rb')) == 0) {
4010 @fclose($v_dest_file);
4011 $p_entry['status'] = "read_error";
4012 PclZip::privErrorLog(PCLZIP_ERR_READ_OPEN_FAIL, 'Unable to open temporary file \''.$v_gzip_temp_name.'\' in binary read mode');
4013 return PclZip::errorCode();
4017 // ----- Read the file by PCLZIP_READ_BLOCK_SIZE octets blocks
4018 $v_size = $p_entry['size'];
4019 while ($v_size != 0) {
4020 $v_read_size = ($v_size < PCLZIP_READ_BLOCK_SIZE ? $v_size : PCLZIP_READ_BLOCK_SIZE);
4021 $v_buffer = @gzread($v_src_file, $v_read_size);
4022 //$v_binary_data = pack('a'.$v_read_size, $v_buffer);
4023 @fwrite($v_dest_file, $v_buffer, $v_read_size);
4024 $v_size -= $v_read_size;
4026 @fclose($v_dest_file);
4027 @gzclose($v_src_file);
4029 // ----- Delete the temporary file
4030 @unlink($v_gzip_temp_name);
4035 // --------------------------------------------------------------------------------
4037 // --------------------------------------------------------------------------------
4038 // Function : privExtractFileInOutput()
4042 // --------------------------------------------------------------------------------
4043 function privExtractFileInOutput(&$p_entry, &$p_options)
4047 // ----- Read the file header
4048 if (($v_result = $this->privReadFileHeader($v_header)) != 1) {
4053 // ----- Check that the file header is coherent with $p_entry info
4054 if ($this->privCheckFileHeaders($v_header, $p_entry) != 1) {
4058 // ----- Look for pre-extract callback
4059 if (isset($p_options[PCLZIP_CB_PRE_EXTRACT])) {
4061 // ----- Generate a local information
4062 $v_local_header = array();
4063 $this->privConvertHeader2FileInfo($p_entry, $v_local_header);
4065 // ----- Call the callback
4066 // Here I do not use call_user_func() because I need to send a reference to the
4068 // eval('$v_result = '.$p_options[PCLZIP_CB_PRE_EXTRACT].'(PCLZIP_CB_PRE_EXTRACT, $v_local_header);');
4069 $v_result = $p_options[PCLZIP_CB_PRE_EXTRACT](PCLZIP_CB_PRE_EXTRACT, $v_local_header);
4070 if ($v_result == 0) {
4071 // ----- Change the file status
4072 $p_entry['status'] = "skipped";
4076 // ----- Look for abort result
4077 if ($v_result == 2) {
4078 // ----- This status is internal and will be changed in 'skipped'
4079 $p_entry['status'] = "aborted";
4080 $v_result = PCLZIP_ERR_USER_ABORTED;
4083 // ----- Update the informations
4084 // Only some fields can be modified
4085 $p_entry['filename'] = $v_local_header['filename'];
4090 // ----- Look if extraction should be done
4091 if ($p_entry['status'] == 'ok') {
4093 // ----- Do the extraction (if not a folder)
4094 if (!(($p_entry['external']&0x00000010)==0x00000010)) {
4095 // ----- Look for not compressed file
4096 if ($p_entry['compressed_size'] == $p_entry['size']) {
4098 // ----- Read the file in a buffer (one shot)
4099 $v_buffer = @fread($this->zip_fd, $p_entry['compressed_size']);
4101 // ----- Send the file to the output
4107 // ----- Read the compressed file in a buffer (one shot)
4108 $v_buffer = @fread($this->zip_fd, $p_entry['compressed_size']);
4110 // ----- Decompress the file
4111 $v_file_content = gzinflate($v_buffer);
4114 // ----- Send the file to the output
4115 echo $v_file_content;
4116 unset($v_file_content);
4121 // ----- Change abort status
4122 if ($p_entry['status'] == "aborted") {
4123 $p_entry['status'] = "skipped";
4126 // ----- Look for post-extract callback
4127 elseif (isset($p_options[PCLZIP_CB_POST_EXTRACT])) {
4129 // ----- Generate a local information
4130 $v_local_header = array();
4131 $this->privConvertHeader2FileInfo($p_entry, $v_local_header);
4133 // ----- Call the callback
4134 // Here I do not use call_user_func() because I need to send a reference to the
4136 $v_result = $p_options[PCLZIP_CB_POST_EXTRACT](PCLZIP_CB_POST_EXTRACT, $v_local_header);
4138 // ----- Look for abort result
4139 if ($v_result == 2) {
4140 $v_result = PCLZIP_ERR_USER_ABORTED;
4146 // --------------------------------------------------------------------------------
4148 // --------------------------------------------------------------------------------
4149 // Function : privExtractFileAsString()
4153 // --------------------------------------------------------------------------------
4154 function privExtractFileAsString(&$p_entry, &$p_string, &$p_options)
4158 // ----- Read the file header
4159 $v_header = array();
4160 if (($v_result = $this->privReadFileHeader($v_header)) != 1)
4167 // ----- Check that the file header is coherent with $p_entry info
4168 if ($this->privCheckFileHeaders($v_header, $p_entry) != 1) {
4172 // ----- Look for pre-extract callback
4173 if (isset($p_options[PCLZIP_CB_PRE_EXTRACT])) {
4175 // ----- Generate a local information
4176 $v_local_header = array();
4177 $this->privConvertHeader2FileInfo($p_entry, $v_local_header);
4179 // ----- Call the callback
4180 // Here I do not use call_user_func() because I need to send a reference to the
4182 $v_result = $p_options[PCLZIP_CB_PRE_EXTRACT](PCLZIP_CB_PRE_EXTRACT, $v_local_header);
4183 if ($v_result == 0) {
4184 // ----- Change the file status
4185 $p_entry['status'] = "skipped";
4189 // ----- Look for abort result
4190 if ($v_result == 2) {
4191 // ----- This status is internal and will be changed in 'skipped'
4192 $p_entry['status'] = "aborted";
4193 $v_result = PCLZIP_ERR_USER_ABORTED;
4196 // ----- Update the informations
4197 // Only some fields can be modified
4198 $p_entry['filename'] = $v_local_header['filename'];
4202 // ----- Look if extraction should be done
4203 if ($p_entry['status'] == 'ok') {
4205 // ----- Do the extraction (if not a folder)
4206 if (!(($p_entry['external']&0x00000010)==0x00000010)) {
4207 // ----- Look for not compressed file
4208 // if ($p_entry['compressed_size'] == $p_entry['size'])
4209 if ($p_entry['compression'] == 0) {
4211 // ----- Reading the file
4212 $p_string = @fread($this->zip_fd, $p_entry['compressed_size']);
4216 // ----- Reading the file
4217 $v_data = @fread($this->zip_fd, $p_entry['compressed_size']);
4219 // ----- Decompress the file
4220 if (($p_string = @gzinflate($v_data)) === FALSE) {
4228 // TBC : error : can not extract a folder in a string
4233 // ----- Change abort status
4234 if ($p_entry['status'] == "aborted") {
4235 $p_entry['status'] = "skipped";
4238 // ----- Look for post-extract callback
4239 elseif (isset($p_options[PCLZIP_CB_POST_EXTRACT])) {
4241 // ----- Generate a local information
4242 $v_local_header = array();
4243 $this->privConvertHeader2FileInfo($p_entry, $v_local_header);
4245 // ----- Swap the content to header
4246 $v_local_header['content'] = $p_string;
4249 // ----- Call the callback
4250 // Here I do not use call_user_func() because I need to send a reference to the
4252 $v_result = $p_options[PCLZIP_CB_POST_EXTRACT](PCLZIP_CB_POST_EXTRACT, $v_local_header);
4254 // ----- Swap back the content to header
4255 $p_string = $v_local_header['content'];
4256 unset($v_local_header['content']);
4258 // ----- Look for abort result
4259 if ($v_result == 2) {
4260 $v_result = PCLZIP_ERR_USER_ABORTED;
4267 // --------------------------------------------------------------------------------
4269 // --------------------------------------------------------------------------------
4270 // Function : privReadFileHeader()
4274 // --------------------------------------------------------------------------------
4275 function privReadFileHeader(&$p_header)
4279 // ----- Read the 4 bytes signature
4280 $v_binary_data = @fread($this->zip_fd, 4);
4281 $v_data = unpack('Vid', $v_binary_data);
4283 // ----- Check signature
4284 if ($v_data['id'] != 0x04034b50)
4288 PclZip::privErrorLog(PCLZIP_ERR_BAD_FORMAT, 'Invalid archive structure');
4291 return PclZip::errorCode();
4294 // ----- Read the first 42 bytes of the header
4295 $v_binary_data = fread($this->zip_fd, 26);
4297 // ----- Look for invalid block size
4298 if (strlen($v_binary_data) != 26)
4300 $p_header['filename'] = "";
4301 $p_header['status'] = "invalid_header";
4304 PclZip::privErrorLog(PCLZIP_ERR_BAD_FORMAT, "Invalid block size : ".strlen($v_binary_data));
4307 return PclZip::errorCode();
4310 // ----- Extract the values
4311 $v_data = unpack('vversion/vflag/vcompression/vmtime/vmdate/Vcrc/Vcompressed_size/Vsize/vfilename_len/vextra_len', $v_binary_data);
4313 // ----- Get filename
4314 $p_header['filename'] = fread($this->zip_fd, $v_data['filename_len']);
4316 // ----- Get extra_fields
4317 if ($v_data['extra_len'] != 0) {
4318 $p_header['extra'] = fread($this->zip_fd, $v_data['extra_len']);
4321 $p_header['extra'] = '';
4324 // ----- Extract properties
4325 $p_header['version_extracted'] = $v_data['version'];
4326 $p_header['compression'] = $v_data['compression'];
4327 $p_header['size'] = $v_data['size'];
4328 $p_header['compressed_size'] = $v_data['compressed_size'];
4329 $p_header['crc'] = $v_data['crc'];
4330 $p_header['flag'] = $v_data['flag'];
4331 $p_header['filename_len'] = $v_data['filename_len'];
4333 // ----- Recuperate date in UNIX format
4334 $p_header['mdate'] = $v_data['mdate'];
4335 $p_header['mtime'] = $v_data['mtime'];
4336 if ($p_header['mdate'] && $p_header['mtime'])
4338 // ----- Extract time
4339 $v_hour = ($p_header['mtime'] & 0xF800) >> 11;
4340 $v_minute = ($p_header['mtime'] & 0x07E0) >> 5;
4341 $v_seconde = ($p_header['mtime'] & 0x001F)*2;
4343 // ----- Extract date
4344 $v_year = (($p_header['mdate'] & 0xFE00) >> 9) + 1980;
4345 $v_month = ($p_header['mdate'] & 0x01E0) >> 5;
4346 $v_day = $p_header['mdate'] & 0x001F;
4348 // ----- Get UNIX date format
4349 $p_header['mtime'] = @mktime($v_hour, $v_minute, $v_seconde, $v_month, $v_day, $v_year);
4354 $p_header['mtime'] = time();
4358 //for(reset($v_data); $key = key($v_data); next($v_data)) {
4361 // ----- Set the stored filename
4362 $p_header['stored_filename'] = $p_header['filename'];
4364 // ----- Set the status field
4365 $p_header['status'] = "ok";
4370 // --------------------------------------------------------------------------------
4372 // --------------------------------------------------------------------------------
4373 // Function : privReadCentralFileHeader()
4377 // --------------------------------------------------------------------------------
4378 function privReadCentralFileHeader(&$p_header)
4382 // ----- Read the 4 bytes signature
4383 $v_binary_data = @fread($this->zip_fd, 4);
4384 $v_data = unpack('Vid', $v_binary_data);
4386 // ----- Check signature
4387 if ($v_data['id'] != 0x02014b50)
4391 PclZip::privErrorLog(PCLZIP_ERR_BAD_FORMAT, 'Invalid archive structure');
4394 return PclZip::errorCode();
4397 // ----- Read the first 42 bytes of the header
4398 $v_binary_data = fread($this->zip_fd, 42);
4400 // ----- Look for invalid block size
4401 if (strlen($v_binary_data) != 42)
4403 $p_header['filename'] = "";
4404 $p_header['status'] = "invalid_header";
4407 PclZip::privErrorLog(PCLZIP_ERR_BAD_FORMAT, "Invalid block size : ".strlen($v_binary_data));
4410 return PclZip::errorCode();
4413 // ----- Extract the values
4414 $p_header = unpack('vversion/vversion_extracted/vflag/vcompression/vmtime/vmdate/Vcrc/Vcompressed_size/Vsize/vfilename_len/vextra_len/vcomment_len/vdisk/vinternal/Vexternal/Voffset', $v_binary_data);
4416 // ----- Get filename
4417 if ($p_header['filename_len'] != 0)
4418 $p_header['filename'] = fread($this->zip_fd, $p_header['filename_len']);
4420 $p_header['filename'] = '';
4423 if ($p_header['extra_len'] != 0)
4424 $p_header['extra'] = fread($this->zip_fd, $p_header['extra_len']);
4426 $p_header['extra'] = '';
4428 // ----- Get comment
4429 if ($p_header['comment_len'] != 0)
4430 $p_header['comment'] = fread($this->zip_fd, $p_header['comment_len']);
4432 $p_header['comment'] = '';
4434 // ----- Extract properties
4436 // ----- Recuperate date in UNIX format
4437 //if ($p_header['mdate'] && $p_header['mtime'])
4438 // TBC : bug : this was ignoring time with 0/0/0
4441 // ----- Extract time
4442 $v_hour = ($p_header['mtime'] & 0xF800) >> 11;
4443 $v_minute = ($p_header['mtime'] & 0x07E0) >> 5;
4444 $v_seconde = ($p_header['mtime'] & 0x001F)*2;
4446 // ----- Extract date
4447 $v_year = (($p_header['mdate'] & 0xFE00) >> 9) + 1980;
4448 $v_month = ($p_header['mdate'] & 0x01E0) >> 5;
4449 $v_day = $p_header['mdate'] & 0x001F;
4451 // ----- Get UNIX date format
4452 $p_header['mtime'] = @mktime($v_hour, $v_minute, $v_seconde, $v_month, $v_day, $v_year);
4457 $p_header['mtime'] = time();
4460 // ----- Set the stored filename
4461 $p_header['stored_filename'] = $p_header['filename'];
4463 // ----- Set default status to ok
4464 $p_header['status'] = 'ok';
4466 // ----- Look if it is a directory
4467 if (substr($p_header['filename'], -1) == '/') {
4468 //$p_header['external'] = 0x41FF0010;
4469 $p_header['external'] = 0x00000010;
4476 // --------------------------------------------------------------------------------
4478 // --------------------------------------------------------------------------------
4479 // Function : privCheckFileHeaders()
4485 // --------------------------------------------------------------------------------
4486 function privCheckFileHeaders(&$p_local_header, &$p_central_header)
4490 // ----- Check the static values
4492 if ($p_local_header['filename'] != $p_central_header['filename']) {
4494 if ($p_local_header['version_extracted'] != $p_central_header['version_extracted']) {
4496 if ($p_local_header['flag'] != $p_central_header['flag']) {
4498 if ($p_local_header['compression'] != $p_central_header['compression']) {
4500 if ($p_local_header['mtime'] != $p_central_header['mtime']) {
4502 if ($p_local_header['filename_len'] != $p_central_header['filename_len']) {
4505 // ----- Look for flag bit 3
4506 if (($p_local_header['flag'] & 8) == 8) {
4507 $p_local_header['size'] = $p_central_header['size'];
4508 $p_local_header['compressed_size'] = $p_central_header['compressed_size'];
4509 $p_local_header['crc'] = $p_central_header['crc'];
4515 // --------------------------------------------------------------------------------
4517 // --------------------------------------------------------------------------------
4518 // Function : privReadEndCentralDir()
4522 // --------------------------------------------------------------------------------
4523 function privReadEndCentralDir(&$p_central_dir)
4527 // ----- Go to the end of the zip file
4528 $v_size = filesize($this->zipname);
4529 @fseek($this->zip_fd, $v_size);
4530 if (@ftell($this->zip_fd) != $v_size)
4533 PclZip::privErrorLog(PCLZIP_ERR_BAD_FORMAT, 'Unable to go to the end of the archive \''.$this->zipname.'\'');
4536 return PclZip::errorCode();
4539 // ----- First try : look if this is an archive with no commentaries (most of the time)
4540 // in this case the end of central dir is at 22 bytes of the file end
4543 @fseek($this->zip_fd, $v_size-22);
4544 if (($v_pos = @ftell($this->zip_fd)) != ($v_size-22))
4547 PclZip::privErrorLog(PCLZIP_ERR_BAD_FORMAT, 'Unable to seek back to the middle of the archive \''.$this->zipname.'\'');
4550 return PclZip::errorCode();
4553 // ----- Read for bytes
4554 $v_binary_data = @fread($this->zip_fd, 4);
4555 $v_data = @unpack('Vid', $v_binary_data);
4557 // ----- Check signature
4558 if ($v_data['id'] == 0x06054b50) {
4562 $v_pos = ftell($this->zip_fd);
4565 // ----- Go back to the maximum possible size of the Central Dir End Record
4567 $v_maximum_size = 65557; // 0xFFFF + 22;
4568 if ($v_maximum_size > $v_size)
4569 $v_maximum_size = $v_size;
4570 @fseek($this->zip_fd, $v_size-$v_maximum_size);
4571 if (@ftell($this->zip_fd) != ($v_size-$v_maximum_size))
4574 PclZip::privErrorLog(PCLZIP_ERR_BAD_FORMAT, 'Unable to seek back to the middle of the archive \''.$this->zipname.'\'');
4577 return PclZip::errorCode();
4580 // ----- Read byte per byte in order to find the signature
4581 $v_pos = ftell($this->zip_fd);
4582 $v_bytes = 0x00000000;
4583 while ($v_pos < $v_size)
4585 // ----- Read a byte
4586 $v_byte = @fread($this->zip_fd, 1);
4588 // ----- Add the byte
4589 //$v_bytes = ($v_bytes << 8) | Ord($v_byte);
4590 // Note we mask the old value down such that once shifted we can never end up with more than a 32bit number
4591 // Otherwise on systems where we have 64bit integers the check below for the magic number will fail.
4592 $v_bytes = ( ($v_bytes & 0xFFFFFF) << 8) | Ord($v_byte);
4594 // ----- Compare the bytes
4595 if ($v_bytes == 0x504b0506)
4604 // ----- Look if not found end of central dir
4605 if ($v_pos == $v_size)
4609 PclZip::privErrorLog(PCLZIP_ERR_BAD_FORMAT, "Unable to find End of Central Dir Record signature");
4612 return PclZip::errorCode();
4616 // ----- Read the first 18 bytes of the header
4617 $v_binary_data = fread($this->zip_fd, 18);
4619 // ----- Look for invalid block size
4620 if (strlen($v_binary_data) != 18)
4624 PclZip::privErrorLog(PCLZIP_ERR_BAD_FORMAT, "Invalid End of Central Dir Record size : ".strlen($v_binary_data));
4627 return PclZip::errorCode();
4630 // ----- Extract the values
4631 $v_data = unpack('vdisk/vdisk_start/vdisk_entries/ventries/Vsize/Voffset/vcomment_size', $v_binary_data);
4633 // ----- Check the global size
4634 if (($v_pos + $v_data['comment_size'] + 18) != $v_size) {
4636 // ----- Removed in release 2.2 see readme file
4637 // The check of the file size is a little too strict.
4638 // Some bugs where found when a zip is encrypted/decrypted with 'crypt'.
4639 // While decrypted, zip has training 0 bytes
4642 PclZip::privErrorLog(PCLZIP_ERR_BAD_FORMAT,
4643 'The central dir is not at the end of the archive.'
4644 .' Some trailing bytes exists after the archive.');
4647 return PclZip::errorCode();
4651 // ----- Get comment
4652 if ($v_data['comment_size'] != 0) {
4653 $p_central_dir['comment'] = fread($this->zip_fd, $v_data['comment_size']);
4656 $p_central_dir['comment'] = '';
4658 $p_central_dir['entries'] = $v_data['entries'];
4659 $p_central_dir['disk_entries'] = $v_data['disk_entries'];
4660 $p_central_dir['offset'] = $v_data['offset'];
4661 $p_central_dir['size'] = $v_data['size'];
4662 $p_central_dir['disk'] = $v_data['disk'];
4663 $p_central_dir['disk_start'] = $v_data['disk_start'];
4666 //for(reset($p_central_dir); $key = key($p_central_dir); next($p_central_dir)) {
4672 // --------------------------------------------------------------------------------
4674 // --------------------------------------------------------------------------------
4675 // Function : privDeleteByRule()
4679 // --------------------------------------------------------------------------------
4680 function privDeleteByRule(&$p_result_list, &$p_options)
4683 $v_list_detail = array();
4685 // ----- Open the zip file
4686 if (($v_result=$this->privOpenFd('rb')) != 1)
4692 // ----- Read the central directory informations
4693 $v_central_dir = array();
4694 if (($v_result = $this->privReadEndCentralDir($v_central_dir)) != 1)
4696 $this->privCloseFd();
4700 // ----- Go to beginning of File
4701 @rewind($this->zip_fd);
4703 // ----- Scan all the files
4704 // ----- Start at beginning of Central Dir
4705 $v_pos_entry = $v_central_dir['offset'];
4706 @rewind($this->zip_fd);
4707 if (@fseek($this->zip_fd, $v_pos_entry))
4709 // ----- Close the zip file
4710 $this->privCloseFd();
4713 PclZip::privErrorLog(PCLZIP_ERR_INVALID_ARCHIVE_ZIP, 'Invalid archive size');
4716 return PclZip::errorCode();
4719 // ----- Read each entry
4720 $v_header_list = array();
4722 for ($i=0, $v_nb_extracted=0; $i<$v_central_dir['entries']; $i++)
4725 // ----- Read the file header
4726 $v_header_list[$v_nb_extracted] = array();
4727 if (($v_result = $this->privReadCentralFileHeader($v_header_list[$v_nb_extracted])) != 1)
4729 // ----- Close the zip file
4730 $this->privCloseFd();
4736 // ----- Store the index
4737 $v_header_list[$v_nb_extracted]['index'] = $i;
4739 // ----- Look for the specific extract rules
4742 // ----- Look for extract by name rule
4743 if ( (isset($p_options[PCLZIP_OPT_BY_NAME]))
4744 && ($p_options[PCLZIP_OPT_BY_NAME] != 0)) {
4746 // ----- Look if the filename is in the list
4747 for ($j=0; ($j<sizeof($p_options[PCLZIP_OPT_BY_NAME])) && (!$v_found); $j++) {
4749 // ----- Look for a directory
4750 if (substr($p_options[PCLZIP_OPT_BY_NAME][$j], -1) == "/") {
4752 // ----- Look if the directory is in the filename path
4753 if ( (strlen($v_header_list[$v_nb_extracted]['stored_filename']) > strlen($p_options[PCLZIP_OPT_BY_NAME][$j]))
4754 && (substr($v_header_list[$v_nb_extracted]['stored_filename'], 0, strlen($p_options[PCLZIP_OPT_BY_NAME][$j])) == $p_options[PCLZIP_OPT_BY_NAME][$j])) {
4757 elseif ( (($v_header_list[$v_nb_extracted]['external']&0x00000010)==0x00000010) /* Indicates a folder */
4758 && ($v_header_list[$v_nb_extracted]['stored_filename'].'/' == $p_options[PCLZIP_OPT_BY_NAME][$j])) {
4762 // ----- Look for a filename
4763 elseif ($v_header_list[$v_nb_extracted]['stored_filename'] == $p_options[PCLZIP_OPT_BY_NAME][$j]) {
4769 // ----- Look for extract by ereg rule
4770 // ereg() is deprecated with PHP 5.3
4772 else if ( (isset($p_options[PCLZIP_OPT_BY_EREG]))
4773 && ($p_options[PCLZIP_OPT_BY_EREG] != "")) {
4775 if (ereg($p_options[PCLZIP_OPT_BY_EREG], $v_header_list[$v_nb_extracted]['stored_filename'])) {
4781 // ----- Look for extract by preg rule
4782 else if ( (isset($p_options[PCLZIP_OPT_BY_PREG]))
4783 && ($p_options[PCLZIP_OPT_BY_PREG] != "")) {
4785 if (preg_match($p_options[PCLZIP_OPT_BY_PREG], $v_header_list[$v_nb_extracted]['stored_filename'])) {
4790 // ----- Look for extract by index rule
4791 else if ( (isset($p_options[PCLZIP_OPT_BY_INDEX]))
4792 && ($p_options[PCLZIP_OPT_BY_INDEX] != 0)) {
4794 // ----- Look if the index is in the list
4795 for ($j=$j_start; ($j<sizeof($p_options[PCLZIP_OPT_BY_INDEX])) && (!$v_found); $j++) {
4797 if (($i>=$p_options[PCLZIP_OPT_BY_INDEX][$j]['start']) && ($i<=$p_options[PCLZIP_OPT_BY_INDEX][$j]['end'])) {
4800 if ($i>=$p_options[PCLZIP_OPT_BY_INDEX][$j]['end']) {
4804 if ($p_options[PCLZIP_OPT_BY_INDEX][$j]['start']>$i) {
4813 // ----- Look for deletion
4816 unset($v_header_list[$v_nb_extracted]);
4824 // ----- Look if something need to be deleted
4825 if ($v_nb_extracted > 0) {
4827 // ----- Creates a temporay file
4828 $v_zip_temp_name = PCLZIP_TEMPORARY_DIR.uniqid('pclzip-').'.tmp';
4830 // ----- Creates a temporary zip archive
4831 $v_temp_zip = new PclZip($v_zip_temp_name);
4833 // ----- Open the temporary zip file in write mode
4834 if (($v_result = $v_temp_zip->privOpenFd('wb')) != 1) {
4835 $this->privCloseFd();
4841 // ----- Look which file need to be kept
4842 for ($i=0; $i<sizeof($v_header_list); $i++) {
4844 // ----- Calculate the position of the header
4845 @rewind($this->zip_fd);
4846 if (@fseek($this->zip_fd, $v_header_list[$i]['offset'])) {
4847 // ----- Close the zip file
4848 $this->privCloseFd();
4849 $v_temp_zip->privCloseFd();
4850 @unlink($v_zip_temp_name);
4853 PclZip::privErrorLog(PCLZIP_ERR_INVALID_ARCHIVE_ZIP, 'Invalid archive size');
4856 return PclZip::errorCode();
4859 // ----- Read the file header
4860 $v_local_header = array();
4861 if (($v_result = $this->privReadFileHeader($v_local_header)) != 1) {
4862 // ----- Close the zip file
4863 $this->privCloseFd();
4864 $v_temp_zip->privCloseFd();
4865 @unlink($v_zip_temp_name);
4871 // ----- Check that local file header is same as central file header
4872 if ($this->privCheckFileHeaders($v_local_header,
4873 $v_header_list[$i]) != 1) {
4876 unset($v_local_header);
4878 // ----- Write the file header
4879 if (($v_result = $v_temp_zip->privWriteFileHeader($v_header_list[$i])) != 1) {
4880 // ----- Close the zip file
4881 $this->privCloseFd();
4882 $v_temp_zip->privCloseFd();
4883 @unlink($v_zip_temp_name);
4889 // ----- Read/write the data block
4890 if (($v_result = PclZipUtilCopyBlock($this->zip_fd, $v_temp_zip->zip_fd, $v_header_list[$i]['compressed_size'])) != 1) {
4891 // ----- Close the zip file
4892 $this->privCloseFd();
4893 $v_temp_zip->privCloseFd();
4894 @unlink($v_zip_temp_name);
4901 // ----- Store the offset of the central dir
4902 $v_offset = @ftell($v_temp_zip->zip_fd);
4904 // ----- Re-Create the Central Dir files header
4905 for ($i=0; $i<sizeof($v_header_list); $i++) {
4906 // ----- Create the file header
4907 if (($v_result = $v_temp_zip->privWriteCentralFileHeader($v_header_list[$i])) != 1) {
4908 $v_temp_zip->privCloseFd();
4909 $this->privCloseFd();
4910 @unlink($v_zip_temp_name);
4916 // ----- Transform the header to a 'usable' info
4917 $v_temp_zip->privConvertHeader2FileInfo($v_header_list[$i], $p_result_list[$i]);
4921 // ----- Zip file comment
4923 if (isset($p_options[PCLZIP_OPT_COMMENT])) {
4924 $v_comment = $p_options[PCLZIP_OPT_COMMENT];
4927 // ----- Calculate the size of the central header
4928 $v_size = @ftell($v_temp_zip->zip_fd)-$v_offset;
4930 // ----- Create the central dir footer
4931 if (($v_result = $v_temp_zip->privWriteCentralHeader(sizeof($v_header_list), $v_size, $v_offset, $v_comment)) != 1) {
4932 // ----- Reset the file list
4933 unset($v_header_list);
4934 $v_temp_zip->privCloseFd();
4935 $this->privCloseFd();
4936 @unlink($v_zip_temp_name);
4943 $v_temp_zip->privCloseFd();
4944 $this->privCloseFd();
4946 // ----- Delete the zip file
4947 // TBC : I should test the result ...
4948 @unlink($this->zipname);
4950 // ----- Rename the temporary file
4951 // TBC : I should test the result ...
4952 //@rename($v_zip_temp_name, $this->zipname);
4953 PclZipUtilRename($v_zip_temp_name, $this->zipname);
4955 // ----- Destroy the temporary archive
4959 // ----- Remove every files : reset the file
4960 else if ($v_central_dir['entries'] != 0) {
4961 $this->privCloseFd();
4963 if (($v_result = $this->privOpenFd('wb')) != 1) {
4967 if (($v_result = $this->privWriteCentralHeader(0, 0, 0, '')) != 1) {
4971 $this->privCloseFd();
4977 // --------------------------------------------------------------------------------
4979 // --------------------------------------------------------------------------------
4980 // Function : privDirCheck()
4982 // Check if a directory exists, if not it creates it and all the parents directory
4983 // which may be useful.
4985 // $p_dir : Directory path to check.
4988 // -1 : Unable to create directory
4989 // --------------------------------------------------------------------------------
4990 function privDirCheck($p_dir, $p_is_dir=false)
4995 // ----- Remove the final '/'
4996 if (($p_is_dir) && (substr($p_dir, -1)=='/'))
4998 $p_dir = substr($p_dir, 0, strlen($p_dir)-1);
5001 // ----- Check the directory availability
5002 if ((is_dir($p_dir)) || ($p_dir == ""))
5007 // ----- Extract parent directory
5008 $p_parent_dir = dirname($p_dir);
5010 // ----- Just a check
5011 if ($p_parent_dir != $p_dir)
5013 // ----- Look for parent directory
5014 if ($p_parent_dir != "")
5016 if (($v_result = $this->privDirCheck($p_parent_dir)) != 1)
5023 // ----- Create the directory
5024 if (!@mkdir($p_dir, 0777))
5027 PclZip::privErrorLog(PCLZIP_ERR_DIR_CREATE_FAIL, "Unable to create directory '$p_dir'");
5030 return PclZip::errorCode();
5036 // --------------------------------------------------------------------------------
5038 // --------------------------------------------------------------------------------
5039 // Function : privMerge()
5041 // If $p_archive_to_add does not exist, the function exit with a success result.
5044 // --------------------------------------------------------------------------------
5045 function privMerge(&$p_archive_to_add)
5049 // ----- Look if the archive_to_add exists
5050 if (!is_file($p_archive_to_add->zipname))
5053 // ----- Nothing to merge, so merge is a success
5060 // ----- Look if the archive exists
5061 if (!is_file($this->zipname))
5064 // ----- Do a duplicate
5065 $v_result = $this->privDuplicate($p_archive_to_add->zipname);
5071 // ----- Open the zip file
5072 if (($v_result=$this->privOpenFd('rb')) != 1)
5078 // ----- Read the central directory informations
5079 $v_central_dir = array();
5080 if (($v_result = $this->privReadEndCentralDir($v_central_dir)) != 1)
5082 $this->privCloseFd();
5086 // ----- Go to beginning of File
5087 @rewind($this->zip_fd);
5089 // ----- Open the archive_to_add file
5090 if (($v_result=$p_archive_to_add->privOpenFd('rb')) != 1)
5092 $this->privCloseFd();
5098 // ----- Read the central directory informations
5099 $v_central_dir_to_add = array();
5100 if (($v_result = $p_archive_to_add->privReadEndCentralDir($v_central_dir_to_add)) != 1)
5102 $this->privCloseFd();
5103 $p_archive_to_add->privCloseFd();
5108 // ----- Go to beginning of File
5109 @rewind($p_archive_to_add->zip_fd);
5111 // ----- Creates a temporay file
5112 $v_zip_temp_name = PCLZIP_TEMPORARY_DIR.uniqid('pclzip-').'.tmp';
5114 // ----- Open the temporary file in write mode
5115 if (($v_zip_temp_fd = @fopen($v_zip_temp_name, 'wb')) == 0)
5117 $this->privCloseFd();
5118 $p_archive_to_add->privCloseFd();
5120 PclZip::privErrorLog(PCLZIP_ERR_READ_OPEN_FAIL, 'Unable to open temporary file \''.$v_zip_temp_name.'\' in binary write mode');
5123 return PclZip::errorCode();
5126 // ----- Copy the files from the archive to the temporary file
5127 // TBC : Here I should better append the file and go back to erase the central dir
5128 $v_size = $v_central_dir['offset'];
5129 while ($v_size != 0)
5131 $v_read_size = ($v_size < PCLZIP_READ_BLOCK_SIZE ? $v_size : PCLZIP_READ_BLOCK_SIZE);
5132 $v_buffer = fread($this->zip_fd, $v_read_size);
5133 @fwrite($v_zip_temp_fd, $v_buffer, $v_read_size);
5134 $v_size -= $v_read_size;
5137 // ----- Copy the files from the archive_to_add into the temporary file
5138 $v_size = $v_central_dir_to_add['offset'];
5139 while ($v_size != 0)
5141 $v_read_size = ($v_size < PCLZIP_READ_BLOCK_SIZE ? $v_size : PCLZIP_READ_BLOCK_SIZE);
5142 $v_buffer = fread($p_archive_to_add->zip_fd, $v_read_size);
5143 @fwrite($v_zip_temp_fd, $v_buffer, $v_read_size);
5144 $v_size -= $v_read_size;
5147 // ----- Store the offset of the central dir
5148 $v_offset = @ftell($v_zip_temp_fd);
5150 // ----- Copy the block of file headers from the old archive
5151 $v_size = $v_central_dir['size'];
5152 while ($v_size != 0)
5154 $v_read_size = ($v_size < PCLZIP_READ_BLOCK_SIZE ? $v_size : PCLZIP_READ_BLOCK_SIZE);
5155 $v_buffer = @fread($this->zip_fd, $v_read_size);
5156 @fwrite($v_zip_temp_fd, $v_buffer, $v_read_size);
5157 $v_size -= $v_read_size;
5160 // ----- Copy the block of file headers from the archive_to_add
5161 $v_size = $v_central_dir_to_add['size'];
5162 while ($v_size != 0)
5164 $v_read_size = ($v_size < PCLZIP_READ_BLOCK_SIZE ? $v_size : PCLZIP_READ_BLOCK_SIZE);
5165 $v_buffer = @fread($p_archive_to_add->zip_fd, $v_read_size);
5166 @fwrite($v_zip_temp_fd, $v_buffer, $v_read_size);
5167 $v_size -= $v_read_size;
5170 // ----- Merge the file comments
5171 $v_comment = $v_central_dir['comment'].' '.$v_central_dir_to_add['comment'];
5173 // ----- Calculate the size of the (new) central header
5174 $v_size = @ftell($v_zip_temp_fd)-$v_offset;
5176 // ----- Swap the file descriptor
5177 // Here is a trick : I swap the temporary fd with the zip fd, in order to use
5178 // the following methods on the temporary fil and not the real archive fd
5179 $v_swap = $this->zip_fd;
5180 $this->zip_fd = $v_zip_temp_fd;
5181 $v_zip_temp_fd = $v_swap;
5183 // ----- Create the central dir footer
5184 if (($v_result = $this->privWriteCentralHeader($v_central_dir['entries']+$v_central_dir_to_add['entries'], $v_size, $v_offset, $v_comment)) != 1)
5186 $this->privCloseFd();
5187 $p_archive_to_add->privCloseFd();
5188 @fclose($v_zip_temp_fd);
5189 $this->zip_fd = null;
5191 // ----- Reset the file list
5192 unset($v_header_list);
5198 // ----- Swap back the file descriptor
5199 $v_swap = $this->zip_fd;
5200 $this->zip_fd = $v_zip_temp_fd;
5201 $v_zip_temp_fd = $v_swap;
5204 $this->privCloseFd();
5205 $p_archive_to_add->privCloseFd();
5207 // ----- Close the temporary file
5208 @fclose($v_zip_temp_fd);
5210 // ----- Delete the zip file
5211 // TBC : I should test the result ...
5212 @unlink($this->zipname);
5214 // ----- Rename the temporary file
5215 // TBC : I should test the result ...
5216 //@rename($v_zip_temp_name, $this->zipname);
5217 PclZipUtilRename($v_zip_temp_name, $this->zipname);
5222 // --------------------------------------------------------------------------------
5224 // --------------------------------------------------------------------------------
5225 // Function : privDuplicate()
5229 // --------------------------------------------------------------------------------
5230 function privDuplicate($p_archive_filename)
5234 // ----- Look if the $p_archive_filename exists
5235 if (!is_file($p_archive_filename))
5238 // ----- Nothing to duplicate, so duplicate is a success.
5245 // ----- Open the zip file
5246 if (($v_result=$this->privOpenFd('wb')) != 1)
5252 // ----- Open the temporary file in write mode
5253 if (($v_zip_temp_fd = @fopen($p_archive_filename, 'rb')) == 0)
5255 $this->privCloseFd();
5257 PclZip::privErrorLog(PCLZIP_ERR_READ_OPEN_FAIL, 'Unable to open archive file \''.$p_archive_filename.'\' in binary write mode');
5260 return PclZip::errorCode();
5263 // ----- Copy the files from the archive to the temporary file
5264 // TBC : Here I should better append the file and go back to erase the central dir
5265 $v_size = filesize($p_archive_filename);
5266 while ($v_size != 0)
5268 $v_read_size = ($v_size < PCLZIP_READ_BLOCK_SIZE ? $v_size : PCLZIP_READ_BLOCK_SIZE);
5269 $v_buffer = fread($v_zip_temp_fd, $v_read_size);
5270 @fwrite($this->zip_fd, $v_buffer, $v_read_size);
5271 $v_size -= $v_read_size;
5275 $this->privCloseFd();
5277 // ----- Close the temporary file
5278 @fclose($v_zip_temp_fd);
5283 // --------------------------------------------------------------------------------
5285 // --------------------------------------------------------------------------------
5286 // Function : privErrorLog()
5289 // --------------------------------------------------------------------------------
5290 function privErrorLog($p_error_code=0, $p_error_string='')
5292 if (PCLZIP_ERROR_EXTERNAL == 1) {
5293 PclError($p_error_code, $p_error_string);
5296 $this->error_code = $p_error_code;
5297 $this->error_string = $p_error_string;
5300 // --------------------------------------------------------------------------------
5302 // --------------------------------------------------------------------------------
5303 // Function : privErrorReset()
5306 // --------------------------------------------------------------------------------
5307 function privErrorReset()
5309 if (PCLZIP_ERROR_EXTERNAL == 1) {
5313 $this->error_code = 0;
5314 $this->error_string = '';
5317 // --------------------------------------------------------------------------------
5319 // --------------------------------------------------------------------------------
5320 // Function : privDisableMagicQuotes()
5324 // --------------------------------------------------------------------------------
5325 function privDisableMagicQuotes()
5329 // ----- Look if function exists
5330 if ( (!function_exists("get_magic_quotes_runtime"))
5331 || (!function_exists("set_magic_quotes_runtime"))) {
5335 // ----- Look if already done
5336 if ($this->magic_quotes_status != -1) {
5340 // ----- Get and memorize the magic_quote value
5341 $this->magic_quotes_status = @get_magic_quotes_runtime();
5343 // ----- Disable magic_quotes
5344 if ($this->magic_quotes_status == 1) {
5345 @set_magic_quotes_runtime(0);
5351 // --------------------------------------------------------------------------------
5353 // --------------------------------------------------------------------------------
5354 // Function : privSwapBackMagicQuotes()
5358 // --------------------------------------------------------------------------------
5359 function privSwapBackMagicQuotes()
5363 // ----- Look if function exists
5364 if ( (!function_exists("get_magic_quotes_runtime"))
5365 || (!function_exists("set_magic_quotes_runtime"))) {
5369 // ----- Look if something to do
5370 if ($this->magic_quotes_status != -1) {
5374 // ----- Swap back magic_quotes
5375 if ($this->magic_quotes_status == 1) {
5376 @set_magic_quotes_runtime($this->magic_quotes_status);
5382 // --------------------------------------------------------------------------------
5386 // --------------------------------------------------------------------------------
5388 // --------------------------------------------------------------------------------
5389 // Function : PclZipUtilPathReduction()
5393 // --------------------------------------------------------------------------------
5394 function PclZipUtilPathReduction($p_dir)
5398 // ----- Look for not empty path
5400 // ----- Explode path by directory names
5401 $v_list = explode("/", $p_dir);
5403 // ----- Study directories from last to first
5405 for ($i=sizeof($v_list)-1; $i>=0; $i--) {
5406 // ----- Look for current path
5407 if ($v_list[$i] == ".") {
5408 // ----- Ignore this directory
5409 // Should be the first $i=0, but no check is done
5411 else if ($v_list[$i] == "..") {
5414 else if ($v_list[$i] == "") {
5415 // ----- First '/' i.e. root slash
5417 $v_result = "/".$v_result;
5419 // ----- It is an invalid path, so the path is not modified
5425 // ----- Last '/' i.e. indicates a directory
5426 else if ($i == (sizeof($v_list)-1)) {
5427 $v_result = $v_list[$i];
5429 // ----- Double '/' inside the path
5431 // ----- Ignore only the double '//' in path,
5432 // but not the first and last '/'
5436 // ----- Look for item to skip
5441 $v_result = $v_list[$i].($i!=(sizeof($v_list)-1)?"/".$v_result:"");
5446 // ----- Look for skip
5448 while ($v_skip > 0) {
5449 $v_result = '../'.$v_result;
5458 // --------------------------------------------------------------------------------
5460 // --------------------------------------------------------------------------------
5461 // Function : PclZipUtilPathInclusion()
5463 // This function indicates if the path $p_path is under the $p_dir tree. Or,
5464 // said in an other way, if the file or sub-dir $p_path is inside the dir
5466 // The function indicates also if the path is exactly the same as the dir.
5467 // This function supports path with duplicated '/' like '//', but does not
5468 // support '.' or '..' statements.
5471 // 0 if $p_path is not inside directory $p_dir
5472 // 1 if $p_path is inside directory $p_dir
5473 // 2 if $p_path is exactly the same as $p_dir
5474 // --------------------------------------------------------------------------------
5475 function PclZipUtilPathInclusion($p_dir, $p_path)
5479 // ----- Look for path beginning by ./
5480 if ( ($p_dir == '.')
5481 || ((strlen($p_dir) >=2) && (substr($p_dir, 0, 2) == './'))) {
5482 $p_dir = PclZipUtilTranslateWinPath(getcwd(), FALSE).'/'.substr($p_dir, 1);
5484 if ( ($p_path == '.')
5485 || ((strlen($p_path) >=2) && (substr($p_path, 0, 2) == './'))) {
5486 $p_path = PclZipUtilTranslateWinPath(getcwd(), FALSE).'/'.substr($p_path, 1);
5489 // ----- Explode dir and path by directory separator
5490 $v_list_dir = explode("/", $p_dir);
5491 $v_list_dir_size = sizeof($v_list_dir);
5492 $v_list_path = explode("/", $p_path);
5493 $v_list_path_size = sizeof($v_list_path);
5495 // ----- Study directories paths
5498 while (($i < $v_list_dir_size) && ($j < $v_list_path_size) && ($v_result)) {
5500 // ----- Look for empty dir (path reduction)
5501 if ($v_list_dir[$i] == '') {
5505 if ($v_list_path[$j] == '') {
5510 // ----- Compare the items
5511 if (($v_list_dir[$i] != $v_list_path[$j]) && ($v_list_dir[$i] != '') && ( $v_list_path[$j] != '')) {
5520 // ----- Look if everything seems to be the same
5522 // ----- Skip all the empty items
5523 while (($j < $v_list_path_size) && ($v_list_path[$j] == '')) $j++;
5524 while (($i < $v_list_dir_size) && ($v_list_dir[$i] == '')) $i++;
5526 if (($i >= $v_list_dir_size) && ($j >= $v_list_path_size)) {
5527 // ----- There are exactly the same
5530 else if ($i < $v_list_dir_size) {
5531 // ----- The path is shorter than the dir
5539 // --------------------------------------------------------------------------------
5541 // --------------------------------------------------------------------------------
5542 // Function : PclZipUtilCopyBlock()
5545 // $p_mode : read/write compression mode
5546 // 0 : src & dest normal
5547 // 1 : src gzip, dest normal
5548 // 2 : src normal, dest gzip
5549 // 3 : src & dest gzip
5551 // --------------------------------------------------------------------------------
5552 function PclZipUtilCopyBlock($p_src, $p_dest, $p_size, $p_mode=0)
5558 while ($p_size != 0)
5560 $v_read_size = ($p_size < PCLZIP_READ_BLOCK_SIZE ? $p_size : PCLZIP_READ_BLOCK_SIZE);
5561 $v_buffer = @fread($p_src, $v_read_size);
5562 @fwrite($p_dest, $v_buffer, $v_read_size);
5563 $p_size -= $v_read_size;
5566 else if ($p_mode==1)
5568 while ($p_size != 0)
5570 $v_read_size = ($p_size < PCLZIP_READ_BLOCK_SIZE ? $p_size : PCLZIP_READ_BLOCK_SIZE);
5571 $v_buffer = @gzread($p_src, $v_read_size);
5572 @fwrite($p_dest, $v_buffer, $v_read_size);
5573 $p_size -= $v_read_size;
5576 else if ($p_mode==2)
5578 while ($p_size != 0)
5580 $v_read_size = ($p_size < PCLZIP_READ_BLOCK_SIZE ? $p_size : PCLZIP_READ_BLOCK_SIZE);
5581 $v_buffer = @fread($p_src, $v_read_size);
5582 @gzwrite($p_dest, $v_buffer, $v_read_size);
5583 $p_size -= $v_read_size;
5586 else if ($p_mode==3)
5588 while ($p_size != 0)
5590 $v_read_size = ($p_size < PCLZIP_READ_BLOCK_SIZE ? $p_size : PCLZIP_READ_BLOCK_SIZE);
5591 $v_buffer = @gzread($p_src, $v_read_size);
5592 @gzwrite($p_dest, $v_buffer, $v_read_size);
5593 $p_size -= $v_read_size;
5600 // --------------------------------------------------------------------------------
5602 // --------------------------------------------------------------------------------
5603 // Function : PclZipUtilRename()
5605 // This function tries to do a simple rename() function. If it fails, it
5606 // tries to copy the $p_src file in a new $p_dest file and then unlink the
5609 // $p_src : Old filename
5610 // $p_dest : New filename
5612 // 1 on success, 0 on failure.
5613 // --------------------------------------------------------------------------------
5614 function PclZipUtilRename($p_src, $p_dest)
5618 // ----- Try to rename the files
5619 if (!@rename($p_src, $p_dest)) {
5621 // ----- Try to copy & unlink the src
5622 if (!@copy($p_src, $p_dest)) {
5625 else if (!@unlink($p_src)) {
5633 // --------------------------------------------------------------------------------
5635 // --------------------------------------------------------------------------------
5636 // Function : PclZipUtilOptionText()
5638 // Translate option value in text. Mainly for debug purpose.
5640 // $p_option : the option value.
5642 // The option text value.
5643 // --------------------------------------------------------------------------------
5644 function PclZipUtilOptionText($p_option)
5647 $v_list = get_defined_constants();
5648 for (reset($v_list); $v_key = key($v_list); next($v_list)) {
5649 $v_prefix = substr($v_key, 0, 10);
5650 if (( ($v_prefix == 'PCLZIP_OPT')
5651 || ($v_prefix == 'PCLZIP_CB_')
5652 || ($v_prefix == 'PCLZIP_ATT'))
5653 && ($v_list[$v_key] == $p_option)) {
5658 $v_result = 'Unknown';
5662 // --------------------------------------------------------------------------------
5664 // --------------------------------------------------------------------------------
5665 // Function : PclZipUtilTranslateWinPath()
5667 // Translate windows path by replacing '\' by '/' and optionally removing
5670 // $p_path : path to translate.
5671 // $p_remove_disk_letter : true | false
5673 // The path translated.
5674 // --------------------------------------------------------------------------------
5675 function PclZipUtilTranslateWinPath($p_path, $p_remove_disk_letter=true)
5677 if (stristr(php_uname(), 'windows')) {
5678 // ----- Look for potential disk letter
5679 if (($p_remove_disk_letter) && (($v_position = strpos($p_path, ':')) != false)) {
5680 $p_path = substr($p_path, $v_position+1);
5682 // ----- Change potential windows directory separator
5683 if ((strpos($p_path, '\\') > 0) || (substr($p_path, 0,1) == '\\')) {
5684 $p_path = strtr($p_path, '\\', '/');
5689 // --------------------------------------------------------------------------------