<?php
/**
- * @file src/Database/DBStructure.php
+ * @copyright Copyright (C) 2010-2022, the Friendica project
+ *
+ * @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/>.
+ *
*/
namespace Friendica\Database;
use Exception;
-use Friendica\Core\Config;
use Friendica\Core\Hook;
use Friendica\Core\Logger;
+use Friendica\Core\Renderer;
+use Friendica\DI;
+use Friendica\Model\Item;
+use Friendica\Model\User;
use Friendica\Util\DateTimeFormat;
-require_once __DIR__ . '/../../include/dba.php';
-
/**
* This class contains functions that doesn't need to know if pdo, mysqli or whatever is used.
*/
private static $definition = [];
/**
- * Converts all tables from MyISAM to InnoDB
+ * 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::config()->set('system', 'build', $version);
+ echo DI::l10n()->t('The database version had been set to %s.', $version);
+ }
+
+ /**
+ * Drop unused tables
+ *
+ * @param boolean $execute
+ * @return void
+ */
+ public static function dropTables(bool $execute)
+ {
+ $postupdate = DI::config()->get("system", "post_update_version", PostUpdate::VERSION);
+ 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',
+ 'deliverq', 'dsprphotoq', 'ffinder', 'sign', 'spam', 'term', 'user-item', 'thread', 'item', 'challenge',
+ 'auth_codes', 'tokens', 'clients', 'profile_check', 'host'];
+
+ $tables = DBA::selectToArray(['INFORMATION_SCHEMA' => 'TABLES'], ['TABLE_NAME'],
+ ['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'))) {
+ if ($execute) {
+ $sql = 'DROP TABLE ' . DBA::quoteIdentifier($table) . ';';
+ echo $sql . "\n";
+
+ $result = DBA::e($sql);
+ if (!DBA::isResult($result)) {
+ self::printUpdateError($sql);
+ }
+ } else {
+ echo $table . "\n";
+ }
+ }
+ }
+ }
+
+ /**
+ * Converts all tables from MyISAM/InnoDB Antelope to InnoDB Barracuda
*/
public static function convertToInnoDB()
{
['engine' => 'MyISAM', 'table_schema' => DBA::databaseName()]
);
+ $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.') . "\n";
+ echo DI::l10n()->t('There are no tables on MyISAM or InnoDB with the Antelope file format.') . "\n";
return;
}
- foreach ($tables AS $table) {
- $sql = "ALTER TABLE " . DBA::quoteIdentifier($table['table_name']) . " engine=InnoDB;";
+ foreach ($tables as $table) {
+ $sql = "ALTER TABLE " . DBA::quoteIdentifier($table['table_name']) . " ENGINE=InnoDB ROW_FORMAT=DYNAMIC;";
echo $sql . "\n";
$result = DBA::e($sql);
return DI::l10n()->t('Errors encountered performing database changes: ') . $message . EOL;
}
+ public static function writeStructure()
+ {
+ $tables = [];
+ foreach (self::definition(null) as $name => $definition) {
+ $indexes = [[
+ 'name' => 'Name',
+ 'fields' => 'Fields',
+ ],
+ [
+ 'name' => '-',
+ 'fields' => '-',
+ ]];
+
+ $lengths = ['name' => 4, 'fields' => 6];
+ foreach ($definition['indexes'] as $key => $value) {
+ $fieldlist = implode(', ', $value);
+ $indexes[] = ['name' => $key, 'fields' => $fieldlist];
+ $lengths['name'] = max($lengths['name'], strlen($key));
+ $lengths['fields'] = max($lengths['fields'], strlen($fieldlist));
+ }
+
+ array_walk_recursive($indexes, function(&$value, $key) use ($lengths)
+ {
+ $value = str_pad($value, $lengths[$key], $value === '-' ? '-' : ' ');
+ });
+
+ $foreign = [];
+ $fields = [[
+ 'name' => 'Field',
+ 'comment' => 'Description',
+ 'type' => 'Type',
+ 'null' => 'Null',
+ 'primary' => 'Key',
+ 'default' => 'Default',
+ 'extra' => 'Extra',
+ ],
+ [
+ 'name' => '-',
+ 'comment' => '-',
+ 'type' => '-',
+ 'null' => '-',
+ 'primary' => '-',
+ 'default' => '-',
+ 'extra' => '-',
+ ]];
+ $lengths = [
+ 'name' => 5,
+ 'comment' => 11,
+ 'type' => 4,
+ 'null' => 4,
+ 'primary' => 3,
+ 'default' => 7,
+ 'extra' => 5,
+ ];
+ foreach ($definition['fields'] as $key => $value) {
+ $field = [];
+ $field['name'] = $key;
+ $field['comment'] = $value['comment'] ?? '';
+ $field['type'] = $value['type'];
+ $field['null'] = ($value['not null'] ?? false) ? 'NO' : 'YES';
+ $field['primary'] = ($value['primary'] ?? false) ? 'PRI' : '';
+ $field['default'] = $value['default'] ?? 'NULL';
+ $field['extra'] = $value['extra'] ?? '';
+
+ foreach ($field as $fieldname => $fieldvalue) {
+ $lengths[$fieldname] = max($lengths[$fieldname] ?? 0, strlen($fieldvalue));
+ }
+ $fields[] = $field;
+
+ if (!empty($value['foreign'])) {
+ $foreign[] = [
+ 'field' => $key,
+ 'targettable' => array_keys($value['foreign'])[0],
+ 'targetfield' => array_values($value['foreign'])[0]
+ ];
+ }
+ }
+
+ array_walk_recursive($fields, function(&$value, $key) use ($lengths)
+ {
+ $value = str_pad($value, $lengths[$key], $value === '-' ? '-' : ' ');
+ });
+
+ $tables[] = ['name' => $name, 'comment' => $definition['comment']];
+ $content = Renderer::replaceMacros(Renderer::getMarkupTemplate('structure.tpl'), [
+ '$name' => $name,
+ '$comment' => $definition['comment'],
+ '$fields' => $fields,
+ '$indexes' => $indexes,
+ '$foreign' => $foreign,
+ ]);
+ $filename = DI::basePath() . '/doc/database/db_' . $name . '.md';
+ file_put_contents($filename, $content);
+ }
+ asort($tables);
+ $content = Renderer::replaceMacros(Renderer::getMarkupTemplate('tables.tpl'), [
+ '$tables' => $tables,
+ ]);
+ $filename = DI::basePath() . '/doc/database.md';
+ file_put_contents($filename, $content);
+ }
+
public static function printStructure($basePath)
{
$database = self::definition($basePath, false);
echo "-- " . FRIENDICA_PLATFORM . " " . FRIENDICA_VERSION . " (" . FRIENDICA_CODENAME, ")\n";
echo "-- DB_UPDATE_VERSION " . DB_UPDATE_VERSION . "\n";
echo "-- ------------------------------------------\n\n\n";
- foreach ($database AS $name => $structure) {
+ foreach ($database as $name => $structure) {
echo "--\n";
echo "-- TABLE $name\n";
echo "--\n";
echo "\n";
}
+
+ View::printStructure($basePath);
}
/**
- * Loads the database structure definition from the config/dbstructure.config.php file.
+ * Loads the database structure definition from the static/dbstructure.config.php file.
* On first pass, defines DB_UPDATE_VERSION constant.
*
* @see static/dbstructure.config.php
public static function definition($basePath, $with_addons_structure = true)
{
if (!self::$definition) {
+ if (empty($basePath)) {
+ $basePath = DI::app()->getBasePath();
+ }
$filename = $basePath . '/static/dbstructure.config.php';
return $definition;
}
+ /**
+ * Get field data for the given table
+ *
+ * @param string $table
+ * @param array $data data fields
+ * @return array fields for the given
+ */
+ public static function getFieldsForTable(string $table, array $data = [])
+ {
+ $definition = DBStructure::definition('', false);
+ if (empty($definition[$table])) {
+ return [];
+ }
+
+ $fieldnames = array_keys($definition[$table]['fields']);
+
+ $fields = [];
+
+ // Assign all field that are present in the table
+ foreach ($fieldnames as $field) {
+ if (isset($data[$field])) {
+ // Limit the length of varchar, varbinary, char and binrary fields
+ if (is_string($data[$field]) && preg_match("/char\((\d*)\)/", $definition[$table]['fields'][$field]['type'], $result)) {
+ $data[$field] = mb_substr($data[$field], 0, $result[1]);
+ } elseif (is_string($data[$field]) && preg_match("/binary\((\d*)\)/", $definition[$table]['fields'][$field]['type'], $result)) {
+ $data[$field] = substr($data[$field], 0, $result[1]);
+ }
+ $fields[$field] = $data[$field];
+ }
+ }
+
+ return $fields;
+ }
+
private static function createTable($name, $structure, $verbose, $action)
{
$r = true;
$comment = "";
$sql_rows = [];
$primary_keys = [];
- foreach ($structure["fields"] AS $fieldname => $field) {
+ $foreign_keys = [];
+
+ foreach ($structure["fields"] as $fieldname => $field) {
$sql_rows[] = "`" . DBA::escape($fieldname) . "` " . self::FieldCommand($field);
if (!empty($field['primary'])) {
$primary_keys[] = $fieldname;
}
+ if (!empty($field['foreign'])) {
+ $foreign_keys[$fieldname] = $field;
+ }
}
if (!empty($structure["indexes"])) {
- foreach ($structure["indexes"] AS $indexname => $fieldnames) {
+ foreach ($structure["indexes"] as $indexname => $fieldnames) {
$sql_index = self::createIndex($indexname, $fieldnames, "");
if (!is_null($sql_index)) {
$sql_rows[] = $sql_index;
}
}
+ foreach ($foreign_keys as $fieldname => $parameters) {
+ $sql_rows[] = self::foreignCommand($name, $fieldname, $parameters);
+ }
+
if (isset($structure["engine"])) {
$engine = " ENGINE=" . $structure["engine"];
}
}
$names = "";
- foreach ($fieldnames AS $fieldname) {
+ foreach ($fieldnames as $fieldname) {
if ($names != "") {
$names .= ",";
}
return ($sql);
}
+ /**
+ * Perform a database structure dryrun (means: just simulating)
+ *
+ * @throws Exception
+ */
+ public static function dryRun()
+ {
+ self::update(DI::app()->getBasePath(), 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)
+ {
+ if ($enable_maintenance_mode) {
+ DI::config()->set('system', 'maintenance', 1);
+ }
+
+ $status = self::update(DI::app()->getBasePath(), $verbose, true);
+
+ if ($enable_maintenance_mode) {
+ DI::config()->set('system', 'maintenance', 0);
+ DI::config()->set('system', 'maintenance_reason', '');
+ }
+
+ return $status;
+ }
+
+ /**
+ * Updates DB structure from the installation and returns eventual errors messages
+ *
+ * @param string $basePath The base path of this application
+ *
+ * @return string Empty string if the update is successful, error messages otherwise
+ * @throws Exception
+ */
+ public static function install(string $basePath)
+ {
+ return self::update($basePath, false, true, true);
+ }
+
/**
* Updates DB structure and returns eventual errors messages
*
* @return string Empty string if the update is successful, error messages otherwise
* @throws Exception
*/
- public static function update($basePath, $verbose, $action, $install = false, array $tables = null, array $definition = null)
+ private static function update($basePath, $verbose, $action, $install = false, array $tables = null, array $definition = null)
{
- if ($action && !$install) {
- Config::set('system', 'maintenance', 1);
- Config::set('system', 'maintenance_reason', DI::l10n()->t('%s: Database update', DateTimeFormat::utcNow() . ' ' . date('e')));
+ $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')));
}
+ // 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 = '';
- Logger::log('updating structure', Logger::DEBUG);
+ Logger::info('updating structure');
// Get the current structure
$database = [];
if (is_null($tables)) {
- $tables = q("SHOW TABLES");
+ $tables = DBA::toArray(DBA::p("SHOW TABLES"));
}
if (DBA::isResult($tables)) {
- foreach ($tables AS $table) {
+ foreach ($tables as $table) {
$table = current($table);
- Logger::log(sprintf('updating structure for table %s ...', $table), Logger::DEBUG);
+ Logger::info('updating structure', ['table' => $table]);
$database[$table] = self::tableStructure($table);
}
}
}
// Compare it
- foreach ($definition AS $name => $structure) {
+ foreach ($definition as $name => $structure) {
$is_new_table = false;
- $group_by = "";
$sql3 = "";
- $is_unique = false;
- $temp_name = $name;
if (!isset($database[$name])) {
$r = self::createTable($name, $structure, $verbose, $action);
if (!DBA::isResult($r)) {
}
$is_new_table = true;
} else {
- foreach ($structure["indexes"] AS $indexname => $fieldnames) {
- if (isset($database[$name]["indexes"][$indexname])) {
- $current_index_definition = implode(",", $database[$name]["indexes"][$indexname]);
- } else {
- $current_index_definition = "__NOT_SET__";
- }
- $new_index_definition = implode(",", $fieldnames);
- if ($current_index_definition != $new_index_definition) {
- if ($fieldnames[0] == "UNIQUE") {
- $is_unique = true;
- if ($ignore == "") {
- $temp_name = "temp-" . $name;
- }
- }
- }
- }
-
/*
* Drop the index if it isn't present in the definition
* or the definition differ from current status
if ($current_index_definition != $new_index_definition && substr($indexname, 0, 6) != 'local_') {
$sql2 = self::dropIndex($indexname);
if ($sql3 == "") {
- $sql3 = "ALTER" . $ignore . " TABLE `" . $temp_name . "` " . $sql2;
+ $sql3 = "ALTER" . $ignore . " TABLE `" . $name . "` " . $sql2;
} else {
$sql3 .= ", " . $sql2;
}
}
}
// Compare the field structure field by field
- foreach ($structure["fields"] AS $fieldname => $parameters) {
+ foreach ($structure["fields"] as $fieldname => $parameters) {
if (!isset($database[$name]["fields"][$fieldname])) {
$sql2 = self::addTableField($fieldname, $parameters);
if ($sql3 == "") {
- $sql3 = "ALTER" . $ignore . " TABLE `" . $temp_name . "` " . $sql2;
+ $sql3 = "ALTER" . $ignore . " TABLE `" . $name . "` " . $sql2;
} else {
$sql3 .= ", " . $sql2;
}
// Remove the relation data that is used for the referential integrity
unset($parameters['relation']);
+ unset($parameters['foreign']);
// We change the collation after the indexes had been changed.
// This is done to avoid index length problems.
if ($current_field_definition != $new_field_definition) {
$sql2 = self::modifyTableField($fieldname, $parameters);
if ($sql3 == "") {
- $sql3 = "ALTER" . $ignore . " TABLE `" . $temp_name . "` " . $sql2;
+ $sql3 = "ALTER" . $ignore . " TABLE `" . $name . "` " . $sql2;
} else {
$sql3 .= ", " . $sql2;
}
* Don't create keys if table is new
*/
if (!$is_new_table) {
- foreach ($structure["indexes"] AS $indexname => $fieldnames) {
+ foreach ($structure["indexes"] as $indexname => $fieldnames) {
if (isset($database[$name]["indexes"][$indexname])) {
$current_index_definition = implode(",", $database[$name]["indexes"][$indexname]);
} else {
if ($current_index_definition != $new_index_definition) {
$sql2 = self::createIndex($indexname, $fieldnames);
- // Fetch the "group by" fields for unique indexes
- $group_by = self::groupBy($fieldnames);
if ($sql2 != "") {
if ($sql3 == "") {
- $sql3 = "ALTER" . $ignore . " TABLE `" . $temp_name . "` " . $sql2;
+ $sql3 = "ALTER" . $ignore . " TABLE `" . $name . "` " . $sql2;
} else {
$sql3 .= ", " . $sql2;
}
}
}
- if (isset($database[$name]["table_status"]["Comment"])) {
+ $existing_foreign_keys = $database[$name]['foreign_keys'];
+
+ // Foreign keys
+ // Compare the field structure field by field
+ foreach ($structure["fields"] as $fieldname => $parameters) {
+ if (empty($parameters['foreign'])) {
+ continue;
+ }
+
+ $constraint = self::getConstraintName($name, $fieldname, $parameters);
+
+ unset($existing_foreign_keys[$constraint]);
+
+ if (empty($database[$name]['foreign_keys'][$constraint])) {
+ $sql2 = self::addForeignKey($name, $fieldname, $parameters);
+
+ if ($sql3 == "") {
+ $sql3 = "ALTER" . $ignore . " TABLE `" . $name . "` " . $sql2;
+ } else {
+ $sql3 .= ", " . $sql2;
+ }
+ }
+ }
+
+ foreach ($existing_foreign_keys as $param) {
+ $sql2 = self::dropForeignKey($param['CONSTRAINT_NAME']);
+
+ if ($sql3 == "") {
+ $sql3 = "ALTER" . $ignore . " TABLE `" . $name . "` " . $sql2;
+ } else {
+ $sql3 .= ", " . $sql2;
+ }
+ }
+
+ if (isset($database[$name]["table_status"]["TABLE_COMMENT"])) {
$structurecomment = $structure["comment"] ?? '';
- if ($database[$name]["table_status"]["Comment"] != $structurecomment) {
+ if ($database[$name]["table_status"]["TABLE_COMMENT"] != $structurecomment) {
$sql2 = "COMMENT = '" . DBA::escape($structurecomment) . "'";
if ($sql3 == "") {
- $sql3 = "ALTER" . $ignore . " TABLE `" . $temp_name . "` " . $sql2;
+ $sql3 = "ALTER" . $ignore . " TABLE `" . $name . "` " . $sql2;
} else {
$sql3 .= ", " . $sql2;
}
}
}
- if (isset($database[$name]["table_status"]["Engine"]) && isset($structure['engine'])) {
- if ($database[$name]["table_status"]["Engine"] != $structure['engine']) {
+ if (isset($database[$name]["table_status"]["ENGINE"]) && isset($structure['engine'])) {
+ if ($database[$name]["table_status"]["ENGINE"] != $structure['engine']) {
$sql2 = "ENGINE = '" . DBA::escape($structure['engine']) . "'";
if ($sql3 == "") {
- $sql3 = "ALTER" . $ignore . " TABLE `" . $temp_name . "` " . $sql2;
+ $sql3 = "ALTER" . $ignore . " TABLE `" . $name . "` " . $sql2;
} else {
$sql3 .= ", " . $sql2;
}
}
}
- if (isset($database[$name]["table_status"]["Collation"])) {
- if ($database[$name]["table_status"]["Collation"] != 'utf8mb4_general_ci') {
+ if (isset($database[$name]["table_status"]["TABLE_COLLATION"])) {
+ if ($database[$name]["table_status"]["TABLE_COLLATION"] != 'utf8mb4_general_ci') {
$sql2 = "DEFAULT COLLATE utf8mb4_general_ci";
if ($sql3 == "") {
- $sql3 = "ALTER" . $ignore . " TABLE `" . $temp_name . "` " . $sql2;
+ $sql3 = "ALTER" . $ignore . " TABLE `" . $name . "` " . $sql2;
} else {
$sql3 .= ", " . $sql2;
}
// Now have a look at the field collations
// Compare the field structure field by field
- foreach ($structure["fields"] AS $fieldname => $parameters) {
+ foreach ($structure["fields"] as $fieldname => $parameters) {
// Compare the field definition
$field_definition = ($database[$name]["fields"][$fieldname] ?? '') ?: ['Collation' => ''];
if ($field_definition['Collation'] != $parameters['Collation']) {
$sql2 = self::modifyTableField($fieldname, $parameters);
if (($sql3 == "") || (substr($sql3, -2, 2) == "; ")) {
- $sql3 .= "ALTER" . $ignore . " TABLE `" . $temp_name . "` " . $sql2;
+ $sql3 .= "ALTER" . $ignore . " TABLE `" . $name . "` " . $sql2;
} else {
$sql3 .= ", " . $sql2;
}
$sql3 .= ";";
}
- $field_list = '';
- if ($is_unique && $ignore == '') {
- foreach ($database[$name]["fields"] AS $fieldname => $parameters) {
- $field_list .= 'ANY_VALUE(`' . $fieldname . '`),';
- }
- $field_list = rtrim($field_list, ',');
- }
-
if ($verbose) {
- // Ensure index conversion to unique removes duplicates
- if ($is_unique && ($temp_name != $name)) {
- if ($ignore != "") {
- echo "SET session old_alter_table=1;\n";
- } else {
- echo "DROP TABLE IF EXISTS `" . $temp_name . "`;\n";
- echo "CREATE TABLE `" . $temp_name . "` LIKE `" . $name . "`;\n";
- }
- }
-
echo $sql3 . "\n";
-
- if ($is_unique && ($temp_name != $name)) {
- if ($ignore != "") {
- echo "SET session old_alter_table=0;\n";
- } else {
- echo "INSERT INTO `" . $temp_name . "` SELECT " . DBA::anyValueFallback($field_list) . " FROM `" . $name . "`" . $group_by . ";\n";
- echo "DROP TABLE `" . $name . "`;\n";
- echo "RENAME TABLE `" . $temp_name . "` TO `" . $name . "`;\n";
- }
- }
}
if ($action) {
- if (!$install) {
- Config::set('system', 'maintenance_reason', DI::l10n()->t('%s: updating %s table.', DateTimeFormat::utcNow() . ' ' . date('e'), $name));
- }
-
- // Ensure index conversion to unique removes duplicates
- if ($is_unique && ($temp_name != $name)) {
- if ($ignore != "") {
- DBA::e("SET session old_alter_table=1;");
- } else {
- $r = DBA::e("DROP TABLE IF EXISTS `" . $temp_name . "`;");
- if (!DBA::isResult($r)) {
- $errors .= self::printUpdateError($sql3);
- return $errors;
- }
-
- $r = DBA::e("CREATE TABLE `" . $temp_name . "` LIKE `" . $name . "`;");
- if (!DBA::isResult($r)) {
- $errors .= self::printUpdateError($sql3);
- return $errors;
- }
- }
+ 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);
if (!DBA::isResult($r)) {
$errors .= self::printUpdateError($sql3);
}
- if ($is_unique && ($temp_name != $name)) {
- if ($ignore != "") {
- DBA::e("SET session old_alter_table=0;");
- } else {
- $r = DBA::e("INSERT INTO `" . $temp_name . "` SELECT " . $field_list . " FROM `" . $name . "`" . $group_by . ";");
- if (!DBA::isResult($r)) {
- $errors .= self::printUpdateError($sql3);
- return $errors;
- }
- $r = DBA::e("DROP TABLE `" . $name . "`;");
- if (!DBA::isResult($r)) {
- $errors .= self::printUpdateError($sql3);
- return $errors;
- }
- $r = DBA::e("RENAME TABLE `" . $temp_name . "` TO `" . $name . "`;");
- if (!DBA::isResult($r)) {
- $errors .= self::printUpdateError($sql3);
- return $errors;
- }
- }
- }
}
}
}
- if ($action && !$install) {
- Config::set('system', 'maintenance', 0);
- Config::set('system', 'maintenance_reason', '');
+ View::create(false, $action);
+
+ self::checkInitialValues();
+ if ($action && !$install) {
if ($errors) {
- Config::set('system', 'dbupdate', self::UPDATE_FAILED);
+ DI::config()->set('system', 'dbupdate', self::UPDATE_FAILED);
} else {
- Config::set('system', 'dbupdate', self::UPDATE_SUCCESSFUL);
+ DI::config()->set('system', 'dbupdate', self::UPDATE_SUCCESSFUL);
}
}
private static function tableStructure($table)
{
- $structures = q("DESCRIBE `%s`", $table);
-
- $full_columns = q("SHOW FULL COLUMNS FROM `%s`", $table);
+ // This query doesn't seem to be executable as a prepared statement
+ $indexes = DBA::toArray(DBA::p("SHOW INDEX FROM " . DBA::quoteIdentifier($table)));
- $indexes = q("SHOW INDEX FROM `%s`", $table);
+ $fields = DBA::selectToArray(['INFORMATION_SCHEMA' => 'COLUMNS'],
+ ['COLUMN_NAME', 'COLUMN_TYPE', 'IS_NULLABLE', 'COLUMN_DEFAULT', 'EXTRA',
+ 'COLUMN_KEY', 'COLLATION_NAME', 'COLUMN_COMMENT'],
+ ["`TABLE_SCHEMA` = ? AND `TABLE_NAME` = ?",
+ DBA::databaseName(), $table]);
- $table_status = q("SHOW TABLE STATUS WHERE `name` = '%s'", $table);
+ $foreign_keys = DBA::selectToArray(['INFORMATION_SCHEMA' => 'KEY_COLUMN_USAGE'],
+ ['COLUMN_NAME', 'CONSTRAINT_NAME', 'REFERENCED_TABLE_NAME', 'REFERENCED_COLUMN_NAME'],
+ ["`TABLE_SCHEMA` = ? AND `TABLE_NAME` = ? AND `REFERENCED_TABLE_SCHEMA` IS NOT NULL",
+ DBA::databaseName(), $table]);
- if (DBA::isResult($table_status)) {
- $table_status = $table_status[0];
- } else {
- $table_status = [];
- }
+ $table_status = DBA::selectFirst(['INFORMATION_SCHEMA' => 'TABLES'],
+ ['ENGINE', 'TABLE_COLLATION', 'TABLE_COMMENT'],
+ ["`TABLE_SCHEMA` = ? AND `TABLE_NAME` = ?",
+ DBA::databaseName(), $table]);
$fielddata = [];
$indexdata = [];
+ $foreigndata = [];
+
+ if (DBA::isResult($foreign_keys)) {
+ foreach ($foreign_keys as $foreign_key) {
+ $parameters = ['foreign' => [$foreign_key['REFERENCED_TABLE_NAME'] => $foreign_key['REFERENCED_COLUMN_NAME']]];
+ $constraint = self::getConstraintName($table, $foreign_key['COLUMN_NAME'], $parameters);
+ $foreigndata[$constraint] = $foreign_key;
+ }
+ }
if (DBA::isResult($indexes)) {
- foreach ($indexes AS $index) {
+ foreach ($indexes as $index) {
if ($index["Key_name"] != "PRIMARY" && $index["Non_unique"] == "0" && !isset($indexdata[$index["Key_name"]])) {
$indexdata[$index["Key_name"]] = ["UNIQUE"];
}
$indexdata[$index["Key_name"]][] = $column;
}
}
- if (DBA::isResult($structures)) {
- foreach ($structures AS $field) {
- // Replace the default size values so that we don't have to define them
+
+ $fielddata = [];
+ if (DBA::isResult($fields)) {
+ foreach ($fields as $field) {
$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["Type"] = str_replace($search, $replace, $field["Type"]);
+ $field['COLUMN_TYPE'] = str_replace($search, $replace, $field['COLUMN_TYPE']);
+
+ $fielddata[$field['COLUMN_NAME']]['type'] = $field['COLUMN_TYPE'];
- $fielddata[$field["Field"]]["type"] = $field["Type"];
- if ($field["Null"] == "NO") {
- $fielddata[$field["Field"]]["not null"] = true;
+ if ($field['IS_NULLABLE'] == 'NO') {
+ $fielddata[$field['COLUMN_NAME']]['not null'] = true;
}
- if (isset($field["Default"])) {
- $fielddata[$field["Field"]]["default"] = $field["Default"];
+ if (isset($field['COLUMN_DEFAULT']) && ($field['COLUMN_DEFAULT'] != 'NULL')) {
+ $fielddata[$field['COLUMN_NAME']]['default'] = trim($field['COLUMN_DEFAULT'], "'");
}
- if ($field["Extra"] != "") {
- $fielddata[$field["Field"]]["extra"] = $field["Extra"];
+ if (!empty($field['EXTRA'])) {
+ $fielddata[$field['COLUMN_NAME']]['extra'] = $field['EXTRA'];
}
- if ($field["Key"] == "PRI") {
- $fielddata[$field["Field"]]["primary"] = true;
+ if ($field['COLUMN_KEY'] == 'PRI') {
+ $fielddata[$field['COLUMN_NAME']]['primary'] = true;
}
- }
- }
- if (DBA::isResult($full_columns)) {
- foreach ($full_columns AS $column) {
- $fielddata[$column["Field"]]["Collation"] = $column["Collation"];
- $fielddata[$column["Field"]]["comment"] = $column["Comment"];
+
+ $fielddata[$field['COLUMN_NAME']]['Collation'] = $field['COLLATION_NAME'];
+ $fielddata[$field['COLUMN_NAME']]['comment'] = $field['COLUMN_COMMENT'];
}
}
- return ["fields" => $fielddata, "indexes" => $indexdata, "table_status" => $table_status];
+ return ["fields" => $fielddata, "indexes" => $indexdata,
+ "foreign_keys" => $foreigndata, "table_status" => $table_status];
}
private static function dropIndex($indexname)
return ($sql);
}
- /**
- * Constructs a GROUP BY clause from a UNIQUE index definition.
- *
- * @param array $fieldnames
- * @return string
- */
- private static function groupBy(array $fieldnames)
+ private static function getConstraintName(string $tablename, string $fieldname, array $parameters)
{
- if ($fieldnames[0] != "UNIQUE") {
- return "";
- }
+ $foreign_table = array_keys($parameters['foreign'])[0];
+ $foreign_field = array_values($parameters['foreign'])[0];
+
+ return $tablename . "-" . $fieldname. "-" . $foreign_table. "-" . $foreign_field;
+ }
- array_shift($fieldnames);
+ private static function foreignCommand(string $tablename, string $fieldname, array $parameters) {
+ $foreign_table = array_keys($parameters['foreign'])[0];
+ $foreign_field = array_values($parameters['foreign'])[0];
- $names = "";
- foreach ($fieldnames AS $fieldname) {
- if ($names != "") {
- $names .= ",";
- }
+ $sql = "FOREIGN KEY (`" . $fieldname . "`) REFERENCES `" . $foreign_table . "` (`" . $foreign_field . "`)";
- if (preg_match('|(.+)\((\d+)\)|', $fieldname, $matches)) {
- $names .= "`" . DBA::escape($matches[1]) . "`";
- } else {
- $names .= "`" . DBA::escape($fieldname) . "`";
- }
+ if (!empty($parameters['foreign']['on update'])) {
+ $sql .= " ON UPDATE " . strtoupper($parameters['foreign']['on update']);
+ } else {
+ $sql .= " ON UPDATE RESTRICT";
+ }
+
+ if (!empty($parameters['foreign']['on delete'])) {
+ $sql .= " ON DELETE " . strtoupper($parameters['foreign']['on delete']);
+ } else {
+ $sql .= " ON DELETE CASCADE";
}
- $sql = sprintf(" GROUP BY %s", $names);
return $sql;
}
+ private static function addForeignKey(string $tablename, string $fieldname, array $parameters)
+ {
+ return sprintf("ADD %s", self::foreignCommand($tablename, $fieldname, $parameters));
+ }
+
+ private static function dropForeignKey(string $constraint)
+ {
+ return sprintf("DROP FOREIGN KEY `%s`", $constraint);
+ }
+
/**
* Renames columns or the primary key of a table
*
$table = DBA::escape($table);
- foreach ($columns AS $column) {
+ foreach ($columns as $column) {
$sql = "SHOW COLUMNS FROM `" . $table . "` LIKE '" . $column . "';";
$stmt = DBA::p($sql);
return true;
}
+ /**
+ * Check if a foreign key exists for the given table field
+ *
+ * @param string $table
+ * @param string $field
+ * @return boolean
+ */
+ public static function existsForeignKeyForField(string $table, string $field)
+ {
+ return DBA::exists(['INFORMATION_SCHEMA' => 'KEY_COLUMN_USAGE'],
+ ["`TABLE_SCHEMA` = ? AND `TABLE_NAME` = ? AND `COLUMN_NAME` = ? AND `REFERENCED_TABLE_SCHEMA` IS NOT NULL",
+ DBA::databaseName(), $table, $field]);
+ }
/**
* Check if a table exists
*
$stmtColumns = DBA::p("SHOW COLUMNS FROM `" . $table . "`");
return DBA::toArray($stmtColumns);
}
+
+ /**
+ * Check if initial database values do exist - or create them
+ */
+ public static function checkInitialValues(bool $verbose = false)
+ {
+ 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";
+ }
+
+ if (!DBA::exists('verb', ['id' => 0])) {
+ DBA::insert('verb', ['name' => '']);
+ $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";
+ }
+ } elseif ($verbose) {
+ echo "verb: Table not found\n";
+ }
+
+ if (self::existsTable('user') && !DBA::exists('user', ['uid' => 0])) {
+ $user = [
+ "verified" => true,
+ "page-flags" => User::PAGE_FLAGS_SOAPBOX,
+ "account-type" => User::ACCOUNT_TYPE_RELAY,
+ ];
+ DBA::insert('user', $user);
+ $lastid = DBA::lastInsertId();
+ if ($lastid != 0) {
+ DBA::update('user', ['uid' => 0], ['uid' => $lastid]);
+ if ($verbose) {
+ echo "Zero user added\n";
+ }
+ }
+ } elseif (self::existsTable('user') && $verbose) {
+ echo "Zero user already added\n";
+ } elseif ($verbose) {
+ echo "user: Table not found\n";
+ }
+
+ if (self::existsTable('contact') && !DBA::exists('contact', ['id' => 0])) {
+ DBA::insert('contact', ['nurl' => '']);
+ $lastid = DBA::lastInsertId();
+ if ($lastid != 0) {
+ DBA::update('contact', ['id' => 0], ['id' => $lastid]);
+ if ($verbose) {
+ echo "Zero contact added\n";
+ }
+ }
+ } elseif (self::existsTable('contact') && $verbose) {
+ echo "Zero contact already added\n";
+ } elseif ($verbose) {
+ echo "contact: Table not found\n";
+ }
+
+ if (self::existsTable('tag') && !DBA::exists('tag', ['id' => 0])) {
+ DBA::insert('tag', ['name' => '']);
+ $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' => '']);
+ $lastid = DBA::lastInsertId();
+ if ($lastid != 0) {
+ DBA::update('permissionset', ['id' => 0], ['id' => $lastid]);
+ if ($verbose) {
+ echo "Zero permissionset added\n";
+ }
+ }
+ } elseif ($verbose) {
+ echo "Zero permissionset already added\n";
+ }
+ 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,
+ 'allow_gid' => '', 'deny_cid' => '', 'deny_gid' => ''];
+ DBA::insert('permissionset', $fields);
+ }
+ DBA::close($sets);
+ }
+ } elseif ($verbose) {
+ echo "permissionset: Table not found\n";
+ }
+
+ 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)) {
+ DBA::delete('tokens', ['id' => $token['id']]);
+ }
+ DBA::close($tokens);
+ }
+ }
+
+ /**
+ * Checks if a database update is currently running
+ *
+ * @return boolean
+ */
+ private static function isUpdating()
+ {
+ $isUpdate = false;
+
+ $processes = DBA::select(['information_schema' => 'processlist'], ['info'],
+ ['db' => DBA::databaseName(), 'command' => ['Query', 'Execute']]);
+
+ while ($process = DBA::fetch($processes)) {
+ $parts = explode(' ', $process['info']);
+ if (in_array(strtolower(array_shift($parts)), ['alter', 'create', 'drop', 'rename'])) {
+ $isUpdate = true;
+ }
+ }
+
+ DBA::close($processes);
+
+ return $isUpdate;
+ }
}