Router::normalizePattern() - Code Metrics - Inspection of "Merge pull request #126 from armanist/master" - softberg/quantum-php-core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( e45033...b3fad6 )

by Arman

created 2022-12-22 18:06 UTC

Router::normalizePattern() A

↳ Parent: Router

Complexity

Conditions	4
Paths	4

Size

Total Lines	11
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	4
eloc	6
c	1
b	0
f	0
nc	4
nop	4
dl	0
loc	11
rs	10

<?php

/**
 * Quantum PHP Framework
 *
 * An open source software development framework for PHP
 *
 * @package Quantum
 * @author Arman Ag. <[email protected]>
 * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org)
 * @link http://quantum.softberg.org/
 * @since 2.9.0
 */

namespace Quantum\Router;

use Quantum\Exceptions\StopExecutionException;
use Quantum\Exceptions\RouteException;
use Quantum\Exceptions\ViewException;
use Quantum\Exceptions\DiException;
use Quantum\Debugger\Debugger;
use Twig\Error\RuntimeError;
use Twig\Error\SyntaxError;
use Twig\Error\LoaderError;
use Quantum\Http\Response;
use Quantum\Http\Request;
use ReflectionException;
use Psr\Log\LogLevel;

/**
 * Class Router
 * @package Quantum\Router
 */
class Router extends RouteController
{

    /**
     * Parameter types
     */
    const PARAM_TYPES = [
        ':alpha' => '[a-zA-Z]',
        ':num' => '[0-9]',
        ':any' => '[^\/]'
    ];

    /**
     * Request instance
     * @var Request;
     */
    private $request;

    /**
     * Response instance
     * @var Response;
     */
    private $response;

    /**
     * List of routes
     * @var array
     */
    private static $routes = [];

    /**
     * matched routes
     * @var array
     */
    private $matchedRoutes = [];

    /**
     * Router constructor.
     * @param Request $request
     * @param Response $response
     */
    public function __construct(Request $request, Response $response)
    {
        $this->request = $request;
        $this->response = $response;
    }

    /**
     * Finds the current route
     * @throws StopExecutionException
     * @throws ViewException
     * @throws DiException
     * @throws LoaderError
     * @throws RuntimeError
     * @throws SyntaxError
     * @throws RouteException
     * @throws ReflectionException
     */
    public function findRoute()
    {
        $uri = $this->request->getUri();

        if (!$uri) {
            throw RouteException::notFound();
        }

        $this->findPatternMatches($uri);

        if (!count($this->matchedRoutes)) {
            stop(function () {
                $this->handleNotFound();
            });
        }

        if (count($this->matchedRoutes) > 1) {
            $this->checkCollision();
        }

        $matchedRoute = current($this->matchedRoutes);

        $this->checkMethod($matchedRoute);

        $matchedRoute['uri'] = $uri;

        self::setCurrentRoute($matchedRoute);

        if (filter_var(config()->get(Debugger::DEBUG_ENABLED), FILTER_VALIDATE_BOOLEAN)) {
            $routeInfo = [];

            array_walk($matchedRoute, function ($value, $key) use (&$routeInfo) {
                $routeInfo[ucfirst($key)] = json_encode($value);
            });

            Debugger::addToStore(Debugger::ROUTES, LogLevel::INFO, $routeInfo);
        }
    }

    /**
     * Set Routes
     * @param array $routes
     */
    public static function setRoutes(array $routes)
    {
        self::$routes = $routes;
    }

    /**
     * Get Routes
     * @return array
     */
    public static function getRoutes(): array
    {
        return self::$routes;
    }

    /**
     * Resets the routes
     */
    public function resetRoutes()
    {
        parent::$currentRoute = null;
        $this->matchedRoutes = [];
    }

    /**
     * Finds matches by pattern
     * @param string $uri
     * @throws RouteException
     */
    private function findPatternMatches(string $uri)
    {
        $requestUri = urldecode(parse_url($uri)['path']);

        foreach (self::$routes as $route) {

            list($pattern, $params) = $this->handleRoutePattern($route);

            preg_match("/^" . $this->escape($pattern) . "$/u", $requestUri, $matches);

            if (count($matches)) {
                $route['params'] = $this->routeParams($params, $matches);
                $route['pattern'] = $pattern;
                $this->matchedRoutes[] = $route;
            }
        }
    }

