<!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>[37989] trunk: HTTP API: Switch back to returning an array.</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/37989">37989</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/37989","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>rmccue</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-07-06 17:50:44 +0000 (Wed, 06 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: Switch back to returning an array.
The array-compatibility object we started returning in <a href="https://core.trac.wordpress.org/changeset/37428">r37428</a> unfortunately isn't enough like an array. In particular, `is_array()` checks fail, despite the object implementing ArrayAccess. Mea culpa.
This moves the WP_HTTP_Response object to a new http_response key in the array, and changes the value back to an actual array.
Fixes <a href="https://core.trac.wordpress.org/ticket/37097">#37097</a>.
See <a href="https://core.trac.wordpress.org/ticket/33055">#33055</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasshttpphp">trunk/src/wp-includes/class-http.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-06 17:07:19 UTC (rev 37988)
+++ trunk/src/wp-includes/class-http.php 2016-07-06 17:50:44 UTC (rev 37989)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -348,10 +348,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $options['verify'] = apply_filters( 'https_ssl_verify', $options['verify'] );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> try {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $response = Requests::request( $url, $headers, $data, $type, $options );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $requests_response = Requests::request( $url, $headers, $data, $type, $options );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Convert the response into an array
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $response = new WP_HTTP_Requests_Response( $response, $r['filename'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $http_response = new WP_HTTP_Requests_Response( $requests_response, $r['filename'] );
+ $response = $http_response->to_array();
+
+ // Add the original object to the array.
+ $response['http_response'] = $http_response;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> catch ( Requests_Exception $e ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $response = new WP_Error( 'http_request_failed', $e->getMessage() );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -382,6 +386,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'message' => false,
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'cookies' => array(),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'http_response' => 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="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-06 17:07:19 UTC (rev 37988)
+++ trunk/src/wp-includes/class-wp-http-requests-response.php 2016-07-06 17:50:44 UTC (rev 37989)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1,13 +1,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <?php
</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">- * Wrapper object for a Requests_Response for compatibility.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Wrapper object for a Requests_Response for standardisation.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @package WordPress
</span><span class="cx" style="display: block; padding: 0 10px"> * @subpackage HTTP
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.6.0
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-class WP_HTTP_Requests_Response extends WP_HTTP_Response implements ArrayAccess {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+class WP_HTTP_Requests_Response extends WP_HTTP_Response {
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Requests Response object.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -142,88 +142,20 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Check if an ArrayAccess offset exists.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Convert the object to a WP_Http response array.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * This is for array access back-compat.
- *
- * @param string|int $key Array offset.
- * @return bool True if the offset exists, false otherwise.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return array WP_Http response array, per WP_Http::request().
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function offsetExists( $key ) {
- $allowed = array( 'headers', 'body', 'response', 'cookies', 'filename' );
- return in_array( $key, $allowed );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function to_array() {
+ return array(
+ 'headers' => $this->get_headers(),
+ 'body' => $this->get_data(),
+ 'response' => array(
+ 'code' => $this->get_status(),
+ 'message' => get_status_header_desc( $this->get_status() ),
+ ),
+ 'cookies' => $this->get_cookies(),
+ 'filename' => $this->filename,
+ );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
- /**
- * Get an ArrayAccess value.
- *
- * This is for array access back-compat.
- *
- * @param string|int $key Array offset to get.
- * @return mixed Value if the key is a valid offset, null if invalid.
- */
- public function offsetGet( $key ) {
- switch ( $key ) {
- case 'headers':
- return $this->get_headers();
-
- case 'body':
- return $this->get_data();
-
- case 'response':
- return array(
- 'code' => $this->get_status(),
- 'message' => get_status_header_desc( $this->get_status() ),
- );
-
- case 'cookies':
- return $this->get_cookies();
-
- case 'filename':
- return $this->filename;
- }
-
- return null;
- }
-
- /**
- * Set an ArrayAccess value.
- *
- * This is for array access back-compat.
- *
- * @param string|int $key Array offset to set.
- * @param mixed $value Value to set.
- */
- public function offsetSet( $key, $value ) {
- switch ( $key ) {
- case 'headers':
- $this->set_headers( $value );
- break;
-
- case 'body':
- $this->set_data( $value );
- break;
-
- case 'response':
- if ( isset( $value['code'] ) ) {
- $this->set_status( $value['code'] );
- }
- break;
-
- case 'filename':
- $this->filename = $value;
- break;
- }
- }
-
- /**
- * Unset an ArrayAccess value.
- *
- * This is for array access back-compat.
- *
- * @param string|int $key Array offset to remove.
- */
- public function offsetUnset( $key ) {
- $this->offsetSet( $key, null );
- }
</del><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-06 17:07:19 UTC (rev 37988)
+++ trunk/tests/phpunit/tests/http/functions.php 2016-07-06 17:50:44 UTC (rev 37989)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -24,6 +24,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( '200', wp_remote_retrieve_response_code( $response ) );
</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">+ /**
+ * @depends test_head_request
+ */
+ function test_returns_array() {
+ $url = 'https://asdftestblog1.files.wordpress.com/2007/09/2007-06-30-dsc_4700-1.jpg';
+ $response = wp_remote_head( $url );
+ $this->assertInternalType( 'array', $response );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> function test_head_redirect() {
</span><span class="cx" style="display: block; padding: 0 10px"> // this url will 301 redirect
</span><span class="cx" style="display: block; padding: 0 10px"> $url = 'https://asdftestblog1.wordpress.com/files/2007/09/2007-06-30-dsc_4700-1.jpg';
</span></span></pre>
</div>
</div>
</body>
</html>