This commit is contained in:
nikolark committed 2014-09-08 22:18:43 +02:00
1 parent ff5eca21d2
commit 03777ef2b0
578 files changed
+36396 -19889

No files matched your search

+236 -184
View File
@@ -28,43 +28,59 @@
class WP_Http {
/**
* Send a HTTP request to a URI.
* Send an 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.
*
* 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. 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.
*
* The 'blocking' parameter can be used to specify if the calling code requires the result of
* the HTTP request. If set to false, the request will be sent to the remote server, and
* processing returned to the calling code immediately, the caller will know if the request
* suceeded or failed, but will not receive any response from the remote server.
* Please note: The only URI that are supported in the HTTP Transport implementation
* are the HTTP and HTTPS protocols.
*
* @access public
* @since 2.7.0
*
* @param string $url URI resource.
* @param str|array $args Optional. Override the defaults.
* @return array|object Array containing 'headers', 'body', 'response', 'cookies', 'filename'. A WP_Error instance upon error
* @param string $url The request URL.
* @param string|array $args {
* Optional. Array or string of HTTP request arguments.
*
* @type string $method Request method. Accepts 'GET', 'POST', 'HEAD', or 'PUT'.
* Some transports technically allow others, but should not be
* assumed. Default 'GET'.
* @type int $timeout How long the connection should stay open in seconds. Default 5.
* @type int $redirection Number of allowed redirects. Not supported by all transports
* Default 5.
* @type string $httpversion Version of the HTTP protocol to use. Accepts '1.0' and '1.1'.
* Default '1.0'.
* @type string $user-agent User-agent value sent.
* Default WordPress/' . $wp_version . '; ' . get_bloginfo( 'url' ).
* @type bool $reject_unsafe_urls Whether to pass URLs through {@see wp_http_validate_url()}.
* Default false.
* @type bool $blocking Whether the calling code requires the result of the request.
* If set to false, the request will be sent to the remote server,
* and processing returned to the calling code immediately, the caller
* will know if the request succeeded or failed, but will not receive
* any response from the remote server. Default true.
* @type string|array $headers Array or string of headers to send with the request.
* Default empty array.
* @type array $cookies List of cookies to send with the request. Default empty array.
* @type string|array $body Body to send with the request. Default null.
* @type bool $compress Whether to compress the $body when sending the request.
* Default false.
* @type bool $decompress Whether to decompress a compressed response. If set to false and
* compressed content is returned in the response anyway, it will
* need to be separately decompressed. Default true.
* @type bool $sslverify Whether to verify SSL for the request. Default true.
* @type string sslcertificates Absolute path to an SSL certificate .crt file.
* Default ABSPATH . WPINC . '/certificates/ca-bundle.crt'.
* @type bool $stream Whether to stream to a file. If set to true and no filename was
* given, it will be droped it in the WP temp dir and its name will
* be set using the basename of the URL. Default false.
* @type string $filename Filename of the file to write to when streaming. $stream must be
* set to true. Default null.
* @type int $limit_response_size Size in bytes to limit the response to. Default null.
*
* }
* @return array|WP_Error Array containing 'headers', 'body', 'response', 'cookies', 'filename'.
* A WP_Error instance upon error.
*/
function request( $url, $args = array() ) {
public function request( $url, $args = array() ) {
global $wp_version;
$defaults = array(
@@ -139,7 +155,7 @@ class WP_Http {
* @since 2.7.0
*
* @param array $r An array of HTTP request arguments.
* @param string $url The request URI resource.
* @param string $url The request URL.
*/
$r = apply_filters( 'http_request_args', $r, $url );
@@ -157,7 +173,7 @@ class WP_Http {
*
* @param bool $preempt Whether to preempt an HTTP request return. Default false.
* @param array $r HTTP request arguments.
* @param string $url The request URI resource.
* @param string $url The request URL.
*/
$pre = apply_filters( 'pre_http_request', false, $r, $url );
if ( false !== $pre )
@@ -177,21 +193,28 @@ class WP_Http {
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
/*
* 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
*/
$r['ssl'] = $arrURL['scheme'] == 'https' || $arrURL['scheme'] == 'ssl';
// Determine if this request is to OUR install of WordPress
// Determine if this request is to OUR install of WordPress.
$homeURL = parse_url( get_bloginfo( 'url' ) );
$r['local'] = $homeURL['host'] == $arrURL['host'] || 'localhost' == $arrURL['host'];
$r['local'] = 'localhost' == $arrURL['host'] || ( isset( $homeURL['host'] ) && $homeURL['host'] == $arrURL['host'] );
unset( $homeURL );
// If we are streaming to a file but no filename was given drop it in the WP temp dir
// and pick its name using the basename of the $url
/*
* If we are streaming to a file but no filename was given drop it in the WP temp dir
* and pick its name using the basename of the $url.
*/
if ( $r['stream'] && empty( $r['filename'] ) )
$r['filename'] = get_temp_dir() . basename( $url );
// Force some settings if we are streaming to a file and check for existence and perms of destination directory
/*
* Force some settings if we are streaming to a file and check for existence and perms
* of destination directory.
*/
if ( $r['stream'] ) {
$r['blocking'] = true;
if ( ! wp_is_writable( dirname( $r['filename'] ) ) )
@@ -220,10 +243,10 @@ class WP_Http {
$r['headers']['connection'] = 'close';
}
// Construct Cookie: header if any cookies are set
// Construct Cookie: header if any cookies are set.
WP_Http::buildCookieHeader( $r );
// Avoid issues where mbstring.func_overload is enabled
// Avoid issues where mbstring.func_overload is enabled.
mbstring_binary_safe_encoding();
if ( ! isset( $r['headers']['Accept-Encoding'] ) ) {
@@ -290,11 +313,11 @@ class WP_Http {
*/
$request_order = apply_filters( 'http_api_transports', array( 'curl', 'streams' ), $args, $url );
// Loop over each transport on each HTTP request looking for one which will serve this request's needs
// Loop over each transport on each HTTP request looking for one which will serve this request's needs.
foreach ( $request_order as $transport ) {
$class = 'WP_HTTP_' . $transport;
// Check to see if this transport is a possibility, calls the transport statically
// Check to see if this transport is a possibility, calls the transport statically.
if ( !call_user_func( array( $class, 'test' ), $args, $url ) )
continue;
@@ -317,7 +340,7 @@ class WP_Http {
*
* @param string $url URL to Request
* @param array $args Request arguments
* @return array|object Array containing 'headers', 'body', 'response', 'cookies', 'filename'. A WP_Error instance upon error
* @return array|WP_Error Array containing 'headers', 'body', 'response', 'cookies', 'filename'. A WP_Error instance upon error
*/
private function _dispatch_request( $url, $args ) {
static $transports = array();
@@ -337,11 +360,11 @@ class WP_Http {
*
* @since 2.8.0
*
* @param mixed $response HTTP Response or WP_Error object.
* @param string $context Context under which the hook is fired.
* @param string $class HTTP transport used.
* @param array $args HTTP request arguments.
* @param string $url The request URL.
* @param array|WP_Error $response HTTP response or WP_Error object.
* @param string $context Context under which the hook is fired.
* @param string $class HTTP transport used.
* @param array $args HTTP request arguments.
* @param string $url The request URL.
*/
do_action( 'http_api_debug', $response, 'response', $class, $args, $url );
@@ -353,9 +376,9 @@ class WP_Http {
*
* @since 2.9.0
*
* @param array|obj $response HTTP Response.
* @param array $args HTTP request arguments.
* @param string $url The request URL.
* @param array $response HTTP response.
* @param array $args HTTP request arguments.
* @param string $url The request URL.
*/
return apply_filters( 'http_response', $response, $args, $url );
}
@@ -368,11 +391,11 @@ class WP_Http {
* @access public
* @since 2.7.0
*
* @param string $url URI resource.
* @param string $url The request URL.
* @param string|array $args Optional. Override the defaults.
* @return array|object Array containing 'headers', 'body', 'response', 'cookies', 'filename'. A WP_Error instance upon error
* @return array|WP_Error Array containing 'headers', 'body', 'response', 'cookies', 'filename'. A WP_Error instance upon error
*/
function post($url, $args = array()) {
public function post($url, $args = array()) {
$defaults = array('method' => 'POST');
$r = wp_parse_args( $args, $defaults );
return $this->request($url, $r);
@@ -386,11 +409,11 @@ class WP_Http {
* @access public
* @since 2.7.0
*
* @param string $url URI resource.
* @param str|array $args Optional. Override the defaults.
* @return array|object Array containing 'headers', 'body', 'response', 'cookies', 'filename'. A WP_Error instance upon error
* @param string $url The request URL.
* @param string|array $args Optional. Override the defaults.
* @return array|WP_Error Array containing 'headers', 'body', 'response', 'cookies', 'filename'. A WP_Error instance upon error
*/
function get($url, $args = array()) {
public function get($url, $args = array()) {
$defaults = array('method' => 'GET');
$r = wp_parse_args( $args, $defaults );
return $this->request($url, $r);
@@ -404,11 +427,11 @@ class WP_Http {
* @access public
* @since 2.7.0
*
* @param string $url URI resource.
* @param str|array $args Optional. Override the defaults.
* @return array|object Array containing 'headers', 'body', 'response', 'cookies', 'filename'. A WP_Error instance upon error
* @param string $url The request URL.
* @param string|array $args Optional. Override the defaults.
* @return array|WP_Error Array containing 'headers', 'body', 'response', 'cookies', 'filename'. A WP_Error instance upon error
*/
function head($url, $args = array()) {
public function head($url, $args = array()) {
$defaults = array('method' => 'HEAD');
$r = wp_parse_args( $args, $defaults );
return $this->request($url, $r);
@@ -446,20 +469,25 @@ class WP_Http {
* Then a numbered array is returned as the value of that header-key.
*/
public static function processHeaders( $headers, $url = '' ) {
// split headers, one per array element
// Split headers, one per array element.
if ( is_string($headers) ) {
// tolerate line terminator: CRLF = LF (RFC 2616 19.3)
// Tolerate line terminator: CRLF = LF (RFC 2616 19.3).
$headers = str_replace("\r\n", "\n", $headers);
// unfold folded header fields. LWS = [CRLF] 1*( SP | HT ) <US-ASCII SP, space (32)>, <US-ASCII HT, horizontal-tab (9)> (RFC 2616 2.2)
/*
* Unfold folded header fields. LWS = [CRLF] 1*( SP | HT ) <US-ASCII SP, space (32)>,
* <US-ASCII HT, horizontal-tab (9)> (RFC 2616 2.2).
*/
$headers = preg_replace('/\n[ \t]/', ' ', $headers);
// create the headers array
// Create the headers array.
$headers = explode("\n", $headers);
}
$response = array('code' => 0, 'message' => '');
// If a redirection has taken place, The headers for each page request may have been passed.
// In this case, determine the final HTTP header and parse from there.
/*
* If a redirection has taken place, The headers for each page request may have been passed.
* In this case, determine the final HTTP header and parse from there.
*/
for ( $i = count($headers)-1; $i >= 0; $i-- ) {
if ( !empty($headers[$i]) && false === strpos($headers[$i], ':') ) {
$headers = array_splice($headers, $i);
@@ -514,7 +542,7 @@ class WP_Http {
*/
public static function buildCookieHeader( &$r ) {
if ( ! empty($r['cookies']) ) {
// Upgrade any name => value cookie pairs to WP_HTTP_Cookie instances
// Upgrade any name => value cookie pairs to WP_HTTP_Cookie instances.
foreach ( $r['cookies'] as $name => $value ) {
if ( ! is_object( $value ) )
$r['cookies'][ $name ] = new WP_HTTP_Cookie( array( 'name' => $name, 'value' => $value ) );
@@ -550,7 +578,9 @@ class WP_Http {
return $body;
$parsed_body = '';
$body_original = $body; // We'll be altering $body, so need a backup in case of error
// We'll be altering $body, so need a backup in case of error.
$body_original = $body;
while ( true ) {
$has_chunk = (bool) preg_match( '/^([0-9a-f]+)[^\r\n]*\r\n/i', $body, $match );
@@ -560,13 +590,13 @@ class WP_Http {
$length = hexdec( $match[1] );
$chunk_length = strlen( $match[0] );
// Parse out the chunk of data
// Parse out the chunk of data.
$parsed_body .= substr( $body, $chunk_length, $length );
// Remove the chunk from the raw data
// Remove the chunk from the raw data.
$body = substr( $body, $length + $chunk_length );
// End of document
// End of the document.
if ( '0' === trim( $body ) )
return $parsed_body;
}
@@ -591,7 +621,7 @@ class WP_Http {
* @param string $uri URI of url.
* @return bool True to block, false to allow.
*/
function block_request($uri) {
public function block_request($uri) {
// We don't need to block requests, because nothing is blocked.
if ( ! defined( 'WP_HTTP_BLOCK_EXTERNAL' ) || ! WP_HTTP_BLOCK_EXTERNAL )
return false;
@@ -602,8 +632,8 @@ class WP_Http {
$home = parse_url( get_option('siteurl') );
// Don't block requests back to ourselves by default
if ( $check['host'] == 'localhost' || $check['host'] == $home['host'] ) {
// Don't block requests back to ourselves by default.
if ( 'localhost' == $check['host'] || ( isset( $home['host'] ) && $home['host'] == $check['host'] ) ) {
/**
* Filter whether to block local requests through the proxy.
*
@@ -638,11 +668,11 @@ class WP_Http {
}
static function make_absolute_url( $maybe_relative_path, $url ) {
public static function make_absolute_url( $maybe_relative_path, $url ) {
if ( empty( $url ) )
return $maybe_relative_path;
// Check for a scheme
// Check for a scheme.
if ( false !== strpos( $maybe_relative_path, '://' ) )
return $maybe_relative_path;
@@ -656,31 +686,31 @@ class WP_Http {
if ( isset( $url_parts['port'] ) )
$absolute_path .= ':' . $url_parts['port'];
// Start off with the Absolute URL path
// Start off with the Absolute URL path.
$path = ! empty( $url_parts['path'] ) ? $url_parts['path'] : '/';
// If it's a root-relative path, then great
// If it's a root-relative path, then great.
if ( ! empty( $relative_url_parts['path'] ) && '/' == $relative_url_parts['path'][0] ) {
$path = $relative_url_parts['path'];
// Else it's a relative path
// Else it's a relative path.
} elseif ( ! empty( $relative_url_parts['path'] ) ) {
// Strip off any file components from the absolute path
// Strip off any file components from the absolute path.
$path = substr( $path, 0, strrpos( $path, '/' ) + 1 );
// Build the new path
// Build the new path.
$path .= $relative_url_parts['path'];
// Strip all /path/../ out of the path
// Strip all /path/../ out of the path.
while ( strpos( $path, '../' ) > 1 ) {
$path = preg_replace( '![^/]+/\.\./!', '', $path );
}
// Strip any final leading ../ from the path
// Strip any final leading ../ from the path.
$path = preg_replace( '!^/(\.\./)+!', '', $path );
}
// Add the Query string
// Add the Query string.
if ( ! empty( $relative_url_parts['query'] ) )
$path .= '?' . $relative_url_parts['query'];
@@ -693,38 +723,38 @@ class WP_Http {
* @since 3.7.0
*
* @param string $url The URL which was requested.
* @param array $args The Arguements which were used to make the request.
* @param array $args The Arguments which were used to make the request.
* @param array $response The Response of the HTTP request.
* @return false|object False if no redirect is present, a WP_HTTP or WP_Error result otherwise.
*/
static function handle_redirects( $url, $args, $response ) {
public static function handle_redirects( $url, $args, $response ) {
// If no redirects are present, or, redirects were not requested, perform no action.
if ( ! isset( $response['headers']['location'] ) || 0 === $args['_redirection'] )
return false;
// Only perform redirections on redirection http codes
// Only perform redirections on redirection http codes.
if ( $response['response']['code'] > 399 || $response['response']['code'] < 300 )
return false;
// Don't redirect if we've run out of redirects
// Don't redirect if we've run out of redirects.
if ( $args['redirection']-- <= 0 )
return new WP_Error( 'http_request_failed', __('Too many redirects.') );
$redirect_location = $response['headers']['location'];
// If there were multiple Location headers, use the last header specified
// If there were multiple Location headers, use the last header specified.
if ( is_array( $redirect_location ) )
$redirect_location = array_pop( $redirect_location );
$redirect_location = WP_HTTP::make_absolute_url( $redirect_location, $url );
// POST requests should not POST to a redirected location
// POST requests should not POST to a redirected location.
if ( 'POST' == $args['method'] ) {
if ( in_array( $response['response']['code'], array( 302, 303 ) ) )
$args['method'] = 'GET';
}
// Include valid cookies in the redirect process
// Include valid cookies in the redirect process.
if ( ! empty( $response['cookies'] ) ) {
foreach ( $response['cookies'] as $cookie ) {
if ( $cookie->test( $redirect_location ) )
@@ -751,7 +781,7 @@ class WP_Http {
* @param string $maybe_ip A suspected IP address
* @return integer|bool Upon success, '4' or '6' to represent a IPv4 or IPv6 address, false upon failure
*/
static function is_ip_address( $maybe_ip ) {
public static function is_ip_address( $maybe_ip ) {
if ( preg_match( '/^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$/', $maybe_ip ) )
return 4;
@@ -779,11 +809,11 @@ class WP_Http_Streams {
* @since 3.7.0 Combined with the fsockopen transport and switched to stream_socket_client().
*
* @access public
* @param string $url URI resource.
* @param string $url The request URL.
* @param string|array $args Optional. Override the defaults.
* @return array 'headers', 'body', 'response', 'cookies' and 'filename' keys.
* @return array|WP_Error Array containing 'headers', 'body', 'response', 'cookies', 'filename'. A WP_Error instance upon error
*/
function request($url, $args = array()) {
public function request($url, $args = array()) {
$defaults = array(
'method' => 'GET', 'timeout' => 5,
'redirection' => 5, 'httpversion' => '1.0',
@@ -801,7 +831,7 @@ class WP_Http_Streams {
unset($r['headers']['user-agent']);
}
// Construct Cookie: header if any cookies are set
// Construct Cookie: header if any cookies are set.
WP_Http::buildCookieHeader( $r );
$arrURL = parse_url($url);
@@ -826,8 +856,11 @@ class WP_Http_Streams {
unset( $r['headers']['Host'], $r['headers']['host'] );
}
// Certain versions of PHP have issues with 'localhost' and IPv6, It attempts to connect to ::1,
// which fails when the server is not set up for it. For compatibility, always connect to the IPv4 address.
/*
* Certain versions of PHP have issues with 'localhost' and IPv6, It attempts to connect
* to ::1, which fails when the server is not set up for it. For compatibility, always
* connect to the IPv4 address.
*/
if ( 'localhost' == strtolower( $connect_host ) )
$connect_host = '127.0.0.1';
@@ -872,11 +905,14 @@ class WP_Http_Streams {
$utimeout = $timeout == $r['timeout'] ? 0 : 1000000 * $r['timeout'] % 1000000;
$connect_timeout = max( $timeout, 1 );
$connection_error = null; // Store error number
$connection_error_str = null; // Store error string
// Store error number.
$connection_error = null;
// Store error string.
$connection_error_str = null;
if ( !WP_DEBUG ) {
// In the event that the SSL connection fails, silence the many PHP Warnings
// In the event that the SSL connection fails, silence the many PHP Warnings.
if ( $secure_transport )
$error_reporting = error_reporting(0);
@@ -896,14 +932,14 @@ class WP_Http_Streams {
}
if ( false === $handle ) {
// SSL connection failed due to expired/invalid cert, or, OpenSSL configuration is broken
// SSL connection failed due to expired/invalid cert, or, OpenSSL configuration is broken.
if ( $secure_transport && 0 === $connection_error && '' === $connection_error_str )
return new WP_Error( 'http_request_failed', __( 'The SSL certificate for the host could not be verified.' ) );
return new WP_Error('http_request_failed', $connection_error . ': ' . $connection_error_str );
}
// Verify that the SSL certificate is valid for this request
// Verify that the SSL certificate is valid for this request.
if ( $secure_transport && $ssl_verify && ! $proxy->is_enabled() ) {
if ( ! self::verify_ssl_certificate( $handle, $arrURL['host'] ) )
return new WP_Error( 'http_request_failed', __( 'The SSL certificate for the host could not be verified.' ) );
@@ -959,7 +995,7 @@ class WP_Http_Streams {
if ( isset( $r['limit_response_size'] ) )
$block_size = min( $block_size, $r['limit_response_size'] );
// If streaming to a file setup the file handle
// If streaming to a file setup the file handle.
if ( $r['stream'] ) {
if ( ! WP_DEBUG )
$stream_handle = @fopen( $r['filename'], 'w+' );
@@ -1025,13 +1061,14 @@ class WP_Http_Streams {
$response = array(
'headers' => $arrHeaders['headers'],
'body' => null, // Not yet processed
// Not yet processed.
'body' => null,
'response' => $arrHeaders['response'],
'cookies' => $arrHeaders['cookies'],
'filename' => $r['filename']
);
// Handle redirects
// Handle redirects.
if ( false !== ( $redirect_response = WP_HTTP::handle_redirects( $url, $r, $response ) ) )
return $redirect_response;
@@ -1067,7 +1104,7 @@ class WP_Http_Streams {
* @param string $host The hostname being requested
* @return bool If the cerficiate presented in $stream is valid for $host
*/
static function verify_ssl_certificate( $stream, $host ) {
public static function verify_ssl_certificate( $stream, $host ) {
$context_options = stream_context_get_options( $stream );
if ( empty( $context_options['ssl']['peer_certificate'] ) )
@@ -1077,7 +1114,10 @@ class WP_Http_Streams {
if ( ! $cert )
return false;
// If the request is being made to an IP address, we'll validate against IP fields in the cert (if they exist)
/*
* If the request is being made to an IP address, we'll validate against IP fields
* in the cert (if they exist)
*/
$host_type = ( WP_HTTP::is_ip_address( $host ) ? 'ip' : 'dns' );
$certificate_hostnames = array();
@@ -1089,23 +1129,23 @@ class WP_Http_Streams {
$certificate_hostnames[] = strtolower( trim( $match_host ) );
}
} elseif ( !empty( $cert['subject']['CN'] ) ) {
// Only use the CN when the certificate includes no subjectAltName extension
// Only use the CN when the certificate includes no subjectAltName extension.
$certificate_hostnames[] = strtolower( $cert['subject']['CN'] );
}
// Exact hostname/IP matches
// Exact hostname/IP matches.
if ( in_array( strtolower( $host ), $certificate_hostnames ) )
return true;
// IP's can't be wildcards, Stop processing
// IP's can't be wildcards, Stop processing.
if ( 'ip' == $host_type )
return false;
// Test to see if the domain is at least 2 deep for wildcard support
// Test to see if the domain is at least 2 deep for wildcard support.
if ( substr_count( $host, '.' ) < 2 )
return false;
// Wildcard subdomains certs (*.example.com) are valid for a.example.com but not a.b.example.com
// Wildcard subdomains certs (*.example.com) are valid for a.example.com but not a.b.example.com.
$wildcard_host = preg_replace( '/^[^.]+\./', '*.', $host );
return in_array( strtolower( $wildcard_host ), $certificate_hostnames );
@@ -1158,7 +1198,7 @@ class WP_Http_Streams {
* @deprecated 3.7.0 Please use WP_HTTP::request() directly
*/
class WP_HTTP_Fsockopen extends WP_HTTP_Streams {
// For backwards compatibility for users who are using the class directly
// For backwards compatibility for users who are using the class directly.
}
/**
@@ -1214,11 +1254,11 @@ class WP_Http_Curl {
* @access public
* @since 2.7.0
*
* @param string $url
* @param str|array $args Optional. Override the defaults.
* @return array 'headers', 'body', 'response', 'cookies' and 'filename' keys.
* @param string $url The request URL.
* @param string|array $args Optional. Override the defaults.
* @return array|WP_Error Array containing 'headers', 'body', 'response', 'cookies', 'filename'. A WP_Error instance upon error
*/
function request($url, $args = array()) {
public function request($url, $args = array()) {
$defaults = array(
'method' => 'GET', 'timeout' => 5,
'redirection' => 5, 'httpversion' => '1.0',
@@ -1266,8 +1306,10 @@ class WP_Http_Curl {
$ssl_verify = apply_filters( 'https_ssl_verify', $ssl_verify );
}
// CURLOPT_TIMEOUT and CURLOPT_CONNECTTIMEOUT expect integers. Have to use ceil since
// a value of 0 will allow an unlimited timeout.
/*
* CURLOPT_TIMEOUT and CURLOPT_CONNECTTIMEOUT expect integers. Have to use ceil since.
* a value of 0 will allow an unlimited timeout.
*/
$timeout = (int) ceil( $r['timeout'] );
curl_setopt( $handle, CURLOPT_CONNECTTIMEOUT, $timeout );
curl_setopt( $handle, CURLOPT_TIMEOUT, $timeout );
@@ -1278,8 +1320,11 @@ class WP_Http_Curl {
curl_setopt( $handle, CURLOPT_SSL_VERIFYPEER, $ssl_verify );
curl_setopt( $handle, CURLOPT_CAINFO, $r['sslcertificates'] );
curl_setopt( $handle, CURLOPT_USERAGENT, $r['user-agent'] );
// The option doesn't work with safe mode or when open_basedir is set, and there's a
// bug #17490 with redirected POST requests, so handle redirections outside Curl.
/*
* The option doesn't work with safe mode or when open_basedir is set, and there's
* a bug #17490 with redirected POST requests, so handle redirections outside Curl.
*/
curl_setopt( $handle, CURLOPT_FOLLOWLOCATION, false );
if ( defined( 'CURLOPT_PROTOCOLS' ) ) // PHP 5.2.10 / cURL 7.19.4
curl_setopt( $handle, CURLOPT_PROTOCOLS, CURLPROTO_HTTP | CURLPROTO_HTTPS );
@@ -1315,7 +1360,7 @@ class WP_Http_Curl {
else
$this->max_body_length = false;
// If streaming to a file open a file handle, and setup our curl streaming handler
// If streaming to a file open a file handle, and setup our curl streaming handler.
if ( $r['stream'] ) {
if ( ! WP_DEBUG )
$this->stream_handle = @fopen( $r['filename'], 'w+' );
@@ -1328,7 +1373,7 @@ class WP_Http_Curl {
}
if ( !empty( $r['headers'] ) ) {
// cURL expects full header strings in each element
// cURL expects full header strings in each element.
$headers = array();
foreach ( $r['headers'] as $name => $value ) {
$headers[] = "{$name}: $value";
@@ -1351,7 +1396,7 @@ class WP_Http_Curl {
*
* @param resource &$handle The cURL handle returned by curl_init().
* @param array $r The HTTP request arguments.
* @param string $url The destination URL.
* @param string $url The request URL.
*/
do_action_ref_array( 'http_api_curl', array( &$handle, $r, $url ) );
@@ -1372,7 +1417,7 @@ class WP_Http_Curl {
return array( 'headers' => array(), 'body' => '', 'response' => array('code' => false, 'message' => false), 'cookies' => array() );
}
$theResponse = curl_exec( $handle );
curl_exec( $handle );
$theHeaders = WP_Http::processHeaders( $this->headers, $url );
$theBody = $this->body;
@@ -1381,7 +1426,7 @@ class WP_Http_Curl {
$curl_error = curl_errno( $handle );
// If an error occured, or, no response
// If an error occurred, or, no response.
if ( $curl_error || ( 0 == strlen( $theBody ) && empty( $theHeaders['headers'] ) ) ) {
if ( CURLE_WRITE_ERROR /* 23 */ == $curl_error && $r['stream'] ) {
fclose( $this->stream_handle );
@@ -1414,7 +1459,7 @@ class WP_Http_Curl {
'filename' => $r['filename']
);
// Handle redirects
// Handle redirects.
if ( false !== ( $redirect_response = WP_HTTP::handle_redirects( $url, $r, $response ) ) )
return $redirect_response;
@@ -1463,7 +1508,7 @@ class WP_Http_Curl {
$bytes_written = $data_length;
}
// Upon event of this function returning less than strlen( $data ) curl will error with CURLE_WRITE_ERROR
// Upon event of this function returning less than strlen( $data ) curl will error with CURLE_WRITE_ERROR.
return $bytes_written;
}
@@ -1483,7 +1528,8 @@ class WP_Http_Curl {
if ( $is_ssl ) {
$curl_version = curl_version();
if ( ! (CURL_VERSION_SSL & $curl_version['features']) ) // Does this cURL version support SSL requests?
// Check whether this cURL version support SSL requests.
if ( ! (CURL_VERSION_SSL & $curl_version['features']) )
return false;
}
@@ -1543,7 +1589,7 @@ class WP_HTTP_Proxy {
*
* @return bool
*/
function is_enabled() {
public function is_enabled() {
return defined('WP_PROXY_HOST') && defined('WP_PROXY_PORT');
}
@@ -1557,7 +1603,7 @@ class WP_HTTP_Proxy {
*
* @return bool
*/
function use_authentication() {
public function use_authentication() {
return defined('WP_PROXY_USERNAME') && defined('WP_PROXY_PASSWORD');
}
@@ -1568,7 +1614,7 @@ class WP_HTTP_Proxy {
*
* @return string
*/
function host() {
public function host() {
if ( defined('WP_PROXY_HOST') )
return WP_PROXY_HOST;
@@ -1582,7 +1628,7 @@ class WP_HTTP_Proxy {
*
* @return string
*/
function port() {
public function port() {
if ( defined('WP_PROXY_PORT') )
return WP_PROXY_PORT;
@@ -1596,7 +1642,7 @@ class WP_HTTP_Proxy {
*
* @return string
*/
function username() {
public function username() {
if ( defined('WP_PROXY_USERNAME') )
return WP_PROXY_USERNAME;
@@ -1610,7 +1656,7 @@ class WP_HTTP_Proxy {
*
* @return string
*/
function password() {
public function password() {
if ( defined('WP_PROXY_PASSWORD') )
return WP_PROXY_PASSWORD;
@@ -1624,7 +1670,7 @@ class WP_HTTP_Proxy {
*
* @return string
*/
function authentication() {
public function authentication() {
return $this->username() . ':' . $this->password();
}
@@ -1635,7 +1681,7 @@ class WP_HTTP_Proxy {
*
* @return string
*/
function authentication_header() {
public function authentication_header() {
return 'Proxy-Authorization: Basic ' . base64_encode( $this->authentication() );
}
@@ -1652,9 +1698,11 @@ class WP_HTTP_Proxy {
* @param string $uri URI to check.
* @return bool True, to send through the proxy and false if, the proxy should not be used.
*/
function send_through_proxy( $uri ) {
// 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.
public function send_through_proxy( $uri ) {
/*
* 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.
@@ -1680,7 +1728,7 @@ class WP_HTTP_Proxy {
if ( ! is_null( $result ) )
return $result;
if ( $check['host'] == 'localhost' || $check['host'] == $home['host'] )
if ( 'localhost' == $check['host'] || ( isset( $home['host'] ) && $home['host'] == $check['host'] ) )
return false;
if ( !defined('WP_PROXY_BYPASS_HOSTS') )
@@ -1726,7 +1774,7 @@ class WP_Http_Cookie {
* @since 2.8.0
* @var string
*/
var $name;
public $name;
/**
* Cookie value.
@@ -1734,7 +1782,7 @@ class WP_Http_Cookie {
* @since 2.8.0
* @var string
*/
var $value;
public $value;
/**
* When the cookie expires.
@@ -1742,7 +1790,7 @@ class WP_Http_Cookie {
* @since 2.8.0
* @var string
*/
var $expires;
public $expires;
/**
* Cookie URL path.
@@ -1750,7 +1798,7 @@ class WP_Http_Cookie {
* @since 2.8.0
* @var string
*/
var $path;
public $path;
/**
* Cookie Domain.
@@ -1758,7 +1806,7 @@ class WP_Http_Cookie {
* @since 2.8.0
* @var string
*/
var $domain;
public $domain;
/**
* Sets up this cookie object.
@@ -1766,23 +1814,23 @@ class WP_Http_Cookie {
* 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>
* <li>Port (optional)</li>
* </ol>
*
* @access public
* @since 2.8.0
* @access public
*
* @param string|array $data Raw cookie data.
* @param string $requested_url The URL which the cookie was set on, used for default 'domain' and 'port' values
* @param string|array $data {
* Raw cookie data as header string or data array.
*
* @type string $name Cookie name.
* @type mixed $value Value. Should NOT already be urlencoded.
* @type string|int $expires Optional. Unix timestamp or formatted date. Default null.
* @type string $path Optional. Path. Default '/'.
* @type string $domain Optional. Domain. Default host of parsed $requested_url.
* @type int $port Optional. Port. Default null.
* }
* @param string $requested_url The URL which the cookie was set on, used for default $domain
* and $port values.
*/
function __construct( $data, $requested_url = '' ) {
public function __construct( $data, $requested_url = '' ) {
if ( $requested_url )
$arrURL = @parse_url( $requested_url );
if ( isset( $arrURL['host'] ) )
@@ -1792,20 +1840,24 @@ class WP_Http_Cookie {
$this->path = dirname( $this->path ) . '/';
if ( is_string( $data ) ) {
// Assume it's a header string direct from a previous request
// 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
// 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
// Removes name=value from items.
array_shift( $pairs );
// Set everything else as a property.
foreach ( $pairs as $pair ) {
$pair = rtrim($pair);
if ( empty($pair) ) //Handles the cookie ending in ; which results in a empty final pair
// Handle the cookie ending in ; which results in a empty final pair.
if ( empty($pair) )
continue;
list( $key, $val ) = strpos( $pair, '=' ) ? explode( '=', $pair ) : array( $pair, '' );
@@ -1818,7 +1870,7 @@ class WP_Http_Cookie {
if ( !isset( $data['name'] ) )
return false;
// Set properties based directly on parameters
// Set properties based directly on parameters.
foreach ( array( 'name', 'value', 'path', 'domain', 'port' ) as $field ) {
if ( isset( $data[ $field ] ) )
$this->$field = $data[ $field ];
@@ -1842,36 +1894,36 @@ class WP_Http_Cookie {
* @param string $url URL you intend to send this cookie to
* @return boolean true if allowed, false otherwise.
*/
function test( $url ) {
public function test( $url ) {
if ( is_null( $this->name ) )
return false;
// Expires - if expired then nothing else matters
// Expires - if expired then nothing else matters.
if ( isset( $this->expires ) && time() > $this->expires )
return false;
// Get details on the URL we're thinking about sending to
// Get details on the URL we're thinking about sending to.
$url = parse_url( $url );
$url['port'] = isset( $url['port'] ) ? $url['port'] : ( 'https' == $url['scheme'] ? 443 : 80 );
$url['path'] = isset( $url['path'] ) ? $url['path'] : '/';
// Values to use for comparison against the URL
// Values to use for comparison against the URL.
$path = isset( $this->path ) ? $this->path : '/';
$port = isset( $this->port ) ? $this->port : null;
$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)
// 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"
// Port - supports "port-lists" in the format: "80,8000,8080".
if ( !empty( $port ) && !in_array( $url['port'], explode( ',', $port) ) )
return false;
// Path - request path must start with path restriction
// Path - request path must start with path restriction.
if ( substr( $url['path'], 0, strlen( $path ) ) != $path )
return false;
@@ -1886,7 +1938,7 @@ class WP_Http_Cookie {
*
* @return string Header encoded cookie name and value.
*/
function getHeaderValue() {
public function getHeaderValue() {
if ( ! isset( $this->name ) || ! isset( $this->value ) )
return '';
@@ -1909,7 +1961,7 @@ class WP_Http_Cookie {
*
* @return string
*/
function getFullHeader() {
public function getFullHeader() {
return 'Cookie: ' . $this->getHeaderValue();
}
}
@@ -2001,7 +2053,7 @@ class WP_Http_Encoding {
*/
public static function compatible_gzinflate($gzData) {
// Compressed data might contain a full header, if so strip it for gzinflate()
// Compressed data might contain a full header, if so strip it for gzinflate().
if ( substr($gzData, 0, 3) == "\x1f\x8b\x08" ) {
$i = 10;
$flg = ord( substr($gzData, 3, 1) );
@@ -2041,11 +2093,11 @@ class WP_Http_Encoding {
$type = array();
$compression_enabled = WP_Http_Encoding::is_available();
if ( ! $args['decompress'] ) // decompression specifically disabled
if ( ! $args['decompress'] ) // Decompression specifically disabled.
$compression_enabled = false;
elseif ( $args['stream'] ) // disable when streaming to file
elseif ( $args['stream'] ) // Disable when streaming to file.
$compression_enabled = false;
elseif ( isset( $args['limit_response_size'] ) ) // If only partial content is being requested, we won't be able to decompress it
elseif ( isset( $args['limit_response_size'] ) ) // If only partial content is being requested, we won't be able to decompress it.
$compression_enabled = false;
if ( $compression_enabled ) {