| Current File : /home/pacjaorg/wpt.pacja.org/cop/libraries/fof40/Database/Installer.php |
<?php
/**
* @package FOF
* @copyright Copyright (c)2010-2022 Nicholas K. Dionysopoulos / Akeeba Ltd
* @license GNU General Public License version 3, or later
*/
namespace FOF40\Database;
defined('_JEXEC') || die;
use Exception;
use JDatabaseDriver;
use Joomla\CMS\Filesystem\Folder;
use Joomla\Database\DatabaseDriver;
use SimpleXMLElement;
class Installer
{
/** @var array Internal cache for table list */
protected static $allTables = [];
/** @var JDatabaseDriver The database connector object */
private $db;
/** @var string The directory where the XML schema files are stored */
private $xmlDirectory;
/** @var string|null Force a specific **absolute** file path for the XML schema file */
private $forcedFile;
/**
* Public constructor
*
* @param JDatabaseDriver|DatabaseDriver $db The database driver we're going to use to install the tables
* @param string $directory The directory holding the XML schema update files
*/
public function __construct($db, string $directory)
{
$this->db = $db;
$this->xmlDirectory = $directory;
}
/**
* Returns the directory where XML schema files are stored
*
* @return string
*
* @codeCoverageIgnore
*/
public function getXmlDirectory(): string
{
return $this->xmlDirectory;
}
/**
* Sets the directory where XML schema files are stored
*
* @param string $xmlDirectory
*
* @codeCoverageIgnore
*/
public function setXmlDirectory(string $xmlDirectory)
{
$this->xmlDirectory = $xmlDirectory;
}
/**
* Returns the absolute path to the forced XML schema file
*
* @return string
*
* @codeCoverageIgnore
*/
public function getForcedFile(): string
{
return $this->forcedFile;
}
/**
* Sets the absolute path to an XML schema file which will be read no matter what. Set to a blank string to let the
* Installer class auto-detect your schema file based on your database type.
*
* @param string $forcedFile
*
* @codeCoverageIgnore
*/
public function setForcedFile(string $forcedFile)
{
$this->forcedFile = $forcedFile;
}
/**
* Clears the internal table list cache
*
* @return void
*/
public function nukeCache(): void
{
static::$allTables = [];
}
/**
* Creates or updates the database schema
*
* @return void
*
* @throws Exception When a database query fails and it doesn't have the canfail flag
*/
public function updateSchema(): void
{
// Get the schema XML file
$xml = $this->findSchemaXml();
if (empty($xml))
{
return;
}
// Make sure there are SQL commands in this file
if (!$xml->sql)
{
return;
}
// Walk the sql > action tags to find all tables
/** @var SimpleXMLElement $actions */
$actions = $xml->sql->children();
/**
* The meta/autocollation node defines if I should automatically apply the correct collation (utf8 or utf8mb4)
* to the database tables managed by the schema updater. When enabled (default) the queries are automatically
* converted to the correct collation (utf8mb4_unicode_ci or utf8_general_ci) depending on whether your Joomla!
* and MySQL server support Multibyte UTF-8 (UTF8MB4). Moreover, if UTF8MB4 is supported, all CREATE TABLE
* queries are analyzed and the tables referenced in them are auto-converted to the proper utf8mb4 collation.
*/
$autoCollationConversion = true;
if ($xml->meta->autocollation)
{
$value = (string) $xml->meta->autocollation;
$value = trim($value);
$value = strtolower($value);
$autoCollationConversion = in_array($value, ['true', '1', 'on', 'yes']);
}
$hasUtf8mb4Support = method_exists($this->db, 'hasUTF8mb4Support') && $this->db->hasUTF8mb4Support();
$tablesToConvert = [];
// If we have an uppercase db prefix we can expect CREATE TABLE fail because we cannot detect reliably
// the existence of database tables. See https://github.com/joomla/joomla-cms/issues/10928#issuecomment-228549658
$prefix = $this->db->getPrefix();
$canFailCreateTable = preg_match('/[A-Z]/', $prefix);
/** @var SimpleXMLElement $action */
foreach ($actions as $action)
{
// Get the attributes
$attributes = $action->attributes();
// Get the table / view name
$table = $attributes->table ? (string) $attributes->table : '';
if (empty($table))
{
continue;
}
// Am I allowed to let this action fail?
$canFailAction = $attributes->canfail ?: 0;
// Evaluate conditions
$shouldExecute = true;
/** @var SimpleXMLElement $node */
foreach ($action->children() as $node)
{
if ($node->getName() == 'condition')
{
// Get the operator
$operator = $node->attributes()->operator ? (string) $node->attributes()->operator : 'and';
$operator = empty($operator) ? 'and' : $operator;
$condition = $this->conditionMet($table, $node);
switch ($operator)
{
case 'not':
$shouldExecute = $shouldExecute && !$condition;
break;
case 'or':
$shouldExecute = $shouldExecute || $condition;
break;
case 'nor':
$shouldExecute = !$shouldExecute && !$condition;
break;
case 'xor':
$shouldExecute = ($shouldExecute xor $condition);
break;
case 'maybe':
$shouldExecute = $condition ? true : $shouldExecute;
break;
default:
$shouldExecute = $shouldExecute && $condition;
break;
}
}
// DO NOT USE BOOLEAN SHORT CIRCUIT EVALUATION!
// if (!$shouldExecute) break;
}
// Do I have to only collect the tables from CREATE TABLE queries?
$onlyCollectTables = !$shouldExecute && $autoCollationConversion && $hasUtf8mb4Support;
// Make sure all conditions are met OR I have to collect tables from CREATE TABLE queries.
if (!$shouldExecute && !$onlyCollectTables)
{
continue;
}
// Execute queries
foreach ($action->children() as $node)
{
if ($node->getName() == 'query')
{
$query = (string) $node;
if ($autoCollationConversion && $hasUtf8mb4Support)
{
$this->extractTablesToConvert($query, $tablesToConvert);
}
// If we're only collecting tables do not run the queries
if ($onlyCollectTables)
{
continue;
}
$canFail = $node->attributes->canfail ? (string) $node->attributes->canfail : $canFailAction;
if (is_string($canFail))
{
$canFail = strtoupper($canFail);
}
$canFail = (in_array($canFail, [true, 1, 'YES', 'TRUE']));
// Do I need to automatically convert the collation of all CREATE / ALTER queries?
if ($autoCollationConversion)
{
$query = $hasUtf8mb4Support ? $this->convertUtf8QueryToUtf8mb4($query) : $this->convertUtf8mb4QueryToUtf8($query);
}
try
{
$this->db->setQuery($query);
$this->db->execute();
}
catch (Exception $e)
{
// Special consideration for CREATE TABLE commands on uppercase prefix databases.
if ($canFailCreateTable && stripos($query, 'CREATE TABLE') !== false)
{
$canFail = true;
}
// If we are not allowed to fail, throw back the exception we caught
if (!$canFail)
{
throw $e;
}
}
}
}
}
// Auto-convert the collation of tables if we are told to do so, have utf8mb4 support and a list of tables.
if (!$autoCollationConversion)
{
return;
}
if (!$hasUtf8mb4Support)
{
return;
}
if (empty($tablesToConvert))
{
return;
}
$this->convertTablesToUtf8mb4($tablesToConvert);
}
/**
* Uninstalls the database schema
*
* @return void
*/
public function removeSchema(): void
{
// Get the schema XML file
$xml = $this->findSchemaXml();
if (empty($xml))
{
return;
}
// Make sure there are SQL commands in this file
if (!$xml->sql)
{
return;
}
// Walk the sql > action tags to find all tables
$tables = [];
/** @var SimpleXMLElement $actions */
$actions = $xml->sql->children();
/** @var SimpleXMLElement $action */
foreach ($actions as $action)
{
$attributes = $action->attributes();
$table = $attributes->table ? (string) $attributes->table : '';
$isCreate = false;
foreach ($action->children() as $node)
{
if ($node->getName() != 'query')
{
continue;
}
$query = (string) $node;
// Normalize the whitespace of the query
$query = trim($query);
$query = str_replace(["\r\n", "\r", "\n"], ' ', $query);
while (strstr($query, ' ') !== false)
{
$query = str_replace(' ', ' ', $query);
}
// Is it a create table query?
$queryStart = substr($query, 0, 12);
$queryStart = strtoupper($queryStart);
$isCreate = $isCreate || ($queryStart == 'CREATE TABLE');
if ($isCreate)
{
break;
}
}
// Only take into account actions with a CREATE TABLE command.
if ($isCreate)
{
$tables[] = $table;
}
}
// Simplify the tables list
$tables = array_unique($tables);
// Start dropping tables
foreach ($tables as $table)
{
try
{
$this->db->dropTable($table);
}
catch (Exception $e)
{
// Do not fail if I can't drop the table
}
}
}
/**
* Find an suitable schema XML file for this database type and return the SimpleXMLElement holding its information
*
* @return null|SimpleXMLElement Null if no suitable schema XML file is found
*/
protected function findSchemaXml(): ?SimpleXMLElement
{
$xml = null;
// Do we have a forced file?
if (!empty($this->forcedFile))
{
$xml = $this->openAndVerify($this->forcedFile);
if (!is_null($xml))
{
return $xml;
}
}
// Get all XML files in the schema directory
$xmlFiles = Folder::files($this->xmlDirectory, '\.xml$');
if (empty($xmlFiles))
{
return $xml;
}
foreach ($xmlFiles as $baseName)
{
// Remove any accidental whitespace
$baseName = trim($baseName);
// Get the full path to the file
$fileName = $this->xmlDirectory . '/' . $baseName;
$xml = $this->openAndVerify($fileName);
if (!is_null($xml))
{
return $xml;
}
}
return null;
}
/**
* Opens the schema XML file and return the SimpleXMLElement holding its information. If the file doesn't exist, it
* is not a schema file or it doesn't match our database driver we return boolean false.
*
* @return false|SimpleXMLElement False if it's not a suitable XML schema file
*/
protected function openAndVerify($fileName): ?SimpleXMLElement
{
$driverType = $this->db->name;
// Make sure the file exists
if (!@file_exists($fileName))
{
return null;
}
// Make sure the file is a valid XML document
try
{
$xml = new SimpleXMLElement($fileName, LIBXML_NONET, true);
}
catch (Exception $e)
{
$xml = null;
return null;
}
// Make sure the file is an XML schema file
if ($xml->getName() != 'schema')
{
$xml = null;
return null;
}
if (!$xml->meta)
{
$xml = null;
return null;
}
if (!$xml->meta->drivers)
{
$xml = null;
return null;
}
/** @var SimpleXMLElement $drivers */
$drivers = $xml->meta->drivers;
foreach ($drivers->children() as $driverTypeTag)
{
if ((string) $driverTypeTag === $driverType)
{
return $xml;
}
}
// Some custom database drivers use a non-standard $name variable. Let try a relaxed match.
foreach ($drivers->children() as $driverTypeTag)
{
$thisDriverType = (string) $driverTypeTag;
if (
// e.g. $driverType = 'mysqlisilly', $thisDriverType = 'mysqli' => driver matched
strpos($driverType, $thisDriverType) === 0
// e.g. $driverType = 'sillymysqli', $thisDriverType = 'mysqli' => driver matched
|| (substr($driverType, -strlen($thisDriverType)) === $thisDriverType)
)
{
return $xml;
}
}
return null;
}
/**
* Checks if a condition is met
*
* @param string $table The table we're operating on
* @param SimpleXMLElement $node The condition definition node
*
* @return bool
*/
protected function conditionMet(string $table, SimpleXMLElement $node): bool
{
if (empty(static::$allTables))
{
static::$allTables = $this->db->getTableList();
}
// Does the table exist?
$tableNormal = $this->db->replacePrefix($table);
$tableExists = in_array($tableNormal, static::$allTables);
// Initialise
$condition = false;
// Get the condition's attributes
$attributes = $node->attributes();
$type = $attributes->type ?: null;
$value = $attributes->value ? (string) $attributes->value : null;
switch ($type)
{
// Check if a table or column is missing
case 'missing':
$fieldName = (string) $value;
if (empty($fieldName))
{
$condition = !$tableExists;
}
else
{
try
{
$tableColumns = $this->db->getTableColumns($tableNormal, true);
}
catch (Exception $e)
{
$tableColumns = [];
}
$condition = !array_key_exists($fieldName, $tableColumns);
}
break;
// Check if a column type matches the "coltype" attribute
case 'type':
try
{
$tableColumns = $this->db->getTableColumns($tableNormal, true);
}
catch (Exception $e)
{
$tableColumns = [];
}
$condition = false;
if (array_key_exists($value, $tableColumns))
{
$coltype = $attributes->coltype ?: null;
if (!empty($coltype))
{
$coltype = strtolower($coltype);
$currentType = is_string($tableColumns[$value]) ? $tableColumns[$value] : strtolower($tableColumns[$value]->Type);
$condition = ($coltype === $currentType);
}
}
break;
// Check if a column is nullable
case 'nullable':
try
{
$tableColumns = $this->db->getTableColumns($tableNormal, true);
}
catch (Exception $e)
{
$tableColumns = [];
}
$condition = false;
if (array_key_exists($value, $tableColumns))
{
$condition = (is_string($tableColumns[$value]) ? 'YES' : strtolower($tableColumns[$value]->Null)) == 'yes';
}
break;
// Check if a (named) index exists on the table. Currently only supported on MySQL.
case 'index':
$indexName = (string) $value;
$condition = true;
if (!empty($indexName))
{
$indexName = str_replace('#__', $this->db->getPrefix(), $indexName);
$condition = $this->hasIndex($tableNormal, $indexName);
}
break;
// Check if a table or column needs to be upgraded to utf8mb4
case 'utf8mb4upgrade':
$condition = false;
// Check if the driver and the database connection have UTF8MB4 support
if (method_exists($this->db, 'hasUTF8mb4Support') && $this->db->hasUTF8mb4Support())
{
$fieldName = (string) $value;
if (empty($fieldName))
{
$collation = $this->getTableCollation($tableNormal);
}
else
{
$collation = $this->getColumnCollation($tableNormal, $fieldName);
}
$parts = explode('_', $collation, 3);
$encoding = empty($parts[0]) ? '' : strtolower($parts[0]);
$condition = $encoding != 'utf8mb4';
}
break;
// Check if the result of a query matches our expectation
case 'equals':
$query = (string) $node;
try
{
// DO NOT use $this->db->replacePrefix. It does not replace the prefix in strings, only entity names
$query = str_replace('#__', $this->db->getPrefix(), $query);
$this->db->setQuery($query);
$result = $this->db->loadResult();
$condition = ($result == $value);
}
catch (Exception $e)
{
return false;
}
break;
// Always returns true
case 'true':
return true;
default:
return false;
}
return $condition;
}
/**
* Get the collation of a table. Uses an internal cache for efficiency.
*
* @param string $tableName The name of the table
*
* @return string The collation, e.g. "utf8_general_ci"
*/
private function getTableCollation(string $tableName): string
{
static $cache = [];
$tableName = $this->db->replacePrefix($tableName);
if (!isset($cache[$tableName]))
{
$cache[$tableName] = $this->realGetTableCollation($tableName);
}
return $cache[$tableName];
}
/**
* Get the collation of a table. This is the internal method used by getTableCollation.
*
* @param string $tableName The name of the table
*
* @return string The collation, e.g. "utf8_general_ci"
*/
private function realGetTableCollation(string $tableName): string
{
$utf8Support = method_exists($this->db, 'hasUTFSupport') && $this->db->hasUTFSupport();
$utf8mb4Support = $utf8Support && method_exists($this->db, 'hasUTF8mb4Support') && $this->db->hasUTF8mb4Support();
$collation = $utf8mb4Support ? 'utf8mb4_unicode_ci' : ($utf8Support ? 'utf_general_ci' : 'latin1_swedish_ci');
$query = 'SHOW TABLE STATUS LIKE ' . $this->db->q($tableName);
try
{
$row = $this->db->setQuery($query)->loadAssoc();
}
catch (Exception $e)
{
return $collation;
}
if (empty($row))
{
return $collation;
}
if (!isset($row['Collation']))
{
return $collation;
}
if (empty($row['Collation']))
{
return $collation;
}
return $row['Collation'];
}
/**
* Get the collation of a column. Uses an internal cache for efficiency.
*
* @param string $tableName The name of the table
* @param string $columnName The name of the column
*
* @return string The collation, e.g. "utf8_general_ci"
*/
private function getColumnCollation(string $tableName, string $columnName): string
{
static $cache = [];
$tableName = $this->db->replacePrefix($tableName);
$columnName = $this->db->replacePrefix($columnName);
if (!isset($cache[$tableName]))
{
$cache[$tableName] = [];
}
if (!isset($cache[$tableName][$columnName]))
{
$cache[$tableName][$columnName] = $this->realGetColumnCollation($tableName, $columnName);
}
return $cache[$tableName][$columnName];
}
/**
* Get the collation of a column. This is the internal method used by getColumnCollation.
*
* @param string $tableName The name of the table
* @param string $columnName The name of the column
*
* @return string The collation, e.g. "utf8_general_ci"
*/
private function realGetColumnCollation(string $tableName, string $columnName): string
{
$collation = $this->getTableCollation($tableName);
$query = 'SHOW FULL COLUMNS FROM ' . $this->db->qn($tableName) . ' LIKE ' . $this->db->q($columnName);
try
{
$row = $this->db->setQuery($query)->loadAssoc();
}
catch (Exception $e)
{
return $collation;
}
if (empty($row))
{
return $collation;
}
if (!isset($row['Collation']))
{
return $collation;
}
if (empty($row['Collation']))
{
return $collation;
}
return $row['Collation'];
}
/**
* Automatically downgrade a CREATE TABLE or ALTER TABLE query from utf8mb4 (UTF-8 Multibyte) to plain utf8.
*
* We use our own method so we can be site it works even on Joomla! 3.4 or earlier, where UTF8MB4 support is not
* implemented.
*
* @param string $query The query to convert
*
* @return string The converted query
*/
private function convertUtf8mb4QueryToUtf8(string $query): string
{
// If it's not an ALTER TABLE or CREATE TABLE command there's nothing to convert
$beginningOfQuery = substr($query, 0, 12);
$beginningOfQuery = strtoupper($beginningOfQuery);
if (!in_array($beginningOfQuery, ['ALTER TABLE ', 'CREATE TABLE']))
{
return $query;
}
// Replace utf8mb4 with utf8
$from = [
'utf8mb4_unicode_ci',
'utf8mb4_',
'utf8mb4',
];
$to = [
'utf8_general_ci', // Yeah, we convert utf8mb4_unicode_ci to utf8_general_ci per Joomla!'s conventions
'utf8_',
'utf8',
];
return str_replace($from, $to, $query);
}
/**
* Automatically upgrade a CREATE TABLE or ALTER TABLE query from plain utf8 to utf8mb4 (UTF-8 Multibyte).
*
* @param string $query The query to convert
*
* @return string The converted query
*/
private function convertUtf8QueryToUtf8mb4(string $query): string
{
// If it's not an ALTER TABLE or CREATE TABLE command there's nothing to convert
$beginningOfQuery = substr($query, 0, 12);
$beginningOfQuery = strtoupper($beginningOfQuery);
if (!in_array($beginningOfQuery, ['ALTER TABLE ', 'CREATE TABLE']))
{
return $query;
}
// Replace utf8 with utf8mb4
$from = [
'utf8_general_ci',
'utf8_',
'utf8',
];
$to = [
'utf8mb4_unicode_ci', // Yeah, we convert utf8_general_ci to utf8mb4_unicode_ci per Joomla!'s conventions
'utf8mb4_',
'utf8mb4',
];
return str_replace($from, $to, $query);
}
/**
* Analyzes a query. If it's a CREATE TABLE query the table is added to the $tables array.
*
* @param string $query The query to analyze
* @param string[] $tables The array where the name of the detected table is added
*
* @return void
*/
private function extractTablesToConvert(string $query, array &$tables): void
{
// Normalize the whitespace of the query
$query = trim($query);
$query = str_replace(["\r\n", "\r", "\n"], ' ', $query);
while (strstr($query, ' ') !== false)
{
$query = str_replace(' ', ' ', $query);
}
// Is it a create table query?
$queryStart = substr($query, 0, 12);
$queryStart = strtoupper($queryStart);
if ($queryStart != 'CREATE TABLE')
{
return;
}
// Remove the CREATE TABLE keyword. Also, If there's an IF NOT EXISTS clause remove it.
$query = substr($query, 12);
$query = str_ireplace('IF NOT EXISTS', '', $query);
$query = trim($query);
// Make sure there is a space between the table name and its definition, denoted by an open parenthesis
$query = str_replace('(', ' (', $query);
// Now we should have the name of the table, a space and the rest of the query. Extract the table name.
$parts = explode(' ', $query, 2);
$tableName = $parts[0];
/**
* The table name may be quoted. Since UTF8MB4 is only supported in MySQL, the table name can only be
* quoted with surrounding backticks. Therefore we can trim backquotes from the table name to unquote it!
**/
$tableName = trim($tableName, '`');
// Finally, add the table name to $tables if it doesn't already exist.
if (!in_array($tableName, $tables))
{
$tables[] = $tableName;
}
}
/**
* Converts the collation of tables listed in $tablesToConvert to utf8mb4_unicode_ci
*
* @param array $tablesToConvert The list of tables to convert
*
* @return void
*/
private function convertTablesToUtf8mb4(array $tablesToConvert): void
{
// Make sure the database driver REALLY has support for converting character sets
if (!method_exists($this->db, 'getAlterTableCharacterSet'))
{
return;
}
asort($tablesToConvert);
foreach ($tablesToConvert as $tableName)
{
$collation = $this->getTableCollation($tableName);
$parts = explode('_', $collation, 3);
$encoding = empty($parts[0]) ? '' : strtolower($parts[0]);
if ($encoding != 'utf8mb4')
{
$queries = $this->db->getAlterTableCharacterSet($tableName);
try
{
foreach ($queries as $query)
{
$this->db->setQuery($query)->execute();
}
}
catch (Exception $e)
{
// We ignore failed conversions. Remember, you MUST change your indices MANUALLY.
}
}
}
}
/**
* Returns true if table $tableName has an index named $indexName or if it's impossible to retrieve index names for
* the table (not enough privileges, not a MySQL database, ...)
*
* @param string $tableName The name of the table
* @param string $indexName The name of the index
*
* @return bool
*/
private function hasIndex(string $tableName, string $indexName): bool
{
static $isMySQL = null;
static $cache = [];
if (is_null($isMySQL))
{
$driverType = $this->db->name;
$driverType = strtolower($driverType);
$isMySQL = true;
if (
!strpos($driverType, 'mysql') === 0
&& substr($driverType, -5) != 'mysql'
&& substr($driverType, -6) != 'mysqli'
)
{
$isMySQL = false;
}
}
// Not MySQL? Lie and return true.
if (!$isMySQL)
{
return true;
}
if (!isset($cache[$tableName]))
{
$cache[$tableName] = [];
}
if (!isset($cache[$tableName][$indexName]))
{
$cache[$tableName][$indexName] = true;
try
{
$indices = [];
$query = 'SHOW INDEXES FROM ' . $this->db->qn($tableName);
$indexDefinitions = $this->db->setQuery($query)->loadAssocList();
if (!empty($indexDefinitions) && is_array($indexDefinitions))
{
foreach ($indexDefinitions as $def)
{
$indices[] = $def['Key_name'];
}
$indices = array_unique($indices);
}
$cache[$tableName][$indexName] = in_array($indexName, $indices);
}
catch (Exception $e)
{
// Ignore errors
}
}
return $cache[$tableName][$indexName];
}
}