aboutsummaryrefslogtreecommitdiffstats
path: root/cron.php
diff options
context:
space:
mode:
Diffstat (limited to 'cron.php')
-rw-r--r--cron.php215
1 files changed, 144 insertions, 71 deletions
diff --git a/cron.php b/cron.php
index a58ef2c206f..0501c53ff40 100644
--- a/cron.php
+++ b/cron.php
@@ -1,79 +1,87 @@
<?php
+
+declare(strict_types=1);
+
+use OC\Files\SetupManager;
+use OC\Session\CryptoWrapper;
+use OC\Session\Memory;
+use OCP\ILogger;
+
/**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- *
- * @author Artem Sidorenko <artem@posteo.de>
- * @author Christopher Schäpers <kondou@ts.unde.re>
- * @author Christoph Wurst <christoph@winzerhof-wurst.at>
- * @author Daniel Kesselberg <mail@danielkesselberg.de>
- * @author hoellen <dev@hoellen.eu>
- * @author J0WI <J0WI@users.noreply.github.com>
- * @author Jakob Sack <mail@jakobsack.de>
- * @author Joas Schilling <coding@schilljs.com>
- * @author Jörn Friedrich Dreyer <jfd@butonic.de>
- * @author Ko- <k.stoffelen@cs.ru.nl>
- * @author Michael Kuhn <michael@ikkoku.de>
- * @author Morris Jobke <hey@morrisjobke.de>
- * @author Oliver Kohl D.Sc. <oliver@kohl.bz>
- * @author Robin Appelman <robin@icewind.nl>
- * @author Roeland Jago Douma <roeland@famdouma.nl>
- * @author Steffen Lindner <mail@steffen-lindner.de>
- * @author Thomas Müller <thomas.mueller@tmit.eu>
- * @author Vincent Petry <vincent@nextcloud.com>
- * @author Stephen Michel <git@smichel.me>
- *
- * @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/>
- *
+ * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
+ * SPDX-License-Identifier: AGPL-3.0-only
*/
+
require_once __DIR__ . '/lib/versioncheck.php';
+use OCP\App\IAppManager;
+use OCP\BackgroundJob\IJobList;
+use OCP\IAppConfig;
+use OCP\IConfig;
+use OCP\ISession;
+use OCP\ITempManager;
+use OCP\Server;
+use OCP\Util;
+use Psr\Log\LoggerInterface;
+
try {
require_once __DIR__ . '/lib/base.php';
- if (\OCP\Util::needUpgrade()) {
- \OC::$server->getLogger()->debug('Update required, skipping cron', ['app' => 'cron']);
+ if (isset($argv[1]) && ($argv[1] === '-h' || $argv[1] === '--help')) {
+ echo 'Description:
+ Run the background job routine
+
+Usage:
+ php -f cron.php -- [-h] [--verbose] [<job-classes>...]
+
+Arguments:
+ job-classes Optional job class list to only run those jobs
+ Providing a class will ignore the time-sensitivity restriction
+
+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;
}
- if ((bool) \OC::$server->getSystemConfig()->getValue('maintenance', false)) {
- \OC::$server->getLogger()->debug('We are in maintenance mode, skipping cron', ['app' => 'cron']);
+
+ $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
- OC_App::loadApps();
+ Server::get(IAppManager::class)->loadApps();
+ Server::get(ISession::class)->close();
- \OC::$server->getSession()->close();
+ $verbose = isset($argv[1]) && ($argv[1] === '-v' || $argv[1] === '--verbose');
// initialize a dummy memory session
- $session = new \OC\Session\Memory('');
- $cryptoWrapper = \OC::$server->getSessionCryptoWrapper();
+ $session = new Memory();
+ $cryptoWrapper = Server::get(CryptoWrapper::class);
$session = $cryptoWrapper->wrapSession($session);
\OC::$server->setSession($session);
- $logger = \OC::$server->getLogger();
- $config = \OC::$server->getConfig();
-
- // Don't do anything if Nextcloud has not been installed
- if (!$config->getSystemValue('installed', false)) {
- exit(0);
- }
+ $logger = Server::get(LoggerInterface::class);
+ $appConfig = Server::get(IAppConfig::class);
+ $tempManager = Server::get(ITempManager::class);
- \OC::$server->getTempManager()->cleanOld();
+ $tempManager->cleanOld();
// Exit if background jobs are disabled!
- $appMode = $config->getAppValue('core', 'backgroundjobs_mode', 'ajax');
+ $appMode = $appConfig->getValueString('core', 'backgroundjobs_mode', 'ajax');
if ($appMode === 'none') {
if (OC::$CLI) {
echo 'Background Jobs are disabled!' . PHP_EOL;
@@ -91,31 +99,35 @@ try {
// 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');
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);
}
// We call Nextcloud from the CLI (aka cron)
if ($appMode !== 'cron') {
- $config->setAppValue('core', 'backgroundjobs_mode', '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 ($startHour <= 23) {
+ 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) {
@@ -133,7 +145,7 @@ try {
}
// Work
- $jobList = \OC::$server->getJobList();
+ $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
@@ -141,22 +153,76 @@ try {
$endTime = time() + 14 * 60;
$executedJobs = [];
- while ($job = $jobList->getNext($onlyTimeSensitive)) {
+
+ while ($job = $jobList->getNext($onlyTimeSensitive, $jobClasses)) {
if (isset($executedJobs[$job->getId()])) {
$jobList->unlockJob($job);
break;
}
- $logger->debug('CLI cron call has selected job with ID ' . strval($job->getId()), ['app' => 'cron']);
- $job->execute($jobList, $logger);
+ $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;
+ }
+
+ /** @psalm-suppress DeprecatedMethod Calling execute until it is removed, then will switch to start */
+ $job->execute($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
- \OC_Util::tearDownFS();
+ 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 (time() > $endTime) {
+ if ($timeAfter > $endTime) {
break;
}
}
@@ -167,11 +233,12 @@ try {
OC_JSON::error(['data' => ['message' => 'Backgroundjobs are using system cron!']]);
} else {
// Work and success :-)
- $jobList = \OC::$server->getJobList();
+ $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->execute($jobList, $logger);
+ /** @psalm-suppress DeprecatedMethod Calling execute until it is removed, then will switch to start */
+ $job->execute($jobList);
$jobList->setLastJob($job);
}
OC_JSON::success();
@@ -179,14 +246,20 @@ try {
}
// Log the successful cron execution
- $config->setAppValue('core', 'lastcron', time());
+ $appConfig->setValueInt('core', 'lastcron', time());
exit();
} catch (Exception $ex) {
- \OC::$server->getLogger()->logException($ex, ['app' => 'cron']);
+ Server::get(LoggerInterface::class)->error(
+ $ex->getMessage(),
+ ['app' => 'cron', 'exception' => $ex]
+ );
echo $ex . PHP_EOL;
exit(1);
} catch (Error $ex) {
- \OC::$server->getLogger()->logException($ex, ['app' => 'cron']);
+ Server::get(LoggerInterface::class)->error(
+ $ex->getMessage(),
+ ['app' => 'cron', 'exception' => $ex]
+ );
echo $ex . PHP_EOL;
exit(1);
}
generated by cgit v1.2.3 (git 2.39.1) at 2025-08-15 05:38:22 +0000