]> git.mxchange.org Git - friendica.git/blobdiff - src/Database/Database.php
Group selection: Respect "pubmail" and ignore atchived or blocked contacts
[friendica.git] / src / Database / Database.php
index 14381ae922d791d8a1079a42cfde9cfa9317575a..72ce6bbe6c51616ad33f2c41d9b17f5411b41733 100644 (file)
@@ -4,12 +4,12 @@ namespace Friendica\Database;
 
 use Friendica\Core\Config\Cache\ConfigCache;
 use Friendica\Core\System;
+use Friendica\Network\HTTPException\InternalServerErrorException;
 use Friendica\Util\DateTimeFormat;
 use Friendica\Util\Profiler;
 use mysqli;
 use mysqli_result;
 use mysqli_stmt;
-use ParagonIE\HiddenString\HiddenString;
 use PDO;
 use PDOException;
 use PDOStatement;
@@ -22,77 +22,92 @@ use Psr\Log\LoggerInterface;
  */
 class Database
 {
-       private $connected = false;
+       protected $connected = false;
 
        /**
         * @var ConfigCache
         */
-       private $configCache;
+       protected $configCache;
        /**
         * @var Profiler
         */
-       private $profiler;
+       protected $profiler;
        /**
         * @var LoggerInterface
         */
-       private $logger;
-       private $server_info    = '';
+       protected $logger;
+       protected $server_info    = '';
        /** @var PDO|mysqli */
-       private $connection;
-       private $driver;
+       protected $connection;
+       protected $driver;
        private $error          = false;
        private $errorno        = 0;
        private $affected_rows  = 0;
-       private $in_transaction = false;
-       private $in_retrial     = false;
+       protected $in_transaction = false;
+       protected $in_retrial     = false;
        private $relation       = [];
-       private $db_serveraddr;
-       private $db_user;
-       /**
-        * @var HiddenString
-        */
-       private $db_pass;
-       private $db_name;
-       private $db_charset;
 
-       public function __construct(ConfigCache $configCache, Profiler $profiler, LoggerInterface $logger, $serveraddr, $user, HiddenString $pass, $db, $charset = null)
+       public function __construct(ConfigCache $configCache, Profiler $profiler, LoggerInterface $logger, array $server = [])
        {
                // We are storing these values for being able to perform a reconnect
                $this->configCache   = $configCache;
                $this->profiler      = $profiler;
                $this->logger        = $logger;
-               $this->db_serveraddr = $serveraddr;
-               $this->db_user       = $user;
-               $this->db_pass       = $pass;
-               $this->db_name       = $db;
-               $this->db_charset    = $charset;
 
+               $this->readServerVariables($server);
                $this->connect();
 
-               DBA::init($this);
+               if ($this->isConnected()) {
+                       // Loads DB_UPDATE_VERSION constant
+                       DBStructure::definition($configCache->get('system', 'basepath'), false);
+               }
+       }
+
+       private function readServerVariables(array $server)
+       {
+               // Use environment variables for mysql if they are set beforehand
+               if (!empty($server['MYSQL_HOST'])
+                   && (!empty($server['MYSQL_USERNAME'] || !empty($server['MYSQL_USER'])))
+                   && $server['MYSQL_PASSWORD'] !== false
+                   && !empty($server['MYSQL_DATABASE']))
+               {
+                       $db_host = $server['MYSQL_HOST'];
+                       if (!empty($server['MYSQL_PORT'])) {
+                               $db_host .= ':' . $server['MYSQL_PORT'];
+                       }
+                       $this->configCache->set('database', 'hostname', $db_host);
+                       unset($db_host);
+                       if (!empty($server['MYSQL_USERNAME'])) {
+                               $this->configCache->set('database', 'username', $server['MYSQL_USERNAME']);
+                       } else {
+                               $this->configCache->set('database', 'username', $server['MYSQL_USER']);
+                       }
+                       $this->configCache->set('database', 'password', (string) $server['MYSQL_PASSWORD']);
+                       $this->configCache->set('database', 'database', $server['MYSQL_DATABASE']);
+               }
        }
 
        public function connect()
        {
                if (!is_null($this->connection) && $this->connected()) {
-                       return true;
+                       return $this->connected;
                }
 
-               $port       = 0;
-               $serveraddr = trim($this->db_serveraddr);
+               // Reset connected state
+               $this->connected = false;
 
+               $port       = 0;
+               $serveraddr = trim($this->configCache->get('database', 'hostname'));
                $serverdata = explode(':', $serveraddr);
                $server     = $serverdata[0];
-
                if (count($serverdata) > 1) {
                        $port = trim($serverdata[1]);
                }
-
                $server  = trim($server);
-               $user    = trim($this->db_user);
-               $pass    = trim($this->db_pass);
-               $db      = trim($this->db_name);
-               $charset = trim($this->db_charset);
+               $user    = trim($this->configCache->get('database', 'username'));
+               $pass    = trim($this->configCache->get('database', 'password'));
+               $db      = trim($this->configCache->get('database', 'database'));
+               $charset = trim($this->configCache->get('database', 'charset'));
 
                if (!(strlen($server) && strlen($user))) {
                        return false;
@@ -115,7 +130,7 @@ class Database
                                $this->connection->setAttribute(PDO::ATTR_EMULATE_PREPARES, false);
                                $this->connected = true;
                        } catch (PDOException $e) {
-                               /// @TODO At least log exception, don't ignore it!
+                               $this->connected = false;
                        }
                }
 
@@ -161,24 +176,34 @@ class Database
                $this->logger = $logger;
        }
 