    /**
     * Handles the route pattern
     * @param array $route
     * @return array
     * @throws RouteException
     */
    private function handleRoutePattern(array $route): array
    {
        $routeSegments = explode('/', trim($route['route'], '/'));

        $routePattern = '(\/)?';
        $routeParams = [];

        $lastIndex = (int)array_key_last($routeSegments);

        foreach ($routeSegments as $index => $segment) {
            $segmentParam = $this->checkSegment($segment, $index, $lastIndex);

            if (!empty($segmentParam)) {
                $this->checkParamName($routeParams, $segmentParam['name']);

                $routeParams[] = [
                    'route_pattern' => $segment,
                    'pattern' => $segmentParam['pattern'],
                    'name' => $segmentParam['name']
                ];

                $routePattern = $this->normalizePattern($routePattern, $segmentParam, $index, $lastIndex);
            } else {
                $routePattern .= $segment;

                if ($index != $lastIndex) {
                    $routePattern .= '(\/)';
                }
            }
        }

        return [
            $routePattern,
            $routeParams
        ];
    }

    /**
     * Normalize the pattern
     * @param string $routePattern
     * @param array $segmentParam
     * @param int $index
     * @param int $lastIndex
     * @return string
     */
    private function normalizePattern(string $routePattern, array $segmentParam, int $index, int $lastIndex): string
    {
        if ($index == $lastIndex) {
            if (mb_substr($routePattern, -5) == '(\/)?') {
                $routePattern = mb_substr($routePattern, 0, mb_strlen($routePattern) - 5);
            } elseif (mb_substr($routePattern, -4) == '(\/)') {
                $routePattern = mb_substr($routePattern, 0, mb_strlen($routePattern) - 4);
            }
        }

        return $routePattern .= $segmentParam['pattern'];
    }

    /**
     * Gets the route parameters
     * @param array $params
     * @param array $arguments
     * @return array
     */
    private function routeParams(array $params, array $arguments): array
    {
        $arguments = array_diff($arguments, ['', '/']);

        foreach ($params as &$param) {
            $param['value'] = $arguments[$param['name']] ?? null;
            if (mb_substr($param['name'], 0, 1) == '_') {
                $param['name'] = null;
            }
        }

        return $params;
    }

    /**
     * Checks the segment for parameter
     * @param string $segment
     * @param int $index
     * @param int $lastIndex
     * @return array
     * @throws RouteException
     */
    private function checkSegment(string $segment, int $index, int $lastIndex): array
    {
        foreach (self::PARAM_TYPES as $type => $expr) {
            if (preg_match('/\[(.*=)*(' . $type . ')(:([0-9]+))*\](\?)?/', $segment, $match)) {
                return $this->getParamPattern($match, $expr, $index, $lastIndex);
            }
        }

        return [];
    }

    /**
     * Checks the parameter name availability
     * @param array $routeParams
     * @param string $name
     * @throws RouteException
     */
    private function checkParamName(array $routeParams, string $name)
    {
        foreach ($routeParams as $param) {
            if ($param['name'] == $name) {
                throw RouteException::paramNameNotAvailable($name);
            }
        }
    }

    /**
     * Finds pattern for parameter
     * @param array $match
     * @param string $expr
     * @param int $index
     * @param int $lastIndex
     * @return array
     * @throws RouteException
     */
    private function getParamPattern(array $match, string $expr, int $index, int $lastIndex): array
    {
        $pattern = '';

        $name = $this->getParamName($match, $index);

        $pattern .= '(?<' . $name . '>' . $expr;

        if (isset($match[4]) && is_numeric($match[4])) {
            if (isset($match[5]) && $match[5] == '?') {
                $pattern .= '{0,' . $match[4] . '})';
            } else {
                $pattern .= '{' . $match[4] . '})';
            }
        } else {
            if (isset($match[5]) && $match[5] == '?') {
                $pattern .= '*)';
            } else {
                $pattern .= '+)';
            }
        }

        if (isset($match[5]) && $match[5] == '?') {
            $pattern = ($index == $lastIndex ? '(\/)?' . $pattern : $pattern . '(\/)?');
        } else {
            $pattern = ($index == $lastIndex ? '(\/)' . $pattern : $pattern . '(\/)');
        }

        return [
            'name' => $name,
            'pattern' => $pattern
        ];
    }

    /**
     * Gets the parameter name
     * @param array $match
     * @param int $index
     * @return string
     * @throws RouteException
     */
    private function getParamName(array $match, int $index): string
    {
        $name = $match[1] ? rtrim($match[1], '=') : null;

        if ($name) {
            if (!preg_match('/^[a-zA-Z]+$/', $name)) {
                throw RouteException::paramNameNotValid();
            }
        } else {
            $name = '_segment' . $index;
        }

        return $name;
    }

