[stable10] Add background:execute occ command for running cron jobs manually

core/Command/Background/Queue/Delete.php

@@ -41,7 +41,7 @@ protected function configure() {
 		$this
 			->setName('background:queue:delete')
 			->setDescription('Delete a job from the queue')
-			->addArgument('id', InputArgument::REQUIRED, 'id of the job to be deleted');
+			->addArgument('Job ID', InputArgument::REQUIRED, 'ID of the job to be deleted');
 	}
 
 	/**
@@ -50,11 +50,11 @@ protected function configure() {
 	 * @return int
 	 */
 	protected function execute(InputInterface $input, OutputInterface $output) {
-		$id = $input->getArgument('id');
+		$id = $input->getArgument('Job ID');
 
 		$job = $this->jobList->getById($id);
 		if ($job === null) {
-			$output->writeln("Job with id <$id> is not known.");
+			$output->writeln("Job with ID <$id> is not known.");
 			return 1;
 		}
 

core/Command/Background/Queue/Execute.php

@@ -0,0 +1,118 @@
+<?php
+/**
+ * @author Tom Needham <[email protected]>
+ *
+ * @copyright Copyright (c) 2018, ownCloud GmbH
+ * @license AGPL-3.0
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * 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, version 3,
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+namespace OC\Core\Command\Background\Queue;
+
+use OC\BackgroundJob\TimedJob;
+use OC\Log\CommandLogger;
+use OCP\BackgroundJob\IJobList;
+use OCP\AppFramework\Utility\ITimeFactory;
+
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Helper\QuestionHelper;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Question\ConfirmationQuestion;
+
+class Execute extends Command {
+
+	/**
+	 * @var IJobList
+	 */
+	protected $jobList;
+	/** @var ITimeFactory */
+	protected $timeFactory;
+
+	/**
+	 * @param IJobList $jobList
+	 */
+	public function __construct(IJobList $jobList, ITimeFactory $timeFactory) {
+		parent::__construct();
+		$this->jobList = $jobList;
+		$this->timeFactory = $timeFactory;
+	}
+
+	protected function configure() {
+		$this
+			->setName('background:queue:execute')
+			->setDescription("Run a single background job from the queue")
+			->addArgument('Job ID', InputArgument::REQUIRED, 'ID of the job to run')
+			->addOption('force', 'f', InputOption::VALUE_NONE, 'Force run the job even if within timing interval')
+			->addOption('accept-warning', null, InputOption::VALUE_NONE, 'No warning about the usage of this command will be displayed');
+	}
+
+	/**
+	 * @param InputInterface $input
+	 * @param OutputInterface $output
+	 */
+	protected function execute(InputInterface $input, OutputInterface $output) {
+		if (!$input->getOption('accept-warning')) {
+			$helper = new QuestionHelper();
+			$q = <<<EOS
+<question>This command is for maintenance and support purposes. 
+This will run the specified background job now. Regular scheduled runs of the job will
+continue to happen at their scheduled times. 
+If you still want to use this command please confirm the usage by entering: yes
+</question>
+EOS;
+			if (!$helper->ask($input, $output, new ConfirmationQuestion($q, false))) {
+				return 1;
+			}
+		}
+
+		// Get the job to run
+		$jobId = $input->getArgument('Job ID');
+		// Try to find the job
+		$job = $this->jobList->getById($jobId);
+		if ($job === null) {
+			$output->writeln("<error>Job not found</error>");
+			return 1;
+		}
+
+		$jobClass = \get_class($job);
+		$output->writeln("<info>Found job: $jobClass with ID $jobId</info>");
+
+		$start = $this->timeFactory->getTime();
+
+		// Run the job if not reserved
+		$logger = new \OC\Log(new CommandLogger($output), \OC::$server->getSystemConfig());
+
+		if ($job instanceof TimedJob && $input->getOption('force')) {
+			// Force the execution to ignore the interval
+			$output->writeln('<info>Forcing run, resetting last run value to 0</info>');
+			$job->setLastRun(0);
+		}
+
+		$output->writeln('<info>Running job...</info>');
+
+		$job->execute($this->jobList, $logger);
+
+		$duration = $this->timeFactory->getTime() - $start;
+
+		$output->writeln("<info>Finished in $duration seconds</info>");
+		$this->jobList->setLastJob($job);
+		$this->jobList->setExecutionTime($job, $duration);
+
+		return 0;
+	}
+}

core/Command/Background/Queue/Status.php

