aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB/includes/extension/finder.php
blob: ee08b0a82aa8ba70e2e030b6f365c5bf2ad30069 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
<?php
/**
*
* @package extension
* @copyright (c) 2011 phpBB Group
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
*
*/

/**
* @ignore
*/
if (!defined('IN_PHPBB'))
{
	exit;
}

/**
* The extension finder provides a simple way to locate files in active extensions
*
* @package extension
*/
class phpbb_extension_finder
{
	protected $extension_manager;
	protected $phpbb_root_path;
	protected $cache;
	protected $phpEx;
	protected $cache_name;

	/**
	* An associative array, containing all search parameters set in methods.
	* @var	array
	*/
	protected $query;

	/**
	* A map from md5 hashes of serialized queries to their previously retrieved
	* results.
	* @var	array
	*/
	protected $cached_queries;

	/**
	* Creates a new finder instance with its dependencies
	*
	* @param phpbb_extension_manager $extension_manager An extension manager
	*            instance that provides the finder with a list of active
	*            extensions and their locations
	* @param string $phpbb_root_path Path to the phpbb root directory
	* @param phpbb_cache_driver_interface $cache A cache instance or null
	* @param string $phpEx php file extension
	* @param string $cache_name The name of the cache variable, defaults to
	*                           _ext_finder
	*/
	public function __construct(phpbb_extension_manager $extension_manager, $phpbb_root_path = '', phpbb_cache_driver_interface $cache = null, $phpEx = '.php', $cache_name = '_ext_finder')
	{
		$this->extension_manager = $extension_manager;
		$this->phpbb_root_path = $phpbb_root_path;
		$this->cache = $cache;
		$this->phpEx = $phpEx;
		$this->cache_name = $cache_name;

		$this->query = array(
			'default_path' => false,
			'default_suffix' => false,
			'default_prefix' => false,
			'default_directory' => false,
			'suffix' => false,
			'prefix' => false,
			'directory' => false,
		);

		$this->cached_queries = ($this->cache) ? $this->cache->get($this->cache_name) : false;
	}

	/**
	* Sets a default path to be searched in addition to extensions
	*
	* @param string $default_path The path relative to /
	* @return phpbb_extension_finder This object for chaining calls
	*/
	public function default_path($default_path)
	{
		$this->query['default_path'] = $default_path;
		return $this;
	}

	/**
	* Sets a suffix all files found in extensions must match
	*
	* Automatically sets the default_suffix if its value does not differ from
	* the current suffix.
	*
	* @param string $suffix A filename suffix
	* @return phpbb_extension_finder This object for chaining calls
	*/
	public function suffix($suffix)
	{
		if ($this->query['default_suffix'] === $this->query['suffix'])
		{
			$this->query['default_suffix'] = $suffix;
		}

		$this->query['suffix'] = $suffix;
		return $this;
	}

	/**
	* Sets a suffix all files found in the default path must match
	*
	* @param string $default_suffix A filename suffix
	* @return phpbb_extension_finder This object for chaining calls
	*/
	public function default_suffix($default_suffix)
	{
		$this->query['default_suffix'] = $default_suffix;
		return $this;
	}

	/**
	* Sets a prefix all files found in extensions must match
	*
	* Automatically sets the default_prefix if its value does not differ from
	* the current prefix.
	*
	* @param string $prefix A filename prefix
	* @return phpbb_extension_finder This object for chaining calls
	*/
	public function prefix($prefix)
	{
		if ($this->query['default_prefix'] === $this->query['prefix'])
		{
			$this->query['default_prefix'] = $prefix;
		}

		$this->query['prefix'] = $prefix;
		return $this;
	}

	/**
	* Sets a prefix all files found in the default path must match
	*
	* @param string $default_prefix A filename prefix
	* @return phpbb_extension_finder This object for chaining calls
	*/
	public function default_prefix($default_prefix)
	{
		$this->query['default_prefix'] = $default_prefix;
		return $this;
	}

	/**
	* Sets a directory all files found in extensions must be contained in
	*
	* Automatically sets the default_directory if its value does not differ from
	* the current directory.
	*
	* @param string $directory
	* @return phpbb_extension_finder This object for chaining calls
	*/
	public function directory($directory)
	{
		if (strlen($directory) > 1 && $directory[strlen($directory) - 1] === '/')
		{
			$directory = substr($directory, 0, -1);
		}

		if ($this->query['default_directory'] === $this->query['directory'])
		{
			$this->query['default_directory'] = $directory;
		}

		$this->query['directory'] = $directory;
		return $this;
	}

