#27778

pending completion

Build # #27778

Build Type

push

github

Committed by

web-flow

Commit Message

<a href="https://github.com/api-platform/core/commit/<a class=hub.com/api-platform/core/commit/834616aa40a9ff64a09105f97f3cc25a84ed18f4">834616aa4<a href="https://github.com/api-platform/core/commit/834616aa40a9ff64a09105f97f3cc25a84ed18f4">">Merge </a><a class="double-link" href="https://github.com/api-platform/core/commit/<a class="double-link" href="https://github.com/api-platform/core/commit/9b6026810876caa2b224d356cdc3c29483842e99">9b6026810</a>">9b6026810</a><a href="https://github.com/api-platform/core/commit/834616aa40a9ff64a09105f97f3cc25a84ed18f4"> into b97799b8f">b97799b8f</a>

Run Details

4 of 4 new or added lines in 2 files covered. (100.0%)

9759 of 11680 relevant lines covered (83.55%)

14.77 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

87.5

/src/Util/RequestParser.php

<?php

/*
 * This file is part of the API Platform project.
 *
 * (c) Kévin Dunglas <dunglas@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace ApiPlatform\Core\Util;

use Symfony\Component\HttpFoundation\Request;

/**
 * Utility functions for working with Symfony's HttpFoundation request.
 *
 * @internal
 *
 * @author Teoh Han Hui <teohhanhui@gmail.com>
 * @author Vincent Chalamon <vincentchalamon@gmail.com>
 */
final class RequestParser
{
    private function __construct()
    {
    }

    /**
     * Gets a fixed request.
     */
    public static function parseAndDuplicateRequest(Request $request): Request
    {
        $query = self::parseRequestParams(self::getQueryString($request) ?? '');
        $body = self::parseRequestParams($request->getContent());

        return $request->duplicate($query, $body);
    }

    /**
     * Parses request parameters from the specified source.
     *
     * @author Rok Kralj
     *
     * @see https://stackoverflow.com/a/18209799/1529493
     */
    public static function parseRequestParams(string $source): array
    {
        // '[' is urlencoded ('%5B') in the input, but we must urldecode it in order
        // to find it when replacing names with the regexp below.
        $source = str_replace('%5B', '[', $source);

        $source = preg_replace_callback(
            '/(^|(?<=&))[^=[&]+/',
            static function ($key) {
                return bin2hex(urldecode($key[0]));
            },
            $source
        );

        // parse_str urldecodes both keys and values in resulting array.
        parse_str($source, $params);

        return array_combine(array_map('hex2bin', array_keys($params)), $params);
    }

    /**
     * Generates the normalized query string for the Request.
     *
     * It builds a normalized query string, where keys/value pairs are alphabetized
     * and have consistent escaping.
     */
    public static function getQueryString(Request $request): ?string
    {
        $qs = $request->server->get('QUERY_STRING', '');
        if ('' === $qs) {
            return null;
        }

        $parts = [];

        foreach (explode('&', $qs) as $param) {
            if ('' === $param || '=' === $param[0]) {
                // Ignore useless delimiters, e.g. "x=y&".
                // Also ignore pairs with empty key, even if there was a value, e.g. "=value", as such nameless values cannot be retrieved anyway.
                // PHP also does not include them when building _GET.
                continue;
            }

            $keyValuePair = explode('=', $param, 2);

            // GET parameters, that are submitted from a HTML form, encode spaces as "+" by default (as defined in enctype application/x-www-form-urlencoded).
            // PHP also converts "+" to spaces when filling the global _GET or when using the function parse_str. This is why we use urldecode and then normalize to
            // RFC 3986 with rawurlencode.
            $parts[] = isset($keyValuePair[1]) ?
                rawurlencode(urldecode($keyValuePair[0])).'='.rawurlencode(urldecode($keyValuePair[1])) :
                rawurlencode(urldecode($keyValuePair[0]));
        }

        return implode('&', $parts);
    }
}

1	<?php
2
3	/*
4	* This file is part of the API Platform project.
5	*
6	* (c) Kévin Dunglas <dunglas@gmail.com>
7	*
8	* For the full copyright and license information, please view the LICENSE
9	* file that was distributed with this source code.
10	*/
11
12	declare(strict_types=1);
13
14	namespace ApiPlatform\Core\Util;
15
16	use Symfony\Component\HttpFoundation\Request;
17
18	/**
19	* Utility functions for working with Symfony's HttpFoundation request.
20	*
21	* @internal
22	*
23	* @author Teoh Han Hui <teohhanhui@gmail.com>
24	* @author Vincent Chalamon <vincentchalamon@gmail.com>
25	*/
26	final class RequestParser
27	{
28	private function __construct()
29	{
30	}	×
31
32	/**
33	* Gets a fixed request.
34	*/
35	public static function parseAndDuplicateRequest(Request $request): Request
36	{
37	$query = self::parseRequestParams(self::getQueryString($request) ?? '');	1✔
38	$body = self::parseRequestParams($request->getContent());	1✔
39
40	return $request->duplicate($query, $body);	1✔
41	}
42
43	/**
44	* Parses request parameters from the specified source.
45	*
46	* @author Rok Kralj
47	*
48	* @see https://stackoverflow.com/a/18209799/1529493
49	*/
50	public static function parseRequestParams(string $source): array
51	{
52	// '[' is urlencoded ('%5B') in the input, but we must urldecode it in order
53	// to find it when replacing names with the regexp below.
54	$source = str_replace('%5B', '[', $source);	21✔
55
56	$source = preg_replace_callback(	21✔
57	'/(^\|(?<=&))[^=[&]+/',	21✔
58	static function ($key) {	21✔
59	return bin2hex(urldecode($key[0]));	21✔
60	},	21✔
61	$source
62	);
63
64	// parse_str urldecodes both keys and values in resulting array.
65	parse_str($source, $params);	21✔
66
67	return array_combine(array_map('hex2bin', array_keys($params)), $params);	21✔
68	}
69
70	/**
71	* Generates the normalized query string for the Request.
72	*
73	* It builds a normalized query string, where keys/value pairs are alphabetized
74	* and have consistent escaping.
75	*/
76	public static function getQueryString(Request $request): ?string
77	{
78	$qs = $request->server->get('QUERY_STRING', '');	24✔
79	if ('' === $qs) {	24✔
80	return null;	22✔
81	}
82
83	$parts = [];	2✔
84
85	foreach (explode('&', $qs) as $param) {	2✔
86	if ('' === $param \|\| '=' === $param[0]) {	2✔
87	// Ignore useless delimiters, e.g. "x=y&".
88	// Also ignore pairs with empty key, even if there was a value, e.g. "=value", as such nameless values cannot be retrieved anyway.
89	// PHP also does not include them when building _GET.
90	continue;	×
91	}
92
93	$keyValuePair = explode('=', $param, 2);	2✔
94
95	// GET parameters, that are submitted from a HTML form, encode spaces as "+" by default (as defined in enctype application/x-www-form-urlencoded).
96	// PHP also converts "+" to spaces when filling the global _GET or when using the function parse_str. This is why we use urldecode and then normalize to
97	// RFC 3986 with rawurlencode.
98	$parts[] = isset($keyValuePair[1]) ?	2✔
99	rawurlencode(urldecode($keyValuePair[0])).'='.rawurlencode(urldecode($keyValuePair[1])) :	2✔
100	rawurlencode(urldecode($keyValuePair[0]));	×
101	}
102
103	return implode('&', $parts);	2✔
104	}
105	}

api-platform / core / #27778

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous