nextcloud / server

lib/public/BackgroundJob/IJobList.php

Indentation +85 added lines, -85 removed lines

@@ -48,101 +48,101 @@
  * @since 7.0.0
  */
 interface IJobList {
-	/**
-	 * Add a job to the list
-	 *
-	 * @param IJob|class-string<IJob> $job
-	 * @param mixed $argument The argument to be passed to $job->run() when the job is exectured
-	 * @since 7.0.0
-	 */
-	public function add($job, $argument = null): void;
+    /**
+     * Add a job to the list
+     *
+     * @param IJob|class-string<IJob> $job
+     * @param mixed $argument The argument to be passed to $job->run() when the job is exectured
+     * @since 7.0.0
+     */
+    public function add($job, $argument = null): void;
 
-	/**
-	 * Remove a job from the list
-	 *
-	 * @param IJob|class-string<IJob> $job
-	 * @param mixed $argument
-	 * @since 7.0.0
-	 */
-	public function remove($job, $argument = null): void;
+    /**
+     * Remove a job from the list
+     *
+     * @param IJob|class-string<IJob> $job
+     * @param mixed $argument
+     * @since 7.0.0
+     */
+    public function remove($job, $argument = null): void;
 
-	/**
-	 * check if a job is in the list
-	 *
-	 * @param IJob|class-string<IJob> $job
-	 * @param mixed $argument
-	 * @since 7.0.0
-	 */
-	public function has($job, $argument): bool;
+    /**
+     * check if a job is in the list
+     *
+     * @param IJob|class-string<IJob> $job
+     * @param mixed $argument
+     * @since 7.0.0
+     */
+    public function has($job, $argument): bool;
 
-	/**
-	 * Get jobs matching the search
-	 *
-	 * @param IJob|class-string<IJob>|null $job
-	 * @return array<IJob>
-	 * @since 25.0.0
-	 * @deprecated 26.0.0 Use getJobsIterator instead to avoid duplicated job objects
-	 */
-	public function getJobs($job, ?int $limit, int $offset): array;
+    /**
+     * Get jobs matching the search
+     *
+     * @param IJob|class-string<IJob>|null $job
+     * @return array<IJob>
+     * @since 25.0.0
+     * @deprecated 26.0.0 Use getJobsIterator instead to avoid duplicated job objects
+     */
+    public function getJobs($job, ?int $limit, int $offset): array;
 
-	/**
-	 * Get jobs matching the search
-	 *
-	 * @param IJob|class-string<IJob>|null $job
-	 * @return iterable<IJob>
-	 * @since 26.0.0
-	 */
-	public function getJobsIterator($job, ?int $limit, int $offset): iterable;
+    /**
+     * Get jobs matching the search
+     *
+     * @param IJob|class-string<IJob>|null $job
+     * @return iterable<IJob>
+     * @since 26.0.0
+     */
+    public function getJobsIterator($job, ?int $limit, int $offset): iterable;
 
-	/**
-	 * get the next job in the list
-	 *
-	 * @since 7.0.0 - In 24.0.0 parameter $onlyTimeSensitive got added
-	 */
-	public function getNext(bool $onlyTimeSensitive = false): ?IJob;
+    /**
+     * get the next job in the list
+     *
+     * @since 7.0.0 - In 24.0.0 parameter $onlyTimeSensitive got added
+     */
+    public function getNext(bool $onlyTimeSensitive = false): ?IJob;
 
-	/**
-	 * @since 7.0.0
-	 */
-	public function getById(int $id): ?IJob;
+    /**
+     * @since 7.0.0
+     */
+    public function getById(int $id): ?IJob;
 
-	/**
-	 * @since 23.0.0
-	 */
-	public function getDetailsById(int $id): ?array;
+    /**
+     * @since 23.0.0
+     */
+    public function getDetailsById(int $id): ?array;
 
-	/**
-	 * set the job that was last ran to the current time
-	 *
-	 * @since 7.0.0
-	 */
-	public function setLastJob(IJob $job): void;
+    /**
+     * set the job that was last ran to the current time
+     *
+     * @since 7.0.0
+     */
+    public function setLastJob(IJob $job): void;
 
-	/**
-	 * Remove the reservation for a job
-	 *
-	 * @since 9.1.0
-	 */
-	public function unlockJob(IJob $job): void;
+    /**
+     * Remove the reservation for a job
+     *
+     * @since 9.1.0
+     */
+    public function unlockJob(IJob $job): void;
 
-	/**
-	 * set the lastRun of $job to now
-	 *
-	 * @since 7.0.0
-	 */
-	public function setLastRun(IJob $job): void;
+    /**
+     * set the lastRun of $job to now
+     *
+     * @since 7.0.0
+     */
+    public function setLastRun(IJob $job): void;
 
-	/**
-	 * set the run duration of $job
-	 *
-	 * @since 12.0.0
-	 */
-	public function setExecutionTime(IJob $job, int $timeTaken): void;
+    /**
+     * set the run duration of $job
+     *
+     * @since 12.0.0
+     */
+    public function setExecutionTime(IJob $job, int $timeTaken): void;
 
-	/**
-	 * Reset the $job so it executes on the next trigger
-	 *
-	 * @since 23.0.0
-	 */
-	public function resetBackgroundJob(IJob $job): void;
+    /**
+     * Reset the $job so it executes on the next trigger
+     *
+     * @since 23.0.0
+     */
+    public function resetBackgroundJob(IJob $job): void;
 }

