nextcloud-server-mirror/lib/private/Repair/RepairInvalidShares.php

<?php

/**
 * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
 * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
 * SPDX-License-Identifier: AGPL-3.0-only
 */

namespace OC\Repair;

use OC\Core\AppInfo\ConfigLexicon;
use OCP\Constants;
use OCP\DB\QueryBuilder\IQueryBuilder;
use OCP\IAppConfig;
use OCP\IConfig;
use OCP\IDBConnection;
use OCP\Migration\IOutput;
use OCP\Migration\IRepairStep;

/**
 * Repairs shares with invalid data
 */
class RepairInvalidShares implements IRepairStep {
	public const CHUNK_SIZE = 200;

	public function __construct(
		protected IConfig $config,
		protected IDBConnection $connection,
		protected IAppConfig $appConfig,
	) {
	}

	#[\Override]
	public function getName(): string {
		return 'Repair invalid shares';
	}

	/**
	 * Adjust file share permissions
	 */
	private function adjustFileSharePermissions(IOutput $output): void {
		$mask = Constants::PERMISSION_READ | Constants::PERMISSION_UPDATE | Constants::PERMISSION_SHARE;
		$builder = $this->connection->getQueryBuilder();

		$permsFunc = $builder->expr()->bitwiseAnd('permissions', $mask);
		$builder
			->update('share')
			->set('permissions', $permsFunc)
			->where($builder->expr()->eq('item_type', $builder->expr()->literal('file')))
			->andWhere($builder->expr()->neq('permissions', $permsFunc));

		$updatedEntries = $builder->executeStatement();
		if ($updatedEntries > 0) {
			$output->info('Fixed file share permissions for ' . $updatedEntries . ' shares');
		}
	}

	/**
	 * Remove shares where the parent share does not exist anymore
	 */
	private function removeSharesNonExistingParent(IOutput $output): void {
		$deletedEntries = 0;

		$query = $this->connection->getQueryBuilder();
		$query->select('s1.parent')
			->from('share', 's1')
			->where($query->expr()->isNotNull('s1.parent'))
			->andWhere($query->expr()->isNull('s2.id'))
			->leftJoin('s1', 'share', 's2', $query->expr()->eq('s1.parent', 's2.id'))
			->groupBy('s1.parent')
			->setMaxResults(self::CHUNK_SIZE);

		$deleteQuery = $this->connection->getQueryBuilder();
		$deleteQuery->delete('share')
			->where($deleteQuery->expr()->in('parent', $deleteQuery->createParameter('parents')));

		while (true) {
			$result = $query->executeQuery();
			$parents = $result->fetchFirstColumn();
			$parents = array_unique($parents);
			$result->closeCursor();

			if ($parents === []) {
				break;
			}

			$deletedEntriesInIteration = $deleteQuery->setParameter('parents', $parents, IQueryBuilder::PARAM_INT_ARRAY)
				->executeStatement();
			$deletedEntries += $deletedEntriesInIteration;

			if ($deletedEntriesInIteration === 0) {
				break;
			}
		}

		if ($deletedEntries) {
			$output->info('Removed ' . $deletedEntries . ' shares where the parent did not exist');
		}
	}

	/**
	 * Strip trailing slashes that leaked into the share target when a parent folder
	 * of a moved incoming share was renamed
	 */
	private function removeTrailingSlashFromFileTarget(IOutput $output): void {
		if ($this->appConfig->getValueBool('core', ConfigLexicon::SHARE_REPAIR_REMOVED_TRAILING_SLASHES, lazy: true)) {
			return;
		}

		$updatedEntries = 0;

		$query = $this->connection->getQueryBuilder();
		$query->select('id', 'file_target')
			->from('share')
			->where($query->expr()->like('file_target', $query->createNamedParameter('%/')))
			->andWhere($query->expr()->neq('file_target', $query->createNamedParameter('/')))
			->setMaxResults(self::CHUNK_SIZE);

		$updateQuery = $this->connection->getQueryBuilder();
		$updateQuery->update('share')
			->set('file_target', $updateQuery->createParameter('file_target'))
			->where($updateQuery->expr()->eq('id', $updateQuery->createParameter('id')));

		$rowsInLastChunk = self::CHUNK_SIZE;
		while ($rowsInLastChunk === self::CHUNK_SIZE) {
			$result = $query->executeQuery();
			$rows = $result->fetchAllAssociative();
			$result->closeCursor();
			$rowsInLastChunk = count($rows);

			foreach ($rows as $row) {
				$updatedEntries += $updateQuery
					->setParameter('file_target', rtrim($row['file_target'], '/'))
					->setParameter('id', (int)$row['id'])
					->executeStatement();
			}
		}

		$this->appConfig->setValueBool('core', ConfigLexicon::SHARE_REPAIR_REMOVED_TRAILING_SLASHES, true, lazy: true);

		if ($updatedEntries > 0) {
			$output->info('Removed trailing slashes from the target of ' . $updatedEntries . ' shares');
		}
	}

	#[\Override]
	public function run(IOutput $output) {
		$ocVersionFromBeforeUpdate = $this->config->getSystemValueString('version', '0.0.0');
		if (version_compare($ocVersionFromBeforeUpdate, '12.0.0.11', '<')) {
			$this->adjustFileSharePermissions($output);
		}

		$this->removeSharesNonExistingParent($output);
		$this->removeTrailingSlashFromFileTarget($output);
	}
}