program/include/rcube_config.php

   1 <?php
   2
   3 /*
   4  +-----------------------------------------------------------------------+
   5  | program/include/rcube_config.php                                      |
   6  |                                                                       |
   7  | This file is part of the Roundcube Webmail client                     |
   8  | Copyright (C) 2008-2010, The Roundcube Dev Team                       |
   9  | Licensed under the GNU GPL                                            |
  10  |                                                                       |
  11  | PURPOSE:                                                              |
  12  |   Class to read configuration settings                                |
  13  |                                                                       |
  14  +-----------------------------------------------------------------------+
  15  | Author: Thomas Bruederli <roundcube@gmail.com>                        |
  16  +-----------------------------------------------------------------------+
  17
  18  $Id: rcube_config.php 5151 2011-08-31 12:49:44Z alec $
  19
  20 */
  21
  22 /**
  23  * Configuration class for Roundcube
  24  *
  25  * @package Core
  26  */
  27 class rcube_config
  28 {
  29     private $prop = array();
  30     private $errors = array();
  31     private $userprefs = array();
  32
  33
  34     /**
  35      * Object constructor
  36      */
  37     public function __construct()
  38     {
  39         $this->load();
  40     }
  41
  42
  43     /**
  44      * Load config from local config file
  45      *
  46      * @todo Remove global $CONFIG
  47      */
  48     private function load()
  49     {
  50         // load main config file
  51         if (!$this->load_from_file(RCMAIL_CONFIG_DIR . '/main.inc.php'))
  52             $this->errors[] = 'main.inc.php was not found.';
  53
  54         // load database config
  55         if (!$this->load_from_file(RCMAIL_CONFIG_DIR . '/db.inc.php'))
  56             $this->errors[] = 'db.inc.php was not found.';
  57
  58         // load host-specific configuration
  59         $this->load_host_config();
  60
  61         // set skin (with fallback to old 'skin_path' property)
  62         if (empty($this->prop['skin']) && !empty($this->prop['skin_path']))
  63             $this->prop['skin'] = str_replace('skins/', '', unslashify($this->prop['skin_path']));
  64         else if (empty($this->prop['skin']))
  65             $this->prop['skin'] = 'default';
  66
  67         // fix paths
  68         $this->prop['log_dir'] = $this->prop['log_dir'] ? realpath(unslashify($this->prop['log_dir'])) : INSTALL_PATH . 'logs';
  69         $this->prop['temp_dir'] = $this->prop['temp_dir'] ? realpath(unslashify($this->prop['temp_dir'])) : INSTALL_PATH . 'temp';
  70
  71         // fix default imap folders encoding
  72         foreach (array('drafts_mbox', 'junk_mbox', 'sent_mbox', 'trash_mbox') as $folder)
  73             $this->prop[$folder] = rcube_charset_convert($this->prop[$folder], RCMAIL_CHARSET, 'UTF7-IMAP');
  74
  75         if (!empty($this->prop['default_imap_folders']))
  76             foreach ($this->prop['default_imap_folders'] as $n => $folder)
  77                 $this->prop['default_imap_folders'][$n] = rcube_charset_convert($folder, RCMAIL_CHARSET, 'UTF7-IMAP');
  78
  79         // set PHP error logging according to config
  80         if ($this->prop['debug_level'] & 1) {
  81             ini_set('log_errors', 1);
  82
  83             if ($this->prop['log_driver'] == 'syslog') {
  84                 ini_set('error_log', 'syslog');
  85             }
  86             else {
  87                 ini_set('error_log', $this->prop['log_dir'].'/errors');
  88             }
  89         }
  90
  91         // enable display_errors in 'show' level, but not for ajax requests
  92         ini_set('display_errors', intval(empty($_REQUEST['_remote']) && ($this->prop['debug_level'] & 4)));
  93
  94         // export config data
  95         $GLOBALS['CONFIG'] = &$this->prop;
  96     }
  97
  98     /**
  99      * Load a host-specific config file if configured
 100      * This will merge the host specific configuration with the given one
 101      */
 102     private function load_host_config()
 103     {
 104         $fname = null;
 105
 106         if (is_array($this->prop['include_host_config'])) {
 107             $fname = $this->prop['include_host_config'][$_SERVER['HTTP_HOST']];
 108         }
 109         else if (!empty($this->prop['include_host_config'])) {
 110             $fname = preg_replace('/[^a-z0-9\.\-_]/i', '', $_SERVER['HTTP_HOST']) . '.inc.php';
 111         }
 112
 113         if ($fname) {
 114             $this->load_from_file(RCMAIL_CONFIG_DIR . '/' . $fname);
 115         }
 116     }
 117
 118
 119     /**
 120      * Read configuration from a file
 121      * and merge with the already stored config values
 122      *
 123      * @param string $fpath Full path to the config file to be loaded
 124      * @return booelan True on success, false on failure
 125      */
 126     public function load_from_file($fpath)
 127     {
 128         if (is_file($fpath) && is_readable($fpath)) {
 129             // use output buffering, we don't need any output here
 130             ob_start();
 131             include($fpath);
 132             ob_end_clean();
 133
 134             if (is_array($rcmail_config)) {
 135                 $this->prop = array_merge($this->prop, $rcmail_config, $this->userprefs);
 136                 return true;
 137             }
 138         }
 139
 140         return false;
 141     }
 142
 143
 144     /**
 145      * Getter for a specific config parameter
 146      *
 147      * @param  string $name Parameter name
 148      * @param  mixed  $def  Default value if not set
 149      * @return mixed  The requested config value
 150      */
 151     public function get($name, $def = null)
 152     {
 153         $result = isset($this->prop[$name]) ? $this->prop[$name] : $def;
 154         $rcmail = rcmail::get_instance();
 155
 156         if (is_object($rcmail->plugins)) {
 157             $plugin = $rcmail->plugins->exec_hook('config_get', array(
 158                 'name' => $name, 'default' => $def, 'result' => $result));
 159
 160             return $plugin['result'];
 161         }
 162
 163         return $result;
 164     }
 165
 166
 167     /**
 168      * Setter for a config parameter
 169      *
 170      * @param string $name  Parameter name
 171      * @param mixed  $value Parameter value
 172      */
 173     public function set($name, $value)
 174     {
 175         $this->prop[$name] = $value;
 176     }
 177
 178
 179     /**
 180      * Override config options with the given values (eg. user prefs)
 181      *
 182      * @param array $prefs Hash array with config props to merge over
 183      */
 184     public function merge($prefs)
 185     {
 186         $this->prop = array_merge($this->prop, $prefs, $this->userprefs);
 187     }
 188
 189
 190     /**
 191      * Merge the given prefs over the current config
 192      * and make sure that they survive further merging.
 193      *
 194      * @param array $prefs Hash array with user prefs
 195      */
 196     public function set_user_prefs($prefs)
 197     {
 198         // Honor the dont_override setting for any existing user preferences
 199         $dont_override = $this->get('dont_override');
 200         if (is_array($dont_override) && !empty($dont_override)) {
 201             foreach ($prefs as $key => $pref) {
 202                 if (in_array($key, $dont_override)) {
 203                     unset($prefs[$key]);
 204                 }
 205             }
 206         }
 207
 208         $this->userprefs = $prefs;
 209         $this->prop      = array_merge($this->prop, $prefs);
 210     }
 211
 212
 213     /**
 214      * Getter for all config options
 215      *
 216      * @return array  Hash array containg all config properties
 217      */
 218     public function all()
 219     {
 220         return $this->prop;
 221     }
 222
 223     /**
 224      * Special getter for user's timezone
 225      */
 226     public function get_timezone()
 227     {
 228       $tz = $this->get('timezone');
 229       if ($tz == 'auto')
 230         $tz = isset($_SESSION['timezone']) ? $_SESSION['timezone'] : date('Z') / 3600;
 231       else
 232         $tz = intval($tz) + intval($this->get('dst_active'));
 233
 234       return $tz;
 235     }
 236
 237     /**
 238      * Return requested DES crypto key.
 239      *
 240      * @param string $key Crypto key name
 241      * @return string Crypto key
 242      */
 243     public function get_crypto_key($key)
 244     {
 245         // Bomb out if the requested key does not exist
 246         if (!array_key_exists($key, $this->prop)) {
 247             raise_error(array(
 248                 'code' => 500, 'type' => 'php',
 249                 'file' => __FILE__, 'line' => __LINE__,
 250                 'message' => "Request for unconfigured crypto key \"$key\""
 251             ), true, true);
 252         }
 253
 254         $key = $this->prop[$key];
 255
 256         // Bomb out if the configured key is not exactly 24 bytes long
 257         if (strlen($key) != 24) {
 258             raise_error(array(
 259                 'code' => 500, 'type' => 'php',
 260                     'file' => __FILE__, 'line' => __LINE__,
 261                 'message' => "Configured crypto key '$key' is not exactly 24 bytes long"
 262             ), true, true);
 263         }
 264
 265         return $key;
 266     }
 267
 268
 269     /**
 270      * Try to autodetect operating system and find the correct line endings
 271      *
 272      * @return string The appropriate mail header delimiter
 273      */
 274     public function header_delimiter()
 275     {
 276         // use the configured delimiter for headers
 277         if (!empty($this->prop['mail_header_delimiter'])) {
 278             $delim = $this->prop['mail_header_delimiter'];
 279             if ($delim == "\n" || $delim == "\r\n")
 280                 return $delim;
 281             else
 282                 raise_error(array(
 283                     'code' => 500, 'type' => 'php',
 284                         'file' => __FILE__, 'line' => __LINE__,
 285                     'message' => "Invalid mail_header_delimiter setting"
 286                 ), true, false);
 287         }
 288
 289         $php_os = strtolower(substr(PHP_OS, 0, 3));
 290
 291         if ($php_os == 'win')
 292             return "\r\n";
 293
 294         if ($php_os == 'mac')
 295             return "\r\n";
 296
 297         return "\n";
 298     }
 299
 300
 301     /**
 302      * Return the mail domain configured for the given host
 303      *
 304      * @param string  $host   IMAP host
 305      * @param boolean $encode If true, domain name will be converted to IDN ASCII
 306      * @return string Resolved SMTP host
 307      */
 308     public function mail_domain($host, $encode=true)
 309     {
 310         $domain = $host;
 311
 312         if (is_array($this->prop['mail_domain'])) {
 313             if (isset($this->prop['mail_domain'][$host]))
 314                 $domain = $this->prop['mail_domain'][$host];
 315         }
 316         else if (!empty($this->prop['mail_domain']))
 317             $domain = rcube_parse_host($this->prop['mail_domain']);
 318
 319         if ($encode)
 320             $domain = rcube_idn_to_ascii($domain);
 321
 322         return $domain;
 323     }
 324
 325
 326     /**
 327      * Getter for error state
 328      *
 329      * @return mixed Error message on error, False if no errors
 330      */
 331     public function get_error()
 332     {
 333         return empty($this->errors) ? false : join("\n", $this->errors);
 334     }
 335
 336 }