Syscodes\Components\Http\Resources\HttpRequest

Complexity

Total Complexity

44

Size/Duplication

Total Lines	521
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

21 Methods

Rating	Name	Duplication	Size	Complexity
A	getSchemeWithHttpHost()	0	3	1
A	createFromRequest()	0	16	2
A	enabledHttpMethodParameterOverride()	0	3	1
A	getHttpHost()	0	10	5
A	getPort()	0	7	3
A	getDefaultLocale()	0	3	1
A	setFactory()	0	3	1
A	getUser()	0	7	1
A	setLocale()	0	11	2
A	getHost()	0	13	4
A	detectLocale()	0	5	1
A	getLocale()	0	3	2
B	duplicate()	0	44	7
A	__construct()	0	12	1
A	createFromRequestFactory()	0	19	3
A	getPassword()	0	7	1
A	initialize()	0	27	1
A	getHttpMethodParameterOverride()	0	3	1
A	getUserInfo()	0	3	1
A	createFromRequestGlobals()	0	11	3
A	getScheme()	0	3	2

<?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 license@Lenevor.com so we can send you a copy immediately.
 *
 * @package     Lenevor
 * @subpackage  Base
 * @link        https://lenevor.com
 * @copyright   Copyright (c) 2019 - 2023 Alexander Campo <jalexcam@gmail.com>
 * @license     https://opensource.org/licenses/BSD-3-Clause New BSD license or see https://lenevor.com/license or see /license.md
 */

namespace Syscodes\Components\Http\Resources;

use Locale;
use LogicException;
use Syscodes\Components\Http\URI;
use Syscodes\Components\Support\Str;
use Syscodes\Components\Http\Loaders\Files;
use Syscodes\Components\Http\Loaders\Inputs;
use Syscodes\Components\Http\Loaders\Server;
use Syscodes\Components\Http\Loaders\Headers;
use Syscodes\Components\Http\Loaders\Parameters;
use Syscodes\Components\Http\Helpers\RequestClientIP;

/**
 * Allows that HTTP request  loading to initialize the system.
 */
trait HttpRequest
{
	/**
	 * Get the http method parameter.
	 * 
	 * @var bool $httpMethodParameterOverride
	 */
	protected static $httpMethodParameterOverride = false;

	/**
	 * Holds the global active request instance.
	 *
	 * @var bool $requestURI
	 */
	protected static $requestURI;

	/**
	 * Get the custom parameters.
	 * 
	 * @var \Syscodes\Components\Http\Loaders\Parameters $attributes
	 */
	public $attributes;

	/**
	 * The base URL.
	 * 
	 * @var string $baseUrl
	 */
	protected $baseUrl;

	/**
	 * Get the client ip.
	 * 
	 * @var mixed $clientIp
	 */
	protected $clientIp;

	/**
	 * Gets cookies ($_COOKIE).
	 * 
	 * @var \Syscodes\Components\Http\Loaders\Inputs $cookies
	 */
	public $cookies;

	/**
	 * Gets the string with format JSON.
	 * 
	 * @var string|resource|object|null $content
	 */
	protected $content;

	/**
	 * The default Locale this request.
	 * 
	 * @var string $defaultLocale
	 */
	protected $defaultLocale = 'en';
	
	/**
	 * Gets files request ($_FILES).
	 * 
	 * @var \Syscodes\Components\Http\Loaders\Files $files
	 */
	public $files;
	
	/**
	 * Get the headers request ($_SERVER).
	 * 
	 * @var \Syscodes\Components\Http\Loaders\Headers $headers
	 */
	public $headers;

	/**
	 * The current language of the application.
	 * 
	 * @var string $languages
	 */
	protected $languages;
	
	/**
	 * Get the locale.
	 * 
	 * @var string $locale
	 */
	protected $locale;
	
	/** 
	 * The method name.
	 * 
	 * @var string $method
	 */
	protected $method;

	/**
	 * Query string parameters ($_GET).
	 * 
	 * @var \Syscodes\Components\Http\Loaders\Parameters $query
	 */
	public $query;

