<?
/*********************************************************************************************************
  "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.

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

Author(s):
9/9/09 - Fred Barrett - Original blocks of code taken from update_20090909.php
9/28/09 - Stefan Tomic, copied code to this file, encapsulated into functions, reorganized logic for implementation into functions

*/


function upgrade_warning($addToWarning = "") {
  print "WARNING!!! WARNING!!! WARNING!!!\n";
  print "If you are maintaining your ensemble web root as an active checked-out copy of \n";
  print "the svn repository, please make sure you have run 'svn update' on the ensemble \n";
  print "root level before running this script. If you are not maintaining your ensemble\n";
  print "installation with svn, make sure that you have downloaded the complete \n";
  print "distribution for this Ensemble version, and have updated the appropriate files.\n\n";
  print "Also make sure that you have read the release notes for this version and are aware\n";
  print "of all changes that this script will make.\n\n";
  print "As always, make sure that you have a backup of all files under your Ensemble root\n"; 
  print "directory (especially config files or form handlers that are not controlled by svn)\n";
  print "and that you have backed up your database before running this update.\n";
  print "Although this script may back up your database and/or files, it is crucial\n";
  print "that you perform your own backups and that you verify them.\n\n";

  print $addToWarning;
  print("Continue ");
  if(!userConfirm())
    die();
}

function userConfirm() {

  $validInput = false;
  while (!$validInput) {
    print "(y/n)? ";
    $input = trim(fgets(STDIN,256));
    if(!preg_match("|[nNyY]|",$input))
      continue;
    else
      $validInput = true;
  }
  if (preg_match("|[yY]|",$input)) 
    return(true);
  else
    return(false);

}

function deleteDirectory($dir) {
  if (!file_exists($dir)) return true;
  if (!is_dir($dir)) return unlink($dir);
  foreach (scandir($dir) as $item) {
    if ($item == '.' || $item == '..') continue;
    if (!deleteDirectory($dir.DIRECTORY_SEPARATOR.$item)) return false;
  }
  return rmdir($dir);
}


//prompts user for an input, setting to
//the default value if enter or return is pressed
//if default is blank, will continue prompting until
//input is given
function getUserInput($defaultVal) {
  
  printf("[%s]: ",$defaultVal);
  $input = "";
  while(empty($input)) {
    $input = trim(fgets(STDIN,256));
    if(empty($input))
      $input = $defaultVal;
  }
  return($input);

}

function checkDirectoryInput($dirName)
{
  printf("[%s]: ",$dirName);
  $continue=0;
  while (!$continue) {
    $input = trim(fgets(STDIN,256));
    if ($input == NULL) {
      $continue=1;
    } else {
      if (is_dir($input)) {
	$dirName = $input;
	$continue=1;
      } else {
	print "\ndirectory $input not found\n";
      }
    }
  }

  // remove trailing slash if present
  $slash_pos = strrpos($dirName,"/");
  if ($slash_pos == (strlen($dirName)-1)) {
    $dirName = substr($dirName,0,strlen($dirName)-1);
  }

  return $dirName;
}


function mysqlConn() {

  global $MYSQL_HOSTNAME;
  global $DATABASE_NAME;
  global $validDB;

  // get username with ALTER TABLE privileges
  print "Please provide a mysql username with all DATA and STRUCTURE manipulation privileges\n";
  print "on the ensemble database (you can use root)\n";
  $continue=0;
  while (!$continue) {
    print "username: ";
    $muser=trim(fgets(STDIN,256));
    if ($muser != NULL) {
      $continue=1;
    }
  }
  
  // get password
  print "Please provide the mysql password for $muser\n";
  $continue=0;
  while (!$continue) {
    print "password: ";
    system('stty -echo');
    $mpass=trim(fgets(STDIN,256));
    system('stty echo');
    if ($mpass != NULL) {
      $continue=1;
    }
  }
  
  // get username with ALTER TABLE privileges
  print "Please provide the hostname of your mysql server:\n";
  $mhost = "";
  while(empty($mhost)) {
	printf("[%s]: ",$MYSQL_HOSTNAME);
	$mhost=trim(fgets(STDIN,256));
	if ($mhost == NULL) { 
	  $mhost = $MYSQL_HOSTNAME;
	}
  }

  print "Please provide the database name of your ensemble installation:\n";
  $dbName = "";
  while(empty($dbName)) {
    printf("[%s]:",$DATABASE_NAME);
    $dbName = trim(fgets(STDIN,256));
    if($dbName == NULL) 
      $dbName = $DATABASE_NAME;
  }

  // connect to the server, use the `information_schema` table
  $dbConn = mysql_connect($mhost,$muser,$mpass) or trigger_error(mysql_error(),E_USER_ERROR);
  $validDB = mysql_select_db($dbName,$dbConn);
  mysql_query("SET NAMES 'utf8'",$dbConn) or error_condition(mysql_error());

  return array($dbConn,$dbName,$muser,$mpass,$mhost);

}

function backupDB($backupPath,$versionTag = "",$tableName = "",$verbose = 1) {

  global $muser,$mpass,$mhost,$dbName;

  $versionTag = (!empty($versionTag))? "_". $versionTag ."_" : "";
  if($verbose) {
    print "\nBACKING UP THE " . $dbName . " DATABASE";
    print (!empty($tableName))? ", $tableName TABLE\n" : "\n";
  }
  $tableTag = (!empty($tableName))? "_TABLE_" . $tableName : "";
  $backupfpath =$backupPath . "/" . $dbName . $tableTag . $versionTag . date('YMd') .".sql";
  $backupOptions = "-Qau $muser -p'$mpass' -h $mhost ";
  $tableOptions = (!empty($tableName))? " --tables " . $tableName . " " : "" ;
  $backupcmd = "mysqldump " . $backupOptions. $dbName . $tableOptions . " > $backupfpath";
  
  exec($backupcmd,$o,$bcstatus);
  if ($bcstatus) {
    error_condition("could not backup database to $backupfpath");
  }
  if($verbose) {
    print (!empty($tableName))? "table $tableName " : "database ";
    print "backed up to $backupfpath\n";
  }
  return $backupfpath;
}

