@@ -31,59 +31,59 @@ |
||
| 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 | } |
@@ -62,7 +62,7 @@ |
||
| 62 | 62 | // assign default values |
| 63 | 63 | $config = new Configuration('', false); |
| 64 | 64 | $defaults = $config->getDefaults(); |
| 65 | - foreach($defaults as $key => $default) { |
|
| 65 | + foreach ($defaults as $key => $default) { |
|
| 66 | 66 | $parameters[$key.'_default'] = $default; |
| 67 | 67 | } |
| 68 | 68 | |
@@ -87,7 +87,7 @@ discard block |
||
| 87 | 87 | $this->configuration = new Configuration($configPrefix, |
| 88 | 88 | !is_null($configID)); |
| 89 | 89 | $memcache = \OC::$server->getMemCacheFactory(); |
| 90 | - if($memcache->isAvailable()) { |
|
| 90 | + if ($memcache->isAvailable()) { |
|
| 91 | 91 | $this->cache = $memcache->create(); |
| 92 | 92 | } |
| 93 | 93 | $helper = new Helper(\OC::$server->getConfig()); |
@@ -99,7 +99,7 @@ discard block |
||
| 99 | 99 | } |
| 100 | 100 | |
| 101 | 101 | public function __destruct() { |
| 102 | - if(!$this->dontDestruct && $this->ldap->isResource($this->ldapConnectionRes)) { |
|
| 102 | + if (!$this->dontDestruct && $this->ldap->isResource($this->ldapConnectionRes)) { |
|
| 103 | 103 | @$this->ldap->unbind($this->ldapConnectionRes); |
| 104 | 104 | }; |
| 105 | 105 | } |
@@ -119,11 +119,11 @@ discard block |
||
| 119 | 119 | * @return bool|mixed|void |
| 120 | 120 | */ |
| 121 | 121 | public function __get($name) { |
| 122 | - if(!$this->configured) { |
|
| 122 | + if (!$this->configured) { |
|
| 123 | 123 | $this->readConfiguration(); |
| 124 | 124 | } |
| 125 | 125 | |
| 126 | - if($name === 'hasPagedResultSupport') { |
|
| 126 | + if ($name === 'hasPagedResultSupport') { |
|
| 127 | 127 | return $this->hasPagedResultSupport; |
| 128 | 128 | } |
| 129 | 129 | |
@@ -139,7 +139,7 @@ discard block |
||
| 139 | 139 | $before = $this->configuration->$name; |
| 140 | 140 | $this->configuration->$name = $value; |
| 141 | 141 | $after = $this->configuration->$name; |
| 142 | - if($before !== $after) { |
|
| 142 | + if ($before !== $after) { |
|
| 143 | 143 | if ($this->configID !== '') { |
| 144 | 144 | $this->configuration->saveConfiguration(); |
| 145 | 145 | } |
@@ -154,7 +154,7 @@ discard block |
||
| 154 | 154 | * @param bool $state |
| 155 | 155 | */ |
| 156 | 156 | public function setIgnoreValidation($state) { |
| 157 | - $this->ignoreValidation = (bool)$state; |
|
| 157 | + $this->ignoreValidation = (bool) $state; |
|
| 158 | 158 | } |
| 159 | 159 | |
| 160 | 160 | /** |
@@ -170,14 +170,14 @@ discard block |
||
| 170 | 170 | * Returns the LDAP handler |
| 171 | 171 | */ |
| 172 | 172 | public function getConnectionResource() { |
| 173 | - if(!$this->ldapConnectionRes) { |
|
| 173 | + if (!$this->ldapConnectionRes) { |
|
| 174 | 174 | $this->init(); |
| 175 | - } else if(!$this->ldap->isResource($this->ldapConnectionRes)) { |
|
| 175 | + } else if (!$this->ldap->isResource($this->ldapConnectionRes)) { |
|
| 176 | 176 | $this->ldapConnectionRes = null; |
| 177 | 177 | $this->establishConnection(); |
| 178 | 178 | } |
| 179 | - if(is_null($this->ldapConnectionRes)) { |
|
| 180 | - \OCP\Util::writeLog('user_ldap', 'No LDAP Connection to server ' . $this->configuration->ldapHost, \OCP\Util::ERROR); |
|
| 179 | + if (is_null($this->ldapConnectionRes)) { |
|
| 180 | + \OCP\Util::writeLog('user_ldap', 'No LDAP Connection to server '.$this->configuration->ldapHost, \OCP\Util::ERROR); |
|
| 181 | 181 | throw new ServerNotAvailableException('Connection to LDAP server could not be established'); |
| 182 | 182 | } |
| 183 | 183 | return $this->ldapConnectionRes; |
@@ -187,7 +187,7 @@ discard block |
||
| 187 | 187 | * resets the connection resource |
| 188 | 188 | */ |
| 189 | 189 | public function resetConnectionResource() { |
| 190 | - if(!is_null($this->ldapConnectionRes)) { |
|
| 190 | + if (!is_null($this->ldapConnectionRes)) { |
|
| 191 | 191 | @$this->ldap->unbind($this->ldapConnectionRes); |
| 192 | 192 | $this->ldapConnectionRes = null; |
| 193 | 193 | } |
@@ -199,7 +199,7 @@ discard block |
||
| 199 | 199 | */ |
| 200 | 200 | private function getCacheKey($key) { |
| 201 | 201 | $prefix = 'LDAP-'.$this->configID.'-'.$this->configPrefix.'-'; |
| 202 | - if(is_null($key)) { |
|
| 202 | + if (is_null($key)) { |
|
| 203 | 203 | return $prefix; |
| 204 | 204 | } |
| 205 | 205 | return $prefix.md5($key); |
@@ -210,10 +210,10 @@ discard block |
||
| 210 | 210 | * @return mixed|null |
| 211 | 211 | */ |
| 212 | 212 | public function getFromCache($key) { |
| 213 | - if(!$this->configured) { |
|
| 213 | + if (!$this->configured) { |
|
| 214 | 214 | $this->readConfiguration(); |
| 215 | 215 | } |
| 216 | - if(is_null($this->cache) || !$this->configuration->ldapCacheTTL) { |
|
| 216 | + if (is_null($this->cache) || !$this->configuration->ldapCacheTTL) { |
|
| 217 | 217 | return null; |
| 218 | 218 | } |
| 219 | 219 | $key = $this->getCacheKey($key); |
@@ -228,10 +228,10 @@ discard block |
||
| 228 | 228 | * @return string |
| 229 | 229 | */ |
| 230 | 230 | public function writeToCache($key, $value) { |
| 231 | - if(!$this->configured) { |
|
| 231 | + if (!$this->configured) { |
|
| 232 | 232 | $this->readConfiguration(); |
| 233 | 233 | } |
| 234 | - if(is_null($this->cache) |
|
| 234 | + if (is_null($this->cache) |
|
| 235 | 235 | || !$this->configuration->ldapCacheTTL |
| 236 | 236 | || !$this->configuration->ldapConfigurationActive) { |
| 237 | 237 | return null; |
@@ -242,7 +242,7 @@ discard block |
||
| 242 | 242 | } |
| 243 | 243 | |
| 244 | 244 | public function clearCache() { |
| 245 | - if(!is_null($this->cache)) { |
|
| 245 | + if (!is_null($this->cache)) { |
|
| 246 | 246 | $this->cache->clear($this->getCacheKey(null)); |
| 247 | 247 | } |
| 248 | 248 | } |
@@ -254,7 +254,7 @@ discard block |
||
| 254 | 254 | * @return null |
| 255 | 255 | */ |
| 256 | 256 | private function readConfiguration($force = false) { |
| 257 | - if((!$this->configured || $force) && !is_null($this->configID)) { |
|
| 257 | + if ((!$this->configured || $force) && !is_null($this->configID)) { |
|
| 258 | 258 | $this->configuration->readConfiguration(); |
| 259 | 259 | $this->configured = $this->validateConfiguration(); |
| 260 | 260 | } |
@@ -267,12 +267,12 @@ discard block |
||
| 267 | 267 | * @return boolean true if config validates, false otherwise. Check with $setParameters for detailed success on single parameters |
| 268 | 268 | */ |
| 269 | 269 | public function setConfiguration($config, &$setParameters = null) { |
| 270 | - if(is_null($setParameters)) { |
|
| 270 | + if (is_null($setParameters)) { |
|
| 271 | 271 | $setParameters = array(); |
| 272 | 272 | } |
| 273 | 273 | $this->doNotValidate = false; |
| 274 | 274 | $this->configuration->setConfiguration($config, $setParameters); |
| 275 | - if(count($setParameters) > 0) { |
|
| 275 | + if (count($setParameters) > 0) { |
|
| 276 | 276 | $this->configured = $this->validateConfiguration(); |
| 277 | 277 | } |
| 278 | 278 | |
@@ -299,10 +299,10 @@ discard block |
||
| 299 | 299 | $config = $this->configuration->getConfiguration(); |
| 300 | 300 | $cta = $this->configuration->getConfigTranslationArray(); |
| 301 | 301 | $result = array(); |
| 302 | - foreach($cta as $dbkey => $configkey) { |
|
| 303 | - switch($configkey) { |
|
| 302 | + foreach ($cta as $dbkey => $configkey) { |
|
| 303 | + switch ($configkey) { |
|
| 304 | 304 | case 'homeFolderNamingRule': |
| 305 | - if(strpos($config[$configkey], 'attr:') === 0) { |
|
| 305 | + if (strpos($config[$configkey], 'attr:') === 0) { |
|
| 306 | 306 | $result[$dbkey] = substr($config[$configkey], 5); |
| 307 | 307 | } else { |
| 308 | 308 | $result[$dbkey] = ''; |
@@ -313,7 +313,7 @@ discard block |
||
| 313 | 313 | case 'ldapBaseGroups': |
| 314 | 314 | case 'ldapAttributesForUserSearch': |
| 315 | 315 | case 'ldapAttributesForGroupSearch': |
| 316 | - if(is_array($config[$configkey])) { |
|
| 316 | + if (is_array($config[$configkey])) { |
|
| 317 | 317 | $result[$dbkey] = implode("\n", $config[$configkey]); |
| 318 | 318 | break; |
| 319 | 319 | } //else follows default |
@@ -326,23 +326,23 @@ discard block |
||
| 326 | 326 | |
| 327 | 327 | private function doSoftValidation() { |
| 328 | 328 | //if User or Group Base are not set, take over Base DN setting |
| 329 | - foreach(array('ldapBaseUsers', 'ldapBaseGroups') as $keyBase) { |
|
| 329 | + foreach (array('ldapBaseUsers', 'ldapBaseGroups') as $keyBase) { |
|
| 330 | 330 | $val = $this->configuration->$keyBase; |
| 331 | - if(empty($val)) { |
|
| 331 | + if (empty($val)) { |
|
| 332 | 332 | $this->configuration->$keyBase = $this->configuration->ldapBase; |
| 333 | 333 | } |
| 334 | 334 | } |
| 335 | 335 | |
| 336 | - foreach(array('ldapExpertUUIDUserAttr' => 'ldapUuidUserAttribute', |
|
| 336 | + foreach (array('ldapExpertUUIDUserAttr' => 'ldapUuidUserAttribute', |
|
| 337 | 337 | 'ldapExpertUUIDGroupAttr' => 'ldapUuidGroupAttribute') |
| 338 | 338 | as $expertSetting => $effectiveSetting) { |
| 339 | 339 | $uuidOverride = $this->configuration->$expertSetting; |
| 340 | - if(!empty($uuidOverride)) { |
|
| 340 | + if (!empty($uuidOverride)) { |
|
| 341 | 341 | $this->configuration->$effectiveSetting = $uuidOverride; |
| 342 | 342 | } else { |
| 343 | 343 | $uuidAttributes = array('auto', 'entryuuid', 'nsuniqueid', |
| 344 | 344 | 'objectguid', 'guid', 'ipauniqueid'); |
| 345 | - if(!in_array($this->configuration->$effectiveSetting, |
|
| 345 | + if (!in_array($this->configuration->$effectiveSetting, |
|
| 346 | 346 | $uuidAttributes) |
| 347 | 347 | && (!is_null($this->configID))) { |
| 348 | 348 | $this->configuration->$effectiveSetting = 'auto'; |
@@ -364,14 +364,14 @@ discard block |
||
| 364 | 364 | //make sure empty search attributes are saved as simple, empty array |
| 365 | 365 | $saKeys = array('ldapAttributesForUserSearch', |
| 366 | 366 | 'ldapAttributesForGroupSearch'); |
| 367 | - foreach($saKeys as $key) { |
|
| 367 | + foreach ($saKeys as $key) { |
|
| 368 | 368 | $val = $this->configuration->$key; |
| 369 | - if(is_array($val) && count($val) === 1 && empty($val[0])) { |
|
| 369 | + if (is_array($val) && count($val) === 1 && empty($val[0])) { |
|
| 370 | 370 | $this->configuration->$key = array(); |
| 371 | 371 | } |
| 372 | 372 | } |
| 373 | 373 | |
| 374 | - if((stripos($this->configuration->ldapHost, 'ldaps://') === 0) |
|
| 374 | + if ((stripos($this->configuration->ldapHost, 'ldaps://') === 0) |
|
| 375 | 375 | && $this->configuration->ldapTLS) { |
| 376 | 376 | $this->configuration->ldapTLS = false; |
| 377 | 377 | \OCP\Util::writeLog('user_ldap', |
@@ -392,10 +392,10 @@ discard block |
||
| 392 | 392 | //options that shall not be empty |
| 393 | 393 | $options = array('ldapHost', 'ldapPort', 'ldapUserDisplayName', |
| 394 | 394 | 'ldapGroupDisplayName', 'ldapLoginFilter'); |
| 395 | - foreach($options as $key) { |
|
| 395 | + foreach ($options as $key) { |
|
| 396 | 396 | $val = $this->configuration->$key; |
| 397 | - if(empty($val)) { |
|
| 398 | - switch($key) { |
|
| 397 | + if (empty($val)) { |
|
| 398 | + switch ($key) { |
|
| 399 | 399 | case 'ldapHost': |
| 400 | 400 | $subj = 'LDAP Host'; |
| 401 | 401 | break; |
@@ -426,7 +426,7 @@ discard block |
||
| 426 | 426 | $agent = $this->configuration->ldapAgentName; |
| 427 | 427 | $pwd = $this->configuration->ldapAgentPassword; |
| 428 | 428 | if ( |
| 429 | - ($agent === '' && $pwd !== '') |
|
| 429 | + ($agent === '' && $pwd !== '') |
|
| 430 | 430 | || ($agent !== '' && $pwd === '') |
| 431 | 431 | ) { |
| 432 | 432 | \OCP\Util::writeLog('user_ldap', |
@@ -441,14 +441,14 @@ discard block |
||
| 441 | 441 | $baseUsers = $this->configuration->ldapBaseUsers; |
| 442 | 442 | $baseGroups = $this->configuration->ldapBaseGroups; |
| 443 | 443 | |
| 444 | - if(empty($base) && empty($baseUsers) && empty($baseGroups)) { |
|
| 444 | + if (empty($base) && empty($baseUsers) && empty($baseGroups)) { |
|
| 445 | 445 | \OCP\Util::writeLog('user_ldap', |
| 446 | 446 | $errorStr.'Not a single Base DN given.', |
| 447 | 447 | \OCP\Util::WARN); |
| 448 | 448 | $configurationOK = false; |
| 449 | 449 | } |
| 450 | 450 | |
| 451 | - if(mb_strpos($this->configuration->ldapLoginFilter, '%uid', 0, 'UTF-8') |
|
| 451 | + if (mb_strpos($this->configuration->ldapLoginFilter, '%uid', 0, 'UTF-8') |
|
| 452 | 452 | === false) { |
| 453 | 453 | \OCP\Util::writeLog('user_ldap', |
| 454 | 454 | $errorStr.'login filter does not contain %uid '. |
@@ -466,7 +466,7 @@ discard block |
||
| 466 | 466 | */ |
| 467 | 467 | private function validateConfiguration() { |
| 468 | 468 | |
| 469 | - if($this->doNotValidate) { |
|
| 469 | + if ($this->doNotValidate) { |
|
| 470 | 470 | //don't do a validation if it is a new configuration with pure |
| 471 | 471 | //default values. Will be allowed on changes via __set or |
| 472 | 472 | //setConfiguration |
@@ -487,21 +487,21 @@ discard block |
||
| 487 | 487 | * Connects and Binds to LDAP |
| 488 | 488 | */ |
| 489 | 489 | private function establishConnection() { |
| 490 | - if(!$this->configuration->ldapConfigurationActive) { |
|
| 490 | + if (!$this->configuration->ldapConfigurationActive) { |
|
| 491 | 491 | return null; |
| 492 | 492 | } |
| 493 | 493 | static $phpLDAPinstalled = true; |
| 494 | - if(!$phpLDAPinstalled) { |
|
| 494 | + if (!$phpLDAPinstalled) { |
|
| 495 | 495 | return false; |
| 496 | 496 | } |
| 497 | - if(!$this->ignoreValidation && !$this->configured) { |
|
| 497 | + if (!$this->ignoreValidation && !$this->configured) { |
|
| 498 | 498 | \OCP\Util::writeLog('user_ldap', |
| 499 | 499 | 'Configuration is invalid, cannot connect', |
| 500 | 500 | \OCP\Util::WARN); |
| 501 | 501 | return false; |
| 502 | 502 | } |
| 503 | - if(!$this->ldapConnectionRes) { |
|
| 504 | - if(!$this->ldap->areLDAPFunctionsAvailable()) { |
|
| 503 | + if (!$this->ldapConnectionRes) { |
|
| 504 | + if (!$this->ldap->areLDAPFunctionsAvailable()) { |
|
| 505 | 505 | $phpLDAPinstalled = false; |
| 506 | 506 | \OCP\Util::writeLog('user_ldap', |
| 507 | 507 | 'function ldap_connect is not available. Make '. |
@@ -510,8 +510,8 @@ discard block |
||
| 510 | 510 | |
| 511 | 511 | return false; |
| 512 | 512 | } |
| 513 | - if($this->configuration->turnOffCertCheck) { |
|
| 514 | - if(putenv('LDAPTLS_REQCERT=never')) { |
|
| 513 | + if ($this->configuration->turnOffCertCheck) { |
|
| 514 | + if (putenv('LDAPTLS_REQCERT=never')) { |
|
| 515 | 515 | \OCP\Util::writeLog('user_ldap', |
| 516 | 516 | 'Turned off SSL certificate validation successfully.', |
| 517 | 517 | \OCP\Util::DEBUG); |
@@ -534,24 +534,24 @@ discard block |
||
| 534 | 534 | $error = $this->ldap->isResource($this->ldapConnectionRes) ? |
| 535 | 535 | $this->ldap->errno($this->ldapConnectionRes) : -1; |
| 536 | 536 | } |
| 537 | - if($bindStatus === true) { |
|
| 537 | + if ($bindStatus === true) { |
|
| 538 | 538 | return $bindStatus; |
| 539 | 539 | } |
| 540 | 540 | } catch (\OC\ServerNotAvailableException $e) { |
| 541 | - if(trim($this->configuration->ldapBackupHost) === "") { |
|
| 541 | + if (trim($this->configuration->ldapBackupHost) === "") { |
|
| 542 | 542 | throw $e; |
| 543 | 543 | } |
| 544 | 544 | } |
| 545 | 545 | |
| 546 | 546 | //if LDAP server is not reachable, try the Backup (Replica!) Server |
| 547 | - if( $error !== 0 |
|
| 547 | + if ($error !== 0 |
|
| 548 | 548 | || $this->configuration->ldapOverrideMainServer |
| 549 | 549 | || $this->getFromCache('overrideMainServer')) |
| 550 | 550 | { |
| 551 | 551 | $this->doConnect($this->configuration->ldapBackupHost, |
| 552 | 552 | $this->configuration->ldapBackupPort); |
| 553 | 553 | $bindStatus = $this->bind(); |
| 554 | - if($bindStatus && $error === -1 && !$this->getFromCache('overrideMainServer')) { |
|
| 554 | + if ($bindStatus && $error === -1 && !$this->getFromCache('overrideMainServer')) { |
|
| 555 | 555 | //when bind to backup server succeeded and failed to main server, |
| 556 | 556 | //skip contacting him until next cache refresh |
| 557 | 557 | $this->writeToCache('overrideMainServer', true); |
@@ -573,9 +573,9 @@ discard block |
||
| 573 | 573 | return false; |
| 574 | 574 | } |
| 575 | 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) { |
|
| 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 | 579 | $this->ldap->startTls($this->ldapConnectionRes); |
| 580 | 580 | } |
| 581 | 581 | } |
@@ -590,25 +590,25 @@ discard block |
||
| 590 | 590 | */ |
| 591 | 591 | public function bind() { |
| 592 | 592 | static $getConnectionResourceAttempt = false; |
| 593 | - if(!$this->configuration->ldapConfigurationActive) { |
|
| 593 | + if (!$this->configuration->ldapConfigurationActive) { |
|
| 594 | 594 | return false; |
| 595 | 595 | } |
| 596 | - if($getConnectionResourceAttempt) { |
|
| 596 | + if ($getConnectionResourceAttempt) { |
|
| 597 | 597 | $getConnectionResourceAttempt = false; |
| 598 | 598 | return false; |
| 599 | 599 | } |
| 600 | 600 | $getConnectionResourceAttempt = true; |
| 601 | 601 | $cr = $this->getConnectionResource(); |
| 602 | 602 | $getConnectionResourceAttempt = false; |
| 603 | - if(!$this->ldap->isResource($cr)) { |
|
| 603 | + if (!$this->ldap->isResource($cr)) { |
|
| 604 | 604 | return false; |
| 605 | 605 | } |
| 606 | 606 | $ldapLogin = @$this->ldap->bind($cr, |
| 607 | 607 | $this->configuration->ldapAgentName, |
| 608 | 608 | $this->configuration->ldapAgentPassword); |
| 609 | - if(!$ldapLogin) { |
|
| 609 | + if (!$ldapLogin) { |
|
| 610 | 610 | \OCP\Util::writeLog('user_ldap', |
| 611 | - 'Bind failed: ' . $this->ldap->errno($cr) . ': ' . $this->ldap->error($cr), |
|
| 611 | + 'Bind failed: '.$this->ldap->errno($cr).': '.$this->ldap->error($cr), |
|
| 612 | 612 | \OCP\Util::WARN); |
| 613 | 613 | $this->ldapConnectionRes = null; |
| 614 | 614 | return false; |
@@ -52,574 +52,574 @@ |
||
| 52 | 52 | * @property string ldapUuidGroupAttribute |
| 53 | 53 | */ |
| 54 | 54 | class Connection extends LDAPUtility { |
| 55 | - private $ldapConnectionRes = null; |
|
| 56 | - private $configPrefix; |
|
| 57 | - private $configID; |
|
| 58 | - private $configured = false; |
|
| 59 | - private $hasPagedResultSupport = true; |
|
| 60 | - //whether connection should be kept on __destruct |
|
| 61 | - private $dontDestruct = false; |
|
| 62 | - |
|
| 63 | - /** |
|
| 64 | - * @var bool runtime flag that indicates whether supported primary groups are available |
|
| 65 | - */ |
|
| 66 | - public $hasPrimaryGroups = true; |
|
| 67 | - |
|
| 68 | - /** |
|
| 69 | - * @var bool runtime flag that indicates whether supported POSIX gidNumber are available |
|
| 70 | - */ |
|
| 71 | - public $hasGidNumber = true; |
|
| 72 | - |
|
| 73 | - //cache handler |
|
| 74 | - protected $cache; |
|
| 75 | - |
|
| 76 | - /** @var Configuration settings handler **/ |
|
| 77 | - protected $configuration; |
|
| 78 | - |
|
| 79 | - protected $doNotValidate = false; |
|
| 80 | - |
|
| 81 | - protected $ignoreValidation = false; |
|
| 82 | - |
|
| 83 | - /** |
|
| 84 | - * Constructor |
|
| 85 | - * @param ILDAPWrapper $ldap |
|
| 86 | - * @param string $configPrefix a string with the prefix for the configkey column (appconfig table) |
|
| 87 | - * @param string|null $configID a string with the value for the appid column (appconfig table) or null for on-the-fly connections |
|
| 88 | - */ |
|
| 89 | - public function __construct(ILDAPWrapper $ldap, $configPrefix = '', $configID = 'user_ldap') { |
|
| 90 | - parent::__construct($ldap); |
|
| 91 | - $this->configPrefix = $configPrefix; |
|
| 92 | - $this->configID = $configID; |
|
| 93 | - $this->configuration = new Configuration($configPrefix, |
|
| 94 | - !is_null($configID)); |
|
| 95 | - $memcache = \OC::$server->getMemCacheFactory(); |
|
| 96 | - if($memcache->isAvailable()) { |
|
| 97 | - $this->cache = $memcache->create(); |
|
| 98 | - } |
|
| 99 | - $helper = new Helper(\OC::$server->getConfig()); |
|
| 100 | - $this->doNotValidate = !in_array($this->configPrefix, |
|
| 101 | - $helper->getServerConfigurationPrefixes()); |
|
| 102 | - $this->hasPagedResultSupport = |
|
| 103 | - intval($this->configuration->ldapPagingSize) !== 0 |
|
| 104 | - || $this->ldap->hasPagedResultSupport(); |
|
| 105 | - } |
|
| 106 | - |
|
| 107 | - public function __destruct() { |
|
| 108 | - if(!$this->dontDestruct && $this->ldap->isResource($this->ldapConnectionRes)) { |
|
| 109 | - @$this->ldap->unbind($this->ldapConnectionRes); |
|
| 110 | - }; |
|
| 111 | - } |
|
| 112 | - |
|
| 113 | - /** |
|
| 114 | - * defines behaviour when the instance is cloned |
|
| 115 | - */ |
|
| 116 | - public function __clone() { |
|
| 117 | - $this->configuration = new Configuration($this->configPrefix, |
|
| 118 | - !is_null($this->configID)); |
|
| 119 | - $this->ldapConnectionRes = null; |
|
| 120 | - $this->dontDestruct = true; |
|
| 121 | - } |
|
| 122 | - |
|
| 123 | - /** |
|
| 124 | - * @param string $name |
|
| 125 | - * @return bool|mixed|void |
|
| 126 | - */ |
|
| 127 | - public function __get($name) { |
|
| 128 | - if(!$this->configured) { |
|
| 129 | - $this->readConfiguration(); |
|
| 130 | - } |
|
| 131 | - |
|
| 132 | - if($name === 'hasPagedResultSupport') { |
|
| 133 | - return $this->hasPagedResultSupport; |
|
| 134 | - } |
|
| 135 | - |
|
| 136 | - return $this->configuration->$name; |
|
| 137 | - } |
|
| 138 | - |
|
| 139 | - /** |
|
| 140 | - * @param string $name |
|
| 141 | - * @param mixed $value |
|
| 142 | - */ |
|
| 143 | - public function __set($name, $value) { |
|
| 144 | - $this->doNotValidate = false; |
|
| 145 | - $before = $this->configuration->$name; |
|
| 146 | - $this->configuration->$name = $value; |
|
| 147 | - $after = $this->configuration->$name; |
|
| 148 | - if($before !== $after) { |
|
| 149 | - if ($this->configID !== '') { |
|
| 150 | - $this->configuration->saveConfiguration(); |
|
| 151 | - } |
|
| 152 | - $this->validateConfiguration(); |
|
| 153 | - } |
|
| 154 | - } |
|
| 155 | - |
|
| 156 | - /** |
|
| 157 | - * sets whether the result of the configuration validation shall |
|
| 158 | - * be ignored when establishing the connection. Used by the Wizard |
|
| 159 | - * in early configuration state. |
|
| 160 | - * @param bool $state |
|
| 161 | - */ |
|
| 162 | - public function setIgnoreValidation($state) { |
|
| 163 | - $this->ignoreValidation = (bool)$state; |
|
| 164 | - } |
|
| 165 | - |
|
| 166 | - /** |
|
| 167 | - * initializes the LDAP backend |
|
| 168 | - * @param bool $force read the config settings no matter what |
|
| 169 | - */ |
|
| 170 | - public function init($force = false) { |
|
| 171 | - $this->readConfiguration($force); |
|
| 172 | - $this->establishConnection(); |
|
| 173 | - } |
|
| 174 | - |
|
| 175 | - /** |
|
| 176 | - * Returns the LDAP handler |
|
| 177 | - */ |
|
| 178 | - public function getConnectionResource() { |
|
| 179 | - if(!$this->ldapConnectionRes) { |
|
| 180 | - $this->init(); |
|
| 181 | - } else if(!$this->ldap->isResource($this->ldapConnectionRes)) { |
|
| 182 | - $this->ldapConnectionRes = null; |
|
| 183 | - $this->establishConnection(); |
|
| 184 | - } |
|
| 185 | - if(is_null($this->ldapConnectionRes)) { |
|
| 186 | - \OCP\Util::writeLog('user_ldap', 'No LDAP Connection to server ' . $this->configuration->ldapHost, \OCP\Util::ERROR); |
|
| 187 | - throw new ServerNotAvailableException('Connection to LDAP server could not be established'); |
|
| 188 | - } |
|
| 189 | - return $this->ldapConnectionRes; |
|
| 190 | - } |
|
| 191 | - |
|
| 192 | - /** |
|
| 193 | - * resets the connection resource |
|
| 194 | - */ |
|
| 195 | - public function resetConnectionResource() { |
|
| 196 | - if(!is_null($this->ldapConnectionRes)) { |
|
| 197 | - @$this->ldap->unbind($this->ldapConnectionRes); |
|
| 198 | - $this->ldapConnectionRes = null; |
|
| 199 | - } |
|
| 200 | - } |
|
| 201 | - |
|
| 202 | - /** |
|
| 203 | - * @param string|null $key |
|
| 204 | - * @return string |
|
| 205 | - */ |
|
| 206 | - private function getCacheKey($key) { |
|
| 207 | - $prefix = 'LDAP-'.$this->configID.'-'.$this->configPrefix.'-'; |
|
| 208 | - if(is_null($key)) { |
|
| 209 | - return $prefix; |
|
| 210 | - } |
|
| 211 | - return $prefix.md5($key); |
|
| 212 | - } |
|
| 213 | - |
|
| 214 | - /** |
|
| 215 | - * @param string $key |
|
| 216 | - * @return mixed|null |
|
| 217 | - */ |
|
| 218 | - public function getFromCache($key) { |
|
| 219 | - if(!$this->configured) { |
|
| 220 | - $this->readConfiguration(); |
|
| 221 | - } |
|
| 222 | - if(is_null($this->cache) || !$this->configuration->ldapCacheTTL) { |
|
| 223 | - return null; |
|
| 224 | - } |
|
| 225 | - $key = $this->getCacheKey($key); |
|
| 226 | - |
|
| 227 | - return json_decode(base64_decode($this->cache->get($key)), true); |
|
| 228 | - } |
|
| 229 | - |
|
| 230 | - /** |
|
| 231 | - * @param string $key |
|
| 232 | - * @param mixed $value |
|
| 233 | - * |
|
| 234 | - * @return string |
|
| 235 | - */ |
|
| 236 | - public function writeToCache($key, $value) { |
|
| 237 | - if(!$this->configured) { |
|
| 238 | - $this->readConfiguration(); |
|
| 239 | - } |
|
| 240 | - if(is_null($this->cache) |
|
| 241 | - || !$this->configuration->ldapCacheTTL |
|
| 242 | - || !$this->configuration->ldapConfigurationActive) { |
|
| 243 | - return null; |
|
| 244 | - } |
|
| 245 | - $key = $this->getCacheKey($key); |
|
| 246 | - $value = base64_encode(json_encode($value)); |
|
| 247 | - $this->cache->set($key, $value, $this->configuration->ldapCacheTTL); |
|
| 248 | - } |
|
| 249 | - |
|
| 250 | - public function clearCache() { |
|
| 251 | - if(!is_null($this->cache)) { |
|
| 252 | - $this->cache->clear($this->getCacheKey(null)); |
|
| 253 | - } |
|
| 254 | - } |
|
| 255 | - |
|
| 256 | - /** |
|
| 257 | - * Caches the general LDAP configuration. |
|
| 258 | - * @param bool $force optional. true, if the re-read should be forced. defaults |
|
| 259 | - * to false. |
|
| 260 | - * @return null |
|
| 261 | - */ |
|
| 262 | - private function readConfiguration($force = false) { |
|
| 263 | - if((!$this->configured || $force) && !is_null($this->configID)) { |
|
| 264 | - $this->configuration->readConfiguration(); |
|
| 265 | - $this->configured = $this->validateConfiguration(); |
|
| 266 | - } |
|
| 267 | - } |
|
| 268 | - |
|
| 269 | - /** |
|
| 270 | - * set LDAP configuration with values delivered by an array, not read from configuration |
|
| 271 | - * @param array $config array that holds the config parameters in an associated array |
|
| 272 | - * @param array &$setParameters optional; array where the set fields will be given to |
|
| 273 | - * @return boolean true if config validates, false otherwise. Check with $setParameters for detailed success on single parameters |
|
| 274 | - */ |
|
| 275 | - public function setConfiguration($config, &$setParameters = null) { |
|
| 276 | - if(is_null($setParameters)) { |
|
| 277 | - $setParameters = array(); |
|
| 278 | - } |
|
| 279 | - $this->doNotValidate = false; |
|
| 280 | - $this->configuration->setConfiguration($config, $setParameters); |
|
| 281 | - if(count($setParameters) > 0) { |
|
| 282 | - $this->configured = $this->validateConfiguration(); |
|
| 283 | - } |
|
| 284 | - |
|
| 285 | - |
|
| 286 | - return $this->configured; |
|
| 287 | - } |
|
| 288 | - |
|
| 289 | - /** |
|
| 290 | - * saves the current Configuration in the database and empties the |
|
| 291 | - * cache |
|
| 292 | - * @return null |
|
| 293 | - */ |
|
| 294 | - public function saveConfiguration() { |
|
| 295 | - $this->configuration->saveConfiguration(); |
|
| 296 | - $this->clearCache(); |
|
| 297 | - } |
|
| 298 | - |
|
| 299 | - /** |
|
| 300 | - * get the current LDAP configuration |
|
| 301 | - * @return array |
|
| 302 | - */ |
|
| 303 | - public function getConfiguration() { |
|
| 304 | - $this->readConfiguration(); |
|
| 305 | - $config = $this->configuration->getConfiguration(); |
|
| 306 | - $cta = $this->configuration->getConfigTranslationArray(); |
|
| 307 | - $result = array(); |
|
| 308 | - foreach($cta as $dbkey => $configkey) { |
|
| 309 | - switch($configkey) { |
|
| 310 | - case 'homeFolderNamingRule': |
|
| 311 | - if(strpos($config[$configkey], 'attr:') === 0) { |
|
| 312 | - $result[$dbkey] = substr($config[$configkey], 5); |
|
| 313 | - } else { |
|
| 314 | - $result[$dbkey] = ''; |
|
| 315 | - } |
|
| 316 | - break; |
|
| 317 | - case 'ldapBase': |
|
| 318 | - case 'ldapBaseUsers': |
|
| 319 | - case 'ldapBaseGroups': |
|
| 320 | - case 'ldapAttributesForUserSearch': |
|
| 321 | - case 'ldapAttributesForGroupSearch': |
|
| 322 | - if(is_array($config[$configkey])) { |
|
| 323 | - $result[$dbkey] = implode("\n", $config[$configkey]); |
|
| 324 | - break; |
|
| 325 | - } //else follows default |
|
| 326 | - default: |
|
| 327 | - $result[$dbkey] = $config[$configkey]; |
|
| 328 | - } |
|
| 329 | - } |
|
| 330 | - return $result; |
|
| 331 | - } |
|
| 332 | - |
|
| 333 | - private function doSoftValidation() { |
|
| 334 | - //if User or Group Base are not set, take over Base DN setting |
|
| 335 | - foreach(array('ldapBaseUsers', 'ldapBaseGroups') as $keyBase) { |
|
| 336 | - $val = $this->configuration->$keyBase; |
|
| 337 | - if(empty($val)) { |
|
| 338 | - $this->configuration->$keyBase = $this->configuration->ldapBase; |
|
| 339 | - } |
|
| 340 | - } |
|
| 341 | - |
|
| 342 | - foreach(array('ldapExpertUUIDUserAttr' => 'ldapUuidUserAttribute', |
|
| 343 | - 'ldapExpertUUIDGroupAttr' => 'ldapUuidGroupAttribute') |
|
| 344 | - as $expertSetting => $effectiveSetting) { |
|
| 345 | - $uuidOverride = $this->configuration->$expertSetting; |
|
| 346 | - if(!empty($uuidOverride)) { |
|
| 347 | - $this->configuration->$effectiveSetting = $uuidOverride; |
|
| 348 | - } else { |
|
| 349 | - $uuidAttributes = array('auto', 'entryuuid', 'nsuniqueid', |
|
| 350 | - 'objectguid', 'guid', 'ipauniqueid'); |
|
| 351 | - if(!in_array($this->configuration->$effectiveSetting, |
|
| 352 | - $uuidAttributes) |
|
| 353 | - && (!is_null($this->configID))) { |
|
| 354 | - $this->configuration->$effectiveSetting = 'auto'; |
|
| 355 | - $this->configuration->saveConfiguration(); |
|
| 356 | - \OCP\Util::writeLog('user_ldap', |
|
| 357 | - 'Illegal value for the '. |
|
| 358 | - $effectiveSetting.', '.'reset to '. |
|
| 359 | - 'autodetect.', \OCP\Util::INFO); |
|
| 360 | - } |
|
| 361 | - |
|
| 362 | - } |
|
| 363 | - } |
|
| 364 | - |
|
| 365 | - $backupPort = intval($this->configuration->ldapBackupPort); |
|
| 366 | - if ($backupPort <= 0) { |
|
| 367 | - $this->configuration->backupPort = $this->configuration->ldapPort; |
|
| 368 | - } |
|
| 369 | - |
|
| 370 | - //make sure empty search attributes are saved as simple, empty array |
|
| 371 | - $saKeys = array('ldapAttributesForUserSearch', |
|
| 372 | - 'ldapAttributesForGroupSearch'); |
|
| 373 | - foreach($saKeys as $key) { |
|
| 374 | - $val = $this->configuration->$key; |
|
| 375 | - if(is_array($val) && count($val) === 1 && empty($val[0])) { |
|
| 376 | - $this->configuration->$key = array(); |
|
| 377 | - } |
|
| 378 | - } |
|
| 379 | - |
|
| 380 | - if((stripos($this->configuration->ldapHost, 'ldaps://') === 0) |
|
| 381 | - && $this->configuration->ldapTLS) { |
|
| 382 | - $this->configuration->ldapTLS = false; |
|
| 383 | - \OCP\Util::writeLog('user_ldap', |
|
| 384 | - 'LDAPS (already using secure connection) and '. |
|
| 385 | - 'TLS do not work together. Switched off TLS.', |
|
| 386 | - \OCP\Util::INFO); |
|
| 387 | - } |
|
| 388 | - } |
|
| 389 | - |
|
| 390 | - /** |
|
| 391 | - * @return bool |
|
| 392 | - */ |
|
| 393 | - private function doCriticalValidation() { |
|
| 394 | - $configurationOK = true; |
|
| 395 | - $errorStr = 'Configuration Error (prefix '. |
|
| 396 | - strval($this->configPrefix).'): '; |
|
| 397 | - |
|
| 398 | - //options that shall not be empty |
|
| 399 | - $options = array('ldapHost', 'ldapPort', 'ldapUserDisplayName', |
|
| 400 | - 'ldapGroupDisplayName', 'ldapLoginFilter'); |
|
| 401 | - foreach($options as $key) { |
|
| 402 | - $val = $this->configuration->$key; |
|
| 403 | - if(empty($val)) { |
|
| 404 | - switch($key) { |
|
| 405 | - case 'ldapHost': |
|
| 406 | - $subj = 'LDAP Host'; |
|
| 407 | - break; |
|
| 408 | - case 'ldapPort': |
|
| 409 | - $subj = 'LDAP Port'; |
|
| 410 | - break; |
|
| 411 | - case 'ldapUserDisplayName': |
|
| 412 | - $subj = 'LDAP User Display Name'; |
|
| 413 | - break; |
|
| 414 | - case 'ldapGroupDisplayName': |
|
| 415 | - $subj = 'LDAP Group Display Name'; |
|
| 416 | - break; |
|
| 417 | - case 'ldapLoginFilter': |
|
| 418 | - $subj = 'LDAP Login Filter'; |
|
| 419 | - break; |
|
| 420 | - default: |
|
| 421 | - $subj = $key; |
|
| 422 | - break; |
|
| 423 | - } |
|
| 424 | - $configurationOK = false; |
|
| 425 | - \OCP\Util::writeLog('user_ldap', |
|
| 426 | - $errorStr.'No '.$subj.' given!', |
|
| 427 | - \OCP\Util::WARN); |
|
| 428 | - } |
|
| 429 | - } |
|
| 430 | - |
|
| 431 | - //combinations |
|
| 432 | - $agent = $this->configuration->ldapAgentName; |
|
| 433 | - $pwd = $this->configuration->ldapAgentPassword; |
|
| 434 | - if ( |
|
| 435 | - ($agent === '' && $pwd !== '') |
|
| 436 | - || ($agent !== '' && $pwd === '') |
|
| 437 | - ) { |
|
| 438 | - \OCP\Util::writeLog('user_ldap', |
|
| 439 | - $errorStr.'either no password is given for the'. |
|
| 440 | - 'user agent or a password is given, but not an'. |
|
| 441 | - 'LDAP agent.', |
|
| 442 | - \OCP\Util::WARN); |
|
| 443 | - $configurationOK = false; |
|
| 444 | - } |
|
| 445 | - |
|
| 446 | - $base = $this->configuration->ldapBase; |
|
| 447 | - $baseUsers = $this->configuration->ldapBaseUsers; |
|
| 448 | - $baseGroups = $this->configuration->ldapBaseGroups; |
|
| 449 | - |
|
| 450 | - if(empty($base) && empty($baseUsers) && empty($baseGroups)) { |
|
| 451 | - \OCP\Util::writeLog('user_ldap', |
|
| 452 | - $errorStr.'Not a single Base DN given.', |
|
| 453 | - \OCP\Util::WARN); |
|
| 454 | - $configurationOK = false; |
|
| 455 | - } |
|
| 456 | - |
|
| 457 | - if(mb_strpos($this->configuration->ldapLoginFilter, '%uid', 0, 'UTF-8') |
|
| 458 | - === false) { |
|
| 459 | - \OCP\Util::writeLog('user_ldap', |
|
| 460 | - $errorStr.'login filter does not contain %uid '. |
|
| 461 | - 'place holder.', |
|
| 462 | - \OCP\Util::WARN); |
|
| 463 | - $configurationOK = false; |
|
| 464 | - } |
|
| 465 | - |
|
| 466 | - return $configurationOK; |
|
| 467 | - } |
|
| 468 | - |
|
| 469 | - /** |
|
| 470 | - * Validates the user specified configuration |
|
| 471 | - * @return bool true if configuration seems OK, false otherwise |
|
| 472 | - */ |
|
| 473 | - private function validateConfiguration() { |
|
| 474 | - |
|
| 475 | - if($this->doNotValidate) { |
|
| 476 | - //don't do a validation if it is a new configuration with pure |
|
| 477 | - //default values. Will be allowed on changes via __set or |
|
| 478 | - //setConfiguration |
|
| 479 | - return false; |
|
| 480 | - } |
|
| 481 | - |
|
| 482 | - // first step: "soft" checks: settings that are not really |
|
| 483 | - // necessary, but advisable. If left empty, give an info message |
|
| 484 | - $this->doSoftValidation(); |
|
| 485 | - |
|
| 486 | - //second step: critical checks. If left empty or filled wrong, mark as |
|
| 487 | - //not configured and give a warning. |
|
| 488 | - return $this->doCriticalValidation(); |
|
| 489 | - } |
|
| 490 | - |
|
| 491 | - |
|
| 492 | - /** |
|
| 493 | - * Connects and Binds to LDAP |
|
| 494 | - */ |
|
| 495 | - private function establishConnection() { |
|
| 496 | - if(!$this->configuration->ldapConfigurationActive) { |
|
| 497 | - return null; |
|
| 498 | - } |
|
| 499 | - static $phpLDAPinstalled = true; |
|
| 500 | - if(!$phpLDAPinstalled) { |
|
| 501 | - return false; |
|
| 502 | - } |
|
| 503 | - if(!$this->ignoreValidation && !$this->configured) { |
|
| 504 | - \OCP\Util::writeLog('user_ldap', |
|
| 505 | - 'Configuration is invalid, cannot connect', |
|
| 506 | - \OCP\Util::WARN); |
|
| 507 | - return false; |
|
| 508 | - } |
|
| 509 | - if(!$this->ldapConnectionRes) { |
|
| 510 | - if(!$this->ldap->areLDAPFunctionsAvailable()) { |
|
| 511 | - $phpLDAPinstalled = false; |
|
| 512 | - \OCP\Util::writeLog('user_ldap', |
|
| 513 | - 'function ldap_connect is not available. Make '. |
|
| 514 | - 'sure that the PHP ldap module is installed.', |
|
| 515 | - \OCP\Util::ERROR); |
|
| 516 | - |
|
| 517 | - return false; |
|
| 518 | - } |
|
| 519 | - if($this->configuration->turnOffCertCheck) { |
|
| 520 | - if(putenv('LDAPTLS_REQCERT=never')) { |
|
| 521 | - \OCP\Util::writeLog('user_ldap', |
|
| 522 | - 'Turned off SSL certificate validation successfully.', |
|
| 523 | - \OCP\Util::DEBUG); |
|
| 524 | - } else { |
|
| 525 | - \OCP\Util::writeLog('user_ldap', |
|
| 526 | - 'Could not turn off SSL certificate validation.', |
|
| 527 | - \OCP\Util::WARN); |
|
| 528 | - } |
|
| 529 | - } |
|
| 530 | - |
|
| 531 | - $bindStatus = false; |
|
| 532 | - $error = -1; |
|
| 533 | - try { |
|
| 534 | - if (!$this->configuration->ldapOverrideMainServer |
|
| 535 | - && !$this->getFromCache('overrideMainServer') |
|
| 536 | - ) { |
|
| 537 | - $this->doConnect($this->configuration->ldapHost, |
|
| 538 | - $this->configuration->ldapPort); |
|
| 539 | - $bindStatus = $this->bind(); |
|
| 540 | - $error = $this->ldap->isResource($this->ldapConnectionRes) ? |
|
| 541 | - $this->ldap->errno($this->ldapConnectionRes) : -1; |
|
| 542 | - } |
|
| 543 | - if($bindStatus === true) { |
|
| 544 | - return $bindStatus; |
|
| 545 | - } |
|
| 546 | - } catch (\OC\ServerNotAvailableException $e) { |
|
| 547 | - if(trim($this->configuration->ldapBackupHost) === "") { |
|
| 548 | - throw $e; |
|
| 549 | - } |
|
| 550 | - } |
|
| 551 | - |
|
| 552 | - //if LDAP server is not reachable, try the Backup (Replica!) Server |
|
| 553 | - if( $error !== 0 |
|
| 554 | - || $this->configuration->ldapOverrideMainServer |
|
| 555 | - || $this->getFromCache('overrideMainServer')) |
|
| 556 | - { |
|
| 557 | - $this->doConnect($this->configuration->ldapBackupHost, |
|
| 558 | - $this->configuration->ldapBackupPort); |
|
| 559 | - $bindStatus = $this->bind(); |
|
| 560 | - if($bindStatus && $error === -1 && !$this->getFromCache('overrideMainServer')) { |
|
| 561 | - //when bind to backup server succeeded and failed to main server, |
|
| 562 | - //skip contacting him until next cache refresh |
|
| 563 | - $this->writeToCache('overrideMainServer', true); |
|
| 564 | - } |
|
| 565 | - } |
|
| 566 | - return $bindStatus; |
|
| 567 | - } |
|
| 568 | - return null; |
|
| 569 | - } |
|
| 570 | - |
|
| 571 | - /** |
|
| 572 | - * @param string $host |
|
| 573 | - * @param string $port |
|
| 574 | - * @return bool |
|
| 575 | - * @throws \OC\ServerNotAvailableException |
|
| 576 | - */ |
|
| 577 | - private function doConnect($host, $port) { |
|
| 578 | - if ($host === '') { |
|
| 579 | - return false; |
|
| 580 | - } |
|
| 581 | - $this->ldapConnectionRes = $this->ldap->connect($host, $port); |
|
| 582 | - if($this->ldap->setOption($this->ldapConnectionRes, LDAP_OPT_PROTOCOL_VERSION, 3)) { |
|
| 583 | - if($this->ldap->setOption($this->ldapConnectionRes, LDAP_OPT_REFERRALS, 0)) { |
|
| 584 | - if($this->configuration->ldapTLS) { |
|
| 585 | - $this->ldap->startTls($this->ldapConnectionRes); |
|
| 586 | - } |
|
| 587 | - } |
|
| 588 | - } else { |
|
| 589 | - throw new \OC\ServerNotAvailableException('Could not set required LDAP Protocol version.'); |
|
| 590 | - } |
|
| 591 | - return true; |
|
| 592 | - } |
|
| 593 | - |
|
| 594 | - /** |
|
| 595 | - * Binds to LDAP |
|
| 596 | - */ |
|
| 597 | - public function bind() { |
|
| 598 | - static $getConnectionResourceAttempt = false; |
|
| 599 | - if(!$this->configuration->ldapConfigurationActive) { |
|
| 600 | - return false; |
|
| 601 | - } |
|
| 602 | - if($getConnectionResourceAttempt) { |
|
| 603 | - $getConnectionResourceAttempt = false; |
|
| 604 | - return false; |
|
| 605 | - } |
|
| 606 | - $getConnectionResourceAttempt = true; |
|
| 607 | - $cr = $this->getConnectionResource(); |
|
| 608 | - $getConnectionResourceAttempt = false; |
|
| 609 | - if(!$this->ldap->isResource($cr)) { |
|
| 610 | - return false; |
|
| 611 | - } |
|
| 612 | - $ldapLogin = @$this->ldap->bind($cr, |
|
| 613 | - $this->configuration->ldapAgentName, |
|
| 614 | - $this->configuration->ldapAgentPassword); |
|
| 615 | - if(!$ldapLogin) { |
|
| 616 | - \OCP\Util::writeLog('user_ldap', |
|
| 617 | - 'Bind failed: ' . $this->ldap->errno($cr) . ': ' . $this->ldap->error($cr), |
|
| 618 | - \OCP\Util::WARN); |
|
| 619 | - $this->ldapConnectionRes = null; |
|
| 620 | - return false; |
|
| 621 | - } |
|
| 622 | - return true; |
|
| 623 | - } |
|
| 55 | + private $ldapConnectionRes = null; |
|
| 56 | + private $configPrefix; |
|
| 57 | + private $configID; |
|
| 58 | + private $configured = false; |
|
| 59 | + private $hasPagedResultSupport = true; |
|
| 60 | + //whether connection should be kept on __destruct |
|
| 61 | + private $dontDestruct = false; |
|
| 62 | + |
|
| 63 | + /** |
|
| 64 | + * @var bool runtime flag that indicates whether supported primary groups are available |
|
| 65 | + */ |
|
| 66 | + public $hasPrimaryGroups = true; |
|
| 67 | + |
|
| 68 | + /** |
|
| 69 | + * @var bool runtime flag that indicates whether supported POSIX gidNumber are available |
|
| 70 | + */ |
|
| 71 | + public $hasGidNumber = true; |
|
| 72 | + |
|
| 73 | + //cache handler |
|
| 74 | + protected $cache; |
|
| 75 | + |
|
| 76 | + /** @var Configuration settings handler **/ |
|
| 77 | + protected $configuration; |
|
| 78 | + |
|
| 79 | + protected $doNotValidate = false; |
|
| 80 | + |
|
| 81 | + protected $ignoreValidation = false; |
|
| 82 | + |
|
| 83 | + /** |
|
| 84 | + * Constructor |
|
| 85 | + * @param ILDAPWrapper $ldap |
|
| 86 | + * @param string $configPrefix a string with the prefix for the configkey column (appconfig table) |
|
| 87 | + * @param string|null $configID a string with the value for the appid column (appconfig table) or null for on-the-fly connections |
|
| 88 | + */ |
|
| 89 | + public function __construct(ILDAPWrapper $ldap, $configPrefix = '', $configID = 'user_ldap') { |
|
| 90 | + parent::__construct($ldap); |
|
| 91 | + $this->configPrefix = $configPrefix; |
|
| 92 | + $this->configID = $configID; |
|
| 93 | + $this->configuration = new Configuration($configPrefix, |
|
| 94 | + !is_null($configID)); |
|
| 95 | + $memcache = \OC::$server->getMemCacheFactory(); |
|
| 96 | + if($memcache->isAvailable()) { |
|
| 97 | + $this->cache = $memcache->create(); |
|
| 98 | + } |
|
| 99 | + $helper = new Helper(\OC::$server->getConfig()); |
|
| 100 | + $this->doNotValidate = !in_array($this->configPrefix, |
|
| 101 | + $helper->getServerConfigurationPrefixes()); |
|
| 102 | + $this->hasPagedResultSupport = |
|
| 103 | + intval($this->configuration->ldapPagingSize) !== 0 |
|
| 104 | + || $this->ldap->hasPagedResultSupport(); |
|
| 105 | + } |
|
| 106 | + |
|
| 107 | + public function __destruct() { |
|
| 108 | + if(!$this->dontDestruct && $this->ldap->isResource($this->ldapConnectionRes)) { |
|
| 109 | + @$this->ldap->unbind($this->ldapConnectionRes); |
|
| 110 | + }; |
|
| 111 | + } |
|
| 112 | + |
|
| 113 | + /** |
|
| 114 | + * defines behaviour when the instance is cloned |
|
| 115 | + */ |
|
| 116 | + public function __clone() { |
|
| 117 | + $this->configuration = new Configuration($this->configPrefix, |
|
| 118 | + !is_null($this->configID)); |
|
| 119 | + $this->ldapConnectionRes = null; |
|
| 120 | + $this->dontDestruct = true; |
|
| 121 | + } |
|
| 122 | + |
|
| 123 | + /** |
|
| 124 | + * @param string $name |
|
| 125 | + * @return bool|mixed|void |
|
| 126 | + */ |
|
| 127 | + public function __get($name) { |
|
| 128 | + if(!$this->configured) { |
|
| 129 | + $this->readConfiguration(); |
|
| 130 | + } |
|
| 131 | + |
|
| 132 | + if($name === 'hasPagedResultSupport') { |
|
| 133 | + return $this->hasPagedResultSupport; |
|
| 134 | + } |
|
| 135 | + |
|
| 136 | + return $this->configuration->$name; |
|
| 137 | + } |
|
| 138 | + |
|
| 139 | + /** |
|
| 140 | + * @param string $name |
|
| 141 | + * @param mixed $value |
|
| 142 | + */ |
|
| 143 | + public function __set($name, $value) { |
|
| 144 | + $this->doNotValidate = false; |
|
| 145 | + $before = $this->configuration->$name; |
|
| 146 | + $this->configuration->$name = $value; |
|
| 147 | + $after = $this->configuration->$name; |
|
| 148 | + if($before !== $after) { |
|
| 149 | + if ($this->configID !== '') { |
|
| 150 | + $this->configuration->saveConfiguration(); |
|
| 151 | + } |
|
| 152 | + $this->validateConfiguration(); |
|
| 153 | + } |
|
| 154 | + } |
|
| 155 | + |
|
| 156 | + /** |
|
| 157 | + * sets whether the result of the configuration validation shall |
|
| 158 | + * be ignored when establishing the connection. Used by the Wizard |
|
| 159 | + * in early configuration state. |
|
| 160 | + * @param bool $state |
|
| 161 | + */ |
|
| 162 | + public function setIgnoreValidation($state) { |
|
| 163 | + $this->ignoreValidation = (bool)$state; |
|
| 164 | + } |
|
| 165 | + |
|
| 166 | + /** |
|
| 167 | + * initializes the LDAP backend |
|
| 168 | + * @param bool $force read the config settings no matter what |
|
| 169 | + */ |
|
| 170 | + public function init($force = false) { |
|
| 171 | + $this->readConfiguration($force); |
|
| 172 | + $this->establishConnection(); |
|
| 173 | + } |
|
| 174 | + |
|
| 175 | + /** |
|
| 176 | + * Returns the LDAP handler |
|
| 177 | + */ |
|
| 178 | + public function getConnectionResource() { |
|
| 179 | + if(!$this->ldapConnectionRes) { |
|
| 180 | + $this->init(); |
|
| 181 | + } else if(!$this->ldap->isResource($this->ldapConnectionRes)) { |
|
| 182 | + $this->ldapConnectionRes = null; |
|
| 183 | + $this->establishConnection(); |
|
| 184 | + } |
|
| 185 | + if(is_null($this->ldapConnectionRes)) { |
|
| 186 | + \OCP\Util::writeLog('user_ldap', 'No LDAP Connection to server ' . $this->configuration->ldapHost, \OCP\Util::ERROR); |
|
| 187 | + throw new ServerNotAvailableException('Connection to LDAP server could not be established'); |
|
| 188 | + } |
|
| 189 | + return $this->ldapConnectionRes; |
|
| 190 | + } |
|
| 191 | + |
|
| 192 | + /** |
|
| 193 | + * resets the connection resource |
|
| 194 | + */ |
|
| 195 | + public function resetConnectionResource() { |
|
| 196 | + if(!is_null($this->ldapConnectionRes)) { |
|
| 197 | + @$this->ldap->unbind($this->ldapConnectionRes); |
|
| 198 | + $this->ldapConnectionRes = null; |
|
| 199 | + } |
|
| 200 | + } |
|
| 201 | + |
|
| 202 | + /** |
|
| 203 | + * @param string|null $key |
|
| 204 | + * @return string |
|
| 205 | + */ |
|
| 206 | + private function getCacheKey($key) { |
|
| 207 | + $prefix = 'LDAP-'.$this->configID.'-'.$this->configPrefix.'-'; |
|
| 208 | + if(is_null($key)) { |
|
| 209 | + return $prefix; |
|
| 210 | + } |
|
| 211 | + return $prefix.md5($key); |
|
| 212 | + } |
|
| 213 | + |
|
| 214 | + /** |
|
| 215 | + * @param string $key |
|
| 216 | + * @return mixed|null |
|
| 217 | + */ |
|
| 218 | + public function getFromCache($key) { |
|
| 219 | + if(!$this->configured) { |
|
| 220 | + $this->readConfiguration(); |
|
| 221 | + } |
|
| 222 | + if(is_null($this->cache) || !$this->configuration->ldapCacheTTL) { |
|
| 223 | + return null; |
|
| 224 | + } |
|
| 225 | + $key = $this->getCacheKey($key); |
|
| 226 | + |
|
| 227 | + return json_decode(base64_decode($this->cache->get($key)), true); |
|
| 228 | + } |
|
| 229 | + |
|
| 230 | + /** |
|
| 231 | + * @param string $key |
|
| 232 | + * @param mixed $value |
|
| 233 | + * |
|
| 234 | + * @return string |
|
| 235 | + */ |
|
| 236 | + public function writeToCache($key, $value) { |
|
| 237 | + if(!$this->configured) { |
|
| 238 | + $this->readConfiguration(); |
|
| 239 | + } |
|
| 240 | + if(is_null($this->cache) |
|
| 241 | + || !$this->configuration->ldapCacheTTL |
|
| 242 | + || !$this->configuration->ldapConfigurationActive) { |
|
| 243 | + return null; |
|
| 244 | + } |
|
| 245 | + $key = $this->getCacheKey($key); |
|
| 246 | + $value = base64_encode(json_encode($value)); |
|
| 247 | + $this->cache->set($key, $value, $this->configuration->ldapCacheTTL); |
|
| 248 | + } |
|
| 249 | + |
|
| 250 | + public function clearCache() { |
|
| 251 | + if(!is_null($this->cache)) { |
|
| 252 | + $this->cache->clear($this->getCacheKey(null)); |
|
| 253 | + } |
|
| 254 | + } |
|
| 255 | + |
|
| 256 | + /** |
|
| 257 | + * Caches the general LDAP configuration. |
|
| 258 | + * @param bool $force optional. true, if the re-read should be forced. defaults |
|
| 259 | + * to false. |
|
| 260 | + * @return null |
|
| 261 | + */ |
|
| 262 | + private function readConfiguration($force = false) { |
|
| 263 | + if((!$this->configured || $force) && !is_null($this->configID)) { |
|
| 264 | + $this->configuration->readConfiguration(); |
|
| 265 | + $this->configured = $this->validateConfiguration(); |
|
| 266 | + } |
|
| 267 | + } |
|
| 268 | + |
|
| 269 | + /** |
|
| 270 | + * set LDAP configuration with values delivered by an array, not read from configuration |
|
| 271 | + * @param array $config array that holds the config parameters in an associated array |
|
| 272 | + * @param array &$setParameters optional; array where the set fields will be given to |
|
| 273 | + * @return boolean true if config validates, false otherwise. Check with $setParameters for detailed success on single parameters |
|
| 274 | + */ |
|
| 275 | + public function setConfiguration($config, &$setParameters = null) { |
|
| 276 | + if(is_null($setParameters)) { |
|
| 277 | + $setParameters = array(); |
|
| 278 | + } |
|
| 279 | + $this->doNotValidate = false; |
|
| 280 | + $this->configuration->setConfiguration($config, $setParameters); |
|
| 281 | + if(count($setParameters) > 0) { |
|
| 282 | + $this->configured = $this->validateConfiguration(); |
|
| 283 | + } |
|
| 284 | + |
|
| 285 | + |
|
| 286 | + return $this->configured; |
|
| 287 | + } |
|
| 288 | + |
|
| 289 | + /** |
|
| 290 | + * saves the current Configuration in the database and empties the |
|
| 291 | + * cache |
|
| 292 | + * @return null |
|
| 293 | + */ |
|
| 294 | + public function saveConfiguration() { |
|
| 295 | + $this->configuration->saveConfiguration(); |
|
| 296 | + $this->clearCache(); |
|
| 297 | + } |
|
| 298 | + |
|
| 299 | + /** |
|
| 300 | + * get the current LDAP configuration |
|
| 301 | + * @return array |
|
| 302 | + */ |
|
| 303 | + public function getConfiguration() { |
|
| 304 | + $this->readConfiguration(); |
|
| 305 | + $config = $this->configuration->getConfiguration(); |
|
| 306 | + $cta = $this->configuration->getConfigTranslationArray(); |
|
| 307 | + $result = array(); |
|
| 308 | + foreach($cta as $dbkey => $configkey) { |
|
| 309 | + switch($configkey) { |
|
| 310 | + case 'homeFolderNamingRule': |
|
| 311 | + if(strpos($config[$configkey], 'attr:') === 0) { |
|
| 312 | + $result[$dbkey] = substr($config[$configkey], 5); |
|
| 313 | + } else { |
|
| 314 | + $result[$dbkey] = ''; |
|
| 315 | + } |
|
| 316 | + break; |
|
| 317 | + case 'ldapBase': |
|
| 318 | + case 'ldapBaseUsers': |
|
| 319 | + case 'ldapBaseGroups': |
|
| 320 | + case 'ldapAttributesForUserSearch': |
|
| 321 | + case 'ldapAttributesForGroupSearch': |
|
| 322 | + if(is_array($config[$configkey])) { |
|
| 323 | + $result[$dbkey] = implode("\n", $config[$configkey]); |
|
| 324 | + break; |
|
| 325 | + } //else follows default |
|
| 326 | + default: |
|
| 327 | + $result[$dbkey] = $config[$configkey]; |
|
| 328 | + } |
|
| 329 | + } |
|
| 330 | + return $result; |
|
| 331 | + } |
|
| 332 | + |
|
| 333 | + private function doSoftValidation() { |
|
| 334 | + //if User or Group Base are not set, take over Base DN setting |
|
| 335 | + foreach(array('ldapBaseUsers', 'ldapBaseGroups') as $keyBase) { |
|
| 336 | + $val = $this->configuration->$keyBase; |
|
| 337 | + if(empty($val)) { |
|
| 338 | + $this->configuration->$keyBase = $this->configuration->ldapBase; |
|
| 339 | + } |
|
| 340 | + } |
|
| 341 | + |
|
| 342 | + foreach(array('ldapExpertUUIDUserAttr' => 'ldapUuidUserAttribute', |
|
| 343 | + 'ldapExpertUUIDGroupAttr' => 'ldapUuidGroupAttribute') |
|
| 344 | + as $expertSetting => $effectiveSetting) { |
|
| 345 | + $uuidOverride = $this->configuration->$expertSetting; |
|
| 346 | + if(!empty($uuidOverride)) { |
|
| 347 | + $this->configuration->$effectiveSetting = $uuidOverride; |
|
| 348 | + } else { |
|
| 349 | + $uuidAttributes = array('auto', 'entryuuid', 'nsuniqueid', |
|
| 350 | + 'objectguid', 'guid', 'ipauniqueid'); |
|
| 351 | + if(!in_array($this->configuration->$effectiveSetting, |
|
| 352 | + $uuidAttributes) |
|
| 353 | + && (!is_null($this->configID))) { |
|
| 354 | + $this->configuration->$effectiveSetting = 'auto'; |
|
| 355 | + $this->configuration->saveConfiguration(); |
|
| 356 | + \OCP\Util::writeLog('user_ldap', |
|
| 357 | + 'Illegal value for the '. |
|
| 358 | + $effectiveSetting.', '.'reset to '. |
|
| 359 | + 'autodetect.', \OCP\Util::INFO); |
|
| 360 | + } |
|
| 361 | + |
|
| 362 | + } |
|
| 363 | + } |
|
| 364 | + |
|
| 365 | + $backupPort = intval($this->configuration->ldapBackupPort); |
|
| 366 | + if ($backupPort <= 0) { |
|
| 367 | + $this->configuration->backupPort = $this->configuration->ldapPort; |
|
| 368 | + } |
|
| 369 | + |
|
| 370 | + //make sure empty search attributes are saved as simple, empty array |
|
| 371 | + $saKeys = array('ldapAttributesForUserSearch', |
|
| 372 | + 'ldapAttributesForGroupSearch'); |
|
| 373 | + foreach($saKeys as $key) { |
|
| 374 | + $val = $this->configuration->$key; |
|
| 375 | + if(is_array($val) && count($val) === 1 && empty($val[0])) { |
|
| 376 | + $this->configuration->$key = array(); |
|
| 377 | + } |
|
| 378 | + } |
|
| 379 | + |
|
| 380 | + if((stripos($this->configuration->ldapHost, 'ldaps://') === 0) |
|
| 381 | + && $this->configuration->ldapTLS) { |
|
| 382 | + $this->configuration->ldapTLS = false; |
|
| 383 | + \OCP\Util::writeLog('user_ldap', |
|
| 384 | + 'LDAPS (already using secure connection) and '. |
|
| 385 | + 'TLS do not work together. Switched off TLS.', |
|
| 386 | + \OCP\Util::INFO); |
|
| 387 | + } |
|
| 388 | + } |
|
| 389 | + |
|
| 390 | + /** |
|
| 391 | + * @return bool |
|
| 392 | + */ |
|
| 393 | + private function doCriticalValidation() { |
|
| 394 | + $configurationOK = true; |
|
| 395 | + $errorStr = 'Configuration Error (prefix '. |
|
| 396 | + strval($this->configPrefix).'): '; |
|
| 397 | + |
|
| 398 | + //options that shall not be empty |
|
| 399 | + $options = array('ldapHost', 'ldapPort', 'ldapUserDisplayName', |
|
| 400 | + 'ldapGroupDisplayName', 'ldapLoginFilter'); |
|
| 401 | + foreach($options as $key) { |
|
| 402 | + $val = $this->configuration->$key; |
|
| 403 | + if(empty($val)) { |
|
| 404 | + switch($key) { |
|
| 405 | + case 'ldapHost': |
|
| 406 | + $subj = 'LDAP Host'; |
|
| 407 | + break; |
|
| 408 | + case 'ldapPort': |
|
| 409 | + $subj = 'LDAP Port'; |
|
| 410 | + break; |
|
| 411 | + case 'ldapUserDisplayName': |
|
| 412 | + $subj = 'LDAP User Display Name'; |
|
| 413 | + break; |
|
| 414 | + case 'ldapGroupDisplayName': |
|
| 415 | + $subj = 'LDAP Group Display Name'; |
|
| 416 | + break; |
|
| 417 | + case 'ldapLoginFilter': |
|
| 418 | + $subj = 'LDAP Login Filter'; |
|
| 419 | + break; |
|
| 420 | + default: |
|
| 421 | + $subj = $key; |
|
| 422 | + break; |
|
| 423 | + } |
|
| 424 | + $configurationOK = false; |
|
| 425 | + \OCP\Util::writeLog('user_ldap', |
|
| 426 | + $errorStr.'No '.$subj.' given!', |
|
| 427 | + \OCP\Util::WARN); |
|
| 428 | + } |
|
| 429 | + } |
|
| 430 | + |
|
| 431 | + //combinations |
|
| 432 | + $agent = $this->configuration->ldapAgentName; |
|
| 433 | + $pwd = $this->configuration->ldapAgentPassword; |
|
| 434 | + if ( |
|
| 435 | + ($agent === '' && $pwd !== '') |
|
| 436 | + || ($agent !== '' && $pwd === '') |
|
| 437 | + ) { |
|
| 438 | + \OCP\Util::writeLog('user_ldap', |
|
| 439 | + $errorStr.'either no password is given for the'. |
|
| 440 | + 'user agent or a password is given, but not an'. |
|
| 441 | + 'LDAP agent.', |
|
| 442 | + \OCP\Util::WARN); |
|
| 443 | + $configurationOK = false; |
|
| 444 | + } |
|
| 445 | + |
|
| 446 | + $base = $this->configuration->ldapBase; |
|
| 447 | + $baseUsers = $this->configuration->ldapBaseUsers; |
|
| 448 | + $baseGroups = $this->configuration->ldapBaseGroups; |
|
| 449 | + |
|
| 450 | + if(empty($base) && empty($baseUsers) && empty($baseGroups)) { |
|
| 451 | + \OCP\Util::writeLog('user_ldap', |
|
| 452 | + $errorStr.'Not a single Base DN given.', |
|
| 453 | + \OCP\Util::WARN); |
|
| 454 | + $configurationOK = false; |
|
| 455 | + } |
|
| 456 | + |
|
| 457 | + if(mb_strpos($this->configuration->ldapLoginFilter, '%uid', 0, 'UTF-8') |
|
| 458 | + === false) { |
|
| 459 | + \OCP\Util::writeLog('user_ldap', |
|
| 460 | + $errorStr.'login filter does not contain %uid '. |
|
| 461 | + 'place holder.', |
|
| 462 | + \OCP\Util::WARN); |
|
| 463 | + $configurationOK = false; |
|
| 464 | + } |
|
| 465 | + |
|
| 466 | + return $configurationOK; |
|
| 467 | + } |
|
| 468 | + |
|
| 469 | + /** |
|
| 470 | + * Validates the user specified configuration |
|
| 471 | + * @return bool true if configuration seems OK, false otherwise |
|
| 472 | + */ |
|
| 473 | + private function validateConfiguration() { |
|
| 474 | + |
|
| 475 | + if($this->doNotValidate) { |
|
| 476 | + //don't do a validation if it is a new configuration with pure |
|
| 477 | + //default values. Will be allowed on changes via __set or |
|
| 478 | + //setConfiguration |
|
| 479 | + return false; |
|
| 480 | + } |
|
| 481 | + |
|
| 482 | + // first step: "soft" checks: settings that are not really |
|
| 483 | + // necessary, but advisable. If left empty, give an info message |
|
| 484 | + $this->doSoftValidation(); |
|
| 485 | + |
|
| 486 | + //second step: critical checks. If left empty or filled wrong, mark as |
|
| 487 | + //not configured and give a warning. |
|
| 488 | + return $this->doCriticalValidation(); |
|
| 489 | + } |
|
| 490 | + |
|
| 491 | + |
|
| 492 | + /** |
|
| 493 | + * Connects and Binds to LDAP |
|
| 494 | + */ |
|
| 495 | + private function establishConnection() { |
|
| 496 | + if(!$this->configuration->ldapConfigurationActive) { |
|
| 497 | + return null; |
|
| 498 | + } |
|
| 499 | + static $phpLDAPinstalled = true; |
|
| 500 | + if(!$phpLDAPinstalled) { |
|
| 501 | + return false; |
|
| 502 | + } |
|
| 503 | + if(!$this->ignoreValidation && !$this->configured) { |
|
| 504 | + \OCP\Util::writeLog('user_ldap', |
|
| 505 | + 'Configuration is invalid, cannot connect', |
|
| 506 | + \OCP\Util::WARN); |
|
| 507 | + return false; |
|
| 508 | + } |
|
| 509 | + if(!$this->ldapConnectionRes) { |
|
| 510 | + if(!$this->ldap->areLDAPFunctionsAvailable()) { |
|
| 511 | + $phpLDAPinstalled = false; |
|
| 512 | + \OCP\Util::writeLog('user_ldap', |
|
| 513 | + 'function ldap_connect is not available. Make '. |
|
| 514 | + 'sure that the PHP ldap module is installed.', |
|
| 515 | + \OCP\Util::ERROR); |
|
| 516 | + |
|
| 517 | + return false; |
|
| 518 | + } |
|
| 519 | + if($this->configuration->turnOffCertCheck) { |
|
| 520 | + if(putenv('LDAPTLS_REQCERT=never')) { |
|
| 521 | + \OCP\Util::writeLog('user_ldap', |
|
| 522 | + 'Turned off SSL certificate validation successfully.', |
|
| 523 | + \OCP\Util::DEBUG); |
|
| 524 | + } else { |
|
| 525 | + \OCP\Util::writeLog('user_ldap', |
|
| 526 | + 'Could not turn off SSL certificate validation.', |
|
| 527 | + \OCP\Util::WARN); |
|
| 528 | + } |
|
| 529 | + } |
|
| 530 | + |
|
| 531 | + $bindStatus = false; |
|
| 532 | + $error = -1; |
|
| 533 | + try { |
|
| 534 | + if (!$this->configuration->ldapOverrideMainServer |
|
| 535 | + && !$this->getFromCache('overrideMainServer') |
|
| 536 | + ) { |
|
| 537 | + $this->doConnect($this->configuration->ldapHost, |
|
| 538 | + $this->configuration->ldapPort); |
|
| 539 | + $bindStatus = $this->bind(); |
|
| 540 | + $error = $this->ldap->isResource($this->ldapConnectionRes) ? |
|
| 541 | + $this->ldap->errno($this->ldapConnectionRes) : -1; |
|
| 542 | + } |
|
| 543 | + if($bindStatus === true) { |
|
| 544 | + return $bindStatus; |
|
| 545 | + } |
|
| 546 | + } catch (\OC\ServerNotAvailableException $e) { |
|
| 547 | + if(trim($this->configuration->ldapBackupHost) === "") { |
|
| 548 | + throw $e; |
|
| 549 | + } |
|
| 550 | + } |
|
| 551 | + |
|
| 552 | + //if LDAP server is not reachable, try the Backup (Replica!) Server |
|
| 553 | + if( $error !== 0 |
|
| 554 | + || $this->configuration->ldapOverrideMainServer |
|
| 555 | + || $this->getFromCache('overrideMainServer')) |
|
| 556 | + { |
|
| 557 | + $this->doConnect($this->configuration->ldapBackupHost, |
|
| 558 | + $this->configuration->ldapBackupPort); |
|
| 559 | + $bindStatus = $this->bind(); |
|
| 560 | + if($bindStatus && $error === -1 && !$this->getFromCache('overrideMainServer')) { |
|
| 561 | + //when bind to backup server succeeded and failed to main server, |
|
| 562 | + //skip contacting him until next cache refresh |
|
| 563 | + $this->writeToCache('overrideMainServer', true); |
|
| 564 | + } |
|
| 565 | + } |
|
| 566 | + return $bindStatus; |
|
| 567 | + } |
|
| 568 | + return null; |
|
| 569 | + } |
|
| 570 | + |
|
| 571 | + /** |
|
| 572 | + * @param string $host |
|
| 573 | + * @param string $port |
|
| 574 | + * @return bool |
|
| 575 | + * @throws \OC\ServerNotAvailableException |
|
| 576 | + */ |
|
| 577 | + private function doConnect($host, $port) { |
|
| 578 | + if ($host === '') { |
|
| 579 | + return false; |
|
| 580 | + } |
|
| 581 | + $this->ldapConnectionRes = $this->ldap->connect($host, $port); |
|
| 582 | + if($this->ldap->setOption($this->ldapConnectionRes, LDAP_OPT_PROTOCOL_VERSION, 3)) { |
|
| 583 | + if($this->ldap->setOption($this->ldapConnectionRes, LDAP_OPT_REFERRALS, 0)) { |
|
| 584 | + if($this->configuration->ldapTLS) { |
|
| 585 | + $this->ldap->startTls($this->ldapConnectionRes); |
|
| 586 | + } |
|
| 587 | + } |
|
| 588 | + } else { |
|
| 589 | + throw new \OC\ServerNotAvailableException('Could not set required LDAP Protocol version.'); |
|
| 590 | + } |
|
| 591 | + return true; |
|
| 592 | + } |
|
| 593 | + |
|
| 594 | + /** |
|
| 595 | + * Binds to LDAP |
|
| 596 | + */ |
|
| 597 | + public function bind() { |
|
| 598 | + static $getConnectionResourceAttempt = false; |
|
| 599 | + if(!$this->configuration->ldapConfigurationActive) { |
|
| 600 | + return false; |
|
| 601 | + } |
|
| 602 | + if($getConnectionResourceAttempt) { |
|
| 603 | + $getConnectionResourceAttempt = false; |
|
| 604 | + return false; |
|
| 605 | + } |
|
| 606 | + $getConnectionResourceAttempt = true; |
|
| 607 | + $cr = $this->getConnectionResource(); |
|
| 608 | + $getConnectionResourceAttempt = false; |
|
| 609 | + if(!$this->ldap->isResource($cr)) { |
|
| 610 | + return false; |
|
| 611 | + } |
|
| 612 | + $ldapLogin = @$this->ldap->bind($cr, |
|
| 613 | + $this->configuration->ldapAgentName, |
|
| 614 | + $this->configuration->ldapAgentPassword); |
|
| 615 | + if(!$ldapLogin) { |
|
| 616 | + \OCP\Util::writeLog('user_ldap', |
|
| 617 | + 'Bind failed: ' . $this->ldap->errno($cr) . ': ' . $this->ldap->error($cr), |
|
| 618 | + \OCP\Util::WARN); |
|
| 619 | + $this->ldapConnectionRes = null; |
|
| 620 | + return false; |
|
| 621 | + } |
|
| 622 | + return true; |
|
| 623 | + } |
|
| 624 | 624 | |
| 625 | 625 | } |
@@ -33,155 +33,155 @@ |
||
| 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 | } |
@@ -47,7 +47,7 @@ discard block |
||
| 47 | 47 | $this->logger = $serverContainer->getLogger(); |
| 48 | 48 | $this->helper = $helper; |
| 49 | 49 | $this->deletedUsersIndex = $deletedUsersIndex; |
| 50 | - foreach ($serverContainer->getUserManager()->getBackends() as $backend){ |
|
| 50 | + foreach ($serverContainer->getUserManager()->getBackends() as $backend) { |
|
| 51 | 51 | $this->logger->debug('instance '.get_class($backend).' backend.', ['app' => 'user_ldap']); |
| 52 | 52 | if ($backend instanceof IUserLDAP) { |
| 53 | 53 | $this->backend = $backend; |
@@ -64,11 +64,11 @@ discard block |
||
| 64 | 64 | * @throws \Exception if translation was unsuccessful |
| 65 | 65 | */ |
| 66 | 66 | public function getUserDN($uid) { |
| 67 | - if(!$this->backend->userExists($uid)){ |
|
| 67 | + if (!$this->backend->userExists($uid)) { |
|
| 68 | 68 | throw new \Exception('User id not found in LDAP'); |
| 69 | 69 | } |
| 70 | 70 | $result = $this->backend->getLDAPAccess($uid)->username2dn($uid); |
| 71 | - if(!$result){ |
|
| 71 | + if (!$result) { |
|
| 72 | 72 | throw new \Exception('Translation to LDAP DN unsuccessful'); |
| 73 | 73 | } |
| 74 | 74 | return $result; |
@@ -83,7 +83,7 @@ discard block |
||
| 83 | 83 | */ |
| 84 | 84 | public function getUserName($dn) { |
| 85 | 85 | $result = $this->backend->dn2UserName($dn); |
| 86 | - if(!$result){ |
|
| 86 | + if (!$result) { |
|
| 87 | 87 | throw new \Exception('Translation to internal user name unsuccessful'); |
| 88 | 88 | } |
| 89 | 89 | return $result; |
@@ -115,7 +115,7 @@ discard block |
||
| 115 | 115 | * @throws \Exception if user id was not found in LDAP |
| 116 | 116 | */ |
| 117 | 117 | public function getLDAPConnection($uid) { |
| 118 | - if(!$this->backend->userExists($uid)){ |
|
| 118 | + if (!$this->backend->userExists($uid)) { |
|
| 119 | 119 | throw new \Exception('User id not found in LDAP'); |
| 120 | 120 | } |
| 121 | 121 | return $this->backend->getNewLDAPConnection($uid); |
@@ -128,7 +128,7 @@ discard block |
||
| 128 | 128 | * @throws \Exception if user id was not found in LDAP |
| 129 | 129 | */ |
| 130 | 130 | public function getLDAPBaseUsers($uid) { |
| 131 | - if(!$this->backend->userExists($uid)){ |
|
| 131 | + if (!$this->backend->userExists($uid)) { |
|
| 132 | 132 | throw new \Exception('User id not found in LDAP'); |
| 133 | 133 | } |
| 134 | 134 | return $this->backend->getLDAPAccess($uid)->getConnection()->getConfiguration()['ldap_base_users']; |
@@ -141,7 +141,7 @@ discard block |
||
| 141 | 141 | * @throws \Exception if user id was not found in LDAP |
| 142 | 142 | */ |
| 143 | 143 | public function getLDAPBaseGroups($uid) { |
| 144 | - if(!$this->backend->userExists($uid)){ |
|
| 144 | + if (!$this->backend->userExists($uid)) { |
|
| 145 | 145 | throw new \Exception('User id not found in LDAP'); |
| 146 | 146 | } |
| 147 | 147 | return $this->backend->getLDAPAccess($uid)->getConnection()->getConfiguration()['ldap_base_groups']; |
@@ -153,7 +153,7 @@ discard block |
||
| 153 | 153 | * @throws \Exception if user id was not found in LDAP |
| 154 | 154 | */ |
| 155 | 155 | public function clearCache($uid) { |
| 156 | - if(!$this->backend->userExists($uid)){ |
|
| 156 | + if (!$this->backend->userExists($uid)) { |
|
| 157 | 157 | throw new \Exception('User id not found in LDAP'); |
| 158 | 158 | } |
| 159 | 159 | $this->backend->getLDAPAccess($uid)->getConnection()->clearCache(); |
@@ -28,32 +28,32 @@ |
||
| 28 | 28 | use OCA\User_LDAP\Mapping\UserMapping; |
| 29 | 29 | |
| 30 | 30 | class LDAPProviderFactory implements ILDAPProviderFactory { |
| 31 | - /** |
|
| 32 | - * Server container |
|
| 33 | - * |
|
| 34 | - * @var IServerContainer |
|
| 35 | - */ |
|
| 36 | - private $serverContainer; |
|
| 31 | + /** |
|
| 32 | + * Server container |
|
| 33 | + * |
|
| 34 | + * @var IServerContainer |
|
| 35 | + */ |
|
| 36 | + private $serverContainer; |
|
| 37 | 37 | |
| 38 | - /** |
|
| 39 | - * Constructor for the LDAP provider factory |
|
| 40 | - * |
|
| 41 | - * @param IServerContainer $serverContainer server container |
|
| 42 | - */ |
|
| 43 | - public function __construct(IServerContainer $serverContainer) { |
|
| 44 | - $this->serverContainer = $serverContainer; |
|
| 45 | - } |
|
| 38 | + /** |
|
| 39 | + * Constructor for the LDAP provider factory |
|
| 40 | + * |
|
| 41 | + * @param IServerContainer $serverContainer server container |
|
| 42 | + */ |
|
| 43 | + public function __construct(IServerContainer $serverContainer) { |
|
| 44 | + $this->serverContainer = $serverContainer; |
|
| 45 | + } |
|
| 46 | 46 | |
| 47 | - /** |
|
| 48 | - * creates and returns an instance of the ILDAPProvider |
|
| 49 | - * |
|
| 50 | - * @return OCP\LDAP\ILDAPProvider |
|
| 51 | - */ |
|
| 52 | - public function getLDAPProvider() { |
|
| 53 | - $dbConnection = $this->serverContainer->getDatabaseConnection(); |
|
| 54 | - $userMapping = new UserMapping($dbConnection); |
|
| 55 | - return new LDAPProvider($this->serverContainer, new Helper($this->serverContainer->getConfig()), |
|
| 56 | - new DeletedUsersIndex($this->serverContainer->getConfig(), |
|
| 57 | - $dbConnection, $userMapping)); |
|
| 58 | - } |
|
| 47 | + /** |
|
| 48 | + * creates and returns an instance of the ILDAPProvider |
|
| 49 | + * |
|
| 50 | + * @return OCP\LDAP\ILDAPProvider |
|
| 51 | + */ |
|
| 52 | + public function getLDAPProvider() { |
|
| 53 | + $dbConnection = $this->serverContainer->getDatabaseConnection(); |
|
| 54 | + $userMapping = new UserMapping($dbConnection); |
|
| 55 | + return new LDAPProvider($this->serverContainer, new Helper($this->serverContainer->getConfig()), |
|
| 56 | + new DeletedUsersIndex($this->serverContainer->getConfig(), |
|
| 57 | + $dbConnection, $userMapping)); |
|
| 58 | + } |
|
| 59 | 59 | } |
@@ -41,7 +41,7 @@ |
||
| 41 | 41 | $application->registerRoutes($this, [ |
| 42 | 42 | 'ocs' => [ |
| 43 | 43 | ['name' => 'ConfigAPI#create', 'url' => '/api/v1/config', 'verb' => 'POST'], |
| 44 | - ['name' => 'ConfigAPI#show', 'url' => '/api/v1/config/{configID}', 'verb' => 'GET'], |
|
| 44 | + ['name' => 'ConfigAPI#show', 'url' => '/api/v1/config/{configID}', 'verb' => 'GET'], |
|
| 45 | 45 | ['name' => 'ConfigAPI#modify', 'url' => '/api/v1/config/{configID}', 'verb' => 'PUT'], |
| 46 | 46 | ['name' => 'ConfigAPI#delete', 'url' => '/api/v1/config/{configID}', 'verb' => 'DELETE'], |
| 47 | 47 | ] |
@@ -23,36 +23,36 @@ |
||
| 23 | 23 | |
| 24 | 24 | /** @var $this \OCP\Route\IRouter */ |
| 25 | 25 | $this->create('user_ldap_ajax_clearMappings', 'ajax/clearMappings.php') |
| 26 | - ->actionInclude('user_ldap/ajax/clearMappings.php'); |
|
| 26 | + ->actionInclude('user_ldap/ajax/clearMappings.php'); |
|
| 27 | 27 | $this->create('user_ldap_ajax_deleteConfiguration', 'ajax/deleteConfiguration.php') |
| 28 | - ->actionInclude('user_ldap/ajax/deleteConfiguration.php'); |
|
| 28 | + ->actionInclude('user_ldap/ajax/deleteConfiguration.php'); |
|
| 29 | 29 | $this->create('user_ldap_ajax_getConfiguration', 'ajax/getConfiguration.php') |
| 30 | - ->actionInclude('user_ldap/ajax/getConfiguration.php'); |
|
| 30 | + ->actionInclude('user_ldap/ajax/getConfiguration.php'); |
|
| 31 | 31 | $this->create('user_ldap_ajax_getNewServerConfigPrefix', 'ajax/getNewServerConfigPrefix.php') |
| 32 | - ->actionInclude('user_ldap/ajax/getNewServerConfigPrefix.php'); |
|
| 32 | + ->actionInclude('user_ldap/ajax/getNewServerConfigPrefix.php'); |
|
| 33 | 33 | $this->create('user_ldap_ajax_setConfiguration', 'ajax/setConfiguration.php') |
| 34 | - ->actionInclude('user_ldap/ajax/setConfiguration.php'); |
|
| 34 | + ->actionInclude('user_ldap/ajax/setConfiguration.php'); |
|
| 35 | 35 | $this->create('user_ldap_ajax_testConfiguration', 'ajax/testConfiguration.php') |
| 36 | - ->actionInclude('user_ldap/ajax/testConfiguration.php'); |
|
| 36 | + ->actionInclude('user_ldap/ajax/testConfiguration.php'); |
|
| 37 | 37 | $this->create('user_ldap_ajax_wizard', 'ajax/wizard.php') |
| 38 | - ->actionInclude('user_ldap/ajax/wizard.php'); |
|
| 38 | + ->actionInclude('user_ldap/ajax/wizard.php'); |
|
| 39 | 39 | |
| 40 | 40 | $application = new \OCP\AppFramework\App('user_ldap'); |
| 41 | 41 | $application->registerRoutes($this, [ |
| 42 | - 'ocs' => [ |
|
| 43 | - ['name' => 'ConfigAPI#create', 'url' => '/api/v1/config', 'verb' => 'POST'], |
|
| 44 | - ['name' => 'ConfigAPI#show', 'url' => '/api/v1/config/{configID}', 'verb' => 'GET'], |
|
| 45 | - ['name' => 'ConfigAPI#modify', 'url' => '/api/v1/config/{configID}', 'verb' => 'PUT'], |
|
| 46 | - ['name' => 'ConfigAPI#delete', 'url' => '/api/v1/config/{configID}', 'verb' => 'DELETE'], |
|
| 47 | - ] |
|
| 42 | + 'ocs' => [ |
|
| 43 | + ['name' => 'ConfigAPI#create', 'url' => '/api/v1/config', 'verb' => 'POST'], |
|
| 44 | + ['name' => 'ConfigAPI#show', 'url' => '/api/v1/config/{configID}', 'verb' => 'GET'], |
|
| 45 | + ['name' => 'ConfigAPI#modify', 'url' => '/api/v1/config/{configID}', 'verb' => 'PUT'], |
|
| 46 | + ['name' => 'ConfigAPI#delete', 'url' => '/api/v1/config/{configID}', 'verb' => 'DELETE'], |
|
| 47 | + ] |
|
| 48 | 48 | ]); |
| 49 | 49 | |
| 50 | 50 | $application = new OCA\User_LDAP\AppInfo\Application(); |
| 51 | 51 | $application->registerRoutes($this, [ |
| 52 | - 'routes' => [ |
|
| 53 | - ['name' => 'renewPassword#tryRenewPassword', 'url' => '/renewpassword', 'verb' => 'POST'], |
|
| 54 | - ['name' => 'renewPassword#showRenewPasswordForm', 'url' => '/renewpassword/{user}', 'verb' => 'GET'], |
|
| 55 | - ['name' => 'renewPassword#cancel', 'url' => '/renewpassword/cancel', 'verb' => 'GET'], |
|
| 56 | - ['name' => 'renewPassword#showLoginFormInvalidPassword', 'url' => '/renewpassword/invalidlogin/{user}', 'verb' => 'GET'], |
|
| 57 | - ] |
|
| 52 | + 'routes' => [ |
|
| 53 | + ['name' => 'renewPassword#tryRenewPassword', 'url' => '/renewpassword', 'verb' => 'POST'], |
|
| 54 | + ['name' => 'renewPassword#showRenewPasswordForm', 'url' => '/renewpassword/{user}', 'verb' => 'GET'], |
|
| 55 | + ['name' => 'renewPassword#cancel', 'url' => '/renewpassword/cancel', 'verb' => 'GET'], |
|
| 56 | + ['name' => 'renewPassword#showLoginFormInvalidPassword', 'url' => '/renewpassword/invalidlogin/{user}', 'verb' => 'GET'], |
|
| 57 | + ] |
|
| 58 | 58 | ]); |
@@ -23,7 +23,7 @@ |
||
| 23 | 23 | */ |
| 24 | 24 | $state = OCP\Config::getSystemValue('ldapIgnoreNamingRules', 'doSet'); |
| 25 | 25 | if($state === 'doSet') { |
| 26 | - OCP\Config::setSystemValue('ldapIgnoreNamingRules', false); |
|
| 26 | + OCP\Config::setSystemValue('ldapIgnoreNamingRules', false); |
|
| 27 | 27 | } |
| 28 | 28 | |
| 29 | 29 | $helper = new \OCA\User_LDAP\Helper(\OC::$server->getConfig()); |
@@ -22,7 +22,7 @@ |
||
| 22 | 22 | * |
| 23 | 23 | */ |
| 24 | 24 | $state = OCP\Config::getSystemValue('ldapIgnoreNamingRules', 'doSet'); |
| 25 | -if($state === 'doSet') { |
|
| 25 | +if ($state === 'doSet') { |
|
| 26 | 26 | OCP\Config::setSystemValue('ldapIgnoreNamingRules', false); |
| 27 | 27 | } |
| 28 | 28 | |
@@ -7,7 +7,7 @@ discard block |
||
| 7 | 7 | <div id="emptycontent" class="hidden"> |
| 8 | 8 | <div class="icon-external"></div> |
| 9 | 9 | <h2><?php p($l->t('No external storage configured')); ?></h2> |
| 10 | - <p><a href="<?php p(link_to('', 'index.php/settings/personal#files_external' )); ?>"><?php p($l->t('You can add external storages in the personal settings')); ?></a></p> |
|
| 10 | + <p><a href="<?php p(link_to('', 'index.php/settings/personal#files_external')); ?>"><?php p($l->t('You can add external storages in the personal settings')); ?></a></p> |
|
| 11 | 11 | </div> |
| 12 | 12 | |
| 13 | 13 | <input type="hidden" name="dir" value="" id="dir"> |
@@ -17,7 +17,7 @@ discard block |
||
| 17 | 17 | <tr> |
| 18 | 18 | <th id='headerName' class="hidden column-name"> |
| 19 | 19 | <div id="headerName-container"> |
| 20 | - <a class="name sort columntitle" data-sort="name"><span><?php p($l->t( 'Name' )); ?></span><span class="sort-indicator"></span></a> |
|
| 20 | + <a class="name sort columntitle" data-sort="name"><span><?php p($l->t('Name')); ?></span><span class="sort-indicator"></span></a> |
|
| 21 | 21 | </div> |
| 22 | 22 | </th> |
| 23 | 23 | <th id="headerBackend" class="hidden column-backend"> |
@@ -1,47 +1,47 @@ discard block |
||
| 1 | 1 | <?php |
| 2 | - use \OCA\Files_External\Lib\Backend\Backend; |
|
| 3 | - use \OCA\Files_External\Lib\Auth\AuthMechanism; |
|
| 4 | - use \OCA\Files_External\Lib\DefinitionParameter; |
|
| 5 | - use \OCA\Files_External\Service\BackendService; |
|
| 2 | + use \OCA\Files_External\Lib\Backend\Backend; |
|
| 3 | + use \OCA\Files_External\Lib\Auth\AuthMechanism; |
|
| 4 | + use \OCA\Files_External\Lib\DefinitionParameter; |
|
| 5 | + use \OCA\Files_External\Service\BackendService; |
|
| 6 | 6 | |
| 7 | - $canCreateMounts = $_['visibilityType'] === BackendService::VISIBILITY_ADMIN || $_['allowUserMounting']; |
|
| 7 | + $canCreateMounts = $_['visibilityType'] === BackendService::VISIBILITY_ADMIN || $_['allowUserMounting']; |
|
| 8 | 8 | |
| 9 | - $l->t("Enable encryption"); |
|
| 10 | - $l->t("Enable previews"); |
|
| 11 | - $l->t("Enable sharing"); |
|
| 12 | - $l->t("Check for changes"); |
|
| 13 | - $l->t("Never"); |
|
| 14 | - $l->t("Once every direct access"); |
|
| 9 | + $l->t("Enable encryption"); |
|
| 10 | + $l->t("Enable previews"); |
|
| 11 | + $l->t("Enable sharing"); |
|
| 12 | + $l->t("Check for changes"); |
|
| 13 | + $l->t("Never"); |
|
| 14 | + $l->t("Once every direct access"); |
|
| 15 | 15 | |
| 16 | - script('files_external', 'settings'); |
|
| 17 | - style('files_external', 'settings'); |
|
| 16 | + script('files_external', 'settings'); |
|
| 17 | + style('files_external', 'settings'); |
|
| 18 | 18 | |
| 19 | - // load custom JS |
|
| 20 | - foreach ($_['backends'] as $backend) { |
|
| 21 | - /** @var Backend $backend */ |
|
| 22 | - $scripts = $backend->getCustomJs(); |
|
| 23 | - foreach ($scripts as $script) { |
|
| 24 | - script('files_external', $script); |
|
| 25 | - } |
|
| 26 | - } |
|
| 27 | - foreach ($_['authMechanisms'] as $authMechanism) { |
|
| 28 | - /** @var AuthMechanism $authMechanism */ |
|
| 29 | - $scripts = $authMechanism->getCustomJs(); |
|
| 30 | - foreach ($scripts as $script) { |
|
| 31 | - script('files_external', $script); |
|
| 32 | - } |
|
| 33 | - } |
|
| 19 | + // load custom JS |
|
| 20 | + foreach ($_['backends'] as $backend) { |
|
| 21 | + /** @var Backend $backend */ |
|
| 22 | + $scripts = $backend->getCustomJs(); |
|
| 23 | + foreach ($scripts as $script) { |
|
| 24 | + script('files_external', $script); |
|
| 25 | + } |
|
| 26 | + } |
|
| 27 | + foreach ($_['authMechanisms'] as $authMechanism) { |
|
| 28 | + /** @var AuthMechanism $authMechanism */ |
|
| 29 | + $scripts = $authMechanism->getCustomJs(); |
|
| 30 | + foreach ($scripts as $script) { |
|
| 31 | + script('files_external', $script); |
|
| 32 | + } |
|
| 33 | + } |
|
| 34 | 34 | |
| 35 | - function writeParameterInput($parameter, $options, $classes = []) { |
|
| 36 | - $value = ''; |
|
| 37 | - if (isset($options[$parameter->getName()])) { |
|
| 38 | - $value = $options[$parameter->getName()]; |
|
| 39 | - } |
|
| 40 | - $placeholder = $parameter->getText(); |
|
| 41 | - $is_optional = $parameter->isFlagSet(DefinitionParameter::FLAG_OPTIONAL); |
|
| 35 | + function writeParameterInput($parameter, $options, $classes = []) { |
|
| 36 | + $value = ''; |
|
| 37 | + if (isset($options[$parameter->getName()])) { |
|
| 38 | + $value = $options[$parameter->getName()]; |
|
| 39 | + } |
|
| 40 | + $placeholder = $parameter->getText(); |
|
| 41 | + $is_optional = $parameter->isFlagSet(DefinitionParameter::FLAG_OPTIONAL); |
|
| 42 | 42 | |
| 43 | - switch ($parameter->getType()) { |
|
| 44 | - case DefinitionParameter::VALUE_PASSWORD: ?> |
|
| 43 | + switch ($parameter->getType()) { |
|
| 44 | + case DefinitionParameter::VALUE_PASSWORD: ?> |
|
| 45 | 45 | <?php if ($is_optional) { $classes[] = 'optional'; } ?> |
| 46 | 46 | <input type="password" |
| 47 | 47 | <?php if (!empty($classes)): ?> class="<?php p(implode(' ', $classes)); ?>"<?php endif; ?> |
@@ -50,8 +50,8 @@ discard block |
||
| 50 | 50 | placeholder="<?php p($placeholder); ?>" |
| 51 | 51 | /> |
| 52 | 52 | <?php |
| 53 | - break; |
|
| 54 | - case DefinitionParameter::VALUE_BOOLEAN: ?> |
|
| 53 | + break; |
|
| 54 | + case DefinitionParameter::VALUE_BOOLEAN: ?> |
|
| 55 | 55 | <?php $checkboxId = uniqid("checkbox_"); ?> |
| 56 | 56 | <div> |
| 57 | 57 | <label> |
@@ -65,16 +65,16 @@ discard block |
||
| 65 | 65 | </label> |
| 66 | 66 | </div> |
| 67 | 67 | <?php |
| 68 | - break; |
|
| 69 | - case DefinitionParameter::VALUE_HIDDEN: ?> |
|
| 68 | + break; |
|
| 69 | + case DefinitionParameter::VALUE_HIDDEN: ?> |
|
| 70 | 70 | <input type="hidden" |
| 71 | 71 | <?php if (!empty($classes)): ?> class="<?php p(implode(' ', $classes)); ?>"<?php endif; ?> |
| 72 | 72 | data-parameter="<?php p($parameter->getName()); ?>" |
| 73 | 73 | value="<?php p($value); ?>" |
| 74 | 74 | /> |
| 75 | 75 | <?php |
| 76 | - break; |
|
| 77 | - default: ?> |
|
| 76 | + break; |
|
| 77 | + default: ?> |
|
| 78 | 78 | <?php if ($is_optional) { $classes[] = 'optional'; } ?> |
| 79 | 79 | <input type="text" |
| 80 | 80 | <?php if (!empty($classes)): ?> class="<?php p(implode(' ', $classes)); ?>"<?php endif; ?> |
@@ -83,8 +83,8 @@ discard block |
||
| 83 | 83 | placeholder="<?php p($placeholder); ?>" |
| 84 | 84 | /> |
| 85 | 85 | <?php |
| 86 | - } |
|
| 87 | - } |
|
| 86 | + } |
|
| 87 | + } |
|
| 88 | 88 | ?> |
| 89 | 89 | |
| 90 | 90 | <form data-can-create="<?php echo $canCreateMounts?'true':'false' ?>" id="files_external" class="section" data-encryption-enabled="<?php echo $_['encryptionEnabled']?'true': 'false'; ?>"> |
@@ -122,13 +122,13 @@ discard block |
||
| 122 | 122 | <?php p($l->t('Add storage')); ?> |
| 123 | 123 | </option> |
| 124 | 124 | <?php |
| 125 | - $sortedBackends = array_filter($_['backends'], function($backend) use ($_) { |
|
| 126 | - return $backend->isVisibleFor($_['visibilityType']); |
|
| 127 | - }); |
|
| 128 | - uasort($sortedBackends, function($a, $b) { |
|
| 129 | - return strcasecmp($a->getText(), $b->getText()); |
|
| 130 | - }); |
|
| 131 | - ?> |
|
| 125 | + $sortedBackends = array_filter($_['backends'], function($backend) use ($_) { |
|
| 126 | + return $backend->isVisibleFor($_['visibilityType']); |
|
| 127 | + }); |
|
| 128 | + uasort($sortedBackends, function($a, $b) { |
|
| 129 | + return strcasecmp($a->getText(), $b->getText()); |
|
| 130 | + }); |
|
| 131 | + ?> |
|
| 132 | 132 | <?php foreach ($sortedBackends as $backend): ?> |
| 133 | 133 | <?php if ($backend->getDeprecateTo()) continue; // ignore deprecated backends ?> |
| 134 | 134 | <option value="<?php p($backend->getIdentifier()); ?>"><?php p($backend->getText()); ?></option> |
@@ -169,10 +169,10 @@ discard block |
||
| 169 | 169 | <p id="userMountingBackends"<?php if ($_['allowUserMounting'] != 'yes'): ?> class="hidden"<?php endif; ?>> |
| 170 | 170 | <?php p($l->t('Allow users to mount the following external storage')); ?><br /> |
| 171 | 171 | <?php |
| 172 | - $userBackends = array_filter($_['backends'], function($backend) { |
|
| 173 | - return $backend->isAllowedVisibleFor(BackendService::VISIBILITY_PERSONAL); |
|
| 174 | - }); |
|
| 175 | - ?> |
|
| 172 | + $userBackends = array_filter($_['backends'], function($backend) { |
|
| 173 | + return $backend->isAllowedVisibleFor(BackendService::VISIBILITY_PERSONAL); |
|
| 174 | + }); |
|
| 175 | + ?> |
|
| 176 | 176 | <?php $i = 0; foreach ($userBackends as $backend): ?> |
| 177 | 177 | <?php if ($deprecateTo = $backend->getDeprecateTo()): ?> |
| 178 | 178 | <input type="hidden" id="allowUserMountingBackends<?php p($i); ?>" name="allowUserMountingBackends[]" value="<?php p($backend->getIdentifier()); ?>" data-deprecate-to="<?php p($deprecateTo->getIdentifier()); ?>" /> |
@@ -41,44 +41,44 @@ |
||
| 41 | 41 | $is_optional = $parameter->isFlagSet(DefinitionParameter::FLAG_OPTIONAL); |
| 42 | 42 | |
| 43 | 43 | switch ($parameter->getType()) { |
| 44 | - case DefinitionParameter::VALUE_PASSWORD: ?> |
|
| 45 | - <?php if ($is_optional) { $classes[] = 'optional'; } ?> |
|
| 46 | - <input type="password" |
|
| 44 | + case DefinitionParameter::VALUE_PASSWORD: ?> |
|
| 45 | + <?php if ($is_optional) { $classes[] = 'optional'; } ?> |
|
| 46 | + <input type="password" |
|
| 47 | 47 | <?php if (!empty($classes)): ?> class="<?php p(implode(' ', $classes)); ?>"<?php endif; ?> |
| 48 | - data-parameter="<?php p($parameter->getName()); ?>" |
|
| 48 | + data-parameter="<?php p($parameter->getName()); ?>" |
|
| 49 | 49 | value="<?php p($value); ?>" |
| 50 | 50 | placeholder="<?php p($placeholder); ?>" |
| 51 | 51 | /> |
| 52 | 52 | <?php |
| 53 | - break; |
|
| 54 | - case DefinitionParameter::VALUE_BOOLEAN: ?> |
|
| 55 | - <?php $checkboxId = uniqid("checkbox_"); ?> |
|
| 53 | + break; |
|
| 54 | + case DefinitionParameter::VALUE_BOOLEAN: ?> |
|
| 55 | + <?php $checkboxId = uniqid("checkbox_"); ?> |
|
| 56 | 56 | <div> |
| 57 | 57 | <label> |
| 58 | 58 | <input type="checkbox" |
| 59 | 59 | id="<?php p($checkboxId); ?>" |
| 60 | 60 | <?php if (!empty($classes)): ?> class="checkbox <?php p(implode(' ', $classes)); ?>"<?php endif; ?> |
| 61 | - data-parameter="<?php p($parameter->getName()); ?>" |
|
| 61 | + data-parameter="<?php p($parameter->getName()); ?>" |
|
| 62 | 62 | <?php if ($value === true): ?> checked="checked"<?php endif; ?> |
| 63 | - /> |
|
| 63 | + /> |
|
| 64 | 64 | <?php p($placeholder); ?> |
| 65 | 65 | </label> |
| 66 | 66 | </div> |
| 67 | 67 | <?php |
| 68 | - break; |
|
| 69 | - case DefinitionParameter::VALUE_HIDDEN: ?> |
|
| 70 | - <input type="hidden" |
|
| 68 | + break; |
|
| 69 | + case DefinitionParameter::VALUE_HIDDEN: ?> |
|
| 70 | + <input type="hidden" |
|
| 71 | 71 | <?php if (!empty($classes)): ?> class="<?php p(implode(' ', $classes)); ?>"<?php endif; ?> |
| 72 | - data-parameter="<?php p($parameter->getName()); ?>" |
|
| 72 | + data-parameter="<?php p($parameter->getName()); ?>" |
|
| 73 | 73 | value="<?php p($value); ?>" |
| 74 | 74 | /> |
| 75 | 75 | <?php |
| 76 | - break; |
|
| 77 | - default: ?> |
|
| 78 | - <?php if ($is_optional) { $classes[] = 'optional'; } ?> |
|
| 79 | - <input type="text" |
|
| 76 | + break; |
|
| 77 | + default: ?> |
|
| 78 | + <?php if ($is_optional) { $classes[] = 'optional'; } ?> |
|
| 79 | + <input type="text" |
|
| 80 | 80 | <?php if (!empty($classes)): ?> class="<?php p(implode(' ', $classes)); ?>"<?php endif; ?> |
| 81 | - data-parameter="<?php p($parameter->getName()); ?>" |
|
| 81 | + data-parameter="<?php p($parameter->getName()); ?>" |
|
| 82 | 82 | value="<?php p($value); ?>" |
| 83 | 83 | placeholder="<?php p($placeholder); ?>" |
| 84 | 84 | /> |
@@ -87,9 +87,9 @@ |
||
| 87 | 87 | } |
| 88 | 88 | ?> |
| 89 | 89 | |
| 90 | -<form data-can-create="<?php echo $canCreateMounts?'true':'false' ?>" id="files_external" class="section" data-encryption-enabled="<?php echo $_['encryptionEnabled']?'true': 'false'; ?>"> |
|
| 90 | +<form data-can-create="<?php echo $canCreateMounts ? 'true' : 'false' ?>" id="files_external" class="section" data-encryption-enabled="<?php echo $_['encryptionEnabled'] ? 'true' : 'false'; ?>"> |
|
| 91 | 91 | <h2 data-anchor-name="external-storage"><?php p($l->t('External storages')); ?></h2> |
| 92 | - <?php if (isset($_['dependencies']) and ($_['dependencies']<>'') and $canCreateMounts) print_unescaped(''.$_['dependencies'].''); ?> |
|
| 92 | + <?php if (isset($_['dependencies']) and ($_['dependencies'] <> '') and $canCreateMounts) print_unescaped(''.$_['dependencies'].''); ?> |
|
| 93 | 93 | <table id="externalStorage" class="grid" data-admin='<?php print_unescaped(json_encode($_['visibilityType'] === BackendService::VISIBILITY_ADMIN)); ?>'> |
| 94 | 94 | <thead> |
| 95 | 95 | <tr> |
@@ -89,7 +89,10 @@ discard block |
||
| 89 | 89 | |
| 90 | 90 | <form data-can-create="<?php echo $canCreateMounts?'true':'false' ?>" id="files_external" class="section" data-encryption-enabled="<?php echo $_['encryptionEnabled']?'true': 'false'; ?>"> |
| 91 | 91 | <h2 data-anchor-name="external-storage"><?php p($l->t('External storages')); ?></h2> |
| 92 | - <?php if (isset($_['dependencies']) and ($_['dependencies']<>'') and $canCreateMounts) print_unescaped(''.$_['dependencies'].''); ?> |
|
| 92 | + <?php if (isset($_['dependencies']) and ($_['dependencies']<>'') and $canCreateMounts) { |
|
| 93 | + print_unescaped(''.$_['dependencies'].''); |
|
| 94 | +} |
|
| 95 | +?> |
|
| 93 | 96 | <table id="externalStorage" class="grid" data-admin='<?php print_unescaped(json_encode($_['visibilityType'] === BackendService::VISIBILITY_ADMIN)); ?>'> |
| 94 | 97 | <thead> |
| 95 | 98 | <tr> |
@@ -98,7 +101,10 @@ discard block |
||
| 98 | 101 | <th><?php p($l->t('External storage')); ?></th> |
| 99 | 102 | <th><?php p($l->t('Authentication')); ?></th> |
| 100 | 103 | <th><?php p($l->t('Configuration')); ?></th> |
| 101 | - <?php if ($_['visibilityType'] === BackendService::VISIBILITY_ADMIN) print_unescaped('<th>'.$l->t('Available for').'</th>'); ?> |
|
| 104 | + <?php if ($_['visibilityType'] === BackendService::VISIBILITY_ADMIN) { |
|
| 105 | + print_unescaped('<th>'.$l->t('Available for').'</th>'); |
|
| 106 | +} |
|
| 107 | +?> |
|
| 102 | 108 | <th> </th> |
| 103 | 109 | <th> </th> |
| 104 | 110 | </tr> |
@@ -130,7 +136,10 @@ discard block |
||
| 130 | 136 | }); |
| 131 | 137 | ?> |
| 132 | 138 | <?php foreach ($sortedBackends as $backend): ?> |
| 133 | - <?php if ($backend->getDeprecateTo()) continue; // ignore deprecated backends ?> |
|
| 139 | + <?php if ($backend->getDeprecateTo()) { |
|
| 140 | + continue; |
|
| 141 | +} |
|
| 142 | +// ignore deprecated backends ?> |
|
| 134 | 143 | <option value="<?php p($backend->getIdentifier()); ?>"><?php p($backend->getText()); ?></option> |
| 135 | 144 | <?php endforeach; ?> |
| 136 | 145 | </select> |
@@ -169,7 +178,10 @@ discard block |
||
| 169 | 178 | |
| 170 | 179 | <?php if ($_['visibilityType'] === BackendService::VISIBILITY_ADMIN): ?> |
| 171 | 180 | <input type="checkbox" name="allowUserMounting" id="allowUserMounting" class="checkbox" |
| 172 | - value="1" <?php if ($_['allowUserMounting'] == 'yes') print_unescaped(' checked="checked"'); ?> /> |
|
| 181 | + value="1" <?php if ($_['allowUserMounting'] == 'yes') { |
|
| 182 | + print_unescaped(' checked="checked"'); |
|
| 183 | +} |
|
| 184 | +?> /> |
|
| 173 | 185 | <label for="allowUserMounting"><?php p($l->t('Allow users to mount external storage')); ?></label> <span id="userMountingMsg" class="msg"></span> |
| 174 | 186 | |
| 175 | 187 | <p id="userMountingBackends"<?php if ($_['allowUserMounting'] != 'yes'): ?> class="hidden"<?php endif; ?>> |
@@ -182,8 +194,14 @@ discard block |
||
| 182 | 194 | <?php $i = 0; foreach ($userBackends as $backend): ?> |
| 183 | 195 | <?php if ($deprecateTo = $backend->getDeprecateTo()): ?> |
| 184 | 196 | <input type="hidden" id="allowUserMountingBackends<?php p($i); ?>" name="allowUserMountingBackends[]" value="<?php p($backend->getIdentifier()); ?>" data-deprecate-to="<?php p($deprecateTo->getIdentifier()); ?>" /> |
| 185 | - <?php else: ?> |
|
| 186 | - <input type="checkbox" id="allowUserMountingBackends<?php p($i); ?>" class="checkbox" name="allowUserMountingBackends[]" value="<?php p($backend->getIdentifier()); ?>" <?php if ($backend->isVisibleFor(BackendService::VISIBILITY_PERSONAL)) print_unescaped(' checked="checked"'); ?> /> |
|
| 197 | + <?php else { |
|
| 198 | + : ?> |
|
| 199 | + <input type="checkbox" id="allowUserMountingBackends<?php p($i); |
|
| 200 | +} |
|
| 201 | +?>" class="checkbox" name="allowUserMountingBackends[]" value="<?php p($backend->getIdentifier()); ?>" <?php if ($backend->isVisibleFor(BackendService::VISIBILITY_PERSONAL)) { |
|
| 202 | + print_unescaped(' checked="checked"'); |
|
| 203 | +} |
|
| 204 | +?> /> |
|
| 187 | 205 | <label for="allowUserMountingBackends<?php p($i); ?>"><?php p($backend->getText()); ?></label> <br /> |
| 188 | 206 | <?php endif; ?> |
| 189 | 207 | <?php $i++; ?> |
@@ -33,42 +33,42 @@ |
||
| 33 | 33 | |
| 34 | 34 | // FIXME: currently hard-coded to Dropbox OAuth |
| 35 | 35 | if (isset($_POST['app_key']) && isset($_POST['app_secret'])) { |
| 36 | - $oauth = new Dropbox_OAuth_Curl((string)$_POST['app_key'], (string)$_POST['app_secret']); |
|
| 37 | - if (isset($_POST['step'])) { |
|
| 38 | - switch ($_POST['step']) { |
|
| 39 | - case 1: |
|
| 40 | - try { |
|
| 41 | - if (isset($_POST['callback'])) { |
|
| 42 | - $callback = (string)$_POST['callback']; |
|
| 43 | - } else { |
|
| 44 | - $callback = null; |
|
| 45 | - } |
|
| 46 | - $token = $oauth->getRequestToken(); |
|
| 47 | - OCP\JSON::success(array('data' => array('url' => $oauth->getAuthorizeUrl($callback), |
|
| 48 | - 'request_token' => $token['token'], |
|
| 49 | - 'request_token_secret' => $token['token_secret']))); |
|
| 50 | - } catch (Exception $exception) { |
|
| 51 | - OCP\JSON::error(array('data' => array('message' => |
|
| 52 | - $l->t('Fetching request tokens failed. Verify that your app key and secret are correct.')) |
|
| 53 | - )); |
|
| 54 | - } |
|
| 55 | - break; |
|
| 56 | - case 2: |
|
| 57 | - if (isset($_POST['request_token']) && isset($_POST['request_token_secret'])) { |
|
| 58 | - try { |
|
| 59 | - $oauth->setToken((string)$_POST['request_token'], (string)$_POST['request_token_secret']); |
|
| 60 | - $token = $oauth->getAccessToken(); |
|
| 61 | - OCP\JSON::success(array('access_token' => $token['token'], |
|
| 62 | - 'access_token_secret' => $token['token_secret'])); |
|
| 63 | - } catch (Exception $exception) { |
|
| 64 | - OCP\JSON::error(array('data' => array('message' => |
|
| 65 | - $l->t('Fetching access tokens failed. Verify that your app key and secret are correct.')) |
|
| 66 | - )); |
|
| 67 | - } |
|
| 68 | - } |
|
| 69 | - break; |
|
| 70 | - } |
|
| 71 | - } |
|
| 36 | + $oauth = new Dropbox_OAuth_Curl((string)$_POST['app_key'], (string)$_POST['app_secret']); |
|
| 37 | + if (isset($_POST['step'])) { |
|
| 38 | + switch ($_POST['step']) { |
|
| 39 | + case 1: |
|
| 40 | + try { |
|
| 41 | + if (isset($_POST['callback'])) { |
|
| 42 | + $callback = (string)$_POST['callback']; |
|
| 43 | + } else { |
|
| 44 | + $callback = null; |
|
| 45 | + } |
|
| 46 | + $token = $oauth->getRequestToken(); |
|
| 47 | + OCP\JSON::success(array('data' => array('url' => $oauth->getAuthorizeUrl($callback), |
|
| 48 | + 'request_token' => $token['token'], |
|
| 49 | + 'request_token_secret' => $token['token_secret']))); |
|
| 50 | + } catch (Exception $exception) { |
|
| 51 | + OCP\JSON::error(array('data' => array('message' => |
|
| 52 | + $l->t('Fetching request tokens failed. Verify that your app key and secret are correct.')) |
|
| 53 | + )); |
|
| 54 | + } |
|
| 55 | + break; |
|
| 56 | + case 2: |
|
| 57 | + if (isset($_POST['request_token']) && isset($_POST['request_token_secret'])) { |
|
| 58 | + try { |
|
| 59 | + $oauth->setToken((string)$_POST['request_token'], (string)$_POST['request_token_secret']); |
|
| 60 | + $token = $oauth->getAccessToken(); |
|
| 61 | + OCP\JSON::success(array('access_token' => $token['token'], |
|
| 62 | + 'access_token_secret' => $token['token_secret'])); |
|
| 63 | + } catch (Exception $exception) { |
|
| 64 | + OCP\JSON::error(array('data' => array('message' => |
|
| 65 | + $l->t('Fetching access tokens failed. Verify that your app key and secret are correct.')) |
|
| 66 | + )); |
|
| 67 | + } |
|
| 68 | + } |
|
| 69 | + break; |
|
| 70 | + } |
|
| 71 | + } |
|
| 72 | 72 | } else { |
| 73 | - OCP\JSON::error(array('data' => array('message' => $l->t('Please provide a valid app key and secret.')))); |
|
| 73 | + OCP\JSON::error(array('data' => array('message' => $l->t('Please provide a valid app key and secret.')))); |
|
| 74 | 74 | } |
@@ -24,7 +24,7 @@ discard block |
||
| 24 | 24 | * along with this program. If not, see <http://www.gnu.org/licenses/> |
| 25 | 25 | * |
| 26 | 26 | */ |
| 27 | -require_once __DIR__ . '/../3rdparty/Dropbox/autoload.php'; |
|
| 27 | +require_once __DIR__.'/../3rdparty/Dropbox/autoload.php'; |
|
| 28 | 28 | |
| 29 | 29 | OCP\JSON::checkAppEnabled('files_external'); |
| 30 | 30 | OCP\JSON::checkLoggedIn(); |
@@ -33,13 +33,13 @@ discard block |
||
| 33 | 33 | |
| 34 | 34 | // FIXME: currently hard-coded to Dropbox OAuth |
| 35 | 35 | if (isset($_POST['app_key']) && isset($_POST['app_secret'])) { |
| 36 | - $oauth = new Dropbox_OAuth_Curl((string)$_POST['app_key'], (string)$_POST['app_secret']); |
|
| 36 | + $oauth = new Dropbox_OAuth_Curl((string) $_POST['app_key'], (string) $_POST['app_secret']); |
|
| 37 | 37 | if (isset($_POST['step'])) { |
| 38 | 38 | switch ($_POST['step']) { |
| 39 | 39 | case 1: |
| 40 | 40 | try { |
| 41 | 41 | if (isset($_POST['callback'])) { |
| 42 | - $callback = (string)$_POST['callback']; |
|
| 42 | + $callback = (string) $_POST['callback']; |
|
| 43 | 43 | } else { |
| 44 | 44 | $callback = null; |
| 45 | 45 | } |
@@ -56,7 +56,7 @@ discard block |
||
| 56 | 56 | case 2: |
| 57 | 57 | if (isset($_POST['request_token']) && isset($_POST['request_token_secret'])) { |
| 58 | 58 | try { |
| 59 | - $oauth->setToken((string)$_POST['request_token'], (string)$_POST['request_token_secret']); |
|
| 59 | + $oauth->setToken((string) $_POST['request_token'], (string) $_POST['request_token_secret']); |
|
| 60 | 60 | $token = $oauth->getAccessToken(); |
| 61 | 61 | OCP\JSON::success(array('access_token' => $token['token'], |
| 62 | 62 | 'access_token_secret' => $token['token_secret'])); |