Changeset 50842 for trunk/src/wp-includes/Requests/Transport/cURL.php

Timestamp:

05/11/2021 07:40:41 PM (5 years ago)

Author:

desrosj

Message:

External Libraries: Update the Requests library to version 1.8.0.

While some of the changes in the 1.8.0 release have already been copied to WordPress Core in earlier releases (see [38727], [46258], [47902] and [49382]), this release contains additional improvements, including:

• A significant performance fix when using cURL.
• Improved compliance with RFC2616.

The library has also been moved under the WordPress project’s GitHub organization and can now be found at ​https://github.com/WordPress/Requests.

Props jrf, dd32, rmccue, justinahinon, netweb, schlessera, TimothyBJacobs, soulseekah, ozh, skithund, carlalexander, travisnorthcutt, desrosj.
Fixes #53101.

File:

• trunk/src/wp-includes/Requests/Transport/cURL.php (modified) (21 diffs)

trunk/src/wp-includes/Requests/Transport/cURL.php

@@ -39 +39 @@
 
         /**
-         * Version string
-         *
-         * @var long
+         * cURL version number
+         *
+         * @var int
          */
         public $version;
@@ -91 +91 @@
          */
         public function __construct() {
-                $curl = curl_version();
+                $curl          = curl_version();
                 $this->version = $curl['version_number'];
-                $this->handle = curl_init();
+                $this->handle  = curl_init();
 
                 curl_setopt($this->handle, CURLOPT_HEADER, false);
@@ -101 +101 @@
                 }
                 if (defined('CURLOPT_PROTOCOLS')) {
+                        // phpcs:ignore PHPCompatibility.Constants.NewConstants.curlopt_protocolsFound
                         curl_setopt($this->handle, CURLOPT_PROTOCOLS, CURLPROTO_HTTP | CURLPROTO_HTTPS);
                 }
                 if (defined('CURLOPT_REDIR_PROTOCOLS')) {
+                        // phpcs:ignore PHPCompatibility.Constants.NewConstants.curlopt_redir_protocolsFound
                         curl_setopt($this->handle, CURLOPT_REDIR_PROTOCOLS, CURLPROTO_HTTP | CURLPROTO_HTTPS);
                 }
@@ -139 +141 @@
                 }
 