    /**
     * Checks the route collisions
     * @throws RouteException
     */
    private function checkCollision()
    {
        $length = count($this->matchedRoutes);

        for ($i = 0; $i < $length - 1; $i++) {
            for ($j = $i + 1; $j < $length; $j++) {
                if ($this->matchedRoutes[$i]['method'] == $this->matchedRoutes[$j]['method']) {
                    throw RouteException::repetitiveRouteSameMethod($this->matchedRoutes[$j]['method']);
                }
                if ($this->matchedRoutes[$i]['module'] != $this->matchedRoutes[$j]['module']) {
                    throw RouteException::repetitiveRouteDifferentModules();
                }
            }
        }
    }

    /**
     * Checks the request method against defined route method
     * @param array $matchedRoute
     * @throws RouteException
     */
    private function checkMethod(array $matchedRoute)
    {
        if (strpos($matchedRoute['method'], '|') !== false) {
            if (!in_array($this->request->getMethod(), explode('|', $matchedRoute['method']))) {
                throw RouteException::incorrectMethod($this->request->getMethod());
            }
        } else if ($this->request->getMethod() != $matchedRoute['method']) {
            throw RouteException::incorrectMethod($this->request->getMethod());
        }
    }

    /**
     * Escapes the slashes
     * @param string $str
     * @return string
     */
    private function escape(string $str): string
    {
        return str_replace('/', '\/', stripslashes($str));
    }

    /**
     * Handles page not found
     * @throws DiException
     * @throws ViewException
     * @throws ReflectionException
     * @throws LoaderError
     * @throws RuntimeError
     * @throws SyntaxError
     */
    private function handleNotFound()
    {
        if ($this->request->getHeader('Accept') == 'application/json') {
            $this->response->json(['status' => 'error', 'message' => 'Page not found'], 404);
        } else {
            $this->response->html(partial('errors/404'), 404);
        }
    }

}


