* * 200: Returns availability status */ #[PublicPage] #[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|DataResponse * * 200: Task scheduled successfully * 412: Scheduling task is not possible */ #[PublicPage] #[UserRateLimit(limit: 20, period: 120)] #[AnonRateLimit(limit: 5, period: 120)] #[ApiRoute(verb: 'POST', url: '/schedule', root: '/text2image')] public function schedule(string $input, string $appId, string $identifier = '', int $numberOfImages = 8): DataResponse { $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|DataResponse * * 200: Task returned * 404: Task not found */ #[PublicPage] #[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|DataResponse * * 200: Image returned * 404: Task or image not found */ #[PublicPage] #[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|DataResponse * * 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|DataResponse * * 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); /** @var CoreTextToImageTask[] $json */ $json = 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); } } }