devilbox/.devilbox/www/htdocs/vendor/phpmyadmin-4.7/libraries/Tracker.php

874 lines
28 KiB
PHP

<?php
/* vim: set expandtab sw=4 ts=4 sts=4: */
/**
* Tracking changes on databases, tables and views
*
* @package PhpMyAdmin
*/
namespace PMA\libraries;
use PMA\libraries\plugins\export\ExportSql;
/**
* This class tracks changes on databases, tables and views.
*
* @package PhpMyAdmin
*
* @todo use stristr instead of strstr
*/
class Tracker
{
/**
* Whether tracking is ready.
*/
static protected $enabled = false;
/**
* Actually enables tracking. This needs to be done after all
* underlaying code is initialized.
*
* @static
*
* @return void
*/
static public function enable()
{
self::$enabled = true;
}
/**
* Gets the on/off value of the Tracker module, starts initialization.
*
* @static
*
* @return boolean (true=on|false=off)
*/
static public function isActive()
{
if (! self::$enabled) {
return false;
}
/* We need to avoid attempt to track any queries
* from PMA_getRelationsParam
*/
self::$enabled = false;
$cfgRelation = PMA_getRelationsParam();
/* Restore original state */
self::$enabled = true;
if (! $cfgRelation['trackingwork']) {
return false;
}
$pma_table = self::_getTrackingTable();
if (isset($pma_table)) {
return true;
} else {
return false;
}
}
/**
* Parses the name of a table from a SQL statement substring.
*
* @param string $string part of SQL statement
*
* @static
*
* @return string the name of table
*/
static protected function getTableName($string)
{
if (mb_strstr($string, '.')) {
$temp = explode('.', $string);
$tablename = $temp[1];
} else {
$tablename = $string;
}
$str = explode("\n", $tablename);
$tablename = $str[0];
$tablename = str_replace(';', '', $tablename);
$tablename = str_replace('`', '', $tablename);
$tablename = trim($tablename);
return $tablename;
}
/**
* Gets the tracking status of a table, is it active or deactive ?
*
* @param string $dbname name of database
* @param string $tablename name of table
*
* @static
*
* @return boolean true or false
*/
static public function isTracked($dbname, $tablename)
{
if (! self::$enabled) {
return false;
}
/* We need to avoid attempt to track any queries
* from PMA_getRelationsParam
*/
self::$enabled = false;
$cfgRelation = PMA_getRelationsParam();
/* Restore original state */
self::$enabled = true;
if (! $cfgRelation['trackingwork']) {
return false;
}
$sql_query = " SELECT tracking_active FROM " . self::_getTrackingTable() .
" WHERE db_name = '" . $GLOBALS['dbi']->escapeString($dbname) . "' " .
" AND table_name = '" . $GLOBALS['dbi']->escapeString($tablename) . "' " .
" ORDER BY version DESC LIMIT 1";
$result = $GLOBALS['dbi']->fetchValue($sql_query);
return ($result == 1);
}
/**
* Returns the comment line for the log.
*
* @return string Comment, contains date and username
*/
static public function getLogComment()
{
$date = date('Y-m-d H:i:s');
$user = preg_replace('/\s+/', ' ', $GLOBALS['cfg']['Server']['user']);
return "# log " . $date . " " . $user . "\n";
}
/**
* Creates tracking version of a table / view
* (in other words: create a job to track future changes on the table).
*
* @param string $dbname name of database
* @param string $tablename name of table
* @param string $version version
* @param string $tracking_set set of tracking statements
* @param bool $is_view if table is a view
*
* @static
*
* @return int result of version insertion
*/
static public function createVersion($dbname, $tablename, $version,
$tracking_set = '', $is_view = false
) {
global $sql_backquotes, $export_type;
if ($tracking_set == '') {
$tracking_set
= $GLOBALS['cfg']['Server']['tracking_default_statements'];
}
// get Export SQL instance
include_once "libraries/plugin_interface.lib.php";
/* @var $export_sql_plugin \PMA\libraries\plugins\export\ExportSql */
$export_sql_plugin = PMA_getPlugin(
"export",
"sql",
'libraries/plugins/export/',
array(
'export_type' => $export_type,
'single_table' => false,
)
);
$sql_backquotes = true;
$date = date('Y-m-d H:i:s');
// Get data definition snapshot of table
$columns = $GLOBALS['dbi']->getColumns($dbname, $tablename, null, true);
// int indices to reduce size
$columns = array_values($columns);
// remove Privileges to reduce size
for ($i = 0, $nb = count($columns); $i < $nb; $i++) {
unset($columns[$i]['Privileges']);
}
$indexes = $GLOBALS['dbi']->getTableIndexes($dbname, $tablename);
$snapshot = array('COLUMNS' => $columns, 'INDEXES' => $indexes);
$snapshot = serialize($snapshot);
// Get DROP TABLE / DROP VIEW and CREATE TABLE SQL statements
$sql_backquotes = true;
$create_sql = "";
if ($GLOBALS['cfg']['Server']['tracking_add_drop_table'] == true
&& $is_view == false
) {
$create_sql .= self::getLogComment()
. 'DROP TABLE IF EXISTS ' . Util::backquote($tablename) . ";\n";
}
if ($GLOBALS['cfg']['Server']['tracking_add_drop_view'] == true
&& $is_view == true
) {
$create_sql .= self::getLogComment()
. 'DROP VIEW IF EXISTS ' . Util::backquote($tablename) . ";\n";
}
$create_sql .= self::getLogComment() .
$export_sql_plugin->getTableDef($dbname, $tablename, "\n", "");
// Save version
$sql_query = "/*NOTRACK*/\n" .
"INSERT INTO " . self::_getTrackingTable() . " (" .
"db_name, " .
"table_name, " .
"version, " .
"date_created, " .
"date_updated, " .
"schema_snapshot, " .
"schema_sql, " .
"data_sql, " .
"tracking " .
") " .
"values (
'" . $GLOBALS['dbi']->escapeString($dbname) . "',
'" . $GLOBALS['dbi']->escapeString($tablename) . "',
'" . $GLOBALS['dbi']->escapeString($version) . "',
'" . $GLOBALS['dbi']->escapeString($date) . "',
'" . $GLOBALS['dbi']->escapeString($date) . "',
'" . $GLOBALS['dbi']->escapeString($snapshot) . "',
'" . $GLOBALS['dbi']->escapeString($create_sql) . "',
'" . $GLOBALS['dbi']->escapeString("\n") . "',
'" . $GLOBALS['dbi']->escapeString($tracking_set)
. "' )";
$result = PMA_queryAsControlUser($sql_query);
if ($result) {
// Deactivate previous version
self::deactivateTracking($dbname, $tablename, ($version - 1));
}
return $result;
}
/**
* Removes all tracking data for a table or a version of a table
*
* @param string $dbname name of database
* @param string $tablename name of table
* @param string $version version
*
* @static
*
* @return int result of version insertion
*/
static public function deleteTracking($dbname, $tablename, $version = '')
{
$sql_query = "/*NOTRACK*/\n"
. "DELETE FROM " . self::_getTrackingTable()
. " WHERE `db_name` = '"
. $GLOBALS['dbi']->escapeString($dbname) . "'"
. " AND `table_name` = '"
. $GLOBALS['dbi']->escapeString($tablename) . "'";
if ($version) {
$sql_query .= " AND `version` = '"
. $GLOBALS['dbi']->escapeString($version) . "'";
}
$result = PMA_queryAsControlUser($sql_query);
return $result;
}
/**
* Creates tracking version of a database
* (in other words: create a job to track future changes on the database).
*
* @param string $dbname name of database
* @param string $version version
* @param string $query query
* @param string $tracking_set set of tracking statements
*
* @static
*
* @return int result of version insertion
*/
static public function createDatabaseVersion($dbname, $version, $query,
$tracking_set = 'CREATE DATABASE,ALTER DATABASE,DROP DATABASE'
) {
$date = date('Y-m-d H:i:s');
if ($tracking_set == '') {
$tracking_set
= $GLOBALS['cfg']['Server']['tracking_default_statements'];
}
$create_sql = "";
if ($GLOBALS['cfg']['Server']['tracking_add_drop_database'] == true) {
$create_sql .= self::getLogComment()
. 'DROP DATABASE IF EXISTS ' . Util::backquote($dbname) . ";\n";
}
$create_sql .= self::getLogComment() . $query;
// Save version
$sql_query = "/*NOTRACK*/\n" .
"INSERT INTO " . self::_getTrackingTable() . " (" .
"db_name, " .
"table_name, " .
"version, " .
"date_created, " .
"date_updated, " .
"schema_snapshot, " .
"schema_sql, " .
"data_sql, " .
"tracking " .
") " .
"values (
'" . $GLOBALS['dbi']->escapeString($dbname) . "',
'" . $GLOBALS['dbi']->escapeString('') . "',
'" . $GLOBALS['dbi']->escapeString($version) . "',
'" . $GLOBALS['dbi']->escapeString($date) . "',
'" . $GLOBALS['dbi']->escapeString($date) . "',
'" . $GLOBALS['dbi']->escapeString('') . "',
'" . $GLOBALS['dbi']->escapeString($create_sql) . "',
'" . $GLOBALS['dbi']->escapeString("\n") . "',
'" . $GLOBALS['dbi']->escapeString($tracking_set)
. "' )";
$result = PMA_queryAsControlUser($sql_query);
return $result;
}
/**
* Changes tracking of a table.
*
* @param string $dbname name of database
* @param string $tablename name of table
* @param string $version version
* @param integer $new_state the new state of tracking
*
* @static
*
* @return int result of SQL query
*/
static private function _changeTracking($dbname, $tablename,
$version, $new_state
) {
$sql_query = " UPDATE " . self::_getTrackingTable() .
" SET `tracking_active` = '" . $new_state . "' " .
" WHERE `db_name` = '" . $GLOBALS['dbi']->escapeString($dbname) . "' " .
" AND `table_name` = '" . $GLOBALS['dbi']->escapeString($tablename) . "' " .
" AND `version` = '" . $GLOBALS['dbi']->escapeString($version) . "' ";
$result = PMA_queryAsControlUser($sql_query);
return $result;
}
/**
* Changes tracking data of a table.
*
* @param string $dbname name of database
* @param string $tablename name of table
* @param string $version version
* @param string $type type of data(DDL || DML)
* @param string|array $new_data the new tracking data
*
* @static
*
* @return bool result of change
*/
static public function changeTrackingData($dbname, $tablename,
$version, $type, $new_data
) {
if ($type == 'DDL') {
$save_to = 'schema_sql';
} elseif ($type == 'DML') {
$save_to = 'data_sql';
} else {
return false;
}
$date = date('Y-m-d H:i:s');
$new_data_processed = '';
if (is_array($new_data)) {
foreach ($new_data as $data) {
$new_data_processed .= '# log ' . $date . ' ' . $data['username']
. $GLOBALS['dbi']->escapeString($data['statement']) . "\n";
}
} else {
$new_data_processed = $new_data;
}
$sql_query = " UPDATE " . self::_getTrackingTable() .
" SET `" . $save_to . "` = '" . $new_data_processed . "' " .
" WHERE `db_name` = '" . $GLOBALS['dbi']->escapeString($dbname) . "' " .
" AND `table_name` = '" . $GLOBALS['dbi']->escapeString($tablename) . "' " .
" AND `version` = '" . $GLOBALS['dbi']->escapeString($version) . "' ";
$result = PMA_queryAsControlUser($sql_query);
return (boolean) $result;
}
/**
* Activates tracking of a table.
*
* @param string $dbname name of database
* @param string $tablename name of table
* @param string $version version
*
* @static
*
* @return int result of SQL query
*/
static public function activateTracking($dbname, $tablename, $version)
{
return self::_changeTracking($dbname, $tablename, $version, 1);
}
/**
* Deactivates tracking of a table.
*
* @param string $dbname name of database
* @param string $tablename name of table
* @param string $version version
*
* @static
*
* @return int result of SQL query
*/
static public function deactivateTracking($dbname, $tablename, $version)
{
return self::_changeTracking($dbname, $tablename, $version, 0);
}
/**
* Gets the newest version of a tracking job
* (in other words: gets the HEAD version).
*
* @param string $dbname name of database
* @param string $tablename name of table
* @param string $statement tracked statement
*
* @static
*
* @return int (-1 if no version exists | > 0 if a version exists)
*/
static public function getVersion($dbname, $tablename, $statement = null)
{
$sql_query = " SELECT MAX(version) FROM " . self::_getTrackingTable() .
" WHERE `db_name` = '" . $GLOBALS['dbi']->escapeString($dbname) . "' " .
" AND `table_name` = '" . $GLOBALS['dbi']->escapeString($tablename) . "' ";
if ($statement != "") {
$sql_query .= " AND FIND_IN_SET('"
. $statement . "',tracking) > 0" ;
}
$row = $GLOBALS['dbi']->fetchArray(PMA_queryAsControlUser($sql_query));
return isset($row[0])
? $row[0]
: -1;
}
/**
* Gets the record of a tracking job.
*
* @param string $dbname name of database
* @param string $tablename name of table
* @param string $version version number
*
* @static
*
* @return mixed record DDM log, DDL log, structure snapshot, tracked
* statements.
*/
static public function getTrackedData($dbname, $tablename, $version)
{
$sql_query = " SELECT * FROM " . self::_getTrackingTable() .
" WHERE `db_name` = '" . $GLOBALS['dbi']->escapeString($dbname) . "' ";
if (! empty($tablename)) {
$sql_query .= " AND `table_name` = '"
. $GLOBALS['dbi']->escapeString($tablename) . "' ";
}
$sql_query .= " AND `version` = '" . $GLOBALS['dbi']->escapeString($version)
. "' " . " ORDER BY `version` DESC LIMIT 1";
$mixed = $GLOBALS['dbi']->fetchAssoc(PMA_queryAsControlUser($sql_query));
// Parse log
$log_schema_entries = explode('# log ', $mixed['schema_sql']);
$log_data_entries = explode('# log ', $mixed['data_sql']);
$ddl_date_from = $date = date('Y-m-d H:i:s');
$ddlog = array();
$first_iteration = true;
// Iterate tracked data definition statements
// For each log entry we want to get date, username and statement
foreach ($log_schema_entries as $log_entry) {
if (trim($log_entry) != '') {
$date = mb_substr($log_entry, 0, 19);
$username = mb_substr(
$log_entry, 20, mb_strpos($log_entry, "\n") - 20
);
if ($first_iteration) {
$ddl_date_from = $date;
$first_iteration = false;
}
$statement = rtrim(mb_strstr($log_entry, "\n"));
$ddlog[] = array( 'date' => $date,
'username'=> $username,
'statement' => $statement );
}
}
$date_from = $ddl_date_from;
$ddl_date_to = $date;
$dml_date_from = $date_from;
$dmlog = array();
$first_iteration = true;
// Iterate tracked data manipulation statements
// For each log entry we want to get date, username and statement
foreach ($log_data_entries as $log_entry) {
if (trim($log_entry) != '') {
$date = mb_substr($log_entry, 0, 19);
$username = mb_substr(
$log_entry, 20, mb_strpos($log_entry, "\n") - 20
);
if ($first_iteration) {
$dml_date_from = $date;
$first_iteration = false;
}
$statement = rtrim(mb_strstr($log_entry, "\n"));
$dmlog[] = array( 'date' => $date,
'username' => $username,
'statement' => $statement );
}
}
$dml_date_to = $date;
// Define begin and end of date range for both logs
$data = array();
if (strtotime($ddl_date_from) <= strtotime($dml_date_from)) {
$data['date_from'] = $ddl_date_from;
} else {
$data['date_from'] = $dml_date_from;
}
if (strtotime($ddl_date_to) >= strtotime($dml_date_to)) {
$data['date_to'] = $ddl_date_to;
} else {
$data['date_to'] = $dml_date_to;
}
$data['ddlog'] = $ddlog;
$data['dmlog'] = $dmlog;
$data['tracking'] = $mixed['tracking'];
$data['schema_snapshot'] = $mixed['schema_snapshot'];
return $data;
}
/**
* Parses a query. Gets
* - statement identifier (UPDATE, ALTER TABLE, ...)
* - type of statement, is it part of DDL or DML ?
* - tablename
*
* @param string $query query
*
* @static
* @todo: using PMA SQL Parser when possible
* @todo: support multi-table/view drops
*
* @return mixed Array containing identifier, type and tablename.
*
*/
static public function parseQuery($query)
{
// Usage of PMA_SQP does not work here
//
// require_once("libraries/sqlparser.lib.php");
// $parsed_sql = PMA_SQP_parse($query);
// $sql_info = PMA_SQP_analyze($parsed_sql);
$parser = new \PhpMyAdmin\SqlParser\Parser($query);
$tokens = $parser->list->tokens;
// Parse USE statement, need it for SQL dump imports
if ($tokens[0]->value == 'USE') {
$GLOBALS['db'] = $tokens[2]->value;
}
$result = array();
if (!empty($parser->statements)) {
$statement = $parser->statements[0];
$options = isset($statement->options) ? $statement->options->options : null;
/*
* DDL statements
*/
$result['type'] = 'DDL';
// Parse CREATE statement
if ($statement instanceof \PhpMyAdmin\SqlParser\Statements\CreateStatement) {
if (empty($options) || !isset($options[6])) {
return $result;
}
if ($options[6] == 'VIEW' || $options[6] == 'TABLE') {
$result['identifier'] = 'CREATE ' . $options[6];
$result['tablename'] = $statement->name->table ;
} elseif ($options[6] == 'DATABASE') {
$result['identifier'] = 'CREATE DATABASE' ;
$result['tablename'] = '' ;
// In case of CREATE DATABASE, table field of the CreateStatement is actually name of the database
$GLOBALS['db'] = $statement->name->table;
} elseif ($options[6] == 'INDEX'
|| $options[6] == 'UNIQUE INDEX'
|| $options[6] == 'FULLTEXT INDEX'
|| $options[6] == 'SPATIAL INDEX'
){
$result['identifier'] = 'CREATE INDEX';
// In case of CREATE INDEX, we have to get the table name from body of the statement
$result['tablename'] = $statement->body[3]->value == '.' ? $statement->body[4]->value
: $statement->body[2]->value ;
}
}
// Parse ALTER statement
elseif ($statement instanceof \PhpMyAdmin\SqlParser\Statements\AlterStatement) {
if (empty($options) || !isset($options[3])) {
return $result;
}
if ($options[3] == 'VIEW' || $options[3] == 'TABLE') {
$result['identifier'] = 'ALTER ' . $options[3] ;
$result['tablename'] = $statement->table->table ;
} elseif ($options[3] == 'DATABASE') {
$result['identifier'] = 'ALTER DATABASE' ;
$result['tablename'] = '' ;
$GLOBALS['db'] = $statement->table->table ;
}
}
// Parse DROP statement
elseif ($statement instanceof \PhpMyAdmin\SqlParser\Statements\DropStatement) {
if (empty($options) || !isset($options[1])) {
return $result;
}
if ($options[1] == 'VIEW' || $options[1] == 'TABLE') {
$result['identifier'] = 'DROP ' . $options[1] ;
$result['tablename'] = $statement->fields[0]->table;
} elseif ($options[1] == 'DATABASE') {
$result['identifier'] = 'DROP DATABASE' ;
$result['tablename'] = '';
$GLOBALS['db'] = $statement->fields[0]->table;
} elseif ($options[1] == 'INDEX') {
$result['identifier'] = 'DROP INDEX' ;
$result['tablename'] = $statement->table->table;
}
}
// Prase RENAME statement
elseif ($statement instanceof \PhpMyAdmin\SqlParser\Statements\RenameStatement) {
$result['identifier'] = 'RENAME TABLE';
$result['tablename'] = $statement->renames[0]->old->table;
$result['tablename_after_rename'] = $statement->renames[0]->new->table;
}
if (isset($result['identifier'])) {
return $result ;
}
/*
* DML statements
*/
$result['type'] = 'DML';
// Parse UPDATE statement
if ($statement instanceof \PhpMyAdmin\SqlParser\Statements\UpdateStatement) {
$result['identifier'] = 'UPDATE';
$result['tablename'] = $statement->tables[0]->table;
}
// Parse INSERT INTO statement
if ($statement instanceof \PhpMyAdmin\SqlParser\Statements\InsertStatement) {
$result['identifier'] = 'INSERT';
$result['tablename'] = $statement->into->dest->table;
}
// Parse DELETE statement
if ($statement instanceof \PhpMyAdmin\SqlParser\Statements\DeleteStatement) {
$result['identifier'] = 'DELETE';
$result['tablename'] = $statement->from[0]->table;
}
// Parse TRUNCATE statement
if ($statement instanceof \PhpMyAdmin\SqlParser\Statements\TruncateStatement) {
$result['identifier'] = 'TRUNCATE' ;
$result['tablename'] = $statement->table->table;
}
}
return $result;
}
/**
* Analyzes a given SQL statement and saves tracking data.
*
* @param string $query a SQL query
*
* @static
*
* @return void
*/
static public function handleQuery($query)
{
// If query is marked as untouchable, leave
if (mb_strstr($query, "/*NOTRACK*/")) {
return;
}
if (! (substr($query, -1) == ';')) {
$query = $query . ";\n";
}
// Get some information about query
$result = self::parseQuery($query);
// Get database name
$dbname = trim(isset($GLOBALS['db']) ? $GLOBALS['db'] : '', '`');
// $dbname can be empty, for example when coming from Synchronize
// and this is a query for the remote server
if (empty($dbname)) {
return;
}
// If we found a valid statement
if (isset($result['identifier'])) {
$version = self::getVersion(
$dbname, $result['tablename'], $result['identifier']
);
// If version not exists and auto-creation is enabled
if ($GLOBALS['cfg']['Server']['tracking_version_auto_create'] == true
&& self::isTracked($dbname, $result['tablename']) == false
&& $version == -1
) {
// Create the version
switch ($result['identifier']) {
case 'CREATE TABLE':
self::createVersion($dbname, $result['tablename'], '1');
break;
case 'CREATE VIEW':
self::createVersion(
$dbname, $result['tablename'], '1', '', true
);
break;
case 'CREATE DATABASE':
self::createDatabaseVersion($dbname, '1', $query);
break;
} // end switch
}
// If version exists
if (self::isTracked($dbname, $result['tablename']) && $version != -1) {
if ($result['type'] == 'DDL') {
$save_to = 'schema_sql';
} elseif ($result['type'] == 'DML') {
$save_to = 'data_sql';
} else {
$save_to = '';
}
$date = date('Y-m-d H:i:s');
// Cut off `dbname`. from query
$query = preg_replace(
'/`' . preg_quote($dbname, '/') . '`\s?\./',
'',
$query
);
// Add log information
$query = self::getLogComment() . $query ;
// Mark it as untouchable
$sql_query = " /*NOTRACK*/\n"
. " UPDATE " . self::_getTrackingTable()
. " SET " . Util::backquote($save_to)
. " = CONCAT( " . Util::backquote($save_to) . ",'\n"
. $GLOBALS['dbi']->escapeString($query) . "') ,"
. " `date_updated` = '" . $date . "' ";
// If table was renamed we have to change
// the tablename attribute in pma_tracking too
if ($result['identifier'] == 'RENAME TABLE') {
$sql_query .= ', `table_name` = \''
. $GLOBALS['dbi']->escapeString($result['tablename_after_rename'])
. '\' ';
}
// Save the tracking information only for
// 1. the database
// 2. the table / view
// 3. the statements
// we want to track
$sql_query .=
" WHERE FIND_IN_SET('" . $result['identifier'] . "',tracking) > 0" .
" AND `db_name` = '" . $GLOBALS['dbi']->escapeString($dbname) . "' " .
" AND `table_name` = '"
. $GLOBALS['dbi']->escapeString($result['tablename']) . "' " .
" AND `version` = '" . $GLOBALS['dbi']->escapeString($version) . "' ";
PMA_queryAsControlUser($sql_query);
}
}
}
/**
* Returns the tracking table
*
* @return string tracking table
*/
private static function _getTrackingTable()
{
$cfgRelation = PMA_getRelationsParam();
return Util::backquote($cfgRelation['db'])
. '.' . Util::backquote($cfgRelation['tracking']);
}
}