You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
654 lines
18 KiB
PHP
654 lines
18 KiB
PHP
<?php
|
|
|
|
/*
|
|
+-----------------------------------------------------------------------+
|
|
| rcube_install.php |
|
|
| |
|
|
| This file is part of the RoundCube Webmail package |
|
|
| Copyright (C) 2008-2009, RoundCube Dev. - Switzerland |
|
|
| Licensed under the GNU Public License |
|
|
+-----------------------------------------------------------------------+
|
|
|
|
$Id: $
|
|
|
|
*/
|
|
|
|
|
|
/**
|
|
* Class to control the installation process of the RoundCube Webmail package
|
|
*
|
|
* @category Install
|
|
* @package RoundCube
|
|
* @author Thomas Bruederli
|
|
*/
|
|
class rcube_install
|
|
{
|
|
var $step;
|
|
var $is_post = false;
|
|
var $failures = 0;
|
|
var $config = array();
|
|
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 $bool_config_props = array();
|
|
|
|
var $obsolete_config = array('db_backend');
|
|
var $replaced_config = array(
|
|
'skin_path' => 'skin',
|
|
'locale_string' => 'language',
|
|
'multiple_identities' => 'identities_level',
|
|
'addrbook_show_images' => 'show_images',
|
|
);
|
|
|
|
// these config options are required for a working system
|
|
var $required_config = array('db_dsnw', 'db_table_contactgroups', 'db_table_contactgroupmembers', 'des_key');
|
|
|
|
/**
|
|
* Constructor
|
|
*/
|
|
function rcube_install()
|
|
{
|
|
$this->step = intval($_REQUEST['_step']);
|
|
$this->is_post = $_SERVER['REQUEST_METHOD'] == 'POST';
|
|
}
|
|
|
|
/**
|
|
* Singleton getter
|
|
*/
|
|
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);
|
|
}
|
|
|
|
/**
|
|
* Read the default config file and store properties
|
|
* @access private
|
|
*/
|
|
function _load_config($suffix)
|
|
{
|
|
@include RCMAIL_CONFIG_DIR . '/main.inc' . $suffix;
|
|
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;
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Getter for a certain config property
|
|
*
|
|
* @param string Property name
|
|
* @param string Default value
|
|
* @return string The property value
|
|
*/
|
|
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
|
|
*
|
|
* @param string Which config file (either 'main' or 'db')
|
|
* @return string The complete config file content
|
|
*/
|
|
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;
|
|
|
|
// convert some form data
|
|
if ($prop == 'debug_level') {
|
|
$val = 0;
|
|
if (is_array($value))
|
|
foreach ($value as $dbgval)
|
|
$val += intval($dbgval);
|
|
$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
|
|
$value = sprintf('%s://%s:%s@%s/%s', $_POST['_dbtype'],
|
|
rawurlencode($_POST['_dbuser']), rawurlencode($_POST['_dbpass']), $_POST['_dbhost'], $_POST['_dbname']);
|
|
}
|
|
else if ($prop == 'smtp_auth_type' && $value == '0') {
|
|
$value = '';
|
|
}
|
|
else if ($prop == 'default_host' && is_array($value)) {
|
|
$value = rcube_install::_clean_array($value);
|
|
if (count($value) <= 1)
|
|
$value = $value[0];
|
|
}
|
|
else if ($prop == 'pagesize') {
|
|
$value = max(2, intval($value));
|
|
}
|
|
else if ($prop == 'smtp_user' && !empty($_POST['_smtp_user_u'])) {
|
|
$value = '%u';
|
|
}
|
|
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;
|
|
}
|
|
else if (is_numeric($value)) {
|
|
$value = intval($value);
|
|
}
|
|
|
|
// skip this property
|
|
if (!$force && ($value == $default))
|
|
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) . ';'",
|
|
$out);
|
|
}
|
|
|
|
return trim($out);
|
|
}
|
|
|
|
|
|
/**
|
|
* Check the current configuration for missing properties
|
|
* and deprecated or obsolete settings
|
|
*
|
|
* @return array List with problems detected
|
|
*/
|
|
function check_config()
|
|
{
|
|
$this->config = array();
|
|
$this->load_defaults();
|
|
$defaults = $this->config;
|
|
|
|
$this->load_config();
|
|
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]) {
|
|
$out['replaced'][] = array('prop' => $prop, 'replacement' => $replacement);
|
|
$seen[$replacement] = true;
|
|
}
|
|
else if (!$seen[$prop] && in_array($prop, $this->obsolete_config)) {
|
|
$out['obsolete'][] = array('prop' => $prop);
|
|
$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);
|
|
}
|
|
|
|
// 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;
|
|
}
|
|
|
|
|
|
/**
|
|
* Merge the current configuration with the defaults
|
|
* and copy replaced values to the new options.
|
|
*/
|
|
function merge_config()
|
|
{
|
|
$current = $this->config;
|
|
$this->config = array();
|
|
$this->load_defaults();
|
|
|
|
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]);
|
|
else if ($prop == 'multiple_identities')
|
|
$this->config[$replacement] = $current[$prop] ? 2 : 0;
|
|
else
|
|
$this->config[$replacement] = $current[$prop];
|
|
|
|
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) {
|
|
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;
|
|
}
|
|
|
|
|
|
/**
|
|
* Getter for the last error message
|
|
*
|
|
* @return string Error message or null if none exists
|
|
*/
|
|
function get_error()
|
|
{
|
|
return $this->last_error['message'];
|
|
}
|
|
|
|
|
|
/**
|
|
* Return a list with all imap hosts configured
|
|
*
|
|
* @return array Clean list with imap hosts
|
|
*/
|
|
function get_hostlist()
|
|
{
|
|
$default_hosts = (array)$this->getprop('default_host');
|
|
$out = array();
|
|
|
|
foreach ($default_hosts as $key => $name) {
|
|
if (!empty($name))
|
|
$out[] = is_numeric($key) ? $name : $key;
|
|
}
|
|
|
|
return $out;
|
|
}
|
|
|
|
|
|
/**
|
|
* Display OK status
|
|
*
|
|
* @param string Test name
|
|
* @param string Confirm message
|
|
*/
|
|
function pass($name, $message = '')
|
|
{
|
|
echo Q($name) . ': <span class="success">OK</span>';
|
|
$this->_showhint($message);
|
|
}
|
|
|
|
|
|
/**
|
|
* Display an error status and increase failure count
|
|
*
|
|
* @param string Test name
|
|
* @param string Error message
|
|
* @param string URL for details
|
|
*/
|
|
function fail($name, $message = '', $url = '')
|
|
{
|
|
$this->failures++;
|
|
|
|
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);
|
|
}
|
|
|
|
|
|
/**
|
|
* Display warning status
|
|
*
|
|
* @param string Test name
|
|
* @param string Warning message
|
|
* @param string URL for details
|
|
*/
|
|
function na($name, $message = '', $url = '')
|
|
{
|
|
echo Q($name) . ': <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))
|
|
$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);
|
|
}
|
|
|
|
|
|
/**
|
|
* 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;
|
|
|
|
// 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 (preg_match('/^--/', $line))
|
|
continue;
|
|
|
|
$buff .= $line . "\n";
|
|
if (preg_match('/;$/', trim($line))) {
|
|
$DB->query($buff);
|
|
$buff = '';
|
|
if ($this->get_error())
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
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
|
|
*/
|
|
function raise_error($p)
|
|
{
|
|
$this->last_error = $p;
|
|
}
|
|
|
|
|
|
/**
|
|
* Generarte a ramdom string to be used as encryption key
|
|
*
|
|
* @param int Key length
|
|
* @return string The generated random string
|
|
* @static
|
|
*/
|
|
function random_key($length)
|
|
{
|
|
$alpha = 'ABCDEFGHIJKLMNOPQERSTUVXYZabcdefghijklmnopqrtsuvwxyz0123456789+*%&?!$-_=';
|
|
$out = '';
|
|
|
|
for ($i=0; $i < $length; $i++)
|
|
$out .= $alpha{rand(0, strlen($alpha)-1)};
|
|
|
|
return $out;
|
|
}
|
|
|
|
}
|
|
|