-
Notifications
You must be signed in to change notification settings - Fork 522
Expand file tree
/
Copy pathAbstractHttpProvider.php
More file actions
223 lines (186 loc) · 7.41 KB
/
AbstractHttpProvider.php
File metadata and controls
223 lines (186 loc) · 7.41 KB
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
<?php
declare(strict_types=1);
/*
* This file is part of the Geocoder package.
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*
* @license MIT License
*/
namespace Geocoder\Http\Provider;
use Geocoder\Exception\InvalidCredentials;
use Geocoder\Exception\InvalidServerResponse;
use Geocoder\Exception\QuotaExceeded;
use Geocoder\Provider\AbstractProvider;
use Http\Discovery\Psr17Factory;
use Http\Message\MessageFactory;
use Psr\Http\Client\ClientInterface;
use Psr\Http\Message\RequestFactoryInterface;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseFactoryInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\StreamFactoryInterface;
use Psr\Http\Message\StreamInterface;
use Psr\Http\Message\UriInterface;
/**
* @author William Durand <william.durand1@gmail.com>
* @author Tobias Nyholm <tobias.nyholm@gmail.com>
*/
abstract class AbstractHttpProvider extends AbstractProvider
{
/**
* @var ClientInterface
*/
private $client;
/**
* @var RequestFactoryInterface&StreamFactoryInterface)|MessageFactory
*/
private $messageFactory;
/**
* @param Psr17Factory|MessageFactory|null $factory Passing a MessageFactory is @deprecated
*/
public function __construct(ClientInterface $client, MessageFactory|Psr17Factory|null $factory = null)
{
$this->client = $client;
$this->messageFactory = $factory ?? ($client instanceof RequestFactoryInterface && $client instanceof StreamFactoryInterface ? $client : new Psr17Factory());
}
/**
* Get URL and return contents. If content is empty, an exception will be thrown.
*
* @throws InvalidServerResponse
*/
protected function getUrlContents(string $url): string
{
$request = $this->getRequest($url);
return $this->getParsedResponse($request);
}
protected function getRequest(string $url): RequestInterface
{
return $this->createRequest('GET', $url);
}
/**
* @param array<string,string|string[]> $headers
*/
protected function createRequest(string $method, string $uri, array $headers = [], ?string $body = null): RequestInterface
{
if ($this->messageFactory instanceof MessageFactory) {
return $this->messageFactory->createRequest($method, $uri, $headers, $body);
}
$request = $this->messageFactory->createRequest($method, $uri);
foreach ($headers as $name => $value) {
$request = $request->withAddedHeader($name, $value);
}
if (null === $body) {
return $request;
}
$stream = $this->messageFactory->createStream($body);
if ($stream->isSeekable()) {
$stream->seek(0);
}
return $request->withBody($stream);
}
/**
* Send request and return contents. If content is empty, an exception will be thrown.
*
* @throws InvalidServerResponse
*/
protected function getParsedResponse(RequestInterface $request): string
{
$response = $this->getHttpClient()->sendRequest($request);
$statusCode = $response->getStatusCode();
if (401 === $statusCode || 403 === $statusCode) {
throw new InvalidCredentials();
} elseif (429 === $statusCode) {
throw new QuotaExceeded();
} elseif ($statusCode >= 300) {
throw InvalidServerResponse::create((string) $request->getUri(), $statusCode);
}
$body = (string) $response->getBody();
if ('' === $body) {
throw InvalidServerResponse::emptyResponse((string) $request->getUri());
}
return $body;
}
/**
* Returns the HTTP adapter.
*/
protected function getHttpClient(): ClientInterface
{
return $this->client;
}
/**
* @deprecated Use createRequest instead
*/
protected function getMessageFactory(): MessageFactory
{
if ($this->messageFactory instanceof MessageFactory) {
return $this->messageFactory;
}
$factory = $this->messageFactory instanceof ResponseFactoryInterface ? $this->messageFactory : new Psr17Factory();
return new class($factory) implements MessageFactory {
public function __construct(
/**
* @param RequestFactoryInterface&ResponseFactoryInterface&StreamFactoryInterface $factory
*/
private RequestFactoryInterface|ResponseFactoryInterface|StreamFactoryInterface $factory,
) {
}
/**
* @param string $method
* @param string|UriInterface $uri
* @param array<string,string|string[]> $headers
* @param resource|string|StreamInterface|null $body
* @param string $protocolVersion
*/
public function createRequest($method, $uri, array $headers = [], $body = null, $protocolVersion = '1.1'): RequestInterface
{
$request = $this->factory->createRequest($method, $uri);
foreach ($headers as $name => $value) {
$request = $request->withAddedHeader($name, $value);
}
if (null !== $body) {
$request = $request->withBody($this->createStream($body));
}
return $request->withProtocolVersion($protocolVersion);
}
/**
* @param int $statusCode
* @param string|null $reasonPhrase
* @param array<string,string|string[]> $headers
* @param resource|string|StreamInterface|null $body
* @param string $protocolVersion
*/
public function createResponse($statusCode = 200, $reasonPhrase = null, array $headers = [], $body = null, $protocolVersion = '1.1'): ResponseInterface
{
$response = $this->factory->createResponse($statusCode, $reasonPhrase);
foreach ($headers as $name => $value) {
$response = $response->withAddedHeader($name, $value);
}
if (null !== $body) {
$response = $response->withBody($this->createStream($body));
}
return $response->withProtocolVersion($protocolVersion);
}
/**
* @param string|resource|StreamInterface|null $body
*/
private function createStream($body = ''): StreamInterface
{
if ($body instanceof StreamInterface) {
return $body;
}
if (\is_string($body ?? '')) {
$stream = $this->factory->createStream($body ?? '');
} elseif (\is_resource($body)) {
$stream = $this->factory->createStreamFromResource($body);
} else {
throw new \InvalidArgumentException(sprintf('"%s()" expects string, resource or StreamInterface, "%s" given.', __METHOD__, get_debug_type($body)));
}
if ($stream->isSeekable()) {
$stream->seek(0);
}
return $stream;
}
};
}
}