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

  Copyright (c) 2005-10 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.6.0
  // May 25, 2010 - Stefan Tomic, Original Version

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


$versionInfo = 'v1.6.0';

print "\n\n------------------ ENSEMBLE UPDATE: MAY 25, 2010, $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 = "It is also imperative that you have applied the previous update (upgrade_v1.5.2_2009Nov18.php)\n".
  "before proceeding. 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";

//Exit if english.php doesn't exist
//We need at least this file in order for the new language
//feature of Ensemble to work
if(!is_file($ensroot . "/include/languages/english.php")) {
	print "Could not find " . $ensroot . "/include/languages/english.php\n";
	print "Your Ensemble scripts may be out of date.\n";
	print "Exiting this upgrade script.\n";
}

//if header_footer_audio directory wasn't created (via svn)
//then we can try and create it now
if(!is_dir($ensroot . "/form_processing/header_footer_audio")) {

	$mkdirSuccess = mkdir($ensroot . "/form_processing/header_footer_audio");
	if($mkdirSuccess) {
		print "Created directory " .$ensroot . "/form_processing/header_footer_audio\n";
	}
	else {
		print "Could not create directory " .$ensroot . "/form_processing/header_footer_audio\n";
		print "Exiting upgrade script.\n";
		die();
	}
}

//if question_audio directory wasn't created (via svn)
//then we can try and create it now
if(!is_dir($ensroot . "/form_processing/question_audio")) {

	$mkdirSuccess = mkdir($ensroot . "/form_processing/question_audio");
	if($mkdirSuccess) {
		print "Created directory " .$ensroot . "/form_processing/question_audio\n";
	}
	else {
		print "Could not create directory " .$ensroot . "/form_processing/question_audio\n";
		print "Exiting upgrade script.\n";
		die();
	}
}

//set appropriate permissions on audio directories
print "Attempting to set group write privileges on audio directories:\n";
print "If submission of question audio files isn't working properly, review the permissions on these directories:\n";
print $ensroot . "/form_processing/header_footer_audio\n";
print $ensroot . "/form_processing/question_audio\n\n";
print "The webserver user (e.g. apache) should have write access to these directories.\n";
chmod($ensroot . "/form_processing/question_audio",0775);
chmod($ensroot . "/form_processing/header_footer_audio",0775);

//if Ensemble is still using the old subject ID form handlers, quit this upgrade script
//and throw a warning. The old subject ID form handlers are now no longer supported
$sql_get_form_handlers = "select form_handler from experiment_x_form where form_handler = 'form_subject_id.php' or form_handler = 'form_subect_id_with_validation.php'";
$get_form_handlers = mysql_query($sql_get_form_handlers) or die(mysql_error());
if(mysql_num_rows($get_form_handlers) > 0) {
	print "It appears that the old subject ID form handler(s) 'form_subject_id.php' and/or 'form_subect_id_with_validation.php' \n";
	print "are in use. These form handlers are no longer supported. Please reconfigure your experiments to use one of the newer \n";
	print "form handlers (e.g. form_subject_register.php). Then rerun the upgrade script. This upgrade script will exit now without\n";
	print "performing any changes.\n";
	die();
}


