summaryrefslogtreecommitdiffstats
path: root/lib/private/Http/Client
diff options
context:
space:
mode:
authorRoeland Jago Douma <rullzer@owncloud.com>2016-04-28 10:10:50 +0200
committerRoeland Jago Douma <rullzer@owncloud.com>2016-04-28 10:10:50 +0200
commit0b69cd1120d951592de4bdf4979eed2ee0c060cd (patch)
tree6a37d3e87cce08b4b3f86b70e9e9227daee80292 /lib/private/Http/Client
parentba0099f73abc133cfc88ad2d7a25b86677d1c111 (diff)
downloadnextcloud-server-0b69cd1120d951592de4bdf4979eed2ee0c060cd.tar.gz
nextcloud-server-0b69cd1120d951592de4bdf4979eed2ee0c060cd.zip
Move \OC\Http to PSR-4
Diffstat (limited to 'lib/private/Http/Client')
-rw-r--r--lib/private/Http/Client/Client.php294
-rw-r--r--lib/private/Http/Client/ClientService.php56
-rw-r--r--lib/private/Http/Client/Response.php81
3 files changed, 431 insertions, 0 deletions
diff --git a/lib/private/Http/Client/Client.php b/lib/private/Http/Client/Client.php
new file mode 100644
index 00000000000..bd9e82ddae7
--- /dev/null
+++ b/lib/private/Http/Client/Client.php
@@ -0,0 +1,294 @@
+<?php
+/**
+ * @author Lukas Reschke <lukas@owncloud.com>
+ * @author Robin Appelman <icewind@owncloud.com>
+ *
+ * @copyright Copyright (c) 2016, ownCloud, Inc.
+ * @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 OCP\Http\Client\IClient;
+use OCP\ICertificateManager;
+use OCP\IConfig;
+
+/**
+ * Class Client
+ *
+ * @package OC\Http
+ */
+class Client implements IClient {
+ /** @var GuzzleClient */
+ private $client;
+ /** @var IConfig */
+ private $config;
+ /** @var ICertificateManager */
+ private $certificateManager;
+
+ /**
+ * @param IConfig $config
+ * @param ICertificateManager $certificateManager
+ * @param GuzzleClient $client
+ */
+ public function __construct(IConfig $config,
+ ICertificateManager $certificateManager,
+ GuzzleClient $client) {
+ $this->config = $config;
+ $this->client = $client;
+ $this->certificateManager = $certificateManager;
+ $this->setDefaultOptions();
+ }
+
+ /**
+ * Sets the default options to the client
+ */
+ private function setDefaultOptions() {
+ // Either use user bundle or the system bundle if nothing is specified
+ if ($this->certificateManager->listCertificates() !== []) {
+ $this->client->setDefaultOption('verify', $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)) {
+ $this->client->setDefaultOption('verify', $this->certificateManager->getAbsoluteBundlePath(null));
+ } else {
+ $this->client->setDefaultOption('verify', \OC::$SERVERROOT . '/resources/config/ca-bundle.crt');
+ }
+ }
+
+ $this->client->setDefaultOption('headers/User-Agent', 'ownCloud Server Crawler');
+ if($this->getProxyUri() !== '') {
+ $this->client->setDefaultOption('proxy', $this->getProxyUri());
+ }
+ }
+
+ /**
+ * Get the proxy URI
+ * @return string
+ */
+ private function getProxyUri() {
+ $proxyHost = $this->config->getSystemValue('proxy', null);
+ $proxyUserPwd = $this->config->getSystemValue('proxyuserpwd', null);
+ $proxyUri = '';
+
+ if(!is_null($proxyUserPwd)) {
+ $proxyUri .= $proxyUserPwd.'@';
+ }
+ if(!is_null($proxyHost)) {
+ $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 Response
+ * @throws \Exception If the request could not get completed
+ */
+ public function get($uri, array $options = []) {
+ $response = $this->client->get($uri, $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 Response
+ * @throws \Exception If the request could not get completed
+ */
+ public function head($uri, $options = []) {
+ $response = $this->client->head($uri, $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 Response
+ * @throws \Exception If the request could not get completed
+ */
+ public function post($uri, array $options = []) {
+ $response = $this->client->post($uri, $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 Response
+ * @throws \Exception If the request could not get completed
+ */
+ public function put($uri, array $options = []) {
+ $response = $this->client->put($uri, $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 Response
+ * @throws \Exception If the request could not get completed
+ */
+ public function delete($uri, array $options = []) {
+ $response = $this->client->delete($uri, $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 Response
+ * @throws \Exception If the request could not get completed
+ */
+ public function options($uri, array $options = []) {
+ $response = $this->client->options($uri, $options);
+ return new Response($response);
+ }
+}
diff --git a/lib/private/Http/Client/ClientService.php b/lib/private/Http/Client/ClientService.php
new file mode 100644
index 00000000000..7e280dbf3ca
--- /dev/null
+++ b/lib/private/Http/Client/ClientService.php
@@ -0,0 +1,56 @@
+<?php
+/**
+ * @author Lukas Reschke <lukas@owncloud.com>
+ *
+ * @copyright Copyright (c) 2016, ownCloud, Inc.
+ * @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 OCP\Http\Client\IClientService;
+use OCP\ICertificateManager;
+use OCP\IConfig;
+
+/**
+ * Class ClientService
+ *
+ * @package OC\Http
+ */
+class ClientService implements IClientService {
+ /** @var IConfig */
+ private $config;
+ /** @var ICertificateManager */
+ private $certificateManager;
+
+ /**
+ * @param IConfig $config
+ * @param ICertificateManager $certificateManager
+ */
+ public function __construct(IConfig $config,
+ ICertificateManager $certificateManager) {
+ $this->config = $config;
+ $this->certificateManager = $certificateManager;
+ }
+
+ /**
+ * @return Client
+ */
+ public function newClient() {
+ return new Client($this->config, $this->certificateManager, new GuzzleClient());
+ }
+}
diff --git a/lib/private/Http/Client/Response.php b/lib/private/Http/Client/Response.php
new file mode 100644
index 00000000000..7a879eab111
--- /dev/null
+++ b/lib/private/Http/Client/Response.php
@@ -0,0 +1,81 @@
+<?php
+/**
+ * @author Lukas Reschke <lukas@owncloud.com>
+ * @author Robin Appelman <icewind@owncloud.com>
+ *
+ * @copyright Copyright (c) 2016, ownCloud, Inc.
+ * @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 OCP\Http\Client\IResponse;
+use GuzzleHttp\Message\Response as GuzzleResponse;
+
+/**
+ * Class Response
+ *
+ * @package OC\Http
+ */
+class Response implements IResponse {
+ /** @var GuzzleResponse */
+ private $response;
+
+ /**
+ * @var bool
+ */
+ private $stream;
+
+ /**
+ * @param GuzzleResponse $response
+ * @param bool $stream
+ */
+ public function __construct(GuzzleResponse $response, $stream = false) {
+ $this->response = $response;
+ $this->stream = $stream;
+ }
+
+ /**
+ * @return string|resource
+ */
+ public function getBody() {
+ return $this->stream ?
+ $this->response->getBody()->detach():
+ $this->response->getBody()->getContents();
+ }
+
+ /**
+ * @return int
+ */
+ public function getStatusCode() {
+ return $this->response->getStatusCode();
+ }
+
+ /**
+ * @param $key
+ * @return string
+ */
+ public function getHeader($key) {
+ return $this->response->getHeader($key);
+ }
+
+ /**
+ * @return array
+ */
+ public function getHeaders() {
+ return $this->response->getHeaders();
+ }
+}