1			<?php
2
3			/**
4			* Quantum PHP Framework
5			*
6			* An open source software development framework for PHP
7			*
8			* @package Quantum
9			* @author Arman Ag. <[email protected]>
10			* @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org)
11			* @link http://quantum.softberg.org/
12			* @since 2.9.0
13			*/
14
15			namespace Quantum\Router;
16
17			use Quantum\Exceptions\StopExecutionException;
18			use Quantum\Exceptions\RouteException;
19			use Quantum\Exceptions\ViewException;
20			use Quantum\Exceptions\DiException;
21			use Quantum\Debugger\Debugger;
22			use Twig\Error\RuntimeError;
23			use Twig\Error\SyntaxError;
24			use Twig\Error\LoaderError;
25			use Quantum\Http\Response;
26			use Quantum\Http\Request;
27			use ReflectionException;
28			use Psr\Log\LogLevel;
29
30			/**
31			* Class Router
32			* @package Quantum\Router
33			*/
34			class Router extends RouteController
35			{
36
37			/**
38			* Parameter types
39			*/
40			const PARAM_TYPES = [
41			':alpha' => '[a-zA-Z]',
42			':num' => '[0-9]',
43			':any' => '[^\/]'
44			];
45
46			/**
47			* Request instance
48			* @var Request;
49			*/
50			private $request;
51
52			/**
53			* Response instance
54			* @var Response;
55			*/
56			private $response;
57
58			/**
59			* List of routes
60			* @var array
61			*/
62			private static $routes = [];
63
64			/**
65			* matched routes
66			* @var array
67			*/
68			private $matchedRoutes = [];
69
70			/**
71			* Router constructor.
72			* @param Request $request
73			* @param Response $response
74			*/
75			public function __construct(Request $request, Response $response)
76			{
77			$this->request = $request;
78			$this->response = $response;
79			}
80
81			/**
82			* Finds the current route
83			* @throws StopExecutionException
84			* @throws ViewException
85			* @throws DiException
86			* @throws LoaderError
87			* @throws RuntimeError
88			* @throws SyntaxError
89			* @throws RouteException
90			* @throws ReflectionException
91			*/
92			public function findRoute()
93			{
94			$uri = $this->request->getUri();
95
96			if (!$uri) {
97			throw RouteException::notFound();
98			}
99
100			$this->findPatternMatches($uri);
101
102			if (!count($this->matchedRoutes)) {
103			stop(function () {
104			$this->handleNotFound();
105			});
106			}
107
108			if (count($this->matchedRoutes) > 1) {
109			$this->checkCollision();
110			}
111
112			$matchedRoute = current($this->matchedRoutes);
113
114			$this->checkMethod($matchedRoute);
115
116			$matchedRoute['uri'] = $uri;
117
118			self::setCurrentRoute($matchedRoute);
119
120			if (filter_var(config()->get(Debugger::DEBUG_ENABLED), FILTER_VALIDATE_BOOLEAN)) {
121			$routeInfo = [];
122
123			array_walk($matchedRoute, function ($value, $key) use (&$routeInfo) {
124			$routeInfo[ucfirst($key)] = json_encode($value);
125			});
126
127			Debugger::addToStore(Debugger::ROUTES, LogLevel::INFO, $routeInfo);
128			}
129			}
130
131			/**
132			* Set Routes
133			* @param array $routes
134			*/
135			public static function setRoutes(array $routes)
136			{
137			self::$routes = $routes;
138			}
139
140			/**
141			* Get Routes
142			* @return array
143			*/
144			public static function getRoutes(): array
145			{
146			return self::$routes;
147			}
148
149			/**
150			* Resets the routes
151			*/
152			public function resetRoutes()
153			{
154			parent::$currentRoute = null;
155			$this->matchedRoutes = [];
156			}
157
158			/**
159			* Finds matches by pattern
160			* @param string $uri
161			* @throws RouteException
162			*/
163			private function findPatternMatches(string $uri)
164			{
165			$requestUri = urldecode(parse_url($uri)['path']);
166
167			foreach (self::$routes as $route) {
168
169			list($pattern, $params) = $this->handleRoutePattern($route);
170
171			preg_match("/^" . $this->escape($pattern) . "$/u", $requestUri, $matches);
172
173			if (count($matches)) {
174			$route['params'] = $this->routeParams($params, $matches);
175			$route['pattern'] = $pattern;
176			$this->matchedRoutes[] = $route;
177			}
178			}
179			}
180
181			/**
182			* Handles the route pattern
183			* @param array $route
184			* @return array
185			* @throws RouteException
186			*/
187			private function handleRoutePattern(array $route): array
188			{
189			$routeSegments = explode('/', trim($route['route'], '/'));
190
191			$routePattern = '(\/)?';
192			$routeParams = [];
193
194			$lastIndex = (int)array_key_last($routeSegments);
195
196			foreach ($routeSegments as $index => $segment) {
197			$segmentParam = $this->checkSegment($segment, $index, $lastIndex);
198
199			if (!empty($segmentParam)) {
200			$this->checkParamName($routeParams, $segmentParam['name']);
201
202			$routeParams[] = [
203			'route_pattern' => $segment,
204			'pattern' => $segmentParam['pattern'],
205			'name' => $segmentParam['name']
206			];
207
208			$routePattern = $this->normalizePattern($routePattern, $segmentParam, $index, $lastIndex);
209			} else {
210			$routePattern .= $segment;
211
212			if ($index != $lastIndex) {
213			$routePattern .= '(\/)';
214			}
215			}
216			}
217
218			return [
219			$routePattern,
220			$routeParams
221			];
222			}
223
224			/**
225			* Normalize the pattern
226			* @param string $routePattern
227			* @param array $segmentParam
228			* @param int $index
229			* @param int $lastIndex
230			* @return string
231			*/
232			private function normalizePattern(string $routePattern, array $segmentParam, int $index, int $lastIndex): string
233			{
234			if ($index == $lastIndex) {
235			if (mb_substr($routePattern, -5) == '(\/)?') {
236			$routePattern = mb_substr($routePattern, 0, mb_strlen($routePattern) - 5);
237			} elseif (mb_substr($routePattern, -4) == '(\/)') {
238			$routePattern = mb_substr($routePattern, 0, mb_strlen($routePattern) - 4);
239			}
240			}
241
242			return $routePattern .= $segmentParam['pattern'];
243			}
244
245			/**
246			* Gets the route parameters
247			* @param array $params
248			* @param array $arguments
249			* @return array
250			*/
251			private function routeParams(array $params, array $arguments): array
252			{
253			$arguments = array_diff($arguments, ['', '/']);
254
255			foreach ($params as &$param) {
256			$param['value'] = $arguments[$param['name']] ?? null;
257			if (mb_substr($param['name'], 0, 1) == '_') {
258			$param['name'] = null;
259			}
260			}
261
262			return $params;
263			}
264
265			/**
266			* Checks the segment for parameter
267			* @param string $segment
268			* @param int $index
269			* @param int $lastIndex
270			* @return array
271			* @throws RouteException
272			*/
273			private function checkSegment(string $segment, int $index, int $lastIndex): array
274			{
275			foreach (self::PARAM_TYPES as $type => $expr) {
276			if (preg_match('/\[(.=)(' . $type . ')(:([0-9]+))*\](\?)?/', $segment, $match)) {
277			return $this->getParamPattern($match, $expr, $index, $lastIndex);
278			}
279			}
280
281			return [];
282			}
283
284			/**
285			* Checks the parameter name availability
286			* @param array $routeParams
287			* @param string $name
288			* @throws RouteException
289			*/
290			private function checkParamName(array $routeParams, string $name)
291			{
292			foreach ($routeParams as $param) {
293			if ($param['name'] == $name) {
294			throw RouteException::paramNameNotAvailable($name);
295			}
296			}
297			}
298
299			/**
300			* Finds pattern for parameter
301			* @param array $match
302			* @param string $expr
303			* @param int $index
304			* @param int $lastIndex
305			* @return array
306			* @throws RouteException
307			*/
308			private function getParamPattern(array $match, string $expr, int $index, int $lastIndex): array
309			{
310			$pattern = '';
311
312			$name = $this->getParamName($match, $index);
313
314			$pattern .= '(?<' . $name . '>' . $expr;
315
316			if (isset($match[4]) && is_numeric($match[4])) {
317			if (isset($match[5]) && $match[5] == '?') {
318			$pattern .= '{0,' . $match[4] . '})';
319			} else {
320			$pattern .= '{' . $match[4] . '})';
321			}
322			} else {
323			if (isset($match[5]) && $match[5] == '?') {
324			$pattern .= '*)';
325			} else {
326			$pattern .= '+)';
327			}
328			}
329
330			if (isset($match[5]) && $match[5] == '?') {
331			$pattern = ($index == $lastIndex ? '(\/)?' . $pattern : $pattern . '(\/)?');
332			} else {
333			$pattern = ($index == $lastIndex ? '(\/)' . $pattern : $pattern . '(\/)');
334			}
335
336			return [
337			'name' => $name,
338			'pattern' => $pattern
339			];
340			}
341
342			/**
343			* Gets the parameter name
344			* @param array $match
345			* @param int $index
346			* @return string
347			* @throws RouteException
348			*/
349			private function getParamName(array $match, int $index): string
350			{
351			$name = $match[1] ? rtrim($match[1], '=') : null;
352
353			if ($name) {
354			if (!preg_match('/^[a-zA-Z]+$/', $name)) {
355			throw RouteException::paramNameNotValid();
356			}
357			} else {
358			$name = '_segment' . $index;
359			}
360
361			return $name;
362			}
363
364			/**
365			* Checks the route collisions
366			* @throws RouteException
367			*/
368			private function checkCollision()
369			{
370			$length = count($this->matchedRoutes);
371
372			for ($i = 0; $i < $length - 1; $i++) {
373			for ($j = $i + 1; $j < $length; $j++) {
374			if ($this->matchedRoutes[$i]['method'] == $this->matchedRoutes[$j]['method']) {
375			throw RouteException::repetitiveRouteSameMethod($this->matchedRoutes[$j]['method']);
376			}
377			if ($this->matchedRoutes[$i]['module'] != $this->matchedRoutes[$j]['module']) {
378			throw RouteException::repetitiveRouteDifferentModules();
379			}
380			}
381			}
382			}
383
384			/**
385			* Checks the request method against defined route method
386			* @param array $matchedRoute
387			* @throws RouteException
388			*/
389			private function checkMethod(array $matchedRoute)
390			{
391			if (strpos($matchedRoute['method'], '\|') !== false) {
392			if (!in_array($this->request->getMethod(), explode('\|', $matchedRoute['method']))) {
393			throw RouteException::incorrectMethod($this->request->getMethod());
394			}
395			} else if ($this->request->getMethod() != $matchedRoute['method']) {
396			throw RouteException::incorrectMethod($this->request->getMethod());
397			}
398			}
399
400			/**
401			* Escapes the slashes
402			* @param string $str
403			* @return string
404			*/
405			private function escape(string $str): string
406			{
407			return str_replace('/', '\/', stripslashes($str));
408			}
409
410			/**
411			* Handles page not found
412			* @throws DiException
413			* @throws ViewException
414			* @throws ReflectionException
415			* @throws LoaderError
416			* @throws RuntimeError
417			* @throws SyntaxError
418			*/
419			private function handleNotFound()
420			{
421			if ($this->request->getHeader('Accept') == 'application/json') {
422			$this->response->json(['status' => 'error', 'message' => 'Page not found'], 404);
423			} else {
424			$this->response->html(partial('errors/404'), 404);
425			}
426			}
427
428			}
429

softberg / quantum-php-core

Push — master ( e45033...b3fad6 )

Router::normalizePattern() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like