	/**
	 * Request body parameters ($_POST).
	 * 
	 * @var \Syscodes\Components\Http\Loaders\Parameters $request
	 */
	public $request;

	/**
	 * The detected uri and server variables ($_SERVER).
	 * 
	 * @var \Syscodes\Components\Http\Loaders\Server $server
	 */
	public $server;

	/** 
	 * List of routes uri.
	 *
	 * @var \Syscodes\Components\Http\URI $uri 
	 */
	public $uri;

	/**
	 * Stores the valid locale codes.
	 * 
	 * @var array $validLocales
	 */
	protected $validLocales = [];

	/**
	 * Constructor. Create new the Request class.
	 * 
	 * @param  array  $query
	 * @param  array  $request
	 * @param  array  $attributes
	 * @param  array  $cookies
	 * @param  array  $files
	 * @param  array  $server
	 * @param  string|resource|null $content  
	 * 
	 * @return void
	 */
	public function __construct(
		array $query = [],
		array $request = [],
		array $attributes = [],
		array $cookies = [],
		array $files = [],
		array $server = [],
		$content = null
	) {
		$this->initialize($query, $request, $attributes, $cookies, $files, $server, $content);
		
		$this->detectLocale();
	}

	/**
     * Enables support for the _method request parameter to determine the intended HTTP method.
     * 
     * @return void
     */
    public static function enabledHttpMethodParameterOverride(): void
    {
        self::$httpMethodParameterOverride = true;
    }
	
	/**
	 * Checks whether support for the _method request parameter is enabled.
	 * 
	 * @return bool
	 */
	public static function getHttpMethodParameterOverride(): bool
	{
		return self::$httpMethodParameterOverride;
	}

	/**
	 * Creates an Syscodes request from of the Request class instance.
	 * 
	 * @param  \Syscodes\Components\Http\Request  $request
	 * 
	 * @return static
	 */
	public static function createFromRequest($request): static
	{
		$newRequest = (new static)->duplicate(
			$request->query->all(), $request->request->all(), $request->attributes->all(),
			$request->cookies->all(), $request->files->all(), $request->server->all()
		);
		
		$newRequest->headers->replace($request->headers->all());
		
		$newRequest->content = $request->content;

The property $content is declared protected in Syscodes\Components\Http\Request. Since you implement __get, consider adding a @property or @property-read.

		
		if ($newRequest->isJson()) {

It seems like isJson() must be provided by classes using this trait. How about adding it as abstract method to this trait?

			$newRequest->request = $newRequest->json();

It seems like json() must be provided by classes using this trait. How about adding it as abstract method to this trait?

		}
		
		return $newRequest;
	}

	/**
	 * Creates a new request with value from PHP's super global.
	 * 
	 * @return static
	 */
	public static function createFromRequestGlobals(): static
	{
		$request = static::createFromRequestFactory($_GET, $_POST, [], $_COOKIE, $_FILES, $_SERVER);

		if (Str::startsWith($request->headers->get('CONTENT_TYPE', ''), 'application/x-www-form-urlencoded')
		    && in_array(strtoupper($request->server->get('REQUEST_METHOD', 'GET')), ['PUT', 'DELETE', 'PATCH'])) {
			parse_str($request->getContent(), $data);

It seems like getContent() must be provided by classes using this trait. How about adding it as abstract method to this trait?

			$request->request = new Inputs($data);
		}

		return $request;
	}

	/**
	 * Creates a new request from a factory.
	 * 
	 * @param  array  $query
	 * @param  array  $request
	 * @param  array  $attributes
	 * @param  array  $cookies
	 * @param  array  $files
	 * @param  array  $server
	 * 
	 * @return static
	 */
	private static function createFromRequestFactory(
		array $query = [], 
		array $request = [],
		array $attributes = [] ,
		array $cookies = [], 
		array $files = [], 
		array $server = []
	): static {
		if (self::$requestURI) {
			$request = (self::$requestURI)($query, $request, [], $cookies, $files, $server);

			if ( ! $request instanceof self) {
				throw new LogicException('The Request active must return an instance of Syscodes\Components\Http\Request');
			}

			return $request;
		}

		return new static($query, $request, $attributes, $cookies, $files, $server);
	}

