UriResolver::uri() - Code Metrics - itsjavi/philae - Measure and Improve Code Quality continuously with Scrutinizer

UriResolver::uri() C
last analyzed 2017-05-27 08:20 UTC

↳ Parent: UriResolver

Complexity

Conditions	7
Paths	13

Size

Total Lines	31
Code Lines	18

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	11
CRAP Score	9.8821

Importance

Changes

Metric	Value
dl	0
loc	31
ccs	11
cts	18
cp	0.6111
rs	6.7272
c	0
b	0
f	0
cc	7
eloc	18
nc	13
nop	2
crap	9.8821

<?php

namespace Philae\Utils;

use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Message\UriInterface;

/**
 * Base URL and base path resolver based on Zend Http Request
 * and compatible with PSR-7.
 *
 * @link https://github.com/zendframework/zend-http/blob/master/src/PhpEnvironment/Request.php
 *
 */
class UriResolver implements UriResolverInterface
{
    /**
     * @var ServerRequestInterface
     */
    protected $request;

    /**
     * @var string
     */
    protected $baseUri;

    /**
     * @var string
     */
    protected $baseUriPath;

    public function __construct(ServerRequestInterface $request)
    {
        $this->request = $request;
    }

    /**
     * Returns a new uri object, a clone of the current request one, with the given modifications.
     *
     * @param string $to If the path is absolute, the base url path won't be prepended,
     *   if it is a relative path it will be prepended.
     * @param array $query If null, the current query will be preserved
     * @return UriInterface
     */
    public function uri(string $to = null, array $query = null): UriInterface
    {
        $baseUrl = $this->getBaseUriPath();
        $uri     = clone $this->request->getUri();

        if (is_null($to) && is_null($query)) {
            return $uri;
        }

        if (strpos($to, '?') !== false) {
            $queryString = explode('?', $to, 2);
            $to          = $queryString[0];
            if (isset($queryString[1])) {
                parse_str($queryString[1], $queryString);
                $query = array_merge($queryString, (array)$query);
            }
        }

        if (strpos($to, '/') !== 0) {
            $baseUrl = rtrim($baseUrl, '/');
            $to      = rtrim($baseUrl . '/' . trim($to, '/'), '/');
        }

        $uri = $uri->withPath($to);

        if (!is_null($query)) {
            $uri = $uri->withQuery(http_build_query($query));
        }

        return $uri;
    }

    public function getBaseUri(): string
    {
        if ($this->baseUri === null) {
            $this->setBaseUri($this->detectBaseUri());
        }

        return $this->baseUri;
    }

    /**
     * @param string $baseUri
     * @return $this
     */
    public function setBaseUri(string $baseUri)
    {
        $this->baseUri = $baseUri;

        return $this;
    }

    /**
     * Set the base path.
     *
     * @param  string $baseUriPath
     * @return self
     */
    public function setBaseUriPath(string $baseUriPath)
    {
        $this->baseUriPath = rtrim($baseUriPath, '/');

        return $this;
    }

    public function getBaseUriPath(): string
    {
        if ($this->baseUriPath === null) {
            $this->setBaseUriPath($this->detectBaseUriPath($this->getBaseUri()));
        }

        return $this->baseUriPath;
    }

    /**
     * @param string $name
     * @param mixed $default
     * @return string|mixed
     */
    protected function getServerParam(string $name, $default = '')
    {
        $params = $this->request->getServerParams();

        return isset($params[$name]) ? $params[$name] : $default;
    }

