-
Notifications
You must be signed in to change notification settings - Fork 704
Expand file tree
/
Copy pathModule.php
More file actions
458 lines (396 loc) · 14.8 KB
/
Copy pathModule.php
File metadata and controls
458 lines (396 loc) · 14.8 KB
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
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
<?php
declare(strict_types=1);
namespace SimpleSAML;
use Exception;
use SimpleSAML\Assert\Assert;
use SimpleSAML\Utils;
use Symfony\Component\Filesystem\Filesystem;
use Symfony\Component\Filesystem\Path;
use Symfony\Component\Finder\Finder;
use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\HttpFoundation\Request;
use function array_key_exists;
use function class_exists;
use function count;
use function dirname;
use function explode;
use function in_array;
use function is_bool;
use function is_callable;
use function is_dir;
use function is_subclass_of;
use function rtrim;
use function str_replace;
use function strval;
/**
* Helper class for accessing information about modules.
*
* @package SimpleSAMLphp
*/
class Module
{
/**
* Index pages: file names to attempt when accessing directories.
*
* @var string[]
*/
public static array $indexFiles = ['index.php', 'index.html', 'index.htm', 'index.txt'];
/**
* MIME Types
*
* The key is the file extension and the value the corresponding MIME type.
*
* @var array<string, string>
*/
public static array $mimeTypes = [
'bmp' => 'image/x-ms-bmp',
'css' => 'text/css',
'gif' => 'image/gif',
'htm' => 'text/html',
'html' => 'text/html',
'shtml' => 'text/html',
'ico' => 'image/vnd.microsoft.icon',
'jpe' => 'image/jpeg',
'jpeg' => 'image/jpeg',
'jpg' => 'image/jpeg',
'js' => 'text/javascript',
'pdf' => 'application/pdf',
'png' => 'image/png',
'svg' => 'image/svg+xml',
'svgz' => 'image/svg+xml',
'swf' => 'application/x-shockwave-flash',
'swfl' => 'application/x-shockwave-flash',
'txt' => 'text/plain',
'xht' => 'application/xhtml+xml',
'xhtml' => 'application/xhtml+xml',
];
/**
* A list containing the modules currently installed.
*
* @var string[]
*/
public static array $modules = [];
/**
* A list containing the modules that are enabled by default, unless specifically disabled
*
* @var array<string, bool>
*/
public static array $core_modules = [
'core' => true,
'admin' => true,
'saml' => true,
];
/**
* A cache containing specific information for modules, like whether they are enabled or not, or their hooks.
*
* @var array
*/
public static array $module_info = [];
/**
* Retrieve the base directory for a module.
*
* The returned path name will be an absolute path.
*
* @param string $module Name of the module
*
* @return string The base directory of a module.
*/
public static function getModuleDir(string $module): string
{
$baseDir = dirname(__FILE__, 3) . '/modules';
$moduleDir = $baseDir . '/' . $module;
return $moduleDir;
}
/**
* Determine whether a module is enabled.
*
* Will return false if the given module doesn't exist.
*
* @param string $module Name of the module
*
* @return bool True if the given module is enabled, false otherwise.
*
* @throws \Exception If module.enable is set and is not boolean.
*/
public static function isModuleEnabled(string $module): bool
{
$config = Configuration::getOptionalConfig();
return self::isModuleEnabledWithConf($module, $config->getOptionalArray('module.enable', self::$core_modules));
}
/**
* Legacy handler for the removed module.php entry point.
*
* @param \Symfony\Component\HttpFoundation\Request|null $request
* The request to process. Defaults to the current one.
* @return never
*
* @throws \SimpleSAML\Error\NotFound Always, because module.php is no longer supported.
*/
public static function process(?Request $request = null): never
{
throw new Error\NotFound('The module.php entry point is no longer supported.');
}
/**
* Get absolute URL to a published module asset.
*
* @param string $module Module name.
* @param string $asset Asset path relative to the module assets directory.
* @param array $parameters Extra parameters which should be added to the URL. Optional.
* @return string
*/
public static function getModuleAssetUrl(
string $module,
string $asset,
array $parameters = [],
): string {
$httpUtils = new Utils\HTTP();
$url = $httpUtils->getBaseURL() . 'assets/' . $module . '/' . ltrim($asset, '/');
if (!empty($parameters)) {
$url = $httpUtils->addURLParameters($url, $parameters);
}
return $url;
}
/**
* @param string $module
* @param array $mod_config
* @return bool
*/
private static function isModuleEnabledWithConf(string $module, array $mod_config): bool
{
if (isset(self::$module_info[$module]['enabled'])) {
return self::$module_info[$module]['enabled'];
}
if (!empty(self::$modules) && !in_array($module, self::$modules, true)) {
return false;
}
$moduleDir = self::getModuleDir($module);
if (!is_dir($moduleDir)) {
self::$module_info[$module]['enabled'] = false;
return false;
}
if (isset($mod_config[$module])) {
if (is_bool($mod_config[$module])) {
self::$module_info[$module]['enabled'] = $mod_config[$module];
return $mod_config[$module];
}
throw new Exception("Invalid module.enable value for the '$module' module.");
}
$core_module = array_key_exists($module, self::$core_modules) ? true : false;
self::$module_info[$module]['enabled'] = $core_module ? true : false;
return $core_module ? true : false;
}
/**
* Get available modules.
*
* @return string[] One string for each module.
*
* @throws \Exception If we cannot open the module's directory.
*/
public static function getModules(): array
{
if (!empty(self::$modules)) {
return self::$modules;
}
$path = self::getModuleDir('.');
$finder = new Finder();
$finder->directories()->in($path)->depth(0);
foreach ($finder as $module) {
self::$modules[] = $module->getFileName();
}
return self::$modules;
}
/**
* Resolve module class.
*
* This function takes a string on the form "<module>:<class>" and converts it to a class
* name. It can also check that the given class is a subclass of a specific class. The
* resolved classname will be "\SimleSAML\Module\<module>\<$type>\<class>.
*
* It is also possible to specify a full classname instead of <module>:<class>.
*
* An exception will be thrown if the class can't be resolved.
*
* @param string $id The string we should resolve.
* @param string $type The type of the class.
* @param string|null $subclass The class should be a subclass of this class. Optional.
*
* @return string The classname.
*
* @throws \Exception If the class cannot be resolved.
*/
public static function resolveClass(string $id, string $type, ?string $subclass = null): string
{
$tmp = explode(':', $id, 2);
if (count($tmp) === 1) {
// no module involved
$className = $tmp[0];
if (!class_exists($className)) {
throw new Exception("Could not resolve '$id': no class named '$className'.");
}
} elseif (!in_array($tmp[0], self::getModules())) {
// Module not installed
throw new Exception('No module named \'' . $tmp[0] . '\' has been installed.');
} elseif (!self::isModuleEnabled($tmp[0])) {
// Module installed, but not enabled
throw new Exception('The module \'' . $tmp[0] . '\' is not enabled.');
} else {
// should be a module
// make sure empty types are handled correctly
$type = (empty($type)) ? '\\' : '\\' . $type . '\\';
$className = 'SimpleSAML\\Module\\' . $tmp[0] . $type . $tmp[1];
}
// Check if the class exists to give a more informative error
// for cases where modules might have been moved or renamed.
// Otherwise a not subclass of error would be thrown for a class
// that does not exist.
if (!class_exists($className, true)) {
throw new Exception(
'Could not resolve \'' . $id . '\': The class \'' . $className
. '\' does not exist.',
);
}
if ($subclass !== null && !is_subclass_of($className, $subclass)) {
throw new Exception(
'Could not resolve \'' . $id . '\': The class \'' . $className
. '\' isn\'t a subclass of \'' . $subclass . '\'.',
);
}
return $className;
}
/**
* Create an object of a class returned by resolveNonModuleClass() or resolveClass().
*
* @param string $className The classname.
* @param string|null $subclass The class should be a subclass of this class. Optional.
*
* @return object The new object
*/
public static function createObject(string $className, ?string $subclass = null): object
{
$obj = new $className();
if ($subclass) {
if (!is_subclass_of($obj, $subclass, false)) {
throw new Exception(
'Could not instantiate \'' . $className . '\': The class \'' . $className
. '\' isn\'t a subclass of \'' . $subclass . '\'.',
);
}
}
return $obj;
}
/**
* Get absolute URL to a specified module resource.
*
* This function creates an absolute URL to a resource stored under ".../modules/<module>/public/".
*
* @param string $resource Resource path, on the form "<module name>/<resource>"
* @param array $parameters Extra parameters which should be added to the URL. Optional.
*
* @return string The absolute URL to the given resource.
*/
public static function getModuleURL(string $resource, array $parameters = []): string
{
Assert::notSame($resource[0], '/');
$httpUtils = new Utils\HTTP();
$url = $httpUtils->getBaseURL() . 'module/' . $resource;
if (!empty($parameters)) {
$url = $httpUtils->addURLParameters($url, $parameters);
}
return $url;
}
/**
* Get the available hooks for a given module.
*
* @param string $module The module where we should look for hooks.
*
* @return array An array with the hooks available for this module. Each element is an array with two keys: 'file'
* points to the file that contains the hook, and 'func' contains the name of the function implementing that hook.
* When there are no hooks defined, an empty array is returned.
*/
public static function getModuleHooks(string $module): array
{
if (isset(self::$modules[$module]['hooks'])) {
return self::$modules[$module]['hooks'];
}
$hooks = [];
$hook_dir = Path::canonicalize(dirname(__FILE__, 3) . '/modules/' . $module . '/hooks');
if ((new Filesystem())->exists($hook_dir)) {
$finder = new Finder();
$finder->files()->in($hook_dir)->depth(0);
foreach ($finder as $file) {
if (preg_match('/^hook_(\w+)\.php$/', $file->getFileName(), $matches)) {
$hook_name = $matches[1];
$hook_func = $module . '_hook_' . $hook_name;
$hooks[$hook_name] = ['file' => Path::canonicalize(strval($file)), 'func' => $hook_func];
}
}
}
return $hooks;
}
/**
* Call a hook in all enabled modules.
*
* This function iterates over all enabled modules and calls a hook in each module.
*
* @param string $hook The name of the hook.
* @param mixed &$data The data which should be passed to each hook. Will be passed as a reference.
*
* @throws \SimpleSAML\Error\Exception If an invalid hook is found in a module.
*/
public static function callHooks(string $hook, mixed &$data = null): void
{
$modules = self::getModules();
$config = Configuration::getOptionalConfig()->getOptionalArray('module.enable', self::$core_modules);
sort($modules);
foreach ($modules as $module) {
if (!self::isModuleEnabledWithConf($module, $config)) {
continue;
}
if (!isset(self::$module_info[$module]['hooks'])) {
self::$module_info[$module]['hooks'] = self::getModuleHooks($module);
}
if (
!isset(self::$module_info[$module]['hooks'][$hook])
|| empty(self::$module_info[$module]['hooks'][$hook])
) {
continue;
}
require_once(self::$module_info[$module]['hooks'][$hook]['file']);
if (!is_callable(self::$module_info[$module]['hooks'][$hook]['func'])) {
throw new Error\Exception('Invalid hook \'' . $hook . '\' for module \'' . $module . '\'.');
}
$fn = self::$module_info[$module]['hooks'][$hook]['func'];
$fn($data);
}
}
/**
* Handle a valid request for a module that lacks a trailing slash.
*
* This method add the trailing slash and redirects to the resulting URL.
*
* @param \Symfony\Component\HttpFoundation\Request $request The request to process by this controller method.
* @return \Symfony\Component\HttpFoundation\RedirectResponse
* A redirection to the URI specified in the request, but with a trailing slash.
*/
public static function addTrailingSlash(Request $request): RedirectResponse
{
// Must be of form /{module} - append a slash
return new RedirectResponse($request->getRequestUri() . '/', 308);
}
/**
* Handle a valid request that ends with a trailing slash.
*
* This method removes the trailing slash and redirects to the resulting URL.
*
* @param \Symfony\Component\HttpFoundation\Request $request The request to process by this controller method.
*
* @return \Symfony\Component\HttpFoundation\RedirectResponse
* A redirection to the URI specified in the request, but without the trailing slash.
*/
public static function removeTrailingSlash(Request $request): RedirectResponse
{
$pathInfo = $request->server->get('PATH_INFO');
$url = str_replace($pathInfo, rtrim($pathInfo, ' /'), $request->getRequestUri());
return new RedirectResponse($url, 308);
}
}