Create interactive update script with improved DB schema check; udated installer with new features and styles

author: thomascube <thomas@roundcube.net> 2011-02-25 16:37:22 +0000
committer: thomascube <thomas@roundcube.net> 2011-02-25 16:37:22 +0000
commit: e6bb836e053913ec8a5930a6d51af1fa55eb08e2 (patch)
tree: 92fe8cdb0529d8543d488b3164202e2d7833c0f6 /installer
parent: b8f14ce7442c3a7e1a9e081b88c3108405c7a86e (diff)
11 files changed, 187 insertions, 91 deletions
diff --git a/installer/check.php b/installer/check.php
index 0ba5f58de..944d3840f 100644
--- a/installer/check.php
+++ b/installer/check.php
@@ -22,6 +22,7 @@ $required_libs = array(
     'PEAR'      => 'PEAR.php',
     'MDB2'      => 'MDB2.php',
     'Net_SMTP'  => 'Net/SMTP.php',
+    'Net_IDNA2' => 'Net/IDNA2.php',
     'Mail_mime' => 'Mail/mime.php',
 );
 
diff --git a/installer/images/banner_bg.gif b/installer/images/banner_bg.gif
deleted file mode 100644
index 9cef8a7c5..000000000
--- a/installer/images/banner_bg.gif
+++ /dev/null
diff --git a/installer/images/banner_gradient.gif b/installer/images/banner_gradient.gif
new file mode 100644
index 000000000..8ab1b0630
--- /dev/null
+++ b/installer/images/banner_gradient.gif
diff --git a/installer/images/banner_logo.gif b/installer/images/banner_logo.gif
deleted file mode 100644
index a7dd11426..000000000
--- a/installer/images/banner_logo.gif
+++ /dev/null
diff --git a/installer/images/banner_right.gif b/installer/images/banner_right.gif
deleted file mode 100644
index 3248668ac..000000000
--- a/installer/images/banner_right.gif
+++ /dev/null
diff --git a/installer/images/banner_schraffur.gif b/installer/images/banner_schraffur.gif
new file mode 100644
index 000000000..50182b4d6
--- /dev/null
+++ b/installer/images/banner_schraffur.gif
diff --git a/installer/images/rcube_logo.gif b/installer/images/rcube_logo.gif
new file mode 100644
index 000000000..26f82ff99
--- /dev/null
+++ b/installer/images/rcube_logo.gif
diff --git a/installer/index.php b/installer/index.php
index 1c157da7f..e09b82797 100644
--- a/installer/index.php
+++ b/installer/index.php
@@ -68,14 +68,13 @@ if ($RCI->configured && empty($_REQUEST['_step'])) {
 <body>
 
 <div id="banner">
-  <div id="header">
-    <div class="banner-logo"><a href="http://www.roundcube.net"><img src="images/banner_logo.gif" width="200" height="56" border="0" alt="Roundcube Webmal Project" /></a></div>
-    <div class="banner-right"><img src="images/banner_right.gif" width="10" height="56" alt="" /></div>
-  </div>
-  <div id="topnav">
-    <a href="http://trac.roundcube.net/wiki/Howto_Install">How-to Wiki</a>
-  </div>
- </div>
+  <div class="banner-bg"></div>
+  <div class="banner-logo"><a href="http://roundcube.net"><img src="images/rcube_logo.gif" width="210" height="55" border="0" alt="Roundcube - Open source webmail project" /></a></div>
+</div>
+
+<div id="topnav">
+  <a href="http://trac.roundcube.net/wiki/Howto_Install">How-to Wiki</a>
+</div>
 
 <div id="content">
 
@@ -120,7 +119,7 @@ else {
 </div>
 
 <div id="footer">
-  Installer by the Roundcube Dev Team. Copyright &copy; 2008 - Published under the GNU Public License;&nbsp;
+  Installer by the Roundcube Dev Team. Copyright &copy; 2008-2011 - Published under the GNU Public License;&nbsp;
   Icons by <a href="http://famfamfam.com">famfamfam</a>
 </div>
 </body>
diff --git a/installer/rcube_install.php b/installer/rcube_install.php
index 3f4e607f5..3f2d1a48e 100644
--- a/installer/rcube_install.php
+++ b/installer/rcube_install.php
@@ -29,10 +29,11 @@ class rcube_install
   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');
+  var $obsolete_config = array('db_backend', 'double_auth');
   var $replaced_config = array(
     'skin_path' => 'skin',
     'locale_string' => 'language',
@@ -42,7 +43,10 @@ class rcube_install
   );
   
   // these config options are required for a working system
-  var $required_config = array('db_dsnw', 'db_table_contactgroups', 'db_table_contactgroupmembers', 'des_key');
+  var $required_config = array(
+    'db_dsnw', 'db_table_contactgroups', 'db_table_contactgroupmembers',
+    'des_key', 'session_lifetime',
+  );
   
   /**
    * Constructor
@@ -294,7 +298,7 @@ class rcube_install
     $this->config = array();
     $this->load_defaults();
     
-    foreach ($this->replaced_config as $prop => $replacement)
+    foreach ($this->replaced_config as $prop => $replacement) {
       if (isset($current[$prop])) {
         if ($prop == 'skin_path')
           $this->config[$replacement] = preg_replace('#skins/(\w+)/?$#', '\\1', $current[$prop]);
@@ -302,8 +306,8 @@ class rcube_install
           $this->config[$replacement] = $current[$prop] ? 2 : 0;
         else
           $this->config[$replacement] = $current[$prop];
-        
-        unset($current[$prop]);
+      }
+      unset($current[$prop]);
     }
     
     foreach ($this->obsolete_config as $prop) {
@@ -320,6 +324,9 @@ class rcube_install
       }
     }
     
+    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);
     
     foreach ((array)$current['ldap_public'] as $key => $values) {
@@ -339,18 +346,8 @@ class rcube_install
     if (!$this->configured)
       return false;
     
-    // simple ad hand-made db schema
-    $db_schema = array(
-      'users' => array(),
-      'identities' => array(),
-      'contacts' => array(),
-      'contactgroups' => array(),
-      'contactgroupmembers' => array(),
-      'cache' => array(),
-      'messages' => array(),
-      'session' => array(),
-    );
-    
+    // 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
@@ -358,13 +355,43 @@ class rcube_install
 
     foreach ($db_schema as $table => $cols) {
       $table = !empty($this->config['db_table_'.$table]) ? $this->config['db_table_'.$table] : $table;
-      if (!in_array($table, $existing_tables))
-        $errors[] = "Missing table ".$table;
-      // TODO: check cols and indices
+      if (!in_array($table, $existing_tables)) {
+        $errors[] = "Missing table '".$table."'";
+      }
+      else {  // compare cols
+        $db_cols = $DB->list_cols($table);
+        $diff = array_diff(array_keys($cols), $db_cols);
+        if (!empty($diff))
+          $errors[] = "Missing columns in table '$table': " . join(',', $diff);
+      }
     }
     
     return !empty($errors) ? $errors : false;
   }
+
+  /**
+   * Utility function to read database schema from an .sql file
+   */
+  private function db_read_schema($schemafile)
+  {
+    $lines = file($schemafile);
+    $table_block = false;
+    $schema = array();
+    foreach ($lines as $line) {
+      if (preg_match('/^\s*create table `?([a-z0-9_]+)`?/i', $line, $m)) {
+        $table_block = $m[1];
+      }
+      else if ($table_block && preg_match('/^\s*`?([a-z0-9_-]+)`?\s+([a-z]+)/', $line, $m)) {
+        $col = $m[1];
+        if (!in_array(strtoupper($col), array('PRIMARY','KEY','INDEX','UNIQUE','CONSTRAINT','REFERENCES','FOREIGN'))) {
+          $schema[$table_block][$col] = $m[2];
+        }
+      }
+    }
+    
+    return $schema;
+  }
+  
   
   /**
    * Compare the local database schema with the reference schema
@@ -474,6 +501,16 @@ class rcube_install
     return $out;
   }
   
+  /**
+   * Create a HTML dropdown to select a previous version of Roundcube
+   */
+  function versions_select($attrib = array())
+  {
+    $select = new html_select($attrib);
+    $select->add(array('0.1-stable', '0.1.1', '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'));
+    return $select;
+  }
+  
   
   /**
    * Display OK status
@@ -592,39 +629,98 @@ class rcube_install
    */
   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;
+    $engine = isset($this->db_map[$DB->db_provider]) ? $this->db_map[$DB->db_provider] : $DB->db_provider;
     
     // read schema file from /SQL/*
-    $fname = "../SQL/$engine.initial.sql";
+    $fname = INSTALL_PATH . "SQL/$engine.initial.sql";
+    if ($sql = @file_get_contents($fname)) {
+      $this->exec_sql($sql, $DB);
+    }
+    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;
+  }
+  
+  
+  /**
+   * Update database with SQL statements from SQL/*.update.sql
+   *
+   * @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)
+  {
+    $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)) {
-      $buff = '';
-      foreach ($lines as $i => $line) {
-        if (preg_match('/^--/', $line))
-          continue;
-          
-        $buff .= $line . "\n";
-        if (preg_match('/;$/', trim($line))) {
-          $DB->query($buff);
-          $buff = '';
-          if ($this->get_error())
-            break;
+      $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 schema file: $fname");
+      $this->fail('DB Schema', "Cannot read the update file: $fname");
       return false;
     }
     
     if ($err = $this->get_error()) {
-      $this->fail('DB Schema', "Error creating database schema: $err");
+      $this->fail('DB Schema', "Error updating database: $err");
       return false;
     }
 
     return true;
   }
   
+  
+  /**
+   * Execute the given SQL queries on the database connection
+   *
+   * @param string SQL queries to execute
+   * @param object rcube_db Database connection
+   * @return boolen True on success, False on error
+   */
+  function exec_sql($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);
+        $buff = '';
+        if ($DB->is_error())
+          break;
+      }
+    }
+    
+    return !$DB->is_error();
+  }
+  
+  
   /**
    * Handler for Roundcube errors
    */
