Merged configuration refactoring from 'dev_config' branch back into master (#1487311)

4 files changed, 176 insertions, 156 deletions

diff --git a/installer/config.php b/installer/config.php
index bfeb677ee..f990fc23f 100644
--- a/installer/config.php
+++ b/installer/config.php
@@ -9,9 +9,6 @@ if (!class_exists('rcube_install') || !is_object($RCI)) {
 <input type="hidden" name="_step" value="2" />
 <?php
 
-// also load the default config to fill in the fields
-$RCI->load_defaults();
-
 // register these boolean fields
 $RCI->bool_config_props = array(
   'ip_check' => 1,
@@ -27,24 +24,24 @@ $RCI->bool_config_props = array(
 $_SESSION['allowinstaller'] = true;
 
 if (!empty($_POST['submit'])) {
-  
-  echo '<p class="notice">Copy or download the following configurations and save them in two files';
-  echo ' (names above the text box) within the <tt>'.RCMAIL_CONFIG_DIR.'</tt> directory of your Roundcube installation.';
+  echo '<p class="notice">Copy or download the following configuration and save it';
+  echo ' as <tt><b>config.inc.php</b></tt> within the <tt>'.RCUBE_CONFIG_DIR.'</tt> directory of your Roundcube installation.<br/>';
+  echo ' Make sure that there are no characters outside the <tt>&lt;?php ?&gt;</tt> brackets when saving the file.';
+  echo '&nbsp;<input type="button" onclick="location.href=\'index.php?_getconfig=1\'" value="Download" />';
+  if ($RCI->legacy_config) {
+      echo '<br/><br/>Afterwards, please <b>remove</b> the old configuration files <tt>main.inc.php</tt> and <tt>db.inc.php</tt>';
+      echo ' from the config directory.';
+  }
   echo '</p>';
-  
+
   $textbox = new html_textarea(array('rows' => 16, 'cols' => 60, 'class' => "configfile"));
-  
-  echo '<div><em>main.inc.php (<a href="index.php?_getfile=main">download</a>)</em></div>';
-  echo $textbox->show(($_SESSION['main.inc.php'] = $RCI->create_config('main')));
-  
-  echo '<div style="margin-top:1em"><em>db.inc.php (<a href="index.php?_getfile=db">download</a>)</em></div>';
-  echo $textbox->show($_SESSION['db.inc.php'] = $RCI->create_config('db'));
+  echo $textbox->show(($_SESSION['config'] = $RCI->create_config()));
 
   echo '<p class="hint">Of course there are more options to configure.
-    Have a look at the config files or visit <a href="http://trac.roundcube.net/wiki/Howto_Config">Howto_Config</a> to find out.</p>';
+    Have a look at the defaults.inc.php file or visit <a href="http://trac.roundcube.net/wiki/Howto_Config">Howto_Config</a> to find out.</p>';
 
   echo '<p><input type="button" onclick="location.href=\'./index.php?_step=3\'" value="CONTINUE" /></p>';
-  
+
   // echo '<style type="text/css"> .configblock { display:none } </style>';
   echo "\n<hr style='margin-bottom:1.6em' />\n";
 }
@@ -648,7 +645,7 @@ $select_param_folding->add('Full RFC 2231 (Roundcube, Thunderbird)', '0');
 $select_param_folding->add('RFC 2047/2231 (MS Outlook, OE)', '1');
 $select_param_folding->add('Full RFC 2047 (deprecated)', '2');
 
-echo $select_param_folding->show(intval($RCI->getprop('mime_param_folding')));
+echo $select_param_folding->show(strval($RCI->getprop('mime_param_folding')));
 
 ?>
 <div>How to encode attachment long/non-ascii names</div>
diff --git a/installer/index.php b/installer/index.php
index 0e80b1cd6..d084c8aa5 100644
--- a/installer/index.php
+++ b/installer/index.php
@@ -5,7 +5,7 @@
  | Roundcube Webmail setup tool                                            |
  | Version 0.9-git                                                         |
  |                                                                         |
- | Copyright (C) 2009-2012, The Roundcube Dev Team                         |
+ | Copyright (C) 2009-2013, The Roundcube Dev Team                         |
  |                                                                         |
  | This program is free software: you can redistribute it and/or modify    |
  | it under the terms of the GNU General Public License (with exceptions   |
@@ -54,17 +54,18 @@ require_once 'rcube_install.php';
 // deprecated aliases (to be removed)
 require_once 'bc.php';
 
-session_start();
+if (function_exists('session_start'))
+  session_start();
 
 $RCI = rcube_install::get_instance();
 $RCI->load_config();
 
-if (isset($_GET['_getfile']) && in_array($_GET['_getfile'], array('main', 'db'))) {
-  $filename = $_GET['_getfile'] . '.inc.php';
-  if (!empty($_SESSION[$filename])) {
+if (isset($_GET['_getconfig'])) {
+  $filename = 'config.inc.php';
+  if (!empty($_SESSION['config'])) {
     header('Content-type: text/plain');
     header('Content-Disposition: attachment; filename="'.$filename.'"');
-    echo $_SESSION[$filename];
+    echo $_SESSION['config'];
     exit;
   }
   else {
@@ -74,14 +75,14 @@ if (isset($_GET['_getfile']) && in_array($_GET['_getfile'], array('main', 'db'))
 }
 
 if ($RCI->configured && ($RCI->getprop('enable_installer') || $_SESSION['allowinstaller']) &&
-    isset($_GET['_mergeconfig']) && in_array($_GET['_mergeconfig'], array('main', 'db'))) {
-  $filename = $_GET['_mergeconfig'] . '.inc.php';
+    !empty($_GET['_mergeconfig'])) {
+  $filename = 'config.inc.php';
 
   header('Content-type: text/plain');
   header('Content-Disposition: attachment; filename="'.$filename.'"');
 
   $RCI->merge_config();
-  echo $RCI->create_config($_GET['_mergeconfig'], true);
+  echo $RCI->create_config();
   exit;
 }
 
@@ -121,8 +122,16 @@ if ($RCI->configured && empty($_REQUEST['_step'])) {
   // exit if installation is complete
   if ($RCI->configured && !$RCI->getprop('enable_installer') && !$_SESSION['allowinstaller']) {
     // header("HTTP/1.0 404 Not Found");
-    echo '<h2 class="error">The installer is disabled!</h2>';
-    echo '<p>To enable it again, set <tt>$rcmail_config[\'enable_installer\'] = true;</tt> in RCUBE_CONFIG_DIR/main.inc.php</p>';
+    if ($RCI->configured && $RCI->legacy_config) {
+      echo '<h2 class="error">Your configuration needs to be migrated!</h2>';
+      echo '<p>We changed the configuration files structure and your installation needs to be updated accordingly.</p>';
+      echo '<p>Please run the <tt>bin/update.sh</tt> script from the command line or set <p>&nbsp; <tt>$rcmail_config[\'enable_installer\'] = true;</tt></p>';
+      echo ' in your RCUBE_CONFIG_DIR/main.inc.php to let the installer help you migrating it.</p>';
+    }
+    else {
+      echo '<h2 class="error">The installer is disabled!</h2>';
+      echo '<p>To enable it again, set <tt>$rcmail_config[\'enable_installer\'] = true;</tt> in RCUBE_CONFIG_DIR/config.inc.php</p>';
+    }
     echo '</div></body></html>';
     exit;
   }
diff --git a/installer/rcube_install.php b/installer/rcube_install.php
index ab7967708..600db34ab 100644
--- a/installer/rcube_install.php
+++ b/installer/rcube_install.php
@@ -28,10 +28,12 @@ class rcube_install
   var $failures = 0;
   var $config = array();
   var $configured = false;
+  var $legacy_config = false;
   var $last_error = null;
   var $email_pattern = '([a-z0-9][a-z0-9\-\.\+\_]*@[a-z0-9]([a-z0-9\-][.]?)*[a-z0-9])';
   var $bool_config_props = array();
 
+  var $local_config = array('db_dsnw', 'default_host', 'support_url', 'des_key', 'plugins');
   var $obsolete_config = array('db_backend', 'double_auth');
   var $replaced_config = array(
     'skin_path'            => 'skin',
@@ -44,11 +46,6 @@ class rcube_install
     'top_posting'          => 'reply_mode',
   );
 
-  // these config options are required for a working system
-  var $required_config = array(
-    'db_dsnw', 'des_key', 'session_lifetime',
-  );
-
   // list of supported database drivers
   var $supported_dbs = array(
     'MySQL'               => 'pdo_mysql',
@@ -83,43 +80,75 @@ class rcube_install
   }
 
   /**
-   * Read the default config files and store properties
-   */
-  function load_defaults()
-  {
-    $this->_load_config('.php.dist');
-  }
-
-
-  /**
    * Read the local config files and store properties
    */
   function load_config()
   {
-    $this->config = array();
-    $this->_load_config('.php');
-    $this->configured = !empty($this->config);
+    // defaults
+    if ($config = $this->load_config_file(RCUBE_CONFIG_DIR . 'defaults.inc.php')) {
+        $this->config = (array) $config;
+        $this->defaults = $this->config;
+    }
+
+    $config = null;
+
+    // config
+    if ($config = $this->load_config_file(RCUBE_CONFIG_DIR . 'config.inc.php')) {
+        $this->config = array_merge($this->config, $config);
+    }
+    else {
+      if ($config = $this->load_config_file(RCUBE_CONFIG_DIR . 'main.inc.php')) {
+        $this->config = array_merge($this->config, $config);
+        $this->legacy_config = true;
+      }
+      if ($config = $this->load_config_file(RCUBE_CONFIG_DIR . 'db.inc.php')) {
+        $this->config = array_merge($this->config, $config);
+        $this->legacy_config = true;
+      }
+    }
+
+    $this->configured = !empty($config);
   }
 
   /**
    * Read the default config file and store properties
-   * @access private
    */
-  function _load_config($suffix)
+  public function load_config_file($file)
   {
-    if (is_readable($main_inc = RCUBE_CONFIG_DIR . 'main.inc' . $suffix)) {
-      include($main_inc);
-      if (is_array($rcmail_config))
-        $this->config += $rcmail_config;
-    }
-    if (is_readable($db_inc = RCUBE_CONFIG_DIR . 'db.inc'. $suffix)) {
-      include($db_inc);
-      if (is_array($rcmail_config))
-        $this->config += $rcmail_config;
+    if (is_readable($file)) {
+      include $file;
+
+      // read comments from config file
+      if (function_exists('token_get_all')) {
+        $tokens = token_get_all(file_get_contents($file));
+        $in_config = false;
+        $buffer = '';
+        for ($i=0; $i < count($tokens); $i++) {
+          $token = $tokens[$i];
+          if ($token[0] == T_VARIABLE && $token[1] == '$config' || $token[1] == '$rcmail_config') {
+            $in_config = true;
+            if ($buffer && $tokens[$i+1] == '[' && $tokens[$i+2][0] == T_CONSTANT_ENCAPSED_STRING) {
+              $propname = trim($tokens[$i+2][1], "'\"");
+              $this->comments[$propname] = $buffer;
+              $buffer = '';
+              $i += 3;
+            }
+          }
+          else if ($in_config && $token[0] == T_COMMENT) {
+            $buffer .= strtr($token[1], array('\n' => "\n"));
+          }
+        }
+      }
+
+      // deprecated name of config variable
+      if (is_array($rcmail_config)) {
+        return $rcmail_config;
+      }
+
+      return $config;
     }
   }
 
-
   /**
    * Getter for a certain config property
    *
@@ -139,24 +168,22 @@ class rcube_install
 
 
   /**
-   * Take the default config file and replace the parameters
-   * with the submitted form data
+   * Create configuration file that contains parameters
+   * that differ from default values.
    *
-   * @param string Which config file (either 'main' or 'db')
    * @return string The complete config file content
    */
-  function create_config($which, $force = false)
+  function create_config()
   {
-    $out = @file_get_contents(RCUBE_CONFIG_DIR . $which . '.inc.php.dist');
-
-    if (!$out)
-      return '[Warning: could not read the config template file]';
+    $config = array();
 
     foreach ($this->config as $prop => $default) {
-
       $is_default = !isset($_POST["_$prop"]);
       $value      = !$is_default || $this->bool_config_props[$prop] ? $_POST["_$prop"] : $default;
 
+      if ($prop == 'enable_installer')
+        $value = false;
+
       // convert some form data
       if ($prop == 'debug_level' && !$is_default) {
         if (is_array($value)) {
@@ -166,7 +193,7 @@ class rcube_install
           $value = $val;
         }
       }
-      else if ($which == 'db' && $prop == 'db_dsnw' && !empty($_POST['_dbtype'])) {
+      else if ($prop == 'db_dsnw' && !empty($_POST['_dbtype'])) {
         if ($_POST['_dbtype'] == 'sqlite')
           $value = sprintf('%s://%s?mode=0646', $_POST['_dbtype'], $_POST['_dbname']{0} == '/' ? '/' . $_POST['_dbname'] : $_POST['_dbname']);
         else if ($_POST['_dbtype'])
@@ -211,22 +238,24 @@ class rcube_install
       }
 
       // skip this property
-      if (!$force && !$this->configured && ($value == $default))
+      if ((!array_key_exists($prop, $this->defaults) || ($value == $this->defaults[$prop])) && !in_array($prop, $this->local_config)) {
         continue;
+      }
 
       // save change
       $this->config[$prop] = $value;
+      $config[$prop] = $value;
+    }
 
-      $dump = self::_dump_var($value, $prop);
-
-      // replace the matching line in config file
-      $out = preg_replace(
-        '/(\$rcmail_config\[\''.preg_quote($prop).'\'\])\s+=\s+(.+);/Ui',
-        "\\1 = $dump;",
-        $out);
+    $out = "<?php\n\n";
+    $out .= "/* Local configuration for Roundcube Webmail */\n\n";
+    foreach ($config as $prop => $value) {
+      // copy option descriptions from existing config or defaults.inc.php
+      $out .= $this->comments[$prop];
+      $out .= "\$config['$prop'] = " . rcube_install::_dump_var($value, $prop) . ";\n\n";
     }
 
-    return trim($out);
+    return $out;
   }
 
 
@@ -238,16 +267,13 @@ class rcube_install
    */
   function check_config()
   {
-    $this->config = array();
-    $this->load_defaults();
-    $defaults = $this->config;
-
     $this->load_config();
-    if (!$this->configured)
+
+    if (!$this->configured) {
       return null;
+    }
 
     $out = $seen = array();
-    $required = array_flip($this->required_config);
 
     // iterate over the current configuration
     foreach ($this->config as $prop => $value) {
@@ -266,12 +292,6 @@ class rcube_install
         $out['obsolete'][] = array('prop' => 'mime_magic', 'explain' => "Set value to null in order to use system default");
     }
 
-    // iterate over default config
-    foreach ($defaults as $prop => $value) {
-      if (!isset($seen[$prop]) && isset($required[$prop]) && !(is_bool($this->config[$prop]) || strlen($this->config[$prop])))
-        $out['missing'][] = array('prop' => $prop);
-    }
-
     // check config dependencies and contradictions
     if ($this->config['enable_spellcheck'] && $this->config['spellcheck_engine'] == 'pspell') {
       if (!extension_loaded('pspell')) {
@@ -319,7 +339,6 @@ class rcube_install
   {
     $current = $this->config;
     $this->config = array();
-    $this->load_defaults();
 
     foreach ($this->replaced_config as $prop => $replacement) {
       if (isset($current[$prop])) {
@@ -347,7 +366,7 @@ class rcube_install
       }
     }
 
-    $this->config  = array_merge($this->config, $current);
+    $this->config = array_merge($this->config, $current);
 
     foreach (array_keys((array)$current['ldap_public']) as $key) {
       $this->config['ldap_public'][$key] = $current['ldap_public'][$key];
@@ -613,7 +632,8 @@ class rcube_install
   }
 
 
-  static function _dump_var($var, $name=null) {
+  static function _dump_var($var, $name=null)
+  {
     // special values
     switch ($name) {
     case 'syslog_facility':
@@ -626,8 +646,20 @@ class rcube_install
       if ($val = $list[$var])
         return $val;
       break;
-    }
 
+    case 'mail_header_delimiter':
+      $var = str_replace(array("\r", "\n"), array('\r', '\n'), $var);
+      return '"' . $var. '"';
+      break;
+/*
+    // RCMAIL_VERSION is undefined here
+    case 'useragent':
+      if (preg_match('|^(.*)/('.preg_quote(RCMAIL_VERSION, '|').')$|i', $var, $m)) {
+        return '"' . addcslashes($var, '"') . '/" . RCMAIL_VERSION';
+      }
+      break;
+*/
+    }
 
     if (is_array($var)) {
       if (empty($var)) {
diff --git a/installer/test.php b/installer/test.php
index 75dac47aa..f834308ad 100644
--- a/installer/test.php
+++ b/installer/test.php
@@ -7,52 +7,44 @@ if (!class_exists('rcube_install') || !is_object($RCI)) {
 ?>
 <form action="index.php?_step=3" method="post">
 
-<h3>Check config files</h3>
+<h3>Check config file</h3>
 <?php
 
-$read_main = is_readable(RCUBE_CONFIG_DIR . 'main.inc.php');
-$read_db = is_readable(RCUBE_CONFIG_DIR . 'db.inc.php');
-
-if ($read_main && !empty($RCI->config)) {
-  $RCI->pass('main.inc.php');
-}
-else if ($read_main) {
-  $RCI->fail('main.inc.php', 'Syntax error');
+if ($read_config = is_readable(RCUBE_CONFIG_DIR . 'defaults.inc.php')) {
+  $config = $RCI->load_config_file(RCUBE_CONFIG_DIR . 'defaults.inc.php');
+  if (!empty($config)) {
+    $RCI->pass('defaults.inc.php');
+  }
+  else {
+    $RCI->fail('defaults.inc.php', 'Syntax error');
+  }
 }
-else if (!$read_main) {
-  $RCI->fail('main.inc.php', 'Unable to read file. Did you create the config files?');
+else {
+  $RCI->fail('defaults.inc.php', 'Unable to read default config file?');
 }
 echo '<br />';
 
-if ($read_db && !empty($RCI->config['db_dsnw'])) {
-  $RCI->pass('db.inc.php');
-}
-else if ($read_db) {
-  $RCI->fail('db.inc.php', 'Syntax error');
+if ($read_config = is_readable(RCUBE_CONFIG_DIR . 'config.inc.php')) {
+  $config = $RCI->load_config_file(RCUBE_CONFIG_DIR . 'config.inc.php');
+  if (!empty($config)) {
+    $RCI->pass('config.inc.php');
+  }
+  else {
+    $RCI->fail('config.inc.php', 'Syntax error');
+  }
 }
-else if (!$read_db) {
-  $RCI->fail('db.inc.php', 'Unable to read file. Did you create the config files?');
+else {
+  $RCI->fail('config.inc.php', 'Unable to read file. Did you create the config file?');
 }
+echo '<br />';
 
-if ($RCI->configured && ($messages = $RCI->check_config())) {
-  
-  if (is_array($messages['missing'])) {
-    echo '<h3 class="warning">Missing config options</h3>';
-    echo '<p class="hint">The following config options are not set (not present or empty) in the current configuration.<br/>';
-    echo 'Please check the default config files and set the missing properties in your local config files.</p>';
-
-    echo '<ul class="configwarnings">';
-    foreach ($messages['missing'] as $msg) {
-      echo html::tag('li', null, html::span('propname', $msg['prop']) . ($msg['name'] ? ':&nbsp;' . $msg['name'] : ''));
-    }
-    echo '</ul>';
-  }
 
+if ($RCI->configured && ($messages = $RCI->check_config())) {
   if (is_array($messages['replaced'])) {
     echo '<h3 class="warning">Replaced config options</h3>';
     echo '<p class="hint">The following config options have been replaced or renamed. ';
     echo 'Please update them accordingly in your config files.</p>';
-    
+
     echo '<ul class="configwarings">';
     foreach ($messages['replaced'] as $msg) {
       echo html::tag('li', null, html::span('propname', $msg['prop']) .
@@ -64,32 +56,28 @@ if ($RCI->configured && ($messages = $RCI->check_config())) {
   if (is_array($messages['obsolete'])) {
     echo '<h3>Obsolete config options</h3>';
     echo '<p class="hint">You still have some obsolete or inexistent properties set. This isn\'t a problem but should be noticed.</p>';
-    
+
     echo '<ul class="configwarings">';
     foreach ($messages['obsolete'] as $msg) {
       echo html::tag('li', null, html::span('propname', $msg['prop']) . ($msg['name'] ? ':&nbsp;' . $msg['name'] : ''));
     }
     echo '</ul>';
   }
-  
-  echo '<p class="suggestion">OK, lazy people can download the updated config files here: ';
-  echo html::a(array('href' => './?_mergeconfig=main'), 'main.inc.php') . ' &nbsp;';
-  echo html::a(array('href' => './?_mergeconfig=db'), 'db.inc.php');
+
+  echo '<p class="suggestion">OK, lazy people can download the updated config file here: ';
+  echo html::a(array('href' => './?_mergeconfig=1'), 'config.inc.php') . ' &nbsp;';
   echo "</p>";
-  
-  
+
   if (is_array($messages['dependencies'])) {
     echo '<h3 class="warning">Dependency check failed</h3>';
     echo '<p class="hint">Some of your configuration settings require other options to be configured or additional PHP modules to be installed</p>';
-    
+
     echo '<ul class="configwarings">';
     foreach ($messages['dependencies'] as $msg) {
       echo html::tag('li', null, html::span('propname', $msg['prop']) . ': ' . $msg['explain']);
     }
     echo '</ul>';
   }
-
-  
 }
 
 ?>
@@ -98,30 +86,24 @@ if ($RCI->configured && ($messages = $RCI->check_config())) {
 <p>Roundcube may need to write/save files into these directories</p>
 <?php
 
-if ($RCI->configured) {
-    $pass = false;
-
-    $dirs[] = $RCI->config['temp_dir'] ? $RCI->config['temp_dir'] : 'temp';
-    if($RCI->config['log_driver'] != 'syslog')
-      $dirs[] = $RCI->config['log_dir'] ? $RCI->config['log_dir'] : 'logs';
+$dirs[] = $RCI->config['temp_dir'] ? $RCI->config['temp_dir'] : 'temp';
+if ($RCI->config['log_driver'] != 'syslog')
+    $dirs[] = $RCI->config['log_dir'] ? $RCI->config['log_dir'] : 'logs';
 
-    foreach ($dirs as $dir) {
-        $dirpath = $dir[0] == '/' ? $dir : INSTALL_PATH . $dir;
-        if (is_writable(realpath($dirpath))) {
-            $RCI->pass($dir);
-            $pass = true;
-        }
-        else {
-            $RCI->fail($dir, 'not writeable for the webserver');
-        }
-        echo '<br />';
+foreach ($dirs as $dir) {
+    $dirpath = $dir[0] == '/' ? $dir : INSTALL_PATH . $dir;
+    if (is_writable(realpath($dirpath))) {
+        $RCI->pass($dir);
+        $pass = true;
     }
-    
-    if (!$pass)
-        echo '<p class="hint">Use <tt>chmod</tt> or <tt>chown</tt> to grant write privileges to the webserver</p>';
+    else {
+        $RCI->fail($dir, 'not writeable for the webserver');
+    }
+    echo '<br />';
 }
-else {
-    $RCI->fail('Config', 'Could not read config files');
+
+if (!$pass) {
+    echo '<p class="hint">Use <tt>chmod</tt> or <tt>chown</tt> to grant write privileges to the webserver</p>';
 }
 
 ?>
@@ -151,7 +133,7 @@ if ($RCI->configured) {
     }
 }
 else {
-    $RCI->fail('Config', 'Could not read config files');
+    $RCI->fail('DSN (write)', 'Could not read config file');
 }
 
 // initialize db with schema found in /SQL/*
@@ -463,7 +445,7 @@ if (isset($_POST['imaptest']) && !empty($_POST['_host']) && !empty($_POST['_user
 
 After completing the installation and the final tests please <b>remove</b> the whole
 installer folder from the document root of the webserver or make sure that
-<tt>enable_installer</tt> option in config/main.inc.php is disabled.<br />
+<tt>enable_installer</tt> option in <tt>config.inc.php</tt> is disabled.<br />
 <br />
 
 These files may expose sensitive configuration data like server passwords and encryption keys