-
-
Notifications
You must be signed in to change notification settings - Fork 4.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #11711 from nextcloud/feature/backgroundjobs_ocp
Add proper backgroundjobs to OCP
- Loading branch information
Showing
7 changed files
with
367 additions
and
57 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,143 @@ | ||
| <?php | ||
| declare(strict_types=1); | ||
| /** | ||
| * @copyright Copyright (c) 2018, Roeland Jago Douma <roeland@famdouma.nl> | ||
| * | ||
| * @author Roeland Jago Douma <roeland@famdouma.nl> | ||
| * | ||
| * @license GNU AGPL version 3 or any later version | ||
| * | ||
| * This program is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU Affero General Public License as | ||
| * published by the Free Software Foundation, either version 3 of the | ||
| * License, or (at your option) any later version. | ||
| * | ||
| * 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 | ||
| * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| * | ||
| */ | ||
|
|
||
| namespace OCP\BackgroundJob; | ||
|
|
||
| use OCP\AppFramework\Utility\ITimeFactory; | ||
| use OCP\ILogger; | ||
|
|
||
| /** | ||
| * Base class for background jobs | ||
| * | ||
| * This is here if you want to do advanced stuff in your background jobs. | ||
| * For the most common use cases have a look at QueuedJob and TimedJob | ||
| * | ||
| * @since 15.0.0 | ||
| */ | ||
| abstract class Job implements IJob { | ||
|
|
||
| /** @var int $id */ | ||
| protected $id; | ||
|
|
||
| /** @var int $lastRun */ | ||
| protected $lastRun; | ||
|
|
||
| /** @var mixed $argument */ | ||
| protected $argument; | ||
|
|
||
| /** @var ITimeFactory */ | ||
| protected $time; | ||
|
|
||
| /** | ||
| * @since 15.0.0 | ||
| */ | ||
| public function __construct(ITimeFactory $time) { | ||
| $this->time = $time; | ||
| } | ||
|
|
||
| /** | ||
| * The function to prepare the execution of the job. | ||
| * | ||
| * @param IJobList $jobList | ||
| * @param ILogger|null $logger | ||
| * | ||
| * @since 15.0.0 | ||
| */ | ||
| public function execute($jobList, ILogger $logger = null) { | ||
| $jobList->setLastRun($this); | ||
| if ($logger === null) { | ||
| $logger = \OC::$server->getLogger(); | ||
| } | ||
|
|
||
| try { | ||
| $jobStartTime = $this->time->getTime(); | ||
| $logger->debug('Run ' . get_class($this) . ' job with ID ' . $this->getId(), ['app' => 'cron']); | ||
| $this->run($this->argument); | ||
| $timeTaken = $this->time->getTime() - $jobStartTime; | ||
|
|
||
| $logger->debug('Finished ' . get_class($this) . ' job with ID ' . $this->getId() . ' in ' . $timeTaken . ' seconds', ['app' => 'cron']); | ||
| $jobList->setExecutionTime($this, $timeTaken); | ||
| } catch (\Exception $e) { | ||
| if ($logger) { | ||
| $logger->logException($e, [ | ||
| 'app' => 'core', | ||
| 'message' => 'Error while running background job (class: ' . get_class($this) . ', arguments: ' . print_r($this->argument, true) . ')' | ||
| ]); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * @since 15.0.0 | ||
| */ | ||
| final public function setId($id) { | ||
| $this->id = $id; | ||
| } | ||
|
|
||
| /** | ||
| * @since 15.0.0 | ||
| */ | ||
| final public function setLastRun($lastRun) { | ||
| $this->lastRun = $lastRun; | ||
| } | ||
|
|
||
| /** | ||
| * @since 15.0.0 | ||
| */ | ||
| public function setArgument($argument) { | ||
| $this->argument = $argument; | ||
| } | ||
|
|
||
| /** | ||
| * @since 15.0.0 | ||
| */ | ||
| final public function getId(): int { | ||
| return $this->id; | ||
| } | ||
|
|
||
| /** | ||
| * @since 15.0.0 | ||
| */ | ||
| final public function getLastRun(): int { | ||
| return $this->lastRun; | ||
| } | ||
|
|
||
| /** | ||
| * @since 15.0.0 | ||
| */ | ||
| public function getArgument() { | ||
| return $this->argument; | ||
| } | ||
|
|
||
| /** | ||
| * The actual function that is called to run the job | ||
| * | ||
| * @param $argument | ||
| * @return mixed | ||
| * | ||
| * @since 15.0.0 | ||
| */ | ||
| abstract protected function run($argument); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| <?php | ||
| declare(strict_types=1); | ||
| /** | ||
| * @copyright Copyright (c) 2018, Roeland Jago Douma <roeland@famdouma.nl> | ||
| * | ||
| * @author Roeland Jago Douma <roeland@famdouma.nl> | ||
| * | ||
| * @license GNU AGPL version 3 or any later version | ||
| * | ||
| * This program is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU Affero General Public License as | ||
| * published by the Free Software Foundation, either version 3 of the | ||
| * License, or (at your option) any later version. | ||
| * | ||
| * 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 | ||
| * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| * | ||
| */ | ||
|
|
||
| namespace OCP\BackgroundJob; | ||
|
|
||
| use OCP\ILogger; | ||
|
|
||
| /** | ||
| * Simple base class for a one time background job | ||
| * | ||
| * @since 15.0.0 | ||
| */ | ||
| abstract class QueuedJob extends Job { | ||
|
|
||
| /** | ||
| * run the job, then remove it from the joblist | ||
| * | ||
| * @param IJobList $jobList | ||
| * @param ILogger|null $logger | ||
| * | ||
| * @since 15.0.0 | ||
| */ | ||
| final public function execute($jobList, ILogger $logger = null) { | ||
| $jobList->remove($this, $this->argument); | ||
| parent::execute($jobList, $logger); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| <?php | ||
| declare(strict_types=1); | ||
| /** | ||
| * @copyright Copyright (c) 2018, Roeland Jago Douma <roeland@famdouma.nl> | ||
| * | ||
| * @author Roeland Jago Douma <roeland@famdouma.nl> | ||
| * | ||
| * @license GNU AGPL version 3 or any later version | ||
| * | ||
| * This program is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU Affero General Public License as | ||
| * published by the Free Software Foundation, either version 3 of the | ||
| * License, or (at your option) any later version. | ||
| * | ||
| * 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 | ||
| * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| * | ||
| */ | ||
|
|
||
| namespace OCP\BackgroundJob; | ||
|
|
||
| use OC\BackgroundJob\JobList; | ||
| use OCP\ILogger; | ||
|
|
||
| /** | ||
| * Simple base class to extend to run periodic background jobs. | ||
| * Call setInterval with your desired interval in seconds from the constructor. | ||
| * | ||
| * @since 15.0.0 | ||
| */ | ||
| abstract class TimedJob extends Job { | ||
| /** @var int */ | ||
| protected $interval = 0; | ||
|
|
||
| /** | ||
| * set the interval for the job | ||
| * | ||
| * @since 15.0.0 | ||
| */ | ||
| public function setInterval(int $interval) { | ||
| $this->interval = $interval; | ||
| } | ||
|
|
||
| /** | ||
| * run the job if the last run is is more than the interval ago | ||
| * | ||
| * @param JobList $jobList | ||
| * @param ILogger|null $logger | ||
| * | ||
| * @since 15.0.0 | ||
| */ | ||
| final public function execute($jobList, ILogger $logger = null) { | ||
| if (($this->time->getTime() - $this->lastRun) > $this->interval) { | ||
| parent::execute($jobList, $logger); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.