From bf67d60e435a6f01b835a0d5afb9737f81560433 Mon Sep 17 00:00:00 2001
From: alecpl <alec@alec.pl>
Date: Fri, 23 Apr 2010 08:25:44 -0400
Subject: [PATCH] - Skip session initialization/configuration if session is initialized already (e.g. using Installer)
---
installer/rcube_install.php | 302 ++++++++++++++++++++++++++++++++++++++++---------
1 files changed, 245 insertions(+), 57 deletions(-)
diff --git a/installer/rcube_install.php b/installer/rcube_install.php
index 21e353c..ae568d2 100644
--- a/installer/rcube_install.php
+++ b/installer/rcube_install.php
@@ -5,7 +5,7 @@
| rcube_install.php |
| |
| This file is part of the RoundCube Webmail package |
- | Copyright (C) 2008, RoundCube Dev. - Switzerland |
+ | Copyright (C) 2008-2009, RoundCube Dev. - Switzerland |
| Licensed under the GNU Public License |
+-----------------------------------------------------------------------+
@@ -30,19 +30,18 @@
var $configured = false;
var $last_error = null;
var $email_pattern = '([a-z0-9][a-z0-9\-\.\+\_]*@[a-z0-9]([a-z0-9\-][.]?)*[a-z0-9])';
- var $config_props = array();
+ var $bool_config_props = array();
var $obsolete_config = array('db_backend');
- var $replaced_config = array('skin_path' => 'skin', 'locale_string' => 'language');
+ var $replaced_config = array(
+ 'skin_path' => 'skin',
+ 'locale_string' => 'language',
+ 'multiple_identities' => 'identities_level',
+ 'addrbook_show_images' => 'show_images',
+ );
- // these config options are optional or can be set to null
- var $optional_config = array(
- 'log_driver', 'syslog_id', 'syslog_facility', 'imap_auth_type',
- 'smtp_helo_host', 'sendmail_delay', 'double_auth', 'language',
- 'mail_header_delimiter', 'create_default_folders',
- 'quota_zero_as_unlimited', 'spellcheck_uri', 'spellcheck_languages',
- 'http_received_header', 'session_domain', 'mime_magic', 'log_logins',
- 'enable_installer', 'skin_include_php');
+ // these config options are required for a working system
+ var $required_config = array('db_dsnw', 'db_table_contactgroups', 'db_table_contactgroupmembers', 'des_key');
/**
* Constructor
@@ -130,13 +129,13 @@
*/
function create_config($which, $force = false)
{
- $out = file_get_contents("../config/{$which}.inc.php.dist");
+ $out = @file_get_contents(RCMAIL_CONFIG_DIR . "/{$which}.inc.php.dist");
if (!$out)
- return '[Warning: could not read the template file]';
+ return '[Warning: could not read the config template file]';
foreach ($this->config as $prop => $default) {
- $value = (isset($_POST["_$prop"]) || $this->config_props[$prop]) ? $_POST["_$prop"] : $default;
+ $value = (isset($_POST["_$prop"]) || $this->bool_config_props[$prop]) ? $_POST["_$prop"] : $default;
// convert some form data
if ($prop == 'debug_level') {
@@ -170,6 +169,18 @@
else if ($prop == 'smtp_pass' && !empty($_POST['_smtp_user_u'])) {
$value = '%p';
}
+ else if ($prop == 'default_imap_folders'){
+ $value = Array();
+ foreach($this->config['default_imap_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;
+ }
+ }
else if (is_bool($default)) {
$value = (bool)$value;
}
@@ -187,7 +198,7 @@
// replace the matching line in config file
$out = preg_replace(
'/(\$rcmail_config\[\''.preg_quote($prop).'\'\])\s+=\s+(.+);/Uie',
- "'\\1 = ' . var_export(\$value, true) . ';'",
+ "'\\1 = ' . rcube_install::_dump_var(\$value) . ';'",
$out);
}
@@ -212,9 +223,9 @@
return null;
$out = $seen = array();
- $optional = array_flip($this->optional_config);
+ $required = array_flip($this->required_config);
- // ireate over the current configuration
+ // iterate over the current configuration
foreach ($this->config as $prop => $value) {
if ($replacement = $this->replaced_config[$prop]) {
$out['replaced'][] = array('prop' => $prop, 'replacement' => $replacement);
@@ -228,8 +239,43 @@
// iterate over default config
foreach ($defaults as $prop => $value) {
- if (!$seen[$prop] && !isset($this->config[$prop]) && !isset($optional[$prop]))
+ if (!isset($seen[$prop]) && !isset($this->config[$prop]) && isset($required[$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')) {
+ $out['dependencies'][] = array('prop' => 'spellcheck_engine',
+ 'explain' => 'This requires the <tt>pspell</tt> extension which could not be loaded.');
+ }
+ else if (!empty($this->config['spellcheck_languages'])) {
+ foreach ($this->config['spellcheck_languages'] as $lang => $descr)
+ 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.');
+ }
+ 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) {
+ if ($ldap_public['global_search']) {
+ $out['replaced'][] = array('prop' => 'ldap_public::global_search', 'replacement' => 'autocomplete_addressbooks');
+ break;
+ }
+ }
}
return $out;
@@ -250,6 +296,8 @@
if (isset($current[$prop])) {
if ($prop == 'skin_path')
$this->config[$replacement] = preg_replace('#skins/(\w+)/?$#', '\\1', $current[$prop]);
+ else if ($prop == 'multiple_identities')
+ $this->config[$replacement] = $current[$prop] ? 2 : 0;
else
$this->config[$replacement] = $current[$prop];
@@ -260,7 +308,137 @@
unset($current[$prop]);
}
- $this->config = array_merge($current, $this->config);
+ // 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) {
+ if ($ldap_public['global_search']) {
+ $this->config['autocomplete_addressbooks'][] = $key;
+ unset($current['ldap_public'][$key]['global_search']);
+ }
+ }
+ }
+
+ $this->config = array_merge($this->config, $current);
+
+ foreach ((array)$current['ldap_public'] as $key => $values) {
+ $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
+ * @return boolean True if the schema is up-to-date, false if not or an error occured
+ */
+ function db_schema_check($DB, $update = false)
+ {
+ 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(),
+ );
+
+ $errors = array();
+
+ // check list of tables
+ $existing_tables = $DB->list_tables();
+ foreach ($db_schema as $table => $cols) {
+ if (!in_array($this->config['db_table_'.$table], $existing_tables))
+ $errors[] = "Missing table ".$table;
+
+ // TODO: check cols and indices
+ }
+
+ return !empty($errors) ? $errors : false;
+ }
+
+ /**
+ * 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;
}
@@ -321,6 +499,20 @@
echo Q($name) . ': <span class="fail">NOT OK</span>';
$this->_showhint($message, $url);
}
+
+
+ /**
+ * Display an error status for optional settings/features
+ *
+ * @param string Test name
+ * @param string Error message
+ * @param string URL for details
+ */
+ function optfail($name, $message = '', $url = '')
+ {
+ echo Q($name) . ': <span class="na">NOT OK</span>';
+ $this->_showhint($message, $url);
+ }
/**
@@ -349,15 +541,43 @@
}
- function _clean_array($arr)
+ static function _clean_array($arr)
{
$out = array();
- foreach (array_unique($arr) as $i => $val)
- if (!empty($val))
- $out[] = $val;
+ foreach (array_unique($arr) as $k => $val) {
+ if (!empty($val)) {
+ if (is_numeric($k))
+ $out[] = $val;
+ else
+ $out[$k] = $val;
+ }
+ }
return $out;
+ }
+
+
+ static function _dump_var($var) {
+ if (is_array($var)) {
+ if (empty($var)) {
+ return 'array()';
+ }
+ else { // check if all keys are numeric
+ $isnum = true;
+ foreach ($var as $key => $value) {
+ 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);
}
@@ -372,26 +592,16 @@
$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))
+ if (preg_match('/^--/', $line))
continue;
$buff .= $line . "\n";
- if (eregi(';$', trim($line))) {
+ if (preg_match('/;$/', trim($line))) {
$DB->query($buff);
$buff = '';
if ($this->get_error())
@@ -439,27 +649,5 @@
return $out;
}
-}
-
-
-/**
- * Shortcut function for htmlentities()
- *
- * @param string String to quote
- * @return string The html-encoded string
- */
-function Q($string)
-{
- return htmlentities($string);
-}
-
-
-/**
- * Fake rinternal error handler to catch errors
- */
-function raise_error($p)
-{
- $rci = rcube_install::get_instance();
- $rci->raise_error($p);
}
--
Gitblit v1.9.1