-
Notifications
You must be signed in to change notification settings - Fork 9
/
Request.php
904 lines (793 loc) · 24.3 KB
/
Request.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
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
<?php
namespace Guzzle\Http\Message;
use Guzzle\Common\Event;
use Guzzle\Common\Collection;
use Guzzle\Common\Exception\InvalidArgumentException;
use Guzzle\Common\Exception\RuntimeException;
use Guzzle\Http\Utils;
use Guzzle\Http\Exception\RequestException;
use Guzzle\Http\Exception\BadResponseException;
use Guzzle\Http\ClientInterface;
use Guzzle\Http\QueryString;
use Guzzle\Http\EntityBody;
use Guzzle\Http\Url;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\EventDispatcher\EventDispatcher;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
/**
* HTTP request class to send requests
*/
class Request extends AbstractMessage implements RequestInterface
{
/**
* @var EventDispatcherInterface
*/
protected $eventDispatcher;
/**
* @var Url HTTP Url
*/
protected $url;
/**
* @var string HTTP method (GET, PUT, POST, DELETE, HEAD, OPTIONS, TRACE)
*/
protected $method;
/**
* @var ClientInterface
*/
protected $client;
/**
* @var Response Response of the request
*/
protected $response;
/**
* @var EntityBody Response body
*/
protected $responseBody;
/**
* @var string State of the request object
*/
protected $state;
/**
* @param string Auth username
*/
protected $username;
/**
* @param string Auth password
*/
protected $password;
/**
* @var Collection cURL specific transfer options
*/
protected $curlOptions;
/**
* {@inheritdoc}
*/
public static function getAllEvents()
{
return array(
// Called when receiving or uploading data through cURL
'curl.callback.read', 'curl.callback.write', 'curl.callback.progress',
// About to send the request
'request.before_send',
// Sent the request
'request.sent',
// Completed HTTP transaction
'request.complete',
// A request received a successful response
'request.success',
// A request received an unsuccessful response
'request.error',
// An exception is being thrown because of an unsuccessful response
'request.exception',
// Received response status line
'request.receive.status_line',
// Manually set a response
'request.set_response'
);
}
/**
* Create a new request
*
* @param string $method HTTP method
* @param string|Url $url HTTP URL to connect to. The URI scheme, host
* header, and URI are parsed from the full URL. If query string
* parameters are present they will be parsed as well.
* @param array|Collection $headers HTTP headers
*/
public function __construct($method, $url, $headers = array())
{
$this->method = strtoupper($method);
$this->curlOptions = new Collection();
$this->params = new Collection();
$this->setUrl($url);
if ($headers) {
// Special handling for multi-value headers
foreach ($headers as $key => $value) {
$lkey = strtolower($key);
// Deal with collisions with Host and Authorization
if ($lkey == 'host') {
$this->setHeader($key, $value);
} elseif ($lkey == 'authorization') {
$parts = explode(' ', $value);
if ($parts[0] == 'Basic' && isset($parts[1])) {
list($user, $pass) = explode(':', base64_decode($parts[1]));
$this->setAuth($user, $pass);
} else {
$this->setHeader($key, $value);
}
} else {
foreach ((array) $value as $v) {
$this->addHeader($key, $v);
}
}
}
}
if (!$this->hasHeader('User-Agent', true)) {
$this->setHeader('User-Agent', Utils::getDefaultUserAgent());
}
$this->setState(self::STATE_NEW);
}
/**
* Clone the request object, leaving off any response that was received
*/
public function __clone()
{
if ($this->eventDispatcher) {
$this->eventDispatcher = clone $this->eventDispatcher;
}
$this->curlOptions = clone $this->curlOptions;
$this->params = clone $this->params;
$this->url = clone $this->url;
// Get a clone of the headers
$headers = array();
foreach ($this->headers as $k => $v) {
$headers[$k] = clone $v;
}
$this->headers = $headers;
$this->response = $this->responseBody = null;
$this->params->remove('curl_handle')
->remove('queued_response')
->remove('curl_multi');
$this->setState(RequestInterface::STATE_NEW);
}
/**
* Get the HTTP request as a string
*
* @return string
*/
public function __toString()
{
return $this->getRawHeaders() . "\r\n\r\n";
}
/**
* Default method that will throw exceptions if an unsuccessful response
* is received.
*
* @param Event $event Received
* @throws BadResponseException if the response is not successful
*/
public static function onRequestError(Event $event)
{
$e = BadResponseException::factory($event['request'], $event['response']);
$event['request']->dispatch('request.exception', array(
'request' => $event['request'],
'response' => $event['response'],
'exception' => $e
));
throw $e;
}
/**
* Set the client used to transport the request
*
* @param ClientInterface $client
*
* @return Request
*/
public function setClient(ClientInterface $client)
{
$this->client = $client;
return $this;
}
/**
* Get the client used to transport the request
*
* @return ClientInterface $client
*/
public function getClient()
{
return $this->client;
}
/**
* Get the raw message headers as a string
*
* @return string
*/
public function getRawHeaders()
{
$protocolVersion = $this->protocolVersion ?: '1.1';
return trim($this->method . ' ' . $this->getResource()) . ' '
. strtoupper(str_replace('https', 'http', $this->url->getScheme()))
. '/' . $protocolVersion . "\r\n" . implode("\r\n", $this->getHeaderLines());
}
/**
* Set the URL of the request
*
* Warning: Calling this method will modify headers, rewrite the query
* string object, and set other data associated with the request.
*
* @param string|Url $url Full URL to set including query string
*
* @return Request
*/
public function setUrl($url)
{
if ($url instanceof Url) {
$this->url = $url;
} else {
$this->url = Url::factory($url);
}
// Update the port and host header
$this->setPort($this->url->getPort());
if ($this->url->getUsername() || $this->url->getPassword()) {
$this->setAuth($this->url->getUsername(), $this->url->getPassword());
// Remove the auth info from the URL
$this->url->setUsername(null);
$this->url->setPassword(null);
}
return $this;
}
/**
* Send the request
*
* @return Response
* @throws RuntimeException if a client is not associated with the request
*/
public function send()
{
if (!$this->client) {
throw new RuntimeException('A client must be set on the request');
}
return $this->client->send($this);
}
/**
* Get the previously received {@see Response} or NULL if the request has
* not been sent
*
* @return Response|null
*/
public function getResponse()
{
return $this->response;
}
/**
* Get the collection of key value pairs that will be used as the query
* string in the request
*
* @param bool $asString Set to TRUE to get the query as string
*
* @return QueryString|string
*/
public function getQuery($asString = false)
{
return $asString
? (string) $this->url->getQuery()
: $this->url->getQuery();
}
/**
* Get the HTTP method of the request
*
* @return string
*/
public function getMethod()
{
return $this->method;
}
/**
* Get the URI scheme of the request (http, https, ftp, etc)
*
* @return string
*/
public function getScheme()
{
return $this->url->getScheme();
}
/**
* Set the URI scheme of the request (http, https, ftp, etc)
*
* @param string $scheme Scheme to set
*
* @return Request
*/
public function setScheme($scheme)
{
$this->url->setScheme($scheme);
return $this;
}
/**
* Get the host of the request
*
* @return string
*/
public function getHost()
{
return $this->url->getHost();
}
/**
* Set the host of the request.
*
* @param string $host Host to set (e.g. www.yahoo.com, www.yahoo.com)
*
* @return Request
*/
public function setHost($host)
{
$this->url->setHost($host);
$this->setPort($this->url->getPort());
return $this;
}
/**
* Get the HTTP protocol version of the request
*
* @return string
*/
public function getProtocolVersion()
{
return $this->protocolVersion;
}
/**
* Set the HTTP protocol version of the request (e.g. 1.1 or 1.0)
*
* @param string $protocol HTTP protocol version to use with the request
*
* @return Request
*/
public function setProtocolVersion($protocol)
{
$this->protocolVersion = $protocol;
return $this;
}
/**
* Get the path of the request (e.g. '/', '/index.html')
*
* @return string
*/
public function getPath()
{
return $this->url->getPath();
}
/**
* Set the path of the request (e.g. '/', '/index.html')
*
* @param string|array $path Path to set or array of segments to implode
*
* @return Request
*/
public function setPath($path)
{
$this->url->setPath($path);
return $this;
}
/**
* Get the port that the request will be sent on if it has been set
*
* @return int|null
*/
public function getPort()
{
return $this->url->getPort();
}
/**
* Set the port that the request will be sent on
*
* @param int $port Port number to set
*
* @return Request
*/
public function setPort($port)
{
$this->url->setPort($port);
// Include the port in the Host header if it is not the default port
// for the scheme of the URL
$scheme = $this->url->getScheme();
if (($scheme == 'http' && $port != 80) || ($scheme == 'https' && $port != 443)) {
$this->headers['host'] = new Header('Host', $this->url->getHost() . ':' . $port);
} else {
$this->headers['host'] = new Header('Host', $this->url->getHost());
}
return $this;
}
/**
* Get the username to pass in the URL if set
*
* @return string|null
*/
public function getUsername()
{
return $this->username;
}
/**
* Get the password to pass in the URL if set
*
* @return string|null
*/
public function getPassword()
{
return $this->password;
}
/**
* Set HTTP authorization parameters
*
* @param string|false $user User name or false disable authentication
* @param string $password Password
* @param string $scheme Curl authentication scheme to use
*
* @return Request
*
* @see http://www.ietf.org/rfc/rfc2617.txt
*/
public function setAuth($user, $password = '', $scheme = CURLAUTH_BASIC)
{
// If we got false or null, disable authentication
if (!$user || !$password) {
$this->password = $this->username = null;
$this->removeHeader('Authorization');
$this->getCurlOptions()->remove(CURLOPT_HTTPAUTH);
} else {
$this->username = $user;
$this->password = $password;
// Bypass CURL when using basic auth to promote connection reuse
if ($scheme == CURLAUTH_BASIC) {
$this->getCurlOptions()->remove(CURLOPT_HTTPAUTH);
$this->setHeader('Authorization', 'Basic ' . base64_encode($this->username . ':' . $this->password));
} else {
$this->getCurlOptions()->set(CURLOPT_HTTPAUTH, $scheme)
->set(CURLOPT_USERPWD, $this->username . ':' . $this->password);
}
}
return $this;
}
/**
* Get the resource part of the the request, including the path, query
* string, and fragment
*
* @return string
*/
public function getResource()
{
return $this->url->getPath() . (string) $this->url->getQuery();
}
/**
* Get the full URL of the request (e.g. 'http://www.guzzle-project.com/')
* scheme://username:password@domain:port/path?query_string#fragment
*
* @param bool $asObject Set to TRUE to retrieve the URL as
* a clone of the URL object owned by the request
*
* @return string|Url
*/
public function getUrl($asObject = false)
{
return $asObject ? clone $this->url : (string) $this->url;
}
/**
* Get the state of the request. One of 'complete', 'sending', 'new'
*
* @return string
*/
public function getState()
{
return $this->state;
}
/**
* Set the state of the request
*
* @param string $state State of the request (complete, sending, or new)
*
* @return Request
*/
public function setState($state)
{
$this->state = $state;
if ($this->state == self::STATE_NEW) {
$this->responseBody = $this->response = null;
} elseif ($this->state == self::STATE_COMPLETE) {
$this->processResponse();
}
return $this;
}
/**
* Get the cURL options that will be applied when the cURL handle is created
*
* @return Collection
*/
public function getCurlOptions()
{
return $this->curlOptions;
}
/**
* Method to receive HTTP response headers as they are retrieved
*
* @param string $data Header data.
*
* @return integer Returns the size of the data.
*/
public function receiveResponseHeader($data)
{
static $normalize = array("\r", "\n");
$this->state = self::STATE_TRANSFER;
$length = strlen($data);
$data = str_replace($normalize, '', $data);
if (strpos($data, 'HTTP/') === 0) {
list($dummy, $code, $status) = explode(' ', $data, 3);
// Only download the body of the response to the specified response
// body when a successful response is received.
if ($code >= 200 && $code < 300) {
$body = $this->getResponseBody();
} else {
$body = EntityBody::factory();
}
$previousResponse = $this->response;
$this->response = new Response($code, null, $body);
$this->response->setStatus($code, $status)->setRequest($this);
$this->dispatch('request.receive.status_line', array(
'line' => $data,
'status_code' => $code,
'reason_phrase' => $status,
'previous_response' => $previousResponse
));
} elseif (strpos($data, ':') !== false) {
list($header, $value) = explode(':', $data, 2);
$this->response->addHeader(trim($header), trim($value));
}
return $length;
}
/**
* Manually set a response for the request.
*
* This method is useful for specifying a mock response for the request or
* setting the response using a cache. Manually setting a response will
* bypass the actual sending of a request.
*
* @param Response $response Response object to set
* @param bool $queued Set to TRUE to keep the request in a stat
* of not having been sent, but queue the response for send()
*
* @return Request Returns a reference to the object.
*/
public function setResponse(Response $response, $queued = false)
{
$response->setRequest($this);
if ($queued) {
$this->getParams()->set('queued_response', $response);
} else {
$this->getParams()->remove('queued_response');
$this->response = $response;
$this->responseBody = $response->getBody();
$this->processResponse();
}
$this->dispatch('request.set_response', $this->getEventArray());
return $this;
}
/**
* Set the EntityBody that will hold the response message's entity body.
*
* This method should be invoked when you need to send the response's
* entity body somewhere other than the normal php://temp buffer. For
* example, you can send the entity body to a socket, file, or some other
* custom stream.
*
* @param EntityBody $body Response body object
*
* @return Request
*/
public function setResponseBody(EntityBody $body)
{
$this->responseBody = $body;
return $this;
}
/**
* Determine if the response body is repeatable (readable + seekable)
*
* @return bool
*/
public function isResponseBodyRepeatable()
{
return !$this->responseBody ? true : $this->responseBody->isSeekable() && $this->responseBody->isReadable();
}
/**
* Get an array of cookies
*
* @return array
*/
public function getCookies()
{
$cookieData = new Collection();
if ($cookies = $this->getHeader('Cookie')) {
foreach ($cookies as $cookie) {
$parts = explode('=', $cookie, 2);
$cookieData->add($parts[0], isset($parts[1]) ? $parts[1] : '');
}
}
return $cookieData->getAll();
}
/**
* Get a cookie value by name
*
* @param string $name Cookie to retrieve
*
* @return null|string|array
*/
public function getCookie($name)
{
$cookies = $this->getCookies();
return isset($cookies[$name]) ? $cookies[$name] : null;
}
/**
* Add a Cookie value by name to the Cookie header
*
* @param string $name Name of the cookie to add
* @param string $value Value to set
*
* @return Request
*/
public function addCookie($name, $value)
{
if (!$this->hasHeader('Cookie')) {
$this->setHeader('Cookie', "{$name}={$value}");
} else {
$this->getHeader('Cookie')->add("{$name}={$value}");
}
return $this;
}
/**
* Remove a specific cookie value by name
*
* @param string $name Cookie to remove by name
*
* @return Request
*/
public function removeCookie($name)
{
if ($cookie = $this->getHeader('Cookie')) {
foreach ($cookie as $cookieValue) {
if (strpos($cookieValue, $name . '=') === 0) {
$cookie->removeValue($cookieValue);
}
}
}
return $this;
}
/**
* Returns whether or not the request can be cached
*
* @return bool
*/
public function canCache()
{
// Only GET and HEAD requests can be cached
if ($this->method != RequestInterface::GET && $this->method != RequestInterface::HEAD) {
return false;
}
// Never cache requests when using no-store
if ($this->hasCacheControlDirective('no-store')) {
return false;
}
return true;
}
/**
* {@inheritdoc}
*/
public function setEventDispatcher(EventDispatcherInterface $eventDispatcher)
{
$this->eventDispatcher = $eventDispatcher;
$this->eventDispatcher->addListener('request.error', array(__CLASS__, 'onRequestError'), -255);
return $this;
}
/**
* {@inheritdoc}
*/
public function getEventDispatcher()
{
if (!$this->eventDispatcher) {
$this->setEventDispatcher(new EventDispatcher());
}
return $this->eventDispatcher;
}
/**
* {@inheritdoc}
*/
public function dispatch($eventName, array $context = array())
{
$context['request'] = $this;
$this->getEventDispatcher()->dispatch($eventName, new Event($context));
}
/**
* {@inheritdoc}
* @codeCoverageIgnore
*/
public function addSubscriber(EventSubscriberInterface $subscriber)
{
$this->getEventDispatcher()->addSubscriber($subscriber);
return $this;
}
/**
* {@inheritdoc}
*/
protected function changedHeader($action, $header)
{
parent::changedHeader($action, $header);
if ($header === 'host') {
// If the Host header was changed, be sure to update the internal URL
$this->setHost((string) $this->getHeader('Host'));
}
}
/**
* Get the EntityBody that will store the received response entity body
*
* @return EntityBody
*/
protected function getResponseBody()
{
if ($this->responseBody === null) {
$this->responseBody = EntityBody::factory();
}
return $this->responseBody;
}
/**
* Get an array containing the request and response for event notifications
*
* @return array
*/
protected function getEventArray()
{
return array(
'request' => $this,
'response' => $this->response
);
}
/**
* Process a received response
*
* @throws BadResponseException on unsuccessful responses
*/
protected function processResponse()
{
// Use the queued response if one is set
if ($this->getParams()->get('queued_response')) {
$this->response = $this->getParams()->get('queued_response');
$this->responseBody = $this->response->getBody();
$this->getParams()->remove('queued_response');
} elseif (!$this->response) {
// If no response, then processResponse shouldn't have been called
$e = new RequestException('Error completing request');
$e->setRequest($this);
throw $e;
}
$this->state = self::STATE_COMPLETE;
// A request was sent, but we don't know if we'll send more or if the
// final response will be a successful response
$this->dispatch('request.sent', $this->getEventArray());
// Some response processors will remove the response or reset the state
// (example: ExponentialBackoffPlugin)
if ($this->state == RequestInterface::STATE_COMPLETE) {
// The request completed, so the HTTP transaction is complete
$this->dispatch('request.complete', $this->getEventArray());
// If the response is bad, allow listeners to modify it or throw
// exceptions. You can change the response by modifying the Event
// object in your listeners or calling setResponse() on the request
if ($this->response->isError()) {
$event = new Event($this->getEventArray());
$this->getEventDispatcher()->dispatch('request.error', $event);
// Allow events of request.error to quietly change the response
if ($event['response'] !== $this->response) {
$this->response = $event['response'];
}
}
// If a successful response was received, dispatch an event
if ($this->response->isSuccessful()) {
$this->dispatch('request.success', $this->getEventArray());
}
}
return $this;
}
}