mirror of https://github.com/FreshRSS/FreshRSS.git
222 lines
6.6 KiB
PHP
222 lines
6.6 KiB
PHP
<?php
|
|
declare(strict_types=1);
|
|
|
|
/**
|
|
* Manage configuration for the application.
|
|
* @property string $base_url
|
|
* @property array{'type':string,'host':string,'user':string,'password':string,'base':string,'prefix':string,
|
|
* 'connection_uri_params':string,'pdo_options':array<int,int|string|bool>} $db
|
|
* @property bool $disable_update
|
|
* @property string $environment
|
|
* @property array<string,bool> $extensions_enabled
|
|
* @property-read string $mailer
|
|
* @property-read array{'hostname':string,'host':string,'auth':bool,'username':string,'password':string,'secure':string,'port':int,'from':string} $smtp
|
|
* @property string $title
|
|
*/
|
|
class Minz_Configuration {
|
|
/**
|
|
* The list of configurations.
|
|
* @var array<string,static>
|
|
*/
|
|
private static array $config_list = array();
|
|
|
|
/**
|
|
* Add a new configuration to the list of configuration.
|
|
*
|
|
* @param string $namespace the name of the current configuration
|
|
* @param string $config_filename the filename of the configuration
|
|
* @param string $default_filename a filename containing default values for the configuration
|
|
* @param Minz_ConfigurationSetterInterface $configuration_setter an optional helper to set values in configuration
|
|
* @throws Minz_FileNotExistException
|
|
*/
|
|
public static function register(string $namespace, string $config_filename, string $default_filename = null,
|
|
Minz_ConfigurationSetterInterface $configuration_setter = null): void {
|
|
self::$config_list[$namespace] = new static(
|
|
$namespace, $config_filename, $default_filename, $configuration_setter
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Parse a file and return its data.
|
|
*
|
|
* @param string $filename the name of the file to parse.
|
|
* @return array<string,mixed> of values
|
|
* @throws Minz_FileNotExistException if the file does not exist or is invalid.
|
|
*/
|
|
public static function load(string $filename): array {
|
|
$data = @include($filename);
|
|
if (is_array($data)) {
|
|
return $data;
|
|
} else {
|
|
throw new Minz_FileNotExistException($filename);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Return the configuration related to a given namespace.
|
|
*
|
|
* @param string $namespace the name of the configuration to get.
|
|
* @return static object
|
|
* @throws Minz_ConfigurationNamespaceException if the namespace does not exist.
|
|
*/
|
|
public static function get(string $namespace) {
|
|
if (!isset(self::$config_list[$namespace])) {
|
|
throw new Minz_ConfigurationNamespaceException(
|
|
$namespace . ' namespace does not exist'
|
|
);
|
|
}
|
|
|
|
return self::$config_list[$namespace];
|
|
}
|
|
|
|
/**
|
|
* The namespace of the current configuration.
|
|
* Unused.
|
|
* @phpstan-ignore property.onlyWritten
|
|
*/
|
|
private string $namespace = '';
|
|
|
|
/**
|
|
* The filename for the current configuration.
|
|
*/
|
|
private string $config_filename = '';
|
|
|
|
/**
|
|
* The filename for the current default values, null by default.
|
|
*/
|
|
private ?string $default_filename = null;
|
|
|
|
/**
|
|
* The configuration values, an empty array by default.
|
|
* @var array<string,mixed>
|
|
*/
|
|
private array $data = [];
|
|
|
|
/**
|
|
* An object which help to set good values in configuration.
|
|
*/
|
|
private ?Minz_ConfigurationSetterInterface $configuration_setter = null;
|
|
|
|
/**
|
|
* Create a new Minz_Configuration object.
|
|
*
|
|
* @param string $namespace the name of the current configuration.
|
|
* @param string $config_filename the file containing configuration values.
|
|
* @param string $default_filename the file containing default values, null by default.
|
|
* @param Minz_ConfigurationSetterInterface $configuration_setter an optional helper to set values in configuration
|
|
* @throws Minz_FileNotExistException
|
|
*/
|
|
private final function __construct(string $namespace, string $config_filename, string $default_filename = null,
|
|
Minz_ConfigurationSetterInterface $configuration_setter = null) {
|
|
$this->namespace = $namespace;
|
|
$this->config_filename = $config_filename;
|
|
$this->default_filename = $default_filename;
|
|
$this->_configurationSetter($configuration_setter);
|
|
|
|
if ($this->default_filename != null) {
|
|
$this->data = self::load($this->default_filename);
|
|
}
|
|
|
|
try {
|
|
$this->data = array_replace_recursive(
|
|
$this->data, self::load($this->config_filename)
|
|
);
|
|
} catch (Minz_FileNotExistException $e) {
|
|
if ($this->default_filename == null) {
|
|
throw $e;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Set a configuration setter for the current configuration.
|
|
* @param Minz_ConfigurationSetterInterface|null $configuration_setter the setter to call when modifying data.
|
|
*/
|
|
public function _configurationSetter(?Minz_ConfigurationSetterInterface $configuration_setter): void {
|
|
if (is_callable(array($configuration_setter, 'handle'))) {
|
|
$this->configuration_setter = $configuration_setter;
|
|
}
|
|
}
|
|
|
|
public function configurationSetter(): ?Minz_ConfigurationSetterInterface {
|
|
return $this->configuration_setter;
|
|
}
|
|
|
|
/**
|
|
* Check if a parameter is defined in the configuration
|
|
*/
|
|
public function hasParam(string $key): bool {
|
|
return isset($this->data[$key]);
|
|
}
|
|
|
|
/**
|
|
* Return the value of the given param.
|
|
*
|
|
* @param string $key the name of the param.
|
|
* @param mixed $default default value to return if key does not exist.
|
|
* @return array|mixed value corresponding to the key.
|
|
*/
|
|
public function param(string $key, $default = null) {
|
|
if (isset($this->data[$key])) {
|
|
return $this->data[$key];
|
|
} elseif (!is_null($default)) {
|
|
return $default;
|
|
} else {
|
|
Minz_Log::warning($key . ' does not exist in configuration');
|
|
return null;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* A wrapper for param().
|
|
* @return array|mixed
|
|
*/
|
|
public function __get(string $key) {
|
|
return $this->param($key);
|
|
}
|
|
|
|
/**
|
|
* Set or remove a param.
|
|
*
|
|
* @param string $key the param name to set.
|
|
* @param mixed $value the value to set. If null, the key is removed from the configuration.
|
|
*/
|
|
public function _param(string $key, $value = null): void {
|
|
if ($this->configuration_setter !== null && $this->configuration_setter->support($key)) {
|
|
$this->configuration_setter->handle($this->data, $key, $value);
|
|
} elseif (isset($this->data[$key]) && is_null($value)) {
|
|
unset($this->data[$key]);
|
|
} elseif ($value !== null) {
|
|
$this->data[$key] = $value;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* A wrapper for _param().
|
|
* @param mixed $value
|
|
*/
|
|
public function __set(string $key, $value): void {
|
|
$this->_param($key, $value);
|
|
}
|
|
|
|
/**
|
|
* Save the current configuration in the configuration file.
|
|
*/
|
|
public function save(): bool {
|
|
$back_filename = $this->config_filename . '.bak.php';
|
|
@rename($this->config_filename, $back_filename);
|
|
|
|
if (file_put_contents($this->config_filename,
|
|
"<?php\nreturn " . var_export($this->data, true) . ';', LOCK_EX) === false) {
|
|
return false;
|
|
}
|
|
|
|
// Clear PHP cache for include
|
|
if (function_exists('opcache_invalidate')) {
|
|
opcache_invalidate($this->config_filename);
|
|
}
|
|
|
|
return true;
|
|
}
|
|
}
|