nextcloud / server

lib/private/Files/ObjectStore/S3ConnectionTrait.php

Indentation +155 added lines, -155 removed lines

@@ -40,159 +40,159 @@
 use OCP\ILogger;
 
 trait S3ConnectionTrait {
-	/** @var array */
-	protected $params;
-
-	/** @var S3Client */
-	protected $connection;
-
-	/** @var string */
-	protected $id;
-
-	/** @var string */
-	protected $bucket;
-
-	/** @var int */
-	protected $timeout;
-
-	/** @var int */
-	protected $uploadPartSize;
-
-	protected $test;
-
-	protected function parseParams($params) {
-		if (empty($params['bucket'])) {
-			throw new \Exception("Bucket has to be configured.");
-		}
-
-		$this->id = 'amazon::' . $params['bucket'];
-
-		$this->test = isset($params['test']);
-		$this->bucket = $params['bucket'];
-		$this->timeout = !isset($params['timeout']) ? 15 : $params['timeout'];
-		$this->uploadPartSize = !isset($params['uploadPartSize']) ? 524288000 : $params['uploadPartSize'];
-		$params['region'] = empty($params['region']) ? 'eu-west-1' : $params['region'];
-		$params['hostname'] = empty($params['hostname']) ? 's3.' . $params['region'] . '.amazonaws.com' : $params['hostname'];
-		if (!isset($params['port']) || $params['port'] === '') {
-			$params['port'] = (isset($params['use_ssl']) && $params['use_ssl'] === false) ? 80 : 443;
-		}
-		$params['verify_bucket_exists'] = empty($params['verify_bucket_exists']) ? true : $params['verify_bucket_exists'];
-		$this->params = $params;
-	}
-
-	public function getBucket() {
-		return $this->bucket;
-	}
-
-	/**
-	 * Returns the connection
-	 *
-	 * @return S3Client connected client
-	 * @throws \Exception if connection could not be made
-	 */
-	public function getConnection() {
-		if (!is_null($this->connection)) {
-			return $this->connection;
-		}
-
-		$scheme = (isset($this->params['use_ssl']) && $this->params['use_ssl'] === false) ? 'http' : 'https';
-		$base_url = $scheme . '://' . $this->params['hostname'] . ':' . $this->params['port'] . '/';
-
-		// Adding explicit credential provider to the beginning chain.
-		// Including environment variables and IAM instance profiles.
-		$provider = CredentialProvider::memoize(
-			CredentialProvider::chain(
-				$this->paramCredentialProvider(),
-				CredentialProvider::env(),
-				CredentialProvider::instanceProfile()
-			)
-		);
-
-		$options = [
-			'version' => isset($this->params['version']) ? $this->params['version'] : 'latest',
-			'credentials' => $provider,
-			'endpoint' => $base_url,
-			'region' => $this->params['region'],
-			'use_path_style_endpoint' => isset($this->params['use_path_style']) ? $this->params['use_path_style'] : false,
-			'signature_provider' => \Aws\or_chain([self::class, 'legacySignatureProvider'], ClientResolver::_default_signature_provider()),
-			'csm' => false,
-		];
-		if (isset($this->params['proxy'])) {
-			$options['request.options'] = ['proxy' => $this->params['proxy']];
-		}
-		if (isset($this->params['legacy_auth']) && $this->params['legacy_auth']) {
-			$options['signature_version'] = 'v2';
-		}
-		$this->connection = new S3Client($options);
-
-		if (!$this->connection::isBucketDnsCompatible($this->bucket)) {
-			$logger = \OC::$server->getLogger();
-			$logger->debug('Bucket "' . $this->bucket . '" This bucket name is not dns compatible, it may contain invalid characters.',
-					 ['app' => 'objectstore']);
-		}
-
-		if ($this->params['verify_bucket_exists'] && !$this->connection->doesBucketExist($this->bucket)) {
-			$logger = \OC::$server->getLogger();
-			try {
-				$logger->info('Bucket "' . $this->bucket . '" does not exist - creating it.', ['app' => 'objectstore']);
-				if (!$this->connection::isBucketDnsCompatible($this->bucket)) {
-					throw new \Exception("The bucket will not be created because the name is not dns compatible, please correct it: " . $this->bucket);
-				}
-				$this->connection->createBucket(['Bucket' => $this->bucket]);
-				$this->testTimeout();
-			} catch (S3Exception $e) {
-				$logger->logException($e, [
-					'message' => 'Invalid remote storage.',
-					'level' => ILogger::DEBUG,
-					'app' => 'objectstore',
-				]);
-				throw new \Exception('Creation of bucket "' . $this->bucket . '" failed. ' . $e->getMessage());
-			}
-		}
-
-		// google cloud's s3 compatibility doesn't like the EncodingType parameter
-		if (strpos($base_url, 'storage.googleapis.com')) {
-			$this->connection->getHandlerList()->remove('s3.auto_encode');
-		}
-
-		return $this->connection;
-	}
-
-	/**
-	 * when running the tests wait to let the buckets catch up
-	 */
-	private function testTimeout() {
-		if ($this->test) {
-			sleep($this->timeout);
-		}
-	}
-
-	public static function legacySignatureProvider($version, $service, $region) {
-		switch ($version) {
-			case 'v2':
-			case 's3':
-				return new S3Signature();
-			default:
-				return null;
-		}
-	}
-
-	/**
-	 * This function creates a credential provider based on user parameter file
-	 */
-	protected function paramCredentialProvider() : callable {
-		return function () {
-			$key = empty($this->params['key']) ? null : $this->params['key'];
-			$secret = empty($this->params['secret']) ? null : $this->params['secret'];
-
-			if ($key && $secret) {
-				return Promise\promise_for(
-					new Credentials($key, $secret)
-				);
-			}
-
-			$msg = 'Could not find parameters set for credentials in config file.';
-			return new RejectedPromise(new CredentialsException($msg));
-		};
-	}
+    /** @var array */
+    protected $params;
+
+    /** @var S3Client */
+    protected $connection;
+
+    /** @var string */
+    protected $id;
+
+    /** @var string */
+    protected $bucket;
+
+    /** @var int */
+    protected $timeout;
+
+    /** @var int */
+    protected $uploadPartSize;
+
+    protected $test;
+
+    protected function parseParams($params) {
+        if (empty($params['bucket'])) {
+            throw new \Exception("Bucket has to be configured.");
+        }
+
+        $this->id = 'amazon::' . $params['bucket'];
+
+        $this->test = isset($params['test']);
+        $this->bucket = $params['bucket'];
+        $this->timeout = !isset($params['timeout']) ? 15 : $params['timeout'];
+        $this->uploadPartSize = !isset($params['uploadPartSize']) ? 524288000 : $params['uploadPartSize'];
+        $params['region'] = empty($params['region']) ? 'eu-west-1' : $params['region'];
+        $params['hostname'] = empty($params['hostname']) ? 's3.' . $params['region'] . '.amazonaws.com' : $params['hostname'];
+        if (!isset($params['port']) || $params['port'] === '') {
+            $params['port'] = (isset($params['use_ssl']) && $params['use_ssl'] === false) ? 80 : 443;
+        }
+        $params['verify_bucket_exists'] = empty($params['verify_bucket_exists']) ? true : $params['verify_bucket_exists'];
+        $this->params = $params;
+    }
+
+    public function getBucket() {
+        return $this->bucket;
+    }
+
+    /**
+     * Returns the connection
+     *
+     * @return S3Client connected client
+     * @throws \Exception if connection could not be made
+     */
+    public function getConnection() {
+        if (!is_null($this->connection)) {
+            return $this->connection;
+        }
+
+        $scheme = (isset($this->params['use_ssl']) && $this->params['use_ssl'] === false) ? 'http' : 'https';
+        $base_url = $scheme . '://' . $this->params['hostname'] . ':' . $this->params['port'] . '/';
+
+        // Adding explicit credential provider to the beginning chain.
+        // Including environment variables and IAM instance profiles.
+        $provider = CredentialProvider::memoize(
+            CredentialProvider::chain(
+                $this->paramCredentialProvider(),
+                CredentialProvider::env(),
+                CredentialProvider::instanceProfile()
+            )
+        );
+
+        $options = [
+            'version' => isset($this->params['version']) ? $this->params['version'] : 'latest',
+            'credentials' => $provider,
+            'endpoint' => $base_url,
+            'region' => $this->params['region'],
+            'use_path_style_endpoint' => isset($this->params['use_path_style']) ? $this->params['use_path_style'] : false,
+            'signature_provider' => \Aws\or_chain([self::class, 'legacySignatureProvider'], ClientResolver::_default_signature_provider()),
+            'csm' => false,
+        ];
+        if (isset($this->params['proxy'])) {
+            $options['request.options'] = ['proxy' => $this->params['proxy']];
+        }
+        if (isset($this->params['legacy_auth']) && $this->params['legacy_auth']) {
+            $options['signature_version'] = 'v2';
+        }
+        $this->connection = new S3Client($options);
+
+        if (!$this->connection::isBucketDnsCompatible($this->bucket)) {
+            $logger = \OC::$server->getLogger();
+            $logger->debug('Bucket "' . $this->bucket . '" This bucket name is not dns compatible, it may contain invalid characters.',
+                        ['app' => 'objectstore']);
+        }
+
+        if ($this->params['verify_bucket_exists'] && !$this->connection->doesBucketExist($this->bucket)) {
+            $logger = \OC::$server->getLogger();
+            try {
+                $logger->info('Bucket "' . $this->bucket . '" does not exist - creating it.', ['app' => 'objectstore']);
+                if (!$this->connection::isBucketDnsCompatible($this->bucket)) {
+                    throw new \Exception("The bucket will not be created because the name is not dns compatible, please correct it: " . $this->bucket);
+                }
+                $this->connection->createBucket(['Bucket' => $this->bucket]);
+                $this->testTimeout();
+            } catch (S3Exception $e) {
+                $logger->logException($e, [
+                    'message' => 'Invalid remote storage.',
+                    'level' => ILogger::DEBUG,
+                    'app' => 'objectstore',
+                ]);
+                throw new \Exception('Creation of bucket "' . $this->bucket . '" failed. ' . $e->getMessage());
+            }
+        }
+
+        // google cloud's s3 compatibility doesn't like the EncodingType parameter
+        if (strpos($base_url, 'storage.googleapis.com')) {
+            $this->connection->getHandlerList()->remove('s3.auto_encode');
+        }
+
+        return $this->connection;
+    }
+
+    /**
+     * when running the tests wait to let the buckets catch up
+     */
+    private function testTimeout() {
+        if ($this->test) {
+            sleep($this->timeout);
+        }
+    }
+
+    public static function legacySignatureProvider($version, $service, $region) {
+        switch ($version) {
+            case 'v2':
+            case 's3':
+                return new S3Signature();
+            default:
+                return null;
+        }
+    }
+
+    /**
+     * This function creates a credential provider based on user parameter file
+     */
+    protected function paramCredentialProvider() : callable {
+        return function () {
+            $key = empty($this->params['key']) ? null : $this->params['key'];
+            $secret = empty($this->params['secret']) ? null : $this->params['secret'];
+
+            if ($key && $secret) {
+                return Promise\promise_for(
+                    new Credentials($key, $secret)
+                );
+            }
+
+            $msg = 'Could not find parameters set for credentials in config file.';
+            return new RejectedPromise(new CredentialsException($msg));
+        };
+    }
 }