	/**
	* Sets a directory all files found in the default path must be contained in
	*
	* @param string $default_directory
	* @return phpbb_extension_finder This object for chaining calls
	*/
	public function default_directory($default_directory)
	{
		if (strlen($default_directory) > 1 && $default_directory[strlen($default_directory) - 1] === '/')
		{
			$default_directory = substr($default_directory, 0, -1);
		}

		$this->query['default_directory'] = $default_directory;
		return $this;
	}

	/**
	* Finds auto loadable php classes matching the configured options.
	*
	* The php file extension is automatically added to suffixes.
	*
	* @param bool $cache Whether the result should be cached
	* @return array An array of found class names
	*/
	public function get_classes($cache = true)
	{
		$this->query['suffix'] .= $this->phpEx;
		$this->query['default_suffix'] .= $this->phpEx;

		$files = $this->find($cache, false);

		$classes = array();
		foreach ($files as $file)
		{
			$file = preg_replace('#^includes/#', '', $file);

			$classes[] = 'phpbb_' . str_replace('/', '_', substr($file, 0, -strlen($this->phpEx)));
		}
		return $classes;
	}

	/**
	* Finds all directories matching the configured options
	*
	* @param bool $cache Whether the result should be cached
	* @return array An array of paths to found directories
	*/
	public function get_directories($cache = true)
	{
		return $this->find_with_root_path($cache, true);
	}

	/**
	* Finds all files matching the configured options.
	*
	* @param bool $cache Whether the result should be cached
	* @return array An array of paths to found files
	*/
	public function get_files($cache = true)
	{
		return $this->find_with_root_path($cache, false);
	}

	/**
	* A wrapper around the general find which prepends a root path to results
	*
	* @param bool $cache Whether the result should be cached
	* @param bool $is_dir Whether the found items should be directories
	* @return array An array of paths to found items
	*/
	protected function find_with_root_path($cache = true, $is_dir = false)
	{
		$items = $this->find($cache, $is_dir);

		$result = array();
		foreach ($items as $item)
		{
			$result[] = $this->phpbb_root_path . $item;
		}

		return $result;
	}

	/**
	* Finds all file system entries matching the configured options
	*
	* @param bool $cache Whether the result should be cached
	* @param bool $is_dir Whether the found items should be directories
	* @return array An array of paths to found items
	*/
	protected function find($cache = true, $is_dir = false)
	{
		$this->query['is_dir'] = $is_dir;
		$query = md5(serialize($this->query));

		if (!defined('DEBUG') && $cache && isset($this->cached_queries[$query]))
		{
			return $this->cached_queries[$query];
		}

		$files = array();

		$extensions = $this->extension_manager->all_enabled();

		if ($this->query['default_path'])
		{
			$extensions['/'] = $this->phpbb_root_path . $this->query['default_path'];
		}

		foreach ($extensions as $name => $path)
		{
			if (!file_exists($path))
			{
				continue;
			}

			if ($name === '/')
			{
				$location = $this->query['default_path'];
				$name = '';
				$suffix = $this->query['default_suffix'];
				$prefix = $this->query['default_prefix'];
				$directory = $this->query['default_directory'];
			}
			else
			{
				$location = 'ext/';
				$name .= '/';
				$suffix = $this->query['suffix'];
				$prefix = $this->query['prefix'];
				$directory = $this->query['directory'];
			}

			// match only first directory if leading slash is given
			if ($directory === '/')
			{
				$directory_pattern = '^' . preg_quote(DIRECTORY_SEPARATOR, '#');
			}
			else if ($directory && $directory[0] === '/')
			{
				$directory_pattern = '^' . preg_quote($directory . DIRECTORY_SEPARATOR, '#');
			}
			else
			{
				$directory_pattern = preg_quote(DIRECTORY_SEPARATOR . $directory . DIRECTORY_SEPARATOR, '#');
			}
			$directory_pattern = '#' . $directory_pattern . '#';

			$iterator = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($path));
			foreach ($iterator as $file_info)
			{
				if ($file_info->isDir() == $is_dir)
				{
					$relative_path = ($is_dir) ? $iterator->getInnerIterator()->getSubPath() . DIRECTORY_SEPARATOR:
						$iterator->getInnerIterator()->getSubPathname();

					$item_name = ($is_dir) ? basename($iterator->getInnerIterator()->getSubPath()) :
						$file_info->getFilename();

					if ((!$suffix || substr($relative_path, -strlen($suffix)) === $suffix) &&
						(!$prefix || substr($item_name, 0, strlen($prefix)) === $prefix) &&
						(!$directory || preg_match($directory_pattern, DIRECTORY_SEPARATOR . $relative_path)))
					{
						$files[] = str_replace(DIRECTORY_SEPARATOR, '/', $location . $name . $relative_path);
					}
				}
			}
		}

		if ($cache && $this->cache)
		{
			$this->cached_queries[$query] = $files;
			$this->cache->put($this->cache_name, $this->cached_queries);
		}

		return $files;
	}
}