	/**
	 * Returns the factory request currently being used.
	 *
	 * @param  \Syscodes\Components\Http\Request|callable|null  $request  
	 *
	 * @return void
	 */
	public static function setFactory(?callable $request): void
	{
		self::$requestURI = $request;

It seems like $request can also be of type callable. However, the property $requestURI is declared as type boolean. Maybe add an additional type check?

	}

	/**
	 * Sets the parameters for this request.
	 * 
	 * @param  array  $query
	 * @param  array  $request
	 * @param  array  $attributes
	 * @param  array  $cookies
	 * @param  array  $files
	 * @param  array  $server
	 * 
	 * @return void
	 */
	public function initialize(
		array $query = [], 
		array $request = [],
		array $attributes = [],
		array $cookies = [], 
		array $files = [], 
		array $server = [], 
		$content = null
	): void {
		$this->query = new Inputs($query);
		$this->request = new Inputs($request);
		$this->attributes = new Parameters($attributes);
		$this->cookies = new Inputs($cookies);
		$this->files = new Files($files);
		$this->server = new Server($server);
		$this->headers = new Headers($this->server->all());

		// Variables initialized
		$this->uri = new URI;
		$this->method = null;
		$this->baseUrl = null;
		$this->content = $content;
		$this->pathInfo = null;

The property pathInfo does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

		$this->languages = null;
		$this->acceptableContentTypes = null;

The property acceptableContentTypes does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

		$this->validLocales = config('app.supportedLocales');

It seems like config('app.supportedLocales') can also be of type Syscodes\Components\Config\Configure. However, the property $validLocales is declared as type array. Maybe add an additional type check?

		$this->clientIp = new RequestClientIP($this->server->all());
	}

	/**
	 * Clones a request and overrides some of its parameters.
	 * 
	 * @param  array|null  $query
	 * @param  array|null  $request
	 * @param  array|null  $attributes
	 * @param  array|null  $cookies
	 * @param  array|null  $files
	 * @param  array|null  $server
	 * 
	 * @return static
	 */
	public function duplicate(
		array $query = null, 
		array $request = null,
		array $attributes = null,
		array $cookies = null,
		array $files = null,
		array $server = null
	): static {
		$duplicate = clone $this;

		if (null !== $query) {
			$duplicate->query = new Inputs($query);
		}

		if (null !== $request) {
			$duplicate->request = new Inputs($request);
		}

		if (null !== $attributes) {
			$duplicate->attributes = new Parameters($attributes);
		}

		if (null !== $cookies) {
			$duplicate->cookies = new Inputs($cookies);
		}

		if (null !== $files) {
			$duplicate->files = new Files($files);
		}

		if (null !== $server) {
			$duplicate->server  = new Server($server);
			$duplicate->headers = new Headers($duplicate->server->all());
		}

		$duplicate->uri = new URI;
		$duplicate->locale = null;
		$duplicate->method = null;
		$duplicate->baseUrl = null;
		$duplicate->pathInfo = null;

The property pathInfo does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

		$duplicate->validLocales = config('app.supportedLocales');

It seems like config('app.supportedLocales') can also be of type Syscodes\Components\Config\Configure. However, the property $validLocales is declared as type array. Maybe add an additional type check?

		$duplicate->clientIp = new RequestClientIP($duplicate->server->all());

		return $duplicate;		
	}

	/**
	 * Handles setting up the locale, auto-detecting of language.
	 * 
	 * @return void
	 */
	public function detectLocale(): void
	{
		$this->languages = $this->defaultLocale = config('app.locale');

It seems like $this->defaultLocale = config('app.locale') can also be of type Syscodes\Components\Config\Configure. However, the property $languages is declared as type string. Maybe add an additional type check?

It seems like config('app.locale') can also be of type Syscodes\Components\Config\Configure. However, the property $defaultLocale is declared as type string. Maybe add an additional type check?

		$this->setLocale($this->validLocales[0]);
	}

