forked from DataDog/dd-trace-php
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdatadog-setup.php
1328 lines (1217 loc) · 49.8 KB
/
datadog-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
// Tests for the installer are in 'dockerfiles/verify_packages/installer'
const INI_CONF = 'Scan this dir for additional .ini files';
const EXTENSION_DIR = 'extension_dir';
const THREAD_SAFETY = 'Thread Safety';
const PHP_API = 'PHP API';
const IS_DEBUG = 'Debug Build';
// Options
const OPT_HELP = 'help';
const OPT_INSTALL_DIR = 'install-dir';
const OPT_PHP_BIN = 'php-bin';
const OPT_FILE = 'file';
const OPT_UNINSTALL = 'uninstall';
const OPT_ENABLE_APPSEC = 'enable-appsec';
const OPT_ENABLE_PROFILING = 'enable-profiling';
// Release version is set while generating the final release files
const RELEASE_VERSION = '@release_version@';
// Supported platforms
const PLATFORM_X86_LINUX_GNU = 'x86_64-linux-gnu';
const PLATFORM_X86_LINUX_MUSL = 'x86_64-linux-musl';
function main()
{
if (is_truthy(getenv('DD_TEST_EXECUTION'))) {
return;
}
$options = parse_validate_user_options();
if ($options[OPT_UNINSTALL]) {
uninstall($options);
} else {
install($options);
}
}
function print_help()
{
echo <<<EOD
Usage:
Interactive
php get-dd-trace.php ...
Non-Interactive
php get-dd-trace.php --php-bin php ...
php get-dd-trace.php --php-bin php --php-bin /usr/local/sbin/php-fpm ...
Options:
-h, --help Print this help text and exit
--php-bin all|<path to php> Install the library to the specified binary or all php binaries in standard search
paths. The option can be provided multiple times.
--install-dir <path> Install to a specific directory. Default: '/opt/datadog'
--uninstall Uninstall the library from the specified binaries
--enable-appsec Enable the BETA appsec module.
--enable-profiling Enable the BETA profiling module.
EOD;
}
function install($options)
{
$platform = is_alpine() ? PLATFORM_X86_LINUX_MUSL : PLATFORM_X86_LINUX_GNU;
// Checking required libraries
check_library_prerequisite_or_exit('libcurl');
if (is_alpine()) {
check_library_prerequisite_or_exit('libexecinfo');
}
// Picking the right binaries to install the library
$selectedBinaries = require_binaries_or_exit($options);
$interactive = empty($options[OPT_PHP_BIN]);
// Preparing clean tmp folder to extract files
$tmpDir = sys_get_temp_dir() . '/dd-install';
$tmpDirTarGz = $tmpDir . "/dd-library-php-${platform}.tar.gz";
$tmpArchiveRoot = $tmpDir . '/dd-library-php';
$tmpArchiveTraceRoot = $tmpDir . '/dd-library-php/trace';
$tmpArchiveAppsecRoot = $tmpDir . '/dd-library-php/appsec';
$tmpArchiveAppsecBin = "${tmpArchiveAppsecRoot}/bin";
$tmpArchiveAppsecEtc = "${tmpArchiveAppsecRoot}/etc";
$tmpArchiveProfilingRoot = $tmpDir . '/dd-library-php/profiling';
$tmpBridgeDir = $tmpArchiveTraceRoot . '/bridge';
execute_or_exit("Cannot create directory '$tmpDir'", "mkdir -p " . escapeshellarg($tmpDir));
register_shutdown_function(function () use ($tmpDir) {
execute_or_exit("Cannot remove temporary directory '$tmpDir'", "rm -rf " . escapeshellarg($tmpDir));
});
execute_or_exit(
"Cannot clean '$tmpDir'",
"rm -rf " . escapeshellarg($tmpDir) . "/* "
);
// Retrieve and extract the archive to a tmp location
if (isset($options[OPT_FILE])) {
print_warning('--' . OPT_FILE . ' option is intended for internal usage and can be removed without notice');
$tmpDirTarGz = $options[OPT_FILE];
} else {
$version = RELEASE_VERSION;
// phpcs:disable Generic.Files.LineLength.TooLong
// For testing purposes, we need an alternate repo where we can push bundles that includes changes that we are
// trying to test, as the previously released versions would not have those changes.
$url = (getenv('DD_TEST_INSTALLER_REPO') ?: "https://github.com/DataDog/dd-trace-php")
. "/releases/download/${version}/dd-library-php-${version}-${platform}.tar.gz";
// phpcs:enable Generic.Files.LineLength.TooLong
download($url, $tmpDirTarGz);
unset($version);
}
execute_or_exit(
"Cannot extract the archive",
"tar -xf " . escapeshellarg($tmpDirTarGz) . " -C " . escapeshellarg($tmpDir)
);
$releaseVersion = trim(file_get_contents("$tmpArchiveRoot/VERSION"));
$installDir = $options[OPT_INSTALL_DIR] . '/' . $releaseVersion;
// Tracer sources
$installDirSourcesDir = $installDir . '/dd-trace-sources';
$installDirBridgeDir = $installDirSourcesDir . '/bridge';
$installDirWrapperPath = $installDirBridgeDir . '/dd_wrap_autoloader.php';
// copying sources to the final destination
execute_or_exit(
"Cannot create directory '$installDirSourcesDir'",
"mkdir -p " . escapeshellarg($installDirSourcesDir)
);
execute_or_exit(
"Cannot copy files from '$tmpBridgeDir' to '$installDirSourcesDir'",
"cp -r " . escapeshellarg("$tmpBridgeDir") . ' ' . escapeshellarg($installDirSourcesDir)
);
echo "Installed required source files to '$installDir'\n";
// Appsec helper and rules
execute_or_exit(
"Cannot copy files from '$tmpArchiveAppsecBin' to '$installDir'",
"cp -r " . escapeshellarg("$tmpArchiveAppsecBin") . ' ' . escapeshellarg($installDir)
);
execute_or_exit(
"Cannot copy files from '$tmpArchiveAppsecEtc' to '$installDir'",
"cp -r " . escapeshellarg("$tmpArchiveAppsecEtc") . ' ' . escapeshellarg($installDir)
);
$appSecRulesPath = $installDir . '/etc/recommended.json';
// Actual installation
foreach ($selectedBinaries as $command => $fullPath) {
$binaryForLog = ($command === $fullPath) ? $fullPath : "$command ($fullPath)";
echo "Installing to binary: $binaryForLog\n";
$phpMajorMinor = get_php_major_minor($fullPath);
check_php_ext_prerequisite_or_exit($fullPath, 'json');
$phpProperties = ini_values($fullPath);
if (is_truthy($phpProperties[THREAD_SAFETY]) && is_truthy($phpProperties[IS_DEBUG])) {
print_error_and_exit('(ZTS DEBUG) builds of PHP are currently not supported');
}
// Copying the extension
$extensionVersion = $phpProperties[PHP_API];
// Suffix (zts/debug/alpine)
$extensionSuffix = '';
if (is_truthy($phpProperties[IS_DEBUG])) {
$extensionSuffix = '-debug';
} elseif (is_truthy($phpProperties[THREAD_SAFETY])) {
$extensionSuffix = '-zts';
}
// Trace
$extensionRealPath = "$tmpArchiveTraceRoot/ext/$extensionVersion/ddtrace$extensionSuffix.so" ;
$extensionDestination = $phpProperties[EXTENSION_DIR] . '/ddtrace.so';
safe_copy_extension($extensionRealPath, $extensionDestination);
// Profiling
$shouldInstallProfiling =
in_array($phpMajorMinor, ['7.1', '7.2', '7.3', '7.4', '8.0'])
&& !is_truthy($phpProperties[THREAD_SAFETY])
&& !is_truthy($phpProperties[IS_DEBUG]);
if ($shouldInstallProfiling) {
$profilingExtensionRealPath = "$tmpArchiveProfilingRoot/ext/$extensionVersion/datadog-profiling.so";
$profilingExtensionDestination = $phpProperties[EXTENSION_DIR] . '/datadog-profiling.so';
safe_copy_extension($profilingExtensionRealPath, $profilingExtensionDestination);
}
// Appsec
$shouldInstallAppsec =
in_array($phpMajorMinor, ['7.0', '7.1', '7.2', '7.3', '7.4', '8.0', '8.1'])
&& !is_truthy($phpProperties[IS_DEBUG]);
if ($shouldInstallAppsec) {
$appsecExtensionRealPath = "${tmpArchiveAppsecRoot}/ext/${extensionVersion}/ddappsec${extensionSuffix}.so";
$appsecExtensionDestination = $phpProperties[EXTENSION_DIR] . '/ddappsec.so';
safe_copy_extension($appsecExtensionRealPath, $appsecExtensionDestination);
}
$appSecHelperPath = $installDir . '/bin/ddappsec-helper';
// Writing the ini file
$iniFileName = '98-ddtrace.ini';
$iniFilePaths = [$phpProperties[INI_CONF] . '/' . $iniFileName];
if (\strpos($phpProperties[INI_CONF], '/cli/conf.d') !== false) {
/* debian based distros have INI folders split by SAPI, in a predefined way:
* - <...>/cli/conf.d <-- we know this from php -i
* - <...>/apache2/conf.d <-- we derive this from relative path
* - <...>/fpm/conf.d <-- we derive this from relative path
*/
$apacheConfd = str_replace('/cli/conf.d', '/apache2/conf.d', $phpProperties[INI_CONF]);
if (\is_dir($apacheConfd)) {
array_push($iniFilePaths, "$apacheConfd/$iniFileName");
}
}
foreach ($iniFilePaths as $iniFilePath) {
if (!file_exists($iniFilePath)) {
$iniDir = dirname($iniFilePath);
execute_or_exit(
"Cannot create directory '$iniDir'",
"mkdir -p " . escapeshellarg($iniDir)
);
if (false === file_put_contents($iniFilePath, '')) {
print_error_and_exit("Cannot create INI file $iniFilePath");
}
echo "Created INI file '$iniFilePath'\n";
} else {
echo "Updating existing INI file '$iniFilePath'\n";
// phpcs:disable Generic.Files.LineLength.TooLong
execute_or_exit(
'Impossible to replace the deprecated ddtrace.request_init_hook parameter with the new name.',
"sed -i 's|ddtrace.request_init_hook|datadog.trace.request_init_hook|g' " . escapeshellarg($iniFilePath)
);
execute_or_exit(
'Impossible to update the INI settings file.',
"sed -i 's@datadog\.trace\.request_init_hook \?= \?\(.*\)@datadog.trace.request_init_hook = '" . escapeshellarg($installDirWrapperPath) . "'@g' " . escapeshellarg($iniFilePath)
);
// phpcs:enable Generic.Files.LineLength.TooLong
/* In order to support upgrading from legacy installation method to new installation method, we replace
* "extension = /opt/datadog-php/xyz.so" with "extension = ddtrace.so" honoring trailing `;`, hence not
* automatically re-activating the extension if the user had commented it out.
*/
execute_or_exit(
'Impossible to update the INI settings file.',
"sed -i 's@extension \?= \?.*ddtrace.*\(.*\)@extension = ddtrace.so@g' "
. escapeshellarg($iniFilePath)
);
}
add_missing_ini_settings(
$iniFilePath,
get_ini_settings($installDirWrapperPath, $appSecHelperPath, $appSecRulesPath)
);
// Enabling profiling
if (is_truthy($options[OPT_ENABLE_PROFILING])) {
// phpcs:disable Generic.Files.LineLength.TooLong
if ($shouldInstallProfiling) {
execute_or_exit(
'Impossible to update the INI settings file.',
"sed -i 's@ \?; \?zend_extension \?= \?datadog-profiling.so@zend_extension = datadog-profiling.so@g' "
. escapeshellarg($iniFilePath)
);
} else {
$enableProfiling = OPT_ENABLE_PROFILING;
print_error_and_exit("Option --${enableProfiling} was provided, but it is not supported on this PHP build or version.\n");
}
// phpcs:enable Generic.Files.LineLength.TooLong
}
// Enabling appsec
if (is_truthy($options[OPT_ENABLE_APPSEC])) {
if ($shouldInstallAppsec) {
// Appsec crashes with missing symbols if tracing is not loaded
execute_or_exit(
'Impossible to update the INI settings file.',
"sed -i 's@ \?; \?extension \?= \?ddtrace.so@extension = ddtrace.so@g' "
. escapeshellarg($iniFilePath)
);
execute_or_exit(
'Impossible to update the INI settings file.',
"sed -i 's@ \?; \?extension \?= \?ddappsec.so@extension = ddappsec.so@g' "
. escapeshellarg($iniFilePath)
);
} else {
$enableAppsec = OPT_ENABLE_APPSEC;
// phpcs:disable Generic.Files.LineLength.TooLong
print_error_and_exit("Option --${enableAppsec} was provided, but it is not supported on this PHP build or version.\n");
// phpcs:enable Generic.Files.LineLength.TooLong
}
}
echo "Installation to '$binaryForLog' was successful\n";
}
}
echo "--------------------------------------------------\n";
echo "SUCCESS\n\n";
if ($interactive) {
echo "To run this script in a non interactive mode, use the following options:\n";
$args = array_merge(
$_SERVER["argv"],
array_map(
function ($el) {
return '--php-bin=' . $el;
},
array_keys($selectedBinaries)
)
);
echo " php " . implode(" ", array_map("escapeshellarg", $args)) . "\n";
}
}
/**
* Copies an extension's file to a destination using copy+rename to avoid segfault if the file is loaded by php.
*
* @param string $source
* @param string $destination
* @return void
*/
function safe_copy_extension($source, $destination)
{
/* Move - rename() - instead of copy() since copying does a fopen() and copies to the stream itself, causing a
* segfault in the PHP process that is running and had loaded the old shared object file.
*/
$tmpName = $destination . '.tmp';
copy($source, $tmpName);
rename($tmpName, $destination);
echo "Copied '$source' to '$destination'\n";
}
function uninstall($options)
{
$selectedBinaries = require_binaries_or_exit($options);
foreach ($selectedBinaries as $command => $fullPath) {
$binaryForLog = ($command === $fullPath) ? $fullPath : "$command ($fullPath)";
echo "Uninstalling from binary: $binaryForLog\n";
$phpProperties = ini_values($fullPath);
$extensionDestinations = [
$phpProperties[EXTENSION_DIR] . '/ddtrace.so',
$phpProperties[EXTENSION_DIR] . '/datadog-profiling.so',
$phpProperties[EXTENSION_DIR] . '/ddappsec.so',
];
// Writing the ini file
$iniFileName = '98-ddtrace.ini';
$iniFilePaths = [$phpProperties[INI_CONF] . '/' . $iniFileName];
if (\strpos('/cli/conf.d', $phpProperties[INI_CONF]) >= 0) {
/* debian based distros have INI folders split by SAPI, in a predefined way:
* - <...>/cli/conf.d <-- we know this from php -i
* - <...>/apache2/conf.d <-- we derive this from relative path
* - <...>/fpm/conf.d <-- we derive this from relative path
*/
$apacheConfd = str_replace('/cli/conf.d', '/apache2/conf.d', $phpProperties[INI_CONF]);
if (\is_dir($apacheConfd)) {
array_push($iniFilePaths, "$apacheConfd/$iniFileName");
}
}
/* Actual uninstall
* 1) comment out extension=ddtrace.so
* 2) remove ddtrace.so
*/
foreach ($iniFilePaths as $iniFilePath) {
if (file_exists($iniFilePath)) {
execute_or_exit(
"Impossible to disable PHP modules from '$iniFilePath'. You can disable them manually.",
"sed -i 's@^extension \?=@;extension =@g' " . escapeshellarg($iniFilePath)
);
execute_or_exit(
"Impossible to disable Zend modules from '$iniFilePath'. You can disable them manually.",
"sed -i 's@^zend_extension \?=@;zend_extension =@g' " . escapeshellarg($iniFilePath)
);
echo "Disabled all modules in INI file '$iniFilePath'. "
. "The file has not been removed to preserve custom settings.\n";
}
}
$errors = false;
foreach ($extensionDestinations as $extensionDestination) {
if (file_exists($extensionDestination) && false === unlink($extensionDestination)) {
print_warning("Error while removing $extensionDestination. It can be manually removed.");
$errors = true;
}
}
if ($errors) {
echo "Uninstall from '$binaryForLog' was completed with warnings\n";
} else {
echo "Uninstall from '$binaryForLog' was successful\n";
}
}
}
/**
* Returns a list of php binaries where the library will be installed. If not explicitly provided by the CLI options,
* then the list is retrieved using an interactive session.
*
* @param array $options
* @return array
*/
function require_binaries_or_exit($options)
{
$selectedBinaries = [];
if (empty($options[OPT_PHP_BIN])) {
$selectedBinaries = pick_binaries_interactive(search_php_binaries());
} else {
foreach ($options[OPT_PHP_BIN] as $command) {
if ($command == "all") {
$selectedBinaries += search_php_binaries();
} elseif ($resolvedPath = resolve_command_full_path($command)) {
$selectedBinaries[$command] = $resolvedPath;
} else {
print_error_and_exit("Provided PHP binary '$command' was not found.\n");
}
}
}
if (empty($selectedBinaries)) {
print_error_and_exit("At least one binary must be specified\n");
}
return $selectedBinaries;
}
/**
* Checks if a library is available or not in an OS-independent way.
*
* @param string $requiredLibrary E.g. libcurl
* @return void
*/
function check_library_prerequisite_or_exit($requiredLibrary)
{
if (is_alpine()) {
$lastLine = execute_or_exit(
"Error while searching for library '$requiredLibrary'.",
"find /usr/local/lib /usr/lib -type f -name '*${requiredLibrary}*.so*'"
);
} else {
$lastLine = execute_or_exit(
"Cannot find library '$requiredLibrary'",
"ldconfig -p | grep $requiredLibrary"
);
}
if (empty($lastLine)) {
print_error_and_exit("Required library '$requiredLibrary' not found.\n");
}
}
/**
* Checks if an extension is enabled or not.
*
* @param string $binary
* @param string $requiredLibrary E.g. json
* @return void
*/
function check_php_ext_prerequisite_or_exit($binary, $extName)
{
$lastLine = execute_or_exit(
"Cannot retrieve extensions list",
// '|| true' is necessary because grep exits with 1 if the pattern was not found.
"$binary -m | grep '$extName' || true"
);
if (empty($lastLine)) {
print_error_and_exit("Required PHP extension '$extName' not found.\n");
}
}
/**
* @return bool
*/
function is_alpine()
{
$osInfoFile = '/etc/os-release';
// if /etc/os-release is not readable, we cannot tell and we assume NO
if (!is_readable($osInfoFile)) {
return false;
}
return false !== stripos(file_get_contents($osInfoFile), 'alpine');
}
/**
* Parses command line options provided by the user and generate a normalized $options array.
* @return array
*/
function parse_validate_user_options()
{
$shortOptions = "h";
$longOptions = [
OPT_HELP,
OPT_PHP_BIN . ':',
OPT_FILE . ':',
OPT_INSTALL_DIR . ':',
OPT_UNINSTALL,
OPT_ENABLE_APPSEC,
OPT_ENABLE_PROFILING,
];
$options = getopt($shortOptions, $longOptions);
global $argc;
if ($options === false || (empty($options) && $argc > 1)) {
/* Note that the above conditions are not as robust as I'd like.
* Consider:
* php datadog-setup.php --enable-profiling 0.69.0 --php-bin php
* getopt will stop at 0.69.0 as it doesn't recognize it, but it will
* return an array that only has enable-profiling in it.
* I don't see an obvious way out of this, but catching some failures
* here is better than not catching any.
*/
print_error_and_exit("Failed to parse options", true);
}
// Help and exit
if (key_exists('h', $options) || key_exists(OPT_HELP, $options)) {
print_help();
exit(0);
}
$normalizedOptions = [];
$normalizedOptions[OPT_UNINSTALL] = isset($options[OPT_UNINSTALL]) ? true : false;
if (!$normalizedOptions[OPT_UNINSTALL]) {
if (isset($options[OPT_FILE])) {
if (is_array($options[OPT_FILE])) {
print_error_and_exit('Only one --file can be provided', true);
}
$normalizedOptions[OPT_FILE] = $options[OPT_FILE];
}
}
if (isset($options[OPT_PHP_BIN])) {
$normalizedOptions[OPT_PHP_BIN] =
is_array($options[OPT_PHP_BIN])
? $options[OPT_PHP_BIN]
: [$options[OPT_PHP_BIN]];
}
$normalizedOptions[OPT_INSTALL_DIR] =
isset($options[OPT_INSTALL_DIR])
? rtrim($options[OPT_INSTALL_DIR], '/')
: '/opt/datadog';
$normalizedOptions[OPT_INSTALL_DIR] = $normalizedOptions[OPT_INSTALL_DIR] . '/dd-library';
$normalizedOptions[OPT_ENABLE_APPSEC] = isset($options[OPT_ENABLE_APPSEC]);
$normalizedOptions[OPT_ENABLE_PROFILING] = isset($options[OPT_ENABLE_PROFILING]);
return $normalizedOptions;
}
function print_error_and_exit($message, $printHelp = false)
{
echo "ERROR: $message\n";
if ($printHelp) {
print_help();
}
exit(1);
}
function print_warning($message)
{
echo "WARNING: $message\n";
}
/**
* Given a certain set of available PHP binaries, let users pick in an interactive way the ones where the library
* should be installed to.
*
* @param array $php_binaries
* @return array
*/
function pick_binaries_interactive(array $php_binaries)
{
echo "Multiple PHP binaries detected. Please select the binaries the datadog library will be installed to:\n\n";
$commands = array_keys($php_binaries);
for ($index = 0; $index < count($commands); $index++) {
$command = $commands[$index];
$fullPath = $php_binaries[$command];
echo " "
. str_pad($index + 1, 2, ' ', STR_PAD_LEFT)
. ". "
. ($command !== $fullPath ? "$command --> " : "")
. $fullPath
. "\n";
}
echo "\n";
flush();
echo "Select binaries using their number. Multiple binaries separated by space (example: 1 3): ";
$userInput = fgets(STDIN);
$choices = array_map('intval', array_filter(explode(' ', $userInput)));
$pickedBinaries = [];
foreach ($choices as $choice) {
$index = $choice - 1; // we render to the user as 1-indexed
if (!isset($commands[$index])) {
echo "\nERROR: Wrong choice: $choice\n\n";
return pick_binaries_interactive($php_binaries);
}
$command = $commands[$index];
$pickedBinaries[$command] = $php_binaries[$command];
}
return $pickedBinaries;
}
function execute_or_exit($exitMessage, $command)
{
$output = [];
$returnCode = 0;
$lastLine = exec($command, $output, $returnCode);
if (false === $lastLine || $returnCode > 0) {
print_error_and_exit(
$exitMessage .
"\nFailed command (return code $returnCode): $command\n---- Output ----\n" .
implode("\n", $output) .
"\n---- End of output ----\n"
);
}
return $lastLine;
}
/**
* Downloads the library applying a number of fallback mechanisms if specific libraries/binaries are not available.
*
* @param string $url
* @param string $destination
*/
function download($url, $destination)
{
echo "Downloading installable archive from $url.\n";
echo "This operation might take a while.\n";
$okMessage = "\nDownload completed\n\n";
/* We try the following options, mostly to provide progress report, if possible:
* 1) `ext-curl` (with progress report); if 'ext-curl' is not installed...
* 2) `curl` from CLI (it shows progress); if `curl` is not installed...
* 3) `file_get_contents()` (no progress report); if `allow_url_fopen=0`...
* 4) exit with errror
*/
// ext-curl
if (extension_loaded('curl')) {
if (false === $fp = fopen($destination, 'w+')) {
print_error_and_exit("Error while opening target file '$destination' for writing\n");
}
global $progress_counter;
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_TIMEOUT, 50);
curl_setopt($ch, CURLOPT_FILE, $fp);
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
curl_setopt($ch, CURLOPT_PROGRESSFUNCTION, 'on_download_progress');
curl_setopt($ch, CURLOPT_NOPROGRESS, false);
$progress_counter = 0;
$return = curl_exec($ch);
curl_close($ch);
fclose($fp);
if (false !== $return) {
echo $okMessage;
return;
}
// Otherwise we attempt other methods
}
// curl
$statusCode = 0;
$output = [];
if (false !== exec('curl --version', $output, $statusCode) && $statusCode === 0) {
$curlInvocationStatusCode = 0;
system(
'curl -L --output ' . escapeshellarg($destination) . ' ' . escapeshellarg($url),
$curlInvocationStatusCode
);
if ($curlInvocationStatusCode === 0) {
echo $okMessage;
return;
}
// Otherwise we attempt other methods
}
// file_get_contents
if (is_truthy(ini_get('allow_url_fopen'))) {
if (false === file_put_contents($destination, file_get_contents($url))) {
print_error_and_exit("Error while downloading the installable archive from $url\n");
}
echo $okMessage;
return;
}
echo "Error: Cannot download the installable archive.\n";
echo " One of the following prerequisites must be satisfied:\n";
echo " - PHP ext-curl extension is installed\n";
echo " - curl CLI command is available\n";
echo " - the INI setting 'allow_url_fopen=1'\n";
exit(1);
}
/**
* Progress callback as specified by the ext-curl documentation.
* see: https://www.php.net/manual/en/function.curl-setopt.php#:~:text=CURLOPT_PROGRESSFUNCTION
*
* @return int
*/
function on_download_progress($curlHandle, $download_size, $downloaded)
{
global $progress_counter;
if ($download_size === 0) {
return 0;
}
$ratio = $downloaded / $download_size;
if ($ratio == 1) {
return 0;
}
// Max 20 dots to show progress
if ($ratio >= ($progress_counter + (1 / 20))) {
$progress_counter = $ratio;
echo ".";
}
flush();
return 0;
}
/**
* Extracts and normalizes a set of properties from PHP's ini values.
*
* @param string $binary
* @return array
*/
function ini_values($binary)
{
$properties = [INI_CONF, EXTENSION_DIR, THREAD_SAFETY, PHP_API, IS_DEBUG];
$lines = [];
// Timezone is irrelevant to this script. Quick-and-dirty workaround to the PHP 5 warning with missing timezone
exec(escapeshellarg($binary) . " -d date.timezone=UTC -i", $lines);
$found = [];
foreach ($lines as $line) {
$parts = explode('=>', $line);
if (count($parts) === 2 || count($parts) === 3) {
$key = trim($parts[0]);
if (in_array($key, $properties)) {
$found[$key] = trim(count($parts) === 2 ? $parts[1] : $parts[2]);
}
}
}
return $found;
}
function is_truthy($value)
{
$normalized = trim(strtolower($value));
return in_array($normalized, ['1', 'true', 'yes', 'enabled']);
}
/**
* @param array $phpVersions
* @param string $prefix Default ''. Used for testing purposes only.
* @return array
*/
function search_php_binaries($prefix = '')
{
echo "Searching for available php binaries, this operation might take a while.\n";
$results = [];
$allPossibleCommands = build_known_command_names_matrix();
// First, we search in $PATH, for php, php7, php74, php7.4, php7.4-fpm, etc....
foreach ($allPossibleCommands as $command) {
$path = exec("command -v " . escapeshellarg($command));
if ($resolvedPath = resolve_command_full_path($command)) {
$results[$command] = $resolvedPath;
}
}
// Then we search in known possible locations for popular installable paths on different systems.
$standardPaths = [
$prefix . '/usr/bin',
$prefix . '/usr/sbin',
$prefix . '/usr/local/bin',
$prefix . '/usr/local/sbin',
];
$remiSafePaths = array_map(function ($phpVersion) use ($prefix) {
list($major, $minor) = explode('.', $phpVersion);
/* php is installed to /usr/bin/php${major}${minor} so we do not need to do anything special, while php-fpm
* is installed to /opt/remi/php${major}${minor}/root/usr/sbin and it needs to be added to the searched
* locations.
*/
return "${prefix}/opt/remi/php${major}${minor}/root/usr/sbin";
}, get_supported_php_versions());
$escapedSearchLocations = implode(' ', array_map('escapeshellarg', $standardPaths + $remiSafePaths));
$escapedCommandNamesForFind = implode(
' -o ',
array_map(
function ($cmd) {
return '-name ' . escapeshellarg($cmd);
},
$allPossibleCommands
)
);
$pathsFound = [];
exec(
"find -L $escapedSearchLocations -type f \( $escapedCommandNamesForFind \) 2>/dev/null",
$pathsFound
);
foreach ($pathsFound as $path) {
$resolved = realpath($path);
if (in_array($resolved, array_values($results))) {
continue;
}
$results[$path] = $resolved;
}
return $results;
}
/**
* @param mixed $command
* @return string|false
*/
function resolve_command_full_path($command)
{
$path = exec("command -v " . escapeshellarg($command));
if (false === $path || empty($path)) {
// command is not defined
return false;
}
// Resolving symlinks
return realpath($path);
}
function build_known_command_names_matrix()
{
$results = ['php', 'php-fpm'];
foreach (get_supported_php_versions() as $phpVersion) {
list($major, $minor) = explode('.', $phpVersion);
array_push(
$results,
"php${major}",
"php${major}${minor}",
"php${major}.${minor}",
"php${major}-fpm",
"php${major}${minor}-fpm",
"php${major}.${minor}-fpm",
"php-fpm${major}",
"php-fpm${major}${minor}",
"php-fpm${major}.${minor}"
);
}
return array_unique($results);
}
/**
* Adds ini entries that are not present in the provided ini file.
*
* @param string $iniFilePath
*/
function add_missing_ini_settings($iniFilePath, $settings)
{
$iniFileContent = file_get_contents($iniFilePath);
$formattedMissingProperties = '';
foreach ($settings as $setting) {
$settingMightExist = 1 === preg_match(
'/' . str_replace('.', '\.', $setting['name']) . '\s?=\s?/',
$iniFileContent
);
if ($settingMightExist) {
continue;
}
// Formatting the setting to be added.
$description =
is_string($setting['description'])
? '; ' . $setting['description']
: implode(
"\n",
array_map(
function ($line) {
return '; ' . $line;
},
$setting['description']
)
);
$setting = ($setting['commented'] ? ';' : '') . $setting['name'] . ' = ' . $setting['default'];
$formattedMissingProperties .= "\n$description\n$setting\n";
}
if ($formattedMissingProperties !== '') {
if (false === file_put_contents($iniFilePath, $iniFileContent . $formattedMissingProperties)) {
print_error_and_exit("Cannot add additional settings to the INI file $iniFilePath");
}
}
}
function get_php_major_minor($binary)
{
return execute_or_exit(
"Cannot read PHP version",
"$binary -v | grep -oE 'PHP [[:digit:]]+.[[:digit:]]+' | awk '{print \$NF}'"
);
}
/**
* Returns array of associative arrays with the following keys:
* - name (string): the setting name;
* - default (string): the default value;
* - commented (bool): whether this setting should be commented or not when added;
* - description (string|string[]): A string (or an array of strings, each representing a line) that describes
* the setting.
*
* @param string $requestInitHookPath
* @param string $appsecHelperPath
* @param string $appsecRulesPath
* @return array
*/
function get_ini_settings($requestInitHookPath, $appsecHelperPath, $appsecRulesPath)
{
// phpcs:disable Generic.Files.LineLength.TooLong
return [
[
'name' => 'extension',
'default' => 'ddtrace.so',
'commented' => false,
'description' => 'Enables or disables tracing (set by the installer, do not change it)',
],
[
'name' => 'zend_extension',
'default' => 'datadog-profiling.so',
'commented' => true,
'description' => 'Enables the profiling module',
],
[
'name' => 'extension',
'default' => 'ddappsec.so',
'commented' => true,
'description' => 'Enables the appsec module',
],
[
'name' => 'datadog.trace.request_init_hook',
'default' => $requestInitHookPath,
'commented' => false,
'description' => 'Path to the request init hook (set by the installer, do not change it)',
],
[
'name' => 'datadog.trace.enabled',
'default' => 'On',
'commented' => true,
'description' => 'Enables or disables tracing. On by default',
],
[
'name' => 'datadog.trace.cli_enabled',
'default' => 'Off',
'commented' => true,
'description' => 'Enable or disable tracing of CLI scripts. Off by default',
],
[
'name' => 'datadog.trace.auto_flush_enabled',
'default' => 'Off',
'commented' => true,
'description' => 'For long running processes, this setting has to be set to On',
],
[
'name' => 'datadog.trace.generate_root_span',
'default' => 'On',
'commented' => true,
'description' => 'For long running processes, this setting has to be set to Off',
],
[
'name' => 'datadog.trace.debug',
'default' => 'Off',
'commented' => true,
'description' => 'Enables or disables debug mode. When On logs are printed to the error_log',
],
[
'name' => 'datadog.trace.startup_logs',
'default' => 'On',
'commented' => true,
'description' => 'Enables startup logs, including diagnostic checks',
],
[
'name' => 'datadog.service',