friendica/src/Database/DBStructure.php

926 lines
28 KiB
PHP
Raw Normal View History

<?php
2017-12-02 00:13:39 +01:00
/**
2023-01-01 15:36:24 +01:00
* @copyright Copyright (C) 2010-2023, the Friendica project
2020-02-09 15:45:36 +01:00
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*
2017-12-02 00:13:39 +01:00
*/
2018-12-23 21:32:23 +01:00
2017-12-14 22:14:02 +01:00
namespace Friendica\Database;
use Exception;
2018-10-29 22:20:46 +01:00
use Friendica\Core\Logger;
use Friendica\DI;
use Friendica\Model\Item;
use Friendica\Model\User;
use Friendica\Util\DateTimeFormat;
use Friendica\Util\Writer\DbaDefinitionSqlWriter;
2017-12-14 22:14:02 +01:00
/**
* This class contains functions that doesn't need to know if pdo, mysqli or whatever is used.
*/
class DBStructure
{
const UPDATE_NOT_CHECKED = 0; // Database check wasn't executed before
const UPDATE_SUCCESSFUL = 1; // Database check was successful
const UPDATE_FAILED = 2; // Database check failed
2018-12-23 21:32:23 +01:00
const RENAME_COLUMN = 0;
const RENAME_PRIMARY_KEY = 1;
2020-09-13 17:57:24 +02:00
/**
* Set a database version to trigger update functions
*
* @param string $version
* @return void
*/
public static function setDatabaseVersion(string $version)
{
if (!is_numeric($version)) {
throw new \Asika\SimpleConsole\CommandArgsException('The version number must be numeric');
}
DI::keyValue()->set('build', $version);
2020-09-13 17:57:24 +02:00
echo DI::l10n()->t('The database version had been set to %s.', $version);
}
2020-12-20 15:01:46 +01:00
/**
* Drop unused tables
*
* @param boolean $execute
* @return void
*/
public static function dropTables(bool $execute)
{
$postupdate = DI::keyValue()->get('post_update_version') ?? PostUpdate::VERSION;
2021-01-30 23:03:53 +01:00
if ($postupdate < PostUpdate::VERSION) {
echo DI::l10n()->t('The post update is at version %d, it has to be at %d to safely drop the tables.', $postupdate, PostUpdate::VERSION);
return;
}
$old_tables = ['fserver', 'gcign', 'gcontact', 'gcontact-relation', 'gfollower' ,'glink', 'item-delivery-data',
'item-activity', 'item-content', 'item_id', 'participation', 'poll', 'poll_result', 'queue', 'retriever_rule',
2021-07-20 19:41:04 +02:00
'deliverq', 'dsprphotoq', 'ffinder', 'sign', 'spam', 'term', 'user-item', 'thread', 'item', 'challenge',
2023-02-04 20:52:24 +01:00
'auth_codes', 'tokens', 'clients', 'profile_check', 'host', 'conversation', 'fcontact', 'addon'];
2020-12-20 15:01:46 +01:00
$tables = DBA::selectToArray('INFORMATION_SCHEMA.TABLES', ['TABLE_NAME'],
2020-12-20 15:01:46 +01:00
['TABLE_SCHEMA' => DBA::databaseName(), 'TABLE_TYPE' => 'BASE TABLE']);
if (empty($tables)) {
echo DI::l10n()->t('No unused tables found.');
return;
}
if (!$execute) {
echo DI::l10n()->t('These tables are not used for friendica and will be deleted when you execute "dbstructure drop -e":') . "\n\n";
}
foreach ($old_tables as $table) {
if (in_array($table, array_column($tables, 'TABLE_NAME'))) {
2020-12-20 15:01:46 +01:00
if ($execute) {
$sql = 'DROP TABLE ' . DBA::quoteIdentifier($table) . ';';
2020-12-20 15:01:46 +01:00
echo $sql . "\n";
$result = DBA::e($sql);
if (!DBA::isResult($result)) {
self::printUpdateError($sql);
}
} else {
echo $table . "\n";
2020-12-20 15:01:46 +01:00
}
}
}
}
2020-01-19 11:10:53 +01:00
/**
* Converts all tables from MyISAM/InnoDB Antelope to InnoDB Barracuda
2017-12-14 22:14:02 +01:00
*/
2018-12-23 21:32:23 +01:00
public static function convertToInnoDB()
{
$tables = DBA::selectToArray(
'information_schema.tables',
['table_name'],
['engine' => 'MyISAM', 'table_schema' => DBA::databaseName()]
);
2017-12-14 22:14:02 +01:00
$tables = array_merge($tables, DBA::selectToArray(
'information_schema.tables',
['table_name'],
['engine' => 'InnoDB', 'ROW_FORMAT' => ['COMPACT', 'REDUNDANT'], 'table_schema' => DBA::databaseName()]
));
if (!DBA::isResult($tables)) {
echo DI::l10n()->t('There are no tables on MyISAM or InnoDB with the Antelope file format.') . "\n";
2017-12-14 22:14:02 +01:00
return;
}
2021-10-03 12:34:41 +02:00
foreach ($tables as $table) {
$sql = "ALTER TABLE " . DBA::quoteIdentifier($table['table_name']) . " ENGINE=InnoDB ROW_FORMAT=DYNAMIC;";
2018-12-23 21:32:23 +01:00
echo $sql . "\n";
2017-12-14 22:14:02 +01:00
$result = DBA::e($sql);
2018-07-21 14:46:04 +02:00
if (!DBA::isResult($result)) {
2017-12-14 22:14:02 +01:00
self::printUpdateError($sql);
}
}
}
2018-12-23 21:32:23 +01:00
/**
2020-01-19 07:05:23 +01:00
* Print out database error messages
2018-12-23 21:32:23 +01:00
*
* @param string $message Message to be added to the error message
2022-07-13 00:23:12 +02:00
*
2018-12-23 21:32:23 +01:00
* @return string Error message
*/
private static function printUpdateError(string $message): string
2018-12-23 21:32:23 +01:00
{
echo DI::l10n()->t("\nError %d occurred during database update:\n%s\n",
2018-12-23 21:32:23 +01:00
DBA::errorNo(), DBA::errorMessage());
2022-10-18 14:29:50 +02:00
return DI::l10n()->t('Errors encountered performing database changes: ') . $message . '<br />';
2018-12-23 21:32:23 +01:00
}
/**
* Perform a database structure dryrun (means: just simulating)
*
2022-07-13 00:23:12 +02:00
* @return string Empty string if the update is successful, error messages otherwise
* @throws Exception
*/
public static function dryRun(): string
{
return self::update(true, false);
}
/**
* Updates DB structure and returns eventual errors messages
*
* @param bool $enable_maintenance_mode Set the maintenance mode
* @param bool $verbose Display the SQL commands
*
* @return string Empty string if the update is successful, error messages otherwise
* @throws Exception
*/
public static function performUpdate(bool $enable_maintenance_mode = true, bool $verbose = false): string
{
if ($enable_maintenance_mode) {
DI::config()->set('system', 'maintenance', true);
}
$status = self::update($verbose, true);
if ($enable_maintenance_mode) {
2023-01-03 17:24:05 +01:00
DI::config()->beginTransaction()
->set('system', 'maintenance', false)
->delete('system', 'maintenance_reason')
2023-01-03 17:24:05 +01:00
->commit();
}
return $status;
}
/**
* Updates DB structure from the installation and returns eventual errors messages
*
* @return string Empty string if the update is successful, error messages otherwise
* @throws Exception
*/
public static function install(): string
{
return self::update(false, true, true);
}
/**
* Updates DB structure and returns eventual errors messages
*
* @param bool $verbose
* @param bool $action Whether to actually apply the update
* @param bool $install Is this the initial update during the installation?
* @param array $tables An array of the database tables
* @param array $definition An array of the definition tables
* @return string Empty string if the update is successful, error messages otherwise
2019-01-06 22:06:53 +01:00
* @throws Exception
*/
private static function update(bool $verbose, bool $action, bool $install = false, array $tables = null, array $definition = null): string
2018-12-23 21:32:23 +01:00
{
2022-12-29 23:38:14 +01:00
$in_maintenance_mode = DI::config()->get('system', 'maintenance');
if ($action && !$install && self::isUpdating()) {
return DI::l10n()->t('Another database update is currently running.');
}
if ($in_maintenance_mode) {
DI::config()->set('system', 'maintenance_reason', DI::l10n()->t('%s: Database update', DateTimeFormat::utcNow() . ' ' . date('e')));
2017-12-14 22:14:02 +01:00
}
2014-09-04 00:58:52 +02:00
2020-05-15 19:49:07 +02:00
// ensure that all initial values exist. This test has to be done prior and after the structure check.
// Prior is needed if the specific tables already exists - after is needed when they had been created.
self::checkInitialValues();
$errors = '';
2020-11-18 10:14:12 +01:00
Logger::info('updating structure');
2017-12-14 22:14:02 +01:00
// Get the current structure
$database = [];
2017-12-14 22:14:02 +01:00
if (is_null($tables)) {
2020-05-10 16:55:03 +02:00
$tables = DBA::toArray(DBA::p("SHOW TABLES"));
}
2018-07-21 14:46:04 +02:00
if (DBA::isResult($tables)) {
2021-10-03 12:34:41 +02:00
foreach ($tables as $table) {
2017-12-14 22:14:02 +01:00
$table = current($table);
2020-11-18 10:14:12 +01:00
Logger::info('updating structure', ['table' => $table]);
2017-12-14 22:14:02 +01:00
$database[$table] = self::tableStructure($table);
}
2017-12-14 22:14:02 +01:00
}
// Get the definition
if (is_null($definition)) {
// just for Update purpose, reload the DBA definition with addons to explicit get the whole definition
$definition = DI::dbaDefinition()->load(true)->getAll();
2017-12-14 22:14:02 +01:00
}
// MySQL >= 5.7.4 doesn't support the IGNORE keyword in ALTER TABLE statements
if ((version_compare(DBA::serverInfo(), '5.7.4') >= 0) &&
!(strpos(DBA::serverInfo(), 'MariaDB') !== false)) {
2017-12-14 22:14:02 +01:00
$ignore = '';
} else {
2017-12-14 22:14:02 +01:00
$ignore = ' IGNORE';
}
// Compare it
2021-10-03 12:34:41 +02:00
foreach ($definition as $name => $structure) {
$is_new_table = false;
$sql3 = "";
2017-12-14 22:14:02 +01:00
if (!isset($database[$name])) {
$sql = DbaDefinitionSqlWriter::createTable($name, $structure, $verbose, $action);
if ($verbose) {
echo $sql;
}
if ($action) {
$r = DBA::e($sql);
if (!DBA::isResult($r)) {
$errors .= self::printUpdateError($name);
}
2017-01-16 00:30:43 +01:00
}
$is_new_table = true;
2017-12-14 22:14:02 +01:00
} else {
/*
* Drop the index if it isn't present in the definition
* or the definition differ from current status
* and index name doesn't start with "local_"
*/
foreach ($database[$name]["indexes"] as $indexName => $fieldNames) {
$current_index_definition = implode(",", $fieldNames);
if (isset($structure["indexes"][$indexName])) {
$new_index_definition = implode(",", $structure["indexes"][$indexName]);
} else {
2017-12-14 22:14:02 +01:00
$new_index_definition = "__NOT_SET__";
}
if ($current_index_definition != $new_index_definition && substr($indexName, 0, 6) != 'local_') {
$sql2 = DbaDefinitionSqlWriter::dropIndex($indexName);
2017-12-14 22:14:02 +01:00
if ($sql3 == "") {
2021-09-26 20:30:44 +02:00
$sql3 = "ALTER" . $ignore . " TABLE `" . $name . "` " . $sql2;
2017-12-14 22:14:02 +01:00
} else {
2018-12-23 21:32:23 +01:00
$sql3 .= ", " . $sql2;
2017-12-14 22:14:02 +01:00
}
}
2017-12-14 22:14:02 +01:00
}
// Compare the field structure field by field
foreach ($structure["fields"] as $fieldName => $parameters) {
if (!isset($database[$name]["fields"][$fieldName])) {
$sql2 = DbaDefinitionSqlWriter::addTableField($fieldName, $parameters);
if ($sql3 == "") {
2021-09-26 20:30:44 +02:00
$sql3 = "ALTER" . $ignore . " TABLE `" . $name . "` " . $sql2;
} else {
2018-12-23 21:32:23 +01:00
$sql3 .= ", " . $sql2;
}
2017-12-14 22:14:02 +01:00
} else {
// Compare the field definition
$field_definition = $database[$name]["fields"][$fieldName];
2017-12-14 22:14:02 +01:00
// Remove the relation data that is used for the referential integrity
unset($parameters['relation']);
2020-05-10 16:55:03 +02:00
unset($parameters['foreign']);
2017-12-14 22:14:02 +01:00
// We change the collation after the indexes had been changed.
// This is done to avoid index length problems.
// So here we always ensure that there is no need to change it.
unset($parameters['Collation']);
unset($field_definition['Collation']);
// Only update the comment when it is defined
if (!isset($parameters['comment'])) {
$parameters['comment'] = "";
}
$current_field_definition = DBA::cleanQuery(implode(",", $field_definition));
$new_field_definition = DBA::cleanQuery(implode(",", $parameters));
2017-12-14 22:14:02 +01:00
if ($current_field_definition != $new_field_definition) {
$sql2 = DbaDefinitionSqlWriter::modifyTableField($fieldName, $parameters);
2017-12-14 22:14:02 +01:00
if ($sql3 == "") {
2021-09-26 20:30:44 +02:00
$sql3 = "ALTER" . $ignore . " TABLE `" . $name . "` " . $sql2;
2017-12-14 22:14:02 +01:00
} else {
2018-12-23 21:32:23 +01:00
$sql3 .= ", " . $sql2;
2017-12-14 22:14:02 +01:00
}
}
}
}
}
2017-12-14 22:14:02 +01:00
/*
* Create the index if the index don't exists in database
* or the definition differ from the current status.
* Don't create keys if table is new
*/
if (!$is_new_table) {
foreach ($structure["indexes"] as $indexName => $fieldNames) {
if (isset($database[$name]["indexes"][$indexName])) {
$current_index_definition = implode(",", $database[$name]["indexes"][$indexName]);
2017-12-14 22:14:02 +01:00
} else {
$current_index_definition = "__NOT_SET__";
}
$new_index_definition = implode(",", $fieldNames);
2017-12-14 22:14:02 +01:00
if ($current_index_definition != $new_index_definition) {
$sql2 = DbaDefinitionSqlWriter::createIndex($indexName, $fieldNames);
2017-12-14 22:14:02 +01:00
if ($sql2 != "") {
if ($sql3 == "") {
2021-09-26 20:30:44 +02:00
$sql3 = "ALTER" . $ignore . " TABLE `" . $name . "` " . $sql2;
2017-12-14 22:14:02 +01:00
} else {
2018-12-23 21:32:23 +01:00
$sql3 .= ", " . $sql2;
2017-12-14 22:14:02 +01:00
}
}
}
2017-12-14 22:14:02 +01:00
}
2020-05-10 16:55:03 +02:00
$existing_foreign_keys = $database[$name]['foreign_keys'];
// Foreign keys
// Compare the field structure field by field
foreach ($structure["fields"] as $fieldName => $parameters) {
2020-05-10 16:55:03 +02:00
if (empty($parameters['foreign'])) {
continue;
}
$constraint = self::getConstraintName($name, $fieldName, $parameters);
2020-05-10 16:55:03 +02:00
unset($existing_foreign_keys[$constraint]);
if (empty($database[$name]['foreign_keys'][$constraint])) {
$sql2 = DbaDefinitionSqlWriter::addForeignKey($fieldName, $parameters);
2020-05-10 16:55:03 +02:00
if ($sql3 == "") {
2021-09-26 20:30:44 +02:00
$sql3 = "ALTER" . $ignore . " TABLE `" . $name . "` " . $sql2;
2020-05-10 16:55:03 +02:00
} else {
$sql3 .= ", " . $sql2;
}
}
}
foreach ($existing_foreign_keys as $param) {
$sql2 = DbaDefinitionSqlWriter::dropForeignKey($param['CONSTRAINT_NAME']);
2020-05-10 16:55:03 +02:00
if ($sql3 == "") {
2021-09-26 20:30:44 +02:00
$sql3 = "ALTER" . $ignore . " TABLE `" . $name . "` " . $sql2;
2020-05-10 16:55:03 +02:00
} else {
$sql3 .= ", " . $sql2;
}
}
if (isset($database[$name]["table_status"]["TABLE_COMMENT"])) {
$structurecomment = $structure["comment"] ?? '';
if ($database[$name]["table_status"]["TABLE_COMMENT"] != $structurecomment) {
2018-12-23 21:32:23 +01:00
$sql2 = "COMMENT = '" . DBA::escape($structurecomment) . "'";
if ($sql3 == "") {
2021-09-26 20:30:44 +02:00
$sql3 = "ALTER" . $ignore . " TABLE `" . $name . "` " . $sql2;
} else {
2018-12-23 21:32:23 +01:00
$sql3 .= ", " . $sql2;
}
}
}
if (isset($database[$name]["table_status"]["ENGINE"]) && isset($structure['engine'])) {
if ($database[$name]["table_status"]["ENGINE"] != $structure['engine']) {
2018-12-23 21:32:23 +01:00
$sql2 = "ENGINE = '" . DBA::escape($structure['engine']) . "'";
if ($sql3 == "") {
2021-09-26 20:30:44 +02:00
$sql3 = "ALTER" . $ignore . " TABLE `" . $name . "` " . $sql2;
} else {
2018-12-23 21:32:23 +01:00
$sql3 .= ", " . $sql2;
}
}
}
if (isset($database[$name]["table_status"]["TABLE_COLLATION"])) {
if ($database[$name]["table_status"]["TABLE_COLLATION"] != 'utf8mb4_general_ci') {
2017-12-14 22:14:02 +01:00
$sql2 = "DEFAULT COLLATE utf8mb4_general_ci";
if ($sql3 == "") {
2021-09-26 20:30:44 +02:00
$sql3 = "ALTER" . $ignore . " TABLE `" . $name . "` " . $sql2;
} else {
2018-12-23 21:32:23 +01:00
$sql3 .= ", " . $sql2;
}
}
}
2017-12-14 22:14:02 +01:00
if ($sql3 != "") {
$sql3 .= "; ";
}
// Now have a look at the field collations
// Compare the field structure field by field
foreach ($structure["fields"] as $fieldName => $parameters) {
2017-12-14 22:14:02 +01:00
// Compare the field definition
$field_definition = ($database[$name]["fields"][$fieldName] ?? '') ?: ['Collation' => ''];
2017-12-14 22:14:02 +01:00
// Define the default collation if not given
if (!isset($parameters['Collation']) && !empty($field_definition['Collation'])) {
2017-12-14 22:14:02 +01:00
$parameters['Collation'] = 'utf8mb4_general_ci';
} else {
2017-12-14 22:14:02 +01:00
$parameters['Collation'] = null;
}
if ($field_definition['Collation'] != $parameters['Collation']) {
$sql2 = DbaDefinitionSqlWriter::modifyTableField($fieldName, $parameters);
2017-12-14 22:14:02 +01:00
if (($sql3 == "") || (substr($sql3, -2, 2) == "; ")) {
2021-09-26 20:30:44 +02:00
$sql3 .= "ALTER" . $ignore . " TABLE `" . $name . "` " . $sql2;
2017-12-14 22:14:02 +01:00
} else {
2018-12-23 21:32:23 +01:00
$sql3 .= ", " . $sql2;
2017-12-14 22:14:02 +01:00
}
}
}
}
if ($sql3 != "") {
2017-12-14 22:14:02 +01:00
if (substr($sql3, -2, 2) != "; ") {
$sql3 .= ";";
}
2017-12-14 22:14:02 +01:00
if ($verbose) {
2018-12-23 21:32:23 +01:00
echo $sql3 . "\n";
2017-01-16 00:30:43 +01:00
}
2017-12-14 22:14:02 +01:00
if ($action) {
if ($in_maintenance_mode) {
DI::config()->set('system', 'maintenance_reason', DI::l10n()->t('%s: updating %s table.', DateTimeFormat::utcNow() . ' ' . date('e'), $name));
}
$r = DBA::e($sql3);
2018-07-21 14:46:04 +02:00
if (!DBA::isResult($r)) {
2017-12-14 22:14:02 +01:00
$errors .= self::printUpdateError($sql3);
}
2017-01-16 00:30:43 +01:00
}
}
}
2020-05-10 16:55:03 +02:00
View::create(false, $action);
2020-04-23 08:19:44 +02:00
2020-05-15 19:49:07 +02:00
self::checkInitialValues();
if ($action && !$install) {
if ($errors) {
DI::config()->set('system', 'dbupdate', self::UPDATE_FAILED);
} else {
DI::config()->set('system', 'dbupdate', self::UPDATE_SUCCESSFUL);
}
2017-12-14 22:14:02 +01:00
}
2017-12-14 22:14:02 +01:00
return $errors;
2017-04-14 13:26:47 +02:00
}
/**
* Returns an array with table structure information
*
* @param string $table Name of table
* @return array Table structure information
*/
private static function tableStructure(string $table): array
2018-12-23 21:32:23 +01:00
{
// This query doesn't seem to be executable as a prepared statement
2020-05-11 20:59:36 +02:00
$indexes = DBA::toArray(DBA::p("SHOW INDEX FROM " . DBA::quoteIdentifier($table)));
$fields = DBA::selectToArray('INFORMATION_SCHEMA.COLUMNS',
['COLUMN_NAME', 'COLUMN_TYPE', 'IS_NULLABLE', 'COLUMN_DEFAULT', 'EXTRA',
2022-07-13 00:23:12 +02:00
'COLUMN_KEY', 'COLLATION_NAME', 'COLUMN_COMMENT'],
["`TABLE_SCHEMA` = ? AND `TABLE_NAME` = ?",
2022-07-13 00:23:12 +02:00
DBA::databaseName(), $table]);
$foreign_keys = DBA::selectToArray('INFORMATION_SCHEMA.KEY_COLUMN_USAGE',
2020-05-10 16:55:03 +02:00
['COLUMN_NAME', 'CONSTRAINT_NAME', 'REFERENCED_TABLE_NAME', 'REFERENCED_COLUMN_NAME'],
["`TABLE_SCHEMA` = ? AND `TABLE_NAME` = ? AND `REFERENCED_TABLE_SCHEMA` IS NOT NULL",
2022-07-13 00:23:12 +02:00
DBA::databaseName(), $table]);
2020-05-10 16:55:03 +02:00
$table_status = DBA::selectFirst('INFORMATION_SCHEMA.TABLES',
['ENGINE', 'TABLE_COLLATION', 'TABLE_COMMENT'],
["`TABLE_SCHEMA` = ? AND `TABLE_NAME` = ?",
2022-07-13 00:23:12 +02:00
DBA::databaseName(), $table]);
2022-07-13 00:23:12 +02:00
$fielddata = [];
$indexdata = [];
2020-05-10 16:55:03 +02:00
$foreigndata = [];
if (DBA::isResult($foreign_keys)) {
foreach ($foreign_keys as $foreign_key) {
2022-07-13 00:23:12 +02:00
$parameters = ['foreign' => [$foreign_key['REFERENCED_TABLE_NAME'] => $foreign_key['REFERENCED_COLUMN_NAME']]];
$constraint = self::getConstraintName($table, $foreign_key['COLUMN_NAME'], $parameters);
2020-05-10 16:55:03 +02:00
$foreigndata[$constraint] = $foreign_key;
}
}
2018-12-23 21:32:23 +01:00
if (DBA::isResult($indexes)) {
2021-10-03 12:34:41 +02:00
foreach ($indexes as $index) {
if ($index["Key_name"] != "PRIMARY" && $index["Non_unique"] == "0" && !isset($indexdata[$index["Key_name"]])) {
$indexdata[$index["Key_name"]] = ["UNIQUE"];
}
if ($index["Index_type"] == "FULLTEXT" && !isset($indexdata[$index["Key_name"]])) {
$indexdata[$index["Key_name"]] = ["FULLTEXT"];
2018-12-23 21:32:23 +01:00
}
2018-12-23 21:32:23 +01:00
$column = $index["Column_name"];
2018-12-23 21:32:23 +01:00
if ($index["Sub_part"] != "") {
$column .= "(" . $index["Sub_part"] . ")";
2017-12-14 22:14:02 +01:00
}
2018-12-23 21:32:23 +01:00
$indexdata[$index["Key_name"]][] = $column;
2017-12-14 22:14:02 +01:00
}
}
$fielddata = [];
if (DBA::isResult($fields)) {
2021-10-03 12:34:41 +02:00
foreach ($fields as $field) {
2022-07-13 00:23:12 +02:00
$search = ['tinyint(1)', 'tinyint(3) unsigned', 'tinyint(4)', 'smallint(5) unsigned', 'smallint(6)', 'mediumint(8) unsigned', 'mediumint(9)', 'bigint(20)', 'int(10) unsigned', 'int(11)'];
$replace = ['boolean', 'tinyint unsigned', 'tinyint', 'smallint unsigned', 'smallint', 'mediumint unsigned', 'mediumint', 'bigint', 'int unsigned', 'int'];
$field['COLUMN_TYPE'] = str_replace($search, $replace, $field['COLUMN_TYPE']);
$fielddata[$field['COLUMN_NAME']]['type'] = $field['COLUMN_TYPE'];
if ($field['IS_NULLABLE'] == 'NO') {
2020-05-11 20:59:36 +02:00
$fielddata[$field['COLUMN_NAME']]['not null'] = true;
2018-12-23 21:32:23 +01:00
}
if (isset($field['COLUMN_DEFAULT']) && ($field['COLUMN_DEFAULT'] != 'NULL')) {
$fielddata[$field['COLUMN_NAME']]['default'] = trim($field['COLUMN_DEFAULT'], "'");
2018-12-23 21:32:23 +01:00
}
if (!empty($field['EXTRA'])) {
$fielddata[$field['COLUMN_NAME']]['extra'] = $field['EXTRA'];
2018-12-23 21:32:23 +01:00
}
if ($field['COLUMN_KEY'] == 'PRI') {
2020-05-11 21:07:18 +02:00
$fielddata[$field['COLUMN_NAME']]['primary'] = true;
2018-12-23 21:32:23 +01:00
}
$fielddata[$field['COLUMN_NAME']]['Collation'] = $field['COLLATION_NAME'];
2022-07-13 00:23:12 +02:00
$fielddata[$field['COLUMN_NAME']]['comment'] = $field['COLUMN_COMMENT'];
2018-12-23 21:32:23 +01:00
}
2017-12-14 22:14:02 +01:00
}
return [
2022-07-13 00:23:12 +02:00
'fields' => $fielddata,
'indexes' => $indexdata,
'foreign_keys' => $foreigndata,
'table_status' => $table_status
];
}
private static function getConstraintName(string $tableName, string $fieldName, array $parameters): string
2020-05-10 16:55:03 +02:00
{
$foreign_table = array_keys($parameters['foreign'])[0];
$foreign_field = array_values($parameters['foreign'])[0];
return $tableName . '-' . $fieldName. '-' . $foreign_table. '-' . $foreign_field;
2020-05-10 16:55:03 +02:00
}
/**
2018-12-23 21:32:23 +01:00
* Renames columns or the primary key of a table
*
2018-12-23 21:32:23 +01:00
* @todo You cannot rename a primary key if "auto increment" is set
*
* @param string $table Table name
* @param array $columns Columns Syntax for Rename: [ $old1 => [ $new1, $type1 ], $old2 => [ $new2, $type2 ], ... ]
* Syntax for Primary Key: [ $col1, $col2, ...]
2018-12-23 21:32:23 +01:00
* @param int $type The type of renaming (Default is Column)
*
* @return boolean Was the renaming successful?
2019-01-06 22:06:53 +01:00
* @throws Exception
*/
public static function rename(string $table, array $columns, int $type = self::RENAME_COLUMN): bool
{
2018-12-23 21:32:23 +01:00
if (empty($table) || empty($columns)) {
return false;
}
if (!is_array($columns)) {
return false;
}
$table = DBA::escape($table);
2018-12-23 21:32:23 +01:00
$sql = "ALTER TABLE `" . $table . "`";
switch ($type) {
case self::RENAME_COLUMN:
if (!self::existsColumn($table, array_keys($columns))) {
return false;
}
$sql .= implode(',', array_map(
function ($to, $from) {
return " CHANGE `" . $from . "` `" . $to[0] . "` " . $to[1];
},
$columns,
array_keys($columns)
));
break;
case self::RENAME_PRIMARY_KEY:
if (!self::existsColumn($table, $columns)) {
return false;
}
$sql .= " DROP PRIMARY KEY, ADD PRIMARY KEY(`" . implode('`, `', $columns) . "`)";
break;
default:
return false;
}
$sql .= ';';
$stmt = DBA::p($sql);
if (is_bool($stmt)) {
$retval = $stmt;
} else {
2018-12-23 21:32:23 +01:00
$retval = true;
}
DBA::close($stmt);
return $retval;
}
/**
2018-12-23 21:32:23 +01:00
* Check if the columns of the table exists
*
* @param string $table Table name
* @param array $columns Columns to check ( Syntax: [ $col1, $col2, .. ] )
*
* @return boolean Does the table exist?
2019-01-06 22:06:53 +01:00
* @throws Exception
*/
public static function existsColumn(string $table, array $columns = []): bool
2018-12-23 21:32:23 +01:00
{
if (empty($table)) {
return false;
}
if (is_null($columns) || empty($columns)) {
return self::existsTable($table);
}
$table = DBA::escape($table);
2021-10-03 12:34:41 +02:00
foreach ($columns as $column) {
$sql = "SHOW COLUMNS FROM `" . $table . "` LIKE '" . $column . "';";
$stmt = DBA::p($sql);
if (is_bool($stmt)) {
$retval = $stmt;
} else {
2018-07-21 04:05:12 +02:00
$retval = (DBA::numRows($stmt) > 0);
}
DBA::close($stmt);
if (!$retval) {
return false;
}
}
return true;
}
/**
* Check if a foreign key exists for the given table field
*
* @param string $table Table name
* @param string $field Field name
* @return boolean Wether a foreign key exists
*/
public static function existsForeignKeyForField(string $table, string $field): bool
{
return DBA::exists('INFORMATION_SCHEMA.KEY_COLUMN_USAGE',
["`TABLE_SCHEMA` = ? AND `TABLE_NAME` = ? AND `COLUMN_NAME` = ? AND `REFERENCED_TABLE_SCHEMA` IS NOT NULL",
2022-07-13 00:23:12 +02:00
DBA::databaseName(), $table, $field]);
}
/**
* Check if a table exists
*
* @param string $table Single table name (please loop yourself)
2018-12-23 21:32:23 +01:00
* @return boolean Does the table exist?
2019-01-06 22:06:53 +01:00
* @throws Exception
*/
public static function existsTable(string $table): bool
2018-12-23 21:32:23 +01:00
{
if (empty($table)) {
return false;
}
$condition = ['table_schema' => DBA::databaseName(), 'table_name' => $table];
return DBA::exists('information_schema.tables', $condition);
}
2019-03-01 12:35:59 +01:00
/**
* Returns the columns of a table
*
* @param string $table Table name
*
* @return array An array of the table columns
* @throws Exception
*/
public static function getColumns(string $table): array
2019-03-01 12:35:59 +01:00
{
2019-03-01 17:15:34 +01:00
$stmtColumns = DBA::p("SHOW COLUMNS FROM `" . $table . "`");
return DBA::toArray($stmtColumns);
2019-03-01 12:35:59 +01:00
}
2020-05-15 19:49:07 +02:00
/**
* Check if initial database values do exist - or create them
*
* @param bool $verbose Whether to output messages
* @return void
*/
public static function checkInitialValues(bool $verbose = false)
2020-05-15 19:49:07 +02:00
{
if (self::existsTable('verb')) {
if (!DBA::exists('verb', ['id' => 1])) {
foreach (Item::ACTIVITIES as $index => $activity) {
DBA::insert('verb', ['id' => $index + 1, 'name' => $activity], Database::INSERT_IGNORE);
}
if ($verbose) {
echo "verb: activities added\n";
}
} elseif ($verbose) {
echo "verb: activities already added\n";
2020-05-19 07:51:58 +02:00
}
if (!DBA::exists('verb', ['id' => 0])) {
DBA::insert('verb', ['name' => ''], Database::INSERT_IGNORE);
$lastid = DBA::lastInsertId();
if ($lastid != 0) {
DBA::update('verb', ['id' => 0], ['id' => $lastid]);
if ($verbose) {
echo "Zero verb added\n";
}
}
} elseif ($verbose) {
echo "Zero verb already added\n";
2020-11-19 07:26:30 +01:00
}
} elseif ($verbose) {
echo "verb: Table not found\n";
2020-11-19 07:26:30 +01:00
}
2020-11-18 00:45:16 +01:00
if (self::existsTable('user') && !DBA::exists('user', ['uid' => 0])) {
2020-11-18 06:55:15 +01:00
$user = [
2022-07-13 00:23:12 +02:00
'verified' => true,
'page-flags' => User::PAGE_FLAGS_SOAPBOX,
'account-type' => User::ACCOUNT_TYPE_RELAY,
2020-11-18 06:55:15 +01:00
];
DBA::insert('user', $user);
2020-11-18 01:13:39 +01:00
$lastid = DBA::lastInsertId();
if ($lastid != 0) {
2020-11-18 06:55:15 +01:00
DBA::update('user', ['uid' => 0], ['uid' => $lastid]);
if ($verbose) {
echo "Zero user added\n";
}
2020-11-18 01:13:39 +01:00
}
2020-11-23 20:47:30 +01:00
} elseif (self::existsTable('user') && $verbose) {
echo "Zero user already added\n";
2020-11-23 20:47:30 +01:00
} elseif ($verbose) {
echo "user: Table not found\n";
2020-11-18 01:13:39 +01:00
}
if (self::existsTable('contact') && !DBA::exists('contact', ['id' => 0])) {
DBA::insert('contact', ['nurl' => ''], Database::INSERT_IGNORE);
2020-11-18 01:13:39 +01:00
$lastid = DBA::lastInsertId();
if ($lastid != 0) {
DBA::update('contact', ['id' => 0], ['id' => $lastid]);
if ($verbose) {
echo "Zero contact added\n";
}
2021-06-14 10:53:37 +02:00
}
2020-11-23 20:47:30 +01:00
} elseif (self::existsTable('contact') && $verbose) {
echo "Zero contact already added\n";
2020-11-23 20:47:30 +01:00
} elseif ($verbose) {
echo "contact: Table not found\n";
2020-11-18 01:13:39 +01:00
}
2020-11-23 20:47:30 +01:00
if (self::existsTable('tag') && !DBA::exists('tag', ['id' => 0])) {
DBA::insert('tag', ['name' => ''], Database::INSERT_IGNORE);
2020-11-23 20:47:30 +01:00
$lastid = DBA::lastInsertId();
if ($lastid != 0) {
DBA::update('tag', ['id' => 0], ['id' => $lastid]);
if ($verbose) {
echo "Zero tag added\n";
}
}
} elseif (self::existsTable('tag') && $verbose) {
echo "Zero tag already added\n";
} elseif ($verbose) {
echo "tag: Table not found\n";
}
if (self::existsTable('permissionset')) {
if (!DBA::exists('permissionset', ['id' => 0])) {
DBA::insert('permissionset', ['allow_cid' => '', 'allow_gid' => '', 'deny_cid' => '', 'deny_gid' => ''], Database::INSERT_IGNORE);
$lastid = DBA::lastInsertId();
if ($lastid != 0) {
DBA::update('permissionset', ['id' => 0], ['id' => $lastid]);
if ($verbose) {
2020-11-23 20:47:30 +01:00
echo "Zero permissionset added\n";
}
}
} elseif ($verbose) {
echo "Zero permissionset already added\n";
}
2021-02-14 19:33:15 +01:00
if (self::existsTable('item') && !self::existsForeignKeyForField('item', 'psid')) {
$sets = DBA::p("SELECT `psid`, `item`.`uid`, `item`.`private` FROM `item`
LEFT JOIN `permissionset` ON `permissionset`.`id` = `item`.`psid`
WHERE `permissionset`.`id` IS NULL AND NOT `psid` IS NULL");
while ($set = DBA::fetch($sets)) {
if (($set['private'] == Item::PRIVATE) && ($set['uid'] != 0)) {
$owner = User::getOwnerDataById($set['uid']);
if ($owner) {
$permission = '<' . $owner['id'] . '>';
} else {
$permission = '<>';
}
} else {
$permission = '';
}
$fields = ['id' => $set['psid'], 'uid' => $set['uid'], 'allow_cid' => $permission,
2022-07-13 00:23:12 +02:00
'allow_gid' => '', 'deny_cid' => '', 'deny_gid' => ''];
DBA::insert('permissionset', $fields, Database::INSERT_IGNORE);
}
DBA::close($sets);
2020-05-15 19:49:07 +02:00
}
} elseif ($verbose) {
echo "permissionset: Table not found\n";
2020-05-15 19:49:07 +02:00
}
2021-06-14 10:53:37 +02:00
2021-07-20 19:41:04 +02:00
if (self::existsTable('tokens') && self::existsTable('clients') && !self::existsForeignKeyForField('tokens', 'client_id')) {
$tokens = DBA::p("SELECT `tokens`.`id` FROM `tokens`
LEFT JOIN `clients` ON `clients`.`client_id` = `tokens`.`client_id`
WHERE `clients`.`client_id` IS NULL");
while ($token = DBA::fetch($tokens)) {
2020-05-16 08:14:25 +02:00
DBA::delete('tokens', ['id' => $token['id']]);
}
DBA::close($tokens);
}
2020-05-15 19:49:07 +02:00
}
/**
* Checks if a database update is currently running
*
* @return boolean
*/
private static function isUpdating(): bool
{
$isUpdate = false;
$processes = DBA::select('information_schema.processlist', ['info'], [
2022-07-13 00:23:12 +02:00
'db' => DBA::databaseName(),
'command' => ['Query', 'Execute']
]);
2020-05-16 11:01:54 +02:00
while ($process = DBA::fetch($processes)) {
$parts = explode(' ', $process['info']);
if (in_array(strtolower(array_shift($parts)), ['alter', 'create', 'drop', 'rename'])) {
$isUpdate = true;
}
}
2020-05-16 11:01:54 +02:00
DBA::close($processes);
return $isUpdate;
}
2017-12-14 23:18:53 +01:00
}