<?php
/**
- * @file src/Database/DBStructure.php
+ * @copyright Copyright (C) 2020, Friendica
+ *
+ * @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\L10n;
use Friendica\Core\Logger;
+use Friendica\DI;
use Friendica\Util\DateTimeFormat;
-require_once 'boot.php';
-require_once 'include/dba.php';
-require_once 'include/enotify.php';
-require_once 'include/text.php';
+require_once __DIR__ . '/../../include/dba.php';
/**
- * @brief This class contain functions for the database management
- *
* This class contains functions that doesn't need to know if pdo, mysqli or whatever is used.
*/
class DBStructure
*/
private static $definition = [];
- /*
- * Converts all tables from MyISAM to InnoDB
+ /**
+ * Converts all tables from MyISAM/InnoDB Antelope to InnoDB Barracuda
*/
public static function convertToInnoDB()
{
- $r = q("SELECT `TABLE_NAME` FROM `information_schema`.`tables` WHERE `engine` = 'MyISAM' AND `table_schema` = '%s'",
- DBA::escape(DBA::databaseName()));
-
- if (!DBA::isResult($r)) {
- echo L10n::t('There are no tables on MyISAM.') . "\n";
+ $tables = DBA::selectToArray(
+ ['information_schema' => 'tables'],
+ ['table_name'],
+ ['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 or InnoDB with the Antelope file format.') . "\n";
return;
}
- foreach ($r AS $table) {
- $sql = sprintf("ALTER TABLE `%s` engine=InnoDB;", DBA::escape($table['TABLE_NAME']));
+ foreach ($tables AS $table) {
+ $sql = "ALTER TABLE " . DBA::quoteIdentifier($table['table_name']) . " ENGINE=InnoDB ROW_FORMAT=DYNAMIC;";
echo $sql . "\n";
$result = DBA::e($sql);
}
/**
- * @brief Print out database error messages
+ * Print out database error messages
*
* @param string $message Message to be added to the error message
*
*/
private static function printUpdateError($message)
{
- echo L10n::t("\nError %d occurred during database update:\n%s\n",
+ echo DI::l10n()->t("\nError %d occurred during database update:\n%s\n",
DBA::errorNo(), DBA::errorMessage());
- return L10n::t('Errors encountered performing database changes: ') . $message . EOL;
+ return DI::l10n()->t('Errors encountered performing database changes: ') . $message . EOL;
}
- public static function printStructure()
+ public static function printStructure($basePath)
{
- $database = self::definition(false);
+ $database = self::definition($basePath, false);
echo "-- ------------------------------------------\n";
echo "-- " . FRIENDICA_PLATFORM . " " . FRIENDICA_VERSION . " (" . FRIENDICA_CODENAME, ")\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 config/dbstructure.config.php
+ * @see static/dbstructure.config.php
* @param boolean $with_addons_structure Whether to tack on addons additional tables
+ * @param string $basePath The base path of this application
* @return array
* @throws Exception
*/
- public static function definition($with_addons_structure = true)
+ public static function definition($basePath, $with_addons_structure = true)
{
if (!self::$definition) {
- $a = \Friendica\BaseObject::getApp();
- $filename = $a->getBasePath() . '/config/dbstructure.config.php';
+ $filename = $basePath . '/static/dbstructure.config.php';
if (!is_readable($filename)) {
- throw new Exception('Missing database structure config file config/dbstructure.config.php');
+ throw new Exception('Missing database structure config file static/dbstructure.config.php');
}
$definition = require $filename;
if (!$definition) {
- throw new Exception('Corrupted database structure config file config/dbstructure.config.php');
+ throw new Exception('Corrupted database structure config file static/dbstructure.config.php');
}
self::$definition = $definition;
throw new Exception("Invalid parameter 'method' in self::createIndex(): '$method'");
}
- if ($fieldnames[0] == "UNIQUE") {
- array_shift($fieldnames);
- $method .= ' UNIQUE';
+ if (in_array($fieldnames[0], ["UNIQUE", "FULLTEXT"])) {
+ $index_type = array_shift($fieldnames);
+ $method .= " " . $index_type;
}
$names = "";
/**
* Updates DB structure and returns eventual errors messages
*
- * @param bool $verbose
- * @param bool $action Whether to actually apply the update
- * @param bool $install Is this the initial update during the installation?
- * @param array $tables An array of the database tables
- * @param array $definition An array of the definition tables
+ * @param string $basePath The base path of this application
+ * @param bool $verbose
+ * @param bool $action Whether to actually apply the update
+ * @param bool $install Is this the initial update during the installation?
+ * @param array $tables An array of the database tables
+ * @param array $definition An array of the definition tables
* @return string Empty string if the update is successful, error messages otherwise
+ * @throws Exception
*/
- public static function update($verbose, $action, $install = false, array $tables = null, array $definition = null)
+ public 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', L10n::t('%s: Database update', DateTimeFormat::utcNow() . ' ' . date('e')));
+ DI::config()->set('system', 'maintenance', 1);
+ DI::config()->set('system', 'maintenance_reason', DI::l10n()->t('%s: Database update', DateTimeFormat::utcNow() . ' ' . date('e')));
}
$errors = '';
// Get the definition
if (is_null($definition)) {
- $definition = self::definition();
+ $definition = self::definition($basePath);
}
// MySQL >= 5.7.4 doesn't support the IGNORE keyword in ALTER TABLE statements
$sql2 = self::createIndex($indexname, $fieldnames);
// Fetch the "group by" fields for unique indexes
- if ($fieldnames[0] == "UNIQUE") {
- $group_by = self::groupBy($indexname, $fieldnames);
- }
+ $group_by = self::groupBy($fieldnames);
if ($sql2 != "") {
if ($sql3 == "") {
$sql3 = "ALTER" . $ignore . " TABLE `" . $temp_name . "` " . $sql2;
}
if (isset($database[$name]["table_status"]["Comment"])) {
- $structurecomment = defaults($structure, "comment", "");
+ $structurecomment = $structure["comment"] ?? '';
if ($database[$name]["table_status"]["Comment"] != $structurecomment) {
$sql2 = "COMMENT = '" . DBA::escape($structurecomment) . "'";
// Compare the field structure field by field
foreach ($structure["fields"] AS $fieldname => $parameters) {
// Compare the field definition
- $field_definition = defaults($database[$name]["fields"], $fieldname, ['Collation' => '']);
+ $field_definition = ($database[$name]["fields"][$fieldname] ?? '') ?: ['Collation' => ''];
// Define the default collation if not given
if (!isset($parameters['Collation']) && !empty($field_definition['Collation'])) {
if ($action) {
if (!$install) {
- Config::set('system', 'maintenance_reason', L10n::t('%s: updating %s table.', DateTimeFormat::utcNow() . ' ' . date('e'), $name));
+ 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
}
}
+ View::create($verbose, $action);
+
if ($action && !$install) {
- Config::set('system', 'maintenance', 0);
- Config::set('system', 'maintenance_reason', '');
+ DI::config()->set('system', 'maintenance', 0);
+ DI::config()->set('system', 'maintenance_reason', '');
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);
}
}
if (DBA::isResult($indexes)) {
foreach ($indexes AS $index) {
- if ($index['Key_name'] != 'PRIMARY' && $index['Non_unique'] == '0' && !isset($indexdata[$index["Key_name"]])) {
- $indexdata[$index["Key_name"]] = ['UNIQUE'];
+ if ($index["Key_name"] != "PRIMARY" && $index["Non_unique"] == "0" && !isset($indexdata[$index["Key_name"]])) {
+ $indexdata[$index["Key_name"]] = ["UNIQUE"];
+ }
+
+ if ($index["Index_type"] == "FULLTEXT" && !isset($indexdata[$index["Key_name"]])) {
+ $indexdata[$index["Key_name"]] = ["FULLTEXT"];
}
$column = $index["Column_name"];
return ($sql);
}
- private static function groupBy($indexname, $fieldnames)
+ /**
+ * 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 "";
* @todo You cannot rename a primary key if "auto increment" is set
*
* @param string $table Table name
- * @param array $columns Columns Syntax for Rename: [ $old1 => [ $new1, $type1 ], $old2 => [ $new2, $type2 ], ... ] )
- * Syntax for Primary Key: [ $col1, $col2, ...] )
+ * @param array $columns Columns Syntax for Rename: [ $old1 => [ $new1, $type1 ], $old2 => [ $new2, $type2 ], ... ]
+ * Syntax for Primary Key: [ $col1, $col2, ...]
* @param int $type The type of renaming (Default is Column)
*
* @return boolean Was the renaming successful?
- *
+ * @throws Exception
*/
public static function rename($table, $columns, $type = self::RENAME_COLUMN)
{
* @param array $columns Columns to check ( Syntax: [ $col1, $col2, .. ] )
*
* @return boolean Does the table exist?
+ * @throws Exception
*/
public static function existsColumn($table, $columns = [])
{
/**
* Check if a table exists
*
- * @param string $table Table name
+ * @param string|array $table Table name
*
* @return boolean Does the table exist?
+ * @throws Exception
*/
public static function existsTable($table)
{
return false;
}
- $table = DBA::escape($table);
-
- $sql = "SHOW TABLES LIKE '" . $table . "';";
-
- $stmt = DBA::p($sql);
-
- if (is_bool($stmt)) {
- $retval = $stmt;
+ if (is_array($table)) {
+ $condition = ['table_schema' => key($table), 'table_name' => current($table)];
} else {
- $retval = (DBA::numRows($stmt) > 0);
+ $condition = ['table_schema' => DBA::databaseName(), 'table_name' => $table];
}
- DBA::close($stmt);
+ $result = DBA::exists(['information_schema' => 'tables'], $condition);
- return $retval;
+ return $result;
+ }
+
+ /**
+ * Returns the columns of a table
+ *
+ * @param string $table Table name
+ *
+ * @return array An array of the table columns
+ * @throws Exception
+ */
+ public static function getColumns($table)
+ {
+ $stmtColumns = DBA::p("SHOW COLUMNS FROM `" . $table . "`");
+ return DBA::toArray($stmtColumns);
}
}