aboutsummaryrefslogtreecommitdiffstats
path: root/core/BackgroundJobs
diff options
context:
space:
mode:
Diffstat (limited to 'core/BackgroundJobs')
-rw-r--r--core/BackgroundJobs/BackgroundCleanupUpdaterBackupsJob.php68
-rw-r--r--core/BackgroundJobs/CheckForUserCertificates.php46
-rw-r--r--core/BackgroundJobs/CleanupLoginFlowV2.php34
-rw-r--r--core/BackgroundJobs/GenerateMetadataJob.php120
-rw-r--r--core/BackgroundJobs/LookupServerSendCheckBackgroundJob.php52
5 files changed, 188 insertions, 132 deletions
diff --git a/core/BackgroundJobs/BackgroundCleanupUpdaterBackupsJob.php b/core/BackgroundJobs/BackgroundCleanupUpdaterBackupsJob.php
index d699eac3768..d1ecc08ca4b 100644
--- a/core/BackgroundJobs/BackgroundCleanupUpdaterBackupsJob.php
+++ b/core/BackgroundJobs/BackgroundCleanupUpdaterBackupsJob.php
@@ -3,61 +3,46 @@
declare(strict_types=1);
/**
- * @copyright 2018 Morris Jobke <hey@morrisjobke.de>
- *
- * @author Christoph Wurst <christoph@winzerhof-wurst.at>
- * @author Morris Jobke <hey@morrisjobke.de>
- *
- * @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/>.
- *
+ * SPDX-FileCopyrightText: 2018 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OC\Core\BackgroundJobs;
-use OC\BackgroundJob\QueuedJob;
+use OCP\AppFramework\Utility\ITimeFactory;
+use OCP\BackgroundJob\QueuedJob;
+use OCP\Files;
use OCP\IConfig;
-use OCP\ILogger;
+use Psr\Log\LoggerInterface;
class BackgroundCleanupUpdaterBackupsJob extends QueuedJob {
-
- /** @var IConfig */
- protected $config;
- /** @var ILogger */
- protected $log;
-
- public function __construct(IConfig $config, ILogger $log) {
- $this->config = $config;
- $this->log = $log;
+ public function __construct(
+ protected IConfig $config,
+ protected LoggerInterface $log,
+ ITimeFactory $time,
+ ) {
+ parent::__construct($time);
}
/**
* This job cleans up all backups except the latest 3 from the updaters backup directory
*
+ * @param array $argument
*/
- public function run($arguments) {
- $dataDir = $this->config->getSystemValue('datadirectory', \OC::$SERVERROOT . '/data');
+ public function run($argument): void {
+ $this->log->info('Running background job to clean-up outdated updater backups');
+
+ $updateDir = $this->config->getSystemValue('updatedirectory', null) ?? $this->config->getSystemValue('datadirectory', \OC::$SERVERROOT . '/data');
$instanceId = $this->config->getSystemValue('instanceid', null);
if (!is_string($instanceId) || empty($instanceId)) {
+ $this->log->error('Skipping updater backup clean-up - instanceId is missing!');
return;
}
- $updaterFolderPath = $dataDir . '/updater-' . $instanceId;
+ $updaterFolderPath = $updateDir . '/updater-' . $instanceId;
$backupFolderPath = $updaterFolderPath . '/backups';
if (file_exists($backupFolderPath)) {
- $this->log->info("$backupFolderPath exists - start to clean it up");
+ $this->log->debug("Updater backup folder detected: $backupFolderPath");
$dirList = [];
$dirs = new \DirectoryIterator($backupFolderPath);
@@ -71,6 +56,8 @@ class BackgroundCleanupUpdaterBackupsJob extends QueuedJob {
$realPath = $dir->getRealPath();
if ($realPath === false) {
+ $pathName = $dir->getPathname();
+ $this->log->warning("Skipping updater backup folder: $pathName (not found)");
continue;
}
@@ -80,15 +67,18 @@ class BackgroundCleanupUpdaterBackupsJob extends QueuedJob {
ksort($dirList);
// drop the newest 3 directories
$dirList = array_slice($dirList, 0, -3);
- $this->log->info("List of all directories that will be deleted: " . json_encode($dirList));
+ $this->log->debug('Updater backup folders that will be deleted: ' . json_encode($dirList));
foreach ($dirList as $dir) {
$this->log->info("Removing $dir ...");
- \OC_Helper::rmdirr($dir);
+ $result = Files::rmdirr($dir);
+ if (!$result) {
+ $this->log->error('Could not remove updater backup folder $dir');
+ }
}
- $this->log->info("Cleanup finished");
+ $this->log->info('Background job to clean-up updater backups has finished');
} else {
- $this->log->info("Could not find updater directory $backupFolderPath - cleanup step not needed");
+ $this->log->warning("Skipping updater backup clean-up - could not find updater backup folder $backupFolderPath");
}
}
}
diff --git a/core/BackgroundJobs/CheckForUserCertificates.php b/core/BackgroundJobs/CheckForUserCertificates.php
index 6bc3f1c4681..c4ac28905ef 100644
--- a/core/BackgroundJobs/CheckForUserCertificates.php
+++ b/core/BackgroundJobs/CheckForUserCertificates.php
@@ -3,30 +3,13 @@
declare(strict_types=1);
/**
- * @copyright 2020 Morris Jobke <hey@morrisjobke.de>
- *
- * @author J0WI <J0WI@users.noreply.github.com>
- * @author Morris Jobke <hey@morrisjobke.de>
- *
- * @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/>.
- *
+ * SPDX-FileCopyrightText: 2020 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OC\Core\BackgroundJobs;
-use OC\BackgroundJob\QueuedJob;
+use OCP\AppFramework\Utility\ITimeFactory;
+use OCP\BackgroundJob\QueuedJob;
use OCP\Files\Folder;
use OCP\Files\IRootFolder;
use OCP\Files\NotFoundException;
@@ -35,18 +18,13 @@ use OCP\IUser;
use OCP\IUserManager;
class CheckForUserCertificates extends QueuedJob {
-
- /** @var IConfig */
- protected $config;
- /** @var IUserManager */
- private $userManager;
- /** @var IRootFolder */
- private $rootFolder;
-
- public function __construct(IConfig $config, IUserManager $userManager, IRootFolder $rootFolder) {
- $this->config = $config;
- $this->userManager = $userManager;
- $this->rootFolder = $rootFolder;
+ public function __construct(
+ protected IConfig $config,
+ private IUserManager $userManager,
+ private IRootFolder $rootFolder,
+ ITimeFactory $time,
+ ) {
+ parent::__construct($time);
}
/**
@@ -54,7 +32,7 @@ class CheckForUserCertificates extends QueuedJob {
*/
public function run($arguments): void {
$uploadList = [];
- $this->userManager->callForSeenUsers(function (IUser $user) use (&$uploadList) {
+ $this->userManager->callForSeenUsers(function (IUser $user) use (&$uploadList): void {
$userId = $user->getUID();
try {
\OC_Util::setupFS($userId);
diff --git a/core/BackgroundJobs/CleanupLoginFlowV2.php b/core/BackgroundJobs/CleanupLoginFlowV2.php
index 919fbd7e653..e5bcf00a921 100644
--- a/core/BackgroundJobs/CleanupLoginFlowV2.php
+++ b/core/BackgroundJobs/CleanupLoginFlowV2.php
@@ -3,26 +3,8 @@
declare(strict_types=1);
/**
- * @copyright Copyright (c) 2019, Roeland Jago Douma <roeland@famdouma.nl>
- *
- * @author J0WI <J0WI@users.noreply.github.com>
- * @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/>.
- *
+ * SPDX-FileCopyrightText: 2019 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OC\Core\BackgroundJobs;
@@ -31,15 +13,13 @@ use OCP\AppFramework\Utility\ITimeFactory;
use OCP\BackgroundJob\TimedJob;
class CleanupLoginFlowV2 extends TimedJob {
-
- /** @var LoginFlowV2Mapper */
- private $loginFlowV2Mapper;
-
- public function __construct(ITimeFactory $time, LoginFlowV2Mapper $loginFlowV2Mapper) {
+ public function __construct(
+ ITimeFactory $time,
+ private LoginFlowV2Mapper $loginFlowV2Mapper,
+ ) {
parent::__construct($time);
- $this->loginFlowV2Mapper = $loginFlowV2Mapper;
- $this->setInterval(3600);
+ $this->setInterval(60 * 60);
}
protected function run($argument): void {
diff --git a/core/BackgroundJobs/GenerateMetadataJob.php b/core/BackgroundJobs/GenerateMetadataJob.php
new file mode 100644
index 00000000000..cb02a8e4ffa
--- /dev/null
+++ b/core/BackgroundJobs/GenerateMetadataJob.php
@@ -0,0 +1,120 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OC\Core\BackgroundJobs;
+
+use OC\Files\Mount\MoveableMount;
+use OCP\AppFramework\Utility\ITimeFactory;
+use OCP\BackgroundJob\IJobList;
+use OCP\BackgroundJob\TimedJob;
+use OCP\Files\Folder;
+use OCP\Files\IRootFolder;
+use OCP\FilesMetadata\Exceptions\FilesMetadataNotFoundException;
+use OCP\FilesMetadata\IFilesMetadataManager;
+use OCP\IAppConfig;
+use OCP\IConfig;
+use OCP\IUserManager;
+use Psr\Log\LoggerInterface;
+
+class GenerateMetadataJob extends TimedJob {
+ // Default file size limit for metadata generation (MBytes).
+ protected const DEFAULT_MAX_FILESIZE = 256;
+
+ public function __construct(
+ ITimeFactory $time,
+ private IConfig $config,
+ private IAppConfig $appConfig,
+ private IRootFolder $rootFolder,
+ private IUserManager $userManager,
+ private IFilesMetadataManager $filesMetadataManager,
+ private IJobList $jobList,
+ private LoggerInterface $logger,
+ ) {
+ parent::__construct($time);
+
+ $this->setTimeSensitivity(self::TIME_INSENSITIVE);
+ $this->setInterval(24 * 60 * 60);
+ }
+
+ protected function run(mixed $argument): void {
+ if ($this->appConfig->getValueBool('core', 'metadataGenerationDone', false)) {
+ return;
+ }
+
+ $lastHandledUser = $this->appConfig->getValueString('core', 'metadataGenerationLastHandledUser', '');
+
+ $users = $this->userManager->search('');
+
+ // we'll only start timer once we have found a valid user to handle
+ // meaning NOW if we have not handled any user from a previous run
+ $startTime = ($lastHandledUser === '') ? time() : null;
+ foreach ($users as $user) {
+ $userId = $user->getUID();
+
+ // if we already handled a previous run, we start timer only when we face the last handled user
+ if ($startTime === null) {
+ if ($userId === $lastHandledUser) {
+ $startTime = time();
+ }
+ continue;
+ }
+
+ $this->appConfig->setValueString('core', 'metadataGenerationLastHandledUser', $userId);
+ $this->scanFilesForUser($user->getUID());
+
+ // Stop if execution time is more than one hour.
+ if (time() - $startTime > 3600) {
+ return;
+ }
+ }
+
+ $this->appConfig->deleteKey('core', 'metadataGenerationLastHandledUser');
+ $this->appConfig->setValueBool('core', 'metadataGenerationDone', true);
+ }
+
+ private function scanFilesForUser(string $userId): void {
+ $userFolder = $this->rootFolder->getUserFolder($userId);
+ $this->scanFolder($userFolder);
+ }
+
+ private function scanFolder(Folder $folder): void {
+ // Do not scan share and other moveable mounts.
+ if ($folder->getMountPoint() instanceof MoveableMount) {
+ return;
+ }
+
+ foreach ($folder->getDirectoryListing() as $node) {
+ if ($node instanceof Folder) {
+ $this->scanFolder($node);
+ continue;
+ }
+
+ // Don't generate metadata for files bigger than configured metadata_max_filesize
+ // Files are loaded in memory so very big files can lead to an OOM on the server
+ $nodeSize = $node->getSize();
+ $nodeLimit = $this->config->getSystemValueInt('metadata_max_filesize', self::DEFAULT_MAX_FILESIZE);
+ if ($nodeSize > $nodeLimit * 1000000) {
+ $this->logger->debug('Skipping generating metadata for fileid ' . $node->getId() . " as its size exceeds configured 'metadata_max_filesize'.");
+ continue;
+ }
+
+ try {
+ $this->filesMetadataManager->getMetadata($node->getId(), false);
+ } catch (FilesMetadataNotFoundException) {
+ try {
+ $this->filesMetadataManager->refreshMetadata(
+ $node,
+ IFilesMetadataManager::PROCESS_LIVE | IFilesMetadataManager::PROCESS_BACKGROUND
+ );
+ } catch (\Throwable $ex) {
+ $this->logger->warning('Error while generating metadata for fileid ' . $node->getId(), ['exception' => $ex]);
+ }
+ }
+ }
+ }
+}
diff --git a/core/BackgroundJobs/LookupServerSendCheckBackgroundJob.php b/core/BackgroundJobs/LookupServerSendCheckBackgroundJob.php
index 282c56f37f1..86622e58758 100644
--- a/core/BackgroundJobs/LookupServerSendCheckBackgroundJob.php
+++ b/core/BackgroundJobs/LookupServerSendCheckBackgroundJob.php
@@ -3,48 +3,36 @@
declare(strict_types=1);
/**
- * @copyright Copyright (c) 2021 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/>.
- *
+ * SPDX-FileCopyrightText: 2021 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OC\Core\BackgroundJobs;
-use OC\BackgroundJob\QueuedJob;
+use OCP\AppFramework\Utility\ITimeFactory;
+use OCP\BackgroundJob\QueuedJob;
use OCP\IConfig;
use OCP\IUser;
use OCP\IUserManager;
class LookupServerSendCheckBackgroundJob extends QueuedJob {
-
- /** @var IConfig */
- protected $config;
- /** @var IUserManager */
- private $userManager;
-
- public function __construct(IConfig $config, IUserManager $userManager) {
- $this->config = $config;
- $this->userManager = $userManager;
+ public function __construct(
+ protected IConfig $config,
+ private IUserManager $userManager,
+ ITimeFactory $time,
+ ) {
+ parent::__construct($time);
}
- public function run($arguments) {
- $this->userManager->callForSeenUsers(function (IUser $user) {
- $this->config->setUserValue($user->getUID(), 'lookup_server_connector', 'dataSend', '1');
+ /**
+ * @param array $argument
+ */
+ public function run($argument): void {
+ $this->userManager->callForSeenUsers(function (IUser $user): void {
+ // If the user data was not updated yet (check if LUS is enabled and if then update on LUS or delete on LUS)
+ // then we need to flag the user data to be checked
+ if ($this->config->getUserValue($user->getUID(), 'lookup_server_connector', 'dataSend', '') === '') {
+ $this->config->setUserValue($user->getUID(), 'lookup_server_connector', 'dataSend', '1');
+ }
});
}
}
generated by cgit v1.2.3 (git 2.39.1) at 2025-08-15 20:50:16 +0000