[task/config-class] Implemented a config class to replace the global array.

There is a phpbb_config class which simply holds an array and does not persist any data. It implements ArrayAccess, Countable and IteratorAggregate to allow regular use of configuration as if it was still an array. The phpbb_config_db class depends on an instance of the dbal and a cache driver. It obtains the configuration data from cache and database as necessary and persists data to the database. The functions set_config and set_config_count remain for backward compatability but they only call methods on the new config class now instead of directly manipulating the database and cache. PHPBB3-9988
author: Nils Adermann <naderman@naderman.de> 2011-01-10 02:27:18 +0100
committer: Nils Adermann <naderman@naderman.de> 2011-01-10 04:05:23 +0100
commit: fb2642bbc6360dacfd4a3cc9f7e9447b02cb46a1 (patch)
tree: e96dc907ae493b520beccc8823008903c81e86af /phpBB/includes
parent: 5ea59ba3222965c824284a7f0d0648bbe12a7bec (diff)
download: forums-fb2642bbc6360dacfd4a3cc9f7e9447b02cb46a1.tar
forums-fb2642bbc6360dacfd4a3cc9f7e9447b02cb46a1.tar.gz
forums-fb2642bbc6360dacfd4a3cc9f7e9447b02cb46a1.tar.bz2
forums-fb2642bbc6360dacfd4a3cc9f7e9447b02cb46a1.tar.xz
forums-fb2642bbc6360dacfd4a3cc9f7e9447b02cb46a1.zip
8 files changed, 426 insertions, 86 deletions
diff --git a/phpBB/includes/cache/service.php b/phpBB/includes/cache/service.php
index 424606bfc8..bcbb0ce872 100644
--- a/phpBB/includes/cache/service.php
+++ b/phpBB/includes/cache/service.php
@@ -40,51 +40,6 @@ class phpbb_cache_service
 	}
 
 	/**
-	* Get config values
-	*/
-	function obtain_config()
-	{
-		global $db;
-
-		if (($config = $this->acm->get('config')) !== false)
-		{
-			$sql = 'SELECT config_name, config_value
-				FROM ' . CONFIG_TABLE . '
-				WHERE is_dynamic = 1';
-			$result = $db->sql_query($sql);
-
-			while ($row = $db->sql_fetchrow($result))
-			{
-				$config[$row['config_name']] = $row['config_value'];
-			}
-			$db->sql_freeresult($result);
-		}
-		else
-		{
-			$config = $cached_config = array();
-
-			$sql = 'SELECT config_name, config_value, is_dynamic
-				FROM ' . CONFIG_TABLE;
-			$result = $db->sql_query($sql);
-
-			while ($row = $db->sql_fetchrow($result))
-			{
-				if (!$row['is_dynamic'])
-				{
-					$cached_config[$row['config_name']] = $row['config_value'];
-				}
-
-				$config[$row['config_name']] = $row['config_value'];
-			}
-			$db->sql_freeresult($result);
-
-			$this->acm->put('config', $cached_config);
-		}
-
-		return $config;
-	}
-
-	/**
 	* Obtain list of naughty words and build preg style replacement arrays for use by the
 	* calling script
 	*/
diff --git a/phpBB/includes/captcha/plugins/phpbb_captcha_gd_plugin.php b/phpBB/includes/captcha/plugins/phpbb_captcha_gd_plugin.php
index e9cc1f57d2..1c82065a90 100644
--- a/phpBB/includes/captcha/plugins/phpbb_captcha_gd_plugin.php
+++ b/phpBB/includes/captcha/plugins/phpbb_captcha_gd_plugin.php
@@ -152,9 +152,16 @@ class phpbb_captcha_gd extends phpbb_default_captcha
 		global $config;
 
 		$config_old = $config;
+
+		$config = new phpbb_config(array());
+		foreach ($old_config as $key => $value)
+		{
+			$config->set($key, $value);
+		}
+
 		foreach ($this->captcha_vars as $captcha_var => $template_var)
 		{
-				$config[$captcha_var] = request_var($captcha_var, (int) $config[$captcha_var]);
+			$config->set($captcha_var, request_var($captcha_var, (int) $config[$captcha_var]));
 		}
 		parent::execute_demo();
 		$config = $config_old;
