BasePath::detectBasePath() - Code Metrics - Inspection of "clarify basePath doc" - oscarotero/psr7-middlewares - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b2e200...1332b8 )

by Oscar

created 2015-12-29 10:19 UTC

BasePath::detectBasePath() F

↳ Parent: BasePath

Complexity

Conditions	23
Paths	1152

Size

Total Lines	73
Code Lines	37

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	73
rs	2.4986
cc	23
eloc	37
nc	1152
nop	1

How to fix Long Method Complexity

<?php

namespace Psr7Middlewares\Middleware;

use Psr7Middlewares\Utils;
use Psr7Middlewares\Middleware;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Message\ResponseInterface;

/**
 * Middleware to strip the path prefix.
 */
class BasePath
{
    const KEY = 'BASE_PATH';

    use Utils\BasePathTrait;

    /**
     * @var bool
     */
    private $autodetect = false;

    /**
     * Returns the basePath.
     *
     * @param ServerRequestInterface $request
     *
     * @return string|null
     */
    public static function getBasePath(ServerRequestInterface $request)
    {
        return Middleware::getAttribute($request, self::KEY);
    }

    /**
     * Constructor. Set the path prefix.
     *
     * @param string|null $basePath
     */
    public function __construct($basePath = null)
    {
        if ($basePath !== null) {
            $this->basePath($basePath);
        }
    }

    /**
     * Autodetect the basePath.
     *
     * @param bool $autodetect
     * 
     * @return self
     */
    public function autodetect($autodetect = true)
    {
        $this->autodetect = $autodetect;

        return $this;
    }

    /**
     * Execute the middleware.
     *
     * @param ServerRequestInterface $request
     * @param ResponseInterface      $response
     * @param callable               $next
     *
     * @return ResponseInterface
     */
    public function __invoke(ServerRequestInterface $request, ResponseInterface $response, callable $next)
    {
        if ($this->autodetect) {
            $this->basePath(self::detectBasePath($request));
        }

        $uri = $request->getUri();
        $path = $this->getPath($uri->getPath());
        $request = $request->withUri($uri->withPath($path));

        $request = Middleware::setAttribute($request, self::KEY, $this->basePath);

        return $next($request, $response);
    }

    /**
     * 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).
     * 
     * This code has been adapted from the Zend implementation:
     * https://github.com/zendframework/zend-http/blob/master/src/PhpEnvironment/Request.php
     * 
     * @param ServerRequestInterface $request
     *
     * @return string
     */
    protected static function detectBasePath(ServerRequestInterface $request)
    {
        $server = $request->getServerParams();

        $filename = isset($server['SCRIPT_FILENAME']) ? $server['SCRIPT_FILENAME'] : '';
        $scriptName = isset($server['SCRIPT_NAME']) ? $server['SCRIPT_NAME'] : null;
        $phpSelf = isset($server['PHP_SELF']) ? $server['PHP_SELF'] : null;
        $origScriptName = isset($server['ORIG_SCRIPT_NAME']) ? $server['ORIG_SCRIPT_NAME'] : null;

        if ($scriptName !== null && basename($scriptName) === $filename) {
            $baseUrl = $scriptName;
        } elseif ($phpSelf !== null && basename($phpSelf) === $filename) {
            $baseUrl = $phpSelf;
        } elseif ($origScriptName !== null && basename($origScriptName) === $filename) {
            // 1and1 shared hosting compatibility.
            $baseUrl = $origScriptName;
        } else {
            // Backtrack up the SCRIPT_FILENAME to find the portion
            // matching PHP_SELF.
            $baseUrl = '/';
            $basename = basename($filename);

            if ($basename) {
                $path = ($phpSelf ? trim($phpSelf, '/') : '');
                $basePos = strpos($path, $basename) ?: 0;
                $baseUrl .= substr($path, 0, $basePos).$basename;
            }
        }

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

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

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

        // Directory portion of base path matches.
        $baseDir = str_replace('\\', '/', dirname($baseUrl));

        if (0 === strpos($requestUri, $baseDir)) {
            return $baseDir;
        }

        $truncatedRequestUri = $requestUri;

        if (false !== ($pos = strpos($requestUri, '?'))) {
            $truncatedRequestUri = substr($requestUri, 0, $pos);
        }

        $basename = basename($baseUrl);

        // 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($baseUrl)
            && (false !== ($pos = strpos($requestUri, $baseUrl)) && $pos !== 0)
        ) {
            $baseUrl = substr($requestUri, 0, $pos + strlen($baseUrl));
        }

        return $baseUrl;
    }
}


