owncloud/core

<?php
/**
 * @author Christoph Wurst <christoph@owncloud.com>
 * @author Joas Schilling <coding@schilljs.com>
 * @author Lukas Reschke <lukas@statuscode.ch>
 * @author Morris Jobke <hey@morrisjobke.de>
 * @author Roeland Jago Douma <rullzer@owncloud.com>
 * @author Thomas Müller <thomas.mueller@tmit.eu>
 * @author Tobias Kaminsky <tobias@kaminsky.me>
 * @author Vincent Petry <pvince81@owncloud.com>
 *
 * @copyright Copyright (c) 2018, ownCloud GmbH
 * @license AGPL-3.0
 *
 * This code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License, version 3,
 * as published by the Free Software Foundation.
 *
 * 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, version 3,
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
 *
 */

namespace OCA\Files\Controller;

use OCA\Files\Service\TagService;
use OCP\AppFramework\Controller;
use OCP\AppFramework\Http;
use OCP\AppFramework\Http\DataDisplayResponse;
use OCP\AppFramework\Http\DataResponse;
use OCP\AppFramework\Http\Response;
use OCP\IConfig;
use OCP\IPreview;
use OCP\IRequest;
use OCP\IUserSession;
use OCP\Share\IManager;

/**
 * Class ApiController
 *
 * @package OCA\Files\Controller
 */
class ApiController extends Controller {
    /** @var TagService */
    private $tagService;
    /** @var IManager **/
    private $shareManager;
    /** @var IPreview */
    private $previewManager;
    /** IUserSession */
    private $userSession;
    /** IConfig */
    private $config;

    /**
     * @param string $appName
     * @param IRequest $request
     * @param IUserSession $userSession
     * @param TagService $tagService
     * @param IPreview $previewManager
     * @param IManager $shareManager
     * @param IConfig $config
     */
    public function __construct(
        $appName,
        IRequest $request,
        IUserSession $userSession,
        TagService $tagService,
        IPreview $previewManager,
        IManager $shareManager,
        IConfig $config
    ) {
        parent::__construct($appName, $request);
        $this->userSession = $userSession;
        $this->tagService = $tagService;
        $this->previewManager = $previewManager;
        $this->shareManager = $shareManager;
        $this->config = $config;
    }

    /**
     * Gets a thumbnail of the specified file
     *
     * @since API version 1.0
     *
     * @NoAdminRequired
     * @NoCSRFRequired
     *
     * @param int $x
     * @param int $y
     * @param string $file URL-encoded filename
     * @return DataResponse|DataDisplayResponse
     */
    public function getThumbnail($x, $y, $file) {
        if ($x < 1 || $y < 1) {
            return new DataResponse(['message' => 'Requested size must be numeric and a positive value.'], Http::STATUS_BAD_REQUEST);
        }

        $preview = $this->previewManager->createPreview('files/'.$file, $x, $y, true);
        if ($preview->valid()) {
            return new DataDisplayResponse($preview->data(), Http::STATUS_OK, ['Content-Type' => 'image/png']);
        } else {
            return new DataResponse(['message' => 'File not found.'], Http::STATUS_NOT_FOUND);
        }
    }

    /**
     * Updates the info of the specified file path
     * The passed tags are absolute, which means they will
     * replace the actual tag selection.
     *
     * @NoAdminRequired
     *
     * @param string $path path
     * @param array|string $tags array of tags
     * @return DataResponse
     */
    public function updateFileTags($path, $tags = null) {
        $result = [];
        // if tags specified or empty array, update tags
        if ($tags !== null) {
            try {
                $this->tagService->updateFileTags($path, $tags);
            } catch (\OCP\Files\NotFoundException $e) {
                return new DataResponse([
                    'message' => $e->getMessage()
                ], Http::STATUS_NOT_FOUND);
            } catch (\OCP\Files\StorageNotAvailableException $e) {
                return new DataResponse([
                    'message' => $e->getMessage()
                ], Http::STATUS_SERVICE_UNAVAILABLE);
            } catch (\Exception $e) {
                return new DataResponse([
                    'message' => $e->getMessage()
                ], Http::STATUS_NOT_FOUND);
            }
            $result['tags'] = $tags;
        }
        return new DataResponse($result);
    }

    /**
     * Change the default sort mode
     *
     * @NoAdminRequired
     *
     * @param string $mode
     * @param string $direction
     * @param string $view
     * @return Response
     */
    public function updateFileSorting($mode, $direction, $view = 'files') {
        // currently we only store for the files view
        if ($view !== 'files') {
            return new Response();
        }
        // TODO: also store for every view individually and allow for more modes
        $allowedMode = ['name', 'size', 'mtime'];
        $allowedDirection = ['asc', 'desc'];
        if (!\in_array($mode, $allowedMode) || !\in_array($direction, $allowedDirection)) {
            $response = new Response();
            $response->setStatus(Http::STATUS_UNPROCESSABLE_ENTITY);
            return $response;
        }
        $this->config->setUserValue($this->userSession->getUser()->getUID(), 'files', 'file_sorting', $mode);
        $this->config->setUserValue($this->userSession->getUser()->getUID(), 'files', 'file_sorting_direction', $direction);
        return new Response();
    }

    /**
     * Toggle default for showing/hiding hidden files
     *
     * @NoAdminRequired
     *
     * @param bool $show
     * @return Response
     */
    public function showHiddenFiles($show) {
        $this->config->setUserValue($this->userSession->getUser()->getUID(), 'files', 'show_hidden', (int) $show);
        return new Response();
    }
}