aboutsummaryrefslogtreecommitdiffstats
path: root/apps/files_trashbin/lib/Command
diff options
context:
space:
mode:
Diffstat (limited to 'apps/files_trashbin/lib/Command')
-rw-r--r--apps/files_trashbin/lib/Command/CleanUp.php102
-rw-r--r--apps/files_trashbin/lib/Command/Expire.php41
-rw-r--r--apps/files_trashbin/lib/Command/ExpireTrash.php86
-rw-r--r--apps/files_trashbin/lib/Command/RestoreAllFiles.php273
-rw-r--r--apps/files_trashbin/lib/Command/Size.php124
5 files changed, 491 insertions, 135 deletions
diff --git a/apps/files_trashbin/lib/Command/CleanUp.php b/apps/files_trashbin/lib/Command/CleanUp.php
index b727dd9e133..e9b4fa8ae60 100644
--- a/apps/files_trashbin/lib/Command/CleanUp.php
+++ b/apps/files_trashbin/lib/Command/CleanUp.php
@@ -1,58 +1,32 @@
<?php
+
/**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- *
- * @author Björn Schießle <bjoern@schiessle.org>
- * @author Joas Schilling <coding@schilljs.com>
- *
- * @license AGPL-3.0
- *
- * 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/>
- *
+ * SPDX-FileCopyrightText: 2018-2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
+ * SPDX-License-Identifier: AGPL-3.0-only
*/
-
namespace OCA\Files_Trashbin\Command;
use OCP\Files\IRootFolder;
use OCP\IDBConnection;
use OCP\IUserBackend;
use OCP\IUserManager;
+use OCP\Util;
use Symfony\Component\Console\Command\Command;
+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 CleanUp extends Command {
- /** @var IUserManager */
- protected $userManager;
-
- /** @var IRootFolder */
- protected $rootFolder;
-
- /** @var \OCP\IDBConnection */
- protected $dbConnection;
-
- /**
- * @param IRootFolder $rootFolder
- * @param IUserManager $userManager
- * @param IDBConnection $dbConnection
- */
- function __construct(IRootFolder $rootFolder, IUserManager $userManager, IDBConnection $dbConnection) {
+ public function __construct(
+ protected IRootFolder $rootFolder,
+ protected IUserManager $userManager,
+ protected IDBConnection $dbConnection,
+ ) {
parent::__construct();
- $this->userManager = $userManager;
- $this->rootFolder = $rootFolder;
- $this->dbConnection = $dbConnection;
}
protected function configure() {
@@ -62,23 +36,33 @@ class CleanUp extends Command {
->addArgument(
'user_id',
InputArgument::OPTIONAL | InputArgument::IS_ARRAY,
- 'remove deleted files of the given user(s), if no user is given all deleted files will be removed'
+ 'remove 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) {
+ protected function execute(InputInterface $input, OutputInterface $output): int {
$users = $input->getArgument('user_id');
- if (!empty($users)) {
+ $verbose = $input->getOption('verbose');
+ 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("Remove deleted files of <info>$user</info>");
- $this->removeDeletedFiles($user);
+ $this->removeDeletedFiles($user, $output, $verbose);
} else {
$output->writeln("<error>Unknown user $user</error>");
+ return 1;
}
}
- } else {
- $output->writeln('Remove all deleted files');
+ } elseif ($input->getOption('all-users')) {
+ $output->writeln('Remove deleted files for all users');
foreach ($this->userManager->getBackends() as $backend) {
$name = get_class($backend);
if ($backend instanceof IUserBackend) {
@@ -91,30 +75,44 @@ class CleanUp extends Command {
$users = $backend->getUsers('', $limit, $offset);
foreach ($users as $user) {
$output->writeln(" <info>$user</info>");
- $this->removeDeletedFiles($user);
+ $this->removeDeletedFiles($user, $output, $verbose);
}
$offset += $limit;
} while (count($users) >= $limit);
}
+ } else {
+ throw new InvalidOptionException('Either specify a user_id or --all-users');
}
+ return 0;
}
/**
* remove deleted files for the given user
- *
- * @param string $uid
*/
- protected function removeDeletedFiles($uid) {
+ protected function removeDeletedFiles(string $uid, OutputInterface $output, bool $verbose): void {
\OC_Util::tearDownFS();
\OC_Util::setupFS($uid);
- if ($this->rootFolder->nodeExists('/' . $uid . '/files_trashbin')) {
- $this->rootFolder->get('/' . $uid . '/files_trashbin')->delete();
+ $path = '/' . $uid . '/files_trashbin';
+ if ($this->rootFolder->nodeExists($path)) {
+ $node = $this->rootFolder->get($path);
+
+ if ($verbose) {
+ $output->writeln('Deleting <info>' . Util::humanFileSize($node->getSize()) . "</info> in trash for <info>$uid</info>.");
+ }
+ $node->delete();
+ if ($this->rootFolder->nodeExists($path)) {
+ $output->writeln('<error>Trash folder sill exists after attempting to delete it</error>');
+ return;
+ }
$query = $this->dbConnection->getQueryBuilder();
$query->delete('files_trash')
->where($query->expr()->eq('user', $query->createParameter('uid')))
->setParameter('uid', $uid);
- $query->execute();
+ $query->executeStatement();
+ } else {
+ if ($verbose) {
+ $output->writeln("No trash found for <info>$uid</info>");
+ }
}
}
-
}
diff --git a/apps/files_trashbin/lib/Command/Expire.php b/apps/files_trashbin/lib/Command/Expire.php
index 0d9bb4a088a..73a42cd4749 100644
--- a/apps/files_trashbin/lib/Command/Expire.php
+++ b/apps/files_trashbin/lib/Command/Expire.php
@@ -1,52 +1,31 @@
<?php
+
/**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- *
- * @author Joas Schilling <coding@schilljs.com>
- * @author Morris Jobke <hey@morrisjobke.de>
- * @author Robin Appelman <robin@icewind.nl>
- * @author Thomas Müller <thomas.mueller@tmit.eu>
- * @author Vincent Petry <pvince81@owncloud.com>
- *
- * @license AGPL-3.0
- *
- * 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/>
- *
+ * SPDX-FileCopyrightText: 2019-2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
+ * SPDX-License-Identifier: AGPL-3.0-only
*/
-
namespace OCA\Files_Trashbin\Command;
use OC\Command\FileAccess;
use OCA\Files_Trashbin\Trashbin;
use OCP\Command\ICommand;
+use OCP\IUserManager;
+use OCP\Server;
class Expire implements ICommand {
use FileAccess;
/**
- * @var string
- */
- private $user;
-
- /**
* @param string $user
*/
- function __construct($user) {
- $this->user = $user;
+ public function __construct(
+ private $user,
+ ) {
}
public function handle() {
- $userManager = \OC::$server->getUserManager();
+ $userManager = Server::get(IUserManager::class);
if (!$userManager->userExists($this->user)) {
// User has been deleted already
return;
diff --git a/apps/files_trashbin/lib/Command/ExpireTrash.php b/apps/files_trashbin/lib/Command/ExpireTrash.php
index 6b46fd9e626..422d8379984 100644
--- a/apps/files_trashbin/lib/Command/ExpireTrash.php
+++ b/apps/files_trashbin/lib/Command/ExpireTrash.php
@@ -1,33 +1,18 @@
<?php
+
/**
- * @copyright Copyright (c) 2016, ownCloud GmbH.
- *
- * @author Jörn Friedrich Dreyer <jfd@butonic.de>
- * @author Thomas Müller <thomas.mueller@tmit.eu>
- *
- * @license AGPL-3.0
- *
- * 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/>
- *
+ * SPDX-FileCopyrightText: 2019-2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2016 ownCloud GmbH.
+ * SPDX-License-Identifier: AGPL-3.0-only
*/
-
namespace OCA\Files_Trashbin\Command;
-use OCP\IUser;
-use OCP\IUserManager;
+use OC\Files\View;
use OCA\Files_Trashbin\Expiration;
-use OCA\Files_Trashbin\Helper;
use OCA\Files_Trashbin\Trashbin;
+use OCP\IUser;
+use OCP\IUserManager;
+use Psr\Log\LoggerInterface;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Helper\ProgressBar;
use Symfony\Component\Console\Input\InputArgument;
@@ -37,25 +22,15 @@ use Symfony\Component\Console\Output\OutputInterface;
class ExpireTrash extends Command {
/**
- * @var Expiration
- */
- private $expiration;
-
- /**
- * @var IUserManager
- */
- private $userManager;
-
- /**
* @param IUserManager|null $userManager
* @param Expiration|null $expiration
*/
- public function __construct(IUserManager $userManager = null,
- Expiration $expiration = null) {
+ public function __construct(
+ private LoggerInterface $logger,
+ private ?IUserManager $userManager = null,
+ private ?Expiration $expiration = null,
+ ) {
parent::__construct();
-
- $this->userManager = $userManager;
- $this->expiration = $expiration;
}
protected function configure() {
@@ -69,12 +44,12 @@ class ExpireTrash extends Command {
);
}
- protected function execute(InputInterface $input, OutputInterface $output) {
-
+ protected function execute(InputInterface $input, OutputInterface $output): int {
+ $minAge = $this->expiration->getMinAgeAsTimestamp();
$maxAge = $this->expiration->getMaxAgeAsTimestamp();
- if (!$maxAge) {
- $output->writeln("No expiry configured.");
- return;
+ if ($minAge === false && $maxAge === false) {
+ $output->writeln('Auto expiration is configured - keeps files and folders in the trash bin for 30 days and automatically deletes anytime after that if space is needed (note: files may not be deleted if space is not needed)');
+ return 1;
}
$users = $input->getArgument('user_id');
@@ -86,27 +61,34 @@ class ExpireTrash extends Command {
$this->expireTrashForUser($userObject);
} else {
$output->writeln("<error>Unknown user $user</error>");
+ return 1;
}
}
} else {
$p = new ProgressBar($output);
$p->start();
- $this->userManager->callForSeenUsers(function(IUser $user) use ($p) {
+
+ $users = $this->userManager->getSeenUsers();
+ foreach ($users as $user) {
$p->advance();
$this->expireTrashForUser($user);
- });
+ }
$p->finish();
$output->writeln('');
}
+ return 0;
}
- function expireTrashForUser(IUser $user) {
- $uid = $user->getUID();
- if (!$this->setupFS($uid)) {
- return;
+ public function expireTrashForUser(IUser $user) {
+ try {
+ $uid = $user->getUID();
+ if (!$this->setupFS($uid)) {
+ return;
+ }
+ Trashbin::expire($uid);
+ } catch (\Throwable $e) {
+ $this->logger->error('Error while expiring trashbin for user ' . $user->getUID(), ['exception' => $e]);
}
- $dirContent = Helper::getTrashFiles('/', $uid, 'mtime');
- Trashbin::deleteExpiredFiles($dirContent, $uid);
}
/**
@@ -119,7 +101,7 @@ class ExpireTrash extends Command {
\OC_Util::setupFS($user);
// Check if this user has a trashbin directory
- $view = new \OC\Files\View('/' . $user);
+ $view = new View('/' . $user);
if (!$view->is_dir('/files_trashbin/files')) {
return false;
}
diff --git a/apps/files_trashbin/lib/Command/RestoreAllFiles.php b/apps/files_trashbin/lib/Command/RestoreAllFiles.php
new file mode 100644
index 00000000000..ce31f759c0e
--- /dev/null
+++ b/apps/files_trashbin/lib/Command/RestoreAllFiles.php
@@ -0,0 +1,273 @@
+<?php
+
+/**
+ * SPDX-FileCopyrightText: 2021 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+namespace OCA\Files_Trashbin\Command;
+
+use OC\Core\Command\Base;
+use OCA\Files_Trashbin\Trash\ITrashManager;
+use OCA\Files_Trashbin\Trash\TrashItem;
+use OCP\Files\IRootFolder;
+use OCP\IDBConnection;
+use OCP\IL10N;
+use OCP\IUserBackend;
+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 RestoreAllFiles extends Base {
+
+ private const SCOPE_ALL = 0;
+ private const SCOPE_USER = 1;
+ private const SCOPE_GROUPFOLDERS = 2;
+
+ private static array $SCOPE_MAP = [
+ 'user' => self::SCOPE_USER,
+ 'groupfolders' => self::SCOPE_GROUPFOLDERS,
+ 'all' => self::SCOPE_ALL
+ ];
+
+ /** @var IL10N */
+ protected $l10n;
+
+ /**
+ * @param IRootFolder $rootFolder
+ * @param IUserManager $userManager
+ * @param IDBConnection $dbConnection
+ * @param ITrashManager $trashManager
+ * @param IFactory $l10nFactory
+ */
+ public function __construct(
+ protected IRootFolder $rootFolder,
+ protected IUserManager $userManager,
+ protected IDBConnection $dbConnection,
+ protected ITrashManager $trashManager,
+ IFactory $l10nFactory,
+ ) {
+ parent::__construct();
+ $this->l10n = $l10nFactory->get('files_trashbin');
+ }
+
+ protected function configure(): void {
+ parent::configure();
+ $this
+ ->setName('trashbin:restore')
+ ->setDescription('Restore all deleted files according to the given filters')
+ ->addArgument(
+ 'user_id',
+ InputArgument::OPTIONAL | InputArgument::IS_ARRAY,
+ 'restore all deleted files of the given user(s)'
+ )
+ ->addOption(
+ 'all-users',
+ null,
+ InputOption::VALUE_NONE,
+ 'run action on all users'
+ )
+ ->addOption(
+ 'scope',
+ 's',
+ InputOption::VALUE_OPTIONAL,
+ 'Restore files from the given scope. Possible values are "user", "groupfolders" or "all"',
+ 'user'
+ )
+ ->addOption(
+ 'since',
+ null,
+ InputOption::VALUE_OPTIONAL,
+ 'Only restore files deleted after the given date and time, see https://www.php.net/manual/en/function.strtotime.php for more information on supported formats'
+ )
+ ->addOption(
+ 'until',
+ null,
+ InputOption::VALUE_OPTIONAL,
+ 'Only restore files deleted before the given date and time, see https://www.php.net/manual/en/function.strtotime.php for more information on supported formats'
+ )
+ ->addOption(
+ 'dry-run',
+ 'd',
+ InputOption::VALUE_NONE,
+ 'Only show which files would be restored but do not perform any action'
+ );
+ }
+
+ protected function execute(InputInterface $input, OutputInterface $output): int {
+ /** @var string[] $users */
+ $users = $input->getArgument('user_id');
+ if ((!empty($users)) && ($input->getOption('all-users'))) {
+ throw new InvalidOptionException('Either specify a user_id or --all-users');
+ }
+
+ [$scope, $since, $until, $dryRun] = $this->parseArgs($input);
+
+ if (!empty($users)) {
+ foreach ($users as $user) {
+ $output->writeln("Restoring deleted files for user <info>$user</info>");
+ $this->restoreDeletedFiles($user, $scope, $since, $until, $dryRun, $output);
+ }
+ } 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->restoreDeletedFiles($user, $scope, $since, $until, $dryRun, $output);
+ }
+ $offset += $limit;
+ } while (count($users) >= $limit);
+ }
+ } else {
+ throw new InvalidOptionException('Either specify a user_id or --all-users');
+ }
+ return 0;
+ }
+
+ /**
+ * Restore deleted files for the given user according to the given filters
+ */
+ protected function restoreDeletedFiles(string $uid, int $scope, ?int $since, ?int $until, bool $dryRun, OutputInterface $output): void {
+ \OC_Util::tearDownFS();
+ \OC_Util::setupFS($uid);
+ \OC_User::setUserId($uid);
+
+ $user = $this->userManager->get($uid);
+
+ if ($user === null) {
+ $output->writeln("<error>Unknown user $uid</error>");
+ return;
+ }
+
+ $userTrashItems = $this->filterTrashItems(
+ $this->trashManager->listTrashRoot($user),
+ $scope,
+ $since,
+ $until,
+ $output);
+
+ $trashCount = count($userTrashItems);
+ if ($trashCount == 0) {
+ $output->writeln('User has no deleted files in the trashbin matching the given filters');
+ return;
+ }
+ $prepMsg = $dryRun ? 'Would restore' : 'Preparing to restore';
+ $output->writeln("$prepMsg <info>$trashCount</info> files...");
+ $count = 0;
+ foreach ($userTrashItems as $trashItem) {
+ $filename = $trashItem->getName();
+ $humanTime = $this->l10n->l('datetime', $trashItem->getDeletedTime());
+ // We use getTitle() here instead of getOriginalLocation() because
+ // for groupfolders this contains the groupfolder name itself as prefix
+ // which makes it more human readable
+ $location = $trashItem->getTitle();
+
+ if ($dryRun) {
+ $output->writeln("Would restore <info>$filename</info> originally deleted at <info>$humanTime</info> to <info>/$location</info>");
+ continue;
+ }
+
+ $output->write("File <info>$filename</info> originally deleted at <info>$humanTime</info> restoring to <info>/$location</info>:");
+
+ try {
+ $trashItem->getTrashBackend()->restoreItem($trashItem);
+ } catch (\Throwable $e) {
+ $output->writeln(' <error>Failed: ' . $e->getMessage() . '</error>');
+ $output->writeln(' <error>' . $e->getTraceAsString() . '</error>', OutputInterface::VERBOSITY_VERY_VERBOSE);
+ continue;
+ }
+
+ $count++;
+ $output->writeln(' <info>success</info>');
+ }
+
+ if (!$dryRun) {
+ $output->writeln("Successfully restored <info>$count</info> out of <info>$trashCount</info> files.");
+ }
+ }
+
+ protected function parseArgs(InputInterface $input): array {
+ $since = $this->parseTimestamp($input->getOption('since'));
+ $until = $this->parseTimestamp($input->getOption('until'));
+
+ if ($since !== null && $until !== null && $since > $until) {
+ throw new InvalidOptionException('since must be before until');
+ }
+
+ return [
+ $this->parseScope($input->getOption('scope')),
+ $since,
+ $until,
+ $input->getOption('dry-run')
+ ];
+ }
+
+ protected function parseScope(string $scope): int {
+ if (isset(self::$SCOPE_MAP[$scope])) {
+ return self::$SCOPE_MAP[$scope];
+ }
+
+ throw new InvalidOptionException("Invalid scope '$scope'");
+ }
+
+ protected function parseTimestamp(?string $timestamp): ?int {
+ if ($timestamp === null) {
+ return null;
+ }
+ $timestamp = strtotime($timestamp);
+ if ($timestamp === false) {
+ throw new InvalidOptionException("Invalid timestamp '$timestamp'");
+ }
+ return $timestamp;
+ }
+
+ protected function filterTrashItems(array $trashItems, int $scope, ?int $since, ?int $until, OutputInterface $output): array {
+ $filteredTrashItems = [];
+ foreach ($trashItems as $trashItem) {
+ $trashItemClass = get_class($trashItem);
+
+ // Check scope with exact class name for locally deleted files
+ if ($scope === self::SCOPE_USER && $trashItemClass !== TrashItem::class) {
+ $output->writeln('Skipping <info>' . $trashItem->getName() . '</info> because it is not a user trash item', OutputInterface::VERBOSITY_VERBOSE);
+ continue;
+ }
+
+ /**
+ * Check scope for groupfolders by string because the groupfolders app might not be installed.
+ * That's why PSALM doesn't know the class GroupTrashItem.
+ * @psalm-suppress RedundantCondition
+ */
+ if ($scope === self::SCOPE_GROUPFOLDERS && $trashItemClass !== 'OCA\GroupFolders\Trash\GroupTrashItem') {
+ $output->writeln('Skipping <info>' . $trashItem->getName() . '</info> because it is not a groupfolders trash item', OutputInterface::VERBOSITY_VERBOSE);
+ continue;
+ }
+
+ // Check left timestamp boundary
+ if ($since !== null && $trashItem->getDeletedTime() <= $since) {
+ $output->writeln('Skipping <info>' . $trashItem->getName() . "</info> because it was deleted before the 'since' timestamp", OutputInterface::VERBOSITY_VERBOSE);
+ continue;
+ }
+
+ // Check right timestamp boundary
+ if ($until !== null && $trashItem->getDeletedTime() >= $until) {
+ $output->writeln('Skipping <info>' . $trashItem->getName() . "</info> because it was deleted after the 'until' timestamp", OutputInterface::VERBOSITY_VERBOSE);
+ continue;
+ }
+
+ $filteredTrashItems[] = $trashItem;
+ }
+ return $filteredTrashItems;
+ }
+}
diff --git a/apps/files_trashbin/lib/Command/Size.php b/apps/files_trashbin/lib/Command/Size.php
new file mode 100644
index 00000000000..9c19d4d92b3
--- /dev/null
+++ b/apps/files_trashbin/lib/Command/Size.php
@@ -0,0 +1,124 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2020 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCA\Files_Trashbin\Command;
+
+use OC\Core\Command\Base;
+use OCP\Command\IBus;
+use OCP\IConfig;
+use OCP\IUser;
+use OCP\IUserManager;
+use OCP\Util;
+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 Size extends Base {
+ public function __construct(
+ private IConfig $config,
+ private IUserManager $userManager,
+ private IBus $commandBus,
+ ) {
+ parent::__construct();
+ }
+
+ protected function configure() {
+ parent::configure();
+ $this
+ ->setName('trashbin:size')
+ ->setDescription('Configure the target trashbin size')
+ ->addOption('user', 'u', InputOption::VALUE_REQUIRED, 'configure the target size for the provided user, if no user is given the default size is configured')
+ ->addArgument(
+ 'size',
+ InputArgument::OPTIONAL,
+ 'the target size for the trashbin, if not provided the current trashbin size will be returned'
+ );
+ }
+
+ protected function execute(InputInterface $input, OutputInterface $output): int {
+ $user = $input->getOption('user');
+ $size = $input->getArgument('size');
+
+ if ($size) {
+ $parsedSize = Util::computerFileSize($size);
+ if ($parsedSize === false) {
+ $output->writeln('<error>Failed to parse input size</error>');
+ return -1;
+ }
+ if ($user) {
+ $this->config->setUserValue($user, 'files_trashbin', 'trashbin_size', (string)$parsedSize);
+ $this->commandBus->push(new Expire($user));
+ } else {
+ $this->config->setAppValue('files_trashbin', 'trashbin_size', (string)$parsedSize);
+ $output->writeln('<info>Warning: changing the default trashbin size will automatically trigger cleanup of existing trashbins,</info>');
+ $output->writeln('<info>a users trashbin can exceed the configured size until they move a new file to the trashbin.</info>');
+ }
+ } else {
+ $this->printTrashbinSize($input, $output, $user);
+ }
+
+ return 0;
+ }
+
+ private function printTrashbinSize(InputInterface $input, OutputInterface $output, ?string $user) {
+ $globalSize = (int)$this->config->getAppValue('files_trashbin', 'trashbin_size', '-1');
+ if ($globalSize < 0) {
+ $globalHumanSize = 'default (50% of available space)';
+ } else {
+ $globalHumanSize = Util::humanFileSize($globalSize);
+ }
+
+ if ($user) {
+ $userSize = (int)$this->config->getUserValue($user, 'files_trashbin', 'trashbin_size', '-1');
+
+ if ($userSize < 0) {
+ $userHumanSize = ($globalSize < 0) ? $globalHumanSize : "default($globalHumanSize)";
+ } else {
+ $userHumanSize = Util::humanFileSize($userSize);
+ }
+
+ if ($input->getOption('output') == self::OUTPUT_FORMAT_PLAIN) {
+ $output->writeln($userHumanSize);
+ } else {
+ $userValue = ($userSize < 0) ? 'default' : $userSize;
+ $globalValue = ($globalSize < 0) ? 'default' : $globalSize;
+ $this->writeArrayInOutputFormat($input, $output, [
+ 'user_size' => $userValue,
+ 'global_size' => $globalValue,
+ 'effective_size' => ($userSize < 0) ? $globalValue : $userValue,
+ ]);
+ }
+ } else {
+ $users = [];
+ $this->userManager->callForSeenUsers(function (IUser $user) use (&$users): void {
+ $users[] = $user->getUID();
+ });
+ $userValues = $this->config->getUserValueForUsers('files_trashbin', 'trashbin_size', $users);
+
+ if ($input->getOption('output') == self::OUTPUT_FORMAT_PLAIN) {
+ $output->writeln("Default size: $globalHumanSize");
+ $output->writeln('');
+ if (count($userValues)) {
+ $output->writeln('Per-user sizes:');
+ $this->writeArrayInOutputFormat($input, $output, array_map(function ($size) {
+ return Util::humanFileSize($size);
+ }, $userValues));
+ } else {
+ $output->writeln('No per-user sizes configured');
+ }
+ } else {
+ $globalValue = ($globalSize < 0) ? 'default' : $globalSize;
+ $this->writeArrayInOutputFormat($input, $output, [
+ 'global_size' => $globalValue,
+ 'user_sizes' => $userValues,
+ ]);
+ }
+ }
+ }
+}
generated by cgit v1.2.3 (git 2.39.1) at 2025-08-16 00:52:08 +0000