HttpProcessUtility::readQuotedParameterValue() - Code Metrics - Inspection of "Cleanup HttpProcessUtility" - Algo-Web/POData - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#261)

by Christopher

created 2020-05-09 09:16 UTC

HttpProcessUtility::readQuotedParameterValue() C

↳ Parent: HttpProcessUtility

Complexity

Conditions	12
Paths	51

Size

Total Lines	61
Code Lines	33

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	12
eloc	33
nc	51
nop	3
dl	0
loc	61
rs	6.9666
c	2
b	0
f	0

How to fix Long Method Complexity

<?php

declare(strict_types=1);

namespace POData;

use POData\Common\HttpHeaderFailure;
use POData\Common\Messages;
use POData\Providers\Metadata\Type\Char;
filter:
    dependency_paths: ["lib/*"]

/**
 * Class HttpProcessUtility.
 */
class HttpProcessUtility
{
    /**
     * Gets the appropriate MIME type for the request, throwing if there is none.
     *
     * @param string   $acceptTypesText    Text as it appears in an HTTP
     *                                     Accepts header
     * @param string[] $exactContentTypes  Preferred content type to match if an exact media type is given - this is in
     *                                     descending order of preference
     * @param string   $inexactContentType Preferred fallback content type for inexact matches
     *
     * @throws HttpHeaderFailure
     * @return string|null       One of exactContentType or inexactContentType
     */
    public static function selectRequiredMimeType(
        ?string $acceptTypesText,
        array $exactContentTypes,
        $inexactContentType
    ): ?string {
        $selectedContentType   = null;
        $selectedMatchingParts = -1;
        $selectedQualityValue  = 0;

        if (null === $acceptTypesText) {
            throw new HttpHeaderFailure(Messages::unsupportedMediaType(), 415);
        }

        $acceptTypes = self::mimeTypesFromAcceptHeaders($acceptTypesText);
        foreach ($acceptTypes as $acceptType) {
            foreach ($exactContentTypes as $exactContentType) {
                if (0 == strcasecmp($acceptType->getMimeType(), $exactContentType)) {
                    $selectedContentType  = $exactContentType;
                    $selectedQualityValue = $acceptType->getQualityValue();
                    break 2;
                }
            }

            $matchingParts = $acceptType->getMatchingRating($inexactContentType);
            if ($matchingParts < 0) {
                continue;
            }

            $candidateQualityValue = $acceptType->getQualityValue();
            // A more specific type wins.
            if ($matchingParts > $selectedMatchingParts ||
                (
                    $matchingParts == $selectedMatchingParts &&
                    // A type with a higher q-value wins.
                    $candidateQualityValue > $selectedQualityValue
                )) {
                $selectedContentType = $inexactContentType;
                $selectedMatchingParts = $matchingParts;
                $selectedQualityValue = $candidateQualityValue;
            }
        }

        if ((null === $selectedContentType || 0 == $selectedQualityValue) &&
            !empty($acceptTypes)) {
            throw new HttpHeaderFailure(Messages::unsupportedMediaType(), 415);
        }

        return empty($acceptTypes) ? $inexactContentType : $selectedContentType;
    }

    /**
     * Returns all MIME types from the $text.
     *
     * @param string $text Text as it appears on an HTTP Accepts header
     *
     * @throws HttpHeaderFailure If found any syntax error in the given text
     * @return MediaType[]       Array of media (MIME) type description
     */
    public static function mimeTypesFromAcceptHeaders(string $text): array
    {
        $mediaTypes = [];
        $textIndex  = 0;
        while (!self::skipWhiteSpace($text, $textIndex)) {
            $type    = null;
            $subType = null;
            self::readMediaTypeAndSubtype($text, $textIndex, $type, $subType);

            $parameters = [];
            while (!self::skipWhitespace($text, $textIndex)) {
                if (',' == $text[$textIndex]) {
                    ++$textIndex;
                    break;
                }

                if (';' != $text[$textIndex]) {
                    throw new HttpHeaderFailure(
                        Messages::httpProcessUtilityMediaTypeRequiresSemicolonBeforeParameter(),
                        400
                    );
                }

                ++$textIndex;
                if (self::skipWhiteSpace($text, $textIndex)) {
                    break;
                }

                self::readMediaTypeParameter($text, $textIndex, $parameters);
            }

            $mediaTypes[] = new MediaType($type, $subType, $parameters);
        }

        return $mediaTypes;
    }

