diff options
Diffstat (limited to 'lib/public/BackgroundJob')
| -rw-r--r-- | lib/public/BackgroundJob/IJob.php | 4 | ||||
| -rw-r--r-- | lib/public/BackgroundJob/Job.php | 2 | ||||
| -rw-r--r-- | lib/public/BackgroundJob/QueuedJob.php | 2 | ||||
| -rw-r--r-- | lib/public/BackgroundJob/TimedJob.php | 20 |
4 files changed, 21 insertions, 7 deletions
diff --git a/lib/public/BackgroundJob/IJob.php b/lib/public/BackgroundJob/IJob.php index 6988e1e682a..28a7df1c377 100644 --- a/lib/public/BackgroundJob/IJob.php +++ b/lib/public/BackgroundJob/IJob.php @@ -10,7 +10,7 @@ namespace OCP\BackgroundJob; use OCP\ILogger; /** - * This interface represend a backgroud job run with cron + * This interface represents a background job run with cron * * To implement a background job, you must extend either \OCP\BackgroundJob\Job, * \OCP\BackgroundJob\TimedJob or \OCP\BackgroundJob\QueuedJob @@ -33,7 +33,7 @@ interface IJob { * @param IJobList $jobList The job list that manages the state of this job * @param ILogger|null $logger * @since 7.0.0 - * @deprecated since 25.0.0 Use start() instead. This method will be removed + * @deprecated 25.0.0 Use start() instead. This method will be removed * with the ILogger interface */ public function execute(IJobList $jobList, ?ILogger $logger = null); diff --git a/lib/public/BackgroundJob/Job.php b/lib/public/BackgroundJob/Job.php index 3b25db311a4..2483387a9c9 100644 --- a/lib/public/BackgroundJob/Job.php +++ b/lib/public/BackgroundJob/Job.php @@ -39,7 +39,7 @@ abstract class Job implements IJob, IParallelAwareJob { * @return void * * @since 15.0.0 - * @deprecated since 25.0.0 Use start() instead. This method will be removed + * @deprecated 25.0.0 Use start() instead. This method will be removed * with the ILogger interface */ public function execute(IJobList $jobList, ?ILogger $logger = null) { diff --git a/lib/public/BackgroundJob/QueuedJob.php b/lib/public/BackgroundJob/QueuedJob.php index caacff42b1a..75e27d1d60f 100644 --- a/lib/public/BackgroundJob/QueuedJob.php +++ b/lib/public/BackgroundJob/QueuedJob.php @@ -22,7 +22,7 @@ abstract class QueuedJob extends Job { * @param ILogger|null $logger * * @since 15.0.0 - * @deprecated since 25.0.0 Use start() instead. This method will be removed + * @deprecated 25.0.0 Use start() instead. This method will be removed * with the ILogger interface */ final public function execute($jobList, ?ILogger $logger = null) { diff --git a/lib/public/BackgroundJob/TimedJob.php b/lib/public/BackgroundJob/TimedJob.php index 6665d194789..486c03c5fda 100644 --- a/lib/public/BackgroundJob/TimedJob.php +++ b/lib/public/BackgroundJob/TimedJob.php @@ -8,6 +8,8 @@ declare(strict_types=1); namespace OCP\BackgroundJob; use OCP\ILogger; +use OCP\Server; +use Psr\Log\LoggerInterface; /** * Simple base class to extend to run periodic background jobs. @@ -31,6 +33,15 @@ abstract class TimedJob extends Job { } /** + * Get the interval [seconds] for the job + * + * @since 32.0.0 + */ + public function getInterval(): int { + return $this->interval; + } + + /** * Whether the background job is time sensitive and needs to run soon after * the scheduled interval, of if it is okay to be delayed until a later time. * @@ -52,8 +63,8 @@ abstract class TimedJob extends Job { * @since 24.0.0 */ public function setTimeSensitivity(int $sensitivity): void { - if ($sensitivity !== IJob::TIME_SENSITIVE && - $sensitivity !== IJob::TIME_INSENSITIVE) { + if ($sensitivity !== self::TIME_SENSITIVE + && $sensitivity !== self::TIME_INSENSITIVE) { throw new \InvalidArgumentException('Invalid sensitivity'); } @@ -67,7 +78,7 @@ abstract class TimedJob extends Job { * @param ILogger|null $logger * * @since 15.0.0 - * @deprecated since 25.0.0 Use start() instead + * @deprecated 25.0.0 Use start() instead */ final public function execute(IJobList $jobList, ?ILogger $logger = null) { $this->start($jobList); @@ -80,6 +91,9 @@ abstract class TimedJob extends Job { */ final public function start(IJobList $jobList): void { if (($this->time->getTime() - $this->lastRun) > $this->interval) { + if ($this->interval >= 12 * 60 * 60 && $this->isTimeSensitive()) { + Server::get(LoggerInterface::class)->debug('TimedJob ' . get_class($this) . ' has a configured interval of ' . $this->interval . ' seconds, but is also marked as time sensitive. Please consider marking it as time insensitive to allow more sensitive jobs to run when needed.'); + } parent::start($jobList); } } |