install: fix install procedure

install procedure as a wizard
graphical rappresentation of passed/unpassed system checks
db connection test don't try anymore to create the db
admin email and timezone are asked in a separate pass
fix loading of database.sql, removing comments from phpmyadmin export
fix check for .htconfig.php writability
ask for php-cli path if not found in PATH
install_db.tpl use field_* templates to render the form

1 files changed, 361 insertions, 151 deletions

diff --git a/mod/install.php b/mod/install.php
index d994ca70f..f7820fc80 100644
--- a/mod/install.php
+++ b/mod/install.php
@@ -1,68 +1,99 @@
 <?php
 
+$install_wizard_pass=1;
+
+
+function install_init(&$a){
+	global $install_wizard_pass;
+	if (x($_POST,'pass'))
+		$install_wizard_pass = intval($_POST['pass']);
+
+}
 
 function install_post(&$a) {
+	global $install_wizard_pass, $db;
 
-	global $db;
-
-	$urlpath = $a->get_path();
-	$dbhost = notags(trim($_POST['dbhost']));
-	$dbuser = notags(trim($_POST['dbuser']));
-	$dbpass = notags(trim($_POST['dbpass']));
-	$dbdata = notags(trim($_POST['dbdata']));
-	$timezone = notags(trim($_POST['timezone']));
-	$phpath = notags(trim($_POST['phpath']));
-	$adminmail = notags(trim($_POST['adminmail']));
-
-	require_once("dba.php");
-	unset($db);
-	$db = new dba($dbhost, $dbuser, $dbpass, $dbdata, true);
-
-	if(get_db_errno()) {
-		unset($db);
-		$db = new dba($dbhost, $dbuser, $dbpass, '', true);
-		if(! get_db_errno()) {
-			$r = q("CREATE DATABASE '%s'",
-					dbesc($dbdata)
-			);
-			if($r) {
+	switch($install_wizard_pass) {
+		case 1:
+		case 2:
+			return;
+			break; // just in case return don't return :)
+		case 3:
+			$urlpath = $a->get_path();
+			$dbhost = notags(trim($_POST['dbhost']));
+			$dbuser = notags(trim($_POST['dbuser']));
+			$dbpass = notags(trim($_POST['dbpass']));
+			$dbdata = notags(trim($_POST['dbdata']));
+			$phpath = notags(trim($_POST['phpath']));
+
+			require_once("dba.php");
+			unset($db);
+			$db = new dba($dbhost, $dbuser, $dbpass, $dbdata, true);
+			/*if(get_db_errno()) {
 				unset($db);
-				$db = new dba($dbhost, $dbuser, $dbpass, $dbdata, true);
+				$db = new dba($dbhost, $dbuser, $dbpass, '', true);
+
+				if(! get_db_errno()) {
+					$r = q("CREATE DATABASE '%s'",
+							dbesc($dbdata)
+					);
+					if($r) {
+						unset($db);
+						$db = new dba($dbhost, $dbuser, $dbpass, $dbdata, true);
+					} else {
+						$a->data['db_create_failed']=true;
+					}
+				} else {
+					$a->data['db_conn_failed']=true;
+					return;
+				}
+			}*/
+			if(get_db_errno()) {
+				$a->data['db_conn_failed']=true;
 			}
-		}
-		if(get_db_errno()) {
-			notice( t('Could not create/connect to database.') . EOL);
-			return;
-		}
-	}
-
-	info( t('Connected to database.') . EOL);
-
-	$tpl = get_intltext_template('htconfig.tpl');
-	$txt = replace_macros($tpl,array(
-		'$dbhost' => $dbhost,
-		'$dbuser' => $dbuser,
-		'$dbpass' => $dbpass,
-		'$dbdata' => $dbdata,
-		'$timezone' => $timezone,
-		'$urlpath' => $urlpath,
-		'$phpath' => $phpath,
-		'$adminmail' => $adminmail
-	));
 
-	$result = file_put_contents('.htconfig.php', $txt);
-	if(! $result) {
-		$a->data['txt'] = $txt;
-	}
+			return; 
+			break;
+		case 4;
+			$urlpath = $a->get_path();
+			$dbhost = notags(trim($_POST['dbhost']));
+			$dbuser = notags(trim($_POST['dbuser']));
+			$dbpass = notags(trim($_POST['dbpass']));
+			$dbdata = notags(trim($_POST['dbdata']));
+			$phpath = notags(trim($_POST['phpath']));
+			$timezone = notags(trim($_POST['timezone']));
+			$adminmail = notags(trim($_POST['adminmail']));
+
+			// connect to db
+			$db = new dba($dbhost, $dbuser, $dbpass, $dbdata, true);
+
+			$tpl = get_intltext_template('htconfig.tpl');
+			$txt = replace_macros($tpl,array(
+				'$dbhost' => $dbhost,
+				'$dbuser' => $dbuser,
+				'$dbpass' => $dbpass,
+				'$dbdata' => $dbdata,
+				'$timezone' => $timezone,
+				'$urlpath' => $urlpath,
+				'$phpath' => $phpath,
+				'$adminmail' => $adminmail
+			));
+
+			$result = file_put_contents('.htconfig.php', $txt);
+			if(! $result) {
+				$a->data['txt'] = $txt;
+			}
 
-	$errors = load_database($db);
+			$errors = load_database($db);
 
-	if($errors)
-		$a->data['db_failed'] = true;
-	else
-		$a->data['db_installed'] = true;
+			if($errors)
+				$a->data['db_failed'] = $errors;
+			else
+				$a->data['db_installed'] = true;
 
-	return;
+			return;
+		break;
+	}
 }
 
 function get_db_errno() {
@@ -74,107 +105,249 @@ function get_db_errno() {
 
 function install_content(&$a) {
 
-	global $db;
+	global $install_wizard_pass, $db;
 	$o = '';
+	$wizard_status = "";
+	$install_title = t('Friendica Social Communications Server - Setup');
+	
+	if(x($a->data,'txt') && strlen($a->data['txt'])) {
+		$tpl = get_markup_template('install.tpl');
+		return replace_macros($tpl, array(
+			'$title' => $install_title,
+			'$pass' => t('Database connection'),
+			'$text' => manual_config($a),
+		));
+	}
+	
+	if(x($a->data,'db_conn_failed')) {
+		$install_wizard_pass = 2;
+		$wizard_status =  t('Could not connect to database.');
+	}
+	if(x($a->data,'db_create_failed')) {
+		$install_wizard_pass = 2;
+		$wizard_status =  t('Could not create table.');
+	}
 	
 	if(x($a->data,'db_installed')) {
-		$o .= '<h2>' . t('Proceed with Installation') . '</h2>';
-		$o .= '<p style="font-size: 130%;">';
-		$o .= t('Your Friendica site database has been installed.') . EOL;
-		$o .= t('IMPORTANT: You will need to [manually] setup a scheduled task for the poller.') . EOL ;
-		$o .= t('Please see the file "INSTALL.txt".') . EOL ;
-		$o .= '<br />';
-		$o .= '<a href="' . $a->get_baseurl() . '/register' . '">' . t('Proceed to registration') . '</a>' ;
-		$o .= '</p>';
-		return $o;
+		$txt = '<p style="font-size: 130%;">';
+		$txt .= t('Your Friendica site database has been installed.') . EOL;
+		$txt .= t('IMPORTANT: You will need to [manually] setup a scheduled task for the poller.') . EOL ;
+		$txt .= t('Please see the file "INSTALL.txt".') . EOL ;
+		$txt .= '<br />';
+		$txt .= '<a href="' . $a->get_baseurl() . '/register' . '">' . t('Proceed to registration') . '</a>' ;
+		$txt .= '</p>';
+		
+		$tpl = get_markup_template('install.tpl');
+		return replace_macros($tpl, array(
+			'$title' => $install_title,
+			'$pass' => t('Proceed with Installation'),
+			'$text' => $txt,
+		));
+
 	}
 
 	if(x($a->data,'db_failed')) {
-		$o .= t('Database import failed.') . EOL;
-		$o .= t('You may need to import the file "database.sql" manually using phpmyadmin or mysql.') . EOL;
-		$o .= t('Please see the file "INSTALL.txt".') . EOL ;
-		return $o;
+		$txt = t('You may need to import the file "database.sql" manually using phpmyadmin or mysql.') . EOL;
+		$txt .= t('Please see the file "INSTALL.txt".') . EOL ."<hr>" ;
+		$txt .= "<pre>".$a->data['db_failed'] . "</pre>". EOL ;
+
+		$tpl = get_markup_template('install.tpl');
+		return replace_macros($tpl, array(
+			'$title' => $install_title,
+			'$pass' => t('Database connection'),
+			'$status' => t('Database import failed.'),
+			'$text' => $txt,
+		));
+		
 	}
 
 	if($db && $db->connected) {
 		$r = q("SELECT COUNT(*) as `total` FROM `user`");
 		if($r && count($r) && $r[0]['total']) {
-			notice( t('Permission denied.') . EOL);
-			return '';
+			$tpl = get_markup_template('install.tpl');
+			return replace_macros($tpl, array(
+				'$title' => $install_title,
+				'$pass' => '',
+				'$status' => t('Permission denied.'),
+				'$text' => '',
+			));
 		}
 	}
 
-	info( t('Welcome to Friendica.') . EOL);
-
+	switch ($install_wizard_pass){
+		case 1: { // System check
 
-	check_funcs();
 
-	$o .= check_htconfig();
-	if(strlen($o))
-		return $o;
+			$checks = array();
 
-	if(strlen($a->data['txt'])) {
-		$o .= manual_config($a);
-		return;
-	}
+			check_funcs($checks);
 
-	$o .= check_php($phpath);
+			check_htconfig($checks);
 
-	$o .= check_keys();
+			check_keys($checks);
+			
+			if(x($_POST,'phppath'))
+				$phpath = notags(trim($_POST['phppath']));
 
+			check_php($phpath, $checks);
 
-	require_once('datetime.php');
 
-	$tpl = get_markup_template('install_db.tpl');
-	$o .= replace_macros($tpl, array(
-		'$lbl_01' => t('Friendica Social Communications Server'),
-		'$lbl_02' => t('Installation'),
-		'$lbl_03' => t('In order to install Friendica we need to know how to connect to your database.'),
-		'$lbl_04' => t('Please contact your hosting provider or site administrator if you have questions about these settings.'),
-		'$lbl_05' => t('The database you specify below should already exist. If it does not, please create it before continuing.'),
-		'$lbl_06' => t('Database Server Name'),
-		'$lbl_07' => t('Database Login Name'),
-		'$lbl_08' => t('Database Login Password'),
-		'$lbl_09' => t('Database Name'),
-		'$lbl_10' => t('Please select a default timezone for your website'),
-		'$lbl_11' => t('Site administrator email address. Your account email address must match this in order to use the web admin panel.'), 
-		'$baseurl' => $a->get_baseurl(),
-		'$tzselect' => ((x($_POST,'timezone')) ? select_timezone($_POST['timezone']) : select_timezone()),
-		'$submit' => t('Submit'),
-		'$dbhost' => ((x($_POST,'dbhost')) ? notags(trim($_POST['dbhost'])) : 'localhost'),
-		'$dbuser' => notags(trim($_POST['dbuser'])),
-		'$dbpass' => notags(trim($_POST['dbpass'])),
-		'$dbdata' => notags(trim($_POST['dbdata'])),
-		'$phpath' => $phpath,
-		'$adminmail' => notags(trim($_POST['adminmail']))
-	));
+			function check_passed($v, $c){
+				if ($c['required'])
+					$v = $v && $c['status'];
+				return $v;
+			}
+			$checkspassed = array_reduce($checks, "check_passed", true);
+			
+
+			$tpl = get_markup_template('install_checks.tpl');
+			$o .= replace_macros($tpl, array(
+				'$title' => $install_title,
+				'$pass' => t('System check'),
+				'$checks' => $checks,
+				'$passed' => $checkspassed,
+				'$see_install' => t('Please see the file "INSTALL.txt".'),
+				'$next' => t('Next'),
+				'$reload' => t('Check again'),
+				'$phpath' => $phpath,
+			));
+			return $o;
+		}; break;
+		
+		case 2: { // Database config
+
+			$dbhost = ((x($_POST,'dbhost')) ? notags(trim($_POST['dbhost'])) : 'localhost');
+			$dbuser = notags(trim($_POST['dbuser']));
+			$dbpass = notags(trim($_POST['dbpass']));
+			$dbdata = notags(trim($_POST['dbdata']));
+			$phpath = notags(trim($_POST['phppath']));
+			
+
+			$tpl = get_markup_template('install_db.tpl');
+			$o .= replace_macros($tpl, array(
+				'$title' => $install_title,
+				'$pass' => t('Database connection'),
+				'$info_01' => t('In order to install Friendica we need to know how to connect to your database.'),
+				'$info_02' => t('Please contact your hosting provider or site administrator if you have questions about these settings.'),
+				'$info_03' => t('The database you specify below should already exist. If it does not, please create it before continuing.'),
+
+				'$status' => $wizard_status,
+				
+				'$dbhost' => array('dbhost', t('Database Server Name'), $dbhost, ''),
+				'$dbuser' => array('dbuser', t('Database Login Name'), $dbuser, ''),
+				'$dbpass' => array('dbpass', t('Database Login Password'), $dbpass, ''),
+				'$dbdata' => array('dbdata', t('Database Name'), $dbdata, ''),
+				'$adminmail' => array('adminmail', t('Site administrator email address'), $adminmail, t('Your account email address must match this in order to use the web admin panel.')),
+
+				
+
+				'$lbl_10' => t('Please select a default timezone for your website'),
+				
+				'$baseurl' => $a->get_baseurl(),
+				
+				'$phpath' => $phpath,
+				
+				'$submit' => t('Submit'),
+				
+			));
+			return $o;
+		}; break;
+		case 3: { // Site settings
+			require_once('datetime.php');
+			$dbhost = ((x($_POST,'dbhost')) ? notags(trim($_POST['dbhost'])) : 'localhost');
+			$dbuser = notags(trim($_POST['dbuser']));
+			$dbpass = notags(trim($_POST['dbpass']));
+			$dbdata = notags(trim($_POST['dbdata']));
+			$phpath = notags(trim($_POST['phppath']));
+			
+			$adminmail = notags(trim($_POST['adminmail']));
+			$timezone = ((x($_POST,'timezone')) ? ($_POST['timezone']) : 'America/Los_Angeles');
+			
+			$tpl = get_markup_template('install_settings.tpl');
+			$o .= replace_macros($tpl, array(
+				'$title' => $install_title,
+				'$pass' => t('Site settings'),
+
+				'$status' => $wizard_status,
+				
+				'$dbhost' => $dbhost, 
+				'$dbuser' => $dbuser,
+				'$dbpass' => $dbpass,
+				'$dbdata' => $dbdata,
+				'$phpath' => $phpath,
+				
+				'$adminmail' => array('adminmail', t('Site administrator email address'), $adminmail, t('Your account email address must match this in order to use the web admin panel.')),
+
+				
+				'$timezone' => field_timezone('timezone', t('Please select a default timezone for your website'), $timezone, ''),
+				
+				'$baseurl' => $a->get_baseurl(),
+				
+				
+				
+				'$submit' => t('Submit'),
+				
+			));
+			return $o;
+		}; break;
+			
+	}
+}
 
-	return $o;
+/**
+ * checks   : array passed to template
+ * title    : string
+ * status   : boolean
+ * required : boolean
+ * help		: string optional
+ */
+function check_add(&$checks, $title, $status, $required, $help){
+	$checks[] = array(
+		'title' => $title,
+		'status' => $status,
+		'required' => $required,
+		'help'	=> $help,
+	);
 }
 
-function check_php(&$phpath) {
-	$o = '';
-	$phpath = trim(shell_exec('which php'));
-	if(! strlen($phpath)) {
-		$o .= t('Could not find a command line version of PHP in the web server PATH.') . EOL;
-		$o .= t('This is required. Please adjust the configuration file .htconfig.php accordingly.') . EOL;
+function check_php(&$phpath, &$checks) {
+	if (strlen($phpath)){
+		$passed = file_exists($phpath);
+	} else {
+		$phpath = trim(shell_exec('which php'));
+		$passed = strlen($phpath);
 	}
-	if(strlen($phpath)) {
+	$help = "";
+	if(!$passed) {
+		$help .= t('Could not find a command line version of PHP in the web server PATH.'). EOL;
+		$tpl = get_markup_template('field_input.tpl');
+		$help .= replace_macros($tpl, array(
+			'$field' => array('phppath', t('PHP executable path'), $phpath, t('Enter full path to php executable')),
+		));
+		$phpath="";
+	}
+	
+	check_add($checks, t('Command line PHP'), $passed, true, $help);
+	
+	if($passed) {
 		$str = autoname(8);
 		$cmd = "$phpath testargs.php $str";
 		$result = trim(shell_exec($cmd));
-		if($result != $str) {
-			$o .= t('The command line version of PHP on your system does not have "register_argc_argv" enabled.') . EOL;
-			$o .= t('This is required for message delivery to work.') . EOL;
+		$passed2 = $result == $str;
+		$help = "";
+		if(!$passed2) {
+			$help .= t('The command line version of PHP on your system does not have "register_argc_argv" enabled.'). EOL;
+			$help .= t('This is required for message delivery to work.');
 		}
+		check_add($checks, t('PHP "register_argc_argv"'), $passed, true, $help);
 	}
-	return $o;
+	
 
 }
 
-function check_keys() {
+function check_keys(&$checks) {
 
-	$o = '';
+	$help = '';
 
 	$res = false;
 
@@ -187,45 +360,73 @@ function check_keys() {
 	// Get private key
 
 	if(! $res) {
-		$o .= t('Error: the "openssl_pkey_new" function on this system is not able to generate encryption keys') . EOL;
-		$o .= t('If running under Windows, please see "http://www.php.net/manual/en/openssl.installation.php".') . EOL;
+		$help .= t('Error: the "openssl_pkey_new" function on this system is not able to generate encryption keys'). EOL;
+		$help .= t('If running under Windows, please see "http://www.php.net/manual/en/openssl.installation.php".');
 	}
-	return $o;
+	check_add($checks, t('Generate encryption keys'), $res, true, $help);
 
 }
 
 
-function check_funcs() {
-	if((function_exists('apache_get_modules')) && (! in_array('mod_rewrite',apache_get_modules())))
-		notice( t('Error: Apache webserver mod-rewrite module is required but not installed.') . EOL);
-	if(! function_exists('curl_init')) 
-		notice( t('Error: libCURL PHP module required but not installed.') . EOL);
-	if(! function_exists('imagecreatefromjpeg')) 
-		notice( t('Error: GD graphics PHP module with JPEG support required but not installed.') . EOL);
-	if(! function_exists('openssl_public_encrypt')) 
-		notice( t('Error: openssl PHP module required but not installed.') . EOL);	
-	if(! function_exists('mysqli_connect')) 
-		notice( t('Error: mysqli PHP module required but not installed.') . EOL);
-	if(! function_exists('mb_strlen'))
-		notice( t('Error: mb_string PHP module required but not installed.') . EOL);
+function check_funcs(&$checks) {
+	$ck_funcs = array();
+	check_add($ck_funcs, t('libCurl PHP module'), true, true, "");
+	check_add($ck_funcs, t('GD graphics PHP module'), true, true, "");
+	check_add($ck_funcs, t('OpenSSL PHP module'), true, true, "");
+	check_add($ck_funcs, t('mysqli PHP module'), true, true, "");
+	check_add($ck_funcs, t('mb_string PHP module'), true, true, "");
+		
+	
+	if(function_exists('apache_get_modules')){
+		if (! in_array('mod_rewrite',apache_get_modules())) {
+			check_add($ck_funcs, t('Apace mod_rewrite module'), false, true, t('Error: Apache webserver mod-rewrite module is required but not installed.'));
+		} else {
+			check_add($ck_funcs, t('Apace mod_rewrite module'), true, true, "");
+		}
+	}
+	if(! function_exists('curl_init')){
+		$ck_funcs[0]['status']= false;
+		$ck_funcs[0]['help']= t('Error: libCURL PHP module required but not installed.');
+	}
+	if(! function_exists('imagecreatefromjpeg')){
+		$ck_funcs[1]['status']= false;
+		$ck_funcs[1]['help']= t('Error: GD graphics PHP module with JPEG support required but not installed.');
+	}
+	if(! function_exists('openssl_public_encrypt')) {
+		$ck_funcs[2]['status']= false;
+		$ck_funcs[2]['help']= t('Error: openssl PHP module required but not installed.');
+	}
+	if(! function_exists('mysqli_connect')){
+		$ck_funcs[3]['status']= false;
+		$ck_funcs[3]['help']= t('Error: mysqli PHP module required but not installed.');
+	}
+	if(! function_exists('mb_strlen')){
+		$ck_funcs[4]['status']= false;
+		$ck_funcs[4]['help']= t('Error: mb_string PHP module required but not installed.');
+	}
 	
-	if((x($_SESSION,'sysmsg')) && is_array($_SESSION['sysmsg']) && count($_SESSION['sysmsg']))
-		notice( t('Please see the file "INSTALL.txt".') . EOL);
+	$checks = array_merge($checks, $ck_funcs);
+	
+	/*if((x($_SESSION,'sysmsg')) && is_array($_SESSION['sysmsg']) && count($_SESSION['sysmsg']))
+		notice( t('Please see the file "INSTALL.txt".') . EOL);*/
 }
 
 
-function check_htconfig() {
-
-	if(((file_exists('.htconfig.php')) && (! is_writable('.htconfig.php')))
-		|| (! is_writable('.'))) {
-
-		$o = t('The web installer needs to be able to create a file called ".htconfig.php" in the top folder of your web server and it is unable to do so.');
-		$o .= t('This is most often a permission setting, as the web server may not be able to write files in your folder - even if you can.');
-		$o .= t('Please check with your site documentation or support people to see if this situation can be corrected.');
-		$o .= t('If not, you may be required to perform a manual installation. Please see the file "INSTALL.txt" for instructions.'); 
+function check_htconfig(&$checks) {
+	$status = true;
+	$help = "";
+	if(	(file_exists('.htconfig.php') && !is_writable('.htconfig.php')) ||
+		(!file_exists('.htconfig.php') && !is_writable('.')) ) {
+	
+		$status=false;
+		$help = t('The web installer needs to be able to create a file called ".htconfig.php" in the top folder of your web server and it is unable to do so.') .EOL;
+		$help .= t('This is most often a permission setting, as the web server may not be able to write files in your folder - even if you can.').EOL;
+		$help .= t('Please check with your site documentation or support people to see if this situation can be corrected.').EOL;
+		$help .= t('If not, you may be required to perform a manual installation. Please see the file "INSTALL.txt" for instructions.').EOL; 
 	}
 
-	return $o;
+	check_add($checks, t('.htconfig.php is writable'), $status, true, $help);
+	
 }
 
 	
@@ -236,18 +437,27 @@ function manual_config(&$a) {
 	return $o;
 }
 
+function load_database_rem($v, $i){
+	$l = trim($i);
+	if (strlen($l)>1 && ($l[0]=="-" || ($l[0]=="/" && $l[1]=="*"))){
+		return $v;
+	} else  {
+		return $v."\n".$i;
+	}
+}
+
 
 function load_database($db) {
 
 	$str = file_get_contents('database.sql');
+	$str = array_reduce(explode("\n", $str),"load_database_rem","");
 	$arr = explode(';',$str);
-	$errors = 0;
+	$errors = false;
 	foreach($arr as $a) {
 		if(strlen(trim($a))) {	
 			$r = @$db->q(trim($a));
 			if(! $r) {
-				notice( t('Errors encountered creating database tables.') . $a . EOL);
-				$errors ++;
+				$errors .=  t('Errors encountered creating database tables.') . $a . EOL;
 			}
 		}
 	}