$installer->resetChecks();
- if (!$installer->installDatabase($basePathConf)) {
+ if (!$installer->installDatabase()) {
$errorMessage = $this->extractErrors($installer->getChecks());
throw new RuntimeException($errorMessage);
}
use Friendica\Core\Update;
use Friendica\Database\Database;
use Friendica\Database\DBStructure;
+use Friendica\Database\Definition\DbaDefinition;
+use Friendica\Database\Definition\ViewDefinition;
+use Friendica\Util\BasePath;
+use Friendica\Util\Writer\DbaDefinitionSqlWriter;
+use Friendica\Util\Writer\DocWriter;
+use Friendica\Util\Writer\ViewDefinitionSqlWriter;
use RuntimeException;
/**
* @var Cache
*/
private $configCache;
+ /**
+ * @var DbaDefinition
+ */
+ private $dbaDefinition;
+ /**
+ * @var ViewDefinition
+ */
+ private $viewDefinition;
+ /**
+ * @var string
+ */
+ private $basePath;
protected function getHelp()
{
return $help;
}
- public function __construct(Database $dba, Cache $configCache, $argv = null)
+ public function __construct(Database $dba, DbaDefinition $dbaDefinition, ViewDefinition $viewDefinition, BasePath $basePath, Cache $configCache, $argv = null)
{
parent::__construct($argv);
$this->dba = $dba;
+ $this->dbaDefinition = $dbaDefinition;
+ $this->viewDefinition = $viewDefinition;
$this->configCache = $configCache;
+ $this->basePath = $basePath->getPath();
}
protected function doExecute()
$output = ob_get_clean();
break;
case "dumpsql":
- DBStructure::writeStructure();
- ob_start();
- DBStructure::printStructure($basePath);
- $output = ob_get_clean();
+ DocWriter::writeDbDefinition($this->dbaDefinition, $this->basePath);
+ $output = DbaDefinitionSqlWriter::create($this->dbaDefinition);
+ $output .= ViewDefinitionSqlWriter::create($this->viewDefinition);
break;
case "toinnodb":
ob_start();
/***
* Installs the DB-Scheme for Friendica
*
- * @param string $basePath The base path of this application
- *
* @return bool true if the installation was successful, otherwise false
* @throws Exception
*/
- public function installDatabase($basePath)
+ public function installDatabase()
{
- $result = DBStructure::install($basePath);
+ $result = DBStructure::install();
if ($result) {
$txt = DI::l10n()->t('You may need to import the file "database.sql" manually using phpmyadmin or mysql.') . EOL;
/**
* @return Database\Database
*/
- public static function dba()
+ public static function dba(): Database\Database
{
return self::$dice->create(Database\Database::class);
}
+ /**
+ * @return \Friendica\Database\Definition\DbaDefinition
+ */
+ public static function dbaDefinition(): Database\Definition\DbaDefinition
+ {
+ return self::$dice->create(Database\Definition\DbaDefinition::class);
+ }
+
+ /**
+ * @return \Friendica\Database\Definition\ViewDefinition
+ */
+ public static function viewDefinition(): Database\Definition\ViewDefinition
+ {
+ return self::$dice->create(Database\Definition\ViewDefinition::class);
+ }
+
//
// "App" namespace instances
//
namespace Friendica\Database;
use Exception;
-use Friendica\Core\Hook;
use Friendica\Core\Logger;
-use Friendica\Core\Renderer;
use Friendica\DI;
use Friendica\Model\Item;
use Friendica\Model\User;
use Friendica\Util\DateTimeFormat;
+use Friendica\Util\Writer\DbaDefinitionSqlWriter;
/**
* This class contains functions that doesn't need to know if pdo, mysqli or whatever is used.
const RENAME_COLUMN = 0;
const RENAME_PRIMARY_KEY = 1;
- /**
- * Database structure definition loaded from config/dbstructure.config.php
- *
- * @var array
- */
- private static $definition = [];
-
/**
* Set a database version to trigger update functions
*
return DI::l10n()->t('Errors encountered performing database changes: ') . $message . EOL;
}
- public static function writeStructure()
- {
- $tables = [];
- foreach (self::definition('') 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(string $basePath)
- {
- $database = self::definition($basePath, false);
-
- echo "-- ------------------------------------------\n";
- 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) {
- echo "--\n";
- echo "-- TABLE $name\n";
- echo "--\n";
- self::createTable($name, $structure, true, false);
-
- echo "\n";
- }
-
- View::printStructure($basePath);
- }
-
- /**
- * Loads the database structure definition from the static/dbstructure.config.php file.
- * On first pass, defines DB_UPDATE_VERSION constant.
- *
- * @see static/dbstructure.config.php
- * @param string $basePath The base path of this application
- * @param boolean $with_addons_structure Whether to tack on addons additional tables
- * @return array
- * @throws Exception
- */
- public static function definition(string $basePath, bool $with_addons_structure = true): array
- {
- if (!self::$definition) {
- if (empty($basePath)) {
- $basePath = DI::app()->getBasePath();
- }
-
- $filename = $basePath . '/static/dbstructure.config.php';
-
- if (!is_readable($filename)) {
- throw new Exception('Missing database structure config file static/dbstructure.config.php at basePath=' . $basePath);
- }
-
- $definition = require $filename;
-
- if (!$definition) {
- throw new Exception('Corrupted database structure config file static/dbstructure.config.php');
- }
-
- self::$definition = $definition;
- } else {
- $definition = self::$definition;
- }
-
- if ($with_addons_structure) {
- Hook::callAll('dbstructure_definition', $definition);
- }
-
- return $definition;
- }
-
- /**
- * Get field data for the given table
- *
- * @param string $table Tavle to load field definitions for
- * @param array $data data fields
- * @return array fields for the given
- */
- public static function getFieldsForTable(string $table, array $data = []): array
- {
- $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;
- }
-
- /**
- * Creates given table with structure
- *
- * @param string $name Name of table
- * @param array $structure Structure of table
- * @param boolean $verbose Output SQL statements
- * @param boolean $action Whether to run the SQL commands
- * @return Whether the SQL command ran successful
- */
- private static function createTable(string $name, array $structure, bool $verbose, bool $action): bool
- {
- $r = true;
-
- $engine = '';
- $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 ($structure['indexes'] as $indexName => $fieldNames) {
- $sql_index = self::createIndex($indexName, $fieldNames, '');
- if (!is_null($sql_index)) {
- $sql_rows[] = $sql_index;
- }
- }
- }
-
- foreach ($foreign_keys as $fieldName => $parameters) {
- $sql_rows[] = self::foreignCommand($name, $fieldName, $parameters);
- }
-
- if (isset($structure['engine'])) {
- $engine = ' ENGINE=' . $structure['engine'];
- }
-
- if (isset($structure['comment'])) {
- $comment = " COMMENT='" . DBA::escape($structure['comment']) . "'";
- }
-
- $sql = implode(",\n\t", $sql_rows);
-
- $sql = sprintf("CREATE TABLE IF NOT EXISTS `%s` (\n\t", DBA::escape($name)) . $sql .
- "\n)" . $engine . " DEFAULT COLLATE utf8mb4_general_ci" . $comment;
- if ($verbose) {
- echo $sql . ";\n";
- }
-
- if ($action) {
- $r = DBA::e($sql);
- }
-
- return $r;
- }
-
- /**
- * Returns SQL statement for field
- *
- * @param array $parameters Parameters for SQL statement
- * @param boolean $create Whether to include PRIMARY KEY statement (unused)
- * @return string SQL statement part
- */
- private static function FieldCommand(array $parameters, bool $create = true): string
- {
- $fieldstruct = $parameters['type'];
-
- if (isset($parameters['Collation'])) {
- $fieldstruct .= ' COLLATE ' . $parameters['Collation'];
- }
-
- if (isset($parameters['not null'])) {
- $fieldstruct .= ' NOT NULL';
- }
-
- if (isset($parameters['default'])) {
- if (strpos(strtolower($parameters['type']), 'int') !== false) {
- $fieldstruct .= ' DEFAULT ' . $parameters['default'];
- } else {
- $fieldstruct .= " DEFAULT '" . $parameters['default'] . "'";
- }
- }
- if (isset($parameters['extra'])) {
- $fieldstruct .= ' ' . $parameters['extra'];
- }
-
- if (isset($parameters['comment'])) {
- $fieldstruct .= " COMMENT '" . DBA::escape($parameters['comment']) . "'";
- }
-
- /*if (($parameters['primary'] != '') && $create)
- $fieldstruct .= ' PRIMARY KEY';*/
-
- return $fieldstruct;
- }
-
- private static function createIndex(string $indexName, array $fieldNames, string $method = 'ADD')
- {
- $method = strtoupper(trim($method));
- if ($method != '' && $method != 'ADD') {
- throw new Exception("Invalid parameter 'method' in self::createIndex(): '$method'");
- }
-
- if (in_array($fieldNames[0], ['UNIQUE', 'FULLTEXT'])) {
- $index_type = array_shift($fieldNames);
- $method .= " " . $index_type;
- }
-
- $names = "";
- foreach ($fieldNames as $fieldName) {
- if ($names != '') {
- $names .= ',';
- }
-
- if (preg_match('|(.+)\((\d+)\)|', $fieldName, $matches)) {
- $names .= "`" . DBA::escape($matches[1]) . "`(" . intval($matches[2]) . ")";
- } else {
- $names .= "`" . DBA::escape($fieldName) . "`";
- }
- }
-
- if ($indexName == 'PRIMARY') {
- return sprintf("%s PRIMARY KEY(%s)", $method, $names);
- }
-
-
- return sprintf("%s INDEX `%s` (%s)", $method, DBA::escape($indexName), $names);
- }
-
/**
* Perform a database structure dryrun (means: just simulating)
*
* @throws Exception
*/
- public static function dryRun()
+ public static function dryRun(): string
{
- self::update(DI::app()->getBasePath(), true, false);
+ return self::update(true, false);
}
/**
DI::config()->set('system', 'maintenance', 1);
}
- $status = self::update(DI::app()->getBasePath(), $verbose, true);
+ $status = self::update($verbose, true);
if ($enable_maintenance_mode) {
DI::config()->set('system', 'maintenance', 0);
/**
* 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): string
+ public static function install(): string
{
- return self::update($basePath, false, true, true);
+ return self::update(false, true, true);
}
/**
* Updates DB structure and returns eventual errors messages
*
- * @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?
* @return string Empty string if the update is successful, error messages otherwise
* @throws Exception
*/
- private static function update(string $basePath, bool $verbose, bool $action, bool $install = false, array $tables = null, array $definition = null): string
+ private static function update(bool $verbose, bool $action, bool $install = false, array $tables = null, array $definition = null): string
{
$in_maintenance_mode = DI::config()->get('system', 'maintenance');
// Get the definition
if (is_null($definition)) {
- $definition = self::definition($basePath);
+ $definition = DI::dbaDefinition()->getAll();
}
// MySQL >= 5.7.4 doesn't support the IGNORE keyword in ALTER TABLE statements
// Compare it
foreach ($definition as $name => $structure) {
$is_new_table = false;
- $sql3 = "";
+ $sql3 = "";
if (!isset($database[$name])) {
- $r = self::createTable($name, $structure, $verbose, $action);
- if (!DBA::isResult($r)) {
- $errors .= self::printUpdateError($name);
+ $sql = DbaDefinitionSqlWriter::createTable($name, $structure, $verbose, $action);
+ if ($verbose) {
+ echo $sql;
+ }
+ if ($action) {
+ $r = DBA::e($sql);
+ if (!DBA::isResult($r)) {
+ $errors .= self::printUpdateError($name);
+ }
}
$is_new_table = true;
} else {
$new_index_definition = "__NOT_SET__";
}
if ($current_index_definition != $new_index_definition && substr($indexName, 0, 6) != 'local_') {
- $sql2 = self::dropIndex($indexName);
+ $sql2 = DbaDefinitionSqlWriter::dropIndex($indexName);
if ($sql3 == "") {
$sql3 = "ALTER" . $ignore . " TABLE `" . $name . "` " . $sql2;
} else {
// Compare the field structure field by field
foreach ($structure["fields"] as $fieldName => $parameters) {
if (!isset($database[$name]["fields"][$fieldName])) {
- $sql2 = self::addTableField($fieldName, $parameters);
+ $sql2 = DbaDefinitionSqlWriter::addTableField($fieldName, $parameters);
if ($sql3 == "") {
$sql3 = "ALTER" . $ignore . " TABLE `" . $name . "` " . $sql2;
} else {
}
$current_field_definition = DBA::cleanQuery(implode(",", $field_definition));
- $new_field_definition = DBA::cleanQuery(implode(",", $parameters));
+ $new_field_definition = DBA::cleanQuery(implode(",", $parameters));
if ($current_field_definition != $new_field_definition) {
- $sql2 = self::modifyTableField($fieldName, $parameters);
+ $sql2 = DbaDefinitionSqlWriter::modifyTableField($fieldName, $parameters);
if ($sql3 == "") {
$sql3 = "ALTER" . $ignore . " TABLE `" . $name . "` " . $sql2;
} else {
}
$new_index_definition = implode(",", $fieldNames);
if ($current_index_definition != $new_index_definition) {
- $sql2 = self::createIndex($indexName, $fieldNames);
+ $sql2 = DbaDefinitionSqlWriter::createIndex($indexName, $fieldNames);
if ($sql2 != "") {
if ($sql3 == "") {
unset($existing_foreign_keys[$constraint]);
if (empty($database[$name]['foreign_keys'][$constraint])) {
- $sql2 = self::addForeignKey($name, $fieldName, $parameters);
+ $sql2 = DbaDefinitionSqlWriter::addForeignKey($fieldName, $parameters);
if ($sql3 == "") {
$sql3 = "ALTER" . $ignore . " TABLE `" . $name . "` " . $sql2;
}
foreach ($existing_foreign_keys as $param) {
- $sql2 = self::dropForeignKey($param['CONSTRAINT_NAME']);
+ $sql2 = DbaDefinitionSqlWriter::dropForeignKey($param['CONSTRAINT_NAME']);
if ($sql3 == "") {
$sql3 = "ALTER" . $ignore . " TABLE `" . $name . "` " . $sql2;
}
if ($field_definition['Collation'] != $parameters['Collation']) {
- $sql2 = self::modifyTableField($fieldName, $parameters);
+ $sql2 = DbaDefinitionSqlWriter::modifyTableField($fieldName, $parameters);
if (($sql3 == "") || (substr($sql3, -2, 2) == "; ")) {
$sql3 .= "ALTER" . $ignore . " TABLE `" . $name . "` " . $sql2;
} else {
$fields = DBA::selectToArray('INFORMATION_SCHEMA.COLUMNS',
['COLUMN_NAME', 'COLUMN_TYPE', 'IS_NULLABLE', 'COLUMN_DEFAULT', 'EXTRA',
- 'COLUMN_KEY', 'COLLATION_NAME', 'COLUMN_COMMENT'],
+ 'COLUMN_KEY', 'COLLATION_NAME', 'COLUMN_COMMENT'],
["`TABLE_SCHEMA` = ? AND `TABLE_NAME` = ?",
- DBA::databaseName(), $table]);
+ 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]);
+ DBA::databaseName(), $table]);
$table_status = DBA::selectFirst('INFORMATION_SCHEMA.TABLES',
['ENGINE', 'TABLE_COLLATION', 'TABLE_COMMENT'],
["`TABLE_SCHEMA` = ? AND `TABLE_NAME` = ?",
- DBA::databaseName(), $table]);
+ DBA::databaseName(), $table]);
- $fielddata = [];
- $indexdata = [];
+ $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);
+ $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;
}
}
$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'];
+ $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']);
$fielddata[$field['COLUMN_NAME']]['type'] = $field['COLUMN_TYPE'];
}
$fielddata[$field['COLUMN_NAME']]['Collation'] = $field['COLLATION_NAME'];
- $fielddata[$field['COLUMN_NAME']]['comment'] = $field['COLUMN_COMMENT'];
+ $fielddata[$field['COLUMN_NAME']]['comment'] = $field['COLUMN_COMMENT'];
}
}
return [
- 'fields' => $fielddata,
- 'indexes' => $indexdata,
+ 'fields' => $fielddata,
+ 'indexes' => $indexdata,
'foreign_keys' => $foreigndata,
'table_status' => $table_status
];
}
- private static function dropIndex(string $indexName): string
- {
- return sprintf("DROP INDEX `%s`", DBA::escape($indexName));
- }
-
- private static function addTableField(string $fieldName, array $parameters): string
- {
- return sprintf("ADD `%s` %s", DBA::escape($fieldName), self::FieldCommand($parameters));
- }
-
- private static function modifyTableField(string $fieldName, array $parameters): string
- {
- return sprintf("MODIFY `%s` %s", DBA::escape($fieldName), self::FieldCommand($parameters, false));
- }
-
private static function getConstraintName(string $tableName, string $fieldName, array $parameters): string
{
$foreign_table = array_keys($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): string
- {
- return sprintf("ADD %s", self::foreignCommand($tableName, $fieldName, $parameters));
- }
-
- private static function dropForeignKey(string $constraint): string
- {
- return sprintf("DROP FOREIGN KEY `%s`", $constraint);
- }
-
/**
* Renames columns or the primary key of a table
*
{
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]);
+ DBA::databaseName(), $table, $field]);
}
/**
if (self::existsTable('user') && !DBA::exists('user', ['uid' => 0])) {
$user = [
- 'verified' => true,
- 'page-flags' => User::PAGE_FLAGS_SOAPBOX,
+ 'verified' => true,
+ 'page-flags' => User::PAGE_FLAGS_SOAPBOX,
'account-type' => User::ACCOUNT_TYPE_RELAY,
];
DBA::insert('user', $user);
$permission = '';
}
$fields = ['id' => $set['psid'], 'uid' => $set['uid'], 'allow_cid' => $permission,
- 'allow_gid' => '', 'deny_cid' => '', 'deny_gid' => ''];
+ 'allow_gid' => '', 'deny_cid' => '', 'deny_gid' => ''];
DBA::insert('permissionset', $fields);
}
DBA::close($sets);
$isUpdate = false;
$processes = DBA::select('information_schema.processlist', ['info'], [
- 'db' => DBA::databaseName(),
+ 'db' => DBA::databaseName(),
'command' => ['Query', 'Execute']
]);
use Friendica\Core\Config\ValueObject\Cache;
use Friendica\Core\System;
+use Friendica\Database\Definition\DbaDefinition;
+use Friendica\Database\Definition\ViewDefinition;
use Friendica\Network\HTTPException\ServiceUnavailableException;
use Friendica\Util\DateTimeFormat;
use Friendica\Util\Profiler;
protected $in_retrial = false;
protected $testmode = false;
private $relation = [];
+ /** @var DbaDefinition */
+ protected $dbaDefinition;
+ /** @var ViewDefinition */
+ protected $viewDefinition;
- public function __construct(Cache $configCache, Profiler $profiler, LoggerInterface $logger)
+ public function __construct(Cache $configCache, Profiler $profiler, DbaDefinition $dbaDefinition, ViewDefinition $viewDefinition, LoggerInterface $logger)
{
// We are storing these values for being able to perform a reconnect
- $this->configCache = $configCache;
- $this->profiler = $profiler;
- $this->logger = $logger;
+ $this->configCache = $configCache;
+ $this->profiler = $profiler;
+ $this->logger = $logger;
+ $this->dbaDefinition = $dbaDefinition;
+ $this->viewDefinition = $viewDefinition;
$this->connect();
-
- if ($this->isConnected()) {
- // Loads DB_UPDATE_VERSION constant
- DBStructure::definition($configCache->get('system', 'basepath'), false);
- }
}
/**
$types = [];
- $tables = DBStructure::definition('', false);
+ $tables = $this->dbaDefinition->getAll();
if (empty($tables[$table])) {
// When a matching table wasn't found we check if it is a view
- $views = View::definition('', false);
+ $views = $this->viewDefinition->getAll();
if (empty($views[$table])) {
return $fields;
}
--- /dev/null
+<?php
+/**
+ * @copyright Copyright (C) 2010-2022, the Friendica project
+ *
+ * @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\Definition;
+
+use Exception;
+use Friendica\Core\Hook;
+
+/**
+ * Stores the whole database definition
+ */
+class DbaDefinition
+{
+ /** @var string The relative path of the db structure config file */
+ const DBSTRUCTURE_RELATIVE_PATH = '/static/dbstructure.config.php';
+
+ /** @var array The complete DB definition as an array */
+ protected $definition;
+
+ /** @var string */
+ protected $configFile;
+
+ /**
+ * @param string $basePath The basepath of the dbstructure file (loads relative path in case of null)
+ *
+ * @throws Exception in case the config file isn't available/readable
+ */
+ public function __construct(string $basePath)
+ {
+ $this->configFile = $basePath . static::DBSTRUCTURE_RELATIVE_PATH;
+
+ if (!is_readable($this->configFile)) {
+ throw new Exception('Missing database structure config file static/dbstructure.config.php at basePath=' . $basePath);
+ }
+ }
+
+ /**
+ * @return array Returns the whole Definition as an array
+ */
+ public function getAll(): array
+ {
+ return $this->definition;
+ }
+
+ /**
+ * Get field data for the given table
+ *
+ * @param string $table Tavle to load field definitions for
+ * @param array $data data fields
+ * @return array fields for the given
+ */
+ public function getFieldsForTable(string $table, array $data = []): array
+ {
+ $definition = $this->definition;
+ 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;
+ }
+
+ /**
+ * Loads the database structure definition from the static/dbstructure.config.php file.
+ * On first pass, defines DB_UPDATE_VERSION constant.
+ *
+ * @param bool $withAddonStructure Whether to tack on addons additional tables
+ *
+ * @throws Exception in case the definition cannot be found
+ *
+ * @see static/dbstructure.config.php
+ *
+ * @return self The current instance
+ */
+ public function load(bool $withAddonStructure = false): self
+ {
+ $definition = require $this->configFile;
+
+ if (!$definition) {
+ throw new Exception('Corrupted database structure config file static/dbstructure.config.php');
+ }
+
+ if ($withAddonStructure) {
+ Hook::callAll('dbstructure_definition', $definition);
+ }
+
+ $this->definition = $definition;
+
+ return $this;
+ }
+}
--- /dev/null
+<?php
+/**
+ * @copyright Copyright (C) 2010-2022, the Friendica project
+ *
+ * @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\Definition;
+
+use Exception;
+use Friendica\Core\Hook;
+
+/**
+ * Stores the whole View definitions
+ */
+class ViewDefinition
+{
+ /** @var string the relative path to the database view config file */
+ const DBSTRUCTURE_RELATIVE_PATH = '/static/dbview.config.php';
+
+ /** @var array The complete view definition as an array */
+ protected $definition;
+
+ /** @var string */
+ protected $configFile;
+
+ /**
+ * @param string $basePath The basepath of the dbview file (loads relative path in case of null)
+ *
+ * @throws Exception in case the config file isn't available/readable
+ */
+ public function __construct(string $basePath)
+ {
+ $this->configFile = $basePath . static::DBSTRUCTURE_RELATIVE_PATH;
+
+ if (!is_readable($this->configFile)) {
+ throw new Exception('Missing database structure config file static/dbview.config.php at basePath=' . $basePath);
+ }
+ }
+
+ /**
+ * @return array Returns the whole Definition as an array
+ */
+ public function getAll(): array
+ {
+ return $this->definition;
+ }
+
+ /**
+ * Loads the database structure definition from the static/dbview.config.php file.
+ * On first pass, defines DB_UPDATE_VERSION constant.
+ *
+ * @param bool $withAddonStructure Whether to tack on addons additional tables
+ *
+ * @throws Exception in case the definition cannot be found
+ *
+ * @see static/dbview.config.php
+ *
+ * @return self The current instance
+ */
+ public function load(bool $withAddonStructure = false): self
+ {
+ $definition = require $this->configFile;
+
+ if (!$definition) {
+ throw new Exception('Corrupted database structure config file static/dbstructure.config.php');
+ }
+
+ if ($withAddonStructure) {
+ Hook::callAll('dbview_definition', $definition);
+ }
+
+ $this->definition = $definition;
+
+ return $this;
+ }
+}
namespace Friendica\Database;
-use Exception;
-use Friendica\Core\Hook;
use Friendica\DI;
+use Friendica\Util\Writer\ViewDefinitionSqlWriter;
class View
{
- /**
- * view definition loaded from static/dbview.config.php
- *
- * @var array
- */
- private static $definition = [];
-
- /**
- * Loads the database structure definition from the static/dbview.config.php file.
- * On first pass, defines DB_UPDATE_VERSION constant.
- *
- * @see static/dbview.config.php
- * @param string $basePath The base path of this application
- * @param boolean $with_addons_structure Whether to tack on addons additional tables
- * @return array
- * @throws Exception
- */
- public static function definition(string $basePath = '', bool $with_addons_structure = true): array
- {
- if (!self::$definition) {
- if (empty($basePath)) {
- $basePath = DI::app()->getBasePath();
- }
-
- $filename = $basePath . '/static/dbview.config.php';
-
- if (!is_readable($filename)) {
- throw new Exception('Missing database view config file static/dbview.config.php');
- }
-
- $definition = require $filename;
-
- if (!$definition) {
- throw new Exception('Corrupted database view config file static/dbview.config.php');
- }
-
- self::$definition = $definition;
- } else {
- $definition = self::$definition;
- }
-
- if ($with_addons_structure) {
- Hook::callAll('dbview_definition', $definition);
- }
-
- return $definition;
- }
-
/**
* Creates a view
*
public static function create(bool $verbose, bool $action)
{
// Delete previously used views that aren't used anymore
- foreach(['post-view', 'post-thread-view'] as $view) {
+ foreach (['post-view', 'post-thread-view'] as $view) {
if (self::isView($view)) {
$sql = sprintf("DROP VIEW IF EXISTS `%s`", DBA::escape($view));
if (!empty($sql) && $verbose) {
echo $sql . ";\n";
}
-
+
if (!empty($sql) && $action) {
DBA::e($sql);
}
}
}
- $definition = self::definition();
+ $definition = DI::viewDefinition()->getAll();
foreach ($definition as $name => $structure) {
- self::createView($name, $structure, $verbose, $action);
- }
- }
-
- /**
- * Prints view structure
- *
- * @param string $basePath Base path
- * @return void
- */
- public static function printStructure(string $basePath)
- {
- $database = self::definition($basePath, false);
-
- foreach ($database as $name => $structure) {
- echo "--\n";
- echo "-- VIEW $name\n";
- echo "--\n";
- self::createView($name, $structure, true, false);
-
- echo "\n";
- }
- }
-
- /**
- * Creates view
- *
- * @param string $name Name of view
- * @param array $structure Structure of view
- * @param bool $verbose Whether to show SQL statements
- * @param bool $action Whether to execute SQL statements
- * @return bool Whether execution went fine
- */
- private static function createView(string $name, array $structure, bool $verbose, bool $action): bool
- {
- $r = true;
-
- $sql_rows = [];
- foreach ($structure['fields'] as $fieldname => $origin) {
- if (is_string($origin)) {
- $sql_rows[] = $origin . " AS `" . DBA::escape($fieldname) . "`";
- } elseif (is_array($origin) && (sizeof($origin) == 2)) {
- $sql_rows[] = "`" . DBA::escape($origin[0]) . "`.`" . DBA::escape($origin[1]) . "` AS `" . DBA::escape($fieldname) . "`";
+ if (self::isView($name)) {
+ DBA::e(sprintf("DROP VIEW IF EXISTS `%s`", DBA::escape($name)));
+ } elseif (self::isTable($name)) {
+ DBA::e(sprintf("DROP TABLE IF EXISTS `%s`", DBA::escape($name)));
}
+ DBA::e(ViewDefinitionSqlWriter::createView($name, $structure));
}
-
- if (self::isView($name)) {
- $sql = sprintf("DROP VIEW IF EXISTS `%s`", DBA::escape($name));
- } elseif (self::isTable($name)) {
- $sql = sprintf("DROP TABLE IF EXISTS `%s`", DBA::escape($name));
- }
-
- if (!empty($sql) && $verbose) {
- echo $sql . ";\n";
- }
-
- if (!empty($sql) && $action) {
- DBA::e($sql);
- }
-
- $sql = sprintf("CREATE VIEW `%s` AS SELECT \n\t", DBA::escape($name)) .
- implode(",\n\t", $sql_rows) . "\n\t" . $structure['query'];
-
- if ($verbose) {
- echo $sql . ";\n";
- }
-
- if ($action) {
- $r = DBA::e($sql);
- }
-
- return $r;
}
/**
}
// Limit the length on incoming fields
- $apcontact = DBStructure::getFieldsForTable('apcontact', $apcontact);
+ $apcontact = DI::dbaDefinition()->getFieldsForTable('apcontact', $apcontact);
if (DBA::exists('apcontact', ['url' => $apcontact['url']])) {
DBA::update('apcontact', $apcontact, ['url' => $apcontact['url']]);
use Friendica\Core\System;
use Friendica\Database\DBA;
-use Friendica\Database\DBStructure;
use Friendica\DI;
use Friendica\Core\Storage\Exception\InvalidClassStorageException;
use Friendica\Core\Storage\Exception\ReferenceStorageException;
*/
private static function getFields(): array
{
- $allfields = DBStructure::definition(DI::app()->getBasePath(), false);
+ $allfields = DI::dbaDefinition()->getAll();
$fields = array_keys($allfields['attach']['fields']);
array_splice($fields, array_search('data', $fields), 1);
return $fields;
use Friendica\Database\Database;
use Friendica\Database\DBA;
use Friendica\Database\DBStructure;
+use Friendica\DI;
use Friendica\Model\Contact;
use Friendica\Model\ItemURI;
use PDOException;
$fields['rel'] = Contact::SELF;
}
- return DBStructure::getFieldsForTable('user-contact', $fields);
+ return DI::dbaDefinition()->getFieldsForTable('user-contact', $fields);
}
/**
*/
public static function update(array $fields, array $condition): bool
{
- $fields = DBStructure::getFieldsForTable('gserver', $fields);
+ $fields = DI::dbaDefinition()->getFieldsForTable('gserver', $fields);
return DBA::update('gserver', $fields, $condition);
}
*/
private static function getFields(): array
{
- $allfields = DBStructure::definition(DI::app()->getBasePath(), false);
+ $allfields = DI::dbaDefinition()->getAll();
$fields = array_keys($allfields['photo']['fields']);
array_splice($fields, array_search('data', $fields), 1);
return $fields;
use Friendica\Database\Database;
use Friendica\Database\DBA;
use Friendica\Database\DBStructure;
+use Friendica\DI;
use Friendica\Protocol\Activity;
class Post
throw new BadMethodCallException('Empty URI_id');
}
- $fields = DBStructure::getFieldsForTable('post', $data);
+ $fields = DI::dbaDefinition()->getFieldsForTable('post', $data);
// Additionally assign the key fields
$fields['uri-id'] = $uri_id;
// To ensure the data integrity we do it in an transaction
DBA::transaction();
- $update_fields = DBStructure::getFieldsForTable('post-user', $fields);
+ $update_fields = DI::dbaDefinition()->getFieldsForTable('post-user', $fields);
if (!empty($update_fields)) {
$affected_count = 0;
$posts = DBA::select('post-user-view', ['post-user-id'], $condition);
$affected = $affected_count;
}
- $update_fields = DBStructure::getFieldsForTable('post-content', $fields);
+ $update_fields = DI::dbaDefinition()->getFieldsForTable('post-content', $fields);
if (!empty($update_fields)) {
$affected_count = 0;
$posts = DBA::select('post-user-view', ['uri-id'], $condition, ['group_by' => ['uri-id']]);
$affected = max($affected, $affected_count);
}
- $update_fields = DBStructure::getFieldsForTable('post', $fields);
+ $update_fields = DI::dbaDefinition()->getFieldsForTable('post', $fields);
if (!empty($update_fields)) {
$affected_count = 0;
$posts = DBA::select('post-user-view', ['uri-id'], $condition, ['group_by' => ['uri-id']]);
$affected = max($affected, $affected_count);
}
- $update_fields = DBStructure::getFieldsForTable('post-thread', $fields);
+ $update_fields = DI::dbaDefinition()->getFieldsForTable('post-thread', $fields);
if (!empty($update_fields)) {
$affected_count = 0;
$posts = DBA::select('post-user-view', ['uri-id'], $thread_condition, ['group_by' => ['uri-id']]);
$affected = max($affected, $affected_count);
}
- $update_fields = DBStructure::getFieldsForTable('post-thread-user', $fields);
+ $update_fields = DI::dbaDefinition()->getFieldsForTable('post-thread-user', $fields);
if (!empty($update_fields)) {
$affected_count = 0;
$posts = DBA::select('post-user-view', ['post-user-id'], $thread_condition);
use Friendica\Database\Database;
use Friendica\Database\DBA;
use Friendica\Database\DBStructure;
+use Friendica\DI;
use Friendica\Model\Post;
class Content
throw new BadMethodCallException('Empty URI_id');
}
- $fields = DBStructure::getFieldsForTable('post-content', $data);
+ $fields = DI::dbaDefinition()->getFieldsForTable('post-content', $data);
// Additionally assign the key fields
$fields['uri-id'] = $uri_id;
throw new BadMethodCallException('Empty URI_id');
}
- $fields = DBStructure::getFieldsForTable('post-content', $data);
+ $fields = DI::dbaDefinition()->getFieldsForTable('post-content', $data);
// Remove the key fields
unset($fields['uri-id']);
use Friendica\Core\Logger;
use Friendica\Database\DBA;
use Friendica\Database\Database;
-use Friendica\Database\DBStructure;
+use Friendica\DI;
use Friendica\Model\Post;
class History
*/
public static function add(int $uri_id, array $item)
{
- $allfields = DBStructure::definition('', false);
+ $allfields = DI::dbaDefinition()->getAll();
$fields = array_keys($allfields['post-history']['fields']);
$post = Post::selectFirstPost($fields, ['uri-id' => $uri_id]);
}
$update = false;
- $changed = DBStructure::getFieldsForTable('post-history', $item);
+ $changed = DI::dbaDefinition()->getFieldsForTable('post-history', $item);
unset($changed['uri-id']);
unset($changed['edited']);
foreach ($changed as $field => $content) {
use BadMethodCallException;
use Friendica\Database\DBA;
use Friendica\Database\DBStructure;
+use Friendica\DI;
class Question
{
throw new BadMethodCallException('Empty URI_id');
}
- $fields = DBStructure::getFieldsForTable('post-question', $data);
+ $fields = DI::dbaDefinition()->getFieldsForTable('post-question', $data);
// Remove the key fields
unset($fields['uri-id']);
use BadMethodCallException;
use Friendica\Database\DBA;
use Friendica\Database\DBStructure;
+use Friendica\DI;
class QuestionOption
{
throw new BadMethodCallException('Empty URI_id');
}
- $fields = DBStructure::getFieldsForTable('post-question-option', $data);
+ $fields = DI::dbaDefinition()->getFieldsForTable('post-question-option', $data);
// Remove the key fields
unset($fields['uri-id']);
use Friendica\Database\Database;
use Friendica\Database\DBA;
use Friendica\Database\DBStructure;
+use Friendica\DI;
class Thread
{
throw new BadMethodCallException('Empty URI_id');
}
- $fields = DBStructure::getFieldsForTable('post-thread', $data);
+ $fields = DI::dbaDefinition()->getFieldsForTable('post-thread', $data);
// Additionally assign the key fields
$fields['uri-id'] = $uri_id;
throw new BadMethodCallException('Empty URI_id');
}
- $fields = DBStructure::getFieldsForTable('post-thread', $data);
+ $fields = DI::dbaDefinition()->getFieldsForTable('post-thread', $data);
// Remove the key fields
unset($fields['uri-id']);
use Friendica\Database\Database;
use Friendica\Database\DBA;
use Friendica\Database\DBStructure;
+use Friendica\DI;
class ThreadUser
{
throw new BadMethodCallException('Empty URI_id');
}
- $fields = DBStructure::getFieldsForTable('post-thread-user', $data);
+ $fields = DI::dbaDefinition()->getFieldsForTable('post-thread-user', $data);
// Additionally assign the key fields
$fields['uri-id'] = $uri_id;
throw new BadMethodCallException('Empty URI_id');
}
- $fields = DBStructure::getFieldsForTable('post-thread-user', $data);
+ $fields = DI::dbaDefinition()->getFieldsForTable('post-thread-user', $data);
// Remove the key fields
unset($fields['uri-id']);
use \BadMethodCallException;
use Friendica\Database\Database;
use Friendica\Database\DBStructure;
+use Friendica\DI;
class User
{
return false;
}
- $fields = DBStructure::getFieldsForTable('post-user', $data);
+ $fields = DI::dbaDefinition()->getFieldsForTable('post-user', $data);
// Additionally assign the key fields
$fields['uri-id'] = $uri_id;
throw new BadMethodCallException('Empty URI_id');
}
- $fields = DBStructure::getFieldsForTable('post-user', $data);
+ $fields = DI::dbaDefinition()->getFieldsForTable('post-user', $data);
// Remove the key fields
unset($fields['uri-id']);
throw new BadMethodCallException('Empty URI_id');
}
- $fields = DBStructure::getFieldsForTable('post-user-notification', $data);
+ $fields = DI::dbaDefinition()->getFieldsForTable('post-user-notification', $data);
$fields['uri-id'] = $uri_id;
$fields['uid'] = $uid;
throw new BadMethodCallException('Empty URI_id');
}
- $fields = DBStructure::getFieldsForTable('post-user-notification', $data);
+ $fields = DI::dbaDefinition()->getFieldsForTable('post-user-notification', $data);
// Remove the key fields
unset($fields['uri-id']);
return;
}
- $this->installer->installDatabase($configCache->get('system', 'basepath'));
+ $this->installer->installDatabase();
// install allowed themes to register theme hooks
// this is same as "Reload active theme" in /admin/themes
*/
private static function exportMultiRow(string $query)
{
- $dbStructure = DBStructure::definition(DI::app()->getBasePath(), false);
+ $dbStructure = DI::dbaDefinition()->getAll();
preg_match("/\s+from\s+`?([a-z\d_]+)`?/i", $query, $match);
$table = $match[1];
*/
private static function exportRow(string $query)
{
- $dbStructure = DBStructure::definition(DI::app()->getBasePath(), false);
+ $dbStructure = DI::dbaDefinition()->getAll();
preg_match("/\s+from\s+`?([a-z\d_]+)`?/i", $query, $match);
$table = $match[1];
--- /dev/null
+<?php
+/**
+ * @copyright Copyright (C) 2010-2022, the Friendica project
+ *
+ * @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\Util\Writer;
+
+use Exception;
+use Friendica\Database\Definition\DbaDefinition;
+
+/**
+ * SQL writer utility for the database definition
+ */
+class DbaDefinitionSqlWriter
+{
+ /**
+ * Creates a complete SQL definition bases on a give DBA Definition class
+ *
+ * @param DbaDefinition $definition The DBA definition class
+ *
+ * @return string The SQL definition as a string
+ *
+ * @throws Exception in case of parameter failures
+ */
+ public static function create(DbaDefinition $definition): string
+ {
+ $sqlString = "-- ------------------------------------------\n";
+ $sqlString .= "-- " . FRIENDICA_PLATFORM . " " . FRIENDICA_VERSION . " (" . FRIENDICA_CODENAME . ")\n";
+ $sqlString .= "-- DB_UPDATE_VERSION " . DB_UPDATE_VERSION . "\n";
+ $sqlString .= "-- ------------------------------------------\n\n\n";
+
+ foreach ($definition->getAll() as $tableName => $tableStructure) {
+ $sqlString .= "--\n";
+ $sqlString .= "-- TABLE $tableName\n";
+ $sqlString .= "--\n";
+ $sqlString .= static::createTable($tableName, $tableStructure);
+ }
+
+ return $sqlString;
+ }
+
+ /**
+ * Creates the SQL definition of one table
+ *
+ * @param string $tableName The table name
+ * @param array $tableStructure The table structure
+ *
+ * @return string The SQL definition
+ *
+ * @throws Exception in cases of structure failures
+ */
+ public static function createTable(string $tableName, array $tableStructure): string
+ {
+ $engine = '';
+ $comment = '';
+ $sql_rows = [];
+ $primary_keys = [];
+ $foreign_keys = [];
+
+ foreach ($tableStructure['fields'] as $fieldName => $field) {
+ $sql_rows[] = '`' . static::escape($fieldName) . '` ' . self::FieldCommand($field);
+ if (!empty($field['primary'])) {
+ $primary_keys[] = $fieldName;
+ }
+ if (!empty($field['foreign'])) {
+ $foreign_keys[$fieldName] = $field;
+ }
+ }
+
+ if (!empty($tableStructure['indexes'])) {
+ foreach ($tableStructure['indexes'] as $indexName => $fieldNames) {
+ $sql_index = self::createIndex($indexName, $fieldNames, '');
+ if (!is_null($sql_index)) {
+ $sql_rows[] = $sql_index;
+ }
+ }
+ }
+
+ foreach ($foreign_keys as $fieldName => $parameters) {
+ $sql_rows[] = self::foreignCommand($fieldName, $parameters);
+ }
+
+ if (isset($tableStructure['engine'])) {
+ $engine = ' ENGINE=' . $tableStructure['engine'];
+ }
+
+ if (isset($tableStructure['comment'])) {
+ $comment = " COMMENT='" . static::escape($tableStructure['comment']) . "'";
+ }
+
+ $sql = implode(",\n\t", $sql_rows);
+
+ $sql = sprintf("CREATE TABLE IF NOT EXISTS `%s` (\n\t", static::escape($tableName)) . $sql .
+ "\n)" . $engine . " DEFAULT COLLATE utf8mb4_general_ci" . $comment;
+ return $sql . ";\n\n";
+ }
+
+ /**
+ * Standard escaping for SQL definitions
+ *
+ * @param string $sqlString the SQL string to escape
+ *
+ * @return string escaped SQL string
+ */
+ public static function escape(string $sqlString): string
+ {
+ return str_replace("'", "\\'", $sqlString);
+ }
+
+ /**
+ * Creates the SQL definition to add a foreign key
+ *
+ * @param string $keyName The foreign key name
+ * @param array $parameters The given parameters of the foreign key
+ *
+ * @return string The SQL definition
+ */
+ public static function addForeignKey(string $keyName, array $parameters): string
+ {
+ return sprintf("ADD %s", static::foreignCommand($keyName, $parameters));
+ }
+
+ /**
+ * Creates the SQL definition to drop a foreign key
+ *
+ * @param string $keyName The foreign key name
+ *
+ * @return string The SQL definition
+ */
+ public static function dropForeignKey(string $keyName): string
+ {
+ return sprintf("DROP FOREIGN KEY `%s`", $keyName);
+ }
+
+ /**
+ * Creates the SQL definition to drop an index
+ *
+ * @param string $indexName The index name
+ *
+ * @return string The SQL definition
+ */
+ public static function dropIndex(string $indexName): string
+ {
+ return sprintf("DROP INDEX `%s`", static::escape($indexName));
+ }
+
+ /**
+ * Creates the SQL definition to add a table field
+ *
+ * @param string $fieldName The table field name
+ * @param array $parameters The parameters of the table field
+ *
+ * @return string The SQL definition
+ */
+ public static function addTableField(string $fieldName, array $parameters): string
+ {
+ return sprintf("ADD `%s` %s", static::escape($fieldName), static::FieldCommand($parameters));
+ }
+
+ /**
+ * Creates the SQL definition to modify a table field
+ *
+ * @param string $fieldName The table field name
+ * @param array $parameters The paramters to modify
+ *
+ * @return string The SQL definition
+ */
+ public static function modifyTableField(string $fieldName, array $parameters): string
+ {
+ return sprintf("MODIFY `%s` %s", static::escape($fieldName), self::FieldCommand($parameters, false));
+ }
+
+ /**
+ * Returns SQL statement for field
+ *
+ * @param array $parameters Parameters for SQL statement
+ * @param boolean $create Whether to include PRIMARY KEY statement (unused)
+ * @return string SQL statement part
+ */
+ public static function FieldCommand(array $parameters, bool $create = true): string
+ {
+ $fieldstruct = $parameters['type'];
+
+ if (isset($parameters['Collation'])) {
+ $fieldstruct .= ' COLLATE ' . $parameters['Collation'];
+ }
+
+ if (isset($parameters['not null'])) {
+ $fieldstruct .= ' NOT NULL';
+ }
+
+ if (isset($parameters['default'])) {
+ if (strpos(strtolower($parameters['type']), 'int') !== false) {
+ $fieldstruct .= ' DEFAULT ' . $parameters['default'];
+ } else {
+ $fieldstruct .= " DEFAULT '" . $parameters['default'] . "'";
+ }
+ }
+ if (isset($parameters['extra'])) {
+ $fieldstruct .= ' ' . $parameters['extra'];
+ }
+
+ if (isset($parameters['comment'])) {
+ $fieldstruct .= " COMMENT '" . static::escape($parameters['comment']) . "'";
+ }
+
+ /*if (($parameters['primary'] != '') && $create)
+ $fieldstruct .= ' PRIMARY KEY';*/
+
+ return $fieldstruct;
+ }
+
+ /**
+ * Creates the SQL definition to create an index
+ *
+ * @param string $indexName The index name
+ * @param array $fieldNames The field names of this index
+ * @param string $method The method to create the index (default is ADD)
+ *
+ * @return string The SQL definition
+ * @throws Exception in cases the paramter contains invalid content
+ */
+ public static function createIndex(string $indexName, array $fieldNames, string $method = 'ADD'): string
+ {
+ $method = strtoupper(trim($method));
+ if ($method != '' && $method != 'ADD') {
+ throw new Exception("Invalid parameter 'method' in self::createIndex(): '$method'");
+ }
+
+ if (in_array($fieldNames[0], ['UNIQUE', 'FULLTEXT'])) {
+ $index_type = array_shift($fieldNames);
+ $method .= " " . $index_type;
+ }
+
+ $names = "";
+ foreach ($fieldNames as $fieldName) {
+ if ($names != '') {
+ $names .= ',';
+ }
+
+ if (preg_match('|(.+)\((\d+)\)|', $fieldName, $matches)) {
+ $names .= "`" . static::escape($matches[1]) . "`(" . intval($matches[2]) . ")";
+ } else {
+ $names .= "`" . static::escape($fieldName) . "`";
+ }
+ }
+
+ if ($indexName == 'PRIMARY') {
+ return sprintf("%s PRIMARY KEY(%s)", $method, $names);
+ }
+
+
+ return sprintf("%s INDEX `%s` (%s)", $method, static::escape($indexName), $names);
+ }
+
+ /**
+ * Creates the SQL definition for foreign keys
+ *
+ * @param string $foreignKeyName The foreign key name
+ * @param array $parameters The parameters of the foreign key
+ *
+ * @return string The SQL definition
+ */
+ public static function foreignCommand(string $foreignKeyName, array $parameters): string
+ {
+ $foreign_table = array_keys($parameters['foreign'])[0];
+ $foreign_field = array_values($parameters['foreign'])[0];
+
+ $sql = "FOREIGN KEY (`" . $foreignKeyName . "`) 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;
+ }
+}
--- /dev/null
+<?php
+/**
+ * @copyright Copyright (C) 2010-2022, the Friendica project
+ *
+ * @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\Util\Writer;
+
+use Friendica\Core\Renderer;
+use Friendica\Database\Definition\DbaDefinition;
+use Friendica\Network\HTTPException\ServiceUnavailableException;
+
+/**
+ * Utility class to write content into the '/doc' directory
+ */
+class DocWriter
+{
+ /**
+ * Creates all database definitions as Markdown fields and create the mkdoc config file.
+ *
+ * @param DbaDefinition $definition The Database definition class
+ * @param string $basePath The basepath of Friendica
+ *
+ * @return void
+ * @throws ServiceUnavailableException in really unexpected cases!
+ */
+ public static function writeDbDefinition(DbaDefinition $definition, string $basePath)
+ {
+ $tables = [];
+ foreach ($definition->getAll() 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 = $basePath . '/doc/database/db_' . $name . '.md';
+ file_put_contents($filename, $content);
+ }
+ asort($tables);
+ $content = Renderer::replaceMacros(Renderer::getMarkupTemplate('tables.tpl'), [
+ '$tables' => $tables,
+ ]);
+ $filename = $basePath . '/doc/database.md';
+ file_put_contents($filename, $content);
+ }
+}
--- /dev/null
+<?php
+/**
+ * @copyright Copyright (C) 2010-2022, the Friendica project
+ *
+ * @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\Util\Writer;
+
+use Friendica\Database\Definition\ViewDefinition;
+
+class ViewDefinitionSqlWriter
+{
+ public static function create(ViewDefinition $definition): string
+ {
+ $sqlString = '';
+
+ foreach ($definition->getAll() as $viewName => $viewStructure) {
+ $sqlString .= "--\n";
+ $sqlString .= "-- VIEW $viewName\n";
+ $sqlString .= "--\n";
+ $sqlString .= static::dropView($viewName);
+ $sqlString .= static::createView($viewName, $viewStructure);
+ }
+
+ return $sqlString;
+ }
+
+ public static function dropView(string $viewName): string
+ {
+ return sprintf("DROP VIEW IF EXISTS `%s`", static::escape($viewName)) . ";\n";
+ }
+
+ public static function createView(string $viewName, array $viewStructure): string
+ {
+ $sql_rows = [];
+ foreach ($viewStructure['fields'] as $fieldname => $origin) {
+ if (is_string($origin)) {
+ $sql_rows[] = $origin . " AS `" . static::escape($fieldname) . "`";
+ } elseif (is_array($origin) && (sizeof($origin) == 2)) {
+ $sql_rows[] = "`" . static::escape($origin[0]) . "`.`" . static::escape($origin[1]) . "` AS `" . static::escape($fieldname) . "`";
+ }
+ }
+ return sprintf("CREATE VIEW `%s` AS SELECT \n\t", static::escape($viewName)) .
+ implode(",\n\t", $sql_rows) . "\n\t" . $viewStructure['query'] . ";\n\n";
+ }
+
+ public static function escape(string $sqlString): string
+ {
+ return str_replace("'", "\\'", $sqlString);
+ }
+}
$rows = 0;
$userposts = DBA::select('post-user', [], ["`uri-id` not in (select `uri-id` from `post`)"]);
while ($fields = DBA::fetch($userposts)) {
- $post_fields = DBStructure::getFieldsForTable('post', $fields);
+ $post_fields = DI::dbaDefinition()->getFieldsForTable('post', $fields);
DBA::insert('post', $post_fields, Database::INSERT_IGNORE);
$rows++;
}
$rows = 0;
$userposts = DBA::select('post-user', [], ["`gravity` = ? AND `uri-id` not in (select `uri-id` from `post-thread`)", GRAVITY_PARENT]);
while ($fields = DBA::fetch($userposts)) {
- $post_fields = DBStructure::getFieldsForTable('post-thread', $fields);
+ $post_fields = DI::dbaDefinition()->getFieldsForTable('post-thread', $fields);
$post_fields['commented'] = $post_fields['changed'] = $post_fields['created'];
DBA::insert('post-thread', $post_fields, Database::INSERT_IGNORE);
$rows++;
$rows = 0;
$userposts = DBA::select('post-user', [], ["`gravity` = ? AND `id` not in (select `post-user-id` from `post-thread-user`)", GRAVITY_PARENT]);
while ($fields = DBA::fetch($userposts)) {
- $post_fields = DBStructure::getFieldsForTable('post-thread-user', $fields);
+ $post_fields = DI::dbaDefinition()->getFieldsForTable('post-thread-user', $fields);
$post_fields['commented'] = $post_fields['changed'] = $post_fields['created'];
DBA::insert('post-thread-user', $post_fields, Database::INSERT_IGNORE);
$rows++;
use Friendica\Core\Session\Capability\IHandleSessions;
use Friendica\Core\Storage\Repository\StorageManager;
use Friendica\Database\Database;
+use Friendica\Database\Definition\DbaDefinition;
+use Friendica\Database\Definition\ViewDefinition;
use Friendica\Factory;
use Friendica\Core\Storage\Capability\ICanWriteToStorage;
use Friendica\Model\User\Cookie;
['create', [], Dice::CHAIN_CALL],
]
],
+ DbaDefinition::class => [
+ 'constructParams' => [
+ [Dice::INSTANCE => '$basepath'],
+ ],
+ 'call' => [
+ ['load', [false], Dice::CHAIN_CALL],
+ ],
+ ],
+ ViewDefinition::class => [
+ 'constructParams' => [
+ [Dice::INSTANCE => '$basepath'],
+ ],
+ 'call' => [
+ ['load', [false], Dice::CHAIN_CALL],
+ ],
+ ],
Database::class => [
'constructParams' => [
[Dice::INSTANCE => \Psr\Log\NullLogger::class],
projects / friendica.git / commitdiff