feat(user_ldap): Add a wizard OCS API

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

apps/user_ldap/lib/Controller/WizardController.php

@@ -0,0 +1,120 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\User_LDAP\Controller;
+
+use OCA\User_LDAP\Configuration;
+use OCA\User_LDAP\ConnectionFactory;
+use OCA\User_LDAP\Settings\Admin;
+use OCA\User_LDAP\WizardFactory;
+use OCP\AppFramework\Http;
+use OCP\AppFramework\Http\Attribute\ApiRoute;
+use OCP\AppFramework\Http\Attribute\AuthorizedAdminSetting;
+use OCP\AppFramework\Http\DataResponse;
+use OCP\AppFramework\OCS\OCSException;
+use OCP\AppFramework\OCSController;
+use OCP\IL10N;
+use OCP\IRequest;
+use Psr\Log\LoggerInterface;
+
+class WizardController extends OCSController {
+	public function __construct(
+		string $appName,
+		IRequest $request,
+		private LoggerInterface $logger,
+		private ConnectionFactory $connectionFactory,
+		private IL10N $l,
+		private WizardFactory $wizardFactory,
+	) {
+		parent::__construct($appName, $request);
+	}
+
+	/**
+	 * Run a wizard action and returns the result
+	 *
+	 * @return DataResponse<Http::STATUS_OK, array, array{}>
+	 * @throws OCSException
+	 *
+	 * 200: Wizard action result
+	 */
+	#[AuthorizedAdminSetting(settings: Admin::class)]
+	#[ApiRoute(verb: 'POST', url: '/api/v1/wizard/{configID}/{action}')]
+	public function action(string $configID, string $action, ?string $loginName, ?string $key, ?string $val) {
+		try {
+			$wizard = $this->wizardFactory->get($configID);
+			switch ($action) {
+				case 'guessPortAndTLS':
+				case 'guessBaseDN':
+				case 'detectEmailAttribute':
+				case 'detectUserDisplayNameAttribute':
+				case 'determineGroupMemberAssoc':
+				case 'determineUserObjectClasses':
+				case 'determineGroupObjectClasses':
+				case 'determineGroupsForUsers':
+				case 'determineGroupsForGroups':
+				case 'determineAttributes':
+				case 'getUserListFilter':
+				case 'getUserLoginFilter':
+				case 'getGroupFilter':
+				case 'countUsers':
+				case 'countGroups':
+				case 'countInBaseDN':
+					try {
+						$result = $wizard->$action();
+						if ($result !== false) {
+							return new DataResponse($result->getResultArray());
+						}
+					} catch (\Exception $e) {
+						throw new OCSException($e->getMessage());
+					}
+					throw new OCSException();
+
+				case 'testLoginName':
+					try {
+						if ($loginName === null || $loginName === '') {
+							throw new OCSException('No login name passed');
+						}
+						$result = $wizard->$action($loginName);
+						if ($result !== false) {
+							return new DataResponse($result->getResultArray());
+						}
+					} catch (\Exception $e) {
+						throw new OCSException($e->getMessage());
+					}
+					throw new OCSException();
+
+				case 'save':
+					if ($key === null || $val === null) {
+						throw new OCSException($this->l->t('No data specified'));
+						exit;
+					}
+					$setParameters = [];
+					$configuration = new Configuration($configID);
+					$configuration->setConfiguration([$key => $val], $setParameters);
+					if (!in_array($key, $setParameters)) {
+						throw new OCSException($this->l->t('Could not set configuration %1$s to %2$s', [$key, $setParameters[0]]));
+					}
+					$configuration->saveConfiguration();
+					//clear the cache on save
+					$connection = $this->connectionFactory->get($configID);
+					$connection->clearCache();
+					return new DataResponse();
+					break;
+				default:
+					throw new OCSException($this->l->t('Action does not exist'));
+					break;
+			}
+		} catch (OCSException $e) {
+			throw $e;
+		} catch (\Exception $e) {
+			$this->logger->error($e->getMessage(), ['exception' => $e]);
+			throw new OCSException('An issue occurred when creating the new config.');
+		}
+	}
+}

apps/user_ldap/lib/WizardFactory.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\User_LDAP;
+
+class WizardFactory {
+	public function __construct(
+		private ILDAPWrapper $ldap,
+		private AccessFactory $accessFactory,
+	) {
+	}
+
+	public function get(string $configID): Wizard {
+		$configuration = new Configuration($configID);
+
+		$connection = new Connection($this->ldap, $configID, null);
+		$connection->setConfiguration($configuration->getConfiguration());
+		$connection->ldapConfigurationActive = (string)true;
+		$connection->setIgnoreValidation(true);
+
+		$access = $this->accessFactory->get($connection);
+
+		return new Wizard($configuration, $this->ldap, $access);
+	}
+}