X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/4713a14935b83517997f3c88f808eb41da55033d..e0feb3b2e5b436a06bbb04fbc838d1cd6ec95399:/wp-includes/http.php?ds=sidebyside diff --git a/wp-includes/http.php b/wp-includes/http.php index 57746ff8..4768c7fd 100644 --- a/wp-includes/http.php +++ b/wp-includes/http.php @@ -4,7 +4,7 @@ * * Will eventually replace and standardize the WordPress HTTP requests made. * - * @link http://trac.wordpress.org/ticket/4779 HTTP API Proposal + * @link https://core.trac.wordpress.org/ticket/4779 HTTP API Proposal * * @package WordPress * @subpackage HTTP @@ -17,14 +17,16 @@ * @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; } @@ -34,13 +36,13 @@ function _wp_http_get_object() { * 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() ) { @@ -55,13 +57,13 @@ 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() ) { @@ -76,13 +78,13 @@ 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() ) { @@ -97,13 +99,13 @@ 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() ) { @@ -115,100 +117,93 @@ 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: * - * - * $res = array( 'headers' => array(), 'response' => array('code' => int, 'message' => string) ); - * + * $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. * - * - * $user_agent = $res['headers']['user-agent']; - * + * $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 ); } /** @@ -219,7 +214,7 @@ function wp_remote_head($url, $args = array()) { * @param array $response HTTP response. * @return array The headers of the response. Empty array if incorrect parameter given. */ -function wp_remote_retrieve_headers(&$response) { +function wp_remote_retrieve_headers( $response ) { if ( is_wp_error($response) || ! isset($response['headers']) || ! is_array($response['headers'])) return array(); @@ -231,11 +226,11 @@ function wp_remote_retrieve_headers(&$response) { * * @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) { +function wp_remote_retrieve_header( $response, $header ) { if ( is_wp_error($response) || ! isset($response['headers']) || ! is_array($response['headers'])) return ''; @@ -253,9 +248,9 @@ function wp_remote_retrieve_header(&$response, $header) { * @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 ''; @@ -272,7 +267,7 @@ function wp_remote_retrieve_response_code(&$response) { * @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 ''; @@ -287,7 +282,7 @@ function wp_remote_retrieve_response_message(&$response) { * @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 ''; @@ -300,12 +295,13 @@ function wp_remote_retrieve_body(&$response) { * @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 ); @@ -323,7 +319,7 @@ function wp_http_supports( $capabilities = array(), $url = null ) { } } - return (bool) $objFetchSite->_get_first_available_transport( $capabilities ); + return (bool) $http->_get_first_available_transport( $capabilities ); } /** @@ -388,8 +384,8 @@ function get_allowed_http_origins() { * * @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 True if the origin is allowed. False otherwise. */ function is_allowed_http_origin( $origin = null ) { $origin_arg = $origin; @@ -405,8 +401,8 @@ function is_allowed_http_origin( $origin = null ) { * * @since 3.4.0 * - * @param string $origin Result of check for allowed origin. - * @param string $origin_arg original origin string passed into is_allowed_http_origin function. + * @param string $origin Result of check for allowed origin. + * @param string $origin_arg Original origin string passed into is_allowed_http_origin function. */ return apply_filters( 'allowed_http_origin', $origin, $origin_arg ); } @@ -421,8 +417,8 @@ function is_allowed_http_origin( $origin = null ) { * * @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(); @@ -448,11 +444,13 @@ function send_origin_headers() { * * @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 ); @@ -462,7 +460,7 @@ function wp_http_validate_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' ) ); @@ -480,8 +478,7 @@ function wp_http_validate_url( $url ) { } if ( $ip ) { $parts = array_map( 'intval', explode( '.', $ip ) ); - if ( '127.0.0.1' === $ip - || ( 10 === $parts[0] ) + if ( 127 === $parts[0] || 10 === $parts[0] || ( 172 === $parts[0] && 16 <= $parts[1] && 31 >= $parts[1] ) || ( 192 === $parts[0] && 168 === $parts[1] ) ) { @@ -493,9 +490,9 @@ function wp_http_validate_url( $url ) { * * @since 3.6.0 * - * @param bool false Whether HTTP request is external or not. + * @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. + * @param string $url URL of the requested host. */ if ( ! apply_filters( 'http_request_host_is_external', false, $host, $url ) ) return false; @@ -523,7 +520,7 @@ function wp_http_validate_url( $url ) { * * @since 3.6.0 * - * @param bool $is_external + * @param bool $is_external * @param string $host * @return bool */ @@ -540,7 +537,10 @@ function allowed_http_request_hosts( $is_external, $host ) { * * @since 3.6.0 * - * @param bool $is_external + * @global wpdb $wpdb + * @staticvar array $queried + * + * @param bool $is_external * @param string $host * @return bool */