Add command to query the queue status and delete a job

core/Command/Background/Queue/Delete.php

@@ -0,0 +1,49 @@
+<?php
+
+namespace OC\Core\Command\Background\Queue;
+
+use OC\Console\CommandLogger;
+use OCP\BackgroundJob\IJob;
+use OCP\ILogger;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Helper\Table;
+use Symfony\Component\Console\Helper\TableHelper;
+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 Delete extends Command {
+
+	/** @var \OCP\BackgroundJob\IJobList */
+	private $jobList;
+
+	public function __construct() {
+		$this->jobList = \OC::$server->getJobList();
+		parent::__construct();
+	}
+
+	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');
+	}
+
+	/**
+	* @param InputInterface $input
+	* @param OutputInterface $output
+	*/
+	protected function execute(InputInterface $input, OutputInterface $output) {
+		$id = $input->getArgument('id');
+
+		$job = $this->jobList->getById($id);
+		if (is_null($job)) {
+			$output->writeln("Job with id <$id> is not known.");
+			return;
+		}
+
+		$this->jobList->removeById($id);
+		$output->writeln("Job has been deleted.");
+	}
+}

core/Command/Background/Queue/Status.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace OC\Core\Command\Background\Queue;
+
+use OC\Console\CommandLogger;
+use OCP\BackgroundJob\IJob;
+use OCP\ILogger;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Helper\Table;
+use Symfony\Component\Console\Helper\TableHelper;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class Status extends Command {
+
+	/** @var \OCP\BackgroundJob\IJobList */
+	private $jobList;
+
+	public function __construct() {
+		$this->jobList = \OC::$server->getJobList();
+		parent::__construct();
+	}
+
+	protected function configure() {
+		$this
+			->setName("background:queue:status")
+			->setDescription("List queue status");
+	}
+
+	/**
+	* @param InputInterface $input
+	* @param OutputInterface $output
+	*/
+	protected function execute(InputInterface $input, OutputInterface $output) {
+		/** @var TableHelper $t */
+		$t = $this->getHelper('table');
+		$t->setHeaders(['Id', 'Job', 'Last run', 'Arguments']);
+		$this->jobList->listJobs(function (IJob $job) use ($t) {
+			$t->addRow([$job->getId(), get_class($job), date('c', $job->getLastRun()), $job->getArgument()]);
+		});
+		$t->render($output);
+	}
+}

core/Command/Background/Worker.php → core/Command/Background/Queue/Worker.php

@@ -1,15 +1,16 @@
 <?php
 
-namespace OC\Core\Command\Background;
+namespace OC\Core\Command\Background\Queue;
 
 use OC\Console\CommandLogger;
+use OC\Core\Command\Base;
 use OCP\ILogger;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 
-class Worker extends Command {
+class Worker extends Base {
 
 	/** @var \OCP\BackgroundJob\IJobList */
 	private $jobList;
@@ -23,7 +24,7 @@ public function __construct() {
 
 	protected function configure() {
 		$this
-			->setName("background:worker")
+			->setName("background:queue:worker")
 			->setDescription("Listen to the background job queue and execute the jobs")
 			->addOption('sleep', null, InputOption::VALUE_OPTIONAL, 'Number of seconds to sleep when no job is available', 3);
 	}
@@ -35,8 +36,11 @@ protected function configure() {
 	protected function execute(InputInterface $input, OutputInterface $output) {
 		$this->logger = new CommandLogger($output);
 
-		$waitTime = $input->getOption('sleep');
+		$waitTime = max(1, $input->getOption('sleep'));
 		while (true) {
+			if ($this->hasBeenInterrupted()) {
+				break;
+			}
 			if (is_null($this->executeNext())) {
 				sleep($waitTime);
 			}

core/register_command.php

@@ -71,7 +71,9 @@
 	$application->add(new OC\Core\Command\Background\Cron(\OC::$server->getConfig()));
 	$application->add(new OC\Core\Command\Background\WebCron(\OC::$server->getConfig()));
 	$application->add(new OC\Core\Command\Background\Ajax(\OC::$server->getConfig()));
-	$application->add(new OC\Core\Command\Background\Worker());
+	$application->add(new OC\Core\Command\Background\Queue\Worker());
+	$application->add(new OC\Core\Command\Background\Queue\Status());
+	$application->add(new OC\Core\Command\Background\Queue\Delete());
 
 	$application->add(new OC\Core\Command\Config\App\DeleteConfig(\OC::$server->getConfig()));
 	$application->add(new OC\Core\Command\Config\App\GetConfig(\OC::$server->getConfig()));

lib/private/BackgroundJob/JobList.php

@@ -108,7 +108,7 @@ public function remove($job, $argument = null) {
 	/**
 	 * @param int $id
 	 */
-	protected function removeById($id) {
+	public function removeById($id) {
 		$query = $this->connection->getQueryBuilder();
 		$query->delete('jobs')
 			->where($query->expr()->eq('id', $query->createNamedParameter($id, IQueryBuilder::PARAM_INT)));
@@ -305,9 +305,7 @@ public function getLastJob() {
 	}
 
 	/**
-	 * set the lastRun of $job to now
-	 *
-	 * @param IJob $job
+	 * @inheritdoc
 	 */
 	public function setLastRun($job) {
 		$query = $this->connection->getQueryBuilder();
@@ -324,4 +322,24 @@ public function setExecutionTime($job, $timeTaken) {
 			->where($query->expr()->eq('id', $query->createNamedParameter($job->getId(), IQueryBuilder::PARAM_INT)));
 		$query->execute();
 	}
+
+	/**
+	 * @inheritdoc
+	 */
+	public function listJobs(\Closure $callback) {
+		$query = $this->connection->getQueryBuilder();
+		$query->select('*')
+			->from('jobs');
+		$result = $query->execute();
+
+		while ($row = $result->fetch()) {
+			$job = $this->buildJob($row);
+			if ($job) {
+				if ($callback($job) === false) {
+					break;
+				}
+			}
+		}
+		$result->closeCursor();
+	}
 }

lib/public/BackgroundJob/IJobList.php

@@ -127,4 +127,20 @@ public function setLastRun($job);
 	 * @since 10.0.0
 	 */
 	public function setExecutionTime($job, $timeTaken);
+
+	/**
+	 * iterate over all jobs in the queue
+	 *
+	 * @return void
+	 * @since 10.0.3
+	 */
+	public function listJobs(\Closure $callback);
+
+	/**
+	 * remove a specific job by id
+	 * @return void
+	 * @since 10.0.3
+	 */
+	public function removeById($id);
+
 }