Find this useful? Enter your email to receive occasional updates for securing PHP code.

Signing you up...

Thank you for signing up!

PHP Decode

<?php declare(strict_types=1); /** * This file is part of CodeIgniter 4 framework. * ..

Decoded Output download

<?php

declare(strict_types=1);

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <[email protected]>
 *
 * 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\Services;
use CodeIgniter\Exceptions\ConfigException;
use CodeIgniter\Filters\Exceptions\FilterException;
use CodeIgniter\Filtersixtures\GoogleCurious;
use CodeIgniter\Filtersixtures\GoogleEmpty;
use CodeIgniter\Filtersixtures\GoogleMe;
use CodeIgniter\Filtersixtures\GoogleYou;
use CodeIgniter\Filtersixtures\InvalidClass;
use CodeIgniter\Filtersixtures\Multiple1;
use CodeIgniter\Filtersixtures\Multiple2;
use CodeIgniter\Filtersixtures\Role;
use CodeIgniter\HTTP\CLIRequest;
use CodeIgniter\HTTP\Response;
use CodeIgniter\HTTP\ResponseInterface;
use CodeIgniter\Test\CIUnitTestCase;
use CodeIgniter\Test\ConfigFromArrayTrait;
use CodeIgniter\Test\Mock\MockAppConfig;
use Config\Filters as FiltersConfig;
use PHPUnit\Framework\Attributes\BackupGlobals;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Group;

require_once __DIR__ . '/fixtures/GoogleMe.php';
require_once __DIR__ . '/fixtures/GoogleYou.php';
require_once __DIR__ . '/fixtures/GoogleEmpty.php';
require_once __DIR__ . '/fixtures/GoogleCurious.php';
require_once __DIR__ . '/fixtures/InvalidClass.php';
require_once __DIR__ . '/fixtures/Multiple1.php';
require_once __DIR__ . '/fixtures/Multiple2.php';
require_once __DIR__ . '/fixtures/Role.php';

/**
 * @internal
 */
#[BackupGlobals(true)]
#[Group('Others')]
final class FiltersTest extends CIUnitTestCase
{
    use ConfigFromArrayTrait;

    private Response $response;

    protected function setUp(): void
    {
        parent::setUp();

        $this->resetServices();

        $defaults = [
            'Config'        => APPPATH . 'Config',
            'App'           => APPPATH,
            'Tests\Support' => TESTPATH . '_support',
        ];
        Services::autoloader()->addNamespace($defaults);

        $_SERVER = [];

        $this->response = Services::response();
    }

    private function createFilters(FiltersConfig $config, $request = null): Filters
    {
        $request ??= Services::request();

        return new Filters($config, $request, $this->response);
    }

