<?php
/*********************************************************************************************************
  "Ensemble" is the proprietary property of The Regents of the University of California ("The Regents.")

  Copyright (c) 2005-14 The Regents of the University of California, Davis campus. All Rights Reserved.

  Redistribution and use in source and binary forms, with or without modification, are permitted by
  nonprofit, research institutions for research use only, provided the conditions in the included
  license agreement are met.

  Refer to the file "ensemble_license.txt" for the license agreement,
  located in the top level directory of this distribution.

**********************************************************************************************************/

  // ENSEMBLE UPGRADE -- v 1.7.0
  // June 20, 2014 - Jeff Rector, Original Version

include_once('../../include/variables.php');
include_once('../../include/functions.php');
include_once('./upgrade_functions.php');


$versionInfo = 'v1.7.0';
$versionDate = 'June 20, 2014';

print "\n\n------------------ ENSEMBLE UPDATE: $versionDate, $versionInfo ----------------------\n";
print "--------------------------------------------------------------------------------\n\n";

function rollback() {

    print "\nTHIS SCRIPT CANNOT ROLLBACK ANY CHANGES IT MAY HAVE MADE.\n";
    print "You should inspect your scripts and database and recover them from a backup, if necessary.\n";
    print "A database backup should have been performed at the beginning of this script, or you may recover from your own backup.\n";
  
  die();
  
}

/*********************************************************************************************************
   PREPARE UPGRADE
   Obtain ensemble root path, establish database connection, backup database
*/


// initialize variables and lists for the upgrade
$ensroot = $ENSEMBLE_QEI_QPI_DIR;
$svn_public_path = 'https://atonal.ucdavis.edu/repos/public';
$svn_formprocess = $svn_public_path.'/ensemble/release/v1/form_processing';


// print standard upgrade warnings and provide option to exit script
$addToWarning = "You should run this script as \"root\" user.\n\n";

upgrade_warning($addToWarning);

print "\n\nENSEMBLE INSTALLATION ROOT DIRECTORY\n";
print "\nWhere is your ensemble installation located?\n";
$ensroot = checkDirectoryInput($ensroot);


print "\n\nESTABLISHING DATABASE CONNECTION\n\n";

list($dbConn,$dbName,$muser,$mpass,$mhost) = mysqlConn();

/********************************************************************************************************/
//PERFORM A SERIES OF CHECKS TO MAKE SURE THAT FILES AND VARIABLES ARE WHERE THEY SHOULD BE

$variables_config_path = $ensroot . "/include/variables_config.php";
$variables_path =  $ensroot . "/include/variables.php";

$versionInfoFile = $ensroot."/include/version_info.php";
if(!file_exists($versionInfoFile)) {
	print "\n\nFile $versionInfoFile does not exist.\n";
	print "Make sure you have the most recent Ensemble distribution.\n";
	print "If you are using svn, perform an svn update.\n";
	print "Exiting the upgrade script now.\n";
	die();
}
else {

	if(!function_exists('compareVersionStrings')) {
		print "Function \"compareVersionStrings\" doesn't exist in functions.php.\n";
		print "Your Ensemble distribution is probably not up to date.\n";
		print "Make sure that you have upgraded your Ensemble scripts to the latest version.\n";
		print "Exiting the upgrade script now.\n";
		die();
	}
	include($versionInfoFile);
	if(compareVersionStrings($ENSEMBLE_VERSION,"1.6.1") == 0) {
		print "WARNING: Your current Ensemble version appears to be ". $versionInfoFile . "\n";
		print "If you have properly updated your distribution with svn, the current version should be 1.7.0\n";
		print "You may have updated your Ensemble distribution without svn.\n";
		print "If this is the case, make sure all of your Ensemble scripts are up to date.\n";
		print "You may then proceed with this upgrade script.\n";
		print "If you are not sure whether your Ensemble scripts are up to date, then\n" . 
		print "do not update the Ensemble version info and quit the upgrade script now.\n";
		changeConfigFile($versionInfoFile,"ENSEMBLE_VERSION","1.7.0");
	}
	elseif(compareVersionStrings($ENSEMBLE_VERSION,"1.6.1") < 0) {
		print "Your current Ensemble version appears to be " . $ENSEMBLE_VERSION . "\n";
		print "This was reported by " . $versionInfoFile . "\n";
		print "Your Ensemble version must be at least 1.6.1 in order to run this script.\n";
		print "Exiting the upgrade script now.\n";
		die();
	}
	elseif(compareVersionStrings($ENSEMBLE_VERSION,"1.7.0") >= 0) {
		print "Current Ensemble version is " . $ENSEMBLE_VERSION . "\n";
		print "Proceeding with upgrade.\n";
	}
	else {
		print "Your Ensemble version could not be determined.\n";
		print "This is usually reported by " . $versionInfoFile . "\n";
		print "Your Ensemble version must be at least 1.7.0 in order to run this script.\n";
		print "Exiting the upgrade script now.\n";
		die();
	}

}

//END VERSION, FILE, AND DIRECTORY CHECKING
/********************************************************************************************************/
// BACKUP THE DATABASE

print "\nDirectory to save database backup ";
$backupDir = checkDirectoryInput($_ENV['HOME']);


$dbBackupFpath = backupDB($backupDir,$versionInfo);

/********************************************************************************************************/

//VARIABLE UPDATES


//DATABASE UPDATES

//add 'theme' enum to attribute classes
//first get existing class list and add theme if necessary
$sql_describe_enum = "show columns from `attribute` like 'class'";
$describe_enum = mysql_select($sql_describe_enum);
preg_match_all("/('.*?')/", $describe_enum['Type'], $enum_array);
$enum_fields = $enum_array[1];
if(!in_array("'theme'",$enum_fields))
  $enum_fields[] = "'theme'";
$sql_add_subject_group = sprintf("ALTER TABLE  `attribute` CHANGE  `class`  `class` ENUM( %s ) " .
				 "CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL DEFAULT  'stim_set'",
				 implode(',',$enum_fields));
print "\n\nSubmitting query:\n";
print $sql_add_subject_group . "\n\n";
mysql_query($sql_add_subject_group) or die(mysql_error());

print "DONE UPDATING!\n\n";
print "Please test your installation by verifying that old experiments still run\n";

?>