11 files changed, 178 insertions, 106 deletions
diff --git a/phpBB/includes/cache/driver/apc.php b/phpBB/includes/cache/driver/apc.php
index dc0144fac3..0516b669c8 100644
--- a/phpBB/includes/cache/driver/apc.php
+++ b/phpBB/includes/cache/driver/apc.php
@@ -26,7 +26,7 @@ class phpbb_cache_driver_apc extends phpbb_cache_driver_memory
 	/**
 	* Purge cache data
 	*
-	* @return void
+	* @return null
 	*/
 	function purge()
 	{
diff --git a/phpBB/includes/cache/driver/eaccelerator.php b/phpBB/includes/cache/driver/eaccelerator.php
index 7939f043c9..257b90c76e 100644
--- a/phpBB/includes/cache/driver/eaccelerator.php
+++ b/phpBB/includes/cache/driver/eaccelerator.php
@@ -30,7 +30,7 @@ class phpbb_cache_driver_eaccelerator extends phpbb_cache_driver_memory
 	/**
 	* Purge cache data
 	*
-	* @return void
+	* @return null
 	*/
 	function purge()
 	{
@@ -47,7 +47,7 @@ class phpbb_cache_driver_eaccelerator extends phpbb_cache_driver_memory
 	/**
 	 * Perform cache garbage collection
 	 *
-	 * @return void
+	 * @return null
 	 */
 	function tidy()
 	{
diff --git a/phpBB/includes/cache/driver/file.php b/phpBB/includes/cache/driver/file.php
index f64a9e3ea8..85decbe3e8 100644
--- a/phpBB/includes/cache/driver/file.php
+++ b/phpBB/includes/cache/driver/file.php
@@ -214,7 +214,12 @@ class phpbb_cache_driver_file extends phpbb_cache_driver_base
 
 		while (($entry = readdir($dir)) !== false)
 		{
-			if (strpos($entry, 'sql_') !== 0 && strpos($entry, 'data_') !== 0 && strpos($entry, 'ctpl_') !== 0 && strpos($entry, 'tpl_') !== 0)
+			if (strpos($entry, 'container_') !== 0 &&
+				strpos($entry, 'url_matcher') !== 0 &&
+				strpos($entry, 'sql_') !== 0 &&
+				strpos($entry, 'data_') !== 0 &&
+				strpos($entry, 'ctpl_') !== 0 &&
+				strpos($entry, 'tpl_') !== 0)
 			{
 				continue;
 			}
@@ -362,12 +367,10 @@ class phpbb_cache_driver_file extends phpbb_cache_driver_base
 	}
 
 	/**
-	* Save sql query
+	* {@inheritDoc}
 	*/
-	function sql_save($query, $query_result, $ttl)
+	function sql_save(phpbb_db_driver $db, $query, $query_result, $ttl)
 	{
-		global $db;
-
 		// Remove extra spaces and tabs
 		$query = preg_replace('/[\n\r\s\t]+/', ' ', $query);
 
@@ -383,10 +386,10 @@ class phpbb_cache_driver_file extends phpbb_cache_driver_base
 
 		if ($this->_write('sql_' . md5($query), $this->sql_rowset[$query_id], $ttl + time(), $query))
 		{
-			$query_result = $query_id;
+			return $query_id;
 		}
 
-		return $query_id;
+		return $query_result;
 	}
 
 	/**
@@ -648,10 +651,11 @@ class phpbb_cache_driver_file extends phpbb_cache_driver_base
 
 		$file = "{$this->cache_dir}$filename.$phpEx";
 
+		$lock = new phpbb_lock_flock($file);
+		$lock->acquire();
+
 		if ($handle = @fopen($file, 'wb'))
 		{
-			@flock($handle, LOCK_EX);
-
 			// File header
 			fwrite($handle, '<' . '?php exit; ?' . '>');
 
@@ -692,7 +696,6 @@ class phpbb_cache_driver_file extends phpbb_cache_driver_base
 				fwrite($handle, $data);
 			}
 
-			@flock($handle, LOCK_UN);
 			fclose($handle);
 
 			if (!function_exists('phpbb_chmod'))
@@ -703,10 +706,16 @@ class phpbb_cache_driver_file extends phpbb_cache_driver_base
 
 			phpbb_chmod($file, CHMOD_READ | CHMOD_WRITE);
 
-			return true;
+			$return_value = true;
+		}
+		else
+		{
+			$return_value = false;
 		}
 
-		return false;
+		$lock->release();
+
+		return $return_value;
 	}
 
 	/**
diff --git a/phpBB/includes/cache/driver/interface.php b/phpBB/includes/cache/driver/interface.php
index 847ba97262..53f684d1c8 100644
--- a/phpBB/includes/cache/driver/interface.php
+++ b/phpBB/includes/cache/driver/interface.php
@@ -63,42 +63,82 @@ interface phpbb_cache_driver_interface
 	public function destroy($var_name, $table = '');
 
 	/**
-	* Check if a given cache entry exist
+	* Check if a given cache entry exists
 	*/
 	public function _exists($var_name);
 
 	/**
-	* Load cached sql query
+	* Load result of an SQL query from cache.
+	*
+	* @param string $query			SQL query
+	*
+	* @return int|bool				Query ID (integer) if cache contains a rowset
+	*								for the specified query.
+	*								False otherwise.
 	*/
 	public function sql_load($query);
 
 	/**
-	* Save sql query
+	* Save result of an SQL query in cache.
+	*
+	* In persistent cache stores, this function stores the query
+	* result to persistent storage. In other words, there is no need
+	* to call save() afterwards.
+	*
+	* @param phpbb_db_driver $db	Database connection
+	* @param string $query			SQL query, should be used for generating storage key
+	* @param mixed $query_result	The result from dbal::sql_query, to be passed to
+	* 								dbal::sql_fetchrow to get all rows and store them
+	* 								in cache.
+	* @param int $ttl				Time to live, after this timeout the query should
+	*								expire from the cache.
+	* @return int|mixed				If storing in cache succeeded, an integer $query_id
+	* 								representing the query should be returned. Otherwise
+	* 								the original $query_result should be returned.
 	*/
-	public function sql_save($query, $query_result, $ttl);
+	public function sql_save(phpbb_db_driver $db, $query, $query_result, $ttl);
 
 	/**
-	* Ceck if a given sql query exist in cache
+	* Check if result for a given SQL query exists in cache.
+	*
+	* @param int $query_id
+	* @return bool
 	*/
 	public function sql_exists($query_id);
 
 	/**
 	* Fetch row from cache (database)
+	*
+	* @param int $query_id
+	* @return array|bool 			The query result if found in the cache, otherwise
+	* 								false.
 	*/
 	public function sql_fetchrow($query_id);
 
 	/**
 	* Fetch a field from the current row of a cached database result (database)
+	*
+	* @param int $query_id
+	* @param $field 				The name of the column.
+	* @return string|bool 			The field of the query result if found in the cache,
+	* 								otherwise false.
 	*/
 	public function sql_fetchfield($query_id, $field);
 
 	/**
 	* Seek a specific row in an a cached database result (database)
+	*
+	* @param int $rownum 			Row to seek to.
+	* @param int $query_id
+	* @return bool
 	*/
 	public function sql_rowseek($rownum, $query_id);
 
 	/**
 	* Free memory used for a cached database result (database)
+	*
+	* @param int $query_id
+	* @return bool
 	*/
 	public function sql_freeresult($query_id);
 }
diff --git a/phpBB/includes/cache/driver/memcache.php b/phpBB/includes/cache/driver/memcache.php
index 9fe70f8b44..3fd16b23b0 100644
--- a/phpBB/includes/cache/driver/memcache.php
+++ b/phpBB/includes/cache/driver/memcache.php
@@ -64,7 +64,7 @@ class phpbb_cache_driver_memcache extends phpbb_cache_driver_memory
 	/**
 	* Unload the cache resources
 	*
-	* @return void
+	* @return null
 	*/
 	function unload()
 	{
@@ -76,7 +76,7 @@ class phpbb_cache_driver_memcache extends phpbb_cache_driver_memory
 	/**
 	* Purge cache data
 	*
-	* @return void
+	* @return null
 	*/
 	function purge()
 	{
diff --git a/phpBB/includes/cache/driver/memory.php b/phpBB/includes/cache/driver/memory.php
index e0771ab1d3..f77a1df316 100644
--- a/phpBB/includes/cache/driver/memory.php
+++ b/phpBB/includes/cache/driver/memory.php
@@ -162,7 +162,12 @@ abstract class phpbb_cache_driver_memory extends phpbb_cache_driver_base
 
 		while (($entry = readdir($dir)) !== false)
 		{
-			if (strpos($entry, 'sql_') !== 0 && strpos($entry, 'data_') !== 0 && strpos($entry, 'ctpl_') !== 0 && strpos($entry, 'tpl_') !== 0)
+			if (strpos($entry, 'container_') !== 0 &&
+				strpos($entry, 'url_matcher') !== 0 &&
+				strpos($entry, 'sql_') !== 0 &&
+				strpos($entry, 'data_') !== 0 &&
+				strpos($entry, 'ctpl_') !== 0 &&
+				strpos($entry, 'tpl_') !== 0)
 			{
 				continue;
 			}
@@ -278,12 +283,10 @@ abstract class phpbb_cache_driver_memory extends phpbb_cache_driver_base
 	}
 
 	/**
-	* Save sql query
+	* {@inheritDoc}
 	*/
-	function sql_save($query, $query_result, $ttl)
+	function sql_save(phpbb_db_driver $db, $query, $query_result, $ttl)
 	{
-		global $db;
-
 		// Remove extra spaces and tabs
 		$query = preg_replace('/[\n\r\s\t]+/', ' ', $query);
 		$hash = md5($query);
@@ -294,7 +297,7 @@ abstract class phpbb_cache_driver_memory extends phpbb_cache_driver_base
 		if (!preg_match('/FROM \\(?(`?\\w+`?(?: \\w+)?(?:, ?`?\\w+`?(?: \\w+)?)*)\\)?/', $query, $regs))
 		{
 			// Bail out if the match fails.
-			return;
+			return $query_result;
 		}
 		$tables = array_map('trim', explode(',', $regs[1]));
 
@@ -334,8 +337,6 @@ abstract class phpbb_cache_driver_memory extends phpbb_cache_driver_base
 
 		$this->_write('sql_' . $hash, $this->sql_rowset[$query_id], $ttl);
 
-		$query_result = $query_id;
-
 		return $query_id;
 	}
 
diff --git a/phpBB/includes/cache/driver/null.php b/phpBB/includes/cache/driver/null.php
index df2c6c026f..2fadc27ba3 100644
--- a/phpBB/includes/cache/driver/null.php
+++ b/phpBB/includes/cache/driver/null.php
@@ -105,10 +105,11 @@ class phpbb_cache_driver_null extends phpbb_cache_driver_base
 	}
 
 	/**
-	* Save sql query
+	* {@inheritDoc}
 	*/
-	function sql_save($query, $query_result, $ttl)
+	function sql_save(phpbb_db_driver $db, $query, $query_result, $ttl)
 	{
+		return $query_result;
 	}
 
 	/**
diff --git a/phpBB/includes/cache/driver/redis.php b/phpBB/includes/cache/driver/redis.php
index a768885962..960735b673 100644
--- a/phpBB/includes/cache/driver/redis.php
+++ b/phpBB/includes/cache/driver/redis.php
@@ -39,13 +39,39 @@ class phpbb_cache_driver_redis extends phpbb_cache_driver_memory
 
 	var $redis;
 
+	/**
+	* Creates a redis cache driver.
+	*
+	* The following global constants affect operation:
+	*
+	* PHPBB_ACM_REDIS_HOST
+	* PHPBB_ACM_REDIS_PORT
+	* PHPBB_ACM_REDIS_PASSWORD
+	* PHPBB_ACM_REDIS_DB
+	*
+	* There are no publicly documented constructor parameters.
+	*/
 	function __construct()
 	{
 		// Call the parent constructor
 		parent::__construct();
 
 		$this->redis = new Redis();
-		$this->redis->connect(PHPBB_ACM_REDIS_HOST, PHPBB_ACM_REDIS_PORT);
+
+		$args = func_get_args();
+		if (!empty($args))
+		{
+			$ok = call_user_func_array(array($this->redis, 'connect'), $args);
+		}
+		else
+		{
+			$ok = $this->redis->connect(PHPBB_ACM_REDIS_HOST, PHPBB_ACM_REDIS_PORT);
+		}
+
+		if (!$ok)
+		{
+			trigger_error('Could not connect to redis server');
+		}
 
 		if (defined('PHPBB_ACM_REDIS_PASSWORD'))
 		{
@@ -74,7 +100,7 @@ class phpbb_cache_driver_redis extends phpbb_cache_driver_memory
 	/**
 	* Unload the cache resources
 	*
-	* @return void
+	* @return null
 	*/
 	function unload()
 	{
@@ -86,7 +112,7 @@ class phpbb_cache_driver_redis extends phpbb_cache_driver_memory
 	/**
 	* Purge cache data
 	*
-	* @return void
+	* @return null
 	*/
 	function purge()
 	{
diff --git a/phpBB/includes/cache/driver/wincache.php b/phpBB/includes/cache/driver/wincache.php
index fa9eb95f88..58f3b4a581 100644
--- a/phpBB/includes/cache/driver/wincache.php
+++ b/phpBB/includes/cache/driver/wincache.php
@@ -26,7 +26,7 @@ class phpbb_cache_driver_wincache extends phpbb_cache_driver_memory
 	/**
 	* Purge cache data
 	*
-	* @return void
+	* @return null
 	*/
 	function purge()
 	{
diff --git a/phpBB/includes/cache/driver/xcache.php b/phpBB/includes/cache/driver/xcache.php
index 0b768bdb3e..06c5fafd97 100644
--- a/phpBB/includes/cache/driver/xcache.php
+++ b/phpBB/includes/cache/driver/xcache.php
@@ -41,7 +41,7 @@ class phpbb_cache_driver_xcache extends phpbb_cache_driver_memory
 	/**
 	* Purge cache data
 	*
-	* @return void
+	* @return null
 	*/
 	function purge()
 	{
diff --git a/phpBB/includes/cache/service.php b/phpBB/includes/cache/service.php
index e63ec6e33a..69c5e0fdd0 100644
--- a/phpBB/includes/cache/service.php
+++ b/phpBB/includes/cache/service.php
@@ -21,16 +21,57 @@ if (!defined('IN_PHPBB'))
 */
 class phpbb_cache_service
 {
-	private $driver;
+	/**
+	* Cache driver.
+	*
+	* @var phpbb_cache_driver_interface
+	*/
+	protected $driver;
+
+	/**
+	* The config.
+	*
+	* @var phpbb_config
+	*/
+	protected $config;
+
+	/**
+	* Database connection.
+	*
+	* @var phpbb_db_driver
+	*/
+	protected $db;
+
+	/**
+	* Root path.
+	*
+	* @var string
+	*/
+	protected $phpbb_root_path;
+
+	/**
+	* PHP extension.
+	*
+	* @var string
+	*/
+	protected $php_ext;
 
 	/**
 	* Creates a cache service around a cache driver
 	*
 	* @param phpbb_cache_driver_interface $driver The cache driver
+	* @param phpbb_config $config The config
+	* @param phpbb_db_driver $db Database connection
+	* @param string $phpbb_root_path Root path
+	* @param string $php_ext PHP extension
 	*/
-	public function __construct(phpbb_cache_driver_interface $driver = null)
+	public function __construct(phpbb_cache_driver_interface $driver, phpbb_config $config, phpbb_db_driver $db, $phpbb_root_path, $php_ext)
 	{
 		$this->set_driver($driver);
+		$this->config = $config;
+		$this->db = $db;
+		$this->phpbb_root_path = $phpbb_root_path;
+		$this->php_ext = $php_ext;
 	}
 
 	/**
@@ -64,21 +105,19 @@ class phpbb_cache_service
 	*/
 	function obtain_word_list()
 	{
-		global $db;
-
 		if (($censors = $this->driver->get('_word_censors')) === false)
 		{
 			$sql = 'SELECT word, replacement
 				FROM ' . WORDS_TABLE;
-			$result = $db->sql_query($sql);
+			$result = $this->db->sql_query($sql);
 
 			$censors = array();
-			while ($row = $db->sql_fetchrow($result))
+			while ($row = $this->db->sql_fetchrow($result))
 			{
 				$censors['match'][] = get_censor_preg_expression($row['word']);
 				$censors['replace'][] = $row['replacement'];
 			}
-			$db->sql_freeresult($result);
+			$this->db->sql_freeresult($result);
 
 			$this->driver->put('_word_censors', $censors);
 		}
@@ -93,23 +132,21 @@ class phpbb_cache_service
 	{
 		if (($icons = $this->driver->get('_icons')) === false)
 		{
-			global $db;
-
 			// Topic icons
 			$sql = 'SELECT *
 				FROM ' . ICONS_TABLE . '
 				ORDER BY icons_order';
-			$result = $db->sql_query($sql);
+			$result = $this->db->sql_query($sql);
 
 			$icons = array();
-			while ($row = $db->sql_fetchrow($result))
+			while ($row = $this->db->sql_fetchrow($result))
 			{
 				$icons[$row['icons_id']]['img'] = $row['icons_url'];
 				$icons[$row['icons_id']]['width'] = (int) $row['icons_width'];
 				$icons[$row['icons_id']]['height'] = (int) $row['icons_height'];
 				$icons[$row['icons_id']]['display'] = (bool) $row['display_on_posting'];
 			}
-			$db->sql_freeresult($result);
+			$this->db->sql_freeresult($result);
 
 			$this->driver->put('_icons', $icons);
 		}
@@ -124,15 +161,13 @@ class phpbb_cache_service
 	{
 		if (($ranks = $this->driver->get('_ranks')) === false)
 		{
-			global $db;
-
 			$sql = 'SELECT *
 				FROM ' . RANKS_TABLE . '
 				ORDER BY rank_min DESC';
-			$result = $db->sql_query($sql);
+			$result = $this->db->sql_query($sql);
 
 			$ranks = array();
-			while ($row = $db->sql_fetchrow($result))
+			while ($row = $this->db->sql_fetchrow($result))
 			{
 				if ($row['rank_special'])
 				{
@@ -150,7 +185,7 @@ class phpbb_cache_service
 					);
 				}
 			}
-			$db->sql_freeresult($result);
+			$this->db->sql_freeresult($result);
 
 			$this->driver->put('_ranks', $ranks);
 		}
@@ -169,8 +204,6 @@ class phpbb_cache_service
 	{
 		if (($extensions = $this->driver->get('_extensions')) === false)
 		{
-			global $db;
-
 			$extensions = array(
 				'_allowed_post'	=> array(),
 				'_allowed_pm'	=> array(),
@@ -181,9 +214,9 @@ class phpbb_cache_service
 				FROM ' . EXTENSIONS_TABLE . ' e, ' . EXTENSION_GROUPS_TABLE . ' g
 				WHERE e.group_id = g.group_id
 					AND (g.allow_group = 1 OR g.allow_in_pm = 1)';
-			$result = $db->sql_query($sql);
+			$result = $this->db->sql_query($sql);
 
-			while ($row = $db->sql_fetchrow($result))
+			while ($row = $this->db->sql_fetchrow($result))
 			{
 				$extension = strtolower(trim($row['extension']));
 
@@ -210,7 +243,7 @@ class phpbb_cache_service
 					$extensions['_allowed_pm'][$extension] = 0;
 				}
 			}
-			$db->sql_freeresult($result);
+			$this->db->sql_freeresult($result);
 
 			$this->driver->put('_extensions', $extensions);
 		}
@@ -275,9 +308,7 @@ class phpbb_cache_service
 	{
 		if (($bots = $this->driver->get('_bots')) === false)
 		{
-			global $db;
-
-			switch ($db->sql_layer)
+			switch ($this->db->sql_layer)
 			{
 				case 'mssql':
 				case 'mssql_odbc':
@@ -303,14 +334,14 @@ class phpbb_cache_service
 					ORDER BY LENGTH(bot_agent) DESC';
 				break;
 			}
-			$result = $db->sql_query($sql);
+			$result = $this->db->sql_query($sql);
 
 			$bots = array();
-			while ($row = $db->sql_fetchrow($result))
+			while ($row = $this->db->sql_fetchrow($result))
 			{
 				$bots[] = $row;
 			}
-			$db->sql_freeresult($result);
+			$this->db->sql_freeresult($result);
 
 			$this->driver->put('_bots', $bots);
 		}
@@ -323,8 +354,6 @@ class phpbb_cache_service
 	*/
 	function obtain_cfg_items($style)
 	{
-		global $config, $phpbb_root_path;
-
 		$parsed_array = $this->driver->get('_cfg_' . $style['style_path']);
 
 		if ($parsed_array === false)
@@ -332,14 +361,14 @@ class phpbb_cache_service
 			$parsed_array = array();
 		}
 
-		$filename = $phpbb_root_path . 'styles/' . $style['style_path'] . '/style.cfg';
+		$filename = $this->phpbb_root_path . 'styles/' . $style['style_path'] . '/style.cfg';
 
 		if (!file_exists($filename))
 		{
 			return $parsed_array;
 		}
 
-		if (!isset($parsed_array['filetime']) || (($config['load_tplcompile'] && @filemtime($filename) > $parsed_array['filetime'])))
+		if (!isset($parsed_array['filetime']) || (($this->config['load_tplcompile'] && @filemtime($filename) > $parsed_array['filetime'])))
 		{
 			// Re-parse cfg file
 			$parsed_array = parse_cfg_file($filename);
@@ -358,54 +387,20 @@ class phpbb_cache_service
 	{
 		if (($usernames = $this->driver->get('_disallowed_usernames')) === false)
 		{
-			global $db;
-
 			$sql = 'SELECT disallow_username
 				FROM ' . DISALLOW_TABLE;
-			$result = $db->sql_query($sql);
+			$result = $this->db->sql_query($sql);
 
 			$usernames = array();
-			while ($row = $db->sql_fetchrow($result))
+			while ($row = $this->db->sql_fetchrow($result))
 			{
 				$usernames[] = str_replace('%', '.*?', preg_quote(utf8_clean_string($row['disallow_username']), '#'));
 			}
-			$db->sql_freeresult($result);
+			$this->db->sql_freeresult($result);
 
 			$this->driver->put('_disallowed_usernames', $usernames);
 		}
 
 		return $usernames;
 	}
-
-	/**
-	* Obtain hooks...
-	*/
-	function obtain_hooks()
-	{
-		global $phpbb_root_path, $phpEx;
-
-		if (($hook_files = $this->driver->get('_hooks')) === false)
-		{
-			$hook_files = array();
-
-			// Now search for hooks...
-			$dh = @opendir($phpbb_root_path . 'includes/hooks/');
-
-			if ($dh)
-			{
-				while (($file = readdir($dh)) !== false)
-				{
-					if (strpos($file, 'hook_') === 0 && substr($file, -(strlen($phpEx) + 1)) === '.' . $phpEx)
-					{
-						$hook_files[] = substr($file, 0, -(strlen($phpEx) + 1));
-					}
-				}
-				closedir($dh);
-			}
-
-			$this->driver->put('_hooks', $hook_files);
-		}
-
-		return $hook_files;
-	}
 }