first commit
This commit is contained in:
CHIEFSOFT\ameye
@@ -0,0 +1,869 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* This file is part of CodeIgniter 4 framework.
|
||||
*
|
||||
* (c) CodeIgniter Foundation <admin@codeigniter.com>
|
||||
*
|
||||
* For the full copyright and license information, please view
|
||||
* the LICENSE file that was distributed with this source code.
|
||||
*/
|
||||
|
||||
namespace CodeIgniter\Filters;
|
||||
|
||||
use CodeIgniter\Config\Filters as BaseFiltersConfig;
|
||||
use CodeIgniter\Exceptions\ConfigException;
|
||||
use CodeIgniter\Filters\Exceptions\FilterException;
|
||||
use CodeIgniter\HTTP\RequestInterface;
|
||||
use CodeIgniter\HTTP\ResponseInterface;
|
||||
use Config\Feature;
|
||||
use Config\Filters as FiltersConfig;
|
||||
use Config\Modules;
|
||||
|
||||
/**
|
||||
* Filters
|
||||
*
|
||||
* @see \CodeIgniter\Filters\FiltersTest
|
||||
*/
|
||||
class Filters
|
||||
{
|
||||
/**
|
||||
* The original config file
|
||||
*
|
||||
* @var FiltersConfig
|
||||
*/
|
||||
protected $config;
|
||||
|
||||
/**
|
||||
* The active IncomingRequest or CLIRequest
|
||||
*
|
||||
* @var RequestInterface
|
||||
*/
|
||||
protected $request;
|
||||
|
||||
/**
|
||||
* The active Response instance
|
||||
*
|
||||
* @var ResponseInterface
|
||||
*/
|
||||
protected $response;
|
||||
|
||||
/**
|
||||
* Handle to the modules config.
|
||||
*
|
||||
* @var Modules
|
||||
*/
|
||||
protected $modules;
|
||||
|
||||
/**
|
||||
* Whether we've done initial processing
|
||||
* on the filter lists.
|
||||
*
|
||||
* @var bool
|
||||
*/
|
||||
protected $initialized = false;
|
||||
|
||||
/**
|
||||
* The processed filters that will
|
||||
* be used to check against.
|
||||
*
|
||||
* This does not include "Required Filters".
|
||||
*
|
||||
* @var array<string, array>
|
||||
*/
|
||||
protected $filters = [
|
||||
'before' => [],
|
||||
'after' => [],
|
||||
];
|
||||
|
||||
/**
|
||||
* The collection of filters' class names that will
|
||||
* be used to execute in each position.
|
||||
*
|
||||
* This does not include "Required Filters".
|
||||
*
|
||||
* @var array<string, array>
|
||||
*/
|
||||
protected $filtersClass = [
|
||||
'before' => [],
|
||||
'after' => [],
|
||||
];
|
||||
|
||||
/**
|
||||
* Any arguments to be passed to filters.
|
||||
*
|
||||
* @var array<string, list<string>|null> [name => params]
|
||||
*/
|
||||
protected $arguments = [];
|
||||
|
||||
/**
|
||||
* Any arguments to be passed to filtersClass.
|
||||
*
|
||||
* @var array<class-string, list<string>|null> [classname => arguments]
|
||||
*/
|
||||
protected $argumentsClass = [];
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param FiltersConfig $config
|
||||
*/
|
||||
public function __construct($config, RequestInterface $request, ResponseInterface $response, ?Modules $modules = null)
|
||||
{
|
||||
$this->config = $config;
|
||||
$this->request = &$request;
|
||||
$this->setResponse($response);
|
||||
|
||||
$this->modules = $modules ?? config(Modules::class);
|
||||
|
||||
if ($this->modules->shouldDiscover('filters')) {
|
||||
$this->discoverFilters();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* If discoverFilters is enabled in Config then system will try to
|
||||
* auto-discover custom filters files in Namespaces and allow access to
|
||||
* the config object via the variable $filters as with the routes file
|
||||
*
|
||||
* Sample :
|
||||
* $filters->aliases['custom-auth'] = \Acme\Blob\Filters\BlobAuth::class;
|
||||
*
|
||||
* @deprecated 4.4.2 Use Registrar instead.
|
||||
*/
|
||||
private function discoverFilters(): void
|
||||
{
|
||||
$locator = service('locator');
|
||||
|
||||
// for access by custom filters
|
||||
$filters = $this->config;
|
||||
|
||||
$files = $locator->search('Config/Filters.php');
|
||||
|
||||
foreach ($files as $file) {
|
||||
// The $file may not be a class file.
|
||||
$className = $locator->getClassname($file);
|
||||
|
||||
// Don't include our main Filter config again...
|
||||
if ($className === FiltersConfig::class || $className === BaseFiltersConfig::class) {
|
||||
continue;
|
||||
}
|
||||
|
||||
include $file;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the response explicitly.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function setResponse(ResponseInterface $response)
|
||||
{
|
||||
$this->response = $response;
|
||||
}
|
||||
|
||||
/**
|
||||
* Runs through all of the filters for the specified
|
||||
* uri and position.
|
||||
*
|
||||
* @param string $uri URI path relative to baseURL
|
||||
* @phpstan-param 'before'|'after' $position
|
||||
*
|
||||
* @return RequestInterface|ResponseInterface|string|null
|
||||
*
|
||||
* @throws FilterException
|
||||
*/
|
||||
public function run(string $uri, string $position = 'before')
|
||||
{
|
||||
$this->initialize(strtolower($uri));
|
||||
|
||||
if ($position === 'before') {
|
||||
return $this->runBefore($this->filtersClass[$position]);
|
||||
}
|
||||
|
||||
// After
|
||||
return $this->runAfter($this->filtersClass[$position]);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return RequestInterface|ResponseInterface|string
|
||||
*/
|
||||
private function runBefore(array $filterClasses)
|
||||
{
|
||||
foreach ($filterClasses as $className) {
|
||||
$class = new $className();
|
||||
|
||||
if (! $class instanceof FilterInterface) {
|
||||
throw FilterException::forIncorrectInterface($class::class);
|
||||
}
|
||||
|
||||
$result = $class->before(
|
||||
$this->request,
|
||||
$this->argumentsClass[$className] ?? null
|
||||
);
|
||||
|
||||
if ($result instanceof RequestInterface) {
|
||||
$this->request = $result;
|
||||
|
||||
continue;
|
||||
}
|
||||
|
||||
// If the response object was sent back,
|
||||
// then send it and quit.
|
||||
if ($result instanceof ResponseInterface) {
|
||||
// short circuit - bypass any other filters
|
||||
return $result;
|
||||
}
|
||||
|
||||
// Ignore an empty result
|
||||
if (empty($result)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
return $this->request;
|
||||
}
|
||||
|
||||
private function runAfter(array $filterClasses): ResponseInterface
|
||||
{
|
||||
foreach ($filterClasses as $className) {
|
||||
$class = new $className();
|
||||
|
||||
if (! $class instanceof FilterInterface) {
|
||||
throw FilterException::forIncorrectInterface($class::class);
|
||||
}
|
||||
|
||||
$result = $class->after(
|
||||
$this->request,
|
||||
$this->response,
|
||||
$this->argumentsClass[$className] ?? null
|
||||
);
|
||||
|
||||
if ($result instanceof ResponseInterface) {
|
||||
$this->response = $result;
|
||||
|
||||
continue;
|
||||
}
|
||||
}
|
||||
|
||||
return $this->response;
|
||||
}
|
||||
|
||||
/**
|
||||
* Runs "Required Filters" for the specified position.
|
||||
*
|
||||
* @return RequestInterface|ResponseInterface|string|null
|
||||
*
|
||||
* @phpstan-param 'before'|'after' $position
|
||||
*
|
||||
* @throws FilterException
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
public function runRequired(string $position = 'before')
|
||||
{
|
||||
[$filters, $aliases] = $this->getRequiredFilters($position);
|
||||
|
||||
if ($filters === []) {
|
||||
return $position === 'before' ? $this->request : $this->response;
|
||||
}
|
||||
|
||||
$filterClasses = [];
|
||||
|
||||
foreach ($filters as $alias) {
|
||||
if (is_array($aliases[$alias])) {
|
||||
$filterClasses[$position] = array_merge($filterClasses[$position], $aliases[$alias]);
|
||||
} else {
|
||||
$filterClasses[$position][] = $aliases[$alias];
|
||||
}
|
||||
}
|
||||
|
||||
if ($position === 'before') {
|
||||
return $this->runBefore($filterClasses[$position]);
|
||||
}
|
||||
|
||||
// After
|
||||
return $this->runAfter($filterClasses[$position]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns "Required Filters" for the specified position.
|
||||
*
|
||||
* @phpstan-param 'before'|'after' $position
|
||||
*
|
||||
* @internal
|
||||
*/
|
||||
public function getRequiredFilters(string $position = 'before'): array
|
||||
{
|
||||
// For backward compatibility. For users who do not update Config\Filters.
|
||||
if (! isset($this->config->required[$position])) {
|
||||
$baseConfig = config(BaseFiltersConfig::class); // @phpstan-ignore-line
|
||||
$filters = $baseConfig->required[$position];
|
||||
$aliases = $baseConfig->aliases;
|
||||
} else {
|
||||
$filters = $this->config->required[$position];
|
||||
$aliases = $this->config->aliases;
|
||||
}
|
||||
|
||||
if ($filters === []) {
|
||||
return [[], $aliases];
|
||||
}
|
||||
|
||||
if ($position === 'after') {
|
||||
if (in_array('toolbar', $this->filters['after'], true)) {
|
||||
// It was already run in globals filters. So remove it.
|
||||
$filters = $this->setToolbarToLast($filters, true);
|
||||
} else {
|
||||
// Set the toolbar filter to the last position to be executed
|
||||
$filters = $this->setToolbarToLast($filters);
|
||||
}
|
||||
}
|
||||
|
||||
foreach ($filters as $alias) {
|
||||
if (! array_key_exists($alias, $aliases)) {
|
||||
throw FilterException::forNoAlias($alias);
|
||||
}
|
||||
}
|
||||
|
||||
return [$filters, $aliases];
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the toolbar filter to the last position to be executed.
|
||||
*
|
||||
* @param list<string> $filters `after` filter array
|
||||
* @param bool $remove if true, remove `toolbar` filter
|
||||
*/
|
||||
private function setToolbarToLast(array $filters, bool $remove = false): array
|
||||
{
|
||||
$afters = [];
|
||||
$found = false;
|
||||
|
||||
foreach ($filters as $alias) {
|
||||
if ($alias === 'toolbar') {
|
||||
$found = true;
|
||||
|
||||
continue;
|
||||
}
|
||||
|
||||
$afters[] = $alias;
|
||||
}
|
||||
|
||||
if ($found && ! $remove) {
|
||||
$afters[] = 'toolbar';
|
||||
}
|
||||
|
||||
return $afters;
|
||||
}
|
||||
|
||||
/**
|
||||
* Runs through our list of filters provided by the configuration
|
||||
* object to get them ready for use, including getting uri masks
|
||||
* to proper regex, removing those we can from the possibilities
|
||||
* based on HTTP method, etc.
|
||||
*
|
||||
* The resulting $this->filters is an array of only filters
|
||||
* that should be applied to this request.
|
||||
*
|
||||
* We go ahead and process the entire tree because we'll need to
|
||||
* run through both a before and after and don't want to double
|
||||
* process the rows.
|
||||
*
|
||||
* @param string|null $uri URI path relative to baseURL (all lowercase)
|
||||
*
|
||||
* @TODO We don't need to accept null as $uri.
|
||||
*
|
||||
* @return Filters
|
||||
*/
|
||||
public function initialize(?string $uri = null)
|
||||
{
|
||||
if ($this->initialized === true) {
|
||||
return $this;
|
||||
}
|
||||
|
||||
// Decode URL-encoded string
|
||||
$uri = urldecode($uri ?? '');
|
||||
|
||||
$oldFilterOrder = config(Feature::class)->oldFilterOrder ?? false;
|
||||
if ($oldFilterOrder) {
|
||||
$this->processGlobals($uri);
|
||||
$this->processMethods();
|
||||
$this->processFilters($uri);
|
||||
} else {
|
||||
$this->processFilters($uri);
|
||||
$this->processMethods();
|
||||
$this->processGlobals($uri);
|
||||
}
|
||||
|
||||
// Set the toolbar filter to the last position to be executed
|
||||
$this->filters['after'] = $this->setToolbarToLast($this->filters['after']);
|
||||
|
||||
$this->processAliasesToClass('before');
|
||||
$this->processAliasesToClass('after');
|
||||
|
||||
$this->initialized = true;
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Restores instance to its pre-initialized state.
|
||||
* Most useful for testing so the service can be
|
||||
* re-initialized to a different path.
|
||||
*/
|
||||
public function reset(): self
|
||||
{
|
||||
$this->initialized = false;
|
||||
|
||||
$this->arguments = $this->argumentsClass = [];
|
||||
|
||||
$this->filters = $this->filtersClass = [
|
||||
'before' => [],
|
||||
'after' => [],
|
||||
];
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the processed filters array.
|
||||
* This does not include "Required Filters".
|
||||
*/
|
||||
public function getFilters(): array
|
||||
{
|
||||
return $this->filters;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the filtersClass array.
|
||||
* This does not include "Required Filters".
|
||||
*/
|
||||
public function getFiltersClass(): array
|
||||
{
|
||||
return $this->filtersClass;
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds a new alias to the config file.
|
||||
* MUST be called prior to initialize();
|
||||
* Intended for use within routes files.
|
||||
*
|
||||
* @return $this
|
||||
*/
|
||||
public function addFilter(string $class, ?string $alias = null, string $when = 'before', string $section = 'globals')
|
||||
{
|
||||
$alias ??= md5($class);
|
||||
|
||||
if (! isset($this->config->{$section})) {
|
||||
$this->config->{$section} = [];
|
||||
}
|
||||
|
||||
if (! isset($this->config->{$section}[$when])) {
|
||||
$this->config->{$section}[$when] = [];
|
||||
}
|
||||
|
||||
$this->config->aliases[$alias] = $class;
|
||||
|
||||
$this->config->{$section}[$when][] = $alias;
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Ensures that a specific filter is on and enabled for the current request.
|
||||
*
|
||||
* Filters can have "arguments". This is done by placing a colon immediately
|
||||
* after the filter name, followed by a comma-separated list of arguments that
|
||||
* are passed to the filter when executed.
|
||||
*
|
||||
* @param string $name filter_name or filter_name:arguments like 'role:admin,manager'
|
||||
*/
|
||||
private function enableFilter(string $name, string $when = 'before'): void
|
||||
{
|
||||
// Get arguments and clean name
|
||||
[$name, $arguments] = $this->getCleanName($name);
|
||||
$this->arguments[$name] = ($arguments !== []) ? $arguments : null;
|
||||
|
||||
if (class_exists($name)) {
|
||||
$this->config->aliases[$name] = $name;
|
||||
} elseif (! array_key_exists($name, $this->config->aliases)) {
|
||||
throw FilterException::forNoAlias($name);
|
||||
}
|
||||
|
||||
$classNames = (array) $this->config->aliases[$name];
|
||||
|
||||
foreach ($classNames as $className) {
|
||||
$this->argumentsClass[$className] = $this->arguments[$name] ?? null;
|
||||
}
|
||||
|
||||
if (! isset($this->filters[$when][$name])) {
|
||||
$this->filters[$when][] = $name;
|
||||
$this->filtersClass[$when] = array_merge($this->filtersClass[$when], $classNames);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get clean name and arguments
|
||||
*
|
||||
* @param string $name filter_name or filter_name:arguments like 'role:admin,manager'
|
||||
*
|
||||
* @return array{0: string, 1: list<string>} [name, arguments]
|
||||
*/
|
||||
private function getCleanName(string $name): array
|
||||
{
|
||||
$arguments = [];
|
||||
|
||||
if (str_contains($name, ':')) {
|
||||
[$name, $arguments] = explode(':', $name);
|
||||
|
||||
$arguments = explode(',', $arguments);
|
||||
array_walk($arguments, static function (&$item): void {
|
||||
$item = trim($item);
|
||||
});
|
||||
}
|
||||
|
||||
return [$name, $arguments];
|
||||
}
|
||||
|
||||
/**
|
||||
* Ensures that specific filters are on and enabled for the current request.
|
||||
*
|
||||
* Filters can have "arguments". This is done by placing a colon immediately
|
||||
* after the filter name, followed by a comma-separated list of arguments that
|
||||
* are passed to the filter when executed.
|
||||
*
|
||||
* @params array<string> $names filter_name or filter_name:arguments like 'role:admin,manager'
|
||||
*
|
||||
* @return Filters
|
||||
*/
|
||||
public function enableFilters(array $names, string $when = 'before')
|
||||
{
|
||||
foreach ($names as $filter) {
|
||||
$this->enableFilter($filter, $when);
|
||||
}
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the arguments for a specified key, or all.
|
||||
*
|
||||
* @return array<string, string>|string
|
||||
*/
|
||||
public function getArguments(?string $key = null)
|
||||
{
|
||||
return $key === null ? $this->arguments : $this->arguments[$key];
|
||||
}
|
||||
|
||||
// --------------------------------------------------------------------
|
||||
// Processors
|
||||
// --------------------------------------------------------------------
|
||||
|
||||
/**
|
||||
* Add any applicable (not excluded) global filter settings to the mix.
|
||||
*
|
||||
* @param string|null $uri URI path relative to baseURL (all lowercase)
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
protected function processGlobals(?string $uri = null)
|
||||
{
|
||||
if (! isset($this->config->globals) || ! is_array($this->config->globals)) {
|
||||
return;
|
||||
}
|
||||
|
||||
$uri = strtolower(trim($uri ?? '', '/ '));
|
||||
|
||||
// Add any global filters, unless they are excluded for this URI
|
||||
$sets = ['before', 'after'];
|
||||
|
||||
$filters = [];
|
||||
|
||||
foreach ($sets as $set) {
|
||||
if (isset($this->config->globals[$set])) {
|
||||
// look at each alias in the group
|
||||
foreach ($this->config->globals[$set] as $alias => $rules) {
|
||||
$keep = true;
|
||||
if (is_array($rules)) {
|
||||
// see if it should be excluded
|
||||
if (isset($rules['except'])) {
|
||||
// grab the exclusion rules
|
||||
$check = $rules['except'];
|
||||
if ($this->checkExcept($uri, $check)) {
|
||||
$keep = false;
|
||||
}
|
||||
}
|
||||
} else {
|
||||
$alias = $rules; // simple name of filter to apply
|
||||
}
|
||||
|
||||
if ($keep) {
|
||||
$filters[$set][] = $alias;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (isset($filters['before'])) {
|
||||
$oldFilterOrder = config(Feature::class)->oldFilterOrder ?? false;
|
||||
if ($oldFilterOrder) {
|
||||
$this->filters['before'] = array_merge($this->filters['before'], $filters['before']);
|
||||
} else {
|
||||
$this->filters['before'] = array_merge($filters['before'], $this->filters['before']);
|
||||
}
|
||||
}
|
||||
|
||||
if (isset($filters['after'])) {
|
||||
$this->filters['after'] = array_merge($this->filters['after'], $filters['after']);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Add any method-specific filters to the mix.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
protected function processMethods()
|
||||
{
|
||||
if (! isset($this->config->methods) || ! is_array($this->config->methods)) {
|
||||
return;
|
||||
}
|
||||
|
||||
$method = $this->request->getMethod();
|
||||
|
||||
$found = false;
|
||||
|
||||
if (array_key_exists($method, $this->config->methods)) {
|
||||
$found = true;
|
||||
}
|
||||
// Checks lowercase HTTP method for backward compatibility.
|
||||
// @deprecated 4.5.0
|
||||
// @TODO remove this in the future.
|
||||
elseif (array_key_exists(strtolower($method), $this->config->methods)) {
|
||||
@trigger_error(
|
||||
'Setting lowercase HTTP method key "' . strtolower($method) . '" is deprecated.'
|
||||
. ' Use uppercase HTTP method like "' . strtoupper($method) . '".',
|
||||
E_USER_DEPRECATED
|
||||
);
|
||||
|
||||
$found = true;
|
||||
$method = strtolower($method);
|
||||
}
|
||||
|
||||
if ($found) {
|
||||
$oldFilterOrder = config(Feature::class)->oldFilterOrder ?? false;
|
||||
if ($oldFilterOrder) {
|
||||
$this->filters['before'] = array_merge($this->filters['before'], $this->config->methods[$method]);
|
||||
} else {
|
||||
$this->filters['before'] = array_merge($this->config->methods[$method], $this->filters['before']);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Add any applicable configured filters to the mix.
|
||||
*
|
||||
* @param string|null $uri URI path relative to baseURL (all lowercase)
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
protected function processFilters(?string $uri = null)
|
||||
{
|
||||
if (! isset($this->config->filters) || ! $this->config->filters) {
|
||||
return;
|
||||
}
|
||||
|
||||
$uri = strtolower(trim($uri, '/ '));
|
||||
|
||||
// Add any filters that apply to this URI
|
||||
$filters = [];
|
||||
|
||||
foreach ($this->config->filters as $alias => $settings) {
|
||||
// Look for inclusion rules
|
||||
if (isset($settings['before'])) {
|
||||
$path = $settings['before'];
|
||||
|
||||
if ($this->pathApplies($uri, $path)) {
|
||||
// Get arguments and clean name
|
||||
[$name, $arguments] = $this->getCleanName($alias);
|
||||
|
||||
$filters['before'][] = $name;
|
||||
|
||||
$this->registerArguments($name, $arguments);
|
||||
}
|
||||
}
|
||||
|
||||
if (isset($settings['after'])) {
|
||||
$path = $settings['after'];
|
||||
|
||||
if ($this->pathApplies($uri, $path)) {
|
||||
// Get arguments and clean name
|
||||
[$name, $arguments] = $this->getCleanName($alias);
|
||||
|
||||
$filters['after'][] = $name;
|
||||
|
||||
// The arguments may have already been registered in the before filter.
|
||||
// So disable check.
|
||||
$this->registerArguments($name, $arguments, false);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
$oldFilterOrder = config(Feature::class)->oldFilterOrder ?? false;
|
||||
|
||||
if (isset($filters['before'])) {
|
||||
if ($oldFilterOrder) {
|
||||
$this->filters['before'] = array_merge($this->filters['before'], $filters['before']);
|
||||
} else {
|
||||
$this->filters['before'] = array_merge($filters['before'], $this->filters['before']);
|
||||
}
|
||||
}
|
||||
|
||||
if (isset($filters['after'])) {
|
||||
if (! $oldFilterOrder) {
|
||||
$filters['after'] = array_reverse($filters['after']);
|
||||
}
|
||||
|
||||
$this->filters['after'] = array_merge($this->filters['after'], $filters['after']);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $name filter alias
|
||||
* @param array $arguments filter arguments
|
||||
* @param bool $check if true, check if already defined
|
||||
*/
|
||||
private function registerArguments(string $name, array $arguments, bool $check = true): void
|
||||
{
|
||||
if ($arguments !== []) {
|
||||
if ($check && array_key_exists($name, $this->arguments)) {
|
||||
throw new ConfigException(
|
||||
'"' . $name . '" already has arguments: '
|
||||
. (($this->arguments[$name] === null) ? 'null' : implode(',', $this->arguments[$name]))
|
||||
);
|
||||
}
|
||||
|
||||
$this->arguments[$name] = $arguments;
|
||||
}
|
||||
|
||||
$classNames = (array) $this->config->aliases[$name];
|
||||
|
||||
foreach ($classNames as $className) {
|
||||
$this->argumentsClass[$className] = $this->arguments[$name] ?? null;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Maps filter aliases to the equivalent filter classes
|
||||
*
|
||||
* @return void
|
||||
*
|
||||
* @throws FilterException
|
||||
*/
|
||||
protected function processAliasesToClass(string $position)
|
||||
{
|
||||
$filterClasses = [];
|
||||
|
||||
foreach ($this->filters[$position] as $alias => $rules) {
|
||||
if (is_numeric($alias) && is_string($rules)) {
|
||||
$alias = $rules;
|
||||
}
|
||||
|
||||
if (! array_key_exists($alias, $this->config->aliases)) {
|
||||
throw FilterException::forNoAlias($alias);
|
||||
}
|
||||
|
||||
if (is_array($this->config->aliases[$alias])) {
|
||||
$filterClasses = [...$filterClasses, ...$this->config->aliases[$alias]];
|
||||
} else {
|
||||
$filterClasses[] = $this->config->aliases[$alias];
|
||||
}
|
||||
}
|
||||
|
||||
// when using enableFilter() we already write the class name in $filterClasses as well as the
|
||||
// alias in $filters. This leads to duplicates when using route filters.
|
||||
if ($position === 'before') {
|
||||
$this->filtersClass[$position] = array_merge($filterClasses, $this->filtersClass[$position]);
|
||||
} else {
|
||||
$this->filtersClass[$position] = array_merge($this->filtersClass[$position], $filterClasses);
|
||||
}
|
||||
|
||||
// Since some filters like rate limiters rely on being executed once a request we filter em here.
|
||||
$this->filtersClass[$position] = array_values(array_unique($this->filtersClass[$position]));
|
||||
}
|
||||
|
||||
/**
|
||||
* Check paths for match for URI
|
||||
*
|
||||
* @param string $uri URI to test against
|
||||
* @param array|string $paths The path patterns to test
|
||||
*
|
||||
* @return bool True if any of the paths apply to the URI
|
||||
*/
|
||||
private function pathApplies(string $uri, $paths)
|
||||
{
|
||||
// empty path matches all
|
||||
if ($paths === '' || $paths === []) {
|
||||
return true;
|
||||
}
|
||||
|
||||
// make sure the paths are iterable
|
||||
if (is_string($paths)) {
|
||||
$paths = [$paths];
|
||||
}
|
||||
|
||||
return $this->checkPseudoRegex($uri, $paths);
|
||||
}
|
||||
|
||||
/**
|
||||
* Check except paths
|
||||
*
|
||||
* @param string $uri URI path relative to baseURL (all lowercase)
|
||||
* @param array|string $paths The except path patterns
|
||||
*
|
||||
* @return bool True if the URI matches except paths.
|
||||
*/
|
||||
private function checkExcept(string $uri, $paths): bool
|
||||
{
|
||||
// empty array does not match anything
|
||||
if ($paths === []) {
|
||||
return false;
|
||||
}
|
||||
|
||||
// make sure the paths are iterable
|
||||
if (is_string($paths)) {
|
||||
$paths = [$paths];
|
||||
}
|
||||
|
||||
return $this->checkPseudoRegex($uri, $paths);
|
||||
}
|
||||
|
||||
/**
|
||||
* Check the URI path as pseudo-regex
|
||||
*
|
||||
* @param string $uri URI path relative to baseURL (all lowercase, URL-decoded)
|
||||
* @param array $paths The except path patterns
|
||||
*/
|
||||
private function checkPseudoRegex(string $uri, array $paths): bool
|
||||
{
|
||||
// treat each path as pseudo-regex
|
||||
foreach ($paths as $path) {
|
||||
// need to escape path separators
|
||||
$path = str_replace('/', '\/', trim($path, '/ '));
|
||||
// need to make pseudo wildcard real
|
||||
$path = strtolower(str_replace('*', '.*', $path));
|
||||
|
||||
// Does this rule apply here?
|
||||
if (preg_match('#\A' . $path . '\z#u', $uri, $match) === 1) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user