lib/private/BackgroundJob/JobList.php

Indentation +342 added lines, -342 removed lines

@@ -40,346 +40,346 @@
 use OCP\IDBConnection;
 
 class JobList implements IJobList {
-	protected IDBConnection $connection;
-	protected IConfig $config;
-	protected ITimeFactory $timeFactory;
-
-	public function __construct(IDBConnection $connection, IConfig $config, ITimeFactory $timeFactory) {
-		$this->connection = $connection;
-		$this->config = $config;
-		$this->timeFactory = $timeFactory;
-	}
-
-	/**
-	 * @param IJob|class-string<IJob> $job
-	 * @param mixed $argument
-	 */
-	public function add($job, $argument = null): void {
-		if ($job instanceof IJob) {
-			$class = get_class($job);
-		} else {
-			$class = $job;
-		}
-
-		$argumentJson = json_encode($argument);
-		if (strlen($argumentJson) > 4000) {
-			throw new \InvalidArgumentException('Background job arguments can\'t exceed 4000 characters (json encoded)');
-		}
-
-		$query = $this->connection->getQueryBuilder();
-		if (!$this->has($job, $argument)) {
-			$query->insert('jobs')
-				->values([
-					'class' => $query->createNamedParameter($class),
-					'argument' => $query->createNamedParameter($argumentJson),
-					'argument_hash' => $query->createNamedParameter(md5($argumentJson)),
-					'last_run' => $query->createNamedParameter(0, IQueryBuilder::PARAM_INT),
-					'last_checked' => $query->createNamedParameter($this->timeFactory->getTime(), IQueryBuilder::PARAM_INT),
-				]);
-		} else {
-			$query->update('jobs')
-				->set('reserved_at', $query->expr()->literal(0, IQueryBuilder::PARAM_INT))
-				->set('last_checked', $query->createNamedParameter($this->timeFactory->getTime(), IQueryBuilder::PARAM_INT))
-				->where($query->expr()->eq('class', $query->createNamedParameter($class)))
-				->andWhere($query->expr()->eq('argument_hash', $query->createNamedParameter(md5($argumentJson))));
-		}
-		$query->executeStatement();
-	}
-
-	/**
-	 * @param IJob|string $job
-	 * @param mixed $argument
-	 */
-	public function remove($job, $argument = null): void {
-		if ($job instanceof IJob) {
-			$class = get_class($job);
-		} else {
-			$class = $job;
-		}
-
-		$query = $this->connection->getQueryBuilder();
-		$query->delete('jobs')
-			->where($query->expr()->eq('class', $query->createNamedParameter($class)));
-		if (!is_null($argument)) {
-			$argumentJson = json_encode($argument);
-			$query->andWhere($query->expr()->eq('argument_hash', $query->createNamedParameter(md5($argumentJson))));
-		}
-
-		// Add galera safe delete chunking if using mysql
-		// Stops us hitting wsrep_max_ws_rows when large row counts are deleted
-		if ($this->connection->getDatabasePlatform() instanceof MySQLPlatform) {
-			// Then use chunked delete
-			$max = IQueryBuilder::MAX_ROW_DELETION;
-
-			$query->setMaxResults($max);
-
-			do {
-				$deleted = $query->execute();
-			} while ($deleted === $max);
-		} else {
-			// Dont use chunked delete - let the DB handle the large row count natively
-			$query->execute();
-		}
-	}
-
-	protected function removeById(int $id): void {
-		$query = $this->connection->getQueryBuilder();
-		$query->delete('jobs')
-			->where($query->expr()->eq('id', $query->createNamedParameter($id, IQueryBuilder::PARAM_INT)));
-		$query->executeStatement();
-	}
-
-	/**
-	 * check if a job is in the list
-	 *
-	 * @param IJob|class-string<IJob> $job
-	 * @param mixed $argument
-	 */
-	public function has($job, $argument): bool {
-		if ($job instanceof IJob) {
-			$class = get_class($job);
-		} else {
-			$class = $job;
-		}
-		$argument = json_encode($argument);
-
-		$query = $this->connection->getQueryBuilder();
-		$query->select('id')
-			->from('jobs')
-			->where($query->expr()->eq('class', $query->createNamedParameter($class)))
-			->andWhere($query->expr()->eq('argument_hash', $query->createNamedParameter(md5($argument))))
-			->setMaxResults(1);
-
-		$result = $query->executeQuery();
-		$row = $result->fetch();
-		$result->closeCursor();
-
-		return (bool) $row;
-	}
-
-	public function getJobs($job, ?int $limit, int $offset): array {
-		$iterable = $this->getJobsIterator($job, $limit, $offset);
-		if (is_array($iterable)) {
-			return $iterable;
-		} else {
-			return iterator_to_array($iterable);
-		}
-	}
-
-	/**
-	 * @param IJob|class-string<IJob>|null $job
-	 * @return iterable<IJob> Avoid to store these objects as they may share a Singleton instance. You should instead use these IJobs instances while looping on the iterable.
-	 */
-	public function getJobsIterator($job, ?int $limit, int $offset): iterable {
-		$query = $this->connection->getQueryBuilder();
-		$query->select('*')
-			->from('jobs')
-			->setMaxResults($limit)
-			->setFirstResult($offset);
-
-		if ($job !== null) {
-			if ($job instanceof IJob) {
-				$class = get_class($job);
-			} else {
-				$class = $job;
-			}
-			$query->where($query->expr()->eq('class', $query->createNamedParameter($class)));
-		}
-
-		$result = $query->executeQuery();
-
-		while ($row = $result->fetch()) {
-			$job = $this->buildJob($row);
-			if ($job) {
-				yield $job;
-			}
-		}
-		$result->closeCursor();
-	}
-
-	/**
-	 * Get the next job in the list
-	 * @return ?IJob the next job to run. Beware that this object may be a singleton and may be modified by the next call to buildJob.
-	 */
-	public function getNext(bool $onlyTimeSensitive = false): ?IJob {
-		$query = $this->connection->getQueryBuilder();
-		$query->select('*')
-			->from('jobs')
-			->where($query->expr()->lte('reserved_at', $query->createNamedParameter($this->timeFactory->getTime() - 12 * 3600, IQueryBuilder::PARAM_INT)))
-			->andWhere($query->expr()->lte('last_checked', $query->createNamedParameter($this->timeFactory->getTime(), IQueryBuilder::PARAM_INT)))
-			->orderBy('last_checked', 'ASC')
-			->setMaxResults(1);
-
-		if ($onlyTimeSensitive) {
-			$query->andWhere($query->expr()->eq('time_sensitive', $query->createNamedParameter(IJob::TIME_SENSITIVE, IQueryBuilder::PARAM_INT)));
-		}
-
-		$update = $this->connection->getQueryBuilder();
-		$update->update('jobs')
-			->set('reserved_at', $update->createNamedParameter($this->timeFactory->getTime()))
-			->set('last_checked', $update->createNamedParameter($this->timeFactory->getTime()))
-			->where($update->expr()->eq('id', $update->createParameter('jobid')))
-			->andWhere($update->expr()->eq('reserved_at', $update->createParameter('reserved_at')))
-			->andWhere($update->expr()->eq('last_checked', $update->createParameter('last_checked')));
-
-		$result = $query->executeQuery();
-		$row = $result->fetch();
-		$result->closeCursor();
-
-		if ($row) {
-			$update->setParameter('jobid', $row['id']);
-			$update->setParameter('reserved_at', $row['reserved_at']);
-			$update->setParameter('last_checked', $row['last_checked']);
-			$count = $update->executeStatement();
-
-			if ($count === 0) {
-				// Background job already executed elsewhere, try again.
-				return $this->getNext($onlyTimeSensitive);
-			}
-			$job = $this->buildJob($row);
-
-			if ($job === null) {
-				// set the last_checked to 12h in the future to not check failing jobs all over again
-				$reset = $this->connection->getQueryBuilder();
-				$reset->update('jobs')
-					->set('reserved_at', $reset->expr()->literal(0, IQueryBuilder::PARAM_INT))
-					->set('last_checked', $reset->createNamedParameter($this->timeFactory->getTime() + 12 * 3600, IQueryBuilder::PARAM_INT))
-					->where($reset->expr()->eq('id', $reset->createNamedParameter($row['id'], IQueryBuilder::PARAM_INT)));
-				$reset->executeStatement();
-
-				// Background job from disabled app, try again.
-				return $this->getNext($onlyTimeSensitive);
-			}
-
-			return $job;
-		} else {
-			return null;
-		}
-	}
-
-	/**
-	 * @return ?IJob The job matching the id. Beware that this object may be a singleton and may be modified by the next call to buildJob.
-	 */
-	public function getById(int $id): ?IJob {
-		$row = $this->getDetailsById($id);
-
-		if ($row) {
-			return $this->buildJob($row);
-		}
-
-		return null;
-	}
-
-	public function getDetailsById(int $id): ?array {
-		$query = $this->connection->getQueryBuilder();
-		$query->select('*')
-			->from('jobs')
-			->where($query->expr()->eq('id', $query->createNamedParameter($id, IQueryBuilder::PARAM_INT)));
-		$result = $query->executeQuery();
-		$row = $result->fetch();
-		$result->closeCursor();
-
-		if ($row) {
-			return $row;
-		}
-
-		return null;
-	}
-
-	/**
-	 * get the job object from a row in the db
-	 *
-	 * @param array{class:class-string<IJob>, id:mixed, last_run:mixed, argument:string} $row
-	 * @return ?IJob the next job to run. Beware that this object may be a singleton and may be modified by the next call to buildJob.
-	 */
-	private function buildJob(array $row): ?IJob {
-		try {
-			try {
-				// Try to load the job as a service
-				/** @var IJob $job */
-				$job = \OCP\Server::get($row['class']);
-			} catch (QueryException $e) {
-				if (class_exists($row['class'])) {
-					$class = $row['class'];
-					$job = new $class();
-				} else {
-					// job from disabled app or old version of an app, no need to do anything
-					return null;
-				}
-			}
-
-			if (!($job instanceof IJob)) {
-				// This most likely means an invalid job was enqueued. We can ignore it.
-				return null;
-			}
-			$job->setId((int) $row['id']);
-			$job->setLastRun((int) $row['last_run']);
-			$job->setArgument(json_decode($row['argument'], true));
-			return $job;
-		} catch (AutoloadNotAllowedException $e) {
-			// job is from a disabled app, ignore
-			return null;
-		}
-	}
-
-	/**
-	 * set the job that was last ran
-	 */
-	public function setLastJob(IJob $job): void {
-		$this->unlockJob($job);
-		$this->config->setAppValue('backgroundjob', 'lastjob', (string)$job->getId());
-	}
-
-	/**
-	 * Remove the reservation for a job
-	 */
-	public function unlockJob(IJob $job): void {
-		$query = $this->connection->getQueryBuilder();
-		$query->update('jobs')
-			->set('reserved_at', $query->expr()->literal(0, IQueryBuilder::PARAM_INT))
-			->where($query->expr()->eq('id', $query->createNamedParameter($job->getId(), IQueryBuilder::PARAM_INT)));
-		$query->executeStatement();
-	}
-
-	/**
-	 * set the lastRun of $job to now
-	 */
-	public function setLastRun(IJob $job): void {
-		$query = $this->connection->getQueryBuilder();
-		$query->update('jobs')
-			->set('last_run', $query->createNamedParameter(time(), IQueryBuilder::PARAM_INT))
-			->where($query->expr()->eq('id', $query->createNamedParameter($job->getId(), IQueryBuilder::PARAM_INT)));
-
-		if ($job instanceof \OCP\BackgroundJob\TimedJob
-			&& !$job->isTimeSensitive()) {
-			$query->set('time_sensitive', $query->createNamedParameter(IJob::TIME_INSENSITIVE));
-		}
-
-		$query->executeStatement();
-	}
-
-	/**
-	 * @param int $timeTaken
-	 */
-	public function setExecutionTime(IJob $job, $timeTaken): void {
-		$query = $this->connection->getQueryBuilder();
-		$query->update('jobs')
-			->set('execution_duration', $query->createNamedParameter($timeTaken, IQueryBuilder::PARAM_INT))
-			->where($query->expr()->eq('id', $query->createNamedParameter($job->getId(), IQueryBuilder::PARAM_INT)));
-		$query->executeStatement();
-	}
-
-	/**
-	 * Reset the $job so it executes on the next trigger
-	 *
-	 * @since 23.0.0
-	 */
-	public function resetBackgroundJob(IJob $job): void {
-		$query = $this->connection->getQueryBuilder();
-		$query->update('jobs')
-			->set('last_run', $query->createNamedParameter(0, IQueryBuilder::PARAM_INT))
-			->set('reserved_at', $query->createNamedParameter(0, IQueryBuilder::PARAM_INT))
-			->where($query->expr()->eq('id', $query->createNamedParameter($job->getId()), IQueryBuilder::PARAM_INT));
-		$query->executeStatement();
-	}
+    protected IDBConnection $connection;
+    protected IConfig $config;
+    protected ITimeFactory $timeFactory;
+
+    public function __construct(IDBConnection $connection, IConfig $config, ITimeFactory $timeFactory) {
+        $this->connection = $connection;
+        $this->config = $config;
+        $this->timeFactory = $timeFactory;
+    }
+
+    /**
+     * @param IJob|class-string<IJob> $job
+     * @param mixed $argument
+     */
+    public function add($job, $argument = null): void {
+        if ($job instanceof IJob) {
+            $class = get_class($job);
+        } else {
+            $class = $job;
+        }
+
+        $argumentJson = json_encode($argument);
+        if (strlen($argumentJson) > 4000) {
+            throw new \InvalidArgumentException('Background job arguments can\'t exceed 4000 characters (json encoded)');
+        }
+
+        $query = $this->connection->getQueryBuilder();
+        if (!$this->has($job, $argument)) {
+            $query->insert('jobs')
+                ->values([
+                    'class' => $query->createNamedParameter($class),
+                    'argument' => $query->createNamedParameter($argumentJson),
+                    'argument_hash' => $query->createNamedParameter(md5($argumentJson)),
+                    'last_run' => $query->createNamedParameter(0, IQueryBuilder::PARAM_INT),
+                    'last_checked' => $query->createNamedParameter($this->timeFactory->getTime(), IQueryBuilder::PARAM_INT),
+                ]);
+        } else {
+            $query->update('jobs')
+                ->set('reserved_at', $query->expr()->literal(0, IQueryBuilder::PARAM_INT))
+                ->set('last_checked', $query->createNamedParameter($this->timeFactory->getTime(), IQueryBuilder::PARAM_INT))
+                ->where($query->expr()->eq('class', $query->createNamedParameter($class)))
+                ->andWhere($query->expr()->eq('argument_hash', $query->createNamedParameter(md5($argumentJson))));
+        }
+        $query->executeStatement();
+    }
+
+    /**
+     * @param IJob|string $job
+     * @param mixed $argument
+     */
+    public function remove($job, $argument = null): void {
+        if ($job instanceof IJob) {
+            $class = get_class($job);
+        } else {
+            $class = $job;
+        }
+
+        $query = $this->connection->getQueryBuilder();
+        $query->delete('jobs')
+            ->where($query->expr()->eq('class', $query->createNamedParameter($class)));
+        if (!is_null($argument)) {
+            $argumentJson = json_encode($argument);
+            $query->andWhere($query->expr()->eq('argument_hash', $query->createNamedParameter(md5($argumentJson))));
+        }
+
+        // Add galera safe delete chunking if using mysql
+        // Stops us hitting wsrep_max_ws_rows when large row counts are deleted
+        if ($this->connection->getDatabasePlatform() instanceof MySQLPlatform) {
+            // Then use chunked delete
+            $max = IQueryBuilder::MAX_ROW_DELETION;
+
+            $query->setMaxResults($max);
+
+            do {
+                $deleted = $query->execute();
+            } while ($deleted === $max);
+        } else {
+            // Dont use chunked delete - let the DB handle the large row count natively
+            $query->execute();
+        }
+    }
+
+    protected function removeById(int $id): void {
+        $query = $this->connection->getQueryBuilder();
+        $query->delete('jobs')
+            ->where($query->expr()->eq('id', $query->createNamedParameter($id, IQueryBuilder::PARAM_INT)));
+        $query->executeStatement();
+    }
+
+    /**
+     * check if a job is in the list
+     *
+     * @param IJob|class-string<IJob> $job
+     * @param mixed $argument
+     */
+    public function has($job, $argument): bool {
+        if ($job instanceof IJob) {
+            $class = get_class($job);
+        } else {
+            $class = $job;
+        }
+        $argument = json_encode($argument);
+
+        $query = $this->connection->getQueryBuilder();
+        $query->select('id')
+            ->from('jobs')
+            ->where($query->expr()->eq('class', $query->createNamedParameter($class)))
+            ->andWhere($query->expr()->eq('argument_hash', $query->createNamedParameter(md5($argument))))
+            ->setMaxResults(1);
+
+        $result = $query->executeQuery();
+        $row = $result->fetch();
+        $result->closeCursor();
+
+        return (bool) $row;
+    }
+
+    public function getJobs($job, ?int $limit, int $offset): array {
+        $iterable = $this->getJobsIterator($job, $limit, $offset);
+        if (is_array($iterable)) {
+            return $iterable;
+        } else {
+            return iterator_to_array($iterable);
+        }
+    }
+
+    /**
+     * @param IJob|class-string<IJob>|null $job
+     * @return iterable<IJob> Avoid to store these objects as they may share a Singleton instance. You should instead use these IJobs instances while looping on the iterable.
+     */
+    public function getJobsIterator($job, ?int $limit, int $offset): iterable {
+        $query = $this->connection->getQueryBuilder();
+        $query->select('*')
+            ->from('jobs')
+            ->setMaxResults($limit)
+            ->setFirstResult($offset);
+
+        if ($job !== null) {
+            if ($job instanceof IJob) {
+                $class = get_class($job);
+            } else {
+                $class = $job;
+            }
+            $query->where($query->expr()->eq('class', $query->createNamedParameter($class)));
+        }
+
+        $result = $query->executeQuery();
+
+        while ($row = $result->fetch()) {
+            $job = $this->buildJob($row);
+            if ($job) {
+                yield $job;
+            }
+        }
+        $result->closeCursor();
+    }
+
+    /**
+     * Get the next job in the list
+     * @return ?IJob the next job to run. Beware that this object may be a singleton and may be modified by the next call to buildJob.
+     */
+    public function getNext(bool $onlyTimeSensitive = false): ?IJob {
+        $query = $this->connection->getQueryBuilder();
+        $query->select('*')
+            ->from('jobs')
+            ->where($query->expr()->lte('reserved_at', $query->createNamedParameter($this->timeFactory->getTime() - 12 * 3600, IQueryBuilder::PARAM_INT)))
+            ->andWhere($query->expr()->lte('last_checked', $query->createNamedParameter($this->timeFactory->getTime(), IQueryBuilder::PARAM_INT)))
+            ->orderBy('last_checked', 'ASC')
+            ->setMaxResults(1);
+
+        if ($onlyTimeSensitive) {
+            $query->andWhere($query->expr()->eq('time_sensitive', $query->createNamedParameter(IJob::TIME_SENSITIVE, IQueryBuilder::PARAM_INT)));
+        }
+
+        $update = $this->connection->getQueryBuilder();
+        $update->update('jobs')
+            ->set('reserved_at', $update->createNamedParameter($this->timeFactory->getTime()))
+            ->set('last_checked', $update->createNamedParameter($this->timeFactory->getTime()))
+            ->where($update->expr()->eq('id', $update->createParameter('jobid')))
+            ->andWhere($update->expr()->eq('reserved_at', $update->createParameter('reserved_at')))
+            ->andWhere($update->expr()->eq('last_checked', $update->createParameter('last_checked')));
+
+        $result = $query->executeQuery();
+        $row = $result->fetch();
+        $result->closeCursor();
+
+        if ($row) {
+            $update->setParameter('jobid', $row['id']);
+            $update->setParameter('reserved_at', $row['reserved_at']);
+            $update->setParameter('last_checked', $row['last_checked']);
+            $count = $update->executeStatement();
+
+            if ($count === 0) {
+                // Background job already executed elsewhere, try again.
+                return $this->getNext($onlyTimeSensitive);
+            }
+            $job = $this->buildJob($row);
+
+            if ($job === null) {
+                // set the last_checked to 12h in the future to not check failing jobs all over again
+                $reset = $this->connection->getQueryBuilder();
+                $reset->update('jobs')
+                    ->set('reserved_at', $reset->expr()->literal(0, IQueryBuilder::PARAM_INT))
+                    ->set('last_checked', $reset->createNamedParameter($this->timeFactory->getTime() + 12 * 3600, IQueryBuilder::PARAM_INT))
+                    ->where($reset->expr()->eq('id', $reset->createNamedParameter($row['id'], IQueryBuilder::PARAM_INT)));
+                $reset->executeStatement();
+
+                // Background job from disabled app, try again.
+                return $this->getNext($onlyTimeSensitive);
+            }
+
+            return $job;
+        } else {
+            return null;
+        }
+    }
+
+    /**
+     * @return ?IJob The job matching the id. Beware that this object may be a singleton and may be modified by the next call to buildJob.
+     */
+    public function getById(int $id): ?IJob {
+        $row = $this->getDetailsById($id);
+
+        if ($row) {
+            return $this->buildJob($row);
+        }
+
+        return null;
+    }
+
+    public function getDetailsById(int $id): ?array {
+        $query = $this->connection->getQueryBuilder();
+        $query->select('*')
+            ->from('jobs')
+            ->where($query->expr()->eq('id', $query->createNamedParameter($id, IQueryBuilder::PARAM_INT)));
+        $result = $query->executeQuery();
+        $row = $result->fetch();
+        $result->closeCursor();
+
+        if ($row) {
+            return $row;
+        }
+
+        return null;
+    }
+
+    /**
+     * get the job object from a row in the db
+     *
+     * @param array{class:class-string<IJob>, id:mixed, last_run:mixed, argument:string} $row
+     * @return ?IJob the next job to run. Beware that this object may be a singleton and may be modified by the next call to buildJob.
+     */
+    private function buildJob(array $row): ?IJob {
+        try {
+            try {
+                // Try to load the job as a service
+                /** @var IJob $job */
+                $job = \OCP\Server::get($row['class']);
+            } catch (QueryException $e) {
+                if (class_exists($row['class'])) {
+                    $class = $row['class'];
+                    $job = new $class();
+                } else {
+                    // job from disabled app or old version of an app, no need to do anything
+                    return null;
+                }
+            }
+
+            if (!($job instanceof IJob)) {
+                // This most likely means an invalid job was enqueued. We can ignore it.
+                return null;
+            }
+            $job->setId((int) $row['id']);
+            $job->setLastRun((int) $row['last_run']);
+            $job->setArgument(json_decode($row['argument'], true));
+            return $job;
+        } catch (AutoloadNotAllowedException $e) {
+            // job is from a disabled app, ignore
+            return null;
+        }
+    }
+
+    /**
+     * set the job that was last ran
+     */
+    public function setLastJob(IJob $job): void {
+        $this->unlockJob($job);
+        $this->config->setAppValue('backgroundjob', 'lastjob', (string)$job->getId());
+    }
+
+    /**
+     * Remove the reservation for a job
+     */
+    public function unlockJob(IJob $job): void {
+        $query = $this->connection->getQueryBuilder();
+        $query->update('jobs')
+            ->set('reserved_at', $query->expr()->literal(0, IQueryBuilder::PARAM_INT))
+            ->where($query->expr()->eq('id', $query->createNamedParameter($job->getId(), IQueryBuilder::PARAM_INT)));
+        $query->executeStatement();
+    }
+
+    /**
+     * set the lastRun of $job to now
+     */
+    public function setLastRun(IJob $job): void {
+        $query = $this->connection->getQueryBuilder();
+        $query->update('jobs')
+            ->set('last_run', $query->createNamedParameter(time(), IQueryBuilder::PARAM_INT))
+            ->where($query->expr()->eq('id', $query->createNamedParameter($job->getId(), IQueryBuilder::PARAM_INT)));
+
+        if ($job instanceof \OCP\BackgroundJob\TimedJob
+            && !$job->isTimeSensitive()) {
+            $query->set('time_sensitive', $query->createNamedParameter(IJob::TIME_INSENSITIVE));
+        }
+
+        $query->executeStatement();
+    }
+
+    /**
+     * @param int $timeTaken
+     */
+    public function setExecutionTime(IJob $job, $timeTaken): void {
+        $query = $this->connection->getQueryBuilder();
+        $query->update('jobs')
+            ->set('execution_duration', $query->createNamedParameter($timeTaken, IQueryBuilder::PARAM_INT))
+            ->where($query->expr()->eq('id', $query->createNamedParameter($job->getId(), IQueryBuilder::PARAM_INT)));
+        $query->executeStatement();
+    }
+
+    /**
+     * Reset the $job so it executes on the next trigger
+     *
+     * @since 23.0.0
+     */
+    public function resetBackgroundJob(IJob $job): void {
+        $query = $this->connection->getQueryBuilder();
+        $query->update('jobs')
+            ->set('last_run', $query->createNamedParameter(0, IQueryBuilder::PARAM_INT))
+            ->set('reserved_at', $query->createNamedParameter(0, IQueryBuilder::PARAM_INT))
+            ->where($query->expr()->eq('id', $query->createNamedParameter($job->getId()), IQueryBuilder::PARAM_INT));
+        $query->executeStatement();
+    }
 }

