Merge config files (#1487311). Now we have defaults.inc.php and config.inc....

Aleksander Machniak

2013-06-14 461a30d771edd8bc6606f2c92dfde363514b93b1

 installer/rcube_install.php

@@ -5,15 +5,12 @@
 | rcube_install.php                                                     |
 |                                                                       |
 | This file is part of the Roundcube Webmail package                    |
 | Copyright (C) 2008-2011, The Roundcube Dev Team                       |
 | Copyright (C) 2008-2012, The Roundcube Dev Team                       |
 |                                                                       |
 | Licensed under the GNU General Public License version 3 or            |
 | any later version with exceptions for skins & plugins.                |
 | See the README file for a full license statement.                     |
 +-----------------------------------------------------------------------+

 $Id$

*/


@@ -32,87 +29,100 @@
  var $config = array();
  var $configured = false;
  var $last_error = null;
  var $db_map = array('pgsql' => 'postgres', 'mysqli' => 'mysql', 'sqlsrv' => 'mssql');
  var $email_pattern = '([a-z0-9][a-z0-9\-\.\+\_]*@[a-z0-9]([a-z0-9\-][.]?)*[a-z0-9])';
  var $bool_config_props = array();

  var $obsolete_config = array('db_backend', 'double_auth');
  var $replaced_config = array(
    'skin_path' => 'skin',
    'locale_string' => 'language',
    'multiple_identities' => 'identities_level',
    'skin_path'            => 'skin',
    'locale_string'        => 'language',
    'multiple_identities'  => 'identities_level',
    'addrbook_show_images' => 'show_images',
    'imap_root' => 'imap_ns_personal',
    'pagesize' => 'mail_pagesize',
    'imap_root'            => 'imap_ns_personal',
    'pagesize'             => 'mail_pagesize',
    'default_imap_folders' => 'default_folders',
    'top_posting'          => 'reply_mode',
  );

  // these config options are required for a working system
  var $required_config = array(
    'db_dsnw', 'db_table_contactgroups', 'db_table_contactgroupmembers',
    'des_key', 'session_lifetime',
  // list of supported database drivers
  var $supported_dbs = array(
    'MySQL'               => 'pdo_mysql',
    'PostgreSQL'          => 'pdo_pgsql',
    'SQLite'              => 'pdo_sqlite',
    'SQLite (v2)'         => 'pdo_sqlite2',
    'SQL Server (SQLSRV)' => 'pdo_sqlsrv',
    'SQL Server (DBLIB)'  => 'pdo_dblib',
  );


  /**
   * Constructor
   */
  function rcube_install()
  function __construct()
  {
    $this->step = intval($_REQUEST['_step']);
    $this->is_post = $_SERVER['REQUEST_METHOD'] == 'POST';
  }
  

  /**
   * Singleton getter
   */
  function get_instance()
  static function get_instance()
  {
    static $inst;
    

    if (!$inst)
      $inst = new rcube_install();
    

    return $inst;
  }
  
  /**
   * 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);
      }
      if ($config = $this->load_config_file(RCUBE_CONFIG_DIR . 'db.inc.php')) {
        $this->config = array_merge($this->config, $config);
      }
    }

    $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 = RCMAIL_CONFIG_DIR . '/main.inc' . $suffix)) {
      include($main_inc);
      if (is_array($rcmail_config))
        $this->config += $rcmail_config;
    }
    if (is_readable($db_inc = RCMAIL_CONFIG_DIR . '/db.inc'. $suffix)) {
      include($db_inc);
      if (is_array($rcmail_config))
        $this->config += $rcmail_config;
    if (is_readable($file)) {
      include $file;

      // deprecated name of config variable
      if (is_array($rcmail_config)) {
        return $rcmail_config;
      }

      return $config;
    }
  }
  
  

  /**
   * Getter for a certain config property
   *
@@ -123,30 +133,25 @@
  function getprop($name, $default = '')
  {
    $value = $this->config[$name];
    

    if ($name == 'des_key' && !$this->configured && !isset($_REQUEST["_$name"]))
      $value = rcube_install::random_key(24);
    

    return $value !== null && $value !== '' ? $value : $default;
  }


  /**
   * 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(RCMAIL_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;

@@ -184,16 +189,16 @@
        $value = '%p';
      }
      else if ($prop == 'default_folders') {
       $value = array();
       foreach ($this->config['default_folders'] as $_folder) {
         switch ($_folder) {
         case 'Drafts': $_folder = $this->config['drafts_mbox']; break;
         case 'Sent':   $_folder = $this->config['sent_mbox']; break;
         case 'Junk':   $_folder = $this->config['junk_mbox']; break;
         case 'Trash':  $_folder = $this->config['trash_mbox']; break;
        $value = array();
        foreach ($this->config['default_folders'] as $_folder) {
          switch ($_folder) {
          case 'Drafts': $_folder = $this->config['drafts_mbox']; break;
          case 'Sent':   $_folder = $this->config['sent_mbox']; break;
          case 'Junk':   $_folder = $this->config['junk_mbox']; break;
          case 'Trash':  $_folder = $this->config['trash_mbox']; break;
          }
       if (!in_array($_folder, $value))
         $value[] = $_folder;
        if (!in_array($_folder, $value))
          $value[] = $_folder;
        }
      }
      else if (is_bool($default)) {
@@ -204,20 +209,26 @@
      }

      // skip this property
      if (!$force && !$this->configured && ($value == $default))
      if (!array_key_exists($prop, $this->defaults) || ($value == $this->defaults[$prop])) {
        continue;
      }

      // save change
      $this->config[$prop] = $value;

      // replace the matching line in config file
      $out = preg_replace(
        '/(\$rcmail_config\[\''.preg_quote($prop).'\'\])\s+=\s+(.+);/Uie',
        "'\\1 = ' . rcube_install::_dump_var(\$value, \$prop) . ';'",
        $out);
      $config[$prop] = $value;
    }

    return trim($out);
    // sort by option name
    ksort($config);

    $out = "<?php\n\n";
    foreach ($config as $prop => $value) {
      // @TODO: copy option descriptions from defaults.inc.php file?
      $out .= "\$config['$prop'] = " . rcube_install::_dump_var($value, $prop) . ";\n";
    }
    $out .= "\n?>";

    return $out;
  }


@@ -229,17 +240,14 @@
   */
  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) {
      if ($replacement = $this->replaced_config[$prop]) {
@@ -251,11 +259,10 @@
        $seen[$prop] = true;
      }
    }
    
    // iterate over default config
    foreach ($defaults as $prop => $value) {
      if (!isset($seen[$prop]) && !isset($this->config[$prop]) && isset($required[$prop]))
        $out['missing'][] = array('prop' => $prop);

    // the old default mime_magic reference is obsolete
    if ($this->config['mime_magic'] == '/usr/share/misc/magic') {
        $out['obsolete'][] = array('prop' => 'mime_magic', 'explain' => "Set value to null in order to use system default");
    }

    // check config dependencies and contradictions
@@ -266,23 +273,23 @@
      }
      else if (!empty($this->config['spellcheck_languages'])) {
        foreach ($this->config['spellcheck_languages'] as $lang => $descr)
          if (!pspell_new($lang))
          if (!@pspell_new($lang))
            $out['dependencies'][] = array('prop' => 'spellcheck_languages',
              'explain' => "You are missing pspell support for language $lang ($descr)");
      }
    }
    

    if ($this->config['log_driver'] == 'syslog') {
      if (!function_exists('openlog')) {
        $out['dependencies'][] = array('prop' => 'log_driver',
          'explain' => 'This requires the <tt>sylog</tt> extension which could not be loaded.');
          'explain' => 'This requires the <tt>syslog</tt> extension which could not be loaded.');
      }
      if (empty($this->config['syslog_id'])) {
        $out['dependencies'][] = array('prop' => 'syslog_id',
          'explain' => 'Using <tt>syslog</tt> for logging requires a syslog ID to be configured');
      }
    }
    

    // check ldap_public sources having global_search enabled
    if (is_array($this->config['ldap_public']) && !is_array($this->config['autocomplete_addressbooks'])) {
      foreach ($this->config['ldap_public'] as $ldap_public) {
@@ -292,11 +299,11 @@
        }
      }
    }
    

    return $out;
  }
  
  


  /**
   * Merge the current configuration with the defaults
   * and copy replaced values to the new options.
@@ -305,7 +312,6 @@
  {
    $current = $this->config;
    $this->config = array();
    $this->load_defaults();

    foreach ($this->replaced_config as $prop => $replacement) {
      if (isset($current[$prop])) {
@@ -318,11 +324,11 @@
      }
      unset($current[$prop]);
    }
    

    foreach ($this->obsolete_config as $prop) {
      unset($current[$prop]);
    }
    

    // add all ldap_public sources having global_search enabled to autocomplete_addressbooks
    if (is_array($current['ldap_public'])) {
      foreach ($current['ldap_public'] as $key => $ldap_public) {
@@ -332,38 +338,36 @@
        }
      }
    }
    
    if ($current['keep_alive'] && $current['session_lifetime'] < $current['keep_alive'])
      $current['session_lifetime'] = max(10, ceil($current['keep_alive'] / 60) * 2);

    $this->config  = array_merge($this->config, $current);
    $this->config = array_merge($this->config, $current);

    foreach ((array)$current['ldap_public'] as $key => $values) {
    foreach (array_keys((array)$current['ldap_public']) as $key) {
      $this->config['ldap_public'][$key] = $current['ldap_public'][$key];
    }
  }
  

  /**
   * Compare the local database schema with the reference schema
   * required for this version of Roundcube
   *
   * @param boolean True if the schema schould be updated
   * @param rcube_db Database object
   *
   * @return boolean True if the schema is up-to-date, false if not or an error occured
   */
  function db_schema_check($DB, $update = false)
  function db_schema_check($DB)
  {
    if (!$this->configured)
      return false;
    

    // read reference schema from mysql.initial.sql
    $db_schema = $this->db_read_schema(INSTALL_PATH . 'SQL/mysql.initial.sql');
    $errors = array();
    

    // check list of tables
    $existing_tables = $DB->list_tables();

    foreach ($db_schema as $table => $cols) {
      $table = !empty($this->config['db_table_'.$table]) ? $this->config['db_table_'.$table] : $table;
      $table = $this->config['db_prefix'] . $table;
      if (!in_array($table, $existing_tables)) {
        $errors[] = "Missing table '".$table."'";
      }
@@ -374,7 +378,7 @@
          $errors[] = "Missing columns in table '$table': " . join(',', $diff);
      }
    }
    

    return !empty($errors) ? $errors : false;
  }

