nextcloud/lib/private/BackgroundJob/JobList.php

385 lines
11 KiB
PHP
Raw Normal View History

2013-04-21 01:27:46 +04:00
<?php
/**
2016-07-21 18:07:57 +03:00
* @copyright Copyright (c) 2016, ownCloud, Inc.
*
* @author Joas Schilling <coding@schilljs.com>
* @author Jörn Friedrich Dreyer <jfd@butonic.de>
* @author Lukas Reschke <lukas@statuscode.ch>
2015-03-26 13:44:34 +03:00
* @author Morris Jobke <hey@morrisjobke.de>
* @author Noveen Sachdeva <noveen.sachdeva@research.iiit.ac.in>
2016-07-21 19:13:36 +03:00
* @author Robin Appelman <robin@icewind.nl>
2016-01-12 17:02:16 +03:00
* @author Robin McCorkell <robin@mccorkell.me.uk>
2015-03-26 13:44:34 +03:00
*
* @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
*/
2013-04-21 01:27:46 +04:00
namespace OC\BackgroundJob;
use OCP\AppFramework\QueryException;
use OCP\AppFramework\Utility\ITimeFactory;
use OCP\BackgroundJob\IJob;
2014-02-12 16:32:16 +04:00
use OCP\BackgroundJob\IJobList;
use OCP\AutoloadNotAllowedException;
use OCP\DB\QueryBuilder\IQueryBuilder;
use OCP\IConfig;
use OCP\IDBConnection;
2014-02-12 16:32:16 +04:00
class JobList implements IJobList {
/** @var IDBConnection */
protected $connection;
/**@var IConfig */
protected $config;
/**@var ITimeFactory */
protected $timeFactory;
/** @var int - 12 hours * 3600 seconds*/
private $jobTimeOut = 43200;
/**
* @param IDBConnection $connection
* @param IConfig $config
* @param ITimeFactory $timeFactory
*/
public function __construct(IDBConnection $connection, IConfig $config, ITimeFactory $timeFactory) {
$this->connection = $connection;
$this->config = $config;
$this->timeFactory = $timeFactory;
}
2013-04-21 01:27:46 +04: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)) {
if ($job instanceof IJob) {
2013-04-21 01:27:46 +04:00
$class = get_class($job);
} else {
$class = $job;
}
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)');
}
$query = $this->connection->getQueryBuilder();
$query->insert('jobs')
->values([
'class' => $query->createNamedParameter($class),
'argument' => $query->createNamedParameter($argument),
'last_run' => $query->createNamedParameter(0, IQueryBuilder::PARAM_INT),
'last_checked' => $query->createNamedParameter($this->timeFactory->getTime(), IQueryBuilder::PARAM_INT),
]);
$query->execute();
2013-04-21 01:27:46 +04:00
}
}
/**
* @param IJob|string $job
2013-04-21 01:27:46 +04:00
* @param mixed $argument
*/
public function remove($job, $argument = null) {
if ($job instanceof IJob) {
2013-04-21 01:27:46 +04:00
$class = get_class($job);
} else {
$class = $job;
}
$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);
$query->andWhere($query->expr()->eq('argument', $query->createNamedParameter($argument)));
2013-04-21 01:27:46 +04:00
}
$query->execute();
2013-04-21 01:27:46 +04:00
}
/**
* @param int $id
*/
protected function removeById($id) {
$query = $this->connection->getQueryBuilder();
$query->delete('jobs')
->where($query->expr()->eq('id', $query->createNamedParameter($id, IQueryBuilder::PARAM_INT)));
$query->execute();
}
2013-04-21 01:27:46 +04:00
/**
* check if a job is in the list
*
* @param IJob|string $job
2013-04-21 01:27:46 +04:00
* @param mixed $argument
* @return bool
*/
public function has($job, $argument) {
if ($job instanceof IJob) {
2013-04-21 01:27:46 +04:00
$class = get_class($job);
} else {
$class = $job;
}
$argument = json_encode($argument);
$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
*
* @return IJob[]
* @deprecated 9.0.0 - This method is dangerous since it can cause load and
* memory problems when creating too many instances.
2013-04-21 01:27:46 +04:00
*/
public function getAll() {
$query = $this->connection->getQueryBuilder();
$query->select('*')
->from('jobs');
$result = $query->execute();
$jobs = [];
while ($row = $result->fetch()) {
$job = $this->buildJob($row);
if ($job) {
$jobs[] = $job;
}
2013-04-21 01:27:46 +04:00
}
$result->closeCursor();
2013-04-21 01:27:46 +04:00
return $jobs;
}
/**
* get the next job in the list
*
* @return IJob|null
* @suppress SqlInjectionChecker
2013-04-21 01:27:46 +04:00
*/
public function getNext() {
$query = $this->connection->getQueryBuilder();
$query->select('*')
->from('jobs')
->where($query->expr()->lte('reserved_at', $query->createNamedParameter($this->timeFactory->getTime() - $this->jobTimeOut, IQueryBuilder::PARAM_INT)))
->andWhere($query->expr()->lte('last_checked', $query->createNamedParameter($this->timeFactory->getTime(), IQueryBuilder::PARAM_INT)))
->orderBy('last_checked', 'ASC')
->setMaxResults(1);
$update = $this->connection->getQueryBuilder();
$update->update('jobs')
->set('reserved_at', $update->createNamedParameter($this->timeFactory->getTime()))
->set('last_checked', $update->createNamedParameter($this->timeFactory->getTime()))
->where($update->expr()->eq('id', $update->createParameter('jobid')))
->andWhere($update->expr()->eq('reserved_at', $update->createParameter('reserved_at')))
->andWhere($update->expr()->eq('last_checked', $update->createParameter('last_checked')));
$result = $query->execute();
$row = $result->fetch();
$result->closeCursor();
if ($row) {
$update->setParameter('jobid', $row['id']);
$update->setParameter('reserved_at', $row['reserved_at']);
$update->setParameter('last_checked', $row['last_checked']);
$count = $update->execute();
if ($count === 0) {
// Background job already executed elsewhere, try again.
return $this->getNext();
}
$job = $this->buildJob($row);
if ($job === null) {
// set the last_checked to 12h in the future to not check failing jobs all over again
$reset = $this->connection->getQueryBuilder();
$reset->update('jobs')
->set('reserved_at', $reset->expr()->literal(0, IQueryBuilder::PARAM_INT))
->set('last_checked', $reset->createNamedParameter($this->timeFactory->getTime() + 12 * 3600, IQueryBuilder::PARAM_INT))
->where($reset->expr()->eq('id', $reset->createNamedParameter($row['id'], IQueryBuilder::PARAM_INT)));
$reset->execute();
// Background job from disabled app, try again.
return $this->getNext();
2013-04-21 01:27:46 +04:00
}
return $job;
} else {
return null;
}
2013-04-21 01:27:46 +04:00
}
/**
* @param int $id
* @return IJob|null
*/
public function getById($id) {
$query = $this->connection->getQueryBuilder();
$query->select('*')
->from('jobs')
->where($query->expr()->eq('id', $query->createNamedParameter($id, IQueryBuilder::PARAM_INT)));
$result = $query->execute();
$row = $result->fetch();
$result->closeCursor();
if ($row) {
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 IJob|null
2013-04-21 01:27:46 +04:00
*/
private function buildJob($row) {
try {
try {
// Try to load the job as a service
/** @var IJob $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;
}
}
$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
return null;
}
2013-04-21 01:27:46 +04:00
}
/**
* set the job that was last ran
*
* @param IJob $job
2013-04-21 01:27:46 +04:00
*/
public function setLastJob(IJob $job) {
$this->unlockJob($job);
$this->config->setAppValue('backgroundjob', 'lastjob', $job->getId());
2013-04-21 01:27:46 +04:00
}
/**
* Remove the reservation for a job
*
* @param IJob $job
* @suppress SqlInjectionChecker
*/
public function unlockJob(IJob $job) {
$query = $this->connection->getQueryBuilder();
$query->update('jobs')
->set('reserved_at', $query->expr()->literal(0, IQueryBuilder::PARAM_INT))
->where($query->expr()->eq('id', $query->createNamedParameter($job->getId(), IQueryBuilder::PARAM_INT)));
$query->execute();
}
2013-04-21 01:27:46 +04:00
/**
* get the id of the last ran job
*
* @return int
* @deprecated 9.1.0 - The functionality behind the value is deprecated, it
* only tells you which job finished last, but since we now allow multiple
* executors to run in parallel, it's not used to calculate the next job.
2013-04-21 01:27:46 +04:00
*/
public function getLastJob() {
return (int) $this->config->getAppValue('backgroundjob', 'lastjob', 0);
2013-04-21 01:27:46 +04:00
}
/**
* set the lastRun of $job to now
*
* @param IJob $job
2013-04-21 01:27:46 +04:00
*/
public function setLastRun(IJob $job) {
$query = $this->connection->getQueryBuilder();
$query->update('jobs')
->set('last_run', $query->createNamedParameter(time(), IQueryBuilder::PARAM_INT))
->where($query->expr()->eq('id', $query->createNamedParameter($job->getId(), IQueryBuilder::PARAM_INT)));
$query->execute();
2013-04-21 01:27:46 +04:00
}
/**
* @param IJob $job
* @param $timeTaken
*/
public function setExecutionTime(IJob $job, $timeTaken) {
$query = $this->connection->getQueryBuilder();
$query->update('jobs')
->set('execution_duration', $query->createNamedParameter($timeTaken, IQueryBuilder::PARAM_INT))
->where($query->expr()->eq('id', $query->createNamedParameter($job->getId(), IQueryBuilder::PARAM_INT)));
$query->execute();
}
/**
* checks if a job is still running (reserved_at time is smaller than 12 hours ago)
*
* Background information:
*
* The 12 hours is the same timeout that is also used to re-schedule an non-terminated
* job (see getNext()). The idea here is to give a job enough time to run very
* long but still be able to recognize that it maybe crashed and re-schedule it
* after the timeout. It's more likely to be crashed at that time than it ran
* that long.
*
* In theory it could lead to an nearly endless loop (as in - at most 12 hours).
* The cron command will not start new jobs when maintenance mode is active and
* this method is only executed in maintenance mode (see where it is called in
* the upgrader class. So this means in the worst case we wait 12 hours when a
* job has crashed. On the other hand: then the instance should be fixed anyways.
*
* @return bool
*/
public function isAnyJobRunning(): bool {
$query = $this->connection->getQueryBuilder();
$query->select('*')
->from('jobs')
->where($query->expr()->gt('reserved_at', $query->createNamedParameter($this->timeFactory->getTime() - $this->jobTimeOut, IQueryBuilder::PARAM_INT)))
->setMaxResults(1);
$result = $query->execute();
$row = $result->fetch();
$result->closeCursor();
if ($row) {
return true;
}
return false;
}
2013-04-21 01:27:46 +04:00
}