Merge pull request #43387 from nextcloud/fix/migrate-away-from-ilogger-in-jobs
Côme Chilliet
10 months ago
committed by
Louis Chemineau
parent
f6ed1effbf
commit
303e2febc7
@ -1,98 +0,0 @@ |
||||
<?php |
||||
/** |
||||
* @copyright Copyright (c) 2016, ownCloud, Inc. |
||||
* |
||||
* @author Daniel Kesselberg <mail@danielkesselberg.de> |
||||
* @author Morris Jobke <hey@morrisjobke.de> |
||||
* @author Noveen Sachdeva <noveen.sachdeva@research.iiit.ac.in> |
||||
* @author Robin Appelman <robin@icewind.nl> |
||||
* @author Thomas Müller <thomas.mueller@tmit.eu> |
||||
* |
||||
* @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/> |
||||
* |
||||
*/ |
||||
namespace OC\BackgroundJob; |
||||
|
||||
use OCP\BackgroundJob\IJob; |
||||
use OCP\BackgroundJob\IJobList; |
||||
use OCP\ILogger; |
||||
|
||||
/** |
||||
* @deprecated internal class, use \OCP\BackgroundJob\Job |
||||
*/ |
||||
abstract class Job implements IJob { |
||||
/** @var int */ |
||||
protected $id; |
||||
|
||||
/** @var int */ |
||||
protected $lastRun; |
||||
|
||||
/** @var mixed */ |
||||
protected $argument; |
||||
|
||||
public function execute(IJobList $jobList, ILogger $logger = null) { |
||||
$jobList->setLastRun($this); |
||||
if ($logger === null) { |
||||
$logger = \OC::$server->getLogger(); |
||||
} |
||||
|
||||
try { |
||||
$jobStartTime = time(); |
||||
$logger->debug('Run ' . get_class($this) . ' job with ID ' . $this->getId(), ['app' => 'cron']); |
||||
$this->run($this->argument); |
||||
$timeTaken = time() - $jobStartTime; |
||||
|
||||
$logger->debug('Finished ' . get_class($this) . ' job with ID ' . $this->getId() . ' in ' . $timeTaken . ' seconds', ['app' => 'cron']); |
||||
$jobList->setExecutionTime($this, $timeTaken); |
||||
} catch (\Throwable $e) { |
||||
if ($logger) { |
||||
$logger->logException($e, [ |
||||
'app' => 'core', |
||||
'message' => 'Error while running background job (class: ' . get_class($this) . ', arguments: ' . print_r($this->argument, true) . ')' |
||||
]); |
||||
} |
||||
} |
||||
} |
||||
|
||||
public function start(IJobList $jobList): void { |
||||
$this->execute($jobList); |
||||
} |
||||
|
||||
abstract protected function run($argument); |
||||
|
||||
public function setId(int $id) { |
||||
$this->id = $id; |
||||
} |
||||
|
||||
public function setLastRun(int $lastRun) { |
||||
$this->lastRun = $lastRun; |
||||
} |
||||
|
||||
public function setArgument($argument) { |
||||
$this->argument = $argument; |
||||
} |
||||
|
||||
public function getId() { |
||||
return $this->id; |
||||
} |
||||
|
||||
public function getLastRun() { |
||||
return $this->lastRun; |
||||
} |
||||
|
||||
public function getArgument() { |
||||
return $this->argument; |
||||
} |
||||
} |
||||
@ -1,49 +0,0 @@ |
||||
<?php |
||||
/** |
||||
* @copyright Copyright (c) 2016, ownCloud, Inc. |
||||
* |
||||
* @author Christoph Wurst <christoph@winzerhof-wurst.at> |
||||
* @author Lukas Reschke <lukas@statuscode.ch> |
||||
* @author Morris Jobke <hey@morrisjobke.de> |
||||
* @author Robin Appelman <robin@icewind.nl> |
||||
* |
||||
* @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/> |
||||
* |
||||
*/ |
||||
namespace OC\BackgroundJob; |
||||
|
||||
use OCP\ILogger; |
||||
|
||||
/** |
||||
* Class QueuedJob |
||||
* |
||||
* create a background job that is to be executed once |
||||
* |
||||
* @package OC\BackgroundJob |
||||
* |
||||
* @deprecated internal class, use \OCP\BackgroundJob\QueuedJob |
||||
*/ |
||||
abstract class QueuedJob extends Job { |
||||
/** |
||||
* run the job, then remove it from the joblist |
||||
* |
||||
* @param JobList $jobList |
||||
* @param ILogger|null $logger |
||||
*/ |
||||
public function execute($jobList, ILogger $logger = null) { |
||||
$jobList->remove($this, $this->argument); |
||||
parent::execute($jobList, $logger); |
||||
} |
||||
} |
||||
@ -1,63 +0,0 @@ |
||||
<?php |
||||
/** |
||||
* @copyright Copyright (c) 2016, ownCloud, Inc. |
||||
* |
||||
* @author Christoph Wurst <christoph@winzerhof-wurst.at> |
||||
* @author Daniel Kesselberg <mail@danielkesselberg.de> |
||||
* @author Lukas Reschke <lukas@statuscode.ch> |
||||
* @author Morris Jobke <hey@morrisjobke.de> |
||||
* @author Robin Appelman <robin@icewind.nl> |
||||
* |
||||
* @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/> |
||||
* |
||||
*/ |
||||
namespace OC\BackgroundJob; |
||||
|
||||
use OCP\BackgroundJob\IJobList; |
||||
use OCP\ILogger; |
||||
|
||||
/** |
||||
* Class QueuedJob |
||||
* |
||||
* create a background job that is to be executed at an interval |
||||
* |
||||
* @package OC\BackgroundJob |
||||
* |
||||
* @deprecated internal class, use \OCP\BackgroundJob\TimedJob |
||||
*/ |
||||
abstract class TimedJob extends Job { |
||||
protected $interval = 0; |
||||
|
||||
/** |
||||
* set the interval for the job |
||||
* |
||||
* @param int $interval |
||||
*/ |
||||
public function setInterval($interval) { |
||||
$this->interval = $interval; |
||||
} |
||||
|
||||
/** |
||||
* run the job if |
||||
* |
||||
* @param IJobList $jobList |
||||
* @param ILogger|null $logger |
||||
*/ |
||||
public function execute($jobList, ILogger $logger = null) { |
||||
if ((time() - $this->lastRun) > $this->interval) { |
||||
parent::execute($jobList, $logger); |
||||
} |
||||
} |
||||
} |
||||
Loading…
Reference in new issue