route() - Code Metrics - Inspection of "Generate absolute URLs" - fisharebest/webtrees - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( f7ab47...54a7c5 )

by Greg

created 2019-10-20 22:23 UTC

route() B

↳ Parent: Project

Complexity

Conditions	6
Paths	8

Size

Total Lines	41
Code Lines	25

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	6
eloc	25
c	1
b	0
f	0
nc	8
nop	2
dl	0
loc	41
rs	8.8977

<?php

/**
 * webtrees: online genealogy
 * Copyright (C) 2019 webtrees development team
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

declare(strict_types=1);

use Aura\Router\RouterContainer;
use Fig\Http\Message\StatusCodeInterface;
use Fisharebest\Webtrees\Application;
use Fisharebest\Webtrees\Html;
use Fisharebest\Webtrees\Session;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php
use Fisharebest\Webtrees\View as WebtreesView;
use Fisharebest\Webtrees\Webtrees;
use Psr\Http\Message\ResponseFactoryInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Message\StreamFactoryInterface;

/**
 * Get the IoC container, or fetch something from it.
 *
 * @param string|null $abstract
 *
 * @return mixed
 */
function app(string $abstract = null)
{
    if ($abstract === null) {
        return Application::getInstance();
    }

    return Application::getInstance()->make($abstract);
}

/**
 * Generate a URL to an asset file in the public folder.
 * Add a version parameter for cache-busting.
 *
 * @param string $path
 *
 * @return string
 */
function asset(string $path): string
{
    if (substr($path, -1) === '/') {
        $version = '';
    } elseif (Webtrees::STABILITY === '') {

        $version = '?v=' . Webtrees::VERSION;
    } else {
        $version = '?v=' . filemtime(Webtrees::ROOT_DIR . 'public/' . $path);
    }

    $base_url = app(ServerRequestInterface::class)->getAttribute('base_url');

    return $base_url . '/public/' . $path . $version;
}

/**
 * Generate a CSRF token form field.
 *
 * @return string
 */
function csrf_field()
{
    return '<input type="hidden" name="csrf" value="' . e(Session::getCsrfToken()) . '">';
}

/**
 * Get the CSRF token value.
 *
 * @return string
 */
function csrf_token()
{
    return Session::getCsrfToken();
}

/**
 * @param string $url
 * @param int    $code
 *
 * @return ResponseInterface
 */
function redirect(string $url, $code = StatusCodeInterface::STATUS_FOUND): ResponseInterface
{
    /** @var ResponseFactoryInterface $response_factory */
    $response_factory = app(ResponseFactoryInterface::class);

    return $response_factory
        ->createResponse($code)
        ->withHeader('Location', $url);
}

/**
 * Create a response.
 *
 * @param mixed    $content
 * @param int      $code
 * @param string[] $headers
 *
 * @return ResponseInterface
 */
function response($content = '', $code = StatusCodeInterface::STATUS_OK, $headers = []): ResponseInterface
{
    if ($content === '' && $code === StatusCodeInterface::STATUS_OK) {
        $code = StatusCodeInterface::STATUS_NO_CONTENT;
    }

    if ($headers === []) {
        if (is_string($content)) {
            $headers = [
                'Content-Type'   => 'text/html; charset=utf-8',
                'Content-Length' => strlen($content),
            ];
        } else {
            $content = json_encode($content, JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_AMP | JSON_HEX_QUOT);
            $headers = [
                'Content-Type'   => 'application/json',
                'Content-Length' => strlen($content),
            ];
        }
    }

    /** @var ResponseFactoryInterface $response_factory */
    $response_factory = app(ResponseFactoryInterface::class);

    /** @var StreamFactoryInterface $stream_factory */
    $stream_factory = app(StreamFactoryInterface::class);

    $stream = $stream_factory->createStream($content);

    $response = $response_factory
        ->createResponse($code)
        ->withBody($stream);

    foreach ($headers as $key => $value) {
        $response = $response->withHeader($key, $value);
    }

    return $response;
}

/**
 * Generate a URL for a named route.
 *
 * @param string  $route_name
 * @param mixed[] $parameters
 *
 * @return string
 */
