Merge pull request #32211 from nextcloud/feat/repair_share_ownership

Add repair command to fix wrong share ownership
2022-11-08 18:57:03 +01:00 · 2022-11-08 18:57:03 +01:00 · 87f4ed55e5
parent ad77bf4030 6d8c72c9f6
commit 87f4ed55e5
4 changed files with 199 additions and 0 deletions
--- a/core/Command/Maintenance/RepairShareOwnership.php
+++ b/core/Command/Maintenance/RepairShareOwnership.php
@ -0,0 +1,196 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2020 Arthur Schiwon <blizzz@arthur-schiwon.de>
+ *
+ * @author Arthur Schiwon <blizzz@arthur-schiwon.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/>.
+ *
+ */
+
+namespace OC\Core\Command\Maintenance;
+
+use Symfony\Component\Console\Command\Command;
+use OCP\DB\QueryBuilder\IQueryBuilder;
+use OCP\IDBConnection;
+use OCP\IUser;
+use OCP\IUserManager;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Question\ConfirmationQuestion;
+
+class RepairShareOwnership extends Command {
+	private IDBConnection $dbConnection;
+	private IUserManager $userManager;
+
+	public function __construct(
+		IDBConnection $dbConnection,
+		IUserManager $userManager
+	) {
+		$this->dbConnection = $dbConnection;
+		$this->userManager = $userManager;
+		parent::__construct();
+	}
+
+	protected function configure() {
+		$this
+			->setName('maintenance:repair-share-owner')
+			->setDescription('repair invalid share-owner entries in the database')
+			->addOption('no-confirm', 'y', InputOption::VALUE_NONE, "Don't ask for confirmation before repairing the shares")
+			->addArgument('user', InputArgument::OPTIONAL, "User to fix incoming shares for, if omitted all users will be fixed");
+	}
+
+	protected function execute(InputInterface $input, OutputInterface $output): int {
+		$noConfirm = $input->getOption('no-confirm');
+		$userId = $input->getArgument('user');
+		if ($userId) {
+			$user = $this->userManager->get($userId);
+			if (!$user) {
+				$output->writeln("<error>user $userId not found</error>");
+				return 1;
+			}
+			$shares = $this->getWrongShareOwnershipForUser($user);
+		} else {
+			$shares = $this->getWrongShareOwnership();
+		}
+
+		if ($shares) {
+			$output->writeln("");
+			$output->writeln("Found " . count($shares) . " shares with invalid share owner");
+			foreach ($shares as $share) {
+				/** @var array{shareId: int, fileTarget: string, initiator: string, receiver: string, owner: string, mountOwner: string} $share */
+				$output->writeln(" - share ${share['shareId']} from \"${share['initiator']}\" to \"${share['receiver']}\" at \"${share['fileTarget']}\", owned by \"${share['owner']}\", that should be owned by \"${share['mountOwner']}\"");
+			}
+			$output->writeln("");
+
+			if (!$noConfirm) {
+				$helper = $this->getHelper('question');
+				$question = new ConfirmationQuestion('Repair these shares? [y/N]', false);
+
+				if (!$helper->ask($input, $output, $question)) {
+					return 0;
+				}
+			}
+			$output->writeln("Repairing " . count($shares) . " shares");
+			$this->repairShares($shares);
+		} else {
+			$output->writeln("Found no shares with invalid share owner");
+		}
+
+		return 0;
+	}
+
+	/**
+	 * @return array{shareId: int, fileTarget: string, initiator: string, receiver: string, owner: string, mountOwner: string}[]
+	 * @throws \OCP\DB\Exception
+	 */
+	protected function getWrongShareOwnership(): array {
+		$qb = $this->dbConnection->getQueryBuilder();
+		$brokenShares = $qb
+			->select('s.id', 'm.user_id', 's.uid_owner', 's.uid_initiator', 's.share_with', 's.file_target')
+			->from('share', 's')
+			->join('s', 'filecache', 'f', $qb->expr()->eq('s.item_source', $qb->expr()->castColumn('f.fileid', IQueryBuilder::PARAM_STR)))
+			->join('s', 'mounts', 'm', $qb->expr()->eq('f.storage', 'm.storage_id'))
+			->where($qb->expr()->neq('m.user_id', 's.uid_owner'))
+			->andWhere($qb->expr()->eq($qb->func()->concat($qb->expr()->literal('/'), 'm.user_id', $qb->expr()->literal('/')), 'm.mount_point'))
+			->executeQuery()
+			->fetchAll();
+
+		$found = [];
+
+		foreach ($brokenShares as $share) {
+			$found[] = [
+				'shareId' => (int) $share['id'],
+				'fileTarget' => $share['file_target'],
+				'initiator' => $share['uid_initiator'],
+				'receiver' => $share['share_with'],
+				'owner' => $share['uid_owner'],
+				'mountOwner' => $share['user_id'],
+			];
+		}
+
+		return $found;
+	}
+
+	/**
+	 * @param IUser $user
+	 * @return array{shareId: int, fileTarget: string, initiator: string, receiver: string, owner: string, mountOwner: string}[]
+	 * @throws \OCP\DB\Exception
+	 */
+	protected function getWrongShareOwnershipForUser(IUser $user): array {
+		$qb = $this->dbConnection->getQueryBuilder();
+		$brokenShares = $qb
+			->select('s.id', 'm.user_id', 's.uid_owner', 's.uid_initiator', 's.share_with', 's.file_target')
+			->from('share', 's')
+			->join('s', 'filecache', 'f', $qb->expr()->eq('s.item_source', $qb->expr()->castColumn('f.fileid', IQueryBuilder::PARAM_STR)))
+			->join('s', 'mounts', 'm', $qb->expr()->eq('f.storage', 'm.storage_id'))
+			->where($qb->expr()->neq('m.user_id', 's.uid_owner'))
+			->andWhere($qb->expr()->eq($qb->func()->concat($qb->expr()->literal('/'), 'm.user_id', $qb->expr()->literal('/')), 'm.mount_point'))
+			->andWhere($qb->expr()->eq('s.share_with', $qb->createNamedParameter($user->getUID())))
+			->executeQuery()
+			->fetchAll();
+
+		$found = [];
+
+		foreach ($brokenShares as $share) {
+			$found[] = [
+				'shareId' => (int) $share['id'],
+				'fileTarget' => $share['file_target'],
+				'initiator' => $share['uid_initiator'],
+				'receiver' => $share['share_with'],
+				'owner' => $share['uid_owner'],
+				'mountOwner' => $share['user_id'],
+			];
+		}
+
+		return $found;
+	}
+
+	/**
+	 * @param array{shareId: int, fileTarget: string, initiator: string, receiver: string, owner: string, mountOwner: string}[] $shares
+	 * @return void
+	 */
+	protected function repairShares(array $shares) {
+		$this->dbConnection->beginTransaction();
+
+		$update = $this->dbConnection->getQueryBuilder();
+		$update->update('share')
+			->set('uid_owner', $update->createParameter('share_owner'))
+			->set('uid_initiator', $update->createParameter('share_initiator'))
+			->where($update->expr()->eq('id', $update->createParameter('share_id')));
+
+		foreach ($shares as $share) {
+			/** @var array{shareId: int, fileTarget: string, initiator: string, receiver: string, owner: string, mountOwner: string} $share */
+			$update->setParameter('share_id', $share['shareId'], IQueryBuilder::PARAM_INT);
+			$update->setParameter('share_owner', $share['mountOwner']);
+
+			// if the broken owner is also the initiator it's safe to update them both, otherwise we don't touch the initiator
+			if ($share['initiator'] === $share['owner']) {
+				$update->setParameter('share_initiator', $share['mountOwner']);
+			} else {
+				$update->setParameter('share_initiator', $share['initiator']);
+			}
+			$update->executeStatement();
+		}
+
+		$this->dbConnection->commit();
+	}
+}
--- a/core/register_command.php
+++ b/core/register_command.php
@ -173,6 +173,7 @@ if (\OC::$server->getConfig()->getSystemValue('installed', false)) {
 		\OC::$server->get(\OCP\EventDispatcher\IEventDispatcher::class),
 		\OC::$server->getAppManager()
 	));