$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.5.3") == 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.6.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.6.0");
	}
	elseif(compareVersionStrings($ENSEMBLE_VERSION,"1.5.3") < 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.5.3 in order to run this script.\n";
		print "Exiting the upgrade script now.\n";
		die();
	}
	elseif(compareVersionStrings($ENSEMBLE_VERSION,"1.6.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.5.3 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

//Add $DEFAULT_LANGUAGE variable to variables_config.php if it doesn't already exist
if(!variableInFile("DEFAULT_LANGUAGE",$variables_config_path)) {
    
    changeConfigFile($variables_config_path,"DEFAULT_LANGUAGE","english");
}

//DATABASE UPDATES

//convert experiment.language field from an enum to a varchar field
$sql_alter_tbl = "ALTER TABLE  `experiment` CHANGE  `language`  `language` VARCHAR( 30 ) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL DEFAULT  'english'";
print "\nperforming query: " .$sql_alter_tbl."\n\n";
mysql_query($sql_alter_tbl) or die(mysql_error());

//add play_question_audio and encrypted_response_table fields to experiment table
if(!fieldInTable('play_question_audio','experiment') && !fieldInTable('encrypted_response_table','experiment')) {
    $sql_alter_tbl = "ALTER TABLE  `experiment` ADD  `play_question_audio` ENUM(  'T',  'F' ) NOT NULL DEFAULT  'F' AFTER  `language` , ".
	"ADD  `encrypted_response_table` ENUM(  'T',  'F' ) NOT NULL DEFAULT  'F' AFTER  `play_question_audio`";
    print "performing query: " .$sql_alter_tbl."\n\n";
    mysql_query($sql_alter_tbl) or die(mysql_error());
 }
//convert form_handler field from an enum to a varchar(50) 
$sql_alter_tbl = "ALTER TABLE  `experiment_x_form` CHANGE  `form_handler`  `form_handler` VARCHAR( 50 ) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL";
    mysql_query($sql_alter_tbl) or die(mysql_error());

//add header_audio_path and footer_audio_path to form table
if(!fieldInTable('header_audio_path','form') && !fieldInTable('footer_audio_path','form')) {
    $sql_alter_tbl = "ALTER TABLE  `form` ADD  `header_audio_path` VARCHAR( 50 ) NULL DEFAULT NULL AFTER  `footer` , ".
	"ADD  `footer_audio_path` VARCHAR( 50 ) NULL DEFAULT NULL AFTER  `header_audio_path`";
    print "performing query: " .$sql_alter_tbl."\n\n";
    mysql_query($sql_alter_tbl) or die(mysql_error());
 }

//add audio_path to question_x_data_format
if(!fieldInTable('audio_path','question_x_data_format')) {
    $sql_alter_tbl = "ALTER TABLE  `question_x_data_format` ADD  `audio_path` VARCHAR( 50 ) NULL DEFAULT NULL AFTER  `html_field_type`";
    print "performing query: " .$sql_alter_tbl."\n\n";
    mysql_query($sql_alter_tbl) or die(mysql_error());
 }

//add passphrase, security_questions, and security_responses fields to subject table
if(!fieldInTable('passphrase','subject') && !fieldInTable('security_questions','subject') && !fieldInTable('security_responses','subject')) {
    $sql_alter_tbl = "ALTER TABLE  `subject` ADD  `passphrase` BLOB NULL DEFAULT NULL AFTER  `name_suffix` , ".
	"ADD  `security_questions` TEXT NULL DEFAULT NULL AFTER  `passphrase` , ".
	"ADD  `security_responses` BLOB NULL DEFAULT NULL AFTER  `security_questions` ";
    print "performing query: " .$sql_alter_tbl."\n\n";
    mysql_query($sql_alter_tbl) or die(mysql_error());
 }

//add county field to subject table
if(!fieldInTable('county','subject')) {
    $sql_alter_tbl = "ALTER TABLE  `subject` ADD  `county` BLOB NULL DEFAULT NULL AFTER  `city`";
    print "performing query: " .$sql_alter_tbl."\n\n";
    mysql_query($sql_alter_tbl) or die(mysql_error());
 }

//retrieve the names of all response tables and add the "decline" field to each of them
$sql_get_response_tables = "select response_table from experiment";
$get_response_tables = mysql_query($sql_get_response_tables) or die(mysql_error());
while($row_response_tables = mysql_fetch_assoc($get_response_tables)) {
	$resp_table = $row_response_tables['response_table'];

	$sql_check_table_exist = sprintf("show tables like '%s'",$resp_table);
	$check_table_exist = mysql_query($sql_check_table_exist) or die(mysql_error());
	if(mysql_num_rows($check_table_exist) == 0) {
	    printf("WARNING: Table %s doesn't exist. However, it is specified in the response_table field in the experiment table.\n",$resp_table);
	    print "Ignoring this table name and continuing with the update. You may want to review the response_table\n";
	    print "values in the experiment table for data integrity.\n\n";
	    continue;
	}

	if(!fieldInTable('decline',$resp_table)) {
	    $sql_alter_tbl = sprintf("ALTER TABLE  `%s` ADD  `decline` ENUM(  'T',  'F' ) NOT NULL DEFAULT  'F'",$resp_table);
	    print "performing query: " .$sql_alter_tbl."\n\n";
	    mysql_query($sql_alter_tbl) or die(mysql_error());
	}
}


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

?>