[ticket/11305] Extract hook finder from cache service.

Unlike most other things in cache service, hook finder does not need
a database connection.

PHPBB3-11305

phpBB/common.php

@@ -120,8 +120,9 @@ $phpbb_style = $phpbb_container->get('style');
 // Add own hook handler
 require($phpbb_root_path . 'includes/hooks/index.' . $phpEx);
 $phpbb_hook = new phpbb_hook(array('exit_handler', 'phpbb_user_session_handler', 'append_sid', array('phpbb_template', 'display')));
+$phpbb_hook_finder = new phpbb_hook_finder($phpbb_root_path, $phpEx, $phpbb_container->get('cache.driver'));
 
-foreach ($cache->obtain_hooks() as $hook)
+foreach ($phpbb_hook_finder->find() as $hook)
 {
 	@include($phpbb_root_path . 'includes/hooks/' . $hook . '.' . $phpEx);
 }

phpBB/includes/cache/service.php

@@ -403,34 +403,4 @@ class phpbb_cache_service
 
 		return $usernames;
 	}
-
-	/**
-	* Obtain hooks...
-	*/
-	function obtain_hooks()
-	{
-		if (($hook_files = $this->driver->get('_hooks')) === false)
-		{
-			$hook_files = array();
-
-			// Now search for hooks...
-			$dh = @opendir($this->phpbb_root_path . 'includes/hooks/');
-
-			if ($dh)
-			{
-				while (($file = readdir($dh)) !== false)
-				{
-					if (strpos($file, 'hook_') === 0 && substr($file, -(strlen($this->php_ext) + 1)) === '.' . $this->php_ext)
-					{
-						$hook_files[] = substr($file, 0, -(strlen($this->php_ext) + 1));
-					}
-				}
-				closedir($dh);
-			}
-
-			$this->driver->put('_hooks', $hook_files);
-		}
-
-		return $hook_files;
-	}
 }

phpBB/includes/hook/finder.php

@@ -0,0 +1,84 @@
+<?php
+/**
+*
+* @package extension
+* @copyright (c) 2013 phpBB Group
+* @license http://opensource.org/licenses/gpl-2.0.php GNU General Public License v2
+*
+*/
+
+/**
+* @ignore
+*/
+if (!defined('IN_PHPBB'))
+{
+	exit;
+}
+
+/**
+* The hook finder locates installed hooks.
+*
+* @package phpBB3
+*/
+class phpbb_hook_finder
+{
+	protected $phpbb_root_path;
+	protected $cache;
+	protected $php_ext;
+
+	/**
+	* Creates a new finder instance.
+	*
+	* @param string $phpbb_root_path Path to the phpbb root directory
+	* @param string $php_ext php file extension
+	* @param phpbb_cache_driver_interface $cache A cache instance or null
+	*/
+	public function __construct($phpbb_root_path, $php_ext, phpbb_cache_driver_interface $cache = null)
+	{
+		$this->phpbb_root_path = $phpbb_root_path;
+		$this->cache = $cache;
+		$this->php_ext = $php_ext;
+	}
+
+	/**
+	* Finds all hook files.
+	*
+	* @param bool $cache Whether the result should be cached
+	* @return array An array of paths to found hook files
+	*/
+	public function find($cache = true)
+	{
+		if (!defined('DEBUG') && $cache && $this->cache)
+		{
+			$hook_files = $this->cache->get('_hooks');
+			if ($hook_files !== false)
+			{
+				return $hook_files;
+			}
+		}
+
+		$hook_files = array();
+
+		// Now search for hooks...
+		$dh = @opendir($this->phpbb_root_path . 'includes/hooks/');
+
+		if ($dh)
+		{
+			while (($file = readdir($dh)) !== false)
+			{
+				if (strpos($file, 'hook_') === 0 && substr($file, -(strlen($this->php_ext) + 1)) === '.' . $this->php_ext)
+				{
+					$hook_files[] = substr($file, 0, -(strlen($this->php_ext) + 1));
+				}
+			}
+			closedir($dh);
+		}
+
+		if ($cache && $this->cache)
+		{
+			$this->cache->put('_hooks', $hook_files);
+		}
+
+		return $hook_files;
+	}
+}

phpBB/install/database_update.php

@@ -133,7 +133,8 @@ if (file_exists($phpbb_root_path . 'includes/hooks/index.' . $phpEx))
 	require($phpbb_root_path . 'includes/hooks/index.' . $phpEx);
 	$phpbb_hook = new phpbb_hook(array('exit_handler', 'phpbb_user_session_handler', 'append_sid', array('template', 'display')));
 
-	foreach ($cache->obtain_hooks() as $hook)
+	$phpbb_hook_finder = new phpbb_hook_finder($phpbb_root_path, $phpEx, $phpbb_container->get('cache.driver'));
+	foreach ($phpbb_hook_finder->find() as $hook)
 	{
 		@include($phpbb_root_path . 'includes/hooks/' . $hook . '.' . $phpEx);
 	}

phpBB/install/index.php

@@ -199,7 +199,8 @@ if (file_exists($phpbb_root_path . 'includes/hooks/index.' . $phpEx))
 	require($phpbb_root_path . 'includes/hooks/index.' . $phpEx);
 	$phpbb_hook = new phpbb_hook(array('exit_handler', 'phpbb_user_session_handler', 'append_sid', array('template', 'display')));
 
-	foreach ($cache->obtain_hooks() as $hook)
+	$phpbb_hook_finder = new phpbb_hook_finder($phpbb_root_path, $phpEx, $phpbb_container->get('cache.driver'));
+	foreach ($phpbb_hook_finder->find() as $hook)
 	{
 		@include($phpbb_root_path . 'includes/hooks/' . $hook . '.' . $phpEx);
 	}