Fix database initialization and check write access on the DB; update INSTAL...

thomascube

2008-02-26 190e97e88624b4b42ad677c7446c0d5a0b7b17a6

Fix database initialization and check write access on the DB; update INSTALL instructions

 INSTALL

@@ -35,10 +35,9 @@
   - /temp
   - /logs
3. Create a new database and a database user for RoundCube (see DATABASE SETUP)
4. Create database tables using the queries in file 'SQL/*.initial.sql'
   (* stands for your database type)
5. Rename the files config/*.inc.php.dist to config/*.inc.php
6. Modify the files in config/* to suit your local environment
4. Point your browser to http:///url-to-roundcube/installer/
5. Follow the instructions of the install script (or see MANUAL CONFINGURATION)
6. After creating and testing the configuration, remove the installer directory
7. Done!


@@ -109,12 +108,13 @@
using that version you'll have to change ownership of the DB later.


CONFIGURATION
=============
MANUAL CONFIGURATION
====================

First of all, rename the files config/*.inc.php.dist to config/*.inc.php.
You can then change these files according to your environment and your needs.
Details about the config parameters can be found in the config files.
See http://trac.roundcube.net/wiki/Howto_Install for even more guidance.

You can also modify the default .htaccess file. This is necessary to
increase the allowed size of file attachments, for example:

 installer/config.php

@@ -5,7 +5,7 @@
ini_set('display_errors', 1);
require_once 'include/rcube_html.inc';

$RCI->get_defaults();
$RCI->load_defaults();

if (!empty($_POST['submit'])) {
  

 installer/rcube_install.php

@@ -52,7 +52,7 @@
  /**
   * Read the default config files and store properties
   */
  function get_defaults()
  function load_defaults()
  {
    $this->_load_config('.php.dist');
  }
@@ -74,7 +74,7 @@
  {
    include '../config/main.inc' . $suffix;
    if (is_array($rcmail_config)) {
      $this->config = $rcmail_config;
      $this->config += $rcmail_config;
    }
      
    @include '../config/db.inc'. $suffix;
@@ -238,6 +238,56 @@
    return $out;
  }
  
  
  /**
   * Initialize the database with the according schema
   *
   * @param object rcube_db Database connection
   * @return boolen True on success, False on error
   */
  function init_db($DB)
  {
    $db_map = array('pgsql' => 'postgres', 'mysqli' => 'mysql');
    $engine = isset($db_map[$DB->db_provider]) ? $db_map[$DB->db_provider] : $DB->db_provider;
    
    // find out db version
    if ($engine == 'mysql') {
      $DB->query('SELECT VERSION() AS version');
      $sql_arr = $DB->fetch_assoc();
      $version = floatval($sql_arr['version']);
      
      if ($version >= 4.1)
        $engine = 'mysql5';
    }
    
    // read schema file from /SQL/*
    $fname = "../SQL/$engine.initial.sql";
    if ($lines = @file($fname, FILE_SKIP_EMPTY_LINES)) {
      $buff = '';
      foreach ($lines as $i => $line) {
        if (eregi('^--', $line))
          continue;
          
        $buff .= $line . "\n";
        if (eregi(';$', trim($line))) {
          $DB->query($buff);
          $buff = '';
        }
      }
    }
    else {
      $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;
    }

    return true;
  }
  
  /**
   * Handler for RoundCube errors
   */

 installer/styles.css

@@ -123,7 +123,7 @@
  font-family: monospace;
  font-size: 9pt;
  width: 100%;
  height: 40em;
  height: 30em;
}

dt.propname {

 installer/test.php

@@ -49,12 +49,14 @@
        $DB->db_connect('w');
        if (!($db_error_msg = $DB->is_error())) {
            $RCI->pass('DSN (write)');
            echo '<br />';
            $db_working = true;
        }
        else {
            $RCI->fail('DSN (write)', "Error: $db_error_msg");
            $RCI->fail('DSN (write)', $db_error_msg);
            echo '<p class="hint">Make sure that the configured database extists and that the user as write privileges<br />';
            echo 'DSN: ' . $RCI->config['db_dsnw'] . '</p>';
        }
        echo '<br />';
    }
    else {
        $RCI->fail('DSN (write)', 'not set');
@@ -66,34 +68,43 @@

// initialize db with schema found in /SQL/*
if ($db_working && $_POST['initdb']) {
    $engine = preg_match('/^([a-z]+):/i', $RCI->config['db_dsnw'], $regs) ? $regs[1] : 'mysql';
    $fname = '../SQL/' . ($engine == 'pgsql' ? 'postgres' : $engine) . '.initial.sql';
    if ($sql = @file_get_contents($fname)) {
        $DB->query($sql);
    }
    else {
        $RCI->fail('DB Schema', "Cannot read the schema file: $fname");
    }
    
    if ($err = $RCI->get_error()) {
        $RCI->fail('DB Schema', "Error creating database schema: $err");
    if (!($success = $RCI->init_db($DB))) {
        $db_working = false;
        echo '<p class="warning">Please try to inizialize the database manually as described in the INSTALL guide.</p>';
        echo '<br />';
        echo '<p class="warning">Please try to inizialize the database manually as described in the INSTALL guide.
          Make sure that the configured database extists and that the user as write privileges</p>';
    }
}

// test database
if ($db_working) {
    $success = $DB->query("SELECT count(*) FROM {$RCI->config['db_table_users']}");
    if (!$success) {
    $db_read = $DB->query("SELECT count(*) FROM {$RCI->config['db_table_users']}");
    if (!$db_read) {
        $RCI->fail('DB Schema', "Database not initialized");
        $db_working = false;
        echo '<p><input type="submit" name="initdb" value="Initialize database" /></p>';
    }
    else {
        $RCI->pass('DB Schema');
    }
    echo '<br />';
}

// more database tests
if ($db_working) {
    // write test
    $db_write = $DB->query("INSERT INTO {$RCI->config['db_table_cache']} (session_id, cache_key, data, user_id) VALUES (?, ?, ?, 0)", '1234567890abcdef', 'test', 'test');
    $insert_id = $DB->insert_id($RCI->config['db_sequence_cache']);
    
    if ($db_write && $insert_id) {
      $RCI->pass('DB Write');
      $DB->query("DELETE FROM {$RCI->config['db_table_cache']} WHERE cache_id=?", $insert_id);
    }
    else {
      $RCI->fail('DB Write', $RCI->get_error());
    }
    echo '<br />';    
    
    // check timezone settings
    $tz_db = 'SELECT ' . $DB->unixtimestamp($DB->now()) . ' AS tz_db';
    $tz_db = $DB->query($tz_db);
    $tz_db = $DB->fetch_assoc($tz_db);
@@ -104,12 +115,11 @@
    // sometimes db and web servers are on separate hosts, so allow a 30 minutes delta
    if (abs($tz_diff) > 1800) {
        $RCI->fail('DB Time', "Database time differs {$td_ziff}s from PHP time");
    } else {
    }
    else {
        $RCI->pass('DB Time');
    }
    
}


?>