Http::parseBaseUrl() - Code Metrics - lenevor/syscodes - Measure and Improve Code Quality continuously with Scrutinizer

Http::parseBaseUrl() C
last analyzed 2021-03-26 23:28 UTC

↳ Parent: Http
Complexity

Conditions	14
Paths	24
Size

Total Lines	48
Code Lines	29
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	14
eloc	29
c	1
b	0
f	0
nc	24
nop	0
dl	0
loc	48
rs	6.2666
How to fix Complexity

<?php 

/**
 * Lenevor Framework
 *
 * LICENSE
 *
 * This source file is subject to the new BSD license that is bundled
 * with this package in the file license.md.
 * It is also available through the world-wide-web at this URL:
 * https://lenevor.com/license
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to [email protected] so we can send you a copy immediately.
 *
 * @package     Lenevor
 * @subpackage  Base
 * @link        https://lenevor.com
 * @copyright   Copyright (c) 2019 - 2021 Alexander Campo <[email protected]>
 * @license     https://opensource.org/licenses/BSD-3-Clause New BSD license or see https://lenevor.com/license or see /license.md
 */

namespace Syscodes\Http;

use Syscodes\Collections\Arr;

/**
 * Returns the HTTP requests is filtered and detected in the routes set by the user.
 * 
 * @author Alexander Campo <[email protected]>
 */
class Http
{
	/**
	 * Return's the protocol that the request was made with.
	 *
	 * @return string
	 */
	public function protocol()
	{
		if ($this->server('HTTPS') == 'on' ||
			$this->server('HTTPS') == 1 ||
			$this->server('SERVER_PORT') == 443 ||
			(config('security.allow-x-headers', false) && $this->server('HTTP_X_FORWARDED_PROTO') == 'https') ||
			(config('security.allow-x-headers', false) && $this->server('HTTP_X_FORWARDED_PORT') == 443))
		{
			return 'https';
		}

		return 'http';
	}

	/**
	 * Fetch an item from the COOKIE array.
	 *
	 * @param  string  $index  The index key
	 * @param  mixed  $default  The default value
	 *
	 * @return string|array
	 */
	public function cookie($index = null, $default = null)
	{
		return (func_num_args() === 0) ? $_COOKIE : Arr::get($_COOKIE, strtoupper($index), $default);
		return (func_num_args() === 0) ? $_COOKIE : Arr::get($_COOKIE, strtoupper(/** @scrutinizer ignore-type */ $index), $default);
	}

	/**
	 * Fetch an item from the FILE array.
	 *
	 * @param  string  $index  The index key
	 * @param  mixed  $default  The default value
	 *
	 * @return string|array
	 */
	public function file($index = null, $default = null)
	{
		return (func_num_args() === 0) ? $_FILES : Arr::get($_FILES, strtoupper($index), $default);
		return (func_num_args() === 0) ? $_FILES : Arr::get($_FILES, strtoupper(/** @scrutinizer ignore-type */ $index), $default);
	}

	/**
	 * Fetch an item from the SERVER array.
	 *
	 * @param  string  $index  The index key
	 * @param  mixed  $default  The default value
	 *
	 * @return string|array
	 */
	public function server($index = null, $default = null)
	{
		return (func_num_args() === 0) ? $_SERVER : Arr::get($_SERVER, strtoupper($index), $default);
		return (func_num_args() === 0) ? $_SERVER : Arr::get($_SERVER, strtoupper(/** @scrutinizer ignore-type */ $index), $default);
	}
	
	/**
	 * Gets the URI Protocol based setting, will attempt to detect the path 
	 * portion of the current URI.
	 * 
	 * @param  string  $protocol
	 * 
	 * @return string
	 */
	public function detectPath(string $protocol = '') 
	{
		if (empty($protocol)) {
			$protocol = 'REQUEST_URI';
		}

		switch($protocol) {
			case 'REQUEST_URI':
				$path = $this->parseRequestUri();
				break;
			case 'QUERY_STRING':
				$path = $this->parseQueryString();
				break;
			case 'PATH_INFO':
			default:
				$path = $this->server($protocol) ?? $this->parseRequestUri();
				break;
		}

		return $path;

	}

