feat: add config mode to datadog-setup.php

datadog-setup.php

@@ -58,6 +58,182 @@ function print_help()
 EOD;
 }
 
+/**
+ * This function will print out all Datadog specific PHP INI settings. The list
+ * of Datadog specific settings is retrieved by calling `get_ini_settings()`. It
+ * will also show the default and INI file this setting was found.
+ * The output will be grouped by PHP binary, example:
+ *
+ * $ php datadog-setup.php config list --php-bin all
+ * Searching for available php binaries, this operation might take a while.
+ * Datadog configuration for binary: php (/opt/php/8.2/bin/php)
+ * datadog.profiling.enabled => On // default: 1, INI file: /opt/php/etc/conf.d/98-ddtrace.ini
+ * datadog.profiling.experimental_allocation_enabled => On // default: 1, INI file: /opt/php/etc/conf.d/98-ddtrace.ini
+ *
+ * @see get_ini_settings
+ */
+function config_list(array $options): void
+{
+    $selectedBinaries = require_binaries_or_exit($options);
+    $iniSettings = get_ini_settings('', '', '');
+    foreach ($selectedBinaries as $command => $fullPath) {
+        $binaryForLog = ($command === $fullPath) ? $fullPath : "$command ($fullPath)";
+        echo "Datadog configuration for binary: $binaryForLog", PHP_EOL;
+
+        $iniFilePaths = find_ini_files(
+            ini_values($fullPath)
+        );
+
+        foreach ($iniFilePaths as $iniFilePath) {
+            $iniFileSettings = parse_ini_file($iniFilePath);
+            foreach ($iniFileSettings as $iniFileSetting => $currentValue) {
+                foreach ($iniSettings as $iniSetting) {
+                    if ($iniSetting['name'] !== $iniFileSetting) {
+                        continue;
+                    }
+                    echo $iniSetting['name'], ' => ', $currentValue, ' // default: ',
+                        $iniSetting['default'], ', INI file: ', $iniFilePath, PHP_EOL;
+                }
+            }
+        }
+    }
+}
+
+/**
+ * This function will print the specified PHP INI settings.
+ * The output will be grouped by PHP binary, example:
+ *
+ * $ php datadog-setup.php config get --php-bin all \
+ *   -ddatadog.profiling.experimental_allocation_enabled \
+ *   -ddatadog.profiling.experimental_cpu_enabled \
+ *   -dnonexisting
+ * Datadog configuration for binary: php (/opt/php/8.2/bin/php)
+ * datadog.profiling.experimental_allocation_enabled => On // INI file: /opt/php/etc/conf.d/98-ddtrace.ini
+ * datadog.profiling.experimental_cpu_enabled => On // INI file: /opt/php/etc/conf.d/98-ddtrace.ini
+ * nonexisting => undefined // is missing in INI files
+ */
+function config_get(array $options): void
+{
+    $selectedBinaries = require_binaries_or_exit($options);
+    foreach ($selectedBinaries as $command => $fullPath) {
+        $binaryForLog = ($command === $fullPath) ? $fullPath : "$command ($fullPath)";
+        echo "Datadog configuration for binary: $binaryForLog", PHP_EOL;
+
+        $iniFilePaths = find_ini_files(
+            ini_values($fullPath)
+        );
+
+        if (count($iniFilePaths) === 0) {
+            echo 'No INI files for this binary found', PHP_EOL;
+            continue;
+        }
+
+        foreach ($options['d'] as $iniSetting) {
+            $found = false;
+            foreach ($iniFilePaths as $iniFilePath) {
+                $iniFileSettings = parse_ini_file($iniFilePath, false, INI_SCANNER_RAW);
+                if (array_key_exists($iniSetting, $iniFileSettings)) {
+                    echo $iniSetting, ' => ', $iniFileSettings[$iniSetting], ' // INI file: ', $iniFilePath, PHP_EOL;
+                    $found = true;
+                }
+            }
+            if (!$found) {
+                echo $iniSetting, ' => undefined // is missing in INI files', PHP_EOL;
+            }
+        }
+    }
+}
+
+/**
+ * This function will set the given INI settings for any given PHP binary
+ *
+ * $ php datadog-setup.php config set --php-bin all \
+ *   -ddatadog.profiling.experimental_allocation_enabled=On \
+ *   -ddatadog.profiling.experimental_cpu_enabled=On \
+ * Setting configuration for binary: php (/opt/php/8.2/bin/php)
+ * Set 'datadog.profiling.experimental_allocation_enabled' to 'On' in INI file: /opt/php/etc/conf.d/98-ddtrace.ini
+ * Set 'datadog.profiling.experimental_cpu_enabled' to 'On' in INI file: /opt/php/etc/conf.d/98-ddtrace.ini
+ */
+function config_set(array $options): void
+{
+    $selectedBinaries = require_binaries_or_exit($options);
+    foreach ($selectedBinaries as $command => $fullPath) {
+        $binaryForLog = ($command === $fullPath) ? $fullPath : "$command ($fullPath)";
+        echo "Setting configuration for binary: $binaryForLog", PHP_EOL;
+
+        $phpProps = ini_values($fullPath);
+        $iniFilePaths = find_ini_files($phpProps);
+
+        foreach ($options['d'] as $cliIniSetting) {
+            // `trim()` should not be needed, but better safe than sorry
+            $iniSetting = array_map(
+                'trim',
+                explode('=', $cliIniSetting, 2)
+            );
+            if (count($iniSetting) !== 2) {
+                echo "The given INI setting '", $cliIniSetting, "' can't be parsed, skipping.", PHP_EOL;
+                continue;
+            }
+
+            // safety: try out if parsing the generated ini setting is actually
+            // possible
+            $newSetting = $iniSetting[0] . ' = ' . $iniSetting[1];
+            if (parse_ini_string($newSetting, false, INI_SCANNER_RAW) === false) {
+                echo "The given INI setting '", $cliIniSetting,
+                    "' can't be converted to a valid INI setting, skipping.", PHP_EOL;
+            }
+
+            $found = false;
+
+            // search INI file with $iniSetting as it might already exists
+            // in some INI file
+            foreach ($iniFilePaths as $iniFile) {
+                if (!is_file($iniFile)) {
+                    continue;
+                }
+                $iniFileContent = file_get_contents($iniFile);
+                if (preg_match("/^\s*" . preg_quote($iniSetting[0]) . "\s*=\s*/mi", $iniFileContent)) {
+                    // in case we found the ini setting, we break the loop and
+                    // leaf $iniFile and $iniFileContent to be used later
+                    $found = true;
+                    break;
+                }
+            }
+
+            if ($found) {
+                // $iniFile has the filename of the INI file and $iniFileContent
+                // has it's contents as a left over of the `foreach` above
+                $regex = '/^\s*' . preg_quote($iniSetting[0]) . '\s*=.*$/mi';
+                $iniFileContent = preg_replace($regex, $newSetting, $iniFileContent);
+                if ($iniFileContent === null) {
+                    // something wrong with the regex, the user should see a warning
+                    // in the form of "Warning: preg_replace(): Compilation failed ..."
+                    echo "Could not update the given INI setting in file '", $iniFile, "', skipping", PHP_EOL;
+                }
+            } else {
+                // set filename
+                $iniFilePath = $phpProps[INI_SCANDIR] . '/98-ddtrace.ini';
+                $iniFileContent = '';
+                if (is_file($iniFilePath)) {
+                    $iniFileContent = file_get_contents($iniFilePath);
+                }
+                // check for "End of Line" symbol at the end of the file and
+                // add in case it is missing
+                if (strlen($iniFileContent) > 0 && substr($iniFileContent, -1, 1) !== PHP_EOL) {
+                    $iniFileContent .= PHP_EOL;
+                }
+                $iniFileContent .= $newSetting . PHP_EOL;
+            }
+            if (file_put_contents($iniFile, $iniFileContent) === false) {
+                echo "Could not set '", $iniSetting[0], "' to '", $iniSetting[1],
+                    "' in INI file: ", $iniFile , PHP_EOL;
+            } else {
+                echo "Set '", $iniSetting[0], "' to '", $iniSetting[1], "' in INI file: ", $iniFile, PHP_EOL;
+            }
+        }
+    }
+}
+
 function install($options)
 {
     $architecture = get_architecture();
@@ -220,40 +396,7 @@ function install($options)
         }
         $appSecHelperPath = $installDir . '/bin/ddappsec-helper';
 