+       /**
+        * Sets the profiler for DBA
+        *
+        * @param Profiler $profiler
+        */
+       public function setProfiler(Profiler $profiler)
+       {
+               $this->profiler = $profiler;
+       }
        /**
         * Disconnects the current database connection
         */
        public function disconnect()
        {
-               if (is_null($this->connection)) {
-                       return;
+               if (!is_null($this->connection)) {
+                       switch ($this->driver) {
+                               case 'pdo':
+                                       $this->connection = null;
+                                       break;
+                               case 'mysqli':
+                                       $this->connection->close();
+                                       $this->connection = null;
+                                       break;
+                       }
                }
 
-               switch ($this->driver) {
-                       case 'pdo':
-                               $this->connection = null;
-                               break;
-                       case 'mysqli':
-                               $this->connection->close();
-                               $this->connection = null;
-                               break;
-               }
+               $this->driver    = null;
+               $this->connected = false;
        }
 
        /**
@@ -323,6 +348,11 @@ class Database
                }
        }
 
+       public function isConnected()
+       {
+               return $this->connected;
+       }
+
        public function connected()
        {
                $connected = false;
@@ -343,6 +373,7 @@ class Database
                                $connected = $this->connection->ping();
                                break;
                }
+
                return $connected;
        }
 
@@ -459,6 +490,10 @@ class Database
                // We are having an own error logging in the function "e"
                $called_from_e = ($called_from['function'] == 'e');
 
+               if (!isset($this->connection)) {
+                       throw new InternalServerErrorException('The Connection is empty, although connected is set true.');
+               }
+
                switch ($this->driver) {
                        case 'pdo':
                                // If there are no arguments we use "query"
@@ -700,8 +735,8 @@ class Database
        /**
         * @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
@@ -881,49 +916,32 @@ class Database
        /**
         * @brief Insert a row into a table
         *
-        * @param string/array $table Table name
-        *
-        * @return string formatted and sanitzed table name
-        * @throws \Exception
-        */
-       public function formatTableName($table)
-       {
-               if (is_string($table)) {
-                       return "`" . $this->sanitizeIdentifier($table) . "`";
-               }
-
-               if (!is_array($table)) {
-                       return '';
-               }
-
-               $scheme = key($table);
-
-               return "`" . $this->sanitizeIdentifier($scheme) . "`.`" . $this->sanitizeIdentifier($table[$scheme]) . "`";
-       }
-
-       /**
-        * @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 function insert($table, $param, $on_duplicate_update = false)
        {
-
                if (empty($table) || empty($param)) {
                        $this->logger->info('Table and fields have to be set');
                        return false;
                }
 
-               $sql = "INSERT INTO " . $this->formatTableName($table) . " (`" . implode("`, `", array_keys($param)) . "`) VALUES (" .
-                      substr(str_repeat("?, ", count($param)), 0, -2) . ")";
+               $table_string = DBA::buildTableString($table);
+
+               $fields_string = implode(', ', array_map([DBA::class, 'quoteIdentifier'], array_keys($param)));
+
+               $values_string = substr(str_repeat("?, ", count($param)), 0, -2);
+
+               $sql = "INSERT INTO " . $table_string . " (" . $fields_string . ") VALUES (" . $values_string . ")";
 
                if ($on_duplicate_update) {
-                       $sql .= " ON DUPLICATE KEY UPDATE `" . implode("` = ?, `", array_keys($param)) . "` = ?";
+                       $fields_string = implode(' = ?, ', array_map([DBA::class, 'quoteIdentifier'], array_keys($param)));
+
+                       $sql .= " ON DUPLICATE KEY UPDATE " . $fields_string . " = ?";
 
                        $values = array_values($param);
                        $param  = array_merge_recursive($values, $values);
@@ -955,7 +973,7 @@ class Database
         *
         * 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
@@ -970,7 +988,7 @@ class Database
                        $this->connection->autocommit(false);
                }
 
-               $success = $this->e("LOCK TABLES " . $this->formatTableName($table) . " WRITE");
+               $success = $this->e("LOCK TABLES " . DBA::buildTableString($table) . " WRITE");
 
                if ($this->driver == 'pdo') {
                        $this->connection->setAttribute(PDO::ATTR_EMULATE_PREPARES, false);
@@ -1045,7 +1063,7 @@ class Database
                return true;
        }
 
-       private function performCommit()
+       protected function performCommit()
        {
                switch ($this->driver) {
                        case 'pdo':
@@ -1127,6 +1145,8 @@ class Database
        /**
         * @brief Delete a row from a table
         *
+        * Note: this methods does NOT accept schema => table arrays because of the complex relation stuff.
+        *
         * @param string $table      Table name
         * @param array  $conditions Field condition(s)
         * @param array  $options
@@ -1151,13 +1171,11 @@ class Database
 
                // We quit when this key already exists in the callstack.
                if (isset($callstack[$key])) {
-                       return $commands;
+                       return true;
                }
 
                $callstack[$key] = true;
 
-               $table = $this->sanitizeIdentifier($table);
-
                $commands[$key] = ['table' => $table, 'conditions' => $conditions];
 
                // Don't use "defaults" here, since it would set "false" to "true"
@@ -1225,7 +1243,7 @@ class Database
                        $condition_string = DBA::buildCondition($conditions);
 
                        if ((count($command['conditions']) > 1) || is_int($first_key)) {
-                               $sql = "DELETE FROM `" . $command['table'] . "`" . $condition_string;
+                               $sql = "DELETE FROM " . DBA::quoteIdentifier($command['table']) . " " . $condition_string;
                                $this->logger->debug($this->replaceParameters($sql, $conditions));
 
                                if (!$this->e($sql, $conditions)) {
@@ -1253,7 +1271,7 @@ class Database
                foreach ($compacted AS $table => $values) {
                        foreach ($values AS $field => $field_value_list) {
                                foreach ($field_value_list AS $field_values) {
-                                       $sql = "DELETE FROM `" . $table . "` WHERE `" . $field . "` IN (" .
+                                       $sql = "DELETE FROM " . DBA::quoteIdentifier($table) . " WHERE " . DBA::quoteIdentifier($field) . " IN (" .
                                               substr(str_repeat("?, ", count($field_values)), 0, -2) . ");";
 
                                        $this->logger->debug($this->replaceParameters($sql, $field_values));
@@ -1294,7 +1312,7 @@ class Database
         * 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)
@@ -1304,12 +1322,13 @@ class Database
         */
        public function update($table, $fields, $condition, $old_fields = [])
        {
-
                if (empty($table) || empty($fields) || empty($condition)) {
                        $this->logger->info('Table, fields and condition have to be set');
                        return false;
                }
 
+               $table_string = DBA::buildTableString($table);
+
                $condition_string = DBA::buildCondition($condition);
 
                if (is_bool($old_fields)) {
@@ -1342,8 +1361,9 @@ class Database
                        return true;
                }
 
-               $sql = "UPDATE " . $this->formatTableName($table) . " SET `" .
-                      implode("` = ?, `", array_keys($fields)) . "` = ?" . $condition_string;
+               $sql = "UPDATE " . $table_string . " SET "
+                       . implode(" = ?, ", array_map([DBA::class, 'quoteIdentifier'], array_keys($fields))) . " = ?"
+                       . $condition_string;
 
                $params1 = array_values($fields);
                $params2 = array_values($condition);
@@ -1380,13 +1400,30 @@ class Database
                }
        }
 
