nextcloud / server

lib/public/BackgroundJob/TimedJob.php

Indentation +60 added lines, -60 removed lines

@@ -19,70 +19,70 @@
  * @since 33.0.0 removed deprecated `execute()` method
  */
 abstract class TimedJob extends Job {
-	protected int $interval = 0;
-	protected int $timeSensitivity = IJob::TIME_SENSITIVE;
+    protected int $interval = 0;
+    protected int $timeSensitivity = IJob::TIME_SENSITIVE;
 
-	/**
-	 * Set the interval for the job
-	 *
-	 * @param int $seconds the time to pass between two runs of the same job in seconds
-	 *
-	 * @since 15.0.0
-	 */
-	public function setInterval(int $seconds): void {
-		$this->interval = $seconds;
-	}
+    /**
+     * Set the interval for the job
+     *
+     * @param int $seconds the time to pass between two runs of the same job in seconds
+     *
+     * @since 15.0.0
+     */
+    public function setInterval(int $seconds): void {
+        $this->interval = $seconds;
+    }
 
-	/**
-	 * Get the interval [seconds] for the job
-	 *
-	 * @since 32.0.0
-	 */
-	public function getInterval(): int {
-		return $this->interval;
-	}
+    /**
+     * 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.
-	 *
-	 * @return bool
-	 * @since 24.0.0
-	 */
-	public function isTimeSensitive(): bool {
-		return $this->timeSensitivity === IJob::TIME_SENSITIVE;
-	}
+    /**
+     * 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.
+     *
+     * @return bool
+     * @since 24.0.0
+     */
+    public function isTimeSensitive(): bool {
+        return $this->timeSensitivity === IJob::TIME_SENSITIVE;
+    }
 
-	/**
-	 * If your background job is not time sensitive (sending instant email
-	 * notifications, etc.) it would be nice to set it to IJob::TIME_INSENSITIVE
-	 * This way the execution can be delayed during high usage times.
-	 *
-	 * @param int $sensitivity
-	 * @psalm-param IJob::TIME_* $sensitivity
-	 * @return void
-	 * @since 24.0.0
-	 */
-	public function setTimeSensitivity(int $sensitivity): void {
-		if ($sensitivity !== self::TIME_SENSITIVE
-			&& $sensitivity !== self::TIME_INSENSITIVE) {
-			throw new \InvalidArgumentException('Invalid sensitivity');
-		}
+    /**
+     * If your background job is not time sensitive (sending instant email
+     * notifications, etc.) it would be nice to set it to IJob::TIME_INSENSITIVE
+     * This way the execution can be delayed during high usage times.
+     *
+     * @param int $sensitivity
+     * @psalm-param IJob::TIME_* $sensitivity
+     * @return void
+     * @since 24.0.0
+     */
+    public function setTimeSensitivity(int $sensitivity): void {
+        if ($sensitivity !== self::TIME_SENSITIVE
+            && $sensitivity !== self::TIME_INSENSITIVE) {
+            throw new \InvalidArgumentException('Invalid sensitivity');
+        }
 
-		$this->timeSensitivity = $sensitivity;
-	}
+        $this->timeSensitivity = $sensitivity;
+    }
 
-	/**
-	 * Run the job if the last run is more than the interval ago
-	 *
-	 * @since 25.0.0
-	 */
-	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);
-		}
-	}
+    /**
+     * Run the job if the last run is more than the interval ago
+     *
+     * @since 25.0.0
+     */
+    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);
+        }
+    }
 }

lib/public/BackgroundJob/Job.php

Indentation +110 added lines, -110 removed lines

