- return DI::l10n()->t('Errors encountered performing database changes: ') . $message . EOL;
- }
-
- public static function writeStructure()
- {
- Renderer::registerTemplateEngine('Friendica\Render\FriendicaSmartyEngine');
-
- $tables = [];
- foreach (self::definition(null) as $name => $definition) {
- $fields = [];
- foreach ($definition['fields'] as $key => $value) {
- $field = [];
- $field['name'] = $key;
- $field['comment'] = $value['comment'] ?? '';
- $field['type'] = $value['type'];
- $field['notnull'] = ($value['not null'] ?? false) ? 'YES' : 'NO';
- $field['primary'] = ($value['primary'] ?? false) ? 'PRI' : '';
- $field['default'] = $value['default'] ?? '';
- $field['extra'] = $value['extra'] ?? '';
-
- $fields[] = $field;
- }
- $tables[] = ['name' => $name, 'comment' => $definition['comment']];
- $content = Renderer::replaceMacros(Renderer::getMarkupTemplate('structure.tpl'), [
- '$name' => $name,
- '$comment' => $definition['comment'],
- '$fields' => $fields,
- ]);
- $filename = DI::basePath() . '/doc/database/db_' . $name . '.md';
- file_put_contents($filename, $content);
- }
- $content = Renderer::replaceMacros(Renderer::getMarkupTemplate('tables.tpl'), [
- '$tables' => $tables,
- ]);
- $filename = DI::basePath() . '/doc/database.md';
- file_put_contents($filename, $content);
- }
-
- public static function printStructure($basePath)
- {
- $database = self::definition($basePath, false);
-
- 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 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($basePath, $with_addons_structure = true)
- {
- 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');
- }
-
- $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
- * @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;
-
- $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;
- }
-
- private static function FieldCommand($parameters, $create = true)
- {
- $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($indexname, $fieldnames, $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);
- }
-
-
- $sql = sprintf("%s INDEX `%s` (%s)", $method, DBA::escape($indexname), $names);
- return ($sql);