Rfc7230::hashRule() - Code Metrics - Stadly/Http - Measure and Improve Code Quality continuously with Scrutinizer

Rfc7230::hashRule() B
last analyzed 2023-09-22 08:55 UTC

↳ Parent: Rfc7230

Complexity

Conditions	8
Paths	9

Size

Total Lines	28
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	16
CRAP Score	8

Importance

Changes

Metric	Value
cc	8
eloc	15
c	0
b	0
f	0
nc	9
nop	3
dl	0
loc	28
ccs	16
cts	16
cp	1
crap	8
rs	8.4444

<?php

declare(strict_types=1);

namespace Stadly\Http\Utilities;

use InvalidArgumentException;

/**
 * Regular expressions for matching rules in RFC 7230:
 * Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing
 *
 * Specification: https://tools.ietf.org/html/rfc7230
 */
final class Rfc7230
{
    /**
     * Specification: https://tools.ietf.org/html/rfc7230#section-3.2 (header-field)
     */
    public const HEADER_FIELD = '(?:' . self::FIELD_NAME . ':' . self::OWS . self::FIELD_VALUE . self::OWS . ')';

    /**
     * Specification: https://tools.ietf.org/html/rfc7230#section-3.2 (header-field)
     */
    public const HEADER_FIELD_CAPTURE
        = '(?:' . self::FIELD_NAME_CAPTURE . ':' . self::OWS . self::FIELD_VALUE_CAPTURE . self::OWS . ')';

    /**
     * Specification: https://tools.ietf.org/html/rfc7230#section-3.2 (field-name)
     */
    public const FIELD_NAME = self::TOKEN;

    /**
     * Specification: https://tools.ietf.org/html/rfc7230#section-3.2 (field-name)
     */
    public const FIELD_NAME_CAPTURE = '(?<FIELD_NAME>' . self::TOKEN . ')';

    /**
     * Specification: https://tools.ietf.org/html/rfc7230#section-3.2 (field-value)
     */
    public const FIELD_VALUE = '(?:(?:' . self::FIELD_CONTENT . '|' . self::OBS_FOLD . ')*)';

    /**
     * Specification: https://tools.ietf.org/html/rfc7230#section-3.2 (field-value)
     */
    public const FIELD_VALUE_CAPTURE = '(?<FIELD_VALUE>(?:' . self::FIELD_CONTENT . '|' . self::OBS_FOLD . ')*)';

    /**
     * Specification: https://tools.ietf.org/html/rfc7230#section-3.2 (field-content)
     *
     * This rule has been updated by an erratum: https://www.rfc-editor.org/errata/eid4189
     * Original: field-vchar [ 1*( SP / HTAB ) field-vchar ]
     * Updated: field-vchar [ 1*( SP / HTAB / field-vchar ) field-vchar ]
     */
    public const FIELD_CONTENT
        = '(?:' . self::FIELD_VCHAR
        . '(?:(?:' . Rfc5234::SP . '|' . Rfc5234::HTAB . '|' . self::FIELD_VCHAR . ')+' . self::FIELD_VCHAR . ')?)';

    /**
     * Specification: https://tools.ietf.org/html/rfc7230#section-3.2 (field-vchar)
     */
    public const FIELD_VCHAR = '(?:' . Rfc5234::VCHAR . '|' . self::OBS_TEXT . ')';

    /**
     * Specification: https://tools.ietf.org/html/rfc7230#section-3.2 (obs-fold)
     *
     * This rule has been updated by an erratum: https://www.rfc-editor.org/errata/eid4189
     * Original: CRLF 1*( SP / HTAB )
     * Updated: OWS CRLF 1*( SP / HTAB )
     */
    public const OBS_FOLD = '(?:' . self::OWS . Rfc5234::CRLF . '(?:' . Rfc5234::SP . '|' . Rfc5234::HTAB . ')+)';

    /**
     * Specification: https://tools.ietf.org/html/rfc7230#section-3.2.3 (OWS)
     */
    public const OWS = '(?:(?:' . Rfc5234::SP . '|' . Rfc5234::HTAB . ')*)';

    /**
     * Specification: https://tools.ietf.org/html/rfc7230#section-3.2.3 (RWS)
     */
    public const RWS = '(?:(?:' . Rfc5234::SP . '|' . Rfc5234::HTAB . ')+)';

    /**
     * Specification: https://tools.ietf.org/html/rfc7230#section-3.2.3 (BWS)
     */
    public const BWS = self::OWS;

