Changeset 38164

Timestamp:

07/27/2016 03:31:48 PM (10 years ago)

Author:

ocean90

Message:

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.

Location:

trunk

Files:

• src/wp-includes/class-http.php (modified) (3 diffs)
• src/wp-includes/class-wp-http-cookie.php (modified) (1 diff)
• 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

@@ -326 +326 @@
                 }
 
-                // 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'] );
                 }
 
@@ -415 +415 @@
 
         /**
+         * 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.
          *
@@ -421 +445 @@
          * 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.
          */

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

@@ -217 +217 @@
                 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,
+                );
+        }
 }

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

@@ -177 +177 @@
                                 '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,
                         ));
                 }

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

@@ -108 +108 @@
         }
 
+        /**
+         * @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 );
+        }
 }