    /**
     * Skips whitespace in the specified text by advancing an index to
     * the next non-whitespace character.
     *
     * @param string $text       Text to scan
     * @param int    &$textIndex Index to begin scanning from
     *
     * @return bool true if the end of the string was reached, false otherwise
     */
    public static function skipWhiteSpace(string $text, int &$textIndex): bool
    {
        $textLen = strlen(strval($text));
        while (($textIndex < $textLen) && Char::isWhiteSpace($text[$textIndex])) {
            ++$textIndex;
        }

        return $textLen == $textIndex;
    }

    /**
     * Reads the type and subtype specifications for a MIME type.
     *
     * @param string $text       Text in which specification exists
     * @param int    &$textIndex Pointer into text
     * @param string &$type      Type of media found
     * @param string &$subType   Subtype of media found
     *
     * @throws HttpHeaderFailure If failed to read type and sub-type
     */
    public static function readMediaTypeAndSubtype(
        string $text,
        int &$textIndex,
        &$type,
        &$subType
    ): void {
        $textStart = $textIndex;
        if (self::readToken($text, $textIndex)) {
            throw new HttpHeaderFailure(
                Messages::httpProcessUtilityMediaTypeUnspecified(),
                400
            );
        }

        if ('/' != $text[$textIndex]) {
            throw new HttpHeaderFailure(
                Messages::httpProcessUtilityMediaTypeRequiresSlash(),
                400
            );
        }

        $type = substr($text, $textStart, $textIndex - $textStart);
        ++$textIndex;

        $subTypeStart = $textIndex;
        self::readToken($text, $textIndex);
        if ($textIndex == $subTypeStart) {
            throw new HttpHeaderFailure(
                Messages::httpProcessUtilityMediaTypeRequiresSubType(),
                400
            );
        }

        $subType = substr($text, $subTypeStart, $textIndex - $subTypeStart);
    }

    /**
     * Reads a token on the specified text by advancing an index on it.
     *
     * @param string $text       Text to read token from
     * @param int    &$textIndex Index for the position being scanned on text
     *
     * @return bool true if the end of the text was reached; false otherwise
     */
    public static function readToken(string $text, int &$textIndex): bool
    {
        $textLen = strlen($text);
        while (($textIndex < $textLen) && self::isHttpTokenChar($text[$textIndex])) {
            ++$textIndex;
        }

        return $textLen == $textIndex;
    }

    /**
     * To check whether the given character is a HTTP token character
     * or not.
     *
     * @param string $char The character to inspect
     *
     * @return bool True if the given character is a valid HTTP token
     *              character, False otherwise
     */
    public static function isHttpTokenChar(string $char): bool
    {
        return 126 > ord($char) && 31 < ord($char) && !self::isHttpSeparator($char);
    }

    /**
     * To check whether the given character is a HTTP separator character.
     *
     * @param string $char The character to inspect
     *
     * @return bool True if the given character is a valid HTTP separator
     *              character, False otherwise
     */
    public static function isHttpSeparator(string $char): bool
    {
        $httpSeperators = ['(', ')', '<', '>', '@', ',', ';', ':', '\\', '"', '/', '[', ']', '?', '=', '{', '}', ' '];
        return in_array($char, $httpSeperators) || ord($char) == Char::TAB;
    }

    /**
     * Read a parameter for a media type/range.
     *
     * @param string $text        Text to read from
     * @param int    &$textIndex  Pointer in text
     * @param array  &$parameters Array with parameters
     *
     * @throws HttpHeaderFailure If found parameter value missing
     */
    public static function readMediaTypeParameter(string $text, int &$textIndex, array &$parameters)
    {
        $textStart = $textIndex;
        if (self::readToken($text, $textIndex)) {
            throw new HttpHeaderFailure(
                Messages::httpProcessUtilityMediaTypeMissingValue(),
                400
            );
        }

        $parameterName = substr($text, $textStart, $textIndex - $textStart);
        if ('=' != $text[$textIndex]) {
            throw new HttpHeaderFailure(
                Messages::httpProcessUtilityMediaTypeMissingValue(),
                400
            );
        }

        ++$textIndex;
        $parameterValue
                      = self::readQuotedParameterValue($parameterName, $text, $textIndex);
        $parameters[] = [$parameterName => $parameterValue];
    }