diff --git a/installer/styles.css b/installer/styles.css
index 1acdc9cd0..06f49e370 100644
--- a/installer/styles.css
+++ b/installer/styles.css
@@ -1,62 +1,53 @@
-
 body {
-  margin: 1em 2em 2em 2em;
-  background-color: #fff;
-}
-
-body, td, th, div, p {
-  font-family: "Lucida Grande", Verdana, Arial, Helvetica, sans-serif;
-  font-size: small;
-  color: #000;
+	background: white;
+	font-family: "Lucida Grande", Verdana, Arial, Helvetica, sans-serif;
+	font-size: small;
+	color: black;
+	margin: 0;
 }
 
 #banner {
-  position: relative;
+	position: relative;
+	height: 58px;
+	margin: 0 0 1em 0;
+	padding: 10px 20px;
+	background: url('images/banner_gradient.gif') top left repeat-x #d8edfd;
+	overflow: hidden;
 }
 
-#header {
-  position: relative;
-  height: 56px;
-  background: url('images/banner_bg.gif') top left repeat-x #fff;
+#banner .banner-bg {
+	position: absolute;
+	top: 0;
+	right: 0;
+	width: 630px;
+	height: 78px;
+	background: url('images/banner_schraffur.gif') top right no-repeat;
+	z-index: 0;
 }
 
