<?php
/**
- * Simple and uniform HTTP request API.
+ * Core HTTP Request API
*
- * Will eventually replace and standardize the WordPress HTTP requests made.
- *
- * @link http://trac.wordpress.org/ticket/4779 HTTP API Proposal
+ * Standardizes the HTTP requests for WordPress. Handles cookies, gzip encoding and decoding, chunk
+ * decoding, if HTTP 1.1 and various other difficult HTTP protocol implementations.
*
* @package WordPress
* @subpackage HTTP
- * @since 2.7.0
*/
/**
* @since 2.7.0
* @access private
*
+ * @staticvar WP_Http $http
+ *
* @return WP_Http HTTP Transport object.
*/
function _wp_http_get_object() {
- static $http;
+ static $http = null;
- if ( is_null($http) )
+ if ( is_null( $http ) ) {
$http = new WP_Http();
-
+ }
return $http;
}
* This function is ideal when the HTTP request is being made to an arbitrary
* URL. The URL is validated to avoid redirection and request forgery attacks.
*
- * @see wp_remote_request() For more information on the response array format
- * and default arguments.
- *
* @since 3.6.0
*
- * @param string $url Site URL to retrieve.
- * @param array $args Optional. Override the defaults.
+ * @see wp_remote_request() For more information on the response array format.
+ * @see WP_Http::request() For default arguments information.
+ *
+ * @param string $url Site URL to retrieve.
+ * @param array $args Optional. Request arguments. Default empty array.
* @return WP_Error|array The response or WP_Error on failure.
*/
function wp_safe_remote_request( $url, $args = array() ) {
* This function is ideal when the HTTP request is being made to an arbitrary
* URL. The URL is validated to avoid redirection and request forgery attacks.
*
- * @see wp_remote_request() For more information on the response array format
- * and default arguments.
- *
* @since 3.6.0
*
- * @param string $url Site URL to retrieve.
- * @param array $args Optional. Override the defaults.
+ * @see wp_remote_request() For more information on the response array format.
+ * @see WP_Http::request() For default arguments information.
+ *
+ * @param string $url Site URL to retrieve.
+ * @param array $args Optional. Request arguments. Default empty array.
* @return WP_Error|array The response or WP_Error on failure.
*/
function wp_safe_remote_get( $url, $args = array() ) {
* This function is ideal when the HTTP request is being made to an arbitrary
* URL. The URL is validated to avoid redirection and request forgery attacks.
*
- * @see wp_remote_request() For more information on the response array format
- * and default arguments.
- *
* @since 3.6.0
*
- * @param string $url Site URL to retrieve.
- * @param array $args Optional. Override the defaults.
+ * @see wp_remote_request() For more information on the response array format.
+ * @see WP_Http::request() For default arguments information.
+ *
+ * @param string $url Site URL to retrieve.
+ * @param array $args Optional. Request arguments. Default empty array.
* @return WP_Error|array The response or WP_Error on failure.
*/
function wp_safe_remote_post( $url, $args = array() ) {
* This function is ideal when the HTTP request is being made to an arbitrary
* URL. The URL is validated to avoid redirection and request forgery attacks.
*
- * @see wp_remote_request() For more information on the response array format
- * and default arguments.
- *
* @since 3.6.0
*
+ * @see wp_remote_request() For more information on the response array format.
+ * @see WP_Http::request() For default arguments information.
+ *
* @param string $url Site URL to retrieve.
- * @param array $args Optional. Override the defaults.
+ * @param array $args Optional. Request arguments. Default empty array.
* @return WP_Error|array The response or WP_Error on failure.
*/
function wp_safe_remote_head( $url, $args = array() ) {
/**
* Retrieve the raw response from the HTTP request.
*
- * The array structure is a little complex.
+ * The array structure is a little complex:
*
- * <code>
- * $res = array( 'headers' => array(), 'response' => array('code' => int, 'message' => string) );
- * </code>
+ * $res = array(
+ * 'headers' => array(),
+ * 'response' => array(
+ * 'code' => int,
+ * 'message' => string
+ * )
+ * );
*
* 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>
+ * $user_agent = $res['headers']['user-agent'];
*
* 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.
*
- * List of default arguments:
- * 'method' => 'GET'
+ * Request method defaults for helper functions:
* - Default 'GET' for wp_remote_get()
* - Default 'POST' for wp_remote_post()
* - Default 'HEAD' for wp_remote_head()
- * 'timeout' => 5
- * 'redirection' => 5
- * 'httpversion' => '1.0'
- * 'user-agent' => 'WordPress/' . $wp_version . '; ' . get_bloginfo( 'url' )
- * 'blocking' => true
- * 'headers' => array()
- * 'cookies' => array()
- * 'body' => null
- * 'compress' => false,
- * 'decompress' => true,
- * 'sslverify' => true,
- * 'stream' => false,
- * 'filename' => null
*
* @since 2.7.0
*
- * @param string $url Site URL to retrieve.
- * @param array $args Optional. Override the defaults.
+ * @see WP_Http::request() For additional information on default arguments.
+ *
+ * @param string $url Site URL to retrieve.
+ * @param array $args Optional. Request arguments. Default empty array.
* @return WP_Error|array The response or WP_Error on failure.
*/
function wp_remote_request($url, $args = array()) {
- $objFetchSite = _wp_http_get_object();
- return $objFetchSite->request($url, $args);
+ $http = _wp_http_get_object();
+ return $http->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 and default arguments.
- *
* @since 2.7.0
*
- * @param string $url Site URL to retrieve.
- * @param array $args Optional. Override the defaults.
+ * @see wp_remote_request() For more information on the response array format.
+ * @see WP_Http::request() For default arguments information.
+ *
+ * @param string $url Site URL to retrieve.
+ * @param array $args Optional. Request arguments. Default empty array.
* @return WP_Error|array The response or WP_Error on failure.
*/
function wp_remote_get($url, $args = array()) {
- $objFetchSite = _wp_http_get_object();
- return $objFetchSite->get($url, $args);
+ $http = _wp_http_get_object();
+ return $http->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 and default arguments.
- *
* @since 2.7.0
*
- * @param string $url Site URL to retrieve.
- * @param array $args Optional. Override the defaults.
+ * @see wp_remote_request() For more information on the response array format.
+ * @see WP_Http::request() For default arguments information.
+ *
+ * @param string $url Site URL to retrieve.
+ * @param array $args Optional. Request arguments. Default empty array.
* @return WP_Error|array The response or WP_Error on failure.
*/
function wp_remote_post($url, $args = array()) {
- $objFetchSite = _wp_http_get_object();
- return $objFetchSite->post($url, $args);
+ $http = _wp_http_get_object();
+ return $http->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 and default arguments.
- *
* @since 2.7.0
*
- * @param string $url Site URL to retrieve.
- * @param array $args Optional. Override the defaults.
+ * @see wp_remote_request() For more information on the response array format.
+ * @see WP_Http::request() For default arguments information.
+ *
+ * @param string $url Site URL to retrieve.
+ * @param array $args Optional. Request arguments. Default empty array.
* @return WP_Error|array The response or WP_Error on failure.
*/
function wp_remote_head($url, $args = array()) {
- $objFetchSite = _wp_http_get_object();
- return $objFetchSite->head($url, $args);
+ $http = _wp_http_get_object();
+ return $http->head( $url, $args );
}
/**
* Retrieve only the headers from the raw response.
*
* @since 2.7.0
+ * @since 4.6.0 Return value changed from an array to an Requests_Utility_CaseInsensitiveDictionary instance.
+ *
+ * @see \Requests_Utility_CaseInsensitiveDictionary
*
* @param array $response HTTP response.
- * @return array The headers of the response. Empty array if incorrect parameter given.
+ * @return array|\Requests_Utility_CaseInsensitiveDictionary The headers of the response. Empty array if incorrect parameter given.
*/
-function wp_remote_retrieve_headers(&$response) {
- if ( is_wp_error($response) || ! isset($response['headers']) || ! is_array($response['headers']))
+function wp_remote_retrieve_headers( $response ) {
+ if ( is_wp_error( $response ) || ! isset( $response['headers'] ) ) {
return array();
+ }
return $response['headers'];
}
*
* @since 2.7.0
*
- * @param array $response
+ * @param array $response
* @param string $header Header name to retrieve value from.
* @return string The header value. Empty string on if incorrect parameter given, or if the header doesn't exist.
*/
-function wp_remote_retrieve_header(&$response, $header) {
- if ( is_wp_error($response) || ! isset($response['headers']) || ! is_array($response['headers']))
+function wp_remote_retrieve_header( $response, $header ) {
+ if ( is_wp_error( $response ) || ! isset( $response['headers'] ) ) {
return '';
+ }
- if ( array_key_exists($header, $response['headers']) )
+ if ( isset( $response['headers'][ $header ] ) ) {
return $response['headers'][$header];
+ }
return '';
}
* @since 2.7.0
*
* @param array $response HTTP response.
- * @return string the response code. Empty string on incorrect parameter given.
+ * @return int|string The response code as an integer. Empty string on incorrect parameter given.
*/
-function wp_remote_retrieve_response_code(&$response) {
+function wp_remote_retrieve_response_code( $response ) {
if ( is_wp_error($response) || ! isset($response['response']) || ! is_array($response['response']))
return '';
* @param array $response HTTP response.
* @return string The response message. Empty string on incorrect parameter given.
*/
-function wp_remote_retrieve_response_message(&$response) {
+function wp_remote_retrieve_response_message( $response ) {
if ( is_wp_error($response) || ! isset($response['response']) || ! is_array($response['response']))
return '';
* @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) {
+function wp_remote_retrieve_body( $response ) {
if ( is_wp_error($response) || ! isset($response['body']) )
return '';
return $response['body'];
}
+/**
+ * Retrieve only the cookies from the raw response.
+ *
+ * @since 4.4.0
+ *
+ * @param array $response HTTP response.
+ * @return array An array of `WP_Http_Cookie` objects from the response. Empty array if there are none, or the response is a WP_Error.
+ */
+function wp_remote_retrieve_cookies( $response ) {
+ if ( is_wp_error( $response ) || empty( $response['cookies'] ) ) {
+ return array();
+ }
+
+ return $response['cookies'];
+}
+
+/**
+ * Retrieve a single cookie by name from the raw response.
+ *
+ * @since 4.4.0
+ *
+ * @param array $response HTTP response.
+ * @param string $name The name of the cookie to retrieve.
+ * @return WP_Http_Cookie|string The `WP_Http_Cookie` object. Empty string if the cookie isn't present in the response.
+ */
+function wp_remote_retrieve_cookie( $response, $name ) {
+ $cookies = wp_remote_retrieve_cookies( $response );
+
+ if ( empty( $cookies ) ) {
+ return '';
+ }
+
+ foreach ( $cookies as $cookie ) {
+ if ( $cookie->name === $name ) {
+ return $cookie;
+ }
+ }
+
+ return '';
+}
+
+/**
+ * Retrieve a single cookie's value by name from the raw response.
+ *
+ * @since 4.4.0
+ *
+ * @param array $response HTTP response.
+ * @param string $name The name of the cookie to retrieve.
+ * @return string The value of the cookie. Empty string if the cookie isn't present in the response.
+ */
+function wp_remote_retrieve_cookie_value( $response, $name ) {
+ $cookie = wp_remote_retrieve_cookie( $response, $name );
+
+ if ( ! is_a( $cookie, 'WP_Http_Cookie' ) ) {
+ return '';
+ }
+
+ return $cookie->value;
+}
+
/**
* Determines if there is an HTTP Transport that can process this request.
*
* @since 3.2.0
*
* @param array $capabilities Array of capabilities to test or a wp_remote_request() $args array.
- * @param string $url Optional. If given, will check if the URL requires SSL and adds that requirement to the capabilities array.
+ * @param string $url Optional. If given, will check if the URL requires SSL and adds
+ * that requirement to the capabilities array.
*
* @return bool
*/
function wp_http_supports( $capabilities = array(), $url = null ) {
- $objFetchSite = _wp_http_get_object();
+ $http = _wp_http_get_object();
$capabilities = wp_parse_args( $capabilities );
}
}
- return (bool) $objFetchSite->_get_first_available_transport( $capabilities );
+ return (bool) $http->_get_first_available_transport( $capabilities );
}
/**
if ( ! empty ( $_SERVER[ 'HTTP_ORIGIN' ] ) )
$origin = $_SERVER[ 'HTTP_ORIGIN' ];
+ /**
+ * Change the origin of an HTTP request.
+ *
+ * @since 3.4.0
+ *
+ * @param string $origin The original origin for the request.
+ */
return apply_filters( 'http_origin', $origin );
}
/**
- * Retrieve list of allowed http origins.
+ * Retrieve list of allowed HTTP origins.
*
* @since 3.4.0
*
'https://' . $home_origin[ 'host' ],
) );
+ /**
+ * Change the origin types allowed for HTTP requests.
+ *
+ * @since 3.4.0
+ *
+ * @param array $allowed_origins {
+ * Default allowed HTTP origins.
+ * @type string Non-secure URL for admin origin.
+ * @type string Secure URL for admin origin.
+ * @type string Non-secure URL for home origin.
+ * @type string Secure URL for home origin.
+ * }
+ */
return apply_filters( 'allowed_http_origins' , $allowed_origins );
}
/**
- * Determines if the http origin is an authorized one.
+ * Determines if the HTTP origin is an authorized one.
*
* @since 3.4.0
*
- * @param string Origin URL. If not provided, the value of get_http_origin() is used.
- * @return bool True if the origin is allowed. False otherwise.
+ * @param null|string $origin Origin URL. If not provided, the value of get_http_origin() is used.
+ * @return string Origin URL if allowed, empty string if not.
*/
function is_allowed_http_origin( $origin = null ) {
$origin_arg = $origin;
if ( $origin && ! in_array( $origin, get_allowed_http_origins() ) )
$origin = '';
+ /**
+ * Change the allowed HTTP origin result.
+ *
+ * @since 3.4.0
+ *
+ * @param string $origin Origin URL if allowed, empty string if not.
+ * @param string $origin_arg Original origin string passed into is_allowed_http_origin function.
+ */
return apply_filters( 'allowed_http_origin', $origin, $origin_arg );
}
*
* @since 3.4.0
*
- * @return bool|string Returns the origin URL if headers are sent. Returns false
- * if headers are not sent.
+ * @return string|false Returns the origin URL if headers are sent. Returns false
+ * if headers are not sent.
*/
function send_origin_headers() {
$origin = get_http_origin();
*
* @since 3.5.2
*
- * @return mixed URL or false on failure.
+ * @param string $url
+ * @return false|string URL or false on failure.
*/
function wp_http_validate_url( $url ) {
+ $original_url = $url;
$url = wp_kses_bad_protocol( $url, array( 'http', 'https' ) );
- if ( ! $url )
+ if ( ! $url || strtolower( $url ) !== strtolower( $original_url ) )
return false;
$parsed_url = @parse_url( $url );
if ( isset( $parsed_url['user'] ) || isset( $parsed_url['pass'] ) )
return false;
- if ( false !== strpos( $parsed_url['host'], ':' ) )
+ if ( false !== strpbrk( $parsed_url['host'], ':#?[]' ) )
return false;
$parsed_home = @parse_url( get_option( 'home' ) );
- $same_host = strtolower( $parsed_home['host'] ) === strtolower( $parsed_url['host'] );
+ if ( isset( $parsed_home['host'] ) ) {
+ $same_host = ( strtolower( $parsed_home['host'] ) === strtolower( $parsed_url['host'] ) || 'localhost' === strtolower( $parsed_url['host'] ) );
+ } else {
+ $same_host = false;
+ }
if ( ! $same_host ) {
$host = trim( $parsed_url['host'], '.' );
- if ( preg_match( '#^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$#', $host ) ) {
+ if ( preg_match( '#^(([1-9]?\d|1\d\d|25[0-5]|2[0-4]\d)\.){3}([1-9]?\d|1\d\d|25[0-5]|2[0-4]\d)$#', $host ) ) {
$ip = $host;
} else {
$ip = gethostbyname( $host );
}
if ( $ip ) {
$parts = array_map( 'intval', explode( '.', $ip ) );
- if ( '127.0.0.1' === $ip
- || ( 10 === $parts[0] )
+ if ( 127 === $parts[0] || 10 === $parts[0] || 0 === $parts[0]
|| ( 172 === $parts[0] && 16 <= $parts[1] && 31 >= $parts[1] )
|| ( 192 === $parts[0] && 168 === $parts[1] )
) {
// If host appears local, reject unless specifically allowed.
+ /**
+ * Check if HTTP request is external or not.
+ *
+ * Allows to change and allow external requests for the HTTP request.
+ *
+ * @since 3.6.0
+ *
+ * @param bool false Whether HTTP request is external or not.
+ * @param string $host IP of the requested host.
+ * @param string $url URL of the requested host.
+ */
if ( ! apply_filters( 'http_request_host_is_external', false, $host, $url ) )
return false;
}
if ( 80 === $port || 443 === $port || 8080 === $port )
return $url;
- if ( $parsed_home && $same_host && $parsed_home['port'] === $port )
+ if ( $parsed_home && $same_host && isset( $parsed_home['port'] ) && $parsed_home['port'] === $port )
return $url;
return false;
/**
* Whitelists allowed redirect hosts for safe HTTP requests as well.
*
- * Attached to the http_request_host_is_external filter.
+ * Attached to the {@see 'http_request_host_is_external'} filter.
*
* @since 3.6.0
*
- * @param bool $is_external
+ * @param bool $is_external
* @param string $host
* @return bool
*/
/**
* Whitelists any domain in a multisite installation for safe HTTP requests.
*
- * Attached to the http_request_host_is_external filter.
+ * Attached to the {@see 'http_request_host_is_external'} filter.
*
* @since 3.6.0
*
- * @param bool $is_external
+ * @global wpdb $wpdb WordPress database abstraction object.
+ * @staticvar array $queried
+ *
+ * @param bool $is_external
* @param string $host
* @return bool
*/
function ms_allowed_http_request_hosts( $is_external, $host ) {
- global $wpdb, $current_site;
+ global $wpdb;
static $queried = array();
if ( $is_external )
return $is_external;
- if ( $host === $current_site->domain )
+ if ( $host === get_network()->domain )
return true;
if ( isset( $queried[ $host ] ) )
return $queried[ $host ];
$queried[ $host ] = (bool) $wpdb->get_var( $wpdb->prepare( "SELECT domain FROM $wpdb->blogs WHERE domain = %s LIMIT 1", $host ) );
return $queried[ $host ];
}
+
+/**
+ * A wrapper for PHP's parse_url() function that handles consistency in the return
+ * values across PHP versions.
+ *
+ * PHP 5.4.7 expanded parse_url()'s ability to handle non-absolute url's, including
+ * schemeless and relative url's with :// in the path. This function works around
+ * those limitations providing a standard output on PHP 5.2~5.4+.
+ *
+ * Secondly, across various PHP versions, schemeless URLs starting containing a ":"
+ * in the query are being handled inconsistently. This function works around those
+ * differences as well.
+ *
+ * Error suppression is used as prior to PHP 5.3.3, an E_WARNING would be generated
+ * when URL parsing failed.
+ *
+ * @since 4.4.0
+ * @since 4.7.0 The $component parameter was added for parity with PHP's parse_url().
+ *
+ * @param string $url The URL to parse.
+ * @param int $component The specific component to retrieve. Use one of the PHP
+ * predefined constants to specify which one.
+ * Defaults to -1 (= return all parts as an array).
+ * @see http://php.net/manual/en/function.parse-url.php
+ * @return mixed False on parse failure; Array of URL components on success;
+ * When a specific component has been requested: null if the component
+ * doesn't exist in the given URL; a sting or - in the case of
+ * PHP_URL_PORT - integer when it does. See parse_url()'s return values.
+ */
+function wp_parse_url( $url, $component = -1 ) {
+ $to_unset = array();
+ $url = strval( $url );
+
+ if ( '//' === substr( $url, 0, 2 ) ) {
+ $to_unset[] = 'scheme';
+ $url = 'placeholder:' . $url;
+ } elseif ( '/' === substr( $url, 0, 1 ) ) {
+ $to_unset[] = 'scheme';
+ $to_unset[] = 'host';
+ $url = 'placeholder://placeholder' . $url;
+ }
+
+ $parts = @parse_url( $url );
+
+ if ( false === $parts ) {
+ // Parsing failure.
+ return $parts;
+ }
+
+ // Remove the placeholder values.
+ foreach ( $to_unset as $key ) {
+ unset( $parts[ $key ] );
+ }
+
+ return _get_component_from_parsed_url_array( $parts, $component );
+}
+
+/**
+ * Retrieve a specific component from a parsed URL array.
+ *
+ * @internal
+ *
+ * @since 4.7.0
+ *
+ * @param array|false $url_parts The parsed URL. Can be false if the URL failed to parse.
+ * @param int $component The specific component to retrieve. Use one of the PHP
+ * predefined constants to specify which one.
+ * Defaults to -1 (= return all parts as an array).
+ * @see http://php.net/manual/en/function.parse-url.php
+ * @return mixed False on parse failure; Array of URL components on success;
+ * When a specific component has been requested: null if the component
+ * doesn't exist in the given URL; a sting or - in the case of
+ * PHP_URL_PORT - integer when it does. See parse_url()'s return values.
+ */
+function _get_component_from_parsed_url_array( $url_parts, $component = -1 ) {
+ if ( -1 === $component ) {
+ return $url_parts;
+ }
+
+ $key = _wp_translate_php_url_constant_to_key( $component );
+ if ( false !== $key && is_array( $url_parts ) && isset( $url_parts[ $key ] ) ) {
+ return $url_parts[ $key ];
+ } else {
+ return null;
+ }
+}
+
+/**
+ * Translate a PHP_URL_* constant to the named array keys PHP uses.
+ *
+ * @internal
+ *
+ * @since 4.7.0
+ *
+ * @see http://php.net/manual/en/url.constants.php
+ *
+ * @param int $constant PHP_URL_* constant.
+ * @return string|bool The named key or false.
+ */
+function _wp_translate_php_url_constant_to_key( $constant ) {
+ $translation = array(
+ PHP_URL_SCHEME => 'scheme',
+ PHP_URL_HOST => 'host',
+ PHP_URL_PORT => 'port',
+ PHP_URL_USER => 'user',
+ PHP_URL_PASS => 'pass',
+ PHP_URL_PATH => 'path',
+ PHP_URL_QUERY => 'query',
+ PHP_URL_FRAGMENT => 'fragment',
+ );
+
+ if ( isset( $translation[ $constant ] ) ) {
+ return $translation[ $constant ];
+ } else {
+ return false;
+ }
+}
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff