aboutsummaryrefslogtreecommitdiff
path: root/lib/Minz/Configuration.php
diff options
context:
space:
mode:
authorGravatar Marien Fressinaud <dev@marienfressinaud.fr> 2015-01-08 14:18:32 +0100
committerGravatar Marien Fressinaud <dev@marienfressinaud.fr> 2015-01-08 14:18:32 +0100
commit73023bc12b81a27045703e1f733faeb2b4e02cec (patch)
tree14aca1a1953d0a813c06794e48a63738abccdcea /lib/Minz/Configuration.php
parent26da4aa448906f857a252507b34d369a386043c6 (diff)
parent0e4e16ac55097aa173c7c439367294ebd7645562 (diff)
Merge branch 'dev' into 252-extensions
Conflicts: app/FreshRSS.php app/Models/Configuration.php app/views/index/index.phtml app/views/index/normal.phtml lib/Minz/Configuration.php lib/Minz/Translate.php lib/lib_rss.php
Diffstat (limited to 'lib/Minz/Configuration.php')
-rw-r--r--lib/Minz/Configuration.php548
1 files changed, 166 insertions, 382 deletions
diff --git a/lib/Minz/Configuration.php b/lib/Minz/Configuration.php
index 4a3221ef5..fe415e22b 100644
--- a/lib/Minz/Configuration.php
+++ b/lib/Minz/Configuration.php
@@ -1,169 +1,105 @@
<?php
-/**
- * MINZ - Copyright 2011 Marien Fressinaud
- * Sous licence AGPL3 <http://www.gnu.org/licenses/>
-*/
/**
- * La classe Configuration permet de gérer la configuration de l'application
+ * Manage configuration for the application.
*/
class Minz_Configuration {
- const CONF_PATH_NAME = '/config.php';
-
/**
- * VERSION est la version actuelle de MINZ
+ * The list of configurations.
*/
- const VERSION = '1.3.1.freshrss'; // version spéciale FreshRSS
+ private static $config_list = array();
/**
- * valeurs possibles pour l'"environment"
- * SILENT rend l'application muette (pas de log)
- * PRODUCTION est recommandée pour une appli en production
- * (log les erreurs critiques)
- * DEVELOPMENT log toutes les erreurs
+ * Add a new configuration to the list of configuration.
+ *
+ * @param $namespace the name of the current configuration
+ * @param $config_filename the filename of the configuration
+ * @param $default_filename a filename containing default values for the configuration
+ * @param $configuration_setter an optional helper to set values in configuration
+ * @throws Minz_ConfigurationNamespaceException if the namespace already exists.
*/
- const SILENT = 0;
- const PRODUCTION = 1;
- const DEVELOPMENT = 2;
+ public static function register($namespace, $config_filename, $default_filename = null,
+ $configuration_setter = null) {
+ if (isset(self::$config_list[$namespace])) {
+ throw new Minz_ConfigurationNamespaceException(
+ $namespace . ' namespace already exists'
+ );
+ }
+
+ self::$config_list[$namespace] = new Minz_Configuration(
+ $namespace, $config_filename, $default_filename, $configuration_setter
+ );
+ }
/**
- * définition des variables de configuration
- * $salt une chaîne de caractères aléatoires (obligatoire)
- * $environment gère le niveau d'affichage pour log et erreurs
- * $base_url le chemin de base pour accéder à l'application
- * $title le nom de l'application
- * $language la langue par défaut de l'application
- * $db paramètres pour la base de données (tableau)
- * - host le serveur de la base
- * - user nom d'utilisateur
- * - password mot de passe de l'utilisateur
- * - base le nom de la base de données
+ * Parse a file and return its data.
+ *
+ * If the file does not contain a valid PHP code returning an array, an
+ * empty array is returned anyway.
+ *
+ * @param $filename the name of the file to parse.
+ * @return an array of values
+ * @throws Minz_FileNotExistException if the file does not exist.
*/
- private static $salt = '';
- private static $environment = Minz_Configuration::PRODUCTION;
- private static $base_url = '';
- private static $title = '';
- private static $language = 'en';
- private static $default_user = '';
- private static $allow_anonymous = false;
- private static $allow_anonymous_refresh = false;
- private static $auth_type = 'none';
- private static $api_enabled = false;
- private static $unsafe_autologin_enabled = false;
+ public static function load($filename) {
+ if (!file_exists($filename)) {
+ throw new Minz_FileNotExistException($filename);
+ }
- private static $db = array (
- 'type' => 'mysql',
- 'host' => '',
- 'user' => '',
- 'password' => '',
- 'base' => '',
- 'prefix' => '',
- );
+ $data = @include($filename);
+ if (is_array($data)) {
+ return $data;
+ } else {
+ return array();
+ }
+ }
- const MAX_SMALL_INT = 16384;
- private static $limits = array(
- 'cache_duration' => 800, //SimplePie cache duration in seconds
- 'timeout' => 10, //SimplePie timeout in seconds
- 'max_inactivity' => PHP_INT_MAX, //Time in seconds after which a user who has not used the account is considered inactive (no auto-refresh of feeds).
- 'max_feeds' => Minz_Configuration::MAX_SMALL_INT,
- 'max_categories' => Minz_Configuration::MAX_SMALL_INT,
- );
+ /**
+ * Return the configuration related to a given namespace.
+ *
+ * @param $namespace the name of the configuration to get.
+ * @return a Minz_Configuration object
+ * @throws Minz_ConfigurationNamespaceException if the namespace does not exist.
+ */
+ public static function get($namespace) {
+ if (!isset(self::$config_list[$namespace])) {
+ throw new Minz_ConfigurationNamespaceException(
+ $namespace . ' namespace does not exist'
+ );
+ }
- private static $extensions_enabled = array();
+ return self::$config_list[$namespace];
+ }
- /*
- * Getteurs
+ /**
+ * The namespace of the current configuration.
*/
- public static function salt () {
- return self::$salt;
- }
- public static function environment ($str = false) {
- $env = self::$environment;
+ private $namespace = '';
- if ($str) {
- switch (self::$environment) {
- case self::SILENT:
- $env = 'silent';
- break;
- case self::DEVELOPMENT:
- $env = 'development';
- break;
- case self::PRODUCTION:
- default:
- $env = 'production';
- }
- }
+ /**
+ * The filename for the current configuration.
+ */
+ private $config_filename = '';
- return $env;
- }
- public static function baseUrl () {
- return self::$base_url;
- }
- public static function title () {
- return self::$title;
- }
- public static function language () {
- return self::$language;
- }
- public static function dataBase () {
- return self::$db;
- }
- public static function limits() {
- return self::$limits;
- }
- public static function defaultUser () {
- return self::$default_user;
- }
- public static function allowAnonymous() {
- return self::$allow_anonymous;
- }
- public static function allowAnonymousRefresh() {
- return self::$allow_anonymous_refresh;
- }
- public static function authType() {
- return self::$auth_type;
- }
- public static function needsLogin() {
- return self::$auth_type !== 'none';
- }
- public static function canLogIn() {
- return self::$auth_type === 'form' || self::$auth_type === 'persona';
- }
- public static function apiEnabled() {
- return self::$api_enabled;
- }
- public static function unsafeAutologinEnabled() {
- return self::$unsafe_autologin_enabled;
- }
- public static function extensionsEnabled() {
- return self::$extensions_enabled;
- }
+ /**
+ * The filename for the current default values, null by default.
+ */
+ private $default_filename = null;
- public static function _allowAnonymous($allow = false) {
- self::$allow_anonymous = ((bool)$allow) && self::canLogIn();
- }
- public static function _allowAnonymousRefresh($allow = false) {
- self::$allow_anonymous_refresh = ((bool)$allow) && self::allowAnonymous();
- }
- public static function _authType($value) {
- $value = strtolower($value);
- switch ($value) {
- case 'form':
- case 'http_auth':
- case 'persona':
- case 'none':
- self::$auth_type = $value;
- break;
- }
- self::_allowAnonymous(self::$allow_anonymous);
- }
+ /**
+ * The configuration values, an empty array by default.
+ */
+ private $data = array();
- public static function _enableApi($value = false) {
- self::$api_enabled = (bool)$value;
- }
- public static function _enableAutologin($value = false) {
- self::$unsafe_autologin_enabled = (bool)$value;
- }
+ /**
+ * The default values, an empty array by default.
+ */
+ private $data_default = array();
+
+ /**
+ * An object which help to set good values in configuration.
+ */
+ private $configuration_setter = null;
public function removeExtension($ext_name) {
self::$extensions_enabled = array_diff(
@@ -179,266 +115,114 @@ class Minz_Configuration {
}
/**
- * Initialise les variables de configuration
- * @exception Minz_FileNotExistException si le CONF_PATH_NAME n'existe pas
- * @exception Minz_BadConfigurationException si CONF_PATH_NAME mal formaté
+ * Create a new Minz_Configuration object.
+ *
+ * @param $namespace the name of the current configuration.
+ * @param $config_filename the file containing configuration values.
+ * @param $default_filename the file containing default values, null by default.
+ * @param $configuration_setter an optional helper to set values in configuration
*/
- public static function init () {
+ private function __construct($namespace, $config_filename, $default_filename = null,
+ $configuration_setter = null) {
+ $this->namespace = $namespace;
+ $this->config_filename = $config_filename;
+
try {
- self::parseFile ();
- self::setReporting ();
+ $this->data = self::load($this->config_filename);
} catch (Minz_FileNotExistException $e) {
- throw $e;
- } catch (Minz_BadConfigurationException $e) {
- throw $e;
+ if (is_null($default_filename)) {
+ throw $e;
+ }
}
- }
- public static function writeFile() {
- $ini_array = array(
- 'general' => array(
- 'environment' => self::environment(true),
- 'salt' => self::$salt,
- 'base_url' => self::$base_url,
- 'title' => self::$title,
- 'default_user' => self::$default_user,
- 'allow_anonymous' => self::$allow_anonymous,
- 'allow_anonymous_refresh' => self::$allow_anonymous_refresh,
- 'auth_type' => self::$auth_type,
- 'api_enabled' => self::$api_enabled,
- 'unsafe_autologin_enabled' => self::$unsafe_autologin_enabled,
- ),
- 'limits' => self::$limits,
- 'db' => self::$db,
- 'extensions_enabled' => self::$extensions_enabled,
- );
- @rename(DATA_PATH . self::CONF_PATH_NAME, DATA_PATH . self::CONF_PATH_NAME . '.bak.php');
- $result = file_put_contents(DATA_PATH . self::CONF_PATH_NAME, "<?php\n return " . var_export($ini_array, true) . ';');
- if (function_exists('opcache_invalidate')) {
- opcache_invalidate(DATA_PATH . self::CONF_PATH_NAME); //Clear PHP 5.5+ cache for include
+ $this->default_filename = $default_filename;
+ if (!is_null($this->default_filename)) {
+ $this->data_default = self::load($this->default_filename);
}
- return (bool)$result;
+
+ $this->_configurationSetter($configuration_setter);
}
/**
- * Parse un fichier de configuration
- * @exception Minz_PermissionDeniedException si le CONF_PATH_NAME n'est pas accessible
- * @exception Minz_BadConfigurationException si CONF_PATH_NAME mal formaté
+ * Set a configuration setter for the current configuration.
+ * @param $configuration_setter the setter to call when modifying data. It
+ * must implement an handle($key, $value) method.
*/
- private static function parseFile () {
- $ini_array = include(DATA_PATH . self::CONF_PATH_NAME);
-
- if (!is_array($ini_array)) {
- throw new Minz_PermissionDeniedException (
- DATA_PATH . self::CONF_PATH_NAME,
- Minz_Exception::ERROR
- );
+ public function _configurationSetter($configuration_setter) {
+ if (is_callable(array($configuration_setter, 'handle'))) {
+ $this->configuration_setter = $configuration_setter;
}
+ }
- // [general] est obligatoire
- if (!isset ($ini_array['general'])) {
- throw new Minz_BadConfigurationException (
- '[general]',
- Minz_Exception::ERROR
- );
- }
- $general = $ini_array['general'];
-
- // salt est obligatoire
- if (!isset ($general['salt'])) {
- if (isset($general['sel_application'])) { //v0.6
- $general['salt'] = $general['sel_application'];
- } else {
- throw new Minz_BadConfigurationException (
- 'salt',
- Minz_Exception::ERROR
- );
- }
+ /**
+ * Return the value of the given param.
+ *
+ * @param $key the name of the param.
+ * @param $default default value to return if key does not exist.
+ * @return the value corresponding to the key.
+ * @throws Minz_ConfigurationParamException if the param does not exist
+ */
+ public function param($key, $default = null) {
+ if (isset($this->data[$key])) {
+ return $this->data[$key];
+ } elseif (!is_null($default)) {
+ return $default;
+ } elseif (isset($this->data_default[$key])) {
+ return $this->data_default[$key];
+ } else {
+ Minz_Log::warning($key . ' does not exist in configuration');
+ return null;
}
- self::$salt = $general['salt'];
+ }
- if (isset ($general['environment'])) {
- switch ($general['environment']) {
- case 'silent':
- self::$environment = Minz_Configuration::SILENT;
- break;
- case 'development':
- self::$environment = Minz_Configuration::DEVELOPMENT;
- break;
- case 'production':
- self::$environment = Minz_Configuration::PRODUCTION;
- break;
- default:
- if ($general['environment'] >= 0 &&
- $general['environment'] <= 2) {
- // fallback 0.7-beta
- self::$environment = $general['environment'];
- } else {
- throw new Minz_BadConfigurationException (
- 'environment',
- Minz_Exception::ERROR
- );
- }
- }
+ /**
+ * A wrapper for param().
+ */
+ public function __get($key) {
+ return $this->param($key);
+ }
+ /**
+ * Set or remove a param.
+ *
+ * @param $key the param name to set.
+ * @param $value the value to set. If null, the key is removed from the configuration.
+ */
+ public function _param($key, $value = null) {
+ if (!is_null($this->configuration_setter) && $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 (!is_null($value)) {
+ $this->data[$key] = $value;
}
- if (isset ($general['base_url'])) {
- self::$base_url = $general['base_url'];
- }
+ }
- if (isset ($general['title'])) {
- self::$title = $general['title'];
- }
- if (isset ($general['language'])) {
- self::$language = $general['language'];
- }
- if (isset ($general['default_user'])) {
- self::$default_user = $general['default_user'];
- }
- if (isset ($general['auth_type'])) {
- self::_authType($general['auth_type']);
- }
- if (isset ($general['allow_anonymous'])) {
- self::$allow_anonymous = (
- ((bool)($general['allow_anonymous'])) &&
- ($general['allow_anonymous'] !== 'no')
- );
- }
- if (isset ($general['allow_anonymous_refresh'])) {
- self::$allow_anonymous_refresh = (
- ((bool)($general['allow_anonymous_refresh'])) &&
- ($general['allow_anonymous_refresh'] !== 'no')
- );
- }
- if (isset ($general['api_enabled'])) {
- self::$api_enabled = (
- ((bool)($general['api_enabled'])) &&
- ($general['api_enabled'] !== 'no')
- );
- }
- if (isset ($general['unsafe_autologin_enabled'])) {
- self::$unsafe_autologin_enabled = (
- ((bool)($general['unsafe_autologin_enabled'])) &&
- ($general['unsafe_autologin_enabled'] !== 'no')
- );
- }
+ /**
+ * A wrapper for _param().
+ */
+ public function __set($key, $value) {
+ $this->_param($key, $value);
+ }
- if (isset($ini_array['limits'])) {
- $limits = $ini_array['limits'];
- if (isset($limits['cache_duration'])) {
- $v = intval($limits['cache_duration']);
- if ($v > 0) {
- self::$limits['cache_duration'] = $v;
- }
- }
- if (isset($limits['timeout'])) {
- $v = intval($limits['timeout']);
- if ($v > 0) {
- self::$limits['timeout'] = $v;
- }
- }
- if (isset($limits['max_inactivity'])) {
- $v = intval($limits['max_inactivity']);
- if ($v > 0) {
- self::$limits['max_inactivity'] = $v;
- }
- }
- if (isset($limits['max_feeds'])) {
- $v = intval($limits['max_feeds']);
- if ($v > 0 && $v < Minz_Configuration::MAX_SMALL_INT) {
- self::$limits['max_feeds'] = $v;
- }
- }
- if (isset($limits['max_categories'])) {
- $v = intval($limits['max_categories']);
- if ($v > 0 && $v < Minz_Configuration::MAX_SMALL_INT) {
- self::$limits['max_categories'] = $v;
- }
- }
- }
+ /**
+ * Save the current configuration in the configuration file.
+ */
+ public function save() {
+ $back_filename = $this->config_filename . '.bak.php';
+ @rename($this->config_filename, $back_filename);
- // Extensions
- if (isset($ini_array['extensions_enabled']) &&
- is_array($ini_array['extensions_enabled'])) {
- self::$extensions_enabled = $ini_array['extensions_enabled'];
+ if (file_put_contents($this->config_filename,
+ "<?php\nreturn " . var_export($this->data, true) . ';',
+ LOCK_EX) === false) {
+ return false;
}
- // Base de données
- if (isset ($ini_array['db'])) {
- $db = $ini_array['db'];
- if (empty($db['type'])) {
- throw new Minz_BadConfigurationException (
- 'type',
- Minz_Exception::ERROR
- );
- }
- switch ($db['type']) {
- case 'mysql':
- if (empty($db['host'])) {
- throw new Minz_BadConfigurationException (
- 'host',
- Minz_Exception::ERROR
- );
- }
- if (empty($db['user'])) {
- throw new Minz_BadConfigurationException (
- 'user',
- Minz_Exception::ERROR
- );
- }
- if (!isset($db['password'])) {
- throw new Minz_BadConfigurationException (
- 'password',
- Minz_Exception::ERROR
- );
- }
- if (empty($db['base'])) {
- throw new Minz_BadConfigurationException (
- 'base',
- Minz_Exception::ERROR
- );
- }
- self::$db['host'] = $db['host'];
- self::$db['user'] = $db['user'];
- self::$db['password'] = $db['password'];
- self::$db['base'] = $db['base'];
- if (isset($db['prefix'])) {
- self::$db['prefix'] = $db['prefix'];
- }
- break;
- case 'sqlite':
- self::$db['host'] = '';
- self::$db['user'] = '';
- self::$db['password'] = '';
- self::$db['base'] = '';
- self::$db['prefix'] = '';
- break;
- default:
- throw new Minz_BadConfigurationException (
- 'type',
- Minz_Exception::ERROR
- );
- break;
- }
- self::$db['type'] = $db['type'];
+ // Clear PHP 5.5+ cache for include
+ if (function_exists('opcache_invalidate')) {
+ opcache_invalidate($this->config_filename);
}
- }
- private static function setReporting() {
- switch (self::$environment) {
- case self::PRODUCTION:
- error_reporting(E_ALL);
- ini_set('display_errors','Off');
- ini_set('log_errors', 'On');
- break;
- case self::DEVELOPMENT:
- error_reporting(E_ALL);
- ini_set('display_errors','On');
- ini_set('log_errors', 'On');
- break;
- case self::SILENT:
- error_reporting(0);
- break;
- }
+ return true;
}
}