Wordpress 2.8
[autoinstalls/wordpress.git] / wp-admin / includes / class-pclzip.php
1 <?php
2 // --------------------------------------------------------------------------------
3 // PhpConcept Library - Zip Module 2.8
4 // --------------------------------------------------------------------------------
5 // License GNU/LGPL - Vincent Blavet - March 2006
6 // http://www.phpconcept.net
7 // --------------------------------------------------------------------------------
8 //
9 // Presentation :
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.
13 //
14 // Description :
15 //   See readme.txt and http://www.phpconcept.net
16 //
17 // Warning :
18 //   This library and the associated files are non commercial, non professional
19 //   work.
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.
23 //
24 // --------------------------------------------------------------------------------
25 // $Id: pclzip.lib.php,v 1.55 2009/04/22 07:38:36 vblavet Exp $
26 // --------------------------------------------------------------------------------
27
28   // ----- Constants
29   if (!defined('PCLZIP_READ_BLOCK_SIZE')) {
30     define( 'PCLZIP_READ_BLOCK_SIZE', 2048 );
31   }
32   
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', ',' );
45   }
46
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 );
54   }
55
56   // ----- Optional static temporary directory
57   //       By default temporary files are generated in the script current
58   //       path.
59   //       If defined :
60   //       - MUST BE terminated by a '/'.
61   //       - MUST be a valid, already created directory
62   //       Samples :
63   // define( 'PCLZIP_TEMPORARY_DIR', '/temp/' );
64   // define( 'PCLZIP_TEMPORARY_DIR', 'C:/Temp/' );
65   if (!defined('PCLZIP_TEMPORARY_DIR')) {
66     define( 'PCLZIP_TEMPORARY_DIR', '' );
67   }
68
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.
75   //       Samples :
76   // define( 'PCLZIP_TEMPORARY_FILE_RATIO', 0.5 );
77   if (!defined('PCLZIP_TEMPORARY_FILE_RATIO')) {
78     define( 'PCLZIP_TEMPORARY_FILE_RATIO', 0.47 );
79   }
80
81 // --------------------------------------------------------------------------------
82 // ***** UNDER THIS LINE NOTHING NEEDS TO BE MODIFIED *****
83 // --------------------------------------------------------------------------------
84
85   // ----- Global variables
86   $g_pclzip_version = "2.8";
87
88   // ----- Error codes
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 );
126
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
155   
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 );
163
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 );
169   /* For futur use
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 );
174   */
175
176   // --------------------------------------------------------------------------------
177   // Class : PclZip
178   // Description :
179   //   PclZip is the class that represent a Zip archive.
180   //   The public methods allow the manipulation of the archive.
181   // Attributes :
182   //   Attributes must not be accessed directly.
183   // Methods :
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   // --------------------------------------------------------------------------------
190   class PclZip
191   {
192     // ----- Filename of the zip file
193     var $zipname = '';
194
195     // ----- File descriptor of the zip file
196     var $zip_fd = 0;
197
198     // ----- Internal error handling
199     var $error_code = 1;
200     var $error_string = '';
201     
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;
206
207   // --------------------------------------------------------------------------------
208   // Function : PclZip()
209   // Description :
210   //   Creates a PclZip object and set the name of the associated Zip archive
211   //   filename.
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 PclZip($p_zipname)
216   {
217     //--(MAGIC-PclTrace)--//PclTraceFctStart(__FILE__, __LINE__, 'PclZip::PclZip', "zipname=$p_zipname");
218
219     // ----- Tests the zlib
220     if (!function_exists('gzopen'))
221     {
222       //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 1, "zlib extension seems to be missing");
223       die('Abort '.basename(__FILE__).' : Missing zlib extensions');
224     }
225
226     // ----- Set the attributes
227     $this->zipname = $p_zipname;
228     $this->zip_fd = 0;
229     $this->magic_quotes_status = -1;
230
231     // ----- Return
232     //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, 1);
233     return;
234   }
235   // --------------------------------------------------------------------------------
236
237   // --------------------------------------------------------------------------------
238   // Function :
239   //   create($p_filelist, $p_add_dir="", $p_remove_dir="")
240   //   create($p_filelist, $p_option, $p_option_value, ...)
241   // Description :
242   //   This method supports two different synopsis. The first one is historical.
243   //   This method creates a Zip Archive. The Zip file is created in the
244   //   filesystem. The files and directories indicated in $p_filelist
245   //   are added in the archive. See the parameters description for the
246   //   supported format of $p_filelist.
247   //   When a directory is in the list, the directory and its content is added
248   //   in the archive.
249   //   In this synopsis, the function takes an optional variable list of
250   //   options. See bellow the supported options.
251   // Parameters :
252   //   $p_filelist : An array containing file or directory names, or
253   //                 a string containing one filename or one directory name, or
254   //                 a string containing a list of filenames and/or directory
255   //                 names separated by spaces.
256   //   $p_add_dir : A path to add before the real path of the archived file,
257   //                in order to have it memorized in the archive.
258   //   $p_remove_dir : A path to remove from the real path of the file to archive,
259   //                   in order to have a shorter path memorized in the archive.
260   //                   When $p_add_dir and $p_remove_dir are set, $p_remove_dir
261   //                   is removed first, before $p_add_dir is added.
262   // Options :
263   //   PCLZIP_OPT_ADD_PATH :
264   //   PCLZIP_OPT_REMOVE_PATH :
265   //   PCLZIP_OPT_REMOVE_ALL_PATH :
266   //   PCLZIP_OPT_COMMENT :
267   //   PCLZIP_CB_PRE_ADD :
268   //   PCLZIP_CB_POST_ADD :
269   // Return Values :
270   //   0 on failure,
271   //   The list of the added files, with a status of the add action.
272   //   (see PclZip::listContent() for list entry format)
273   // --------------------------------------------------------------------------------
274   function create($p_filelist)
275   {
276     //--(MAGIC-PclTrace)--//PclTraceFctStart(__FILE__, __LINE__, 'PclZip::create', "filelist='$p_filelist', ...");
277     $v_result=1;
278
279     // ----- Reset the error handler
280     $this->privErrorReset();
281
282     // ----- Set default values
283     $v_options = array();
284     $v_options[PCLZIP_OPT_NO_COMPRESSION] = FALSE;
285
286     // ----- Look for variable options arguments
287     $v_size = func_num_args();
288     //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 4, "$v_size arguments passed to the method");
289
290     // ----- Look for arguments
291     if ($v_size > 1) {
292       // ----- Get the arguments
293       $v_arg_list = func_get_args();
294
295       // ----- Remove from the options list the first argument
296       array_shift($v_arg_list);
297       $v_size--;
298
299       // ----- Look for first arg
300       if ((is_integer($v_arg_list[0])) && ($v_arg_list[0] > 77000)) {
301         //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, "Variable list of options detected");
302
303         // ----- Parse the options
304         $v_result = $this->privParseOptions($v_arg_list, $v_size, $v_options,
305                                             array (PCLZIP_OPT_REMOVE_PATH => 'optional',
306                                                    PCLZIP_OPT_REMOVE_ALL_PATH => 'optional',
307                                                    PCLZIP_OPT_ADD_PATH => 'optional',
308                                                    PCLZIP_CB_PRE_ADD => 'optional',
309                                                    PCLZIP_CB_POST_ADD => 'optional',
310                                                    PCLZIP_OPT_NO_COMPRESSION => 'optional',
311                                                    PCLZIP_OPT_COMMENT => 'optional',
312                                                    PCLZIP_OPT_TEMP_FILE_THRESHOLD => 'optional',
313                                                    PCLZIP_OPT_TEMP_FILE_ON => 'optional',
314                                                    PCLZIP_OPT_TEMP_FILE_OFF => 'optional'
315                                                    //, PCLZIP_OPT_CRYPT => 'optional'
316                                              ));
317         if ($v_result != 1) {
318           //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, 0);
319           return 0;
320         }
321       }
322
323       // ----- Look for 2 args
324       // Here we need to support the first historic synopsis of the
325       // method.
326       else {
327         //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, "Static synopsis");
328
329         // ----- Get the first argument
330         $v_options[PCLZIP_OPT_ADD_PATH] = $v_arg_list[0];
331
332         // ----- Look for the optional second argument
333         if ($v_size == 2) {
334           $v_options[PCLZIP_OPT_REMOVE_PATH] = $v_arg_list[1];
335         }
336         else if ($v_size > 2) {
337           PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER,
338                                        "Invalid number / type of arguments");
339           //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
340           return 0;
341         }
342       }
343     }
344     
345     // ----- Look for default option values
346     $this->privOptionDefaultThreshold($v_options);
347
348     // ----- Init
349     $v_string_list = array();
350     $v_att_list = array();
351     $v_filedescr_list = array();
352     $p_result_list = array();
353     
354     // ----- Look if the $p_filelist is really an array
355     if (is_array($p_filelist)) {
356     
357       // ----- Look if the first element is also an array
358       //       This will mean that this is a file description entry
359       if (isset($p_filelist[0]) && is_array($p_filelist[0])) {
360         $v_att_list = $p_filelist;
361       }
362       
363       // ----- The list is a list of string names
364       else {
365         $v_string_list = $p_filelist;
366       }
367     }
368
369     // ----- Look if the $p_filelist is a string
370     else if (is_string($p_filelist)) {
371       // ----- Create a list from the string
372       $v_string_list = explode(PCLZIP_SEPARATOR, $p_filelist);
373     }
374
375     // ----- Invalid variable type for $p_filelist
376     else {
377       PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Invalid variable type p_filelist");
378       //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, 0);
379       return 0;
380     }
381     
382     // ----- Reformat the string list
383     if (sizeof($v_string_list) != 0) {
384       foreach ($v_string_list as $v_string) {
385         if ($v_string != '') {
386           $v_att_list[][PCLZIP_ATT_FILE_NAME] = $v_string;
387         }
388         else {
389           //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, "Ignore an empty filename");
390         }
391       }
392     }
393     
394     // ----- For each file in the list check the attributes
395     $v_supported_attributes
396     = array ( PCLZIP_ATT_FILE_NAME => 'mandatory'
397              ,PCLZIP_ATT_FILE_NEW_SHORT_NAME => 'optional'
398              ,PCLZIP_ATT_FILE_NEW_FULL_NAME => 'optional'
399              ,PCLZIP_ATT_FILE_MTIME => 'optional'
400              ,PCLZIP_ATT_FILE_CONTENT => 'optional'
401              ,PCLZIP_ATT_FILE_COMMENT => 'optional'
402                                                 );
403     foreach ($v_att_list as $v_entry) {
404       $v_result = $this->privFileDescrParseAtt($v_entry,
405                                                $v_filedescr_list[],
406                                                $v_options,
407                                                $v_supported_attributes);
408       if ($v_result != 1) {
409         //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, 0);
410         return 0;
411       }
412     }
413
414     // ----- Expand the filelist (expand directories)
415     $v_result = $this->privFileDescrExpand($v_filedescr_list, $v_options);
416     if ($v_result != 1) {
417       //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, 0);
418       return 0;
419     }
420
421     // ----- Call the create fct
422     $v_result = $this->privCreate($v_filedescr_list, $p_result_list, $v_options);
423     if ($v_result != 1) {
424       //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, 0);
425       return 0;
426     }
427
428     // ----- Return
429     //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $p_result_list);
430     return $p_result_list;
431   }
432   // --------------------------------------------------------------------------------
433
434   // --------------------------------------------------------------------------------
435   // Function :
436   //   add($p_filelist, $p_add_dir="", $p_remove_dir="")
437   //   add($p_filelist, $p_option, $p_option_value, ...)
438   // Description :
439   //   This method supports two synopsis. The first one is historical.
440   //   This methods add the list of files in an existing archive.
441   //   If a file with the same name already exists, it is added at the end of the
442   //   archive, the first one is still present.
443   //   If the archive does not exist, it is created.
444   // Parameters :
445   //   $p_filelist : An array containing file or directory names, or
446   //                 a string containing one filename or one directory name, or
447   //                 a string containing a list of filenames and/or directory
448   //                 names separated by spaces.
449   //   $p_add_dir : A path to add before the real path of the archived file,
450   //                in order to have it memorized in the archive.
451   //   $p_remove_dir : A path to remove from the real path of the file to archive,
452   //                   in order to have a shorter path memorized in the archive.
453   //                   When $p_add_dir and $p_remove_dir are set, $p_remove_dir
454   //                   is removed first, before $p_add_dir is added.
455   // Options :
456   //   PCLZIP_OPT_ADD_PATH :
457   //   PCLZIP_OPT_REMOVE_PATH :
458   //   PCLZIP_OPT_REMOVE_ALL_PATH :
459   //   PCLZIP_OPT_COMMENT :
460   //   PCLZIP_OPT_ADD_COMMENT :
461   //   PCLZIP_OPT_PREPEND_COMMENT :
462   //   PCLZIP_CB_PRE_ADD :
463   //   PCLZIP_CB_POST_ADD :
464   // Return Values :
465   //   0 on failure,
466   //   The list of the added files, with a status of the add action.
467   //   (see PclZip::listContent() for list entry format)
468   // --------------------------------------------------------------------------------
469   function add($p_filelist)
470   {
471     //--(MAGIC-PclTrace)--//PclTraceFctStart(__FILE__, __LINE__, 'PclZip::add', "filelist='$p_filelist', ...");
472     $v_result=1;
473
474     // ----- Reset the error handler
475     $this->privErrorReset();
476
477     // ----- Set default values
478     $v_options = array();
479     $v_options[PCLZIP_OPT_NO_COMPRESSION] = FALSE;
480
481     // ----- Look for variable options arguments
482     $v_size = func_num_args();
483     //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 4, "$v_size arguments passed to the method");
484
485     // ----- Look for arguments
486     if ($v_size > 1) {
487       // ----- Get the arguments
488       $v_arg_list = func_get_args();
489
490       // ----- Remove form the options list the first argument
491       array_shift($v_arg_list);
492       $v_size--;
493
494       // ----- Look for first arg
495       if ((is_integer($v_arg_list[0])) && ($v_arg_list[0] > 77000)) {
496         //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, "Variable list of options detected");
497
498         // ----- Parse the options
499         $v_result = $this->privParseOptions($v_arg_list, $v_size, $v_options,
500                                             array (PCLZIP_OPT_REMOVE_PATH => 'optional',
501                                                    PCLZIP_OPT_REMOVE_ALL_PATH => 'optional',
502                                                    PCLZIP_OPT_ADD_PATH => 'optional',
503                                                    PCLZIP_CB_PRE_ADD => 'optional',
504                                                    PCLZIP_CB_POST_ADD => 'optional',
505                                                    PCLZIP_OPT_NO_COMPRESSION => 'optional',
506                                                    PCLZIP_OPT_COMMENT => 'optional',
507                                                    PCLZIP_OPT_ADD_COMMENT => 'optional',
508                                                    PCLZIP_OPT_PREPEND_COMMENT => 'optional',
509                                                    PCLZIP_OPT_TEMP_FILE_THRESHOLD => 'optional',
510                                                    PCLZIP_OPT_TEMP_FILE_ON => 'optional',
511                                                    PCLZIP_OPT_TEMP_FILE_OFF => 'optional'
512                                                    //, PCLZIP_OPT_CRYPT => 'optional'
513                                                                                                    ));
514         if ($v_result != 1) {
515           //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, 0);
516           return 0;
517         }
518       }
519
520       // ----- Look for 2 args
521       // Here we need to support the first historic synopsis of the
522       // method.
523       else {
524         //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, "Static synopsis");
525
526         // ----- Get the first argument
527         $v_options[PCLZIP_OPT_ADD_PATH] = $v_add_path = $v_arg_list[0];
528
529         // ----- Look for the optional second argument
530         if ($v_size == 2) {
531           $v_options[PCLZIP_OPT_REMOVE_PATH] = $v_arg_list[1];
532         }
533         else if ($v_size > 2) {
534           // ----- Error log
535           PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Invalid number / type of arguments");
536
537           // ----- Return
538           //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
539           return 0;
540         }
541       }
542     }
543
544     // ----- Look for default option values
545     $this->privOptionDefaultThreshold($v_options);
546
547     // ----- Init
548     $v_string_list = array();
549     $v_att_list = array();
550     $v_filedescr_list = array();
551     $p_result_list = array();
552     
553     // ----- Look if the $p_filelist is really an array
554     if (is_array($p_filelist)) {
555     
556       // ----- Look if the first element is also an array
557       //       This will mean that this is a file description entry
558       if (isset($p_filelist[0]) && is_array($p_filelist[0])) {
559         $v_att_list = $p_filelist;
560       }
561       
562       // ----- The list is a list of string names
563       else {
564         $v_string_list = $p_filelist;
565       }
566     }
567
568     // ----- Look if the $p_filelist is a string
569     else if (is_string($p_filelist)) {
570       // ----- Create a list from the string
571       $v_string_list = explode(PCLZIP_SEPARATOR, $p_filelist);
572     }
573
574     // ----- Invalid variable type for $p_filelist
575     else {
576       PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Invalid variable type '".gettype($p_filelist)."' for p_filelist");
577       //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, 0);
578       return 0;
579     }
580     
581     // ----- Reformat the string list
582     if (sizeof($v_string_list) != 0) {
583       foreach ($v_string_list as $v_string) {
584         $v_att_list[][PCLZIP_ATT_FILE_NAME] = $v_string;
585       }
586     }
587     
588     // ----- For each file in the list check the attributes
589     $v_supported_attributes
590     = array ( PCLZIP_ATT_FILE_NAME => 'mandatory'
591              ,PCLZIP_ATT_FILE_NEW_SHORT_NAME => 'optional'
592              ,PCLZIP_ATT_FILE_NEW_FULL_NAME => 'optional'
593              ,PCLZIP_ATT_FILE_MTIME => 'optional'
594              ,PCLZIP_ATT_FILE_CONTENT => 'optional'
595              ,PCLZIP_ATT_FILE_COMMENT => 'optional'
596                                                 );
597     foreach ($v_att_list as $v_entry) {
598       $v_result = $this->privFileDescrParseAtt($v_entry,
599                                                $v_filedescr_list[],
600                                                $v_options,
601                                                $v_supported_attributes);
602       if ($v_result != 1) {
603         //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, 0);
604         return 0;
605       }
606     }
607
608     // ----- Expand the filelist (expand directories)
609     $v_result = $this->privFileDescrExpand($v_filedescr_list, $v_options);
610     if ($v_result != 1) {
611       //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, 0);
612       return 0;
613     }
614
615     // ----- Call the create fct
616     $v_result = $this->privAdd($v_filedescr_list, $p_result_list, $v_options);
617     if ($v_result != 1) {
618       //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, 0);
619       return 0;
620     }
621
622     // ----- Return
623     //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $p_result_list);
624     return $p_result_list;
625   }
626   // --------------------------------------------------------------------------------
627
628   // --------------------------------------------------------------------------------
629   // Function : listContent()
630   // Description :
631   //   This public method, gives the list of the files and directories, with their
632   //   properties.
633   //   The properties of each entries in the list are (used also in other functions) :
634   //     filename : Name of the file. For a create or add action it is the filename
635   //                given by the user. For an extract function it is the filename
636   //                of the extracted file.
637   //     stored_filename : Name of the file / directory stored in the archive.
638   //     size : Size of the stored file.
639   //     compressed_size : Size of the file's data compressed in the archive
640   //                       (without the headers overhead)
641   //     mtime : Last known modification date of the file (UNIX timestamp)
642   //     comment : Comment associated with the file
643   //     folder : true | false
644   //     index : index of the file in the archive
645   //     status : status of the action (depending of the action) :
646   //              Values are :
647   //                ok : OK !
648   //                filtered : the file / dir is not extracted (filtered by user)
649   //                already_a_directory : the file can not be extracted because a
650   //                                      directory with the same name already exists
651   //                write_protected : the file can not be extracted because a file
652   //                                  with the same name already exists and is
653   //                                  write protected
654   //                newer_exist : the file was not extracted because a newer file exists
655   //                path_creation_fail : the file is not extracted because the folder
656   //                                     does not exist and can not be created
657   //                write_error : the file was not extracted because there was a
658   //                              error while writing the file
659   //                read_error : the file was not extracted because there was a error
660   //                             while reading the file
661   //                invalid_header : the file was not extracted because of an archive
662   //                                 format error (bad file header)
663   //   Note that each time a method can continue operating when there
664   //   is an action error on a file, the error is only logged in the file status.
665   // Return Values :
666   //   0 on an unrecoverable failure,
667   //   The list of the files in the archive.
668   // --------------------------------------------------------------------------------
669   function listContent()
670   {
671     //--(MAGIC-PclTrace)--//PclTraceFctStart(__FILE__, __LINE__, 'PclZip::listContent', "");
672     $v_result=1;
673
674     // ----- Reset the error handler
675     $this->privErrorReset();
676
677     // ----- Check archive
678     if (!$this->privCheckFormat()) {
679       //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, 0);
680       return(0);
681     }
682
683     // ----- Call the extracting fct
684     $p_list = array();
685     if (($v_result = $this->privList($p_list)) != 1)
686     {
687       unset($p_list);
688       //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, 0, PclZip::errorInfo());
689       return(0);
690     }
691
692     // ----- Return
693     //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $p_list);
694     return $p_list;
695   }
696   // --------------------------------------------------------------------------------
697
698   // --------------------------------------------------------------------------------
699   // Function :
700   //   extract($p_path="./", $p_remove_path="")
701   //   extract([$p_option, $p_option_value, ...])
702   // Description :
703   //   This method supports two synopsis. The first one is historical.
704   //   This method extract all the files / directories from the archive to the
705   //   folder indicated in $p_path.
706   //   If you want to ignore the 'root' part of path of the memorized files
707   //   you can indicate this in the optional $p_remove_path parameter.
708   //   By default, if a newer file with the same name already exists, the
709   //   file is not extracted.
710   //
711   //   If both PCLZIP_OPT_PATH and PCLZIP_OPT_ADD_PATH aoptions
712   //   are used, the path indicated in PCLZIP_OPT_ADD_PATH is append
713   //   at the end of the path value of PCLZIP_OPT_PATH.
714   // Parameters :
715   //   $p_path : Path where the files and directories are to be extracted
716   //   $p_remove_path : First part ('root' part) of the memorized path
717   //                    (if any similar) to remove while extracting.
718   // Options :
719   //   PCLZIP_OPT_PATH :
720   //   PCLZIP_OPT_ADD_PATH :
721   //   PCLZIP_OPT_REMOVE_PATH :
722   //   PCLZIP_OPT_REMOVE_ALL_PATH :
723   //   PCLZIP_CB_PRE_EXTRACT :
724   //   PCLZIP_CB_POST_EXTRACT :
725   // Return Values :
726   //   0 or a negative value on failure,
727   //   The list of the extracted files, with a status of the action.
728   //   (see PclZip::listContent() for list entry format)
729   // --------------------------------------------------------------------------------
730   function extract()
731   {
732     //--(MAGIC-PclTrace)--//PclTraceFctStart(__FILE__, __LINE__, "PclZip::extract", "");
733     $v_result=1;
734
735     // ----- Reset the error handler
736     $this->privErrorReset();
737
738     // ----- Check archive
739     if (!$this->privCheckFormat()) {
740       //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, 0);
741       return(0);
742     }
743
744     // ----- Set default values
745     $v_options = array();
746 //    $v_path = "./";
747     $v_path = '';
748     $v_remove_path = "";
749     $v_remove_all_path = false;
750
751     // ----- Look for variable options arguments
752     $v_size = func_num_args();
753     //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 4, "$v_size arguments passed to the method");
754
755     // ----- Default values for option
756     $v_options[PCLZIP_OPT_EXTRACT_AS_STRING] = FALSE;
757
758     // ----- Look for arguments
759     if ($v_size > 0) {
760       // ----- Get the arguments
761       $v_arg_list = func_get_args();
762
763       // ----- Look for first arg
764       if ((is_integer($v_arg_list[0])) && ($v_arg_list[0] > 77000)) {
765         //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, "Variable list of options");
766
767         // ----- Parse the options
768         $v_result = $this->privParseOptions($v_arg_list, $v_size, $v_options,
769                                             array (PCLZIP_OPT_PATH => 'optional',
770                                                    PCLZIP_OPT_REMOVE_PATH => 'optional',
771                                                    PCLZIP_OPT_REMOVE_ALL_PATH => 'optional',
772                                                    PCLZIP_OPT_ADD_PATH => 'optional',
773                                                    PCLZIP_CB_PRE_EXTRACT => 'optional',
774                                                    PCLZIP_CB_POST_EXTRACT => 'optional',
775                                                    PCLZIP_OPT_SET_CHMOD => 'optional',
776                                                    PCLZIP_OPT_BY_NAME => 'optional',
777                                                    PCLZIP_OPT_BY_EREG => 'optional',
778                                                    PCLZIP_OPT_BY_PREG => 'optional',
779                                                    PCLZIP_OPT_BY_INDEX => 'optional',
780                                                    PCLZIP_OPT_EXTRACT_AS_STRING => 'optional',
781                                                    PCLZIP_OPT_EXTRACT_IN_OUTPUT => 'optional',
782                                                    PCLZIP_OPT_REPLACE_NEWER => 'optional'
783                                                    ,PCLZIP_OPT_STOP_ON_ERROR => 'optional'
784                                                    ,PCLZIP_OPT_EXTRACT_DIR_RESTRICTION => 'optional',
785                                                    PCLZIP_OPT_TEMP_FILE_THRESHOLD => 'optional',
786                                                    PCLZIP_OPT_TEMP_FILE_ON => 'optional',
787                                                    PCLZIP_OPT_TEMP_FILE_OFF => 'optional'
788                                                                                                     ));
789         if ($v_result != 1) {
790           //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, 0);
791           return 0;
792         }
793
794         // ----- Set the arguments
795         if (isset($v_options[PCLZIP_OPT_PATH])) {
796           $v_path = $v_options[PCLZIP_OPT_PATH];
797         }
798         if (isset($v_options[PCLZIP_OPT_REMOVE_PATH])) {
799           $v_remove_path = $v_options[PCLZIP_OPT_REMOVE_PATH];
800         }
801         if (isset($v_options[PCLZIP_OPT_REMOVE_ALL_PATH])) {
802           $v_remove_all_path = $v_options[PCLZIP_OPT_REMOVE_ALL_PATH];
803         }
804         if (isset($v_options[PCLZIP_OPT_ADD_PATH])) {
805           // ----- Check for '/' in last path char
806           if ((strlen($v_path) > 0) && (substr($v_path, -1) != '/')) {
807             $v_path .= '/';
808           }
809           $v_path .= $v_options[PCLZIP_OPT_ADD_PATH];
810         }
811       }
812
813       // ----- Look for 2 args
814       // Here we need to support the first historic synopsis of the
815       // method.
816       else {
817         //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, "Static synopsis");
818
819         // ----- Get the first argument
820         $v_path = $v_arg_list[0];
821
822         // ----- Look for the optional second argument
823         if ($v_size == 2) {
824           $v_remove_path = $v_arg_list[1];
825         }
826         else if ($v_size > 2) {
827           // ----- Error log
828           PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Invalid number / type of arguments");
829
830           // ----- Return
831           //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, 0, PclZip::errorInfo());
832           return 0;
833         }
834       }
835     }
836
837     // ----- Look for default option values
838     $this->privOptionDefaultThreshold($v_options);
839
840     // ----- Trace
841     //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2, "path='$v_path', remove_path='$v_remove_path', remove_all_path='".($v_remove_path?'true':'false')."'");
842
843     // ----- Call the extracting fct
844     $p_list = array();
845     $v_result = $this->privExtractByRule($p_list, $v_path, $v_remove_path,
846                                              $v_remove_all_path, $v_options);
847     if ($v_result < 1) {
848       unset($p_list);
849       //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, 0, PclZip::errorInfo());
850       return(0);
851     }
852
853     // ----- Return
854     //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $p_list);
855     return $p_list;
856   }
857   // --------------------------------------------------------------------------------
858
859
860   // --------------------------------------------------------------------------------
861   // Function :
862   //   extractByIndex($p_index, $p_path="./", $p_remove_path="")
863   //   extractByIndex($p_index, [$p_option, $p_option_value, ...])
864   // Description :
865   //   This method supports two synopsis. The first one is historical.
866   //   This method is doing a partial extract of the archive.
867   //   The extracted files or folders are identified by their index in the
868   //   archive (from 0 to n).
869   //   Note that if the index identify a folder, only the folder entry is
870   //   extracted, not all the files included in the archive.
871   // Parameters :
872   //   $p_index : A single index (integer) or a string of indexes of files to
873   //              extract. The form of the string is "0,4-6,8-12" with only numbers
874   //              and '-' for range or ',' to separate ranges. No spaces or ';'
875   //              are allowed.
876   //   $p_path : Path where the files and directories are to be extracted
877   //   $p_remove_path : First part ('root' part) of the memorized path
878   //                    (if any similar) to remove while extracting.
879   // Options :
880   //   PCLZIP_OPT_PATH :
881   //   PCLZIP_OPT_ADD_PATH :
882   //   PCLZIP_OPT_REMOVE_PATH :
883   //   PCLZIP_OPT_REMOVE_ALL_PATH :
884   //   PCLZIP_OPT_EXTRACT_AS_STRING : The files are extracted as strings and
885   //     not as files.
886   //     The resulting content is in a new field 'content' in the file
887   //     structure.
888   //     This option must be used alone (any other options are ignored).
889   //   PCLZIP_CB_PRE_EXTRACT :
890   //   PCLZIP_CB_POST_EXTRACT :
891   // Return Values :
892   //   0 on failure,
893   //   The list of the extracted files, with a status of the action.
894   //   (see PclZip::listContent() for list entry format)
895   // --------------------------------------------------------------------------------
896   //function extractByIndex($p_index, options...)
897   function extractByIndex($p_index)
898   {
899     //--(MAGIC-PclTrace)--//PclTraceFctStart(__FILE__, __LINE__, "PclZip::extractByIndex", "index='$p_index', ...");
900     $v_result=1;
901
902     // ----- Reset the error handler
903     $this->privErrorReset();
904
905     // ----- Check archive
906     if (!$this->privCheckFormat()) {
907       //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, 0);
908       return(0);
909     }
910
911     // ----- Set default values
912     $v_options = array();
913 //    $v_path = "./";
914     $v_path = '';
915     $v_remove_path = "";
916     $v_remove_all_path = false;
917
918     // ----- Look for variable options arguments
919     $v_size = func_num_args();
920     //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 4, "$v_size arguments passed to the method");
921
922     // ----- Default values for option
923     $v_options[PCLZIP_OPT_EXTRACT_AS_STRING] = FALSE;
924
925     // ----- Look for arguments
926     if ($v_size > 1) {
927       // ----- Get the arguments
928       $v_arg_list = func_get_args();
929
930       // ----- Remove form the options list the first argument
931       array_shift($v_arg_list);
932       $v_size--;
933
934       // ----- Look for first arg
935       if ((is_integer($v_arg_list[0])) && ($v_arg_list[0] > 77000)) {
936         //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, "Variable list of options");
937
938         // ----- Parse the options
939         $v_result = $this->privParseOptions($v_arg_list, $v_size, $v_options,
940                                             array (PCLZIP_OPT_PATH => 'optional',
941                                                    PCLZIP_OPT_REMOVE_PATH => 'optional',
942                                                    PCLZIP_OPT_REMOVE_ALL_PATH => 'optional',
943                                                    PCLZIP_OPT_EXTRACT_AS_STRING => 'optional',
944                                                    PCLZIP_OPT_ADD_PATH => 'optional',
945                                                    PCLZIP_CB_PRE_EXTRACT => 'optional',
946                                                    PCLZIP_CB_POST_EXTRACT => 'optional',
947                                                    PCLZIP_OPT_SET_CHMOD => 'optional',
948                                                    PCLZIP_OPT_REPLACE_NEWER => 'optional'
949                                                    ,PCLZIP_OPT_STOP_ON_ERROR => 'optional'
950                                                    ,PCLZIP_OPT_EXTRACT_DIR_RESTRICTION => 'optional',
951                                                    PCLZIP_OPT_TEMP_FILE_THRESHOLD => 'optional',
952                                                    PCLZIP_OPT_TEMP_FILE_ON => 'optional',
953                                                    PCLZIP_OPT_TEMP_FILE_OFF => 'optional'
954                                                                                                    ));
955         if ($v_result != 1) {
956           //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, 0);
957           return 0;
958         }
959
960         // ----- Set the arguments
961         if (isset($v_options[PCLZIP_OPT_PATH])) {
962           $v_path = $v_options[PCLZIP_OPT_PATH];
963         }
964         if (isset($v_options[PCLZIP_OPT_REMOVE_PATH])) {
965           $v_remove_path = $v_options[PCLZIP_OPT_REMOVE_PATH];
966         }
967         if (isset($v_options[PCLZIP_OPT_REMOVE_ALL_PATH])) {
968           $v_remove_all_path = $v_options[PCLZIP_OPT_REMOVE_ALL_PATH];
969         }
970         if (isset($v_options[PCLZIP_OPT_ADD_PATH])) {
971           // ----- Check for '/' in last path char
972           if ((strlen($v_path) > 0) && (substr($v_path, -1) != '/')) {
973             $v_path .= '/';
974           }
975           $v_path .= $v_options[PCLZIP_OPT_ADD_PATH];
976         }
977         if (!isset($v_options[PCLZIP_OPT_EXTRACT_AS_STRING])) {
978           $v_options[PCLZIP_OPT_EXTRACT_AS_STRING] = FALSE;
979           //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 4, "Option PCLZIP_OPT_EXTRACT_AS_STRING not set.");
980         }
981         else {
982             //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 4, "Option PCLZIP_OPT_EXTRACT_AS_STRING set.");
983         }
984       }
985
986       // ----- Look for 2 args
987       // Here we need to support the first historic synopsis of the
988       // method.
989       else {
990         //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, "Static synopsis");
991
992         // ----- Get the first argument
993         $v_path = $v_arg_list[0];
994
995         // ----- Look for the optional second argument
996         if ($v_size == 2) {
997           $v_remove_path = $v_arg_list[1];
998         }
999         else if ($v_size > 2) {
1000           // ----- Error log
1001           PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Invalid number / type of arguments");
1002
1003           // ----- Return
1004           //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
1005           return 0;
1006         }
1007       }
1008     }
1009
1010     // ----- Trace
1011     //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2, "index='$p_index', path='$v_path', remove_path='$v_remove_path', remove_all_path='".($v_remove_path?'true':'false')."'");
1012
1013     // ----- Trick
1014     // Here I want to reuse extractByRule(), so I need to parse the $p_index
1015     // with privParseOptions()
1016     $v_arg_trick = array (PCLZIP_OPT_BY_INDEX, $p_index);
1017     $v_options_trick = array();
1018     $v_result = $this->privParseOptions($v_arg_trick, sizeof($v_arg_trick), $v_options_trick,
1019                                         array (PCLZIP_OPT_BY_INDEX => 'optional' ));
1020     if ($v_result != 1) {
1021         //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, 0);
1022         return 0;
1023     }
1024     $v_options[PCLZIP_OPT_BY_INDEX] = $v_options_trick[PCLZIP_OPT_BY_INDEX];
1025
1026     // ----- Look for default option values
1027     $this->privOptionDefaultThreshold($v_options);
1028
1029     // ----- Call the extracting fct
1030     if (($v_result = $this->privExtractByRule($p_list, $v_path, $v_remove_path, $v_remove_all_path, $v_options)) < 1) {
1031         //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, 0, PclZip::errorInfo());
1032         return(0);
1033     }
1034
1035     // ----- Return
1036     //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $p_list);
1037     return $p_list;
1038   }
1039   // --------------------------------------------------------------------------------
1040
1041   // --------------------------------------------------------------------------------
1042   // Function :
1043   //   delete([$p_option, $p_option_value, ...])
1044   // Description :
1045   //   This method removes files from the archive.
1046   //   If no parameters are given, then all the archive is emptied.
1047   // Parameters :
1048   //   None or optional arguments.
1049   // Options :
1050   //   PCLZIP_OPT_BY_INDEX :
1051   //   PCLZIP_OPT_BY_NAME :
1052   //   PCLZIP_OPT_BY_EREG : 
1053   //   PCLZIP_OPT_BY_PREG :
1054   // Return Values :
1055   //   0 on failure,
1056   //   The list of the files which are still present in the archive.
1057   //   (see PclZip::listContent() for list entry format)
1058   // --------------------------------------------------------------------------------
1059   function delete()
1060   {
1061     //--(MAGIC-PclTrace)--//PclTraceFctStart(__FILE__, __LINE__, "PclZip::delete", "");
1062     $v_result=1;
1063
1064     // ----- Reset the error handler
1065     $this->privErrorReset();
1066
1067     // ----- Check archive
1068     if (!$this->privCheckFormat()) {
1069       //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, 0);
1070       return(0);
1071     }
1072
1073     // ----- Set default values
1074     $v_options = array();
1075
1076     // ----- Look for variable options arguments
1077     $v_size = func_num_args();
1078     //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 4, "$v_size arguments passed to the method");
1079
1080     // ----- Look for arguments
1081     if ($v_size > 0) {
1082       // ----- Get the arguments
1083       $v_arg_list = func_get_args();
1084
1085       // ----- Parse the options
1086       $v_result = $this->privParseOptions($v_arg_list, $v_size, $v_options,
1087                                         array (PCLZIP_OPT_BY_NAME => 'optional',
1088                                                PCLZIP_OPT_BY_EREG => 'optional',
1089                                                PCLZIP_OPT_BY_PREG => 'optional',
1090                                                PCLZIP_OPT_BY_INDEX => 'optional' ));
1091       if ($v_result != 1) {
1092           //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, 0);
1093           return 0;
1094       }
1095     }
1096
1097     // ----- Magic quotes trick
1098     $this->privDisableMagicQuotes();
1099
1100     // ----- Call the delete fct
1101     $v_list = array();
1102     if (($v_result = $this->privDeleteByRule($v_list, $v_options)) != 1) {
1103       $this->privSwapBackMagicQuotes();
1104       unset($v_list);
1105       //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, 0, PclZip::errorInfo());
1106       return(0);
1107     }
1108
1109     // ----- Magic quotes trick
1110     $this->privSwapBackMagicQuotes();
1111
1112     // ----- Return
1113     //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $v_list);
1114     return $v_list;
1115   }
1116   // --------------------------------------------------------------------------------
1117
1118   // --------------------------------------------------------------------------------
1119   // Function : deleteByIndex()
1120   // Description :
1121   //   ***** Deprecated *****
1122   //   delete(PCLZIP_OPT_BY_INDEX, $p_index) should be prefered.
1123   // --------------------------------------------------------------------------------
1124   function deleteByIndex($p_index)
1125   {
1126     //--(MAGIC-PclTrace)--//PclTraceFctStart(__FILE__, __LINE__, "PclZip::deleteByIndex", "index='$p_index'");
1127     
1128     $p_list = $this->delete(PCLZIP_OPT_BY_INDEX, $p_index);
1129
1130     // ----- Return
1131     //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $p_list);
1132     return $p_list;
1133   }
1134   // --------------------------------------------------------------------------------
1135
1136   // --------------------------------------------------------------------------------
1137   // Function : properties()
1138   // Description :
1139   //   This method gives the properties of the archive.
1140   //   The properties are :
1141   //     nb : Number of files in the archive
1142   //     comment : Comment associated with the archive file
1143   //     status : not_exist, ok
1144   // Parameters :
1145   //   None
1146   // Return Values :
1147   //   0 on failure,
1148   //   An array with the archive properties.
1149   // --------------------------------------------------------------------------------
1150   function properties()
1151   {
1152     //--(MAGIC-PclTrace)--//PclTraceFctStart(__FILE__, __LINE__, "PclZip::properties", "");
1153
1154     // ----- Reset the error handler
1155     $this->privErrorReset();
1156
1157     // ----- Magic quotes trick
1158     $this->privDisableMagicQuotes();
1159
1160     // ----- Check archive
1161     if (!$this->privCheckFormat()) {
1162       $this->privSwapBackMagicQuotes();
1163       //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, 0);
1164       return(0);
1165     }
1166
1167     // ----- Default properties
1168     $v_prop = array();
1169     $v_prop['comment'] = '';
1170     $v_prop['nb'] = 0;
1171     $v_prop['status'] = 'not_exist';
1172
1173     // ----- Look if file exists
1174     if (@is_file($this->zipname))
1175     {
1176       // ----- Open the zip file
1177       //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, "Open file in binary read mode");
1178       if (($this->zip_fd = @fopen($this->zipname, 'rb')) == 0)
1179       {
1180         $this->privSwapBackMagicQuotes();
1181         
1182         // ----- Error log
1183         PclZip::privErrorLog(PCLZIP_ERR_READ_OPEN_FAIL, 'Unable to open archive \''.$this->zipname.'\' in binary read mode');
1184
1185         // ----- Return
1186         //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), 0);
1187         return 0;
1188       }
1189
1190       // ----- Read the central directory informations
1191       $v_central_dir = array();
1192       if (($v_result = $this->privReadEndCentralDir($v_central_dir)) != 1)
1193       {
1194         $this->privSwapBackMagicQuotes();
1195         //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, 0);
1196         return 0;
1197       }
1198
1199       // ----- Close the zip file
1200       $this->privCloseFd();
1201
1202       // ----- Set the user attributes
1203       $v_prop['comment'] = $v_central_dir['comment'];
1204       $v_prop['nb'] = $v_central_dir['entries'];
1205       $v_prop['status'] = 'ok';
1206     }
1207
1208     // ----- Magic quotes trick
1209     $this->privSwapBackMagicQuotes();
1210
1211     // ----- Return
1212     //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $v_prop);
1213     return $v_prop;
1214   }
1215   // --------------------------------------------------------------------------------
1216
1217   // --------------------------------------------------------------------------------
1218   // Function : duplicate()
1219   // Description :
1220   //   This method creates an archive by copying the content of an other one. If
1221   //   the archive already exist, it is replaced by the new one without any warning.
1222   // Parameters :
1223   //   $p_archive : The filename of a valid archive, or
1224   //                a valid PclZip object.
1225   // Return Values :
1226   //   1 on success.
1227   //   0 or a negative value on error (error code).
1228   // --------------------------------------------------------------------------------
1229   function duplicate($p_archive)
1230   {
1231     //--(MAGIC-PclTrace)--//PclTraceFctStart(__FILE__, __LINE__, "PclZip::duplicate", "");
1232     $v_result = 1;
1233
1234     // ----- Reset the error handler
1235     $this->privErrorReset();
1236
1237     // ----- Look if the $p_archive is a PclZip object
1238     if ((is_object($p_archive)) && (get_class($p_archive) == 'pclzip'))
1239     {
1240       //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2, "The parameter is valid PclZip object '".$p_archive->zipname."'");
1241
1242       // ----- Duplicate the archive
1243       $v_result = $this->privDuplicate($p_archive->zipname);
1244     }
1245
1246     // ----- Look if the $p_archive is a string (so a filename)
1247     else if (is_string($p_archive))
1248     {
1249       //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2, "The parameter is a filename '$p_archive'");
1250
1251       // ----- Check that $p_archive is a valid zip file
1252       // TBC : Should also check the archive format
1253       if (!is_file($p_archive)) {
1254         // ----- Error log
1255         PclZip::privErrorLog(PCLZIP_ERR_MISSING_FILE, "No file with filename '".$p_archive."'");
1256         $v_result = PCLZIP_ERR_MISSING_FILE;
1257       }
1258       else {
1259         // ----- Duplicate the archive
1260         $v_result = $this->privDuplicate($p_archive);
1261       }
1262     }
1263
1264     // ----- Invalid variable
1265     else
1266     {
1267       // ----- Error log
1268       PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Invalid variable type p_archive_to_add");
1269       $v_result = PCLZIP_ERR_INVALID_PARAMETER;
1270     }
1271
1272     // ----- Return
1273     //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $v_result);
1274     return $v_result;
1275   }
1276   // --------------------------------------------------------------------------------
1277
1278   // --------------------------------------------------------------------------------
1279   // Function : merge()
1280   // Description :
1281   //   This method merge the $p_archive_to_add archive at the end of the current
1282   //   one ($this).
1283   //   If the archive ($this) does not exist, the merge becomes a duplicate.
1284   //   If the $p_archive_to_add archive does not exist, the merge is a success.
1285   // Parameters :
1286   //   $p_archive_to_add : It can be directly the filename of a valid zip archive,
1287   //                       or a PclZip object archive.
1288   // Return Values :
1289   //   1 on success,
1290   //   0 or negative values on error (see below).
1291   // --------------------------------------------------------------------------------
1292   function merge($p_archive_to_add)
1293   {
1294     //--(MAGIC-PclTrace)--//PclTraceFctStart(__FILE__, __LINE__, "PclZip::merge", "");
1295     $v_result = 1;
1296
1297     // ----- Reset the error handler
1298     $this->privErrorReset();
1299
1300     // ----- Check archive
1301     if (!$this->privCheckFormat()) {
1302       //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, 0);
1303       return(0);
1304     }
1305
1306     // ----- Look if the $p_archive_to_add is a PclZip object
1307     if ((is_object($p_archive_to_add)) && (get_class($p_archive_to_add) == 'pclzip'))
1308     {
1309       //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, "The parameter is valid PclZip object");
1310
1311       // ----- Merge the archive
1312       $v_result = $this->privMerge($p_archive_to_add);
1313     }
1314
1315     // ----- Look if the $p_archive_to_add is a string (so a filename)
1316     else if (is_string($p_archive_to_add))
1317     {
1318       //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, "The parameter is a filename");
1319
1320       // ----- Create a temporary archive
1321       $v_object_archive = new PclZip($p_archive_to_add);
1322
1323       // ----- Merge the archive
1324       $v_result = $this->privMerge($v_object_archive);
1325     }
1326
1327     // ----- Invalid variable
1328     else
1329     {
1330       // ----- Error log
1331       PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Invalid variable type p_archive_to_add");
1332       $v_result = PCLZIP_ERR_INVALID_PARAMETER;
1333     }
1334
1335     // ----- Return
1336     //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $v_result);
1337     return $v_result;
1338   }
1339   // --------------------------------------------------------------------------------
1340
1341
1342
1343   // --------------------------------------------------------------------------------
1344   // Function : errorCode()
1345   // Description :
1346   // Parameters :
1347   // --------------------------------------------------------------------------------
1348   function errorCode()
1349   {
1350     if (PCLZIP_ERROR_EXTERNAL == 1) {
1351       return(PclErrorCode());
1352     }
1353     else {
1354       return($this->error_code);
1355     }
1356   }
1357   // --------------------------------------------------------------------------------
1358
1359   // --------------------------------------------------------------------------------
1360   // Function : errorName()
1361   // Description :
1362   // Parameters :
1363   // --------------------------------------------------------------------------------
1364   function errorName($p_with_code=false)
1365   {
1366     $v_name = array ( PCLZIP_ERR_NO_ERROR => 'PCLZIP_ERR_NO_ERROR',
1367                       PCLZIP_ERR_WRITE_OPEN_FAIL => 'PCLZIP_ERR_WRITE_OPEN_FAIL',
1368                       PCLZIP_ERR_READ_OPEN_FAIL => 'PCLZIP_ERR_READ_OPEN_FAIL',
1369                       PCLZIP_ERR_INVALID_PARAMETER => 'PCLZIP_ERR_INVALID_PARAMETER',
1370                       PCLZIP_ERR_MISSING_FILE => 'PCLZIP_ERR_MISSING_FILE',
1371                       PCLZIP_ERR_FILENAME_TOO_LONG => 'PCLZIP_ERR_FILENAME_TOO_LONG',
1372                       PCLZIP_ERR_INVALID_ZIP => 'PCLZIP_ERR_INVALID_ZIP',
1373                       PCLZIP_ERR_BAD_EXTRACTED_FILE => 'PCLZIP_ERR_BAD_EXTRACTED_FILE',
1374                       PCLZIP_ERR_DIR_CREATE_FAIL => 'PCLZIP_ERR_DIR_CREATE_FAIL',
1375                       PCLZIP_ERR_BAD_EXTENSION => 'PCLZIP_ERR_BAD_EXTENSION',
1376                       PCLZIP_ERR_BAD_FORMAT => 'PCLZIP_ERR_BAD_FORMAT',
1377                       PCLZIP_ERR_DELETE_FILE_FAIL => 'PCLZIP_ERR_DELETE_FILE_FAIL',
1378                       PCLZIP_ERR_RENAME_FILE_FAIL => 'PCLZIP_ERR_RENAME_FILE_FAIL',
1379                       PCLZIP_ERR_BAD_CHECKSUM => 'PCLZIP_ERR_BAD_CHECKSUM',
1380                       PCLZIP_ERR_INVALID_ARCHIVE_ZIP => 'PCLZIP_ERR_INVALID_ARCHIVE_ZIP',
1381                       PCLZIP_ERR_MISSING_OPTION_VALUE => 'PCLZIP_ERR_MISSING_OPTION_VALUE',
1382                       PCLZIP_ERR_INVALID_OPTION_VALUE => 'PCLZIP_ERR_INVALID_OPTION_VALUE',
1383                       PCLZIP_ERR_UNSUPPORTED_COMPRESSION => 'PCLZIP_ERR_UNSUPPORTED_COMPRESSION',
1384                       PCLZIP_ERR_UNSUPPORTED_ENCRYPTION => 'PCLZIP_ERR_UNSUPPORTED_ENCRYPTION'
1385                       ,PCLZIP_ERR_INVALID_ATTRIBUTE_VALUE => 'PCLZIP_ERR_INVALID_ATTRIBUTE_VALUE'
1386                       ,PCLZIP_ERR_DIRECTORY_RESTRICTION => 'PCLZIP_ERR_DIRECTORY_RESTRICTION'
1387                     );
1388
1389     if (isset($v_name[$this->error_code])) {
1390       $v_value = $v_name[$this->error_code];
1391     }
1392     else {
1393       $v_value = 'NoName';
1394     }
1395
1396     if ($p_with_code) {
1397       return($v_value.' ('.$this->error_code.')');
1398     }
1399     else {
1400       return($v_value);
1401     }
1402   }
1403   // --------------------------------------------------------------------------------
1404
1405   // --------------------------------------------------------------------------------
1406   // Function : errorInfo()
1407   // Description :
1408   // Parameters :
1409   // --------------------------------------------------------------------------------
1410   function errorInfo($p_full=false)
1411   {
1412     if (PCLZIP_ERROR_EXTERNAL == 1) {
1413       return(PclErrorString());
1414     }
1415     else {
1416       if ($p_full) {
1417         return($this->errorName(true)." : ".$this->error_string);
1418       }
1419       else {
1420         return($this->error_string." [code ".$this->error_code."]");
1421       }
1422     }
1423   }
1424   // --------------------------------------------------------------------------------
1425
1426
1427 // --------------------------------------------------------------------------------
1428 // ***** UNDER THIS LINE ARE DEFINED PRIVATE INTERNAL FUNCTIONS *****
1429 // *****                                                        *****
1430 // *****       THESES FUNCTIONS MUST NOT BE USED DIRECTLY       *****
1431 // --------------------------------------------------------------------------------
1432
1433
1434
1435   // --------------------------------------------------------------------------------
1436   // Function : privCheckFormat()
1437   // Description :
1438   //   This method check that the archive exists and is a valid zip archive.
1439   //   Several level of check exists. (futur)
1440   // Parameters :
1441   //   $p_level : Level of check. Default 0.
1442   //              0 : Check the first bytes (magic codes) (default value))
1443   //              1 : 0 + Check the central directory (futur)
1444   //              2 : 1 + Check each file header (futur)
1445   // Return Values :
1446   //   true on success,
1447   //   false on error, the error code is set.
1448   // --------------------------------------------------------------------------------
1449   function privCheckFormat($p_level=0)
1450   {
1451     //--(MAGIC-PclTrace)--//PclTraceFctStart(__FILE__, __LINE__, "PclZip::privCheckFormat", "");
1452     $v_result = true;
1453
1454         // ----- Reset the file system cache
1455     clearstatcache();
1456
1457     // ----- Reset the error handler
1458     $this->privErrorReset();
1459
1460     // ----- Look if the file exits
1461     if (!is_file($this->zipname)) {
1462       // ----- Error log
1463       PclZip::privErrorLog(PCLZIP_ERR_MISSING_FILE, "Missing archive file '".$this->zipname."'");
1464       //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, false, PclZip::errorInfo());
1465       return(false);
1466     }
1467
1468     // ----- Check that the file is readeable
1469     if (!is_readable($this->zipname)) {
1470       // ----- Error log
1471       PclZip::privErrorLog(PCLZIP_ERR_READ_OPEN_FAIL, "Unable to read archive '".$this->zipname."'");
1472       //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, false, PclZip::errorInfo());
1473       return(false);
1474     }
1475
1476     // ----- Check the magic code
1477     // TBC
1478
1479     // ----- Check the central header
1480     // TBC
1481
1482     // ----- Check each file header
1483     // TBC
1484
1485     // ----- Return
1486     //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $v_result);
1487     return $v_result;
1488   }
1489   // --------------------------------------------------------------------------------
1490
1491   // --------------------------------------------------------------------------------
1492   // Function : privParseOptions()
1493   // Description :
1494   //   This internal methods reads the variable list of arguments ($p_options_list,
1495   //   $p_size) and generate an array with the options and values ($v_result_list).
1496   //   $v_requested_options contains the options that can be present and those that
1497   //   must be present.
1498   //   $v_requested_options is an array, with the option value as key, and 'optional',
1499   //   or 'mandatory' as value.
1500   // Parameters :
1501   //   See above.
1502   // Return Values :
1503   //   1 on success.
1504   //   0 on failure.
1505   // --------------------------------------------------------------------------------
1506   function privParseOptions(&$p_options_list, $p_size, &$v_result_list, $v_requested_options=false)
1507   {
1508     //--(MAGIC-PclTrace)--//PclTraceFctStart(__FILE__, __LINE__, "PclZip::privParseOptions", "");
1509     $v_result=1;
1510     
1511     // ----- Read the options
1512     $i=0;
1513     while ($i<$p_size) {
1514       //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 4, "Looking for table index $i, option = '".PclZipUtilOptionText($p_options_list[$i])."(".$p_options_list[$i].")'");
1515
1516       // ----- Check if the option is supported
1517       if (!isset($v_requested_options[$p_options_list[$i]])) {
1518         // ----- Error log
1519         PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Invalid optional parameter '".$p_options_list[$i]."' for this method");
1520
1521         // ----- Return
1522         //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
1523         return PclZip::errorCode();
1524       }
1525
1526       // ----- Look for next option
1527       switch ($p_options_list[$i]) {
1528         // ----- Look for options that request a path value
1529         case PCLZIP_OPT_PATH :
1530         case PCLZIP_OPT_REMOVE_PATH :
1531         case PCLZIP_OPT_ADD_PATH :
1532           // ----- Check the number of parameters
1533           if (($i+1) >= $p_size) {
1534             // ----- Error log
1535             PclZip::privErrorLog(PCLZIP_ERR_MISSING_OPTION_VALUE, "Missing parameter value for option '".PclZipUtilOptionText($p_options_list[$i])."'");
1536
1537             // ----- Return
1538             //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
1539             return PclZip::errorCode();
1540           }
1541
1542           // ----- Get the value
1543           $v_result_list[$p_options_list[$i]] = PclZipUtilTranslateWinPath($p_options_list[$i+1], FALSE);
1544           //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2, "".PclZipUtilOptionText($p_options_list[$i])." = '".$v_result_list[$p_options_list[$i]]."'");
1545           $i++;
1546         break;
1547
1548         case PCLZIP_OPT_TEMP_FILE_THRESHOLD :
1549           // ----- Check the number of parameters
1550           if (($i+1) >= $p_size) {
1551             PclZip::privErrorLog(PCLZIP_ERR_MISSING_OPTION_VALUE, "Missing parameter value for option '".PclZipUtilOptionText($p_options_list[$i])."'");
1552             //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
1553             return PclZip::errorCode();
1554           }
1555           
1556           // ----- Check for incompatible options
1557           if (isset($v_result_list[PCLZIP_OPT_TEMP_FILE_OFF])) {
1558             PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Option '".PclZipUtilOptionText($p_options_list[$i])."' can not be used with option 'PCLZIP_OPT_TEMP_FILE_OFF'");
1559             //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
1560             return PclZip::errorCode();
1561           }
1562           
1563           // ----- Check the value
1564           $v_value = $p_options_list[$i+1];
1565           if ((!is_integer($v_value)) || ($v_value<0)) {
1566             PclZip::privErrorLog(PCLZIP_ERR_INVALID_OPTION_VALUE, "Integer expected for option '".PclZipUtilOptionText($p_options_list[$i])."'");
1567             //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
1568             return PclZip::errorCode();
1569           }
1570
1571           // ----- Get the value (and convert it in bytes)
1572           $v_result_list[$p_options_list[$i]] = $v_value*1048576;
1573           //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2, "".PclZipUtilOptionText($p_options_list[$i])." = '".$v_result_list[$p_options_list[$i]]."'");
1574           $i++;
1575         break;
1576
1577         case PCLZIP_OPT_TEMP_FILE_ON :
1578           // ----- Check for incompatible options
1579           if (isset($v_result_list[PCLZIP_OPT_TEMP_FILE_OFF])) {
1580             PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Option '".PclZipUtilOptionText($p_options_list[$i])."' can not be used with option 'PCLZIP_OPT_TEMP_FILE_OFF'");
1581             //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
1582             return PclZip::errorCode();
1583           }
1584           
1585           $v_result_list[$p_options_list[$i]] = true;
1586           //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2, "".PclZipUtilOptionText($p_options_list[$i])." = '".$v_result_list[$p_options_list[$i]]."'");
1587         break;
1588
1589         case PCLZIP_OPT_TEMP_FILE_OFF :
1590           // ----- Check for incompatible options
1591           if (isset($v_result_list[PCLZIP_OPT_TEMP_FILE_ON])) {
1592             PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Option '".PclZipUtilOptionText($p_options_list[$i])."' can not be used with option 'PCLZIP_OPT_TEMP_FILE_ON'");
1593             //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
1594             return PclZip::errorCode();
1595           }
1596           // ----- Check for incompatible options
1597           if (isset($v_result_list[PCLZIP_OPT_TEMP_FILE_THRESHOLD])) {
1598             PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Option '".PclZipUtilOptionText($p_options_list[$i])."' can not be used with option 'PCLZIP_OPT_TEMP_FILE_THRESHOLD'");
1599             //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
1600             return PclZip::errorCode();
1601           }
1602           
1603           $v_result_list[$p_options_list[$i]] = true;
1604           //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2, "".PclZipUtilOptionText($p_options_list[$i])." = '".$v_result_list[$p_options_list[$i]]."'");
1605         break;
1606
1607         case PCLZIP_OPT_EXTRACT_DIR_RESTRICTION :
1608           // ----- Check the number of parameters
1609           if (($i+1) >= $p_size) {
1610             // ----- Error log
1611             PclZip::privErrorLog(PCLZIP_ERR_MISSING_OPTION_VALUE, "Missing parameter value for option '".PclZipUtilOptionText($p_options_list[$i])."'");
1612
1613             // ----- Return
1614             //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
1615             return PclZip::errorCode();
1616           }
1617
1618           // ----- Get the value
1619           if (   is_string($p_options_list[$i+1])
1620               && ($p_options_list[$i+1] != '')) {
1621             $v_result_list[$p_options_list[$i]] = PclZipUtilTranslateWinPath($p_options_list[$i+1], FALSE);
1622             //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2, "".PclZipUtilOptionText($p_options_list[$i])." = '".$v_result_list[$p_options_list[$i]]."'");
1623             $i++;
1624           }
1625           else {
1626             //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2, "".PclZipUtilOptionText($p_options_list[$i])." set with an empty value is ignored.");
1627           }
1628         break;
1629
1630         // ----- Look for options that request an array of string for value
1631         case PCLZIP_OPT_BY_NAME :
1632           // ----- Check the number of parameters
1633           if (($i+1) >= $p_size) {
1634             // ----- Error log
1635             PclZip::privErrorLog(PCLZIP_ERR_MISSING_OPTION_VALUE, "Missing parameter value for option '".PclZipUtilOptionText($p_options_list[$i])."'");
1636
1637             // ----- Return
1638             //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
1639             return PclZip::errorCode();
1640           }
1641
1642           // ----- Get the value
1643           if (is_string($p_options_list[$i+1])) {
1644               $v_result_list[$p_options_list[$i]][0] = $p_options_list[$i+1];
1645           }
1646           else if (is_array($p_options_list[$i+1])) {
1647               $v_result_list[$p_options_list[$i]] = $p_options_list[$i+1];
1648           }
1649           else {
1650             // ----- Error log
1651             PclZip::privErrorLog(PCLZIP_ERR_INVALID_OPTION_VALUE, "Wrong parameter value for option '".PclZipUtilOptionText($p_options_list[$i])."'");
1652
1653             // ----- Return
1654             //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
1655             return PclZip::errorCode();
1656           }
1657           ////--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2, "".PclZipUtilOptionText($p_options_list[$i])." = '".$v_result_list[$p_options_list[$i]]."'");
1658           $i++;
1659         break;
1660
1661         // ----- Look for options that request an EREG or PREG expression
1662         case PCLZIP_OPT_BY_EREG :
1663         case PCLZIP_OPT_BY_PREG :
1664         //case PCLZIP_OPT_CRYPT :
1665           // ----- Check the number of parameters
1666           if (($i+1) >= $p_size) {
1667             // ----- Error log
1668             PclZip::privErrorLog(PCLZIP_ERR_MISSING_OPTION_VALUE, "Missing parameter value for option '".PclZipUtilOptionText($p_options_list[$i])."'");
1669
1670             // ----- Return
1671             //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
1672             return PclZip::errorCode();
1673           }
1674
1675           // ----- Get the value
1676           if (is_string($p_options_list[$i+1])) {
1677               $v_result_list[$p_options_list[$i]] = $p_options_list[$i+1];
1678           }
1679           else {
1680             // ----- Error log
1681             PclZip::privErrorLog(PCLZIP_ERR_INVALID_OPTION_VALUE, "Wrong parameter value for option '".PclZipUtilOptionText($p_options_list[$i])."'");
1682
1683             // ----- Return
1684             //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
1685             return PclZip::errorCode();
1686           }
1687           //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2, "".PclZipUtilOptionText($p_options_list[$i])." = '".$v_result_list[$p_options_list[$i]]."'");
1688           $i++;
1689         break;
1690
1691         // ----- Look for options that takes a string
1692         case PCLZIP_OPT_COMMENT :
1693         case PCLZIP_OPT_ADD_COMMENT :
1694         case PCLZIP_OPT_PREPEND_COMMENT :
1695           // ----- Check the number of parameters
1696           if (($i+1) >= $p_size) {
1697             // ----- Error log
1698             PclZip::privErrorLog(PCLZIP_ERR_MISSING_OPTION_VALUE,
1699                                              "Missing parameter value for option '"
1700                                                                  .PclZipUtilOptionText($p_options_list[$i])
1701                                                                  ."'");
1702
1703             // ----- Return
1704             //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
1705             return PclZip::errorCode();
1706           }
1707
1708           // ----- Get the value
1709           if (is_string($p_options_list[$i+1])) {
1710               $v_result_list[$p_options_list[$i]] = $p_options_list[$i+1];
1711           }
1712           else {
1713             // ----- Error log
1714             PclZip::privErrorLog(PCLZIP_ERR_INVALID_OPTION_VALUE,
1715                                              "Wrong parameter value for option '"
1716                                                                  .PclZipUtilOptionText($p_options_list[$i])
1717                                                                  ."'");
1718
1719             // ----- Return
1720             //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
1721             return PclZip::errorCode();
1722           }
1723           //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2, "".PclZipUtilOptionText($p_options_list[$i])." = '".$v_result_list[$p_options_list[$i]]."'");
1724           $i++;
1725         break;
1726
1727         // ----- Look for options that request an array of index
1728         case PCLZIP_OPT_BY_INDEX :
1729           // ----- Check the number of parameters
1730           if (($i+1) >= $p_size) {
1731             // ----- Error log
1732             PclZip::privErrorLog(PCLZIP_ERR_MISSING_OPTION_VALUE, "Missing parameter value for option '".PclZipUtilOptionText($p_options_list[$i])."'");
1733
1734             // ----- Return
1735             //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
1736             return PclZip::errorCode();
1737           }
1738
1739           // ----- Get the value
1740           $v_work_list = array();
1741           if (is_string($p_options_list[$i+1])) {
1742               //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 4, "Index value is a string '".$p_options_list[$i+1]."'");
1743
1744               // ----- Remove spaces
1745               $p_options_list[$i+1] = strtr($p_options_list[$i+1], ' ', '');
1746
1747               // ----- Parse items
1748               $v_work_list = explode(",", $p_options_list[$i+1]);
1749           }
1750           else if (is_integer($p_options_list[$i+1])) {
1751               //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 4, "Index value is an integer '".$p_options_list[$i+1]."'");
1752               $v_work_list[0] = $p_options_list[$i+1].'-'.$p_options_list[$i+1];
1753           }
1754           else if (is_array($p_options_list[$i+1])) {
1755               //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 4, "Index value is an array");
1756               $v_work_list = $p_options_list[$i+1];
1757           }
1758           else {
1759             // ----- Error log
1760             PclZip::privErrorLog(PCLZIP_ERR_INVALID_OPTION_VALUE, "Value must be integer, string or array for option '".PclZipUtilOptionText($p_options_list[$i])."'");
1761
1762             // ----- Return
1763             //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
1764             return PclZip::errorCode();
1765           }
1766           
1767           // ----- Reduce the index list
1768           // each index item in the list must be a couple with a start and
1769           // an end value : [0,3], [5-5], [8-10], ...
1770           // ----- Check the format of each item
1771           $v_sort_flag=false;
1772           $v_sort_value=0;
1773           for ($j=0; $j<sizeof($v_work_list); $j++) {
1774               // ----- Explode the item
1775               $v_item_list = explode("-", $v_work_list[$j]);
1776               $v_size_item_list = sizeof($v_item_list);
1777               
1778               // ----- TBC : Here we might check that each item is a
1779               // real integer ...
1780               
1781               // ----- Look for single value
1782               if ($v_size_item_list == 1) {
1783                   // ----- Set the option value
1784                   $v_result_list[$p_options_list[$i]][$j]['start'] = $v_item_list[0];
1785                   $v_result_list[$p_options_list[$i]][$j]['end'] = $v_item_list[0];
1786               }
1787               elseif ($v_size_item_list == 2) {
1788                   // ----- Set the option value
1789                   $v_result_list[$p_options_list[$i]][$j]['start'] = $v_item_list[0];
1790                   $v_result_list[$p_options_list[$i]][$j]['end'] = $v_item_list[1];
1791               }
1792               else {
1793                   // ----- Error log
1794                   PclZip::privErrorLog(PCLZIP_ERR_INVALID_OPTION_VALUE, "Too many values in index range for option '".PclZipUtilOptionText($p_options_list[$i])."'");
1795
1796                   // ----- Return
1797                   //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
1798                   return PclZip::errorCode();
1799               }
1800
1801               //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, "Extracted index item = [".$v_result_list[$p_options_list[$i]][$j]['start'].",".$v_result_list[$p_options_list[$i]][$j]['end']."]");
1802
1803               // ----- Look for list sort
1804               if ($v_result_list[$p_options_list[$i]][$j]['start'] < $v_sort_value) {
1805                   //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, "The list should be sorted ...");
1806                   $v_sort_flag=true;
1807
1808                   // ----- TBC : An automatic sort should be writen ...
1809                   // ----- Error log
1810                   PclZip::privErrorLog(PCLZIP_ERR_INVALID_OPTION_VALUE, "Invalid order of index range for option '".PclZipUtilOptionText($p_options_list[$i])."'");
1811
1812                   // ----- Return
1813                   //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
1814                   return PclZip::errorCode();
1815               }
1816               $v_sort_value = $v_result_list[$p_options_list[$i]][$j]['start'];
1817           }
1818           
1819           // ----- Sort the items
1820           if ($v_sort_flag) {
1821               // TBC : To Be Completed
1822               //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, "List sorting is not yet write ...");
1823           }
1824
1825           // ----- Next option
1826           $i++;
1827         break;
1828
1829         // ----- Look for options that request no value
1830         case PCLZIP_OPT_REMOVE_ALL_PATH :
1831         case PCLZIP_OPT_EXTRACT_AS_STRING :
1832         case PCLZIP_OPT_NO_COMPRESSION :
1833         case PCLZIP_OPT_EXTRACT_IN_OUTPUT :
1834         case PCLZIP_OPT_REPLACE_NEWER :
1835         case PCLZIP_OPT_STOP_ON_ERROR :
1836           $v_result_list[$p_options_list[$i]] = true;
1837           //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2, "".PclZipUtilOptionText($p_options_list[$i])." = '".$v_result_list[$p_options_list[$i]]."'");
1838         break;
1839
1840         // ----- Look for options that request an octal value
1841         case PCLZIP_OPT_SET_CHMOD :
1842           // ----- Check the number of parameters
1843           if (($i+1) >= $p_size) {
1844             // ----- Error log
1845             PclZip::privErrorLog(PCLZIP_ERR_MISSING_OPTION_VALUE, "Missing parameter value for option '".PclZipUtilOptionText($p_options_list[$i])."'");
1846
1847             // ----- Return
1848             //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
1849             return PclZip::errorCode();
1850           }
1851
1852           // ----- Get the value
1853           $v_result_list[$p_options_list[$i]] = $p_options_list[$i+1];
1854           //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2, "".PclZipUtilOptionText($p_options_list[$i])." = '".$v_result_list[$p_options_list[$i]]."'");
1855           $i++;
1856         break;
1857
1858         // ----- Look for options that request a call-back
1859         case PCLZIP_CB_PRE_EXTRACT :
1860         case PCLZIP_CB_POST_EXTRACT :
1861         case PCLZIP_CB_PRE_ADD :
1862         case PCLZIP_CB_POST_ADD :
1863         /* for futur use
1864         case PCLZIP_CB_PRE_DELETE :
1865         case PCLZIP_CB_POST_DELETE :
1866         case PCLZIP_CB_PRE_LIST :
1867         case PCLZIP_CB_POST_LIST :
1868         */
1869           // ----- Check the number of parameters
1870           if (($i+1) >= $p_size) {
1871             // ----- Error log
1872             PclZip::privErrorLog(PCLZIP_ERR_MISSING_OPTION_VALUE, "Missing parameter value for option '".PclZipUtilOptionText($p_options_list[$i])."'");
1873
1874             // ----- Return
1875             //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
1876             return PclZip::errorCode();
1877           }
1878
1879           // ----- Get the value
1880           $v_function_name = $p_options_list[$i+1];
1881           //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2, "call-back ".PclZipUtilOptionText($p_options_list[$i])." = '".$v_function_name."'");
1882
1883           // ----- Check that the value is a valid existing function
1884           if (!function_exists($v_function_name)) {
1885             // ----- Error log
1886             PclZip::privErrorLog(PCLZIP_ERR_INVALID_OPTION_VALUE, "Function '".$v_function_name."()' is not an existing function for option '".PclZipUtilOptionText($p_options_list[$i])."'");
1887
1888             // ----- Return
1889             //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
1890             return PclZip::errorCode();
1891           }
1892
1893           // ----- Set the attribute
1894           $v_result_list[$p_options_list[$i]] = $v_function_name;
1895           $i++;
1896         break;
1897
1898         default :
1899           // ----- Error log
1900           PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER,
1901                                        "Unknown parameter '"
1902                                                            .$p_options_list[$i]."'");
1903
1904           // ----- Return
1905           //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
1906           return PclZip::errorCode();
1907       }
1908
1909       // ----- Next options
1910       $i++;
1911     }
1912
1913     // ----- Look for mandatory options
1914     if ($v_requested_options !== false) {
1915       for ($key=reset($v_requested_options); $key=key($v_requested_options); $key=next($v_requested_options)) {
1916         // ----- Look for mandatory option
1917         if ($v_requested_options[$key] == 'mandatory') {
1918           //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 4, "Detect a mandatory option : ".PclZipUtilOptionText($key)."(".$key.")");
1919           // ----- Look if present
1920           if (!isset($v_result_list[$key])) {
1921             // ----- Error log
1922             PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Missing mandatory parameter ".PclZipUtilOptionText($key)."(".$key.")");
1923
1924             // ----- Return
1925             //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
1926             return PclZip::errorCode();
1927           }
1928         }
1929       }
1930     }
1931     
1932     // ----- Look for default values
1933     if (!isset($v_result_list[PCLZIP_OPT_TEMP_FILE_THRESHOLD])) {
1934       //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3,"Calculate auto threshold");
1935       
1936     }
1937
1938     // ----- Return
1939     //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $v_result);
1940     return $v_result;
1941   }
1942   // --------------------------------------------------------------------------------
1943
1944   // --------------------------------------------------------------------------------
1945   // Function : privOptionDefaultThreshold()
1946   // Description :
1947   // Parameters :
1948   // Return Values :
1949   // --------------------------------------------------------------------------------
1950   function privOptionDefaultThreshold(&$p_options)
1951   {
1952     //--(MAGIC-PclTrace)--//PclTraceFctStart(__FILE__, __LINE__, "PclZip::privOptionDefaultThreshold", "");
1953     $v_result=1;
1954     
1955     if (isset($p_options[PCLZIP_OPT_TEMP_FILE_THRESHOLD])
1956         || isset($p_options[PCLZIP_OPT_TEMP_FILE_OFF])) {
1957       //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $v_result);
1958       return $v_result;
1959     }
1960     
1961     //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3,"Create an auto-threshold for use of temporay files");
1962     // ----- Get 'memory_limit' configuration value
1963     $v_memory_limit = ini_get('memory_limit');
1964     $v_memory_limit = trim($v_memory_limit);
1965     $last = strtolower(substr($v_memory_limit, -1));
1966  
1967     if($last == 'g')
1968         //$v_memory_limit = $v_memory_limit*1024*1024*1024;
1969         $v_memory_limit = $v_memory_limit*1073741824;
1970     if($last == 'm')
1971         //$v_memory_limit = $v_memory_limit*1024*1024;
1972         $v_memory_limit = $v_memory_limit*1048576;
1973     if($last == 'k')
1974         $v_memory_limit = $v_memory_limit*1024;
1975             
1976     $p_options[PCLZIP_OPT_TEMP_FILE_THRESHOLD] = floor($v_memory_limit*PCLZIP_TEMPORARY_FILE_RATIO);
1977     
1978     //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3,"Current memory usage : ".memory_get_usage(TRUE)." bytes");
1979     //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3,"Threshold value is : ".$p_options[PCLZIP_OPT_TEMP_FILE_THRESHOLD]." bytes");
1980
1981     // ----- Sanity check : No threshold if value lower than 1M
1982     if ($p_options[PCLZIP_OPT_TEMP_FILE_THRESHOLD] < 1048576) {
1983       //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3,"Unset the threshold (value ".$p_options[PCLZIP_OPT_TEMP_FILE_THRESHOLD].") because under 1Mo sanity check)");
1984       unset($p_options[PCLZIP_OPT_TEMP_FILE_THRESHOLD]);
1985     }
1986           
1987     // ----- Return
1988     //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $v_result);
1989     return $v_result;
1990   }
1991   // --------------------------------------------------------------------------------
1992
1993   // --------------------------------------------------------------------------------
1994   // Function : privFileDescrParseAtt()
1995   // Description :
1996   // Parameters :
1997   // Return Values :
1998   //   1 on success.
1999   //   0 on failure.
2000   // --------------------------------------------------------------------------------
2001   function privFileDescrParseAtt(&$p_file_list, &$p_filedescr, $v_options, $v_requested_options=false)
2002   {
2003     //--(MAGIC-PclTrace)--//PclTraceFctStart(__FILE__, __LINE__, "PclZip::privFileDescrParseAtt", "");
2004     $v_result=1;
2005     
2006     // ----- For each file in the list check the attributes
2007     foreach ($p_file_list as $v_key => $v_value) {
2008     
2009       // ----- Check if the option is supported
2010       if (!isset($v_requested_options[$v_key])) {
2011         // ----- Error log
2012         PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Invalid file attribute '".$v_key."' for this file");
2013
2014         // ----- Return
2015         //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
2016         return PclZip::errorCode();
2017       }
2018
2019       // ----- Look for attribute
2020       switch ($v_key) {
2021         case PCLZIP_ATT_FILE_NAME :
2022           if (!is_string($v_value)) {
2023             PclZip::privErrorLog(PCLZIP_ERR_INVALID_ATTRIBUTE_VALUE, "Invalid type ".gettype($v_value).". String expected for attribute '".PclZipUtilOptionText($v_key)."'");
2024             //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
2025             return PclZip::errorCode();
2026           }
2027
2028           $p_filedescr['filename'] = PclZipUtilPathReduction($v_value);
2029           //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2, "".PclZipUtilOptionText($v_key)." = '".$v_value."'");
2030           
2031           if ($p_filedescr['filename'] == '') {
2032             PclZip::privErrorLog(PCLZIP_ERR_INVALID_ATTRIBUTE_VALUE, "Invalid empty filename for attribute '".PclZipUtilOptionText($v_key)."'");
2033             //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
2034             return PclZip::errorCode();
2035           }
2036
2037         break;
2038
2039         case PCLZIP_ATT_FILE_NEW_SHORT_NAME :
2040           if (!is_string($v_value)) {
2041             PclZip::privErrorLog(PCLZIP_ERR_INVALID_ATTRIBUTE_VALUE, "Invalid type ".gettype($v_value).". String expected for attribute '".PclZipUtilOptionText($v_key)."'");
2042             //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
2043             return PclZip::errorCode();
2044           }
2045
2046           $p_filedescr['new_short_name'] = PclZipUtilPathReduction($v_value);
2047           //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2, "".PclZipUtilOptionText($v_key)." = '".$v_value."'");
2048
2049           if ($p_filedescr['new_short_name'] == '') {
2050             PclZip::privErrorLog(PCLZIP_ERR_INVALID_ATTRIBUTE_VALUE, "Invalid empty short filename for attribute '".PclZipUtilOptionText($v_key)."'");
2051             //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
2052             return PclZip::errorCode();
2053           }
2054         break;
2055
2056         case PCLZIP_ATT_FILE_NEW_FULL_NAME :
2057           if (!is_string($v_value)) {
2058             PclZip::privErrorLog(PCLZIP_ERR_INVALID_ATTRIBUTE_VALUE, "Invalid type ".gettype($v_value).". String expected for attribute '".PclZipUtilOptionText($v_key)."'");
2059             //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
2060             return PclZip::errorCode();
2061           }
2062
2063           $p_filedescr['new_full_name'] = PclZipUtilPathReduction($v_value);
2064           //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2, "".PclZipUtilOptionText($v_key)." = '".$v_value."'");
2065
2066           if ($p_filedescr['new_full_name'] == '') {
2067             PclZip::privErrorLog(PCLZIP_ERR_INVALID_ATTRIBUTE_VALUE, "Invalid empty full filename for attribute '".PclZipUtilOptionText($v_key)."'");
2068             //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
2069             return PclZip::errorCode();
2070           }
2071         break;
2072
2073         // ----- Look for options that takes a string
2074         case PCLZIP_ATT_FILE_COMMENT :
2075           if (!is_string($v_value)) {
2076             PclZip::privErrorLog(PCLZIP_ERR_INVALID_ATTRIBUTE_VALUE, "Invalid type ".gettype($v_value).". String expected for attribute '".PclZipUtilOptionText($v_key)."'");
2077             //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
2078             return PclZip::errorCode();
2079           }
2080
2081           $p_filedescr['comment'] = $v_value;
2082           //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2, "".PclZipUtilOptionText($v_key)." = '".$v_value."'");
2083         break;
2084
2085         case PCLZIP_ATT_FILE_MTIME :
2086           if (!is_integer($v_value)) {
2087             PclZip::privErrorLog(PCLZIP_ERR_INVALID_ATTRIBUTE_VALUE, "Invalid type ".gettype($v_value).". Integer expected for attribute '".PclZipUtilOptionText($v_key)."'");
2088             //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
2089             return PclZip::errorCode();
2090           }
2091
2092           $p_filedescr['mtime'] = $v_value;
2093           //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2, "".PclZipUtilOptionText($v_key)." = '".$v_value."'");
2094         break;
2095
2096         case PCLZIP_ATT_FILE_CONTENT :
2097           $p_filedescr['content'] = $v_value;
2098           ////--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2, "".PclZipUtilOptionText($v_key)." = '".$v_value."'");
2099         break;
2100
2101         default :
2102           // ----- Error log
2103           PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER,
2104                                            "Unknown parameter '".$v_key."'");
2105
2106           // ----- Return
2107           //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
2108           return PclZip::errorCode();
2109       }
2110
2111       // ----- Look for mandatory options
2112       if ($v_requested_options !== false) {
2113         for ($key=reset($v_requested_options); $key=key($v_requested_options); $key=next($v_requested_options)) {
2114           // ----- Look for mandatory option
2115           if ($v_requested_options[$key] == 'mandatory') {
2116             //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 4, "Detect a mandatory option : ".PclZipUtilOptionText($key)."(".$key.")");
2117             // ----- Look if present
2118             if (!isset($p_file_list[$key])) {
2119               PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Missing mandatory parameter ".PclZipUtilOptionText($key)."(".$key.")");
2120               //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
2121               return PclZip::errorCode();
2122             }
2123           }
2124         }
2125       }
2126     
2127     // end foreach
2128     }
2129     
2130     // ----- Return
2131     //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $v_result);
2132     return $v_result;
2133   }
2134   // --------------------------------------------------------------------------------
2135
2136   // --------------------------------------------------------------------------------
2137   // Function : privFileDescrExpand()
2138   // Description :
2139   //   This method look for each item of the list to see if its a file, a folder
2140   //   or a string to be added as file. For any other type of files (link, other)
2141   //   just ignore the item.
2142   //   Then prepare the information that will be stored for that file.
2143   //   When its a folder, expand the folder with all the files that are in that 
2144   //   folder (recursively).
2145   // Parameters :
2146   // Return Values :
2147   //   1 on success.
2148   //   0 on failure.
2149   // --------------------------------------------------------------------------------
2150   function privFileDescrExpand(&$p_filedescr_list, &$p_options)
2151   {
2152     //--(MAGIC-PclTrace)--//PclTraceFctStart(__FILE__, __LINE__, "PclZip::privFileDescrExpand", "");
2153     $v_result=1;
2154     
2155     // ----- Create a result list
2156     $v_result_list = array();
2157     
2158     // ----- Look each entry
2159     for ($i=0; $i<sizeof($p_filedescr_list); $i++) {
2160       //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, "Looking for file ".$i.".");
2161       
2162       // ----- Get filedescr
2163       $v_descr = $p_filedescr_list[$i];
2164       
2165       // ----- Reduce the filename
2166       //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, "Filedescr before reduction :'".$v_descr['filename']."'");
2167       $v_descr['filename'] = PclZipUtilTranslateWinPath($v_descr['filename'], false);
2168       $v_descr['filename'] = PclZipUtilPathReduction($v_descr['filename']);
2169       //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, "Filedescr after reduction :'".$v_descr['filename']."'");
2170       
2171       // ----- Look for real file or folder
2172       if (file_exists($v_descr['filename'])) {
2173         if (@is_file($v_descr['filename'])) {
2174           //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, "This is a file");
2175           $v_descr['type'] = 'file';
2176         }
2177         else if (@is_dir($v_descr['filename'])) {
2178           //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, "This is a folder");
2179           $v_descr['type'] = 'folder';
2180         }
2181         else if (@is_link($v_descr['filename'])) {
2182           //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, "Unsupported file type : link");
2183           // skip
2184           continue;
2185         }
2186         else {
2187           //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, "Unsupported file type : unknown type");
2188           // skip
2189           continue;
2190         }
2191       }
2192       
2193       // ----- Look for string added as file
2194       else if (isset($v_descr['content'])) {
2195         //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, "This is a string added as a file");
2196         $v_descr['type'] = 'virtual_file';
2197       }
2198       
2199       // ----- Missing file
2200       else {
2201         // ----- Error log
2202         //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2, "File '".$v_descr['filename']."' does not exist");
2203         PclZip::privErrorLog(PCLZIP_ERR_MISSING_FILE, "File '".$v_descr['filename']."' does not exist");
2204
2205         // ----- Return
2206         //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
2207         return PclZip::errorCode();
2208       }
2209       
2210       // ----- Calculate the stored filename
2211       $this->privCalculateStoredFilename($v_descr, $p_options);
2212       
2213       // ----- Add the descriptor in result list
2214       $v_result_list[sizeof($v_result_list)] = $v_descr;
2215       
2216       // ----- Look for folder
2217       if ($v_descr['type'] == 'folder') {
2218         // ----- List of items in folder
2219         $v_dirlist_descr = array();
2220         $v_dirlist_nb = 0;
2221         if ($v_folder_handler = @opendir($v_descr['filename'])) {
2222           while (($v_item_handler = @readdir($v_folder_handler)) !== false) {
2223             //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2, "Looking for '".$v_item_handler."' in the directory");
2224
2225             // ----- Skip '.' and '..'
2226             if (($v_item_handler == '.') || ($v_item_handler == '..')) {
2227                 continue;
2228             }
2229             
2230             // ----- Compose the full filename
2231             $v_dirlist_descr[$v_dirlist_nb]['filename'] = $v_descr['filename'].'/'.$v_item_handler;
2232             
2233             // ----- Look for different stored filename
2234             // Because the name of the folder was changed, the name of the
2235             // files/sub-folders also change
2236             if ($v_descr['stored_filename'] != $v_descr['filename']) {
2237               if ($v_descr['stored_filename'] != '') {
2238                 $v_dirlist_descr[$v_dirlist_nb]['new_full_name'] = $v_descr['stored_filename'].'/'.$v_item_handler;
2239               }
2240               else {
2241                 $v_dirlist_descr[$v_dirlist_nb]['new_full_name'] = $v_item_handler;
2242               }
2243             }
2244       
2245             $v_dirlist_nb++;
2246           }
2247           
2248           @closedir($v_folder_handler);
2249         }
2250         else {
2251           //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2, "Unable to open dir '".$v_descr['filename']."' in read mode. Skipped.");
2252           // TBC : unable to open folder in read mode
2253         }
2254         
2255         // ----- Expand each element of the list
2256         if ($v_dirlist_nb != 0) {
2257           // ----- Expand
2258           if (($v_result = $this->privFileDescrExpand($v_dirlist_descr, $p_options)) != 1) {
2259             //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $v_result);
2260             return $v_result;
2261           }
2262           
2263           // ----- Concat the resulting list
2264           //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2, "Merging result list (size '".sizeof($v_result_list)."') with dirlist (size '".sizeof($v_dirlist_descr)."')");
2265           $v_result_list = array_merge($v_result_list, $v_dirlist_descr);
2266           //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2, "merged result list is size '".sizeof($v_result_list)."'");
2267         }
2268         else {
2269           //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2, "Nothing in this folder to expand.");
2270         }
2271           
2272         // ----- Free local array
2273         unset($v_dirlist_descr);
2274       }
2275     }
2276     
2277     // ----- Get the result list
2278     $p_filedescr_list = $v_result_list;
2279
2280     // ----- Return
2281     //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $v_result);
2282     return $v_result;
2283   }
2284   // --------------------------------------------------------------------------------
2285
2286   // --------------------------------------------------------------------------------
2287   // Function : privCreate()
2288   // Description :
2289   // Parameters :
2290   // Return Values :
2291   // --------------------------------------------------------------------------------
2292   function privCreate($p_filedescr_list, &$p_result_list, &$p_options)
2293   {
2294     //--(MAGIC-PclTrace)--//PclTraceFctStart(__FILE__, __LINE__, "PclZip::privCreate", "list");
2295     $v_result=1;
2296     $v_list_detail = array();
2297     
2298     // ----- Magic quotes trick
2299     $this->privDisableMagicQuotes();
2300
2301     // ----- Open the file in write mode
2302     if (($v_result = $this->privOpenFd('wb')) != 1)
2303     {
2304       // ----- Return
2305       //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $v_result);
2306       return $v_result;
2307     }
2308
2309     // ----- Add the list of files
2310     $v_result = $this->privAddList($p_filedescr_list, $p_result_list, $p_options);
2311
2312     // ----- Close
2313     $this->privCloseFd();
2314
2315     // ----- Magic quotes trick
2316     $this->privSwapBackMagicQuotes();
2317
2318     // ----- Return
2319     //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $v_result);
2320     return $v_result;
2321   }
2322   // --------------------------------------------------------------------------------
2323
2324   // --------------------------------------------------------------------------------
2325   // Function : privAdd()
2326   // Description :
2327   // Parameters :
2328   // Return Values :
2329   // --------------------------------------------------------------------------------
2330   function privAdd($p_filedescr_list, &$p_result_list, &$p_options)
2331   {
2332     //--(MAGIC-PclTrace)--//PclTraceFctStart(__FILE__, __LINE__, "PclZip::privAdd", "list");
2333     $v_result=1;
2334     $v_list_detail = array();
2335
2336     // ----- Look if the archive exists or is empty
2337     if ((!is_file($this->zipname)) || (filesize($this->zipname) == 0))
2338     {
2339       //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, "Archive does not exist, or is empty, create it.");
2340
2341       // ----- Do a create
2342       $v_result = $this->privCreate($p_filedescr_list, $p_result_list, $p_options);
2343
2344       // ----- Return
2345       //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $v_result);
2346       return $v_result;
2347     }
2348     // ----- Magic quotes trick
2349     $this->privDisableMagicQuotes();
2350
2351     // ----- Open the zip file
2352     //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, "Open file in binary read mode");
2353     if (($v_result=$this->privOpenFd('rb')) != 1)
2354     {
2355       // ----- Magic quotes trick
2356       $this->privSwapBackMagicQuotes();
2357
2358       // ----- Return
2359       //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $v_result);
2360       return $v_result;
2361     }
2362
2363     // ----- Read the central directory informations
2364     $v_central_dir = array();
2365     if (($v_result = $this->privReadEndCentralDir($v_central_dir)) != 1)
2366     {
2367       $this->privCloseFd();
2368       $this->privSwapBackMagicQuotes();
2369       //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $v_result);
2370       return $v_result;
2371     }
2372
2373     // ----- Go to beginning of File
2374     //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 5, "Position in file : ".ftell($this->zip_fd)."'");
2375     @rewind($this->zip_fd);
2376     //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 5, "Position in file : ".ftell($this->zip_fd)."'");
2377
2378     // ----- Creates a temporay file
2379     $v_zip_temp_name = PCLZIP_TEMPORARY_DIR.uniqid('pclzip-').'.tmp';
2380
2381     // ----- Open the temporary file in write mode
2382     //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, "Open file in binary read mode");
2383     if (($v_zip_temp_fd = @fopen($v_zip_temp_name, 'wb')) == 0)
2384     {
2385       $this->privCloseFd();
2386       $this->privSwapBackMagicQuotes();
2387
2388       PclZip::privErrorLog(PCLZIP_ERR_READ_OPEN_FAIL, 'Unable to open temporary file \''.$v_zip_temp_name.'\' in binary write mode');
2389
2390       // ----- Return
2391       //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
2392       return PclZip::errorCode();
2393     }
2394
2395     // ----- Copy the files from the archive to the temporary file
2396     // TBC : Here I should better append the file and go back to erase the central dir
2397     $v_size = $v_central_dir['offset'];
2398     while ($v_size != 0)
2399     {
2400       $v_read_size = ($v_size < PCLZIP_READ_BLOCK_SIZE ? $v_size : PCLZIP_READ_BLOCK_SIZE);
2401       //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 4, "Read $v_read_size bytes");
2402       $v_buffer = fread($this->zip_fd, $v_read_size);
2403       @fwrite($v_zip_temp_fd, $v_buffer, $v_read_size);
2404       $v_size -= $v_read_size;
2405     }
2406
2407     // ----- Swap the file descriptor
2408     // Here is a trick : I swap the temporary fd with the zip fd, in order to use
2409     // the following methods on the temporary fil and not the real archive
2410     $v_swap = $this->zip_fd;
2411     $this->zip_fd = $v_zip_temp_fd;
2412     $v_zip_temp_fd = $v_swap;
2413
2414     // ----- Add the files
2415     $v_header_list = array();
2416     if (($v_result = $this->privAddFileList($p_filedescr_list, $v_header_list, $p_options)) != 1)
2417     {
2418       fclose($v_zip_temp_fd);
2419       $this->privCloseFd();
2420       @unlink($v_zip_temp_name);
2421       $this->privSwapBackMagicQuotes();
2422
2423       // ----- Return
2424       //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $v_result);
2425       return $v_result;
2426     }
2427
2428     // ----- Store the offset of the central dir
2429     $v_offset = @ftell($this->zip_fd);
2430     //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 4, "New offset of central dir : $v_offset");
2431
2432     // ----- Copy the block of file headers from the old archive
2433     $v_size = $v_central_dir['size'];
2434     while ($v_size != 0)
2435     {
2436       $v_read_size = ($v_size < PCLZIP_READ_BLOCK_SIZE ? $v_size : PCLZIP_READ_BLOCK_SIZE);
2437       //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 4, "Read $v_read_size bytes");
2438       $v_buffer = @fread($v_zip_temp_fd, $v_read_size);
2439       @fwrite($this->zip_fd, $v_buffer, $v_read_size);
2440       $v_size -= $v_read_size;
2441     }
2442
2443     // ----- Create the Central Dir files header
2444     for ($i=0, $v_count=0; $i<sizeof($v_header_list); $i++)
2445     {
2446       // ----- Create the file header
2447       if ($v_header_list[$i]['status'] == 'ok') {
2448         if (($v_result = $this->privWriteCentralFileHeader($v_header_list[$i])) != 1) {
2449           fclose($v_zip_temp_fd);
2450           $this->privCloseFd();
2451           @unlink($v_zip_temp_name);
2452           $this->privSwapBackMagicQuotes();
2453
2454           // ----- Return
2455           //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $v_result);
2456           return $v_result;
2457         }
2458         $v_count++;
2459       }
2460
2461       // ----- Transform the header to a 'usable' info
2462       $this->privConvertHeader2FileInfo($v_header_list[$i], $p_result_list[$i]);
2463     }
2464
2465     // ----- Zip file comment
2466     $v_comment = $v_central_dir['comment'];
2467     if (isset($p_options[PCLZIP_OPT_COMMENT])) {
2468       $v_comment = $p_options[PCLZIP_OPT_COMMENT];
2469     }
2470     if (isset($p_options[PCLZIP_OPT_ADD_COMMENT])) {
2471       $v_comment = $v_comment.$p_options[PCLZIP_OPT_ADD_COMMENT];
2472     }
2473     if (isset($p_options[PCLZIP_OPT_PREPEND_COMMENT])) {
2474       $v_comment = $p_options[PCLZIP_OPT_PREPEND_COMMENT].$v_comment;
2475     }
2476
2477     // ----- Calculate the size of the central header
2478     $v_size = @ftell($this->zip_fd)-$v_offset;
2479
2480     // ----- Create the central dir footer
2481     if (($v_result = $this->privWriteCentralHeader($v_count+$v_central_dir['entries'], $v_size, $v_offset, $v_comment)) != 1)
2482     {
2483       // ----- Reset the file list
2484       unset($v_header_list);
2485       $this->privSwapBackMagicQuotes();
2486
2487       // ----- Return
2488       //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $v_result);
2489       return $v_result;
2490     }
2491
2492     // ----- Swap back the file descriptor
2493     $v_swap = $this->zip_fd;
2494     $this->zip_fd = $v_zip_temp_fd;
2495     $v_zip_temp_fd = $v_swap;
2496
2497     // ----- Close
2498     $this->privCloseFd();
2499
2500     // ----- Close the temporary file
2501     @fclose($v_zip_temp_fd);
2502
2503     // ----- Magic quotes trick
2504     $this->privSwapBackMagicQuotes();
2505
2506     // ----- Delete the zip file
2507     // TBC : I should test the result ...
2508     @unlink($this->zipname);
2509
2510     // ----- Rename the temporary file
2511     // TBC : I should test the result ...
2512     //@rename($v_zip_temp_name, $this->zipname);
2513     PclZipUtilRename($v_zip_temp_name, $this->zipname);
2514
2515     // ----- Return
2516     //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $v_result);
2517     return $v_result;
2518   }
2519   // --------------------------------------------------------------------------------
2520
2521   // --------------------------------------------------------------------------------
2522   // Function : privOpenFd()
2523   // Description :
2524   // Parameters :
2525   // --------------------------------------------------------------------------------
2526   function privOpenFd($p_mode)
2527   {
2528     //--(MAGIC-PclTrace)--//PclTraceFctStart(__FILE__, __LINE__, "PclZip::privOpenFd", 'mode='.$p_mode);
2529     $v_result=1;
2530
2531     // ----- Look if already open
2532     if ($this->zip_fd != 0)
2533     {
2534       // ----- Error log
2535       PclZip::privErrorLog(PCLZIP_ERR_READ_OPEN_FAIL, 'Zip file \''.$this->zipname.'\' already open');
2536
2537       // ----- Return
2538       //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
2539       return PclZip::errorCode();
2540     }
2541
2542     // ----- Open the zip file
2543     //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, 'Open file in '.$p_mode.' mode');
2544     if (($this->zip_fd = @fopen($this->zipname, $p_mode)) == 0)
2545     {
2546       // ----- Error log
2547       PclZip::privErrorLog(PCLZIP_ERR_READ_OPEN_FAIL, 'Unable to open archive \''.$this->zipname.'\' in '.$p_mode.' mode');
2548
2549       // ----- Return
2550       //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
2551       return PclZip::errorCode();
2552     }
2553
2554     // ----- Return
2555     //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $v_result);
2556     return $v_result;
2557   }
2558   // --------------------------------------------------------------------------------
2559
2560   // --------------------------------------------------------------------------------
2561   // Function : privCloseFd()
2562   // Description :
2563   // Parameters :
2564   // --------------------------------------------------------------------------------
2565   function privCloseFd()
2566   {
2567     //--(MAGIC-PclTrace)--//PclTraceFctStart(__FILE__, __LINE__, "PclZip::privCloseFd", "");
2568     $v_result=1;
2569
2570     if ($this->zip_fd != 0)
2571       @fclose($this->zip_fd);
2572     $this->zip_fd = 0;
2573
2574     // ----- Return
2575     //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $v_result);
2576     return $v_result;
2577   }
2578   // --------------------------------------------------------------------------------
2579
2580   // --------------------------------------------------------------------------------
2581   // Function : privAddList()
2582   // Description :
2583   //   $p_add_dir and $p_remove_dir will give the ability to memorize a path which is
2584   //   different from the real path of the file. This is usefull if you want to have PclTar
2585   //   running in any directory, and memorize relative path from an other directory.
2586   // Parameters :
2587   //   $p_list : An array containing the file or directory names to add in the tar
2588   //   $p_result_list : list of added files with their properties (specially the status field)
2589   //   $p_add_dir : Path to add in the filename path archived
2590   //   $p_remove_dir : Path to remove in the filename path archived
2591   // Return Values :
2592   // --------------------------------------------------------------------------------
2593 //  function privAddList($p_list, &$p_result_list, $p_add_dir, $p_remove_dir, $p_remove_all_dir, &$p_options)
2594   function privAddList($p_filedescr_list, &$p_result_list, &$p_options)
2595   {
2596     //--(MAGIC-PclTrace)--//PclTraceFctStart(__FILE__, __LINE__, "PclZip::privAddList", "list");
2597     $v_result=1;
2598
2599     // ----- Add the files
2600     $v_header_list = array();
2601     if (($v_result = $this->privAddFileList($p_filedescr_list, $v_header_list, $p_options)) != 1)
2602     {
2603       // ----- Return
2604       //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $v_result);
2605       return $v_result;
2606     }
2607
2608     // ----- Store the offset of the central dir
2609     $v_offset = @ftell($this->zip_fd);
2610
2611     // ----- Create the Central Dir files header
2612     for ($i=0,$v_count=0; $i<sizeof($v_header_list); $i++)
2613     {
2614       // ----- Create the file header
2615       if ($v_header_list[$i]['status'] == 'ok') {
2616         if (($v_result = $this->privWriteCentralFileHeader($v_header_list[$i])) != 1) {
2617           // ----- Return
2618           //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $v_result);
2619           return $v_result;
2620         }
2621         $v_count++;
2622       }
2623
2624       // ----- Transform the header to a 'usable' info
2625       $this->privConvertHeader2FileInfo($v_header_list[$i], $p_result_list[$i]);
2626     }
2627
2628     // ----- Zip file comment
2629     $v_comment = '';
2630     if (isset($p_options[PCLZIP_OPT_COMMENT])) {
2631       $v_comment = $p_options[PCLZIP_OPT_COMMENT];
2632     }
2633
2634     // ----- Calculate the size of the central header
2635     $v_size = @ftell($this->zip_fd)-$v_offset;
2636
2637     // ----- Create the central dir footer
2638     if (($v_result = $this->privWriteCentralHeader($v_count, $v_size, $v_offset, $v_comment)) != 1)
2639     {
2640       // ----- Reset the file list
2641       unset($v_header_list);
2642
2643       // ----- Return
2644       //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $v_result);
2645       return $v_result;
2646     }
2647
2648     // ----- Return
2649     //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $v_result);
2650     return $v_result;
2651   }
2652   // --------------------------------------------------------------------------------
2653
2654   // --------------------------------------------------------------------------------
2655   // Function : privAddFileList()
2656   // Description :
2657   // Parameters :
2658   //   $p_filedescr_list : An array containing the file description 
2659   //                      or directory names to add in the zip
2660   //   $p_result_list : list of added files with their properties (specially the status field)
2661   // Return Values :
2662   // --------------------------------------------------------------------------------
2663   function privAddFileList($p_filedescr_list, &$p_result_list, &$p_options)
2664   {
2665     //--(MAGIC-PclTrace)--//PclTraceFctStart(__FILE__, __LINE__, "PclZip::privAddFileList", "filedescr_list");
2666     $v_result=1;
2667     $v_header = array();
2668
2669     // ----- Recuperate the current number of elt in list
2670     $v_nb = sizeof($p_result_list);
2671     //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 4, "Before add, list have ".$v_nb." elements");
2672
2673     // ----- Loop on the files
2674     for ($j=0; ($j<sizeof($p_filedescr_list)) && ($v_result==1); $j++) {
2675       // ----- Format the filename
2676       $p_filedescr_list[$j]['filename']
2677       = PclZipUtilTranslateWinPath($p_filedescr_list[$j]['filename'], false);
2678       
2679       //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2, "Looking for file '".$p_filedescr_list[$j]['filename']."'");
2680
2681       // ----- Skip empty file names
2682       // TBC : Can this be possible ? not checked in DescrParseAtt ?
2683       if ($p_filedescr_list[$j]['filename'] == "") {
2684         //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2, "Skip empty filename");
2685         continue;
2686       }
2687
2688       // ----- Check the filename
2689       if (   ($p_filedescr_list[$j]['type'] != 'virtual_file')
2690           && (!file_exists($p_filedescr_list[$j]['filename']))) {
2691         //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2, "File '".$p_filedescr_list[$j]['filename']."' does not exist");
2692         PclZip::privErrorLog(PCLZIP_ERR_MISSING_FILE, "File '".$p_filedescr_list[$j]['filename']."' does not exist");
2693         //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
2694         return PclZip::errorCode();
2695       }
2696
2697       // ----- Look if it is a file or a dir with no all path remove option
2698       // or a dir with all its path removed
2699 //      if (   (is_file($p_filedescr_list[$j]['filename']))
2700 //          || (   is_dir($p_filedescr_list[$j]['filename'])
2701       if (   ($p_filedescr_list[$j]['type'] == 'file')
2702           || ($p_filedescr_list[$j]['type'] == 'virtual_file')
2703           || (   ($p_filedescr_list[$j]['type'] == 'folder')
2704               && (   !isset($p_options[PCLZIP_OPT_REMOVE_ALL_PATH])
2705                   || !$p_options[PCLZIP_OPT_REMOVE_ALL_PATH]))
2706           ) {
2707
2708         // ----- Add the file
2709         $v_result = $this->privAddFile($p_filedescr_list[$j], $v_header,
2710                                        $p_options);
2711         if ($v_result != 1) {
2712           //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $v_result);
2713           return $v_result;
2714         }
2715
2716         // ----- Store the file infos
2717         $p_result_list[$v_nb++] = $v_header;
2718       }
2719     }
2720     //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 4, "After add, list have ".$v_nb." elements");
2721
2722     // ----- Return
2723     //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $v_result);
2724     return $v_result;
2725   }
2726   // --------------------------------------------------------------------------------
2727
2728   // --------------------------------------------------------------------------------
2729   // Function : privAddFile()
2730   // Description :
2731   // Parameters :
2732   // Return Values :
2733   // --------------------------------------------------------------------------------
2734   function privAddFile($p_filedescr, &$p_header, &$p_options)
2735   {
2736     //--(MAGIC-PclTrace)--//PclTraceFctStart(__FILE__, __LINE__, "PclZip::privAddFile", "filename='".$p_filedescr['filename']."'");
2737     $v_result=1;
2738     
2739     // ----- Working variable
2740     $p_filename = $p_filedescr['filename'];
2741
2742     // TBC : Already done in the fileAtt check ... ?
2743     if ($p_filename == "") {
2744       // ----- Error log
2745       PclZip::privErrorLog(PCLZIP_ERR_INVALID_PARAMETER, "Invalid file list parameter (invalid or empty list)");
2746
2747       // ----- Return
2748       //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
2749       return PclZip::errorCode();
2750     }
2751   
2752     // ----- Look for a stored different filename 
2753     /* TBC : Removed
2754     if (isset($p_filedescr['stored_filename'])) {
2755       $v_stored_filename = $p_filedescr['stored_filename'];
2756       //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2, 'Stored filename is NOT the same "'.$v_stored_filename.'"');
2757     }
2758     else {
2759       $v_stored_filename = $p_filedescr['stored_filename'];
2760       //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2, 'Stored filename is the same');
2761     }
2762     */
2763
2764     // ----- Set the file properties
2765     clearstatcache();
2766     $p_header['version'] = 20;
2767     $p_header['version_extracted'] = 10;
2768     $p_header['flag'] = 0;
2769     $p_header['compression'] = 0;
2770     $p_header['crc'] = 0;
2771     $p_header['compressed_size'] = 0;
2772     $p_header['filename_len'] = strlen($p_filename);
2773     $p_header['extra_len'] = 0;
2774     $p_header['disk'] = 0;
2775     $p_header['internal'] = 0;
2776     $p_header['offset'] = 0;
2777     $p_header['filename'] = $p_filename;
2778 // TBC : Removed    $p_header['stored_filename'] = $v_stored_filename;
2779     $p_header['stored_filename'] = $p_filedescr['stored_filename'];
2780     $p_header['extra'] = '';
2781     $p_header['status'] = 'ok';
2782     $p_header['index'] = -1;
2783
2784     // ----- Look for regular file
2785     if ($p_filedescr['type']=='file') {
2786       $p_header['external'] = 0x00000000;
2787       $p_header['size'] = filesize($p_filename);
2788     }
2789     
2790     // ----- Look for regular folder
2791     else if ($p_filedescr['type']=='folder') {
2792       $p_header['external'] = 0x00000010;
2793       $p_header['mtime'] = filemtime($p_filename);
2794       $p_header['size'] = filesize($p_filename);
2795     }
2796     
2797     // ----- Look for virtual file
2798     else if ($p_filedescr['type'] == 'virtual_file') {
2799       $p_header['external'] = 0x00000000;
2800       $p_header['size'] = strlen($p_filedescr['content']);
2801     }
2802     
2803     //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 5, "Header external extension '".sprintf("0x%X",$p_header['external'])."'");
2804
2805     // ----- Look for filetime
2806     if (isset($p_filedescr['mtime'])) {
2807       //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3,"Overload mtime value with :'".$p_filedescr['mtime']."'");
2808       $p_header['mtime'] = $p_filedescr['mtime'];
2809     }
2810     else if ($p_filedescr['type'] == 'virtual_file') {
2811       $p_header['mtime'] = time();
2812       //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, "Virtual file : use current time '".$p_header['mtime']."' for mtime value.");
2813     }
2814     else {
2815       $p_header['mtime'] = filemtime($p_filename);
2816     }
2817
2818     // ------ Look for file comment
2819     if (isset($p_filedescr['comment'])) {
2820       $p_header['comment_len'] = strlen($p_filedescr['comment']);
2821       $p_header['comment'] = $p_filedescr['comment'];
2822     }
2823     else {
2824       $p_header['comment_len'] = 0;
2825       $p_header['comment'] = '';
2826     }
2827
2828     // ----- Look for pre-add callback
2829     if (isset($p_options[PCLZIP_CB_PRE_ADD])) {
2830       //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2, "A pre-callback '".$p_options[PCLZIP_CB_PRE_ADD]."()') is defined for the extraction");
2831
2832       // ----- Generate a local information
2833       $v_local_header = array();
2834       $this->privConvertHeader2FileInfo($p_header, $v_local_header);
2835
2836       // ----- Call the callback
2837       // Here I do not use call_user_func() because I need to send a reference to the
2838       // header.
2839       eval('$v_result = '.$p_options[PCLZIP_CB_PRE_ADD].'(PCLZIP_CB_PRE_ADD, $v_local_header);');
2840       if ($v_result == 0) {
2841         // ----- Change the file status
2842         $p_header['status'] = "skipped";
2843         $v_result = 1;
2844       }
2845
2846       // ----- Update the informations
2847       // Only some fields can be modified
2848       if ($p_header['stored_filename'] != $v_local_header['stored_filename']) {
2849         $p_header['stored_filename'] = PclZipUtilPathReduction($v_local_header['stored_filename']);
2850         //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2, "New stored filename is '".$p_header['stored_filename']."'");
2851       }
2852     }
2853
2854     // ----- Look for empty stored filename
2855     if ($p_header['stored_filename'] == "") {
2856       $p_header['status'] = "filtered";
2857     }
2858     
2859     // ----- Check the path length
2860     if (strlen($p_header['stored_filename']) > 0xFF) {
2861       $p_header['status'] = 'filename_too_long';
2862     }
2863
2864     // ----- Look if no error, or file not skipped
2865     if ($p_header['status'] == 'ok') {
2866
2867       // ----- Look for a file
2868       if ($p_filedescr['type'] == 'file') {
2869         // ----- Look for using temporary file to zip
2870         if ( (!isset($p_options[PCLZIP_OPT_TEMP_FILE_OFF])) 
2871             && (isset($p_options[PCLZIP_OPT_TEMP_FILE_ON])
2872                 || (isset($p_options[PCLZIP_OPT_TEMP_FILE_THRESHOLD])
2873                     && ($p_options[PCLZIP_OPT_TEMP_FILE_THRESHOLD] <= $p_header['size'])) ) ) {
2874           $v_result = $this->privAddFileUsingTempFile($p_filedescr, $p_header, $p_options);
2875           if ($v_result < PCLZIP_ERR_NO_ERROR) {
2876             return $v_result;
2877           }
2878         }
2879         
2880         // ----- Use "in memory" zip algo
2881         else {
2882           //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2,"In memory compression.");      
2883           //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2,"Current memory usage : ".memory_get_usage(TRUE)." bytes");      
2884           //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2,"Current memory peak : ".memory_get_peak_usage(TRUE)." bytes");      
2885           //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2, "'".$p_filename."' is a file");
2886
2887         // ----- Open the source file
2888         if (($v_file = @fopen($p_filename, "rb")) == 0) {
2889           PclZip::privErrorLog(PCLZIP_ERR_READ_OPEN_FAIL, "Unable to open file '$p_filename' in binary read mode");
2890           //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
2891           return PclZip::errorCode();
2892         }
2893
2894         // ----- Read the file content
2895         $v_content = @fread($v_file, $p_header['size']);
2896         //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2,"Memory usage after reading file : ".memory_get_usage(TRUE)." bytes");      
2897         //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2,"Memory peak after reading file : ".memory_get_peak_usage(TRUE)." bytes");      
2898
2899         // ----- Close the file
2900         @fclose($v_file);
2901
2902         // ----- Calculate the CRC
2903         $p_header['crc'] = @crc32($v_content);
2904         
2905         // ----- Look for no compression
2906         if ($p_options[PCLZIP_OPT_NO_COMPRESSION]) {
2907           //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2, "File will not be compressed");
2908           // ----- Set header parameters
2909           $p_header['compressed_size'] = $p_header['size'];
2910           $p_header['compression'] = 0;
2911         }
2912         
2913         // ----- Look for normal compression
2914         else {
2915           //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2, "File will be compressed");
2916           // ----- Compress the content
2917           $v_content = @gzdeflate($v_content);
2918           //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2,"Memory usage after gzdeflate : ".memory_get_usage(TRUE)." bytes");      
2919           //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2,"Memory peak after gzdeflate : ".memory_get_peak_usage(TRUE)." bytes");      
2920
2921           // ----- Set header parameters
2922           $p_header['compressed_size'] = strlen($v_content);
2923           $p_header['compression'] = 8;
2924         }
2925         
2926         // ----- Call the header generation
2927         if (($v_result = $this->privWriteFileHeader($p_header)) != 1) {
2928           @fclose($v_file);
2929           //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $v_result);
2930           return $v_result;
2931         }
2932
2933         // ----- Write the compressed (or not) content
2934         @fwrite($this->zip_fd, $v_content, $p_header['compressed_size']);
2935
2936         }
2937
2938       }
2939
2940       // ----- Look for a virtual file (a file from string)
2941       else if ($p_filedescr['type'] == 'virtual_file') {
2942           
2943         //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2, "Add by string");
2944         $v_content = $p_filedescr['content'];
2945
2946         // ----- Calculate the CRC
2947         $p_header['crc'] = @crc32($v_content);
2948         
2949         // ----- Look for no compression
2950         if ($p_options[PCLZIP_OPT_NO_COMPRESSION]) {
2951           //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2, "File will not be compressed");
2952           // ----- Set header parameters
2953           $p_header['compressed_size'] = $p_header['size'];
2954           $p_header['compression'] = 0;
2955         }
2956         
2957         // ----- Look for normal compression
2958         else {
2959           //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2, "File will be compressed");
2960           // ----- Compress the content
2961           $v_content = @gzdeflate($v_content);
2962
2963           // ----- Set header parameters
2964           $p_header['compressed_size'] = strlen($v_content);
2965           $p_header['compression'] = 8;
2966         }
2967         
2968         // ----- Call the header generation
2969         if (($v_result = $this->privWriteFileHeader($p_header)) != 1) {
2970           @fclose($v_file);
2971           //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $v_result);
2972           return $v_result;
2973         }
2974
2975         // ----- Write the compressed (or not) content
2976         @fwrite($this->zip_fd, $v_content, $p_header['compressed_size']);
2977       }
2978
2979       // ----- Look for a directory
2980       else if ($p_filedescr['type'] == 'folder') {
2981         //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2, "'".$p_filename."' is a folder");
2982         // ----- Look for directory last '/'
2983         if (@substr($p_header['stored_filename'], -1) != '/') {
2984           $p_header['stored_filename'] .= '/';
2985         }
2986
2987         // ----- Set the file properties
2988         $p_header['size'] = 0;
2989         //$p_header['external'] = 0x41FF0010;   // Value for a folder : to be checked
2990         $p_header['external'] = 0x00000010;   // Value for a folder : to be checked
2991
2992         // ----- Call the header generation
2993         if (($v_result = $this->privWriteFileHeader($p_header)) != 1)
2994         {
2995           //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $v_result);
2996           return $v_result;
2997         }
2998       }
2999     }
3000
3001     // ----- Look for post-add callback
3002     if (isset($p_options[PCLZIP_CB_POST_ADD])) {
3003       //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2, "A post-callback '".$p_options[PCLZIP_CB_POST_ADD]."()') is defined for the extraction");
3004
3005       // ----- Generate a local information
3006       $v_local_header = array();
3007       $this->privConvertHeader2FileInfo($p_header, $v_local_header);
3008
3009       // ----- Call the callback
3010       // Here I do not use call_user_func() because I need to send a reference to the
3011       // header.
3012       eval('$v_result = '.$p_options[PCLZIP_CB_POST_ADD].'(PCLZIP_CB_POST_ADD, $v_local_header);');
3013       if ($v_result == 0) {
3014         // ----- Ignored
3015         $v_result = 1;
3016       }
3017
3018       // ----- Update the informations
3019       // Nothing can be modified
3020     }
3021
3022     // ----- Return
3023     //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $v_result);
3024     return $v_result;
3025   }
3026   // --------------------------------------------------------------------------------
3027
3028   // --------------------------------------------------------------------------------
3029   // Function : privAddFileUsingTempFile()
3030   // Description :
3031   // Parameters :
3032   // Return Values :
3033   // --------------------------------------------------------------------------------
3034   function privAddFileUsingTempFile($p_filedescr, &$p_header, &$p_options)
3035   {
3036     //--(MAGIC-PclTrace)--//PclTraceFctStart(__FILE__, __LINE__, "PclZip::privAddFileUsingTempFile", "filename='".$p_filedescr['filename']."'");
3037     $v_result=PCLZIP_ERR_NO_ERROR;
3038     
3039     // ----- Working variable
3040     $p_filename = $p_filedescr['filename'];
3041
3042     //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2, "'".$p_filename."' is a file");
3043
3044     // ----- Open the source file
3045     if (($v_file = @fopen($p_filename, "rb")) == 0) {
3046       PclZip::privErrorLog(PCLZIP_ERR_READ_OPEN_FAIL, "Unable to open file '$p_filename' in binary read mode");
3047       //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
3048       return PclZip::errorCode();
3049     }
3050
3051     // ----- Creates a compressed temporary file
3052     $v_gzip_temp_name = PCLZIP_TEMPORARY_DIR.uniqid('pclzip-').'.gz';
3053     if (($v_file_compressed = @gzopen($v_gzip_temp_name, "wb")) == 0) {
3054       fclose($v_file);
3055       PclZip::privErrorLog(PCLZIP_ERR_WRITE_OPEN_FAIL, 'Unable to open temporary file \''.$v_gzip_temp_name.'\' in binary write mode');
3056       //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
3057       return PclZip::errorCode();
3058     }
3059
3060     // ----- Read the file by PCLZIP_READ_BLOCK_SIZE octets blocks
3061     $v_size = filesize($p_filename);
3062     while ($v_size != 0) {
3063       $v_read_size = ($v_size < PCLZIP_READ_BLOCK_SIZE ? $v_size : PCLZIP_READ_BLOCK_SIZE);
3064       //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 4, "Read ".$v_read_size." bytes");
3065       $v_buffer = @fread($v_file, $v_read_size);
3066       //$v_binary_data = pack('a'.$v_read_size, $v_buffer);
3067       @gzputs($v_file_compressed, $v_buffer, $v_read_size);
3068       $v_size -= $v_read_size;
3069     }
3070
3071     // ----- Close the file
3072     @fclose($v_file);
3073     @gzclose($v_file_compressed);
3074
3075     // ----- Check the minimum file size
3076     //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 4, "gzip file size ".filesize($v_gzip_temp_name));
3077     if (filesize($v_gzip_temp_name) < 18) {
3078       PclZip::privErrorLog(PCLZIP_ERR_BAD_FORMAT, 'gzip temporary file \''.$v_gzip_temp_name.'\' has invalid filesize - should be minimum 18 bytes');
3079       //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
3080       return PclZip::errorCode();
3081     }
3082
3083     // ----- Extract the compressed attributes
3084     if (($v_file_compressed = @fopen($v_gzip_temp_name, "rb")) == 0) {
3085       PclZip::privErrorLog(PCLZIP_ERR_READ_OPEN_FAIL, 'Unable to open temporary file \''.$v_gzip_temp_name.'\' in binary read mode');
3086       //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
3087       return PclZip::errorCode();
3088     }
3089
3090     // ----- Read the gzip file header
3091     $v_binary_data = @fread($v_file_compressed, 10);
3092     $v_data_header = unpack('a1id1/a1id2/a1cm/a1flag/Vmtime/a1xfl/a1os', $v_binary_data);
3093
3094     // ----- Check some parameters
3095     //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 4, '$v_data_header[id1]='.bin2hex($v_data_header['id1']));
3096     //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 4, '$v_data_header[id2]='.bin2hex($v_data_header['id2']));
3097     //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 4, '$v_data_header[cm]='.bin2hex($v_data_header['cm']));
3098     //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 4, '$v_data_header[flag]='.bin2hex($v_data_header['flag']));
3099     //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 4, '$v_data_header[mtime]='.$v_data_header['mtime']);
3100     //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 4, '$v_data_header[xfl]='.bin2hex($v_data_header['xfl']));
3101     //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 4, '$v_data_header[os]='.bin2hex($v_data_header['os']));
3102     $v_data_header['os'] = bin2hex($v_data_header['os']);
3103
3104     // ----- Read the gzip file footer
3105     //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 4, "File position after header ".ftell($v_file_compressed));
3106     @fseek($v_file_compressed, filesize($v_gzip_temp_name)-8);
3107     //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 4, "File position at beginning of footer ".ftell($v_file_compressed));
3108     $v_binary_data = @fread($v_file_compressed, 8);
3109     //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 4, "File position after footer ".ftell($v_file_compressed));
3110     $v_data_footer = unpack('Vcrc/Vcompressed_size', $v_binary_data);
3111
3112     // ----- Set the attributes
3113     $p_header['compression'] = ord($v_data_header['cm']);
3114     //$p_header['mtime'] = $v_data_header['mtime'];
3115     $p_header['crc'] = $v_data_footer['crc'];
3116     //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 4, "Compressed size ".(filesize($v_gzip_temp_name)-18));
3117     $p_header['compressed_size'] = filesize($v_gzip_temp_name)-18;
3118
3119     // ----- Close the file
3120     @fclose($v_file_compressed);
3121
3122     // ----- Call the header generation
3123     if (($v_result = $this->privWriteFileHeader($p_header)) != 1) {
3124       //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $v_result);
3125       return $v_result;
3126     }
3127
3128     // ----- Add the compressed data
3129     if (($v_file_compressed = @fopen($v_gzip_temp_name, "rb")) == 0)
3130     {
3131       PclZip::privErrorLog(PCLZIP_ERR_READ_OPEN_FAIL, 'Unable to open temporary file \''.$v_gzip_temp_name.'\' in binary read mode');
3132       //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
3133       return PclZip::errorCode();
3134     }
3135
3136     // ----- Read the file by PCLZIP_READ_BLOCK_SIZE octets blocks
3137     fseek($v_file_compressed, 10);
3138     //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 4, "File position before reading compressed data ".ftell($v_file_compressed));
3139     //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 4, ' '.$p_header['compressed_size'].' bytes to read');
3140     $v_size = $p_header['compressed_size'];
3141     while ($v_size != 0)
3142     {
3143       $v_read_size = ($v_size < PCLZIP_READ_BLOCK_SIZE ? $v_size : PCLZIP_READ_BLOCK_SIZE);
3144       //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 4, "Read ".$v_read_size." bytes");
3145       $v_buffer = @fread($v_file_compressed, $v_read_size);
3146       //$v_binary_data = pack('a'.$v_read_size, $v_buffer);
3147       @fwrite($this->zip_fd, $v_buffer, $v_read_size);
3148       $v_size -= $v_read_size;
3149     }
3150
3151     // ----- Close the file
3152     @fclose($v_file_compressed);
3153
3154     // ----- Unlink the temporary file
3155     @unlink($v_gzip_temp_name);
3156     
3157     // ----- Return
3158     //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $v_result);
3159     return $v_result;
3160   }
3161   // --------------------------------------------------------------------------------
3162
3163   // --------------------------------------------------------------------------------
3164   // Function : privCalculateStoredFilename()
3165   // Description :
3166   //   Based on file descriptor properties and global options, this method
3167   //   calculate the filename that will be stored in the archive.
3168   // Parameters :
3169   // Return Values :
3170   // --------------------------------------------------------------------------------
3171   function privCalculateStoredFilename(&$p_filedescr, &$p_options)
3172   {
3173     //--(MAGIC-PclTrace)--//PclTraceFctStart(__FILE__, __LINE__, "PclZip::privCalculateStoredFilename", "filename='".$p_filedescr['filename']."'");
3174     $v_result=1;
3175     
3176     // ----- Working variables
3177     $p_filename = $p_filedescr['filename'];
3178     if (isset($p_options[PCLZIP_OPT_ADD_PATH])) {
3179       $p_add_dir = $p_options[PCLZIP_OPT_ADD_PATH];
3180     }
3181     else {
3182       $p_add_dir = '';
3183     }
3184     if (isset($p_options[PCLZIP_OPT_REMOVE_PATH])) {
3185       $p_remove_dir = $p_options[PCLZIP_OPT_REMOVE_PATH];
3186     }
3187     else {
3188       $p_remove_dir = '';
3189     }
3190     //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, "Remove path ='".$p_remove_dir."'");
3191     if (isset($p_options[PCLZIP_OPT_REMOVE_ALL_PATH])) {
3192       $p_remove_all_dir = $p_options[PCLZIP_OPT_REMOVE_ALL_PATH];
3193     }
3194     else {
3195       $p_remove_all_dir = 0;
3196     }
3197
3198     // ----- Look for full name change
3199     if (isset($p_filedescr['new_full_name'])) {
3200       // ----- Remove drive letter if any
3201       $v_stored_filename = PclZipUtilTranslateWinPath($p_filedescr['new_full_name']);
3202       //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 4, "Changing full name of '".$p_filename."' for '".$v_stored_filename."'");
3203     }
3204     
3205     // ----- Look for path and/or short name change
3206     else {
3207
3208       // ----- Look for short name change
3209       // Its when we cahnge just the filename but not the path
3210       if (isset($p_filedescr['new_short_name'])) {
3211         $v_path_info = pathinfo($p_filename);
3212         $v_dir = '';
3213         if ($v_path_info['dirname'] != '') {
3214           $v_dir = $v_path_info['dirname'].'/';
3215         }
3216         $v_stored_filename = $v_dir.$p_filedescr['new_short_name'];
3217         //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 4, "Changing short name of '".$p_filename."' for '".$v_stored_filename."'");
3218       }
3219       else {
3220         // ----- Calculate the stored filename
3221         $v_stored_filename = $p_filename;
3222       }
3223
3224       // ----- Look for all path to remove
3225       if ($p_remove_all_dir) {
3226         $v_stored_filename = basename($p_filename);
3227         //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 4, "Remove all path selected change '".$p_filename."' for '".$v_stored_filename."'");
3228       }
3229       // ----- Look for partial path remove
3230       else if ($p_remove_dir != "") {
3231         //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, "Partial path to remove");
3232         if (substr($p_remove_dir, -1) != '/')
3233           $p_remove_dir .= "/";
3234
3235         if (   (substr($p_filename, 0, 2) == "./")
3236             || (substr($p_remove_dir, 0, 2) == "./")) {
3237             
3238           if (   (substr($p_filename, 0, 2) == "./")
3239               && (substr($p_remove_dir, 0, 2) != "./")) {
3240             $p_remove_dir = "./".$p_remove_dir;
3241           }
3242           if (   (substr($p_filename, 0, 2) != "./")
3243               && (substr($p_remove_dir, 0, 2) == "./")) {
3244             $p_remove_dir = substr($p_remove_dir, 2);
3245           }
3246         }
3247
3248         $v_compare = PclZipUtilPathInclusion($p_remove_dir,
3249                                              $v_stored_filename);
3250         if ($v_compare > 0) {
3251           if ($v_compare == 2) {
3252             $v_stored_filename = "";
3253             //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 4, "Path to remove is the current folder");
3254           }
3255           else {
3256             //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 4, "Remove path '$p_remove_dir' in file '$v_stored_filename'");
3257             $v_stored_filename = substr($v_stored_filename,
3258                                         strlen($p_remove_dir));
3259             //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 4, "Result is '$v_stored_filename'");
3260           }
3261         }
3262       }
3263       
3264       // ----- Remove drive letter if any
3265       $v_stored_filename = PclZipUtilTranslateWinPath($v_stored_filename);
3266       
3267       // ----- Look for path to add
3268       if ($p_add_dir != "") {
3269         if (substr($p_add_dir, -1) == "/")
3270           $v_stored_filename = $p_add_dir.$v_stored_filename;
3271         else
3272           $v_stored_filename = $p_add_dir."/".$v_stored_filename;
3273         //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, "Add path '$p_add_dir' in file '$p_filename' = '$v_stored_filename'");
3274       }
3275     }
3276
3277     // ----- Filename (reduce the path of stored name)
3278     $v_stored_filename = PclZipUtilPathReduction($v_stored_filename);
3279     $p_filedescr['stored_filename'] = $v_stored_filename;
3280     //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2, "Stored filename will be '".$p_filedescr['stored_filename']."', strlen ".strlen($p_filedescr['stored_filename']));
3281     
3282     // ----- Return
3283     //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $v_result);
3284     return $v_result;
3285   }
3286   // --------------------------------------------------------------------------------
3287
3288   // --------------------------------------------------------------------------------
3289   // Function : privWriteFileHeader()
3290   // Description :
3291   // Parameters :
3292   // Return Values :
3293   // --------------------------------------------------------------------------------
3294   function privWriteFileHeader(&$p_header)
3295   {
3296     //--(MAGIC-PclTrace)--//PclTraceFctStart(__FILE__, __LINE__, "PclZip::privWriteFileHeader", 'file="'.$p_header['filename'].'", stored as "'.$p_header['stored_filename'].'"');
3297     $v_result=1;
3298
3299     // ----- Store the offset position of the file
3300     $p_header['offset'] = ftell($this->zip_fd);
3301     //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 2, 'File offset of the header :'.$p_header['offset']);
3302
3303     // ----- Transform UNIX mtime to DOS format mdate/mtime
3304     //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, 'Date : \''.date("d/m/y H:i:s", $p_header['mtime']).'\'');
3305     $v_date = getdate($p_header['mtime']);
3306     $v_mtime = ($v_date['hours']<<11) + ($v_date['minutes']<<5) + $v_date['seconds']/2;
3307     $v_mdate = (($v_date['year']-1980)<<9) + ($v_date['mon']<<5) + $v_date['mday'];
3308
3309     // ----- Packed data
3310     $v_binary_data = pack("VvvvvvVVVvv", 0x04034b50,
3311                               $p_header['version_extracted'], $p_header['flag'],
3312                           $p_header['compression'], $v_mtime, $v_mdate,
3313                           $p_header['crc'], $p_header['compressed_size'],
3314                                                   $p_header['size'],
3315                           strlen($p_header['stored_filename']),
3316                                                   $p_header['extra_len']);
3317
3318     // ----- Write the first 148 bytes of the header in the archive
3319     fputs($this->zip_fd, $v_binary_data, 30);
3320
3321     // ----- Write the variable fields
3322     if (strlen($p_header['stored_filename']) != 0)
3323     {
3324       fputs($this->zip_fd, $p_header['stored_filename'], strlen($p_header['stored_filename']));
3325     }
3326     if ($p_header['extra_len'] != 0)
3327     {
3328       fputs($this->zip_fd, $p_header['extra'], $p_header['extra_len']);
3329     }
3330
3331     // ----- Return
3332     //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $v_result);
3333     return $v_result;
3334   }
3335   // --------------------------------------------------------------------------------
3336
3337   // --------------------------------------------------------------------------------
3338   // Function : privWriteCentralFileHeader()
3339   // Description :
3340   // Parameters :
3341   // Return Values :
3342   // --------------------------------------------------------------------------------
3343   function privWriteCentralFileHeader(&$p_header)
3344   {
3345     //--(MAGIC-PclTrace)--//PclTraceFctStart(__FILE__, __LINE__, "PclZip::privWriteCentralFileHeader", 'file="'.$p_header['filename'].'", stored as "'.$p_header['stored_filename'].'"');
3346     $v_result=1;
3347
3348     // TBC
3349     //for(reset($p_header); $key = key($p_header); next($p_header)) {
3350     //  //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, "header[$key] = ".$p_header[$key]);
3351     //}
3352
3353     // ----- Transform UNIX mtime to DOS format mdate/mtime
3354     //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, 'Date : \''.date("d/m/y H:i:s", $p_header['mtime']).'\'');
3355     $v_date = getdate($p_header['mtime']);
3356     $v_mtime = ($v_date['hours']<<11) + ($v_date['minutes']<<5) + $v_date['seconds']/2;
3357     $v_mdate = (($v_date['year']-1980)<<9) + ($v_date['mon']<<5) + $v_date['mday'];
3358
3359     //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, 'Comment size : \''.$p_header['comment_len'].'\'');
3360
3361     // ----- Packed data
3362     $v_binary_data = pack("VvvvvvvVVVvvvvvVV", 0x02014b50,
3363                               $p_header['version'], $p_header['version_extracted'],
3364                           $p_header['flag'], $p_header['compression'],
3365                                                   $v_mtime, $v_mdate, $p_header['crc'],
3366                           $p_header['compressed_size'], $p_header['size'],
3367                           strlen($p_header['stored_filename']),
3368                                                   $p_header['extra_len'], $p_header['comment_len'],
3369                           $p_header['disk'], $p_header['internal'],
3370                                                   $p_header['external'], $p_header['offset']);
3371
3372     // ----- Write the 42 bytes of the header in the zip file
3373     fputs($this->zip_fd, $v_binary_data, 46);
3374
3375     // ----- Write the variable fields
3376     if (strlen($p_header['stored_filename']) != 0)
3377     {
3378       fputs($this->zip_fd, $p_header['stored_filename'], strlen($p_header['stored_filename']));
3379     }
3380     if ($p_header['extra_len'] != 0)
3381     {
3382       fputs($this->zip_fd, $p_header['extra'], $p_header['extra_len']);
3383     }
3384     if ($p_header['comment_len'] != 0)
3385     {
3386       fputs($this->zip_fd, $p_header['comment'], $p_header['comment_len']);
3387     }
3388
3389     // ----- Return
3390     //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $v_result);
3391     return $v_result;
3392   }
3393   // --------------------------------------------------------------------------------
3394
3395   // --------------------------------------------------------------------------------
3396   // Function : privWriteCentralHeader()
3397   // Description :
3398   // Parameters :
3399   // Return Values :
3400   // --------------------------------------------------------------------------------
3401   function privWriteCentralHeader($p_nb_entries, $p_size, $p_offset, $p_comment)
3402   {
3403     //--(MAGIC-PclTrace)--//PclTraceFctStart(__FILE__, __LINE__, "PclZip::privWriteCentralHeader", 'nb_entries='.$p_nb_entries.', size='.$p_size.', offset='.$p_offset.', comment="'.$p_comment.'"');
3404     $v_result=1;
3405
3406     // ----- Packed data
3407     $v_binary_data = pack("VvvvvVVv", 0x06054b50, 0, 0, $p_nb_entries,
3408                               $p_nb_entries, $p_size,
3409                                                   $p_offset, strlen($p_comment));
3410
3411     // ----- Write the 22 bytes of the header in the zip file
3412     fputs($this->zip_fd, $v_binary_data, 22);
3413
3414     // ----- Write the variable fields
3415     if (strlen($p_comment) != 0)
3416     {
3417       fputs($this->zip_fd, $p_comment, strlen($p_comment));
3418     }
3419
3420     // ----- Return
3421     //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $v_result);
3422     return $v_result;
3423   }
3424   // --------------------------------------------------------------------------------
3425
3426   // --------------------------------------------------------------------------------
3427   // Function : privList()
3428   // Description :
3429   // Parameters :
3430   // Return Values :
3431   // --------------------------------------------------------------------------------
3432   function privList(&$p_list)
3433   {
3434     //--(MAGIC-PclTrace)--//PclTraceFctStart(__FILE__, __LINE__, "PclZip::privList", "list");
3435     $v_result=1;
3436
3437     // ----- Magic quotes trick
3438     $this->privDisableMagicQuotes();
3439
3440     // ----- Open the zip file
3441     //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, "Open file in binary read mode");
3442     if (($this->zip_fd = @fopen($this->zipname, 'rb')) == 0)
3443     {
3444       // ----- Magic quotes trick
3445       $this->privSwapBackMagicQuotes();
3446       
3447       // ----- Error log
3448       PclZip::privErrorLog(PCLZIP_ERR_READ_OPEN_FAIL, 'Unable to open archive \''.$this->zipname.'\' in binary read mode');
3449
3450       // ----- Return
3451       //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
3452       return PclZip::errorCode();
3453     }
3454
3455     // ----- Read the central directory informations
3456     $v_central_dir = array();
3457     if (($v_result = $this->privReadEndCentralDir($v_central_dir)) != 1)
3458     {
3459       $this->privSwapBackMagicQuotes();
3460       //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $v_result);
3461       return $v_result;
3462     }
3463
3464     // ----- Go to beginning of Central Dir
3465     //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, "Offset : ".$v_central_dir['offset']."'");
3466     //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, "Position in file : ".ftell($this->zip_fd)."'");
3467     @rewind($this->zip_fd);
3468     //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, "Position in file : ".ftell($this->zip_fd)."'");
3469     if (@fseek($this->zip_fd, $v_central_dir['offset']))
3470     {
3471       $this->privSwapBackMagicQuotes();
3472
3473       // ----- Error log
3474       PclZip::privErrorLog(PCLZIP_ERR_INVALID_ARCHIVE_ZIP, 'Invalid archive size');
3475
3476       // ----- Return
3477       //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
3478       return PclZip::errorCode();
3479     }
3480     //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, "Position in file : ".ftell($this->zip_fd)."'");
3481
3482     // ----- Read each entry
3483     for ($i=0; $i<$v_central_dir['entries']; $i++)
3484     {
3485       // ----- Read the file header
3486       if (($v_result = $this->privReadCentralFileHeader($v_header)) != 1)
3487       {
3488         $this->privSwapBackMagicQuotes();
3489         //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $v_result);
3490         return $v_result;
3491       }
3492       $v_header['index'] = $i;
3493
3494       // ----- Get the only interesting attributes
3495       $this->privConvertHeader2FileInfo($v_header, $p_list[$i]);
3496       unset($v_header);
3497     }
3498
3499     // ----- Close the zip file
3500     $this->privCloseFd();
3501
3502     // ----- Magic quotes trick
3503     $this->privSwapBackMagicQuotes();
3504
3505     // ----- Return
3506     //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $v_result);
3507     return $v_result;
3508   }
3509   // --------------------------------------------------------------------------------
3510
3511   // --------------------------------------------------------------------------------
3512   // Function : privConvertHeader2FileInfo()
3513   // Description :
3514   //   This function takes the file informations from the central directory
3515   //   entries and extract the interesting parameters that will be given back.
3516   //   The resulting file infos are set in the array $p_info
3517   //     $p_info['filename'] : Filename with full path. Given by user (add),
3518   //                           extracted in the filesystem (extract).
3519   //     $p_info['stored_filename'] : Stored filename in the archive.
3520   //     $p_info['size'] = Size of the file.
3521   //     $p_info['compressed_size'] = Compressed size of the file.
3522   //     $p_info['mtime'] = Last modification date of the file.
3523   //     $p_info['comment'] = Comment associated with the file.
3524   //     $p_info['folder'] = true/false : indicates if the entry is a folder or not.
3525   //     $p_info['status'] = status of the action on the file.
3526   //     $p_info['crc'] = CRC of the file content.
3527   // Parameters :
3528   // Return Values :
3529   // --------------------------------------------------------------------------------
3530   function privConvertHeader2FileInfo($p_header, &$p_info)
3531   {
3532     //--(MAGIC-PclTrace)--//PclTraceFctStart(__FILE__, __LINE__, "PclZip::privConvertHeader2FileInfo", "Filename='".$p_header['filename']."'");
3533     $v_result=1;
3534
3535     // ----- Get the interesting attributes
3536     $v_temp_path = PclZipUtilPathReduction($p_header['filename']);
3537     $p_info['filename'] = $v_temp_path;
3538     $v_temp_path = PclZipUtilPathReduction($p_header['stored_filename']);
3539     $p_info['stored_filename'] = $v_temp_path;
3540     $p_info['size'] = $p_header['size'];
3541     $p_info['compressed_size'] = $p_header['compressed_size'];
3542     $p_info['mtime'] = $p_header['mtime'];
3543     $p_info['comment'] = $p_header['comment'];
3544     $p_info['folder'] = (($p_header['external']&0x00000010)==0x00000010);
3545     $p_info['index'] = $p_header['index'];
3546     $p_info['status'] = $p_header['status'];
3547     $p_info['crc'] = $p_header['crc'];
3548
3549     // ----- Return
3550     //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $v_result);
3551     return $v_result;
3552   }
3553   // --------------------------------------------------------------------------------
3554
3555   // --------------------------------------------------------------------------------
3556   // Function : privExtractByRule()
3557   // Description :
3558   //   Extract a file or directory depending of rules (by index, by name, ...)
3559   // Parameters :
3560   //   $p_file_list : An array where will be placed the properties of each
3561   //                  extracted file
3562   //   $p_path : Path to add while writing the extracted files
3563   //   $p_remove_path : Path to remove (from the file memorized path) while writing the
3564   //                    extracted files. If the path does not match the file path,
3565   //                    the file is extracted with its memorized path.
3566   //                    $p_remove_path does not apply to 'list' mode.
3567   //                    $p_path and $p_remove_path are commulative.
3568   // Return Values :
3569   //   1 on success,0 or less on error (see error code list)
3570   // --------------------------------------------------------------------------------
3571   function privExtractByRule(&$p_file_list, $p_path, $p_remove_path, $p_remove_all_path, &$p_options)
3572   {
3573     //--(MAGIC-PclTrace)--//PclTraceFctStart(__FILE__, __LINE__, "PclZip::privExtractByRule", "path='$p_path', remove_path='$p_remove_path', remove_all_path='".($p_remove_all_path?'true':'false')."'");
3574     $v_result=1;
3575
3576     // ----- Magic quotes trick
3577     $this->privDisableMagicQuotes();
3578
3579     // ----- Check the path
3580     if (   ($p_path == "")
3581             || (   (substr($p_path, 0, 1) != "/")
3582                     && (substr($p_path, 0, 3) != "../")
3583                         && (substr($p_path,1,2)!=":/")))
3584       $p_path = "./".$p_path;
3585
3586     // ----- Reduce the path last (and duplicated) '/'
3587     if (($p_path != "./") && ($p_path != "/"))
3588     {
3589       // ----- Look for the path end '/'
3590       while (substr($p_path, -1) == "/")
3591       {
3592         //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, "Destination path [$p_path] ends by '/'");
3593         $p_path = substr($p_path, 0, strlen($p_path)-1);
3594         //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, "Modified to [$p_path]");
3595       }
3596     }
3597
3598     // ----- Look for path to remove format (should end by /)
3599     if (($p_remove_path != "") && (substr($p_remove_path, -1) != '/'))
3600     {
3601       $p_remove_path .= '/';
3602     }
3603     $p_remove_path_size = strlen($p_remove_path);
3604
3605     // ----- Open the zip file
3606     //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, "Open file in binary read mode");
3607     if (($v_result = $this->privOpenFd('rb')) != 1)
3608     {
3609       $this->privSwapBackMagicQuotes();
3610       //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $v_result);
3611       return $v_result;
3612     }
3613
3614     // ----- Read the central directory informations
3615     $v_central_dir = array();
3616     if (($v_result = $this->privReadEndCentralDir($v_central_dir)) != 1)
3617     {
3618       // ----- Close the zip file
3619       $this->privCloseFd();
3620       $this->privSwapBackMagicQuotes();
3621
3622       //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $v_result);
3623       return $v_result;
3624     }
3625
3626     // ----- Start at beginning of Central Dir
3627     $v_pos_entry = $v_central_dir['offset'];
3628
3629     // ----- Read each entry
3630     $j_start = 0;
3631     for ($i=0, $v_nb_extracted=0; $i<$v_central_dir['entries']; $i++)
3632     {
3633       //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, "Read next file header entry : '$i'");
3634
3635       // ----- Read next Central dir entry
3636       //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 4, "Position before rewind : ".ftell($this->zip_fd)."'");
3637       @rewind($this->zip_fd);
3638       //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 4, "Position after rewind : ".ftell($this->zip_fd)."'");
3639       if (@fseek($this->zip_fd, $v_pos_entry))
3640       {
3641         // ----- Close the zip file
3642         $this->privCloseFd();
3643         $this->privSwapBackMagicQuotes();
3644
3645         // ----- Error log
3646         PclZip::privErrorLog(PCLZIP_ERR_INVALID_ARCHIVE_ZIP, 'Invalid archive size');
3647
3648         // ----- Return
3649         //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, PclZip::errorCode(), PclZip::errorInfo());
3650         return PclZip::errorCode();
3651       }
3652       //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, "Position after fseek : ".ftell($this->zip_fd)."'");
3653
3654       // ----- Read the file header
3655       $v_header = array();
3656       if (($v_result = $this->privReadCentralFileHeader($v_header)) != 1)
3657       {
3658         // ----- Close the zip file
3659         $this->privCloseFd();
3660         $this->privSwapBackMagicQuotes();
3661
3662         //--(MAGIC-PclTrace)--//PclTraceFctEnd(__FILE__, __LINE__, $v_result);
3663         return $v_result;
3664       }
3665
3666       // ----- Store the index
3667       $v_header['index'] = $i;
3668
3669       // ----- Store the file position
3670       $v_pos_entry = ftell($this->zip_fd);
3671
3672       // ----- Look for the specific extract rules
3673       $v_extract = false;
3674
3675       // ----- Look for extract by name rule
3676       if (   (isset($p_options[PCLZIP_OPT_BY_NAME]))
3677           && ($p_options[PCLZIP_OPT_BY_NAME] != 0)) {
3678           //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, "Extract with rule 'ByName'");
3679
3680           // ----- Look if the filename is in the list
3681           for ($j=0; ($j<sizeof($p_options[PCLZIP_OPT_BY_NAME])) && (!$v_extract); $j++) {
3682               //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, "Compare with file '".$p_options[PCLZIP_OPT_BY_NAME][$j]."'");
3683
3684               // ----- Look for a directory
3685               if (substr($p_options[PCLZIP_OPT_BY_NAME][$j], -1) == "/") {
3686                   //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, "The searched item is a directory");
3687
3688                   // ----- Look if the directory is in the filename path
3689                   if (   (strlen($v_header['stored_filename']) > strlen($p_options[PCLZIP_OPT_BY_NAME][$j]))
3690                       && (substr($v_header['stored_filename'], 0, strlen($p_options[PCLZIP_OPT_BY_NAME][$j])) == $p_options[PCLZIP_OPT_BY_NAME][$j])) {
3691                       //--(MAGIC-PclTrace)--//PclTraceFctMessage(__FILE__, __LINE__, 3, "The directory is in the file path");
3692                       $v_extract = true;
3693                   }