Context Navigation

← Previous Change
Next Change →

Session.php

Timestamp:

11/25/2021 01:10:30 AM (5 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:

: 1 edited

trunk/src/wp-includes/Requests/Session.php (modified) (20 diffs)

Legend:

: Unmodified
: Added
: Removed

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

-              r50842
+              r52244
  * Session handler for persistent requests and default parameters
+ *
+ * @package Requests
+ * @subpackage Session Handler
+ * @package Requests\SessionHandler
  */
+namespace WpOrg\Requests;
+use WpOrg\Requests\Cookie\Jar;
+use WpOrg\Requests\Exception\InvalidArgument;
+use WpOrg\Requests\Iri;
+use WpOrg\Requests\Requests;
+use WpOrg\Requests\Utility\InputValidator;
 /**
 …
  * a shared cookie jar), then overridden for individual requests.
+ *
+ * @package Requests
+ * @subpackage Session Handler
+ * @package Requests\SessionHandler
  */
 class Requests_Session {
+class Session {
         /**
          * Base URL for requests
 …
          * @var array
          */
         public $headers = array();
+        public $headers = [];
         /**
 …
          * @var array
          */
         public $data = array();
+        public $data = [];
         /**
 …
          * @var array
          */
         public $options = array();
+        public $options = [];
         /**
          * Create a new session
+         *
          * @param string|null $url Base URL for requests
+         * @param string|Stringable|null $url Base URL for requests
          * @param array $headers Default headers for requests
          * @param array $data Default data for requests
          * @param array $options Default options for requests
+         */
+        public function __construct($url = null, $headers = array(), $data = array(), $options = array()) {
+         *
+         * @throws \WpOrg\Requests\Exception\InvalidArgument When the passed $url argument is not a string, Stringable or null.
+         * @throws \WpOrg\Requests\Exception\InvalidArgument When the passed $headers argument is not an array.
+         * @throws \WpOrg\Requests\Exception\InvalidArgument When the passed $data argument is not an array.
+         * @throws \WpOrg\Requests\Exception\InvalidArgument When the passed $options argument is not an array.
+         */
+        public function __construct($url = null, $headers = [], $data = [], $options = []) {
+                if ($url !== null && InputValidator::is_string_or_stringable($url) === false) {
+                        throw InvalidArgument::create(1, '$url', 'string|Stringable|null', gettype($url));
+                }
+                if (is_array($headers) === false) {
+                        throw InvalidArgument::create(2, '$headers', 'array', gettype($headers));
+                }
+                if (is_array($data) === false) {
+                        throw InvalidArgument::create(3, '$data', 'array', gettype($data));
+                }
+                if (is_array($options) === false) {
+                        throw InvalidArgument::create(4, '$options', 'array', gettype($options));
+                }
                 $this->url     = $url;
                 $this->headers = $headers;
 …
                 if (empty($this->options['cookies'])) {
                         $this->options['cookies'] = new Requests_Cookie_Jar();
+                        $this->options['cookies'] = new Jar();
+                }
+        }
 …
          * Get a property's value
+         *
          * @param string $key Property key
+         * @param string $name Property name.
          * @return mixed|null Property value, null if none found
          */
         public function __get($key) {
                 if (isset($this->options[$key])) {
                         return $this->options[$key];
+        public function __get($name) {
+                if (isset($this->options[$name])) {
+                        return $this->options[$name];
+                }
 …
          * Set a property's value
+         *
          * @param string $key Property key
+         * @param string $name Property name.
          * @param mixed $value Property value
          */
         public function __set($key, $value) {
                 $this->options[$key] = $value;
+        public function __set($name, $value) {
+                $this->options[$name] = $value;
+        }
 …
          * Remove a property's value
+         *
          * @param string $key Property key
          */
         public function __isset($key) {
                 return isset($this->options[$key]);
+         * @param string $name Property name.
+         */
+        public function __isset($name) {
+                return isset($this->options[$name]);
+        }
 …
          * Remove a property's value
+         *
+         * @param string $key Property key
+         */
+        public function __unset($key) {
+                if (isset($this->options[$key])) {
+                        unset($this->options[$key]);
+                }
+         * @param string $name Property name.
+         */
+        public function __unset($name) {
+                unset($this->options[$name]);
+        }
         /**#@+
          * @see request()
+         * @see \WpOrg\Requests\Session::request()
          * @param string $url
          * @param array $headers
          * @param array $options
          * @return Requests_Response
+         * @return \WpOrg\Requests\Response
          */
         /**
          * Send a GET request
          */
         public function get($url, $headers = array(), $options = array()) {
+        public function get($url, $headers = [], $options = []) {
                 return $this->request($url, $headers, null, Requests::GET, $options);
+        }
 …
          * Send a HEAD request
          */
         public function head($url, $headers = array(), $options = array()) {
+        public function head($url, $headers = [], $options = []) {
                 return $this->request($url, $headers, null, Requests::HEAD, $options);
+        }
 …
          * Send a DELETE request
          */
         public function delete($url, $headers = array(), $options = array()) {
+        public function delete($url, $headers = [], $options = []) {
                 return $this->request($url, $headers, null, Requests::DELETE, $options);
+        }
 …
         /**#@+
          * @see request()
+         * @see \WpOrg\Requests\Session::request()
          * @param string $url
          * @param array $headers
          * @param array $data
          * @param array $options
          * @return Requests_Response
+         * @return \WpOrg\Requests\Response
          */
         /**
          * Send a POST request
          */
         public function post($url, $headers = array(), $data = array(), $options = array()) {
+        public function post($url, $headers = [], $data = [], $options = []) {
                 return $this->request($url, $headers, $data, Requests::POST, $options);
+        }
 …
          * Send a PUT request
          */
         public function put($url, $headers = array(), $data = array(), $options = array()) {
+        public function put($url, $headers = [], $data = [], $options = []) {
                 return $this->request($url, $headers, $data, Requests::PUT, $options);
+        }
 …
          * Send a PATCH request
+         *
          * Note: Unlike {@see post} and {@see put}, `$headers` is required, as the
          * specification recommends that should send an ETag
+         * Note: Unlike {@see \WpOrg\Requests\Session::post()} and {@see \WpOrg\Requests\Session::put()},
+         * `$headers` is required, as the specification recommends that should send an ETag
+         *
          * @link https://tools.ietf.org/html/rfc5789
          */
         public function patch($url, $headers, $data = array(), $options = array()) {
+        public function patch($url, $headers, $data = [], $options = []) {
                 return $this->request($url, $headers, $data, Requests::PATCH, $options);
+        }
 …
          * parsing.
+         *
+         * @see Requests::request()
+         *
+         * @throws Requests_Exception On invalid URLs (`nonhttp`)
+         * @see \WpOrg\Requests\Requests::request()
+         *
          * @param string $url URL to request
          * @param array $headers Extra headers to send with the request
          * @param array|null $data Data to send either as a query string for GET/HEAD requests, or in the body for POST requests
+         * @param string $type HTTP request type (use Requests constants)
+         * @param array $options Options for the request (see {@see Requests::request})
+         * @return Requests_Response
+         */
+        public function request($url, $headers = array(), $data = array(), $type = Requests::GET, $options = array()) {
+         * @param string $type HTTP request type (use \WpOrg\Requests\Requests constants)
+         * @param array $options Options for the request (see {@see \WpOrg\Requests\Requests::request()})
+         * @return \WpOrg\Requests\Response
+         *
+         * @throws \WpOrg\Requests\Exception On invalid URLs (`nonhttp`)
+         */
+        public function request($url, $headers = [], $data = [], $type = Requests::GET, $options = []) {
                 $request = $this->merge_request(compact('url', 'headers', 'data', 'options'));
 …
          * Send multiple HTTP requests simultaneously
+         *
+         * @see Requests::request_multiple()
+         *
+         * @param array $requests Requests data (see {@see Requests::request_multiple})
+         * @param array $options Global and default options (see {@see Requests::request})
+         * @return array Responses (either Requests_Response or a Requests_Exception object)
+         */
+        public function request_multiple($requests, $options = array()) {
+         * @see \WpOrg\Requests\Requests::request_multiple()
+         *
+         * @param array $requests Requests data (see {@see \WpOrg\Requests\Requests::request_multiple()})
+         * @param array $options Global and default options (see {@see \WpOrg\Requests\Requests::request()})
+         * @return array Responses (either \WpOrg\Requests\Response or a \WpOrg\Requests\Exception object)
+         *
+         * @throws \WpOrg\Requests\Exception\InvalidArgument When the passed $requests argument is not an array or iterable object with array access.
+         * @throws \WpOrg\Requests\Exception\InvalidArgument When the passed $options argument is not an array.
+         */
+        public function request_multiple($requests, $options = []) {
+                if (InputValidator::has_array_access($requests) === false || InputValidator::is_iterable($requests) === false) {
+                        throw InvalidArgument::create(1, '$requests', 'array|ArrayAccess&Traversable', gettype($requests));
+                }
+                if (is_array($options) === false) {
+                        throw InvalidArgument::create(2, '$options', 'array', gettype($options));
+                }
                 foreach ($requests as $key => $request) {
                         $requests[$key] = $this->merge_request($request, false);
 …
          * Merge a request's data with the default data
+         *
          * @param array $request Request data (same form as {@see request_multiple})
+         * @param array $request Request data (same form as {@see \WpOrg\Requests\Session::request_multiple()})
          * @param boolean $merge_options Should we merge options as well?
          * @return array Request data
 …
         protected function merge_request($request, $merge_options = true) {
                 if ($this->url !== null) {
                         $request['url'] = Requests_IRI::absolutize($this->url, $request['url']);
+                        $request['url'] = Iri::absolutize($this->url, $request['url']);
                         $request['url'] = $request['url']->uri;
+                }
                 if (empty($request['headers'])) {
                         $request['headers'] = array();
+                        $request['headers'] = [];
+                }
                 $request['headers'] = array_merge($this->headers, $request['headers']);
 …
+                }
                 if ($merge_options !== false) {
+                if ($merge_options === true) {
                         $request['options'] = array_merge($this->options, $request['options']);

Note: See TracChangeset for help on using the changeset viewer.

Make WordPress Core

Context Navigation

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

Legend:

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

Download in other formats: