nextcloud/lib/private/backgroundjob/joblist.php

200 lines
4.7 KiB
PHP
Raw Normal View History

2013-04-21 01:27:46 +04:00
<?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.
2013-04-21 01:27:46 +04:00
*/
2013-04-21 01:27:46 +04:00
namespace OC\BackgroundJob;
2014-02-12 16:32:16 +04:00
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;
}
2013-04-21 01:27:46 +04:00
/**
* @param Job|string $job
2013-04-21 01:27:46 +04: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 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)');
}
$query = $this->conn->prepare('INSERT INTO `*PREFIX*jobs`(`class`, `argument`, `last_run`) VALUES(?, ?, 0)');
2013-04-21 01:27:46 +04:00
$query->execute(array($class, $argument));
}
}
/**
* @param Job|string $job
2013-04-21 01:27:46 +04: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);
$query = $this->conn->prepare('DELETE FROM `*PREFIX*jobs` WHERE `class` = ? AND `argument` = ?');
2013-04-21 01:27:46 +04:00
$query->execute(array($class, $argument));
} else {
$query = $this->conn->prepare('DELETE FROM `*PREFIX*jobs` WHERE `class` = ?');
2013-04-21 01:27:46 +04:00
$query->execute(array($class));
}
}
/**
* check if a job is in the list
*
* @param Job|string $job
2013-04-21 01:27:46 +04: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);
$query = $this->conn->prepare('SELECT `id` FROM `*PREFIX*jobs` WHERE `class` = ? AND `argument` = ?');
$query->execute(array($class, $argument));
return (bool)$query->fetch();
2013-04-21 01:27:46 +04:00
}
/**
* get all jobs in the list
*
* @return Job[]
*/
public function getAll() {
$query = $this->conn->prepare('SELECT `id`, `class`, `last_run`, `argument` FROM `*PREFIX*jobs`');
$query->execute();
2013-04-21 01:27:46 +04:00
$jobs = array();
while ($row = $query->fetch()) {
$job = $this->buildJob($row);
if ($job) {
$jobs[] = $job;
}
2013-04-21 01:27:46 +04:00
}
return $jobs;
}
/**
* get the next job in the list
*
* @return Job
*/
public function getNext() {
$lastId = $this->getLastJob();
$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()) {
2013-04-21 01:27:46 +04:00
return $this->buildJob($row);
} else {
//begin at the start of the queue
$query = $this->conn->prepare('SELECT `id`, `class`, `last_run`, `argument` FROM `*PREFIX*jobs` ORDER BY `id` ASC', 1);
$query->execute();
if ($row = $query->fetch()) {
2013-04-21 01:27:46 +04:00
return $this->buildJob($row);
} else {
return null; //empty job list
}
}
}
/**
* @param int $id
* @return Job|null
*/
public function getById($id) {
$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;
}
}
2013-04-21 01:27:46 +04: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
*/
if ($class === 'OC_Cache_FileGlobalGC') {
$class = '\OC\Cache\FileGlobalGC';
}
2014-06-27 02:52:37 +04:00
if (!class_exists($class)) {
// job from disabled app or old version of an app, no need to do anything
return null;
}
2013-04-21 01:27:46 +04:00
$job = new $class();
$job->setId($row['id']);
$job->setLastRun($row['last_run']);
2013-11-05 13:30:18 +04:00
$job->setArgument(json_decode($row['argument'], true));
2013-04-21 01:27:46 +04:00
return $job;
}
/**
* set the job that was last ran
*
* @param Job $job
*/
public function setLastJob($job) {
$this->config->setAppValue('backgroundjob', 'lastjob', $job->getId());
2013-04-21 01:27:46 +04:00
}
/**
* get the id of the last ran job
*
* @return string
2013-04-21 01:27:46 +04:00
*/
public function getLastJob() {
2014-02-12 16:52:13 +04:00
return $this->config->getAppValue('backgroundjob', 'lastjob', 0);
2013-04-21 01:27:46 +04:00
}
/**
* set the lastRun of $job to now
*
* @param Job $job
*/
public function setLastRun($job) {
$query = $this->conn->prepare('UPDATE `*PREFIX*jobs` SET `last_run` = ? WHERE `id` = ?');
2013-04-21 01:27:46 +04:00
$query->execute(array(time(), $job->getId()));
}
}