]> git.mxchange.org Git - friendica.git/blobdiff - src/Database/DBStructure.php
Merge pull request #10318 from annando/issue-9926
[friendica.git] / src / Database / DBStructure.php
index 6f3fe5dba5b2e718741ff44e03f155e1d1f6e3bd..914846590be264ed833d1b683013d997fc813031 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
  *
@@ -64,6 +64,53 @@ class DBStructure
                echo DI::l10n()->t('The database version had been set to %s.', $version);
        }
 
+       /**
+        * Drop unused tables
+        *
+        * @param boolean $execute
+        * @return void
+        */
+       public static function dropTables(bool $execute)
+       {
+               $postupdate = DI::config()->get("system", "post_update_version", PostUpdate::VERSION);
+               if ($postupdate < PostUpdate::VERSION) {
+                       echo DI::l10n()->t('The post update is at version %d, it has to be at %d to safely drop the tables.', $postupdate, PostUpdate::VERSION);
+                       return;
+               }
+
+               $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',
+                       'deliverq', 'dsprphotoq', 'ffinder', 'sign', 'spam', 'term', 'user-item', 'thread', 'item'];
+
+               $tables = DBA::selectToArray(['INFORMATION_SCHEMA' => 'TABLES'], ['TABLE_NAME'],
+                       ['TABLE_SCHEMA' => DBA::databaseName(), 'TABLE_TYPE' => 'BASE TABLE']);
+
+               if (empty($tables)) {
+                       echo DI::l10n()->t('No unused tables found.');
+                       return;
+               }
+
+               if (!$execute) {
+                       echo DI::l10n()->t('These tables are not used for friendica and will be deleted when you execute "dbstructure drop -e":') . "\n\n";
+               }
+
+               foreach ($tables as $table) {
+                       if (in_array($table['TABLE_NAME'], $old_tables)) {
+                               if ($execute) {
+                                       $sql = 'DROP TABLE ' . DBA::quoteIdentifier($table['TABLE_NAME']) . ';';
+                                       echo $sql . "\n";
+
+                                       $result = DBA::e($sql);
+                                       if (!DBA::isResult($result)) {
+                                               self::printUpdateError($sql);
+                                       }
+                               } else {
+                                       echo $table['TABLE_NAME'] . "\n";
+                               }
+                       }
+               }
+       }
+
        /**
         * Converts all tables from MyISAM/InnoDB Antelope to InnoDB Barracuda
         */
@@ -145,6 +192,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';
 
@@ -191,6 +241,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];
                        }
                }
@@ -321,6 +377,54 @@ class DBStructure
                return ($sql);
        }
 
+       /**
+        * Perform a database structure dryrun (means: just simulating)
+        *
+        * @throws Exception
+        */
+       public static function dryRun()
+       {
+               self::update(DI::app()->getBasePath(), true, false);
+       }
+
+       /**
+        * Updates DB structure and returns eventual errors messages
+        *
+        * @param bool $enable_maintenance_mode Set the maintenance mode
+        * @param bool $verbose                 Display the SQL commands
+        *
+        * @return string Empty string if the update is successful, error messages otherwise
+        * @throws Exception
+        */
+       public static function performUpdate(bool $enable_maintenance_mode = true, bool $verbose = false)
+       {
+               if ($enable_maintenance_mode) {
+                       DI::config()->set('system', 'maintenance', 1);
+               }
+
+               $status = self::update(DI::app()->getBasePath(), $verbose, true);
+
+               if ($enable_maintenance_mode) {
+                       DI::config()->set('system', 'maintenance', 0);
+                       DI::config()->set('system', 'maintenance_reason', '');
+               }
+
+               return $status;
+       }
+
+       /**
+        * 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)
+       {
+               return self::update($basePath, false, true, true);
+       }
+
        /**
         * Updates DB structure and returns eventual errors messages
         *
@@ -333,14 +437,15 @@ class DBStructure
         * @return string Empty string if the update is successful, error messages otherwise
         * @throws Exception
         */
-       public static function update($basePath, $verbose, $action, $install = false, array $tables = null, array $definition = null)
+       private 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.');
-                       }
+               $in_maintenance_mode = DI::config()->get('system', 'maintenance');
 
-                       DI::config()->set('system', 'maintenance', 1);
+               if ($action && !$install && self::isUpdating()) {
+                       return DI::l10n()->t('Another database update is currently running.');
+               }
+
+               if ($in_maintenance_mode) {
                        DI::config()->set('system', 'maintenance_reason', DI::l10n()->t('%s: Database update', DateTimeFormat::utcNow() . ' ' . date('e')));
                }
 
