Add backgroundjobs to OCP

This adds abstract classes to base background jobs on.
Right now almost all uses of this use the private namespace.

For most usages it will be enough to just extend the the abstract
classes QueuedJob or TimedJob.

It should be a straight forward drop in replacement.

The private jobs can then be killed off after a few releases. So we have
a nice public API.

Signed-off-by: Roeland Jago Douma <roeland@famdouma.nl>

1 files changed, 48 insertions, 0 deletions

diff --git a/lib/public/BackgroundJob/QueuedJob.php b/lib/public/BackgroundJob/QueuedJob.php
new file mode 100644
index 00000000000..4964ed9ad33
--- /dev/null
+++ b/lib/public/BackgroundJob/QueuedJob.php
@@ -0,0 +1,48 @@
+<?php
+declare(strict_types=1);
+/**
+ * @copyright Copyright (c) 2018, Roeland Jago Douma <roeland@famdouma.nl>
+ *
+ * @author Roeland Jago Douma <roeland@famdouma.nl>
+ *
+ * @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 OCP\BackgroundJob;
+
+use OCP\ILogger;
+
+/**
+ * Simple base class for a one time background job
+ *
+ * @since 15.0.0
+ */
+abstract class QueuedJob extends Job {
+
+	/**
+	 * run the job, then remove it from the joblist
+	 *
+	 * @param IJobList $jobList
+	 * @param ILogger|null $logger
+	 *
+	 * @since 15.0.0
+	 */
+	final public function execute($jobList, ILogger $logger = null) {
+		$jobList->remove($this, $this->argument);
+		parent::execute($jobList, $logger);
+	}
+}