function route(string $route_name, array $parameters = []): string
{
    $request          = app(ServerRequestInterface::class);
    $router_container = app(RouterContainer::class);
    $route            = $router_container->getMap()->getRoute($route_name);

    // Scheme/user/pass/host needed for absolute URLs.
    static $prefix = null;

    if ($prefix === null) {
        $base_url   = $request->getAttribute('base_url');
        $base_parts = parse_url($base_url);
        $prefix     = $base_parts['scheme'] . '://';
        if (array_key_exists('user', $base_parts)) {
            $prefix .= $base_parts['user'];
            if (array_key_exists('pass', $base_parts)) {
                $prefix .= $base_parts['pass'];
            }
            $prefix .= '@';
        }
        $prefix .= $base_parts['host'];
    }

    // Generate the URL.
    $url = $router_container->getGenerator()->generate($route_name, $parameters);

    // Aura ignores parameters that are not tokens.  We need to add them as query parameters.
    $parameters = array_filter($parameters, static function (string $key) use ($route): bool {
        return strpos($route->path, '{' . $key . '}') === false && strpos($route->path, '{/' . $key . '}') === false;
    }, ARRAY_FILTER_USE_KEY);

    // Turn the pretty URL into an ugly one.
    if ($request->getAttribute('rewrite_urls') !== '1') {
        $path       = parse_url($url, PHP_URL_PATH);
        $parameters = ['route' => $path] + $parameters;
        $base_url   = $request->getAttribute('base_url');
        $base_path  = parse_url($base_url, PHP_URL_PATH) ?? '';
        $url        = $base_path . '/index.php';
    }

    return Html::url($url, $parameters);
}

/**
 * Cerate and render a view in a single operation.
 *
 * @param string  $name
 * @param mixed[] $data
 *
 * @return string
 */
function view(string $name, array $data = [])
{
    return WebtreesView::make($name, $data);
}


1			<?php
2
3			/**
4			* webtrees: online genealogy
5			* Copyright (C) 2019 webtrees development team
6			* This program is free software: you can redistribute it and/or modify
7			* it under the terms of the GNU General Public License as published by
8			* the Free Software Foundation, either version 3 of the License, or
9			* (at your option) any later version.
10			* This program is distributed in the hope that it will be useful,
11			* but WITHOUT ANY WARRANTY; without even the implied warranty of
12			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13			* GNU General Public License for more details.
14			* You should have received a copy of the GNU General Public License
15			* along with this program. If not, see <http://www.gnu.org/licenses/>.
16			*/
17
18			declare(strict_types=1);
19
20			use Aura\Router\RouterContainer;
21			use Fig\Http\Message\StatusCodeInterface;
22			use Fisharebest\Webtrees\Application;
23			use Fisharebest\Webtrees\Html;
24			use Fisharebest\Webtrees\Session;
			0 ignored issues – show Bug introduced 2018-09-14 11:21 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `Session`. Consider defining an alias. Let?s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let?s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