diff --git a/phpBB/includes/config/config.php b/phpBB/includes/config/config.php
new file mode 100644
index 0000000000..64fef28cfa
--- /dev/null
+++ b/phpBB/includes/config/config.php
@@ -0,0 +1,157 @@
+<?php
+/**
+*
+* @package phpBB3
+* @copyright (c) 2010 phpBB Group
+* @license http://opensource.org/licenses/gpl-license.php GNU Public License
+*
+*/
+
+/**
+* @ignore
+*/
+if (!defined('IN_PHPBB'))
+{
+	exit;
+}
+
+/**
+* Configuration container class
+* @package phpBB3
+*/
+class phpbb_config implements ArrayAccess, IteratorAggregate, Countable
+{
+	/**
+	* The configuration data
+	* @var array(string => string)
+	*/
+	protected $config;
+
+	/**
+	* Creates a configuration container with a default set of values
+	*
+	* @param array(string => string) $config The configuration data.
+	*/
+	public function __construct(array $config)
+	{
+		$this->config = $config;
+	}
+
+	/**
+	* Retrieves an ArrayIterator over the configuration values.
+	*
+	* @return ArrayIterator An iterator over all config data
+	*/
+	public function getIterator()
+	{
+		return new ArrayIterator($this->config);
+	}
+
+	/**
+	* Checks if the specified config value exists.
+	*
+	* @param  string $key The configuration option's name.
+	* @return bool        Whether the configuration option exists.
+	*/
+	public function offsetExists($key)
+	{
+		return isset($this->config[$key]);
+	}
+
+	/**
+	* Retrieves a configuration value.
+	*
+	* @param  string $key The configuration option's name.
+	* @return string      The configuration value
+	*/
+	public function offsetGet($key)
+	{
+		return (isset($this->config[$key])) ? $this->config[$key] : '';
+	}
+
+	/**
+	* Temporarily overwrites the value of a configuration variable.
+	*
+	* The configuration change will not persist. It will be lost
+	* after the request.
+	*
+	* @param string $key   The configuration option's name.
+	* @param string $value The temporary value.
+	*/
+	public function offsetSet($key, $value)
+	{
+		$this->config[$key] = $value;
+	}
+
+	/**
+	* Called when deleting a configuration value directly, triggers an error.
+	*
+	* @param string $key The configuration option's name.
+	*/
+	public function offsetUnset($key)
+	{
+		trigger_error('Config values have to be deleted explicitly with the phpbb_config::delete($key) method.', E_USER_ERROR);
+	}
+
+	/**
+	* Retrieves the number of configuration options currently set.
+	*
+	* @return int Number of config options
+	*/
+	public function count()
+	{
+		return count($this->config);
+	}
+
+	/**
+	* Sets a configuration option's value
+	*
+	* @param string $key   The configuration option's name
+	* @param string $value New configuration value
+	* @param bool   $cache Whether this variable should be cached or if it
+	*                      changes too frequently to be efficiently cached.
+	*/
+	public function set($key, $value, $cache = true)
+	{
+		$this->config[$key] = $value;
+	}
+
+	/**
+	* Sets a configuration option's value only if the old_value matches the
+	* current configuration value or the configuration value does not exist yet.
+	*
+	* @param  string $key       The configuration option's name
+	* @param  string $old_value Current configuration value
+	* @param  string $value     New configuration value
+	* @param  bool   $cache     Whether this variable should be cached or if it
+	*                           changes too frequently to be efficiently cached.
+	* @return bool              True if the value was changed, false otherwise.
+	*/
+	public function set_atomic($key, $old_value, $value, $cache = true)
+	{
+		if (!isset($this->config[$key]) || $this->config[$key] == $old_value)
+		{
+			$this->config[$key] = $value;
+			return true;
+		}
+		return false;
+	}
+
+	/**
+	* Increments an integer configuration value.
+	*
+	* @param string $key       The configuration option's name
+	* @param int    $increment Amount to increment by
+	* @param bool   $cache     Whether this variable should be cached or if it
+	*                          changes too frequently to be efficiently cached.
+	*/
+	function increment($key, $increment, $cache = true)
+	{
+		if (!isset($this->config[$key]))
+		{
+			$this->config[$key] = 0;
+		}
+
+		$this->config[$key] += $increment;
+	}
+}
diff --git a/phpBB/includes/config/db.php b/phpBB/includes/config/db.php
new file mode 100644
index 0000000000..e6b7bffb73
--- /dev/null
+++ b/phpBB/includes/config/db.php
@@ -0,0 +1,175 @@
+<?php
+/**
+*
+* @package phpBB3
+* @copyright (c) 2010 phpBB Group
+* @license http://opensource.org/licenses/gpl-license.php GNU Public License
+*
+*/
+
+/**
+* @ignore
+*/
+if (!defined('IN_PHPBB'))
+{
+	exit;
+}
+
+/**
+* Configuration container class
+* @package phpBB3
+*/
+class phpbb_config_db extends phpbb_config
+{
+	/**
+	* Cache instance
+	* @var phpbb_cache_driver_interface
+	*/
+	protected $cache;
+
+	/**
+	* Database connection
+	* @var dbal
+	*/
+	protected $db;
+
+	/**
+	* Creates a configuration container with a default set of values
+	*
+	* @param phpbb_cache_driver_interface $cache Cache instance
+	* @param dbal                         $db    Database connection
+	* @param string                       $table Configuration table name
+	*/
+	public function __construct(phpbb_cache_driver_interface $cache, dbal $db, $table)
+	{
+		$this->db = $db;
+		$this->cache = $cache;
+		$this->table = $table;
+
+		if (($config = $cache->get('config')) !== false)
+		{
+			$sql = 'SELECT config_name, config_value
+				FROM ' . $this->table . '
+				WHERE is_dynamic = 1';
+			$result = $this->db->sql_query($sql);
+			$config += $this->db->sql_fetchrowset($result);
+			$this->db->sql_freeresult($result);
+		}
+		else
+		{
+			$config = $cached_config = array();
+
+			$sql = 'SELECT config_name, config_value, is_dynamic
+				FROM ' . $this->table;
+			$result = $this->db->sql_query($sql);
+
+			while ($row = $this->db->sql_fetchrow($result))
+			{
+				if (!$row['is_dynamic'])
+				{
+					$cached_config[$row['config_name']] = $row['config_value'];
+				}
+
+				$config[$row['config_name']] = $row['config_value'];
+			}
+			$this->db->sql_freeresult($result);
+
+			$cache->put('config', $cached_config);
+		}
+
+		parent::__construct($config);
+	}
+
+	/**
+	* Sets a configuration option's value
+	*
+	* @param string $key   The configuration option's name
+	* @param string $value New configuration value
+	* @param bool   $cache Whether this variable should be cached or if it
+	*                      changes too frequently to be efficiently cached.
+	*/
+	public function set($key, $value, $cache = true)
+	{
+		$this->set_atomic($key, false, $value, $cache);
+	}
+
+	/**
+	* Sets a configuration option's value only if the old_value matches the
+	* current configuration value or the configuration value does not exist yet.
+	*
+	* @param  string $key       The configuration option's name
+	* @param  mixed  $old_value Current configuration value or false to ignore
+	*                           the old value
+	* @param  string $new_value New configuration value
+	* @param  bool   $cache     Whether this variable should be cached or if it
+	*                           changes too frequently to be efficiently cached
+	* @return bool              True if the value was changed, false otherwise
+	*/
+	public function set_atomic($key, $old_value, $new_value, $cache = true)
+	{
+		$sql = 'UPDATE ' . $this->table . "
+			SET config_value = '" . $this->db->sql_escape($new_value) . "'
+			WHERE config_name = '" . $this->db->sql_escape($key) . "'";
+
+		if ($old_value !== false)
+		{
+			$sql .= " AND config_value = '" . $this->db->sql_escape($old_value) . "'";
+		}
+
+		$result = $this->db->sql_query($sql);
+
+		if (!$this->db->sql_affectedrows($result) && isset($this->config[$key]))
+		{
+			return false;
+		}
+
+		if (!isset($this->config[$key]))
+		{
+			$sql = 'INSERT INTO ' . $this->table . ' ' . $this->db->sql_build_array('INSERT', array(
+				'config_name'	=> $key,
+				'config_value'	=> $new_value,
+				'is_dynamic'	=> ($cache) ? 0 : 1));
+			$this->db->sql_query($sql);
+		}
+
+		if ($cache)
+		{
+			$this->cache->destroy('config');
+		}
+
+		$this->config[$key] = $new_value;
+		return true;
+	}
+
+	/**
+	* Increments an integer config value directly in the database.
+	*
+	* Using this method instead of setting the new value directly avoids race
+	* conditions and unlike set_atomic it cannot fail.
+	*
+	* @param string $key       The configuration option's name
+	* @param int    $increment Amount to increment by
+	* @param bool   $cache     Whether this variable should be cached or if it
+	*                          changes too frequently to be efficiently cached.
+	*/
+	function increment($key, $increment, $cache = true)
+	{
+		if (!isset($this->config[$key]))
+		{
+			$this->set($key, '0', $cache);
+		}
+
+		$sql_update = $this->db->cast_expr_to_string($this->db->cast_expr_to_bigint('config_value') . ' + ' . (int) $increment);
+
+		$this->db->sql_query('UPDATE ' . $this->table . '
+			SET config_value = ' . $sql_update . "
+			WHERE config_name = '" . $this->db->sql_escape($key) . "'");
+
+		if ($cache)
+		{
+			$this->cache->destroy('config');
+		}
+
+		$this->config[$key] += $increment;
+	}
+}
diff --git a/phpBB/includes/db/dbal.php b/phpBB/includes/db/dbal.php
index fd0464814f..cfebb61440 100644
--- a/phpBB/includes/db/dbal.php
+++ b/phpBB/includes/db/dbal.php
@@ -448,6 +448,28 @@ class dbal
 	}
 
 	/**
+	* Returns SQL string to cast a string expression to an int.
+	*
+	* @param  string $expression An expression evaluating to string
+	* @return string             Expression returning an int
+	*/
+	function cast_expr_to_bigint($expression)
+	{
+		return $expression;
+	}
+
+	/**
+	* Returns SQL string to cast an integer expression to a string.
+	*
+	* @param  string $expression An expression evaluating to int
+	* @return string             Expression returning a string
+	*/
+	function cast_expr_to_string($expression)
+	{
+		return $expression;
+	}
+
+	/**
 	* Run more than one insert statement.
 	*
 	* @param string $table table name to run the statements on
diff --git a/phpBB/includes/db/firebird.php b/phpBB/includes/db/firebird.php
index 68069ab6cf..69476f79f8 100644
--- a/phpBB/includes/db/firebird.php
+++ b/phpBB/includes/db/firebird.php
@@ -466,6 +466,22 @@ class dbal_firebird extends dbal
 	}
 
 	/**
+	* @inheritdoc
+	*/
+	function cast_expr_to_bigint($expression)
+	{
+		return 'CAST(' . $expression . ' as DECIMAL(255, 0))';
+	}
+
+	/**
+	* @inheritdoc
+	*/
+	function cast_expr_to_string($expression)
+	{
+		return 'CAST(' . $expression . ' as VARCHAR(255))';
+	}
+
+	/**
 	* return sql error array
 	* @access private
 	*/
