feat(file-actions): start implementing 3 file actions

Signed-off-by: Julien Veyssier <julien-nc@posteo.net>

Author: julien-nc

appinfo/routes.php

@@ -34,6 +34,7 @@
 		['name' => 'assistantApi#saveOutputFile', 'url' => '/api/{apiVersion}/task/{ocpTaskId}/file/{fileId}/save', 'verb' => 'POST', 'requirements' => $requirements],
 		['name' => 'assistantApi#getOutputFilePreview', 'url' => '/api/{apiVersion}/task/{ocpTaskId}/output-file/{fileId}/preview', 'verb' => 'GET', 'requirements' => $requirements],
 		['name' => 'assistantApi#getOutputFile', 'url' => '/api/{apiVersion}/task/{ocpTaskId}/output-file/{fileId}/download', 'verb' => 'GET', 'requirements' => $requirements],
+		['name' => 'assistantApi#runFileAction', 'url' => '/api/{apiVersion}/file-action/{fileId}/{taskTypeId}', 'verb' => 'POST', 'requirements' => $requirements],
 
 		['name' => 'chattyLLM#newSession', 'url' => '/chat/new_session', 'verb' => 'PUT'],
 		['name' => 'chattyLLM#updateSessionTitle', 'url' => '/chat/update_session', 'verb' => 'PATCH'],

lib/AppInfo/Application.php

@@ -12,6 +12,7 @@
 use OCA\Assistant\Listener\ChattyLLMTaskListener;
 use OCA\Assistant\Listener\CSPListener;
 use OCA\Assistant\Listener\FreePrompt\FreePromptReferenceListener;
+use OCA\Assistant\Listener\LoadAdditionalScriptsListener;
 use OCA\Assistant\Listener\SpeechToText\SpeechToTextReferenceListener;
 use OCA\Assistant\Listener\TaskFailedListener;
 use OCA\Assistant\Listener\TaskOutputFileReferenceListener;
@@ -24,6 +25,7 @@
 use OCA\Assistant\Reference\Text2ImageReferenceProvider;
 use OCA\Assistant\TaskProcessing\AudioToAudioChatProvider;
 use OCA\Assistant\TaskProcessing\ContextAgentAudioInteractionProvider;
+use OCA\Files\Event\LoadAdditionalScriptsEvent;
 use OCP\AppFramework\App;
 use OCP\AppFramework\Bootstrap\IBootContext;
 
@@ -64,6 +66,7 @@ public function register(IRegistrationContext $context): void {
 		$context->registerEventListener(RenderReferenceEvent::class, TaskOutputFileReferenceListener::class);
 
 		$context->registerEventListener(BeforeTemplateRenderedEvent::class, BeforeTemplateRenderedListener::class);
+		$context->registerEventListener(LoadAdditionalScriptsEvent::class, LoadAdditionalScriptsListener::class);
 
 		$context->registerEventListener(TaskSuccessfulEvent::class, TaskSuccessfulListener::class);
 		$context->registerEventListener(TaskFailedEvent::class, TaskFailedListener::class);

lib/Controller/AssistantApiController.php

@@ -9,6 +9,7 @@
 
 use OCA\Assistant\ResponseDefinitions;
 use OCA\Assistant\Service\AssistantService;
+use OCA\Assistant\Service\TaskProcessingService;
 use OCP\AppFramework\Db\MultipleObjectsReturnedException;
 use OCP\AppFramework\Http;
 use OCP\AppFramework\Http\Attribute\AnonRateLimit;
@@ -41,6 +42,7 @@ public function __construct(
 		IRequest $request,
 		private IL10N $l10n,
 		private AssistantService $assistantService,
+		private TaskProcessingService $taskProcessingService,
 		private LoggerInterface $logger,
 		private ?string $userId,
 	) {
@@ -408,4 +410,14 @@ public function getOutputFile(int $ocpTaskId, int $fileId): DataDownloadResponse
 			return new DataResponse('', Http::STATUS_NOT_FOUND);
 		}
 	}
+
+	#[NoAdminRequired]
+	public function runFileAction(int $fileId, string $taskTypeId): DataResponse {
+		try {
+			$taskId = $this->taskProcessingService->runFileAction($this->userId, $fileId, $taskTypeId);
+			return new DataResponse(['taskId' => $taskId]);
+		} catch (Exception|Throwable $e) {
+			return new DataResponse(['error' => $e->getMessage()], Http::STATUS_BAD_REQUEST);
+		}
+	}
 }

lib/Listener/FileActionTaskListener.php

@@ -0,0 +1,52 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\Assistant\Listener;
+
+use OCA\Assistant\AppInfo\Application;
+use OCA\Assistant\Service\TaskProcessingService;
+use OCP\EventDispatcher\Event;
+use OCP\EventDispatcher\IEventListener;
+use OCP\TaskProcessing\Events\TaskSuccessfulEvent;
+
+/**
+ * @template-implements IEventListener<TaskSuccessfulEvent>
+ */
+class FileActionTaskListener implements IEventListener {
+
+	public function __construct(
+		private TaskProcessingService $taskProcessingService,
+	) {
+	}
+
+	public function handle(Event $event): void {
+		if (!($event instanceof TaskSuccessfulEvent)) {
+			return;
+		}
+
+		$task = $event->getTask();
+		$customId = $task->getCustomId();
+		$appId = $task->getAppId();
+		$taskTypeId = $task->getTaskTypeId();
+
+		if ($customId === null || $appId !== (Application::APP_ID . ':file-action')) {
+			return;
+		}
+
+		if (!$this->taskProcessingService->isFileActionTaskTypeAuthorized($taskTypeId)) {
+			return;
+		}
+
+		if (preg_match('/^file-action:(\d+)$/', $customId, $matches)) {
+			$sourceFileId = (int)$matches[1];
+			// TODO get the task output, write it in the output file (in the same dir as the source one)
+			// TODO maybe send a notification
+		}
+	}
+}

