<!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>[45135] trunk: HTTP: Add support for the `host-only` flag to `Wp_Http_Cookie`.</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 { white-space: pre-line; 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/45135">45135</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/45135","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>pento</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2019-04-08 05:31:35 +0000 (Mon, 08 Apr 2019)</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: Add support for the `host-only` flag to `Wp_Http_Cookie`.
Props soulseekah.
Fixes <a href="https://core.trac.wordpress.org/ticket/43231">#43231</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 2019-04-08 05:21:49 UTC (rev 45134)
+++ trunk/src/wp-includes/class-http.php 2019-04-08 05:31:35 UTC (rev 45135)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -449,7 +449,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $cookies as $name => $value ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $value instanceof WP_Http_Cookie ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $cookie_jar[ $value->name ] = new Requests_Cookie( $value->name, $value->value, $value->get_attributes() );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $cookie_jar[ $value->name ] = new Requests_Cookie( $value->name, $value->value, $value->get_attributes(), array( 'host-only' => $value->host_only ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> } elseif ( is_scalar( $value ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $cookie_jar[ $name ] = new Requests_Cookie( $name, $value );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</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 2019-04-08 05:21:49 UTC (rev 45134)
+++ trunk/src/wp-includes/class-wp-http-cookie.php 2019-04-08 05:31:35 UTC (rev 45135)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -61,6 +61,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public $domain;
</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">+ * host-only flag.
+ *
+ * @since 5.2.0
+ * @var bool
+ */
+ public $host_only;
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Sets up this cookie object.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * The parameter $data should be either an associative array containing the indices names below
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -67,16 +75,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * or a header string detailing it.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.8.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 5.2.0 Added `host_only` to the `$data` parameter.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string|array $data {
</span><span class="cx" style="display: block; padding: 0 10px"> * Raw cookie data as header string or data array.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type string $name Cookie name.
- * @type mixed $value Value. Should NOT already be urlencoded.
- * @type string|int $expires Optional. Unix timestamp or formatted date. Default null.
- * @type string $path Optional. Path. Default '/'.
- * @type string $domain Optional. Domain. Default host of parsed $requested_url.
- * @type int $port Optional. Port. Default null.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $name Cookie name.
+ * @type mixed $value Value. Should NOT already be urlencoded.
+ * @type string|int $expires Optional. Unix timestamp or formatted date. Default null.
+ * @type string $path Optional. Path. Default '/'.
+ * @type string $domain Optional. Domain. Default host of parsed $requested_url.
+ * @type int $port Optional. Port. Default null.
+ * @type bool $host_only Optional. host-only storage flag. Default true.
</ins><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $requested_url The URL which the cookie was set on, used for default $domain
</span><span class="cx" style="display: block; padding: 0 10px"> * and $port values.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -128,7 +138,7 @@
</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"> // Set properties based directly on parameters.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- foreach ( array( 'name', 'value', 'path', 'domain', 'port' ) as $field ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ foreach ( array( 'name', 'value', 'path', 'domain', 'port', 'host_only' ) as $field ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $data[ $field ] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->$field = $data[ $field ];
</span><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 2019-04-08 05:21:49 UTC (rev 45134)
+++ trunk/src/wp-includes/class-wp-http-requests-response.php 2019-04-08 05:31:35 UTC (rev 45135)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -164,11 +164,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $this->response->cookies as $cookie ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $cookies[] = new WP_Http_Cookie(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'name' => $cookie->name,
- 'value' => urldecode( $cookie->value ),
- '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,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'name' => $cookie->name,
+ 'value' => urldecode( $cookie->value ),
+ '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,
+ 'host_only' => isset( $cookie->flags['host-only'] ) ? $cookie->flags['host-only'] : 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 2019-04-08 05:21:49 UTC (rev 45134)
+++ trunk/tests/phpunit/tests/http/functions.php 2019-04-08 05:31:35 UTC (rev 45135)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -199,4 +199,29 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 'test', $cookie->name );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 'foo', $cookie->value );
</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 43231
+ */
+ function test_get_cookie_host_only() {
+ // emulate WP_Http::request() internals
+ $requests_response = new Requests_Response();
+
+ $requests_response->cookies['test'] = Requests_Cookie::parse( 'test=foo; domain=.wordpress.org' );
+
+ $requests_response->cookies['test']->flags['host-only'] = false; // https://github.com/rmccue/Requests/issues/306
+
+ $http_response = new WP_HTTP_Requests_Response( $requests_response );
+
+ $response = $http_response->to_array();
+
+ // check the host_only flag in the resulting WP_Http_Cookie
+ $cookie = wp_remote_retrieve_cookie( $response, 'test' );
+ $this->assertEquals( $cookie->domain, 'wordpress.org' );
+ $this->assertFalse( $cookie->host_only, 'host-only flag not set' );
+
+ // regurgitate (Requests_Cookie -> WP_Http_Cookie -> Requests_Cookie)
+ $cookies = WP_Http::normalize_cookies( wp_remote_retrieve_cookies( $response ) );
+ $this->assertFalse( $cookies['test']->flags['host-only'], 'host-only flag data lost' );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>