allow anon text processing scheduling

add a textprocessing_tasks index
convert anotations to method attributes
refactor TP manager
add mapper methods

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

(cherry picked from commit 41b19cf969956fe57fcb35e3dee0200d5c29b6d7)
Signed-off-by: Julien Veyssier <julien-nc@posteo.net>

2 files changed, 109 insertions, 28 deletions

diff --git a/core/Controller/TextProcessingApiController.php b/core/Controller/TextProcessingApiController.php
index 0f4c8c40b29..c713a70481c 100644
--- a/core/Controller/TextProcessingApiController.php
+++ b/core/Controller/TextProcessingApiController.php
@@ -27,7 +27,12 @@ declare(strict_types=1);
 namespace OC\Core\Controller;
 
 use InvalidArgumentException;
+use OCA\Core\ResponseDefinitions;
 use OCP\AppFramework\Http;
+use OCP\AppFramework\Http\Attribute\AnonRateLimit;
+use OCP\AppFramework\Http\Attribute\NoAdminRequired;
+use OCP\AppFramework\Http\Attribute\PublicPage;
+use OCP\AppFramework\Http\Attribute\UserRateLimit;
 use OCP\AppFramework\Http\DataResponse;
 use OCP\Common\Exception\NotFoundException;
 use OCP\IL10N;
@@ -41,15 +46,18 @@ use Psr\Container\ContainerInterface;
 use Psr\Container\NotFoundExceptionInterface;
 use Psr\Log\LoggerInterface;
 