@@ -21,114 +21,114 @@
  * @since 33.0.0 removed deprecated `execute()` method
  */
 abstract class Job implements IJob, IParallelAwareJob {
-	protected int $id = 0;
-	protected int $lastRun = 0;
-	protected mixed $argument = null;
-	protected bool $allowParallelRuns = true;
-
-	/**
-	 * @since 15.0.0
-	 */
-	public function __construct(
-		protected ITimeFactory $time,
-	) {
-	}
-
-	/**
-	 * @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);
+    protected int $id = 0;
+    protected int $lastRun = 0;
+    protected mixed $argument = null;
+    protected bool $allowParallelRuns = true;
+
+    /**
+     * @since 15.0.0
+     */
+    public function __construct(
+        protected ITimeFactory $time,
+    ) {
+    }
+
+    /**
+     * @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);
 }

lib/public/BackgroundJob/QueuedJob.php

Indentation +13 added lines, -13 removed lines

@@ -16,17 +16,17 @@
  */
 abstract class QueuedJob extends Job {
 
-	/**
-	 * Run the job, then remove it from the joblist
-	 *
-	 * @since 25.0.0
-	 */
-	final public function start(IJobList $jobList): void {
-		if ($this->id) {
-			$jobList->removeById($this->id);
-		} else {
-			$jobList->remove($this, $this->argument);
-		}
-		parent::start($jobList);
-	}
+    /**
+     * Run the job, then remove it from the joblist
+     *
+     * @since 25.0.0
+     */
+    final public function start(IJobList $jobList): void {
+        if ($this->id) {
+            $jobList->removeById($this->id);
+        } else {
+            $jobList->remove($this, $this->argument);
+        }
+        parent::start($jobList);
+    }
 }

lib/public/BackgroundJob/IJob.php

Indentation +57 added lines, -57 removed lines

@@ -18,68 +18,68 @@
  * @since 33.0.0 removed deprecated `execute()` method
  */
 interface IJob {
-	/**
-	 * @since 24.0.0
-	 */
-	public const TIME_INSENSITIVE = 0;
-	/**
-	 * @since 24.0.0
-	 */
-	public const TIME_SENSITIVE = 1;
+    /**
+     * @since 24.0.0
+     */
+    public const TIME_INSENSITIVE = 0;
+    /**
+     * @since 24.0.0
+     */
+    public const TIME_SENSITIVE = 1;
 
-	/**
-	 * Start the background job with the registered argument
-	 *
-	 * This methods will take care of running the background job, of initializing
-	 * the state and cleaning up the job list after running the job.
-	 *
-	 * For common background job scenario, you will want to use TimedJob or QueuedJob
-	 * instead of overwriting this method.
-	 *
-	 * @param IJobList $jobList The job list that manages the state of this job
-	 * @since 25.0.0
-	 */
-	public function start(IJobList $jobList): void;
+    /**
+     * Start the background job with the registered argument
+     *
+     * This methods will take care of running the background job, of initializing
+     * the state and cleaning up the job list after running the job.
+     *
+     * For common background job scenario, you will want to use TimedJob or QueuedJob
+     * instead of overwriting this method.
+     *
+     * @param IJobList $jobList The job list that manages the state of this job
+     * @since 25.0.0
+     */
+    public function start(IJobList $jobList): void;
 
-	/**
-	 * @since 7.0.0
-	 */
-	public function setId(int $id);
+    /**
+     * @since 7.0.0
+     */
+    public function setId(int $id);
 
-	/**
-	 * @since 7.0.0
-	 */
-	public function setLastRun(int $lastRun);
+    /**
+     * @since 7.0.0
+     */
+    public function setLastRun(int $lastRun);
 
-	/**
-	 * @param mixed $argument
-	 * @since 7.0.0
-	 */
-	public function setArgument($argument);
+    /**
+     * @param mixed $argument
+     * @since 7.0.0
+     */
+    public function setArgument($argument);
 
-	/**
-	 * Get the id of the background job
-	 * This id is determined by the job list when a job is added to the list
-	 *
-	 * @return int
-	 * @since 7.0.0
-	 */
-	public function getId();
+    /**
+     * Get the id of the background job
+     * This id is determined by the job list when a job is added to the list
+     *
+     * @return int
+     * @since 7.0.0
+     */
+    public function getId();
 
-	/**
-	 * Get the last time this job was run as unix timestamp
-	 *
-	 * @return int
-	 * @since 7.0.0
-	 */
-	public function getLastRun();
+    /**
+     * Get the last time this job was run as unix timestamp
+     *
+     * @return int
+     * @since 7.0.0
+     */
+    public function getLastRun();
 
-	/**
-	 * Get the argument associated with the background job
-	 * This is the argument that will be passed to the background job
-	 *
-	 * @return mixed
-	 * @since 7.0.0
-	 */
-	public function getArgument();
+    /**
+     * Get the argument associated with the background job
+     * This is the argument that will be passed to the background job
+     *
+     * @return mixed
+     * @since 7.0.0
+     */
+    public function getArgument();
 }

cron.php

Indentation +219 added lines, -219 removed lines

@@ -26,10 +26,10 @@ 
 use Psr\Log\LoggerInterface;
 
 try {
-	require_once __DIR__ . '/lib/base.php';
+    require_once __DIR__ . '/lib/base.php';
 
-	if (isset($argv[1]) && ($argv[1] === '-h' || $argv[1] === '--help')) {
-		echo 'Description:
+    if (isset($argv[1]) && ($argv[1] === '-h' || $argv[1] === '--help')) {
+        echo 'Description:
   Run the background job routine
 
 Usage:
@@ -42,222 +42,222 @@ 
 Options:
   -h, --help                 Display this help message
   -v, --verbose              Output more information' . PHP_EOL;
-		exit(0);
-	}
-
-	if (Util::needUpgrade()) {
-		Server::get(LoggerInterface::class)->debug('Update required, skipping cron', ['app' => 'cron']);
-		exit;
-	}
-
-	$config = Server::get(IConfig::class);
-
-	if ($config->getSystemValueBool('maintenance', false)) {
-		Server::get(LoggerInterface::class)->debug('We are in maintenance mode, skipping cron', ['app' => 'cron']);
-		exit;
-	}
-
-	// Don't do anything if Nextcloud has not been installed
-	if (!$config->getSystemValueBool('installed', false)) {
-		exit(0);
-	}
-
-	// load all apps to get all api routes properly setup
-	Server::get(IAppManager::class)->loadApps();
-	Server::get(ISession::class)->close();
-
-	$verbose = isset($argv[1]) && ($argv[1] === '-v' || $argv[1] === '--verbose');
-
-	// initialize a dummy memory session
-	$session = new Memory();
-	$cryptoWrapper = Server::get(CryptoWrapper::class);
-	$session = $cryptoWrapper->wrapSession($session);
-	\OC::$server->setSession($session);
-
-	$logger = Server::get(LoggerInterface::class);
-	$appConfig = Server::get(IAppConfig::class);
-	$tempManager = Server::get(ITempManager::class);
-
-	$tempManager->cleanOld();
-
-	// Exit if background jobs are disabled!
-	$appMode = $appConfig->getValueString('core', 'backgroundjobs_mode', 'ajax');
-	if ($appMode === 'none') {
-		if (OC::$CLI) {
-			echo 'Background Jobs are disabled!' . PHP_EOL;
-		} else {
-			OC_JSON::error(['data' => ['message' => 'Background jobs disabled!']]);
-		}
-		exit(1);
-	}
-
-	if (OC::$CLI) {
-		// set to run indefinitely if needed
-		if (strpos(@ini_get('disable_functions'), 'set_time_limit') === false) {
-			@set_time_limit(0);
-		}
-
-		// the cron job must be executed with the right user
-		if (!function_exists('posix_getuid')) {
-			echo 'The posix extensions are required - see https://www.php.net/manual/en/book.posix.php' . PHP_EOL;
-			exit(1);
-		}
-
-		$user = posix_getuid();
-		$configUser = fileowner(OC::$configDir . 'config.php');
-		if ($user !== $configUser) {
-			echo 'Console has to be executed with the user that owns the file config/config.php' . PHP_EOL;
-			echo 'Current user id: ' . $user . PHP_EOL;
-			echo 'Owner id of config.php: ' . $configUser . PHP_EOL;
-			exit(1);
-		}
-
-
-		// We call Nextcloud from the CLI (aka cron)
-		if ($appMode !== 'cron') {
-			$appConfig->setValueString('core', 'backgroundjobs_mode', 'cron');
-		}
-
-		// a specific job class list can optionally be given as argument
-		$jobClasses = array_slice($argv, $verbose ? 2 : 1);
-		$jobClasses = empty($jobClasses) ? null : $jobClasses;
-
-		// Low-load hours
-		$onlyTimeSensitive = false;
-		$startHour = $config->getSystemValueInt('maintenance_window_start', 100);
-		if ($jobClasses === null && $startHour <= 23) {
-			$date = new \DateTime('now', new \DateTimeZone('UTC'));
-			$currentHour = (int)$date->format('G');
-			$endHour = $startHour + 4;
-
-			if ($startHour <= 20) {
-				// Start time: 01:00
-				// End time: 05:00
-				// Only run sensitive tasks when it's before the start or after the end
-				$onlyTimeSensitive = $currentHour < $startHour || $currentHour > $endHour;
-			} else {
-				// Start time: 23:00
-				// End time: 03:00
-				$endHour -= 24; // Correct the end time from 27:00 to 03:00
-				// Only run sensitive tasks when it's after the end and before the start
-				$onlyTimeSensitive = $currentHour > $endHour && $currentHour < $startHour;
-			}
-		}
-
-		// Work
-		$jobList = Server::get(IJobList::class);
-
-		// We only ask for jobs for 14 minutes, because after 5 minutes the next
-		// system cron task should spawn and we want to have at most three
-		// cron jobs running in parallel.
-		$endTime = time() + 14 * 60;
-
-		$executedJobs = [];
-
-		while ($job = $jobList->getNext($onlyTimeSensitive, $jobClasses)) {
-			if (isset($executedJobs[$job->getId()])) {
-				$jobList->unlockJob($job);
-				break;
-			}
-
-			$jobDetails = get_class($job) . ' (id: ' . $job->getId() . ', arguments: ' . json_encode($job->getArgument()) . ')';
-			$logger->debug('CLI cron call has selected job ' . $jobDetails, ['app' => 'cron']);
-
-			$timeBefore = time();
-			$memoryBefore = memory_get_usage();
-			$memoryPeakBefore = memory_get_peak_usage();
-
-			if ($verbose) {
-				echo 'Starting job ' . $jobDetails . PHP_EOL;
-			}
-
-			$job->start($jobList);
-
-			$timeAfter = time();
-			$memoryAfter = memory_get_usage();
-			$memoryPeakAfter = memory_get_peak_usage();
-
-			$cronInterval = 5 * 60;
-			$timeSpent = $timeAfter - $timeBefore;
-			if ($timeSpent > $cronInterval) {
-				$logLevel = match (true) {
-					$timeSpent > $cronInterval * 128 => ILogger::FATAL,
-					$timeSpent > $cronInterval * 64 => ILogger::ERROR,
-					$timeSpent > $cronInterval * 16 => ILogger::WARN,
-					$timeSpent > $cronInterval * 8 => ILogger::INFO,
-					default => ILogger::DEBUG,
-				};
-				$logger->log(
-					$logLevel,
-					'Background job ' . $jobDetails . ' ran for ' . $timeSpent . ' seconds',
-					['app' => 'cron']
-				);
-			}
-
-			if ($memoryAfter - $memoryBefore > 50_000_000) {
-				$message = 'Used memory grew by more than 50 MB when executing job ' . $jobDetails . ': ' . Util::humanFileSize($memoryAfter) . ' (before: ' . Util::humanFileSize($memoryBefore) . ')';
-				$logger->warning($message, ['app' => 'cron']);
-				if ($verbose) {
-					echo $message . PHP_EOL;
-				}
-			}
-			if ($memoryPeakAfter > 300_000_000 && $memoryPeakBefore <= 300_000_000) {
-				$message = 'Cron job used more than 300 MB of ram after executing job ' . $jobDetails . ': ' . Util::humanFileSize($memoryPeakAfter) . ' (before: ' . Util::humanFileSize($memoryPeakBefore) . ')';
-				$logger->warning($message, ['app' => 'cron']);
-				if ($verbose) {
-					echo $message . PHP_EOL;
-				}
-			}
-
-			// clean up after unclean jobs
-			Server::get(SetupManager::class)->tearDown();
-			$tempManager->clean();
-
-			if ($verbose) {
-				echo 'Job ' . $jobDetails . ' done in ' . ($timeAfter - $timeBefore) . ' seconds' . PHP_EOL;
-			}
-
-			$jobList->setLastJob($job);
-			$executedJobs[$job->getId()] = true;
-			unset($job);
-
-			if ($timeAfter > $endTime) {
-				break;
-			}
-		}
-	} else {
-		// We call cron.php from some website
-		if ($appMode === 'cron') {
-			// Cron is cron :-P
-			OC_JSON::error(['data' => ['message' => 'Backgroundjobs are using system cron!']]);
-		} else {
-			// Work and success :-)
-			$jobList = Server::get(IJobList::class);
-			$job = $jobList->getNext();
-			if ($job != null) {
-				$logger->debug('WebCron call has selected job with ID ' . strval($job->getId()), ['app' => 'cron']);
-				$job->start($jobList);
-				$jobList->setLastJob($job);
-			}
-			OC_JSON::success();
-		}
-	}
-
-	// Log the successful cron execution
-	$appConfig->setValueInt('core', 'lastcron', time());
-	exit();
+        exit(0);
+    }
+
+    if (Util::needUpgrade()) {
+        Server::get(LoggerInterface::class)->debug('Update required, skipping cron', ['app' => 'cron']);
+        exit;
+    }
+
+    $config = Server::get(IConfig::class);
+
+    if ($config->getSystemValueBool('maintenance', false)) {
+        Server::get(LoggerInterface::class)->debug('We are in maintenance mode, skipping cron', ['app' => 'cron']);
+        exit;
+    }
+
+    // Don't do anything if Nextcloud has not been installed
+    if (!$config->getSystemValueBool('installed', false)) {
+        exit(0);
+    }
+
+    // load all apps to get all api routes properly setup
+    Server::get(IAppManager::class)->loadApps();
+    Server::get(ISession::class)->close();
+
+    $verbose = isset($argv[1]) && ($argv[1] === '-v' || $argv[1] === '--verbose');
+
+    // initialize a dummy memory session
+    $session = new Memory();
+    $cryptoWrapper = Server::get(CryptoWrapper::class);
+    $session = $cryptoWrapper->wrapSession($session);
+    \OC::$server->setSession($session);
+
+    $logger = Server::get(LoggerInterface::class);
+    $appConfig = Server::get(IAppConfig::class);
+    $tempManager = Server::get(ITempManager::class);
+
+    $tempManager->cleanOld();
+
+    // Exit if background jobs are disabled!
+    $appMode = $appConfig->getValueString('core', 'backgroundjobs_mode', 'ajax');
+    if ($appMode === 'none') {
+        if (OC::$CLI) {
+            echo 'Background Jobs are disabled!' . PHP_EOL;
+        } else {
+            OC_JSON::error(['data' => ['message' => 'Background jobs disabled!']]);
+        }
+        exit(1);
+    }
+
+    if (OC::$CLI) {
+        // set to run indefinitely if needed
+        if (strpos(@ini_get('disable_functions'), 'set_time_limit') === false) {
+            @set_time_limit(0);
+        }
+
+        // the cron job must be executed with the right user
+        if (!function_exists('posix_getuid')) {
+            echo 'The posix extensions are required - see https://www.php.net/manual/en/book.posix.php' . PHP_EOL;
+            exit(1);
+        }
+
+        $user = posix_getuid();
+        $configUser = fileowner(OC::$configDir . 'config.php');
+        if ($user !== $configUser) {
+            echo 'Console has to be executed with the user that owns the file config/config.php' . PHP_EOL;
+            echo 'Current user id: ' . $user . PHP_EOL;
+            echo 'Owner id of config.php: ' . $configUser . PHP_EOL;
+            exit(1);
+        }
+
+
+        // We call Nextcloud from the CLI (aka cron)
+        if ($appMode !== 'cron') {
+            $appConfig->setValueString('core', 'backgroundjobs_mode', 'cron');
+        }
+
+        // a specific job class list can optionally be given as argument
+        $jobClasses = array_slice($argv, $verbose ? 2 : 1);
+        $jobClasses = empty($jobClasses) ? null : $jobClasses;
+
+        // Low-load hours
+        $onlyTimeSensitive = false;
+        $startHour = $config->getSystemValueInt('maintenance_window_start', 100);
+        if ($jobClasses === null && $startHour <= 23) {
+            $date = new \DateTime('now', new \DateTimeZone('UTC'));
+            $currentHour = (int)$date->format('G');
+            $endHour = $startHour + 4;
+
+            if ($startHour <= 20) {
+                // Start time: 01:00
+                // End time: 05:00
+                // Only run sensitive tasks when it's before the start or after the end
+                $onlyTimeSensitive = $currentHour < $startHour || $currentHour > $endHour;
+            } else {
+                // Start time: 23:00
+                // End time: 03:00
+                $endHour -= 24; // Correct the end time from 27:00 to 03:00
+                // Only run sensitive tasks when it's after the end and before the start
+                $onlyTimeSensitive = $currentHour > $endHour && $currentHour < $startHour;
+            }
+        }
+
+        // Work
+        $jobList = Server::get(IJobList::class);
+
+        // We only ask for jobs for 14 minutes, because after 5 minutes the next
+        // system cron task should spawn and we want to have at most three
+        // cron jobs running in parallel.
+        $endTime = time() + 14 * 60;
+
+        $executedJobs = [];
+
+        while ($job = $jobList->getNext($onlyTimeSensitive, $jobClasses)) {
+            if (isset($executedJobs[$job->getId()])) {
+                $jobList->unlockJob($job);
+                break;
+            }
+
+            $jobDetails = get_class($job) . ' (id: ' . $job->getId() . ', arguments: ' . json_encode($job->getArgument()) . ')';
+            $logger->debug('CLI cron call has selected job ' . $jobDetails, ['app' => 'cron']);
+
+            $timeBefore = time();
+            $memoryBefore = memory_get_usage();
+            $memoryPeakBefore = memory_get_peak_usage();
+
+            if ($verbose) {
+                echo 'Starting job ' . $jobDetails . PHP_EOL;
+            }
+
+            $job->start($jobList);
+
+            $timeAfter = time();
+            $memoryAfter = memory_get_usage();
+            $memoryPeakAfter = memory_get_peak_usage();
+
+            $cronInterval = 5 * 60;
+            $timeSpent = $timeAfter - $timeBefore;
+            if ($timeSpent > $cronInterval) {
+                $logLevel = match (true) {
+                    $timeSpent > $cronInterval * 128 => ILogger::FATAL,
+                    $timeSpent > $cronInterval * 64 => ILogger::ERROR,
+                    $timeSpent > $cronInterval * 16 => ILogger::WARN,
+                    $timeSpent > $cronInterval * 8 => ILogger::INFO,
+                    default => ILogger::DEBUG,
+                };
+                $logger->log(
+                    $logLevel,
+                    'Background job ' . $jobDetails . ' ran for ' . $timeSpent . ' seconds',
+                    ['app' => 'cron']
+                );
+            }
+
+            if ($memoryAfter - $memoryBefore > 50_000_000) {
+                $message = 'Used memory grew by more than 50 MB when executing job ' . $jobDetails . ': ' . Util::humanFileSize($memoryAfter) . ' (before: ' . Util::humanFileSize($memoryBefore) . ')';
+                $logger->warning($message, ['app' => 'cron']);
+                if ($verbose) {
+                    echo $message . PHP_EOL;
+                }
+            }
+            if ($memoryPeakAfter > 300_000_000 && $memoryPeakBefore <= 300_000_000) {
+                $message = 'Cron job used more than 300 MB of ram after executing job ' . $jobDetails . ': ' . Util::humanFileSize($memoryPeakAfter) . ' (before: ' . Util::humanFileSize($memoryPeakBefore) . ')';
+                $logger->warning($message, ['app' => 'cron']);
+                if ($verbose) {
+                    echo $message . PHP_EOL;
+                }
+            }
+
+            // clean up after unclean jobs
+            Server::get(SetupManager::class)->tearDown();
+            $tempManager->clean();
+
+            if ($verbose) {
+                echo 'Job ' . $jobDetails . ' done in ' . ($timeAfter - $timeBefore) . ' seconds' . PHP_EOL;
+            }
+
+            $jobList->setLastJob($job);
+            $executedJobs[$job->getId()] = true;
+            unset($job);
+
+            if ($timeAfter > $endTime) {
+                break;
+            }
+        }
+    } else {
+        // We call cron.php from some website
+        if ($appMode === 'cron') {
+            // Cron is cron :-P
+            OC_JSON::error(['data' => ['message' => 'Backgroundjobs are using system cron!']]);
+        } else {
+            // Work and success :-)
+            $jobList = Server::get(IJobList::class);
+            $job = $jobList->getNext();
+            if ($job != null) {
+                $logger->debug('WebCron call has selected job with ID ' . strval($job->getId()), ['app' => 'cron']);
+                $job->start($jobList);
+                $jobList->setLastJob($job);
+            }
+            OC_JSON::success();
+        }
+    }
+
+    // Log the successful cron execution
+    $appConfig->setValueInt('core', 'lastcron', time());
+    exit();
 } catch (Exception $ex) {
-	Server::get(LoggerInterface::class)->error(
-		$ex->getMessage(),
-		['app' => 'cron', 'exception' => $ex]
-	);
-	echo $ex . PHP_EOL;
-	exit(1);
+    Server::get(LoggerInterface::class)->error(
+        $ex->getMessage(),
+        ['app' => 'cron', 'exception' => $ex]
+    );
+    echo $ex . PHP_EOL;
+    exit(1);
 } catch (Error $ex) {
-	Server::get(LoggerInterface::class)->error(
-		$ex->getMessage(),
-		['app' => 'cron', 'exception' => $ex]
-	);
-	echo $ex . PHP_EOL;
-	exit(1);
+    Server::get(LoggerInterface::class)->error(
+        $ex->getMessage(),
+        ['app' => 'cron', 'exception' => $ex]
+    );
+    echo $ex . PHP_EOL;
+    exit(1);
 }

Spacing +21 added lines, -21 removed lines

@@ -13,7 +13,7 @@ 
  * SPDX-License-Identifier: AGPL-3.0-only
  */
 
-require_once __DIR__ . '/lib/versioncheck.php';
+require_once __DIR__.'/lib/versioncheck.php';
 
 use OCP\App\IAppManager;
 use OCP\BackgroundJob\IJobList;
@@ -26,7 +26,7 @@ 
 use Psr\Log\LoggerInterface;
 
 try {
-	require_once __DIR__ . '/lib/base.php';
+	require_once __DIR__.'/lib/base.php';
 
 	if (isset($argv[1]) && ($argv[1] === '-h' || $argv[1] === '--help')) {
 		echo 'Description:
@@ -84,7 +84,7 @@ 
 	$appMode = $appConfig->getValueString('core', 'backgroundjobs_mode', 'ajax');
 	if ($appMode === 'none') {
 		if (OC::$CLI) {
-			echo 'Background Jobs are disabled!' . PHP_EOL;
+			echo 'Background Jobs are disabled!'.PHP_EOL;
 		} else {
 			OC_JSON::error(['data' => ['message' => 'Background jobs disabled!']]);
 		}
@@ -99,16 +99,16 @@ 
 
 		// the cron job must be executed with the right user
 		if (!function_exists('posix_getuid')) {
-			echo 'The posix extensions are required - see https://www.php.net/manual/en/book.posix.php' . PHP_EOL;
+			echo 'The posix extensions are required - see https://www.php.net/manual/en/book.posix.php'.PHP_EOL;
 			exit(1);
 		}
 
 		$user = posix_getuid();
-		$configUser = fileowner(OC::$configDir . 'config.php');
+		$configUser = fileowner(OC::$configDir.'config.php');
 		if ($user !== $configUser) {
-			echo 'Console has to be executed with the user that owns the file config/config.php' . PHP_EOL;
-			echo 'Current user id: ' . $user . PHP_EOL;
-			echo 'Owner id of config.php: ' . $configUser . PHP_EOL;
+			echo 'Console has to be executed with the user that owns the file config/config.php'.PHP_EOL;
+			echo 'Current user id: '.$user.PHP_EOL;
+			echo 'Owner id of config.php: '.$configUser.PHP_EOL;
 			exit(1);
 		}
 
@@ -127,7 +127,7 @@ 
 		$startHour = $config->getSystemValueInt('maintenance_window_start', 100);
 		if ($jobClasses === null && $startHour <= 23) {
 			$date = new \DateTime('now', new \DateTimeZone('UTC'));
-			$currentHour = (int)$date->format('G');
+			$currentHour = (int) $date->format('G');
 			$endHour = $startHour + 4;
 
 			if ($startHour <= 20) {
@@ -160,15 +160,15 @@ 
 				break;
 			}
 
-			$jobDetails = get_class($job) . ' (id: ' . $job->getId() . ', arguments: ' . json_encode($job->getArgument()) . ')';
-			$logger->debug('CLI cron call has selected job ' . $jobDetails, ['app' => 'cron']);
+			$jobDetails = get_class($job).' (id: '.$job->getId().', arguments: '.json_encode($job->getArgument()).')';
+			$logger->debug('CLI cron call has selected job '.$jobDetails, ['app' => 'cron']);
 
 			$timeBefore = time();
 			$memoryBefore = memory_get_usage();
 			$memoryPeakBefore = memory_get_peak_usage();
 
 			if ($verbose) {
-				echo 'Starting job ' . $jobDetails . PHP_EOL;
+				echo 'Starting job '.$jobDetails.PHP_EOL;
 			}
 
 			$job->start($jobList);
@@ -189,23 +189,23 @@ 
 				};
 				$logger->log(
 					$logLevel,
-					'Background job ' . $jobDetails . ' ran for ' . $timeSpent . ' seconds',
+					'Background job '.$jobDetails.' ran for '.$timeSpent.' seconds',
 					['app' => 'cron']
 				);
 			}
 
 			if ($memoryAfter - $memoryBefore > 50_000_000) {
-				$message = 'Used memory grew by more than 50 MB when executing job ' . $jobDetails . ': ' . Util::humanFileSize($memoryAfter) . ' (before: ' . Util::humanFileSize($memoryBefore) . ')';
+				$message = 'Used memory grew by more than 50 MB when executing job '.$jobDetails.': '.Util::humanFileSize($memoryAfter).' (before: '.Util::humanFileSize($memoryBefore).')';
 				$logger->warning($message, ['app' => 'cron']);
 				if ($verbose) {
-					echo $message . PHP_EOL;
+					echo $message.PHP_EOL;
 				}
 			}
 			if ($memoryPeakAfter > 300_000_000 && $memoryPeakBefore <= 300_000_000) {
-				$message = 'Cron job used more than 300 MB of ram after executing job ' . $jobDetails . ': ' . Util::humanFileSize($memoryPeakAfter) . ' (before: ' . Util::humanFileSize($memoryPeakBefore) . ')';
+				$message = 'Cron job used more than 300 MB of ram after executing job '.$jobDetails.': '.Util::humanFileSize($memoryPeakAfter).' (before: '.Util::humanFileSize($memoryPeakBefore).')';
 				$logger->warning($message, ['app' => 'cron']);
 				if ($verbose) {
-					echo $message . PHP_EOL;
+					echo $message.PHP_EOL;
 				}
 			}
 
@@ -214,7 +214,7 @@ 
 			$tempManager->clean();
 
 			if ($verbose) {
-				echo 'Job ' . $jobDetails . ' done in ' . ($timeAfter - $timeBefore) . ' seconds' . PHP_EOL;
+				echo 'Job '.$jobDetails.' done in '.($timeAfter - $timeBefore).' seconds'.PHP_EOL;
 			}
 
 			$jobList->setLastJob($job);
@@ -235,7 +235,7 @@ 
 			$jobList = Server::get(IJobList::class);
 			$job = $jobList->getNext();
 			if ($job != null) {
-				$logger->debug('WebCron call has selected job with ID ' . strval($job->getId()), ['app' => 'cron']);
+				$logger->debug('WebCron call has selected job with ID '.strval($job->getId()), ['app' => 'cron']);
 				$job->start($jobList);
 				$jobList->setLastJob($job);
 			}
@@ -251,13 +251,13 @@ 
 		$ex->getMessage(),
 		['app' => 'cron', 'exception' => $ex]
 	);
-	echo $ex . PHP_EOL;
+	echo $ex.PHP_EOL;
 	exit(1);
 } catch (Error $ex) {
 	Server::get(LoggerInterface::class)->error(
 		$ex->getMessage(),
 		['app' => 'cron', 'exception' => $ex]
 	);
-	echo $ex . PHP_EOL;
+	echo $ex.PHP_EOL;
 	exit(1);
 }

core/Command/Background/JobWorker.php

Indentation +151 added lines, -151 removed lines

@@ -20,155 +20,155 @@
 
 class JobWorker extends JobBase {
 
-	public function __construct(
-		protected IJobList $jobList,
-		protected LoggerInterface $logger,
-		private ITempManager $tempManager,
-		private SetupManager $setupManager,
-	) {
-		parent::__construct($jobList, $logger);
-	}
-	protected function configure(): void {
-		parent::configure();
-
-		$this
-			->setName('background-job:worker')
-			->setDescription('Run a background job worker')
-			->addArgument(
-				'job-classes',
-				InputArgument::OPTIONAL | InputArgument::IS_ARRAY,
-				'The classes of the jobs to look for in the database'
-			)
-			->addOption(
-				'once',
-				null,
-				InputOption::VALUE_NONE,
-				'Only execute the worker once (as a regular cron execution would do it)'
-			)
-			->addOption(
-				'interval',
-				'i',
-				InputOption::VALUE_OPTIONAL,
-				'Interval in seconds in which the worker should repeat already processed jobs (set to 0 for no repeat)',
-				5
-			)
-			->addOption(
-				'stop_after',
-				't',
-				InputOption::VALUE_OPTIONAL,
-				'Duration after which the worker should stop and exit. The worker won\'t kill a potential running job, it will exit after this job has finished running (supported values are: "30" or "30s" for 30 seconds, "10m" for 10 minutes and "2h" for 2 hours)'
-			)
-		;
-	}
-
-	protected function execute(InputInterface $input, OutputInterface $output): int {
-		$startTime = time();
-		$stopAfterOptionValue = $input->getOption('stop_after');
-		$stopAfterSeconds = $stopAfterOptionValue === null
-			? null
-			: $this->parseStopAfter($stopAfterOptionValue);
-		if ($stopAfterSeconds !== null) {
-			$output->writeln('<info>Background job worker will stop after ' . $stopAfterSeconds . ' seconds</info>');
-		}
-
-		$jobClasses = $input->getArgument('job-classes');
-		$jobClasses = empty($jobClasses) ? null : $jobClasses;
-
-		if ($jobClasses !== null) {
-			// at least one class is invalid
-			foreach ($jobClasses as $jobClass) {
-				if (!class_exists($jobClass)) {
-					$output->writeln('<error>Invalid job class: ' . $jobClass . '</error>');
-					return 1;
-				}
-			}
-		}
-
-		while (true) {
-			// Stop if we exceeded stop_after value
-			if ($stopAfterSeconds !== null && ($startTime + $stopAfterSeconds) < time()) {
-				$output->writeln('stop_after time has been exceeded, exiting...', OutputInterface::VERBOSITY_VERBOSE);
-				break;
-			}
-			// Handle canceling of the process
-			try {
-				$this->abortIfInterrupted();
-			} catch (InterruptedException $e) {
-				$output->writeln('<info>Background job worker stopped</info>');
-				break;
-			}
-
-			$this->printSummary($input, $output);
-
-			usleep(50000);
-			$job = $this->jobList->getNext(false, $jobClasses);
-			if (!$job) {
-				if ($input->getOption('once') === true) {
-					if ($jobClasses === null) {
-						$output->writeln('No job is currently queued', OutputInterface::VERBOSITY_VERBOSE);
-					} else {
-						$output->writeln('No job of classes [' . implode(', ', $jobClasses) . '] is currently queued', OutputInterface::VERBOSITY_VERBOSE);
-					}
-					$output->writeln('Exiting...', OutputInterface::VERBOSITY_VERBOSE);
-					break;
-				}
-
-				$output->writeln('Waiting for new jobs to be queued', OutputInterface::VERBOSITY_VERBOSE);
-				// Re-check interval for new jobs
-				sleep(1);
-				continue;
-			}
-
-			$output->writeln('Running job ' . get_class($job) . ' with ID ' . $job->getId());
-
-			if ($output->isVerbose()) {
-				$this->printJobInfo($job->getId(), $job, $output);
-			}
-
-			$job->start($this->jobList);
-			$output->writeln('Job ' . $job->getId() . ' has finished', OutputInterface::VERBOSITY_VERBOSE);
-
-			// clean up after unclean jobs
-			$this->setupManager->tearDown();
-			$this->tempManager->clean();
-
-			$this->jobList->setLastJob($job);
-			$this->jobList->unlockJob($job);
-
-			if ($input->getOption('once') === true) {
-				break;
-			}
-		}
-
-		return 0;
-	}
-
-	private function printSummary(InputInterface $input, OutputInterface $output): void {
-		if (!$output->isVeryVerbose()) {
-			return;
-		}
-		$output->writeln('<comment>Summary</comment>');
-
-		$counts = [];
-		foreach ($this->jobList->countByClass() as $row) {
-			$counts[] = $row;
-		}
-		$this->writeTableInOutputFormat($input, $output, $counts);
-	}
-
-	private function parseStopAfter(string $value): ?int {
-		if (is_numeric($value)) {
-			return (int)$value;
-		}
-		if (preg_match("/^(\d+)s$/i", $value, $matches)) {
-			return (int)$matches[0];
-		}
-		if (preg_match("/^(\d+)m$/i", $value, $matches)) {
-			return 60 * ((int)$matches[0]);
-		}
-		if (preg_match("/^(\d+)h$/i", $value, $matches)) {
-			return 60 * 60 * ((int)$matches[0]);
-		}
-		return null;
-	}
+    public function __construct(
+        protected IJobList $jobList,
+        protected LoggerInterface $logger,
+        private ITempManager $tempManager,
+        private SetupManager $setupManager,
+    ) {
+        parent::__construct($jobList, $logger);
+    }
+    protected function configure(): void {
+        parent::configure();
+
+        $this
+            ->setName('background-job:worker')
+            ->setDescription('Run a background job worker')
+            ->addArgument(
+                'job-classes',
+                InputArgument::OPTIONAL | InputArgument::IS_ARRAY,
+                'The classes of the jobs to look for in the database'
+            )
+            ->addOption(
+                'once',
+                null,
+                InputOption::VALUE_NONE,
+                'Only execute the worker once (as a regular cron execution would do it)'
+            )
+            ->addOption(
+                'interval',
+                'i',
+                InputOption::VALUE_OPTIONAL,
+                'Interval in seconds in which the worker should repeat already processed jobs (set to 0 for no repeat)',
+                5
+            )
+            ->addOption(
+                'stop_after',
+                't',
+                InputOption::VALUE_OPTIONAL,
+                'Duration after which the worker should stop and exit. The worker won\'t kill a potential running job, it will exit after this job has finished running (supported values are: "30" or "30s" for 30 seconds, "10m" for 10 minutes and "2h" for 2 hours)'
+            )
+        ;
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int {
+        $startTime = time();
+        $stopAfterOptionValue = $input->getOption('stop_after');
+        $stopAfterSeconds = $stopAfterOptionValue === null
+            ? null
+            : $this->parseStopAfter($stopAfterOptionValue);
+        if ($stopAfterSeconds !== null) {
+            $output->writeln('<info>Background job worker will stop after ' . $stopAfterSeconds . ' seconds</info>');
+        }
+
+        $jobClasses = $input->getArgument('job-classes');
+        $jobClasses = empty($jobClasses) ? null : $jobClasses;
+
+        if ($jobClasses !== null) {
+            // at least one class is invalid
+            foreach ($jobClasses as $jobClass) {
+                if (!class_exists($jobClass)) {
+                    $output->writeln('<error>Invalid job class: ' . $jobClass . '</error>');
+                    return 1;
+                }
+            }
+        }
+
+        while (true) {
+            // Stop if we exceeded stop_after value
+            if ($stopAfterSeconds !== null && ($startTime + $stopAfterSeconds) < time()) {
+                $output->writeln('stop_after time has been exceeded, exiting...', OutputInterface::VERBOSITY_VERBOSE);
+                break;
+            }
+            // Handle canceling of the process
+            try {
+                $this->abortIfInterrupted();
+            } catch (InterruptedException $e) {
+                $output->writeln('<info>Background job worker stopped</info>');
+                break;
+            }
+
+            $this->printSummary($input, $output);
+
+            usleep(50000);
+            $job = $this->jobList->getNext(false, $jobClasses);
+            if (!$job) {
+                if ($input->getOption('once') === true) {
+                    if ($jobClasses === null) {
+                        $output->writeln('No job is currently queued', OutputInterface::VERBOSITY_VERBOSE);
+                    } else {
+                        $output->writeln('No job of classes [' . implode(', ', $jobClasses) . '] is currently queued', OutputInterface::VERBOSITY_VERBOSE);
+                    }
+                    $output->writeln('Exiting...', OutputInterface::VERBOSITY_VERBOSE);
+                    break;
+                }
+
+                $output->writeln('Waiting for new jobs to be queued', OutputInterface::VERBOSITY_VERBOSE);
+                // Re-check interval for new jobs
+                sleep(1);
+                continue;
+            }
+
+            $output->writeln('Running job ' . get_class($job) . ' with ID ' . $job->getId());
+
+            if ($output->isVerbose()) {
+                $this->printJobInfo($job->getId(), $job, $output);
+            }
+
+            $job->start($this->jobList);
+            $output->writeln('Job ' . $job->getId() . ' has finished', OutputInterface::VERBOSITY_VERBOSE);
+
+            // clean up after unclean jobs
+            $this->setupManager->tearDown();
+            $this->tempManager->clean();
+
+            $this->jobList->setLastJob($job);
+            $this->jobList->unlockJob($job);
+
+            if ($input->getOption('once') === true) {
+                break;
+            }
+        }
+
+        return 0;
+    }
+
+    private function printSummary(InputInterface $input, OutputInterface $output): void {
+        if (!$output->isVeryVerbose()) {
+            return;
+        }
+        $output->writeln('<comment>Summary</comment>');
+
+        $counts = [];
+        foreach ($this->jobList->countByClass() as $row) {
+            $counts[] = $row;
+        }
+        $this->writeTableInOutputFormat($input, $output, $counts);
+    }
+
+    private function parseStopAfter(string $value): ?int {
+        if (is_numeric($value)) {
+            return (int)$value;
+        }
+        if (preg_match("/^(\d+)s$/i", $value, $matches)) {
+            return (int)$matches[0];
+        }
+        if (preg_match("/^(\d+)m$/i", $value, $matches)) {
+            return 60 * ((int)$matches[0]);
+        }
+        if (preg_match("/^(\d+)h$/i", $value, $matches)) {
+            return 60 * 60 * ((int)$matches[0]);
+        }
+        return null;
+    }
 }

Spacing +9 added lines, -9 removed lines

@@ -68,7 +68,7 @@ 
 			? null
 			: $this->parseStopAfter($stopAfterOptionValue);
 		if ($stopAfterSeconds !== null) {
-			$output->writeln('<info>Background job worker will stop after ' . $stopAfterSeconds . ' seconds</info>');
+			$output->writeln('<info>Background job worker will stop after '.$stopAfterSeconds.' seconds</info>');
 		}
 
 		$jobClasses = $input->getArgument('job-classes');
@@ -78,7 +78,7 @@ 
 			// at least one class is invalid
 			foreach ($jobClasses as $jobClass) {
 				if (!class_exists($jobClass)) {
-					$output->writeln('<error>Invalid job class: ' . $jobClass . '</error>');
+					$output->writeln('<error>Invalid job class: '.$jobClass.'</error>');
 					return 1;
 				}
 			}
@@ -107,7 +107,7 @@ 
 					if ($jobClasses === null) {
 						$output->writeln('No job is currently queued', OutputInterface::VERBOSITY_VERBOSE);
 					} else {
-						$output->writeln('No job of classes [' . implode(', ', $jobClasses) . '] is currently queued', OutputInterface::VERBOSITY_VERBOSE);
+						$output->writeln('No job of classes ['.implode(', ', $jobClasses).'] is currently queued', OutputInterface::VERBOSITY_VERBOSE);
 					}
 					$output->writeln('Exiting...', OutputInterface::VERBOSITY_VERBOSE);
 					break;
@@ -119,14 +119,14 @@ 
 				continue;
 			}
 
-			$output->writeln('Running job ' . get_class($job) . ' with ID ' . $job->getId());
+			$output->writeln('Running job '.get_class($job).' with ID '.$job->getId());
 
 			if ($output->isVerbose()) {
 				$this->printJobInfo($job->getId(), $job, $output);
 			}
 
 			$job->start($this->jobList);
-			$output->writeln('Job ' . $job->getId() . ' has finished', OutputInterface::VERBOSITY_VERBOSE);
+			$output->writeln('Job '.$job->getId().' has finished', OutputInterface::VERBOSITY_VERBOSE);
 
 			// clean up after unclean jobs
 			$this->setupManager->tearDown();
@@ -158,16 +158,16 @@ 
 
 	private function parseStopAfter(string $value): ?int {
 		if (is_numeric($value)) {
-			return (int)$value;
+			return (int) $value;
 		}
 		if (preg_match("/^(\d+)s$/i", $value, $matches)) {
-			return (int)$matches[0];
+			return (int) $matches[0];
 		}
 		if (preg_match("/^(\d+)m$/i", $value, $matches)) {
-			return 60 * ((int)$matches[0]);
+			return 60 * ((int) $matches[0]);
 		}
 		if (preg_match("/^(\d+)h$/i", $value, $matches)) {
-			return 60 * 60 * ((int)$matches[0]);
+			return 60 * 60 * ((int) $matches[0]);
 		}
 		return null;
 	}

core/Command/Background/Job.php

Indentation +116 added lines, -116 removed lines

@@ -19,120 +19,120 @@
 use Symfony\Component\Console\Output\OutputInterface;
 
 class Job extends Command {
-	public function __construct(
-		protected IJobList $jobList,
-	) {
-		parent::__construct();
-	}
-
-	protected function configure(): void {
-		$this
-			->setName('background-job:execute')
-			->setDescription('Execute a single background job manually')
-			->addArgument(
-				'job-id',
-				InputArgument::REQUIRED,
-				'The ID of the job in the database'
-			)
-			->addOption(
-				'force-execute',
-				null,
-				InputOption::VALUE_NONE,
-				'Force execute the background job, independent from last run and being reserved'
-			)
-		;
-	}
-
-	protected function execute(InputInterface $input, OutputInterface $output): int {
-		$jobId = (int)$input->getArgument('job-id');
-
-		$job = $this->jobList->getById($jobId);
-		if ($job === null) {
-			$output->writeln('<error>Job with ID ' . $jobId . ' could not be found in the database</error>');
-			return 1;
-		}
-
-		$this->printJobInfo($jobId, $job, $output);
-		$output->writeln('');
-
-		$lastRun = $job->getLastRun();
-		if ($input->getOption('force-execute')) {
-			$lastRun = 0;
-			$output->writeln('<comment>Forcing execution of the job</comment>');
-			$output->writeln('');
-
-			$this->jobList->resetBackgroundJob($job);
-		}
-
-		$job = $this->jobList->getById($jobId);
-		if ($job === null) {
-			$output->writeln('<error>Something went wrong when trying to retrieve Job with ID ' . $jobId . ' from database</error>');
-			return 1;
-		}
-		$job->start($this->jobList);
-		$job = $this->jobList->getById($jobId);
-
-		if (($job === null) || ($lastRun !== $job->getLastRun())) {
-			$output->writeln('<info>Job executed!</info>');
-			$output->writeln('');
-
-			if ($job instanceof TimedJob) {
-				$this->printJobInfo($jobId, $job, $output);
-			}
-		} else {
-			$output->writeln('<comment>Job was not executed because it is not due</comment>');
-			$output->writeln('Specify the <question>--force-execute</question> option to run it anyway');
-		}
-
-		return 0;
-	}
-
-	protected function printJobInfo(int $jobId, IJob $job, OutputInterface $output): void {
-		$row = $this->jobList->getDetailsById($jobId);
-
-		$lastRun = new \DateTime();
-		$lastRun->setTimestamp((int)$row['last_run']);
-		$lastChecked = new \DateTime();
-		$lastChecked->setTimestamp((int)$row['last_checked']);
-		$reservedAt = new \DateTime();
-		$reservedAt->setTimestamp((int)$row['reserved_at']);
-
-		$output->writeln('Job class:            ' . get_class($job));
-		$output->writeln('Arguments:            ' . json_encode($job->getArgument()));
-
-		$isTimedJob = $job instanceof TimedJob;
-		if ($isTimedJob) {
-			$output->writeln('Type:                 timed');
-		} elseif ($job instanceof QueuedJob) {
-			$output->writeln('Type:                 queued');
-		} else {
-			$output->writeln('Type:                 job');
-		}
-
-		$output->writeln('');
-		$output->writeln('Last checked:         ' . $lastChecked->format(\DateTimeInterface::ATOM));
-		if ((int)$row['reserved_at'] === 0) {
-			$output->writeln('Reserved at:          -');
-		} else {
-			$output->writeln('Reserved at:          <comment>' . $reservedAt->format(\DateTimeInterface::ATOM) . '</comment>');
-		}
-		$output->writeln('Last executed:        ' . $lastRun->format(\DateTimeInterface::ATOM));
-		$output->writeln('Last duration:        ' . $row['execution_duration']);
-
-		if ($isTimedJob) {
-			$reflection = new \ReflectionClass($job);
-			$intervalProperty = $reflection->getProperty('interval');
-			$intervalProperty->setAccessible(true);
-			$interval = $intervalProperty->getValue($job);
-
-			$nextRun = new \DateTime();
-			$nextRun->setTimestamp($row['last_run'] + $interval);
-
-			if ($nextRun > new \DateTime()) {
-				$output->writeln('Next execution:       <comment>' . $nextRun->format(\DateTimeInterface::ATOM) . '</comment>');
-			} else {
-				$output->writeln('Next execution:       <info>' . $nextRun->format(\DateTimeInterface::ATOM) . '</info>');
-			}
-		}
-	}
+    public function __construct(
+        protected IJobList $jobList,
+    ) {
+        parent::__construct();
+    }
+
+    protected function configure(): void {
+        $this
+            ->setName('background-job:execute')
+            ->setDescription('Execute a single background job manually')
+            ->addArgument(
+                'job-id',
+                InputArgument::REQUIRED,
+                'The ID of the job in the database'
+            )
+            ->addOption(
+                'force-execute',
+                null,
+                InputOption::VALUE_NONE,
+                'Force execute the background job, independent from last run and being reserved'
+            )
+        ;
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int {
+        $jobId = (int)$input->getArgument('job-id');
+
+        $job = $this->jobList->getById($jobId);
+        if ($job === null) {
+            $output->writeln('<error>Job with ID ' . $jobId . ' could not be found in the database</error>');
+            return 1;
+        }
+
+        $this->printJobInfo($jobId, $job, $output);
+        $output->writeln('');
+
+        $lastRun = $job->getLastRun();
+        if ($input->getOption('force-execute')) {
+            $lastRun = 0;
+            $output->writeln('<comment>Forcing execution of the job</comment>');
+            $output->writeln('');
+
+            $this->jobList->resetBackgroundJob($job);
+        }
+
+        $job = $this->jobList->getById($jobId);
+        if ($job === null) {
+            $output->writeln('<error>Something went wrong when trying to retrieve Job with ID ' . $jobId . ' from database</error>');
+            return 1;
+        }
+        $job->start($this->jobList);
+        $job = $this->jobList->getById($jobId);
+
+        if (($job === null) || ($lastRun !== $job->getLastRun())) {
+            $output->writeln('<info>Job executed!</info>');
+            $output->writeln('');
+
+            if ($job instanceof TimedJob) {
+                $this->printJobInfo($jobId, $job, $output);
+            }
+        } else {
+            $output->writeln('<comment>Job was not executed because it is not due</comment>');
+            $output->writeln('Specify the <question>--force-execute</question> option to run it anyway');
+        }
+
+        return 0;
+    }
+
+    protected function printJobInfo(int $jobId, IJob $job, OutputInterface $output): void {
+        $row = $this->jobList->getDetailsById($jobId);
+
+        $lastRun = new \DateTime();
+        $lastRun->setTimestamp((int)$row['last_run']);
+        $lastChecked = new \DateTime();
+        $lastChecked->setTimestamp((int)$row['last_checked']);
+        $reservedAt = new \DateTime();
+        $reservedAt->setTimestamp((int)$row['reserved_at']);
+
+        $output->writeln('Job class:            ' . get_class($job));
+        $output->writeln('Arguments:            ' . json_encode($job->getArgument()));
+
+        $isTimedJob = $job instanceof TimedJob;
+        if ($isTimedJob) {
+            $output->writeln('Type:                 timed');
+        } elseif ($job instanceof QueuedJob) {
+            $output->writeln('Type:                 queued');
+        } else {
+            $output->writeln('Type:                 job');
+        }
+
+        $output->writeln('');
+        $output->writeln('Last checked:         ' . $lastChecked->format(\DateTimeInterface::ATOM));
+        if ((int)$row['reserved_at'] === 0) {
+            $output->writeln('Reserved at:          -');
+        } else {
+            $output->writeln('Reserved at:          <comment>' . $reservedAt->format(\DateTimeInterface::ATOM) . '</comment>');
+        }
+        $output->writeln('Last executed:        ' . $lastRun->format(\DateTimeInterface::ATOM));
+        $output->writeln('Last duration:        ' . $row['execution_duration']);
+
+        if ($isTimedJob) {
+            $reflection = new \ReflectionClass($job);
+            $intervalProperty = $reflection->getProperty('interval');
+            $intervalProperty->setAccessible(true);
+            $interval = $intervalProperty->getValue($job);
+
+            $nextRun = new \DateTime();
+            $nextRun->setTimestamp($row['last_run'] + $interval);
+
+            if ($nextRun > new \DateTime()) {
+                $output->writeln('Next execution:       <comment>' . $nextRun->format(\DateTimeInterface::ATOM) . '</comment>');
+            } else {
+                $output->writeln('Next execution:       <info>' . $nextRun->format(\DateTimeInterface::ATOM) . '</info>');
+            }
+        }
+    }
 }

Spacing +15 added lines, -15 removed lines

@@ -44,11 +44,11 @@ 
 	}
 
 	protected function execute(InputInterface $input, OutputInterface $output): int {
-		$jobId = (int)$input->getArgument('job-id');
+		$jobId = (int) $input->getArgument('job-id');
 
 		$job = $this->jobList->getById($jobId);
 		if ($job === null) {
-			$output->writeln('<error>Job with ID ' . $jobId . ' could not be found in the database</error>');
+			$output->writeln('<error>Job with ID '.$jobId.' could not be found in the database</error>');
 			return 1;
 		}
 
@@ -66,7 +66,7 @@ 
 
 		$job = $this->jobList->getById($jobId);
 		if ($job === null) {
-			$output->writeln('<error>Something went wrong when trying to retrieve Job with ID ' . $jobId . ' from database</error>');
+			$output->writeln('<error>Something went wrong when trying to retrieve Job with ID '.$jobId.' from database</error>');
 			return 1;
 		}
 		$job->start($this->jobList);
@@ -91,14 +91,14 @@ 
 		$row = $this->jobList->getDetailsById($jobId);
 
 		$lastRun = new \DateTime();
-		$lastRun->setTimestamp((int)$row['last_run']);
+		$lastRun->setTimestamp((int) $row['last_run']);
 		$lastChecked = new \DateTime();
-		$lastChecked->setTimestamp((int)$row['last_checked']);
+		$lastChecked->setTimestamp((int) $row['last_checked']);
 		$reservedAt = new \DateTime();
-		$reservedAt->setTimestamp((int)$row['reserved_at']);
+		$reservedAt->setTimestamp((int) $row['reserved_at']);
 
-		$output->writeln('Job class:            ' . get_class($job));
-		$output->writeln('Arguments:            ' . json_encode($job->getArgument()));
+		$output->writeln('Job class:            '.get_class($job));
+		$output->writeln('Arguments:            '.json_encode($job->getArgument()));
 
 		$isTimedJob = $job instanceof TimedJob;
 		if ($isTimedJob) {
@@ -110,14 +110,14 @@ 
 		}
 
 		$output->writeln('');
-		$output->writeln('Last checked:         ' . $lastChecked->format(\DateTimeInterface::ATOM));
-		if ((int)$row['reserved_at'] === 0) {
+		$output->writeln('Last checked:         '.$lastChecked->format(\DateTimeInterface::ATOM));
+		if ((int) $row['reserved_at'] === 0) {
 			$output->writeln('Reserved at:          -');
 		} else {
-			$output->writeln('Reserved at:          <comment>' . $reservedAt->format(\DateTimeInterface::ATOM) . '</comment>');
+			$output->writeln('Reserved at:          <comment>'.$reservedAt->format(\DateTimeInterface::ATOM).'</comment>');
 		}
-		$output->writeln('Last executed:        ' . $lastRun->format(\DateTimeInterface::ATOM));
-		$output->writeln('Last duration:        ' . $row['execution_duration']);
+		$output->writeln('Last executed:        '.$lastRun->format(\DateTimeInterface::ATOM));
+		$output->writeln('Last duration:        '.$row['execution_duration']);
 
 		if ($isTimedJob) {
 			$reflection = new \ReflectionClass($job);
@@ -129,9 +129,9 @@ 
 			$nextRun->setTimestamp($row['last_run'] + $interval);
 
 			if ($nextRun > new \DateTime()) {
-				$output->writeln('Next execution:       <comment>' . $nextRun->format(\DateTimeInterface::ATOM) . '</comment>');
+				$output->writeln('Next execution:       <comment>'.$nextRun->format(\DateTimeInterface::ATOM).'</comment>');
 			} else {
-				$output->writeln('Next execution:       <info>' . $nextRun->format(\DateTimeInterface::ATOM) . '</info>');
+				$output->writeln('Next execution:       <info>'.$nextRun->format(\DateTimeInterface::ATOM).'</info>');
 			}
 		}
 	}