New database update system that uses the database structure defined in dbstructure.php

boot.php

@@ -1000,6 +1000,10 @@ if(! function_exists('update_db')) {
 
 				if(DB_UPDATE_VERSION == UPDATE_VERSION) {
 
+					// Compare the current structure with the defined structure
+					require_once("include/dbstructure.php");
+					update_structure(false, true);
+
 					for($x = $stored; $x < $current; $x ++) {
 						if(function_exists('update_' . $x)) {
 

mod/install.php

@@ -4,7 +4,7 @@ $install_wizard_pass=1;
 
 
 function install_init(&$a){
-	
+
 	// $baseurl/install/testrwrite to test if rewite in .htaccess is working
 	if ($a->argc==2 && $a->argv[1]=="testrewrite") {
 		echo "ok";
@@ -58,7 +58,7 @@ function install_post(&$a) {
 				$a->data['db_conn_failed']=true;
 			}
 
-			return; 
+			return;
 			break;
 		case 4:
 			$urlpath = $a->get_path();
@@ -107,7 +107,7 @@ function get_db_errno() {
 		return mysqli_connect_errno();
 	else
 		return mysql_errno();
-}		
+}
 
 function install_content(&$a) {
 
@@ -115,9 +115,9 @@ function install_content(&$a) {
 	$o = '';
 	$wizard_status = "";
 	$install_title = t('Friendica Communications Server - Setup');
-	
 
-	
+
+
 	if(x($a->data,'db_conn_failed')) {
 		$install_wizard_pass = 2;
 		$wizard_status =  t('Could not connect to database.');
@@ -126,7 +126,7 @@ function install_content(&$a) {
 		$install_wizard_pass = 2;
 		$wizard_status =  t('Could not create table.');
 	}
-	
+
 	$db_return_text="";
 	if(x($a->data,'db_installed')) {
 		$txt = '<p style="font-size: 130%;">';
@@ -140,7 +140,7 @@ function install_content(&$a) {
 		$txt .= "<pre>".$a->data['db_failed'] . "</pre>". EOL ;
 		$db_return_text .= $txt;
 	}
-	
+
 	if($db && $db->connected) {
 		$r = q("SELECT COUNT(*) as `total` FROM `user`");
 		if($r && count($r) && $r[0]['total']) {
@@ -157,7 +157,7 @@ function install_content(&$a) {
 	if(x($a->data,'txt') && strlen($a->data['txt'])) {
 		$db_return_text .= manual_config($a);
 	}
-	
+
 	if ($db_return_text!="") {
 		$tpl = get_markup_template('install.tpl');
 		return replace_macros($tpl, array(
@@ -166,7 +166,7 @@ function install_content(&$a) {
 			'$text' => $db_return_text . what_next(),
 		));
 	}
-	
+
 	switch ($install_wizard_pass){
 		case 1: { // System check
 
@@ -180,21 +180,21 @@ function install_content(&$a) {
 			check_smarty3($checks);
 
 			check_keys($checks);
-			
+
 			if(x($_POST,'phpath'))
 				$phpath = notags(trim($_POST['phpath']));
 
 			check_php($phpath, $checks);
 
             check_htaccess($checks);
-            
+
 			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');
@@ -211,7 +211,7 @@ function install_content(&$a) {
 			));
 			return $o;
 		}; break;
-		
+
 		case 2: { // Database config
 
 			$dbhost = ((x($_POST,'dbhost')) ? notags(trim($_POST['dbhost'])) : 'localhost');
@@ -219,7 +219,7 @@ function install_content(&$a) {
 			$dbpass = notags(trim($_POST['dbpass']));
 			$dbdata = notags(trim($_POST['dbdata']));
 			$phpath = notags(trim($_POST['phpath']));
-			
+
 
 			$tpl = get_markup_template('install_db.tpl');
 			$o .= replace_macros($tpl, array(
@@ -230,23 +230,23 @@ function install_content(&$a) {
 				'$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;
@@ -257,38 +257,38 @@ function install_content(&$a) {
 			$dbpass = notags(trim($_POST['dbpass']));
 			$dbdata = notags(trim($_POST['dbdata']));
 			$phpath = notags(trim($_POST['phpath']));
-			
+
 			$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, 
+				'$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;
-			
+
 	}
 }
 
@@ -327,9 +327,9 @@ function check_php(&$phpath, &$checks) {
 		));
 		$phpath="";
 	}
-	
+
 	check_add($checks, t('Command line PHP').($passed?" (<tt>$phpath</tt>)":""), $passed, false, $help);
-	
+
 	if($passed) {
 		$cmd = "$phpath -v";
 		$result = trim(shell_exec($cmd));
@@ -342,8 +342,8 @@ function check_php(&$phpath, &$checks) {
 		}
 		check_add($checks, t('PHP cli binary'), $passed2, true, $help);
 	}
-	
+
-	
+
 	if($passed2) {
 		$str = autoname(8);
 		$cmd = "$phpath testargs.php $str";
@@ -356,7 +356,7 @@ function check_php(&$phpath, &$checks) {
 		}
 		check_add($checks, t('PHP register_argc_argv'), $passed3, true, $help);
 	}
-	
+
 
 }
 
@@ -366,7 +366,7 @@ function check_keys(&$checks) {
 
 	$res = false;
 
-	if(function_exists('openssl_pkey_new')) 
+	if(function_exists('openssl_pkey_new'))
 		$res=openssl_pkey_new(array(
 		'digest_alg' => 'sha1',
 		'private_key_bits' => 4096,
@@ -390,8 +390,8 @@ function check_funcs(&$checks) {
 	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('Apache mod_rewrite module'), false, true, t('Error: Apache webserver mod-rewrite module is required but not installed.'));
@@ -420,9 +420,9 @@ function check_funcs(&$checks) {
 		$ck_funcs[4]['status']= false;
 		$ck_funcs[4]['help']= t('Error: mb_string PHP module required but not installed.');
 	}
-	
+
 	$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);*/
 }
@@ -433,14 +433,14 @@ function check_htconfig(&$checks) {
 	$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('At the end of this procedure, we will give you a text to save in a file named .htconfig.php in your Friendica top folder.').EOL;
-		$help .= t('You can alternatively skip this procedure and perform a manual installation. Please see the file "INSTALL.txt" for instructions.').EOL; 
+		$help .= t('You can alternatively skip this procedure and perform a manual installation. Please see the file "INSTALL.txt" for instructions.').EOL;
 	}
-    
+
 	check_add($checks, t('.htconfig.php is writable'), $status, false, $help);
 
 }
@@ -449,14 +449,14 @@ function check_smarty3(&$checks) {
 	$status = true;
 	$help = "";
 	if(	!is_writable('view/smarty3') ) {
-	
+
 		$status=false;
 		$help = t('Friendica uses the Smarty3 template engine to render its web views. Smarty3 compiles templates to PHP to speed up rendering.') .EOL;
 		$help .= t('In order to store these compiled templates, the web server needs to have write access to the directory view/smarty3/ under the Friendica top level folder.').EOL;
 		$help .= t('Please ensure that the user that your web server runs as (e.g. www-data) has write access to this folder.').EOL;
-		$help .= t('Note: as a security measure, you should give the web server write access to view/smarty3/ only--not the template files (.tpl) that it contains.').EOL; 
+		$help .= t('Note: as a security measure, you should give the web server write access to view/smarty3/ only--not the template files (.tpl) that it contains.').EOL;
 	}
-    
+
 	check_add($checks, t('view/smarty3 is writable'), $status, true, $help);
 
 }
@@ -471,14 +471,14 @@ function check_htaccess(&$checks) {
             $status = false;
             $help = t('Url rewrite in .htaccess is not working. Check your server configuration.');
         }
-        check_add($checks, t('Url rewrite is working'), $status, true, $help); 
+        check_add($checks, t('Url rewrite is working'), $status, true, $help);
     } else {
         // cannot check modrewrite if libcurl is not installed
     }
-	
+
 }
 
-	
+
 function manual_config(&$a) {
 	$data = htmlentities($a->data['txt'],ENT_COMPAT,'UTF-8');
 	$o = t('The database configuration file ".htconfig.php" could not be written. Please use the enclosed text to create a configuration file in your web server root.');
@@ -498,27 +498,31 @@ function load_database_rem($v, $i){
 
 function load_database($db) {
 
-	$str = file_get_contents('database.sql');
+	require_once("include/dbstructure.php");
+	$errors = update_structure(false, true);
+
+/*	$str = file_get_contents('database.sql');
 	$arr = explode(';',$str);
 	$errors = false;
 	foreach($arr as $a) {
-		if(strlen(trim($a))) {	
+		if(strlen(trim($a))) {
 			$r = @$db->q(trim($a));
 			if(false === $r) {
 				$errors .=  t('Errors encountered creating database tables.') . $a . EOL;
 			}
 		}
-	}
+	}*/
+
 	return $errors;
 }
 
 function what_next() {
 	$a = get_app();
 	$baseurl = $a->get_baseurl();
-	return 
+	return
 		t('<h1>What next</h1>')
 		."<p>".t('IMPORTANT: You will need to [manually] setup a scheduled task for the poller.')
-		.t('Please see the file "INSTALL.txt".')			
+		.t('Please see the file "INSTALL.txt".')
 		."</p><p>"
 		.t("Go to your new Friendica node <a href='$baseurl/register'>registration page</a> and register as new user. Remember to use the same email you have entered as administrator email. This will allow you to enter the site admin panel.")
 		."</p>";

update.php

@@ -10,26 +10,25 @@ define( 'UPDATE_VERSION' , 1170 );
  * copying the latest files from the source code repository will always perform a clean
  * and painless upgrade.
  *
- * Each function in this file is named update_nnnn() where nnnn is an increasing number 
+ * Each function in this file is named update_nnnn() where nnnn is an increasing number
  * which began counting at 1000.
- * 
+ *
  * At the top of the file "boot.php" is a define for DB_UPDATE_VERSION. Any time there is a change
  * to the database schema or one which requires an upgrade path from the existing application,
  * the DB_UPDATE_VERSION and the UPDATE_VERSION at the top of this file are incremented.
  *
  * The current DB_UPDATE_VERSION is stored in the config area of the database. If the application starts up
- * and DB_UPDATE_VERSION is greater than the last stored build number, we will process every update function 
+ * and DB_UPDATE_VERSION is greater than the last stored build number, we will process every update function
- * in order from the currently stored value to the new DB_UPDATE_VERSION. This is expected to bring the system 
+ * in order from the currently stored value to the new DB_UPDATE_VERSION. This is expected to bring the system
  * up to current without requiring re-installation or manual intervention.
  *
  * Once the upgrade functions have completed, the current DB_UPDATE_VERSION is stored as the current value.
- * The DB_UPDATE_VERSION will always be one greater than the last numbered script in this file. 
+ * The DB_UPDATE_VERSION will always be one greater than the last numbered script in this file.
  *
  * If you change the database schema, the following are required:
- *    1. Update the file database.sql to match the new schema.
+ *    1. Update the file include/dbstructure.php to match the new schema.
- *    2. Update this file by adding a new function at the end with the number of the current DB_UPDATE_VERSION.
+ *    2. If there is a need for a post procession, update this file by adding a new function at the end with the number of the current DB_UPDATE_VERSION.
- *       This function should modify the current database schema and perform any other steps necessary
+ *       This function should perform some post procession steps but no database updates.
- *       to ensure that upgrade is silent and free from requiring interaction.
  *    3. Increment the DB_UPDATE_VERSION in boot.php *AND* the UPDATE_VERSION in this file to match it
  *    4. TEST the upgrade prior to checkin and filing a pull request.
  *