Your IP : 3.145.76.12
<?php
/**
* Lightweight abstraction layer for common simple database routines
*
* Standard: PSR-2
*
* @package SC\DUPX\DB
* @link http://www.php-fig.org/psr/psr-2/
*/
defined('ABSPATH') || defined('DUPXABSPATH') || exit;
use Duplicator\Installer\Utils\Log\Log;
class DUPX_DB
{
const DELETE_CHUNK_SIZE = 500;
const MYSQLI_CLIENT_NO_FLAGS = 0;
const DB_CONNECTION_FLAG_NOT_SET = -1;
/**
* Modified version of https://developer.wordpress.org/reference/classes/wpdb/db_connect/
*
* @param string $host The server host name
* @param string $username The server DB user name
* @param string $password The server DB password
* @param string $dbname The server DB name
* @param int $flag Extra flags for connection
*
* @return mysqli|null Database connection handle
*/
public static function connect($host, $username, $password, $dbname = null, $flag = self::MYSQLI_CLIENT_NO_FLAGS)
{
try {
$port = null;
$socket = null;
$is_ipv6 = false;
$host_data = self::parseDBHost($host);
if ($host_data) {
list($host, $port, $socket, $is_ipv6) = $host_data;
}
/*
* If using the `mysqlnd` library, the IPv6 address needs to be
* enclosed in square brackets, whereas it doesn't while using the
* `libmysqlclient` library.
* @see https://bugs.php.net/bug.php?id=67563
*/
if ($is_ipv6 && extension_loaded('mysqlnd')) {
$host = "[$host]";
}
$dbh = mysqli_init();
@mysqli_real_connect($dbh, $host, $username, $password, null, $port, $socket, $flag);
if ($dbh->connect_errno) {
$dbh = null;
Log::info('DATABASE CONNECTION ERROR: ' . mysqli_connect_error() . '[ERRNO:' . mysqli_connect_errno() . ']');
} else {
if (method_exists($dbh, 'options')) {
$dbh->options(MYSQLI_OPT_LOCAL_INFILE, 'disable');
}
}
if (!empty($dbname)) {
if (mysqli_select_db($dbh, mysqli_real_escape_string($dbh, $dbname)) == false) {
Log::info('DATABASE SELECT DB ERROR: ' . $dbname . ' BUT IS CONNECTED SO CONTINUE');
}
}
} catch (Exception $e) {
Log::info('DATABASE CONNECTION EXCEPTION ERROR: ' . $e->getMessage());
return null;
}
return $dbh;
}
/**
* Modified version of https://developer.wordpress.org/reference/classes/wpdb/parse_db_host/
* Return Array containing the host, the port, the socket and whether it is an IPv6 address, in that order. If $host couldn't be parsed, returns false
*
* @param string $host The DB_HOST setting to parse
*
* @return false|array{0:string,1:?int,2:?string,3:bool}
*/
public static function parseDBHost($host)
{
$port = null;
$socket = null;
$is_ipv6 = false;
// First peel off the socket parameter from the right, if it exists.
$socket_pos = strpos($host, ':/');
if (false !== $socket_pos) {
$socket = substr($host, $socket_pos + 1);
$host = substr($host, 0, $socket_pos);
}
// We need to check for an IPv6 address first.
// An IPv6 address will always contain at least two colons.
if (substr_count($host, ':') > 1) {
$pattern = '#^(?:\[)?(?P<host>[0-9a-fA-F:]+)(?:\]:(?P<port>[\d]+))?#';
$is_ipv6 = true;
} else {
// We seem to be dealing with an IPv4 address.
$pattern = '#^(?P<host>[^:/]*)(?::(?P<port>[\d]+))?#';
}
$matches = array();
$result = preg_match($pattern, $host, $matches);
if (1 !== $result) {
// Couldn't parse the address, bail.
return false;
}
$host = '';
foreach (array('host', 'port') as $component) {
if (!empty($matches[$component])) {
$$component = $matches[$component];
}
}
return array(
$host,
$port,
$socket,
$is_ipv6,
);
}
/**
*
* @param string $host The server host name
* @param string $username The server DB user name
* @param string $password The server DB password
* @param string $dbname The server DB name
*
* @return boolean
*/
public static function testConnection($host, $username, $password, $dbname = '')
{
if (($dbh = DUPX_DB::connect($host, $username, $password, $dbname))) {
mysqli_close($dbh);
return true;
} else {
return false;
}
}
/**
* Count the tables in a given database
*
* @param mysqli $dbh A valid database link handle
* @param string $dbname Database to count tables in
*
* @return int The number of tables in the database
*/
public static function countTables($dbh, $dbname)
{
$res = self::mysqli_query($dbh, "SELECT COUNT(*) AS count FROM information_schema.tables WHERE table_schema = '" . mysqli_real_escape_string($dbh, $dbname) . "' ");
$row = mysqli_fetch_row($res);
return is_null($row) ? 0 : $row[0];
}
/**
* Returns the number of rows in a table
*
* @param mysqli $dbh A valid database link handle
* @param string $name A valid table name
*
* @return int The number of rows in the table
*/
public static function countTableRows($dbh, $name)
{
$total = self::mysqli_query($dbh, "SELECT COUNT(*) FROM `" . mysqli_real_escape_string($dbh, $name) . "`");
if ($total) {
$total = @mysqli_fetch_array($total);
return $total[0];
} else {
return 0;
}
}
/**
* Get default character set
*
* @param mysqli $dbh A valid database link handle
*
* @return string Default charset
*/
public static function getDefaultCharSet($dbh)
{
static $defaultCharset = null;
if (is_null($defaultCharset)) {
$query = 'SHOW VARIABLES LIKE "character_set_database"';
if (($result = self::mysqli_query($dbh, $query))) {
if (($row = $result->fetch_assoc())) {
$defaultCharset = $row["Value"];
}
$result->free();
} else {
$defaultCharset = '';
}
}
return $defaultCharset;
}
/**
* Get Supported charset list
*
* @param mysqli $dbh A valid database link handle
*
* @return string[] Supported charset list
*/
public static function getSupportedCharSetList($dbh)
{
static $charsetList = null;
if (is_null($charsetList)) {
$charsetList = array();
$query = "SHOW CHARACTER SET;";
if (($result = self::mysqli_query($dbh, $query))) {
while ($row = $result->fetch_assoc()) {
$charsetList[] = $row["Charset"];
}
$result->free();
}
sort($charsetList);
}
return $charsetList;
}
/**
* Get Supported collations along with character set
*
* @param mysqli $dbh A valid database link handle
*
* @return array<array{Collation:string,Charset:string,Id:int,Default:string,Sortlen:int}>
*/
public static function getSupportedCollates($dbh)
{
static $collations = null;
if (is_null($collations)) {
$collations = array();
$query = "SHOW COLLATION";
if (($result = self::mysqli_query($dbh, $query))) {
while ($row = $result->fetch_assoc()) {
$collations[] = $row;
}
$result->free();
}
usort($collations, function ($a, $b) {
return strcmp($a['Collation'], $b['Collation']);
});
}
return $collations;
}
/**
* Get Supported collations along with character set
*
* @param mysqli $dbh A valid database link handle
*
* @return string[] Supported collation
*/
public static function getSupportedCollateList($dbh)
{
static $collates = null;
if (is_null($collates)) {
$collates = array();
$query = "SHOW COLLATION";
if (($result = self::mysqli_query($dbh, $query))) {
while ($row = $result->fetch_assoc()) {
$collates[] = $row['Collation'];
}
$result->free();
}
sort($collates);
}
return $collates;
}
/**
* Returns the database names as an array
*
* @param mysqli $dbh A valid database link handle
* @param string $dbuser An optional dbuser name to search by
*
* @return string[] A list of all database names
*/
public static function getDatabases($dbh, $dbuser = '')
{
$sql = strlen($dbuser) ? "SHOW DATABASES LIKE '%" . mysqli_real_escape_string($dbh, $dbuser) . "%'" : 'SHOW DATABASES';
$query = self::mysqli_query($dbh, $sql);
if ($query) {
while ($db = @mysqli_fetch_array($query)) {
$all_dbs[] = $db[0];
}
if (isset($all_dbs) && is_array($all_dbs)) {
return $all_dbs;
}
}
return array();
}
/**
* Check if database exists
*
* @param mysqli $dbh DB connection
* @param string $dbname database name
*
* @return bool
*/
public static function databaseExists($dbh, $dbname)
{
$sql = 'SELECT COUNT(SCHEMA_NAME) AS databaseExists ' .
'FROM INFORMATION_SCHEMA.SCHEMATA WHERE SCHEMA_NAME = "' . mysqli_real_escape_string($dbh, $dbname) . '"';
$res = self::mysqli_query($dbh, $sql);
$row = mysqli_fetch_row($res);
return (!is_null($row) && $row[0] >= 1);
}
/**
* Check if table exists
*
* @param mysqli $dbh A valid database link handle
* @param string $tablename Table name to check for
*
* @return bool Whether or not if given table exists
*/
public static function tableExists($dbh, $tablename)
{
$query = self::mysqli_query($dbh, "SHOW TABLES LIKE '" . mysqli_real_escape_string($dbh, $tablename) . "'");
return $query && mysqli_num_rows($query) == 1;
}
/**
* Select database if exists
*
* @param mysqli $dbh DB connection
* @param string $dbname database name
*
* @return bool false on failure
*/
public static function selectDB($dbh, $dbname)
{
if (!self::databaseExists($dbh, $dbname)) {
return false;
}
return mysqli_select_db($dbh, $dbname);
}
/**
* Returns the tables for a database as an array
*
* @param mysqli $dbh A valid database link handle
*
* @return string[] A list of all table names
*/
public static function getTables(mysqli $dbh)
{
$query = self::mysqli_query($dbh, 'SHOW TABLES');
if ($query) {
$all_tables = array();
while ($table = @mysqli_fetch_array($query)) {
$all_tables[] = $table[0];
}
return $all_tables;
}
return array();
}
/**
* Get the requested MySQL system variable
*
* @param mysqli $dbh A valid database link handle
* @param string $name The database variable name to lookup
* @param mixed $default default value if query fail
*
* @return mixed the server variable to query for
*/
public static function getVariable($dbh, $name, $default = null)
{
if (($result = self::mysqli_query($dbh, "SHOW VARIABLES LIKE '" . mysqli_real_escape_string($dbh, $name) . "'")) == false) {
return $default;
}
$row = @mysqli_fetch_array($result);
@mysqli_free_result($result);
return isset($row[1]) ? $row[1] : $default;
}
/**
* Gets the MySQL database version number
*
* @param mysqli $dbh A valid database link handle
* @param bool $full True: Gets the full version
* False: Gets only the numeric
* portion i.e. 5.5.6 or 10.1.2
* (for MariaDB)
*
* @return string '0' on failure, version number on success
*/
public static function getVersion($dbh, $full = false)
{
if ($full) {
$version = self::getVariable($dbh, 'version', '');
} else {
$version = preg_replace('/[^0-9.].*/', '', self::getVariable($dbh, '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 = mysqli_get_server_info($dbh);
$version = preg_replace('/[^0-9.].*/', '', $version);
}
return empty($version) ? '0' : $version;
}
/**
* Determine if a MySQL database supports a particular feature
*
* @param mysqli $dbh Database connection handle
* @param string $feature the feature to check for
*
* @return bool
*/
public static function hasAbility($dbh, $feature)
{
$version = self::getVersion($dbh);
switch (strtolower($feature)) {
case 'collation':
case 'group_concat':
case 'subqueries':
return version_compare($version, '4.1', '>=');
case 'set_charset':
return version_compare($version, '5.0.7', '>=');
};
return false;
}
/**
* Runs a query and returns the results as an array with the column names
*
* @param mysqli $dbh A valid database link handle
* @param string $sql The sql to run
* @param int $column_index The column index to use as the key
*
* @return scalar[] The result of the query as an array with the column name as the key
*/
public static function queryColumnToArray($dbh, $sql, $column_index = 0)
{
$result_array = array();
$full_result_array = self::queryToArray($dbh, $sql);
for ($i = 0; $i < count($full_result_array); $i++) {
$result_array[] = $full_result_array[$i][$column_index];
}
return $result_array;
}
/**
* Runs a query with no result
*
* @param mysqli $dbh A valid database link handle
* @param string $sql The sql to run
*
* @return scalar[][] The result of the query as an array
*/
public static function queryToArray($dbh, $sql)
{
$result = array();
$query_result = self::mysqli_query($dbh, $sql);
if ($query_result !== false) {
if (mysqli_num_rows($query_result) > 0) {
while ($row = mysqli_fetch_row($query_result)) {
$result[] = $row;
}
}
} else {
$error = mysqli_error($dbh);
throw new Exception("Error executing query {$sql}.<br/>{$error}");
}
return $result;
}
/**
* Runs a query with no result
*
* @param mysqli $dbh A valid database link handle
* @param string $sql The sql to run
*
* @return void
*/
public static function queryNoReturn($dbh, $sql)
{
if (self::mysqli_query($dbh, $sql) === false) {
$error = mysqli_error($dbh);
throw new Exception("Error executing query {$sql}.<br/>{$error}");
}
}
/**
* Drops the table given
*
* @param mysqli $dbh A valid database link handle
* @param string $name A valid table name to remove
*
* @return void
*/
public static function dropTable($dbh, $name)
{
Log::info('DROP TABLE ' . $name, Log::LV_DETAILED);
$escapedName = mysqli_real_escape_string($dbh, $name);
self::queryNoReturn($dbh, 'DROP TABLE IF EXISTS `' . $escapedName . '`');
}
/**
* Empty the table given
*
* @param mysqli $dbh A valid database link handle
* @param string $name A valid table name to remove
*
* @return void
*/
public static function emptyTable($dbh, $name)
{
Log::info('TRUNCATE TABLE ' . $name, Log::LV_DETAILED);
$escapedName = mysqli_real_escape_string($dbh, $name);
self::queryNoReturn($dbh, 'TRUNCATE TABLE `' . $escapedName . '`');
}
/**
* Renames an existing table
*
* @param mysqli $dbh A valid database link handle
* @param string $existing_name The current tables name
* @param string $new_name The new table name to replace the existing name
* @param bool $delete_if_conflict Delete the table name if there is a conflict
*
* @return void
*/
public static function renameTable($dbh, $existing_name, $new_name, $delete_if_conflict = false)
{
if ($delete_if_conflict) {
self::dropTable($dbh, $new_name);
}
Log::info('RENAME TABLE ' . $existing_name . ' TO ' . $new_name);
$escapedOldName = mysqli_real_escape_string($dbh, $existing_name);
$escapedNewName = mysqli_real_escape_string($dbh, $new_name);
self::queryNoReturn($dbh, 'RENAME TABLE `' . $escapedOldName . '` TO `' . $escapedNewName . '`');
}
/**
* Renames an existing table
*
* @param mysqli $dbh A valid database link handle
* @param string $existing_name The current tables name
* @param string $new_name The new table name to replace the existing name
* @param bool $delete_if_conflict Delete the table name if there is a conflict
*
* @return void
*/
public static function copyTable($dbh, $existing_name, $new_name, $delete_if_conflict = false)
{
if ($delete_if_conflict) {
self::dropTable($dbh, $new_name);
}
Log::info('COPY TABLE ' . $existing_name . ' TO ' . $new_name);
$escapedOldName = mysqli_real_escape_string($dbh, $existing_name);
$escapedNewName = mysqli_real_escape_string($dbh, $new_name);
self::queryNoReturn($dbh, 'CREATE TABLE `' . $escapedNewName . '` LIKE `' . $escapedOldName . '`');
self::queryNoReturn($dbh, 'INSERT INTO `' . $escapedNewName . '` SELECT * FROM `' . $escapedOldName . '`');
}
/**
* Sets the MySQL connection's character set.
*
* @param mysqli $dbh The resource given by mysqli_connect
* @param ?string $charset The character set, null default value
* @param ?string $collate The collation, null default value
*
* @return bool
*/
public static function setCharset($dbh, $charset = null, $collate = null)
{
if (!self::hasAbility($dbh, 'collation')) {
return false;
}
$charset = (!isset($charset) ) ? $GLOBALS['DBCHARSET_DEFAULT'] : $charset;
$collate = (!isset($collate) ) ? '' : $collate;
if (empty($charset)) {
return true;
}
if (function_exists('mysqli_set_charset') && self::hasAbility($dbh, 'set_charset')) {
try {
if (($result1 = mysqli_set_charset($dbh, $charset)) === false) {
$errMsg = mysqli_error($dbh);
Log::info('DATABASE ERROR: mysqli_set_charset ' . Log::v2str($charset) . ' MSG: ' . $errMsg);
} else {
Log::info('DATABASE: mysqli_set_charset ' . Log::v2str($charset), Log::LV_DETAILED);
}
} catch (Exception $e) {
Log::info('DATABASE ERROR: mysqli_set_charset ' . Log::v2str($charset) . ' MSG: ' . $e->getMessage());
$result1 = false;
}
if (!empty($collate)) {
$sql = "SET collation_connection = " . mysqli_real_escape_string($dbh, $collate);
if (($result2 = self::mysqli_query($dbh, $sql)) === false) {
$errMsg = mysqli_error($dbh);
Log::info('DATABASE ERROR: SET collation_connection ' . Log::v2str($collate) . ' MSG: ' . $errMsg);
} else {
Log::info('DATABASE: SET collation_connection ' . Log::v2str($collate), Log::LV_DETAILED);
}
} else {
$result2 = true;
}
return $result1 && $result2;
} else {
$sql = " SET NAMES " . mysqli_real_escape_string($dbh, $charset);
if (!empty($collate)) {
$sql .= " COLLATE " . mysqli_real_escape_string($dbh, $collate);
}
if (($result = self::mysqli_query($dbh, $sql)) === false) {
$errMsg = mysqli_error($dbh);
Log::info('DATABASE SQL ERROR: ' . Log::v2str($sql) . ' MSG: ' . $errMsg);
} else {
Log::info('DATABASE SQL: ' . Log::v2str($sql), Log::LV_DETAILED);
}
return $result;
}
}
/**
*
* @param mysqli $dbh The resource given by mysqli_connect\
*
* @return bool|string return false if current database isent selected or the string name
*/
public static function getCurrentDatabase($dbh)
{
// SELECT DATABASE() as db;
if (($result = self::mysqli_query($dbh, 'SELECT DATABASE() as db')) === false) {
return false;
}
$assoc = $result->fetch_assoc();
return isset($assoc['db']) ? $assoc['db'] : false;
}
/**
* mysqli_query wrapper with logging
*
* @param mysqli $link db connection
* @param string $query query string
* @param int $logFailLevel Write in the log only if the log level is equal to or greater than level
* @param int $resultmode The result mode can be one of 3 constants indicating how the result will be returned from the MySQL server.
*
* @return mysqli_result|bool For successful SELECT, SHOW, DESCRIBE or EXPLAIN queries, mysqli_query() will return a mysqli_result object.
* For other successful queries mysqli_query() will return TRUE. Returns FALSE on failure
*/
public static function mysqli_query(
mysqli $link,
$query,
$logFailLevel = Log::LV_DEFAULT,
$resultmode = MYSQLI_STORE_RESULT
) {
try {
$result = mysqli_query($link, $query, $resultmode);
} catch (Exception $e) {
$result = false;
}
self::query_log_callback($link, $result, $query, $logFailLevel);
return $result;
}
/**
* Query log callback
*
* @param mysqli $link db connection
* @param mysqli_result|bool $result mysqli_result object or false on failure
* @param string $query query string
* @param int $logFailLevel ENUM Log::LV_*
*
* @return void
*/
public static function query_log_callback(mysqli $link, $result, $query, $logFailLevel = Log::LV_DEFAULT)
{
if ($result === false) {
if (Log::isLevel($logFailLevel)) {
$callers = debug_backtrace(); // phpcs:ignore PHPCompatibility.FunctionUse.ArgumentFunctionsReportCurrentValue.NeedsInspection
$file = $callers[0]['file'];
$line = $callers[0]['line'];
$queryLog = substr($query, 0, Log::isLevel(Log::LV_DEBUG) ? 10000 : 500);
Log::info('DB QUERY [ERROR][' . $file . ':' . $line . '] MSG: ' . mysqli_error($link) . "\n\tSQL: " . $queryLog);
Log::info(Log::traceToString($callers, 1));
}
} else {
if (Log::isLevel(Log::LV_HARD_DEBUG)) {
$callers = debug_backtrace(); // phpcs:ignore PHPCompatibility.FunctionUse.ArgumentFunctionsReportCurrentValue.NeedsInspection
$file = $callers[0]['file'];
$line = $callers[0]['line'];
Log::info('DB QUERY [' . $file . ':' . $line . ']: ' . Log::v2str(substr($query, 0, 2000)), Log::LV_HARD_DEBUG);
}
}
}
/**
* Chunks delete
*
* @param mysqli $dbh database connection
* @param string $table table name
* @param string $where where contidions
*
* @return int affected rows
*/
public static function chunksDelete($dbh, $table, $where)
{
$sql = 'DELETE FROM ' . mysqli_real_escape_string($dbh, $table) . ' WHERE ' . $where . ' LIMIT ' . self::DELETE_CHUNK_SIZE;
$totalAffectedRows = 0;
do {
DUPX_DB::queryNoReturn($dbh, $sql);
$affectRows = mysqli_affected_rows($dbh);
$totalAffectedRows += $affectRows;
} while ($affectRows >= self::DELETE_CHUNK_SIZE);
return $totalAffectedRows;
}
}