1 files changed, 220 insertions, 182 deletions

diff --git a/apps/files/lib/Controller/ViewController.php b/apps/files/lib/Controller/ViewController.php
index fa8243822a8..ecf21cef313 100644
--- a/apps/files/lib/Controller/ViewController.php
+++ b/apps/files/lib/Controller/ViewController.php
@@ -1,268 +1,306 @@
 <?php
+
 /**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- *
- * @author Christoph Wurst <christoph@owncloud.com>
- * @author Joas Schilling <coding@schilljs.com>
- * @author Lukas Reschke <lukas@statuscode.ch>
- * @author Roeland Jago Douma <roeland@famdouma.nl>
- * @author Thomas Müller <thomas.mueller@tmit.eu>
- * @author Vincent Petry <pvince81@owncloud.com>
- *
- * @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/>
- *
+ * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
+ * SPDX-License-Identifier: AGPL-3.0-only
  */
-
 namespace OCA\Files\Controller;
 
+use OC\Files\FilenameValidator;
+use OC\Files\Filesystem;
+use OCA\Files\AppInfo\Application;
+use OCA\Files\Event\LoadAdditionalScriptsEvent;
+use OCA\Files\Event\LoadSearchPlugins;
+use OCA\Files\Event\LoadSidebar;
+use OCA\Files\Service\UserConfig;
+use OCA\Files\Service\ViewConfig;
+use OCA\Viewer\Event\LoadViewer;
+use OCP\App\IAppManager;
 use OCP\AppFramework\Controller;
+use OCP\AppFramework\Http\Attribute\NoAdminRequired;
+use OCP\AppFramework\Http\Attribute\NoCSRFRequired;
+use OCP\AppFramework\Http\Attribute\OpenAPI;
 use OCP\AppFramework\Http\ContentSecurityPolicy;
 use OCP\AppFramework\Http\RedirectResponse;
+use OCP\AppFramework\Http\Response;
 use OCP\AppFramework\Http\TemplateResponse;
+use OCP\AppFramework\Services\IInitialState;
+use OCP\Authentication\TwoFactorAuth\IRegistry;
+use OCP\Collaboration\Resources\LoadAdditionalScriptsEvent as ResourcesLoadAdditionalScriptsEvent;
+use OCP\EventDispatcher\IEventDispatcher;
+use OCP\Files\Folder;
 use OCP\Files\IRootFolder;
 use OCP\Files\NotFoundException;
+use OCP\Files\Template\ITemplateManager;
 use OCP\IConfig;
 use OCP\IL10N;
 use OCP\IRequest;
 use OCP\IURLGenerator;
 use OCP\IUserSession;
-use Symfony\Component\EventDispatcher\EventDispatcherInterface;
-use OCP\Files\Folder;
-use OCP\App\IAppManager;
-use Symfony\Component\EventDispatcher\GenericEvent;
+use OCP\Util;
 
 /**
- * Class ViewController
- *
  * @package OCA\Files\Controller
  */