+/**
+ * @psalm-import-type CoreTextProcessingTask from ResponseDefinitions
+ */
 class TextProcessingApiController extends \OCP\AppFramework\OCSController {
 	public function __construct(
-		string           $appName,
-		IRequest         $request,
-		private IManager $languageModelManager,
-		private IL10N    $l,
-		private ?string  $userId,
+		string                     $appName,
+		IRequest                   $request,
+		private IManager           $textProcessingManager,
+		private IL10N              $l,
+		private ?string            $userId,
 		private ContainerInterface $container,
-		private LoggerInterface $logger,
+		private LoggerInterface    $logger,
 	) {
 		parent::__construct($appName, $request);
 	}
@@ -57,11 +65,13 @@ class TextProcessingApiController extends \OCP\AppFramework\OCSController {
 	/**
 	 * This endpoint returns all available LanguageModel task types
 	 *
-	 * @PublicPage
+	 * @return DataResponse<Http::STATUS_OK, array{types: array{id: string, name: string, description: string}[]}, array{}>
 	 */
+	#[PublicPage]
 	public function taskTypes(): DataResponse {
-		$typeClasses = $this->languageModelManager->getAvailableTaskTypes();
+		$typeClasses = $this->textProcessingManager->getAvailableTaskTypes();
 		$types = [];
+		/** @var string $typeClass */
 		foreach ($typeClasses as $typeClass) {
 			try {
 				/** @var ITaskType $object */
@@ -85,10 +95,20 @@ class TextProcessingApiController extends \OCP\AppFramework\OCSController {
 	/**
 	 * This endpoint allows scheduling a language model task
 	 *
-	 * @PublicPage
-	 * @UserRateThrottle(limit=20, period=120)
-	 * @AnonRateThrottle(limit=5, period=120)
+	 * @param string $input Input text
+	 * @param string $type Type of the task
+	 * @param string $appId ID of the app that will execute the task
+	 * @param string $identifier An arbitrary identifier for the task
+	 *
+	 * @return DataResponse<Http::STATUS_OK, array{task: CoreTextProcessingTask}, array{}>|DataResponse<Http::STATUS_BAD_REQUEST|Http::STATUS_PRECONDITION_FAILED, array{message: string}, array{}>
+	 *
+	 * 200: Task scheduled successfully
+	 * 400: Scheduling task is not possible
+	 * 412: Scheduling task is not possible
 	 */
+	#[PublicPage]
+	#[UserRateLimit(limit: 20, period: 120)]
+	#[AnonRateLimit(limit: 5, period: 120)]
 	public function schedule(string $input, string $type, string $appId, string $identifier = ''): DataResponse {
 		try {
 			$task = new Task($type, $input, $appId, $this->userId, $identifier);
@@ -96,7 +116,7 @@ class TextProcessingApiController extends \OCP\AppFramework\OCSController {
 			return new DataResponse(['message' => $this->l->t('Requested task type does not exist')], Http::STATUS_BAD_REQUEST);
 		}
 		try {
-			$this->languageModelManager->scheduleTask($task);
+			$this->textProcessingManager->scheduleTask($task);
 
 			$json = $task->jsonSerialize();
 
@@ -112,16 +132,17 @@ class TextProcessingApiController extends \OCP\AppFramework\OCSController {
 	 * This endpoint allows checking the status and results of a task.
 	 * Tasks are removed 1 week after receiving their last update.
 	 *
-	 * @PublicPage
 	 * @param int $id The id of the task
+	 *
+	 * @return DataResponse<Http::STATUS_OK, array{task: CoreTextProcessingTask}, array{}>|DataResponse<Http::STATUS_NOT_FOUND|Http::STATUS_INTERNAL_SERVER_ERROR, array{message: string}, array{}>
+	 *
+	 * 200: Task returned
+	 * 404: Task not found
 	 */
+	#[PublicPage]
 	public function getTask(int $id): DataResponse {
 		try {
-			$task = $this->languageModelManager->getTask($id);
-
-			if ($this->userId !== $task->getUserId()) {
-				return new DataResponse(['message' => $this->l->t('Task not found')], Http::STATUS_NOT_FOUND);
-			}
+			$task = $this->textProcessingManager->getUserTask($id, $this->userId);
 
 			$json = $task->jsonSerialize();
 
@@ -136,10 +157,8 @@ class TextProcessingApiController extends \OCP\AppFramework\OCSController {
 	}
 
 	/**
-	 * This endpoint returns a list of tasks related with a specific appId and identifier
-	 *
-	 * @PublicPage
-	 * @UserRateThrottle(limit=20, period=120)
+	 * This endpoint returns a list of tasks of a user that are related
+	 * with a specific appId and optionally with an identifier
 	 *
 	 * @param string $appId
 	 * @param string|null $identifier
@@ -147,14 +166,10 @@ class TextProcessingApiController extends \OCP\AppFramework\OCSController {
 	 *
 	 *  200: Task list returned
 	 */
+	#[NoAdminRequired]
 	public function listTasksByApp(string $appId, ?string $identifier = null): DataResponse {
-		if ($this->userId === null) {
-			return new DataResponse([
-				'tasks' => [],
-			]);
-		}
 		try {
-			$tasks = $this->languageModelManager->getTasksByApp($this->userId, $appId, $identifier);
+			$tasks = $this->textProcessingManager->getUserTasksByApp($this->userId, $appId, $identifier);
 			$json = array_map(static function (Task $task) {
 				return $task->jsonSerialize();
 			}, $tasks);
diff --git a/core/Migrations/Version28000Date20230803221055.php b/core/Migrations/Version28000Date20230803221055.php
new file mode 100644
index 00000000000..8878a6f6cce
--- /dev/null
+++ b/core/Migrations/Version28000Date20230803221055.php
@@ -0,0 +1,66 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2023 Julien Veyssier <julien-nc@posteo.net>
+ *
+ * @author Julien Veyssier <julien-nc@posteo.net>
+ *
+ * @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 <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OC\Core\Migrations;
+
+use Closure;
+use OCP\DB\ISchemaWrapper;
+use OCP\Migration\IOutput;
+use OCP\Migration\SimpleMigrationStep;
+
+/**
+ * Adjust textprocessing_tasks table
+ */
+class Version28000Date20230803221055 extends SimpleMigrationStep {
+	/**
+	 * @param IOutput $output
+	 * @param Closure $schemaClosure The `\Closure` returns a `ISchemaWrapper`
+	 * @param array $options
+	 * @return null|ISchemaWrapper
+	 */
+	public function changeSchema(IOutput $output, Closure $schemaClosure, array $options): ?ISchemaWrapper {
+		/** @var ISchemaWrapper $schema */
+		$schema = $schemaClosure();
+		$changed = false;
+
+		if ($schema->hasTable('textprocessing_tasks')) {
+			$table = $schema->getTable('textprocessing_tasks');
+
+			$column = $table->getColumn('user_id');
+			$column->setNotnull(false);
+
+			$table->addIndex(['user_id', 'app_id', 'identifier'], 'tp_tasks_uid_appid_ident');
+
+			$changed = true;
+		}
+
+		if ($changed) {
+			return $schema;
+		}
+
+		return null;
+	}
+}