nextcloud / server

lib/public/TaskProcessing/EShapeType.php

Indentation +170 added lines, -170 removed lines

@@ -17,181 +17,181 @@
  * @since 30.0.0
  */
 enum EShapeType: int {
-	case Number = 0;
-	case Text = 1;
-	case Image = 2;
-	case Audio = 3;
-	case Video = 4;
-	case File = 5;
-	case Enum = 6;
-	case ListOfNumbers = 10;
-	case ListOfTexts = 11;
-	case ListOfImages = 12;
-	case ListOfAudios = 13;
-	case ListOfVideos = 14;
-	case ListOfFiles = 15;
+    case Number = 0;
+    case Text = 1;
+    case Image = 2;
+    case Audio = 3;
+    case Video = 4;
+    case File = 5;
+    case Enum = 6;
+    case ListOfNumbers = 10;
+    case ListOfTexts = 11;
+    case ListOfImages = 12;
+    case ListOfAudios = 13;
+    case ListOfVideos = 14;
+    case ListOfFiles = 15;
 
-	/**
-	 * @param mixed $value
-	 * @param ShapeEnumValue[] $enumValues
-	 * @return void
-	 * @throws ValidationException
-	 * @since 30.0.0
-	 */
-	public function validateEnum(mixed $value, array $enumValues): void {
-		if ($this !== EShapeType::Enum) {
-			throw new ValidationException('Provider provided enum values for non-enum slot');
-		}
-		foreach ($enumValues as $enumValue) {
-			if ($value === $enumValue->getValue()) {
-				return;
-			}
-		}
-		throw new ValidationException('Wrong value given for Enum slot. Got "' . $value . '", but expected one of the provided enum values: "' . implode('", "', array_map(fn ($enumValue) => $enumValue->getValue(), $enumValues)) . '"');
-	}
+    /**
+     * @param mixed $value
+     * @param ShapeEnumValue[] $enumValues
+     * @return void
+     * @throws ValidationException
+     * @since 30.0.0
+     */
+    public function validateEnum(mixed $value, array $enumValues): void {
+        if ($this !== EShapeType::Enum) {
+            throw new ValidationException('Provider provided enum values for non-enum slot');
+        }
+        foreach ($enumValues as $enumValue) {
+            if ($value === $enumValue->getValue()) {
+                return;
+            }
+        }
+        throw new ValidationException('Wrong value given for Enum slot. Got "' . $value . '", but expected one of the provided enum values: "' . implode('", "', array_map(fn ($enumValue) => $enumValue->getValue(), $enumValues)) . '"');
+    }
 
-	/**
-	 * @param mixed $value
-	 * @return void
-	 * @throws ValidationException
-	 * @since 30.0.0
-	 */
-	private function validateNonFileType(mixed $value): void {
-		if ($this === EShapeType::Enum && !is_string($value)) {
-			throw new ValidationException('Non-text item provided for Enum slot');
-		}
-		if ($this === EShapeType::Text && !is_string($value)) {
-			throw new ValidationException('Non-text item provided for Text slot');
-		}
-		if ($this === EShapeType::ListOfTexts && (!is_array($value) || count(array_filter($value, fn ($item) => !is_string($item))) > 0)) {
-			throw new ValidationException('Non-text list item provided for ListOfTexts slot');
-		}
-		if ($this === EShapeType::Number && !is_numeric($value)) {
-			throw new ValidationException('Non-numeric item provided for Number slot');
-		}
-		if ($this === EShapeType::ListOfNumbers && (!is_array($value) || count(array_filter($value, fn ($item) => !is_numeric($item))) > 0)) {
-			throw new ValidationException('Non-numeric list item provided for ListOfNumbers slot');
-		}
-	}
+    /**
+     * @param mixed $value
+     * @return void
+     * @throws ValidationException
+     * @since 30.0.0
+     */
+    private function validateNonFileType(mixed $value): void {
+        if ($this === EShapeType::Enum && !is_string($value)) {
+            throw new ValidationException('Non-text item provided for Enum slot');
+        }
+        if ($this === EShapeType::Text && !is_string($value)) {
+            throw new ValidationException('Non-text item provided for Text slot');
+        }
+        if ($this === EShapeType::ListOfTexts && (!is_array($value) || count(array_filter($value, fn ($item) => !is_string($item))) > 0)) {
+            throw new ValidationException('Non-text list item provided for ListOfTexts slot');
+        }
+        if ($this === EShapeType::Number && !is_numeric($value)) {
+            throw new ValidationException('Non-numeric item provided for Number slot');
+        }
+        if ($this === EShapeType::ListOfNumbers && (!is_array($value) || count(array_filter($value, fn ($item) => !is_numeric($item))) > 0)) {
+            throw new ValidationException('Non-numeric list item provided for ListOfNumbers slot');
+        }
+    }
 
-	/**
-	 * @param mixed $value
-	 * @return void
-	 * @throws Exception\ValidationException
-	 * @since 30.0.0
-	 */
-	public function validateInput(mixed $value): void {
-		$this->validateNonFileType($value);
-		if ($this === EShapeType::Text && is_string($value) && strlen($value) > 64_000) {
-			throw new ValidationException('Text is too long');
-		}
-		if ($this === EShapeType::Image && !is_numeric($value)) {
-			throw new ValidationException('Non-image item provided for Image slot');
-		}
-		if ($this === EShapeType::ListOfImages && (!is_array($value) || count(array_filter($value, fn ($item) => !is_numeric($item))) > 0)) {
-			throw new ValidationException('Non-image list item provided for ListOfImages slot');
-		}
-		if ($this === EShapeType::Audio && !is_numeric($value)) {
-			throw new ValidationException('Non-audio item provided for Audio slot');
-		}
-		if ($this === EShapeType::ListOfAudios && (!is_array($value) || count(array_filter($value, fn ($item) => !is_numeric($item))) > 0)) {
-			throw new ValidationException('Non-audio list item provided for ListOfAudio slot');
-		}
-		if ($this === EShapeType::Video && !is_numeric($value)) {
-			throw new ValidationException('Non-video item provided for Video slot');
-		}
-		if ($this === EShapeType::ListOfVideos && (!is_array($value) || count(array_filter($value, fn ($item) => !is_numeric($item))) > 0)) {
-			throw new ValidationException('Non-video list item provided for ListOfTexts slot');
-		}
-		if ($this === EShapeType::File && !is_numeric($value)) {
-			throw new ValidationException('Non-file item provided for File slot');
-		}
-		if ($this === EShapeType::ListOfFiles && (!is_array($value) || count(array_filter($value, fn ($item) => !is_numeric($item))) > 0)) {
-			throw new ValidationException('Non-audio list item provided for ListOfFiles slot');
-		}
-	}
+    /**
+     * @param mixed $value
+     * @return void
+     * @throws Exception\ValidationException
+     * @since 30.0.0
+     */
+    public function validateInput(mixed $value): void {
+        $this->validateNonFileType($value);
+        if ($this === EShapeType::Text && is_string($value) && strlen($value) > 64_000) {
+            throw new ValidationException('Text is too long');
+        }
+        if ($this === EShapeType::Image && !is_numeric($value)) {
+            throw new ValidationException('Non-image item provided for Image slot');
+        }
+        if ($this === EShapeType::ListOfImages && (!is_array($value) || count(array_filter($value, fn ($item) => !is_numeric($item))) > 0)) {
+            throw new ValidationException('Non-image list item provided for ListOfImages slot');
+        }
+        if ($this === EShapeType::Audio && !is_numeric($value)) {
+            throw new ValidationException('Non-audio item provided for Audio slot');
+        }
+        if ($this === EShapeType::ListOfAudios && (!is_array($value) || count(array_filter($value, fn ($item) => !is_numeric($item))) > 0)) {
+            throw new ValidationException('Non-audio list item provided for ListOfAudio slot');
+        }
+        if ($this === EShapeType::Video && !is_numeric($value)) {
+            throw new ValidationException('Non-video item provided for Video slot');
+        }
+        if ($this === EShapeType::ListOfVideos && (!is_array($value) || count(array_filter($value, fn ($item) => !is_numeric($item))) > 0)) {
+            throw new ValidationException('Non-video list item provided for ListOfTexts slot');
+        }
+        if ($this === EShapeType::File && !is_numeric($value)) {
+            throw new ValidationException('Non-file item provided for File slot');
+        }
+        if ($this === EShapeType::ListOfFiles && (!is_array($value) || count(array_filter($value, fn ($item) => !is_numeric($item))) > 0)) {
+            throw new ValidationException('Non-audio list item provided for ListOfFiles slot');
+        }
+    }
 
-	/**
-	 * @throws ValidationException
-	 * @since 30.0.0
-	 */
-	public function validateOutputWithFileData(mixed $value): void {
-		$this->validateNonFileType($value);
-		if ($this === EShapeType::Image && !is_string($value)) {
-			throw new ValidationException('Non-image item provided for Image slot');
-		}
-		if ($this === EShapeType::ListOfImages && (!is_array($value) || count(array_filter($value, fn ($item) => !is_string($item))) > 0)) {
-			throw new ValidationException('Non-image list item provided for ListOfImages slot');
-		}
-		if ($this === EShapeType::Audio && !is_string($value)) {
-			throw new ValidationException('Non-audio item provided for Audio slot');
-		}
-		if ($this === EShapeType::ListOfAudios && (!is_array($value) || count(array_filter($value, fn ($item) => !is_string($item))) > 0)) {
-			throw new ValidationException('Non-audio list item provided for ListOfAudio slot');
-		}
-		if ($this === EShapeType::Video && !is_string($value)) {
-			throw new ValidationException('Non-video item provided for Video slot');
-		}
-		if ($this === EShapeType::ListOfVideos && (!is_array($value) || count(array_filter($value, fn ($item) => !is_string($item))) > 0)) {
-			throw new ValidationException('Non-video list item provided for ListOfTexts slot');
-		}
-		if ($this === EShapeType::File && !is_string($value)) {
-			throw new ValidationException('Non-file item provided for File slot');
-		}
-		if ($this === EShapeType::ListOfFiles && (!is_array($value) || count(array_filter($value, fn ($item) => !is_string($item))) > 0)) {
-			throw new ValidationException('Non-audio list item provided for ListOfFiles slot');
-		}
-	}
+    /**
+     * @throws ValidationException
+     * @since 30.0.0
+     */
+    public function validateOutputWithFileData(mixed $value): void {
+        $this->validateNonFileType($value);
+        if ($this === EShapeType::Image && !is_string($value)) {
+            throw new ValidationException('Non-image item provided for Image slot');
+        }
+        if ($this === EShapeType::ListOfImages && (!is_array($value) || count(array_filter($value, fn ($item) => !is_string($item))) > 0)) {
+            throw new ValidationException('Non-image list item provided for ListOfImages slot');
+        }
+        if ($this === EShapeType::Audio && !is_string($value)) {
+            throw new ValidationException('Non-audio item provided for Audio slot');
+        }
+        if ($this === EShapeType::ListOfAudios && (!is_array($value) || count(array_filter($value, fn ($item) => !is_string($item))) > 0)) {
+            throw new ValidationException('Non-audio list item provided for ListOfAudio slot');
+        }
+        if ($this === EShapeType::Video && !is_string($value)) {
+            throw new ValidationException('Non-video item provided for Video slot');
+        }
+        if ($this === EShapeType::ListOfVideos && (!is_array($value) || count(array_filter($value, fn ($item) => !is_string($item))) > 0)) {
+            throw new ValidationException('Non-video list item provided for ListOfTexts slot');
+        }
+        if ($this === EShapeType::File && !is_string($value)) {
+            throw new ValidationException('Non-file item provided for File slot');
+        }
+        if ($this === EShapeType::ListOfFiles && (!is_array($value) || count(array_filter($value, fn ($item) => !is_string($item))) > 0)) {
+            throw new ValidationException('Non-audio list item provided for ListOfFiles slot');
+        }
+    }
 
-	/**
-	 * @param mixed $value
-	 * @return void
-	 * @throws ValidationException
-	 * @since 30.0.0
-	 */
-	public function validateOutputWithFileIds(mixed $value): void {
-		$this->validateNonFileType($value);
-		if ($this === EShapeType::Image && !is_numeric($value)) {
-			throw new ValidationException('Non-image item provided for Image slot');
-		}
-		if ($this === EShapeType::ListOfImages && (!is_array($value) || count(array_filter($value, fn ($item) => !is_numeric($item))) > 0)) {
-			throw new ValidationException('Non-image list item provided for ListOfImages slot');
-		}
-		if ($this === EShapeType::Audio && !is_numeric($value)) {
-			throw new ValidationException('Non-audio item provided for Audio slot');
-		}
-		if ($this === EShapeType::ListOfAudios && (!is_array($value) || count(array_filter($value, fn ($item) => !is_numeric($item))) > 0)) {
-			throw new ValidationException('Non-audio list item provided for ListOfAudio slot');
-		}
-		if ($this === EShapeType::Video && !is_numeric($value)) {
-			throw new ValidationException('Non-video item provided for Video slot');
-		}
-		if ($this === EShapeType::ListOfVideos && (!is_array($value) || count(array_filter($value, fn ($item) => !is_numeric($item))) > 0)) {
-			throw new ValidationException('Non-video list item provided for ListOfTexts slot');
-		}
-		if ($this === EShapeType::File && !is_numeric($value)) {
-			throw new ValidationException('Non-file item provided for File slot');
-		}
-		if ($this === EShapeType::ListOfFiles && (!is_array($value) || count(array_filter($value, fn ($item) => !is_numeric($item))) > 0)) {
-			throw new ValidationException('Non-audio list item provided for ListOfFiles slot');
-		}
-	}
+    /**
+     * @param mixed $value
+     * @return void
+     * @throws ValidationException
+     * @since 30.0.0
+     */
+    public function validateOutputWithFileIds(mixed $value): void {
+        $this->validateNonFileType($value);
+        if ($this === EShapeType::Image && !is_numeric($value)) {
+            throw new ValidationException('Non-image item provided for Image slot');
+        }
+        if ($this === EShapeType::ListOfImages && (!is_array($value) || count(array_filter($value, fn ($item) => !is_numeric($item))) > 0)) {
+            throw new ValidationException('Non-image list item provided for ListOfImages slot');
+        }
+        if ($this === EShapeType::Audio && !is_numeric($value)) {
+            throw new ValidationException('Non-audio item provided for Audio slot');
+        }
+        if ($this === EShapeType::ListOfAudios && (!is_array($value) || count(array_filter($value, fn ($item) => !is_numeric($item))) > 0)) {
+            throw new ValidationException('Non-audio list item provided for ListOfAudio slot');
+        }
+        if ($this === EShapeType::Video && !is_numeric($value)) {
+            throw new ValidationException('Non-video item provided for Video slot');
+        }
+        if ($this === EShapeType::ListOfVideos && (!is_array($value) || count(array_filter($value, fn ($item) => !is_numeric($item))) > 0)) {
+            throw new ValidationException('Non-video list item provided for ListOfTexts slot');
+        }
+        if ($this === EShapeType::File && !is_numeric($value)) {
+            throw new ValidationException('Non-file item provided for File slot');
+        }
+        if ($this === EShapeType::ListOfFiles && (!is_array($value) || count(array_filter($value, fn ($item) => !is_numeric($item))) > 0)) {
+            throw new ValidationException('Non-audio list item provided for ListOfFiles slot');
+        }
+    }
 
-	/**
-	 * @param EShapeType $type
-	 * @return EShapeType
-	 * @since 30.0.0
-	 */
-	public static function getScalarType(EShapeType $type): EShapeType {
-		return EShapeType::from($type->value % 10);
-	}
+    /**
+     * @param EShapeType $type
+     * @return EShapeType
+     * @since 30.0.0
+     */
+    public static function getScalarType(EShapeType $type): EShapeType {
+        return EShapeType::from($type->value % 10);
+    }
 
-	/**
-	 * @param EShapeType $type
-	 * @return bool
-	 * @since 30.0.0
-	 */
-	public static function isFileType(EShapeType $type): bool {
-		return in_array(EShapeType::getScalarType($type), [EShapeType::File, EShapeType::Image, EShapeType::Audio, EShapeType::Video], true);
-	}
+    /**
+     * @param EShapeType $type
+     * @return bool
+     * @since 30.0.0
+     */
+    public static function isFileType(EShapeType $type): bool {
+        return in_array(EShapeType::getScalarType($type), [EShapeType::File, EShapeType::Image, EShapeType::Audio, EShapeType::Video], true);
+    }
 }

