occ background-job:delete

Signed-off-by: Maxence Lange <[email protected]>

core/Command/Background/Delete.php

@@ -0,0 +1,80 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * @copyright Copyright (c) 2024, Maxence Lange <[email protected]>
+ *
+ * @author Maxence Lange <[email protected]>
+ *
+ * @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\Base;
+use OCP\BackgroundJob\IJobList;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Question\ConfirmationQuestion;
+
+class Delete extends Base {
+	public function __construct(
+		protected IJobList $jobList,
+	) {
+		parent::__construct();
+	}
+
+	protected function configure(): void {
+		$this
+			->setName('background-job:delete')
+			->setDescription('Remove a background job from database')
+			->addArgument(
+				'job-id',
+				InputArgument::REQUIRED,
+				'The ID of the job in the database'
+			);
+	}
+
+	protected function execute(InputInterface $input, OutputInterface $output): int {
+		$jobId = (int) $input->getArgument('job-id');
+
+		$job = $this->jobList->getById($jobId);
+		if ($job === null) {
+			$output->writeln('<error>Job with ID ' . $jobId . ' could not be found in the database</error>');
+			return 1;
+		}
+
+		$output->writeln('Job class: ' . get_class($job));
+		$output->writeln('Arguments: ' . json_encode($job->getArgument()));
+		$output->writeln('');
+
+		$question = new ConfirmationQuestion(
+			'<comment>Do you really want to delete this background job ? It could create some misbehaviours in Nextcloud.</comment> (y/N) ', false,
+			'/^(y|Y)/i'
+		);
+
+		$helper = $this->getHelper('question');
+		if (!$helper->ask($input, $output, $question)) {
+			$output->writeln('aborted.');
+			return 0;
+		}
+
+		$this->jobList->remove($job, $job->getArgument());
+		return 0;
+	}
+}

core/register_command.php

@@ -92,6 +92,7 @@
 	$application->add(new OC\Core\Command\Background\Ajax(\OC::$server->getConfig()));
 	$application->add(new OC\Core\Command\Background\Job(\OC::$server->getJobList(), \OC::$server->getLogger()));
 	$application->add(new OC\Core\Command\Background\ListCommand(\OC::$server->getJobList()));
+	$application->add(\OCP\Server::get(\OC\Core\Command\Background\Delete::class));
 
 	$application->add(\OC::$server->query(\OC\Core\Command\Broadcast\Test::class));
 

lib/composer/composer/autoload_classmap.php

@@ -1023,6 +1023,7 @@
     'OC\\Core\\Command\\Background\\Ajax' => $baseDir . '/core/Command/Background/Ajax.php',
     'OC\\Core\\Command\\Background\\Base' => $baseDir . '/core/Command/Background/Base.php',
     'OC\\Core\\Command\\Background\\Cron' => $baseDir . '/core/Command/Background/Cron.php',
+    'OC\\Core\\Command\\Background\\Delete' => $baseDir . '/core/Command/Background/Delete.php',
     'OC\\Core\\Command\\Background\\Job' => $baseDir . '/core/Command/Background/Job.php',
     'OC\\Core\\Command\\Background\\ListCommand' => $baseDir . '/core/Command/Background/ListCommand.php',
     'OC\\Core\\Command\\Background\\WebCron' => $baseDir . '/core/Command/Background/WebCron.php',

lib/composer/composer/autoload_static.php

@@ -1056,6 +1056,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
         'OC\\Core\\Command\\Background\\Ajax' => __DIR__ . '/../../..' . '/core/Command/Background/Ajax.php',
         'OC\\Core\\Command\\Background\\Base' => __DIR__ . '/../../..' . '/core/Command/Background/Base.php',
         'OC\\Core\\Command\\Background\\Cron' => __DIR__ . '/../../..' . '/core/Command/Background/Cron.php',
+        'OC\\Core\\Command\\Background\\Delete' => __DIR__ . '/../../..' . '/core/Command/Background/Delete.php',
         'OC\\Core\\Command\\Background\\Job' => __DIR__ . '/../../..' . '/core/Command/Background/Job.php',
         'OC\\Core\\Command\\Background\\ListCommand' => __DIR__ . '/../../..' . '/core/Command/Background/ListCommand.php',
         'OC\\Core\\Command\\Background\\WebCron' => __DIR__ . '/../../..' . '/core/Command/Background/WebCron.php',