1782 lines
56 KiB
PHP
1782 lines
56 KiB
PHP
<?php
|
|
/**
|
|
* Simple and uniform HTTP request API.
|
|
*
|
|
* Will eventually replace and standardize the WordPress HTTP requests made.
|
|
*
|
|
* @link http://trac.wordpress.org/ticket/4779 HTTP API Proposal
|
|
*
|
|
* @package WordPress
|
|
* @subpackage HTTP
|
|
* @since 2.7.0
|
|
* @author Jacob Santos <wordpress@santosj.name>
|
|
*/
|
|
|
|
/**
|
|
* Implementation for deflate and gzip transfer encodings.
|
|
*
|
|
* Includes RFC 1950, RFC 1951, and RFC 1952.
|
|
*
|
|
* @since unknown
|
|
* @package WordPress
|
|
* @subpackage HTTP
|
|
*/
|
|
class WP_Http_Encoding {
|
|
|
|
/**
|
|
* Compress raw string using the deflate format.
|
|
*
|
|
* Supports the RFC 1951 standard.
|
|
*
|
|
* @since unknown
|
|
*
|
|
* @param string $raw String to compress.
|
|
* @param int $level Optional, default is 9. Compression level, 9 is highest.
|
|
* @param string $supports Optional, not used. When implemented it will choose the right compression based on what the server supports.
|
|
* @return string|bool False on failure.
|
|
*/
|
|
function compress( $raw, $level = 9, $supports = null ) {
|
|
return gzdeflate( $raw, $level );
|
|
}
|
|
|
|
/**
|
|
* Decompression of deflated string.
|
|
*
|
|
* Will attempt to decompress using the RFC 1950 standard, and if that fails
|
|
* then the RFC 1951 standard deflate will be attempted. Finally, the RFC
|
|
* 1952 standard gzip decode will be attempted. If all fail, then the
|
|
* original compressed string will be returned.
|
|
*
|
|
* @since unknown
|
|
*
|
|
* @param string $compressed String to decompress.
|
|
* @param int $length The optional length of the compressed data.
|
|
* @return string|bool False on failure.
|
|
*/
|
|
function decompress( $compressed, $length = null ) {
|
|
$decompressed = gzinflate( $compressed );
|
|
|
|
if( false !== $decompressed )
|
|
return $decompressed;
|
|
|
|
$decompressed = gzuncompress( $compressed );
|
|
|
|
if( false !== $decompressed )
|
|
return $decompressed;
|
|
|
|
$decompressed = gzdecode( $compressed );
|
|
|
|
if( false !== $decompressed )
|
|
return $decompressed;
|
|
|
|
return $compressed;
|
|
}
|
|
|
|
/**
|
|
* What encoding types to accept and their priority values.
|
|
*
|
|
* @since unknown
|
|
*
|
|
* @return string Types of encoding to accept.
|
|
*/
|
|
function accept_encoding() {
|
|
$type = array();
|
|
if( function_exists( 'gzinflate' ) )
|
|
$type[] = 'deflate;q=1.0';
|
|
|
|
if( function_exists( 'gzuncompress' ) )
|
|
$type[] = 'compress;q=0.5';
|
|
|
|
if( function_exists( 'gzdecode' ) )
|
|
$type[] = 'gzip;q=0.5';
|
|
|
|
return implode(', ', $type);
|
|
}
|
|
|
|
/**
|
|
* What enconding the content used when it was compressed to send in the headers.
|
|
*
|
|
* @since unknown
|
|
*
|
|
* @return string Content-Encoding string to send in the header.
|
|
*/
|
|
function content_encoding() {
|
|
return 'deflate';
|
|
}
|
|
|
|
/**
|
|
* Whether the content be decoded based on the headers.
|
|
*
|
|
* @since unknown
|
|
*
|
|
* @param array|string $headers All of the available headers.
|
|
* @return bool
|
|
*/
|
|
function should_decode($headers) {
|
|
if( is_array( $headers ) ) {
|
|
if( array_key_exists('content-encoding', $headers) && ! empty( $headers['content-encoding'] ) )
|
|
return true;
|
|
} else if( is_string( $headers ) ) {
|
|
return ( stripos($headers, 'content-encoding:') !== false );
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Whether decompression and compression are supported by the PHP version.
|
|
*
|
|
* Each function is tested instead of checking for the zlib extension, to
|
|
* ensure that the functions all exist in the PHP version and aren't
|
|
* disabled.
|
|
*
|
|
* @since unknown
|
|
*
|
|
* @return bool
|
|
*/
|
|
function is_available() {
|
|
return ( function_exists('gzuncompress') || function_exists('gzdeflate') ||
|
|
function_exists('gzinflate') );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* WordPress HTTP Class for managing HTTP Transports and making HTTP requests.
|
|
*
|
|
* This class is called for the functionality of making HTTP requests and should
|
|
* replace Snoopy functionality, eventually. There is no available functionality
|
|
* to add HTTP transport implementations, since most of the HTTP transports are
|
|
* added and available for use.
|
|
*
|
|
* The exception is that cURL is not available as a transport and lacking an
|
|
* implementation. It will be added later and should be a patch on the WordPress
|
|
* Trac.
|
|
*
|
|
* There are no properties, because none are needed and for performance reasons.
|
|
* Some of the functions are static and while they do have some overhead over
|
|
* functions in PHP4, the purpose is maintainability. When PHP5 is finally the
|
|
* requirement, it will be easy to add the static keyword to the code. It is not
|
|
* as easy to convert a function to a method after enough code uses the old way.
|
|
*
|
|
* Debugging includes several actions, which pass different variables for
|
|
* debugging the HTTP API.
|
|
*
|
|
* <strong>http_transport_get_debug</strong> - gives working, nonblocking, and
|
|
* blocking transports.
|
|
*
|
|
* <strong>http_transport_post_debug</strong> - gives working, nonblocking, and
|
|
* blocking transports.
|
|
*
|
|
* @package WordPress
|
|
* @subpackage HTTP
|
|
* @since 2.7.0
|
|
*/
|
|
class WP_Http {
|
|
|
|
/**
|
|
* PHP4 style Constructor - Calls PHP5 Style Constructor
|
|
*
|
|
* @since 2.7.0
|
|
* @return WP_Http
|
|
*/
|
|
function WP_Http() {
|
|
$this->__construct();
|
|
}
|
|
|
|
/**
|
|
* PHP5 style Constructor - Setup available transport if not available.
|
|
*
|
|
* PHP4 does not have the 'self' keyword and since WordPress supports PHP4,
|
|
* the class needs to be used for the static call.
|
|
*
|
|
* The transport are setup to save time. This should only be called once, so
|
|
* the overhead should be fine.
|
|
*
|
|
* @since 2.7.0
|
|
* @return WP_Http
|
|
*/
|
|
function __construct() {
|
|
WP_Http::_getTransport();
|
|
WP_Http::_postTransport();
|
|
}
|
|
|
|
/**
|
|
* Tests the WordPress HTTP objects for an object to use and returns it.
|
|
*
|
|
* Tests all of the objects and returns the object that passes. Also caches
|
|
* that object to be used later.
|
|
*
|
|
* The order for the GET/HEAD requests are Streams, HTTP Extension, Fopen,
|
|
* and finally Fsockopen. fsockopen() is used last, because it has the most
|
|
* overhead in its implementation. There isn't any real way around it, since
|
|
* redirects have to be supported, much the same way the other transports
|
|
* also handle redirects.
|
|
*
|
|
* There are currently issues with "localhost" not resolving correctly with
|
|
* DNS. This may cause an error "failed to open stream: A connection attempt
|
|
* failed because the connected party did not properly respond after a
|
|
* period of time, or established connection failed because connected host
|
|
* has failed to respond."
|
|
*
|
|
* @since 2.7.0
|
|
* @access private
|
|
*
|
|
* @param array $args Request args, default us an empty array
|
|
* @return object|null Null if no transports are available, HTTP transport object.
|
|
*/
|
|
function &_getTransport( $args = array() ) {
|
|
static $working_transport, $blocking_transport, $nonblocking_transport;
|
|
|
|
if ( is_null($working_transport) ) {
|
|
if ( true === WP_Http_ExtHttp::test($args) ) {
|
|
$working_transport['exthttp'] = new WP_Http_ExtHttp();
|
|
$blocking_transport[] = &$working_transport['exthttp'];
|
|
} else if ( true === WP_Http_Curl::test($args) ) {
|
|
$working_transport['curl'] = new WP_Http_Curl();
|
|
$blocking_transport[] = &$working_transport['curl'];
|
|
} else if ( true === WP_Http_Streams::test($args) ) {
|
|
$working_transport['streams'] = new WP_Http_Streams();
|
|
$blocking_transport[] = &$working_transport['streams'];
|
|
} else if ( true === WP_Http_Fopen::test($args) ) {
|
|
$working_transport['fopen'] = new WP_Http_Fopen();
|
|
$blocking_transport[] = &$working_transport['fopen'];
|
|
} else if ( true === WP_Http_Fsockopen::test($args) ) {
|
|
$working_transport['fsockopen'] = new WP_Http_Fsockopen();
|
|
$blocking_transport[] = &$working_transport['fsockopen'];
|
|
}
|
|
|
|
foreach ( array('curl', 'streams', 'fopen', 'fsockopen', 'exthttp') as $transport ) {
|
|
if ( isset($working_transport[$transport]) )
|
|
$nonblocking_transport[] = &$working_transport[$transport];
|
|
}
|
|
}
|
|
|
|
if( has_filter('http_transport_get_debug') )
|
|
do_action('http_transport_get_debug', $working_transport, $blocking_transport, $nonblocking_transport);
|
|
|
|
if ( isset($args['blocking']) && !$args['blocking'] )
|
|
return $nonblocking_transport;
|
|
else
|
|
return $blocking_transport;
|
|
}
|
|
|
|
/**
|
|
* Tests the WordPress HTTP objects for an object to use and returns it.
|
|
*
|
|
* Tests all of the objects and returns the object that passes. Also caches
|
|
* that object to be used later. This is for posting content to a URL and
|
|
* is used when there is a body. The plain Fopen Transport can not be used
|
|
* to send content, but the streams transport can. This is a limitation that
|
|
* is addressed here, by just not including that transport.
|
|
*
|
|
* @since 2.7.0
|
|
* @access private
|
|
*
|
|
* @param array $args Request args, default us an empty array
|
|
* @return object|null Null if no transports are available, HTTP transport object.
|
|
*/
|
|
function &_postTransport( $args = array() ) {
|
|
static $working_transport, $blocking_transport, $nonblocking_transport;
|
|
|
|
if ( is_null($working_transport) ) {
|
|
if ( true === WP_Http_ExtHttp::test($args) ) {
|
|
$working_transport['exthttp'] = new WP_Http_ExtHttp();
|
|
$blocking_transport[] = &$working_transport['exthttp'];
|
|
} else if ( true === WP_Http_Curl::test($args) ) {
|
|
$working_transport['curl'] = new WP_Http_Curl();
|
|
$blocking_transport[] = &$working_transport['curl'];
|
|
} else if ( true === WP_Http_Streams::test($args) ) {
|
|
$working_transport['streams'] = new WP_Http_Streams();
|
|
$blocking_transport[] = &$working_transport['streams'];
|
|
} else if ( true === WP_Http_Fsockopen::test($args) ) {
|
|
$working_transport['fsockopen'] = new WP_Http_Fsockopen();
|
|
$blocking_transport[] = &$working_transport['fsockopen'];
|
|
}
|
|
|
|
foreach ( array('curl', 'streams', 'fsockopen', 'exthttp') as $transport ) {
|
|
if ( isset($working_transport[$transport]) )
|
|
$nonblocking_transport[] = &$working_transport[$transport];
|
|
}
|
|
}
|
|
|
|
if( has_filter('http_transport_post_debug') )
|
|
do_action('http_transport_post_debug', $working_transport, $blocking_transport, $nonblocking_transport);
|
|
|
|
if ( isset($args['blocking']) && !$args['blocking'] )
|
|
return $nonblocking_transport;
|
|
else
|
|
return $blocking_transport;
|
|
}
|
|
|
|
/**
|
|
* Send a HTTP request to a URI.
|
|
*
|
|
* The body and headers are part of the arguments. The 'body' argument is
|
|
* for the body and will accept either a string or an array. The 'headers'
|
|
* argument should be an array, but a string is acceptable. If the 'body'
|
|
* argument is an array, then it will automatically be escaped using
|
|
* http_build_query().
|
|
*
|
|
* The only URI that are supported in the HTTP Transport implementation are
|
|
* the HTTP and HTTPS protocols. HTTP and HTTPS are assumed so the server
|
|
* might not know how to handle the send headers. Other protocols are
|
|
* unsupported and most likely will fail.
|
|
*
|
|
* The defaults are 'method', 'timeout', 'redirection', 'httpversion',
|
|
* 'blocking' and 'user-agent'.
|
|
*
|
|
* Accepted 'method' values are 'GET', 'POST', and 'HEAD', some transports
|
|
* technically allow others, but should not be assumed. The 'timeout' is
|
|
* used to sent how long the connection should stay open before failing when
|
|
* no response. 'redirection' is used to track how many redirects were taken
|
|
* and used to sent the amount for other transports, but not all transports
|
|
* accept setting that value.
|
|
*
|
|
* The 'httpversion' option is used to sent the HTTP version and accepted
|
|
* values are '1.0', and '1.1' and should be a string. Version 1.1 is not
|
|
* supported, because of chunk response. The 'user-agent' option is the
|
|
* user-agent and is used to replace the default user-agent, which is
|
|
* 'WordPress/WP_Version', where WP_Version is the value from $wp_version.
|
|
*
|
|
* 'blocking' is the default, which is used to tell the transport, whether
|
|
* it should halt PHP while it performs the request or continue regardless.
|
|
* Actually, that isn't entirely correct. Blocking mode really just means
|
|
* whether the fread should just pull what it can whenever it gets bytes or
|
|
* if it should wait until it has enough in the buffer to read or finishes
|
|
* reading the entire content. It doesn't actually always mean that PHP will
|
|
* continue going after making the request.
|
|
*
|
|
* @access public
|
|
* @since 2.7.0
|
|
*
|
|
* @param string $url URI resource.
|
|
* @param str|array $args Optional. Override the defaults.
|
|
* @return array containing 'headers', 'body', 'response', 'cookies'
|
|
*/
|
|
function request( $url, $args = array() ) {
|
|
global $wp_version;
|
|
|
|
$defaults = array(
|
|
'method' => 'GET',
|
|
'timeout' => apply_filters( 'http_request_timeout', 5),
|
|
'redirection' => apply_filters( 'http_request_redirection_count', 5),
|
|
'httpversion' => apply_filters( 'http_request_version', '1.0'),
|
|
'user-agent' => apply_filters( 'http_headers_useragent', 'WordPress/' . $wp_version . '; ' . get_bloginfo( 'url' ) ),
|
|
'blocking' => true,
|
|
'headers' => array(),
|
|
'cookies' => array(),
|
|
'body' => null,
|
|
'compress' => false,
|
|
'decompress' => true,
|
|
'sslverify' => true
|
|
);
|
|
|
|
$r = wp_parse_args( $args, $defaults );
|
|
$r = apply_filters( 'http_request_args', $r, $url );
|
|
|
|
$arrURL = parse_url($url);
|
|
|
|
if ( $this->block_request( $url ) )
|
|
return new WP_Error('http_request_failed', 'User has blocked requests through HTTP.');
|
|
|
|
// Determine if this is a https call and pass that on to the transport functions
|
|
// so that we can blacklist the transports that do not support ssl verification
|
|
if ( $arrURL['scheme'] == 'https' || $arrURL['scheme'] == 'ssl' )
|
|
$r['ssl'] = true;
|
|
else
|
|
$r['ssl'] = false;
|
|
|
|
// Determine if this request is to OUR install of WordPress
|
|
if ( stristr(get_bloginfo('url'), $arrURL['host']) )
|
|
$r['local'] = true;
|
|
else
|
|
$r['local'] = false;
|
|
|
|
if ( is_null( $r['headers'] ) )
|
|
$r['headers'] = array();
|
|
|
|
if ( ! is_array($r['headers']) ) {
|
|
$processedHeaders = WP_Http::processHeaders($r['headers']);
|
|
$r['headers'] = $processedHeaders['headers'];
|
|
}
|
|
|
|
if ( isset($r['headers']['User-Agent']) ) {
|
|
$r['user-agent'] = $r['headers']['User-Agent'];
|
|
unset($r['headers']['User-Agent']);
|
|
}
|
|
|
|
if ( isset($r['headers']['user-agent']) ) {
|
|
$r['user-agent'] = $r['headers']['user-agent'];
|
|
unset($r['headers']['user-agent']);
|
|
}
|
|
|
|
// Construct Cookie: header if any cookies are set
|
|
WP_Http::buildCookieHeader( $r );
|
|
|
|
if( WP_Http_Encoding::is_available() )
|
|
$r['headers']['Accept-Encoding'] = WP_Http_Encoding::accept_encoding();
|
|
|
|
if ( is_null($r['body']) ) {
|
|
// Some servers fail when sending content without the content-length
|
|
// header being set.
|
|
$r['headers']['Content-Length'] = 0;
|
|
$transports = WP_Http::_getTransport($r);
|
|
} else {
|
|
if ( is_array( $r['body'] ) || is_object( $r['body'] ) ) {
|
|
$r['body'] = http_build_query($r['body'], null, '&');
|
|
$r['headers']['Content-Type'] = 'application/x-www-form-urlencoded; charset=' . get_option('blog_charset');
|
|
$r['headers']['Content-Length'] = strlen($r['body']);
|
|
}
|
|
|
|
if ( ! isset( $r['headers']['Content-Length'] ) && ! isset( $r['headers']['content-length'] ) )
|
|
$r['headers']['Content-Length'] = strlen($r['body']);
|
|
|
|
$transports = WP_Http::_postTransport($r);
|
|
}
|
|
|
|
if( has_action('http_api_debug') )
|
|
do_action('http_api_debug', $transports, 'transports_list');
|
|
|
|
$response = array( 'headers' => array(), 'body' => '', 'response' => array('code' => false, 'message' => false), 'cookies' => array() );
|
|
foreach( (array) $transports as $transport ) {
|
|
$response = $transport->request($url, $r);
|
|
|
|
if( has_action('http_api_debug') )
|
|
do_action( 'http_api_debug', $response, 'response', get_class($transport) );
|
|
|
|
if( ! is_wp_error($response) )
|
|
return $response;
|
|
}
|
|
|
|
return $response;
|
|
}
|
|
|
|
/**
|
|
* Uses the POST HTTP method.
|
|
*
|
|
* Used for sending data that is expected to be in the body.
|
|
*
|
|
* @access public
|
|
* @since 2.7.0
|
|
*
|
|
* @param string $url URI resource.
|
|
* @param str|array $args Optional. Override the defaults.
|
|
* @return boolean
|
|
*/
|
|
function post($url, $args = array()) {
|
|
$defaults = array('method' => 'POST');
|
|
$r = wp_parse_args( $args, $defaults );
|
|
return $this->request($url, $r);
|
|
}
|
|
|
|
/**
|
|
* Uses the GET HTTP method.
|
|
*
|
|
* Used for sending data that is expected to be in the body.
|
|
*
|
|
* @access public
|
|
* @since 2.7.0
|
|
*
|
|
* @param string $url URI resource.
|
|
* @param str|array $args Optional. Override the defaults.
|
|
* @return boolean
|
|
*/
|
|
function get($url, $args = array()) {
|
|
$defaults = array('method' => 'GET');
|
|
$r = wp_parse_args( $args, $defaults );
|
|
return $this->request($url, $r);
|
|
}
|
|
|
|
/**
|
|
* Uses the HEAD HTTP method.
|
|
*
|
|
* Used for sending data that is expected to be in the body.
|
|
*
|
|
* @access public
|
|
* @since 2.7.0
|
|
*
|
|
* @param string $url URI resource.
|
|
* @param str|array $args Optional. Override the defaults.
|
|
* @return boolean
|
|
*/
|
|
function head($url, $args = array()) {
|
|
$defaults = array('method' => 'HEAD');
|
|
$r = wp_parse_args( $args, $defaults );
|
|
return $this->request($url, $r);
|
|
}
|
|
|
|
/**
|
|
* Parses the responses and splits the parts into headers and body.
|
|
*
|
|
* @access public
|
|
* @static
|
|
* @since 2.7.0
|
|
*
|
|
* @param string $strResponse The full response string
|
|
* @return array Array with 'headers' and 'body' keys.
|
|
*/
|
|
function processResponse($strResponse) {
|
|
list($theHeaders, $theBody) = explode("\r\n\r\n", $strResponse, 2);
|
|
return array('headers' => $theHeaders, 'body' => $theBody);
|
|
}
|
|
|
|
/**
|
|
* Transform header string into an array.
|
|
*
|
|
* If an array is given then it is assumed to be raw header data with numeric keys with the
|
|
* headers as the values. No headers must be passed that were already processed.
|
|
*
|
|
* @access public
|
|
* @static
|
|
* @since 2.7.0
|
|
*
|
|
* @param string|array $headers
|
|
* @return array Processed string headers. If duplicate headers are encountered,
|
|
* Then a numbered array is returned as the value of that header-key.
|
|
*/
|
|
function processHeaders($headers) {
|
|
if ( is_string($headers) )
|
|
$headers = explode("\n", str_replace(array("\r\n", "\r"), "\n", $headers) );
|
|
|
|
$response = array('code' => 0, 'message' => '');
|
|
|
|
$cookies = array();
|
|
$newheaders = array();
|
|
foreach ( $headers as $tempheader ) {
|
|
if ( empty($tempheader) )
|
|
continue;
|
|
|
|
if ( false === strpos($tempheader, ':') ) {
|
|
list( , $iResponseCode, $strResponseMsg) = explode(' ', $tempheader, 3);
|
|
$response['code'] = $iResponseCode;
|
|
$response['message'] = $strResponseMsg;
|
|
continue;
|
|
}
|
|
|
|
list($key, $value) = explode(':', $tempheader, 2);
|
|
|
|
if ( !empty( $value ) ) {
|
|
$key = strtolower( $key );
|
|
if ( isset( $newheaders[$key] ) ) {
|
|
$newheaders[$key] = array( $newheaders[$key], trim( $value ) );
|
|
} else {
|
|
$newheaders[$key] = trim( $value );
|
|
}
|
|
if ( 'set-cookie' == strtolower( $key ) )
|
|
$cookies[] = new WP_Http_Cookie( $value );
|
|
}
|
|
}
|
|
|
|
return array('response' => $response, 'headers' => $newheaders, 'cookies' => $cookies);
|
|
}
|
|
|
|
/**
|
|
* Takes the arguments for a ::request() and checks for the cookie array.
|
|
*
|
|
* If it's found, then it's assumed to contain WP_Http_Cookie objects, which are each parsed
|
|
* into strings and added to the Cookie: header (within the arguments array). Edits the array by
|
|
* reference.
|
|
*
|
|
* @access public
|
|
* @version 2.8.0
|
|
* @static
|
|
*
|
|
* @param array $r Full array of args passed into ::request()
|
|
*/
|
|
function buildCookieHeader( &$r ) {
|
|
if ( ! empty($r['cookies']) ) {
|
|
$cookies_header = '';
|
|
foreach ( (array) $r['cookies'] as $cookie ) {
|
|
$cookies_header .= $cookie->getHeaderValue() . '; ';
|
|
}
|
|
$cookies_header = substr( $cookies_header, 0, -2 );
|
|
$r['headers']['cookie'] = $cookies_header;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Decodes chunk transfer-encoding, based off the HTTP 1.1 specification.
|
|
*
|
|
* Based off the HTTP http_encoding_dechunk function. Does not support
|
|
* UTF-8. Does not support returning footer headers. Shouldn't be too
|
|
* difficult to support it though.
|
|
*
|
|
* @todo Add support for footer chunked headers.
|
|
* @access public
|
|
* @since 2.7.0
|
|
* @static
|
|
*
|
|
* @param string $body Body content
|
|
* @return string Chunked decoded body on success or raw body on failure.
|
|
*/
|
|
function chunkTransferDecode($body) {
|
|
$body = str_replace(array("\r\n", "\r"), "\n", $body);
|
|
// The body is not chunked encoding or is malformed.
|
|
if ( ! preg_match( '/^[0-9a-f]+(\s|\n)+/mi', trim($body) ) )
|
|
return $body;
|
|
|
|
$parsedBody = '';
|
|
//$parsedHeaders = array(); Unsupported
|
|
|
|
while ( true ) {
|
|
$hasChunk = (bool) preg_match( '/^([0-9a-f]+)(\s|\n)+/mi', $body, $match );
|
|
|
|
if ( $hasChunk ) {
|
|
if ( empty( $match[1] ) )
|
|
return $body;
|
|
|
|
$length = hexdec( $match[1] );
|
|
$chunkLength = strlen( $match[0] );
|
|
|
|
$strBody = substr($body, $chunkLength, $length);
|
|
$parsedBody .= $strBody;
|
|
|
|
$body = ltrim(str_replace(array($match[0], $strBody), '', $body), "\n");
|
|
|
|
if( "0" == trim($body) )
|
|
return $parsedBody; // Ignore footer headers.
|
|
} else {
|
|
return $body;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Block requests through the proxy.
|
|
*
|
|
* Those who are behind a proxy and want to prevent access to certain hosts may do so. This will
|
|
* prevent plugins from working and core functionality, if you don't include api.wordpress.org.
|
|
*
|
|
* You block external URL requests by defining WP_HTTP_BLOCK_EXTERNAL in your wp-config.php file
|
|
* and this will only allow localhost and your blog to make requests. The constant
|
|
* WP_ACCESSABLE_HOSTS will allow additional hosts to go through for requests.
|
|
*
|
|
* @since unknown
|
|
* @link http://core.trac.wordpress.org/ticket/8927 Allow preventing external requests.
|
|
*
|
|
* @param string $uri URI of url.
|
|
* @return bool True to block, false to allow.
|
|
*/
|
|
function block_request($uri) {
|
|
// We don't need to block requests, because nothing is blocked.
|
|
if ( ! defined('WP_HTTP_BLOCK_EXTERNAL') || ( defined('WP_HTTP_BLOCK_EXTERNAL') && WP_HTTP_BLOCK_EXTERNAL == false ) )
|
|
return false;
|
|
|
|
// parse_url() only handles http, https type URLs, and will emit E_WARNING on failure.
|
|
// This will be displayed on blogs, which is not reasonable.
|
|
$check = @parse_url($uri);
|
|
|
|
/* Malformed URL, can not process, but this could mean ssl, so let through anyway.
|
|
*
|
|
* This isn't very security sound. There are instances where a hacker might attempt
|
|
* to bypass the proxy and this check. However, the reason for this behavior is that
|
|
* WordPress does not do any checking currently for non-proxy requests, so it is keeps with
|
|
* the default unsecure nature of the HTTP request.
|
|
*/
|
|
if ( $check === false )
|
|
return false;
|
|
|
|
$home = parse_url( get_bloginfo('site_url') );
|
|
|
|
// Don't block requests back to ourselves by default
|
|
if ( $uri == 'localhost' || $uri == $home['host'] )
|
|
return apply_filters('block_local_requests', false);
|
|
|
|
if ( defined('WP_ACCESSABLE_HOSTS') && is_array( WP_ACCESSABLE_HOSTS ) && in_array( $check['host'], WP_ACCESSABLE_HOSTS ) ) {
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* HTTP request method uses fsockopen function to retrieve the url.
|
|
*
|
|
* This would be the preferred method, but the fsockopen implementation has the
|
|
* most overhead of all the HTTP transport implementations.
|
|
*
|
|
* @package WordPress
|
|
* @subpackage HTTP
|
|
* @since 2.7.0
|
|
*/
|
|
class WP_Http_Fsockopen {
|
|
/**
|
|
* Send a HTTP request to a URI using fsockopen().
|
|
*
|
|
* Does not support non-blocking mode.
|
|
*
|
|
* @see WP_Http::request For default options descriptions.
|
|
*
|
|
* @since 2.7
|
|
* @access public
|
|
* @param string $url URI resource.
|
|
* @param str|array $args Optional. Override the defaults.
|
|
* @return array 'headers', 'body', 'cookies' and 'response' keys.
|
|
*/
|
|
function request($url, $args = array()) {
|
|
$defaults = array(
|
|
'method' => 'GET', 'timeout' => 5,
|
|
'redirection' => 5, 'httpversion' => '1.0',
|
|
'blocking' => true,
|
|
'headers' => array(), 'body' => null, 'cookies' => array()
|
|
);
|
|
|
|
$r = wp_parse_args( $args, $defaults );
|
|
|
|
if ( isset($r['headers']['User-Agent']) ) {
|
|
$r['user-agent'] = $r['headers']['User-Agent'];
|
|
unset($r['headers']['User-Agent']);
|
|
} else if( isset($r['headers']['user-agent']) ) {
|
|
$r['user-agent'] = $r['headers']['user-agent'];
|
|
unset($r['headers']['user-agent']);
|
|
}
|
|
|
|
// Construct Cookie: header if any cookies are set
|
|
WP_Http::buildCookieHeader( $r );
|
|
|
|
$iError = null; // Store error number
|
|
$strError = null; // Store error string
|
|
|
|
$arrURL = parse_url($url);
|
|
|
|
$secure_transport = false;
|
|
|
|
if ( ! isset($arrURL['port']) ) {
|
|
if ( ($arrURL['scheme'] == 'ssl' || $arrURL['scheme'] == 'https') && extension_loaded('openssl') ) {
|
|
$arrURL['host'] = 'ssl://' . $arrURL['host'];
|
|
$arrURL['port'] = apply_filters('http_request_port', 443);
|
|
$secure_transport = true;
|
|
} else {
|
|
$arrURL['port'] = apply_filters('http_request_default_port', 80);
|
|
}
|
|
} else {
|
|
$arrURL['port'] = apply_filters('http_request_port', $arrURL['port']);
|
|
}
|
|
|
|
// There are issues with the HTTPS and SSL protocols that cause errors
|
|
// that can be safely ignored and should be ignored.
|
|
if ( true === $secure_transport )
|
|
$error_reporting = error_reporting(0);
|
|
|
|
$startDelay = time();
|
|
|
|
if ( !defined('WP_DEBUG') || ( defined('WP_DEBUG') && false === WP_DEBUG ) )
|
|
$handle = @fsockopen($arrURL['host'], $arrURL['port'], $iError, $strError, $r['timeout'] );
|
|
else
|
|
$handle = fsockopen($arrURL['host'], $arrURL['port'], $iError, $strError, $r['timeout'] );
|
|
|
|
$endDelay = time();
|
|
|
|
// If the delay is greater than the timeout then fsockopen should't be
|
|
// used, because it will cause a long delay.
|
|
$elapseDelay = ($endDelay-$startDelay) > $r['timeout'];
|
|
if ( true === $elapseDelay )
|
|
add_option( 'disable_fsockopen', $endDelay, null, true );
|
|
|
|
if ( false === $handle )
|
|
return new WP_Error('http_request_failed', $iError . ': ' . $strError);
|
|
|
|
// WordPress supports PHP 4.3, which has this function. Removed sanity
|
|
// checking for performance reasons.
|
|
stream_set_timeout($handle, $r['timeout'] );
|
|
|
|
$requestPath = $arrURL['path'] . ( isset($arrURL['query']) ? '?' . $arrURL['query'] : '' );
|
|
$requestPath = empty($requestPath) ? '/' : $requestPath;
|
|
|
|
$strHeaders = '';
|
|
$strHeaders .= strtoupper($r['method']) . ' ' . $requestPath . ' HTTP/' . $r['httpversion'] . "\r\n";
|
|
$strHeaders .= 'Host: ' . $arrURL['host'] . "\r\n";
|
|
|
|
if( isset($r['user-agent']) )
|
|
$strHeaders .= 'User-agent: ' . $r['user-agent'] . "\r\n";
|
|
|
|
if ( is_array($r['headers']) ) {
|
|
foreach ( (array) $r['headers'] as $header => $headerValue )
|
|
$strHeaders .= $header . ': ' . $headerValue . "\r\n";
|
|
} else {
|
|
$strHeaders .= $r['headers'];
|
|
}
|
|
|
|
$strHeaders .= "\r\n";
|
|
|
|
if ( ! is_null($r['body']) )
|
|
$strHeaders .= $r['body'];
|
|
|
|
fwrite($handle, $strHeaders);
|
|
|
|
if ( ! $r['blocking'] ) {
|
|
fclose($handle);
|
|
return array( 'headers' => array(), 'body' => '', 'response' => array('code' => false, 'message' => false), 'cookies' => array() );
|
|
}
|
|
|
|
$strResponse = '';
|
|
while ( ! feof($handle) )
|
|
$strResponse .= fread($handle, 4096);
|
|
|
|
fclose($handle);
|
|
|
|
if ( true === $secure_transport )
|
|
error_reporting($error_reporting);
|
|
|
|
$process = WP_Http::processResponse($strResponse);
|
|
$arrHeaders = WP_Http::processHeaders($process['headers']);
|
|
|
|
// Is the response code within the 400 range?
|
|
if ( (int) $arrHeaders['response']['code'] >= 400 && (int) $arrHeaders['response']['code'] < 500 )
|
|
return new WP_Error('http_request_failed', $arrHeaders['response']['code'] . ': ' . $arrHeaders['response']['message']);
|
|
|
|
// If location is found, then assume redirect and redirect to location.
|
|
if ( isset($arrHeaders['headers']['location']) ) {
|
|
if ( $r['redirection']-- > 0 ) {
|
|
return $this->request($arrHeaders['headers']['location'], $r);
|
|
} else {
|
|
return new WP_Error('http_request_failed', __('Too many redirects.'));
|
|
}
|
|
}
|
|
|
|
// If the body was chunk encoded, then decode it.
|
|
if ( ! empty( $process['body'] ) && isset( $arrHeaders['headers']['transfer-encoding'] ) && 'chunked' == $arrHeaders['headers']['transfer-encoding'] )
|
|
$process['body'] = WP_Http::chunkTransferDecode($process['body']);
|
|
|
|
if ( true === $r['decompress'] && true === WP_Http_Encoding::should_decode($arrHeaders) )
|
|
$process['body'] = WP_Http_Encoding::decompress( $process['body'] );
|
|
|
|
return array('headers' => $arrHeaders['headers'], 'body' => $process['body'], 'response' => $arrHeaders['response'], 'cookies' => $arrHeaders['cookies']);
|
|
}
|
|
|
|
/**
|
|
* Whether this class can be used for retrieving an URL.
|
|
*
|
|
* @since 2.7.0
|
|
* @static
|
|
* @return boolean False means this class can not be used, true means it can.
|
|
*/
|
|
function test($args = array()) {
|
|
if ( false !== ($option = get_option( 'disable_fsockopen' )) && time()-$option < 43200 ) // 12 hours
|
|
return false;
|
|
|
|
if ( function_exists( 'fsockopen' ) && ( isset($args['ssl']) && !$args['ssl'] ) )
|
|
return apply_filters('use_fsockopen_transport', true);
|
|
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* HTTP request method uses fopen function to retrieve the url.
|
|
*
|
|
* Requires PHP version greater than 4.3.0 for stream support. Does not allow
|
|
* for $context support, but should still be okay, to write the headers, before
|
|
* getting the response. Also requires that 'allow_url_fopen' to be enabled.
|
|
*
|
|
* @package WordPress
|
|
* @subpackage HTTP
|
|
* @since 2.7.0
|
|
*/
|
|
class WP_Http_Fopen {
|
|
/**
|
|
* Send a HTTP request to a URI using fopen().
|
|
*
|
|
* This transport does not support sending of headers and body, therefore
|
|
* should not be used in the instances, where there is a body and headers.
|
|
*
|
|
* Notes: Does not support non-blocking mode. Ignores 'redirection' option.
|
|
*
|
|
* @see WP_Http::retrieve For default options descriptions.
|
|
*
|
|
* @access public
|
|
* @since 2.7.0
|
|
*
|
|
* @param string $url URI resource.
|
|
* @param str|array $args Optional. Override the defaults.
|
|
* @return array 'headers', 'body', 'cookies' and 'response' keys.
|
|
*/
|
|
function request($url, $args = array()) {
|
|
global $http_response_header;
|
|
|
|
$defaults = array(
|
|
'method' => 'GET', 'timeout' => 5,
|
|
'redirection' => 5, 'httpversion' => '1.0',
|
|
'blocking' => true,
|
|
'headers' => array(), 'body' => null, 'cookies' => array()
|
|
);
|
|
|
|
$r = wp_parse_args( $args, $defaults );
|
|
|
|
$arrURL = parse_url($url);
|
|
|
|
if ( false === $arrURL )
|
|
return new WP_Error('http_request_failed', sprintf(__('Malformed URL: %s'), $url));
|
|
|
|
if ( 'http' != $arrURL['scheme'] && 'https' != $arrURL['scheme'] )
|
|
$url = str_replace($arrURL['scheme'], 'http', $url);
|
|
|
|
if ( !defined('WP_DEBUG') || ( defined('WP_DEBUG') && false === WP_DEBUG ) )
|
|
$handle = @fopen($url, 'r');
|
|
else
|
|
$handle = fopen($url, 'r');
|
|
|
|
if (! $handle)
|
|
return new WP_Error('http_request_failed', sprintf(__('Could not open handle for fopen() to %s'), $url));
|
|
|
|
// WordPress supports PHP 4.3, which has this function. Removed sanity
|
|
// checking for performance reasons.
|
|
stream_set_timeout($handle, $r['timeout'] );
|
|
|
|
if ( ! $r['blocking'] ) {
|
|
fclose($handle);
|
|
return array( 'headers' => array(), 'body' => '', 'response' => array('code' => false, 'message' => false), 'cookies' => array() );
|
|
}
|
|
|
|
$strResponse = '';
|
|
while ( ! feof($handle) )
|
|
$strResponse .= fread($handle, 4096);
|
|
|
|
$theHeaders = '';
|
|
if ( function_exists('stream_get_meta_data') ) {
|
|
$meta = stream_get_meta_data($handle);
|
|
$theHeaders = $meta['wrapper_data'];
|
|
if( isset( $meta['wrapper_data']['headers'] ) )
|
|
$theHeaders = $meta['wrapper_data']['headers'];
|
|
} else {
|
|
if( ! isset( $http_response_header ) )
|
|
global $http_response_header;
|
|
$theHeaders = $http_response_header;
|
|
}
|
|
|
|
fclose($handle);
|
|
|
|
$processedHeaders = WP_Http::processHeaders($theHeaders);
|
|
|
|
if ( ! empty( $strResponse ) && isset( $processedHeaders['headers']['transfer-encoding'] ) && 'chunked' == $processedHeaders['headers']['transfer-encoding'] )
|
|
$strResponse = WP_Http::chunkTransferDecode($strResponse);
|
|
|
|
if ( true === $r['decompress'] && true === WP_Http_Encoding::should_decode($processedHeaders) )
|
|
$strResponse = WP_Http_Encoding::decompress( $strResponse );
|
|
|
|
return array('headers' => $processedHeaders['headers'], 'body' => $strResponse, 'response' => $processedHeaders['response'], 'cookies' => $processedHeaders['cookies']);
|
|
}
|
|
|
|
/**
|
|
* Whether this class can be used for retrieving an URL.
|
|
*
|
|
* @since 2.7.0
|
|
* @static
|
|
* @return boolean False means this class can not be used, true means it can.
|
|
*/
|
|
function test() {
|
|
if ( ! function_exists('fopen') || (function_exists('ini_get') && true != ini_get('allow_url_fopen')) )
|
|
return false;
|
|
|
|
if (
|
|
( isset($args['ssl']) && !$args['ssl'] ) ||
|
|
( isset($args['local']) && $args['local'] == true && apply_filters('https_local_ssl_verify', true) != true ) ||
|
|
( isset($args['local']) && $args['local'] == false && apply_filters('https_ssl_verify', true) != true ) ||
|
|
( isset($args['sslverify']) && !$args['sslverify'] )
|
|
)
|
|
return apply_filters('use_fopen_transport', true);
|
|
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* HTTP request method uses Streams to retrieve the url.
|
|
*
|
|
* Requires PHP 5.0+ and uses fopen with stream context. Requires that
|
|
* 'allow_url_fopen' PHP setting to be enabled.
|
|
*
|
|
* Second preferred method for getting the URL, for PHP 5.
|
|
*
|
|
* @package WordPress
|
|
* @subpackage HTTP
|
|
* @since 2.7.0
|
|
*/
|
|
class WP_Http_Streams {
|
|
/**
|
|
* Send a HTTP request to a URI using streams with fopen().
|
|
*
|
|
* @access public
|
|
* @since 2.7.0
|
|
*
|
|
* @param string $url
|
|
* @param str|array $args Optional. Override the defaults.
|
|
* @return array 'headers', 'body', 'cookies' and 'response' keys.
|
|
*/
|
|
function request($url, $args = array()) {
|
|
$defaults = array(
|
|
'method' => 'GET', 'timeout' => 5,
|
|
'redirection' => 5, 'httpversion' => '1.0',
|
|
'blocking' => true,
|
|
'headers' => array(), 'body' => null, 'cookies' => array()
|
|
);
|
|
|
|
$r = wp_parse_args( $args, $defaults );
|
|
|
|
if ( isset($r['headers']['User-Agent']) ) {
|
|
$r['user-agent'] = $r['headers']['User-Agent'];
|
|
unset($r['headers']['User-Agent']);
|
|
} else if( isset($r['headers']['user-agent']) ) {
|
|
$r['user-agent'] = $r['headers']['user-agent'];
|
|
unset($r['headers']['user-agent']);
|
|
}
|
|
|
|
// Construct Cookie: header if any cookies are set
|
|
WP_Http::buildCookieHeader( $r );
|
|
|
|
$arrURL = parse_url($url);
|
|
|
|
if ( false === $arrURL )
|
|
return new WP_Error('http_request_failed', sprintf(__('Malformed URL: %s'), $url));
|
|
|
|
if ( 'http' != $arrURL['scheme'] && 'https' != $arrURL['scheme'] )
|
|
$url = str_replace($arrURL['scheme'], 'http', $url);
|
|
|
|
// Convert Header array to string.
|
|
$strHeaders = '';
|
|
if ( is_array( $r['headers'] ) )
|
|
foreach( $r['headers'] as $name => $value )
|
|
$strHeaders .= "{$name}: $value\r\n";
|
|
else if ( is_string( $r['headers'] ) )
|
|
$strHeaders = $r['headers'];
|
|
|
|
$arrContext = array('http' =>
|
|
array(
|
|
'method' => strtoupper($r['method']),
|
|
'user_agent' => $r['user-agent'],
|
|
'max_redirects' => $r['redirection'],
|
|
'protocol_version' => (float) $r['httpversion'],
|
|
'header' => $strHeaders,
|
|
'timeout' => $r['timeout'],
|
|
'ssl' => array(
|
|
'verify_peer' => apply_filters('https_ssl_verify', $r['sslverify']),
|
|
'verify_host' => apply_filters('https_ssl_verify', $r['sslverify'])
|
|
)
|
|
)
|
|
);
|
|
|
|
if ( ! is_null($r['body']) && ! empty($r['body'] ) )
|
|
$arrContext['http']['content'] = $r['body'];
|
|
|
|
$context = stream_context_create($arrContext);
|
|
|
|
if ( ! defined('WP_DEBUG') || ( defined('WP_DEBUG') && false === WP_DEBUG ) )
|
|
$handle = @fopen($url, 'r', false, $context);
|
|
else
|
|
$handle = fopen($url, 'r', false, $context);
|
|
|
|
if ( ! $handle)
|
|
return new WP_Error('http_request_failed', sprintf(__('Could not open handle for fopen() to %s'), $url));
|
|
|
|
// WordPress supports PHP 4.3, which has this function. Removed sanity
|
|
// checking for performance reasons.
|
|
stream_set_timeout($handle, $r['timeout'] );
|
|
|
|
if ( ! $r['blocking'] ) {
|
|
stream_set_blocking($handle, 0);
|
|
fclose($handle);
|
|
return array( 'headers' => array(), 'body' => '', 'response' => array('code' => false, 'message' => false), 'cookies' => array() );
|
|
}
|
|
|
|
$strResponse = stream_get_contents($handle);
|
|
$meta = stream_get_meta_data($handle);
|
|
|
|
fclose($handle);
|
|
|
|
$processedHeaders = array();
|
|
if( isset( $meta['wrapper_data']['headers'] ) )
|
|
$processedHeaders = WP_Http::processHeaders($meta['wrapper_data']['headers']);
|
|
else
|
|
$processedHeaders = WP_Http::processHeaders($meta['wrapper_data']);
|
|
|
|
if ( ! empty( $strResponse ) && isset( $processedHeaders['headers']['transfer-encoding'] ) && 'chunked' == $processedHeaders['headers']['transfer-encoding'] )
|
|
$strResponse = WP_Http::chunkTransferDecode($strResponse);
|
|
|
|
if ( true === $r['decompress'] && true === WP_Http_Encoding::should_decode($processedHeaders) )
|
|
$strResponse = WP_Http_Encoding::decompress( $strResponse );
|
|
|
|
return array('headers' => $processedHeaders['headers'], 'body' => $strResponse, 'response' => $processedHeaders['response'], 'cookies' => $processedHeaders['cookies']);
|
|
}
|
|
|
|
/**
|
|
* Whether this class can be used for retrieving an URL.
|
|
*
|
|
* @static
|
|
* @access public
|
|
* @since 2.7.0
|
|
*
|
|
* @return boolean False means this class can not be used, true means it can.
|
|
*/
|
|
function test($args = array()) {
|
|
if ( ! function_exists('fopen') || (function_exists('ini_get') && true != ini_get('allow_url_fopen')) )
|
|
return false;
|
|
|
|
if ( version_compare(PHP_VERSION, '5.0', '<') )
|
|
return false;
|
|
|
|
return apply_filters('use_streams_transport', true);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* HTTP request method uses HTTP extension to retrieve the url.
|
|
*
|
|
* Requires the HTTP extension to be installed. This would be the preferred
|
|
* transport since it can handle a lot of the problems that forces the others to
|
|
* use the HTTP version 1.0. Even if PHP 5.2+ is being used, it doesn't mean
|
|
* that the HTTP extension will be enabled.
|
|
*
|
|
* @package WordPress
|
|
* @subpackage HTTP
|
|
* @since 2.7.0
|
|
*/
|
|
class WP_Http_ExtHTTP {
|
|
/**
|
|
* Send a HTTP request to a URI using HTTP extension.
|
|
*
|
|
* Does not support non-blocking.
|
|
*
|
|
* @access public
|
|
* @since 2.7
|
|
*
|
|
* @param string $url
|
|
* @param str|array $args Optional. Override the defaults.
|
|
* @return array 'headers', 'body', 'cookies' and 'response' keys.
|
|
*/
|
|
function request($url, $args = array()) {
|
|
$defaults = array(
|
|
'method' => 'GET', 'timeout' => 5,
|
|
'redirection' => 5, 'httpversion' => '1.0',
|
|
'blocking' => true,
|
|
'headers' => array(), 'body' => null, 'cookies' => array()
|
|
);
|
|
|
|
$r = wp_parse_args( $args, $defaults );
|
|
|
|
if ( isset($r['headers']['User-Agent']) ) {
|
|
$r['user-agent'] = $r['headers']['User-Agent'];
|
|
unset($r['headers']['User-Agent']);
|
|
} else if( isset($r['headers']['user-agent']) ) {
|
|
$r['user-agent'] = $r['headers']['user-agent'];
|
|
unset($r['headers']['user-agent']);
|
|
}
|
|
|
|
// Construct Cookie: header if any cookies are set
|
|
WP_Http::buildCookieHeader( $r );
|
|
|
|
switch ( $r['method'] ) {
|
|
case 'POST':
|
|
$r['method'] = HTTP_METH_POST;
|
|
break;
|
|
case 'HEAD':
|
|
$r['method'] = HTTP_METH_HEAD;
|
|
break;
|
|
case 'GET':
|
|
default:
|
|
$r['method'] = HTTP_METH_GET;
|
|
}
|
|
|
|
$arrURL = parse_url($url);
|
|
|
|
if ( 'http' != $arrURL['scheme'] || 'https' != $arrURL['scheme'] )
|
|
$url = str_replace($arrURL['scheme'], 'http', $url);
|
|
|
|
$options = array(
|
|
'timeout' => $r['timeout'],
|
|
'connecttimeout' => $r['timeout'],
|
|
'redirect' => $r['redirection'],
|
|
'useragent' => $r['user-agent'],
|
|
'headers' => $r['headers'],
|
|
'ssl' => array(
|
|
'verifypeer' => apply_filters('https_ssl_verify', $r['sslverify']),
|
|
'verifyhost' => apply_filters('https_ssl_verify', $r['sslverify'])
|
|
)
|
|
);
|
|
|
|
if ( !defined('WP_DEBUG') || ( defined('WP_DEBUG') && false === WP_DEBUG ) ) //Emits warning level notices for max redirects and timeouts
|
|
$strResponse = @http_request($r['method'], $url, $r['body'], $options, $info);
|
|
else
|
|
$strResponse = http_request($r['method'], $url, $r['body'], $options, $info); //Emits warning level notices for max redirects and timeouts
|
|
|
|
// Error may still be set, Response may return headers or partial document, and error
|
|
// contains a reason the request was aborted, eg, timeout expired or max-redirects reached.
|
|
if ( false === $strResponse || ! empty($info['error']) )
|
|
return new WP_Error('http_request_failed', $info['response_code'] . ': ' . $info['error']);
|
|
|
|
if ( ! $r['blocking'] )
|
|
return array( 'headers' => array(), 'body' => '', 'response' => array('code' => false, 'message' => false), 'cookies' => array() );
|
|
|
|
list($theHeaders, $theBody) = explode("\r\n\r\n", $strResponse, 2);
|
|
$theHeaders = WP_Http::processHeaders($theHeaders);
|
|
|
|
if ( ! empty( $theBody ) && isset( $theHeaders['headers']['transfer-encoding'] ) && 'chunked' == $theHeaders['headers']['transfer-encoding'] ) {
|
|
if ( !defined('WP_DEBUG') || ( defined('WP_DEBUG') && false === WP_DEBUG ) )
|
|
$theBody = @http_chunked_decode($theBody);
|
|
else
|
|
$theBody = http_chunked_decode($theBody);
|
|
}
|
|
|
|
if ( true === $r['decompress'] && true === WP_Http_Encoding::should_decode($theHeaders) )
|
|
$theBody = http_inflate( $theBody );
|
|
|
|
$theResponse = array();
|
|
$theResponse['code'] = $info['response_code'];
|
|
$theResponse['message'] = get_status_header_desc($info['response_code']);
|
|
|
|
return array('headers' => $theHeaders['headers'], 'body' => $theBody, 'response' => $theResponse, 'cookies' => $theHeaders['cookies']);
|
|
}
|
|
|
|
/**
|
|
* Whether this class can be used for retrieving an URL.
|
|
*
|
|
* @static
|
|
* @since 2.7.0
|
|
*
|
|
* @return boolean False means this class can not be used, true means it can.
|
|
*/
|
|
function test($args = array()) {
|
|
if ( function_exists('http_request') )
|
|
return apply_filters('use_http_extension_transport', true);
|
|
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* HTTP request method uses Curl extension to retrieve the url.
|
|
*
|
|
* Requires the Curl extension to be installed.
|
|
*
|
|
* @package WordPress
|
|
* @subpackage HTTP
|
|
* @since 2.7
|
|
*/
|
|
class WP_Http_Curl {
|
|
|
|
/**
|
|
* Send a HTTP request to a URI using cURL extension.
|
|
*
|
|
* @access public
|
|
* @since 2.7.0
|
|
*
|
|
* @param string $url
|
|
* @param str|array $args Optional. Override the defaults.
|
|
* @return array 'headers', 'body', 'cookies' and 'response' keys.
|
|
*/
|
|
function request($url, $args = array()) {
|
|
$defaults = array(
|
|
'method' => 'GET', 'timeout' => 5,
|
|
'redirection' => 5, 'httpversion' => '1.0',
|
|
'blocking' => true,
|
|
'headers' => array(), 'body' => null, 'cookies' => array()
|
|
);
|
|
|
|
$r = wp_parse_args( $args, $defaults );
|
|
|
|
if ( isset($r['headers']['User-Agent']) ) {
|
|
$r['user-agent'] = $r['headers']['User-Agent'];
|
|
unset($r['headers']['User-Agent']);
|
|
} else if( isset($r['headers']['user-agent']) ) {
|
|
$r['user-agent'] = $r['headers']['user-agent'];
|
|
unset($r['headers']['user-agent']);
|
|
}
|
|
|
|
// Construct Cookie: header if any cookies are set
|
|
WP_Http::buildCookieHeader( $r );
|
|
|
|
// cURL extension will sometimes fail when the timeout is less than 1 as
|
|
// it may round down to 0, which gives it unlimited timeout.
|
|
if ( $r['timeout'] > 0 && $r['timeout'] < 1 )
|
|
$r['timeout'] = 1;
|
|
|
|
$handle = curl_init();
|
|
|
|
curl_setopt( $handle, CURLOPT_URL, $url);
|
|
curl_setopt( $handle, CURLOPT_RETURNTRANSFER, true );
|
|
curl_setopt( $handle, CURLOPT_SSL_VERIFYHOST, apply_filters('https_ssl_verify', $r['sslverify']) );
|
|
curl_setopt( $handle, CURLOPT_SSL_VERIFYPEER, apply_filters('https_ssl_verify', $r['sslverify']) );
|
|
curl_setopt( $handle, CURLOPT_USERAGENT, $r['user-agent'] );
|
|
curl_setopt( $handle, CURLOPT_CONNECTTIMEOUT, $r['timeout'] );
|
|
curl_setopt( $handle, CURLOPT_TIMEOUT, $r['timeout'] );
|
|
curl_setopt( $handle, CURLOPT_MAXREDIRS, $r['redirection'] );
|
|
|
|
switch ( $r['method'] ) {
|
|
case 'HEAD':
|
|
curl_setopt( $handle, CURLOPT_NOBODY, true );
|
|
break;
|
|
case 'POST':
|
|
curl_setopt( $handle, CURLOPT_POST, true );
|
|
curl_setopt( $handle, CURLOPT_POSTFIELDS, $r['body'] );
|
|
break;
|
|
}
|
|
|
|
if ( true === $r['blocking'] )
|
|
curl_setopt( $handle, CURLOPT_HEADER, true );
|
|
else
|
|
curl_setopt( $handle, CURLOPT_HEADER, false );
|
|
|
|
// The option doesn't work with safe mode or when open_basedir is set.
|
|
if ( !ini_get('safe_mode') && !ini_get('open_basedir') )
|
|
curl_setopt( $handle, CURLOPT_FOLLOWLOCATION, true );
|
|
|
|
if ( !empty( $r['headers'] ) ) {
|
|
// cURL expects full header strings in each element
|
|
$headers = array();
|
|
foreach ( $r['headers'] as $name => $value ) {
|
|
$headers[] = "{$name}: $value";
|
|
}
|
|
curl_setopt( $handle, CURLOPT_HTTPHEADER, $headers );
|
|
}
|
|
|
|
if ( $r['httpversion'] == '1.0' )
|
|
curl_setopt( $handle, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0 );
|
|
else
|
|
curl_setopt( $handle, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_1 );
|
|
|
|
// Cookies are not handled by the HTTP API currently. Allow for plugin
|
|
// authors to handle it themselves... Although, it is somewhat pointless
|
|
// without some reference.
|
|
do_action_ref_array( 'http_api_curl', array(&$handle) );
|
|
|
|
// We don't need to return the body, so don't. Just execute request
|
|
// and return.
|
|
if ( ! $r['blocking'] ) {
|
|
curl_exec( $handle );
|
|
curl_close( $handle );
|
|
return array( 'headers' => array(), 'body' => '', 'response' => array('code' => false, 'message' => false), 'cookies' => array() );
|
|
}
|
|
|
|
$theResponse = curl_exec( $handle );
|
|
|
|
if ( !empty($theResponse) ) {
|
|
$headerLength = curl_getinfo($handle, CURLINFO_HEADER_SIZE);
|
|
$theHeaders = trim( substr($theResponse, 0, $headerLength) );
|
|
$theBody = substr( $theResponse, $headerLength );
|
|
if ( false !== strrpos($theHeaders, "\r\n\r\n") ) {
|
|
$headerParts = explode("\r\n\r\n", $theHeaders);
|
|
$theHeaders = $headerParts[ count($headerParts) -1 ];
|
|
}
|
|
$theHeaders = WP_Http::processHeaders($theHeaders);
|
|
} else {
|
|
if ( $curl_error = curl_error($handle) )
|
|
return new WP_Error('http_request_failed', $curl_error);
|
|
if ( in_array( curl_getinfo( $handle, CURLINFO_HTTP_CODE ), array(301, 302) ) )
|
|
return new WP_Error('http_request_failed', __('Too many redirects.'));
|
|
|
|
$theHeaders = array( 'headers' => array(), 'cookies' => array() );
|
|
$theBody = '';
|
|
}
|
|
|
|
$response = array();
|
|
$response['code'] = curl_getinfo( $handle, CURLINFO_HTTP_CODE );
|
|
$response['message'] = get_status_header_desc($response['code']);
|
|
|
|
curl_close( $handle );
|
|
|
|
if ( true === $r['decompress'] && true === WP_Http_Encoding::should_decode($theHeaders) )
|
|
$theBody = WP_Http_Encoding::decompress( $theBody );
|
|
|
|
return array('headers' => $theHeaders['headers'], 'body' => $theBody, 'response' => $response, 'cookies' => $theHeaders['cookies']);
|
|
}
|
|
|
|
/**
|
|
* Whether this class can be used for retrieving an URL.
|
|
*
|
|
* @static
|
|
* @since 2.7.0
|
|
*
|
|
* @return boolean False means this class can not be used, true means it can.
|
|
*/
|
|
function test($args = array()) {
|
|
if ( function_exists('curl_init') && function_exists('curl_exec') )
|
|
return apply_filters('use_curl_transport', true);
|
|
|
|
return false;
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Internal representation of a single cookie.
|
|
*
|
|
* Returned cookies are represented using this class, and when cookies are
|
|
* set, if they are not already a WP_Http_Cookie() object, then they are turned
|
|
* into one.
|
|
*
|
|
* @todo The WordPress convention is to use underscores instead of camelCase for function and method
|
|
* names. Need to switch to use underscores instead for the methods.
|
|
*
|
|
* @package WordPress
|
|
* @subpackage HTTP
|
|
* @since 2.8.0
|
|
* @author Beau Lebens
|
|
*/
|
|
class WP_Http_Cookie {
|
|
|
|
/**
|
|
* Cookie name.
|
|
*
|
|
* @since 2.8.0
|
|
* @var string
|
|
*/
|
|
var $name;
|
|
|
|
/**
|
|
* Cookie value.
|
|
*
|
|
* @since 2.8.0
|
|
* @var string
|
|
*/
|
|
var $value;
|
|
|
|
/**
|
|
* When the cookie expires.
|
|
*
|
|
* @since 2.8.0
|
|
* @var string
|
|
*/
|
|
var $expires;
|
|
|
|
/**
|
|
* Cookie URL path.
|
|
*
|
|
* @since 2.8.0
|
|
* @var string
|
|
*/
|
|
var $path;
|
|
|
|
/**
|
|
* Cookie Domain.
|
|
*
|
|
* @since 2.8.0
|
|
* @var string
|
|
*/
|
|
var $domain;
|
|
|
|
/**
|
|
* PHP4 style Constructor - Calls PHP5 Style Constructor.
|
|
*
|
|
* @access public
|
|
* @since 2.8.0
|
|
* @param string|array $data Raw cookie data.
|
|
*/
|
|
function WP_Http_Cookie( $data ) {
|
|
$this->__construct( $data );
|
|
}
|
|
|
|
/**
|
|
* Sets up this cookie object.
|
|
*
|
|
* The parameter $data should be either an associative array containing the indices names below
|
|
* or a header string detailing it.
|
|
*
|
|
* If it's an array, it should include the following elements:
|
|
* <ol>
|
|
* <li>Name</li>
|
|
* <li>Value - should NOT be urlencoded already.</li>
|
|
* <li>Expires - (optional) String or int (UNIX timestamp).</li>
|
|
* <li>Path (optional)</li>
|
|
* <li>Domain (optional)</li>
|
|
* </ol>
|
|
*
|
|
* @access public
|
|
* @since 2.8.0
|
|
*
|
|
* @param string|array $data Raw cookie data.
|
|
*/
|
|
function __construct( $data ) {
|
|
if ( is_string( $data ) ) {
|
|
// Assume it's a header string direct from a previous request
|
|
$pairs = explode( ';', $data );
|
|
|
|
// Special handling for first pair; name=value. Also be careful of "=" in value
|
|
$name = trim( substr( $pairs[0], 0, strpos( $pairs[0], '=' ) ) );
|
|
$value = substr( $pairs[0], strpos( $pairs[0], '=' ) + 1 );
|
|
$this->name = $name;
|
|
$this->value = urldecode( $value );
|
|
array_shift( $pairs ); //Removes name=value from items.
|
|
|
|
// Set everything else as a property
|
|
foreach ( $pairs as $pair ) {
|
|
if ( empty($pair) ) //Handles the cookie ending in ; which results in a empty final pair
|
|
continue;
|
|
|
|
list( $key, $val ) = explode( '=', $pair );
|
|
$key = strtolower( trim( $key ) );
|
|
if ( 'expires' == $key )
|
|
$val = strtotime( $val );
|
|
$this->$key = $val;
|
|
}
|
|
} else {
|
|
if ( !isset( $data['name'] ) )
|
|
return false;
|
|
|
|
// Set properties based directly on parameters
|
|
$this->name = $data['name'];
|
|
$this->value = isset( $data['value'] ) ? $data['value'] : '';
|
|
$this->path = isset( $data['path'] ) ? $data['path'] : '';
|
|
$this->domain = isset( $data['domain'] ) ? $data['domain'] : '';
|
|
|
|
if ( isset( $data['expires'] ) )
|
|
$this->expires = is_int( $data['expires'] ) ? $data['expires'] : strtotime( $data['expires'] );
|
|
else
|
|
$this->expires = null;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Confirms that it's OK to send this cookie to the URL checked against.
|
|
*
|
|
* Decision is based on RFC 2109/2965, so look there for details on validity.
|
|
*
|
|
* @access public
|
|
* @since 2.8.0
|
|
*
|
|
* @param string $url URL you intend to send this cookie to
|
|
* @return boolean TRUE if allowed, FALSE otherwise.
|
|
*/
|
|
function test( $url ) {
|
|
// Expires - if expired then nothing else matters
|
|
if ( time() > $this->expires )
|
|
return false;
|
|
|
|
// Get details on the URL we're thinking about sending to
|
|
$url = parse_url( $url );
|
|
$url['port'] = isset( $url['port'] ) ? $url['port'] : 80;
|
|
$url['path'] = isset( $url['path'] ) ? $url['path'] : '/';
|
|
|
|
// Values to use for comparison against the URL
|
|
$path = isset( $this->path ) ? $this->path : '/';
|
|
$port = isset( $this->port ) ? $this->port : 80;
|
|
$domain = isset( $this->domain ) ? strtolower( $this->domain ) : strtolower( $url['host'] );
|
|
if ( false === stripos( $domain, '.' ) )
|
|
$domain .= '.local';
|
|
|
|
// Host - very basic check that the request URL ends with the domain restriction (minus leading dot)
|
|
$domain = substr( $domain, 0, 1 ) == '.' ? substr( $domain, 1 ) : $domain;
|
|
if ( substr( $url['host'], -strlen( $domain ) ) != $domain )
|
|
return false;
|
|
|
|
// Port - supports "port-lists" in the format: "80,8000,8080"
|
|
if ( !in_array( $url['port'], explode( ',', $port) ) )
|
|
return false;
|
|
|
|
// Path - request path must start with path restriction
|
|
if ( substr( $url['path'], 0, strlen( $path ) ) != $path )
|
|
return false;
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Convert cookie name and value back to header string.
|
|
*
|
|
* @access public
|
|
* @since 2.8.0
|
|
*
|
|
* @return string Header encoded cookie name and value.
|
|
*/
|
|
function getHeaderValue() {
|
|
if ( empty( $this->name ) || empty( $this->value ) )
|
|
return '';
|
|
|
|
return $this->name . '=' . urlencode( $this->value );
|
|
}
|
|
|
|
/**
|
|
* Retrieve cookie header for usage in the rest of the WordPress HTTP API.
|
|
*
|
|
* @access public
|
|
* @since 2.8.0
|
|
*
|
|
* @return string
|
|
*/
|
|
function getFullHeader() {
|
|
return 'Cookie: ' . $this->getHeaderValue();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns the initialized WP_Http Object
|
|
*
|
|
* @since 2.7.0
|
|
* @access private
|
|
*
|
|
* @return WP_Http HTTP Transport object.
|
|
*/
|
|
function &_wp_http_get_object() {
|
|
static $http;
|
|
|
|
if ( is_null($http) )
|
|
$http = new WP_Http();
|
|
|
|
return $http;
|
|
}
|
|
|
|
/**
|
|
* Retrieve the raw response from the HTTP request.
|
|
*
|
|
* The array structure is a little complex.
|
|
*
|
|
* <code>
|
|
* $res = array( 'headers' => array(), 'response' => array('code' => int, 'message' => string) );
|
|
* </code>
|
|
*
|
|
* All of the headers in $res['headers'] are with the name as the key and the
|
|
* value as the value. So to get the User-Agent, you would do the following.
|
|
*
|
|
* <code>
|
|
* $user_agent = $res['headers']['user-agent'];
|
|
* </code>
|
|
*
|
|
* The body is the raw response content and can be retrieved from $res['body'].
|
|
*
|
|
* This function is called first to make the request and there are other API
|
|
* functions to abstract out the above convoluted setup.
|
|
*
|
|
* @since 2.7.0
|
|
*
|
|
* @param string $url Site URL to retrieve.
|
|
* @param array $args Optional. Override the defaults.
|
|
* @return WP_Error|string The body of the response or WP_Error on failure.
|
|
*/
|
|
function wp_remote_request($url, $args = array()) {
|
|
$objFetchSite = _wp_http_get_object();
|
|
return $objFetchSite->request($url, $args);
|
|
}
|
|
|
|
/**
|
|
* Retrieve the raw response from the HTTP request using the GET method.
|
|
*
|
|
* @see wp_remote_request() For more information on the response array format.
|
|
*
|
|
* @since 2.7.0
|
|
*
|
|
* @param string $url Site URL to retrieve.
|
|
* @param array $args Optional. Override the defaults.
|
|
* @return WP_Error|string The body of the response or WP_Error on failure.
|
|
*/
|
|
function wp_remote_get($url, $args = array()) {
|
|
$objFetchSite = _wp_http_get_object();
|
|
|
|
return $objFetchSite->get($url, $args);
|
|
}
|
|
|
|
/**
|
|
* Retrieve the raw response from the HTTP request using the POST method.
|
|
*
|
|
* @see wp_remote_request() For more information on the response array format.
|
|
*
|
|
* @since 2.7.0
|
|
*
|
|
* @param string $url Site URL to retrieve.
|
|
* @param array $args Optional. Override the defaults.
|
|
* @return WP_Error|string The body of the response or WP_Error on failure.
|
|
*/
|
|
function wp_remote_post($url, $args = array()) {
|
|
$objFetchSite = _wp_http_get_object();
|
|
return $objFetchSite->post($url, $args);
|
|
}
|
|
|
|
/**
|
|
* Retrieve the raw response from the HTTP request using the HEAD method.
|
|
*
|
|
* @see wp_remote_request() For more information on the response array format.
|
|
*
|
|
* @since 2.7.0
|
|
*
|
|
* @param string $url Site URL to retrieve.
|
|
* @param array $args Optional. Override the defaults.
|
|
* @return WP_Error|string The body of the response or WP_Error on failure.
|
|
*/
|
|
function wp_remote_head($url, $args = array()) {
|
|
$objFetchSite = _wp_http_get_object();
|
|
return $objFetchSite->head($url, $args);
|
|
}
|
|
|
|
/**
|
|
* Retrieve only the headers from the raw response.
|
|
*
|
|
* @since 2.7.0
|
|
*
|
|
* @param array $response HTTP response.
|
|
* @return array The headers of the response. Empty array if incorrect parameter given.
|
|
*/
|
|
function wp_remote_retrieve_headers(&$response) {
|
|
if ( ! isset($response['headers']) || ! is_array($response['headers']))
|
|
return array();
|
|
|
|
return $response['headers'];
|
|
}
|
|
|
|
/**
|
|
* Retrieve a single header by name from the raw response.
|
|
*
|
|
* @since 2.7.0
|
|
*
|
|
* @param array $response
|
|
* @param string $header Header name to retrieve value from.
|
|
* @return array The header value. Empty string on if incorrect parameter given.
|
|
*/
|
|
function wp_remote_retrieve_header(&$response, $header) {
|
|
if ( ! isset($response['headers']) || ! is_array($response['headers']))
|
|
return '';
|
|
|
|
if ( array_key_exists($header, $response['headers']) )
|
|
return $response['headers'][$header];
|
|
|
|
return '';
|
|
}
|
|
|
|
/**
|
|
* Retrieve only the response code from the raw response.
|
|
*
|
|
* Will return an empty array if incorrect parameter value is given.
|
|
*
|
|
* @since 2.7.0
|
|
*
|
|
* @param array $response HTTP response.
|
|
* @return array The keys 'code' and 'message' give information on the response.
|
|
*/
|
|
function wp_remote_retrieve_response_code(&$response) {
|
|
if ( ! isset($response['response']) || ! is_array($response['response']))
|
|
return '';
|
|
|
|
return $response['response']['code'];
|
|
}
|
|
|
|
/**
|
|
* Retrieve only the response message from the raw response.
|
|
*
|
|
* Will return an empty array if incorrect parameter value is given.
|
|
*
|
|
* @since 2.7.0
|
|
*
|
|
* @param array $response HTTP response.
|
|
* @return array The keys 'code' and 'message' give information on the response.
|
|
*/
|
|
function wp_remote_retrieve_response_message(&$response) {
|
|
if ( ! isset($response['response']) || ! is_array($response['response']))
|
|
return '';
|
|
|
|
return $response['response']['message'];
|
|
}
|
|
|
|
/**
|
|
* Retrieve only the body from the raw response.
|
|
*
|
|
* @since 2.7.0
|
|
*
|
|
* @param array $response HTTP response.
|
|
* @return string The body of the response. Empty string if no body or incorrect parameter given.
|
|
*/
|
|
function wp_remote_retrieve_body(&$response) {
|
|
if ( ! isset($response['body']) )
|
|
return '';
|
|
|
|
return $response['body'];
|
|
}
|
|
|
|
?>
|