Current File : /var/www/knwn/wp-content/plugins/wpsynchro/includes/Database/DatabaseFinalize.php
<?php
/**
* Class for handling database finalize
* @since 1.0.0
*/
namespace WPSynchro\Database;
use WPSynchro\CommonFunctions;
class DatabaseFinalize
{
// Data objects
public $job = null;
public $installation = null;
public $databasesync = null;
public $logger = null;
public $timer = null;
/**
* Constructor
* @since 1.0.0
*/
public function __construct()
{
}
/**
* Calculate completion percent
* @since 1.0.0
*/
public function finalize(&$installation, &$job)
{
// Timer
global $wpsynchro_container;
$this->timer = $wpsynchro_container->get("class.SyncTimerList");
$this->installation = &$installation;
$this->job = &$job;
$this->logger = $wpsynchro_container->get("class.Logger");
$this->databasesync = $wpsynchro_container->get('class.DatabaseSync');
$this->databasesync->job = $this->job;
$this->databasesync->installation = $this->installation;
$this->logger->log("INFO", "Starting database finalize with remaining time: " . $this->timer->getRemainingSyncTime());
// Prepare SQL statements, if not done yet
if (!$this->job->finalize_db_initialized) {
$this->job->finalize_progress_description = __("Preparing database finalize", "wpsynchro");
$this->logger->log("INFO", "Prepare SQL queries for database finalize");
$this->prepareSQLQueries();
$this->job->finalize_db_initialized = true;
$this->logger->log("INFO", "Done preparing SQL queries for database finalize");
$this->job->request_full_timeframe = true;
return;
}
// Execute a group of queries
if (count($this->job->finalize_db_sql_queries) > 0) {
$this->job->finalize_progress_description = sprintf(
__("Finalizing table %d out of %d", "wpsynchro"),
$this->job->finalize_db_sql_queries_count - count($this->job->finalize_db_sql_queries),
$this->job->finalize_db_sql_queries_count
);
$sql_group = array_pop($this->job->finalize_db_sql_queries);
// Execute a set of queries
$body = new \stdClass();
$body->sql_inserts = $sql_group;
$body->type = 'finalize'; // For executing sql
$this->logger->log("DEBUG", "Calling remote client db service with " . count($body->sql_inserts) . " SQL statements:", $sql_group);
$this->databasesync->callRemoteClientDBService($body, 'to');
$this->job->request_full_timeframe = true;
return;
}
// After all tables is renamed, we remove all the extra temporary tables on the target (only leftovers from other syncs)
if (count($this->job->errors) == 0 && !$this->job->finalize_db_excess_tables_initialized) {
$this->job->finalize_db_excess_table_queries = $this->cleanUpAfterFinalizing();
$this->job->finalize_db_excess_table_queries_count = count($this->job->finalize_db_excess_table_queries);
$this->job->finalize_db_excess_tables_initialized = true;
$this->job->request_full_timeframe = true;
return;
}
// If any excess SQL queries to clean up excess tables, run them
if (count($this->job->errors) == 0 && count($this->job->finalize_db_excess_table_queries) > 0) {
$this->job->finalize_progress_description = sprintf(
__("Removing old temporary table - %d out of %d", "wpsynchro"),
$this->job->finalize_db_excess_table_queries_count - count($this->job->finalize_db_excess_table_queries),
$this->job->finalize_db_excess_table_queries_count
);
$sql = array_pop($this->job->finalize_db_excess_table_queries);
// Execute a clean up query
$body = new \stdClass();
$body->sql_inserts = [$sql];
$body->type = 'finalize'; // For executing sql
$this->logger->log("DEBUG", "Calling remote client db service with for excess table cleanup - SQL statement:", $body->sql_inserts);
$this->databasesync->callRemoteClientDBService($body, 'to');
$this->job->request_full_timeframe = true;
return;
}
// Check for table case issues on the migration
if (count($this->job->errors) == 0) {
$this->job->finalize_progress_description = __("Check that all tables on target is in correct case", "wpsynchro");
$this->checkTableCasesCorrect($this->job->finalize_db_table_to_expect_on_target);
}
if (count($this->job->errors) > 0) {
// Errors during finalize
return;
} else {
// All good
$this->job->finalize_db_completed = true;
}
}
/**
* Prepare the list of sql queries to run for finalize
* @since 1.6.0
*/
public function prepareSQLQueries()
{
// Handle preserving data
$sql_queries = [];
$sql_queries_last = [];
// Handle data to keep
$sql_queries[] = $this->handleDataToKeep();
// Get latest and greatest from target db
$dbtables = $this->retrieveDatabaseTables();
// Create lookup array
$to_table_lookup = [];
foreach ($dbtables as $to_table) {
$to_table_lookup[$to_table->name] = $to_table->rows;
}
// Get prefix of remote db
$commonfunctions = new CommonFunctions();
$table_prefix = $commonfunctions->getDBTempTableName();
// Run finalize checks
foreach ($this->job->from_dbmasterdata as $from_table) {
$from_rows = $from_table->rows;
// If its old temp table on source, just ignore
if (strpos($from_table->name, $table_prefix) > -1) {
$this->logger->log("DEBUG", "Table " . $from_table->name . " is a old temp table, so ignore");
continue;
}
// Check if table exists on "to", which it should
if (!isset($to_table_lookup[$from_table->temp_name])) {
// Not transferred - Error
$this->logger->log("CRITICAL", "Table " . $from_table->name . " does not exist on target, but it should. It is not transferred. Temp name is " . $from_table->temp_name);
$this->job->errors[] = sprintf(__("Finalize: Error in database synchronization for table %s - It is not transferred", "wpsynchro"), $from_table->name);
continue;
}
$to_rows = $to_table_lookup[$from_table->temp_name];
$this->checkRowCountCompare($from_table->name, $from_rows, $to_rows);
}
// Get tables to be renamed
foreach ($this->job->from_dbmasterdata as $table) {
if (!isset($from_table->temp_name) || strlen($from_table->temp_name) == 0) {
continue;
}
$table_name = $table->name;
$table_temp_name = $table->temp_name;
$sql_queries_in_group = [];
// If table prefix change is enabled
if ($this->installation->db_table_prefix_change) {
// Check if we need to change prefixes and therefore need to rewrite table name
$table_name = DatabaseHelperFunctions::handleTablePrefixChange($table_name, $this->job->from_wpdb_prefix, $this->job->to_wpdb_prefix);
// Handle the data updates in table when doing prefix change
$prefix_change_sql_queries = $this->handleDataChangeOnPrefixChange($table_name, $table_temp_name);
$sql_queries_in_group = array_merge($sql_queries_in_group, $prefix_change_sql_queries);
}
// Add tables to the list for "expected to be on target"
$this->job->finalize_db_table_to_expect_on_target[] = $table_name;
// Add sql statements
$this->logger->log("DEBUG", "Add drop table in database on " . $table_name . " and rename from " . $table_temp_name);
$sql_queries_in_group[] = 'DROP TABLE IF EXISTS `' . $table_name . '`';
$sql_queries_in_group[] = 'RENAME TABLE `' . $table_temp_name . '` TO `' . $table_name . '`';
// Check if it is special table
if ($table_name == $this->job->to_wp_users_table) {
$sql_queries_last[0] = $sql_queries_in_group;
} elseif ($table_name == $this->job->to_wp_usermeta_table) {
$sql_queries_last[1] = $sql_queries_in_group;
} elseif ($table_name == $this->job->to_wp_options_table) {
$sql_queries_last[2] = $sql_queries_in_group;
} else {
$sql_queries[] = $sql_queries_in_group;
}
}
// Handle multisite
$sql_queries = array_merge($sql_queries, $this->getMultisiteFinalizeSQL());
// Add the last queries
ksort($sql_queries_last);
foreach ($sql_queries_last as $query) {
$sql_queries[] = $query;
}
// Add views
foreach ($this->job->db_views_to_be_synced as $table) {
// Add sql statements
$this->logger->log("DEBUG", "Add drop view in database on " . $table->name . " and create it again");
$view_sql = [
'DROP VIEW IF EXISTS `' . $table->name . '`',
$table->create_table
];
$sql_queries[] = $view_sql;
}
// Turn it around, so we can pop of from top
$sql_queries = array_reverse($sql_queries);
// Log sql queries
$this->logger->log("DEBUG", "Finalize SQL queries:", $sql_queries);
$this->job->finalize_db_sql_queries = $sql_queries;
$this->job->finalize_db_sql_queries_count = count($sql_queries);
}
/**
* Handle the data to keep (such as WP Synchro data etc.)
* @since 1.2.0
*/
public function handleDataToKeep()
{
// Figure out if we actually migrate the options table
$target_options_table_tempname = "";
$sql_queries = [];
foreach ($this->job->from_dbmasterdata as $table) {
if ($table->name == $this->job->from_wp_options_table) {
$target_options_table_tempname = $table->temp_name;
break;
}
}
if ($target_options_table_tempname == "") {
return $sql_queries;
}
// Preserving data in options table, if it is migrated
if ($this->installation->include_all_database_tables || in_array($this->job->from_wp_options_table, $this->installation->only_include_database_table_names)) {
$delete_from_sql = "delete from `" . $target_options_table_tempname . "` where option_name like 'wpsynchro_%'";
$insert_into_sql = "insert into `" . $target_options_table_tempname . "` (option_name,option_value,autoload) select option_name,option_value,autoload from " . $this->job->to_wp_options_table . " where option_name like 'wpsynchro_%'";
$sql_queries[] = $delete_from_sql;
$this->logger->log("INFO", "Add sql statement to delete WP Synchro options: " . $delete_from_sql);
$sql_queries[] = $insert_into_sql;
$this->logger->log("INFO", "Add sql statement to copy current WP Synchro options to temp table: " . $insert_into_sql);
if ($this->installation->db_preserve_activeplugins) {
$delete_from_sql = "delete from `" . $target_options_table_tempname . "` where option_name = 'active_plugins'";
$insert_into_sql = "insert into `" . $target_options_table_tempname . "` (option_name,option_value,autoload) select option_name,option_value,autoload from " . $this->job->to_wp_options_table . " where option_name = 'active_plugins'";
$sql_queries[] = $delete_from_sql;
$this->logger->log("INFO", "Add sql statement to delete active plugin setting: " . $delete_from_sql);
$sql_queries[] = $insert_into_sql;
$this->logger->log("INFO", "Add sql statement to copy current active plugin setting to temp table: " . $insert_into_sql);
}
}
return $sql_queries;
}
/**
* Handle data to be renamed inside tables when changing prefix
* @since 1.3.2
*/
public function handleDataChangeOnPrefixChange($table_name, $table_temp_name)
{
$source_prefix = $this->job->from_wpdb_prefix;
$target_prefix = $this->job->to_wpdb_prefix;
$sql_queries = [];
global $wpdb;
if ($source_prefix != $target_prefix) {
// Add sql queries to change meta data if options table or user_meta table
$temp_wp_usermeta = $this->job->to_wpdb_prefix . "usermeta";
if ($table_name == $this->job->to_wp_usermeta_table || $table_name == $temp_wp_usermeta) {
// Update prefixes in usermeta table
$sql_queries[] = "update `" . $table_temp_name . "` set meta_key = replace(meta_key, '" . $source_prefix . "', '" . $target_prefix . "') where meta_key like '" . $wpdb->esc_like($source_prefix) . "%'";
$this->logger->log("DEBUG", "update data in temp table " . $table_temp_name . " (" . $table_name . ") to replace source prefix " . $source_prefix . " with target prefix " . $target_prefix);
} else if ($table_name == $this->job->to_wp_options_table) {
// Update prefix in options table
$this->logger->log("DEBUG", "update data in temp table " . $table_temp_name . " (" . $table_name . ") to replace source prefix " . $source_prefix . " with target prefix " . $target_prefix);
$sql_queries[] = "update `" . $table_temp_name . "` set option_name = replace(option_name, '" . $source_prefix . "', '" . $target_prefix . "') where option_name like '" . $wpdb->esc_like($source_prefix) . "%'";
}
}
return $sql_queries;
}
/**
* Retrieve new database data from target
* @since 1.2.0
*/
public function retrieveDatabaseTables($temp_table = true)
{
// Retrieve new db tables list from destination
global $wpsynchro_container;
$masterdata_obj = $wpsynchro_container->get('class.MasterdataSync');
$data_to_retrieve = ["dbdetails"];
$masterdata_obj->installation = $this->installation;
$masterdata_obj->job = $this->job;
$masterdata_obj->logger = $this->logger;
$this->logger->log("DEBUG", "Retrieving new masterdata from target");
$masterdata = $masterdata_obj->retrieveMasterdata('to', $data_to_retrieve);
if (!is_object($masterdata) || !isset($masterdata->tmptables_dbdetails)) {
$this->job->errors[] = __("Could not retrieve data from remote site for finalizing", "wpsynchro");
$this->logger->log("CRITICAL", "Could not retrieve data from target site for finalizing");
return;
}
$this->logger->log("DEBUG", "Retrieving new masterdata completed");
if ($temp_table) {
return $masterdata->tmptables_dbdetails;
} else {
return $masterdata->dbdetails;
}
}
/**
* Try to clean up if any temporary tables are left on target
* @since 1.2.0
*/
public function cleanUpAfterFinalizing()
{
$temp_tables_left = $this->retrieveDatabaseTables();
$sql_queries = [];
foreach ($temp_tables_left as $table) {
$sql_queries[] = 'drop table if exists `' . $table->name . '`';
$this->logger->log("DEBUG", "Add sql to delete excess temp table: " . $table->name);
}
if (count($sql_queries) == 0) {
$this->logger->log("DEBUG", "No excess temp tables to delete");
}
return $sql_queries;
}
/**
* Check that tables have correct case
* @since 1.3.0
*/
public function checkTableCasesCorrect($tables_to_be_expected_on_target)
{
$tables_on_target = $this->retrieveDatabaseTables(false);
$tables_check_ignore = $this->getMultisiteTableExclusions();
foreach ($tables_to_be_expected_on_target as $checktablename) {
// Check if table name is excluded from check, such as due to multisite stuff
if (in_array($checktablename, $tables_check_ignore)) {
continue;
}
$found = false;
foreach ($tables_on_target as $targettable) {
if ($checktablename == $targettable->name) {
$found = true;
break;
}
}
if (!$found) {
// Not found in correct case, now check for case insensitive
foreach ($tables_on_target as $targettable) {
$found_case_insensitive = false;
$found_table_case = $targettable->name;
if (strcasecmp($checktablename, $targettable->name) == 0) {
$found_case_insensitive = true;
break;
}
}
if ($found_case_insensitive) {
$warningmsg = sprintf(__("Finalize: Table %s is not found with the correct case. We found a table called %s. This may or may not give you problems. This happens due to SQL server configuration.", "wpsynchro"), $checktablename, $found_table_case);
$this->job->warnings[] = $warningmsg;
$this->logger->log("WARNING", $warningmsg);
} else {
$warningmsg = sprintf(__("Finalize: Table %s is not found on target. It may be a problem with the rename from temp table name.", "wpsynchro"), $checktablename, $found_table_case);
$this->job->warnings[] = $warningmsg;
$this->logger->log("WARNING", $warningmsg);
}
}
}
}
/**
* Function to help with finalizing database data and checks if rows are with reasonable limits
* @since 1.0.0
*/
public function checkRowCountCompare($from_tablename, $from_rows, $to_rows)
{
$margin_for_warning_rows_equal = 5; // 5%
// If from has no rows, the to table should also be empty
if ($from_rows == 0 && $to_rows != 0) {
$this->job->errors[] = sprintf(__("Finalize: Error in database synchronization for table %s - It should not contain any rows", "wpsynchro"), $from_tablename);
return;
}
// If from has rows, but the to table is empty, could be memory limit hit, exceeding post max size or mysql max_packet_size
if ($from_rows > 0 && $to_rows == 0) {
$this->job->errors[] = sprintf(__("Finalize: Error in database synchronization for table %s - No rows has been transferred, but should contain %d rows. Normally this is because the ressource limits has been hit and the database content is too large. Contact support is this continues to fail.", "wpsynchro"), $from_tablename, $from_rows);
return;
}
// Check that rows approximately equal. Could have been changed a bit while synching, which is okay, but raises a warning if too much. Its okay if it is bigger
if ($to_rows < ((1 - ($margin_for_warning_rows_equal / 100)) * $from_rows)) {
$this->job->warnings[] = sprintf(__("Finalize: Warning in database synchronization for table %s - It differs more than %d%% in size, which indicate something has gone wrong during transfer. We found %d rows, but expected around %d rows.", "wpsynchro"), $from_tablename, $margin_for_warning_rows_equal, $to_rows, $from_rows);
}
}
/**
* Handle the multisite finalize sql
* @since 1.6.0
*/
public function getMultisiteFinalizeSQL()
{
$multisite_sql = [];
return $multisite_sql;
}
/**
* Handle which tables to not check for on the target - aka those that might be renamed or removed, such as users table on multisite
* @since 1.6.0
*/
public function getMultisiteTableExclusions()
{
$tables_to_exclude = [];
return $tables_to_exclude;
}
/**
* Get percentage completed for database finalize
* @since 1.6.0
*/
public function getPercentCompletedForDatabaseFinalize()
{
// We have four primary steps - Initialize, rename queries, drop excess tables and the last checks
$completion = 0;
if ($this->job->finalize_db_initialized) {
$completion += 10;
}
if ($this->job->finalize_db_sql_queries_count > 0) {
$completion += 80 * (count($this->job->finalize_db_sql_queries) / $this->job->finalize_db_sql_queries_count);
} else {
$completion += 80;
}
if ($this->job->finalize_db_excess_table_queries_count > 0) {
$completion += 10 * (count($this->job->finalize_db_excess_table_queries) / $this->job->finalize_db_excess_table_queries_count);
} else {
$completion += 10;
}
return 1 - ($completion / 100);
}
}
Mini Shell