    public function testProcessMethodDetectsCLI(): void
    {
        $_SERVER['argv'] = [
            'spark',
            'list',
        ];
        $_SERVER['argc'] = 2;

        $config = [
            'aliases' => ['foo' => ''],
            'globals' => [],
            'methods' => [
                'CLI' => ['foo'],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters(
            $filtersConfig,
            new CLIRequest(new MockAppConfig())
        );

        $expected = [
            'before' => ['foo'],
            'after'  => [],
        ];
        $this->assertSame($expected, $filters->initialize()->getFilters());
    }

    public function testProcessMethodDetectsGetRequests(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => ['foo' => ''],
            'globals' => [],
            'methods' => [
                'GET' => ['foo'],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $expected = [
            'before' => ['foo'],
            'after'  => [],
        ];
        $this->assertSame($expected, $filters->initialize()->getFilters());
    }

    public function testProcessMethodRespectsMethod(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => [
                'foo' => '',
                'bar' => '',
            ],
            'globals' => [],
            'methods' => [
                'POST' => ['foo'],
                'GET'  => ['bar'],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $expected = [
            'before' => ['bar'],
            'after'  => [],
        ];
        $this->assertSame($expected, $filters->initialize()->getFilters());
    }

    public function testProcessMethodIgnoresMethod(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'DELETE';

        $config = [
            'aliases' => [
                'foo' => '',
                'bar' => '',
            ],
            'globals' => [],
            'methods' => [
                'POST' => ['foo'],
                'GET'  => ['bar'],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $expected = [
            'before' => [],
            'after'  => [],
        ];
        $this->assertSame($expected, $filters->initialize()->getFilters());
    }

    public function testProcessMethodProcessGlobals(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => [
                'foo' => '',
                'bar' => '',
                'baz' => '',
            ],
            'globals' => [
                'before' => [
                    'foo' => ['bar'], // not excluded
                    'bar',
                ],
                'after' => [
                    'baz',
                ],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $expected = [
            'before' => [
                'foo',
                'bar',
            ],
            'after' => ['baz'],
        ];
        $this->assertSame($expected, $filters->initialize()->getFilters());
    }

    public static function provideProcessMethodProcessGlobalsWithExcept(): iterable
    {
        return [
            [
                ['admin/*'],
            ],
            [
                ['admin/*', 'foo/*'],
            ],
            [
                ['*'],
            ],
            [
                'admin/*',
            ],
        ];
    }

    /**
     * @param array|string $except
     */
    #[DataProvider('provideProcessMethodProcessGlobalsWithExcept')]
    public function testProcessMethodProcessGlobalsWithExcept($except): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => [
                'foo' => '',
                'bar' => '',
                'baz' => '',
            ],
            'globals' => [
                'before' => [
                    'foo' => ['except' => $except],
                    'bar',
                ],
                'after' => [
                    'baz',
                ],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $uri      = 'admin/foo/bar';
        $expected = [
            'before' => [
                'bar',
            ],
            'after' => ['baz'],
        ];
        $this->assertSame($expected, $filters->initialize($uri)->getFilters());
    }

    public function testProcessMethodProcessesFiltersBefore(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => [
                'foo' => '',
                'bar' => '',
                'baz' => '',
            ],
            'globals' => [],
            'filters' => [
                'foo' => [
                    'before' => ['admin/*'],
                    'after'  => ['/users/*'],
                ],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $uri      = 'admin/foo/bar';
        $expected = [
            'before' => ['foo'],
            'after'  => [],
        ];
        $this->assertSame($expected, $filters->initialize($uri)->getFilters());
    }

    public function testProcessMethodProcessesFiltersAfter(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => [
                'foo' => '',
                'bar' => '',
                'baz' => '',
            ],
            'globals' => [],
            'filters' => [
                'foo' => [
                    'before' => ['admin/*'],
                    'after'  => ['/users/*'],
                ],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $uri      = 'users/foo/bar';
        $expected = [
            'before' => [],
            'after'  => [
                'foo',
            ],
        ];
        $this->assertSame($expected, $filters->initialize($uri)->getFilters());
    }

    public function testProcessMethodProcessesCombined(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => [
                'foog' => '',
                'barg' => '',
                'bazg' => '',
                'foo'  => '',
                'bar'  => '',
                'foof' => '',
            ],
            'globals' => [
                'before' => [
                    'foog' => ['except' => ['admin/*']],
                    'barg',
                ],
                'after' => [
                    'bazg',
                ],
            ],
            'methods' => [
                'POST' => ['foo'],
                'GET'  => ['bar'],
            ],
            'filters' => [
                'foof' => [
                    'before' => ['admin/*'],
                    'after'  => ['/users/*'],
                ],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $uri      = 'admin/foo/bar';
        $expected = [
            'before' => [
                'barg',
                'bar',
                'foof',
            ],
            'after' => ['bazg'],
        ];
        $this->assertSame($expected, $filters->initialize($uri)->getFilters());
    }

    public function testProcessMethodProcessesCombinedAfterForToolbar(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => [
                'toolbar' => '',
                'bazg'    => '',
                'bar'     => '',
                'foof'    => '',
            ],
            'globals' => [
                'after' => [
                    'toolbar',
                    'bazg',
                ],
            ],
            'methods' => [
                'GET' => ['bar'],
            ],
            'filters' => [
                'foof' => [
                    'after' => ['admin/*'],
                ],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $uri      = 'admin/foo/bar';
        $expected = [
            'before' => ['bar'],
            'after'  => [
                'foof',
                'bazg',
                'toolbar',
            ],
        ];
        $this->assertSame($expected, $filters->initialize($uri)->getFilters());
    }

    public function testRunThrowsWithInvalidAlias(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => [],
            'globals' => [
                'before' => ['invalid'],
                'after'  => [],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $this->expectException(FilterException::class);

        $uri = 'admin/foo/bar';
        $filters->run($uri);
    }

    public function testCustomFiltersLoad(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => [],
            'globals' => [
                'before' => ['test-customfilter'],
                'after'  => [],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $uri     = 'admin/foo/bar';
        $request = $filters->run($uri, 'before');

        $this->assertSame('http://hellowworld.com', $request->getBody());

        $this->resetServices();
    }

    /**
     * @see https://github.com/codeigniter4/CodeIgniter4/issues/4720
     */
    public function testAllCustomFiltersAreDiscoveredInConstructor(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => [],
            'globals' => [],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $configFilters = $this->getPrivateProperty($filters, 'config');
        $this->assertContains('test-customfilter', array_keys($configFilters->aliases));
    }

    public function testRunThrowsWithInvalidClassType(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => ['invalid' => InvalidClass::class],
            'globals' => [
                'before' => ['invalid'],
                'after'  => [],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $this->expectException(FilterException::class);

        $uri = 'admin/foo/bar';
        $filters->run($uri);
    }

    public function testRunDoesBefore(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => ['google' => GoogleMe::class],
            'globals' => [
                'before' => ['google'],
                'after'  => [],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $uri     = 'admin/foo/bar';
        $request = $filters->run($uri, 'before');

        $this->assertSame('http://google.com', $request->getBody());
    }

    public function testRunDoesAfter(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => ['google' => GoogleMe::class],
            'globals' => [
                'before' => [],
                'after'  => ['google'],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $uri      = 'admin/foo/bar';
        $response = $filters->run($uri, 'after');

        $this->assertSame('http://google.com', $response->getBody());
    }

    public function testShortCircuit(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => ['banana' => GoogleYou::class],
            'globals' => [
                'before' => ['banana'],
                'after'  => [],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $uri      = 'admin/foo/bar';
        $response = $filters->run($uri, 'before');

        $this->assertInstanceOf(ResponseInterface::class, $response);
        $this->assertSame('http://google.com', $response->getBody());
    }

    public function testOtherResult(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => [
                'nowhere' => GoogleEmpty::class,
                'banana'  => GoogleCurious::class,
            ],
            'globals' => [
                'before' => [
                    'nowhere',
                    'banana',
                ],
                'after' => [],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $uri      = 'admin/foo/bar';
        $response = $filters->run($uri, 'before');

        $this->assertSame('This is curious', $response);
    }

    /**
     * @param array|string $except
     */
    #[DataProvider('provideBeforeExcept')]
    public function testBeforeExcept(string $uri, $except, array $expected): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => [
                'foo' => '',
                'bar' => '',
                'baz' => '',
            ],
            'globals' => [
                'before' => [
                    'foo' => ['except' => $except],
                    'bar',
                ],
                'after' => [
                    'baz',
                ],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $this->assertSame($expected, $filters->initialize($uri)->getFilters());
    }

    public static function provideBeforeExcept(): iterable
    {
        return [
            'string exclude' => [
                'admin/foo/bar',
                'admin/*',
                [
                    'before' => [
                        'bar',
                    ],
                    'after' => ['baz'],
                ],
            ],
            'string not exclude' => [
                'admin/foo/bar',
                'george/*',
                [
                    'before' => [
                        'foo',
                        'bar',
                    ],
                    'after' => ['baz'],
                ],
            ],
            'empty array not exclude' => [
                'admin/foo/bar',
                [],
                [
                    'before' => [
                        'foo',
                        'bar',
                    ],
                    'after' => ['baz'],
                ],
            ],
            'empty string not exclude' => [
                'admin/foo/bar',
                // The URI path '' means the baseURL.
                '',
                [
                    'before' => [
                        'foo',
                        'bar',
                    ],
                    'after' => ['baz'],
                ],
            ],
            'empty string exclude' => [
                // The URI path '' means the baseURL.
                '',
                // So this setting excludes `foo` filter only to the baseURL.
                '',
                [
                    'before' => [
                        'bar',
                    ],
                    'after' => ['baz'],
                ],
            ],
            'slash not exclude' => [
                'admin/foo/bar',
                '/',
                [
                    'before' => [
                        'foo',
                        'bar',
                    ],
                    'after' => ['baz'],
                ],
            ],
            'slash exclude' => [
                // The URI path '' means the baseURL.
                '',
                '/',
                [
                    'before' => [
                        'bar',
                    ],
                    'after' => ['baz'],
                ],
            ],
        ];
    }

    public function testAfterExceptString(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => [
                'foo' => '',
                'bar' => '',
                'baz' => '',
            ],
            'globals' => [
                'before' => [
                    'bar',
                ],
                'after' => [
                    'foo' => ['except' => 'admin/*'],
                    'baz',
                ],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $uri      = 'admin/foo/bar';
        $expected = [
            'before' => [
                'bar',
            ],
            'after' => ['baz'],
        ];
        $this->assertSame($expected, $filters->initialize($uri)->getFilters());
    }

    public function testAfterExceptInapplicable(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => [
                'foo' => '',
                'bar' => '',
                'baz' => '',
            ],
            'globals' => [
                'before' => [
                    'bar',
                ],
                'after' => [
                    'foo' => ['except' => 'george/*'],
                    'baz',
                ],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $uri      = 'admin/foo/bar';
        $expected = [
            'before' => [
                'bar',
            ],
            'after' => [
                'foo',
                'baz',
            ],
        ];
        $this->assertSame($expected, $filters->initialize($uri)->getFilters());
    }

    public function testAddFilter(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => ['google' => GoogleMe::class],
            'globals' => [
                'before' => ['google'],
                'after'  => [],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $filters = $filters->addFilter('Some\Class', 'some_alias');
        $filters = $filters->initialize('admin/foo/bar');
        $filters = $filters->getFilters();

        $this->assertContains('some_alias', $filters['before']);
    }

    public function testAddFilterSection(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config        = [];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $list = $filters
            ->addFilter('Some\OtherClass', 'another', 'before', 'globals')
            ->initialize('admin/foo/bar')
            ->getFilters();

        $this->assertContains('another', $list['before']);
    }

    public function testInitializeTwice(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config        = [];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $list = $filters
            ->addFilter('Some\OtherClass', 'another', 'before', 'globals')
            ->initialize('admin/foo/bar')
            ->initialize()
            ->getFilters();

        $this->assertContains('another', $list['before']);
    }

    public function testEnableFilter(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => ['google' => GoogleMe::class],
            'globals' => [
                'before' => [],
                'after'  => [],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $filters = $filters->initialize('admin/foo/bar');
        $filters->enableFilters(['google'], 'before');
        $filters = $filters->getFilters();

        $this->assertContains('google', $filters['before']);
    }

    public function testFiltersWithArguments(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => ['role' => Role::class],
            'globals' => [
            ],
            'filters' => [
                'role:admin,super' => [
                    'before' => ['admin/*'],
                    'after'  => ['admin/*'],
                ],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $filters = $filters->initialize('admin/foo/bar');
        $found   = $filters->getFilters();

        $this->assertContains('role', $found['before']);
        $this->assertSame(['admin', 'super'], $filters->getArguments('role'));
        $this->assertSame(['role' => ['admin', 'super']], $filters->getArguments());

        $response = $filters->run('admin/foo/bar', 'before');

        $this->assertSame('admin;super', $response);

        $response = $filters->run('admin/foo/bar', 'after');

        $this->assertSame('admin;super', $response->getBody());
    }

    public function testFilterWithArgumentsIsDefined(): void
    {
        $this->expectException(ConfigException::class);
        $this->expectExceptionMessage('"role" already has arguments: admin,super');

        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => ['role' => Role::class],
            'globals' => [],
            'filters' => [
                'role:admin,super' => [
                    'before' => ['admin/*'],
                ],
                'role:super' => [
                    'before' => ['admin/user/*'],
                ],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $filters->initialize('admin/user/bar');
    }

    public function testFilterWithoutArgumentsIsDefined(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => ['role' => Role::class],
            'globals' => [],
            'filters' => [
                'role' => [
                    'before' => ['admin/*'],
                ],
                'role:super' => [
                    'before' => ['admin/user/*'],
                ],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $filters = $filters->initialize('admin/user/bar');
        $found   = $filters->getFilters();

        $this->assertContains('role', $found['before']);
        $this->assertSame(['super'], $filters->getArguments('role'));
        $this->assertSame(['role' => ['super']], $filters->getArguments());
    }

    public function testEnableFilterWithArguments(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => ['role' => Role::class],
            'globals' => [
                'before' => [],
                'after'  => [],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $filters = $filters->initialize('admin/foo/bar');
        $filters->enableFilters(['role:admin , super'], 'before');
        $filters->enableFilters(['role:admin , super'], 'after');
        $found = $filters->getFilters();

        $this->assertContains('role', $found['before']);
        $this->assertSame(['admin', 'super'], $filters->getArguments('role'));
        $this->assertSame(['role' => ['admin', 'super']], $filters->getArguments());

        $response = $filters->run('admin/foo/bar', 'before');

        $this->assertSame('admin;super', $response);

        $response = $filters->run('admin/foo/bar', 'after');

        $this->assertSame('admin;super', $response->getBody());
    }

    public function testEnableFilterWithNoArguments(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => ['role' => Role::class],
            'globals' => [
                'before' => [],
                'after'  => [],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $filters = $filters->initialize('admin/foo/bar');
        $filters->enableFilters(['role'], 'before');
        $filters->enableFilters(['role'], 'after');
        $found = $filters->getFilters();

        $this->assertContains('role', $found['before']);

        $response = $filters->run('admin/foo/bar', 'before');

        $this->assertSame('Is null', $response);

        $response = $filters->run('admin/foo/bar', 'after');

        $this->assertSame('Is null', $response->getBody());
    }

    public function testEnableNonFilter(): void
    {
        $this->expectException(FilterException::class);

        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => ['google' => GoogleMe::class],
            'globals' => [
                'before' => [],
                'after'  => [],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $filters = $filters->initialize('admin/foo/bar');
        $filters->enableFilters(['goggle'], 'before');
    }

    /**
     * @see https://github.com/codeigniter4/CodeIgniter4/issues/1664
     */
    public function testMatchesURICaseInsensitively(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => [
                'foo'  => '',
                'bar'  => '',
                'frak' => '',
                'baz'  => '',
            ],
            'globals' => [
                'before' => [
                    'foo' => ['except' => 'Admin/*'],
                    'bar',
                ],
                'after' => [
                    'foo' => ['except' => 'Admin/*'],
                    'baz',
                ],
            ],
            'filters' => [
                'frak' => [
                    'before' => ['Admin/*'],
                    'after'  => ['Admin/*'],
                ],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $uri      = 'admin/foo/bar';
        $expected = [
            'before' => [
                'bar',
                'frak',
            ],
            'after' => [
                'frak',
                'baz',
            ],
        ];
        $this->assertSame($expected, $filters->initialize($uri)->getFilters());
    }

    public function testMatchesURIWithUnicode(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => [
                'foo'  => '',
                'bar'  => '',
                'frak' => '',
                'baz'  => '',
            ],
            'globals' => [
                'before' => [
                    'foo' => ['except' => '/*'],
                    'bar',
                ],
                'after' => [
                    'foo' => ['except' => '/*'],
                    'baz',
                ],
            ],
            'filters' => [
                'frak' => [
                    'before' => ['/*'],
                    'after'  => ['/*'],
                ],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        // URIs passed to Filters are URL-encoded.
        $uri      = '%E6%97%A5%E6%9C%AC%E8%AA%9E/foo/bar';
        $expected = [
            'before' => [
                'bar',
                'frak',
            ],
            'after' => [
                'frak',
                'baz',
            ],
        ];
        $this->assertSame($expected, $filters->initialize($uri)->getFilters());
    }

    /**
     * @see https://github.com/codeigniter4/CodeIgniter4/issues/1907
     */
    public function testFilterMatching(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => [
                'foo'  => '',
                'bar'  => '',
                'frak' => '',
            ],
            'globals' => [],
            'filters' => [
                'frak' => [
                    'before' => ['admin*'],
                    'after'  => ['admin/*'],
                ],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $uri    = 'admin';
        $actual = $filters->initialize($uri)->getFilters();

        $expected = [
            'before' => [
                'frak',
            ],
            'after' => [],
        ];
        $this->assertSame($expected, $actual);
    }

    /**
     * @see https://github.com/codeigniter4/CodeIgniter4/issues/1907
     */
    public function testGlobalFilterMatching(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => [
                'foo' => '',
                'one' => '',
                'two' => '',
            ],
            'globals' => [
                'before' => [
                    'foo' => ['except' => 'admin*'],
                    'one',
                ],
                'after' => [
                    'foo' => ['except' => 'admin/*'],
                    'two',
                ],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $uri    = 'admin';
        $actual = $filters->initialize($uri)->getFilters();

        $expected = [
            'before' => [
                'one',
            ],
            'after' => [
                'foo',
                'two',
            ],
        ];
        $this->assertSame($expected, $actual);
    }

    /**
     * @see https://github.com/codeigniter4/CodeIgniter4/issues/1907
     */
    public function testCombinedFilterMatching(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => [
                'foo'  => '',
                'one'  => '',
                'frak' => '',
                'two'  => '',
            ],
            'globals' => [
                'before' => [
                    'foo' => ['except' => 'admin*'],
                    'one',
                ],
                'after' => [
                    'foo' => ['except' => 'admin/*'],
                    'two',
                ],
            ],
            'filters' => [
                'frak' => [
                    'before' => ['admin*'],
                    'after'  => ['admin/*'],
                ],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $uri      = 'admin123';
        $expected = [
            'before' => [
                'one',
                'frak',
            ],
            'after' => [
                'foo',
                'two',
            ],
        ];
        $this->assertSame($expected, $filters->initialize($uri)->getFilters());
    }

    /**
     * @see https://github.com/codeigniter4/CodeIgniter4/issues/1907
     */
    public function testSegmentedFilterMatching(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => [
                'foo'  => '',
                'one'  => '',
                'frak' => '',
            ],
            'globals' => [
                'before' => [
                    'foo' => ['except' => 'admin*'],
                ],
                'after' => [
                    'foo' => ['except' => 'admin/*'],
                ],
            ],
            'filters' => [
                'frak' => [
                    'before' => ['admin*'],
                    'after'  => ['admin/*'],
                ],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $uri      = 'admin/123';
        $expected = [
            'before' => [
                'frak',
            ],
            'after' => [
                'frak',
            ],
        ];
        $this->assertSame($expected, $filters->initialize($uri)->getFilters());
    }

    /**
     * @see https://github.com/codeigniter4/CodeIgniter4/issues/2831
     */
    public function testFilterAliasMultiple(): void
    {
        $config = [
            'aliases' => [
                'multipleTest' => [
                    Multiple1::class,
                    Multiple2::class,
                ],
            ],
            'globals' => [
                'before' => [
                    'multipleTest',
                ],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $uri     = 'admin/foo/bar';
        $request = $filters->run($uri, 'before');

        $this->assertSame('http://exampleMultipleURL.com', $request->header('x-url')->getValue());
        $this->assertSame('http://exampleMultipleCSP.com', $request->header('x-csp')->getValue());
    }

    public function testFilterClass(): void
    {
        $config = [
            'aliases' => [
                'multipleTest' => [
                    Multiple1::class,
                    Multiple2::class,
                ],
            ],
            'globals' => [
                'after' => [
                    'multipleTest',
                ],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $filters->run('admin/foo/bar', 'before');

        $expected = [
            'before' => [],
            'after'  => [
                Multiple1::class,
                Multiple2::class,
            ],
        ];
        $this->assertSame($expected, $filters->getFiltersClass());
    }

    public function testReset(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => [
                'foo' => '',
            ],
            'globals' => [],
            'filters' => [
                'foo' => [
                    'before' => ['admin*'],
                ],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $uri = 'admin';
        $this->assertSame(['foo'], $filters->initialize($uri)->getFilters()['before']);
        $this->assertSame([], $filters->reset()->getFilters()['before']);
    }
}
 ?>

Did this file decode correctly?

Original Code

<?php

declare(strict_types=1);

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <[email protected]>
 *
 * 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\Services;
use CodeIgniter\Exceptions\ConfigException;
use CodeIgniter\Filters\Exceptions\FilterException;
use CodeIgniter\Filters\fixtures\GoogleCurious;
use CodeIgniter\Filters\fixtures\GoogleEmpty;
use CodeIgniter\Filters\fixtures\GoogleMe;
use CodeIgniter\Filters\fixtures\GoogleYou;
use CodeIgniter\Filters\fixtures\InvalidClass;
use CodeIgniter\Filters\fixtures\Multiple1;
use CodeIgniter\Filters\fixtures\Multiple2;
use CodeIgniter\Filters\fixtures\Role;
use CodeIgniter\HTTP\CLIRequest;
use CodeIgniter\HTTP\Response;
use CodeIgniter\HTTP\ResponseInterface;
use CodeIgniter\Test\CIUnitTestCase;
use CodeIgniter\Test\ConfigFromArrayTrait;
use CodeIgniter\Test\Mock\MockAppConfig;
use Config\Filters as FiltersConfig;
use PHPUnit\Framework\Attributes\BackupGlobals;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Group;

require_once __DIR__ . '/fixtures/GoogleMe.php';
require_once __DIR__ . '/fixtures/GoogleYou.php';
require_once __DIR__ . '/fixtures/GoogleEmpty.php';
require_once __DIR__ . '/fixtures/GoogleCurious.php';
require_once __DIR__ . '/fixtures/InvalidClass.php';
require_once __DIR__ . '/fixtures/Multiple1.php';
require_once __DIR__ . '/fixtures/Multiple2.php';
require_once __DIR__ . '/fixtures/Role.php';

/**
 * @internal
 */
#[BackupGlobals(true)]
#[Group('Others')]
final class FiltersTest extends CIUnitTestCase
{
    use ConfigFromArrayTrait;

    private Response $response;

    protected function setUp(): void
    {
        parent::setUp();

        $this->resetServices();

        $defaults = [
            'Config'        => APPPATH . 'Config',
            'App'           => APPPATH,
            'Tests\Support' => TESTPATH . '_support',
        ];
        Services::autoloader()->addNamespace($defaults);

        $_SERVER = [];

        $this->response = Services::response();
    }

    private function createFilters(FiltersConfig $config, $request = null): Filters
    {
        $request ??= Services::request();

        return new Filters($config, $request, $this->response);
    }

    public function testProcessMethodDetectsCLI(): void
    {
        $_SERVER['argv'] = [
            'spark',
            'list',
        ];
        $_SERVER['argc'] = 2;

        $config = [
            'aliases' => ['foo' => ''],
            'globals' => [],
            'methods' => [
                'CLI' => ['foo'],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters(
            $filtersConfig,
            new CLIRequest(new MockAppConfig())
        );

        $expected = [
            'before' => ['foo'],
            'after'  => [],
        ];
        $this->assertSame($expected, $filters->initialize()->getFilters());
    }

    public function testProcessMethodDetectsGetRequests(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => ['foo' => ''],
            'globals' => [],
            'methods' => [
                'GET' => ['foo'],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $expected = [
            'before' => ['foo'],
            'after'  => [],
        ];
        $this->assertSame($expected, $filters->initialize()->getFilters());
    }

    public function testProcessMethodRespectsMethod(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => [
                'foo' => '',
                'bar' => '',
            ],
            'globals' => [],
            'methods' => [
                'POST' => ['foo'],
                'GET'  => ['bar'],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $expected = [
            'before' => ['bar'],
            'after'  => [],
        ];
        $this->assertSame($expected, $filters->initialize()->getFilters());
    }

    public function testProcessMethodIgnoresMethod(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'DELETE';

        $config = [
            'aliases' => [
                'foo' => '',
                'bar' => '',
            ],
            'globals' => [],
            'methods' => [
                'POST' => ['foo'],
                'GET'  => ['bar'],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $expected = [
            'before' => [],
            'after'  => [],
        ];
        $this->assertSame($expected, $filters->initialize()->getFilters());
    }

    public function testProcessMethodProcessGlobals(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => [
                'foo' => '',
                'bar' => '',
                'baz' => '',
            ],
            'globals' => [
                'before' => [
                    'foo' => ['bar'], // not excluded
                    'bar',
                ],
                'after' => [
                    'baz',
                ],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $expected = [
            'before' => [
                'foo',
                'bar',
            ],
            'after' => ['baz'],
        ];
        $this->assertSame($expected, $filters->initialize()->getFilters());
    }

    public static function provideProcessMethodProcessGlobalsWithExcept(): iterable
    {
        return [
            [
                ['admin/*'],
            ],
            [
                ['admin/*', 'foo/*'],
            ],
            [
                ['*'],
            ],
            [
                'admin/*',
            ],
        ];
    }

    /**
     * @param array|string $except
     */
    #[DataProvider('provideProcessMethodProcessGlobalsWithExcept')]
    public function testProcessMethodProcessGlobalsWithExcept($except): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => [
                'foo' => '',
                'bar' => '',
                'baz' => '',
            ],
            'globals' => [
                'before' => [
                    'foo' => ['except' => $except],
                    'bar',
                ],
                'after' => [
                    'baz',
                ],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $uri      = 'admin/foo/bar';
        $expected = [
            'before' => [
                'bar',
            ],
            'after' => ['baz'],
        ];
        $this->assertSame($expected, $filters->initialize($uri)->getFilters());
    }

    public function testProcessMethodProcessesFiltersBefore(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => [
                'foo' => '',
                'bar' => '',
                'baz' => '',
            ],
            'globals' => [],
            'filters' => [
                'foo' => [
                    'before' => ['admin/*'],
                    'after'  => ['/users/*'],
                ],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $uri      = 'admin/foo/bar';
        $expected = [
            'before' => ['foo'],
            'after'  => [],
        ];
        $this->assertSame($expected, $filters->initialize($uri)->getFilters());
    }

    public function testProcessMethodProcessesFiltersAfter(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => [
                'foo' => '',
                'bar' => '',
                'baz' => '',
            ],
            'globals' => [],
            'filters' => [
                'foo' => [
                    'before' => ['admin/*'],
                    'after'  => ['/users/*'],
                ],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $uri      = 'users/foo/bar';
        $expected = [
            'before' => [],
            'after'  => [
                'foo',
            ],
        ];
        $this->assertSame($expected, $filters->initialize($uri)->getFilters());
    }

    public function testProcessMethodProcessesCombined(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => [
                'foog' => '',
                'barg' => '',
                'bazg' => '',
                'foo'  => '',
                'bar'  => '',
                'foof' => '',
            ],
            'globals' => [
                'before' => [
                    'foog' => ['except' => ['admin/*']],
                    'barg',
                ],
                'after' => [
                    'bazg',
                ],
            ],
            'methods' => [
                'POST' => ['foo'],
                'GET'  => ['bar'],
            ],
            'filters' => [
                'foof' => [
                    'before' => ['admin/*'],
                    'after'  => ['/users/*'],
                ],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $uri      = 'admin/foo/bar';
        $expected = [
            'before' => [
                'barg',
                'bar',
                'foof',
            ],
            'after' => ['bazg'],
        ];
        $this->assertSame($expected, $filters->initialize($uri)->getFilters());
    }

    public function testProcessMethodProcessesCombinedAfterForToolbar(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => [
                'toolbar' => '',
                'bazg'    => '',
                'bar'     => '',
                'foof'    => '',
            ],
            'globals' => [
                'after' => [
                    'toolbar',
                    'bazg',
                ],
            ],
            'methods' => [
                'GET' => ['bar'],
            ],
            'filters' => [
                'foof' => [
                    'after' => ['admin/*'],
                ],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $uri      = 'admin/foo/bar';
        $expected = [
            'before' => ['bar'],
            'after'  => [
                'foof',
                'bazg',
                'toolbar',
            ],
        ];
        $this->assertSame($expected, $filters->initialize($uri)->getFilters());
    }

    public function testRunThrowsWithInvalidAlias(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => [],
            'globals' => [
                'before' => ['invalid'],
                'after'  => [],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $this->expectException(FilterException::class);

        $uri = 'admin/foo/bar';
        $filters->run($uri);
    }

    public function testCustomFiltersLoad(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => [],
            'globals' => [
                'before' => ['test-customfilter'],
                'after'  => [],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $uri     = 'admin/foo/bar';
        $request = $filters->run($uri, 'before');

        $this->assertSame('http://hellowworld.com', $request->getBody());

        $this->resetServices();
    }

    /**
     * @see https://github.com/codeigniter4/CodeIgniter4/issues/4720
     */
    public function testAllCustomFiltersAreDiscoveredInConstructor(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => [],
            'globals' => [],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $configFilters = $this->getPrivateProperty($filters, 'config');
        $this->assertContains('test-customfilter', array_keys($configFilters->aliases));
    }

    public function testRunThrowsWithInvalidClassType(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => ['invalid' => InvalidClass::class],
            'globals' => [
                'before' => ['invalid'],
                'after'  => [],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $this->expectException(FilterException::class);

        $uri = 'admin/foo/bar';
        $filters->run($uri);
    }

    public function testRunDoesBefore(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => ['google' => GoogleMe::class],
            'globals' => [
                'before' => ['google'],
                'after'  => [],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $uri     = 'admin/foo/bar';
        $request = $filters->run($uri, 'before');

        $this->assertSame('http://google.com', $request->getBody());
    }

    public function testRunDoesAfter(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => ['google' => GoogleMe::class],
            'globals' => [
                'before' => [],
                'after'  => ['google'],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $uri      = 'admin/foo/bar';
        $response = $filters->run($uri, 'after');

        $this->assertSame('http://google.com', $response->getBody());
    }

    public function testShortCircuit(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => ['banana' => GoogleYou::class],
            'globals' => [
                'before' => ['banana'],
                'after'  => [],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $uri      = 'admin/foo/bar';
        $response = $filters->run($uri, 'before');

        $this->assertInstanceOf(ResponseInterface::class, $response);
        $this->assertSame('http://google.com', $response->getBody());
    }

    public function testOtherResult(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => [
                'nowhere' => GoogleEmpty::class,
                'banana'  => GoogleCurious::class,
            ],
            'globals' => [
                'before' => [
                    'nowhere',
                    'banana',
                ],
                'after' => [],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $uri      = 'admin/foo/bar';
        $response = $filters->run($uri, 'before');

        $this->assertSame('This is curious', $response);
    }

    /**
     * @param array|string $except
     */
    #[DataProvider('provideBeforeExcept')]
    public function testBeforeExcept(string $uri, $except, array $expected): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => [
                'foo' => '',
                'bar' => '',
                'baz' => '',
            ],
            'globals' => [
                'before' => [
                    'foo' => ['except' => $except],
                    'bar',
                ],
                'after' => [
                    'baz',
                ],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $this->assertSame($expected, $filters->initialize($uri)->getFilters());
    }

    public static function provideBeforeExcept(): iterable
    {
        return [
            'string exclude' => [
                'admin/foo/bar',
                'admin/*',
                [
                    'before' => [
                        'bar',
                    ],
                    'after' => ['baz'],
                ],
            ],
            'string not exclude' => [
                'admin/foo/bar',
                'george/*',
                [
                    'before' => [
                        'foo',
                        'bar',
                    ],
                    'after' => ['baz'],
                ],
            ],
            'empty array not exclude' => [
                'admin/foo/bar',
                [],
                [
                    'before' => [
                        'foo',
                        'bar',
                    ],
                    'after' => ['baz'],
                ],
            ],
            'empty string not exclude' => [
                'admin/foo/bar',
                // The URI path '' means the baseURL.
                '',
                [
                    'before' => [
                        'foo',
                        'bar',
                    ],
                    'after' => ['baz'],
                ],
            ],
            'empty string exclude' => [
                // The URI path '' means the baseURL.
                '',
                // So this setting excludes `foo` filter only to the baseURL.
                '',
                [
                    'before' => [
                        'bar',
                    ],
                    'after' => ['baz'],
                ],
            ],
            'slash not exclude' => [
                'admin/foo/bar',
                '/',
                [
                    'before' => [
                        'foo',
                        'bar',
                    ],
                    'after' => ['baz'],
                ],
            ],
            'slash exclude' => [
                // The URI path '' means the baseURL.
                '',
                '/',
                [
                    'before' => [
                        'bar',
                    ],
                    'after' => ['baz'],
                ],
            ],
        ];
    }

    public function testAfterExceptString(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => [
                'foo' => '',
                'bar' => '',
                'baz' => '',
            ],
            'globals' => [
                'before' => [
                    'bar',
                ],
                'after' => [
                    'foo' => ['except' => 'admin/*'],
                    'baz',
                ],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $uri      = 'admin/foo/bar';
        $expected = [
            'before' => [
                'bar',
            ],
            'after' => ['baz'],
        ];
        $this->assertSame($expected, $filters->initialize($uri)->getFilters());
    }

    public function testAfterExceptInapplicable(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => [
                'foo' => '',
                'bar' => '',
                'baz' => '',
            ],
            'globals' => [
                'before' => [
                    'bar',
                ],
                'after' => [
                    'foo' => ['except' => 'george/*'],
                    'baz',
                ],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $uri      = 'admin/foo/bar';
        $expected = [
            'before' => [
                'bar',
            ],
            'after' => [
                'foo',
                'baz',
            ],
        ];
        $this->assertSame($expected, $filters->initialize($uri)->getFilters());
    }

    public function testAddFilter(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => ['google' => GoogleMe::class],
            'globals' => [
                'before' => ['google'],
                'after'  => [],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $filters = $filters->addFilter('Some\Class', 'some_alias');
        $filters = $filters->initialize('admin/foo/bar');
        $filters = $filters->getFilters();

        $this->assertContains('some_alias', $filters['before']);
    }

    public function testAddFilterSection(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config        = [];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $list = $filters
            ->addFilter('Some\OtherClass', 'another', 'before', 'globals')
            ->initialize('admin/foo/bar')
            ->getFilters();

        $this->assertContains('another', $list['before']);
    }

    public function testInitializeTwice(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config        = [];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $list = $filters
            ->addFilter('Some\OtherClass', 'another', 'before', 'globals')
            ->initialize('admin/foo/bar')
            ->initialize()
            ->getFilters();

        $this->assertContains('another', $list['before']);
    }

    public function testEnableFilter(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => ['google' => GoogleMe::class],
            'globals' => [
                'before' => [],
                'after'  => [],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $filters = $filters->initialize('admin/foo/bar');
        $filters->enableFilters(['google'], 'before');
        $filters = $filters->getFilters();

        $this->assertContains('google', $filters['before']);
    }

    public function testFiltersWithArguments(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => ['role' => Role::class],
            'globals' => [
            ],
            'filters' => [
                'role:admin,super' => [
                    'before' => ['admin/*'],
                    'after'  => ['admin/*'],
                ],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $filters = $filters->initialize('admin/foo/bar');
        $found   = $filters->getFilters();

        $this->assertContains('role', $found['before']);
        $this->assertSame(['admin', 'super'], $filters->getArguments('role'));
        $this->assertSame(['role' => ['admin', 'super']], $filters->getArguments());

        $response = $filters->run('admin/foo/bar', 'before');

        $this->assertSame('admin;super', $response);

        $response = $filters->run('admin/foo/bar', 'after');

        $this->assertSame('admin;super', $response->getBody());
    }

    public function testFilterWithArgumentsIsDefined(): void
    {
        $this->expectException(ConfigException::class);
        $this->expectExceptionMessage('"role" already has arguments: admin,super');

        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => ['role' => Role::class],
            'globals' => [],
            'filters' => [
                'role:admin,super' => [
                    'before' => ['admin/*'],
                ],
                'role:super' => [
                    'before' => ['admin/user/*'],
                ],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $filters->initialize('admin/user/bar');
    }

    public function testFilterWithoutArgumentsIsDefined(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => ['role' => Role::class],
            'globals' => [],
            'filters' => [
                'role' => [
                    'before' => ['admin/*'],
                ],
                'role:super' => [
                    'before' => ['admin/user/*'],
                ],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $filters = $filters->initialize('admin/user/bar');
        $found   = $filters->getFilters();

        $this->assertContains('role', $found['before']);
        $this->assertSame(['super'], $filters->getArguments('role'));
        $this->assertSame(['role' => ['super']], $filters->getArguments());
    }

    public function testEnableFilterWithArguments(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => ['role' => Role::class],
            'globals' => [
                'before' => [],
                'after'  => [],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $filters = $filters->initialize('admin/foo/bar');
        $filters->enableFilters(['role:admin , super'], 'before');
        $filters->enableFilters(['role:admin , super'], 'after');
        $found = $filters->getFilters();

        $this->assertContains('role', $found['before']);
        $this->assertSame(['admin', 'super'], $filters->getArguments('role'));
        $this->assertSame(['role' => ['admin', 'super']], $filters->getArguments());

        $response = $filters->run('admin/foo/bar', 'before');

        $this->assertSame('admin;super', $response);

        $response = $filters->run('admin/foo/bar', 'after');

        $this->assertSame('admin;super', $response->getBody());
    }

    public function testEnableFilterWithNoArguments(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => ['role' => Role::class],
            'globals' => [
                'before' => [],
                'after'  => [],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $filters = $filters->initialize('admin/foo/bar');
        $filters->enableFilters(['role'], 'before');
        $filters->enableFilters(['role'], 'after');
        $found = $filters->getFilters();

        $this->assertContains('role', $found['before']);

        $response = $filters->run('admin/foo/bar', 'before');

        $this->assertSame('Is null', $response);

        $response = $filters->run('admin/foo/bar', 'after');

        $this->assertSame('Is null', $response->getBody());
    }

    public function testEnableNonFilter(): void
    {
        $this->expectException(FilterException::class);

        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => ['google' => GoogleMe::class],
            'globals' => [
                'before' => [],
                'after'  => [],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $filters = $filters->initialize('admin/foo/bar');
        $filters->enableFilters(['goggle'], 'before');
    }

    /**
     * @see https://github.com/codeigniter4/CodeIgniter4/issues/1664
     */
    public function testMatchesURICaseInsensitively(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => [
                'foo'  => '',
                'bar'  => '',
                'frak' => '',
                'baz'  => '',
            ],
            'globals' => [
                'before' => [
                    'foo' => ['except' => 'Admin/*'],
                    'bar',
                ],
                'after' => [
                    'foo' => ['except' => 'Admin/*'],
                    'baz',
                ],
            ],
            'filters' => [
                'frak' => [
                    'before' => ['Admin/*'],
                    'after'  => ['Admin/*'],
                ],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $uri      = 'admin/foo/bar';
        $expected = [
            'before' => [
                'bar',
                'frak',
            ],
            'after' => [
                'frak',
                'baz',
            ],
        ];
        $this->assertSame($expected, $filters->initialize($uri)->getFilters());
    }

    public function testMatchesURIWithUnicode(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => [
                'foo'  => '',
                'bar'  => '',
                'frak' => '',
                'baz'  => '',
            ],
            'globals' => [
                'before' => [
                    'foo' => ['except' => '/*'],
                    'bar',
                ],
                'after' => [
                    'foo' => ['except' => '/*'],
                    'baz',
                ],
            ],
            'filters' => [
                'frak' => [
                    'before' => ['/*'],
                    'after'  => ['/*'],
                ],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        // URIs passed to Filters are URL-encoded.
        $uri      = '%E6%97%A5%E6%9C%AC%E8%AA%9E/foo/bar';
        $expected = [
            'before' => [
                'bar',
                'frak',
            ],
            'after' => [
                'frak',
                'baz',
            ],
        ];
        $this->assertSame($expected, $filters->initialize($uri)->getFilters());
    }

    /**
     * @see https://github.com/codeigniter4/CodeIgniter4/issues/1907
     */
    public function testFilterMatching(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => [
                'foo'  => '',
                'bar'  => '',
                'frak' => '',
            ],
            'globals' => [],
            'filters' => [
                'frak' => [
                    'before' => ['admin*'],
                    'after'  => ['admin/*'],
                ],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $uri    = 'admin';
        $actual = $filters->initialize($uri)->getFilters();

        $expected = [
            'before' => [
                'frak',
            ],
            'after' => [],
        ];
        $this->assertSame($expected, $actual);
    }

    /**
     * @see https://github.com/codeigniter4/CodeIgniter4/issues/1907
     */
    public function testGlobalFilterMatching(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => [
                'foo' => '',
                'one' => '',
                'two' => '',
            ],
            'globals' => [
                'before' => [
                    'foo' => ['except' => 'admin*'],
                    'one',
                ],
                'after' => [
                    'foo' => ['except' => 'admin/*'],
                    'two',
                ],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $uri    = 'admin';
        $actual = $filters->initialize($uri)->getFilters();

        $expected = [
            'before' => [
                'one',
            ],
            'after' => [
                'foo',
                'two',
            ],
        ];
        $this->assertSame($expected, $actual);
    }

    /**
     * @see https://github.com/codeigniter4/CodeIgniter4/issues/1907
     */
    public function testCombinedFilterMatching(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => [
                'foo'  => '',
                'one'  => '',
                'frak' => '',
                'two'  => '',
            ],
            'globals' => [
                'before' => [
                    'foo' => ['except' => 'admin*'],
                    'one',
                ],
                'after' => [
                    'foo' => ['except' => 'admin/*'],
                    'two',
                ],
            ],
            'filters' => [
                'frak' => [
                    'before' => ['admin*'],
                    'after'  => ['admin/*'],
                ],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $uri      = 'admin123';
        $expected = [
            'before' => [
                'one',
                'frak',
            ],
            'after' => [
                'foo',
                'two',
            ],
        ];
        $this->assertSame($expected, $filters->initialize($uri)->getFilters());
    }

    /**
     * @see https://github.com/codeigniter4/CodeIgniter4/issues/1907
     */
    public function testSegmentedFilterMatching(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => [
                'foo'  => '',
                'one'  => '',
                'frak' => '',
            ],
            'globals' => [
                'before' => [
                    'foo' => ['except' => 'admin*'],
                ],
                'after' => [
                    'foo' => ['except' => 'admin/*'],
                ],
            ],
            'filters' => [
                'frak' => [
                    'before' => ['admin*'],
                    'after'  => ['admin/*'],
                ],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $uri      = 'admin/123';
        $expected = [
            'before' => [
                'frak',
            ],
            'after' => [
                'frak',
            ],
        ];
        $this->assertSame($expected, $filters->initialize($uri)->getFilters());
    }

    /**
     * @see https://github.com/codeigniter4/CodeIgniter4/issues/2831
     */
    public function testFilterAliasMultiple(): void
    {
        $config = [
            'aliases' => [
                'multipleTest' => [
                    Multiple1::class,
                    Multiple2::class,
                ],
            ],
            'globals' => [
                'before' => [
                    'multipleTest',
                ],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $uri     = 'admin/foo/bar';
        $request = $filters->run($uri, 'before');

        $this->assertSame('http://exampleMultipleURL.com', $request->header('x-url')->getValue());
        $this->assertSame('http://exampleMultipleCSP.com', $request->header('x-csp')->getValue());
    }

    public function testFilterClass(): void
    {
        $config = [
            'aliases' => [
                'multipleTest' => [
                    Multiple1::class,
                    Multiple2::class,
                ],
            ],
            'globals' => [
                'after' => [
                    'multipleTest',
                ],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $filters->run('admin/foo/bar', 'before');

        $expected = [
            'before' => [],
            'after'  => [
                Multiple1::class,
                Multiple2::class,
            ],
        ];
        $this->assertSame($expected, $filters->getFiltersClass());
    }

    public function testReset(): void
    {
        $_SERVER['REQUEST_METHOD'] = 'GET';

        $config = [
            'aliases' => [
                'foo' => '',
            ],
            'globals' => [],
            'filters' => [
                'foo' => [
                    'before' => ['admin*'],
                ],
            ],
        ];
        $filtersConfig = $this->createConfigFromArray(FiltersConfig::class, $config);
        $filters       = $this->createFilters($filtersConfig);

        $uri = 'admin';
        $this->assertSame(['foo'], $filters->initialize($uri)->getFilters()['before']);
        $this->assertSame([], $filters->reset()->getFilters()['before']);
    }
}

Function Calls

None

Variables

None

Stats

MD5 e45c1293b58780c7db01c34d461515cb
Eval Count 0
Decode Time 94 ms