Skip to content

Commit

Permalink
start implementing ocs endpoint to get task list from user+appId+iden…
Browse files Browse the repository at this point in the history
…tifier

Signed-off-by: Julien Veyssier <[email protected]>
  • Loading branch information
julien-nc committed Aug 3, 2023
1 parent 9a7e2b1 commit dabc537
Show file tree
Hide file tree
Showing 5 changed files with 78 additions and 1 deletion.
32 changes: 32 additions & 0 deletions core/Controller/TextProcessingApiController.php
Original file line number Diff line number Diff line change
Expand Up @@ -157,4 +157,36 @@ public function getTask(int $id): DataResponse {
return new DataResponse(['message' => $this->l->t('Internal error')], Http::STATUS_INTERNAL_SERVER_ERROR);
}
}

/**
* This endpoint returns a list of tasks related with a specific appId and identifier
*
* @PublicPage
* @UserRateThrottle(limit=20, period=120)
*
* @param string $appId
* @param string|null $identifier
* @return DataResponse<Http::STATUS_OK, array{tasks: array{CoreTextProcessingTask}}, array{}>|DataResponse<Http::STATUS_INTERNAL_SERVER_ERROR, array{message: string}, array{}>
*
* 200: Task list returned
*/
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);
$json = 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);
}
}
}
1 change: 1 addition & 0 deletions core/routes.php
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,7 @@
['root' => '/textprocessing', 'name' => 'TextProcessingApi#taskTypes', 'url' => '/tasktypes', 'verb' => 'GET'],
['root' => '/textprocessing', 'name' => 'TextProcessingApi#schedule', 'url' => '/schedule', 'verb' => 'POST'],
['root' => '/textprocessing', 'name' => 'TextProcessingApi#getTask', 'url' => '/task/{id}', 'verb' => 'GET'],
['root' => '/textprocessing', 'name' => 'TextProcessingApi#listTasksByApp', 'url' => '/tasks/app/{appId}', 'verb' => 'GET'],
],
]);

Expand Down
19 changes: 19 additions & 0 deletions lib/private/TextProcessing/Db/TaskMapper.php
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,25 @@ public function find(int $id): Task {
return $this->findEntity($qb);
}

/**
* @param string $userId
* @param string $appId
* @param string|null $identifier
* @return array
* @throws Exception
*/
public function findByApp(string $userId, string $appId, ?string $identifier = null): array {
$qb = $this->db->getQueryBuilder();
$qb->select(Task::$columns)
->from($this->tableName)
->where($qb->expr()->eq('app_id', $qb->createPositionalParameter($appId)))
->andWhere($qb->expr()->eq('user_id', $qb->createPositionalParameter($userId)));
if ($identifier !== null) {
$qb->andWhere($qb->expr()->eq('identifier', $qb->createPositionalParameter($identifier)));
}
return $this->findEntities($qb);
}

/**
* @param int $timeout
* @return int the number of deleted tasks
Expand Down
19 changes: 18 additions & 1 deletion lib/private/TextProcessing/Manager.php
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,24 @@ public function getTask(int $id): OCPTask {
} catch (MultipleObjectsReturnedException $e) {
throw new RuntimeException('Could not uniquely identify task with given id', 0, $e);
} catch (Exception $e) {
throw new RuntimeException('Failure while trying to find task by id: '.$e->getMessage(), 0, $e);
throw new RuntimeException('Failure while trying to find task by id: ' . $e->getMessage(), 0, $e);
}
}

/**
* @param string $userId
* @param string $appId
* @param string|null $identifier
* @return array
*/
public function getTasksByApp(string $userId, string $appId, ?string $identifier = null): array {
try {
$taskEntities = $this->taskMapper->findByApp($userId, $appId, $identifier);
return array_map(static function (DbTask $taskEntity) {
return $taskEntity->toPublicTask();
}, $taskEntities);
} catch (Exception $e) {
throw new RuntimeException('Failure while trying to find tasks by appId and identifier: ' . $e->getMessage(), 0, $e);
}
}
}
8 changes: 8 additions & 0 deletions lib/public/TextProcessing/IManager.php
Original file line number Diff line number Diff line change
Expand Up @@ -80,4 +80,12 @@ public function scheduleTask(Task $task) : void;
* @since 27.1.0
*/
public function getTask(int $id): Task;

/**
* @param string $userId
* @param string $appId
* @param string|null $identifier
* @return array
*/
public function getTasksByApp(string $userId, string $appId, ?string $identifier = null): array;
}

0 comments on commit dabc537

Please sign in to comment.