    /**
     * Reads Mime type parameter value for a particular parameter in the
     * Content-Type/Accept headers.
     *
     * @param string $parameterName Name of parameter
     * @param string $text          Header text
     * @param int    &$textIndex    Parsing index in $text
     *
     * @throws HttpHeaderFailure
     * @return string            String representing the value of the $parameterName parameter
     */
    public static function readQuotedParameterValue(
        string $parameterName,
        string $text,
        int &$textIndex
    ): ?string {
        $parameterValue = [];
        $textLen        = strlen($text);
        $valueIsQuoted  = false;
        if ($textIndex < $textLen) {
            if ('"' == $text[$textIndex]) {
                ++$textIndex;
                $valueIsQuoted = true;
            }
        }

        while ($textIndex < $textLen) {
            $currentChar = $text[$textIndex];

            if ('\\' == $currentChar || '"' == $currentChar) {
                if (!$valueIsQuoted) {
                    throw new HttpHeaderFailure(
                        Messages::httpProcessUtilityEscapeCharWithoutQuotes(
                            $parameterName
                        ),
                        400
                    );
                }

                ++$textIndex;

                // End of quoted parameter value.
                if ('"' == $currentChar) {
                    $valueIsQuoted = false;
                    break;
                }

                if ($textIndex >= $textLen) {
                    throw new HttpHeaderFailure(
                        Messages::httpProcessUtilityEscapeCharAtEnd($parameterName),
                        400
                    );
                }

                $currentChar = $text[$textIndex];
            } elseif (!self::isHttpTokenChar($currentChar)) {
                // If the given character is special, we stop processing.
                break;
            }

            $parameterValue[] = $currentChar;
            ++$textIndex;
        }

        if ($valueIsQuoted) {
            throw new HttpHeaderFailure(
                Messages::httpProcessUtilityClosingQuoteNotFound($parameterName),
                400
            );
        }

        return empty($parameterValue) ? null : implode('', $parameterValue);
    }

    /**
     * Selects an acceptable MIME type that satisfies the Accepts header.
     *
     * @param string   $acceptTypesText Text for Accepts header
     * @param string[] $availableTypes  Types that the server is willing to return, in descending order of preference
     *
     * @throws HttpHeaderFailure
     * @return string|null       The best MIME type for the client
     */
    public static function selectMimeType(string $acceptTypesText, array $availableTypes): ?string
    {
        $selectedContentType     = null;
        $selectedMatchingParts   = -1;
        $selectedQualityValue    = 0;
        $selectedPreferenceIndex = PHP_INT_MAX;
        $acceptable              = false;
        $acceptTypesEmpty        = true;

        $acceptTypes  = self::mimeTypesFromAcceptHeaders($acceptTypesText);
        $numAvailable = count($availableTypes);
        foreach ($acceptTypes as $acceptType) {
            $acceptTypesEmpty = false;
            for ($i = 0; $i < $numAvailable; ++$i) {
                $availableType = $availableTypes[$i];
                $matchRating   = $acceptType->getMatchingRating($availableType);
                if (0 > $matchRating) {
                    continue;
                }

                $candidateQualityValue = $acceptType->getQualityValue();
                if ($matchRating > $selectedMatchingParts) {
                    // A more specific type wins.
                    $selectedContentType     = $availableType;
                    $selectedMatchingParts   = $matchRating;
                    $selectedQualityValue    = $candidateQualityValue;
                    $selectedPreferenceIndex = $i;
                    $acceptable              = 0 != $selectedQualityValue;
                } elseif ($matchRating == $selectedMatchingParts) {
                    // A type with a higher q-value wins.
                    if ($candidateQualityValue > $selectedQualityValue) {
                        $selectedContentType     = $availableType;
                        $selectedQualityValue    = $candidateQualityValue;
                        $selectedPreferenceIndex = $i;
                        $acceptable              = 0 != $selectedQualityValue;
                    } elseif ($candidateQualityValue == $selectedQualityValue) {
                        // A type that is earlier in the availableTypes array wins.
                        if ($i < $selectedPreferenceIndex) {
                            $selectedContentType     = $availableType;
                            $selectedPreferenceIndex = $i;
                        }
                    }
                }
            }
        }

        if ($acceptTypesEmpty) {
            $selectedContentType = $availableTypes[0];
        } elseif (!$acceptable) {

            $selectedContentType = null;
        }

        return $selectedContentType;
    }

