feat(internal-link): avoid re-writing of the new fileid

Signed-off-by: Maxence Lange <[email protected]>

Author: ArtificialOwl

apps/files/lib/Controller/ViewController.php

@@ -92,8 +92,8 @@ public function showFile(?string $fileid = null, ?string $opendetails = null, ?s
 		try {
 			$event = new InternalLinkRequestEvent($fileid);
 			$this->eventDispatcher->dispatchTyped($event);
-			
-			return $event->getResponse() ?? $this->redirectToFile((int)$fileid, $opendetails, $openfile);
+
+			return $event->getResponse() ?? $this->redirectToFile((int)($event->getNewFileId() ?? $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

lib/composer/composer/autoload_classmap.php

@@ -407,6 +407,7 @@
     'OCP\\Files\\Events\\FileCacheUpdated' => $baseDir . '/lib/public/Files/Events/FileCacheUpdated.php',
     'OCP\\Files\\Events\\FileScannedEvent' => $baseDir . '/lib/public/Files/Events/FileScannedEvent.php',
     'OCP\\Files\\Events\\FolderScannedEvent' => $baseDir . '/lib/public/Files/Events/FolderScannedEvent.php',
+    'OCP\\Files\\Events\\InternalLinkRequestEvent' => $baseDir . '/lib/public/Files/Events/InternalLinkRequestEvent.php',
     'OCP\\Files\\Events\\InvalidateMountCacheEvent' => $baseDir . '/lib/public/Files/Events/InvalidateMountCacheEvent.php',
     'OCP\\Files\\Events\\NodeAddedToCache' => $baseDir . '/lib/public/Files/Events/NodeAddedToCache.php',
     'OCP\\Files\\Events\\NodeAddedToFavorite' => $baseDir . '/lib/public/Files/Events/NodeAddedToFavorite.php',

lib/composer/composer/autoload_static.php

@@ -448,6 +448,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
         'OCP\\Files\\Events\\FileCacheUpdated' => __DIR__ . '/../../..' . '/lib/public/Files/Events/FileCacheUpdated.php',
         'OCP\\Files\\Events\\FileScannedEvent' => __DIR__ . '/../../..' . '/lib/public/Files/Events/FileScannedEvent.php',
         'OCP\\Files\\Events\\FolderScannedEvent' => __DIR__ . '/../../..' . '/lib/public/Files/Events/FolderScannedEvent.php',
+        'OCP\\Files\\Events\\InternalLinkRequestEvent' => __DIR__ . '/../../..' . '/lib/public/Files/Events/InternalLinkRequestEvent.php',
         'OCP\\Files\\Events\\InvalidateMountCacheEvent' => __DIR__ . '/../../..' . '/lib/public/Files/Events/InvalidateMountCacheEvent.php',
         'OCP\\Files\\Events\\NodeAddedToCache' => __DIR__ . '/../../..' . '/lib/public/Files/Events/NodeAddedToCache.php',
         'OCP\\Files\\Events\\NodeAddedToFavorite' => __DIR__ . '/../../..' . '/lib/public/Files/Events/NodeAddedToFavorite.php',

lib/public/Files/Events/InternalLinkRequestEvent.php

@@ -8,48 +8,82 @@
  */
 namespace OCP\Files\Events;
 
-use OCP\AppFramework\Http\Response;
+use OCA\Files\Controller\ViewController;
+use OCP\AppFramework\Http\RedirectResponse;
 use OCP\EventDispatcher\Event;
+use OCP\Server;
+use Psr\Log\LoggerInterface;
 
 /**
+ * Allow a modification of the behavior on internal-link request ('/index.php/f/12345')
+ *
+ * A listener can change the value of the FileId or even force a new RedirectResponse() to be sent back to the client.
+ *
+ * @see ViewController::showFile
  * @since 32.0.0
  */
 class InternalLinkRequestEvent extends Event {
-	private ?Response $response = null;
+	private ?RedirectResponse $response = null;
+	private ?string $newFileId = null;
 	/**
 	 * @since 32.0.0
 	 */
 	public function __construct(
-		private string &$fileId,
+		private readonly string $fileId,
 	) {
 		parent::__construct();
 	}
 
 	/**
+	 * returns the original fileId
+	 *
 	 * @since 32.0.0
 	 */
-	public function setFileId(string $fileId): void {
-		$this->fileId = $fileId;
+	public function getFileId(): string {
+		return $this->fileId;
 	}
 
 	/**
+	 * Set a new fileId that will be used by the original RedirectResponse
+	 *
 	 * @since 32.0.0
 	 */
-	public function getFileId(): string {
-		return $this->fileId;
+	public function setNewFileId(string $fileId): void {
+		if ($this->newFileId === null) {
+			$this->newFileId = $fileId;
+		} else {
+			Server::get(LoggerInterface::class)->notice('a new file id was already set', ['exception' => new \Exception('')]);
+		}
+	}
+
+	/**
+	 * return new fileId, or NULL if not defined
+	 *
+	 * @since 32.0.0
+	 */
+	public function getNewFileId(): ?string {
+		return $this->newFileId;
 	}
 
 	/**
+	 * set a new RedirectResponse
+	 *
 	 * @since 32.0.0
 	 */
-	public function setResponse(Response $response): void {
-		$this->response = $response;
+	public function setResponse(RedirectResponse $response): void {
+		if ($this->response === null) {
+			$this->response = $response;
+		} else {
+			Server::get(LoggerInterface::class)->notice('a RedirectResponse was already set', ['exception' => new \Exception('')]);
+		}
 	}
 
 	/**
+	 * return the new response to send back to client
+	 *
 	 * @since 32.0.0
 	 */
-	public function getResponse(): ?Response {
+	public function getResponse(): ?RedirectResponse {
 		return $this->response;
 	}
 }