/
pharcommand.inc
executable file
·1595 lines (1516 loc) · 39 KB
/
pharcommand.inc
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
/**
* @file pharcommand.inc
* @ingroup Phar
* @brief class CLICommand
* @author Marcus Boerger
* @date 2007 - 2008
*
* Phar Command
*/
// {{{ class PharCommand extends CLICommand
/**
* PharCommand class
*
* This class handles the handling of the phar
* commands. It will be used from command line/console
* in order to retrieve and execute phar functions.
*
* @ingroup Phar
* @brief Phar console command implementation
* @author Marcus Boerger
* @version 1.0
*/
class PharCommand extends CLICommand
{
// {{{ public function cli_get_SP2
public function cli_get_SP2($l1, $arg_inf)
{
return str_repeat(' ', $l1 + 2 + 4 + 9);
}
// }}}
// {{{ public function cli_get_SP3
/**
* Cli Get SP3
*
* @param string $l1 Eleven
* @param string $l2 Twelve
* @param string $arg_inf
* @return string The repeated string.
*/
function cli_get_SP3($l1, $l2, $arg_inf)
{
return str_repeat(' ', $l1 + 2 + 4 + 9 + 2 + $l2 + 2);
}
// }}}
// {{{ static function phar_args
/**
* Phar arguments
*
* This function contains all the phar commands
*
* @param string $which Which argument is chosen.
* @param string $phartype The type of phar, specific file to work on
* @return unknown
*/
static function phar_args($which, $phartype)
{
$phar_args = array(
'a' => array(
'typ' => 'alias',
'val' => NULL,
'inf' => '<alias> Provide an alias name for the phar file.'
),
'b' => array(
'typ' => 'any',
'val' => NULL,
'inf' => '<bang> Hash-bang line to start the archive (e.g. #!/usr/bin/php). The hash '
.' mark itself \'#!\' and the newline character are optional.'
),
'c' => array(
'typ' => 'compalg',
'val' => NULL,
'inf' => '<algo> Compression algorithm.',
'select' => array(
'0' => 'No compression',
'none' => 'No compression',
'auto' => 'Automatically select compression algorithm'
)
),
'e' => array(
'typ' => 'entry',
'val' => NULL,
'inf' => '<entry> Name of entry to work on (must include PHAR internal directory name if any).'
),
'f' => array(
'typ' => $phartype,
'val' => NULL,
'inf' => '<file> Specifies the phar file to work on.'
),
'h' => array(
'typ' => 'select',
'val' => NULL,
'inf' => '<method> Selects the hash algorithm.',
'select' => array('md5' => 'MD5','sha1' => 'SHA1')
),
'i' => array(
'typ' => 'regex',
'val' => NULL,
'inf' => '<regex> Specifies a regular expression for input files.'
),
'k' => array(
'typ' => 'any',
'val' => NULL,
'inf' => '<index> Subscription index to work on.',
),
'l' => array(
'typ' => 'int',
'val' => 0,
'inf' => '<level> Number of preceding subdirectories to strip from file entries',
),
'm' => array(
'typ' => 'any',
'val' => NULL,
'inf' => '<meta> Meta data to store with entry (serialized php data).'
),
'p' => array(
'typ' => 'loader',
'val' => NULL,
'inf' => '<loader> Location of PHP_Archive class file (pear list-files PHP_Archive).'
.'You can use \'0\' or \'1\' to locate it automatically using the mentioned '
.'pear command. When using \'0\' the command does not error out when the '
.'class file cannot be located. This switch also adds some code around the '
.'stub so that class PHP_Archive gets registered as phar:// stream wrapper '
.'if necessary. And finally this switch will add the file phar.inc from '
.'this package and load it to ensure class Phar is present.'
,
),
's' => array(
'typ' => 'file',
'val' => NULL,
'inf' => '<stub> Select the stub file.'
),
'x' => array(
'typ' => 'regex',
'val' => NULL,
'inf' => '<regex> Regular expression for input files to exclude.'
),
'y' => array(
'typ' => 'privkey',
'val' => NULL,
'inf' => '<key> Private key for OpenSSL signing.',
),
);
if (extension_loaded('zlib')) {
$phar_args['c']['select']['gz'] = 'GZip compression';
$phar_args['c']['select']['gzip'] = 'GZip compression';
}
if (extension_loaded('bz2')) {
$phar_args['c']['select']['bz2'] = 'BZip2 compression';
$phar_args['c']['select']['bzip2'] = 'BZip2 compression';
}
$hash_avail = Phar::getSupportedSignatures();
$hash_optional = array('SHA-256' => 'SHA256',
'SHA-512' => 'SHA512',
'OpenSSL' => 'OpenSSL');
if (!in_array('OpenSSL', $hash_avail)) {
unset($phar_args['y']);
}
foreach($hash_optional as $key => $name) {
if (in_array($key, $hash_avail)) {
$phar_args['h']['select'][strtolower($name)] = $name;
}
}
$args = array();
foreach($phar_args as $lkey => $cfg) {
$ukey = strtoupper($lkey);
$required = strpos($which, $ukey) !== false;
$optional = strpos($which, $lkey) !== false;
if ($required || $optional) {
$args[$lkey] = $cfg;
$args[$lkey]['required'] = $required;
}
}
return $args;
}
// }}}
// {{{ static function strEndsWith
/**
* String Ends With
*
* Whether a string ends with another needle.
*
* @param string $haystack The haystack
* @param string $needle The needle.
* @return mixed false if doesn't end with anything, the string
* substr'ed if the string ends with the needle.
*/
static function strEndsWith($haystack, $needle)
{
return substr($haystack, -strlen($needle)) == $needle;
}
// }}}
// {{{ static function cli_arg_typ_loader
/**
* Argument type loader
*
* @param string $arg Either 'auto', 'optional' or an filename that
* contains class PHP_Archive
* @param string $cfg Configuration to pass to a new file
* @param string $key The key
* @return string $arg The argument.
*/
static function cli_arg_typ_loader($arg, $cfg, $key)
{
if (($arg == '0' || $arg == '1') && !file_exists($arg) && substr(PHP_OS, 0, 3) != 'WIN') {
$found = NULL;
$apiver = false;
$path = explode(PATH_SEPARATOR, $_ENV['PATH']);
$pear = false;
foreach ($path as $component) {
if (file_exists($component . DIRECTORY_SEPARATOR . 'pear')
&& is_executable($component . DIRECTORY_SEPARATOR . 'pear')) {
$pear = true;
break;
}
}
if ($pear) {
$apiver = `pear -q info PHP_Archive 2>/dev/null|grep 'API Version'`;
$apiver = trim(substr($apiver, strlen('API Version')));
}
if ($apiver) {
self::notice("PEAR package PHP_Archive: API Version: $apiver.\n");
$files = explode("\n", `pear list-files PHP_Archive`);
$phpdir = `pear config-get php_dir 2>/dev/null`;
$phpdir = trim($phpdir);
self::notice("PEAR package PHP_Archive: $phpdir.\n");
if (is_dir($phpdir)) {
foreach($files as $ent) {
$matches = NULL;
if (preg_match(",^php[ \t]+([^ \t].*[\\\\/]PHP[\\\\/]Archive\.php)$,", $ent, $matches)) {
$sub = $matches[1];
if (strpos($sub, $phpdir) !== 0) {
$found = NULL;
break;
}
$found = $sub;
break;
}
}
} else {
self::notice("PEAR package PHP_Archive: corrupt or inaccessible base dir: $php_dir.\n");
}
}
if (isset($found)) {
self::notice("PEAR package PHP_Archive: $found.\n");
} else {
$msg = "PEAR package PHP_Archive not installed: generated phar will require PHP's phar extension be enabled.\n";
if ($arg == '0') {
self::notice($msg);
} else {
self::error($msg);
}
}
$arg = $found;
}
return self::cli_arg_typ_file($arg);
}
// }}}
// {{{ static function cli_arg_typ_pharnew
/**
* Argument type new phar
*
* @param string $arg The new phar component.
* @param string $cfg Configuration to pass to a new file
* @param string $key The key
* @return string $arg The new argument file.
*/
static function cli_arg_typ_pharnew($arg, $cfg, $key)
{
$arg = self::cli_arg_typ_filenew($arg, $cfg, $key);
if (!Phar::isValidPharFilename($arg)) {
self::error("Phar files must have file extension '.phar', '.phar.php', '.phar.bz2' or '.phar.gz'.\n");
}
return $arg;
}
// }}}
// {{{ static function cli_arg_typ_pharfile
/**
* Argument type existing Phar file
*
* Return filename of an existing Phar.
*
* @param string $arg The file in the phar to open.
* @param string $cfg The configuration information
* @param string $key The key information.
* @return string $pharfile The name of the loaded Phar file.
* @note The Phar will be loaded
*/
static function cli_arg_typ_pharfile($arg, $cfg, $key)
{
try {
$pharfile = self::cli_arg_typ_file($arg, $cfg, $key);
if (!Phar::loadPhar($pharfile)) {
self::error("Unable to open phar '$arg'\n");
}
return $pharfile;
} catch(Exception $e) {
self::error("Exception while opening phar '$arg':\n" . $e->getMessage() . "\n");
}
}
// }}}
// {{{ static function cli_arg_typ_pharurl
/**
* Argument type Phar url-like
*
* Check the argument as cli_arg_Typ_phar and return its name prefixed
* with phar://
*
* Ex:
* <code>
* $arg = 'pharchive.phar/file.php';
* cli_arg_typ_pharurl($arg)
* </code>
*
* @param string $arg The url-like phar archive to retrieve.
* @return string The phar file-archive.
*/
static function cli_arg_typ_pharurl($arg, $cfg, $key)
{
return 'phar://' . self::cli_arg_typ_pharfile($arg, $cfg, $key);
}
// }}}
// {{{ static function cli_arg_typ_phar
/**
* Cli argument type phar
*
* @param string $arg The phar archive to use.
* @return object new Phar of the passed argument.
*/
static function cli_arg_typ_phar($arg, $cfg, $key)
{
try {
return new Phar(self::cli_arg_typ_pharfile($arg, $cfg, $key));
} catch(Exception $e) {
self::error("Exception while opening phar '$argv':\n" . $e->getMessage() . "\n");
}
}
// }}}
// {{{ static function cli_arg_typ_entry
/**
* Argument type Entry name
*
* @param string $arg The argument (the entry)
* @return string $arg The entry itself.
*/
static function cli_arg_typ_entry($arg, $cfg, $key)
{
// no further check atm, maybe check for no '/' at beginning
return $arg;
}
// }}}
// {{{ static function cli_arg_typ_compalg
/**
* Argument type compression algorithm
*
* @param string $arg The phar selection
* @param string $cfg The config option.
* @param string $key The key information.
* @return string $arg The selected algorithm
*/
static function cli_arg_typ_compalg($arg, $cfg, $key)
{
$arg = self::cli_arg_typ_select($arg, $cfg, $key);
switch($arg) {
case 'auto':
if (extension_loaded('zlib')) {
$arg = 'gz';
} elseif (extension_loaded('bz2')) {
$arg = 'bz2';
} else {
$arg = '0';
}
break;
}
return $arg;
}
// }}}
// {{{ static function cli_arg_typ_privkey
/**
* Argument type private key (for OpenSSL signing)
*
* @param string $arg The phar selection
* @param string $cfg The config option.
* @param string $key The key information.
* @return string $arg The private key.
*/
static function cli_arg_typ_privkey($arg, $cfg, $key)
{
$arg = self::cli_arg_typ_string($arg, $cfg, $key);
$hash_avail = Phar::getSupportedSignatures();
if ($arg && !in_array('OpenSSL', $hash_avail))
{
self::error("Cannot specifiy private key without OpenSSL support.\n");
}
return $arg;
}
// }}}
// {{{ static function phar_check_hash
/**
* Check whether hash method is valid.
*
* @return Hash constant to be used.
*/
function phar_check_hash($hash, $privkey)
{
switch($hash) {
case 'md5':
return Phar::MD5;
case 'sha1':
return Phar::SHA1;
case 'sha256':
return Phar::SHA256;
case 'sha512':
return Phar::SHA512;
case 'openssl':
if (!$privkey) {
self::error("Cannot use OpenSSL signing without key.\n");
}
return Phar::OPENSSL;
}
}
// }}}
// {{{ static function cli_cmd_inf_pack
/**
* Information pack
*
* @return string A description about packing files into a Phar archive.
*/
static function cli_cmd_inf_pack()
{
return "Pack files into a PHAR archive.\n" .
"When using -s <stub>, then the stub file is being " .
"excluded from the list of input files/dirs." .
"To create an archive that contains PEAR class PHP_Archive " .
"then point -p argument to PHP/Archive.php.\n";
}
// }}}
// {{{ static function cli_cmd_arg_pack
/**
* Pack a new phar infos
*
* @return array $args The arguments for a new Phar archive.
*/
static function cli_cmd_arg_pack()
{
$args = self::phar_args('abcFhilpsxy', 'pharnew');
$args[''] = array(
'typ' => 'any',
'val' => NULL,
'required' => 1,
'inf' => ' Any number of input files and directories. If -i is in use then ONLY files and matching the given regular expression are being packed. If -x is given then files matching that regular expression are NOT being packed.',
);
return $args;
}
// }}}
// {{{ function phar_set_stub_begin
/**
* Set the stub
*/
public function phar_set_stub_begin(Phar $phar, $stub, $loader = NULL, $hashbang = NULL)
{
if (isset($stub)) {
$c = file_get_contents($stub);
if (substr($c, 0, 2) == '#!') {
if (strpos($c, "\n") !== false) {
if (!isset($hashbang)) {
$hashbang = substr($c, 0, strpos($c, "\n") + 1);
}
$c = substr($c, strpos($c, "\n") + 1);
} else {
if (!isset($hashbang)) {
$hashbang = $c;
}
$c = NULL;
}
}
if (isset($hashbang)) {
if (substr($hashbang, 0, 2) != '#!') {
$hashbang = '#!' . $hashbang;
}
if (substr($hashbang, -1) != "\n") {
$hashbang .= "\n";
}
} else {
$hashbang = "";
}
if (isset($loader)) {
$s = "<?php if (!class_exists('PHP_Archive')) {\n?>";
if (is_file($loader)) {
$s .= file_get_contents($loader);
}
$s .= "<?php\n";
$s .= "}\n";
$s .= "if (!in_array('phar', stream_get_wrappers())) {\n";
$s .= "\tstream_wrapper_register('phar', 'PHP_Archive');\n";
$s .= "}\n";
$s .= "if (!class_exists('Phar',0)) {\n";
$s .= "\tinclude 'phar://'.__FILE__.'/phar.inc';\n";
$s .= "}\n";
$s .= '?>';
$s .= $c;
$phar->setStub($hashbang . $s);
} else {
$phar->setStub($hashbang . $c);
}
return new SplFileInfo($stub);
}
return NULL;
}
// }}}
// {{{ function phar_set_stub_end
/**
* Set stub end
*/
public function phar_set_stub_end(Phar $phar, $stub, $loader = NULL)
{
if (isset($stub) && isset($loader)) {
if (substr(__FILE__, -15) == 'pharcommand.inc') {
self::phar_add_file($phar, 0, 'phar.inc', 'phar://'.__FILE__.'/phar.inc', NULL);
} else {
self::phar_add_file($phar, 0, 'phar.inc', dirname(__FILE__).'/phar/phar.inc', NULL);
}
}
}
// }}}
// {{{ function cli_cmd_run_pack
/**
* Pack a new Phar
*
* This function will try to pack a new Phar archive.
*
* @see Exit to make sure that we are done.
*/
public function cli_cmd_run_pack()
{
if (ini_get('phar.readonly')) {
self::error("Creating phar files is disabled by ini setting 'phar.readonly'.\n");
}
if (!Phar::canWrite()) {
self::error("Creating phar files is disabled, Phar::canWrite() returned false.\n");
}
$alias = $this->args['a']['val'];
$hashbang = $this->args['b']['val'];
$archive = $this->args['f']['val'];
$hash = $this->args['h']['val'];
$privkey = $this->args['y']['val'];
$regex = $this->args['i']['val'];
$level = $this->args['l']['val'];
$loader = $this->args['p']['val'];
$stub = $this->args['s']['val'];
$invregex = $this->args['x']['val'];
$input = $this->args['']['val'];
$hash = self::phar_check_hash($hash, $privkey);
$phar = new Phar($archive, 0, $alias);
$phar->startBuffering();
$stub = $this->phar_set_stub_begin($phar, $stub, $loader, $hashbang);
if (!is_array($input)) {
$this->phar_add($phar, $level, $input, $regex, $invregex, $stub, NULL, isset($loader));
} else {
foreach($input as $i) {
$this->phar_add($phar, $level, $i, $regex, $invregex, $stub, NULL, isset($loader));
}
}
$this->phar_set_stub_end($phar, $stub, $loader);
switch($this->args['c']['val']) {
case 'gz':
case 'gzip':
$phar->compressFiles(Phar::GZ);
break;
case 'bz2':
case 'bzip2':
$phar->compressFiles(Phar::BZ2);
break;
default:
$phar->decompressFiles();
break;
}
if ($hash) {
$phar->setSignatureAlgorithm($hash, $privkey);
}
$phar->stopBuffering();
exit(0);
}
// }}}
// {{{ static function phar_add
/**
* Add files to a phar archive.
*
* This function will take a directory and iterate through
* it and get the files to insert into the Phar archive.
*
* @param Phar $phar The phar object.
* @param string $input The input directory
* @param string $regex The regex used in RegexIterator.
* @param string $invregex The InvertedRegexIterator expression.
* @param SplFileInfo $stub Stub file object
* @param mixed $compress Compression algorithm or NULL
* @param boolean $noloader Whether to prevent adding the loader
*/
static function phar_add(Phar $phar, $level, $input, $regex, $invregex, SplFileInfo $stub = NULL, $compress = NULL, $noloader = false)
{
if ($input && is_file($input) && !is_dir($input)) {
return self::phar_add_file($phar, $level, $input, $input, $compress);
}
$dir = new RecursiveDirectoryIterator($input);
$dir = new RecursiveIteratorIterator($dir);
if (isset($regex)) {
$dir = new RegexIterator($dir, $regex);
}
if (isset($invregex)) {
$dir = new InvertedRegexIterator($dir, $invregex);
}
try {
foreach($dir as $file) {
if ((empty($stub) || $file->getRealPath() != $stub->getRealPath()) && !is_dir($file)) {
self::phar_add_file($phar, $level, $dir->getSubPathName(), $file, $compress, $noloader);
}
}
} catch(Excpetion $e) {
self::error("Unable to complete operation on file '$file'\n" . $e->getMessage() . "\n");
}
}
// }}}
// {{{ static function phar_add_file
/**
* Add a phar file
*
* This function adds a file to a phar archive.
*
* @param Phar $phar The phar object
* @param string $level The level of the file.
* @param string $entry The entry point
* @param string $file The file to add to the archive
* @param string $compress The compression scheme for the file.
* @param boolean $noloader Whether to prevent adding the loader
*/
static function phar_add_file(Phar $phar, $level, $entry, $file, $compress, $noloader = false)
{
$entry = str_replace('//', '/', $entry);
while($level-- > 0 && ($p = strpos($entry, '/')) !== false) {
$entry = substr($entry, $p+1);
}
if ($noloader && $entry == 'phar.inc') {
return;
}
echo "$entry\n";
$phar[$entry] = file_get_contents($file);
switch($compress) {
case 'gz':
case 'gzip':
$phar[$entry]->compress(Phar::GZ);
break;
case 'bz2':
case 'bzip2':
$phar[$entry]->compress(Phar::BZ2);
break;
case '0':
$phar[$entry]->decompress();
break;
default:
break;
}
}
// }}}
// {{{ public function phar_dir_echo
/**
* Echo directory
*
* @param string $pn
* @param unknown_type $f
*/
public function phar_dir_echo($pn, $f)
{
echo "$f\n";
}
// }}}
// {{{ public function phar_dir_operation
/**
* Directory operations
*
* Phar directory operations.
*
* @param RecursiveIteratorIterator $dir The recursiveIteratorIterator object.
* @param string $func Function to call on the iterations
* @param array $args Function arguments.
*/
public function phar_dir_operation(RecursiveIteratorIterator $dir, $func, array $args = array())
{
$regex = $this->args['i']['val'];
$invregex= $this->args['x']['val'];
if (isset($regex)) {
$dir = new RegexIterator($dir, $regex);
}
if (isset($invregex)) {
$dir = new InvertedRegexIterator($dir, $invregex);
}
$any = false;
foreach($dir as $pn => $f) {
$any = true;
call_user_func($func, $pn, $f, $args);
}
return $any;
}
// {{{ static function cli_cmd_inf_list
/**
* Cli Command Info List
*
* @return string What inf does
*/
static function cli_cmd_inf_list()
{
return "List contents of a PHAR archive.";
}
// }}}
// {{{ static function cli_cmd_arg_list
/**
* Cli Command Argument List
*
* @return arguments list
*/
static function cli_cmd_arg_list()
{
return self::phar_args('Fix', 'pharurl');
}
// }}}
// {{{ public function cli_cmd_run_list
/**
* Cli Command Run List
*
* @see $this->phar_dir_operation
*/
public function cli_cmd_run_list()
{
$this->phar_dir_operation(
new DirectoryTreeIterator(
$this->args['f']['val']),
array($this, 'phar_dir_echo')
);
}
// }}}
// {{{ static function cli_command_inf_tree
/**
* Cli Command Inf Tree
*
* @return string The description of a directory tree for a Phar archive.
*/
static function cli_cmd_inf_tree()
{
return "Get a directory tree for a PHAR archive.";
}
// }}}
// {{{ static function cli_cmd_arg_tree
/**
* Cli Command Argument Tree
*
* @return string Arguments in URL format.
*/
static function cli_cmd_arg_tree()
{
return self::phar_args('Fix', 'pharurl');
}
// }}}
// {{{ public function cli_cmd_run_tree
/**
* Cli Command Run Tree
*
* Set the phar_dir_operation with a directorygraphiterator.
*
* @see DirectoryGraphIterator
* @see $this->phar_dir_operation
*
*/
public function cli_cmd_run_tree()
{
$a = $this->phar_dir_operation(
new DirectoryGraphIterator(
$this->args['f']['val']),
array($this, 'phar_dir_echo')
);
if (!$a) {
echo "|-<root directory>\n";
}
}
// }}}
// {{{ cli_cmd_inf_extract
/**
* Cli Command Inf Extract
*
* @return string The description of the command extra to a directory.
*/
static function cli_cmd_inf_extract()
{
return "Extract a PHAR package to a directory.";
}
// }}}
// {{{ static function cli_cmd_arg_extract
/**
* Cli Command Arguments Extract
*
* The arguments for the extract function.
*
* @return array The arguments for the extraction.
*/
static function cli_cmd_arg_extract()
{
$args = self::phar_args('Fix', 'phar');
$args[''] = array(
'type' => 'dir',
'val' => '.',
'inf' => ' Directory to extract to (defaults to \'.\').',
);
return $args;
}
// }}}
// {{{ public function cli_cmd_run_extract
/**
* Run Extract
*
* Run the extraction of a phar Archive.
*
* @see $this->phar_dir_operation
*/
public function cli_cmd_run_extract()
{
$dir = $this->args['']['val'];
if (is_array($dir)) {
if (count($dir) != 1) {
self::error("Only one target directory allowed.\n");
} else {
$dir = $dir[0];
}
}
$phar = $this->args['f']['val'];
$base = $phar->getPathname();
$bend = strpos($base, '.phar');
$bend = strpos($base, '/', $bend);
$base = substr($base, 0, $bend + 1);
$blen = strlen($base);
$this->phar_dir_operation(
new RecursiveIteratorIterator($phar),
array($this, 'phar_dir_extract'),
array($blen, $dir)
);
}
// }}}
// {{{ public function phar_dir_extract
/**
* Extract to a directory
*
* This function will extract the content of a Phar
* to a directory and create new files and directories
* depending on the permissions on that folder.
*
* @param string $pn
* @param string $f The file name
* @param array $args The directory and Blen informations
*/
public function phar_dir_extract($pn, $f, $args)
{
$blen = $args[0];
$dir = $args[1];
$sub = substr($pn, $blen);
$target = $dir . '/' . $sub;
if (!file_exists(dirname($target))) {
@mkdir(dirname($target), 0777, true);
}
if (!file_exists(dirname($target))) {
self::error("Operation could not be completed\n");
}
echo "$sub";
if (!@copy($f, $target)) {
echo " ...error\n";
} else {
echo " ...ok\n";
}
}
// }}}
// {{{ static function cli_cmd_inf_delete
/**
* Delete an entry from a phar information.
*
* @return string The information
*/
static function cli_cmd_inf_delete()
{
return 'Delete entry from a PHAR archive';
}
// }}}
// {{{ static function cli_cmd_arg_delete
/**
* The cli command argument for deleting.
*
* @return array informations about the arguments to use.
*/
static function cli_cmd_arg_delete()
{
return self::phar_args('FE', 'phar');
}
// }}}
// {{{ public function cli_cmd_run_delete
/**
* Deleting execution
*
* Execute the deleting of the file from the phar archive.
*/
public function cli_cmd_run_delete()
{
$phar = $this->args['f']['val'];
$entry = $this->args['e']['val'];
$phar->startBuffering();
unset($phar[$entry]);
$phar->stopBuffering();
}
// }}}
// {{{ static function cli_cmd_inf_add
/**
* Client comment add file information
*
* @return string The description of the feature
*/
static function cli_cmd_inf_add()
{
return "Add entries to a PHAR package.";
}
// }}}
// {{{ static function cli_cmd_arg_add
/**
* Add a file arguments
*/
static function cli_cmd_arg_add()
{
$args = self::phar_args('acFilx', 'phar');
$args[''] = array(
'type' => 'any',
'val' => NULL,
'required' => 1,
'inf' => ' Any number of input files and directories. If -i is in use then ONLY files and matching the given regular expression are being packed. If -x is given then files matching that regular expression are NOT being packed.',
);
return $args;
}
// }}}
// {{{ public functio cli_cmd_run_add
/**
* Add a file
*
* Run the action of adding a file to
* a phar archive.
*/
public function cli_cmd_run_add()
{
$compress= $this->args['c']['val'];
$phar = $this->args['f']['val'];
$regex = $this->args['i']['val'];