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);
+ }
+
/**
* Converts all tables from MyISAM/InnoDB Antelope to InnoDB Barracuda
*/
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])) {
+ $fields[$field] = $data[$field];
+ }
+ }
+
+ return $fields;
+ }
+
private static function createTable($name, $structure, $verbose, $action)
{
$r = true;
$comment = "";
$sql_rows = [];
$primary_keys = [];
+ $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 ($foreign_keys AS $fieldname => $parameters) {
+ $sql_rows[] = self::foreignCommand($name, $fieldname, $parameters);
+ }
+
if (isset($structure["engine"])) {
$engine = " ENGINE=" . $structure["engine"];
}
public static function update($basePath, $verbose, $action, $install = false, array $tables = null, array $definition = null)
{
if ($action && !$install) {
+ if (self::isUpdating()) {
+ return DI::l10n()->t('Another database update is currently running.');
+ }
+
DI::config()->set('system', 'maintenance', 1);
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);
$database = [];
if (is_null($tables)) {
- $tables = q("SHOW TABLES");
+ $tables = DBA::toArray(DBA::p("SHOW TABLES"));
}
if (DBA::isResult($tables)) {
// 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 (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 `" . $temp_name . "` " . $sql2;
+ } else {
+ $sql3 .= ", " . $sql2;
+ }
+ }
+ }
+
+ foreach ($existing_foreign_keys as $param) {
+ $sql2 = self::dropForeignKey($param['CONSTRAINT_NAME']);
+
+ if ($sql3 == "") {
+ $sql3 = "ALTER" . $ignore . " TABLE `" . $temp_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 == "") {
}
}
- 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 == "") {
}
}
- View::create($verbose, $action);
+ View::create(false, $action);
+
+ self::checkInitialValues();
if ($action && !$install) {
DI::config()->set('system', 'maintenance', 0);
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) {
$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);
}
+ private static function getConstraintName(string $tablename, string $fieldname, array $parameters)
+ {
+ $foreign_table = array_keys($parameters['foreign'])[0];
+ $foreign_field = array_values($parameters['foreign'])[0];
+
+ return $tablename . "-" . $fieldname. "-" . $foreign_table. "-" . $foreign_field;
+ }
+
+ private static function foreignCommand(string $tablename, string $fieldname, array $parameters) {
+ $foreign_table = array_keys($parameters['foreign'])[0];
+ $foreign_field = array_values($parameters['foreign'])[0];
+
+ $sql = "FOREIGN KEY (`" . $fieldname . "`) REFERENCES `" . $foreign_table . "` (`" . $foreign_field . "`)";
+
+ 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";
+ }
+
+ 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);
+ }
+
/**
* Constructs a GROUP BY clause from a UNIQUE index definition.
*
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()
+ {
+ if (self::existsTable('verb') && !DBA::exists('verb', ['id' => 1])) {
+ foreach (Item::ACTIVITIES as $index => $activity) {
+ DBA::insert('verb', ['id' => $index + 1, 'name' => $activity], true);
+ }
+ }
+
+ 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 (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 (!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);
+ }
+ }
+
+ 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 (self::existsTable('user') && !DBA::exists('user', ['uid' => 0])) {
+ $system = User::getSystemAccount();
+ $user = [
+ "username" => $system['name'],
+ "nickname" => $system['nick'],
+ "register_date" => $system['created'],
+ "pubkey" => $system['pubkey'],
+ "prvkey" => $system['prvkey'],
+ "spubkey" => $system['spubkey'],
+ "sprvkey" => $system['sprvkey'],
+ "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 (!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