core/Controller/TextProcessingApiController.php

Indentation +177 added lines, -177 removed lines

@@ -38,181 +38,181 @@
  * @psalm-import-type CoreTextProcessingTask from ResponseDefinitions
  */
 class TextProcessingApiController extends OCSController {
-	public function __construct(
-		string $appName,
-		IRequest $request,
-		private IManager $textProcessingManager,
-		private IL10N $l,
-		private ?string $userId,
-		private ContainerInterface $container,
-		private LoggerInterface $logger,
-	) {
-		parent::__construct($appName, $request);
-	}
-
-	/**
-	 * This endpoint returns all available LanguageModel task types
-	 *
-	 * @return DataResponse<Http::STATUS_OK, array{types: list<array{id: string, name: string, description: string}>}, array{}>
-	 *
-	 * 200: Task types returned
-	 */
-	#[PublicPage]
-	#[ApiRoute(verb: 'GET', url: '/tasktypes', root: '/textprocessing')]
-	public function taskTypes(): DataResponse {
-		$typeClasses = $this->textProcessingManager->getAvailableTaskTypes();
-		$types = [];
-		/** @var string $typeClass */
-		foreach ($typeClasses as $typeClass) {
-			try {
-				/** @var ITaskType $object */
-				$object = $this->container->get($typeClass);
-			} catch (NotFoundExceptionInterface|ContainerExceptionInterface $e) {
-				$this->logger->warning('Could not find ' . $typeClass, ['exception' => $e]);
-				continue;
-			}
-			$types[] = [
-				'id' => $typeClass,
-				'name' => $object->getName(),
-				'description' => $object->getDescription(),
-			];
-		}
-
-		return new DataResponse([
-			'types' => $types,
-		]);
-	}
-
-	/**
-	 * This endpoint allows scheduling a language model task
-	 *
-	 * @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_INTERNAL_SERVER_ERROR|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
-	 */
-	#[NoAdminRequired]
-	#[UserRateLimit(limit: 20, period: 120)]
-	#[AnonRateLimit(limit: 5, period: 120)]
-	#[ApiRoute(verb: 'POST', url: '/schedule', root: '/textprocessing')]
-	public function schedule(string $input, string $type, string $appId, string $identifier = ''): DataResponse {
-		if (strlen($input) > 64_000) {
-			return new DataResponse(['message' => $this->l->t('Input text is too long')], Http::STATUS_BAD_REQUEST);
-		}
-		try {
-			$task = new Task($type, $input, $appId, $this->userId, $identifier);
-		} catch (InvalidArgumentException) {
-			return new DataResponse(['message' => $this->l->t('Requested task type does not exist')], Http::STATUS_BAD_REQUEST);
-		}
-		try {
-			try {
-				$this->textProcessingManager->runOrScheduleTask($task);
-			} catch (TaskFailureException) {
-				// noop, because the task object has the failure status set already, we just return the task json
-			}
-
-			$json = $task->jsonSerialize();
-
-			return new DataResponse([
-				'task' => $json,
-			]);
-		} catch (PreConditionNotMetException) {
-			return new DataResponse(['message' => $this->l->t('Necessary language model provider is not available')], Http::STATUS_PRECONDITION_FAILED);
-		} catch (Exception) {
-			return new DataResponse(['message' => 'Internal server error'], Http::STATUS_INTERNAL_SERVER_ERROR);
-		}
-	}
-
-	/**
-	 * This endpoint allows checking the status and results of a task.
-	 * Tasks are removed 1 week after receiving their last update.
-	 *
-	 * @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
-	 */
-	#[NoAdminRequired]
-	#[ApiRoute(verb: 'GET', url: '/task/{id}', root: '/textprocessing')]
-	public function getTask(int $id): DataResponse {
-		try {
-			$task = $this->textProcessingManager->getUserTask($id, $this->userId);
-
-			$json = $task->jsonSerialize();
-
-			return new DataResponse([
-				'task' => $json,
-			]);
-		} catch (NotFoundException $e) {
-			return new DataResponse(['message' => $this->l->t('Task not found')], Http::STATUS_NOT_FOUND);
-		} catch (\RuntimeException $e) {
-			return new DataResponse(['message' => $this->l->t('Internal error')], Http::STATUS_INTERNAL_SERVER_ERROR);
-		}
-	}
-
-	/**
-	 * This endpoint allows to delete a scheduled task for a user
-	 *
-	 * @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
-	 */
-	#[NoAdminRequired]
-	#[ApiRoute(verb: 'DELETE', url: '/task/{id}', root: '/textprocessing')]
-	public function deleteTask(int $id): DataResponse {
-		try {
-			$task = $this->textProcessingManager->getUserTask($id, $this->userId);
-
-			$this->textProcessingManager->deleteTask($task);
-
-			$json = $task->jsonSerialize();
-
-			return new DataResponse([
-				'task' => $json,
-			]);
-		} catch (NotFoundException $e) {
-			return new DataResponse(['message' => $this->l->t('Task not found')], Http::STATUS_NOT_FOUND);
-		} catch (\RuntimeException $e) {
-			return new DataResponse(['message' => $this->l->t('Internal error')], Http::STATUS_INTERNAL_SERVER_ERROR);
-		}
-	}
-
-
-	/**
-	 * 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 ID of the app
-	 * @param string|null $identifier An arbitrary identifier for the task
-	 * @return DataResponse<Http::STATUS_OK, array{tasks: list<CoreTextProcessingTask>}, array{}>|DataResponse<Http::STATUS_INTERNAL_SERVER_ERROR, array{message: string}, array{}>
-	 *
-	 * 200: Task list returned
-	 */
-	#[NoAdminRequired]
-	#[ApiRoute(verb: 'GET', url: '/tasks/app/{appId}', root: '/textprocessing')]
-	public function listTasksByApp(string $appId, ?string $identifier = null): DataResponse {
-		try {
-			$tasks = $this->textProcessingManager->getUserTasksByApp($this->userId, $appId, $identifier);
-			$json = array_values(array_map(static function (Task $task) {
-				return $task->jsonSerialize();
-			}, $tasks));
-
-			return new DataResponse([
-				'tasks' => $json,
-			]);
-		} catch (\RuntimeException $e) {
-			return new DataResponse(['message' => $this->l->t('Internal error')], Http::STATUS_INTERNAL_SERVER_ERROR);
-		}
-	}
+    public function __construct(
+        string $appName,
+        IRequest $request,
+        private IManager $textProcessingManager,
+        private IL10N $l,
+        private ?string $userId,
+        private ContainerInterface $container,
+        private LoggerInterface $logger,
+    ) {
+        parent::__construct($appName, $request);
+    }
+
+    /**
+     * This endpoint returns all available LanguageModel task types
+     *
+     * @return DataResponse<Http::STATUS_OK, array{types: list<array{id: string, name: string, description: string}>}, array{}>
+     *
+     * 200: Task types returned
+     */
+    #[PublicPage]
+    #[ApiRoute(verb: 'GET', url: '/tasktypes', root: '/textprocessing')]
+    public function taskTypes(): DataResponse {
+        $typeClasses = $this->textProcessingManager->getAvailableTaskTypes();
+        $types = [];
+        /** @var string $typeClass */
+        foreach ($typeClasses as $typeClass) {
+            try {
+                /** @var ITaskType $object */
+                $object = $this->container->get($typeClass);
+            } catch (NotFoundExceptionInterface|ContainerExceptionInterface $e) {
+                $this->logger->warning('Could not find ' . $typeClass, ['exception' => $e]);
+                continue;
+            }
+            $types[] = [
+                'id' => $typeClass,
+                'name' => $object->getName(),
+                'description' => $object->getDescription(),
+            ];
+        }
+
+        return new DataResponse([
+            'types' => $types,
+        ]);
+    }
+
+    /**
+     * This endpoint allows scheduling a language model task
+     *
+     * @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_INTERNAL_SERVER_ERROR|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
+     */
+    #[NoAdminRequired]
+    #[UserRateLimit(limit: 20, period: 120)]
+    #[AnonRateLimit(limit: 5, period: 120)]
+    #[ApiRoute(verb: 'POST', url: '/schedule', root: '/textprocessing')]
+    public function schedule(string $input, string $type, string $appId, string $identifier = ''): DataResponse {
+        if (strlen($input) > 64_000) {
+            return new DataResponse(['message' => $this->l->t('Input text is too long')], Http::STATUS_BAD_REQUEST);
+        }
+        try {
+            $task = new Task($type, $input, $appId, $this->userId, $identifier);
+        } catch (InvalidArgumentException) {
+            return new DataResponse(['message' => $this->l->t('Requested task type does not exist')], Http::STATUS_BAD_REQUEST);
+        }
+        try {
+            try {
+                $this->textProcessingManager->runOrScheduleTask($task);
+            } catch (TaskFailureException) {
+                // noop, because the task object has the failure status set already, we just return the task json
+            }
+
+            $json = $task->jsonSerialize();
+
+            return new DataResponse([
+                'task' => $json,
+            ]);
+        } catch (PreConditionNotMetException) {
+            return new DataResponse(['message' => $this->l->t('Necessary language model provider is not available')], Http::STATUS_PRECONDITION_FAILED);
+        } catch (Exception) {
+            return new DataResponse(['message' => 'Internal server error'], Http::STATUS_INTERNAL_SERVER_ERROR);
+        }
+    }
+
+    /**
+     * This endpoint allows checking the status and results of a task.
+     * Tasks are removed 1 week after receiving their last update.
+     *
+     * @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
+     */
+    #[NoAdminRequired]
+    #[ApiRoute(verb: 'GET', url: '/task/{id}', root: '/textprocessing')]
+    public function getTask(int $id): DataResponse {
+        try {
+            $task = $this->textProcessingManager->getUserTask($id, $this->userId);
+
+            $json = $task->jsonSerialize();
+
+            return new DataResponse([
+                'task' => $json,
+            ]);
+        } catch (NotFoundException $e) {
+            return new DataResponse(['message' => $this->l->t('Task not found')], Http::STATUS_NOT_FOUND);
+        } catch (\RuntimeException $e) {
+            return new DataResponse(['message' => $this->l->t('Internal error')], Http::STATUS_INTERNAL_SERVER_ERROR);
+        }
+    }
+
+    /**
+     * This endpoint allows to delete a scheduled task for a user
+     *
+     * @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
+     */
+    #[NoAdminRequired]
+    #[ApiRoute(verb: 'DELETE', url: '/task/{id}', root: '/textprocessing')]
+    public function deleteTask(int $id): DataResponse {
+        try {
+            $task = $this->textProcessingManager->getUserTask($id, $this->userId);
+
+            $this->textProcessingManager->deleteTask($task);
+
+            $json = $task->jsonSerialize();
+
+            return new DataResponse([
+                'task' => $json,
+            ]);
+        } catch (NotFoundException $e) {
+            return new DataResponse(['message' => $this->l->t('Task not found')], Http::STATUS_NOT_FOUND);
+        } catch (\RuntimeException $e) {
+            return new DataResponse(['message' => $this->l->t('Internal error')], Http::STATUS_INTERNAL_SERVER_ERROR);
+        }
+    }
+
+
+    /**
+     * 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 ID of the app
+     * @param string|null $identifier An arbitrary identifier for the task
+     * @return DataResponse<Http::STATUS_OK, array{tasks: list<CoreTextProcessingTask>}, array{}>|DataResponse<Http::STATUS_INTERNAL_SERVER_ERROR, array{message: string}, array{}>
+     *
+     * 200: Task list returned
+     */
+    #[NoAdminRequired]
+    #[ApiRoute(verb: 'GET', url: '/tasks/app/{appId}', root: '/textprocessing')]
+    public function listTasksByApp(string $appId, ?string $identifier = null): DataResponse {
+        try {
+            $tasks = $this->textProcessingManager->getUserTasksByApp($this->userId, $appId, $identifier);
+            $json = array_values(array_map(static function (Task $task) {
+                return $task->jsonSerialize();
+            }, $tasks));
+
+            return new DataResponse([
+                'tasks' => $json,
+            ]);
+        } catch (\RuntimeException $e) {
+            return new DataResponse(['message' => $this->l->t('Internal error')], Http::STATUS_INTERNAL_SERVER_ERROR);
+        }
+    }
 }