Spacing +8 added lines, -8 removed lines

@@ -65,14 +65,14 @@ 
 			throw new \Exception("Bucket has to be configured.");
 		}
 
-		$this->id = 'amazon::' . $params['bucket'];
+		$this->id = 'amazon::'.$params['bucket'];
 
 		$this->test = isset($params['test']);
 		$this->bucket = $params['bucket'];
 		$this->timeout = !isset($params['timeout']) ? 15 : $params['timeout'];
 		$this->uploadPartSize = !isset($params['uploadPartSize']) ? 524288000 : $params['uploadPartSize'];
 		$params['region'] = empty($params['region']) ? 'eu-west-1' : $params['region'];
-		$params['hostname'] = empty($params['hostname']) ? 's3.' . $params['region'] . '.amazonaws.com' : $params['hostname'];
+		$params['hostname'] = empty($params['hostname']) ? 's3.'.$params['region'].'.amazonaws.com' : $params['hostname'];
 		if (!isset($params['port']) || $params['port'] === '') {
 			$params['port'] = (isset($params['use_ssl']) && $params['use_ssl'] === false) ? 80 : 443;
 		}
@@ -96,7 +96,7 @@ 
 		}
 
 		$scheme = (isset($this->params['use_ssl']) && $this->params['use_ssl'] === false) ? 'http' : 'https';
