nextcloud/lib/private/Http/Client/Client.php

341 lines
11 KiB
PHP
Raw Normal View History

2015-03-16 13:28:23 +03:00
<?php
declare(strict_types=1);
2015-03-16 13:28:23 +03:00
/**
2016-07-21 18:07:57 +03:00
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
2016-05-26 20:56:05 +03:00
* @author Lukas Reschke <lukas@statuscode.ch>
2016-07-21 19:13:36 +03:00
* @author Robin Appelman <robin@icewind.nl>
2015-03-26 13:44:34 +03:00
*
* @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/>
*
2015-03-16 13:28:23 +03:00
*/
namespace OC\Http\Client;
use GuzzleHttp\Client as GuzzleClient;
use GuzzleHttp\HandlerStack;
use GuzzleHttp\Middleware;
2015-03-16 13:28:23 +03:00
use OCP\Http\Client\IClient;
use OCP\Http\Client\IResponse;
2015-03-16 13:28:23 +03:00
use OCP\ICertificateManager;
use OCP\IConfig;
use Psr\Http\Message\RequestInterface;
2015-03-16 13:28:23 +03:00
/**
* 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;
2015-03-16 13:28:23 +03:00
/**
* @param IConfig $config
* @param ICertificateManager $certificateManager
* @param GuzzleClient $client
*/
public function __construct(
IConfig $config,
ICertificateManager $certificateManager,
GuzzleClient $client,
HandlerStack $stack
) {
2015-03-16 13:28:23 +03:00
$this->config = $config;
$this->client = $client;
$this->stack = $stack;
2015-03-16 13:28:23 +03:00
$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();
2015-03-16 13:28:23 +03:00
} 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';
}
2015-03-16 13:28:23 +03:00
}
}
/**
* Get the proxy URI
*
2015-03-16 13:28:23 +03:00
* @return string
*/
private function getProxyUri(): string {
2015-03-16 13:28:23 +03:00
$proxyHost = $this->config->getSystemValue('proxy', null);
$proxyUserPwd = $this->config->getSystemValue('proxyuserpwd', null);
$proxyUri = '';
if ($proxyUserPwd !== null) {
$proxyUri .= $proxyUserPwd . '@';
2015-03-16 13:28:23 +03:00
}
if ($proxyHost !== null) {
2015-03-16 13:28:23 +03:00
$proxyUri .= $proxyHost;
}
return $proxyUri;
}
/**
* Sends a GET request
*
2015-03-16 13:28:23 +03:00
* @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
2015-03-16 13:28:23 +03:00
* @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);
2015-03-16 13:28:23 +03:00
}
/**
* Sends a HEAD request
*
2015-03-16 13:28:23 +03:00
* @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
2015-03-16 13:28:23 +03:00
*/
public function head(string $uri, array $options = []): IResponse {
$this->setDefaultOptions();
$response = $this->client->request('head', $uri, array_merge($this->getRequestOptions(), $options));
2015-03-16 13:28:23 +03:00
return new Response($response);
}
/**
* Sends a POST request
*
2015-03-16 13:28:23 +03:00
* @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
2015-03-16 13:28:23 +03:00
*/
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));
2015-03-16 13:28:23 +03:00
return new Response($response);
}
/**
* Sends a PUT request
*
2015-03-16 13:28:23 +03:00
* @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
2015-03-16 13:28:23 +03:00
*/
public function put(string $uri, array $options = []): IResponse {
$this->setDefaultOptions();
$response = $this->client->request('put', $uri, array_merge($this->getRequestOptions(), $options));
2015-03-16 13:28:23 +03:00
return new Response($response);
}
/**
* Sends a DELETE request
*
2015-03-16 13:28:23 +03:00
* @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
2015-03-16 13:28:23 +03:00
*/
public function delete(string $uri, array $options = []): IResponse {
$this->setDefaultOptions();
$response = $this->client->request('delete', $uri, array_merge($this->getRequestOptions(), $options));
2015-03-16 13:28:23 +03:00
return new Response($response);
}
/**
* Sends a options request
*
2015-03-16 13:28:23 +03:00
* @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
2015-03-16 13:28:23 +03:00
*/
public function options(string $uri, array $options = []): IResponse {
$this->setDefaultOptions();
$response = $this->client->request('options', $uri, array_merge($this->getRequestOptions(), $options));
2015-03-16 13:28:23 +03:00
return new Response($response);
}
}