1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
|
<?php
namespace MediaWiki\Rest\HeaderParser;
/**
* A class to assist with the parsing of If-None-Match, If-Match and ETag headers
*/
class IfNoneMatch extends HeaderParserBase {
/** @var array[] */
private $results = [];
/** @var string|null */
private $lastError;
/**
* Parse an If-None-Match or If-Match header list as returned by
* RequestInterface::getHeader().
*
* The return value is an array of tag info arrays. Each tag info array is
* an associative array with the following keys:
*
* - weak: True if the tag is weak, false otherwise
* - contents: The contents of the double-quoted opaque-tag, not
* including the quotes.
* - whole: The whole ETag, including weak indicator and quoted opaque-tag
*
* In the case of a wildcard header like "If-Match: *", there cannot be any
* other tags. The return value is an array with a single tag info array with
* 'whole' => '*'.
*
* If the header was invalid, an empty array will be returned. Further
* information about why the parsing failed can be found by calling
* getLastError().
*
* @param string[] $headerList
* @return array[]
*/
public function parseHeaderList( $headerList ) {
$this->lastError = null;
if ( count( $headerList ) === 1 && $headerList[0] === '*' ) {
return [ [
'weak' => true,
'contents' => null,
'whole' => '*'
] ];
}
$this->results = [];
try {
foreach ( $headerList as $header ) {
$this->parseHeader( $header );
}
return $this->results;
} catch ( HeaderParserError $e ) {
$this->lastError = $e->getMessage();
return [];
}
}
/**
* Parse an entity-tag such as might be found in an ETag response header.
* The result is an associative array in the same format returned by
* parseHeaderList().
*
* If parsing failed, null is returned.
*
* @param string $eTag
* @return array|null
*/
public function parseETag( $eTag ) {
$this->setInput( $eTag );
$this->results = [];
try {
$this->consumeTag();
$this->assertEnd();
} catch ( HeaderParserError $e ) {
$this->lastError = $e->getMessage();
return null;
}
/* @phan-suppress-next-line PhanTypeInvalidDimOffset */
return $this->results[0];
}
/**
* Get the last parse error message, or null if there was none
*
* @return string|null
*/
public function getLastError() {
return $this->lastError;
}
/**
* Parse a single header
*
* @param string $header
* @throws HeaderParserError
*/
private function parseHeader( $header ) {
$this->setInput( $header );
$this->consumeTagList();
$this->assertEnd();
}
/**
* Consume a comma-separated list of entity-tags
*
* @throws HeaderParserError
*/
private function consumeTagList() {
while ( true ) {
$this->skipWhitespace();
$this->consumeTag();
$this->skipWhitespace();
if ( $this->pos === $this->inputLength ) {
break;
} else {
$this->consumeString( ',' );
}
}
}
/**
* Consume a single entity-tag and append to the result array
*
* @throws HeaderParserError
*/
private function consumeTag() {
$weak = false;
$whole = '';
if ( substr( $this->input, $this->pos, 2 ) === 'W/' ) {
$weak = true;
$whole .= 'W/';
$this->pos += 2;
}
$this->consumeString( '"' );
if ( !preg_match( '/[!#-~\x80-\xff]*/A', $this->input, $m, 0, $this->pos ) ) {
$this->error( 'unexpected regex failure' );
}
$contents = $m[0];
$this->pos += strlen( $contents );
$this->consumeString( '"' );
$whole .= '"' . $contents . '"';
$this->results[] = [
'weak' => $weak,
'contents' => $contents,
'whole' => $whole
];
}
}
|
