EGroupware /
egroupware
| Total Complexity | 220 |
| Total Lines | 1214 |
| Duplicated Lines | 0 % |
| Changes | 0 | ||
Complex classes like Ads often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Ads, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 39 | class Ads |
||
| 40 | { |
||
| 41 | /** |
||
| 42 | * Instance of adLDAP class |
||
| 43 | * |
||
| 44 | * @var adLDAP |
||
| 45 | */ |
||
| 46 | private $adldap; |
||
| 47 | /** |
||
| 48 | * total number of found entries from get_list method |
||
| 49 | * |
||
| 50 | * @var int |
||
| 51 | */ |
||
| 52 | public $total; |
||
| 53 | |||
| 54 | /** |
||
| 55 | * Reference to our frontend |
||
| 56 | * |
||
| 57 | * @var Api\Accounts |
||
| 58 | */ |
||
| 59 | protected $frontend; |
||
| 60 | |||
| 61 | /** |
||
| 62 | * Value of expires attribute for never |
||
| 63 | */ |
||
| 64 | const EXPIRES_NEVER = '9223372036854775807'; |
||
| 65 | |||
| 66 | /** |
||
| 67 | * AD does NOT allow to change sAMAccountName / account_lid |
||
| 68 | */ |
||
| 69 | const CHANGE_ACCOUNT_LID = false; |
||
| 70 | |||
| 71 | /** |
||
| 72 | * Backend requires password to be set, before allowing to enable an account |
||
| 73 | */ |
||
| 74 | const REQUIRE_PASSWORD_FOR_ENABLE = true; |
||
| 75 | |||
| 76 | /** |
||
| 77 | * Attributes to query to be able to generate account_id and account_lid |
||
| 78 | * |
||
| 79 | * @var array |
||
| 80 | */ |
||
| 81 | protected static $default_attributes = array( |
||
| 82 | 'objectsid', 'samaccounttype', 'samaccountname', |
||
| 83 | ); |
||
| 84 | |||
| 85 | /** |
||
| 86 | * Attributes to query for a user (need to contain $default_attributes!) |
||
| 87 | * |
||
| 88 | * @var array |
||
| 89 | */ |
||
| 90 | protected static $user_attributes = array( |
||
| 91 | 'objectsid', 'samaccounttype', 'samaccountname', |
||
| 92 | 'primarygroupid', 'givenname', 'sn', 'mail', 'displayname', 'telephonenumber', |
||
| 93 | 'objectguid', 'useraccountcontrol', 'accountexpires', 'pwdlastset', 'whencreated', 'whenchanged', |
||
| 94 | ); |
||
| 95 | |||
| 96 | /** |
||
| 97 | * Attributes to query for a group (need to contain $default_attributes!) |
||
| 98 | * |
||
| 99 | * @var array |
||
| 100 | */ |
||
| 101 | protected static $group_attributes = array( |
||
| 102 | 'objectsid', 'samaccounttype', 'samaccountname', |
||
| 103 | 'objectguid', 'mail', 'whencreated', 'whenchanged', 'description', |
||
| 104 | ); |
||
| 105 | |||
| 106 | /** |
||
| 107 | * All users with an account_id below that get ignored, because they are system users (incl. 501="Administrator") |
||
| 108 | */ |
||
| 109 | const MIN_ACCOUNT_ID = 1000; |
||
| 110 | |||
| 111 | /** |
||
| 112 | * Enable extra debug messages via error_log (error always get logged) |
||
| 113 | */ |
||
| 114 | public static $debug = false; |
||
| 115 | |||
| 116 | /** |
||
| 117 | * Constructor |
||
| 118 | * |
||
| 119 | * @param Api\Accounts $frontend reference to the frontend class, to be able to call it's methods if needed |
||
| 120 | * @throws adLDAPException |
||
| 121 | */ |
||
| 122 | function __construct(Api\Accounts $frontend) |
||
| 127 | } |
||
| 128 | |||
| 129 | /** |
||
| 130 | * Factory method and singelton to get adLDAP object for given configuration or default server config |
||
| 131 | * |
||
| 132 | * @param array $config=null values for keys 'ads_domain', 'ads_host' (required) and optional 'ads_admin_user', 'ads_admin_passwd', 'ads_connection' |
||
| 133 | * @return adLDAP |
||
| 134 | * @throws adLDAPException |
||
| 135 | */ |
||
| 136 | public static function get_adldap(array &$config=null) |
||
| 137 | { |
||
| 138 | static $adldap = array(); |
||
| 139 | if (!$config) $config =& $GLOBALS['egw_info']['server']; |
||
| 140 | |||
| 141 | if (!isset($adldap[$config['ads_domain']])) |
||
| 142 | { |
||
| 143 | if (empty($config['ads_host'])) throw new Api\Exception("Required ADS host name(s) missing!"); |
||
| 144 | if (empty($config['ads_domain'])) throw new Api\Exception("Required ADS domain missing!"); |
||
| 145 | |||
| 146 | $base_dn_parts = array(); |
||
| 147 | foreach(explode('.', $config['ads_domain']) as $dc) |
||
| 148 | { |
||
| 149 | $base_dn_parts[] = 'DC='.$dc; |
||
| 150 | } |
||
| 151 | $base_dn = implode(',', $base_dn_parts); |
||
| 152 | |||
| 153 | // check if a port is specified as host[:port] and pass it correctly to adLDAP |
||
| 154 | $matches = null; |
||
| 155 | if (preg_match('/:(\d+)/', $host=$config['ads_host'], $matches)) |
||
| 156 | { |
||
| 157 | $port = $matches[1]; |
||
| 158 | $host = preg_replace('/:(\d+)/', '', $config['ads_host']); |
||
| 159 | } |
||
| 160 | $options = array( |
||
| 161 | 'domain_controllers' => preg_split('/[ ,]+/', $host), |
||
| 162 | 'base_dn' => $base_dn ? $base_dn : null, |
||
| 163 | 'account_suffix' => '@'.$config['ads_domain'], |
||
| 164 | 'admin_username' => $config['ads_admin_user'], |
||
| 165 | 'admin_password' => $config['ads_admin_passwd'], |
||
| 166 | 'use_tls' => $config['ads_connection'] == 'tls', |
||
| 167 | 'use_ssl' => $config['ads_connection'] == 'ssl', |
||
| 168 | 'charset' => Api\Translation::charset(), |
||
| 169 | ); |
||
| 170 | if (isset($port)) $options['ad_port'] = $port; |
||
| 171 | |||
| 172 | $adldap[$config['ads_domain']] = new adLDAP($options); |
||
| 173 | if (self::$debug) error_log(__METHOD__."() new adLDAP(".array2string($options).") returned ".array2string($adldap[$config['ads_domain']]).' '.function_backtrace()); |
||
| 174 | } |
||
| 175 | //else error_log(__METHOD__."() returning cached adLDAP ".array2string($adldap[$config['ads_domain']]).' '.function_backtrace()); |
||
| 176 | return $adldap[$config['ads_domain']]; |
||
| 177 | } |
||
| 178 | |||
| 179 | /** |
||
| 180 | * Get SID of domain or an account |
||
| 181 | * |
||
| 182 | * @param int $account_id |
||
| 183 | * @return string|NULL |
||
| 184 | */ |
||
| 185 | protected function get_sid($account_id=null) |
||
| 186 | { |
||
| 187 | static $domain_sid = null; |
||
| 188 | if (!isset($domain_sid)) |
||
| 189 | { |
||
| 190 | $domain_sid = Api\Cache::getCache($this->frontend->config['install_id'], __CLASS__, 'ads_domain_sid'); |
||
| 191 | if ((!is_array($domain_sid) || !isset($domain_sid[$this->frontend->config['ads_domain']])) && |
||
| 192 | ($adldap = self::get_adldap($this->frontend->config)) && |
||
| 193 | ($sr = ldap_search($adldap->getLdapConnection(), $adldap->getBaseDn(), '(objectclass=domain)', array('objectsid'))) && |
||
| 194 | (($entries = ldap_get_entries($adldap->getLdapConnection(), $sr)) || true)) |
||
| 195 | { |
||
| 196 | $domain_sid = array(); |
||
| 197 | $domain_sid[$this->frontend->config['ads_domain']] = $adldap->utilities()->getTextSID($entries[0]['objectsid'][0]); |
||
| 198 | Api\Cache::setCache($this->frontend->config['install_id'], __CLASS__, 'ads_domain_sid', $domain_sid); |
||
| 199 | } |
||
| 200 | } |
||
| 201 | $sid = $domain_sid[$this->frontend->config['ads_domain']]; |
||
| 202 | if ($sid && abs($account_id)) |
||
| 203 | { |
||
| 204 | $sid .= '-'.abs($account_id); |
||
| 205 | } |
||
| 206 | return $sid; |
||
| 207 | } |
||
| 208 | |||
| 209 | const DOMAIN_USERS_GROUP = 513; |
||
| 210 | const ADS_CONTEXT = 'ads_context'; |
||
| 211 | |||
| 212 | /** |
||
| 213 | * Get context for user and group objects |
||
| 214 | * |
||
| 215 | * Can be set via server-config "ads_context", otherwise baseDN is used |
||
| 216 | * |
||
| 217 | * @param boolean $set_if_empty =false true set from DN of "Domain Users" group # |
||
| 218 | * @return string |
||
| 219 | */ |
||
| 220 | public function ads_context($set_if_empty=false) |
||
| 221 | { |
||
| 222 | if (empty($this->frontend->config[self::ADS_CONTEXT])) |
||
| 223 | { |
||
| 224 | if ($set_if_empty && ($dn = $this->id2name(-self::DOMAIN_USERS_GROUP, 'account_dn'))) |
||
| 225 | { |
||
| 226 | $dn = preg_replace('/^CN=.*?,(CN|OU)=/i', '$1=', $dn); |
||
| 227 | Api\Config::save_value(self::ADS_CONTEXT, $this->frontend->config[self::ADS_CONTEXT]=$dn, 'phpgwapi'); |
||
| 228 | } |
||
| 229 | else |
||
| 230 | { |
||
| 231 | return $this->adldap->getBaseDn(); |
||
| 232 | } |
||
| 233 | } |
||
| 234 | return $this->frontend->config[self::ADS_CONTEXT]; |
||
| 235 | } |
||
| 236 | |||
| 237 | /** |
||
| 238 | * Get container for new user and group objects |
||
| 239 | * |
||
| 240 | * Can be set via server-config "ads_context", otherwise parent of DN from "Domain Users" is used |
||
| 241 | * |
||
| 242 | * @return string |
||
| 243 | */ |
||
| 244 | protected function _get_container() |
||
| 245 | { |
||
| 246 | $context = $this->ads_context(true); |
||
| 247 | $base = $this->adldap->getBaseDn(); |
||
| 248 | $matches = null; |
||
| 249 | if (!preg_match('/^(.*),'.preg_quote($base, '/').'$/i', $context, $matches)) |
||
| 250 | { |
||
| 251 | throw new Api\Exception\WrongUserinput("Wrong or not configured ADS context '$context' (baseDN='$base')!"); |
||
| 252 | } |
||
| 253 | $container = $matches[1]; |
||
| 254 | if (self::$debug) error_log(__METHOD__."() context='$context', base='$base' returning ".array2string($container)); |
||
| 255 | return $container; |
||
| 256 | } |
||
| 257 | |||
| 258 | /** |
||
| 259 | * Get connection to ldap server from adLDAP |
||
| 260 | * |
||
| 261 | * @param boolean $reconnect =false true: reconnect even if already connected |
||
| 262 | * @return resource |
||
| 263 | */ |
||
| 264 | public function ldap_connection($reconnect=false) |
||
| 265 | { |
||
| 266 | if (($reconnect || !($ds = $this->adldap->getLdapConnection())) && |
||
|
introduced
by
|
|||
| 267 | // call connect, thought I dont know how it can be not connected ... |
||
| 268 | !$this->adldap->connect() || !($ds = $this->adldap->getLdapConnection())) |
||
| 269 | { |
||
| 270 | error_log(__METHOD__."() !this->adldap->getLdapConnection() this->adldap=".array2string($this->adldap)); |
||
| 271 | } |
||
| 272 | return $ds; |
||
| 273 | } |
||
| 274 | |||
| 275 | /** |
||
| 276 | * Get GUID from SID, as adLDAP only works on GUID not SID currently |
||
| 277 | * |
||
| 278 | * @param string $sid |
||
| 279 | * @return string|NULL |
||
| 280 | */ |
||
| 281 | /*protected function sid2guid($sid) |
||
| 282 | { |
||
| 283 | if (($sr = ldap_search($this->adldap->getLdapConnection(), $this->ads_context(), 'objectsid='.$sid, array('objectguid'))) && |
||
| 284 | ($entries = ldap_get_entries($this->adldap->getLdapConnection(), $sr))) |
||
| 285 | { |
||
| 286 | return $this->adldap->utilities()->decodeGuid($entries[0]['objectguid'][0]); |
||
| 287 | } |
||
| 288 | return null; |
||
| 289 | }*/ |
||
| 290 | |||
| 291 | /** |
||
| 292 | * Convert SID to account_id (RID = last part of SID) |
||
| 293 | * |
||
| 294 | * @param string $sid |
||
| 295 | * @return int |
||
| 296 | */ |
||
| 297 | public static function sid2account_id($sid) |
||
| 298 | { |
||
| 299 | $parts = explode('-', $sid); |
||
| 300 | |||
| 301 | return (int)array_pop($parts); |
||
| 302 | } |
||
| 303 | |||
| 304 | /** |
||
| 305 | * Convert binary SID to account_id (RID = last part of SID) |
||
| 306 | * |
||
| 307 | * @param string $objectsid |
||
| 308 | * @return int |
||
| 309 | */ |
||
| 310 | public function objectsid2account_id($objectsid) |
||
| 311 | { |
||
| 312 | $sid = $this->adldap->utilities()->getTextSID(is_array($objectsid) ? $objectsid[0] : $objectsid); |
||
| 313 | |||
| 314 | return self::sid2account_id($sid); |
||
| 315 | } |
||
| 316 | |||
| 317 | /** |
||
| 318 | * Convert binary GUID to string |
||
| 319 | * |
||
| 320 | * @param string $objectguid |
||
| 321 | * @return int |
||
| 322 | */ |
||
| 323 | public function objectguid2str($objectguid) |
||
| 324 | { |
||
| 325 | return $this->adldap->utilities()->decodeGuid(is_array($objectguid) ? $objectguid[0] : $objectguid); |
||
| 326 | } |
||
| 327 | |||
| 328 | /** |
||
| 329 | * Convert a string GUID to hex string used in filter |
||
| 330 | * |
||
| 331 | * @param string $strGUID |
||
| 332 | * @return int |
||
| 333 | */ |
||
| 334 | public function objectguid2hex($strGUID) |
||
| 335 | { |
||
| 336 | return $this->adldap->utilities()->strGuidToHex($strGUID); |
||
| 337 | } |
||
| 338 | |||
| 339 | /** |
||
| 340 | * Reads the data of one account |
||
| 341 | * |
||
| 342 | * @param int $account_id numeric account-id |
||
| 343 | * @return array|boolean array with account data (keys: account_id, account_lid, ...) or false if account not found |
||
| 344 | */ |
||
| 345 | public function read($account_id) |
||
| 346 | { |
||
| 347 | if (!(int)$account_id) return false; |
||
| 348 | |||
| 349 | $ret = $account_id < 0 ? $this->_read_group($account_id) : $this->_read_user($account_id); |
||
| 350 | if (self::$debug) error_log(__METHOD__."($account_id) returning ".array2string($ret)); |
||
| 351 | return $ret; |
||
| 352 | } |
||
| 353 | |||
| 354 | /** |
||
| 355 | * Saves / adds the data of one account |
||
| 356 | * |
||
| 357 | * If no account_id is set in data the account is added and the new id is set in $data. |
||
| 358 | * |
||
| 359 | * @param array $data array with account-data |
||
| 360 | * @return int|boolean the account_id or false on error |
||
| 361 | */ |
||
| 362 | function save(&$data) |
||
| 363 | { |
||
| 364 | $is_group = $data['account_id'] < 0 || $data['account_type'] === 'g'; |
||
| 365 | $data = Api\Translation::convert($data, Api\Translation::charset(), 'utf-8'); |
||
| 366 | |||
| 367 | if ($data['account_id'] && !($old = $this->read($data['account_id']))) |
||
| 368 | { |
||
| 369 | error_log(__METHOD__.'('.array2string($data).") account NOT found!"); |
||
| 370 | return false; |
||
| 371 | } |
||
| 372 | if ($old) |
||
| 373 | { |
||
| 374 | if (($old['account_type'] == 'g') != $is_group) |
||
| 375 | { |
||
| 376 | error_log(__METHOD__.'('.array2string($data).") changing account-type user <--> group forbidden!"); |
||
| 377 | return false; |
||
| 378 | } |
||
| 379 | $old = Api\Translation::convert($old, Api\Translation::charset(), 'utf-8'); |
||
| 380 | } |
||
| 381 | $ret = $is_group ? $this->_save_group($data, $old) : $this->_save_user($data, $old); |
||
| 382 | |||
| 383 | if (self::$debug) error_log(__METHOD__.'('.array2string($data).') returning '.array2string($ret)); |
||
| 384 | return $ret; |
||
| 385 | } |
||
| 386 | |||
| 387 | /** |
||
| 388 | * Delete one account, deletes also all acl-entries for that account |
||
| 389 | * |
||
| 390 | * @param int $account_id numeric account_id |
||
| 391 | * @return boolean true on success, false otherwise |
||
| 392 | */ |
||
| 393 | function delete($account_id) |
||
| 394 | { |
||
| 395 | if (!(int)$account_id || !($account_lid = $this->id2name($account_id))) |
||
| 396 | { |
||
| 397 | error_log(__METHOD__."($account_id) NOT found!"); |
||
| 398 | return false; |
||
| 399 | } |
||
| 400 | |||
| 401 | // for some reason deleting fails with "ldap_search(): supplied argument is not a valid ldap link resource" |
||
| 402 | // forcing a reconnect fixes it ;-) |
||
| 403 | $this->ldap_connection(true); |
||
| 404 | |||
| 405 | if ($account_id < 0) |
||
| 406 | { |
||
| 407 | $ret = $this->adldap->group()->delete($account_lid); |
||
| 408 | } |
||
| 409 | else |
||
| 410 | { |
||
| 411 | $ret = $this->adldap->user()->delete($account_lid); |
||
| 412 | } |
||
| 413 | if (self::$debug) error_log(__METHOD__."($account_id) account_lid='$account_lid' returning ".array2string($ret)); |
||
| 414 | return $ret; |
||
| 415 | } |
||
| 416 | |||
| 417 | /** |
||
| 418 | * Convert ldap data of a group |
||
| 419 | * |
||
| 420 | * @param array $_data |
||
| 421 | * @return array |
||
| 422 | */ |
||
| 423 | protected function _ldap2group($_data) |
||
| 424 | { |
||
| 425 | $data = Api\Translation::convert($_data, 'utf-8'); |
||
| 426 | |||
| 427 | // no need to calculate sid, if already calculated |
||
| 428 | $sid = is_string($data['objectsid']) ? $data['objectsid'] : |
||
| 429 | $this->adldap->utilities()->getTextSID($data['objectsid'][0]); |
||
| 430 | $account_id = -self::sid2account_id($sid); |
||
| 431 | |||
| 432 | $group = array( |
||
| 433 | 'account_dn' => $data['dn'], |
||
| 434 | 'account_id' => $account_id, |
||
| 435 | 'account_sid' => $sid, |
||
| 436 | 'account_guid' => $this->adldap->utilities()->decodeGuid($data['objectguid'][0]), |
||
| 437 | 'account_lid' => $data['samaccountname'][0], |
||
| 438 | 'account_type' => 'g', |
||
| 439 | 'account_firstname' => $data['samaccountname'][0], |
||
| 440 | 'account_lastname' => lang('Group'), |
||
| 441 | 'account_fullname' => lang('Group').' '.$data['samaccountname'][0], |
||
| 442 | 'account_email' => $data['mail'][0], |
||
| 443 | 'account_created' => !isset($data['whencreated'][0]) ? null : |
||
| 444 | self::_when2ts($data['whencreated'][0]), |
||
| 445 | 'account_modified' => !isset($data['whenchanged'][0]) ? null : |
||
| 446 | self::_when2ts($data['whenchanged'][0]), |
||
| 447 | 'account_description' => $data['description'][0], |
||
| 448 | 'mailAllowed' => true, |
||
| 449 | ); |
||
| 450 | //error_log(__METHOD__."(".array2string($data).") returning ".array2string($group)); |
||
| 451 | return $group; |
||
| 452 | } |
||
| 453 | |||
| 454 | /** |
||
| 455 | * Reads the data of one group |
||
| 456 | * |
||
| 457 | * @internal |
||
| 458 | * @todo take recursive group memberships into account |
||
| 459 | * @param int $account_id numeric account-id (< 0 as it's for a group) |
||
| 460 | * @return array|boolean array with account data (keys: account_id, account_lid, ...) or false if account not found |
||
| 461 | */ |
||
| 462 | protected function _read_group($account_id) |
||
| 463 | { |
||
| 464 | if (!($data = $this->filter(array('objectsid' => $this->get_sid($account_id)), 'g', self::$group_attributes))) |
||
| 465 | { |
||
| 466 | return false; // group not found |
||
| 467 | } |
||
| 468 | $group = $this->_ldap2group(array_shift($data)); |
||
| 469 | |||
| 470 | // for memberships we have to query primaryGroupId and memberOf of users |
||
| 471 | $group['members'] = $this->filter(array('memberOf' => $group['account_dn']), 'u'); |
||
| 472 | // primary group is not stored in memberOf attribute, need to add them too |
||
| 473 | $group['members'] = $this->filter(array('primaryGroupId' => abs($account_id)), 'u', null, $group['members']); |
||
| 474 | |||
| 475 | return $group; |
||
| 476 | } |
||
| 477 | |||
| 478 | /** |
||
| 479 | * Convert ldap data of a user |
||
| 480 | * |
||
| 481 | * @param array $_data |
||
| 482 | * @return array |
||
| 483 | */ |
||
| 484 | protected function _ldap2user(array $_data) |
||
| 485 | { |
||
| 486 | $data = Api\Translation::convert($_data, 'utf-8'); |
||
| 487 | |||
| 488 | // no need to calculate sid, if already calculated |
||
| 489 | $sid = is_string($data['objectsid']) ? $data['objectsid'] : |
||
| 490 | $this->adldap->utilities()->getTextSID($data['objectsid'][0]); |
||
| 491 | $account_id = self::sid2account_id($sid); |
||
| 492 | |||
| 493 | $user = array( |
||
| 494 | 'account_dn' => $data['dn'], |
||
| 495 | 'account_id' => $account_id, |
||
| 496 | 'account_sid' => $sid, |
||
| 497 | 'account_guid' => $this->adldap->utilities()->decodeGuid($data['objectguid'][0]), |
||
| 498 | 'account_lid' => $data['samaccountname'][0], |
||
| 499 | 'account_type' => 'u', |
||
| 500 | 'account_primary_group' => (string)-$data['primarygroupid'][0], |
||
| 501 | 'account_firstname' => $data['givenname'][0], |
||
| 502 | 'account_lastname' => $data['sn'][0], |
||
| 503 | 'account_email' => $data['mail'][0], |
||
| 504 | 'account_fullname' => $data['displayname'][0], |
||
| 505 | 'account_phone' => $data['telephonenumber'][0], |
||
| 506 | 'account_status' => $data['useraccountcontrol'][0] & 2 ? false : 'A', |
||
| 507 | 'account_expires' => !isset($data['accountexpires']) || !$data['accountexpires'][0] || |
||
| 508 | $data['accountexpires'][0] == self::EXPIRES_NEVER ? -1 : |
||
| 509 | $this->adldap->utilities()->convertWindowsTimeToUnixTime($data['accountexpires'][0]), |
||
| 510 | 'account_lastpwd_change' => !isset($data['pwdlastset']) ? null : (!$data['pwdlastset'][0] ? 0 : |
||
| 511 | $this->adldap->utilities()->convertWindowsTimeToUnixTime($data['pwdlastset'][0])), |
||
| 512 | 'account_created' => !isset($data['whencreated'][0]) ? null : |
||
| 513 | self::_when2ts($data['whencreated'][0]), |
||
| 514 | 'account_modified' => !isset($data['whenchanged'][0]) ? null : |
||
| 515 | self::_when2ts($data['whenchanged'][0]), |
||
| 516 | ); |
||
| 517 | // expired accounts are NOT active |
||
| 518 | if ($user['account_expires'] !== -1 && $user['account_expires'] < time()) |
||
| 519 | { |
||
| 520 | $user['account_status'] = false; |
||
| 521 | } |
||
| 522 | $user['person_id'] = $user['account_guid']; // id of contact |
||
| 523 | //error_log(__METHOD__."(".array2string($data).") returning ".array2string($user)); |
||
| 524 | return $user; |
||
| 525 | } |
||
| 526 | |||
| 527 | /** |
||
| 528 | * Check if user is active |
||
| 529 | * |
||
| 530 | * @param array $data values for attributes 'useraccountcontrol' and 'accountexpires' |
||
| 531 | * @return boolean true if user is active, false otherwise |
||
| 532 | */ |
||
| 533 | public function user_active(array $data) |
||
| 534 | { |
||
| 535 | $user = $this->_ldap2user($data); |
||
| 536 | $active = Api\Accounts::is_active($user); |
||
| 537 | //error_log(__METHOD__."(cn={$data['cn'][0]}, useraccountcontrol={$data['useraccountcontrol'][0]}, accountexpires={$data['accountexpires'][0]}) user=".array2string($user)." returning ".array2string($active)); |
||
| 538 | return $active; |
||
| 539 | } |
||
| 540 | |||
| 541 | /** |
||
| 542 | * Reads the data of one user |
||
| 543 | * |
||
| 544 | * @internal |
||
| 545 | * @param int $account_id numeric account-id |
||
| 546 | * @return array|boolean array with account data (keys: account_id, account_lid, ...) or false if account not found |
||
| 547 | */ |
||
| 548 | protected function _read_user($account_id) |
||
| 563 | } |
||
| 564 | |||
| 565 | const WHEN_FORMAT = 'YmdHis'; |
||
| 566 | |||
| 567 | /** |
||
| 568 | * Convert when(Created|Changed) attribute to unix timestamp |
||
| 569 | * |
||
| 570 | * @param string $_when eg. "20130520200000.0Z" |
||
| 571 | * @return int |
||
| 572 | */ |
||
| 573 | protected static function _when2ts($_when) |
||
| 574 | { |
||
| 575 | static $utc=null; |
||
| 576 | if (!isset($utc)) $utc = new \DateTimeZone('UTC'); |
||
| 577 | |||
| 578 | list($when) = explode('.', $_when); // remove .0Z not understood by createFromFormat |
||
| 579 | $datetime = Api\DateTime::createFromFormat(self::WHEN_FORMAT, $when, $utc); |
||
| 580 | if (Api\DateTime::$server_timezone) $datetime->setTimezone(Api\DateTime::$server_timezone); |
||
| 581 | |||
| 582 | return $datetime->getTimestamp(); |
||
| 583 | } |
||
| 584 | |||
| 585 | /** |
||
| 586 | * Saves a group |
||
| 587 | * |
||
| 588 | * @internal |
||
| 589 | * @param array $data array with account-data in utf-8 |
||
| 590 | * @param array $old =null current data |
||
| 591 | * @return int|false account_id or false on error |
||
| 592 | */ |
||
| 593 | protected function _save_group(array &$data, array $old=null) |
||
| 594 | { |
||
| 595 | //error_log(__METHOD__.'('.array2string($data).', old='.array2string($old).')'); |
||
| 596 | |||
| 597 | if (!$old) // new entry |
||
| 598 | { |
||
| 599 | static $new2adldap = array( |
||
| 600 | 'account_lid' => 'group_name', |
||
| 601 | 'account_description' => 'description', |
||
| 602 | ); |
||
| 603 | $attributes = array(); |
||
| 604 | foreach($new2adldap as $egw => $adldap) |
||
| 605 | { |
||
| 606 | $attributes[$adldap] = (string)$data[$egw]; |
||
| 607 | } |
||
| 608 | $attributes['container'] = $this->_get_container(); |
||
| 609 | |||
| 610 | $ret = $this->adldap->group()->create($attributes); |
||
| 611 | if ($ret !== true) |
||
| 612 | { |
||
| 613 | error_log(__METHOD__."(".array2string($data).") adldap->group()->create(".array2string($attributes).') returned '.array2string($ret)); |
||
| 614 | return false; |
||
| 615 | } |
||
| 616 | if (!($ret = $this->name2id($data['account_lid'])) || !($old = $this->read($ret))) |
||
| 617 | { |
||
| 618 | error_log(__METHOD__."(".array2string($data).") newly created group NOT found!"); |
||
| 619 | return false; |
||
| 620 | } |
||
| 621 | } |
||
| 622 | |||
| 623 | // Samba4 does NOT allow to change samaccountname, but CN or DN of a group! |
||
| 624 | // therefore we do NOT allow to change group-name for now (adLDAP also has no method for it) |
||
| 625 | /* check if DN/account_lid changed (not yet supported by adLDAP) |
||
| 626 | if ($old['account_lid'] !== $data['account_lid']) |
||
| 627 | { |
||
| 628 | if (!($ret = ldap_rename($ds=$this->ldap_connection(), $old['account_dn'], |
||
| 629 | 'CN='.$this->adldap->utilities()->ldapSlashes($data['account_lid']), null, true))) |
||
| 630 | { |
||
| 631 | error_log(__METHOD__."(".array2string($data).") rename to new CN failed!"); |
||
| 632 | return false; |
||
| 633 | } |
||
| 634 | }*/ |
||
| 635 | static $egw2adldap = array( |
||
| 636 | //'account_lid' => 'samaccountname', // need to be changed too |
||
| 637 | 'account_email' => 'mail', |
||
| 638 | 'account_description' => 'description', |
||
| 639 | ); |
||
| 640 | $ldap = array(); |
||
| 641 | foreach($egw2adldap as $egw => $adldap) |
||
| 642 | { |
||
| 643 | if (isset($data[$egw]) && (string)$data[$egw] != (string)$old[$egw]) |
||
| 644 | { |
||
| 645 | switch($egw) |
||
| 646 | { |
||
| 647 | case 'account_description': |
||
| 648 | $ldap[$adldap] = !empty($data[$egw]) ? $data[$egw] : array(); |
||
| 649 | break; |
||
| 650 | |||
| 651 | default: |
||
| 652 | $ldap[$adldap] = $data[$egw]; |
||
| 653 | break; |
||
| 654 | } |
||
| 655 | } |
||
| 656 | } |
||
| 657 | // attributes not (yet) suppored by adldap |
||
| 658 | if ($ldap && !($ret = @ldap_modify($ds=$this->ldap_connection(), $old['account_dn'], $ldap))) |
||
| 659 | { |
||
| 660 | error_log(__METHOD__."(".array2string($data).") ldap_modify($ds, '$old[account_dn]', ".array2string($ldap).') returned '.array2string($ret)); |
||
| 661 | return false; |
||
| 662 | } |
||
| 663 | return $old['account_id']; |
||
| 664 | } |
||
| 665 | |||
| 666 | /** |
||
| 667 | * Saves a user account |
||
| 668 | * |
||
| 669 | * @internal |
||
| 670 | * @param array $data array with account-data in utf-8 |
||
| 671 | * @param array $old =null current data |
||
| 672 | * @return int|false account_id or false on error |
||
| 673 | */ |
||
| 674 | protected function _save_user(array &$data, array $old=null) |
||
| 675 | { |
||
| 676 | //error_log(__METHOD__.'('.array2string($data).', old='.array2string($old).')'); |
||
| 677 | if (!isset($data['account_fullname']) && !empty($data['account_firstname']) && !empty($data['account_lastname'])) |
||
| 678 | { |
||
| 679 | $data['account_fullname'] = $data['account_firstname'].' '.$data['account_lastname']; |
||
| 680 | } |
||
| 681 | |||
| 682 | if (($new_entry = !$old)) // new entry |
||
| 683 | { |
||
| 684 | static $new2adldap = array( |
||
| 685 | 'account_lid' => 'username', |
||
| 686 | 'account_firstname' => 'firstname', |
||
| 687 | 'account_lastname' => 'surname', |
||
| 688 | 'account_email' => 'email', |
||
| 689 | 'account_fullname' => 'display_name', |
||
| 690 | 'account_passwd' => 'password', |
||
| 691 | 'account_status' => 'enabled', |
||
| 692 | ); |
||
| 693 | $attributes = array(); |
||
| 694 | foreach($new2adldap as $egw => $adldap) |
||
| 695 | { |
||
| 696 | if ($egw == 'account_passwd' && (empty($data[$egw]) || |
||
| 697 | !$this->adldap->getUseSSL() && !$this->adldap->getUseTLS())) |
||
| 698 | { |
||
| 699 | continue; // do not try to set password, if no SSL or TLS, whole user creation will fail |
||
| 700 | } |
||
| 701 | if (isset($data[$egw])) $attributes[$adldap] = $data[$egw]; |
||
| 702 | } |
||
| 703 | $attributes['enabled'] = !isset($data['account_status']) || $data['account_status'] === 'A'; |
||
| 704 | $attributes['container'] = $this->_get_container(); |
||
| 705 | |||
| 706 | $ret = $this->adldap->user()->create($attributes); |
||
| 707 | if ($ret !== true) |
||
| 708 | { |
||
| 709 | error_log(__METHOD__."(".array2string($data).") adldap->user()->create(".array2string($attributes).') returned '.array2string($ret)); |
||
| 710 | return false; |
||
| 711 | } |
||
| 712 | if (!($ret = $this->name2id($data['account_lid'])) || !($old = $this->read($ret))) |
||
| 713 | { |
||
| 714 | error_log(__METHOD__."(".array2string($data).") newly created user NOT found!"); |
||
| 715 | return false; |
||
| 716 | } |
||
| 717 | $data['account_id'] = $old['account_id']; |
||
| 718 | } |
||
| 719 | // check if DN/account_lid changed (not yet supported by adLDAP) |
||
| 720 | /* disabled as AD does NOT allow to change user-name (account_lid), which is used for DN |
||
| 721 | if (isset($data['account_lid']) && $old['account_lid'] !== $data['account_lid'] || |
||
| 722 | (stripos($old['account_dn'], 'CN='.$data['account_lid'].',') !== 0)) |
||
| 723 | { |
||
| 724 | if (!($ret = ldap_rename($ds=$this->ldap_connection(), $old['account_dn'], |
||
| 725 | 'CN='.$this->adldap->utilities()->ldapSlashes($data['account_lid']), null, true))) |
||
| 726 | { |
||
| 727 | error_log(__METHOD__."(".array2string($data).") rename to new CN failed!"); |
||
| 728 | return false; |
||
| 729 | } |
||
| 730 | }*/ |
||
| 731 | static $egw2adldap = array( |
||
| 732 | 'account_lid' => 'samaccountname', |
||
| 733 | 'account_firstname' => 'firstname', |
||
| 734 | 'account_lastname' => 'surname', |
||
| 735 | 'account_email' => 'email', |
||
| 736 | 'account_fullname' => 'display_name', // handeled currently in rename above, as not supported by adLDAP |
||
| 737 | 'account_passwd' => 'password', |
||
| 738 | 'account_status' => 'enabled', |
||
| 739 | 'account_primary_group' => 'primarygroupid', |
||
| 740 | 'account_expires' => 'expires', |
||
| 741 | //'mustchangepassword'=> 'change_password', // can only set it, but not reset it, therefore we set pwdlastset direct |
||
| 742 | 'account_lastpwd_change' => 'pwdlastset', |
||
| 743 | //'account_phone' => 'telephone', not updated by accounts, only read so far |
||
| 744 | ); |
||
| 745 | $attributes = $ldap = array(); |
||
| 746 | // for a new entry set certain values (eg. profilePath) to in setup configured value |
||
| 747 | if ($new_entry) |
||
| 748 | { |
||
| 749 | foreach($this->frontend->config as $name => $value) |
||
| 750 | { |
||
| 751 | if (substr($name, 0, 8) == 'ads_new_') |
||
| 752 | { |
||
| 753 | $ldap[substr($name, 8)] = str_replace('%u', $data['account_lid'], $value); |
||
| 754 | } |
||
| 755 | } |
||
| 756 | } |
||
| 757 | foreach($egw2adldap as $egw => $adldap) |
||
| 758 | { |
||
| 759 | if (isset($data[$egw]) && (string)$data[$egw] != (string)$old[$egw]) |
||
| 760 | { |
||
| 761 | switch($egw) |
||
| 762 | { |
||
| 763 | case 'account_passwd': |
||
| 764 | if (!empty($data[$egw]) && ($this->adldap->getUseSSL() || $this->adldap->getUseTLS())) |
||
| 765 | { |
||
| 766 | $attributes[$adldap] = $data[$egw]; // only try to set password, if no SSL or TLS |
||
| 767 | } |
||
| 768 | break; |
||
| 769 | case 'account_primary_group': |
||
| 770 | // setting a primary group seems to fail, if user is no member of that group |
||
| 771 | if (isset($old['memberships'][$data[$egw]]) || |
||
| 772 | ($group=$this->id2name($data[$egw])) && $this->adldap->group()->addUser($group, $data['account_id'])) |
||
| 773 | { |
||
| 774 | $old['memberships'][$data[$egw]] = $group; |
||
| 775 | $ldap[$adldap] = abs($data[$egw]); |
||
| 776 | } |
||
| 777 | break; |
||
| 778 | case 'account_lid': |
||
| 779 | $ldap[$adldap] = $data[$egw]; |
||
| 780 | $ldap['userPrincipalName'] = $data[$egw].'@'.$this->frontend->config['ads_domain']; |
||
| 781 | break; |
||
| 782 | case 'account_expires': |
||
| 783 | $attributes[$adldap] = $data[$egw] == -1 ? self::EXPIRES_NEVER : |
||
| 784 | self::convertUnixTimeToWindowsTime($data[$egw]); |
||
| 785 | break; |
||
| 786 | case 'account_status': |
||
| 787 | if ($new_entry && empty($data['account_passwd'])) continue; // cant active new account without passwd! |
||
| 788 | $attributes[$adldap] = $data[$egw] == 'A'; |
||
| 789 | break; |
||
| 790 | case 'account_lastpwd_change': |
||
| 791 | // Samba4 does not understand -1 for current time, but Win2008r2 only allows to set -1 (beside 0) |
||
| 792 | // call Api\Auth\Ads::setLastPwdChange with true to get correct modification for both |
||
| 793 | $ldap = array_merge($ldap, Api\Auth\Ads::setLastPwdChange($data['account_lid'], null, $data[$egw], true)); |
||
| 794 | break; |
||
| 795 | default: |
||
| 796 | $attributes[$adldap] = $data[$egw]; |
||
| 797 | break; |
||
| 798 | } |
||
| 799 | } |
||
| 800 | } |
||
| 801 | // check if we need to update something |
||
| 802 | if ($attributes && !($ret = $this->adldap->user()->modify($data['account_lid'], $attributes))) |
||
| 803 | { |
||
| 804 | error_log(__METHOD__."(".array2string($data).") adldap->user()->modify('$data[account_lid]', ".array2string($attributes).') returned '.array2string($ret).' '.function_backtrace()); |
||
| 805 | return false; |
||
| 806 | } |
||
| 807 | //elseif ($attributes) error_log(__METHOD__."(".array2string($data).") adldap->user()->modify('$data[account_lid]', ".array2string($attributes).') returned '.array2string($ret).' '.function_backtrace()); |
||
| 808 | // attributes not (yet) suppored by adldap |
||
| 809 | if ($ldap && !($ret = @ldap_modify($ds=$this->ldap_connection(), $old['account_dn'], $ldap))) |
||
| 810 | { |
||
| 811 | error_log(__METHOD__."(".array2string($data).") ldap_modify($ds, '$old[account_dn]', ".array2string($ldap).') returned '.array2string($ret).' ('.ldap_error($ds).') '.function_backtrace()); |
||
| 812 | return false; |
||
| 813 | } |
||
| 814 | //elseif ($ldap) error_log(__METHOD__."(".array2string($data).") ldap_modify($ds, '$old[account_dn]', ".array2string($ldap).') returned '.array2string($ret).' '.function_backtrace()); |
||
| 815 | |||
| 816 | //error_log(__METHOD__."(".array2string($data).") returning ".array2string($old['account_id'])); |
||
| 817 | return $old['account_id']; |
||
| 818 | } |
||
| 819 | |||
| 820 | /** |
||
| 821 | * Add seconds between 1601-01-01 and 1970-01-01 and multiply by 10000000 |
||
| 822 | * |
||
| 823 | * @param long $unixTime |
||
| 824 | * @return long windowsTime |
||
| 825 | */ |
||
| 826 | public static function convertUnixTimeToWindowsTime($unixTime) |
||
| 827 | { |
||
| 828 | return ($unixTime + 11644477200) * 10000000; |
||
| 829 | } |
||
| 830 | |||
| 831 | /** |
||
| 832 | * Searches / lists accounts: users and/or groups |
||
| 833 | * |
||
| 834 | * @todo sort and limit query on AD, PHP5.4 and AD support it |
||
| 835 | * |
||
| 836 | * @param array with the following keys: |
||
| 837 | * @param $param['type'] string/int 'accounts', 'groups', 'owngroups' (groups the user is a member of), 'both' |
||
| 838 | * or integer group-id for a list of members of that group |
||
| 839 | * @param $param['start'] int first account to return (returns offset or max_matches entries) or all if not set |
||
| 840 | * @param $param['order'] string column to sort after, default account_lid if unset |
||
| 841 | * @param $param['sort'] string 'ASC' or 'DESC', default 'ASC' if not set |
||
| 842 | * @param $param['query'] string to search for, no search if unset or empty |
||
| 843 | * @param $param['query_type'] string: |
||
| 844 | * 'all' - query all fields for containing $param[query] |
||
| 845 | * 'start' - query all fields starting with $param[query] |
||
| 846 | * 'exact' - query all fields for exact $param[query] |
||
| 847 | * 'lid','firstname','lastname','email' - query only the given field for containing $param[query] |
||
| 848 | * @param $param['offset'] int - number of matches to return if start given, default use the value in the prefs |
||
| 849 | * @param $param['objectclass'] boolean return objectclass(es) under key 'objectclass' in each account |
||
| 850 | * @return array with account_id => data pairs, data is an array with account_id, account_lid, account_firstname, |
||
| 851 | * account_lastname, person_id (id of the linked addressbook entry), account_status, account_expires, account_primary_group |
||
| 852 | */ |
||
| 853 | function search($param) |
||
| 854 | { |
||
| 855 | //error_log(__METHOD__.'('.array2string($param).')'); |
||
| 856 | $account_search = &$this->cache['account_search']; |
||
| 857 | |||
| 858 | // check if the query is cached |
||
| 859 | $serial = serialize($param); |
||
| 860 | if (isset($account_search[$serial])) |
||
| 861 | { |
||
| 862 | $this->total = $account_search[$serial]['total']; |
||
| 863 | return $account_search[$serial]['data']; |
||
| 864 | } |
||
| 865 | // if it's a limited query, check if the unlimited query is cached |
||
| 866 | $start = $param['start']; |
||
| 867 | if (!($maxmatchs = $GLOBALS['egw_info']['user']['preferences']['common']['maxmatchs'])) $maxmatchs = 15; |
||
| 868 | if (!($offset = $param['offset'])) $offset = $maxmatchs; |
||
| 869 | unset($param['start']); |
||
| 870 | unset($param['offset']); |
||
| 871 | $unl_serial = serialize($param); |
||
| 872 | if (isset($account_search[$unl_serial])) |
||
| 873 | { |
||
| 874 | $this->total = $account_search[$unl_serial]['total']; |
||
| 875 | $sortedAccounts = $account_search[$unl_serial]['data']; |
||
| 876 | } |
||
| 877 | else // we need to run the unlimited query |
||
| 878 | { |
||
| 879 | $query = Api\Ldap::quote(strtolower($param['query'])); |
||
| 880 | |||
| 881 | $accounts = array(); |
||
| 882 | if($param['type'] !== 'groups') |
||
| 883 | { |
||
| 884 | if (!empty($query) && $query != '*') |
||
| 885 | { |
||
| 886 | switch($param['query_type']) |
||
| 887 | { |
||
| 888 | case 'all': |
||
| 889 | default: |
||
| 890 | $query = '*'.$query; |
||
| 891 | // fall-through |
||
| 892 | case 'start': |
||
| 893 | $query .= '*'; |
||
| 894 | // fall-through |
||
| 895 | case 'exact': |
||
| 896 | $filter = "(|(samaccountname=$query)(sn=$query)(cn=$query)(givenname=$query)(mail=$query))"; |
||
| 897 | break; |
||
| 898 | case 'firstname': |
||
| 899 | case 'lastname': |
||
| 900 | case 'lid': |
||
| 901 | case 'email': |
||
| 902 | static $to_ldap = array( |
||
| 903 | 'firstname' => 'givenname', |
||
| 904 | 'lastname' => 'sn', |
||
| 905 | 'lid' => 'uid', |
||
| 906 | 'email' => 'mail', |
||
| 907 | ); |
||
| 908 | $filter = '('.$to_ldap[$param['query_type']].'=*'.$query.'*)'; |
||
| 909 | break; |
||
| 910 | } |
||
| 911 | } |
||
| 912 | if (is_numeric($param['type'])) |
||
| 913 | { |
||
| 914 | $membership_filter = '(|(memberOf='.$this->id2name((int)$param['type'], 'account_dn').')(PrimaryGroupId='.abs($param['type']).'))'; |
||
| 915 | $filter = $filter ? "(&$membership_filter$filter)" : $membership_filter; |
||
| 916 | } |
||
| 917 | foreach($this->filter($filter, 'u', self::$user_attributes) as $account_id => $data) |
||
| 918 | { |
||
| 919 | $account = $this->_ldap2user($data); |
||
| 920 | if ($param['active'] && !$this->frontend->is_active($account)) |
||
| 921 | { |
||
| 922 | continue; |
||
| 923 | } |
||
| 924 | $account['account_fullname'] = Api\Accounts::format_username($account['account_lid'],$account['account_firstname'],$account['account_lastname'],$account['account_id']); |
||
| 925 | $accounts[$account_id] = $account; |
||
| 926 | } |
||
| 927 | } |
||
| 928 | if ($param['type'] === 'groups' || $param['type'] === 'both') |
||
| 929 | { |
||
| 930 | $query = Api\Ldap::quote(strtolower($param['query'])); |
||
| 931 | |||
| 932 | $filter = null; |
||
| 933 | if(!empty($query) && $query != '*') |
||
| 934 | { |
||
| 935 | switch($param['query_type']) |
||
| 936 | { |
||
| 937 | case 'all': |
||
| 938 | default: |
||
| 939 | $query = '*'.$query; |
||
| 940 | // fall-through |
||
| 941 | case 'start': |
||
| 942 | $query .= '*'; |
||
| 943 | // fall-through |
||
| 944 | case 'exact': |
||
| 945 | break; |
||
| 946 | } |
||
| 947 | $filter = "(|(cn=$query)(description=$query))"; |
||
| 948 | } |
||
| 949 | foreach($this->filter($filter, 'g', self::$group_attributes) as $account_id => $data) |
||
| 950 | { |
||
| 951 | $accounts[$account_id] = $this->_ldap2group($data); |
||
| 952 | } |
||
| 953 | } |
||
| 954 | // sort the array |
||
| 955 | $this->_callback_sort = strtoupper($param['sort']); |
||
| 956 | $this->_callback_order = empty($param['order']) ? array('account_lid') : explode(',',$param['order']); |
||
| 957 | foreach($this->_callback_order as &$col) |
||
| 958 | { |
||
| 959 | if (substr($col, 0, 8) !== 'account_') $col = 'account_'.$col; |
||
| 960 | } |
||
| 961 | $sortedAccounts = $accounts; |
||
| 962 | uasort($sortedAccounts,array($this,'_sort_callback')); |
||
| 963 | $account_search[$unl_serial]['data'] = $sortedAccounts; |
||
| 964 | |||
| 965 | $account_search[$unl_serial]['total'] = $this->total = count($accounts); |
||
| 966 | } |
||
| 967 | // return only the wanted accounts |
||
| 968 | reset($sortedAccounts); |
||
| 969 | if(is_numeric($start) && is_numeric($offset)) |
||
| 970 | { |
||
| 971 | $account_search[$serial]['data'] = array_slice($sortedAccounts, $start, $offset); |
||
| 972 | $account_search[$serial]['total'] = $this->total; |
||
| 973 | //error_log(__METHOD__.'('.array2string($param).") returning $offset/$this->total entries from $start ".array2string($account_search[$serial]['data'])); |
||
| 974 | return $account_search[$serial]['data']; |
||
| 975 | } |
||
| 976 | //error_log(__METHOD__.'('.array2string($param).') returning all '.array2string($sortedAccounts)); |
||
| 977 | return $sortedAccounts; |
||
| 978 | } |
||
| 979 | |||
| 980 | /** |
||
| 981 | * DESC or ASC |
||
| 982 | * |
||
| 983 | * @var string |
||
| 984 | */ |
||
| 985 | private $_callback_sort = 'ASC'; |
||
| 986 | /** |
||
| 987 | * column_names to sort by |
||
| 988 | * |
||
| 989 | * @var array |
||
| 990 | */ |
||
| 991 | private $_callback_order = array('account_lid'); |
||
| 992 | |||
| 993 | /** |
||
| 994 | * Sort callback for uasort |
||
| 995 | * |
||
| 996 | * @param array $a |
||
| 997 | * @param array $b |
||
| 998 | * @return int |
||
| 999 | */ |
||
| 1000 | protected function _sort_callback($a,$b) |
||
| 1001 | { |
||
| 1002 | foreach($this->_callback_order as $col ) |
||
| 1003 | { |
||
| 1004 | if($this->_callback_sort != 'DESC') |
||
| 1005 | { |
||
| 1006 | $cmp = strcasecmp( $a[$col], $b[$col] ); |
||
| 1007 | } |
||
| 1008 | else |
||
| 1009 | { |
||
| 1010 | $cmp = strcasecmp( $b[$col], $a[$col] ); |
||
| 1011 | } |
||
| 1012 | if ( $cmp != 0 ) |
||
| 1013 | { |
||
| 1014 | return $cmp; |
||
| 1015 | } |
||
| 1016 | } |
||
| 1017 | return 0; |
||
| 1018 | } |
||
| 1019 | |||
| 1020 | /** |
||
| 1021 | * Query ADS by (optional) filter and (optional) account-type filter |
||
| 1022 | * |
||
| 1023 | * All reading ADS queries are done throught this methods. |
||
| 1024 | * |
||
| 1025 | * @param string|array $attr_filter array with attribute => value pairs or filter string or empty |
||
| 1026 | * @param string $account_type u = user, g = group, default null = try both |
||
| 1027 | * @param array $attrs =null default return account_lid, else return raw values from ldap-query |
||
| 1028 | * @param array $accounts =array() array to add filtered accounts too, default empty array |
||
| 1029 | * @return array account_id => account_lid or values for $attrs pairs |
||
| 1030 | */ |
||
| 1031 | protected function filter($attr_filter, $account_type=null, array $attrs=null, array $accounts=array()) |
||
| 1100 | } |
||
| 1101 | |||
| 1102 | /** |
||
| 1103 | * convert an alphanumeric account-value (account_lid, account_email) to the account_id |
||
| 1104 | * |
||
| 1105 | * Please note: |
||
| 1106 | * - if a group and an user have the same account_lid the group will be returned (LDAP only) |
||
| 1107 | * - if multiple user have the same email address, the returned user is undefined |
||
| 1108 | * |
||
| 1109 | * @param string $name value to convert |
||
| 1110 | * @param string $which ='account_lid' type of $name: account_lid (default), account_email, person_id, account_fullname |
||
| 1111 | * @param string $account_type u = user, g = group, default null = try both |
||
| 1112 | * @return int|false numeric account_id or false on error ($name not found) |
||
| 1113 | */ |
||
| 1114 | public function name2id($name, $which='account_lid', $account_type=null) |
||
| 1115 | { |
||
| 1116 | static $to_ldap = array( |
||
| 1117 | 'account_lid' => 'samaccountname', |
||
| 1118 | 'account_email' => 'mail', |
||
| 1119 | 'account_fullname' => 'cn', |
||
| 1120 | 'account_sid' => 'objectsid', |
||
| 1121 | 'account_guid' => 'objectguid', |
||
| 1122 | ); |
||
| 1123 | $ret = false; |
||
| 1124 | if (isset($to_ldap[$which])) |
||
| 1125 | { |
||
| 1126 | foreach($this->filter(array($to_ldap[$which] => $name), $account_type) as $account_id => $account_lid) |
||
| 1127 | { |
||
| 1128 | unset($account_lid); |
||
| 1129 | $ret = $account_id; |
||
| 1130 | break; |
||
| 1131 | } |
||
| 1132 | } |
||
| 1133 | if (self::$debug) error_log(__METHOD__."('$name', '$which', '$account_type') returning ".array2string($ret)); |
||
| 1134 | return $ret; |
||
| 1135 | } |
||
| 1136 | |||
| 1137 | /** |
||
| 1138 | * Convert an numeric account_id to any other value of that account (account_lid, account_email, ...) |
||
| 1139 | * |
||
| 1140 | * Calls frontend which uses (cached) read method to fetch all data by account_id. |
||
| 1141 | * |
||
| 1142 | * @param int $account_id numerica account_id |
||
| 1143 | * @param string $which ='account_lid' type to convert to: account_lid (default), account_email, ... |
||
| 1144 | * @return string/false converted value or false on error ($account_id not found) |
||
| 1145 | */ |
||
| 1146 | public function id2name($account_id, $which='account_lid') |
||
| 1149 | } |
||
| 1150 | |||
| 1151 | /** |
||
| 1152 | * Update the last login timestamps and the IP |
||
| 1153 | * |
||
| 1154 | * @param int $_account_id |
||
| 1155 | * @param string $ip |
||
| 1156 | * @return int lastlogin time |
||
| 1157 | */ |
||
| 1158 | function update_lastlogin($_account_id, $ip) |
||
| 1159 | { |
||
| 1160 | unset($_account_id, $ip); // not used, but required by function signature |
||
| 1161 | |||
| 1162 | return false; // not longer supported |
||
| 1163 | } |
||
| 1164 | |||
| 1165 | /** |
||
| 1166 | * Query memberships of a given account |
||
| 1167 | * |
||
| 1168 | * Calls frontend which uses (cached) read method to fetch all data by account_id. |
||
| 1169 | * |
||
| 1170 | * @param int $account_id |
||
| 1171 | * @return array|boolean array with account_id => account_lid pairs or false if account not found |
||
| 1172 | */ |
||
| 1173 | function memberships($account_id) |
||
| 1174 | { |
||
| 1175 | if (!($data = $this->frontend->read($account_id)) || $data['account_id'] <= 0) return false; |
||
| 1176 | |||
| 1177 | return $data['memberships']; |
||
| 1178 | } |
||
| 1179 | |||
| 1180 | /** |
||
| 1181 | * Query the members of a group |
||
| 1182 | * |
||
| 1183 | * Calls frontend which uses (cached) read method to fetch all data by account_id. |
||
| 1184 | * |
||
| 1185 | * @param int $gid |
||
| 1186 | * @return array with uidnumber => uid pairs |
||
| 1187 | */ |
||
| 1188 | function members($gid) |
||
| 1189 | { |
||
| 1190 | if (!($data = $this->frontend->read($gid)) || $data['account_id'] >= 0) return false; |
||
| 1191 | |||
| 1192 | return $data['members']; |
||
| 1193 | } |
||
| 1194 | |||
| 1195 | /** |
||
| 1196 | * Sets the memberships of the given account |
||
| 1197 | * |
||
| 1198 | * @param array $groups array with gidnumbers |
||
| 1199 | * @param int $account_id uidnumber |
||
| 1200 | * @return int number of added or removed memberships |
||
| 1201 | */ |
||
| 1202 | function set_memberships($groups,$account_id) |
||
| 1203 | { |
||
| 1204 | if (!($account = $this->id2name($account_id))) return; |
||
| 1205 | $current = array_keys($this->memberships($account_id)); |
||
| 1206 | |||
| 1207 | $changed = 0; |
||
| 1208 | foreach(array( |
||
| 1209 | 'add' => array_diff($groups, $current), // add account to all groups he is currently not in |
||
| 1210 | 'remove' => array_diff($current, $groups), // remove account from all groups he is only currently in |
||
| 1211 | ) as $op => $memberships) |
||
| 1212 | { |
||
| 1213 | $func = $op.($account_id > 0 ? 'User' : 'Group'); |
||
| 1214 | foreach($memberships as $gid) |
||
| 1215 | { |
||
| 1216 | $ok = $this->adldap->group()->$func($group=$this->id2name($gid), $account); |
||
| 1217 | //error_log(__METHOD__.'('.array2string($groups).", $account_id) $func('$group', '$account') returned ".array2string($ok)); |
||
| 1218 | $changed += (int)$ok; |
||
| 1219 | } |
||
| 1220 | } |
||
| 1221 | if (self::$debug) error_log(__METHOD__.'('.array2string($groups).", $account_id) current=".array2string($current)." returning $changed"); |
||
| 1222 | return $changed; |
||
| 1223 | } |
||
| 1224 | |||
| 1225 | /** |
||
| 1226 | * Set the members of a group |
||
| 1227 | * |
||
| 1228 | * @param array $users array with uidnumber or uid's |
||
| 1229 | * @param int $gid gidnumber of group to set |
||
| 1230 | * @return int number of added or removed members |
||
| 1231 | */ |
||
| 1232 | function set_members($users, $gid) |
||
| 1253 | } |
||
| 1254 | } |
||
| 1255 | |||
| 1256 | /** |
||
| 1257 | * Fixes and enhancements for adLDAP required by EGroupware |
||
| 1258 | * |
||
| 1259 | * - allow to use utf-8 charset internally, not just an 8-bit iso-charset |
||
| 1260 | * - support for Windows2008r2 (maybe earlier too) and Samba4 "CN=Users" DN as container to create users or groups |
||
| 1261 | */ |
||
| 1262 | class adLDAP extends \adLDAP |
||
| 1263 | { |
||
| 1264 | /** |
||
| 1265 | * Charset used for internal encoding |
||
| 1266 | * |
||
| 1267 | * @var string |
||
| 1268 | */ |
||
| 1269 | public $charset = 'iso-8859-1'; |
||
| 1270 | |||
| 1271 | function __construct(array $options=array()) |
||
| 1272 | { |
||
| 1273 | if (isset($options['charset'])) |
||
| 1674 |
Loading history...