25			use Fisharebest\Webtrees\View as WebtreesView;
26			use Fisharebest\Webtrees\Webtrees;
27			use Psr\Http\Message\ResponseFactoryInterface;
28			use Psr\Http\Message\ResponseInterface;
29			use Psr\Http\Message\ServerRequestInterface;
30			use Psr\Http\Message\StreamFactoryInterface;
31
32			/**
33			* Get the IoC container, or fetch something from it.
34			*
35			* @param string\|null $abstract
36			*
37			* @return mixed
38			*/
39			function app(string $abstract = null)
40			{
41			if ($abstract === null) {
42			return Application::getInstance();
43			}
44
45			return Application::getInstance()->make($abstract);
46			}
47
48			/**
49			* Generate a URL to an asset file in the public folder.
50			* Add a version parameter for cache-busting.
51			*
52			* @param string $path
53			*
54			* @return string
55			*/
56			function asset(string $path): string
57			{
58			if (substr($path, -1) === '/') {
59			$version = '';
60			} elseif (Webtrees::STABILITY === '') {
			0 ignored issues – show introduced 2019-02-06 23:03 UTC by Report Bug Copy Issue Report The condition `Fisharebest\Webtrees\Webtrees::STABILITY === ''` is always `false`. Loading history...
61			$version = '?v=' . Webtrees::VERSION;
62			} else {
63			$version = '?v=' . filemtime(Webtrees::ROOT_DIR . 'public/' . $path);
64			}
65
66			$base_url = app(ServerRequestInterface::class)->getAttribute('base_url');
67
68			return $base_url . '/public/' . $path . $version;
69			}
70
71			/**
72			* Generate a CSRF token form field.
73			*
74			* @return string
75			*/
76			function csrf_field()
77			{
78			return '<input type="hidden" name="csrf" value="' . e(Session::getCsrfToken()) . '">';
79			}
80
81			/**
82			* Get the CSRF token value.
83			*
84			* @return string
85			*/
86			function csrf_token()
87			{
88			return Session::getCsrfToken();
89			}
90
91			/**
92			* @param string $url
93			* @param int $code
94			*
95			* @return ResponseInterface
96			*/
97			function redirect(string $url, $code = StatusCodeInterface::STATUS_FOUND): ResponseInterface
98			{
99			/** @var ResponseFactoryInterface $response_factory */
100			$response_factory = app(ResponseFactoryInterface::class);
101
102			return $response_factory
103			->createResponse($code)
104			->withHeader('Location', $url);
105			}
106
107			/**
108			* Create a response.
109			*
110			* @param mixed $content
111			* @param int $code
112			* @param string[] $headers
113			*
114			* @return ResponseInterface
115			*/
116			function response($content = '', $code = StatusCodeInterface::STATUS_OK, $headers = []): ResponseInterface
117			{
118			if ($content === '' && $code === StatusCodeInterface::STATUS_OK) {
119			$code = StatusCodeInterface::STATUS_NO_CONTENT;
120			}
121
122			if ($headers === []) {
123			if (is_string($content)) {
124			$headers = [
125			'Content-Type' => 'text/html; charset=utf-8',
126			'Content-Length' => strlen($content),
127			];
128			} else {
129			$content = json_encode($content, JSON_HEX_TAG \| JSON_HEX_APOS \| JSON_HEX_AMP \| JSON_HEX_QUOT);
130			$headers = [
131			'Content-Type' => 'application/json',
132			'Content-Length' => strlen($content),
133			];
134			}
135			}
136
137			/** @var ResponseFactoryInterface $response_factory */
138			$response_factory = app(ResponseFactoryInterface::class);
139
140			/** @var StreamFactoryInterface $stream_factory */
141			$stream_factory = app(StreamFactoryInterface::class);
142
143			$stream = $stream_factory->createStream($content);
144
145			$response = $response_factory
146			->createResponse($code)
147			->withBody($stream);
148
149			foreach ($headers as $key => $value) {
150			$response = $response->withHeader($key, $value);
151			}
152
153			return $response;
154			}
155
156			/**
157			* Generate a URL for a named route.
158			*
159			* @param string $route_name
160			* @param mixed[] $parameters
161			*
162			* @return string
163			*/
164			function route(string $route_name, array $parameters = []): string
165			{
166			$request = app(ServerRequestInterface::class);
167			$router_container = app(RouterContainer::class);
168			$route = $router_container->getMap()->getRoute($route_name);
169
170			// Scheme/user/pass/host needed for absolute URLs.
171			static $prefix = null;
172
173			if ($prefix === null) {
174			$base_url = $request->getAttribute('base_url');
175			$base_parts = parse_url($base_url);
176			$prefix = $base_parts['scheme'] . '://';
177			if (array_key_exists('user', $base_parts)) {
178			$prefix .= $base_parts['user'];
179			if (array_key_exists('pass', $base_parts)) {
180			$prefix .= $base_parts['pass'];
181			}
182			$prefix .= '@';
183			}
184			$prefix .= $base_parts['host'];
185			}
186
187			// Generate the URL.
188			$url = $router_container->getGenerator()->generate($route_name, $parameters);
189
190			// Aura ignores parameters that are not tokens. We need to add them as query parameters.
191			$parameters = array_filter($parameters, static function (string $key) use ($route): bool {
192			return strpos($route->path, '{' . $key . '}') === false && strpos($route->path, '{/' . $key . '}') === false;
193			}, ARRAY_FILTER_USE_KEY);
194
195			// Turn the pretty URL into an ugly one.
196			if ($request->getAttribute('rewrite_urls') !== '1') {
197			$path = parse_url($url, PHP_URL_PATH);
198			$parameters = ['route' => $path] + $parameters;
199			$base_url = $request->getAttribute('base_url');
200			$base_path = parse_url($base_url, PHP_URL_PATH) ?? '';
201			$url = $base_path . '/index.php';
202			}
203
204			return Html::url($url, $parameters);
205			}
206
207			/**
208			* Cerate and render a view in a single operation.
209			*
210			* @param string $name
211			* @param mixed[] $data
212			*
213			* @return string
214			*/
215			function view(string $name, array $data = [])
216			{
217			return WebtreesView::make($name, $data);
218			}
219

fisharebest / webtrees

Push — master ( f7ab47...54a7c5 )

route() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like