githubFork/roundcubemail.git

			@@ -4,21 +4,21 @@
			+-----------------------------------------------------------------------+
			\| 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 \|
			\| This file is part of the Roundcube Webmail package \|
			\| Copyright (C) 2008-2012, The Roundcube Dev Team \|
			\| \|
			\| Licensed under the GNU General Public License version 3 or \|
			\| any later version with exceptions for skins & plugins. \|
			\| See the README file for a full license statement. \|
			+-----------------------------------------------------------------------+

			$Id: $

			*/


			/**
			* 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
			@@ -32,17 +32,35 @@
			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',
			'skin_path' => 'skin',
			'locale_string' => 'language',
			'multiple_identities' => 'identities_level',
			'addrbook_show_images' => 'show_images',
			'imap_root' => 'imap_ns_personal',
			'pagesize' => 'mail_pagesize',
			'default_imap_folders' => 'default_folders',
			'top_posting' => 'reply_mode',
			);

			// these config options are optional or can be set to null
			var $required_config = array('db_dsnw', 'des_key');


			// 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', 'support_url',
			);

			// list of supported database drivers
			var $supported_dbs = array(
			'MySQL' => 'pdo_mysql',
			'PostgreSQL' => 'pdo_pgsql',
			'SQLite' => 'pdo_sqlite',
			'SQLite (v2)' => 'pdo_sqlite2',
			'SQL Server (SQLSRV)' => 'pdo_sqlsrv',
			'SQL Server (DBLIB)' => 'pdo_dblib',
			);


			/**
			* Constructor
			*/
			@@ -51,20 +69,20 @@
			$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
			*/
			@@ -90,18 +108,19 @@
			*/
			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 = RCUBE_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 = RCUBE_CONFIG_DIR . 'db.inc'. $suffix)) {
			include($db_inc);
			if (is_array($rcmail_config))
			$this->config += $rcmail_config;
			}
			}




			/**
			* Getter for a certain config property
			*
			@@ -112,14 +131,14 @@
			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
			@@ -129,26 +148,29 @@
			*/
			function create_config($which, $force = false)
			{
			$out = @file_get_contents(RCMAIL_CONFIG_DIR . "/{$which}.inc.php.dist");

			$out = @file_get_contents(RCUBE_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']);
			}
			@@ -160,7 +182,7 @@
			if (count($value) <= 1)
			$value = $value[0];
			}
			else if ($prop == 'pagesize') {
			else if ($prop == 'mail_pagesize' \|\| $prop == 'addressbook_pagesize') {
			$value = max(2, intval($value));
			}
			else if ($prop == 'smtp_user' && !empty($_POST['_smtp_user_u'])) {
			@@ -169,16 +191,17 @@
			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_folders') {
			$value = array();
			foreach ($this->config['default_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)) {
			@@ -187,9 +210,9 @@
			else if (is_numeric($value)) {
			$value = intval($value);
			}


			// skip this property
			if (!$force && ($value == $default))
			if (!$force && !$this->configured && ($value == $default))
			continue;

			// save change
			@@ -198,7 +221,7 @@
			// 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);
			}

			@@ -217,14 +240,14 @@
			$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]) {
			@@ -236,10 +259,15 @@
			$seen[$prop] = true;
			}
			}


			// the old default mime_magic reference is obsolete
			if ($this->config['mime_magic'] == '/usr/share/misc/magic') {
			$out['obsolete'][] = array('prop' => 'mime_magic', 'explain' => "Set value to null in order to use system default");
			}

			// iterate over default config
			foreach ($defaults as $prop => $value) {
			if (!isset($seen[$prop]) && !isset($this->config[$prop]) && isset($required[$prop]))
			if (!isset($seen[$prop]) && isset($required[$prop]) && !(is_bool($this->config[$prop]) \|\| strlen($this->config[$prop])))
			$out['missing'][] = array('prop' => $prop);
			}

			@@ -251,12 +279,12 @@
			}
			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)");
			}
			}


			if ($this->config['log_driver'] == 'syslog') {
			if (!function_exists('openlog')) {
			$out['dependencies'][] = array('prop' => 'log_driver',
			@@ -267,7 +295,7 @@
			'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) {
			@@ -277,11 +305,11 @@
			}
			}
			}


			return $out;
			}




			/**
			* Merge the current configuration with the defaults
			* and copy replaced values to the new options.
			@@ -291,8 +319,8 @@
			$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]);
			@@ -300,14 +328,14 @@
			$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) {
			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) {
			@@ -317,94 +345,73 @@
			}
			}
			}


			$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
			* 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 db_schema_check($DB, $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;
			// 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];
			}
			}
			else
			$this->raise_error(array('message' => "Could not find reference schema file ($ref_schema)"));
			return false;
			}

			return false;

			return $schema;
			}




			/**
			* Getter for the last error message
			*
			@@ -414,8 +421,8 @@
			{
			return $this->last_error['message'];
			}




			/**
			* Return a list with all imap hosts configured
			*
			@@ -425,16 +432,50 @@
			{
			$default_hosts = (array)$this->getprop('default_host');
			$out = array();


			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',
			'0.6-beta', '0.6',
			'0.7-beta', '0.7', '0.7.1', '0.7.2', '0.7.3',
			'0.8-beta', '0.8-rc', '0.8.0', '0.8.1', '0.8.2', '0.8.3', '0.8.4',
			'0.9-beta',
			));
			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
			*
			@@ -446,8 +487,8 @@
			echo Q($name) . ':  <span class="success">OK</span>';
			$this->_showhint($message);
			}




			/**
			* Display an error status and increase failure count
			*
			@@ -458,7 +499,7 @@
			function fail($name, $message = '', $url = '')
			{
			$this->failures++;


			echo Q($name) . ':  <span class="fail">NOT OK</span>';
			$this->_showhint($message, $url);
			}
			@@ -476,8 +517,8 @@
			echo Q($name) . ':  <span class="na">NOT OK</span>';
			$this->_showhint($message, $url);
			}




			/**
			* Display warning status
			*
			@@ -490,24 +531,24 @@
			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))
			@@ -516,12 +557,27 @@
			$out[$k] = $val;
			}
			}


			return $out;
			}


			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()';
			@@ -534,16 +590,16 @@
			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
			*
			@@ -552,31 +608,18 @@
			*/
			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 = $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;
			}
			}
			$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;
			@@ -584,16 +627,60 @@

			return true;
			}



			/**
			* Handler for RoundCube errors
			* Update database schema
			*
			* @param string Version to update from
			*
			* @return boolen True on success, False on error
			*/
			function update_db($version)
			{
			system(INSTALL_PATH . "bin/updatedb.sh --package=roundcube --version=" . $version
			. " --dir=" . INSTALL_PATH . "SQL", $result);

			return !$result;
			}


			/**
			* 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
			*/
			function raise_error($p)
			{
			$this->last_error = $p;
			}




			/**
			* Generarte a ramdom string to be used as encryption key
			*
			@@ -605,12 +692,12 @@
			{
			$alpha = 'ABCDEFGHIJKLMNOPQERSTUVXYZabcdefghijklmnopqrtsuvwxyz0123456789+*%&?!$-_=';
			$out = '';


			for ($i=0; $i < $length; $i++)
			$out .= $alpha{rand(0, strlen($alpha)-1)};


			return $out;
			}


			}