From 7adae349a96d5dffbd47ea5eca1e6bee481b7ce1 Mon Sep 17 00:00:00 2001
From: Oleg Pudeyev <oleg@bsdpower.com>
Date: Tue, 1 Jan 2013 20:48:04 -0500
Subject: [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/includes/hook/finder.php | 84 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 84 insertions(+)
 create mode 100644 phpBB/includes/hook/finder.php

(limited to 'phpBB/includes/hook')

diff --git a/phpBB/includes/hook/finder.php b/phpBB/includes/hook/finder.php
new file mode 100644
index 0000000000..065e685514
--- /dev/null
+++ b/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;
+	}
+}
-- 
cgit v1.2.1