]> git.mxchange.org Git - friendica.git/blobdiff - src/Database/DBStructure.php
Detection of local requests
[friendica.git] / src / Database / DBStructure.php
index 3aedc435fae2c92fa13d02208c8f8a65a1bd2e44..a6d4061a7c54f3266afdbe89377be56bc27f0688 100644 (file)
@@ -1,6 +1,6 @@
 <?php
 /**
- * @copyright Copyright (C) 2020, Friendica
+ * @copyright Copyright (C) 2010-2021, the Friendica project
  *
  * @license GNU AGPL version 3 or any later version
  *
@@ -24,6 +24,7 @@ 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;
@@ -80,7 +81,7 @@ class DBStructure
 
                $old_tables = ['fserver', 'gcign', 'gcontact', 'gcontact-relation', 'gfollower' ,'glink', 'item-delivery-data',
                        'item-activity', 'item-content', 'item_id', 'participation', 'poll', 'poll_result', 'queue', 'retriever_rule',
-                       'sign', 'spam', 'term', 'thread', 'user-item'];
+                       'deliverq', 'dsprphotoq', 'ffinder', 'sign', 'spam', 'term', 'user-item', 'thread', 'item', 'challenge'];
 
                $tables = DBA::selectToArray(['INFORMATION_SCHEMA' => 'TABLES'], ['TABLE_NAME'],
                        ['TABLE_SCHEMA' => DBA::databaseName(), 'TABLE_TYPE' => 'BASE TABLE']);
@@ -159,6 +160,108 @@ class DBStructure
                return DI::l10n()->t('Errors encountered performing database changes: ') . $message . EOL;
        }
 
+       public static function writeStructure()
+       {
+               $tables = [];
+               foreach (self::definition(null) 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($basePath)
        {
                $database = self::definition($basePath, false);
@@ -192,6 +295,9 @@ class DBStructure
        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';
 
@@ -238,6 +344,12 @@ class DBStructure
                // 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];
                        }
                }
@@ -1197,7 +1309,7 @@ class DBStructure
                                if ($verbose) {
                                        echo "Zero contact added\n";
                                }
-                       }               
+                       }
                } elseif (self::existsTable('contact') && $verbose) {
                        echo "Zero contact already added\n";
                } elseif ($verbose) {
@@ -1221,7 +1333,7 @@ class DBStructure
 
                if (self::existsTable('permissionset')) {
                        if (!DBA::exists('permissionset', ['id' => 0])) {
-                               DBA::insert('permissionset', ['allow_cid' => '', 'allow_gid' => '', 'deny_cid' => '', 'deny_gid' => '']);       
+                               DBA::insert('permissionset', ['allow_cid' => '', 'allow_gid' => '', 'deny_cid' => '', 'deny_gid' => '']);
                                $lastid = DBA::lastInsertId();
                                if ($lastid != 0) {
                                        DBA::update('permissionset', ['id' => 0], ['id' => $lastid]);
@@ -1256,7 +1368,7 @@ class DBStructure
                } elseif ($verbose) {
                        echo "permissionset: Table not found\n";
                }
-       
+
                if (!self::existsForeignKeyForField('tokens', 'client_id')) {
                        $tokens = DBA::p("SELECT `tokens`.`id` FROM `tokens`
                                LEFT JOIN `clients` ON `clients`.`client_id` = `tokens`.`client_id`