Yiisoft\Yii\Web\NetworkResolver\BasicNetworkResolver

Complexity

Total Complexity

21

Size/Duplication

Total Lines	97
Duplicated Lines	0 %

Test Coverage

Coverage

71.1%

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getServerRequest()	0	6	3
B	withNewProtocolHeader()	0	19	7
A	withServerRequest()	0	5	1
A	getRemoteIp()	0	7	2
A	getRequestScheme()	0	20	6
A	getUserIp()	0	3	1
A	isSecureConnection()	0	3	1

<?php
declare(strict_types=1);

namespace Yiisoft\Yii\Web\NetworkResolver;

use Psr\Http\Message\ServerRequestInterface;

/**
 * Basic network resolver
 *
 * It can be used in the following cases:
 * - not required IP resolve to access the user's IP
 * - user's IP is already resolved (eg ngx_http_realip_module or similar)
 *
 * @package Yiisoft\Yii\Web\NetworkResolver
 */
class BasicNetworkResolver implements NetworkResolverInterface
{
    protected const SCHEME_HTTPS = 'https';

    /**
     * @var ServerRequestInterface|null
     */
    private $serverRequest;

    private $protocolHeaders = [];

    public function getRemoteIp(): string
    {
        $ip = $this->getServerRequest()->getServerParams()['REMOTE_ADDR'] ?? null;
        if ($ip === null) {
            throw new \RuntimeException('Remote IP is not available!');
        }
        return (string)$ip;
    }

    public function getUserIp(): string
    {
        return $this->getRemoteIp();
    }

    /**
     * User's request scheme
     */
    public function getRequestScheme(): string
    {
        $request = $this->getServerRequest();
        foreach ($this->protocolHeaders as $header => $data) {
            if (!$request->hasHeader($header)) {
                continue;
            }
            $headerValues = $request->getHeader($header);
            if (is_callable($data)) {
                return call_user_func($data, $headerValues, $header, $request);
            }
            $headerValue = strtolower($headerValues[0]);
            foreach ($data as $protocol => $acceptedValues) {
                if (!in_array($headerValue, $acceptedValues)) {
                    continue;
                }
                return $protocol;
            }
        }
        return $request->getUri()->getScheme();
    }

    /**
     * User's connection security
     */
    public function isSecureConnection(): bool
    {
        return $this->getRequestScheme() === self::SCHEME_HTTPS;
    }

    public function withServerRequest(ServerRequestInterface $serverRequest)
    {
        $new = clone $this;
        $new->serverRequest = $serverRequest;
        return $new;
    }

    /**
     * @TODO: documentation
     * @param callable|array $protocolAndAcceptedValues
     * @return static
     */
    public function withNewProtocolHeader(string $header, $protocolAndAcceptedValues)
    {
        $new = clone $this;
        if (is_callable($protocolAndAcceptedValues)) {
            $new->protocolHeaders[$header] = $protocolAndAcceptedValues;
        } elseif (!is_array($protocolAndAcceptedValues)) {
            throw new \RuntimeException('$protocolAndAcceptedValues is not array nor callable!');
        } elseif (is_array($protocolAndAcceptedValues) && count($protocolAndAcceptedValues) === 0) {
            throw new \RuntimeException('$protocolAndAcceptedValues cannot be an empty array!');
        } else {
            $new->protocolHeaders[$header] = [];
            foreach ($protocolAndAcceptedValues as $protocol => $acceptedValues) {
                if (!is_string($protocol)) {
                    throw new \RuntimeException('The protocol must be type of string!');
                }
                $new->protocolHeaders[$header][$protocol] = array_map('strtolower', (array)$acceptedValues);
            }
        }
        return $new;
    }

    protected function getServerRequest(bool $throwIfNull = true): ?ServerRequestInterface
    {
        if ($this->serverRequest === null && $throwIfNull) {
            throw new \RuntimeException('The server request object is not set!');
        }
        return $this->serverRequest;
    }
}