-		$base_url = $scheme . '://' . $this->params['hostname'] . ':' . $this->params['port'] . '/';
+		$base_url = $scheme.'://'.$this->params['hostname'].':'.$this->params['port'].'/';
 
 		// Adding explicit credential provider to the beginning chain.
 		// Including environment variables and IAM instance profiles.
@@ -127,16 +127,16 @@ 
 
 		if (!$this->connection::isBucketDnsCompatible($this->bucket)) {
 			$logger = \OC::$server->getLogger();
-			$logger->debug('Bucket "' . $this->bucket . '" This bucket name is not dns compatible, it may contain invalid characters.',
+			$logger->debug('Bucket "'.$this->bucket.'" This bucket name is not dns compatible, it may contain invalid characters.',
 					 ['app' => 'objectstore']);
 		}
 
 		if ($this->params['verify_bucket_exists'] && !$this->connection->doesBucketExist($this->bucket)) {
 			$logger = \OC::$server->getLogger();
 			try {
-				$logger->info('Bucket "' . $this->bucket . '" does not exist - creating it.', ['app' => 'objectstore']);
+				$logger->info('Bucket "'.$this->bucket.'" does not exist - creating it.', ['app' => 'objectstore']);
 				if (!$this->connection::isBucketDnsCompatible($this->bucket)) {
-					throw new \Exception("The bucket will not be created because the name is not dns compatible, please correct it: " . $this->bucket);
+					throw new \Exception("The bucket will not be created because the name is not dns compatible, please correct it: ".$this->bucket);
 				}
 				$this->connection->createBucket(['Bucket' => $this->bucket]);
 				$this->testTimeout();
@@ -146,7 +146,7 @@ 
 					'level' => ILogger::DEBUG,
 					'app' => 'objectstore',
 				]);
-				throw new \Exception('Creation of bucket "' . $this->bucket . '" failed. ' . $e->getMessage());
+				throw new \Exception('Creation of bucket "'.$this->bucket.'" failed. '.$e->getMessage());
 			}
 		}
 
@@ -181,7 +181,7 @@ 
 	 * This function creates a credential provider based on user parameter file
 	 */
 	protected function paramCredentialProvider() : callable {
-		return function () {
+		return function() {
 			$key = empty($this->params['key']) ? null : $this->params['key'];
 			$secret = empty($this->params['secret']) ? null : $this->params['secret'];