1			<?php
2
3			namespace Psr7Middlewares\Middleware;
4
5			use Psr7Middlewares\Utils;
6			use Psr7Middlewares\Middleware;
7			use Psr\Http\Message\ServerRequestInterface;
8			use Psr\Http\Message\ResponseInterface;
9
10			/**
11			* Middleware to strip the path prefix.
12			*/
13			class BasePath
14			{
15			const KEY = 'BASE_PATH';
16
17			use Utils\BasePathTrait;
18
19			/**
20			* @var bool
21			*/
22			private $autodetect = false;
23
24			/**
25			* Returns the basePath.
26			*
27			* @param ServerRequestInterface $request
28			*
29			* @return string\|null
30			*/
31			public static function getBasePath(ServerRequestInterface $request)
32			{
33			return Middleware::getAttribute($request, self::KEY);
34			}
35
36			/**
37			* Constructor. Set the path prefix.
38			*
39			* @param string\|null $basePath
40			*/
41			public function __construct($basePath = null)
42			{
43			if ($basePath !== null) {
44			$this->basePath($basePath);
45			}
46			}
47
48			/**
49			* Autodetect the basePath.
50			*
51			* @param bool $autodetect
52			*
53			* @return self
54			*/
55			public function autodetect($autodetect = true)
56			{
57			$this->autodetect = $autodetect;
58
59			return $this;
60			}
61
62			/**
63			* Execute the middleware.
64			*
65			* @param ServerRequestInterface $request
66			* @param ResponseInterface $response
67			* @param callable $next
68			*
69			* @return ResponseInterface
70			*/
71			public function __invoke(ServerRequestInterface $request, ResponseInterface $response, callable $next)
72			{
73			if ($this->autodetect) {
74			$this->basePath(self::detectBasePath($request));
75			}
76
77			$uri = $request->getUri();
78			$path = $this->getPath($uri->getPath());
79			$request = $request->withUri($uri->withPath($path));
80
81			$request = Middleware::setAttribute($request, self::KEY, $this->basePath);
82
83			return $next($request, $response);
84			}
85
86			/**
87			* Auto-detect the base path from the request environment.
88			*
89			* Uses a variety of criteria in order to detect the base URL of the request
90			* (i.e., anything additional to the document root).
91			*
92			* This code has been adapted from the Zend implementation:
93			* https://github.com/zendframework/zend-http/blob/master/src/PhpEnvironment/Request.php
94			*
95			* @param ServerRequestInterface $request
96			*
97			* @return string
98			*/
99			protected static function detectBasePath(ServerRequestInterface $request)
100			{
101			$server = $request->getServerParams();
102
103			$filename = isset($server['SCRIPT_FILENAME']) ? $server['SCRIPT_FILENAME'] : '';
104			$scriptName = isset($server['SCRIPT_NAME']) ? $server['SCRIPT_NAME'] : null;
105			$phpSelf = isset($server['PHP_SELF']) ? $server['PHP_SELF'] : null;
106			$origScriptName = isset($server['ORIG_SCRIPT_NAME']) ? $server['ORIG_SCRIPT_NAME'] : null;
107
108			if ($scriptName !== null && basename($scriptName) === $filename) {
109			$baseUrl = $scriptName;
110			} elseif ($phpSelf !== null && basename($phpSelf) === $filename) {
111			$baseUrl = $phpSelf;
112			} elseif ($origScriptName !== null && basename($origScriptName) === $filename) {
113			// 1and1 shared hosting compatibility.
114			$baseUrl = $origScriptName;
115			} else {
116			// Backtrack up the SCRIPT_FILENAME to find the portion
117			// matching PHP_SELF.
118			$baseUrl = '/';
119			$basename = basename($filename);
120
121			if ($basename) {
122			$path = ($phpSelf ? trim($phpSelf, '/') : '');
123			$basePos = strpos($path, $basename) ?: 0;
124			$baseUrl .= substr($path, 0, $basePos).$basename;
125			}
126			}
127
128			// If the baseUrl is empty, then simply return it.
129			if (empty($baseUrl)) {
130			return '';
131			}
132
133			// Does the base URL have anything in common with the request URI?
134			$requestUri = $request->getUri()->getPath();
135
136			// Full base URL matches.
137			if (0 === strpos($requestUri, $baseUrl)) {
138			return $baseUrl;
139			}
140
141			// Directory portion of base path matches.
142			$baseDir = str_replace('\\', '/', dirname($baseUrl));
143
144			if (0 === strpos($requestUri, $baseDir)) {
145			return $baseDir;
146			}
147
148			$truncatedRequestUri = $requestUri;
149
150			if (false !== ($pos = strpos($requestUri, '?'))) {
151			$truncatedRequestUri = substr($requestUri, 0, $pos);
152			}
153
154			$basename = basename($baseUrl);
155
156			// No match whatsoever
157			if (empty($basename) \|\| false === strpos($truncatedRequestUri, $basename)) {
158			return '';
159			}
160
161			// If using mod_rewrite or ISAPI_Rewrite strip the script filename
162			// out of the base path. $pos !== 0 makes sure it is not matching a
163			// value from PATH_INFO or QUERY_STRING.
164			if (strlen($requestUri) >= strlen($baseUrl)
165			&& (false !== ($pos = strpos($requestUri, $baseUrl)) && $pos !== 0)
166			) {
167			$baseUrl = substr($requestUri, 0, $pos + strlen($baseUrl));
168			}
169
170			return $baseUrl;
171			}
172			}
173

oscarotero / psr7-middlewares

Push — master ( b2e200...1332b8 )

BasePath::detectBasePath() F

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like