nextcloud / server

lib/private/Files/ObjectStore/S3ConnectionTrait.php

Indentation +122 added lines, -122 removed lines

@@ -33,131 +33,131 @@
 use OCP\ILogger;
 
 trait S3ConnectionTrait {
-	/** @var array */
-	protected $params;
+    /** @var array */
+    protected $params;
 
-	/** @var S3Client */
-	protected $connection;
+    /** @var S3Client */
+    protected $connection;
 
-	/** @var string */
-	protected $id;
+    /** @var string */
+    protected $id;
 
-	/** @var string */
-	protected $bucket;
+    /** @var string */
+    protected $bucket;
 
-	/** @var int */
-	protected $timeout;
+    /** @var int */
+    protected $timeout;
 	
-	/** @var int */
-	protected $uploadPartSize;
-
-	protected $test;
-
-	protected function parseParams($params) {
-		if (empty($params['key']) || empty($params['secret']) || empty($params['bucket'])) {
-			throw new \Exception("Access Key, Secret and Bucket have 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;
-		}
-		$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'] . '/';
-
-		$options = [
-			'version' => isset($this->params['version']) ? $this->params['version'] : 'latest',
-			'credentials' => [
-				'key' => $this->params['key'],
-				'secret' => $this->params['secret'],
-			],
-			'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())
-		];
-		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->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;
-		}
-	}
+    /** @var int */
+    protected $uploadPartSize;
+
+    protected $test;
+
+    protected function parseParams($params) {
+        if (empty($params['key']) || empty($params['secret']) || empty($params['bucket'])) {
+            throw new \Exception("Access Key, Secret and Bucket have 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;
+        }
+        $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'] . '/';
+
+        $options = [
+            'version' => isset($this->params['version']) ? $this->params['version'] : 'latest',
+            'credentials' => [
+                'key' => $this->params['key'],
+                'secret' => $this->params['secret'],
+            ],
+            '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())
+        ];
+        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->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;
+        }
+    }
 }

Spacing +7 added lines, -7 removed lines

@@ -58,14 +58,14 @@ 
 			throw new \Exception("Access Key, Secret and Bucket have 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;
 		}
@@ -88,7 +88,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'].'/';
 
 		$options = [
 			'version' => isset($this->params['version']) ? $this->params['version'] : 'latest',
@@ -111,16 +111,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->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();
@@ -130,7 +130,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());
 			}
 		}
 

lib/private/Files/ObjectStore/S3ObjectTrait.php

Indentation +81 added lines, -81 removed lines