core/Command/Background/ListCommand.php

Indentation +48 added lines, -48 removed lines

@@ -32,56 +32,56 @@
 use Symfony\Component\Console\Output\OutputInterface;
 
 class ListCommand extends Base {
-	protected IJobList $jobList;
+    protected IJobList $jobList;
 
-	public function __construct(IJobList $jobList) {
-		parent::__construct();
-		$this->jobList = $jobList;
-	}
+    public function __construct(IJobList $jobList) {
+        parent::__construct();
+        $this->jobList = $jobList;
+    }
 
-	protected function configure(): void {
-		$this
-			->setName('background-job:list')
-			->setDescription('List background jobs')
-			->addOption(
-				'class',
-				'c',
-				InputOption::VALUE_OPTIONAL,
-				'Job class to search for',
-				null
-			)->addOption(
-				'limit',
-				'l',
-				InputOption::VALUE_OPTIONAL,
-				'Number of jobs to retrieve',
-				'10'
-			)->addOption(
-				'offset',
-				'o',
-				InputOption::VALUE_OPTIONAL,
-				'Offset for retrieving jobs',
-				'0'
-			)
-		;
-		parent::configure();
-	}
+    protected function configure(): void {
+        $this
+            ->setName('background-job:list')
+            ->setDescription('List background jobs')
+            ->addOption(
+                'class',
+                'c',
+                InputOption::VALUE_OPTIONAL,
+                'Job class to search for',
+                null
+            )->addOption(
+                'limit',
+                'l',
+                InputOption::VALUE_OPTIONAL,
+                'Number of jobs to retrieve',
+                '10'
+            )->addOption(
+                'offset',
+                'o',
+                InputOption::VALUE_OPTIONAL,
+                'Offset for retrieving jobs',
+                '0'
+            )
+        ;
+        parent::configure();
+    }
 
-	protected function execute(InputInterface $input, OutputInterface $output): int {
-		$jobs = $this->jobList->getJobsIterator($input->getOption('class'), (int)$input->getOption('limit'), (int)$input->getOption('offset'));
-		$this->writeTableInOutputFormat($input, $output, $this->formatJobs($jobs));
-		return 0;
-	}
+    protected function execute(InputInterface $input, OutputInterface $output): int {
+        $jobs = $this->jobList->getJobsIterator($input->getOption('class'), (int)$input->getOption('limit'), (int)$input->getOption('offset'));
+        $this->writeTableInOutputFormat($input, $output, $this->formatJobs($jobs));
+        return 0;
+    }
 
-	protected function formatJobs(iterable $jobs): array {
-		$jobsInfo = [];
-		foreach ($jobs as $job) {
-			$jobsInfo[] = [
-				'id' => $job->getId(),
-				'class' => get_class($job),
-				'last_run' => date(DATE_ATOM, $job->getLastRun()),
-				'argument' => json_encode($job->getArgument()),
-			];
-		}
-		return $jobsInfo;
-	}
+    protected function formatJobs(iterable $jobs): array {
+        $jobsInfo = [];
+        foreach ($jobs as $job) {
+            $jobsInfo[] = [
+                'id' => $job->getId(),
+                'class' => get_class($job),
+                'last_run' => date(DATE_ATOM, $job->getLastRun()),
+                'argument' => json_encode($job->getArgument()),
+            ];
+        }
+        return $jobsInfo;
+    }
 }