Blame view

sources/apps/user_ldap/lib/helper.php 5.36 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
  <?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 {
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
29
30
  	 * returns prefixes for each saved LDAP/AD server configuration.
  	 * @param bool $activeConfigurations optional, whether only active configuration shall be
03e52840d   Kload   Init
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
  	 * 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';
a293d369c   Kload   Update sources to...
50
  		$sql = '
03e52840d   Kload   Init
51
52
53
54
55
  			SELECT DISTINCT `configkey`
  			FROM `*PREFIX*appconfig`
  			WHERE `appid` = \'user_ldap\'
  				AND `configkey` LIKE ?
  		';
a293d369c   Kload   Update sources to...
56

03e52840d   Kload   Init
57
  		if($activeConfigurations) {
a293d369c   Kload   Update sources to...
58
59
60
61
62
63
  			if (\OC_Config::getValue( 'dbtype', 'sqlite' ) === 'oci') {
  				//FIXME oracle hack: need to explicitly cast CLOB to CHAR for comparison
  				$sql .= ' AND to_char(`configvalue`)=\'1\'';
  			} else {
  				$sql .= ' AND `configvalue` = \'1\'';
  			}
03e52840d   Kload   Init
64
  		}
03e52840d   Kload   Init
65

a293d369c   Kload   Update sources to...
66
67
68
  		$stmt = \OCP\DB::prepare($sql);
  
  		$serverConfigs = $stmt->execute(array('%'.$referenceConfigkey))->fetchAll();
03e52840d   Kload   Init
69
70
71
72
73
74
75
76
77
78
79
  		$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...
80
  	 *
6d9380f96   Cédric Dupont   Update sources OC...
81
82
  	 * determines the host for every configured connection
  	 * @return array an array with configprefix as keys
31b7f2792   Kload   Upgrade to ownclo...
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
  	 *
  	 */
  	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;
  	}
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
108
109
  	 * deletes a given saved LDAP/AD server configuration.
  	 * @param string $prefix the configuration prefix of the config to delete
03e52840d   Kload   Init
110
111
112
113
114
115
116
117
118
  	 * @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;
  		}
a293d369c   Kload   Update sources to...
119
120
  		$saveOtherConfigurations = '';
  		if(empty($prefix)) {
837968727   Kload   [enh] Upgrade to ...
121
  			$saveOtherConfigurations = 'AND `configkey` NOT LIKE \'s%\'';
a293d369c   Kload   Update sources to...
122
  		}
03e52840d   Kload   Init
123
124
125
126
  		$query = \OCP\DB::prepare('
  			DELETE
  			FROM `*PREFIX*appconfig`
  			WHERE `configkey` LIKE ?
a293d369c   Kload   Update sources to...
127
  				'.$saveOtherConfigurations.'
03e52840d   Kload   Init
128
129
130
131
132
133
134
135
  				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...
136
  		if($delRows === 0) {
03e52840d   Kload   Init
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'
6d9380f96   Cédric Dupont   Update sources OC...
147
  	 * @return bool true on success, false otherwise
03e52840d   Kload   Init
148
149
150
151
152
153
154
155
156
  	 */
  	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;
  		}
6d9380f96   Cédric Dupont   Update sources OC...
157
158
  		$dbtype = \OCP\Config::getSystemValue('dbtype');
  		if(strpos($dbtype, 'sqlite') !== false || $dbtype === 'oci') {
03e52840d   Kload   Init
159
160
161
162
163
164
165
166
167
168
169
170
171
172
  			$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...
173
174
  
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
175
176
177
  	 * extractsthe domain from a given URL
  	 * @param string $url the URL
  	 * @return string|false domain as string on success, false otherwise
31b7f2792   Kload   Upgrade to ownclo...
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
  	 */
  	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
194
  }