Inspection of "Add multipart upload for s3" - nextcloud/server - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#6602)

by Robin

created 2017-09-21 12:49 UTC

Status

Doc Comments +8 added lines patch added patch discarded remove patch

@@ -74,6 +74,10 @@  discard block
 block discarded – undo
 
 	}
 
+	/**
+	 * @param string $urn
+	 * @param resource $stream
+	 */
 	protected function singlePartUpload($urn, $stream) {
 		$this->getConnection()->putObject([
 			'Bucket' => $this->bucket,
@@ -82,6 +86,10 @@  discard block
 block discarded – undo
 		]);
 	}
 
+	/**
+	 * @param string $urn
+	 * @param resource $stream
+	 */
 	protected function multiPartUpload($urn, $stream) {
 		$uploader = new MultipartUploader($this->getConnection(), $stream, [
 			'bucket' => $this->bucket,

Please login to merge, or discard this patch.

Indentation +80 added lines, -80 removed lines patch added patch discarded remove patch

@@ -29,95 +29,95 @@
 block discarded – undo
 const S3_UPLOAD_PART_SIZE = 5368709120;
 
 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
-	 */
-	function readObject($urn) {
-		$client = $this->getConnection();
-		$command = $client->getCommand('GetObject', [
-			'Bucket' => $this->bucket,
-			'Key' => $urn
-		]);
-		$command['@http']['stream'] = true;
-		$result = $client->execute($command);
-		/** @var StreamInterface $body */
-		$body = $result['Body'];
+    /**
+     * @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
+     */
+    function readObject($urn) {
+        $client = $this->getConnection();
+        $command = $client->getCommand('GetObject', [
+            'Bucket' => $this->bucket,
+            'Key' => $urn
+        ]);
+        $command['@http']['stream'] = true;
+        $result = $client->execute($command);
+        /** @var StreamInterface $body */
+        $body = $result['Body'];
 
-		return $body->detach();
-	}
+        return $body->detach();
+    }
 
-	/**
-	 * @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
-	 */
-	function writeObject($urn, $stream) {
-		$stat = fstat($stream);
+    /**
+     * @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
+     */
+    function writeObject($urn, $stream) {
+        $stat = fstat($stream);
 
-		if ($stat['size'] && $stat['size'] < S3_UPLOAD_PART_SIZE) {
-			$this->singlePartUpload($urn, $stream);
-		} else {
-			$this->multiPartUpload($urn, $stream);
-		}
+        if ($stat['size'] && $stat['size'] < S3_UPLOAD_PART_SIZE) {
+            $this->singlePartUpload($urn, $stream);
+        } else {
+            $this->multiPartUpload($urn, $stream);
+        }
 
-	}
+    }
 
-	protected function singlePartUpload($urn, $stream) {
-		$this->getConnection()->putObject([
-			'Bucket' => $this->bucket,
-			'Key' => $urn,
-			'Body' => $stream
-		]);
-	}
+    protected function singlePartUpload($urn, $stream) {
+        $this->getConnection()->putObject([
+            'Bucket' => $this->bucket,
+            'Key' => $urn,
+            'Body' => $stream
+        ]);
+    }
 
-	protected function multiPartUpload($urn, $stream) {
-		$uploader = new MultipartUploader($this->getConnection(), $stream, [
-			'bucket' => $this->bucket,
-			'key' => $urn,
-		]);
+    protected function multiPartUpload($urn, $stream) {
+        $uploader = new MultipartUploader($this->getConnection(), $stream, [
+            'bucket' => $this->bucket,
+            'key' => $urn,
+        ]);
 
-		$tries = 0;
+        $tries = 0;
 
-		do {
-			try {
-				$result = $uploader->upload();
-			} catch (MultipartUploadException $e) {
-				rewind($stream);
-				$tries++;
+        do {
+            try {
+                $result = $uploader->upload();
+            } catch (MultipartUploadException $e) {
+                rewind($stream);
+                $tries++;
 
-				if ($tries < 5) {
-					$uploader = new MultipartUploader($this->getConnection(), $stream, [
-						'state' => $e->getState()
-					]);
-				} else {
-					$this->getConnection()->abortMultipartUpload($e->getState()->getId());
-				}
-			}
-		} while (!isset($result) && $tries < 5);
-	}
+                if ($tries < 5) {
+                    $uploader = new MultipartUploader($this->getConnection(), $stream, [
+                        'state' => $e->getState()
+                    ]);
+                } else {
+                    $this->getConnection()->abortMultipartUpload($e->getState()->getId());
+                }
+            }
+        } while (!isset($result) && $tries < 5);
+    }
 
-	/**
-	 * @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
-	 */
-	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
+     */
+    function deleteObject($urn) {
+        $this->getConnection()->deleteObject([
+            'Bucket' => $this->bucket,
+            'Key' => $urn
+        ]);
+    }
 }

Please login to merge, or discard this patch.

		@@ -74,6 +74,10 @@ discard block
		block discarded – undo
74	74
75	75	}
76	76
	77	+ /**
	78	+ * @param string $urn
	79	+ * @param resource $stream
	80	+ */
77	81	protected function singlePartUpload($urn, $stream) {
78	82	$this->getConnection()->putObject([
79	83	'Bucket' => $this->bucket,
		@@ -82,6 +86,10 @@ discard block
		block discarded – undo
82	86	]);
83	87	}
84	88
	89	+ /**
	90	+ * @param string $urn
	91	+ * @param resource $stream
	92	+ */
85	93	protected function multiPartUpload($urn, $stream) {
86	94	$uploader = new MultipartUploader($this->getConnection(), $stream, [
87	95	'bucket' => $this->bucket,

		@@ -29,95 +29,95 @@
		block discarded – undo
29	29	const S3_UPLOAD_PART_SIZE = 5368709120;
30	30
31	31	trait S3ObjectTrait {
32		- /**
33		- * Returns the connection
34		- *
35		- * @return S3Client connected client
36		- * @throws \Exception if connection could not be made
37		- */
38		- abstract protected function getConnection();
	32	+ /**
	33	+ * Returns the connection
	34	+ *
	35	+ * @return S3Client connected client
	36	+ * @throws \Exception if connection could not be made
	37	+ */
	38	+ abstract protected function getConnection();
39	39
40		- /**
41		- * @param string $urn the unified resource name used to identify the object
42		- * @return resource stream with the read data
43		- * @throws \Exception when something goes wrong, message will be logged
44		- * @since 7.0.0
45		- */
46		- function readObject($urn) {
47		- $client = $this->getConnection();
48		- $command = $client->getCommand('GetObject', [
49		- 'Bucket' => $this->bucket,
50		- 'Key' => $urn
51		- ]);
52		- $command['@http']['stream'] = true;
53		- $result = $client->execute($command);
54		- /** @var StreamInterface $body */
55		- $body = $result['Body'];
	40	+ /**
	41	+ * @param string $urn the unified resource name used to identify the object
	42	+ * @return resource stream with the read data
	43	+ * @throws \Exception when something goes wrong, message will be logged
	44	+ * @since 7.0.0
	45	+ */
	46	+ function readObject($urn) {
	47	+ $client = $this->getConnection();
	48	+ $command = $client->getCommand('GetObject', [
	49	+ 'Bucket' => $this->bucket,
	50	+ 'Key' => $urn
	51	+ ]);
	52	+ $command['@http']['stream'] = true;
	53	+ $result = $client->execute($command);
	54	+ /** @var StreamInterface $body */
	55	+ $body = $result['Body'];
56	56
57		- return $body->detach();
58		- }
	57	+ return $body->detach();
	58	+ }
59	59
60		- /**
61		- * @param string $urn the unified resource name used to identify the object
62		- * @param resource $stream stream with the data to write
63		- * @throws \Exception when something goes wrong, message will be logged
64		- * @since 7.0.0
65		- */
66		- function writeObject($urn, $stream) {
67		- $stat = fstat($stream);
	60	+ /**
	61	+ * @param string $urn the unified resource name used to identify the object
	62	+ * @param resource $stream stream with the data to write
	63	+ * @throws \Exception when something goes wrong, message will be logged
	64	+ * @since 7.0.0
	65	+ */
	66	+ function writeObject($urn, $stream) {
	67	+ $stat = fstat($stream);
68	68
69		- if ($stat['size'] && $stat['size'] < S3_UPLOAD_PART_SIZE) {
70		- $this->singlePartUpload($urn, $stream);
71		- } else {
72		- $this->multiPartUpload($urn, $stream);
73		- }
	69	+ if ($stat['size'] && $stat['size'] < S3_UPLOAD_PART_SIZE) {
	70	+ $this->singlePartUpload($urn, $stream);
	71	+ } else {
	72	+ $this->multiPartUpload($urn, $stream);
	73	+ }
74	74
75		- }
	75	+ }
76	76
77		- protected function singlePartUpload($urn, $stream) {
78		- $this->getConnection()->putObject([
79		- 'Bucket' => $this->bucket,
80		- 'Key' => $urn,
81		- 'Body' => $stream
82		- ]);
83		- }
	77	+ protected function singlePartUpload($urn, $stream) {
	78	+ $this->getConnection()->putObject([
	79	+ 'Bucket' => $this->bucket,
	80	+ 'Key' => $urn,
	81	+ 'Body' => $stream
	82	+ ]);
	83	+ }
84	84
85		- protected function multiPartUpload($urn, $stream) {
86		- $uploader = new MultipartUploader($this->getConnection(), $stream, [
87		- 'bucket' => $this->bucket,
88		- 'key' => $urn,
89		- ]);
	85	+ protected function multiPartUpload($urn, $stream) {
	86	+ $uploader = new MultipartUploader($this->getConnection(), $stream, [
	87	+ 'bucket' => $this->bucket,
	88	+ 'key' => $urn,
	89	+ ]);
90	90
91		- $tries = 0;
	91	+ $tries = 0;
92	92
93		- do {
94		- try {
95		- $result = $uploader->upload();
96		- } catch (MultipartUploadException $e) {
97		- rewind($stream);
98		- $tries++;
	93	+ do {
	94	+ try {
	95	+ $result = $uploader->upload();
	96	+ } catch (MultipartUploadException $e) {
	97	+ rewind($stream);
	98	+ $tries++;
99	99
100		- if ($tries < 5) {
101		- $uploader = new MultipartUploader($this->getConnection(), $stream, [
102		- 'state' => $e->getState()
103		- ]);
104		- } else {
105		- $this->getConnection()->abortMultipartUpload($e->getState()->getId());
106		- }
107		- }
108		- } while (!isset($result) && $tries < 5);
109		- }
	100	+ if ($tries < 5) {
	101	+ $uploader = new MultipartUploader($this->getConnection(), $stream, [
	102	+ 'state' => $e->getState()
	103	+ ]);
	104	+ } else {
	105	+ $this->getConnection()->abortMultipartUpload($e->getState()->getId());
	106	+ }
	107	+ }
	108	+ } while (!isset($result) && $tries < 5);
	109	+ }
110	110
111		- /**
112		- * @param string $urn the unified resource name used to identify the object
113		- * @return void
114		- * @throws \Exception when something goes wrong, message will be logged
115		- * @since 7.0.0
116		- */
117		- function deleteObject($urn) {
118		- $this->getConnection()->deleteObject([
119		- 'Bucket' => $this->bucket,
120		- 'Key' => $urn
121		- ]);
122		- }
	111	+ /**
	112	+ * @param string $urn the unified resource name used to identify the object
	113	+ * @return void
	114	+ * @throws \Exception when something goes wrong, message will be logged
	115	+ * @since 7.0.0
	116	+ */
	117	+ function deleteObject($urn) {
	118	+ $this->getConnection()->deleteObject([
	119	+ 'Bucket' => $this->bucket,
	120	+ 'Key' => $urn
	121	+ ]);
	122	+ }
123	123	}

nextcloud / server

Pull Request — master (#6602)

Status

Category

Doc Comments +8 added lines patch added patch discarded remove patch

Indentation +80 added lines, -80 removed lines patch added patch discarded remove patch