ServerRequestFactory::getHeadersFromGlobals() - Code Metrics - Inspection of "Rename package, add server request infrastructure,..." - yiisoft/yii-runner-web - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#4)

by Evgeniy

created 2021-11-10 19:18 UTC

ServerRequestFactory::getHeadersFromGlobals() B

↳ Parent: ServerRequestFactory

Complexity

Conditions	8
Paths	10

Size

Total Lines	34
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	14
CRAP Score	8.125

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	8
eloc	15
c	2
b	0
f	0
nc	10
nop	0
dl	0
loc	34
ccs	14
cts	16
cp	0.875
crap	8.125
rs	8.4444

<?php

declare(strict_types=1);

namespace Yiisoft\Yii\Runner\Http;

use InvalidArgumentException;
use Psr\Http\Message\ServerRequestFactoryInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Message\StreamFactoryInterface;
use Psr\Http\Message\StreamInterface;
use Psr\Http\Message\UploadedFileFactoryInterface;
use Psr\Http\Message\UriFactoryInterface;
use Psr\Http\Message\UriInterface;
use RuntimeException;

use function array_key_exists;
use function explode;
use function fopen;
use function function_exists;
use function getallheaders;
use function is_array;
use function is_resource;
use function is_string;
use function preg_match;
use function str_replace;
use function strncmp;
use function strtolower;
use function substr;
use function ucwords;

final class ServerRequestFactory
{
    private ServerRequestFactoryInterface $serverRequestFactory;
    private UriFactoryInterface $uriFactory;
    private UploadedFileFactoryInterface $uploadedFileFactory;
    private StreamFactoryInterface $streamFactory;

    public function __construct(
        ServerRequestFactoryInterface $serverRequestFactory,
        UriFactoryInterface $uriFactory,
        UploadedFileFactoryInterface $uploadedFileFactory,
        StreamFactoryInterface $streamFactory
    ) {
        $this->serverRequestFactory = $serverRequestFactory;
        $this->uriFactory = $uriFactory;
        $this->uploadedFileFactory = $uploadedFileFactory;
        $this->streamFactory = $streamFactory;
    }

    public function createFromGlobals(): ServerRequestInterface
    {
        /** @psalm-var array<string, string> $_SERVER */
        return $this->createFromParameters(
            $_SERVER,
            $this->getHeadersFromGlobals(),
            $_COOKIE,
            $_GET,
            $_POST,
            $_FILES,
            fopen('php://input', 'rb') ?: null
        );
    }

    /**
     * @param array $server
     * @param array $headers
     * @param array $cookies
     * @param array $get
     * @param array $post
     * @param array $files
     * @param resource|StreamInterface|string|null $body
     *
     * @psalm-param array<string, string> $server
     * @psalm-param array<string, string|string[]> $headers
     * @psalm-param mixed $body
     *
     * @return ServerRequestInterface
     */
    public function createFromParameters(
        array $server,
        array $headers = [],
        array $cookies = [],
        array $get = [],
        array $post = [],
        array $files = [],
        mixed $body = null
    ): ServerRequestInterface {
        $method = $server['REQUEST_METHOD'] ?? null;

        if ($method === null) {
            throw new RuntimeException('Unable to determine HTTP request method.');
        }

        $uri = $this->getUri($server);
        $request = $this->serverRequestFactory->createServerRequest($method, $uri, $server);

        foreach ($headers as $name => $value) {
            if ($name === 'Host' && $request->hasHeader('Host')) {
                continue;
            }

            $request = $request->withAddedHeader($name, $value);
        }

        $protocol = '1.1';
        if (array_key_exists('SERVER_PROTOCOL', $server) && $server['SERVER_PROTOCOL'] !== '') {
            $protocol = str_replace('HTTP/', '', $server['SERVER_PROTOCOL']);
        }

        $request = $request
            ->withProtocolVersion($protocol)
            ->withQueryParams($get)
            ->withParsedBody($post)
            ->withCookieParams($cookies)
            ->withUploadedFiles($this->getUploadedFilesArray($files))
        ;

        if ($body === null) {
            return $request;
        }

        if ($body instanceof StreamInterface) {
            return $request->withBody($body);
        }

        if (is_string($body)) {
            return $request->withBody($this->streamFactory->createStream($body));
        }

        if (is_resource($body)) {
            return $request->withBody($this->streamFactory->createStreamFromResource($body));
        }

        throw new InvalidArgumentException(
            'Body parameter for "ServerRequestFactory::createFromParameters()"'
            . 'must be instance of StreamInterface, resource or null.',
        );
    }