core/Controller/TextToImageApiController.php

Indentation +200 added lines, -200 removed lines

@@ -35,204 +35,204 @@
  * @psalm-import-type CoreTextToImageTask from ResponseDefinitions
  */
 class TextToImageApiController extends OCSController {
-	public function __construct(
-		string $appName,
-		IRequest $request,
-		private IManager $textToImageManager,
-		private IL10N $l,
-		private ?string $userId,
-		private AppData $appData,
-	) {
-		parent::__construct($appName, $request);
-	}
-
-	/**
-	 * Check whether this feature is available
-	 *
-	 * @return DataResponse<Http::STATUS_OK, array{isAvailable: bool}, array{}>
-	 *
-	 * 200: Returns availability status
-	 */
-	#[NoAdminRequired]
-	#[ApiRoute(verb: 'GET', url: '/is_available', root: '/text2image')]
-	public function isAvailable(): DataResponse {
-		return new DataResponse([
-			'isAvailable' => $this->textToImageManager->hasProviders(),
-		]);
-	}
-
-	/**
-	 * This endpoint allows scheduling a text to image task
-	 *
-	 * @param string $input Input text
-	 * @param string $appId ID of the app that will execute the task
-	 * @param string $identifier An arbitrary identifier for the task
-	 * @param int $numberOfImages The number of images to generate
-	 *
-	 * @return DataResponse<Http::STATUS_OK, array{task: CoreTextToImageTask}, array{}>|DataResponse<Http::STATUS_PRECONDITION_FAILED|Http::STATUS_INTERNAL_SERVER_ERROR, array{message: string}, array{}>
-	 *
-	 * 200: Task scheduled successfully
-	 * 412: Scheduling task is not possible
-	 */
-	#[NoAdminRequired]
-	#[UserRateLimit(limit: 20, period: 120)]
-	#[ApiRoute(verb: 'POST', url: '/schedule', root: '/text2image')]
-	public function schedule(string $input, string $appId, string $identifier = '', int $numberOfImages = 8): DataResponse {
-		if (strlen($input) > 64_000) {
-			return new DataResponse(['message' => $this->l->t('Input text is too long')], Http::STATUS_PRECONDITION_FAILED);
-		}
-		$task = new Task($input, $appId, $numberOfImages, $this->userId, $identifier);
-		try {
-			try {
-				$this->textToImageManager->runOrScheduleTask($task);
-			} catch (TaskFailureException) {
-				// Task status was already updated by the manager, nothing to do here
-			}
-
-			$json = $task->jsonSerialize();
-
-			return new DataResponse([
-				'task' => $json,
-			]);
-		} catch (PreConditionNotMetException) {
-			return new DataResponse(['message' => $this->l->t('No text to image provider is available')], Http::STATUS_PRECONDITION_FAILED);
-		} catch (Exception) {
-			return new DataResponse(['message' => $this->l->t('Internal error')], Http::STATUS_INTERNAL_SERVER_ERROR);
-		}
-	}
-
-	/**
-	 * This endpoint allows checking the status and results of a task.
-	 * Tasks are removed 1 week after receiving their last update.
-	 *
-	 * @param int $id The id of the task
-	 *
-	 * @return DataResponse<Http::STATUS_OK, array{task: CoreTextToImageTask}, array{}>|DataResponse<Http::STATUS_NOT_FOUND|Http::STATUS_INTERNAL_SERVER_ERROR, array{message: string}, array{}>
-	 *
-	 * 200: Task returned
-	 * 404: Task not found
-	 */
-	#[NoAdminRequired]
-	#[BruteForceProtection(action: 'text2image')]
-	#[ApiRoute(verb: 'GET', url: '/task/{id}', root: '/text2image')]
-	public function getTask(int $id): DataResponse {
-		try {
-			$task = $this->textToImageManager->getUserTask($id, $this->userId);
-
-			$json = $task->jsonSerialize();
-
-			return new DataResponse([
-				'task' => $json,
-			]);
-		} catch (TaskNotFoundException) {
-			$res = new DataResponse(['message' => $this->l->t('Task not found')], Http::STATUS_NOT_FOUND);
-			$res->throttle(['action' => 'text2image']);
-			return $res;
-		} catch (\RuntimeException) {
-			return new DataResponse(['message' => $this->l->t('Internal error')], Http::STATUS_INTERNAL_SERVER_ERROR);
-		}
-	}
-
-	/**
-	 * This endpoint allows downloading the resulting image of a task
-	 *
-	 * @param int $id The id of the task
-	 * @param int $index The index of the image to retrieve
-	 *
-	 * @return FileDisplayResponse<Http::STATUS_OK, array{'Content-Type': string}>|DataResponse<Http::STATUS_NOT_FOUND|Http::STATUS_INTERNAL_SERVER_ERROR, array{message: string}, array{}>
-	 *
-	 * 200: Image returned
-	 * 404: Task or image not found
-	 */
-	#[NoAdminRequired]
-	#[BruteForceProtection(action: 'text2image')]
-	#[ApiRoute(verb: 'GET', url: '/task/{id}/image/{index}', root: '/text2image')]
-	public function getImage(int $id, int $index): DataResponse|FileDisplayResponse {
-		try {
-			$task = $this->textToImageManager->getUserTask($id, $this->userId);
-			try {
-				$folder = $this->appData->getFolder('text2image');
-			} catch (NotFoundException) {
-				$res = new DataResponse(['message' => $this->l->t('Image not found')], Http::STATUS_NOT_FOUND);
-				$res->throttle(['action' => 'text2image']);
-				return $res;
-			}
-			$file = $folder->getFolder((string)$task->getId())->getFile((string)$index);
-			$info = getimagesizefromstring($file->getContent());
-
-			return new FileDisplayResponse($file, Http::STATUS_OK, ['Content-Type' => image_type_to_mime_type($info[2])]);
-		} catch (TaskNotFoundException) {
-			$res = new DataResponse(['message' => $this->l->t('Task not found')], Http::STATUS_NOT_FOUND);
-			$res->throttle(['action' => 'text2image']);
-			return $res;
-		} catch (\RuntimeException) {
-			return new DataResponse(['message' => $this->l->t('Internal error')], Http::STATUS_INTERNAL_SERVER_ERROR);
-		} catch (NotFoundException) {
-			$res = new DataResponse(['message' => $this->l->t('Image not found')], Http::STATUS_NOT_FOUND);
-			$res->throttle(['action' => 'text2image']);
-			return $res;
-		}
-	}
-
-	/**
-	 * This endpoint allows to delete a scheduled task for a user
-	 *
-	 * @param int $id The id of the task
-	 *
-	 * @return DataResponse<Http::STATUS_OK, array{task: CoreTextToImageTask}, array{}>|DataResponse<Http::STATUS_NOT_FOUND|Http::STATUS_INTERNAL_SERVER_ERROR, array{message: string}, array{}>
-	 *
-	 * 200: Task returned
-	 * 404: Task not found
-	 */
-	#[NoAdminRequired]
-	#[BruteForceProtection(action: 'text2image')]
-	#[ApiRoute(verb: 'DELETE', url: '/task/{id}', root: '/text2image')]
-	public function deleteTask(int $id): DataResponse {
-		try {
-			$task = $this->textToImageManager->getUserTask($id, $this->userId);
-
-			$this->textToImageManager->deleteTask($task);
-
-			$json = $task->jsonSerialize();
-
-			return new DataResponse([
-				'task' => $json,
-			]);
-		} catch (TaskNotFoundException) {
-			$res = new DataResponse(['message' => $this->l->t('Task not found')], Http::STATUS_NOT_FOUND);
-			$res->throttle(['action' => 'text2image']);
-			return $res;
-		} catch (\RuntimeException) {
-			return new DataResponse(['message' => $this->l->t('Internal error')], Http::STATUS_INTERNAL_SERVER_ERROR);
-		}
-	}
-
-
-	/**
-	 * 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 ID of the app
-	 * @param string|null $identifier An arbitrary identifier for the task
-	 * @return DataResponse<Http::STATUS_OK, array{tasks: list<CoreTextToImageTask>}, array{}>|DataResponse<Http::STATUS_INTERNAL_SERVER_ERROR, array{message: string}, array{}>
-	 *
-	 * 200: Task list returned
-	 */
-	#[NoAdminRequired]
-	#[AnonRateLimit(limit: 5, period: 120)]
-	#[ApiRoute(verb: 'GET', url: '/tasks/app/{appId}', root: '/text2image')]
-	public function listTasksByApp(string $appId, ?string $identifier = null): DataResponse {
-		try {
-			$tasks = $this->textToImageManager->getUserTasksByApp($this->userId, $appId, $identifier);
-			$json = array_values(array_map(static function (Task $task) {
-				return $task->jsonSerialize();
-			}, $tasks));
-
-			return new DataResponse([
-				'tasks' => $json,
-			]);
-		} catch (\RuntimeException) {
-			return new DataResponse(['message' => $this->l->t('Internal error')], Http::STATUS_INTERNAL_SERVER_ERROR);
-		}
-	}
+    public function __construct(
+        string $appName,
+        IRequest $request,
+        private IManager $textToImageManager,
+        private IL10N $l,
+        private ?string $userId,
+        private AppData $appData,
+    ) {
+        parent::__construct($appName, $request);
+    }
+
+    /**
+     * Check whether this feature is available
+     *
+     * @return DataResponse<Http::STATUS_OK, array{isAvailable: bool}, array{}>
+     *
+     * 200: Returns availability status
+     */
+    #[NoAdminRequired]
+    #[ApiRoute(verb: 'GET', url: '/is_available', root: '/text2image')]
+    public function isAvailable(): DataResponse {
+        return new DataResponse([
+            'isAvailable' => $this->textToImageManager->hasProviders(),
+        ]);
+    }
+
+    /**
+     * This endpoint allows scheduling a text to image task
+     *
+     * @param string $input Input text
+     * @param string $appId ID of the app that will execute the task
+     * @param string $identifier An arbitrary identifier for the task
+     * @param int $numberOfImages The number of images to generate
+     *
+     * @return DataResponse<Http::STATUS_OK, array{task: CoreTextToImageTask}, array{}>|DataResponse<Http::STATUS_PRECONDITION_FAILED|Http::STATUS_INTERNAL_SERVER_ERROR, array{message: string}, array{}>
+     *
+     * 200: Task scheduled successfully
+     * 412: Scheduling task is not possible
+     */
+    #[NoAdminRequired]
+    #[UserRateLimit(limit: 20, period: 120)]
+    #[ApiRoute(verb: 'POST', url: '/schedule', root: '/text2image')]
+    public function schedule(string $input, string $appId, string $identifier = '', int $numberOfImages = 8): DataResponse {
+        if (strlen($input) > 64_000) {
+            return new DataResponse(['message' => $this->l->t('Input text is too long')], Http::STATUS_PRECONDITION_FAILED);
+        }
+        $task = new Task($input, $appId, $numberOfImages, $this->userId, $identifier);
+        try {
+            try {
+                $this->textToImageManager->runOrScheduleTask($task);
+            } catch (TaskFailureException) {
+                // Task status was already updated by the manager, nothing to do here
+            }
+
+            $json = $task->jsonSerialize();
+
+            return new DataResponse([
+                'task' => $json,
+            ]);
+        } catch (PreConditionNotMetException) {
+            return new DataResponse(['message' => $this->l->t('No text to image provider is available')], Http::STATUS_PRECONDITION_FAILED);
+        } catch (Exception) {
+            return new DataResponse(['message' => $this->l->t('Internal error')], Http::STATUS_INTERNAL_SERVER_ERROR);
+        }
+    }
+
+    /**
+     * This endpoint allows checking the status and results of a task.
+     * Tasks are removed 1 week after receiving their last update.
+     *
+     * @param int $id The id of the task
+     *
+     * @return DataResponse<Http::STATUS_OK, array{task: CoreTextToImageTask}, array{}>|DataResponse<Http::STATUS_NOT_FOUND|Http::STATUS_INTERNAL_SERVER_ERROR, array{message: string}, array{}>
+     *
+     * 200: Task returned
+     * 404: Task not found
+     */
+    #[NoAdminRequired]
+    #[BruteForceProtection(action: 'text2image')]
+    #[ApiRoute(verb: 'GET', url: '/task/{id}', root: '/text2image')]
+    public function getTask(int $id): DataResponse {
+        try {
+            $task = $this->textToImageManager->getUserTask($id, $this->userId);
+
+            $json = $task->jsonSerialize();
+
+            return new DataResponse([
+                'task' => $json,
+            ]);
+        } catch (TaskNotFoundException) {
+            $res = new DataResponse(['message' => $this->l->t('Task not found')], Http::STATUS_NOT_FOUND);
+            $res->throttle(['action' => 'text2image']);
+            return $res;
+        } catch (\RuntimeException) {
+            return new DataResponse(['message' => $this->l->t('Internal error')], Http::STATUS_INTERNAL_SERVER_ERROR);
+        }
+    }
+
+    /**
+     * This endpoint allows downloading the resulting image of a task
+     *
+     * @param int $id The id of the task
+     * @param int $index The index of the image to retrieve
+     *
+     * @return FileDisplayResponse<Http::STATUS_OK, array{'Content-Type': string}>|DataResponse<Http::STATUS_NOT_FOUND|Http::STATUS_INTERNAL_SERVER_ERROR, array{message: string}, array{}>
+     *
+     * 200: Image returned
+     * 404: Task or image not found
+     */
+    #[NoAdminRequired]
+    #[BruteForceProtection(action: 'text2image')]
+    #[ApiRoute(verb: 'GET', url: '/task/{id}/image/{index}', root: '/text2image')]
+    public function getImage(int $id, int $index): DataResponse|FileDisplayResponse {
+        try {
+            $task = $this->textToImageManager->getUserTask($id, $this->userId);
+            try {
+                $folder = $this->appData->getFolder('text2image');
+            } catch (NotFoundException) {
+                $res = new DataResponse(['message' => $this->l->t('Image not found')], Http::STATUS_NOT_FOUND);
+                $res->throttle(['action' => 'text2image']);
+                return $res;
+            }
+            $file = $folder->getFolder((string)$task->getId())->getFile((string)$index);
+            $info = getimagesizefromstring($file->getContent());
+
+            return new FileDisplayResponse($file, Http::STATUS_OK, ['Content-Type' => image_type_to_mime_type($info[2])]);
+        } catch (TaskNotFoundException) {
+            $res = new DataResponse(['message' => $this->l->t('Task not found')], Http::STATUS_NOT_FOUND);
+            $res->throttle(['action' => 'text2image']);
+            return $res;
+        } catch (\RuntimeException) {
+            return new DataResponse(['message' => $this->l->t('Internal error')], Http::STATUS_INTERNAL_SERVER_ERROR);
+        } catch (NotFoundException) {
+            $res = new DataResponse(['message' => $this->l->t('Image not found')], Http::STATUS_NOT_FOUND);
+            $res->throttle(['action' => 'text2image']);
+            return $res;
+        }
+    }
+
+    /**
+     * This endpoint allows to delete a scheduled task for a user
+     *
+     * @param int $id The id of the task
+     *
+     * @return DataResponse<Http::STATUS_OK, array{task: CoreTextToImageTask}, array{}>|DataResponse<Http::STATUS_NOT_FOUND|Http::STATUS_INTERNAL_SERVER_ERROR, array{message: string}, array{}>
+     *
+     * 200: Task returned
+     * 404: Task not found
+     */
+    #[NoAdminRequired]
+    #[BruteForceProtection(action: 'text2image')]
+    #[ApiRoute(verb: 'DELETE', url: '/task/{id}', root: '/text2image')]
+    public function deleteTask(int $id): DataResponse {
+        try {
+            $task = $this->textToImageManager->getUserTask($id, $this->userId);
+
+            $this->textToImageManager->deleteTask($task);
+
+            $json = $task->jsonSerialize();
+
+            return new DataResponse([
+                'task' => $json,
+            ]);
+        } catch (TaskNotFoundException) {
+            $res = new DataResponse(['message' => $this->l->t('Task not found')], Http::STATUS_NOT_FOUND);
+            $res->throttle(['action' => 'text2image']);
+            return $res;
+        } catch (\RuntimeException) {
+            return new DataResponse(['message' => $this->l->t('Internal error')], Http::STATUS_INTERNAL_SERVER_ERROR);
+        }
+    }
+
+
+    /**
+     * 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 ID of the app
+     * @param string|null $identifier An arbitrary identifier for the task
+     * @return DataResponse<Http::STATUS_OK, array{tasks: list<CoreTextToImageTask>}, array{}>|DataResponse<Http::STATUS_INTERNAL_SERVER_ERROR, array{message: string}, array{}>
+     *
+     * 200: Task list returned
+     */
+    #[NoAdminRequired]
+    #[AnonRateLimit(limit: 5, period: 120)]
+    #[ApiRoute(verb: 'GET', url: '/tasks/app/{appId}', root: '/text2image')]
+    public function listTasksByApp(string $appId, ?string $identifier = null): DataResponse {
+        try {
+            $tasks = $this->textToImageManager->getUserTasksByApp($this->userId, $appId, $identifier);
+            $json = array_values(array_map(static function (Task $task) {
+                return $task->jsonSerialize();
+            }, $tasks));
+
+            return new DataResponse([
+                'tasks' => $json,
+            ]);
+        } catch (\RuntimeException) {
+            return new DataResponse(['message' => $this->l->t('Internal error')], Http::STATUS_INTERNAL_SERVER_ERROR);
+        }
+    }
 }

