From 02525fd98bb3994199ebd877968574610f6898ee Mon Sep 17 00:00:00 2001 From: Roeland Jago Douma Date: Fri, 14 Oct 2016 19:27:14 +0200 Subject: [PATCH] Move preview endpoint to controller Signed-off-by: Roeland Jago Douma --- core/Controller/PreviewController.php | 123 ++++++++++++++++++++++++++ core/ajax/preview.php | 75 ---------------- core/ajax/preview2.php | 40 --------- core/routes.php | 8 +- lib/private/Preview2.php | 7 ++ 5 files changed, 132 insertions(+), 121 deletions(-) create mode 100644 core/Controller/PreviewController.php delete mode 100644 core/ajax/preview.php delete mode 100644 core/ajax/preview2.php diff --git a/core/Controller/PreviewController.php b/core/Controller/PreviewController.php new file mode 100644 index 0000000000..2dd62a2cec --- /dev/null +++ b/core/Controller/PreviewController.php @@ -0,0 +1,123 @@ + + * + * @author Roeland Jago Douma + * + * @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 . + * + */ + +namespace OC\Core\Controller; + +use OC\PreviewManager; +use OCP\AppFramework\Controller; +use OCP\Files\File; +use OCP\AppFramework\Http; +use OCP\AppFramework\Http\DataResponse; +use OCP\Files\IAppData; +use OCP\Files\IRootFolder; +use OCP\Files\NotFoundException; +use OCP\IConfig; +use OCP\IRequest; + +class PreviewController extends Controller { + + /** @var string */ + private $userId; + + /** @var IRootFolder */ + private $root; + + /** @var IConfig */ + private $config; + + /** @var PreviewManager */ + private $previewManager; + + /** @var IAppData */ + private $appData; + + public function __construct($appName, + IRequest $request, + IRootFolder $root, + IConfig $config, + PreviewManager $previewManager, + IAppData $appData, + $userId + ) { + parent::__construct($appName, $request); + + $this->previewManager = $previewManager; + $this->root = $root; + $this->config = $config; + $this->appData = $appData; + $this->userId = $userId; + } + + /** + * @NoAdminRequired + * @NoCSRFRequired + * + * @param string $file + * @param int $x + * @param int $y + * @param bool $a + * @param bool $forceIcon + * @param string $mode + * @return DataResponse|Http\FileDisplayResponse + */ + public function getPreview( + $file = '', + $x = 32, + $y = 32, + $a = false, + $forceIcon = true, + $mode = 'fill') { + + if ($file === '') { + return new DataResponse([], Http::STATUS_BAD_REQUEST); + } + + if ($x === 0 || $y === 0) { + return new DataResponse([], Http::STATUS_BAD_REQUEST); + } + + try { + $userFolder = $this->root->getUserFolder($this->userId); + $file = $userFolder->get($file); + } catch (NotFoundException $e) { + return new DataResponse([], Http::STATUS_NOT_FOUND); + } + + if (!($file instanceof File) || (!$forceIcon && !$this->previewManager->isAvailable($file))) { + return new DataResponse([], Http::STATUS_NOT_FOUND); + } else if (!$file->isReadable()) { + return new DataResponse([], Http::STATUS_FORBIDDEN); + } + + $preview = new \OC\Preview2( + $this->root, + $this->config, + $this->previewManager, + $file, + $this->appData + ); + + $f = $preview->getPreview($x, $y, !$a, $mode); + return new Http\FileDisplayResponse($f, Http::STATUS_OK, ['Content-Type' => $f->getMimeType()]); + } +} diff --git a/core/ajax/preview.php b/core/ajax/preview.php deleted file mode 100644 index aac623b5ce..0000000000 --- a/core/ajax/preview.php +++ /dev/null @@ -1,75 +0,0 @@ - - * @author Joas Schilling - * @author Lukas Reschke - * @author Morris Jobke - * @author Robin Appelman - * @author Thomas Müller - * - * @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 - * - */ -\OC_Util::checkLoggedIn(); -\OC::$server->getSession()->close(); - -$file = array_key_exists('file', $_GET) ? (string)$_GET['file'] : ''; -$maxX = array_key_exists('x', $_GET) ? (int)$_GET['x'] : '32'; -$maxY = array_key_exists('y', $_GET) ? (int)$_GET['y'] : '32'; -$scalingUp = array_key_exists('scalingup', $_GET) ? (bool)$_GET['scalingup'] : true; -$keepAspect = array_key_exists('a', $_GET) ? true : false; -$always = array_key_exists('forceIcon', $_GET) ? (bool)$_GET['forceIcon'] : true; -$mode = array_key_exists('mode', $_GET) ? $_GET['mode'] : 'fill'; - -if ($file === '') { - //400 Bad Request - \OC_Response::setStatus(400); - \OCP\Util::writeLog('core-preview', 'No file parameter was passed', \OCP\Util::DEBUG); - exit; -} - -if ($maxX === 0 || $maxY === 0) { - //400 Bad Request - \OC_Response::setStatus(400); - \OCP\Util::writeLog('core-preview', 'x and/or y set to 0', \OCP\Util::DEBUG); - exit; -} - -$folder = \OC::$server->getUserFolder(); - -try { - $file = $folder->get($file); -} catch (\OCP\Files\NotFoundException $e) { - return \OC_Response::setStatus(404); -} - -if (!$file instanceof OCP\Files\File || !$always && !\OC::$server->getPreviewManager()->isAvailable($file)) { - \OC_Response::setStatus(404); -} else if (!$info->isReadable()) { - \OC_Response::setStatus(403); -} else { - $preview = new \OC\Preview2( - \OC::$server->getRootFolder(), - \OC::$server->getConfig(), - \OC::$server->getPreviewManager(), - $file - ); - $image = $preview->getPreview($maxX, $maxY, !$keepAspect, $mode); - - header('Content-Type: ' . $image->getMimeType()); - echo $image->getContent(); -} diff --git a/core/ajax/preview2.php b/core/ajax/preview2.php deleted file mode 100644 index 7ac5028219..0000000000 --- a/core/ajax/preview2.php +++ /dev/null @@ -1,40 +0,0 @@ -getSession()->close(); - -$file = array_key_exists('file', $_GET) ? (string)$_GET['file'] : ''; -$maxX = array_key_exists('x', $_GET) ? (int)$_GET['x'] : '32'; -$maxY = array_key_exists('y', $_GET) ? (int)$_GET['y'] : '32'; -$keepAspect = array_key_exists('a', $_GET) ? true : false; -$always = array_key_exists('forceIcon', $_GET) ? (bool)$_GET['forceIcon'] : true; -$mode = array_key_exists('mode', $_GET) ? $_GET['mode'] : 'fill'; - -if ($file === '') { - //400 Bad Request - \OC_Response::setStatus(400); - \OCP\Util::writeLog('core-preview', 'No file parameter was passed', \OCP\Util::DEBUG); - exit; -} - -if ($maxX === 0 || $maxY === 0) { - //400 Bad Request - \OC_Response::setStatus(400); - \OCP\Util::writeLog('core-preview', 'x and/or y set to 0', \OCP\Util::DEBUG); - exit; -} - -$userFolder = \OC::$server->getUserFolder(); -$file = $userFolder->get($file); - -$p = new \OC\Preview2(\OC::$server->getRootFolder(), - \OC::$server->getConfig(), - \OC::$server->getPreviewManager(), - $file, - \OC::$server->getAppDataDir('preview')); - -$image = $p->getPreview($maxX, $maxY, !$keepAspect, $mode); - -header('Content-Type: ' . $image->getMimeType()); -echo $image->getContent(); - diff --git a/core/routes.php b/core/routes.php index 9ccf0e653e..c890d232cf 100644 --- a/core/routes.php +++ b/core/routes.php @@ -52,6 +52,8 @@ $application->registerRoutes($this, [ ['name' => 'TwoFactorChallenge#showChallenge', 'url' => '/login/challenge/{challengeProviderId}', 'verb' => 'GET'], ['name' => 'TwoFactorChallenge#solveChallenge', 'url' => '/login/challenge/{challengeProviderId}', 'verb' => 'POST'], ['name' => 'OCJS#getConfig', 'url' => '/core/js/oc.js', 'verb' => 'GET'], + ['name' => 'Preview#getPreview', 'url' => '/core/preview', 'verb' => 'GET'], + ['name' => 'Preview#getPreview', 'url' => '/core/preview.png', 'verb' => 'GET'], ], 'ocs' => [ ['root' => '/cloud', 'name' => 'OCS#getCapabilities', 'url' => '/capabilities', 'verb' => 'GET'], @@ -68,12 +70,6 @@ $application->registerRoutes($this, [ $this->create('search_ajax_search', '/core/search') ->actionInclude('core/search/ajax/search.php'); // Routing -$this->create('core_ajax_preview', '/core/preview') - ->actionInclude('core/ajax/preview2.php'); -$this->create('core_ajax_preview2', '/core/preview2') - ->actionInclude('core/ajax/preview2.php'); -$this->create('core_ajax_preview', '/core/preview.png') - ->actionInclude('core/ajax/preview2.php'); $this->create('core_ajax_update', '/core/ajax/update.php') ->actionInclude('core/ajax/update.php'); diff --git a/lib/private/Preview2.php b/lib/private/Preview2.php index 0a813dca63..e1f3af6ebd 100644 --- a/lib/private/Preview2.php +++ b/lib/private/Preview2.php @@ -53,6 +53,13 @@ class Preview2 { /** @var IAppData */ private $appData; + /** + * @param IRootFolder $rootFolder + * @param IConfig $config + * @param IPreview $previewManager + * @param File $file + * @param IAppData $appData + */ public function __construct( IRootFolder $rootFolder, IConfig $config,