3 * Simple and uniform HTTP request API.
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.
8 * @link http://trac.wordpress.org/ticket/4779 HTTP API Proposal
16 * WordPress HTTP Class for managing HTTP Transports and making HTTP requests.
18 * This class is called for the functionality of making HTTP requests and replaces Snoopy
19 * functionality. There is no available functionality to add HTTP transport implementations, since
20 * most of the HTTP transports are added and available for use.
22 * There are no properties, because none are needed and for performance reasons. Some of the
23 * functions are static and while they do have some overhead over functions in PHP4, the purpose is
24 * maintainability. When PHP5 is finally the requirement, it will be easy to add the static keyword
25 * to the code. It is not as easy to convert a function to a method after enough code uses the old
28 * Debugging includes several actions, which pass different variables for debugging the HTTP API.
37 * Send a HTTP request to a URI.
39 * The body and headers are part of the arguments. The 'body' argument is for the body and will
40 * accept either a string or an array. The 'headers' argument should be an array, but a string
41 * is acceptable. If the 'body' argument is an array, then it will automatically be escaped
42 * using http_build_query().
44 * The only URI that are supported in the HTTP Transport implementation are the HTTP and HTTPS
45 * protocols. HTTP and HTTPS are assumed so the server might not know how to handle the send
46 * headers. Other protocols are unsupported and most likely will fail.
48 * The defaults are 'method', 'timeout', 'redirection', 'httpversion', 'blocking' and
51 * Accepted 'method' values are 'GET', 'POST', and 'HEAD', some transports technically allow
52 * others, but should not be assumed. The 'timeout' is used to sent how long the connection
53 * should stay open before failing when no response. 'redirection' is used to track how many
54 * redirects were taken and used to sent the amount for other transports, but not all transports
55 * accept setting that value.
57 * The 'httpversion' option is used to sent the HTTP version and accepted values are '1.0', and
58 * '1.1' and should be a string. Version 1.1 is not supported, because of chunk response. The
59 * 'user-agent' option is the user-agent and is used to replace the default user-agent, which is
60 * 'WordPress/WP_Version', where WP_Version is the value from $wp_version.
62 * 'blocking' is the default, which is used to tell the transport, whether it should halt PHP
63 * while it performs the request or continue regardless. Actually, that isn't entirely correct.
64 * Blocking mode really just means whether the fread should just pull what it can whenever it
65 * gets bytes or if it should wait until it has enough in the buffer to read or finishes reading
66 * the entire content. It doesn't actually always mean that PHP will continue going after making
71 * @todo Refactor this code. The code in this method extends the scope of its original purpose
72 * and should be refactored to allow for cleaner abstraction and reduce duplication of the
73 * code. One suggestion is to create a class specifically for the arguments, however
74 * preliminary refactoring to this affect has affect more than just the scope of the
75 * arguments. Something to ponder at least.
77 * @param string $url URI resource.
78 * @param str|array $args Optional. Override the defaults.
79 * @return array|object Array containing 'headers', 'body', 'response', 'cookies', 'filename'. A WP_Error instance upon error
81 function request( $url, $args = array() ) {
86 'timeout' => apply_filters( 'http_request_timeout', 5),
87 'redirection' => apply_filters( 'http_request_redirection_count', 5),
88 'httpversion' => apply_filters( 'http_request_version', '1.0'),
89 'user-agent' => apply_filters( 'http_headers_useragent', 'WordPress/' . $wp_version . '; ' . get_bloginfo( 'url' ) ),
102 // Pre-parse for the HEAD checks.
103 $args = wp_parse_args( $args );
105 // By default, Head requests do not cause redirections.
106 if ( isset($args['method']) && 'HEAD' == $args['method'] )
107 $defaults['redirection'] = 0;
109 $r = wp_parse_args( $args, $defaults );
110 $r = apply_filters( 'http_request_args', $r, $url );
112 // Certain classes decrement this, store a copy of the original value for loop purposes.
113 $r['_redirection'] = $r['redirection'];
115 // Allow plugins to short-circuit the request
116 $pre = apply_filters( 'pre_http_request', false, $r, $url );
117 if ( false !== $pre )
120 $arrURL = parse_url( $url );
122 if ( empty( $url ) || empty( $arrURL['scheme'] ) )
123 return new WP_Error('http_request_failed', __('A valid URL was not provided.'));
125 if ( $this->block_request( $url ) )
126 return new WP_Error( 'http_request_failed', __( 'User has blocked requests through HTTP.' ) );
128 // Determine if this is a https call and pass that on to the transport functions
129 // so that we can blacklist the transports that do not support ssl verification
130 $r['ssl'] = $arrURL['scheme'] == 'https' || $arrURL['scheme'] == 'ssl';
132 // Determine if this request is to OUR install of WordPress
133 $homeURL = parse_url( get_bloginfo( 'url' ) );
134 $r['local'] = $homeURL['host'] == $arrURL['host'] || 'localhost' == $arrURL['host'];
137 // If we are streaming to a file but no filename was given drop it in the WP temp dir
138 // and pick it's name using the basename of the $url
139 if ( $r['stream'] && empty( $r['filename'] ) )
140 $r['filename'] = get_temp_dir() . basename( $url );
142 // Force some settings if we are streaming to a file and check for existence and perms of destination directory
143 if ( $r['stream'] ) {
144 $r['blocking'] = true;
145 if ( ! is_writable( dirname( $r['filename'] ) ) )
146 return new WP_Error( 'http_request_failed', __( 'Destination directory for file streaming does not exist or is not writable.' ) );
149 if ( is_null( $r['headers'] ) )
150 $r['headers'] = array();
152 if ( ! is_array( $r['headers'] ) ) {
153 $processedHeaders = WP_Http::processHeaders( $r['headers'] );
154 $r['headers'] = $processedHeaders['headers'];
157 if ( isset( $r['headers']['User-Agent'] ) ) {
158 $r['user-agent'] = $r['headers']['User-Agent'];
159 unset( $r['headers']['User-Agent'] );
162 if ( isset( $r['headers']['user-agent'] ) ) {
163 $r['user-agent'] = $r['headers']['user-agent'];
164 unset( $r['headers']['user-agent'] );
167 // Construct Cookie: header if any cookies are set
168 WP_Http::buildCookieHeader( $r );
170 if ( WP_Http_Encoding::is_available() )
171 $r['headers']['Accept-Encoding'] = WP_Http_Encoding::accept_encoding();
173 if ( empty($r['body']) ) {
175 // Some servers fail when sending content without the content-length header being set.
176 // Also, to fix another bug, we only send when doing POST and PUT and the content-length
177 // header isn't already set.
178 if ( ($r['method'] == 'POST' || $r['method'] == 'PUT') && ! isset( $r['headers']['Content-Length'] ) )
179 $r['headers']['Content-Length'] = 0;
181 if ( is_array( $r['body'] ) || is_object( $r['body'] ) ) {
182 $r['body'] = http_build_query( $r['body'], null, '&' );
183 if ( ! isset( $r['headers']['Content-Type'] ) )
184 $r['headers']['Content-Type'] = 'application/x-www-form-urlencoded; charset=' . get_option( 'blog_charset' );
185 $r['headers']['Content-Length'] = strlen( $r['body'] );
188 if ( ! isset( $r['headers']['Content-Length'] ) && ! isset( $r['headers']['content-length'] ) )
189 $r['headers']['Content-Length'] = strlen( $r['body'] );
192 return $this->_dispatch_request($url, $r);
196 * Tests which transports are capable of supporting the request.
201 * @param array $args Request arguments
202 * @param string $url URL to Request
204 * @return string|false Class name for the first transport that claims to support the request. False if no transport claims to support the request.
206 public function _get_first_available_transport( $args, $url = null ) {
207 $request_order = array( 'curl', 'streams', 'fsockopen' );
209 // Loop over each transport on each HTTP request looking for one which will serve this request's needs
210 foreach ( $request_order as $transport ) {
211 $class = 'WP_HTTP_' . $transport;
213 // Check to see if this transport is a possibility, calls the transport statically
214 if ( !call_user_func( array( $class, 'test' ), $args, $url ) )
224 * Dispatches a HTTP request to a supporting transport.
226 * Tests each transport in order to find a transport which matches the request arguments.
227 * Also caches the transport instance to be used later.
229 * The order for blocking requests is cURL, Streams, and finally Fsockopen.
230 * The order for non-blocking requests is cURL, Streams and Fsockopen().
232 * There are currently issues with "localhost" not resolving correctly with DNS. This may cause
233 * an error "failed to open stream: A connection attempt failed because the connected party did
234 * not properly respond after a period of time, or established connection failed because [the]
235 * connected host has failed to respond."
240 * @param string $url URL to Request
241 * @param array $args Request arguments
242 * @return array|object Array containing 'headers', 'body', 'response', 'cookies', 'filename'. A WP_Error instance upon error
244 private function _dispatch_request( $url, $args ) {
245 static $transports = array();
247 $class = $this->_get_first_available_transport( $args, $url );
249 return new WP_Error( 'http_failure', __( 'There are no HTTP transports available which can complete the requested request.' ) );
251 // Transport claims to support request, instantiate it and give it a whirl.
252 if ( empty( $transports[$class] ) )
253 $transports[$class] = new $class;
255 $response = $transports[$class]->request( $url, $args );
257 do_action( 'http_api_debug', $response, 'response', $class, $args, $url );
259 if ( is_wp_error( $response ) )
262 return apply_filters( 'http_response', $response, $args, $url );
266 * Uses the POST HTTP method.
268 * Used for sending data that is expected to be in the body.
273 * @param string $url URI resource.
274 * @param str|array $args Optional. Override the defaults.
275 * @return array|object Array containing 'headers', 'body', 'response', 'cookies', 'filename'. A WP_Error instance upon error
277 function post($url, $args = array()) {
278 $defaults = array('method' => 'POST');
279 $r = wp_parse_args( $args, $defaults );
280 return $this->request($url, $r);
284 * Uses the GET HTTP method.
286 * Used for sending data that is expected to be in the body.
291 * @param string $url URI resource.
292 * @param str|array $args Optional. Override the defaults.
293 * @return array|object Array containing 'headers', 'body', 'response', 'cookies', 'filename'. A WP_Error instance upon error
295 function get($url, $args = array()) {
296 $defaults = array('method' => 'GET');
297 $r = wp_parse_args( $args, $defaults );
298 return $this->request($url, $r);
302 * Uses the HEAD HTTP method.
304 * Used for sending data that is expected to be in the body.
309 * @param string $url URI resource.
310 * @param str|array $args Optional. Override the defaults.
311 * @return array|object Array containing 'headers', 'body', 'response', 'cookies', 'filename'. A WP_Error instance upon error
313 function head($url, $args = array()) {
314 $defaults = array('method' => 'HEAD');
315 $r = wp_parse_args( $args, $defaults );
316 return $this->request($url, $r);
320 * Parses the responses and splits the parts into headers and body.
326 * @param string $strResponse The full response string
327 * @return array Array with 'headers' and 'body' keys.
329 function processResponse($strResponse) {
330 $res = explode("\r\n\r\n", $strResponse, 2);
332 return array('headers' => $res[0], 'body' => isset($res[1]) ? $res[1] : '');
336 * Transform header string into an array.
338 * If an array is given then it is assumed to be raw header data with numeric keys with the
339 * headers as the values. No headers must be passed that were already processed.
345 * @param string|array $headers
346 * @return array Processed string headers. If duplicate headers are encountered,
347 * Then a numbered array is returned as the value of that header-key.
349 public static function processHeaders($headers) {
350 // split headers, one per array element
351 if ( is_string($headers) ) {
352 // tolerate line terminator: CRLF = LF (RFC 2616 19.3)
353 $headers = str_replace("\r\n", "\n", $headers);
354 // unfold folded header fields. LWS = [CRLF] 1*( SP | HT ) <US-ASCII SP, space (32)>, <US-ASCII HT, horizontal-tab (9)> (RFC 2616 2.2)
355 $headers = preg_replace('/\n[ \t]/', ' ', $headers);
356 // create the headers array
357 $headers = explode("\n", $headers);
360 $response = array('code' => 0, 'message' => '');
362 // If a redirection has taken place, The headers for each page request may have been passed.
363 // In this case, determine the final HTTP header and parse from there.
364 for ( $i = count($headers)-1; $i >= 0; $i-- ) {
365 if ( !empty($headers[$i]) && false === strpos($headers[$i], ':') ) {
366 $headers = array_splice($headers, $i);
372 $newheaders = array();
373 foreach ( (array) $headers as $tempheader ) {
374 if ( empty($tempheader) )
377 if ( false === strpos($tempheader, ':') ) {
378 $stack = explode(' ', $tempheader, 3);
380 list( , $response['code'], $response['message']) = $stack;
384 list($key, $value) = explode(':', $tempheader, 2);
386 if ( !empty( $value ) ) {
387 $key = strtolower( $key );
388 if ( isset( $newheaders[$key] ) ) {
389 if ( !is_array($newheaders[$key]) )
390 $newheaders[$key] = array($newheaders[$key]);
391 $newheaders[$key][] = trim( $value );
393 $newheaders[$key] = trim( $value );
395 if ( 'set-cookie' == $key )
396 $cookies[] = new WP_Http_Cookie( $value );
400 return array('response' => $response, 'headers' => $newheaders, 'cookies' => $cookies);
404 * Takes the arguments for a ::request() and checks for the cookie array.
406 * If it's found, then it's assumed to contain WP_Http_Cookie objects, which are each parsed
407 * into strings and added to the Cookie: header (within the arguments array). Edits the array by
414 * @param array $r Full array of args passed into ::request()
416 public static function buildCookieHeader( &$r ) {
417 if ( ! empty($r['cookies']) ) {
418 $cookies_header = '';
419 foreach ( (array) $r['cookies'] as $cookie ) {
420 $cookies_header .= $cookie->getHeaderValue() . '; ';
422 $cookies_header = substr( $cookies_header, 0, -2 );
423 $r['headers']['cookie'] = $cookies_header;
428 * Decodes chunk transfer-encoding, based off the HTTP 1.1 specification.
430 * Based off the HTTP http_encoding_dechunk function. Does not support UTF-8. Does not support
431 * returning footer headers. Shouldn't be too difficult to support it though.
433 * @todo Add support for footer chunked headers.
438 * @param string $body Body content
439 * @return string Chunked decoded body on success or raw body on failure.
441 function chunkTransferDecode($body) {
442 $body = str_replace(array("\r\n", "\r"), "\n", $body);
443 // The body is not chunked encoding or is malformed.
444 if ( ! preg_match( '/^[0-9a-f]+(\s|\n)+/mi', trim($body) ) )
448 //$parsedHeaders = array(); Unsupported
451 $hasChunk = (bool) preg_match( '/^([0-9a-f]+)(\s|\n)+/mi', $body, $match );
454 if ( empty( $match[1] ) )
457 $length = hexdec( $match[1] );
458 $chunkLength = strlen( $match[0] );
460 $strBody = substr($body, $chunkLength, $length);
461 $parsedBody .= $strBody;
463 $body = ltrim(str_replace(array($match[0], $strBody), '', $body), "\n");
465 if ( "0" == trim($body) )
466 return $parsedBody; // Ignore footer headers.
474 * Block requests through the proxy.
476 * Those who are behind a proxy and want to prevent access to certain hosts may do so. This will
477 * prevent plugins from working and core functionality, if you don't include api.wordpress.org.
479 * You block external URL requests by defining WP_HTTP_BLOCK_EXTERNAL as true in your wp-config.php
480 * file and this will only allow localhost and your blog to make requests. The constant
481 * WP_ACCESSIBLE_HOSTS will allow additional hosts to go through for requests. The format of the
482 * WP_ACCESSIBLE_HOSTS constant is a comma separated list of hostnames to allow, wildcard domains
483 * are supported, eg *.wordpress.org will allow for all subdomains of wordpress.org to be contacted.
486 * @link http://core.trac.wordpress.org/ticket/8927 Allow preventing external requests.
487 * @link http://core.trac.wordpress.org/ticket/14636 Allow wildcard domains in WP_ACCESSIBLE_HOSTS
489 * @param string $uri URI of url.
490 * @return bool True to block, false to allow.
492 function block_request($uri) {
493 // We don't need to block requests, because nothing is blocked.
494 if ( ! defined( 'WP_HTTP_BLOCK_EXTERNAL' ) || ! WP_HTTP_BLOCK_EXTERNAL )
497 // parse_url() only handles http, https type URLs, and will emit E_WARNING on failure.
498 // This will be displayed on blogs, which is not reasonable.
499 $check = @parse_url($uri);
501 /* Malformed URL, can not process, but this could mean ssl, so let through anyway.
503 * This isn't very security sound. There are instances where a hacker might attempt
504 * to bypass the proxy and this check. However, the reason for this behavior is that
505 * WordPress does not do any checking currently for non-proxy requests, so it is keeps with
506 * the default unsecure nature of the HTTP request.
508 if ( $check === false )
511 $home = parse_url( get_option('siteurl') );
513 // Don't block requests back to ourselves by default
514 if ( $check['host'] == 'localhost' || $check['host'] == $home['host'] )
515 return apply_filters('block_local_requests', false);
517 if ( !defined('WP_ACCESSIBLE_HOSTS') )
520 static $accessible_hosts;
521 static $wildcard_regex = false;
522 if ( null == $accessible_hosts ) {
523 $accessible_hosts = preg_split('|,\s*|', WP_ACCESSIBLE_HOSTS);
525 if ( false !== strpos(WP_ACCESSIBLE_HOSTS, '*') ) {
526 $wildcard_regex = array();
527 foreach ( $accessible_hosts as $host )
528 $wildcard_regex[] = str_replace('\*', '[\w.]+?', preg_quote($host, '/'));
529 $wildcard_regex = '/^(' . implode('|', $wildcard_regex) . ')$/i';
533 if ( !empty($wildcard_regex) )
534 return !preg_match($wildcard_regex, $check['host']);
536 return !in_array( $check['host'], $accessible_hosts ); //Inverse logic, If its in the array, then we can't access it.
544 * HTTP request method uses fsockopen function to retrieve the url.
546 * This would be the preferred method, but the fsockopen implementation has the most overhead of all
547 * the HTTP transport implementations.
553 class WP_Http_Fsockopen {
555 * Send a HTTP request to a URI using fsockopen().
557 * Does not support non-blocking mode.
559 * @see WP_Http::request For default options descriptions.
563 * @param string $url URI resource.
564 * @param str|array $args Optional. Override the defaults.
565 * @return array 'headers', 'body', 'response', 'cookies' and 'filename' keys.
567 function request($url, $args = array()) {
569 'method' => 'GET', 'timeout' => 5,
570 'redirection' => 5, 'httpversion' => '1.0',
572 'headers' => array(), 'body' => null, 'cookies' => array()
575 $r = wp_parse_args( $args, $defaults );
577 if ( isset($r['headers']['User-Agent']) ) {
578 $r['user-agent'] = $r['headers']['User-Agent'];
579 unset($r['headers']['User-Agent']);
580 } else if ( isset($r['headers']['user-agent']) ) {
581 $r['user-agent'] = $r['headers']['user-agent'];
582 unset($r['headers']['user-agent']);
585 // Construct Cookie: header if any cookies are set
586 WP_Http::buildCookieHeader( $r );
588 $iError = null; // Store error number
589 $strError = null; // Store error string
591 $arrURL = parse_url($url);
593 $fsockopen_host = $arrURL['host'];
595 $secure_transport = false;
597 if ( ! isset( $arrURL['port'] ) ) {
598 if ( ( $arrURL['scheme'] == 'ssl' || $arrURL['scheme'] == 'https' ) && extension_loaded('openssl') ) {
599 $fsockopen_host = "ssl://$fsockopen_host";
600 $arrURL['port'] = 443;
601 $secure_transport = true;
603 $arrURL['port'] = 80;
607 //fsockopen has issues with 'localhost' with IPv6 with certain versions of PHP, It attempts to connect to ::1,
608 // which fails when the server is not set up for it. For compatibility, always connect to the IPv4 address.
609 if ( 'localhost' == strtolower($fsockopen_host) )
610 $fsockopen_host = '127.0.0.1';
612 // There are issues with the HTTPS and SSL protocols that cause errors that can be safely
613 // ignored and should be ignored.
614 if ( true === $secure_transport )
615 $error_reporting = error_reporting(0);
617 $startDelay = time();
619 $proxy = new WP_HTTP_Proxy();
622 if ( $proxy->is_enabled() && $proxy->send_through_proxy( $url ) )
623 $handle = @fsockopen( $proxy->host(), $proxy->port(), $iError, $strError, $r['timeout'] );
625 $handle = @fsockopen( $fsockopen_host, $arrURL['port'], $iError, $strError, $r['timeout'] );
627 if ( $proxy->is_enabled() && $proxy->send_through_proxy( $url ) )
628 $handle = fsockopen( $proxy->host(), $proxy->port(), $iError, $strError, $r['timeout'] );
630 $handle = fsockopen( $fsockopen_host, $arrURL['port'], $iError, $strError, $r['timeout'] );
635 // If the delay is greater than the timeout then fsockopen shouldn't be used, because it will
636 // cause a long delay.
637 $elapseDelay = ($endDelay-$startDelay) > $r['timeout'];
638 if ( true === $elapseDelay )
639 add_option( 'disable_fsockopen', $endDelay, null, true );
641 if ( false === $handle )
642 return new WP_Error('http_request_failed', $iError . ': ' . $strError);
644 $timeout = (int) floor( $r['timeout'] );
645 $utimeout = $timeout == $r['timeout'] ? 0 : 1000000 * $r['timeout'] % 1000000;
646 stream_set_timeout( $handle, $timeout, $utimeout );
648 if ( $proxy->is_enabled() && $proxy->send_through_proxy( $url ) ) //Some proxies require full URL in this field.
651 $requestPath = $arrURL['path'] . ( isset($arrURL['query']) ? '?' . $arrURL['query'] : '' );
653 if ( empty($requestPath) )
656 $strHeaders = strtoupper($r['method']) . ' ' . $requestPath . ' HTTP/' . $r['httpversion'] . "\r\n";
658 if ( $proxy->is_enabled() && $proxy->send_through_proxy( $url ) )
659 $strHeaders .= 'Host: ' . $arrURL['host'] . ':' . $arrURL['port'] . "\r\n";
661 $strHeaders .= 'Host: ' . $arrURL['host'] . "\r\n";
663 if ( isset($r['user-agent']) )
664 $strHeaders .= 'User-agent: ' . $r['user-agent'] . "\r\n";
666 if ( is_array($r['headers']) ) {
667 foreach ( (array) $r['headers'] as $header => $headerValue )
668 $strHeaders .= $header . ': ' . $headerValue . "\r\n";
670 $strHeaders .= $r['headers'];
673 if ( $proxy->use_authentication() )
674 $strHeaders .= $proxy->authentication_header() . "\r\n";
676 $strHeaders .= "\r\n";
678 if ( ! is_null($r['body']) )
679 $strHeaders .= $r['body'];
681 fwrite($handle, $strHeaders);
683 if ( ! $r['blocking'] ) {
685 return array( 'headers' => array(), 'body' => '', 'response' => array('code' => false, 'message' => false), 'cookies' => array() );
689 $bodyStarted = false;
691 // If streaming to a file setup the file handle
692 if ( $r['stream'] ) {
694 $stream_handle = @fopen( $r['filename'], 'w+' );
696 $stream_handle = fopen( $r['filename'], 'w+' );
697 if ( ! $stream_handle )
698 return new WP_Error( 'http_request_failed', sprintf( __( 'Could not open handle for fopen() to %s' ), $r['filename'] ) );
700 while ( ! feof($handle) ) {
701 $block = fread( $handle, 4096 );
702 if ( $bodyStarted ) {
703 fwrite( $stream_handle, $block );
705 $strResponse .= $block;
706 if ( strpos( $strResponse, "\r\n\r\n" ) ) {
707 $process = WP_Http::processResponse( $strResponse );
709 fwrite( $stream_handle, $process['body'] );
710 unset( $strResponse );
711 $process['body'] = '';
716 fclose( $stream_handle );
719 while ( ! feof($handle) )
720 $strResponse .= fread( $handle, 4096 );
722 $process = WP_Http::processResponse( $strResponse );
723 unset( $strResponse );
728 if ( true === $secure_transport )
729 error_reporting($error_reporting);
731 $arrHeaders = WP_Http::processHeaders( $process['headers'] );
733 // If location is found, then assume redirect and redirect to location.
734 if ( isset($arrHeaders['headers']['location']) && 0 !== $r['_redirection'] ) {
735 if ( $r['redirection']-- > 0 ) {
736 return $this->request($arrHeaders['headers']['location'], $r);
738 return new WP_Error('http_request_failed', __('Too many redirects.'));
742 // If the body was chunk encoded, then decode it.
743 if ( ! empty( $process['body'] ) && isset( $arrHeaders['headers']['transfer-encoding'] ) && 'chunked' == $arrHeaders['headers']['transfer-encoding'] )
744 $process['body'] = WP_Http::chunkTransferDecode($process['body']);
746 if ( true === $r['decompress'] && true === WP_Http_Encoding::should_decode($arrHeaders['headers']) )
747 $process['body'] = WP_Http_Encoding::decompress( $process['body'] );
749 return array( 'headers' => $arrHeaders['headers'], 'body' => $process['body'], 'response' => $arrHeaders['response'], 'cookies' => $arrHeaders['cookies'], 'filename' => $r['filename'] );
753 * Whether this class can be used for retrieving an URL.
757 * @return boolean False means this class can not be used, true means it can.
759 public static function test( $args = array() ) {
760 if ( ! function_exists( 'fsockopen' ) )
763 if ( false !== ($option = get_option( 'disable_fsockopen' )) && time()-$option < 43200 ) // 12 hours
766 $is_ssl = isset( $args['ssl'] ) && $args['ssl'];
768 if ( $is_ssl && ! extension_loaded( 'openssl' ) )
771 return apply_filters( 'use_fsockopen_transport', true, $args );
776 * HTTP request method uses Streams to retrieve the url.
778 * Requires PHP 5.0+ and uses fopen with stream context. Requires that 'allow_url_fopen' PHP setting
781 * Second preferred method for getting the URL, for PHP 5.
787 class WP_Http_Streams {
789 * Send a HTTP request to a URI using streams with fopen().
795 * @param str|array $args Optional. Override the defaults.
796 * @return array 'headers', 'body', 'response', 'cookies' and 'filename' keys.
798 function request($url, $args = array()) {
800 'method' => 'GET', 'timeout' => 5,
801 'redirection' => 5, 'httpversion' => '1.0',
803 'headers' => array(), 'body' => null, 'cookies' => array()
806 $r = wp_parse_args( $args, $defaults );
808 if ( isset($r['headers']['User-Agent']) ) {
809 $r['user-agent'] = $r['headers']['User-Agent'];
810 unset($r['headers']['User-Agent']);
811 } else if ( isset($r['headers']['user-agent']) ) {
812 $r['user-agent'] = $r['headers']['user-agent'];
813 unset($r['headers']['user-agent']);
816 // Construct Cookie: header if any cookies are set
817 WP_Http::buildCookieHeader( $r );
819 $arrURL = parse_url($url);
821 if ( false === $arrURL )
822 return new WP_Error('http_request_failed', sprintf(__('Malformed URL: %s'), $url));
824 if ( 'http' != $arrURL['scheme'] && 'https' != $arrURL['scheme'] )
825 $url = preg_replace('|^' . preg_quote($arrURL['scheme'], '|') . '|', 'http', $url);
827 // Convert Header array to string.
829 if ( is_array( $r['headers'] ) )
830 foreach ( $r['headers'] as $name => $value )
831 $strHeaders .= "{$name}: $value\r\n";
832 else if ( is_string( $r['headers'] ) )
833 $strHeaders = $r['headers'];
835 $is_local = isset($args['local']) && $args['local'];
836 $ssl_verify = isset($args['sslverify']) && $args['sslverify'];
838 $ssl_verify = apply_filters('https_local_ssl_verify', $ssl_verify);
839 elseif ( ! $is_local )
840 $ssl_verify = apply_filters('https_ssl_verify', $ssl_verify);
842 $arrContext = array('http' =>
844 'method' => strtoupper($r['method']),
845 'user_agent' => $r['user-agent'],
846 'max_redirects' => $r['redirection'] + 1, // See #11557
847 'protocol_version' => (float) $r['httpversion'],
848 'header' => $strHeaders,
849 'ignore_errors' => true, // Return non-200 requests.
850 'timeout' => $r['timeout'],
852 'verify_peer' => $ssl_verify,
853 'verify_host' => $ssl_verify
858 $proxy = new WP_HTTP_Proxy();
860 if ( $proxy->is_enabled() && $proxy->send_through_proxy( $url ) ) {
861 $arrContext['http']['proxy'] = 'tcp://' . $proxy->host() . ':' . $proxy->port();
862 $arrContext['http']['request_fulluri'] = true;
864 // We only support Basic authentication so this will only work if that is what your proxy supports.
865 if ( $proxy->use_authentication() )
866 $arrContext['http']['header'] .= $proxy->authentication_header() . "\r\n";
869 if ( ! empty($r['body'] ) )
870 $arrContext['http']['content'] = $r['body'];
872 $context = stream_context_create($arrContext);
875 $handle = @fopen($url, 'r', false, $context);
877 $handle = fopen($url, 'r', false, $context);
880 return new WP_Error('http_request_failed', sprintf(__('Could not open handle for fopen() to %s'), $url));
882 $timeout = (int) floor( $r['timeout'] );
883 $utimeout = $timeout == $r['timeout'] ? 0 : 1000000 * $r['timeout'] % 1000000;
884 stream_set_timeout( $handle, $timeout, $utimeout );
886 if ( ! $r['blocking'] ) {
887 stream_set_blocking($handle, 0);
889 return array( 'headers' => array(), 'body' => '', 'response' => array('code' => false, 'message' => false), 'cookies' => array() );
892 if ( $r['stream'] ) {
894 $stream_handle = @fopen( $r['filename'], 'w+' );
896 $stream_handle = fopen( $r['filename'], 'w+' );
898 if ( ! $stream_handle )
899 return new WP_Error( 'http_request_failed', sprintf( __( 'Could not open handle for fopen() to %s' ), $r['filename'] ) );
901 stream_copy_to_stream( $handle, $stream_handle );
903 fclose( $stream_handle );
906 $strResponse = stream_get_contents( $handle );
909 $meta = stream_get_meta_data( $handle );
913 $processedHeaders = array();
914 if ( isset( $meta['wrapper_data']['headers'] ) )
915 $processedHeaders = WP_Http::processHeaders($meta['wrapper_data']['headers']);
917 $processedHeaders = WP_Http::processHeaders($meta['wrapper_data']);
919 // Streams does not provide an error code which we can use to see why the request stream stopped.
920 // We can however test to see if a location header is present and return based on that.
921 if ( isset($processedHeaders['headers']['location']) && 0 !== $args['_redirection'] )
922 return new WP_Error('http_request_failed', __('Too many redirects.'));
924 if ( ! empty( $strResponse ) && isset( $processedHeaders['headers']['transfer-encoding'] ) && 'chunked' == $processedHeaders['headers']['transfer-encoding'] )
925 $strResponse = WP_Http::chunkTransferDecode($strResponse);
927 if ( true === $r['decompress'] && true === WP_Http_Encoding::should_decode($processedHeaders['headers']) )
928 $strResponse = WP_Http_Encoding::decompress( $strResponse );
930 return array( 'headers' => $processedHeaders['headers'], 'body' => $strResponse, 'response' => $processedHeaders['response'], 'cookies' => $processedHeaders['cookies'], 'filename' => $r['filename'] );
934 * Whether this class can be used for retrieving an URL.
940 * @return boolean False means this class can not be used, true means it can.
942 public static function test( $args = array() ) {
943 if ( ! function_exists( 'fopen' ) )
946 if ( ! function_exists( 'ini_get' ) || true != ini_get( 'allow_url_fopen' ) )
949 $is_ssl = isset( $args['ssl'] ) && $args['ssl'];
951 if ( $is_ssl && ! extension_loaded( 'openssl' ) )
954 return apply_filters( 'use_streams_transport', true, $args );
959 * HTTP request method uses Curl extension to retrieve the url.
961 * Requires the Curl extension to be installed.
970 * Temporary header storage for use with streaming to a file.
976 private $headers = '';
979 * Send a HTTP request to a URI using cURL extension.
985 * @param str|array $args Optional. Override the defaults.
986 * @return array 'headers', 'body', 'response', 'cookies' and 'filename' keys.
988 function request($url, $args = array()) {
990 'method' => 'GET', 'timeout' => 5,
991 'redirection' => 5, 'httpversion' => '1.0',
993 'headers' => array(), 'body' => null, 'cookies' => array()
996 $r = wp_parse_args( $args, $defaults );
998 if ( isset($r['headers']['User-Agent']) ) {
999 $r['user-agent'] = $r['headers']['User-Agent'];
1000 unset($r['headers']['User-Agent']);
1001 } else if ( isset($r['headers']['user-agent']) ) {
1002 $r['user-agent'] = $r['headers']['user-agent'];
1003 unset($r['headers']['user-agent']);
1006 // Construct Cookie: header if any cookies are set.
1007 WP_Http::buildCookieHeader( $r );
1009 $handle = curl_init();
1011 // cURL offers really easy proxy support.
1012 $proxy = new WP_HTTP_Proxy();
1014 if ( $proxy->is_enabled() && $proxy->send_through_proxy( $url ) ) {
1016 curl_setopt( $handle, CURLOPT_PROXYTYPE, CURLPROXY_HTTP );
1017 curl_setopt( $handle, CURLOPT_PROXY, $proxy->host() );
1018 curl_setopt( $handle, CURLOPT_PROXYPORT, $proxy->port() );
1020 if ( $proxy->use_authentication() ) {
1021 curl_setopt( $handle, CURLOPT_PROXYAUTH, CURLAUTH_ANY );
1022 curl_setopt( $handle, CURLOPT_PROXYUSERPWD, $proxy->authentication() );
1026 $is_local = isset($args['local']) && $args['local'];
1027 $ssl_verify = isset($args['sslverify']) && $args['sslverify'];
1029 $ssl_verify = apply_filters('https_local_ssl_verify', $ssl_verify);
1030 elseif ( ! $is_local )
1031 $ssl_verify = apply_filters('https_ssl_verify', $ssl_verify);
1034 // CURLOPT_TIMEOUT and CURLOPT_CONNECTTIMEOUT expect integers. Have to use ceil since
1035 // a value of 0 will allow an unlimited timeout.
1036 $timeout = (int) ceil( $r['timeout'] );
1037 curl_setopt( $handle, CURLOPT_CONNECTTIMEOUT, $timeout );
1038 curl_setopt( $handle, CURLOPT_TIMEOUT, $timeout );
1040 curl_setopt( $handle, CURLOPT_URL, $url);
1041 curl_setopt( $handle, CURLOPT_RETURNTRANSFER, true );
1042 curl_setopt( $handle, CURLOPT_SSL_VERIFYHOST, ( $ssl_verify === true ) ? 2 : false );
1043 curl_setopt( $handle, CURLOPT_SSL_VERIFYPEER, $ssl_verify );
1044 curl_setopt( $handle, CURLOPT_USERAGENT, $r['user-agent'] );
1045 curl_setopt( $handle, CURLOPT_MAXREDIRS, $r['redirection'] );
1047 switch ( $r['method'] ) {
1049 curl_setopt( $handle, CURLOPT_NOBODY, true );
1052 curl_setopt( $handle, CURLOPT_POST, true );
1053 curl_setopt( $handle, CURLOPT_POSTFIELDS, $r['body'] );
1056 curl_setopt( $handle, CURLOPT_CUSTOMREQUEST, 'PUT' );
1057 curl_setopt( $handle, CURLOPT_POSTFIELDS, $r['body'] );
1061 if ( true === $r['blocking'] )
1062 curl_setopt( $handle, CURLOPT_HEADERFUNCTION, array( &$this, 'stream_headers' ) );
1064 curl_setopt( $handle, CURLOPT_HEADER, false );
1066 // If streaming to a file open a file handle, and setup our curl streaming handler
1067 if ( $r['stream'] ) {
1069 $stream_handle = @fopen( $r['filename'], 'w+' );
1071 $stream_handle = fopen( $r['filename'], 'w+' );
1072 if ( ! $stream_handle )
1073 return new WP_Error( 'http_request_failed', sprintf( __( 'Could not open handle for fopen() to %s' ), $r['filename'] ) );
1074 curl_setopt( $handle, CURLOPT_FILE, $stream_handle );
1077 // The option doesn't work with safe mode or when open_basedir is set.
1078 if ( !ini_get('safe_mode') && !ini_get('open_basedir') && 0 !== $r['_redirection'] )
1079 curl_setopt( $handle, CURLOPT_FOLLOWLOCATION, true );
1081 if ( !empty( $r['headers'] ) ) {
1082 // cURL expects full header strings in each element
1084 foreach ( $r['headers'] as $name => $value ) {
1085 $headers[] = "{$name}: $value";
1087 curl_setopt( $handle, CURLOPT_HTTPHEADER, $headers );
1090 if ( $r['httpversion'] == '1.0' )
1091 curl_setopt( $handle, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0 );
1093 curl_setopt( $handle, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_1 );
1095 // Cookies are not handled by the HTTP API currently. Allow for plugin authors to handle it
1096 // themselves... Although, it is somewhat pointless without some reference.
1097 do_action_ref_array( 'http_api_curl', array(&$handle) );
1099 // We don't need to return the body, so don't. Just execute request and return.
1100 if ( ! $r['blocking'] ) {
1101 curl_exec( $handle );
1102 curl_close( $handle );
1103 return array( 'headers' => array(), 'body' => '', 'response' => array('code' => false, 'message' => false), 'cookies' => array() );
1106 $theResponse = curl_exec( $handle );
1108 $theHeaders = WP_Http::processHeaders( $this->headers );
1110 if ( strlen($theResponse) > 0 && ! is_bool( $theResponse ) ) // is_bool: when using $args['stream'], curl_exec will return (bool)true
1111 $theBody = $theResponse;
1113 // If no response, and It's not a HEAD request with valid headers returned
1114 if ( 0 == strlen($theResponse) && ('HEAD' != $args['method'] || empty($this->headers)) ) {
1115 if ( $curl_error = curl_error($handle) )
1116 return new WP_Error('http_request_failed', $curl_error);
1117 if ( in_array( curl_getinfo( $handle, CURLINFO_HTTP_CODE ), array(301, 302) ) )
1118 return new WP_Error('http_request_failed', __('Too many redirects.'));
1121 $this->headers = '';
1123 $response = array();
1124 $response['code'] = curl_getinfo( $handle, CURLINFO_HTTP_CODE );
1125 $response['message'] = get_status_header_desc($response['code']);
1127 curl_close( $handle );
1130 fclose( $stream_handle );
1132 // See #11305 - When running under safe mode, redirection is disabled above. Handle it manually.
1133 if ( ! empty( $theHeaders['headers']['location'] ) && ( ini_get( 'safe_mode' ) || ini_get( 'open_basedir' ) ) && 0 !== $r['_redirection'] ) {
1134 if ( $r['redirection']-- > 0 ) {
1135 return $this->request( $theHeaders['headers']['location'], $r );
1137 return new WP_Error( 'http_request_failed', __( 'Too many redirects.' ) );
1141 if ( true === $r['decompress'] && true === WP_Http_Encoding::should_decode($theHeaders['headers']) )
1142 $theBody = WP_Http_Encoding::decompress( $theBody );
1144 return array( 'headers' => $theHeaders['headers'], 'body' => $theBody, 'response' => $response, 'cookies' => $theHeaders['cookies'], 'filename' => $r['filename'] );
1148 * Grab the headers of the cURL request
1150 * Each header is sent individually to this callback, so we append to the $header property for temporary storage
1156 private function stream_headers( $handle, $headers ) {
1157 $this->headers .= $headers;
1158 return strlen( $headers );
1162 * Whether this class can be used for retrieving an URL.
1167 * @return boolean False means this class can not be used, true means it can.
1169 public static function test( $args = array() ) {
1170 if ( ! function_exists( 'curl_init' ) || ! function_exists( 'curl_exec' ) )
1173 $is_ssl = isset( $args['ssl'] ) && $args['ssl'];
1176 $curl_version = curl_version();
1177 if ( ! (CURL_VERSION_SSL & $curl_version['features']) ) // Does this cURL version support SSL requests?
1181 return apply_filters( 'use_curl_transport', true, $args );
1186 * Adds Proxy support to the WordPress HTTP API.
1188 * There are caveats to proxy support. It requires that defines be made in the wp-config.php file to
1189 * enable proxy support. There are also a few filters that plugins can hook into for some of the
1192 * Please note that only BASIC authentication is supported by most transports.
1193 * cURL MAY support more methods (such as NTLM authentication) depending on your environment.
1195 * The constants are as follows:
1197 * <li>WP_PROXY_HOST - Enable proxy support and host for connecting.</li>
1198 * <li>WP_PROXY_PORT - Proxy port for connection. No default, must be defined.</li>
1199 * <li>WP_PROXY_USERNAME - Proxy username, if it requires authentication.</li>
1200 * <li>WP_PROXY_PASSWORD - Proxy password, if it requires authentication.</li>
1201 * <li>WP_PROXY_BYPASS_HOSTS - Will prevent the hosts in this list from going through the proxy.
1202 * You do not need to have localhost and the blog host in this list, because they will not be passed
1203 * through the proxy. The list should be presented in a comma separated list, wildcards using * are supported, eg. *.wordpress.org</li>
1206 * An example can be as seen below.
1208 * define('WP_PROXY_HOST', '192.168.84.101');
1209 * define('WP_PROXY_PORT', '8080');
1210 * define('WP_PROXY_BYPASS_HOSTS', 'localhost, www.example.com, *.wordpress.org');
1213 * @link http://core.trac.wordpress.org/ticket/4011 Proxy support ticket in WordPress.
1214 * @link http://core.trac.wordpress.org/ticket/14636 Allow wildcard domains in WP_PROXY_BYPASS_HOSTS
1217 class WP_HTTP_Proxy {
1220 * Whether proxy connection should be used.
1223 * @use WP_PROXY_HOST
1224 * @use WP_PROXY_PORT
1228 function is_enabled() {
1229 return defined('WP_PROXY_HOST') && defined('WP_PROXY_PORT');
1233 * Whether authentication should be used.
1236 * @use WP_PROXY_USERNAME
1237 * @use WP_PROXY_PASSWORD
1241 function use_authentication() {
1242 return defined('WP_PROXY_USERNAME') && defined('WP_PROXY_PASSWORD');
1246 * Retrieve the host for the proxy server.
1253 if ( defined('WP_PROXY_HOST') )
1254 return WP_PROXY_HOST;
1260 * Retrieve the port for the proxy server.
1267 if ( defined('WP_PROXY_PORT') )
1268 return WP_PROXY_PORT;
1274 * Retrieve the username for proxy authentication.
1280 function username() {
1281 if ( defined('WP_PROXY_USERNAME') )
1282 return WP_PROXY_USERNAME;
1288 * Retrieve the password for proxy authentication.
1294 function password() {
1295 if ( defined('WP_PROXY_PASSWORD') )
1296 return WP_PROXY_PASSWORD;
1302 * Retrieve authentication string for proxy authentication.
1308 function authentication() {
1309 return $this->username() . ':' . $this->password();
1313 * Retrieve header string for proxy authentication.
1319 function authentication_header() {
1320 return 'Proxy-Authorization: Basic ' . base64_encode( $this->authentication() );
1324 * Whether URL should be sent through the proxy server.
1326 * We want to keep localhost and the blog URL from being sent through the proxy server, because
1327 * some proxies can not handle this. We also have the constant available for defining other
1328 * hosts that won't be sent through the proxy.
1330 * @uses WP_PROXY_BYPASS_HOSTS
1333 * @param string $uri URI to check.
1334 * @return bool True, to send through the proxy and false if, the proxy should not be used.
1336 function send_through_proxy( $uri ) {
1337 // parse_url() only handles http, https type URLs, and will emit E_WARNING on failure.
1338 // This will be displayed on blogs, which is not reasonable.
1339 $check = @parse_url($uri);
1341 // Malformed URL, can not process, but this could mean ssl, so let through anyway.
1342 if ( $check === false )
1345 $home = parse_url( get_option('siteurl') );
1347 if ( $check['host'] == 'localhost' || $check['host'] == $home['host'] )
1350 if ( !defined('WP_PROXY_BYPASS_HOSTS') )
1353 static $bypass_hosts;
1354 static $wildcard_regex = false;
1355 if ( null == $bypass_hosts ) {
1356 $bypass_hosts = preg_split('|,\s*|', WP_PROXY_BYPASS_HOSTS);
1358 if ( false !== strpos(WP_PROXY_BYPASS_HOSTS, '*') ) {
1359 $wildcard_regex = array();
1360 foreach ( $bypass_hosts as $host )
1361 $wildcard_regex[] = str_replace('\*', '[\w.]+?', preg_quote($host, '/'));
1362 $wildcard_regex = '/^(' . implode('|', $wildcard_regex) . ')$/i';
1366 if ( !empty($wildcard_regex) )
1367 return !preg_match($wildcard_regex, $check['host']);
1369 return !in_array( $check['host'], $bypass_hosts );
1373 * Internal representation of a single cookie.
1375 * Returned cookies are represented using this class, and when cookies are set, if they are not
1376 * already a WP_Http_Cookie() object, then they are turned into one.
1378 * @todo The WordPress convention is to use underscores instead of camelCase for function and method
1379 * names. Need to switch to use underscores instead for the methods.
1381 * @package WordPress
1385 class WP_Http_Cookie {
1404 * When the cookie expires.
1428 * Sets up this cookie object.
1430 * The parameter $data should be either an associative array containing the indices names below
1431 * or a header string detailing it.
1433 * If it's an array, it should include the following elements:
1436 * <li>Value - should NOT be urlencoded already.</li>
1437 * <li>Expires - (optional) String or int (UNIX timestamp).</li>
1438 * <li>Path (optional)</li>
1439 * <li>Domain (optional)</li>
1445 * @param string|array $data Raw cookie data.
1447 function __construct( $data ) {
1448 if ( is_string( $data ) ) {
1449 // Assume it's a header string direct from a previous request
1450 $pairs = explode( ';', $data );
1452 // Special handling for first pair; name=value. Also be careful of "=" in value
1453 $name = trim( substr( $pairs[0], 0, strpos( $pairs[0], '=' ) ) );
1454 $value = substr( $pairs[0], strpos( $pairs[0], '=' ) + 1 );
1455 $this->name = $name;
1456 $this->value = urldecode( $value );
1457 array_shift( $pairs ); //Removes name=value from items.
1459 // Set everything else as a property
1460 foreach ( $pairs as $pair ) {
1461 $pair = rtrim($pair);
1462 if ( empty($pair) ) //Handles the cookie ending in ; which results in a empty final pair
1465 list( $key, $val ) = strpos( $pair, '=' ) ? explode( '=', $pair ) : array( $pair, '' );
1466 $key = strtolower( trim( $key ) );
1467 if ( 'expires' == $key )
1468 $val = strtotime( $val );
1472 if ( !isset( $data['name'] ) )
1475 // Set properties based directly on parameters
1476 $this->name = $data['name'];
1477 $this->value = isset( $data['value'] ) ? $data['value'] : '';
1478 $this->path = isset( $data['path'] ) ? $data['path'] : '';
1479 $this->domain = isset( $data['domain'] ) ? $data['domain'] : '';
1481 if ( isset( $data['expires'] ) )
1482 $this->expires = is_int( $data['expires'] ) ? $data['expires'] : strtotime( $data['expires'] );
1484 $this->expires = null;
1489 * Confirms that it's OK to send this cookie to the URL checked against.
1491 * Decision is based on RFC 2109/2965, so look there for details on validity.
1496 * @param string $url URL you intend to send this cookie to
1497 * @return boolean TRUE if allowed, FALSE otherwise.
1499 function test( $url ) {
1500 // Expires - if expired then nothing else matters
1501 if ( time() > $this->expires )
1504 // Get details on the URL we're thinking about sending to
1505 $url = parse_url( $url );
1506 $url['port'] = isset( $url['port'] ) ? $url['port'] : 80;
1507 $url['path'] = isset( $url['path'] ) ? $url['path'] : '/';
1509 // Values to use for comparison against the URL
1510 $path = isset( $this->path ) ? $this->path : '/';
1511 $port = isset( $this->port ) ? $this->port : 80;
1512 $domain = isset( $this->domain ) ? strtolower( $this->domain ) : strtolower( $url['host'] );
1513 if ( false === stripos( $domain, '.' ) )
1514 $domain .= '.local';
1516 // Host - very basic check that the request URL ends with the domain restriction (minus leading dot)
1517 $domain = substr( $domain, 0, 1 ) == '.' ? substr( $domain, 1 ) : $domain;
1518 if ( substr( $url['host'], -strlen( $domain ) ) != $domain )
1521 // Port - supports "port-lists" in the format: "80,8000,8080"
1522 if ( !in_array( $url['port'], explode( ',', $port) ) )
1525 // Path - request path must start with path restriction
1526 if ( substr( $url['path'], 0, strlen( $path ) ) != $path )
1533 * Convert cookie name and value back to header string.
1538 * @return string Header encoded cookie name and value.
1540 function getHeaderValue() {
1541 if ( empty( $this->name ) || empty( $this->value ) )
1544 return $this->name . '=' . urlencode( $this->value );
1548 * Retrieve cookie header for usage in the rest of the WordPress HTTP API.
1555 function getFullHeader() {
1556 return 'Cookie: ' . $this->getHeaderValue();
1561 * Implementation for deflate and gzip transfer encodings.
1563 * Includes RFC 1950, RFC 1951, and RFC 1952.
1566 * @package WordPress
1569 class WP_Http_Encoding {
1572 * Compress raw string using the deflate format.
1574 * Supports the RFC 1951 standard.
1578 * @param string $raw String to compress.
1579 * @param int $level Optional, default is 9. Compression level, 9 is highest.
1580 * @param string $supports Optional, not used. When implemented it will choose the right compression based on what the server supports.
1581 * @return string|bool False on failure.
1583 public static function compress( $raw, $level = 9, $supports = null ) {
1584 return gzdeflate( $raw, $level );
1588 * Decompression of deflated string.
1590 * Will attempt to decompress using the RFC 1950 standard, and if that fails
1591 * then the RFC 1951 standard deflate will be attempted. Finally, the RFC
1592 * 1952 standard gzip decode will be attempted. If all fail, then the
1593 * original compressed string will be returned.
1597 * @param string $compressed String to decompress.
1598 * @param int $length The optional length of the compressed data.
1599 * @return string|bool False on failure.
1601 public static function decompress( $compressed, $length = null ) {
1603 if ( empty($compressed) )
1606 if ( false !== ( $decompressed = @gzinflate( $compressed ) ) )
1607 return $decompressed;
1609 if ( false !== ( $decompressed = WP_Http_Encoding::compatible_gzinflate( $compressed ) ) )
1610 return $decompressed;
1612 if ( false !== ( $decompressed = @gzuncompress( $compressed ) ) )
1613 return $decompressed;
1615 if ( function_exists('gzdecode') ) {
1616 $decompressed = @gzdecode( $compressed );
1618 if ( false !== $decompressed )
1619 return $decompressed;
1626 * Decompression of deflated string while staying compatible with the majority of servers.
1628 * Certain Servers will return deflated data with headers which PHP's gziniflate()
1629 * function cannot handle out of the box. The following function has been created from
1630 * various snippets on the gzinflate() PHP documentation.
1632 * Warning: Magic numbers within. Due to the potential different formats that the compressed
1633 * data may be returned in, some "magic offsets" are needed to ensure proper decompression
1634 * takes place. For a simple progmatic way to determine the magic offset in use, see:
1635 * http://core.trac.wordpress.org/ticket/18273
1638 * @link http://core.trac.wordpress.org/ticket/18273
1639 * @link http://au2.php.net/manual/en/function.gzinflate.php#70875
1640 * @link http://au2.php.net/manual/en/function.gzinflate.php#77336
1642 * @param string $gzData String to decompress.
1643 * @return string|bool False on failure.
1645 public static function compatible_gzinflate($gzData) {
1647 // Compressed data might contain a full header, if so strip it for gzinflate()
1648 if ( substr($gzData, 0, 3) == "\x1f\x8b\x08" ) {
1650 $flg = ord( substr($gzData, 3, 1) );
1653 list($xlen) = unpack('v', substr($gzData, $i, 2) );
1654 $i = $i + 2 + $xlen;
1657 $i = strpos($gzData, "\0", $i) + 1;
1659 $i = strpos($gzData, "\0", $i) + 1;
1663 $decompressed = @gzinflate( substr($gzData, $i, -8) );
1664 if ( false !== $decompressed )
1665 return $decompressed;
1668 // Compressed data from java.util.zip.Deflater amongst others.
1669 $decompressed = @gzinflate( substr($gzData, 2) );
1670 if ( false !== $decompressed )
1671 return $decompressed;
1677 * What encoding types to accept and their priority values.
1681 * @return string Types of encoding to accept.
1683 public static function accept_encoding() {
1685 if ( function_exists( 'gzinflate' ) )
1686 $type[] = 'deflate;q=1.0';
1688 if ( function_exists( 'gzuncompress' ) )
1689 $type[] = 'compress;q=0.5';
1691 if ( function_exists( 'gzdecode' ) )
1692 $type[] = 'gzip;q=0.5';
1694 return implode(', ', $type);
1698 * What encoding the content used when it was compressed to send in the headers.
1702 * @return string Content-Encoding string to send in the header.
1704 public static function content_encoding() {
1709 * Whether the content be decoded based on the headers.
1713 * @param array|string $headers All of the available headers.
1716 public static function should_decode($headers) {
1717 if ( is_array( $headers ) ) {
1718 if ( array_key_exists('content-encoding', $headers) && ! empty( $headers['content-encoding'] ) )
1720 } else if ( is_string( $headers ) ) {
1721 return ( stripos($headers, 'content-encoding:') !== false );
1728 * Whether decompression and compression are supported by the PHP version.
1730 * Each function is tested instead of checking for the zlib extension, to
1731 * ensure that the functions all exist in the PHP version and aren't
1738 public static function is_available() {
1739 return ( function_exists('gzuncompress') || function_exists('gzdeflate') || function_exists('gzinflate') );