Merge pull request #4 from nextcloud-gmbh/enh/albums

Add album fetch routes

1 files changed, 161 insertions, 0 deletions

diff --git a/lib/Controller/AlbumsController.php b/lib/Controller/AlbumsController.php
new file mode 100644
index 00000000..9b412ee8
--- /dev/null
+++ b/lib/Controller/AlbumsController.php
@@ -0,0 +1,161 @@
+<?php
+declare(strict_types=1);
+/**
+ * @copyright Copyright (c) 2019, Roeland Jago Douma <roeland@famdouma.nl>
+ *
+ * @author Roeland Jago Douma <roeland@famdouma.nl>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCA\Photos\Controller;
+
+use OCA\Files_Sharing\SharedStorage;
+use OCP\AppFramework\Controller;
+use OCP\AppFramework\Http;
+use OCP\AppFramework\Http\JSONResponse;
+use OCP\Files\File;
+use OCP\Files\Folder;
+use OCP\Files\IRootFolder;
+use OCP\FIles\Node;
+use OCP\Files\NotFoundException;
+use OCP\IRequest;
+
+class AlbumsController extends Controller {
+
+	/** @var string */
+	private $userId;
+	/** @var IRootFolder */
+	private $rootFolder;
+
+	public function __construct($appName, IRequest $request, string $userId, IRootFolder $rootFolder) {
+		parent::__construct($appName, $request);
+		$this->userId = $userId;
+		$this->rootFolder = $rootFolder;
+	}
+
+	/**
+	 * @NoAdminRequired
+	 */
+	public function myAlbums(string $path = ''): JSONResponse {
+		return $this->generate($path, false);
+	}
+
+	/**
+	 * @NoAdminRequired
+	 */
+	public function sharedAlbums(string $path = ''): JSONResponse {
+		return $this->generate($path, true);
+	}
+
+	private function generate(string $path, bool $shared): JSONResponse {
+		$userFolder = $this->rootFolder->getUserFolder($this->userId);
+
+		$folder = $userFolder;
+		if ($path !== '') {
+			try {
+				$folder = $userFolder->get($path);
+			} catch (NotFoundException $e) {
+				return new JSONResponse([], Http::STATUS_NOT_FOUND);
+			}
+		}
+
+		$data = $this->scanCurrentFolder($folder, $shared);
+		$result = $this->formatData($data);
+
+		return new JSONResponse($result, Http::STATUS_OK);
+	}
+
+	private function formatData(iterable $nodes): array {
+		$userFolder = $this->rootFolder->getUserFolder($this->userId);
+
+		$result = [];
+		/** @var Node $node */
+		foreach ($nodes as $node) {
+			// properly format full path and make sure
+			// we're relative to the user home folder
+			$isRoot = $node === $userFolder;
+			$path = $userFolder->getRelativePath($node->getPath());
+
+			$result[] = [
+				'basename' => $isRoot ? '' : $node->getName(),
+				'etag' => $node->getEtag(),
+				'fileid' => $node->getId(),
+				'filename' => $path,
+				'etag' => $node->getEtag(),
+				'lastmod' => $node->getMTime(),
+				'mime' => $node->getMimetype(),
+				'size' => $node->getSize(),
+				'type' => $node->getType()
+			];
+		}
+
+		return $result;
+	}
+
+	private function scanCurrentFolder(Folder $folder, bool $shared): iterable  {
+		$nodes = $folder->getDirectoryListing();
+
+		// add current folder to iterable set
+		yield $folder;
+
+		foreach ($nodes as $node) {
+			if ($node instanceof Folder) {
+				yield from $this->scanFolder($node, 0, $shared);
+			} elseif ($node instanceof File) {
+				if ($this->validFile($node, $shared)) {
+					yield $node;
+				}
+			}
+		}
+	}
+
+	private function validFile(File $file, bool $shared): bool {
+		if ($file->getMimePart() === 'image' && $this->isShared($file) === $shared) {
+			return true;
+		}
+
+		return false;
+	}
+
+	private function isShared(Node $node): bool {
+		return $node->getStorage()->instanceOfStorage(SharedStorage::class);
+	}
+
+	private function scanFolder(Folder $folder, int $depth, bool $shared): iterable {
+		if ($depth > 4) {
+			return [];
+		}
+
+		$nodes = $folder->getDirectoryListing();
+
+		foreach ($nodes as $node) {
+			if ($node instanceof File) {
+				if ($this->validFile($node, $shared)) {
+					yield $folder;
+					return [];
+				}
+			}
+		}
+
+		foreach ($nodes as $node) {
+			if ($node instanceof Folder && $this->isShared($node) === $shared) {
+				yield from $this->scanFolder($node, $depth + 1, $shared);
+			}
+		}
+	}
+}