@@ -397,90 +401,11 @@
        }
      }
    }
    

    return $schema;
  }
  
  
  /**
   * Compare the local database schema with the reference schema
   * required for this version of Roundcube
   *
   * @param boolean True if the schema schould be updated
   * @return boolean True if the schema is up-to-date, false if not or an error occured
   */
  function mdb2_schema_check($update = false)
  {
    if (!$this->configured)
      return false;
    
    $options = array(
      'use_transactions' => false,
      'log_line_break' => "\n",
      'idxname_format' => '%s',
      'debug' => false,
      'quote_identifier' => true,
      'force_defaults' => false,
      'portability' => true
    );
    
    $dsnw = $this->config['db_dsnw'];
    $schema = MDB2_Schema::factory($dsnw, $options);
    $schema->db->supported['transactions'] = false;
    
    if (PEAR::isError($schema)) {
      $this->raise_error(array('code' => $schema->getCode(), 'message' => $schema->getMessage() . ' ' . $schema->getUserInfo()));
      return false;
    }
    else {
      $definition = $schema->getDefinitionFromDatabase();
      $definition['charset'] = 'utf8';
      
      if (PEAR::isError($definition)) {
        $this->raise_error(array('code' => $definition->getCode(), 'message' => $definition->getMessage() . ' ' . $definition->getUserInfo()));
        return false;
      }
      
      // load reference schema
      $dsn_arr = MDB2::parseDSN($this->config['db_dsnw']);

      $ref_schema = INSTALL_PATH . 'SQL/' . $dsn_arr['phptype'] . '.schema.xml';
      
      if (is_readable($ref_schema)) {
        $reference = $schema->parseDatabaseDefinition($ref_schema, false, array(), $schema->options['fail_on_invalid_names']);
        
        if (PEAR::isError($reference)) {
          $this->raise_error(array('code' => $reference->getCode(), 'message' => $reference->getMessage() . ' ' . $reference->getUserInfo()));
        }
        else {
          $diff = $schema->compareDefinitions($reference, $definition);
          
          if (empty($diff)) {
            return true;
          }
          else if ($update) {
            // update database schema with the diff from the above check
            $success = $schema->alterDatabase($reference, $definition, $diff);
            
            if (PEAR::isError($success)) {
              $this->raise_error(array('code' => $success->getCode(), 'message' => $success->getMessage() . ' ' . $success->getUserInfo()));
            }
            else
              return true;
          }
          echo '<pre>'; var_dump($diff); echo '</pre>';
          return false;
        }
      }
      else
        $this->raise_error(array('message' => "Could not find reference schema file ($ref_schema)"));
        return false;
    }
    
    return false;
  }
  
  

  /**
   * Getter for the last error message
   *
@@ -490,8 +415,8 @@
  {
      return $this->last_error['message'];
  }
  
  


  /**
   * Return a list with all imap hosts configured
   *
@@ -501,12 +426,12 @@
  {
    $default_hosts = (array)$this->getprop('default_host');
    $out = array();
    

    foreach ($default_hosts as $key => $name) {
      if (!empty($name))
        $out[] = rcube_parse_host(is_numeric($key) ? $name : $key);
    }
    

    return $out;
  }

@@ -521,9 +446,12 @@
        '0.2-alpha', '0.2-beta', '0.2-stable',
        '0.3-stable', '0.3.1',
        '0.4-beta', '0.4.2',
        '0.5-beta', '0.5', '0.5.1',
        '0.5-beta', '0.5', '0.5.1', '0.5.2', '0.5.3', '0.5.4',
        '0.6-beta', '0.6',
        '0.7-beta', '0.7', '0.7.1'
        '0.7-beta', '0.7', '0.7.1', '0.7.2', '0.7.3', '0.7.4',
        '0.8-beta', '0.8-rc', '0.8.0', '0.8.1', '0.8.2', '0.8.3', '0.8.4', '0.8.5', '0.8.6',
        '0.9-beta', '0.9-rc', '0.9-rc2',
        // Note: Do not add newer versions here
    ));
    return $select;
  }
@@ -542,7 +470,7 @@
    }
    return $skins;
  }
  

  /**
   * Display OK status
   *
@@ -554,8 +482,8 @@
    echo Q($name) . ':&nbsp; <span class="success">OK</span>';
    $this->_showhint($message);
  }
  
  


  /**
   * Display an error status and increase failure count
   *
@@ -566,7 +494,7 @@
  function fail($name, $message = '', $url = '')
  {
    $this->failures++;
    

    echo Q($name) . ':&nbsp; <span class="fail">NOT OK</span>';
    $this->_showhint($message, $url);
  }
@@ -584,8 +512,8 @@
    echo Q($name) . ':&nbsp; <span class="na">NOT OK</span>';
    $this->_showhint($message, $url);
  }
  
  


  /**
   * Display warning status
   *
@@ -598,24 +526,24 @@
    echo Q($name) . ':&nbsp; <span class="na">NOT AVAILABLE</span>';
    $this->_showhint($message, $url);
  }
  
  


  function _showhint($message, $url = '')
  {
    $hint = Q($message);
    

    if ($url)
      $hint .= ($hint ? '; ' : '') . 'See <a href="' . Q($url) . '" target="_blank">' . Q($url) . '</a>';
      

    if ($hint)
      echo '<span class="indent">(' . $hint . ')</span>';
  }
  
  


  static function _clean_array($arr)
  {
    $out = array();
    

    foreach (array_unique($arr) as $k => $val) {
      if (!empty($val)) {
        if (is_numeric($k))
@@ -624,12 +552,13 @@
          $out[$k] = $val;
      }
    }
    

    return $out;
  }
  
  
  static function _dump_var($var, $name=null) {


  static function _dump_var($var, $name=null)
  {
    // special values
    switch ($name) {
    case 'syslog_facility':
@@ -642,8 +571,20 @@
      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)) {
@@ -651,22 +592,22 @@
      }
      else {  // check if all keys are numeric
        $isnum = true;
        foreach ($var as $key => $value) {
        foreach (array_keys($var) as $key) {
          if (!is_numeric($key)) {
            $isnum = false;
            break;
          }
        }
        

        if ($isnum)
          return 'array(' . join(', ', array_map(array('rcube_install', '_dump_var'), $var)) . ')';
      }
    }
    

    return var_export($var, true);
  }
  
  


  /**
   * Initialize the database with the according schema
   *
@@ -675,8 +616,8 @@
   */
  function init_db($DB)
  {
    $engine = isset($this->db_map[$DB->db_provider]) ? $this->db_map[$DB->db_provider] : $DB->db_provider;
    
    $engine = $DB->db_provider;

    // read schema file from /SQL/*
    $fname = INSTALL_PATH . "SQL/$engine.initial.sql";
    if ($sql = @file_get_contents($fname)) {
@@ -686,7 +627,7 @@
      $this->fail('DB Schema', "Cannot read the schema file: $fname");
      return false;
    }
    

    if ($err = $this->get_error()) {
      $this->fail('DB Schema', "Error creating database schema: $err");
      return false;
@@ -694,52 +635,26 @@

    return true;
  }
  
  


  /**
   * Update database with SQL statements from SQL/*.update.sql
   * Update database schema
   *
   * @param object rcube_db Database connection
   * @param string Version to update from
   *
   * @return boolen True on success, False on error
   */
  function update_db($DB, $version)
  function update_db($version)
  {
    $version = strtolower($version);
    $engine = isset($this->db_map[$DB->db_provider]) ? $this->db_map[$DB->db_provider] : $DB->db_provider;
    
    // read schema file from /SQL/*
    $fname = INSTALL_PATH . "SQL/$engine.update.sql";
    if ($lines = @file($fname, FILE_SKIP_EMPTY_LINES)) {
      $from = false; $sql = '';
      foreach ($lines as $line) {
        $is_comment = preg_match('/^--/', $line);
        if (!$from && $is_comment && preg_match('/from version\s([0-9.]+[a-z-]*)/', $line, $m)) {
          $v = strtolower($m[1]);
          if ($v == $version || version_compare($version, $v, '<='))
            $from = true;
        }
        if ($from && !$is_comment)
          $sql .= $line. "\n";
      }
      
      if ($sql)
        $this->exec_sql($sql, $DB);
    }
    else {
      $this->fail('DB Schema', "Cannot read the update file: $fname");
      return false;
    }
    
    if ($err = $this->get_error()) {
      $this->fail('DB Schema', "Error updating database: $err");
      return false;
    }
    system(INSTALL_PATH . "bin/updatedb.sh --package=roundcube"
      . " --version=" . escapeshellarg($version)
      . " --dir=" . INSTALL_PATH . "SQL"
      . " 2>&1", $result);

    return true;
    return !$result;
  }
  
  


  /**
   * Execute the given SQL queries on the database connection
   *
@@ -749,11 +664,12 @@
   */
  function exec_sql($sql, $DB)
  {
    $sql = $this->fix_table_names($sql, $DB);
    $buff = '';
    foreach (explode("\n", $sql) as $line) {
      if (preg_match('/^--/', $line) || trim($line) == '')
        continue;
        

      $buff .= $line . "\n";
      if (preg_match('/(;|^GO)$/', trim($line))) {
        $DB->query($buff);
@@ -762,11 +678,40 @@
          break;
      }
    }
    

    return !$DB->is_error();
  }
  
  


  /**
   * Parse SQL file and fix table names according to db_prefix
   * Note: This need to be a complete database initial file
   */
  private function fix_table_names($sql, $DB)
  {
    if (empty($this->config['db_prefix'])) {
        return $sql;
    }

    // replace table names
    if (preg_match_all('/CREATE TABLE (\[dbo\]\.|IF NOT EXISTS )?[`"\[\]]*([^`"\[\] \r\n]+)/i', $sql, $matches)) {
      foreach ($matches[2] as $table) {
        $real_table = $this->config['db_prefix'] . $table;
        $sql = preg_replace("/([^a-zA-Z0-9_])$table([^a-zA-Z0-9_])/", "\\1$real_table\\2", $sql);
      }
    }
    // replace sequence names
    if ($DB->db_provider == 'postgres' && preg_match_all('/CREATE SEQUENCE (IF NOT EXISTS )?"?([^" \n\r]+)/i', $sql, $matches)) {
      foreach ($matches[2] as $sequence) {
        $real_sequence = $this->config['db_prefix'] . $sequence;
        $sql = preg_replace("/([^a-zA-Z0-9_])$sequence([^a-zA-Z0-9_])/", "\\1$real_sequence\\2", $sql);
      }
    }

    return $sql;
  }


  /**
   * Handler for Roundcube errors
   */
@@ -774,8 +719,8 @@
  {
      $this->last_error = $p;
  }
  
  


  /**
   * Generarte a ramdom string to be used as encryption key
   *
@@ -787,12 +732,12 @@
  {
    $alpha = 'ABCDEFGHIJKLMNOPQERSTUVXYZabcdefghijklmnopqrtsuvwxyz0123456789+*%&?!$-_=';
    $out = '';
    

    for ($i=0; $i < $length; $i++)
      $out .= $alpha{rand(0, strlen($alpha)-1)};
    

    return $out;
  }
  

}