-
Notifications
You must be signed in to change notification settings - Fork 62
Expand file tree
/
Copy pathZip.php
More file actions
3599 lines (3064 loc) · 116 KB
/
Copy pathZip.php
File metadata and controls
3599 lines (3064 loc) · 116 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/* vim: set ts=4 sw=4: */
// +----------------------------------------------------------------------+
// | PHP Version 4 |
// +----------------------------------------------------------------------+
// | Copyright (c) 1997-2003 The PHP Group |
// +----------------------------------------------------------------------+
// | This source file is subject to version 3.0 of the PHP license, |
// | that is bundled with this package in the file LICENSE, and is |
// | available through the world-wide-web at the following url: |
// | http://www.php.net/license/3_0.txt. |
// | If you did not receive a copy of the PHP license and are unable to |
// | obtain it through the world-wide-web, please send a note to |
// | [email protected] so we can mail you a copy immediately. |
// +----------------------------------------------------------------------+
// | Author: Vincent Blavet <[email protected]> |
// +----------------------------------------------------------------------+
//
// $Id: Zip.php,v 1.1.1.1 2004/11/20 17:44:47 Peris Exp $
require_once 'PEAR.php';
// ----- Constants
define( 'ARCHIVE_ZIP_READ_BLOCK_SIZE', 2048 );
// ----- File list separator
define( 'ARCHIVE_ZIP_SEPARATOR', ',' );
// ----- Optional static temporary directory
// By default temporary files are generated in the script current
// path.
// If defined :
// - MUST BE terminated by a '/'.
// - MUST be a valid, already created directory
// Samples :
// define( 'ARCHIVE_ZIP_TEMPORARY_DIR', '/temp/' );
// define( 'ARCHIVE_ZIP_TEMPORARY_DIR', 'C:/Temp/' );
define( 'ARCHIVE_ZIP_TEMPORARY_DIR', '' );
// ----- Error codes
define( 'ARCHIVE_ZIP_ERR_NO_ERROR', 0 );
define( 'ARCHIVE_ZIP_ERR_WRITE_OPEN_FAIL', -1 );
define( 'ARCHIVE_ZIP_ERR_READ_OPEN_FAIL', -2 );
define( 'ARCHIVE_ZIP_ERR_INVALID_PARAMETER', -3 );
define( 'ARCHIVE_ZIP_ERR_MISSING_FILE', -4 );
define( 'ARCHIVE_ZIP_ERR_FILENAME_TOO_LONG', -5 );
define( 'ARCHIVE_ZIP_ERR_INVALID_ZIP', -6 );
define( 'ARCHIVE_ZIP_ERR_BAD_EXTRACTED_FILE', -7 );
define( 'ARCHIVE_ZIP_ERR_DIR_CREATE_FAIL', -8 );
define( 'ARCHIVE_ZIP_ERR_BAD_EXTENSION', -9 );
define( 'ARCHIVE_ZIP_ERR_BAD_FORMAT', -10 );
define( 'ARCHIVE_ZIP_ERR_DELETE_FILE_FAIL', -11 );
define( 'ARCHIVE_ZIP_ERR_RENAME_FILE_FAIL', -12 );
define( 'ARCHIVE_ZIP_ERR_BAD_CHECKSUM', -13 );
define( 'ARCHIVE_ZIP_ERR_INVALID_ARCHIVE_ZIP', -14 );
define( 'ARCHIVE_ZIP_ERR_MISSING_OPTION_VALUE', -15 );
define( 'ARCHIVE_ZIP_ERR_INVALID_PARAM_VALUE', -16 );
// ----- Warning codes
define( 'ARCHIVE_ZIP_WARN_NO_WARNING', 0 );
define( 'ARCHIVE_ZIP_WARN_FILE_EXIST', 1 );
// ----- Methods parameters
define( 'ARCHIVE_ZIP_PARAM_PATH', 'path' );
define( 'ARCHIVE_ZIP_PARAM_ADD_PATH', 'add_path' );
define( 'ARCHIVE_ZIP_PARAM_REMOVE_PATH', 'remove_path' );
define( 'ARCHIVE_ZIP_PARAM_REMOVE_ALL_PATH', 'remove_all_path' );
define( 'ARCHIVE_ZIP_PARAM_SET_CHMOD', 'set_chmod' );
define( 'ARCHIVE_ZIP_PARAM_EXTRACT_AS_STRING', 'extract_as_string' );
define( 'ARCHIVE_ZIP_PARAM_NO_COMPRESSION', 'no_compression' );
define( 'ARCHIVE_ZIP_PARAM_BY_NAME', 'by_name' );
define( 'ARCHIVE_ZIP_PARAM_BY_INDEX', 'by_index' );
define( 'ARCHIVE_ZIP_PARAM_BY_EREG', 'by_ereg' );
define( 'ARCHIVE_ZIP_PARAM_BY_PREG', 'by_preg' );
define( 'ARCHIVE_ZIP_PARAM_PRE_EXTRACT', 'callback_pre_extract' );
define( 'ARCHIVE_ZIP_PARAM_POST_EXTRACT', 'callback_post_extract' );
define( 'ARCHIVE_ZIP_PARAM_PRE_ADD', 'callback_pre_add' );
define( 'ARCHIVE_ZIP_PARAM_POST_ADD', 'callback_post_add' );
/**
* Class for manipulating zip archive files
*
* A class which provided common methods to manipulate ZIP formatted
* archive files.
* It provides creation, extraction, deletion and add features.
*
* @author Vincent Blavet <[email protected]>
* @version $Revision: 1.1.1.1 $
* @package Archive_Zip
* @category Archive
*/
class Archive_Zip
{
/**
* The filename of the zip archive.
*
* @var string Name of the Zip file
*/
var $_zipname='';
/**
* File descriptor of the opened Zip file.
*
* @var int Internal zip file descriptor
*/
var $_zip_fd=0;
/**
* @var int last error code
*/
var $_error_code=1;
/**
* @var string Last error description
*/
var $_error_string='';
// {{{ constructor
/**
* Archive_Zip Class constructor. This flavour of the constructor only
* declare a new Archive_Zip object, identifying it by the name of the
* zip file.
*
* @param string $p_zipname The name of the zip archive to create
* @access public
*/
function Archive_Zip($p_zipname)
{
// ----- Check the zlib
if (!extension_loaded('zlib')) {
PEAR::loadExtension('zlib');
}
if (!extension_loaded('zlib')) {
die("The extension 'zlib' couldn't be found.\n".
"Please make sure your version of PHP was built ".
"with 'zlib' support.\n");
return false;
}
// ----- Set the attributes
$this->_zipname = $p_zipname;
$this->_zip_fd = 0;
return;
}
// }}}
// {{{ create()
/**
* This method creates a Zip Archive with the filename set with
* the constructor.
* The files and directories indicated in $p_filelist
* are added in the archive.
* When a directory is in the list, the directory and its content is added
* in the archive.
* The methods takes a variable list of parameters in $p_params.
* The supported parameters for this method are :
* 'add_path' : Add a path to the archived files.
* 'remove_path' : Remove the specified 'root' path of the archived files.
* 'remove_all_path' : Remove all the path of the archived files.
* 'no_compression' : The archived files will not be compressed.
*
* @access public
* @param mixed $p_filelist The list of the files or folders to add.
* It can be a string with filenames separated
* by a comma, or an array of filenames.
* @param mixed $p_params An array of variable parameters and values.
* @return mixed An array of file description on success,
* an error code on error
*/
function create($p_filelist, $p_params=0)
{
$this->_errorReset();
// ----- Set default values
if ($p_params === 0) {
$p_params = array();
}
if ($this->_check_parameters($p_params,
array('no_compression' => false,
'add_path' => "",
'remove_path' => "",
'remove_all_path' => false)) != 1) {
return 0;
}
// ----- Look if the $p_filelist is really an array
$p_result_list = array();
if (is_array($p_filelist)) {
$v_result = $this->_create($p_filelist, $p_result_list, $p_params);
}
// ----- Look if the $p_filelist is a string
else if (is_string($p_filelist)) {
// ----- Create a list with the elements from the string
$v_list = explode(ARCHIVE_ZIP_SEPARATOR, $p_filelist);
$v_result = $this->_create($v_list, $p_result_list, $p_params);
}
// ----- Invalid variable
else {
$this->_errorLog(ARCHIVE_ZIP_ERR_INVALID_PARAMETER,
'Invalid variable type p_filelist');
$v_result = ARCHIVE_ZIP_ERR_INVALID_PARAMETER;
}
if ($v_result != 1) {
return 0;
}
return $p_result_list;
}
// }}}
// {{{ add()
/**
* This method add files or directory in an existing Zip Archive.
* If the Zip Archive does not exist it is created.
* The files and directories to add are indicated in $p_filelist.
* When a directory is in the list, the directory and its content is added
* in the archive.
* The methods takes a variable list of parameters in $p_params.
* The supported parameters for this method are :
* 'add_path' : Add a path to the archived files.
* 'remove_path' : Remove the specified 'root' path of the archived files.
* 'remove_all_path' : Remove all the path of the archived files.
* 'no_compression' : The archived files will not be compressed.
* 'callback_pre_add' : A callback function that will be called before
* each entry archiving.
* 'callback_post_add' : A callback function that will be called after
* each entry archiving.
*
* @access public
* @param mixed $p_filelist The list of the files or folders to add.
* It can be a string with filenames separated
* by a comma, or an array of filenames.
* @param mixed $p_params An array of variable parameters and values.
* @return mixed An array of file description on success,
* 0 on an unrecoverable failure, an error code is logged.
*/
function add($p_filelist, $p_params=0)
{
$this->_errorReset();
// ----- Set default values
if ($p_params === 0) {
$p_params = array();
}
if ($this->_check_parameters($p_params,
array ('no_compression' => false,
'add_path' => '',
'remove_path' => '',
'remove_all_path' => false,
'callback_pre_add' => '',
'callback_post_add' => '')) != 1) {
return 0;
}
// ----- Look if the $p_filelist is really an array
$p_result_list = array();
if (is_array($p_filelist)) {
// ----- Call the create fct
$v_result = $this->_add($p_filelist, $p_result_list, $p_params);
}
// ----- Look if the $p_filelist is a string
else if (is_string($p_filelist)) {
// ----- Create a list with the elements from the string
$v_list = explode(ARCHIVE_ZIP_SEPARATOR, $p_filelist);
// ----- Call the create fct
$v_result = $this->_add($v_list, $p_result_list, $p_params);
}
// ----- Invalid variable
else {
$this->_errorLog(ARCHIVE_ZIP_ERR_INVALID_PARAMETER,
"add() : Invalid variable type p_filelist");
$v_result = ARCHIVE_ZIP_ERR_INVALID_PARAMETER;
}
if ($v_result != 1) {
return 0;
}
// ----- Return the result list
return $p_result_list;
}
// }}}
// {{{ listContent()
/**
* This method gives the names and properties of the files and directories
* which are present in the zip archive.
* The properties of each entries in the list are :
* filename : Name of the file.
* For create() or add() it's the filename given by the user.
* For an extract() it's the filename of the extracted file.
* stored_filename : Name of the file / directory stored in the archive.
* size : Size of the stored file.
* compressed_size : Size of the file's data compressed in the archive
* (without the zip headers overhead)
* mtime : Last known modification date of the file (UNIX timestamp)
* comment : Comment associated with the file
* folder : true | false (indicates if the entry is a folder)
* index : index of the file in the archive (-1 when not available)
* status : status of the action on the entry (depending of the action) :
* Values are :
* ok : OK !
* filtered : the file/dir was not extracted (filtered by user)
* already_a_directory : the file can't be extracted because a
* directory with the same name already
* exists
* write_protected : the file can't be extracted because a file
* with the same name already exists and is
* write protected
* newer_exist : the file was not extracted because a newer
* file already exists
* path_creation_fail : the file is not extracted because the
* folder does not exists and can't be
* created
* write_error : the file was not extracted because there was a
* error while writing the file
* read_error : the file was not extracted because there was a
* error while reading the file
* invalid_header : the file was not extracted because of an
* archive format error (bad file header)
* Note that each time a method can continue operating when there
* is an error on a single file, the error is only logged in the file status.
*
* @access public
* @return mixed An array of file description on success,
* 0 on an unrecoverable failure, an error code is logged.
*/
function listContent()
{
$this->_errorReset();
// ----- Check archive
if (!$this->_checkFormat()) {
return(0);
}
$v_list = array();
if ($this->_list($v_list) != 1) {
unset($v_list);
return(0);
}
return $v_list;
}
// }}}
// {{{ extract()
/**
* This method extract the files and folders which are in the zip archive.
* It can extract all the archive or a part of the archive by using filter
* feature (extract by name, by index, by ereg, by preg). The extraction
* can occur in the current path or an other path.
* All the advanced features are activated by the use of variable
* parameters.
* The return value is an array of entry descriptions which gives
* information on extracted files (See listContent()).
* The method may return a success value (an array) even if some files
* are not correctly extracted (see the file status in listContent()).
* The supported variable parameters for this method are :
* 'add_path' : Path where the files and directories are to be extracted
* 'remove_path' : First part ('root' part) of the memorized path
* (if similar) to remove while extracting.
* 'remove_all_path' : Remove all the memorized path while extracting.
* 'extract_as_string' :
* 'set_chmod' : After the extraction of the file the indicated mode
* will be set.
* 'by_name' : It can be a string with file/dir names separated by ',',
* or an array of file/dir names to extract from the archive.
* 'by_index' : A string with range of indexes separated by ',',
* (sample "1,3-5,12").
* 'by_ereg' : A regular expression (ereg) that must match the extracted
* filename.
* 'by_preg' : A regular expression (preg) that must match the extracted
* filename.
* 'callback_pre_extract' : A callback function that will be called before
* each entry extraction.
* 'callback_post_extract' : A callback function that will be called after
* each entry extraction.
*
* @access public
* @param mixed $p_params An array of variable parameters and values.
* @return mixed An array of file description on success,
* 0 on an unrecoverable failure, an error code is logged.
*/
function extract($p_params=0)
{
$this->_errorReset();
// ----- Check archive
if (!$this->_checkFormat()) {
return(0);
}
// ----- Set default values
if ($p_params === 0) {
$p_params = array();
}
if ($this->_check_parameters($p_params,
array ('extract_as_string' => false,
'add_path' => '',
'remove_path' => '',
'remove_all_path' => false,
'callback_pre_extract' => '',
'callback_post_extract' => '',
'set_chmod' => 0,
'by_name' => '',
'by_index' => '',
'by_ereg' => '',
'by_preg' => '') ) != 1) {
return 0;
}
// ----- Call the extracting fct
$v_list = array();
if ($this->_extractByRule($v_list, $p_params) != 1) {
unset($v_list);
return(0);
}
return $v_list;
}
// }}}
// {{{ delete()
/**
* This methods delete archive entries in the zip archive.
* Notice that at least one filtering rule (set by the variable parameter
* list) must be set.
* Also notice that if you delete a folder entry, only the folder entry
* is deleted, not all the files bellonging to this folder.
* The supported variable parameters for this method are :
* 'by_name' : It can be a string with file/dir names separated by ',',
* or an array of file/dir names to delete from the archive.
* 'by_index' : A string with range of indexes separated by ',',
* (sample "1,3-5,12").
* 'by_ereg' : A regular expression (ereg) that must match the extracted
* filename.
* 'by_preg' : A regular expression (preg) that must match the extracted
* filename.
*
* @access public
* @param mixed $p_params An array of variable parameters and values.
* @return mixed An array of file description on success,
* 0 on an unrecoverable failure, an error code is logged.
*/
function delete($p_params)
{
$this->_errorReset();
// ----- Check archive
if (!$this->_checkFormat()) {
return(0);
}
// ----- Set default values
if ($this->_check_parameters($p_params,
array ('by_name' => '',
'by_index' => '',
'by_ereg' => '',
'by_preg' => '') ) != 1) {
return 0;
}
// ----- Check that at least one rule is set
if ( ($p_params['by_name'] == '')
&& ($p_params['by_index'] == '')
&& ($p_params['by_ereg'] == '')
&& ($p_params['by_preg'] == '')) {
$this->_errorLog(ARCHIVE_ZIP_ERR_INVALID_PARAMETER,
'At least one filtering rule must'
.' be set as parameter');
return 0;
}
// ----- Call the delete fct
$v_list = array();
if ($this->_deleteByRule($v_list, $p_params) != 1) {
unset($v_list);
return(0);
}
return $v_list;
}
// }}}
// {{{ properties()
/**
* This method gives the global properties of the archive.
* The properties are :
* nb : Number of files in the archive
* comment : Comment associated with the archive file
* status : not_exist, ok
*
* @access public
* @param mixed $p_params {Description}
* @return mixed An array with the global properties or 0 on error.
*/
function properties()
{
$this->_errorReset();
// ----- Check archive
if (!$this->_checkFormat()) {
return(0);
}
// ----- Default properties
$v_prop = array();
$v_prop['comment'] = '';
$v_prop['nb'] = 0;
$v_prop['status'] = 'not_exist';
// ----- Look if file exists
if (@is_file($this->_zipname)) {
// ----- Open the zip file
if (($this->_zip_fd = @fopen($this->_zipname, 'rb')) == 0) {
$this->_errorLog(ARCHIVE_ZIP_ERR_READ_OPEN_FAIL,
'Unable to open archive \''.$this->_zipname
.'\' in binary read mode');
return 0;
}
// ----- Read the central directory informations
$v_central_dir = array();
if (($v_result = $this->_readEndCentralDir($v_central_dir)) != 1) {
return 0;
}
$this->_closeFd();
// ----- Set the user attributes
$v_prop['comment'] = $v_central_dir['comment'];
$v_prop['nb'] = $v_central_dir['entries'];
$v_prop['status'] = 'ok';
}
return $v_prop;
}
// }}}
// {{{ duplicate()
/**
* This method creates an archive by copying the content of an other one.
* If the archive already exist, it is replaced by the new one without
* any warning.
*
* @access public
* @param mixed $p_archive It can be a valid Archive_Zip object or
* the filename of a valid zip archive.
* @return integer 1 on success, 0 on failure.
*/
function duplicate($p_archive)
{
$this->_errorReset();
// ----- Look if the $p_archive is a Archive_Zip object
if ( (is_object($p_archive))
&& (strtolower(get_class($p_archive)) == 'archive_zip')) {
$v_result = $this->_duplicate($p_archive->_zipname);
}
// ----- Look if the $p_archive is a string (so a filename)
else if (is_string($p_archive)) {
// ----- Check that $p_archive is a valid zip file
// TBC : Should also check the archive format
if (!is_file($p_archive)) {
$this->_errorLog(ARCHIVE_ZIP_ERR_MISSING_FILE,
"No file with filename '".$p_archive."'");
$v_result = ARCHIVE_ZIP_ERR_MISSING_FILE;
}
else {
$v_result = $this->_duplicate($p_archive);
}
}
// ----- Invalid variable
else {
$this->_errorLog(ARCHIVE_ZIP_ERR_INVALID_PARAMETER,
"Invalid variable type p_archive_to_add");
$v_result = ARCHIVE_ZIP_ERR_INVALID_PARAMETER;
}
return $v_result;
}
// }}}
// {{{ merge()
/**
* This method merge a valid zip archive at the end of the
* archive identified by the Archive_Zip object.
* If the archive ($this) does not exist, the merge becomes a duplicate.
* If the archive to add does not exist, the merge is a success.
*
* @access public
* @param mixed $p_archive_to_add It can be a valid Archive_Zip object or
* the filename of a valid zip archive.
* @return integer 1 on success, 0 on failure.
*/
function merge($p_archive_to_add)
{
$v_result = 1;
$this->_errorReset();
// ----- Check archive
if (!$this->_checkFormat()) {
return(0);
}
// ----- Look if the $p_archive_to_add is a Archive_Zip object
if ( (is_object($p_archive_to_add))
&& (strtolower(get_class($p_archive_to_add)) == 'archive_zip')) {
$v_result = $this->_merge($p_archive_to_add);
}
// ----- Look if the $p_archive_to_add is a string (so a filename)
else if (is_string($p_archive_to_add)) {
// ----- Create a temporary archive
$v_object_archive = new Archive_Zip($p_archive_to_add);
// ----- Merge the archive
$v_result = $this->_merge($v_object_archive);
}
// ----- Invalid variable
else {
$this->_errorLog(ARCHIVE_ZIP_ERR_INVALID_PARAMETER,
"Invalid variable type p_archive_to_add");
$v_result = ARCHIVE_ZIP_ERR_INVALID_PARAMETER;
}
return $v_result;
}
// }}}
// {{{ errorCode()
/**
* Method that gives the lastest error code.
*
* @access public
* @return integer The error code value.
*/
function errorCode()
{
return($this->_error_code);
}
// }}}
// {{{ errorName()
/**
* This method gives the latest error code name.
*
* @access public
* @param boolean $p_with_code If true, gives the name and the int value.
* @return string The error name.
*/
function errorName($p_with_code=false)
{
$v_const_list = get_defined_constants();
// ----- Extract error constants from all const.
for (reset($v_const_list);
list($v_key, $v_value) = each($v_const_list);) {
if (substr($v_key, 0, strlen('ARCHIVE_ZIP_ERR_'))
=='ARCHIVE_ZIP_ERR_') {
$v_error_list[$v_key] = $v_value;
}
}
// ----- Search the name form the code value
$v_key=array_search($this->_error_code, $v_error_list, true);
if ($v_key!=false) {
$v_value = $v_key;
}
else {
$v_value = 'NoName';
}
if ($p_with_code) {
return($v_value.' ('.$this->_error_code.')');
}
else {
return($v_value);
}
}
// }}}
// {{{ errorInfo()
/**
* This method returns the description associated with the latest error.
*
* @access public
* @param boolean $p_full If set to true gives the description with the
* error code, the name and the description.
* If set to false gives only the description
* and the error code.
* @return string The error description.
*/
function errorInfo($p_full=false)
{
if ($p_full) {
return($this->errorName(true)." : ".$this->_error_string);
}
else {
return($this->_error_string." [code ".$this->_error_code."]");
}
}
// }}}
// -----------------------------------------------------------------------------
// ***** UNDER THIS LINE ARE DEFINED PRIVATE INTERNAL FUNCTIONS *****
// ***** *****
// ***** THESES FUNCTIONS MUST NOT BE USED DIRECTLY *****
// -----------------------------------------------------------------------------
// ---------------------------------------------------------------------------
// Function : _checkFormat()
// Description :
// This method check that the archive exists and is a valid zip archive.
// Several level of check exists. (futur)
// Parameters :
// $p_level : Level of check. Default 0.
// 0 : Check the first bytes (magic codes) (default value))
// 1 : 0 + Check the central directory (futur)
// 2 : 1 + Check each file header (futur)
// Return Values :
// true on success,
// false on error, the error code is set.
// ---------------------------------------------------------------------------
/**
* Archive_Zip::_checkFormat()
*
* { Description }
*
* @param integer $p_level
*/
function _checkFormat($p_level=0)
{
$v_result = true;
// ----- Reset the error handler
$this->_errorReset();
// ----- Look if the file exits
if (!is_file($this->_zipname)) {
// ----- Error log
$this->_errorLog(ARCHIVE_ZIP_ERR_MISSING_FILE,
"Missing archive file '".$this->_zipname."'");
return(false);
}
// ----- Check that the file is readeable
if (!is_readable($this->_zipname)) {
// ----- Error log
$this->_errorLog(ARCHIVE_ZIP_ERR_READ_OPEN_FAIL,
"Unable to read archive '".$this->_zipname."'");
return(false);
}
// ----- Check the magic code
// TBC
// ----- Check the central header
// TBC
// ----- Check each file header
// TBC
// ----- Return
return $v_result;
}
// ---------------------------------------------------------------------------
// ---------------------------------------------------------------------------
// Function : _create()
// Description :
// Parameters :
// Return Values :
// ---------------------------------------------------------------------------
/**
* Archive_Zip::_create()
*
* { Description }
*
*/
function _create($p_list, &$p_result_list, &$p_params)
{
$v_result=1;
$v_list_detail = array();
$p_add_dir = $p_params['add_path'];
$p_remove_dir = $p_params['remove_path'];
$p_remove_all_dir = $p_params['remove_all_path'];
// ----- Open the file in write mode
if (($v_result = $this->_openFd('wb')) != 1)
{
// ----- Return
return $v_result;
}
// ----- Add the list of files
$v_result = $this->_addList($p_list, $p_result_list, $p_add_dir, $p_remove_dir, $p_remove_all_dir, $p_params);
// ----- Close
$this->_closeFd();
// ----- Return
return $v_result;
}
// ---------------------------------------------------------------------------
// ---------------------------------------------------------------------------
// Function : _add()
// Description :
// Parameters :
// Return Values :
// ---------------------------------------------------------------------------
/**
* Archive_Zip::_add()
*
* { Description }
*
*/
function _add($p_list, &$p_result_list, &$p_params)
{
$v_result=1;
$v_list_detail = array();
$p_add_dir = $p_params['add_path'];
$p_remove_dir = $p_params['remove_path'];
$p_remove_all_dir = $p_params['remove_all_path'];
// ----- Look if the archive exists or is empty and need to be created
if ((!is_file($this->_zipname)) || (filesize($this->_zipname) == 0)) {
$v_result = $this->_create($p_list, $p_result_list, $p_params);
return $v_result;
}
// ----- Open the zip file
if (($v_result=$this->_openFd('rb')) != 1) {
return $v_result;
}
// ----- Read the central directory informations
$v_central_dir = array();
if (($v_result = $this->_readEndCentralDir($v_central_dir)) != 1)
{
$this->_closeFd();
return $v_result;
}
// ----- Go to beginning of File
@rewind($this->_zip_fd);
// ----- Creates a temporay file
$v_zip_temp_name = ARCHIVE_ZIP_TEMPORARY_DIR.uniqid('archive_zip-').'.tmp';
// ----- Open the temporary file in write mode
if (($v_zip_temp_fd = @fopen($v_zip_temp_name, 'wb')) == 0)
{
$this->_closeFd();
$this->_errorLog(ARCHIVE_ZIP_ERR_READ_OPEN_FAIL,
'Unable to open temporary file \''
.$v_zip_temp_name.'\' in binary write mode');
return Archive_Zip::errorCode();
}
// ----- Copy the files from the archive to the temporary file
// TBC : Here I should better append the file and go back to erase the
// central dir
$v_size = $v_central_dir['offset'];
while ($v_size != 0)
{
$v_read_size = ($v_size < ARCHIVE_ZIP_READ_BLOCK_SIZE
? $v_size : ARCHIVE_ZIP_READ_BLOCK_SIZE);
$v_buffer = fread($this->_zip_fd, $v_read_size);
@fwrite($v_zip_temp_fd, $v_buffer, $v_read_size);
$v_size -= $v_read_size;
}
// ----- Swap the file descriptor
// Here is a trick : I swap the temporary fd with the zip fd, in order to
// use the following methods on the temporary fil and not the real archive
$v_swap = $this->_zip_fd;
$this->_zip_fd = $v_zip_temp_fd;
$v_zip_temp_fd = $v_swap;
// ----- Add the files
$v_header_list = array();
if (($v_result = $this->_addFileList($p_list, $v_header_list,
$p_add_dir, $p_remove_dir,
$p_remove_all_dir, $p_params)) != 1)
{
fclose($v_zip_temp_fd);
$this->_closeFd();
@unlink($v_zip_temp_name);
// ----- Return
return $v_result;
}
// ----- Store the offset of the central dir
$v_offset = @ftell($this->_zip_fd);
// ----- Copy the block of file headers from the old archive
$v_size = $v_central_dir['size'];
while ($v_size != 0)
{
$v_read_size = ($v_size < ARCHIVE_ZIP_READ_BLOCK_SIZE
? $v_size : ARCHIVE_ZIP_READ_BLOCK_SIZE);
$v_buffer = @fread($v_zip_temp_fd, $v_read_size);
@fwrite($this->_zip_fd, $v_buffer, $v_read_size);
$v_size -= $v_read_size;
}
// ----- Create the Central Dir files header
for ($i=0, $v_count=0; $i<sizeof($v_header_list); $i++)
{
// ----- Create the file header
if ($v_header_list[$i]['status'] == 'ok') {
if (($v_result=$this->_writeCentralFileHeader($v_header_list[$i]))!=1) {
fclose($v_zip_temp_fd);
$this->_closeFd();
@unlink($v_zip_temp_name);
// ----- Return
return $v_result;
}
$v_count++;
}
// ----- Transform the header to a 'usable' info
$this->_convertHeader2FileInfo($v_header_list[$i], $p_result_list[$i]);
}
// ----- Zip file comment
$v_comment = '';
// ----- Calculate the size of the central header
$v_size = @ftell($this->_zip_fd)-$v_offset;
// ----- Create the central dir footer
if (($v_result = $this->_writeCentralHeader($v_count
+$v_central_dir['entries'],
$v_size, $v_offset,
$v_comment)) != 1) {
// ----- Reset the file list
unset($v_header_list);
// ----- Return
return $v_result;
}
// ----- Swap back the file descriptor
$v_swap = $this->_zip_fd;
$this->_zip_fd = $v_zip_temp_fd;
$v_zip_temp_fd = $v_swap;
// ----- Close
$this->_closeFd();
// ----- Close the temporary file
@fclose($v_zip_temp_fd);
// ----- Delete the zip file
// TBC : I should test the result ...
@unlink($this->_zipname);
// ----- Rename the temporary file
// TBC : I should test the result ...
//@rename($v_zip_temp_name, $this->_zipname);
$this->_tool_Rename($v_zip_temp_name, $this->_zipname);
// ----- Return
return $v_result;
}
// ---------------------------------------------------------------------------
// ---------------------------------------------------------------------------
// Function : _openFd()
// Description :
// Parameters :
// ---------------------------------------------------------------------------