+	$application->add(\OC::$server->query(OC\Core\Command\Maintenance\RepairShareOwnership::class));

 	$application->add(\OC::$server->query(\OC\Core\Command\Preview\Repair::class));
 	$application->add(\OC::$server->query(\OC\Core\Command\Preview\ResetRenderedTexts::class));
--- a/lib/composer/composer/autoload_classmap.php
+++ b/lib/composer/composer/autoload_classmap.php
@ -942,6 +942,7 @@ return array(
    'OC\\Core\\Command\\Maintenance\\Mimetype\\UpdateJS' => $baseDir . '/core/Command/Maintenance/Mimetype/UpdateJS.php',
    'OC\\Core\\Command\\Maintenance\\Mode' => $baseDir . '/core/Command/Maintenance/Mode.php',
    'OC\\Core\\Command\\Maintenance\\Repair' => $baseDir . '/core/Command/Maintenance/Repair.php',
+    'OC\\Core\\Command\\Maintenance\\RepairShareOwnership' => $baseDir . '/core/Command/Maintenance/RepairShareOwnership.php',
    'OC\\Core\\Command\\Maintenance\\UpdateHtaccess' => $baseDir . '/core/Command/Maintenance/UpdateHtaccess.php',
    'OC\\Core\\Command\\Maintenance\\UpdateTheme' => $baseDir . '/core/Command/Maintenance/UpdateTheme.php',
    'OC\\Core\\Command\\Preview\\Repair' => $baseDir . '/core/Command/Preview/Repair.php',
--- a/lib/composer/composer/autoload_static.php
+++ b/lib/composer/composer/autoload_static.php
@ -975,6 +975,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
        'OC\\Core\\Command\\Maintenance\\Mimetype\\UpdateJS' => __DIR__ . '/../../..' . '/core/Command/Maintenance/Mimetype/UpdateJS.php',
        'OC\\Core\\Command\\Maintenance\\Mode' => __DIR__ . '/../../..' . '/core/Command/Maintenance/Mode.php',
        'OC\\Core\\Command\\Maintenance\\Repair' => __DIR__ . '/../../..' . '/core/Command/Maintenance/Repair.php',
+        'OC\\Core\\Command\\Maintenance\\RepairShareOwnership' => __DIR__ . '/../../..' . '/core/Command/Maintenance/RepairShareOwnership.php',
        'OC\\Core\\Command\\Maintenance\\UpdateHtaccess' => __DIR__ . '/../../..' . '/core/Command/Maintenance/UpdateHtaccess.php',
        'OC\\Core\\Command\\Maintenance\\UpdateTheme' => __DIR__ . '/../../..' . '/core/Command/Maintenance/UpdateTheme.php',
        'OC\\Core\\Command\\Preview\\Repair' => __DIR__ . '/../../..' . '/core/Command/Preview/Repair.php',