-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
Response.php
736 lines (661 loc) · 18 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
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
<?php
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
*
* Licensed under The MIT License
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 3.0.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Http\Client;
// This alias is necessary to avoid class name conflicts
// with the deprecated class in this namespace.
use Cake\Http\Cookie\CookieCollection as CookiesCollection;
use Cake\Http\Cookie\CookieInterface;
use Psr\Http\Message\ResponseInterface;
use RuntimeException;
use Zend\Diactoros\MessageTrait;
use Zend\Diactoros\Stream;
/**
* 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->getHeaderLine('content-type');
* ```
*
* Will read the Content-Type header. You can get all set
* headers using:
*
* ```
* $response->getHeaders();
* ```
*
* ### Get the response body
*
* You can access the response body stream using:
*
* ```
* $content = $response->getBody();
* ```
*
* You can get the body string using:
*
* ```
* $content = $response->getStringBody();
* ```
*
* 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->getXml()
* // Get as json
* $content = $response->getJson()
* ```
*
* If the response cannot be decoded, null will be returned.
*
* ### Check the status code
*
* You can access the response status code using:
*
* ```
* $content = $response->getStatusCode();
* ```
*/
class Response extends Message implements ResponseInterface
{
use MessageTrait;
/**
* The status code of the response.
*
* @var int
*/
protected $code;
/**
* Cookie Collection instance
*
* @var \Cake\Http\Cookie\CookieCollection
*/
protected $cookies;
/**
* The reason phrase for the status code
*
* @var string
*/
protected $reasonPhrase;
/**
* 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' => '_getCookies',
'body' => '_getBody',
'code' => 'code',
'json' => '_getJson',
'xml' => '_getXml',
'headers' => '_getHeaders',
];
/**
* Map of deprecated magic properties.
*
* @var array
* @internal
*/
protected $_deprecatedMagicProperties = [
'cookies' => 'getCookies()',
'body' => 'getStringBody()',
'json' => 'getJson()',
'xml' => 'getXml()',
'headers' => 'getHeaders()',
];
/**
* Constructor
*
* @param array $headers Unparsed headers.
* @param string $body The response body.
*/
public function __construct($headers = [], $body = '')
{
$this->_parseHeaders($headers);
if ($this->getHeaderLine('Content-Encoding') === 'gzip') {
$body = $this->_decodeGzipBody($body);
}
$stream = new Stream('php://memory', 'wb+');
$stream->write($body);
$stream->rewind();
$this->stream = $stream;
}
/**
* 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 and reasonphrase.
* - 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->protocol = $matches[1];
$this->code = (int)$matches[2];
$this->reasonPhrase = trim($matches[3]);
continue;
}
if (strpos($value, ':') === false) {
continue;
}
list($name, $value) = explode(':', $value, 2);
$value = trim($value);
$name = trim($name);
$normalized = strtolower($name);
if (isset($this->headers[$name])) {
$this->headers[$name][] = $value;
} else {
$this->headers[$name] = (array)$value;
$this->headerNames[$normalized] = $name;
}
}
}
/**
* Check if the response was OK
*
* @return bool
*/
public function isOk()
{
$codes = [
static::STATUS_OK,
static::STATUS_CREATED,
static::STATUS_ACCEPTED,
static::STATUS_NON_AUTHORITATIVE_INFORMATION,
static::STATUS_NO_CONTENT,
];
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->getHeaderLine('Location')
);
}
/**
* Get the status code from the response
*
* @return int
* @deprecated 3.3.0 Use getStatusCode() instead.
*/
public function statusCode()
{
deprecationWarning(
'Response::statusCode() is deprecated. ' .
'Use Response::getStatusCode() instead.'
);
return $this->code;
}
/**
* {@inheritdoc}
*
* @return int The status code.
*/
public function getStatusCode()
{
return $this->code;
}
/**
* {@inheritdoc}
*
* @param int $code The status code to set.
* @param string $reasonPhrase The status reason phrase.
* @return $this A copy of the current object with an updated status code.
*/
public function withStatus($code, $reasonPhrase = '')
{
$new = clone $this;
$new->code = $code;
$new->reasonPhrase = $reasonPhrase;
return $new;
}
/**
* {@inheritdoc}
*
* @return string The current reason phrase.
*/
public function getReasonPhrase()
{
return $this->reasonPhrase;
}
/**
* Get the encoding if it was set.
*
* @return string|null
* @deprecated 3.3.0 Use getEncoding() instead.
*/
public function encoding()
{
deprecationWarning(
'Response::encoding() is deprecated. ' .
'Use Response::getEncoding() instead.'
);
return $this->getEncoding();
}
/**
* Get the encoding if it was set.
*
* @return string|null
*/
public function getEncoding()
{
$content = $this->getHeaderLine('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.
* @deprecated 3.3.0 Use getHeader() and getHeaderLine() instead.
*/
public function header($name = null)
{
deprecationWarning(
'Response::header() is deprecated. ' .
'Use Response::getHeader() and getHeaderLine() instead.'
);
if ($name === null) {
return $this->_getHeaders();
}
$header = $this->getHeader($name);
if (count($header) === 1) {
return $header[0];
}
return $header;
}
/**
* Read single/multiple cookie values out.
*
* *Note* This method will only provide access to cookies that
* were added as part of the constructor. If cookies are added post
* construction they will not be accessible via this method.
*
* @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
* @deprecated 3.3.0 Use getCookie(), getCookieData() or getCookies() instead.
*/
public function cookie($name = null, $all = false)
{
deprecationWarning(
'Response::cookie() is deprecated. ' .
'Use Response::getCookie(), getCookieData() or getCookies() instead.'
);
if ($name === null) {
return $this->getCookies();
}
if ($all) {
return $this->getCookieData($name);
}
return $this->getCookie($name);
}
/**
* Get the all cookie data.
*
* @return array The cookie data
*/
public function getCookies()
{
return $this->_getCookies();
}
/**
* Get the cookie collection from this response.
*
* This method exposes the response's CookieCollection
* instance allowing you to interact with cookie objects directly.
*
* @return \Cake\Http\Cookie\CookieCollection
*/
public function getCookieCollection()
{
$this->buildCookieCollection();
return $this->cookies;
}
/**
* Get the value of a single cookie.
*
* @param string $name The name of the cookie value.
* @return string|array|null Either the cookie's value or null when the cookie is undefined.
*/
public function getCookie($name)
{
$this->buildCookieCollection();
if (!$this->cookies->has($name)) {
return null;
}
return $this->cookies->get($name)->getValue();
}
/**
* Get the full data for a single cookie.
*
* @param string $name The name of the cookie value.
* @return array|null Either the cookie's data or null when the cookie is undefined.
*/
public function getCookieData($name)
{
$this->buildCookieCollection();
if (!$this->cookies->has($name)) {
return null;
}
$cookie = $this->cookies->get($name);
return $this->convertCookieToArray($cookie);
}
/**
* Convert the cookie into an array of its properties.
*
* This method is compatible with older client code that
* expects date strings instead of timestamps.
*
* @param \Cake\Http\Cookie\CookieInterface $cookie Cookie object.
* @return array
*/
protected function convertCookieToArray(CookieInterface $cookie)
{
return [
'name' => $cookie->getName(),
'value' => $cookie->getValue(),
'path' => $cookie->getPath(),
'domain' => $cookie->getDomain(),
'secure' => $cookie->isSecure(),
'httponly' => $cookie->isHttpOnly(),
'expires' => $cookie->getFormattedExpires(),
];
}
/**
* Lazily build the CookieCollection and cookie objects from the response header
*
* @return void
*/
protected function buildCookieCollection()
{
if ($this->cookies) {
return;
}
$this->cookies = CookiesCollection::createFromHeader($this->getHeader('Set-Cookie'));
}
/**
* Property accessor for `$this->cookies`
*
* @return array Array of Cookie data.
*/
protected function _getCookies()
{
$this->buildCookieCollection();
$cookies = [];
foreach ($this->cookies as $cookie) {
$cookies[$cookie->getName()] = $this->convertCookieToArray($cookie);
}
return $cookies;
}
/**
* Get the HTTP version used.
*
* @return string
* @deprecated 3.3.0 Use getProtocolVersion()
*/
public function version()
{
deprecationWarning(
'Response::version() is deprecated. ' .
'Use Response::getProtocolVersion() instead.'
);
return $this->protocol;
}
/**
* 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.
* @deprecated 3.7.0 Use getStringBody()/getJson()/getXml() instead.
*/
public function body($parser = null)
{
deprecationWarning(
'Response::body() is deprecated. Use getStringBody()/getJson()/getXml() instead.'
);
$stream = $this->stream;
$stream->rewind();
if ($parser) {
return $parser($stream->getContents());
}
return $stream->getContents();
}
/**
* Get the response body as string.
*
* @return string
*/
public function getStringBody()
{
return $this->_getBody();
}
/**
* Get the response body as JSON decoded data.
*
* @return array|null
*/
public function getJson()
{
return $this->_getJson();
}
/**
* Get the response body as JSON decoded data.
*
* @return array|null
*/
protected function _getJson()
{
if ($this->_json) {
return $this->_json;
}
return $this->_json = json_decode($this->_getBody(), true);
}
/**
* Get the response body as XML decoded data.
*
* @return \SimpleXMLElement|null
*/
public function getXml()
{
return $this->_getXml();
}
/**
* Get the response body as XML decoded data.
*
* @return \SimpleXMLElement|null
*/
protected function _getXml()
{
if ($this->_xml) {
return $this->_xml;
}
libxml_use_internal_errors();
$data = simplexml_load_string($this->_getBody());
if ($data) {
$this->_xml = $data;
return $this->_xml;
}
return null;
}
/**
* Provides magic __get() support.
*
* @return array
*/
protected function _getHeaders()
{
$out = [];
foreach ($this->headers as $key => $values) {
$out[$key] = implode(',', $values);
}
return $out;
}
/**
* Provides magic __get() support.
*
* @return string
*/
protected function _getBody()
{
$this->stream->rewind();
return $this->stream->getContents();
}
/**
* 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') {
deprecationWarning(sprintf(
'Response::%s is deprecated. Use Response::%s instead.',
$name,
$this->_deprecatedMagicProperties[$name]
));
return $this->{$key}();
}
if ($key === 'code') {
deprecationWarning(
'Response::code() is deprecated. ' .
'Use Response::getStatusCode() instead.'
);
}
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') {
deprecationWarning(sprintf(
'Response::%s is deprecated. Use Response::%s instead.',
$name,
$this->_deprecatedMagicProperties[$name]
));
$val = $this->{$key}();
return $val !== null;
}
if ($key === 'code') {
deprecationWarning(
'Response::code() is deprecated. ' .
'Use Response::getStatusCode() instead.'
);
}
return isset($this->{$key});
}
}
// @deprecated 3.4.0 Add backwards compat alias.
class_alias('Cake\Http\Client\Response', 'Cake\Network\Http\Response');