mirror of
https://github.com/OpenXE-org/OpenXE.git
synced 2024-12-25 14:10:28 +01:00
472 lines
16 KiB
PHP
472 lines
16 KiB
PHP
<?php
|
||
|
||
/*
|
||
* Upgrader using git for file upgrade and mustal to update the database definition
|
||
*
|
||
* Copyright (c) 2022 OpenXE project
|
||
*
|
||
*/
|
||
|
||
$upgrade_echo_out_file_name = "";
|
||
|
||
function upgrade_set_out_file_name(string $filename) {
|
||
|
||
GLOBAL $upgrade_echo_out_file_name;
|
||
|
||
$upgrade_echo_out_file_name = $filename;
|
||
}
|
||
|
||
function echo_out(string $text) {
|
||
|
||
GLOBAL $upgrade_echo_out_file_name;
|
||
|
||
if ($upgrade_echo_out_file_name == "") {
|
||
echo($text);
|
||
} else {
|
||
file_put_contents($upgrade_echo_out_file_name,$text, FILE_APPEND);
|
||
}
|
||
}
|
||
|
||
function echo_output(array $output) {
|
||
echo_out(implode("\n",$output)."\n");
|
||
}
|
||
|
||
function abort(string $message) {
|
||
echo_out($message."\n");
|
||
echo_out("--------------- Aborted! ---------------\n");
|
||
echo_out("--------------- ".date("Y-m-d H:i:s")." ---------------\n");
|
||
}
|
||
|
||
function git(string $command, &$output, bool $show_command, bool $show_output, string $error_text) : int {
|
||
$output = array();
|
||
if ($show_command) {
|
||
echo_out("git ".$command."\n");
|
||
}
|
||
exec("git ".$command,$output,$retval);
|
||
if (!empty($output)) {
|
||
if ($show_output || $retval != 0) {
|
||
echo_output($output);
|
||
}
|
||
}
|
||
if ($retval != 0) {
|
||
echo_out($error_text."\n");
|
||
}
|
||
return($retval);
|
||
}
|
||
|
||
// -------------------------------- START
|
||
|
||
// Check for correct call method
|
||
if (php_sapi_name() == "cli") {
|
||
|
||
$directory = getcwd();
|
||
if (basename($directory) != 'upgrade') {
|
||
abort("Must be executed from 'upgrade' directory.");
|
||
return(-1);
|
||
}
|
||
|
||
$check_git = false;
|
||
$do_git = false;
|
||
$check_db = false;
|
||
$do_db = false;
|
||
$do = false;
|
||
|
||
if ($argc > 1) {
|
||
|
||
if (in_array('-v', $argv)) {
|
||
$verbose = true;
|
||
} else {
|
||
$verbose = false;
|
||
}
|
||
|
||
if (in_array('-e', $argv)) {
|
||
$export_db = true;
|
||
} else {
|
||
$export_db = false;
|
||
}
|
||
|
||
if (in_array('-f', $argv)) {
|
||
$force = true;
|
||
} else {
|
||
$force = false;
|
||
}
|
||
|
||
if (in_array('-connection', $argv)) {
|
||
$connection = true;
|
||
} else {
|
||
$connection = false;
|
||
}
|
||
|
||
if (in_array('-s', $argv)) {
|
||
$check_git = true;
|
||
} else {
|
||
}
|
||
|
||
if (in_array('-db', $argv)) {
|
||
$check_db = true;
|
||
} else {
|
||
}
|
||
|
||
if (in_array('-do', $argv)) {
|
||
if (!$check_git && !$check_db) {
|
||
$do_git = true;
|
||
$do_db = true;
|
||
}
|
||
if ($check_git) {
|
||
$do_git = true;
|
||
}
|
||
if ($check_db) {
|
||
$do_db = true;
|
||
}
|
||
}
|
||
|
||
if ($check_git || $check_db || $do_git || $do_db) {
|
||
upgrade_main($directory,$verbose,$check_git,$do_git,$export_db,$check_db,$do_db,$force,$connection);
|
||
} else {
|
||
info();
|
||
}
|
||
|
||
} else {
|
||
info();
|
||
}
|
||
|
||
}
|
||
// -------------------------------- END
|
||
|
||
function upgrade_main(string $directory,bool $verbose, bool $check_git, bool $do_git, bool $export_db, bool $check_db, bool $do_db, bool $force, bool $connection) {
|
||
|
||
$mainfolder = dirname($directory);
|
||
$datafolder = $directory."/data";
|
||
$lockfile_name = $datafolder."/.in_progress.flag";
|
||
$remote_file_name = $datafolder."/remote.json";
|
||
$schema_file_name = "db_schema.json";
|
||
|
||
echo_out("--------------- OpenXE upgrade ---------------\n");
|
||
echo_out("--------------- ".date("Y-m-d H:i:s")." ---------------\n");
|
||
|
||
//require_once($directory.'/../cronjobs/githash.php');
|
||
|
||
$remote_info_contents = file_get_contents($remote_file_name);
|
||
if (!$remote_info_contents) {
|
||
abort("Unable to load $remote_file_name");
|
||
return(-1);
|
||
}
|
||
$remote_info = json_decode($remote_info_contents, true);
|
||
|
||
if ($check_git || $do_git) {
|
||
|
||
$retval = git("log HEAD", $output,$verbose,false,"");
|
||
// Not a git repository -> Create it and then go ahead
|
||
if ($retval == 128) {
|
||
if (!$do_git) {
|
||
abort("Git not initialized, use -do to initialize.");
|
||
return(-1);
|
||
}
|
||
|
||
echo_out("Setting up git...");
|
||
$retval = git("init ..", $output,$verbose,$verbose,"Error while initializing git!");
|
||
if ($retval != 0) {
|
||
abort("");
|
||
return(-1);
|
||
}
|
||
$retval = git("add ../.", $output,$verbose,$verbose,"Error while initializing git!");
|
||
if ($retval != 0) {
|
||
abort("");
|
||
return(-1);
|
||
}
|
||
$retval = git("fetch ".$remote_info['host']." ".$remote_info['branch'],$output,$verbose,$verbose,"Error while initializing git!");
|
||
if ($retval != 0) {
|
||
abort("");
|
||
return(-1);
|
||
}
|
||
|
||
$retval = git("checkout FETCH_HEAD -f", $output,$verbose,$verbose,"Error while initializing git!");
|
||
if ($retval != 0) {
|
||
abort("");
|
||
return(-1);
|
||
}
|
||
} else if ($retval != 0) {
|
||
abort("Error while executing git!");
|
||
return(-1);
|
||
}
|
||
|
||
// Get changed files on system -> Should be empty
|
||
$modified_files = false;
|
||
$output = array();
|
||
$retval = git("ls-files -m ..", $output,$verbose,false,"Error while checking Git status.");
|
||
if (!empty($output)) {
|
||
$modified_files = true;
|
||
echo_out("There are modified files:\n");
|
||
echo_output($output);
|
||
}
|
||
|
||
if ($verbose) {
|
||
echo_out("--------------- Upgrade history ---------------\n");
|
||
$retval = git("log --date=short-local --pretty=\"%cd (%h): %s\" HEAD --not HEAD~5",$output,$verbose,$verbose,"Error while showing history!");
|
||
if ($retval != 0) {
|
||
abort("");
|
||
return(-1);
|
||
}
|
||
} else {
|
||
echo_out("--------------- Current version ---------------\n");
|
||
$retval = git("log -1 --date=short-local --pretty=\"%cd (%h): %s\" HEAD",$output,$verbose,true,"Error while showing history!");
|
||
if ($retval != 0) {
|
||
return(-1);
|
||
}
|
||
}
|
||
|
||
if ($do_git) {
|
||
|
||
if ($modified_files && !$force) {
|
||
abort("Clear modified files or use -f");
|
||
return(-1);
|
||
}
|
||
|
||
echo_out("--------------- Pulling files... ---------------\n");
|
||
|
||
if ($force) {
|
||
$retval = git("reset --hard",$output,$verbose,$verbose,"Error while resetting modified files!");
|
||
if ($retval != 0) {
|
||
abort("");
|
||
return(-1);
|
||
}
|
||
}
|
||
|
||
$retval = git("pull ".$remote_info['host']." ".$remote_info['branch'],$output,$verbose,$verbose,"Error while pulling files!");
|
||
if ($retval != 0) {
|
||
abort("");
|
||
return(-1);
|
||
}
|
||
|
||
$retval = git("reset --hard",$output,$verbose,$verbose,"Error while applying files!");
|
||
if ($retval != 0) {
|
||
abort("");
|
||
return(-1);
|
||
}
|
||
|
||
echo_out("--------------- Files upgrade completed ---------------\n");
|
||
$retval = git("log -1 ",$output,$verbose,$verbose,"Error while checking files!");
|
||
if ($retval != 0) {
|
||
abort("");
|
||
return(-1);
|
||
}
|
||
echo_output($output);
|
||
} // $do_git
|
||
else { // Dry run
|
||
echo_out("--------------- Dry run, use -do to upgrade ---------------\n");
|
||
echo_out("--------------- Fetching files... ---------------\n");
|
||
|
||
$retval = git("fetch ".$remote_info['host']." ".$remote_info['branch'],$output,$verbose,$verbose,"Error while fetching files!");
|
||
if ($retval != 0) {
|
||
abort("");
|
||
}
|
||
|
||
echo_out("--------------- Pending upgrades: ---------------\n");
|
||
|
||
$retval = git("log --date=short-local --pretty=\"%cd (%h): %s\" FETCH_HEAD --not HEAD",$output,$verbose,true,"Error while fetching files!");
|
||
if (empty($output)) {
|
||
echo_out("No upgrades pending.\n");
|
||
}
|
||
if ($retval != 0) {
|
||
abort("");
|
||
}
|
||
} // Dry run
|
||
} // $check_git
|
||
|
||
if ($check_db || $do_db || $export_db) {
|
||
|
||
if ($connection) {
|
||
$connection_file_name = $directory."/data/connection.json";
|
||
$connection_file_contents = file_get_contents($connection_file_name);
|
||
if (!$connection_file_contents) {
|
||
abort("Unable to load $connection_file_name");
|
||
return(-1);
|
||
}
|
||
$connection_info = json_decode($connection_file_contents, true);
|
||
|
||
$host = $connection_info['host'];
|
||
$user = $connection_info['user'];
|
||
$passwd = $connection_info['passwd'];
|
||
$schema = $connection_info['schema'];
|
||
|
||
} else {
|
||
|
||
class DatabaseConnectionInfo {
|
||
function __construct($dir) {
|
||
require($dir."/../conf/user.inc.php");
|
||
}
|
||
}
|
||
|
||
$dbci = new DatabaseConnectionInfo($directory);
|
||
|
||
$host = $dbci->WFdbhost;
|
||
$user = $dbci->WFdbuser;
|
||
$passwd = $dbci->WFdbpass;
|
||
$schema = $dbci->WFdbname;
|
||
}
|
||
|
||
require_once($directory.'/../vendor/mustal/mustal_mysql_upgrade_tool.php');
|
||
|
||
echo_out("--------------- Loading from database '$schema@$host'... ---------------\n");
|
||
$db_def = mustal_load_tables_from_db($host, $schema, $user, $passwd, $mustal_replacers);
|
||
|
||
if (empty($db_def)) {
|
||
echo_out("Could not load from $schema@$host\n");
|
||
exit;
|
||
}
|
||
|
||
if ($export_db) {
|
||
$export_file_name = "exported_db_schema.json";
|
||
if (mustal_save_tables_to_json($db_def, $datafolder, $export_file_name, true) == 0) {
|
||
echo_out("Database exported to $datafolder/$export_file_name\n");
|
||
}
|
||
else {
|
||
echo_out("Could not export database to $datafolder/$export_file_name\n");
|
||
}
|
||
}
|
||
|
||
$compare_differences = array();
|
||
|
||
echo_out("--------------- Loading from JSON... ---------------\n");
|
||
$compare_def = mustal_load_tables_from_json($datafolder, $schema_file_name);
|
||
|
||
if (empty($compare_def)) {
|
||
abort("Could not load from JSON $schema_file_name\n");
|
||
return(-1);
|
||
}
|
||
echo_out("Table count database ".count($db_def['tables'])." vs. JSON ".count($compare_def['tables'])."\n");
|
||
echo_out("--------------- Comparing JSON '".$compare_def['database']."@".$compare_def['host']."' vs. database '$schema@$host' ---------------\n");
|
||
$compare_differences = mustal_compare_table_array($db_def,"in DB",$compare_def,"in JSON",false,true);
|
||
if ($verbose) {
|
||
foreach ($compare_differences as $compare_difference) {
|
||
$comma = "";
|
||
foreach ($compare_difference as $key => $value) {
|
||
echo_out($comma."$key => [$value]");
|
||
$comma = ", ";
|
||
}
|
||
echo_out("\n");
|
||
}
|
||
}
|
||
echo_out((empty($compare_differences)?0:count($compare_differences))." differences.\n");
|
||
|
||
echo_out("--------------- Comparing database '$schema@$host' vs. JSON '".$compare_def['database']."@".$compare_def['host']."' ---------------\n");
|
||
$compare_differences = mustal_compare_table_array($compare_def,"in JSON",$db_def,"in DB",true,true);
|
||
if ($verbose) {
|
||
foreach ($compare_differences as $compare_difference) {
|
||
$comma = "";
|
||
foreach ($compare_difference as $key => $value) {
|
||
echo_out($comma."$key => [$value]");
|
||
$comma = ", ";
|
||
}
|
||
echo_out("\n");
|
||
}
|
||
}
|
||
echo_out((empty($compare_differences)?0:count($compare_differences))." differences.\n");
|
||
|
||
echo_out("--------------- Calculating database upgrade for '$schema@$host'... ---------------\n");
|
||
|
||
$upgrade_sql = array();
|
||
$result = mustal_calculate_db_upgrade($compare_def, $db_def, $upgrade_sql, $mustal_replacers);
|
||
|
||
if (!empty($result)) {
|
||
abort(count($result)." errors.\n");
|
||
if ($verbose) {
|
||
foreach($result as $error) {
|
||
echo_out("Code: ".$error[0]." '".$error[1]."'\n");
|
||
}
|
||
}
|
||
return(-1);
|
||
}
|
||
|
||
if ($verbose) {
|
||
foreach($upgrade_sql as $statement) {
|
||
echo_out($statement."\n");
|
||
}
|
||
}
|
||
|
||
echo_out(count($upgrade_sql)." upgrade statements\n");
|
||
|
||
if ($do_db) {
|
||
echo_out("--------------- Executing database upgrade for '$schema@$host' database... ---------------\n");
|
||
// First get the contents of the database table structure
|
||
$mysqli = mysqli_connect($host, $user, $passwd, $schema);
|
||
|
||
/* Check if the connection succeeded */
|
||
if (!$mysqli) {
|
||
echo ("Failed to connect!\n");
|
||
} else {
|
||
|
||
$counter = 0;
|
||
$error_counter = 0;
|
||
$number_of_statements = count($upgrade_sql);
|
||
|
||
foreach ($upgrade_sql as $sql) {
|
||
|
||
$counter++;
|
||
echo_out("\rUpgrade step $counter of $number_of_statements... ");
|
||
|
||
$query_result = mysqli_query($mysqli, $sql);
|
||
if (!$query_result) {
|
||
$error = " not ok: ". mysqli_error($mysqli);
|
||
echo_out($error);
|
||
echo_out("\n");
|
||
// file_put_contents("./errors.txt",date()." ".$error.$sql."\n",FILE_APPEND);
|
||
$error_counter++;
|
||
} else {
|
||
echo_out("ok.\r");
|
||
}
|
||
|
||
}
|
||
|
||
echo_out("\n");
|
||
echo_out("$error_counter errors.\n");
|
||
if ($error_counter > 0) {
|
||
// echo_out("See 'errors.txt'\n");
|
||
}
|
||
|
||
echo_out("--------------- Checking database upgrade for '$schema@$host'... ---------------\n");
|
||
$db_def = mustal_load_tables_from_db($host, $schema, $user, $passwd, $mustal_replacers);
|
||
|
||
echo_out("--------------- Comparing database '$schema@$host' vs. JSON '".$compare_def['database']."@".$compare_def['host']."' ---------------\n");
|
||
$compare_differences = mustal_compare_table_array($compare_def,"in JSON",$db_def,"in DB",true,true);
|
||
echo_out((empty($compare_differences)?0:count($compare_differences))." differences.\n");
|
||
}
|
||
} // $do_db
|
||
} // $check_db
|
||
|
||
/*
|
||
echo_out("--------------- Locking system ---------------\n");
|
||
if (file_exists($lockfile_name)) {
|
||
echo_out("System is already locked.\n");
|
||
} else {
|
||
file_put_contents($lockfile_name," ");
|
||
}
|
||
|
||
echo_out("--------------- Unlocking system ---------------\n");
|
||
unlink($lockfile_name);
|
||
*/
|
||
|
||
echo_out("--------------- Done! ---------------\n");
|
||
echo_out("--------------- ".date("Y-m-d H:i:s")." ---------------\n");
|
||
return(0);
|
||
}
|
||
|
||
function info() {
|
||
echo_out("OpenXE upgrade tool\n");
|
||
echo_out("Copyright 2022 (c) OpenXE project\n");
|
||
echo_out("\n");
|
||
echo_out("Upgrade files and database\n");
|
||
echo_out("Options:\n");
|
||
echo_out("\t-s: check/do system upgrades\n");
|
||
echo_out("\t-db: check/do database upgrades\n");
|
||
echo_out("\t-e: export database schema\n");
|
||
echo_out("\t-do: execute all upgrades\n");
|
||
echo_out("\t-v: verbose output\n");
|
||
echo_out("\t-f: force override of existing files\n");
|
||
echo_out("\t-connection use connection.json in data folder instead of user.inc.php\n");
|
||
echo_out("\t-clean: (not yet implemented) create the needed SQL to remove items from the database not in the JSON\n");
|
||
echo_out("\n");
|
||
}
|
||
|
||
|