0010622: user contact email is not updated during LDAP sync
[tine20] / tine20 / Tinebase / User.php
1 <?php
2 /**
3  * Tine 2.0
4  * 
5  * @package     Tinebase
6  * @subpackage  User
7  * @license     http://www.gnu.org/licenses/agpl.html AGPL Version 3
8  * @copyright   Copyright (c) 2007-2013 Metaways Infosystems GmbH (http://www.metaways.de)
9  * @author      Lars Kneschke <l.kneschke@metaways.de>
10  */
11
12 /**
13  * User Class
14  *
15  * @package     Tinebase
16  * @subpackage  User
17  */
18 class Tinebase_User
19 {
20     /**
21      * backend constants
22      * 
23      * @var string
24      */
25     const ACTIVEDIRECTORY = 'ActiveDirectory';
26     const LDAP   = 'Ldap';
27     const SQL    = 'Sql';
28     const TYPO3  = 'Typo3';
29     
30     /**
31      * user status constants
32      * 
33      * @var string
34      * 
35      * @todo use constants from model
36      */
37     const STATUS_BLOCKED  = 'blocked';
38     const STATUS_DISABLED = 'disabled';
39     const STATUS_ENABLED  = 'enabled';
40     const STATUS_EXPIRED  = 'expired';
41     
42     /**
43      * Key under which the default user group name setting will be stored/retrieved
44      *
45      */
46     const DEFAULT_USER_GROUP_NAME_KEY = 'defaultUserGroupName';
47     
48     /**
49      * Key under which the default admin group name setting will be stored/retrieved
50      *
51      */
52     const DEFAULT_ADMIN_GROUP_NAME_KEY = 'defaultAdminGroupName';
53     
54     protected static $_contact2UserMapping = array(
55         'n_family'      => 'accountLastName',
56         'n_given'       => 'accountFirstName',
57         'n_fn'          => 'accountFullName',
58         'n_fileas'      => 'accountDisplayName',
59         'email'         => 'accountEmailAddress',
60         'container_id'  => 'container_id',
61     );
62     
63     /**
64      * the constructor
65      *
66      * don't use the constructor. use the singleton 
67      */
68     private function __construct() {}
69     
70     /**
71      * don't clone. Use the singleton.
72      */
73     private function __clone() {}
74
75     /**
76      * holds the instance of the singleton
77      *
78      * @var Tinebase_User_Interface
79      */
80     private static $_instance = NULL;
81
82     /**
83      * Holds the accounts backend type (e.g. Ldap or Sql.
84      * Property is lazy loaded on first access via getter {@see getConfiguredBackend()}
85      * 
86      * @var array | optional
87      */
88     private static $_backendType;
89     
90     /**
91      * Holds the backend configuration options.
92      * Property is lazy loaded from {@see Tinebase_Config} on first access via
93      * getter {@see getBackendConfiguration()}
94      * 
95      * @var array | optional
96      */
97     private static $_backendConfiguration;
98     
99     /**
100      * Holds the backend configuration options.
101      * Property is lazy loaded from {@see Tinebase_Config} on first access via
102      * getter {@see getBackendConfiguration()}
103      * 
104      * @var array | optional
105      */
106     private static $_backendConfigurationDefaults = array(
107         self::SQL => array(
108             self::DEFAULT_USER_GROUP_NAME_KEY  => Tinebase_Group::DEFAULT_USER_GROUP,
109             self::DEFAULT_ADMIN_GROUP_NAME_KEY => Tinebase_Group::DEFAULT_ADMIN_GROUP,
110         ),
111         self::LDAP => array(
112             'host' => 'localhost',
113             'username' => '',
114             'password' => '',
115             'bindRequiresDn' => true,
116             'useRfc2307bis' => false,
117             'userDn' => '',
118             'userFilter' => 'objectclass=posixaccount',
119             'userSearchScope' => Zend_Ldap::SEARCH_SCOPE_SUB,
120             'groupsDn' => '',
121             'groupFilter' => 'objectclass=posixgroup',
122             'groupSearchScope' => Zend_Ldap::SEARCH_SCOPE_SUB,
123             'pwEncType' => 'SSHA',
124             'minUserId' => '10000',
125             'maxUserId' => '29999',
126             'minGroupId' => '11000',
127             'maxGroupId' => '11099',
128             'groupUUIDAttribute' => 'entryUUID',
129             'userUUIDAttribute' => 'entryUUID',
130             self::DEFAULT_USER_GROUP_NAME_KEY  => Tinebase_Group::DEFAULT_USER_GROUP,
131             self::DEFAULT_ADMIN_GROUP_NAME_KEY => Tinebase_Group::DEFAULT_ADMIN_GROUP,
132             'readonly' => false,
133         ),
134         self::ACTIVEDIRECTORY => array(
135             'host' => 'localhost',
136             'username' => '',
137             'password' => '',
138             'bindRequiresDn' => true,
139             'useRfc2307' => false,
140             'userDn' => '',
141             'userFilter' => 'objectclass=user',
142             'userSearchScope' => Zend_Ldap::SEARCH_SCOPE_SUB,
143             'groupsDn' => '',
144             'groupFilter' => 'objectclass=group',
145             'groupSearchScope' => Zend_Ldap::SEARCH_SCOPE_SUB,
146             'minUserId' => '10000',
147             'maxUserId' => '29999',
148             'minGroupId' => '11000',
149             'maxGroupId' => '11099',
150             'groupUUIDAttribute' => 'objectGUID',
151             'userUUIDAttribute' => 'objectGUID',
152             self::DEFAULT_USER_GROUP_NAME_KEY  => 'Domain Users',
153             self::DEFAULT_ADMIN_GROUP_NAME_KEY => 'Domain Admins',
154             'readonly' => false,
155          )
156     );
157     
158     /**
159      * the singleton pattern
160      *
161      * @return Tinebase_User_Abstract
162      */
163     public static function getInstance() 
164     {
165         $backendType = self::getConfiguredBackend();
166         
167         if (self::$_instance === NULL) {
168             $backendType = self::getConfiguredBackend();
169             if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ .' accounts backend: ' . $backendType);
170             
171             self::$_instance = self::factory($backendType);
172         }
173         
174         return self::$_instance;
175     }
176         
177     /**
178      * return an instance of the current user backend
179      *
180      * @param   string $backendType name of the user backend
181      * @return  Tinebase_User_Abstract
182      * @throws  Tinebase_Exception_InvalidArgument
183      */
184     public static function factory($backendType) 
185     {
186         $options = self::getBackendConfiguration();
187         
188         // this is a dangerous TRACE as there might be passwords in here!
189         //if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . '::' . __LINE__ . ' ' 
190         //    . print_r($options, TRUE));
191         
192         $options['plugins'] = array();
193         
194         // manage email user settings
195         if (Tinebase_EmailUser::manages(Tinebase_Config::IMAP)) {
196             try {
197                 $options['plugins'][] = Tinebase_EmailUser::getInstance(Tinebase_Config::IMAP);
198             } catch (Exception $e) {
199                 if (Tinebase_Core::isLogLevel(Zend_Log::ERR)) Tinebase_Core::getLogger()->err(__METHOD__ . '::' . __LINE__
200                     . ' Could not add IMAP EmailUser plugin: ' . $e);
201             }
202         }
203         if (Tinebase_EmailUser::manages(Tinebase_Config::SMTP)) {
204             try {
205                 $options['plugins'][] = Tinebase_EmailUser::getInstance(Tinebase_Config::SMTP);
206                         } catch (Exception $e) {
207             if (Tinebase_Core::isLogLevel(Zend_Log::ERR)) Tinebase_Core::getLogger()->err(__METHOD__ . '::' . __LINE__
208                     . ' Could not add SMTP EmailUser plugin: ' . $e);
209             }
210         }
211         
212         switch ($backendType) {
213             case self::ACTIVEDIRECTORY:
214                 $result  = new Tinebase_User_ActiveDirectory($options);
215                 
216                 break;
217                 
218             case self::LDAP:
219                 // manage samba sam?
220                 if (isset(Tinebase_Core::getConfig()->samba) && Tinebase_Core::getConfig()->samba->get('manageSAM', FALSE) == true) {
221                     $options['plugins'][] = new Tinebase_User_Plugin_Samba(Tinebase_Core::getConfig()->samba->toArray());
222                 }
223                 
224                 $result  = new Tinebase_User_Ldap($options);
225                 
226                 break;
227                 
228             case self::SQL:
229                 $result = new Tinebase_User_Sql($options);
230                 
231                 break;
232             
233             case self::TYPO3:
234                 $result = new Tinebase_User_Typo3($options);
235                 
236                 break;
237                 
238             default:
239                 throw new Tinebase_Exception_InvalidArgument("User backend type $backendType not implemented.");
240         }
241         
242         if (Tinebase_Core::isLogLevel(Zend_Log::INFO)) Tinebase_Core::getLogger()->info(__METHOD__ . '::' . __LINE__ 
243             . ' Created user backend of type ' . $backendType);
244         
245         return $result;
246     }
247     
248     /**
249      * returns the configured rs backend
250      * 
251      * @return string
252      */
253     public static function getConfiguredBackend()
254     {
255         if (!isset(self::$_backendType)) {
256             if (Setup_Controller::getInstance()->isInstalled('Tinebase')) {
257                 self::setBackendType(Tinebase_Config::getInstance()->get(Tinebase_Config::USERBACKENDTYPE, self::SQL));
258             } else {
259                 self::setBackendType(self::SQL);
260             }
261         }
262         
263         return self::$_backendType;
264     }
265     
266     /**
267      * setter for {@see $_backendType}
268      * 
269      * @todo persist in db
270      * 
271      * @param string $backendType
272      * @return void
273      */
274     public static function setBackendType($backendType)
275     {
276         if (empty($backendType)) {
277             throw new Tinebase_Exception_InvalidArgument('Backend type can not be empty!');
278         }
279         
280         $newBackendType = ucfirst($backendType);
281         if (Tinebase_Core::isLogLevel(Zend_Log::INFO)) Tinebase_Core::getLogger()->info(__METHOD__ . '::' . __LINE__ .
282             ' Setting backend type to ' . $newBackendType);
283         
284         self::$_backendType = $newBackendType;
285     }
286     
287     /**
288      * Setter for {@see $_backendConfiguration}
289      * 
290      * NOTE:
291      * Setting will not be written to Database or Filesystem.
292      * To persist the change call {@see saveBackendConfiguration()}
293      * 
294      * @param mixed $_value
295      * @param string $_key
296      * @param boolean $_applyDefaults
297      * @return void
298      * 
299      * @todo generalize this (see Tinebase_Auth::setBackendConfiguration)
300      */
301     public static function setBackendConfiguration($_value, $_key = null, $_applyDefaults = false)
302     {
303         $defaultValues = self::$_backendConfigurationDefaults[self::getConfiguredBackend()];
304         
305         if (is_null($_key) && !is_array($_value)) {
306             throw new Tinebase_Exception_InvalidArgument('To set backend configuration either a key and value '
307                 . 'parameter are required or the value parameter should be a hash');
308         } elseif (is_null($_key) && is_array($_value)) {
309             $configToSet = $_applyDefaults ? array_merge($defaultValues, $_value) : $_value;
310             foreach ($configToSet as $key => $value) {
311                 self::setBackendConfiguration($value, $key);
312             }
313         } else {
314             if ( ! (isset($defaultValues[$_key]) || array_key_exists($_key, $defaultValues))) {
315                 if (Tinebase_Core::isLogLevel(Zend_Log::INFO)) Tinebase_Core::getLogger()->info(__METHOD__ . '::' . __LINE__ .
316                     " Cannot set backend configuration option '$_key' for accounts storage " . self::getConfiguredBackend());
317                 return;
318             }
319             if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ .
320                 ' Setting backend key ' . $_key . ' to ' . (preg_match('/password|pwd|pass|passwd/i', $_key) ? '********' : $_value));
321             
322             self::$_backendConfiguration[$_key] = $_value;
323         }
324     }
325     
326     /**
327      * Delete the given config setting or all config settings if {@param $_key} is not specified
328      * 
329      * @param string | optional $_key
330      * @return void
331      */
332     public static function deleteBackendConfiguration($_key = null)
333     {
334         if (is_null($_key)) {
335             self::$_backendConfiguration = array();
336         } elseif ((isset(self::$_backendConfiguration[$_key]) || array_key_exists($_key, self::$_backendConfiguration))) {
337             unset(self::$_backendConfiguration[$_key]);
338         } else {
339             Tinebase_Core::getLogger()->warn(__METHOD__ . '::' . __LINE__ . ' configuration option does not exist: ' . $_key);
340         }
341     }
342     
343     /**
344      * Write backend configuration setting {@see $_backendConfigurationSettings} and {@see $_backendType} to
345      * db config table.
346      * 
347      * @return void
348      */
349     public static function saveBackendConfiguration()
350     {
351         Tinebase_Config::getInstance()->set(Tinebase_Config::USERBACKEND, self::getBackendConfiguration());
352         Tinebase_Config::getInstance()->set(Tinebase_Config::USERBACKENDTYPE, self::getConfiguredBackend());
353     }
354     
355     /**
356      * Getter for {@see $_backendConfiguration}
357      * 
358      * @param String | optional $_key
359      * @return mixed [If {@param $_key} is set then only the specified option is returned, otherwise the whole options hash]
360      */
361     public static function getBackendConfiguration($_key = null, $_default = null)
362     {
363         //lazy loading for $_backendConfiguration
364         if (!isset(self::$_backendConfiguration)) {
365             if (Setup_Controller::getInstance()->isInstalled('Tinebase')) {
366                 $rawBackendConfiguration = Tinebase_Config::getInstance()->get(Tinebase_Config::USERBACKEND, new Tinebase_Config_Struct())->toArray();
367             } else {
368                 $rawBackendConfiguration = array();
369             }
370             self::$_backendConfiguration = is_array($rawBackendConfiguration) ? $rawBackendConfiguration : Zend_Json::decode($rawBackendConfiguration);
371         }
372
373         if (isset($_key)) {
374             return (isset(self::$_backendConfiguration[$_key]) || array_key_exists($_key, self::$_backendConfiguration)) ? self::$_backendConfiguration[$_key] : $_default;
375         } else {
376             return self::$_backendConfiguration;
377         }
378     }
379     
380     /**
381      * Returns default configuration for all supported backends 
382      * and overrides the defaults with concrete values stored in this configuration 
383      * 
384      * @param boolean $_getConfiguredBackend
385      * @return mixed [If {@param $_key} is set then only the specified option is returned, otherwise the whole options hash]
386      */
387     public static function getBackendConfigurationWithDefaults($_getConfiguredBackend = TRUE)
388     {
389         $config = array();
390         $defaultConfig = self::getBackendConfigurationDefaults();
391         foreach ($defaultConfig as $backendType => $backendConfig) {
392             $config[$backendType] = ($_getConfiguredBackend && $backendType == self::getConfiguredBackend() ? self::getBackendConfiguration() : array());
393             if (is_array($config[$backendType])) {
394                 foreach ($backendConfig as $key => $value) {
395                     if (! (isset($config[$backendType][$key]) || array_key_exists($key, $config[$backendType]))) {
396                         $config[$backendType][$key] = $value;
397                     }
398                 }
399             } else {
400                 $config[$backendType] = $backendConfig;
401             }
402         }
403         return $config;
404     }
405     
406     /**
407      * Getter for {@see $_backendConfigurationDefaults}
408      * @param String | optional $_backendType
409      * @return array
410      */
411     public static function getBackendConfigurationDefaults($_backendType = null) {
412         if ($_backendType) {
413             if (!(isset(self::$_backendConfigurationDefaults[$_backendType]) || array_key_exists($_backendType, self::$_backendConfigurationDefaults))) {
414                 throw new Tinebase_Exception_InvalidArgument("Unknown backend type '$_backendType'");
415             }
416             return self::$_backendConfigurationDefaults[$_backendType];
417         } else {
418             return self::$_backendConfigurationDefaults;
419         }
420     }
421     
422     /**
423      * syncronize user from syncbackend to local sql backend
424      * 
425      * @param  mixed  $username  the login id of the user to synchronize
426      * @param  array $options
427      * @return Tinebase_Model_FullUser
428      * @throws Tinebase_Exception
429      * 
430      * @todo make use of dbmail plugin configurable (should be false by default)
431      * @todo switch to new primary group if it could not be found
432      * @todo write a test and refactor this ... :(
433      */
434     public static function syncUser($username, $options = array())
435     {
436         if ($username instanceof Tinebase_Model_FullUser) {
437             $username = $username->accountLoginName;
438         } else {
439             $username = $username;
440         }
441         
442         if (Tinebase_Core::isLogLevel(Zend_Log::INFO)) Tinebase_Core::getLogger()->info(__METHOD__ . '::' . __LINE__ . "  sync user data for: " . $username);
443         
444         $userBackend  = Tinebase_User::getInstance();
445         if (isset($options['ldapplugins']) && is_array($options['ldapplugins'])) {
446             foreach ($options['ldapplugins'] as $plugin) {
447                 $userBackend->registerLdapPlugin($plugin);
448             }
449         }
450         
451         $user = $userBackend->getUserByPropertyFromSyncBackend('accountLoginName', $username, 'Tinebase_Model_FullUser');
452         $user->accountPrimaryGroup = Tinebase_Group::getInstance()->resolveGIdNumberToUUId($user->accountPrimaryGroup);
453         
454         $userProperties = method_exists($userBackend, 'getLastUserProperties') ? $userBackend->getLastUserProperties() : array();
455         
456         $hookResult = self::_syncUserHook($user, $userProperties);
457         if (! $hookResult) {
458             return null;
459         }
460         
461         if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . '::' . __LINE__ . ' ' 
462             . print_r($user->toArray(), TRUE));
463         
464         $group = self::getPrimaryGroupForUser($user);
465         
466         try {
467             $currentUser = $userBackend->getUserByProperty('accountId', $user, 'Tinebase_Model_FullUser');
468         
469             $currentUser->accountLoginName          = $user->accountLoginName;
470             $currentUser->accountLastPasswordChange = $user->accountLastPasswordChange;
471             $currentUser->accountExpires            = $user->accountExpires;
472             $currentUser->accountPrimaryGroup       = $user->accountPrimaryGroup;
473             $currentUser->accountDisplayName        = $user->accountDisplayName;
474             $currentUser->accountLastName           = $user->accountLastName;
475             $currentUser->accountFirstName          = $user->accountFirstName;
476             $currentUser->accountFullName           = $user->accountFullName;
477             $currentUser->accountEmailAddress       = $user->accountEmailAddress;
478             $currentUser->accountHomeDirectory      = $user->accountHomeDirectory;
479             $currentUser->accountLoginShell         = $user->accountLoginShell;
480             if (! empty($user->visibility) && $currentUser->visibility !== $user->visibility) {
481                 $currentUser->visibility            = $user->visibility;
482                 if (empty($currentUser->contact_id) && $currentUser->visibility == Tinebase_Model_FullUser::VISIBILITY_DISPLAYED) {
483                     self::createContactForSyncedUser($currentUser);
484                 }
485             }
486         
487             $syncedUser = $userBackend->updateUserInSqlBackend($currentUser);
488             if (! empty($user->container_id)) {
489                 $syncedUser->container_id = $user->container_id;
490             }
491             $userBackend->updatePluginUser($syncedUser, $user);
492             
493         } catch (Tinebase_Exception_NotFound $ten) {
494             try {
495                 $invalidUser = $userBackend->getUserByPropertyFromSqlBackend('accountLoginName', $username, 'Tinebase_Model_FullUser');
496                 if (Tinebase_Core::isLogLevel(Zend_Log::CRIT)) Tinebase_Core::getLogger()->crit(__METHOD__ . '::' . __LINE__ 
497                     . " Remove invalid user: " . $username);
498                 $userBackend->deleteUserInSqlBackend($invalidUser);
499             } catch (Tinebase_Exception_NotFound $ten) {
500                 // do nothing
501             }
502             
503             if ($user->visibility !== Tinebase_Model_FullUser::VISIBILITY_HIDDEN) {
504                 self::createContactForSyncedUser($user);
505             }
506             $syncedUser = $userBackend->addUserInSqlBackend($user);
507             $userBackend->addPluginUser($syncedUser, $user);
508         }
509         
510         self::syncContactData($syncedUser, $options);
511         
512         // sync group memberships
513         Tinebase_Group::syncMemberships($syncedUser);
514         
515         return $syncedUser;
516     }
517     
518     /**
519      * import contactdata(phone, address, fax, birthday. photo)
520      * 
521      * @param Tinebase_Model_FullUser $syncedUser
522      * @param array $options
523      */
524     public static function syncContactData($syncedUser, $options)
525     {
526         if (! Tinebase_Config::getInstance()->get(Tinebase_Config::SYNC_USER_CONTACT_DATA, true)
527                 || ! isset($options['syncContactData'])
528                 || ! $options['syncContactData']
529                 || ! Tinebase_Application::getInstance()->isInstalled('Addressbook')
530                 ||   $syncedUser->visibility === Tinebase_Model_FullUser::VISIBILITY_HIDDEN
531         ) {
532             if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
533                 . ' Contact data sync disabled');
534             return;
535         }
536         
537         $addressbook = Addressbook_Backend_Factory::factory(Addressbook_Backend_Factory::SQL);
538         
539         try {
540             $contact = $addressbook->getByUserId($syncedUser->getId());
541             $originalContact = clone $contact;
542             
543             Tinebase_User::getInstance()->updateContactFromSyncBackend($syncedUser, $contact);
544             $contact = self::_user2Contact($syncedUser, $contact);
545             
546             // TODO allow to diff jpegphoto, too
547             $diff = $contact->diff($originalContact, array('jpegphoto'));
548             if (! $diff->isEmpty()) {
549                 // add modlog info
550                 Tinebase_Timemachine_ModificationLog::setRecordMetaData($contact, 'update');
551                 Tinebase_Container::getInstance()->increaseContentSequence($contact->container_id);
552                 
553                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
554                     . ' Updating contact data for user ' . $syncedUser->accountLoginName);
555                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
556                     . ' Diff: ' . print_r($diff->toArray(), true));
557                 
558                 $addressbook->update($contact);
559             } else {
560                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
561                     . ' User contact is up to date.');
562             }
563         } catch (Addressbook_Exception_NotFound $aenf) {
564             self::createContactForSyncedUser($syncedUser);
565             $syncedUser = Tinebase_User::getInstance()->updateUserInSqlBackend($syncedUser);
566         }
567     }
568     
569     /**
570      * get primary group for user and make sure that group exists
571      * 
572      * @param Tinebase_Model_FullUser $user
573      * @throws Tinebase_Exception
574      * @return Tinebase_Model_Group
575      */
576     public static function getPrimaryGroupForUser($user)
577     {
578         $groupBackend = Tinebase_Group::getInstance();
579         
580         try {
581             $group = $groupBackend->getGroupById($user->accountPrimaryGroup);
582         } catch (Tinebase_Exception_Record_NotDefined $tern) {
583             if ($groupBackend->isDisabledBackend()) {
584                 // groups are sql only
585                 $group = $groupBackend->getDefaultGroup();
586                 $user->accountPrimaryGroup = $group->getId();
587             } else {
588                 try {
589                     $group = $groupBackend->getGroupByIdFromSyncBackend($user->accountPrimaryGroup);
590                 } catch (Tinebase_Exception_Record_NotDefined $ternd) {
591                     throw new Tinebase_Exception('Primary group ' . $user->accountPrimaryGroup . ' not found in sync backend.');
592                 }
593                 try {
594                     $sqlGgroup = $groupBackend->getGroupByName($group->name);
595                     throw new Tinebase_Exception('Group already exists but it has a different ID: ' . $group->name);
596         
597                 } catch (Tinebase_Exception_Record_NotDefined $tern) {
598                     if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ 
599                         . " Adding group " . $group->name);
600                     $group = $groupBackend->addGroupInSqlBackend($group);
601                 }
602             }
603         }
604         
605         return $group;
606     }
607     
608     /**
609      * call configured hooks for adjusting synced user data
610      * 
611      * @param Tinebase_Model_FullUser $user
612      * @param array $userProperties
613      * @return boolean if false, user is skipped
614      */
615     protected static function _syncUserHook(Tinebase_Model_FullUser $user, $userProperties)
616     {
617         $result = true;
618         $hookClass = Tinebase_Config::getInstance()->get(Tinebase_Config::SYNC_USER_HOOK_CLASS);
619         if ($hookClass && class_exists($hookClass)) {
620             $hook = new $hookClass();
621             if (method_exists($hook, 'syncUser')) {
622                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
623                     . ' Calling ' . $hookClass . '::syncUser() ...');
624                 
625                 try {
626                     $result = call_user_func_array(array($hook, 'syncUser'), array($user, $userProperties));
627                 } catch (Tinebase_Exception $te) {
628                     Tinebase_Exception::log($te);
629                     return false;
630                 }
631             }
632         }
633         
634         return $result;
635     }
636     
637     /**
638      * create contact in addressbook
639      * 
640      * @param Tinebase_Model_FullUser $user
641      */
642     public static function createContactForSyncedUser($user)
643     {
644         if (! Tinebase_Application::getInstance()->isInstalled('Addressbook')) {
645             return;
646         }
647         
648         $contact = self::_user2Contact($user);
649         
650         // add modlog info
651         Tinebase_Timemachine_ModificationLog::setRecordMetaData($contact, 'create');
652         
653         $addressbook = Addressbook_Backend_Factory::factory(Addressbook_Backend_Factory::SQL);
654         $contact = $addressbook->create($contact);
655         
656         if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ 
657             . " Added contact " . $contact->n_given);
658         
659         $user->contact_id = $contact->getId();
660     }
661     
662     /**
663      * sync user data to contact
664      * 
665      * @param Tinebase_Model_FullUser $user
666      * @param Addressbook_Model_Contact $contact
667      * @return Addressbook_Model_Contact
668      */
669     protected static function _user2Contact($user, $contact = null)
670     {
671         if ($contact === null) {
672             $contact = new Addressbook_Model_Contact(array(), true);
673         }
674         
675         $contact->type = Addressbook_Model_Contact::CONTACTTYPE_USER;
676         
677         foreach (self::$_contact2UserMapping as $contactKey => $userKey) {
678             if (! empty($contact->{$contactKey}) && $contact->{$contactKey} == $user->{$userKey}) {
679                 continue;
680             }
681             
682             switch ($contactKey) {
683                 case 'container_id':
684                     $contact->container_id = (! empty($user->container_id)) ? $user->container_id : Admin_Controller_User::getInstance()->getDefaultInternalAddressbook();
685                     break;
686                 default:
687                     $contact->{$contactKey} = $user->{$userKey};
688             }
689         }
690         
691         return $contact;
692     }
693     
694     /**
695      * import users from sync backend
696      * 
697      * @param array $options
698      */
699     public static function syncUsers($options)
700     {
701         if (Tinebase_Core::isLogLevel(Zend_Log::INFO)) Tinebase_Core::getLogger()->info(__METHOD__ . '::' . __LINE__ 
702             .' Start synchronizing users ...');
703         
704         $users = Tinebase_User::getInstance()->getUsersFromSyncBackend(NULL, NULL, 'ASC', NULL, NULL, 'Tinebase_Model_FullUser');
705         
706         if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
707             . ' About to sync ' . count($users) . ' users from sync backend ...');
708         
709         foreach ($users as $user) {
710             try {
711                 self::syncUser($user, $options);
712             } catch (Tinebase_Exception_NotFound $ten) {
713                 Tinebase_Core::getLogger()->crit(__METHOD__ . '::' . __LINE__ . " User {$user->accountLoginName} not synced: "
714                     . $ten->getMessage());
715             }
716         }
717         
718         // @todo this should be improved: only the cache of synced users + group memberships should be cleaned
719         if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ 
720             . ' Finished synchronizing users. Clearing cache after user sync ...');
721         Tinebase_Core::getCache()->clean();
722     }
723
724     /**
725      * get all user passwords from ldap
726      * - set pw for user (in sql and sql plugins)
727      * - do not encrypt the pw again as it is encrypted in LDAP
728      * 
729      * @throws Tinebase_Exception_Backend
730      */
731     public static function syncLdapPasswords()
732     {
733         $userBackend = Tinebase_User::getInstance();
734         if (! $userBackend instanceof Tinebase_User_Ldap) {
735             throw new Tinebase_Exception_Backend('Needs LDAP accounts backend');
736         }
737         
738         $result = $userBackend->getUserAttributes(array('entryUUID', 'userPassword'));
739         
740         if (Tinebase_Core::isLogLevel(Zend_Log::INFO)) Tinebase_Core::getLogger()->info(__METHOD__ . '::' . __LINE__
741             . ' About to sync ' . count($result) . ' user passwords from LDAP to Tine 2.0.');
742         
743         $sqlBackend = Tinebase_User::factory(self::SQL);
744         foreach ($result as $user) {
745             try {
746                 $sqlBackend->setPassword($user['entryUUID'], $user['userPassword'], FALSE);
747             } catch (Tinebase_Exception_NotFound $tenf) {
748                 if (Tinebase_Core::isLogLevel(Zend_Log::INFO)) Tinebase_Core::getLogger()->info(__METHOD__ . '::' . __LINE__
749                     . ' Could not find user with id ' . $user['entryUUID'] . ' in SQL backend.');
750             }
751         }
752     }
753     
754     /**
755      * create initial admin account
756      * 
757      * Method is called during Setup Initialization
758      *
759      * $_options may contain the following keys:
760      * <code>
761      * $options = array(
762      *  'adminLoginName'    => 'admin',
763      *  'adminPassword'     => 'lars',
764      *  'adminFirstName'    => 'Tine 2.0',
765      *  'adminLastName'     => 'Admin Account',
766      *  'adminEmailAddress' => 'admin@tine20domain.org',
767      *  'expires'            => Tinebase_DateTime object
768      * );
769      * </code>
770      *
771      * @param array $_options [hash that may contain override values for admin user name and password]
772      * @return void
773      */
774     public static function createInitialAccounts($_options)
775     {
776         if (! isset($_options['adminPassword']) || ! isset($_options['adminLoginName'])) {
777             throw new Tinebase_Exception_InvalidArgument('Admin password and login name have to be set when creating initial account.', 503);
778         }
779         
780         $adminLoginName     = $_options['adminLoginName'];
781         $adminPassword      = $_options['adminPassword'];
782         $adminFirstName     = isset($_options['adminFirstName'])    ? $_options['adminFirstName'] : 'Tine 2.0';
783         $adminLastName      = isset($_options['adminLastName'])     ? $_options['adminLastName']  : 'Admin Account';
784         $adminEmailAddress  = ((isset($_options['adminEmailAddress']) || array_key_exists('adminEmailAddress', $_options))) ? $_options['adminEmailAddress'] : NULL;
785
786         // get admin & user groups
787         $userBackend   = Tinebase_User::getInstance();
788         $groupsBackend = Tinebase_Group::getInstance();
789         
790         $adminGroup = $groupsBackend->getDefaultAdminGroup();
791         $userGroup  = $groupsBackend->getDefaultGroup();
792         
793         Tinebase_Core::getLogger()->info(__METHOD__ . '::' . __LINE__ . ' Creating initial admin user (login: ' . $adminLoginName . ' / email: ' . $adminEmailAddress . ')');
794
795         $user = new Tinebase_Model_FullUser(array(
796             'accountLoginName'      => $adminLoginName,
797             'accountStatus'         => 'enabled',
798             'accountPrimaryGroup'   => $userGroup->getId(),
799             'accountLastName'       => $adminLastName,
800             'accountDisplayName'    => $adminLastName . ', ' . $adminFirstName,
801             'accountFirstName'      => $adminFirstName,
802             'accountExpires'        => (isset($_options['expires'])) ? $_options['expires'] : NULL,
803             'accountEmailAddress'   => $adminEmailAddress
804         ));
805         
806         if ($adminEmailAddress !== NULL) {
807             $user->imapUser = new Tinebase_Model_EmailUser(array(
808                 'emailPassword' => $adminPassword
809             ));
810             $user->smtpUser = new Tinebase_Model_EmailUser(array(
811                 'emailPassword' => $adminPassword
812             ));
813         }
814
815         // update or create user in local sql backend
816         try {
817             $userBackend->getUserByProperty('accountLoginName', $adminLoginName);
818             $user = $userBackend->updateUserInSqlBackend($user);
819         } catch (Tinebase_Exception_NotFound $ten) {
820             // call addUser here to make sure, sql user plugins (email, ...) are triggered
821             $user = $userBackend->addUser($user);
822         }
823         
824         // set the password for the account
825         Tinebase_User::getInstance()->setPassword($user, $adminPassword);
826
827         // add the admin account to all groups
828         Tinebase_Group::getInstance()->addGroupMember($adminGroup, $user);
829         Tinebase_Group::getInstance()->addGroupMember($userGroup, $user);
830     }
831 }