Thomas Bruederli
2014-12-29 bca7dc68e9f73e863e3a65173a8883c99dc09e3a
program/lib/Roundcube/rcube_config.php
@@ -3,7 +3,7 @@
/*
 +-----------------------------------------------------------------------+
 | This file is part of the Roundcube Webmail client                     |
 | Copyright (C) 2008-2012, The Roundcube Dev Team                       |
 | Copyright (C) 2008-2013, The Roundcube Dev Team                       |
 |                                                                       |
 | Licensed under the GNU General Public License version 3 or            |
 | any later version with exceptions for skins & plugins.                |
@@ -27,7 +27,7 @@
    const DEFAULT_SKIN = 'larry';
    private $env = '';
    private $basedir = 'config/';
    private $paths = array();
    private $prop = array();
    private $errors = array();
    private $userprefs = array();
@@ -39,7 +39,6 @@
     */
    private $legacy_props = array(
        // new name => old name
        'default_folders'      => 'default_imap_folders',
        'mail_pagesize'        => 'pagesize',
        'addressbook_pagesize' => 'pagesize',
        'reply_mode'           => 'top_posting',
@@ -58,7 +57,32 @@
    public function __construct($env = '')
    {
        $this->env = $env;
        $this->basedir = RCUBE_CONFIG_DIR;
        if ($paths = getenv('RCUBE_CONFIG_PATH')) {
            $this->paths = explode(PATH_SEPARATOR, $paths);
            // make all paths absolute
            foreach ($this->paths as $i => $path) {
                if (!rcube_utils::is_absolute_path($path)) {
                    if ($realpath = realpath(RCUBE_INSTALL_PATH . $path)) {
                        $this->paths[$i] = unslashify($realpath) . '/';
                    }
                    else {
                        unset($this->paths[$i]);
                    }
                }
                else {
                    $this->paths[$i] = unslashify($path) . '/';
                }
            }
        }
        if (defined('RCUBE_CONFIG_DIR') && !in_array(RCUBE_CONFIG_DIR, $this->paths)) {
            $this->paths[] = RCUBE_CONFIG_DIR;
        }
        if (empty($this->paths)) {
            $this->paths[] = RCUBE_INSTALL_PATH . 'config/';
        }
        $this->load();
@@ -66,6 +90,107 @@
        // but contain information that is used in various
        // locations in the code:
        $this->set('contactlist_fields', array('name', 'firstname', 'surname', 'email'));
    }
    /**
     * @brief Guess the type the string may fit into.
     *
     * Look inside the string to determine what type might be best as a container.
     *
     * @param $value The value to inspect
     *
     * @return The guess at the type.
     */
    private function guess_type($value)
    {
        $_ = 'string';
        // array requires hint to be passed.
        if (preg_match('/^[-+]?(\d+(\.\d*)?|\.\d+)([eE][-+]?\d+)?$/', $value) !== false) {
            $_ = 'double';
        }
        else if (preg_match('/^\d+$/', $value) !== false) {
            $_ = 'integer';
        }
        else if (preg_match('/(t(rue)?)|(f(alse)?)/i', $value) !== false) {
            $_ = 'boolean';
        }
        return $_;
    }
    /**
     * @brief Parse environment variable into PHP type.
     *
     * Perform an appropriate parsing of the string to create the desired PHP type.
     *
     * @param $string String to parse into PHP type
     * @param $type Type of value to return
     *
     * @return Appropriately typed interpretation of $string.
     */
    private function parse_env($string, $type)
    {
        $_ = $string;
        switch ($type) {
        case 'boolean':
            $_ = (boolean) $_;
            break;
        case 'integer':
            $_ = (integer) $_;
            break;
        case 'double':
            $_ = (double) $_;
            break;
        case 'string':
            break;
        case 'array':
            $_ = json_decode($_, true);
            break;
        case 'object':
            $_ = json_decode($_, false);
            break;
        case 'resource':
        case 'NULL':
        default:
            $_ = $this->parse_env($_, $this->guess_type($_));
        }
        return $_;
    }
    /**
     * @brief Get environment variable value.
     *
     * Retrieve an environment variable's value or if it's not found, return the
     * provided default value.
     *
     * @param $varname Environment variable name
     * @param $default_value Default value to return if necessary
     * @param $type Type of value to return
     *
     * @return Value of the environment variable or default if not found.
     */
    private function getenv_default($varname, $default_value, $type = null)
    {
        $_ = getenv($varname);
        if ($_ === false) {
            $_ = $default_value;
        }
        else {
            if (is_null($type)) {
                $type = gettype($default_value);
            }
            $_ = $this->parse_env($_, $type);
        }
        return $_;
    }
@@ -94,8 +219,7 @@
        }
        // load host-specific configuration
        if (!empty($_SERVER['HTTP_HOST']))
            $this->load_host_config();
        $this->load_host_config();
        // set skin (with fallback to old 'skin_path' property)
        if (empty($this->prop['skin'])) {
@@ -118,10 +242,6 @@
        // 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], 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, RCUBE_CHARSET, 'UTF7-IMAP');
        // set PHP error logging according to config
        if ($this->prop['debug_level'] & 1) {
@@ -151,20 +271,30 @@
     */
    private function load_host_config()
    {
        $fname = null;
        if (is_array($this->prop['include_host_config'])) {
            $fname = $this->prop['include_host_config'][$_SERVER['HTTP_HOST']];
        }
        else if (!empty($this->prop['include_host_config'])) {
            $fname = preg_replace('/[^a-z0-9\.\-_]/i', '', $_SERVER['HTTP_HOST']) . '.inc.php';
        if (empty($this->prop['include_host_config'])) {
            return;
        }
        if ($fname) {
            $this->load_from_file($fname);
        foreach (array('HTTP_HOST', 'SERVER_NAME', 'SERVER_ADDR') as $key) {
            $fname = null;
            $name  = $_SERVER[$key];
            if (!$name) {
                continue;
            }
            if (is_array($this->prop['include_host_config'])) {
                $fname = $this->prop['include_host_config'][$name];
            }
            else {
                $fname = preg_replace('/[^a-z0-9\.\-_]/i', '', $name) . '.inc.php';
            }
            if ($fname && $this->load_from_file($fname)) {
                return;
            }
        }
    }
    /**
     * Read configuration from a file
@@ -175,47 +305,65 @@
     */
    public function load_from_file($file)
    {
        $fpath = $this->resolve_path($file);
        if ($fpath && is_file($fpath) && is_readable($fpath)) {
            // use output buffering, we don't need any output here
            ob_start();
            include($fpath);
            ob_end_clean();
        $success = false;
            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;
        foreach ($this->resolve_paths($file) as $fpath) {
            if ($fpath && is_file($fpath) && is_readable($fpath)) {
                // use output buffering, we don't need any output here
                ob_start();
                include($fpath);
                ob_end_clean();
                if (is_array($config)) {
                    $this->merge($config);
                    $success = true;
                }
                // deprecated name of config variable
                if (is_array($rcmail_config)) {
                    $this->merge($rcmail_config);
                    $success = true;
                }
            }
        }
        return false;
        return $success;
    }
    /**
     * Helper method to resolve the absolute path to the given config file.
     * Helper method to resolve absolute paths to the given config file.
     * This also takes the 'env' property into account.
     *
     * @param string  Filename or absolute file path
     * @param boolean Return -$env file path if exists
     * @return array  List of candidates in config dir path(s)
     */
    public function resolve_path($file, $use_env = true)
    public function resolve_paths($file, $use_env = true)
    {
        if (strpos($file, '/') === false) {
            $file = realpath($this->basedir . '/' . $file);
        $files    = array();
        $abs_path = rcube_utils::is_absolute_path($file);
        foreach ($this->paths as $basepath) {
            $realpath = $abs_path ? $file : realpath($basepath . '/' . $file);
            // check if <file>-env.ini exists
            if ($realpath && $use_env && !empty($this->env)) {
                $envfile = preg_replace('/\.(inc.php)$/', '-' . $this->env . '.\\1', $realpath);
                if (is_file($envfile))
                    $realpath = $envfile;
            }
            if ($realpath) {
                $files[] = $realpath;
                // no need to continue the loop if an absolute file path is given
                if ($abs_path) {
                    break;
                }
            }
        }
        // check if <file>-env.ini exists
        if ($file && $use_env && !empty($this->env)) {
            $envfile = preg_replace('/\.(inc.php)$/', '-' . $this->env . '.\\1', $file);
            if (is_file($envfile))
                return $envfile;
        }
        return $file;
        return $files;
    }
    /**
     * Getter for a specific config parameter
@@ -232,6 +380,8 @@
        else {
            $result = $def;
        }
        $result = $this->getenv_default('ROUNDCUBE_' . strtoupper($name), $result);
        $rcube = rcube::get_instance();
@@ -313,7 +463,16 @@
     */
    public function all()
    {
        return $this->prop;
        $props = $this->prop;
   foreach ($props as $prop_name => $prop_value)
            $props[$prop_name] = $this->getenv_default('ROUNDCUBE_' . strtoupper($prop_name), $prop_value);
        $rcube  = rcube::get_instance();
        $plugin = $rcube->plugins->exec_hook('config_get', array(
            'name' => '*', 'result' => $props));
        return $plugin['result'];
    }
    /**
@@ -478,7 +637,7 @@
        // convert deprecated numeric timezone value
        if (isset($props['timezone']) && is_numeric($props['timezone'])) {
            if ($tz = timezone_name_from_abbr("", $props['timezone'] * 3600, 0)) {
            if ($tz = self::timezone_name_from_abbr($props['timezone'])) {
                $props['timezone'] = $tz;
            }
            else {
@@ -488,4 +647,65 @@
        return $props;
    }
    /**
     * timezone_name_from_abbr() replacement. Converts timezone offset
     * into timezone name abbreviation.
     *
     * @param float $offset Timezone offset (in hours)
     *
     * @return string Timezone abbreviation
     */
    static public function timezone_name_from_abbr($offset)
    {
        // List of timezones here is not complete - https://bugs.php.net/bug.php?id=44780
        if ($tz = timezone_name_from_abbr('', $offset * 3600, 0)) {
            return $tz;
        }
        // try with more complete list (#1489261)
        $timezones = array(
            '-660' => "Pacific/Apia",
            '-600' => "Pacific/Honolulu",
            '-570' => "Pacific/Marquesas",
            '-540' => "America/Anchorage",
            '-480' => "America/Los_Angeles",
            '-420' => "America/Denver",
            '-360' => "America/Chicago",
            '-300' => "America/New_York",
            '-270' => "America/Caracas",
            '-240' => "America/Halifax",
            '-210' => "Canada/Newfoundland",
            '-180' => "America/Sao_Paulo",
             '-60' => "Atlantic/Azores",
               '0' => "Europe/London",
              '60' => "Europe/Paris",
             '120' => "Europe/Helsinki",
             '180' => "Europe/Moscow",
             '210' => "Asia/Tehran",
             '240' => "Asia/Dubai",
             '300' => "Asia/Karachi",
             '270' => "Asia/Kabul",
             '300' => "Asia/Karachi",
             '330' => "Asia/Kolkata",
             '345' => "Asia/Katmandu",
             '360' => "Asia/Yekaterinburg",
             '390' => "Asia/Rangoon",
             '420' => "Asia/Krasnoyarsk",
             '480' => "Asia/Shanghai",
             '525' => "Australia/Eucla",
             '540' => "Asia/Tokyo",
             '570' => "Australia/Adelaide",
             '600' => "Australia/Melbourne",
             '630' => "Australia/Lord_Howe",
             '660' => "Asia/Vladivostok",
             '690' => "Pacific/Norfolk",
             '720' => "Pacific/Auckland",
             '765' => "Pacific/Chatham",
             '780' => "Pacific/Enderbury",
             '840' => "Pacific/Kiritimati",
        );
        return $timezones[(string) intval($offset * 60)];
    }
}