2013-04-21 01:27:46 +04:00
|
|
|
<?php
|
|
|
|
/**
|
2015-03-26 13:44:34 +03: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-21 01:27:46 +04:00
|
|
|
*/
|
2015-02-26 13:37:37 +03:00
|
|
|
|
2013-04-21 01:27:46 +04:00
|
|
|
namespace OC\BackgroundJob;
|
|
|
|
|
2015-12-18 13:44:32 +03:00
|
|
|
use OCP\AppFramework\QueryException;
|
2015-12-18 12:04:30 +03:00
|
|
|
use OCP\BackgroundJob\IJob;
|
2014-02-12 16:32:16 +04:00
|
|
|
use OCP\BackgroundJob\IJobList;
|
2015-09-05 18:50:02 +03:00
|
|
|
use OCP\AutoloadNotAllowedException;
|
2014-02-12 16:32:16 +04:00
|
|
|
|
|
|
|
class JobList implements IJobList {
|
2015-12-18 11:47:54 +03:00
|
|
|
/** @var \OCP\IDBConnection */
|
|
|
|
protected $connection;
|
2014-02-11 17:00:24 +04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @var \OCP\IConfig $config
|
|
|
|
*/
|
2015-12-18 11:47:54 +03:00
|
|
|
protected $config;
|
2014-02-11 17:00:24 +04:00
|
|
|
|
|
|
|
/**
|
2015-12-18 11:47:54 +03:00
|
|
|
* @param \OCP\IDBConnection $connection
|
2014-02-11 17:00:24 +04:00
|
|
|
* @param \OCP\IConfig $config
|
|
|
|
*/
|
2015-12-18 11:47:54 +03:00
|
|
|
public function __construct($connection, $config) {
|
|
|
|
$this->connection = $connection;
|
2014-02-11 17:00:24 +04:00
|
|
|
$this->config = $config;
|
|
|
|
}
|
|
|
|
|
2013-04-21 01:27:46 +04:00
|
|
|
/**
|
2015-12-18 12:04:30 +03:00
|
|
|
* @param IJob|string $job
|
2013-04-21 01:27:46 +04:00
|
|
|
* @param mixed $argument
|
|
|
|
*/
|
|
|
|
public function add($job, $argument = null) {
|
|
|
|
if (!$this->has($job, $argument)) {
|
2015-12-18 12:04:30 +03:00
|
|
|
if ($job instanceof IJob) {
|
2013-04-21 01:27:46 +04:00
|
|
|
$class = get_class($job);
|
|
|
|
} else {
|
|
|
|
$class = $job;
|
|
|
|
}
|
2015-12-18 11:47:54 +03:00
|
|
|
|
2013-04-21 01:27:46 +04:00
|
|
|
$argument = json_encode($argument);
|
2015-02-23 20:07:13 +03:00
|
|
|
if (strlen($argument) > 4000) {
|
2015-02-26 17:07:51 +03:00
|
|
|
throw new \InvalidArgumentException('Background job arguments can\'t exceed 4000 characters (json encoded)');
|
2015-02-17 18:52:09 +03:00
|
|
|
}
|
2015-12-18 11:47:54 +03:00
|
|
|
|
|
|
|
$query = $this->connection->getQueryBuilder();
|
|
|
|
$query->insert('jobs')
|
|
|
|
->values([
|
|
|
|
'class' => $query->createNamedParameter($class),
|
|
|
|
'argument' => $query->createNamedParameter($argument),
|
|
|
|
'last_run' => $query->createNamedParameter(0, \PDO::PARAM_INT),
|
|
|
|
]);
|
|
|
|
$query->execute();
|
2013-04-21 01:27:46 +04:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2015-12-18 12:04:30 +03:00
|
|
|
* @param IJob|string $job
|
2013-04-21 01:27:46 +04:00
|
|
|
* @param mixed $argument
|
|
|
|
*/
|
|
|
|
public function remove($job, $argument = null) {
|
2015-12-18 12:04:30 +03:00
|
|
|
if ($job instanceof IJob) {
|
2013-04-21 01:27:46 +04:00
|
|
|
$class = get_class($job);
|
|
|
|
} else {
|
|
|
|
$class = $job;
|
|
|
|
}
|
2015-12-18 11:47:54 +03:00
|
|
|
|
|
|
|
$query = $this->connection->getQueryBuilder();
|
|
|
|
$query->delete('jobs')
|
|
|
|
->where($query->expr()->eq('class', $query->createNamedParameter($class)));
|
2013-04-21 01:27:46 +04:00
|
|
|
if (!is_null($argument)) {
|
|
|
|
$argument = json_encode($argument);
|
2015-12-18 11:47:54 +03:00
|
|
|
$query->andWhere($query->expr()->eq('argument', $query->createNamedParameter($argument)));
|
2013-04-21 01:27:46 +04:00
|
|
|
}
|
2015-12-18 11:47:54 +03:00
|
|
|
$query->execute();
|
2013-04-21 01:27:46 +04:00
|
|
|
}
|
|
|
|
|
2015-12-18 11:47:54 +03:00
|
|
|
/**
|
|
|
|
* @param int $id
|
|
|
|
*/
|
2015-08-19 15:16:05 +03:00
|
|
|
protected function removeById($id) {
|
2015-12-18 11:47:54 +03:00
|
|
|
$query = $this->connection->getQueryBuilder();
|
|
|
|
$query->delete('jobs')
|
|
|
|
->where($query->expr()->eq('id', $query->createNamedParameter($id, \PDO::PARAM_INT)));
|
|
|
|
$query->execute();
|
2015-08-19 15:16:05 +03:00
|
|
|
}
|
|
|
|
|
2013-04-21 01:27:46 +04:00
|
|
|
/**
|
|
|
|
* check if a job is in the list
|
|
|
|
*
|
2015-12-18 12:04:30 +03:00
|
|
|
* @param IJob|string $job
|
2013-04-21 01:27:46 +04:00
|
|
|
* @param mixed $argument
|
|
|
|
* @return bool
|
|
|
|
*/
|
|
|
|
public function has($job, $argument) {
|
2015-12-18 12:04:30 +03:00
|
|
|
if ($job instanceof IJob) {
|
2013-04-21 01:27:46 +04:00
|
|
|
$class = get_class($job);
|
|
|
|
} else {
|
|
|
|
$class = $job;
|
|
|
|
}
|
|
|
|
$argument = json_encode($argument);
|
2015-12-18 11:47:54 +03:00
|
|
|
|
|
|
|
$query = $this->connection->getQueryBuilder();
|
|
|
|
$query->select('id')
|
|
|
|
->from('jobs')
|
|
|
|
->where($query->expr()->eq('class', $query->createNamedParameter($class)))
|
|
|
|
->andWhere($query->expr()->eq('argument', $query->createNamedParameter($argument)))
|
|
|
|
->setMaxResults(1);
|
|
|
|
|
|
|
|
$result = $query->execute();
|
|
|
|
$row = $result->fetch();
|
|
|
|
$result->closeCursor();
|
|
|
|
|
|
|
|
return (bool) $row;
|
2013-04-21 01:27:46 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* get all jobs in the list
|
|
|
|
*
|
2015-12-18 12:04:30 +03:00
|
|
|
* @return IJob[]
|
2013-04-21 01:27:46 +04:00
|
|
|
*/
|
|
|
|
public function getAll() {
|
2015-12-18 11:47:54 +03:00
|
|
|
$query = $this->connection->getQueryBuilder();
|
|
|
|
$query->select('*')
|
|
|
|
->from('jobs');
|
|
|
|
$result = $query->execute();
|
|
|
|
|
|
|
|
$jobs = [];
|
|
|
|
while ($row = $result->fetch()) {
|
2014-07-25 20:02:02 +04:00
|
|
|
$job = $this->buildJob($row);
|
|
|
|
if ($job) {
|
|
|
|
$jobs[] = $job;
|
|
|
|
}
|
2013-04-21 01:27:46 +04:00
|
|
|
}
|
2015-12-18 11:47:54 +03:00
|
|
|
$result->closeCursor();
|
|
|
|
|
2013-04-21 01:27:46 +04:00
|
|
|
return $jobs;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* get the next job in the list
|
|
|
|
*
|
2015-12-18 12:04:30 +03:00
|
|
|
* @return IJob|null
|
2013-04-21 01:27:46 +04:00
|
|
|
*/
|
|
|
|
public function getNext() {
|
|
|
|
$lastId = $this->getLastJob();
|
2015-12-18 11:47:54 +03:00
|
|
|
|
|
|
|
$query = $this->connection->getQueryBuilder();
|
|
|
|
$query->select('*')
|
|
|
|
->from('jobs')
|
|
|
|
->where($query->expr()->gt('id', $query->createNamedParameter($lastId, \PDO::PARAM_INT)))
|
|
|
|
->orderBy('id', 'ASC')
|
|
|
|
->setMaxResults(1);
|
|
|
|
$result = $query->execute();
|
|
|
|
$row = $result->fetch();
|
|
|
|
$result->closeCursor();
|
|
|
|
|
|
|
|
if ($row) {
|
2015-08-19 15:16:05 +03:00
|
|
|
$jobId = $row['id'];
|
|
|
|
$job = $this->buildJob($row);
|
2013-04-21 01:27:46 +04:00
|
|
|
} else {
|
|
|
|
//begin at the start of the queue
|
2015-12-18 11:47:54 +03:00
|
|
|
$query = $this->connection->getQueryBuilder();
|
|
|
|
$query->select('*')
|
|
|
|
->from('jobs')
|
|
|
|
->orderBy('id', 'ASC')
|
|
|
|
->setMaxResults(1);
|
|
|
|
$result = $query->execute();
|
|
|
|
$row = $result->fetch();
|
|
|
|
$result->closeCursor();
|
|
|
|
|
|
|
|
if ($row) {
|
2015-08-19 15:16:05 +03:00
|
|
|
$jobId = $row['id'];
|
|
|
|
$job = $this->buildJob($row);
|
2013-04-21 01:27:46 +04:00
|
|
|
} else {
|
|
|
|
return null; //empty job list
|
|
|
|
}
|
|
|
|
}
|
2015-12-18 11:47:54 +03:00
|
|
|
|
2015-08-19 15:16:05 +03:00
|
|
|
if (is_null($job)) {
|
|
|
|
$this->removeById($jobId);
|
|
|
|
return $this->getNext();
|
|
|
|
} else {
|
|
|
|
return $job;
|
|
|
|
}
|
2013-04-21 01:27:46 +04:00
|
|
|
}
|
|
|
|
|
2013-04-24 16:38:41 +04:00
|
|
|
/**
|
|
|
|
* @param int $id
|
2015-12-18 12:04:30 +03:00
|
|
|
* @return IJob|null
|
2013-04-24 16:38:41 +04:00
|
|
|
*/
|
|
|
|
public function getById($id) {
|
2015-12-18 11:47:54 +03:00
|
|
|
$query = $this->connection->getQueryBuilder();
|
|
|
|
$query->select('*')
|
|
|
|
->from('jobs')
|
|
|
|
->where($query->expr()->eq('id', $query->createNamedParameter($id, \PDO::PARAM_INT)));
|
|
|
|
$result = $query->execute();
|
|
|
|
$row = $result->fetch();
|
|
|
|
$result->closeCursor();
|
|
|
|
|
|
|
|
if ($row) {
|
2013-04-24 16:38:41 +04:00
|
|
|
return $this->buildJob($row);
|
|
|
|
} else {
|
|
|
|
return null;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2013-04-21 01:27:46 +04:00
|
|
|
/**
|
|
|
|
* get the job object from a row in the db
|
|
|
|
*
|
|
|
|
* @param array $row
|
2015-12-18 12:04:30 +03:00
|
|
|
* @return IJob|null
|
2013-04-21 01:27:46 +04:00
|
|
|
*/
|
|
|
|
private function buildJob($row) {
|
2015-09-05 18:50:02 +03:00
|
|
|
try {
|
2015-12-18 13:44:32 +03:00
|
|
|
try {
|
|
|
|
// Try to load the job as a service
|
|
|
|
/** @var Job $job */
|
|
|
|
$job = \OC::$server->query($row['class']);
|
|
|
|
} catch (QueryException $e) {
|
|
|
|
if (class_exists($row['class'])) {
|
|
|
|
$class = $row['class'];
|
|
|
|
$job = new $class();
|
|
|
|
} else {
|
|
|
|
// job from disabled app or old version of an app, no need to do anything
|
|
|
|
return null;
|
|
|
|
}
|
2015-09-05 18:50:02 +03:00
|
|
|
}
|
2015-12-18 13:44:32 +03:00
|
|
|
|
2015-09-05 18:50:02 +03:00
|
|
|
$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
|
2015-12-18 13:44:32 +03:00
|
|
|
return null;
|
2014-06-27 00:39:40 +04:00
|
|
|
}
|
2013-04-21 01:27:46 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* set the job that was last ran
|
|
|
|
*
|
2015-12-18 12:04:30 +03:00
|
|
|
* @param IJob $job
|
2013-04-21 01:27:46 +04:00
|
|
|
*/
|
|
|
|
public function setLastJob($job) {
|
2014-02-11 17:00:24 +04:00
|
|
|
$this->config->setAppValue('backgroundjob', 'lastjob', $job->getId());
|
2013-04-21 01:27:46 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* get the id of the last ran job
|
|
|
|
*
|
2015-12-18 12:04:30 +03:00
|
|
|
* @return int
|
2013-04-21 01:27:46 +04:00
|
|
|
*/
|
|
|
|
public function getLastJob() {
|
2015-12-18 12:04:30 +03:00
|
|
|
return (int) $this->config->getAppValue('backgroundjob', 'lastjob', 0);
|
2013-04-21 01:27:46 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* set the lastRun of $job to now
|
|
|
|
*
|
2015-12-18 12:04:30 +03:00
|
|
|
* @param IJob $job
|
2013-04-21 01:27:46 +04:00
|
|
|
*/
|
|
|
|
public function setLastRun($job) {
|
2015-12-18 11:47:54 +03:00
|
|
|
$query = $this->connection->getQueryBuilder();
|
|
|
|
$query->update('jobs')
|
|
|
|
->set('last_run', $query->createNamedParameter(time(), \PDO::PARAM_INT))
|
|
|
|
->where($query->expr()->eq('id', $query->createNamedParameter($job->getId(), \PDO::PARAM_INT)));
|
|
|
|
$query->execute();
|
2013-04-21 01:27:46 +04:00
|
|
|
}
|
|
|
|
}
|