@@ -34,93 +34,93 @@
 use OC\Files\Stream\SeekableHttpStream;
 
 trait S3ObjectTrait {
-	/**
-	 * Returns the connection
-	 *
-	 * @return S3Client connected client
-	 * @throws \Exception if connection could not be made
-	 */
-	abstract protected function getConnection();
+    /**
+     * Returns the connection
+     *
+     * @return S3Client connected client
+     * @throws \Exception if connection could not be made
+     */
+    abstract protected function getConnection();
 
-	/**
-	 * @param string $urn the unified resource name used to identify the object
-	 * @return resource stream with the read data
-	 * @throws \Exception when something goes wrong, message will be logged
-	 * @since 7.0.0
-	 */
-	public function readObject($urn) {
-		return SeekableHttpStream::open(function ($range) use ($urn) {
-			$command = $this->getConnection()->getCommand('GetObject', [
-				'Bucket' => $this->bucket,
-				'Key' => $urn,
-				'Range' => 'bytes=' . $range,
-			]);
-			$request = \Aws\serialize($command);
-			$headers = [];
-			foreach ($request->getHeaders() as $key => $values) {
-				foreach ($values as $value) {
-					$headers[] = "$key: $value";
-				}
-			}
-			$opts = [
-				'http' => [
-					'protocol_version' => 1.1,
-					'header' => $headers,
-				],
-			];
+    /**
+     * @param string $urn the unified resource name used to identify the object
+     * @return resource stream with the read data
+     * @throws \Exception when something goes wrong, message will be logged
+     * @since 7.0.0
+     */
+    public function readObject($urn) {
+        return SeekableHttpStream::open(function ($range) use ($urn) {
+            $command = $this->getConnection()->getCommand('GetObject', [
+                'Bucket' => $this->bucket,
+                'Key' => $urn,
+                'Range' => 'bytes=' . $range,
+            ]);
+            $request = \Aws\serialize($command);
+            $headers = [];
+            foreach ($request->getHeaders() as $key => $values) {
+                foreach ($values as $value) {
+                    $headers[] = "$key: $value";
+                }
+            }
+            $opts = [
+                'http' => [
+                    'protocol_version' => 1.1,
+                    'header' => $headers,
+                ],
+            ];
 
-			$context = stream_context_create($opts);
-			return fopen($request->getUri(), 'r', false, $context);
-		});
-	}
+            $context = stream_context_create($opts);
+            return fopen($request->getUri(), 'r', false, $context);
+        });
+    }
 
-	/**
-	 * @param string $urn the unified resource name used to identify the object
-	 * @param resource $stream stream with the data to write
-	 * @throws \Exception when something goes wrong, message will be logged
-	 * @since 7.0.0
-	 */
-	public function writeObject($urn, $stream) {
-		$count = 0;
-		$countStream = CallbackWrapper::wrap($stream, function ($read) use (&$count) {
-			$count += $read;
-		});
+    /**
+     * @param string $urn the unified resource name used to identify the object
+     * @param resource $stream stream with the data to write
+     * @throws \Exception when something goes wrong, message will be logged
+     * @since 7.0.0
+     */
+    public function writeObject($urn, $stream) {
+        $count = 0;
+        $countStream = CallbackWrapper::wrap($stream, function ($read) use (&$count) {
+            $count += $read;
+        });
 
-		$uploader = new MultipartUploader($this->getConnection(), $countStream, [
-			'bucket' => $this->bucket,
-			'key' => $urn,
-			'part_size' => $this->uploadPartSize,
-		]);
+        $uploader = new MultipartUploader($this->getConnection(), $countStream, [
+            'bucket' => $this->bucket,
+            'key' => $urn,
+            'part_size' => $this->uploadPartSize,
+        ]);
 
-		try {
-			$uploader->upload();
-		} catch (S3MultipartUploadException $e) {
-			// This is an empty file so just touch it then
-			if ($count === 0 && feof($countStream)) {
-				$uploader = new ObjectUploader($this->getConnection(), $this->bucket, $urn, '');
-				$uploader->upload();
-			} else {
-				throw $e;
-			}
-		}
+        try {
+            $uploader->upload();
+        } catch (S3MultipartUploadException $e) {
+            // This is an empty file so just touch it then
+            if ($count === 0 && feof($countStream)) {
+                $uploader = new ObjectUploader($this->getConnection(), $this->bucket, $urn, '');
+                $uploader->upload();
+            } else {
+                throw $e;
+            }
+        }
 
-		fclose($countStream);
-	}
+        fclose($countStream);
+    }
 
-	/**
-	 * @param string $urn the unified resource name used to identify the object
-	 * @return void
-	 * @throws \Exception when something goes wrong, message will be logged
-	 * @since 7.0.0
-	 */
-	public function deleteObject($urn) {
-		$this->getConnection()->deleteObject([
-			'Bucket' => $this->bucket,
-			'Key' => $urn,
-		]);
-	}
+    /**
+     * @param string $urn the unified resource name used to identify the object
+     * @return void
+     * @throws \Exception when something goes wrong, message will be logged
+     * @since 7.0.0
+     */
+    public function deleteObject($urn) {
+        $this->getConnection()->deleteObject([
+            'Bucket' => $this->bucket,
+            'Key' => $urn,
+        ]);
+    }
 
-	public function objectExists($urn) {
-		return $this->getConnection()->doesObjectExist($this->bucket, $urn);
-	}
+    public function objectExists($urn) {
+        return $this->getConnection()->doesObjectExist($this->bucket, $urn);
+    }
 }