<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[38164] trunk: HTTP API: Normalize cookies before passing them to Requests.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/38164">38164</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/38164","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>ocean90</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-07-27 15:31:48 +0000 (Wed, 27 Jul 2016)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="https://core.trac.wordpress.org/ticket/37437">#37437</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasshttpphp">trunk/src/wp-includes/class-http.php</a></li>
<li><a href="#trunksrcwpincludesclasswphttpcookiephp">trunk/src/wp-includes/class-wp-http-cookie.php</a></li>
<li><a href="#trunksrcwpincludesclasswphttprequestsresponsephp">trunk/src/wp-includes/class-wp-http-requests-response.php</a></li>
<li><a href="#trunktestsphpunittestshttpfunctionsphp">trunk/tests/phpunit/tests/http/functions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasshttpphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-http.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-http.php 2016-07-27 14:54:57 UTC (rev 38163)
+++ trunk/src/wp-includes/class-http.php 2016-07-27 15:31:48 UTC (rev 38164)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -325,9 +325,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $options['max_bytes'] = $r['limit_response_size'];
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // If we've got cookies, use them
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // If we've got cookies, use and convert them to Requests_Cookie.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $r['cookies'] ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $options['cookies'] = $r['cookies'];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $options['cookies'] = WP_Http::normalize_cookies( $r['cookies'] );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // SSL certificate handling
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -414,15 +414,43 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * 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;
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Match redirect behaviour to browser handling.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Changes 302 redirects from POST to GET to match browser handling. Per
</span><span class="cx" style="display: block; padding: 0 10px"> * RFC 7231, user agents can deviate from the strict reading of the
</span><span class="cx" style="display: block; padding: 0 10px"> * specification for compatibility purposes.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $location URL to redirect to.
- * @param array $headers Headers for the redirect.
- * @param array $options Redirect request options.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @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.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param Requests_Response $original Response object.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public static function browser_redirect_compatibility( $location, $headers, $data, &$options, $original ) {
</span></span></pre></div>
<a id="trunksrcwpincludesclasswphttpcookiephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-wp-http-cookie.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-http-cookie.php 2016-07-27 14:54:57 UTC (rev 38163)
+++ trunk/src/wp-includes/class-wp-http-cookie.php 2016-07-27 15:31:48 UTC (rev 38164)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -216,4 +216,26 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public function getFullHeader() {
</span><span class="cx" style="display: block; padding: 0 10px"> return 'Cookie: ' . $this->getHeaderValue();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * 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,
+ );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunksrcwpincludesclasswphttprequestsresponsephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-wp-http-requests-response.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-http-requests-response.php 2016-07-27 14:54:57 UTC (rev 38163)
+++ trunk/src/wp-includes/class-wp-http-requests-response.php 2016-07-27 15:31:48 UTC (rev 38164)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -176,9 +176,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $cookies[] = new WP_Http_Cookie( array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'name' => $cookie->name,
</span><span class="cx" style="display: block; padding: 0 10px"> 'value' => urldecode( $cookie->value ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'expires' => $cookie->attributes['expires'],
- 'path' => $cookie->attributes['path'],
- 'domain' => $cookie->attributes['domain'],
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ '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,
</ins><span class="cx" style="display: block; padding: 0 10px"> ));
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunktestsphpunittestshttpfunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/http/functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/http/functions.php 2016-07-27 14:54:57 UTC (rev 38163)
+++ trunk/tests/phpunit/tests/http/functions.php 2016-07-27 15:31:48 UTC (rev 38164)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -107,4 +107,45 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( '', $no_cookie );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * @ticket 37437
+ */
+ function test_get_response_cookies_with_wp_http_cookie_object() {
+ $url = 'http://example.org';
+
+ $response = wp_remote_get( $url, array(
+ 'cookies' => array(
+ new WP_Http_Cookie( array( 'name' => 'test', 'value' => 'foo' ) ),
+ ),
+ ) );
+ $cookies = wp_remote_retrieve_cookies( $response );
+
+ $this->assertNotEmpty( $cookies );
+
+ $cookie = wp_remote_retrieve_cookie( $response, 'test' );
+ $this->assertInstanceOf( 'WP_Http_Cookie', $cookie );
+ $this->assertSame( 'test', $cookie->name );
+ $this->assertSame( 'foo', $cookie->value );
+ }
+
+ /**
+ * @ticket 37437
+ */
+ function test_get_response_cookies_with_name_value_array() {
+ $url = 'http://example.org';
+
+ $response = wp_remote_get( $url, array(
+ 'cookies' => array(
+ 'test' => 'foo',
+ ),
+ ) );
+ $cookies = wp_remote_retrieve_cookies( $response );
+
+ $this->assertNotEmpty( $cookies );
+
+ $cookie = wp_remote_retrieve_cookie( $response, 'test' );
+ $this->assertInstanceOf( 'WP_Http_Cookie', $cookie );
+ $this->assertSame( 'test', $cookie->name );
+ $this->assertSame( 'foo', $cookie->value );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>