diff --git a/phpBB/includes/db/postgres.php b/phpBB/includes/db/postgres.php
index eb297b8db5..424ce12245 100644
--- a/phpBB/includes/db/postgres.php
+++ b/phpBB/includes/db/postgres.php
@@ -366,6 +366,22 @@ class dbal_postgres extends dbal
 	}
 
 	/**
+	* @inheritdoc
+	*/
+	function cast_expr_to_bigint($expression)
+	{
+		return 'CAST(' . $expression . ' as DECIMAL(255, 0))';
+	}
+
+	/**
+	* @inheritdoc
+	*/
+	function cast_expr_to_string($expression)
+	{
+		return 'CAST(' . $expression . ' as VARCHAR(255))';
+	}
+
+	/**
 	* return sql error array
 	* @access private
 	*/
diff --git a/phpBB/includes/functions.php b/phpBB/includes/functions.php
index c55931a2fb..12e4ebc597 100644
--- a/phpBB/includes/functions.php
+++ b/phpBB/includes/functions.php
@@ -17,7 +17,11 @@ if (!defined('IN_PHPBB'))
 }
 
 // Common global functions
-
+/**
+* Casts a variable to the given type.
+*
+* @deprecated
+*/
 function set_var(&$result, $var, $type, $multibyte = false)
 {
 	// no need for dependency injection here, if you have the object, call the method yourself!
@@ -30,6 +34,7 @@ function set_var(&$result, $var, $type, $multibyte = false)
 * See {@link phpbb_request_interface::variable phpbb_request_interface::variable} for
 * documentation of this function's use.
 *
+* @deprecated
 * @param	mixed			$var_name	The form variable's name from which data shall be retrieved.
 * 										If the value is an array this may be an array of indizes which will give
 * 										direct access to a value at any depth. E.g. if the value of "var" is array(1 => "a")
@@ -78,59 +83,46 @@ function request_var($var_name, $default, $multibyte = false, $cookie = false, p
 
 /**
 * Set config value. Creates missing config entry.
+*
+* @deprecated
 */
-function set_config($config_name, $config_value, $is_dynamic = false)
+function set_config($config_name, $config_value, $is_dynamic = false, phpbb_config $set_config = null)
 {
-	global $db, $cache, $config;
-
-	$sql = 'UPDATE ' . CONFIG_TABLE . "
-		SET config_value = '" . $db->sql_escape($config_value) . "'
-		WHERE config_name = '" . $db->sql_escape($config_name) . "'";
-	$db->sql_query($sql);
+	static $config = null;
 
-	if (!$db->sql_affectedrows() && !isset($config[$config_name]))
+	if ($set_config !== null)
 	{
-		$sql = 'INSERT INTO ' . CONFIG_TABLE . ' ' . $db->sql_build_array('INSERT', array(
-			'config_name'	=> $config_name,
-			'config_value'	=> $config_value,
-			'is_dynamic'	=> ($is_dynamic) ? 1 : 0));
-		$db->sql_query($sql);
-	}
-
-	$config[$config_name] = $config_value;
+		$config = $set_config;
 
-	if (!$is_dynamic)
-	{
-		$cache->destroy('config');
+		if (empty($config_name))
+		{
+			return;
+		}
 	}
+
+	$config->set($config_name, $config_value, !$is_dynamic);
 }
 
 /**
 * Set dynamic config value with arithmetic operation.
+*
+* @deprecated
 */
-function set_config_count($config_name, $increment, $is_dynamic = false)
+function set_config_count($config_name, $increment, $is_dynamic = false, phpbb_config $set_config = null)
 {
-	global $db, $cache;
+	static $config = null;
 
-	switch ($db->sql_layer)
+	if ($set_config !== null)
 	{
-		case 'firebird':
-		case 'postgres':
-			$sql_update = 'CAST(CAST(config_value as DECIMAL(255, 0)) + ' . (int) $increment . ' as VARCHAR(255))';
-		break;
+		$config = $set_config;
 
-		// MySQL, SQlite, mssql, mssql_odbc, oracle
-		default:
-			$sql_update = 'config_value + ' . (int) $increment;
-		break;
+		if (empty($config_name))
+		{
+			return;
+		}
 	}
 
-	$db->sql_query('UPDATE ' . CONFIG_TABLE . ' SET config_value = ' . $sql_update . " WHERE config_name = '" . $db->sql_escape($config_name) . "'");
-
-	if (!$is_dynamic)
-	{
-		$cache->destroy('config');
-	}
+	$config->increment($config_name, $increment, !$is_dynamic);
 }
 
 /**
@@ -3546,7 +3538,7 @@ function phpbb_checkdnsrr($host, $type = 'MX')
 	// but until 5.3.3 it only works for MX records
 	// See: http://bugs.php.net/bug.php?id=51844
 
-	// Call checkdnsrr() if 
+	// Call checkdnsrr() if
 	// we're looking for an MX record or
 	// we're not on Windows or
 	// we're running a PHP version where #51844 has been fixed
@@ -3566,7 +3558,7 @@ function phpbb_checkdnsrr($host, $type = 'MX')
 	// dns_get_record() is available since PHP 5; since PHP 5.3 also on Windows,
 	// but on Windows it does not work reliable for AAAA records before PHP 5.3.1
 
-	// Call dns_get_record() if 
+	// Call dns_get_record() if
 	// we're not looking for an AAAA record or
 	// we're not on Windows or
 	// we're running a PHP version where AAAA lookups work reliable
@@ -3596,7 +3588,7 @@ function phpbb_checkdnsrr($host, $type = 'MX')
 		foreach ($resultset as $result)
 		{
 			if (
-				isset($result['host']) && $result['host'] == $host && 
+				isset($result['host']) && $result['host'] == $host &&
 				isset($result['type']) && $result['type'] == $type
 			)
 			{
author	Nils Adermann <naderman@naderman.de>	2011-01-10 02:27:18 +0100
committer	Nils Adermann <naderman@naderman.de>	2011-01-10 04:05:23 +0100
commit	fb2642bbc6360dacfd4a3cc9f7e9447b02cb46a1 (patch)
tree	e96dc907ae493b520beccc8823008903c81e86af /phpBB/includes
parent	5ea59ba3222965c824284a7f0d0648bbe12a7bec (diff)
download	forums-fb2642bbc6360dacfd4a3cc9f7e9447b02cb46a1.tar forums-fb2642bbc6360dacfd4a3cc9f7e9447b02cb46a1.tar.gz forums-fb2642bbc6360dacfd4a3cc9f7e9447b02cb46a1.tar.bz2 forums-fb2642bbc6360dacfd4a3cc9f7e9447b02cb46a1.tar.xz forums-fb2642bbc6360dacfd4a3cc9f7e9447b02cb46a1.zip