Changeset 52244 for trunk/src/wp-includes/Requests/Response.php

Timestamp:

11/25/2021 01:10:30 AM (3 years ago)

Author:

SergeyBiryukov

Message:

External Libraries: Update the Requests library to version 2.0.0.

This is a major release and contains breaking changes.

Most important changes to be aware of for this release:

• All code is now namespaced. Though there is a full backward compatibility layer available and the old class names are still supported, using them will generate a deprecation notice (which can be silenced by plugins if they'd need to support multiple WP versions). See the ​upgrade guide for more details.
• A lot of classes have been marked final. This should generally not affect userland code as care has been taken to not apply the final keyword to classes which are known to be extended in userland code.
• Extensive input validation has been added to Requests. When Requests is used as documented though, this will be unnoticable.
• A new WpOrg\Requests\Requests::has_capabilities() method has been introduced which can be used to address #37708.
• A new WpOrg\Requests\Response::decode_body() method has been introduced which may be usable to simplify some of the WP native wrapper code.
• Remaining PHP 8.0 compatibility fixed (support for named parameters).
• PHP 8.1 compatibility.

Release notes: ​https://github.com/WordPress/Requests/releases/tag/v2.0.0

For a full list of changes in this update, see the Requests GitHub:
​https://github.com/WordPress/Requests/compare/v1.8.1...v2.0.0

Follow-up to [50842], [51078].

Props jrf, schlessera, datagutten, wojsmol, dd32, dustinrue, soulseekah, costdev, szepeviktor.
Fixes #54504.

File:

• trunk/src/wp-includes/Requests/Response.php (modified) (5 diffs)

trunk/src/wp-includes/Requests/Response.php

@@ -3 +3 @@
  * HTTP response class
  *
- * Contains a response from Requests::request()
+ * Contains a response from \WpOrg\Requests\Requests::request()
+ *
  * @package Requests
  */
+
+namespace WpOrg\Requests;
+
+use WpOrg\Requests\Cookie\Jar;
+use WpOrg\Requests\Exception;
+use WpOrg\Requests\Exception\Http;
+use WpOrg\Requests\Response\Headers;
 
 /**
  * HTTP response class
  *
- * Contains a response from Requests::request()
+ * Contains a response from \WpOrg\Requests\Requests::request()
+ *
  * @package Requests
  */
-class Requests_Response {
-    /**
-     * Constructor
-     */
-    public function __construct() {
-        $this->headers = new Requests_Response_Headers();
-        $this->cookies = new Requests_Cookie_Jar();
-    }
+class Response {
 
     /**
@@ -39 +41 @@
      * Headers, as an associative array
      *
-     * @var Requests_Response_Headers Array-like object representing headers
+     * @var \WpOrg\Requests\Response\Headers Array-like object representing headers
      */
-    public $headers = array();
+    public $headers = [];
 
     /**
@@ -81 +83 @@
      * Previous requests (from redirects)
      *
-     * @var array Array of Requests_Response objects
+     * @var array Array of \WpOrg\Requests\Response objects
      */
-    public $history = array();
+    public $history = [];
 
     /**
      * Cookies from the request
      *
-     * @var Requests_Cookie_Jar Array-like object representing a cookie jar
+     * @var \WpOrg\Requests\Cookie\Jar Array-like object representing a cookie jar
      */
-    public $cookies = array();
+    public $cookies = [];
+
+    /**
+     * Constructor
+     */
+    public function __construct() {
+        $this->headers = new Headers();
+        $this->cookies = new Jar();
+    }
 
     /**
@@ -99 +109 @@
     public function is_redirect() {
         $code = $this->status_code;
-        return in_array($code, array(300, 301, 302, 303, 307), true) || $code > 307 && $code < 400;
+        return in_array($code, [300, 301, 302, 303, 307], true) || $code > 307 && $code < 400;
     }
 
@@ -105 +115 @@
      * Throws an exception if the request was not successful
      *
-     * @throws Requests_Exception If `$allow_redirects` is false, and code is 3xx (`response.no_redirects`)
-     * @throws Requests_Exception_HTTP On non-successful status code. Exception class corresponds to code (e.g. {@see Requests_Exception_HTTP_404})
      * @param boolean $allow_redirects Set to false to throw on a 3xx as well
+     *
+     * @throws \WpOrg\Requests\Exception If `$allow_redirects` is false, and code is 3xx (`response.no_redirects`)
+     * @throws \WpOrg\Requests\Exception\Http On non-successful status code. Exception class corresponds to "Status" + code (e.g. {@see \WpOrg\Requests\Exception\Http\Status404})
      */
     public function throw_for_status($allow_redirects = true) {
         if ($this->is_redirect()) {
-            if (!$allow_redirects) {
-                throw new Requests_Exception('Redirection not allowed', 'response.no_redirects', $this);
+            if ($allow_redirects !== true) {
+                throw new Exception('Redirection not allowed', 'response.no_redirects', $this);
             }
         }
         elseif (!$this->success) {
-            $exception = Requests_Exception_HTTP::get_class($this->status_code);
+            $exception = Http::get_class($this->status_code);
             throw new $exception(null, $this);
         }
     }
+
+    /**
+     * JSON decode the response body.
+     *
+     * The method parameters are the same as those for the PHP native `json_decode()` function.
+     *
+     * @link https://php.net/json-decode
+     *
+     * @param ?bool $associative Optional. When `true`, JSON objects will be returned as associative arrays;
+     *                           When `false`, JSON objects will be returned as objects.
+     *                           When `null`, JSON objects will be returned as associative arrays
+     *                           or objects depending on whether `JSON_OBJECT_AS_ARRAY` is set in the flags.
+     *                           Defaults to `true` (in contrast to the PHP native default of `null`).
+     * @param int   $depth       Optional. Maximum nesting depth of the structure being decoded.
+     *                           Defaults to `512`.
+     * @param int   $options     Optional. Bitmask of JSON_BIGINT_AS_STRING, JSON_INVALID_UTF8_IGNORE,
+     *                           JSON_INVALID_UTF8_SUBSTITUTE, JSON_OBJECT_AS_ARRAY, JSON_THROW_ON_ERROR.
+     *                           Defaults to `0` (no options set).
+     *
+     * @return array
+     *
+     * @throws \WpOrg\Requests\Exception If `$this->body` is not valid json.
+     */
+    public function decode_body($associative = true, $depth = 512, $options = 0) {
+        $data = json_decode($this->body, $associative, $depth, $options);
+
+        if (json_last_error() !== JSON_ERROR_NONE) {
+            $last_error = json_last_error_msg();
+            throw new Exception('Unable to parse JSON data: ' . $last_error, 'response.invalid', $this);
+        }
+
+        return $data;
+    }
 }