2013-04-20 21:27:46 +00:00
|
|
|
<?php
|
|
|
|
/**
|
2015-03-26 10:44:34 +00:00
|
|
|
* @author Morris Jobke <hey@morrisjobke.de>
|
|
|
|
* @author Robin Appelman <icewind@owncloud.com>
|
|
|
|
* @author Thomas Müller <thomas.mueller@tmit.eu>
|
|
|
|
*
|
|
|
|
* @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-11 13:00:24 +00:00
|
|
|
use OCP\BackgroundJob\IJob;
|
2015-04-30 09:52:30 +00:00
|
|
|
use OCP\ILogger;
|
2014-02-11 13:00:24 +00:00
|
|
|
|
|
|
|
abstract class Job implements IJob {
|
2013-12-02 12:41:47 +00:00
|
|
|
/**
|
|
|
|
* @var int $id
|
|
|
|
*/
|
2013-04-20 21:27:46 +00:00
|
|
|
protected $id;
|
2013-12-02 12:41:47 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @var int $lastRun
|
|
|
|
*/
|
2013-04-20 21:27:46 +00:00
|
|
|
protected $lastRun;
|
2013-12-02 12:41:47 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @var mixed $argument
|
|
|
|
*/
|
2013-04-20 21:27:46 +00:00
|
|
|
protected $argument;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param JobList $jobList
|
2015-04-30 09:52:30 +00:00
|
|
|
* @param ILogger $logger
|
2013-04-20 21:27:46 +00:00
|
|
|
*/
|
2015-04-30 09:52:30 +00:00
|
|
|
public function execute($jobList, ILogger $logger = null) {
|
2013-04-20 21:27:46 +00:00
|
|
|
$jobList->setLastRun($this);
|
2013-12-02 12:41:47 +00:00
|
|
|
try {
|
|
|
|
$this->run($this->argument);
|
|
|
|
} catch (\Exception $e) {
|
|
|
|
if ($logger) {
|
|
|
|
$logger->error('Error while running background job: ' . $e->getMessage());
|
|
|
|
}
|
2013-12-02 12:43:26 +00:00
|
|
|
$jobList->remove($this, $this->argument);
|
2013-12-02 12:41:47 +00:00
|
|
|
}
|
2013-04-20 21:27:46 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
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() {
|
2013-04-23 21:46:56 +00:00
|
|
|
return $this->lastRun;
|
2013-04-20 21:27:46 +00:00
|
|
|
}
|
2013-04-24 12:38:41 +00:00
|
|
|
|
|
|
|
public function getArgument() {
|
|
|
|
return $this->argument;
|
|
|
|
}
|
2013-04-20 21:27:46 +00:00
|
|
|
}
|