aboutsummaryrefslogtreecommitdiffstats
path: root/apps/files_versions/lib/Command
diff options
context:
space:
mode:
Diffstat (limited to 'apps/files_versions/lib/Command')
-rw-r--r--apps/files_versions/lib/Command/CleanUp.php132
-rw-r--r--apps/files_versions/lib/Command/Expire.php71
-rw-r--r--apps/files_versions/lib/Command/ExpireVersions.php101
3 files changed, 129 insertions, 175 deletions
diff --git a/apps/files_versions/lib/Command/CleanUp.php b/apps/files_versions/lib/Command/CleanUp.php
index 7254d1e5bf2..e8c46afef16 100644
--- a/apps/files_versions/lib/Command/CleanUp.php
+++ b/apps/files_versions/lib/Command/CleanUp.php
@@ -1,55 +1,32 @@
<?php
+
/**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- *
- * @author Björn Schießle <bjoern@schiessle.org>
- *
- * @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 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
+ * SPDX-License-Identifier: AGPL-3.0-only
*/
-
namespace OCA\Files_Versions\Command;
-
+use OCA\Files_Versions\Db\VersionsMapper;
use OCP\Files\IRootFolder;
use OCP\IUserBackend;
use OCP\IUserManager;
use Symfony\Component\Console\Command\Command;
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;
-
- /**
- * @param IRootFolder $rootFolder
- * @param IUserManager $userManager
- */
- function __construct(IRootFolder $rootFolder, IUserManager $userManager) {
+ public function __construct(
+ protected IRootFolder $rootFolder,
+ protected IUserManager $userManager,
+ protected VersionsMapper $versionMapper,
+ ) {
parent::__construct();
- $this->userManager = $userManager;
- $this->rootFolder = $rootFolder;
}
- protected function configure() {
+ protected function configure(): void {
$this
->setName('versions:cleanup')
->setDescription('Delete versions')
@@ -57,59 +34,82 @@ class CleanUp extends Command {
'user_id',
InputArgument::OPTIONAL | InputArgument::IS_ARRAY,
'delete versions of the given user(s), if no user is given all versions will be deleted'
+ )
+ ->addOption(
+ 'path',
+ 'p',
+ InputOption::VALUE_REQUIRED,
+ 'only delete versions of this path, e.g. --path="/alice/files/Music"'
);
}
- protected function execute(InputInterface $input, OutputInterface $output) {
-
+ protected function execute(InputInterface $input, OutputInterface $output): int {
$users = $input->getArgument('user_id');
+
+ $path = $input->getOption('path');
+ if ($path) {
+ if (!preg_match('#^/([^/]+)/files(/.*)?$#', $path, $pathMatches)) {
+ $output->writeln('<error>Invalid path given</error>');
+ return self::FAILURE;
+ }
+
+ $users = [ $pathMatches[1] ];
+ $path = trim($pathMatches[2], '/');
+ }
+
if (!empty($users)) {
foreach ($users as $user) {
- if ($this->userManager->userExists($user)) {
- $output->writeln("Delete versions of <info>$user</info>");
- $this->deleteVersions($user);
- } else {
+ if (!$this->userManager->userExists($user)) {
$output->writeln("<error>Unknown user $user</error>");
+ return self::FAILURE;
}
+
+ $output->writeln("Delete versions of <info>$user</info>");
+ $this->deleteVersions($user, $path);
}
- } else {
- $output->writeln('Delete all versions');
- foreach ($this->userManager->getBackends() as $backend) {
- $name = get_class($backend);
+ return self::SUCCESS;
+ }
- if ($backend instanceof IUserBackend) {
- $name = $backend->getBackendName();
- }
+ $output->writeln('Delete all versions');
+ foreach ($this->userManager->getBackends() as $backend) {
+ $name = get_class($backend);
- $output->writeln("Delete versions 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->deleteVersions($user);
- }
- $offset += $limit;
- } while (count($users) >= $limit);
+ if ($backend instanceof IUserBackend) {
+ $name = $backend->getBackendName();
}
+
+ $output->writeln("Delete versions 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->deleteVersions($user);
+ }
+ $offset += $limit;
+ } while (count($users) >= $limit);
}
+
+ return self::SUCCESS;
}
/**
* delete versions for the given user
- *
- * @param string $user
*/
- protected function deleteVersions($user) {
+ protected function deleteVersions(string $user, ?string $path = null): void {
\OC_Util::tearDownFS();
\OC_Util::setupFS($user);
- if ($this->rootFolder->nodeExists('/' . $user . '/files_versions')) {
- $this->rootFolder->get('/' . $user . '/files_versions')->delete();
+
+ $userHomeStorageId = $this->rootFolder->getUserFolder($user)->getStorage()->getCache()->getNumericStorageId();
+ $this->versionMapper->deleteAllVersionsForUser($userHomeStorageId, $path);
+
+ $fullPath = '/' . $user . '/files_versions' . ($path ? '/' . $path : '');
+ if ($this->rootFolder->nodeExists($fullPath)) {
+ $this->rootFolder->get($fullPath)->delete();
}
}
-
}
diff --git a/apps/files_versions/lib/Command/Expire.php b/apps/files_versions/lib/Command/Expire.php
index fdb72c91887..a30e623c347 100644
--- a/apps/files_versions/lib/Command/Expire.php
+++ b/apps/files_versions/lib/Command/Expire.php
@@ -1,64 +1,49 @@
<?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 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: 2020 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
+ * SPDX-License-Identifier: AGPL-3.0-only
*/
-
namespace OCA\Files_Versions\Command;
use OC\Command\FileAccess;
use OCA\Files_Versions\Storage;
use OCP\Command\ICommand;
+use OCP\Files\StorageNotAvailableException;
+use OCP\IUserManager;
+use OCP\Server;
+use Psr\Log\LoggerInterface;
class Expire implements ICommand {
use FileAccess;
- /**
- * @var string
- */
- private $fileName;
-
- /**
- * @var string
- */
- private $user;
-
- /**
- * @param string $user
- * @param string $fileName
- */
- function __construct($user, $fileName) {
- $this->user = $user;
- $this->fileName = $fileName;
+ public function __construct(
+ private string $user,
+ private string $fileName,
+ ) {
}
-
- public function handle() {
- $userManager = \OC::$server->getUserManager();
+ public function handle(): void {
+ /** @var IUserManager $userManager */
+ $userManager = Server::get(IUserManager::class);
if (!$userManager->userExists($this->user)) {
// User has been deleted already
return;
}
- Storage::expire($this->fileName, $this->user);
+ try {
+ Storage::expire($this->fileName, $this->user);
+ } catch (StorageNotAvailableException $e) {
+ // In case of external storage and session credentials, the expiration
+ // fails because the command does not have those credentials
+
+ $logger = Server::get(LoggerInterface::class);
+ $logger->warning($e->getMessage(), [
+ 'exception' => $e,
+ 'uid' => $this->user,
+ 'fileName' => $this->fileName,
+ ]);
+ }
}
}
diff --git a/apps/files_versions/lib/Command/ExpireVersions.php b/apps/files_versions/lib/Command/ExpireVersions.php
index 09de0ad6d90..d3f341a21d2 100644
--- a/apps/files_versions/lib/Command/ExpireVersions.php
+++ b/apps/files_versions/lib/Command/ExpireVersions.php
@@ -1,28 +1,13 @@
<?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: 2018 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2016 ownCloud GmbH.
+ * SPDX-License-Identifier: AGPL-3.0-only
*/
-
namespace OCA\Files_Versions\Command;
+use OC\Files\View;
use OCA\Files_Versions\Expiration;
use OCA\Files_Versions\Storage;
use OCP\IUser;
@@ -34,72 +19,58 @@ use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
class ExpireVersions 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 IUserManager $userManager,
+ private Expiration $expiration,
+ ) {
parent::__construct();
-
- $this->userManager = $userManager;
- $this->expiration = $expiration;
}
- protected function configure() {
+ protected function configure(): void {
$this
->setName('versions:expire')
->setDescription('Expires the users file versions')
->addArgument(
'user_id',
InputArgument::OPTIONAL | InputArgument::IS_ARRAY,
- 'expire file versions of the given user(s), if no user is given file versions for all users will be expired.'
+ 'expire file versions of the given account(s), if no account is given file versions for all accounts will be expired.'
);
}
- protected function execute(InputInterface $input, OutputInterface $output) {
-
+ protected function execute(InputInterface $input, OutputInterface $output): int {
$maxAge = $this->expiration->getMaxAgeAsTimestamp();
if (!$maxAge) {
- $output->writeln("No expiry configured.");
- return;
+ $output->writeln('Auto expiration is configured - expiration will be handled automatically according to the expiration patterns detailed at the following link https://docs.nextcloud.com/server/latest/admin_manual/configuration_files/file_versioning.html.');
+ return self::FAILURE;
}
$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->expireVersionsForUser($userObject);
- } else {
- $output->writeln("<error>Unknown user $user</error>");
+ if (!$this->userManager->userExists($user)) {
+ $output->writeln("<error>Unknown account $user</error>");
+ return self::FAILURE;
}
+
+ $output->writeln("Remove deleted files of <info>$user</info>");
+ $userObject = $this->userManager->get($user);
+ $this->expireVersionsForUser($userObject);
}
- } else {
- $p = new ProgressBar($output);
- $p->start();
- $this->userManager->callForSeenUsers(function(IUser $user) use ($p) {
- $p->advance();
- $this->expireVersionsForUser($user);
- });
- $p->finish();
- $output->writeln('');
+ return self::SUCCESS;
}
+
+ $p = new ProgressBar($output);
+ $p->start();
+ $this->userManager->callForSeenUsers(function (IUser $user) use ($p): void {
+ $p->advance();
+ $this->expireVersionsForUser($user);
+ });
+ $p->finish();
+ $output->writeln('');
+ return self::SUCCESS;
}
- function expireVersionsForUser(IUser $user) {
+ public function expireVersionsForUser(IUser $user): void {
$uid = $user->getUID();
if (!$this->setupFS($uid)) {
return;
@@ -109,15 +80,13 @@ class ExpireVersions extends Command {
/**
* Act on behalf on versions item owner
- * @param string $user
- * @return boolean
*/
- protected function setupFS($user) {
+ protected function setupFS(string $user): bool {
\OC_Util::tearDownFS();
\OC_Util::setupFS($user);
// Check if this user has a version directory
- $view = new \OC\Files\View('/' . $user);
+ $view = new View('/' . $user);
if (!$view->is_dir('/files_versions')) {
return false;
}