memories/lib/Controller/ApiController.php

<?php

declare(strict_types=1);
/**
 * @copyright Copyright (c) 2020 John Molakvoæ <skjnldsv@protonmail.com>
 *
 * @author John Molakvoæ <skjnldsv@protonmail.com>
 *
 * @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 <http://www.gnu.org/licenses/>.
 *
 */

namespace OCA\Memories\Controller;

use OC\Files\Search\SearchComparison;
use OC\Files\Search\SearchQuery;
use OCA\Memories\AppInfo\Application;
use OCA\Memories\Db\TimelineQuery;
use OCA\Memories\Exif;
use OCP\AppFramework\Controller;
use OCP\AppFramework\Http;
use OCP\AppFramework\Http\JSONResponse;
use OCP\Files\IRootFolder;
use OCP\IConfig;
use OCP\IDBConnection;
use OCP\IRequest;
use OCP\IUserSession;
use OCP\Files\FileInfo;
use OCP\Files\Folder;
use OCP\Files\Search\ISearchComparison;

class ApiController extends Controller {
    private IConfig $config;
    private IUserSession $userSession;
    private IDBConnection $connection;
    private IRootFolder $rootFolder;
    private TimelineQuery $timelineQuery;

    public function __construct(
        IRequest $request,
        IConfig $config,
        IUserSession $userSession,
        IDBConnection $connection,
        IRootFolder $rootFolder) {

        parent::__construct(Application::APPNAME, $request);

        $this->config = $config;
        $this->userSession = $userSession;
        $this->connection = $connection;
        $this->rootFolder = $rootFolder;
        $this->timelineQuery = new TimelineQuery($this->connection);
    }

    /**
     * Get transformations depending on the request
     */
    private function getTransformations() {
        $transforms = array();

        // Filter only favorites
        if ($this->request->getParam('fav')) {
            $transforms[] = array($this->timelineQuery, 'transformFavoriteFilter');
        }

        // Filter only videos
        if ($this->request->getParam('vid')) {
            $transforms[] = array($this->timelineQuery, 'videoFilter');
        }

        return $transforms;
    }

    /** Preload a few "day" at the start of "days" response */
    private function preloadDays(array &$days, Folder &$folder, bool $recursive) {
        $uid = $this->userSession->getUser()->getUID();
        $transforms = $this->getTransformations();
        $preloaded = 0;
        foreach ($days as &$day) {
            $day["detail"] = $this->timelineQuery->getDay(
                $folder,
                $uid,
                $day["dayid"],
                $recursive,
                $transforms,
            );
            $day["count"] = count($day["detail"]); // make sure count is accurate
            $preloaded += $day["count"];

            if ($preloaded >= 50) { // should be enough
                break;
            }
        }
    }

    /** Get the Folder object relevant to the request */
    private function getRequestFolder() {
        $uid = $this->userSession->getUser()->getUID();
        try {
            $folder = null;
            $folderPath = $this->request->getParam('folder');
            $userFolder = $this->rootFolder->getUserFolder($uid);

            if (!is_null($folderPath)) {
                $folder = $userFolder->get($folderPath);
            } else {
                $configPath = Exif::removeExtraSlash(Exif::getPhotosPath($this->config, $uid));
                $folder = $userFolder->get($configPath);
            }

            if (!$folder instanceof Folder) {
                throw new \Exception("Folder not found");
            }
        } catch (\Exception $e) {
            return null;
        }
        return $folder;
    }

    /**
     * @NoAdminRequired
     *
     * @return JSONResponse
     */
    public function days(): JSONResponse {
        $user = $this->userSession->getUser();
        if (is_null($user)) {
            return new JSONResponse([], Http::STATUS_PRECONDITION_FAILED);
        }
        $uid = $user->getUID();

        // Get the folder to show
        $folder = $this->getRequestFolder();
        $recursive = is_null($this->request->getParam('folder'));
        if (is_null($folder)) {
            return new JSONResponse([], Http::STATUS_NOT_FOUND);
        }

        // Run actual query
        $list = $this->timelineQuery->getDays(
            $folder,
            $uid,
            $recursive,
            $this->getTransformations(),
        );

        // Preload some day responses
        $this->preloadDays($list, $folder, $recursive);

        // Add subfolder info if querying non-recursively
        if (!$recursive) {
            $this->addSubfolders($folder, $list, $user);
        }

        return new JSONResponse($list, Http::STATUS_OK);
    }

    /**
     * @NoAdminRequired
     *
     * @return JSONResponse
     */
    public function day(string $id): JSONResponse {
        $user = $this->userSession->getUser();
        if (is_null($user)) {
            return new JSONResponse([], Http::STATUS_PRECONDITION_FAILED);
        }
        $uid = $user->getUID();

        // Get the folder to show
        $folder = $this->getRequestFolder();
        $recursive = is_null($this->request->getParam('folder'));
        if (is_null($folder)) {
            return new JSONResponse([], Http::STATUS_NOT_FOUND);
        }

        // Run actual query
        $list = $this->timelineQuery->getDay(
            $folder,
            $uid,
            intval($id),
            $recursive,
            $this->getTransformations(),
        );
        return new JSONResponse($list, Http::STATUS_OK);
    }

    /**
     * @NoAdminRequired
     */
    public function addSubfolders(Folder &$folder, &$list, &$user) {
        // Get subdirectories
        $sub = $folder->search(new SearchQuery(
            new SearchComparison(ISearchComparison::COMPARE_EQUAL, 'mimetype', FileInfo::MIMETYPE_FOLDER),
            0, 0, [], $user));
        $sub = array_filter($sub, function ($item) use (&$folder) {
            return $item->getParent()->getId() === $folder->getId();
        });

        // Sort by name
        usort($sub, function($a, $b) {
            return strnatcmp($a->getName(), $b->getName());
        });

        // Map sub to JSON array
        $subdirArray = [
            "dayid" => \OCA\Memories\Util::$TAG_DAYID_FOLDERS,
            "detail" => array_map(function (&$node) {
                return [
                    "fileid" => $node->getId(),
                    "name" => $node->getName(),
                    "isfolder" => 1,
                    "path" => $node->getPath(),
                ];
            }, $sub, []),
        ];
        $subdirArray["count"] = count($subdirArray["detail"]);
        array_unshift($list, $subdirArray);
    }

    /**
     * @NoAdminRequired
     *
     * update preferences (user setting)
     *
     * @param string key the identifier to change
     * @param string value the value to set
     *
     * @return JSONResponse an empty JSONResponse with respective http status code
     */
    public function setUserConfig(string $key, string $value): JSONResponse {
        $user = $this->userSession->getUser();
        if (is_null($user)) {
            return new JSONResponse([], Http::STATUS_PRECONDITION_FAILED);
        }

        $userId = $user->getUid();
        $this->config->setUserValue($userId, Application::APPNAME, $key, $value);
        return new JSONResponse([], Http::STATUS_OK);
    }
}