/
composer-setup.php
5446 lines (5110 loc) · 299 KB
/
composer-setup.php
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
/*
* This file is part of Composer.
*
* (c) Nils Adermann <naderman@naderman.de>
* Jordi Boggiano <j.boggiano@seld.be>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
process(is_array($argv) ? $argv : array());
/**
* processes the installer
*/
function process($argv)
{
// Determine ANSI output from --ansi and --no-ansi flags
setUseAnsi($argv);
if (in_array('--help', $argv)) {
displayHelp();
exit(0);
}
$check = in_array('--check', $argv);
$help = in_array('--help', $argv);
$force = in_array('--force', $argv);
$quiet = in_array('--quiet', $argv);
$channel = in_array('--snapshot', $argv) ? 'snapshot' : (in_array('--preview', $argv) ? 'preview' : 'stable');
$disableTls = in_array('--disable-tls', $argv);
$installDir = getOptValue('--install-dir', $argv, false);
$version = getOptValue('--version', $argv, false);
$filename = getOptValue('--filename', $argv, 'composer.phar');
$cafile = getOptValue('--cafile', $argv, false);
if (!checkParams($installDir, $version, $cafile)) {
exit(1);
}
$ok = checkPlatform($warnings, $quiet, $disableTls, true);
if ($check) {
// Only show warnings if we haven't output any errors
if ($ok) {
showWarnings($warnings);
showSecurityWarning($disableTls);
}
exit($ok ? 0 : 1);
}
if ($ok || $force) {
$installer = new Installer($quiet, $disableTls, $cafile);
if ($installer->run($version, $installDir, $filename, $channel)) {
showWarnings($warnings);
showSecurityWarning($disableTls);
exit(0);
}
}
exit(1);
}
/**
* displays the help
*/
function displayHelp()
{
echo <<<EOF
Composer Installer
------------------
Options
--help this help
--check for checking environment only
--force forces the installation
--ansi force ANSI color output
--no-ansi disable ANSI color output
--quiet do not output unimportant messages
--install-dir="..." accepts a target installation directory
--preview install the latest version from the preview (alpha/beta/rc) channel instead of stable
--snapshot install the latest version from the snapshot (dev builds) channel instead of stable
--version="..." accepts a specific version to install instead of the latest
--filename="..." accepts a target filename (default: composer.phar)
--disable-tls disable SSL/TLS security for file downloads
--cafile="..." accepts a path to a Certificate Authority (CA) certificate file for SSL/TLS verification
EOF;
}
/**
* Sets the USE_ANSI define for colorizing output
*
* @param array $argv Command-line arguments
*/
function setUseAnsi($argv)
{
// --no-ansi wins over --ansi
if (in_array('--no-ansi', $argv)) {
define('USE_ANSI', false);
} elseif (in_array('--ansi', $argv)) {
define('USE_ANSI', true);
} else {
// On Windows, default to no ANSI, except in ANSICON and ConEmu.
// Everywhere else, default to ANSI if stdout is a terminal.
define(
'USE_ANSI',
(DIRECTORY_SEPARATOR == '\\')
? (false !== getenv('ANSICON') || 'ON' === getenv('ConEmuANSI'))
: (function_exists('posix_isatty') && posix_isatty(1))
);
}
}
/**
* Returns the value of a command-line option
*
* @param string $opt The command-line option to check
* @param array $argv Command-line arguments
* @param mixed $default Default value to be returned
*
* @return mixed The command-line value or the default
*/
function getOptValue($opt, $argv, $default)
{
$optLength = strlen($opt);
foreach ($argv as $key => $value) {
$next = $key + 1;
if (0 === strpos($value, $opt)) {
if ($optLength === strlen($value) && isset($argv[$next])) {
return trim($argv[$next]);
} else {
return trim(substr($value, $optLength + 1));
}
}
}
return $default;
}
/**
* Checks that user-supplied params are valid
*
* @param mixed $installDir The required istallation directory
* @param mixed $version The required composer version to install
* @param mixed $cafile Certificate Authority file
*
* @return bool True if the supplied params are okay
*/
function checkParams($installDir, $version, $cafile)
{
$result = true;
if (false !== $installDir && !is_dir($installDir)) {
out("The defined install dir ({$installDir}) does not exist.", 'info');
$result = false;
}
if (false !== $version && 1 !== preg_match('/^\d+\.\d+\.\d+(\-(alpha|beta|RC)\d*)*$/', $version)) {
out("The defined install version ({$version}) does not match release pattern.", 'info');
$result = false;
}
if (false !== $cafile && (!file_exists($cafile) || !is_readable($cafile))) {
out("The defined Certificate Authority (CA) cert file ({$cafile}) does not exist or is not readable.", 'info');
$result = false;
}
return $result;
}
/**
* Checks the platform for possible issues running Composer
*
* Errors are written to the output, warnings are saved for later display.
*
* @param array $warnings Populated by method, to be shown later
* @param bool $quiet Quiet mode
* @param bool $disableTls Bypass tls
* @param bool $install If we are installing, rather than diagnosing
*
* @return bool True if there are no errors
*/
function checkPlatform(&$warnings, $quiet, $disableTls, $install)
{
getPlatformIssues($errors, $warnings, $install);
// Make openssl warning an error if tls has not been specifically disabled
if (isset($warnings['openssl']) && !$disableTls) {
$errors['openssl'] = $warnings['openssl'];
unset($warnings['openssl']);
}
if (!empty($errors)) {
out('Some settings on your machine make Composer unable to work properly.', 'error');
out('Make sure that you fix the issues listed below and run this script again:', 'error');
outputIssues($errors);
return false;
}
if (empty($warnings) && !$quiet) {
out('All settings correct for using Composer', 'success');
}
return true;
}
/**
* Checks platform configuration for common incompatibility issues
*
* @param array $errors Populated by method
* @param array $warnings Populated by method
* @param bool $install If we are installing, rather than diagnosing
*
* @return bool If any errors or warnings have been found
*/
function getPlatformIssues(&$errors, &$warnings, $install)
{
$errors = array();
$warnings = array();
if ($iniPath = php_ini_loaded_file()) {
$iniMessage = PHP_EOL.'The php.ini used by your command-line PHP is: ' . $iniPath;
} else {
$iniMessage = PHP_EOL.'A php.ini file does not exist. You will have to create one.';
}
$iniMessage .= PHP_EOL.'If you can not modify the ini file, you can also run `php -d option=value` to modify ini values on the fly. You can use -d multiple times.';
if (ini_get('detect_unicode')) {
$errors['unicode'] = array(
'The detect_unicode setting must be disabled.',
'Add the following to the end of your `php.ini`:',
' detect_unicode = Off',
$iniMessage
);
}
if (extension_loaded('suhosin')) {
$suhosin = ini_get('suhosin.executor.include.whitelist');
$suhosinBlacklist = ini_get('suhosin.executor.include.blacklist');
if (false === stripos($suhosin, 'phar') && (!$suhosinBlacklist || false !== stripos($suhosinBlacklist, 'phar'))) {
$errors['suhosin'] = array(
'The suhosin.executor.include.whitelist setting is incorrect.',
'Add the following to the end of your `php.ini` or suhosin.ini (Example path [for Debian]: /etc/php5/cli/conf.d/suhosin.ini):',
' suhosin.executor.include.whitelist = phar '.$suhosin,
$iniMessage
);
}
}
if (!function_exists('json_decode')) {
$errors['json'] = array(
'The json extension is missing.',
'Install it or recompile php without --disable-json'
);
}
if (!extension_loaded('Phar')) {
$errors['phar'] = array(
'The phar extension is missing.',
'Install it or recompile php without --disable-phar'
);
}
if (!extension_loaded('filter')) {
$errors['filter'] = array(
'The filter extension is missing.',
'Install it or recompile php without --disable-filter'
);
}
if (!extension_loaded('hash')) {
$errors['hash'] = array(
'The hash extension is missing.',
'Install it or recompile php without --disable-hash'
);
}
if (!extension_loaded('iconv') && !extension_loaded('mbstring')) {
$errors['iconv_mbstring'] = array(
'The iconv OR mbstring extension is required and both are missing.',
'Install either of them or recompile php without --disable-iconv'
);
}
if (!ini_get('allow_url_fopen')) {
$errors['allow_url_fopen'] = array(
'The allow_url_fopen setting is incorrect.',
'Add the following to the end of your `php.ini`:',
' allow_url_fopen = On',
$iniMessage
);
}
if (extension_loaded('ionCube Loader') && ioncube_loader_iversion() < 40009) {
$ioncube = ioncube_loader_version();
$errors['ioncube'] = array(
'Your ionCube Loader extension ('.$ioncube.') is incompatible with Phar files.',
'Upgrade to ionCube 4.0.9 or higher or remove this line (path may be different) from your `php.ini` to disable it:',
' zend_extension = /usr/lib/php5/20090626+lfs/ioncube_loader_lin_5.3.so',
$iniMessage
);
}
if (version_compare(PHP_VERSION, '5.3.2', '<')) {
$errors['php'] = array(
'Your PHP ('.PHP_VERSION.') is too old, you must upgrade to PHP 5.3.2 or higher.'
);
}
if (version_compare(PHP_VERSION, '5.3.4', '<')) {
$warnings['php'] = array(
'Your PHP ('.PHP_VERSION.') is quite old, upgrading to PHP 5.3.4 or higher is recommended.',
'Composer works with 5.3.2+ for most people, but there might be edge case issues.'
);
}
if (!extension_loaded('openssl')) {
$warnings['openssl'] = array(
'The openssl extension is missing, which means that secure HTTPS transfers are impossible.',
'If possible you should enable it or recompile php with --with-openssl'
);
}
if (extension_loaded('openssl') && OPENSSL_VERSION_NUMBER < 0x1000100f) {
// Attempt to parse version number out, fallback to whole string value.
$opensslVersion = trim(strstr(OPENSSL_VERSION_TEXT, ' '));
$opensslVersion = substr($opensslVersion, 0, strpos($opensslVersion, ' '));
$opensslVersion = $opensslVersion ? $opensslVersion : OPENSSL_VERSION_TEXT;
$warnings['openssl_version'] = array(
'The OpenSSL library ('.$opensslVersion.') used by PHP does not support TLSv1.2 or TLSv1.1.',
'If possible you should upgrade OpenSSL to version 1.0.1 or above.'
);
}
if (!defined('HHVM_VERSION') && !extension_loaded('apcu') && ini_get('apc.enable_cli')) {
$warnings['apc_cli'] = array(
'The apc.enable_cli setting is incorrect.',
'Add the following to the end of your `php.ini`:',
' apc.enable_cli = Off',
$iniMessage
);
}
if (!$install && extension_loaded('xdebug')) {
$warnings['xdebug_loaded'] = array(
'The xdebug extension is loaded, this can slow down Composer a little.',
'Disabling it when using Composer is recommended.'
);
if (ini_get('xdebug.profiler_enabled')) {
$warnings['xdebug_profile'] = array(
'The xdebug.profiler_enabled setting is enabled, this can slow down Composer a lot.',
'Add the following to the end of your `php.ini` to disable it:',
' xdebug.profiler_enabled = 0',
$iniMessage
);
}
}
if (!extension_loaded('zlib')) {
$warnings['zlib'] = array(
'The zlib extension is not loaded, this can slow down Composer a lot.',
'If possible, install it or recompile php with --with-zlib',
$iniMessage
);
}
ob_start();
phpinfo(INFO_GENERAL);
$phpinfo = ob_get_clean();
if (preg_match('{Configure Command(?: *</td><td class="v">| *=> *)(.*?)(?:</td>|$)}m', $phpinfo, $match)) {
$configure = $match[1];
if (false !== strpos($configure, '--enable-sigchild')) {
$warnings['sigchild'] = array(
'PHP was compiled with --enable-sigchild which can cause issues on some platforms.',
'Recompile it without this flag if possible, see also:',
' https://bugs.php.net/bug.php?id=22999'
);
}
if (false !== strpos($configure, '--with-curlwrappers')) {
$warnings['curlwrappers'] = array(
'PHP was compiled with --with-curlwrappers which will cause issues with HTTP authentication and GitHub.',
'Recompile it without this flag if possible'
);
}
}
// Stringify the message arrays
foreach ($errors as $key => $value) {
$errors[$key] = PHP_EOL.implode(PHP_EOL, $value);
}
foreach ($warnings as $key => $value) {
$warnings[$key] = PHP_EOL.implode(PHP_EOL, $value);
}
return !empty($errors) || !empty($warnings);
}
/**
* Outputs an array of issues
*
* @param array $issues
*/
function outputIssues($issues)
{
foreach ($issues as $issue) {
out($issue, 'info');
}
out('');
}
/**
* Outputs any warnings found
*
* @param array $warnings
*/
function showWarnings($warnings)
{
if (!empty($warnings)) {
out('Some settings on your machine may cause stability issues with Composer.', 'error');
out('If you encounter issues, try to change the following:', 'error');
outputIssues($warnings);
}
}
/**
* Outputs an end of process warning if tls has been bypassed
*
* @param bool $disableTls Bypass tls
*/
function showSecurityWarning($disableTls)
{
if ($disableTls) {
out('You have instructed the Installer not to enforce SSL/TLS security on remote HTTPS requests.', 'info');
out('This will leave all downloads during installation vulnerable to Man-In-The-Middle (MITM) attacks', 'info');
}
}
/**
* colorize output
*/
function out($text, $color = null, $newLine = true)
{
$styles = array(
'success' => "\033[0;32m%s\033[0m",
'error' => "\033[31;31m%s\033[0m",
'info' => "\033[33;33m%s\033[0m"
);
$format = '%s';
if (isset($styles[$color]) && USE_ANSI) {
$format = $styles[$color];
}
if ($newLine) {
$format .= PHP_EOL;
}
printf($format, $text);
}
/**
* Returns the system-dependent Composer home location, which may not exist
*
* @return string
*/
function getHomeDir()
{
$home = getenv('COMPOSER_HOME');
if (!$home) {
$userDir = getUserDir();
if (defined('PHP_WINDOWS_VERSION_MAJOR')) {
$home = $userDir.'/Composer';
} else {
$home = $userDir.'/.composer';
if (!is_dir($home) && useXdg()) {
// XDG Base Directory Specifications
if (!($xdgConfig = getenv('XDG_CONFIG_HOME'))) {
$xdgConfig = $userDir.'/.config';
}
$home = $xdgConfig.'/composer';
}
}
}
return $home;
}
/**
* Returns the location of the user directory from the environment
* @throws RuntimeException If the environment value does not exists
*
* @return string
*/
function getUserDir()
{
$userEnv = defined('PHP_WINDOWS_VERSION_MAJOR') ? 'APPDATA' : 'HOME';
$userDir = getenv($userEnv);
if (!$userDir) {
throw new RuntimeException('The '.$userEnv.' or COMPOSER_HOME environment variable must be set for composer to run correctly');
}
return rtrim(strtr($userDir, '\\', '/'), '/');
}
/**
* @return bool
*/
function useXdg()
{
foreach (array_keys($_SERVER) as $key) {
if (substr($key, 0, 4) === 'XDG_') {
return true;
}
}
return false;
}
function validateCaFile($contents)
{
// assume the CA is valid if php is vulnerable to
// https://www.sektioneins.de/advisories/advisory-012013-php-openssl_x509_parse-memory-corruption-vulnerability.html
if (
PHP_VERSION_ID <= 50327
|| (PHP_VERSION_ID >= 50400 && PHP_VERSION_ID < 50422)
|| (PHP_VERSION_ID >= 50500 && PHP_VERSION_ID < 50506)
) {
return !empty($contents);
}
return (bool) openssl_x509_parse($contents);
}
class Installer
{
private $quiet;
private $disableTls;
private $cafile;
private $installPath;
private $target;
private $tmpFile;
private $baseUrl;
private $algo;
private $errHandler;
private $httpClient;
private $pubKeys = array();
private $installs = array();
/**
* Constructor - must not do anything that throws an exception
*
* @param bool $quiet Quiet mode
* @param bool $disableTls Bypass tls
* @param mixed $cafile Path to CA bundle, or false
*/
public function __construct($quiet, $disableTls, $caFile)
{
if (($this->quiet = $quiet)) {
ob_start();
}
$this->disableTls = $disableTls;
$this->cafile = $caFile;
$this->errHandler = new ErrorHandler();
}
/**
* Runs the installer
*
* @param mixed $version Specific version to install, or false
* @param mixed $installDir Specific installation directory, or false
* @param string $filename Specific filename to save to, or composer.phar
* @param string $channel Specific version channel to use
* @throws Exception If anything other than a RuntimeException is caught
*
* @return bool If the installation succeeded
*/
public function run($version, $installDir, $filename, $channel)
{
try {
$this->initTargets($installDir, $filename);
$this->initTls();
$this->httpClient = new HttpClient($this->disableTls, $this->cafile);
$result = $this->install($version, $channel);
if ($result && $channel !== 'stable' && !$version && defined('PHP_BINARY')) {
$null = (defined('PHP_WINDOWS_VERSION_MAJOR') ? 'NUL' : '/dev/null');
@exec(escapeshellarg(PHP_BINARY) .' '.escapeshellarg($this->target).' self-update --'.$channel.' --set-channel-only -q > '.$null.' 2> '.$null, $output);
}
} catch (Exception $e) {
$result = false;
}
// Always clean up
$this->cleanUp($result);
if (isset($e)) {
// Rethrow anything that is not a RuntimeException
if (!$e instanceof RuntimeException) {
throw $e;
}
out($e->getMessage(), 'error');
}
return $result;
}
/**
* Initialization methods to set the required filenames and composer url
*
* @param mixed $installDir Specific installation directory, or false
* @param string $filename Specific filename to save to, or composer.phar
* @throws RuntimeException If the installation directory is not writable
*/
protected function initTargets($installDir, $filename)
{
$this->installPath = (is_dir($installDir) ? rtrim($installDir, '/').'/' : '').$filename;
$installDir = realpath($installDir) ? realpath($installDir) : getcwd();
if (!is_writeable($installDir)) {
throw new RuntimeException('The installation directory "'.$installDir.'" is not writable');
}
$this->target = $installDir.DIRECTORY_SEPARATOR.$filename;
$this->tmpFile = $installDir.DIRECTORY_SEPARATOR.basename($this->target, '.phar').'-temp.phar';
$uriScheme = $this->disableTls ? 'http' : 'https';
$this->baseUrl = $uriScheme.'://getcomposer.org';
}
/**
* A wrapper around methods to check tls and write public keys
* @throws RuntimeException If SHA384 is not supported
*/
protected function initTls()
{
if ($this->disableTls) {
return;
}
if (!in_array('SHA384', openssl_get_md_methods())) {
throw new RuntimeException('SHA384 is not supported by your openssl extension');
}
$this->algo = defined('OPENSSL_ALGO_SHA384') ? OPENSSL_ALGO_SHA384 : 'SHA384';
$home = $this->getComposerHome();
$this->pubKeys = array(
'dev' => $this->installKey(self::getPKDev(), $home, 'keys.dev.pub'),
'tags' => $this->installKey(self::getPKTags(), $home, 'keys.tags.pub')
);
if (empty($this->cafile) && !HttpClient::getSystemCaRootBundlePath()) {
$this->cafile = $this->installKey(HttpClient::getPackagedCaFile(), $home, 'cacert.pem');
}
}
/**
* Returns the Composer home directory, creating it if required
* @throws RuntimeException If the directory cannot be created
*
* @return string
*/
protected function getComposerHome()
{
$home = getHomeDir();
if (!is_dir($home)) {
$this->errHandler->start();
if (!mkdir($home, 0777, true)) {
throw new RuntimeException(sprintf(
'Unable to create Composer home directory "%s": %s',
$home,
$this->errHandler->message
));
}
$this->installs[] = $home;
$this->errHandler->stop();
}
return $home;
}
/**
* Writes public key data to disc
*
* @param string $data The public key(s) in pem format
* @param string $path The directory to write to
* @param string $filename The name of the file
* @throws RuntimeException If the file cannot be written
*
* @return string The path to the saved data
*/
protected function installKey($data, $path, $filename)
{
$this->errHandler->start();
$target = $path.DIRECTORY_SEPARATOR.$filename;
$installed = file_exists($target);
$write = file_put_contents($target, $data, LOCK_EX);
@chmod($target, 0644);
$this->errHandler->stop();
if (!$write) {
throw new RuntimeException(sprintf('Unable to write %s to: %s', $filename, $path));
}
if (!$installed) {
$this->installs[] = $target;
}
return $target;
}
/**
* The main install function
*
* @param mixed $version Specific version to install, or false
* @param string $channel Version channel to use
*
* @return bool If the installation succeeded
*/
protected function install($version, $channel)
{
$retries = 3;
$result = false;
$infoMsg = 'Downloading...';
$infoType = 'info';
while ($retries--) {
if (!$this->quiet) {
out($infoMsg, $infoType);
$infoMsg = 'Retrying...';
$infoType = 'error';
}
if (!$this->getVersion($channel, $version, $url, $error)) {
out($error, 'error');
continue;
}
if (!$this->downloadToTmp($url, $signature, $error)) {
out($error, 'error');
continue;
}
if (!$this->verifyAndSave($version, $signature, $error)) {
out($error, 'error');
continue;
}
$result = true;
break;
}
if (!$this->quiet) {
if ($result) {
out(PHP_EOL."Composer (version {$version}) successfully installed to: {$this->target}", 'success');
out("Use it: php {$this->installPath}", 'info');
out('');
} else {
out('The download failed repeatedly, aborting.', 'error');
}
}
return $result;
}
/**
* Sets the version url, downloading version data if required
*
* @param string $channel Version channel to use
* @param false|string $version Version to install, or set by method
* @param null|string $url The versioned url, set by method
* @param null|string $error Set by method on failure
*
* @return bool If the operation succeeded
*/
protected function getVersion($channel, &$version, &$url, &$error)
{
$error = '';
if ($version) {
if (empty($url)) {
$url = $this->baseUrl."/download/{$version}/composer.phar";
}
return true;
}
$this->errHandler->start();
if ($this->downloadVersionData($data, $error)) {
$this->parseVersionData($data, $channel, $version, $url);
}
$this->errHandler->stop();
return empty($error);
}
/**
* Downloads and json-decodes version data
*
* @param null|array $data Downloaded version data, set by method
* @param null|string $error Set by method on failure
*
* @return bool If the operation succeeded
*/
protected function downloadVersionData(&$data, &$error)
{
$url = $this->baseUrl.'/versions';
$errFmt = 'The "%s" file could not be %s: %s';
if (!$json = $this->httpClient->get($url)) {
$error = sprintf($errFmt, $url, 'downloaded', $this->errHandler->message);
return false;
}
if (!$data = json_decode($json, true)) {
$error = sprintf($errFmt, $url, 'json-decoded', $this->getJsonError());
return false;
}
return true;
}
/**
* A wrapper around the methods needed to download and save the phar
*
* @param string $url The versioned download url
* @param null|string $signature Set by method on successful download
* @param null|string $error Set by method on failure
*
* @return bool If the operation succeeded
*/
protected function downloadToTmp($url, &$signature, &$error)
{
$error = '';
$errFmt = 'The "%s" file could not be downloaded: %s';
$sigUrl = $url.'.sig';
$this->errHandler->start();
if (!$fh = fopen($this->tmpFile, 'w')) {
$error = sprintf('Could not create file "%s": %s', $this->tmpFile, $this->errHandler->message);
} elseif (!$this->getSignature($sigUrl, $signature)) {
$error = sprintf($errFmt, $sigUrl, $this->errHandler->message);
} elseif (!fwrite($fh, $this->httpClient->get($url))) {
$error = sprintf($errFmt, $url, $this->errHandler->message);
}
if (is_resource($fh)) {
fclose($fh);
}
$this->errHandler->stop();
return empty($error);
}
/**
* Verifies the downloaded file and saves it to the target location
*
* @param string $version The composer version downloaded
* @param string $signature The digital signature to check
* @param null|string $error Set by method on failure
*
* @return bool If the operation succeeded
*/
protected function verifyAndSave($version, $signature, &$error)
{
$error = '';
if (!$this->validatePhar($this->tmpFile, $pharError)) {
$error = 'The download is corrupt: '.$pharError;
} elseif (!$this->verifySignature($version, $signature, $this->tmpFile)) {
$error = 'Signature mismatch, could not verify the phar file integrity';
} else {
$this->errHandler->start();
if (!rename($this->tmpFile, $this->target)) {
$error = sprintf('Could not write to file "%s": %s', $this->target, $this->errHandler->message);
}
chmod($this->target, 0755);
$this->errHandler->stop();
}
return empty($error);
}
/**
* Parses an array of version data to match the required channel
*
* @param array $data Downloaded version data
* @param mixed $channel Version channel to use
* @param false|string $version Set by method
* @param mixed $url The versioned url, set by method
*/
protected function parseVersionData(array $data, $channel, &$version, &$url)
{
foreach ($data[$channel] as $candidate) {
if ($candidate['min-php'] <= PHP_VERSION_ID) {
$version = $candidate['version'];
$url = $this->baseUrl.$candidate['path'];
break;
}
}
if (!$version) {
$error = sprintf(
'None of the %d %s version(s) of Composer matches your PHP version (%s / ID: %d)',
count($data[$channel]),
$channel,
PHP_VERSION,
PHP_VERSION_ID
);
throw new RuntimeException($error);
}
}
/**
* Downloads the digital signature of required phar file
*
* @param string $url The signature url
* @param null|string $signature Set by method on success
*
* @return bool If the download succeeded
*/
protected function getSignature($url, &$signature)
{
if (!$result = $this->disableTls) {
$signature = $this->httpClient->get($url);
if ($signature) {
$signature = json_decode($signature, true);
$signature = base64_decode($signature['sha384']);
$result = true;
}
}
return $result;
}
/**
* Verifies the signature of the downloaded phar
*
* @param string $version The composer versione
* @param string $signature The downloaded digital signature
* @param string $file The temp phar file
*
* @return bool If the operation succeeded
*/
protected function verifySignature($version, $signature, $file)
{
if (!$result = $this->disableTls) {
$path = preg_match('{^[0-9a-f]{40}$}', $version) ? $this->pubKeys['dev'] : $this->pubKeys['tags'];
$pubkeyid = openssl_pkey_get_public('file://'.$path);
$result = 1 === openssl_verify(
file_get_contents($file),
$signature,
$pubkeyid,
$this->algo
);
openssl_free_key($pubkeyid);
}
return $result;
}
/**
* Validates the downloaded phar file
*
* @param string $pharFile The temp phar file
* @param null|string $error Set by method on failure
*
* @return bool If the operation succeeded
*/
protected function validatePhar($pharFile, &$error)
{
if (ini_get('phar.readonly')) {
return true;
}
try {
// Test the phar validity
$phar = new Phar($pharFile);
// Free the variable to unlock the file
unset($phar);
$result = true;
} catch (Exception $e) {