-#header div.banner-logo {
-  position: absolute;
-  top: 0px;
-  left: 0px;
-  width: 200px;
-  height: 56px;
+#banner .banner-logo {
+	position: absolute;
+	top: 10px;
+	left: 20px;
+	z-index: 4;
 }
 
-#header div.banner-right {
-  position: absolute;
-  right: 0px;
-  top: 0px;
-  width: 10px;
-  height: 56px;
+#banner .banner-logo a {
+	border: 0;
 }
 
 #topnav {
-  position: absolute;
-  right: 20px;
-  bottom: 8px;
-  text-align: right;
-  color: #ebebeb;
-  font-size: smaller;
+	position: absolute;
+	top: 3.6em;
+	right: 20px;
 }
 
 #topnav a {
-  color: #ebebeb;
-  font-size: 11px;
-  text-decoration: none;
-}
-
-#topnav a:hover {
-  text-decoration: underline;
+	color: #666;
 }
 
 #content {
-  margin: 8px 20px;
+	margin: 2em 20px;
 }
 
 #footer {
diff --git a/installer/test.php b/installer/test.php
index 713edfbb6..02a1cebe2 100644
--- a/installer/test.php
+++ b/installer/test.php
@@ -156,6 +156,14 @@ if ($db_working && $_POST['initdb']) {
     }
 }
 
