nextcloud / server

lib/private/Http/Client/Client.php

Indentation +282 added lines, -282 removed lines

@@ -42,308 +42,308 @@
  * @package OC\Http
  */
 class Client implements IClient {
-	/** @var GuzzleClient */
-	private $client;
-	/** @var IConfig */
-	private $config;
-	/** @var ICertificateManager */
-	private $certificateManager;
+    /** @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;
-	}
+    /**
+     * @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;
+    }
 
-	private function buildRequestOptions(array $options): array {
-		$proxy = $this->getProxyUri();
+    private function buildRequestOptions(array $options): array {
+        $proxy = $this->getProxyUri();
 
-		$defaults = [
-			RequestOptions::VERIFY => $this->getCertBundle(),
-			RequestOptions::TIMEOUT => 30,
-		];
+        $defaults = [
+            RequestOptions::VERIFY => $this->getCertBundle(),
+            RequestOptions::TIMEOUT => 30,
+        ];
 
-		// Only add RequestOptions::PROXY if Nextcloud is explicitly
-		// configured to use a proxy. This is needed in order not to override
-		// Guzzle default values.
-		if($proxy !== null) {
-			$defaults[RequestOptions::PROXY] = $proxy;
-		}
+        // Only add RequestOptions::PROXY if Nextcloud is explicitly
+        // configured to use a proxy. This is needed in order not to override
+        // Guzzle default values.
+        if($proxy !== null) {
+            $defaults[RequestOptions::PROXY] = $proxy;
+        }
 
-		$options = array_merge($defaults, $options);
+        $options = array_merge($defaults, $options);
 
-		if (!isset($options[RequestOptions::HEADERS]['User-Agent'])) {
-			$options[RequestOptions::HEADERS]['User-Agent'] = 'Nextcloud Server Crawler';
-		}
+        if (!isset($options[RequestOptions::HEADERS]['User-Agent'])) {
+            $options[RequestOptions::HEADERS]['User-Agent'] = 'Nextcloud Server Crawler';
+        }
 
-		return $options;
-	}
+        return $options;
+    }
 
-	private function getCertBundle(): string {
-		if ($this->certificateManager->listCertificates() !== []) {
-			return $this->certificateManager->getAbsoluteBundlePath();
-		}
+    private function getCertBundle(): string {
+        if ($this->certificateManager->listCertificates() !== []) {
+            return $this->certificateManager->getAbsoluteBundlePath();
+        }
 
-		// 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);
-		}
+        // 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);
+        }
 
-		return \OC::$SERVERROOT . '/resources/config/ca-bundle.crt';
-	}
+        return \OC::$SERVERROOT . '/resources/config/ca-bundle.crt';
+    }
 
-	/**
-	 * Returns a null or an associative array specifiying the proxy URI for
-	 * 'http' and 'https' schemes, in addition to a 'no' key value pair
-	 * providing a list of host names that should not be proxied to.
-	 *
-	 * @return array|null
-	 *
-	 * The return array looks like:
-	 * [
-	 *   'http' => 'username:password@proxy.example.com',
-	 *   'https' => 'username:password@proxy.example.com',
-	 *   'no' => ['foo.com', 'bar.com']
-	 * ]
-	 *
-	 */
-	private function getProxyUri(): ?array {
-		$proxyHost = $this->config->getSystemValue('proxy', '');
+    /**
+     * Returns a null or an associative array specifiying the proxy URI for
+     * 'http' and 'https' schemes, in addition to a 'no' key value pair
+     * providing a list of host names that should not be proxied to.
+     *
+     * @return array|null
+     *
+     * The return array looks like:
+     * [
+     *   'http' => 'username:password@proxy.example.com',
+     *   'https' => 'username:password@proxy.example.com',
+     *   'no' => ['foo.com', 'bar.com']
+     * ]
+     *
+     */
+    private function getProxyUri(): ?array {
+        $proxyHost = $this->config->getSystemValue('proxy', '');
 
-		if ($proxyHost === '' || $proxyHost === null) {
-			return null;
-		}
+        if ($proxyHost === '' || $proxyHost === null) {
+            return null;
+        }
 
-		$proxyUserPwd = $this->config->getSystemValue('proxyuserpwd', '');
-		if ($proxyUserPwd !== '' && $proxyUserPwd !== null) {
-			$proxyHost = $proxyUserPwd . '@' . $proxyHost;
-		}
+        $proxyUserPwd = $this->config->getSystemValue('proxyuserpwd', '');
+        if ($proxyUserPwd !== '' && $proxyUserPwd !== null) {
+            $proxyHost = $proxyUserPwd . '@' . $proxyHost;
+        }
 
-		$proxy = [
-			'http' => $proxyHost,
-			'https' => $proxyHost,
-		];
+        $proxy = [
+            'http' => $proxyHost,
+            'https' => $proxyHost,
+        ];
 
-		$proxyExclude = $this->config->getSystemValue('proxyexclude', []);
-		if ($proxyExclude !== [] && $proxyExclude !== null) {
-			$proxy['no'] = $proxyExclude;
-		}
+        $proxyExclude = $this->config->getSystemValue('proxyexclude', []);
+        if ($proxyExclude !== [] && $proxyExclude !== null) {
+            $proxy['no'] = $proxyExclude;
+        }
 
-		return $proxy;
-	}
+        return $proxy;
+    }
 
-	/**
-	 * 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 {
-		$response = $this->client->request('get', $uri, $this->buildRequestOptions($options));
-		$isStream = isset($options['stream']) && $options['stream'];
-		return new Response($response, $isStream);
-	}
+    /**
+     * 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 {
+        $response = $this->client->request('get', $uri, $this->buildRequestOptions($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 {
-		$response = $this->client->request('head', $uri, $this->buildRequestOptions($options));
-		return new Response($response);
-	}
+    /**
+     * 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 {
+        $response = $this->client->request('head', $uri, $this->buildRequestOptions($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 {
-		if (isset($options['body']) && is_array($options['body'])) {
-			$options['form_params'] = $options['body'];
-			unset($options['body']);
-		}
-		$response = $this->client->request('post', $uri, $this->buildRequestOptions($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 {
+        if (isset($options['body']) && is_array($options['body'])) {
+            $options['form_params'] = $options['body'];
+            unset($options['body']);
+        }
+        $response = $this->client->request('post', $uri, $this->buildRequestOptions($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 {
-		$response = $this->client->request('put', $uri, $this->buildRequestOptions($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 {
+        $response = $this->client->request('put', $uri, $this->buildRequestOptions($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 {
-		$response = $this->client->request('delete', $uri, $this->buildRequestOptions($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 {
+        $response = $this->client->request('delete', $uri, $this->buildRequestOptions($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 {
-		$response = $this->client->request('options', $uri, $this->buildRequestOptions($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 {
+        $response = $this->client->request('options', $uri, $this->buildRequestOptions($options));
+        return new Response($response);
+    }
 }

Spacing +3 added lines, -3 removed lines

@@ -75,7 +75,7 @@ 
 		// Only add RequestOptions::PROXY if Nextcloud is explicitly
 		// configured to use a proxy. This is needed in order not to override
 		// Guzzle default values.
-		if($proxy !== null) {
+		if ($proxy !== null) {
 			$defaults[RequestOptions::PROXY] = $proxy;
 		}
 
@@ -100,7 +100,7 @@ 
 			return $this->certificateManager->getAbsoluteBundlePath(null);
 		}
 
-		return \OC::$SERVERROOT . '/resources/config/ca-bundle.crt';
+		return \OC::$SERVERROOT.'/resources/config/ca-bundle.crt';
 	}
 
 	/**
@@ -127,7 +127,7 @@ 
 
 		$proxyUserPwd = $this->config->getSystemValue('proxyuserpwd', '');
 		if ($proxyUserPwd !== '' && $proxyUserPwd !== null) {
-			$proxyHost = $proxyUserPwd . '@' . $proxyHost;
+			$proxyHost = $proxyUserPwd.'@'.$proxyHost;
 		}
 
 		$proxy = [