mirror of https://github.com/nextcloud/server.git
Merge pull request #30359 from nextcloud/enh/background-job-class
Allow calling cron jobs background job class with occpull/45196/head
Marcel Klehr
4 weeks ago
committed by
GitHub
commit
d1ed8bd5e9
@ -0,0 +1,95 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* @copyright Copyright (c) 2022 Julius Härtl <jus@bitgrid.net>
|
||||
*
|
||||
* @author Julius Härtl <jus@bitgrid.net>
|
||||
*
|
||||
* @license GNU AGPL version 3 or any later version
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
|
||||
namespace OC\Core\Command\Background;
|
||||
|
||||
use OCP\BackgroundJob\IJob;
|
||||
use OCP\BackgroundJob\IJobList;
|
||||
use Psr\Log\LoggerInterface;
|
||||
use Symfony\Component\Console\Output\OutputInterface;
|
||||
|
||||
abstract class JobBase extends \OC\Core\Command\Base {
|
||||
|
||||
public function __construct(
|
||||
protected IJobList $jobList,
|
||||
protected LoggerInterface $logger
|
||||
) {
|
||||
parent::__construct();
|
||||
}
|
||||
|
||||
protected function printJobInfo(int $jobId, IJob $job, OutputInterface $output): void {
|
||||
$row = $this->jobList->getDetailsById($jobId);
|
||||
|
||||
if ($row === null) {
|
||||
return;
|
||||
}
|
||||
|
||||
$lastRun = new \DateTime();
|
||||
$lastRun->setTimestamp((int) $row['last_run']);
|
||||
$lastChecked = new \DateTime();
|
||||
$lastChecked->setTimestamp((int) $row['last_checked']);
|
||||
$reservedAt = new \DateTime();
|
||||
$reservedAt->setTimestamp((int) $row['reserved_at']);
|
||||
|
||||
$output->writeln('Job class: ' . get_class($job));
|
||||
$output->writeln('Arguments: ' . json_encode($job->getArgument()));
|
||||
|
||||
$isTimedJob = $job instanceof \OCP\BackgroundJob\TimedJob;
|
||||
if ($isTimedJob) {
|
||||
$output->writeln('Type: timed');
|
||||
} elseif ($job instanceof \OCP\BackgroundJob\QueuedJob) {
|
||||
$output->writeln('Type: queued');
|
||||
} else {
|
||||
$output->writeln('Type: job');
|
||||
}
|
||||
|
||||
$output->writeln('');
|
||||
$output->writeln('Last checked: ' . $lastChecked->format(\DateTimeInterface::ATOM));
|
||||
if ((int) $row['reserved_at'] === 0) {
|
||||
$output->writeln('Reserved at: -');
|
||||
} else {
|
||||
$output->writeln('Reserved at: <comment>' . $reservedAt->format(\DateTimeInterface::ATOM) . '</comment>');
|
||||
}
|
||||
$output->writeln('Last executed: ' . $lastRun->format(\DateTimeInterface::ATOM));
|
||||
$output->writeln('Last duration: ' . $row['execution_duration']);
|
||||
|
||||
if ($isTimedJob) {
|
||||
$reflection = new \ReflectionClass($job);
|
||||
$intervalProperty = $reflection->getProperty('interval');
|
||||
$intervalProperty->setAccessible(true);
|
||||
$interval = $intervalProperty->getValue($job);
|
||||
|
||||
$nextRun = new \DateTime();
|
||||
$nextRun->setTimestamp((int)$row['last_run'] + $interval);
|
||||
|
||||
if ($nextRun > new \DateTime()) {
|
||||
$output->writeln('Next execution: <comment>' . $nextRun->format(\DateTimeInterface::ATOM) . '</comment>');
|
||||
} else {
|
||||
$output->writeln('Next execution: <info>' . $nextRun->format(\DateTimeInterface::ATOM) . '</info>');
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,157 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
/**
|
||||
* @copyright Copyright (c) 2021, Joas Schilling <coding@schilljs.com>
|
||||
*
|
||||
* @author Joas Schilling <coding@schilljs.com>
|
||||
*
|
||||
* @license GNU AGPL version 3 or any later version
|
||||
*
|
||||
* This program is free software: you can redistribute it and/or modify
|
||||
* it under the terms of the GNU Affero General Public License as
|
||||
* published by the Free Software Foundation, either version 3 of the
|
||||
* License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU Affero General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU Affero General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*
|
||||
*/
|
||||
|
||||
namespace OC\Core\Command\Background;
|
||||
|
||||
use OC\Core\Command\InterruptedException;
|
||||
use OC\Files\SetupManager;
|
||||
use OCP\BackgroundJob\IJobList;
|
||||
use OCP\ITempManager;
|
||||
use Psr\Log\LoggerInterface;
|
||||
use Symfony\Component\Console\Input\InputArgument;
|
||||
use Symfony\Component\Console\Input\InputInterface;
|
||||
use Symfony\Component\Console\Input\InputOption;
|
||||
use Symfony\Component\Console\Output\OutputInterface;
|
||||
|
||||
class JobWorker extends JobBase {
|
||||
|
||||
public function __construct(
|
||||
protected IJobList $jobList,
|
||||
protected LoggerInterface $logger,
|
||||
private ITempManager $tempManager,
|
||||
private SetupManager $setupManager,
|
||||
) {
|
||||
parent::__construct($jobList, $logger);
|
||||
}
|
||||
protected function configure(): void {
|
||||
parent::configure();
|
||||
|
||||
$this
|
||||
->setName('background-job:worker')
|
||||
->setDescription('Run a background job worker')
|
||||
->addArgument(
|
||||
'job-classes',
|
||||
InputArgument::OPTIONAL | InputArgument::IS_ARRAY,
|
||||
'The classes of the jobs to look for in the database'
|
||||
)
|
||||
->addOption(
|
||||
'once',
|
||||
null,
|
||||
InputOption::VALUE_NONE,
|
||||
'Only execute the worker once (as a regular cron execution would do it)'
|
||||
)
|
||||
->addOption(
|
||||
'interval',
|
||||
'i',
|
||||
InputOption::VALUE_OPTIONAL,
|
||||
'Interval in seconds in which the worker should repeat already processed jobs (set to 0 for no repeat)',
|
||||
5
|
||||
)
|
||||
;
|
||||
}
|
||||
|
||||
protected function execute(InputInterface $input, OutputInterface $output): int {
|
||||
$jobClasses = $input->getArgument('job-classes');
|
||||
$jobClasses = empty($jobClasses) ? null : $jobClasses;
|
||||
|
||||
if ($jobClasses !== null) {
|
||||
// at least one class is invalid
|
||||
foreach ($jobClasses as $jobClass) {
|
||||
if (!class_exists($jobClass)) {
|
||||
$output->writeln('<error>Invalid job class: ' . $jobClass . '</error>');
|
||||
return 1;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
while (true) {
|
||||
// Handle canceling of the process
|
||||
try {
|
||||
$this->abortIfInterrupted();
|
||||
} catch (InterruptedException $e) {
|
||||
$output->writeln('<info>Background job worker stopped</info>');
|
||||
break;
|
||||
}
|
||||
|
||||
$this->printSummary($input, $output);
|
||||
|
||||
usleep(50000);
|
||||
$job = $this->jobList->getNext(false, $jobClasses);
|
||||
if (!$job) {
|
||||
if ($input->getOption('once') === true) {
|
||||
if ($jobClasses === null) {
|
||||
$output->writeln('No job is currently queued', OutputInterface::VERBOSITY_VERBOSE);
|
||||
} else {
|
||||
$output->writeln('No job of classes [' . implode(', ', $jobClasses) . '] is currently queued', OutputInterface::VERBOSITY_VERBOSE);
|
||||
}
|
||||
$output->writeln('Exiting...', OutputInterface::VERBOSITY_VERBOSE);
|
||||
break;
|
||||
}
|
||||
|
||||
$output->writeln('Waiting for new jobs to be queued', OutputInterface::VERBOSITY_VERBOSE);
|
||||
// Re-check interval for new jobs
|
||||
sleep(1);
|
||||
continue;
|
||||
}
|
||||
|
||||
$output->writeln('Running job ' . get_class($job) . ' with ID ' . $job->getId());
|
||||
|
||||
if ($output->isVerbose()) {
|
||||
$this->printJobInfo($job->getId(), $job, $output);
|
||||
}
|
||||
|
||||
/** @psalm-suppress DeprecatedMethod Calling execute until it is removed, then will switch to start */
|
||||
$job->execute($this->jobList);
|
||||
|
||||
$output->writeln('Job ' . $job->getId() . ' has finished', OutputInterface::VERBOSITY_VERBOSE);
|
||||
|
||||
// clean up after unclean jobs
|
||||
$this->setupManager->tearDown();
|
||||
$this->tempManager->clean();
|
||||
|
||||
$this->jobList->setLastJob($job);
|
||||
$this->jobList->unlockJob($job);
|
||||
|
||||
if ($input->getOption('once') === true) {
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
private function printSummary(InputInterface $input, OutputInterface $output): void {
|
||||
if (!$output->isVeryVerbose()) {
|
||||
return;
|
||||
}
|
||||
$output->writeln('<comment>Summary</comment>');
|
||||
|
||||
$counts = [];
|
||||
foreach ($this->jobList->countByClass() as $row) {
|
||||
$counts[] = $row;
|
||||
}
|
||||
$this->writeTableInOutputFormat($input, $output, $counts);
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue