3 * @file src/Database/DBStructure.php
6 namespace Friendica\Database;
9 use Friendica\Core\Config;
10 use Friendica\Core\Hook;
11 use Friendica\Core\L10n;
12 use Friendica\Core\Logger;
13 use Friendica\Util\DateTimeFormat;
15 require_once __DIR__ . '/../../include/dba.php';
18 * @brief This class contain functions for the database management
20 * This class contains functions that doesn't need to know if pdo, mysqli or whatever is used.
24 const UPDATE_NOT_CHECKED = 0; // Database check wasn't executed before
25 const UPDATE_SUCCESSFUL = 1; // Database check was successful
26 const UPDATE_FAILED = 2; // Database check failed
28 const RENAME_COLUMN = 0;
29 const RENAME_PRIMARY_KEY = 1;
32 * Database structure definition loaded from config/dbstructure.config.php
36 private static $definition = [];
39 * Converts all tables from MyISAM to InnoDB
41 public static function convertToInnoDB()
43 $tables = DBA::selectToArray(
44 ['information_schema' => 'tables'],
46 ['engine' => 'MyISAM', 'table_schema' => DBA::databaseName()]
49 if (!DBA::isResult($tables)) {
50 echo L10n::t('There are no tables on MyISAM.') . "\n";
54 foreach ($tables AS $table) {
55 $sql = "ALTER TABLE " . DBA::quoteIdentifier($table['table_name']) . " engine=InnoDB;";
58 $result = DBA::e($sql);
59 if (!DBA::isResult($result)) {
60 self::printUpdateError($sql);
66 * @brief Print out database error messages
68 * @param string $message Message to be added to the error message
70 * @return string Error message
72 private static function printUpdateError($message)
74 echo L10n::t("\nError %d occurred during database update:\n%s\n",
75 DBA::errorNo(), DBA::errorMessage());
77 return L10n::t('Errors encountered performing database changes: ') . $message . EOL;
80 public static function printStructure($basePath)
82 $database = self::definition($basePath, false);
84 echo "-- ------------------------------------------\n";
85 echo "-- " . FRIENDICA_PLATFORM . " " . FRIENDICA_VERSION . " (" . FRIENDICA_CODENAME, ")\n";
86 echo "-- DB_UPDATE_VERSION " . DB_UPDATE_VERSION . "\n";
87 echo "-- ------------------------------------------\n\n\n";
88 foreach ($database AS $name => $structure) {
90 echo "-- TABLE $name\n";
92 self::createTable($name, $structure, true, false);
99 * Loads the database structure definition from the config/dbstructure.config.php file.
100 * On first pass, defines DB_UPDATE_VERSION constant.
102 * @see static/dbstructure.config.php
103 * @param boolean $with_addons_structure Whether to tack on addons additional tables
104 * @param string $basePath The base path of this application
108 public static function definition($basePath, $with_addons_structure = true)
110 if (!self::$definition) {
112 $filename = $basePath . '/static/dbstructure.config.php';
114 if (!is_readable($filename)) {
115 throw new Exception('Missing database structure config file static/dbstructure.config.php');
118 $definition = require $filename;
121 throw new Exception('Corrupted database structure config file static/dbstructure.config.php');
124 self::$definition = $definition;
126 $definition = self::$definition;
129 if ($with_addons_structure) {
130 Hook::callAll('dbstructure_definition', $definition);
136 private static function createTable($name, $structure, $verbose, $action)
144 foreach ($structure["fields"] AS $fieldname => $field) {
145 $sql_rows[] = "`" . DBA::escape($fieldname) . "` " . self::FieldCommand($field);
146 if (!empty($field['primary'])) {
147 $primary_keys[] = $fieldname;
151 if (!empty($structure["indexes"])) {
152 foreach ($structure["indexes"] AS $indexname => $fieldnames) {
153 $sql_index = self::createIndex($indexname, $fieldnames, "");
154 if (!is_null($sql_index)) {
155 $sql_rows[] = $sql_index;
160 if (isset($structure["engine"])) {
161 $engine = " ENGINE=" . $structure["engine"];
164 if (isset($structure["comment"])) {
165 $comment = " COMMENT='" . DBA::escape($structure["comment"]) . "'";
168 $sql = implode(",\n\t", $sql_rows);
170 $sql = sprintf("CREATE TABLE IF NOT EXISTS `%s` (\n\t", DBA::escape($name)) . $sql .
171 "\n)" . $engine . " DEFAULT COLLATE utf8mb4_general_ci" . $comment;
183 private static function FieldCommand($parameters, $create = true)
185 $fieldstruct = $parameters["type"];
187 if (isset($parameters["Collation"])) {
188 $fieldstruct .= " COLLATE " . $parameters["Collation"];
191 if (isset($parameters["not null"])) {
192 $fieldstruct .= " NOT NULL";
195 if (isset($parameters["default"])) {
196 if (strpos(strtolower($parameters["type"]), "int") !== false) {
197 $fieldstruct .= " DEFAULT " . $parameters["default"];
199 $fieldstruct .= " DEFAULT '" . $parameters["default"] . "'";
202 if (isset($parameters["extra"])) {
203 $fieldstruct .= " " . $parameters["extra"];
206 if (isset($parameters["comment"])) {
207 $fieldstruct .= " COMMENT '" . DBA::escape($parameters["comment"]) . "'";
210 /*if (($parameters["primary"] != "") && $create)
211 $fieldstruct .= " PRIMARY KEY";*/
213 return ($fieldstruct);
216 private static function createIndex($indexname, $fieldnames, $method = "ADD")
218 $method = strtoupper(trim($method));
219 if ($method != "" && $method != "ADD") {
220 throw new Exception("Invalid parameter 'method' in self::createIndex(): '$method'");
223 if (in_array($fieldnames[0], ["UNIQUE", "FULLTEXT"])) {
224 $index_type = array_shift($fieldnames);
225 $method .= " " . $index_type;
229 foreach ($fieldnames AS $fieldname) {
234 if (preg_match('|(.+)\((\d+)\)|', $fieldname, $matches)) {
235 $names .= "`" . DBA::escape($matches[1]) . "`(" . intval($matches[2]) . ")";
237 $names .= "`" . DBA::escape($fieldname) . "`";
241 if ($indexname == "PRIMARY") {
242 return sprintf("%s PRIMARY KEY(%s)", $method, $names);
246 $sql = sprintf("%s INDEX `%s` (%s)", $method, DBA::escape($indexname), $names);
251 * Updates DB structure and returns eventual errors messages
253 * @param string $basePath The base path of this application
254 * @param bool $verbose
255 * @param bool $action Whether to actually apply the update
256 * @param bool $install Is this the initial update during the installation?
257 * @param array $tables An array of the database tables
258 * @param array $definition An array of the definition tables
259 * @return string Empty string if the update is successful, error messages otherwise
262 public static function update($basePath, $verbose, $action, $install = false, array $tables = null, array $definition = null)
264 if ($action && !$install) {
265 Config::set('system', 'maintenance', 1);
266 Config::set('system', 'maintenance_reason', L10n::t('%s: Database update', DateTimeFormat::utcNow() . ' ' . date('e')));
271 Logger::log('updating structure', Logger::DEBUG);
273 // Get the current structure
276 if (is_null($tables)) {
277 $tables = q("SHOW TABLES");
280 if (DBA::isResult($tables)) {
281 foreach ($tables AS $table) {
282 $table = current($table);
284 Logger::log(sprintf('updating structure for table %s ...', $table), Logger::DEBUG);
285 $database[$table] = self::tableStructure($table);
289 // Get the definition
290 if (is_null($definition)) {
291 $definition = self::definition($basePath);
294 // MySQL >= 5.7.4 doesn't support the IGNORE keyword in ALTER TABLE statements
295 if ((version_compare(DBA::serverInfo(), '5.7.4') >= 0) &&
296 !(strpos(DBA::serverInfo(), 'MariaDB') !== false)) {
303 foreach ($definition AS $name => $structure) {
304 $is_new_table = false;
309 if (!isset($database[$name])) {
310 $r = self::createTable($name, $structure, $verbose, $action);
311 if (!DBA::isResult($r)) {
312 $errors .= self::printUpdateError($name);
314 $is_new_table = true;
316 foreach ($structure["indexes"] AS $indexname => $fieldnames) {
317 if (isset($database[$name]["indexes"][$indexname])) {
318 $current_index_definition = implode(",", $database[$name]["indexes"][$indexname]);
320 $current_index_definition = "__NOT_SET__";
322 $new_index_definition = implode(",", $fieldnames);
323 if ($current_index_definition != $new_index_definition) {
324 if ($fieldnames[0] == "UNIQUE") {
327 $temp_name = "temp-" . $name;
334 * Drop the index if it isn't present in the definition
335 * or the definition differ from current status
336 * and index name doesn't start with "local_"
338 foreach ($database[$name]["indexes"] as $indexname => $fieldnames) {
339 $current_index_definition = implode(",", $fieldnames);
340 if (isset($structure["indexes"][$indexname])) {
341 $new_index_definition = implode(",", $structure["indexes"][$indexname]);
343 $new_index_definition = "__NOT_SET__";
345 if ($current_index_definition != $new_index_definition && substr($indexname, 0, 6) != 'local_') {
346 $sql2 = self::dropIndex($indexname);
348 $sql3 = "ALTER" . $ignore . " TABLE `" . $temp_name . "` " . $sql2;
350 $sql3 .= ", " . $sql2;
354 // Compare the field structure field by field
355 foreach ($structure["fields"] AS $fieldname => $parameters) {
356 if (!isset($database[$name]["fields"][$fieldname])) {
357 $sql2 = self::addTableField($fieldname, $parameters);
359 $sql3 = "ALTER" . $ignore . " TABLE `" . $temp_name . "` " . $sql2;
361 $sql3 .= ", " . $sql2;
364 // Compare the field definition
365 $field_definition = $database[$name]["fields"][$fieldname];
367 // Remove the relation data that is used for the referential integrity
368 unset($parameters['relation']);
370 // We change the collation after the indexes had been changed.
371 // This is done to avoid index length problems.
372 // So here we always ensure that there is no need to change it.
373 unset($parameters['Collation']);
374 unset($field_definition['Collation']);
376 // Only update the comment when it is defined
377 if (!isset($parameters['comment'])) {
378 $parameters['comment'] = "";
381 $current_field_definition = DBA::cleanQuery(implode(",", $field_definition));
382 $new_field_definition = DBA::cleanQuery(implode(",", $parameters));
383 if ($current_field_definition != $new_field_definition) {
384 $sql2 = self::modifyTableField($fieldname, $parameters);
386 $sql3 = "ALTER" . $ignore . " TABLE `" . $temp_name . "` " . $sql2;
388 $sql3 .= ", " . $sql2;
396 * Create the index if the index don't exists in database
397 * or the definition differ from the current status.
398 * Don't create keys if table is new
400 if (!$is_new_table) {
401 foreach ($structure["indexes"] AS $indexname => $fieldnames) {
402 if (isset($database[$name]["indexes"][$indexname])) {
403 $current_index_definition = implode(",", $database[$name]["indexes"][$indexname]);
405 $current_index_definition = "__NOT_SET__";
407 $new_index_definition = implode(",", $fieldnames);
408 if ($current_index_definition != $new_index_definition) {
409 $sql2 = self::createIndex($indexname, $fieldnames);
411 // Fetch the "group by" fields for unique indexes
412 $group_by = self::groupBy($fieldnames);
415 $sql3 = "ALTER" . $ignore . " TABLE `" . $temp_name . "` " . $sql2;
417 $sql3 .= ", " . $sql2;
423 if (isset($database[$name]["table_status"]["Comment"])) {
424 $structurecomment = $structure["comment"] ?? '';
425 if ($database[$name]["table_status"]["Comment"] != $structurecomment) {
426 $sql2 = "COMMENT = '" . DBA::escape($structurecomment) . "'";
429 $sql3 = "ALTER" . $ignore . " TABLE `" . $temp_name . "` " . $sql2;
431 $sql3 .= ", " . $sql2;
436 if (isset($database[$name]["table_status"]["Engine"]) && isset($structure['engine'])) {
437 if ($database[$name]["table_status"]["Engine"] != $structure['engine']) {
438 $sql2 = "ENGINE = '" . DBA::escape($structure['engine']) . "'";
441 $sql3 = "ALTER" . $ignore . " TABLE `" . $temp_name . "` " . $sql2;
443 $sql3 .= ", " . $sql2;
448 if (isset($database[$name]["table_status"]["Collation"])) {
449 if ($database[$name]["table_status"]["Collation"] != 'utf8mb4_general_ci') {
450 $sql2 = "DEFAULT COLLATE utf8mb4_general_ci";
453 $sql3 = "ALTER" . $ignore . " TABLE `" . $temp_name . "` " . $sql2;
455 $sql3 .= ", " . $sql2;
464 // Now have a look at the field collations
465 // Compare the field structure field by field
466 foreach ($structure["fields"] AS $fieldname => $parameters) {
467 // Compare the field definition
468 $field_definition = ($database[$name]["fields"][$fieldname] ?? '') ?: ['Collation' => ''];
470 // Define the default collation if not given
471 if (!isset($parameters['Collation']) && !empty($field_definition['Collation'])) {
472 $parameters['Collation'] = 'utf8mb4_general_ci';
474 $parameters['Collation'] = null;
477 if ($field_definition['Collation'] != $parameters['Collation']) {
478 $sql2 = self::modifyTableField($fieldname, $parameters);
479 if (($sql3 == "") || (substr($sql3, -2, 2) == "; ")) {
480 $sql3 .= "ALTER" . $ignore . " TABLE `" . $temp_name . "` " . $sql2;
482 $sql3 .= ", " . $sql2;
489 if (substr($sql3, -2, 2) != "; ") {
494 if ($is_unique && $ignore == '') {
495 foreach ($database[$name]["fields"] AS $fieldname => $parameters) {
496 $field_list .= 'ANY_VALUE(`' . $fieldname . '`),';
498 $field_list = rtrim($field_list, ',');
502 // Ensure index conversion to unique removes duplicates
503 if ($is_unique && ($temp_name != $name)) {
505 echo "SET session old_alter_table=1;\n";
507 echo "DROP TABLE IF EXISTS `" . $temp_name . "`;\n";
508 echo "CREATE TABLE `" . $temp_name . "` LIKE `" . $name . "`;\n";
514 if ($is_unique && ($temp_name != $name)) {
516 echo "SET session old_alter_table=0;\n";
518 echo "INSERT INTO `" . $temp_name . "` SELECT " . DBA::anyValueFallback($field_list) . " FROM `" . $name . "`" . $group_by . ";\n";
519 echo "DROP TABLE `" . $name . "`;\n";
520 echo "RENAME TABLE `" . $temp_name . "` TO `" . $name . "`;\n";
527 Config::set('system', 'maintenance_reason', L10n::t('%s: updating %s table.', DateTimeFormat::utcNow() . ' ' . date('e'), $name));
530 // Ensure index conversion to unique removes duplicates
531 if ($is_unique && ($temp_name != $name)) {
533 DBA::e("SET session old_alter_table=1;");
535 $r = DBA::e("DROP TABLE IF EXISTS `" . $temp_name . "`;");
536 if (!DBA::isResult($r)) {
537 $errors .= self::printUpdateError($sql3);
541 $r = DBA::e("CREATE TABLE `" . $temp_name . "` LIKE `" . $name . "`;");
542 if (!DBA::isResult($r)) {
543 $errors .= self::printUpdateError($sql3);
550 if (!DBA::isResult($r)) {
551 $errors .= self::printUpdateError($sql3);
553 if ($is_unique && ($temp_name != $name)) {
555 DBA::e("SET session old_alter_table=0;");
557 $r = DBA::e("INSERT INTO `" . $temp_name . "` SELECT " . $field_list . " FROM `" . $name . "`" . $group_by . ";");
558 if (!DBA::isResult($r)) {
559 $errors .= self::printUpdateError($sql3);
562 $r = DBA::e("DROP TABLE `" . $name . "`;");
563 if (!DBA::isResult($r)) {
564 $errors .= self::printUpdateError($sql3);
567 $r = DBA::e("RENAME TABLE `" . $temp_name . "` TO `" . $name . "`;");
568 if (!DBA::isResult($r)) {
569 $errors .= self::printUpdateError($sql3);
578 if ($action && !$install) {
579 Config::set('system', 'maintenance', 0);
580 Config::set('system', 'maintenance_reason', '');
583 Config::set('system', 'dbupdate', self::UPDATE_FAILED);
585 Config::set('system', 'dbupdate', self::UPDATE_SUCCESSFUL);
592 private static function tableStructure($table)
594 $structures = q("DESCRIBE `%s`", $table);
596 $full_columns = q("SHOW FULL COLUMNS FROM `%s`", $table);
598 $indexes = q("SHOW INDEX FROM `%s`", $table);
600 $table_status = q("SHOW TABLE STATUS WHERE `name` = '%s'", $table);
602 if (DBA::isResult($table_status)) {
603 $table_status = $table_status[0];
611 if (DBA::isResult($indexes)) {
612 foreach ($indexes AS $index) {
613 if ($index["Key_name"] != "PRIMARY" && $index["Non_unique"] == "0" && !isset($indexdata[$index["Key_name"]])) {
614 $indexdata[$index["Key_name"]] = ["UNIQUE"];
617 if ($index["Index_type"] == "FULLTEXT" && !isset($indexdata[$index["Key_name"]])) {
618 $indexdata[$index["Key_name"]] = ["FULLTEXT"];
621 $column = $index["Column_name"];
623 if ($index["Sub_part"] != "") {
624 $column .= "(" . $index["Sub_part"] . ")";
627 $indexdata[$index["Key_name"]][] = $column;
630 if (DBA::isResult($structures)) {
631 foreach ($structures AS $field) {
632 // Replace the default size values so that we don't have to define them
633 $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)'];
634 $replace = ['boolean', 'tinyint unsigned', 'tinyint', 'smallint unsigned', 'smallint', 'mediumint unsigned', 'mediumint', 'bigint', 'int unsigned', 'int'];
635 $field["Type"] = str_replace($search, $replace, $field["Type"]);
637 $fielddata[$field["Field"]]["type"] = $field["Type"];
638 if ($field["Null"] == "NO") {
639 $fielddata[$field["Field"]]["not null"] = true;
642 if (isset($field["Default"])) {
643 $fielddata[$field["Field"]]["default"] = $field["Default"];
646 if ($field["Extra"] != "") {
647 $fielddata[$field["Field"]]["extra"] = $field["Extra"];
650 if ($field["Key"] == "PRI") {
651 $fielddata[$field["Field"]]["primary"] = true;
655 if (DBA::isResult($full_columns)) {
656 foreach ($full_columns AS $column) {
657 $fielddata[$column["Field"]]["Collation"] = $column["Collation"];
658 $fielddata[$column["Field"]]["comment"] = $column["Comment"];
662 return ["fields" => $fielddata, "indexes" => $indexdata, "table_status" => $table_status];
665 private static function dropIndex($indexname)
667 $sql = sprintf("DROP INDEX `%s`", DBA::escape($indexname));
671 private static function addTableField($fieldname, $parameters)
673 $sql = sprintf("ADD `%s` %s", DBA::escape($fieldname), self::FieldCommand($parameters));
677 private static function modifyTableField($fieldname, $parameters)
679 $sql = sprintf("MODIFY `%s` %s", DBA::escape($fieldname), self::FieldCommand($parameters, false));
684 * Constructs a GROUP BY clause from a UNIQUE index definition.
686 * @param array $fieldnames
689 private static function groupBy(array $fieldnames)
691 if ($fieldnames[0] != "UNIQUE") {
695 array_shift($fieldnames);
698 foreach ($fieldnames AS $fieldname) {
703 if (preg_match('|(.+)\((\d+)\)|', $fieldname, $matches)) {
704 $names .= "`" . DBA::escape($matches[1]) . "`";
706 $names .= "`" . DBA::escape($fieldname) . "`";
710 $sql = sprintf(" GROUP BY %s", $names);
715 * Renames columns or the primary key of a table
717 * @todo You cannot rename a primary key if "auto increment" is set
719 * @param string $table Table name
720 * @param array $columns Columns Syntax for Rename: [ $old1 => [ $new1, $type1 ], $old2 => [ $new2, $type2 ], ... ]
721 * Syntax for Primary Key: [ $col1, $col2, ...]
722 * @param int $type The type of renaming (Default is Column)
724 * @return boolean Was the renaming successful?
727 public static function rename($table, $columns, $type = self::RENAME_COLUMN)
729 if (empty($table) || empty($columns)) {
733 if (!is_array($columns)) {
737 $table = DBA::escape($table);
739 $sql = "ALTER TABLE `" . $table . "`";
741 case self::RENAME_COLUMN:
742 if (!self::existsColumn($table, array_keys($columns))) {
745 $sql .= implode(',', array_map(
746 function ($to, $from) {
747 return " CHANGE `" . $from . "` `" . $to[0] . "` " . $to[1];
753 case self::RENAME_PRIMARY_KEY:
754 if (!self::existsColumn($table, $columns)) {
757 $sql .= " DROP PRIMARY KEY, ADD PRIMARY KEY(`" . implode('`, `', $columns) . "`)";
765 $stmt = DBA::p($sql);
767 if (is_bool($stmt)) {
779 * Check if the columns of the table exists
781 * @param string $table Table name
782 * @param array $columns Columns to check ( Syntax: [ $col1, $col2, .. ] )
784 * @return boolean Does the table exist?
787 public static function existsColumn($table, $columns = [])
793 if (is_null($columns) || empty($columns)) {
794 return self::existsTable($table);
797 $table = DBA::escape($table);
799 foreach ($columns AS $column) {
800 $sql = "SHOW COLUMNS FROM `" . $table . "` LIKE '" . $column . "';";
802 $stmt = DBA::p($sql);
804 if (is_bool($stmt)) {
807 $retval = (DBA::numRows($stmt) > 0);
821 * Check if a table exists
823 * @param string|array $table Table name
825 * @return boolean Does the table exist?
828 public static function existsTable($table)
834 if (is_array($table)) {
835 $condition = ['table_schema' => key($table), 'table_name' => current($table)];
837 $condition = ['table_schema' => DBA::databaseName(), 'table_name' => $table];
840 $result = DBA::exists(['information_schema' => 'tables'], $condition);
846 * Returns the columns of a table
848 * @param string $table Table name
850 * @return array An array of the table columns
853 public static function getColumns($table)
855 $stmtColumns = DBA::p("SHOW COLUMNS FROM `" . $table . "`");
856 return DBA::toArray($stmtColumns);