+else if ($db_working && $_POST['updatedb']) {
+  if (!($success = $RCI->update_db($DB, $_POST['version']))) {
+      $updatefile = INSTALL_PATH . 'SQL/' . (isset($RCI->db_map[$DB->db_provider]) ? $RCI->db_map[$DB->db_provider] : $DB->db_provider) . '.update.sql';
+      echo '<p class="warning">Please manually execute the SQL statements from '.$updatefile.' on your database.<br/>';
+      echo 'See comments in the file and execute queries below the comment with the currently installed version number.</p>';
+  }
+}
+
 // test database
 if ($db_working) {
     $db_read = $DB->query("SELECT count(*) FROM {$RCI->config['db_table_users']}");
@@ -164,12 +172,13 @@ if ($db_working) {
         echo '<p><input type="submit" name="initdb" value="Initialize database" /></p>';
         $db_working = false;
     }
-    else if ($RCI->db_schema_check($DB, $update = !empty($_POST['updatedb']))) {
+    else if ($err = $RCI->db_schema_check($DB, $update = !empty($_POST['updatedb']))) {
         $RCI->fail('DB Schema', "Database schema differs");
-        $db_map = array('pgsql' => 'postgres', 'mysqli' => 'mysql', 'sqlsrv' => 'mssql');
-        $updatefile = INSTALL_PATH . 'SQL/' . (isset($db_map[$DB->db_provider]) ? $db_map[$DB->db_provider] : $DB->db_provider) . '.update.sql';
-        echo '<p class="warning">Please manually execute the SQL statements from '.$updatefile.' on your database.<br/>';
-        echo 'See comments in the file and execute queries that are superscribed with the currently installed version number.</p>';
+        echo '<ul style="margin:0"><li>' . join("</li>\n<li>", $err) . "</li></ul>";
+        $select = $RCI->versions_select(array('name' => 'version'));
+        echo '<p class="suggestion">You should run the update queries to get the schmea fixed.<br/><br/>Version to update from: ' . $select->show() . '&nbsp;<input type="submit" name="updatedb" value="Update" /></p>';
+//        echo '<p class="warning">Please manually execute the SQL statements from '.$updatefile.' on your database.<br/>';
+//        echo 'See comments in the file and execute queries that are superscribed with the currently installed version number.</p>';
         $db_working = false;
     }
     else {
@@ -412,7 +421,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
-enable_installer option in main.inc.php is disabled.<br />
+<tt>enable_installer</tt> option in config/main.inc.php is disabled.<br />
 <br />
 
 These files may expose sensitive configuration data like server passwords and encryption keys
author	thomascube <thomas@roundcube.net>	2011-02-25 16:37:22 +0000
committer	thomascube <thomas@roundcube.net>	2011-02-25 16:37:22 +0000
commit	e6bb836e053913ec8a5930a6d51af1fa55eb08e2 (patch)
tree	92fe8cdb0529d8543d488b3164202e2d7833c0f6 /installer
parent	b8f14ce7442c3a7e1a9e081b88c3108405c7a86e (diff)