2013-04-20 21:27:46 +00:00
|
|
|
<?php
|
|
|
|
/**
|
2015-03-26 10:44:34 +00:00
|
|
|
* @author Jörn Friedrich Dreyer <jfd@butonic.de>
|
|
|
|
* @author Morris Jobke <hey@morrisjobke.de>
|
|
|
|
* @author Robin Appelman <icewind@owncloud.com>
|
|
|
|
* @author Robin McCorkell <rmccorkell@karoshi.org.uk>
|
|
|
|
*
|
|
|
|
* @copyright Copyright (c) 2015, ownCloud, Inc.
|
|
|
|
* @license AGPL-3.0
|
|
|
|
*
|
|
|
|
* This code is free software: you can redistribute it and/or modify
|
|
|
|
* it under the terms of the GNU Affero General Public License, version 3,
|
|
|
|
* as published by the Free Software Foundation.
|
|
|
|
*
|
|
|
|
* 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, version 3,
|
|
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>
|
|
|
|
*
|
2013-04-20 21:27:46 +00:00
|
|
|
*/
|
2015-02-26 10:37:37 +00:00
|
|
|
|
2013-04-20 21:27:46 +00:00
|
|
|
namespace OC\BackgroundJob;
|
|
|
|
|
2014-02-12 12:32:16 +00:00
|
|
|
use OCP\BackgroundJob\IJobList;
|
2015-09-05 15:50:02 +00:00
|
|
|
use OCP\AutoloadNotAllowedException;
|
2014-02-12 12:32:16 +00:00
|
|
|
|
|
|
|
class JobList implements IJobList {
|
2014-02-11 13:00:24 +00:00
|
|
|
/**
|
|
|
|
* @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;
|
|
|
|
}
|
|
|
|
|
2013-04-20 21:27:46 +00:00
|
|
|
/**
|
2014-05-11 20:51:30 +00:00
|
|
|
* @param Job|string $job
|
2013-04-20 21:27:46 +00:00
|
|
|
* @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);
|
2015-02-23 17:07:13 +00:00
|
|
|
if (strlen($argument) > 4000) {
|
2015-02-26 14:07:51 +00:00
|
|
|
throw new \InvalidArgumentException('Background job arguments can\'t exceed 4000 characters (json encoded)');
|
2015-02-17 15:52:09 +00:00
|
|
|
}
|
2014-02-11 13:00:24 +00:00
|
|
|
$query = $this->conn->prepare('INSERT INTO `*PREFIX*jobs`(`class`, `argument`, `last_run`) VALUES(?, ?, 0)');
|
2013-04-20 21:27:46 +00:00
|
|
|
$query->execute(array($class, $argument));
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2014-05-11 20:51:30 +00:00
|
|
|
* @param Job|string $job
|
2013-04-20 21:27:46 +00:00
|
|
|
* @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);
|
2014-02-11 13:00:24 +00:00
|
|
|
$query = $this->conn->prepare('DELETE FROM `*PREFIX*jobs` WHERE `class` = ? AND `argument` = ?');
|
2013-04-20 21:27:46 +00:00
|
|
|
$query->execute(array($class, $argument));
|
|
|
|
} else {
|
2014-02-11 13:00:24 +00:00
|
|
|
$query = $this->conn->prepare('DELETE FROM `*PREFIX*jobs` WHERE `class` = ?');
|
2013-04-20 21:27:46 +00:00
|
|
|
$query->execute(array($class));
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2015-08-19 12:16:05 +00:00
|
|
|
protected function removeById($id) {
|
|
|
|
$query = $this->conn->prepare('DELETE FROM `*PREFIX*jobs` WHERE `id` = ?');
|
|
|
|
$query->execute([$id]);
|
|
|
|
}
|
|
|
|
|
2013-04-20 21:27:46 +00:00
|
|
|
/**
|
|
|
|
* check if a job is in the list
|
|
|
|
*
|
2014-05-11 20:51:30 +00:00
|
|
|
* @param Job|string $job
|
2013-04-20 21:27:46 +00:00
|
|
|
* @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);
|
2014-02-11 13:00:24 +00:00
|
|
|
$query = $this->conn->prepare('SELECT `id` FROM `*PREFIX*jobs` WHERE `class` = ? AND `argument` = ?');
|
|
|
|
$query->execute(array($class, $argument));
|
|
|
|
return (bool)$query->fetch();
|
2013-04-20 21:27:46 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* get all jobs in the list
|
|
|
|
*
|
|
|
|
* @return Job[]
|
|
|
|
*/
|
|
|
|
public function getAll() {
|
2014-02-11 13:00:24 +00:00
|
|
|
$query = $this->conn->prepare('SELECT `id`, `class`, `last_run`, `argument` FROM `*PREFIX*jobs`');
|
|
|
|
$query->execute();
|
2013-04-20 21:27:46 +00:00
|
|
|
$jobs = array();
|
2014-02-11 13:00:24 +00:00
|
|
|
while ($row = $query->fetch()) {
|
2014-07-25 16:02:02 +00:00
|
|
|
$job = $this->buildJob($row);
|
|
|
|
if ($job) {
|
|
|
|
$jobs[] = $job;
|
|
|
|
}
|
2013-04-20 21:27:46 +00:00
|
|
|
}
|
|
|
|
return $jobs;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* get the next job in the list
|
|
|
|
*
|
|
|
|
* @return Job
|
|
|
|
*/
|
|
|
|
public function getNext() {
|
|
|
|
$lastId = $this->getLastJob();
|
2014-02-11 13:00:24 +00:00
|
|
|
$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()) {
|
2015-08-19 12:16:05 +00:00
|
|
|
$jobId = $row['id'];
|
|
|
|
$job = $this->buildJob($row);
|
2013-04-20 21:27:46 +00:00
|
|
|
} else {
|
|
|
|
//begin at the start of the queue
|
2014-02-11 13:00:24 +00:00
|
|
|
$query = $this->conn->prepare('SELECT `id`, `class`, `last_run`, `argument` FROM `*PREFIX*jobs` ORDER BY `id` ASC', 1);
|
|
|
|
$query->execute();
|
|
|
|
if ($row = $query->fetch()) {
|
2015-08-19 12:16:05 +00:00
|
|
|
$jobId = $row['id'];
|
|
|
|
$job = $this->buildJob($row);
|
2013-04-20 21:27:46 +00:00
|
|
|
} else {
|
|
|
|
return null; //empty job list
|
|
|
|
}
|
|
|
|
}
|
2015-08-19 12:16:05 +00:00
|
|
|
if (is_null($job)) {
|
|
|
|
$this->removeById($jobId);
|
|
|
|
return $this->getNext();
|
|
|
|
} else {
|
|
|
|
return $job;
|
|
|
|
}
|
2013-04-20 21:27:46 +00:00
|
|
|
}
|
|
|
|
|
2013-04-24 12:38:41 +00:00
|
|
|
/**
|
|
|
|
* @param int $id
|
2014-05-11 20:51:30 +00:00
|
|
|
* @return Job|null
|
2013-04-24 12:38:41 +00:00
|
|
|
*/
|
|
|
|
public function getById($id) {
|
2014-02-11 13:00:24 +00:00
|
|
|
$query = $this->conn->prepare('SELECT `id`, `class`, `last_run`, `argument` FROM `*PREFIX*jobs` WHERE `id` = ?');
|
|
|
|
$query->execute(array($id));
|
|
|
|
if ($row = $query->fetch()) {
|
2013-04-24 12:38:41 +00:00
|
|
|
return $this->buildJob($row);
|
|
|
|
} else {
|
|
|
|
return null;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2013-04-20 21:27:46 +00:00
|
|
|
/**
|
|
|
|
* 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
|
|
|
|
*/
|
2015-09-05 15:50:02 +00:00
|
|
|
try {
|
|
|
|
if (!class_exists($class)) {
|
|
|
|
// job from disabled app or old version of an app, no need to do anything
|
|
|
|
return null;
|
|
|
|
}
|
|
|
|
$job = new $class();
|
|
|
|
$job->setId($row['id']);
|
|
|
|
$job->setLastRun($row['last_run']);
|
|
|
|
$job->setArgument(json_decode($row['argument'], true));
|
|
|
|
return $job;
|
|
|
|
} catch (AutoloadNotAllowedException $e) {
|
|
|
|
// job is from a disabled app, ignore
|
2014-06-26 20:39:40 +00:00
|
|
|
}
|
2015-09-05 15:50:02 +00:00
|
|
|
return null;
|
2013-04-20 21:27:46 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* set the job that was last ran
|
|
|
|
*
|
|
|
|
* @param Job $job
|
|
|
|
*/
|
|
|
|
public function setLastJob($job) {
|
2014-02-11 13:00:24 +00:00
|
|
|
$this->config->setAppValue('backgroundjob', 'lastjob', $job->getId());
|
2013-04-20 21:27:46 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* get the id of the last ran job
|
|
|
|
*
|
2014-02-06 15:30:58 +00:00
|
|
|
* @return string
|
2013-04-20 21:27:46 +00:00
|
|
|
*/
|
|
|
|
public function getLastJob() {
|
2014-02-12 12:52:13 +00:00
|
|
|
return $this->config->getAppValue('backgroundjob', 'lastjob', 0);
|
2013-04-20 21:27:46 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* set the lastRun of $job to now
|
|
|
|
*
|
|
|
|
* @param Job $job
|
|
|
|
*/
|
|
|
|
public function setLastRun($job) {
|
2014-02-11 13:00:24 +00:00
|
|
|
$query = $this->conn->prepare('UPDATE `*PREFIX*jobs` SET `last_run` = ? WHERE `id` = ?');
|
2013-04-20 21:27:46 +00:00
|
|
|
$query->execute(array(time(), $job->getId()));
|
|
|
|
}
|
|
|
|
}
|