aboutsummaryrefslogtreecommitdiffstats
path: root/apps/files_external/lib/Command/Notify.php
diff options
context:
space:
mode:
Diffstat (limited to 'apps/files_external/lib/Command/Notify.php')
-rw-r--r--apps/files_external/lib/Command/Notify.php283
1 files changed, 93 insertions, 190 deletions
diff --git a/apps/files_external/lib/Command/Notify.php b/apps/files_external/lib/Command/Notify.php
index 31919ba2d2a..0982aa5598b 100644
--- a/apps/files_external/lib/Command/Notify.php
+++ b/apps/files_external/lib/Command/Notify.php
@@ -1,36 +1,14 @@
<?php
+
+declare(strict_types=1);
+
/**
- * @copyright Copyright (c) 2016 Robin Appelman <robin@icewind.nl>
- *
- * @author Ari Selseng <ari@selseng.net>
- * @author Christoph Wurst <christoph@winzerhof-wurst.at>
- * @author Joas Schilling <coding@schilljs.com>
- * @author Robin Appelman <robin@icewind.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: 2016 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
*/
-
namespace OCA\Files_External\Command;
use Doctrine\DBAL\Exception\DriverException;
-use OC\Core\Command\Base;
-use OCA\Files_External\Lib\InsufficientDataForMeaningfulAnswerException;
-use OCA\Files_External\Lib\StorageConfig;
use OCA\Files_External\Service\GlobalStoragesService;
use OCP\DB\QueryBuilder\IQueryBuilder;
use OCP\Files\Notify\IChange;
@@ -38,39 +16,25 @@ use OCP\Files\Notify\INotifyHandler;
use OCP\Files\Notify\IRenameChange;
use OCP\Files\Storage\INotifyStorage;
use OCP\Files\Storage\IStorage;
-use OCP\Files\StorageNotAvailableException;
use OCP\IDBConnection;
-use OCP\ILogger;
use OCP\IUserManager;
+use Psr\Log\LoggerInterface;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
-class Notify extends Base {
- /** @var GlobalStoragesService */
- private $globalService;
- /** @var IDBConnection */
- private $connection;
- /** @var ILogger */
- private $logger;
- /** @var IUserManager */
- private $userManager;
-
+class Notify extends StorageAuthBase {
public function __construct(
+ private IDBConnection $connection,
+ private LoggerInterface $logger,
GlobalStoragesService $globalService,
- IDBConnection $connection,
- ILogger $logger,
- IUserManager $userManager
+ IUserManager $userManager,
) {
- parent::__construct();
- $this->globalService = $globalService;
- $this->connection = $connection;
- $this->logger = $logger;
- $this->userManager = $userManager;
+ parent::__construct($globalService, $userManager);
}
- protected function configure() {
+ protected function configure(): void {
$this
->setName('files_external:notify')
->setDescription('Listen for active update notifications for a configured external mount')
@@ -99,156 +63,100 @@ class Notify extends Base {
'',
InputOption::VALUE_NONE,
'Disable self check on startup'
+ )->addOption(
+ 'dry-run',
+ '',
+ InputOption::VALUE_NONE,
+ 'Don\'t make any changes, only log detected changes'
);
parent::configure();
}
- private function getUserOption(InputInterface $input): ?string {
- if ($input->getOption('user')) {
- return (string)$input->getOption('user');
- } elseif (isset($_ENV['NOTIFY_USER'])) {
- return (string)$_ENV['NOTIFY_USER'];
- } elseif (isset($_SERVER['NOTIFY_USER'])) {
- return (string)$_SERVER['NOTIFY_USER'];
- } else {
- return null;
- }
- }
-
- private function getPasswordOption(InputInterface $input): ?string {
- if ($input->getOption('password')) {
- return (string)$input->getOption('password');
- } elseif (isset($_ENV['NOTIFY_PASSWORD'])) {
- return (string)$_ENV['NOTIFY_PASSWORD'];
- } elseif (isset($_SERVER['NOTIFY_PASSWORD'])) {
- return (string)$_SERVER['NOTIFY_PASSWORD'];
- } else {
- return null;
- }
- }
-
protected function execute(InputInterface $input, OutputInterface $output): int {
- $mount = $this->globalService->getStorage($input->getArgument('mount_id'));
- if (is_null($mount)) {
- $output->writeln('<error>Mount not found</error>');
- return 1;
- }
- $noAuth = false;
-
- $userOption = $this->getUserOption($input);
- $passwordOption = $this->getPasswordOption($input);
-
- // if only the user is provided, we get the user object to pass along to the auth backend
- // this allows using saved user credentials
- $user = ($userOption && !$passwordOption) ? $this->userManager->get($userOption) : null;
-
- try {
- $authBackend = $mount->getAuthMechanism();
- $authBackend->manipulateStorageConfig($mount, $user);
- } catch (InsufficientDataForMeaningfulAnswerException $e) {
- $noAuth = true;
- } catch (StorageNotAvailableException $e) {
- $noAuth = true;
- }
-
- if ($userOption) {
- $mount->setBackendOption('user', $userOption);
- }
- if ($passwordOption) {
- $mount->setBackendOption('password', $passwordOption);
- }
-
- try {
- $backend = $mount->getBackend();
- $backend->manipulateStorageConfig($mount, $user);
- } catch (InsufficientDataForMeaningfulAnswerException $e) {
- $noAuth = true;
- } catch (StorageNotAvailableException $e) {
- $noAuth = true;
+ [$mount, $storage] = $this->createStorage($input, $output);
+ if ($storage === null) {
+ return self::FAILURE;
}
- try {
- $storage = $this->createStorage($mount);
- } catch (\Exception $e) {
- $output->writeln('<error>Error while trying to create storage</error>');
- if ($noAuth) {
- $output->writeln('<error>Username and/or password required</error>');
- }
- return 1;
- }
if (!$storage instanceof INotifyStorage) {
$output->writeln('<error>Mount of type "' . $mount->getBackend()->getText() . '" does not support active update notifications</error>');
- return 1;
+ return self::FAILURE;
}
- $verbose = $input->getOption('verbose');
+ $dryRun = $input->getOption('dry-run');
+ if ($dryRun && $output->getVerbosity() < OutputInterface::VERBOSITY_VERBOSE) {
+ $output->setVerbosity(OutputInterface::VERBOSITY_VERBOSE);
+ }
$path = trim($input->getOption('path'), '/');
$notifyHandler = $storage->notify($path);
if (!$input->getOption('no-self-check')) {
- $this->selfTest($storage, $notifyHandler, $verbose, $output);
+ $this->selfTest($storage, $notifyHandler, $output);
}
- $notifyHandler->listen(function (IChange $change) use ($mount, $verbose, $output) {
- if ($verbose) {
- $this->logUpdate($change, $output);
- }
+ $notifyHandler->listen(function (IChange $change) use ($mount, $output, $dryRun): void {
+ $this->logUpdate($change, $output);
if ($change instanceof IRenameChange) {
- $this->markParentAsOutdated($mount->getId(), $change->getTargetPath(), $output);
+ $this->markParentAsOutdated($mount->getId(), $change->getTargetPath(), $output, $dryRun);
}
- $this->markParentAsOutdated($mount->getId(), $change->getPath(), $output);
+ $this->markParentAsOutdated($mount->getId(), $change->getPath(), $output, $dryRun);
});
- return 0;
+ return self::SUCCESS;
}
- private function createStorage(StorageConfig $mount) {
- $class = $mount->getBackend()->getStorageClass();
- return new $class($mount->getBackendOptions());
- }
-
- private function markParentAsOutdated($mountId, $path, OutputInterface $output) {
+ private function markParentAsOutdated($mountId, $path, OutputInterface $output, bool $dryRun): void {
$parent = ltrim(dirname($path), '/');
if ($parent === '.') {
$parent = '';
}
try {
- $storageIds = $this->getStorageIds($mountId);
+ $storages = $this->getStorageIds($mountId, $parent);
} catch (DriverException $ex) {
- $this->logger->logException($ex, ['message' => 'Error while trying to find correct storage ids.', 'level' => ILogger::WARN]);
+ $this->logger->warning('Error while trying to find correct storage ids.', ['exception' => $ex]);
$this->connection = $this->reconnectToDatabase($this->connection, $output);
$output->writeln('<info>Needed to reconnect to the database</info>');
- $storageIds = $this->getStorageIds($mountId);
+ $storages = $this->getStorageIds($mountId, $path);
}
- if (count($storageIds) === 0) {
- throw new StorageNotAvailableException('No storages found by mount ID ' . $mountId);
+ if (count($storages) === 0) {
+ $output->writeln(" no users found with access to '$parent', skipping", OutputInterface::VERBOSITY_VERBOSE);
+ return;
}
- $storageIds = array_map('intval', $storageIds);
- $result = $this->updateParent($storageIds, $parent);
- if ($result === 0) {
- //TODO: Find existing parent further up the tree in the database and register that folder instead.
- $this->logger->info('Failed updating parent for "' . $path . '" while trying to register change. It may not exist in the filecache.');
+ $users = array_map(function (array $storage) {
+ return $storage['user_id'];
+ }, $storages);
+
+ $output->writeln(" marking '$parent' as outdated for " . implode(', ', $users), OutputInterface::VERBOSITY_VERBOSE);
+
+ $storageIds = array_map(function (array $storage) {
+ return intval($storage['storage_id']);
+ }, $storages);
+ $storageIds = array_values(array_unique($storageIds));
+
+ if ($dryRun) {
+ $output->writeln(' dry-run: skipping database write');
+ } else {
+ $result = $this->updateParent($storageIds, $parent);
+ if ($result === 0) {
+ //TODO: Find existing parent further up the tree in the database and register that folder instead.
+ $this->logger->info('Failed updating parent for "' . $path . '" while trying to register change. It may not exist in the filecache.');
+ }
}
}
- private function logUpdate(IChange $change, OutputInterface $output) {
- switch ($change->getType()) {
- case INotifyStorage::NOTIFY_ADDED:
- $text = 'added';
- break;
- case INotifyStorage::NOTIFY_MODIFIED:
- $text = 'modified';
- break;
- case INotifyStorage::NOTIFY_REMOVED:
- $text = 'removed';
- break;
- case INotifyStorage::NOTIFY_RENAMED:
- $text = 'renamed';
- break;
- default:
- return;
+ private function logUpdate(IChange $change, OutputInterface $output): void {
+ $text = match ($change->getType()) {
+ INotifyStorage::NOTIFY_ADDED => 'added',
+ INotifyStorage::NOTIFY_MODIFIED => 'modified',
+ INotifyStorage::NOTIFY_REMOVED => 'removed',
+ INotifyStorage::NOTIFY_RENAMED => 'renamed',
+ default => '',
+ };
+
+ if ($text === '') {
+ return;
}
$text .= ' ' . $change->getPath();
@@ -256,29 +164,23 @@ class Notify extends Base {
$text .= ' to ' . $change->getTargetPath();
}
- $output->writeln($text);
+ $output->writeln($text, OutputInterface::VERBOSITY_VERBOSE);
}
- /**
- * @param int $mountId
- * @return array
- */
- private function getStorageIds($mountId) {
+ private function getStorageIds(int $mountId, string $path): array {
+ $pathHash = md5(trim(\OC_Util::normalizeUnicode($path), '/'));
$qb = $this->connection->getQueryBuilder();
return $qb
- ->select('storage_id')
- ->from('mounts')
+ ->select('storage_id', 'user_id')
+ ->from('mounts', 'm')
+ ->innerJoin('m', 'filecache', 'f', $qb->expr()->eq('m.storage_id', 'f.storage'))
->where($qb->expr()->eq('mount_id', $qb->createNamedParameter($mountId, IQueryBuilder::PARAM_INT)))
+ ->andWhere($qb->expr()->eq('path_hash', $qb->createNamedParameter($pathHash, IQueryBuilder::PARAM_STR)))
->execute()
- ->fetchAll(\PDO::FETCH_COLUMN);
+ ->fetchAll();
}
- /**
- * @param array $storageIds
- * @param string $parent
- * @return int
- */
- private function updateParent($storageIds, $parent) {
+ private function updateParent(array $storageIds, string $parent): int {
$pathHash = md5(trim(\OC_Util::normalizeUnicode($parent), '/'));
$qb = $this->connection->getQueryBuilder();
return $qb
@@ -286,24 +188,22 @@ class Notify extends Base {
->set('size', $qb->createNamedParameter(-1, IQueryBuilder::PARAM_INT))
->where($qb->expr()->in('storage', $qb->createNamedParameter($storageIds, IQueryBuilder::PARAM_INT_ARRAY, ':storage_ids')))
->andWhere($qb->expr()->eq('path_hash', $qb->createNamedParameter($pathHash, IQueryBuilder::PARAM_STR)))
- ->execute();
+ ->executeStatement();
}
- /**
- * @return \OCP\IDBConnection
- */
- private function reconnectToDatabase(IDBConnection $connection, OutputInterface $output) {
+ private function reconnectToDatabase(IDBConnection $connection, OutputInterface $output): IDBConnection {
try {
$connection->close();
} catch (\Exception $ex) {
- $this->logger->logException($ex, ['app' => 'files_external', 'message' => 'Error while disconnecting from DB', 'level' => ILogger::WARN]);
+ $this->logger->warning('Error while disconnecting from DB', ['exception' => $ex]);
$output->writeln("<info>Error while disconnecting from database: {$ex->getMessage()}</info>");
}
- while (!$connection->isConnected()) {
+ $connected = false;
+ while (!$connected) {
try {
- $connection->connect();
+ $connected = $connection->connect();
} catch (\Exception $ex) {
- $this->logger->logException($ex, ['app' => 'files_external', 'message' => 'Error while re-connecting to database', 'level' => ILogger::WARN]);
+ $this->logger->warning('Error while re-connecting to database', ['exception' => $ex]);
$output->writeln("<info>Error while re-connecting to database: {$ex->getMessage()}</info>");
sleep(60);
}
@@ -312,9 +212,12 @@ class Notify extends Base {
}
- private function selfTest(IStorage $storage, INotifyHandler $notifyHandler, $verbose, OutputInterface $output) {
+ private function selfTest(IStorage $storage, INotifyHandler $notifyHandler, OutputInterface $output): void {
usleep(100 * 1000); //give time for the notify to start
- $storage->file_put_contents('/.nc_test_file.txt', 'test content');
+ if (!$storage->file_put_contents('/.nc_test_file.txt', 'test content')) {
+ $output->writeln('Failed to create test file for self-test');
+ return;
+ }
$storage->mkdir('/.nc_test_folder');
$storage->file_put_contents('/.nc_test_folder/subfile.txt', 'test content');
@@ -339,11 +242,11 @@ class Notify extends Base {
}
}
- if ($foundRootChange && $foundSubfolderChange && $verbose) {
- $output->writeln('<info>Self-test successful</info>');
- } elseif ($foundRootChange && !$foundSubfolderChange) {
+ if ($foundRootChange && $foundSubfolderChange) {
+ $output->writeln('<info>Self-test successful</info>', OutputInterface::VERBOSITY_VERBOSE);
+ } elseif ($foundRootChange) {
$output->writeln('<error>Error while running self-test, change is subfolder not detected</error>');
- } elseif (!$foundRootChange) {
+ } else {
$output->writeln('<error>Error while running self-test, no changes detected</error>');
}
}
generated by cgit v1.2.3 (git 2.39.1) at 2025-08-16 14:34:37 +0000