@@ -34,8 +34,8 @@ |
||
| 34 | 34 | $prefix = (string)$_POST['ldap_serverconfig_chooser']; |
| 35 | 35 | $helper = new \OCA\User_LDAP\Helper(\OC::$server->getConfig()); |
| 36 | 36 | if($helper->deleteServerConfiguration($prefix)) { |
| 37 | - OCP\JSON::success(); |
|
| 37 | + OCP\JSON::success(); |
|
| 38 | 38 | } else { |
| 39 | - $l = \OC::$server->getL10N('user_ldap'); |
|
| 40 | - OCP\JSON::error(array('message' => $l->t('Failed to delete the server configuration'))); |
|
| 39 | + $l = \OC::$server->getL10N('user_ldap'); |
|
| 40 | + OCP\JSON::error(array('message' => $l->t('Failed to delete the server configuration'))); |
|
| 41 | 41 | } |
@@ -31,9 +31,9 @@ |
||
| 31 | 31 | OCP\JSON::checkAppEnabled('user_ldap'); |
| 32 | 32 | OCP\JSON::callCheck(); |
| 33 | 33 | |
| 34 | -$prefix = (string)$_POST['ldap_serverconfig_chooser']; |
|
| 34 | +$prefix = (string) $_POST['ldap_serverconfig_chooser']; |
|
| 35 | 35 | $helper = new \OCA\User_LDAP\Helper(\OC::$server->getConfig()); |
| 36 | -if($helper->deleteServerConfiguration($prefix)) { |
|
| 36 | +if ($helper->deleteServerConfiguration($prefix)) { |
|
| 37 | 37 | OCP\JSON::success(); |
| 38 | 38 | } else { |
| 39 | 39 | $l = \OC::$server->getL10N('user_ldap'); |
@@ -33,13 +33,13 @@ discard block |
||
| 33 | 33 | $l = \OC::$server->getL10N('user_ldap'); |
| 34 | 34 | |
| 35 | 35 | if(!isset($_POST['action'])) { |
| 36 | - \OCP\JSON::error(array('message' => $l->t('No action specified'))); |
|
| 36 | + \OCP\JSON::error(array('message' => $l->t('No action specified'))); |
|
| 37 | 37 | } |
| 38 | 38 | $action = (string)$_POST['action']; |
| 39 | 39 | |
| 40 | 40 | |
| 41 | 41 | if(!isset($_POST['ldap_serverconfig_chooser'])) { |
| 42 | - \OCP\JSON::error(array('message' => $l->t('No configuration specified'))); |
|
| 42 | + \OCP\JSON::error(array('message' => $l->t('No configuration specified'))); |
|
| 43 | 43 | } |
| 44 | 44 | $prefix = (string)$_POST['ldap_serverconfig_chooser']; |
| 45 | 45 | |
@@ -52,90 +52,90 @@ discard block |
||
| 52 | 52 | $con->setIgnoreValidation(true); |
| 53 | 53 | |
| 54 | 54 | $userManager = new \OCA\User_LDAP\User\Manager( |
| 55 | - \OC::$server->getConfig(), |
|
| 56 | - new \OCA\User_LDAP\FilesystemHelper(), |
|
| 57 | - new \OCA\User_LDAP\LogWrapper(), |
|
| 58 | - \OC::$server->getAvatarManager(), |
|
| 59 | - new \OCP\Image(), |
|
| 60 | - \OC::$server->getDatabaseConnection(), |
|
| 61 | - \OC::$server->getUserManager()); |
|
| 55 | + \OC::$server->getConfig(), |
|
| 56 | + new \OCA\User_LDAP\FilesystemHelper(), |
|
| 57 | + new \OCA\User_LDAP\LogWrapper(), |
|
| 58 | + \OC::$server->getAvatarManager(), |
|
| 59 | + new \OCP\Image(), |
|
| 60 | + \OC::$server->getDatabaseConnection(), |
|
| 61 | + \OC::$server->getUserManager()); |
|
| 62 | 62 | |
| 63 | 63 | $access = new \OCA\User_LDAP\Access($con, $ldapWrapper, $userManager, new \OCA\User_LDAP\Helper( |
| 64 | - \OC::$server->getConfig() |
|
| 64 | + \OC::$server->getConfig() |
|
| 65 | 65 | )); |
| 66 | 66 | |
| 67 | 67 | $wizard = new \OCA\User_LDAP\Wizard($configuration, $ldapWrapper, $access); |
| 68 | 68 | |
| 69 | 69 | switch($action) { |
| 70 | - case 'guessPortAndTLS': |
|
| 71 | - case 'guessBaseDN': |
|
| 72 | - case 'detectEmailAttribute': |
|
| 73 | - case 'detectUserDisplayNameAttribute': |
|
| 74 | - case 'determineGroupMemberAssoc': |
|
| 75 | - case 'determineUserObjectClasses': |
|
| 76 | - case 'determineGroupObjectClasses': |
|
| 77 | - case 'determineGroupsForUsers': |
|
| 78 | - case 'determineGroupsForGroups': |
|
| 79 | - case 'determineAttributes': |
|
| 80 | - case 'getUserListFilter': |
|
| 81 | - case 'getUserLoginFilter': |
|
| 82 | - case 'getGroupFilter': |
|
| 83 | - case 'countUsers': |
|
| 84 | - case 'countGroups': |
|
| 85 | - case 'countInBaseDN': |
|
| 86 | - try { |
|
| 87 | - $result = $wizard->$action(); |
|
| 88 | - if($result !== false) { |
|
| 89 | - OCP\JSON::success($result->getResultArray()); |
|
| 90 | - exit; |
|
| 91 | - } |
|
| 92 | - } catch (\Exception $e) { |
|
| 93 | - \OCP\JSON::error(array('message' => $e->getMessage(), 'code' => $e->getCode())); |
|
| 94 | - exit; |
|
| 95 | - } |
|
| 96 | - \OCP\JSON::error(); |
|
| 97 | - exit; |
|
| 98 | - break; |
|
| 70 | + case 'guessPortAndTLS': |
|
| 71 | + case 'guessBaseDN': |
|
| 72 | + case 'detectEmailAttribute': |
|
| 73 | + case 'detectUserDisplayNameAttribute': |
|
| 74 | + case 'determineGroupMemberAssoc': |
|
| 75 | + case 'determineUserObjectClasses': |
|
| 76 | + case 'determineGroupObjectClasses': |
|
| 77 | + case 'determineGroupsForUsers': |
|
| 78 | + case 'determineGroupsForGroups': |
|
| 79 | + case 'determineAttributes': |
|
| 80 | + case 'getUserListFilter': |
|
| 81 | + case 'getUserLoginFilter': |
|
| 82 | + case 'getGroupFilter': |
|
| 83 | + case 'countUsers': |
|
| 84 | + case 'countGroups': |
|
| 85 | + case 'countInBaseDN': |
|
| 86 | + try { |
|
| 87 | + $result = $wizard->$action(); |
|
| 88 | + if($result !== false) { |
|
| 89 | + OCP\JSON::success($result->getResultArray()); |
|
| 90 | + exit; |
|
| 91 | + } |
|
| 92 | + } catch (\Exception $e) { |
|
| 93 | + \OCP\JSON::error(array('message' => $e->getMessage(), 'code' => $e->getCode())); |
|
| 94 | + exit; |
|
| 95 | + } |
|
| 96 | + \OCP\JSON::error(); |
|
| 97 | + exit; |
|
| 98 | + break; |
|
| 99 | 99 | |
| 100 | - case 'testLoginName': { |
|
| 101 | - try { |
|
| 102 | - $loginName = $_POST['ldap_test_loginname']; |
|
| 103 | - $result = $wizard->$action($loginName); |
|
| 104 | - if($result !== false) { |
|
| 105 | - OCP\JSON::success($result->getResultArray()); |
|
| 106 | - exit; |
|
| 107 | - } |
|
| 108 | - } catch (\Exception $e) { |
|
| 109 | - \OCP\JSON::error(array('message' => $e->getMessage())); |
|
| 110 | - exit; |
|
| 111 | - } |
|
| 112 | - \OCP\JSON::error(); |
|
| 113 | - exit; |
|
| 114 | - break; |
|
| 115 | - } |
|
| 100 | + case 'testLoginName': { |
|
| 101 | + try { |
|
| 102 | + $loginName = $_POST['ldap_test_loginname']; |
|
| 103 | + $result = $wizard->$action($loginName); |
|
| 104 | + if($result !== false) { |
|
| 105 | + OCP\JSON::success($result->getResultArray()); |
|
| 106 | + exit; |
|
| 107 | + } |
|
| 108 | + } catch (\Exception $e) { |
|
| 109 | + \OCP\JSON::error(array('message' => $e->getMessage())); |
|
| 110 | + exit; |
|
| 111 | + } |
|
| 112 | + \OCP\JSON::error(); |
|
| 113 | + exit; |
|
| 114 | + break; |
|
| 115 | + } |
|
| 116 | 116 | |
| 117 | - case 'save': |
|
| 118 | - $key = isset($_POST['cfgkey']) ? $_POST['cfgkey'] : false; |
|
| 119 | - $val = isset($_POST['cfgval']) ? $_POST['cfgval'] : null; |
|
| 120 | - if($key === false || is_null($val)) { |
|
| 121 | - \OCP\JSON::error(array('message' => $l->t('No data specified'))); |
|
| 122 | - exit; |
|
| 123 | - } |
|
| 124 | - $cfg = array($key => $val); |
|
| 125 | - $setParameters = array(); |
|
| 126 | - $configuration->setConfiguration($cfg, $setParameters); |
|
| 127 | - if(!in_array($key, $setParameters)) { |
|
| 128 | - \OCP\JSON::error(array('message' => $l->t($key. |
|
| 129 | - ' Could not set configuration %s', $setParameters[0]))); |
|
| 130 | - exit; |
|
| 131 | - } |
|
| 132 | - $configuration->saveConfiguration(); |
|
| 133 | - //clear the cache on save |
|
| 134 | - $connection = new \OCA\User_LDAP\Connection($ldapWrapper, $prefix); |
|
| 135 | - $connection->clearCache(); |
|
| 136 | - OCP\JSON::success(); |
|
| 137 | - break; |
|
| 138 | - default: |
|
| 139 | - \OCP\JSON::error(array('message' => $l->t('Action does not exist'))); |
|
| 140 | - break; |
|
| 117 | + case 'save': |
|
| 118 | + $key = isset($_POST['cfgkey']) ? $_POST['cfgkey'] : false; |
|
| 119 | + $val = isset($_POST['cfgval']) ? $_POST['cfgval'] : null; |
|
| 120 | + if($key === false || is_null($val)) { |
|
| 121 | + \OCP\JSON::error(array('message' => $l->t('No data specified'))); |
|
| 122 | + exit; |
|
| 123 | + } |
|
| 124 | + $cfg = array($key => $val); |
|
| 125 | + $setParameters = array(); |
|
| 126 | + $configuration->setConfiguration($cfg, $setParameters); |
|
| 127 | + if(!in_array($key, $setParameters)) { |
|
| 128 | + \OCP\JSON::error(array('message' => $l->t($key. |
|
| 129 | + ' Could not set configuration %s', $setParameters[0]))); |
|
| 130 | + exit; |
|
| 131 | + } |
|
| 132 | + $configuration->saveConfiguration(); |
|
| 133 | + //clear the cache on save |
|
| 134 | + $connection = new \OCA\User_LDAP\Connection($ldapWrapper, $prefix); |
|
| 135 | + $connection->clearCache(); |
|
| 136 | + OCP\JSON::success(); |
|
| 137 | + break; |
|
| 138 | + default: |
|
| 139 | + \OCP\JSON::error(array('message' => $l->t('Action does not exist'))); |
|
| 140 | + break; |
|
| 141 | 141 | } |
@@ -32,16 +32,16 @@ discard block |
||
| 32 | 32 | |
| 33 | 33 | $l = \OC::$server->getL10N('user_ldap'); |
| 34 | 34 | |
| 35 | -if(!isset($_POST['action'])) { |
|
| 35 | +if (!isset($_POST['action'])) { |
|
| 36 | 36 | \OCP\JSON::error(array('message' => $l->t('No action specified'))); |
| 37 | 37 | } |
| 38 | -$action = (string)$_POST['action']; |
|
| 38 | +$action = (string) $_POST['action']; |
|
| 39 | 39 | |
| 40 | 40 | |
| 41 | -if(!isset($_POST['ldap_serverconfig_chooser'])) { |
|
| 41 | +if (!isset($_POST['ldap_serverconfig_chooser'])) { |
|
| 42 | 42 | \OCP\JSON::error(array('message' => $l->t('No configuration specified'))); |
| 43 | 43 | } |
| 44 | -$prefix = (string)$_POST['ldap_serverconfig_chooser']; |
|
| 44 | +$prefix = (string) $_POST['ldap_serverconfig_chooser']; |
|
| 45 | 45 | |
| 46 | 46 | $ldapWrapper = new \OCA\User_LDAP\LDAP(); |
| 47 | 47 | $configuration = new \OCA\User_LDAP\Configuration($prefix); |
@@ -66,7 +66,7 @@ discard block |
||
| 66 | 66 | |
| 67 | 67 | $wizard = new \OCA\User_LDAP\Wizard($configuration, $ldapWrapper, $access); |
| 68 | 68 | |
| 69 | -switch($action) { |
|
| 69 | +switch ($action) { |
|
| 70 | 70 | case 'guessPortAndTLS': |
| 71 | 71 | case 'guessBaseDN': |
| 72 | 72 | case 'detectEmailAttribute': |
@@ -85,7 +85,7 @@ discard block |
||
| 85 | 85 | case 'countInBaseDN': |
| 86 | 86 | try { |
| 87 | 87 | $result = $wizard->$action(); |
| 88 | - if($result !== false) { |
|
| 88 | + if ($result !== false) { |
|
| 89 | 89 | OCP\JSON::success($result->getResultArray()); |
| 90 | 90 | exit; |
| 91 | 91 | } |
@@ -101,7 +101,7 @@ discard block |
||
| 101 | 101 | try { |
| 102 | 102 | $loginName = $_POST['ldap_test_loginname']; |
| 103 | 103 | $result = $wizard->$action($loginName); |
| 104 | - if($result !== false) { |
|
| 104 | + if ($result !== false) { |
|
| 105 | 105 | OCP\JSON::success($result->getResultArray()); |
| 106 | 106 | exit; |
| 107 | 107 | } |
@@ -117,14 +117,14 @@ discard block |
||
| 117 | 117 | case 'save': |
| 118 | 118 | $key = isset($_POST['cfgkey']) ? $_POST['cfgkey'] : false; |
| 119 | 119 | $val = isset($_POST['cfgval']) ? $_POST['cfgval'] : null; |
| 120 | - if($key === false || is_null($val)) { |
|
| 120 | + if ($key === false || is_null($val)) { |
|
| 121 | 121 | \OCP\JSON::error(array('message' => $l->t('No data specified'))); |
| 122 | 122 | exit; |
| 123 | 123 | } |
| 124 | 124 | $cfg = array($key => $val); |
| 125 | 125 | $setParameters = array(); |
| 126 | 126 | $configuration->setConfiguration($cfg, $setParameters); |
| 127 | - if(!in_array($key, $setParameters)) { |
|
| 127 | + if (!in_array($key, $setParameters)) { |
|
| 128 | 128 | \OCP\JSON::error(array('message' => $l->t($key. |
| 129 | 129 | ' Could not set configuration %s', $setParameters[0]))); |
| 130 | 130 | exit; |
@@ -38,12 +38,12 @@ |
||
| 38 | 38 | |
| 39 | 39 | $newConfig = new \OCA\User_LDAP\Configuration($nk, false); |
| 40 | 40 | if(isset($_POST['copyConfig'])) { |
| 41 | - $originalConfig = new \OCA\User_LDAP\Configuration($_POST['copyConfig']); |
|
| 42 | - $newConfig->setConfiguration($originalConfig->getConfiguration()); |
|
| 41 | + $originalConfig = new \OCA\User_LDAP\Configuration($_POST['copyConfig']); |
|
| 42 | + $newConfig->setConfiguration($originalConfig->getConfiguration()); |
|
| 43 | 43 | } else { |
| 44 | - $configuration = new \OCA\User_LDAP\Configuration($nk, false); |
|
| 45 | - $newConfig->setConfiguration($configuration->getDefaults()); |
|
| 46 | - $resultData['defaults'] = $configuration->getDefaults(); |
|
| 44 | + $configuration = new \OCA\User_LDAP\Configuration($nk, false); |
|
| 45 | + $newConfig->setConfiguration($configuration->getDefaults()); |
|
| 46 | + $resultData['defaults'] = $configuration->getDefaults(); |
|
| 47 | 47 | } |
| 48 | 48 | $newConfig->saveConfiguration(); |
| 49 | 49 | |
@@ -32,12 +32,12 @@ |
||
| 32 | 32 | sort($serverConnections); |
| 33 | 33 | $lk = array_pop($serverConnections); |
| 34 | 34 | $ln = intval(str_replace('s', '', $lk)); |
| 35 | -$nk = 's'.str_pad($ln+1, 2, '0', STR_PAD_LEFT); |
|
| 35 | +$nk = 's'.str_pad($ln + 1, 2, '0', STR_PAD_LEFT); |
|
| 36 | 36 | |
| 37 | 37 | $resultData = array('configPrefix' => $nk); |
| 38 | 38 | |
| 39 | 39 | $newConfig = new \OCA\User_LDAP\Configuration($nk, false); |
| 40 | -if(isset($_POST['copyConfig'])) { |
|
| 40 | +if (isset($_POST['copyConfig'])) { |
|
| 41 | 41 | $originalConfig = new \OCA\User_LDAP\Configuration($_POST['copyConfig']); |
| 42 | 42 | $newConfig->setConfiguration($originalConfig->getConfiguration()); |
| 43 | 43 | } else { |
@@ -29,12 +29,12 @@ |
||
| 29 | 29 | */ |
| 30 | 30 | class GroupMapping extends AbstractMapping { |
| 31 | 31 | |
| 32 | - /** |
|
| 33 | - * returns the DB table name which holds the mappings |
|
| 34 | - * @return string |
|
| 35 | - */ |
|
| 36 | - protected function getTableName() { |
|
| 37 | - return '*PREFIX*ldap_group_mapping'; |
|
| 38 | - } |
|
| 32 | + /** |
|
| 33 | + * returns the DB table name which holds the mappings |
|
| 34 | + * @return string |
|
| 35 | + */ |
|
| 36 | + protected function getTableName() { |
|
| 37 | + return '*PREFIX*ldap_group_mapping'; |
|
| 38 | + } |
|
| 39 | 39 | |
| 40 | 40 | } |
@@ -29,12 +29,12 @@ |
||
| 29 | 29 | */ |
| 30 | 30 | class UserMapping extends AbstractMapping { |
| 31 | 31 | |
| 32 | - /** |
|
| 33 | - * returns the DB table name which holds the mappings |
|
| 34 | - * @return string |
|
| 35 | - */ |
|
| 36 | - protected function getTableName() { |
|
| 37 | - return '*PREFIX*ldap_user_mapping'; |
|
| 38 | - } |
|
| 32 | + /** |
|
| 33 | + * returns the DB table name which holds the mappings |
|
| 34 | + * @return string |
|
| 35 | + */ |
|
| 36 | + protected function getTableName() { |
|
| 37 | + return '*PREFIX*ldap_user_mapping'; |
|
| 38 | + } |
|
| 39 | 39 | |
| 40 | 40 | } |
@@ -29,252 +29,252 @@ |
||
| 29 | 29 | * @package OCA\User_LDAP\Mapping |
| 30 | 30 | */ |
| 31 | 31 | abstract class AbstractMapping { |
| 32 | - /** |
|
| 33 | - * @var \OCP\IDBConnection $dbc |
|
| 34 | - */ |
|
| 35 | - protected $dbc; |
|
| 32 | + /** |
|
| 33 | + * @var \OCP\IDBConnection $dbc |
|
| 34 | + */ |
|
| 35 | + protected $dbc; |
|
| 36 | 36 | |
| 37 | - /** |
|
| 38 | - * returns the DB table name which holds the mappings |
|
| 39 | - * @return string |
|
| 40 | - */ |
|
| 41 | - abstract protected function getTableName(); |
|
| 37 | + /** |
|
| 38 | + * returns the DB table name which holds the mappings |
|
| 39 | + * @return string |
|
| 40 | + */ |
|
| 41 | + abstract protected function getTableName(); |
|
| 42 | 42 | |
| 43 | - /** |
|
| 44 | - * @param \OCP\IDBConnection $dbc |
|
| 45 | - */ |
|
| 46 | - public function __construct(\OCP\IDBConnection $dbc) { |
|
| 47 | - $this->dbc = $dbc; |
|
| 48 | - } |
|
| 43 | + /** |
|
| 44 | + * @param \OCP\IDBConnection $dbc |
|
| 45 | + */ |
|
| 46 | + public function __construct(\OCP\IDBConnection $dbc) { |
|
| 47 | + $this->dbc = $dbc; |
|
| 48 | + } |
|
| 49 | 49 | |
| 50 | - /** |
|
| 51 | - * checks whether a provided string represents an existing table col |
|
| 52 | - * @param string $col |
|
| 53 | - * @return bool |
|
| 54 | - */ |
|
| 55 | - public function isColNameValid($col) { |
|
| 56 | - switch($col) { |
|
| 57 | - case 'ldap_dn': |
|
| 58 | - case 'owncloud_name': |
|
| 59 | - case 'directory_uuid': |
|
| 60 | - return true; |
|
| 61 | - default: |
|
| 62 | - return false; |
|
| 63 | - } |
|
| 64 | - } |
|
| 50 | + /** |
|
| 51 | + * checks whether a provided string represents an existing table col |
|
| 52 | + * @param string $col |
|
| 53 | + * @return bool |
|
| 54 | + */ |
|
| 55 | + public function isColNameValid($col) { |
|
| 56 | + switch($col) { |
|
| 57 | + case 'ldap_dn': |
|
| 58 | + case 'owncloud_name': |
|
| 59 | + case 'directory_uuid': |
|
| 60 | + return true; |
|
| 61 | + default: |
|
| 62 | + return false; |
|
| 63 | + } |
|
| 64 | + } |
|
| 65 | 65 | |
| 66 | - /** |
|
| 67 | - * Gets the value of one column based on a provided value of another column |
|
| 68 | - * @param string $fetchCol |
|
| 69 | - * @param string $compareCol |
|
| 70 | - * @param string $search |
|
| 71 | - * @throws \Exception |
|
| 72 | - * @return string|false |
|
| 73 | - */ |
|
| 74 | - protected function getXbyY($fetchCol, $compareCol, $search) { |
|
| 75 | - if(!$this->isColNameValid($fetchCol)) { |
|
| 76 | - //this is used internally only, but we don't want to risk |
|
| 77 | - //having SQL injection at all. |
|
| 78 | - throw new \Exception('Invalid Column Name'); |
|
| 79 | - } |
|
| 80 | - $query = $this->dbc->prepare(' |
|
| 66 | + /** |
|
| 67 | + * Gets the value of one column based on a provided value of another column |
|
| 68 | + * @param string $fetchCol |
|
| 69 | + * @param string $compareCol |
|
| 70 | + * @param string $search |
|
| 71 | + * @throws \Exception |
|
| 72 | + * @return string|false |
|
| 73 | + */ |
|
| 74 | + protected function getXbyY($fetchCol, $compareCol, $search) { |
|
| 75 | + if(!$this->isColNameValid($fetchCol)) { |
|
| 76 | + //this is used internally only, but we don't want to risk |
|
| 77 | + //having SQL injection at all. |
|
| 78 | + throw new \Exception('Invalid Column Name'); |
|
| 79 | + } |
|
| 80 | + $query = $this->dbc->prepare(' |
|
| 81 | 81 | SELECT `' . $fetchCol . '` |
| 82 | 82 | FROM `'. $this->getTableName() .'` |
| 83 | 83 | WHERE `' . $compareCol . '` = ? |
| 84 | 84 | '); |
| 85 | 85 | |
| 86 | - $res = $query->execute(array($search)); |
|
| 87 | - if($res !== false) { |
|
| 88 | - return $query->fetchColumn(); |
|
| 89 | - } |
|
| 86 | + $res = $query->execute(array($search)); |
|
| 87 | + if($res !== false) { |
|
| 88 | + return $query->fetchColumn(); |
|
| 89 | + } |
|
| 90 | 90 | |
| 91 | - return false; |
|
| 92 | - } |
|
| 91 | + return false; |
|
| 92 | + } |
|
| 93 | 93 | |
| 94 | - /** |
|
| 95 | - * Performs a DELETE or UPDATE query to the database. |
|
| 96 | - * @param \Doctrine\DBAL\Driver\Statement $query |
|
| 97 | - * @param array $parameters |
|
| 98 | - * @return bool true if at least one row was modified, false otherwise |
|
| 99 | - */ |
|
| 100 | - protected function modify($query, $parameters) { |
|
| 101 | - $result = $query->execute($parameters); |
|
| 102 | - return ($result === true && $query->rowCount() > 0); |
|
| 103 | - } |
|
| 94 | + /** |
|
| 95 | + * Performs a DELETE or UPDATE query to the database. |
|
| 96 | + * @param \Doctrine\DBAL\Driver\Statement $query |
|
| 97 | + * @param array $parameters |
|
| 98 | + * @return bool true if at least one row was modified, false otherwise |
|
| 99 | + */ |
|
| 100 | + protected function modify($query, $parameters) { |
|
| 101 | + $result = $query->execute($parameters); |
|
| 102 | + return ($result === true && $query->rowCount() > 0); |
|
| 103 | + } |
|
| 104 | 104 | |
| 105 | - /** |
|
| 106 | - * Gets the LDAP DN based on the provided name. |
|
| 107 | - * Replaces Access::ocname2dn |
|
| 108 | - * @param string $name |
|
| 109 | - * @return string|false |
|
| 110 | - */ |
|
| 111 | - public function getDNByName($name) { |
|
| 112 | - return $this->getXbyY('ldap_dn', 'owncloud_name', $name); |
|
| 113 | - } |
|
| 105 | + /** |
|
| 106 | + * Gets the LDAP DN based on the provided name. |
|
| 107 | + * Replaces Access::ocname2dn |
|
| 108 | + * @param string $name |
|
| 109 | + * @return string|false |
|
| 110 | + */ |
|
| 111 | + public function getDNByName($name) { |
|
| 112 | + return $this->getXbyY('ldap_dn', 'owncloud_name', $name); |
|
| 113 | + } |
|
| 114 | 114 | |
| 115 | - /** |
|
| 116 | - * Updates the DN based on the given UUID |
|
| 117 | - * @param string $fdn |
|
| 118 | - * @param string $uuid |
|
| 119 | - * @return bool |
|
| 120 | - */ |
|
| 121 | - public function setDNbyUUID($fdn, $uuid) { |
|
| 122 | - $query = $this->dbc->prepare(' |
|
| 115 | + /** |
|
| 116 | + * Updates the DN based on the given UUID |
|
| 117 | + * @param string $fdn |
|
| 118 | + * @param string $uuid |
|
| 119 | + * @return bool |
|
| 120 | + */ |
|
| 121 | + public function setDNbyUUID($fdn, $uuid) { |
|
| 122 | + $query = $this->dbc->prepare(' |
|
| 123 | 123 | UPDATE `' . $this->getTableName() . '` |
| 124 | 124 | SET `ldap_dn` = ? |
| 125 | 125 | WHERE `directory_uuid` = ? |
| 126 | 126 | '); |
| 127 | 127 | |
| 128 | - return $this->modify($query, array($fdn, $uuid)); |
|
| 129 | - } |
|
| 128 | + return $this->modify($query, array($fdn, $uuid)); |
|
| 129 | + } |
|
| 130 | 130 | |
| 131 | - /** |
|
| 132 | - * Updates the UUID based on the given DN |
|
| 133 | - * |
|
| 134 | - * required by Migration/UUIDFix |
|
| 135 | - * |
|
| 136 | - * @param $uuid |
|
| 137 | - * @param $fdn |
|
| 138 | - * @return bool |
|
| 139 | - */ |
|
| 140 | - public function setUUIDbyDN($uuid, $fdn) { |
|
| 141 | - $query = $this->dbc->prepare(' |
|
| 131 | + /** |
|
| 132 | + * Updates the UUID based on the given DN |
|
| 133 | + * |
|
| 134 | + * required by Migration/UUIDFix |
|
| 135 | + * |
|
| 136 | + * @param $uuid |
|
| 137 | + * @param $fdn |
|
| 138 | + * @return bool |
|
| 139 | + */ |
|
| 140 | + public function setUUIDbyDN($uuid, $fdn) { |
|
| 141 | + $query = $this->dbc->prepare(' |
|
| 142 | 142 | UPDATE `' . $this->getTableName() . '` |
| 143 | 143 | SET `directory_uuid` = ? |
| 144 | 144 | WHERE `ldap_dn` = ? |
| 145 | 145 | '); |
| 146 | 146 | |
| 147 | - return $this->modify($query, [$uuid, $fdn]); |
|
| 148 | - } |
|
| 147 | + return $this->modify($query, [$uuid, $fdn]); |
|
| 148 | + } |
|
| 149 | 149 | |
| 150 | - /** |
|
| 151 | - * Gets the name based on the provided LDAP DN. |
|
| 152 | - * @param string $fdn |
|
| 153 | - * @return string|false |
|
| 154 | - */ |
|
| 155 | - public function getNameByDN($fdn) { |
|
| 156 | - return $this->getXbyY('owncloud_name', 'ldap_dn', $fdn); |
|
| 157 | - } |
|
| 150 | + /** |
|
| 151 | + * Gets the name based on the provided LDAP DN. |
|
| 152 | + * @param string $fdn |
|
| 153 | + * @return string|false |
|
| 154 | + */ |
|
| 155 | + public function getNameByDN($fdn) { |
|
| 156 | + return $this->getXbyY('owncloud_name', 'ldap_dn', $fdn); |
|
| 157 | + } |
|
| 158 | 158 | |
| 159 | - /** |
|
| 160 | - * Searches mapped names by the giving string in the name column |
|
| 161 | - * @param string $search |
|
| 162 | - * @param string $prefixMatch |
|
| 163 | - * @param string $postfixMatch |
|
| 164 | - * @return string[] |
|
| 165 | - */ |
|
| 166 | - public function getNamesBySearch($search, $prefixMatch = "", $postfixMatch = "") { |
|
| 167 | - $query = $this->dbc->prepare(' |
|
| 159 | + /** |
|
| 160 | + * Searches mapped names by the giving string in the name column |
|
| 161 | + * @param string $search |
|
| 162 | + * @param string $prefixMatch |
|
| 163 | + * @param string $postfixMatch |
|
| 164 | + * @return string[] |
|
| 165 | + */ |
|
| 166 | + public function getNamesBySearch($search, $prefixMatch = "", $postfixMatch = "") { |
|
| 167 | + $query = $this->dbc->prepare(' |
|
| 168 | 168 | SELECT `owncloud_name` |
| 169 | 169 | FROM `'. $this->getTableName() .'` |
| 170 | 170 | WHERE `owncloud_name` LIKE ? |
| 171 | 171 | '); |
| 172 | 172 | |
| 173 | - $res = $query->execute(array($prefixMatch.$this->dbc->escapeLikeParameter($search).$postfixMatch)); |
|
| 174 | - $names = array(); |
|
| 175 | - if($res !== false) { |
|
| 176 | - while($row = $query->fetch()) { |
|
| 177 | - $names[] = $row['owncloud_name']; |
|
| 178 | - } |
|
| 179 | - } |
|
| 180 | - return $names; |
|
| 181 | - } |
|
| 173 | + $res = $query->execute(array($prefixMatch.$this->dbc->escapeLikeParameter($search).$postfixMatch)); |
|
| 174 | + $names = array(); |
|
| 175 | + if($res !== false) { |
|
| 176 | + while($row = $query->fetch()) { |
|
| 177 | + $names[] = $row['owncloud_name']; |
|
| 178 | + } |
|
| 179 | + } |
|
| 180 | + return $names; |
|
| 181 | + } |
|
| 182 | 182 | |
| 183 | - /** |
|
| 184 | - * Gets the name based on the provided LDAP UUID. |
|
| 185 | - * @param string $uuid |
|
| 186 | - * @return string|false |
|
| 187 | - */ |
|
| 188 | - public function getNameByUUID($uuid) { |
|
| 189 | - return $this->getXbyY('owncloud_name', 'directory_uuid', $uuid); |
|
| 190 | - } |
|
| 183 | + /** |
|
| 184 | + * Gets the name based on the provided LDAP UUID. |
|
| 185 | + * @param string $uuid |
|
| 186 | + * @return string|false |
|
| 187 | + */ |
|
| 188 | + public function getNameByUUID($uuid) { |
|
| 189 | + return $this->getXbyY('owncloud_name', 'directory_uuid', $uuid); |
|
| 190 | + } |
|
| 191 | 191 | |
| 192 | - /** |
|
| 193 | - * Gets the UUID based on the provided LDAP DN |
|
| 194 | - * @param string $dn |
|
| 195 | - * @return false|string |
|
| 196 | - * @throws \Exception |
|
| 197 | - */ |
|
| 198 | - public function getUUIDByDN($dn) { |
|
| 199 | - return $this->getXbyY('directory_uuid', 'ldap_dn', $dn); |
|
| 200 | - } |
|
| 192 | + /** |
|
| 193 | + * Gets the UUID based on the provided LDAP DN |
|
| 194 | + * @param string $dn |
|
| 195 | + * @return false|string |
|
| 196 | + * @throws \Exception |
|
| 197 | + */ |
|
| 198 | + public function getUUIDByDN($dn) { |
|
| 199 | + return $this->getXbyY('directory_uuid', 'ldap_dn', $dn); |
|
| 200 | + } |
|
| 201 | 201 | |
| 202 | - /** |
|
| 203 | - * gets a piece of the mapping list |
|
| 204 | - * @param int $offset |
|
| 205 | - * @param int $limit |
|
| 206 | - * @return array |
|
| 207 | - */ |
|
| 208 | - public function getList($offset = null, $limit = null) { |
|
| 209 | - $query = $this->dbc->prepare(' |
|
| 202 | + /** |
|
| 203 | + * gets a piece of the mapping list |
|
| 204 | + * @param int $offset |
|
| 205 | + * @param int $limit |
|
| 206 | + * @return array |
|
| 207 | + */ |
|
| 208 | + public function getList($offset = null, $limit = null) { |
|
| 209 | + $query = $this->dbc->prepare(' |
|
| 210 | 210 | SELECT |
| 211 | 211 | `ldap_dn` AS `dn`, |
| 212 | 212 | `owncloud_name` AS `name`, |
| 213 | 213 | `directory_uuid` AS `uuid` |
| 214 | 214 | FROM `' . $this->getTableName() . '`', |
| 215 | - $limit, |
|
| 216 | - $offset |
|
| 217 | - ); |
|
| 215 | + $limit, |
|
| 216 | + $offset |
|
| 217 | + ); |
|
| 218 | 218 | |
| 219 | - $query->execute(); |
|
| 220 | - return $query->fetchAll(); |
|
| 221 | - } |
|
| 219 | + $query->execute(); |
|
| 220 | + return $query->fetchAll(); |
|
| 221 | + } |
|
| 222 | 222 | |
| 223 | - /** |
|
| 224 | - * attempts to map the given entry |
|
| 225 | - * @param string $fdn fully distinguished name (from LDAP) |
|
| 226 | - * @param string $name |
|
| 227 | - * @param string $uuid a unique identifier as used in LDAP |
|
| 228 | - * @return bool |
|
| 229 | - */ |
|
| 230 | - public function map($fdn, $name, $uuid) { |
|
| 231 | - if(mb_strlen($fdn) > 255) { |
|
| 232 | - \OC::$server->getLogger()->error( |
|
| 233 | - 'Cannot map, because the DN exceeds 255 characters: {dn}', |
|
| 234 | - [ |
|
| 235 | - 'app' => 'user_ldap', |
|
| 236 | - 'dn' => $fdn, |
|
| 237 | - ] |
|
| 238 | - ); |
|
| 239 | - return false; |
|
| 240 | - } |
|
| 223 | + /** |
|
| 224 | + * attempts to map the given entry |
|
| 225 | + * @param string $fdn fully distinguished name (from LDAP) |
|
| 226 | + * @param string $name |
|
| 227 | + * @param string $uuid a unique identifier as used in LDAP |
|
| 228 | + * @return bool |
|
| 229 | + */ |
|
| 230 | + public function map($fdn, $name, $uuid) { |
|
| 231 | + if(mb_strlen($fdn) > 255) { |
|
| 232 | + \OC::$server->getLogger()->error( |
|
| 233 | + 'Cannot map, because the DN exceeds 255 characters: {dn}', |
|
| 234 | + [ |
|
| 235 | + 'app' => 'user_ldap', |
|
| 236 | + 'dn' => $fdn, |
|
| 237 | + ] |
|
| 238 | + ); |
|
| 239 | + return false; |
|
| 240 | + } |
|
| 241 | 241 | |
| 242 | - $row = array( |
|
| 243 | - 'ldap_dn' => $fdn, |
|
| 244 | - 'owncloud_name' => $name, |
|
| 245 | - 'directory_uuid' => $uuid |
|
| 246 | - ); |
|
| 242 | + $row = array( |
|
| 243 | + 'ldap_dn' => $fdn, |
|
| 244 | + 'owncloud_name' => $name, |
|
| 245 | + 'directory_uuid' => $uuid |
|
| 246 | + ); |
|
| 247 | 247 | |
| 248 | - try { |
|
| 249 | - $result = $this->dbc->insertIfNotExist($this->getTableName(), $row); |
|
| 250 | - // insertIfNotExist returns values as int |
|
| 251 | - return (bool)$result; |
|
| 252 | - } catch (\Exception $e) { |
|
| 253 | - return false; |
|
| 254 | - } |
|
| 255 | - } |
|
| 248 | + try { |
|
| 249 | + $result = $this->dbc->insertIfNotExist($this->getTableName(), $row); |
|
| 250 | + // insertIfNotExist returns values as int |
|
| 251 | + return (bool)$result; |
|
| 252 | + } catch (\Exception $e) { |
|
| 253 | + return false; |
|
| 254 | + } |
|
| 255 | + } |
|
| 256 | 256 | |
| 257 | - /** |
|
| 258 | - * removes a mapping based on the owncloud_name of the entry |
|
| 259 | - * @param string $name |
|
| 260 | - * @return bool |
|
| 261 | - */ |
|
| 262 | - public function unmap($name) { |
|
| 263 | - $query = $this->dbc->prepare(' |
|
| 257 | + /** |
|
| 258 | + * removes a mapping based on the owncloud_name of the entry |
|
| 259 | + * @param string $name |
|
| 260 | + * @return bool |
|
| 261 | + */ |
|
| 262 | + public function unmap($name) { |
|
| 263 | + $query = $this->dbc->prepare(' |
|
| 264 | 264 | DELETE FROM `'. $this->getTableName() .'` |
| 265 | 265 | WHERE `owncloud_name` = ?'); |
| 266 | 266 | |
| 267 | - return $this->modify($query, array($name)); |
|
| 268 | - } |
|
| 267 | + return $this->modify($query, array($name)); |
|
| 268 | + } |
|
| 269 | 269 | |
| 270 | - /** |
|
| 271 | - * Truncate's the mapping table |
|
| 272 | - * @return bool |
|
| 273 | - */ |
|
| 274 | - public function clear() { |
|
| 275 | - $sql = $this->dbc |
|
| 276 | - ->getDatabasePlatform() |
|
| 277 | - ->getTruncateTableSQL('`' . $this->getTableName() . '`'); |
|
| 278 | - return $this->dbc->prepare($sql)->execute(); |
|
| 279 | - } |
|
| 270 | + /** |
|
| 271 | + * Truncate's the mapping table |
|
| 272 | + * @return bool |
|
| 273 | + */ |
|
| 274 | + public function clear() { |
|
| 275 | + $sql = $this->dbc |
|
| 276 | + ->getDatabasePlatform() |
|
| 277 | + ->getTruncateTableSQL('`' . $this->getTableName() . '`'); |
|
| 278 | + return $this->dbc->prepare($sql)->execute(); |
|
| 279 | + } |
|
| 280 | 280 | } |
@@ -53,7 +53,7 @@ discard block |
||
| 53 | 53 | * @return bool |
| 54 | 54 | */ |
| 55 | 55 | public function isColNameValid($col) { |
| 56 | - switch($col) { |
|
| 56 | + switch ($col) { |
|
| 57 | 57 | case 'ldap_dn': |
| 58 | 58 | case 'owncloud_name': |
| 59 | 59 | case 'directory_uuid': |
@@ -72,19 +72,19 @@ discard block |
||
| 72 | 72 | * @return string|false |
| 73 | 73 | */ |
| 74 | 74 | protected function getXbyY($fetchCol, $compareCol, $search) { |
| 75 | - if(!$this->isColNameValid($fetchCol)) { |
|
| 75 | + if (!$this->isColNameValid($fetchCol)) { |
|
| 76 | 76 | //this is used internally only, but we don't want to risk |
| 77 | 77 | //having SQL injection at all. |
| 78 | 78 | throw new \Exception('Invalid Column Name'); |
| 79 | 79 | } |
| 80 | 80 | $query = $this->dbc->prepare(' |
| 81 | - SELECT `' . $fetchCol . '` |
|
| 82 | - FROM `'. $this->getTableName() .'` |
|
| 83 | - WHERE `' . $compareCol . '` = ? |
|
| 81 | + SELECT `' . $fetchCol.'` |
|
| 82 | + FROM `'. $this->getTableName().'` |
|
| 83 | + WHERE `' . $compareCol.'` = ? |
|
| 84 | 84 | '); |
| 85 | 85 | |
| 86 | 86 | $res = $query->execute(array($search)); |
| 87 | - if($res !== false) { |
|
| 87 | + if ($res !== false) { |
|
| 88 | 88 | return $query->fetchColumn(); |
| 89 | 89 | } |
| 90 | 90 | |
@@ -120,7 +120,7 @@ discard block |
||
| 120 | 120 | */ |
| 121 | 121 | public function setDNbyUUID($fdn, $uuid) { |
| 122 | 122 | $query = $this->dbc->prepare(' |
| 123 | - UPDATE `' . $this->getTableName() . '` |
|
| 123 | + UPDATE `' . $this->getTableName().'` |
|
| 124 | 124 | SET `ldap_dn` = ? |
| 125 | 125 | WHERE `directory_uuid` = ? |
| 126 | 126 | '); |
@@ -139,7 +139,7 @@ discard block |
||
| 139 | 139 | */ |
| 140 | 140 | public function setUUIDbyDN($uuid, $fdn) { |
| 141 | 141 | $query = $this->dbc->prepare(' |
| 142 | - UPDATE `' . $this->getTableName() . '` |
|
| 142 | + UPDATE `' . $this->getTableName().'` |
|
| 143 | 143 | SET `directory_uuid` = ? |
| 144 | 144 | WHERE `ldap_dn` = ? |
| 145 | 145 | '); |
@@ -166,14 +166,14 @@ discard block |
||
| 166 | 166 | public function getNamesBySearch($search, $prefixMatch = "", $postfixMatch = "") { |
| 167 | 167 | $query = $this->dbc->prepare(' |
| 168 | 168 | SELECT `owncloud_name` |
| 169 | - FROM `'. $this->getTableName() .'` |
|
| 169 | + FROM `'. $this->getTableName().'` |
|
| 170 | 170 | WHERE `owncloud_name` LIKE ? |
| 171 | 171 | '); |
| 172 | 172 | |
| 173 | 173 | $res = $query->execute(array($prefixMatch.$this->dbc->escapeLikeParameter($search).$postfixMatch)); |
| 174 | 174 | $names = array(); |
| 175 | - if($res !== false) { |
|
| 176 | - while($row = $query->fetch()) { |
|
| 175 | + if ($res !== false) { |
|
| 176 | + while ($row = $query->fetch()) { |
|
| 177 | 177 | $names[] = $row['owncloud_name']; |
| 178 | 178 | } |
| 179 | 179 | } |
@@ -211,7 +211,7 @@ discard block |
||
| 211 | 211 | `ldap_dn` AS `dn`, |
| 212 | 212 | `owncloud_name` AS `name`, |
| 213 | 213 | `directory_uuid` AS `uuid` |
| 214 | - FROM `' . $this->getTableName() . '`', |
|
| 214 | + FROM `' . $this->getTableName().'`', |
|
| 215 | 215 | $limit, |
| 216 | 216 | $offset |
| 217 | 217 | ); |
@@ -228,7 +228,7 @@ discard block |
||
| 228 | 228 | * @return bool |
| 229 | 229 | */ |
| 230 | 230 | public function map($fdn, $name, $uuid) { |
| 231 | - if(mb_strlen($fdn) > 255) { |
|
| 231 | + if (mb_strlen($fdn) > 255) { |
|
| 232 | 232 | \OC::$server->getLogger()->error( |
| 233 | 233 | 'Cannot map, because the DN exceeds 255 characters: {dn}', |
| 234 | 234 | [ |
@@ -248,7 +248,7 @@ discard block |
||
| 248 | 248 | try { |
| 249 | 249 | $result = $this->dbc->insertIfNotExist($this->getTableName(), $row); |
| 250 | 250 | // insertIfNotExist returns values as int |
| 251 | - return (bool)$result; |
|
| 251 | + return (bool) $result; |
|
| 252 | 252 | } catch (\Exception $e) { |
| 253 | 253 | return false; |
| 254 | 254 | } |
@@ -261,7 +261,7 @@ discard block |
||
| 261 | 261 | */ |
| 262 | 262 | public function unmap($name) { |
| 263 | 263 | $query = $this->dbc->prepare(' |
| 264 | - DELETE FROM `'. $this->getTableName() .'` |
|
| 264 | + DELETE FROM `'. $this->getTableName().'` |
|
| 265 | 265 | WHERE `owncloud_name` = ?'); |
| 266 | 266 | |
| 267 | 267 | return $this->modify($query, array($name)); |
@@ -274,7 +274,7 @@ discard block |
||
| 274 | 274 | public function clear() { |
| 275 | 275 | $sql = $this->dbc |
| 276 | 276 | ->getDatabasePlatform() |
| 277 | - ->getTruncateTableSQL('`' . $this->getTableName() . '`'); |
|
| 277 | + ->getTruncateTableSQL('`'.$this->getTableName().'`'); |
|
| 278 | 278 | return $this->dbc->prepare($sql)->execute(); |
| 279 | 279 | } |
| 280 | 280 | } |
@@ -27,182 +27,182 @@ |
||
| 27 | 27 | namespace OCA\User_LDAP; |
| 28 | 28 | |
| 29 | 29 | class Group_Proxy extends Proxy implements \OCP\GroupInterface { |
| 30 | - private $backends = array(); |
|
| 31 | - private $refBackend = null; |
|
| 32 | - |
|
| 33 | - /** |
|
| 34 | - * Constructor |
|
| 35 | - * @param string[] $serverConfigPrefixes array containing the config Prefixes |
|
| 36 | - */ |
|
| 37 | - public function __construct($serverConfigPrefixes, ILDAPWrapper $ldap) { |
|
| 38 | - parent::__construct($ldap); |
|
| 39 | - foreach($serverConfigPrefixes as $configPrefix) { |
|
| 40 | - $this->backends[$configPrefix] = |
|
| 41 | - new \OCA\User_LDAP\Group_LDAP($this->getAccess($configPrefix)); |
|
| 42 | - if(is_null($this->refBackend)) { |
|
| 43 | - $this->refBackend = &$this->backends[$configPrefix]; |
|
| 44 | - } |
|
| 45 | - } |
|
| 46 | - } |
|
| 47 | - |
|
| 48 | - /** |
|
| 49 | - * Tries the backends one after the other until a positive result is returned from the specified method |
|
| 50 | - * @param string $gid the gid connected to the request |
|
| 51 | - * @param string $method the method of the group backend that shall be called |
|
| 52 | - * @param array $parameters an array of parameters to be passed |
|
| 53 | - * @return mixed, the result of the method or false |
|
| 54 | - */ |
|
| 55 | - protected function walkBackends($gid, $method, $parameters) { |
|
| 56 | - $cacheKey = $this->getGroupCacheKey($gid); |
|
| 57 | - foreach($this->backends as $configPrefix => $backend) { |
|
| 58 | - if($result = call_user_func_array(array($backend, $method), $parameters)) { |
|
| 59 | - $this->writeToCache($cacheKey, $configPrefix); |
|
| 60 | - return $result; |
|
| 61 | - } |
|
| 62 | - } |
|
| 63 | - return false; |
|
| 64 | - } |
|
| 65 | - |
|
| 66 | - /** |
|
| 67 | - * Asks the backend connected to the server that supposely takes care of the gid from the request. |
|
| 68 | - * @param string $gid the gid connected to the request |
|
| 69 | - * @param string $method the method of the group backend that shall be called |
|
| 70 | - * @param array $parameters an array of parameters to be passed |
|
| 71 | - * @param mixed $passOnWhen the result matches this variable |
|
| 72 | - * @return mixed, the result of the method or false |
|
| 73 | - */ |
|
| 74 | - protected function callOnLastSeenOn($gid, $method, $parameters, $passOnWhen) { |
|
| 75 | - $cacheKey = $this->getGroupCacheKey($gid);; |
|
| 76 | - $prefix = $this->getFromCache($cacheKey); |
|
| 77 | - //in case the uid has been found in the past, try this stored connection first |
|
| 78 | - if(!is_null($prefix)) { |
|
| 79 | - if(isset($this->backends[$prefix])) { |
|
| 80 | - $result = call_user_func_array(array($this->backends[$prefix], $method), $parameters); |
|
| 81 | - if($result === $passOnWhen) { |
|
| 82 | - //not found here, reset cache to null if group vanished |
|
| 83 | - //because sometimes methods return false with a reason |
|
| 84 | - $groupExists = call_user_func_array( |
|
| 85 | - array($this->backends[$prefix], 'groupExists'), |
|
| 86 | - array($gid) |
|
| 87 | - ); |
|
| 88 | - if(!$groupExists) { |
|
| 89 | - $this->writeToCache($cacheKey, null); |
|
| 90 | - } |
|
| 91 | - } |
|
| 92 | - return $result; |
|
| 93 | - } |
|
| 94 | - } |
|
| 95 | - return false; |
|
| 96 | - } |
|
| 97 | - |
|
| 98 | - /** |
|
| 99 | - * is user in group? |
|
| 100 | - * @param string $uid uid of the user |
|
| 101 | - * @param string $gid gid of the group |
|
| 102 | - * @return bool |
|
| 103 | - * |
|
| 104 | - * Checks whether the user is member of a group or not. |
|
| 105 | - */ |
|
| 106 | - public function inGroup($uid, $gid) { |
|
| 107 | - return $this->handleRequest($gid, 'inGroup', array($uid, $gid)); |
|
| 108 | - } |
|
| 109 | - |
|
| 110 | - /** |
|
| 111 | - * Get all groups a user belongs to |
|
| 112 | - * @param string $uid Name of the user |
|
| 113 | - * @return string[] with group names |
|
| 114 | - * |
|
| 115 | - * This function fetches all groups a user belongs to. It does not check |
|
| 116 | - * if the user exists at all. |
|
| 117 | - */ |
|
| 118 | - public function getUserGroups($uid) { |
|
| 119 | - $groups = array(); |
|
| 120 | - |
|
| 121 | - foreach($this->backends as $backend) { |
|
| 122 | - $backendGroups = $backend->getUserGroups($uid); |
|
| 123 | - if (is_array($backendGroups)) { |
|
| 124 | - $groups = array_merge($groups, $backendGroups); |
|
| 125 | - } |
|
| 126 | - } |
|
| 127 | - |
|
| 128 | - return $groups; |
|
| 129 | - } |
|
| 130 | - |
|
| 131 | - /** |
|
| 132 | - * get a list of all users in a group |
|
| 133 | - * @return string[] with user ids |
|
| 134 | - */ |
|
| 135 | - public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0) { |
|
| 136 | - $users = array(); |
|
| 137 | - |
|
| 138 | - foreach($this->backends as $backend) { |
|
| 139 | - $backendUsers = $backend->usersInGroup($gid, $search, $limit, $offset); |
|
| 140 | - if (is_array($backendUsers)) { |
|
| 141 | - $users = array_merge($users, $backendUsers); |
|
| 142 | - } |
|
| 143 | - } |
|
| 144 | - |
|
| 145 | - return $users; |
|
| 146 | - } |
|
| 147 | - |
|
| 148 | - /** |
|
| 149 | - * returns the number of users in a group, who match the search term |
|
| 150 | - * @param string $gid the internal group name |
|
| 151 | - * @param string $search optional, a search string |
|
| 152 | - * @return int|bool |
|
| 153 | - */ |
|
| 154 | - public function countUsersInGroup($gid, $search = '') { |
|
| 155 | - return $this->handleRequest( |
|
| 156 | - $gid, 'countUsersInGroup', array($gid, $search)); |
|
| 157 | - } |
|
| 158 | - |
|
| 159 | - /** |
|
| 160 | - * get a list of all groups |
|
| 161 | - * @return string[] with group names |
|
| 162 | - * |
|
| 163 | - * Returns a list with all groups |
|
| 164 | - */ |
|
| 165 | - public function getGroups($search = '', $limit = -1, $offset = 0) { |
|
| 166 | - $groups = array(); |
|
| 167 | - |
|
| 168 | - foreach($this->backends as $backend) { |
|
| 169 | - $backendGroups = $backend->getGroups($search, $limit, $offset); |
|
| 170 | - if (is_array($backendGroups)) { |
|
| 171 | - $groups = array_merge($groups, $backendGroups); |
|
| 172 | - } |
|
| 173 | - } |
|
| 174 | - |
|
| 175 | - return $groups; |
|
| 176 | - } |
|
| 177 | - |
|
| 178 | - /** |
|
| 179 | - * check if a group exists |
|
| 180 | - * @param string $gid |
|
| 181 | - * @return bool |
|
| 182 | - */ |
|
| 183 | - public function groupExists($gid) { |
|
| 184 | - return $this->handleRequest($gid, 'groupExists', array($gid)); |
|
| 185 | - } |
|
| 186 | - |
|
| 187 | - /** |
|
| 188 | - * Check if backend implements actions |
|
| 189 | - * @param int $actions bitwise-or'ed actions |
|
| 190 | - * @return boolean |
|
| 191 | - * |
|
| 192 | - * Returns the supported actions as int to be |
|
| 193 | - * compared with OC_USER_BACKEND_CREATE_USER etc. |
|
| 194 | - */ |
|
| 195 | - public function implementsActions($actions) { |
|
| 196 | - //it's the same across all our user backends obviously |
|
| 197 | - return $this->refBackend->implementsActions($actions); |
|
| 198 | - } |
|
| 199 | - |
|
| 200 | - /** |
|
| 201 | - * Return access for LDAP interaction. |
|
| 202 | - * @param string $gid |
|
| 203 | - * @return Access instance of Access for LDAP interaction |
|
| 204 | - */ |
|
| 205 | - public function getLDAPAccess($gid) { |
|
| 206 | - return $this->handleRequest($gid, 'getLDAPAccess', []); |
|
| 207 | - } |
|
| 30 | + private $backends = array(); |
|
| 31 | + private $refBackend = null; |
|
| 32 | + |
|
| 33 | + /** |
|
| 34 | + * Constructor |
|
| 35 | + * @param string[] $serverConfigPrefixes array containing the config Prefixes |
|
| 36 | + */ |
|
| 37 | + public function __construct($serverConfigPrefixes, ILDAPWrapper $ldap) { |
|
| 38 | + parent::__construct($ldap); |
|
| 39 | + foreach($serverConfigPrefixes as $configPrefix) { |
|
| 40 | + $this->backends[$configPrefix] = |
|
| 41 | + new \OCA\User_LDAP\Group_LDAP($this->getAccess($configPrefix)); |
|
| 42 | + if(is_null($this->refBackend)) { |
|
| 43 | + $this->refBackend = &$this->backends[$configPrefix]; |
|
| 44 | + } |
|
| 45 | + } |
|
| 46 | + } |
|
| 47 | + |
|
| 48 | + /** |
|
| 49 | + * Tries the backends one after the other until a positive result is returned from the specified method |
|
| 50 | + * @param string $gid the gid connected to the request |
|
| 51 | + * @param string $method the method of the group backend that shall be called |
|
| 52 | + * @param array $parameters an array of parameters to be passed |
|
| 53 | + * @return mixed, the result of the method or false |
|
| 54 | + */ |
|
| 55 | + protected function walkBackends($gid, $method, $parameters) { |
|
| 56 | + $cacheKey = $this->getGroupCacheKey($gid); |
|
| 57 | + foreach($this->backends as $configPrefix => $backend) { |
|
| 58 | + if($result = call_user_func_array(array($backend, $method), $parameters)) { |
|
| 59 | + $this->writeToCache($cacheKey, $configPrefix); |
|
| 60 | + return $result; |
|
| 61 | + } |
|
| 62 | + } |
|
| 63 | + return false; |
|
| 64 | + } |
|
| 65 | + |
|
| 66 | + /** |
|
| 67 | + * Asks the backend connected to the server that supposely takes care of the gid from the request. |
|
| 68 | + * @param string $gid the gid connected to the request |
|
| 69 | + * @param string $method the method of the group backend that shall be called |
|
| 70 | + * @param array $parameters an array of parameters to be passed |
|
| 71 | + * @param mixed $passOnWhen the result matches this variable |
|
| 72 | + * @return mixed, the result of the method or false |
|
| 73 | + */ |
|
| 74 | + protected function callOnLastSeenOn($gid, $method, $parameters, $passOnWhen) { |
|
| 75 | + $cacheKey = $this->getGroupCacheKey($gid);; |
|
| 76 | + $prefix = $this->getFromCache($cacheKey); |
|
| 77 | + //in case the uid has been found in the past, try this stored connection first |
|
| 78 | + if(!is_null($prefix)) { |
|
| 79 | + if(isset($this->backends[$prefix])) { |
|
| 80 | + $result = call_user_func_array(array($this->backends[$prefix], $method), $parameters); |
|
| 81 | + if($result === $passOnWhen) { |
|
| 82 | + //not found here, reset cache to null if group vanished |
|
| 83 | + //because sometimes methods return false with a reason |
|
| 84 | + $groupExists = call_user_func_array( |
|
| 85 | + array($this->backends[$prefix], 'groupExists'), |
|
| 86 | + array($gid) |
|
| 87 | + ); |
|
| 88 | + if(!$groupExists) { |
|
| 89 | + $this->writeToCache($cacheKey, null); |
|
| 90 | + } |
|
| 91 | + } |
|
| 92 | + return $result; |
|
| 93 | + } |
|
| 94 | + } |
|
| 95 | + return false; |
|
| 96 | + } |
|
| 97 | + |
|
| 98 | + /** |
|
| 99 | + * is user in group? |
|
| 100 | + * @param string $uid uid of the user |
|
| 101 | + * @param string $gid gid of the group |
|
| 102 | + * @return bool |
|
| 103 | + * |
|
| 104 | + * Checks whether the user is member of a group or not. |
|
| 105 | + */ |
|
| 106 | + public function inGroup($uid, $gid) { |
|
| 107 | + return $this->handleRequest($gid, 'inGroup', array($uid, $gid)); |
|
| 108 | + } |
|
| 109 | + |
|
| 110 | + /** |
|
| 111 | + * Get all groups a user belongs to |
|
| 112 | + * @param string $uid Name of the user |
|
| 113 | + * @return string[] with group names |
|
| 114 | + * |
|
| 115 | + * This function fetches all groups a user belongs to. It does not check |
|
| 116 | + * if the user exists at all. |
|
| 117 | + */ |
|
| 118 | + public function getUserGroups($uid) { |
|
| 119 | + $groups = array(); |
|
| 120 | + |
|
| 121 | + foreach($this->backends as $backend) { |
|
| 122 | + $backendGroups = $backend->getUserGroups($uid); |
|
| 123 | + if (is_array($backendGroups)) { |
|
| 124 | + $groups = array_merge($groups, $backendGroups); |
|
| 125 | + } |
|
| 126 | + } |
|
| 127 | + |
|
| 128 | + return $groups; |
|
| 129 | + } |
|
| 130 | + |
|
| 131 | + /** |
|
| 132 | + * get a list of all users in a group |
|
| 133 | + * @return string[] with user ids |
|
| 134 | + */ |
|
| 135 | + public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0) { |
|
| 136 | + $users = array(); |
|
| 137 | + |
|
| 138 | + foreach($this->backends as $backend) { |
|
| 139 | + $backendUsers = $backend->usersInGroup($gid, $search, $limit, $offset); |
|
| 140 | + if (is_array($backendUsers)) { |
|
| 141 | + $users = array_merge($users, $backendUsers); |
|
| 142 | + } |
|
| 143 | + } |
|
| 144 | + |
|
| 145 | + return $users; |
|
| 146 | + } |
|
| 147 | + |
|
| 148 | + /** |
|
| 149 | + * returns the number of users in a group, who match the search term |
|
| 150 | + * @param string $gid the internal group name |
|
| 151 | + * @param string $search optional, a search string |
|
| 152 | + * @return int|bool |
|
| 153 | + */ |
|
| 154 | + public function countUsersInGroup($gid, $search = '') { |
|
| 155 | + return $this->handleRequest( |
|
| 156 | + $gid, 'countUsersInGroup', array($gid, $search)); |
|
| 157 | + } |
|
| 158 | + |
|
| 159 | + /** |
|
| 160 | + * get a list of all groups |
|
| 161 | + * @return string[] with group names |
|
| 162 | + * |
|
| 163 | + * Returns a list with all groups |
|
| 164 | + */ |
|
| 165 | + public function getGroups($search = '', $limit = -1, $offset = 0) { |
|
| 166 | + $groups = array(); |
|
| 167 | + |
|
| 168 | + foreach($this->backends as $backend) { |
|
| 169 | + $backendGroups = $backend->getGroups($search, $limit, $offset); |
|
| 170 | + if (is_array($backendGroups)) { |
|
| 171 | + $groups = array_merge($groups, $backendGroups); |
|
| 172 | + } |
|
| 173 | + } |
|
| 174 | + |
|
| 175 | + return $groups; |
|
| 176 | + } |
|
| 177 | + |
|
| 178 | + /** |
|
| 179 | + * check if a group exists |
|
| 180 | + * @param string $gid |
|
| 181 | + * @return bool |
|
| 182 | + */ |
|
| 183 | + public function groupExists($gid) { |
|
| 184 | + return $this->handleRequest($gid, 'groupExists', array($gid)); |
|
| 185 | + } |
|
| 186 | + |
|
| 187 | + /** |
|
| 188 | + * Check if backend implements actions |
|
| 189 | + * @param int $actions bitwise-or'ed actions |
|
| 190 | + * @return boolean |
|
| 191 | + * |
|
| 192 | + * Returns the supported actions as int to be |
|
| 193 | + * compared with OC_USER_BACKEND_CREATE_USER etc. |
|
| 194 | + */ |
|
| 195 | + public function implementsActions($actions) { |
|
| 196 | + //it's the same across all our user backends obviously |
|
| 197 | + return $this->refBackend->implementsActions($actions); |
|
| 198 | + } |
|
| 199 | + |
|
| 200 | + /** |
|
| 201 | + * Return access for LDAP interaction. |
|
| 202 | + * @param string $gid |
|
| 203 | + * @return Access instance of Access for LDAP interaction |
|
| 204 | + */ |
|
| 205 | + public function getLDAPAccess($gid) { |
|
| 206 | + return $this->handleRequest($gid, 'getLDAPAccess', []); |
|
| 207 | + } |
|
| 208 | 208 | } |
@@ -36,10 +36,10 @@ discard block |
||
| 36 | 36 | */ |
| 37 | 37 | public function __construct($serverConfigPrefixes, ILDAPWrapper $ldap) { |
| 38 | 38 | parent::__construct($ldap); |
| 39 | - foreach($serverConfigPrefixes as $configPrefix) { |
|
| 39 | + foreach ($serverConfigPrefixes as $configPrefix) { |
|
| 40 | 40 | $this->backends[$configPrefix] = |
| 41 | 41 | new \OCA\User_LDAP\Group_LDAP($this->getAccess($configPrefix)); |
| 42 | - if(is_null($this->refBackend)) { |
|
| 42 | + if (is_null($this->refBackend)) { |
|
| 43 | 43 | $this->refBackend = &$this->backends[$configPrefix]; |
| 44 | 44 | } |
| 45 | 45 | } |
@@ -54,8 +54,8 @@ discard block |
||
| 54 | 54 | */ |
| 55 | 55 | protected function walkBackends($gid, $method, $parameters) { |
| 56 | 56 | $cacheKey = $this->getGroupCacheKey($gid); |
| 57 | - foreach($this->backends as $configPrefix => $backend) { |
|
| 58 | - if($result = call_user_func_array(array($backend, $method), $parameters)) { |
|
| 57 | + foreach ($this->backends as $configPrefix => $backend) { |
|
| 58 | + if ($result = call_user_func_array(array($backend, $method), $parameters)) { |
|
| 59 | 59 | $this->writeToCache($cacheKey, $configPrefix); |
| 60 | 60 | return $result; |
| 61 | 61 | } |
@@ -72,20 +72,20 @@ discard block |
||
| 72 | 72 | * @return mixed, the result of the method or false |
| 73 | 73 | */ |
| 74 | 74 | protected function callOnLastSeenOn($gid, $method, $parameters, $passOnWhen) { |
| 75 | - $cacheKey = $this->getGroupCacheKey($gid);; |
|
| 75 | + $cacheKey = $this->getGroupCacheKey($gid); ; |
|
| 76 | 76 | $prefix = $this->getFromCache($cacheKey); |
| 77 | 77 | //in case the uid has been found in the past, try this stored connection first |
| 78 | - if(!is_null($prefix)) { |
|
| 79 | - if(isset($this->backends[$prefix])) { |
|
| 78 | + if (!is_null($prefix)) { |
|
| 79 | + if (isset($this->backends[$prefix])) { |
|
| 80 | 80 | $result = call_user_func_array(array($this->backends[$prefix], $method), $parameters); |
| 81 | - if($result === $passOnWhen) { |
|
| 81 | + if ($result === $passOnWhen) { |
|
| 82 | 82 | //not found here, reset cache to null if group vanished |
| 83 | 83 | //because sometimes methods return false with a reason |
| 84 | 84 | $groupExists = call_user_func_array( |
| 85 | 85 | array($this->backends[$prefix], 'groupExists'), |
| 86 | 86 | array($gid) |
| 87 | 87 | ); |
| 88 | - if(!$groupExists) { |
|
| 88 | + if (!$groupExists) { |
|
| 89 | 89 | $this->writeToCache($cacheKey, null); |
| 90 | 90 | } |
| 91 | 91 | } |
@@ -118,7 +118,7 @@ discard block |
||
| 118 | 118 | public function getUserGroups($uid) { |
| 119 | 119 | $groups = array(); |
| 120 | 120 | |
| 121 | - foreach($this->backends as $backend) { |
|
| 121 | + foreach ($this->backends as $backend) { |
|
| 122 | 122 | $backendGroups = $backend->getUserGroups($uid); |
| 123 | 123 | if (is_array($backendGroups)) { |
| 124 | 124 | $groups = array_merge($groups, $backendGroups); |
@@ -135,7 +135,7 @@ discard block |
||
| 135 | 135 | public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0) { |
| 136 | 136 | $users = array(); |
| 137 | 137 | |
| 138 | - foreach($this->backends as $backend) { |
|
| 138 | + foreach ($this->backends as $backend) { |
|
| 139 | 139 | $backendUsers = $backend->usersInGroup($gid, $search, $limit, $offset); |
| 140 | 140 | if (is_array($backendUsers)) { |
| 141 | 141 | $users = array_merge($users, $backendUsers); |
@@ -165,7 +165,7 @@ discard block |
||
| 165 | 165 | public function getGroups($search = '', $limit = -1, $offset = 0) { |
| 166 | 166 | $groups = array(); |
| 167 | 167 | |
| 168 | - foreach($this->backends as $backend) { |
|
| 168 | + foreach ($this->backends as $backend) { |
|
| 169 | 169 | $backendGroups = $backend->getGroups($search, $limit, $offset); |
| 170 | 170 | if (is_array($backendGroups)) { |
| 171 | 171 | $groups = array_merge($groups, $backendGroups); |
@@ -33,341 +33,341 @@ |
||
| 33 | 33 | use OCA\User_LDAP\Exceptions\ConstraintViolationException; |
| 34 | 34 | |
| 35 | 35 | class LDAP implements ILDAPWrapper { |
| 36 | - protected $curFunc = ''; |
|
| 37 | - protected $curArgs = array(); |
|
| 38 | - |
|
| 39 | - /** |
|
| 40 | - * @param resource $link |
|
| 41 | - * @param string $dn |
|
| 42 | - * @param string $password |
|
| 43 | - * @return bool|mixed |
|
| 44 | - */ |
|
| 45 | - public function bind($link, $dn, $password) { |
|
| 46 | - return $this->invokeLDAPMethod('bind', $link, $dn, $password); |
|
| 47 | - } |
|
| 48 | - |
|
| 49 | - /** |
|
| 50 | - * @param string $host |
|
| 51 | - * @param string $port |
|
| 52 | - * @return mixed |
|
| 53 | - */ |
|
| 54 | - public function connect($host, $port) { |
|
| 55 | - if(strpos($host, '://') === false) { |
|
| 56 | - $host = 'ldap://' . $host; |
|
| 57 | - } |
|
| 58 | - if(strpos($host, ':', strpos($host, '://') + 1) === false) { |
|
| 59 | - //ldap_connect ignores port parameter when URLs are passed |
|
| 60 | - $host .= ':' . $port; |
|
| 61 | - } |
|
| 62 | - return $this->invokeLDAPMethod('connect', $host); |
|
| 63 | - } |
|
| 64 | - |
|
| 65 | - /** |
|
| 66 | - * @param LDAP $link |
|
| 67 | - * @param LDAP $result |
|
| 68 | - * @param string $cookie |
|
| 69 | - * @return bool|LDAP |
|
| 70 | - */ |
|
| 71 | - public function controlPagedResultResponse($link, $result, &$cookie) { |
|
| 72 | - $this->preFunctionCall('ldap_control_paged_result_response', |
|
| 73 | - array($link, $result, $cookie)); |
|
| 74 | - $result = ldap_control_paged_result_response($link, $result, $cookie); |
|
| 75 | - $this->postFunctionCall(); |
|
| 76 | - |
|
| 77 | - return $result; |
|
| 78 | - } |
|
| 79 | - |
|
| 80 | - /** |
|
| 81 | - * @param LDAP $link |
|
| 82 | - * @param int $pageSize |
|
| 83 | - * @param bool $isCritical |
|
| 84 | - * @param string $cookie |
|
| 85 | - * @return mixed|true |
|
| 86 | - */ |
|
| 87 | - public function controlPagedResult($link, $pageSize, $isCritical, $cookie) { |
|
| 88 | - return $this->invokeLDAPMethod('control_paged_result', $link, $pageSize, |
|
| 89 | - $isCritical, $cookie); |
|
| 90 | - } |
|
| 91 | - |
|
| 92 | - /** |
|
| 93 | - * @param LDAP $link |
|
| 94 | - * @param LDAP $result |
|
| 95 | - * @return mixed |
|
| 96 | - */ |
|
| 97 | - public function countEntries($link, $result) { |
|
| 98 | - return $this->invokeLDAPMethod('count_entries', $link, $result); |
|
| 99 | - } |
|
| 100 | - |
|
| 101 | - /** |
|
| 102 | - * @param LDAP $link |
|
| 103 | - * @return mixed|string |
|
| 104 | - */ |
|
| 105 | - public function errno($link) { |
|
| 106 | - return $this->invokeLDAPMethod('errno', $link); |
|
| 107 | - } |
|
| 108 | - |
|
| 109 | - /** |
|
| 110 | - * @param LDAP $link |
|
| 111 | - * @return int|mixed |
|
| 112 | - */ |
|
| 113 | - public function error($link) { |
|
| 114 | - return $this->invokeLDAPMethod('error', $link); |
|
| 115 | - } |
|
| 116 | - |
|
| 117 | - /** |
|
| 118 | - * Splits DN into its component parts |
|
| 119 | - * @param string $dn |
|
| 120 | - * @param int @withAttrib |
|
| 121 | - * @return array|false |
|
| 122 | - * @link http://www.php.net/manual/en/function.ldap-explode-dn.php |
|
| 123 | - */ |
|
| 124 | - public function explodeDN($dn, $withAttrib) { |
|
| 125 | - return $this->invokeLDAPMethod('explode_dn', $dn, $withAttrib); |
|
| 126 | - } |
|
| 127 | - |
|
| 128 | - /** |
|
| 129 | - * @param LDAP $link |
|
| 130 | - * @param LDAP $result |
|
| 131 | - * @return mixed |
|
| 132 | - */ |
|
| 133 | - public function firstEntry($link, $result) { |
|
| 134 | - return $this->invokeLDAPMethod('first_entry', $link, $result); |
|
| 135 | - } |
|
| 136 | - |
|
| 137 | - /** |
|
| 138 | - * @param LDAP $link |
|
| 139 | - * @param LDAP $result |
|
| 140 | - * @return array|mixed |
|
| 141 | - */ |
|
| 142 | - public function getAttributes($link, $result) { |
|
| 143 | - return $this->invokeLDAPMethod('get_attributes', $link, $result); |
|
| 144 | - } |
|
| 145 | - |
|
| 146 | - /** |
|
| 147 | - * @param LDAP $link |
|
| 148 | - * @param LDAP $result |
|
| 149 | - * @return mixed|string |
|
| 150 | - */ |
|
| 151 | - public function getDN($link, $result) { |
|
| 152 | - return $this->invokeLDAPMethod('get_dn', $link, $result); |
|
| 153 | - } |
|
| 154 | - |
|
| 155 | - /** |
|
| 156 | - * @param LDAP $link |
|
| 157 | - * @param LDAP $result |
|
| 158 | - * @return array|mixed |
|
| 159 | - */ |
|
| 160 | - public function getEntries($link, $result) { |
|
| 161 | - return $this->invokeLDAPMethod('get_entries', $link, $result); |
|
| 162 | - } |
|
| 163 | - |
|
| 164 | - /** |
|
| 165 | - * @param LDAP $link |
|
| 166 | - * @param resource $result |
|
| 167 | - * @return mixed |
|
| 168 | - */ |
|
| 169 | - public function nextEntry($link, $result) { |
|
| 170 | - return $this->invokeLDAPMethod('next_entry', $link, $result); |
|
| 171 | - } |
|
| 172 | - |
|
| 173 | - /** |
|
| 174 | - * @param LDAP $link |
|
| 175 | - * @param string $baseDN |
|
| 176 | - * @param string $filter |
|
| 177 | - * @param array $attr |
|
| 178 | - * @return mixed |
|
| 179 | - */ |
|
| 180 | - public function read($link, $baseDN, $filter, $attr) { |
|
| 181 | - return $this->invokeLDAPMethod('read', $link, $baseDN, $filter, $attr); |
|
| 182 | - } |
|
| 183 | - |
|
| 184 | - /** |
|
| 185 | - * @param LDAP $link |
|
| 186 | - * @param string $baseDN |
|
| 187 | - * @param string $filter |
|
| 188 | - * @param array $attr |
|
| 189 | - * @param int $attrsOnly |
|
| 190 | - * @param int $limit |
|
| 191 | - * @return mixed |
|
| 192 | - */ |
|
| 193 | - public function search($link, $baseDN, $filter, $attr, $attrsOnly = 0, $limit = 0) { |
|
| 194 | - return $this->invokeLDAPMethod('search', $link, $baseDN, $filter, $attr, $attrsOnly, $limit); |
|
| 195 | - } |
|
| 196 | - |
|
| 197 | - /** |
|
| 198 | - * @param LDAP $link |
|
| 199 | - * @param string $userDN |
|
| 200 | - * @param string $password |
|
| 201 | - * @return bool |
|
| 202 | - */ |
|
| 203 | - public function modReplace($link, $userDN, $password) { |
|
| 204 | - return $this->invokeLDAPMethod('mod_replace', $link, $userDN, array('userPassword' => $password)); |
|
| 205 | - } |
|
| 206 | - |
|
| 207 | - /** |
|
| 208 | - * @param LDAP $link |
|
| 209 | - * @param string $option |
|
| 210 | - * @param int $value |
|
| 211 | - * @return bool|mixed |
|
| 212 | - */ |
|
| 213 | - public function setOption($link, $option, $value) { |
|
| 214 | - return $this->invokeLDAPMethod('set_option', $link, $option, $value); |
|
| 215 | - } |
|
| 216 | - |
|
| 217 | - /** |
|
| 218 | - * @param LDAP $link |
|
| 219 | - * @return mixed|true |
|
| 220 | - */ |
|
| 221 | - public function startTls($link) { |
|
| 222 | - return $this->invokeLDAPMethod('start_tls', $link); |
|
| 223 | - } |
|
| 224 | - |
|
| 225 | - /** |
|
| 226 | - * @param resource $link |
|
| 227 | - * @return bool|mixed |
|
| 228 | - */ |
|
| 229 | - public function unbind($link) { |
|
| 230 | - return $this->invokeLDAPMethod('unbind', $link); |
|
| 231 | - } |
|
| 232 | - |
|
| 233 | - /** |
|
| 234 | - * Checks whether the server supports LDAP |
|
| 235 | - * @return boolean if it the case, false otherwise |
|
| 236 | - * */ |
|
| 237 | - public function areLDAPFunctionsAvailable() { |
|
| 238 | - return function_exists('ldap_connect'); |
|
| 239 | - } |
|
| 240 | - |
|
| 241 | - /** |
|
| 242 | - * Checks whether PHP supports LDAP Paged Results |
|
| 243 | - * @return boolean if it the case, false otherwise |
|
| 244 | - * */ |
|
| 245 | - public function hasPagedResultSupport() { |
|
| 246 | - $hasSupport = function_exists('ldap_control_paged_result') |
|
| 247 | - && function_exists('ldap_control_paged_result_response'); |
|
| 248 | - return $hasSupport; |
|
| 249 | - } |
|
| 250 | - |
|
| 251 | - /** |
|
| 252 | - * Checks whether the submitted parameter is a resource |
|
| 253 | - * @param Resource $resource the resource variable to check |
|
| 254 | - * @return bool true if it is a resource, false otherwise |
|
| 255 | - */ |
|
| 256 | - public function isResource($resource) { |
|
| 257 | - return is_resource($resource); |
|
| 258 | - } |
|
| 259 | - |
|
| 260 | - /** |
|
| 261 | - * Checks whether the return value from LDAP is wrong or not. |
|
| 262 | - * |
|
| 263 | - * When using ldap_search we provide an array, in case multiple bases are |
|
| 264 | - * configured. Thus, we need to check the array elements. |
|
| 265 | - * |
|
| 266 | - * @param $result |
|
| 267 | - * @return bool |
|
| 268 | - */ |
|
| 269 | - protected function isResultFalse($result) { |
|
| 270 | - if($result === false) { |
|
| 271 | - return true; |
|
| 272 | - } |
|
| 273 | - |
|
| 274 | - if($this->curFunc === 'ldap_search' && is_array($result)) { |
|
| 275 | - foreach ($result as $singleResult) { |
|
| 276 | - if($singleResult === false) { |
|
| 277 | - return true; |
|
| 278 | - } |
|
| 279 | - } |
|
| 280 | - } |
|
| 281 | - |
|
| 282 | - return false; |
|
| 283 | - } |
|
| 284 | - |
|
| 285 | - /** |
|
| 286 | - * @return mixed |
|
| 287 | - */ |
|
| 288 | - protected function invokeLDAPMethod() { |
|
| 289 | - $arguments = func_get_args(); |
|
| 290 | - $func = 'ldap_' . array_shift($arguments); |
|
| 291 | - if(function_exists($func)) { |
|
| 292 | - $this->preFunctionCall($func, $arguments); |
|
| 293 | - $result = call_user_func_array($func, $arguments); |
|
| 294 | - if ($this->isResultFalse($result)) { |
|
| 295 | - $this->postFunctionCall(); |
|
| 296 | - } |
|
| 297 | - return $result; |
|
| 298 | - } |
|
| 299 | - return null; |
|
| 300 | - } |
|
| 301 | - |
|
| 302 | - /** |
|
| 303 | - * @param string $functionName |
|
| 304 | - * @param array $args |
|
| 305 | - */ |
|
| 306 | - private function preFunctionCall($functionName, $args) { |
|
| 307 | - $this->curFunc = $functionName; |
|
| 308 | - $this->curArgs = $args; |
|
| 309 | - } |
|
| 310 | - |
|
| 311 | - /** |
|
| 312 | - * Analyzes the returned LDAP error and acts accordingly if not 0 |
|
| 313 | - * |
|
| 314 | - * @param resource $resource the LDAP Connection resource |
|
| 315 | - * @throws ConstraintViolationException |
|
| 316 | - * @throws ServerNotAvailableException |
|
| 317 | - * @throws \Exception |
|
| 318 | - */ |
|
| 319 | - private function processLDAPError($resource) { |
|
| 320 | - $errorCode = ldap_errno($resource); |
|
| 321 | - if($errorCode === 0) { |
|
| 322 | - return; |
|
| 323 | - } |
|
| 324 | - $errorMsg = ldap_error($resource); |
|
| 325 | - |
|
| 326 | - if($this->curFunc === 'ldap_get_entries' |
|
| 327 | - && $errorCode === -4) { |
|
| 328 | - } else if ($errorCode === 32) { |
|
| 329 | - //for now |
|
| 330 | - } else if ($errorCode === 10) { |
|
| 331 | - //referrals, we switch them off, but then there is AD :) |
|
| 332 | - } else if ($errorCode === -1) { |
|
| 333 | - throw new ServerNotAvailableException('Lost connection to LDAP server.'); |
|
| 334 | - } else if ($errorCode === 48) { |
|
| 335 | - throw new \Exception('LDAP authentication method rejected', $errorCode); |
|
| 336 | - } else if ($errorCode === 1) { |
|
| 337 | - throw new \Exception('LDAP Operations error', $errorCode); |
|
| 338 | - } else if ($errorCode === 19) { |
|
| 339 | - ldap_get_option($this->curArgs[0], LDAP_OPT_ERROR_STRING, $extended_error); |
|
| 340 | - throw new ConstraintViolationException(!empty($extended_error)?$extended_error:$errorMsg, $errorCode); |
|
| 341 | - } else { |
|
| 342 | - \OCP\Util::writeLog('user_ldap', |
|
| 343 | - 'LDAP error '.$errorMsg.' (' . |
|
| 344 | - $errorCode.') after calling '. |
|
| 345 | - $this->curFunc, |
|
| 346 | - \OCP\Util::DEBUG); |
|
| 347 | - } |
|
| 348 | - } |
|
| 349 | - |
|
| 350 | - /** |
|
| 351 | - * Called after an ldap method is run to act on LDAP error if necessary |
|
| 352 | - */ |
|
| 353 | - private function postFunctionCall() { |
|
| 354 | - if($this->isResource($this->curArgs[0])) { |
|
| 355 | - $resource = $this->curArgs[0]; |
|
| 356 | - } else if( |
|
| 357 | - $this->curFunc === 'ldap_search' |
|
| 358 | - && is_array($this->curArgs[0]) |
|
| 359 | - && $this->isResource($this->curArgs[0][0]) |
|
| 360 | - ) { |
|
| 361 | - // we use always the same LDAP connection resource, is enough to |
|
| 362 | - // take the first one. |
|
| 363 | - $resource = $this->curArgs[0][0]; |
|
| 364 | - } else { |
|
| 365 | - return; |
|
| 366 | - } |
|
| 367 | - |
|
| 368 | - $this->processLDAPError($resource); |
|
| 369 | - |
|
| 370 | - $this->curFunc = ''; |
|
| 371 | - $this->curArgs = []; |
|
| 372 | - } |
|
| 36 | + protected $curFunc = ''; |
|
| 37 | + protected $curArgs = array(); |
|
| 38 | + |
|
| 39 | + /** |
|
| 40 | + * @param resource $link |
|
| 41 | + * @param string $dn |
|
| 42 | + * @param string $password |
|
| 43 | + * @return bool|mixed |
|
| 44 | + */ |
|
| 45 | + public function bind($link, $dn, $password) { |
|
| 46 | + return $this->invokeLDAPMethod('bind', $link, $dn, $password); |
|
| 47 | + } |
|
| 48 | + |
|
| 49 | + /** |
|
| 50 | + * @param string $host |
|
| 51 | + * @param string $port |
|
| 52 | + * @return mixed |
|
| 53 | + */ |
|
| 54 | + public function connect($host, $port) { |
|
| 55 | + if(strpos($host, '://') === false) { |
|
| 56 | + $host = 'ldap://' . $host; |
|
| 57 | + } |
|
| 58 | + if(strpos($host, ':', strpos($host, '://') + 1) === false) { |
|
| 59 | + //ldap_connect ignores port parameter when URLs are passed |
|
| 60 | + $host .= ':' . $port; |
|
| 61 | + } |
|
| 62 | + return $this->invokeLDAPMethod('connect', $host); |
|
| 63 | + } |
|
| 64 | + |
|
| 65 | + /** |
|
| 66 | + * @param LDAP $link |
|
| 67 | + * @param LDAP $result |
|
| 68 | + * @param string $cookie |
|
| 69 | + * @return bool|LDAP |
|
| 70 | + */ |
|
| 71 | + public function controlPagedResultResponse($link, $result, &$cookie) { |
|
| 72 | + $this->preFunctionCall('ldap_control_paged_result_response', |
|
| 73 | + array($link, $result, $cookie)); |
|
| 74 | + $result = ldap_control_paged_result_response($link, $result, $cookie); |
|
| 75 | + $this->postFunctionCall(); |
|
| 76 | + |
|
| 77 | + return $result; |
|
| 78 | + } |
|
| 79 | + |
|
| 80 | + /** |
|
| 81 | + * @param LDAP $link |
|
| 82 | + * @param int $pageSize |
|
| 83 | + * @param bool $isCritical |
|
| 84 | + * @param string $cookie |
|
| 85 | + * @return mixed|true |
|
| 86 | + */ |
|
| 87 | + public function controlPagedResult($link, $pageSize, $isCritical, $cookie) { |
|
| 88 | + return $this->invokeLDAPMethod('control_paged_result', $link, $pageSize, |
|
| 89 | + $isCritical, $cookie); |
|
| 90 | + } |
|
| 91 | + |
|
| 92 | + /** |
|
| 93 | + * @param LDAP $link |
|
| 94 | + * @param LDAP $result |
|
| 95 | + * @return mixed |
|
| 96 | + */ |
|
| 97 | + public function countEntries($link, $result) { |
|
| 98 | + return $this->invokeLDAPMethod('count_entries', $link, $result); |
|
| 99 | + } |
|
| 100 | + |
|
| 101 | + /** |
|
| 102 | + * @param LDAP $link |
|
| 103 | + * @return mixed|string |
|
| 104 | + */ |
|
| 105 | + public function errno($link) { |
|
| 106 | + return $this->invokeLDAPMethod('errno', $link); |
|
| 107 | + } |
|
| 108 | + |
|
| 109 | + /** |
|
| 110 | + * @param LDAP $link |
|
| 111 | + * @return int|mixed |
|
| 112 | + */ |
|
| 113 | + public function error($link) { |
|
| 114 | + return $this->invokeLDAPMethod('error', $link); |
|
| 115 | + } |
|
| 116 | + |
|
| 117 | + /** |
|
| 118 | + * Splits DN into its component parts |
|
| 119 | + * @param string $dn |
|
| 120 | + * @param int @withAttrib |
|
| 121 | + * @return array|false |
|
| 122 | + * @link http://www.php.net/manual/en/function.ldap-explode-dn.php |
|
| 123 | + */ |
|
| 124 | + public function explodeDN($dn, $withAttrib) { |
|
| 125 | + return $this->invokeLDAPMethod('explode_dn', $dn, $withAttrib); |
|
| 126 | + } |
|
| 127 | + |
|
| 128 | + /** |
|
| 129 | + * @param LDAP $link |
|
| 130 | + * @param LDAP $result |
|
| 131 | + * @return mixed |
|
| 132 | + */ |
|
| 133 | + public function firstEntry($link, $result) { |
|
| 134 | + return $this->invokeLDAPMethod('first_entry', $link, $result); |
|
| 135 | + } |
|
| 136 | + |
|
| 137 | + /** |
|
| 138 | + * @param LDAP $link |
|
| 139 | + * @param LDAP $result |
|
| 140 | + * @return array|mixed |
|
| 141 | + */ |
|
| 142 | + public function getAttributes($link, $result) { |
|
| 143 | + return $this->invokeLDAPMethod('get_attributes', $link, $result); |
|
| 144 | + } |
|
| 145 | + |
|
| 146 | + /** |
|
| 147 | + * @param LDAP $link |
|
| 148 | + * @param LDAP $result |
|
| 149 | + * @return mixed|string |
|
| 150 | + */ |
|
| 151 | + public function getDN($link, $result) { |
|
| 152 | + return $this->invokeLDAPMethod('get_dn', $link, $result); |
|
| 153 | + } |
|
| 154 | + |
|
| 155 | + /** |
|
| 156 | + * @param LDAP $link |
|
| 157 | + * @param LDAP $result |
|
| 158 | + * @return array|mixed |
|
| 159 | + */ |
|
| 160 | + public function getEntries($link, $result) { |
|
| 161 | + return $this->invokeLDAPMethod('get_entries', $link, $result); |
|
| 162 | + } |
|
| 163 | + |
|
| 164 | + /** |
|
| 165 | + * @param LDAP $link |
|
| 166 | + * @param resource $result |
|
| 167 | + * @return mixed |
|
| 168 | + */ |
|
| 169 | + public function nextEntry($link, $result) { |
|
| 170 | + return $this->invokeLDAPMethod('next_entry', $link, $result); |
|
| 171 | + } |
|
| 172 | + |
|
| 173 | + /** |
|
| 174 | + * @param LDAP $link |
|
| 175 | + * @param string $baseDN |
|
| 176 | + * @param string $filter |
|
| 177 | + * @param array $attr |
|
| 178 | + * @return mixed |
|
| 179 | + */ |
|
| 180 | + public function read($link, $baseDN, $filter, $attr) { |
|
| 181 | + return $this->invokeLDAPMethod('read', $link, $baseDN, $filter, $attr); |
|
| 182 | + } |
|
| 183 | + |
|
| 184 | + /** |
|
| 185 | + * @param LDAP $link |
|
| 186 | + * @param string $baseDN |
|
| 187 | + * @param string $filter |
|
| 188 | + * @param array $attr |
|
| 189 | + * @param int $attrsOnly |
|
| 190 | + * @param int $limit |
|
| 191 | + * @return mixed |
|
| 192 | + */ |
|
| 193 | + public function search($link, $baseDN, $filter, $attr, $attrsOnly = 0, $limit = 0) { |
|
| 194 | + return $this->invokeLDAPMethod('search', $link, $baseDN, $filter, $attr, $attrsOnly, $limit); |
|
| 195 | + } |
|
| 196 | + |
|
| 197 | + /** |
|
| 198 | + * @param LDAP $link |
|
| 199 | + * @param string $userDN |
|
| 200 | + * @param string $password |
|
| 201 | + * @return bool |
|
| 202 | + */ |
|
| 203 | + public function modReplace($link, $userDN, $password) { |
|
| 204 | + return $this->invokeLDAPMethod('mod_replace', $link, $userDN, array('userPassword' => $password)); |
|
| 205 | + } |
|
| 206 | + |
|
| 207 | + /** |
|
| 208 | + * @param LDAP $link |
|
| 209 | + * @param string $option |
|
| 210 | + * @param int $value |
|
| 211 | + * @return bool|mixed |
|
| 212 | + */ |
|
| 213 | + public function setOption($link, $option, $value) { |
|
| 214 | + return $this->invokeLDAPMethod('set_option', $link, $option, $value); |
|
| 215 | + } |
|
| 216 | + |
|
| 217 | + /** |
|
| 218 | + * @param LDAP $link |
|
| 219 | + * @return mixed|true |
|
| 220 | + */ |
|
| 221 | + public function startTls($link) { |
|
| 222 | + return $this->invokeLDAPMethod('start_tls', $link); |
|
| 223 | + } |
|
| 224 | + |
|
| 225 | + /** |
|
| 226 | + * @param resource $link |
|
| 227 | + * @return bool|mixed |
|
| 228 | + */ |
|
| 229 | + public function unbind($link) { |
|
| 230 | + return $this->invokeLDAPMethod('unbind', $link); |
|
| 231 | + } |
|
| 232 | + |
|
| 233 | + /** |
|
| 234 | + * Checks whether the server supports LDAP |
|
| 235 | + * @return boolean if it the case, false otherwise |
|
| 236 | + * */ |
|
| 237 | + public function areLDAPFunctionsAvailable() { |
|
| 238 | + return function_exists('ldap_connect'); |
|
| 239 | + } |
|
| 240 | + |
|
| 241 | + /** |
|
| 242 | + * Checks whether PHP supports LDAP Paged Results |
|
| 243 | + * @return boolean if it the case, false otherwise |
|
| 244 | + * */ |
|
| 245 | + public function hasPagedResultSupport() { |
|
| 246 | + $hasSupport = function_exists('ldap_control_paged_result') |
|
| 247 | + && function_exists('ldap_control_paged_result_response'); |
|
| 248 | + return $hasSupport; |
|
| 249 | + } |
|
| 250 | + |
|
| 251 | + /** |
|
| 252 | + * Checks whether the submitted parameter is a resource |
|
| 253 | + * @param Resource $resource the resource variable to check |
|
| 254 | + * @return bool true if it is a resource, false otherwise |
|
| 255 | + */ |
|
| 256 | + public function isResource($resource) { |
|
| 257 | + return is_resource($resource); |
|
| 258 | + } |
|
| 259 | + |
|
| 260 | + /** |
|
| 261 | + * Checks whether the return value from LDAP is wrong or not. |
|
| 262 | + * |
|
| 263 | + * When using ldap_search we provide an array, in case multiple bases are |
|
| 264 | + * configured. Thus, we need to check the array elements. |
|
| 265 | + * |
|
| 266 | + * @param $result |
|
| 267 | + * @return bool |
|
| 268 | + */ |
|
| 269 | + protected function isResultFalse($result) { |
|
| 270 | + if($result === false) { |
|
| 271 | + return true; |
|
| 272 | + } |
|
| 273 | + |
|
| 274 | + if($this->curFunc === 'ldap_search' && is_array($result)) { |
|
| 275 | + foreach ($result as $singleResult) { |
|
| 276 | + if($singleResult === false) { |
|
| 277 | + return true; |
|
| 278 | + } |
|
| 279 | + } |
|
| 280 | + } |
|
| 281 | + |
|
| 282 | + return false; |
|
| 283 | + } |
|
| 284 | + |
|
| 285 | + /** |
|
| 286 | + * @return mixed |
|
| 287 | + */ |
|
| 288 | + protected function invokeLDAPMethod() { |
|
| 289 | + $arguments = func_get_args(); |
|
| 290 | + $func = 'ldap_' . array_shift($arguments); |
|
| 291 | + if(function_exists($func)) { |
|
| 292 | + $this->preFunctionCall($func, $arguments); |
|
| 293 | + $result = call_user_func_array($func, $arguments); |
|
| 294 | + if ($this->isResultFalse($result)) { |
|
| 295 | + $this->postFunctionCall(); |
|
| 296 | + } |
|
| 297 | + return $result; |
|
| 298 | + } |
|
| 299 | + return null; |
|
| 300 | + } |
|
| 301 | + |
|
| 302 | + /** |
|
| 303 | + * @param string $functionName |
|
| 304 | + * @param array $args |
|
| 305 | + */ |
|
| 306 | + private function preFunctionCall($functionName, $args) { |
|
| 307 | + $this->curFunc = $functionName; |
|
| 308 | + $this->curArgs = $args; |
|
| 309 | + } |
|
| 310 | + |
|
| 311 | + /** |
|
| 312 | + * Analyzes the returned LDAP error and acts accordingly if not 0 |
|
| 313 | + * |
|
| 314 | + * @param resource $resource the LDAP Connection resource |
|
| 315 | + * @throws ConstraintViolationException |
|
| 316 | + * @throws ServerNotAvailableException |
|
| 317 | + * @throws \Exception |
|
| 318 | + */ |
|
| 319 | + private function processLDAPError($resource) { |
|
| 320 | + $errorCode = ldap_errno($resource); |
|
| 321 | + if($errorCode === 0) { |
|
| 322 | + return; |
|
| 323 | + } |
|
| 324 | + $errorMsg = ldap_error($resource); |
|
| 325 | + |
|
| 326 | + if($this->curFunc === 'ldap_get_entries' |
|
| 327 | + && $errorCode === -4) { |
|
| 328 | + } else if ($errorCode === 32) { |
|
| 329 | + //for now |
|
| 330 | + } else if ($errorCode === 10) { |
|
| 331 | + //referrals, we switch them off, but then there is AD :) |
|
| 332 | + } else if ($errorCode === -1) { |
|
| 333 | + throw new ServerNotAvailableException('Lost connection to LDAP server.'); |
|
| 334 | + } else if ($errorCode === 48) { |
|
| 335 | + throw new \Exception('LDAP authentication method rejected', $errorCode); |
|
| 336 | + } else if ($errorCode === 1) { |
|
| 337 | + throw new \Exception('LDAP Operations error', $errorCode); |
|
| 338 | + } else if ($errorCode === 19) { |
|
| 339 | + ldap_get_option($this->curArgs[0], LDAP_OPT_ERROR_STRING, $extended_error); |
|
| 340 | + throw new ConstraintViolationException(!empty($extended_error)?$extended_error:$errorMsg, $errorCode); |
|
| 341 | + } else { |
|
| 342 | + \OCP\Util::writeLog('user_ldap', |
|
| 343 | + 'LDAP error '.$errorMsg.' (' . |
|
| 344 | + $errorCode.') after calling '. |
|
| 345 | + $this->curFunc, |
|
| 346 | + \OCP\Util::DEBUG); |
|
| 347 | + } |
|
| 348 | + } |
|
| 349 | + |
|
| 350 | + /** |
|
| 351 | + * Called after an ldap method is run to act on LDAP error if necessary |
|
| 352 | + */ |
|
| 353 | + private function postFunctionCall() { |
|
| 354 | + if($this->isResource($this->curArgs[0])) { |
|
| 355 | + $resource = $this->curArgs[0]; |
|
| 356 | + } else if( |
|
| 357 | + $this->curFunc === 'ldap_search' |
|
| 358 | + && is_array($this->curArgs[0]) |
|
| 359 | + && $this->isResource($this->curArgs[0][0]) |
|
| 360 | + ) { |
|
| 361 | + // we use always the same LDAP connection resource, is enough to |
|
| 362 | + // take the first one. |
|
| 363 | + $resource = $this->curArgs[0][0]; |
|
| 364 | + } else { |
|
| 365 | + return; |
|
| 366 | + } |
|
| 367 | + |
|
| 368 | + $this->processLDAPError($resource); |
|
| 369 | + |
|
| 370 | + $this->curFunc = ''; |
|
| 371 | + $this->curArgs = []; |
|
| 372 | + } |
|
| 373 | 373 | } |
@@ -52,12 +52,12 @@ discard block |
||
| 52 | 52 | * @return mixed |
| 53 | 53 | */ |
| 54 | 54 | public function connect($host, $port) { |
| 55 | - if(strpos($host, '://') === false) { |
|
| 56 | - $host = 'ldap://' . $host; |
|
| 55 | + if (strpos($host, '://') === false) { |
|
| 56 | + $host = 'ldap://'.$host; |
|
| 57 | 57 | } |
| 58 | - if(strpos($host, ':', strpos($host, '://') + 1) === false) { |
|
| 58 | + if (strpos($host, ':', strpos($host, '://') + 1) === false) { |
|
| 59 | 59 | //ldap_connect ignores port parameter when URLs are passed |
| 60 | - $host .= ':' . $port; |
|
| 60 | + $host .= ':'.$port; |
|
| 61 | 61 | } |
| 62 | 62 | return $this->invokeLDAPMethod('connect', $host); |
| 63 | 63 | } |
@@ -267,13 +267,13 @@ discard block |
||
| 267 | 267 | * @return bool |
| 268 | 268 | */ |
| 269 | 269 | protected function isResultFalse($result) { |
| 270 | - if($result === false) { |
|
| 270 | + if ($result === false) { |
|
| 271 | 271 | return true; |
| 272 | 272 | } |
| 273 | 273 | |
| 274 | - if($this->curFunc === 'ldap_search' && is_array($result)) { |
|
| 274 | + if ($this->curFunc === 'ldap_search' && is_array($result)) { |
|
| 275 | 275 | foreach ($result as $singleResult) { |
| 276 | - if($singleResult === false) { |
|
| 276 | + if ($singleResult === false) { |
|
| 277 | 277 | return true; |
| 278 | 278 | } |
| 279 | 279 | } |
@@ -287,8 +287,8 @@ discard block |
||
| 287 | 287 | */ |
| 288 | 288 | protected function invokeLDAPMethod() { |
| 289 | 289 | $arguments = func_get_args(); |
| 290 | - $func = 'ldap_' . array_shift($arguments); |
|
| 291 | - if(function_exists($func)) { |
|
| 290 | + $func = 'ldap_'.array_shift($arguments); |
|
| 291 | + if (function_exists($func)) { |
|
| 292 | 292 | $this->preFunctionCall($func, $arguments); |
| 293 | 293 | $result = call_user_func_array($func, $arguments); |
| 294 | 294 | if ($this->isResultFalse($result)) { |
@@ -318,12 +318,12 @@ discard block |
||
| 318 | 318 | */ |
| 319 | 319 | private function processLDAPError($resource) { |
| 320 | 320 | $errorCode = ldap_errno($resource); |
| 321 | - if($errorCode === 0) { |
|
| 321 | + if ($errorCode === 0) { |
|
| 322 | 322 | return; |
| 323 | 323 | } |
| 324 | - $errorMsg = ldap_error($resource); |
|
| 324 | + $errorMsg = ldap_error($resource); |
|
| 325 | 325 | |
| 326 | - if($this->curFunc === 'ldap_get_entries' |
|
| 326 | + if ($this->curFunc === 'ldap_get_entries' |
|
| 327 | 327 | && $errorCode === -4) { |
| 328 | 328 | } else if ($errorCode === 32) { |
| 329 | 329 | //for now |
@@ -337,10 +337,10 @@ discard block |
||
| 337 | 337 | throw new \Exception('LDAP Operations error', $errorCode); |
| 338 | 338 | } else if ($errorCode === 19) { |
| 339 | 339 | ldap_get_option($this->curArgs[0], LDAP_OPT_ERROR_STRING, $extended_error); |
| 340 | - throw new ConstraintViolationException(!empty($extended_error)?$extended_error:$errorMsg, $errorCode); |
|
| 340 | + throw new ConstraintViolationException(!empty($extended_error) ? $extended_error : $errorMsg, $errorCode); |
|
| 341 | 341 | } else { |
| 342 | 342 | \OCP\Util::writeLog('user_ldap', |
| 343 | - 'LDAP error '.$errorMsg.' (' . |
|
| 343 | + 'LDAP error '.$errorMsg.' ('. |
|
| 344 | 344 | $errorCode.') after calling '. |
| 345 | 345 | $this->curFunc, |
| 346 | 346 | \OCP\Util::DEBUG); |
@@ -351,9 +351,9 @@ discard block |
||
| 351 | 351 | * Called after an ldap method is run to act on LDAP error if necessary |
| 352 | 352 | */ |
| 353 | 353 | private function postFunctionCall() { |
| 354 | - if($this->isResource($this->curArgs[0])) { |
|
| 354 | + if ($this->isResource($this->curArgs[0])) { |
|
| 355 | 355 | $resource = $this->curArgs[0]; |
| 356 | - } else if( |
|
| 356 | + } else if ( |
|
| 357 | 357 | $this->curFunc === 'ldap_search' |
| 358 | 358 | && is_array($this->curArgs[0]) |
| 359 | 359 | && $this->isResource($this->curArgs[0][0]) |
@@ -41,504 +41,504 @@ |
||
| 41 | 41 | * represents an LDAP user, gets and holds user-specific information from LDAP |
| 42 | 42 | */ |
| 43 | 43 | class User { |
| 44 | - /** |
|
| 45 | - * @var IUserTools |
|
| 46 | - */ |
|
| 47 | - protected $access; |
|
| 48 | - /** |
|
| 49 | - * @var Connection |
|
| 50 | - */ |
|
| 51 | - protected $connection; |
|
| 52 | - /** |
|
| 53 | - * @var IConfig |
|
| 54 | - */ |
|
| 55 | - protected $config; |
|
| 56 | - /** |
|
| 57 | - * @var FilesystemHelper |
|
| 58 | - */ |
|
| 59 | - protected $fs; |
|
| 60 | - /** |
|
| 61 | - * @var Image |
|
| 62 | - */ |
|
| 63 | - protected $image; |
|
| 64 | - /** |
|
| 65 | - * @var LogWrapper |
|
| 66 | - */ |
|
| 67 | - protected $log; |
|
| 68 | - /** |
|
| 69 | - * @var IAvatarManager |
|
| 70 | - */ |
|
| 71 | - protected $avatarManager; |
|
| 72 | - /** |
|
| 73 | - * @var IUserManager |
|
| 74 | - */ |
|
| 75 | - protected $userManager; |
|
| 76 | - /** |
|
| 77 | - * @var string |
|
| 78 | - */ |
|
| 79 | - protected $dn; |
|
| 80 | - /** |
|
| 81 | - * @var string |
|
| 82 | - */ |
|
| 83 | - protected $uid; |
|
| 84 | - /** |
|
| 85 | - * @var string[] |
|
| 86 | - */ |
|
| 87 | - protected $refreshedFeatures = array(); |
|
| 88 | - /** |
|
| 89 | - * @var string |
|
| 90 | - */ |
|
| 91 | - protected $avatarImage; |
|
| 92 | - |
|
| 93 | - /** |
|
| 94 | - * DB config keys for user preferences |
|
| 95 | - */ |
|
| 96 | - const USER_PREFKEY_FIRSTLOGIN = 'firstLoginAccomplished'; |
|
| 97 | - const USER_PREFKEY_LASTREFRESH = 'lastFeatureRefresh'; |
|
| 98 | - |
|
| 99 | - /** |
|
| 100 | - * @brief constructor, make sure the subclasses call this one! |
|
| 101 | - * @param string $username the internal username |
|
| 102 | - * @param string $dn the LDAP DN |
|
| 103 | - * @param IUserTools $access an instance that implements IUserTools for |
|
| 104 | - * LDAP interaction |
|
| 105 | - * @param IConfig $config |
|
| 106 | - * @param FilesystemHelper $fs |
|
| 107 | - * @param Image $image any empty instance |
|
| 108 | - * @param LogWrapper $log |
|
| 109 | - * @param IAvatarManager $avatarManager |
|
| 110 | - * @param IUserManager $userManager |
|
| 111 | - */ |
|
| 112 | - public function __construct($username, $dn, IUserTools $access, |
|
| 113 | - IConfig $config, FilesystemHelper $fs, Image $image, |
|
| 114 | - LogWrapper $log, IAvatarManager $avatarManager, IUserManager $userManager) { |
|
| 115 | - |
|
| 116 | - if ($username === null) { |
|
| 117 | - $log->log("uid for '$dn' must not be null!", Util::ERROR); |
|
| 118 | - throw new \InvalidArgumentException('uid must not be null!'); |
|
| 119 | - } else if ($username === '') { |
|
| 120 | - $log->log("uid for '$dn' must not be an empty string", Util::ERROR); |
|
| 121 | - throw new \InvalidArgumentException('uid must not be an empty string!'); |
|
| 122 | - } |
|
| 123 | - |
|
| 124 | - $this->access = $access; |
|
| 125 | - $this->connection = $access->getConnection(); |
|
| 126 | - $this->config = $config; |
|
| 127 | - $this->fs = $fs; |
|
| 128 | - $this->dn = $dn; |
|
| 129 | - $this->uid = $username; |
|
| 130 | - $this->image = $image; |
|
| 131 | - $this->log = $log; |
|
| 132 | - $this->avatarManager = $avatarManager; |
|
| 133 | - $this->userManager = $userManager; |
|
| 134 | - } |
|
| 135 | - |
|
| 136 | - /** |
|
| 137 | - * @brief updates properties like email, quota or avatar provided by LDAP |
|
| 138 | - * @return null |
|
| 139 | - */ |
|
| 140 | - public function update() { |
|
| 141 | - if(is_null($this->dn)) { |
|
| 142 | - return null; |
|
| 143 | - } |
|
| 144 | - |
|
| 145 | - $hasLoggedIn = $this->config->getUserValue($this->uid, 'user_ldap', |
|
| 146 | - self::USER_PREFKEY_FIRSTLOGIN, 0); |
|
| 147 | - |
|
| 148 | - if($this->needsRefresh()) { |
|
| 149 | - $this->updateEmail(); |
|
| 150 | - $this->updateQuota(); |
|
| 151 | - if($hasLoggedIn !== 0) { |
|
| 152 | - //we do not need to try it, when the user has not been logged in |
|
| 153 | - //before, because the file system will not be ready. |
|
| 154 | - $this->updateAvatar(); |
|
| 155 | - //in order to get an avatar as soon as possible, mark the user |
|
| 156 | - //as refreshed only when updating the avatar did happen |
|
| 157 | - $this->markRefreshTime(); |
|
| 158 | - } |
|
| 159 | - } |
|
| 160 | - } |
|
| 161 | - |
|
| 162 | - /** |
|
| 163 | - * processes results from LDAP for attributes as returned by getAttributesToRead() |
|
| 164 | - * @param array $ldapEntry the user entry as retrieved from LDAP |
|
| 165 | - */ |
|
| 166 | - public function processAttributes($ldapEntry) { |
|
| 167 | - $this->markRefreshTime(); |
|
| 168 | - //Quota |
|
| 169 | - $attr = strtolower($this->connection->ldapQuotaAttribute); |
|
| 170 | - if(isset($ldapEntry[$attr])) { |
|
| 171 | - $this->updateQuota($ldapEntry[$attr][0]); |
|
| 172 | - } |
|
| 173 | - unset($attr); |
|
| 174 | - |
|
| 175 | ||
| 176 | - $attr = strtolower($this->connection->ldapEmailAttribute); |
|
| 177 | - if(isset($ldapEntry[$attr])) { |
|
| 178 | - $this->updateEmail($ldapEntry[$attr][0]); |
|
| 179 | - } |
|
| 180 | - unset($attr); |
|
| 181 | - |
|
| 182 | - //displayName |
|
| 183 | - $displayName = $displayName2 = ''; |
|
| 184 | - $attr = strtolower($this->connection->ldapUserDisplayName); |
|
| 185 | - if(isset($ldapEntry[$attr])) { |
|
| 186 | - $displayName = strval($ldapEntry[$attr][0]); |
|
| 187 | - } |
|
| 188 | - $attr = strtolower($this->connection->ldapUserDisplayName2); |
|
| 189 | - if(isset($ldapEntry[$attr])) { |
|
| 190 | - $displayName2 = strval($ldapEntry[$attr][0]); |
|
| 191 | - } |
|
| 192 | - if ($displayName !== '') { |
|
| 193 | - $this->composeAndStoreDisplayName($displayName); |
|
| 194 | - $this->access->cacheUserDisplayName( |
|
| 195 | - $this->getUsername(), |
|
| 196 | - $displayName, |
|
| 197 | - $displayName2 |
|
| 198 | - ); |
|
| 199 | - } |
|
| 200 | - unset($attr); |
|
| 201 | - |
|
| 202 | - // LDAP Username, needed for s2s sharing |
|
| 203 | - if(isset($ldapEntry['uid'])) { |
|
| 204 | - $this->storeLDAPUserName($ldapEntry['uid'][0]); |
|
| 205 | - } else if(isset($ldapEntry['samaccountname'])) { |
|
| 206 | - $this->storeLDAPUserName($ldapEntry['samaccountname'][0]); |
|
| 207 | - } |
|
| 208 | - |
|
| 209 | - //homePath |
|
| 210 | - if(strpos($this->connection->homeFolderNamingRule, 'attr:') === 0) { |
|
| 211 | - $attr = strtolower(substr($this->connection->homeFolderNamingRule, strlen('attr:'))); |
|
| 212 | - if(isset($ldapEntry[$attr])) { |
|
| 213 | - $this->access->cacheUserHome( |
|
| 214 | - $this->getUsername(), $this->getHomePath($ldapEntry[$attr][0])); |
|
| 215 | - } |
|
| 216 | - } |
|
| 217 | - |
|
| 218 | - //memberOf groups |
|
| 219 | - $cacheKey = 'getMemberOf'.$this->getUsername(); |
|
| 220 | - $groups = false; |
|
| 221 | - if(isset($ldapEntry['memberof'])) { |
|
| 222 | - $groups = $ldapEntry['memberof']; |
|
| 223 | - } |
|
| 224 | - $this->connection->writeToCache($cacheKey, $groups); |
|
| 225 | - |
|
| 226 | - //Avatar |
|
| 227 | - $attrs = array('jpegphoto', 'thumbnailphoto'); |
|
| 228 | - foreach ($attrs as $attr) { |
|
| 229 | - if(isset($ldapEntry[$attr])) { |
|
| 230 | - $this->avatarImage = $ldapEntry[$attr][0]; |
|
| 231 | - // the call to the method that saves the avatar in the file |
|
| 232 | - // system must be postponed after the login. It is to ensure |
|
| 233 | - // external mounts are mounted properly (e.g. with login |
|
| 234 | - // credentials from the session). |
|
| 235 | - \OCP\Util::connectHook('OC_User', 'post_login', $this, 'updateAvatarPostLogin'); |
|
| 236 | - break; |
|
| 237 | - } |
|
| 238 | - } |
|
| 239 | - } |
|
| 240 | - |
|
| 241 | - /** |
|
| 242 | - * @brief returns the LDAP DN of the user |
|
| 243 | - * @return string |
|
| 244 | - */ |
|
| 245 | - public function getDN() { |
|
| 246 | - return $this->dn; |
|
| 247 | - } |
|
| 248 | - |
|
| 249 | - /** |
|
| 250 | - * @brief returns the ownCloud internal username of the user |
|
| 251 | - * @return string |
|
| 252 | - */ |
|
| 253 | - public function getUsername() { |
|
| 254 | - return $this->uid; |
|
| 255 | - } |
|
| 256 | - |
|
| 257 | - /** |
|
| 258 | - * returns the home directory of the user if specified by LDAP settings |
|
| 259 | - * @param string $valueFromLDAP |
|
| 260 | - * @return bool|string |
|
| 261 | - * @throws \Exception |
|
| 262 | - */ |
|
| 263 | - public function getHomePath($valueFromLDAP = null) { |
|
| 264 | - $path = strval($valueFromLDAP); |
|
| 265 | - $attr = null; |
|
| 266 | - |
|
| 267 | - if (is_null($valueFromLDAP) |
|
| 268 | - && strpos($this->access->connection->homeFolderNamingRule, 'attr:') === 0 |
|
| 269 | - && $this->access->connection->homeFolderNamingRule !== 'attr:') |
|
| 270 | - { |
|
| 271 | - $attr = substr($this->access->connection->homeFolderNamingRule, strlen('attr:')); |
|
| 272 | - $homedir = $this->access->readAttribute( |
|
| 273 | - $this->access->username2dn($this->getUsername()), $attr); |
|
| 274 | - if ($homedir && isset($homedir[0])) { |
|
| 275 | - $path = $homedir[0]; |
|
| 276 | - } |
|
| 277 | - } |
|
| 278 | - |
|
| 279 | - if ($path !== '') { |
|
| 280 | - //if attribute's value is an absolute path take this, otherwise append it to data dir |
|
| 281 | - //check for / at the beginning or pattern c:\ resp. c:/ |
|
| 282 | - if( '/' !== $path[0] |
|
| 283 | - && !(3 < strlen($path) && ctype_alpha($path[0]) |
|
| 284 | - && $path[1] === ':' && ('\\' === $path[2] || '/' === $path[2])) |
|
| 285 | - ) { |
|
| 286 | - $path = $this->config->getSystemValue('datadirectory', |
|
| 287 | - \OC::$SERVERROOT.'/data' ) . '/' . $path; |
|
| 288 | - } |
|
| 289 | - //we need it to store it in the DB as well in case a user gets |
|
| 290 | - //deleted so we can clean up afterwards |
|
| 291 | - $this->config->setUserValue( |
|
| 292 | - $this->getUsername(), 'user_ldap', 'homePath', $path |
|
| 293 | - ); |
|
| 294 | - return $path; |
|
| 295 | - } |
|
| 296 | - |
|
| 297 | - if( !is_null($attr) |
|
| 298 | - && $this->config->getAppValue('user_ldap', 'enforce_home_folder_naming_rule', true) |
|
| 299 | - ) { |
|
| 300 | - // a naming rule attribute is defined, but it doesn't exist for that LDAP user |
|
| 301 | - throw new \Exception('Home dir attribute can\'t be read from LDAP for uid: ' . $this->getUsername()); |
|
| 302 | - } |
|
| 303 | - |
|
| 304 | - //false will apply default behaviour as defined and done by OC_User |
|
| 305 | - $this->config->setUserValue($this->getUsername(), 'user_ldap', 'homePath', ''); |
|
| 306 | - return false; |
|
| 307 | - } |
|
| 308 | - |
|
| 309 | - public function getMemberOfGroups() { |
|
| 310 | - $cacheKey = 'getMemberOf'.$this->getUsername(); |
|
| 311 | - $memberOfGroups = $this->connection->getFromCache($cacheKey); |
|
| 312 | - if(!is_null($memberOfGroups)) { |
|
| 313 | - return $memberOfGroups; |
|
| 314 | - } |
|
| 315 | - $groupDNs = $this->access->readAttribute($this->getDN(), 'memberOf'); |
|
| 316 | - $this->connection->writeToCache($cacheKey, $groupDNs); |
|
| 317 | - return $groupDNs; |
|
| 318 | - } |
|
| 319 | - |
|
| 320 | - /** |
|
| 321 | - * @brief reads the image from LDAP that shall be used as Avatar |
|
| 322 | - * @return string data (provided by LDAP) | false |
|
| 323 | - */ |
|
| 324 | - public function getAvatarImage() { |
|
| 325 | - if(!is_null($this->avatarImage)) { |
|
| 326 | - return $this->avatarImage; |
|
| 327 | - } |
|
| 328 | - |
|
| 329 | - $this->avatarImage = false; |
|
| 330 | - $attributes = array('jpegPhoto', 'thumbnailPhoto'); |
|
| 331 | - foreach($attributes as $attribute) { |
|
| 332 | - $result = $this->access->readAttribute($this->dn, $attribute); |
|
| 333 | - if($result !== false && is_array($result) && isset($result[0])) { |
|
| 334 | - $this->avatarImage = $result[0]; |
|
| 335 | - break; |
|
| 336 | - } |
|
| 337 | - } |
|
| 338 | - |
|
| 339 | - return $this->avatarImage; |
|
| 340 | - } |
|
| 341 | - |
|
| 342 | - /** |
|
| 343 | - * @brief marks the user as having logged in at least once |
|
| 344 | - * @return null |
|
| 345 | - */ |
|
| 346 | - public function markLogin() { |
|
| 347 | - $this->config->setUserValue( |
|
| 348 | - $this->uid, 'user_ldap', self::USER_PREFKEY_FIRSTLOGIN, 1); |
|
| 349 | - } |
|
| 350 | - |
|
| 351 | - /** |
|
| 352 | - * @brief marks the time when user features like email have been updated |
|
| 353 | - * @return null |
|
| 354 | - */ |
|
| 355 | - public function markRefreshTime() { |
|
| 356 | - $this->config->setUserValue( |
|
| 357 | - $this->uid, 'user_ldap', self::USER_PREFKEY_LASTREFRESH, time()); |
|
| 358 | - } |
|
| 359 | - |
|
| 360 | - /** |
|
| 361 | - * @brief checks whether user features needs to be updated again by |
|
| 362 | - * comparing the difference of time of the last refresh to now with the |
|
| 363 | - * desired interval |
|
| 364 | - * @return bool |
|
| 365 | - */ |
|
| 366 | - private function needsRefresh() { |
|
| 367 | - $lastChecked = $this->config->getUserValue($this->uid, 'user_ldap', |
|
| 368 | - self::USER_PREFKEY_LASTREFRESH, 0); |
|
| 369 | - |
|
| 370 | - //TODO make interval configurable |
|
| 371 | - if((time() - intval($lastChecked)) < 86400 ) { |
|
| 372 | - return false; |
|
| 373 | - } |
|
| 374 | - return true; |
|
| 375 | - } |
|
| 376 | - |
|
| 377 | - /** |
|
| 378 | - * Stores a key-value pair in relation to this user |
|
| 379 | - * |
|
| 380 | - * @param string $key |
|
| 381 | - * @param string $value |
|
| 382 | - */ |
|
| 383 | - private function store($key, $value) { |
|
| 384 | - $this->config->setUserValue($this->uid, 'user_ldap', $key, $value); |
|
| 385 | - } |
|
| 386 | - |
|
| 387 | - /** |
|
| 388 | - * Composes the display name and stores it in the database. The final |
|
| 389 | - * display name is returned. |
|
| 390 | - * |
|
| 391 | - * @param string $displayName |
|
| 392 | - * @param string $displayName2 |
|
| 393 | - * @returns string the effective display name |
|
| 394 | - */ |
|
| 395 | - public function composeAndStoreDisplayName($displayName, $displayName2 = '') { |
|
| 396 | - $displayName2 = strval($displayName2); |
|
| 397 | - if($displayName2 !== '') { |
|
| 398 | - $displayName .= ' (' . $displayName2 . ')'; |
|
| 399 | - } |
|
| 400 | - $this->store('displayName', $displayName); |
|
| 401 | - return $displayName; |
|
| 402 | - } |
|
| 403 | - |
|
| 404 | - /** |
|
| 405 | - * Stores the LDAP Username in the Database |
|
| 406 | - * @param string $userName |
|
| 407 | - */ |
|
| 408 | - public function storeLDAPUserName($userName) { |
|
| 409 | - $this->store('uid', $userName); |
|
| 410 | - } |
|
| 411 | - |
|
| 412 | - /** |
|
| 413 | - * @brief checks whether an update method specified by feature was run |
|
| 414 | - * already. If not, it will marked like this, because it is expected that |
|
| 415 | - * the method will be run, when false is returned. |
|
| 416 | - * @param string $feature email | quota | avatar (can be extended) |
|
| 417 | - * @return bool |
|
| 418 | - */ |
|
| 419 | - private function wasRefreshed($feature) { |
|
| 420 | - if(isset($this->refreshedFeatures[$feature])) { |
|
| 421 | - return true; |
|
| 422 | - } |
|
| 423 | - $this->refreshedFeatures[$feature] = 1; |
|
| 424 | - return false; |
|
| 425 | - } |
|
| 426 | - |
|
| 427 | - /** |
|
| 428 | - * fetches the email from LDAP and stores it as ownCloud user value |
|
| 429 | - * @param string $valueFromLDAP if known, to save an LDAP read request |
|
| 430 | - * @return null |
|
| 431 | - */ |
|
| 432 | - public function updateEmail($valueFromLDAP = null) { |
|
| 433 | - if($this->wasRefreshed('email')) { |
|
| 434 | - return; |
|
| 435 | - } |
|
| 436 | - $email = strval($valueFromLDAP); |
|
| 437 | - if(is_null($valueFromLDAP)) { |
|
| 438 | - $emailAttribute = $this->connection->ldapEmailAttribute; |
|
| 439 | - if ($emailAttribute !== '') { |
|
| 440 | - $aEmail = $this->access->readAttribute($this->dn, $emailAttribute); |
|
| 441 | - if(is_array($aEmail) && (count($aEmail) > 0)) { |
|
| 442 | - $email = strval($aEmail[0]); |
|
| 443 | - } |
|
| 444 | - } |
|
| 445 | - } |
|
| 446 | - if ($email !== '') { |
|
| 447 | - $user = $this->userManager->get($this->uid); |
|
| 448 | - if (!is_null($user)) { |
|
| 449 | - $currentEmail = strval($user->getEMailAddress()); |
|
| 450 | - if ($currentEmail !== $email) { |
|
| 451 | - $user->setEMailAddress($email); |
|
| 452 | - } |
|
| 453 | - } |
|
| 454 | - } |
|
| 455 | - } |
|
| 456 | - |
|
| 457 | - /** |
|
| 458 | - * fetches the quota from LDAP and stores it as ownCloud user value |
|
| 459 | - * @param string $valueFromLDAP the quota attribute's value can be passed, |
|
| 460 | - * to save the readAttribute request |
|
| 461 | - * @return null |
|
| 462 | - */ |
|
| 463 | - public function updateQuota($valueFromLDAP = null) { |
|
| 464 | - if($this->wasRefreshed('quota')) { |
|
| 465 | - return; |
|
| 466 | - } |
|
| 467 | - //can be null |
|
| 468 | - $quotaDefault = $this->connection->ldapQuotaDefault; |
|
| 469 | - $quota = $quotaDefault !== '' ? $quotaDefault : null; |
|
| 470 | - $quota = !is_null($valueFromLDAP) ? $valueFromLDAP : $quota; |
|
| 471 | - |
|
| 472 | - if(is_null($valueFromLDAP)) { |
|
| 473 | - $quotaAttribute = $this->connection->ldapQuotaAttribute; |
|
| 474 | - if ($quotaAttribute !== '') { |
|
| 475 | - $aQuota = $this->access->readAttribute($this->dn, $quotaAttribute); |
|
| 476 | - if($aQuota && (count($aQuota) > 0)) { |
|
| 477 | - $quota = $aQuota[0]; |
|
| 478 | - } |
|
| 479 | - } |
|
| 480 | - } |
|
| 481 | - if(!is_null($quota)) { |
|
| 482 | - $this->userManager->get($this->uid)->setQuota($quota); |
|
| 483 | - } |
|
| 484 | - } |
|
| 485 | - |
|
| 486 | - /** |
|
| 487 | - * called by a post_login hook to save the avatar picture |
|
| 488 | - * |
|
| 489 | - * @param array $params |
|
| 490 | - */ |
|
| 491 | - public function updateAvatarPostLogin($params) { |
|
| 492 | - if(isset($params['uid']) && $params['uid'] === $this->getUsername()) { |
|
| 493 | - $this->updateAvatar(); |
|
| 494 | - } |
|
| 495 | - } |
|
| 496 | - |
|
| 497 | - /** |
|
| 498 | - * @brief attempts to get an image from LDAP and sets it as ownCloud avatar |
|
| 499 | - * @return null |
|
| 500 | - */ |
|
| 501 | - public function updateAvatar() { |
|
| 502 | - if($this->wasRefreshed('avatar')) { |
|
| 503 | - return; |
|
| 504 | - } |
|
| 505 | - $avatarImage = $this->getAvatarImage(); |
|
| 506 | - if($avatarImage === false) { |
|
| 507 | - //not set, nothing left to do; |
|
| 508 | - return; |
|
| 509 | - } |
|
| 510 | - $this->image->loadFromBase64(base64_encode($avatarImage)); |
|
| 511 | - $this->setOwnCloudAvatar(); |
|
| 512 | - } |
|
| 513 | - |
|
| 514 | - /** |
|
| 515 | - * @brief sets an image as ownCloud avatar |
|
| 516 | - * @return null |
|
| 517 | - */ |
|
| 518 | - private function setOwnCloudAvatar() { |
|
| 519 | - if(!$this->image->valid()) { |
|
| 520 | - $this->log->log('jpegPhoto data invalid for '.$this->dn, \OCP\Util::ERROR); |
|
| 521 | - return; |
|
| 522 | - } |
|
| 523 | - //make sure it is a square and not bigger than 128x128 |
|
| 524 | - $size = min(array($this->image->width(), $this->image->height(), 128)); |
|
| 525 | - if(!$this->image->centerCrop($size)) { |
|
| 526 | - $this->log->log('croping image for avatar failed for '.$this->dn, \OCP\Util::ERROR); |
|
| 527 | - return; |
|
| 528 | - } |
|
| 529 | - |
|
| 530 | - if(!$this->fs->isLoaded()) { |
|
| 531 | - $this->fs->setup($this->uid); |
|
| 532 | - } |
|
| 533 | - |
|
| 534 | - try { |
|
| 535 | - $avatar = $this->avatarManager->getAvatar($this->uid); |
|
| 536 | - $avatar->set($this->image); |
|
| 537 | - } catch (\Exception $e) { |
|
| 538 | - \OC::$server->getLogger()->notice( |
|
| 539 | - 'Could not set avatar for ' . $this->dn . ', because: ' . $e->getMessage(), |
|
| 540 | - ['app' => 'user_ldap']); |
|
| 541 | - } |
|
| 542 | - } |
|
| 44 | + /** |
|
| 45 | + * @var IUserTools |
|
| 46 | + */ |
|
| 47 | + protected $access; |
|
| 48 | + /** |
|
| 49 | + * @var Connection |
|
| 50 | + */ |
|
| 51 | + protected $connection; |
|
| 52 | + /** |
|
| 53 | + * @var IConfig |
|
| 54 | + */ |
|
| 55 | + protected $config; |
|
| 56 | + /** |
|
| 57 | + * @var FilesystemHelper |
|
| 58 | + */ |
|
| 59 | + protected $fs; |
|
| 60 | + /** |
|
| 61 | + * @var Image |
|
| 62 | + */ |
|
| 63 | + protected $image; |
|
| 64 | + /** |
|
| 65 | + * @var LogWrapper |
|
| 66 | + */ |
|
| 67 | + protected $log; |
|
| 68 | + /** |
|
| 69 | + * @var IAvatarManager |
|
| 70 | + */ |
|
| 71 | + protected $avatarManager; |
|
| 72 | + /** |
|
| 73 | + * @var IUserManager |
|
| 74 | + */ |
|
| 75 | + protected $userManager; |
|
| 76 | + /** |
|
| 77 | + * @var string |
|
| 78 | + */ |
|
| 79 | + protected $dn; |
|
| 80 | + /** |
|
| 81 | + * @var string |
|
| 82 | + */ |
|
| 83 | + protected $uid; |
|
| 84 | + /** |
|
| 85 | + * @var string[] |
|
| 86 | + */ |
|
| 87 | + protected $refreshedFeatures = array(); |
|
| 88 | + /** |
|
| 89 | + * @var string |
|
| 90 | + */ |
|
| 91 | + protected $avatarImage; |
|
| 92 | + |
|
| 93 | + /** |
|
| 94 | + * DB config keys for user preferences |
|
| 95 | + */ |
|
| 96 | + const USER_PREFKEY_FIRSTLOGIN = 'firstLoginAccomplished'; |
|
| 97 | + const USER_PREFKEY_LASTREFRESH = 'lastFeatureRefresh'; |
|
| 98 | + |
|
| 99 | + /** |
|
| 100 | + * @brief constructor, make sure the subclasses call this one! |
|
| 101 | + * @param string $username the internal username |
|
| 102 | + * @param string $dn the LDAP DN |
|
| 103 | + * @param IUserTools $access an instance that implements IUserTools for |
|
| 104 | + * LDAP interaction |
|
| 105 | + * @param IConfig $config |
|
| 106 | + * @param FilesystemHelper $fs |
|
| 107 | + * @param Image $image any empty instance |
|
| 108 | + * @param LogWrapper $log |
|
| 109 | + * @param IAvatarManager $avatarManager |
|
| 110 | + * @param IUserManager $userManager |
|
| 111 | + */ |
|
| 112 | + public function __construct($username, $dn, IUserTools $access, |
|
| 113 | + IConfig $config, FilesystemHelper $fs, Image $image, |
|
| 114 | + LogWrapper $log, IAvatarManager $avatarManager, IUserManager $userManager) { |
|
| 115 | + |
|
| 116 | + if ($username === null) { |
|
| 117 | + $log->log("uid for '$dn' must not be null!", Util::ERROR); |
|
| 118 | + throw new \InvalidArgumentException('uid must not be null!'); |
|
| 119 | + } else if ($username === '') { |
|
| 120 | + $log->log("uid for '$dn' must not be an empty string", Util::ERROR); |
|
| 121 | + throw new \InvalidArgumentException('uid must not be an empty string!'); |
|
| 122 | + } |
|
| 123 | + |
|
| 124 | + $this->access = $access; |
|
| 125 | + $this->connection = $access->getConnection(); |
|
| 126 | + $this->config = $config; |
|
| 127 | + $this->fs = $fs; |
|
| 128 | + $this->dn = $dn; |
|
| 129 | + $this->uid = $username; |
|
| 130 | + $this->image = $image; |
|
| 131 | + $this->log = $log; |
|
| 132 | + $this->avatarManager = $avatarManager; |
|
| 133 | + $this->userManager = $userManager; |
|
| 134 | + } |
|
| 135 | + |
|
| 136 | + /** |
|
| 137 | + * @brief updates properties like email, quota or avatar provided by LDAP |
|
| 138 | + * @return null |
|
| 139 | + */ |
|
| 140 | + public function update() { |
|
| 141 | + if(is_null($this->dn)) { |
|
| 142 | + return null; |
|
| 143 | + } |
|
| 144 | + |
|
| 145 | + $hasLoggedIn = $this->config->getUserValue($this->uid, 'user_ldap', |
|
| 146 | + self::USER_PREFKEY_FIRSTLOGIN, 0); |
|
| 147 | + |
|
| 148 | + if($this->needsRefresh()) { |
|
| 149 | + $this->updateEmail(); |
|
| 150 | + $this->updateQuota(); |
|
| 151 | + if($hasLoggedIn !== 0) { |
|
| 152 | + //we do not need to try it, when the user has not been logged in |
|
| 153 | + //before, because the file system will not be ready. |
|
| 154 | + $this->updateAvatar(); |
|
| 155 | + //in order to get an avatar as soon as possible, mark the user |
|
| 156 | + //as refreshed only when updating the avatar did happen |
|
| 157 | + $this->markRefreshTime(); |
|
| 158 | + } |
|
| 159 | + } |
|
| 160 | + } |
|
| 161 | + |
|
| 162 | + /** |
|
| 163 | + * processes results from LDAP for attributes as returned by getAttributesToRead() |
|
| 164 | + * @param array $ldapEntry the user entry as retrieved from LDAP |
|
| 165 | + */ |
|
| 166 | + public function processAttributes($ldapEntry) { |
|
| 167 | + $this->markRefreshTime(); |
|
| 168 | + //Quota |
|
| 169 | + $attr = strtolower($this->connection->ldapQuotaAttribute); |
|
| 170 | + if(isset($ldapEntry[$attr])) { |
|
| 171 | + $this->updateQuota($ldapEntry[$attr][0]); |
|
| 172 | + } |
|
| 173 | + unset($attr); |
|
| 174 | + |
|
| 175 | ||
| 176 | + $attr = strtolower($this->connection->ldapEmailAttribute); |
|
| 177 | + if(isset($ldapEntry[$attr])) { |
|
| 178 | + $this->updateEmail($ldapEntry[$attr][0]); |
|
| 179 | + } |
|
| 180 | + unset($attr); |
|
| 181 | + |
|
| 182 | + //displayName |
|
| 183 | + $displayName = $displayName2 = ''; |
|
| 184 | + $attr = strtolower($this->connection->ldapUserDisplayName); |
|
| 185 | + if(isset($ldapEntry[$attr])) { |
|
| 186 | + $displayName = strval($ldapEntry[$attr][0]); |
|
| 187 | + } |
|
| 188 | + $attr = strtolower($this->connection->ldapUserDisplayName2); |
|
| 189 | + if(isset($ldapEntry[$attr])) { |
|
| 190 | + $displayName2 = strval($ldapEntry[$attr][0]); |
|
| 191 | + } |
|
| 192 | + if ($displayName !== '') { |
|
| 193 | + $this->composeAndStoreDisplayName($displayName); |
|
| 194 | + $this->access->cacheUserDisplayName( |
|
| 195 | + $this->getUsername(), |
|
| 196 | + $displayName, |
|
| 197 | + $displayName2 |
|
| 198 | + ); |
|
| 199 | + } |
|
| 200 | + unset($attr); |
|
| 201 | + |
|
| 202 | + // LDAP Username, needed for s2s sharing |
|
| 203 | + if(isset($ldapEntry['uid'])) { |
|
| 204 | + $this->storeLDAPUserName($ldapEntry['uid'][0]); |
|
| 205 | + } else if(isset($ldapEntry['samaccountname'])) { |
|
| 206 | + $this->storeLDAPUserName($ldapEntry['samaccountname'][0]); |
|
| 207 | + } |
|
| 208 | + |
|
| 209 | + //homePath |
|
| 210 | + if(strpos($this->connection->homeFolderNamingRule, 'attr:') === 0) { |
|
| 211 | + $attr = strtolower(substr($this->connection->homeFolderNamingRule, strlen('attr:'))); |
|
| 212 | + if(isset($ldapEntry[$attr])) { |
|
| 213 | + $this->access->cacheUserHome( |
|
| 214 | + $this->getUsername(), $this->getHomePath($ldapEntry[$attr][0])); |
|
| 215 | + } |
|
| 216 | + } |
|
| 217 | + |
|
| 218 | + //memberOf groups |
|
| 219 | + $cacheKey = 'getMemberOf'.$this->getUsername(); |
|
| 220 | + $groups = false; |
|
| 221 | + if(isset($ldapEntry['memberof'])) { |
|
| 222 | + $groups = $ldapEntry['memberof']; |
|
| 223 | + } |
|
| 224 | + $this->connection->writeToCache($cacheKey, $groups); |
|
| 225 | + |
|
| 226 | + //Avatar |
|
| 227 | + $attrs = array('jpegphoto', 'thumbnailphoto'); |
|
| 228 | + foreach ($attrs as $attr) { |
|
| 229 | + if(isset($ldapEntry[$attr])) { |
|
| 230 | + $this->avatarImage = $ldapEntry[$attr][0]; |
|
| 231 | + // the call to the method that saves the avatar in the file |
|
| 232 | + // system must be postponed after the login. It is to ensure |
|
| 233 | + // external mounts are mounted properly (e.g. with login |
|
| 234 | + // credentials from the session). |
|
| 235 | + \OCP\Util::connectHook('OC_User', 'post_login', $this, 'updateAvatarPostLogin'); |
|
| 236 | + break; |
|
| 237 | + } |
|
| 238 | + } |
|
| 239 | + } |
|
| 240 | + |
|
| 241 | + /** |
|
| 242 | + * @brief returns the LDAP DN of the user |
|
| 243 | + * @return string |
|
| 244 | + */ |
|
| 245 | + public function getDN() { |
|
| 246 | + return $this->dn; |
|
| 247 | + } |
|
| 248 | + |
|
| 249 | + /** |
|
| 250 | + * @brief returns the ownCloud internal username of the user |
|
| 251 | + * @return string |
|
| 252 | + */ |
|
| 253 | + public function getUsername() { |
|
| 254 | + return $this->uid; |
|
| 255 | + } |
|
| 256 | + |
|
| 257 | + /** |
|
| 258 | + * returns the home directory of the user if specified by LDAP settings |
|
| 259 | + * @param string $valueFromLDAP |
|
| 260 | + * @return bool|string |
|
| 261 | + * @throws \Exception |
|
| 262 | + */ |
|
| 263 | + public function getHomePath($valueFromLDAP = null) { |
|
| 264 | + $path = strval($valueFromLDAP); |
|
| 265 | + $attr = null; |
|
| 266 | + |
|
| 267 | + if (is_null($valueFromLDAP) |
|
| 268 | + && strpos($this->access->connection->homeFolderNamingRule, 'attr:') === 0 |
|
| 269 | + && $this->access->connection->homeFolderNamingRule !== 'attr:') |
|
| 270 | + { |
|
| 271 | + $attr = substr($this->access->connection->homeFolderNamingRule, strlen('attr:')); |
|
| 272 | + $homedir = $this->access->readAttribute( |
|
| 273 | + $this->access->username2dn($this->getUsername()), $attr); |
|
| 274 | + if ($homedir && isset($homedir[0])) { |
|
| 275 | + $path = $homedir[0]; |
|
| 276 | + } |
|
| 277 | + } |
|
| 278 | + |
|
| 279 | + if ($path !== '') { |
|
| 280 | + //if attribute's value is an absolute path take this, otherwise append it to data dir |
|
| 281 | + //check for / at the beginning or pattern c:\ resp. c:/ |
|
| 282 | + if( '/' !== $path[0] |
|
| 283 | + && !(3 < strlen($path) && ctype_alpha($path[0]) |
|
| 284 | + && $path[1] === ':' && ('\\' === $path[2] || '/' === $path[2])) |
|
| 285 | + ) { |
|
| 286 | + $path = $this->config->getSystemValue('datadirectory', |
|
| 287 | + \OC::$SERVERROOT.'/data' ) . '/' . $path; |
|
| 288 | + } |
|
| 289 | + //we need it to store it in the DB as well in case a user gets |
|
| 290 | + //deleted so we can clean up afterwards |
|
| 291 | + $this->config->setUserValue( |
|
| 292 | + $this->getUsername(), 'user_ldap', 'homePath', $path |
|
| 293 | + ); |
|
| 294 | + return $path; |
|
| 295 | + } |
|
| 296 | + |
|
| 297 | + if( !is_null($attr) |
|
| 298 | + && $this->config->getAppValue('user_ldap', 'enforce_home_folder_naming_rule', true) |
|
| 299 | + ) { |
|
| 300 | + // a naming rule attribute is defined, but it doesn't exist for that LDAP user |
|
| 301 | + throw new \Exception('Home dir attribute can\'t be read from LDAP for uid: ' . $this->getUsername()); |
|
| 302 | + } |
|
| 303 | + |
|
| 304 | + //false will apply default behaviour as defined and done by OC_User |
|
| 305 | + $this->config->setUserValue($this->getUsername(), 'user_ldap', 'homePath', ''); |
|
| 306 | + return false; |
|
| 307 | + } |
|
| 308 | + |
|
| 309 | + public function getMemberOfGroups() { |
|
| 310 | + $cacheKey = 'getMemberOf'.$this->getUsername(); |
|
| 311 | + $memberOfGroups = $this->connection->getFromCache($cacheKey); |
|
| 312 | + if(!is_null($memberOfGroups)) { |
|
| 313 | + return $memberOfGroups; |
|
| 314 | + } |
|
| 315 | + $groupDNs = $this->access->readAttribute($this->getDN(), 'memberOf'); |
|
| 316 | + $this->connection->writeToCache($cacheKey, $groupDNs); |
|
| 317 | + return $groupDNs; |
|
| 318 | + } |
|
| 319 | + |
|
| 320 | + /** |
|
| 321 | + * @brief reads the image from LDAP that shall be used as Avatar |
|
| 322 | + * @return string data (provided by LDAP) | false |
|
| 323 | + */ |
|
| 324 | + public function getAvatarImage() { |
|
| 325 | + if(!is_null($this->avatarImage)) { |
|
| 326 | + return $this->avatarImage; |
|
| 327 | + } |
|
| 328 | + |
|
| 329 | + $this->avatarImage = false; |
|
| 330 | + $attributes = array('jpegPhoto', 'thumbnailPhoto'); |
|
| 331 | + foreach($attributes as $attribute) { |
|
| 332 | + $result = $this->access->readAttribute($this->dn, $attribute); |
|
| 333 | + if($result !== false && is_array($result) && isset($result[0])) { |
|
| 334 | + $this->avatarImage = $result[0]; |
|
| 335 | + break; |
|
| 336 | + } |
|
| 337 | + } |
|
| 338 | + |
|
| 339 | + return $this->avatarImage; |
|
| 340 | + } |
|
| 341 | + |
|
| 342 | + /** |
|
| 343 | + * @brief marks the user as having logged in at least once |
|
| 344 | + * @return null |
|
| 345 | + */ |
|
| 346 | + public function markLogin() { |
|
| 347 | + $this->config->setUserValue( |
|
| 348 | + $this->uid, 'user_ldap', self::USER_PREFKEY_FIRSTLOGIN, 1); |
|
| 349 | + } |
|
| 350 | + |
|
| 351 | + /** |
|
| 352 | + * @brief marks the time when user features like email have been updated |
|
| 353 | + * @return null |
|
| 354 | + */ |
|
| 355 | + public function markRefreshTime() { |
|
| 356 | + $this->config->setUserValue( |
|
| 357 | + $this->uid, 'user_ldap', self::USER_PREFKEY_LASTREFRESH, time()); |
|
| 358 | + } |
|
| 359 | + |
|
| 360 | + /** |
|
| 361 | + * @brief checks whether user features needs to be updated again by |
|
| 362 | + * comparing the difference of time of the last refresh to now with the |
|
| 363 | + * desired interval |
|
| 364 | + * @return bool |
|
| 365 | + */ |
|
| 366 | + private function needsRefresh() { |
|
| 367 | + $lastChecked = $this->config->getUserValue($this->uid, 'user_ldap', |
|
| 368 | + self::USER_PREFKEY_LASTREFRESH, 0); |
|
| 369 | + |
|
| 370 | + //TODO make interval configurable |
|
| 371 | + if((time() - intval($lastChecked)) < 86400 ) { |
|
| 372 | + return false; |
|
| 373 | + } |
|
| 374 | + return true; |
|
| 375 | + } |
|
| 376 | + |
|
| 377 | + /** |
|
| 378 | + * Stores a key-value pair in relation to this user |
|
| 379 | + * |
|
| 380 | + * @param string $key |
|
| 381 | + * @param string $value |
|
| 382 | + */ |
|
| 383 | + private function store($key, $value) { |
|
| 384 | + $this->config->setUserValue($this->uid, 'user_ldap', $key, $value); |
|
| 385 | + } |
|
| 386 | + |
|
| 387 | + /** |
|
| 388 | + * Composes the display name and stores it in the database. The final |
|
| 389 | + * display name is returned. |
|
| 390 | + * |
|
| 391 | + * @param string $displayName |
|
| 392 | + * @param string $displayName2 |
|
| 393 | + * @returns string the effective display name |
|
| 394 | + */ |
|
| 395 | + public function composeAndStoreDisplayName($displayName, $displayName2 = '') { |
|
| 396 | + $displayName2 = strval($displayName2); |
|
| 397 | + if($displayName2 !== '') { |
|
| 398 | + $displayName .= ' (' . $displayName2 . ')'; |
|
| 399 | + } |
|
| 400 | + $this->store('displayName', $displayName); |
|
| 401 | + return $displayName; |
|
| 402 | + } |
|
| 403 | + |
|
| 404 | + /** |
|
| 405 | + * Stores the LDAP Username in the Database |
|
| 406 | + * @param string $userName |
|
| 407 | + */ |
|
| 408 | + public function storeLDAPUserName($userName) { |
|
| 409 | + $this->store('uid', $userName); |
|
| 410 | + } |
|
| 411 | + |
|
| 412 | + /** |
|
| 413 | + * @brief checks whether an update method specified by feature was run |
|
| 414 | + * already. If not, it will marked like this, because it is expected that |
|
| 415 | + * the method will be run, when false is returned. |
|
| 416 | + * @param string $feature email | quota | avatar (can be extended) |
|
| 417 | + * @return bool |
|
| 418 | + */ |
|
| 419 | + private function wasRefreshed($feature) { |
|
| 420 | + if(isset($this->refreshedFeatures[$feature])) { |
|
| 421 | + return true; |
|
| 422 | + } |
|
| 423 | + $this->refreshedFeatures[$feature] = 1; |
|
| 424 | + return false; |
|
| 425 | + } |
|
| 426 | + |
|
| 427 | + /** |
|
| 428 | + * fetches the email from LDAP and stores it as ownCloud user value |
|
| 429 | + * @param string $valueFromLDAP if known, to save an LDAP read request |
|
| 430 | + * @return null |
|
| 431 | + */ |
|
| 432 | + public function updateEmail($valueFromLDAP = null) { |
|
| 433 | + if($this->wasRefreshed('email')) { |
|
| 434 | + return; |
|
| 435 | + } |
|
| 436 | + $email = strval($valueFromLDAP); |
|
| 437 | + if(is_null($valueFromLDAP)) { |
|
| 438 | + $emailAttribute = $this->connection->ldapEmailAttribute; |
|
| 439 | + if ($emailAttribute !== '') { |
|
| 440 | + $aEmail = $this->access->readAttribute($this->dn, $emailAttribute); |
|
| 441 | + if(is_array($aEmail) && (count($aEmail) > 0)) { |
|
| 442 | + $email = strval($aEmail[0]); |
|
| 443 | + } |
|
| 444 | + } |
|
| 445 | + } |
|
| 446 | + if ($email !== '') { |
|
| 447 | + $user = $this->userManager->get($this->uid); |
|
| 448 | + if (!is_null($user)) { |
|
| 449 | + $currentEmail = strval($user->getEMailAddress()); |
|
| 450 | + if ($currentEmail !== $email) { |
|
| 451 | + $user->setEMailAddress($email); |
|
| 452 | + } |
|
| 453 | + } |
|
| 454 | + } |
|
| 455 | + } |
|
| 456 | + |
|
| 457 | + /** |
|
| 458 | + * fetches the quota from LDAP and stores it as ownCloud user value |
|
| 459 | + * @param string $valueFromLDAP the quota attribute's value can be passed, |
|
| 460 | + * to save the readAttribute request |
|
| 461 | + * @return null |
|
| 462 | + */ |
|
| 463 | + public function updateQuota($valueFromLDAP = null) { |
|
| 464 | + if($this->wasRefreshed('quota')) { |
|
| 465 | + return; |
|
| 466 | + } |
|
| 467 | + //can be null |
|
| 468 | + $quotaDefault = $this->connection->ldapQuotaDefault; |
|
| 469 | + $quota = $quotaDefault !== '' ? $quotaDefault : null; |
|
| 470 | + $quota = !is_null($valueFromLDAP) ? $valueFromLDAP : $quota; |
|
| 471 | + |
|
| 472 | + if(is_null($valueFromLDAP)) { |
|
| 473 | + $quotaAttribute = $this->connection->ldapQuotaAttribute; |
|
| 474 | + if ($quotaAttribute !== '') { |
|
| 475 | + $aQuota = $this->access->readAttribute($this->dn, $quotaAttribute); |
|
| 476 | + if($aQuota && (count($aQuota) > 0)) { |
|
| 477 | + $quota = $aQuota[0]; |
|
| 478 | + } |
|
| 479 | + } |
|
| 480 | + } |
|
| 481 | + if(!is_null($quota)) { |
|
| 482 | + $this->userManager->get($this->uid)->setQuota($quota); |
|
| 483 | + } |
|
| 484 | + } |
|
| 485 | + |
|
| 486 | + /** |
|
| 487 | + * called by a post_login hook to save the avatar picture |
|
| 488 | + * |
|
| 489 | + * @param array $params |
|
| 490 | + */ |
|
| 491 | + public function updateAvatarPostLogin($params) { |
|
| 492 | + if(isset($params['uid']) && $params['uid'] === $this->getUsername()) { |
|
| 493 | + $this->updateAvatar(); |
|
| 494 | + } |
|
| 495 | + } |
|
| 496 | + |
|
| 497 | + /** |
|
| 498 | + * @brief attempts to get an image from LDAP and sets it as ownCloud avatar |
|
| 499 | + * @return null |
|
| 500 | + */ |
|
| 501 | + public function updateAvatar() { |
|
| 502 | + if($this->wasRefreshed('avatar')) { |
|
| 503 | + return; |
|
| 504 | + } |
|
| 505 | + $avatarImage = $this->getAvatarImage(); |
|
| 506 | + if($avatarImage === false) { |
|
| 507 | + //not set, nothing left to do; |
|
| 508 | + return; |
|
| 509 | + } |
|
| 510 | + $this->image->loadFromBase64(base64_encode($avatarImage)); |
|
| 511 | + $this->setOwnCloudAvatar(); |
|
| 512 | + } |
|
| 513 | + |
|
| 514 | + /** |
|
| 515 | + * @brief sets an image as ownCloud avatar |
|
| 516 | + * @return null |
|
| 517 | + */ |
|
| 518 | + private function setOwnCloudAvatar() { |
|
| 519 | + if(!$this->image->valid()) { |
|
| 520 | + $this->log->log('jpegPhoto data invalid for '.$this->dn, \OCP\Util::ERROR); |
|
| 521 | + return; |
|
| 522 | + } |
|
| 523 | + //make sure it is a square and not bigger than 128x128 |
|
| 524 | + $size = min(array($this->image->width(), $this->image->height(), 128)); |
|
| 525 | + if(!$this->image->centerCrop($size)) { |
|
| 526 | + $this->log->log('croping image for avatar failed for '.$this->dn, \OCP\Util::ERROR); |
|
| 527 | + return; |
|
| 528 | + } |
|
| 529 | + |
|
| 530 | + if(!$this->fs->isLoaded()) { |
|
| 531 | + $this->fs->setup($this->uid); |
|
| 532 | + } |
|
| 533 | + |
|
| 534 | + try { |
|
| 535 | + $avatar = $this->avatarManager->getAvatar($this->uid); |
|
| 536 | + $avatar->set($this->image); |
|
| 537 | + } catch (\Exception $e) { |
|
| 538 | + \OC::$server->getLogger()->notice( |
|
| 539 | + 'Could not set avatar for ' . $this->dn . ', because: ' . $e->getMessage(), |
|
| 540 | + ['app' => 'user_ldap']); |
|
| 541 | + } |
|
| 542 | + } |
|
| 543 | 543 | |
| 544 | 544 | } |
@@ -138,17 +138,17 @@ discard block |
||
| 138 | 138 | * @return null |
| 139 | 139 | */ |
| 140 | 140 | public function update() { |
| 141 | - if(is_null($this->dn)) { |
|
| 141 | + if (is_null($this->dn)) { |
|
| 142 | 142 | return null; |
| 143 | 143 | } |
| 144 | 144 | |
| 145 | 145 | $hasLoggedIn = $this->config->getUserValue($this->uid, 'user_ldap', |
| 146 | 146 | self::USER_PREFKEY_FIRSTLOGIN, 0); |
| 147 | 147 | |
| 148 | - if($this->needsRefresh()) { |
|
| 148 | + if ($this->needsRefresh()) { |
|
| 149 | 149 | $this->updateEmail(); |
| 150 | 150 | $this->updateQuota(); |
| 151 | - if($hasLoggedIn !== 0) { |
|
| 151 | + if ($hasLoggedIn !== 0) { |
|
| 152 | 152 | //we do not need to try it, when the user has not been logged in |
| 153 | 153 | //before, because the file system will not be ready. |
| 154 | 154 | $this->updateAvatar(); |
@@ -167,14 +167,14 @@ discard block |
||
| 167 | 167 | $this->markRefreshTime(); |
| 168 | 168 | //Quota |
| 169 | 169 | $attr = strtolower($this->connection->ldapQuotaAttribute); |
| 170 | - if(isset($ldapEntry[$attr])) { |
|
| 170 | + if (isset($ldapEntry[$attr])) { |
|
| 171 | 171 | $this->updateQuota($ldapEntry[$attr][0]); |
| 172 | 172 | } |
| 173 | 173 | unset($attr); |
| 174 | 174 | |
| 175 | 175 | |
| 176 | 176 | $attr = strtolower($this->connection->ldapEmailAttribute); |
| 177 | - if(isset($ldapEntry[$attr])) { |
|
| 177 | + if (isset($ldapEntry[$attr])) { |
|
| 178 | 178 | $this->updateEmail($ldapEntry[$attr][0]); |
| 179 | 179 | } |
| 180 | 180 | unset($attr); |
@@ -182,11 +182,11 @@ discard block |
||
| 182 | 182 | //displayName |
| 183 | 183 | $displayName = $displayName2 = ''; |
| 184 | 184 | $attr = strtolower($this->connection->ldapUserDisplayName); |
| 185 | - if(isset($ldapEntry[$attr])) { |
|
| 185 | + if (isset($ldapEntry[$attr])) { |
|
| 186 | 186 | $displayName = strval($ldapEntry[$attr][0]); |
| 187 | 187 | } |
| 188 | 188 | $attr = strtolower($this->connection->ldapUserDisplayName2); |
| 189 | - if(isset($ldapEntry[$attr])) { |
|
| 189 | + if (isset($ldapEntry[$attr])) { |
|
| 190 | 190 | $displayName2 = strval($ldapEntry[$attr][0]); |
| 191 | 191 | } |
| 192 | 192 | if ($displayName !== '') { |
@@ -200,16 +200,16 @@ discard block |
||
| 200 | 200 | unset($attr); |
| 201 | 201 | |
| 202 | 202 | // LDAP Username, needed for s2s sharing |
| 203 | - if(isset($ldapEntry['uid'])) { |
|
| 203 | + if (isset($ldapEntry['uid'])) { |
|
| 204 | 204 | $this->storeLDAPUserName($ldapEntry['uid'][0]); |
| 205 | - } else if(isset($ldapEntry['samaccountname'])) { |
|
| 205 | + } else if (isset($ldapEntry['samaccountname'])) { |
|
| 206 | 206 | $this->storeLDAPUserName($ldapEntry['samaccountname'][0]); |
| 207 | 207 | } |
| 208 | 208 | |
| 209 | 209 | //homePath |
| 210 | - if(strpos($this->connection->homeFolderNamingRule, 'attr:') === 0) { |
|
| 210 | + if (strpos($this->connection->homeFolderNamingRule, 'attr:') === 0) { |
|
| 211 | 211 | $attr = strtolower(substr($this->connection->homeFolderNamingRule, strlen('attr:'))); |
| 212 | - if(isset($ldapEntry[$attr])) { |
|
| 212 | + if (isset($ldapEntry[$attr])) { |
|
| 213 | 213 | $this->access->cacheUserHome( |
| 214 | 214 | $this->getUsername(), $this->getHomePath($ldapEntry[$attr][0])); |
| 215 | 215 | } |
@@ -218,15 +218,15 @@ discard block |
||
| 218 | 218 | //memberOf groups |
| 219 | 219 | $cacheKey = 'getMemberOf'.$this->getUsername(); |
| 220 | 220 | $groups = false; |
| 221 | - if(isset($ldapEntry['memberof'])) { |
|
| 221 | + if (isset($ldapEntry['memberof'])) { |
|
| 222 | 222 | $groups = $ldapEntry['memberof']; |
| 223 | 223 | } |
| 224 | 224 | $this->connection->writeToCache($cacheKey, $groups); |
| 225 | 225 | |
| 226 | 226 | //Avatar |
| 227 | 227 | $attrs = array('jpegphoto', 'thumbnailphoto'); |
| 228 | - foreach ($attrs as $attr) { |
|
| 229 | - if(isset($ldapEntry[$attr])) { |
|
| 228 | + foreach ($attrs as $attr) { |
|
| 229 | + if (isset($ldapEntry[$attr])) { |
|
| 230 | 230 | $this->avatarImage = $ldapEntry[$attr][0]; |
| 231 | 231 | // the call to the method that saves the avatar in the file |
| 232 | 232 | // system must be postponed after the login. It is to ensure |
@@ -279,12 +279,12 @@ discard block |
||
| 279 | 279 | if ($path !== '') { |
| 280 | 280 | //if attribute's value is an absolute path take this, otherwise append it to data dir |
| 281 | 281 | //check for / at the beginning or pattern c:\ resp. c:/ |
| 282 | - if( '/' !== $path[0] |
|
| 282 | + if ('/' !== $path[0] |
|
| 283 | 283 | && !(3 < strlen($path) && ctype_alpha($path[0]) |
| 284 | 284 | && $path[1] === ':' && ('\\' === $path[2] || '/' === $path[2])) |
| 285 | 285 | ) { |
| 286 | 286 | $path = $this->config->getSystemValue('datadirectory', |
| 287 | - \OC::$SERVERROOT.'/data' ) . '/' . $path; |
|
| 287 | + \OC::$SERVERROOT.'/data').'/'.$path; |
|
| 288 | 288 | } |
| 289 | 289 | //we need it to store it in the DB as well in case a user gets |
| 290 | 290 | //deleted so we can clean up afterwards |
@@ -294,11 +294,11 @@ discard block |
||
| 294 | 294 | return $path; |
| 295 | 295 | } |
| 296 | 296 | |
| 297 | - if( !is_null($attr) |
|
| 297 | + if (!is_null($attr) |
|
| 298 | 298 | && $this->config->getAppValue('user_ldap', 'enforce_home_folder_naming_rule', true) |
| 299 | 299 | ) { |
| 300 | 300 | // a naming rule attribute is defined, but it doesn't exist for that LDAP user |
| 301 | - throw new \Exception('Home dir attribute can\'t be read from LDAP for uid: ' . $this->getUsername()); |
|
| 301 | + throw new \Exception('Home dir attribute can\'t be read from LDAP for uid: '.$this->getUsername()); |
|
| 302 | 302 | } |
| 303 | 303 | |
| 304 | 304 | //false will apply default behaviour as defined and done by OC_User |
@@ -309,7 +309,7 @@ discard block |
||
| 309 | 309 | public function getMemberOfGroups() { |
| 310 | 310 | $cacheKey = 'getMemberOf'.$this->getUsername(); |
| 311 | 311 | $memberOfGroups = $this->connection->getFromCache($cacheKey); |
| 312 | - if(!is_null($memberOfGroups)) { |
|
| 312 | + if (!is_null($memberOfGroups)) { |
|
| 313 | 313 | return $memberOfGroups; |
| 314 | 314 | } |
| 315 | 315 | $groupDNs = $this->access->readAttribute($this->getDN(), 'memberOf'); |
@@ -322,15 +322,15 @@ discard block |
||
| 322 | 322 | * @return string data (provided by LDAP) | false |
| 323 | 323 | */ |
| 324 | 324 | public function getAvatarImage() { |
| 325 | - if(!is_null($this->avatarImage)) { |
|
| 325 | + if (!is_null($this->avatarImage)) { |
|
| 326 | 326 | return $this->avatarImage; |
| 327 | 327 | } |
| 328 | 328 | |
| 329 | 329 | $this->avatarImage = false; |
| 330 | 330 | $attributes = array('jpegPhoto', 'thumbnailPhoto'); |
| 331 | - foreach($attributes as $attribute) { |
|
| 331 | + foreach ($attributes as $attribute) { |
|
| 332 | 332 | $result = $this->access->readAttribute($this->dn, $attribute); |
| 333 | - if($result !== false && is_array($result) && isset($result[0])) { |
|
| 333 | + if ($result !== false && is_array($result) && isset($result[0])) { |
|
| 334 | 334 | $this->avatarImage = $result[0]; |
| 335 | 335 | break; |
| 336 | 336 | } |
@@ -368,7 +368,7 @@ discard block |
||
| 368 | 368 | self::USER_PREFKEY_LASTREFRESH, 0); |
| 369 | 369 | |
| 370 | 370 | //TODO make interval configurable |
| 371 | - if((time() - intval($lastChecked)) < 86400 ) { |
|
| 371 | + if ((time() - intval($lastChecked)) < 86400) { |
|
| 372 | 372 | return false; |
| 373 | 373 | } |
| 374 | 374 | return true; |
@@ -394,8 +394,8 @@ discard block |
||
| 394 | 394 | */ |
| 395 | 395 | public function composeAndStoreDisplayName($displayName, $displayName2 = '') { |
| 396 | 396 | $displayName2 = strval($displayName2); |
| 397 | - if($displayName2 !== '') { |
|
| 398 | - $displayName .= ' (' . $displayName2 . ')'; |
|
| 397 | + if ($displayName2 !== '') { |
|
| 398 | + $displayName .= ' ('.$displayName2.')'; |
|
| 399 | 399 | } |
| 400 | 400 | $this->store('displayName', $displayName); |
| 401 | 401 | return $displayName; |
@@ -417,7 +417,7 @@ discard block |
||
| 417 | 417 | * @return bool |
| 418 | 418 | */ |
| 419 | 419 | private function wasRefreshed($feature) { |
| 420 | - if(isset($this->refreshedFeatures[$feature])) { |
|
| 420 | + if (isset($this->refreshedFeatures[$feature])) { |
|
| 421 | 421 | return true; |
| 422 | 422 | } |
| 423 | 423 | $this->refreshedFeatures[$feature] = 1; |
@@ -430,15 +430,15 @@ discard block |
||
| 430 | 430 | * @return null |
| 431 | 431 | */ |
| 432 | 432 | public function updateEmail($valueFromLDAP = null) { |
| 433 | - if($this->wasRefreshed('email')) { |
|
| 433 | + if ($this->wasRefreshed('email')) { |
|
| 434 | 434 | return; |
| 435 | 435 | } |
| 436 | 436 | $email = strval($valueFromLDAP); |
| 437 | - if(is_null($valueFromLDAP)) { |
|
| 437 | + if (is_null($valueFromLDAP)) { |
|
| 438 | 438 | $emailAttribute = $this->connection->ldapEmailAttribute; |
| 439 | 439 | if ($emailAttribute !== '') { |
| 440 | 440 | $aEmail = $this->access->readAttribute($this->dn, $emailAttribute); |
| 441 | - if(is_array($aEmail) && (count($aEmail) > 0)) { |
|
| 441 | + if (is_array($aEmail) && (count($aEmail) > 0)) { |
|
| 442 | 442 | $email = strval($aEmail[0]); |
| 443 | 443 | } |
| 444 | 444 | } |
@@ -461,7 +461,7 @@ discard block |
||
| 461 | 461 | * @return null |
| 462 | 462 | */ |
| 463 | 463 | public function updateQuota($valueFromLDAP = null) { |
| 464 | - if($this->wasRefreshed('quota')) { |
|
| 464 | + if ($this->wasRefreshed('quota')) { |
|
| 465 | 465 | return; |
| 466 | 466 | } |
| 467 | 467 | //can be null |
@@ -469,16 +469,16 @@ discard block |
||
| 469 | 469 | $quota = $quotaDefault !== '' ? $quotaDefault : null; |
| 470 | 470 | $quota = !is_null($valueFromLDAP) ? $valueFromLDAP : $quota; |
| 471 | 471 | |
| 472 | - if(is_null($valueFromLDAP)) { |
|
| 472 | + if (is_null($valueFromLDAP)) { |
|
| 473 | 473 | $quotaAttribute = $this->connection->ldapQuotaAttribute; |
| 474 | 474 | if ($quotaAttribute !== '') { |
| 475 | 475 | $aQuota = $this->access->readAttribute($this->dn, $quotaAttribute); |
| 476 | - if($aQuota && (count($aQuota) > 0)) { |
|
| 476 | + if ($aQuota && (count($aQuota) > 0)) { |
|
| 477 | 477 | $quota = $aQuota[0]; |
| 478 | 478 | } |
| 479 | 479 | } |
| 480 | 480 | } |
| 481 | - if(!is_null($quota)) { |
|
| 481 | + if (!is_null($quota)) { |
|
| 482 | 482 | $this->userManager->get($this->uid)->setQuota($quota); |
| 483 | 483 | } |
| 484 | 484 | } |
@@ -489,7 +489,7 @@ discard block |
||
| 489 | 489 | * @param array $params |
| 490 | 490 | */ |
| 491 | 491 | public function updateAvatarPostLogin($params) { |
| 492 | - if(isset($params['uid']) && $params['uid'] === $this->getUsername()) { |
|
| 492 | + if (isset($params['uid']) && $params['uid'] === $this->getUsername()) { |
|
| 493 | 493 | $this->updateAvatar(); |
| 494 | 494 | } |
| 495 | 495 | } |
@@ -499,11 +499,11 @@ discard block |
||
| 499 | 499 | * @return null |
| 500 | 500 | */ |
| 501 | 501 | public function updateAvatar() { |
| 502 | - if($this->wasRefreshed('avatar')) { |
|
| 502 | + if ($this->wasRefreshed('avatar')) { |
|
| 503 | 503 | return; |
| 504 | 504 | } |
| 505 | 505 | $avatarImage = $this->getAvatarImage(); |
| 506 | - if($avatarImage === false) { |
|
| 506 | + if ($avatarImage === false) { |
|
| 507 | 507 | //not set, nothing left to do; |
| 508 | 508 | return; |
| 509 | 509 | } |
@@ -516,18 +516,18 @@ discard block |
||
| 516 | 516 | * @return null |
| 517 | 517 | */ |
| 518 | 518 | private function setOwnCloudAvatar() { |
| 519 | - if(!$this->image->valid()) { |
|
| 519 | + if (!$this->image->valid()) { |
|
| 520 | 520 | $this->log->log('jpegPhoto data invalid for '.$this->dn, \OCP\Util::ERROR); |
| 521 | 521 | return; |
| 522 | 522 | } |
| 523 | 523 | //make sure it is a square and not bigger than 128x128 |
| 524 | 524 | $size = min(array($this->image->width(), $this->image->height(), 128)); |
| 525 | - if(!$this->image->centerCrop($size)) { |
|
| 525 | + if (!$this->image->centerCrop($size)) { |
|
| 526 | 526 | $this->log->log('croping image for avatar failed for '.$this->dn, \OCP\Util::ERROR); |
| 527 | 527 | return; |
| 528 | 528 | } |
| 529 | 529 | |
| 530 | - if(!$this->fs->isLoaded()) { |
|
| 530 | + if (!$this->fs->isLoaded()) { |
|
| 531 | 531 | $this->fs->setup($this->uid); |
| 532 | 532 | } |
| 533 | 533 | |
@@ -536,7 +536,7 @@ discard block |
||
| 536 | 536 | $avatar->set($this->image); |
| 537 | 537 | } catch (\Exception $e) { |
| 538 | 538 | \OC::$server->getLogger()->notice( |
| 539 | - 'Could not set avatar for ' . $this->dn . ', because: ' . $e->getMessage(), |
|
| 539 | + 'Could not set avatar for '.$this->dn.', because: '.$e->getMessage(), |
|
| 540 | 540 | ['app' => 'user_ldap']); |
| 541 | 541 | } |
| 542 | 542 | } |