Yiisoft\Yii\Web\NetworkResolver\BasicNetworkResolver

Complexity

Total Complexity

14

Size/Duplication

Total Lines	70
Duplicated Lines	0 %

Test Coverage

Coverage

63.33%

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getServerRequest()	0	6	3
A	withServerRequest()	0	5	1
A	getRemoteIp()	0	7	2
A	getRequestScheme()	0	10	4
A	withNewSecureProtocolHeader()	0	8	2
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;

class BasicNetworkResolver implements NetworkResolverInterface
{
    protected const SCHEME_HTTPS = 'https';

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

    private $secureProtocolHeaders = [];

    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();
    }

    public function getRequestScheme(): string
    {
        $request = $this->getServerRequest();
        foreach ($this->secureProtocolHeaders as $header => $values) {
            if (!$request->hasHeader($header) || !in_array(strtolower($request->getHeader($header)[0]), $values)) {
                continue;
            }
            return self::SCHEME_HTTPS;
        }
        return $request->getUri()->getScheme();
    }

    public function isSecureConnection(): bool
    {
        return $this->getRequestScheme() === self::SCHEME_HTTPS;
    }

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

    /**
     * @TODO: currently https only, callback, http
     * @return static
     */
    public function withNewSecureProtocolHeader(string $header, array $valuesOfSecureProtocol)
    {
        $new = clone $this;
        if (count($valuesOfSecureProtocol) === 0) {
            throw new \RuntimeException('$valuesOfSecureProtocol cannot be an empty array!');
        }
        $new->secureProtocolHeaders[$header] = array_map('strtolower', $valuesOfSecureProtocol);
        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;
    }
}