    /**
     * @psalm-param array<string, string> $server
     */
    private function getUri(array $server): UriInterface
    {
        $uri = $this->uriFactory->createUri();

        if (array_key_exists('HTTPS', $server) && $server['HTTPS'] !== '' && $server['HTTPS'] !== 'off') {
            $uri = $uri->withScheme('https');
        } else {
            $uri = $uri->withScheme('http');
        }

        if (isset($server['HTTP_HOST'])) {
            $uri = preg_match('/^(.+):(\d+)$/', $server['HTTP_HOST'], $matches) === 1
                ? $uri->withHost($matches[1])->withPort((int) $matches[2])
                : $uri->withHost($server['HTTP_HOST'])
            ;
        } elseif (isset($server['SERVER_NAME'])) {
            $uri = $uri->withHost($server['SERVER_NAME']);
        }

        if (isset($server['SERVER_PORT'])) {
            $uri = $uri->withPort((int) $server['SERVER_PORT']);
        }

        if (isset($server['REQUEST_URI'])) {
            $uri = $uri->withPath(explode('?', $server['REQUEST_URI'])[0]);
        }

        if (isset($server['QUERY_STRING'])) {
            $uri = $uri->withQuery($server['QUERY_STRING']);
        }

        return $uri;
    }

    /**
     * @psalm-return array<string, string>
     */
    private function getHeadersFromGlobals(): array
    {
        if (function_exists('getallheaders')) {
            /** @psalm-var array<string, string>|false $headers */
            $headers = getallheaders();
            return $headers === false ? [] : $headers;

        }

        $headers = [];

        /**
         * @var string $name
         * @var string $value
         */
        foreach ($_SERVER as $name => $value) {
            if (strncmp($name, 'REDIRECT_', 9) === 0) {
                $name = substr($name, 9);

                if (array_key_exists($name, $_SERVER)) {
                    continue;
                }
            }

            if (strncmp($name, 'HTTP_', 5) === 0) {
                $headers[$this->normalizeHeaderName(substr($name, 5))] = $value;
                continue;
            }

            if (strncmp($name, 'CONTENT_', 8) === 0) {
                $headers[$this->normalizeHeaderName($name)] = $value;
            }
        }

        return $headers;
    }

    private function normalizeHeaderName(string $name): string
    {
        return str_replace(' ', '-', ucwords(strtolower(str_replace('_', ' ', $name))));
    }

    private function getUploadedFilesArray(array $filesArray): array
    {
        $files = [];

        /** @var array $info */
        foreach ($filesArray as $class => $info) {
            $files[$class] = [];
            $this->populateUploadedFileRecursive(
                $files[$class],
                $info['name'],
                $info['tmp_name'],
                $info['type'],
                $info['size'],
                $info['error'],
            );
        }

        return $files;
    }