@@ -640,7 +745,7 @@ class DBStructure
                                }
 
                                if ($action) {
-                                       if (!$install) {
+                                       if ($in_maintenance_mode) {
                                                DI::config()->set('system', 'maintenance_reason', DI::l10n()->t('%s: updating %s table.', DateTimeFormat::utcNow() . ' ' . date('e'), $name));
                                        }
 
@@ -697,9 +802,6 @@ class DBStructure
                self::checkInitialValues();
 
                if ($action && !$install) {
-                       DI::config()->set('system', 'maintenance', 0);
-                       DI::config()->set('system', 'maintenance_reason', '');
-
                        if ($errors) {
                                DI::config()->set('system', 'dbupdate', self::UPDATE_FAILED);
                        } else {
@@ -1046,12 +1148,34 @@ class DBStructure
        /**
         * Check if initial database values do exist - or create them
         */
-       public static function checkInitialValues()
+       public static function checkInitialValues(bool $verbose = false)
        {
-               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('verb')) {
+                       if (!DBA::exists('verb', ['id' => 1])) {
+                               foreach (Item::ACTIVITIES as $index => $activity) {
+                                       DBA::insert('verb', ['id' => $index + 1, 'name' => $activity], Database::INSERT_IGNORE);
+                               }
+                               if ($verbose) {
+                                       echo "verb: activities added\n";
+                               }
+                       } elseif ($verbose) {
+                               echo "verb: activities already added\n";
                        }
+
+                       if (!DBA::exists('verb', ['id' => 0])) {
+                               DBA::insert('verb', ['name' => '']);
+                               $lastid = DBA::lastInsertId();
+                               if ($lastid != 0) {
+                                       DBA::update('verb', ['id' => 0], ['id' => $lastid]);
+                                       if ($verbose) {
+                                               echo "Zero verb added\n";
+                                       }
+                               }
+                       } elseif ($verbose) {
+                               echo "Zero verb already added\n";
+                       }
+               } elseif ($verbose) {
+                       echo "verb: Table not found\n";
                }
 
                if (self::existsTable('user') && !DBA::exists('user', ['uid' => 0])) {
@@ -1064,7 +1188,14 @@ class DBStructure
                        $lastid = DBA::lastInsertId();
                        if ($lastid != 0) {
                                DBA::update('user', ['uid' => 0], ['uid' => $lastid]);
+                               if ($verbose) {
+                                       echo "Zero user added\n";
+                               }
                        }
+               } elseif (self::existsTable('user') && $verbose) {
+                       echo "Zero user already added\n";
+               } elseif ($verbose) {
+                       echo "user: Table not found\n";
                }
 
                if (self::existsTable('contact') && !DBA::exists('contact', ['id' => 0])) {
@@ -1072,7 +1203,29 @@ class DBStructure
                        $lastid = DBA::lastInsertId();
                        if ($lastid != 0) {
                                DBA::update('contact', ['id' => 0], ['id' => $lastid]);
+                               if ($verbose) {
+                                       echo "Zero contact added\n";
+                               }
                        }               
+               } elseif (self::existsTable('contact') && $verbose) {
+                       echo "Zero contact already added\n";
+               } elseif ($verbose) {
+                       echo "contact: Table not found\n";
+               }
+
+               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 ($verbose) {
+                                       echo "Zero tag added\n";
+                               }
+                       }
+               } elseif (self::existsTable('tag') && $verbose) {
+                       echo "Zero tag already added\n";
+               } elseif ($verbose) {
+                       echo "tag: Table not found\n";
                }
 
                if (self::existsTable('permissionset')) {
@@ -1081,9 +1234,14 @@ class DBStructure
                                $lastid = DBA::lastInsertId();
                                if ($lastid != 0) {
                                        DBA::update('permissionset', ['id' => 0], ['id' => $lastid]);
+                                       if ($verbose) {
+                                               echo "Zero permissionset added\n";
+                                       }
                                }
+                       } elseif ($verbose) {
+                               echo "Zero permissionset already added\n";
                        }
-                       if (!self::existsForeignKeyForField('item', 'psid')) {
+                       if (self::existsTable('item') && !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");
@@ -1104,16 +1262,10 @@ class DBStructure
                                }
                                DBA::close($sets);
                        }
+               } elseif ($verbose) {
+                       echo "permissionset: Table not found\n";
                }
        
-               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::existsForeignKeyForField('tokens', 'client_id')) {
                        $tokens = DBA::p("SELECT `tokens`.`id` FROM `tokens`
                                LEFT JOIN `clients` ON `clients`.`client_id` = `tokens`.`client_id`