Merge branch '2015.11-develop' into 2016.11
[tine20] / tine20 / Tinebase / Config.php
1 <?php
2 /**
3  * Tine 2.0
4  * 
5  * @package     Tinebase
6  * @subpackage  Config
7  * @license     http://www.gnu.org/licenses/agpl.html AGPL Version 3
8  * @copyright   Copyright (c) 2007-2014 Metaways Infosystems GmbH (http://www.metaways.de)
9  * @author      Philipp Schüle <p.schuele@metaways.de>
10  * 
11  */
12
13 /**
14  * the class provides functions to handle config options
15  * 
16  * @package     Tinebase
17  * @subpackage  Config
18  * 
19  * @todo remove all deprecated stuff
20  */
21 class Tinebase_Config extends Tinebase_Config_Abstract
22 {
23     /**
24      * imap conf name
25      * 
26      * @var string
27      */
28     const IMAP = 'imap';
29     
30     /**
31      * smtp conf name
32      * 
33      * @var string
34      */
35     const SMTP = 'smtp';
36
37     /**
38      * sieve conf name
39      * 
40      * @var string
41      */
42     const SIEVE = 'sieve';
43
44     /**
45      * authentication backend config
46      * 
47      * @var string
48      */
49     const AUTHENTICATIONBACKEND = 'Tinebase_Authentication_BackendConfiguration';
50     
51     /**
52      * authentication backend type config
53      * 
54      * @var string
55      */
56     const AUTHENTICATIONBACKENDTYPE = 'Tinebase_Authentication_BackendType';
57     
58     /**
59      * save automatic alarms when creating new record
60      * 
61      * @var string
62      */
63     const AUTOMATICALARM = 'automaticalarm';
64     
65     /**
66      * user backend config
67      * 
68      * @var string
69      */
70     const USERBACKEND = 'Tinebase_User_BackendConfiguration';
71     
72     /**
73      * user backend type config
74      * 
75      * @var string
76      */
77     const USERBACKENDTYPE = 'Tinebase_User_BackendType';
78     
79     /**
80      * cronjob user id
81      * 
82      * @var string
83      */
84     const CRONUSERID = 'cronuserid';
85
86     /**
87      * setup user id
88      *
89      * @var string
90      */
91     const SETUPUSERID = 'setupuserid';
92
93     /**
94      * FEATURE_SHOW_ADVANCED_SEARCH
95      *
96      * @var string
97      */
98     const FEATURE_SHOW_ADVANCED_SEARCH = 'featureShowAdvancedSearch';
99
100     /**
101      * FEATURE_CONTAINER_CUSTOM_SORT
102      *
103      * @var string
104      */
105     const FEATURE_CONTAINER_CUSTOM_SORT = 'featureContainerCustomSort';
106
107     /**
108      * FEATURE_SHOW_ACCOUNT_EMAIL
109      *
110      * @var string
111      */
112     const FEATURE_SHOW_ACCOUNT_EMAIL = 'featureShowAccountEmail';
113
114     /**
115      * FEATURE_REMEMBER_POPUP_SIZE
116      *
117      * @var string
118      */
119     const FEATURE_REMEMBER_POPUP_SIZE = 'featureRememberPopupSize';
120
121     /**
122      * user defined page title postfix for browser page title
123      * 
124      * @var string
125      */
126     const PAGETITLEPOSTFIX = 'pagetitlepostfix';
127
128     /**
129      * logout redirect url
130      * 
131      * @var string
132      */
133     const REDIRECTURL = 'redirectUrl';
134     
135     /**
136      * redirect always
137      * 
138      * @var string
139      */
140     const REDIRECTALWAYS = 'redirectAlways';
141     
142     /**
143      * Config key for Setting "Redirect to referring site if exists?"
144      * 
145      * @var string
146      */
147     const REDIRECTTOREFERRER = 'redirectToReferrer';
148     
149     /**
150      * Config key for configuring allowed origins of the json frontend
151      *  
152      * @var string
153      */
154     const ALLOWEDJSONORIGINS = 'allowedJsonOrigins';
155     
156     /**
157      * Config key for acceptedTermsVersion
158      * @var string
159      */
160     const ACCEPTEDTERMSVERSION = 'acceptedTermsVersion';
161     
162     /**
163      * Config key for map panel in addressbook / include geoext code
164      * @var string
165      */
166     const MAPPANEL = 'mapPanel';
167
168     /**
169      * disable ldap certificate check
170      *
171      * @var string
172      */
173     const LDAP_DISABLE_TLSREQCERT = 'ldapDisableTlsReqCert';
174
175     /**
176      * overwritten ldap fields
177      *
178      * @var string
179      */
180     const LDAP_OVERWRITE_CONTACT_FIELDS = 'ldapOverwriteContactFields';
181
182     /**
183      * configure hook class for user sync
184      *
185      * @var string
186      */
187     const SYNC_USER_HOOK_CLASS = 'syncUserHookClass';
188     
189     /**
190      * configure if user contact data should be synced from sync backend
191      *
192      * @var boolean
193      */
194     const SYNC_USER_CONTACT_DATA = 'syncUserContactData';
195     
196     /**
197      * Config key for session ip validation -> if this is set to FALSE no Zend_Session_Validator_IpAddress is registered
198      * 
199      * @var string
200      */
201     const SESSIONIPVALIDATION = 'sessionIpValidation';
202     
203     /**
204      * Config key for session user agent validation -> if this is set to FALSE no Zend_Session_Validator_HttpUserAgent is registered
205      * 
206      * @var string
207      */
208     const SESSIONUSERAGENTVALIDATION = 'sessionUserAgentValidation';
209     
210     /**
211      * filestore directory
212      * 
213      * @var string
214      */
215     const FILESDIR = 'filesdir';
216     
217     /**
218      * xls export config
219      * 
220      * @deprecated move to app config
221      * @var string
222      */
223     const XLSEXPORTCONFIG = 'xlsexportconfig';
224     
225     /**
226      * app defaults
227      * 
228      * @deprecated move to app and split
229      * @var string
230      */
231     const APPDEFAULTS = 'appdefaults';
232     
233     /**
234     * REUSEUSERNAME_SAVEUSERNAME
235     *
236     * @var string
237     */
238     const REUSEUSERNAME_SAVEUSERNAME = 'saveusername';
239         
240     /**
241     * PASSWORD_CHANGE
242     *
243     * @var string
244     */
245     const PASSWORD_CHANGE = 'changepw';
246     
247     /**
248      * PASSWORD_POLICY_ACTIVE
249      *
250      * @var string
251      */
252     const PASSWORD_POLICY_ACTIVE = 'pwPolicyActive';
253     
254     /**
255      * PASSWORD_POLICY_ONLYASCII
256      *
257      * @var string
258      */
259     const PASSWORD_POLICY_ONLYASCII = 'pwPolicyOnlyASCII';
260     
261     /**
262      * PASSWORD_POLICY_MIN_LENGTH
263      *
264      * @var string
265      */
266     const PASSWORD_POLICY_MIN_LENGTH = 'pwPolicyMinLength';
267     
268     /**
269      * PASSWORD_POLICY_MIN_WORD_CHARS
270      *
271      * @var string
272      */
273     const PASSWORD_POLICY_MIN_WORD_CHARS = 'pwPolicyMinWordChars';
274     
275     /**
276      * PASSWORD_POLICY_MIN_UPPERCASE_CHARS
277      *
278      * @var string
279      */
280     const PASSWORD_POLICY_MIN_UPPERCASE_CHARS = 'pwPolicyMinUppercaseChars';
281     
282     /**
283      * PASSWORD_POLICY_MIN_SPECIAL_CHARS
284      *
285      * @var string
286      */
287     const PASSWORD_POLICY_MIN_SPECIAL_CHARS = 'pwPolicyMinSpecialChars';
288     
289     /**
290      * PASSWORD_POLICY_MIN_NUMBERS
291      *
292      * @var string
293      */
294     const PASSWORD_POLICY_MIN_NUMBERS = 'pwPolicyMinNumbers';
295     
296     /**
297      * PASSWORD_POLICY_FORBID_USERNAME
298      *
299      * @var string
300      */
301     const PASSWORD_POLICY_FORBID_USERNAME = 'pwPolicyForbidUsername';
302     
303     /**
304      * AUTOMATIC_BUGREPORTS
305      *
306      * @var string
307      */
308     const AUTOMATIC_BUGREPORTS = 'automaticBugreports';
309     
310     /**
311      * LAST_SESSIONS_CLEANUP_RUN
312      *
313      * @var string
314      */
315     const LAST_SESSIONS_CLEANUP_RUN = 'lastSessionsCleanupRun';
316     
317     /**
318      * WARN_LOGIN_FAILURES
319      *
320      * @var string
321      */
322     const WARN_LOGIN_FAILURES = 'warnLoginFailures';
323      
324     /**
325      * ANYONE_ACCOUNT_DISABLED
326      *
327      * @var string
328      */
329     const ANYONE_ACCOUNT_DISABLED = 'anyoneAccountDisabled';
330     
331     /**
332      * ALARMS_EACH_JOB
333      *
334      * @var string
335      */
336     const ALARMS_EACH_JOB = 'alarmsEachJob';
337     
338     /**
339      * ACCOUNT_DEACTIVATION_NOTIFICATION
340      *
341      * @var string
342      */
343     const ACCOUNT_DEACTIVATION_NOTIFICATION = 'accountDeactivationNotification';
344
345     /**
346      * ACCOUNT_DELETION_EVENTCONFIGURATION
347      *
348      * @var string
349      */
350     const ACCOUNT_DELETION_EVENTCONFIGURATION = 'accountDeletionEventConfiguration';
351     
352     /**
353      * roleChangeAllowed
354      *
355      * @var string
356      */
357     const ROLE_CHANGE_ALLOWED = 'roleChangeAllowed';
358     
359     /**
360      * max username length
361      *
362      * @var string
363      */
364     const MAX_USERNAME_LENGTH = 'max_username_length';
365
366     /**
367      * conf.d folder name
368      *
369      * @var string
370      */
371     const CONFD_FOLDER = 'confdfolder';
372
373     /**
374      * maintenance mode
375      *
376      * @var string
377      */
378     const MAINTENANCE_MODE = 'maintenanceMode';
379
380     /**
381      * @var string
382      */
383     const FAT_CLIENT_CUSTOM_JS = 'fatClientCustomJS';
384     
385     const BRANDING_LOGO = 'branding_logo';
386     const BRANDING_FAVICON = 'branding_favicon';
387     const BRANDING_TITLE = 'branding_title';
388     const BRANDING_WEBURL = 'branding_weburl';
389     const BRANDING_DESCRIPTION = 'branding_description';
390
391     /**
392      * @var string
393      */
394     const USE_LOGINNAME_AS_FOLDERNAME = 'useLoginnameAsFoldername';
395
396     /**
397      * @var string
398      */
399     const VERSION_CHECK = 'versionCheck';
400
401     /**
402      * (non-PHPdoc)
403      * @see tine20/Tinebase/Config/Definition::$_properties
404      */
405     protected static $_properties = array(
406         /**
407          * possible values:
408          *
409          * $_deletePersonalContainers => delete personal containers
410          * $_keepAsContact => keep "account" as contact in the addressbook
411          * $_keepOrganizerEvents => keep accounts organizer events as external events in the calendar
412          * $_keepAsContact => keep accounts calender event attendee as external attendee
413          *
414          * TODO add more options (like move to another container)
415          */
416         self::ACCOUNT_DELETION_EVENTCONFIGURATION => array(
417             //_('Account Deletion Event')
418             'label'                 => 'Account Deletion Event',
419             //_('Configure what should happen to data of deleted users')
420             'description'           => 'Configure what should happen to data of deleted users',
421             'type'                  => 'object',
422             'class'                 => 'Tinebase_Config_Struct',
423             'clientRegistryInclude' => FALSE,
424             'setByAdminModule'      => TRUE,
425             'setBySetupModule'      => TRUE,
426         ),
427         self::IMAP => array(
428                                    //_('System IMAP')
429             'label'                 => 'System IMAP',
430                                    //_('System IMAP server configuration.')
431             'description'           => 'System IMAP server configuration.',
432             'type'                  => 'object',
433             'class'                 => 'Tinebase_Config_Struct',
434             'clientRegistryInclude' => FALSE,
435             'setByAdminModule'      => FALSE,
436             'setBySetupModule'      => TRUE,
437         ),
438         self::SMTP => array(
439                                    //_('System SMTP')
440             'label'                 => 'System SMTP',
441                                    //_('System SMTP server configuration.')
442             'description'           => 'System SMTP server configuration.',
443             'type'                  => 'object',
444             'class'                 => 'Tinebase_Config_Struct',
445             'clientRegistryInclude' => FALSE,
446             'setByAdminModule'      => FALSE,
447             'setBySetupModule'      => TRUE,
448         ),
449         self::SIEVE => array(
450                                    //_('System SIEVE')
451             'label'                 => 'System SIEVE',
452                                    //_('System SIEVE server configuration.')
453             'description'           => 'System SIEVE server configuration.',
454             'type'                  => 'object',
455             'class'                 => 'Tinebase_Config_Struct',
456             'clientRegistryInclude' => FALSE,
457             'setByAdminModule'      => FALSE,
458             'setBySetupModule'      => TRUE,
459         ),
460         self::AUTHENTICATIONBACKENDTYPE => array(
461                                    //_('Authentication Backend')
462             'label'                 => 'Authentication Backend',
463                                    //_('Backend adapter for user authentication.')
464             'description'           => 'Backend adapter for user authentication.',
465             'type'                  => 'string',
466             'clientRegistryInclude' => FALSE,
467             'setByAdminModule'      => FALSE,
468             'setBySetupModule'      => TRUE,
469         ),
470         self::AUTHENTICATIONBACKEND => array(
471                                    //_('Authentication Configuration')
472             'label'                 => 'Authentication Configuration',
473                                    //_('Authentication backend configuration.')
474             'description'           => 'Authentication backend configuration.',
475             'type'                  => 'object',
476             'class'                 => 'Tinebase_Config_Struct',
477             'clientRegistryInclude' => FALSE,
478             'setByAdminModule'      => FALSE,
479             'setBySetupModule'      => TRUE,
480         ),
481         self::USERBACKENDTYPE => array(
482                                    //_('User Backend')
483             'label'                 => 'User Backend',
484                                    //_('Backend adapter for user data.')
485             'description'           => 'Backend adapter for user data.',
486             'type'                  => 'string',
487             'clientRegistryInclude' => FALSE,
488             'setByAdminModule'      => FALSE,
489             'setBySetupModule'      => TRUE,
490         ),
491         self::USERBACKEND => array(
492                                    //_('User Configuration')
493             'label'                 => 'User Configuration',
494                                    //_('User backend configuration.')
495             'description'           => 'User backend configuration.',
496             'type'                  => 'object',
497             'class'                 => 'Tinebase_Config_Struct',
498             'clientRegistryInclude' => FALSE,
499             'setByAdminModule'      => FALSE,
500             'setBySetupModule'      => TRUE,
501         ),
502         self::ENABLED_FEATURES => array(
503             //_('Enabled Features')
504             'label'                 => 'Enabled Features',
505             'description'           => 'Enabled Features',
506             'type'                  => 'object',
507             'class'                 => 'Tinebase_Config_Struct',
508             'clientRegistryInclude' => TRUE,
509             'content'               => array(
510                 self::FEATURE_SHOW_ADVANCED_SEARCH => array(
511                     'label'         => 'Show Advanced Search', //_('Show Advanced Search')
512                     'description'   => 'Show toggle button to switch on or off the advanced search for the quickfilter',
513                     //_('Show toggle button to switch on or off the advanced search for the quickfilter')
514                 ),
515                 self::FEATURE_CONTAINER_CUSTOM_SORT => array(
516                     'label'         => 'Container Custom Sort', //_('Container Custom Sort')
517                     'description'   => 'Allows to sort containers by setting the sort order in Admin/Container',
518                     //_('Allows to sort containers by setting the sort order in Admin/Container')
519                 ),
520                 self::FEATURE_SHOW_ACCOUNT_EMAIL => array(
521                     'label'         => 'Show Account Email Address', //_('Show Account Email Address')
522                     'description'   => 'Show email address in account picker and attendee grids',
523                     //_('Show email address in account picker and attendee grids')
524                 ),
525                 self::FEATURE_REMEMBER_POPUP_SIZE => array(
526                     'label'         => 'Remeber Popup Size', //_('Remeber Popup Size')
527                     'description'   => 'Save edit dialog size in state',
528                     //_('Save edit dialog size in state')
529                 ),
530             ),
531             'default'               => array(
532                 self::FEATURE_SHOW_ADVANCED_SEARCH  => true,
533                 self::FEATURE_CONTAINER_CUSTOM_SORT => true,
534                 self::FEATURE_SHOW_ACCOUNT_EMAIL    => true,
535                 self::FEATURE_REMEMBER_POPUP_SIZE   => true,
536             ),
537         ),
538         self::CRONUSERID => array(
539                                    //_('Cronuser ID')
540             'label'                 => 'Cronuser ID',
541                                    //_('User ID of the cron user.')
542             'description'           => 'User ID of the cron user.',
543             'type'                  => 'string',
544             'clientRegistryInclude' => FALSE,
545             'setByAdminModule'      => TRUE,
546             'setBySetupModule'      => TRUE,
547         ),
548         self::PAGETITLEPOSTFIX => array(
549                                    //_('Title Postfix')
550             'label'                 => 'Title Postfix',
551                                    //_('Postfix string appended to the title of this installation.')
552             'description'           => 'Postfix string appended to the title of this installation.',
553             'type'                  => 'string',
554             'clientRegistryInclude' => FALSE,
555             'setByAdminModule'      => TRUE,
556             'setBySetupModule'      => TRUE,
557         ),
558         self::REDIRECTURL => array(
559                                    //_('Redirect URL')
560             'label'                 => 'Redirect URL',
561                                    //_('Redirect to this URL after logout.')
562             'description'           => 'Redirect to this URL after logout.',
563             'type'                  => 'string',
564             'clientRegistryInclude' => FALSE,
565             'setByAdminModule'      => FALSE,
566             'setBySetupModule'      => TRUE,
567         ),
568         self::REDIRECTTOREFERRER => array(
569                                    //_('Redirect to Referrer')
570             'label'                 => 'Redirect to Referrer',
571                                    //_('Redirect to referrer after logout.')
572             'description'           => 'Redirect to referrer after logout.',
573             'type'                  => 'bool',
574             'clientRegistryInclude' => FALSE,
575             'setByAdminModule'      => FALSE,
576             'setBySetupModule'      => TRUE,
577         ),
578         self::REDIRECTALWAYS => array(
579                                    //_('Redirect Always')
580             'label'                 => 'Redirect Always',
581                                    //_('Redirect to configured redirect URL also for login.')
582             'description'           => 'Redirect to configured redirect URL also for login.',
583             'type'                  => 'bool',
584             'clientRegistryInclude' => FALSE,
585             'setByAdminModule'      => FALSE,
586             'setBySetupModule'      => TRUE,
587         ),
588         self::ALLOWEDJSONORIGINS => array(
589                                    //_('Allowed Origins')
590             'label'                 => 'Allowed Origins',
591                                    //_('Allowed Origins for the JSON API.')
592             'description'           => 'Allowed Origins for the JSON API.',
593             'type'                  => 'array',
594             'clientRegistryInclude' => FALSE,
595             'setByAdminModule'      => FALSE,
596             'setBySetupModule'      => FALSE,
597         ),
598         self::ACCEPTEDTERMSVERSION => array(
599                                    //_('Accepted Terms Version')
600             'label'                 => 'Accepted Terms Version',
601                                    //_('Accepted version number of the terms and conditions document.')
602             'description'           => 'Accepted version number of the terms and conditions document.',
603             'type'                  => 'int',
604             'clientRegistryInclude' => FALSE,
605             'setByAdminModule'      => FALSE,
606             'setBySetupModule'      => FALSE,
607         ),
608         self::MAPPANEL => array(
609                                    //_('Use Geolocation Services')
610             'label'                 => 'Use Geolocation Services',
611                                    //_('Use of external Geolocation services is allowed.')
612             'description'           => 'Use of external Geolocation services is allowed.',
613             'type'                  => 'bool',
614             'clientRegistryInclude' => TRUE,
615             'setByAdminModule'      => FALSE,
616             'setBySetupModule'      => TRUE,
617         ),
618         self::LDAP_DISABLE_TLSREQCERT => array(
619                                    //_('Disable LDAP TLS Certificate Check')
620             'label'                 => 'Disable LDAP TLS Certificate Check',
621                                    //_('LDAP TLS Certificate should not be checked')
622             'description'           => 'LDAP TLS Certificate should not be checked',
623             'type'                  => 'bool',
624             'clientRegistryInclude' => false,
625             'setByAdminModule'      => false,
626             'setBySetupModule'      => true,
627             'default'               => false
628         ),
629         // TODO should this be added to LDAP config array/struct?
630         // TODO does this depend on LDAP readonly option?
631         self::LDAP_OVERWRITE_CONTACT_FIELDS => array(
632             //_('Contact fields overwritten by LDAP')
633             'label'                 => 'Contact fields overwritten by LDAP',
634             //_('These fields are overwritten during LDAP sync if empty')
635             'description'           => 'These fields are overwritten during LDAP sync if empty',
636             'type'                  => 'array',
637             'clientRegistryInclude' => false,
638             'setByAdminModule'      => false,
639             'setBySetupModule'      => true,
640             'default'               => array()
641         ),
642         self::SYNC_USER_HOOK_CLASS => array(
643                                    //_('Configure hook class for user sync')
644             'label'                 => 'Configure hook class for user sync',
645                                    //_('Allows to change data after fetching user from sync backend')
646             'description'           => 'Allows to change data after fetching user from sync backend',
647             'type'                  => 'string',
648             'clientRegistryInclude' => false,
649             'setByAdminModule'      => false,
650             'setBySetupModule'      => true,
651         ),
652         self::SYNC_USER_CONTACT_DATA => array(
653             //_('Sync contact data from sync backend')
654             'label'                 => 'Sync contact data from sync backend',
655             //_('Sync user contact data from sync backend')
656             'description'           => 'Sync user contact data from sync backend',
657             'type'                  => 'bool',
658             'clientRegistryInclude' => FALSE,
659             'setByAdminModule'      => FALSE,
660             'setBySetupModule'      => FALSE,
661             'default'               => TRUE
662         ),
663         self::SESSIONIPVALIDATION => array(
664                                    //_('IP Session Validator')
665             'label'                 => 'IP Session Validator',
666                                    //_('Destroy session if the users IP changes.')
667             'description'           => 'Destroy session if the users IP changes.',
668             'type'                  => 'bool',
669             'clientRegistryInclude' => FALSE,
670             'setByAdminModule'      => FALSE,
671             'setBySetupModule'      => TRUE,
672         ),
673         self::SESSIONUSERAGENTVALIDATION => array(
674                                    //_('UA Session Validator')
675             'label'                 => 'UA Session Validator',
676                                    //_('Destroy session if the users user agent string changes.')
677             'description'           => 'Destroy session if the users user agent string changes.',
678             'type'                  => 'bool',
679             'clientRegistryInclude' => FALSE,
680             'setByAdminModule'      => FALSE,
681             'setBySetupModule'      => TRUE,
682         ),
683         self::FILESDIR => array(
684                                    //_('Files Directory')
685             'label'                 => 'Files Directory',
686                                    //_('Directory with web server write access for user files.')
687             'description'           => 'Directory with web server write access for user files.',
688             'type'                  => 'string',
689             'clientRegistryInclude' => FALSE,
690             'setByAdminModule'      => FALSE,
691             'setBySetupModule'      => TRUE,
692         ),
693         self::REUSEUSERNAME_SAVEUSERNAME => array(
694             //_('Reuse last username logged')
695             'label'                 => 'Reuse last username logged',
696             //_('Reuse last username logged')            
697             'description'           => 'Reuse last username logged',
698             'type'                  => 'bool',
699             'clientRegistryInclude' => FALSE,
700             'setByAdminModule'      => FALSE,
701             'setBySetupModule'      => TRUE,
702         ),
703         self::PASSWORD_CHANGE => array(
704         //_('User may change password')
705             'label'                 => 'User may change password',
706         //_('User may change password')
707             'description'           => 'User may change password',
708             'type'                  => 'bool',
709             'clientRegistryInclude' => TRUE,
710             'setByAdminModule'      => FALSE,
711             'setBySetupModule'      => TRUE,
712             'default'               => TRUE
713         ),
714         self::PASSWORD_POLICY_ACTIVE => array(
715         //_('Enable password policy')
716             'label'                 => 'Enable password policy',
717         //_('Enable password policy')
718             'description'           => 'Enable password policy',
719             'type'                  => 'bool',
720             'clientRegistryInclude' => FALSE,
721             'setByAdminModule'      => FALSE,
722             'setBySetupModule'      => TRUE,
723         ),
724         self::PASSWORD_POLICY_ONLYASCII => array(
725         //_('Only ASCII')
726             'label'                 => 'Only ASCII',
727         //_('Only ASCII characters are allowed in passwords.')
728             'description'           => 'Only ASCII characters are allowed in passwords.',
729             'type'                  => 'bool',
730             'clientRegistryInclude' => FALSE,
731             'setByAdminModule'      => FALSE,
732             'setBySetupModule'      => TRUE,
733         ),
734         self::PASSWORD_POLICY_MIN_LENGTH => array(
735         //_('Minimum length')
736             'label'                 => 'Minimum length',
737         //_('Minimum password length')
738             'description'           => 'Minimum password length.',
739             'type'                  => 'int',
740             'clientRegistryInclude' => FALSE,
741             'setByAdminModule'      => FALSE,
742             'setBySetupModule'      => TRUE,
743         ),
744         self::PASSWORD_POLICY_MIN_WORD_CHARS => array(
745         //_('Minimum word chars')
746             'label'                 => 'Minimum word chars',
747         //_('Minimum word chars in password')
748             'description'           => 'Minimum word chars in password',
749             'type'                  => 'int',
750             'clientRegistryInclude' => FALSE,
751             'setByAdminModule'      => FALSE,
752             'setBySetupModule'      => TRUE,
753         ),
754         self::PASSWORD_POLICY_MIN_UPPERCASE_CHARS => array(
755         //_('Minimum uppercase chars')
756             'label'                 => 'Minimum uppercase chars',
757         //_('Minimum uppercase chars in password')
758             'description'           => 'Minimum uppercase chars in password',
759             'type'                  => 'int',
760             'clientRegistryInclude' => FALSE,
761             'setByAdminModule'      => FALSE,
762             'setBySetupModule'      => TRUE,
763         ),
764         self::PASSWORD_POLICY_MIN_SPECIAL_CHARS => array(
765         //_('Minimum special chars')
766             'label'                 => 'Minimum special chars',
767         //_('Minimum special chars in password')
768             'description'           => 'Minimum special chars in password',
769             'type'                  => 'int',
770             'clientRegistryInclude' => FALSE,
771             'setByAdminModule'      => FALSE,
772             'setBySetupModule'      => TRUE,
773         ),
774         self::PASSWORD_POLICY_MIN_NUMBERS => array(
775         //_('Minimum numbers')
776             'label'                 => 'Minimum numbers',
777         //_('Minimum numbers in password')
778             'description'           => 'Minimum numbers in password',
779             'type'                  => 'int',
780             'clientRegistryInclude' => FALSE,
781             'setByAdminModule'      => FALSE,
782             'setBySetupModule'      => TRUE,
783         ),
784         self::PASSWORD_POLICY_FORBID_USERNAME => array(
785         //_('Forbid part of username')
786             'label'                 => 'Forbid part of username',
787         //_('Forbid part of username in password')
788             'description'           => 'Forbid part of username in password',
789             'type'                  => 'bool',
790             'clientRegistryInclude' => FALSE,
791             'setByAdminModule'      => FALSE,
792             'setBySetupModule'      => TRUE,
793         ),
794         self::AUTOMATIC_BUGREPORTS => array(
795                                    //_('Automatic bugreports')
796             'label'                 => 'Automatic bugreports',
797                                    //_('Always send bugreports, even on timeouts and other exceptions / failures.')
798             'description'           => 'Always send bugreports, even on timeouts and other exceptions / failures.',
799             'type'                  => 'bool',
800             'clientRegistryInclude' => TRUE,
801             'setByAdminModule'      => FALSE,
802             'setBySetupModule'      => TRUE,
803         ),
804         self::LAST_SESSIONS_CLEANUP_RUN => array(
805                                    //_('Last sessions cleanup run')
806             'label'                 => 'Last sessions cleanup run',
807                                    //_('Stores the timestamp of the last sessions cleanup task run.')
808             'description'           => 'Stores the timestamp of the last sessions cleanup task run.',
809             'type'                  => self::TYPE_DATETIME,
810             'clientRegistryInclude' => FALSE,
811             'setByAdminModule'      => FALSE,
812             'setBySetupModule'      => FALSE,
813         ),
814         self::WARN_LOGIN_FAILURES => array(
815             //_('Warn after X login failures')
816             'label'                 => 'Warn after X login failures',
817             //_('Maximum allowed login failures before writing warn log messages')
818             'description'           => 'Maximum allowed login failures before writing warn log messages',
819             'type'                  => 'int',
820             'clientRegistryInclude' => FALSE,
821             'setByAdminModule'      => FALSE,
822             'setBySetupModule'      => TRUE,
823             'default'               => 4
824         ),
825         self::ANYONE_ACCOUNT_DISABLED => array(
826                                    //_('Disable Anyone Account')
827             'label'                 => 'Disable Anyone Account',
828                                    //_('Disallow anyone account in grant configurations')
829             'description'           => 'Disallow anyone account in grant configurations',
830             'type'                  => 'bool',
831             'clientRegistryInclude' => TRUE,
832             'setByAdminModule'      => FALSE,
833             'setBySetupModule'      => TRUE,
834         ),
835         self::ALARMS_EACH_JOB => array(
836                                    //_('Alarms sent each job')
837             'label'                 => 'Alarms sent each job',
838                                    //_('Allows to configure the maximum number of alarm notifications in each run of sendPendingAlarms (0 = no limit)')
839             'description'           => 'Allows to configure the maximum number of alarm notifications in each run of sendPendingAlarms (0 = no limit)',
840             'type'                  => 'integer',
841             'clientRegistryInclude' => FALSE,
842             'setByAdminModule'      => FALSE,
843             'setBySetupModule'      => TRUE,
844         ),
845         self::ACCOUNT_DEACTIVATION_NOTIFICATION => array(
846             //_('Account deactivation notfication')
847             'label'                 => 'Account deactivation notfication',
848             //_('Send E-Mail to user if the account is deactivated or the user tries to login with deactivated account')
849             'description'           => 'Send E-Mail to User if the account is deactivated or the user tries to login with deactivated account',
850             'type'                  => 'bool',
851             'clientRegistryInclude' => FALSE,
852             'setByAdminModule'      => FALSE,
853             'setBySetupModule'      => TRUE,
854         ),
855         self::ROLE_CHANGE_ALLOWED => array(
856                                    //_('Role change allowed')
857             'label'                 => 'Role change allowed',
858                                    //_('Allows to configure which user is allowed to switch to another users account')
859             'description'           => 'Allows to configure which user is allowed to switch to another users account',
860             'type'                  => 'Tinebase_Config_Struct',
861             'clientRegistryInclude' => TRUE,
862             'setByAdminModule'      => FALSE,
863             'setBySetupModule'      => TRUE,
864         ),
865         self::MAX_USERNAME_LENGTH => array(
866             //_('Max username length')
867             'label'                 => 'Max username length',
868             //_('Max username length')
869             'description'           => 'Max username length',
870             'type'                  => 'int',
871             'default'               => NULL,
872             'clientRegistryInclude' => FALSE,
873         ),
874         self::CONFD_FOLDER => array(
875             //_('conf.d folder name')
876             'label'                 => 'conf.d folder name',
877             //_('Folder for additional config files (conf.d) - NOTE: this is only used if set in config.inc.php!')
878             'description'           => 'Folder for additional config files (conf.d) - NOTE: this is only used if set in config.inc.php!',
879             'type'                  => 'string',
880             'default'               => '',
881             'clientRegistryInclude' => FALSE,
882             'setByAdminModule'      => FALSE,
883             'setBySetupModule'      => FALSE,
884         ),
885         self::MAINTENANCE_MODE => array(
886             //_('Maintenance mode enabled')
887             'label'                 => 'Maintenance mode enabled',
888             //_('Folder for additional config files (conf.d) - NOTE: this is only used if set in config.inc.php!')
889             'description'           => 'Installation is in maintenance mode. With this only users having the maintenance right can login',
890             'type'                  => 'bool',
891             'default'               => '',
892             'clientRegistryInclude' => FALSE,
893             'setByAdminModule'      => TRUE,
894             'setBySetupModule'      => TRUE,
895         ),
896         self::VERSION_CHECK => array(
897             //_('Version check enabled')
898             'label'                 => 'Version check enabled',
899             'description'           => 'Version check enabled',
900             'type'                  => 'bool',
901             'default'               => true,
902             'clientRegistryInclude' => true,
903             'setByAdminModule'      => false,
904             'setBySetupModule'      => false,
905         ),
906         self::FAT_CLIENT_CUSTOM_JS => array(
907             // NOTE: it's possible to deliver customjs vom vfs by using the tine20:// streamwrapper
908             //       tine20://<applicationid>/folders/shared/<containerid>/custom.js
909             //_('Custom Javascript includes for Fat-Client')
910             'label'                 => 'Custom Javascript includes for Fat-Client',
911             //_('An array of javascript files to include for the fat client. This files might be stored outside the docroot of the webserver.')
912             'description'           => "An array of javascript files to include for the fat client. This files might be stored outside the docroot of the webserver.",
913             'type'                  => 'array',
914             'default'               => array(),
915             'clientRegistryInclude' => FALSE,
916             'setByAdminModule'      => FALSE,
917             'setBySetupModule'      => FALSE,
918         ),
919         self::BRANDING_DESCRIPTION => array(
920                 //_('custom description')
921                 'label'                 => 'custom description',
922                 //_('Custom description for branding.')
923                 'description'           => 'Custom description for branding.',
924                 'type'                  => 'string',
925                 'default'               => '',
926                 'clientRegistryInclude' => FALSE,
927                 'setByAdminModule'      => FALSE,
928                 'setBySetupModule'      => FALSE,
929         ),
930         self::BRANDING_WEBURL => array(
931                 //_('custom weburl')
932                 'label'                 => 'custom weburl',
933                 //_('Custom weburl for branding.')
934                 'description'           => 'Custom weburl for branding.',
935                 'type'                  => 'string',
936                 'default'               => '',
937                 'clientRegistryInclude' => FALSE,
938                 'setByAdminModule'      => FALSE,
939                 'setBySetupModule'      => FALSE,
940         ),
941         self::BRANDING_TITLE => array(
942                 //_('custom title')
943                 'label'                 => 'custom title',
944                 //_('Custom title for branding.')
945                 'description'           => 'Custom ltitle for branding.',
946                 'type'                  => 'string',
947                 'default'               => '',
948                 'clientRegistryInclude' => FALSE,
949                 'setByAdminModule'      => FALSE,
950                 'setBySetupModule'      => FALSE,
951         ),
952         self::BRANDING_LOGO => array(
953                 //_('custom logo path')
954                 'label'                 => 'custom logo path',
955                 //_('Path to custom logo.')
956                 'description'           => 'Path to custom logo.',
957                 'type'                  => 'string',
958                 'default'               => '',
959                 'clientRegistryInclude' => FALSE,
960                 'setByAdminModule'      => FALSE,
961                 'setBySetupModule'      => FALSE,
962         ),
963         self::BRANDING_FAVICON => array(
964                 //_('custom favicon path')
965                 'label'                 => 'custom favicon path',
966                 //_('Path to custom favicon.')
967                 'description'           => 'Path to custom favicon.',
968                 'type'                  => 'string',
969                 'default'               => '',
970                 'clientRegistryInclude' => FALSE,
971                 'setByAdminModule'      => FALSE,
972                 'setBySetupModule'      => FALSE,
973         ),
974         self::USE_LOGINNAME_AS_FOLDERNAME => array(
975         //_('Use login name instead of full name')
976             'label'                 => 'Use login name instead of full name',
977         //_('Use login name instead of full name for webdav.')
978             'description'           => 'Use login name instead of full name for webdav.',
979             'type'                  => 'bool',
980             'clientRegistryInclude' => FALSE,
981             'setByAdminModule'      => FALSE,
982             'setBySetupModule'      => FALSE,
983             'default'               => FALSE,
984         ),
985     );
986     
987     /**
988      * (non-PHPdoc)
989      * @see tine20/Tinebase/Config/Abstract::$_appName
990      */
991     protected $_appName = 'Tinebase';
992     
993     /**
994      * holds the instance of the singleton
995      *
996      * @var Tinebase_Config
997      */
998     private static $_instance = NULL;
999
1000     /**
1001      * server classes
1002      *
1003      * @var array
1004      */
1005     protected static $_serverPlugins = array(
1006         'Tinebase_Server_Plugin_Json'   => 80,
1007         'Tinebase_Server_Plugin_WebDAV' => 80,
1008         'Tinebase_Server_Plugin_Cli'    => 90,
1009         'Tinebase_Server_Plugin_Http'   => 100
1010     );
1011
1012     /**
1013      * the constructor
1014      *
1015      * don't use the constructor. use the singleton 
1016      */
1017     private function __construct() {}
1018     
1019     /**
1020      * the constructor
1021      *
1022      * don't use the constructor. use the singleton 
1023      */
1024     private function __clone() {}
1025     
1026     /**
1027      * Returns instance of Tinebase_Config
1028      *
1029      * @return Tinebase_Config
1030      */
1031     public static function getInstance() 
1032     {
1033         if (self::$_instance === NULL) {
1034             self::$_instance = new Tinebase_Config();
1035         }
1036         
1037         return self::$_instance;
1038     }
1039     
1040     /**
1041      * (non-PHPdoc)
1042      * @see tine20/Tinebase/Config/Abstract::getProperties()
1043      */
1044     public static function getProperties()
1045     {
1046         return self::$_properties;
1047     }
1048     
1049     /**
1050      * get config for client registry
1051      * 
1052      * @return Tinebase_Config_Struct
1053      */
1054     public function getClientRegistryConfig()
1055     {
1056         // get all config names to be included in registry
1057         $clientProperties = new Tinebase_Config_Struct(array());
1058         $userApplications = Tinebase_Core::getUser()->getApplications(TRUE);
1059         foreach ($userApplications as $application) {
1060             $config = Tinebase_Config_Abstract::factory($application->name);
1061             if ($config) {
1062                 $clientProperties[$application->name] = new Tinebase_Config_Struct(array());
1063                 $properties = $config->getProperties();
1064                 foreach ((array) $properties as $name => $definition) {
1065                     
1066                     if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . '::' . __LINE__ 
1067                         . ' ' . print_r($definition, TRUE));
1068                     
1069                     if ((isset($definition['clientRegistryInclude']) || array_key_exists('clientRegistryInclude', $definition))
1070                         && $definition['clientRegistryInclude'] === TRUE)
1071                     {
1072                         // add definition here till we have a better place
1073                         try {
1074                             $configRegistryItem = new Tinebase_Config_Struct(array(
1075                                 'value' => $config->{$name},
1076                                 'definition' => new Tinebase_Config_Struct($definition),
1077                             ));
1078                             if (Tinebase_Core::isLogLevel(Zend_Log::TRACE)) Tinebase_Core::getLogger()->trace(__METHOD__ . '::' . __LINE__
1079                                 . ' ' . print_r($configRegistryItem->toArray(), TRUE));
1080                             $clientProperties[$application->name][$name] = $configRegistryItem;
1081                         } catch (Exception $e) {
1082                             Tinebase_Exception::log($e);
1083                         }
1084                     }
1085                 }
1086                 if (Tinebase_Core::isLogLevel(Zend_Log::DEBUG)) Tinebase_Core::getLogger()->debug(__METHOD__ . '::' . __LINE__ 
1087                     . ' Got ' . count($clientProperties[$application->name]) . ' config items for ' . $application->name . '.');
1088             }
1089         }
1090         
1091         return $clientProperties;
1092     }
1093     
1094     /**
1095      * get application config
1096      *
1097      * @param  string  $applicationName Application name
1098      * @return Tinebase_Config_Abstract  $configClass
1099      */
1100     public static function getAppConfig($applicationName)
1101     {
1102         $configClassName = $applicationName . '_Config';
1103         if (@class_exists($configClassName)) {
1104             return $configClassName::getInstance();
1105         } else {
1106             if (Tinebase_Core::isLogLevel(Zend_Log::INFO)) Tinebase_Core::getLogger()->info(__METHOD__ . '::' . __LINE__
1107                 . ' Application ' . $applicationName . ' has no config.');
1108             return NULL;
1109         }
1110     }
1111     
1112     /**
1113      * get option setting string
1114      * 
1115      * @deprecated
1116      * @param Tinebase_Record_Interface $_record
1117      * @param string $_id
1118      * @param string $_label
1119      * @return string
1120      */
1121     public static function getOptionString($_record, $_label)
1122     {
1123         $controller = Tinebase_Core::getApplicationInstance($_record->getApplication());
1124         $settings = $controller->getConfigSettings();
1125         $idField = $_label . '_id';
1126         
1127         $option = $settings->getOptionById($_record->{$idField}, $_label . 's');
1128         
1129         $result = (isset($option[$_label])) ? $option[$_label] : '';
1130         
1131         return $result;
1132     }
1133 }