WordPress 4.4
[autoinstalls/wordpress.git] / wp-includes / http.php
index 4768c7fdd7c1a709dabca9eb2acb289b682b47ec..8fa00e942fc140346b07304d34e68b07df13a084 100644 (file)
@@ -1,14 +1,12 @@
 <?php
 /**
- * Simple and uniform HTTP request API.
+ * Core HTTP Request API
  *
- * Will eventually replace and standardize the WordPress HTTP requests made.
- *
- * @link https://core.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
  */
 
 /**
@@ -289,6 +287,66 @@ function wp_remote_retrieve_body( $response ) {
        return $response['body'];
 }
 
+/**
+ * Retrieve only the body 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.
  *
@@ -537,7 +595,7 @@ function allowed_http_request_hosts( $is_external, $host ) {
  *
  * @since 3.6.0
  *
- * @global wpdb $wpdb
+ * @global wpdb $wpdb WordPress database abstraction object.
  * @staticvar array $queried
  *
  * @param bool   $is_external
@@ -556,3 +614,49 @@ function ms_allowed_http_request_hosts( $is_external, $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 edgecases in < PHP 5.4.7
+ *
+ * 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 works around those
+ * limitations providing a standard output on PHP 5.2~5.4+.
+ *
+ * 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
+ *
+ * @param string $url The URL to parse.
+ * @return bool|array False on failure; Array of URL components on success;
+ *                    See parse_url()'s return values.
+ */
+function wp_parse_url( $url ) {
+       $parts = @parse_url( $url );
+       if ( ! $parts ) {
+               // < PHP 5.4.7 compat, trouble with relative paths including a scheme break in the path
+               if ( '/' == $url[0] && false !== strpos( $url, '://' ) ) {
+                       // Since we know it's a relative path, prefix with a scheme/host placeholder and try again
+                       if ( ! $parts = @parse_url( 'placeholder://placeholder' . $url ) ) {
+                               return $parts;
+                       }
+                       // Remove the placeholder values
+                       unset( $parts['scheme'], $parts['host'] );
+               } else {
+                       return $parts;
+               }
+       }
+
+       // < PHP 5.4.7 compat, doesn't detect schemeless URL's host field
+       if ( '//' == substr( $url, 0, 2 ) && ! isset( $parts['host'] ) ) {
+               $path_parts = explode( '/', substr( $parts['path'], 2 ), 2 );
+               $parts['host'] = $path_parts[0];
+               if ( isset( $path_parts[1] ) ) {
+                       $parts['path'] = '/' . $path_parts[1];
+               } else {
+                       unset( $parts['path'] );
+               }
+       }
+
+       return $parts;
+}