@@ -34,8 +34,8 @@ |
||
34 | 34 | $prefix = (string)$_POST['ldap_serverconfig_chooser']; |
35 | 35 | $helper = new \OCA\User_LDAP\Helper(\OC::$server->getConfig()); |
36 | 36 | if($helper->deleteServerConfiguration($prefix)) { |
37 | - OCP\JSON::success(); |
|
37 | + OCP\JSON::success(); |
|
38 | 38 | } else { |
39 | - $l = \OC::$server->getL10N('user_ldap'); |
|
40 | - OCP\JSON::error(array('message' => $l->t('Failed to delete the server configuration'))); |
|
39 | + $l = \OC::$server->getL10N('user_ldap'); |
|
40 | + OCP\JSON::error(array('message' => $l->t('Failed to delete the server configuration'))); |
|
41 | 41 | } |
@@ -38,12 +38,12 @@ |
||
38 | 38 | |
39 | 39 | $newConfig = new \OCA\User_LDAP\Configuration($nk, false); |
40 | 40 | if(isset($_POST['copyConfig'])) { |
41 | - $originalConfig = new \OCA\User_LDAP\Configuration($_POST['copyConfig']); |
|
42 | - $newConfig->setConfiguration($originalConfig->getConfiguration()); |
|
41 | + $originalConfig = new \OCA\User_LDAP\Configuration($_POST['copyConfig']); |
|
42 | + $newConfig->setConfiguration($originalConfig->getConfiguration()); |
|
43 | 43 | } else { |
44 | - $configuration = new \OCA\User_LDAP\Configuration($nk, false); |
|
45 | - $newConfig->setConfiguration($configuration->getDefaults()); |
|
46 | - $resultData['defaults'] = $configuration->getDefaults(); |
|
44 | + $configuration = new \OCA\User_LDAP\Configuration($nk, false); |
|
45 | + $newConfig->setConfiguration($configuration->getDefaults()); |
|
46 | + $resultData['defaults'] = $configuration->getDefaults(); |
|
47 | 47 | } |
48 | 48 | $newConfig->saveConfiguration(); |
49 | 49 |
@@ -29,12 +29,12 @@ |
||
29 | 29 | */ |
30 | 30 | class GroupMapping extends AbstractMapping { |
31 | 31 | |
32 | - /** |
|
33 | - * returns the DB table name which holds the mappings |
|
34 | - * @return string |
|
35 | - */ |
|
36 | - protected function getTableName() { |
|
37 | - return '*PREFIX*ldap_group_mapping'; |
|
38 | - } |
|
32 | + /** |
|
33 | + * returns the DB table name which holds the mappings |
|
34 | + * @return string |
|
35 | + */ |
|
36 | + protected function getTableName() { |
|
37 | + return '*PREFIX*ldap_group_mapping'; |
|
38 | + } |
|
39 | 39 | |
40 | 40 | } |
@@ -29,12 +29,12 @@ |
||
29 | 29 | */ |
30 | 30 | class UserMapping extends AbstractMapping { |
31 | 31 | |
32 | - /** |
|
33 | - * returns the DB table name which holds the mappings |
|
34 | - * @return string |
|
35 | - */ |
|
36 | - protected function getTableName() { |
|
37 | - return '*PREFIX*ldap_user_mapping'; |
|
38 | - } |
|
32 | + /** |
|
33 | + * returns the DB table name which holds the mappings |
|
34 | + * @return string |
|
35 | + */ |
|
36 | + protected function getTableName() { |
|
37 | + return '*PREFIX*ldap_user_mapping'; |
|
38 | + } |
|
39 | 39 | |
40 | 40 | } |
@@ -29,252 +29,252 @@ |
||
29 | 29 | * @package OCA\User_LDAP\Mapping |
30 | 30 | */ |
31 | 31 | abstract class AbstractMapping { |
32 | - /** |
|
33 | - * @var \OCP\IDBConnection $dbc |
|
34 | - */ |
|
35 | - protected $dbc; |
|
32 | + /** |
|
33 | + * @var \OCP\IDBConnection $dbc |
|
34 | + */ |
|
35 | + protected $dbc; |
|
36 | 36 | |
37 | - /** |
|
38 | - * returns the DB table name which holds the mappings |
|
39 | - * @return string |
|
40 | - */ |
|
41 | - abstract protected function getTableName(); |
|
37 | + /** |
|
38 | + * returns the DB table name which holds the mappings |
|
39 | + * @return string |
|
40 | + */ |
|
41 | + abstract protected function getTableName(); |
|
42 | 42 | |
43 | - /** |
|
44 | - * @param \OCP\IDBConnection $dbc |
|
45 | - */ |
|
46 | - public function __construct(\OCP\IDBConnection $dbc) { |
|
47 | - $this->dbc = $dbc; |
|
48 | - } |
|
43 | + /** |
|
44 | + * @param \OCP\IDBConnection $dbc |
|
45 | + */ |
|
46 | + public function __construct(\OCP\IDBConnection $dbc) { |
|
47 | + $this->dbc = $dbc; |
|
48 | + } |
|
49 | 49 | |
50 | - /** |
|
51 | - * checks whether a provided string represents an existing table col |
|
52 | - * @param string $col |
|
53 | - * @return bool |
|
54 | - */ |
|
55 | - public function isColNameValid($col) { |
|
56 | - switch($col) { |
|
57 | - case 'ldap_dn': |
|
58 | - case 'owncloud_name': |
|
59 | - case 'directory_uuid': |
|
60 | - return true; |
|
61 | - default: |
|
62 | - return false; |
|
63 | - } |
|
64 | - } |
|
50 | + /** |
|
51 | + * checks whether a provided string represents an existing table col |
|
52 | + * @param string $col |
|
53 | + * @return bool |
|
54 | + */ |
|
55 | + public function isColNameValid($col) { |
|
56 | + switch($col) { |
|
57 | + case 'ldap_dn': |
|
58 | + case 'owncloud_name': |
|
59 | + case 'directory_uuid': |
|
60 | + return true; |
|
61 | + default: |
|
62 | + return false; |
|
63 | + } |
|
64 | + } |
|
65 | 65 | |
66 | - /** |
|
67 | - * Gets the value of one column based on a provided value of another column |
|
68 | - * @param string $fetchCol |
|
69 | - * @param string $compareCol |
|
70 | - * @param string $search |
|
71 | - * @throws \Exception |
|
72 | - * @return string|false |
|
73 | - */ |
|
74 | - protected function getXbyY($fetchCol, $compareCol, $search) { |
|
75 | - if(!$this->isColNameValid($fetchCol)) { |
|
76 | - //this is used internally only, but we don't want to risk |
|
77 | - //having SQL injection at all. |
|
78 | - throw new \Exception('Invalid Column Name'); |
|
79 | - } |
|
80 | - $query = $this->dbc->prepare(' |
|
66 | + /** |
|
67 | + * Gets the value of one column based on a provided value of another column |
|
68 | + * @param string $fetchCol |
|
69 | + * @param string $compareCol |
|
70 | + * @param string $search |
|
71 | + * @throws \Exception |
|
72 | + * @return string|false |
|
73 | + */ |
|
74 | + protected function getXbyY($fetchCol, $compareCol, $search) { |
|
75 | + if(!$this->isColNameValid($fetchCol)) { |
|
76 | + //this is used internally only, but we don't want to risk |
|
77 | + //having SQL injection at all. |
|
78 | + throw new \Exception('Invalid Column Name'); |
|
79 | + } |
|
80 | + $query = $this->dbc->prepare(' |
|
81 | 81 | SELECT `' . $fetchCol . '` |
82 | 82 | FROM `'. $this->getTableName() .'` |
83 | 83 | WHERE `' . $compareCol . '` = ? |
84 | 84 | '); |
85 | 85 | |
86 | - $res = $query->execute(array($search)); |
|
87 | - if($res !== false) { |
|
88 | - return $query->fetchColumn(); |
|
89 | - } |
|
86 | + $res = $query->execute(array($search)); |
|
87 | + if($res !== false) { |
|
88 | + return $query->fetchColumn(); |
|
89 | + } |
|
90 | 90 | |
91 | - return false; |
|
92 | - } |
|
91 | + return false; |
|
92 | + } |
|
93 | 93 | |
94 | - /** |
|
95 | - * Performs a DELETE or UPDATE query to the database. |
|
96 | - * @param \Doctrine\DBAL\Driver\Statement $query |
|
97 | - * @param array $parameters |
|
98 | - * @return bool true if at least one row was modified, false otherwise |
|
99 | - */ |
|
100 | - protected function modify($query, $parameters) { |
|
101 | - $result = $query->execute($parameters); |
|
102 | - return ($result === true && $query->rowCount() > 0); |
|
103 | - } |
|
94 | + /** |
|
95 | + * Performs a DELETE or UPDATE query to the database. |
|
96 | + * @param \Doctrine\DBAL\Driver\Statement $query |
|
97 | + * @param array $parameters |
|
98 | + * @return bool true if at least one row was modified, false otherwise |
|
99 | + */ |
|
100 | + protected function modify($query, $parameters) { |
|
101 | + $result = $query->execute($parameters); |
|
102 | + return ($result === true && $query->rowCount() > 0); |
|
103 | + } |
|
104 | 104 | |
105 | - /** |
|
106 | - * Gets the LDAP DN based on the provided name. |
|
107 | - * Replaces Access::ocname2dn |
|
108 | - * @param string $name |
|
109 | - * @return string|false |
|
110 | - */ |
|
111 | - public function getDNByName($name) { |
|
112 | - return $this->getXbyY('ldap_dn', 'owncloud_name', $name); |
|
113 | - } |
|
105 | + /** |
|
106 | + * Gets the LDAP DN based on the provided name. |
|
107 | + * Replaces Access::ocname2dn |
|
108 | + * @param string $name |
|
109 | + * @return string|false |
|
110 | + */ |
|
111 | + public function getDNByName($name) { |
|
112 | + return $this->getXbyY('ldap_dn', 'owncloud_name', $name); |
|
113 | + } |
|
114 | 114 | |
115 | - /** |
|
116 | - * Updates the DN based on the given UUID |
|
117 | - * @param string $fdn |
|
118 | - * @param string $uuid |
|
119 | - * @return bool |
|
120 | - */ |
|
121 | - public function setDNbyUUID($fdn, $uuid) { |
|
122 | - $query = $this->dbc->prepare(' |
|
115 | + /** |
|
116 | + * Updates the DN based on the given UUID |
|
117 | + * @param string $fdn |
|
118 | + * @param string $uuid |
|
119 | + * @return bool |
|
120 | + */ |
|
121 | + public function setDNbyUUID($fdn, $uuid) { |
|
122 | + $query = $this->dbc->prepare(' |
|
123 | 123 | UPDATE `' . $this->getTableName() . '` |
124 | 124 | SET `ldap_dn` = ? |
125 | 125 | WHERE `directory_uuid` = ? |
126 | 126 | '); |
127 | 127 | |
128 | - return $this->modify($query, array($fdn, $uuid)); |
|
129 | - } |
|
128 | + return $this->modify($query, array($fdn, $uuid)); |
|
129 | + } |
|
130 | 130 | |
131 | - /** |
|
132 | - * Updates the UUID based on the given DN |
|
133 | - * |
|
134 | - * required by Migration/UUIDFix |
|
135 | - * |
|
136 | - * @param $uuid |
|
137 | - * @param $fdn |
|
138 | - * @return bool |
|
139 | - */ |
|
140 | - public function setUUIDbyDN($uuid, $fdn) { |
|
141 | - $query = $this->dbc->prepare(' |
|
131 | + /** |
|
132 | + * Updates the UUID based on the given DN |
|
133 | + * |
|
134 | + * required by Migration/UUIDFix |
|
135 | + * |
|
136 | + * @param $uuid |
|
137 | + * @param $fdn |
|
138 | + * @return bool |
|
139 | + */ |
|
140 | + public function setUUIDbyDN($uuid, $fdn) { |
|
141 | + $query = $this->dbc->prepare(' |
|
142 | 142 | UPDATE `' . $this->getTableName() . '` |
143 | 143 | SET `directory_uuid` = ? |
144 | 144 | WHERE `ldap_dn` = ? |
145 | 145 | '); |
146 | 146 | |
147 | - return $this->modify($query, [$uuid, $fdn]); |
|
148 | - } |
|
147 | + return $this->modify($query, [$uuid, $fdn]); |
|
148 | + } |
|
149 | 149 | |
150 | - /** |
|
151 | - * Gets the name based on the provided LDAP DN. |
|
152 | - * @param string $fdn |
|
153 | - * @return string|false |
|
154 | - */ |
|
155 | - public function getNameByDN($fdn) { |
|
156 | - return $this->getXbyY('owncloud_name', 'ldap_dn', $fdn); |
|
157 | - } |
|
150 | + /** |
|
151 | + * Gets the name based on the provided LDAP DN. |
|
152 | + * @param string $fdn |
|
153 | + * @return string|false |
|
154 | + */ |
|
155 | + public function getNameByDN($fdn) { |
|
156 | + return $this->getXbyY('owncloud_name', 'ldap_dn', $fdn); |
|
157 | + } |
|
158 | 158 | |
159 | - /** |
|
160 | - * Searches mapped names by the giving string in the name column |
|
161 | - * @param string $search |
|
162 | - * @param string $prefixMatch |
|
163 | - * @param string $postfixMatch |
|
164 | - * @return string[] |
|
165 | - */ |
|
166 | - public function getNamesBySearch($search, $prefixMatch = "", $postfixMatch = "") { |
|
167 | - $query = $this->dbc->prepare(' |
|
159 | + /** |
|
160 | + * Searches mapped names by the giving string in the name column |
|
161 | + * @param string $search |
|
162 | + * @param string $prefixMatch |
|
163 | + * @param string $postfixMatch |
|
164 | + * @return string[] |
|
165 | + */ |
|
166 | + public function getNamesBySearch($search, $prefixMatch = "", $postfixMatch = "") { |
|
167 | + $query = $this->dbc->prepare(' |
|
168 | 168 | SELECT `owncloud_name` |
169 | 169 | FROM `'. $this->getTableName() .'` |
170 | 170 | WHERE `owncloud_name` LIKE ? |
171 | 171 | '); |
172 | 172 | |
173 | - $res = $query->execute(array($prefixMatch.$this->dbc->escapeLikeParameter($search).$postfixMatch)); |
|
174 | - $names = array(); |
|
175 | - if($res !== false) { |
|
176 | - while($row = $query->fetch()) { |
|
177 | - $names[] = $row['owncloud_name']; |
|
178 | - } |
|
179 | - } |
|
180 | - return $names; |
|
181 | - } |
|
173 | + $res = $query->execute(array($prefixMatch.$this->dbc->escapeLikeParameter($search).$postfixMatch)); |
|
174 | + $names = array(); |
|
175 | + if($res !== false) { |
|
176 | + while($row = $query->fetch()) { |
|
177 | + $names[] = $row['owncloud_name']; |
|
178 | + } |
|
179 | + } |
|
180 | + return $names; |
|
181 | + } |
|
182 | 182 | |
183 | - /** |
|
184 | - * Gets the name based on the provided LDAP UUID. |
|
185 | - * @param string $uuid |
|
186 | - * @return string|false |
|
187 | - */ |
|
188 | - public function getNameByUUID($uuid) { |
|
189 | - return $this->getXbyY('owncloud_name', 'directory_uuid', $uuid); |
|
190 | - } |
|
183 | + /** |
|
184 | + * Gets the name based on the provided LDAP UUID. |
|
185 | + * @param string $uuid |
|
186 | + * @return string|false |
|
187 | + */ |
|
188 | + public function getNameByUUID($uuid) { |
|
189 | + return $this->getXbyY('owncloud_name', 'directory_uuid', $uuid); |
|
190 | + } |
|
191 | 191 | |
192 | - /** |
|
193 | - * Gets the UUID based on the provided LDAP DN |
|
194 | - * @param string $dn |
|
195 | - * @return false|string |
|
196 | - * @throws \Exception |
|
197 | - */ |
|
198 | - public function getUUIDByDN($dn) { |
|
199 | - return $this->getXbyY('directory_uuid', 'ldap_dn', $dn); |
|
200 | - } |
|
192 | + /** |
|
193 | + * Gets the UUID based on the provided LDAP DN |
|
194 | + * @param string $dn |
|
195 | + * @return false|string |
|
196 | + * @throws \Exception |
|
197 | + */ |
|
198 | + public function getUUIDByDN($dn) { |
|
199 | + return $this->getXbyY('directory_uuid', 'ldap_dn', $dn); |
|
200 | + } |
|
201 | 201 | |
202 | - /** |
|
203 | - * gets a piece of the mapping list |
|
204 | - * @param int $offset |
|
205 | - * @param int $limit |
|
206 | - * @return array |
|
207 | - */ |
|
208 | - public function getList($offset = null, $limit = null) { |
|
209 | - $query = $this->dbc->prepare(' |
|
202 | + /** |
|
203 | + * gets a piece of the mapping list |
|
204 | + * @param int $offset |
|
205 | + * @param int $limit |
|
206 | + * @return array |
|
207 | + */ |
|
208 | + public function getList($offset = null, $limit = null) { |
|
209 | + $query = $this->dbc->prepare(' |
|
210 | 210 | SELECT |
211 | 211 | `ldap_dn` AS `dn`, |
212 | 212 | `owncloud_name` AS `name`, |
213 | 213 | `directory_uuid` AS `uuid` |
214 | 214 | FROM `' . $this->getTableName() . '`', |
215 | - $limit, |
|
216 | - $offset |
|
217 | - ); |
|
215 | + $limit, |
|
216 | + $offset |
|
217 | + ); |
|
218 | 218 | |
219 | - $query->execute(); |
|
220 | - return $query->fetchAll(); |
|
221 | - } |
|
219 | + $query->execute(); |
|
220 | + return $query->fetchAll(); |
|
221 | + } |
|
222 | 222 | |
223 | - /** |
|
224 | - * attempts to map the given entry |
|
225 | - * @param string $fdn fully distinguished name (from LDAP) |
|
226 | - * @param string $name |
|
227 | - * @param string $uuid a unique identifier as used in LDAP |
|
228 | - * @return bool |
|
229 | - */ |
|
230 | - public function map($fdn, $name, $uuid) { |
|
231 | - if(mb_strlen($fdn) > 255) { |
|
232 | - \OC::$server->getLogger()->error( |
|
233 | - 'Cannot map, because the DN exceeds 255 characters: {dn}', |
|
234 | - [ |
|
235 | - 'app' => 'user_ldap', |
|
236 | - 'dn' => $fdn, |
|
237 | - ] |
|
238 | - ); |
|
239 | - return false; |
|
240 | - } |
|
223 | + /** |
|
224 | + * attempts to map the given entry |
|
225 | + * @param string $fdn fully distinguished name (from LDAP) |
|
226 | + * @param string $name |
|
227 | + * @param string $uuid a unique identifier as used in LDAP |
|
228 | + * @return bool |
|
229 | + */ |
|
230 | + public function map($fdn, $name, $uuid) { |
|
231 | + if(mb_strlen($fdn) > 255) { |
|
232 | + \OC::$server->getLogger()->error( |
|
233 | + 'Cannot map, because the DN exceeds 255 characters: {dn}', |
|
234 | + [ |
|
235 | + 'app' => 'user_ldap', |
|
236 | + 'dn' => $fdn, |
|
237 | + ] |
|
238 | + ); |
|
239 | + return false; |
|
240 | + } |
|
241 | 241 | |
242 | - $row = array( |
|
243 | - 'ldap_dn' => $fdn, |
|
244 | - 'owncloud_name' => $name, |
|
245 | - 'directory_uuid' => $uuid |
|
246 | - ); |
|
242 | + $row = array( |
|
243 | + 'ldap_dn' => $fdn, |
|
244 | + 'owncloud_name' => $name, |
|
245 | + 'directory_uuid' => $uuid |
|
246 | + ); |
|
247 | 247 | |
248 | - try { |
|
249 | - $result = $this->dbc->insertIfNotExist($this->getTableName(), $row); |
|
250 | - // insertIfNotExist returns values as int |
|
251 | - return (bool)$result; |
|
252 | - } catch (\Exception $e) { |
|
253 | - return false; |
|
254 | - } |
|
255 | - } |
|
248 | + try { |
|
249 | + $result = $this->dbc->insertIfNotExist($this->getTableName(), $row); |
|
250 | + // insertIfNotExist returns values as int |
|
251 | + return (bool)$result; |
|
252 | + } catch (\Exception $e) { |
|
253 | + return false; |
|
254 | + } |
|
255 | + } |
|
256 | 256 | |
257 | - /** |
|
258 | - * removes a mapping based on the owncloud_name of the entry |
|
259 | - * @param string $name |
|
260 | - * @return bool |
|
261 | - */ |
|
262 | - public function unmap($name) { |
|
263 | - $query = $this->dbc->prepare(' |
|
257 | + /** |
|
258 | + * removes a mapping based on the owncloud_name of the entry |
|
259 | + * @param string $name |
|
260 | + * @return bool |
|
261 | + */ |
|
262 | + public function unmap($name) { |
|
263 | + $query = $this->dbc->prepare(' |
|
264 | 264 | DELETE FROM `'. $this->getTableName() .'` |
265 | 265 | WHERE `owncloud_name` = ?'); |
266 | 266 | |
267 | - return $this->modify($query, array($name)); |
|
268 | - } |
|
267 | + return $this->modify($query, array($name)); |
|
268 | + } |
|
269 | 269 | |
270 | - /** |
|
271 | - * Truncate's the mapping table |
|
272 | - * @return bool |
|
273 | - */ |
|
274 | - public function clear() { |
|
275 | - $sql = $this->dbc |
|
276 | - ->getDatabasePlatform() |
|
277 | - ->getTruncateTableSQL('`' . $this->getTableName() . '`'); |
|
278 | - return $this->dbc->prepare($sql)->execute(); |
|
279 | - } |
|
270 | + /** |
|
271 | + * Truncate's the mapping table |
|
272 | + * @return bool |
|
273 | + */ |
|
274 | + public function clear() { |
|
275 | + $sql = $this->dbc |
|
276 | + ->getDatabasePlatform() |
|
277 | + ->getTruncateTableSQL('`' . $this->getTableName() . '`'); |
|
278 | + return $this->dbc->prepare($sql)->execute(); |
|
279 | + } |
|
280 | 280 | } |
@@ -27,182 +27,182 @@ |
||
27 | 27 | namespace OCA\User_LDAP; |
28 | 28 | |
29 | 29 | class Group_Proxy extends Proxy implements \OCP\GroupInterface { |
30 | - private $backends = array(); |
|
31 | - private $refBackend = null; |
|
32 | - |
|
33 | - /** |
|
34 | - * Constructor |
|
35 | - * @param string[] $serverConfigPrefixes array containing the config Prefixes |
|
36 | - */ |
|
37 | - public function __construct($serverConfigPrefixes, ILDAPWrapper $ldap) { |
|
38 | - parent::__construct($ldap); |
|
39 | - foreach($serverConfigPrefixes as $configPrefix) { |
|
40 | - $this->backends[$configPrefix] = |
|
41 | - new \OCA\User_LDAP\Group_LDAP($this->getAccess($configPrefix)); |
|
42 | - if(is_null($this->refBackend)) { |
|
43 | - $this->refBackend = &$this->backends[$configPrefix]; |
|
44 | - } |
|
45 | - } |
|
46 | - } |
|
47 | - |
|
48 | - /** |
|
49 | - * Tries the backends one after the other until a positive result is returned from the specified method |
|
50 | - * @param string $gid the gid connected to the request |
|
51 | - * @param string $method the method of the group backend that shall be called |
|
52 | - * @param array $parameters an array of parameters to be passed |
|
53 | - * @return mixed, the result of the method or false |
|
54 | - */ |
|
55 | - protected function walkBackends($gid, $method, $parameters) { |
|
56 | - $cacheKey = $this->getGroupCacheKey($gid); |
|
57 | - foreach($this->backends as $configPrefix => $backend) { |
|
58 | - if($result = call_user_func_array(array($backend, $method), $parameters)) { |
|
59 | - $this->writeToCache($cacheKey, $configPrefix); |
|
60 | - return $result; |
|
61 | - } |
|
62 | - } |
|
63 | - return false; |
|
64 | - } |
|
65 | - |
|
66 | - /** |
|
67 | - * Asks the backend connected to the server that supposely takes care of the gid from the request. |
|
68 | - * @param string $gid the gid connected to the request |
|
69 | - * @param string $method the method of the group backend that shall be called |
|
70 | - * @param array $parameters an array of parameters to be passed |
|
71 | - * @param mixed $passOnWhen the result matches this variable |
|
72 | - * @return mixed, the result of the method or false |
|
73 | - */ |
|
74 | - protected function callOnLastSeenOn($gid, $method, $parameters, $passOnWhen) { |
|
75 | - $cacheKey = $this->getGroupCacheKey($gid);; |
|
76 | - $prefix = $this->getFromCache($cacheKey); |
|
77 | - //in case the uid has been found in the past, try this stored connection first |
|
78 | - if(!is_null($prefix)) { |
|
79 | - if(isset($this->backends[$prefix])) { |
|
80 | - $result = call_user_func_array(array($this->backends[$prefix], $method), $parameters); |
|
81 | - if($result === $passOnWhen) { |
|
82 | - //not found here, reset cache to null if group vanished |
|
83 | - //because sometimes methods return false with a reason |
|
84 | - $groupExists = call_user_func_array( |
|
85 | - array($this->backends[$prefix], 'groupExists'), |
|
86 | - array($gid) |
|
87 | - ); |
|
88 | - if(!$groupExists) { |
|
89 | - $this->writeToCache($cacheKey, null); |
|
90 | - } |
|
91 | - } |
|
92 | - return $result; |
|
93 | - } |
|
94 | - } |
|
95 | - return false; |
|
96 | - } |
|
97 | - |
|
98 | - /** |
|
99 | - * is user in group? |
|
100 | - * @param string $uid uid of the user |
|
101 | - * @param string $gid gid of the group |
|
102 | - * @return bool |
|
103 | - * |
|
104 | - * Checks whether the user is member of a group or not. |
|
105 | - */ |
|
106 | - public function inGroup($uid, $gid) { |
|
107 | - return $this->handleRequest($gid, 'inGroup', array($uid, $gid)); |
|
108 | - } |
|
109 | - |
|
110 | - /** |
|
111 | - * Get all groups a user belongs to |
|
112 | - * @param string $uid Name of the user |
|
113 | - * @return string[] with group names |
|
114 | - * |
|
115 | - * This function fetches all groups a user belongs to. It does not check |
|
116 | - * if the user exists at all. |
|
117 | - */ |
|
118 | - public function getUserGroups($uid) { |
|
119 | - $groups = array(); |
|
120 | - |
|
121 | - foreach($this->backends as $backend) { |
|
122 | - $backendGroups = $backend->getUserGroups($uid); |
|
123 | - if (is_array($backendGroups)) { |
|
124 | - $groups = array_merge($groups, $backendGroups); |
|
125 | - } |
|
126 | - } |
|
127 | - |
|
128 | - return $groups; |
|
129 | - } |
|
130 | - |
|
131 | - /** |
|
132 | - * get a list of all users in a group |
|
133 | - * @return string[] with user ids |
|
134 | - */ |
|
135 | - public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0) { |
|
136 | - $users = array(); |
|
137 | - |
|
138 | - foreach($this->backends as $backend) { |
|
139 | - $backendUsers = $backend->usersInGroup($gid, $search, $limit, $offset); |
|
140 | - if (is_array($backendUsers)) { |
|
141 | - $users = array_merge($users, $backendUsers); |
|
142 | - } |
|
143 | - } |
|
144 | - |
|
145 | - return $users; |
|
146 | - } |
|
147 | - |
|
148 | - /** |
|
149 | - * returns the number of users in a group, who match the search term |
|
150 | - * @param string $gid the internal group name |
|
151 | - * @param string $search optional, a search string |
|
152 | - * @return int|bool |
|
153 | - */ |
|
154 | - public function countUsersInGroup($gid, $search = '') { |
|
155 | - return $this->handleRequest( |
|
156 | - $gid, 'countUsersInGroup', array($gid, $search)); |
|
157 | - } |
|
158 | - |
|
159 | - /** |
|
160 | - * get a list of all groups |
|
161 | - * @return string[] with group names |
|
162 | - * |
|
163 | - * Returns a list with all groups |
|
164 | - */ |
|
165 | - public function getGroups($search = '', $limit = -1, $offset = 0) { |
|
166 | - $groups = array(); |
|
167 | - |
|
168 | - foreach($this->backends as $backend) { |
|
169 | - $backendGroups = $backend->getGroups($search, $limit, $offset); |
|
170 | - if (is_array($backendGroups)) { |
|
171 | - $groups = array_merge($groups, $backendGroups); |
|
172 | - } |
|
173 | - } |
|
174 | - |
|
175 | - return $groups; |
|
176 | - } |
|
177 | - |
|
178 | - /** |
|
179 | - * check if a group exists |
|
180 | - * @param string $gid |
|
181 | - * @return bool |
|
182 | - */ |
|
183 | - public function groupExists($gid) { |
|
184 | - return $this->handleRequest($gid, 'groupExists', array($gid)); |
|
185 | - } |
|
186 | - |
|
187 | - /** |
|
188 | - * Check if backend implements actions |
|
189 | - * @param int $actions bitwise-or'ed actions |
|
190 | - * @return boolean |
|
191 | - * |
|
192 | - * Returns the supported actions as int to be |
|
193 | - * compared with OC_USER_BACKEND_CREATE_USER etc. |
|
194 | - */ |
|
195 | - public function implementsActions($actions) { |
|
196 | - //it's the same across all our user backends obviously |
|
197 | - return $this->refBackend->implementsActions($actions); |
|
198 | - } |
|
199 | - |
|
200 | - /** |
|
201 | - * Return access for LDAP interaction. |
|
202 | - * @param string $gid |
|
203 | - * @return Access instance of Access for LDAP interaction |
|
204 | - */ |
|
205 | - public function getLDAPAccess($gid) { |
|
206 | - return $this->handleRequest($gid, 'getLDAPAccess', []); |
|
207 | - } |
|
30 | + private $backends = array(); |
|
31 | + private $refBackend = null; |
|
32 | + |
|
33 | + /** |
|
34 | + * Constructor |
|
35 | + * @param string[] $serverConfigPrefixes array containing the config Prefixes |
|
36 | + */ |
|
37 | + public function __construct($serverConfigPrefixes, ILDAPWrapper $ldap) { |
|
38 | + parent::__construct($ldap); |
|
39 | + foreach($serverConfigPrefixes as $configPrefix) { |
|
40 | + $this->backends[$configPrefix] = |
|
41 | + new \OCA\User_LDAP\Group_LDAP($this->getAccess($configPrefix)); |
|
42 | + if(is_null($this->refBackend)) { |
|
43 | + $this->refBackend = &$this->backends[$configPrefix]; |
|
44 | + } |
|
45 | + } |
|
46 | + } |
|
47 | + |
|
48 | + /** |
|
49 | + * Tries the backends one after the other until a positive result is returned from the specified method |
|
50 | + * @param string $gid the gid connected to the request |
|
51 | + * @param string $method the method of the group backend that shall be called |
|
52 | + * @param array $parameters an array of parameters to be passed |
|
53 | + * @return mixed, the result of the method or false |
|
54 | + */ |
|
55 | + protected function walkBackends($gid, $method, $parameters) { |
|
56 | + $cacheKey = $this->getGroupCacheKey($gid); |
|
57 | + foreach($this->backends as $configPrefix => $backend) { |
|
58 | + if($result = call_user_func_array(array($backend, $method), $parameters)) { |
|
59 | + $this->writeToCache($cacheKey, $configPrefix); |
|
60 | + return $result; |
|
61 | + } |
|
62 | + } |
|
63 | + return false; |
|
64 | + } |
|
65 | + |
|
66 | + /** |
|
67 | + * Asks the backend connected to the server that supposely takes care of the gid from the request. |
|
68 | + * @param string $gid the gid connected to the request |
|
69 | + * @param string $method the method of the group backend that shall be called |
|
70 | + * @param array $parameters an array of parameters to be passed |
|
71 | + * @param mixed $passOnWhen the result matches this variable |
|
72 | + * @return mixed, the result of the method or false |
|
73 | + */ |
|
74 | + protected function callOnLastSeenOn($gid, $method, $parameters, $passOnWhen) { |
|
75 | + $cacheKey = $this->getGroupCacheKey($gid);; |
|
76 | + $prefix = $this->getFromCache($cacheKey); |
|
77 | + //in case the uid has been found in the past, try this stored connection first |
|
78 | + if(!is_null($prefix)) { |
|
79 | + if(isset($this->backends[$prefix])) { |
|
80 | + $result = call_user_func_array(array($this->backends[$prefix], $method), $parameters); |
|
81 | + if($result === $passOnWhen) { |
|
82 | + //not found here, reset cache to null if group vanished |
|
83 | + //because sometimes methods return false with a reason |
|
84 | + $groupExists = call_user_func_array( |
|
85 | + array($this->backends[$prefix], 'groupExists'), |
|
86 | + array($gid) |
|
87 | + ); |
|
88 | + if(!$groupExists) { |
|
89 | + $this->writeToCache($cacheKey, null); |
|
90 | + } |
|
91 | + } |
|
92 | + return $result; |
|
93 | + } |
|
94 | + } |
|
95 | + return false; |
|
96 | + } |
|
97 | + |
|
98 | + /** |
|
99 | + * is user in group? |
|
100 | + * @param string $uid uid of the user |
|
101 | + * @param string $gid gid of the group |
|
102 | + * @return bool |
|
103 | + * |
|
104 | + * Checks whether the user is member of a group or not. |
|
105 | + */ |
|
106 | + public function inGroup($uid, $gid) { |
|
107 | + return $this->handleRequest($gid, 'inGroup', array($uid, $gid)); |
|
108 | + } |
|
109 | + |
|
110 | + /** |
|
111 | + * Get all groups a user belongs to |
|
112 | + * @param string $uid Name of the user |
|
113 | + * @return string[] with group names |
|
114 | + * |
|
115 | + * This function fetches all groups a user belongs to. It does not check |
|
116 | + * if the user exists at all. |
|
117 | + */ |
|
118 | + public function getUserGroups($uid) { |
|
119 | + $groups = array(); |
|
120 | + |
|
121 | + foreach($this->backends as $backend) { |
|
122 | + $backendGroups = $backend->getUserGroups($uid); |
|
123 | + if (is_array($backendGroups)) { |
|
124 | + $groups = array_merge($groups, $backendGroups); |
|
125 | + } |
|
126 | + } |
|
127 | + |
|
128 | + return $groups; |
|
129 | + } |
|
130 | + |
|
131 | + /** |
|
132 | + * get a list of all users in a group |
|
133 | + * @return string[] with user ids |
|
134 | + */ |
|
135 | + public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0) { |
|
136 | + $users = array(); |
|
137 | + |
|
138 | + foreach($this->backends as $backend) { |
|
139 | + $backendUsers = $backend->usersInGroup($gid, $search, $limit, $offset); |
|
140 | + if (is_array($backendUsers)) { |
|
141 | + $users = array_merge($users, $backendUsers); |
|
142 | + } |
|
143 | + } |
|
144 | + |
|
145 | + return $users; |
|
146 | + } |
|
147 | + |
|
148 | + /** |
|
149 | + * returns the number of users in a group, who match the search term |
|
150 | + * @param string $gid the internal group name |
|
151 | + * @param string $search optional, a search string |
|
152 | + * @return int|bool |
|
153 | + */ |
|
154 | + public function countUsersInGroup($gid, $search = '') { |
|
155 | + return $this->handleRequest( |
|
156 | + $gid, 'countUsersInGroup', array($gid, $search)); |
|
157 | + } |
|
158 | + |
|
159 | + /** |
|
160 | + * get a list of all groups |
|
161 | + * @return string[] with group names |
|
162 | + * |
|
163 | + * Returns a list with all groups |
|
164 | + */ |
|
165 | + public function getGroups($search = '', $limit = -1, $offset = 0) { |
|
166 | + $groups = array(); |
|
167 | + |
|
168 | + foreach($this->backends as $backend) { |
|
169 | + $backendGroups = $backend->getGroups($search, $limit, $offset); |
|
170 | + if (is_array($backendGroups)) { |
|
171 | + $groups = array_merge($groups, $backendGroups); |
|
172 | + } |
|
173 | + } |
|
174 | + |
|
175 | + return $groups; |
|
176 | + } |
|
177 | + |
|
178 | + /** |
|
179 | + * check if a group exists |
|
180 | + * @param string $gid |
|
181 | + * @return bool |
|
182 | + */ |
|
183 | + public function groupExists($gid) { |
|
184 | + return $this->handleRequest($gid, 'groupExists', array($gid)); |
|
185 | + } |
|
186 | + |
|
187 | + /** |
|
188 | + * Check if backend implements actions |
|
189 | + * @param int $actions bitwise-or'ed actions |
|
190 | + * @return boolean |
|
191 | + * |
|
192 | + * Returns the supported actions as int to be |
|
193 | + * compared with OC_USER_BACKEND_CREATE_USER etc. |
|
194 | + */ |
|
195 | + public function implementsActions($actions) { |
|
196 | + //it's the same across all our user backends obviously |
|
197 | + return $this->refBackend->implementsActions($actions); |
|
198 | + } |
|
199 | + |
|
200 | + /** |
|
201 | + * Return access for LDAP interaction. |
|
202 | + * @param string $gid |
|
203 | + * @return Access instance of Access for LDAP interaction |
|
204 | + */ |
|
205 | + public function getLDAPAccess($gid) { |
|
206 | + return $this->handleRequest($gid, 'getLDAPAccess', []); |
|
207 | + } |
|
208 | 208 | } |
@@ -33,341 +33,341 @@ |
||
33 | 33 | use OCA\User_LDAP\Exceptions\ConstraintViolationException; |
34 | 34 | |
35 | 35 | class LDAP implements ILDAPWrapper { |
36 | - protected $curFunc = ''; |
|
37 | - protected $curArgs = array(); |
|
38 | - |
|
39 | - /** |
|
40 | - * @param resource $link |
|
41 | - * @param string $dn |
|
42 | - * @param string $password |
|
43 | - * @return bool|mixed |
|
44 | - */ |
|
45 | - public function bind($link, $dn, $password) { |
|
46 | - return $this->invokeLDAPMethod('bind', $link, $dn, $password); |
|
47 | - } |
|
48 | - |
|
49 | - /** |
|
50 | - * @param string $host |
|
51 | - * @param string $port |
|
52 | - * @return mixed |
|
53 | - */ |
|
54 | - public function connect($host, $port) { |
|
55 | - if(strpos($host, '://') === false) { |
|
56 | - $host = 'ldap://' . $host; |
|
57 | - } |
|
58 | - if(strpos($host, ':', strpos($host, '://') + 1) === false) { |
|
59 | - //ldap_connect ignores port parameter when URLs are passed |
|
60 | - $host .= ':' . $port; |
|
61 | - } |
|
62 | - return $this->invokeLDAPMethod('connect', $host); |
|
63 | - } |
|
64 | - |
|
65 | - /** |
|
66 | - * @param LDAP $link |
|
67 | - * @param LDAP $result |
|
68 | - * @param string $cookie |
|
69 | - * @return bool|LDAP |
|
70 | - */ |
|
71 | - public function controlPagedResultResponse($link, $result, &$cookie) { |
|
72 | - $this->preFunctionCall('ldap_control_paged_result_response', |
|
73 | - array($link, $result, $cookie)); |
|
74 | - $result = ldap_control_paged_result_response($link, $result, $cookie); |
|
75 | - $this->postFunctionCall(); |
|
76 | - |
|
77 | - return $result; |
|
78 | - } |
|
79 | - |
|
80 | - /** |
|
81 | - * @param LDAP $link |
|
82 | - * @param int $pageSize |
|
83 | - * @param bool $isCritical |
|
84 | - * @param string $cookie |
|
85 | - * @return mixed|true |
|
86 | - */ |
|
87 | - public function controlPagedResult($link, $pageSize, $isCritical, $cookie) { |
|
88 | - return $this->invokeLDAPMethod('control_paged_result', $link, $pageSize, |
|
89 | - $isCritical, $cookie); |
|
90 | - } |
|
91 | - |
|
92 | - /** |
|
93 | - * @param LDAP $link |
|
94 | - * @param LDAP $result |
|
95 | - * @return mixed |
|
96 | - */ |
|
97 | - public function countEntries($link, $result) { |
|
98 | - return $this->invokeLDAPMethod('count_entries', $link, $result); |
|
99 | - } |
|
100 | - |
|
101 | - /** |
|
102 | - * @param LDAP $link |
|
103 | - * @return mixed|string |
|
104 | - */ |
|
105 | - public function errno($link) { |
|
106 | - return $this->invokeLDAPMethod('errno', $link); |
|
107 | - } |
|
108 | - |
|
109 | - /** |
|
110 | - * @param LDAP $link |
|
111 | - * @return int|mixed |
|
112 | - */ |
|
113 | - public function error($link) { |
|
114 | - return $this->invokeLDAPMethod('error', $link); |
|
115 | - } |
|
116 | - |
|
117 | - /** |
|
118 | - * Splits DN into its component parts |
|
119 | - * @param string $dn |
|
120 | - * @param int @withAttrib |
|
121 | - * @return array|false |
|
122 | - * @link http://www.php.net/manual/en/function.ldap-explode-dn.php |
|
123 | - */ |
|
124 | - public function explodeDN($dn, $withAttrib) { |
|
125 | - return $this->invokeLDAPMethod('explode_dn', $dn, $withAttrib); |
|
126 | - } |
|
127 | - |
|
128 | - /** |
|
129 | - * @param LDAP $link |
|
130 | - * @param LDAP $result |
|
131 | - * @return mixed |
|
132 | - */ |
|
133 | - public function firstEntry($link, $result) { |
|
134 | - return $this->invokeLDAPMethod('first_entry', $link, $result); |
|
135 | - } |
|
136 | - |
|
137 | - /** |
|
138 | - * @param LDAP $link |
|
139 | - * @param LDAP $result |
|
140 | - * @return array|mixed |
|
141 | - */ |
|
142 | - public function getAttributes($link, $result) { |
|
143 | - return $this->invokeLDAPMethod('get_attributes', $link, $result); |
|
144 | - } |
|
145 | - |
|
146 | - /** |
|
147 | - * @param LDAP $link |
|
148 | - * @param LDAP $result |
|
149 | - * @return mixed|string |
|
150 | - */ |
|
151 | - public function getDN($link, $result) { |
|
152 | - return $this->invokeLDAPMethod('get_dn', $link, $result); |
|
153 | - } |
|
154 | - |
|
155 | - /** |
|
156 | - * @param LDAP $link |
|
157 | - * @param LDAP $result |
|
158 | - * @return array|mixed |
|
159 | - */ |
|
160 | - public function getEntries($link, $result) { |
|
161 | - return $this->invokeLDAPMethod('get_entries', $link, $result); |
|
162 | - } |
|
163 | - |
|
164 | - /** |
|
165 | - * @param LDAP $link |
|
166 | - * @param resource $result |
|
167 | - * @return mixed |
|
168 | - */ |
|
169 | - public function nextEntry($link, $result) { |
|
170 | - return $this->invokeLDAPMethod('next_entry', $link, $result); |
|
171 | - } |
|
172 | - |
|
173 | - /** |
|
174 | - * @param LDAP $link |
|
175 | - * @param string $baseDN |
|
176 | - * @param string $filter |
|
177 | - * @param array $attr |
|
178 | - * @return mixed |
|
179 | - */ |
|
180 | - public function read($link, $baseDN, $filter, $attr) { |
|
181 | - return $this->invokeLDAPMethod('read', $link, $baseDN, $filter, $attr); |
|
182 | - } |
|
183 | - |
|
184 | - /** |
|
185 | - * @param LDAP $link |
|
186 | - * @param string $baseDN |
|
187 | - * @param string $filter |
|
188 | - * @param array $attr |
|
189 | - * @param int $attrsOnly |
|
190 | - * @param int $limit |
|
191 | - * @return mixed |
|
192 | - */ |
|
193 | - public function search($link, $baseDN, $filter, $attr, $attrsOnly = 0, $limit = 0) { |
|
194 | - return $this->invokeLDAPMethod('search', $link, $baseDN, $filter, $attr, $attrsOnly, $limit); |
|
195 | - } |
|
196 | - |
|
197 | - /** |
|
198 | - * @param LDAP $link |
|
199 | - * @param string $userDN |
|
200 | - * @param string $password |
|
201 | - * @return bool |
|
202 | - */ |
|
203 | - public function modReplace($link, $userDN, $password) { |
|
204 | - return $this->invokeLDAPMethod('mod_replace', $link, $userDN, array('userPassword' => $password)); |
|
205 | - } |
|
206 | - |
|
207 | - /** |
|
208 | - * @param LDAP $link |
|
209 | - * @param string $option |
|
210 | - * @param int $value |
|
211 | - * @return bool|mixed |
|
212 | - */ |
|
213 | - public function setOption($link, $option, $value) { |
|
214 | - return $this->invokeLDAPMethod('set_option', $link, $option, $value); |
|
215 | - } |
|
216 | - |
|
217 | - /** |
|
218 | - * @param LDAP $link |
|
219 | - * @return mixed|true |
|
220 | - */ |
|
221 | - public function startTls($link) { |
|
222 | - return $this->invokeLDAPMethod('start_tls', $link); |
|
223 | - } |
|
224 | - |
|
225 | - /** |
|
226 | - * @param resource $link |
|
227 | - * @return bool|mixed |
|
228 | - */ |
|
229 | - public function unbind($link) { |
|
230 | - return $this->invokeLDAPMethod('unbind', $link); |
|
231 | - } |
|
232 | - |
|
233 | - /** |
|
234 | - * Checks whether the server supports LDAP |
|
235 | - * @return boolean if it the case, false otherwise |
|
236 | - * */ |
|
237 | - public function areLDAPFunctionsAvailable() { |
|
238 | - return function_exists('ldap_connect'); |
|
239 | - } |
|
240 | - |
|
241 | - /** |
|
242 | - * Checks whether PHP supports LDAP Paged Results |
|
243 | - * @return boolean if it the case, false otherwise |
|
244 | - * */ |
|
245 | - public function hasPagedResultSupport() { |
|
246 | - $hasSupport = function_exists('ldap_control_paged_result') |
|
247 | - && function_exists('ldap_control_paged_result_response'); |
|
248 | - return $hasSupport; |
|
249 | - } |
|
250 | - |
|
251 | - /** |
|
252 | - * Checks whether the submitted parameter is a resource |
|
253 | - * @param Resource $resource the resource variable to check |
|
254 | - * @return bool true if it is a resource, false otherwise |
|
255 | - */ |
|
256 | - public function isResource($resource) { |
|
257 | - return is_resource($resource); |
|
258 | - } |
|
259 | - |
|
260 | - /** |
|
261 | - * Checks whether the return value from LDAP is wrong or not. |
|
262 | - * |
|
263 | - * When using ldap_search we provide an array, in case multiple bases are |
|
264 | - * configured. Thus, we need to check the array elements. |
|
265 | - * |
|
266 | - * @param $result |
|
267 | - * @return bool |
|
268 | - */ |
|
269 | - protected function isResultFalse($result) { |
|
270 | - if($result === false) { |
|
271 | - return true; |
|
272 | - } |
|
273 | - |
|
274 | - if($this->curFunc === 'ldap_search' && is_array($result)) { |
|
275 | - foreach ($result as $singleResult) { |
|
276 | - if($singleResult === false) { |
|
277 | - return true; |
|
278 | - } |
|
279 | - } |
|
280 | - } |
|
281 | - |
|
282 | - return false; |
|
283 | - } |
|
284 | - |
|
285 | - /** |
|
286 | - * @return mixed |
|
287 | - */ |
|
288 | - protected function invokeLDAPMethod() { |
|
289 | - $arguments = func_get_args(); |
|
290 | - $func = 'ldap_' . array_shift($arguments); |
|
291 | - if(function_exists($func)) { |
|
292 | - $this->preFunctionCall($func, $arguments); |
|
293 | - $result = call_user_func_array($func, $arguments); |
|
294 | - if ($this->isResultFalse($result)) { |
|
295 | - $this->postFunctionCall(); |
|
296 | - } |
|
297 | - return $result; |
|
298 | - } |
|
299 | - return null; |
|
300 | - } |
|
301 | - |
|
302 | - /** |
|
303 | - * @param string $functionName |
|
304 | - * @param array $args |
|
305 | - */ |
|
306 | - private function preFunctionCall($functionName, $args) { |
|
307 | - $this->curFunc = $functionName; |
|
308 | - $this->curArgs = $args; |
|
309 | - } |
|
310 | - |
|
311 | - /** |
|
312 | - * Analyzes the returned LDAP error and acts accordingly if not 0 |
|
313 | - * |
|
314 | - * @param resource $resource the LDAP Connection resource |
|
315 | - * @throws ConstraintViolationException |
|
316 | - * @throws ServerNotAvailableException |
|
317 | - * @throws \Exception |
|
318 | - */ |
|
319 | - private function processLDAPError($resource) { |
|
320 | - $errorCode = ldap_errno($resource); |
|
321 | - if($errorCode === 0) { |
|
322 | - return; |
|
323 | - } |
|
324 | - $errorMsg = ldap_error($resource); |
|
325 | - |
|
326 | - if($this->curFunc === 'ldap_get_entries' |
|
327 | - && $errorCode === -4) { |
|
328 | - } else if ($errorCode === 32) { |
|
329 | - //for now |
|
330 | - } else if ($errorCode === 10) { |
|
331 | - //referrals, we switch them off, but then there is AD :) |
|
332 | - } else if ($errorCode === -1) { |
|
333 | - throw new ServerNotAvailableException('Lost connection to LDAP server.'); |
|
334 | - } else if ($errorCode === 48) { |
|
335 | - throw new \Exception('LDAP authentication method rejected', $errorCode); |
|
336 | - } else if ($errorCode === 1) { |
|
337 | - throw new \Exception('LDAP Operations error', $errorCode); |
|
338 | - } else if ($errorCode === 19) { |
|
339 | - ldap_get_option($this->curArgs[0], LDAP_OPT_ERROR_STRING, $extended_error); |
|
340 | - throw new ConstraintViolationException(!empty($extended_error)?$extended_error:$errorMsg, $errorCode); |
|
341 | - } else { |
|
342 | - \OCP\Util::writeLog('user_ldap', |
|
343 | - 'LDAP error '.$errorMsg.' (' . |
|
344 | - $errorCode.') after calling '. |
|
345 | - $this->curFunc, |
|
346 | - \OCP\Util::DEBUG); |
|
347 | - } |
|
348 | - } |
|
349 | - |
|
350 | - /** |
|
351 | - * Called after an ldap method is run to act on LDAP error if necessary |
|
352 | - */ |
|
353 | - private function postFunctionCall() { |
|
354 | - if($this->isResource($this->curArgs[0])) { |
|
355 | - $resource = $this->curArgs[0]; |
|
356 | - } else if( |
|
357 | - $this->curFunc === 'ldap_search' |
|
358 | - && is_array($this->curArgs[0]) |
|
359 | - && $this->isResource($this->curArgs[0][0]) |
|
360 | - ) { |
|
361 | - // we use always the same LDAP connection resource, is enough to |
|
362 | - // take the first one. |
|
363 | - $resource = $this->curArgs[0][0]; |
|
364 | - } else { |
|
365 | - return; |
|
366 | - } |
|
367 | - |
|
368 | - $this->processLDAPError($resource); |
|
369 | - |
|
370 | - $this->curFunc = ''; |
|
371 | - $this->curArgs = []; |
|
372 | - } |
|
36 | + protected $curFunc = ''; |
|
37 | + protected $curArgs = array(); |
|
38 | + |
|
39 | + /** |
|
40 | + * @param resource $link |
|
41 | + * @param string $dn |
|
42 | + * @param string $password |
|
43 | + * @return bool|mixed |
|
44 | + */ |
|
45 | + public function bind($link, $dn, $password) { |
|
46 | + return $this->invokeLDAPMethod('bind', $link, $dn, $password); |
|
47 | + } |
|
48 | + |
|
49 | + /** |
|
50 | + * @param string $host |
|
51 | + * @param string $port |
|
52 | + * @return mixed |
|
53 | + */ |
|
54 | + public function connect($host, $port) { |
|
55 | + if(strpos($host, '://') === false) { |
|
56 | + $host = 'ldap://' . $host; |
|
57 | + } |
|
58 | + if(strpos($host, ':', strpos($host, '://') + 1) === false) { |
|
59 | + //ldap_connect ignores port parameter when URLs are passed |
|
60 | + $host .= ':' . $port; |
|
61 | + } |
|
62 | + return $this->invokeLDAPMethod('connect', $host); |
|
63 | + } |
|
64 | + |
|
65 | + /** |
|
66 | + * @param LDAP $link |
|
67 | + * @param LDAP $result |
|
68 | + * @param string $cookie |
|
69 | + * @return bool|LDAP |
|
70 | + */ |
|
71 | + public function controlPagedResultResponse($link, $result, &$cookie) { |
|
72 | + $this->preFunctionCall('ldap_control_paged_result_response', |
|
73 | + array($link, $result, $cookie)); |
|
74 | + $result = ldap_control_paged_result_response($link, $result, $cookie); |
|
75 | + $this->postFunctionCall(); |
|
76 | + |
|
77 | + return $result; |
|
78 | + } |
|
79 | + |
|
80 | + /** |
|
81 | + * @param LDAP $link |
|
82 | + * @param int $pageSize |
|
83 | + * @param bool $isCritical |
|
84 | + * @param string $cookie |
|
85 | + * @return mixed|true |
|
86 | + */ |
|
87 | + public function controlPagedResult($link, $pageSize, $isCritical, $cookie) { |
|
88 | + return $this->invokeLDAPMethod('control_paged_result', $link, $pageSize, |
|
89 | + $isCritical, $cookie); |
|
90 | + } |
|
91 | + |
|
92 | + /** |
|
93 | + * @param LDAP $link |
|
94 | + * @param LDAP $result |
|
95 | + * @return mixed |
|
96 | + */ |
|
97 | + public function countEntries($link, $result) { |
|
98 | + return $this->invokeLDAPMethod('count_entries', $link, $result); |
|
99 | + } |
|
100 | + |
|
101 | + /** |
|
102 | + * @param LDAP $link |
|
103 | + * @return mixed|string |
|
104 | + */ |
|
105 | + public function errno($link) { |
|
106 | + return $this->invokeLDAPMethod('errno', $link); |
|
107 | + } |
|
108 | + |
|
109 | + /** |
|
110 | + * @param LDAP $link |
|
111 | + * @return int|mixed |
|
112 | + */ |
|
113 | + public function error($link) { |
|
114 | + return $this->invokeLDAPMethod('error', $link); |
|
115 | + } |
|
116 | + |
|
117 | + /** |
|
118 | + * Splits DN into its component parts |
|
119 | + * @param string $dn |
|
120 | + * @param int @withAttrib |
|
121 | + * @return array|false |
|
122 | + * @link http://www.php.net/manual/en/function.ldap-explode-dn.php |
|
123 | + */ |
|
124 | + public function explodeDN($dn, $withAttrib) { |
|
125 | + return $this->invokeLDAPMethod('explode_dn', $dn, $withAttrib); |
|
126 | + } |
|
127 | + |
|
128 | + /** |
|
129 | + * @param LDAP $link |
|
130 | + * @param LDAP $result |
|
131 | + * @return mixed |
|
132 | + */ |
|
133 | + public function firstEntry($link, $result) { |
|
134 | + return $this->invokeLDAPMethod('first_entry', $link, $result); |
|
135 | + } |
|
136 | + |
|
137 | + /** |
|
138 | + * @param LDAP $link |
|
139 | + * @param LDAP $result |
|
140 | + * @return array|mixed |
|
141 | + */ |
|
142 | + public function getAttributes($link, $result) { |
|
143 | + return $this->invokeLDAPMethod('get_attributes', $link, $result); |
|
144 | + } |
|
145 | + |
|
146 | + /** |
|
147 | + * @param LDAP $link |
|
148 | + * @param LDAP $result |
|
149 | + * @return mixed|string |
|
150 | + */ |
|
151 | + public function getDN($link, $result) { |
|
152 | + return $this->invokeLDAPMethod('get_dn', $link, $result); |
|
153 | + } |
|
154 | + |
|
155 | + /** |
|
156 | + * @param LDAP $link |
|
157 | + * @param LDAP $result |
|
158 | + * @return array|mixed |
|
159 | + */ |
|
160 | + public function getEntries($link, $result) { |
|
161 | + return $this->invokeLDAPMethod('get_entries', $link, $result); |
|
162 | + } |
|
163 | + |
|
164 | + /** |
|
165 | + * @param LDAP $link |
|
166 | + * @param resource $result |
|
167 | + * @return mixed |
|
168 | + */ |
|
169 | + public function nextEntry($link, $result) { |
|
170 | + return $this->invokeLDAPMethod('next_entry', $link, $result); |
|
171 | + } |
|
172 | + |
|
173 | + /** |
|
174 | + * @param LDAP $link |
|
175 | + * @param string $baseDN |
|
176 | + * @param string $filter |
|
177 | + * @param array $attr |
|
178 | + * @return mixed |
|
179 | + */ |
|
180 | + public function read($link, $baseDN, $filter, $attr) { |
|
181 | + return $this->invokeLDAPMethod('read', $link, $baseDN, $filter, $attr); |
|
182 | + } |
|
183 | + |
|
184 | + /** |
|
185 | + * @param LDAP $link |
|
186 | + * @param string $baseDN |
|
187 | + * @param string $filter |
|
188 | + * @param array $attr |
|
189 | + * @param int $attrsOnly |
|
190 | + * @param int $limit |
|
191 | + * @return mixed |
|
192 | + */ |
|
193 | + public function search($link, $baseDN, $filter, $attr, $attrsOnly = 0, $limit = 0) { |
|
194 | + return $this->invokeLDAPMethod('search', $link, $baseDN, $filter, $attr, $attrsOnly, $limit); |
|
195 | + } |
|
196 | + |
|
197 | + /** |
|
198 | + * @param LDAP $link |
|
199 | + * @param string $userDN |
|
200 | + * @param string $password |
|
201 | + * @return bool |
|
202 | + */ |
|
203 | + public function modReplace($link, $userDN, $password) { |
|
204 | + return $this->invokeLDAPMethod('mod_replace', $link, $userDN, array('userPassword' => $password)); |
|
205 | + } |
|
206 | + |
|
207 | + /** |
|
208 | + * @param LDAP $link |
|
209 | + * @param string $option |
|
210 | + * @param int $value |
|
211 | + * @return bool|mixed |
|
212 | + */ |
|
213 | + public function setOption($link, $option, $value) { |
|
214 | + return $this->invokeLDAPMethod('set_option', $link, $option, $value); |
|
215 | + } |
|
216 | + |
|
217 | + /** |
|
218 | + * @param LDAP $link |
|
219 | + * @return mixed|true |
|
220 | + */ |
|
221 | + public function startTls($link) { |
|
222 | + return $this->invokeLDAPMethod('start_tls', $link); |
|
223 | + } |
|
224 | + |
|
225 | + /** |
|
226 | + * @param resource $link |
|
227 | + * @return bool|mixed |
|
228 | + */ |
|
229 | + public function unbind($link) { |
|
230 | + return $this->invokeLDAPMethod('unbind', $link); |
|
231 | + } |
|
232 | + |
|
233 | + /** |
|
234 | + * Checks whether the server supports LDAP |
|
235 | + * @return boolean if it the case, false otherwise |
|
236 | + * */ |
|
237 | + public function areLDAPFunctionsAvailable() { |
|
238 | + return function_exists('ldap_connect'); |
|
239 | + } |
|
240 | + |
|
241 | + /** |
|
242 | + * Checks whether PHP supports LDAP Paged Results |
|
243 | + * @return boolean if it the case, false otherwise |
|
244 | + * */ |
|
245 | + public function hasPagedResultSupport() { |
|
246 | + $hasSupport = function_exists('ldap_control_paged_result') |
|
247 | + && function_exists('ldap_control_paged_result_response'); |
|
248 | + return $hasSupport; |
|
249 | + } |
|
250 | + |
|
251 | + /** |
|
252 | + * Checks whether the submitted parameter is a resource |
|
253 | + * @param Resource $resource the resource variable to check |
|
254 | + * @return bool true if it is a resource, false otherwise |
|
255 | + */ |
|
256 | + public function isResource($resource) { |
|
257 | + return is_resource($resource); |
|
258 | + } |
|
259 | + |
|
260 | + /** |
|
261 | + * Checks whether the return value from LDAP is wrong or not. |
|
262 | + * |
|
263 | + * When using ldap_search we provide an array, in case multiple bases are |
|
264 | + * configured. Thus, we need to check the array elements. |
|
265 | + * |
|
266 | + * @param $result |
|
267 | + * @return bool |
|
268 | + */ |
|
269 | + protected function isResultFalse($result) { |
|
270 | + if($result === false) { |
|
271 | + return true; |
|
272 | + } |
|
273 | + |
|
274 | + if($this->curFunc === 'ldap_search' && is_array($result)) { |
|
275 | + foreach ($result as $singleResult) { |
|
276 | + if($singleResult === false) { |
|
277 | + return true; |
|
278 | + } |
|
279 | + } |
|
280 | + } |
|
281 | + |
|
282 | + return false; |
|
283 | + } |
|
284 | + |
|
285 | + /** |
|
286 | + * @return mixed |
|
287 | + */ |
|
288 | + protected function invokeLDAPMethod() { |
|
289 | + $arguments = func_get_args(); |
|
290 | + $func = 'ldap_' . array_shift($arguments); |
|
291 | + if(function_exists($func)) { |
|
292 | + $this->preFunctionCall($func, $arguments); |
|
293 | + $result = call_user_func_array($func, $arguments); |
|
294 | + if ($this->isResultFalse($result)) { |
|
295 | + $this->postFunctionCall(); |
|
296 | + } |
|
297 | + return $result; |
|
298 | + } |
|
299 | + return null; |
|
300 | + } |
|
301 | + |
|
302 | + /** |
|
303 | + * @param string $functionName |
|
304 | + * @param array $args |
|
305 | + */ |
|
306 | + private function preFunctionCall($functionName, $args) { |
|
307 | + $this->curFunc = $functionName; |
|
308 | + $this->curArgs = $args; |
|
309 | + } |
|
310 | + |
|
311 | + /** |
|
312 | + * Analyzes the returned LDAP error and acts accordingly if not 0 |
|
313 | + * |
|
314 | + * @param resource $resource the LDAP Connection resource |
|
315 | + * @throws ConstraintViolationException |
|
316 | + * @throws ServerNotAvailableException |
|
317 | + * @throws \Exception |
|
318 | + */ |
|
319 | + private function processLDAPError($resource) { |
|
320 | + $errorCode = ldap_errno($resource); |
|
321 | + if($errorCode === 0) { |
|
322 | + return; |
|
323 | + } |
|
324 | + $errorMsg = ldap_error($resource); |
|
325 | + |
|
326 | + if($this->curFunc === 'ldap_get_entries' |
|
327 | + && $errorCode === -4) { |
|
328 | + } else if ($errorCode === 32) { |
|
329 | + //for now |
|
330 | + } else if ($errorCode === 10) { |
|
331 | + //referrals, we switch them off, but then there is AD :) |
|
332 | + } else if ($errorCode === -1) { |
|
333 | + throw new ServerNotAvailableException('Lost connection to LDAP server.'); |
|
334 | + } else if ($errorCode === 48) { |
|
335 | + throw new \Exception('LDAP authentication method rejected', $errorCode); |
|
336 | + } else if ($errorCode === 1) { |
|
337 | + throw new \Exception('LDAP Operations error', $errorCode); |
|
338 | + } else if ($errorCode === 19) { |
|
339 | + ldap_get_option($this->curArgs[0], LDAP_OPT_ERROR_STRING, $extended_error); |
|
340 | + throw new ConstraintViolationException(!empty($extended_error)?$extended_error:$errorMsg, $errorCode); |
|
341 | + } else { |
|
342 | + \OCP\Util::writeLog('user_ldap', |
|
343 | + 'LDAP error '.$errorMsg.' (' . |
|
344 | + $errorCode.') after calling '. |
|
345 | + $this->curFunc, |
|
346 | + \OCP\Util::DEBUG); |
|
347 | + } |
|
348 | + } |
|
349 | + |
|
350 | + /** |
|
351 | + * Called after an ldap method is run to act on LDAP error if necessary |
|
352 | + */ |
|
353 | + private function postFunctionCall() { |
|
354 | + if($this->isResource($this->curArgs[0])) { |
|
355 | + $resource = $this->curArgs[0]; |
|
356 | + } else if( |
|
357 | + $this->curFunc === 'ldap_search' |
|
358 | + && is_array($this->curArgs[0]) |
|
359 | + && $this->isResource($this->curArgs[0][0]) |
|
360 | + ) { |
|
361 | + // we use always the same LDAP connection resource, is enough to |
|
362 | + // take the first one. |
|
363 | + $resource = $this->curArgs[0][0]; |
|
364 | + } else { |
|
365 | + return; |
|
366 | + } |
|
367 | + |
|
368 | + $this->processLDAPError($resource); |
|
369 | + |
|
370 | + $this->curFunc = ''; |
|
371 | + $this->curArgs = []; |
|
372 | + } |
|
373 | 373 | } |
@@ -31,84 +31,84 @@ |
||
31 | 31 | * @package OCA\User_LDAP |
32 | 32 | */ |
33 | 33 | class DeletedUsersIndex { |
34 | - /** |
|
35 | - * @var \OCP\IConfig $config |
|
36 | - */ |
|
37 | - protected $config; |
|
34 | + /** |
|
35 | + * @var \OCP\IConfig $config |
|
36 | + */ |
|
37 | + protected $config; |
|
38 | 38 | |
39 | - /** |
|
40 | - * @var \OCP\IDBConnection $db |
|
41 | - */ |
|
42 | - protected $db; |
|
39 | + /** |
|
40 | + * @var \OCP\IDBConnection $db |
|
41 | + */ |
|
42 | + protected $db; |
|
43 | 43 | |
44 | - /** |
|
45 | - * @var \OCA\User_LDAP\Mapping\UserMapping $mapping |
|
46 | - */ |
|
47 | - protected $mapping; |
|
44 | + /** |
|
45 | + * @var \OCA\User_LDAP\Mapping\UserMapping $mapping |
|
46 | + */ |
|
47 | + protected $mapping; |
|
48 | 48 | |
49 | - /** |
|
50 | - * @var array $deletedUsers |
|
51 | - */ |
|
52 | - protected $deletedUsers; |
|
49 | + /** |
|
50 | + * @var array $deletedUsers |
|
51 | + */ |
|
52 | + protected $deletedUsers; |
|
53 | 53 | |
54 | - /** |
|
55 | - * @param \OCP\IConfig $config |
|
56 | - * @param \OCP\IDBConnection $db |
|
57 | - * @param \OCA\User_LDAP\Mapping\UserMapping $mapping |
|
58 | - */ |
|
59 | - public function __construct(\OCP\IConfig $config, \OCP\IDBConnection $db, UserMapping $mapping) { |
|
60 | - $this->config = $config; |
|
61 | - $this->db = $db; |
|
62 | - $this->mapping = $mapping; |
|
63 | - } |
|
54 | + /** |
|
55 | + * @param \OCP\IConfig $config |
|
56 | + * @param \OCP\IDBConnection $db |
|
57 | + * @param \OCA\User_LDAP\Mapping\UserMapping $mapping |
|
58 | + */ |
|
59 | + public function __construct(\OCP\IConfig $config, \OCP\IDBConnection $db, UserMapping $mapping) { |
|
60 | + $this->config = $config; |
|
61 | + $this->db = $db; |
|
62 | + $this->mapping = $mapping; |
|
63 | + } |
|
64 | 64 | |
65 | - /** |
|
66 | - * reads LDAP users marked as deleted from the database |
|
67 | - * @return \OCA\User_LDAP\User\OfflineUser[] |
|
68 | - */ |
|
69 | - private function fetchDeletedUsers() { |
|
70 | - $deletedUsers = $this->config->getUsersForUserValue( |
|
71 | - 'user_ldap', 'isDeleted', '1'); |
|
65 | + /** |
|
66 | + * reads LDAP users marked as deleted from the database |
|
67 | + * @return \OCA\User_LDAP\User\OfflineUser[] |
|
68 | + */ |
|
69 | + private function fetchDeletedUsers() { |
|
70 | + $deletedUsers = $this->config->getUsersForUserValue( |
|
71 | + 'user_ldap', 'isDeleted', '1'); |
|
72 | 72 | |
73 | - $userObjects = array(); |
|
74 | - foreach($deletedUsers as $user) { |
|
75 | - $userObjects[] = new OfflineUser($user, $this->config, $this->db, $this->mapping); |
|
76 | - } |
|
77 | - $this->deletedUsers = $userObjects; |
|
73 | + $userObjects = array(); |
|
74 | + foreach($deletedUsers as $user) { |
|
75 | + $userObjects[] = new OfflineUser($user, $this->config, $this->db, $this->mapping); |
|
76 | + } |
|
77 | + $this->deletedUsers = $userObjects; |
|
78 | 78 | |
79 | - return $this->deletedUsers; |
|
80 | - } |
|
79 | + return $this->deletedUsers; |
|
80 | + } |
|
81 | 81 | |
82 | - /** |
|
83 | - * returns all LDAP users that are marked as deleted |
|
84 | - * @return \OCA\User_LDAP\User\OfflineUser[] |
|
85 | - */ |
|
86 | - public function getUsers() { |
|
87 | - if(is_array($this->deletedUsers)) { |
|
88 | - return $this->deletedUsers; |
|
89 | - } |
|
90 | - return $this->fetchDeletedUsers(); |
|
91 | - } |
|
82 | + /** |
|
83 | + * returns all LDAP users that are marked as deleted |
|
84 | + * @return \OCA\User_LDAP\User\OfflineUser[] |
|
85 | + */ |
|
86 | + public function getUsers() { |
|
87 | + if(is_array($this->deletedUsers)) { |
|
88 | + return $this->deletedUsers; |
|
89 | + } |
|
90 | + return $this->fetchDeletedUsers(); |
|
91 | + } |
|
92 | 92 | |
93 | - /** |
|
94 | - * whether at least one user was detected as deleted |
|
95 | - * @return bool |
|
96 | - */ |
|
97 | - public function hasUsers() { |
|
98 | - if($this->deletedUsers === false) { |
|
99 | - $this->fetchDeletedUsers(); |
|
100 | - } |
|
101 | - if(is_array($this->deletedUsers) && count($this->deletedUsers) > 0) { |
|
102 | - return true; |
|
103 | - } |
|
104 | - return false; |
|
105 | - } |
|
93 | + /** |
|
94 | + * whether at least one user was detected as deleted |
|
95 | + * @return bool |
|
96 | + */ |
|
97 | + public function hasUsers() { |
|
98 | + if($this->deletedUsers === false) { |
|
99 | + $this->fetchDeletedUsers(); |
|
100 | + } |
|
101 | + if(is_array($this->deletedUsers) && count($this->deletedUsers) > 0) { |
|
102 | + return true; |
|
103 | + } |
|
104 | + return false; |
|
105 | + } |
|
106 | 106 | |
107 | - /** |
|
108 | - * marks a user as deleted |
|
109 | - * @param string $ocName |
|
110 | - */ |
|
111 | - public function markUser($ocName) { |
|
112 | - $this->config->setUserValue($ocName, 'user_ldap', 'isDeleted', '1'); |
|
113 | - } |
|
107 | + /** |
|
108 | + * marks a user as deleted |
|
109 | + * @param string $ocName |
|
110 | + */ |
|
111 | + public function markUser($ocName) { |
|
112 | + $this->config->setUserValue($ocName, 'user_ldap', 'isDeleted', '1'); |
|
113 | + } |
|
114 | 114 | } |
@@ -30,13 +30,13 @@ |
||
30 | 30 | * defines methods that are required by User class for LDAP interaction |
31 | 31 | */ |
32 | 32 | interface IUserTools { |
33 | - public function getConnection(); |
|
33 | + public function getConnection(); |
|
34 | 34 | |
35 | - public function readAttribute($dn, $attr, $filter = 'objectClass=*'); |
|
35 | + public function readAttribute($dn, $attr, $filter = 'objectClass=*'); |
|
36 | 36 | |
37 | - public function stringResemblesDN($string); |
|
37 | + public function stringResemblesDN($string); |
|
38 | 38 | |
39 | - public function dn2username($dn, $ldapname = null); |
|
39 | + public function dn2username($dn, $ldapname = null); |
|
40 | 40 | |
41 | - public function username2dn($name); |
|
41 | + public function username2dn($name); |
|
42 | 42 | } |