482 lines
16 KiB
PHP
482 lines
16 KiB
PHP
<?php
|
|
|
|
/**
|
|
* Lightweight abstraction layer for common simple database routines
|
|
*
|
|
* Standard: PSR-2
|
|
*
|
|
* @package SC\DupPro\DB
|
|
* @copyright (c) 2017, Snapcreek LLC
|
|
* @license https://opensource.org/licenses/GPL-3.0 GNU Public License
|
|
*/
|
|
|
|
defined('ABSPATH') || defined('DUPXABSPATH') || exit;
|
|
|
|
use Duplicator\Libs\Shell\Shell;
|
|
use Duplicator\Libs\Snap\SnapOS;
|
|
|
|
class DUP_PRO_DB extends wpdb
|
|
{
|
|
const BUILD_MODE_MYSQLDUMP = 'MYSQLDUMP';
|
|
const BUILD_MODE_PHP_SINGLE_THREAD = 'PHP';
|
|
const BUILD_MODE_PHP_MULTI_THREAD = 'PHPCHUNKING';
|
|
|
|
const PHPDUMP_MODE_MULTI = 0;
|
|
const PHPDUMP_MODE_SINGLE = 1;
|
|
|
|
const MAX_TABLE_COUNT_IN_PACKET = 100;
|
|
|
|
/**
|
|
* Get the requested MySQL system variable
|
|
*
|
|
* @param string $variable The database variable name to lookup
|
|
*
|
|
* @return ?string the server variable to query for
|
|
*/
|
|
public static function getVariable($variable)
|
|
{
|
|
global $wpdb;
|
|
$row = $wpdb->get_row("SHOW VARIABLES LIKE '{$variable}'", ARRAY_N);
|
|
return isset($row[1]) ? $row[1] : null;
|
|
}
|
|
|
|
/**
|
|
* Return the value of lower_case_table_names
|
|
*
|
|
* @see https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_lower_case_table_names
|
|
*
|
|
* @return int
|
|
*/
|
|
public static function getLowerCaseTableNames()
|
|
{
|
|
if (($result = self::getVariable("lower_case_table_names")) === null) {
|
|
if (SnapOS::isOSX()) {
|
|
return 2;
|
|
} elseif (SnapOS::isWindows()) {
|
|
return 1;
|
|
} else {
|
|
return 0;
|
|
}
|
|
}
|
|
|
|
return (int) $result;
|
|
}
|
|
|
|
/**
|
|
* Returns true if table names are case sensitive in this DB
|
|
*
|
|
* @return bool
|
|
*/
|
|
public static function dbIsCaseSensitive()
|
|
{
|
|
return self::getLowerCaseTableNames() === 0;
|
|
}
|
|
|
|
/**
|
|
* Return table have real case sensitive prefix.
|
|
*
|
|
* @param string $table Table name
|
|
*
|
|
* @return string
|
|
*/
|
|
public static function updateCaseSensitivePrefix($table)
|
|
{
|
|
global $wpdb;
|
|
|
|
if (!self::dbIsCaseSensitive() && stripos($table, $wpdb->prefix) === 0) {
|
|
return $wpdb->prefix . substr($table, strlen($wpdb->prefix));
|
|
}
|
|
|
|
return $table;
|
|
}
|
|
|
|
/**
|
|
* Gets the MySQL database version number
|
|
*
|
|
* @param bool $full True: Gets the full version if available (i.e 10.2.3-MariaDB)
|
|
* False: Gets only the numeric portion i.e. (5.5.6 -or- 10.1.2)
|
|
*
|
|
* @return false|string 0 on failure, version number on success
|
|
*/
|
|
public static function getVersion($full = false)
|
|
{
|
|
global $wpdb;
|
|
if ($full) {
|
|
$version = self::getVariable('version');
|
|
} else {
|
|
$version = preg_replace('/[^0-9.].*/', '', self::getVariable('version'));
|
|
}
|
|
|
|
//Fall-back for servers that have restricted SQL for SHOW statement
|
|
//Note: For MariaDB this will report something like 5.5.5 when it is really 10.2.1.
|
|
//This mainly is due to mysqli_get_server_info method which gets the version comment
|
|
//and uses a regex vs getting just the int version of the value. So while the former
|
|
//code above is much more accurate it may fail in rare situations
|
|
if (empty($version)) {
|
|
$version = $wpdb->db_version();
|
|
}
|
|
|
|
return empty($version) ? 0 : $version;
|
|
}
|
|
|
|
/**
|
|
* Try to return the mysqldump path on Windows servers
|
|
*
|
|
* @return boolean|string
|
|
*/
|
|
public static function getWindowsMySqlDumpRealPath()
|
|
{
|
|
if (function_exists('php_ini_loaded_file')) {
|
|
$get_php_ini_path = php_ini_loaded_file();
|
|
if (@file_exists($get_php_ini_path)) {
|
|
$search = array(
|
|
dirname(dirname($get_php_ini_path)) . '/mysql/bin/mysqldump.exe',
|
|
dirname(dirname(dirname($get_php_ini_path))) . '/mysql/bin/mysqldump.exe',
|
|
dirname(dirname($get_php_ini_path)) . '/mysql/bin/mysqldump',
|
|
dirname(dirname(dirname($get_php_ini_path))) . '/mysql/bin/mysqldump',
|
|
);
|
|
foreach ($search as $mysqldump) {
|
|
if (@file_exists($mysqldump)) {
|
|
return str_replace("\\", "/", $mysqldump);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
unset($search);
|
|
unset($get_php_ini_path);
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Returns the mysqldump path if the server is enabled to execute it
|
|
*
|
|
* @return boolean|string
|
|
*/
|
|
public static function getMySqlDumpPath()
|
|
{
|
|
$global = DUP_PRO_Global_Entity::getInstance();
|
|
|
|
if (!Shell::test()) {
|
|
return false;
|
|
}
|
|
|
|
$custom_mysqldump_path = (strlen($global->package_mysqldump_path)) ? $global->package_mysqldump_path : '';
|
|
$custom_mysqldump_path = escapeshellcmd($custom_mysqldump_path);
|
|
|
|
//Common Windows Paths
|
|
if (SnapOS::isWindows()) {
|
|
$paths = array(
|
|
$custom_mysqldump_path,
|
|
DUP_PRO_DB::getWindowsMySqlDumpRealPath(),
|
|
'C:/xampp/mysql/bin/mysqldump.exe',
|
|
'C:/Program Files/xampp/mysql/bin/mysqldump',
|
|
'C:/Program Files/MySQL/MySQL Server 6.0/bin/mysqldump',
|
|
'C:/Program Files/MySQL/MySQL Server 5.5/bin/mysqldump',
|
|
'C:/Program Files/MySQL/MySQL Server 5.4/bin/mysqldump',
|
|
'C:/Program Files/MySQL/MySQL Server 5.1/bin/mysqldump',
|
|
'C:/Program Files/MySQL/MySQL Server 5.0/bin/mysqldump',
|
|
);
|
|
} else {
|
|
//Common Linux Paths
|
|
$paths = [];
|
|
if (strlen($custom_mysqldump_path)) {
|
|
$paths[] = $custom_mysqldump_path;
|
|
}
|
|
// Add possible executeable path if that exists instead of empty string
|
|
if (($shellResult = Shell::runCommand('which mysqldump', Shell::AVAILABLE_COMMANDS)) !== false) {
|
|
$mysqlDumpExecPath = trim($shellResult->getOutputAsString());
|
|
if (strlen($mysqlDumpExecPath) > 0) {
|
|
$paths[] = $mysqlDumpExecPath;
|
|
}
|
|
}
|
|
|
|
$paths = array_merge(
|
|
$paths,
|
|
[
|
|
'/usr/local/bin/mysqldump',
|
|
'/usr/local/mysql/bin/mysqldump',
|
|
'/usr/mysql/bin/mysqldump',
|
|
'/usr/bin/mysqldump',
|
|
'/opt/local/lib/mysql6/bin/mysqldump',
|
|
'/opt/local/lib/mysql5/bin/mysqldump',
|
|
'/opt/local/lib/mysql4/bin/mysqldump',
|
|
'/usr/bin/mysqldump',
|
|
]
|
|
);
|
|
$paths = array_values($paths);
|
|
}
|
|
|
|
foreach ($paths as $path) {
|
|
if (strlen($path) === 0) {
|
|
continue;
|
|
}
|
|
|
|
$cmd = $path . ' --version';
|
|
$shellOutput = Shell::runCommand($cmd);
|
|
if ($shellOutput !== false && $shellOutput->getCode() === 0) {
|
|
return $path;
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Get Sql query to create table which is given.
|
|
*
|
|
* @param string $table Table name
|
|
*
|
|
* @return string mysql query create table
|
|
*/
|
|
private static function getCreateTableQuery($table)
|
|
{
|
|
$row = $GLOBALS['wpdb']->get_row('SHOW CREATE TABLE `' . esc_sql($table) . '`', ARRAY_N);
|
|
return $row[1];
|
|
}
|
|
|
|
/**
|
|
* Returns all collation types that are assigned to the tables in
|
|
* the current database. Each element in the array is unique
|
|
*
|
|
* @param string[] $tables A list of tables to include from the search
|
|
*
|
|
* @return string[] Returns an array with all the character set being used
|
|
*/
|
|
public static function getTableCharSetList($tables)
|
|
{
|
|
$charSets = array();
|
|
try {
|
|
foreach ($tables as $table) {
|
|
$createTableQuery = self::getCreateTableQuery($table);
|
|
if (preg_match('/ CHARSET=([^\s;]+)/i', $createTableQuery, $charsetMatch)) {
|
|
if (!in_array($charsetMatch[1], $charSets)) {
|
|
$charSets[] = $charsetMatch[1];
|
|
}
|
|
}
|
|
}
|
|
return $charSets;
|
|
} catch (Exception $ex) {
|
|
return $charSets;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns all collation types that are assigned to the tables and columns table in
|
|
* the current database. Each element in the array is unique
|
|
*
|
|
* @param string[] $tablesToInclude A list of tables to include in the search
|
|
*
|
|
* @return string[] Returns an array with all the collation types being used
|
|
*/
|
|
public static function getTableCollationList($tablesToInclude)
|
|
{
|
|
global $wpdb;
|
|
static $collations = null;
|
|
if (is_null($collations)) {
|
|
$collations = array();
|
|
//use half the number of tables since we are using them twice
|
|
foreach (array_chunk($tablesToInclude, self::MAX_TABLE_COUNT_IN_PACKET) as $tablesChunk) {
|
|
$sqlTables = implode(",", array_map(array(__CLASS__, 'escValueToQueryString'), $tablesChunk));
|
|
|
|
//UNION is by default DISTINCT
|
|
$query = "SELECT `COLLATION_NAME` FROM `information_schema`.`columns` WHERE `COLLATION_NAME` IS NOT NULL AND `table_schema` = '{$wpdb->dbname}' "
|
|
. "AND `table_name` in (" . $sqlTables . ")"
|
|
. "UNION SELECT `TABLE_COLLATION` FROM `information_schema`.`tables` WHERE `TABLE_COLLATION` IS NOT NULL AND `table_schema` = '{$wpdb->dbname}' "
|
|
. "AND `table_name` in (" . $sqlTables . ")";
|
|
|
|
if (!$wpdb->query($query)) {
|
|
DUP_PRO_Log::info("GET TABLE COLLATION ERROR: " . $wpdb->last_error);
|
|
continue;
|
|
}
|
|
|
|
$collations = array_merge($collations, $wpdb->get_col());
|
|
}
|
|
$collations = array_values(array_unique($collations));
|
|
sort($collations);
|
|
}
|
|
|
|
return $collations;
|
|
}
|
|
|
|
/**
|
|
* Returns list of MySQL engines used by $tablesToInclude in the current DB
|
|
*
|
|
* @param string[] $tablesToInclude tables to check the engines for
|
|
*
|
|
* @return string[]
|
|
*/
|
|
public static function getTableEngineList($tablesToInclude)
|
|
{
|
|
/** @var wpdb $wpdb */
|
|
global $wpdb;
|
|
|
|
static $engines = null;
|
|
if (is_null($engines)) {
|
|
$engines = array();
|
|
foreach (array_chunk($tablesToInclude, self::MAX_TABLE_COUNT_IN_PACKET) as $tablesChunk) {
|
|
$query = "SELECT DISTINCT `ENGINE` FROM `information_schema`.`tables` WHERE `ENGINE` IS NOT NULL AND `table_schema` = '{$wpdb->dbname}' "
|
|
. "AND `table_name` in (" . implode(",", array_map(array(__CLASS__, 'escValueToQueryString'), $tablesChunk)) . ")";
|
|
|
|
if (!$wpdb->query($query)) {
|
|
DUP_PRO_Log::info("GET TABLE ENGINES ERROR: " . $wpdb->last_error);
|
|
}
|
|
$engines = array_merge($engines, $wpdb->get_col($query));
|
|
}
|
|
$engines = array_values(array_unique($engines));
|
|
}
|
|
|
|
return $engines;
|
|
}
|
|
|
|
/**
|
|
* Returns the correct database build mode PHP, MYSQLDUMP, PHPCHUNKING
|
|
*
|
|
* @return string Returns a string with one of theses three values PHP, MYSQLDUMP, PHPCHUNKING
|
|
*/
|
|
public static function getBuildMode()
|
|
{
|
|
$global = DUP_PRO_Global_Entity::getInstance();
|
|
if ($global->package_mysqldump) {
|
|
$mysqlDumpPath = DUP_PRO_DB::getMySqlDumpPath();
|
|
if ($mysqlDumpPath === false) {
|
|
DUP_PRO_Log::trace("Forcing into PHP mode - the mysqldump executable wasn't found!");
|
|
$global->package_mysqldump = false;
|
|
$global->save();
|
|
}
|
|
}
|
|
|
|
if ($global->package_mysqldump) {
|
|
return self::BUILD_MODE_MYSQLDUMP;
|
|
} elseif ($global->package_phpdump_mode == self::PHPDUMP_MODE_MULTI) {
|
|
return self::BUILD_MODE_PHP_MULTI_THREAD;
|
|
} else {
|
|
return self::BUILD_MODE_PHP_SINGLE_THREAD;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns an escaped sql string
|
|
*
|
|
* @param string $sql The sql to escape
|
|
* @param bool $removePlaceholderEscape Patch for how the default WP function works.
|
|
*
|
|
* @return boolean|string
|
|
* @also see: https://make.wordpress.org/core/2017/10/31/changed-behaviour-of-esc_sql-in-wordpress-4-8-3/
|
|
*/
|
|
public static function escSQL($sql, $removePlaceholderEscape = false)
|
|
{
|
|
global $wpdb;
|
|
static $removePlMethodExists = null;
|
|
if (is_null($removePlMethodExists)) {
|
|
$removePlMethodExists = method_exists($wpdb, 'remove_placeholder_escape');
|
|
}
|
|
|
|
if ($removePlaceholderEscape && $removePlMethodExists) {
|
|
return $wpdb->remove_placeholder_escape(esc_sql($sql));
|
|
} else {
|
|
return esc_sql($sql);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get tables list in database
|
|
*
|
|
* @return string[]
|
|
*/
|
|
public static function getTablesList()
|
|
{
|
|
global $wpdb;
|
|
|
|
$result = $wpdb->get_col("SHOW FULL TABLES FROM `" . DB_NAME . "` WHERE Table_Type = 'BASE TABLE' ", 0);
|
|
if (!is_array($result)) {
|
|
return array();
|
|
}
|
|
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* This function escape sql string without add and remove remove_placeholder_escape
|
|
* Don't use esc_sql wordpress function
|
|
*
|
|
* @param null|scalar $value input value
|
|
*
|
|
* @return string
|
|
*/
|
|
public static function escValueToQueryString($value)
|
|
{
|
|
if (is_null($value)) {
|
|
return 'NULL';
|
|
}
|
|
global $wpdb;
|
|
return '"' . mysqli_real_escape_string($wpdb->dbh, (string) $value) . '"';
|
|
}
|
|
|
|
/**
|
|
* This function returns the list of tables with the number of rows for each table.
|
|
* Using the count the number is the real and not approximate number of the table schema.
|
|
*
|
|
* @param string|string[] $tables list of tables os single table
|
|
*
|
|
* @return array<string,int> key table nale val table rows
|
|
*/
|
|
public static function getTablesRows($tables = array())
|
|
{
|
|
$result = array();
|
|
if (empty($tables)) {
|
|
return $result;
|
|
}
|
|
|
|
$tables = (array) $tables;
|
|
global $wpdb;
|
|
$query = '';
|
|
foreach ($tables as $index => $table) {
|
|
$query .= ($index > 0 ? ' UNION ' : '');
|
|
$query .= 'SELECT "' . $wpdb->_real_escape($table) . '" AS `table`, COUNT(*) AS `rows` FROM `' . $wpdb->_real_escape($table) . '`';
|
|
}
|
|
$queryResult = $wpdb->get_results($query);
|
|
if ($wpdb->last_error) {
|
|
DUP_PRO_Log::info("QUERY ERROR: " . $wpdb->last_error);
|
|
throw new Exception('SET TOTAL QUERY ERROR: ' . $wpdb->last_error);
|
|
}
|
|
|
|
foreach ($queryResult as $tableInfo) {
|
|
$result[self::updateCaseSensitivePrefix($tableInfo->table)] = $tableInfo->rows;
|
|
}
|
|
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* This function returns the total number of rows in the listed tables.
|
|
* It does not count the real number of rows but evaluates the number present in the table schema.
|
|
* This number is a rough estimate that may be different from the real number.
|
|
*
|
|
* The advantage of this function is that it is instantaneous unlike the actual counting of lines that take several seconds.
|
|
* But the number returned by this function cannot be used for any type of line count validation in the database.
|
|
*
|
|
* @param string|string[] $tables list of tables os single table
|
|
*
|
|
* @return int
|
|
*/
|
|
public static function getImpreciseTotaTablesRows($tables = array())
|
|
{
|
|
$tables = (array) $tables;
|
|
if (count($tables) == 0) {
|
|
return 0;
|
|
}
|
|
|
|
global $wpdb;
|
|
$query = 'SELECT SUM(TABLE_ROWS) as "totalRows" FROM information_schema.TABLES '
|
|
. 'WHERE TABLE_SCHEMA = "' . $wpdb->_real_escape($wpdb->dbname) . '" '
|
|
. 'AND TABLE_NAME IN (' . implode(',', array_map(array(__CLASS__, 'escValueToQueryString'), $tables)) . ')';
|
|
$result = (int) $wpdb->get_var($query);
|
|
if ($wpdb->last_error) {
|
|
DUP_PRO_Log::info("QUERY ERROR: " . $wpdb->last_error);
|
|
throw new Exception('SET TOTAL QUERY ERROR: ' . $wpdb->last_error);
|
|
}
|
|
|
|
return $result;
|
|
}
|
|
}
|