-                $this->response_data = '';
-                $this->response_bytes = 0;
+                $this->response_data       = '';
+                $this->response_bytes      = 0;
                 $this->response_byte_limit = false;
                 if ($options['max_bytes'] !== false) {
@@ -169 +171 @@
                         curl_setopt($this->handle, CURLOPT_ENCODING, 'none');
 
-                        $this->response_data = '';
+                        $this->response_data  = '';
                         $this->response_bytes = 0;
                         curl_exec($this->handle);
@@ -200 +202 @@
                 $multihandle = curl_multi_init();
                 $subrequests = array();
-                $subhandles = array();
+                $subhandles  = array();
 
                 $class = get_class($this);
                 foreach ($requests as $id => $request) {
                         $subrequests[$id] = new $class();
-                        $subhandles[$id] = $subrequests[$id]->get_subrequest_handle($request['url'], $request['headers'], $request['data'], $request['options']);
+                        $subhandles[$id]  = $subrequests[$id]->get_subrequest_handle($request['url'], $request['headers'], $request['data'], $request['options']);
                         $request['options']['hooks']->dispatch('curl.before_multi_add', array(&$subhandles[$id]));
                         curl_multi_add_handle($multihandle, $subhandles[$id]);
                 }
 
-                $completed = 0;
-                $responses = array();
+                $completed       = 0;
+                $responses       = array();
+                $subrequestcount = count($subrequests);
 
                 $request['options']['hooks']->dispatch('curl.before_multi_exec', array(&$multihandle));
 
                 do {
-                        $active = false;
+                        $active = 0;
 
                         do {
@@ -236 +239 @@
                         foreach ($to_process as $key => $done) {
                                 $options = $requests[$key]['options'];
-                                if (CURLE_OK !== $done['result']) {
+                                if ($done['result'] !== CURLE_OK) {
                                         //get error string for handle.
-                                        $reason = curl_error($done['handle']);
-                                        $exception = new Requests_Exception_Transport_cURL(
-                                                                        $reason,
-                                                                        Requests_Exception_Transport_cURL::EASY,
-                                                                        $done['handle'],
-                                                                        $done['result']
-                                                                );
+                                        $reason          = curl_error($done['handle']);
+                                        $exception       = new Requests_Exception_Transport_cURL(
+                                                $reason,
+                                                Requests_Exception_Transport_cURL::EASY,
+                                                $done['handle'],
+                                                $done['result']
+                                        );
                                         $responses[$key] = $exception;
                                         $options['hooks']->dispatch('transport.internal.parse_error', array(&$responses[$key], $requests[$key]));
@@ -263 +266 @@
                         }
                 }
-                while ($active || $completed < count($subrequests));
+                while ($active || $completed < $subrequestcount);
 
                 $request['options']['hooks']->dispatch('curl.after_multi_exec', array(&$multihandle));
@@ -288 +291 @@
                 }
 
-                $this->response_data = '';
-                $this->response_bytes = 0;
+                $this->response_data       = '';
+                $this->response_bytes      = 0;
                 $this->response_byte_limit = false;
                 if ($options['max_bytes'] !== false) {
@@ -311 +314 @@
 
                 // Force closing the connection for old versions of cURL (<7.22).
-                if ( ! isset( $headers['Connection'] ) ) {
+                if (!isset($headers['Connection'])) {
                         $headers['Connection'] = 'close';
+                }
+
+                /**
+                 * Add "Expect" header.
+                 *
+                 * By default, cURL adds a "Expect: 100-Continue" to most requests. This header can
+                 * add as much as a second to the time it takes for cURL to perform a request. To
+                 * prevent this, we need to set an empty "Expect" header. To match the behaviour of
+                 * Guzzle, we'll add the empty header to requests that are smaller than 1 MB and use
+                 * HTTP/1.1.
+                 *
+                 * https://curl.se/mail/lib-2017-07/0013.html
+                 */
+                if (!isset($headers['Expect']) && $options['protocol_version'] === 1.1) {
+                        $headers['Expect'] = $this->get_expect_header($data);
                 }
 
@@ -321 +339 @@
 
                         if ($data_format === 'query') {
-                                $url = self::format_get($url, $data);
+                                $url  = self::format_get($url, $data);
                                 $data = '';
                         }
@@ -364 +382 @@
                 }
                 else {
+                        // phpcs:ignore PHPCompatibility.Constants.NewConstants.curlopt_timeout_msFound
                         curl_setopt($this->handle, CURLOPT_TIMEOUT_MS, round($timeout * 1000));
                 }
@@ -371 +390 @@
                 }
                 else {
+                        // phpcs:ignore PHPCompatibility.Constants.NewConstants.curlopt_connecttimeout_msFound
                         curl_setopt($this->handle, CURLOPT_CONNECTTIMEOUT_MS, round($options['connect_timeout'] * 1000));
                 }
@@ -386 +406 @@
                 }
 
-                if (true === $options['blocking']) {
-                        curl_setopt($this->handle, CURLOPT_HEADERFUNCTION, array(&$this, 'stream_headers'));
-                        curl_setopt($this->handle, CURLOPT_WRITEFUNCTION, array(&$this, 'stream_body'));
+                if ($options['blocking'] === true) {
+                        curl_setopt($this->handle, CURLOPT_HEADERFUNCTION, array($this, 'stream_headers'));
+                        curl_setopt($this->handle, CURLOPT_WRITEFUNCTION, array($this, 'stream_body'));
                         curl_setopt($this->handle, CURLOPT_BUFFERSIZE, Requests::BUFFER_SIZE);
                 }
@@ -398 +418 @@
          * @param string $response Response data from the body
          * @param array $options Request options
-         * @return string HTTP response data including headers
+         * @return string|false HTTP response data including headers. False if non-blocking.
+         * @throws Requests_Exception
          */
         public function process_response($response, $options) {
@@ -406 +427 @@
                         return false;
                 }
-                if ($options['filename'] !== false) {
+                if ($options['filename'] !== false && $this->stream_handle) {
                         fclose($this->stream_handle);
                         $this->headers = trim($this->headers);
@@ -440 +461 @@
                 // (We may want to keep this somewhere just in case)
                 if ($this->done_headers) {
-                        $this->headers = '';
+                        $this->headers      = '';
                         $this->done_headers = false;
                 }
@@ -474 +495 @@
                                 // Limit the length
                                 $limited_length = ($this->response_byte_limit - $this->response_bytes);
-                                $data = substr($data, 0, $limited_length);
+                                $data           = substr($data, 0, $limited_length);
                         }
                 }
@@ -498 +519 @@
         protected static function format_get($url, $data) {
                 if (!empty($data)) {
+                        $query     = '';
                         $url_parts = parse_url($url);
                         if (empty($url_parts['query'])) {
-                                $query = $url_parts['query'] = '';
+                                $url_parts['query'] = '';
                         }
                         else {
@@ -507 +529 @@
 
                         $query .= '&' . http_build_query($data, null, '&');
-                        $query = trim($query, '&');
+                        $query  = trim($query, '&');
 
                         if (empty($url_parts['query'])) {
@@ -540 +562 @@
                 return true;
         }
+
+        /**
+         * Get the correct "Expect" header for the given request data.
+         *
+         * @param string|array $data Data to send either as the POST body, or as parameters in the URL for a GET/HEAD.
+         * @return string The "Expect" header.
+         */
+        protected function get_expect_header($data) {
+                if (!is_array($data)) {
+                        return strlen((string) $data) >= 1048576 ? '100-Continue' : '';
+                }
+
+                $bytesize = 0;
+                $iterator = new RecursiveIteratorIterator(new RecursiveArrayIterator($data));
+
+                foreach ($iterator as $datum) {
+                        $bytesize += strlen((string) $datum);
+
+                        if ($bytesize >= 1048576) {
+                                return '100-Continue';
+                        }
+                }
+
+                return '';
+        }
 }