feat: Add Folder::getOrCreateFolder api

Allow to remove some boilerplate and also this new function is type
safe.

Signed-off-by: Carl Schwan <[email protected]>

Author: CarlSchwan

lib/private/Files/Node/Folder.php

@@ -16,6 +16,7 @@
 use OC\User\LazyUser;
 use OCP\Files\Cache\ICacheEntry;
 use OCP\Files\FileInfo;
+use OCP\Files\Folder as IFolder;
 use OCP\Files\Mount\IMountPoint;
 use OCP\Files\Node as INode;
 use OCP\Files\NotFoundException;
@@ -26,8 +27,9 @@
 use OCP\Files\Search\ISearchOrder;
 use OCP\Files\Search\ISearchQuery;
 use OCP\IUserManager;
+use Override;
 
-class Folder extends Node implements \OCP\Files\Folder {
+class Folder extends Node implements IFolder {
 
 	private ?IUserManager $userManager = null;
 
@@ -480,4 +482,28 @@ private function recreateIfNeeded(): void {
 			$this->wasDeleted = false;
 		}
 	}
+
+	#[Override]
+	public function getOrCreateFolder(string $path, int $maxRetries = 5): IFolder {
+		$i = 0;
+		while (true) {
+			$path = $i === 0 ? $path : $path . ' (' . $i . ')';
+			try {
+				$folder = $this->get($path);
+				if ($folder instanceof IFolder) {
+					return $folder;
+				}
+			} catch (NotFoundException) {
+				$folder = $this->get(dirname($path));
+				if (!($folder instanceof Folder)) {
+					throw new NotPermittedException("Unable to create folder $path. Parent is not a directory.");
+				}
+				return $folder->newFolder(basename($path));
+			}
+			$i++;
+			if ($i > 5) {
+				throw new NotPermittedException('Unable to load or create folder.');
+			}
+		}
+	}
 }

lib/private/Files/Node/LazyFolder.php

@@ -14,6 +14,7 @@
 use OCP\Files\IRootFolder;
 use OCP\Files\Mount\IMountPoint;
 use OCP\Files\NotPermittedException;
+use Override;
 
 /**
  * Class LazyFolder
@@ -138,6 +139,11 @@ public function get($path) {
 		return $this->getRootFolder()->get($this->getFullPath($path));
 	}
 
+	#[Override]
+	public function getOrCreateFolder(string $path, int $maxRetries = 5): Folder {
+		return $this->getRootFolder()->getOrCreateFolder($this->getFullPath($path), $maxRetries);
+	}
+
 	/**
 	 * @inheritDoc
 	 */

lib/private/Files/Template/TemplateManager.php

@@ -355,14 +355,7 @@ public function initializeTemplateDirectory(?string $path = null, ?string $userI
 				}
 			}
 
-			try {
-				/** @var Folder $folder */
-				$folder = $userFolder->get($userTemplatePath);
-			} catch (NotFoundException $e) {
-				/** @var Folder $folder */
-				$folder = $userFolder->get(dirname($userTemplatePath));
-				$folder = $folder->newFolder(basename($userTemplatePath));
-			}
+			$folder = $userFolder->getOrCreateFolder($userTemplatePath);
 
 			$folderIsEmpty = count($folder->getDirectoryListing()) === 0;
 

lib/public/Files/Folder.php

@@ -65,6 +65,15 @@ public function getDirectoryListing();
 	 */
 	public function get($path);
 
+	/**
+	 * Get or create new folder if the folder does not already exist.
+	 *
+	 * @param string $path relative path of the file or folder
+	 * @throw \OCP\Files\NotPermittedException
+	 * @since 33.0.0
+	 */
+	public function getOrCreateFolder(string $path, int $maxRetries = 5): Folder;
+
 	/**
 	 * Check if a file or folder exists in the folder
 	 *