aboutsummaryrefslogtreecommitdiffstats
path: root/apps/user_ldap/lib/SetupChecks/LdapConnection.php
blob: 63877ff06ae67c14b3c2f2b50e9818fa4bd50e88 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
<?php

declare(strict_types=1);

/**
 * @copyright Copyright (c) 2024 Côme Chilliet <come.chilliet@nextcloud.com>
 *
 * @author Côme Chilliet <come.chilliet@nextcloud.com>
 *
 * @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 <https://www.gnu.org/licenses/>.
 *
 */

namespace OCA\User_LDAP\SetupChecks;

use OCA\User_LDAP\AccessFactory;
use OCA\User_LDAP\ConnectionFactory;
use OCA\User_LDAP\Helper;
use OCP\IL10N;
use OCP\SetupCheck\ISetupCheck;
use OCP\SetupCheck\SetupResult;

class LdapConnection implements ISetupCheck {
	public function __construct(
		private IL10N $l10n,
		private Helper $helper,
		private ConnectionFactory $connectionFactory,
		private AccessFactory $accessFactory,
	) {
	}

	public function getCategory(): string {
		return 'ldap';
	}

	public function getName(): string {
		return $this->l10n->t('LDAP Connection');
	}

	public function run(): SetupResult {
		$availableConfigs = $this->helper->getServerConfigurationPrefixes();
		$inactiveConfigurations = [];
		$bindFailedConfigurations = [];
		$searchFailedConfigurations = [];
		foreach ($availableConfigs as $configID) {
			$connection = $this->connectionFactory->get($configID);
			if (!$connection->ldapConfigurationActive) {
				$inactiveConfigurations[] = $configID;
				continue;
			}
			if (!$connection->bind()) {
				$bindFailedConfigurations[] = $configID;
				continue;
			}
			$access = $this->accessFactory->get($connection);
			$result = $access->countObjects(1);
			if (!is_int($result) || ($result <= 0)) {
				$searchFailedConfigurations[] = $configID;
			}
		}
		$output = '';
		if (!empty($bindFailedConfigurations)) {
			$output .= $this->l10n->n(
				'Binding failed for this LDAP configuration: %s',
				'Binding failed for these LDAP configurations: %s',
				count($bindFailedConfigurations),
				[implode(',', $bindFailedConfigurations)]
			)."\n";
		}
		if (!empty($searchFailedConfigurations)) {
			$output .= $this->l10n->n(
				'Searching failed for this LDAP configuration: %s',
				'Searching failed for these LDAP configurations: %s',
				count($searchFailedConfigurations),
				[implode(',', $searchFailedConfigurations)]
			)."\n";
		}
		if (!empty($inactiveConfigurations)) {
			$output .= $this->l10n->n(
				'There is an inactive LDAP configuration: %s',
				'There are inactive LDAP configurations: %s',
				count($inactiveConfigurations),
				[implode(',', $inactiveConfigurations)]
			)."\n";
		}
		if (!empty($bindFailedConfigurations) || !empty($searchFailedConfigurations)) {
			return SetupResult::error($output);
		} elseif (!empty($inactiveConfigurations)) {
			return SetupResult::warning($output);
		}
		return SetupResult::success($this->l10n->n(
			'Binding and searching works on the configured LDAP connection (%s)',
			'Binding and searching works on all of the configured LDAP connections (%s)',
			count($availableConfigs),
			[implode(',', $availableConfigs)]
		));
	}
}