]> scripts.mit.edu Git - autoinstalls/wordpress.git/blob - wp-includes/class-http.php
WordPress 4.6.2
[autoinstalls/wordpress.git] / wp-includes / class-http.php
1 <?php
2 /**
3  * HTTP API: WP_Http class
4  *
5  * @package WordPress
6  * @subpackage HTTP
7  * @since 2.7.0
8  */
9
10 if ( ! class_exists( 'Requests' ) ) {
11         require( ABSPATH . WPINC . '/class-requests.php' );
12
13         Requests::register_autoloader();
14         Requests::set_certificate_path( ABSPATH . WPINC . '/certificates/ca-bundle.crt' );
15 }
16
17 /**
18  * Core class used for managing HTTP transports and making HTTP requests.
19  *
20  * This class is used to consistently make outgoing HTTP requests easy for developers
21  * while still being compatible with the many PHP configurations under which
22  * WordPress runs.
23  *
24  * Debugging includes several actions, which pass different variables for debugging the HTTP API.
25  *
26  * @since 2.7.0
27  */
28 class WP_Http {
29
30         // Aliases for HTTP response codes.
31         const HTTP_CONTINUE                   = 100;
32         const SWITCHING_PROTOCOLS             = 101;
33         const PROCESSING                      = 102;
34
35         const OK                              = 200;
36         const CREATED                         = 201;
37         const ACCEPTED                        = 202;
38         const NON_AUTHORITATIVE_INFORMATION   = 203;
39         const NO_CONTENT                      = 204;
40         const RESET_CONTENT                   = 205;
41         const PARTIAL_CONTENT                 = 206;
42         const MULTI_STATUS                    = 207;
43         const IM_USED                         = 226;
44
45         const MULTIPLE_CHOICES                = 300;
46         const MOVED_PERMANENTLY               = 301;
47         const FOUND                           = 302;
48         const SEE_OTHER                       = 303;
49         const NOT_MODIFIED                    = 304;
50         const USE_PROXY                       = 305;
51         const RESERVED                        = 306;
52         const TEMPORARY_REDIRECT              = 307;
53         const PERMANENT_REDIRECT              = 308;
54
55         const BAD_REQUEST                     = 400;
56         const UNAUTHORIZED                    = 401;
57         const PAYMENT_REQUIRED                = 402;
58         const FORBIDDEN                       = 403;
59         const NOT_FOUND                       = 404;
60         const METHOD_NOT_ALLOWED              = 405;
61         const NOT_ACCEPTABLE                  = 406;
62         const PROXY_AUTHENTICATION_REQUIRED   = 407;
63         const REQUEST_TIMEOUT                 = 408;
64         const CONFLICT                        = 409;
65         const GONE                            = 410;
66         const LENGTH_REQUIRED                 = 411;
67         const PRECONDITION_FAILED             = 412;
68         const REQUEST_ENTITY_TOO_LARGE        = 413;
69         const REQUEST_URI_TOO_LONG            = 414;
70         const UNSUPPORTED_MEDIA_TYPE          = 415;
71         const REQUESTED_RANGE_NOT_SATISFIABLE = 416;
72         const EXPECTATION_FAILED              = 417;
73         const IM_A_TEAPOT                     = 418;
74         const MISDIRECTED_REQUEST             = 421;
75         const UNPROCESSABLE_ENTITY            = 422;
76         const LOCKED                          = 423;
77         const FAILED_DEPENDENCY               = 424;
78         const UPGRADE_REQUIRED                = 426;
79         const PRECONDITION_REQUIRED           = 428;
80         const TOO_MANY_REQUESTS               = 429;
81         const REQUEST_HEADER_FIELDS_TOO_LARGE = 431;
82         const UNAVAILABLE_FOR_LEGAL_REASONS   = 451;
83
84         const INTERNAL_SERVER_ERROR           = 500;
85         const NOT_IMPLEMENTED                 = 501;
86         const BAD_GATEWAY                     = 502;
87         const SERVICE_UNAVAILABLE             = 503;
88         const GATEWAY_TIMEOUT                 = 504;
89         const HTTP_VERSION_NOT_SUPPORTED      = 505;
90         const VARIANT_ALSO_NEGOTIATES         = 506;
91         const INSUFFICIENT_STORAGE            = 507;
92         const NOT_EXTENDED                    = 510;
93         const NETWORK_AUTHENTICATION_REQUIRED = 511;
94
95         /**
96          * Send an HTTP request to a URI.
97          *
98          * Please note: The only URI that are supported in the HTTP Transport implementation
99          * are the HTTP and HTTPS protocols.
100          *
101          * @access public
102          * @since 2.7.0
103          *
104          * @global string $wp_version
105          *
106          * @param string       $url  The request URL.
107          * @param string|array $args {
108          *     Optional. Array or string of HTTP request arguments.
109          *
110          *     @type string       $method              Request method. Accepts 'GET', 'POST', 'HEAD', or 'PUT'.
111          *                                             Some transports technically allow others, but should not be
112          *                                             assumed. Default 'GET'.
113          *     @type int          $timeout             How long the connection should stay open in seconds. Default 5.
114          *     @type int          $redirection         Number of allowed redirects. Not supported by all transports
115          *                                             Default 5.
116          *     @type string       $httpversion         Version of the HTTP protocol to use. Accepts '1.0' and '1.1'.
117          *                                             Default '1.0'.
118          *     @type string       $user-agent          User-agent value sent.
119          *                                             Default WordPress/' . $wp_version . '; ' . get_bloginfo( 'url' ).
120          *     @type bool         $reject_unsafe_urls  Whether to pass URLs through wp_http_validate_url().
121          *                                             Default false.
122          *     @type bool         $blocking            Whether the calling code requires the result of the request.
123          *                                             If set to false, the request will be sent to the remote server,
124          *                                             and processing returned to the calling code immediately, the caller
125          *                                             will know if the request succeeded or failed, but will not receive
126          *                                             any response from the remote server. Default true.
127          *     @type string|array $headers             Array or string of headers to send with the request.
128          *                                             Default empty array.
129          *     @type array        $cookies             List of cookies to send with the request. Default empty array.
130          *     @type string|array $body                Body to send with the request. Default null.
131          *     @type bool         $compress            Whether to compress the $body when sending the request.
132          *                                             Default false.
133          *     @type bool         $decompress          Whether to decompress a compressed response. If set to false and
134          *                                             compressed content is returned in the response anyway, it will
135          *                                             need to be separately decompressed. Default true.
136          *     @type bool         $sslverify           Whether to verify SSL for the request. Default true.
137          *     @type string       sslcertificates      Absolute path to an SSL certificate .crt file.
138          *                                             Default ABSPATH . WPINC . '/certificates/ca-bundle.crt'.
139          *     @type bool         $stream              Whether to stream to a file. If set to true and no filename was
140          *                                             given, it will be droped it in the WP temp dir and its name will
141          *                                             be set using the basename of the URL. Default false.
142          *     @type string       $filename            Filename of the file to write to when streaming. $stream must be
143          *                                             set to true. Default null.
144          *     @type int          $limit_response_size Size in bytes to limit the response to. Default null.
145          *
146          * }
147          * @return array|WP_Error Array containing 'headers', 'body', 'response', 'cookies', 'filename'.
148          *                        A WP_Error instance upon error.
149          */
150         public function request( $url, $args = array() ) {
151                 global $wp_version;
152
153                 $defaults = array(
154                         'method' => 'GET',
155                         /**
156                          * Filters the timeout value for an HTTP request.
157                          *
158                          * @since 2.7.0
159                          *
160                          * @param int $timeout_value Time in seconds until a request times out.
161                          *                           Default 5.
162                          */
163                         'timeout' => apply_filters( 'http_request_timeout', 5 ),
164                         /**
165                          * Filters the number of redirects allowed during an HTTP request.
166                          *
167                          * @since 2.7.0
168                          *
169                          * @param int $redirect_count Number of redirects allowed. Default 5.
170                          */
171                         'redirection' => apply_filters( 'http_request_redirection_count', 5 ),
172                         /**
173                          * Filters the version of the HTTP protocol used in a request.
174                          *
175                          * @since 2.7.0
176                          *
177                          * @param string $version Version of HTTP used. Accepts '1.0' and '1.1'.
178                          *                        Default '1.0'.
179                          */
180                         'httpversion' => apply_filters( 'http_request_version', '1.0' ),
181                         /**
182                          * Filters the user agent value sent with an HTTP request.
183                          *
184                          * @since 2.7.0
185                          *
186                          * @param string $user_agent WordPress user agent string.
187                          */
188                         'user-agent' => apply_filters( 'http_headers_useragent', 'WordPress/' . $wp_version . '; ' . get_bloginfo( 'url' ) ),
189                         /**
190                          * Filters whether to pass URLs through wp_http_validate_url() in an HTTP request.
191                          *
192                          * @since 3.6.0
193                          *
194                          * @param bool $pass_url Whether to pass URLs through wp_http_validate_url().
195                          *                       Default false.
196                          */
197                         'reject_unsafe_urls' => apply_filters( 'http_request_reject_unsafe_urls', false ),
198                         'blocking' => true,
199                         'headers' => array(),
200                         'cookies' => array(),
201                         'body' => null,
202                         'compress' => false,
203                         'decompress' => true,
204                         'sslverify' => true,
205                         'sslcertificates' => ABSPATH . WPINC . '/certificates/ca-bundle.crt',
206                         'stream' => false,
207                         'filename' => null,
208                         'limit_response_size' => null,
209                 );
210
211                 // Pre-parse for the HEAD checks.
212                 $args = wp_parse_args( $args );
213
214                 // By default, Head requests do not cause redirections.
215                 if ( isset($args['method']) && 'HEAD' == $args['method'] )
216                         $defaults['redirection'] = 0;
217
218                 $r = wp_parse_args( $args, $defaults );
219                 /**
220                  * Filters the arguments used in an HTTP request.
221                  *
222                  * @since 2.7.0
223                  *
224                  * @param array  $r   An array of HTTP request arguments.
225                  * @param string $url The request URL.
226                  */
227                 $r = apply_filters( 'http_request_args', $r, $url );
228
229                 // The transports decrement this, store a copy of the original value for loop purposes.
230                 if ( ! isset( $r['_redirection'] ) )
231                         $r['_redirection'] = $r['redirection'];
232
233                 /**
234                  * Filters whether to preempt an HTTP request's return value.
235                  *
236                  * Returning a non-false value from the filter will short-circuit the HTTP request and return
237                  * early with that value. A filter should return either:
238                  *
239                  *  - An array containing 'headers', 'body', 'response', 'cookies', and 'filename' elements
240                  *  - A WP_Error instance
241                  *  - boolean false (to avoid short-circuiting the response)
242                  *
243                  * Returning any other value may result in unexpected behaviour.
244                  *
245                  * @since 2.9.0
246                  *
247                  * @param false|array|WP_Error $preempt Whether to preempt an HTTP request's return value. Default false.
248                  * @param array               $r        HTTP request arguments.
249                  * @param string              $url      The request URL.
250                  */
251                 $pre = apply_filters( 'pre_http_request', false, $r, $url );
252
253                 if ( false !== $pre )
254                         return $pre;
255
256                 if ( function_exists( 'wp_kses_bad_protocol' ) ) {
257                         if ( $r['reject_unsafe_urls'] ) {
258                                 $url = wp_http_validate_url( $url );
259                         }
260                         if ( $url ) {
261                                 $url = wp_kses_bad_protocol( $url, array( 'http', 'https', 'ssl' ) );
262                         }
263                 }
264
265                 $arrURL = @parse_url( $url );
266
267                 if ( empty( $url ) || empty( $arrURL['scheme'] ) ) {
268                         return new WP_Error('http_request_failed', __('A valid URL was not provided.'));
269                 }
270
271                 if ( $this->block_request( $url ) ) {
272                         return new WP_Error( 'http_request_failed', __( 'User has blocked requests through HTTP.' ) );
273                 }
274
275                 // If we are streaming to a file but no filename was given drop it in the WP temp dir
276                 // and pick its name using the basename of the $url
277                 if ( $r['stream'] ) {
278                         if ( empty( $r['filename'] ) ) {
279                                 $r['filename'] = get_temp_dir() . basename( $url );
280                         }
281
282                         // Force some settings if we are streaming to a file and check for existence and perms of destination directory
283                         $r['blocking'] = true;
284                         if ( ! wp_is_writable( dirname( $r['filename'] ) ) ) {
285                                 return new WP_Error( 'http_request_failed', __( 'Destination directory for file streaming does not exist or is not writable.' ) );
286                         }
287                 }
288
289                 if ( is_null( $r['headers'] ) ) {
290                         $r['headers'] = array();
291                 }
292
293                 // WP allows passing in headers as a string, weirdly.
294                 if ( ! is_array( $r['headers'] ) ) {
295                         $processedHeaders = WP_Http::processHeaders( $r['headers'] );
296                         $r['headers'] = $processedHeaders['headers'];
297                 }
298
299                 // Setup arguments
300                 $headers = $r['headers'];
301                 $data = $r['body'];
302                 $type = $r['method'];
303                 $options = array(
304                         'timeout' => $r['timeout'],
305                         'useragent' => $r['user-agent'],
306                         'blocking' => $r['blocking'],
307                         'hooks' => new Requests_Hooks(),
308                 );
309
310                 // Ensure redirects follow browser behaviour.
311                 $options['hooks']->register( 'requests.before_redirect', array( get_class(), 'browser_redirect_compatibility' ) );
312
313                 if ( $r['stream'] ) {
314                         $options['filename'] = $r['filename'];
315                 }
316                 if ( empty( $r['redirection'] ) ) {
317                         $options['follow_redirects'] = false;
318                 } else {
319                         $options['redirects'] = $r['redirection'];
320                 }
321
322                 // Use byte limit, if we can
323                 if ( isset( $r['limit_response_size'] ) ) {
324                         $options['max_bytes'] = $r['limit_response_size'];
325                 }
326
327                 // If we've got cookies, use and convert them to Requests_Cookie.
328                 if ( ! empty( $r['cookies'] ) ) {
329                         $options['cookies'] = WP_Http::normalize_cookies( $r['cookies'] );
330                 }
331
332                 // SSL certificate handling
333                 if ( ! $r['sslverify'] ) {
334                         $options['verify'] = false;
335                         $options['verifyname'] = false;
336                 } else {
337                         $options['verify'] = $r['sslcertificates'];
338                 }
339
340                 // All non-GET/HEAD requests should put the arguments in the form body.
341                 if ( 'HEAD' !== $type && 'GET' !== $type ) {
342                         $options['data_format'] = 'body';
343                 }
344
345                 /**
346                  * Filters whether SSL should be verified for non-local requests.
347                  *
348                  * @since 2.8.0
349                  *
350                  * @param bool $ssl_verify Whether to verify the SSL connection. Default true.
351                  */
352                 $options['verify'] = apply_filters( 'https_ssl_verify', $options['verify'] );
353
354                 // Check for proxies.
355                 $proxy = new WP_HTTP_Proxy();
356                 if ( $proxy->is_enabled() && $proxy->send_through_proxy( $url ) ) {
357                         $options['proxy'] = new Requests_Proxy_HTTP( $proxy->host() . ':' . $proxy->port() );
358
359                         if ( $proxy->use_authentication() ) {
360                                 $options['proxy']->use_authentication = true;
361                                 $options['proxy']->user = $proxy->username();
362                                 $options['proxy']->pass = $proxy->password();
363                         }
364                 }
365
366                 // Avoid issues where mbstring.func_overload is enabled
367                 mbstring_binary_safe_encoding();
368
369                 try {
370                         $requests_response = Requests::request( $url, $headers, $data, $type, $options );
371
372                         // Convert the response into an array
373                         $http_response = new WP_HTTP_Requests_Response( $requests_response, $r['filename'] );
374                         $response = $http_response->to_array();
375
376                         // Add the original object to the array.
377                         $response['http_response'] = $http_response;
378                 }
379                 catch ( Requests_Exception $e ) {
380                         $response = new WP_Error( 'http_request_failed', $e->getMessage() );
381                 }
382
383                 reset_mbstring_encoding();
384
385                 /**
386                  * Fires after an HTTP API response is received and before the response is returned.
387                  *
388                  * @since 2.8.0
389                  *
390                  * @param array|WP_Error $response HTTP response or WP_Error object.
391                  * @param string         $context  Context under which the hook is fired.
392                  * @param string         $class    HTTP transport used.
393                  * @param array          $args     HTTP request arguments.
394                  * @param string         $url      The request URL.
395                  */
396                 do_action( 'http_api_debug', $response, 'response', 'Requests', $r, $url );
397                 if ( is_wp_error( $response ) ) {
398                         return $response;
399                 }
400
401                 if ( ! $r['blocking'] ) {
402                         return array(
403                                 'headers' => array(),
404                                 'body' => '',
405                                 'response' => array(
406                                         'code' => false,
407                                         'message' => false,
408                                 ),
409                                 'cookies' => array(),
410                                 'http_response' => null,
411                         );
412                 }
413
414                 /**
415                  * Filters the HTTP API response immediately before the response is returned.
416                  *
417                  * @since 2.9.0
418                  *
419                  * @param array  $response HTTP response.
420                  * @param array  $r        HTTP request arguments.
421                  * @param string $url      The request URL.
422                  */
423                 return apply_filters( 'http_response', $response, $r, $url );
424         }
425
426         /**
427          * Normalizes cookies for using in Requests.
428          *
429          * @since 4.6.0
430          * @access public
431          * @static
432          *
433          * @param array $cookies List of cookies to send with the request.
434          * @return Requests_Cookie_Jar Cookie holder object.
435          */
436         public static function normalize_cookies( $cookies ) {
437                 $cookie_jar = new Requests_Cookie_Jar();
438
439                 foreach ( $cookies as $name => $value ) {
440                         if ( $value instanceof WP_Http_Cookie ) {
441                                 $cookie_jar[ $value->name ] = new Requests_Cookie( $value->name, $value->value, $value->get_attributes() );
442                         } elseif ( is_scalar( $value ) ) {
443                                 $cookie_jar[ $name ] = new Requests_Cookie( $name, $value );
444                         }
445                 }
446
447                 return $cookie_jar;
448         }
449
450         /**
451          * Match redirect behaviour to browser handling.
452          *
453          * Changes 302 redirects from POST to GET to match browser handling. Per
454          * RFC 7231, user agents can deviate from the strict reading of the
455          * specification for compatibility purposes.
456          *
457          * @since 4.6.0
458          * @access public
459          * @static
460          *
461          * @param string            $location URL to redirect to.
462          * @param array             $headers  Headers for the redirect.
463          * @param array             $options  Redirect request options.
464          * @param Requests_Response $original Response object.
465          */
466         public static function browser_redirect_compatibility( $location, $headers, $data, &$options, $original ) {
467                 // Browser compat
468                 if ( $original->status_code === 302 ) {
469                         $options['type'] = Requests::GET;
470                 }
471         }
472
473         /**
474          * Tests which transports are capable of supporting the request.
475          *
476          * @since 3.2.0
477          * @access public
478          *
479          * @param array $args Request arguments
480          * @param string $url URL to Request
481          *
482          * @return string|false Class name for the first transport that claims to support the request. False if no transport claims to support the request.
483          */
484         public function _get_first_available_transport( $args, $url = null ) {
485                 $transports = array( 'curl', 'streams' );
486
487                 /**
488                  * Filters which HTTP transports are available and in what order.
489                  *
490                  * @since 3.7.0
491                  *
492                  * @param array  $transports Array of HTTP transports to check. Default array contains
493                  *                           'curl', and 'streams', in that order.
494                  * @param array  $args       HTTP request arguments.
495                  * @param string $url        The URL to request.
496                  */
497                 $request_order = apply_filters( 'http_api_transports', $transports, $args, $url );
498
499                 // Loop over each transport on each HTTP request looking for one which will serve this request's needs.
500                 foreach ( $request_order as $transport ) {
501                         if ( in_array( $transport, $transports ) ) {
502                                 $transport = ucfirst( $transport );
503                         }
504                         $class = 'WP_Http_' . $transport;
505
506                         // Check to see if this transport is a possibility, calls the transport statically.
507                         if ( !call_user_func( array( $class, 'test' ), $args, $url ) )
508                                 continue;
509
510                         return $class;
511                 }
512
513                 return false;
514         }
515
516         /**
517          * Dispatches a HTTP request to a supporting transport.
518          *
519          * Tests each transport in order to find a transport which matches the request arguments.
520          * Also caches the transport instance to be used later.
521          *
522          * The order for requests is cURL, and then PHP Streams.
523          *
524          * @since 3.2.0
525          *
526          * @static
527          * @access private
528          *
529          * @param string $url URL to Request
530          * @param array $args Request arguments
531          * @return array|WP_Error Array containing 'headers', 'body', 'response', 'cookies', 'filename'. A WP_Error instance upon error
532          */
533         private function _dispatch_request( $url, $args ) {
534                 static $transports = array();
535
536                 $class = $this->_get_first_available_transport( $args, $url );
537                 if ( !$class )
538                         return new WP_Error( 'http_failure', __( 'There are no HTTP transports available which can complete the requested request.' ) );
539
540                 // Transport claims to support request, instantiate it and give it a whirl.
541                 if ( empty( $transports[$class] ) )
542                         $transports[$class] = new $class;
543
544                 $response = $transports[$class]->request( $url, $args );
545
546                 /** This action is documented in wp-includes/class-http.php */
547                 do_action( 'http_api_debug', $response, 'response', $class, $args, $url );
548
549                 if ( is_wp_error( $response ) )
550                         return $response;
551
552                 /**
553                  * Filters the HTTP API response immediately before the response is returned.
554                  *
555                  * @since 2.9.0
556                  *
557                  * @param array  $response HTTP response.
558                  * @param array  $args     HTTP request arguments.
559                  * @param string $url      The request URL.
560                  */
561                 return apply_filters( 'http_response', $response, $args, $url );
562         }
563
564         /**
565          * Uses the POST HTTP method.
566          *
567          * Used for sending data that is expected to be in the body.
568          *
569          * @access public
570          * @since 2.7.0
571          *
572          * @param string       $url  The request URL.
573          * @param string|array $args Optional. Override the defaults.
574          * @return array|WP_Error Array containing 'headers', 'body', 'response', 'cookies', 'filename'. A WP_Error instance upon error
575          */
576         public function post($url, $args = array()) {
577                 $defaults = array('method' => 'POST');
578                 $r = wp_parse_args( $args, $defaults );
579                 return $this->request($url, $r);
580         }
581
582         /**
583          * Uses the GET HTTP method.
584          *
585          * Used for sending data that is expected to be in the body.
586          *
587          * @access public
588          * @since 2.7.0
589          *
590          * @param string $url The request URL.
591          * @param string|array $args Optional. Override the defaults.
592          * @return array|WP_Error Array containing 'headers', 'body', 'response', 'cookies', 'filename'. A WP_Error instance upon error
593          */
594         public function get($url, $args = array()) {
595                 $defaults = array('method' => 'GET');
596                 $r = wp_parse_args( $args, $defaults );
597                 return $this->request($url, $r);
598         }
599
600         /**
601          * Uses the HEAD HTTP method.
602          *
603          * Used for sending data that is expected to be in the body.
604          *
605          * @access public
606          * @since 2.7.0
607          *
608          * @param string $url The request URL.
609          * @param string|array $args Optional. Override the defaults.
610          * @return array|WP_Error Array containing 'headers', 'body', 'response', 'cookies', 'filename'. A WP_Error instance upon error
611          */
612         public function head($url, $args = array()) {
613                 $defaults = array('method' => 'HEAD');
614                 $r = wp_parse_args( $args, $defaults );
615                 return $this->request($url, $r);
616         }
617
618         /**
619          * Parses the responses and splits the parts into headers and body.
620          *
621          * @access public
622          * @static
623          * @since 2.7.0
624          *
625          * @param string $strResponse The full response string
626          * @return array Array with 'headers' and 'body' keys.
627          */
628         public static function processResponse($strResponse) {
629                 $res = explode("\r\n\r\n", $strResponse, 2);
630
631                 return array('headers' => $res[0], 'body' => isset($res[1]) ? $res[1] : '');
632         }
633
634         /**
635          * Transform header string into an array.
636          *
637          * If an array is given then it is assumed to be raw header data with numeric keys with the
638          * headers as the values. No headers must be passed that were already processed.
639          *
640          * @access public
641          * @static
642          * @since 2.7.0
643          *
644          * @param string|array $headers
645          * @param string $url The URL that was requested
646          * @return array Processed string headers. If duplicate headers are encountered,
647          *                                      Then a numbered array is returned as the value of that header-key.
648          */
649         public static function processHeaders( $headers, $url = '' ) {
650                 // Split headers, one per array element.
651                 if ( is_string($headers) ) {
652                         // Tolerate line terminator: CRLF = LF (RFC 2616 19.3).
653                         $headers = str_replace("\r\n", "\n", $headers);
654                         /*
655                          * Unfold folded header fields. LWS = [CRLF] 1*( SP | HT ) <US-ASCII SP, space (32)>,
656                          * <US-ASCII HT, horizontal-tab (9)> (RFC 2616 2.2).
657                          */
658                         $headers = preg_replace('/\n[ \t]/', ' ', $headers);
659                         // Create the headers array.
660                         $headers = explode("\n", $headers);
661                 }
662
663                 $response = array('code' => 0, 'message' => '');
664
665                 /*
666                  * If a redirection has taken place, The headers for each page request may have been passed.
667                  * In this case, determine the final HTTP header and parse from there.
668                  */
669                 for ( $i = count($headers)-1; $i >= 0; $i-- ) {
670                         if ( !empty($headers[$i]) && false === strpos($headers[$i], ':') ) {
671                                 $headers = array_splice($headers, $i);
672                                 break;
673                         }
674                 }
675
676                 $cookies = array();
677                 $newheaders = array();
678                 foreach ( (array) $headers as $tempheader ) {
679                         if ( empty($tempheader) )
680                                 continue;
681
682                         if ( false === strpos($tempheader, ':') ) {
683                                 $stack = explode(' ', $tempheader, 3);
684                                 $stack[] = '';
685                                 list( , $response['code'], $response['message']) = $stack;
686                                 continue;
687                         }
688
689                         list($key, $value) = explode(':', $tempheader, 2);
690
691                         $key = strtolower( $key );
692                         $value = trim( $value );
693
694                         if ( isset( $newheaders[ $key ] ) ) {
695                                 if ( ! is_array( $newheaders[ $key ] ) )
696                                         $newheaders[$key] = array( $newheaders[ $key ] );
697                                 $newheaders[ $key ][] = $value;
698                         } else {
699                                 $newheaders[ $key ] = $value;
700                         }
701                         if ( 'set-cookie' == $key )
702                                 $cookies[] = new WP_Http_Cookie( $value, $url );
703                 }
704
705                 // Cast the Response Code to an int
706                 $response['code'] = intval( $response['code'] );
707
708                 return array('response' => $response, 'headers' => $newheaders, 'cookies' => $cookies);
709         }
710
711         /**
712          * Takes the arguments for a ::request() and checks for the cookie array.
713          *
714          * If it's found, then it upgrades any basic name => value pairs to WP_Http_Cookie instances,
715          * which are each parsed into strings and added to the Cookie: header (within the arguments array).
716          * Edits the array by reference.
717          *
718          * @access public
719          * @version 2.8.0
720          * @static
721          *
722          * @param array $r Full array of args passed into ::request()
723          */
724         public static function buildCookieHeader( &$r ) {
725                 if ( ! empty($r['cookies']) ) {
726                         // Upgrade any name => value cookie pairs to WP_HTTP_Cookie instances.
727                         foreach ( $r['cookies'] as $name => $value ) {
728                                 if ( ! is_object( $value ) )
729                                         $r['cookies'][ $name ] = new WP_Http_Cookie( array( 'name' => $name, 'value' => $value ) );
730                         }
731
732                         $cookies_header = '';
733                         foreach ( (array) $r['cookies'] as $cookie ) {
734                                 $cookies_header .= $cookie->getHeaderValue() . '; ';
735                         }
736
737                         $cookies_header = substr( $cookies_header, 0, -2 );
738                         $r['headers']['cookie'] = $cookies_header;
739                 }
740         }
741
742         /**
743          * Decodes chunk transfer-encoding, based off the HTTP 1.1 specification.
744          *
745          * Based off the HTTP http_encoding_dechunk function.
746          *
747          * @link https://tools.ietf.org/html/rfc2616#section-19.4.6 Process for chunked decoding.
748          *
749          * @access public
750          * @since 2.7.0
751          * @static
752          *
753          * @param string $body Body content
754          * @return string Chunked decoded body on success or raw body on failure.
755          */
756         public static function chunkTransferDecode( $body ) {
757                 // The body is not chunked encoded or is malformed.
758                 if ( ! preg_match( '/^([0-9a-f]+)[^\r\n]*\r\n/i', trim( $body ) ) )
759                         return $body;
760
761                 $parsed_body = '';
762
763                 // We'll be altering $body, so need a backup in case of error.
764                 $body_original = $body;
765
766                 while ( true ) {
767                         $has_chunk = (bool) preg_match( '/^([0-9a-f]+)[^\r\n]*\r\n/i', $body, $match );
768                         if ( ! $has_chunk || empty( $match[1] ) )
769                                 return $body_original;
770
771                         $length = hexdec( $match[1] );
772                         $chunk_length = strlen( $match[0] );
773
774                         // Parse out the chunk of data.
775                         $parsed_body .= substr( $body, $chunk_length, $length );
776
777                         // Remove the chunk from the raw data.
778                         $body = substr( $body, $length + $chunk_length );
779
780                         // End of the document.
781                         if ( '0' === trim( $body ) )
782                                 return $parsed_body;
783                 }
784         }
785
786         /**
787          * Block requests through the proxy.
788          *
789          * Those who are behind a proxy and want to prevent access to certain hosts may do so. This will
790          * prevent plugins from working and core functionality, if you don't include api.wordpress.org.
791          *
792          * You block external URL requests by defining WP_HTTP_BLOCK_EXTERNAL as true in your wp-config.php
793          * file and this will only allow localhost and your site to make requests. The constant
794          * WP_ACCESSIBLE_HOSTS will allow additional hosts to go through for requests. The format of the
795          * WP_ACCESSIBLE_HOSTS constant is a comma separated list of hostnames to allow, wildcard domains
796          * are supported, eg *.wordpress.org will allow for all subdomains of wordpress.org to be contacted.
797          *
798          * @since 2.8.0
799          * @link https://core.trac.wordpress.org/ticket/8927 Allow preventing external requests.
800          * @link https://core.trac.wordpress.org/ticket/14636 Allow wildcard domains in WP_ACCESSIBLE_HOSTS
801          *
802          * @staticvar array|null $accessible_hosts
803          * @staticvar array      $wildcard_regex
804          *
805          * @param string $uri URI of url.
806          * @return bool True to block, false to allow.
807          */
808         public function block_request($uri) {
809                 // We don't need to block requests, because nothing is blocked.
810                 if ( ! defined( 'WP_HTTP_BLOCK_EXTERNAL' ) || ! WP_HTTP_BLOCK_EXTERNAL )
811                         return false;
812
813                 $check = parse_url($uri);
814                 if ( ! $check )
815                         return true;
816
817                 $home = parse_url( get_option('siteurl') );
818
819                 // Don't block requests back to ourselves by default.
820                 if ( 'localhost' == $check['host'] || ( isset( $home['host'] ) && $home['host'] == $check['host'] ) ) {
821                         /**
822                          * Filters whether to block local requests through the proxy.
823                          *
824                          * @since 2.8.0
825                          *
826                          * @param bool $block Whether to block local requests through proxy.
827                          *                    Default false.
828                          */
829                         return apply_filters( 'block_local_requests', false );
830                 }
831
832                 if ( !defined('WP_ACCESSIBLE_HOSTS') )
833                         return true;
834
835                 static $accessible_hosts = null;
836                 static $wildcard_regex = array();
837                 if ( null === $accessible_hosts ) {
838                         $accessible_hosts = preg_split('|,\s*|', WP_ACCESSIBLE_HOSTS);
839
840                         if ( false !== strpos(WP_ACCESSIBLE_HOSTS, '*') ) {
841                                 $wildcard_regex = array();
842                                 foreach ( $accessible_hosts as $host )
843                                         $wildcard_regex[] = str_replace( '\*', '.+', preg_quote( $host, '/' ) );
844                                 $wildcard_regex = '/^(' . implode('|', $wildcard_regex) . ')$/i';
845                         }
846                 }
847
848                 if ( !empty($wildcard_regex) )
849                         return !preg_match($wildcard_regex, $check['host']);
850                 else
851                         return !in_array( $check['host'], $accessible_hosts ); //Inverse logic, If it's in the array, then we can't access it.
852
853         }
854
855         /**
856          * Used as a wrapper for PHP's parse_url() function that handles edgecases in < PHP 5.4.7.
857          *
858          * @access protected
859          * @deprecated 4.4.0 Use wp_parse_url()
860          * @see wp_parse_url()
861          *
862          * @param string $url The URL to parse.
863          * @return bool|array False on failure; Array of URL components on success;
864          *                    See parse_url()'s return values.
865          */
866         protected static function parse_url( $url ) {
867                 _deprecated_function( __METHOD__, '4.4.0', 'wp_parse_url()' );
868                 return wp_parse_url( $url );
869         }
870
871         /**
872          * Converts a relative URL to an absolute URL relative to a given URL.
873          *
874          * If an Absolute URL is provided, no processing of that URL is done.
875          *
876          * @since 3.4.0
877          *
878          * @static
879          * @access public
880          *
881          * @param string $maybe_relative_path The URL which might be relative
882          * @param string $url                 The URL which $maybe_relative_path is relative to
883          * @return string An Absolute URL, in a failure condition where the URL cannot be parsed, the relative URL will be returned.
884          */
885         public static function make_absolute_url( $maybe_relative_path, $url ) {
886                 if ( empty( $url ) )
887                         return $maybe_relative_path;
888
889                 if ( ! $url_parts = wp_parse_url( $url ) ) {
890                         return $maybe_relative_path;
891                 }
892
893                 if ( ! $relative_url_parts = wp_parse_url( $maybe_relative_path ) ) {
894                         return $maybe_relative_path;
895                 }
896
897                 // Check for a scheme on the 'relative' url
898                 if ( ! empty( $relative_url_parts['scheme'] ) ) {
899                         return $maybe_relative_path;
900                 }
901
902                 $absolute_path = $url_parts['scheme'] . '://';
903
904                 // 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
905                 if ( isset( $relative_url_parts['host'] ) ) {
906                         $absolute_path .= $relative_url_parts['host'];
907                         if ( isset( $relative_url_parts['port'] ) )
908                                 $absolute_path .= ':' . $relative_url_parts['port'];
909                 } else {
910                         $absolute_path .= $url_parts['host'];
911                         if ( isset( $url_parts['port'] ) )
912                                 $absolute_path .= ':' . $url_parts['port'];
913                 }
914
915                 // Start off with the Absolute URL path.
916                 $path = ! empty( $url_parts['path'] ) ? $url_parts['path'] : '/';
917
918                 // If it's a root-relative path, then great.
919                 if ( ! empty( $relative_url_parts['path'] ) && '/' == $relative_url_parts['path'][0] ) {
920                         $path = $relative_url_parts['path'];
921
922                 // Else it's a relative path.
923                 } elseif ( ! empty( $relative_url_parts['path'] ) ) {
924                         // Strip off any file components from the absolute path.
925                         $path = substr( $path, 0, strrpos( $path, '/' ) + 1 );
926
927                         // Build the new path.
928                         $path .= $relative_url_parts['path'];
929
930                         // Strip all /path/../ out of the path.
931                         while ( strpos( $path, '../' ) > 1 ) {
932                                 $path = preg_replace( '![^/]+/\.\./!', '', $path );
933                         }
934
935                         // Strip any final leading ../ from the path.
936                         $path = preg_replace( '!^/(\.\./)+!', '', $path );
937                 }
938
939                 // Add the Query string.
940                 if ( ! empty( $relative_url_parts['query'] ) )
941                         $path .= '?' . $relative_url_parts['query'];
942
943                 return $absolute_path . '/' . ltrim( $path, '/' );
944         }
945
946         /**
947          * Handles HTTP Redirects and follows them if appropriate.
948          *
949          * @since 3.7.0
950          *
951          * @static
952          *
953          * @param string $url The URL which was requested.
954          * @param array $args The Arguments which were used to make the request.
955          * @param array $response The Response of the HTTP request.
956          * @return false|object False if no redirect is present, a WP_HTTP or WP_Error result otherwise.
957          */
958         public static function handle_redirects( $url, $args, $response ) {
959                 // If no redirects are present, or, redirects were not requested, perform no action.
960                 if ( ! isset( $response['headers']['location'] ) || 0 === $args['_redirection'] )
961                         return false;
962
963                 // Only perform redirections on redirection http codes.
964                 if ( $response['response']['code'] > 399 || $response['response']['code'] < 300 )
965                         return false;
966
967                 // Don't redirect if we've run out of redirects.
968                 if ( $args['redirection']-- <= 0 )
969                         return new WP_Error( 'http_request_failed', __('Too many redirects.') );
970
971                 $redirect_location = $response['headers']['location'];
972
973                 // If there were multiple Location headers, use the last header specified.
974                 if ( is_array( $redirect_location ) )
975                         $redirect_location = array_pop( $redirect_location );
976
977                 $redirect_location = WP_Http::make_absolute_url( $redirect_location, $url );
978
979                 // POST requests should not POST to a redirected location.
980                 if ( 'POST' == $args['method'] ) {
981                         if ( in_array( $response['response']['code'], array( 302, 303 ) ) )
982                                 $args['method'] = 'GET';
983                 }
984
985                 // Include valid cookies in the redirect process.
986                 if ( ! empty( $response['cookies'] ) ) {
987                         foreach ( $response['cookies'] as $cookie ) {
988                                 if ( $cookie->test( $redirect_location ) )
989                                         $args['cookies'][] = $cookie;
990                         }
991                 }
992
993                 return wp_remote_request( $redirect_location, $args );
994         }
995
996         /**
997          * Determines if a specified string represents an IP address or not.
998          *
999          * This function also detects the type of the IP address, returning either
1000          * '4' or '6' to represent a IPv4 and IPv6 address respectively.
1001          * This does not verify if the IP is a valid IP, only that it appears to be
1002          * an IP address.
1003          *
1004          * @link http://home.deds.nl/~aeron/regex/ for IPv6 regex
1005          *
1006          * @since 3.7.0
1007          * @static
1008          *
1009          * @param string $maybe_ip A suspected IP address
1010          * @return integer|bool Upon success, '4' or '6' to represent a IPv4 or IPv6 address, false upon failure
1011          */
1012         public static function is_ip_address( $maybe_ip ) {
1013                 if ( preg_match( '/^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$/', $maybe_ip ) )
1014                         return 4;
1015
1016                 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, ' []' ) ) )
1017                         return 6;
1018
1019                 return false;
1020         }
1021
1022 }