core/Controller/TranslationApiController.php

Indentation +57 added lines, -57 removed lines

@@ -25,65 +25,65 @@
 use OCP\Translation\ITranslationManager;
 
 class TranslationApiController extends OCSController {
-	public function __construct(
-		string $appName,
-		IRequest $request,
-		private ITranslationManager $translationManager,
-		private IL10N $l10n,
-	) {
-		parent::__construct($appName, $request);
-	}
+    public function __construct(
+        string $appName,
+        IRequest $request,
+        private ITranslationManager $translationManager,
+        private IL10N $l10n,
+    ) {
+        parent::__construct($appName, $request);
+    }
 
-	/**
-	 * Get the list of supported languages
-	 *
-	 * @return DataResponse<Http::STATUS_OK, array{languages: list<array{from: string, fromLabel: string, to: string, toLabel: string}>, languageDetection: bool}, array{}>
-	 *
-	 * 200: Supported languages returned
-	 */
-	#[PublicPage]
-	#[ApiRoute(verb: 'GET', url: '/languages', root: '/translation')]
-	public function languages(): DataResponse {
-		return new DataResponse([
-			'languages' => array_values(array_map(fn ($lang) => $lang->jsonSerialize(), $this->translationManager->getLanguages())),
-			'languageDetection' => $this->translationManager->canDetectLanguage(),
-		]);
-	}
+    /**
+     * Get the list of supported languages
+     *
+     * @return DataResponse<Http::STATUS_OK, array{languages: list<array{from: string, fromLabel: string, to: string, toLabel: string}>, languageDetection: bool}, array{}>
+     *
+     * 200: Supported languages returned
+     */
+    #[PublicPage]
+    #[ApiRoute(verb: 'GET', url: '/languages', root: '/translation')]
+    public function languages(): DataResponse {
+        return new DataResponse([
+            'languages' => array_values(array_map(fn ($lang) => $lang->jsonSerialize(), $this->translationManager->getLanguages())),
+            'languageDetection' => $this->translationManager->canDetectLanguage(),
+        ]);
+    }
 
-	/**
-	 * Translate a text
-	 *
-	 * @param string $text Text to be translated
-	 * @param string|null $fromLanguage Language to translate from
-	 * @param string $toLanguage Language to translate to
-	 * @return DataResponse<Http::STATUS_OK, array{text: string, from: ?string}, array{}>|DataResponse<Http::STATUS_BAD_REQUEST|Http::STATUS_PRECONDITION_FAILED|Http::STATUS_INTERNAL_SERVER_ERROR, array{message: string, from?: ?string}, array{}>
-	 *
-	 * 200: Translated text returned
-	 * 400: Language not detected or unable to translate
-	 * 412: Translating is not possible
-	 */
-	#[PublicPage]
-	#[UserRateLimit(limit: 25, period: 120)]
-	#[AnonRateLimit(limit: 10, period: 120)]
-	#[ApiRoute(verb: 'POST', url: '/translate', root: '/translation')]
-	public function translate(string $text, ?string $fromLanguage, string $toLanguage): DataResponse {
-		if (strlen($text) > 64_000) {
-			return new DataResponse(['message' => $this->l10n->t('Input text is too long')], Http::STATUS_BAD_REQUEST);
-		}
-		try {
-			$translation = $this->translationManager->translate($text, $fromLanguage, $toLanguage);
+    /**
+     * Translate a text
+     *
+     * @param string $text Text to be translated
+     * @param string|null $fromLanguage Language to translate from
+     * @param string $toLanguage Language to translate to
+     * @return DataResponse<Http::STATUS_OK, array{text: string, from: ?string}, array{}>|DataResponse<Http::STATUS_BAD_REQUEST|Http::STATUS_PRECONDITION_FAILED|Http::STATUS_INTERNAL_SERVER_ERROR, array{message: string, from?: ?string}, array{}>
+     *
+     * 200: Translated text returned
+     * 400: Language not detected or unable to translate
+     * 412: Translating is not possible
+     */
+    #[PublicPage]
+    #[UserRateLimit(limit: 25, period: 120)]
+    #[AnonRateLimit(limit: 10, period: 120)]
+    #[ApiRoute(verb: 'POST', url: '/translate', root: '/translation')]
+    public function translate(string $text, ?string $fromLanguage, string $toLanguage): DataResponse {
+        if (strlen($text) > 64_000) {
+            return new DataResponse(['message' => $this->l10n->t('Input text is too long')], Http::STATUS_BAD_REQUEST);
+        }
+        try {
+            $translation = $this->translationManager->translate($text, $fromLanguage, $toLanguage);
 
-			return new DataResponse([
-				'text' => $translation,
-				'from' => $fromLanguage,
+            return new DataResponse([
+                'text' => $translation,
+                'from' => $fromLanguage,
 
-			]);
-		} catch (PreConditionNotMetException) {
-			return new DataResponse(['message' => $this->l10n->t('No translation provider available')], Http::STATUS_PRECONDITION_FAILED);
-		} catch (InvalidArgumentException) {
-			return new DataResponse(['message' => $this->l10n->t('Could not detect language')], Http::STATUS_BAD_REQUEST);
-		} catch (CouldNotTranslateException $e) {
-			return new DataResponse(['message' => $this->l10n->t('Unable to translate'), 'from' => $e->getFrom()], Http::STATUS_BAD_REQUEST);
-		}
-	}
+            ]);
+        } catch (PreConditionNotMetException) {
+            return new DataResponse(['message' => $this->l10n->t('No translation provider available')], Http::STATUS_PRECONDITION_FAILED);
+        } catch (InvalidArgumentException) {
+            return new DataResponse(['message' => $this->l10n->t('Could not detect language')], Http::STATUS_BAD_REQUEST);
+        } catch (CouldNotTranslateException $e) {
+            return new DataResponse(['message' => $this->l10n->t('Unable to translate'), 'from' => $e->getFrom()], Http::STATUS_BAD_REQUEST);
+        }
+    }
 }