-
-
Notifications
You must be signed in to change notification settings - Fork 4.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #41667 from nextcloud/backport/39285/stable23
[stable23] add command do delete orphan shares
- Loading branch information
Showing
5 changed files
with
193 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
| /** | ||
| * @copyright Copyright (c) 2023 Robin Appelman <robin@icewind.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/>. | ||
| * | ||
| */ | ||
|
|
||
| namespace OCA\Files_Sharing\Command; | ||
|
|
||
|
|
||
| use Symfony\Component\Console\Question\ConfirmationQuestion; | ||
| use OC\Core\Command\Base; | ||
| use OCA\Files_Sharing\OrphanHelper; | ||
| use Symfony\Component\Console\Helper\QuestionHelper; | ||
| use Symfony\Component\Console\Input\InputInterface; | ||
| use Symfony\Component\Console\Input\InputOption; | ||
| use Symfony\Component\Console\Output\OutputInterface; | ||
|
|
||
| class DeleteOrphanShares extends Base { | ||
|
|
||
| /** @var OrphanHelper $orphanHelper */ | ||
| private $orphanHelper; | ||
|
|
||
| public function __construct(OrphanHelper $orphanHelper) { | ||
| parent::__construct(); | ||
| $this->orphanHelper = $orphanHelper; | ||
| } | ||
|
|
||
| protected function configure(): void { | ||
| $this | ||
| ->setName('sharing:delete-orphan-shares') | ||
| ->setDescription('Delete shares where the owner no longer has access to the file') | ||
| ->addOption( | ||
| 'force', | ||
| 'f', | ||
| InputOption::VALUE_NONE, | ||
| 'delete the shares without asking' | ||
| ); | ||
| } | ||
|
|
||
| public function execute(InputInterface $input, OutputInterface $output): int { | ||
| $force = $input->getOption('force'); | ||
| $shares = $this->orphanHelper->getAllShares(); | ||
|
|
||
| $orphans = []; | ||
| foreach ($shares as $share) { | ||
| if (!$this->orphanHelper->isShareValid($share['owner'], $share['fileid'])) { | ||
| $orphans[] = $share['id']; | ||
| $exists = $this->orphanHelper->fileExists($share['fileid']); | ||
| $output->writeln("<info>{$share['target']}</info> owned by <info>{$share['owner']}</info>"); | ||
| if ($exists) { | ||
| $output->writeln(" file still exists but the share owner lost access to it, run <info>occ info:file {$share['fileid']}</info> for more information about the file"); | ||
| } else { | ||
| $output->writeln(" file no longer exists"); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| $count = count($orphans); | ||
|
|
||
| if ($count === 0) { | ||
| $output->writeln("No orphan shares detected"); | ||
| return 0; | ||
| } | ||
|
|
||
| if ($force) { | ||
| $doDelete = true; | ||
| } else { | ||
| $output->writeln(""); | ||
| /** @var QuestionHelper $helper */ | ||
| $helper = $this->getHelper('question'); | ||
| $question = new ConfirmationQuestion("Delete <info>$count</info> orphan shares? [y/N] ", false); | ||
| $doDelete = $helper->ask($input, $output, $question); | ||
| } | ||
|
|
||
| if ($doDelete) { | ||
| $this->orphanHelper->deleteShares($orphans); | ||
| } | ||
|
|
||
| return 0; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
| /** | ||
| * @copyright Copyright (c) 2023 Robin Appelman <robin@icewind.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/>. | ||
| * | ||
| */ | ||
|
|
||
| namespace OCA\Files_Sharing; | ||
|
|
||
| use OCP\DB\QueryBuilder\IQueryBuilder; | ||
| use OCP\Files\IRootFolder; | ||
| use OCP\IDBConnection; | ||
|
|
||
| class OrphanHelper { | ||
|
|
||
| /** @var IDBConnection $connection */ | ||
| private $connection; | ||
|
|
||
| /** @var IRootFolder $rootFolder */ | ||
| private $rootFolder; | ||
|
|
||
| public function __construct( | ||
| IDBConnection $connection, | ||
| IRootFolder $rootFolder | ||
| ) { | ||
| $this->connection = $connection; | ||
| $this->rootFolder = $rootFolder; | ||
| } | ||
|
|
||
| public function isShareValid(string $owner, int $fileId): bool { | ||
| $userFolder = $this->rootFolder->getUserFolder($owner); | ||
| $nodes = $userFolder->getById($fileId); | ||
| return count($nodes) > 0; | ||
| } | ||
|
|
||
| /** | ||
| * @param int[] $ids | ||
| * @return void | ||
| */ | ||
| public function deleteShares(array $ids): void { | ||
| $query = $this->connection->getQueryBuilder(); | ||
| $query->delete('share') | ||
| ->where($query->expr()->in('id', $query->createNamedParameter($ids, IQueryBuilder::PARAM_INT_ARRAY))); | ||
| $query->executeStatement(); | ||
| } | ||
|
|
||
| public function fileExists(int $fileId): bool { | ||
| $query = $this->connection->getQueryBuilder(); | ||
| $query->select('fileid') | ||
| ->from('filecache') | ||
| ->where($query->expr()->eq('fileid', $query->createNamedParameter($fileId, IQueryBuilder::PARAM_INT))); | ||
| return $query->executeQuery()->fetchOne() !== false; | ||
| } | ||
|
|
||
| /** | ||
| * @return \Traversable<int, array{id: int, owner: string, fileid: int, target: string}> | ||
| */ | ||
| public function getAllShares() { | ||
| $query = $this->connection->getQueryBuilder(); | ||
| $query->select('id', 'file_source', 'uid_owner', 'file_target') | ||
| ->from('share') | ||
| ->where($query->expr()->eq('item_type', $query->createNamedParameter('file'))) | ||
| ->orWhere($query->expr()->eq('item_type', $query->createNamedParameter('folder'))); | ||
| $result = $query->executeQuery(); | ||
| while ($row = $result->fetch()) { | ||
| yield [ | ||
| 'id' => (int)$row['id'], | ||
| 'owner' => (string)$row['uid_owner'], | ||
| 'fileid' => (int)$row['file_source'], | ||
| 'target' => (string)$row['file_target'], | ||
| ]; | ||
| } | ||
| } | ||
| } |