+#[OpenAPI(scope: OpenAPI::SCOPE_IGNORE)]
 class ViewController extends Controller {
-	/** @var string */
-	protected $appName;
-	/** @var IRequest */
-	protected $request;
-	/** @var IURLGenerator */
-	protected $urlGenerator;
-	/** @var IL10N */
-	protected $l10n;
-	/** @var IConfig */
-	protected $config;
-	/** @var EventDispatcherInterface */
-	protected $eventDispatcher;
-	/** @var IUserSession */
-	protected $userSession;
-	/** @var IAppManager */
-	protected $appManager;
-	/** @var IRootFolder */
-	protected $rootFolder;
 
-	/**
-	 * @param string $appName
-	 * @param IRequest $request
-	 * @param IURLGenerator $urlGenerator
-	 * @param IL10N $l10n
-	 * @param IConfig $config
-	 * @param EventDispatcherInterface $eventDispatcherInterface
-	 * @param IUserSession $userSession
-	 * @param IAppManager $appManager
-	 * @param IRootFolder $rootFolder
-	 */
-	public function __construct($appName,
-								IRequest $request,
-								IURLGenerator $urlGenerator,
-								IL10N $l10n,
-								IConfig $config,
-								EventDispatcherInterface $eventDispatcherInterface,
-								IUserSession $userSession,
-								IAppManager $appManager,
-								IRootFolder $rootFolder
+	public function __construct(
+		string $appName,
+		IRequest $request,
+		private IURLGenerator $urlGenerator,
+		private IL10N $l10n,
+		private IConfig $config,
+		private IEventDispatcher $eventDispatcher,
+		private IUserSession $userSession,
+		private IAppManager $appManager,
+		private IRootFolder $rootFolder,
+		private IInitialState $initialState,
+		private ITemplateManager $templateManager,
+		private UserConfig $userConfig,
+		private ViewConfig $viewConfig,
+		private FilenameValidator $filenameValidator,
+		private IRegistry $twoFactorRegistry,
 	) {
 		parent::__construct($appName, $request);
-		$this->appName = $appName;
-		$this->request = $request;
-		$this->urlGenerator = $urlGenerator;
-		$this->l10n = $l10n;
-		$this->config = $config;
-		$this->eventDispatcher = $eventDispatcherInterface;
-		$this->userSession = $userSession;
-		$this->appManager = $appManager;
-		$this->rootFolder = $rootFolder;
 	}
 
 	/**
-	 * @param string $appName
-	 * @param string $scriptName
-	 * @return string
+	 * FIXME: Replace with non static code
+	 *
+	 * @return array
+	 * @throws NotFoundException
+	 */
+	protected function getStorageInfo(string $dir = '/') {
+		$rootInfo = Filesystem::getFileInfo('/', false);
+
+		return \OC_Helper::getStorageInfo($dir, $rootInfo ?: null);
+	}
+
+	/**
+	 * @param string $fileid
+	 * @return TemplateResponse|RedirectResponse
 	 */
-	protected function renderScript($appName, $scriptName) {
-		$content = '';
-		$appPath = \OC_App::getAppPath($appName);
-		$scriptPath = $appPath . '/' . $scriptName;
-		if (file_exists($scriptPath)) {
-			// TODO: sanitize path / script name ?
-			ob_start();
-			include $scriptPath;
-			$content = ob_get_contents();
-			@ob_end_clean();
+	#[NoAdminRequired]
+	#[NoCSRFRequired]
+	public function showFile(?string $fileid = null, ?string $opendetails = null, ?string $openfile = null): Response {
+		if (!$fileid) {
+			return new RedirectResponse($this->urlGenerator->linkToRoute('files.view.index'));
+		}
+
+		// This is the entry point from the `/f/{fileid}` URL which is hardcoded in the server.
+		try {
+			return $this->redirectToFile((int)$fileid, $opendetails, $openfile);
+		} catch (NotFoundException $e) {
+			// Keep the fileid even if not found, it will be used
+			// to detect the file could not be found and warn the user
+			return new RedirectResponse($this->urlGenerator->linkToRoute('files.view.indexViewFileid', ['fileid' => $fileid, 'view' => 'files']));
 		}
-		return $content;
 	}
 
+
 	/**
-	 * FIXME: Replace with non static code
-	 *
-	 * @return array
-	 * @throws \OCP\Files\NotFoundException
+	 * @param string $dir
+	 * @param string $view
+	 * @param string $fileid
+	 * @return TemplateResponse|RedirectResponse
 	 */
-	protected function getStorageInfo() {
-		$dirInfo = \OC\Files\Filesystem::getFileInfo('/', false);
-		return \OC_Helper::getStorageInfo('/', $dirInfo);
+	#[NoAdminRequired]
+	#[NoCSRFRequired]
+	public function indexView($dir = '', $view = '', $fileid = null) {
+		return $this->index($dir, $view, $fileid);
+	}
+
+	/**
+	 * @param string $dir
+	 * @param string $view
+	 * @param string $fileid
+	 * @return TemplateResponse|RedirectResponse
+	 */
+	#[NoAdminRequired]
+	#[NoCSRFRequired]
+	public function indexViewFileid($dir = '', $view = '', $fileid = null) {
+		return $this->index($dir, $view, $fileid);
 	}
 
 	/**
-	 * @NoCSRFRequired
-	 * @NoAdminRequired
-	 *
 	 * @param string $dir
 	 * @param string $view
 	 * @param string $fileid
 	 * @return TemplateResponse|RedirectResponse
 	 */
-	public function index($dir = '', $view = '', $fileid = null, $fileNotFound = false) {
-		if ($fileid !== null) {
+	#[NoAdminRequired]
+	#[NoCSRFRequired]
+	public function index($dir = '', $view = '', $fileid = null) {
+		if ($fileid !== null && $view !== 'trashbin') {
 			try {
-				return $this->showFile($fileid);
+				return $this->redirectToFileIfInTrashbin((int)$fileid);
 			} catch (NotFoundException $e) {
-				return new RedirectResponse($this->urlGenerator->linkToRoute('files.view.index', ['fileNotFound' => true]));
 			}
 		}
 
-		$nav = new \OCP\Template('files', 'appnavigation', '');
-
 		// Load the files we need
-		\OCP\Util::addStyle('files', 'merged');
-		\OCP\Util::addScript('files', 'merged-index');
-
-		// mostly for the home storage's free space
-		// FIXME: Make non static
-		$storageInfo = $this->getStorageInfo();
-
-		\OCA\Files\App::getNavigationManager()->add(
-			[
-				'id' => 'favorites',
-				'appname' => 'files',
-				'script' => 'simplelist.php',
-				'order' => 5,
-				'name' => $this->l10n->t('Favorites')
-			]
-		);
+		Util::addInitScript('files', 'init');
+		Util::addScript('files', 'main');
 
-		$navItems = \OCA\Files\App::getNavigationManager()->getAll();
-		usort($navItems, function($item1, $item2) {
-			return $item1['order'] - $item2['order'];
-		});
-		$nav->assign('navigationItems', $navItems);
+		$user = $this->userSession->getUser();
+		$userId = $user->getUID();
 
+		// If the file doesn't exists in the folder and
+		// exists in only one occurrence, redirect to that file
+		// in the correct folder
+		if ($fileid && $dir !== '') {
+			$baseFolder = $this->rootFolder->getUserFolder($userId);
+			$nodes = $baseFolder->getById((int)$fileid);
+			if (!empty($nodes)) {
+				$nodePath = $baseFolder->getRelativePath($nodes[0]->getPath());
+				$relativePath = $nodePath ? dirname($nodePath) : '';
+				// If the requested path does not contain the file id
+				// or if the requested path is not the file id itself
+				if (count($nodes) === 1 && $relativePath !== $dir && $nodePath !== $dir) {
+					return $this->redirectToFile((int)$fileid);
+				}
+			}
+		}
 
-		$nav->assign('usage', \OC_Helper::humanFileSize($storageInfo['used']));
-		if ($storageInfo['quota'] === \OCP\Files\FileInfo::SPACE_UNLIMITED) {
-			$totalSpace = $this->l10n->t('Unlimited');
-		} else {
-			$totalSpace = \OC_Helper::humanFileSize($storageInfo['total']);
+		try {
+			// If view is files, we use the directory, otherwise we use the root storage
+			$storageInfo = $this->getStorageInfo(($view === 'files' && $dir) ? $dir : '/');
+		} catch (\Exception $e) {
+			$storageInfo = $this->getStorageInfo();
 		}
-		$nav->assign('total_space', $totalSpace);
-		$nav->assign('quota', $storageInfo['quota']);
-		$nav->assign('usage_relative', $storageInfo['relative']);
 
-		$contentItems = [];
+		$this->initialState->provideInitialState('storageStats', $storageInfo);
+		$this->initialState->provideInitialState('config', $this->userConfig->getConfigs());
+		$this->initialState->provideInitialState('viewConfigs', $this->viewConfig->getConfigs());
 
-		// render the container content for every navigation item
-		foreach ($navItems as $item) {
-			$content = '';
-			if (isset($item['script'])) {
-				$content = $this->renderScript($item['appname'], $item['script']);
-			}
-			$contentItem = [];
-			$contentItem['id'] = $item['id'];
-			$contentItem['content'] = $content;
-			$contentItems[] = $contentItem;
+		// File sorting user config
+		$filesSortingConfig = json_decode($this->config->getUserValue($userId, 'files', 'files_sorting_configs', '{}'), true);
+		$this->initialState->provideInitialState('filesSortingConfig', $filesSortingConfig);
+
+		// Forbidden file characters (deprecated use capabilities)
+		// TODO: Remove with next release of `@nextcloud/files`
+		$forbiddenCharacters = $this->filenameValidator->getForbiddenCharacters();
+		$this->initialState->provideInitialState('forbiddenCharacters', $forbiddenCharacters);
+
+		$event = new LoadAdditionalScriptsEvent();
+		$this->eventDispatcher->dispatchTyped($event);
+		$this->eventDispatcher->dispatchTyped(new ResourcesLoadAdditionalScriptsEvent());
+		$this->eventDispatcher->dispatchTyped(new LoadSidebar());
+		$this->eventDispatcher->dispatchTyped(new LoadSearchPlugins());
+		// Load Viewer scripts
+		if (class_exists(LoadViewer::class)) {
+			$this->eventDispatcher->dispatchTyped(new LoadViewer());
 		}
 
-		$event = new GenericEvent(null, ['hiddenFields' => []]);
-		$this->eventDispatcher->dispatch('OCA\Files::loadAdditionalScripts', $event);
+		$this->initialState->provideInitialState('templates_enabled', ($this->config->getSystemValueString('skeletondirectory', \OC::$SERVERROOT . '/core/skeleton') !== '') || ($this->config->getSystemValueString('templatedirectory', \OC::$SERVERROOT . '/core/skeleton/Templates') !== ''));
+		$this->initialState->provideInitialState('templates_path', $this->templateManager->hasTemplateDirectory() ? $this->templateManager->getTemplatePath() : false);
+		$this->initialState->provideInitialState('templates', $this->templateManager->listCreators());
 
-		$params = [];
-		$params['usedSpacePercent'] = (int)$storageInfo['relative'];
-		$params['owner'] = $storageInfo['owner'];
-		$params['ownerDisplayName'] = $storageInfo['ownerDisplayName'];
-		$params['isPublic'] = false;
-		$params['allowShareWithLink'] = $this->config->getAppValue('core', 'shareapi_allow_links', 'yes');
-		$user = $this->userSession->getUser()->getUID();
-		$params['defaultFileSorting'] = $this->config->getUserValue($user, 'files', 'file_sorting', 'name');
-		$params['defaultFileSortingDirection'] = $this->config->getUserValue($user, 'files', 'file_sorting_direction', 'asc');
-		$showHidden = (bool) $this->config->getUserValue($this->userSession->getUser()->getUID(), 'files', 'show_hidden', false);
-		$params['showHiddenFiles'] = $showHidden ? 1 : 0;
-		$params['fileNotFound'] = $fileNotFound ? 1 : 0;
-		$params['appNavigation'] = $nav;
-		$params['appContents'] = $contentItems;
-		$params['hiddenFields'] = $event->getArgument('hiddenFields');
+		$isTwoFactorEnabled = false;
+		foreach ($this->twoFactorRegistry->getProviderStates($user) as $providerId => $providerState) {
+			if ($providerId !== 'backup_codes' && $providerState === true) {
+				$isTwoFactorEnabled = true;
+			}
+		}
+
+		$this->initialState->provideInitialState('isTwoFactorEnabled', $isTwoFactorEnabled);
 
 		$response = new TemplateResponse(
-			$this->appName,
+			Application::APP_ID,
 			'index',
-			$params
 		);
 		$policy = new ContentSecurityPolicy();
 		$policy->addAllowedFrameDomain('\'self\'');
+		// Allow preview service worker
+		$policy->addAllowedWorkerSrcDomain('\'self\'');
 		$response->setContentSecurityPolicy($policy);
 
 		return $response;
 	}
 
 	/**
-	 * Redirects to the file list and highlight the given file id
+	 * Redirects to the trashbin file list and highlight the given file id
 	 *
-	 * @param string $fileId file id to show
+	 * @param int $fileId file id to show
 	 * @return RedirectResponse redirect response or not found response
-	 * @throws \OCP\Files\NotFoundException
+	 * @throws NotFoundException
 	 */
-	private function showFile($fileId) {
+	private function redirectToFileIfInTrashbin($fileId): RedirectResponse {
 		$uid = $this->userSession->getUser()->getUID();
 		$baseFolder = $this->rootFolder->getUserFolder($uid);
-		$files = $baseFolder->getById($fileId);
+		$node = $baseFolder->getFirstNodeById($fileId);
 		$params = [];
 
-		if (empty($files) && $this->appManager->isEnabledForUser('files_trashbin')) {
+		if (!$node && $this->appManager->isEnabledForUser('files_trashbin')) {
+			/** @var Folder */
 			$baseFolder = $this->rootFolder->get($uid . '/files_trashbin/files/');
-			$files = $baseFolder->getById($fileId);
+			$node = $baseFolder->getFirstNodeById($fileId);
 			$params['view'] = 'trashbin';
+
+			if ($node) {
+				$params['fileid'] = $fileId;
+				if ($node instanceof Folder) {
+					// set the full path to enter the folder
+					$params['dir'] = $baseFolder->getRelativePath($node->getPath());
+				} else {
+					// set parent path as dir
+					$params['dir'] = $baseFolder->getRelativePath($node->getParent()->getPath());
+				}
+				return new RedirectResponse($this->urlGenerator->linkToRoute('files.view.indexViewFileid', $params));
+			}
 		}
+		throw new NotFoundException();
+	}
+
+	/**
+	 * Redirects to the file list and highlight the given file id
+	 *
+	 * @param int $fileId file id to show
+	 * @param string|null $openDetails open details parameter
+	 * @param string|null $openFile open file parameter
+	 * @return RedirectResponse redirect response or not found response
+	 * @throws NotFoundException
+	 */
+	private function redirectToFile(int $fileId, ?string $openDetails = null, ?string $openFile = null): RedirectResponse {
+		$uid = $this->userSession->getUser()->getUID();
+		$baseFolder = $this->rootFolder->getUserFolder($uid);
+		$node = $baseFolder->getFirstNodeById($fileId);
+		$params = ['view' => 'files'];
 
-		if (!empty($files)) {
-			$file = current($files);
-			if ($file instanceof Folder) {
+		try {
+			$this->redirectToFileIfInTrashbin($fileId);
+		} catch (NotFoundException $e) {
+		}
+
+		if ($node) {
+			$params['fileid'] = $fileId;
+			if ($node instanceof Folder) {
 				// set the full path to enter the folder
-				$params['dir'] = $baseFolder->getRelativePath($file->getPath());
+				$params['dir'] = $baseFolder->getRelativePath($node->getPath());
 			} else {
 				// set parent path as dir
-				$params['dir'] = $baseFolder->getRelativePath($file->getParent()->getPath());
-				// and scroll to the entry
-				$params['scrollto'] = $file->getName();
+				$params['dir'] = $baseFolder->getRelativePath($node->getParent()->getPath());
+				// open the file by default (opening the viewer)
+				$params['openfile'] = 'true';
+			}
+
+			// Forward open parameters if any.
+			// - openfile is true by default
+			// - opendetails is undefined by default
+			// - both will be evaluated as truthy
+			if ($openDetails !== null) {
+				$params['opendetails'] = $openDetails !== 'false' ? 'true' : 'false';
 			}
-			return new RedirectResponse($this->urlGenerator->linkToRoute('files.view.index', $params));
+
+			if ($openFile !== null) {
+				$params['openfile'] = $openFile !== 'false' ? 'true' : 'false';
+			}
+
+			return new RedirectResponse($this->urlGenerator->linkToRoute('files.view.indexViewFileid', $params));
 		}
-		throw new \OCP\Files\NotFoundException();
+
+		throw new NotFoundException();
 	}
 }