Merge pull request #26176 from nextcloud/backport/26076/stable20

[stable20] adds ldap user:reset command

apps/user_ldap/appinfo/register_command.php

@@ -30,6 +30,8 @@
 use OCA\User_LDAP\User_Proxy;
 use OCA\User_LDAP\Mapping\UserMapping;
 use OCA\User_LDAP\User\DeletedUsersIndex;
+use OCA\User_LDAP\UserPluginManager;
+use OCP\IUserManager;
 
 $dbConnection = \OC::$server->getDatabaseConnection();
 $userMapping = new UserMapping($dbConnection);
@@ -41,7 +43,7 @@
 	$ocConfig,
 	\OC::$server->getNotificationManager(),
 	\OC::$server->getUserSession(),
-	\OC::$server->query(\OCA\User_LDAP\UserPluginManager::class)
+	\OC::$server->query(UserPluginManager::class)
 );
 $deletedUsersIndex = new DeletedUsersIndex(
 	$ocConfig, $dbConnection, $userMapping
@@ -52,6 +54,11 @@
 $application->add(new OCA\User_LDAP\Command\TestConfig());
 $application->add(new OCA\User_LDAP\Command\CreateEmptyConfig($helper));
 $application->add(new OCA\User_LDAP\Command\DeleteConfig($helper));
+$application->add(new OCA\User_LDAP\Command\ResetUser(
+	$deletedUsersIndex,
+	\OC::$server->get(IUserManager::class),
+	\OC::$server->get(UserPluginManager::class)
+));
 $application->add(new OCA\User_LDAP\Command\Search($ocConfig));
 $application->add(new OCA\User_LDAP\Command\ShowRemnants(
 	$deletedUsersIndex, \OC::$server->getDateTimeFormatter())

apps/user_ldap/composer/composer/autoload_classmap.php

@@ -13,6 +13,7 @@
     'OCA\\User_LDAP\\Command\\CheckUser' => $baseDir . '/../lib/Command/CheckUser.php',
     'OCA\\User_LDAP\\Command\\CreateEmptyConfig' => $baseDir . '/../lib/Command/CreateEmptyConfig.php',
     'OCA\\User_LDAP\\Command\\DeleteConfig' => $baseDir . '/../lib/Command/DeleteConfig.php',
+    'OCA\\User_LDAP\\Command\\ResetUser' => $baseDir . '/../lib/Command/ResetUser.php',
     'OCA\\User_LDAP\\Command\\Search' => $baseDir . '/../lib/Command/Search.php',
     'OCA\\User_LDAP\\Command\\SetConfig' => $baseDir . '/../lib/Command/SetConfig.php',
     'OCA\\User_LDAP\\Command\\ShowConfig' => $baseDir . '/../lib/Command/ShowConfig.php',

apps/user_ldap/composer/composer/autoload_static.php

@@ -28,6 +28,7 @@ class ComposerStaticInitUser_LDAP
         'OCA\\User_LDAP\\Command\\CheckUser' => __DIR__ . '/..' . '/../lib/Command/CheckUser.php',
         'OCA\\User_LDAP\\Command\\CreateEmptyConfig' => __DIR__ . '/..' . '/../lib/Command/CreateEmptyConfig.php',
         'OCA\\User_LDAP\\Command\\DeleteConfig' => __DIR__ . '/..' . '/../lib/Command/DeleteConfig.php',
+        'OCA\\User_LDAP\\Command\\ResetUser' => __DIR__ . '/..' . '/../lib/Command/ResetUser.php',
         'OCA\\User_LDAP\\Command\\Search' => __DIR__ . '/..' . '/../lib/Command/Search.php',
         'OCA\\User_LDAP\\Command\\SetConfig' => __DIR__ . '/..' . '/../lib/Command/SetConfig.php',
         'OCA\\User_LDAP\\Command\\ShowConfig' => __DIR__ . '/..' . '/../lib/Command/ShowConfig.php',

apps/user_ldap/lib/Command/ResetUser.php

@@ -0,0 +1,112 @@
+<?php
+/**
+ * @copyright Copyright (c) 2021 Arthur Schiwon <[email protected]>
+ *
+ * @author Arthur Schiwon <[email protected]>
+ *
+ * @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\User_LDAP\Command;
+
+use OCA\User_LDAP\User\DeletedUsersIndex;
+use OCA\User_LDAP\User_Proxy;
+use OCA\User_LDAP\UserPluginManager;
+use OCP\IUser;
+use OCP\IUserManager;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Helper\QuestionHelper;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Question\Question;
+
+class ResetUser extends Command {
+	/** @var DeletedUsersIndex */
+	protected $dui;
+	/** @var IUserManager */
+	private $userManager;
+	/** @var UserPluginManager */
+	private $pluginManager;
+
+	public function __construct(
+		DeletedUsersIndex $dui,
+		IUserManager $userManager,
+		UserPluginManager $pluginManager
+	) {
+		$this->dui = $dui;
+		$this->userManager = $userManager;
+		$this->pluginManager = $pluginManager;
+		parent::__construct();
+	}
+
+	protected function configure() {
+		$this
+			->setName('ldap:reset-user')
+			->setDescription('deletes an LDAP user independent of the user state')
+			->addArgument(
+				'uid',
+				InputArgument::REQUIRED,
+				'the user id as used in Nextcloud'
+			)
+			->addOption(
+				'yes',
+				'y',
+				InputOption::VALUE_NONE,
+				'do not ask for confirmation'
+			);
+	}
+
+	protected function execute(InputInterface $input, OutputInterface $output): int {
+		try {
+			$uid = $input->getArgument('uid');
+			$user = $this->userManager->get($uid);
+			if (!$user instanceof IUser) {
+				throw new \Exception('User not found');
+			}
+			$backend = $user->getBackend();
+			if (!$backend instanceof User_Proxy) {
+				throw new \Exception('The given user is not a recognized LDAP user.');
+			}
+			if ($input->getOption('yes') === false) {
+				/** @var QuestionHelper $helper */
+				$helper = $this->getHelper('question');
+				$q = new Question('Delete all local data of this user (y|N)? ');
+				$input->setOption('yes', $helper->ask($input, $output, $q) === 'y');
+			}
+			if ($input->getOption('yes') !== true) {
+				throw new \Exception('Reset cancelled by operator');
+			}
+
+			$this->dui->markUser($uid);
+			$pluginManagerSuppressed = $this->pluginManager->setSuppressDeletion(true);
+			if ($user->delete()) {
+				$this->pluginManager->setSuppressDeletion($pluginManagerSuppressed);
+				return 0;
+			}
+		} catch (\Throwable $e) {
+			if (isset($pluginManagerSuppressed)) {
+				$this->pluginManager->setSuppressDeletion($pluginManagerSuppressed);
+			}
+			$output->writeln('<error>' . $e->getMessage() . '</error>');
+			return 1;
+		}
+		$output->writeln('<error>Error while resetting user</error>');
+		return 2;
+	}
+}

apps/user_ldap/lib/UserPluginManager.php

@@ -28,8 +28,6 @@
 use OC\User\Backend;
 
 class UserPluginManager {
-	public $test = false;
-
 	private $respondToActions = 0;
 
 	private $which = [
@@ -43,6 +41,9 @@ class UserPluginManager {
 		'deleteUser' => null
 	];
 
+	/** @var bool */
+	private $suppressDeletion = false;
+
 	/**
 	 * @return int All implemented actions, except for 'deleteUser'
 	 */
@@ -192,7 +193,7 @@ public function countUsers() {
 	 * @return bool
 	 */
 	public function canDeleteUser() {
-		return $this->which['deleteUser'] !== null;
+		return !$this->suppressDeletion && $this->which['deleteUser'] !== null;
 	}
 
 	/**
@@ -203,8 +204,21 @@ public function canDeleteUser() {
 	public function deleteUser($uid) {
 		$plugin = $this->which['deleteUser'];
 		if ($plugin) {
+			if ($this->suppressDeletion) {
+				return false;
+			}
 			return $plugin->deleteUser($uid);
 		}
 		throw new \Exception('No plugin implements deleteUser in this LDAP Backend.');
 	}
+
+	/**
+	 * @param bool $value
+	 * @return bool – the value before the change
+	 */
+	public function setSuppressDeletion(bool $value): bool {
+		$old = $this->suppressDeletion;
+		$this->suppressDeletion = $value;
+		return $old;
+	}
 }