Jump/jumpapp/classes/Config.php

<?php
/**
 *      ██ ██    ██ ███    ███ ██████
 *      ██ ██    ██ ████  ████ ██   ██
 *      ██ ██    ██ ██ ████ ██ ██████
 * ██   ██ ██    ██ ██  ██  ██ ██
 *  █████   ██████  ██      ██ ██
 *
 * @author Dale Davies <dale@daledavies.co.uk>
 * @copyright Copyright (c) 2022, Dale Davies
 * @license MIT
 */

namespace Jump;

use Jump\Exceptions\ConfigException;

/**
 * Load, parse and enumerate all configuration paramaters requires throughout
 * the application. Validates the config.php on load to ensure required params
 * are all present.
 *
 * Provides a simple interface for retriving config paramaters once initialised.
 *
 * @author Dale Davies <dale@daledavies.co.uk>
 * @license MIT
 */
class Config {

    private \PHLAK\Config\Config $config;

    /**
     * Required files and directories need that should not be configurable.
     */
    private const BASE_APPLICATION_PATHS = [
        'backgroundsdir' => '/assets/backgrounds',
        'defaulticonpath' => '/assets/images/default-icon.png',
        'searchenginesfile' => '/search/searchengines.json',
        'sitesdir' => '/sites',
        'sitesfile' => '/sites/sites.json',
        'templatedir' => '/templates',
        'translationsdir' => '/translations'
    ];

    /**
     * Configurable params we do expect to find in config.php
     */
    private const CONFIG_PARAMS = [
        'sitename',
        'showclock',
        'metrictemp',
        'wwwroot',
        'cachebypass',
        'cachedir',
        'noindex'
    ];

    /**
     * Session config params.
     */
    private const CONFIG_SESSION = [
        'sessionname' => 'JUMP',
        'sessiontimeout' => '10 minutes'
    ];

    public function __construct() {
        $this->config = new \PHLAK\Config\Config(__DIR__.'/../config.php');
        $this->add_wwwroot_to_base_paths();
        $this->add_session_config();
        if ($this->config_params_missing()) {
            throw new ConfigException('Config.php must always contain... '.implode(', ', self::CONFIG_PARAMS));
        }
    }

    /**
     * Prefixes the wwwroot string from config.php to the base application paths
     * so they can be located in the file system correctly.
     *
     * @return void
     */
    private function add_wwwroot_to_base_paths(): void {
        $wwwroot = $this->config->get('wwwroot');
        foreach(self::BASE_APPLICATION_PATHS as $key => $value) {
            $this->config->set($key, $wwwroot.$value);
        }
    }

    private function add_session_config(): void {
        foreach(self::CONFIG_SESSION as $key => $value) {
            $this->config->set($key, $value);
        }
    }

    /**
     * Determine if any configuration params are missing in the list loaded
     * from the config.php.
     *
     * @return boolean
     */
    private function config_params_missing(): bool {
        return !!array_diff(
            array_merge(
                array_keys(self::BASE_APPLICATION_PATHS),
                self::CONFIG_PARAMS
            ),
            array_keys($this->config->toArray()),
        );
    }

    /**
     * Retrieves the config parameter provided in $key, first checks for its
     * existence.
     *
     * @param string $key The requested config parameter key, not case sensitive.
     * @param bool $strict Throw exception if requested param is not found, or return null.
     * @return mixed The selected value from the configuration array.
     */
    public function get(string $key, $strict = true): mixed {
        $key = strtolower($key);
        if (!$this->config->has($key) && $strict === true) {
            throw new ConfigException('Config key does not exist... ('.$key.')');
        }
        return trim($this->config->get($key));
    }

    /**
     * Get all config paramaters and values as an array.
     *
     * @return array Multidimensional array of config params.
     */
    public function get_all(): array {
        return $this->config->toArray();
    }

    /**
     * Attempt to converts a string to a boolean correctly, will return the parsed boolean
     * or null on failure.
     *
     * @param mixed $input A string representing a boolean value... "true", "yes", "no", "false" etc.
     * @return mixed Returns a proper boolean or null on failure.
     */
    public function parse_bool(mixed $input): mixed {
        return filter_var($input,FILTER_VALIDATE_BOOLEAN,FILTER_NULL_ON_FAILURE);
    }

    public function get_wwwurl() {
        return rtrim($this->config->get('wwwurl', false), '/');
    }

}