feat(user_ldap): Add option to check all seen users

This can be useful in some situations to sync all seen users with --update

Signed-off-by: Côme Chilliet <come.chilliet@nextcloud.com>

Author: come-nc

apps/user_ldap/lib/Command/CheckUser.php

@@ -11,6 +11,8 @@
 use OCA\User_LDAP\Mapping\UserMapping;
 use OCA\User_LDAP\User\DeletedUsersIndex;
 use OCA\User_LDAP\User_Proxy;
+use OCP\IUser;
+use OCP\IUserManager;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
@@ -23,6 +25,7 @@ public function __construct(
 		protected Helper $helper,
 		protected DeletedUsersIndex $dui,
 		protected UserMapping $mapping,
+		protected IUserManager $userManager,
 	) {
 		parent::__construct();
 	}
@@ -33,7 +36,7 @@ protected function configure(): void {
 			->setDescription('checks whether a user exists on LDAP.')
 			->addArgument(
 				'ocName',
-				InputArgument::REQUIRED,
+				InputArgument::OPTIONAL,
 				'the user name as used in Nextcloud, or the LDAP DN'
 			)
 			->addOption(
@@ -48,44 +51,74 @@ protected function configure(): void {
 				InputOption::VALUE_NONE,
 				'syncs values from LDAP'
 			)
+			->addOption(
+				'all-seen-users',
+				null,
+				InputOption::VALUE_NONE,
+				'sync all seen users instead of only one'
+			)
 		;
 	}
 
 	protected function execute(InputInterface $input, OutputInterface $output): int {
 		try {
 			$this->assertAllowed($input->getOption('force'));
 			$uid = $input->getArgument('ocName');
-			if ($this->backend->getLDAPAccess($uid)->stringResemblesDN($uid)) {
-				$username = $this->backend->dn2UserName($uid);
-				if ($username !== false) {
-					$uid = $username;
-				}
-			}
-			$wasMapped = $this->userWasMapped($uid);
-			$exists = $this->backend->userExistsOnLDAP($uid, true);
-			if ($exists === true) {
-				$output->writeln('The user is still available on LDAP.');
-				if ($input->getOption('update')) {
-					$this->updateUser($uid, $output);
-				}
-				return self::SUCCESS;
-			}
 
-			if ($wasMapped) {
-				$this->dui->markUser($uid);
-				$output->writeln('The user does not exists on LDAP anymore.');
-				$output->writeln('Clean up the user\'s remnants by: ./occ user:delete "'
-					. $uid . '"');
+			if ($uid !== null) {
+				return $this->checkUser($input, $output, $uid);
+			} elseif ($input->getOption('all-seen-users')) {
+				$this->userManager->callForSeenUsers(
+					function (IUser $user) use ($input, $output): true {
+						try {
+							$output->writeln('<info>Checking ' . $user->getUID() . '…</info>', OutputInterface::VERBOSITY_VERBOSE);
+							$this->checkUser($input, $output, $user->getUID());
+						} catch (\Exception $e) {
+							$output->writeln('<error> ' . $user->getUID() . ': ' . $e->getMessage() . '</error>');
+						}
+						/* Always continue */
+						return true;
+					}
+				);
+				$output->writeln('<info>Finished checking all seen users.</info>', OutputInterface::VERBOSITY_VERBOSE);
 				return self::SUCCESS;
+			} else {
+				throw new \InvalidArgumentException('Either a user name or --all-seen-users is required');
 			}
-
-			throw new \Exception('The given user is not a recognized LDAP user.');
 		} catch (\Exception $e) {
 			$output->writeln('<error>' . $e->getMessage() . '</error>');
 			return self::FAILURE;
 		}
 	}
 
+	private function checkUser(InputInterface $input, OutputInterface $output, string $uid): int {
+		if ($this->backend->getLDAPAccess($uid)->stringResemblesDN($uid)) {
+			$username = $this->backend->dn2UserName($uid);
+			if ($username !== false) {
+				$uid = $username;
+			}
+		}
+		$wasMapped = $this->userWasMapped($uid);
+		$exists = $this->backend->userExistsOnLDAP($uid, true);
+		if ($exists === true) {
+			$output->writeln('The user is still available on LDAP.');
+			if ($input->getOption('update')) {
+				$this->updateUser($uid, $output);
+			}
+			return self::SUCCESS;
+		}
+
+		if ($wasMapped) {
+			$this->dui->markUser($uid);
+			$output->writeln('The user does not exists on LDAP anymore.');
+			$output->writeln('Clean up the user\'s remnants by: ./occ user:delete "'
+				. $uid . '"');
+			return self::SUCCESS;
+		}
+
+		throw new \Exception('The given user is not a recognized LDAP user.');
+	}
+
 	/**
 	 * checks whether a user is actually mapped
 	 * @param string $ocName the username as used in Nextcloud