1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
|
<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2018, Roeland Jago Douma <roeland@famdouma.nl>
*
* @author Christoph Wurst <christoph@winzerhof-wurst.at>
* @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;
use Psr\Log\LoggerInterface;
/**
* 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, IParallelAwareJob {
protected int $id = 0;
protected int $lastRun = 0;
protected $argument;
protected ITimeFactory $time;
protected bool $allowParallelRuns = true;
/**
* @since 15.0.0
*/
public function __construct(ITimeFactory $time) {
$this->time = $time;
}
/**
* The function to prepare the execution of the job.
*
* @return void
*
* @since 15.0.0
* @deprecated since 25.0.0 Use start() instead. This method will be removed
* with the ILogger interface
*/
public function execute(IJobList $jobList, ?ILogger $logger = null) {
$this->start($jobList);
}
/**
* @inheritdoc
* @since 25.0.0
*/
public function start(IJobList $jobList): void {
$jobList->setLastRun($this);
$logger = \OCP\Server::get(LoggerInterface::class);
try {
$jobDetails = get_class($this) . ' (id: ' . $this->getId() . ', arguments: ' . json_encode($this->getArgument()) . ')';
$jobStartTime = $this->time->getTime();
$logger->debug('Starting job ' . $jobDetails, ['app' => 'cron']);
$this->run($this->argument);
$timeTaken = $this->time->getTime() - $jobStartTime;
$logger->debug('Finished job ' . $jobDetails . ' in ' . $timeTaken . ' seconds', ['app' => 'cron']);
$jobList->setExecutionTime($this, $timeTaken);
} catch (\Throwable $e) {
if ($logger) {
$logger->error('Error while running background job ' . $jobDetails, [
'app' => 'core',
'exception' => $e,
]);
}
}
}
/**
* @since 15.0.0
*/
final public function setId(int $id) {
$this->id = $id;
}
/**
* @since 15.0.0
*/
final public function setLastRun(int $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;
}
/**
* Set this to false to prevent two Jobs from this class from running in parallel
*
* @param bool $allow
* @return void
* @since 27.0.0
*/
public function setAllowParallelRuns(bool $allow): void {
$this->allowParallelRuns = $allow;
}
/**
* @return bool
* @since 27.0.0
*/
public function getAllowParallelRuns(): bool {
return $this->allowParallelRuns;
}
/**
* The actual function that is called to run the job
*
* @param $argument
* @return void
*
* @since 15.0.0
*/
abstract protected function run($argument);
}
|
