]> git.mxchange.org Git - friendica.git/blobdiff - src/Database/DBStructure.php
Remove deprecated code
[friendica.git] / src / Database / DBStructure.php
index 3043ae132235b76de62239ffbc9a1fdb442fe959..686f0582c98a06df9b6cc2127ac4feccf88719f2 100644 (file)
@@ -6,15 +6,14 @@
 namespace Friendica\Database;
 
 use Exception;
-use Friendica\Core\Config;
 use Friendica\Core\Hook;
-use Friendica\Core\L10n;
 use Friendica\Core\Logger;
+use Friendica\DI;
 use Friendica\Util\DateTimeFormat;
 
+require_once __DIR__ . '/../../include/dba.php';
+
 /**
- * @brief This class contain functions for the database management
- *
  * This class contains functions that doesn't need to know if pdo, mysqli or whatever is used.
  */
 class DBStructure
@@ -33,21 +32,24 @@ class DBStructure
         */
        private static $definition = [];
 
-       /*
+       /**
         * Converts all tables from MyISAM to InnoDB
         */
        public static function convertToInnoDB()
        {
-               $r = q("SELECT `TABLE_NAME` FROM `information_schema`.`tables` WHERE `engine` = 'MyISAM' AND `table_schema` = '%s'",
-                       DBA::escape(DBA::databaseName()));
-
-               if (!DBA::isResult($r)) {
-                       echo L10n::t('There are no tables on MyISAM.') . "\n";
+               $tables = DBA::selectToArray(
+                       ['information_schema' => 'tables'],
+                       ['table_name'],
+                       ['engine' => 'MyISAM', 'table_schema' => DBA::databaseName()]
+               );
+
+               if (!DBA::isResult($tables)) {
+                       echo DI::l10n()->t('There are no tables on MyISAM.') . "\n";
                        return;
                }
 
-               foreach ($r AS $table) {
-                       $sql = sprintf("ALTER TABLE `%s` engine=InnoDB;", DBA::escape($table['TABLE_NAME']));
+               foreach ($tables AS $table) {
+                       $sql = "ALTER TABLE " . DBA::quoteIdentifier($table['table_name']) . " engine=InnoDB;";
                        echo $sql . "\n";
 
                        $result = DBA::e($sql);
@@ -58,7 +60,7 @@ class DBStructure
        }
 
        /**
-        * @brief Print out database error messages
+        * Print out database error messages
         *
         * @param string $message Message to be added to the error message
         *
@@ -66,15 +68,15 @@ class DBStructure
         */
        private static function printUpdateError($message)
        {
-               echo L10n::t("\nError %d occurred during database update:\n%s\n",
+               echo DI::l10n()->t("\nError %d occurred during database update:\n%s\n",
                        DBA::errorNo(), DBA::errorMessage());
 
-               return L10n::t('Errors encountered performing database changes: ') . $message . EOL;
+               return DI::l10n()->t('Errors encountered performing database changes: ') . $message . EOL;
        }
 
-       public static function printStructure()
+       public static function printStructure($basePath)
        {
-               $database = self::definition(false);
+               $database = self::definition($basePath, false);
 
                echo "-- ------------------------------------------\n";
                echo "-- " . FRIENDICA_PLATFORM . " " . FRIENDICA_VERSION . " (" . FRIENDICA_CODENAME, ")\n";
@@ -94,26 +96,26 @@ class DBStructure
         * Loads the database structure definition from the config/dbstructure.config.php file.
         * On first pass, defines DB_UPDATE_VERSION constant.
         *
-        * @see config/dbstructure.config.php
+        * @see static/dbstructure.config.php
         * @param boolean $with_addons_structure Whether to tack on addons additional tables
+        * @param string  $basePath              The base path of this application
         * @return array
         * @throws Exception
         */
-       public static function definition($with_addons_structure = true)
+       public static function definition($basePath, $with_addons_structure = true)
        {
                if (!self::$definition) {
-                       $a = \Friendica\BaseObject::getApp();
 
-                       $filename = $a->getBasePath() . '/config/dbstructure.config.php';
+                       $filename = $basePath . '/static/dbstructure.config.php';
 
                        if (!is_readable($filename)) {
-                               throw new Exception('Missing database structure config file config/dbstructure.config.php');
+                               throw new Exception('Missing database structure config file static/dbstructure.config.php');
                        }
 
                        $definition = require $filename;
 
                        if (!$definition) {
-                               throw new Exception('Corrupted database structure config file config/dbstructure.config.php');
+                               throw new Exception('Corrupted database structure config file static/dbstructure.config.php');
                        }
 
                        self::$definition = $definition;
@@ -245,18 +247,20 @@ class DBStructure
        /**
         * Updates DB structure and returns eventual errors messages
         *
-        * @param bool  $verbose
-        * @param bool  $action     Whether to actually apply the update
-        * @param bool  $install    Is this the initial update during the installation?
-        * @param array $tables     An array of the database tables
-        * @param array $definition An array of the definition tables
+        * @param string $basePath   The base path of this application
+        * @param bool   $verbose
+        * @param bool   $action     Whether to actually apply the update
+        * @param bool   $install    Is this the initial update during the installation?
+        * @param array  $tables     An array of the database tables
+        * @param array  $definition An array of the definition tables
         * @return string Empty string if the update is successful, error messages otherwise
+        * @throws Exception
         */
-       public static function update($verbose, $action, $install = false, array $tables = null, array $definition = null)
+       public static function update($basePath, $verbose, $action, $install = false, array $tables = null, array $definition = null)
        {
                if ($action && !$install) {
-                       Config::set('system', 'maintenance', 1);
-                       Config::set('system', 'maintenance_reason', L10n::t('%s: Database update', DateTimeFormat::utcNow() . ' ' . date('e')));
+                       DI::config()->set('system', 'maintenance', 1);
+                       DI::config()->set('system', 'maintenance_reason', DI::l10n()->t('%s: Database update', DateTimeFormat::utcNow() . ' ' . date('e')));
                }
 
                $errors = '';
@@ -281,7 +285,7 @@ class DBStructure
 
                // Get the definition
                if (is_null($definition)) {
-                       $definition = self::definition();
+                       $definition = self::definition($basePath);
                }
 
                // MySQL >= 5.7.4 doesn't support the IGNORE keyword in ALTER TABLE statements
@@ -414,7 +418,7 @@ class DBStructure
                                }
 
                                if (isset($database[$name]["table_status"]["Comment"])) {
-                                       $structurecomment = defaults($structure, "comment", "");
+                                       $structurecomment = $structure["comment"] ?? '';
                                        if ($database[$name]["table_status"]["Comment"] != $structurecomment) {
                                                $sql2 = "COMMENT = '" . DBA::escape($structurecomment) . "'";
 
@@ -458,7 +462,7 @@ class DBStructure
                                // Compare the field structure field by field
                                foreach ($structure["fields"] AS $fieldname => $parameters) {
                                        // Compare the field definition
-                                       $field_definition = defaults($database[$name]["fields"], $fieldname, ['Collation' => '']);
+                                       $field_definition = ($database[$name]["fields"][$fieldname] ?? '') ?: ['Collation' => ''];
 
                                        // Define the default collation if not given
                                        if (!isset($parameters['Collation']) && !empty($field_definition['Collation'])) {
@@ -517,7 +521,7 @@ class DBStructure
 
                                if ($action) {
                                        if (!$install) {
-                                               Config::set('system', 'maintenance_reason', L10n::t('%s: updating %s table.', DateTimeFormat::utcNow() . ' ' . date('e'), $name));
+                                               DI::config()->set('system', 'maintenance_reason', DI::l10n()->t('%s: updating %s table.', DateTimeFormat::utcNow() . ' ' . date('e'), $name));
                                        }
 
                                        // Ensure index conversion to unique removes duplicates
@@ -569,13 +573,13 @@ class DBStructure
                }
 
                if ($action && !$install) {
-                       Config::set('system', 'maintenance', 0);
-                       Config::set('system', 'maintenance_reason', '');
+                       DI::config()->set('system', 'maintenance', 0);
+                       DI::config()->set('system', 'maintenance_reason', '');
 
                        if ($errors) {
-                               Config::set('system', 'dbupdate', self::UPDATE_FAILED);
+                               DI::config()->set('system', 'dbupdate', self::UPDATE_FAILED);
                        } else {
-                               Config::set('system', 'dbupdate', self::UPDATE_SUCCESSFUL);
+                               DI::config()->set('system', 'dbupdate', self::UPDATE_SUCCESSFUL);
                        }
                }
 
@@ -710,12 +714,12 @@ class DBStructure
         * @todo You cannot rename a primary key if "auto increment" is set
         *
         * @param string $table            Table name
-        * @param array  $columns          Columns Syntax for Rename: [ $old1 => [ $new1, $type1 ], $old2 => [ $new2, $type2 ], ... ] )
-        *                                 Syntax for Primary Key: [ $col1, $col2, ...] )
+        * @param array  $columns          Columns Syntax for Rename: [ $old1 => [ $new1, $type1 ], $old2 => [ $new2, $type2 ], ... ]
+        *                                 Syntax for Primary Key: [ $col1, $col2, ...]
         * @param int    $type             The type of renaming (Default is Column)
         *
         * @return boolean Was the renaming successful?
-        *
+        * @throws Exception
         */
        public static function rename($table, $columns, $type = self::RENAME_COLUMN)
        {
@@ -775,6 +779,7 @@ class DBStructure
         * @param array  $columns Columns to check ( Syntax: [ $col1, $col2, .. ] )
         *
         * @return boolean Does the table exist?
+        * @throws Exception
         */
        public static function existsColumn($table, $columns = [])
        {
@@ -812,9 +817,10 @@ class DBStructure
        /**
         *    Check if a table exists
         *
-        * @param string $table Table name
+        * @param string|array $table Table name
         *
         * @return boolean Does the table exist?
+        * @throws Exception
         */
        public static function existsTable($table)
        {
@@ -822,20 +828,28 @@ class DBStructure
                        return false;
                }
 
-               $table = DBA::escape($table);
-
-               $sql = "SHOW TABLES LIKE '" . $table . "';";
-
-               $stmt = DBA::p($sql);
-
-               if (is_bool($stmt)) {
-                       $retval = $stmt;
+               if (is_array($table)) {
+                       $condition = ['table_schema' => key($table), 'table_name' => current($table)];
                } else {
-                       $retval = (DBA::numRows($stmt) > 0);
+                       $condition = ['table_schema' => DBA::databaseName(), 'table_name' => $table];
                }
 
-               DBA::close($stmt);
+               $result = DBA::exists(['information_schema' => 'tables'], $condition);
 
-               return $retval;
+               return $result;
+       }
+
+       /**
+        * Returns the columns of a table
+        *
+        * @param string $table Table name
+        *
+        * @return array An array of the table columns
+        * @throws Exception
+        */
+       public static function getColumns($table)
+       {
+               $stmtColumns = DBA::p("SHOW COLUMNS FROM `" . $table . "`");
+               return DBA::toArray($stmtColumns);
        }
 }