Skip to content

Commit

Permalink
Add command to scan trashbin for database inconsistencies
Browse files Browse the repository at this point in the history
Signed-off-by: Côme Chilliet <come.chilliet@nextcloud.com>
  • Loading branch information
come-nc authored and AndyScherzinger committed Aug 7, 2024
1 parent 749dc7d commit ecaffe9
Show file tree
Hide file tree
Showing 4 changed files with 163 additions and 0 deletions.
1 change: 1 addition & 0 deletions apps/files_trashbin/appinfo/info.xml
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ To prevent an account from running out of disk space, the Deleted files app will
<command>OCA\Files_Trashbin\Command\ExpireTrash</command>
<command>OCA\Files_Trashbin\Command\Size</command>
<command>OCA\Files_Trashbin\Command\RestoreAllFiles</command>
<command>OCA\Files_Trashbin\Command\ScanFileSystem</command>
</commands>

<sabre>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
'OCA\\Files_Trashbin\\Command\\Expire' => $baseDir . '/../lib/Command/Expire.php',
'OCA\\Files_Trashbin\\Command\\ExpireTrash' => $baseDir . '/../lib/Command/ExpireTrash.php',
'OCA\\Files_Trashbin\\Command\\RestoreAllFiles' => $baseDir . '/../lib/Command/RestoreAllFiles.php',
'OCA\\Files_Trashbin\\Command\\ScanFileSystem' => $baseDir . '/../lib/Command/ScanFileSystem.php',
'OCA\\Files_Trashbin\\Command\\Size' => $baseDir . '/../lib/Command/Size.php',
'OCA\\Files_Trashbin\\Controller\\PreviewController' => $baseDir . '/../lib/Controller/PreviewController.php',
'OCA\\Files_Trashbin\\Events\\BeforeNodeRestoredEvent' => $baseDir . '/../lib/Events/BeforeNodeRestoredEvent.php',
Expand Down
1 change: 1 addition & 0 deletions apps/files_trashbin/composer/composer/autoload_static.php
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ class ComposerStaticInitFiles_Trashbin
'OCA\\Files_Trashbin\\Command\\Expire' => __DIR__ . '/..' . '/../lib/Command/Expire.php',
'OCA\\Files_Trashbin\\Command\\ExpireTrash' => __DIR__ . '/..' . '/../lib/Command/ExpireTrash.php',
'OCA\\Files_Trashbin\\Command\\RestoreAllFiles' => __DIR__ . '/..' . '/../lib/Command/RestoreAllFiles.php',
'OCA\\Files_Trashbin\\Command\\ScanFileSystem' => __DIR__ . '/..' . '/../lib/Command/ScanFileSystem.php',
'OCA\\Files_Trashbin\\Command\\Size' => __DIR__ . '/..' . '/../lib/Command/Size.php',
'OCA\\Files_Trashbin\\Controller\\PreviewController' => __DIR__ . '/..' . '/../lib/Controller/PreviewController.php',
'OCA\\Files_Trashbin\\Events\\BeforeNodeRestoredEvent' => __DIR__ . '/..' . '/../lib/Events/BeforeNodeRestoredEvent.php',
Expand Down
160 changes: 160 additions & 0 deletions apps/files_trashbin/lib/Command/ScanFileSystem.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,160 @@
<?php

declare(strict_types=1);

/**
* @copyright Copyright (c) 2023, Nextcloud, GmbH.
*
* @author Côme Chilliet <come.chilliet@nextcloud.com>
*
* @license AGPL-3.0-or-later
*
* This code is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* 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, version 3,
* along with this program. If not, see <http://www.gnu.org/licenses/>
*
*/

namespace OCA\Files_Trashbin\Command;

