wp/wp-includes/http.php
author ymh <ymh.work@gmail.com>
Wed, 06 Nov 2013 03:21:17 +0000
changeset 0 d970ebf37754
child 5 5e2f62d02dcd
permissions -rw-r--r--
first import
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     1
<?php
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     2
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     3
 * Simple and uniform HTTP request API.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     4
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     5
 * Will eventually replace and standardize the WordPress HTTP requests made.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     6
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     7
 * @link http://trac.wordpress.org/ticket/4779 HTTP API Proposal
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     8
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     9
 * @package WordPress
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    10
 * @subpackage HTTP
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    11
 * @since 2.7.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    12
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    13
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    14
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    15
 * Returns the initialized WP_Http Object
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    16
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    17
 * @since 2.7.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    18
 * @access private
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    19
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    20
 * @return WP_Http HTTP Transport object.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    21
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    22
function _wp_http_get_object() {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    23
	static $http;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    24
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    25
	if ( is_null($http) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    26
		$http = new WP_Http();
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    27
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    28
	return $http;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    29
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    30
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    31
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    32
 * Retrieve the raw response from a safe HTTP request.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    33
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    34
 * This function is ideal when the HTTP request is being made to an arbitrary
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    35
 * URL. The URL is validated to avoid redirection and request forgery attacks.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    36
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    37
 * @see wp_remote_request() For more information on the response array format
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    38
 * 	and default arguments.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    39
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    40
 * @since 3.6.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    41
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    42
 * @param string $url Site URL to retrieve.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    43
 * @param array $args Optional. Override the defaults.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    44
 * @return WP_Error|array The response or WP_Error on failure.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    45
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    46
function wp_safe_remote_request( $url, $args = array() ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    47
	$args['reject_unsafe_urls'] = true;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    48
	$http = _wp_http_get_object();
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    49
	return $http->request( $url, $args );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    50
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    51
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    52
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    53
 * Retrieve the raw response from a safe HTTP request using the GET method.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    54
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    55
 * This function is ideal when the HTTP request is being made to an arbitrary
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    56
 * URL. The URL is validated to avoid redirection and request forgery attacks.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    57
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    58
 * @see wp_remote_request() For more information on the response array format
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    59
 * 	and default arguments.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    60
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    61
 * @since 3.6.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    62
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    63
 * @param string $url Site URL to retrieve.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    64
 * @param array $args Optional. Override the defaults.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    65
 * @return WP_Error|array The response or WP_Error on failure.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    66
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    67
function wp_safe_remote_get( $url, $args = array() ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    68
	$args['reject_unsafe_urls'] = true;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    69
	$http = _wp_http_get_object();
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    70
	return $http->get( $url, $args );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    71
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    72
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    73
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    74
 * Retrieve the raw response from a safe HTTP request using the POST method.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    75
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    76
 * This function is ideal when the HTTP request is being made to an arbitrary
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    77
 * URL. The URL is validated to avoid redirection and request forgery attacks.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    78
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    79
 * @see wp_remote_request() For more information on the response array format
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    80
 * 	and default arguments.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    81
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    82
 * @since 3.6.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    83
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    84
 * @param string $url Site URL to retrieve.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    85
 * @param array $args Optional. Override the defaults.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    86
 * @return WP_Error|array The response or WP_Error on failure.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    87
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    88
function wp_safe_remote_post( $url, $args = array() ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    89
	$args['reject_unsafe_urls'] = true;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    90
	$http = _wp_http_get_object();
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    91
	return $http->post( $url, $args );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    92
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    93
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    94
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    95
 * Retrieve the raw response from a safe HTTP request using the HEAD method.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    96
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    97
 * This function is ideal when the HTTP request is being made to an arbitrary
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    98
 * URL. The URL is validated to avoid redirection and request forgery attacks.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    99
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   100
 * @see wp_remote_request() For more information on the response array format
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   101
 * 	and default arguments.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   102
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   103
 * @since 3.6.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   104
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   105
 * @param string $url Site URL to retrieve.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   106
 * @param array $args Optional. Override the defaults.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   107
 * @return WP_Error|array The response or WP_Error on failure.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   108
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   109
function wp_safe_remote_head( $url, $args = array() ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   110
	$args['reject_unsafe_urls'] = true;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   111
	$http = _wp_http_get_object();
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   112
	return $http->head( $url, $args );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   113
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   114
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   115
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   116
 * Retrieve the raw response from the HTTP request.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   117
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   118
 * The array structure is a little complex.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   119
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   120
 * <code>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   121
 * $res = array( 'headers' => array(), 'response' => array('code' => int, 'message' => string) );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   122
 * </code>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   123
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   124
 * All of the headers in $res['headers'] are with the name as the key and the
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   125
 * value as the value. So to get the User-Agent, you would do the following.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   126
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   127
 * <code>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   128
 * $user_agent = $res['headers']['user-agent'];
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   129
 * </code>
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   130
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   131
 * The body is the raw response content and can be retrieved from $res['body'].
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   132
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   133
 * This function is called first to make the request and there are other API
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   134
 * functions to abstract out the above convoluted setup.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   135
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   136
 * List of default arguments:
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   137
 * 'method'      => 'GET'
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   138
 *  - Default 'GET'  for wp_remote_get()
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   139
 *  - Default 'POST' for wp_remote_post()
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   140
 *  - Default 'HEAD' for wp_remote_head()
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   141
 * 'timeout'     => 5
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   142
 * 'redirection' => 5
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   143
 * 'httpversion' => '1.0'
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   144
 * 'user-agent'  => 'WordPress/' . $wp_version . '; ' . get_bloginfo( 'url' )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   145
 * 'blocking'    => true
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   146
 * 'headers'     => array()
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   147
 * 'cookies'     => array()
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   148
 * 'body'        => null
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   149
 * 'compress'    => false,
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   150
 * 'decompress'  => true,
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   151
 * 'sslverify'   => true,
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   152
 * 'stream'      => false,
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   153
 * 'filename'    => null
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   154
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   155
 * @since 2.7.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   156
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   157
 * @param string $url Site URL to retrieve.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   158
 * @param array $args Optional. Override the defaults.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   159
 * @return WP_Error|array The response or WP_Error on failure.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   160
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   161
function wp_remote_request($url, $args = array()) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   162
	$objFetchSite = _wp_http_get_object();
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   163
	return $objFetchSite->request($url, $args);
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   164
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   165
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   166
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   167
 * Retrieve the raw response from the HTTP request using the GET method.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   168
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   169
 * @see wp_remote_request() For more information on the response array format and default arguments.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   170
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   171
 * @since 2.7.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   172
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   173
 * @param string $url Site URL to retrieve.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   174
 * @param array $args Optional. Override the defaults.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   175
 * @return WP_Error|array The response or WP_Error on failure.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   176
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   177
function wp_remote_get($url, $args = array()) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   178
	$objFetchSite = _wp_http_get_object();
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   179
	return $objFetchSite->get($url, $args);
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   180
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   181
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   182
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   183
 * Retrieve the raw response from the HTTP request using the POST method.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   184
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   185
 * @see wp_remote_request() For more information on the response array format and default arguments.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   186
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   187
 * @since 2.7.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   188
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   189
 * @param string $url Site URL to retrieve.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   190
 * @param array $args Optional. Override the defaults.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   191
 * @return WP_Error|array The response or WP_Error on failure.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   192
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   193
function wp_remote_post($url, $args = array()) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   194
	$objFetchSite = _wp_http_get_object();
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   195
	return $objFetchSite->post($url, $args);
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   196
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   197
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   198
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   199
 * Retrieve the raw response from the HTTP request using the HEAD method.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   200
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   201
 * @see wp_remote_request() For more information on the response array format and default arguments.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   202
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   203
 * @since 2.7.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   204
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   205
 * @param string $url Site URL to retrieve.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   206
 * @param array $args Optional. Override the defaults.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   207
 * @return WP_Error|array The response or WP_Error on failure.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   208
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   209
function wp_remote_head($url, $args = array()) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   210
	$objFetchSite = _wp_http_get_object();
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   211
	return $objFetchSite->head($url, $args);
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   212
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   213
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   214
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   215
 * Retrieve only the headers from the raw response.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   216
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   217
 * @since 2.7.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   218
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   219
 * @param array $response HTTP response.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   220
 * @return array The headers of the response. Empty array if incorrect parameter given.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   221
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   222
function wp_remote_retrieve_headers(&$response) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   223
	if ( is_wp_error($response) || ! isset($response['headers']) || ! is_array($response['headers']))
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   224
		return array();
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   225
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   226
	return $response['headers'];
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   227
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   228
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   229
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   230
 * Retrieve a single header by name from the raw response.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   231
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   232
 * @since 2.7.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   233
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   234
 * @param array $response
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   235
 * @param string $header Header name to retrieve value from.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   236
 * @return string The header value. Empty string on if incorrect parameter given, or if the header doesn't exist.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   237
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   238
function wp_remote_retrieve_header(&$response, $header) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   239
	if ( is_wp_error($response) || ! isset($response['headers']) || ! is_array($response['headers']))
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   240
		return '';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   241
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   242
	if ( array_key_exists($header, $response['headers']) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   243
		return $response['headers'][$header];
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   244
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   245
	return '';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   246
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   247
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   248
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   249
 * Retrieve only the response code from the raw response.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   250
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   251
 * Will return an empty array if incorrect parameter value is given.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   252
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   253
 * @since 2.7.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   254
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   255
 * @param array $response HTTP response.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   256
 * @return string the response code. Empty string on incorrect parameter given.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   257
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   258
function wp_remote_retrieve_response_code(&$response) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   259
	if ( is_wp_error($response) || ! isset($response['response']) || ! is_array($response['response']))
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   260
		return '';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   261
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   262
	return $response['response']['code'];
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   263
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   264
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   265
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   266
 * Retrieve only the response message from the raw response.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   267
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   268
 * Will return an empty array if incorrect parameter value is given.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   269
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   270
 * @since 2.7.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   271
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   272
 * @param array $response HTTP response.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   273
 * @return string The response message. Empty string on incorrect parameter given.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   274
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   275
function wp_remote_retrieve_response_message(&$response) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   276
	if ( is_wp_error($response) || ! isset($response['response']) || ! is_array($response['response']))
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   277
		return '';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   278
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   279
	return $response['response']['message'];
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   280
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   281
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   282
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   283
 * Retrieve only the body from the raw response.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   284
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   285
 * @since 2.7.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   286
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   287
 * @param array $response HTTP response.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   288
 * @return string The body of the response. Empty string if no body or incorrect parameter given.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   289
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   290
function wp_remote_retrieve_body(&$response) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   291
	if ( is_wp_error($response) || ! isset($response['body']) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   292
		return '';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   293
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   294
	return $response['body'];
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   295
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   296
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   297
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   298
 * Determines if there is an HTTP Transport that can process this request.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   299
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   300
 * @since 3.2.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   301
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   302
 * @param array  $capabilities Array of capabilities to test or a wp_remote_request() $args array.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   303
 * @param string $url Optional. If given, will check if the URL requires SSL and adds that requirement to the capabilities array.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   304
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   305
 * @return bool
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   306
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   307
function wp_http_supports( $capabilities = array(), $url = null ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   308
	$objFetchSite = _wp_http_get_object();
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   309
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   310
	$capabilities = wp_parse_args( $capabilities );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   311
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   312
	$count = count( $capabilities );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   313
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   314
	// If we have a numeric $capabilities array, spoof a wp_remote_request() associative $args array
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   315
	if ( $count && count( array_filter( array_keys( $capabilities ), 'is_numeric' ) ) == $count ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   316
		$capabilities = array_combine( array_values( $capabilities ), array_fill( 0, $count, true ) );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   317
	}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   318
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   319
	if ( $url && !isset( $capabilities['ssl'] ) ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   320
		$scheme = parse_url( $url, PHP_URL_SCHEME );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   321
		if ( 'https' == $scheme || 'ssl' == $scheme ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   322
			$capabilities['ssl'] = true;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   323
		}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   324
	}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   325
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   326
	return (bool) $objFetchSite->_get_first_available_transport( $capabilities );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   327
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   328
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   329
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   330
 * Get the HTTP Origin of the current request.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   331
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   332
 * @since 3.4.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   333
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   334
 * @return string URL of the origin. Empty string if no origin.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   335
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   336
function get_http_origin() {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   337
	$origin = '';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   338
	if ( ! empty ( $_SERVER[ 'HTTP_ORIGIN' ] ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   339
		$origin = $_SERVER[ 'HTTP_ORIGIN' ];
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   340
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   341
	/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   342
	 * Change the origin of an HTTP request.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   343
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   344
	 * @since 3.4.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   345
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   346
	 * @param string $origin The original origin for the request.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   347
	 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   348
	return apply_filters( 'http_origin', $origin );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   349
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   350
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   351
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   352
 * Retrieve list of allowed HTTP origins.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   353
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   354
 * @since 3.4.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   355
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   356
 * @return array Array of origin URLs.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   357
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   358
function get_allowed_http_origins() {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   359
	$admin_origin = parse_url( admin_url() );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   360
	$home_origin = parse_url( home_url() );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   361
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   362
	// @todo preserve port?
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   363
	$allowed_origins = array_unique( array(
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   364
		'http://' . $admin_origin[ 'host' ],
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   365
		'https://' . $admin_origin[ 'host' ],
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   366
		'http://' . $home_origin[ 'host' ],
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   367
		'https://' . $home_origin[ 'host' ],
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   368
	) );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   369
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   370
	/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   371
	 * Change the origin types allowed for HTTP requests.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   372
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   373
	 * @since 3.4.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   374
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   375
	 * @param array $allowed_origins {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   376
	 *     Default allowed HTTP origins.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   377
	 *     @type string Non-secure URL for admin origin.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   378
	 *     @type string Secure URL for admin origin.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   379
	 *     @type string Non-secure URL for home origin.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   380
	 *     @type string Secure URL for home origin.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   381
	 * }
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   382
	 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   383
	return apply_filters( 'allowed_http_origins' , $allowed_origins );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   384
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   385
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   386
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   387
 * Determines if the HTTP origin is an authorized one.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   388
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   389
 * @since 3.4.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   390
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   391
 * @param string Origin URL. If not provided, the value of get_http_origin() is used.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   392
 * @return bool True if the origin is allowed. False otherwise.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   393
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   394
function is_allowed_http_origin( $origin = null ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   395
	$origin_arg = $origin;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   396
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   397
	if ( null === $origin )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   398
		$origin = get_http_origin();
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   399
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   400
	if ( $origin && ! in_array( $origin, get_allowed_http_origins() ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   401
		$origin = '';
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   402
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   403
	/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   404
	 * Change the allowed HTTP origin result.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   405
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   406
	 * @since 3.4.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   407
	 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   408
	 * @param string $origin Result of check for allowed origin.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   409
	 * @param string $origin_arg original origin string passed into is_allowed_http_origin function.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   410
	 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   411
	return apply_filters( 'allowed_http_origin', $origin, $origin_arg );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   412
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   413
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   414
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   415
 * Send Access-Control-Allow-Origin and related headers if the current request
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   416
 * is from an allowed origin.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   417
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   418
 * If the request is an OPTIONS request, the script exits with either access
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   419
 * control headers sent, or a 403 response if the origin is not allowed. For
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   420
 * other request methods, you will receive a return value.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   421
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   422
 * @since 3.4.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   423
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   424
 * @return bool|string Returns the origin URL if headers are sent. Returns false
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   425
 * if headers are not sent.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   426
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   427
function send_origin_headers() {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   428
	$origin = get_http_origin();
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   429
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   430
	if ( is_allowed_http_origin( $origin ) ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   431
		@header( 'Access-Control-Allow-Origin: ' .  $origin );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   432
		@header( 'Access-Control-Allow-Credentials: true' );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   433
		if ( 'OPTIONS' === $_SERVER['REQUEST_METHOD'] )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   434
			exit;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   435
		return $origin;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   436
	}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   437
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   438
	if ( 'OPTIONS' === $_SERVER['REQUEST_METHOD'] ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   439
		status_header( 403 );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   440
		exit;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   441
	}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   442
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   443
	return false;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   444
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   445
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   446
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   447
 * Validate a URL for safe use in the HTTP API.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   448
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   449
 * @since 3.5.2
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   450
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   451
 * @return mixed URL or false on failure.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   452
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   453
function wp_http_validate_url( $url ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   454
	$url = wp_kses_bad_protocol( $url, array( 'http', 'https' ) );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   455
	if ( ! $url )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   456
		return false;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   457
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   458
	$parsed_url = @parse_url( $url );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   459
	if ( ! $parsed_url || empty( $parsed_url['host'] ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   460
		return false;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   461
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   462
	if ( isset( $parsed_url['user'] ) || isset( $parsed_url['pass'] ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   463
		return false;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   464
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   465
	if ( false !== strpos( $parsed_url['host'], ':' ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   466
		return false;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   467
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   468
	$parsed_home = @parse_url( get_option( 'home' ) );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   469
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   470
	$same_host = strtolower( $parsed_home['host'] ) === strtolower( $parsed_url['host'] );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   471
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   472
	if ( ! $same_host ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   473
		$host = trim( $parsed_url['host'], '.' );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   474
		if ( preg_match( '#^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$#', $host ) ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   475
			$ip = $host;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   476
		} else {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   477
			$ip = gethostbyname( $host );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   478
			if ( $ip === $host ) // Error condition for gethostbyname()
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   479
				$ip = false;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   480
		}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   481
		if ( $ip ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   482
			$parts = array_map( 'intval', explode( '.', $ip ) );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   483
			if ( '127.0.0.1' === $ip
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   484
				|| ( 10 === $parts[0] )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   485
				|| ( 172 === $parts[0] && 16 <= $parts[1] && 31 >= $parts[1] )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   486
				|| ( 192 === $parts[0] && 168 === $parts[1] )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   487
			) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   488
				// If host appears local, reject unless specifically allowed.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   489
				/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   490
				 * Check if HTTP request is external or not.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   491
				 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   492
				 * Allows to change and allow external requests for the HTTP request.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   493
				 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   494
				 * @since 3.6.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   495
				 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   496
				 * @param bool false Whether HTTP request is external or not.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   497
				 * @param string $host IP of the requested host.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   498
				 * @param string $url URL of the requested host.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   499
				 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   500
				if ( ! apply_filters( 'http_request_host_is_external', false, $host, $url ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   501
					return false;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   502
			}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   503
		}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   504
	}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   505
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   506
	if ( empty( $parsed_url['port'] ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   507
		return $url;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   508
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   509
	$port = $parsed_url['port'];
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   510
	if ( 80 === $port || 443 === $port || 8080 === $port )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   511
		return $url;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   512
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   513
	if ( $parsed_home && $same_host && $parsed_home['port'] === $port )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   514
		return $url;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   515
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   516
	return false;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   517
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   518
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   519
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   520
 * Whitelists allowed redirect hosts for safe HTTP requests as well.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   521
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   522
 * Attached to the http_request_host_is_external filter.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   523
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   524
 * @since 3.6.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   525
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   526
 * @param bool $is_external
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   527
 * @param string $host
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   528
 * @return bool
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   529
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   530
function allowed_http_request_hosts( $is_external, $host ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   531
	if ( ! $is_external && wp_validate_redirect( 'http://' . $host ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   532
		$is_external = true;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   533
	return $is_external;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   534
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   535
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   536
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   537
 * Whitelists any domain in a multisite installation for safe HTTP requests.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   538
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   539
 * Attached to the http_request_host_is_external filter.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   540
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   541
 * @since 3.6.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   542
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   543
 * @param bool $is_external
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   544
 * @param string $host
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   545
 * @return bool
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   546
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   547
function ms_allowed_http_request_hosts( $is_external, $host ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   548
	global $wpdb, $current_site;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   549
	static $queried = array();
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   550
	if ( $is_external )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   551
		return $is_external;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   552
	if ( $host === $current_site->domain )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   553
		return true;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   554
	if ( isset( $queried[ $host ] ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   555
		return $queried[ $host ];
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   556
	$queried[ $host ] = (bool) $wpdb->get_var( $wpdb->prepare( "SELECT domain FROM $wpdb->blogs WHERE domain = %s LIMIT 1", $host ) );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   557
	return $queried[ $host ];
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   558
}