    /**
     * Auto-detect the base path from the request environment
     *
     * Uses a variety of criteria in order to detect the base URL of the request
     * (i.e., anything additional to the document root).
     *
     *
     * @return string
     */
    protected function detectBaseUri(): string
    {
        $filename       = $this->getServerParam('SCRIPT_FILENAME', '');
        $scriptName     = $this->getServerParam('SCRIPT_NAME');
        $phpSelf        = $this->getServerParam('PHP_SELF');
        $origScriptName = $this->getServerParam('ORIG_SCRIPT_NAME');

        if ($scriptName !== null && basename($scriptName) === $filename) {
            $baseUri = $scriptName;
        } elseif ($phpSelf !== null && basename($phpSelf) === $filename) {
            $baseUri = $phpSelf;
        } elseif ($origScriptName !== null && basename($origScriptName) === $filename) {
            // 1and1 shared hosting compatibility.
            $baseUri = $origScriptName;
        } else {
            // Backtrack up the SCRIPT_FILENAME to find the portion
            // matching PHP_SELF.
            $baseUri  = '/';
            $basename = basename($filename);
            if ($basename) {
                $path    = ($phpSelf ? trim($phpSelf, '/') : '');
                $basePos = strpos($path, $basename) ?: 0;
                $baseUri .= substr($path, 0, $basePos) . $basename;
            }
        }

        // If the baseUri is empty, then simply return it.
        if (empty($baseUri)) {
            return '';
        }

        // Does the base URL have anything in common with the request URI?
        $requestUri = $this->request->getUri()->getPath();

        // Full base URL matches.
        if (0 === strpos($requestUri, $baseUri)) {
            return $baseUri;
        }

        // Directory portion of base path matches.
        $baseDir = str_replace('\\', '/', dirname($baseUri));
        if (0 === strpos($requestUri, $baseDir)) {
            return $baseDir;
        }
        $truncatedRequestUri = $requestUri;
        if (false !== ($pos = strpos($requestUri, '?'))) {
            $truncatedRequestUri = substr($requestUri, 0, $pos);
        }
        $basename = basename($baseUri);

        // No match whatsoever
        if (empty($basename) || false === strpos($truncatedRequestUri, $basename)) {
            return '';
        }

        // If using mod_rewrite or ISAPI_Rewrite strip the script filename
        // out of the base path. $pos !== 0 makes sure it is not matching a
        // value from PATH_INFO or QUERY_STRING.
        if (strlen($requestUri) >= strlen($baseUri)
            && (false !== ($pos = strpos($requestUri, $baseUri)) && $pos !== 0)
        ) {
            $baseUri = substr($requestUri, 0, $pos + strlen($baseUri));
        }

        return $baseUri;
    }

    /**
     * Autodetect the base path of the request, without the filename if any.
     *
     * Uses several criteria to determine the base path of the request.
     *
     * @param string|null $baseUri
     * @return string
     */
    protected function detectBaseUriPath(string $baseUri = null): string
    {
        $baseUri = is_null($baseUri) ? $this->getBaseUri() : $baseUri;

        // Empty base url detected
        if ($baseUri === '') {
            return '';
        }
        $filename = basename($this->getServerParam('SCRIPT_FILENAME', ''));

        // basename() matches the script filename; return the directory
        if (basename($baseUri) === $filename) {
            return str_replace('\\', '/', dirname($baseUri));
        }

        // Base path is identical to base URL
        return $baseUri;
    }
}


