Blame view

sources/apps/user_ldap/lib/helper.php 4.95 KB
03e52840d   Kload   Init
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
  <?php
  
  /**
   * ownCloud – LDAP Helper
   *
   * @author Arthur Schiwon
   * @copyright 2013 Arthur Schiwon blizzz@owncloud.com
   *
   * This library is free software; you can redistribute it and/or
   * modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
   * License as published by the Free Software Foundation; either
   * version 3 of the License, or any later version.
   *
   * This library 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 library.  If not, see <http://www.gnu.org/licenses/>.
   *
   */
  
  namespace OCA\user_ldap\lib;
  
  class Helper {
  
  	/**
  	 * @brief returns prefixes for each saved LDAP/AD server configuration.
  	 * @param bool optional, whether only active configuration shall be
  	 * retrieved, defaults to false
  	 * @return array with a list of the available prefixes
  	 *
  	 * Configuration prefixes are used to set up configurations for n LDAP or
  	 * AD servers. Since configuration is stored in the database, table
  	 * appconfig under appid user_ldap, the common identifiers in column
  	 * 'configkey' have a prefix. The prefix for the very first server
  	 * configuration is empty.
  	 * Configkey Examples:
  	 * Server 1: ldap_login_filter
  	 * Server 2: s1_ldap_login_filter
  	 * Server 3: s2_ldap_login_filter
  	 *
  	 * The prefix needs to be passed to the constructor of Connection class,
  	 * except the default (first) server shall be connected to.
  	 *
  	 */
  	static public function getServerConfigurationPrefixes($activeConfigurations = false) {
  		$referenceConfigkey = 'ldap_configuration_active';
  
  		$query = '
  			SELECT DISTINCT `configkey`
  			FROM `*PREFIX*appconfig`
  			WHERE `appid` = \'user_ldap\'
  				AND `configkey` LIKE ?
  		';
  		if($activeConfigurations) {
31b7f2792   Kload   Upgrade to ownclo...
58
  			$query .= ' AND `configvalue` = \'1\'';
03e52840d   Kload   Init
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
  		}
  		$query = \OCP\DB::prepare($query);
  
  		$serverConfigs = $query->execute(array('%'.$referenceConfigkey))->fetchAll();
  		$prefixes = array();
  
  		foreach($serverConfigs as $serverConfig) {
  			$len = strlen($serverConfig['configkey']) - strlen($referenceConfigkey);
  			$prefixes[] = substr($serverConfig['configkey'], 0, $len);
  		}
  
  		return $prefixes;
  	}
  
  	/**
31b7f2792   Kload   Upgrade to ownclo...
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
  	 *
  	 * @brief determines the host for every configured connection
  	 * @return an array with configprefix as keys
  	 *
  	 */
  	static public function getServerConfigurationHosts() {
  		$referenceConfigkey = 'ldap_host';
  
  		$query = '
  			SELECT DISTINCT `configkey`, `configvalue`
  			FROM `*PREFIX*appconfig`
  			WHERE `appid` = \'user_ldap\'
  				AND `configkey` LIKE ?
  		';
  		$query = \OCP\DB::prepare($query);
  		$configHosts = $query->execute(array('%'.$referenceConfigkey))->fetchAll();
  		$result = array();
  
  		foreach($configHosts as $configHost) {
  			$len = strlen($configHost['configkey']) - strlen($referenceConfigkey);
  			$prefix = substr($configHost['configkey'], 0, $len);
  			$result[$prefix] = $configHost['configvalue'];
  		}
  
  		return $result;
  	}
  
  	/**
03e52840d   Kload   Init
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
  	 * @brief deletes a given saved LDAP/AD server configuration.
  	 * @param string the configuration prefix of the config to delete
  	 * @return bool true on success, false otherwise
  	 */
  	static public function deleteServerConfiguration($prefix) {
  		//just to be on the safe side
  		\OCP\User::checkAdminUser();
  
  		if(!in_array($prefix, self::getServerConfigurationPrefixes())) {
  			return false;
  		}
  
  		$query = \OCP\DB::prepare('
  			DELETE
  			FROM `*PREFIX*appconfig`
  			WHERE `configkey` LIKE ?
  				AND `appid` = \'user_ldap\'
  				AND `configkey` NOT IN (\'enabled\', \'installed_version\', \'types\', \'bgjUpdateGroupsLastRun\')
  		');
  		$delRows = $query->execute(array($prefix.'%'));
  
  		if(\OCP\DB::isError($delRows)) {
  			return false;
  		}
31b7f2792   Kload   Upgrade to ownclo...
126
  		if($delRows === 0) {
03e52840d   Kload   Init
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
  			return false;
  		}
  
  		return true;
  	}
  
  	/**
  	 * Truncate's the given mapping table
  	 *
  	 * @param string $mapping either 'user' or 'group'
  	 * @return boolean true on success, false otherwise
  	 */
  	static public function clearMapping($mapping) {
  		if($mapping === 'user') {
  			$table = '`*PREFIX*ldap_user_mapping`';
  		} else if ($mapping === 'group') {
  			$table = '`*PREFIX*ldap_group_mapping`';
  		} else {
  			return false;
  		}
31b7f2792   Kload   Upgrade to ownclo...
147
  		if(strpos(\OCP\Config::getSystemValue('dbtype'), 'sqlite') !== false) {
03e52840d   Kload   Init
148
149
150
151
152
153
154
155
156
157
158
159
160
161
  			$query = \OCP\DB::prepare('DELETE FROM '.$table);
  		} else {
  			$query = \OCP\DB::prepare('TRUNCATE '.$table);
  		}
  
  
  		$res = $query->execute();
  
  		if(\OCP\DB::isError($res)) {
  			return false;
  		}
  
  		return true;
  	}
31b7f2792   Kload   Upgrade to ownclo...
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
  
  	/**
  	 * @brief extractsthe domain from a given URL
  	 * @param $url the URL
  	 * @return mixed, domain as string on success, false otherwise
  	 */
  	static public function getDomainFromURL($url) {
  		$uinfo = parse_url($url);
  		if(!is_array($uinfo)) {
  			return false;
  		}
  
  		$domain = false;
  		if(isset($uinfo['host'])) {
  			$domain = $uinfo['host'];
  		} else if(isset($uinfo['path'])) {
  			$domain = $uinfo['path'];
  		}
  
  		return $domain;
  	}
03e52840d   Kload   Init
183
  }