    /**
     * Specification: https://tools.ietf.org/html/rfc7230#section-3.2.6 (token)
     */
    public const TOKEN = '(?:' . self::TCHAR . '+)';

    /**
     * Specification: https://tools.ietf.org/html/rfc7230#section-3.2.6 (tchar)
     */
    public const TCHAR = "(?:[!#$%&'*+\\-.\\^_`|~]|" . Rfc5234::DIGIT . '|' . Rfc5234::ALPHA . ')';

    /**
     * Specification: https://tools.ietf.org/html/rfc7230#section-3.2.6 (quoted-string)
     */
    public const QUOTED_STRING
        = '(?:' . Rfc5234::DQUOTE . '(?:' . self::QDTEXT . '|' . self::QUOTED_PAIR . ')*' . Rfc5234::DQUOTE . ')';

    /**
     * Specification: https://tools.ietf.org/html/rfc7230#section-3.2.6 (qdtext)
     */
    public const QDTEXT
        = '(?:' . Rfc5234::HTAB . '|' . Rfc5234::SP . "|[\x21\x23-\x5B\\\x5D-\x7E]|" . self::OBS_TEXT . ')';

    /**
     * Specification: https://tools.ietf.org/html/rfc7230#section-3.2.6 (obs-text)
     */
    public const OBS_TEXT = "[\x80-\xFF]";

    /**
     * Specification: https://tools.ietf.org/html/rfc7230#section-3.2.6 (comment)
     */
    public const COMMENT = '(?:\\((?:' . self::CTEXT . '|' . self::QUOTED_PAIR . '|(?R))*\\))';

    /**
     * Specification: https://tools.ietf.org/html/rfc7230#section-3.2.6 (ctext)
     */
    public const CTEXT
        = '(?:' . Rfc5234::HTAB . '|' . Rfc5234::SP . '|[\x21-\x27\x2A-\x5B\x5D-\x7E]|' . self::OBS_TEXT . ')';

    /**
     * Specification: https://tools.ietf.org/html/rfc7230#section-3.2.6 (quoted-pair)
     */
    public const QUOTED_PAIR
        = '(?:\\\\(?:' . Rfc5234::HTAB . '|' . Rfc5234::SP . '|' . Rfc5234::VCHAR . '|' . self::OBS_TEXT . '))';

