<?php
// Exit if accessed directly
if (! defined('DUPLICATOR_VERSION')) exit;
class DUP_Database
{
//PUBLIC
public $Type = 'MySQL';
public $Size;
public $File;
public $Path;
public $FilterTables;
public $FilterOn;
public $Name;
public $Compatible;
public $Comments;
//PROTECTED
protected $Package;
//PRIVATE
private $dbStorePath;
private $EOFMarker;
private $networkFlush;
/**
* Init this object
*/
function __construct($package)
{
$this->Package = $package;
$this->EOFMarker = "";
$package_zip_flush = DUP_Settings::Get('package_zip_flush');
$this->networkFlush = empty($package_zip_flush) ? false : $package_zip_flush;
}
/**
* Build the database script
*
* @param DUP_Package $package A reference to the package that this database object belongs in
*
* @return null
*/
public function build($package, $errorBehavior = Dup_ErrorBehavior::Quit)
{
try {
$this->Package = $package;
do_action('duplicator_lite_build_database_before_start' , $package);
$time_start = DUP_Util::getMicrotime();
$this->Package->setStatus(DUP_PackageStatus::DBSTART);
$this->dbStorePath = "{$this->Package->StorePath}/{$this->File}";
$package_mysqldump = DUP_Settings::Get('package_mysqldump');
$package_phpdump_qrylimit = DUP_Settings::Get('package_phpdump_qrylimit');
$mysqlDumpPath = DUP_DB::getMySqlDumpPath();
$mode = ($mysqlDumpPath && $package_mysqldump) ? 'MYSQLDUMP' : 'PHP';
$reserved_db_filepath = DUPLICATOR_WPROOTPATH.'database.sql';
$log = "\n********************************************************************************\n";
$log .= "DATABASE:\n";
$log .= "********************************************************************************\n";
$log .= "BUILD MODE: {$mode}";
$log .= ($mode == 'PHP') ? "(query limit - {$package_phpdump_qrylimit})\n" : "\n";
$log .= "MYSQLTIMEOUT: ".DUPLICATOR_DB_MAX_TIME."\n";
$log .= "MYSQLDUMP: ";
$log .= ($mysqlDumpPath) ? "Is Supported" : "Not Supported";
DUP_Log::Info($log);
$log = null;
//Reserved file found
if (file_exists($reserved_db_filepath)) {
$error_message = 'Reserved SQL file detected';
$package->BuildProgress->set_failed($error_message);
$package->Update();
DUP_Log::Error($error_message,
"The file database.sql was found at [{$reserved_db_filepath}].\n"
."\tPlease remove/rename this file to continue with the package creation.", $errorBehavior);
}
do_action('duplicator_lite_build_database_start' , $package);
switch ($mode) {
case 'MYSQLDUMP':
$this->mysqlDump($mysqlDumpPath);
break;
case 'PHP' :
$this->phpDump();
break;
}
DUP_Log::Info("SQL CREATED: {$this->File}");
$time_end = DUP_Util::getMicrotime();
$time_sum = DUP_Util::elapsedTime($time_end, $time_start);
//File below 10k considered incomplete
$sql_file_size = filesize($this->dbStorePath);
DUP_Log::Info("SQL FILE SIZE: ".DUP_Util::byteSize($sql_file_size)." ({$sql_file_size})");
if ($sql_file_size < 1350) {
$error_message = "SQL file size too low.";
$package->BuildProgress->set_failed($error_message);
$package->Update();
DUP_Log::Error($error_message, "File does not look complete. Check permission on file and parent directory at [{$this->dbStorePath}]", $errorBehavior);
do_action('duplicator_lite_build_database_fail' , $package);
} else {
do_action('duplicator_lite_build_database_completed' , $package);
}
DUP_Log::Info("SQL FILE TIME: ".date("Y-m-d H:i:s"));
DUP_Log::Info("SQL RUNTIME: {$time_sum}");
$this->Size = @filesize($this->dbStorePath);
$this->Package->setStatus(DUP_PackageStatus::DBDONE);
} catch (Exception $e) {
do_action('duplicator_lite_build_database_fail' , $package);
DUP_Log::Error("Runtime error in DUP_Database::Build", "Exception: {$e}", $errorBehavior);
}
}
/**
* Get the database meta-data such as tables as all there details
*
* @return array Returns an array full of meta-data about the database
*/
public function getScannerData()
{
global $wpdb;
$filterTables = isset($this->FilterTables) ? explode(',', $this->FilterTables) : null;
$tblCount = 0;
$tables = $wpdb->get_results("SHOW TABLE STATUS", ARRAY_A);
$info = array();
$info['Status']['Success'] = is_null($tables) ? false : true;
//DB_Case for the database name is never checked on
$info['Status']['DB_Case'] = 'Good';
$info['Status']['DB_Rows'] = 'Good';
$info['Status']['DB_Size'] = 'Good';
$info['Status']['TBL_Case'] = 'Good';
$info['Status']['TBL_Rows'] = 'Good';
$info['Status']['TBL_Size'] = 'Good';
$info['Size'] = 0;
$info['Rows'] = 0;
$info['TableCount'] = 0;
$info['TableList'] = array();
$tblCaseFound = 0;
$tblRowsFound = 0;
$tblSizeFound = 0;
//Grab Table Stats
foreach ($tables as $table) {
$name = $table["Name"];
if ($this->FilterOn && is_array($filterTables)) {
if (in_array($name, $filterTables)) {
continue;
}
}
$size = ($table["Data_length"] + $table["Index_length"]);
$rows = empty($table["Rows"]) ? '0' : $table["Rows"];
$info['Size'] += $size;
$info['Rows'] += ($table["Rows"]);
$info['TableList'][$name]['Case'] = preg_match('/[A-Z]/', $name) ? 1 : 0;
$info['TableList'][$name]['Rows'] = number_format($rows);
$info['TableList'][$name]['Size'] = DUP_Util::byteSize($size);
$info['TableList'][$name]['USize'] = $size;
$tblCount++;
//Table Uppercase
if ($info['TableList'][$name]['Case']) {
if (!$tblCaseFound) {
$tblCaseFound = 1;
}
}
//Table Row Count
if ($rows > DUPLICATOR_SCAN_DB_TBL_ROWS) {
if (!$tblRowsFound) {
$tblRowsFound = 1;
}
}
//Table Size
if ($size > DUPLICATOR_SCAN_DB_TBL_SIZE) {
if (!$tblSizeFound) {
$tblSizeFound = 1;
}
}
}
$info['Status']['DB_Case'] = preg_match('/[A-Z]/', $wpdb->dbname) ? 'Warn' : 'Good';
$info['Status']['DB_Rows'] = ($info['Rows'] > DUPLICATOR_SCAN_DB_ALL_ROWS) ? 'Warn' : 'Good';
$info['Status']['DB_Size'] = ($info['Size'] > DUPLICATOR_SCAN_DB_ALL_SIZE) ? 'Warn' : 'Good';
$info['Status']['TBL_Case'] = ($tblCaseFound) ? 'Warn' : 'Good';
$info['Status']['TBL_Rows'] = ($tblRowsFound) ? 'Warn' : 'Good';
$info['Status']['TBL_Size'] = ($tblSizeFound) ? 'Warn' : 'Good';
$info['RawSize'] = $info['Size'];
$info['Size'] = DUP_Util::byteSize($info['Size']) or "unknown";
$info['Rows'] = number_format($info['Rows']) or "unknown";
$info['TableList'] = $info['TableList'] or "unknown";
$info['TableCount'] = $tblCount;
return $info;
}
/**
* Build the database script using mysqldump
*
* @return bool Returns true if the sql script was successfully created
*/
private function mysqlDump($exePath)
{
global $wpdb;
require_once (DUPLICATOR_PLUGIN_PATH.'classes/utilities/class.u.shell.php');
$host = explode(':', DB_HOST);
$host = reset($host);
$port = strpos(DB_HOST, ':') ? end(explode(':', DB_HOST)) : '';
$name = DB_NAME;
$mysqlcompat_on = isset($this->Compatible) && strlen($this->Compatible);
//Build command
$cmd = escapeshellarg($exePath);
$cmd .= ' --no-create-db';
$cmd .= ' --single-transaction';
$cmd .= ' --hex-blob';
$cmd .= ' --skip-add-drop-table';
$cmd .= ' --routines';
$cmd .= ' --quote-names';
$cmd .= ' --skip-comments';
$cmd .= ' --skip-set-charset';
$cmd .= ' --allow-keywords';
//Compatibility mode
if ($mysqlcompat_on) {
DUP_Log::Info("COMPATIBLE: [{$this->Compatible}]");
$cmd .= " --compatible={$this->Compatible}";
}
//Filter tables
$tables = $wpdb->get_col('SHOW TABLES');
$filterTables = isset($this->FilterTables) ? explode(',', $this->FilterTables) : null;
$tblAllCount = count($tables);
$tblFilterOn = ($this->FilterOn) ? 'ON' : 'OFF';
if (is_array($filterTables) && $this->FilterOn) {
foreach ($tables as $key => $val) {
if (in_array($tables[$key], $filterTables)) {
$cmd .= " --ignore-table={$name}.{$tables[$key]} ";
unset($tables[$key]);
}
}
}
$cmd .= ' -u '.escapeshellarg(DB_USER);
$cmd .= (DB_PASSWORD) ?
' -p'.DUP_Shell_U::escapeshellargWindowsSupport(DB_PASSWORD) : '';
$cmd .= ' -h '.escapeshellarg($host);
$cmd .= (!empty($port) && is_numeric($port) ) ?
' -P '.$port : '';
$isPopenEnabled = DUP_Shell_U::isPopenEnabled();
if (!$isPopenEnabled) {
$cmd .= ' -r '.escapeshellarg($this->dbStorePath);
}
$cmd .= ' '.escapeshellarg(DB_NAME);
$cmd .= ' 2>&1';
if ($isPopenEnabled) {
$needToRewrite = false;
foreach ($tables as $tableName) {
$rewriteTableAs = $this->rewriteTableNameAs($tableName);
if ($tableName != $rewriteTableAs) {
$needToRewrite = true;
break;
}
}
if ($needToRewrite) {
$findReplaceTableNames = array(); // orignal table name => rewrite table name
foreach ($tables as $tableName) {
$rewriteTableAs = $this->rewriteTableNameAs($tableName);
if ($tableName != $rewriteTableAs) {
$findReplaceTableNames[$tableName] = $rewriteTableAs;
}
}
}
$firstLine = '';
DUP_LOG::trace("Executing mysql dump command by popen: $cmd");
$handle = popen($cmd, "r");
if ($handle) {
$sql_header = "/* DUPLICATOR-LITE (MYSQL-DUMP BUILD MODE) MYSQL SCRIPT CREATED ON : ".@date("Y-m-d H:i:s")." */\n\n";
file_put_contents($this->dbStorePath, $sql_header, FILE_APPEND);
while (!feof($handle)) {
$line = fgets($handle); //get ony one line
if ($line) {
if (empty($firstLine)) {
$firstLine = $line;
if (false !== stripos($line, 'Using a password on the command line interface can be insecure')) continue;
}
if ($needToRewrite) {
$replaceCount = 1;
if (preg_match('/CREATE TABLE `(.*?)`/', $line, $matches)) {
$tableName = $matches[1];
if (isset($findReplaceTableNames[$tableName])) {
$rewriteTableAs = $findReplaceTableNames[$tableName];
$line = str_replace('CREATE TABLE `'.$tableName.'`', 'CREATE TABLE `'.$rewriteTableAs.'`', $line, $replaceCount);
}
} elseif (preg_match('/INSERT INTO `(.*?)`/', $line, $matches)) {
$tableName = $matches[1];
if (isset($findReplaceTableNames[$tableName])) {
$rewriteTableAs = $findReplaceTableNames[$tableName];
$line = str_replace('INSERT INTO `'.$tableName.'`', 'INSERT INTO `'.$rewriteTableAs.'`', $line, $replaceCount);
}
} elseif (preg_match('/LOCK TABLES `(.*?)`/', $line, $matches)) {
$tableName = $matches[1];
if (isset($findReplaceTableNames[$tableName])) {
$rewriteTableAs = $findReplaceTableNames[$tableName];
$line = str_replace('LOCK TABLES `'.$tableName.'`', 'LOCK TABLES `'.$rewriteTableAs.'`', $line, $replaceCount);
}
}
}
file_put_contents($this->dbStorePath, $line, FILE_APPEND);
$output = "Ran from {$exePath}";
}
}
$ret = pclose($handle);
} else {
$output = '';
}
// Password bug > 5.6 (@see http://bugs.mysql.com/bug.php?id=66546)
if (empty($output) && trim($firstLine) === 'Warning: Using a password on the command line interface can be insecure.') {
$output = '';
}
} else {
DUP_LOG::trace("Executing mysql dump command $cmd");
$output = shell_exec($cmd);
// Password bug > 5.6 (@see http://bugs.mysql.com/bug.php?id=66546)
if (trim($output) === 'Warning: Using a password on the command line interface can be insecure.') {
$output = '';
}
$output = (strlen($output)) ? $output : "Ran from {$exePath}";
$tblCreateCount = count($tables);
$tblFilterCount = $tblAllCount - $tblCreateCount;
//DEBUG
//DUP_Log::Info("COMMAND: {$cmd}");
DUP_Log::Info("FILTERED: [{$this->FilterTables}]");
DUP_Log::Info("RESPONSE: {$output}");
DUP_Log::Info("TABLES: total:{$tblAllCount} | filtered:{$tblFilterCount} | create:{$tblCreateCount}");
}
$sql_footer = "\n\n/* Duplicator WordPress Timestamp: ".date("Y-m-d H:i:s")."*/\n";
$sql_footer .= "/* ".DUPLICATOR_DB_EOF_MARKER." */\n";
file_put_contents($this->dbStorePath, $sql_footer, FILE_APPEND);
return ($output) ? false : true;
}
/**
* Build the database script using php
*
* @return bool Returns true if the sql script was successfully created
*/
private function phpDump()
{
global $wpdb;
$wpdb->query("SET session wait_timeout = ".DUPLICATOR_DB_MAX_TIME);
$handle = fopen($this->dbStorePath, 'w+');
$tables = $wpdb->get_col("SHOW FULL TABLES WHERE Table_Type != 'VIEW'");
$filterTables = isset($this->FilterTables) ? explode(',', $this->FilterTables) : null;
$tblAllCount = count($tables);
$tblFilterOn = ($this->FilterOn) ? 'ON' : 'OFF';
$qryLimit = DUP_Settings::Get('package_phpdump_qrylimit');
if (is_array($filterTables) && $this->FilterOn) {
foreach ($tables as $key => $val) {
if (in_array($tables[$key], $filterTables)) {
unset($tables[$key]);
}
}
}
$tblCreateCount = count($tables);
$tblFilterCount = $tblAllCount - $tblCreateCount;
DUP_Log::Info("TABLES: total:{$tblAllCount} | filtered:{$tblFilterCount} | create:{$tblCreateCount}");
DUP_Log::Info("FILTERED: [{$this->FilterTables}]");
//Added 'NO_AUTO_VALUE_ON_ZERO' at plugin version 1.2.12 to fix :
//**ERROR** database error write 'Invalid default value for for older mysql versions
$sql_header = "/* DUPLICATOR-LITE (PHP BUILD MODE) MYSQL SCRIPT CREATED ON : ".@date("Y-m-d H:i:s")." */\n\n";
$sql_header .= "/*!40101 SET @OLD_SQL_MODE=@@SQL_MODE, SQL_MODE='NO_AUTO_VALUE_ON_ZERO' */;\n\n";
$sql_header .= "SET FOREIGN_KEY_CHECKS = 0;\n\n";
fwrite($handle, $sql_header);
//BUILD CREATES:
//All creates must be created before inserts do to foreign key constraints
foreach ($tables as $table) {
$rewrite_table_as = $this->rewriteTableNameAs($table);
//$sql_del = ($GLOBALS['duplicator_opts']['dbadd_drop']) ? "DROP TABLE IF EXISTS {$table};\n\n" : "";
//@fwrite($handle, $sql_del);
$create = $wpdb->get_row("SHOW CREATE TABLE `{$table}`", ARRAY_N);
$count = 1;
$create_table_query = str_replace($table, $rewrite_table_as, $create[1], $count);
@fwrite($handle, "{$create_table_query};\n\n");
}
$procedures = $wpdb->get_col("SHOW PROCEDURE STATUS WHERE `Db` = '{$wpdb->dbname}'",1);
if(count($procedures)){
foreach ($procedures as $procedure){
@fwrite($handle, "DELIMITER ;;\n");
$create = $wpdb->get_row("SHOW CREATE PROCEDURE `{$procedure}`", ARRAY_N);
@fwrite($handle, "{$create[2]} ;;\n");
@fwrite($handle, "DELIMITER ;\n\n");
}
}
$views = $wpdb->get_col("SHOW FULL TABLES WHERE Table_Type = 'VIEW'");
if(count($views)){
foreach ($views as $view){
$create = $wpdb->get_row("SHOW CREATE VIEW `{$view}`", ARRAY_N);
@fwrite($handle, "{$create[1]};\n\n");
}
}
$table_count = count($tables);
$table_number = 0;
//BUILD INSERTS:
//Create Insert in 100 row increments to better handle memory
foreach ($tables as $table) {
$table_number++;
if($table_number % 2 == 0) {
$this->Package->Status = SnapLibUtil::getWorkPercent(DUP_PackageStatus::DBSTART, DUP_PackageStatus::DBDONE, $table_count, $table_number);
$this->Package->update();
}
$row_count = $wpdb->get_var("SELECT Count(*) FROM `{$table}`");
//DUP_Log::Info("{$table} ({$row_count})");
if ($row_count > $qryLimit) {
$row_count = ceil($row_count / $qryLimit);
} else if ($row_count > 0) {
$row_count = 1;
}
if ($row_count >= 1) {
fwrite($handle, "\n/* INSERT TABLE DATA: {$table} */\n");
}
$rewrite_table_as = $this->rewriteTableNameAs($table);
for ($i = 0; $i < $row_count; $i++) {
$sql = "";
$limit = $i * $qryLimit;
$query = "SELECT * FROM `{$table}` LIMIT {$limit}, {$qryLimit}";
$rows = $wpdb->get_results($query, ARRAY_A);
if (is_array($rows)) {
foreach ($rows as $row) {
$sql .= "INSERT INTO `{$rewrite_table_as}` VALUES(";
$num_values = count($row);
$num_counter = 1;
foreach ($row as $value) {
if (is_null($value) || !isset($value)) {
($num_values == $num_counter) ? $sql .= 'NULL' : $sql .= 'NULL, ';
} else {
($num_values == $num_counter)
? $sql .= '"' . DUP_DB::escSQL($value, true) . '"'
: $sql .= '"' . DUP_DB::escSQL($value, true) . '", ';
}
$num_counter++;
}
$sql .= ");\n";
}
fwrite($handle, $sql);
}
}
//Flush buffer if enabled
if ($this->networkFlush) {
DUP_Util::fcgiFlush();
}
$sql = null;
$rows = null;
}
$sql_footer = "\nSET FOREIGN_KEY_CHECKS = 1; \n\n";
$sql_footer .= "/* Duplicator WordPress Timestamp: ".date("Y-m-d H:i:s")."*/\n";
$sql_footer .= "/* ".DUPLICATOR_DB_EOF_MARKER." */\n";
fwrite($handle, $sql_footer);
$wpdb->flush();
fclose($handle);
}
private function rewriteTableNameAs($table) {
$table_prefix = $this->getTablePrefix();
if (!isset($this->sameNameTableExists)) {
global $wpdb;
$this->sameNameTableExists = false;
$all_tables = $wpdb->get_col("SHOW FULL TABLES WHERE Table_Type != 'VIEW'");
foreach ($all_tables as $table_name) {
if (strtolower($table_name) != $table_name && in_array(strtolower($table_name), $all_tables)) {
$this->sameNameTableExists = true;
break;
}
}
}
if (false === $this->sameNameTableExists && 0 === stripos($table, $table_prefix) && 0 !== strpos($table, $table_prefix)) {
$post_fix = substr($table, strlen($table_prefix));
$rewrite_table_name = $table_prefix.$post_fix;
} else {
$rewrite_table_name = $table;
}
return $rewrite_table_name;
}
private function getTablePrefix() {
global $wpdb;
$table_prefix = (is_multisite() && !defined('MULTISITE')) ? $wpdb->base_prefix : $wpdb->get_blog_prefix(0);
return $table_prefix;
}
}