phpmyadmin/libraries/classes/Setup/ConfigGenerator.php

<?php
/**
 * Config file generator
 */

declare(strict_types=1);

namespace PhpMyAdmin\Setup;

use PhpMyAdmin\Config\ConfigFile;
use PhpMyAdmin\Version;

use function array_keys;
use function count;
use function gmdate;
use function implode;
use function is_array;
use function is_string;
use function mb_strlen;
use function preg_replace;
use function sodium_bin2hex;
use function sodium_crypto_secretbox_keygen;
use function sprintf;
use function str_contains;
use function strtr;
use function var_export;

use const DATE_RFC1123;
use const SODIUM_CRYPTO_SECRETBOX_KEYBYTES;

/**
 * Config file generation class
 */
class ConfigGenerator
{
    /**
     * Creates config file
     *
     * @param ConfigFile $cf Config file instance
     */
    public static function getConfigFile(ConfigFile $cf): string
    {
        $eol = isset($_SESSION['eol']) && $_SESSION['eol'] === 'win' ? "\r\n" : "\n";
        $conf = $cf->getConfig();

        // header
        $ret = '<?php' . $eol
            . '/**' . $eol
            . ' * Generated configuration file' . $eol
            . ' * Generated by: phpMyAdmin '
                . Version::VERSION
                . ' setup script' . $eol
            . ' * Date: ' . gmdate(DATE_RFC1123) . $eol
            . ' */' . $eol . $eol;

        //servers
        if (! empty($conf['Servers'])) {
            $ret .= self::getServerPart($cf, $eol, $conf['Servers']);
            unset($conf['Servers']);
        }

        // other settings
        $persistKeys = $cf->getPersistKeysMap();

        foreach ($conf as $k => $v) {
            $k = preg_replace('/[^A-Za-z0-9_]/', '_', (string) $k);
            $ret .= self::getVarExport($k, $v, $eol);
            if (! isset($persistKeys[$k])) {
                continue;
            }

            unset($persistKeys[$k]);
        }

        // keep 1d array keys which are present in $persist_keys (config.values.php)
        foreach (array_keys($persistKeys) as $k) {
            if (str_contains($k, '/')) {
                continue;
            }

            $k = preg_replace('/[^A-Za-z0-9_]/', '_', $k);
            $ret .= self::getVarExport($k, $cf->getDefault($k), $eol);
        }

        return $ret . $eol;
    }

    /**
     * Returns exported configuration variable
     *
     * @param string $varName  configuration name
     * @param mixed  $varValue configuration value(s)
     * @param string $eol      line ending
     */
    private static function getVarExport(string $varName, mixed $varValue, string $eol): string
    {
        if ($varName === 'blowfish_secret') {
            $secret = self::getBlowfishSecretKey($varValue);

            return sprintf('$cfg[\'blowfish_secret\'] = \sodium_hex2bin(\'%s\');%s', sodium_bin2hex($secret), $eol);
        }

        if (! is_array($varValue) || $varValue === []) {
            return "\$cfg['" . $varName . "'] = "
                . var_export($varValue, true) . ';' . $eol;
        }

        if (self::isZeroBasedArray($varValue)) {
            return "\$cfg['" . $varName . "'] = "
                . self::exportZeroBasedArray($varValue, $eol)
                . ';' . $eol;
        }

        $ret = '';
        // string keys: $cfg[key][subkey] = value
        foreach ($varValue as $k => $v) {
            $k = preg_replace('/[^A-Za-z0-9_]/', '_', $k);
            $ret .= "\$cfg['" . $varName . "']['" . $k . "'] = "
                . var_export($v, true) . ';' . $eol;
        }

        return $ret;
    }

    /**
     * Check whether $array is a continuous 0-based array
     *
     * @param mixed[] $array Array to check
     */
    private static function isZeroBasedArray(array $array): bool
    {
        for ($i = 0, $nb = count($array); $i < $nb; $i++) {
            if (! isset($array[$i])) {
                return false;
            }
        }

        return true;
    }

    /**
     * Exports continuous 0-based array
     *
     * @param mixed[] $array Array to export
     * @param string  $eol   Newline string
     */
    private static function exportZeroBasedArray(array $array, string $eol): string
    {
        $retv = [];
        foreach ($array as $v) {
            $retv[] = var_export($v, true);
        }

        $ret = '[';
        if (count($retv) <= 4) {
            // up to 4 values - one line
            return $ret . implode(', ', $retv) . ']';
        }

        // more than 4 values - value per line
        $imax = count($retv);
        for ($i = 0; $i < $imax; $i++) {
            $ret .= ($i > 0 ? ',' : '') . $eol . '    ' . $retv[$i];
        }

        return $ret . ']';
    }

    /**
     * Generate server part of config file
     *
     * @param ConfigFile $cf      Config file
     * @param string     $eol     Carriage return char
     * @param mixed[]    $servers Servers list
     */
    protected static function getServerPart(ConfigFile $cf, string $eol, array $servers): string|null
    {
        if ($cf->getServerCount() === 0) {
            return null;
        }

        $ret = '/* Servers configuration */' . $eol . '$i = 0;' . $eol . $eol;
        foreach ($servers as $id => $server) {
            $ret .= '/* Server: '
                . strtr($cf->getServerName($id) . ' [' . $id . '] ', '*/', '-')
                . '*/' . $eol
                . '$i++;' . $eol;
            foreach ($server as $k => $v) {
                $k = preg_replace('/[^A-Za-z0-9_]/', '_', (string) $k);
                $ret .= "\$cfg['Servers'][\$i]['" . $k . "'] = "
                    . (is_array($v) && self::isZeroBasedArray($v)
                        ? self::exportZeroBasedArray($v, $eol)
                        : var_export($v, true))
                    . ';' . $eol;
            }

            $ret .= $eol;
        }

        $ret .= '/* End of servers configuration */' . $eol . $eol;

        return $ret;
    }

    /** @psalm-return non-empty-string */
    private static function getBlowfishSecretKey(mixed $key): string
    {
        if (is_string($key) && mb_strlen($key, '8bit') === SODIUM_CRYPTO_SECRETBOX_KEYBYTES) {
            return $key;
        }

        return sodium_crypto_secretbox_keygen();
    }
}