X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=installer%2Frcube_install.php;h=dbe662acff869750ea29244a98d22a848382ff32;hb=76507f7c63a660742e76889ad6e3919f3dde3bb0;hp=f30c0085f1e4b3f44c86c6f870ddb4af4cb70055;hpb=b68022ca3782d5eb5a1a7ef6f8cf7abe1dc15bd6;p=roundcube.git diff --git a/installer/rcube_install.php b/installer/rcube_install.php index f30c008..dbe662a 100644 --- a/installer/rcube_install.php +++ b/installer/rcube_install.php @@ -4,8 +4,8 @@ +-----------------------------------------------------------------------+ | rcube_install.php | | | - | This file is part of the RoundCube Webmail package | - | Copyright (C) 2008-2009, RoundCube Dev. - Switzerland | + | This file is part of the Roundcube Webmail package | + | Copyright (C) 2008-2011, The Roundcube Dev Team | | Licensed under the GNU Public License | +-----------------------------------------------------------------------+ @@ -15,10 +15,10 @@ /** - * Class to control the installation process of the RoundCube Webmail package + * Class to control the installation process of the Roundcube Webmail package * * @category Install - * @package RoundCube + * @package Roundcube * @author Thomas Bruederli */ class rcube_install @@ -29,26 +29,24 @@ 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', 'multiple_identities' => 'identities_level', 'addrbook_show_images' => 'show_images', + 'imap_root' => 'imap_ns_personal', ); - // 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', 'smtp_auth_type', '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', 'imap_root', 'imap_delimiter', - 'virtuser_file', 'virtuser_query', 'dont_override'); + // 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', + ); /** * Constructor @@ -97,14 +95,15 @@ class rcube_install */ function _load_config($suffix) { - @include RCMAIL_CONFIG_DIR . '/main.inc' . $suffix; - if (is_array($rcmail_config)) { - $this->config += $rcmail_config; + if (is_readable($main_inc = RCMAIL_CONFIG_DIR . '/main.inc' . $suffix)) { + include($main_inc); + if (is_array($rcmail_config)) + $this->config += $rcmail_config; } - - @include RCMAIL_CONFIG_DIR . '/db.inc'. $suffix; - 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; } } @@ -125,8 +124,8 @@ class rcube_install return $value !== null && $value !== '' ? $value : $default; } - - + + /** * Take the default config file and replace the parameters * with the submitted form data @@ -137,25 +136,28 @@ class rcube_install function create_config($which, $force = false) { $out = @file_get_contents(RCMAIL_CONFIG_DIR . "/{$which}.inc.php.dist"); - + if (!$out) return '[Warning: could not read the config template file]'; foreach ($this->config as $prop => $default) { - $value = (isset($_POST["_$prop"]) || $this->bool_config_props[$prop]) ? $_POST["_$prop"] : $default; - + + $is_default = !isset($_POST["_$prop"]); + $value = !$is_default || $this->bool_config_props[$prop] ? $_POST["_$prop"] : $default; + // convert some form data - if ($prop == 'debug_level') { - $val = 0; - if (is_array($value)) + if ($prop == 'debug_level' && !$is_default) { + if (is_array($value)) { + $val = 0; foreach ($value as $dbgval) $val += intval($dbgval); - $value = $val; + $value = $val; + } } else if ($which == 'db' && $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 + else if ($_POST['_dbtype']) $value = sprintf('%s://%s:%s@%s/%s', $_POST['_dbtype'], rawurlencode($_POST['_dbuser']), rawurlencode($_POST['_dbpass']), $_POST['_dbhost'], $_POST['_dbname']); } @@ -176,16 +178,17 @@ class rcube_install 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; + 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; + if (!in_array($_folder, $value)) + $value[] = $_folder; } } else if (is_bool($default)) { @@ -194,9 +197,9 @@ class rcube_install else if (is_numeric($value)) { $value = intval($value); } - + // skip this property - if (!$force && ($value == $default)) + if (!$force && !$this->configured && ($value == $default)) continue; // save change @@ -205,7 +208,7 @@ class rcube_install // replace the matching line in config file $out = preg_replace( '/(\$rcmail_config\[\''.preg_quote($prop).'\'\])\s+=\s+(.+);/Uie', - "'\\1 = ' . rcube_install::_dump_var(\$value) . ';'", + "'\\1 = ' . rcube_install::_dump_var(\$value, \$prop) . ';'", $out); } @@ -230,7 +233,7 @@ class rcube_install return null; $out = $seen = array(); - $optional = array_flip($this->optional_config); + $required = array_flip($this->required_config); // iterate over the current configuration foreach ($this->config as $prop => $value) { @@ -246,19 +249,19 @@ class rcube_install // 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 pspell extension which could not be loaded.'); } - if (!empty($this->config['spellcheck_languages'])) { + 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)"); } @@ -298,8 +301,8 @@ class rcube_install $current = $this->config; $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]); @@ -307,8 +310,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) { @@ -325,22 +328,83 @@ 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) { $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; + + // 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; + 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 - * required for this version of RoundCube + * 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($update = false) + function mdb2_schema_check($update = false) { if (!$this->configured) return false; @@ -355,7 +419,8 @@ class rcube_install 'portability' => true ); - $schema =& MDB2_Schema::factory($this->config['db_dsnw'], $options); + $dsnw = $this->config['db_dsnw']; + $schema = MDB2_Schema::factory($dsnw, $options); $schema->db->supported['transactions'] = false; if (PEAR::isError($schema)) { @@ -372,10 +437,11 @@ class rcube_install } // load reference schema - $dsn = MDB2::parseDSN($this->config['db_dsnw']); - $ref_schema = INSTALL_PATH . 'SQL/' . $dsn['phptype'] . '.schema.xml'; + $dsn_arr = MDB2::parseDSN($this->config['db_dsnw']); + + $ref_schema = INSTALL_PATH . 'SQL/' . $dsn_arr['phptype'] . '.schema.xml'; - if (is_file($ref_schema)) { + if (is_readable($ref_schema)) { $reference = $schema->parseDatabaseDefinition($ref_schema, false, array(), $schema->options['fail_on_invalid_names']); if (PEAR::isError($reference)) { @@ -433,12 +499,36 @@ class rcube_install foreach ($default_hosts as $key => $name) { if (!empty($name)) - $out[] = is_numeric($key) ? $name : $key; + $out[] = rcube_parse_host(is_numeric($key) ? $name : $key); } 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; + } + + /** + * Return a list with available subfolders of the skin directory + */ + function list_skins() + { + $skins = array(); + $skindir = INSTALL_PATH . 'skins/'; + foreach (glob($skindir . '*') as $path) { + if (is_dir($path) && is_readable($path)) { + $skins[] = substr($path, strlen($skindir)); + } + } + return $skins; + } /** * Display OK status @@ -526,7 +616,22 @@ class rcube_install } - static function _dump_var($var) { + static function _dump_var($var, $name=null) { + // special values + switch ($name) { + case 'syslog_facility': + $list = array(32 => 'LOG_AUTH', 80 => 'LOG_AUTHPRIV', 72 => ' LOG_CRON', + 24 => 'LOG_DAEMON', 0 => 'LOG_KERN', 128 => 'LOG_LOCAL0', + 136 => 'LOG_LOCAL1', 144 => 'LOG_LOCAL2', 152 => 'LOG_LOCAL3', + 160 => 'LOG_LOCAL4', 168 => 'LOG_LOCAL5', 176 => 'LOG_LOCAL6', + 184 => 'LOG_LOCAL7', 48 => 'LOG_LPR', 16 => 'LOG_MAIL', + 56 => 'LOG_NEWS', 40 => 'LOG_SYSLOG', 8 => 'LOG_USER', 64 => 'LOG_UUCP'); + if ($val = $list[$var]) + return $val; + break; + } + + if (is_array($var)) { if (empty($var)) { return 'array()'; @@ -557,41 +662,100 @@ 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 = 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 = "../SQL/$engine.initial.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 + * Handler for Roundcube errors */ function raise_error($p) {