	/**
	 * Filters a value from the start of a string in this case the passed URI string.
	 *
	 * @return string
	 */
	protected function parseRequestUri()
	{
		if ( ! isset($_SERVER['REQUEST_URI'], $_SERVER['SCRIPT_NAME'])) {
			return '';
		}

		$requestURI = $this->server('REQUEST_URI') ?? '/';
		$components = parse_url($requestURI);
		$components = parse_url(/** @scrutinizer ignore-type */ $requestURI);
		$query      = $components['query'] ?? '';
		$uri        = $components['path'] ?? '';

		// If the search value is at the start
		if (isset($this->server('SCRIPT_NAME')[0])) {
			if (0 === strpos($uri, $this->server('SCRIPT_NAME'))) {
			if (0 === strpos($uri, /** @scrutinizer ignore-type */ $this->server('SCRIPT_NAME'))) {
				$uri = (string) substr($uri, strlen($this->server('SCRIPT_NAME')));
				$uri = (string) substr($uri, strlen(/** @scrutinizer ignore-type */ $this->server('SCRIPT_NAME')));
			} elseif (0 < strpos($uri, $this->server('SCRIPT_NAME'))) {
				$uri = (string) substr($uri, strpos($uri, $this->server('SCRIPT_NAME')) + strlen($this->server('SCRIPT_NAME')));
			} elseif (0 === strpos($uri, dirname($this->server('SCRIPT_NAME')))) {
			} elseif (0 === strpos($uri, dirname(/** @scrutinizer ignore-type */ $this->server('SCRIPT_NAME')))) {
				$uri = (string) substr($uri, strlen(dirname($this->server('SCRIPT_NAME'))));
			}
		}

		// This section ensures that even on servers that require the URI to contain 
		// the query string (Nginx) is the correctly
		if ('' === trim($uri, '/') && 0 === strncmp($query, '/', 1)) {
			$query					 = explode('?', $query, 2);
			$uri  					 = $query[0];
			$_SERVER['QUERY_STRING'] = $query[1] ?? '';
		} else {
			$_SERVER['QUERY_STRING'] = $query;
		}

		// Parses the string into variables
		parse_str($_SERVER['QUERY_STRING'], $_GET);

		if ('/' === $uri || '' === $uri) {
			return '';
		}

		return $this->filterDecode($uri);
	}

	/**
	 * Will parse QUERY_STRING and automatically detect the URI from it.
	 * 
	 * @return string
	 */
	protected function parseQueryString()
	{
		$uri = $_SERVER['QUERY_STRING'] ?? @getenv('QUERY_STRING');

		if (trim($uri, '/') === '') {
			return '';
		} elseif (0 === strncmp($uri, '/', 1)) {
			$uri    				 = explode('?', $uri, 2);
			$_SERVER['QUERY_STRING'] = $uri[1] ?? '';
			$uri    				 = $uri[0] ?? '';
		}

		parse_str($_SERVER['QUERY_STRING'], $_GET);

		return $this->filterDecode($uri);
	}

	/**
	 * Filters the uri string remove any malicious characters and inappropriate slashes.
	 *
	 * @param  string  $uri
	 *
	 * @return string
	 */
	protected function filterDecode($uri)
	{
		// Remove all characters except letters,
		// digits and $-_.+!*'(),{}|\\^~[]`<>#%";/?:@&=.
		$uri = filter_var(rawurldecode($uri), FILTER_SANITIZE_URL);
		
		// Return argument if not empty or return a single slash
		return trim($uri, '/') ?: '/';
	}
	
	/**
	 * Parse the base URL.
	 * 
	 * @return string
	 */
	public function parseBaseUrl() 
	{
		$filename = basename($this->server('SCRIPT_FILENAME'));
		$filename = basename(/** @scrutinizer ignore-type */ $this->server('SCRIPT_FILENAME'));
		
		if ($filename === basename($this->server('SCRIPT_NAME'))) {
			$baseUrl = $this->server('SCRIPT_NAME');
		} elseif ($filename === basename($this->server('PHP_SELF'))) {
			$baseUrl = $this->server('PHP_SELF');
		} elseif ($filename === basename($this->server('ORIG_SCRIPT_NAME'))) {
			$baseUrl = $this->server('ORIG_SCRIPT_NAME');
		} else {
			$path    = $this->server('PHP_SELF', '');
			$file    = $this->server('SCRIPT_FILENAME', '');
			$segs    = explode('/', trim($file, '/'));
			$segs    = explode('/', trim(/** @scrutinizer ignore-type */ $file, '/'));
			$segs    = array_reverse($segs);
			$index   = 0;
			$last    = count($segs);
			$baseUrl = '';
			
			do 	{
				$seg     = $segs[$index];
				$baseUrl = '/'.$seg.$baseUrl;
				++$index;
			} while ($last > $index && (false !== $pos = strpos($path, $baseUrl)) && 0 != $pos);
			} while ($last > $index && (false !== $pos = strpos(/** @scrutinizer ignore-type */ $path, $baseUrl)) && 0 != $pos);
		}

		// Does the baseUrl have anything in common with the request_uri?
		$requestUri = $this->parseRequestUri();

		if ('' !== $requestUri && '/' !== $requestUri[0]) {
			$requestUri = '/'.$requestUri;
		}

		$baseUrl = dirname($baseUrl);
		$baseUrl = dirname(/** @scrutinizer ignore-type */ $baseUrl);

		if (empty($baseUrl) || false !== strpos(rawurldecode($requestUri), $baseUrl)) {
			// no match whatsoever; set it blank
			return '';
		}
		
		// If using mod_rewrite or ISAPI_Rewrite strip the script filename
		// out of baseUrl. $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)) && 0 !== $pos) {
			$baseUrl = substr($requestUri, 0, $pos + strlen($baseUrl));
		}
		
		return rtrim($baseUrl, '/'.DIRECTORY_SEPARATOR);
	}

	/**
	 * Parse the path info.
	 * 
	 * @return string
	 */
	public function parsePathInfo()
	{
		if (null === ($requestUri = $this->parseRequestUri())) {

			return '/';
		}

		// Remove the query string from REQUEST_URI
		if (false !== $pos = strpos($requestUri, '?')) {
			$requestUri = substr($requestUri, 0, $pos);
		}

		if ('' !== $requestUri && '/' !== $requestUri[0]) {
			$requestUri = '/'.$requestUri;
		}

		if (null === ($baseUrl = $this->parseBaseUrl())) {

			return $requestUri;
		}

		$pathInfo = substr($requestUri, strlen($baseUrl));

		if (false === $pathInfo && '' === $pathInfo) {
			return '/';
		}
		
		return (string) $pathInfo;
	}
}
lenevor / syscodes

Http::parseBaseUrl() C last analyzed 2021-03-26 23:28 UTC

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like

Http::parseBaseUrl() C
last analyzed 2021-03-26 23:28 UTC
