Merge pull request #40981 from nextcloud/fix/object-storage-user

fix(objectstorage): cleanup HomeObjectStoreStorage
nextcloud · Feb 2, 2024 · 8a4bd3b · 8a4bd3b
2 parents 86e57e9 + 30798eb
commit 8a4bd3b
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 39 deletions.
diff --git a/lib/private/Files/ObjectStore/AppdataPreviewObjectStoreStorage.php b/lib/private/Files/ObjectStore/AppdataPreviewObjectStoreStorage.php
@@ -26,9 +26,12 @@
 namespace OC\Files\ObjectStore;
 
 class AppdataPreviewObjectStoreStorage extends ObjectStoreStorage {
-	/** @var string */
-	private $internalId;
+	private string $internalId;
 
+	/**
+	 * @param array $params
+	 * @throws \Exception
+	 */
 	public function __construct($params) {
 		if (!isset($params['internal-id'])) {
 			throw new \Exception('missing id in parameters');
@@ -37,7 +40,7 @@ public function __construct($params) {
 		parent::__construct($params);
 	}
 
-	public function getId() {
+	public function getId(): string {
 		return 'object::appdata::preview:' . $this->internalId;
 	}
 }
diff --git a/lib/private/Files/ObjectStore/HomeObjectStoreStorage.php b/lib/private/Files/ObjectStore/HomeObjectStoreStorage.php
@@ -7,6 +7,7 @@
  * @author Jörn Friedrich Dreyer <[email protected]>
  * @author Morris Jobke <[email protected]>
  * @author Roeland Jago Douma <[email protected]>
+ * @author Thomas Citharel <[email protected]>
  *
  * @license AGPL-3.0
  *
@@ -25,44 +26,42 @@
  */
 namespace OC\Files\ObjectStore;
 
-use OC\User\User;
+use Exception;
+use OCP\Files\IHomeStorage;
 use OCP\IUser;
 
-class HomeObjectStoreStorage extends ObjectStoreStorage implements \OCP\Files\IHomeStorage {
+class HomeObjectStoreStorage extends ObjectStoreStorage implements IHomeStorage {
+	protected IUser $user;
+
 	/**
 	 * The home user storage requires a user object to create a unique storage id
+	 *
 	 * @param array $params
+	 * @throws Exception
 	 */
 	public function __construct($params) {
-		if (! isset($params['user']) || ! $params['user'] instanceof User) {
-			throw new \Exception('missing user object in parameters');
+		if (! isset($params['user']) || ! $params['user'] instanceof IUser) {
+			throw new Exception('missing user object in parameters');
 		}
 		$this->user = $params['user'];
 		parent::__construct($params);
 	}
 
-	public function getId() {
+	public function getId(): string {
 		return 'object::user:' . $this->user->getUID();
 	}
 
 	/**
 	 * get the owner of a path
 	 *
 	 * @param string $path The path to get the owner
-	 * @return false|string uid
+	 * @return string uid
 	 */
-	public function getOwner($path) {
-		if (is_object($this->user)) {
-			return $this->user->getUID();
-		}
-		return false;
+	public function getOwner($path): string {
+		return $this->user->getUID();
 	}
 
-	/**
-	 * @param string $path, optional
-	 * @return \OC\User\User
-	 */
-	public function getUser($path = null): IUser {
+	public function getUser(): IUser {
 		return $this->user;
 	}
 }
diff --git a/lib/private/Files/ObjectStore/ObjectStoreStorage.php b/lib/private/Files/ObjectStore/ObjectStoreStorage.php
@@ -47,32 +47,24 @@
 use OCP\Files\ObjectStore\IObjectStoreMultiPartUpload;
 use OCP\Files\Storage\IChunkedFileWrite;
 use OCP\Files\Storage\IStorage;
+use OCP\ILogger;
 
 class ObjectStoreStorage extends \OC\Files\Storage\Common implements IChunkedFileWrite {
 	use CopyDirectory;
 
-	/**
-	 * @var \OCP\Files\ObjectStore\IObjectStore $objectStore
-	 */
-	protected $objectStore;
-	/**
-	 * @var string $id
-	 */
-	protected $id;
-	/**
-	 * @var \OC\User\User $user
-	 */
-	protected $user;
-
-	private $objectPrefix = 'urn:oid:';
+	protected IObjectStore $objectStore;
+	protected string $id;
+	private string $objectPrefix = 'urn:oid:';
 
-	private $logger;
+	private ILogger $logger;
 
 	private bool $handleCopiesAsOwned;
+	protected bool $validateWrites = true;
 
-	/** @var bool */
-	protected $validateWrites = true;
-
+	/**
+	 * @param array $params
+	 * @throws \Exception
+	 */
 	public function __construct($params) {
 		if (isset($params['objectstore']) && $params['objectstore'] instanceof IObjectStore) {
 			$this->objectStore = $params['objectstore'];

diff --git a/tests/lib/Files/ObjectStore/ObjectStoreStorageOverwrite.php b/tests/lib/Files/ObjectStore/ObjectStoreStorageOverwrite.php
@@ -30,15 +30,15 @@
  * Allow overwriting the object store instance for test purposes
  */
 class ObjectStoreStorageOverwrite extends ObjectStoreStorage {
-	public function setObjectStore(IObjectStore $objectStore) {
+	public function setObjectStore(IObjectStore $objectStore): void {
 		$this->objectStore = $objectStore;
 	}
 
 	public function getObjectStore(): IObjectStore {
 		return $this->objectStore;
 	}
 
-	public function setValidateWrites(bool $validate) {
+	public function setValidateWrites(bool $validate): void {
 		$this->validateWrites = $validate;
 	}
 }