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

Timestamp:

11/25/2021 01:10:30 AM (4 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/Auth/Basic.php (modified) (5 diffs)

trunk/src/wp-includes/Requests/Auth/Basic.php

@@ -3 +3 @@
  * Basic Authentication provider
  *
- * @package Requests
- * @subpackage Authentication
+ * @package Requests\Authentication
  */
+
+namespace WpOrg\Requests\Auth;
+
+use WpOrg\Requests\Auth;
+use WpOrg\Requests\Exception\ArgumentCount;
+use WpOrg\Requests\Exception\InvalidArgument;
+use WpOrg\Requests\Hooks;
 
 /**
@@ -13 +19 @@
  * header.
  *
- * @package Requests
- * @subpackage Authentication
+ * @package Requests\Authentication
  */
-class Requests_Auth_Basic implements Requests_Auth {
+class Basic implements Auth {
     /**
      * Username
@@ -34 +39 @@
      * Constructor
      *
-     * @throws Requests_Exception On incorrect number of arguments (`authbasicbadargs`)
+     * @since 2.0 Throws an `InvalidArgument` exception.
+     * @since 2.0 Throws an `ArgumentCount` exception instead of the Requests base `Exception.
+     *
      * @param array|null $args Array of user and password. Must have exactly two elements
+     *
+     * @throws \WpOrg\Requests\Exception\InvalidArgument When the passed argument is not an array or null.
+     * @throws \WpOrg\Requests\Exception\ArgumentCount   On incorrect number of array elements (`authbasicbadargs`).
      */
     public function __construct($args = null) {
         if (is_array($args)) {
             if (count($args) !== 2) {
-                throw new Requests_Exception('Invalid number of arguments', 'authbasicbadargs');
+                throw ArgumentCount::create('an array with exactly two elements', count($args), 'authbasicbadargs');
             }
 
             list($this->user, $this->pass) = $args;
+            return;
+        }
+
+        if ($args !== null) {
+            throw InvalidArgument::create(1, '$args', 'array|null', gettype($args));
         }
     }
@@ -50 +65 @@
      * Register the necessary callbacks
      *
-     * @see curl_before_send
-     * @see fsockopen_header
-     * @param Requests_Hooks $hooks Hook system
+     * @see \WpOrg\Requests\Auth\Basic::curl_before_send()
+     * @see \WpOrg\Requests\Auth\Basic::fsockopen_header()
+     * @param \WpOrg\Requests\Hooks $hooks Hook system
      */
-    public function register(Requests_Hooks $hooks) {
-        $hooks->register('curl.before_send', array($this, 'curl_before_send'));
-        $hooks->register('fsockopen.after_headers', array($this, 'fsockopen_header'));
+    public function register(Hooks $hooks) {
+        $hooks->register('curl.before_send', [$this, 'curl_before_send']);
+        $hooks->register('fsockopen.after_headers', [$this, 'fsockopen_header']);
     }
 
@@ -62 +77 @@
      * Set cURL parameters before the data is sent
      *
-     * @param resource $handle cURL resource
+     * @param resource|\CurlHandle $handle cURL handle
      */
     public function curl_before_send(&$handle) {