// function error condition:
// if a function called "rollback" is defined in the upgrade script
// it calls it (note that rollback doesn't take any input args).
// if rollback is not defined, it outputs whatever error message was passed
// to it and dies
function error_condition($message = "") {
  
  if(function_exists('rollback')) {
    print "\nERROR : " . $message ."\n";
    rollback();
  }
  else {
    die('ERROR: ' . $message);
  }
    
}

function fieldInTable($fieldname,$tablename) {

    $sql_check_field = sprintf("describe %s %s",$tablename,$fieldname);
    $check_field = mysql_query($sql_check_field) or die(mysql_error());

    if(mysql_num_rows($check_field) > 0)
	return TRUE;
    else
	return FALSE;
}

//returns true if the variable is being assigned in the config file
//otherwise returns false.
//The variable should be specified without the $ symbol
function variableInFile($varname,$vcpath) {

 //assign the contents of the file to an array of strings (one string for each line)
  $contentArray = file($vcpath);
  
  //the regular expression pattern to check if the variable already exists
  $pattern = sprintf("|[[:space:]]*\\$%s[[:space:]]*=.*|",$varname);
  
  $nLines = count($contentArray);

  for($iLine = 0;$iLine < $nLines; $iLine++) {
      $lineContent = $contentArray[$iLine];
    
      if(preg_match($pattern,$lineContent)) {
	  return TRUE;
      }
  }
  return FALSE;

}


// This function is useful for editing the variables_config.php file
// or $variables.php. 
// Basically, it sees if the variable is being set in the config file.
// If it is, it replaces the line by setting the variable to a new value.
// Optionally, it can prompt the user whether or not to perform the replacement.
// If the variable does not exist, it appends the variable to the end of the config file.
//$vcpath = path to variables_config.php
//$varname = the variable name to change/add
//$value = the value to set $varname to
//$warnBeforeReplace = whether or not to warn before replacing a value (default = true)
//NEW FEATURE (11/16/09 S.T.):
//Addition of "code" datattype 
//Code datatype allows the insertion of new code to config files e.g. include('filepath')
//Pass the code to $varname, pass blank string to $value, and set $dataType="code" 
//to use this feature
//NEW FEATURE (11/16/09 S.T.):
//In order to remove a variable, use "<REMOVE>" as the $value
function changeConfigFile($vcpath,$varname,$value,$warnBeforeReplace = true,$dataType = "string") {

  print "\n\nEDITING $vcpath:\n\n";

  //assign the contents of the file to an array of strings (one string for each line)
  $contentArray = file($vcpath);
  
  if(strcmp($dataType,"code") != 0) {
    //the regular expression pattern to check if the variable already exists
    $pattern = sprintf("|[[:space:]]*\\$%s[[:space:]]*=.*|",$varname);
  }
  else {
    $pattern = "|[[:space:]]*".preg_quote($varname)."[[:space:]]*|";
  }

  if(!(strcmp($value,"<REMOVE>") == 0)) {
    //the content to add or replace in the file
    switch($dataType) {
    case "string":
      $newContent = sprintf("$%s='%s';",$varname,$value);
      break;
    case "integer":
    case "double":
      $newContent = sprintf("$%s=%d;",$varname,$value);
      break;
    case "code":
      $newContent = $varname;
      break;
    default:
      error_condition(sprintf("function addVarToConfig, data type %s not recognized",$dataType));
    }
 
    //$addContent flags whether or not to add content to the end of the file
    $addContent = true;
 }
  else {
    $addContent = false;
    $newContent = "";
  }
    
  $nLines = count($contentArray);
  
 
  //$replaceContent flags whether or not the content was replaced
  $replaceContent = false;

  //loop over every line to try and find a match for the pattern
  for($iLine = 0;$iLine < $nLines; $iLine++) {
    $lineContent = $contentArray[$iLine];
    
    if(preg_match($pattern,$lineContent)) {
      //if a match was found, do not add anything to end of file
      $addContent = false;

      //prompt first to see if user wants to replace the content
      if($warnBeforeReplace) {
	print "Found Line: $lineContent";
	print "Replace with: $newContent\n";
	$replaceConfirm = userConfirm();
	
      }
      else
	$replaceConfirm = true;

      if($replaceConfirm) {
	$replaceContent = true;
	$contentArray[$iLine] = $newContent."\n\n";
	break;
      }

    } //if preg_match
  
  } //for

  //if a match was found, $addContent should be false
  if($addContent) {
    print "Adding $newContent to the end of the file\n";
    
    //pop from the end of contentArray until we find php end tag
    $popContent = "";
    while(!preg_match("|.*\?\>|",$popContent))
      $popContent = array_pop($contentArray);
  array_push($contentArray,$newContent."\n\n");
  array_push($contentArray,"?>");
  }
  
  //if we are either adding content, or replacing content
  //then rewrite the file. Otherwise, leave it alone
  if($addContent || $replaceContent) {
    $contentString = implode("",$contentArray);
    if (!file_put_contents($vcpath,$contentString)) {
      error_condition("ERROR writing to $vcpath\n\n");
    }
    print "Done editing $vcpath\n";
  }
 else {
   print "Leaving file $vcpath alone.\nMake sure the variables in this file are correct.\n\n";
 }
  
}


?>