]> git.mxchange.org Git - friendica.git/blobdiff - src/Database/DBA.php
Restructured "manage" functionality, added count parameters
[friendica.git] / src / Database / DBA.php
index 6e9bc89be1fca65e1e737f038fd2b1b086a2cdc7..6f746ff64702dbd9ad47c344b41de4d7080aaded 100644 (file)
@@ -2,6 +2,7 @@
 
 namespace Friendica\Database;
 
+use Friendica\BaseObject;
 use mysqli;
 use mysqli_result;
 use mysqli_stmt;
@@ -13,7 +14,7 @@ use PDOStatement;
  *
  * This class is for the low level database stuff that does driver specific things.
  */
-class DBA
+class DBA extends BaseObject
 {
        /**
         * Lowest possible date value
@@ -24,19 +25,9 @@ class DBA
         */
        const NULL_DATETIME = '0001-01-01 00:00:00';
 
-       /**
-        * @var Database
-        */
-       private static $database;
-
-       public static function init(Database $database)
-       {
-               self::$database = $database;
-       }
-
        public static function connect()
        {
-               return self::$database->connect();
+               return self::getClass(Database::class)->connect();
        }
 
        /**
@@ -44,7 +35,7 @@ class DBA
         */
        public static function disconnect()
        {
-               self::$database->disconnect();
+               self::getClass(Database::class)->disconnect();
        }
 
        /**
@@ -52,7 +43,7 @@ class DBA
         */
        public static function reconnect()
        {
-               return self::$database->reconnect();
+               return self::getClass(Database::class)->reconnect();
        }
 
        /**
@@ -61,7 +52,7 @@ class DBA
         */
        public static function getConnection()
        {
-               return self::$database->getConnection();
+               return self::getClass(Database::class)->getConnection();
        }
 
        /**
@@ -74,7 +65,7 @@ class DBA
         */
        public static function serverInfo()
        {
-               return self::$database->serverInfo();
+               return self::getClass(Database::class)->serverInfo();
        }
 
        /**
@@ -85,17 +76,17 @@ class DBA
         */
        public static function databaseName()
        {
-               return self::$database->databaseName();
+               return self::getClass(Database::class)->databaseName();
        }
 
        public static function escape($str)
        {
-               return self::$database->escape($str);
+               return self::getClass(Database::class)->escape($str);
        }
 
        public static function connected()
        {
-               return self::$database->connected();
+               return self::getClass(Database::class)->connected();
        }
 
        /**
@@ -111,7 +102,7 @@ class DBA
         */
        public static function anyValueFallback($sql)
        {
-               return self::$database->anyValueFallback($sql);
+               return self::getClass(Database::class)->anyValueFallback($sql);
        }
 
        /**
@@ -167,7 +158,7 @@ class DBA
        {
                $params = self::getParam(func_get_args());
 
-               return self::$database->p($sql, $params);
+               return self::getClass(Database::class)->p($sql, $params);
        }
 
        /**
@@ -183,21 +174,21 @@ class DBA
 
                $params = self::getParam(func_get_args());
 
-               return self::$database->e($sql, $params);
+               return self::getClass(Database::class)->e($sql, $params);
        }
 
        /**
         * @brief Check if data exists
         *
-        * @param string $table     Table name
-        * @param array  $condition array of fields for condition
+        * @param string|array $table     Table name or array [schema => table]
+        * @param array        $condition array of fields for condition
         *
         * @return boolean Are there rows for that condition?
         * @throws \Exception
         */
        public static function exists($table, $condition)
        {
-               return self::$database->exists($table, $condition);
+               return self::getClass(Database::class)->exists($table, $condition);
        }
 
        /**
@@ -214,7 +205,7 @@ class DBA
        {
                $params = self::getParam(func_get_args());
 
-               return self::$database->fetchFirst($sql, $params);
+               return self::getClass(Database::class)->fetchFirst($sql, $params);
        }
 
        /**
@@ -224,7 +215,7 @@ class DBA
         */
        public static function affectedRows()
        {
-               return self::$database->affectedRows();
+               return self::getClass(Database::class)->affectedRows();
        }
 
        /**
@@ -235,7 +226,7 @@ class DBA
         */
        public static function columnCount($stmt)
        {
-               return self::$database->columnCount($stmt);
+               return self::getClass(Database::class)->columnCount($stmt);
        }
        /**
         * @brief Returns the number of rows of a statement
@@ -245,7 +236,7 @@ class DBA
         */
        public static function numRows($stmt)
        {
-               return self::$database->numRows($stmt);
+               return self::getClass(Database::class)->numRows($stmt);
        }
 
        /**
@@ -256,22 +247,22 @@ class DBA
         */
        public static function fetch($stmt)
        {
-               return self::$database->fetch($stmt);
+               return self::getClass(Database::class)->fetch($stmt);
        }
 
        /**
         * @brief Insert a row into a table
         *
-        * @param string $table               Table name
-        * @param array  $param               parameter array
-        * @param bool   $on_duplicate_update Do an update on a duplicate entry
+        * @param string|array $table               Table name or array [schema => table]
+        * @param array        $param               parameter array
+        * @param bool         $on_duplicate_update Do an update on a duplicate entry
         *
         * @return boolean was the insert successful?
         * @throws \Exception
         */
        public static function insert($table, $param, $on_duplicate_update = false)
        {
-               return self::$database->insert($table, $param, $on_duplicate_update);
+               return self::getClass(Database::class)->insert($table, $param, $on_duplicate_update);
        }
 
        /**
@@ -281,7 +272,7 @@ class DBA
         */
        public static function lastInsertId()
        {
-               return self::$database->lastInsertId();
+               return self::getClass(Database::class)->lastInsertId();
        }
 
        /**
@@ -289,14 +280,14 @@ class DBA
         *
         * This function can be extended in the future to accept a table array as well.
         *
-        * @param string $table Table name
+        * @param string|array $table Table name or array [schema => table]
         *
         * @return boolean was the lock successful?
         * @throws \Exception
         */
        public static function lock($table)
        {
-               return self::$database->lock($table);
+               return self::getClass(Database::class)->lock($table);
        }
 
        /**
@@ -307,7 +298,7 @@ class DBA
         */
        public static function unlock()
        {
-               return self::$database->unlock();
+               return self::getClass(Database::class)->unlock();
        }
 
        /**
@@ -317,7 +308,7 @@ class DBA
         */
        public static function transaction()
        {
-               return self::$database->transaction();
+               return self::getClass(Database::class)->transaction();
        }
 
        /**
@@ -327,7 +318,7 @@ class DBA
         */
        public static function commit()
        {
-               return self::$database->commit();
+               return self::getClass(Database::class)->commit();
        }
 
        /**
@@ -337,7 +328,7 @@ class DBA
         */
        public static function rollback()
        {
-               return self::$database->rollback();
+               return self::getClass(Database::class)->rollback();
        }
 
        /**
@@ -354,7 +345,7 @@ class DBA
         */
        public static function delete($table, array $conditions, array $options = [])
        {
-               return self::$database->delete($table, $conditions, $options);
+               return self::getClass(Database::class)->delete($table, $conditions, $options);
        }
 
        /**
@@ -378,7 +369,7 @@ class DBA
         * Only set $old_fields to a boolean value when you are sure that you will update a single row.
         * When you set $old_fields to "true" then $fields must contain all relevant fields!
         *
-        * @param string        $table      Table name
+        * @param string|array  $table      Table name or array [schema => table]
         * @param array         $fields     contains the fields that are updated
         * @param array         $condition  condition array with the key values
         * @param array|boolean $old_fields array with the old field values that are about to be replaced (true = update on duplicate)
@@ -388,33 +379,50 @@ class DBA
         */
        public static function update($table, $fields, $condition, $old_fields = [])
        {
-               return self::$database->update($table, $fields, $condition, $old_fields);
+               return self::getClass(Database::class)->update($table, $fields, $condition, $old_fields);
        }
 
        /**
         * Retrieve a single record from a table and returns it in an associative array
         *
         * @brief Retrieve a single record from a table
-        * @param string $table
-        * @param array  $fields
-        * @param array  $condition
-        * @param array  $params
+        * @param string|array $table     Table name or array [schema => table]
+        * @param array        $fields
+        * @param array        $condition
+        * @param array        $params
         * @return bool|array
         * @throws \Exception
         * @see   self::select
         */
        public static function selectFirst($table, array $fields = [], array $condition = [], $params = [])
        {
-               return self::$database->selectFirst($table, $fields, $condition, $params);
+               return self::getClass(Database::class)->selectFirst($table, $fields, $condition, $params);
+       }
+
+       /**
+        * @brief Select rows from a table and fills an array with the data
+        *
+        * @param string|array $table     Table name or array [schema => table]
+        * @param array        $fields    Array of selected fields, empty for all
+        * @param array        $condition Array of fields for condition
+        * @param array        $params    Array of several parameters
+        *
+        * @return array Data array
+        * @throws \Exception
+        * @see   self::select
+        */
+       public static function selectToArray(string $table, array $fields = [], array $condition = [], array $params = [])
+       {
+               return self::getClass(Database::class)->selectToArray($table, $fields, $condition, $params);
        }
 
        /**
         * @brief Select rows from a table
         *
-        * @param string $table     Table name
-        * @param array  $fields    Array of selected fields, empty for all
-        * @param array  $condition Array of fields for condition
-        * @param array  $params    Array of several parameters
+        * @param string|array $table     Table name or array [schema => table]
+        * @param array        $fields    Array of selected fields, empty for all
+        * @param array        $condition Array of fields for condition
+        * @param array        $params    Array of several parameters
         *
         * @return boolean|object
         *
@@ -433,14 +441,15 @@ class DBA
         */
        public static function select($table, array $fields = [], array $condition = [], array $params = [])
        {
-               return self::$database->select($table, $fields, $condition, $params);
+               return self::getClass(Database::class)->select($table, $fields, $condition, $params);
        }
 
        /**
         * @brief Counts the rows from a table satisfying the provided condition
         *
-        * @param string $table     Table name
-        * @param array  $condition array of fields for condition
+        * @param string|array $table     Table name or array [schema => table]
+        * @param array        $condition array of fields for condition
+        * @param array        $params    Array of several parameters
         *
         * @return int
         *
@@ -454,9 +463,50 @@ class DBA
         * $count = DBA::count($table, $condition);
         * @throws \Exception
         */
-       public static function count($table, array $condition = [])
+       public static function count($table, array $condition = [], array $params = [])
        {
-               return self::$database->count($table, $condition);
+               return self::getClass(Database::class)->count($table, $condition, $params);
+       }
+
+       /**
+        * Build the table query substring from one or more tables, with or without a schema.
+        *
+        * Expected formats:
+        * - table
+        * - [table1, table2, ...]
+        * - [schema1 => table1, schema2 => table2, table3, ...]
+        *
+        * @param string|array $tables
+        * @return string
+        */
+       public static function buildTableString($tables)
+       {
+               if (is_string($tables)) {
+                       $tables = [$tables];
+               }
+
+               $quotedTables = [];
+
+               foreach ($tables as $schema => $table) {
+                       if (is_numeric($schema)) {
+                               $quotedTables[] = self::quoteIdentifier($table);
+                       } else {
+                               $quotedTables[] = self::quoteIdentifier($schema) . '.' . self::quoteIdentifier($table);
+                       }
+               }
+
+               return implode(', ', $quotedTables);
+       }
+
+       /**
+        * Escape an identifier (table or field name)
+        *
+        * @param $identifier
+        * @return string
+        */
+       public static function quoteIdentifier($identifier)
+       {
+               return '`' . str_replace('`', '``', $identifier) . '`';
        }
 
        /**
@@ -519,12 +569,12 @@ class DBA
 
                                                $new_values = array_merge($new_values, array_values($value));
                                                $placeholders = substr(str_repeat("?, ", count($value)), 0, -2);
-                                               $condition_string .= "`" . $field . "` IN (" . $placeholders . ")";
+                                               $condition_string .= self::quoteIdentifier($field) . " IN (" . $placeholders . ")";
                                        } elseif (is_null($value)) {
-                                               $condition_string .= "`" . $field . "` IS NULL";
+                                               $condition_string .= self::quoteIdentifier($field) . " IS NULL";
                                        } else {
                                                $new_values[$field] = $value;
-                                               $condition_string .= "`" . $field . "` = ?";
+                                               $condition_string .= self::quoteIdentifier($field) . " = ?";
                                        }
                                }
                                $condition_string = " WHERE (" . $condition_string . ")";
@@ -544,12 +594,8 @@ class DBA
        public static function buildParameter(array $params = [])
        {
                $groupby_string = '';
-               if (isset($params['group_by'])) {
-                       $groupby_string = " GROUP BY ";
-                       foreach ($params['group_by'] as $fields) {
-                               $groupby_string .= "`" . $fields . "`, ";
-                       }
-                       $groupby_string = substr($groupby_string, 0, -2);
+               if (!empty($params['group_by'])) {
+                       $groupby_string = " GROUP BY " . implode(', ', array_map(['self', 'quoteIdentifier'], $params['group_by']));
                }
 
                $order_string = '';
@@ -559,9 +605,9 @@ class DBA
                                if ($order === 'RAND()') {
                                        $order_string .= "RAND(), ";
                                } elseif (!is_int($fields)) {
-                                       $order_string .= "`" . $fields . "` " . ($order ? "DESC" : "ASC") . ", ";
+                                       $order_string .= self::quoteIdentifier($fields) . " " . ($order ? "DESC" : "ASC") . ", ";
                                } else {
-                                       $order_string .= "`" . $order . "`, ";
+                                       $order_string .= self::quoteIdentifier($order) . ", ";
                                }
                        }
                        $order_string = substr($order_string, 0, -2);
@@ -588,7 +634,7 @@ class DBA
         */
        public static function toArray($stmt, $do_close = true)
        {
-               return self::$database->toArray($stmt, $do_close);
+               return self::getClass(Database::class)->toArray($stmt, $do_close);
        }
 
        /**
@@ -598,7 +644,7 @@ class DBA
         */
        public static function errorNo()
        {
-               return self::$database->errorNo();
+               return self::getClass(Database::class)->errorNo();
        }
 
        /**
@@ -608,7 +654,7 @@ class DBA
         */
        public static function errorMessage()
        {
-               return self::$database->errorMessage();
+               return self::getClass(Database::class)->errorMessage();
        }
 
        /**
@@ -619,7 +665,7 @@ class DBA
         */
        public static function close($stmt)
        {
-               return self::$database->close($stmt);
+               return self::getClass(Database::class)->close($stmt);
        }
 
        /**
@@ -632,7 +678,7 @@ class DBA
         */
        public static function processlist()
        {
-               return self::$database->processlist();
+               return self::getClass(Database::class)->processlist();
        }
 
        /**
@@ -644,7 +690,7 @@ class DBA
         */
        public static function isResult($array)
        {
-               return self::$database->isResult($array);
+               return self::getClass(Database::class)->isResult($array);
        }
 
        /**
@@ -656,6 +702,6 @@ class DBA
         */
        public static function escapeArray(&$arr, $add_quotation = false)
        {
-               return self::$database->escapeArray($arr, $add_quotation);
+               return self::getClass(Database::class)->escapeArray($arr, $add_quotation);
        }
 }