Changeset 29968

Timestamp:

10/20/2014 07:31:45 AM (10 years ago)

Author:

dd32

Message:

HTTP API: Support both the 'limit_response_size' and 'stream' parameters at the same time, allowing a partial file download.
Fixes #26726

Location:

trunk

Files:

• src/wp-includes/class-http.php (modified) (8 diffs)
• tests/phpunit/tests/http/base.php (modified) (1 diff)

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

@@ -209 +209 @@
          * and pick its name using the basename of the $url.
          */
-        if ( $r['stream']  && empty( $r['filename'] ) )
-            $r['filename'] = get_temp_dir() . basename( $url );
+        if ( $r['stream']  && empty( $r['filename'] ) ) {
+            $r['filename'] = wp_unique_filename( get_temp_dir(), basename( $url ) );
+        }
 
         /*
@@ -1097 +1098 @@
                 $this_block_size = strlen( $block );
 
-                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 ) );
+                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 );
+                }
 
                 $bytes_written_to_file = fwrite( $stream_handle, $block );
@@ -1324 +1327 @@
      */
     private $stream_handle = false;
+
+    /**
+     * The total bytes written in the current request.
+     *
+     * @since 4.1.0
+     * @access prviate
+     * @var int
+     */
+    private $bytes_written_total = 0;
 
     /**
@@ -1497 +1509 @@
         $theHeaders = WP_Http::processHeaders( $this->headers, $url );
         $theBody = $this->body;
+        $bytes_written_total = $this->bytes_written_total;
 
         $this->headers = '';
         $this->body = '';
+        $this->bytes_written_total = 0;
 
         $curl_error = curl_errno( $handle );
@@ -1505 +1519 @@
         // If an error occurred, or, no response.
         if ( $curl_error || ( 0 == strlen( $theBody ) && empty( $theHeaders['headers'] ) ) ) {
-            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.' ) );
-            }
-            if ( $curl_error = curl_error( $handle ) ) {
-                curl_close( $handle );
-                return new WP_Error( 'http_request_failed', $curl_error );
+            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 );
+                }
             }
             if ( in_array( curl_getinfo( $handle, CURLINFO_HTTP_CODE ), array( 301, 302 ) ) ) {
@@ -1562 +1579 @@
      *
      * The contents of the document are passed in chunks, so we append to the $body property for temporary storage.
-     * Returning a length shorter than the length of $data passed in will cause cURL to abort the request as "completed"
+     * Returning a length shorter than the length of $data passed in will cause cURL to abort the request with CURLE_WRITE_ERROR
      *
      * @since 3.6.0
@@ -1571 +1588 @@
         $data_length = strlen( $data );
 
-        if ( $this->max_body_length && ( strlen( $this->body ) + $data_length ) > $this->max_body_length )
-            $data = substr( $data, 0, ( $this->max_body_length - $data_length ) );
+        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 );
+        }
 
         if ( $this->stream_handle ) {
@@ -1580 +1599 @@
             $bytes_written = $data_length;
         }
+
+        $this->bytes_written_total += $bytes_written;
 
         // Upon event of this function returning less than strlen( $data ) curl will error with CURLE_WRITE_ERROR.

trunk/tests/phpunit/tests/http/base.php

@@ -185 +185 @@
         $res = wp_remote_request( $url, array( 'stream' => true, 'timeout' => 30 ) ); //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( '', $res['body'] ); // The body should be empty.
         $this->assertEquals( $size, $res['headers']['content-length'] ); // Check the headers are returned (and the size is the same..)
-        $this->assertEquals( $size, filesize($res['filename']) ); // Check that the file is written to disk correctly without any extra characters
-
-        unlink($res['filename']); // Remove the temporary file
+        $this->assertEquals( $size, $filesize ); // Check that the file is written to disk correctly without any extra characters
+    }
+
+    /**
+     * @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
+
     }