<?php
/**
- * @copyright Copyright (C) 2020, Friendica
+ * @copyright Copyright (C) 2010-2021, the Friendica project
*
* @license GNU AGPL version 3 or any later version
*
use Friendica\Core\Hook;
use Friendica\Core\Logger;
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 = [];
+ /**
+ * 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'];
+
+ $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 ($tables as $table) {
+ if (in_array($table['TABLE_NAME'], $old_tables)) {
+ if ($execute) {
+ $sql = 'DROP TABLE ' . DBA::quoteIdentifier($table['TABLE_NAME']) . ';';
+ echo $sql . "\n";
+
+ $result = DBA::e($sql);
+ if (!DBA::isResult($result)) {
+ self::printUpdateError($sql);
+ }
+ } else {
+ echo $table['TABLE_NAME'] . "\n";
+ }
+ }
+ }
+ }
+
/**
* Converts all tables from MyISAM/InnoDB Antelope to InnoDB Barracuda
*/
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;
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) {
- DI::config()->set('system', 'maintenance', 1);
+ $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 = [];
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);
}
}
}
}
- foreach ($existing_foreign_keys as $constraint => $param) {
- $sql2 = self::dropForeignKey($constraint);
+ foreach ($existing_foreign_keys as $param) {
+ $sql2 = self::dropForeignKey($param['CONSTRAINT_NAME']);
if ($sql3 == "") {
$sql3 = "ALTER" . $ignore . " TABLE `" . $temp_name . "` " . $sql2;
}
}
- if (isset($database[$name]["table_status"]["Comment"])) {
+ 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 == "") {
}
}
- 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 == "") {
}
}
- 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 == "") {
}
if ($action) {
- if (!$install) {
+ if ($in_maintenance_mode) {
DI::config()->set('system', 'maintenance_reason', DI::l10n()->t('%s: updating %s table.', DateTimeFormat::utcNow() . ' ' . date('e'), $name));
}
View::create(false, $action);
- if ($action && !$install) {
- DI::config()->set('system', 'maintenance', 0);
- DI::config()->set('system', 'maintenance_reason', '');
+ self::checkInitialValues();
+ if ($action && !$install) {
if ($errors) {
DI::config()->set('system', 'dbupdate', self::UPDATE_FAILED);
} else {
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]);
$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]);
- $table_status = q("SHOW TABLE STATUS WHERE `name` = '%s'", $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 = [];
if (DBA::isResult($foreign_keys)) {
foreach ($foreign_keys as $foreign_key) {
- $constraint = $foreign_key['CONSTRAINT_NAME'];
- unset($foreign_key['CONSTRAINT_NAME']);
+ $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;
}
}
$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'];
}
}
$foreign_table = array_keys($parameters['foreign'])[0];
$foreign_field = array_values($parameters['foreign'])[0];
- $constraint = self::getConstraintName($tablename, $fieldname, $parameters);
-
- $sql = "CONSTRAINT `" . $constraint . "` FOREIGN KEY (`" . $fieldname . "`)" .
- " REFERENCES `" . $foreign_table . "` (`" . $foreign_field . "`)";
+ $sql = "FOREIGN KEY (`" . $fieldname . "`) REFERENCES `" . $foreign_table . "` (`" . $foreign_field . "`)";
if (!empty($parameters['foreign']['on update'])) {
$sql .= " ON UPDATE " . strtoupper($parameters['foreign']['on update']);
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::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;
+ }
}
projects / friendica.git / blobdiff