diff options
author | Pierre Schmitz <pierre@archlinux.de> | 2014-12-27 15:41:37 +0100 |
---|---|---|
committer | Pierre Schmitz <pierre@archlinux.de> | 2014-12-31 11:43:28 +0100 |
commit | c1f9b1f7b1b77776192048005dcc66dcf3df2bfb (patch) | |
tree | 2b38796e738dd74cb42ecd9bfd151803108386bc /includes/config | |
parent | b88ab0086858470dd1f644e64cb4e4f62bb2be9b (diff) |
Update to MediaWiki 1.24.1
Diffstat (limited to 'includes/config')
-rw-r--r-- | includes/config/Config.php | 47 | ||||
-rw-r--r-- | includes/config/ConfigException.php | 29 | ||||
-rw-r--r-- | includes/config/ConfigFactory.php | 112 | ||||
-rw-r--r-- | includes/config/GlobalVarConfig.php | 108 | ||||
-rw-r--r-- | includes/config/HashConfig.php | 75 | ||||
-rw-r--r-- | includes/config/MultiConfig.php | 72 | ||||
-rw-r--r-- | includes/config/MutableConfig.php | 38 |
7 files changed, 481 insertions, 0 deletions
diff --git a/includes/config/Config.php b/includes/config/Config.php new file mode 100644 index 00000000..38f589dc --- /dev/null +++ b/includes/config/Config.php @@ -0,0 +1,47 @@ +<?php +/** + * Copyright 2014 + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * http://www.gnu.org/copyleft/gpl.html + * + * @file + */ + +/** + * Interface for configuration instances + * + * @since 1.23 + */ +interface Config { + + /** + * Get a configuration variable such as "Sitename" or "UploadMaintenance." + * + * @param string $name Name of configuration option + * @return mixed Value configured + * @throws ConfigException + */ + public function get( $name ); + + /** + * Check whether a configuration option is set for the given name + * + * @param string $name Name of configuration option + * @return bool + * @since 1.24 + */ + public function has( $name ); +} diff --git a/includes/config/ConfigException.php b/includes/config/ConfigException.php new file mode 100644 index 00000000..75cd5eeb --- /dev/null +++ b/includes/config/ConfigException.php @@ -0,0 +1,29 @@ +<?php +/** + * Copyright 2014 + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * http://www.gnu.org/copyleft/gpl.html + * + * @file + */ + +/** + * Exceptions for config failures + * + * @since 1.23 + */ +class ConfigException extends MWException { +} diff --git a/includes/config/ConfigFactory.php b/includes/config/ConfigFactory.php new file mode 100644 index 00000000..12b0c399 --- /dev/null +++ b/includes/config/ConfigFactory.php @@ -0,0 +1,112 @@ +<?php + +/** + * Copyright 2014 + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * http://www.gnu.org/copyleft/gpl.html + * + * @file + */ + +/** + * Factory class to create Config objects + * + * @since 1.23 + */ +class ConfigFactory { + + /** + * Map of config name => callback + * @var array + */ + protected $factoryFunctions = array(); + + /** + * Config objects that have already been created + * name => Config object + * @var array + */ + protected $configs = array(); + + /** + * @var ConfigFactory + */ + private static $self; + + public static function getDefaultInstance() { + if ( !self::$self ) { + self::$self = new self; + global $wgConfigRegistry; + foreach ( $wgConfigRegistry as $name => $callback ) { + self::$self->register( $name, $callback ); + } + } + return self::$self; + } + + /** + * Destroy the default instance + * Should only be called inside unit tests + * @throws MWException + * @codeCoverageIgnore + */ + public static function destroyDefaultInstance() { + if ( !defined( 'MW_PHPUNIT_TEST' ) ) { + throw new MWException( __METHOD__ . ' was called outside of unit tests' ); + } + + self::$self = null; + } + + /** + * Register a new config factory function + * Will override if it's already registered + * @param string $name + * @param callable $callback That takes this ConfigFactory as an argument + * @throws InvalidArgumentException If an invalid callback is provided + */ + public function register( $name, $callback ) { + if ( !is_callable( $callback ) ) { + throw new InvalidArgumentException( 'Invalid callback provided' ); + } + $this->factoryFunctions[$name] = $callback; + } + + /** + * Create a given Config using the registered callback for $name. + * If an object was already created, the same Config object is returned. + * @param string $name Name of the extension/component you want a Config object for + * 'main' is used for core + * @throws ConfigException If a factory function isn't registered for $name + * @throws UnexpectedValueException If the factory function returns a non-Config object + * @return Config + */ + public function makeConfig( $name ) { + if ( !isset( $this->configs[$name] ) ) { + if ( !isset( $this->factoryFunctions[$name] ) ) { + throw new ConfigException( "No registered builder available for $name." ); + } + $conf = call_user_func( $this->factoryFunctions[$name], $this ); + if ( $conf instanceof Config ) { + $this->configs[$name] = $conf; + } else { + throw new UnexpectedValueException( "The builder for $name returned a non-Config object." ); + } + } + + return $this->configs[$name]; + } +} diff --git a/includes/config/GlobalVarConfig.php b/includes/config/GlobalVarConfig.php new file mode 100644 index 00000000..39d6e8e1 --- /dev/null +++ b/includes/config/GlobalVarConfig.php @@ -0,0 +1,108 @@ +<?php +/** + * Copyright 2014 + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * http://www.gnu.org/copyleft/gpl.html + * + * @file + */ + +/** + * Accesses configuration settings from $GLOBALS + * + * @since 1.23 + */ +class GlobalVarConfig implements Config { + + /** + * Prefix to use for configuration variables + * @var string + */ + private $prefix; + + /** + * Default builder function + * @return GlobalVarConfig + */ + public static function newInstance() { + return new GlobalVarConfig(); + } + + public function __construct( $prefix = 'wg' ) { + $this->prefix = $prefix; + } + + /** + * @see Config::get + */ + public function get( $name ) { + if ( !$this->has( $name ) ) { + throw new ConfigException( __METHOD__ . ": undefined option: '$name'" ); + } + return $this->getWithPrefix( $this->prefix, $name ); + } + + /** + * @see Config::has + */ + public function has( $name ) { + return $this->hasWithPrefix( $this->prefix, $name ); + } + + /** + * @see MutableConfig::set + * @deprecated since 1.24 + */ + public function set( $name, $value ) { + wfDeprecated( __METHOD__, '1.24' ); + $this->setWithPrefix( $this->prefix, $name, $value ); + } + + /** + * Get a variable with a given prefix, if not the defaults. + * + * @param string $prefix Prefix to use on the variable, if one. + * @param string $name Variable name without prefix + * @return mixed + */ + protected function getWithPrefix( $prefix, $name ) { + return $GLOBALS[$prefix . $name]; + } + + /** + * Check if a variable with a given prefix is set + * + * @param string $prefix Prefix to use on the variable + * @param string $name Variable name without prefix + * @return bool + */ + protected function hasWithPrefix( $prefix, $name ) { + $var = $prefix . $name; + return array_key_exists( $var, $GLOBALS ); + } + + /** + * Get a variable with a given prefix, if not the defaults. + * + * @param string $prefix Prefix to use on the variable + * @param string $name Variable name without prefix + * @param mixed $value Value to set + * @deprecated since 1.24 + */ + protected function setWithPrefix( $prefix, $name, $value ) { + $GLOBALS[$prefix . $name] = $value; + } +} diff --git a/includes/config/HashConfig.php b/includes/config/HashConfig.php new file mode 100644 index 00000000..a09a0a43 --- /dev/null +++ b/includes/config/HashConfig.php @@ -0,0 +1,75 @@ +<?php +/** + * Copyright 2014 + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * http://www.gnu.org/copyleft/gpl.html + * + * @file + */ + +/** + * A Config instance which stores all settings as a member variable + * + * @since 1.24 + */ +class HashConfig implements Config, MutableConfig { + + /** + * Array of config settings + * + * @var array + */ + private $settings; + + /** + * @return HashConfig + */ + public static function newInstance() { + return new HashConfig; + } + + /** + * @param array $settings Any current settings to pre-load + */ + public function __construct( array $settings = array() ) { + $this->settings = $settings; + } + + /** + * @see Config::get + */ + public function get( $name ) { + if ( !$this->has( $name ) ) { + throw new ConfigException( __METHOD__ . ": undefined option: '$name'" ); + } + + return $this->settings[$name]; + } + + /** + * @see Config::has + */ + public function has( $name ) { + return array_key_exists( $name, $this->settings ); + } + + /** + * @see Config::set + */ + public function set( $name, $value ) { + $this->settings[$name] = $value; + } +} diff --git a/includes/config/MultiConfig.php b/includes/config/MultiConfig.php new file mode 100644 index 00000000..cbb65aa6 --- /dev/null +++ b/includes/config/MultiConfig.php @@ -0,0 +1,72 @@ +<?php +/** + * Copyright 2014 + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * http://www.gnu.org/copyleft/gpl.html + * + * @file + */ + +/** + * Provides a fallback sequence for Config objects + * + * @since 1.24 + */ +class MultiConfig implements Config { + + /** + * Array of Config objects to use + * Order matters, the Config objects + * will be checked in order to see + * whether they have the requested setting + * + * @var Config[] + */ + private $configs; + + /** + * @param Config[] $configs + */ + public function __construct( array $configs ) { + $this->configs = $configs; + } + + /** + * @see Config::get + */ + public function get( $name ) { + foreach ( $this->configs as $config ) { + if ( $config->has( $name ) ) { + return $config->get( $name ); + } + } + + throw new ConfigException( __METHOD__ . ": undefined option: '$name'" ); + } + + /** + * @see Config::has + */ + public function has( $name ) { + foreach ( $this->configs as $config ) { + if ( $config->has( $name ) ) { + return true; + } + } + + return false; + } +} diff --git a/includes/config/MutableConfig.php b/includes/config/MutableConfig.php new file mode 100644 index 00000000..e765e3bc --- /dev/null +++ b/includes/config/MutableConfig.php @@ -0,0 +1,38 @@ +<?php +/** + * Copyright 2014 + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * http://www.gnu.org/copyleft/gpl.html + * + * @file + */ + +/** + * Interface for mutable configuration instances + * + * @since 1.24 + */ +interface MutableConfig { + + /** + * Set a configuration variable such a "Sitename" to something like "My Wiki" + * + * @param string $name Name of configuration option + * @param mixed $value Value to set + * @throws ConfigException + */ + public function set( $name, $value ); +} |