Merge pull request #7156 from owncloud/backgroundjob-public

Add the background job list to the public server container

7 files changed, 196 insertions, 38 deletions

diff --git a/lib/private/backgroundjob/job.php b/lib/private/backgroundjob/job.php
index 92bd0f8fdbd..0cef401bc24 100644
--- a/lib/private/backgroundjob/job.php
+++ b/lib/private/backgroundjob/job.php
@@ -8,7 +8,9 @@
 
 namespace OC\BackgroundJob;
 
-abstract class Job {
+use OCP\BackgroundJob\IJob;
+
+abstract class Job implements IJob {
 	/**
 	 * @var int $id
 	 */
diff --git a/lib/private/backgroundjob/joblist.php b/lib/private/backgroundjob/joblist.php
index 99743a70c77..586e99a3cbc 100644
--- a/lib/private/backgroundjob/joblist.php
+++ b/lib/private/backgroundjob/joblist.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright (c) 2013 Robin Appelman <icewind@owncloud.com>
+ * Copyright (c) 2014 Robin Appelman <icewind@owncloud.com>
  * This file is licensed under the Affero General Public License version 3 or
  * later.
  * See the COPYING-README file.
@@ -8,14 +8,28 @@
 
 namespace OC\BackgroundJob;
 
-/**
- * Class QueuedJob
- *
- * create a background job that is to be executed once
- *
- * @package OC\BackgroundJob
- */
-class JobList {
+use OCP\BackgroundJob\IJobList;
+
+class JobList implements IJobList {
+	/**
+	 * @var \OCP\IDBConnection
+	 */
+	private $conn;
+
+	/**
+	 * @var \OCP\IConfig $config
+	 */
+	private $config;
+
+	/**
+	 * @param \OCP\IDBConnection $conn
+	 * @param \OCP\IConfig $config
+	 */
+	public function __construct($conn, $config) {
+		$this->conn = $conn;
+		$this->config = $config;
+	}
+
 	/**
 	 * @param Job|string $job
 	 * @param mixed $argument
@@ -28,7 +42,7 @@ class JobList {
 				$class = $job;
 			}
 			$argument = json_encode($argument);
-			$query = \OC_DB::prepare('INSERT INTO `*PREFIX*jobs`(`class`, `argument`, `last_run`) VALUES(?, ?, 0)');
+			$query = $this->conn->prepare('INSERT INTO `*PREFIX*jobs`(`class`, `argument`, `last_run`) VALUES(?, ?, 0)');
 			$query->execute(array($class, $argument));
 		}
 	}
@@ -45,10 +59,10 @@ class JobList {
 		}
 		if (!is_null($argument)) {
 			$argument = json_encode($argument);
-			$query = \OC_DB::prepare('DELETE FROM `*PREFIX*jobs` WHERE `class` = ? AND `argument` = ?');
+			$query = $this->conn->prepare('DELETE FROM `*PREFIX*jobs` WHERE `class` = ? AND `argument` = ?');
 			$query->execute(array($class, $argument));
 		} else {
-			$query = \OC_DB::prepare('DELETE FROM `*PREFIX*jobs` WHERE `class` = ?');
+			$query = $this->conn->prepare('DELETE FROM `*PREFIX*jobs` WHERE `class` = ?');
 			$query->execute(array($class));
 		}
 	}
@@ -67,9 +81,9 @@ class JobList {
 			$class = $job;
 		}
 		$argument = json_encode($argument);
-		$query = \OC_DB::prepare('SELECT `id` FROM `*PREFIX*jobs` WHERE `class` = ? AND `argument` = ?');
-		$result = $query->execute(array($class, $argument));
-		return (bool)$result->fetchRow();
+		$query = $this->conn->prepare('SELECT `id` FROM `*PREFIX*jobs` WHERE `class` = ? AND `argument` = ?');
+		$query->execute(array($class, $argument));
+		return (bool)$query->fetch();
 	}
 
 	/**
@@ -78,10 +92,10 @@ class JobList {
 	 * @return Job[]
 	 */
 	public function getAll() {
-		$query = \OC_DB::prepare('SELECT `id`, `class`, `last_run`, `argument` FROM `*PREFIX*jobs`');
-		$result = $query->execute();
+		$query = $this->conn->prepare('SELECT `id`, `class`, `last_run`, `argument` FROM `*PREFIX*jobs`');
+		$query->execute();
 		$jobs = array();
-		while ($row = $result->fetchRow()) {
+		while ($row = $query->fetch()) {
 			$jobs[] = $this->buildJob($row);
 		}
 		return $jobs;
@@ -94,15 +108,15 @@ class JobList {
 	 */
 	public function getNext() {
 		$lastId = $this->getLastJob();
-		$query = \OC_DB::prepare('SELECT `id`, `class`, `last_run`, `argument` FROM `*PREFIX*jobs` WHERE `id` > ? ORDER BY `id` ASC', 1);
-		$result = $query->execute(array($lastId));
-		if ($row = $result->fetchRow()) {
+		$query = $this->conn->prepare('SELECT `id`, `class`, `last_run`, `argument` FROM `*PREFIX*jobs` WHERE `id` > ? ORDER BY `id` ASC', 1);
+		$query->execute(array($lastId));
+		if ($row = $query->fetch()) {
 			return $this->buildJob($row);
 		} else {
 			//begin at the start of the queue
-			$query = \OC_DB::prepare('SELECT `id`, `class`, `last_run`, `argument` FROM `*PREFIX*jobs` ORDER BY `id` ASC', 1);
-			$result = $query->execute();
-			if ($row = $result->fetchRow()) {
+			$query = $this->conn->prepare('SELECT `id`, `class`, `last_run`, `argument` FROM `*PREFIX*jobs` ORDER BY `id` ASC', 1);
+			$query->execute();
+			if ($row = $query->fetch()) {
 				return $this->buildJob($row);
 			} else {
 				return null; //empty job list
@@ -115,9 +129,9 @@ class JobList {
 	 * @return Job
 	 */
 	public function getById($id) {
-		$query = \OC_DB::prepare('SELECT `id`, `class`, `last_run`, `argument` FROM `*PREFIX*jobs` WHERE `id` = ?');
-		$result = $query->execute(array($id));
-		if ($row = $result->fetchRow()) {
+		$query = $this->conn->prepare('SELECT `id`, `class`, `last_run`, `argument` FROM `*PREFIX*jobs` WHERE `id` = ?');
+		$query->execute(array($id));
+		if ($row = $query->fetch()) {
 			return $this->buildJob($row);
 		} else {
 			return null;
@@ -148,7 +162,7 @@ class JobList {
 	 * @param Job $job
 	 */
 	public function setLastJob($job) {
-		\OC_Appconfig::setValue('backgroundjob', 'lastjob', $job->getId());
+		$this->config->setAppValue('backgroundjob', 'lastjob', $job->getId());
 	}
 
 	/**
@@ -157,7 +171,7 @@ class JobList {
 	 * @return int
 	 */
 	public function getLastJob() {
-		return \OC_Appconfig::getValue('backgroundjob', 'lastjob', 0);
+		return $this->config->getAppValue('backgroundjob', 'lastjob', 0);
 	}
 
 	/**
@@ -166,7 +180,7 @@ class JobList {
 	 * @param Job $job
 	 */
 	public function setLastRun($job) {
-		$query = \OC_DB::prepare('UPDATE `*PREFIX*jobs` SET `last_run` = ? WHERE `id` = ?');
+		$query = $this->conn->prepare('UPDATE `*PREFIX*jobs` SET `last_run` = ? WHERE `id` = ?');
 		$query->execute(array(time(), $job->getId()));
 	}
 }
diff --git a/lib/private/server.php b/lib/private/server.php
index fc8f170dc4a..7696fc207fd 100644
--- a/lib/private/server.php
+++ b/lib/private/server.php
@@ -151,6 +151,13 @@ class Server extends SimpleContainer implements IServerContainer {
 		$this->registerService('AvatarManager', function($c) {
 			return new AvatarManager();
 		});
+		$this->registerService('JobList', function ($c) {
+			/**
+			 * @var Server $c
+			 */
+			$config = $c->getConfig();
+			return new \OC\BackgroundJob\JobList($c->getDatabaseConnection(), $config);
+		});
 	}
 
 	/**
@@ -348,4 +355,13 @@ class Server extends SimpleContainer implements IServerContainer {
 	function getActivityManager() {
 		return $this->query('ActivityManager');
 	}
+
+	/**
+	 * Returns an job list for controlling background jobs
+	 *
+	 * @return \OCP\BackgroundJob\IJobList
+	 */
+	function getJobList(){
+		return $this->query('JobList');
+	}
 }
diff --git a/lib/public/backgroundjob.php b/lib/public/backgroundjob.php
index a7f54491dfa..bcaf6e35454 100644
--- a/lib/public/backgroundjob.php
+++ b/lib/public/backgroundjob.php
@@ -33,7 +33,7 @@ use \OC\BackgroundJob\JobList;
 /**
  * This class provides functions to register backgroundjobs in ownCloud
  *
- * To create a new backgroundjob create a new class that inharits from either \OC\BackgroundJob\Job,
+ * To create a new backgroundjob create a new class that inherits from either \OC\BackgroundJob\Job,
  * \OC\BackgroundJob\QueuedJob or \OC\BackgroundJob\TimedJob and register it using
  * \OCP\BackgroundJob->registerJob($job, $argument), $argument will be passed to the run() function
  * of the job when the job is executed.
@@ -73,7 +73,7 @@ class BackgroundJob {
 	 * @param mixed $argument
 	 */
 	public static function registerJob($job, $argument = null) {
-		$jobList = new JobList();
+		$jobList = \OC::$server->getJobList();
 		$jobList->add($job, $argument);
 	}
 
@@ -99,7 +99,7 @@ class BackgroundJob {
 	 * key is string "$klass-$method", value is array( $klass, $method )
 	 */
 	static public function allRegularTasks() {
-		$jobList = new JobList();
+		$jobList = \OC::$server->getJobList();
 		$allJobs = $jobList->getAll();
 		$regularJobs = array();
 		foreach ($allJobs as $job) {
@@ -118,7 +118,7 @@ class BackgroundJob {
 	 * @return associative array
 	 */
 	public static function findQueuedTask($id) {
-		$jobList = new JobList();
+		$jobList = \OC::$server->getJobList();
 		return $jobList->getById($id);
 	}
 
@@ -128,7 +128,7 @@ class BackgroundJob {
 	 * @return array with associative arrays
 	 */
 	public static function allQueuedTasks() {
-		$jobList = new JobList();
+		$jobList = \OC::$server->getJobList();
 		$allJobs = $jobList->getAll();
 		$queuedJobs = array();
 		foreach ($allJobs as $job) {
@@ -148,7 +148,7 @@ class BackgroundJob {
 	 * @return array with associative arrays
 	 */
 	public static function queuedTaskWhereAppIs($app) {
-		$jobList = new JobList();
+		$jobList = \OC::$server->getJobList();
 		$allJobs = $jobList->getAll();
 		$queuedJobs = array();
 		foreach ($allJobs as $job) {
@@ -186,7 +186,7 @@ class BackgroundJob {
 	 * Deletes a report
 	 */
 	public static function deleteQueuedTask($id) {
-		$jobList = new JobList();
+		$jobList = \OC::$server->getJobList();
 		$job = $jobList->getById($id);
 		if ($job) {
 			$jobList->remove($job);
diff --git a/lib/public/backgroundjob/ijob.php b/lib/public/backgroundjob/ijob.php
new file mode 100644
index 00000000000..5231e9537a9
--- /dev/null
+++ b/lib/public/backgroundjob/ijob.php
@@ -0,0 +1,42 @@
+<?php
+/**
+ * Copyright (c) 2014 Robin Appelman <icewind@owncloud.com>
+ * This file is licensed under the Affero General Public License version 3 or
+ * later.
+ * See the COPYING-README file.
+ */
+
+namespace OCP\BackgroundJob;
+
+interface IJob {
+	/**
+	 * Run the background job with the registered argument
+	 *
+	 * @param \OCP\BackgroundJob\IJobList $jobList The job list that manages the state of this job
+	 * @param \OC\Log $logger
+	 */
+	public function execute($jobList, $logger = null);
+
+	/**
+	 * Get the id of the background job
+	 * This id is determined by the job list when a job is added to the list
+	 *
+	 * @return int
+	 */
+	public function getId();
+
+	/**
+	 * Get the last time this job was run as unix timestamp
+	 *
+	 * @return int
+	 */
+	public function getLastRun();
+
+	/**
+	 * Get the argument associated with the background job
+	 * This is the argument that will be passed to the background job
+	 *
+	 * @return mixed
+	 */
+	public function getArgument();
+}
diff --git a/lib/public/backgroundjob/ijoblist.php b/lib/public/backgroundjob/ijoblist.php
new file mode 100644
index 00000000000..72f3fe863da
--- /dev/null
+++ b/lib/public/backgroundjob/ijoblist.php
@@ -0,0 +1,77 @@
+<?php
+/**
+ * Copyright (c) 2014 Robin Appelman <icewind@owncloud.com>
+ * This file is licensed under the Affero General Public License version 3 or
+ * later.
+ * See the COPYING-README file.
+ */
+
+namespace OCP\BackgroundJob;
+
+interface IJobList {
+	/**
+	 * Add a job to the list
+	 *
+	 * @param \OCP\BackgroundJob\IJob |string $job
+	 * @param mixed $argument The argument to be passed to $job->run() when the job is exectured
+	 */
+	public function add($job, $argument = null);
+
+	/**
+	 * Remove a job from the list
+	 *
+	 * @param \OCP\BackgroundJob\IJob|string $job
+	 * @param mixed $argument
+	 */
+	public function remove($job, $argument = null);
+
+	/**
+	 * check if a job is in the list
+	 *
+	 * @param $job
+	 * @param mixed $argument
+	 * @return bool
+	 */
+	public function has($job, $argument);
+
+	/**
+	 * get all jobs in the list
+	 *
+	 * @return \OCP\BackgroundJob\IJob[]
+	 */
+	public function getAll();
+
+	/**
+	 * get the next job in the list
+	 *
+	 * @return \OCP\BackgroundJob\IJob
+	 */
+	public function getNext();
+
+	/**
+	 * @param int $id
+	 * @return \OCP\BackgroundJob\IJob
+	 */
+	public function getById($id);
+
+	/**
+	 * set the job that was last ran to the current time
+	 *
+	 * @param \OCP\BackgroundJob\IJob $job
+	 */
+	public function setLastJob($job);
+
+	/**
+	 * get the id of the last ran job
+	 *
+	 * @return int
+	 */
+	public function getLastJob();
+
+	/**
+	 * set the lastRun of $job to now
+	 *
+	 * @param \OCP\BackgroundJob\IJob $job
+	 */
+	public function setLastRun($job);
+}
diff --git a/lib/public/iservercontainer.php b/lib/public/iservercontainer.php
index dcb00caf496..5fb51f9ecd5 100644
--- a/lib/public/iservercontainer.php
+++ b/lib/public/iservercontainer.php
@@ -183,4 +183,11 @@ interface IServerContainer {
 	 */
 	function getAvatarManager();
 
+	/**
+	 * Returns an job list for controlling background jobs
+	 *
+	 * @return \OCP\BackgroundJob\IJobList
+	 */
+	function getJobList();
+
 }