feat(taskprocessing): add appId filter to taskprocessing occ commands

Signed-off-by: Julien Veyssier <julien-nc@posteo.net>
nextcloud · Jul 23, 2024 · 0f2da49 · 0f2da49
1 parent 0780bd3
commit 0f2da49
Show file tree

Hide file tree

Showing 5 changed files with 40 additions and 7 deletions.
diff --git a/core/Command/TaskProcessing/ListCommand.php b/core/Command/TaskProcessing/ListCommand.php
@@ -35,6 +35,12 @@ protected function configure() {
 				InputOption::VALUE_OPTIONAL,
 				'only get the tasks for one task type'
 			)
+			->addOption(
+				'appId',
+				null,
+				InputOption::VALUE_OPTIONAL,
+				'only get the tasks for one app ID'
+			)
 			->addOption(
 				'customId',
 				null,
@@ -70,12 +76,13 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 			$userIdFilter = null;
 		}
 		$type = $input->getOption('type');
+		$appId = $input->getOption('appId');
 		$customId = $input->getOption('customId');
 		$status = $input->getOption('status');
 		$scheduledAfter = $input->getOption('scheduledAfter');
 		$endedBefore = $input->getOption('endedBefore');
 
-		$tasks = $this->taskProcessingManager->getTasks($userIdFilter, $type, $customId, $status, $scheduledAfter, $endedBefore);
+		$tasks = $this->taskProcessingManager->getTasks($userIdFilter, $type, $appId, $customId, $status, $scheduledAfter, $endedBefore);
 		$arrayTasks = array_map(fn (Task $task): array => $task->jsonSerialize(), $tasks);
 
 		$this->writeArrayInOutputFormat($input, $output, $arrayTasks);

diff --git a/core/Command/TaskProcessing/Statistics.php b/core/Command/TaskProcessing/Statistics.php
@@ -35,6 +35,12 @@ protected function configure() {
 				InputOption::VALUE_OPTIONAL,
 				'only get the tasks for one task type'
 			)
+			->addOption(
+				'appId',
+				null,
+				InputOption::VALUE_OPTIONAL,
+				'only get the tasks for one app ID'
+			)
 			->addOption(
 				'customId',
 				null,
@@ -70,12 +76,13 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 			$userIdFilter = null;
 		}
 		$type = $input->getOption('type');
+		$appId = $input->getOption('appId');
 		$customId = $input->getOption('customId');
 		$status = $input->getOption('status');
 		$scheduledAfter = $input->getOption('scheduledAfter');
 		$endedBefore = $input->getOption('endedBefore');
 
-		$tasks = $this->taskProcessingManager->getTasks($userIdFilter, $type, $customId, $status, $scheduledAfter, $endedBefore);
+		$tasks = $this->taskProcessingManager->getTasks($userIdFilter, $type, $appId, $customId, $status, $scheduledAfter, $endedBefore);
 
 		$stats = ['Number of tasks' => count($tasks)];
 

diff --git a/lib/private/TaskProcessing/Db/TaskMapper.php b/lib/private/TaskProcessing/Db/TaskMapper.php
@@ -136,7 +136,20 @@ public function findUserTasksByApp(?string $userId, string $appId, ?string $cust
 		return array_values($this->findEntities($qb));
 	}
 
-	public function findTasks(?string $userId, ?string $taskType = null, ?string $customId = null, ?int $status = null, ?int $scheduleAfter = null, ?int $endedBefore = null): array {
+	/**
+	 * @param string|null $userId
+	 * @param string|null $taskType
+	 * @param string|null $appId
+	 * @param string|null $customId
+	 * @param int|null $status
+	 * @param int|null $scheduleAfter
+	 * @param int|null $endedBefore
+	 * @return array
+	 * @throws Exception
+	 */
+	public function findTasks(
+		?string $userId, ?string $taskType = null, ?string $appId = null, ?string $customId = null,
+		?int $status = null, ?int $scheduleAfter = null, ?int $endedBefore = null): array {
 		$qb = $this->db->getQueryBuilder();
 		$qb->select(Task::$columns)
 			->from($this->tableName);
@@ -148,6 +161,9 @@ public function findTasks(?string $userId, ?string $taskType = null, ?string $cu
 		if ($taskType !== null) {
 			$qb->andWhere($qb->expr()->eq('type', $qb->createPositionalParameter($taskType)));
 		}
+		if ($appId !== null) {
+			$qb->andWhere($qb->expr()->eq('app_id', $qb->createPositionalParameter($appId)));
+		}
 		if ($customId !== null) {
 			$qb->andWhere($qb->expr()->eq('custom_id', $qb->createPositionalParameter($customId)));
 		}

diff --git a/lib/private/TaskProcessing/Manager.php b/lib/private/TaskProcessing/Manager.php
@@ -851,10 +851,11 @@ public function getUserTasks(?string $userId, ?string $taskTypeId = null, ?strin
 	}
 
 	public function getTasks(
-		?string $userId, ?string $taskTypeId = null, ?string $customId = null, ?int $status = null, ?int $scheduleAfter = null, ?int $endedBefore = null
+		?string $userId, ?string $taskTypeId = null, ?string $appId = null, ?string $customId = null,
+		?int $status = null, ?int $scheduleAfter = null, ?int $endedBefore = null
 	): array {
 		try {
-			$taskEntities = $this->taskMapper->findTasks($userId, $taskTypeId, $customId, $status, $scheduleAfter, $endedBefore);
+			$taskEntities = $this->taskMapper->findTasks($userId, $taskTypeId, $appId, $customId, $status, $scheduleAfter, $endedBefore);
 			return array_map(fn ($taskEntity): Task => $taskEntity->toPublicTask(), $taskEntities);
 		} catch (\OCP\DB\Exception $e) {
 			throw new \OCP\TaskProcessing\Exception\Exception('There was a problem finding the tasks', 0, $e);

diff --git a/lib/public/TaskProcessing/IManager.php b/lib/public/TaskProcessing/IManager.php
@@ -143,7 +143,8 @@ public function getUserTasks(?string $userId, ?string $taskTypeId = null, ?strin
 	/**
 	 * @param string|null $userId The user id that scheduled the task
 	 * @param string|null $taskTypeId The task type id to filter by
-	 * @param string|null $customId
+	 * @param string|null $appId The app ID of the app that submitted the task
+	 * @param string|null $customId The custom task ID
 	 * @param int|null $status The task status
 	 * @param int|null $scheduleAfter Minimum schedule time filter
 	 * @param int|null $endedBefore Maximum ending time filter
@@ -153,7 +154,8 @@ public function getUserTasks(?string $userId, ?string $taskTypeId = null, ?strin
 	 * @since 30.0.0
 	 */
 	public function getTasks(
-		?string $userId, ?string $taskTypeId = null, ?string $customId = null, ?int $status = null, ?int $scheduleAfter = null, ?int $endedBefore = null
+		?string $userId, ?string $taskTypeId = null, ?string $appId = null, ?string $customId = null,
+		?int $status = null, ?int $scheduleAfter = null, ?int $endedBefore = null
 	): array;
 
 	/**