|
0
|
1 |
<?php |
|
|
2 |
/** |
|
|
3 |
* Simple and uniform HTTP request API. |
|
|
4 |
* |
|
|
5 |
* Standardizes the HTTP requests for WordPress. Handles cookies, gzip encoding and decoding, chunk |
|
|
6 |
* decoding, if HTTP 1.1 and various other difficult HTTP protocol implementations. |
|
|
7 |
* |
|
5
|
8 |
* @link https://core.trac.wordpress.org/ticket/4779 HTTP API Proposal |
|
0
|
9 |
* |
|
|
10 |
* @package WordPress |
|
|
11 |
* @subpackage HTTP |
|
|
12 |
* @since 2.7.0 |
|
|
13 |
*/ |
|
|
14 |
|
|
|
15 |
/** |
|
|
16 |
* WordPress HTTP Class for managing HTTP Transports and making HTTP requests. |
|
|
17 |
* |
|
|
18 |
* This class is used to consistently make outgoing HTTP requests easy for developers |
|
|
19 |
* while still being compatible with the many PHP configurations under which |
|
|
20 |
* WordPress runs. |
|
|
21 |
* |
|
|
22 |
* Debugging includes several actions, which pass different variables for debugging the HTTP API. |
|
|
23 |
* |
|
|
24 |
* @package WordPress |
|
|
25 |
* @subpackage HTTP |
|
|
26 |
* @since 2.7.0 |
|
|
27 |
*/ |
|
|
28 |
class WP_Http { |
|
|
29 |
|
|
|
30 |
/** |
|
5
|
31 |
* Send an HTTP request to a URI. |
|
0
|
32 |
* |
|
5
|
33 |
* Please note: The only URI that are supported in the HTTP Transport implementation |
|
|
34 |
* are the HTTP and HTTPS protocols. |
|
0
|
35 |
* |
|
|
36 |
* @access public |
|
|
37 |
* @since 2.7.0 |
|
|
38 |
* |
|
5
|
39 |
* @param string $url The request URL. |
|
|
40 |
* @param string|array $args { |
|
|
41 |
* Optional. Array or string of HTTP request arguments. |
|
|
42 |
* |
|
|
43 |
* @type string $method Request method. Accepts 'GET', 'POST', 'HEAD', or 'PUT'. |
|
|
44 |
* Some transports technically allow others, but should not be |
|
|
45 |
* assumed. Default 'GET'. |
|
|
46 |
* @type int $timeout How long the connection should stay open in seconds. Default 5. |
|
|
47 |
* @type int $redirection Number of allowed redirects. Not supported by all transports |
|
|
48 |
* Default 5. |
|
|
49 |
* @type string $httpversion Version of the HTTP protocol to use. Accepts '1.0' and '1.1'. |
|
|
50 |
* Default '1.0'. |
|
|
51 |
* @type string $user-agent User-agent value sent. |
|
|
52 |
* Default WordPress/' . $wp_version . '; ' . get_bloginfo( 'url' ). |
|
|
53 |
* @type bool $reject_unsafe_urls Whether to pass URLs through {@see wp_http_validate_url()}. |
|
|
54 |
* Default false. |
|
|
55 |
* @type bool $blocking Whether the calling code requires the result of the request. |
|
|
56 |
* If set to false, the request will be sent to the remote server, |
|
|
57 |
* and processing returned to the calling code immediately, the caller |
|
|
58 |
* will know if the request succeeded or failed, but will not receive |
|
|
59 |
* any response from the remote server. Default true. |
|
|
60 |
* @type string|array $headers Array or string of headers to send with the request. |
|
|
61 |
* Default empty array. |
|
|
62 |
* @type array $cookies List of cookies to send with the request. Default empty array. |
|
|
63 |
* @type string|array $body Body to send with the request. Default null. |
|
|
64 |
* @type bool $compress Whether to compress the $body when sending the request. |
|
|
65 |
* Default false. |
|
|
66 |
* @type bool $decompress Whether to decompress a compressed response. If set to false and |
|
|
67 |
* compressed content is returned in the response anyway, it will |
|
|
68 |
* need to be separately decompressed. Default true. |
|
|
69 |
* @type bool $sslverify Whether to verify SSL for the request. Default true. |
|
|
70 |
* @type string sslcertificates Absolute path to an SSL certificate .crt file. |
|
|
71 |
* Default ABSPATH . WPINC . '/certificates/ca-bundle.crt'. |
|
|
72 |
* @type bool $stream Whether to stream to a file. If set to true and no filename was |
|
|
73 |
* given, it will be droped it in the WP temp dir and its name will |
|
|
74 |
* be set using the basename of the URL. Default false. |
|
|
75 |
* @type string $filename Filename of the file to write to when streaming. $stream must be |
|
|
76 |
* set to true. Default null. |
|
|
77 |
* @type int $limit_response_size Size in bytes to limit the response to. Default null. |
|
|
78 |
* |
|
|
79 |
* } |
|
|
80 |
* @return array|WP_Error Array containing 'headers', 'body', 'response', 'cookies', 'filename'. |
|
|
81 |
* A WP_Error instance upon error. |
|
0
|
82 |
*/ |
|
5
|
83 |
public function request( $url, $args = array() ) { |
|
0
|
84 |
global $wp_version; |
|
|
85 |
|
|
|
86 |
$defaults = array( |
|
|
87 |
'method' => 'GET', |
|
5
|
88 |
/** |
|
|
89 |
* Filter the timeout value for an HTTP request. |
|
|
90 |
* |
|
|
91 |
* @since 2.7.0 |
|
|
92 |
* |
|
|
93 |
* @param int $timeout_value Time in seconds until a request times out. |
|
|
94 |
* Default 5. |
|
|
95 |
*/ |
|
|
96 |
'timeout' => apply_filters( 'http_request_timeout', 5 ), |
|
|
97 |
/** |
|
|
98 |
* Filter the number of redirects allowed during an HTTP request. |
|
|
99 |
* |
|
|
100 |
* @since 2.7.0 |
|
|
101 |
* |
|
|
102 |
* @param int $redirect_count Number of redirects allowed. Default 5. |
|
|
103 |
*/ |
|
|
104 |
'redirection' => apply_filters( 'http_request_redirection_count', 5 ), |
|
|
105 |
/** |
|
|
106 |
* Filter the version of the HTTP protocol used in a request. |
|
|
107 |
* |
|
|
108 |
* @since 2.7.0 |
|
|
109 |
* |
|
|
110 |
* @param string $version Version of HTTP used. Accepts '1.0' and '1.1'. |
|
|
111 |
* Default '1.0'. |
|
|
112 |
*/ |
|
|
113 |
'httpversion' => apply_filters( 'http_request_version', '1.0' ), |
|
|
114 |
/** |
|
|
115 |
* Filter the user agent value sent with an HTTP request. |
|
|
116 |
* |
|
|
117 |
* @since 2.7.0 |
|
|
118 |
* |
|
|
119 |
* @param string $user_agent WordPress user agent string. |
|
|
120 |
*/ |
|
0
|
121 |
'user-agent' => apply_filters( 'http_headers_useragent', 'WordPress/' . $wp_version . '; ' . get_bloginfo( 'url' ) ), |
|
5
|
122 |
/** |
|
|
123 |
* Filter whether to pass URLs through wp_http_validate_url() in an HTTP request. |
|
|
124 |
* |
|
|
125 |
* @since 3.6.0 |
|
|
126 |
* |
|
|
127 |
* @param bool $pass_url Whether to pass URLs through wp_http_validate_url(). |
|
|
128 |
* Default false. |
|
|
129 |
*/ |
|
0
|
130 |
'reject_unsafe_urls' => apply_filters( 'http_request_reject_unsafe_urls', false ), |
|
|
131 |
'blocking' => true, |
|
|
132 |
'headers' => array(), |
|
|
133 |
'cookies' => array(), |
|
|
134 |
'body' => null, |
|
|
135 |
'compress' => false, |
|
|
136 |
'decompress' => true, |
|
|
137 |
'sslverify' => true, |
|
|
138 |
'sslcertificates' => ABSPATH . WPINC . '/certificates/ca-bundle.crt', |
|
|
139 |
'stream' => false, |
|
|
140 |
'filename' => null, |
|
|
141 |
'limit_response_size' => null, |
|
|
142 |
); |
|
|
143 |
|
|
|
144 |
// Pre-parse for the HEAD checks. |
|
|
145 |
$args = wp_parse_args( $args ); |
|
|
146 |
|
|
|
147 |
// By default, Head requests do not cause redirections. |
|
|
148 |
if ( isset($args['method']) && 'HEAD' == $args['method'] ) |
|
|
149 |
$defaults['redirection'] = 0; |
|
|
150 |
|
|
|
151 |
$r = wp_parse_args( $args, $defaults ); |
|
5
|
152 |
/** |
|
|
153 |
* Filter the arguments used in an HTTP request. |
|
|
154 |
* |
|
|
155 |
* @since 2.7.0 |
|
|
156 |
* |
|
|
157 |
* @param array $r An array of HTTP request arguments. |
|
|
158 |
* @param string $url The request URL. |
|
|
159 |
*/ |
|
0
|
160 |
$r = apply_filters( 'http_request_args', $r, $url ); |
|
|
161 |
|
|
|
162 |
// The transports decrement this, store a copy of the original value for loop purposes. |
|
|
163 |
if ( ! isset( $r['_redirection'] ) ) |
|
|
164 |
$r['_redirection'] = $r['redirection']; |
|
|
165 |
|
|
5
|
166 |
/** |
|
|
167 |
* Filter whether to preempt an HTTP request's return. |
|
|
168 |
* |
|
|
169 |
* Returning a truthy value to the filter will short-circuit |
|
|
170 |
* the HTTP request and return early with that value. |
|
|
171 |
* |
|
|
172 |
* @since 2.9.0 |
|
|
173 |
* |
|
|
174 |
* @param bool $preempt Whether to preempt an HTTP request return. Default false. |
|
|
175 |
* @param array $r HTTP request arguments. |
|
|
176 |
* @param string $url The request URL. |
|
|
177 |
*/ |
|
0
|
178 |
$pre = apply_filters( 'pre_http_request', false, $r, $url ); |
|
|
179 |
if ( false !== $pre ) |
|
|
180 |
return $pre; |
|
|
181 |
|
|
|
182 |
if ( function_exists( 'wp_kses_bad_protocol' ) ) { |
|
|
183 |
if ( $r['reject_unsafe_urls'] ) |
|
|
184 |
$url = wp_http_validate_url( $url ); |
|
5
|
185 |
if ( $url ) { |
|
|
186 |
$url = wp_kses_bad_protocol( $url, array( 'http', 'https', 'ssl' ) ); |
|
|
187 |
} |
|
0
|
188 |
} |
|
|
189 |
|
|
|
190 |
$arrURL = @parse_url( $url ); |
|
|
191 |
|
|
|
192 |
if ( empty( $url ) || empty( $arrURL['scheme'] ) ) |
|
|
193 |
return new WP_Error('http_request_failed', __('A valid URL was not provided.')); |
|
|
194 |
|
|
|
195 |
if ( $this->block_request( $url ) ) |
|
|
196 |
return new WP_Error( 'http_request_failed', __( 'User has blocked requests through HTTP.' ) ); |
|
|
197 |
|
|
5
|
198 |
/* |
|
|
199 |
* Determine if this is a https call and pass that on to the transport functions |
|
|
200 |
* so that we can blacklist the transports that do not support ssl verification |
|
|
201 |
*/ |
|
0
|
202 |
$r['ssl'] = $arrURL['scheme'] == 'https' || $arrURL['scheme'] == 'ssl'; |
|
|
203 |
|
|
5
|
204 |
// Determine if this request is to OUR install of WordPress. |
|
0
|
205 |
$homeURL = parse_url( get_bloginfo( 'url' ) ); |
|
5
|
206 |
$r['local'] = 'localhost' == $arrURL['host'] || ( isset( $homeURL['host'] ) && $homeURL['host'] == $arrURL['host'] ); |
|
0
|
207 |
unset( $homeURL ); |
|
|
208 |
|
|
5
|
209 |
/* |
|
|
210 |
* If we are streaming to a file but no filename was given drop it in the WP temp dir |
|
|
211 |
* and pick its name using the basename of the $url. |
|
|
212 |
*/ |
|
|
213 |
if ( $r['stream'] && empty( $r['filename'] ) ) { |
|
|
214 |
$r['filename'] = wp_unique_filename( get_temp_dir(), basename( $url ) ); |
|
|
215 |
} |
|
0
|
216 |
|
|
5
|
217 |
/* |
|
|
218 |
* Force some settings if we are streaming to a file and check for existence and perms |
|
|
219 |
* of destination directory. |
|
|
220 |
*/ |
|
0
|
221 |
if ( $r['stream'] ) { |
|
|
222 |
$r['blocking'] = true; |
|
|
223 |
if ( ! wp_is_writable( dirname( $r['filename'] ) ) ) |
|
|
224 |
return new WP_Error( 'http_request_failed', __( 'Destination directory for file streaming does not exist or is not writable.' ) ); |
|
|
225 |
} |
|
|
226 |
|
|
|
227 |
if ( is_null( $r['headers'] ) ) |
|
|
228 |
$r['headers'] = array(); |
|
|
229 |
|
|
|
230 |
if ( ! is_array( $r['headers'] ) ) { |
|
5
|
231 |
$processedHeaders = self::processHeaders( $r['headers'], $url ); |
|
0
|
232 |
$r['headers'] = $processedHeaders['headers']; |
|
|
233 |
} |
|
|
234 |
|
|
|
235 |
if ( isset( $r['headers']['User-Agent'] ) ) { |
|
|
236 |
$r['user-agent'] = $r['headers']['User-Agent']; |
|
|
237 |
unset( $r['headers']['User-Agent'] ); |
|
|
238 |
} |
|
|
239 |
|
|
|
240 |
if ( isset( $r['headers']['user-agent'] ) ) { |
|
|
241 |
$r['user-agent'] = $r['headers']['user-agent']; |
|
|
242 |
unset( $r['headers']['user-agent'] ); |
|
|
243 |
} |
|
|
244 |
|
|
|
245 |
if ( '1.1' == $r['httpversion'] && !isset( $r['headers']['connection'] ) ) { |
|
|
246 |
$r['headers']['connection'] = 'close'; |
|
|
247 |
} |
|
|
248 |
|
|
5
|
249 |
// Construct Cookie: header if any cookies are set. |
|
|
250 |
self::buildCookieHeader( $r ); |
|
0
|
251 |
|
|
5
|
252 |
// Avoid issues where mbstring.func_overload is enabled. |
|
0
|
253 |
mbstring_binary_safe_encoding(); |
|
|
254 |
|
|
|
255 |
if ( ! isset( $r['headers']['Accept-Encoding'] ) ) { |
|
|
256 |
if ( $encoding = WP_Http_Encoding::accept_encoding( $url, $r ) ) |
|
|
257 |
$r['headers']['Accept-Encoding'] = $encoding; |
|
|
258 |
} |
|
|
259 |
|
|
|
260 |
if ( ( ! is_null( $r['body'] ) && '' != $r['body'] ) || 'POST' == $r['method'] || 'PUT' == $r['method'] ) { |
|
|
261 |
if ( is_array( $r['body'] ) || is_object( $r['body'] ) ) { |
|
|
262 |
$r['body'] = http_build_query( $r['body'], null, '&' ); |
|
|
263 |
|
|
|
264 |
if ( ! isset( $r['headers']['Content-Type'] ) ) |
|
|
265 |
$r['headers']['Content-Type'] = 'application/x-www-form-urlencoded; charset=' . get_option( 'blog_charset' ); |
|
|
266 |
} |
|
|
267 |
|
|
|
268 |
if ( '' === $r['body'] ) |
|
|
269 |
$r['body'] = null; |
|
|
270 |
|
|
|
271 |
if ( ! isset( $r['headers']['Content-Length'] ) && ! isset( $r['headers']['content-length'] ) ) |
|
|
272 |
$r['headers']['Content-Length'] = strlen( $r['body'] ); |
|
|
273 |
} |
|
|
274 |
|
|
|
275 |
$response = $this->_dispatch_request( $url, $r ); |
|
|
276 |
|
|
|
277 |
reset_mbstring_encoding(); |
|
|
278 |
|
|
|
279 |
if ( is_wp_error( $response ) ) |
|
|
280 |
return $response; |
|
|
281 |
|
|
|
282 |
// Append cookies that were used in this request to the response |
|
|
283 |
if ( ! empty( $r['cookies'] ) ) { |
|
|
284 |
$cookies_set = wp_list_pluck( $response['cookies'], 'name' ); |
|
|
285 |
foreach ( $r['cookies'] as $cookie ) { |
|
|
286 |
if ( ! in_array( $cookie->name, $cookies_set ) && $cookie->test( $url ) ) { |
|
|
287 |
$response['cookies'][] = $cookie; |
|
|
288 |
} |
|
|
289 |
} |
|
|
290 |
} |
|
|
291 |
|
|
|
292 |
return $response; |
|
|
293 |
} |
|
|
294 |
|
|
|
295 |
/** |
|
|
296 |
* Tests which transports are capable of supporting the request. |
|
|
297 |
* |
|
|
298 |
* @since 3.2.0 |
|
|
299 |
* @access private |
|
|
300 |
* |
|
|
301 |
* @param array $args Request arguments |
|
|
302 |
* @param string $url URL to Request |
|
|
303 |
* |
|
5
|
304 |
* @return string|false Class name for the first transport that claims to support the request. False if no transport claims to support the request. |
|
0
|
305 |
*/ |
|
|
306 |
public function _get_first_available_transport( $args, $url = null ) { |
|
5
|
307 |
/** |
|
|
308 |
* Filter which HTTP transports are available and in what order. |
|
|
309 |
* |
|
|
310 |
* @since 3.7.0 |
|
|
311 |
* |
|
|
312 |
* @param array $value Array of HTTP transports to check. Default array contains |
|
|
313 |
* 'curl', and 'streams', in that order. |
|
|
314 |
* @param array $args HTTP request arguments. |
|
|
315 |
* @param string $url The URL to request. |
|
|
316 |
*/ |
|
0
|
317 |
$request_order = apply_filters( 'http_api_transports', array( 'curl', 'streams' ), $args, $url ); |
|
|
318 |
|
|
5
|
319 |
// Loop over each transport on each HTTP request looking for one which will serve this request's needs. |
|
0
|
320 |
foreach ( $request_order as $transport ) { |
|
|
321 |
$class = 'WP_HTTP_' . $transport; |
|
|
322 |
|
|
5
|
323 |
// Check to see if this transport is a possibility, calls the transport statically. |
|
0
|
324 |
if ( !call_user_func( array( $class, 'test' ), $args, $url ) ) |
|
|
325 |
continue; |
|
|
326 |
|
|
|
327 |
return $class; |
|
|
328 |
} |
|
|
329 |
|
|
|
330 |
return false; |
|
|
331 |
} |
|
|
332 |
|
|
|
333 |
/** |
|
|
334 |
* Dispatches a HTTP request to a supporting transport. |
|
|
335 |
* |
|
|
336 |
* Tests each transport in order to find a transport which matches the request arguments. |
|
|
337 |
* Also caches the transport instance to be used later. |
|
|
338 |
* |
|
|
339 |
* The order for requests is cURL, and then PHP Streams. |
|
|
340 |
* |
|
|
341 |
* @since 3.2.0 |
|
|
342 |
* @access private |
|
|
343 |
* |
|
|
344 |
* @param string $url URL to Request |
|
|
345 |
* @param array $args Request arguments |
|
5
|
346 |
* @return array|WP_Error Array containing 'headers', 'body', 'response', 'cookies', 'filename'. A WP_Error instance upon error |
|
0
|
347 |
*/ |
|
|
348 |
private function _dispatch_request( $url, $args ) { |
|
|
349 |
static $transports = array(); |
|
|
350 |
|
|
|
351 |
$class = $this->_get_first_available_transport( $args, $url ); |
|
|
352 |
if ( !$class ) |
|
|
353 |
return new WP_Error( 'http_failure', __( 'There are no HTTP transports available which can complete the requested request.' ) ); |
|
|
354 |
|
|
|
355 |
// Transport claims to support request, instantiate it and give it a whirl. |
|
|
356 |
if ( empty( $transports[$class] ) ) |
|
|
357 |
$transports[$class] = new $class; |
|
|
358 |
|
|
|
359 |
$response = $transports[$class]->request( $url, $args ); |
|
|
360 |
|
|
5
|
361 |
/** |
|
|
362 |
* Fires after an HTTP API response is received and before the response is returned. |
|
|
363 |
* |
|
|
364 |
* @since 2.8.0 |
|
|
365 |
* |
|
|
366 |
* @param array|WP_Error $response HTTP response or WP_Error object. |
|
|
367 |
* @param string $context Context under which the hook is fired. |
|
|
368 |
* @param string $class HTTP transport used. |
|
|
369 |
* @param array $args HTTP request arguments. |
|
|
370 |
* @param string $url The request URL. |
|
|
371 |
*/ |
|
0
|
372 |
do_action( 'http_api_debug', $response, 'response', $class, $args, $url ); |
|
|
373 |
|
|
|
374 |
if ( is_wp_error( $response ) ) |
|
|
375 |
return $response; |
|
|
376 |
|
|
5
|
377 |
/** |
|
|
378 |
* Filter the HTTP API response immediately before the response is returned. |
|
|
379 |
* |
|
|
380 |
* @since 2.9.0 |
|
|
381 |
* |
|
|
382 |
* @param array $response HTTP response. |
|
|
383 |
* @param array $args HTTP request arguments. |
|
|
384 |
* @param string $url The request URL. |
|
|
385 |
*/ |
|
0
|
386 |
return apply_filters( 'http_response', $response, $args, $url ); |
|
|
387 |
} |
|
|
388 |
|
|
|
389 |
/** |
|
|
390 |
* Uses the POST HTTP method. |
|
|
391 |
* |
|
|
392 |
* Used for sending data that is expected to be in the body. |
|
|
393 |
* |
|
|
394 |
* @access public |
|
|
395 |
* @since 2.7.0 |
|
|
396 |
* |
|
5
|
397 |
* @param string $url The request URL. |
|
|
398 |
* @param string|array $args Optional. Override the defaults. |
|
|
399 |
* @return array|WP_Error Array containing 'headers', 'body', 'response', 'cookies', 'filename'. A WP_Error instance upon error |
|
0
|
400 |
*/ |
|
5
|
401 |
public function post($url, $args = array()) { |
|
0
|
402 |
$defaults = array('method' => 'POST'); |
|
|
403 |
$r = wp_parse_args( $args, $defaults ); |
|
|
404 |
return $this->request($url, $r); |
|
|
405 |
} |
|
|
406 |
|
|
|
407 |
/** |
|
|
408 |
* Uses the GET HTTP method. |
|
|
409 |
* |
|
|
410 |
* Used for sending data that is expected to be in the body. |
|
|
411 |
* |
|
|
412 |
* @access public |
|
|
413 |
* @since 2.7.0 |
|
|
414 |
* |
|
5
|
415 |
* @param string $url The request URL. |
|
|
416 |
* @param string|array $args Optional. Override the defaults. |
|
|
417 |
* @return array|WP_Error Array containing 'headers', 'body', 'response', 'cookies', 'filename'. A WP_Error instance upon error |
|
0
|
418 |
*/ |
|
5
|
419 |
public function get($url, $args = array()) { |
|
0
|
420 |
$defaults = array('method' => 'GET'); |
|
|
421 |
$r = wp_parse_args( $args, $defaults ); |
|
|
422 |
return $this->request($url, $r); |
|
|
423 |
} |
|
|
424 |
|
|
|
425 |
/** |
|
|
426 |
* Uses the HEAD HTTP method. |
|
|
427 |
* |
|
|
428 |
* Used for sending data that is expected to be in the body. |
|
|
429 |
* |
|
|
430 |
* @access public |
|
|
431 |
* @since 2.7.0 |
|
|
432 |
* |
|
5
|
433 |
* @param string $url The request URL. |
|
|
434 |
* @param string|array $args Optional. Override the defaults. |
|
|
435 |
* @return array|WP_Error Array containing 'headers', 'body', 'response', 'cookies', 'filename'. A WP_Error instance upon error |
|
0
|
436 |
*/ |
|
5
|
437 |
public function head($url, $args = array()) { |
|
0
|
438 |
$defaults = array('method' => 'HEAD'); |
|
|
439 |
$r = wp_parse_args( $args, $defaults ); |
|
|
440 |
return $this->request($url, $r); |
|
|
441 |
} |
|
|
442 |
|
|
|
443 |
/** |
|
|
444 |
* Parses the responses and splits the parts into headers and body. |
|
|
445 |
* |
|
|
446 |
* @access public |
|
|
447 |
* @static |
|
|
448 |
* @since 2.7.0 |
|
|
449 |
* |
|
|
450 |
* @param string $strResponse The full response string |
|
|
451 |
* @return array Array with 'headers' and 'body' keys. |
|
|
452 |
*/ |
|
|
453 |
public static function processResponse($strResponse) { |
|
|
454 |
$res = explode("\r\n\r\n", $strResponse, 2); |
|
|
455 |
|
|
|
456 |
return array('headers' => $res[0], 'body' => isset($res[1]) ? $res[1] : ''); |
|
|
457 |
} |
|
|
458 |
|
|
|
459 |
/** |
|
|
460 |
* Transform header string into an array. |
|
|
461 |
* |
|
|
462 |
* If an array is given then it is assumed to be raw header data with numeric keys with the |
|
|
463 |
* headers as the values. No headers must be passed that were already processed. |
|
|
464 |
* |
|
|
465 |
* @access public |
|
|
466 |
* @static |
|
|
467 |
* @since 2.7.0 |
|
|
468 |
* |
|
|
469 |
* @param string|array $headers |
|
|
470 |
* @param string $url The URL that was requested |
|
|
471 |
* @return array Processed string headers. If duplicate headers are encountered, |
|
|
472 |
* Then a numbered array is returned as the value of that header-key. |
|
|
473 |
*/ |
|
|
474 |
public static function processHeaders( $headers, $url = '' ) { |
|
5
|
475 |
// Split headers, one per array element. |
|
0
|
476 |
if ( is_string($headers) ) { |
|
5
|
477 |
// Tolerate line terminator: CRLF = LF (RFC 2616 19.3). |
|
0
|
478 |
$headers = str_replace("\r\n", "\n", $headers); |
|
5
|
479 |
/* |
|
|
480 |
* Unfold folded header fields. LWS = [CRLF] 1*( SP | HT ) <US-ASCII SP, space (32)>, |
|
|
481 |
* <US-ASCII HT, horizontal-tab (9)> (RFC 2616 2.2). |
|
|
482 |
*/ |
|
0
|
483 |
$headers = preg_replace('/\n[ \t]/', ' ', $headers); |
|
5
|
484 |
// Create the headers array. |
|
0
|
485 |
$headers = explode("\n", $headers); |
|
|
486 |
} |
|
|
487 |
|
|
|
488 |
$response = array('code' => 0, 'message' => ''); |
|
|
489 |
|
|
5
|
490 |
/* |
|
|
491 |
* If a redirection has taken place, The headers for each page request may have been passed. |
|
|
492 |
* In this case, determine the final HTTP header and parse from there. |
|
|
493 |
*/ |
|
0
|
494 |
for ( $i = count($headers)-1; $i >= 0; $i-- ) { |
|
|
495 |
if ( !empty($headers[$i]) && false === strpos($headers[$i], ':') ) { |
|
|
496 |
$headers = array_splice($headers, $i); |
|
|
497 |
break; |
|
|
498 |
} |
|
|
499 |
} |
|
|
500 |
|
|
|
501 |
$cookies = array(); |
|
|
502 |
$newheaders = array(); |
|
|
503 |
foreach ( (array) $headers as $tempheader ) { |
|
|
504 |
if ( empty($tempheader) ) |
|
|
505 |
continue; |
|
|
506 |
|
|
|
507 |
if ( false === strpos($tempheader, ':') ) { |
|
|
508 |
$stack = explode(' ', $tempheader, 3); |
|
|
509 |
$stack[] = ''; |
|
|
510 |
list( , $response['code'], $response['message']) = $stack; |
|
|
511 |
continue; |
|
|
512 |
} |
|
|
513 |
|
|
|
514 |
list($key, $value) = explode(':', $tempheader, 2); |
|
|
515 |
|
|
|
516 |
$key = strtolower( $key ); |
|
|
517 |
$value = trim( $value ); |
|
|
518 |
|
|
|
519 |
if ( isset( $newheaders[ $key ] ) ) { |
|
|
520 |
if ( ! is_array( $newheaders[ $key ] ) ) |
|
|
521 |
$newheaders[$key] = array( $newheaders[ $key ] ); |
|
|
522 |
$newheaders[ $key ][] = $value; |
|
|
523 |
} else { |
|
|
524 |
$newheaders[ $key ] = $value; |
|
|
525 |
} |
|
|
526 |
if ( 'set-cookie' == $key ) |
|
|
527 |
$cookies[] = new WP_Http_Cookie( $value, $url ); |
|
|
528 |
} |
|
|
529 |
|
|
5
|
530 |
// Cast the Response Code to an int |
|
|
531 |
$response['code'] = intval( $response['code'] ); |
|
|
532 |
|
|
0
|
533 |
return array('response' => $response, 'headers' => $newheaders, 'cookies' => $cookies); |
|
|
534 |
} |
|
|
535 |
|
|
|
536 |
/** |
|
|
537 |
* Takes the arguments for a ::request() and checks for the cookie array. |
|
|
538 |
* |
|
|
539 |
* If it's found, then it upgrades any basic name => value pairs to WP_Http_Cookie instances, |
|
|
540 |
* which are each parsed into strings and added to the Cookie: header (within the arguments array). |
|
|
541 |
* Edits the array by reference. |
|
|
542 |
* |
|
|
543 |
* @access public |
|
|
544 |
* @version 2.8.0 |
|
|
545 |
* @static |
|
|
546 |
* |
|
|
547 |
* @param array $r Full array of args passed into ::request() |
|
|
548 |
*/ |
|
|
549 |
public static function buildCookieHeader( &$r ) { |
|
|
550 |
if ( ! empty($r['cookies']) ) { |
|
5
|
551 |
// Upgrade any name => value cookie pairs to WP_HTTP_Cookie instances. |
|
0
|
552 |
foreach ( $r['cookies'] as $name => $value ) { |
|
|
553 |
if ( ! is_object( $value ) ) |
|
|
554 |
$r['cookies'][ $name ] = new WP_HTTP_Cookie( array( 'name' => $name, 'value' => $value ) ); |
|
|
555 |
} |
|
|
556 |
|
|
|
557 |
$cookies_header = ''; |
|
|
558 |
foreach ( (array) $r['cookies'] as $cookie ) { |
|
|
559 |
$cookies_header .= $cookie->getHeaderValue() . '; '; |
|
|
560 |
} |
|
|
561 |
|
|
|
562 |
$cookies_header = substr( $cookies_header, 0, -2 ); |
|
|
563 |
$r['headers']['cookie'] = $cookies_header; |
|
|
564 |
} |
|
|
565 |
} |
|
|
566 |
|
|
|
567 |
/** |
|
|
568 |
* Decodes chunk transfer-encoding, based off the HTTP 1.1 specification. |
|
|
569 |
* |
|
|
570 |
* Based off the HTTP http_encoding_dechunk function. |
|
|
571 |
* |
|
|
572 |
* @link http://tools.ietf.org/html/rfc2616#section-19.4.6 Process for chunked decoding. |
|
|
573 |
* |
|
|
574 |
* @access public |
|
|
575 |
* @since 2.7.0 |
|
|
576 |
* @static |
|
|
577 |
* |
|
|
578 |
* @param string $body Body content |
|
|
579 |
* @return string Chunked decoded body on success or raw body on failure. |
|
|
580 |
*/ |
|
|
581 |
public static function chunkTransferDecode( $body ) { |
|
|
582 |
// The body is not chunked encoded or is malformed. |
|
|
583 |
if ( ! preg_match( '/^([0-9a-f]+)[^\r\n]*\r\n/i', trim( $body ) ) ) |
|
|
584 |
return $body; |
|
|
585 |
|
|
|
586 |
$parsed_body = ''; |
|
5
|
587 |
|
|
|
588 |
// We'll be altering $body, so need a backup in case of error. |
|
|
589 |
$body_original = $body; |
|
0
|
590 |
|
|
|
591 |
while ( true ) { |
|
|
592 |
$has_chunk = (bool) preg_match( '/^([0-9a-f]+)[^\r\n]*\r\n/i', $body, $match ); |
|
|
593 |
if ( ! $has_chunk || empty( $match[1] ) ) |
|
|
594 |
return $body_original; |
|
|
595 |
|
|
|
596 |
$length = hexdec( $match[1] ); |
|
|
597 |
$chunk_length = strlen( $match[0] ); |
|
|
598 |
|
|
5
|
599 |
// Parse out the chunk of data. |
|
0
|
600 |
$parsed_body .= substr( $body, $chunk_length, $length ); |
|
|
601 |
|
|
5
|
602 |
// Remove the chunk from the raw data. |
|
0
|
603 |
$body = substr( $body, $length + $chunk_length ); |
|
|
604 |
|
|
5
|
605 |
// End of the document. |
|
0
|
606 |
if ( '0' === trim( $body ) ) |
|
|
607 |
return $parsed_body; |
|
|
608 |
} |
|
|
609 |
} |
|
|
610 |
|
|
|
611 |
/** |
|
|
612 |
* Block requests through the proxy. |
|
|
613 |
* |
|
|
614 |
* Those who are behind a proxy and want to prevent access to certain hosts may do so. This will |
|
|
615 |
* prevent plugins from working and core functionality, if you don't include api.wordpress.org. |
|
|
616 |
* |
|
|
617 |
* You block external URL requests by defining WP_HTTP_BLOCK_EXTERNAL as true in your wp-config.php |
|
|
618 |
* file and this will only allow localhost and your blog to make requests. The constant |
|
|
619 |
* WP_ACCESSIBLE_HOSTS will allow additional hosts to go through for requests. The format of the |
|
|
620 |
* WP_ACCESSIBLE_HOSTS constant is a comma separated list of hostnames to allow, wildcard domains |
|
|
621 |
* are supported, eg *.wordpress.org will allow for all subdomains of wordpress.org to be contacted. |
|
|
622 |
* |
|
|
623 |
* @since 2.8.0 |
|
5
|
624 |
* @link https://core.trac.wordpress.org/ticket/8927 Allow preventing external requests. |
|
|
625 |
* @link https://core.trac.wordpress.org/ticket/14636 Allow wildcard domains in WP_ACCESSIBLE_HOSTS |
|
0
|
626 |
* |
|
|
627 |
* @param string $uri URI of url. |
|
|
628 |
* @return bool True to block, false to allow. |
|
|
629 |
*/ |
|
5
|
630 |
public function block_request($uri) { |
|
0
|
631 |
// We don't need to block requests, because nothing is blocked. |
|
|
632 |
if ( ! defined( 'WP_HTTP_BLOCK_EXTERNAL' ) || ! WP_HTTP_BLOCK_EXTERNAL ) |
|
|
633 |
return false; |
|
|
634 |
|
|
|
635 |
$check = parse_url($uri); |
|
|
636 |
if ( ! $check ) |
|
|
637 |
return true; |
|
|
638 |
|
|
|
639 |
$home = parse_url( get_option('siteurl') ); |
|
|
640 |
|
|
5
|
641 |
// Don't block requests back to ourselves by default. |
|
|
642 |
if ( 'localhost' == $check['host'] || ( isset( $home['host'] ) && $home['host'] == $check['host'] ) ) { |
|
|
643 |
/** |
|
|
644 |
* Filter whether to block local requests through the proxy. |
|
|
645 |
* |
|
|
646 |
* @since 2.8.0 |
|
|
647 |
* |
|
|
648 |
* @param bool $block Whether to block local requests through proxy. |
|
|
649 |
* Default false. |
|
|
650 |
*/ |
|
|
651 |
return apply_filters( 'block_local_requests', false ); |
|
|
652 |
} |
|
0
|
653 |
|
|
|
654 |
if ( !defined('WP_ACCESSIBLE_HOSTS') ) |
|
|
655 |
return true; |
|
|
656 |
|
|
|
657 |
static $accessible_hosts; |
|
|
658 |
static $wildcard_regex = false; |
|
|
659 |
if ( null == $accessible_hosts ) { |
|
|
660 |
$accessible_hosts = preg_split('|,\s*|', WP_ACCESSIBLE_HOSTS); |
|
|
661 |
|
|
|
662 |
if ( false !== strpos(WP_ACCESSIBLE_HOSTS, '*') ) { |
|
|
663 |
$wildcard_regex = array(); |
|
|
664 |
foreach ( $accessible_hosts as $host ) |
|
|
665 |
$wildcard_regex[] = str_replace( '\*', '.+', preg_quote( $host, '/' ) ); |
|
|
666 |
$wildcard_regex = '/^(' . implode('|', $wildcard_regex) . ')$/i'; |
|
|
667 |
} |
|
|
668 |
} |
|
|
669 |
|
|
|
670 |
if ( !empty($wildcard_regex) ) |
|
|
671 |
return !preg_match($wildcard_regex, $check['host']); |
|
|
672 |
else |
|
|
673 |
return !in_array( $check['host'], $accessible_hosts ); //Inverse logic, If it's in the array, then we can't access it. |
|
|
674 |
|
|
|
675 |
} |
|
|
676 |
|
|
5
|
677 |
/** |
|
|
678 |
* A wrapper for PHP's parse_url() function that handles edgecases in < PHP 5.4.7 |
|
|
679 |
* |
|
|
680 |
* PHP 5.4.7 expanded parse_url()'s ability to handle non-absolute url's, including |
|
|
681 |
* schemeless and relative url's with :// in the path, this works around those |
|
|
682 |
* limitations providing a standard output on PHP 5.2~5.4+. |
|
|
683 |
* |
|
|
684 |
* Error suppression is used as prior to PHP 5.3.3, an E_WARNING would be generated |
|
|
685 |
* when URL parsing failed. |
|
|
686 |
* |
|
|
687 |
* @since 4.1.0 |
|
|
688 |
* @access protected |
|
|
689 |
* |
|
|
690 |
* @param string $url The URL to parse. |
|
|
691 |
* @return bool|array False on failure; Array of URL components on success; |
|
|
692 |
* See parse_url()'s return values. |
|
|
693 |
*/ |
|
|
694 |
protected static function parse_url( $url ) { |
|
|
695 |
$parts = @parse_url( $url ); |
|
|
696 |
if ( ! $parts ) { |
|
|
697 |
// < PHP 5.4.7 compat, trouble with relative paths including a scheme break in the path |
|
|
698 |
if ( '/' == $url[0] && false !== strpos( $url, '://' ) ) { |
|
|
699 |
// Since we know it's a relative path, prefix with a scheme/host placeholder and try again |
|
|
700 |
if ( ! $parts = @parse_url( 'placeholder://placeholder' . $url ) ) { |
|
|
701 |
return $parts; |
|
|
702 |
} |
|
|
703 |
// Remove the placeholder values |
|
|
704 |
unset( $parts['scheme'], $parts['host'] ); |
|
|
705 |
} else { |
|
|
706 |
return $parts; |
|
|
707 |
} |
|
|
708 |
} |
|
|
709 |
|
|
|
710 |
// < PHP 5.4.7 compat, doesn't detect schemeless URL's host field |
|
|
711 |
if ( '//' == substr( $url, 0, 2 ) && ! isset( $parts['host'] ) ) { |
|
|
712 |
list( $parts['host'], $slashless_path ) = explode( '/', substr( $parts['path'], 2 ), 2 ); |
|
|
713 |
$parts['path'] = "/{$slashless_path}"; |
|
|
714 |
} |
|
|
715 |
|
|
|
716 |
return $parts; |
|
|
717 |
} |
|
|
718 |
|
|
|
719 |
/** |
|
|
720 |
* Converts a relative URL to an absolute URL relative to a given URL. |
|
|
721 |
* |
|
|
722 |
* If an Absolute URL is provided, no processing of that URL is done. |
|
|
723 |
* |
|
|
724 |
* @since 3.4.0 |
|
|
725 |
* |
|
|
726 |
* @access public |
|
|
727 |
* @param string $maybe_relative_path The URL which might be relative |
|
|
728 |
* @param string $url The URL which $maybe_relative_path is relative to |
|
|
729 |
* @return string An Absolute URL, in a failure condition where the URL cannot be parsed, the relative URL will be returned. |
|
|
730 |
*/ |
|
|
731 |
public static function make_absolute_url( $maybe_relative_path, $url ) { |
|
0
|
732 |
if ( empty( $url ) ) |
|
|
733 |
return $maybe_relative_path; |
|
|
734 |
|
|
5
|
735 |
if ( ! $url_parts = WP_HTTP::parse_url( $url ) ) { |
|
|
736 |
return $maybe_relative_path; |
|
|
737 |
} |
|
|
738 |
|
|
|
739 |
if ( ! $relative_url_parts = WP_HTTP::parse_url( $maybe_relative_path ) ) { |
|
0
|
740 |
return $maybe_relative_path; |
|
5
|
741 |
} |
|
0
|
742 |
|
|
5
|
743 |
// Check for a scheme on the 'relative' url |
|
|
744 |
if ( ! empty( $relative_url_parts['scheme'] ) ) { |
|
0
|
745 |
return $maybe_relative_path; |
|
5
|
746 |
} |
|
0
|
747 |
|
|
5
|
748 |
$absolute_path = $url_parts['scheme'] . '://'; |
|
0
|
749 |
|
|
5
|
750 |
// Schemeless URL's will make it this far, so we check for a host in the relative url and convert it to a protocol-url |
|
|
751 |
if ( isset( $relative_url_parts['host'] ) ) { |
|
|
752 |
$absolute_path .= $relative_url_parts['host']; |
|
|
753 |
if ( isset( $relative_url_parts['port'] ) ) |
|
|
754 |
$absolute_path .= ':' . $relative_url_parts['port']; |
|
|
755 |
} else { |
|
|
756 |
$absolute_path .= $url_parts['host']; |
|
|
757 |
if ( isset( $url_parts['port'] ) ) |
|
|
758 |
$absolute_path .= ':' . $url_parts['port']; |
|
|
759 |
} |
|
0
|
760 |
|
|
5
|
761 |
// Start off with the Absolute URL path. |
|
0
|
762 |
$path = ! empty( $url_parts['path'] ) ? $url_parts['path'] : '/'; |
|
|
763 |
|
|
5
|
764 |
// If it's a root-relative path, then great. |
|
0
|
765 |
if ( ! empty( $relative_url_parts['path'] ) && '/' == $relative_url_parts['path'][0] ) { |
|
|
766 |
$path = $relative_url_parts['path']; |
|
|
767 |
|
|
5
|
768 |
// Else it's a relative path. |
|
0
|
769 |
} elseif ( ! empty( $relative_url_parts['path'] ) ) { |
|
5
|
770 |
// Strip off any file components from the absolute path. |
|
0
|
771 |
$path = substr( $path, 0, strrpos( $path, '/' ) + 1 ); |
|
|
772 |
|
|
5
|
773 |
// Build the new path. |
|
0
|
774 |
$path .= $relative_url_parts['path']; |
|
|
775 |
|
|
5
|
776 |
// Strip all /path/../ out of the path. |
|
0
|
777 |
while ( strpos( $path, '../' ) > 1 ) { |
|
|
778 |
$path = preg_replace( '![^/]+/\.\./!', '', $path ); |
|
|
779 |
} |
|
|
780 |
|
|
5
|
781 |
// Strip any final leading ../ from the path. |
|
0
|
782 |
$path = preg_replace( '!^/(\.\./)+!', '', $path ); |
|
|
783 |
} |
|
|
784 |
|
|
5
|
785 |
// Add the Query string. |
|
0
|
786 |
if ( ! empty( $relative_url_parts['query'] ) ) |
|
|
787 |
$path .= '?' . $relative_url_parts['query']; |
|
|
788 |
|
|
|
789 |
return $absolute_path . '/' . ltrim( $path, '/' ); |
|
|
790 |
} |
|
|
791 |
|
|
|
792 |
/** |
|
|
793 |
* Handles HTTP Redirects and follows them if appropriate. |
|
|
794 |
* |
|
|
795 |
* @since 3.7.0 |
|
|
796 |
* |
|
|
797 |
* @param string $url The URL which was requested. |
|
5
|
798 |
* @param array $args The Arguments which were used to make the request. |
|
0
|
799 |
* @param array $response The Response of the HTTP request. |
|
|
800 |
* @return false|object False if no redirect is present, a WP_HTTP or WP_Error result otherwise. |
|
|
801 |
*/ |
|
5
|
802 |
public static function handle_redirects( $url, $args, $response ) { |
|
0
|
803 |
// If no redirects are present, or, redirects were not requested, perform no action. |
|
|
804 |
if ( ! isset( $response['headers']['location'] ) || 0 === $args['_redirection'] ) |
|
|
805 |
return false; |
|
|
806 |
|
|
5
|
807 |
// Only perform redirections on redirection http codes. |
|
0
|
808 |
if ( $response['response']['code'] > 399 || $response['response']['code'] < 300 ) |
|
|
809 |
return false; |
|
|
810 |
|
|
5
|
811 |
// Don't redirect if we've run out of redirects. |
|
0
|
812 |
if ( $args['redirection']-- <= 0 ) |
|
|
813 |
return new WP_Error( 'http_request_failed', __('Too many redirects.') ); |
|
|
814 |
|
|
|
815 |
$redirect_location = $response['headers']['location']; |
|
|
816 |
|
|
5
|
817 |
// If there were multiple Location headers, use the last header specified. |
|
0
|
818 |
if ( is_array( $redirect_location ) ) |
|
|
819 |
$redirect_location = array_pop( $redirect_location ); |
|
|
820 |
|
|
|
821 |
$redirect_location = WP_HTTP::make_absolute_url( $redirect_location, $url ); |
|
|
822 |
|
|
5
|
823 |
// POST requests should not POST to a redirected location. |
|
0
|
824 |
if ( 'POST' == $args['method'] ) { |
|
|
825 |
if ( in_array( $response['response']['code'], array( 302, 303 ) ) ) |
|
|
826 |
$args['method'] = 'GET'; |
|
|
827 |
} |
|
|
828 |
|
|
5
|
829 |
// Include valid cookies in the redirect process. |
|
0
|
830 |
if ( ! empty( $response['cookies'] ) ) { |
|
|
831 |
foreach ( $response['cookies'] as $cookie ) { |
|
|
832 |
if ( $cookie->test( $redirect_location ) ) |
|
|
833 |
$args['cookies'][] = $cookie; |
|
|
834 |
} |
|
|
835 |
} |
|
|
836 |
|
|
|
837 |
return wp_remote_request( $redirect_location, $args ); |
|
|
838 |
} |
|
|
839 |
|
|
|
840 |
/** |
|
|
841 |
* Determines if a specified string represents an IP address or not. |
|
|
842 |
* |
|
|
843 |
* This function also detects the type of the IP address, returning either |
|
|
844 |
* '4' or '6' to represent a IPv4 and IPv6 address respectively. |
|
|
845 |
* This does not verify if the IP is a valid IP, only that it appears to be |
|
|
846 |
* an IP address. |
|
|
847 |
* |
|
|
848 |
* @see http://home.deds.nl/~aeron/regex/ for IPv6 regex |
|
|
849 |
* |
|
|
850 |
* @since 3.7.0 |
|
|
851 |
* @static |
|
|
852 |
* |
|
|
853 |
* @param string $maybe_ip A suspected IP address |
|
|
854 |
* @return integer|bool Upon success, '4' or '6' to represent a IPv4 or IPv6 address, false upon failure |
|
|
855 |
*/ |
|
5
|
856 |
public static function is_ip_address( $maybe_ip ) { |
|
0
|
857 |
if ( preg_match( '/^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$/', $maybe_ip ) ) |
|
|
858 |
return 4; |
|
|
859 |
|
|
|
860 |
if ( false !== strpos( $maybe_ip, ':' ) && preg_match( '/^(((?=.*(::))(?!.*\3.+\3))\3?|([\dA-F]{1,4}(\3|:\b|$)|\2))(?4){5}((?4){2}|(((2[0-4]|1\d|[1-9])?\d|25[0-5])\.?\b){4})$/i', trim( $maybe_ip, ' []' ) ) ) |
|
|
861 |
return 6; |
|
|
862 |
|
|
|
863 |
return false; |
|
|
864 |
} |
|
|
865 |
|
|
|
866 |
} |
|
|
867 |
|
|
|
868 |
/** |
|
|
869 |
* HTTP request method uses PHP Streams to retrieve the url. |
|
|
870 |
* |
|
|
871 |
* @since 2.7.0 |
|
|
872 |
* @since 3.7.0 Combined with the fsockopen transport and switched to stream_socket_client(). |
|
|
873 |
*/ |
|
|
874 |
class WP_Http_Streams { |
|
|
875 |
/** |
|
|
876 |
* Send a HTTP request to a URI using PHP Streams. |
|
|
877 |
* |
|
|
878 |
* @see WP_Http::request For default options descriptions. |
|
|
879 |
* |
|
|
880 |
* @since 2.7.0 |
|
|
881 |
* @since 3.7.0 Combined with the fsockopen transport and switched to stream_socket_client(). |
|
|
882 |
* |
|
|
883 |
* @access public |
|
5
|
884 |
* @param string $url The request URL. |
|
0
|
885 |
* @param string|array $args Optional. Override the defaults. |
|
5
|
886 |
* @return array|WP_Error Array containing 'headers', 'body', 'response', 'cookies', 'filename'. A WP_Error instance upon error |
|
0
|
887 |
*/ |
|
5
|
888 |
public function request($url, $args = array()) { |
|
0
|
889 |
$defaults = array( |
|
|
890 |
'method' => 'GET', 'timeout' => 5, |
|
|
891 |
'redirection' => 5, 'httpversion' => '1.0', |
|
|
892 |
'blocking' => true, |
|
|
893 |
'headers' => array(), 'body' => null, 'cookies' => array() |
|
|
894 |
); |
|
|
895 |
|
|
|
896 |
$r = wp_parse_args( $args, $defaults ); |
|
|
897 |
|
|
5
|
898 |
if ( isset( $r['headers']['User-Agent'] ) ) { |
|
0
|
899 |
$r['user-agent'] = $r['headers']['User-Agent']; |
|
5
|
900 |
unset( $r['headers']['User-Agent'] ); |
|
|
901 |
} elseif ( isset( $r['headers']['user-agent'] ) ) { |
|
0
|
902 |
$r['user-agent'] = $r['headers']['user-agent']; |
|
5
|
903 |
unset( $r['headers']['user-agent'] ); |
|
0
|
904 |
} |
|
|
905 |
|
|
5
|
906 |
// Construct Cookie: header if any cookies are set. |
|
0
|
907 |
WP_Http::buildCookieHeader( $r ); |
|
|
908 |
|
|
|
909 |
$arrURL = parse_url($url); |
|
|
910 |
|
|
|
911 |
$connect_host = $arrURL['host']; |
|
|
912 |
|
|
|
913 |
$secure_transport = ( $arrURL['scheme'] == 'ssl' || $arrURL['scheme'] == 'https' ); |
|
|
914 |
if ( ! isset( $arrURL['port'] ) ) { |
|
|
915 |
if ( $arrURL['scheme'] == 'ssl' || $arrURL['scheme'] == 'https' ) { |
|
|
916 |
$arrURL['port'] = 443; |
|
|
917 |
$secure_transport = true; |
|
|
918 |
} else { |
|
|
919 |
$arrURL['port'] = 80; |
|
|
920 |
} |
|
|
921 |
} |
|
|
922 |
|
|
5
|
923 |
// Always pass a Path, defaulting to the root in cases such as http://example.com |
|
|
924 |
if ( ! isset( $arrURL['path'] ) ) { |
|
|
925 |
$arrURL['path'] = '/'; |
|
|
926 |
} |
|
|
927 |
|
|
0
|
928 |
if ( isset( $r['headers']['Host'] ) || isset( $r['headers']['host'] ) ) { |
|
|
929 |
if ( isset( $r['headers']['Host'] ) ) |
|
|
930 |
$arrURL['host'] = $r['headers']['Host']; |
|
|
931 |
else |
|
|
932 |
$arrURL['host'] = $r['headers']['host']; |
|
|
933 |
unset( $r['headers']['Host'], $r['headers']['host'] ); |
|
|
934 |
} |
|
|
935 |
|
|
5
|
936 |
/* |
|
|
937 |
* Certain versions of PHP have issues with 'localhost' and IPv6, It attempts to connect |
|
|
938 |
* to ::1, which fails when the server is not set up for it. For compatibility, always |
|
|
939 |
* connect to the IPv4 address. |
|
|
940 |
*/ |
|
0
|
941 |
if ( 'localhost' == strtolower( $connect_host ) ) |
|
|
942 |
$connect_host = '127.0.0.1'; |
|
|
943 |
|
|
|
944 |
$connect_host = $secure_transport ? 'ssl://' . $connect_host : 'tcp://' . $connect_host; |
|
|
945 |
|
|
|
946 |
$is_local = isset( $r['local'] ) && $r['local']; |
|
|
947 |
$ssl_verify = isset( $r['sslverify'] ) && $r['sslverify']; |
|
5
|
948 |
if ( $is_local ) { |
|
|
949 |
/** |
|
|
950 |
* Filter whether SSL should be verified for local requests. |
|
|
951 |
* |
|
|
952 |
* @since 2.8.0 |
|
|
953 |
* |
|
|
954 |
* @param bool $ssl_verify Whether to verify the SSL connection. Default true. |
|
|
955 |
*/ |
|
0
|
956 |
$ssl_verify = apply_filters( 'https_local_ssl_verify', $ssl_verify ); |
|
5
|
957 |
} elseif ( ! $is_local ) { |
|
|
958 |
/** |
|
|
959 |
* Filter whether SSL should be verified for non-local requests. |
|
|
960 |
* |
|
|
961 |
* @since 2.8.0 |
|
|
962 |
* |
|
|
963 |
* @param bool $ssl_verify Whether to verify the SSL connection. Default true. |
|
|
964 |
*/ |
|
0
|
965 |
$ssl_verify = apply_filters( 'https_ssl_verify', $ssl_verify ); |
|
5
|
966 |
} |
|
0
|
967 |
|
|
|
968 |
$proxy = new WP_HTTP_Proxy(); |
|
|
969 |
|
|
|
970 |
$context = stream_context_create( array( |
|
|
971 |
'ssl' => array( |
|
|
972 |
'verify_peer' => $ssl_verify, |
|
|
973 |
//'CN_match' => $arrURL['host'], // This is handled by self::verify_ssl_certificate() |
|
|
974 |
'capture_peer_cert' => $ssl_verify, |
|
|
975 |
'SNI_enabled' => true, |
|
|
976 |
'cafile' => $r['sslcertificates'], |
|
|
977 |
'allow_self_signed' => ! $ssl_verify, |
|
|
978 |
) |
|
|
979 |
) ); |
|
|
980 |
|
|
|
981 |
$timeout = (int) floor( $r['timeout'] ); |
|
|
982 |
$utimeout = $timeout == $r['timeout'] ? 0 : 1000000 * $r['timeout'] % 1000000; |
|
|
983 |
$connect_timeout = max( $timeout, 1 ); |
|
|
984 |
|
|
5
|
985 |
// Store error number. |
|
|
986 |
$connection_error = null; |
|
|
987 |
|
|
|
988 |
// Store error string. |
|
|
989 |
$connection_error_str = null; |
|
0
|
990 |
|
|
|
991 |
if ( !WP_DEBUG ) { |
|
5
|
992 |
// In the event that the SSL connection fails, silence the many PHP Warnings. |
|
0
|
993 |
if ( $secure_transport ) |
|
|
994 |
$error_reporting = error_reporting(0); |
|
|
995 |
|
|
|
996 |
if ( $proxy->is_enabled() && $proxy->send_through_proxy( $url ) ) |
|
|
997 |
$handle = @stream_socket_client( 'tcp://' . $proxy->host() . ':' . $proxy->port(), $connection_error, $connection_error_str, $connect_timeout, STREAM_CLIENT_CONNECT, $context ); |
|
|
998 |
else |
|
|
999 |
$handle = @stream_socket_client( $connect_host . ':' . $arrURL['port'], $connection_error, $connection_error_str, $connect_timeout, STREAM_CLIENT_CONNECT, $context ); |
|
|
1000 |
|
|
|
1001 |
if ( $secure_transport ) |
|
|
1002 |
error_reporting( $error_reporting ); |
|
|
1003 |
|
|
|
1004 |
} else { |
|
|
1005 |
if ( $proxy->is_enabled() && $proxy->send_through_proxy( $url ) ) |
|
|
1006 |
$handle = stream_socket_client( 'tcp://' . $proxy->host() . ':' . $proxy->port(), $connection_error, $connection_error_str, $connect_timeout, STREAM_CLIENT_CONNECT, $context ); |
|
|
1007 |
else |
|
|
1008 |
$handle = stream_socket_client( $connect_host . ':' . $arrURL['port'], $connection_error, $connection_error_str, $connect_timeout, STREAM_CLIENT_CONNECT, $context ); |
|
|
1009 |
} |
|
|
1010 |
|
|
|
1011 |
if ( false === $handle ) { |
|
5
|
1012 |
// SSL connection failed due to expired/invalid cert, or, OpenSSL configuration is broken. |
|
0
|
1013 |
if ( $secure_transport && 0 === $connection_error && '' === $connection_error_str ) |
|
|
1014 |
return new WP_Error( 'http_request_failed', __( 'The SSL certificate for the host could not be verified.' ) ); |
|
|
1015 |
|
|
|
1016 |
return new WP_Error('http_request_failed', $connection_error . ': ' . $connection_error_str ); |
|
|
1017 |
} |
|
|
1018 |
|
|
5
|
1019 |
// Verify that the SSL certificate is valid for this request. |
|
0
|
1020 |
if ( $secure_transport && $ssl_verify && ! $proxy->is_enabled() ) { |
|
|
1021 |
if ( ! self::verify_ssl_certificate( $handle, $arrURL['host'] ) ) |
|
|
1022 |
return new WP_Error( 'http_request_failed', __( 'The SSL certificate for the host could not be verified.' ) ); |
|
|
1023 |
} |
|
|
1024 |
|
|
|
1025 |
stream_set_timeout( $handle, $timeout, $utimeout ); |
|
|
1026 |
|
|
|
1027 |
if ( $proxy->is_enabled() && $proxy->send_through_proxy( $url ) ) //Some proxies require full URL in this field. |
|
|
1028 |
$requestPath = $url; |
|
|
1029 |
else |
|
|
1030 |
$requestPath = $arrURL['path'] . ( isset($arrURL['query']) ? '?' . $arrURL['query'] : '' ); |
|
|
1031 |
|
|
|
1032 |
$strHeaders = strtoupper($r['method']) . ' ' . $requestPath . ' HTTP/' . $r['httpversion'] . "\r\n"; |
|
|
1033 |
|
|
5
|
1034 |
$include_port_in_host_header = ( |
|
|
1035 |
( $proxy->is_enabled() && $proxy->send_through_proxy( $url ) ) || |
|
|
1036 |
( 'http' == $arrURL['scheme'] && 80 != $arrURL['port'] ) || |
|
|
1037 |
( 'https' == $arrURL['scheme'] && 443 != $arrURL['port'] ) |
|
|
1038 |
); |
|
|
1039 |
|
|
|
1040 |
if ( $include_port_in_host_header ) { |
|
0
|
1041 |
$strHeaders .= 'Host: ' . $arrURL['host'] . ':' . $arrURL['port'] . "\r\n"; |
|
5
|
1042 |
} else { |
|
0
|
1043 |
$strHeaders .= 'Host: ' . $arrURL['host'] . "\r\n"; |
|
5
|
1044 |
} |
|
0
|
1045 |
|
|
|
1046 |
if ( isset($r['user-agent']) ) |
|
|
1047 |
$strHeaders .= 'User-agent: ' . $r['user-agent'] . "\r\n"; |
|
|
1048 |
|
|
|
1049 |
if ( is_array($r['headers']) ) { |
|
|
1050 |
foreach ( (array) $r['headers'] as $header => $headerValue ) |
|
|
1051 |
$strHeaders .= $header . ': ' . $headerValue . "\r\n"; |
|
|
1052 |
} else { |
|
|
1053 |
$strHeaders .= $r['headers']; |
|
|
1054 |
} |
|
|
1055 |
|
|
|
1056 |
if ( $proxy->use_authentication() ) |
|
|
1057 |
$strHeaders .= $proxy->authentication_header() . "\r\n"; |
|
|
1058 |
|
|
|
1059 |
$strHeaders .= "\r\n"; |
|
|
1060 |
|
|
|
1061 |
if ( ! is_null($r['body']) ) |
|
|
1062 |
$strHeaders .= $r['body']; |
|
|
1063 |
|
|
|
1064 |
fwrite($handle, $strHeaders); |
|
|
1065 |
|
|
|
1066 |
if ( ! $r['blocking'] ) { |
|
|
1067 |
stream_set_blocking( $handle, 0 ); |
|
|
1068 |
fclose( $handle ); |
|
|
1069 |
return array( 'headers' => array(), 'body' => '', 'response' => array('code' => false, 'message' => false), 'cookies' => array() ); |
|
|
1070 |
} |
|
|
1071 |
|
|
|
1072 |
$strResponse = ''; |
|
|
1073 |
$bodyStarted = false; |
|
|
1074 |
$keep_reading = true; |
|
|
1075 |
$block_size = 4096; |
|
|
1076 |
if ( isset( $r['limit_response_size'] ) ) |
|
|
1077 |
$block_size = min( $block_size, $r['limit_response_size'] ); |
|
|
1078 |
|
|
5
|
1079 |
// If streaming to a file setup the file handle. |
|
0
|
1080 |
if ( $r['stream'] ) { |
|
|
1081 |
if ( ! WP_DEBUG ) |
|
|
1082 |
$stream_handle = @fopen( $r['filename'], 'w+' ); |
|
|
1083 |
else |
|
|
1084 |
$stream_handle = fopen( $r['filename'], 'w+' ); |
|
|
1085 |
if ( ! $stream_handle ) |
|
|
1086 |
return new WP_Error( 'http_request_failed', sprintf( __( 'Could not open handle for fopen() to %s' ), $r['filename'] ) ); |
|
|
1087 |
|
|
|
1088 |
$bytes_written = 0; |
|
|
1089 |
while ( ! feof($handle) && $keep_reading ) { |
|
|
1090 |
$block = fread( $handle, $block_size ); |
|
|
1091 |
if ( ! $bodyStarted ) { |
|
|
1092 |
$strResponse .= $block; |
|
|
1093 |
if ( strpos( $strResponse, "\r\n\r\n" ) ) { |
|
|
1094 |
$process = WP_Http::processResponse( $strResponse ); |
|
|
1095 |
$bodyStarted = true; |
|
|
1096 |
$block = $process['body']; |
|
|
1097 |
unset( $strResponse ); |
|
|
1098 |
$process['body'] = ''; |
|
|
1099 |
} |
|
|
1100 |
} |
|
|
1101 |
|
|
|
1102 |
$this_block_size = strlen( $block ); |
|
|
1103 |
|
|
5
|
1104 |
if ( isset( $r['limit_response_size'] ) && ( $bytes_written + $this_block_size ) > $r['limit_response_size'] ) { |
|
|
1105 |
$this_block_size = ( $r['limit_response_size'] - $bytes_written ); |
|
|
1106 |
$block = substr( $block, 0, $this_block_size ); |
|
|
1107 |
} |
|
0
|
1108 |
|
|
|
1109 |
$bytes_written_to_file = fwrite( $stream_handle, $block ); |
|
|
1110 |
|
|
|
1111 |
if ( $bytes_written_to_file != $this_block_size ) { |
|
|
1112 |
fclose( $handle ); |
|
|
1113 |
fclose( $stream_handle ); |
|
|
1114 |
return new WP_Error( 'http_request_failed', __( 'Failed to write request to temporary file.' ) ); |
|
|
1115 |
} |
|
|
1116 |
|
|
|
1117 |
$bytes_written += $bytes_written_to_file; |
|
|
1118 |
|
|
|
1119 |
$keep_reading = !isset( $r['limit_response_size'] ) || $bytes_written < $r['limit_response_size']; |
|
|
1120 |
} |
|
|
1121 |
|
|
|
1122 |
fclose( $stream_handle ); |
|
|
1123 |
|
|
|
1124 |
} else { |
|
|
1125 |
$header_length = 0; |
|
|
1126 |
while ( ! feof( $handle ) && $keep_reading ) { |
|
|
1127 |
$block = fread( $handle, $block_size ); |
|
|
1128 |
$strResponse .= $block; |
|
|
1129 |
if ( ! $bodyStarted && strpos( $strResponse, "\r\n\r\n" ) ) { |
|
|
1130 |
$header_length = strpos( $strResponse, "\r\n\r\n" ) + 4; |
|
|
1131 |
$bodyStarted = true; |
|
|
1132 |
} |
|
|
1133 |
$keep_reading = ( ! $bodyStarted || !isset( $r['limit_response_size'] ) || strlen( $strResponse ) < ( $header_length + $r['limit_response_size'] ) ); |
|
|
1134 |
} |
|
|
1135 |
|
|
|
1136 |
$process = WP_Http::processResponse( $strResponse ); |
|
|
1137 |
unset( $strResponse ); |
|
|
1138 |
|
|
|
1139 |
} |
|
|
1140 |
|
|
|
1141 |
fclose( $handle ); |
|
|
1142 |
|
|
|
1143 |
$arrHeaders = WP_Http::processHeaders( $process['headers'], $url ); |
|
|
1144 |
|
|
|
1145 |
$response = array( |
|
|
1146 |
'headers' => $arrHeaders['headers'], |
|
5
|
1147 |
// Not yet processed. |
|
|
1148 |
'body' => null, |
|
0
|
1149 |
'response' => $arrHeaders['response'], |
|
|
1150 |
'cookies' => $arrHeaders['cookies'], |
|
|
1151 |
'filename' => $r['filename'] |
|
|
1152 |
); |
|
|
1153 |
|
|
5
|
1154 |
// Handle redirects. |
|
0
|
1155 |
if ( false !== ( $redirect_response = WP_HTTP::handle_redirects( $url, $r, $response ) ) ) |
|
|
1156 |
return $redirect_response; |
|
|
1157 |
|
|
|
1158 |
// If the body was chunk encoded, then decode it. |
|
|
1159 |
if ( ! empty( $process['body'] ) && isset( $arrHeaders['headers']['transfer-encoding'] ) && 'chunked' == $arrHeaders['headers']['transfer-encoding'] ) |
|
|
1160 |
$process['body'] = WP_Http::chunkTransferDecode($process['body']); |
|
|
1161 |
|
|
|
1162 |
if ( true === $r['decompress'] && true === WP_Http_Encoding::should_decode($arrHeaders['headers']) ) |
|
|
1163 |
$process['body'] = WP_Http_Encoding::decompress( $process['body'] ); |
|
|
1164 |
|
|
|
1165 |
if ( isset( $r['limit_response_size'] ) && strlen( $process['body'] ) > $r['limit_response_size'] ) |
|
|
1166 |
$process['body'] = substr( $process['body'], 0, $r['limit_response_size'] ); |
|
|
1167 |
|
|
|
1168 |
$response['body'] = $process['body']; |
|
|
1169 |
|
|
|
1170 |
return $response; |
|
|
1171 |
} |
|
|
1172 |
|
|
|
1173 |
/** |
|
|
1174 |
* Verifies the received SSL certificate against it's Common Names and subjectAltName fields |
|
|
1175 |
* |
|
|
1176 |
* PHP's SSL verifications only verify that it's a valid Certificate, it doesn't verify if |
|
|
1177 |
* the certificate is valid for the hostname which was requested. |
|
|
1178 |
* This function verifies the requested hostname against certificate's subjectAltName field, |
|
|
1179 |
* if that is empty, or contains no DNS entries, a fallback to the Common Name field is used. |
|
|
1180 |
* |
|
|
1181 |
* IP Address support is included if the request is being made to an IP address. |
|
|
1182 |
* |
|
|
1183 |
* @since 3.7.0 |
|
|
1184 |
* @static |
|
|
1185 |
* |
|
|
1186 |
* @param stream $stream The PHP Stream which the SSL request is being made over |
|
|
1187 |
* @param string $host The hostname being requested |
|
|
1188 |
* @return bool If the cerficiate presented in $stream is valid for $host |
|
|
1189 |
*/ |
|
5
|
1190 |
public static function verify_ssl_certificate( $stream, $host ) { |
|
0
|
1191 |
$context_options = stream_context_get_options( $stream ); |
|
|
1192 |
|
|
|
1193 |
if ( empty( $context_options['ssl']['peer_certificate'] ) ) |
|
|
1194 |
return false; |
|
|
1195 |
|
|
|
1196 |
$cert = openssl_x509_parse( $context_options['ssl']['peer_certificate'] ); |
|
|
1197 |
if ( ! $cert ) |
|
|
1198 |
return false; |
|
|
1199 |
|
|
5
|
1200 |
/* |
|
|
1201 |
* If the request is being made to an IP address, we'll validate against IP fields |
|
|
1202 |
* in the cert (if they exist) |
|
|
1203 |
*/ |
|
0
|
1204 |
$host_type = ( WP_HTTP::is_ip_address( $host ) ? 'ip' : 'dns' ); |
|
|
1205 |
|
|
|
1206 |
$certificate_hostnames = array(); |
|
|
1207 |
if ( ! empty( $cert['extensions']['subjectAltName'] ) ) { |
|
|
1208 |
$match_against = preg_split( '/,\s*/', $cert['extensions']['subjectAltName'] ); |
|
|
1209 |
foreach ( $match_against as $match ) { |
|
|
1210 |
list( $match_type, $match_host ) = explode( ':', $match ); |
|
|
1211 |
if ( $host_type == strtolower( trim( $match_type ) ) ) // IP: or DNS: |
|
|
1212 |
$certificate_hostnames[] = strtolower( trim( $match_host ) ); |
|
|
1213 |
} |
|
|
1214 |
} elseif ( !empty( $cert['subject']['CN'] ) ) { |
|
5
|
1215 |
// Only use the CN when the certificate includes no subjectAltName extension. |
|
0
|
1216 |
$certificate_hostnames[] = strtolower( $cert['subject']['CN'] ); |
|
|
1217 |
} |
|
|
1218 |
|
|
5
|
1219 |
// Exact hostname/IP matches. |
|
0
|
1220 |
if ( in_array( strtolower( $host ), $certificate_hostnames ) ) |
|
|
1221 |
return true; |
|
|
1222 |
|
|
5
|
1223 |
// IP's can't be wildcards, Stop processing. |
|
0
|
1224 |
if ( 'ip' == $host_type ) |
|
|
1225 |
return false; |
|
|
1226 |
|
|
5
|
1227 |
// Test to see if the domain is at least 2 deep for wildcard support. |
|
0
|
1228 |
if ( substr_count( $host, '.' ) < 2 ) |
|
|
1229 |
return false; |
|
|
1230 |
|
|
5
|
1231 |
// Wildcard subdomains certs (*.example.com) are valid for a.example.com but not a.b.example.com. |
|
0
|
1232 |
$wildcard_host = preg_replace( '/^[^.]+\./', '*.', $host ); |
|
|
1233 |
|
|
|
1234 |
return in_array( strtolower( $wildcard_host ), $certificate_hostnames ); |
|
|
1235 |
} |
|
|
1236 |
|
|
|
1237 |
/** |
|
5
|
1238 |
* Whether this class can be used for retrieving a URL. |
|
0
|
1239 |
* |
|
|
1240 |
* @static |
|
|
1241 |
* @access public |
|
|
1242 |
* @since 2.7.0 |
|
|
1243 |
* @since 3.7.0 Combined with the fsockopen transport and switched to stream_socket_client(). |
|
|
1244 |
* |
|
|
1245 |
* @return boolean False means this class can not be used, true means it can. |
|
|
1246 |
*/ |
|
|
1247 |
public static function test( $args = array() ) { |
|
|
1248 |
if ( ! function_exists( 'stream_socket_client' ) ) |
|
|
1249 |
return false; |
|
|
1250 |
|
|
|
1251 |
$is_ssl = isset( $args['ssl'] ) && $args['ssl']; |
|
|
1252 |
|
|
|
1253 |
if ( $is_ssl ) { |
|
|
1254 |
if ( ! extension_loaded( 'openssl' ) ) |
|
|
1255 |
return false; |
|
|
1256 |
if ( ! function_exists( 'openssl_x509_parse' ) ) |
|
|
1257 |
return false; |
|
|
1258 |
} |
|
|
1259 |
|
|
5
|
1260 |
/** |
|
|
1261 |
* Filter whether streams can be used as a transport for retrieving a URL. |
|
|
1262 |
* |
|
|
1263 |
* @since 2.7.0 |
|
|
1264 |
* |
|
|
1265 |
* @param bool $use_class Whether the class can be used. Default true. |
|
|
1266 |
* @param array $args Request arguments. |
|
|
1267 |
*/ |
|
0
|
1268 |
return apply_filters( 'use_streams_transport', true, $args ); |
|
|
1269 |
} |
|
|
1270 |
} |
|
|
1271 |
|
|
|
1272 |
/** |
|
|
1273 |
* Deprecated HTTP Transport method which used fsockopen. |
|
|
1274 |
* |
|
|
1275 |
* This class is not used, and is included for backwards compatibility only. |
|
|
1276 |
* All code should make use of WP_HTTP directly through it's API. |
|
|
1277 |
* |
|
|
1278 |
* @see WP_HTTP::request |
|
|
1279 |
* |
|
|
1280 |
* @since 2.7.0 |
|
|
1281 |
* @deprecated 3.7.0 Please use WP_HTTP::request() directly |
|
|
1282 |
*/ |
|
|
1283 |
class WP_HTTP_Fsockopen extends WP_HTTP_Streams { |
|
5
|
1284 |
// For backwards compatibility for users who are using the class directly. |
|
0
|
1285 |
} |
|
|
1286 |
|
|
|
1287 |
/** |
|
|
1288 |
* HTTP request method uses Curl extension to retrieve the url. |
|
|
1289 |
* |
|
|
1290 |
* Requires the Curl extension to be installed. |
|
|
1291 |
* |
|
|
1292 |
* @package WordPress |
|
|
1293 |
* @subpackage HTTP |
|
|
1294 |
* @since 2.7.0 |
|
|
1295 |
*/ |
|
|
1296 |
class WP_Http_Curl { |
|
|
1297 |
|
|
|
1298 |
/** |
|
|
1299 |
* Temporary header storage for during requests. |
|
|
1300 |
* |
|
|
1301 |
* @since 3.2.0 |
|
|
1302 |
* @access private |
|
|
1303 |
* @var string |
|
|
1304 |
*/ |
|
|
1305 |
private $headers = ''; |
|
|
1306 |
|
|
|
1307 |
/** |
|
|
1308 |
* Temporary body storage for during requests. |
|
|
1309 |
* |
|
|
1310 |
* @since 3.6.0 |
|
|
1311 |
* @access private |
|
|
1312 |
* @var string |
|
|
1313 |
*/ |
|
|
1314 |
private $body = ''; |
|
|
1315 |
|
|
|
1316 |
/** |
|
5
|
1317 |
* The maximum amount of data to receive from the remote server. |
|
0
|
1318 |
* |
|
|
1319 |
* @since 3.6.0 |
|
|
1320 |
* @access private |
|
|
1321 |
* @var int |
|
|
1322 |
*/ |
|
|
1323 |
private $max_body_length = false; |
|
|
1324 |
|
|
|
1325 |
/** |
|
|
1326 |
* The file resource used for streaming to file. |
|
|
1327 |
* |
|
|
1328 |
* @since 3.6.0 |
|
|
1329 |
* @access private |
|
|
1330 |
* @var resource |
|
|
1331 |
*/ |
|
|
1332 |
private $stream_handle = false; |
|
|
1333 |
|
|
|
1334 |
/** |
|
5
|
1335 |
* The total bytes written in the current request. |
|
|
1336 |
* |
|
|
1337 |
* @since 4.1.0 |
|
|
1338 |
* @access private |
|
|
1339 |
* @var int |
|
|
1340 |
*/ |
|
|
1341 |
private $bytes_written_total = 0; |
|
|
1342 |
|
|
|
1343 |
/** |
|
0
|
1344 |
* Send a HTTP request to a URI using cURL extension. |
|
|
1345 |
* |
|
|
1346 |
* @access public |
|
|
1347 |
* @since 2.7.0 |
|
|
1348 |
* |
|
5
|
1349 |
* @param string $url The request URL. |
|
|
1350 |
* @param string|array $args Optional. Override the defaults. |
|
|
1351 |
* @return array|WP_Error Array containing 'headers', 'body', 'response', 'cookies', 'filename'. A WP_Error instance upon error |
|
0
|
1352 |
*/ |
|
5
|
1353 |
public function request($url, $args = array()) { |
|
0
|
1354 |
$defaults = array( |
|
|
1355 |
'method' => 'GET', 'timeout' => 5, |
|
|
1356 |
'redirection' => 5, 'httpversion' => '1.0', |
|
|
1357 |
'blocking' => true, |
|
|
1358 |
'headers' => array(), 'body' => null, 'cookies' => array() |
|
|
1359 |
); |
|
|
1360 |
|
|
|
1361 |
$r = wp_parse_args( $args, $defaults ); |
|
|
1362 |
|
|
5
|
1363 |
if ( isset( $r['headers']['User-Agent'] ) ) { |
|
0
|
1364 |
$r['user-agent'] = $r['headers']['User-Agent']; |
|
5
|
1365 |
unset( $r['headers']['User-Agent'] ); |
|
|
1366 |
} elseif ( isset( $r['headers']['user-agent'] ) ) { |
|
0
|
1367 |
$r['user-agent'] = $r['headers']['user-agent']; |
|
5
|
1368 |
unset( $r['headers']['user-agent'] ); |
|
0
|
1369 |
} |
|
|
1370 |
|
|
|
1371 |
// Construct Cookie: header if any cookies are set. |
|
|
1372 |
WP_Http::buildCookieHeader( $r ); |
|
|
1373 |
|
|
|
1374 |
$handle = curl_init(); |
|
|
1375 |
|
|
|
1376 |
// cURL offers really easy proxy support. |
|
|
1377 |
$proxy = new WP_HTTP_Proxy(); |
|
|
1378 |
|
|
|
1379 |
if ( $proxy->is_enabled() && $proxy->send_through_proxy( $url ) ) { |
|
|
1380 |
|
|
|
1381 |
curl_setopt( $handle, CURLOPT_PROXYTYPE, CURLPROXY_HTTP ); |
|
|
1382 |
curl_setopt( $handle, CURLOPT_PROXY, $proxy->host() ); |
|
|
1383 |
curl_setopt( $handle, CURLOPT_PROXYPORT, $proxy->port() ); |
|
|
1384 |
|
|
|
1385 |
if ( $proxy->use_authentication() ) { |
|
|
1386 |
curl_setopt( $handle, CURLOPT_PROXYAUTH, CURLAUTH_ANY ); |
|
|
1387 |
curl_setopt( $handle, CURLOPT_PROXYUSERPWD, $proxy->authentication() ); |
|
|
1388 |
} |
|
|
1389 |
} |
|
|
1390 |
|
|
|
1391 |
$is_local = isset($r['local']) && $r['local']; |
|
|
1392 |
$ssl_verify = isset($r['sslverify']) && $r['sslverify']; |
|
5
|
1393 |
if ( $is_local ) { |
|
|
1394 |
/** This filter is documented in wp-includes/class-http.php */ |
|
|
1395 |
$ssl_verify = apply_filters( 'https_local_ssl_verify', $ssl_verify ); |
|
|
1396 |
} elseif ( ! $is_local ) { |
|
|
1397 |
/** This filter is documented in wp-includes/class-http.php */ |
|
|
1398 |
$ssl_verify = apply_filters( 'https_ssl_verify', $ssl_verify ); |
|
|
1399 |
} |
|
0
|
1400 |
|
|
5
|
1401 |
/* |
|
|
1402 |
* CURLOPT_TIMEOUT and CURLOPT_CONNECTTIMEOUT expect integers. Have to use ceil since. |
|
|
1403 |
* a value of 0 will allow an unlimited timeout. |
|
|
1404 |
*/ |
|
0
|
1405 |
$timeout = (int) ceil( $r['timeout'] ); |
|
|
1406 |
curl_setopt( $handle, CURLOPT_CONNECTTIMEOUT, $timeout ); |
|
|
1407 |
curl_setopt( $handle, CURLOPT_TIMEOUT, $timeout ); |
|
|
1408 |
|
|
|
1409 |
curl_setopt( $handle, CURLOPT_URL, $url); |
|
|
1410 |
curl_setopt( $handle, CURLOPT_RETURNTRANSFER, true ); |
|
|
1411 |
curl_setopt( $handle, CURLOPT_SSL_VERIFYHOST, ( $ssl_verify === true ) ? 2 : false ); |
|
|
1412 |
curl_setopt( $handle, CURLOPT_SSL_VERIFYPEER, $ssl_verify ); |
|
|
1413 |
curl_setopt( $handle, CURLOPT_CAINFO, $r['sslcertificates'] ); |
|
|
1414 |
curl_setopt( $handle, CURLOPT_USERAGENT, $r['user-agent'] ); |
|
5
|
1415 |
|
|
|
1416 |
/* |
|
|
1417 |
* The option doesn't work with safe mode or when open_basedir is set, and there's |
|
|
1418 |
* a bug #17490 with redirected POST requests, so handle redirections outside Curl. |
|
|
1419 |
*/ |
|
0
|
1420 |
curl_setopt( $handle, CURLOPT_FOLLOWLOCATION, false ); |
|
|
1421 |
if ( defined( 'CURLOPT_PROTOCOLS' ) ) // PHP 5.2.10 / cURL 7.19.4 |
|
|
1422 |
curl_setopt( $handle, CURLOPT_PROTOCOLS, CURLPROTO_HTTP | CURLPROTO_HTTPS ); |
|
|
1423 |
|
|
|
1424 |
switch ( $r['method'] ) { |
|
|
1425 |
case 'HEAD': |
|
|
1426 |
curl_setopt( $handle, CURLOPT_NOBODY, true ); |
|
|
1427 |
break; |
|
|
1428 |
case 'POST': |
|
|
1429 |
curl_setopt( $handle, CURLOPT_POST, true ); |
|
|
1430 |
curl_setopt( $handle, CURLOPT_POSTFIELDS, $r['body'] ); |
|
|
1431 |
break; |
|
|
1432 |
case 'PUT': |
|
|
1433 |
curl_setopt( $handle, CURLOPT_CUSTOMREQUEST, 'PUT' ); |
|
|
1434 |
curl_setopt( $handle, CURLOPT_POSTFIELDS, $r['body'] ); |
|
|
1435 |
break; |
|
|
1436 |
default: |
|
|
1437 |
curl_setopt( $handle, CURLOPT_CUSTOMREQUEST, $r['method'] ); |
|
|
1438 |
if ( ! is_null( $r['body'] ) ) |
|
|
1439 |
curl_setopt( $handle, CURLOPT_POSTFIELDS, $r['body'] ); |
|
|
1440 |
break; |
|
|
1441 |
} |
|
|
1442 |
|
|
|
1443 |
if ( true === $r['blocking'] ) { |
|
|
1444 |
curl_setopt( $handle, CURLOPT_HEADERFUNCTION, array( $this, 'stream_headers' ) ); |
|
|
1445 |
curl_setopt( $handle, CURLOPT_WRITEFUNCTION, array( $this, 'stream_body' ) ); |
|
|
1446 |
} |
|
|
1447 |
|
|
|
1448 |
curl_setopt( $handle, CURLOPT_HEADER, false ); |
|
|
1449 |
|
|
|
1450 |
if ( isset( $r['limit_response_size'] ) ) |
|
|
1451 |
$this->max_body_length = intval( $r['limit_response_size'] ); |
|
|
1452 |
else |
|
|
1453 |
$this->max_body_length = false; |
|
|
1454 |
|
|
5
|
1455 |
// If streaming to a file open a file handle, and setup our curl streaming handler. |
|
0
|
1456 |
if ( $r['stream'] ) { |
|
|
1457 |
if ( ! WP_DEBUG ) |
|
|
1458 |
$this->stream_handle = @fopen( $r['filename'], 'w+' ); |
|
|
1459 |
else |
|
|
1460 |
$this->stream_handle = fopen( $r['filename'], 'w+' ); |
|
|
1461 |
if ( ! $this->stream_handle ) |
|
|
1462 |
return new WP_Error( 'http_request_failed', sprintf( __( 'Could not open handle for fopen() to %s' ), $r['filename'] ) ); |
|
|
1463 |
} else { |
|
|
1464 |
$this->stream_handle = false; |
|
|
1465 |
} |
|
|
1466 |
|
|
|
1467 |
if ( !empty( $r['headers'] ) ) { |
|
5
|
1468 |
// cURL expects full header strings in each element. |
|
0
|
1469 |
$headers = array(); |
|
|
1470 |
foreach ( $r['headers'] as $name => $value ) { |
|
|
1471 |
$headers[] = "{$name}: $value"; |
|
|
1472 |
} |
|
|
1473 |
curl_setopt( $handle, CURLOPT_HTTPHEADER, $headers ); |
|
|
1474 |
} |
|
|
1475 |
|
|
|
1476 |
if ( $r['httpversion'] == '1.0' ) |
|
|
1477 |
curl_setopt( $handle, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0 ); |
|
|
1478 |
else |
|
|
1479 |
curl_setopt( $handle, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_1 ); |
|
|
1480 |
|
|
5
|
1481 |
/** |
|
|
1482 |
* Fires before the cURL request is executed. |
|
|
1483 |
* |
|
|
1484 |
* Cookies are not currently handled by the HTTP API. This action allows |
|
|
1485 |
* plugins to handle cookies themselves. |
|
|
1486 |
* |
|
|
1487 |
* @since 2.8.0 |
|
|
1488 |
* |
|
|
1489 |
* @param resource &$handle The cURL handle returned by curl_init(). |
|
|
1490 |
* @param array $r The HTTP request arguments. |
|
|
1491 |
* @param string $url The request URL. |
|
|
1492 |
*/ |
|
|
1493 |
do_action_ref_array( 'http_api_curl', array( &$handle, $r, $url ) ); |
|
0
|
1494 |
|
|
|
1495 |
// We don't need to return the body, so don't. Just execute request and return. |
|
|
1496 |
if ( ! $r['blocking'] ) { |
|
|
1497 |
curl_exec( $handle ); |
|
|
1498 |
|
|
|
1499 |
if ( $curl_error = curl_error( $handle ) ) { |
|
|
1500 |
curl_close( $handle ); |
|
|
1501 |
return new WP_Error( 'http_request_failed', $curl_error ); |
|
|
1502 |
} |
|
|
1503 |
if ( in_array( curl_getinfo( $handle, CURLINFO_HTTP_CODE ), array( 301, 302 ) ) ) { |
|
|
1504 |
curl_close( $handle ); |
|
|
1505 |
return new WP_Error( 'http_request_failed', __( 'Too many redirects.' ) ); |
|
|
1506 |
} |
|
|
1507 |
|
|
|
1508 |
curl_close( $handle ); |
|
|
1509 |
return array( 'headers' => array(), 'body' => '', 'response' => array('code' => false, 'message' => false), 'cookies' => array() ); |
|
|
1510 |
} |
|
|
1511 |
|
|
5
|
1512 |
curl_exec( $handle ); |
|
0
|
1513 |
$theHeaders = WP_Http::processHeaders( $this->headers, $url ); |
|
|
1514 |
$theBody = $this->body; |
|
5
|
1515 |
$bytes_written_total = $this->bytes_written_total; |
|
0
|
1516 |
|
|
|
1517 |
$this->headers = ''; |
|
|
1518 |
$this->body = ''; |
|
5
|
1519 |
$this->bytes_written_total = 0; |
|
0
|
1520 |
|
|
|
1521 |
$curl_error = curl_errno( $handle ); |
|
|
1522 |
|
|
5
|
1523 |
// If an error occurred, or, no response. |
|
0
|
1524 |
if ( $curl_error || ( 0 == strlen( $theBody ) && empty( $theHeaders['headers'] ) ) ) { |
|
5
|
1525 |
if ( CURLE_WRITE_ERROR /* 23 */ == $curl_error ) { |
|
|
1526 |
if ( ! $this->max_body_length || $this->max_body_length != $bytes_written_total ) { |
|
|
1527 |
if ( $r['stream'] ) { |
|
|
1528 |
curl_close( $handle ); |
|
|
1529 |
fclose( $this->stream_handle ); |
|
|
1530 |
return new WP_Error( 'http_request_failed', __( 'Failed to write request to temporary file.' ) ); |
|
|
1531 |
} else { |
|
|
1532 |
curl_close( $handle ); |
|
|
1533 |
return new WP_Error( 'http_request_failed', curl_error( $handle ) ); |
|
|
1534 |
} |
|
|
1535 |
} |
|
|
1536 |
} else { |
|
|
1537 |
if ( $curl_error = curl_error( $handle ) ) { |
|
|
1538 |
curl_close( $handle ); |
|
|
1539 |
return new WP_Error( 'http_request_failed', $curl_error ); |
|
|
1540 |
} |
|
0
|
1541 |
} |
|
|
1542 |
if ( in_array( curl_getinfo( $handle, CURLINFO_HTTP_CODE ), array( 301, 302 ) ) ) { |
|
|
1543 |
curl_close( $handle ); |
|
|
1544 |
return new WP_Error( 'http_request_failed', __( 'Too many redirects.' ) ); |
|
|
1545 |
} |
|
|
1546 |
} |
|
|
1547 |
|
|
|
1548 |
curl_close( $handle ); |
|
|
1549 |
|
|
|
1550 |
if ( $r['stream'] ) |
|
|
1551 |
fclose( $this->stream_handle ); |
|
|
1552 |
|
|
|
1553 |
$response = array( |
|
|
1554 |
'headers' => $theHeaders['headers'], |
|
|
1555 |
'body' => null, |
|
5
|
1556 |
'response' => $theHeaders['response'], |
|
0
|
1557 |
'cookies' => $theHeaders['cookies'], |
|
|
1558 |
'filename' => $r['filename'] |
|
|
1559 |
); |
|
|
1560 |
|
|
5
|
1561 |
// Handle redirects. |
|
0
|
1562 |
if ( false !== ( $redirect_response = WP_HTTP::handle_redirects( $url, $r, $response ) ) ) |
|
|
1563 |
return $redirect_response; |
|
|
1564 |
|
|
|
1565 |
if ( true === $r['decompress'] && true === WP_Http_Encoding::should_decode($theHeaders['headers']) ) |
|
|
1566 |
$theBody = WP_Http_Encoding::decompress( $theBody ); |
|
|
1567 |
|
|
|
1568 |
$response['body'] = $theBody; |
|
|
1569 |
|
|
|
1570 |
return $response; |
|
|
1571 |
} |
|
|
1572 |
|
|
|
1573 |
/** |
|
|
1574 |
* Grab the headers of the cURL request |
|
|
1575 |
* |
|
|
1576 |
* Each header is sent individually to this callback, so we append to the $header property for temporary storage |
|
|
1577 |
* |
|
|
1578 |
* @since 3.2.0 |
|
|
1579 |
* @access private |
|
|
1580 |
* @return int |
|
|
1581 |
*/ |
|
|
1582 |
private function stream_headers( $handle, $headers ) { |
|
|
1583 |
$this->headers .= $headers; |
|
|
1584 |
return strlen( $headers ); |
|
|
1585 |
} |
|
|
1586 |
|
|
|
1587 |
/** |
|
|
1588 |
* Grab the body of the cURL request |
|
|
1589 |
* |
|
|
1590 |
* The contents of the document are passed in chunks, so we append to the $body property for temporary storage. |
|
5
|
1591 |
* Returning a length shorter than the length of $data passed in will cause cURL to abort the request with CURLE_WRITE_ERROR |
|
0
|
1592 |
* |
|
|
1593 |
* @since 3.6.0 |
|
|
1594 |
* @access private |
|
|
1595 |
* @return int |
|
|
1596 |
*/ |
|
|
1597 |
private function stream_body( $handle, $data ) { |
|
|
1598 |
$data_length = strlen( $data ); |
|
|
1599 |
|
|
5
|
1600 |
if ( $this->max_body_length && ( $this->bytes_written_total + $data_length ) > $this->max_body_length ) { |
|
|
1601 |
$data_length = ( $this->max_body_length - $this->bytes_written_total ); |
|
|
1602 |
$data = substr( $data, 0, $data_length ); |
|
|
1603 |
} |
|
0
|
1604 |
|
|
|
1605 |
if ( $this->stream_handle ) { |
|
|
1606 |
$bytes_written = fwrite( $this->stream_handle, $data ); |
|
|
1607 |
} else { |
|
|
1608 |
$this->body .= $data; |
|
|
1609 |
$bytes_written = $data_length; |
|
|
1610 |
} |
|
|
1611 |
|
|
5
|
1612 |
$this->bytes_written_total += $bytes_written; |
|
|
1613 |
|
|
|
1614 |
// Upon event of this function returning less than strlen( $data ) curl will error with CURLE_WRITE_ERROR. |
|
0
|
1615 |
return $bytes_written; |
|
|
1616 |
} |
|
|
1617 |
|
|
|
1618 |
/** |
|
|
1619 |
* Whether this class can be used for retrieving an URL. |
|
|
1620 |
* |
|
|
1621 |
* @static |
|
|
1622 |
* @since 2.7.0 |
|
|
1623 |
* |
|
|
1624 |
* @return boolean False means this class can not be used, true means it can. |
|
|
1625 |
*/ |
|
|
1626 |
public static function test( $args = array() ) { |
|
|
1627 |
if ( ! function_exists( 'curl_init' ) || ! function_exists( 'curl_exec' ) ) |
|
|
1628 |
return false; |
|
|
1629 |
|
|
|
1630 |
$is_ssl = isset( $args['ssl'] ) && $args['ssl']; |
|
|
1631 |
|
|
|
1632 |
if ( $is_ssl ) { |
|
|
1633 |
$curl_version = curl_version(); |
|
5
|
1634 |
// Check whether this cURL version support SSL requests. |
|
|
1635 |
if ( ! (CURL_VERSION_SSL & $curl_version['features']) ) |
|
0
|
1636 |
return false; |
|
|
1637 |
} |
|
|
1638 |
|
|
5
|
1639 |
/** |
|
|
1640 |
* Filter whether cURL can be used as a transport for retrieving a URL. |
|
|
1641 |
* |
|
|
1642 |
* @since 2.7.0 |
|
|
1643 |
* |
|
|
1644 |
* @param bool $use_class Whether the class can be used. Default true. |
|
|
1645 |
* @param array $args An array of request arguments. |
|
|
1646 |
*/ |
|
0
|
1647 |
return apply_filters( 'use_curl_transport', true, $args ); |
|
|
1648 |
} |
|
|
1649 |
} |
|
|
1650 |
|
|
|
1651 |
/** |
|
|
1652 |
* Adds Proxy support to the WordPress HTTP API. |
|
|
1653 |
* |
|
|
1654 |
* There are caveats to proxy support. It requires that defines be made in the wp-config.php file to |
|
|
1655 |
* enable proxy support. There are also a few filters that plugins can hook into for some of the |
|
|
1656 |
* constants. |
|
|
1657 |
* |
|
|
1658 |
* Please note that only BASIC authentication is supported by most transports. |
|
|
1659 |
* cURL MAY support more methods (such as NTLM authentication) depending on your environment. |
|
|
1660 |
* |
|
|
1661 |
* The constants are as follows: |
|
|
1662 |
* <ol> |
|
|
1663 |
* <li>WP_PROXY_HOST - Enable proxy support and host for connecting.</li> |
|
|
1664 |
* <li>WP_PROXY_PORT - Proxy port for connection. No default, must be defined.</li> |
|
|
1665 |
* <li>WP_PROXY_USERNAME - Proxy username, if it requires authentication.</li> |
|
|
1666 |
* <li>WP_PROXY_PASSWORD - Proxy password, if it requires authentication.</li> |
|
|
1667 |
* <li>WP_PROXY_BYPASS_HOSTS - Will prevent the hosts in this list from going through the proxy. |
|
|
1668 |
* You do not need to have localhost and the blog host in this list, because they will not be passed |
|
|
1669 |
* through the proxy. The list should be presented in a comma separated list, wildcards using * are supported, eg. *.wordpress.org</li> |
|
|
1670 |
* </ol> |
|
|
1671 |
* |
|
|
1672 |
* An example can be as seen below. |
|
|
1673 |
* |
|
5
|
1674 |
* define('WP_PROXY_HOST', '192.168.84.101'); |
|
|
1675 |
* define('WP_PROXY_PORT', '8080'); |
|
|
1676 |
* define('WP_PROXY_BYPASS_HOSTS', 'localhost, www.example.com, *.wordpress.org'); |
|
|
1677 |
* |
|
|
1678 |
* @link https://core.trac.wordpress.org/ticket/4011 Proxy support ticket in WordPress. |
|
|
1679 |
* @link https://core.trac.wordpress.org/ticket/14636 Allow wildcard domains in WP_PROXY_BYPASS_HOSTS |
|
|
1680 |
* @since 2.8.0 |
|
0
|
1681 |
*/ |
|
|
1682 |
class WP_HTTP_Proxy { |
|
|
1683 |
|
|
|
1684 |
/** |
|
|
1685 |
* Whether proxy connection should be used. |
|
|
1686 |
* |
|
5
|
1687 |
* @since 2.8.0 |
|
|
1688 |
* |
|
0
|
1689 |
* @use WP_PROXY_HOST |
|
|
1690 |
* @use WP_PROXY_PORT |
|
|
1691 |
* |
|
|
1692 |
* @return bool |
|
|
1693 |
*/ |
|
5
|
1694 |
public function is_enabled() { |
|
0
|
1695 |
return defined('WP_PROXY_HOST') && defined('WP_PROXY_PORT'); |
|
|
1696 |
} |
|
|
1697 |
|
|
|
1698 |
/** |
|
|
1699 |
* Whether authentication should be used. |
|
|
1700 |
* |
|
5
|
1701 |
* @since 2.8.0 |
|
|
1702 |
* |
|
0
|
1703 |
* @use WP_PROXY_USERNAME |
|
|
1704 |
* @use WP_PROXY_PASSWORD |
|
|
1705 |
* |
|
|
1706 |
* @return bool |
|
|
1707 |
*/ |
|
5
|
1708 |
public function use_authentication() { |
|
0
|
1709 |
return defined('WP_PROXY_USERNAME') && defined('WP_PROXY_PASSWORD'); |
|
|
1710 |
} |
|
|
1711 |
|
|
|
1712 |
/** |
|
|
1713 |
* Retrieve the host for the proxy server. |
|
|
1714 |
* |
|
5
|
1715 |
* @since 2.8.0 |
|
0
|
1716 |
* |
|
|
1717 |
* @return string |
|
|
1718 |
*/ |
|
5
|
1719 |
public function host() { |
|
0
|
1720 |
if ( defined('WP_PROXY_HOST') ) |
|
|
1721 |
return WP_PROXY_HOST; |
|
|
1722 |
|
|
|
1723 |
return ''; |
|
|
1724 |
} |
|
|
1725 |
|
|
|
1726 |
/** |
|
|
1727 |
* Retrieve the port for the proxy server. |
|
|
1728 |
* |
|
5
|
1729 |
* @since 2.8.0 |
|
0
|
1730 |
* |
|
|
1731 |
* @return string |
|
|
1732 |
*/ |
|
5
|
1733 |
public function port() { |
|
0
|
1734 |
if ( defined('WP_PROXY_PORT') ) |
|
|
1735 |
return WP_PROXY_PORT; |
|
|
1736 |
|
|
|
1737 |
return ''; |
|
|
1738 |
} |
|
|
1739 |
|
|
|
1740 |
/** |
|
|
1741 |
* Retrieve the username for proxy authentication. |
|
|
1742 |
* |
|
5
|
1743 |
* @since 2.8.0 |
|
0
|
1744 |
* |
|
|
1745 |
* @return string |
|
|
1746 |
*/ |
|
5
|
1747 |
public function username() { |
|
0
|
1748 |
if ( defined('WP_PROXY_USERNAME') ) |
|
|
1749 |
return WP_PROXY_USERNAME; |
|
|
1750 |
|
|
|
1751 |
return ''; |
|
|
1752 |
} |
|
|
1753 |
|
|
|
1754 |
/** |
|
|
1755 |
* Retrieve the password for proxy authentication. |
|
|
1756 |
* |
|
5
|
1757 |
* @since 2.8.0 |
|
0
|
1758 |
* |
|
|
1759 |
* @return string |
|
|
1760 |
*/ |
|
5
|
1761 |
public function password() { |
|
0
|
1762 |
if ( defined('WP_PROXY_PASSWORD') ) |
|
|
1763 |
return WP_PROXY_PASSWORD; |
|
|
1764 |
|
|
|
1765 |
return ''; |
|
|
1766 |
} |
|
|
1767 |
|
|
|
1768 |
/** |
|
|
1769 |
* Retrieve authentication string for proxy authentication. |
|
|
1770 |
* |
|
5
|
1771 |
* @since 2.8.0 |
|
0
|
1772 |
* |
|
|
1773 |
* @return string |
|
|
1774 |
*/ |
|
5
|
1775 |
public function authentication() { |
|
0
|
1776 |
return $this->username() . ':' . $this->password(); |
|
|
1777 |
} |
|
|
1778 |
|
|
|
1779 |
/** |
|
|
1780 |
* Retrieve header string for proxy authentication. |
|
|
1781 |
* |
|
5
|
1782 |
* @since 2.8.0 |
|
0
|
1783 |
* |
|
|
1784 |
* @return string |
|
|
1785 |
*/ |
|
5
|
1786 |
public function authentication_header() { |
|
0
|
1787 |
return 'Proxy-Authorization: Basic ' . base64_encode( $this->authentication() ); |
|
|
1788 |
} |
|
|
1789 |
|
|
|
1790 |
/** |
|
|
1791 |
* Whether URL should be sent through the proxy server. |
|
|
1792 |
* |
|
|
1793 |
* We want to keep localhost and the blog URL from being sent through the proxy server, because |
|
|
1794 |
* some proxies can not handle this. We also have the constant available for defining other |
|
|
1795 |
* hosts that won't be sent through the proxy. |
|
|
1796 |
* |
|
|
1797 |
* @since 2.8.0 |
|
|
1798 |
* |
|
|
1799 |
* @param string $uri URI to check. |
|
|
1800 |
* @return bool True, to send through the proxy and false if, the proxy should not be used. |
|
|
1801 |
*/ |
|
5
|
1802 |
public function send_through_proxy( $uri ) { |
|
|
1803 |
/* |
|
|
1804 |
* parse_url() only handles http, https type URLs, and will emit E_WARNING on failure. |
|
|
1805 |
* This will be displayed on blogs, which is not reasonable. |
|
|
1806 |
*/ |
|
0
|
1807 |
$check = @parse_url($uri); |
|
|
1808 |
|
|
|
1809 |
// Malformed URL, can not process, but this could mean ssl, so let through anyway. |
|
|
1810 |
if ( $check === false ) |
|
|
1811 |
return true; |
|
|
1812 |
|
|
|
1813 |
$home = parse_url( get_option('siteurl') ); |
|
|
1814 |
|
|
5
|
1815 |
/** |
|
|
1816 |
* Filter whether to preempt sending the request through the proxy server. |
|
|
1817 |
* |
|
|
1818 |
* Returning false will bypass the proxy; returning true will send |
|
|
1819 |
* the request through the proxy. Returning null bypasses the filter. |
|
|
1820 |
* |
|
|
1821 |
* @since 3.5.0 |
|
|
1822 |
* |
|
|
1823 |
* @param null $override Whether to override the request result. Default null. |
|
|
1824 |
* @param string $uri URL to check. |
|
|
1825 |
* @param array $check Associative array result of parsing the URI. |
|
|
1826 |
* @param array $home Associative array result of parsing the site URL. |
|
|
1827 |
*/ |
|
0
|
1828 |
$result = apply_filters( 'pre_http_send_through_proxy', null, $uri, $check, $home ); |
|
|
1829 |
if ( ! is_null( $result ) ) |
|
|
1830 |
return $result; |
|
|
1831 |
|
|
5
|
1832 |
if ( 'localhost' == $check['host'] || ( isset( $home['host'] ) && $home['host'] == $check['host'] ) ) |
|
0
|
1833 |
return false; |
|
|
1834 |
|
|
|
1835 |
if ( !defined('WP_PROXY_BYPASS_HOSTS') ) |
|
|
1836 |
return true; |
|
|
1837 |
|
|
|
1838 |
static $bypass_hosts; |
|
|
1839 |
static $wildcard_regex = false; |
|
|
1840 |
if ( null == $bypass_hosts ) { |
|
|
1841 |
$bypass_hosts = preg_split('|,\s*|', WP_PROXY_BYPASS_HOSTS); |
|
|
1842 |
|
|
|
1843 |
if ( false !== strpos(WP_PROXY_BYPASS_HOSTS, '*') ) { |
|
|
1844 |
$wildcard_regex = array(); |
|
|
1845 |
foreach ( $bypass_hosts as $host ) |
|
|
1846 |
$wildcard_regex[] = str_replace( '\*', '.+', preg_quote( $host, '/' ) ); |
|
|
1847 |
$wildcard_regex = '/^(' . implode('|', $wildcard_regex) . ')$/i'; |
|
|
1848 |
} |
|
|
1849 |
} |
|
|
1850 |
|
|
|
1851 |
if ( !empty($wildcard_regex) ) |
|
|
1852 |
return !preg_match($wildcard_regex, $check['host']); |
|
|
1853 |
else |
|
|
1854 |
return !in_array( $check['host'], $bypass_hosts ); |
|
|
1855 |
} |
|
|
1856 |
} |
|
|
1857 |
/** |
|
|
1858 |
* Internal representation of a single cookie. |
|
|
1859 |
* |
|
|
1860 |
* Returned cookies are represented using this class, and when cookies are set, if they are not |
|
|
1861 |
* already a WP_Http_Cookie() object, then they are turned into one. |
|
|
1862 |
* |
|
|
1863 |
* @todo The WordPress convention is to use underscores instead of camelCase for function and method |
|
|
1864 |
* names. Need to switch to use underscores instead for the methods. |
|
|
1865 |
* |
|
|
1866 |
* @package WordPress |
|
|
1867 |
* @subpackage HTTP |
|
|
1868 |
* @since 2.8.0 |
|
|
1869 |
*/ |
|
|
1870 |
class WP_Http_Cookie { |
|
|
1871 |
|
|
|
1872 |
/** |
|
|
1873 |
* Cookie name. |
|
|
1874 |
* |
|
|
1875 |
* @since 2.8.0 |
|
|
1876 |
* @var string |
|
|
1877 |
*/ |
|
5
|
1878 |
public $name; |
|
0
|
1879 |
|
|
|
1880 |
/** |
|
|
1881 |
* Cookie value. |
|
|
1882 |
* |
|
|
1883 |
* @since 2.8.0 |
|
|
1884 |
* @var string |
|
|
1885 |
*/ |
|
5
|
1886 |
public $value; |
|
0
|
1887 |
|
|
|
1888 |
/** |
|
|
1889 |
* When the cookie expires. |
|
|
1890 |
* |
|
|
1891 |
* @since 2.8.0 |
|
|
1892 |
* @var string |
|
|
1893 |
*/ |
|
5
|
1894 |
public $expires; |
|
0
|
1895 |
|
|
|
1896 |
/** |
|
|
1897 |
* Cookie URL path. |
|
|
1898 |
* |
|
|
1899 |
* @since 2.8.0 |
|
|
1900 |
* @var string |
|
|
1901 |
*/ |
|
5
|
1902 |
public $path; |
|
0
|
1903 |
|
|
|
1904 |
/** |
|
|
1905 |
* Cookie Domain. |
|
|
1906 |
* |
|
|
1907 |
* @since 2.8.0 |
|
|
1908 |
* @var string |
|
|
1909 |
*/ |
|
5
|
1910 |
public $domain; |
|
0
|
1911 |
|
|
|
1912 |
/** |
|
|
1913 |
* Sets up this cookie object. |
|
|
1914 |
* |
|
|
1915 |
* The parameter $data should be either an associative array containing the indices names below |
|
|
1916 |
* or a header string detailing it. |
|
|
1917 |
* |
|
5
|
1918 |
* @since 2.8.0 |
|
|
1919 |
* @access public |
|
|
1920 |
* |
|
|
1921 |
* @param string|array $data { |
|
|
1922 |
* Raw cookie data as header string or data array. |
|
0
|
1923 |
* |
|
5
|
1924 |
* @type string $name Cookie name. |
|
|
1925 |
* @type mixed $value Value. Should NOT already be urlencoded. |
|
|
1926 |
* @type string|int $expires Optional. Unix timestamp or formatted date. Default null. |
|
|
1927 |
* @type string $path Optional. Path. Default '/'. |
|
|
1928 |
* @type string $domain Optional. Domain. Default host of parsed $requested_url. |
|
|
1929 |
* @type int $port Optional. Port. Default null. |
|
|
1930 |
* } |
|
|
1931 |
* @param string $requested_url The URL which the cookie was set on, used for default $domain |
|
|
1932 |
* and $port values. |
|
0
|
1933 |
*/ |
|
5
|
1934 |
public function __construct( $data, $requested_url = '' ) { |
|
0
|
1935 |
if ( $requested_url ) |
|
|
1936 |
$arrURL = @parse_url( $requested_url ); |
|
|
1937 |
if ( isset( $arrURL['host'] ) ) |
|
|
1938 |
$this->domain = $arrURL['host']; |
|
|
1939 |
$this->path = isset( $arrURL['path'] ) ? $arrURL['path'] : '/'; |
|
|
1940 |
if ( '/' != substr( $this->path, -1 ) ) |
|
|
1941 |
$this->path = dirname( $this->path ) . '/'; |
|
|
1942 |
|
|
|
1943 |
if ( is_string( $data ) ) { |
|
5
|
1944 |
// Assume it's a header string direct from a previous request. |
|
0
|
1945 |
$pairs = explode( ';', $data ); |
|
|
1946 |
|
|
5
|
1947 |
// Special handling for first pair; name=value. Also be careful of "=" in value. |
|
0
|
1948 |
$name = trim( substr( $pairs[0], 0, strpos( $pairs[0], '=' ) ) ); |
|
|
1949 |
$value = substr( $pairs[0], strpos( $pairs[0], '=' ) + 1 ); |
|
|
1950 |
$this->name = $name; |
|
|
1951 |
$this->value = urldecode( $value ); |
|
|
1952 |
|
|
5
|
1953 |
// Removes name=value from items. |
|
|
1954 |
array_shift( $pairs ); |
|
|
1955 |
|
|
|
1956 |
// Set everything else as a property. |
|
0
|
1957 |
foreach ( $pairs as $pair ) { |
|
|
1958 |
$pair = rtrim($pair); |
|
5
|
1959 |
|
|
|
1960 |
// Handle the cookie ending in ; which results in a empty final pair. |
|
|
1961 |
if ( empty($pair) ) |
|
0
|
1962 |
continue; |
|
|
1963 |
|
|
|
1964 |
list( $key, $val ) = strpos( $pair, '=' ) ? explode( '=', $pair ) : array( $pair, '' ); |
|
|
1965 |
$key = strtolower( trim( $key ) ); |
|
|
1966 |
if ( 'expires' == $key ) |
|
|
1967 |
$val = strtotime( $val ); |
|
|
1968 |
$this->$key = $val; |
|
|
1969 |
} |
|
|
1970 |
} else { |
|
|
1971 |
if ( !isset( $data['name'] ) ) |
|
5
|
1972 |
return; |
|
0
|
1973 |
|
|
5
|
1974 |
// Set properties based directly on parameters. |
|
0
|
1975 |
foreach ( array( 'name', 'value', 'path', 'domain', 'port' ) as $field ) { |
|
|
1976 |
if ( isset( $data[ $field ] ) ) |
|
|
1977 |
$this->$field = $data[ $field ]; |
|
|
1978 |
} |
|
|
1979 |
|
|
|
1980 |
if ( isset( $data['expires'] ) ) |
|
|
1981 |
$this->expires = is_int( $data['expires'] ) ? $data['expires'] : strtotime( $data['expires'] ); |
|
|
1982 |
else |
|
|
1983 |
$this->expires = null; |
|
|
1984 |
} |
|
|
1985 |
} |
|
|
1986 |
|
|
|
1987 |
/** |
|
|
1988 |
* Confirms that it's OK to send this cookie to the URL checked against. |
|
|
1989 |
* |
|
|
1990 |
* Decision is based on RFC 2109/2965, so look there for details on validity. |
|
|
1991 |
* |
|
|
1992 |
* @access public |
|
|
1993 |
* @since 2.8.0 |
|
|
1994 |
* |
|
|
1995 |
* @param string $url URL you intend to send this cookie to |
|
|
1996 |
* @return boolean true if allowed, false otherwise. |
|
|
1997 |
*/ |
|
5
|
1998 |
public function test( $url ) { |
|
0
|
1999 |
if ( is_null( $this->name ) ) |
|
|
2000 |
return false; |
|
|
2001 |
|
|
5
|
2002 |
// Expires - if expired then nothing else matters. |
|
0
|
2003 |
if ( isset( $this->expires ) && time() > $this->expires ) |
|
|
2004 |
return false; |
|
|
2005 |
|
|
5
|
2006 |
// Get details on the URL we're thinking about sending to. |
|
0
|
2007 |
$url = parse_url( $url ); |
|
|
2008 |
$url['port'] = isset( $url['port'] ) ? $url['port'] : ( 'https' == $url['scheme'] ? 443 : 80 ); |
|
|
2009 |
$url['path'] = isset( $url['path'] ) ? $url['path'] : '/'; |
|
|
2010 |
|
|
5
|
2011 |
// Values to use for comparison against the URL. |
|
0
|
2012 |
$path = isset( $this->path ) ? $this->path : '/'; |
|
|
2013 |
$port = isset( $this->port ) ? $this->port : null; |
|
|
2014 |
$domain = isset( $this->domain ) ? strtolower( $this->domain ) : strtolower( $url['host'] ); |
|
|
2015 |
if ( false === stripos( $domain, '.' ) ) |
|
|
2016 |
$domain .= '.local'; |
|
|
2017 |
|
|
5
|
2018 |
// Host - very basic check that the request URL ends with the domain restriction (minus leading dot). |
|
0
|
2019 |
$domain = substr( $domain, 0, 1 ) == '.' ? substr( $domain, 1 ) : $domain; |
|
|
2020 |
if ( substr( $url['host'], -strlen( $domain ) ) != $domain ) |
|
|
2021 |
return false; |
|
|
2022 |
|
|
5
|
2023 |
// Port - supports "port-lists" in the format: "80,8000,8080". |
|
0
|
2024 |
if ( !empty( $port ) && !in_array( $url['port'], explode( ',', $port) ) ) |
|
|
2025 |
return false; |
|
|
2026 |
|
|
5
|
2027 |
// Path - request path must start with path restriction. |
|
0
|
2028 |
if ( substr( $url['path'], 0, strlen( $path ) ) != $path ) |
|
|
2029 |
return false; |
|
|
2030 |
|
|
|
2031 |
return true; |
|
|
2032 |
} |
|
|
2033 |
|
|
|
2034 |
/** |
|
|
2035 |
* Convert cookie name and value back to header string. |
|
|
2036 |
* |
|
|
2037 |
* @access public |
|
|
2038 |
* @since 2.8.0 |
|
|
2039 |
* |
|
|
2040 |
* @return string Header encoded cookie name and value. |
|
|
2041 |
*/ |
|
5
|
2042 |
public function getHeaderValue() { |
|
0
|
2043 |
if ( ! isset( $this->name ) || ! isset( $this->value ) ) |
|
|
2044 |
return ''; |
|
|
2045 |
|
|
5
|
2046 |
/** |
|
|
2047 |
* Filter the header-encoded cookie value. |
|
|
2048 |
* |
|
|
2049 |
* @since 3.4.0 |
|
|
2050 |
* |
|
|
2051 |
* @param string $value The cookie value. |
|
|
2052 |
* @param string $name The cookie name. |
|
|
2053 |
*/ |
|
0
|
2054 |
return $this->name . '=' . apply_filters( 'wp_http_cookie_value', $this->value, $this->name ); |
|
|
2055 |
} |
|
|
2056 |
|
|
|
2057 |
/** |
|
|
2058 |
* Retrieve cookie header for usage in the rest of the WordPress HTTP API. |
|
|
2059 |
* |
|
|
2060 |
* @access public |
|
|
2061 |
* @since 2.8.0 |
|
|
2062 |
* |
|
|
2063 |
* @return string |
|
|
2064 |
*/ |
|
5
|
2065 |
public function getFullHeader() { |
|
0
|
2066 |
return 'Cookie: ' . $this->getHeaderValue(); |
|
|
2067 |
} |
|
|
2068 |
} |
|
|
2069 |
|
|
|
2070 |
/** |
|
|
2071 |
* Implementation for deflate and gzip transfer encodings. |
|
|
2072 |
* |
|
|
2073 |
* Includes RFC 1950, RFC 1951, and RFC 1952. |
|
|
2074 |
* |
|
5
|
2075 |
* @since 2.8.0 |
|
0
|
2076 |
* @package WordPress |
|
|
2077 |
* @subpackage HTTP |
|
|
2078 |
*/ |
|
|
2079 |
class WP_Http_Encoding { |
|
|
2080 |
|
|
|
2081 |
/** |
|
|
2082 |
* Compress raw string using the deflate format. |
|
|
2083 |
* |
|
|
2084 |
* Supports the RFC 1951 standard. |
|
|
2085 |
* |
|
5
|
2086 |
* @since 2.8.0 |
|
0
|
2087 |
* |
|
|
2088 |
* @param string $raw String to compress. |
|
|
2089 |
* @param int $level Optional, default is 9. Compression level, 9 is highest. |
|
|
2090 |
* @param string $supports Optional, not used. When implemented it will choose the right compression based on what the server supports. |
|
5
|
2091 |
* @return string|false False on failure. |
|
0
|
2092 |
*/ |
|
|
2093 |
public static function compress( $raw, $level = 9, $supports = null ) { |
|
|
2094 |
return gzdeflate( $raw, $level ); |
|
|
2095 |
} |
|
|
2096 |
|
|
|
2097 |
/** |
|
|
2098 |
* Decompression of deflated string. |
|
|
2099 |
* |
|
|
2100 |
* Will attempt to decompress using the RFC 1950 standard, and if that fails |
|
|
2101 |
* then the RFC 1951 standard deflate will be attempted. Finally, the RFC |
|
|
2102 |
* 1952 standard gzip decode will be attempted. If all fail, then the |
|
|
2103 |
* original compressed string will be returned. |
|
|
2104 |
* |
|
5
|
2105 |
* @since 2.8.0 |
|
0
|
2106 |
* |
|
|
2107 |
* @param string $compressed String to decompress. |
|
|
2108 |
* @param int $length The optional length of the compressed data. |
|
|
2109 |
* @return string|bool False on failure. |
|
|
2110 |
*/ |
|
|
2111 |
public static function decompress( $compressed, $length = null ) { |
|
|
2112 |
|
|
|
2113 |
if ( empty($compressed) ) |
|
|
2114 |
return $compressed; |
|
|
2115 |
|
|
|
2116 |
if ( false !== ( $decompressed = @gzinflate( $compressed ) ) ) |
|
|
2117 |
return $decompressed; |
|
|
2118 |
|
|
5
|
2119 |
if ( false !== ( $decompressed = self::compatible_gzinflate( $compressed ) ) ) |
|
0
|
2120 |
return $decompressed; |
|
|
2121 |
|
|
|
2122 |
if ( false !== ( $decompressed = @gzuncompress( $compressed ) ) ) |
|
|
2123 |
return $decompressed; |
|
|
2124 |
|
|
|
2125 |
if ( function_exists('gzdecode') ) { |
|
|
2126 |
$decompressed = @gzdecode( $compressed ); |
|
|
2127 |
|
|
|
2128 |
if ( false !== $decompressed ) |
|
|
2129 |
return $decompressed; |
|
|
2130 |
} |
|
|
2131 |
|
|
|
2132 |
return $compressed; |
|
|
2133 |
} |
|
|
2134 |
|
|
|
2135 |
/** |
|
|
2136 |
* Decompression of deflated string while staying compatible with the majority of servers. |
|
|
2137 |
* |
|
|
2138 |
* Certain Servers will return deflated data with headers which PHP's gzinflate() |
|
|
2139 |
* function cannot handle out of the box. The following function has been created from |
|
|
2140 |
* various snippets on the gzinflate() PHP documentation. |
|
|
2141 |
* |
|
|
2142 |
* Warning: Magic numbers within. Due to the potential different formats that the compressed |
|
|
2143 |
* data may be returned in, some "magic offsets" are needed to ensure proper decompression |
|
|
2144 |
* takes place. For a simple progmatic way to determine the magic offset in use, see: |
|
5
|
2145 |
* https://core.trac.wordpress.org/ticket/18273 |
|
0
|
2146 |
* |
|
|
2147 |
* @since 2.8.1 |
|
5
|
2148 |
* @link https://core.trac.wordpress.org/ticket/18273 |
|
0
|
2149 |
* @link http://au2.php.net/manual/en/function.gzinflate.php#70875 |
|
|
2150 |
* @link http://au2.php.net/manual/en/function.gzinflate.php#77336 |
|
|
2151 |
* |
|
|
2152 |
* @param string $gzData String to decompress. |
|
|
2153 |
* @return string|bool False on failure. |
|
|
2154 |
*/ |
|
|
2155 |
public static function compatible_gzinflate($gzData) { |
|
|
2156 |
|
|
5
|
2157 |
// Compressed data might contain a full header, if so strip it for gzinflate(). |
|
0
|
2158 |
if ( substr($gzData, 0, 3) == "\x1f\x8b\x08" ) { |
|
|
2159 |
$i = 10; |
|
|
2160 |
$flg = ord( substr($gzData, 3, 1) ); |
|
|
2161 |
if ( $flg > 0 ) { |
|
|
2162 |
if ( $flg & 4 ) { |
|
|
2163 |
list($xlen) = unpack('v', substr($gzData, $i, 2) ); |
|
|
2164 |
$i = $i + 2 + $xlen; |
|
|
2165 |
} |
|
|
2166 |
if ( $flg & 8 ) |
|
|
2167 |
$i = strpos($gzData, "\0", $i) + 1; |
|
|
2168 |
if ( $flg & 16 ) |
|
|
2169 |
$i = strpos($gzData, "\0", $i) + 1; |
|
|
2170 |
if ( $flg & 2 ) |
|
|
2171 |
$i = $i + 2; |
|
|
2172 |
} |
|
|
2173 |
$decompressed = @gzinflate( substr($gzData, $i, -8) ); |
|
|
2174 |
if ( false !== $decompressed ) |
|
|
2175 |
return $decompressed; |
|
|
2176 |
} |
|
|
2177 |
|
|
|
2178 |
// Compressed data from java.util.zip.Deflater amongst others. |
|
|
2179 |
$decompressed = @gzinflate( substr($gzData, 2) ); |
|
|
2180 |
if ( false !== $decompressed ) |
|
|
2181 |
return $decompressed; |
|
|
2182 |
|
|
|
2183 |
return false; |
|
|
2184 |
} |
|
|
2185 |
|
|
|
2186 |
/** |
|
|
2187 |
* What encoding types to accept and their priority values. |
|
|
2188 |
* |
|
5
|
2189 |
* @since 2.8.0 |
|
0
|
2190 |
* |
|
5
|
2191 |
* @param string $url |
|
|
2192 |
* @param array $args |
|
0
|
2193 |
* @return string Types of encoding to accept. |
|
|
2194 |
*/ |
|
|
2195 |
public static function accept_encoding( $url, $args ) { |
|
|
2196 |
$type = array(); |
|
5
|
2197 |
$compression_enabled = self::is_available(); |
|
0
|
2198 |
|
|
5
|
2199 |
if ( ! $args['decompress'] ) // Decompression specifically disabled. |
|
0
|
2200 |
$compression_enabled = false; |
|
5
|
2201 |
elseif ( $args['stream'] ) // Disable when streaming to file. |
|
0
|
2202 |
$compression_enabled = false; |
|
5
|
2203 |
elseif ( isset( $args['limit_response_size'] ) ) // If only partial content is being requested, we won't be able to decompress it. |
|
0
|
2204 |
$compression_enabled = false; |
|
|
2205 |
|
|
|
2206 |
if ( $compression_enabled ) { |
|
|
2207 |
if ( function_exists( 'gzinflate' ) ) |
|
|
2208 |
$type[] = 'deflate;q=1.0'; |
|
|
2209 |
|
|
|
2210 |
if ( function_exists( 'gzuncompress' ) ) |
|
|
2211 |
$type[] = 'compress;q=0.5'; |
|
|
2212 |
|
|
|
2213 |
if ( function_exists( 'gzdecode' ) ) |
|
|
2214 |
$type[] = 'gzip;q=0.5'; |
|
|
2215 |
} |
|
|
2216 |
|
|
5
|
2217 |
/** |
|
|
2218 |
* Filter the allowed encoding types. |
|
|
2219 |
* |
|
|
2220 |
* @since 3.6.0 |
|
|
2221 |
* |
|
|
2222 |
* @param array $type Encoding types allowed. Accepts 'gzinflate', |
|
|
2223 |
* 'gzuncompress', 'gzdecode'. |
|
|
2224 |
* @param string $url URL of the HTTP request. |
|
|
2225 |
* @param array $args HTTP request arguments. |
|
|
2226 |
*/ |
|
0
|
2227 |
$type = apply_filters( 'wp_http_accept_encoding', $type, $url, $args ); |
|
|
2228 |
|
|
|
2229 |
return implode(', ', $type); |
|
|
2230 |
} |
|
|
2231 |
|
|
|
2232 |
/** |
|
|
2233 |
* What encoding the content used when it was compressed to send in the headers. |
|
|
2234 |
* |
|
5
|
2235 |
* @since 2.8.0 |
|
0
|
2236 |
* |
|
|
2237 |
* @return string Content-Encoding string to send in the header. |
|
|
2238 |
*/ |
|
|
2239 |
public static function content_encoding() { |
|
|
2240 |
return 'deflate'; |
|
|
2241 |
} |
|
|
2242 |
|
|
|
2243 |
/** |
|
|
2244 |
* Whether the content be decoded based on the headers. |
|
|
2245 |
* |
|
5
|
2246 |
* @since 2.8.0 |
|
0
|
2247 |
* |
|
|
2248 |
* @param array|string $headers All of the available headers. |
|
|
2249 |
* @return bool |
|
|
2250 |
*/ |
|
|
2251 |
public static function should_decode($headers) { |
|
|
2252 |
if ( is_array( $headers ) ) { |
|
|
2253 |
if ( array_key_exists('content-encoding', $headers) && ! empty( $headers['content-encoding'] ) ) |
|
|
2254 |
return true; |
|
5
|
2255 |
} elseif ( is_string( $headers ) ) { |
|
0
|
2256 |
return ( stripos($headers, 'content-encoding:') !== false ); |
|
|
2257 |
} |
|
|
2258 |
|
|
|
2259 |
return false; |
|
|
2260 |
} |
|
|
2261 |
|
|
|
2262 |
/** |
|
|
2263 |
* Whether decompression and compression are supported by the PHP version. |
|
|
2264 |
* |
|
|
2265 |
* Each function is tested instead of checking for the zlib extension, to |
|
|
2266 |
* ensure that the functions all exist in the PHP version and aren't |
|
|
2267 |
* disabled. |
|
|
2268 |
* |
|
5
|
2269 |
* @since 2.8.0 |
|
0
|
2270 |
* |
|
|
2271 |
* @return bool |
|
|
2272 |
*/ |
|
|
2273 |
public static function is_available() { |
|
|
2274 |
return ( function_exists('gzuncompress') || function_exists('gzdeflate') || function_exists('gzinflate') ); |
|
|
2275 |
} |
|
|
2276 |
} |