123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146 |
- <?php
- declare(strict_types=1);
- /**
- * SPDX-FileCopyrightText: 2018 Nextcloud GmbH and Nextcloud contributors
- * SPDX-License-Identifier: AGPL-3.0-or-later
- */
- namespace OCP\BackgroundJob;
- use OCP\AppFramework\Utility\ITimeFactory;
- use OCP\ILogger;
- use Psr\Log\LoggerInterface;
- /**
- * Base class for background jobs
- *
- * This is here if you want to do advanced stuff in your background jobs.
- * For the most common use cases have a look at QueuedJob and TimedJob
- *
- * @since 15.0.0
- */
- abstract class Job implements IJob, IParallelAwareJob {
- protected int $id = 0;
- protected int $lastRun = 0;
- protected $argument;
- protected ITimeFactory $time;
- protected bool $allowParallelRuns = true;
- /**
- * @since 15.0.0
- */
- public function __construct(ITimeFactory $time) {
- $this->time = $time;
- }
- /**
- * The function to prepare the execution of the job.
- *
- * @return void
- *
- * @since 15.0.0
- * @deprecated since 25.0.0 Use start() instead. This method will be removed
- * with the ILogger interface
- */
- public function execute(IJobList $jobList, ?ILogger $logger = null) {
- $this->start($jobList);
- }
- /**
- * @inheritdoc
- * @since 25.0.0
- */
- public function start(IJobList $jobList): void {
- $jobList->setLastRun($this);
- $logger = \OCP\Server::get(LoggerInterface::class);
- try {
- $jobDetails = get_class($this) . ' (id: ' . $this->getId() . ', arguments: ' . json_encode($this->getArgument()) . ')';
- $jobStartTime = $this->time->getTime();
- $logger->debug('Starting job ' . $jobDetails, ['app' => 'cron']);
- $this->run($this->argument);
- $timeTaken = $this->time->getTime() - $jobStartTime;
- $logger->debug('Finished job ' . $jobDetails . ' in ' . $timeTaken . ' seconds', ['app' => 'cron']);
- $jobList->setExecutionTime($this, $timeTaken);
- } catch (\Throwable $e) {
- if ($logger) {
- $logger->error('Error while running background job ' . $jobDetails, [
- 'app' => 'core',
- 'exception' => $e,
- ]);
- }
- }
- }
- /**
- * @since 15.0.0
- */
- final public function setId(int $id) {
- $this->id = $id;
- }
- /**
- * @since 15.0.0
- */
- final public function setLastRun(int $lastRun) {
- $this->lastRun = $lastRun;
- }
- /**
- * @since 15.0.0
- */
- public function setArgument($argument) {
- $this->argument = $argument;
- }
- /**
- * @since 15.0.0
- */
- final public function getId(): int {
- return $this->id;
- }
- /**
- * @since 15.0.0
- */
- final public function getLastRun(): int {
- return $this->lastRun;
- }
- /**
- * @since 15.0.0
- */
- public function getArgument() {
- return $this->argument;
- }
- /**
- * Set this to false to prevent two Jobs from this class from running in parallel
- *
- * @param bool $allow
- * @return void
- * @since 27.0.0
- */
- public function setAllowParallelRuns(bool $allow): void {
- $this->allowParallelRuns = $allow;
- }
- /**
- * @return bool
- * @since 27.0.0
- */
- public function getAllowParallelRuns(): bool {
- return $this->allowParallelRuns;
- }
- /**
- * The actual function that is called to run the job
- *
- * @param $argument
- * @return void
- *
- * @since 15.0.0
- */
- abstract protected function run($argument);
- }
|