mirror of
https://github.com/WordPress/WordPress.git
synced 2024-10-30 07:20:01 +01:00
95f823d933
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 [https://requests.ryanmccue.info/docs/upgrading.html 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. Built from https://develop.svn.wordpress.org/trunk@52244 git-svn-id: http://core.svn.wordpress.org/trunk@51836 1a063a9b-81f0-0310-95a4-ce76da25c4cd
168 lines
4.1 KiB
PHP
168 lines
4.1 KiB
PHP
<?php
|
|
/**
|
|
* HTTP Proxy connection interface
|
|
*
|
|
* @package Requests\Proxy
|
|
* @since 1.6
|
|
*/
|
|
|
|
namespace WpOrg\Requests\Proxy;
|
|
|
|
use WpOrg\Requests\Exception\ArgumentCount;
|
|
use WpOrg\Requests\Exception\InvalidArgument;
|
|
use WpOrg\Requests\Hooks;
|
|
use WpOrg\Requests\Proxy;
|
|
|
|
/**
|
|
* HTTP Proxy connection interface
|
|
*
|
|
* Provides a handler for connection via an HTTP proxy
|
|
*
|
|
* @package Requests\Proxy
|
|
* @since 1.6
|
|
*/
|
|
final class Http implements Proxy {
|
|
/**
|
|
* Proxy host and port
|
|
*
|
|
* Notation: "host:port" (eg 127.0.0.1:8080 or someproxy.com:3128)
|
|
*
|
|
* @var string
|
|
*/
|
|
public $proxy;
|
|
|
|
/**
|
|
* Username
|
|
*
|
|
* @var string
|
|
*/
|
|
public $user;
|
|
|
|
/**
|
|
* Password
|
|
*
|
|
* @var string
|
|
*/
|
|
public $pass;
|
|
|
|
/**
|
|
* Do we need to authenticate? (ie username & password have been provided)
|
|
*
|
|
* @var boolean
|
|
*/
|
|
public $use_authentication;
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @since 1.6
|
|
*
|
|
* @param array|string|null $args Proxy as a string or an array of proxy, user and password.
|
|
* When passed as an array, must have exactly one (proxy)
|
|
* or three elements (proxy, user, password).
|
|
*
|
|
* @throws \WpOrg\Requests\Exception\InvalidArgument When the passed argument is not an array, a string or null.
|
|
* @throws \WpOrg\Requests\Exception\ArgumentCount On incorrect number of arguments (`proxyhttpbadargs`)
|
|
*/
|
|
public function __construct($args = null) {
|
|
if (is_string($args)) {
|
|
$this->proxy = $args;
|
|
}
|
|
elseif (is_array($args)) {
|
|
if (count($args) === 1) {
|
|
list($this->proxy) = $args;
|
|
}
|
|
elseif (count($args) === 3) {
|
|
list($this->proxy, $this->user, $this->pass) = $args;
|
|
$this->use_authentication = true;
|
|
}
|
|
else {
|
|
throw ArgumentCount::create(
|
|
'an array with exactly one element or exactly three elements',
|
|
count($args),
|
|
'proxyhttpbadargs'
|
|
);
|
|
}
|
|
} elseif ($args !== null) {
|
|
throw InvalidArgument::create(1, '$args', 'array|string|null', gettype($args));
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Register the necessary callbacks
|
|
*
|
|
* @since 1.6
|
|
* @see \WpOrg\Requests\Proxy\HTTP::curl_before_send()
|
|
* @see \WpOrg\Requests\Proxy\HTTP::fsockopen_remote_socket()
|
|
* @see \WpOrg\Requests\Proxy\HTTP::fsockopen_remote_host_path()
|
|
* @see \WpOrg\Requests\Proxy\HTTP::fsockopen_header()
|
|
* @param \WpOrg\Requests\Hooks $hooks Hook system
|
|
*/
|
|
public function register(Hooks $hooks) {
|
|
$hooks->register('curl.before_send', [$this, 'curl_before_send']);
|
|
|
|
$hooks->register('fsockopen.remote_socket', [$this, 'fsockopen_remote_socket']);
|
|
$hooks->register('fsockopen.remote_host_path', [$this, 'fsockopen_remote_host_path']);
|
|
if ($this->use_authentication) {
|
|
$hooks->register('fsockopen.after_headers', [$this, 'fsockopen_header']);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Set cURL parameters before the data is sent
|
|
*
|
|
* @since 1.6
|
|
* @param resource|\CurlHandle $handle cURL handle
|
|
*/
|
|
public function curl_before_send(&$handle) {
|
|
curl_setopt($handle, CURLOPT_PROXYTYPE, CURLPROXY_HTTP);
|
|
curl_setopt($handle, CURLOPT_PROXY, $this->proxy);
|
|
|
|
if ($this->use_authentication) {
|
|
curl_setopt($handle, CURLOPT_PROXYAUTH, CURLAUTH_ANY);
|
|
curl_setopt($handle, CURLOPT_PROXYUSERPWD, $this->get_auth_string());
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Alter remote socket information before opening socket connection
|
|
*
|
|
* @since 1.6
|
|
* @param string $remote_socket Socket connection string
|
|
*/
|
|
public function fsockopen_remote_socket(&$remote_socket) {
|
|
$remote_socket = $this->proxy;
|
|
}
|
|
|
|
/**
|
|
* Alter remote path before getting stream data
|
|
*
|
|
* @since 1.6
|
|
* @param string $path Path to send in HTTP request string ("GET ...")
|
|
* @param string $url Full URL we're requesting
|
|
*/
|
|
public function fsockopen_remote_host_path(&$path, $url) {
|
|
$path = $url;
|
|
}
|
|
|
|
/**
|
|
* Add extra headers to the request before sending
|
|
*
|
|
* @since 1.6
|
|
* @param string $out HTTP header string
|
|
*/
|
|
public function fsockopen_header(&$out) {
|
|
$out .= sprintf("Proxy-Authorization: Basic %s\r\n", base64_encode($this->get_auth_string()));
|
|
}
|
|
|
|
/**
|
|
* Get the authentication string (user:pass)
|
|
*
|
|
* @since 1.6
|
|
* @return string
|
|
*/
|
|
public function get_auth_string() {
|
|
return $this->user . ':' . $this->pass;
|
|
}
|
|
}
|