+       /**
+        * @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 function selectToArray(string $table, array $fields = [], array $condition = [], array $params = [])
+       {
+               return $this->toArray($this->select($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
         *
@@ -1410,16 +1447,18 @@ class Database
                }
 
                if (count($fields) > 0) {
-                       $select_fields = "`" . implode("`, `", array_values($fields)) . "`";
+                       $select_string = implode(', ', array_map([DBA::class, 'quoteIdentifier'], $fields));
                } else {
-                       $select_fields = "*";
+                       $select_string = '*';
                }
 
+               $table_string = DBA::buildTableString($table);
+
                $condition_string = DBA::buildCondition($condition);
 
                $param_string = DBA::buildParameter($params);
 
-               $sql = "SELECT " . $select_fields . " FROM " . $this->formatTableName($table) . $condition_string . $param_string;
+               $sql = "SELECT " . $select_string . " FROM " . $table_string . $condition_string . $param_string;
 
                $result = $this->p($sql, $condition);
 
@@ -1429,8 +1468,9 @@ class Database
        /**
         * @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
         *
@@ -1444,15 +1484,25 @@ class Database
         * $count = DBA::count($table, $condition);
         * @throws \Exception
         */
-       public function count($table, array $condition = [])
+       public function count($table, array $condition = [], array $params = [])
        {
                if (empty($table)) {
                        return false;
                }
 
+               $table_string = DBA::buildTableString($table);
+
                $condition_string = DBA::buildCondition($condition);
 
-               $sql = "SELECT COUNT(*) AS `count` FROM " . $this->formatTableName($table) . $condition_string;
+               if (empty($params['expression'])) {
+                       $expression = '*';
+               } elseif (!empty($params['distinct'])) {
+                       $expression = "DISTINCT " . DBA::quoteIdentifier($params['expression']);
+               } else {
+                       $expression = DBA::quoteIdentifier($params['expression']);
+               }
+
+               $sql = "SELECT COUNT(" . $expression . ") AS `count` FROM " . $table_string . $condition_string;
 
                $row = $this->fetchFirst($sql, $condition);
 
@@ -1470,16 +1520,18 @@ class Database
        public function toArray($stmt, $do_close = true)
        {
                if (is_bool($stmt)) {
-                       return $stmt;
+                       return [];
                }
 
                $data = [];
                while ($row = $this->fetch($stmt)) {
                        $data[] = $row;
                }
+
                if ($do_close) {
                        $this->close($stmt);
                }
+
                return $data;
        }