<!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>[29968] trunk: HTTP API: Support both the 'limit_response_size' and 'stream' parameters at the same time, allowing a partial file download.</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/29968">29968</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/29968","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>dd32</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2014-10-20 07:31:45 +0000 (Mon, 20 Oct 2014)</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: Support both the 'limit_response_size' and 'stream' parameters at the same time, allowing a partial file download.
Fixes <a href="https://core.trac.wordpress.org/ticket/26726">#26726</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasshttpphp">trunk/src/wp-includes/class-http.php</a></li>
<li><a href="#trunktestsphpunittestshttpbasephp">trunk/tests/phpunit/tests/http/base.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 2014-10-19 21:23:32 UTC (rev 29967)
+++ trunk/src/wp-includes/class-http.php 2014-10-20 07:31:45 UTC (rev 29968)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -208,8 +208,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * If we are streaming to a file but no filename was given drop it in the WP temp dir
</span><span class="cx" style="display: block; padding: 0 10px"> * and pick its name using the basename of the $url.
</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 ( $r['stream'] && empty( $r['filename'] ) )
- $r['filename'] = get_temp_dir() . basename( $url );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $r['stream'] && empty( $r['filename'] ) ) {
+ $r['filename'] = wp_unique_filename( get_temp_dir(), basename( $url ) );
+ }
</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"> * Force some settings if we are streaming to a file and check for existence and perms
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1096,8 +1097,10 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this_block_size = strlen( $block );
</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 ( isset( $r['limit_response_size'] ) && ( $bytes_written + $this_block_size ) > $r['limit_response_size'] )
- $block = substr( $block, 0, ( $r['limit_response_size'] - $bytes_written ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( isset( $r['limit_response_size'] ) && ( $bytes_written + $this_block_size ) > $r['limit_response_size'] ) {
+ $this_block_size = ( $r['limit_response_size'] - $bytes_written );
+ $block = substr( $block, 0, $this_block_size );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $bytes_written_to_file = fwrite( $stream_handle, $block );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1325,6 +1328,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> private $stream_handle = false;
</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">+ * The total bytes written in the current request.
+ *
+ * @since 4.1.0
+ * @access prviate
+ * @var int
+ */
+ private $bytes_written_total = 0;
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Send a HTTP request to a URI using cURL extension.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @access public
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1496,22 +1508,27 @@
</span><span class="cx" style="display: block; padding: 0 10px"> curl_exec( $handle );
</span><span class="cx" style="display: block; padding: 0 10px"> $theHeaders = WP_Http::processHeaders( $this->headers, $url );
</span><span class="cx" style="display: block; padding: 0 10px"> $theBody = $this->body;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $bytes_written_total = $this->bytes_written_total;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->headers = '';
</span><span class="cx" style="display: block; padding: 0 10px"> $this->body = '';
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->bytes_written_total = 0;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $curl_error = curl_errno( $handle );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // If an error occurred, or, no response.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $curl_error || ( 0 == strlen( $theBody ) && empty( $theHeaders['headers'] ) ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( CURLE_WRITE_ERROR /* 23 */ == $curl_error && $r['stream'] ) {
- fclose( $this->stream_handle );
- return new WP_Error( 'http_request_failed', __( 'Failed to write request to temporary file.' ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( CURLE_WRITE_ERROR /* 23 */ == $curl_error && $r['stream'] ) {
+ if ( ! $this->max_body_length || $this->max_body_length != $bytes_written_total ) {
+ fclose( $this->stream_handle );
+ return new WP_Error( 'http_request_failed', __( 'Failed to write request to temporary file.' ) );
+ }
+ } else {
+ if ( $curl_error = curl_error( $handle ) ) {
+ curl_close( $handle );
+ return new WP_Error( 'http_request_failed', $curl_error );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $curl_error = curl_error( $handle ) ) {
- curl_close( $handle );
- return new WP_Error( 'http_request_failed', $curl_error );
- }
</del><span class="cx" style="display: block; padding: 0 10px"> if ( in_array( curl_getinfo( $handle, CURLINFO_HTTP_CODE ), array( 301, 302 ) ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> curl_close( $handle );
</span><span class="cx" style="display: block; padding: 0 10px"> return new WP_Error( 'http_request_failed', __( 'Too many redirects.' ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1561,7 +1578,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Grab the body of the cURL request
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * The contents of the document are passed in chunks, so we append to the $body property for temporary storage.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Returning a length shorter than the length of $data passed in will cause cURL to abort the request as "completed"
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Returning a length shorter than the length of $data passed in will cause cURL to abort the request with CURLE_WRITE_ERROR
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.6.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @access private
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1570,8 +1587,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> private function stream_body( $handle, $data ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $data_length = strlen( $data );
</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 ( $this->max_body_length && ( strlen( $this->body ) + $data_length ) > $this->max_body_length )
- $data = substr( $data, 0, ( $this->max_body_length - $data_length ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $this->max_body_length && ( $this->bytes_written_total + $data_length ) > $this->max_body_length ) {
+ $data_length = ( $this->max_body_length - $this->bytes_written_total );
+ $data = substr( $data, 0, $data_length );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $this->stream_handle ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $bytes_written = fwrite( $this->stream_handle, $data );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1580,6 +1599,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $bytes_written = $data_length;
</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">+ $this->bytes_written_total += $bytes_written;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Upon event of this function returning less than strlen( $data ) curl will error with CURLE_WRITE_ERROR.
</span><span class="cx" style="display: block; padding: 0 10px"> return $bytes_written;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestshttpbasephp"></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/base.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/http/base.php 2014-10-19 21:23:32 UTC (rev 29967)
+++ trunk/tests/phpunit/tests/http/base.php 2014-10-20 07:31:45 UTC (rev 29968)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -184,12 +184,35 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $size = 87348;
</span><span class="cx" style="display: block; padding: 0 10px"> $res = wp_remote_request( $url, array( 'stream' => true, 'timeout' => 30 ) ); //Auto generate the filename.
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Cleanup before we assert, as it'll return early.
+ if ( ! is_wp_error( $res ) ) {
+ $filesize = filesize( $res['filename'] );
+ unlink( $res['filename'] );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertFalse( is_wp_error( $res ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( '', $res['body'] ); // The body should be empty.
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $size, $res['headers']['content-length'] ); // Check the headers are returned (and the size is the same..)
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertEquals( $size, filesize($res['filename']) ); // Check that the file is written to disk correctly without any extra characters
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertEquals( $size, $filesize ); // Check that the file is written to disk correctly without any extra characters
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- unlink($res['filename']); // Remove the temporary file
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * @ticket 26726
+ */
+ function test_file_stream_limited_size() {
+ $url = 'http://unit-tests.svn.wordpress.org/trunk/data/images/2004-07-22-DSC_0007.jpg'; // we'll test against a file in the unit test data
+ $size = 10000;
+ $res = wp_remote_request( $url, array( 'stream' => true, 'timeout' => 30, 'limit_response_size' => $size ) ); //Auto generate the filename.
+
+ // Cleanup before we assert, as it'll return early.
+ if ( ! is_wp_error( $res ) ) {
+ $filesize = filesize( $res['filename'] );
+ unlink( $res['filename'] );
+ }
+
+ $this->assertFalse( is_wp_error( $res ) );
+ $this->assertEquals( $size, $filesize ); // Check that the file is written to disk correctly without any extra characters
+
</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>
</div>
</body>
</html>