    /**
     * Reads the numeric part of a quality value substring, normalizing it to 0-1000.
     * rather than the standard 0.000-1.000 ranges.
     *
     * @param string $text       Text to read qvalue from
     * @param int    &$textIndex Index into text where the qvalue starts
     *
     * @throws HttpHeaderFailure If any error occurred while reading and processing
     *                           the quality factor
     * @return int               The normalised qvalue
     */
    public static function readQualityValue(string $text, int &$textIndex): int
    {
        $digit = $text[$textIndex++];
        if ('0' == $digit) {
            $qualityValue = 0;
        } elseif ('1' == $digit) {
            $qualityValue = 1;
        } else {
            throw new HttpHeaderFailure(
                Messages::httpProcessUtilityMalformedHeaderValue(),
                400
            );
        }

        $textLen = strlen($text);
        if ($textIndex < $textLen && '.' == $text[$textIndex]) {
            ++$textIndex;

            $adjustFactor = 1000;
            while (1 < $adjustFactor && $textIndex < $textLen) {
                $c         = $text[$textIndex];
                $charValue = self::digitToInt32($c);
                if (0 <= $charValue) {
                    ++$textIndex;
                    $adjustFactor /= 10;
                    $qualityValue *= 10;
                    $qualityValue += $charValue;
                } else {
                    break;
                }
            }

            $qualityValue *= $adjustFactor;
            if ($qualityValue > 1000) {
                // Too high of a value in qvalue.
                throw new HttpHeaderFailure(
                    Messages::httpProcessUtilityMalformedHeaderValue(),
                    400
                );
            }
        } else {
            $qualityValue *= 1000;
        }

        return $qualityValue;
    }

    /**
     * Converts the specified character from the ASCII range to a digit.
     *
     * @param string $c Character to convert
     *
     * @throws HttpHeaderFailure If $c is not ASCII value for digit or element separator
     * @return int               The Int32 value for $c, or -1 if it is an element separator
     */
    public static function digitToInt32(string $c): int
    {
        if ('0' <= $c && '9' >= $c) {
            return intval($c);
        } else {
            if (self::isHttpElementSeparator($c)) {
                return -1;
            } else {
                throw new HttpHeaderFailure(
                    Messages::httpProcessUtilityMalformedHeaderValue(),
                    400
                );
            }
        }
    }

    /**
     * Verifies whether the specified character is a valid separator in.
     * an HTTP header list of element.
     *
     * @param string $c Character to verify
     *
     * @return bool true if c is a valid character for separating elements;
     *              false otherwise
     */
    public static function isHttpElementSeparator(string $c): bool
    {
        return ',' == $c || ' ' == $c || '\t' == $c;
    }

