Changeset 45135

Timestamp:

04/08/2019 05:31:35 AM (6 years ago)

Author:

pento

Message:

HTTP: Add support for the host-only flag to Wp_Http_Cookie.

Props soulseekah.
Fixes #43231.

Location:

trunk

Files:

• src/wp-includes/class-http.php (modified) (1 diff)
• src/wp-includes/class-wp-http-cookie.php (modified) (3 diffs)
• src/wp-includes/class-wp-http-requests-response.php (modified) (1 diff)
• tests/phpunit/tests/http/functions.php (modified) (1 diff)

trunk/src/wp-includes/class-http.php

@@ -450 +450 @@
         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() );
+                $cookie_jar[ $value->name ] = new Requests_Cookie( $value->name, $value->value, $value->get_attributes(), array( 'host-only' => $value->host_only ) );
             } elseif ( is_scalar( $value ) ) {
                 $cookie_jar[ $name ] = new Requests_Cookie( $name, $value );

trunk/src/wp-includes/class-wp-http-cookie.php

@@ -62 +62 @@
 
     /**
+     * host-only flag.
+     *
+     * @since 5.2.0
+     * @var bool
+     */
+    public $host_only;
+
+    /**
      * Sets up this cookie object.
      *
@@ -68 +76 @@
      *
      * @since 2.8.0
+     * @since 5.2.0 Added `host_only` to the `$data` parameter.
      *
      * @param string|array $data {
      *     Raw cookie data as header string or data array.
      *
-     *     @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 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.
      * }
      * @param string       $requested_url The URL which the cookie was set on, used for default $domain
@@ -129 +139 @@
 
             // Set properties based directly on parameters.
-            foreach ( array( 'name', 'value', 'path', 'domain', 'port' ) as $field ) {
+            foreach ( array( 'name', 'value', 'path', 'domain', 'port', 'host_only' ) as $field ) {
                 if ( isset( $data[ $field ] ) ) {
                     $this->$field = $data[ $field ];

trunk/src/wp-includes/class-wp-http-requests-response.php

@@ -165 +165 @@
             $cookies[] = new WP_Http_Cookie(
                 array(
-                    '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,
+                    '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,
                 )
             );

trunk/tests/phpunit/tests/http/functions.php

@@ -200 +200 @@
         $this->assertSame( 'foo', $cookie->value );
     }
+
+    /**
+     * @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' );
+    }
 }