From b2607f8d7887199668de8f330aed1a711d145dd6 Mon Sep 17 00:00:00 2001
From: Dominik Schilling <dominikschilling+git@gmail.com>
Date: Wed, 27 Jul 2016 15:32:27 +0000
Subject: [PATCH] HTTP API: Normalize cookies before passing them to Requests.

Requests has its own cookie object in form of `Requests_Cookie`. Therefore we have to convert `WP_Http_Cookie` objects to `Requests_Cookie`.
This introduces `WP_Http_Cookie::get_attributes()` to retrieve cookie attributes of a `WP_Http_Cookie` object and `WP_Http::normalize_cookies()` to convert the cookie objects.

Fixes #37437.
Built from https://develop.svn.wordpress.org/trunk@38164


git-svn-id: http://core.svn.wordpress.org/trunk@38105 1a063a9b-81f0-0310-95a4-ce76da25c4cd
---
 wp-includes/class-http.php                    | 38 ++++++++++++++++---
 wp-includes/class-wp-http-cookie.php          | 22 +++++++++++
 .../class-wp-http-requests-response.php       |  6 +--
 wp-includes/version.php                       |  2 +-
 4 files changed, 59 insertions(+), 9 deletions(-)

diff --git a/wp-includes/class-http.php b/wp-includes/class-http.php
index 8360abcb03..173566d464 100644
--- a/wp-includes/class-http.php
+++ b/wp-includes/class-http.php
@@ -325,9 +325,9 @@ class WP_Http {
 			$options['max_bytes'] = $r['limit_response_size'];
 		}
 
-		// If we've got cookies, use them
+		// If we've got cookies, use and convert them to Requests_Cookie.
 		if ( ! empty( $r['cookies'] ) ) {
-			$options['cookies'] = $r['cookies'];
+			$options['cookies'] = WP_Http::normalize_cookies( $r['cookies'] );
 		}
 
 		// SSL certificate handling
@@ -413,6 +413,30 @@ class WP_Http {
 		return apply_filters( 'http_response', $response, $r, $url );
 	}
 
+	/**
+	 * Normalizes cookies for using in Requests.
+	 *
+	 * @since 4.6.0
+	 * @access public
+	 * @static
+	 *
+	 * @param array $cookies List of cookies to send with the request.
+	 * @return Requests_Cookie_Jar Cookie holder object.
+	 */
+	public static function normalize_cookies( $cookies ) {
+		$cookie_jar = new Requests_Cookie_Jar();
+
+		foreach ( $cookies as $name => $value ) {
+			if ( $value instanceof WP_Http_Cookie ) {
+				$cookie_jar[ $value->name ] = new Requests_Cookie( $value->name, $value->value, $value->get_attributes() );
+			} elseif ( is_string( $value ) ) {
+				$cookie_jar[ $name ] = new Requests_Cookie( $name, $value );
+			}
+		}
+
+		return $cookie_jar;
+	}
+
 	/**
 	 * Match redirect behaviour to browser handling.
 	 *
@@ -420,9 +444,13 @@ class WP_Http {
 	 * RFC 7231, user agents can deviate from the strict reading of the
 	 * specification for compatibility purposes.
 	 *
-	 * @param string $location URL to redirect to.
-	 * @param array $headers Headers for the redirect.
-	 * @param array $options Redirect request options.
+	 * @since 4.6.0
+	 * @access public
+	 * @static
+	 *
+	 * @param string            $location URL to redirect to.
+	 * @param array             $headers  Headers for the redirect.
+	 * @param array             $options  Redirect request options.
 	 * @param Requests_Response $original Response object.
 	 */
 	public static function browser_redirect_compatibility( $location, $headers, $data, &$options, $original ) {
diff --git a/wp-includes/class-wp-http-cookie.php b/wp-includes/class-wp-http-cookie.php
index 8ae947be57..d2affc2cc1 100644
--- a/wp-includes/class-wp-http-cookie.php
+++ b/wp-includes/class-wp-http-cookie.php
@@ -216,4 +216,26 @@ class WP_Http_Cookie {
 	public function getFullHeader() {
 		return 'Cookie: ' . $this->getHeaderValue();
 	}
+
+	/**
+	 * Retrieves cookie attributes.
+	 *
+	 * @since 4.6.0
+	 * @access public
+	 *
+	 * @return array {
+	 *    List of attributes.
+	 *
+	 *    @type string $expires When the cookie expires.
+	 *    @type string $path    Cookie URL path.
+	 *    @type string $domain  Cookie domain.
+	 * }
+	 */
+	public function get_attributes() {
+		return array(
+			'expires' => $this->expires,
+			'path'    => $this->path,
+			'domain'  => $this->domain,
+		);
+	}
 }
diff --git a/wp-includes/class-wp-http-requests-response.php b/wp-includes/class-wp-http-requests-response.php
index 5ed99b3e77..ab0a5cc056 100644
--- a/wp-includes/class-wp-http-requests-response.php
+++ b/wp-includes/class-wp-http-requests-response.php
@@ -176,9 +176,9 @@ class WP_HTTP_Requests_Response extends WP_HTTP_Response {
 			$cookies[] = new WP_Http_Cookie( array(
 				'name'    => $cookie->name,
 				'value'   => urldecode( $cookie->value ),
-				'expires' => $cookie->attributes['expires'],
-				'path'    => $cookie->attributes['path'],
-				'domain'  => $cookie->attributes['domain'],
+				'expires' => isset( $cookie->attributes['expires'] ) ? $cookie->attributes['expires'] : null,
+				'path'    => isset( $cookie->attributes['path'] ) ? $cookie->attributes['path'] : null,
+				'domain'  => isset( $cookie->attributes['domain'] ) ? $cookie->attributes['domain'] : null,
 			));
 		}
 
diff --git a/wp-includes/version.php b/wp-includes/version.php
index def7000cf6..fc9b7d1d7f 100644
--- a/wp-includes/version.php
+++ b/wp-includes/version.php
@@ -4,7 +4,7 @@
  *
  * @global string $wp_version
  */
-$wp_version = '4.6-beta4-38163';
+$wp_version = '4.6-beta4-38164';
 
 /**
  * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.