-        // Writing the ini file
-        if ($phpProperties[INI_SCANDIR]) {
-            $iniFileName = '98-ddtrace.ini';
-            // Search for pre-existing files with extension = ddtrace.so to avoid conflicts
-            // See issue https://github.com/DataDog/dd-trace-php/issues/1833
-            foreach (scandir($phpProperties[INI_SCANDIR]) as $ini) {
-                $path = "{$phpProperties[INI_SCANDIR]}/$ini";
-                if (is_file($path)) {
-                    // match /path/to/ddtrace.so, plain extension = ddtrace or future extensions like ddtrace.dll
-                    if (preg_match("(^\s*extension\s*=\s*(\S*ddtrace)\b)m", file_get_contents($path), $res)) {
-                        if (basename($res[1]) == "ddtrace") {
-                            $iniFileName = $ini;
-                        }
-                    }
-                }
-            }
-
-            $iniFilePaths = [$phpProperties[INI_SCANDIR] . '/' . $iniFileName];
-
-            if (strpos($phpProperties[INI_SCANDIR], '/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_SCANDIR]);
-                if (is_dir($apacheConfd)) {
-                    $iniFilePaths[] = "$apacheConfd/$iniFileName";
-                }
-            }
-        } else {
-            $iniFileName = $phpProperties[INI_MAIN];
-            $iniFilePaths = [$iniFileName];
-        }
+        $iniFilePaths = find_ini_files($phpProperties);
 
         foreach ($iniFilePaths as $iniFilePath) {
             if (!file_exists($iniFilePath)) {
@@ -386,6 +529,52 @@ function ($el) {
     }
 }
 
+/**
+ * Finds the INI files for the given php properties. Those properties can be
+ * retrieved by calling `ini_values($pathToPHPBinary)`.
+ *
+ * @see ini_values
+ * @return string[]
+ */
+function find_ini_files(array $phpProperties): array
+{
+    $iniFilePaths = [];
+    if ($phpProperties[INI_SCANDIR]) {
+        $iniFileName = '98-ddtrace.ini';
+        // Search for pre-existing files with extension = ddtrace.so to avoid conflicts
+        // See issue https://github.com/DataDog/dd-trace-php/issues/1833
+        foreach (scandir($phpProperties[INI_SCANDIR]) as $ini) {
+            $path = "{$phpProperties[INI_SCANDIR]}/$ini";
+            if (is_file($path)) {
+                // match /path/to/ddtrace.so, plain extension = ddtrace or future extensions like ddtrace.dll
+                if (preg_match("(^\s*extension\s*=\s*(\S*ddtrace)\b)m", file_get_contents($path), $res)) {
+                    if (basename($res[1]) == "ddtrace") {
+                        $iniFileName = $ini;
+                    }
+                }
+            }
+        }
+
+        $iniFilePaths = [$phpProperties[INI_SCANDIR] . '/' . $iniFileName];
+
+        if (strpos($phpProperties[INI_SCANDIR], '/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_SCANDIR]);
+            if (is_dir($apacheConfd)) {
+                $iniFilePaths[] = "$apacheConfd/$iniFileName";
+            }
+        }
+    } else {
+        $iniFileName = $phpProperties[INI_MAIN];
+        $iniFilePaths = [$iniFileName];
+    }
+    return $iniFilePaths;
+}
+
 /**
  * Copies an extension's file to a destination using copy+rename to avoid segfault if the file is loaded by php.
  *
@@ -639,12 +828,94 @@ function get_architecture()
     );
 }
 
+function parse_cli_arguments(array $argv = NULL): array
+{
+    if (is_null($argv)) {
+        $argv = $_SERVER['argv'];
+    }
+
+    // strip the application name
+    array_shift($argv);
+
+    $arguments = [
+        'cmd' => NULL,
+        'opts' => [],
+    ];
+
+    while (NULL !== $token = array_shift($argv)) {
+        if (substr($token, 0, 2) === '--') {
+            // parse long option
+            $key = substr($token, 2);
+            $value = array_shift($argv);
+            if ($value === null) {
+                $value = false;
+            } elseif (substr($value, 0, 1) === '-') {
+                // another option, but it back onto $argv
+                array_unshift($argv, $value);
+                $value = false;
+            }
+            if (!isset($arguments['opts'][$key])) {
+                $arguments['opts'][$key] = $value;
+            } elseif(is_string($arguments['opts'][$key])) {
+                $arguments['opts'][$key] = [
+                    $arguments['opts'][$key],
+                    $value,
+                ];
+            } else {
+                $arguments['opts'][$key][] = $value;
+            }
+        } elseif (substr($token, 0, 1) === '-') {
+            // parse short option
+            $key = $token[1];
+            if (strlen($token) === 2) {
+                // -d datadog.profiling.enabled or
+                // -h
+                $value = array_shift($argv);
+                if ($value === null) {
+                    $value = false;
+                } elseif (substr($value, 0, 1) === '-') {
+                    // another option, but it back onto $argv
+                    array_unshift($argv, $value);
+                    $value = false;
+                }
+            } else {
+                // -ddatadog.profiling.enabled
+                $value = substr($token, 2);
+            }
+            if (!isset($arguments['opts'][$key])) {
+                $arguments['opts'][$key] = $value;
+            } elseif(is_string($arguments['opts'][$key])) {
+                $arguments['opts'][$key] = [
+                    $arguments['opts'][$key],
+                    $value,
+                ];
+            } else {
+                $arguments['opts'][$key][] = $value;
+            }
+        } else {
+            // parse command
+            if ($arguments['cmd'] === NULL) {
+                $arguments['cmd'] = $token;
+            } else {
+                $arguments['cmd'] .= ' '.$token;
+            }
+        }
+    }
+
+    if ($arguments['cmd'] === NULL) {
+        $arguments['cmd'] = 'install';
+    }
+
+    return $arguments;
+}
+
 /**
  * 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,
@@ -656,6 +927,10 @@ function parse_validate_user_options()
         OPT_ENABLE_PROFILING,
     ];
     $options = getopt($shortOptions, $longOptions);
+    */
+
+    $args = parse_cli_arguments();
+    $options = $args['opts'];
 
     global $argc;
     if ($options === false || (empty($options) && $argc > 1)) {