Completed
Pull Request — master (#3590)
by Individual IT
11:38
created
apps/user_ldap/lib/Settings/Section.php 1 patch
Indentation   +46 added lines, -46 removed lines patch added patch discarded remove patch
@@ -28,55 +28,55 @@
 block discarded – undo
28 28
 use OCP\Settings\IIconSection;
29 29
 
30 30
 class Section implements IIconSection {
31
-	/** @var IL10N */
32
-	private $l;
33
-	/** @var IURLGenerator */
34
-	private $url;
31
+    /** @var IL10N */
32
+    private $l;
33
+    /** @var IURLGenerator */
34
+    private $url;
35 35
 
36
-	/**
37
-	 * @param IURLGenerator $url
38
-	 * @param IL10N $l
39
-	 */
40
-	public function __construct(IURLGenerator $url, IL10N $l) {
41
-		$this->url = $url;
42
-		$this->l = $l;
43
-	}
36
+    /**
37
+     * @param IURLGenerator $url
38
+     * @param IL10N $l
39
+     */
40
+    public function __construct(IURLGenerator $url, IL10N $l) {
41
+        $this->url = $url;
42
+        $this->l = $l;
43
+    }
44 44
 
45
-	/**
46
-	 * returns the ID of the section. It is supposed to be a lower case string,
47
-	 * e.g. 'ldap'
48
-	 *
49
-	 * @returns string
50
-	 */
51
-	public function getID() {
52
-		return 'ldap';
53
-	}
45
+    /**
46
+     * returns the ID of the section. It is supposed to be a lower case string,
47
+     * e.g. 'ldap'
48
+     *
49
+     * @returns string
50
+     */
51
+    public function getID() {
52
+        return 'ldap';
53
+    }
54 54
 
55
-	/**
56
-	 * returns the translated name as it should be displayed, e.g. 'LDAP / AD
57
-	 * integration'. Use the L10N service to translate it.
58
-	 *
59
-	 * @return string
60
-	 */
61
-	public function getName() {
62
-		return $this->l->t('LDAP / AD integration');
63
-	}
55
+    /**
56
+     * returns the translated name as it should be displayed, e.g. 'LDAP / AD
57
+     * integration'. Use the L10N service to translate it.
58
+     *
59
+     * @return string
60
+     */
61
+    public function getName() {
62
+        return $this->l->t('LDAP / AD integration');
63
+    }
64 64
 
65
-	/**
66
-	 * @return int whether the form should be rather on the top or bottom of
67
-	 * the settings navigation. The sections are arranged in ascending order of
68
-	 * the priority values. It is required to return a value between 0 and 99.
69
-	 *
70
-	 * E.g.: 70
71
-	 */
72
-	public function getPriority() {
73
-		return 25;
74
-	}
65
+    /**
66
+     * @return int whether the form should be rather on the top or bottom of
67
+     * the settings navigation. The sections are arranged in ascending order of
68
+     * the priority values. It is required to return a value between 0 and 99.
69
+     *
70
+     * E.g.: 70
71
+     */
72
+    public function getPriority() {
73
+        return 25;
74
+    }
75 75
 
76
-	/**
77
-	 * {@inheritdoc}
78
-	 */
79
-	public function getIcon() {
80
-		return $this->url->imagePath('user_ldap', 'app-dark.svg');
81
-	}
76
+    /**
77
+     * {@inheritdoc}
78
+     */
79
+    public function getIcon() {
80
+        return $this->url->imagePath('user_ldap', 'app-dark.svg');
81
+    }
82 82
 }
Please login to merge, or discard this patch.
apps/user_ldap/lib/Settings/Admin.php 1 patch
Indentation   +47 added lines, -47 removed lines patch added patch discarded remove patch
@@ -31,59 +31,59 @@
 block discarded – undo
31 31
 use OCP\Template;
32 32
 
33 33
 class Admin implements ISettings {
34
-	/** @var IL10N */
35
-	private $l;
34
+    /** @var IL10N */
35
+    private $l;
36 36
 
37
-	/**
38
-	 * @param IL10N $l
39
-	 */
40
-	public function __construct(IL10N $l) {
41
-		$this->l = $l;
42
-	}
37
+    /**
38
+     * @param IL10N $l
39
+     */
40
+    public function __construct(IL10N $l) {
41
+        $this->l = $l;
42
+    }
43 43
 
44
-	/**
45
-	 * @return TemplateResponse
46
-	 */
47
-	public function getForm() {
48
-		$helper = new Helper(\OC::$server->getConfig());
49
-		$prefixes = $helper->getServerConfigurationPrefixes();
50
-		$hosts = $helper->getServerConfigurationHosts();
44
+    /**
45
+     * @return TemplateResponse
46
+     */
47
+    public function getForm() {
48
+        $helper = new Helper(\OC::$server->getConfig());
49
+        $prefixes = $helper->getServerConfigurationPrefixes();
50
+        $hosts = $helper->getServerConfigurationHosts();
51 51
 
52
-		$wControls = new Template('user_ldap', 'part.wizardcontrols');
53
-		$wControls = $wControls->fetchPage();
54
-		$sControls = new Template('user_ldap', 'part.settingcontrols');
55
-		$sControls = $sControls->fetchPage();
52
+        $wControls = new Template('user_ldap', 'part.wizardcontrols');
53
+        $wControls = $wControls->fetchPage();
54
+        $sControls = new Template('user_ldap', 'part.settingcontrols');
55
+        $sControls = $sControls->fetchPage();
56 56
 
57
-		$parameters['serverConfigurationPrefixes'] = $prefixes;
58
-		$parameters['serverConfigurationHosts'] = $hosts;
59
-		$parameters['settingControls'] = $sControls;
60
-		$parameters['wizardControls'] = $wControls;
57
+        $parameters['serverConfigurationPrefixes'] = $prefixes;
58
+        $parameters['serverConfigurationHosts'] = $hosts;
59
+        $parameters['settingControls'] = $sControls;
60
+        $parameters['wizardControls'] = $wControls;
61 61
 
62
-		// assign default values
63
-		$config = new Configuration('', false);
64
-		$defaults = $config->getDefaults();
65
-		foreach($defaults as $key => $default) {
66
-			$parameters[$key.'_default'] = $default;
67
-		}
62
+        // assign default values
63
+        $config = new Configuration('', false);
64
+        $defaults = $config->getDefaults();
65
+        foreach($defaults as $key => $default) {
66
+            $parameters[$key.'_default'] = $default;
67
+        }
68 68
 
69
-		return new TemplateResponse('user_ldap', 'settings', $parameters);
70
-	}
69
+        return new TemplateResponse('user_ldap', 'settings', $parameters);
70
+    }
71 71
 
72
-	/**
73
-	 * @return string the section ID, e.g. 'sharing'
74
-	 */
75
-	public function getSection() {
76
-		return 'ldap';
77
-	}
72
+    /**
73
+     * @return string the section ID, e.g. 'sharing'
74
+     */
75
+    public function getSection() {
76
+        return 'ldap';
77
+    }
78 78
 
79
-	/**
80
-	 * @return int whether the form should be rather on the top or bottom of
81
-	 * the admin section. The forms are arranged in ascending order of the
82
-	 * priority values. It is required to return a value between 0 and 100.
83
-	 *
84
-	 * E.g.: 70
85
-	 */
86
-	public function getPriority() {
87
-		return 5;
88
-	}
79
+    /**
80
+     * @return int whether the form should be rather on the top or bottom of
81
+     * the admin section. The forms are arranged in ascending order of the
82
+     * priority values. It is required to return a value between 0 and 100.
83
+     *
84
+     * E.g.: 70
85
+     */
86
+    public function getPriority() {
87
+        return 5;
88
+    }
89 89
 }
Please login to merge, or discard this patch.
apps/user_ldap/lib/User_Proxy.php 1 patch
Indentation   +260 added lines, -260 removed lines patch added patch discarded remove patch
@@ -33,285 +33,285 @@
 block discarded – undo
33 33
 use OCP\IConfig;
34 34
 
35 35
 class User_Proxy extends Proxy implements \OCP\IUserBackend, \OCP\UserInterface, IUserLDAP {
36
-	private $backends = array();
37
-	private $refBackend = null;
36
+    private $backends = array();
37
+    private $refBackend = null;
38 38
 
39
-	/**
40
-	 * Constructor
41
-	 * @param array $serverConfigPrefixes array containing the config Prefixes
42
-	 */
43
-	public function __construct(array $serverConfigPrefixes, ILDAPWrapper $ldap, IConfig $ocConfig) {
44
-		parent::__construct($ldap);
45
-		foreach($serverConfigPrefixes as $configPrefix) {
46
-			$this->backends[$configPrefix] =
47
-				new User_LDAP($this->getAccess($configPrefix), $ocConfig);
48
-			if(is_null($this->refBackend)) {
49
-				$this->refBackend = &$this->backends[$configPrefix];
50
-			}
51
-		}
52
-	}
39
+    /**
40
+     * Constructor
41
+     * @param array $serverConfigPrefixes array containing the config Prefixes
42
+     */
43
+    public function __construct(array $serverConfigPrefixes, ILDAPWrapper $ldap, IConfig $ocConfig) {
44
+        parent::__construct($ldap);
45
+        foreach($serverConfigPrefixes as $configPrefix) {
46
+            $this->backends[$configPrefix] =
47
+                new User_LDAP($this->getAccess($configPrefix), $ocConfig);
48
+            if(is_null($this->refBackend)) {
49
+                $this->refBackend = &$this->backends[$configPrefix];
50
+            }
51
+        }
52
+    }
53 53
 
54
-	/**
55
-	 * Tries the backends one after the other until a positive result is returned from the specified method
56
-	 * @param string $uid the uid connected to the request
57
-	 * @param string $method the method of the user backend that shall be called
58
-	 * @param array $parameters an array of parameters to be passed
59
-	 * @return mixed the result of the method or false
60
-	 */
61
-	protected function walkBackends($uid, $method, $parameters) {
62
-		$cacheKey = $this->getUserCacheKey($uid);
63
-		foreach($this->backends as $configPrefix => $backend) {
64
-			$instance = $backend;
65
-			if(!method_exists($instance, $method)
66
-				&& method_exists($this->getAccess($configPrefix), $method)) {
67
-				$instance = $this->getAccess($configPrefix);
68
-			}
69
-			if($result = call_user_func_array(array($instance, $method), $parameters)) {
70
-				$this->writeToCache($cacheKey, $configPrefix);
71
-				return $result;
72
-			}
73
-		}
74
-		return false;
75
-	}
54
+    /**
55
+     * Tries the backends one after the other until a positive result is returned from the specified method
56
+     * @param string $uid the uid connected to the request
57
+     * @param string $method the method of the user backend that shall be called
58
+     * @param array $parameters an array of parameters to be passed
59
+     * @return mixed the result of the method or false
60
+     */
61
+    protected function walkBackends($uid, $method, $parameters) {
62
+        $cacheKey = $this->getUserCacheKey($uid);
63
+        foreach($this->backends as $configPrefix => $backend) {
64
+            $instance = $backend;
65
+            if(!method_exists($instance, $method)
66
+                && method_exists($this->getAccess($configPrefix), $method)) {
67
+                $instance = $this->getAccess($configPrefix);
68
+            }
69
+            if($result = call_user_func_array(array($instance, $method), $parameters)) {
70
+                $this->writeToCache($cacheKey, $configPrefix);
71
+                return $result;
72
+            }
73
+        }
74
+        return false;
75
+    }
76 76
 
77
-	/**
78
-	 * Asks the backend connected to the server that supposely takes care of the uid from the request.
79
-	 * @param string $uid the uid connected to the request
80
-	 * @param string $method the method of the user backend that shall be called
81
-	 * @param array $parameters an array of parameters to be passed
82
-	 * @param mixed $passOnWhen the result matches this variable
83
-	 * @return mixed the result of the method or false
84
-	 */
85
-	protected function callOnLastSeenOn($uid, $method, $parameters, $passOnWhen) {
86
-		$cacheKey = $this->getUserCacheKey($uid);
87
-		$prefix = $this->getFromCache($cacheKey);
88
-		//in case the uid has been found in the past, try this stored connection first
89
-		if(!is_null($prefix)) {
90
-			if(isset($this->backends[$prefix])) {
91
-				$instance = $this->backends[$prefix];
92
-				if(!method_exists($instance, $method)
93
-					&& method_exists($this->getAccess($prefix), $method)) {
94
-					$instance = $this->getAccess($prefix);
95
-				}
96
-				$result = call_user_func_array(array($instance, $method), $parameters);
97
-				if($result === $passOnWhen) {
98
-					//not found here, reset cache to null if user vanished
99
-					//because sometimes methods return false with a reason
100
-					$userExists = call_user_func_array(
101
-						array($this->backends[$prefix], 'userExists'),
102
-						array($uid)
103
-					);
104
-					if(!$userExists) {
105
-						$this->writeToCache($cacheKey, null);
106
-					}
107
-				}
108
-				return $result;
109
-			}
110
-		}
111
-		return false;
112
-	}
77
+    /**
78
+     * Asks the backend connected to the server that supposely takes care of the uid from the request.
79
+     * @param string $uid the uid connected to the request
80
+     * @param string $method the method of the user backend that shall be called
81
+     * @param array $parameters an array of parameters to be passed
82
+     * @param mixed $passOnWhen the result matches this variable
83
+     * @return mixed the result of the method or false
84
+     */
85
+    protected function callOnLastSeenOn($uid, $method, $parameters, $passOnWhen) {
86
+        $cacheKey = $this->getUserCacheKey($uid);
87
+        $prefix = $this->getFromCache($cacheKey);
88
+        //in case the uid has been found in the past, try this stored connection first
89
+        if(!is_null($prefix)) {
90
+            if(isset($this->backends[$prefix])) {
91
+                $instance = $this->backends[$prefix];
92
+                if(!method_exists($instance, $method)
93
+                    && method_exists($this->getAccess($prefix), $method)) {
94
+                    $instance = $this->getAccess($prefix);
95
+                }
96
+                $result = call_user_func_array(array($instance, $method), $parameters);
97
+                if($result === $passOnWhen) {
98
+                    //not found here, reset cache to null if user vanished
99
+                    //because sometimes methods return false with a reason
100
+                    $userExists = call_user_func_array(
101
+                        array($this->backends[$prefix], 'userExists'),
102
+                        array($uid)
103
+                    );
104
+                    if(!$userExists) {
105
+                        $this->writeToCache($cacheKey, null);
106
+                    }
107
+                }
108
+                return $result;
109
+            }
110
+        }
111
+        return false;
112
+    }
113 113
 
114
-	/**
115
-	 * Check if backend implements actions
116
-	 * @param int $actions bitwise-or'ed actions
117
-	 * @return boolean
118
-	 *
119
-	 * Returns the supported actions as int to be
120
-	 * compared with OC_USER_BACKEND_CREATE_USER etc.
121
-	 */
122
-	public function implementsActions($actions) {
123
-		//it's the same across all our user backends obviously
124
-		return $this->refBackend->implementsActions($actions);
125
-	}
114
+    /**
115
+     * Check if backend implements actions
116
+     * @param int $actions bitwise-or'ed actions
117
+     * @return boolean
118
+     *
119
+     * Returns the supported actions as int to be
120
+     * compared with OC_USER_BACKEND_CREATE_USER etc.
121
+     */
122
+    public function implementsActions($actions) {
123
+        //it's the same across all our user backends obviously
124
+        return $this->refBackend->implementsActions($actions);
125
+    }
126 126
 
127
-	/**
128
-	 * Backend name to be shown in user management
129
-	 * @return string the name of the backend to be shown
130
-	 */
131
-	public function getBackendName() {
132
-		return $this->refBackend->getBackendName();
133
-	}
127
+    /**
128
+     * Backend name to be shown in user management
129
+     * @return string the name of the backend to be shown
130
+     */
131
+    public function getBackendName() {
132
+        return $this->refBackend->getBackendName();
133
+    }
134 134
 
135
-	/**
136
-	 * Get a list of all users
137
-	 *
138
-	 * @param string $search
139
-	 * @param null|int $limit
140
-	 * @param null|int $offset
141
-	 * @return string[] an array of all uids
142
-	 */
143
-	public function getUsers($search = '', $limit = 10, $offset = 0) {
144
-		//we do it just as the /OC_User implementation: do not play around with limit and offset but ask all backends
145
-		$users = array();
146
-		foreach($this->backends as $backend) {
147
-			$backendUsers = $backend->getUsers($search, $limit, $offset);
148
-			if (is_array($backendUsers)) {
149
-				$users = array_merge($users, $backendUsers);
150
-			}
151
-		}
152
-		return $users;
153
-	}
135
+    /**
136
+     * Get a list of all users
137
+     *
138
+     * @param string $search
139
+     * @param null|int $limit
140
+     * @param null|int $offset
141
+     * @return string[] an array of all uids
142
+     */
143
+    public function getUsers($search = '', $limit = 10, $offset = 0) {
144
+        //we do it just as the /OC_User implementation: do not play around with limit and offset but ask all backends
145
+        $users = array();
146
+        foreach($this->backends as $backend) {
147
+            $backendUsers = $backend->getUsers($search, $limit, $offset);
148
+            if (is_array($backendUsers)) {
149
+                $users = array_merge($users, $backendUsers);
150
+            }
151
+        }
152
+        return $users;
153
+    }
154 154
 
155
-	/**
156
-	 * check if a user exists
157
-	 * @param string $uid the username
158
-	 * @return boolean
159
-	 */
160
-	public function userExists($uid) {
161
-		return $this->handleRequest($uid, 'userExists', array($uid));
162
-	}
155
+    /**
156
+     * check if a user exists
157
+     * @param string $uid the username
158
+     * @return boolean
159
+     */
160
+    public function userExists($uid) {
161
+        return $this->handleRequest($uid, 'userExists', array($uid));
162
+    }
163 163
 
164
-	/**
165
-	 * check if a user exists on LDAP
166
-	 * @param string|\OCA\User_LDAP\User\User $user either the ownCloud user
167
-	 * name or an instance of that user
168
-	 * @return boolean
169
-	 */
170
-	public function userExistsOnLDAP($user) {
171
-		$id = ($user instanceof User) ? $user->getUsername() : $user;
172
-		return $this->handleRequest($id, 'userExistsOnLDAP', array($user));
173
-	}
164
+    /**
165
+     * check if a user exists on LDAP
166
+     * @param string|\OCA\User_LDAP\User\User $user either the ownCloud user
167
+     * name or an instance of that user
168
+     * @return boolean
169
+     */
170
+    public function userExistsOnLDAP($user) {
171
+        $id = ($user instanceof User) ? $user->getUsername() : $user;
172
+        return $this->handleRequest($id, 'userExistsOnLDAP', array($user));
173
+    }
174 174
 
175
-	/**
176
-	 * Check if the password is correct
177
-	 * @param string $uid The username
178
-	 * @param string $password The password
179
-	 * @return bool
180
-	 *
181
-	 * Check if the password is correct without logging in the user
182
-	 */
183
-	public function checkPassword($uid, $password) {
184
-		return $this->handleRequest($uid, 'checkPassword', array($uid, $password));
185
-	}
175
+    /**
176
+     * Check if the password is correct
177
+     * @param string $uid The username
178
+     * @param string $password The password
179
+     * @return bool
180
+     *
181
+     * Check if the password is correct without logging in the user
182
+     */
183
+    public function checkPassword($uid, $password) {
184
+        return $this->handleRequest($uid, 'checkPassword', array($uid, $password));
185
+    }
186 186
 
187
-	/**
188
-	 * returns the username for the given login name, if available
189
-	 *
190
-	 * @param string $loginName
191
-	 * @return string|false
192
-	 */
193
-	public function loginName2UserName($loginName) {
194
-		$id = 'LOGINNAME,' . $loginName;
195
-		return $this->handleRequest($id, 'loginName2UserName', array($loginName));
196
-	}
187
+    /**
188
+     * returns the username for the given login name, if available
189
+     *
190
+     * @param string $loginName
191
+     * @return string|false
192
+     */
193
+    public function loginName2UserName($loginName) {
194
+        $id = 'LOGINNAME,' . $loginName;
195
+        return $this->handleRequest($id, 'loginName2UserName', array($loginName));
196
+    }
197 197
 	
198
-	/**
199
-	 * returns the username for the given LDAP DN, if available
200
-	 *
201
-	 * @param string $dn
202
-	 * @return string|false with the username
203
-	 */
204
-	public function dn2UserName($dn) {
205
-		$id = 'DN,' . $dn;
206
-		return $this->handleRequest($id, 'dn2UserName', array($dn));
207
-	}
198
+    /**
199
+     * returns the username for the given LDAP DN, if available
200
+     *
201
+     * @param string $dn
202
+     * @return string|false with the username
203
+     */
204
+    public function dn2UserName($dn) {
205
+        $id = 'DN,' . $dn;
206
+        return $this->handleRequest($id, 'dn2UserName', array($dn));
207
+    }
208 208
 
209
-	/**
210
-	 * get the user's home directory
211
-	 * @param string $uid the username
212
-	 * @return boolean
213
-	 */
214
-	public function getHome($uid) {
215
-		return $this->handleRequest($uid, 'getHome', array($uid));
216
-	}
209
+    /**
210
+     * get the user's home directory
211
+     * @param string $uid the username
212
+     * @return boolean
213
+     */
214
+    public function getHome($uid) {
215
+        return $this->handleRequest($uid, 'getHome', array($uid));
216
+    }
217 217
 
218
-	/**
219
-	 * get display name of the user
220
-	 * @param string $uid user ID of the user
221
-	 * @return string display name
222
-	 */
223
-	public function getDisplayName($uid) {
224
-		return $this->handleRequest($uid, 'getDisplayName', array($uid));
225
-	}
218
+    /**
219
+     * get display name of the user
220
+     * @param string $uid user ID of the user
221
+     * @return string display name
222
+     */
223
+    public function getDisplayName($uid) {
224
+        return $this->handleRequest($uid, 'getDisplayName', array($uid));
225
+    }
226 226
 
227
-	/**
228
-	 * checks whether the user is allowed to change his avatar in ownCloud
229
-	 * @param string $uid the ownCloud user name
230
-	 * @return boolean either the user can or cannot
231
-	 */
232
-	public function canChangeAvatar($uid) {
233
-		return $this->handleRequest($uid, 'canChangeAvatar', array($uid), true);
234
-	}
227
+    /**
228
+     * checks whether the user is allowed to change his avatar in ownCloud
229
+     * @param string $uid the ownCloud user name
230
+     * @return boolean either the user can or cannot
231
+     */
232
+    public function canChangeAvatar($uid) {
233
+        return $this->handleRequest($uid, 'canChangeAvatar', array($uid), true);
234
+    }
235 235
 
236
-	/**
237
-	 * Get a list of all display names and user ids.
238
-	 * @param string $search
239
-	 * @param string|null $limit
240
-	 * @param string|null $offset
241
-	 * @return array an array of all displayNames (value) and the corresponding uids (key)
242
-	 */
243
-	public function getDisplayNames($search = '', $limit = null, $offset = null) {
244
-		//we do it just as the /OC_User implementation: do not play around with limit and offset but ask all backends
245
-		$users = array();
246
-		foreach($this->backends as $backend) {
247
-			$backendUsers = $backend->getDisplayNames($search, $limit, $offset);
248
-			if (is_array($backendUsers)) {
249
-				$users = $users + $backendUsers;
250
-			}
251
-		}
252
-		return $users;
253
-	}
236
+    /**
237
+     * Get a list of all display names and user ids.
238
+     * @param string $search
239
+     * @param string|null $limit
240
+     * @param string|null $offset
241
+     * @return array an array of all displayNames (value) and the corresponding uids (key)
242
+     */
243
+    public function getDisplayNames($search = '', $limit = null, $offset = null) {
244
+        //we do it just as the /OC_User implementation: do not play around with limit and offset but ask all backends
245
+        $users = array();
246
+        foreach($this->backends as $backend) {
247
+            $backendUsers = $backend->getDisplayNames($search, $limit, $offset);
248
+            if (is_array($backendUsers)) {
249
+                $users = $users + $backendUsers;
250
+            }
251
+        }
252
+        return $users;
253
+    }
254 254
 
255
-	/**
256
-	 * delete a user
257
-	 * @param string $uid The username of the user to delete
258
-	 * @return bool
259
-	 *
260
-	 * Deletes a user
261
-	 */
262
-	public function deleteUser($uid) {
263
-		return $this->handleRequest($uid, 'deleteUser', array($uid));
264
-	}
255
+    /**
256
+     * delete a user
257
+     * @param string $uid The username of the user to delete
258
+     * @return bool
259
+     *
260
+     * Deletes a user
261
+     */
262
+    public function deleteUser($uid) {
263
+        return $this->handleRequest($uid, 'deleteUser', array($uid));
264
+    }
265 265
 	
266
-	/**
267
-	 * Set password
268
-	 * @param string $uid The username
269
-	 * @param string $password The new password
270
-	 * @return bool
271
-	 *
272
-	 */
273
-	public function setPassword($uid, $password) {
274
-		return $this->handleRequest($uid, 'setPassword', array($uid, $password));
275
-	}
266
+    /**
267
+     * Set password
268
+     * @param string $uid The username
269
+     * @param string $password The new password
270
+     * @return bool
271
+     *
272
+     */
273
+    public function setPassword($uid, $password) {
274
+        return $this->handleRequest($uid, 'setPassword', array($uid, $password));
275
+    }
276 276
 
277
-	/**
278
-	 * @return bool
279
-	 */
280
-	public function hasUserListings() {
281
-		return $this->refBackend->hasUserListings();
282
-	}
277
+    /**
278
+     * @return bool
279
+     */
280
+    public function hasUserListings() {
281
+        return $this->refBackend->hasUserListings();
282
+    }
283 283
 
284
-	/**
285
-	 * Count the number of users
286
-	 * @return int|bool
287
-	 */
288
-	public function countUsers() {
289
-		$users = false;
290
-		foreach($this->backends as $backend) {
291
-			$backendUsers = $backend->countUsers();
292
-			if ($backendUsers !== false) {
293
-				$users += $backendUsers;
294
-			}
295
-		}
296
-		return $users;
297
-	}
284
+    /**
285
+     * Count the number of users
286
+     * @return int|bool
287
+     */
288
+    public function countUsers() {
289
+        $users = false;
290
+        foreach($this->backends as $backend) {
291
+            $backendUsers = $backend->countUsers();
292
+            if ($backendUsers !== false) {
293
+                $users += $backendUsers;
294
+            }
295
+        }
296
+        return $users;
297
+    }
298 298
 
299
-	/**
300
-	 * Return access for LDAP interaction.
301
-	 * @param string $uid
302
-	 * @return Access instance of Access for LDAP interaction
303
-	 */
304
-	public function getLDAPAccess($uid) {
305
-		return $this->handleRequest($uid, 'getLDAPAccess', array($uid));
306
-	}
299
+    /**
300
+     * Return access for LDAP interaction.
301
+     * @param string $uid
302
+     * @return Access instance of Access for LDAP interaction
303
+     */
304
+    public function getLDAPAccess($uid) {
305
+        return $this->handleRequest($uid, 'getLDAPAccess', array($uid));
306
+    }
307 307
 	
308
-	/**
309
-	 * Return a new LDAP connection for the specified user.
310
-	 * The connection needs to be closed manually.
311
-	 * @param string $uid
312
-	 * @return resource of the LDAP connection
313
-	 */
314
-	public function getNewLDAPConnection($uid) {
315
-		return $this->handleRequest($uid, 'getNewLDAPConnection', array($uid));
316
-	}
308
+    /**
309
+     * Return a new LDAP connection for the specified user.
310
+     * The connection needs to be closed manually.
311
+     * @param string $uid
312
+     * @return resource of the LDAP connection
313
+     */
314
+    public function getNewLDAPConnection($uid) {
315
+        return $this->handleRequest($uid, 'getNewLDAPConnection', array($uid));
316
+    }
317 317
 }
Please login to merge, or discard this patch.
apps/user_ldap/lib/Connection.php 1 patch
Indentation   +564 added lines, -564 removed lines patch added patch discarded remove patch
@@ -51,569 +51,569 @@
 block discarded – undo
51 51
  * @property string ldapUuidGroupAttribute
52 52
  */
53 53
 class Connection extends LDAPUtility {
54
-	private $ldapConnectionRes = null;
55
-	private $configPrefix;
56
-	private $configID;
57
-	private $configured = false;
58
-	private $hasPagedResultSupport = true;
59
-	//whether connection should be kept on __destruct
60
-	private $dontDestruct = false;
61
-
62
-	/**
63
-	 * @var bool runtime flag that indicates whether supported primary groups are available
64
-	 */
65
-	public $hasPrimaryGroups = true;
66
-
67
-	//cache handler
68
-	protected $cache;
69
-
70
-	/** @var Configuration settings handler **/
71
-	protected $configuration;
72
-
73
-	protected $doNotValidate = false;
74
-
75
-	protected $ignoreValidation = false;
76
-
77
-	/**
78
-	 * Constructor
79
-	 * @param ILDAPWrapper $ldap
80
-	 * @param string $configPrefix a string with the prefix for the configkey column (appconfig table)
81
-	 * @param string|null $configID a string with the value for the appid column (appconfig table) or null for on-the-fly connections
82
-	 */
83
-	public function __construct(ILDAPWrapper $ldap, $configPrefix = '', $configID = 'user_ldap') {
84
-		parent::__construct($ldap);
85
-		$this->configPrefix = $configPrefix;
86
-		$this->configID = $configID;
87
-		$this->configuration = new Configuration($configPrefix,
88
-												 !is_null($configID));
89
-		$memcache = \OC::$server->getMemCacheFactory();
90
-		if($memcache->isAvailable()) {
91
-			$this->cache = $memcache->create();
92
-		}
93
-		$helper = new Helper(\OC::$server->getConfig());
94
-		$this->doNotValidate = !in_array($this->configPrefix,
95
-			$helper->getServerConfigurationPrefixes());
96
-		$this->hasPagedResultSupport =
97
-			intval($this->configuration->ldapPagingSize) !== 0
98
-			|| $this->ldap->hasPagedResultSupport();
99
-	}
100
-
101
-	public function __destruct() {
102
-		if(!$this->dontDestruct && $this->ldap->isResource($this->ldapConnectionRes)) {
103
-			@$this->ldap->unbind($this->ldapConnectionRes);
104
-		};
105
-	}
106
-
107
-	/**
108
-	 * defines behaviour when the instance is cloned
109
-	 */
110
-	public function __clone() {
111
-		$this->configuration = new Configuration($this->configPrefix,
112
-												 !is_null($this->configID));
113
-		$this->ldapConnectionRes = null;
114
-		$this->dontDestruct = true;
115
-	}
116
-
117
-	/**
118
-	 * @param string $name
119
-	 * @return bool|mixed|void
120
-	 */
121
-	public function __get($name) {
122
-		if(!$this->configured) {
123
-			$this->readConfiguration();
124
-		}
125
-
126
-		if($name === 'hasPagedResultSupport') {
127
-			return $this->hasPagedResultSupport;
128
-		}
129
-
130
-		return $this->configuration->$name;
131
-	}
132
-
133
-	/**
134
-	 * @param string $name
135
-	 * @param mixed $value
136
-	 */
137
-	public function __set($name, $value) {
138
-		$this->doNotValidate = false;
139
-		$before = $this->configuration->$name;
140
-		$this->configuration->$name = $value;
141
-		$after = $this->configuration->$name;
142
-		if($before !== $after) {
143
-			if ($this->configID !== '') {
144
-				$this->configuration->saveConfiguration();
145
-			}
146
-			$this->validateConfiguration();
147
-		}
148
-	}
149
-
150
-	/**
151
-	 * sets whether the result of the configuration validation shall
152
-	 * be ignored when establishing the connection. Used by the Wizard
153
-	 * in early configuration state.
154
-	 * @param bool $state
155
-	 */
156
-	public function setIgnoreValidation($state) {
157
-		$this->ignoreValidation = (bool)$state;
158
-	}
159
-
160
-	/**
161
-	 * initializes the LDAP backend
162
-	 * @param bool $force read the config settings no matter what
163
-	 */
164
-	public function init($force = false) {
165
-		$this->readConfiguration($force);
166
-		$this->establishConnection();
167
-	}
168
-
169
-	/**
170
-	 * Returns the LDAP handler
171
-	 */
172
-	public function getConnectionResource() {
173
-		if(!$this->ldapConnectionRes) {
174
-			$this->init();
175
-		} else if(!$this->ldap->isResource($this->ldapConnectionRes)) {
176
-			$this->ldapConnectionRes = null;
177
-			$this->establishConnection();
178
-		}
179
-		if(is_null($this->ldapConnectionRes)) {
180
-			\OCP\Util::writeLog('user_ldap', 'No LDAP Connection to server ' . $this->configuration->ldapHost, \OCP\Util::ERROR);
181
-			throw new ServerNotAvailableException('Connection to LDAP server could not be established');
182
-		}
183
-		return $this->ldapConnectionRes;
184
-	}
185
-
186
-	/**
187
-	 * resets the connection resource
188
-	 */
189
-	public function resetConnectionResource() {
190
-		if(!is_null($this->ldapConnectionRes)) {
191
-			@$this->ldap->unbind($this->ldapConnectionRes);
192
-			$this->ldapConnectionRes = null;
193
-		}
194
-	}
195
-
196
-	/**
197
-	 * @param string|null $key
198
-	 * @return string
199
-	 */
200
-	private function getCacheKey($key) {
201
-		$prefix = 'LDAP-'.$this->configID.'-'.$this->configPrefix.'-';
202
-		if(is_null($key)) {
203
-			return $prefix;
204
-		}
205
-		return $prefix.md5($key);
206
-	}
207
-
208
-	/**
209
-	 * @param string $key
210
-	 * @return mixed|null
211
-	 */
212
-	public function getFromCache($key) {
213
-		if(!$this->configured) {
214
-			$this->readConfiguration();
215
-		}
216
-		if(is_null($this->cache) || !$this->configuration->ldapCacheTTL) {
217
-			return null;
218
-		}
219
-		$key = $this->getCacheKey($key);
220
-
221
-		return json_decode(base64_decode($this->cache->get($key)), true);
222
-	}
223
-
224
-	/**
225
-	 * @param string $key
226
-	 * @param mixed $value
227
-	 *
228
-	 * @return string
229
-	 */
230
-	public function writeToCache($key, $value) {
231
-		if(!$this->configured) {
232
-			$this->readConfiguration();
233
-		}
234
-		if(is_null($this->cache)
235
-			|| !$this->configuration->ldapCacheTTL
236
-			|| !$this->configuration->ldapConfigurationActive) {
237
-			return null;
238
-		}
239
-		$key   = $this->getCacheKey($key);
240
-		$value = base64_encode(json_encode($value));
241
-		$this->cache->set($key, $value, $this->configuration->ldapCacheTTL);
242
-	}
243
-
244
-	public function clearCache() {
245
-		if(!is_null($this->cache)) {
246
-			$this->cache->clear($this->getCacheKey(null));
247
-		}
248
-	}
249
-
250
-	/**
251
-	 * Caches the general LDAP configuration.
252
-	 * @param bool $force optional. true, if the re-read should be forced. defaults
253
-	 * to false.
254
-	 * @return null
255
-	 */
256
-	private function readConfiguration($force = false) {
257
-		if((!$this->configured || $force) && !is_null($this->configID)) {
258
-			$this->configuration->readConfiguration();
259
-			$this->configured = $this->validateConfiguration();
260
-		}
261
-	}
262
-
263
-	/**
264
-	 * set LDAP configuration with values delivered by an array, not read from configuration
265
-	 * @param array $config array that holds the config parameters in an associated array
266
-	 * @param array &$setParameters optional; array where the set fields will be given to
267
-	 * @return boolean true if config validates, false otherwise. Check with $setParameters for detailed success on single parameters
268
-	 */
269
-	public function setConfiguration($config, &$setParameters = null) {
270
-		if(is_null($setParameters)) {
271
-			$setParameters = array();
272
-		}
273
-		$this->doNotValidate = false;
274
-		$this->configuration->setConfiguration($config, $setParameters);
275
-		if(count($setParameters) > 0) {
276
-			$this->configured = $this->validateConfiguration();
277
-		}
278
-
279
-
280
-		return $this->configured;
281
-	}
282
-
283
-	/**
284
-	 * saves the current Configuration in the database and empties the
285
-	 * cache
286
-	 * @return null
287
-	 */
288
-	public function saveConfiguration() {
289
-		$this->configuration->saveConfiguration();
290
-		$this->clearCache();
291
-	}
292
-
293
-	/**
294
-	 * get the current LDAP configuration
295
-	 * @return array
296
-	 */
297
-	public function getConfiguration() {
298
-		$this->readConfiguration();
299
-		$config = $this->configuration->getConfiguration();
300
-		$cta = $this->configuration->getConfigTranslationArray();
301
-		$result = array();
302
-		foreach($cta as $dbkey => $configkey) {
303
-			switch($configkey) {
304
-				case 'homeFolderNamingRule':
305
-					if(strpos($config[$configkey], 'attr:') === 0) {
306
-						$result[$dbkey] = substr($config[$configkey], 5);
307
-					} else {
308
-						$result[$dbkey] = '';
309
-					}
310
-					break;
311
-				case 'ldapBase':
312
-				case 'ldapBaseUsers':
313
-				case 'ldapBaseGroups':
314
-				case 'ldapAttributesForUserSearch':
315
-				case 'ldapAttributesForGroupSearch':
316
-					if(is_array($config[$configkey])) {
317
-						$result[$dbkey] = implode("\n", $config[$configkey]);
318
-						break;
319
-					} //else follows default
320
-				default:
321
-					$result[$dbkey] = $config[$configkey];
322
-			}
323
-		}
324
-		return $result;
325
-	}
326
-
327
-	private function doSoftValidation() {
328
-		//if User or Group Base are not set, take over Base DN setting
329
-		foreach(array('ldapBaseUsers', 'ldapBaseGroups') as $keyBase) {
330
-			$val = $this->configuration->$keyBase;
331
-			if(empty($val)) {
332
-				$this->configuration->$keyBase = $this->configuration->ldapBase;
333
-			}
334
-		}
335
-
336
-		foreach(array('ldapExpertUUIDUserAttr'  => 'ldapUuidUserAttribute',
337
-					  'ldapExpertUUIDGroupAttr' => 'ldapUuidGroupAttribute')
338
-				as $expertSetting => $effectiveSetting) {
339
-			$uuidOverride = $this->configuration->$expertSetting;
340
-			if(!empty($uuidOverride)) {
341
-				$this->configuration->$effectiveSetting = $uuidOverride;
342
-			} else {
343
-				$uuidAttributes = array('auto', 'entryuuid', 'nsuniqueid',
344
-										'objectguid', 'guid', 'ipauniqueid');
345
-				if(!in_array($this->configuration->$effectiveSetting,
346
-							$uuidAttributes)
347
-					&& (!is_null($this->configID))) {
348
-					$this->configuration->$effectiveSetting = 'auto';
349
-					$this->configuration->saveConfiguration();
350
-					\OCP\Util::writeLog('user_ldap',
351
-										'Illegal value for the '.
352
-										$effectiveSetting.', '.'reset to '.
353
-										'autodetect.', \OCP\Util::INFO);
354
-				}
355
-
356
-			}
357
-		}
358
-
359
-		$backupPort = intval($this->configuration->ldapBackupPort);
360
-		if ($backupPort <= 0) {
361
-			$this->configuration->backupPort = $this->configuration->ldapPort;
362
-		}
363
-
364
-		//make sure empty search attributes are saved as simple, empty array
365
-		$saKeys = array('ldapAttributesForUserSearch',
366
-						'ldapAttributesForGroupSearch');
367
-		foreach($saKeys as $key) {
368
-			$val = $this->configuration->$key;
369
-			if(is_array($val) && count($val) === 1 && empty($val[0])) {
370
-				$this->configuration->$key = array();
371
-			}
372
-		}
373
-
374
-		if((stripos($this->configuration->ldapHost, 'ldaps://') === 0)
375
-			&& $this->configuration->ldapTLS) {
376
-			$this->configuration->ldapTLS = false;
377
-			\OCP\Util::writeLog('user_ldap',
378
-								'LDAPS (already using secure connection) and '.
379
-								'TLS do not work together. Switched off TLS.',
380
-								\OCP\Util::INFO);
381
-		}
382
-	}
383
-
384
-	/**
385
-	 * @return bool
386
-	 */
387
-	private function doCriticalValidation() {
388
-		$configurationOK = true;
389
-		$errorStr = 'Configuration Error (prefix '.
390
-					strval($this->configPrefix).'): ';
391
-
392
-		//options that shall not be empty
393
-		$options = array('ldapHost', 'ldapPort', 'ldapUserDisplayName',
394
-						 'ldapGroupDisplayName', 'ldapLoginFilter');
395
-		foreach($options as $key) {
396
-			$val = $this->configuration->$key;
397
-			if(empty($val)) {
398
-				switch($key) {
399
-					case 'ldapHost':
400
-						$subj = 'LDAP Host';
401
-						break;
402
-					case 'ldapPort':
403
-						$subj = 'LDAP Port';
404
-						break;
405
-					case 'ldapUserDisplayName':
406
-						$subj = 'LDAP User Display Name';
407
-						break;
408
-					case 'ldapGroupDisplayName':
409
-						$subj = 'LDAP Group Display Name';
410
-						break;
411
-					case 'ldapLoginFilter':
412
-						$subj = 'LDAP Login Filter';
413
-						break;
414
-					default:
415
-						$subj = $key;
416
-						break;
417
-				}
418
-				$configurationOK = false;
419
-				\OCP\Util::writeLog('user_ldap',
420
-									$errorStr.'No '.$subj.' given!',
421
-									\OCP\Util::WARN);
422
-			}
423
-		}
424
-
425
-		//combinations
426
-		$agent = $this->configuration->ldapAgentName;
427
-		$pwd = $this->configuration->ldapAgentPassword;
428
-		if (
429
-			($agent === ''  && $pwd !== '')
430
-			|| ($agent !== '' && $pwd === '')
431
-		) {
432
-			\OCP\Util::writeLog('user_ldap',
433
-								$errorStr.'either no password is given for the'.
434
-								'user agent or a password is given, but not an'.
435
-								'LDAP agent.',
436
-				\OCP\Util::WARN);
437
-			$configurationOK = false;
438
-		}
439
-
440
-		$base = $this->configuration->ldapBase;
441
-		$baseUsers = $this->configuration->ldapBaseUsers;
442
-		$baseGroups = $this->configuration->ldapBaseGroups;
443
-
444
-		if(empty($base) && empty($baseUsers) && empty($baseGroups)) {
445
-			\OCP\Util::writeLog('user_ldap',
446
-								$errorStr.'Not a single Base DN given.',
447
-								\OCP\Util::WARN);
448
-			$configurationOK = false;
449
-		}
450
-
451
-		if(mb_strpos($this->configuration->ldapLoginFilter, '%uid', 0, 'UTF-8')
452
-		   === false) {
453
-			\OCP\Util::writeLog('user_ldap',
454
-								$errorStr.'login filter does not contain %uid '.
455
-								'place holder.',
456
-								\OCP\Util::WARN);
457
-			$configurationOK = false;
458
-		}
459
-
460
-		return $configurationOK;
461
-	}
462
-
463
-	/**
464
-	 * Validates the user specified configuration
465
-	 * @return bool true if configuration seems OK, false otherwise
466
-	 */
467
-	private function validateConfiguration() {
468
-
469
-		if($this->doNotValidate) {
470
-			//don't do a validation if it is a new configuration with pure
471
-			//default values. Will be allowed on changes via __set or
472
-			//setConfiguration
473
-			return false;
474
-		}
475
-
476
-		// first step: "soft" checks: settings that are not really
477
-		// necessary, but advisable. If left empty, give an info message
478
-		$this->doSoftValidation();
479
-
480
-		//second step: critical checks. If left empty or filled wrong, mark as
481
-		//not configured and give a warning.
482
-		return $this->doCriticalValidation();
483
-	}
484
-
485
-
486
-	/**
487
-	 * Connects and Binds to LDAP
488
-	 */
489
-	private function establishConnection() {
490
-		if(!$this->configuration->ldapConfigurationActive) {
491
-			return null;
492
-		}
493
-		static $phpLDAPinstalled = true;
494
-		if(!$phpLDAPinstalled) {
495
-			return false;
496
-		}
497
-		if(!$this->ignoreValidation && !$this->configured) {
498
-			\OCP\Util::writeLog('user_ldap',
499
-								'Configuration is invalid, cannot connect',
500
-								\OCP\Util::WARN);
501
-			return false;
502
-		}
503
-		if(!$this->ldapConnectionRes) {
504
-			if(!$this->ldap->areLDAPFunctionsAvailable()) {
505
-				$phpLDAPinstalled = false;
506
-				\OCP\Util::writeLog('user_ldap',
507
-									'function ldap_connect is not available. Make '.
508
-									'sure that the PHP ldap module is installed.',
509
-									\OCP\Util::ERROR);
510
-
511
-				return false;
512
-			}
513
-			if($this->configuration->turnOffCertCheck) {
514
-				if(putenv('LDAPTLS_REQCERT=never')) {
515
-					\OCP\Util::writeLog('user_ldap',
516
-						'Turned off SSL certificate validation successfully.',
517
-						\OCP\Util::DEBUG);
518
-				} else {
519
-					\OCP\Util::writeLog('user_ldap',
520
-										'Could not turn off SSL certificate validation.',
521
-										\OCP\Util::WARN);
522
-				}
523
-			}
524
-
525
-			$bindStatus = false;
526
-			$error = -1;
527
-			try {
528
-				if (!$this->configuration->ldapOverrideMainServer
529
-					&& !$this->getFromCache('overrideMainServer')
530
-				) {
531
-					$this->doConnect($this->configuration->ldapHost,
532
-						$this->configuration->ldapPort);
533
-					$bindStatus = $this->bind();
534
-					$error = $this->ldap->isResource($this->ldapConnectionRes) ?
535
-						$this->ldap->errno($this->ldapConnectionRes) : -1;
536
-				}
537
-				if($bindStatus === true) {
538
-					return $bindStatus;
539
-				}
540
-			} catch (\OC\ServerNotAvailableException $e) {
541
-				if(trim($this->configuration->ldapBackupHost) === "") {
542
-					throw $e;
543
-				}
544
-			}
545
-
546
-			//if LDAP server is not reachable, try the Backup (Replica!) Server
547
-			if(    $error !== 0
548
-				|| $this->configuration->ldapOverrideMainServer
549
-				|| $this->getFromCache('overrideMainServer'))
550
-			{
551
-				$this->doConnect($this->configuration->ldapBackupHost,
552
-								 $this->configuration->ldapBackupPort);
553
-				$bindStatus = $this->bind();
554
-				if($bindStatus && $error === -1 && !$this->getFromCache('overrideMainServer')) {
555
-					//when bind to backup server succeeded and failed to main server,
556
-					//skip contacting him until next cache refresh
557
-					$this->writeToCache('overrideMainServer', true);
558
-				}
559
-			}
560
-			return $bindStatus;
561
-		}
562
-		return null;
563
-	}
564
-
565
-	/**
566
-	 * @param string $host
567
-	 * @param string $port
568
-	 * @return bool
569
-	 * @throws \OC\ServerNotAvailableException
570
-	 */
571
-	private function doConnect($host, $port) {
572
-		if ($host === '') {
573
-			return false;
574
-		}
575
-		$this->ldapConnectionRes = $this->ldap->connect($host, $port);
576
-		if($this->ldap->setOption($this->ldapConnectionRes, LDAP_OPT_PROTOCOL_VERSION, 3)) {
577
-			if($this->ldap->setOption($this->ldapConnectionRes, LDAP_OPT_REFERRALS, 0)) {
578
-				if($this->configuration->ldapTLS) {
579
-					$this->ldap->startTls($this->ldapConnectionRes);
580
-				}
581
-			}
582
-		} else {
583
-			throw new \OC\ServerNotAvailableException('Could not set required LDAP Protocol version.');
584
-		}
585
-		return true;
586
-	}
587
-
588
-	/**
589
-	 * Binds to LDAP
590
-	 */
591
-	public function bind() {
592
-		static $getConnectionResourceAttempt = false;
593
-		if(!$this->configuration->ldapConfigurationActive) {
594
-			return false;
595
-		}
596
-		if($getConnectionResourceAttempt) {
597
-			$getConnectionResourceAttempt = false;
598
-			return false;
599
-		}
600
-		$getConnectionResourceAttempt = true;
601
-		$cr = $this->getConnectionResource();
602
-		$getConnectionResourceAttempt = false;
603
-		if(!$this->ldap->isResource($cr)) {
604
-			return false;
605
-		}
606
-		$ldapLogin = @$this->ldap->bind($cr,
607
-										$this->configuration->ldapAgentName,
608
-										$this->configuration->ldapAgentPassword);
609
-		if(!$ldapLogin) {
610
-			\OCP\Util::writeLog('user_ldap',
611
-				'Bind failed: ' . $this->ldap->errno($cr) . ': ' . $this->ldap->error($cr),
612
-				\OCP\Util::WARN);
613
-			$this->ldapConnectionRes = null;
614
-			return false;
615
-		}
616
-		return true;
617
-	}
54
+    private $ldapConnectionRes = null;
55
+    private $configPrefix;
56
+    private $configID;
57
+    private $configured = false;
58
+    private $hasPagedResultSupport = true;
59
+    //whether connection should be kept on __destruct
60
+    private $dontDestruct = false;
61
+
62
+    /**
63
+     * @var bool runtime flag that indicates whether supported primary groups are available
64
+     */
65
+    public $hasPrimaryGroups = true;
66
+
67
+    //cache handler
68
+    protected $cache;
69
+
70
+    /** @var Configuration settings handler **/
71
+    protected $configuration;
72
+
73
+    protected $doNotValidate = false;
74
+
75
+    protected $ignoreValidation = false;
76
+
77
+    /**
78
+     * Constructor
79
+     * @param ILDAPWrapper $ldap
80
+     * @param string $configPrefix a string with the prefix for the configkey column (appconfig table)
81
+     * @param string|null $configID a string with the value for the appid column (appconfig table) or null for on-the-fly connections
82
+     */
83
+    public function __construct(ILDAPWrapper $ldap, $configPrefix = '', $configID = 'user_ldap') {
84
+        parent::__construct($ldap);
85
+        $this->configPrefix = $configPrefix;
86
+        $this->configID = $configID;
87
+        $this->configuration = new Configuration($configPrefix,
88
+                                                    !is_null($configID));
89
+        $memcache = \OC::$server->getMemCacheFactory();
90
+        if($memcache->isAvailable()) {
91
+            $this->cache = $memcache->create();
92
+        }
93
+        $helper = new Helper(\OC::$server->getConfig());
94
+        $this->doNotValidate = !in_array($this->configPrefix,
95
+            $helper->getServerConfigurationPrefixes());
96
+        $this->hasPagedResultSupport =
97
+            intval($this->configuration->ldapPagingSize) !== 0
98
+            || $this->ldap->hasPagedResultSupport();
99
+    }
100
+
101
+    public function __destruct() {
102
+        if(!$this->dontDestruct && $this->ldap->isResource($this->ldapConnectionRes)) {
103
+            @$this->ldap->unbind($this->ldapConnectionRes);
104
+        };
105
+    }
106
+
107
+    /**
108
+     * defines behaviour when the instance is cloned
109
+     */
110
+    public function __clone() {
111
+        $this->configuration = new Configuration($this->configPrefix,
112
+                                                    !is_null($this->configID));
113
+        $this->ldapConnectionRes = null;
114
+        $this->dontDestruct = true;
115
+    }
116
+
117
+    /**
118
+     * @param string $name
119
+     * @return bool|mixed|void
120
+     */
121
+    public function __get($name) {
122
+        if(!$this->configured) {
123
+            $this->readConfiguration();
124
+        }
125
+
126
+        if($name === 'hasPagedResultSupport') {
127
+            return $this->hasPagedResultSupport;
128
+        }
129
+
130
+        return $this->configuration->$name;
131
+    }
132
+
133
+    /**
134
+     * @param string $name
135
+     * @param mixed $value
136
+     */
137
+    public function __set($name, $value) {
138
+        $this->doNotValidate = false;
139
+        $before = $this->configuration->$name;
140
+        $this->configuration->$name = $value;
141
+        $after = $this->configuration->$name;
142
+        if($before !== $after) {
143
+            if ($this->configID !== '') {
144
+                $this->configuration->saveConfiguration();
145
+            }
146
+            $this->validateConfiguration();
147
+        }
148
+    }
149
+
150
+    /**
151
+     * sets whether the result of the configuration validation shall
152
+     * be ignored when establishing the connection. Used by the Wizard
153
+     * in early configuration state.
154
+     * @param bool $state
155
+     */
156
+    public function setIgnoreValidation($state) {
157
+        $this->ignoreValidation = (bool)$state;
158
+    }
159
+
160
+    /**
161
+     * initializes the LDAP backend
162
+     * @param bool $force read the config settings no matter what
163
+     */
164
+    public function init($force = false) {
165
+        $this->readConfiguration($force);
166
+        $this->establishConnection();
167
+    }
168
+
169
+    /**
170
+     * Returns the LDAP handler
171
+     */
172
+    public function getConnectionResource() {
173
+        if(!$this->ldapConnectionRes) {
174
+            $this->init();
175
+        } else if(!$this->ldap->isResource($this->ldapConnectionRes)) {
176
+            $this->ldapConnectionRes = null;
177
+            $this->establishConnection();
178
+        }
179
+        if(is_null($this->ldapConnectionRes)) {
180
+            \OCP\Util::writeLog('user_ldap', 'No LDAP Connection to server ' . $this->configuration->ldapHost, \OCP\Util::ERROR);
181
+            throw new ServerNotAvailableException('Connection to LDAP server could not be established');
182
+        }
183
+        return $this->ldapConnectionRes;
184
+    }
185
+
186
+    /**
187
+     * resets the connection resource
188
+     */
189
+    public function resetConnectionResource() {
190
+        if(!is_null($this->ldapConnectionRes)) {
191
+            @$this->ldap->unbind($this->ldapConnectionRes);
192
+            $this->ldapConnectionRes = null;
193
+        }
194
+    }
195
+
196
+    /**
197
+     * @param string|null $key
198
+     * @return string
199
+     */
200
+    private function getCacheKey($key) {
201
+        $prefix = 'LDAP-'.$this->configID.'-'.$this->configPrefix.'-';
202
+        if(is_null($key)) {
203
+            return $prefix;
204
+        }
205
+        return $prefix.md5($key);
206
+    }
207
+
208
+    /**
209
+     * @param string $key
210
+     * @return mixed|null
211
+     */
212
+    public function getFromCache($key) {
213
+        if(!$this->configured) {
214
+            $this->readConfiguration();
215
+        }
216
+        if(is_null($this->cache) || !$this->configuration->ldapCacheTTL) {
217
+            return null;
218
+        }
219
+        $key = $this->getCacheKey($key);
220
+
221
+        return json_decode(base64_decode($this->cache->get($key)), true);
222
+    }
223
+
224
+    /**
225
+     * @param string $key
226
+     * @param mixed $value
227
+     *
228
+     * @return string
229
+     */
230
+    public function writeToCache($key, $value) {
231
+        if(!$this->configured) {
232
+            $this->readConfiguration();
233
+        }
234
+        if(is_null($this->cache)
235
+            || !$this->configuration->ldapCacheTTL
236
+            || !$this->configuration->ldapConfigurationActive) {
237
+            return null;
238
+        }
239
+        $key   = $this->getCacheKey($key);
240
+        $value = base64_encode(json_encode($value));
241
+        $this->cache->set($key, $value, $this->configuration->ldapCacheTTL);
242
+    }
243
+
244
+    public function clearCache() {
245
+        if(!is_null($this->cache)) {
246
+            $this->cache->clear($this->getCacheKey(null));
247
+        }
248
+    }
249
+
250
+    /**
251
+     * Caches the general LDAP configuration.
252
+     * @param bool $force optional. true, if the re-read should be forced. defaults
253
+     * to false.
254
+     * @return null
255
+     */
256
+    private function readConfiguration($force = false) {
257
+        if((!$this->configured || $force) && !is_null($this->configID)) {
258
+            $this->configuration->readConfiguration();
259
+            $this->configured = $this->validateConfiguration();
260
+        }
261
+    }
262
+
263
+    /**
264
+     * set LDAP configuration with values delivered by an array, not read from configuration
265
+     * @param array $config array that holds the config parameters in an associated array
266
+     * @param array &$setParameters optional; array where the set fields will be given to
267
+     * @return boolean true if config validates, false otherwise. Check with $setParameters for detailed success on single parameters
268
+     */
269
+    public function setConfiguration($config, &$setParameters = null) {
270
+        if(is_null($setParameters)) {
271
+            $setParameters = array();
272
+        }
273
+        $this->doNotValidate = false;
274
+        $this->configuration->setConfiguration($config, $setParameters);
275
+        if(count($setParameters) > 0) {
276
+            $this->configured = $this->validateConfiguration();
277
+        }
278
+
279
+
280
+        return $this->configured;
281
+    }
282
+
283
+    /**
284
+     * saves the current Configuration in the database and empties the
285
+     * cache
286
+     * @return null
287
+     */
288
+    public function saveConfiguration() {
289
+        $this->configuration->saveConfiguration();
290
+        $this->clearCache();
291
+    }
292
+
293
+    /**
294
+     * get the current LDAP configuration
295
+     * @return array
296
+     */
297
+    public function getConfiguration() {
298
+        $this->readConfiguration();
299
+        $config = $this->configuration->getConfiguration();
300
+        $cta = $this->configuration->getConfigTranslationArray();
301
+        $result = array();
302
+        foreach($cta as $dbkey => $configkey) {
303
+            switch($configkey) {
304
+                case 'homeFolderNamingRule':
305
+                    if(strpos($config[$configkey], 'attr:') === 0) {
306
+                        $result[$dbkey] = substr($config[$configkey], 5);
307
+                    } else {
308
+                        $result[$dbkey] = '';
309
+                    }
310
+                    break;
311
+                case 'ldapBase':
312
+                case 'ldapBaseUsers':
313
+                case 'ldapBaseGroups':
314
+                case 'ldapAttributesForUserSearch':
315
+                case 'ldapAttributesForGroupSearch':
316
+                    if(is_array($config[$configkey])) {
317
+                        $result[$dbkey] = implode("\n", $config[$configkey]);
318
+                        break;
319
+                    } //else follows default
320
+                default:
321
+                    $result[$dbkey] = $config[$configkey];
322
+            }
323
+        }
324
+        return $result;
325
+    }
326
+
327
+    private function doSoftValidation() {
328
+        //if User or Group Base are not set, take over Base DN setting
329
+        foreach(array('ldapBaseUsers', 'ldapBaseGroups') as $keyBase) {
330
+            $val = $this->configuration->$keyBase;
331
+            if(empty($val)) {
332
+                $this->configuration->$keyBase = $this->configuration->ldapBase;
333
+            }
334
+        }
335
+
336
+        foreach(array('ldapExpertUUIDUserAttr'  => 'ldapUuidUserAttribute',
337
+                        'ldapExpertUUIDGroupAttr' => 'ldapUuidGroupAttribute')
338
+                as $expertSetting => $effectiveSetting) {
339
+            $uuidOverride = $this->configuration->$expertSetting;
340
+            if(!empty($uuidOverride)) {
341
+                $this->configuration->$effectiveSetting = $uuidOverride;
342
+            } else {
343
+                $uuidAttributes = array('auto', 'entryuuid', 'nsuniqueid',
344
+                                        'objectguid', 'guid', 'ipauniqueid');
345
+                if(!in_array($this->configuration->$effectiveSetting,
346
+                            $uuidAttributes)
347
+                    && (!is_null($this->configID))) {
348
+                    $this->configuration->$effectiveSetting = 'auto';
349
+                    $this->configuration->saveConfiguration();
350
+                    \OCP\Util::writeLog('user_ldap',
351
+                                        'Illegal value for the '.
352
+                                        $effectiveSetting.', '.'reset to '.
353
+                                        'autodetect.', \OCP\Util::INFO);
354
+                }
355
+
356
+            }
357
+        }
358
+
359
+        $backupPort = intval($this->configuration->ldapBackupPort);
360
+        if ($backupPort <= 0) {
361
+            $this->configuration->backupPort = $this->configuration->ldapPort;
362
+        }
363
+
364
+        //make sure empty search attributes are saved as simple, empty array
365
+        $saKeys = array('ldapAttributesForUserSearch',
366
+                        'ldapAttributesForGroupSearch');
367
+        foreach($saKeys as $key) {
368
+            $val = $this->configuration->$key;
369
+            if(is_array($val) && count($val) === 1 && empty($val[0])) {
370
+                $this->configuration->$key = array();
371
+            }
372
+        }
373
+
374
+        if((stripos($this->configuration->ldapHost, 'ldaps://') === 0)
375
+            && $this->configuration->ldapTLS) {
376
+            $this->configuration->ldapTLS = false;
377
+            \OCP\Util::writeLog('user_ldap',
378
+                                'LDAPS (already using secure connection) and '.
379
+                                'TLS do not work together. Switched off TLS.',
380
+                                \OCP\Util::INFO);
381
+        }
382
+    }
383
+
384
+    /**
385
+     * @return bool
386
+     */
387
+    private function doCriticalValidation() {
388
+        $configurationOK = true;
389
+        $errorStr = 'Configuration Error (prefix '.
390
+                    strval($this->configPrefix).'): ';
391
+
392
+        //options that shall not be empty
393
+        $options = array('ldapHost', 'ldapPort', 'ldapUserDisplayName',
394
+                            'ldapGroupDisplayName', 'ldapLoginFilter');
395
+        foreach($options as $key) {
396
+            $val = $this->configuration->$key;
397
+            if(empty($val)) {
398
+                switch($key) {
399
+                    case 'ldapHost':
400
+                        $subj = 'LDAP Host';
401
+                        break;
402
+                    case 'ldapPort':
403
+                        $subj = 'LDAP Port';
404
+                        break;
405
+                    case 'ldapUserDisplayName':
406
+                        $subj = 'LDAP User Display Name';
407
+                        break;
408
+                    case 'ldapGroupDisplayName':
409
+                        $subj = 'LDAP Group Display Name';
410
+                        break;
411
+                    case 'ldapLoginFilter':
412
+                        $subj = 'LDAP Login Filter';
413
+                        break;
414
+                    default:
415
+                        $subj = $key;
416
+                        break;
417
+                }
418
+                $configurationOK = false;
419
+                \OCP\Util::writeLog('user_ldap',
420
+                                    $errorStr.'No '.$subj.' given!',
421
+                                    \OCP\Util::WARN);
422
+            }
423
+        }
424
+
425
+        //combinations
426
+        $agent = $this->configuration->ldapAgentName;
427
+        $pwd = $this->configuration->ldapAgentPassword;
428
+        if (
429
+            ($agent === ''  && $pwd !== '')
430
+            || ($agent !== '' && $pwd === '')
431
+        ) {
432
+            \OCP\Util::writeLog('user_ldap',
433
+                                $errorStr.'either no password is given for the'.
434
+                                'user agent or a password is given, but not an'.
435
+                                'LDAP agent.',
436
+                \OCP\Util::WARN);
437
+            $configurationOK = false;
438
+        }
439
+
440
+        $base = $this->configuration->ldapBase;
441
+        $baseUsers = $this->configuration->ldapBaseUsers;
442
+        $baseGroups = $this->configuration->ldapBaseGroups;
443
+
444
+        if(empty($base) && empty($baseUsers) && empty($baseGroups)) {
445
+            \OCP\Util::writeLog('user_ldap',
446
+                                $errorStr.'Not a single Base DN given.',
447
+                                \OCP\Util::WARN);
448
+            $configurationOK = false;
449
+        }
450
+
451
+        if(mb_strpos($this->configuration->ldapLoginFilter, '%uid', 0, 'UTF-8')
452
+            === false) {
453
+            \OCP\Util::writeLog('user_ldap',
454
+                                $errorStr.'login filter does not contain %uid '.
455
+                                'place holder.',
456
+                                \OCP\Util::WARN);
457
+            $configurationOK = false;
458
+        }
459
+
460
+        return $configurationOK;
461
+    }
462
+
463
+    /**
464
+     * Validates the user specified configuration
465
+     * @return bool true if configuration seems OK, false otherwise
466
+     */
467
+    private function validateConfiguration() {
468
+
469
+        if($this->doNotValidate) {
470
+            //don't do a validation if it is a new configuration with pure
471
+            //default values. Will be allowed on changes via __set or
472
+            //setConfiguration
473
+            return false;
474
+        }
475
+
476
+        // first step: "soft" checks: settings that are not really
477
+        // necessary, but advisable. If left empty, give an info message
478
+        $this->doSoftValidation();
479
+
480
+        //second step: critical checks. If left empty or filled wrong, mark as
481
+        //not configured and give a warning.
482
+        return $this->doCriticalValidation();
483
+    }
484
+
485
+
486
+    /**
487
+     * Connects and Binds to LDAP
488
+     */
489
+    private function establishConnection() {
490
+        if(!$this->configuration->ldapConfigurationActive) {
491
+            return null;
492
+        }
493
+        static $phpLDAPinstalled = true;
494
+        if(!$phpLDAPinstalled) {
495
+            return false;
496
+        }
497
+        if(!$this->ignoreValidation && !$this->configured) {
498
+            \OCP\Util::writeLog('user_ldap',
499
+                                'Configuration is invalid, cannot connect',
500
+                                \OCP\Util::WARN);
501
+            return false;
502
+        }
503
+        if(!$this->ldapConnectionRes) {
504
+            if(!$this->ldap->areLDAPFunctionsAvailable()) {
505
+                $phpLDAPinstalled = false;
506
+                \OCP\Util::writeLog('user_ldap',
507
+                                    'function ldap_connect is not available. Make '.
508
+                                    'sure that the PHP ldap module is installed.',
509
+                                    \OCP\Util::ERROR);
510
+
511
+                return false;
512
+            }
513
+            if($this->configuration->turnOffCertCheck) {
514
+                if(putenv('LDAPTLS_REQCERT=never')) {
515
+                    \OCP\Util::writeLog('user_ldap',
516
+                        'Turned off SSL certificate validation successfully.',
517
+                        \OCP\Util::DEBUG);
518
+                } else {
519
+                    \OCP\Util::writeLog('user_ldap',
520
+                                        'Could not turn off SSL certificate validation.',
521
+                                        \OCP\Util::WARN);
522
+                }
523
+            }
524
+
525
+            $bindStatus = false;
526
+            $error = -1;
527
+            try {
528
+                if (!$this->configuration->ldapOverrideMainServer
529
+                    && !$this->getFromCache('overrideMainServer')
530
+                ) {
531
+                    $this->doConnect($this->configuration->ldapHost,
532
+                        $this->configuration->ldapPort);
533
+                    $bindStatus = $this->bind();
534
+                    $error = $this->ldap->isResource($this->ldapConnectionRes) ?
535
+                        $this->ldap->errno($this->ldapConnectionRes) : -1;
536
+                }
537
+                if($bindStatus === true) {
538
+                    return $bindStatus;
539
+                }
540
+            } catch (\OC\ServerNotAvailableException $e) {
541
+                if(trim($this->configuration->ldapBackupHost) === "") {
542
+                    throw $e;
543
+                }
544
+            }
545
+
546
+            //if LDAP server is not reachable, try the Backup (Replica!) Server
547
+            if(    $error !== 0
548
+                || $this->configuration->ldapOverrideMainServer
549
+                || $this->getFromCache('overrideMainServer'))
550
+            {
551
+                $this->doConnect($this->configuration->ldapBackupHost,
552
+                                    $this->configuration->ldapBackupPort);
553
+                $bindStatus = $this->bind();
554
+                if($bindStatus && $error === -1 && !$this->getFromCache('overrideMainServer')) {
555
+                    //when bind to backup server succeeded and failed to main server,
556
+                    //skip contacting him until next cache refresh
557
+                    $this->writeToCache('overrideMainServer', true);
558
+                }
559
+            }
560
+            return $bindStatus;
561
+        }
562
+        return null;
563
+    }
564
+
565
+    /**
566
+     * @param string $host
567
+     * @param string $port
568
+     * @return bool
569
+     * @throws \OC\ServerNotAvailableException
570
+     */
571
+    private function doConnect($host, $port) {
572
+        if ($host === '') {
573
+            return false;
574
+        }
575
+        $this->ldapConnectionRes = $this->ldap->connect($host, $port);
576
+        if($this->ldap->setOption($this->ldapConnectionRes, LDAP_OPT_PROTOCOL_VERSION, 3)) {
577
+            if($this->ldap->setOption($this->ldapConnectionRes, LDAP_OPT_REFERRALS, 0)) {
578
+                if($this->configuration->ldapTLS) {
579
+                    $this->ldap->startTls($this->ldapConnectionRes);
580
+                }
581
+            }
582
+        } else {
583
+            throw new \OC\ServerNotAvailableException('Could not set required LDAP Protocol version.');
584
+        }
585
+        return true;
586
+    }
587
+
588
+    /**
589
+     * Binds to LDAP
590
+     */
591
+    public function bind() {
592
+        static $getConnectionResourceAttempt = false;
593
+        if(!$this->configuration->ldapConfigurationActive) {
594
+            return false;
595
+        }
596
+        if($getConnectionResourceAttempt) {
597
+            $getConnectionResourceAttempt = false;
598
+            return false;
599
+        }
600
+        $getConnectionResourceAttempt = true;
601
+        $cr = $this->getConnectionResource();
602
+        $getConnectionResourceAttempt = false;
603
+        if(!$this->ldap->isResource($cr)) {
604
+            return false;
605
+        }
606
+        $ldapLogin = @$this->ldap->bind($cr,
607
+                                        $this->configuration->ldapAgentName,
608
+                                        $this->configuration->ldapAgentPassword);
609
+        if(!$ldapLogin) {
610
+            \OCP\Util::writeLog('user_ldap',
611
+                'Bind failed: ' . $this->ldap->errno($cr) . ': ' . $this->ldap->error($cr),
612
+                \OCP\Util::WARN);
613
+            $this->ldapConnectionRes = null;
614
+            return false;
615
+        }
616
+        return true;
617
+    }
618 618
 
619 619
 }
Please login to merge, or discard this patch.
apps/user_ldap/lib/Access.php 1 patch
Indentation   +1768 added lines, -1768 removed lines patch added patch discarded remove patch
@@ -52,1527 +52,1527 @@  discard block
 block discarded – undo
52 52
  * @package OCA\User_LDAP
53 53
  */
54 54
 class Access extends LDAPUtility implements IUserTools {
55
-	/**
56
-	 * @var \OCA\User_LDAP\Connection
57
-	 */
58
-	public $connection;
59
-	/** @var Manager */
60
-	public $userManager;
61
-	//never ever check this var directly, always use getPagedSearchResultState
62
-	protected $pagedSearchedSuccessful;
63
-
64
-	/**
65
-	 * @var string[] $cookies an array of returned Paged Result cookies
66
-	 */
67
-	protected $cookies = array();
68
-
69
-	/**
70
-	 * @var string $lastCookie the last cookie returned from a Paged Results
71
-	 * operation, defaults to an empty string
72
-	 */
73
-	protected $lastCookie = '';
74
-
75
-	/**
76
-	 * @var AbstractMapping $userMapper
77
-	 */
78
-	protected $userMapper;
79
-
80
-	/**
81
-	* @var AbstractMapping $userMapper
82
-	*/
83
-	protected $groupMapper;
55
+    /**
56
+     * @var \OCA\User_LDAP\Connection
57
+     */
58
+    public $connection;
59
+    /** @var Manager */
60
+    public $userManager;
61
+    //never ever check this var directly, always use getPagedSearchResultState
62
+    protected $pagedSearchedSuccessful;
63
+
64
+    /**
65
+     * @var string[] $cookies an array of returned Paged Result cookies
66
+     */
67
+    protected $cookies = array();
68
+
69
+    /**
70
+     * @var string $lastCookie the last cookie returned from a Paged Results
71
+     * operation, defaults to an empty string
72
+     */
73
+    protected $lastCookie = '';
74
+
75
+    /**
76
+     * @var AbstractMapping $userMapper
77
+     */
78
+    protected $userMapper;
79
+
80
+    /**
81
+     * @var AbstractMapping $userMapper
82
+     */
83
+    protected $groupMapper;
84 84
 	
85
-	/**
86
-	 * @var \OCA\User_LDAP\Helper
87
-	 */
88
-	private $helper;
89
-
90
-	public function __construct(Connection $connection, ILDAPWrapper $ldap,
91
-		Manager $userManager, Helper $helper) {
92
-		parent::__construct($ldap);
93
-		$this->connection = $connection;
94
-		$this->userManager = $userManager;
95
-		$this->userManager->setLdapAccess($this);
96
-		$this->helper = $helper;
97
-	}
98
-
99
-	/**
100
-	 * sets the User Mapper
101
-	 * @param AbstractMapping $mapper
102
-	 */
103
-	public function setUserMapper(AbstractMapping $mapper) {
104
-		$this->userMapper = $mapper;
105
-	}
106
-
107
-	/**
108
-	 * returns the User Mapper
109
-	 * @throws \Exception
110
-	 * @return AbstractMapping
111
-	 */
112
-	public function getUserMapper() {
113
-		if(is_null($this->userMapper)) {
114
-			throw new \Exception('UserMapper was not assigned to this Access instance.');
115
-		}
116
-		return $this->userMapper;
117
-	}
118
-
119
-	/**
120
-	 * sets the Group Mapper
121
-	 * @param AbstractMapping $mapper
122
-	 */
123
-	public function setGroupMapper(AbstractMapping $mapper) {
124
-		$this->groupMapper = $mapper;
125
-	}
126
-
127
-	/**
128
-	 * returns the Group Mapper
129
-	 * @throws \Exception
130
-	 * @return AbstractMapping
131
-	 */
132
-	public function getGroupMapper() {
133
-		if(is_null($this->groupMapper)) {
134
-			throw new \Exception('GroupMapper was not assigned to this Access instance.');
135
-		}
136
-		return $this->groupMapper;
137
-	}
138
-
139
-	/**
140
-	 * @return bool
141
-	 */
142
-	private function checkConnection() {
143
-		return ($this->connection instanceof Connection);
144
-	}
145
-
146
-	/**
147
-	 * returns the Connection instance
148
-	 * @return \OCA\User_LDAP\Connection
149
-	 */
150
-	public function getConnection() {
151
-		return $this->connection;
152
-	}
153
-
154
-	/**
155
-	 * reads a given attribute for an LDAP record identified by a DN
156
-	 * @param string $dn the record in question
157
-	 * @param string $attr the attribute that shall be retrieved
158
-	 *        if empty, just check the record's existence
159
-	 * @param string $filter
160
-	 * @return array|false an array of values on success or an empty
161
-	 *          array if $attr is empty, false otherwise
162
-	 */
163
-	public function readAttribute($dn, $attr, $filter = 'objectClass=*') {
164
-		if(!$this->checkConnection()) {
165
-			\OCP\Util::writeLog('user_ldap',
166
-				'No LDAP Connector assigned, access impossible for readAttribute.',
167
-				\OCP\Util::WARN);
168
-			return false;
169
-		}
170
-		$cr = $this->connection->getConnectionResource();
171
-		if(!$this->ldap->isResource($cr)) {
172
-			//LDAP not available
173
-			\OCP\Util::writeLog('user_ldap', 'LDAP resource not available.', \OCP\Util::DEBUG);
174
-			return false;
175
-		}
176
-		//Cancel possibly running Paged Results operation, otherwise we run in
177
-		//LDAP protocol errors
178
-		$this->abandonPagedSearch();
179
-		// openLDAP requires that we init a new Paged Search. Not needed by AD,
180
-		// but does not hurt either.
181
-		$pagingSize = intval($this->connection->ldapPagingSize);
182
-		// 0 won't result in replies, small numbers may leave out groups
183
-		// (cf. #12306), 500 is default for paging and should work everywhere.
184
-		$maxResults = $pagingSize > 20 ? $pagingSize : 500;
185
-		$attr = mb_strtolower($attr, 'UTF-8');
186
-		// the actual read attribute later may contain parameters on a ranged
187
-		// request, e.g. member;range=99-199. Depends on server reply.
188
-		$attrToRead = $attr;
189
-
190
-		$values = [];
191
-		$isRangeRequest = false;
192
-		do {
193
-			$result = $this->executeRead($cr, $dn, $attrToRead, $filter, $maxResults);
194
-			if(is_bool($result)) {
195
-				// when an exists request was run and it was successful, an empty
196
-				// array must be returned
197
-				return $result ? [] : false;
198
-			}
199
-
200
-			if (!$isRangeRequest) {
201
-				$values = $this->extractAttributeValuesFromResult($result, $attr);
202
-				if (!empty($values)) {
203
-					return $values;
204
-				}
205
-			}
206
-
207
-			$isRangeRequest = false;
208
-			$result = $this->extractRangeData($result, $attr);
209
-			if (!empty($result)) {
210
-				$normalizedResult = $this->extractAttributeValuesFromResult(
211
-					[ $attr => $result['values'] ],
212
-					$attr
213
-				);
214
-				$values = array_merge($values, $normalizedResult);
215
-
216
-				if($result['rangeHigh'] === '*') {
217
-					// when server replies with * as high range value, there are
218
-					// no more results left
219
-					return $values;
220
-				} else {
221
-					$low  = $result['rangeHigh'] + 1;
222
-					$attrToRead = $result['attributeName'] . ';range=' . $low . '-*';
223
-					$isRangeRequest = true;
224
-				}
225
-			}
226
-		} while($isRangeRequest);
227
-
228
-		\OCP\Util::writeLog('user_ldap', 'Requested attribute '.$attr.' not found for '.$dn, \OCP\Util::DEBUG);
229
-		return false;
230
-	}
231
-
232
-	/**
233
-	 * Runs an read operation against LDAP
234
-	 *
235
-	 * @param resource $cr the LDAP connection
236
-	 * @param string $dn
237
-	 * @param string $attribute
238
-	 * @param string $filter
239
-	 * @param int $maxResults
240
-	 * @return array|bool false if there was any error, true if an exists check
241
-	 *                    was performed and the requested DN found, array with the
242
-	 *                    returned data on a successful usual operation
243
-	 */
244
-	public function executeRead($cr, $dn, $attribute, $filter, $maxResults) {
245
-		$this->initPagedSearch($filter, array($dn), array($attribute), $maxResults, 0);
246
-		$dn = $this->helper->DNasBaseParameter($dn);
247
-		$rr = @$this->ldap->read($cr, $dn, $filter, array($attribute));
248
-		if (!$this->ldap->isResource($rr)) {
249
-			if ($attribute !== '') {
250
-				//do not throw this message on userExists check, irritates
251
-				\OCP\Util::writeLog('user_ldap', 'readAttribute failed for DN ' . $dn, \OCP\Util::DEBUG);
252
-			}
253
-			//in case an error occurs , e.g. object does not exist
254
-			return false;
255
-		}
256
-		if ($attribute === '' && ($filter === 'objectclass=*' || $this->ldap->countEntries($cr, $rr) === 1)) {
257
-			\OCP\Util::writeLog('user_ldap', 'readAttribute: ' . $dn . ' found', \OCP\Util::DEBUG);
258
-			return true;
259
-		}
260
-		$er = $this->ldap->firstEntry($cr, $rr);
261
-		if (!$this->ldap->isResource($er)) {
262
-			//did not match the filter, return false
263
-			return false;
264
-		}
265
-		//LDAP attributes are not case sensitive
266
-		$result = \OCP\Util::mb_array_change_key_case(
267
-			$this->ldap->getAttributes($cr, $er), MB_CASE_LOWER, 'UTF-8');
268
-
269
-		return $result;
270
-	}
271
-
272
-	/**
273
-	 * Normalizes a result grom getAttributes(), i.e. handles DNs and binary
274
-	 * data if present.
275
-	 *
276
-	 * @param array $result from ILDAPWrapper::getAttributes()
277
-	 * @param string $attribute the attribute name that was read
278
-	 * @return string[]
279
-	 */
280
-	public function extractAttributeValuesFromResult($result, $attribute) {
281
-		$values = [];
282
-		if(isset($result[$attribute]) && $result[$attribute]['count'] > 0) {
283
-			$lowercaseAttribute = strtolower($attribute);
284
-			for($i=0;$i<$result[$attribute]['count'];$i++) {
285
-				if($this->resemblesDN($attribute)) {
286
-					$values[] = $this->helper->sanitizeDN($result[$attribute][$i]);
287
-				} elseif($lowercaseAttribute === 'objectguid' || $lowercaseAttribute === 'guid') {
288
-					$values[] = $this->convertObjectGUID2Str($result[$attribute][$i]);
289
-				} else {
290
-					$values[] = $result[$attribute][$i];
291
-				}
292
-			}
293
-		}
294
-		return $values;
295
-	}
296
-
297
-	/**
298
-	 * Attempts to find ranged data in a getAttribute results and extracts the
299
-	 * returned values as well as information on the range and full attribute
300
-	 * name for further processing.
301
-	 *
302
-	 * @param array $result from ILDAPWrapper::getAttributes()
303
-	 * @param string $attribute the attribute name that was read. Without ";range=…"
304
-	 * @return array If a range was detected with keys 'values', 'attributeName',
305
-	 *               'attributeFull' and 'rangeHigh', otherwise empty.
306
-	 */
307
-	public function extractRangeData($result, $attribute) {
308
-		$keys = array_keys($result);
309
-		foreach($keys as $key) {
310
-			if($key !== $attribute && strpos($key, $attribute) === 0) {
311
-				$queryData = explode(';', $key);
312
-				if(strpos($queryData[1], 'range=') === 0) {
313
-					$high = substr($queryData[1], 1 + strpos($queryData[1], '-'));
314
-					$data = [
315
-						'values' => $result[$key],
316
-						'attributeName' => $queryData[0],
317
-						'attributeFull' => $key,
318
-						'rangeHigh' => $high,
319
-					];
320
-					return $data;
321
-				}
322
-			}
323
-		}
324
-		return [];
325
-	}
85
+    /**
86
+     * @var \OCA\User_LDAP\Helper
87
+     */
88
+    private $helper;
89
+
90
+    public function __construct(Connection $connection, ILDAPWrapper $ldap,
91
+        Manager $userManager, Helper $helper) {
92
+        parent::__construct($ldap);
93
+        $this->connection = $connection;
94
+        $this->userManager = $userManager;
95
+        $this->userManager->setLdapAccess($this);
96
+        $this->helper = $helper;
97
+    }
98
+
99
+    /**
100
+     * sets the User Mapper
101
+     * @param AbstractMapping $mapper
102
+     */
103
+    public function setUserMapper(AbstractMapping $mapper) {
104
+        $this->userMapper = $mapper;
105
+    }
106
+
107
+    /**
108
+     * returns the User Mapper
109
+     * @throws \Exception
110
+     * @return AbstractMapping
111
+     */
112
+    public function getUserMapper() {
113
+        if(is_null($this->userMapper)) {
114
+            throw new \Exception('UserMapper was not assigned to this Access instance.');
115
+        }
116
+        return $this->userMapper;
117
+    }
118
+
119
+    /**
120
+     * sets the Group Mapper
121
+     * @param AbstractMapping $mapper
122
+     */
123
+    public function setGroupMapper(AbstractMapping $mapper) {
124
+        $this->groupMapper = $mapper;
125
+    }
126
+
127
+    /**
128
+     * returns the Group Mapper
129
+     * @throws \Exception
130
+     * @return AbstractMapping
131
+     */
132
+    public function getGroupMapper() {
133
+        if(is_null($this->groupMapper)) {
134
+            throw new \Exception('GroupMapper was not assigned to this Access instance.');
135
+        }
136
+        return $this->groupMapper;
137
+    }
138
+
139
+    /**
140
+     * @return bool
141
+     */
142
+    private function checkConnection() {
143
+        return ($this->connection instanceof Connection);
144
+    }
145
+
146
+    /**
147
+     * returns the Connection instance
148
+     * @return \OCA\User_LDAP\Connection
149
+     */
150
+    public function getConnection() {
151
+        return $this->connection;
152
+    }
153
+
154
+    /**
155
+     * reads a given attribute for an LDAP record identified by a DN
156
+     * @param string $dn the record in question
157
+     * @param string $attr the attribute that shall be retrieved
158
+     *        if empty, just check the record's existence
159
+     * @param string $filter
160
+     * @return array|false an array of values on success or an empty
161
+     *          array if $attr is empty, false otherwise
162
+     */
163
+    public function readAttribute($dn, $attr, $filter = 'objectClass=*') {
164
+        if(!$this->checkConnection()) {
165
+            \OCP\Util::writeLog('user_ldap',
166
+                'No LDAP Connector assigned, access impossible for readAttribute.',
167
+                \OCP\Util::WARN);
168
+            return false;
169
+        }
170
+        $cr = $this->connection->getConnectionResource();
171
+        if(!$this->ldap->isResource($cr)) {
172
+            //LDAP not available
173
+            \OCP\Util::writeLog('user_ldap', 'LDAP resource not available.', \OCP\Util::DEBUG);
174
+            return false;
175
+        }
176
+        //Cancel possibly running Paged Results operation, otherwise we run in
177
+        //LDAP protocol errors
178
+        $this->abandonPagedSearch();
179
+        // openLDAP requires that we init a new Paged Search. Not needed by AD,
180
+        // but does not hurt either.
181
+        $pagingSize = intval($this->connection->ldapPagingSize);
182
+        // 0 won't result in replies, small numbers may leave out groups
183
+        // (cf. #12306), 500 is default for paging and should work everywhere.
184
+        $maxResults = $pagingSize > 20 ? $pagingSize : 500;
185
+        $attr = mb_strtolower($attr, 'UTF-8');
186
+        // the actual read attribute later may contain parameters on a ranged
187
+        // request, e.g. member;range=99-199. Depends on server reply.
188
+        $attrToRead = $attr;
189
+
190
+        $values = [];
191
+        $isRangeRequest = false;
192
+        do {
193
+            $result = $this->executeRead($cr, $dn, $attrToRead, $filter, $maxResults);
194
+            if(is_bool($result)) {
195
+                // when an exists request was run and it was successful, an empty
196
+                // array must be returned
197
+                return $result ? [] : false;
198
+            }
199
+
200
+            if (!$isRangeRequest) {
201
+                $values = $this->extractAttributeValuesFromResult($result, $attr);
202
+                if (!empty($values)) {
203
+                    return $values;
204
+                }
205
+            }
206
+
207
+            $isRangeRequest = false;
208
+            $result = $this->extractRangeData($result, $attr);
209
+            if (!empty($result)) {
210
+                $normalizedResult = $this->extractAttributeValuesFromResult(
211
+                    [ $attr => $result['values'] ],
212
+                    $attr
213
+                );
214
+                $values = array_merge($values, $normalizedResult);
215
+
216
+                if($result['rangeHigh'] === '*') {
217
+                    // when server replies with * as high range value, there are
218
+                    // no more results left
219
+                    return $values;
220
+                } else {
221
+                    $low  = $result['rangeHigh'] + 1;
222
+                    $attrToRead = $result['attributeName'] . ';range=' . $low . '-*';
223
+                    $isRangeRequest = true;
224
+                }
225
+            }
226
+        } while($isRangeRequest);
227
+
228
+        \OCP\Util::writeLog('user_ldap', 'Requested attribute '.$attr.' not found for '.$dn, \OCP\Util::DEBUG);
229
+        return false;
230
+    }
231
+
232
+    /**
233
+     * Runs an read operation against LDAP
234
+     *
235
+     * @param resource $cr the LDAP connection
236
+     * @param string $dn
237
+     * @param string $attribute
238
+     * @param string $filter
239
+     * @param int $maxResults
240
+     * @return array|bool false if there was any error, true if an exists check
241
+     *                    was performed and the requested DN found, array with the
242
+     *                    returned data on a successful usual operation
243
+     */
244
+    public function executeRead($cr, $dn, $attribute, $filter, $maxResults) {
245
+        $this->initPagedSearch($filter, array($dn), array($attribute), $maxResults, 0);
246
+        $dn = $this->helper->DNasBaseParameter($dn);
247
+        $rr = @$this->ldap->read($cr, $dn, $filter, array($attribute));
248
+        if (!$this->ldap->isResource($rr)) {
249
+            if ($attribute !== '') {
250
+                //do not throw this message on userExists check, irritates
251
+                \OCP\Util::writeLog('user_ldap', 'readAttribute failed for DN ' . $dn, \OCP\Util::DEBUG);
252
+            }
253
+            //in case an error occurs , e.g. object does not exist
254
+            return false;
255
+        }
256
+        if ($attribute === '' && ($filter === 'objectclass=*' || $this->ldap->countEntries($cr, $rr) === 1)) {
257
+            \OCP\Util::writeLog('user_ldap', 'readAttribute: ' . $dn . ' found', \OCP\Util::DEBUG);
258
+            return true;
259
+        }
260
+        $er = $this->ldap->firstEntry($cr, $rr);
261
+        if (!$this->ldap->isResource($er)) {
262
+            //did not match the filter, return false
263
+            return false;
264
+        }
265
+        //LDAP attributes are not case sensitive
266
+        $result = \OCP\Util::mb_array_change_key_case(
267
+            $this->ldap->getAttributes($cr, $er), MB_CASE_LOWER, 'UTF-8');
268
+
269
+        return $result;
270
+    }
271
+
272
+    /**
273
+     * Normalizes a result grom getAttributes(), i.e. handles DNs and binary
274
+     * data if present.
275
+     *
276
+     * @param array $result from ILDAPWrapper::getAttributes()
277
+     * @param string $attribute the attribute name that was read
278
+     * @return string[]
279
+     */
280
+    public function extractAttributeValuesFromResult($result, $attribute) {
281
+        $values = [];
282
+        if(isset($result[$attribute]) && $result[$attribute]['count'] > 0) {
283
+            $lowercaseAttribute = strtolower($attribute);
284
+            for($i=0;$i<$result[$attribute]['count'];$i++) {
285
+                if($this->resemblesDN($attribute)) {
286
+                    $values[] = $this->helper->sanitizeDN($result[$attribute][$i]);
287
+                } elseif($lowercaseAttribute === 'objectguid' || $lowercaseAttribute === 'guid') {
288
+                    $values[] = $this->convertObjectGUID2Str($result[$attribute][$i]);
289
+                } else {
290
+                    $values[] = $result[$attribute][$i];
291
+                }
292
+            }
293
+        }
294
+        return $values;
295
+    }
296
+
297
+    /**
298
+     * Attempts to find ranged data in a getAttribute results and extracts the
299
+     * returned values as well as information on the range and full attribute
300
+     * name for further processing.
301
+     *
302
+     * @param array $result from ILDAPWrapper::getAttributes()
303
+     * @param string $attribute the attribute name that was read. Without ";range=…"
304
+     * @return array If a range was detected with keys 'values', 'attributeName',
305
+     *               'attributeFull' and 'rangeHigh', otherwise empty.
306
+     */
307
+    public function extractRangeData($result, $attribute) {
308
+        $keys = array_keys($result);
309
+        foreach($keys as $key) {
310
+            if($key !== $attribute && strpos($key, $attribute) === 0) {
311
+                $queryData = explode(';', $key);
312
+                if(strpos($queryData[1], 'range=') === 0) {
313
+                    $high = substr($queryData[1], 1 + strpos($queryData[1], '-'));
314
+                    $data = [
315
+                        'values' => $result[$key],
316
+                        'attributeName' => $queryData[0],
317
+                        'attributeFull' => $key,
318
+                        'rangeHigh' => $high,
319
+                    ];
320
+                    return $data;
321
+                }
322
+            }
323
+        }
324
+        return [];
325
+    }
326 326
 	
327
-	/**
328
-	 * Set password for an LDAP user identified by a DN
329
-	 *
330
-	 * @param string $userDN the user in question
331
-	 * @param string $password the new password
332
-	 * @return bool
333
-	 * @throws HintException
334
-	 * @throws \Exception
335
-	 */
336
-	public function setPassword($userDN, $password) {
337
-		if(intval($this->connection->turnOnPasswordChange) !== 1) {
338
-			throw new \Exception('LDAP password changes are disabled.');
339
-		}
340
-		$cr = $this->connection->getConnectionResource();
341
-		if(!$this->ldap->isResource($cr)) {
342
-			//LDAP not available
343
-			\OCP\Util::writeLog('user_ldap', 'LDAP resource not available.', \OCP\Util::DEBUG);
344
-			return false;
345
-		}
327
+    /**
328
+     * Set password for an LDAP user identified by a DN
329
+     *
330
+     * @param string $userDN the user in question
331
+     * @param string $password the new password
332
+     * @return bool
333
+     * @throws HintException
334
+     * @throws \Exception
335
+     */
336
+    public function setPassword($userDN, $password) {
337
+        if(intval($this->connection->turnOnPasswordChange) !== 1) {
338
+            throw new \Exception('LDAP password changes are disabled.');
339
+        }
340
+        $cr = $this->connection->getConnectionResource();
341
+        if(!$this->ldap->isResource($cr)) {
342
+            //LDAP not available
343
+            \OCP\Util::writeLog('user_ldap', 'LDAP resource not available.', \OCP\Util::DEBUG);
344
+            return false;
345
+        }
346 346
 		
347
-		try {
348
-			return $this->ldap->modReplace($cr, $userDN, $password);
349
-		} catch(ConstraintViolationException $e) {
350
-			throw new HintException('Password change rejected.', \OC::$server->getL10N('user_ldap')->t('Password change rejected. Hint: ').$e->getMessage(), $e->getCode());
351
-		}
352
-	}
353
-
354
-	/**
355
-	 * checks whether the given attributes value is probably a DN
356
-	 * @param string $attr the attribute in question
357
-	 * @return boolean if so true, otherwise false
358
-	 */
359
-	private function resemblesDN($attr) {
360
-		$resemblingAttributes = array(
361
-			'dn',
362
-			'uniquemember',
363
-			'member',
364
-			// memberOf is an "operational" attribute, without a definition in any RFC
365
-			'memberof'
366
-		);
367
-		return in_array($attr, $resemblingAttributes);
368
-	}
369
-
370
-	/**
371
-	 * checks whether the given string is probably a DN
372
-	 * @param string $string
373
-	 * @return boolean
374
-	 */
375
-	public function stringResemblesDN($string) {
376
-		$r = $this->ldap->explodeDN($string, 0);
377
-		// if exploding a DN succeeds and does not end up in
378
-		// an empty array except for $r[count] being 0.
379
-		return (is_array($r) && count($r) > 1);
380
-	}
381
-
382
-	/**
383
-	 * returns a DN-string that is cleaned from not domain parts, e.g.
384
-	 * cn=foo,cn=bar,dc=foobar,dc=server,dc=org
385
-	 * becomes dc=foobar,dc=server,dc=org
386
-	 * @param string $dn
387
-	 * @return string
388
-	 */
389
-	public function getDomainDNFromDN($dn) {
390
-		$allParts = $this->ldap->explodeDN($dn, 0);
391
-		if($allParts === false) {
392
-			//not a valid DN
393
-			return '';
394
-		}
395
-		$domainParts = array();
396
-		$dcFound = false;
397
-		foreach($allParts as $part) {
398
-			if(!$dcFound && strpos($part, 'dc=') === 0) {
399
-				$dcFound = true;
400
-			}
401
-			if($dcFound) {
402
-				$domainParts[] = $part;
403
-			}
404
-		}
405
-		$domainDN = implode(',', $domainParts);
406
-		return $domainDN;
407
-	}
408
-
409
-	/**
410
-	 * returns the LDAP DN for the given internal ownCloud name of the group
411
-	 * @param string $name the ownCloud name in question
412
-	 * @return string|false LDAP DN on success, otherwise false
413
-	 */
414
-	public function groupname2dn($name) {
415
-		return $this->groupMapper->getDNByName($name);
416
-	}
417
-
418
-	/**
419
-	 * returns the LDAP DN for the given internal ownCloud name of the user
420
-	 * @param string $name the ownCloud name in question
421
-	 * @return string|false with the LDAP DN on success, otherwise false
422
-	 */
423
-	public function username2dn($name) {
424
-		$fdn = $this->userMapper->getDNByName($name);
425
-
426
-		//Check whether the DN belongs to the Base, to avoid issues on multi-
427
-		//server setups
428
-		if(is_string($fdn) && $this->isDNPartOfBase($fdn, $this->connection->ldapBaseUsers)) {
429
-			return $fdn;
430
-		}
431
-
432
-		return false;
433
-	}
434
-
435
-	/**
436
-	 * returns the internal ownCloud name for the given LDAP DN of the group, false on DN outside of search DN or failure
437
-	 * @param string $fdn the dn of the group object
438
-	 * @param string $ldapName optional, the display name of the object
439
-	 * @return string|false with the name to use in ownCloud, false on DN outside of search DN
440
-	 */
441
-	public function dn2groupname($fdn, $ldapName = null) {
442
-		//To avoid bypassing the base DN settings under certain circumstances
443
-		//with the group support, check whether the provided DN matches one of
444
-		//the given Bases
445
-		if(!$this->isDNPartOfBase($fdn, $this->connection->ldapBaseGroups)) {
446
-			return false;
447
-		}
448
-
449
-		return $this->dn2ocname($fdn, $ldapName, false);
450
-	}
451
-
452
-	/**
453
-	 * accepts an array of group DNs and tests whether they match the user
454
-	 * filter by doing read operations against the group entries. Returns an
455
-	 * array of DNs that match the filter.
456
-	 *
457
-	 * @param string[] $groupDNs
458
-	 * @return string[]
459
-	 */
460
-	public function groupsMatchFilter($groupDNs) {
461
-		$validGroupDNs = [];
462
-		foreach($groupDNs as $dn) {
463
-			$cacheKey = 'groupsMatchFilter-'.$dn;
464
-			$groupMatchFilter = $this->connection->getFromCache($cacheKey);
465
-			if(!is_null($groupMatchFilter)) {
466
-				if($groupMatchFilter) {
467
-					$validGroupDNs[] = $dn;
468
-				}
469
-				continue;
470
-			}
471
-
472
-			// Check the base DN first. If this is not met already, we don't
473
-			// need to ask the server at all.
474
-			if(!$this->isDNPartOfBase($dn, $this->connection->ldapBaseGroups)) {
475
-				$this->connection->writeToCache($cacheKey, false);
476
-				continue;
477
-			}
478
-
479
-			$result = $this->readAttribute($dn, 'cn', $this->connection->ldapGroupFilter);
480
-			if(is_array($result)) {
481
-				$this->connection->writeToCache($cacheKey, true);
482
-				$validGroupDNs[] = $dn;
483
-			} else {
484
-				$this->connection->writeToCache($cacheKey, false);
485
-			}
486
-
487
-		}
488
-		return $validGroupDNs;
489
-	}
490
-
491
-	/**
492
-	 * returns the internal ownCloud name for the given LDAP DN of the user, false on DN outside of search DN or failure
493
-	 * @param string $dn the dn of the user object
494
-	 * @param string $ldapName optional, the display name of the object
495
-	 * @return string|false with with the name to use in ownCloud
496
-	 */
497
-	public function dn2username($fdn, $ldapName = null) {
498
-		//To avoid bypassing the base DN settings under certain circumstances
499
-		//with the group support, check whether the provided DN matches one of
500
-		//the given Bases
501
-		if(!$this->isDNPartOfBase($fdn, $this->connection->ldapBaseUsers)) {
502
-			return false;
503
-		}
504
-
505
-		return $this->dn2ocname($fdn, $ldapName, true);
506
-	}
507
-
508
-	/**
509
-	 * returns an internal ownCloud name for the given LDAP DN, false on DN outside of search DN
510
-	 * @param string $dn the dn of the user object
511
-	 * @param string $ldapName optional, the display name of the object
512
-	 * @param bool $isUser optional, whether it is a user object (otherwise group assumed)
513
-	 * @return string|false with with the name to use in ownCloud
514
-	 */
515
-	public function dn2ocname($fdn, $ldapName = null, $isUser = true) {
516
-		if($isUser) {
517
-			$mapper = $this->getUserMapper();
518
-			$nameAttribute = $this->connection->ldapUserDisplayName;
519
-		} else {
520
-			$mapper = $this->getGroupMapper();
521
-			$nameAttribute = $this->connection->ldapGroupDisplayName;
522
-		}
523
-
524
-		//let's try to retrieve the ownCloud name from the mappings table
525
-		$ocName = $mapper->getNameByDN($fdn);
526
-		if(is_string($ocName)) {
527
-			return $ocName;
528
-		}
529
-
530
-		//second try: get the UUID and check if it is known. Then, update the DN and return the name.
531
-		$uuid = $this->getUUID($fdn, $isUser);
532
-		if(is_string($uuid)) {
533
-			$ocName = $mapper->getNameByUUID($uuid);
534
-			if(is_string($ocName)) {
535
-				$mapper->setDNbyUUID($fdn, $uuid);
536
-				return $ocName;
537
-			}
538
-		} else {
539
-			//If the UUID can't be detected something is foul.
540
-			\OCP\Util::writeLog('user_ldap', 'Cannot determine UUID for '.$fdn.'. Skipping.', \OCP\Util::INFO);
541
-			return false;
542
-		}
543
-
544
-		if(is_null($ldapName)) {
545
-			$ldapName = $this->readAttribute($fdn, $nameAttribute);
546
-			if(!isset($ldapName[0]) && empty($ldapName[0])) {
547
-				\OCP\Util::writeLog('user_ldap', 'No or empty name for '.$fdn.'.', \OCP\Util::INFO);
548
-				return false;
549
-			}
550
-			$ldapName = $ldapName[0];
551
-		}
552
-
553
-		if($isUser) {
554
-			$usernameAttribute = strval($this->connection->ldapExpertUsernameAttr);
555
-			if ($usernameAttribute !== '') {
556
-				$username = $this->readAttribute($fdn, $usernameAttribute);
557
-				$username = $username[0];
558
-			} else {
559
-				$username = $uuid;
560
-			}
561
-			$intName = $this->sanitizeUsername($username);
562
-		} else {
563
-			$intName = $ldapName;
564
-		}
565
-
566
-		//a new user/group! Add it only if it doesn't conflict with other backend's users or existing groups
567
-		//disabling Cache is required to avoid that the new user is cached as not-existing in fooExists check
568
-		//NOTE: mind, disabling cache affects only this instance! Using it
569
-		// outside of core user management will still cache the user as non-existing.
570
-		$originalTTL = $this->connection->ldapCacheTTL;
571
-		$this->connection->setConfiguration(array('ldapCacheTTL' => 0));
572
-		if(($isUser && !\OCP\User::userExists($intName))
573
-			|| (!$isUser && !\OC_Group::groupExists($intName))) {
574
-			if($mapper->map($fdn, $intName, $uuid)) {
575
-				$this->connection->setConfiguration(array('ldapCacheTTL' => $originalTTL));
576
-				return $intName;
577
-			}
578
-		}
579
-		$this->connection->setConfiguration(array('ldapCacheTTL' => $originalTTL));
580
-
581
-		$altName = $this->createAltInternalOwnCloudName($intName, $isUser);
582
-		if(is_string($altName) && $mapper->map($fdn, $altName, $uuid)) {
583
-			return $altName;
584
-		}
585
-
586
-		//if everything else did not help..
587
-		\OCP\Util::writeLog('user_ldap', 'Could not create unique name for '.$fdn.'.', \OCP\Util::INFO);
588
-		return false;
589
-	}
590
-
591
-	/**
592
-	 * gives back the user names as they are used ownClod internally
593
-	 * @param array $ldapUsers as returned by fetchList()
594
-	 * @return array an array with the user names to use in ownCloud
595
-	 *
596
-	 * gives back the user names as they are used ownClod internally
597
-	 */
598
-	public function ownCloudUserNames($ldapUsers) {
599
-		return $this->ldap2ownCloudNames($ldapUsers, true);
600
-	}
601
-
602
-	/**
603
-	 * gives back the group names as they are used ownClod internally
604
-	 * @param array $ldapGroups as returned by fetchList()
605
-	 * @return array an array with the group names to use in ownCloud
606
-	 *
607
-	 * gives back the group names as they are used ownClod internally
608
-	 */
609
-	public function ownCloudGroupNames($ldapGroups) {
610
-		return $this->ldap2ownCloudNames($ldapGroups, false);
611
-	}
612
-
613
-	/**
614
-	 * @param array $ldapObjects as returned by fetchList()
615
-	 * @param bool $isUsers
616
-	 * @return array
617
-	 */
618
-	private function ldap2ownCloudNames($ldapObjects, $isUsers) {
619
-		if($isUsers) {
620
-			$nameAttribute = $this->connection->ldapUserDisplayName;
621
-			$sndAttribute  = $this->connection->ldapUserDisplayName2;
622
-		} else {
623
-			$nameAttribute = $this->connection->ldapGroupDisplayName;
624
-		}
625
-		$ownCloudNames = array();
626
-
627
-		foreach($ldapObjects as $ldapObject) {
628
-			$nameByLDAP = null;
629
-			if(    isset($ldapObject[$nameAttribute])
630
-				&& is_array($ldapObject[$nameAttribute])
631
-				&& isset($ldapObject[$nameAttribute][0])
632
-			) {
633
-				// might be set, but not necessarily. if so, we use it.
634
-				$nameByLDAP = $ldapObject[$nameAttribute][0];
635
-			}
636
-
637
-			$ocName = $this->dn2ocname($ldapObject['dn'][0], $nameByLDAP, $isUsers);
638
-			if($ocName) {
639
-				$ownCloudNames[] = $ocName;
640
-				if($isUsers) {
641
-					//cache the user names so it does not need to be retrieved
642
-					//again later (e.g. sharing dialogue).
643
-					if(is_null($nameByLDAP)) {
644
-						continue;
645
-					}
646
-					$sndName = isset($ldapObject[$sndAttribute][0])
647
-						? $ldapObject[$sndAttribute][0] : '';
648
-					$this->cacheUserDisplayName($ocName, $nameByLDAP, $sndName);
649
-				}
650
-			}
651
-		}
652
-		return $ownCloudNames;
653
-	}
654
-
655
-	/**
656
-	 * caches the user display name
657
-	 * @param string $ocName the internal ownCloud username
658
-	 * @param string|false $home the home directory path
659
-	 */
660
-	public function cacheUserHome($ocName, $home) {
661
-		$cacheKey = 'getHome'.$ocName;
662
-		$this->connection->writeToCache($cacheKey, $home);
663
-	}
664
-
665
-	/**
666
-	 * caches a user as existing
667
-	 * @param string $ocName the internal ownCloud username
668
-	 */
669
-	public function cacheUserExists($ocName) {
670
-		$this->connection->writeToCache('userExists'.$ocName, true);
671
-	}
672
-
673
-	/**
674
-	 * caches the user display name
675
-	 * @param string $ocName the internal ownCloud username
676
-	 * @param string $displayName the display name
677
-	 * @param string $displayName2 the second display name
678
-	 */
679
-	public function cacheUserDisplayName($ocName, $displayName, $displayName2 = '') {
680
-		$user = $this->userManager->get($ocName);
681
-		if($user === null) {
682
-			return;
683
-		}
684
-		$displayName = $user->composeAndStoreDisplayName($displayName, $displayName2);
685
-		$cacheKeyTrunk = 'getDisplayName';
686
-		$this->connection->writeToCache($cacheKeyTrunk.$ocName, $displayName);
687
-	}
688
-
689
-	/**
690
-	 * creates a unique name for internal ownCloud use for users. Don't call it directly.
691
-	 * @param string $name the display name of the object
692
-	 * @return string|false with with the name to use in ownCloud or false if unsuccessful
693
-	 *
694
-	 * Instead of using this method directly, call
695
-	 * createAltInternalOwnCloudName($name, true)
696
-	 */
697
-	private function _createAltInternalOwnCloudNameForUsers($name) {
698
-		$attempts = 0;
699
-		//while loop is just a precaution. If a name is not generated within
700
-		//20 attempts, something else is very wrong. Avoids infinite loop.
701
-		while($attempts < 20){
702
-			$altName = $name . '_' . rand(1000,9999);
703
-			if(!\OCP\User::userExists($altName)) {
704
-				return $altName;
705
-			}
706
-			$attempts++;
707
-		}
708
-		return false;
709
-	}
710
-
711
-	/**
712
-	 * creates a unique name for internal ownCloud use for groups. Don't call it directly.
713
-	 * @param string $name the display name of the object
714
-	 * @return string|false with with the name to use in ownCloud or false if unsuccessful.
715
-	 *
716
-	 * Instead of using this method directly, call
717
-	 * createAltInternalOwnCloudName($name, false)
718
-	 *
719
-	 * Group names are also used as display names, so we do a sequential
720
-	 * numbering, e.g. Developers_42 when there are 41 other groups called
721
-	 * "Developers"
722
-	 */
723
-	private function _createAltInternalOwnCloudNameForGroups($name) {
724
-		$usedNames = $this->groupMapper->getNamesBySearch($name, "", '_%');
725
-		if(!($usedNames) || count($usedNames) === 0) {
726
-			$lastNo = 1; //will become name_2
727
-		} else {
728
-			natsort($usedNames);
729
-			$lastName = array_pop($usedNames);
730
-			$lastNo = intval(substr($lastName, strrpos($lastName, '_') + 1));
731
-		}
732
-		$altName = $name.'_'.strval($lastNo+1);
733
-		unset($usedNames);
734
-
735
-		$attempts = 1;
736
-		while($attempts < 21){
737
-			// Check to be really sure it is unique
738
-			// while loop is just a precaution. If a name is not generated within
739
-			// 20 attempts, something else is very wrong. Avoids infinite loop.
740
-			if(!\OC_Group::groupExists($altName)) {
741
-				return $altName;
742
-			}
743
-			$altName = $name . '_' . ($lastNo + $attempts);
744
-			$attempts++;
745
-		}
746
-		return false;
747
-	}
748
-
749
-	/**
750
-	 * creates a unique name for internal ownCloud use.
751
-	 * @param string $name the display name of the object
752
-	 * @param boolean $isUser whether name should be created for a user (true) or a group (false)
753
-	 * @return string|false with with the name to use in ownCloud or false if unsuccessful
754
-	 */
755
-	private function createAltInternalOwnCloudName($name, $isUser) {
756
-		$originalTTL = $this->connection->ldapCacheTTL;
757
-		$this->connection->setConfiguration(array('ldapCacheTTL' => 0));
758
-		if($isUser) {
759
-			$altName = $this->_createAltInternalOwnCloudNameForUsers($name);
760
-		} else {
761
-			$altName = $this->_createAltInternalOwnCloudNameForGroups($name);
762
-		}
763
-		$this->connection->setConfiguration(array('ldapCacheTTL' => $originalTTL));
764
-
765
-		return $altName;
766
-	}
767
-
768
-	/**
769
-	 * fetches a list of users according to a provided loginName and utilizing
770
-	 * the login filter.
771
-	 *
772
-	 * @param string $loginName
773
-	 * @param array $attributes optional, list of attributes to read
774
-	 * @return array
775
-	 */
776
-	public function fetchUsersByLoginName($loginName, $attributes = array('dn')) {
777
-		$loginName = $this->escapeFilterPart($loginName);
778
-		$filter = str_replace('%uid', $loginName, $this->connection->ldapLoginFilter);
779
-		$users = $this->fetchListOfUsers($filter, $attributes);
780
-		return $users;
781
-	}
782
-
783
-	/**
784
-	 * counts the number of users according to a provided loginName and
785
-	 * utilizing the login filter.
786
-	 *
787
-	 * @param string $loginName
788
-	 * @return array
789
-	 */
790
-	public function countUsersByLoginName($loginName) {
791
-		$loginName = $this->escapeFilterPart($loginName);
792
-		$filter = str_replace('%uid', $loginName, $this->connection->ldapLoginFilter);
793
-		$users = $this->countUsers($filter);
794
-		return $users;
795
-	}
796
-
797
-	/**
798
-	 * @param string $filter
799
-	 * @param string|string[] $attr
800
-	 * @param int $limit
801
-	 * @param int $offset
802
-	 * @return array
803
-	 */
804
-	public function fetchListOfUsers($filter, $attr, $limit = null, $offset = null) {
805
-		$ldapRecords = $this->searchUsers($filter, $attr, $limit, $offset);
806
-		$this->batchApplyUserAttributes($ldapRecords);
807
-		return $this->fetchList($ldapRecords, (count($attr) > 1));
808
-	}
809
-
810
-	/**
811
-	 * provided with an array of LDAP user records the method will fetch the
812
-	 * user object and requests it to process the freshly fetched attributes and
813
-	 * and their values
814
-	 * @param array $ldapRecords
815
-	 */
816
-	public function batchApplyUserAttributes(array $ldapRecords){
817
-		$displayNameAttribute = strtolower($this->connection->ldapUserDisplayName);
818
-		foreach($ldapRecords as $userRecord) {
819
-			if(!isset($userRecord[$displayNameAttribute])) {
820
-				// displayName is obligatory
821
-				continue;
822
-			}
823
-			$ocName  = $this->dn2ocname($userRecord['dn'][0]);
824
-			if($ocName === false) {
825
-				continue;
826
-			}
827
-			$this->cacheUserExists($ocName);
828
-			$user = $this->userManager->get($ocName);
829
-			if($user instanceof OfflineUser) {
830
-				$user->unmark();
831
-				$user = $this->userManager->get($ocName);
832
-			}
833
-			if ($user !== null) {
834
-				$user->processAttributes($userRecord);
835
-			} else {
836
-				\OC::$server->getLogger()->debug(
837
-					"The ldap user manager returned null for $ocName",
838
-					['app'=>'user_ldap']
839
-				);
840
-			}
841
-		}
842
-	}
843
-
844
-	/**
845
-	 * @param string $filter
846
-	 * @param string|string[] $attr
847
-	 * @param int $limit
848
-	 * @param int $offset
849
-	 * @return array
850
-	 */
851
-	public function fetchListOfGroups($filter, $attr, $limit = null, $offset = null) {
852
-		return $this->fetchList($this->searchGroups($filter, $attr, $limit, $offset), (count($attr) > 1));
853
-	}
854
-
855
-	/**
856
-	 * @param array $list
857
-	 * @param bool $manyAttributes
858
-	 * @return array
859
-	 */
860
-	private function fetchList($list, $manyAttributes) {
861
-		if(is_array($list)) {
862
-			if($manyAttributes) {
863
-				return $list;
864
-			} else {
865
-				$list = array_reduce($list, function($carry, $item) {
866
-					$attribute = array_keys($item)[0];
867
-					$carry[] = $item[$attribute][0];
868
-					return $carry;
869
-				}, array());
870
-				return array_unique($list, SORT_LOCALE_STRING);
871
-			}
872
-		}
873
-
874
-		//error cause actually, maybe throw an exception in future.
875
-		return array();
876
-	}
877
-
878
-	/**
879
-	 * executes an LDAP search, optimized for Users
880
-	 * @param string $filter the LDAP filter for the search
881
-	 * @param string|string[] $attr optional, when a certain attribute shall be filtered out
882
-	 * @param integer $limit
883
-	 * @param integer $offset
884
-	 * @return array with the search result
885
-	 *
886
-	 * Executes an LDAP search
887
-	 */
888
-	public function searchUsers($filter, $attr = null, $limit = null, $offset = null) {
889
-		return $this->search($filter, $this->connection->ldapBaseUsers, $attr, $limit, $offset);
890
-	}
891
-
892
-	/**
893
-	 * @param string $filter
894
-	 * @param string|string[] $attr
895
-	 * @param int $limit
896
-	 * @param int $offset
897
-	 * @return false|int
898
-	 */
899
-	public function countUsers($filter, $attr = array('dn'), $limit = null, $offset = null) {
900
-		return $this->count($filter, $this->connection->ldapBaseUsers, $attr, $limit, $offset);
901
-	}
902
-
903
-	/**
904
-	 * executes an LDAP search, optimized for Groups
905
-	 * @param string $filter the LDAP filter for the search
906
-	 * @param string|string[] $attr optional, when a certain attribute shall be filtered out
907
-	 * @param integer $limit
908
-	 * @param integer $offset
909
-	 * @return array with the search result
910
-	 *
911
-	 * Executes an LDAP search
912
-	 */
913
-	public function searchGroups($filter, $attr = null, $limit = null, $offset = null) {
914
-		return $this->search($filter, $this->connection->ldapBaseGroups, $attr, $limit, $offset);
915
-	}
916
-
917
-	/**
918
-	 * returns the number of available groups
919
-	 * @param string $filter the LDAP search filter
920
-	 * @param string[] $attr optional
921
-	 * @param int|null $limit
922
-	 * @param int|null $offset
923
-	 * @return int|bool
924
-	 */
925
-	public function countGroups($filter, $attr = array('dn'), $limit = null, $offset = null) {
926
-		return $this->count($filter, $this->connection->ldapBaseGroups, $attr, $limit, $offset);
927
-	}
928
-
929
-	/**
930
-	 * returns the number of available objects on the base DN
931
-	 *
932
-	 * @param int|null $limit
933
-	 * @param int|null $offset
934
-	 * @return int|bool
935
-	 */
936
-	public function countObjects($limit = null, $offset = null) {
937
-		return $this->count('objectclass=*', $this->connection->ldapBase, array('dn'), $limit, $offset);
938
-	}
939
-
940
-	/**
941
-	 * retrieved. Results will according to the order in the array.
942
-	 * @param int $limit optional, maximum results to be counted
943
-	 * @param int $offset optional, a starting point
944
-	 * @return array|false array with the search result as first value and pagedSearchOK as
945
-	 * second | false if not successful
946
-	 */
947
-	private function executeSearch($filter, $base, &$attr = null, $limit = null, $offset = null) {
948
-		if(!is_null($attr) && !is_array($attr)) {
949
-			$attr = array(mb_strtolower($attr, 'UTF-8'));
950
-		}
951
-
952
-		// See if we have a resource, in case not cancel with message
953
-		$cr = $this->connection->getConnectionResource();
954
-		if(!$this->ldap->isResource($cr)) {
955
-			// Seems like we didn't find any resource.
956
-			// Return an empty array just like before.
957
-			\OCP\Util::writeLog('user_ldap', 'Could not search, because resource is missing.', \OCP\Util::DEBUG);
958
-			return false;
959
-		}
960
-
961
-		//check whether paged search should be attempted
962
-		$pagedSearchOK = $this->initPagedSearch($filter, $base, $attr, intval($limit), $offset);
963
-
964
-		$linkResources = array_pad(array(), count($base), $cr);
965
-		$sr = $this->ldap->search($linkResources, $base, $filter, $attr);
966
-		$error = $this->ldap->errno($cr);
967
-		if(!is_array($sr) || $error !== 0) {
968
-			\OCP\Util::writeLog('user_ldap', 'Attempt for Paging?  '.print_r($pagedSearchOK, true), \OCP\Util::ERROR);
969
-			return false;
970
-		}
971
-
972
-		return array($sr, $pagedSearchOK);
973
-	}
974
-
975
-	/**
976
-	 * processes an LDAP paged search operation
977
-	 * @param array $sr the array containing the LDAP search resources
978
-	 * @param string $filter the LDAP filter for the search
979
-	 * @param array $base an array containing the LDAP subtree(s) that shall be searched
980
-	 * @param int $iFoundItems number of results in the search operation
981
-	 * @param int $limit maximum results to be counted
982
-	 * @param int $offset a starting point
983
-	 * @param bool $pagedSearchOK whether a paged search has been executed
984
-	 * @param bool $skipHandling required for paged search when cookies to
985
-	 * prior results need to be gained
986
-	 * @return bool cookie validity, true if we have more pages, false otherwise.
987
-	 */
988
-	private function processPagedSearchStatus($sr, $filter, $base, $iFoundItems, $limit, $offset, $pagedSearchOK, $skipHandling) {
989
-		$cookie = null;
990
-		if($pagedSearchOK) {
991
-			$cr = $this->connection->getConnectionResource();
992
-			foreach($sr as $key => $res) {
993
-				if($this->ldap->controlPagedResultResponse($cr, $res, $cookie)) {
994
-					$this->setPagedResultCookie($base[$key], $filter, $limit, $offset, $cookie);
995
-				}
996
-			}
997
-
998
-			//browsing through prior pages to get the cookie for the new one
999
-			if($skipHandling) {
1000
-				return false;
1001
-			}
1002
-			// if count is bigger, then the server does not support
1003
-			// paged search. Instead, he did a normal search. We set a
1004
-			// flag here, so the callee knows how to deal with it.
1005
-			if($iFoundItems <= $limit) {
1006
-				$this->pagedSearchedSuccessful = true;
1007
-			}
1008
-		} else {
1009
-			if(!is_null($limit)) {
1010
-				\OCP\Util::writeLog('user_ldap', 'Paged search was not available', \OCP\Util::INFO);
1011
-			}
1012
-		}
1013
-		/* ++ Fixing RHDS searches with pages with zero results ++
347
+        try {
348
+            return $this->ldap->modReplace($cr, $userDN, $password);
349
+        } catch(ConstraintViolationException $e) {
350
+            throw new HintException('Password change rejected.', \OC::$server->getL10N('user_ldap')->t('Password change rejected. Hint: ').$e->getMessage(), $e->getCode());
351
+        }
352
+    }
353
+
354
+    /**
355
+     * checks whether the given attributes value is probably a DN
356
+     * @param string $attr the attribute in question
357
+     * @return boolean if so true, otherwise false
358
+     */
359
+    private function resemblesDN($attr) {
360
+        $resemblingAttributes = array(
361
+            'dn',
362
+            'uniquemember',
363
+            'member',
364
+            // memberOf is an "operational" attribute, without a definition in any RFC
365
+            'memberof'
366
+        );
367
+        return in_array($attr, $resemblingAttributes);
368
+    }
369
+
370
+    /**
371
+     * checks whether the given string is probably a DN
372
+     * @param string $string
373
+     * @return boolean
374
+     */
375
+    public function stringResemblesDN($string) {
376
+        $r = $this->ldap->explodeDN($string, 0);
377
+        // if exploding a DN succeeds and does not end up in
378
+        // an empty array except for $r[count] being 0.
379
+        return (is_array($r) && count($r) > 1);
380
+    }
381
+
382
+    /**
383
+     * returns a DN-string that is cleaned from not domain parts, e.g.
384
+     * cn=foo,cn=bar,dc=foobar,dc=server,dc=org
385
+     * becomes dc=foobar,dc=server,dc=org
386
+     * @param string $dn
387
+     * @return string
388
+     */
389
+    public function getDomainDNFromDN($dn) {
390
+        $allParts = $this->ldap->explodeDN($dn, 0);
391
+        if($allParts === false) {
392
+            //not a valid DN
393
+            return '';
394
+        }
395
+        $domainParts = array();
396
+        $dcFound = false;
397
+        foreach($allParts as $part) {
398
+            if(!$dcFound && strpos($part, 'dc=') === 0) {
399
+                $dcFound = true;
400
+            }
401
+            if($dcFound) {
402
+                $domainParts[] = $part;
403
+            }
404
+        }
405
+        $domainDN = implode(',', $domainParts);
406
+        return $domainDN;
407
+    }
408
+
409
+    /**
410
+     * returns the LDAP DN for the given internal ownCloud name of the group
411
+     * @param string $name the ownCloud name in question
412
+     * @return string|false LDAP DN on success, otherwise false
413
+     */
414
+    public function groupname2dn($name) {
415
+        return $this->groupMapper->getDNByName($name);
416
+    }
417
+
418
+    /**
419
+     * returns the LDAP DN for the given internal ownCloud name of the user
420
+     * @param string $name the ownCloud name in question
421
+     * @return string|false with the LDAP DN on success, otherwise false
422
+     */
423
+    public function username2dn($name) {
424
+        $fdn = $this->userMapper->getDNByName($name);
425
+
426
+        //Check whether the DN belongs to the Base, to avoid issues on multi-
427
+        //server setups
428
+        if(is_string($fdn) && $this->isDNPartOfBase($fdn, $this->connection->ldapBaseUsers)) {
429
+            return $fdn;
430
+        }
431
+
432
+        return false;
433
+    }
434
+
435
+    /**
436
+     * returns the internal ownCloud name for the given LDAP DN of the group, false on DN outside of search DN or failure
437
+     * @param string $fdn the dn of the group object
438
+     * @param string $ldapName optional, the display name of the object
439
+     * @return string|false with the name to use in ownCloud, false on DN outside of search DN
440
+     */
441
+    public function dn2groupname($fdn, $ldapName = null) {
442
+        //To avoid bypassing the base DN settings under certain circumstances
443
+        //with the group support, check whether the provided DN matches one of
444
+        //the given Bases
445
+        if(!$this->isDNPartOfBase($fdn, $this->connection->ldapBaseGroups)) {
446
+            return false;
447
+        }
448
+
449
+        return $this->dn2ocname($fdn, $ldapName, false);
450
+    }
451
+
452
+    /**
453
+     * accepts an array of group DNs and tests whether they match the user
454
+     * filter by doing read operations against the group entries. Returns an
455
+     * array of DNs that match the filter.
456
+     *
457
+     * @param string[] $groupDNs
458
+     * @return string[]
459
+     */
460
+    public function groupsMatchFilter($groupDNs) {
461
+        $validGroupDNs = [];
462
+        foreach($groupDNs as $dn) {
463
+            $cacheKey = 'groupsMatchFilter-'.$dn;
464
+            $groupMatchFilter = $this->connection->getFromCache($cacheKey);
465
+            if(!is_null($groupMatchFilter)) {
466
+                if($groupMatchFilter) {
467
+                    $validGroupDNs[] = $dn;
468
+                }
469
+                continue;
470
+            }
471
+
472
+            // Check the base DN first. If this is not met already, we don't
473
+            // need to ask the server at all.
474
+            if(!$this->isDNPartOfBase($dn, $this->connection->ldapBaseGroups)) {
475
+                $this->connection->writeToCache($cacheKey, false);
476
+                continue;
477
+            }
478
+
479
+            $result = $this->readAttribute($dn, 'cn', $this->connection->ldapGroupFilter);
480
+            if(is_array($result)) {
481
+                $this->connection->writeToCache($cacheKey, true);
482
+                $validGroupDNs[] = $dn;
483
+            } else {
484
+                $this->connection->writeToCache($cacheKey, false);
485
+            }
486
+
487
+        }
488
+        return $validGroupDNs;
489
+    }
490
+
491
+    /**
492
+     * returns the internal ownCloud name for the given LDAP DN of the user, false on DN outside of search DN or failure
493
+     * @param string $dn the dn of the user object
494
+     * @param string $ldapName optional, the display name of the object
495
+     * @return string|false with with the name to use in ownCloud
496
+     */
497
+    public function dn2username($fdn, $ldapName = null) {
498
+        //To avoid bypassing the base DN settings under certain circumstances
499
+        //with the group support, check whether the provided DN matches one of
500
+        //the given Bases
501
+        if(!$this->isDNPartOfBase($fdn, $this->connection->ldapBaseUsers)) {
502
+            return false;
503
+        }
504
+
505
+        return $this->dn2ocname($fdn, $ldapName, true);
506
+    }
507
+
508
+    /**
509
+     * returns an internal ownCloud name for the given LDAP DN, false on DN outside of search DN
510
+     * @param string $dn the dn of the user object
511
+     * @param string $ldapName optional, the display name of the object
512
+     * @param bool $isUser optional, whether it is a user object (otherwise group assumed)
513
+     * @return string|false with with the name to use in ownCloud
514
+     */
515
+    public function dn2ocname($fdn, $ldapName = null, $isUser = true) {
516
+        if($isUser) {
517
+            $mapper = $this->getUserMapper();
518
+            $nameAttribute = $this->connection->ldapUserDisplayName;
519
+        } else {
520
+            $mapper = $this->getGroupMapper();
521
+            $nameAttribute = $this->connection->ldapGroupDisplayName;
522
+        }
523
+
524
+        //let's try to retrieve the ownCloud name from the mappings table
525
+        $ocName = $mapper->getNameByDN($fdn);
526
+        if(is_string($ocName)) {
527
+            return $ocName;
528
+        }
529
+
530
+        //second try: get the UUID and check if it is known. Then, update the DN and return the name.
531
+        $uuid = $this->getUUID($fdn, $isUser);
532
+        if(is_string($uuid)) {
533
+            $ocName = $mapper->getNameByUUID($uuid);
534
+            if(is_string($ocName)) {
535
+                $mapper->setDNbyUUID($fdn, $uuid);
536
+                return $ocName;
537
+            }
538
+        } else {
539
+            //If the UUID can't be detected something is foul.
540
+            \OCP\Util::writeLog('user_ldap', 'Cannot determine UUID for '.$fdn.'. Skipping.', \OCP\Util::INFO);
541
+            return false;
542
+        }
543
+
544
+        if(is_null($ldapName)) {
545
+            $ldapName = $this->readAttribute($fdn, $nameAttribute);
546
+            if(!isset($ldapName[0]) && empty($ldapName[0])) {
547
+                \OCP\Util::writeLog('user_ldap', 'No or empty name for '.$fdn.'.', \OCP\Util::INFO);
548
+                return false;
549
+            }
550
+            $ldapName = $ldapName[0];
551
+        }
552
+
553
+        if($isUser) {
554
+            $usernameAttribute = strval($this->connection->ldapExpertUsernameAttr);
555
+            if ($usernameAttribute !== '') {
556
+                $username = $this->readAttribute($fdn, $usernameAttribute);
557
+                $username = $username[0];
558
+            } else {
559
+                $username = $uuid;
560
+            }
561
+            $intName = $this->sanitizeUsername($username);
562
+        } else {
563
+            $intName = $ldapName;
564
+        }
565
+
566
+        //a new user/group! Add it only if it doesn't conflict with other backend's users or existing groups
567
+        //disabling Cache is required to avoid that the new user is cached as not-existing in fooExists check
568
+        //NOTE: mind, disabling cache affects only this instance! Using it
569
+        // outside of core user management will still cache the user as non-existing.
570
+        $originalTTL = $this->connection->ldapCacheTTL;
571
+        $this->connection->setConfiguration(array('ldapCacheTTL' => 0));
572
+        if(($isUser && !\OCP\User::userExists($intName))
573
+            || (!$isUser && !\OC_Group::groupExists($intName))) {
574
+            if($mapper->map($fdn, $intName, $uuid)) {
575
+                $this->connection->setConfiguration(array('ldapCacheTTL' => $originalTTL));
576
+                return $intName;
577
+            }
578
+        }
579
+        $this->connection->setConfiguration(array('ldapCacheTTL' => $originalTTL));
580
+
581
+        $altName = $this->createAltInternalOwnCloudName($intName, $isUser);
582
+        if(is_string($altName) && $mapper->map($fdn, $altName, $uuid)) {
583
+            return $altName;
584
+        }
585
+
586
+        //if everything else did not help..
587
+        \OCP\Util::writeLog('user_ldap', 'Could not create unique name for '.$fdn.'.', \OCP\Util::INFO);
588
+        return false;
589
+    }
590
+
591
+    /**
592
+     * gives back the user names as they are used ownClod internally
593
+     * @param array $ldapUsers as returned by fetchList()
594
+     * @return array an array with the user names to use in ownCloud
595
+     *
596
+     * gives back the user names as they are used ownClod internally
597
+     */
598
+    public function ownCloudUserNames($ldapUsers) {
599
+        return $this->ldap2ownCloudNames($ldapUsers, true);
600
+    }
601
+
602
+    /**
603
+     * gives back the group names as they are used ownClod internally
604
+     * @param array $ldapGroups as returned by fetchList()
605
+     * @return array an array with the group names to use in ownCloud
606
+     *
607
+     * gives back the group names as they are used ownClod internally
608
+     */
609
+    public function ownCloudGroupNames($ldapGroups) {
610
+        return $this->ldap2ownCloudNames($ldapGroups, false);
611
+    }
612
+
613
+    /**
614
+     * @param array $ldapObjects as returned by fetchList()
615
+     * @param bool $isUsers
616
+     * @return array
617
+     */
618
+    private function ldap2ownCloudNames($ldapObjects, $isUsers) {
619
+        if($isUsers) {
620
+            $nameAttribute = $this->connection->ldapUserDisplayName;
621
+            $sndAttribute  = $this->connection->ldapUserDisplayName2;
622
+        } else {
623
+            $nameAttribute = $this->connection->ldapGroupDisplayName;
624
+        }
625
+        $ownCloudNames = array();
626
+
627
+        foreach($ldapObjects as $ldapObject) {
628
+            $nameByLDAP = null;
629
+            if(    isset($ldapObject[$nameAttribute])
630
+                && is_array($ldapObject[$nameAttribute])
631
+                && isset($ldapObject[$nameAttribute][0])
632
+            ) {
633
+                // might be set, but not necessarily. if so, we use it.
634
+                $nameByLDAP = $ldapObject[$nameAttribute][0];
635
+            }
636
+
637
+            $ocName = $this->dn2ocname($ldapObject['dn'][0], $nameByLDAP, $isUsers);
638
+            if($ocName) {
639
+                $ownCloudNames[] = $ocName;
640
+                if($isUsers) {
641
+                    //cache the user names so it does not need to be retrieved
642
+                    //again later (e.g. sharing dialogue).
643
+                    if(is_null($nameByLDAP)) {
644
+                        continue;
645
+                    }
646
+                    $sndName = isset($ldapObject[$sndAttribute][0])
647
+                        ? $ldapObject[$sndAttribute][0] : '';
648
+                    $this->cacheUserDisplayName($ocName, $nameByLDAP, $sndName);
649
+                }
650
+            }
651
+        }
652
+        return $ownCloudNames;
653
+    }
654
+
655
+    /**
656
+     * caches the user display name
657
+     * @param string $ocName the internal ownCloud username
658
+     * @param string|false $home the home directory path
659
+     */
660
+    public function cacheUserHome($ocName, $home) {
661
+        $cacheKey = 'getHome'.$ocName;
662
+        $this->connection->writeToCache($cacheKey, $home);
663
+    }
664
+
665
+    /**
666
+     * caches a user as existing
667
+     * @param string $ocName the internal ownCloud username
668
+     */
669
+    public function cacheUserExists($ocName) {
670
+        $this->connection->writeToCache('userExists'.$ocName, true);
671
+    }
672
+
673
+    /**
674
+     * caches the user display name
675
+     * @param string $ocName the internal ownCloud username
676
+     * @param string $displayName the display name
677
+     * @param string $displayName2 the second display name
678
+     */
679
+    public function cacheUserDisplayName($ocName, $displayName, $displayName2 = '') {
680
+        $user = $this->userManager->get($ocName);
681
+        if($user === null) {
682
+            return;
683
+        }
684
+        $displayName = $user->composeAndStoreDisplayName($displayName, $displayName2);
685
+        $cacheKeyTrunk = 'getDisplayName';
686
+        $this->connection->writeToCache($cacheKeyTrunk.$ocName, $displayName);
687
+    }
688
+
689
+    /**
690
+     * creates a unique name for internal ownCloud use for users. Don't call it directly.
691
+     * @param string $name the display name of the object
692
+     * @return string|false with with the name to use in ownCloud or false if unsuccessful
693
+     *
694
+     * Instead of using this method directly, call
695
+     * createAltInternalOwnCloudName($name, true)
696
+     */
697
+    private function _createAltInternalOwnCloudNameForUsers($name) {
698
+        $attempts = 0;
699
+        //while loop is just a precaution. If a name is not generated within
700
+        //20 attempts, something else is very wrong. Avoids infinite loop.
701
+        while($attempts < 20){
702
+            $altName = $name . '_' . rand(1000,9999);
703
+            if(!\OCP\User::userExists($altName)) {
704
+                return $altName;
705
+            }
706
+            $attempts++;
707
+        }
708
+        return false;
709
+    }
710
+
711
+    /**
712
+     * creates a unique name for internal ownCloud use for groups. Don't call it directly.
713
+     * @param string $name the display name of the object
714
+     * @return string|false with with the name to use in ownCloud or false if unsuccessful.
715
+     *
716
+     * Instead of using this method directly, call
717
+     * createAltInternalOwnCloudName($name, false)
718
+     *
719
+     * Group names are also used as display names, so we do a sequential
720
+     * numbering, e.g. Developers_42 when there are 41 other groups called
721
+     * "Developers"
722
+     */
723
+    private function _createAltInternalOwnCloudNameForGroups($name) {
724
+        $usedNames = $this->groupMapper->getNamesBySearch($name, "", '_%');
725
+        if(!($usedNames) || count($usedNames) === 0) {
726
+            $lastNo = 1; //will become name_2
727
+        } else {
728
+            natsort($usedNames);
729
+            $lastName = array_pop($usedNames);
730
+            $lastNo = intval(substr($lastName, strrpos($lastName, '_') + 1));
731
+        }
732
+        $altName = $name.'_'.strval($lastNo+1);
733
+        unset($usedNames);
734
+
735
+        $attempts = 1;
736
+        while($attempts < 21){
737
+            // Check to be really sure it is unique
738
+            // while loop is just a precaution. If a name is not generated within
739
+            // 20 attempts, something else is very wrong. Avoids infinite loop.
740
+            if(!\OC_Group::groupExists($altName)) {
741
+                return $altName;
742
+            }
743
+            $altName = $name . '_' . ($lastNo + $attempts);
744
+            $attempts++;
745
+        }
746
+        return false;
747
+    }
748
+
749
+    /**
750
+     * creates a unique name for internal ownCloud use.
751
+     * @param string $name the display name of the object
752
+     * @param boolean $isUser whether name should be created for a user (true) or a group (false)
753
+     * @return string|false with with the name to use in ownCloud or false if unsuccessful
754
+     */
755
+    private function createAltInternalOwnCloudName($name, $isUser) {
756
+        $originalTTL = $this->connection->ldapCacheTTL;
757
+        $this->connection->setConfiguration(array('ldapCacheTTL' => 0));
758
+        if($isUser) {
759
+            $altName = $this->_createAltInternalOwnCloudNameForUsers($name);
760
+        } else {
761
+            $altName = $this->_createAltInternalOwnCloudNameForGroups($name);
762
+        }
763
+        $this->connection->setConfiguration(array('ldapCacheTTL' => $originalTTL));
764
+
765
+        return $altName;
766
+    }
767
+
768
+    /**
769
+     * fetches a list of users according to a provided loginName and utilizing
770
+     * the login filter.
771
+     *
772
+     * @param string $loginName
773
+     * @param array $attributes optional, list of attributes to read
774
+     * @return array
775
+     */
776
+    public function fetchUsersByLoginName($loginName, $attributes = array('dn')) {
777
+        $loginName = $this->escapeFilterPart($loginName);
778
+        $filter = str_replace('%uid', $loginName, $this->connection->ldapLoginFilter);
779
+        $users = $this->fetchListOfUsers($filter, $attributes);
780
+        return $users;
781
+    }
782
+
783
+    /**
784
+     * counts the number of users according to a provided loginName and
785
+     * utilizing the login filter.
786
+     *
787
+     * @param string $loginName
788
+     * @return array
789
+     */
790
+    public function countUsersByLoginName($loginName) {
791
+        $loginName = $this->escapeFilterPart($loginName);
792
+        $filter = str_replace('%uid', $loginName, $this->connection->ldapLoginFilter);
793
+        $users = $this->countUsers($filter);
794
+        return $users;
795
+    }
796
+
797
+    /**
798
+     * @param string $filter
799
+     * @param string|string[] $attr
800
+     * @param int $limit
801
+     * @param int $offset
802
+     * @return array
803
+     */
804
+    public function fetchListOfUsers($filter, $attr, $limit = null, $offset = null) {
805
+        $ldapRecords = $this->searchUsers($filter, $attr, $limit, $offset);
806
+        $this->batchApplyUserAttributes($ldapRecords);
807
+        return $this->fetchList($ldapRecords, (count($attr) > 1));
808
+    }
809
+
810
+    /**
811
+     * provided with an array of LDAP user records the method will fetch the
812
+     * user object and requests it to process the freshly fetched attributes and
813
+     * and their values
814
+     * @param array $ldapRecords
815
+     */
816
+    public function batchApplyUserAttributes(array $ldapRecords){
817
+        $displayNameAttribute = strtolower($this->connection->ldapUserDisplayName);
818
+        foreach($ldapRecords as $userRecord) {
819
+            if(!isset($userRecord[$displayNameAttribute])) {
820
+                // displayName is obligatory
821
+                continue;
822
+            }
823
+            $ocName  = $this->dn2ocname($userRecord['dn'][0]);
824
+            if($ocName === false) {
825
+                continue;
826
+            }
827
+            $this->cacheUserExists($ocName);
828
+            $user = $this->userManager->get($ocName);
829
+            if($user instanceof OfflineUser) {
830
+                $user->unmark();
831
+                $user = $this->userManager->get($ocName);
832
+            }
833
+            if ($user !== null) {
834
+                $user->processAttributes($userRecord);
835
+            } else {
836
+                \OC::$server->getLogger()->debug(
837
+                    "The ldap user manager returned null for $ocName",
838
+                    ['app'=>'user_ldap']
839
+                );
840
+            }
841
+        }
842
+    }
843
+
844
+    /**
845
+     * @param string $filter
846
+     * @param string|string[] $attr
847
+     * @param int $limit
848
+     * @param int $offset
849
+     * @return array
850
+     */
851
+    public function fetchListOfGroups($filter, $attr, $limit = null, $offset = null) {
852
+        return $this->fetchList($this->searchGroups($filter, $attr, $limit, $offset), (count($attr) > 1));
853
+    }
854
+
855
+    /**
856
+     * @param array $list
857
+     * @param bool $manyAttributes
858
+     * @return array
859
+     */
860
+    private function fetchList($list, $manyAttributes) {
861
+        if(is_array($list)) {
862
+            if($manyAttributes) {
863
+                return $list;
864
+            } else {
865
+                $list = array_reduce($list, function($carry, $item) {
866
+                    $attribute = array_keys($item)[0];
867
+                    $carry[] = $item[$attribute][0];
868
+                    return $carry;
869
+                }, array());
870
+                return array_unique($list, SORT_LOCALE_STRING);
871
+            }
872
+        }
873
+
874
+        //error cause actually, maybe throw an exception in future.
875
+        return array();
876
+    }
877
+
878
+    /**
879
+     * executes an LDAP search, optimized for Users
880
+     * @param string $filter the LDAP filter for the search
881
+     * @param string|string[] $attr optional, when a certain attribute shall be filtered out
882
+     * @param integer $limit
883
+     * @param integer $offset
884
+     * @return array with the search result
885
+     *
886
+     * Executes an LDAP search
887
+     */
888
+    public function searchUsers($filter, $attr = null, $limit = null, $offset = null) {
889
+        return $this->search($filter, $this->connection->ldapBaseUsers, $attr, $limit, $offset);
890
+    }
891
+
892
+    /**
893
+     * @param string $filter
894
+     * @param string|string[] $attr
895
+     * @param int $limit
896
+     * @param int $offset
897
+     * @return false|int
898
+     */
899
+    public function countUsers($filter, $attr = array('dn'), $limit = null, $offset = null) {
900
+        return $this->count($filter, $this->connection->ldapBaseUsers, $attr, $limit, $offset);
901
+    }
902
+
903
+    /**
904
+     * executes an LDAP search, optimized for Groups
905
+     * @param string $filter the LDAP filter for the search
906
+     * @param string|string[] $attr optional, when a certain attribute shall be filtered out
907
+     * @param integer $limit
908
+     * @param integer $offset
909
+     * @return array with the search result
910
+     *
911
+     * Executes an LDAP search
912
+     */
913
+    public function searchGroups($filter, $attr = null, $limit = null, $offset = null) {
914
+        return $this->search($filter, $this->connection->ldapBaseGroups, $attr, $limit, $offset);
915
+    }
916
+
917
+    /**
918
+     * returns the number of available groups
919
+     * @param string $filter the LDAP search filter
920
+     * @param string[] $attr optional
921
+     * @param int|null $limit
922
+     * @param int|null $offset
923
+     * @return int|bool
924
+     */
925
+    public function countGroups($filter, $attr = array('dn'), $limit = null, $offset = null) {
926
+        return $this->count($filter, $this->connection->ldapBaseGroups, $attr, $limit, $offset);
927
+    }
928
+
929
+    /**
930
+     * returns the number of available objects on the base DN
931
+     *
932
+     * @param int|null $limit
933
+     * @param int|null $offset
934
+     * @return int|bool
935
+     */
936
+    public function countObjects($limit = null, $offset = null) {
937
+        return $this->count('objectclass=*', $this->connection->ldapBase, array('dn'), $limit, $offset);
938
+    }
939
+
940
+    /**
941
+     * retrieved. Results will according to the order in the array.
942
+     * @param int $limit optional, maximum results to be counted
943
+     * @param int $offset optional, a starting point
944
+     * @return array|false array with the search result as first value and pagedSearchOK as
945
+     * second | false if not successful
946
+     */
947
+    private function executeSearch($filter, $base, &$attr = null, $limit = null, $offset = null) {
948
+        if(!is_null($attr) && !is_array($attr)) {
949
+            $attr = array(mb_strtolower($attr, 'UTF-8'));
950
+        }
951
+
952
+        // See if we have a resource, in case not cancel with message
953
+        $cr = $this->connection->getConnectionResource();
954
+        if(!$this->ldap->isResource($cr)) {
955
+            // Seems like we didn't find any resource.
956
+            // Return an empty array just like before.
957
+            \OCP\Util::writeLog('user_ldap', 'Could not search, because resource is missing.', \OCP\Util::DEBUG);
958
+            return false;
959
+        }
960
+
961
+        //check whether paged search should be attempted
962
+        $pagedSearchOK = $this->initPagedSearch($filter, $base, $attr, intval($limit), $offset);
963
+
964
+        $linkResources = array_pad(array(), count($base), $cr);
965
+        $sr = $this->ldap->search($linkResources, $base, $filter, $attr);
966
+        $error = $this->ldap->errno($cr);
967
+        if(!is_array($sr) || $error !== 0) {
968
+            \OCP\Util::writeLog('user_ldap', 'Attempt for Paging?  '.print_r($pagedSearchOK, true), \OCP\Util::ERROR);
969
+            return false;
970
+        }
971
+
972
+        return array($sr, $pagedSearchOK);
973
+    }
974
+
975
+    /**
976
+     * processes an LDAP paged search operation
977
+     * @param array $sr the array containing the LDAP search resources
978
+     * @param string $filter the LDAP filter for the search
979
+     * @param array $base an array containing the LDAP subtree(s) that shall be searched
980
+     * @param int $iFoundItems number of results in the search operation
981
+     * @param int $limit maximum results to be counted
982
+     * @param int $offset a starting point
983
+     * @param bool $pagedSearchOK whether a paged search has been executed
984
+     * @param bool $skipHandling required for paged search when cookies to
985
+     * prior results need to be gained
986
+     * @return bool cookie validity, true if we have more pages, false otherwise.
987
+     */
988
+    private function processPagedSearchStatus($sr, $filter, $base, $iFoundItems, $limit, $offset, $pagedSearchOK, $skipHandling) {
989
+        $cookie = null;
990
+        if($pagedSearchOK) {
991
+            $cr = $this->connection->getConnectionResource();
992
+            foreach($sr as $key => $res) {
993
+                if($this->ldap->controlPagedResultResponse($cr, $res, $cookie)) {
994
+                    $this->setPagedResultCookie($base[$key], $filter, $limit, $offset, $cookie);
995
+                }
996
+            }
997
+
998
+            //browsing through prior pages to get the cookie for the new one
999
+            if($skipHandling) {
1000
+                return false;
1001
+            }
1002
+            // if count is bigger, then the server does not support
1003
+            // paged search. Instead, he did a normal search. We set a
1004
+            // flag here, so the callee knows how to deal with it.
1005
+            if($iFoundItems <= $limit) {
1006
+                $this->pagedSearchedSuccessful = true;
1007
+            }
1008
+        } else {
1009
+            if(!is_null($limit)) {
1010
+                \OCP\Util::writeLog('user_ldap', 'Paged search was not available', \OCP\Util::INFO);
1011
+            }
1012
+        }
1013
+        /* ++ Fixing RHDS searches with pages with zero results ++
1014 1014
 		 * Return cookie status. If we don't have more pages, with RHDS
1015 1015
 		 * cookie is null, with openldap cookie is an empty string and
1016 1016
 		 * to 386ds '0' is a valid cookie. Even if $iFoundItems == 0
1017 1017
 		 */
1018
-		return !empty($cookie) || $cookie === '0';
1019
-	}
1020
-
1021
-	/**
1022
-	 * executes an LDAP search, but counts the results only
1023
-	 * @param string $filter the LDAP filter for the search
1024
-	 * @param array $base an array containing the LDAP subtree(s) that shall be searched
1025
-	 * @param string|string[] $attr optional, array, one or more attributes that shall be
1026
-	 * retrieved. Results will according to the order in the array.
1027
-	 * @param int $limit optional, maximum results to be counted
1028
-	 * @param int $offset optional, a starting point
1029
-	 * @param bool $skipHandling indicates whether the pages search operation is
1030
-	 * completed
1031
-	 * @return int|false Integer or false if the search could not be initialized
1032
-	 *
1033
-	 */
1034
-	private function count($filter, $base, $attr = null, $limit = null, $offset = null, $skipHandling = false) {
1035
-		\OCP\Util::writeLog('user_ldap', 'Count filter:  '.print_r($filter, true), \OCP\Util::DEBUG);
1036
-
1037
-		$limitPerPage = intval($this->connection->ldapPagingSize);
1038
-		if(!is_null($limit) && $limit < $limitPerPage && $limit > 0) {
1039
-			$limitPerPage = $limit;
1040
-		}
1041
-
1042
-		$counter = 0;
1043
-		$count = null;
1044
-		$this->connection->getConnectionResource();
1045
-
1046
-		do {
1047
-			$search = $this->executeSearch($filter, $base, $attr,
1048
-										   $limitPerPage, $offset);
1049
-			if($search === false) {
1050
-				return $counter > 0 ? $counter : false;
1051
-			}
1052
-			list($sr, $pagedSearchOK) = $search;
1053
-
1054
-			/* ++ Fixing RHDS searches with pages with zero results ++
1018
+        return !empty($cookie) || $cookie === '0';
1019
+    }
1020
+
1021
+    /**
1022
+     * executes an LDAP search, but counts the results only
1023
+     * @param string $filter the LDAP filter for the search
1024
+     * @param array $base an array containing the LDAP subtree(s) that shall be searched
1025
+     * @param string|string[] $attr optional, array, one or more attributes that shall be
1026
+     * retrieved. Results will according to the order in the array.
1027
+     * @param int $limit optional, maximum results to be counted
1028
+     * @param int $offset optional, a starting point
1029
+     * @param bool $skipHandling indicates whether the pages search operation is
1030
+     * completed
1031
+     * @return int|false Integer or false if the search could not be initialized
1032
+     *
1033
+     */
1034
+    private function count($filter, $base, $attr = null, $limit = null, $offset = null, $skipHandling = false) {
1035
+        \OCP\Util::writeLog('user_ldap', 'Count filter:  '.print_r($filter, true), \OCP\Util::DEBUG);
1036
+
1037
+        $limitPerPage = intval($this->connection->ldapPagingSize);
1038
+        if(!is_null($limit) && $limit < $limitPerPage && $limit > 0) {
1039
+            $limitPerPage = $limit;
1040
+        }
1041
+
1042
+        $counter = 0;
1043
+        $count = null;
1044
+        $this->connection->getConnectionResource();
1045
+
1046
+        do {
1047
+            $search = $this->executeSearch($filter, $base, $attr,
1048
+                                            $limitPerPage, $offset);
1049
+            if($search === false) {
1050
+                return $counter > 0 ? $counter : false;
1051
+            }
1052
+            list($sr, $pagedSearchOK) = $search;
1053
+
1054
+            /* ++ Fixing RHDS searches with pages with zero results ++
1055 1055
 			 * countEntriesInSearchResults() method signature changed
1056 1056
 			 * by removing $limit and &$hasHitLimit parameters
1057 1057
 			 */
1058
-			$count = $this->countEntriesInSearchResults($sr);
1059
-			$counter += $count;
1058
+            $count = $this->countEntriesInSearchResults($sr);
1059
+            $counter += $count;
1060 1060
 
1061
-			$hasMorePages = $this->processPagedSearchStatus($sr, $filter, $base, $count, $limitPerPage,
1062
-										$offset, $pagedSearchOK, $skipHandling);
1063
-			$offset += $limitPerPage;
1064
-			/* ++ Fixing RHDS searches with pages with zero results ++
1061
+            $hasMorePages = $this->processPagedSearchStatus($sr, $filter, $base, $count, $limitPerPage,
1062
+                                        $offset, $pagedSearchOK, $skipHandling);
1063
+            $offset += $limitPerPage;
1064
+            /* ++ Fixing RHDS searches with pages with zero results ++
1065 1065
 			 * Continue now depends on $hasMorePages value
1066 1066
 			 */
1067
-			$continue = $pagedSearchOK && $hasMorePages;
1068
-		} while($continue && (is_null($limit) || $limit <= 0 || $limit > $counter));
1069
-
1070
-		return $counter;
1071
-	}
1072
-
1073
-	/**
1074
-	 * @param array $searchResults
1075
-	 * @return int
1076
-	 */
1077
-	private function countEntriesInSearchResults($searchResults) {
1078
-		$cr = $this->connection->getConnectionResource();
1079
-		$counter = 0;
1080
-
1081
-		foreach($searchResults as $res) {
1082
-			$count = intval($this->ldap->countEntries($cr, $res));
1083
-			$counter += $count;
1084
-		}
1085
-
1086
-		return $counter;
1087
-	}
1088
-
1089
-	/**
1090
-	 * Executes an LDAP search
1091
-	 * @param string $filter the LDAP filter for the search
1092
-	 * @param array $base an array containing the LDAP subtree(s) that shall be searched
1093
-	 * @param string|string[] $attr optional, array, one or more attributes that shall be
1094
-	 * @param int $limit
1095
-	 * @param int $offset
1096
-	 * @param bool $skipHandling
1097
-	 * @return array with the search result
1098
-	 */
1099
-	private function search($filter, $base, $attr = null, $limit = null, $offset = null, $skipHandling = false) {
1100
-		if($limit <= 0) {
1101
-			//otherwise search will fail
1102
-			$limit = null;
1103
-		}
1104
-
1105
-		/* ++ Fixing RHDS searches with pages with zero results ++
1067
+            $continue = $pagedSearchOK && $hasMorePages;
1068
+        } while($continue && (is_null($limit) || $limit <= 0 || $limit > $counter));
1069
+
1070
+        return $counter;
1071
+    }
1072
+
1073
+    /**
1074
+     * @param array $searchResults
1075
+     * @return int
1076
+     */
1077
+    private function countEntriesInSearchResults($searchResults) {
1078
+        $cr = $this->connection->getConnectionResource();
1079
+        $counter = 0;
1080
+
1081
+        foreach($searchResults as $res) {
1082
+            $count = intval($this->ldap->countEntries($cr, $res));
1083
+            $counter += $count;
1084
+        }
1085
+
1086
+        return $counter;
1087
+    }
1088
+
1089
+    /**
1090
+     * Executes an LDAP search
1091
+     * @param string $filter the LDAP filter for the search
1092
+     * @param array $base an array containing the LDAP subtree(s) that shall be searched
1093
+     * @param string|string[] $attr optional, array, one or more attributes that shall be
1094
+     * @param int $limit
1095
+     * @param int $offset
1096
+     * @param bool $skipHandling
1097
+     * @return array with the search result
1098
+     */
1099
+    private function search($filter, $base, $attr = null, $limit = null, $offset = null, $skipHandling = false) {
1100
+        if($limit <= 0) {
1101
+            //otherwise search will fail
1102
+            $limit = null;
1103
+        }
1104
+
1105
+        /* ++ Fixing RHDS searches with pages with zero results ++
1106 1106
 		 * As we can have pages with zero results and/or pages with less
1107 1107
 		 * than $limit results but with a still valid server 'cookie',
1108 1108
 		 * loops through until we get $continue equals true and
1109 1109
 		 * $findings['count'] < $limit
1110 1110
 		 */
1111
-		$findings = array();
1112
-		$savedoffset = $offset;
1113
-		do {
1114
-			$search = $this->executeSearch($filter, $base, $attr, $limit, $offset);
1115
-			if($search === false) {
1116
-				return array();
1117
-			}
1118
-			list($sr, $pagedSearchOK) = $search;
1119
-			$cr = $this->connection->getConnectionResource();
1120
-
1121
-			if($skipHandling) {
1122
-				//i.e. result do not need to be fetched, we just need the cookie
1123
-				//thus pass 1 or any other value as $iFoundItems because it is not
1124
-				//used
1125
-				$this->processPagedSearchStatus($sr, $filter, $base, 1, $limit,
1126
-								$offset, $pagedSearchOK,
1127
-								$skipHandling);
1128
-				return array();
1129
-			}
1130
-
1131
-			foreach($sr as $res) {
1132
-				$findings = array_merge($findings, $this->ldap->getEntries($cr	, $res ));
1133
-			}
1134
-
1135
-			$continue = $this->processPagedSearchStatus($sr, $filter, $base, $findings['count'],
1136
-								$limit, $offset, $pagedSearchOK,
1137
-										$skipHandling);
1138
-			$offset += $limit;
1139
-		} while ($continue && $pagedSearchOK && $findings['count'] < $limit);
1140
-		// reseting offset
1141
-		$offset = $savedoffset;
1142
-
1143
-		// if we're here, probably no connection resource is returned.
1144
-		// to make ownCloud behave nicely, we simply give back an empty array.
1145
-		if(is_null($findings)) {
1146
-			return array();
1147
-		}
1148
-
1149
-		if(!is_null($attr)) {
1150
-			$selection = array();
1151
-			$i = 0;
1152
-			foreach($findings as $item) {
1153
-				if(!is_array($item)) {
1154
-					continue;
1155
-				}
1156
-				$item = \OCP\Util::mb_array_change_key_case($item, MB_CASE_LOWER, 'UTF-8');
1157
-				foreach($attr as $key) {
1158
-					$key = mb_strtolower($key, 'UTF-8');
1159
-					if(isset($item[$key])) {
1160
-						if(is_array($item[$key]) && isset($item[$key]['count'])) {
1161
-							unset($item[$key]['count']);
1162
-						}
1163
-						if($key !== 'dn') {
1164
-							$selection[$i][$key] = $this->resemblesDN($key) ?
1165
-								$this->helper->sanitizeDN($item[$key])
1166
-								: $item[$key];
1167
-						} else {
1168
-							$selection[$i][$key] = [$this->helper->sanitizeDN($item[$key])];
1169
-						}
1170
-					}
1171
-
1172
-				}
1173
-				$i++;
1174
-			}
1175
-			$findings = $selection;
1176
-		}
1177
-		//we slice the findings, when
1178
-		//a) paged search unsuccessful, though attempted
1179
-		//b) no paged search, but limit set
1180
-		if((!$this->getPagedSearchResultState()
1181
-			&& $pagedSearchOK)
1182
-			|| (
1183
-				!$pagedSearchOK
1184
-				&& !is_null($limit)
1185
-			)
1186
-		) {
1187
-			$findings = array_slice($findings, intval($offset), $limit);
1188
-		}
1189
-		return $findings;
1190
-	}
1191
-
1192
-	/**
1193
-	 * @param string $name
1194
-	 * @return bool|mixed|string
1195
-	 */
1196
-	public function sanitizeUsername($name) {
1197
-		if($this->connection->ldapIgnoreNamingRules) {
1198
-			return $name;
1199
-		}
1200
-
1201
-		// Transliteration
1202
-		// latin characters to ASCII
1203
-		$name = iconv('UTF-8', 'ASCII//TRANSLIT', $name);
1204
-
1205
-		// Replacements
1206
-		$name = str_replace(' ', '_', $name);
1207
-
1208
-		// Every remaining disallowed characters will be removed
1209
-		$name = preg_replace('/[^a-zA-Z0-9_.@-]/u', '', $name);
1210
-
1211
-		return $name;
1212
-	}
1213
-
1214
-	/**
1215
-	* escapes (user provided) parts for LDAP filter
1216
-	* @param string $input, the provided value
1217
-	* @param bool $allowAsterisk whether in * at the beginning should be preserved
1218
-	* @return string the escaped string
1219
-	*/
1220
-	public function escapeFilterPart($input, $allowAsterisk = false) {
1221
-		$asterisk = '';
1222
-		if($allowAsterisk && strlen($input) > 0 && $input[0] === '*') {
1223
-			$asterisk = '*';
1224
-			$input = mb_substr($input, 1, null, 'UTF-8');
1225
-		}
1226
-		$search  = array('*', '\\', '(', ')');
1227
-		$replace = array('\\*', '\\\\', '\\(', '\\)');
1228
-		return $asterisk . str_replace($search, $replace, $input);
1229
-	}
1230
-
1231
-	/**
1232
-	 * combines the input filters with AND
1233
-	 * @param string[] $filters the filters to connect
1234
-	 * @return string the combined filter
1235
-	 */
1236
-	public function combineFilterWithAnd($filters) {
1237
-		return $this->combineFilter($filters, '&');
1238
-	}
1239
-
1240
-	/**
1241
-	 * combines the input filters with OR
1242
-	 * @param string[] $filters the filters to connect
1243
-	 * @return string the combined filter
1244
-	 * Combines Filter arguments with OR
1245
-	 */
1246
-	public function combineFilterWithOr($filters) {
1247
-		return $this->combineFilter($filters, '|');
1248
-	}
1249
-
1250
-	/**
1251
-	 * combines the input filters with given operator
1252
-	 * @param string[] $filters the filters to connect
1253
-	 * @param string $operator either & or |
1254
-	 * @return string the combined filter
1255
-	 */
1256
-	private function combineFilter($filters, $operator) {
1257
-		$combinedFilter = '('.$operator;
1258
-		foreach($filters as $filter) {
1259
-			if ($filter !== '' && $filter[0] !== '(') {
1260
-				$filter = '('.$filter.')';
1261
-			}
1262
-			$combinedFilter.=$filter;
1263
-		}
1264
-		$combinedFilter.=')';
1265
-		return $combinedFilter;
1266
-	}
1267
-
1268
-	/**
1269
-	 * creates a filter part for to perform search for users
1270
-	 * @param string $search the search term
1271
-	 * @return string the final filter part to use in LDAP searches
1272
-	 */
1273
-	public function getFilterPartForUserSearch($search) {
1274
-		return $this->getFilterPartForSearch($search,
1275
-			$this->connection->ldapAttributesForUserSearch,
1276
-			$this->connection->ldapUserDisplayName);
1277
-	}
1278
-
1279
-	/**
1280
-	 * creates a filter part for to perform search for groups
1281
-	 * @param string $search the search term
1282
-	 * @return string the final filter part to use in LDAP searches
1283
-	 */
1284
-	public function getFilterPartForGroupSearch($search) {
1285
-		return $this->getFilterPartForSearch($search,
1286
-			$this->connection->ldapAttributesForGroupSearch,
1287
-			$this->connection->ldapGroupDisplayName);
1288
-	}
1289
-
1290
-	/**
1291
-	 * creates a filter part for searches by splitting up the given search
1292
-	 * string into single words
1293
-	 * @param string $search the search term
1294
-	 * @param string[] $searchAttributes needs to have at least two attributes,
1295
-	 * otherwise it does not make sense :)
1296
-	 * @return string the final filter part to use in LDAP searches
1297
-	 * @throws \Exception
1298
-	 */
1299
-	private function getAdvancedFilterPartForSearch($search, $searchAttributes) {
1300
-		if(!is_array($searchAttributes) || count($searchAttributes) < 2) {
1301
-			throw new \Exception('searchAttributes must be an array with at least two string');
1302
-		}
1303
-		$searchWords = explode(' ', trim($search));
1304
-		$wordFilters = array();
1305
-		foreach($searchWords as $word) {
1306
-			$word = $this->prepareSearchTerm($word);
1307
-			//every word needs to appear at least once
1308
-			$wordMatchOneAttrFilters = array();
1309
-			foreach($searchAttributes as $attr) {
1310
-				$wordMatchOneAttrFilters[] = $attr . '=' . $word;
1311
-			}
1312
-			$wordFilters[] = $this->combineFilterWithOr($wordMatchOneAttrFilters);
1313
-		}
1314
-		return $this->combineFilterWithAnd($wordFilters);
1315
-	}
1316
-
1317
-	/**
1318
-	 * creates a filter part for searches
1319
-	 * @param string $search the search term
1320
-	 * @param string[]|null $searchAttributes
1321
-	 * @param string $fallbackAttribute a fallback attribute in case the user
1322
-	 * did not define search attributes. Typically the display name attribute.
1323
-	 * @return string the final filter part to use in LDAP searches
1324
-	 */
1325
-	private function getFilterPartForSearch($search, $searchAttributes, $fallbackAttribute) {
1326
-		$filter = array();
1327
-		$haveMultiSearchAttributes = (is_array($searchAttributes) && count($searchAttributes) > 0);
1328
-		if($haveMultiSearchAttributes && strpos(trim($search), ' ') !== false) {
1329
-			try {
1330
-				return $this->getAdvancedFilterPartForSearch($search, $searchAttributes);
1331
-			} catch(\Exception $e) {
1332
-				\OCP\Util::writeLog(
1333
-					'user_ldap',
1334
-					'Creating advanced filter for search failed, falling back to simple method.',
1335
-					\OCP\Util::INFO
1336
-				);
1337
-			}
1338
-		}
1339
-
1340
-		$search = $this->prepareSearchTerm($search);
1341
-		if(!is_array($searchAttributes) || count($searchAttributes) === 0) {
1342
-			if ($fallbackAttribute === '') {
1343
-				return '';
1344
-			}
1345
-			$filter[] = $fallbackAttribute . '=' . $search;
1346
-		} else {
1347
-			foreach($searchAttributes as $attribute) {
1348
-				$filter[] = $attribute . '=' . $search;
1349
-			}
1350
-		}
1351
-		if(count($filter) === 1) {
1352
-			return '('.$filter[0].')';
1353
-		}
1354
-		return $this->combineFilterWithOr($filter);
1355
-	}
1356
-
1357
-	/**
1358
-	 * returns the search term depending on whether we are allowed
1359
-	 * list users found by ldap with the current input appended by
1360
-	 * a *
1361
-	 * @return string
1362
-	 */
1363
-	private function prepareSearchTerm($term) {
1364
-		$config = \OC::$server->getConfig();
1365
-
1366
-		$allowEnum = $config->getAppValue('core', 'shareapi_allow_share_dialog_user_enumeration', 'yes');
1367
-
1368
-		$result = $term;
1369
-		if ($term === '') {
1370
-			$result = '*';
1371
-		} else if ($allowEnum !== 'no') {
1372
-			$result = $term . '*';
1373
-		}
1374
-		return $result;
1375
-	}
1376
-
1377
-	/**
1378
-	 * returns the filter used for counting users
1379
-	 * @return string
1380
-	 */
1381
-	public function getFilterForUserCount() {
1382
-		$filter = $this->combineFilterWithAnd(array(
1383
-			$this->connection->ldapUserFilter,
1384
-			$this->connection->ldapUserDisplayName . '=*'
1385
-		));
1386
-
1387
-		return $filter;
1388
-	}
1389
-
1390
-	/**
1391
-	 * @param string $name
1392
-	 * @param string $password
1393
-	 * @return bool
1394
-	 */
1395
-	public function areCredentialsValid($name, $password) {
1396
-		$name = $this->helper->DNasBaseParameter($name);
1397
-		$testConnection = clone $this->connection;
1398
-		$credentials = array(
1399
-			'ldapAgentName' => $name,
1400
-			'ldapAgentPassword' => $password
1401
-		);
1402
-		if(!$testConnection->setConfiguration($credentials)) {
1403
-			return false;
1404
-		}
1405
-		return $testConnection->bind();
1406
-	}
1407
-
1408
-	/**
1409
-	 * reverse lookup of a DN given a known UUID
1410
-	 *
1411
-	 * @param string $uuid
1412
-	 * @return string
1413
-	 * @throws \Exception
1414
-	 */
1415
-	public function getUserDnByUuid($uuid) {
1416
-		$uuidOverride = $this->connection->ldapExpertUUIDUserAttr;
1417
-		$filter       = $this->connection->ldapUserFilter;
1418
-		$base         = $this->connection->ldapBaseUsers;
1419
-
1420
-		if ($this->connection->ldapUuidUserAttribute === 'auto' && $uuidOverride === '') {
1421
-			// Sacrebleu! The UUID attribute is unknown :( We need first an
1422
-			// existing DN to be able to reliably detect it.
1423
-			$result = $this->search($filter, $base, ['dn'], 1);
1424
-			if(!isset($result[0]) || !isset($result[0]['dn'])) {
1425
-				throw new \Exception('Cannot determine UUID attribute');
1426
-			}
1427
-			$dn = $result[0]['dn'][0];
1428
-			if(!$this->detectUuidAttribute($dn, true)) {
1429
-				throw new \Exception('Cannot determine UUID attribute');
1430
-			}
1431
-		} else {
1432
-			// The UUID attribute is either known or an override is given.
1433
-			// By calling this method we ensure that $this->connection->$uuidAttr
1434
-			// is definitely set
1435
-			if(!$this->detectUuidAttribute('', true)) {
1436
-				throw new \Exception('Cannot determine UUID attribute');
1437
-			}
1438
-		}
1439
-
1440
-		$uuidAttr = $this->connection->ldapUuidUserAttribute;
1441
-		if($uuidAttr === 'guid' || $uuidAttr === 'objectguid') {
1442
-			$uuid = $this->formatGuid2ForFilterUser($uuid);
1443
-		}
1444
-
1445
-		$filter = $uuidAttr . '=' . $uuid;
1446
-		$result = $this->searchUsers($filter, ['dn'], 2);
1447
-		if(is_array($result) && isset($result[0]) && isset($result[0]['dn']) && count($result) === 1) {
1448
-			// we put the count into account to make sure that this is
1449
-			// really unique
1450
-			return $result[0]['dn'][0];
1451
-		}
1452
-
1453
-		throw new \Exception('Cannot determine UUID attribute');
1454
-	}
1455
-
1456
-	/**
1457
-	 * auto-detects the directory's UUID attribute
1458
-	 * @param string $dn a known DN used to check against
1459
-	 * @param bool $isUser
1460
-	 * @param bool $force the detection should be run, even if it is not set to auto
1461
-	 * @return bool true on success, false otherwise
1462
-	 */
1463
-	private function detectUuidAttribute($dn, $isUser = true, $force = false) {
1464
-		if($isUser) {
1465
-			$uuidAttr     = 'ldapUuidUserAttribute';
1466
-			$uuidOverride = $this->connection->ldapExpertUUIDUserAttr;
1467
-		} else {
1468
-			$uuidAttr     = 'ldapUuidGroupAttribute';
1469
-			$uuidOverride = $this->connection->ldapExpertUUIDGroupAttr;
1470
-		}
1471
-
1472
-		if(($this->connection->$uuidAttr !== 'auto') && !$force) {
1473
-			return true;
1474
-		}
1475
-
1476
-		if (is_string($uuidOverride) && trim($uuidOverride) !== '' && !$force) {
1477
-			$this->connection->$uuidAttr = $uuidOverride;
1478
-			return true;
1479
-		}
1480
-
1481
-		// for now, supported attributes are entryUUID, nsuniqueid, objectGUID, ipaUniqueID
1482
-		$testAttributes = array('entryuuid', 'nsuniqueid', 'objectguid', 'guid', 'ipauniqueid');
1483
-
1484
-		foreach($testAttributes as $attribute) {
1485
-			$value = $this->readAttribute($dn, $attribute);
1486
-			if(is_array($value) && isset($value[0]) && !empty($value[0])) {
1487
-				\OCP\Util::writeLog('user_ldap',
1488
-									'Setting '.$attribute.' as '.$uuidAttr,
1489
-									\OCP\Util::DEBUG);
1490
-				$this->connection->$uuidAttr = $attribute;
1491
-				return true;
1492
-			}
1493
-		}
1494
-		\OCP\Util::writeLog('user_ldap',
1495
-							'Could not autodetect the UUID attribute',
1496
-							\OCP\Util::ERROR);
1497
-
1498
-		return false;
1499
-	}
1500
-
1501
-	/**
1502
-	 * @param string $dn
1503
-	 * @param bool $isUser
1504
-	 * @return string|bool
1505
-	 */
1506
-	public function getUUID($dn, $isUser = true) {
1507
-		if($isUser) {
1508
-			$uuidAttr     = 'ldapUuidUserAttribute';
1509
-			$uuidOverride = $this->connection->ldapExpertUUIDUserAttr;
1510
-		} else {
1511
-			$uuidAttr     = 'ldapUuidGroupAttribute';
1512
-			$uuidOverride = $this->connection->ldapExpertUUIDGroupAttr;
1513
-		}
1514
-
1515
-		$uuid = false;
1516
-		if($this->detectUuidAttribute($dn, $isUser)) {
1517
-			$uuid = $this->readAttribute($dn, $this->connection->$uuidAttr);
1518
-			if( !is_array($uuid)
1519
-				&& $uuidOverride !== ''
1520
-				&& $this->detectUuidAttribute($dn, $isUser, true)) {
1521
-					$uuid = $this->readAttribute($dn,
1522
-												 $this->connection->$uuidAttr);
1523
-			}
1524
-			if(is_array($uuid) && isset($uuid[0]) && !empty($uuid[0])) {
1525
-				$uuid = $uuid[0];
1526
-			}
1527
-		}
1528
-
1529
-		return $uuid;
1530
-	}
1531
-
1532
-	/**
1533
-	 * converts a binary ObjectGUID into a string representation
1534
-	 * @param string $oguid the ObjectGUID in it's binary form as retrieved from AD
1535
-	 * @return string
1536
-	 * @link http://www.php.net/manual/en/function.ldap-get-values-len.php#73198
1537
-	 */
1538
-	private function convertObjectGUID2Str($oguid) {
1539
-		$hex_guid = bin2hex($oguid);
1540
-		$hex_guid_to_guid_str = '';
1541
-		for($k = 1; $k <= 4; ++$k) {
1542
-			$hex_guid_to_guid_str .= substr($hex_guid, 8 - 2 * $k, 2);
1543
-		}
1544
-		$hex_guid_to_guid_str .= '-';
1545
-		for($k = 1; $k <= 2; ++$k) {
1546
-			$hex_guid_to_guid_str .= substr($hex_guid, 12 - 2 * $k, 2);
1547
-		}
1548
-		$hex_guid_to_guid_str .= '-';
1549
-		for($k = 1; $k <= 2; ++$k) {
1550
-			$hex_guid_to_guid_str .= substr($hex_guid, 16 - 2 * $k, 2);
1551
-		}
1552
-		$hex_guid_to_guid_str .= '-' . substr($hex_guid, 16, 4);
1553
-		$hex_guid_to_guid_str .= '-' . substr($hex_guid, 20);
1554
-
1555
-		return strtoupper($hex_guid_to_guid_str);
1556
-	}
1557
-
1558
-	/**
1559
-	 * the first three blocks of the string-converted GUID happen to be in
1560
-	 * reverse order. In order to use it in a filter, this needs to be
1561
-	 * corrected. Furthermore the dashes need to be replaced and \\ preprended
1562
-	 * to every two hax figures.
1563
-	 *
1564
-	 * If an invalid string is passed, it will be returned without change.
1565
-	 *
1566
-	 * @param string $guid
1567
-	 * @return string
1568
-	 */
1569
-	public function formatGuid2ForFilterUser($guid) {
1570
-		if(!is_string($guid)) {
1571
-			throw new \InvalidArgumentException('String expected');
1572
-		}
1573
-		$blocks = explode('-', $guid);
1574
-		if(count($blocks) !== 5) {
1575
-			/*
1111
+        $findings = array();
1112
+        $savedoffset = $offset;
1113
+        do {
1114
+            $search = $this->executeSearch($filter, $base, $attr, $limit, $offset);
1115
+            if($search === false) {
1116
+                return array();
1117
+            }
1118
+            list($sr, $pagedSearchOK) = $search;
1119
+            $cr = $this->connection->getConnectionResource();
1120
+
1121
+            if($skipHandling) {
1122
+                //i.e. result do not need to be fetched, we just need the cookie
1123
+                //thus pass 1 or any other value as $iFoundItems because it is not
1124
+                //used
1125
+                $this->processPagedSearchStatus($sr, $filter, $base, 1, $limit,
1126
+                                $offset, $pagedSearchOK,
1127
+                                $skipHandling);
1128
+                return array();
1129
+            }
1130
+
1131
+            foreach($sr as $res) {
1132
+                $findings = array_merge($findings, $this->ldap->getEntries($cr	, $res ));
1133
+            }
1134
+
1135
+            $continue = $this->processPagedSearchStatus($sr, $filter, $base, $findings['count'],
1136
+                                $limit, $offset, $pagedSearchOK,
1137
+                                        $skipHandling);
1138
+            $offset += $limit;
1139
+        } while ($continue && $pagedSearchOK && $findings['count'] < $limit);
1140
+        // reseting offset
1141
+        $offset = $savedoffset;
1142
+
1143
+        // if we're here, probably no connection resource is returned.
1144
+        // to make ownCloud behave nicely, we simply give back an empty array.
1145
+        if(is_null($findings)) {
1146
+            return array();
1147
+        }
1148
+
1149
+        if(!is_null($attr)) {
1150
+            $selection = array();
1151
+            $i = 0;
1152
+            foreach($findings as $item) {
1153
+                if(!is_array($item)) {
1154
+                    continue;
1155
+                }
1156
+                $item = \OCP\Util::mb_array_change_key_case($item, MB_CASE_LOWER, 'UTF-8');
1157
+                foreach($attr as $key) {
1158
+                    $key = mb_strtolower($key, 'UTF-8');
1159
+                    if(isset($item[$key])) {
1160
+                        if(is_array($item[$key]) && isset($item[$key]['count'])) {
1161
+                            unset($item[$key]['count']);
1162
+                        }
1163
+                        if($key !== 'dn') {
1164
+                            $selection[$i][$key] = $this->resemblesDN($key) ?
1165
+                                $this->helper->sanitizeDN($item[$key])
1166
+                                : $item[$key];
1167
+                        } else {
1168
+                            $selection[$i][$key] = [$this->helper->sanitizeDN($item[$key])];
1169
+                        }
1170
+                    }
1171
+
1172
+                }
1173
+                $i++;
1174
+            }
1175
+            $findings = $selection;
1176
+        }
1177
+        //we slice the findings, when
1178
+        //a) paged search unsuccessful, though attempted
1179
+        //b) no paged search, but limit set
1180
+        if((!$this->getPagedSearchResultState()
1181
+            && $pagedSearchOK)
1182
+            || (
1183
+                !$pagedSearchOK
1184
+                && !is_null($limit)
1185
+            )
1186
+        ) {
1187
+            $findings = array_slice($findings, intval($offset), $limit);
1188
+        }
1189
+        return $findings;
1190
+    }
1191
+
1192
+    /**
1193
+     * @param string $name
1194
+     * @return bool|mixed|string
1195
+     */
1196
+    public function sanitizeUsername($name) {
1197
+        if($this->connection->ldapIgnoreNamingRules) {
1198
+            return $name;
1199
+        }
1200
+
1201
+        // Transliteration
1202
+        // latin characters to ASCII
1203
+        $name = iconv('UTF-8', 'ASCII//TRANSLIT', $name);
1204
+
1205
+        // Replacements
1206
+        $name = str_replace(' ', '_', $name);
1207
+
1208
+        // Every remaining disallowed characters will be removed
1209
+        $name = preg_replace('/[^a-zA-Z0-9_.@-]/u', '', $name);
1210
+
1211
+        return $name;
1212
+    }
1213
+
1214
+    /**
1215
+     * escapes (user provided) parts for LDAP filter
1216
+     * @param string $input, the provided value
1217
+     * @param bool $allowAsterisk whether in * at the beginning should be preserved
1218
+     * @return string the escaped string
1219
+     */
1220
+    public function escapeFilterPart($input, $allowAsterisk = false) {
1221
+        $asterisk = '';
1222
+        if($allowAsterisk && strlen($input) > 0 && $input[0] === '*') {
1223
+            $asterisk = '*';
1224
+            $input = mb_substr($input, 1, null, 'UTF-8');
1225
+        }
1226
+        $search  = array('*', '\\', '(', ')');
1227
+        $replace = array('\\*', '\\\\', '\\(', '\\)');
1228
+        return $asterisk . str_replace($search, $replace, $input);
1229
+    }
1230
+
1231
+    /**
1232
+     * combines the input filters with AND
1233
+     * @param string[] $filters the filters to connect
1234
+     * @return string the combined filter
1235
+     */
1236
+    public function combineFilterWithAnd($filters) {
1237
+        return $this->combineFilter($filters, '&');
1238
+    }
1239
+
1240
+    /**
1241
+     * combines the input filters with OR
1242
+     * @param string[] $filters the filters to connect
1243
+     * @return string the combined filter
1244
+     * Combines Filter arguments with OR
1245
+     */
1246
+    public function combineFilterWithOr($filters) {
1247
+        return $this->combineFilter($filters, '|');
1248
+    }
1249
+
1250
+    /**
1251
+     * combines the input filters with given operator
1252
+     * @param string[] $filters the filters to connect
1253
+     * @param string $operator either & or |
1254
+     * @return string the combined filter
1255
+     */
1256
+    private function combineFilter($filters, $operator) {
1257
+        $combinedFilter = '('.$operator;
1258
+        foreach($filters as $filter) {
1259
+            if ($filter !== '' && $filter[0] !== '(') {
1260
+                $filter = '('.$filter.')';
1261
+            }
1262
+            $combinedFilter.=$filter;
1263
+        }
1264
+        $combinedFilter.=')';
1265
+        return $combinedFilter;
1266
+    }
1267
+
1268
+    /**
1269
+     * creates a filter part for to perform search for users
1270
+     * @param string $search the search term
1271
+     * @return string the final filter part to use in LDAP searches
1272
+     */
1273
+    public function getFilterPartForUserSearch($search) {
1274
+        return $this->getFilterPartForSearch($search,
1275
+            $this->connection->ldapAttributesForUserSearch,
1276
+            $this->connection->ldapUserDisplayName);
1277
+    }
1278
+
1279
+    /**
1280
+     * creates a filter part for to perform search for groups
1281
+     * @param string $search the search term
1282
+     * @return string the final filter part to use in LDAP searches
1283
+     */
1284
+    public function getFilterPartForGroupSearch($search) {
1285
+        return $this->getFilterPartForSearch($search,
1286
+            $this->connection->ldapAttributesForGroupSearch,
1287
+            $this->connection->ldapGroupDisplayName);
1288
+    }
1289
+
1290
+    /**
1291
+     * creates a filter part for searches by splitting up the given search
1292
+     * string into single words
1293
+     * @param string $search the search term
1294
+     * @param string[] $searchAttributes needs to have at least two attributes,
1295
+     * otherwise it does not make sense :)
1296
+     * @return string the final filter part to use in LDAP searches
1297
+     * @throws \Exception
1298
+     */
1299
+    private function getAdvancedFilterPartForSearch($search, $searchAttributes) {
1300
+        if(!is_array($searchAttributes) || count($searchAttributes) < 2) {
1301
+            throw new \Exception('searchAttributes must be an array with at least two string');
1302
+        }
1303
+        $searchWords = explode(' ', trim($search));
1304
+        $wordFilters = array();
1305
+        foreach($searchWords as $word) {
1306
+            $word = $this->prepareSearchTerm($word);
1307
+            //every word needs to appear at least once
1308
+            $wordMatchOneAttrFilters = array();
1309
+            foreach($searchAttributes as $attr) {
1310
+                $wordMatchOneAttrFilters[] = $attr . '=' . $word;
1311
+            }
1312
+            $wordFilters[] = $this->combineFilterWithOr($wordMatchOneAttrFilters);
1313
+        }
1314
+        return $this->combineFilterWithAnd($wordFilters);
1315
+    }
1316
+
1317
+    /**
1318
+     * creates a filter part for searches
1319
+     * @param string $search the search term
1320
+     * @param string[]|null $searchAttributes
1321
+     * @param string $fallbackAttribute a fallback attribute in case the user
1322
+     * did not define search attributes. Typically the display name attribute.
1323
+     * @return string the final filter part to use in LDAP searches
1324
+     */
1325
+    private function getFilterPartForSearch($search, $searchAttributes, $fallbackAttribute) {
1326
+        $filter = array();
1327
+        $haveMultiSearchAttributes = (is_array($searchAttributes) && count($searchAttributes) > 0);
1328
+        if($haveMultiSearchAttributes && strpos(trim($search), ' ') !== false) {
1329
+            try {
1330
+                return $this->getAdvancedFilterPartForSearch($search, $searchAttributes);
1331
+            } catch(\Exception $e) {
1332
+                \OCP\Util::writeLog(
1333
+                    'user_ldap',
1334
+                    'Creating advanced filter for search failed, falling back to simple method.',
1335
+                    \OCP\Util::INFO
1336
+                );
1337
+            }
1338
+        }
1339
+
1340
+        $search = $this->prepareSearchTerm($search);
1341
+        if(!is_array($searchAttributes) || count($searchAttributes) === 0) {
1342
+            if ($fallbackAttribute === '') {
1343
+                return '';
1344
+            }
1345
+            $filter[] = $fallbackAttribute . '=' . $search;
1346
+        } else {
1347
+            foreach($searchAttributes as $attribute) {
1348
+                $filter[] = $attribute . '=' . $search;
1349
+            }
1350
+        }
1351
+        if(count($filter) === 1) {
1352
+            return '('.$filter[0].')';
1353
+        }
1354
+        return $this->combineFilterWithOr($filter);
1355
+    }
1356
+
1357
+    /**
1358
+     * returns the search term depending on whether we are allowed
1359
+     * list users found by ldap with the current input appended by
1360
+     * a *
1361
+     * @return string
1362
+     */
1363
+    private function prepareSearchTerm($term) {
1364
+        $config = \OC::$server->getConfig();
1365
+
1366
+        $allowEnum = $config->getAppValue('core', 'shareapi_allow_share_dialog_user_enumeration', 'yes');
1367
+
1368
+        $result = $term;
1369
+        if ($term === '') {
1370
+            $result = '*';
1371
+        } else if ($allowEnum !== 'no') {
1372
+            $result = $term . '*';
1373
+        }
1374
+        return $result;
1375
+    }
1376
+
1377
+    /**
1378
+     * returns the filter used for counting users
1379
+     * @return string
1380
+     */
1381
+    public function getFilterForUserCount() {
1382
+        $filter = $this->combineFilterWithAnd(array(
1383
+            $this->connection->ldapUserFilter,
1384
+            $this->connection->ldapUserDisplayName . '=*'
1385
+        ));
1386
+
1387
+        return $filter;
1388
+    }
1389
+
1390
+    /**
1391
+     * @param string $name
1392
+     * @param string $password
1393
+     * @return bool
1394
+     */
1395
+    public function areCredentialsValid($name, $password) {
1396
+        $name = $this->helper->DNasBaseParameter($name);
1397
+        $testConnection = clone $this->connection;
1398
+        $credentials = array(
1399
+            'ldapAgentName' => $name,
1400
+            'ldapAgentPassword' => $password
1401
+        );
1402
+        if(!$testConnection->setConfiguration($credentials)) {
1403
+            return false;
1404
+        }
1405
+        return $testConnection->bind();
1406
+    }
1407
+
1408
+    /**
1409
+     * reverse lookup of a DN given a known UUID
1410
+     *
1411
+     * @param string $uuid
1412
+     * @return string
1413
+     * @throws \Exception
1414
+     */
1415
+    public function getUserDnByUuid($uuid) {
1416
+        $uuidOverride = $this->connection->ldapExpertUUIDUserAttr;
1417
+        $filter       = $this->connection->ldapUserFilter;
1418
+        $base         = $this->connection->ldapBaseUsers;
1419
+
1420
+        if ($this->connection->ldapUuidUserAttribute === 'auto' && $uuidOverride === '') {
1421
+            // Sacrebleu! The UUID attribute is unknown :( We need first an
1422
+            // existing DN to be able to reliably detect it.
1423
+            $result = $this->search($filter, $base, ['dn'], 1);
1424
+            if(!isset($result[0]) || !isset($result[0]['dn'])) {
1425
+                throw new \Exception('Cannot determine UUID attribute');
1426
+            }
1427
+            $dn = $result[0]['dn'][0];
1428
+            if(!$this->detectUuidAttribute($dn, true)) {
1429
+                throw new \Exception('Cannot determine UUID attribute');
1430
+            }
1431
+        } else {
1432
+            // The UUID attribute is either known or an override is given.
1433
+            // By calling this method we ensure that $this->connection->$uuidAttr
1434
+            // is definitely set
1435
+            if(!$this->detectUuidAttribute('', true)) {
1436
+                throw new \Exception('Cannot determine UUID attribute');
1437
+            }
1438
+        }
1439
+
1440
+        $uuidAttr = $this->connection->ldapUuidUserAttribute;
1441
+        if($uuidAttr === 'guid' || $uuidAttr === 'objectguid') {
1442
+            $uuid = $this->formatGuid2ForFilterUser($uuid);
1443
+        }
1444
+
1445
+        $filter = $uuidAttr . '=' . $uuid;
1446
+        $result = $this->searchUsers($filter, ['dn'], 2);
1447
+        if(is_array($result) && isset($result[0]) && isset($result[0]['dn']) && count($result) === 1) {
1448
+            // we put the count into account to make sure that this is
1449
+            // really unique
1450
+            return $result[0]['dn'][0];
1451
+        }
1452
+
1453
+        throw new \Exception('Cannot determine UUID attribute');
1454
+    }
1455
+
1456
+    /**
1457
+     * auto-detects the directory's UUID attribute
1458
+     * @param string $dn a known DN used to check against
1459
+     * @param bool $isUser
1460
+     * @param bool $force the detection should be run, even if it is not set to auto
1461
+     * @return bool true on success, false otherwise
1462
+     */
1463
+    private function detectUuidAttribute($dn, $isUser = true, $force = false) {
1464
+        if($isUser) {
1465
+            $uuidAttr     = 'ldapUuidUserAttribute';
1466
+            $uuidOverride = $this->connection->ldapExpertUUIDUserAttr;
1467
+        } else {
1468
+            $uuidAttr     = 'ldapUuidGroupAttribute';
1469
+            $uuidOverride = $this->connection->ldapExpertUUIDGroupAttr;
1470
+        }
1471
+
1472
+        if(($this->connection->$uuidAttr !== 'auto') && !$force) {
1473
+            return true;
1474
+        }
1475
+
1476
+        if (is_string($uuidOverride) && trim($uuidOverride) !== '' && !$force) {
1477
+            $this->connection->$uuidAttr = $uuidOverride;
1478
+            return true;
1479
+        }
1480
+
1481
+        // for now, supported attributes are entryUUID, nsuniqueid, objectGUID, ipaUniqueID
1482
+        $testAttributes = array('entryuuid', 'nsuniqueid', 'objectguid', 'guid', 'ipauniqueid');
1483
+
1484
+        foreach($testAttributes as $attribute) {
1485
+            $value = $this->readAttribute($dn, $attribute);
1486
+            if(is_array($value) && isset($value[0]) && !empty($value[0])) {
1487
+                \OCP\Util::writeLog('user_ldap',
1488
+                                    'Setting '.$attribute.' as '.$uuidAttr,
1489
+                                    \OCP\Util::DEBUG);
1490
+                $this->connection->$uuidAttr = $attribute;
1491
+                return true;
1492
+            }
1493
+        }
1494
+        \OCP\Util::writeLog('user_ldap',
1495
+                            'Could not autodetect the UUID attribute',
1496
+                            \OCP\Util::ERROR);
1497
+
1498
+        return false;
1499
+    }
1500
+
1501
+    /**
1502
+     * @param string $dn
1503
+     * @param bool $isUser
1504
+     * @return string|bool
1505
+     */
1506
+    public function getUUID($dn, $isUser = true) {
1507
+        if($isUser) {
1508
+            $uuidAttr     = 'ldapUuidUserAttribute';
1509
+            $uuidOverride = $this->connection->ldapExpertUUIDUserAttr;
1510
+        } else {
1511
+            $uuidAttr     = 'ldapUuidGroupAttribute';
1512
+            $uuidOverride = $this->connection->ldapExpertUUIDGroupAttr;
1513
+        }
1514
+
1515
+        $uuid = false;
1516
+        if($this->detectUuidAttribute($dn, $isUser)) {
1517
+            $uuid = $this->readAttribute($dn, $this->connection->$uuidAttr);
1518
+            if( !is_array($uuid)
1519
+                && $uuidOverride !== ''
1520
+                && $this->detectUuidAttribute($dn, $isUser, true)) {
1521
+                    $uuid = $this->readAttribute($dn,
1522
+                                                    $this->connection->$uuidAttr);
1523
+            }
1524
+            if(is_array($uuid) && isset($uuid[0]) && !empty($uuid[0])) {
1525
+                $uuid = $uuid[0];
1526
+            }
1527
+        }
1528
+
1529
+        return $uuid;
1530
+    }
1531
+
1532
+    /**
1533
+     * converts a binary ObjectGUID into a string representation
1534
+     * @param string $oguid the ObjectGUID in it's binary form as retrieved from AD
1535
+     * @return string
1536
+     * @link http://www.php.net/manual/en/function.ldap-get-values-len.php#73198
1537
+     */
1538
+    private function convertObjectGUID2Str($oguid) {
1539
+        $hex_guid = bin2hex($oguid);
1540
+        $hex_guid_to_guid_str = '';
1541
+        for($k = 1; $k <= 4; ++$k) {
1542
+            $hex_guid_to_guid_str .= substr($hex_guid, 8 - 2 * $k, 2);
1543
+        }
1544
+        $hex_guid_to_guid_str .= '-';
1545
+        for($k = 1; $k <= 2; ++$k) {
1546
+            $hex_guid_to_guid_str .= substr($hex_guid, 12 - 2 * $k, 2);
1547
+        }
1548
+        $hex_guid_to_guid_str .= '-';
1549
+        for($k = 1; $k <= 2; ++$k) {
1550
+            $hex_guid_to_guid_str .= substr($hex_guid, 16 - 2 * $k, 2);
1551
+        }
1552
+        $hex_guid_to_guid_str .= '-' . substr($hex_guid, 16, 4);
1553
+        $hex_guid_to_guid_str .= '-' . substr($hex_guid, 20);
1554
+
1555
+        return strtoupper($hex_guid_to_guid_str);
1556
+    }
1557
+
1558
+    /**
1559
+     * the first three blocks of the string-converted GUID happen to be in
1560
+     * reverse order. In order to use it in a filter, this needs to be
1561
+     * corrected. Furthermore the dashes need to be replaced and \\ preprended
1562
+     * to every two hax figures.
1563
+     *
1564
+     * If an invalid string is passed, it will be returned without change.
1565
+     *
1566
+     * @param string $guid
1567
+     * @return string
1568
+     */
1569
+    public function formatGuid2ForFilterUser($guid) {
1570
+        if(!is_string($guid)) {
1571
+            throw new \InvalidArgumentException('String expected');
1572
+        }
1573
+        $blocks = explode('-', $guid);
1574
+        if(count($blocks) !== 5) {
1575
+            /*
1576 1576
 			 * Why not throw an Exception instead? This method is a utility
1577 1577
 			 * called only when trying to figure out whether a "missing" known
1578 1578
 			 * LDAP user was or was not renamed on the LDAP server. And this
@@ -1583,275 +1583,275 @@  discard block
 block discarded – undo
1583 1583
 			 * an exception here would kill the experience for a valid, acting
1584 1584
 			 * user. Instead we write a log message.
1585 1585
 			 */
1586
-			\OC::$server->getLogger()->info(
1587
-				'Passed string does not resemble a valid GUID. Known UUID ' .
1588
-				'({uuid}) probably does not match UUID configuration.',
1589
-				[ 'app' => 'user_ldap', 'uuid' => $guid ]
1590
-			);
1591
-			return $guid;
1592
-		}
1593
-		for($i=0; $i < 3; $i++) {
1594
-			$pairs = str_split($blocks[$i], 2);
1595
-			$pairs = array_reverse($pairs);
1596
-			$blocks[$i] = implode('', $pairs);
1597
-		}
1598
-		for($i=0; $i < 5; $i++) {
1599
-			$pairs = str_split($blocks[$i], 2);
1600
-			$blocks[$i] = '\\' . implode('\\', $pairs);
1601
-		}
1602
-		return implode('', $blocks);
1603
-	}
1604
-
1605
-	/**
1606
-	 * gets a SID of the domain of the given dn
1607
-	 * @param string $dn
1608
-	 * @return string|bool
1609
-	 */
1610
-	public function getSID($dn) {
1611
-		$domainDN = $this->getDomainDNFromDN($dn);
1612
-		$cacheKey = 'getSID-'.$domainDN;
1613
-		$sid = $this->connection->getFromCache($cacheKey);
1614
-		if(!is_null($sid)) {
1615
-			return $sid;
1616
-		}
1617
-
1618
-		$objectSid = $this->readAttribute($domainDN, 'objectsid');
1619
-		if(!is_array($objectSid) || empty($objectSid)) {
1620
-			$this->connection->writeToCache($cacheKey, false);
1621
-			return false;
1622
-		}
1623
-		$domainObjectSid = $this->convertSID2Str($objectSid[0]);
1624
-		$this->connection->writeToCache($cacheKey, $domainObjectSid);
1625
-
1626
-		return $domainObjectSid;
1627
-	}
1628
-
1629
-	/**
1630
-	 * converts a binary SID into a string representation
1631
-	 * @param string $sid
1632
-	 * @return string
1633
-	 */
1634
-	public function convertSID2Str($sid) {
1635
-		// The format of a SID binary string is as follows:
1636
-		// 1 byte for the revision level
1637
-		// 1 byte for the number n of variable sub-ids
1638
-		// 6 bytes for identifier authority value
1639
-		// n*4 bytes for n sub-ids
1640
-		//
1641
-		// Example: 010400000000000515000000a681e50e4d6c6c2bca32055f
1642
-		//  Legend: RRNNAAAAAAAAAAAA11111111222222223333333344444444
1643
-		$revision = ord($sid[0]);
1644
-		$numberSubID = ord($sid[1]);
1645
-
1646
-		$subIdStart = 8; // 1 + 1 + 6
1647
-		$subIdLength = 4;
1648
-		if (strlen($sid) !== $subIdStart + $subIdLength * $numberSubID) {
1649
-			// Incorrect number of bytes present.
1650
-			return '';
1651
-		}
1652
-
1653
-		// 6 bytes = 48 bits can be represented using floats without loss of
1654
-		// precision (see https://gist.github.com/bantu/886ac680b0aef5812f71)
1655
-		$iav = number_format(hexdec(bin2hex(substr($sid, 2, 6))), 0, '', '');
1656
-
1657
-		$subIDs = array();
1658
-		for ($i = 0; $i < $numberSubID; $i++) {
1659
-			$subID = unpack('V', substr($sid, $subIdStart + $subIdLength * $i, $subIdLength));
1660
-			$subIDs[] = sprintf('%u', $subID[1]);
1661
-		}
1662
-
1663
-		// Result for example above: S-1-5-21-249921958-728525901-1594176202
1664
-		return sprintf('S-%d-%s-%s', $revision, $iav, implode('-', $subIDs));
1665
-	}
1666
-
1667
-	/**
1668
-	 * checks if the given DN is part of the given base DN(s)
1669
-	 * @param string $dn the DN
1670
-	 * @param string[] $bases array containing the allowed base DN or DNs
1671
-	 * @return bool
1672
-	 */
1673
-	public function isDNPartOfBase($dn, $bases) {
1674
-		$belongsToBase = false;
1675
-		$bases = $this->helper->sanitizeDN($bases);
1676
-
1677
-		foreach($bases as $base) {
1678
-			$belongsToBase = true;
1679
-			if(mb_strripos($dn, $base, 0, 'UTF-8') !== (mb_strlen($dn, 'UTF-8')-mb_strlen($base, 'UTF-8'))) {
1680
-				$belongsToBase = false;
1681
-			}
1682
-			if($belongsToBase) {
1683
-				break;
1684
-			}
1685
-		}
1686
-		return $belongsToBase;
1687
-	}
1688
-
1689
-	/**
1690
-	 * resets a running Paged Search operation
1691
-	 */
1692
-	private function abandonPagedSearch() {
1693
-		if($this->connection->hasPagedResultSupport) {
1694
-			$cr = $this->connection->getConnectionResource();
1695
-			$this->ldap->controlPagedResult($cr, 0, false, $this->lastCookie);
1696
-			$this->getPagedSearchResultState();
1697
-			$this->lastCookie = '';
1698
-			$this->cookies = array();
1699
-		}
1700
-	}
1701
-
1702
-	/**
1703
-	 * get a cookie for the next LDAP paged search
1704
-	 * @param string $base a string with the base DN for the search
1705
-	 * @param string $filter the search filter to identify the correct search
1706
-	 * @param int $limit the limit (or 'pageSize'), to identify the correct search well
1707
-	 * @param int $offset the offset for the new search to identify the correct search really good
1708
-	 * @return string containing the key or empty if none is cached
1709
-	 */
1710
-	private function getPagedResultCookie($base, $filter, $limit, $offset) {
1711
-		if($offset === 0) {
1712
-			return '';
1713
-		}
1714
-		$offset -= $limit;
1715
-		//we work with cache here
1716
-		$cacheKey = 'lc' . crc32($base) . '-' . crc32($filter) . '-' . intval($limit) . '-' . intval($offset);
1717
-		$cookie = '';
1718
-		if(isset($this->cookies[$cacheKey])) {
1719
-			$cookie = $this->cookies[$cacheKey];
1720
-			if(is_null($cookie)) {
1721
-				$cookie = '';
1722
-			}
1723
-		}
1724
-		return $cookie;
1725
-	}
1726
-
1727
-	/**
1728
-	 * checks whether an LDAP paged search operation has more pages that can be
1729
-	 * retrieved, typically when offset and limit are provided.
1730
-	 *
1731
-	 * Be very careful to use it: the last cookie value, which is inspected, can
1732
-	 * be reset by other operations. Best, call it immediately after a search(),
1733
-	 * searchUsers() or searchGroups() call. count-methods are probably safe as
1734
-	 * well. Don't rely on it with any fetchList-method.
1735
-	 * @return bool
1736
-	 */
1737
-	public function hasMoreResults() {
1738
-		if(!$this->connection->hasPagedResultSupport) {
1739
-			return false;
1740
-		}
1741
-
1742
-		if(empty($this->lastCookie) && $this->lastCookie !== '0') {
1743
-			// as in RFC 2696, when all results are returned, the cookie will
1744
-			// be empty.
1745
-			return false;
1746
-		}
1747
-
1748
-		return true;
1749
-	}
1750
-
1751
-	/**
1752
-	 * set a cookie for LDAP paged search run
1753
-	 * @param string $base a string with the base DN for the search
1754
-	 * @param string $filter the search filter to identify the correct search
1755
-	 * @param int $limit the limit (or 'pageSize'), to identify the correct search well
1756
-	 * @param int $offset the offset for the run search to identify the correct search really good
1757
-	 * @param string $cookie string containing the cookie returned by ldap_control_paged_result_response
1758
-	 * @return void
1759
-	 */
1760
-	private function setPagedResultCookie($base, $filter, $limit, $offset, $cookie) {
1761
-		// allow '0' for 389ds
1762
-		if(!empty($cookie) || $cookie === '0') {
1763
-			$cacheKey = 'lc' . crc32($base) . '-' . crc32($filter) . '-' .intval($limit) . '-' . intval($offset);
1764
-			$this->cookies[$cacheKey] = $cookie;
1765
-			$this->lastCookie = $cookie;
1766
-		}
1767
-	}
1768
-
1769
-	/**
1770
-	 * Check whether the most recent paged search was successful. It flushed the state var. Use it always after a possible paged search.
1771
-	 * @return boolean|null true on success, null or false otherwise
1772
-	 */
1773
-	public function getPagedSearchResultState() {
1774
-		$result = $this->pagedSearchedSuccessful;
1775
-		$this->pagedSearchedSuccessful = null;
1776
-		return $result;
1777
-	}
1778
-
1779
-	/**
1780
-	 * Prepares a paged search, if possible
1781
-	 * @param string $filter the LDAP filter for the search
1782
-	 * @param string[] $bases an array containing the LDAP subtree(s) that shall be searched
1783
-	 * @param string[] $attr optional, when a certain attribute shall be filtered outside
1784
-	 * @param int $limit
1785
-	 * @param int $offset
1786
-	 * @return bool|true
1787
-	 */
1788
-	private function initPagedSearch($filter, $bases, $attr, $limit, $offset) {
1789
-		$pagedSearchOK = false;
1790
-		if($this->connection->hasPagedResultSupport && ($limit !== 0)) {
1791
-			$offset = intval($offset); //can be null
1792
-			\OCP\Util::writeLog('user_ldap',
1793
-				'initializing paged search for  Filter '.$filter.' base '.print_r($bases, true)
1794
-				.' attr '.print_r($attr, true). ' limit ' .$limit.' offset '.$offset,
1795
-				\OCP\Util::DEBUG);
1796
-			//get the cookie from the search for the previous search, required by LDAP
1797
-			foreach($bases as $base) {
1798
-
1799
-				$cookie = $this->getPagedResultCookie($base, $filter, $limit, $offset);
1800
-				if(empty($cookie) && $cookie !== "0" && ($offset > 0)) {
1801
-					// no cookie known, although the offset is not 0. Maybe cache run out. We need
1802
-					// to start all over *sigh* (btw, Dear Reader, did you know LDAP paged
1803
-					// searching was designed by MSFT?)
1804
-					// 		Lukas: No, but thanks to reading that source I finally know!
1805
-					// '0' is valid, because 389ds
1806
-					$reOffset = ($offset - $limit) < 0 ? 0 : $offset - $limit;
1807
-					//a bit recursive, $offset of 0 is the exit
1808
-					\OCP\Util::writeLog('user_ldap', 'Looking for cookie L/O '.$limit.'/'.$reOffset, \OCP\Util::INFO);
1809
-					$this->search($filter, array($base), $attr, $limit, $reOffset, true);
1810
-					$cookie = $this->getPagedResultCookie($base, $filter, $limit, $offset);
1811
-					//still no cookie? obviously, the server does not like us. Let's skip paging efforts.
1812
-					//TODO: remember this, probably does not change in the next request...
1813
-					if(empty($cookie) && $cookie !== '0') {
1814
-						// '0' is valid, because 389ds
1815
-						$cookie = null;
1816
-					}
1817
-				}
1818
-				if(!is_null($cookie)) {
1819
-					//since offset = 0, this is a new search. We abandon other searches that might be ongoing.
1820
-					$this->abandonPagedSearch();
1821
-					$pagedSearchOK = $this->ldap->controlPagedResult(
1822
-						$this->connection->getConnectionResource(), $limit,
1823
-						false, $cookie);
1824
-					if(!$pagedSearchOK) {
1825
-						return false;
1826
-					}
1827
-					\OCP\Util::writeLog('user_ldap', 'Ready for a paged search', \OCP\Util::DEBUG);
1828
-				} else {
1829
-					\OCP\Util::writeLog('user_ldap',
1830
-						'No paged search for us, Cpt., Limit '.$limit.' Offset '.$offset,
1831
-						\OCP\Util::INFO);
1832
-				}
1833
-
1834
-			}
1835
-		/* ++ Fixing RHDS searches with pages with zero results ++
1586
+            \OC::$server->getLogger()->info(
1587
+                'Passed string does not resemble a valid GUID. Known UUID ' .
1588
+                '({uuid}) probably does not match UUID configuration.',
1589
+                [ 'app' => 'user_ldap', 'uuid' => $guid ]
1590
+            );
1591
+            return $guid;
1592
+        }
1593
+        for($i=0; $i < 3; $i++) {
1594
+            $pairs = str_split($blocks[$i], 2);
1595
+            $pairs = array_reverse($pairs);
1596
+            $blocks[$i] = implode('', $pairs);
1597
+        }
1598
+        for($i=0; $i < 5; $i++) {
1599
+            $pairs = str_split($blocks[$i], 2);
1600
+            $blocks[$i] = '\\' . implode('\\', $pairs);
1601
+        }
1602
+        return implode('', $blocks);
1603
+    }
1604
+
1605
+    /**
1606
+     * gets a SID of the domain of the given dn
1607
+     * @param string $dn
1608
+     * @return string|bool
1609
+     */
1610
+    public function getSID($dn) {
1611
+        $domainDN = $this->getDomainDNFromDN($dn);
1612
+        $cacheKey = 'getSID-'.$domainDN;
1613
+        $sid = $this->connection->getFromCache($cacheKey);
1614
+        if(!is_null($sid)) {
1615
+            return $sid;
1616
+        }
1617
+
1618
+        $objectSid = $this->readAttribute($domainDN, 'objectsid');
1619
+        if(!is_array($objectSid) || empty($objectSid)) {
1620
+            $this->connection->writeToCache($cacheKey, false);
1621
+            return false;
1622
+        }
1623
+        $domainObjectSid = $this->convertSID2Str($objectSid[0]);
1624
+        $this->connection->writeToCache($cacheKey, $domainObjectSid);
1625
+
1626
+        return $domainObjectSid;
1627
+    }
1628
+
1629
+    /**
1630
+     * converts a binary SID into a string representation
1631
+     * @param string $sid
1632
+     * @return string
1633
+     */
1634
+    public function convertSID2Str($sid) {
1635
+        // The format of a SID binary string is as follows:
1636
+        // 1 byte for the revision level
1637
+        // 1 byte for the number n of variable sub-ids
1638
+        // 6 bytes for identifier authority value
1639
+        // n*4 bytes for n sub-ids
1640
+        //
1641
+        // Example: 010400000000000515000000a681e50e4d6c6c2bca32055f
1642
+        //  Legend: RRNNAAAAAAAAAAAA11111111222222223333333344444444
1643
+        $revision = ord($sid[0]);
1644
+        $numberSubID = ord($sid[1]);
1645
+
1646
+        $subIdStart = 8; // 1 + 1 + 6
1647
+        $subIdLength = 4;
1648
+        if (strlen($sid) !== $subIdStart + $subIdLength * $numberSubID) {
1649
+            // Incorrect number of bytes present.
1650
+            return '';
1651
+        }
1652
+
1653
+        // 6 bytes = 48 bits can be represented using floats without loss of
1654
+        // precision (see https://gist.github.com/bantu/886ac680b0aef5812f71)
1655
+        $iav = number_format(hexdec(bin2hex(substr($sid, 2, 6))), 0, '', '');
1656
+
1657
+        $subIDs = array();
1658
+        for ($i = 0; $i < $numberSubID; $i++) {
1659
+            $subID = unpack('V', substr($sid, $subIdStart + $subIdLength * $i, $subIdLength));
1660
+            $subIDs[] = sprintf('%u', $subID[1]);
1661
+        }
1662
+
1663
+        // Result for example above: S-1-5-21-249921958-728525901-1594176202
1664
+        return sprintf('S-%d-%s-%s', $revision, $iav, implode('-', $subIDs));
1665
+    }
1666
+
1667
+    /**
1668
+     * checks if the given DN is part of the given base DN(s)
1669
+     * @param string $dn the DN
1670
+     * @param string[] $bases array containing the allowed base DN or DNs
1671
+     * @return bool
1672
+     */
1673
+    public function isDNPartOfBase($dn, $bases) {
1674
+        $belongsToBase = false;
1675
+        $bases = $this->helper->sanitizeDN($bases);
1676
+
1677
+        foreach($bases as $base) {
1678
+            $belongsToBase = true;
1679
+            if(mb_strripos($dn, $base, 0, 'UTF-8') !== (mb_strlen($dn, 'UTF-8')-mb_strlen($base, 'UTF-8'))) {
1680
+                $belongsToBase = false;
1681
+            }
1682
+            if($belongsToBase) {
1683
+                break;
1684
+            }
1685
+        }
1686
+        return $belongsToBase;
1687
+    }
1688
+
1689
+    /**
1690
+     * resets a running Paged Search operation
1691
+     */
1692
+    private function abandonPagedSearch() {
1693
+        if($this->connection->hasPagedResultSupport) {
1694
+            $cr = $this->connection->getConnectionResource();
1695
+            $this->ldap->controlPagedResult($cr, 0, false, $this->lastCookie);
1696
+            $this->getPagedSearchResultState();
1697
+            $this->lastCookie = '';
1698
+            $this->cookies = array();
1699
+        }
1700
+    }
1701
+
1702
+    /**
1703
+     * get a cookie for the next LDAP paged search
1704
+     * @param string $base a string with the base DN for the search
1705
+     * @param string $filter the search filter to identify the correct search
1706
+     * @param int $limit the limit (or 'pageSize'), to identify the correct search well
1707
+     * @param int $offset the offset for the new search to identify the correct search really good
1708
+     * @return string containing the key or empty if none is cached
1709
+     */
1710
+    private function getPagedResultCookie($base, $filter, $limit, $offset) {
1711
+        if($offset === 0) {
1712
+            return '';
1713
+        }
1714
+        $offset -= $limit;
1715
+        //we work with cache here
1716
+        $cacheKey = 'lc' . crc32($base) . '-' . crc32($filter) . '-' . intval($limit) . '-' . intval($offset);
1717
+        $cookie = '';
1718
+        if(isset($this->cookies[$cacheKey])) {
1719
+            $cookie = $this->cookies[$cacheKey];
1720
+            if(is_null($cookie)) {
1721
+                $cookie = '';
1722
+            }
1723
+        }
1724
+        return $cookie;
1725
+    }
1726
+
1727
+    /**
1728
+     * checks whether an LDAP paged search operation has more pages that can be
1729
+     * retrieved, typically when offset and limit are provided.
1730
+     *
1731
+     * Be very careful to use it: the last cookie value, which is inspected, can
1732
+     * be reset by other operations. Best, call it immediately after a search(),
1733
+     * searchUsers() or searchGroups() call. count-methods are probably safe as
1734
+     * well. Don't rely on it with any fetchList-method.
1735
+     * @return bool
1736
+     */
1737
+    public function hasMoreResults() {
1738
+        if(!$this->connection->hasPagedResultSupport) {
1739
+            return false;
1740
+        }
1741
+
1742
+        if(empty($this->lastCookie) && $this->lastCookie !== '0') {
1743
+            // as in RFC 2696, when all results are returned, the cookie will
1744
+            // be empty.
1745
+            return false;
1746
+        }
1747
+
1748
+        return true;
1749
+    }
1750
+
1751
+    /**
1752
+     * set a cookie for LDAP paged search run
1753
+     * @param string $base a string with the base DN for the search
1754
+     * @param string $filter the search filter to identify the correct search
1755
+     * @param int $limit the limit (or 'pageSize'), to identify the correct search well
1756
+     * @param int $offset the offset for the run search to identify the correct search really good
1757
+     * @param string $cookie string containing the cookie returned by ldap_control_paged_result_response
1758
+     * @return void
1759
+     */
1760
+    private function setPagedResultCookie($base, $filter, $limit, $offset, $cookie) {
1761
+        // allow '0' for 389ds
1762
+        if(!empty($cookie) || $cookie === '0') {
1763
+            $cacheKey = 'lc' . crc32($base) . '-' . crc32($filter) . '-' .intval($limit) . '-' . intval($offset);
1764
+            $this->cookies[$cacheKey] = $cookie;
1765
+            $this->lastCookie = $cookie;
1766
+        }
1767
+    }
1768
+
1769
+    /**
1770
+     * Check whether the most recent paged search was successful. It flushed the state var. Use it always after a possible paged search.
1771
+     * @return boolean|null true on success, null or false otherwise
1772
+     */
1773
+    public function getPagedSearchResultState() {
1774
+        $result = $this->pagedSearchedSuccessful;
1775
+        $this->pagedSearchedSuccessful = null;
1776
+        return $result;
1777
+    }
1778
+
1779
+    /**
1780
+     * Prepares a paged search, if possible
1781
+     * @param string $filter the LDAP filter for the search
1782
+     * @param string[] $bases an array containing the LDAP subtree(s) that shall be searched
1783
+     * @param string[] $attr optional, when a certain attribute shall be filtered outside
1784
+     * @param int $limit
1785
+     * @param int $offset
1786
+     * @return bool|true
1787
+     */
1788
+    private function initPagedSearch($filter, $bases, $attr, $limit, $offset) {
1789
+        $pagedSearchOK = false;
1790
+        if($this->connection->hasPagedResultSupport && ($limit !== 0)) {
1791
+            $offset = intval($offset); //can be null
1792
+            \OCP\Util::writeLog('user_ldap',
1793
+                'initializing paged search for  Filter '.$filter.' base '.print_r($bases, true)
1794
+                .' attr '.print_r($attr, true). ' limit ' .$limit.' offset '.$offset,
1795
+                \OCP\Util::DEBUG);
1796
+            //get the cookie from the search for the previous search, required by LDAP
1797
+            foreach($bases as $base) {
1798
+
1799
+                $cookie = $this->getPagedResultCookie($base, $filter, $limit, $offset);
1800
+                if(empty($cookie) && $cookie !== "0" && ($offset > 0)) {
1801
+                    // no cookie known, although the offset is not 0. Maybe cache run out. We need
1802
+                    // to start all over *sigh* (btw, Dear Reader, did you know LDAP paged
1803
+                    // searching was designed by MSFT?)
1804
+                    // 		Lukas: No, but thanks to reading that source I finally know!
1805
+                    // '0' is valid, because 389ds
1806
+                    $reOffset = ($offset - $limit) < 0 ? 0 : $offset - $limit;
1807
+                    //a bit recursive, $offset of 0 is the exit
1808
+                    \OCP\Util::writeLog('user_ldap', 'Looking for cookie L/O '.$limit.'/'.$reOffset, \OCP\Util::INFO);
1809
+                    $this->search($filter, array($base), $attr, $limit, $reOffset, true);
1810
+                    $cookie = $this->getPagedResultCookie($base, $filter, $limit, $offset);
1811
+                    //still no cookie? obviously, the server does not like us. Let's skip paging efforts.
1812
+                    //TODO: remember this, probably does not change in the next request...
1813
+                    if(empty($cookie) && $cookie !== '0') {
1814
+                        // '0' is valid, because 389ds
1815
+                        $cookie = null;
1816
+                    }
1817
+                }
1818
+                if(!is_null($cookie)) {
1819
+                    //since offset = 0, this is a new search. We abandon other searches that might be ongoing.
1820
+                    $this->abandonPagedSearch();
1821
+                    $pagedSearchOK = $this->ldap->controlPagedResult(
1822
+                        $this->connection->getConnectionResource(), $limit,
1823
+                        false, $cookie);
1824
+                    if(!$pagedSearchOK) {
1825
+                        return false;
1826
+                    }
1827
+                    \OCP\Util::writeLog('user_ldap', 'Ready for a paged search', \OCP\Util::DEBUG);
1828
+                } else {
1829
+                    \OCP\Util::writeLog('user_ldap',
1830
+                        'No paged search for us, Cpt., Limit '.$limit.' Offset '.$offset,
1831
+                        \OCP\Util::INFO);
1832
+                }
1833
+
1834
+            }
1835
+        /* ++ Fixing RHDS searches with pages with zero results ++
1836 1836
 		 * We coudn't get paged searches working with our RHDS for login ($limit = 0),
1837 1837
 		 * due to pages with zero results.
1838 1838
 		 * So we added "&& !empty($this->lastCookie)" to this test to ignore pagination
1839 1839
 		 * if we don't have a previous paged search.
1840 1840
 		 */
1841
-		} else if($this->connection->hasPagedResultSupport && $limit === 0 && !empty($this->lastCookie)) {
1842
-			// a search without limit was requested. However, if we do use
1843
-			// Paged Search once, we always must do it. This requires us to
1844
-			// initialize it with the configured page size.
1845
-			$this->abandonPagedSearch();
1846
-			// in case someone set it to 0 … use 500, otherwise no results will
1847
-			// be returned.
1848
-			$pageSize = intval($this->connection->ldapPagingSize) > 0 ? intval($this->connection->ldapPagingSize) : 500;
1849
-			$pagedSearchOK = $this->ldap->controlPagedResult(
1850
-				$this->connection->getConnectionResource(), $pageSize, false, ''
1851
-			);
1852
-		}
1853
-
1854
-		return $pagedSearchOK;
1855
-	}
1841
+        } else if($this->connection->hasPagedResultSupport && $limit === 0 && !empty($this->lastCookie)) {
1842
+            // a search without limit was requested. However, if we do use
1843
+            // Paged Search once, we always must do it. This requires us to
1844
+            // initialize it with the configured page size.
1845
+            $this->abandonPagedSearch();
1846
+            // in case someone set it to 0 … use 500, otherwise no results will
1847
+            // be returned.
1848
+            $pageSize = intval($this->connection->ldapPagingSize) > 0 ? intval($this->connection->ldapPagingSize) : 500;
1849
+            $pagedSearchOK = $this->ldap->controlPagedResult(
1850
+                $this->connection->getConnectionResource(), $pageSize, false, ''
1851
+            );
1852
+        }
1853
+
1854
+        return $pagedSearchOK;
1855
+    }
1856 1856
 
1857 1857
 }
Please login to merge, or discard this patch.
apps/user_ldap/lib/FilesystemHelper.php 1 patch
Indentation   +14 added lines, -14 removed lines patch added patch discarded remove patch
@@ -29,19 +29,19 @@
 block discarded – undo
29 29
  */
30 30
 class FilesystemHelper {
31 31
 
32
-	/**
33
-	 * @brief states whether the filesystem was loaded
34
-	 * @return bool
35
-	 */
36
-	public function isLoaded() {
37
-		return \OC\Files\Filesystem::$loaded;
38
-	}
32
+    /**
33
+     * @brief states whether the filesystem was loaded
34
+     * @return bool
35
+     */
36
+    public function isLoaded() {
37
+        return \OC\Files\Filesystem::$loaded;
38
+    }
39 39
 
40
-	/**
41
-	 * @brief initializes the filesystem for the given user
42
-	 * @param string $uid the ownCloud username of the user
43
-	 */
44
-	public function setup($uid) {
45
-		\OC_Util::setupFS($uid);
46
-	}
40
+    /**
41
+     * @brief initializes the filesystem for the given user
42
+     * @param string $uid the ownCloud username of the user
43
+     */
44
+    public function setup($uid) {
45
+        \OC_Util::setupFS($uid);
46
+    }
47 47
 }
Please login to merge, or discard this patch.
apps/user_ldap/lib/LDAPProvider.php 1 patch
Indentation   +138 added lines, -138 removed lines patch added patch discarded remove patch
@@ -33,155 +33,155 @@
 block discarded – undo
33 33
  */
34 34
 class LDAPProvider implements ILDAPProvider, IDeletionFlagSupport {
35 35
 
36
-	private $backend;
37
-	private $logger;
38
-	private $helper;
39
-	private $deletedUsersIndex;
36
+    private $backend;
37
+    private $logger;
38
+    private $helper;
39
+    private $deletedUsersIndex;
40 40
 	
41
-	/**
42
-	 * Create new LDAPProvider
43
-	 * @param \OCP\IServerContainer $serverContainer
44
-	 * @throws \Exception if user_ldap app was not enabled
45
-	 */
46
-	public function __construct(IServerContainer $serverContainer, Helper $helper, DeletedUsersIndex $deletedUsersIndex) {
47
-		$this->logger = $serverContainer->getLogger();
48
-		$this->helper = $helper;
49
-		$this->deletedUsersIndex = $deletedUsersIndex;
50
-		foreach ($serverContainer->getUserManager()->getBackends() as $backend){
51
-			$this->logger->debug('instance '.get_class($backend).' backend.', ['app' => 'user_ldap']);
52
-			if ($backend instanceof IUserLDAP) {
53
-				$this->backend = $backend;
54
-				return;
55
-			}
41
+    /**
42
+     * Create new LDAPProvider
43
+     * @param \OCP\IServerContainer $serverContainer
44
+     * @throws \Exception if user_ldap app was not enabled
45
+     */
46
+    public function __construct(IServerContainer $serverContainer, Helper $helper, DeletedUsersIndex $deletedUsersIndex) {
47
+        $this->logger = $serverContainer->getLogger();
48
+        $this->helper = $helper;
49
+        $this->deletedUsersIndex = $deletedUsersIndex;
50
+        foreach ($serverContainer->getUserManager()->getBackends() as $backend){
51
+            $this->logger->debug('instance '.get_class($backend).' backend.', ['app' => 'user_ldap']);
52
+            if ($backend instanceof IUserLDAP) {
53
+                $this->backend = $backend;
54
+                return;
55
+            }
56 56
         }
57
-		throw new \Exception('To use the LDAPProvider, user_ldap app must be enabled');
58
-	}
57
+        throw new \Exception('To use the LDAPProvider, user_ldap app must be enabled');
58
+    }
59 59
 	
60
-	/**
61
-	 * Translate an user id to LDAP DN
62
-	 * @param string $uid user id
63
-	 * @return string with the LDAP DN
64
-	 * @throws \Exception if translation was unsuccessful
65
-	 */
66
-	public function getUserDN($uid) {
67
-		if(!$this->backend->userExists($uid)){
68
-			throw new \Exception('User id not found in LDAP');
69
-		}
70
-		$result = $this->backend->getLDAPAccess($uid)->username2dn($uid);
71
-		if(!$result){
72
-			throw new \Exception('Translation to LDAP DN unsuccessful');
73
-		}
74
-		return $result;
75
-	}
60
+    /**
61
+     * Translate an user id to LDAP DN
62
+     * @param string $uid user id
63
+     * @return string with the LDAP DN
64
+     * @throws \Exception if translation was unsuccessful
65
+     */
66
+    public function getUserDN($uid) {
67
+        if(!$this->backend->userExists($uid)){
68
+            throw new \Exception('User id not found in LDAP');
69
+        }
70
+        $result = $this->backend->getLDAPAccess($uid)->username2dn($uid);
71
+        if(!$result){
72
+            throw new \Exception('Translation to LDAP DN unsuccessful');
73
+        }
74
+        return $result;
75
+    }
76 76
 	
77
-	/**
78
-	 * Translate a LDAP DN to an internal user name. If there is no mapping between 
79
-	 * the DN and the user name, a new one will be created.
80
-	 * @param string $dn LDAP DN
81
-	 * @return string with the internal user name
82
-	 * @throws \Exception if translation was unsuccessful
83
-	 */
84
-	public function getUserName($dn) {
85
-		$result = $this->backend->dn2UserName($dn);
86
-		if(!$result){
87
-			throw new \Exception('Translation to internal user name unsuccessful');
88
-		}
89
-		return $result;
90
-	}
77
+    /**
78
+     * Translate a LDAP DN to an internal user name. If there is no mapping between 
79
+     * the DN and the user name, a new one will be created.
80
+     * @param string $dn LDAP DN
81
+     * @return string with the internal user name
82
+     * @throws \Exception if translation was unsuccessful
83
+     */
84
+    public function getUserName($dn) {
85
+        $result = $this->backend->dn2UserName($dn);
86
+        if(!$result){
87
+            throw new \Exception('Translation to internal user name unsuccessful');
88
+        }
89
+        return $result;
90
+    }
91 91
 	
92
-	/**
93
-	 * Convert a stored DN so it can be used as base parameter for LDAP queries.
94
-	 * @param string $dn the DN in question
95
-	 * @return string
96
-	 */
97
-	public function DNasBaseParameter($dn) {
98
-		return $this->helper->DNasBaseParameter($dn);
99
-	}
92
+    /**
93
+     * Convert a stored DN so it can be used as base parameter for LDAP queries.
94
+     * @param string $dn the DN in question
95
+     * @return string
96
+     */
97
+    public function DNasBaseParameter($dn) {
98
+        return $this->helper->DNasBaseParameter($dn);
99
+    }
100 100
 	
101
-	/**
102
-	 * Sanitize a DN received from the LDAP server.
103
-	 * @param array $dn the DN in question
104
-	 * @return array the sanitized DN
105
-	 */
106
-	public function sanitizeDN($dn) {
107
-		return $this->helper->sanitizeDN($dn);
108
-	}
101
+    /**
102
+     * Sanitize a DN received from the LDAP server.
103
+     * @param array $dn the DN in question
104
+     * @return array the sanitized DN
105
+     */
106
+    public function sanitizeDN($dn) {
107
+        return $this->helper->sanitizeDN($dn);
108
+    }
109 109
 	
110
-	/**
111
-	 * Return a new LDAP connection resource for the specified user. 
112
-	 * The connection must be closed manually.
113
-	 * @param string $uid user id
114
-	 * @return resource of the LDAP connection
115
-	 * @throws \Exception if user id was not found in LDAP
116
-	 */
117
-	public function getLDAPConnection($uid) {
118
-		if(!$this->backend->userExists($uid)){
119
-			throw new \Exception('User id not found in LDAP');
120
-		}
121
-		return $this->backend->getNewLDAPConnection($uid);
122
-	}
110
+    /**
111
+     * Return a new LDAP connection resource for the specified user. 
112
+     * The connection must be closed manually.
113
+     * @param string $uid user id
114
+     * @return resource of the LDAP connection
115
+     * @throws \Exception if user id was not found in LDAP
116
+     */
117
+    public function getLDAPConnection($uid) {
118
+        if(!$this->backend->userExists($uid)){
119
+            throw new \Exception('User id not found in LDAP');
120
+        }
121
+        return $this->backend->getNewLDAPConnection($uid);
122
+    }
123 123
 	
124
-	/**
125
-	 * Get the LDAP base for users.
126
-	 * @param string $uid user id
127
-	 * @return string the base for users
128
-	 * @throws \Exception if user id was not found in LDAP
129
-	 */
130
-	public function getLDAPBaseUsers($uid) {
131
-		if(!$this->backend->userExists($uid)){
132
-			throw new \Exception('User id not found in LDAP');
133
-		}	
134
-		return $this->backend->getLDAPAccess($uid)->getConnection()->getConfiguration()['ldap_base_users'];
135
-	}
124
+    /**
125
+     * Get the LDAP base for users.
126
+     * @param string $uid user id
127
+     * @return string the base for users
128
+     * @throws \Exception if user id was not found in LDAP
129
+     */
130
+    public function getLDAPBaseUsers($uid) {
131
+        if(!$this->backend->userExists($uid)){
132
+            throw new \Exception('User id not found in LDAP');
133
+        }	
134
+        return $this->backend->getLDAPAccess($uid)->getConnection()->getConfiguration()['ldap_base_users'];
135
+    }
136 136
 	
137
-	/**
138
-	 * Get the LDAP base for groups.
139
-	 * @param string $uid user id
140
-	 * @return string the base for groups
141
-	 * @throws \Exception if user id was not found in LDAP
142
-	 */
143
-	public function getLDAPBaseGroups($uid) {
144
-		if(!$this->backend->userExists($uid)){
145
-			throw new \Exception('User id not found in LDAP');
146
-		}
147
-		return $this->backend->getLDAPAccess($uid)->getConnection()->getConfiguration()['ldap_base_groups'];
148
-	}
137
+    /**
138
+     * Get the LDAP base for groups.
139
+     * @param string $uid user id
140
+     * @return string the base for groups
141
+     * @throws \Exception if user id was not found in LDAP
142
+     */
143
+    public function getLDAPBaseGroups($uid) {
144
+        if(!$this->backend->userExists($uid)){
145
+            throw new \Exception('User id not found in LDAP');
146
+        }
147
+        return $this->backend->getLDAPAccess($uid)->getConnection()->getConfiguration()['ldap_base_groups'];
148
+    }
149 149
 	
150
-	/**
151
-	 * Clear the cache if a cache is used, otherwise do nothing.
152
-	 * @param string $uid user id
153
-	 * @throws \Exception if user id was not found in LDAP
154
-	 */
155
-	public function clearCache($uid) {
156
-		if(!$this->backend->userExists($uid)){
157
-			throw new \Exception('User id not found in LDAP');
158
-		}
159
-		$this->backend->getLDAPAccess($uid)->getConnection()->clearCache();
160
-	}
150
+    /**
151
+     * Clear the cache if a cache is used, otherwise do nothing.
152
+     * @param string $uid user id
153
+     * @throws \Exception if user id was not found in LDAP
154
+     */
155
+    public function clearCache($uid) {
156
+        if(!$this->backend->userExists($uid)){
157
+            throw new \Exception('User id not found in LDAP');
158
+        }
159
+        $this->backend->getLDAPAccess($uid)->getConnection()->clearCache();
160
+    }
161 161
 	
162
-	/**
163
-	 * Check whether a LDAP DN exists
164
-	 * @param string $dn LDAP DN
165
-	 * @return bool whether the DN exists
166
-	 */
167
-	public function dnExists($dn) {
168
-		$result = $this->backend->dn2UserName($dn);
169
-		return !$result ? false : true;
170
-	}
162
+    /**
163
+     * Check whether a LDAP DN exists
164
+     * @param string $dn LDAP DN
165
+     * @return bool whether the DN exists
166
+     */
167
+    public function dnExists($dn) {
168
+        $result = $this->backend->dn2UserName($dn);
169
+        return !$result ? false : true;
170
+    }
171 171
 	
172
-	/**
173
-	 * Flag record for deletion.
174
-	 * @param string $uid user id
175
-	 */
176
-	public function flagRecord($uid) {
177
-		$this->deletedUsersIndex->markUser($uid);
178
-	}
172
+    /**
173
+     * Flag record for deletion.
174
+     * @param string $uid user id
175
+     */
176
+    public function flagRecord($uid) {
177
+        $this->deletedUsersIndex->markUser($uid);
178
+    }
179 179
 	
180
-	/**
181
-	 * Unflag record for deletion.
182
-	 * @param string $uid user id
183
-	 */
184
-	public function unflagRecord($uid) {
185
-		//do nothing
186
-	}
180
+    /**
181
+     * Unflag record for deletion.
182
+     * @param string $uid user id
183
+     */
184
+    public function unflagRecord($uid) {
185
+        //do nothing
186
+    }
187 187
 }
Please login to merge, or discard this patch.
apps/user_ldap/lib/User_LDAP.php 1 patch
Indentation   +485 added lines, -485 removed lines patch added patch discarded remove patch
@@ -44,492 +44,492 @@
 block discarded – undo
44 44
 use OCP\Util;
45 45
 
46 46
 class User_LDAP extends BackendUtility implements \OCP\IUserBackend, \OCP\UserInterface, IUserLDAP {
47
-	/** @var string[] $homesToKill */
48
-	protected $homesToKill = array();
49
-
50
-	/** @var \OCP\IConfig */
51
-	protected $ocConfig;
52
-
53
-	/**
54
-	 * @param Access $access
55
-	 * @param \OCP\IConfig $ocConfig
56
-	 */
57
-	public function __construct(Access $access, IConfig $ocConfig) {
58
-		parent::__construct($access);
59
-		$this->ocConfig = $ocConfig;
60
-	}
61
-
62
-	/**
63
-	 * checks whether the user is allowed to change his avatar in ownCloud
64
-	 * @param string $uid the ownCloud user name
65
-	 * @return boolean either the user can or cannot
66
-	 */
67
-	public function canChangeAvatar($uid) {
68
-		$user = $this->access->userManager->get($uid);
69
-		if(!$user instanceof User) {
70
-			return false;
71
-		}
72
-		if($user->getAvatarImage() === false) {
73
-			return true;
74
-		}
75
-
76
-		return false;
77
-	}
78
-
79
-	/**
80
-	 * returns the username for the given login name, if available
81
-	 *
82
-	 * @param string $loginName
83
-	 * @return string|false
84
-	 */
85
-	public function loginName2UserName($loginName) {
86
-		$cacheKey = 'loginName2UserName-'.$loginName;
87
-		$username = $this->access->connection->getFromCache($cacheKey);
88
-		if(!is_null($username)) {
89
-			return $username;
90
-		}
91
-
92
-		try {
93
-			$ldapRecord = $this->getLDAPUserByLoginName($loginName);
94
-			$user = $this->access->userManager->get($ldapRecord['dn'][0]);
95
-			if($user instanceof OfflineUser) {
96
-				// this path is not really possible, however get() is documented
97
-				// to return User or OfflineUser so we are very defensive here.
98
-				$this->access->connection->writeToCache($cacheKey, false);
99
-				return false;
100
-			}
101
-			$username = $user->getUsername();
102
-			$this->access->connection->writeToCache($cacheKey, $username);
103
-			return $username;
104
-		} catch (NotOnLDAP $e) {
105
-			$this->access->connection->writeToCache($cacheKey, false);
106
-			return false;
107
-		}
108
-	}
47
+    /** @var string[] $homesToKill */
48
+    protected $homesToKill = array();
49
+
50
+    /** @var \OCP\IConfig */
51
+    protected $ocConfig;
52
+
53
+    /**
54
+     * @param Access $access
55
+     * @param \OCP\IConfig $ocConfig
56
+     */
57
+    public function __construct(Access $access, IConfig $ocConfig) {
58
+        parent::__construct($access);
59
+        $this->ocConfig = $ocConfig;
60
+    }
61
+
62
+    /**
63
+     * checks whether the user is allowed to change his avatar in ownCloud
64
+     * @param string $uid the ownCloud user name
65
+     * @return boolean either the user can or cannot
66
+     */
67
+    public function canChangeAvatar($uid) {
68
+        $user = $this->access->userManager->get($uid);
69
+        if(!$user instanceof User) {
70
+            return false;
71
+        }
72
+        if($user->getAvatarImage() === false) {
73
+            return true;
74
+        }
75
+
76
+        return false;
77
+    }
78
+
79
+    /**
80
+     * returns the username for the given login name, if available
81
+     *
82
+     * @param string $loginName
83
+     * @return string|false
84
+     */
85
+    public function loginName2UserName($loginName) {
86
+        $cacheKey = 'loginName2UserName-'.$loginName;
87
+        $username = $this->access->connection->getFromCache($cacheKey);
88
+        if(!is_null($username)) {
89
+            return $username;
90
+        }
91
+
92
+        try {
93
+            $ldapRecord = $this->getLDAPUserByLoginName($loginName);
94
+            $user = $this->access->userManager->get($ldapRecord['dn'][0]);
95
+            if($user instanceof OfflineUser) {
96
+                // this path is not really possible, however get() is documented
97
+                // to return User or OfflineUser so we are very defensive here.
98
+                $this->access->connection->writeToCache($cacheKey, false);
99
+                return false;
100
+            }
101
+            $username = $user->getUsername();
102
+            $this->access->connection->writeToCache($cacheKey, $username);
103
+            return $username;
104
+        } catch (NotOnLDAP $e) {
105
+            $this->access->connection->writeToCache($cacheKey, false);
106
+            return false;
107
+        }
108
+    }
109 109
 	
110
-	/**
111
-	 * returns the username for the given LDAP DN, if available
112
-	 *
113
-	 * @param string $dn
114
-	 * @return string|false with the username
115
-	 */
116
-	public function dn2UserName($dn) {
117
-		return $this->access->dn2username($dn);
118
-	}
119
-
120
-	/**
121
-	 * returns an LDAP record based on a given login name
122
-	 *
123
-	 * @param string $loginName
124
-	 * @return array
125
-	 * @throws NotOnLDAP
126
-	 */
127
-	public function getLDAPUserByLoginName($loginName) {
128
-		//find out dn of the user name
129
-		$attrs = $this->access->userManager->getAttributes();
130
-		$users = $this->access->fetchUsersByLoginName($loginName, $attrs);
131
-		if(count($users) < 1) {
132
-			throw new NotOnLDAP('No user available for the given login name on ' .
133
-				$this->access->connection->ldapHost . ':' . $this->access->connection->ldapPort);
134
-		}
135
-		return $users[0];
136
-	}
137
-
138
-	/**
139
-	 * Check if the password is correct without logging in the user
140
-	 *
141
-	 * @param string $uid The username
142
-	 * @param string $password The password
143
-	 * @return false|string
144
-	 */
145
-	public function checkPassword($uid, $password) {
146
-		try {
147
-			$ldapRecord = $this->getLDAPUserByLoginName($uid);
148
-		} catch(NotOnLDAP $e) {
149
-			if($this->ocConfig->getSystemValue('loglevel', Util::WARN) === Util::DEBUG) {
150
-				\OC::$server->getLogger()->logException($e, ['app' => 'user_ldap']);
151
-			}
152
-			return false;
153
-		}
154
-		$dn = $ldapRecord['dn'][0];
155
-		$user = $this->access->userManager->get($dn);
156
-
157
-		if(!$user instanceof User) {
158
-			Util::writeLog('user_ldap',
159
-				'LDAP Login: Could not get user object for DN ' . $dn .
160
-				'. Maybe the LDAP entry has no set display name attribute?',
161
-				Util::WARN);
162
-			return false;
163
-		}
164
-		if($user->getUsername() !== false) {
165
-			//are the credentials OK?
166
-			if(!$this->access->areCredentialsValid($dn, $password)) {
167
-				return false;
168
-			}
169
-
170
-			$this->access->cacheUserExists($user->getUsername());
171
-			$user->processAttributes($ldapRecord);
172
-			$user->markLogin();
173
-
174
-			return $user->getUsername();
175
-		}
176
-
177
-		return false;
178
-	}
179
-
180
-	/**
181
-	 * Set password
182
-	 * @param string $uid The username
183
-	 * @param string $password The new password
184
-	 * @return bool
185
-	 */
186
-	public function setPassword($uid, $password) {
187
-		$user = $this->access->userManager->get($uid);
188
-
189
-		if(!$user instanceof User) {
190
-			throw new \Exception('LDAP setPassword: Could not get user object for uid ' . $uid .
191
-				'. Maybe the LDAP entry has no set display name attribute?');
192
-		}
193
-		if($user->getUsername() !== false) {
194
-			return $this->access->setPassword($user->getDN(), $password);
195
-		}
196
-
197
-		return false;
198
-	}
199
-
200
-	/**
201
-	 * Get a list of all users
202
-	 *
203
-	 * @param string $search
204
-	 * @param integer $limit
205
-	 * @param integer $offset
206
-	 * @return string[] an array of all uids
207
-	 */
208
-	public function getUsers($search = '', $limit = 10, $offset = 0) {
209
-		$search = $this->access->escapeFilterPart($search, true);
210
-		$cachekey = 'getUsers-'.$search.'-'.$limit.'-'.$offset;
211
-
212
-		//check if users are cached, if so return
213
-		$ldap_users = $this->access->connection->getFromCache($cachekey);
214
-		if(!is_null($ldap_users)) {
215
-			return $ldap_users;
216
-		}
217
-
218
-		// if we'd pass -1 to LDAP search, we'd end up in a Protocol
219
-		// error. With a limit of 0, we get 0 results. So we pass null.
220
-		if($limit <= 0) {
221
-			$limit = null;
222
-		}
223
-		$filter = $this->access->combineFilterWithAnd(array(
224
-			$this->access->connection->ldapUserFilter,
225
-			$this->access->connection->ldapUserDisplayName . '=*',
226
-			$this->access->getFilterPartForUserSearch($search)
227
-		));
228
-
229
-		Util::writeLog('user_ldap',
230
-			'getUsers: Options: search '.$search.' limit '.$limit.' offset '.$offset.' Filter: '.$filter,
231
-			Util::DEBUG);
232
-		//do the search and translate results to owncloud names
233
-		$ldap_users = $this->access->fetchListOfUsers(
234
-			$filter,
235
-			$this->access->userManager->getAttributes(true),
236
-			$limit, $offset);
237
-		$ldap_users = $this->access->ownCloudUserNames($ldap_users);
238
-		Util::writeLog('user_ldap', 'getUsers: '.count($ldap_users). ' Users found', Util::DEBUG);
239
-
240
-		$this->access->connection->writeToCache($cachekey, $ldap_users);
241
-		return $ldap_users;
242
-	}
243
-
244
-	/**
245
-	 * checks whether a user is still available on LDAP
246
-	 *
247
-	 * @param string|\OCA\User_LDAP\User\User $user either the ownCloud user
248
-	 * name or an instance of that user
249
-	 * @return bool
250
-	 * @throws \Exception
251
-	 * @throws \OC\ServerNotAvailableException
252
-	 */
253
-	public function userExistsOnLDAP($user) {
254
-		if(is_string($user)) {
255
-			$user = $this->access->userManager->get($user);
256
-		}
257
-		if(is_null($user)) {
258
-			return false;
259
-		}
260
-
261
-		$dn = $user->getDN();
262
-		//check if user really still exists by reading its entry
263
-		if(!is_array($this->access->readAttribute($dn, '', $this->access->connection->ldapUserFilter))) {
264
-			$lcr = $this->access->connection->getConnectionResource();
265
-			if(is_null($lcr)) {
266
-				throw new \Exception('No LDAP Connection to server ' . $this->access->connection->ldapHost);
267
-			}
268
-
269
-			try {
270
-				$uuid = $this->access->getUserMapper()->getUUIDByDN($dn);
271
-				if(!$uuid) {
272
-					return false;
273
-				}
274
-				$newDn = $this->access->getUserDnByUuid($uuid);
275
-				//check if renamed user is still valid by reapplying the ldap filter
276
-				if(!is_array($this->access->readAttribute($newDn, '', $this->access->connection->ldapUserFilter))) {
277
-					return false;
278
-				}
279
-				$this->access->getUserMapper()->setDNbyUUID($newDn, $uuid);
280
-				return true;
281
-			} catch (\Exception $e) {
282
-				return false;
283
-			}
284
-		}
285
-
286
-		if($user instanceof OfflineUser) {
287
-			$user->unmark();
288
-		}
289
-
290
-		return true;
291
-	}
292
-
293
-	/**
294
-	 * check if a user exists
295
-	 * @param string $uid the username
296
-	 * @return boolean
297
-	 * @throws \Exception when connection could not be established
298
-	 */
299
-	public function userExists($uid) {
300
-		$userExists = $this->access->connection->getFromCache('userExists'.$uid);
301
-		if(!is_null($userExists)) {
302
-			return (bool)$userExists;
303
-		}
304
-		//getting dn, if false the user does not exist. If dn, he may be mapped only, requires more checking.
305
-		$user = $this->access->userManager->get($uid);
306
-
307
-		if(is_null($user)) {
308
-			Util::writeLog('user_ldap', 'No DN found for '.$uid.' on '.
309
-				$this->access->connection->ldapHost, Util::DEBUG);
310
-			$this->access->connection->writeToCache('userExists'.$uid, false);
311
-			return false;
312
-		} else if($user instanceof OfflineUser) {
313
-			//express check for users marked as deleted. Returning true is
314
-			//necessary for cleanup
315
-			return true;
316
-		}
317
-
318
-		$result = $this->userExistsOnLDAP($user);
319
-		$this->access->connection->writeToCache('userExists'.$uid, $result);
320
-		if($result === true) {
321
-			$user->update();
322
-		}
323
-		return $result;
324
-	}
325
-
326
-	/**
327
-	* returns whether a user was deleted in LDAP
328
-	*
329
-	* @param string $uid The username of the user to delete
330
-	* @return bool
331
-	*/
332
-	public function deleteUser($uid) {
333
-		$marked = $this->ocConfig->getUserValue($uid, 'user_ldap', 'isDeleted', 0);
334
-		if(intval($marked) === 0) {
335
-			\OC::$server->getLogger()->notice(
336
-				'User '.$uid . ' is not marked as deleted, not cleaning up.',
337
-				array('app' => 'user_ldap'));
338
-			return false;
339
-		}
340
-		\OC::$server->getLogger()->info('Cleaning up after user ' . $uid,
341
-			array('app' => 'user_ldap'));
342
-
343
-		//Get Home Directory out of user preferences so we can return it later,
344
-		//necessary for removing directories as done by OC_User.
345
-		$home = $this->ocConfig->getUserValue($uid, 'user_ldap', 'homePath', '');
346
-		$this->homesToKill[$uid] = $home;
347
-		$this->access->getUserMapper()->unmap($uid);
348
-
349
-		return true;
350
-	}
351
-
352
-	/**
353
-	 * get the user's home directory
354
-	 *
355
-	 * @param string $uid the username
356
-	 * @return bool|string
357
-	 * @throws NoUserException
358
-	 * @throws \Exception
359
-	 */
360
-	public function getHome($uid) {
361
-		if(isset($this->homesToKill[$uid]) && !empty($this->homesToKill[$uid])) {
362
-			//a deleted user who needs some clean up
363
-			return $this->homesToKill[$uid];
364
-		}
365
-
366
-		// user Exists check required as it is not done in user proxy!
367
-		if(!$this->userExists($uid)) {
368
-			return false;
369
-		}
370
-
371
-		$cacheKey = 'getHome'.$uid;
372
-		$path = $this->access->connection->getFromCache($cacheKey);
373
-		if(!is_null($path)) {
374
-			return $path;
375
-		}
376
-
377
-		$user = $this->access->userManager->get($uid);
378
-		if(is_null($user) || ($user instanceof OfflineUser && !$this->userExistsOnLDAP($user->getOCName()))) {
379
-			throw new NoUserException($uid . ' is not a valid user anymore');
380
-		}
381
-		if($user instanceof OfflineUser) {
382
-			// apparently this user survived the userExistsOnLDAP check,
383
-			// we request the user instance again in order to retrieve a User
384
-			// instance instead
385
-			$user = $this->access->userManager->get($uid);
386
-		}
387
-		$path = $user->getHomePath();
388
-		$this->access->cacheUserHome($uid, $path);
389
-
390
-		return $path;
391
-	}
392
-
393
-	/**
394
-	 * get display name of the user
395
-	 * @param string $uid user ID of the user
396
-	 * @return string|false display name
397
-	 */
398
-	public function getDisplayName($uid) {
399
-		if(!$this->userExists($uid)) {
400
-			return false;
401
-		}
402
-
403
-		$cacheKey = 'getDisplayName'.$uid;
404
-		if(!is_null($displayName = $this->access->connection->getFromCache($cacheKey))) {
405
-			return $displayName;
406
-		}
407
-
408
-		//Check whether the display name is configured to have a 2nd feature
409
-		$additionalAttribute = $this->access->connection->ldapUserDisplayName2;
410
-		$displayName2 = '';
411
-		if ($additionalAttribute !== '') {
412
-			$displayName2 = $this->access->readAttribute(
413
-				$this->access->username2dn($uid),
414
-				$additionalAttribute);
415
-		}
416
-
417
-		$displayName = $this->access->readAttribute(
418
-			$this->access->username2dn($uid),
419
-			$this->access->connection->ldapUserDisplayName);
420
-
421
-		if($displayName && (count($displayName) > 0)) {
422
-			$displayName = $displayName[0];
423
-
424
-			if (is_array($displayName2)){
425
-				$displayName2 = count($displayName2) > 0 ? $displayName2[0] : '';
426
-			}
427
-
428
-			$user = $this->access->userManager->get($uid);
429
-			if ($user instanceof User) {
430
-				$displayName = $user->composeAndStoreDisplayName($displayName, $displayName2);
431
-				$this->access->connection->writeToCache($cacheKey, $displayName);
432
-			}
433
-			if ($user instanceof OfflineUser) {
434
-				/** @var OfflineUser $user*/
435
-				$displayName = $user->getDisplayName();
436
-			}
437
-			return $displayName;
438
-		}
439
-
440
-		return null;
441
-	}
442
-
443
-	/**
444
-	 * Get a list of all display names
445
-	 *
446
-	 * @param string $search
447
-	 * @param string|null $limit
448
-	 * @param string|null $offset
449
-	 * @return array an array of all displayNames (value) and the corresponding uids (key)
450
-	 */
451
-	public function getDisplayNames($search = '', $limit = null, $offset = null) {
452
-		$cacheKey = 'getDisplayNames-'.$search.'-'.$limit.'-'.$offset;
453
-		if(!is_null($displayNames = $this->access->connection->getFromCache($cacheKey))) {
454
-			return $displayNames;
455
-		}
456
-
457
-		$displayNames = array();
458
-		$users = $this->getUsers($search, $limit, $offset);
459
-		foreach ($users as $user) {
460
-			$displayNames[$user] = $this->getDisplayName($user);
461
-		}
462
-		$this->access->connection->writeToCache($cacheKey, $displayNames);
463
-		return $displayNames;
464
-	}
465
-
466
-	/**
467
-	* Check if backend implements actions
468
-	* @param int $actions bitwise-or'ed actions
469
-	* @return boolean
470
-	*
471
-	* Returns the supported actions as int to be
472
-	* compared with OC_USER_BACKEND_CREATE_USER etc.
473
-	*/
474
-	public function implementsActions($actions) {
475
-		return (bool)((Backend::CHECK_PASSWORD
476
-			| Backend::GET_HOME
477
-			| Backend::GET_DISPLAYNAME
478
-			| Backend::PROVIDE_AVATAR
479
-			| Backend::COUNT_USERS
480
-			| ((intval($this->access->connection->turnOnPasswordChange) === 1)?(Backend::SET_PASSWORD):0))
481
-			& $actions);
482
-	}
483
-
484
-	/**
485
-	 * @return bool
486
-	 */
487
-	public function hasUserListings() {
488
-		return true;
489
-	}
490
-
491
-	/**
492
-	 * counts the users in LDAP
493
-	 *
494
-	 * @return int|bool
495
-	 */
496
-	public function countUsers() {
497
-		$filter = $this->access->getFilterForUserCount();
498
-		$cacheKey = 'countUsers-'.$filter;
499
-		if(!is_null($entries = $this->access->connection->getFromCache($cacheKey))) {
500
-			return $entries;
501
-		}
502
-		$entries = $this->access->countUsers($filter);
503
-		$this->access->connection->writeToCache($cacheKey, $entries);
504
-		return $entries;
505
-	}
506
-
507
-	/**
508
-	 * Backend name to be shown in user management
509
-	 * @return string the name of the backend to be shown
510
-	 */
511
-	public function getBackendName(){
512
-		return 'LDAP';
513
-	}
110
+    /**
111
+     * returns the username for the given LDAP DN, if available
112
+     *
113
+     * @param string $dn
114
+     * @return string|false with the username
115
+     */
116
+    public function dn2UserName($dn) {
117
+        return $this->access->dn2username($dn);
118
+    }
119
+
120
+    /**
121
+     * returns an LDAP record based on a given login name
122
+     *
123
+     * @param string $loginName
124
+     * @return array
125
+     * @throws NotOnLDAP
126
+     */
127
+    public function getLDAPUserByLoginName($loginName) {
128
+        //find out dn of the user name
129
+        $attrs = $this->access->userManager->getAttributes();
130
+        $users = $this->access->fetchUsersByLoginName($loginName, $attrs);
131
+        if(count($users) < 1) {
132
+            throw new NotOnLDAP('No user available for the given login name on ' .
133
+                $this->access->connection->ldapHost . ':' . $this->access->connection->ldapPort);
134
+        }
135
+        return $users[0];
136
+    }
137
+
138
+    /**
139
+     * Check if the password is correct without logging in the user
140
+     *
141
+     * @param string $uid The username
142
+     * @param string $password The password
143
+     * @return false|string
144
+     */
145
+    public function checkPassword($uid, $password) {
146
+        try {
147
+            $ldapRecord = $this->getLDAPUserByLoginName($uid);
148
+        } catch(NotOnLDAP $e) {
149
+            if($this->ocConfig->getSystemValue('loglevel', Util::WARN) === Util::DEBUG) {
150
+                \OC::$server->getLogger()->logException($e, ['app' => 'user_ldap']);
151
+            }
152
+            return false;
153
+        }
154
+        $dn = $ldapRecord['dn'][0];
155
+        $user = $this->access->userManager->get($dn);
156
+
157
+        if(!$user instanceof User) {
158
+            Util::writeLog('user_ldap',
159
+                'LDAP Login: Could not get user object for DN ' . $dn .
160
+                '. Maybe the LDAP entry has no set display name attribute?',
161
+                Util::WARN);
162
+            return false;
163
+        }
164
+        if($user->getUsername() !== false) {
165
+            //are the credentials OK?
166
+            if(!$this->access->areCredentialsValid($dn, $password)) {
167
+                return false;
168
+            }
169
+
170
+            $this->access->cacheUserExists($user->getUsername());
171
+            $user->processAttributes($ldapRecord);
172
+            $user->markLogin();
173
+
174
+            return $user->getUsername();
175
+        }
176
+
177
+        return false;
178
+    }
179
+
180
+    /**
181
+     * Set password
182
+     * @param string $uid The username
183
+     * @param string $password The new password
184
+     * @return bool
185
+     */
186
+    public function setPassword($uid, $password) {
187
+        $user = $this->access->userManager->get($uid);
188
+
189
+        if(!$user instanceof User) {
190
+            throw new \Exception('LDAP setPassword: Could not get user object for uid ' . $uid .
191
+                '. Maybe the LDAP entry has no set display name attribute?');
192
+        }
193
+        if($user->getUsername() !== false) {
194
+            return $this->access->setPassword($user->getDN(), $password);
195
+        }
196
+
197
+        return false;
198
+    }
199
+
200
+    /**
201
+     * Get a list of all users
202
+     *
203
+     * @param string $search
204
+     * @param integer $limit
205
+     * @param integer $offset
206
+     * @return string[] an array of all uids
207
+     */
208
+    public function getUsers($search = '', $limit = 10, $offset = 0) {
209
+        $search = $this->access->escapeFilterPart($search, true);
210
+        $cachekey = 'getUsers-'.$search.'-'.$limit.'-'.$offset;
211
+
212
+        //check if users are cached, if so return
213
+        $ldap_users = $this->access->connection->getFromCache($cachekey);
214
+        if(!is_null($ldap_users)) {
215
+            return $ldap_users;
216
+        }
217
+
218
+        // if we'd pass -1 to LDAP search, we'd end up in a Protocol
219
+        // error. With a limit of 0, we get 0 results. So we pass null.
220
+        if($limit <= 0) {
221
+            $limit = null;
222
+        }
223
+        $filter = $this->access->combineFilterWithAnd(array(
224
+            $this->access->connection->ldapUserFilter,
225
+            $this->access->connection->ldapUserDisplayName . '=*',
226
+            $this->access->getFilterPartForUserSearch($search)
227
+        ));
228
+
229
+        Util::writeLog('user_ldap',
230
+            'getUsers: Options: search '.$search.' limit '.$limit.' offset '.$offset.' Filter: '.$filter,
231
+            Util::DEBUG);
232
+        //do the search and translate results to owncloud names
233
+        $ldap_users = $this->access->fetchListOfUsers(
234
+            $filter,
235
+            $this->access->userManager->getAttributes(true),
236
+            $limit, $offset);
237
+        $ldap_users = $this->access->ownCloudUserNames($ldap_users);
238
+        Util::writeLog('user_ldap', 'getUsers: '.count($ldap_users). ' Users found', Util::DEBUG);
239
+
240
+        $this->access->connection->writeToCache($cachekey, $ldap_users);
241
+        return $ldap_users;
242
+    }
243
+
244
+    /**
245
+     * checks whether a user is still available on LDAP
246
+     *
247
+     * @param string|\OCA\User_LDAP\User\User $user either the ownCloud user
248
+     * name or an instance of that user
249
+     * @return bool
250
+     * @throws \Exception
251
+     * @throws \OC\ServerNotAvailableException
252
+     */
253
+    public function userExistsOnLDAP($user) {
254
+        if(is_string($user)) {
255
+            $user = $this->access->userManager->get($user);
256
+        }
257
+        if(is_null($user)) {
258
+            return false;
259
+        }
260
+
261
+        $dn = $user->getDN();
262
+        //check if user really still exists by reading its entry
263
+        if(!is_array($this->access->readAttribute($dn, '', $this->access->connection->ldapUserFilter))) {
264
+            $lcr = $this->access->connection->getConnectionResource();
265
+            if(is_null($lcr)) {
266
+                throw new \Exception('No LDAP Connection to server ' . $this->access->connection->ldapHost);
267
+            }
268
+
269
+            try {
270
+                $uuid = $this->access->getUserMapper()->getUUIDByDN($dn);
271
+                if(!$uuid) {
272
+                    return false;
273
+                }
274
+                $newDn = $this->access->getUserDnByUuid($uuid);
275
+                //check if renamed user is still valid by reapplying the ldap filter
276
+                if(!is_array($this->access->readAttribute($newDn, '', $this->access->connection->ldapUserFilter))) {
277
+                    return false;
278
+                }
279
+                $this->access->getUserMapper()->setDNbyUUID($newDn, $uuid);
280
+                return true;
281
+            } catch (\Exception $e) {
282
+                return false;
283
+            }
284
+        }
285
+
286
+        if($user instanceof OfflineUser) {
287
+            $user->unmark();
288
+        }
289
+
290
+        return true;
291
+    }
292
+
293
+    /**
294
+     * check if a user exists
295
+     * @param string $uid the username
296
+     * @return boolean
297
+     * @throws \Exception when connection could not be established
298
+     */
299
+    public function userExists($uid) {
300
+        $userExists = $this->access->connection->getFromCache('userExists'.$uid);
301
+        if(!is_null($userExists)) {
302
+            return (bool)$userExists;
303
+        }
304
+        //getting dn, if false the user does not exist. If dn, he may be mapped only, requires more checking.
305
+        $user = $this->access->userManager->get($uid);
306
+
307
+        if(is_null($user)) {
308
+            Util::writeLog('user_ldap', 'No DN found for '.$uid.' on '.
309
+                $this->access->connection->ldapHost, Util::DEBUG);
310
+            $this->access->connection->writeToCache('userExists'.$uid, false);
311
+            return false;
312
+        } else if($user instanceof OfflineUser) {
313
+            //express check for users marked as deleted. Returning true is
314
+            //necessary for cleanup
315
+            return true;
316
+        }
317
+
318
+        $result = $this->userExistsOnLDAP($user);
319
+        $this->access->connection->writeToCache('userExists'.$uid, $result);
320
+        if($result === true) {
321
+            $user->update();
322
+        }
323
+        return $result;
324
+    }
325
+
326
+    /**
327
+     * returns whether a user was deleted in LDAP
328
+     *
329
+     * @param string $uid The username of the user to delete
330
+     * @return bool
331
+     */
332
+    public function deleteUser($uid) {
333
+        $marked = $this->ocConfig->getUserValue($uid, 'user_ldap', 'isDeleted', 0);
334
+        if(intval($marked) === 0) {
335
+            \OC::$server->getLogger()->notice(
336
+                'User '.$uid . ' is not marked as deleted, not cleaning up.',
337
+                array('app' => 'user_ldap'));
338
+            return false;
339
+        }
340
+        \OC::$server->getLogger()->info('Cleaning up after user ' . $uid,
341
+            array('app' => 'user_ldap'));
342
+
343
+        //Get Home Directory out of user preferences so we can return it later,
344
+        //necessary for removing directories as done by OC_User.
345
+        $home = $this->ocConfig->getUserValue($uid, 'user_ldap', 'homePath', '');
346
+        $this->homesToKill[$uid] = $home;
347
+        $this->access->getUserMapper()->unmap($uid);
348
+
349
+        return true;
350
+    }
351
+
352
+    /**
353
+     * get the user's home directory
354
+     *
355
+     * @param string $uid the username
356
+     * @return bool|string
357
+     * @throws NoUserException
358
+     * @throws \Exception
359
+     */
360
+    public function getHome($uid) {
361
+        if(isset($this->homesToKill[$uid]) && !empty($this->homesToKill[$uid])) {
362
+            //a deleted user who needs some clean up
363
+            return $this->homesToKill[$uid];
364
+        }
365
+
366
+        // user Exists check required as it is not done in user proxy!
367
+        if(!$this->userExists($uid)) {
368
+            return false;
369
+        }
370
+
371
+        $cacheKey = 'getHome'.$uid;
372
+        $path = $this->access->connection->getFromCache($cacheKey);
373
+        if(!is_null($path)) {
374
+            return $path;
375
+        }
376
+
377
+        $user = $this->access->userManager->get($uid);
378
+        if(is_null($user) || ($user instanceof OfflineUser && !$this->userExistsOnLDAP($user->getOCName()))) {
379
+            throw new NoUserException($uid . ' is not a valid user anymore');
380
+        }
381
+        if($user instanceof OfflineUser) {
382
+            // apparently this user survived the userExistsOnLDAP check,
383
+            // we request the user instance again in order to retrieve a User
384
+            // instance instead
385
+            $user = $this->access->userManager->get($uid);
386
+        }
387
+        $path = $user->getHomePath();
388
+        $this->access->cacheUserHome($uid, $path);
389
+
390
+        return $path;
391
+    }
392
+
393
+    /**
394
+     * get display name of the user
395
+     * @param string $uid user ID of the user
396
+     * @return string|false display name
397
+     */
398
+    public function getDisplayName($uid) {
399
+        if(!$this->userExists($uid)) {
400
+            return false;
401
+        }
402
+
403
+        $cacheKey = 'getDisplayName'.$uid;
404
+        if(!is_null($displayName = $this->access->connection->getFromCache($cacheKey))) {
405
+            return $displayName;
406
+        }
407
+
408
+        //Check whether the display name is configured to have a 2nd feature
409
+        $additionalAttribute = $this->access->connection->ldapUserDisplayName2;
410
+        $displayName2 = '';
411
+        if ($additionalAttribute !== '') {
412
+            $displayName2 = $this->access->readAttribute(
413
+                $this->access->username2dn($uid),
414
+                $additionalAttribute);
415
+        }
416
+
417
+        $displayName = $this->access->readAttribute(
418
+            $this->access->username2dn($uid),
419
+            $this->access->connection->ldapUserDisplayName);
420
+
421
+        if($displayName && (count($displayName) > 0)) {
422
+            $displayName = $displayName[0];
423
+
424
+            if (is_array($displayName2)){
425
+                $displayName2 = count($displayName2) > 0 ? $displayName2[0] : '';
426
+            }
427
+
428
+            $user = $this->access->userManager->get($uid);
429
+            if ($user instanceof User) {
430
+                $displayName = $user->composeAndStoreDisplayName($displayName, $displayName2);
431
+                $this->access->connection->writeToCache($cacheKey, $displayName);
432
+            }
433
+            if ($user instanceof OfflineUser) {
434
+                /** @var OfflineUser $user*/
435
+                $displayName = $user->getDisplayName();
436
+            }
437
+            return $displayName;
438
+        }
439
+
440
+        return null;
441
+    }
442
+
443
+    /**
444
+     * Get a list of all display names
445
+     *
446
+     * @param string $search
447
+     * @param string|null $limit
448
+     * @param string|null $offset
449
+     * @return array an array of all displayNames (value) and the corresponding uids (key)
450
+     */
451
+    public function getDisplayNames($search = '', $limit = null, $offset = null) {
452
+        $cacheKey = 'getDisplayNames-'.$search.'-'.$limit.'-'.$offset;
453
+        if(!is_null($displayNames = $this->access->connection->getFromCache($cacheKey))) {
454
+            return $displayNames;
455
+        }
456
+
457
+        $displayNames = array();
458
+        $users = $this->getUsers($search, $limit, $offset);
459
+        foreach ($users as $user) {
460
+            $displayNames[$user] = $this->getDisplayName($user);
461
+        }
462
+        $this->access->connection->writeToCache($cacheKey, $displayNames);
463
+        return $displayNames;
464
+    }
465
+
466
+    /**
467
+     * Check if backend implements actions
468
+     * @param int $actions bitwise-or'ed actions
469
+     * @return boolean
470
+     *
471
+     * Returns the supported actions as int to be
472
+     * compared with OC_USER_BACKEND_CREATE_USER etc.
473
+     */
474
+    public function implementsActions($actions) {
475
+        return (bool)((Backend::CHECK_PASSWORD
476
+            | Backend::GET_HOME
477
+            | Backend::GET_DISPLAYNAME
478
+            | Backend::PROVIDE_AVATAR
479
+            | Backend::COUNT_USERS
480
+            | ((intval($this->access->connection->turnOnPasswordChange) === 1)?(Backend::SET_PASSWORD):0))
481
+            & $actions);
482
+    }
483
+
484
+    /**
485
+     * @return bool
486
+     */
487
+    public function hasUserListings() {
488
+        return true;
489
+    }
490
+
491
+    /**
492
+     * counts the users in LDAP
493
+     *
494
+     * @return int|bool
495
+     */
496
+    public function countUsers() {
497
+        $filter = $this->access->getFilterForUserCount();
498
+        $cacheKey = 'countUsers-'.$filter;
499
+        if(!is_null($entries = $this->access->connection->getFromCache($cacheKey))) {
500
+            return $entries;
501
+        }
502
+        $entries = $this->access->countUsers($filter);
503
+        $this->access->connection->writeToCache($cacheKey, $entries);
504
+        return $entries;
505
+    }
506
+
507
+    /**
508
+     * Backend name to be shown in user management
509
+     * @return string the name of the backend to be shown
510
+     */
511
+    public function getBackendName(){
512
+        return 'LDAP';
513
+    }
514 514
 	
515
-	/**
516
-	 * Return access for LDAP interaction.
517
-	 * @param string $uid
518
-	 * @return Access instance of Access for LDAP interaction
519
-	 */
520
-	public function getLDAPAccess($uid) {
521
-		return $this->access;
522
-	}
515
+    /**
516
+     * Return access for LDAP interaction.
517
+     * @param string $uid
518
+     * @return Access instance of Access for LDAP interaction
519
+     */
520
+    public function getLDAPAccess($uid) {
521
+        return $this->access;
522
+    }
523 523
 	
524
-	/**
525
-	 * Return LDAP connection resource from a cloned connection.
526
-	 * The cloned connection needs to be closed manually.
527
-	 * of the current access.
528
-	 * @param string $uid
529
-	 * @return resource of the LDAP connection
530
-	 */
531
-	public function getNewLDAPConnection($uid) {
532
-		$connection = clone $this->access->getConnection();
533
-		return $connection->getConnectionResource();
534
-	}
524
+    /**
525
+     * Return LDAP connection resource from a cloned connection.
526
+     * The cloned connection needs to be closed manually.
527
+     * of the current access.
528
+     * @param string $uid
529
+     * @return resource of the LDAP connection
530
+     */
531
+    public function getNewLDAPConnection($uid) {
532
+        $connection = clone $this->access->getConnection();
533
+        return $connection->getConnectionResource();
534
+    }
535 535
 }
Please login to merge, or discard this patch.
apps/user_ldap/lib/LogWrapper.php 1 patch
Indentation   +8 added lines, -8 removed lines patch added patch discarded remove patch
@@ -28,13 +28,13 @@
 block discarded – undo
28 28
  * @brief wraps around static ownCloud core methods
29 29
  */
30 30
 class LogWrapper {
31
-	protected $app = 'user_ldap';
31
+    protected $app = 'user_ldap';
32 32
 
33
-	/**
34
-	 * @brief states whether the filesystem was loaded
35
-	 * @return bool
36
-	 */
37
-	public function log($msg, $level) {
38
-		\OCP\Util::writeLog($this->app, $msg, $level);
39
-	}
33
+    /**
34
+     * @brief states whether the filesystem was loaded
35
+     * @return bool
36
+     */
37
+    public function log($msg, $level) {
38
+        \OCP\Util::writeLog($this->app, $msg, $level);
39
+    }
40 40
 }
Please login to merge, or discard this patch.