    /**
     * Get server key by header.
     *
     * @param  string $headerName Name of header
     * @return string
     */
    public static function headerToServerKey(string $headerName): string
    {
        $name = strtoupper(str_replace('-', '_', $headerName));
        $prefixableKeys = ['HOST', 'CONNECTION', 'CACHE_CONTROL', 'ORIGIN', 'USER_AGENT', 'POSTMAN_TOKEN', 'ACCEPT',
            'ACCEPT_ENCODING', 'ACCEPT_LANGUAGE', 'DATASERVICEVERSION', 'MAXDATASERVICEVERSION'];
        return in_array($name, $prefixableKeys) ? 'HTTP_' . $name : $name;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace POData;
6
7			use POData\Common\HttpHeaderFailure;
8			use POData\Common\Messages;
9			use POData\Providers\Metadata\Type\Char;
			0 ignored issues – show Bug introduced 2017-12-13 05:04 UTC by Report Bug Copy Issue Report The type `POData\Providers\Metadata\Type\Char` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
10
11			/**
12			* Class HttpProcessUtility.
13			*/
14			class HttpProcessUtility
15			{
16			/**
17			* Gets the appropriate MIME type for the request, throwing if there is none.
18			*
19			* @param string $acceptTypesText Text as it appears in an HTTP
20			* Accepts header
21			* @param string[] $exactContentTypes Preferred content type to match if an exact media type is given - this is in
22			* descending order of preference
23			* @param string $inexactContentType Preferred fallback content type for inexact matches
24			*
25			* @throws HttpHeaderFailure
26			* @return string\|null One of exactContentType or inexactContentType
27			*/
28			public static function selectRequiredMimeType(
29			?string $acceptTypesText,
30			array $exactContentTypes,
31			$inexactContentType
32			): ?string {
33			$selectedContentType = null;
34			$selectedMatchingParts = -1;
35			$selectedQualityValue = 0;
36
37			if (null === $acceptTypesText) {
38			throw new HttpHeaderFailure(Messages::unsupportedMediaType(), 415);
39			}
40
41			$acceptTypes = self::mimeTypesFromAcceptHeaders($acceptTypesText);
42			foreach ($acceptTypes as $acceptType) {
43			foreach ($exactContentTypes as $exactContentType) {
44			if (0 == strcasecmp($acceptType->getMimeType(), $exactContentType)) {
45			$selectedContentType = $exactContentType;
46			$selectedQualityValue = $acceptType->getQualityValue();
47			break 2;
48			}
49			}
50
51			$matchingParts = $acceptType->getMatchingRating($inexactContentType);
52			if ($matchingParts < 0) {
53			continue;
54			}
55
56			$candidateQualityValue = $acceptType->getQualityValue();
57			// A more specific type wins.
58			if ($matchingParts > $selectedMatchingParts \|\|
59			(
60			$matchingParts == $selectedMatchingParts &&
61			// A type with a higher q-value wins.
62			$candidateQualityValue > $selectedQualityValue
63			)) {
64			$selectedContentType = $inexactContentType;
65			$selectedMatchingParts = $matchingParts;
66			$selectedQualityValue = $candidateQualityValue;
67			}
68			}
69
70			if ((null === $selectedContentType \|\| 0 == $selectedQualityValue) &&
71			!empty($acceptTypes)) {
72			throw new HttpHeaderFailure(Messages::unsupportedMediaType(), 415);
73			}
74
75			return empty($acceptTypes) ? $inexactContentType : $selectedContentType;
76			}
77
78			/**
79			* Returns all MIME types from the $text.
80			*
81			* @param string $text Text as it appears on an HTTP Accepts header
82			*
83			* @throws HttpHeaderFailure If found any syntax error in the given text
84			* @return MediaType[] Array of media (MIME) type description
85			*/
86			public static function mimeTypesFromAcceptHeaders(string $text): array
87			{
88			$mediaTypes = [];
89			$textIndex = 0;
90			while (!self::skipWhiteSpace($text, $textIndex)) {
91			$type = null;
92			$subType = null;
93			self::readMediaTypeAndSubtype($text, $textIndex, $type, $subType);
94
95			$parameters = [];
96			while (!self::skipWhitespace($text, $textIndex)) {
97			if (',' == $text[$textIndex]) {
98			++$textIndex;
99			break;
100			}
101
102			if (';' != $text[$textIndex]) {
103			throw new HttpHeaderFailure(
104			Messages::httpProcessUtilityMediaTypeRequiresSemicolonBeforeParameter(),
105			400
106			);
107			}
108
109			++$textIndex;
110			if (self::skipWhiteSpace($text, $textIndex)) {
111			break;
112			}
113
114			self::readMediaTypeParameter($text, $textIndex, $parameters);
115			}
116
117			$mediaTypes[] = new MediaType($type, $subType, $parameters);
118			}
119
120			return $mediaTypes;
121			}
122
123			/**
124			* Skips whitespace in the specified text by advancing an index to
125			* the next non-whitespace character.
126			*
127			* @param string $text Text to scan
128			* @param int &$textIndex Index to begin scanning from
129			*
130			* @return bool true if the end of the string was reached, false otherwise
131			*/
132			public static function skipWhiteSpace(string $text, int &$textIndex): bool
133			{
134			$textLen = strlen(strval($text));
135			while (($textIndex < $textLen) && Char::isWhiteSpace($text[$textIndex])) {
136			++$textIndex;
137			}
138
139			return $textLen == $textIndex;
140			}
141
142			/**
143			* Reads the type and subtype specifications for a MIME type.
144			*
145			* @param string $text Text in which specification exists
146			* @param int &$textIndex Pointer into text
147			* @param string &$type Type of media found
148			* @param string &$subType Subtype of media found
149			*
150			* @throws HttpHeaderFailure If failed to read type and sub-type
151			*/
152			public static function readMediaTypeAndSubtype(
153			string $text,
154			int &$textIndex,
155			&$type,
156			&$subType
157			): void {
158			$textStart = $textIndex;
159			if (self::readToken($text, $textIndex)) {
160			throw new HttpHeaderFailure(
161			Messages::httpProcessUtilityMediaTypeUnspecified(),
162			400
163			);
164			}
165
166			if ('/' != $text[$textIndex]) {
167			throw new HttpHeaderFailure(
168			Messages::httpProcessUtilityMediaTypeRequiresSlash(),
169			400
170			);
171			}
172
173			$type = substr($text, $textStart, $textIndex - $textStart);
174			++$textIndex;
175
176			$subTypeStart = $textIndex;
177			self::readToken($text, $textIndex);
178			if ($textIndex == $subTypeStart) {
179			throw new HttpHeaderFailure(
180			Messages::httpProcessUtilityMediaTypeRequiresSubType(),
181			400
182			);
183			}
184
185			$subType = substr($text, $subTypeStart, $textIndex - $subTypeStart);
186			}
187
188			/**
189			* Reads a token on the specified text by advancing an index on it.
190			*
191			* @param string $text Text to read token from
192			* @param int &$textIndex Index for the position being scanned on text
193			*
194			* @return bool true if the end of the text was reached; false otherwise
195			*/
196			public static function readToken(string $text, int &$textIndex): bool
197			{
198			$textLen = strlen($text);
199			while (($textIndex < $textLen) && self::isHttpTokenChar($text[$textIndex])) {
200			++$textIndex;
201			}
202
203			return $textLen == $textIndex;
204			}
205
206			/**
207			* To check whether the given character is a HTTP token character
208			* or not.
209			*
210			* @param string $char The character to inspect
211			*
212			* @return bool True if the given character is a valid HTTP token
213			* character, False otherwise
214			*/
215			public static function isHttpTokenChar(string $char): bool
216			{
217			return 126 > ord($char) && 31 < ord($char) && !self::isHttpSeparator($char);
218			}
219
220			/**
221			* To check whether the given character is a HTTP separator character.
222			*
223			* @param string $char The character to inspect
224			*
225			* @return bool True if the given character is a valid HTTP separator
226			* character, False otherwise
227			*/
228			public static function isHttpSeparator(string $char): bool
229			{
230			$httpSeperators = ['(', ')', '<', '>', '@', ',', ';', ':', '\\', '"', '/', '[', ']', '?', '=', '{', '}', ' '];
231			return in_array($char, $httpSeperators) \|\| ord($char) == Char::TAB;
232			}
233
234			/**
235			* Read a parameter for a media type/range.
236			*
237			* @param string $text Text to read from
238			* @param int &$textIndex Pointer in text
239			* @param array &$parameters Array with parameters
240			*
241			* @throws HttpHeaderFailure If found parameter value missing
242			*/
243			public static function readMediaTypeParameter(string $text, int &$textIndex, array &$parameters)
244			{
245			$textStart = $textIndex;
246			if (self::readToken($text, $textIndex)) {
247			throw new HttpHeaderFailure(
248			Messages::httpProcessUtilityMediaTypeMissingValue(),
249			400
250			);
251			}
252
253			$parameterName = substr($text, $textStart, $textIndex - $textStart);
254			if ('=' != $text[$textIndex]) {
255			throw new HttpHeaderFailure(
256			Messages::httpProcessUtilityMediaTypeMissingValue(),
257			400
258			);
259			}
260
261			++$textIndex;
262			$parameterValue
263			= self::readQuotedParameterValue($parameterName, $text, $textIndex);
264			$parameters[] = [$parameterName => $parameterValue];
265			}
266
267			/**
268			* Reads Mime type parameter value for a particular parameter in the
269			* Content-Type/Accept headers.
270			*
271			* @param string $parameterName Name of parameter
272			* @param string $text Header text
273			* @param int &$textIndex Parsing index in $text
274			*
275			* @throws HttpHeaderFailure
276			* @return string String representing the value of the $parameterName parameter
277			*/
278			public static function readQuotedParameterValue(
279			string $parameterName,
280			string $text,
281			int &$textIndex
282			): ?string {
283			$parameterValue = [];
284			$textLen = strlen($text);
285			$valueIsQuoted = false;
286			if ($textIndex < $textLen) {
287			if ('"' == $text[$textIndex]) {
288			++$textIndex;
289			$valueIsQuoted = true;
290			}
291			}
292
293			while ($textIndex < $textLen) {
294			$currentChar = $text[$textIndex];
295
296			if ('\\' == $currentChar \|\| '"' == $currentChar) {
297			if (!$valueIsQuoted) {
298			throw new HttpHeaderFailure(
299			Messages::httpProcessUtilityEscapeCharWithoutQuotes(
300			$parameterName
301			),
302			400
303			);
304			}
305
306			++$textIndex;
307
308			// End of quoted parameter value.
309			if ('"' == $currentChar) {
310			$valueIsQuoted = false;
311			break;
312			}
313
314			if ($textIndex >= $textLen) {
315			throw new HttpHeaderFailure(
316			Messages::httpProcessUtilityEscapeCharAtEnd($parameterName),
317			400
318			);
319			}
320
321			$currentChar = $text[$textIndex];
322			} elseif (!self::isHttpTokenChar($currentChar)) {
323			// If the given character is special, we stop processing.
324			break;
325			}
326
327			$parameterValue[] = $currentChar;
328			++$textIndex;
329			}
330
331			if ($valueIsQuoted) {
332			throw new HttpHeaderFailure(
333			Messages::httpProcessUtilityClosingQuoteNotFound($parameterName),
334			400
335			);
336			}
337
338			return empty($parameterValue) ? null : implode('', $parameterValue);
339			}
340
341			/**
342			* Selects an acceptable MIME type that satisfies the Accepts header.
343			*
344			* @param string $acceptTypesText Text for Accepts header
345			* @param string[] $availableTypes Types that the server is willing to return, in descending order of preference
346			*
347			* @throws HttpHeaderFailure
348			* @return string\|null The best MIME type for the client
349			*/
350			public static function selectMimeType(string $acceptTypesText, array $availableTypes): ?string
351			{
352			$selectedContentType = null;
353			$selectedMatchingParts = -1;
354			$selectedQualityValue = 0;
355			$selectedPreferenceIndex = PHP_INT_MAX;
356			$acceptable = false;
357			$acceptTypesEmpty = true;
358
359			$acceptTypes = self::mimeTypesFromAcceptHeaders($acceptTypesText);
360			$numAvailable = count($availableTypes);
361			foreach ($acceptTypes as $acceptType) {
362			$acceptTypesEmpty = false;
363			for ($i = 0; $i < $numAvailable; ++$i) {
364			$availableType = $availableTypes[$i];
365			$matchRating = $acceptType->getMatchingRating($availableType);
366			if (0 > $matchRating) {
367			continue;
368			}
369
370			$candidateQualityValue = $acceptType->getQualityValue();
371			if ($matchRating > $selectedMatchingParts) {
372			// A more specific type wins.
373			$selectedContentType = $availableType;
374			$selectedMatchingParts = $matchRating;
375			$selectedQualityValue = $candidateQualityValue;
376			$selectedPreferenceIndex = $i;
377			$acceptable = 0 != $selectedQualityValue;
378			} elseif ($matchRating == $selectedMatchingParts) {
379			// A type with a higher q-value wins.
380			if ($candidateQualityValue > $selectedQualityValue) {
381			$selectedContentType = $availableType;
382			$selectedQualityValue = $candidateQualityValue;
383			$selectedPreferenceIndex = $i;
384			$acceptable = 0 != $selectedQualityValue;
385			} elseif ($candidateQualityValue == $selectedQualityValue) {
386			// A type that is earlier in the availableTypes array wins.
387			if ($i < $selectedPreferenceIndex) {
388			$selectedContentType = $availableType;
389			$selectedPreferenceIndex = $i;
390			}
391			}
392			}
393			}
394			}
395
396			if ($acceptTypesEmpty) {
397			$selectedContentType = $availableTypes[0];
398			} elseif (!$acceptable) {
			0 ignored issues – show introduced 2020-05-07 05:25 UTC by Report Bug Copy Issue Report The condition `$acceptable` is always `false`. Loading history...
399			$selectedContentType = null;
400			}
401
402			return $selectedContentType;
403			}
404
405			/**
406			* Reads the numeric part of a quality value substring, normalizing it to 0-1000.
407			* rather than the standard 0.000-1.000 ranges.
408			*
409			* @param string $text Text to read qvalue from
410			* @param int &$textIndex Index into text where the qvalue starts
411			*
412			* @throws HttpHeaderFailure If any error occurred while reading and processing
413			* the quality factor
414			* @return int The normalised qvalue
415			*/
416			public static function readQualityValue(string $text, int &$textIndex): int
417			{
418			$digit = $text[$textIndex++];
419			if ('0' == $digit) {
420			$qualityValue = 0;
421			} elseif ('1' == $digit) {
422			$qualityValue = 1;
423			} else {
424			throw new HttpHeaderFailure(
425			Messages::httpProcessUtilityMalformedHeaderValue(),
426			400
427			);
428			}
429
430			$textLen = strlen($text);
431			if ($textIndex < $textLen && '.' == $text[$textIndex]) {
432			++$textIndex;
433
434			$adjustFactor = 1000;
435			while (1 < $adjustFactor && $textIndex < $textLen) {
436			$c = $text[$textIndex];
437			$charValue = self::digitToInt32($c);
438			if (0 <= $charValue) {
439			++$textIndex;
440			$adjustFactor /= 10;
441			$qualityValue *= 10;
442			$qualityValue += $charValue;
443			} else {
444			break;
445			}
446			}
447
448			$qualityValue *= $adjustFactor;
449			if ($qualityValue > 1000) {
450			// Too high of a value in qvalue.
451			throw new HttpHeaderFailure(
452			Messages::httpProcessUtilityMalformedHeaderValue(),
453			400
454			);
455			}
456			} else {
457			$qualityValue *= 1000;
458			}
459
460			return $qualityValue;
461			}
462
463			/**
464			* Converts the specified character from the ASCII range to a digit.
465			*
466			* @param string $c Character to convert
467			*
468			* @throws HttpHeaderFailure If $c is not ASCII value for digit or element separator
469			* @return int The Int32 value for $c, or -1 if it is an element separator
470			*/
471			public static function digitToInt32(string $c): int
472			{
473			if ('0' <= $c && '9' >= $c) {
474			return intval($c);
475			} else {
476			if (self::isHttpElementSeparator($c)) {
477			return -1;
478			} else {
479			throw new HttpHeaderFailure(
480			Messages::httpProcessUtilityMalformedHeaderValue(),
481			400
482			);
483			}
484			}
485			}
486
487			/**
488			* Verifies whether the specified character is a valid separator in.
489			* an HTTP header list of element.
490			*
491			* @param string $c Character to verify
492			*
493			* @return bool true if c is a valid character for separating elements;
494			* false otherwise
495			*/
496			public static function isHttpElementSeparator(string $c): bool
497			{
498			return ',' == $c \|\| ' ' == $c \|\| '\t' == $c;
499			}
500
501			/**
502			* Get server key by header.
503			*
504			* @param string $headerName Name of header
505			* @return string
506			*/
507			public static function headerToServerKey(string $headerName): string
508			{
509			$name = strtoupper(str_replace('-', '_', $headerName));
510			$prefixableKeys = ['HOST', 'CONNECTION', 'CACHE_CONTROL', 'ORIGIN', 'USER_AGENT', 'POSTMAN_TOKEN', 'ACCEPT',
511			'ACCEPT_ENCODING', 'ACCEPT_LANGUAGE', 'DATASERVICEVERSION', 'MAXDATASERVICEVERSION'];
512			return in_array($name, $prefixableKeys) ? 'HTTP_' . $name : $name;
513			}
514			}
515

Algo-Web / POData

Pull Request — master (#261)

HttpProcessUtility::readQuotedParameterValue() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like