class.config.php

Go to the documentation of this file.

<?php
/*
 *
 *  * Copyright (c) 2022-2025 Bearsampp
 *  * License: GNU General Public License version 3 or later; see LICENSE.txt
 *  * Website: https://bearsampp.com
 *  * Github: https://github.com/Bearsampp
 *
 */

class Config
{
    const CFG_MAX_LOGS_ARCHIVES = 'maxLogsArchives';
    const CFG_LOGS_VERBOSE = 'logsVerbose';
    const CFG_LANG = 'lang';
    const CFG_TIMEZONE = 'timezone';
    const CFG_NOTEPAD = 'notepad';
    const CFG_SCRIPTS_TIMEOUT = 'scriptsTimeout';
    const DOWNLOAD_ID = 'DownloadId';
 
    const CFG_INCLUDE_PR = 'IncludePR';
    const CFG_ENHANCED_QUICKPICK = 'EnhancedQuickPick';
    const CFG_DEFAULT_LANG = 'defaultLang';
    const CFG_HOSTNAME = 'hostname';
    const CFG_BROWSER = 'browser';
    const CFG_ONLINE = 'online';
    const CFG_LAUNCH_STARTUP = 'launchStartup';
 
    const ENABLED = 1;
    const DISABLED = 0;
 
    const VERBOSE_SIMPLE = 0;
    const VERBOSE_REPORT = 1;
    const VERBOSE_DEBUG = 2;
    const VERBOSE_TRACE = 3;

    private $raw;

    public function __construct()
    {
        global $bearsamppRoot;
 
        // Set current timezone to match whats in .conf
        $this->raw = parse_ini_file(Path::getConfigFilePath());
        date_default_timezone_set($this->getTimezone());
    }

    public function getRaw($key)
    {
        return $this->raw[$key];
    }

    public function replace($key, $value)
    {
        $this->replaceAll(array($key => $value));
    }

    public function replaceAll($params)
    {
        global $bearsamppRoot;
 
        Log::trace('Replace config:');
        $content = file_get_contents(Path::getConfigFilePath());
        foreach ($params as $key => $value) {
            // Only accept well-formed keys and values. The key is interpolated
            // into a regex pattern and the value into the INI content, so an
            // unvalidated key/value could inject arbitrary lines or corrupt
            // other settings (config poisoning). Values that could break out
            // of the surrounding quotes or add lines are rejected.
            if (!is_string($key) || preg_match('/^[a-zA-Z0-9_-]+$/', $key) !== 1) {
                throw new RuntimeException('Invalid configuration key: ' . var_export($key, true));
            }
            $value = (string)$value;
            if (preg_match('/[\r\n"\x00-\x1F\x7F]/', $value) === 1) {
                throw new RuntimeException('Invalid configuration value for key: ' . $key);
            }
 
            $content = preg_replace('/^' . preg_quote($key, '/') . '\s=\s.*/m', $key . ' = ' . '"' . $value . '"', $content, -1, $count);
            Log::trace('## ' . $key . ': ' . $value . ' (' . $count . ' replacements done)');
            $this->raw[$key] = $value;
        }
 
        file_put_contents(Path::getConfigFilePath(), $content);
    }

    public function getLang()
    {
        return $this->raw[self::CFG_LANG];
    }

    public function getDefaultLang()
    {
        return $this->raw[self::CFG_DEFAULT_LANG];
    }

    public function getTimezone()
    {
        return $this->raw[self::CFG_TIMEZONE];
    }

    public function getDownloadId()
    {
        return $this->raw[self::DOWNLOAD_ID];
    }

    public function isOnline()
    {
        return $this->raw[self::CFG_ONLINE] == self::ENABLED;
    }

    public function isLaunchStartup()
    {
        return $this->raw[self::CFG_LAUNCH_STARTUP] == self::ENABLED;
    }

    public function getBrowser()
    {
        return $this->raw[self::CFG_BROWSER];
    }

    public function getHostname()
    {
        return $this->raw[self::CFG_HOSTNAME];
    }

    public function getScriptsTimeout()
    {
        return intval($this->raw[self::CFG_SCRIPTS_TIMEOUT]);
    }

    public function getNotepad()
    {
        return $this->raw[self::CFG_NOTEPAD];
    }

    public function getLogsVerbose()
    {
        return intval($this->raw[self::CFG_LOGS_VERBOSE]);
    }

    public function getMaxLogsArchives()
    {
        return intval($this->raw[self::CFG_MAX_LOGS_ARCHIVES]);
    }

    public function getIncludePr()
    {
        return isset($this->raw[self::CFG_INCLUDE_PR]) ? intval($this->raw[self::CFG_INCLUDE_PR]) : 0;
    }

    public function getEnhancedQuickPick()
    {
        return isset($this->raw[self::CFG_ENHANCED_QUICKPICK]) ? intval($this->raw[self::CFG_ENHANCED_QUICKPICK]) : 0;
    }

    public function validateEnhancedQuickPick()
    {
        // Check if the parameter exists in the config
        if (!isset($this->raw[self::CFG_ENHANCED_QUICKPICK])) {
            return [
                'valid' => false,
                'error' => 'Missing parameter: EnhancedQuickPick is not defined in bearsampp.conf'
            ];
        }
 
        $value = $this->raw[self::CFG_ENHANCED_QUICKPICK];
 
        // Check if the value is either "0" or "1"
        if ($value !== "0" && $value !== "1") {
            return [
                'valid' => false,
                'error' => 'Invalid parameter: EnhancedQuickPick must be set to "0" or "1" in bearsampp.conf'
            ];
        }
 
        return ['valid' => true];
    }
}