2 files changed, 391 insertions, 0 deletions
diff --git a/lib/private/TaskProcessing/Db/Task.php b/lib/private/TaskProcessing/Db/Task.php
new file mode 100644
index 00000000000..05c0ae9ac74
--- /dev/null
+++ b/lib/private/TaskProcessing/Db/Task.php
@@ -0,0 +1,155 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OC\TaskProcessing\Db;
+
+use OCP\AppFramework\Db\Entity;
+use OCP\TaskProcessing\Task as OCPTask;
+
+/**
+ * @method setType(string $type)
+ * @method string getType()
+ * @method setLastUpdated(int $lastUpdated)
+ * @method int getLastUpdated()
+ * @method setStatus(int $status)
+ * @method int getStatus()
+ * @method setOutput(string $output)
+ * @method string getOutput()
+ * @method setInput(string $input)
+ * @method string getInput()
+ * @method setUserId(?string $userId)
+ * @method string|null getUserId()
+ * @method setAppId(string $type)
+ * @method string getAppId()
+ * @method setCustomId(string $customId)
+ * @method string getCustomId()
+ * @method setCompletionExpectedAt(null|\DateTime $completionExpectedAt)
+ * @method null|\DateTime getCompletionExpectedAt()
+ * @method setErrorMessage(null|string $error)
+ * @method null|string getErrorMessage()
+ * @method setProgress(null|float $progress)
+ * @method null|float getProgress()
+ * @method setWebhookUri(string $webhookUri)
+ * @method string getWebhookUri()
+ * @method setWebhookMethod(string $webhookMethod)
+ * @method string getWebhookMethod()
+ * @method setScheduledAt(int $scheduledAt)
+ * @method int getScheduledAt()
+ * @method setStartedAt(int $startedAt)
+ * @method int getStartedAt()
+ * @method setEndedAt(int $endedAt)
+ * @method int getEndedAt()
+ * @method setAllowCleanup(int $allowCleanup)
+ * @method int getAllowCleanup()
+ */
+class Task extends Entity {
+	protected $lastUpdated;
+	protected $type;
+	protected $input;
+	protected $output;
+	protected $status;
+	protected $userId;
+	protected $appId;
+	protected $customId;
+	protected $completionExpectedAt;
+	protected $errorMessage;
+	protected $progress;
+	protected $webhookUri;
+	protected $webhookMethod;
+	protected $scheduledAt;
+	protected $startedAt;
+	protected $endedAt;
+	protected $allowCleanup;
+
+	/**
+	 * @var string[]
+	 */
+	public static array $columns = ['id', 'last_updated', 'type', 'input', 'output', 'status', 'user_id', 'app_id', 'custom_id', 'completion_expected_at', 'error_message', 'progress', 'webhook_uri', 'webhook_method', 'scheduled_at', 'started_at', 'ended_at', 'allow_cleanup'];
+
+	/**
+	 * @var string[]
+	 */
+	public static array $fields = ['id', 'lastUpdated', 'type', 'input', 'output', 'status', 'userId', 'appId', 'customId', 'completionExpectedAt', 'errorMessage', 'progress', 'webhookUri', 'webhookMethod', 'scheduledAt', 'startedAt', 'endedAt', 'allowCleanup'];
+
+
+	public function __construct() {
+		// add types in constructor
+		$this->addType('id', 'integer');
+		$this->addType('lastUpdated', 'integer');
+		$this->addType('type', 'string');
+		$this->addType('input', 'string');
+		$this->addType('output', 'string');
+		$this->addType('status', 'integer');
+		$this->addType('userId', 'string');
+		$this->addType('appId', 'string');
+		$this->addType('customId', 'string');
+		$this->addType('completionExpectedAt', 'datetime');
+		$this->addType('errorMessage', 'string');
+		$this->addType('progress', 'float');
+		$this->addType('webhookUri', 'string');
+		$this->addType('webhookMethod', 'string');
+		$this->addType('scheduledAt', 'integer');
+		$this->addType('startedAt', 'integer');
+		$this->addType('endedAt', 'integer');
+		$this->addType('allowCleanup', 'integer');
+	}
+
+	public function toRow(): array {
+		return array_combine(self::$columns, array_map(function ($field) {
+			return $this->{'get' . ucfirst($field)}();
+		}, self::$fields));
+	}
+
+	public static function fromPublicTask(OCPTask $task): self {
+		/** @var Task $taskEntity */
+		$taskEntity = self::fromParams([
+			'id' => $task->getId(),
+			'type' => $task->getTaskTypeId(),
+			'lastUpdated' => time(),
+			'status' => $task->getStatus(),
+			'input' => json_encode($task->getInput(), JSON_THROW_ON_ERROR),
+			'output' => json_encode($task->getOutput(), JSON_THROW_ON_ERROR),
+			'errorMessage' => $task->getErrorMessage(),
+			'userId' => $task->getUserId(),
+			'appId' => $task->getAppId(),
+			'customId' => $task->getCustomId(),
+			'completionExpectedAt' => $task->getCompletionExpectedAt(),
+			'progress' => $task->getProgress(),
+			'webhookUri' => $task->getWebhookUri(),
+			'webhookMethod' => $task->getWebhookMethod(),
+			'scheduledAt' => $task->getScheduledAt(),
+			'startedAt' => $task->getStartedAt(),
+			'endedAt' => $task->getEndedAt(),
+			'allowCleanup' => $task->getAllowCleanup() ? 1 : 0,
+		]);
+		return $taskEntity;
+	}
+
+	/**
+	 * @return OCPTask
+	 * @throws \JsonException
+	 */
+	public function toPublicTask(): OCPTask {
+		$task = new OCPTask($this->getType(), json_decode($this->getInput(), true, 512, JSON_THROW_ON_ERROR), $this->getAppId(), $this->getuserId(), $this->getCustomId());
+		$task->setId($this->getId());
+		$task->setStatus($this->getStatus());
+		$task->setLastUpdated($this->getLastUpdated());
+		$task->setOutput(json_decode($this->getOutput(), true, 512, JSON_THROW_ON_ERROR));
+		$task->setCompletionExpectedAt($this->getCompletionExpectedAt());
+		$task->setErrorMessage($this->getErrorMessage());
+		$task->setProgress($this->getProgress());
+		$task->setWebhookUri($this->getWebhookUri());
+		$task->setWebhookMethod($this->getWebhookMethod());
+		$task->setScheduledAt($this->getScheduledAt());
+		$task->setStartedAt($this->getStartedAt());
+		$task->setEndedAt($this->getEndedAt());
+		$task->setAllowCleanup($this->getAllowCleanup() !== 0);
+		return $task;
+	}
+}
diff --git a/lib/private/TaskProcessing/Db/TaskMapper.php b/lib/private/TaskProcessing/Db/TaskMapper.php
new file mode 100644
index 00000000000..fee96534633
--- /dev/null
+++ b/lib/private/TaskProcessing/Db/TaskMapper.php
@@ -0,0 +1,236 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OC\TaskProcessing\Db;
+
+use OCP\AppFramework\Db\DoesNotExistException;
+use OCP\AppFramework\Db\Entity;
+use OCP\AppFramework\Db\MultipleObjectsReturnedException;
+use OCP\AppFramework\Db\QBMapper;
+use OCP\AppFramework\Utility\ITimeFactory;
+use OCP\DB\Exception;
+use OCP\DB\QueryBuilder\IQueryBuilder;
+use OCP\IDBConnection;
+
+/**
+ * @extends QBMapper<Task>
+ */
+class TaskMapper extends QBMapper {
+	public function __construct(
+		IDBConnection $db,
+		private ITimeFactory $timeFactory,
+	) {
+		parent::__construct($db, 'taskprocessing_tasks', Task::class);
+	}
+
+	/**
+	 * @param int $id
+	 * @return Task
+	 * @throws Exception
+	 * @throws DoesNotExistException
+	 * @throws MultipleObjectsReturnedException
+	 */
+	public function find(int $id): Task {
+		$qb = $this->db->getQueryBuilder();
+		$qb->select(Task::$columns)
+			->from($this->tableName)
+			->where($qb->expr()->eq('id', $qb->createPositionalParameter($id)));
+		return $this->findEntity($qb);
+	}
+
+	/**
+	 * @param list<string> $taskTypes
+	 * @param list<int> $taskIdsToIgnore
+	 * @return Task
+	 * @throws DoesNotExistException
+	 * @throws Exception
+	 */
+	public function findOldestScheduledByType(array $taskTypes, array $taskIdsToIgnore): Task {
+		$qb = $this->db->getQueryBuilder();
+		$qb->select(Task::$columns)
+			->from($this->tableName)
+			->where($qb->expr()->eq('status', $qb->createPositionalParameter(\OCP\TaskProcessing\Task::STATUS_SCHEDULED, IQueryBuilder::PARAM_INT)))
+			->setMaxResults(1)
+			->orderBy('last_updated', 'ASC');
+
+		if (!empty($taskTypes)) {
+			$filter = [];
+			foreach ($taskTypes as $taskType) {
+				$filter[] = $qb->expr()->eq('type', $qb->createPositionalParameter($taskType));
+			}
+
+			$qb->andWhere($qb->expr()->orX(...$filter));
+		}
+
+		if (!empty($taskIdsToIgnore)) {
+			$qb->andWhere($qb->expr()->notIn('id', $qb->createNamedParameter($taskIdsToIgnore, IQueryBuilder::PARAM_INT_ARRAY)));
+		}
+
+		return $this->findEntity($qb);
+	}
+
+	/**
+	 * @param int $id
+	 * @param string|null $userId
+	 * @return Task
+	 * @throws DoesNotExistException
+	 * @throws Exception
+	 * @throws MultipleObjectsReturnedException
+	 */
+	public function findByIdAndUser(int $id, ?string $userId): Task {
+		$qb = $this->db->getQueryBuilder();
+		$qb->select(Task::$columns)
+			->from($this->tableName)
+			->where($qb->expr()->eq('id', $qb->createPositionalParameter($id)));
+		if ($userId === null) {
+			$qb->andWhere($qb->expr()->isNull('user_id'));
+		} else {
+			$qb->andWhere($qb->expr()->eq('user_id', $qb->createPositionalParameter($userId)));
+		}
+		return $this->findEntity($qb);
+	}
+
+	/**
+	 * @param string|null $userId
+	 * @param string|null $taskType
+	 * @param string|null $customId
+	 * @return list<Task>
+	 * @throws Exception
+	 */
+	public function findByUserAndTaskType(?string $userId, ?string $taskType = null, ?string $customId = null): array {
+		$qb = $this->db->getQueryBuilder();
+		$qb->select(Task::$columns)
+			->from($this->tableName)
+			->where($qb->expr()->eq('user_id', $qb->createPositionalParameter($userId)));
+		if ($taskType !== null) {
+			$qb->andWhere($qb->expr()->eq('type', $qb->createPositionalParameter($taskType)));
+		}
+		if ($customId !== null) {
+			$qb->andWhere($qb->expr()->eq('custom_id', $qb->createPositionalParameter($customId)));
+		}
+		return $this->findEntities($qb);
+	}
+
+	/**
+	 * @param string $userId
+	 * @param string $appId
+	 * @param string|null $customId
+	 * @return list<Task>
+	 * @throws Exception
+	 */
+	public function findUserTasksByApp(?string $userId, string $appId, ?string $customId = null): array {
+		$qb = $this->db->getQueryBuilder();
+		$qb->select(Task::$columns)
+			->from($this->tableName)
+			->where($qb->expr()->eq('user_id', $qb->createPositionalParameter($userId)))
+			->andWhere($qb->expr()->eq('app_id', $qb->createPositionalParameter($appId)));
+		if ($customId !== null) {
+			$qb->andWhere($qb->expr()->eq('custom_id', $qb->createPositionalParameter($customId)));
+		}
+		return $this->findEntities($qb);
+	}
+
+	/**
+	 * @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 list<Task>
+	 * @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);
+
+		// empty string: no userId filter
+		if ($userId !== '') {
+			$qb->where($qb->expr()->eq('user_id', $qb->createPositionalParameter($userId)));
+		}
+		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)));
+		}
+		if ($status !== null) {
+			$qb->andWhere($qb->expr()->eq('status', $qb->createPositionalParameter($status, IQueryBuilder::PARAM_INT)));
+		}
+		if ($scheduleAfter !== null) {
+			$qb->andWhere($qb->expr()->isNotNull('scheduled_at'));
+			$qb->andWhere($qb->expr()->gt('scheduled_at', $qb->createPositionalParameter($scheduleAfter, IQueryBuilder::PARAM_INT)));
+		}
+		if ($endedBefore !== null) {
+			$qb->andWhere($qb->expr()->isNotNull('ended_at'));
+			$qb->andWhere($qb->expr()->lt('ended_at', $qb->createPositionalParameter($endedBefore, IQueryBuilder::PARAM_INT)));
+		}
+		return $this->findEntities($qb);
+	}
+
+	/**
+	 * @param int $timeout
+	 * @param bool $force If true, ignore the allow_cleanup flag
+	 * @return int the number of deleted tasks
+	 * @throws Exception
+	 */
+	public function deleteOlderThan(int $timeout, bool $force = false): int {
+		$qb = $this->db->getQueryBuilder();
+		$qb->delete($this->tableName)
+			->where($qb->expr()->lt('last_updated', $qb->createPositionalParameter($this->timeFactory->getDateTime()->getTimestamp() - $timeout)));
+		if (!$force) {
+			$qb->andWhere($qb->expr()->eq('allow_cleanup', $qb->createPositionalParameter(1, IQueryBuilder::PARAM_INT)));
+		}
+		return $qb->executeStatement();
+	}
+
+	/**
+	 * @param int $timeout
+	 * @param bool $force If true, ignore the allow_cleanup flag
+	 * @return \Generator<Task>
+	 * @throws Exception
+	 */
+	public function getTasksToCleanup(int $timeout, bool $force = false): \Generator {
+		$qb = $this->db->getQueryBuilder();
+		$qb->select(Task::$columns)
+			->from($this->tableName)
+			->where($qb->expr()->lt('last_updated', $qb->createPositionalParameter($this->timeFactory->getDateTime()->getTimestamp() - $timeout)));
+		if (!$force) {
+			$qb->andWhere($qb->expr()->eq('allow_cleanup', $qb->createPositionalParameter(1, IQueryBuilder::PARAM_INT)));
+		}
+		foreach ($this->yieldEntities($qb) as $entity) {
+			yield $entity;
+		};
+	}
+
+	public function update(Entity $entity): Entity {
+		$entity->setLastUpdated($this->timeFactory->now()->getTimestamp());
+		return parent::update($entity);
+	}
+
+	public function lockTask(Entity $entity): int {
+		$qb = $this->db->getQueryBuilder();
+		$qb->update($this->tableName)
+			->set('status', $qb->createPositionalParameter(\OCP\TaskProcessing\Task::STATUS_RUNNING, IQueryBuilder::PARAM_INT))
+			->where($qb->expr()->eq('id', $qb->createPositionalParameter($entity->getId(), IQueryBuilder::PARAM_INT)))
+			->andWhere($qb->expr()->neq('status', $qb->createPositionalParameter(2, IQueryBuilder::PARAM_INT)));
+		try {
+			return $qb->executeStatement();
+		} catch (Exception) {
+			return 0;
+		}
+	}
+}