Merged configuration refactoring from 'dev_config' branch back into master ...

Thomas Bruederli

2013-07-10 0703bfecd0b9efca36caee4f7b9c64c4135d57af

 program/lib/Roundcube/rcube_config.php

@@ -2,8 +2,6 @@

/*
 +-----------------------------------------------------------------------+
 | program/include/rcube_config.php                                      |
 |                                                                       |
 | This file is part of the Roundcube Webmail client                     |
 | Copyright (C) 2008-2012, The Roundcube Dev Team                       |
 |                                                                       |
@@ -13,7 +11,6 @@
 |                                                                       |
 | PURPOSE:                                                              |
 |   Class to read configuration settings                                |
 |                                                                       |
 +-----------------------------------------------------------------------+
 | Author: Thomas Bruederli <roundcube@gmail.com>                        |
 +-----------------------------------------------------------------------+
@@ -46,6 +43,8 @@
        'reply_mode'           => 'top_posting',
        'refresh_interval'     => 'keep_alive',
        'min_refresh_interval' => 'min_keep_alive',
        'messages_cache_ttl'   => 'message_cache_lifetime',
        'redundant_attachments_cache_ttl' => 'redundant_attachments_memcache_ttl',
    );


@@ -70,13 +69,22 @@
     */
    private function load()
    {
        // load main config file
        if (!$this->load_from_file(RCUBE_CONFIG_DIR . 'main.inc.php'))
            $this->errors[] = 'main.inc.php was not found.';
        // Load default settings
        if (!$this->load_from_file(RCUBE_CONFIG_DIR . 'defaults.inc.php')) {
            $this->errors[] = 'defaults.inc.php was not found.';
        }

        // load database config
        if (!$this->load_from_file(RCUBE_CONFIG_DIR . 'db.inc.php'))
            $this->errors[] = 'db.inc.php was not found.';
        // load main config file
        if (!$this->load_from_file(RCUBE_CONFIG_DIR . 'config.inc.php')) {
            // Old configuration files
            if (!$this->load_from_file(RCUBE_CONFIG_DIR . 'main.inc.php') ||
                !$this->load_from_file(RCUBE_CONFIG_DIR . 'db.inc.php')) {
                $this->errors[] = 'config.inc.php was not found.';
            }
            else if (rand(1,100) == 10) {  // log warning on every 100th request (average)
                trigger_error("config.inc.php was not found. Please migrate your config by running bin/update.sh", E_USER_WARNING);
            }
        }

        // load host-specific configuration
        $this->load_host_config();
@@ -101,11 +109,11 @@

        // fix default imap folders encoding
        foreach (array('drafts_mbox', 'junk_mbox', 'sent_mbox', 'trash_mbox') as $folder)
            $this->prop[$folder] = rcube_charset::convert($this->prop[$folder], RCMAIL_CHARSET, 'UTF7-IMAP');
            $this->prop[$folder] = rcube_charset::convert($this->prop[$folder], RCUBE_CHARSET, 'UTF7-IMAP');

        if (!empty($this->prop['default_folders']))
            foreach ($this->prop['default_folders'] as $n => $folder)
                $this->prop['default_folders'][$n] = rcube_charset::convert($folder, RCMAIL_CHARSET, 'UTF7-IMAP');
                $this->prop['default_folders'][$n] = rcube_charset::convert($folder, RCUBE_CHARSET, 'UTF7-IMAP');

        // set PHP error logging according to config
        if ($this->prop['debug_level'] & 1) {
@@ -176,8 +184,13 @@
            include($fpath);
            ob_end_clean();

            if (is_array($rcmail_config)) {
                $this->prop = array_merge($this->prop, $rcmail_config, $this->userprefs);
            if (is_array($config)) {
                $this->merge($config);
                return true;
            }
            // deprecated name of config variable
            else if (is_array($rcmail_config)) {
                $this->merge($rcmail_config);
                return true;
            }
        }
@@ -197,9 +210,6 @@
    {
        if (isset($this->prop[$name])) {
            $result = $this->prop[$name];
        }
        else if (isset($this->legacy_props[$name])) {
            return $this->get($this->legacy_props[$name], $def);
        }
        else {
            $result = $def;
@@ -244,6 +254,7 @@
    public function merge($prefs)
    {
        $this->prop = array_merge($this->prop, $prefs, $this->userprefs);
        $this->fix_legacy_props();
    }


@@ -275,6 +286,8 @@

        $this->userprefs = $prefs;
        $this->prop      = array_merge($this->prop, $prefs);

        $this->fix_legacy_props();

        // override timezone settings with client values
        if ($this->prop['timezone'] == 'auto') {
@@ -438,4 +451,18 @@
        return date_default_timezone_get();
    }

    /**
     * Convert legacy options into new ones
     */
    private function fix_legacy_props()
    {
        foreach ($this->legacy_props as $new => $old) {
            if (isset($this->prop[$old])) {
                if (!isset($this->prop[$new])) {
                    $this->prop[$new] = $this->prop[$old];
                }
                unset($this->prop[$old]);
            }
        }
    }
}