    /**
     * Populates uploaded files array from $_FILE data structure recursively.
     *
     * @param array $files Uploaded files array to be populated.
     * @param mixed $names File names provided by PHP.
     * @param mixed $tempNames Temporary file names provided by PHP.
     * @param mixed $types File types provided by PHP.
     * @param mixed $sizes File sizes provided by PHP.
     * @param mixed $errors Uploading issues provided by PHP.
     *
     * @psalm-suppress MixedArgument, ReferenceConstraintViolation
     */
    private function populateUploadedFileRecursive(
        array &$files,
        mixed $names,
        mixed $tempNames,
        mixed $types,
        mixed $sizes,
        mixed $errors
    ): void {
        if (is_array($names)) {
            /** @var array|string $name */
            foreach ($names as $i => $name) {
                $files[$i] = [];
                /** @psalm-suppress MixedArrayAccess */
                $this->populateUploadedFileRecursive(
                    $files[$i],
                    $name,
                    $tempNames[$i],
                    $types[$i],
                    $sizes[$i],
                    $errors[$i],
                );
            }

            return;
        }

        try {
            $stream = $this->streamFactory->createStreamFromFile($tempNames);
        } catch (RuntimeException $e) {
            $stream = $this->streamFactory->createStream();
        }

        $files = $this->uploadedFileFactory->createUploadedFile(
            $stream,
            (int) $sizes,
            (int) $errors,
            $names,
            $types
        );
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Yii\Runner\Http;
6
7		use InvalidArgumentException;
8		use Psr\Http\Message\ServerRequestFactoryInterface;
9		use Psr\Http\Message\ServerRequestInterface;
10		use Psr\Http\Message\StreamFactoryInterface;
11		use Psr\Http\Message\StreamInterface;
12		use Psr\Http\Message\UploadedFileFactoryInterface;
13		use Psr\Http\Message\UriFactoryInterface;
14		use Psr\Http\Message\UriInterface;
15		use RuntimeException;
16
17		use function array_key_exists;
18		use function explode;
19		use function fopen;
20		use function function_exists;
21		use function getallheaders;
22		use function is_array;
23		use function is_resource;
24		use function is_string;
25		use function preg_match;
26		use function str_replace;
27		use function strncmp;
28		use function strtolower;
29		use function substr;
30		use function ucwords;
31
32		final class ServerRequestFactory
33		{
34		private ServerRequestFactoryInterface $serverRequestFactory;
35		private UriFactoryInterface $uriFactory;
36		private UploadedFileFactoryInterface $uploadedFileFactory;
37		private StreamFactoryInterface $streamFactory;
38
39	50	public function __construct(
40		ServerRequestFactoryInterface $serverRequestFactory,
41		UriFactoryInterface $uriFactory,
42		UploadedFileFactoryInterface $uploadedFileFactory,
43		StreamFactoryInterface $streamFactory
44		) {
45	50	$this->serverRequestFactory = $serverRequestFactory;
46	50	$this->uriFactory = $uriFactory;
47	50	$this->uploadedFileFactory = $uploadedFileFactory;
48	50	$this->streamFactory = $streamFactory;
49	50	}
50
51	22	public function createFromGlobals(): ServerRequestInterface
52		{
53		/** @psalm-var array<string, string> $_SERVER */
54	22	return $this->createFromParameters(
55		$_SERVER,
56	22	$this->getHeadersFromGlobals(),
57		$_COOKIE,
58		$_GET,
59		$_POST,
60		$_FILES,
61	22	fopen('php://input', 'rb') ?: null
62		);
63		}
64
65		/**
66		* @param array $server
67		* @param array $headers
68		* @param array $cookies
69		* @param array $get
70		* @param array $post
71		* @param array $files
72		* @param resource\|StreamInterface\|string\|null $body
73		*
74		* @psalm-param array<string, string> $server
75		* @psalm-param array<string, string\|string[]> $headers
76		* @psalm-param mixed $body
77		*
78		* @return ServerRequestInterface
79		*/
80	50	public function createFromParameters(
81		array $server,
82		array $headers = [],
83		array $cookies = [],
84		array $get = [],
85		array $post = [],
86		array $files = [],
87		mixed $body = null
88		): ServerRequestInterface {
89	50	$method = $server['REQUEST_METHOD'] ?? null;
90
91	50	if ($method === null) {
92	1	throw new RuntimeException('Unable to determine HTTP request method.');
93		}
94
95	49	$uri = $this->getUri($server);
96	49	$request = $this->serverRequestFactory->createServerRequest($method, $uri, $server);
97
98	49	foreach ($headers as $name => $value) {
99	13	if ($name === 'Host' && $request->hasHeader('Host')) {
100	13	continue;
101		}
102
103	5	$request = $request->withAddedHeader($name, $value);
104		}
105
106	49	$protocol = '1.1';
107	49	if (array_key_exists('SERVER_PROTOCOL', $server) && $server['SERVER_PROTOCOL'] !== '') {
108	2	$protocol = str_replace('HTTP/', '', $server['SERVER_PROTOCOL']);
109		}
110
111	49	$request = $request
112	49	->withProtocolVersion($protocol)
113	49	->withQueryParams($get)
114	49	->withParsedBody($post)
115	49	->withCookieParams($cookies)
116	49	->withUploadedFiles($this->getUploadedFilesArray($files))
117		;
118
119	49	if ($body === null) {
120	17	return $request;
121		}
122
123	32	if ($body instanceof StreamInterface) {
124	1	return $request->withBody($body);
125		}
126
127	31	if (is_string($body)) {
128	1	return $request->withBody($this->streamFactory->createStream($body));
129		}
130
131	30	if (is_resource($body)) {
132	23	return $request->withBody($this->streamFactory->createStreamFromResource($body));
133		}
134
135	7	throw new InvalidArgumentException(
136		'Body parameter for "ServerRequestFactory::createFromParameters()"'
137	7	. 'must be instance of StreamInterface, resource or null.',
138		);
139		}
140
141		/**
142		* @psalm-param array<string, string> $server
143		*/
144	49	private function getUri(array $server): UriInterface
145		{
146	49	$uri = $this->uriFactory->createUri();
147
148	49	if (array_key_exists('HTTPS', $server) && $server['HTTPS'] !== '' && $server['HTTPS'] !== 'off') {
149	4	$uri = $uri->withScheme('https');
150		} else {
151	45	$uri = $uri->withScheme('http');
152		}
153
154	49	if (isset($server['HTTP_HOST'])) {
155	20	$uri = preg_match('/^(.+):(\d+)$/', $server['HTTP_HOST'], $matches) === 1
156	6	? $uri->withHost($matches[1])->withPort((int) $matches[2])
157	14	: $uri->withHost($server['HTTP_HOST'])
158		;
159	29	} elseif (isset($server['SERVER_NAME'])) {
160	2	$uri = $uri->withHost($server['SERVER_NAME']);
161		}
162
163	49	if (isset($server['SERVER_PORT'])) {
164	2	$uri = $uri->withPort((int) $server['SERVER_PORT']);
165		}
166
167	49	if (isset($server['REQUEST_URI'])) {
168	2	$uri = $uri->withPath(explode('?', $server['REQUEST_URI'])[0]);
169		}
170
171	49	if (isset($server['QUERY_STRING'])) {
172	2	$uri = $uri->withQuery($server['QUERY_STRING']);
173		}
174
175	49	return $uri;
176		}
177
178		/**
179		* @psalm-return array<string, string>
180		*/
181	22	private function getHeadersFromGlobals(): array
182		{
183	22	if (function_exists('getallheaders')) {
184		/** @psalm-var array<string, string>\|false $headers */
185		$headers = getallheaders();
186		return $headers === false ? [] : $headers;
		0 ignored issues – show Bug Best Practice introduced 2021-11-10 19:09 UTC by Report Bug Copy Issue Report The expression `return $headers === false ? array() : $headers` could return the type `true` which is incompatible with the type-hinted return `array`. Consider adding an additional type-check to rule them out. Loading history...
187		}
188
189	22	$headers = [];
190
191		/**
192		* @var string $name
193		* @var string $value
194		*/
195	22	foreach ($_SERVER as $name => $value) {
196	22	if (strncmp($name, 'REDIRECT_', 9) === 0) {
197	5	$name = substr($name, 9);
198
199	5	if (array_key_exists($name, $_SERVER)) {
200	5	continue;
201		}
202		}
203
204	22	if (strncmp($name, 'HTTP_', 5) === 0) {
205	13	$headers[$this->normalizeHeaderName(substr($name, 5))] = $value;
206	13	continue;
207		}
208
209	22	if (strncmp($name, 'CONTENT_', 8) === 0) {
210	5	$headers[$this->normalizeHeaderName($name)] = $value;
211		}
212		}
213
214	22	return $headers;
215		}
216
217	13	private function normalizeHeaderName(string $name): string
218		{
219	13	return str_replace(' ', '-', ucwords(strtolower(str_replace('_', ' ', $name))));
220		}
221
222	49	private function getUploadedFilesArray(array $filesArray): array
223		{
224	49	$files = [];
225
226		/** @var array $info */
227	49	foreach ($filesArray as $class => $info) {
228	6	$files[$class] = [];
229	6	$this->populateUploadedFileRecursive(
230	6	$files[$class],
231	6	$info['name'],
232	6	$info['tmp_name'],
233	6	$info['type'],
234	6	$info['size'],
235	6	$info['error'],
236		);
237		}
238
239	49	return $files;
240		}
241
242		/**
243		* Populates uploaded files array from $_FILE data structure recursively.
244		*
245		* @param array $files Uploaded files array to be populated.
246		* @param mixed $names File names provided by PHP.
247		* @param mixed $tempNames Temporary file names provided by PHP.
248		* @param mixed $types File types provided by PHP.
249		* @param mixed $sizes File sizes provided by PHP.
250		* @param mixed $errors Uploading issues provided by PHP.
251		*
252		* @psalm-suppress MixedArgument, ReferenceConstraintViolation
253		*/
254	6	private function populateUploadedFileRecursive(
255		array &$files,
256		mixed $names,
257		mixed $tempNames,
258		mixed $types,
259		mixed $sizes,
260		mixed $errors
261		): void {
262	6	if (is_array($names)) {
263		/** @var array\|string $name */
264	6	foreach ($names as $i => $name) {
265	6	$files[$i] = [];
266		/** @psalm-suppress MixedArrayAccess */
267	6	$this->populateUploadedFileRecursive(
268	6	$files[$i],
269	6	$name,
270	6	$tempNames[$i],
271	6	$types[$i],
272	6	$sizes[$i],
273	6	$errors[$i],
274		);
275		}
276
277	6	return;
278		}
279
280		try {
281	6	$stream = $this->streamFactory->createStreamFromFile($tempNames);
282	6	} catch (RuntimeException $e) {
283	6	$stream = $this->streamFactory->createStream();
284		}
285
286	6	$files = $this->uploadedFileFactory->createUploadedFile(
287	6	$stream,
288	6	(int) $sizes,
289	6	(int) $errors,
290		$names,
291		$types
292		);
293	6	}
294		}
295

yiisoft / yii-runner-web

Pull Request — master (#4)

ServerRequestFactory::getHeadersFromGlobals() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like