@@ -51,7 +51,7 @@ protected function configure() {
 	 */
 	protected function execute(InputInterface $input, OutputInterface $output) {
 		$t = new Table($output);
-		$t->setHeaders(['Id', 'Job', 'Last run', 'Job Arguments']);
+		$t->setHeaders(['Job ID', 'Job', 'Last Run', 'Job Arguments']);
 		$this->jobList->listJobs(function (IJob $job) use ($t) {
 			$t->addRow([$job->getId(), \get_class($job), \date('c', $job->getLastRun()), $job->getArgument()]);
 		});

core/register_command.php

@@ -74,6 +74,7 @@
 	$application->add(new OC\Core\Command\Background\Ajax(\OC::$server->getConfig()));
 	$application->add(new OC\Core\Command\Background\Queue\Status(\OC::$server->getJobList()));
 	$application->add(new OC\Core\Command\Background\Queue\Delete(\OC::$server->getJobList()));
+	$application->add(new OC\Core\Command\Background\Queue\Execute(\OC::$server->getJobList(), \OC::$server->getTimeFactory()));
 
 	$application->add(new OC\Core\Command\Config\App\DeleteConfig(\OC::$server->getConfig()));
 	$application->add(new OC\Core\Command\Config\App\GetConfig(\OC::$server->getConfig()));
@@ -144,6 +145,7 @@
 	$application->add(new OC\Core\Command\User\Delete(\OC::$server->getUserManager()));
 	$application->add(new OC\Core\Command\User\Disable(\OC::$server->getUserManager()));
 	$application->add(new OC\Core\Command\User\Enable(\OC::$server->getUserManager()));
+	$application->add(new OC\Core\Command\User\Inactive(\OC::$server->getUserManager()));
 	$application->add(new OC\Core\Command\User\LastSeen(\OC::$server->getUserManager()));
 	$application->add(new OC\Core\Command\User\ListUsers(\OC::$server->getUserManager()));
 	$application->add(new OC\Core\Command\User\ListUserGroups(\OC::$server->getUserManager(), \OC::$server->getGroupManager()));
@@ -157,7 +159,6 @@
 	$application->add(new OC\Core\Command\User\Setting(\OC::$server->getUserManager(), \OC::$server->getConfig(), \OC::$server->getDatabaseConnection()));
 	$application->add(new OC\Core\Command\User\Modify(\OC::$server->getUserManager(), \OC::$server->getMailer()));
 	$application->add(new OC\Core\Command\User\SyncBackend(\OC::$server->getAccountMapper(), \OC::$server->getConfig(), \OC::$server->getUserManager(), \OC::$server->getLogger()));
-	$application->add(new \OC\Core\Command\User\Inactive(\OC::$server->getUserManager()));
 
 	$application->add(new OC\Core\Command\Group\Add(\OC::$server->getGroupManager()));
 	$application->add(new OC\Core\Command\Group\Delete(\OC::$server->getGroupManager()));

lib/private/BackgroundJob/Job.php

@@ -52,16 +52,34 @@ public function execute($jobList, ILogger $logger = null) {
 			//storing job start time
 			$jobStartTime = \time();
 
-			\OCP\Util::writeLog('cron', 'Started background job of class : ' . \get_class($this) . ' with arguments : ' . \print_r($this->argument, true), \OCP\Util::DEBUG);
+			if ($logger) {
+				$logger->debug(
+					'Started background job of class : {class} with arguments : {arguments}',
+					[
+						'app' => 'cron',
+						'class' => \get_class($this),
+						'arguments' => \print_r($this->argument, true)
+					]
+				);
+			}
 
 			$this->run($this->argument);
 
 			//storing job end time
 			$jobEndTime = \time();
 			$timeTaken = $jobEndTime - $jobStartTime;
 
-			\OCP\Util::writeLog('cron', "Finished background job, the job took : $timeTaken seconds, " .
-				"this job is an instance of class : " . \get_class($this) . ' with arguments : ' . \print_r($this->argument, true), \OCP\Util::DEBUG);
+			if ($logger) {
+				$logger->debug(
+					'Finished background job, the job took : {timeTaken} seconds, this job is an instance of class : {class} with arguments : {arguments}',
+					[
+						'app' => 'cron',
+						'timeTaken' => $timeTaken,
+						'class' => \get_class($this),
+						'arguments' => \print_r($this->argument, true)
+					]
+				);
+			}
 
 			$jobList->setExecutionTime($this, $timeTaken);
 		} catch (\Exception $e) {

lib/private/BackgroundJob/JobList.php

@@ -262,6 +262,7 @@ private function buildJob($row) {
 			$job->setId($row['id']);
 			$job->setLastRun($row['last_run']);
 			$job->setArgument(\json_decode($row['argument'], true));
+
 			return $job;
 		} catch (AutoloadNotAllowedException $e) {
 			// job is from a disabled app, ignore

lib/private/BackgroundJob/TimedJob.php

@@ -50,7 +50,29 @@ public function setInterval($interval) {
 	 */
 	public function execute($jobList, ILogger $logger = null) {
 		if ((\time() - $this->lastRun) > $this->interval) {
+			if ($logger !== null) {
+				$id = $this->getId();
+				$class = \get_class($this);
+				$lastRun = $this->getLastRun();
+				$interval = $this->interval;
+				$logger->debug(
+					"Running job with id $id and class $class. Last run $lastRun and interval $interval",
+					['app' => 'cron']
+				);
+			}
 			parent::execute($jobList, $logger);
+		} else {
+			if ($logger !== null) {
+				$id = $this->getId();
+				$class = \get_class($this);
+				$lastRun = $this->getLastRun();
+				$interval = $this->interval;
+				$diff = $this->interval - (\time() - $this->lastRun);
+				$logger->debug(
+					"Job with id $id and class $class not running due to interval. Last run $lastRun and interval $interval. Wait $diff seconds.",
+					['app' => 'cron']
+				);
+			}
 		}
 	}
 }