File: treeview.inc

package info (click to toggle)
ldap-account-manager 8.3-1
  • links: PTS
  • area: main
  • in suites: bookworm
  • size: 103,380 kB
  • sloc: php: 249,996; javascript: 154,941; pascal: 38,010; perl: 414; xml: 252; sh: 195; makefile: 184
file content (146 lines) | stat: -rw-r--r-- 3,248 bytes parent folder | download | duplicates (2)
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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
<?php
namespace LAM\TOOLS\TREEVIEW;
use htmlOutputText;
use htmlResponsiveInputField;
use htmlResponsiveRow;
use htmlElement;
use LAMTool;

/*

  This code is part of LDAP Account Manager (http://www.ldap-account-manager.org/)
  Copyright (C) 2021 - 2022  Roland Gruber

  This program is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2 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 General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

*/

/**
* LDAP tree view.
*
* @author Roland Gruber
* @package tools
*/

/**
 * LDAP tree view.
 *
 * @package tools
 */
class TreeViewTool extends LAMTool {

	const TREE_SUFFIX_CONFIG = 'treeViewSuffix';

	/**
	 * {@inheritDoc}
	 */
	public function getName(): string {
	 	return _('Tree view');
	 }

	/**
	 * {@inheritDoc}
	 */
	public function getDescription(): string {
		return _("This is an LDAP browser to work on raw LDAP data.");
	}

	/**
	 * {@inheritDoc}
	 */
	public function getLink(): string {
		return "tools/treeView.php";
	}

	/**
	 * {@inheritDoc}
	 */
	public function getRequiresWriteAccess(): bool {
		return false;
	}

	/**
	 * {@inheritDoc}
	 */
	public function getRequiresPasswordChangeRights(): bool {
		return false;
	}

	/**
	 * {@inheritDoc}
	 */
	public function getImageLink(): string {
		return 'tree.svg';
	}

	/**
	 * {@inheritDoc}
	 */
	public function getPosition(): int {
		return 550;
	}

	/**
	 * {@inheritDoc}
	 */
	public function isVisible(): bool {
		return true;
	}

	/**
	 * {@inheritDoc}
	 */
	public function getConfigOptions(array $settings): ?htmlElement {
		$row = new htmlResponsiveRow();
		$row->add(new htmlOutputText(_('Tree view')), 12);
		$suffix = !empty($settings[self::TREE_SUFFIX_CONFIG]) ? $settings[self::TREE_SUFFIX_CONFIG] : '';
		$row->add(new htmlResponsiveInputField(_('Tree suffix'), self::TREE_SUFFIX_CONFIG, $suffix, '203'), 12);
		$row->addVerticalSpacer('1rem');
		return $row;
	}

	/**
	 * {@inheritDoc}
	 */
	public function checkConfigurationOptions(array $settings): array {
		$errors = array();
		$roots = self::getRootDns($settings);
		foreach ($roots as $root) {
			if (!get_preg($root, 'dn')) {
				$errors[] = array('ERROR', _('Tree suffix is invalid.'), htmlspecialchars($root));
			}
		}
		return $errors;
	}

	/**
	 * Returns the list of configured root DNs.
	 *
	 * @param array|null $settings
	 * @return string[] root DNs
	 */
	public static function getRootDns(?array $settings = null): array {
		$roots = array();
		$toolSettings = $settings;
		if ($toolSettings === null) {
			$toolSettings = $_SESSION['config']->getToolSettings();
		}
		if (!empty($toolSettings[self::TREE_SUFFIX_CONFIG])) {
			$roots = explode(';', $toolSettings[self::TREE_SUFFIX_CONFIG]);
		}
		return $roots;
	}

}