/
Stream.php
330 lines (297 loc) · 9.81 KB
/
Stream.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
<?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\Adapter;
use Cake\Core\Exception\Exception;
use Cake\Http\Client\AdapterInterface;
use Cake\Http\Client\Request;
use Cake\Http\Client\Response;
use Cake\Http\Exception\HttpException;
/**
* Implements sending Cake\Http\Client\Request
* via php's stream API.
*
* This approach and implementation is partly inspired by Aura.Http
*/
class Stream implements AdapterInterface
{
/**
* Context resource used by the stream API.
*
* @var resource|null
*/
protected $_context;
/**
* Array of options/content for the HTTP stream context.
*
* @var array
*/
protected $_contextOptions;
/**
* Array of options/content for the SSL stream context.
*
* @var array
*/
protected $_sslContextOptions;
/**
* The stream resource.
*
* @var resource|null
*/
protected $_stream;
/**
* Connection error list.
*
* @var array
*/
protected $_connectionErrors = [];
/**
* {@inheritDoc}
*/
public function send(Request $request, array $options)
{
$this->_stream = null;
$this->_context = null;
$this->_contextOptions = [];
$this->_sslContextOptions = [];
$this->_connectionErrors = [];
$this->_buildContext($request, $options);
return $this->_send($request);
}
/**
* Create the response list based on the headers & content
*
* Creates one or many response objects based on the number
* of redirects that occurred.
*
* @param array $headers The list of headers from the request(s)
* @param string $content The response content.
* @return \Cake\Http\Client\Response[] The list of responses from the request(s)
*/
public function createResponses($headers, $content)
{
$indexes = $responses = [];
foreach ($headers as $i => $header) {
if (strtoupper(substr($header, 0, 5)) === 'HTTP/') {
$indexes[] = $i;
}
}
$last = count($indexes) - 1;
foreach ($indexes as $i => $start) {
$end = isset($indexes[$i + 1]) ? $indexes[$i + 1] - $start : null;
$headerSlice = array_slice($headers, $start, $end);
$body = $i == $last ? $content : '';
$responses[] = $this->_buildResponse($headerSlice, $body);
}
return $responses;
}
/**
* Build the stream context out of the request object.
*
* @param \Cake\Http\Client\Request $request The request to build context from.
* @param array $options Additional request options.
* @return void
*/
protected function _buildContext(Request $request, $options)
{
$this->_buildContent($request, $options);
$this->_buildHeaders($request, $options);
$this->_buildOptions($request, $options);
$url = $request->getUri();
$scheme = parse_url($url, PHP_URL_SCHEME);
if ($scheme === 'https') {
$this->_buildSslContext($request, $options);
}
$this->_context = stream_context_create([
'http' => $this->_contextOptions,
'ssl' => $this->_sslContextOptions,
]);
}
/**
* Build the header context for the request.
*
* Creates cookies & headers.
*
* @param \Cake\Http\Client\Request $request The request being sent.
* @param array $options Array of options to use.
* @return void
*/
protected function _buildHeaders(Request $request, $options)
{
$headers = [];
foreach ($request->getHeaders() as $name => $values) {
$headers[] = sprintf('%s: %s', $name, implode(', ', $values));
}
$this->_contextOptions['header'] = implode("\r\n", $headers);
}
/**
* Builds the request content based on the request object.
*
* If the $request->body() is a string, it will be used as is.
* Array data will be processed with Cake\Http\Client\FormData
*
* @param \Cake\Http\Client\Request $request The request being sent.
* @param array $options Array of options to use.
* @return void
*/
protected function _buildContent(Request $request, $options)
{
$body = $request->getBody();
if (empty($body)) {
$this->_contextOptions['content'] = '';
return;
}
$body->rewind();
$this->_contextOptions['content'] = $body->getContents();
}
/**
* Build miscellaneous options for the request.
*
* @param \Cake\Http\Client\Request $request The request being sent.
* @param array $options Array of options to use.
* @return void
*/
protected function _buildOptions(Request $request, $options)
{
$this->_contextOptions['method'] = $request->getMethod();
$this->_contextOptions['protocol_version'] = $request->getProtocolVersion();
$this->_contextOptions['ignore_errors'] = true;
if (isset($options['timeout'])) {
$this->_contextOptions['timeout'] = $options['timeout'];
}
// Redirects are handled in the client layer because of cookie handling issues.
$this->_contextOptions['max_redirects'] = 0;
if (isset($options['proxy']['proxy'])) {
$this->_contextOptions['request_fulluri'] = true;
$this->_contextOptions['proxy'] = $options['proxy']['proxy'];
}
}
/**
* Build SSL options for the request.
*
* @param \Cake\Http\Client\Request $request The request being sent.
* @param array $options Array of options to use.
* @return void
*/
protected function _buildSslContext(Request $request, $options)
{
$sslOptions = [
'ssl_verify_peer',
'ssl_verify_peer_name',
'ssl_verify_depth',
'ssl_allow_self_signed',
'ssl_cafile',
'ssl_local_cert',
'ssl_local_pk',
'ssl_passphrase',
];
if (empty($options['ssl_cafile'])) {
$options['ssl_cafile'] = CORE_PATH . 'config' . DIRECTORY_SEPARATOR . 'cacert.pem';
}
if (!empty($options['ssl_verify_host'])) {
$url = $request->getUri();
$host = parse_url($url, PHP_URL_HOST);
$this->_sslContextOptions['peer_name'] = $host;
}
foreach ($sslOptions as $key) {
if (isset($options[$key])) {
$name = substr($key, 4);
$this->_sslContextOptions[$name] = $options[$key];
}
}
}
/**
* Open the stream and send the request.
*
* @param \Cake\Http\Client\Request $request The request object.
* @return array Array of populated Response objects
* @throws \Cake\Http\Exception\HttpException
*/
protected function _send(Request $request)
{
$deadline = false;
if (isset($this->_contextOptions['timeout']) && $this->_contextOptions['timeout'] > 0) {
$deadline = time() + $this->_contextOptions['timeout'];
}
$url = $request->getUri();
$this->_open($url);
$content = '';
$timedOut = false;
while (!feof($this->_stream)) {
if ($deadline !== false) {
stream_set_timeout($this->_stream, max($deadline - time(), 1));
}
$content .= fread($this->_stream, 8192);
$meta = stream_get_meta_data($this->_stream);
if ($meta['timed_out'] || ($deadline !== false && time() > $deadline)) {
$timedOut = true;
break;
}
}
$meta = stream_get_meta_data($this->_stream);
fclose($this->_stream);
if ($timedOut) {
throw new HttpException('Connection timed out ' . $url, 504);
}
$headers = $meta['wrapper_data'];
if (isset($headers['headers']) && is_array($headers['headers'])) {
$headers = $headers['headers'];
}
return $this->createResponses($headers, $content);
}
/**
* Build a response object
*
* @param array $headers Unparsed headers.
* @param string $body The response body.
* @return \Cake\Http\Client\Response
*/
protected function _buildResponse($headers, $body)
{
return new Response($headers, $body);
}
/**
* Open the socket and handle any connection errors.
*
* @param string $url The url to connect to.
* @return void
* @throws \Cake\Core\Exception\Exception
*/
protected function _open($url)
{
set_error_handler(function ($code, $message) {
$this->_connectionErrors[] = $message;
});
try {
$this->_stream = fopen($url, 'rb', false, $this->_context);
} finally {
restore_error_handler();
}
if (!$this->_stream || !empty($this->_connectionErrors)) {
throw new Exception(implode("\n", $this->_connectionErrors));
}
}
/**
* Get the context options
*
* Useful for debugging and testing context creation.
*
* @return array
*/
public function contextOptions()
{
return array_merge($this->_contextOptions, $this->_sslContextOptions);
}
}
// @deprecated 3.4.0 Add backwards compat alias.
class_alias('Cake\Http\Client\Adapter\Stream', 'Cake\Network\Http\Adapter\Stream');