aboutsummaryrefslogtreecommitdiffstats
path: root/apps/files_trashbin/lib/Command/ExpireTrash.php
diff options
context:
space:
mode:
Diffstat (limited to 'apps/files_trashbin/lib/Command/ExpireTrash.php')
-rw-r--r--apps/files_trashbin/lib/Command/ExpireTrash.php111
1 files changed, 111 insertions, 0 deletions
diff --git a/apps/files_trashbin/lib/Command/ExpireTrash.php b/apps/files_trashbin/lib/Command/ExpireTrash.php
new file mode 100644
index 00000000000..422d8379984
--- /dev/null
+++ b/apps/files_trashbin/lib/Command/ExpireTrash.php
@@ -0,0 +1,111 @@
+<?php
+
+/**
+ * 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 OC\Files\View;
+use OCA\Files_Trashbin\Expiration;
+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;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class ExpireTrash extends Command {
+
+ /**
+ * @param IUserManager|null $userManager
+ * @param Expiration|null $expiration
+ */
+ public function __construct(
+ private LoggerInterface $logger,
+ private ?IUserManager $userManager = null,
+ private ?Expiration $expiration = null,
+ ) {
+ parent::__construct();
+ }
+
+ protected function configure() {
+ $this
+ ->setName('trashbin:expire')
+ ->setDescription('Expires the users trashbin')
+ ->addArgument(
+ 'user_id',
+ InputArgument::OPTIONAL | InputArgument::IS_ARRAY,
+ 'expires the trashbin of the given user(s), if no user is given the trash for all users will be expired'
+ );
+ }
+
+ protected function execute(InputInterface $input, OutputInterface $output): int {
+ $minAge = $this->expiration->getMinAgeAsTimestamp();
+ $maxAge = $this->expiration->getMaxAgeAsTimestamp();
+ 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');
+ if (!empty($users)) {
+ foreach ($users as $user) {
+ if ($this->userManager->userExists($user)) {
+ $output->writeln("Remove deleted files of <info>$user</info>");
+ $userObject = $this->userManager->get($user);
+ $this->expireTrashForUser($userObject);
+ } else {
+ $output->writeln("<error>Unknown user $user</error>");
+ return 1;
+ }
+ }
+ } else {
+ $p = new ProgressBar($output);
+ $p->start();
+
+ $users = $this->userManager->getSeenUsers();
+ foreach ($users as $user) {
+ $p->advance();
+ $this->expireTrashForUser($user);
+ }
+ $p->finish();
+ $output->writeln('');
+ }
+ return 0;
+ }
+
+ 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]);
+ }
+ }
+
+ /**
+ * Act on behalf on trash item owner
+ * @param string $user
+ * @return boolean
+ */
+ protected function setupFS($user) {
+ \OC_Util::tearDownFS();
+ \OC_Util::setupFS($user);
+
+ // Check if this user has a trashbin directory
+ $view = new View('/' . $user);
+ if (!$view->is_dir('/files_trashbin/files')) {
+ return false;
+ }
+
+ return true;
+ }
+}