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