├── .gitignore ├── codecov.yml ├── .scrutinizer.yml ├── bundle ├── Matcher │ ├── MatcherInterface.php │ ├── Voter │ │ ├── VoterInterface.php │ │ ├── SiteAccessVoter.php │ │ ├── DefaultSiteAccessVoter.php │ │ └── SiteAccessGroupVoter.php │ └── Matcher.php ├── NetgenSiteAccessRoutesBundle.php ├── DependencyInjection │ ├── NetgenSiteAccessRoutesExtension.php │ └── CompilerPass │ │ └── MatcherPass.php ├── Resources │ └── config │ │ └── services.yaml └── EventListener │ └── RequestListener.php ├── .github └── workflows │ ├── coding_standards.yml │ └── tests.yml ├── phpunit.xml ├── tests ├── Matcher │ ├── Voter │ │ ├── SiteAccessVoterTest.php │ │ ├── DefaultSiteAccessVoterTest.php │ │ └── SiteAccessGroupVoterTest.php │ ├── MatcherIntegrationTest.php │ └── MatcherTest.php └── EventListener │ └── RequestListenerTest.php ├── composer.json ├── .php-cs-fixer.php ├── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | .idea/ 2 | coverage/ 3 | vendor/ 4 | composer.phar 5 | composer.lock 6 | .php-cs-fixer.cache 7 | .phpunit.result.cache 8 | .phpunit.cache 9 | -------------------------------------------------------------------------------- /codecov.yml: -------------------------------------------------------------------------------- 1 | coverage: 2 | status: 3 | patch: false 4 | changes: false 5 | project: 6 | default: 7 | target: auto 8 | comment: off 9 | -------------------------------------------------------------------------------- /.scrutinizer.yml: -------------------------------------------------------------------------------- 1 | filter: 2 | excluded_paths: 3 | - 'tests/*' 4 | - 'vendor/*' 5 | tools: 6 | external_code_coverage: true 7 | php_analyzer: true 8 | sensiolabs_security_checker: true 9 | checks: 10 | php: true 11 | -------------------------------------------------------------------------------- /bundle/Matcher/MatcherInterface.php: -------------------------------------------------------------------------------- 1 | addCompilerPass(new MatcherPass()); 18 | } 19 | } 20 | -------------------------------------------------------------------------------- /bundle/Matcher/Voter/SiteAccessVoter.php: -------------------------------------------------------------------------------- 1 | load('services.yaml'); 18 | } 19 | } 20 | -------------------------------------------------------------------------------- /bundle/Matcher/Voter/DefaultSiteAccessVoter.php: -------------------------------------------------------------------------------- 1 | defaultSiteAccess) { 23 | return VoterInterface::ABSTAIN; 24 | } 25 | 26 | if (in_array(self::DEFAULT_KEY, $routeConfig, true)) { 27 | return true; 28 | } 29 | 30 | return VoterInterface::ABSTAIN; 31 | } 32 | } 33 | -------------------------------------------------------------------------------- /bundle/Matcher/Matcher.php: -------------------------------------------------------------------------------- 1 | voters as $voter) { 24 | $result = $voter->vote($siteAccess, $routeConfig); 25 | if ($result !== VoterInterface::ABSTAIN) { 26 | return $result; 27 | } 28 | } 29 | 30 | return false; 31 | } 32 | } 33 | -------------------------------------------------------------------------------- /phpunit.xml: -------------------------------------------------------------------------------- 1 | 2 | 13 | 14 | 15 | tests 16 | 17 | 18 | 19 | 20 | bundle 21 | 22 | 23 | bundle/DependencyInjection 24 | bundle/Resources 25 | NetgenSiteAccessRoutesBundle.php 26 | 27 | 28 | 29 | -------------------------------------------------------------------------------- /bundle/Matcher/Voter/SiteAccessGroupVoter.php: -------------------------------------------------------------------------------- 1 | groupsBySiteAccess[$siteAccess])) { 22 | return VoterInterface::ABSTAIN; 23 | } 24 | 25 | // We allow the siteaccess if any group to which the siteaccess belongs 26 | // is in the list of allowed siteaccesses 27 | foreach ($this->groupsBySiteAccess[$siteAccess] as $group) { 28 | if (in_array($group, $routeConfig, true)) { 29 | return true; 30 | } 31 | } 32 | 33 | return VoterInterface::ABSTAIN; 34 | } 35 | } 36 | -------------------------------------------------------------------------------- /bundle/DependencyInjection/CompilerPass/MatcherPass.php: -------------------------------------------------------------------------------- 1 | has('netgen_siteaccess_routes.matcher')) { 19 | return; 20 | } 21 | 22 | $matcher = $container->findDefinition('netgen_siteaccess_routes.matcher'); 23 | $voters = $container->findTaggedServiceIds('netgen_siteaccess_routes.voter'); 24 | 25 | $voterServices = []; 26 | foreach ($voters as $serviceName => $tag) { 27 | $voterServices[] = new Reference($serviceName); 28 | } 29 | 30 | $matcher->replaceArgument(0, $voterServices); 31 | } 32 | } 33 | -------------------------------------------------------------------------------- /tests/Matcher/Voter/SiteAccessVoterTest.php: -------------------------------------------------------------------------------- 1 | voter = new SiteAccessVoter(); 21 | } 22 | 23 | #[DataProvider('provideVoteCases')] 24 | public function testVote(string $siteAccess, array $groupConfig, ?bool $vote): void 25 | { 26 | self::assertSame($vote, $this->voter->vote($siteAccess, $groupConfig)); 27 | } 28 | 29 | public static function provideVoteCases(): iterable 30 | { 31 | return [ 32 | ['cro', ['cro', 'eng'], true], 33 | ['eng', ['cro', 'eng'], true], 34 | ['admin', ['cro', 'eng'], VoterInterface::ABSTAIN], 35 | ['extra', ['cro', 'eng'], VoterInterface::ABSTAIN], 36 | ]; 37 | } 38 | } 39 | -------------------------------------------------------------------------------- /bundle/Resources/config/services.yaml: -------------------------------------------------------------------------------- 1 | services: 2 | netgen_siteaccess_routes.event_listener.request: 3 | class: Netgen\Bundle\SiteAccessRoutesBundle\EventListener\RequestListener 4 | arguments: 5 | - "@netgen_siteaccess_routes.matcher" 6 | tags: 7 | - { name: kernel.event_subscriber } 8 | 9 | netgen_siteaccess_routes.matcher: 10 | class: Netgen\Bundle\SiteAccessRoutesBundle\Matcher\Matcher 11 | arguments: 12 | - [] 13 | 14 | netgen_siteaccess_routes.voter.default_siteaccess: 15 | class: Netgen\Bundle\SiteAccessRoutesBundle\Matcher\Voter\DefaultSiteAccessVoter 16 | arguments: 17 | - "%ibexa.site_access.default%" 18 | tags: 19 | - { name: netgen_siteaccess_routes.voter } 20 | 21 | netgen_siteaccess_routes.voter.siteaccess: 22 | class: Netgen\Bundle\SiteAccessRoutesBundle\Matcher\Voter\SiteAccessVoter 23 | tags: 24 | - { name: netgen_siteaccess_routes.voter } 25 | 26 | netgen_siteaccess_routes.voter.siteaccess_group: 27 | class: Netgen\Bundle\SiteAccessRoutesBundle\Matcher\Voter\SiteAccessGroupVoter 28 | arguments: 29 | - "%ibexa.site_access.groups_by_site_access%" 30 | tags: 31 | - { name: netgen_siteaccess_routes.voter } 32 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "netgen/siteaccess-routes-bundle", 3 | "description": "Netgen Siteaccess Routes Bundle is an Ibexa Platform bundle which allows you to specify in which siteaccesses or siteaccess groups can a route be used", 4 | "type": "ibexa-bundle", 5 | "keywords": [ 6 | "ibexa", 7 | "netgen", 8 | "siteaccess-routes-bundle", 9 | "siteaccess" 10 | ], 11 | "homepage": "https://github.com/netgen/NetgenSiteAccessRoutesBundle", 12 | "license": "GPL-2.0-only", 13 | "authors": [ 14 | { 15 | "name": "Netgen", 16 | "homepage": "https://netgen.io" 17 | } 18 | ], 19 | "require": { 20 | "ibexa/core": "^5.0" 21 | }, 22 | "require-dev": { 23 | "phpunit/phpunit": "^12.0" 24 | }, 25 | "minimum-stability": "dev", 26 | "prefer-stable": true, 27 | "autoload": { 28 | "psr-4": { 29 | "Netgen\\Bundle\\SiteAccessRoutesBundle\\": "bundle" 30 | } 31 | }, 32 | "autoload-dev": { 33 | "psr-4": { 34 | "Netgen\\Bundle\\SiteAccessRoutesBundle\\Tests\\": "tests" 35 | } 36 | }, 37 | "scripts": { 38 | "test": "@php vendor/bin/phpunit --colors=always" 39 | }, 40 | "extra": { 41 | "branch-alias": { 42 | "dev-master": "4.x-dev" 43 | } 44 | } 45 | } 46 | -------------------------------------------------------------------------------- /.github/workflows/tests.yml: -------------------------------------------------------------------------------- 1 | name: Tests 2 | 3 | on: 4 | push: 5 | branches: 6 | - 'master' 7 | - '[0-9].[0-9]+' 8 | pull_request: ~ 9 | 10 | jobs: 11 | tests: 12 | name: ${{ matrix.php }} / ${{ matrix.symfony }} / ${{ matrix.phpunit }} 13 | runs-on: ubuntu-latest 14 | 15 | strategy: 16 | fail-fast: false 17 | matrix: 18 | php: ['8.3'] 19 | symfony: ['~7.3.0'] 20 | phpunit: ['phpunit.xml'] 21 | deps: ['normal'] 22 | 23 | steps: 24 | - uses: actions/checkout@v2 25 | - uses: shivammathur/setup-php@v2 26 | with: 27 | php-version: ${{ matrix.php }} 28 | coverage: none 29 | 30 | - run: composer --version 31 | - run: composer validate --strict 32 | 33 | # Install Flex as a global dependency to enable usage of extra.symfony.require 34 | # while keeping Flex recipes from applying 35 | - run: composer global config --no-plugins allow-plugins.symfony/flex true 36 | - run: composer global require --no-scripts symfony/flex 37 | 38 | - run: composer config extra.symfony.require ${{ matrix.symfony }} 39 | 40 | - 41 | run: composer update --prefer-dist 42 | if: ${{ matrix.deps != 'low' }} 43 | 44 | - 45 | run: composer update --prefer-dist --prefer-lowest --prefer-stable 46 | if: ${{ matrix.deps == 'low' }} 47 | 48 | - run: vendor/bin/phpunit -c ${{ matrix.phpunit }} --colors=always 49 | -------------------------------------------------------------------------------- /tests/Matcher/Voter/DefaultSiteAccessVoterTest.php: -------------------------------------------------------------------------------- 1 | voter = new DefaultSiteAccessVoter('eng'); 21 | } 22 | 23 | #[DataProvider('provideVoteCases')] 24 | public function testVote(string $siteAccess, array $groupConfig, ?bool $vote): void 25 | { 26 | self::assertSame($vote, $this->voter->vote($siteAccess, $groupConfig)); 27 | } 28 | 29 | public static function provideVoteCases(): iterable 30 | { 31 | return [ 32 | ['cro', ['_default'], VoterInterface::ABSTAIN], 33 | ['eng', ['_default'], true], 34 | ['extra', ['_default'], VoterInterface::ABSTAIN], 35 | ['cro', ['cro'], VoterInterface::ABSTAIN], 36 | ['eng', ['cro'], VoterInterface::ABSTAIN], 37 | ['extra', ['cro'], VoterInterface::ABSTAIN], 38 | ]; 39 | } 40 | } 41 | -------------------------------------------------------------------------------- /tests/Matcher/Voter/SiteAccessGroupVoterTest.php: -------------------------------------------------------------------------------- 1 | voter = new SiteAccessGroupVoter( 21 | [ 22 | 'eng' => ['frontend'], 23 | 'cro' => ['frontend'], 24 | 'admin' => ['backend'], 25 | ] 26 | ); 27 | } 28 | 29 | #[DataProvider('provideVoteCases')] 30 | public function testVote(string $siteAccess, array $groupConfig, ?bool $vote): void 31 | { 32 | self::assertSame($vote, $this->voter->vote($siteAccess, $groupConfig)); 33 | } 34 | 35 | public static function provideVoteCases(): iterable 36 | { 37 | return [ 38 | ['cro', ['cro', 'backend'], VoterInterface::ABSTAIN], 39 | ['eng', ['cro', 'backend'], VoterInterface::ABSTAIN], 40 | ['admin', ['cro', 'backend'], true], 41 | ['extra', ['cro', 'backend'], VoterInterface::ABSTAIN], 42 | ]; 43 | } 44 | } 45 | -------------------------------------------------------------------------------- /.php-cs-fixer.php: -------------------------------------------------------------------------------- 1 | setRiskyAllowed(true) 5 | ->setRules([ 6 | '@PhpCsFixer' => true, 7 | '@PhpCsFixer:risky' => true, 8 | 9 | // Overrides for rules included in PhpCsFixer rule sets 10 | 'concat_space' => ['spacing' => 'one'], 11 | 'fully_qualified_strict_types' => ['phpdoc_tags' => []], 12 | 'method_chaining_indentation' => false, 13 | 'multiline_whitespace_before_semicolons' => false, 14 | 'native_function_invocation' => ['include' => ['@all']], 15 | 'no_superfluous_phpdoc_tags' => false, 16 | 'ordered_imports' => ['imports_order' => ['class', 'function', 'const']], 17 | 'php_unit_internal_class' => false, 18 | 'php_unit_test_case_static_method_calls' => ['call_type' => 'self'], 19 | 'php_unit_test_class_requires_covers' => false, 20 | 'phpdoc_align' => false, 21 | 'phpdoc_types_order' => ['null_adjustment' => 'always_last', 'sort_algorithm' => 'none'], 22 | 'single_line_comment_style' => false, 23 | 'visibility_required' => ['elements' => ['property', 'method', 'const']], 24 | 'yoda_style' => false, 25 | 26 | // Additional rules 27 | 'date_time_immutable' => true, 28 | 'declare_strict_types' => true, 29 | 'global_namespace_import' => [ 30 | 'import_classes' => null, 31 | 'import_constants' => true, 32 | 'import_functions' => true, 33 | ], 34 | 'list_syntax' => ['syntax' => 'short'], 35 | 'mb_str_functions' => true, 36 | 'native_constant_invocation' => true, 37 | 'nullable_type_declaration_for_default_null_value' => true, 38 | 'static_lambda' => true, 39 | 'ternary_to_null_coalescing' => true, 40 | ]) 41 | ->setFinder( 42 | PhpCsFixer\Finder::create() 43 | ->exclude(['vendor']) 44 | ->in(__DIR__) 45 | ) 46 | ; 47 | -------------------------------------------------------------------------------- /bundle/EventListener/RequestListener.php: -------------------------------------------------------------------------------- 1 | ['onKernelRequest', 31], 29 | ]; 30 | } 31 | 32 | /** 33 | * Throws an exception if current route is not allowed in current siteaccess. 34 | */ 35 | public function onKernelRequest(RequestEvent $event): void 36 | { 37 | if (!$event->isMainRequest()) { 38 | return; 39 | } 40 | 41 | $requestAttributes = $event->getRequest()->attributes; 42 | 43 | $currentSiteAccess = $requestAttributes->get('siteaccess'); 44 | $allowedSiteAccesses = $requestAttributes->get(self::ALLOWED_SITEACCESSES_KEY); 45 | 46 | // We allow the route if no current siteaccess is set or 47 | // no allowed siteaccesses (meaning all are allowed) are defined 48 | if (!$currentSiteAccess instanceof SiteAccess || empty($allowedSiteAccesses)) { 49 | return; 50 | } 51 | 52 | if (!is_array($allowedSiteAccesses)) { 53 | $allowedSiteAccesses = [$allowedSiteAccesses]; 54 | } 55 | 56 | if ($this->matcher->isAllowed($currentSiteAccess->name, $allowedSiteAccesses)) { 57 | return; 58 | } 59 | 60 | throw new NotFoundHttpException('Route is not allowed in current siteaccess'); 61 | } 62 | } 63 | -------------------------------------------------------------------------------- /tests/Matcher/MatcherIntegrationTest.php: -------------------------------------------------------------------------------- 1 | matcher = new Matcher( 22 | [ 23 | new Voter\DefaultSiteAccessVoter('eng'), 24 | new Voter\SiteAccessVoter(), 25 | new Voter\SiteAccessGroupVoter( 26 | [ 27 | 'eng' => ['frontend'], 28 | 'cro' => ['frontend'], 29 | 'admin' => ['backend'], 30 | ] 31 | ), 32 | ] 33 | ); 34 | } 35 | 36 | #[DataProvider('provideIsAllowedCases')] 37 | public function testIsAllowed(string $siteAccess, array $routeConfig, bool $isAllowed): void 38 | { 39 | self::assertSame($isAllowed, $this->matcher->isAllowed($siteAccess, $routeConfig)); 40 | } 41 | 42 | public static function provideIsAllowedCases(): iterable 43 | { 44 | return [ 45 | ['eng', ['eng'], true], 46 | ['cro', ['eng'], false], 47 | ['extra', ['eng'], false], 48 | 49 | ['eng', ['cro'], false], 50 | ['cro', ['cro'], true], 51 | ['extra', ['cro'], false], 52 | 53 | ['eng', ['_default'], true], 54 | ['cro', ['_default'], false], 55 | ['extra', ['_default'], false], 56 | 57 | ['eng', ['eng', 'backend'], true], 58 | ['cro', ['eng', 'backend'], false], 59 | ['admin', ['eng', 'backend'], true], 60 | ['extra', ['eng', 'backend'], false], 61 | 62 | ['eng', ['_default', 'backend'], true], 63 | ['cro', ['_default', 'backend'], false], 64 | ['admin', ['_default', 'backend'], true], 65 | ['extra', ['_default', 'backend'], false], 66 | 67 | ['eng', ['_default', 'cro'], true], 68 | ['cro', ['_default', 'cro'], true], 69 | ['admin', ['_default', 'cro'], false], 70 | ['extra', ['_default', 'cro'], false], 71 | ]; 72 | } 73 | } 74 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Netgen Siteaccess Routes Bundle 2 | =============================== 3 | 4 | [![Code Coverage](https://img.shields.io/codecov/c/github/netgen/NetgenSiteAccessRoutesBundle.svg?style=flat-square)](https://codecov.io/gh/netgen/NetgenSiteAccessRoutesBundle) 5 | [![Quality Score](https://img.shields.io/scrutinizer/g/netgen/NetgenSiteAccessRoutesBundle.svg?style=flat-square)](https://scrutinizer-ci.com/g/netgen/NetgenSiteAccessRoutesBundle) 6 | [![Downloads](https://img.shields.io/packagist/dt/netgen/siteaccess-routes-bundle.svg?style=flat-square)](https://packagist.org/packages/netgen/siteaccess-routes-bundle) 7 | [![Latest stable](https://img.shields.io/packagist/v/netgen/siteaccess-routes-bundle.svg?style=flat-square)](https://packagist.org/packages/netgen/siteaccess-routes-bundle) 8 | [![License](https://img.shields.io/github/license/netgen/NetgenSiteAccessRoutesBundle.svg?style=flat-square)](LICENSE) 9 | 10 | Netgen Siteaccess Routes Bundle is an Ibexa Platform bundle which allows you to specify in which siteaccesses or siteaccess groups can a route be used. 11 | 12 | By default, all routes are accessible in all siteaccesses. To specify in which siteaccess a route can be used, you will need to add an `allowed_siteaccess` param to the `defaults` section of a route or route import: 13 | 14 | ```yml 15 | netgen_site_blog: 16 | path: /blog 17 | controller: "netgen_site.controller.blog:blogAction" 18 | methods: [GET] 19 | defaults: 20 | allowed_siteaccess: cro 21 | ``` 22 | 23 | ```php 24 | // if using PHP attributes 25 | #[Route(path: '/home', defaults: ['allowed_siteaccess' => 'cro'], methods: ['GET'])] 26 | ``` 27 | 28 | or 29 | 30 | ```yml 31 | _netgen_site: 32 | resource: "@NetgenSiteBundle/Resources/config/routing.yaml" 33 | defaults: 34 | allowed_siteaccess: cro 35 | ``` 36 | 37 | You can even specify an array of siteaccesses, or use siteaccess groups: 38 | 39 | ```yml 40 | defaults: 41 | allowed_siteaccess: [backend_group, cro] 42 | ``` 43 | 44 | As a special case, you can use `_default` keyword to signal that the route is also accessible in the default siteaccess, whichever siteaccess that may be. 45 | 46 | ```yml 47 | defaults: 48 | allowed_siteaccess: [cro, _default] 49 | ``` 50 | 51 | ```php 52 | // if using PHP attributes 53 | #[Route(path: '/home', defaults: ['allowed_siteaccess' => ['cro', '_default']], methods: ['GET'])] 54 | ``` 55 | 56 | If the route is not available in current siteaccess, a 404 Not Found response will be returned. 57 | 58 | Installation 59 | ------------ 60 | 61 | Use Composer: 62 | 63 | ```bash 64 | composer require netgen/siteaccess-routes-bundle 65 | ``` 66 | 67 | Activate in `config/bundles.php`: 68 | 69 | ```php 70 | Netgen\Bundle\SiteAccessRoutesBundle\NetgenSiteAccessRoutesBundle::class => ['all' => true], 71 | ``` 72 | 73 | That's it. Configure the routes and go about your day. 74 | 75 | License 76 | ------- 77 | 78 | [GNU General Public License v2](LICENSE) 79 | -------------------------------------------------------------------------------- /tests/Matcher/MatcherTest.php: -------------------------------------------------------------------------------- 1 | voterMocks = [ 26 | $this->createMock(VoterInterface::class), 27 | $this->createMock(VoterInterface::class), 28 | $this->createMock(VoterInterface::class), 29 | ]; 30 | 31 | $this->matcher = new Matcher($this->voterMocks); 32 | } 33 | 34 | #[DataProvider('provideIsAllowedCases')] 35 | public function testIsAllowed(array $voterResults, bool $isAllowed): void 36 | { 37 | foreach ($this->voterMocks as $index => $voter) { 38 | $voter 39 | ->method('vote') 40 | ->willReturn($voterResults[$index]); 41 | } 42 | 43 | self::assertSame($isAllowed, $this->matcher->isAllowed('cro', [])); 44 | } 45 | 46 | public static function provideIsAllowedCases(): iterable 47 | { 48 | return [ 49 | [[true, true, true], true], 50 | [[true, true, false], true], 51 | [[true, false, true], true], 52 | [[true, false, false], true], 53 | [[false, true, true], false], 54 | [[false, true, false], false], 55 | [[false, false, true], false], 56 | [[false, false, false], false], 57 | [[VoterInterface::ABSTAIN, true, true], true], 58 | [[VoterInterface::ABSTAIN, true, false], true], 59 | [[VoterInterface::ABSTAIN, false, true], false], 60 | [[VoterInterface::ABSTAIN, false, false], false], 61 | [[true, VoterInterface::ABSTAIN, true], true], 62 | [[true, VoterInterface::ABSTAIN, false], true], 63 | [[false, VoterInterface::ABSTAIN, true], false], 64 | [[false, VoterInterface::ABSTAIN, false], false], 65 | [[true, true, VoterInterface::ABSTAIN], true], 66 | [[true, false, VoterInterface::ABSTAIN], true], 67 | [[false, true, VoterInterface::ABSTAIN], false], 68 | [[false, false, VoterInterface::ABSTAIN], false], 69 | [[VoterInterface::ABSTAIN, VoterInterface::ABSTAIN, true], true], 70 | [[VoterInterface::ABSTAIN, VoterInterface::ABSTAIN, false], false], 71 | [[VoterInterface::ABSTAIN, true, VoterInterface::ABSTAIN], true], 72 | [[VoterInterface::ABSTAIN, false, VoterInterface::ABSTAIN], false], 73 | [[true, VoterInterface::ABSTAIN, VoterInterface::ABSTAIN], true], 74 | [[false, VoterInterface::ABSTAIN, VoterInterface::ABSTAIN], false], 75 | [[VoterInterface::ABSTAIN, VoterInterface::ABSTAIN, VoterInterface::ABSTAIN], false], 76 | ]; 77 | } 78 | } 79 | -------------------------------------------------------------------------------- /tests/EventListener/RequestListenerTest.php: -------------------------------------------------------------------------------- 1 | matcherMock = $this->createMock(MatcherInterface::class); 29 | 30 | $this->listener = new RequestListener($this->matcherMock); 31 | } 32 | 33 | public function testGetSubscribedEvents(): void 34 | { 35 | self::assertSame( 36 | [KernelEvents::REQUEST => ['onKernelRequest', 31]], 37 | $this->listener::getSubscribedEvents() 38 | ); 39 | } 40 | 41 | public function testOnKernelRequest(): void 42 | { 43 | $kernelMock = $this->createMock(HttpKernelInterface::class); 44 | $request = Request::create('/'); 45 | 46 | $request->attributes->set('allowed_siteaccess', 'cro'); 47 | $request->attributes->set('siteaccess', new SiteAccess('eng')); 48 | 49 | $this->matcherMock 50 | ->expects(self::once()) 51 | ->method('isAllowed') 52 | ->with(self::equalTo('eng'), self::equalTo(['cro'])) 53 | ->willReturn(true); 54 | 55 | $event = new RequestEvent($kernelMock, $request, HttpKernelInterface::MAIN_REQUEST); 56 | self::assertNull($this->listener->onKernelRequest($event)); 57 | } 58 | 59 | public function testOnKernelRequestWithConfigArray(): void 60 | { 61 | $kernelMock = $this->createMock(HttpKernelInterface::class); 62 | $request = Request::create('/'); 63 | 64 | $request->attributes->set('allowed_siteaccess', ['cro', 'eng']); 65 | $request->attributes->set('siteaccess', new SiteAccess('eng')); 66 | 67 | $this->matcherMock 68 | ->expects(self::once()) 69 | ->method('isAllowed') 70 | ->with(self::equalTo('eng'), self::equalTo(['cro', 'eng'])) 71 | ->willReturn(true); 72 | 73 | $event = new RequestEvent($kernelMock, $request, HttpKernelInterface::MAIN_REQUEST); 74 | self::assertNull($this->listener->onKernelRequest($event)); 75 | } 76 | 77 | public function testOnKernelRequestThrowsNotFoundHttpException(): void 78 | { 79 | $this->expectException(NotFoundHttpException::class); 80 | 81 | $kernelMock = $this->createMock(HttpKernelInterface::class); 82 | $request = Request::create('/'); 83 | 84 | $request->attributes->set('allowed_siteaccess', ['cro', 'eng']); 85 | $request->attributes->set('siteaccess', new SiteAccess('eng')); 86 | 87 | $this->matcherMock 88 | ->expects(self::once()) 89 | ->method('isAllowed') 90 | ->with(self::equalTo('eng'), self::equalTo(['cro', 'eng'])) 91 | ->willReturn(false); 92 | 93 | $event = new RequestEvent($kernelMock, $request, HttpKernelInterface::MAIN_REQUEST); 94 | $this->listener->onKernelRequest($event); 95 | } 96 | 97 | public function testOnKernelRequestInSubRequest(): void 98 | { 99 | $kernelMock = $this->createMock(HttpKernelInterface::class); 100 | $request = Request::create('/'); 101 | 102 | $request->attributes->set('allowed_siteaccess', ['cro', 'eng']); 103 | $request->attributes->set('siteaccess', new SiteAccess('eng')); 104 | 105 | $this->matcherMock 106 | ->expects(self::never()) 107 | ->method('isAllowed'); 108 | 109 | $event = new RequestEvent($kernelMock, $request, HttpKernelInterface::SUB_REQUEST); 110 | self::assertNull($this->listener->onKernelRequest($event)); 111 | } 112 | 113 | public function testOnKernelRequestWithNoSiteAccess(): void 114 | { 115 | $kernelMock = $this->createMock(HttpKernelInterface::class); 116 | $request = Request::create('/'); 117 | 118 | $request->attributes->set('allowed_siteaccess', ['cro', 'eng']); 119 | 120 | $this->matcherMock 121 | ->expects(self::never()) 122 | ->method('isAllowed'); 123 | 124 | $event = new RequestEvent($kernelMock, $request, HttpKernelInterface::MAIN_REQUEST); 125 | self::assertNull($this->listener->onKernelRequest($event)); 126 | } 127 | 128 | public function testOnKernelRequestWithNoConfig(): void 129 | { 130 | $kernelMock = $this->createMock(HttpKernelInterface::class); 131 | $request = Request::create('/'); 132 | 133 | $request->attributes->set('siteaccess', new SiteAccess('eng')); 134 | 135 | $this->matcherMock 136 | ->expects(self::never()) 137 | ->method('isAllowed'); 138 | 139 | $event = new RequestEvent($kernelMock, $request, HttpKernelInterface::MAIN_REQUEST); 140 | self::assertNull($this->listener->onKernelRequest($event)); 141 | } 142 | 143 | public function testOnKernelRequestWithEmptyConfig(): void 144 | { 145 | $kernelMock = $this->createMock(HttpKernelInterface::class); 146 | $request = Request::create('/'); 147 | 148 | $request->attributes->set('allowed_siteaccess', []); 149 | $request->attributes->set('siteaccess', new SiteAccess('eng')); 150 | 151 | $this->matcherMock 152 | ->expects(self::never()) 153 | ->method('isAllowed'); 154 | 155 | $event = new RequestEvent($kernelMock, $request, HttpKernelInterface::MAIN_REQUEST); 156 | self::assertNull($this->listener->onKernelRequest($event)); 157 | } 158 | } 159 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc. 5 | 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Library General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | 294 | Copyright (C) 19yy 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License 307 | along with this program; if not, write to the Free Software 308 | Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 309 | 310 | 311 | Also add information on how to contact you by electronic and paper mail. 312 | 313 | If the program is interactive, make it output a short notice like this 314 | when it starts in an interactive mode: 315 | 316 | Gnomovision version 69, Copyright (C) 19yy name of author 317 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 318 | This is free software, and you are welcome to redistribute it 319 | under certain conditions; type `show c' for details. 320 | 321 | The hypothetical commands `show w' and `show c' should show the appropriate 322 | parts of the General Public License. Of course, the commands you use may 323 | be called something other than `show w' and `show c'; they could even be 324 | mouse-clicks or menu items--whatever suits your program. 325 | 326 | You should also get your employer (if you work as a programmer) or your 327 | school, if any, to sign a "copyright disclaimer" for the program, if 328 | necessary. Here is a sample; alter the names: 329 | 330 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 331 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 332 | 333 | , 1 April 1989 334 | Ty Coon, President of Vice 335 | 336 | This General Public License does not permit incorporating your program into 337 | proprietary programs. If your program is a subroutine library, you may 338 | consider it more useful to permit linking proprietary applications with the 339 | library. If this is what you want to do, use the GNU Library General 340 | Public License instead of this License. 341 | --------------------------------------------------------------------------------