* @author Varun Patil * @license AGPL-3.0-or-later * * 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 . */ namespace OCA\Memories\Controller; use OCA\Memories\AppInfo\Application; use OCA\Memories\Db\TimelineQuery; use OCA\Memories\Db\TimelineRoot; use OCA\Memories\Db\TimelineWrite; use OCA\Memories\Exif; use OCP\App\IAppManager; use OCP\AppFramework\Controller; use OCP\AppFramework\Http; use OCP\AppFramework\Http\JSONResponse; use OCP\Encryption\IManager; use OCP\Files\File; use OCP\Files\Folder; use OCP\Files\IRootFolder; use OCP\IConfig; use OCP\IDBConnection; use OCP\IPreview; use OCP\IRequest; use OCP\IUserSession; use OCP\Share\IManager as IShareManager; class ApiBase extends Controller { protected IConfig $config; protected IUserSession $userSession; protected IRootFolder $rootFolder; protected IAppManager $appManager; protected IManager $encryptionManager; protected TimelineQuery $timelineQuery; protected TimelineWrite $timelineWrite; protected IShareManager $shareManager; protected IPreview $previewManager; public function __construct( IRequest $request, IConfig $config, IUserSession $userSession, IDBConnection $connection, IRootFolder $rootFolder, IAppManager $appManager, IManager $encryptionManager, IShareManager $shareManager, IPreview $preview ) { parent::__construct(Application::APPNAME, $request); $this->config = $config; $this->userSession = $userSession; $this->connection = $connection; $this->rootFolder = $rootFolder; $this->appManager = $appManager; $this->encryptionManager = $encryptionManager; $this->shareManager = $shareManager; $this->previewManager = $preview; $this->timelineQuery = new TimelineQuery($connection); $this->timelineWrite = new TimelineWrite($connection, $preview); } /** Get logged in user's UID or throw HTTP error */ protected function getUid(): string { $user = $this->userSession->getUser(); if ($this->getShareToken()) { $user = null; } elseif (null === $user) { return new JSONResponse([], Http::STATUS_PRECONDITION_FAILED); } return $user ? $user->getUID() : ''; } /** Get the TimelineRoot object relevant to the request */ protected function getRequestRoot() { $root = new TimelineRoot(); // Albums have no folder if ($this->request->getParam('album')) { return $root; } // Public shared folder if ($share = $this->getShareNode()) { // can throw $root->addFolder($share); return $root; } // Anything else needs a user $user = $this->userSession->getUser(); if (null === $user) { throw new \Exception('User not logged in'); } $uid = $user->getUID(); $folder = null; $folderPath = $this->request->getParam('folder'); $userFolder = $this->rootFolder->getUserFolder($uid); try { if (null !== $folderPath) { $folder = $userFolder->get(Exif::removeExtraSlash($folderPath)); $root->addFolder($folder); } else { $timelinePath = $this->request->getParam('timelinePath', Exif::getPhotosPath($this->config, $uid)); $timelinePath = Exif::removeExtraSlash($timelinePath); // Multiple timeline path support $paths = explode(';', $timelinePath); foreach ($paths as &$path) { $folder = $userFolder->get(trim($path)); $root->addFolder($folder); } $root->addMountPoints(); } } catch (\OCP\Files\NotFoundException $e) { $msg = $e->getMessage(); throw new \Exception("Folder not found: {$msg}"); } return $root; } /** * Get a file with ID for the current user. */ protected function getUserFile(int $fileId): ?File { return $this->getUserFolderFile($fileId) ?? $this->getAlbumFile($fileId) ?? $this->getShareFile($fileId); } /** * Get a file with ID from user's folder. */ protected function getUserFolderFile(int $id): ?File { $user = $this->userSession->getUser(); if (null === $user) { return null; } $userFolder = $this->rootFolder->getUserFolder($user->getUID()); return $this->getOneFileFromFolder($userFolder, $id); } /** * Get a file with ID from an album. */ protected function getAlbumFile(int $id): ?File { $user = $this->userSession->getUser(); if (null === $user) { return null; } $uid = $user->getUID(); if (!$this->timelineQuery->albumHasUserFile($uid, $id)) { return null; } return $this->getOneFileFromFolder($this->rootFolder, $id); } /** * Get a file with ID from a public share. * * @param int $fileId */ protected function getShareFile(int $id): ?File { try { if ($share = $this->getShareNode()) { return $this->getOneFileFromFolder($share, $id); } } catch (\Exception $e) { } return null; } protected function isRecursive() { return null === $this->request->getParam('folder'); } protected function isArchive() { return null !== $this->request->getParam('archive'); } protected function isMonthView() { return null !== $this->request->getParam('monthView'); } protected function isReverse() { return null !== $this->request->getParam('reverse'); } protected function getShareToken() { return $this->request->getParam('folder_share'); } protected function getShareNode() { $token = $this->getShareToken(); if (null === $token) { return null; } $share = $this->shareManager->getShareByToken($token)->getNode(); // throws exception if not found if (!$share instanceof Folder || !$share->isReadable() || !$share->isShareable()) { throw new \Exception('Share not found or invalid'); } return $share; } /** * Check if albums are enabled for this user. */ protected function albumsIsEnabled(): bool { return \OCA\Memories\Util::albumsIsEnabled($this->appManager); } /** * Check if tags is enabled for this user. */ protected function tagsIsEnabled(): bool { return \OCA\Memories\Util::tagsIsEnabled($this->appManager); } /** * Check if recognize is enabled for this user. */ protected function recognizeIsEnabled(): bool { return \OCA\Memories\Util::recognizeIsEnabled($this->appManager); } /** * Helper to get one file or null from a fiolder. */ private function getOneFileFromFolder(Folder $folder, int $id): ?File { // Check for permissions and get numeric Id $file = $folder->getById($id); if (0 === \count($file)) { return null; } // Check if node is a file if (!$file[0] instanceof File) { return null; } // Check read permission if (!($file[0]->getPermissions() & \OCP\Constants::PERMISSION_READ)) { return null; } return $file[0]; } }