Test Failed
Push — develop ( ebbd0c...8a31ce )
by nguereza
03:10
created

AuthorizationMiddleware::isAllowed()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 5
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 1
eloc 2
c 1
b 0
f 0
nc 1
nop 1
dl 0
loc 5
rs 10
1
<?php
2
3
/**
4
 * Platine Framework
5
 *
6
 * Platine Framework is a lightweight, high-performance, simple and elegant
7
 * PHP Web framework
8
 *
9
 * This content is released under the MIT License (MIT)
10
 *
11
 * Copyright (c) 2020 Platine Framework
12
 *
13
 * Permission is hereby granted, free of charge, to any person obtaining a copy
14
 * of this software and associated documentation files (the "Software"), to deal
15
 * in the Software without restriction, including without limitation the rights
16
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
17
 * copies of the Software, and to permit persons to whom the Software is
18
 * furnished to do so, subject to the following conditions:
19
 *
20
 * The above copyright notice and this permission notice shall be included in all
21
 * copies or substantial portions of the Software.
22
 *
23
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
24
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
26
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
28
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29
 * SOFTWARE.
30
 */
31
32
/**
33
 *  @file AuthorizationMiddleware.php
34
 *
35
 *  The Authorization middleware class
36
 *
37
 *  @package    Platine\Framework\Auth\Middleware
38
 *  @author Platine Developers team
39
 *  @copyright  Copyright (c) 2020
40
 *  @license    http://opensource.org/licenses/MIT  MIT License
41
 *  @link   http://www.iacademy.cf
42
 *  @version 1.0.0
43
 *  @filesource
44
 */
45
46
declare(strict_types=1);
47
48
namespace Platine\Framework\Auth\Middleware;
49
50
use Platine\Config\Config;
51
use Platine\Framework\Auth\AuthorizationInterface;
52
use Platine\Framework\Http\Response\RedirectResponse;
53
use Platine\Framework\Http\RouteHelper;
54
use Platine\Http\Handler\MiddlewareInterface;
55
use Platine\Http\Handler\RequestHandlerInterface;
56
use Platine\Http\ResponseInterface;
57
use Platine\Http\ServerRequestInterface;
58
use Platine\Route\Route;
59
60
/**
61
 * @class AuthorizationMiddleware
62
 * @package Platine\Framework\Auth\Middleware
63
 * @template T
64
 */
65
class AuthorizationMiddleware implements MiddlewareInterface
66
{
67
68
    /**
69
     * The Authorization instance
70
     * @var AuthorizationInterface
71
     */
72
    protected AuthorizationInterface $authorization;
73
74
    /**
75
     * The configuration instance
76
     * @var Config<T>
77
     */
78
    protected Config $config;
79
80
    /**
81
     * The route helper
82
     * @var RouteHelper
83
     */
84
    protected RouteHelper $routeHelper;
85
86
    /**
87
     * Create new instance
88
     * @param AuthorizationInterface $authorization
89
     * @param Config<T> $config
90
     * @param RouteHelper $routeHelper
91
     */
92
    public function __construct(
93
        AuthorizationInterface $authorization,
94
        Config $config,
95
        RouteHelper $routeHelper
96
    ) {
97
        $this->authorization = $authorization;
98
        $this->config = $config;
99
        $this->routeHelper = $routeHelper;
100
    }
101
102
    /**
103
     * {@inheritdoc}
104
     */
105
    public function process(
106
        ServerRequestInterface $request,
107
        RequestHandlerInterface $handler
108
    ): ResponseInterface {
109
        //If no route has been match no need check for authorization
110
        /** @var ?Route $route */
111
        $route = $request->getAttribute(Route::class);
112
        if (!$route) {
113
            return $handler->handle($request);
114
        }
115
116
        $permission = $route->getAttribute('permission');
117
118
        if (empty($permission)) {
119
            return $handler->handle($request);
120
        }
121
122
        if (!$this->authorization->isGranted($permission)) {
123
            $unauthorizedRoute = $this->config->get(
124
                'auth.authorization.unauthorized_route_name'
125
            );
126
127
            return new RedirectResponse(
128
                $this->routeHelper->generateUrl($unauthorizedRoute)
0 ignored issues
show
Bug introduced by
It seems like $unauthorizedRoute can also be of type null; however, parameter $name of Platine\Framework\Http\RouteHelper::generateUrl() does only seem to accept string, maybe add an additional type check? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

128
                $this->routeHelper->generateUrl(/** @scrutinizer ignore-type */ $unauthorizedRoute)
Loading history...
129
            );
130
        }
131
132
        return $handler->handle($request);
133
    }
134
}
135