X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FDatabase%2FDBStructure.php;h=2638bafab767f825d56932ba1bc82697af0b0872;hb=5af7c3002600965bc0638a1c41a7da68f59d0581;hp=7fc1b3feee7e5ab9a507d3f1c4c92c8a988c323a;hpb=befc2af5043a3afde251721c0d27df695db1bb7e;p=friendica.git diff --git a/src/Database/DBStructure.php b/src/Database/DBStructure.php index 7fc1b3feee..2638bafab7 100644 --- a/src/Database/DBStructure.php +++ b/src/Database/DBStructure.php @@ -1,6 +1,6 @@ 'TABLES'], ['TABLE_NAME'], ['TABLE_SCHEMA' => DBA::databaseName(), 'TABLE_TYPE' => 'BASE TABLE']); @@ -94,10 +96,10 @@ class DBStructure echo DI::l10n()->t('These tables are not used for friendica and will be deleted when you execute "dbstructure drop -e":') . "\n\n"; } - foreach ($tables as $table) { - if (in_array($table['TABLE_NAME'], $old_tables)) { + foreach ($old_tables as $table) { + if (in_array($table, array_column($tables, 'TABLE_NAME'))) { if ($execute) { - $sql = 'DROP TABLE ' . DBA::quoteIdentifier($table['TABLE_NAME']) . ';'; + $sql = 'DROP TABLE ' . DBA::quoteIdentifier($table) . ';'; echo $sql . "\n"; $result = DBA::e($sql); @@ -105,7 +107,7 @@ class DBStructure self::printUpdateError($sql); } } else { - echo $table['TABLE_NAME'] . "\n"; + echo $table . "\n"; } } } @@ -133,7 +135,7 @@ class DBStructure return; } - foreach ($tables AS $table) { + foreach ($tables as $table) { $sql = "ALTER TABLE " . DBA::quoteIdentifier($table['table_name']) . " ENGINE=InnoDB ROW_FORMAT=DYNAMIC;"; echo $sql . "\n"; @@ -159,6 +161,108 @@ class DBStructure 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); @@ -167,7 +271,7 @@ class DBStructure 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"; @@ -192,6 +296,9 @@ class DBStructure 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'; @@ -238,6 +345,12 @@ class DBStructure // 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]; } } @@ -255,7 +368,7 @@ class DBStructure $primary_keys = []; $foreign_keys = []; - foreach ($structure["fields"] AS $fieldname => $field) { + foreach ($structure["fields"] as $fieldname => $field) { $sql_rows[] = "`" . DBA::escape($fieldname) . "` " . self::FieldCommand($field); if (!empty($field['primary'])) { $primary_keys[] = $fieldname; @@ -266,7 +379,7 @@ class DBStructure } 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; @@ -274,7 +387,7 @@ class DBStructure } } - foreach ($foreign_keys AS $fieldname => $parameters) { + foreach ($foreign_keys as $fieldname => $parameters) { $sql_rows[] = self::foreignCommand($name, $fieldname, $parameters); } @@ -347,7 +460,7 @@ class DBStructure } $names = ""; - foreach ($fieldnames AS $fieldname) { + foreach ($fieldnames as $fieldname) { if ($names != "") { $names .= ","; } @@ -456,7 +569,7 @@ class DBStructure } if (DBA::isResult($tables)) { - foreach ($tables AS $table) { + foreach ($tables as $table) { $table = current($table); Logger::info('updating structure', ['table' => $table]); @@ -478,12 +591,9 @@ class DBStructure } // 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)) { @@ -491,23 +601,6 @@ class DBStructure } $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 @@ -523,18 +616,18 @@ class DBStructure 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; } @@ -562,7 +655,7 @@ class DBStructure 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; } @@ -577,7 +670,7 @@ class DBStructure * 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 { @@ -587,11 +680,9 @@ class DBStructure 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; } @@ -603,7 +694,7 @@ class DBStructure // Foreign keys // Compare the field structure field by field - foreach ($structure["fields"] AS $fieldname => $parameters) { + foreach ($structure["fields"] as $fieldname => $parameters) { if (empty($parameters['foreign'])) { continue; } @@ -616,7 +707,7 @@ class DBStructure $sql2 = self::addForeignKey($name, $fieldname, $parameters); if ($sql3 == "") { - $sql3 = "ALTER" . $ignore . " TABLE `" . $temp_name . "` " . $sql2; + $sql3 = "ALTER" . $ignore . " TABLE `" . $name . "` " . $sql2; } else { $sql3 .= ", " . $sql2; } @@ -627,7 +718,7 @@ class DBStructure $sql2 = self::dropForeignKey($param['CONSTRAINT_NAME']); if ($sql3 == "") { - $sql3 = "ALTER" . $ignore . " TABLE `" . $temp_name . "` " . $sql2; + $sql3 = "ALTER" . $ignore . " TABLE `" . $name . "` " . $sql2; } else { $sql3 .= ", " . $sql2; } @@ -639,7 +730,7 @@ class DBStructure $sql2 = "COMMENT = '" . DBA::escape($structurecomment) . "'"; if ($sql3 == "") { - $sql3 = "ALTER" . $ignore . " TABLE `" . $temp_name . "` " . $sql2; + $sql3 = "ALTER" . $ignore . " TABLE `" . $name . "` " . $sql2; } else { $sql3 .= ", " . $sql2; } @@ -651,7 +742,7 @@ class DBStructure $sql2 = "ENGINE = '" . DBA::escape($structure['engine']) . "'"; if ($sql3 == "") { - $sql3 = "ALTER" . $ignore . " TABLE `" . $temp_name . "` " . $sql2; + $sql3 = "ALTER" . $ignore . " TABLE `" . $name . "` " . $sql2; } else { $sql3 .= ", " . $sql2; } @@ -663,7 +754,7 @@ class DBStructure $sql2 = "DEFAULT COLLATE utf8mb4_general_ci"; if ($sql3 == "") { - $sql3 = "ALTER" . $ignore . " TABLE `" . $temp_name . "` " . $sql2; + $sql3 = "ALTER" . $ignore . " TABLE `" . $name . "` " . $sql2; } else { $sql3 .= ", " . $sql2; } @@ -676,7 +767,7 @@ class DBStructure // 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' => '']; @@ -690,7 +781,7 @@ class DBStructure 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; } @@ -703,36 +794,8 @@ class DBStructure $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) { @@ -740,50 +803,10 @@ class DBStructure DI::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; - } - } - } - $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; - } - } - } } } } @@ -837,7 +860,7 @@ class DBStructure } 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"]; } @@ -858,7 +881,7 @@ class DBStructure $fielddata = []; if (DBA::isResult($fields)) { - foreach ($fields AS $field) { + 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['COLUMN_TYPE'] = str_replace($search, $replace, $field['COLUMN_TYPE']); @@ -947,37 +970,6 @@ class DBStructure return sprintf("DROP FOREIGN KEY `%s`", $constraint); } - /** - * Constructs a GROUP BY clause from a UNIQUE index definition. - * - * @param array $fieldnames - * @return string - */ - private static function groupBy(array $fieldnames) - { - if ($fieldnames[0] != "UNIQUE") { - return ""; - } - - array_shift($fieldnames); - - $names = ""; - foreach ($fieldnames AS $fieldname) { - if ($names != "") { - $names .= ","; - } - - if (preg_match('|(.+)\((\d+)\)|', $fieldname, $matches)) { - $names .= "`" . DBA::escape($matches[1]) . "`"; - } else { - $names .= "`" . DBA::escape($fieldname) . "`"; - } - } - - $sql = sprintf(" GROUP BY %s", $names); - return $sql; - } - /** * Renames columns or the primary key of a table * @@ -1063,7 +1055,7 @@ class DBStructure $table = DBA::escape($table); - foreach ($columns AS $column) { + foreach ($columns as $column) { $sql = "SHOW COLUMNS FROM `" . $table . "` LIKE '" . $column . "';"; $stmt = DBA::p($sql); @@ -1197,7 +1189,7 @@ class DBStructure if ($verbose) { echo "Zero contact added\n"; } - } + } } elseif (self::existsTable('contact') && $verbose) { echo "Zero contact already added\n"; } elseif ($verbose) { @@ -1221,7 +1213,7 @@ class DBStructure if (self::existsTable('permissionset')) { if (!DBA::exists('permissionset', ['id' => 0])) { - DBA::insert('permissionset', ['allow_cid' => '', 'allow_gid' => '', 'deny_cid' => '', 'deny_gid' => '']); + DBA::insert('permissionset', ['allow_cid' => '', 'allow_gid' => '', 'deny_cid' => '', 'deny_gid' => '']); $lastid = DBA::lastInsertId(); if ($lastid != 0) { DBA::update('permissionset', ['id' => 0], ['id' => $lastid]); @@ -1256,8 +1248,8 @@ class DBStructure } elseif ($verbose) { echo "permissionset: Table not found\n"; } - - if (!self::existsForeignKeyForField('tokens', 'client_id')) { + + 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");