/
Response.php
448 lines (425 loc) · 11 KB
/
Response.php
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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
<?php
/**
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
*
* Licensed under The MIT License
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @since 3.0.0
* @license http://www.opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Network\Http;
use RuntimeException;
/**
* Implements methods for HTTP responses.
*
* All of the following examples assume that `$response` is an
* instance of this class.
*
* ### Get header values
*
* Header names are case-insensitive, but normalized to Title-Case
* when the response is parsed.
*
* ```
* $val = $response->header('content-type');
* ```
*
* Will read the Content-Type header. You can get all set
* headers using:
*
* ```
* $response->header();
* ```
*
* You can also get at the headers using object access. When getting
* headers with object access, you have to use case-sensitive header
* names:
*
* ```
* $val = $response->headers['Content-Type'];
* ```
*
* ### Get the response body
*
* You can access the response body using:
*
* ```
* $content = $response->body();
* ```
*
* You can also use object access:
*
* ```
* $content = $response->body;
* ```
*
* If your response body is in XML or JSON you can use
* special content type specific accessors to read the decoded data.
* JSON data will be returned as arrays, while XML data will be returned
* as SimpleXML nodes:
*
* ```
* // Get as xml
* $content = $response->xml
* // Get as json
* $content = $response->json
* ```
*
* If the response cannot be decoded, null will be returned.
*
* ### Check the status code
*
* You can access the response status code using:
*
* ```
* $content = $response->statusCode();
* ```
*
* You can also use object access:
*
* ```
* $content = $response->code;
* ```
*/
class Response extends Message
{
/**
* The status code of the response.
*
* @var int
*/
protected $_code;
/**
* The response body
*
* @var string
*/
protected $_body;
/**
* Cached decoded XML data.
*
* @var \SimpleXMLElement
*/
protected $_xml;
/**
* Cached decoded JSON data.
*
* @var array
*/
protected $_json;
/**
* Map of public => property names for __get()
*
* @var array
*/
protected $_exposedProperties = [
'cookies' => '_cookies',
'headers' => '_headers',
'body' => '_body',
'code' => '_code',
'json' => '_getJson',
'xml' => '_getXml'
];
/**
* Constructor
*
* @param array $headers Unparsed headers.
* @param string $body The response body.
*/
public function __construct($headers = [], $body = '')
{
$this->_parseHeaders($headers);
if ($this->header('Content-Encoding') === 'gzip') {
$body = $this->_decodeGzipBody($body);
}
$this->_body = $body;
}
/**
* Uncompress a gzip response.
*
* Looks for gzip signatures, and if gzinflate() exists,
* the body will be decompressed.
*
* @param string $body Gzip encoded body.
* @return string
* @throws \RuntimeException When attempting to decode gzip content without gzinflate.
*/
protected function _decodeGzipBody($body)
{
if (!function_exists('gzinflate')) {
throw new RuntimeException('Cannot decompress gzip response body without gzinflate()');
}
$offset = 0;
// Look for gzip 'signature'
if (substr($body, 0, 2) === "\x1f\x8b") {
$offset = 2;
}
// Check the format byte
if (substr($body, $offset, 1) === "\x08") {
return gzinflate(substr($body, $offset + 8));
}
}
/**
* Parses headers if necessary.
*
* - Decodes the status code.
* - Parses and normalizes header names + values.
*
* @param array $headers Headers to parse.
* @return void
*/
protected function _parseHeaders($headers)
{
foreach ($headers as $key => $value) {
if (substr($value, 0, 5) === 'HTTP/') {
preg_match('/HTTP\/([\d.]+) ([0-9]+)/i', $value, $matches);
$this->_version = $matches[1];
$this->_code = $matches[2];
continue;
}
list($name, $value) = explode(':', $value, 2);
$value = trim($value);
$name = $this->_normalizeHeader($name);
if ($name === 'Set-Cookie') {
$this->_parseCookie($value);
}
if (isset($this->_headers[$name])) {
$this->_headers[$name] = (array)$this->_headers[$name];
$this->_headers[$name][] = $value;
} else {
$this->_headers[$name] = $value;
}
}
}
/**
* Parse a cookie header into data.
*
* @param string $value The cookie value to parse.
* @return void
*/
protected function _parseCookie($value)
{
$value = rtrim($value, ';');
$nestedSemi = '";"';
if (strpos($value, $nestedSemi) !== false) {
$value = str_replace($nestedSemi, "{__cookie_replace__}", $value);
$parts = explode(';', $value);
$parts = str_replace("{__cookie_replace__}", $nestedSemi, $parts);
} else {
$parts = preg_split('/\;[ \t]*/', $value);
}
$name = false;
foreach ($parts as $i => $part) {
if (strpos($part, '=') !== false) {
list($key, $value) = explode('=', $part, 2);
} else {
$key = $part;
$value = true;
}
if ($i === 0) {
$name = $key;
$cookie['value'] = $value;
continue;
}
$key = strtolower($key);
if (!isset($cookie[$key])) {
$cookie[$key] = $value;
}
}
$cookie['name'] = $name;
$this->_cookies[$name] = $cookie;
}
/**
* Check if the response was OK
*
* @return bool
*/
public function isOk()
{
$codes = [
static::STATUS_OK,
static::STATUS_CREATED,
static::STATUS_ACCEPTED
];
return in_array($this->_code, $codes);
}
/**
* Check if the response had a redirect status code.
*
* @return bool
*/
public function isRedirect()
{
$codes = [
static::STATUS_MOVED_PERMANENTLY,
static::STATUS_FOUND,
static::STATUS_SEE_OTHER,
static::STATUS_TEMPORARY_REDIRECT,
];
return (
in_array($this->_code, $codes) &&
$this->header('Location')
);
}
/**
* Get the status code from the response
*
* @return int
*/
public function statusCode()
{
return $this->_code;
}
/**
* Get the encoding if it was set.
*
* @return string|null
*/
public function encoding()
{
$content = $this->header('content-type');
if (!$content) {
return null;
}
preg_match('/charset\s?=\s?[\'"]?([a-z0-9-_]+)[\'"]?/i', $content, $matches);
if (empty($matches[1])) {
return null;
}
return $matches[1];
}
/**
* Read single/multiple header value(s) out.
*
* @param string|null $name The name of the header you want. Leave
* null to get all headers.
* @return mixed Null when the header doesn't exist. An array
* will be returned when getting all headers or when getting
* a header that had multiple values set. Otherwise a string
* will be returned.
*/
public function header($name = null)
{
if ($name === null) {
return $this->_headers;
}
$name = $this->_normalizeHeader($name);
if (!isset($this->_headers[$name])) {
return null;
}
return $this->_headers[$name];
}
/**
* Read single/multiple cookie values out.
*
* @param string|null $name The name of the cookie you want. Leave
* null to get all cookies.
* @param bool $all Get all parts of the cookie. When false only
* the value will be returned.
* @return mixed
*/
public function cookie($name = null, $all = false)
{
if ($name === null) {
return $this->_cookies;
}
if (!isset($this->_cookies[$name])) {
return null;
}
if ($all) {
return $this->_cookies[$name];
}
return $this->_cookies[$name]['value'];
}
/**
* Get the response body.
*
* By passing in a $parser callable, you can get the decoded
* response content back.
*
* For example to get the json data as an object:
*
* ```
* $body = $response->body('json_decode');
* ```
*
* @param callable|null $parser The callback to use to decode
* the response body.
* @return mixed The response body.
*/
public function body($parser = null)
{
if ($parser) {
return $parser($this->_body);
}
return $this->_body;
}
/**
* Get the response body as JSON decoded data.
*
* @return mixed
*/
protected function _getJson()
{
if (!empty($this->_json)) {
return $this->_json;
}
return $this->_json = json_decode($this->_body, true);
}
/**
* Get the response body as XML decoded data.
*
* @return null|\SimpleXMLElement
*/
protected function _getXml()
{
if (!empty($this->_xml)) {
return $this->_xml;
}
libxml_use_internal_errors();
$data = simplexml_load_string($this->_body);
if ($data) {
$this->_xml = $data;
return $this->_xml;
}
return null;
}
/**
* Read values as properties.
*
* @param string $name Property name.
* @return mixed
*/
public function __get($name)
{
if (!isset($this->_exposedProperties[$name])) {
return false;
}
$key = $this->_exposedProperties[$name];
if (substr($key, 0, 4) === '_get') {
return $this->{$key}();
}
return $this->{$key};
}
/**
* isset/empty test with -> syntax.
*
* @param string $name Property name.
* @return bool
*/
public function __isset($name)
{
if (!isset($this->_exposedProperties[$name])) {
return false;
}
$key = $this->_exposedProperties[$name];
if (substr($key, 0, 4) === '_get') {
$val = $this->{$key}();
return $val !== null;
}
return isset($this->$key);
}
}