Merge branch '2013.10' into 2014.11
[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             'useStartTls' => false,
117             'useRfc2307bis' => false,
118             'userDn' => '',
119             'userFilter' => 'objectclass=posixaccount',
120             'userSearchScope' => Zend_Ldap::SEARCH_SCOPE_SUB,
121             'groupsDn' => '',
122             'groupFilter' => 'objectclass=posixgroup',
123             'groupSearchScope' => Zend_Ldap::SEARCH_SCOPE_SUB,
124             'pwEncType' => 'SSHA',
125             'minUserId' => '10000',
126             'maxUserId' => '29999',
127             'minGroupId' => '11000',
128             'maxGroupId' => '11099',
129             'groupUUIDAttribute' => 'entryUUID',
130             'userUUIDAttribute' => 'entryUUID',
131             self::DEFAULT_USER_GROUP_NAME_KEY  => Tinebase_Group::DEFAULT_USER_GROUP,
132             self::DEFAULT_ADMIN_GROUP_NAME_KEY => Tinebase_Group::DEFAULT_ADMIN_GROUP,
133             'readonly' => false,
134         ),
135         self::ACTIVEDIRECTORY => array(
136             'host' => 'localhost',
137             'username' => '',
138             'password' => '',
139             'bindRequiresDn' => true,
140             'useRfc2307' => false,
141             'userDn' => '',
142             'userFilter' => 'objectclass=user',
143             'userSearchScope' => Zend_Ldap::SEARCH_SCOPE_SUB,
144             'groupsDn' => '',
145             'groupFilter' => 'objectclass=group',
146             'groupSearchScope' => Zend_Ldap::SEARCH_SCOPE_SUB,
147             'minUserId' => '10000',
148             'maxUserId' => '29999',
149             'minGroupId' => '11000',
150             'maxGroupId' => '11099',
151             'groupUUIDAttribute' => 'objectGUID',
152             'userUUIDAttribute' => 'objectGUID',
153             self::DEFAULT_USER_GROUP_NAME_KEY  => 'Domain Users',
154             self::DEFAULT_ADMIN_GROUP_NAME_KEY => 'Domain Admins',
155             'readonly' => false,
156          )
157     );
158     
159     /**
160      * the singleton pattern
161      *
162      * @return Tinebase_User_Abstract
163      */
164     public static function getInstance() 
165     {
166         if (self::$_instance === NULL) {
167             $backendType = self::getConfiguredBackend();
168             if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ .' accounts backend: ' . $backendType);
169             
170             self::$_instance = self::factory($backendType);
171         }
172         
173         return self::$_instance;
174     }
175         
176     /**
177      * return an instance of the current user backend
178      *
179      * @param   string $backendType name of the user backend
180      * @return  Tinebase_User_Abstract
181      * @throws  Tinebase_Exception_InvalidArgument
182      */
183     public static function factory($backendType) 
184     {
185         $options = self::getBackendConfiguration();
186         
187         // this is a dangerous TRACE as there might be passwords in here!
188         //if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . '::' . __LINE__ . ' ' 
189         //    . print_r($options, TRUE));
190         
191         $options['plugins'] = array();
192         
193         // manage email user settings
194         if (Tinebase_EmailUser::manages(Tinebase_Config::IMAP)) {
195             try {
196                 $options['plugins'][] = Tinebase_EmailUser::getInstance(Tinebase_Config::IMAP);
197             } catch (Exception $e) {
198                 if (Tinebase_Core::isLogLevel(Zend_Log::ERR)) Tinebase_Core::getLogger()->err(__METHOD__ . '::' . __LINE__
199                     . ' Could not add IMAP EmailUser plugin: ' . $e);
200             }
201         }
202         if (Tinebase_EmailUser::manages(Tinebase_Config::SMTP)) {
203             try {
204                 $options['plugins'][] = Tinebase_EmailUser::getInstance(Tinebase_Config::SMTP);
205                         } catch (Exception $e) {
206             if (Tinebase_Core::isLogLevel(Zend_Log::ERR)) Tinebase_Core::getLogger()->err(__METHOD__ . '::' . __LINE__
207                     . ' Could not add SMTP EmailUser plugin: ' . $e);
208             }
209         }
210         
211         switch ($backendType) {
212             case self::ACTIVEDIRECTORY:
213                 $result  = new Tinebase_User_ActiveDirectory($options);
214                 
215                 break;
216                 
217             case self::LDAP:
218                 // manage samba sam?
219                 if (isset(Tinebase_Core::getConfig()->samba) && Tinebase_Core::getConfig()->samba->get('manageSAM', FALSE) == true) {
220                     $options['plugins'][] = new Tinebase_User_Plugin_Samba(Tinebase_Core::getConfig()->samba->toArray());
221                 }
222                 
223                 $result  = new Tinebase_User_Ldap($options);
224                 
225                 break;
226                 
227             case self::SQL:
228                 $result = new Tinebase_User_Sql($options);
229                 
230                 break;
231             
232             case self::TYPO3:
233                 $result = new Tinebase_User_Typo3($options);
234                 
235                 break;
236                 
237             default:
238                 throw new Tinebase_Exception_InvalidArgument("User backend type $backendType not implemented.");
239         }
240         
241         if (Tinebase_Core::isLogLevel(Zend_Log::INFO)) Tinebase_Core::getLogger()->info(__METHOD__ . '::' . __LINE__ 
242             . ' Created user backend of type ' . get_class($result));
243         
244         return $result;
245     }
246     
247     /**
248      * returns the configured rs backend
249      * 
250      * @return string
251      */
252     public static function getConfiguredBackend()
253     {
254         if (!isset(self::$_backendType)) {
255             if (Setup_Controller::getInstance()->isInstalled('Tinebase')) {
256                 self::setBackendType(Tinebase_Config::getInstance()->get(Tinebase_Config::USERBACKENDTYPE, self::SQL));
257             } else {
258                 self::setBackendType(self::SQL);
259             }
260         }
261         
262         return self::$_backendType;
263     }
264     
265     /**
266      * setter for {@see $_backendType}
267      * 
268      * @todo persist in db
269      * 
270      * @param string $backendType
271      * @return void
272      */
273     public static function setBackendType($backendType)
274     {
275         if (empty($backendType)) {
276             throw new Tinebase_Exception_InvalidArgument('Backend type can not be empty!');
277         }
278         
279         $newBackendType = ucfirst($backendType);
280         if (Tinebase_Core::isLogLevel(Zend_Log::INFO)) Tinebase_Core::getLogger()->info(__METHOD__ . '::' . __LINE__ .
281             ' Setting backend type to ' . $newBackendType);
282         
283         self::$_backendType = $newBackendType;
284     }
285     
286     /**
287      * Setter for {@see $_backendConfiguration}
288      * 
289      * NOTE:
290      * Setting will not be written to Database or Filesystem.
291      * To persist the change call {@see saveBackendConfiguration()}
292      * 
293      * @param mixed $_value
294      * @param string $_key
295      * @param boolean $_applyDefaults
296      * @return void
297      * 
298      * @todo generalize this (see Tinebase_Auth::setBackendConfiguration)
299      */
300     public static function setBackendConfiguration($_value, $_key = null, $_applyDefaults = false)
301     {
302         $defaultValues = self::$_backendConfigurationDefaults[self::getConfiguredBackend()];
303         
304         if (is_null($_key) && !is_array($_value)) {
305             throw new Tinebase_Exception_InvalidArgument('To set backend configuration either a key and value '
306                 . 'parameter are required or the value parameter should be a hash');
307         } elseif (is_null($_key) && is_array($_value)) {
308             $configToSet = $_applyDefaults ? array_merge($defaultValues, $_value) : $_value;
309             foreach ($configToSet as $key => $value) {
310                 self::setBackendConfiguration($value, $key);
311             }
312         } else {
313             if ( ! (isset($defaultValues[$_key]) || array_key_exists($_key, $defaultValues))) {
314                 if (Tinebase_Core::isLogLevel(Zend_Log::INFO)) Tinebase_Core::getLogger()->info(__METHOD__ . '::' . __LINE__ .
315                     " Cannot set backend configuration option '$_key' for accounts storage " . self::getConfiguredBackend());
316                 return;
317             }
318             if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ .
319                 ' Setting backend key ' . $_key . ' to ' . (preg_match('/password|pwd|pass|passwd/i', $_key) ? '********' : $_value));
320             
321             self::$_backendConfiguration[$_key] = $_value;
322         }
323     }
324     
325     /**
326      * Delete the given config setting or all config settings if {@param $_key} is not specified
327      * 
328      * @param string | optional $_key
329      * @return void
330      */
331     public static function deleteBackendConfiguration($_key = null)
332     {
333         if (is_null($_key)) {
334             self::$_backendConfiguration = array();
335         } elseif ((isset(self::$_backendConfiguration[$_key]) || array_key_exists($_key, self::$_backendConfiguration))) {
336             unset(self::$_backendConfiguration[$_key]);
337         } else {
338             Tinebase_Core::getLogger()->warn(__METHOD__ . '::' . __LINE__ . ' configuration option does not exist: ' . $_key);
339         }
340     }
341     
342     /**
343      * Write backend configuration setting {@see $_backendConfigurationSettings} and {@see $_backendType} to
344      * db config table.
345      * 
346      * @return void
347      */
348     public static function saveBackendConfiguration()
349     {
350         Tinebase_Config::getInstance()->set(Tinebase_Config::USERBACKEND, self::getBackendConfiguration());
351         Tinebase_Config::getInstance()->set(Tinebase_Config::USERBACKENDTYPE, self::getConfiguredBackend());
352     }
353     
354     /**
355      * Getter for {@see $_backendConfiguration}
356      * 
357      * @param String | optional $_key
358      * @return mixed [If {@param $_key} is set then only the specified option is returned, otherwise the whole options hash]
359      */
360     public static function getBackendConfiguration($_key = null, $_default = null)
361     {
362         //lazy loading for $_backendConfiguration
363         if (!isset(self::$_backendConfiguration)) {
364             if (Setup_Controller::getInstance()->isInstalled('Tinebase')) {
365                 $rawBackendConfiguration = Tinebase_Config::getInstance()->get(Tinebase_Config::USERBACKEND, new Tinebase_Config_Struct())->toArray();
366             } else {
367                 $rawBackendConfiguration = array();
368             }
369             self::$_backendConfiguration = is_array($rawBackendConfiguration) ? $rawBackendConfiguration : Zend_Json::decode($rawBackendConfiguration);
370         }
371
372         if (isset($_key)) {
373             return (isset(self::$_backendConfiguration[$_key]) || array_key_exists($_key, self::$_backendConfiguration)) ? self::$_backendConfiguration[$_key] : $_default;
374         } else {
375             return self::$_backendConfiguration;
376         }
377     }
378     
379     /**
380      * Returns default configuration for all supported backends 
381      * and overrides the defaults with concrete values stored in this configuration 
382      * 
383      * @param boolean $_getConfiguredBackend
384      * @return mixed [If {@param $_key} is set then only the specified option is returned, otherwise the whole options hash]
385      */
386     public static function getBackendConfigurationWithDefaults($_getConfiguredBackend = TRUE)
387     {
388         $config = array();
389         $defaultConfig = self::getBackendConfigurationDefaults();
390         foreach ($defaultConfig as $backendType => $backendConfig) {
391             $config[$backendType] = ($_getConfiguredBackend && $backendType == self::getConfiguredBackend() ? self::getBackendConfiguration() : array());
392             if (is_array($config[$backendType])) {
393                 foreach ($backendConfig as $key => $value) {
394                     if (! (isset($config[$backendType][$key]) || array_key_exists($key, $config[$backendType]))) {
395                         $config[$backendType][$key] = $value;
396                     }
397                 }
398             } else {
399                 $config[$backendType] = $backendConfig;
400             }
401         }
402         return $config;
403     }
404     
405     /**
406      * Getter for {@see $_backendConfigurationDefaults}
407      * @param String | optional $_backendType
408      * @return array
409      */
410     public static function getBackendConfigurationDefaults($_backendType = null) {
411         if ($_backendType) {
412             if (!(isset(self::$_backendConfigurationDefaults[$_backendType]) || array_key_exists($_backendType, self::$_backendConfigurationDefaults))) {
413                 throw new Tinebase_Exception_InvalidArgument("Unknown backend type '$_backendType'");
414             }
415             return self::$_backendConfigurationDefaults[$_backendType];
416         } else {
417             return self::$_backendConfigurationDefaults;
418         }
419     }
420     
421     /**
422      * syncronize user from syncbackend to local sql backend
423      * 
424      * @param  mixed  $username  the login id of the user to synchronize
425      * @param  array $options
426      * @return Tinebase_Model_FullUser
427      * @throws Tinebase_Exception
428      * 
429      * @todo make use of dbmail plugin configurable (should be false by default)
430      * @todo switch to new primary group if it could not be found
431      * @todo write a test and refactor this ... :(
432      */
433     public static function syncUser($username, $options = array())
434     {
435         if ($username instanceof Tinebase_Model_FullUser) {
436             $username = $username->accountLoginName;
437         }
438         
439         if (Tinebase_Core::isLogLevel(Zend_Log::INFO)) Tinebase_Core::getLogger()->info(__METHOD__ . '::' . __LINE__ . "  sync user data for: " . $username);
440         
441         $userBackend  = Tinebase_User::getInstance();
442         if (isset($options['ldapplugins']) && is_array($options['ldapplugins'])) {
443             foreach ($options['ldapplugins'] as $plugin) {
444                 $userBackend->registerLdapPlugin($plugin);
445             }
446         }
447         
448         $user = $userBackend->getUserByPropertyFromSyncBackend('accountLoginName', $username, 'Tinebase_Model_FullUser');
449         $user->accountPrimaryGroup = Tinebase_Group::getInstance()->resolveGIdNumberToUUId($user->accountPrimaryGroup);
450         
451         $userProperties = method_exists($userBackend, 'getLastUserProperties') ? $userBackend->getLastUserProperties() : array();
452         
453         $hookResult = self::_syncUserHook($user, $userProperties);
454         if (! $hookResult) {
455             return null;
456         }
457         
458         if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . '::' . __LINE__ . ' ' 
459             . print_r($user->toArray(), TRUE));
460         
461         self::getPrimaryGroupForUser($user);
462
463         try {
464             $currentUser = $userBackend->getUserByProperty('accountId', $user, 'Tinebase_Model_FullUser');
465         
466             $currentUser->accountLoginName          = $user->accountLoginName;
467             $currentUser->accountLastPasswordChange = $user->accountLastPasswordChange;
468             $currentUser->accountExpires            = $user->accountExpires;
469             $currentUser->accountPrimaryGroup       = $user->accountPrimaryGroup;
470             $currentUser->accountDisplayName        = $user->accountDisplayName;
471             $currentUser->accountLastName           = $user->accountLastName;
472             $currentUser->accountFirstName          = $user->accountFirstName;
473             $currentUser->accountFullName           = $user->accountFullName;
474             $currentUser->accountEmailAddress       = $user->accountEmailAddress;
475             $currentUser->accountHomeDirectory      = $user->accountHomeDirectory;
476             $currentUser->accountLoginShell         = $user->accountLoginShell;
477
478             $currentUser->accountStatus             = isset($user->accountStatus)
479                 ? $user->accountStatus
480                 : Tinebase_Model_User::ACCOUNT_STATUS_ENABLED;
481
482             if (! empty($user->visibility) && $currentUser->visibility !== $user->visibility) {
483                 $currentUser->visibility            = $user->visibility;
484                 if (empty($currentUser->contact_id) && $currentUser->visibility == Tinebase_Model_FullUser::VISIBILITY_DISPLAYED) {
485                     self::createContactForSyncedUser($currentUser);
486                 }
487             }
488             
489             Tinebase_Timemachine_ModificationLog::setRecordMetaData($currentUser, 'update');
490             $syncedUser = $userBackend->updateUserInSqlBackend($currentUser);
491             if (! empty($user->container_id)) {
492                 $syncedUser->container_id = $user->container_id;
493             }
494             $userBackend->updatePluginUser($syncedUser, $user);
495             
496         } catch (Tinebase_Exception_NotFound $ten) {
497             try {
498                 $invalidUser = $userBackend->getUserByPropertyFromSqlBackend('accountLoginName', $username, 'Tinebase_Model_FullUser');
499                 if (Tinebase_Core::isLogLevel(Zend_Log::CRIT)) Tinebase_Core::getLogger()->crit(__METHOD__ . '::' . __LINE__ 
500                     . " Remove invalid user: " . $username);
501                 $userBackend->deleteUserInSqlBackend($invalidUser);
502             } catch (Tinebase_Exception_NotFound $ten) {
503                 // do nothing
504             }
505             
506             if ($user->visibility !== Tinebase_Model_FullUser::VISIBILITY_HIDDEN) {
507                 self::createContactForSyncedUser($user);
508             }
509             Tinebase_Timemachine_ModificationLog::setRecordMetaData($user, 'create');
510             $syncedUser = $userBackend->addUserInSqlBackend($user);
511             $userBackend->addPluginUser($syncedUser, $user);
512         }
513         
514         self::syncContactData($syncedUser, $options);
515         
516         Tinebase_Group::syncMemberships($syncedUser);
517
518         return $syncedUser;
519     }
520
521     /**
522      * import contact data(phone, address, fax, birthday. photo)
523      * 
524      * @param Tinebase_Model_FullUser $syncedUser
525      * @param array $options
526      */
527     public static function syncContactData($syncedUser, $options)
528     {
529         if (! Tinebase_Config::getInstance()->get(Tinebase_Config::SYNC_USER_CONTACT_DATA, true)
530                 || ! isset($options['syncContactData'])
531                 || ! $options['syncContactData']
532                 || ! Tinebase_Application::getInstance()->isInstalled('Addressbook')
533                 ||   $syncedUser->visibility === Tinebase_Model_FullUser::VISIBILITY_HIDDEN
534         ) {
535             if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
536                 . ' Contact data sync disabled');
537             return;
538         }
539         
540         $addressbook = Addressbook_Backend_Factory::factory(Addressbook_Backend_Factory::SQL);
541
542         try {
543             $contact = $addressbook->getByUserId($syncedUser->getId());
544             $originalContact = clone $contact;
545
546             if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . '::' . __LINE__
547                 . ' user: ' .print_r($syncedUser->toArray(), true));
548
549             Tinebase_User::getInstance()->updateContactFromSyncBackend($syncedUser, $contact);
550             $contact = self::_user2Contact($syncedUser, $contact);
551
552             if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . '::' . __LINE__
553                 . ' new contact: ' . print_r($contact->toArray(), true)
554                 . ' orig contact:' . print_r($originalContact->toArray(), true));
555
556             // TODO allow to diff jpegphoto, too / maybe this should only be done when called via CLI/cronjob
557             $diff = $contact->diff($originalContact, array('jpegphoto'));
558             if (! $diff->isEmpty() || ($originalContact->jpegphoto == 0 && ! empty($contact->jpegphoto))) {
559                 // add modlog info
560                 Tinebase_Timemachine_ModificationLog::setRecordMetaData($contact, 'update');
561                 if ($contact->container_id !== null) {
562                     Tinebase_Container::getInstance()->increaseContentSequence($contact->container_id);
563                 }
564                 
565                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
566                     . ' Updating contact data for user ' . $syncedUser->accountLoginName);
567                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
568                     . ' Diff: ' . print_r($diff->toArray(), true));
569
570                 $addressbook->update($contact);
571             } else {
572                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
573                     . ' User contact is up to date.');
574             }
575         } catch (Addressbook_Exception_NotFound $aenf) {
576             self::createContactForSyncedUser($syncedUser);
577             $syncedUser = Tinebase_User::getInstance()->updateUserInSqlBackend($syncedUser);
578
579         } catch (Tinebase_Exception_NotFound $tenf) {
580             if (Tinebase_Core::isLogLevel(Zend_Log::NOTICE)) Tinebase_Core::getLogger()->notice(__METHOD__ . '::' . __LINE__
581                 . ' Contact information seems to be missing in sync backend');
582             Tinebase_Exception::log($tenf);
583         }
584     }
585     
586     /**
587      * get primary group for user and make sure that group exists
588      * 
589      * @param Tinebase_Model_FullUser $user
590      * @throws Tinebase_Exception
591      * @return Tinebase_Model_Group
592      */
593     public static function getPrimaryGroupForUser($user)
594     {
595         $groupBackend = Tinebase_Group::getInstance();
596         
597         try {
598             $group = $groupBackend->getGroupById($user->accountPrimaryGroup);
599         } catch (Tinebase_Exception_Record_NotDefined $tern) {
600             if ($groupBackend->isDisabledBackend()) {
601                 // groups are sql only
602                 $group = $groupBackend->getDefaultGroup();
603                 $user->accountPrimaryGroup = $group->getId();
604             } else {
605                 try {
606                     $group = $groupBackend->getGroupByIdFromSyncBackend($user->accountPrimaryGroup);
607                 } catch (Tinebase_Exception_Record_NotDefined $ternd) {
608                     throw new Tinebase_Exception('Primary group ' . $user->accountPrimaryGroup . ' not found in sync backend.');
609                 }
610                 try {
611                     $groupBackend->getGroupByName($group->name);
612                     throw new Tinebase_Exception('Group already exists but it has a different ID: ' . $group->name);
613         
614                 } catch (Tinebase_Exception_Record_NotDefined $tern) {
615                     if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ 
616                         . " Adding group " . $group->name);
617                     $group = $groupBackend->addGroupInSqlBackend($group);
618                 }
619             }
620         }
621         
622         return $group;
623     }
624     
625     /**
626      * call configured hooks for adjusting synced user data
627      * 
628      * @param Tinebase_Model_FullUser $user
629      * @param array $userProperties
630      * @return boolean if false, user is skipped
631      */
632     protected static function _syncUserHook(Tinebase_Model_FullUser $user, $userProperties)
633     {
634         $result = true;
635         $hookClass = Tinebase_Config::getInstance()->get(Tinebase_Config::SYNC_USER_HOOK_CLASS);
636         if ($hookClass && class_exists($hookClass)) {
637             $hook = new $hookClass();
638             if (method_exists($hook, 'syncUser')) {
639                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
640                     . ' Calling ' . $hookClass . '::syncUser() ...');
641                 
642                 try {
643                     $result = call_user_func_array(array($hook, 'syncUser'), array($user, $userProperties));
644                 } catch (Tinebase_Exception $te) {
645                     Tinebase_Exception::log($te);
646                     return false;
647                 }
648             }
649         }
650         
651         return $result;
652     }
653     
654     /**
655      * create contact in addressbook
656      * 
657      * @param Tinebase_Model_FullUser $user
658      */
659     public static function createContactForSyncedUser($user)
660     {
661         if (! Tinebase_Application::getInstance()->isInstalled('Addressbook')) {
662             return;
663         }
664         
665         $contact = self::_user2Contact($user);
666         
667         // add modlog info
668         Tinebase_Timemachine_ModificationLog::setRecordMetaData($contact, 'create');
669         
670         $addressbook = Addressbook_Backend_Factory::factory(Addressbook_Backend_Factory::SQL);
671         $contact = $addressbook->create($contact);
672         
673         if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ 
674             . " Added contact " . $contact->n_given);
675         
676         $user->contact_id = $contact->getId();
677     }
678     
679     /**
680      * sync user data to contact
681      * 
682      * @param Tinebase_Model_FullUser $user
683      * @param Addressbook_Model_Contact $contact
684      * @return Addressbook_Model_Contact
685      */
686     protected static function _user2Contact($user, $contact = null)
687     {
688         if ($contact === null) {
689             $contact = new Addressbook_Model_Contact(array(), true);
690         }
691         
692         $contact->type = Addressbook_Model_Contact::CONTACTTYPE_USER;
693         
694         foreach (self::$_contact2UserMapping as $contactKey => $userKey) {
695             if (! empty($contact->{$contactKey}) && $contact->{$contactKey} == $user->{$userKey}) {
696                 continue;
697             }
698             
699             switch ($contactKey) {
700                 case 'container_id':
701                     $contact->container_id = (! empty($user->container_id)) ? $user->container_id : Admin_Controller_User::getInstance()->getDefaultInternalAddressbook();
702                     break;
703                 default:
704                     $contact->{$contactKey} = $user->{$userKey};
705             }
706         }
707         
708         return $contact;
709     }
710     
711     /**
712      * import users from sync backend
713      * 
714      * @param array $options
715      */
716     public static function syncUsers($options)
717     {
718         if (Tinebase_Core::isLogLevel(Zend_Log::INFO)) Tinebase_Core::getLogger()->info(__METHOD__ . '::' . __LINE__ 
719             .' Start synchronizing users with options ' . print_r($options, true));
720         
721         $users = Tinebase_User::getInstance()->getUsersFromSyncBackend(NULL, NULL, 'ASC', NULL, NULL, 'Tinebase_Model_FullUser');
722         
723         if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
724             . ' About to sync ' . count($users) . ' users from sync backend ...');
725         
726         foreach ($users as $user) {
727             try {
728                 self::syncUser($user, $options);
729             } catch (Tinebase_Exception_NotFound $ten) {
730                 Tinebase_Core::getLogger()->crit(__METHOD__ . '::' . __LINE__ . " User {$user->accountLoginName} not synced: "
731                     . $ten->getMessage());
732             }
733         }
734
735         if (isset($options['deleteUsers']) && $options['deleteUsers']) {
736             self::_syncDeletedUsers($users);
737         }
738         
739         if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
740             . ' Finished synchronizing users.');
741     }
742
743     /**
744      * deletes user in tine20 db that no longer exist in sync backend
745      *
746      * @param Tinebase_Record_RecordSet $usersInSyncBackend
747      */
748     protected static function _syncDeletedUsers(Tinebase_Record_RecordSet $usersInSyncBackend)
749     {
750         $userIdsInSqlBackend = Tinebase_User::getInstance()->getAllUserIdsFromSqlBackend();
751         $deletedInSyncBackend = array_diff($userIdsInSqlBackend, $usersInSyncBackend->getArrayOfIds());
752
753         if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
754             . ' About to delete / expire ' . count($deletedInSyncBackend) . ' users in SQL backend...');
755
756         foreach ($deletedInSyncBackend as $userToDelete) {
757             $user = Tinebase_User::getInstance()->getUserByPropertyFromSqlBackend('accountId', $userToDelete, 'Tinebase_Model_FullUser');
758
759             if (in_array($user->accountLoginName, self::getSystemUsernames())) {
760                 return;
761             }
762
763             // at first, we expire+deactivate the user
764             $now = Tinebase_DateTime::now();
765             if (! $user->accountExpires || $user->accountStatus !== Tinebase_Model_User::ACCOUNT_STATUS_DISABLED) {
766                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
767                     . ' Disable user and set expiry date of ' . $user->accountLoginName . ' to ' . $now);
768                 $user->accountExpires = $now;
769                 $user->accountStatus = Tinebase_Model_User::ACCOUNT_STATUS_DISABLED;
770                 Tinebase_User::getInstance()->updateUserInSqlBackend($user);
771             } else {
772                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
773                     . ' User already expired ' . print_r($user->toArray(), true));
774
775                 // TODO make time span configurable?
776                 if ($user->accountExpires->isEarlier($now->subYear(1))) {
777                     // if he or she is already expired longer than configured expiry, we remove them!
778                     Tinebase_User::getInstance()->deleteUserInSqlBackend($userToDelete);
779
780                     if (Tinebase_Application::getInstance()->isInstalled('Addressbook') === true && ! empty($user->contact_id)) {
781                         if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__
782                             . ' Deleting user contact of ' . $user->accountLoginName);
783
784                         $contactsBackend = Addressbook_Backend_Factory::factory(Addressbook_Backend_Factory::SQL);
785                         $contactsBackend->delete($user->contact_id);
786                     }
787                 } else {
788                     // keep user in expiry state
789                 }
790             }
791         }
792     }
793
794     /**
795      * returns login_names of system users
796      *
797      * @return array
798      */
799     public static function getSystemUsernames()
800     {
801         return array('cronuser', 'calendarscheduling');
802     }
803
804     /**
805      * get all user passwords from ldap
806      * - set pw for user (in sql and sql plugins)
807      * - do not encrypt the pw again as it is encrypted in LDAP
808      * 
809      * @throws Tinebase_Exception_Backend
810      */
811     public static function syncLdapPasswords()
812     {
813         $userBackend = Tinebase_User::getInstance();
814         if (! $userBackend instanceof Tinebase_User_Ldap) {
815             throw new Tinebase_Exception_Backend('Needs LDAP accounts backend');
816         }
817         
818         $result = $userBackend->getUserAttributes(array('entryUUID', 'userPassword'));
819         
820         if (Tinebase_Core::isLogLevel(Zend_Log::INFO)) Tinebase_Core::getLogger()->info(__METHOD__ . '::' . __LINE__
821             . ' About to sync ' . count($result) . ' user passwords from LDAP to Tine 2.0.');
822         
823         $sqlBackend = Tinebase_User::factory(self::SQL);
824         foreach ($result as $user) {
825             try {
826                 $sqlBackend->setPassword($user['entryUUID'], $user['userPassword'], FALSE);
827             } catch (Tinebase_Exception_NotFound $tenf) {
828                 if (Tinebase_Core::isLogLevel(Zend_Log::INFO)) Tinebase_Core::getLogger()->info(__METHOD__ . '::' . __LINE__
829                     . ' Could not find user with id ' . $user['entryUUID'] . ' in SQL backend.');
830             }
831         }
832     }
833     
834     /**
835      * create initial admin account
836      * 
837      * Method is called during Setup Initialization
838      *
839      * $_options may contain the following keys:
840      * <code>
841      * $options = array(
842      *  'adminLoginName'    => 'admin',
843      *  'adminPassword'     => 'lars',
844      *  'adminFirstName'    => 'Tine 2.0',
845      *  'adminLastName'     => 'Admin Account',
846      *  'adminEmailAddress' => 'admin@tine20domain.org',
847      *  'expires'            => Tinebase_DateTime object
848      * );
849      * </code>
850      *
851      * @param array $_options [hash that may contain override values for admin user name and password]
852      * @return void
853      * @throws Tinebase_Exception_InvalidArgument
854      */
855     public static function createInitialAccounts($_options)
856     {
857         if (! isset($_options['adminPassword']) || ! isset($_options['adminLoginName'])) {
858             throw new Tinebase_Exception_InvalidArgument('Admin password and login name have to be set when creating initial account.', 503);
859         }
860         
861         $adminLoginName     = $_options['adminLoginName'];
862         $adminPassword      = $_options['adminPassword'];
863         $adminFirstName     = isset($_options['adminFirstName'])    ? $_options['adminFirstName'] : 'Tine 2.0';
864         $adminLastName      = isset($_options['adminLastName'])     ? $_options['adminLastName']  : 'Admin Account';
865         $adminEmailAddress  = ((isset($_options['adminEmailAddress']) || array_key_exists('adminEmailAddress', $_options))) ? $_options['adminEmailAddress'] : NULL;
866
867         // get admin & user groups
868         $userBackend   = Tinebase_User::getInstance();
869         $groupsBackend = Tinebase_Group::getInstance();
870         
871         $adminGroup = $groupsBackend->getDefaultAdminGroup();
872         $userGroup  = $groupsBackend->getDefaultGroup();
873         
874         Tinebase_Core::getLogger()->info(__METHOD__ . '::' . __LINE__ . ' Creating initial admin user (login: ' . $adminLoginName . ' / email: ' . $adminEmailAddress . ')');
875
876         $user = new Tinebase_Model_FullUser(array(
877             'accountLoginName'      => $adminLoginName,
878             'accountStatus'         => Tinebase_Model_User::ACCOUNT_STATUS_ENABLED,
879             'accountPrimaryGroup'   => $userGroup->getId(),
880             'accountLastName'       => $adminLastName,
881             'accountDisplayName'    => $adminLastName . ', ' . $adminFirstName,
882             'accountFirstName'      => $adminFirstName,
883             'accountExpires'        => (isset($_options['expires'])) ? $_options['expires'] : NULL,
884             'accountEmailAddress'   => $adminEmailAddress
885         ));
886         
887         if ($adminEmailAddress !== NULL) {
888             $user->imapUser = new Tinebase_Model_EmailUser(array(
889                 'emailPassword' => $adminPassword
890             ));
891             $user->smtpUser = new Tinebase_Model_EmailUser(array(
892                 'emailPassword' => $adminPassword
893             ));
894         }
895
896         // update or create user in local sql backend
897         try {
898             $userBackend->getUserByProperty('accountLoginName', $adminLoginName);
899             Tinebase_Timemachine_ModificationLog::setRecordMetaData($user, 'update');
900             $user = $userBackend->updateUserInSqlBackend($user);
901         } catch (Tinebase_Exception_NotFound $ten) {
902             // call addUser here to make sure, sql user plugins (email, ...) are triggered
903             Tinebase_Timemachine_ModificationLog::setRecordMetaData($user, 'create');
904             $user = $userBackend->addUser($user);
905         }
906         
907         // set the password for the account
908         // empty password triggers password change dialogue during first login
909         if (!empty($adminPassword)) {
910             Tinebase_User::getInstance()->setPassword($user, $adminPassword);
911         }
912
913         // add the admin account to all groups
914         Tinebase_Group::getInstance()->addGroupMember($adminGroup, $user);
915         Tinebase_Group::getInstance()->addGroupMember($userGroup, $user);
916     }
917 }