New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
add command do delete orphan shares #39170
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
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,96 @@ | ||
| <?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 { | ||
| private OrphanHelper $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,86 @@ | ||
| <?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 { | ||
| private IDBConnection $connection; | ||
| private IRootFolder $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'], | ||
| ]; | ||
| } | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No option to delete them one by one? Maybe it is irrelevant in the use case.