/**
* The rollback() function removes the query either from file (MASTER) or from the CDI log (SLAVE)
* @param String $hash The MD5 hash created using the SQL statement, the timestamp and the execution order
* @param Timestamp $timestamp The UNIX timestamp on which the query was originally logged
* @param Integer $order The execution order of the query (in case of multiple executions with the same timestamp)
*/
public static function rollback($hash,$timestamp,$order) {
// do not rollback erronous changes to tbl_cdi_log
$tbl_prefix = Symphony::Configuration()->get('tbl_prefix', 'database');
if (preg_match("/{$tbl_prefix}cdi_log/i", $query)) return true;
try {
if(CdiUtil::isCdiSlave()) {
// On the SLAVE instance we need to remove the execution log entry from the database
Symphony::Database()->query("DELETE FROM `tbl_cdi_log` WHERE `query_hash` LIKE '" . $hash . "'");
} else if(CdiUtil::isCdiMaster()) {
// On the MASTER instance we need to remove the persisted SQL Statement from disk (if it exists)
$entries = self::getCdiLogEntries();
unset($entries[$hash]);
file_put_contents(CDI_FILE, json_encode($entries));
} else {
throw new Exception("Invalid value for the CDI 'mode' configuration option, 'CdiMaster' or 'CdiSlave' expected.");
}
} catch(Exception $e) {
//TODO: think of some smart way of dealing with errors, perhaps through the preference screen or a CDI Status content page?
//In this case it is perhaps better to simply throw the exception because the rollback failed.
throw $e;
}
}
require_once(EXTENSIONS . '/cdi/lib/class.cdipreferences.php');
// We should not be processing any queries when the extension is disabled or when we are the Master instance
if((!class_exists('Administration')) || !CdiUtil::isEnabled()) {
$result["status"] = "error";
$result["message"] = "You can only execute actions from within Symphony and when the CDI extension is enabled";
Symphony::Log()->pushToLog('[CDI] You can only execute actions from within Symphony and when the CDI extension is enabled', E_NOTICE, true);
}
// Clean the database and log files when the cdi_clear action is called
if(isset($_POST["action"]["cdi_clear"])) {
try {
if(CdiUtil::isCdiMaster()) {
CdiMaster::uninstall();
CdiMaster::install();
} else if (CdiUtil::isCdiSlave()) {
CdiSlave::uninstall();
CdiSlave::install();
} else if(CdiUtil::isCdiDBSync()) {
CdiDBSync::uninstall();
CdiDBSync::install();
}
$result["status"] = 'success';
} catch(Exception $e) {
$result["status"] = "error";
$result["message"] = $e->getMessage();
Symphony::Log()->pushToLog('[CDI] ' . $e->getMessage(), E_ERROR, true);
}
}
// Clean the database backup list when cdi_clear_restore action is called
public static function appendInstanceMode() {
$div = new XMLElement('div', NULL, array('class' => 'instanceMode'));
$div->appendChild(new XMLElement('h3','Instance Mode',array('style' => 'margin: 5px 0;')));
$label = Widget::Label();
if(!CdiUtil::isCdiSlave() && !CdiUtil::isCdiDBSyncSlave()) {
$label->setAttribute('style','position:relative;padding-left:18px;');
} else {
$label->setAttribute('style','margin-bottom: 2px;position:relative;padding-left:18px;');
}
$input = Widget::Input('settings[cdi][is-slave]', 'yes', 'checkbox');
$input->setAttribute('style','position:absolute;left:0px;');
$input->setAttribute('class','instance-mode');
if(CdiUtil::canBeMasterInstance()) {
if(CdiUtil::isCdiSlave() || CdiUtil::isCdiDBSyncSlave()) { $input->setAttribute('checked', 'checked'); }
$label->setValue($input->generate() . ' This is a "Slave" instance (no structural changes will be registered)');
} else {
$input->setAttribute('checked', 'checked');
$input->setAttribute('disabled', 'disabled');
$label->setValue($input->generate() . ' This can only be a "Slave" instance due to insufficient write permissions.');
}
$div->appendChild($label);
if(CdiUtil::isCdiSlave() || CdiUtil::isCdiDBSyncSlave())
{
$label = Widget::Label();
$label->setAttribute('style','position:relative;padding-left:18px;');
$input = Widget::Input('settings[cdi][disable_blueprints]', 'yes', 'checkbox');
$input->setAttribute('style','position:absolute;left:0px;');
if(CdiUtil::hasDisabledBlueprints()) {
$input->setAttribute('checked', 'checked');
}
$label->setValue($input->generate() . ' Disable structural changes on this instance.');
$div->appendChild($label);
}
if(CdiUtil::isCdiMaster() || CdiUtil::isCdiSlave()) {
$div->appendChild(new XMLElement('p', 'The extension is designed to allow automatic propagation of structural changes between environments in a DTAP setup.
It is imperitive that you have a single "Master" instance (usually your development environment). This is important because the auto-increment values need to be exactly the same on each database table in every environment.
Switching between modes is therefore not recommended. If needed, make sure you only switch instance mode after you have ensured that you have restored all databases from the same source and cleared the CDI logs on all instances.', array('class' => 'help')));
} else if (CdiUtil::isCdiDBSync()) {
$div->appendChild(new XMLElement('p', 'The extension is designed to allow manual propagation of structural changes between environments in a DTAP setup.
It is imperitive that you have a single "Master" instance (usually your development environment). This is important because the auto-increment values need to be exactly the same on each database table in every environment.
Switching between modes is therefore not recommended. If needed, make sure you only switch instance mode after you have ensured that you have restored all databases from the same source.', array('class' => 'help')));
}
$div->appendChild(new XMLElement('p', 'You need to save your changes before you can configure this instance, or reload the page to cancel.<br />Be advised: changing instances mode will reset any instance specific configuration settings', array('class' => 'cdiInstanceRestart', 'style' => 'display:none;')));
return $div;
}
public function savePreferences($context){
if(CdiPreferences::save()) {
// apply config changes
if(CdiUtil::isCdiSlave()) { CdiSlave::install(); }
else if (CdiUtil::isCdiMaster()) { CdiMaster::install(); }
else { CdiDBSync::install(); }
} else {
Administration::instance()->Page->pageAlert(_('An unknown error occurred while saving preferences for CDI. Your changes have not been saved.'));
return false;
}
}
/**
* The executeQueries() function will try to execute all SQL statements that are available in the manifest folder.
* It will check the CDI log to see if the statement has already been executed based on the MD5 hash.
* This function can only be called by SLAVE instances
*/
public static function update() {
// We should not be processing any queries when the extension is disabled or when we are the Master instance
// Check also exists on content page, but just to be sure!
if((!class_exists('Administration')) || !CdiUtil::isEnabled() || !CdiUtil::isCdiSlave()) {
echo "WARNING: CDI is disabled or you are running the queryies on the Master instance. No queries have been executed.";
return;
}
// Prevent the CdiLogQuery::log() from persisting queries that are executed by CDI itself
// Technically this should not be possible because it will not log queries on a SLAVE instance
// and you can only run the executeQueries when in SLAVE mode. This is just to be sure.
CdiLogQuery::isUpdating(true);
// Switch to maintenance mode
if(Symphony::Configuration()->get('maintenance-enabled', 'cdi') == 'yes') {
Symphony::Configuration()->set('enabled', 'yes', 'maintenance_mode');
Symphony::Configuration()->write();
}
// Implement automatic backup before processing structural changes
if(Symphony::Configuration()->get('backup-enabled', 'cdi') == 'yes') {
try {
if(CdiUtil::hasDumpDBInstalled()) {
require_once(EXTENSIONS . '/cdi/lib/class.cdidumpdb.php');
$currentBackup = CdiDumpDB::backup("automatic");
} else {
throw new Exception('You can only enable automatic backup files when the "Dump DB" extension (version 1.10 or higher) is installed and enabled.');
}
}catch (Exception $e) {
echo "ERROR: " . $e->getMessage() , ". Failed to backup database before update, aborting.";
die();
}
}
try {
$skipped = 0;
$executed = 0;
$entries = CdiLogQuery::getCdiLogEntries();
foreach($entries as $entry) {
$ts = $entry[0];
$order = $entry[1];
$hash = $entry[2];
$query = $entry[3];
$date = date('Y-m-d H:i:s', $ts);
// Replace the table prefix in the query
// Rename the generic table prefix to the prefix used by this instance
$tbl_prefix = Symphony::Configuration()->get('tbl_prefix', 'database');
$query = str_replace('tbl_', $tbl_prefix, $query);
try {
// Look for available CDI log entries based on the provided MD5 hash
$cdiLogEntry = Symphony::Database()->fetchRow(0,"SELECT * FROM tbl_cdi_log WHERE `query_hash` LIKE '" . $hash . "'");
if(empty($cdiLogEntry)) {
// The query has not been found in the log, thus it has not been executed
// So let's execute the query and add it to the log!
Symphony::Database()->query("INSERT INTO `tbl_cdi_log` (`query_hash`,`author`,`url`,`date`,`order`)
VALUES ('" . $hash . "','" . CdiUtil::getAuthor() . "','" . CdiUtil::getURL() . "','" . $date . "'," . $order . ")");
Symphony::Database()->query($query);
$executed++;
} else {
// The query has already been executed, let's do nothing;
$skipped++;
}
} catch (Exception $e) {
//TODO: think of some smart way of dealing with errors, perhaps through the preference screen or a CDI Status content page?
//Due to the error we need to perform a rollback to allow this query to be executed at a later stage.
CdiLogQuery::rollback($hash,$ts,$order);
// Implement automatic restore on error
if((Symphony::Configuration()->get('backup-enabled', 'cdi') == 'yes') &&
(Symphony::Configuration()->get('restore-enabled', 'cdi') == 'yes')) {
try {
CdiDumpDB::restore($currentBackup);
}catch (Exception $r) {
echo "ERROR: " . $r->getMessage() , ". Failed to restore latest database backup. This instance needs immediate attention!";
die();
}
// Restore was succesful, at least we can jump out of maintenance mode
if(Symphony::Configuration()->get('maintenance-enabled', 'cdi') == 'yes') {
Symphony::Configuration()->set('enabled', 'no', 'maintenance_mode');
Symphony::Configuration()->write();
}
echo "ERROR: " . $e->getMessage() , ". Rollback & Restore have been executed.";
} else {
if(Symphony::Configuration()->get('maintenance-enabled', 'cdi') == 'yes') {
echo "ERROR: " . $e->getMessage() , ". Rollback has been executed. This instance is now in maintenance mode and needs immediate attention!";
} else {
echo "ERROR: " . $e->getMessage() , ". Rollback has been executed.";
}
}
// Stop processing
die();
}
}
echo "OK: " . $executed . " queries executed, " . $skipped . " skipped.";
} catch (Exception $e) {
//TODO: think of some smart way of dealing with errors, perhaps through the preference screen or a CDI Status content page?
echo "ERROR: " . $e->getMessage();
}
// Save the last update date to configuration
Symphony::Configuration()->set('last-update', time(), 'cdi');
// No more maintenance mode
if(Symphony::Configuration()->get('maintenance-enabled', 'cdi') == 'yes') {
Symphony::Configuration()->set('enabled', 'no', 'maintenance_mode');
}
Symphony::Configuration()->write();
// Re-enable CdiLogQuery::log() to persist queries
CdiLogQuery::isUpdating(false);
}
