move the private namespace OC into lib/private - OCP will stay in lib/public

Conflicts:
	lib/private/vcategories.php

6 files changed, 323 insertions, 0 deletions

diff --git a/lib/private/backgroundjob/job.php b/lib/private/backgroundjob/job.php
new file mode 100644
index 00000000000..49fbffbd684
--- /dev/null
+++ b/lib/private/backgroundjob/job.php
@@ -0,0 +1,49 @@
+<?php
+/**
+ * Copyright (c) 2013 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 OC\BackgroundJob;
+
+abstract class Job {
+	protected $id;
+	protected $lastRun;
+	protected $argument;
+
+	/**
+	 * @param JobList $jobList
+	 */
+	public function execute($jobList) {
+		$jobList->setLastRun($this);
+		$this->run($this->argument);
+	}
+
+	abstract protected function run($argument);
+
+	public function setId($id) {
+		$this->id = $id;
+	}
+
+	public function setLastRun($lastRun) {
+		$this->lastRun = $lastRun;
+	}
+
+	public function setArgument($argument) {
+		$this->argument = $argument;
+	}
+
+	public function getId() {
+		return $this->id;
+	}
+
+	public function getLastRun() {
+		return $this->lastRun;
+	}
+
+	public function getArgument() {
+		return $this->argument;
+	}
+}
diff --git a/lib/private/backgroundjob/joblist.php b/lib/private/backgroundjob/joblist.php
new file mode 100644
index 00000000000..cc803dd9b5f
--- /dev/null
+++ b/lib/private/backgroundjob/joblist.php
@@ -0,0 +1,172 @@
+<?php
+/**
+ * Copyright (c) 2013 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 OC\BackgroundJob;
+
+/**
+ * Class QueuedJob
+ *
+ * create a background job that is to be executed once
+ *
+ * @package OC\BackgroundJob
+ */
+class JobList {
+	/**
+	 * @param Job|string $job
+	 * @param mixed $argument
+	 */
+	public function add($job, $argument = null) {
+		if (!$this->has($job, $argument)) {
+			if ($job instanceof Job) {
+				$class = get_class($job);
+			} else {
+				$class = $job;
+			}
+			$argument = json_encode($argument);
+			$query = \OC_DB::prepare('INSERT INTO `*PREFIX*jobs`(`class`, `argument`, `last_run`) VALUES(?, ?, 0)');
+			$query->execute(array($class, $argument));
+		}
+	}
+
+	/**
+	 * @param Job|string $job
+	 * @param mixed $argument
+	 */
+	public function remove($job, $argument = null) {
+		if ($job instanceof Job) {
+			$class = get_class($job);
+		} else {
+			$class = $job;
+		}
+		if (!is_null($argument)) {
+			$argument = json_encode($argument);
+			$query = \OC_DB::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->execute(array($class));
+		}
+	}
+
+	/**
+	 * check if a job is in the list
+	 *
+	 * @param $job
+	 * @param mixed $argument
+	 * @return bool
+	 */
+	public function has($job, $argument) {
+		if ($job instanceof Job) {
+			$class = get_class($job);
+		} else {
+			$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();
+	}
+
+	/**
+	 * get all jobs in the list
+	 *
+	 * @return Job[]
+	 */
+	public function getAll() {
+		$query = \OC_DB::prepare('SELECT `id`, `class`, `last_run`, `argument` FROM `*PREFIX*jobs`');
+		$result = $query->execute();
+		$jobs = array();
+		while ($row = $result->fetchRow()) {
+			$jobs[] = $this->buildJob($row);
+		}
+		return $jobs;
+	}
+
+	/**
+	 * get the next job in the list
+	 *
+	 * @return Job
+	 */
+	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()) {
+			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()) {
+				return $this->buildJob($row);
+			} else {
+				return null; //empty job list
+			}
+		}
+	}
+
+	/**
+	 * @param int $id
+	 * @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()) {
+			return $this->buildJob($row);
+		} else {
+			return null;
+		}
+	}
+
+	/**
+	 * get the job object from a row in the db
+	 *
+	 * @param array $row
+	 * @return Job
+	 */
+	private function buildJob($row) {
+		$class = $row['class'];
+		/**
+		 * @var Job $job
+		 */
+		$job = new $class();
+		$job->setId($row['id']);
+		$job->setLastRun($row['last_run']);
+		$job->setArgument(json_decode($row['argument']));
+		return $job;
+	}
+
+	/**
+	 * set the job that was last ran
+	 *
+	 * @param Job $job
+	 */
+	public function setLastJob($job) {
+		\OC_Appconfig::setValue('backgroundjob', 'lastjob', $job->getId());
+	}
+
+	/**
+	 * get the id of the last ran job
+	 *
+	 * @return int
+	 */
+	public function getLastJob() {
+		return \OC_Appconfig::getValue('backgroundjob', 'lastjob', 0);
+	}
+
+	/**
+	 * set the lastRun of $job to now
+	 *
+	 * @param Job $job
+	 */
+	public function setLastRun($job) {
+		$query = \OC_DB::prepare('UPDATE `*PREFIX*jobs` SET `last_run` = ? WHERE `id` = ?');
+		$query->execute(array(time(), $job->getId()));
+	}
+}
diff --git a/lib/private/backgroundjob/legacy/queuedjob.php b/lib/private/backgroundjob/legacy/queuedjob.php
new file mode 100644
index 00000000000..2bc001103b8
--- /dev/null
+++ b/lib/private/backgroundjob/legacy/queuedjob.php
@@ -0,0 +1,18 @@
+<?php
+/**
+ * Copyright (c) 2013 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 OC\BackgroundJob\Legacy;
+
+class QueuedJob extends \OC\BackgroundJob\QueuedJob {
+	public function run($argument) {
+		$class = $argument['klass'];
+		$method = $argument['method'];
+		$parameters = $argument['parameters'];
+		call_user_func(array($class, $method), $parameters);
+	}
+}
diff --git a/lib/private/backgroundjob/legacy/regularjob.php b/lib/private/backgroundjob/legacy/regularjob.php
new file mode 100644
index 00000000000..d4cfa348cea
--- /dev/null
+++ b/lib/private/backgroundjob/legacy/regularjob.php
@@ -0,0 +1,15 @@
+<?php
+/**
+ * Copyright (c) 2013 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 OC\BackgroundJob\Legacy;
+
+class RegularJob extends \OC\BackgroundJob\Job {
+	public function run($argument) {
+		call_user_func($argument);
+	}
+}
diff --git a/lib/private/backgroundjob/queuedjob.php b/lib/private/backgroundjob/queuedjob.php
new file mode 100644
index 00000000000..1714182820d
--- /dev/null
+++ b/lib/private/backgroundjob/queuedjob.php
@@ -0,0 +1,28 @@
+<?php
+/**
+ * Copyright (c) 2013 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 OC\BackgroundJob;
+
+/**
+ * Class QueuedJob
+ *
+ * create a background job that is to be executed once
+ *
+ * @package OC\BackgroundJob
+ */
+abstract class QueuedJob extends Job {
+	/**
+	 * run the job, then remove it from the joblist
+	 *
+	 * @param JobList $jobList
+	 */
+	public function execute($jobList) {
+		$jobList->remove($this);
+		$this->run($this->argument);
+	}
+}
diff --git a/lib/private/backgroundjob/timedjob.php b/lib/private/backgroundjob/timedjob.php
new file mode 100644
index 00000000000..ae9f33505ab
--- /dev/null
+++ b/lib/private/backgroundjob/timedjob.php
@@ -0,0 +1,41 @@
+<?php
+/**
+ * Copyright (c) 2013 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 OC\BackgroundJob;
+
+/**
+ * Class QueuedJob
+ *
+ * create a background job that is to be executed at an interval
+ *
+ * @package OC\BackgroundJob
+ */
+abstract class TimedJob extends Job {
+	protected $interval = 0;
+
+	/**
+	 * set the interval for the job
+	 *
+	 * @param int $interval
+	 */
+	public function setInterval($interval) {
+		$this->interval = $interval;
+	}
+
+	/**
+	 * run the job if
+	 *
+	 * @param JobList $jobList
+	 */
+	public function execute($jobList) {
+		if ((time() - $this->lastRun) > $this->interval) {
+			$jobList->setLastRun($this);
+			$this->run($this->argument);
+		}
+	}
+}