    /**
     * Specification: https://tools.ietf.org/html/rfc7230#section-7 (#rule)
     *
     * This function produces the following rules:
     * 0# element => [ OWS *( "," OWS ) element *( 1*( OWS "," ) OWS element ) ] OWS *( "," OWS )
     * x# element => OWS *( "," OWS ) element <x-1>*( 1*( OWS "," ) OWS element ) OWS *( "," OWS )
     *
     * 0#0 element => OWS *( "," OWS )
     * 0#1 element => [ OWS *( "," OWS ) element ] OWS *( "," OWS )
     * 0#y element => [ OWS *( "," OWS ) element *<y-1>( 1*( OWS "," ) OWS element ) ] OWS *( "," OWS )
     *
     * 1#1 element => OWS *( "," OWS ) element OWS *( "," OWS )
     * x#y element => OWS *( "," OWS ) element <x-1>*<y-1>( 1*( OWS "," ) OWS element ) OWS *( "," OWS )
     *
     * @param string $element Regular expression for the list element.
     * @param int $min Minimum number of elements in list.
     * @param int|null $max Maximum number of elements in list.
     * @return string Regular expression for the list.
     */
    public static function hashRule(string $element, int $min = 0, ?int $max = null): string
    {
        if ($min < 0) {
            throw new InvalidArgumentException('Min number of elements must be non-negative.');
        }
        if ($max !== null && $min > $max) {
            throw new InvalidArgumentException('Max number of elements must be greater than or equal to min.');
        }

        $regEx = '';

        if ($max !== 0) {
            $regEx = self::OWS . '(?:,' . self::OWS . ')*' . $element;

            if ($max !== 1) {
                $minRepeat = max(0, $min - 1);
                $maxRepeat = $max === null ? '' : $max - 1;

                $regEx
                    .= '(?:(?:' . self::OWS . ',)+' . self::OWS . $element . '){' . $minRepeat . ',' . $maxRepeat . '}';
            }

            if ($min === 0) {
                $regEx = '(?:' . $regEx . ')?';
            }
        }

        return $regEx . self::OWS . '(?:,' . self::OWS . ')*';
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Stadly\Http\Utilities;
6
7		use InvalidArgumentException;
8
9		/**
10		* Regular expressions for matching rules in RFC 7230:
11		* Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing
12		*
13		* Specification: https://tools.ietf.org/html/rfc7230
14		*/
15		final class Rfc7230
16		{
17		/**
18		* Specification: https://tools.ietf.org/html/rfc7230#section-3.2 (header-field)
19		*/
20		public const HEADER_FIELD = '(?:' . self::FIELD_NAME . ':' . self::OWS . self::FIELD_VALUE . self::OWS . ')';
21
22		/**
23		* Specification: https://tools.ietf.org/html/rfc7230#section-3.2 (header-field)
24		*/
25		public const HEADER_FIELD_CAPTURE
26		= '(?:' . self::FIELD_NAME_CAPTURE . ':' . self::OWS . self::FIELD_VALUE_CAPTURE . self::OWS . ')';
27
28		/**
29		* Specification: https://tools.ietf.org/html/rfc7230#section-3.2 (field-name)
30		*/
31		public const FIELD_NAME = self::TOKEN;
32
33		/**
34		* Specification: https://tools.ietf.org/html/rfc7230#section-3.2 (field-name)
35		*/
36		public const FIELD_NAME_CAPTURE = '(?<FIELD_NAME>' . self::TOKEN . ')';
37
38		/**
39		* Specification: https://tools.ietf.org/html/rfc7230#section-3.2 (field-value)
40		*/
41		public const FIELD_VALUE = '(?:(?:' . self::FIELD_CONTENT . '\|' . self::OBS_FOLD . ')*)';
42
43		/**
44		* Specification: https://tools.ietf.org/html/rfc7230#section-3.2 (field-value)
45		*/
46		public const FIELD_VALUE_CAPTURE = '(?<FIELD_VALUE>(?:' . self::FIELD_CONTENT . '\|' . self::OBS_FOLD . ')*)';
47
48		/**
49		* Specification: https://tools.ietf.org/html/rfc7230#section-3.2 (field-content)
50		*
51		* This rule has been updated by an erratum: https://www.rfc-editor.org/errata/eid4189
52		* Original: field-vchar [ 1*( SP / HTAB ) field-vchar ]
53		* Updated: field-vchar [ 1*( SP / HTAB / field-vchar ) field-vchar ]
54		*/
55		public const FIELD_CONTENT
56		= '(?:' . self::FIELD_VCHAR
57		. '(?:(?:' . Rfc5234::SP . '\|' . Rfc5234::HTAB . '\|' . self::FIELD_VCHAR . ')+' . self::FIELD_VCHAR . ')?)';
58
59		/**
60		* Specification: https://tools.ietf.org/html/rfc7230#section-3.2 (field-vchar)
61		*/
62		public const FIELD_VCHAR = '(?:' . Rfc5234::VCHAR . '\|' . self::OBS_TEXT . ')';
63
64		/**
65		* Specification: https://tools.ietf.org/html/rfc7230#section-3.2 (obs-fold)
66		*
67		* This rule has been updated by an erratum: https://www.rfc-editor.org/errata/eid4189
68		* Original: CRLF 1*( SP / HTAB )
69		* Updated: OWS CRLF 1*( SP / HTAB )
70		*/
71		public const OBS_FOLD = '(?:' . self::OWS . Rfc5234::CRLF . '(?:' . Rfc5234::SP . '\|' . Rfc5234::HTAB . ')+)';
72
73		/**
74		* Specification: https://tools.ietf.org/html/rfc7230#section-3.2.3 (OWS)
75		*/
76		public const OWS = '(?:(?:' . Rfc5234::SP . '\|' . Rfc5234::HTAB . ')*)';
77
78		/**
79		* Specification: https://tools.ietf.org/html/rfc7230#section-3.2.3 (RWS)
80		*/
81		public const RWS = '(?:(?:' . Rfc5234::SP . '\|' . Rfc5234::HTAB . ')+)';
82
83		/**
84		* Specification: https://tools.ietf.org/html/rfc7230#section-3.2.3 (BWS)
85		*/
86		public const BWS = self::OWS;
87
88		/**
89		* Specification: https://tools.ietf.org/html/rfc7230#section-3.2.6 (token)
90		*/
91		public const TOKEN = '(?:' . self::TCHAR . '+)';
92
93		/**
94		* Specification: https://tools.ietf.org/html/rfc7230#section-3.2.6 (tchar)
95		*/
96		public const TCHAR = "(?:[!#$%&'*+\\-.\\^_`\|~]\|" . Rfc5234::DIGIT . '\|' . Rfc5234::ALPHA . ')';
97
98		/**
99		* Specification: https://tools.ietf.org/html/rfc7230#section-3.2.6 (quoted-string)
100		*/
101		public const QUOTED_STRING
102		= '(?:' . Rfc5234::DQUOTE . '(?:' . self::QDTEXT . '\|' . self::QUOTED_PAIR . ')*' . Rfc5234::DQUOTE . ')';
103
104		/**
105		* Specification: https://tools.ietf.org/html/rfc7230#section-3.2.6 (qdtext)
106		*/
107		public const QDTEXT
108		= '(?:' . Rfc5234::HTAB . '\|' . Rfc5234::SP . "\|[\x21\x23-\x5B\\\x5D-\x7E]\|" . self::OBS_TEXT . ')';
109
110		/**
111		* Specification: https://tools.ietf.org/html/rfc7230#section-3.2.6 (obs-text)
112		*/
113		public const OBS_TEXT = "[\x80-\xFF]";
114
115		/**
116		* Specification: https://tools.ietf.org/html/rfc7230#section-3.2.6 (comment)
117		*/
118		public const COMMENT = '(?:\\((?:' . self::CTEXT . '\|' . self::QUOTED_PAIR . '\|(?R))*\\))';
119
120		/**
121		* Specification: https://tools.ietf.org/html/rfc7230#section-3.2.6 (ctext)
122		*/
123		public const CTEXT
124		= '(?:' . Rfc5234::HTAB . '\|' . Rfc5234::SP . '\|[\x21-\x27\x2A-\x5B\x5D-\x7E]\|' . self::OBS_TEXT . ')';
125
126		/**
127		* Specification: https://tools.ietf.org/html/rfc7230#section-3.2.6 (quoted-pair)
128		*/
129		public const QUOTED_PAIR
130		= '(?:\\\\(?:' . Rfc5234::HTAB . '\|' . Rfc5234::SP . '\|' . Rfc5234::VCHAR . '\|' . self::OBS_TEXT . '))';
131
132		/**
133		* Specification: https://tools.ietf.org/html/rfc7230#section-7 (#rule)
134		*
135		* This function produces the following rules:
136		* 0# element => [ OWS ( "," OWS ) element ( 1( OWS "," ) OWS element ) ] OWS ( "," OWS )
137		* x# element => OWS ( "," OWS ) element <x-1>( 1( OWS "," ) OWS element ) OWS ( "," OWS )
138		*
139		* 0#0 element => OWS *( "," OWS )
140		* 0#1 element => [ OWS ( "," OWS ) element ] OWS ( "," OWS )
141		* 0#y element => [ OWS ( "," OWS ) element <y-1>( 1( OWS "," ) OWS element ) ] OWS ( "," OWS )
142		*
143		* 1#1 element => OWS ( "," OWS ) element OWS ( "," OWS )
144		* x#y element => OWS ( "," OWS ) element <x-1><y-1>( 1( OWS "," ) OWS element ) OWS ( "," OWS )
145		*
146		* @param string $element Regular expression for the list element.
147		* @param int $min Minimum number of elements in list.
148		* @param int\|null $max Maximum number of elements in list.
149		* @return string Regular expression for the list.
150		*/
151	146	public static function hashRule(string $element, int $min = 0, ?int $max = null): string
152		{
153	146	if ($min < 0) {
154	1	throw new InvalidArgumentException('Min number of elements must be non-negative.');
155		}
156	145	if ($max !== null && $min > $max) {
157	1	throw new InvalidArgumentException('Max number of elements must be greater than or equal to min.');
158		}
159
160	144	$regEx = '';
161
162	144	if ($max !== 0) {
163	128	$regEx = self::OWS . '(?:,' . self::OWS . ')*' . $element;
164
165	128	if ($max !== 1) {
166	96	$minRepeat = max(0, $min - 1);
167	96	$maxRepeat = $max === null ? '' : $max - 1;
168
169	96	$regEx
170	96	.= '(?:(?:' . self::OWS . ',)+' . self::OWS . $element . '){' . $minRepeat . ',' . $maxRepeat . '}';
171		}
172
173	128	if ($min === 0) {
174	48	$regEx = '(?:' . $regEx . ')?';
175		}
176		}
177
178	144	return $regEx . self::OWS . '(?:,' . self::OWS . ')*';
179		}
180		}
181

Stadly / Http

Rfc7230::hashRule() B last analyzed 2023-09-22 08:55 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Rfc7230::hashRule() B
last analyzed 2023-09-22 08:55 UTC