use OC\Core\Command\Base;
use OCP\Files\IRootFolder;
use OCP\IDBConnection;
use OCP\IL10N;
use OCP\IUserBackend;
use OCA\Files_Trashbin\Trashbin;
use OCA\Files_Trashbin\Helper;
use OCP\IUserManager;
use OCP\L10N\IFactory;
use Symfony\Component\Console\Exception\InvalidOptionException;
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 ScanFileSystem extends Base {
protected IUserManager $userManager;
protected IRootFolder $rootFolder;
protected IDBConnection $dbConnection;
protected IL10N $l10n;

public function __construct(
IRootFolder $rootFolder,
IUserManager $userManager,
IDBConnection $dbConnection,
IFactory $l10nFactory,
) {
parent::__construct();
$this->userManager = $userManager;
$this->rootFolder = $rootFolder;
$this->dbConnection = $dbConnection;
$this->l10n = $l10nFactory->get('files_trashbin');
}

protected function configure(): void {
parent::configure();
$this
->setName('trashbin:scan')
->setDescription('Rescan trashbin for a user, and fix inconsistencies if needed')
->addArgument(
'user_id',
InputArgument::OPTIONAL | InputArgument::IS_ARRAY,
'scan all deleted files of the given user(s)'
)
->addOption(
'all-users',
null,
InputOption::VALUE_NONE,
'run action on all users'
);
}

protected function execute(InputInterface $input, OutputInterface $output): int {
/** @var string[] $users */
$users = $input->getArgument('user_id');
if ((!empty($users)) and ($input->getOption('all-users'))) {
throw new InvalidOptionException('Either specify a user_id or --all-users');
} elseif (!empty($users)) {
foreach ($users as $user) {
if ($this->userManager->userExists($user)) {
$output->writeln("Restoring deleted files for user <info>$user</info>");
$this->scanDeletedFiles($user, $output);
} else {
$output->writeln("<error>Unknown user $user</error>");
return 1;
}
}
} elseif ($input->getOption('all-users')) {
$output->writeln('Restoring deleted files for all users');
foreach ($this->userManager->getBackends() as $backend) {
$name = get_class($backend);
if ($backend instanceof IUserBackend) {
$name = $backend->getBackendName();
}
$output->writeln("Restoring deleted files for users on backend <info>$name</info>");
$limit = 500;
$offset = 0;
do {
$users = $backend->getUsers('', $limit, $offset);
foreach ($users as $user) {
$output->writeln("<info>$user</info>");
$this->scanDeletedFiles($user, $output);
}
$offset += $limit;
} while (count($users) >= $limit);
}
} else {
throw new InvalidOptionException('Either specify a user_id or --all-users');
}
return 0;
}

/**
* Scan deleted files for the given user
*/
protected function scanDeletedFiles(string $uid, OutputInterface $output): void {
\OC_Util::tearDownFS();
\OC_Util::setupFS($uid);
\OC_User::setUserId($uid);

$filesInTrash = Helper::getTrashFiles('/', $uid);
$filesInTrashDatabase = Trashbin::getLocations($uid);

Check failure on line 129 in apps/files_trashbin/lib/Command/ScanFileSystem.php

View workflow job for this annotation

GitHub Actions / static-code-analysis

UndefinedMethod

apps/files_trashbin/lib/Command/ScanFileSystem.php:129:27: UndefinedMethod: Method OCA\Files_Trashbin\Trashbin::getlocations does not exist (see https://psalm.dev/022)

Check failure

Code scanning / Psalm

UndefinedMethod Error

Method OCA\Files_Trashbin\Trashbin::getlocations does not exist

$trashCount = count($filesInTrash);
$trashCountDatabase = count($filesInTrashDatabase);
if ($trashCount === 0 && $trashCountDatabase === 0) {
$output->writeln("User has no deleted files in the trashbin");
return;
}
$output->writeln("Preparing to scan <info>$trashCount</info> files...");
$count = 0;
foreach ($filesInTrash as $trashFile) {
$filename = $trashFile->getName();
$timestamp = $trashFile->getMtime();
$humanTime = $this->l10n->l('datetime', $timestamp);
if (isset($filesInTrashDatabase[$filename][$timestamp])) {
$count++;
$output->writeln("File <info>$filename</info> originally deleted at <info>$humanTime</info> is clean");
unset($filesInTrashDatabase[$filename][$timestamp]);
} else {
$output->writeln("<error>File <info>$filename</info> originally deleted at <info>$humanTime</info> is missing from database</error>");
}
}

$output->writeln("Found <info>$count</info> clean files out of <info>$trashCount</info> files.");

$filesInTrashDatabase = array_filter($filesInTrashDatabase);

$trashCountDatabase = count($filesInTrashDatabase);

$output->writeln("Found <info>$trashCountDatabase</info> files in database missing from storage.");
}
}

0 comments on commit ecaffe9

Please sign in to comment.