123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340 |
- <?php
- declare(strict_types=1);
- /**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- *
- * @author Lukas Reschke <lukas@statuscode.ch>
- * @author Robin Appelman <robin@icewind.nl>
- *
- * @license AGPL-3.0
- *
- * This code is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License, version 3,
- * as published by the Free Software Foundation.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License, version 3,
- * along with this program. If not, see <http://www.gnu.org/licenses/>
- *
- */
- namespace OC\Http\Client;
- use GuzzleHttp\Client as GuzzleClient;
- use GuzzleHttp\HandlerStack;
- use GuzzleHttp\Middleware;
- use OCP\Http\Client\IClient;
- use OCP\Http\Client\IResponse;
- use OCP\ICertificateManager;
- use OCP\IConfig;
- use Psr\Http\Message\RequestInterface;
- /**
- * Class Client
- *
- * @package OC\Http
- */
- class Client implements IClient {
- /** @var GuzzleClient */
- private $client;
- /** @var IConfig */
- private $config;
- /** @var ICertificateManager */
- private $certificateManager;
- private $configured = false;
- /** @var HandlerStack */
- private $stack;
- /**
- * @param IConfig $config
- * @param ICertificateManager $certificateManager
- * @param GuzzleClient $client
- */
- public function __construct(
- IConfig $config,
- ICertificateManager $certificateManager,
- GuzzleClient $client,
- HandlerStack $stack
- ) {
- $this->config = $config;
- $this->client = $client;
- $this->stack = $stack;
- $this->certificateManager = $certificateManager;
- }
- /**
- * Sets the default options to the client
- */
- private function setDefaultOptions() {
- if ($this->configured) {
- return;
- }
- $this->configured = true;
- $this->stack->push(Middleware::mapRequest(function (RequestInterface $request) {
- return $request
- ->withHeader('User-Agent', 'Nextcloud Server Crawler');
- }));
- }
- private function getRequestOptions() {
- $options = [
- 'verify' => $this->getCertBundle(),
- ];
- $proxyUri = $this->getProxyUri();
- if ($proxyUri !== '') {
- $options['proxy'] = $proxyUri;
- }
- return $options;
- }
- private function getCertBundle() {
- if ($this->certificateManager->listCertificates() !== []) {
- return $this->certificateManager->getAbsoluteBundlePath();
- } else {
- // If the instance is not yet setup we need to use the static path as
- // $this->certificateManager->getAbsoluteBundlePath() tries to instantiiate
- // a view
- if ($this->config->getSystemValue('installed', false)) {
- return $this->certificateManager->getAbsoluteBundlePath(null);
- } else {
- return \OC::$SERVERROOT . '/resources/config/ca-bundle.crt';
- }
- }
- }
- /**
- * Get the proxy URI
- *
- * @return string
- */
- private function getProxyUri(): string {
- $proxyHost = $this->config->getSystemValue('proxy', null);
- $proxyUserPwd = $this->config->getSystemValue('proxyuserpwd', null);
- $proxyUri = '';
- if ($proxyUserPwd !== null) {
- $proxyUri .= $proxyUserPwd . '@';
- }
- if ($proxyHost !== null) {
- $proxyUri .= $proxyHost;
- }
- return $proxyUri;
- }
- /**
- * Sends a GET request
- *
- * @param string $uri
- * @param array $options Array such as
- * 'query' => [
- * 'field' => 'abc',
- * 'other_field' => '123',
- * 'file_name' => fopen('/path/to/file', 'r'),
- * ],
- * 'headers' => [
- * 'foo' => 'bar',
- * ],
- * 'cookies' => ['
- * 'foo' => 'bar',
- * ],
- * 'allow_redirects' => [
- * 'max' => 10, // allow at most 10 redirects.
- * 'strict' => true, // use "strict" RFC compliant redirects.
- * 'referer' => true, // add a Referer header
- * 'protocols' => ['https'] // only allow https URLs
- * ],
- * 'save_to' => '/path/to/file', // save to a file or a stream
- * 'verify' => true, // bool or string to CA file
- * 'debug' => true,
- * 'timeout' => 5,
- * @return IResponse
- * @throws \Exception If the request could not get completed
- */
- public function get(string $uri, array $options = []): IResponse {
- $this->setDefaultOptions();
- $response = $this->client->request('get', $uri, array_merge($this->getRequestOptions(), $options));
- $isStream = isset($options['stream']) && $options['stream'];
- return new Response($response, $isStream);
- }
- /**
- * Sends a HEAD request
- *
- * @param string $uri
- * @param array $options Array such as
- * 'headers' => [
- * 'foo' => 'bar',
- * ],
- * 'cookies' => ['
- * 'foo' => 'bar',
- * ],
- * 'allow_redirects' => [
- * 'max' => 10, // allow at most 10 redirects.
- * 'strict' => true, // use "strict" RFC compliant redirects.
- * 'referer' => true, // add a Referer header
- * 'protocols' => ['https'] // only allow https URLs
- * ],
- * 'save_to' => '/path/to/file', // save to a file or a stream
- * 'verify' => true, // bool or string to CA file
- * 'debug' => true,
- * 'timeout' => 5,
- * @return IResponse
- * @throws \Exception If the request could not get completed
- */
- public function head(string $uri, array $options = []): IResponse {
- $this->setDefaultOptions();
- $response = $this->client->request('head', $uri, array_merge($this->getRequestOptions(), $options));
- return new Response($response);
- }
- /**
- * Sends a POST request
- *
- * @param string $uri
- * @param array $options Array such as
- * 'body' => [
- * 'field' => 'abc',
- * 'other_field' => '123',
- * 'file_name' => fopen('/path/to/file', 'r'),
- * ],
- * 'headers' => [
- * 'foo' => 'bar',
- * ],
- * 'cookies' => ['
- * 'foo' => 'bar',
- * ],
- * 'allow_redirects' => [
- * 'max' => 10, // allow at most 10 redirects.
- * 'strict' => true, // use "strict" RFC compliant redirects.
- * 'referer' => true, // add a Referer header
- * 'protocols' => ['https'] // only allow https URLs
- * ],
- * 'save_to' => '/path/to/file', // save to a file or a stream
- * 'verify' => true, // bool or string to CA file
- * 'debug' => true,
- * 'timeout' => 5,
- * @return IResponse
- * @throws \Exception If the request could not get completed
- */
- public function post(string $uri, array $options = []): IResponse {
- $this->setDefaultOptions();
- if (isset($options['body']) && is_array($options['body'])) {
- $options['form_params'] = $options['body'];
- unset($options['body']);
- }
- $response = $this->client->request('post', $uri, array_merge($this->getRequestOptions(), $options));
- return new Response($response);
- }
- /**
- * Sends a PUT request
- *
- * @param string $uri
- * @param array $options Array such as
- * 'body' => [
- * 'field' => 'abc',
- * 'other_field' => '123',
- * 'file_name' => fopen('/path/to/file', 'r'),
- * ],
- * 'headers' => [
- * 'foo' => 'bar',
- * ],
- * 'cookies' => ['
- * 'foo' => 'bar',
- * ],
- * 'allow_redirects' => [
- * 'max' => 10, // allow at most 10 redirects.
- * 'strict' => true, // use "strict" RFC compliant redirects.
- * 'referer' => true, // add a Referer header
- * 'protocols' => ['https'] // only allow https URLs
- * ],
- * 'save_to' => '/path/to/file', // save to a file or a stream
- * 'verify' => true, // bool or string to CA file
- * 'debug' => true,
- * 'timeout' => 5,
- * @return IResponse
- * @throws \Exception If the request could not get completed
- */
- public function put(string $uri, array $options = []): IResponse {
- $this->setDefaultOptions();
- $response = $this->client->request('put', $uri, array_merge($this->getRequestOptions(), $options));
- return new Response($response);
- }
- /**
- * Sends a DELETE request
- *
- * @param string $uri
- * @param array $options Array such as
- * 'body' => [
- * 'field' => 'abc',
- * 'other_field' => '123',
- * 'file_name' => fopen('/path/to/file', 'r'),
- * ],
- * 'headers' => [
- * 'foo' => 'bar',
- * ],
- * 'cookies' => ['
- * 'foo' => 'bar',
- * ],
- * 'allow_redirects' => [
- * 'max' => 10, // allow at most 10 redirects.
- * 'strict' => true, // use "strict" RFC compliant redirects.
- * 'referer' => true, // add a Referer header
- * 'protocols' => ['https'] // only allow https URLs
- * ],
- * 'save_to' => '/path/to/file', // save to a file or a stream
- * 'verify' => true, // bool or string to CA file
- * 'debug' => true,
- * 'timeout' => 5,
- * @return IResponse
- * @throws \Exception If the request could not get completed
- */
- public function delete(string $uri, array $options = []): IResponse {
- $this->setDefaultOptions();
- $response = $this->client->request('delete', $uri, array_merge($this->getRequestOptions(), $options));
- return new Response($response);
- }
- /**
- * Sends a options request
- *
- * @param string $uri
- * @param array $options Array such as
- * 'body' => [
- * 'field' => 'abc',
- * 'other_field' => '123',
- * 'file_name' => fopen('/path/to/file', 'r'),
- * ],
- * 'headers' => [
- * 'foo' => 'bar',
- * ],
- * 'cookies' => ['
- * 'foo' => 'bar',
- * ],
- * 'allow_redirects' => [
- * 'max' => 10, // allow at most 10 redirects.
- * 'strict' => true, // use "strict" RFC compliant redirects.
- * 'referer' => true, // add a Referer header
- * 'protocols' => ['https'] // only allow https URLs
- * ],
- * 'save_to' => '/path/to/file', // save to a file or a stream
- * 'verify' => true, // bool or string to CA file
- * 'debug' => true,
- * 'timeout' => 5,
- * @return IResponse
- * @throws \Exception If the request could not get completed
- */
- public function options(string $uri, array $options = []): IResponse {
- $this->setDefaultOptions();
- $response = $this->client->request('options', $uri, array_merge($this->getRequestOptions(), $options));
- return new Response($response);
- }
- }
|