lib/Listener/LoadAdditionalScriptsListener.php

@@ -0,0 +1,48 @@
+<?php
+
+/**
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\Assistant\Listener;
+
+use OCA\Assistant\AppInfo\Application;
+use OCA\Files\Event\LoadAdditionalScriptsEvent;
+use OCP\AppFramework\Services\IInitialState;
+use OCP\EventDispatcher\Event;
+use OCP\EventDispatcher\IEventListener;
+use OCP\TaskProcessing\IManager as ITaskProcessingManager;
+use OCP\TaskProcessing\TaskTypes\AudioToText;
+use OCP\TaskProcessing\TaskTypes\TextToTextSummary;
+use OCP\Util;
+
+/**
+ * @implements IEventListener<Event>
+ */
+class LoadAdditionalScriptsListener implements IEventListener {
+
+	public function __construct(
+		private IInitialState $initialStateService,
+		private ITaskProcessingManager $taskProcessingManager,
+	) {
+	}
+
+	public function handle(Event $event): void {
+		if (!$event instanceof LoadAdditionalScriptsEvent) {
+			return;
+		}
+
+		$availableTaskTypes = $this->taskProcessingManager->getAvailableTaskTypes();
+		$summarizeAvailable = array_key_exists(TextToTextSummary::ID, $availableTaskTypes);
+		$sttAvailable = array_key_exists(AudioToText::ID, $availableTaskTypes);
+		$ttsAvailable = class_exists('OCP\\TaskProcessing\\TaskTypes\\TextToSpeech')
+			&& array_key_exists(\OCP\TaskProcessing\TaskTypes\TextToSpeech::ID, $availableTaskTypes);
+
+		$this->initialStateService->provideInitialState('stt-available', $sttAvailable);
+		$this->initialStateService->provideInitialState('tts-available', $ttsAvailable);
+		$this->initialStateService->provideInitialState('summarize-available', $summarizeAvailable);
+
+		Util::addInitScript(Application::APP_ID, Application::APP_ID . '-fileActions');
+	}
+}

lib/Service/TaskProcessingService.php

@@ -7,6 +7,8 @@
 
 namespace OCA\Assistant\Service;
 
+use OC\User\NoUserException;
+use OCA\Assistant\AppInfo\Application;
 use OCP\Files\File;
 use OCP\Files\GenericFileException;
 use OCP\Files\IRootFolder;
@@ -19,6 +21,8 @@
 use OCP\TaskProcessing\Exception\ValidationException;
 use OCP\TaskProcessing\IManager;
 use OCP\TaskProcessing\Task;
+use OCP\TaskProcessing\TaskTypes\AudioToText;
+use OCP\TaskProcessing\TaskTypes\TextToTextSummary;
 use RuntimeException;
 
 class TaskProcessingService {
@@ -66,4 +70,56 @@ public function getOutputFileContent(int $fileId): string {
 		}
 		return $node->getContent();
 	}
+
+	public function isFileActionTaskTypeAuthorized(string $taskTypeId): bool {
+		$authorizedTaskTypes = [AudioToText::ID, TextToTextSummary::ID];
+		if (class_exists('OCP\\TaskProcessing\\TaskTypes\\TextToSpeech')) {
+			$authorizedTaskTypes[] = \OCP\TaskProcessing\TaskTypes\TextToSpeech::ID;
+		}
+		return in_array($taskTypeId, $authorizedTaskTypes, true);
+	}
+
+	/**
+	 * Execute a file action
+	 *
+	 * @param string $userId
+	 * @param int $fileId
+	 * @param string $taskTypeId
+	 * @return int The scheduled task ID
+	 * @throws Exception
+	 * @throws GenericFileException
+	 * @throws LockedException
+	 * @throws NotFoundException
+	 * @throws NotPermittedException
+	 * @throws PreConditionNotMetException
+	 * @throws UnauthorizedException
+	 * @throws ValidationException
+	 * @throws NoUserException
+	 */
+	public function runFileAction(string $userId, int $fileId, string $taskTypeId): int {
+		if (!$this->isFileActionTaskTypeAuthorized($taskTypeId)) {
+			throw new PreConditionNotMetException();
+		}
+		$userFolder = $this->rootFolder->getUserFolder($userId);
+		$file = $userFolder->getFirstNodeById($fileId);
+		if (!$file instanceof File) {
+			throw new NotFoundException('File is not a file');
+		}
+		$input = $taskTypeId === AudioToText::ID
+			? ['input' => $fileId]
+			: ['input' => $file->getContent()];
+		$task = new Task(
+			$taskTypeId,
+			$input,
+			Application::APP_ID . ':file-action:',
+			$userId,
+			'file-action:' . $fileId,
+		);
+		$this->taskProcessingManager->scheduleTask($task);
+		$taskId = $task->getId();
+		if ($taskId === null) {
+			throw new Exception('The task could not be scheduled');
+		}
+		return $taskId;
+	}
 }

package-lock.json

@@ -45,6 +45,7 @@
 		"@nextcloud/axios": "^2.0.0",
 		"@nextcloud/dialogs": "^7.0.0-rc.1",
 		"@nextcloud/event-bus": "^3.1.0",
+		"@nextcloud/files": "^3.11.0",
 		"@nextcloud/initial-state": "^2.0.0",
 		"@nextcloud/l10n": "^3.1.0",
 		"@nextcloud/moment": "^1.3.1",