1		<?php
2
3		namespace Philae\Utils;
4
5		use Psr\Http\Message\ServerRequestInterface;
6		use Psr\Http\Message\UriInterface;
7
8		/**
9		* Base URL and base path resolver based on Zend Http Request
10		* and compatible with PSR-7.
11		*
12		* @link https://github.com/zendframework/zend-http/blob/master/src/PhpEnvironment/Request.php
13		*
14		*/
15		class UriResolver implements UriResolverInterface
16		{
17		/**
18		* @var ServerRequestInterface
19		*/
20		protected $request;
21
22		/**
23		* @var string
24		*/
25		protected $baseUri;
26
27		/**
28		* @var string
29		*/
30		protected $baseUriPath;
31
32	3	public function __construct(ServerRequestInterface $request)
33		{
34	3	$this->request = $request;
35	3	}
36
37		/**
38		* Returns a new uri object, a clone of the current request one, with the given modifications.
39		*
40		* @param string $to If the path is absolute, the base url path won't be prepended,
41		* if it is a relative path it will be prepended.
42		* @param array $query If null, the current query will be preserved
43		* @return UriInterface
44		*/
45	3	public function uri(string $to = null, array $query = null): UriInterface
46		{
47	3	$baseUrl = $this->getBaseUriPath();
48	3	$uri = clone $this->request->getUri();
49
50	3	if (is_null($to) && is_null($query)) {
51		return $uri;
52		}
53
54	3	if (strpos($to, '?') !== false) {
55		$queryString = explode('?', $to, 2);
56		$to = $queryString[0];
57		if (isset($queryString[1])) {
58		parse_str($queryString[1], $queryString);
59		$query = array_merge($queryString, (array)$query);
60		}
61		}
62
63	3	if (strpos($to, '/') !== 0) {
64	3	$baseUrl = rtrim($baseUrl, '/');
65	3	$to = rtrim($baseUrl . '/' . trim($to, '/'), '/');
66		}
67
68	3	$uri = $uri->withPath($to);
69
70	3	if (!is_null($query)) {
71		$uri = $uri->withQuery(http_build_query($query));
72		}
73
74	3	return $uri;
75		}
76
77	3	public function getBaseUri(): string
78		{
79	3	if ($this->baseUri === null) {
80	3	$this->setBaseUri($this->detectBaseUri());
81		}
82
83	3	return $this->baseUri;
84		}
85
86		/**
87		* @param string $baseUri
88		* @return $this
89		*/
90	3	public function setBaseUri(string $baseUri)
91		{
92	3	$this->baseUri = $baseUri;
93
94	3	return $this;
95		}
96
97		/**
98		* Set the base path.
99		*
100		* @param string $baseUriPath
101		* @return self
102		*/
103	3	public function setBaseUriPath(string $baseUriPath)
104		{
105	3	$this->baseUriPath = rtrim($baseUriPath, '/');
106
107	3	return $this;
108		}
109
110	3	public function getBaseUriPath(): string
111		{
112	3	if ($this->baseUriPath === null) {
113	3	$this->setBaseUriPath($this->detectBaseUriPath($this->getBaseUri()));
114		}
115
116	3	return $this->baseUriPath;
117		}
118
119		/**
120		* @param string $name
121		* @param mixed $default
122		* @return string\|mixed
123		*/
124	3	protected function getServerParam(string $name, $default = '')
125		{
126	3	$params = $this->request->getServerParams();
127
128	3	return isset($params[$name]) ? $params[$name] : $default;
129		}
130
131		/**
132		* Auto-detect the base path from the request environment
133		*
134		* Uses a variety of criteria in order to detect the base URL of the request
135		* (i.e., anything additional to the document root).
136		*
137		*
138		* @return string
139		*/
140	3	protected function detectBaseUri(): string
141		{
142	3	$filename = $this->getServerParam('SCRIPT_FILENAME', '');
143	3	$scriptName = $this->getServerParam('SCRIPT_NAME');
144	3	$phpSelf = $this->getServerParam('PHP_SELF');
145	3	$origScriptName = $this->getServerParam('ORIG_SCRIPT_NAME');
146
147	3	if ($scriptName !== null && basename($scriptName) === $filename) {
148	3	$baseUri = $scriptName;
149		} elseif ($phpSelf !== null && basename($phpSelf) === $filename) {
150		$baseUri = $phpSelf;
151		} elseif ($origScriptName !== null && basename($origScriptName) === $filename) {
152		// 1and1 shared hosting compatibility.
153		$baseUri = $origScriptName;
154		} else {
155		// Backtrack up the SCRIPT_FILENAME to find the portion
156		// matching PHP_SELF.
157		$baseUri = '/';
158		$basename = basename($filename);
159		if ($basename) {
160		$path = ($phpSelf ? trim($phpSelf, '/') : '');
161		$basePos = strpos($path, $basename) ?: 0;
162		$baseUri .= substr($path, 0, $basePos) . $basename;
163		}
164		}
165
166		// If the baseUri is empty, then simply return it.
167	3	if (empty($baseUri)) {
168	3	return '';
169		}
170
171		// Does the base URL have anything in common with the request URI?
172		$requestUri = $this->request->getUri()->getPath();
173
174		// Full base URL matches.
175		if (0 === strpos($requestUri, $baseUri)) {
176		return $baseUri;
177		}
178
179		// Directory portion of base path matches.
180		$baseDir = str_replace('\\', '/', dirname($baseUri));
181		if (0 === strpos($requestUri, $baseDir)) {
182		return $baseDir;
183		}
184		$truncatedRequestUri = $requestUri;
185		if (false !== ($pos = strpos($requestUri, '?'))) {
186		$truncatedRequestUri = substr($requestUri, 0, $pos);
187		}
188		$basename = basename($baseUri);
189
190		// No match whatsoever
191		if (empty($basename) \|\| false === strpos($truncatedRequestUri, $basename)) {
192		return '';
193		}
194
195		// If using mod_rewrite or ISAPI_Rewrite strip the script filename
196		// out of the base path. $pos !== 0 makes sure it is not matching a
197		// value from PATH_INFO or QUERY_STRING.
198		if (strlen($requestUri) >= strlen($baseUri)
199		&& (false !== ($pos = strpos($requestUri, $baseUri)) && $pos !== 0)
200		) {
201		$baseUri = substr($requestUri, 0, $pos + strlen($baseUri));
202		}
203
204		return $baseUri;
205		}
206
207		/**
208		* Autodetect the base path of the request, without the filename if any.
209		*
210		* Uses several criteria to determine the base path of the request.
211		*
212		* @param string\|null $baseUri
213		* @return string
214		*/
215	3	protected function detectBaseUriPath(string $baseUri = null): string
216		{
217	3	$baseUri = is_null($baseUri) ? $this->getBaseUri() : $baseUri;
218
219		// Empty base url detected
220	3	if ($baseUri === '') {
221	3	return '';
222		}
223		$filename = basename($this->getServerParam('SCRIPT_FILENAME', ''));
224
225		// basename() matches the script filename; return the directory
226		if (basename($baseUri) === $filename) {
227		return str_replace('\\', '/', dirname($baseUri));
228		}
229
230		// Base path is identical to base URL
231		return $baseUri;
232		}
233		}
234

itsjavi / philae

UriResolver::uri() C last analyzed 2017-05-27 08:20 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

UriResolver::uri() C
last analyzed 2017-05-27 08:20 UTC