	/**
	 * Returns the default locale as set.
	 * 
	 * @return string
	 */
	public function getDefaultLocale(): string
	{
		return $this->defaultLocale;
	}

	/**
	 * Gets the current locale, with a fallback to the default.
	 * 
	 * @return string 
	 */
	public function getLocale(): string
	{
		return $this->languages ?: $this->defaultLocale;
	}

	/**
	 * Sets the locale string for this request.
	 * 
	 * @param  string  $locale
	 * 
	 * @return static
	 */
	public function setLocale(string $locale): static
	{
		if ( ! in_array($locale, $this->validLocales, true)) {
			$locale = $this->defaultLocale;
		}
		
		$this->languages = $locale;

		Locale::setDefault($locale);
			
		return $this;
	}

	/**
	 * Returns the host name.
	 * 
	 * @return string
	 */
	public function getHost(): string
	{
		if ($forwardedHost = $this->server->get('HTTP_X_FORWARDED_HOST')) {
			$host = $forwardedHost[0];
		} elseif ( ! $host = $this->headers->get('HOST')) {

Are you sure the assignment to $host is correct as $this->headers->get('HOST') targeting Syscodes\Components\Http\Loaders\Headers::get() seems to always return null.

			if ( ! $host = $this->server->get('SERVER_NAME')) {
				$host = $this->server->get('REMOTE_ADDR', '');
			}
		}

		$host = strtolower(preg_replace('/:\d+$/', '', trim(($host))));
		
		return $this->uri->setHost($host);
	}

	/**
	 * Returns the port on which the request is made.
	 * 
	 * @return int
	 */
	public function getPort(): int
	{
		if ( ! $this->server->get('HTTP_HOST')) {
			return $this->server->get('SERVER_PORT');
		}
		
		return 'https' === $this->getScheme() ? $this->uri->setPort(443) : $this->uri->setPort(80);

The expression return 'https' === $this->getScheme() ? $this->uri->setPort(443) : $this->uri->setPort(80) returns the type string which is incompatible with the type-hinted return integer.

	}

	/**
	 * Gets the request's scheme.
	 * 
	 * @return string
	 */
	public function getScheme(): string
	{
		return $this->secure() ? $this->uri->setScheme('https') : $this->uri->setScheme('http');

It seems like secure() must be provided by classes using this trait. How about adding it as abstract method to this trait?

	}

	/**
	 * Get the user.
	 * 
	 * @return string|null
	 */
	public function getUser(): ?string
	{
		$user = $this->uri->setUser(
			$this->headers->get('PHP_AUTH_USER')

Are you sure the usage of $this->headers->get('PHP_AUTH_USER') targeting Syscodes\Components\Http\Loaders\Headers::get() seems to always return null.

		);

		return $user;
	}

	/**
	 * Get the password.
	 * 
	 * @return string|null
	 */
	public function getPassword(): ?string
	{
		$password = $this->uri->setPassword(
			$this->headers->get('PHP_AUTH_PW')

Are you sure the usage of $this->headers->get('PHP_AUTH_PW') targeting Syscodes\Components\Http\Loaders\Headers::get() seems to always return null.

		);

		return $password;
	}

	/**
	 * Gets the user info.
	 * 
	 * @return string|null
	 */
	public function getUserInfo(): ?string
	{
		return $this->uri->getUserInfo();
	}

	/**
	 * Returns the HTTP host being requested.
	 * 
	 * @return string
	 */
	public function getHttpHost(): string
	{
		$scheme = $this->getScheme();
		$port   = $this->getPort();

		if (('http' === $scheme && 80 === $port) || ('https' === $scheme && 443 === $port))	{
			return $this->getHost();
		}

		return $this->getHost().':'.$port;
	}

	/**
	 * Gets the scheme and HTTP host.
	 * 
	 * @return string
	 */
	public function getSchemeWithHttpHost(): string
	{
		return $this->getScheme().'://'.$this->getHttpHost();
	}
}