Store the database credentials for reconnect
[friendica.git/.git] / include / dba.php
index f6bab9e..b21b01b 100644 (file)
@@ -1,13 +1,12 @@
 <?php
 
+use Friendica\App;
 use Friendica\Core\L10n;
 use Friendica\Core\System;
 use Friendica\Database\DBM;
 use Friendica\Database\DBStructure;
 use Friendica\Util\DateTimeFormat;
 
-require_once('include/datetime.php');
-
 /**
  * @class MySQL database class
  *
@@ -15,7 +14,7 @@ require_once('include/datetime.php');
  */
 
 class dba {
-       public static $connected = true;
+       public static $connected = false;
 
        private static $_server_info = '';
        private static $db;
@@ -24,10 +23,15 @@ class dba {
        private static $errorno = 0;
        private static $affected_rows = 0;
        private static $in_transaction = false;
+       private static $in_retrial = false;
        private static $relation = [];
+       private static $db_serveraddr = '';
+       private static $db_user = '';
+       private static $db_pass = '';
+       private static $db_name = '';
 
-       public static function connect($serveraddr, $user, $pass, $db, $install = false) {
-               if (!is_null(self::$db)) {
+       public static function connect($serveraddr, $user, $pass, $db) {
+               if (!is_null(self::$db) && self::connected()) {
                        return true;
                }
 
@@ -35,6 +39,12 @@ class dba {
 
                $stamp1 = microtime(true);
 
+               // We are storing these values for being able to perform a reconnect
+               self::$db_serveraddr = $serveraddr;
+               self::$db_user = $user;
+               self::$db_pass = $pass;
+               self::$db_name = $db;
+
                $serveraddr = trim($serveraddr);
 
                $serverdata = explode(':', $serveraddr);
@@ -50,22 +60,9 @@ class dba {
                $db = trim($db);
 
                if (!(strlen($server) && strlen($user))) {
-                       self::$connected = false;
-                       self::$db = null;
                        return false;
                }
 
-               if ($install) {
-                       if (strlen($server) && ($server !== 'localhost') && ($server !== '127.0.0.1')) {
-                               if (! dns_get_record($server, DNS_A + DNS_CNAME + DNS_PTR)) {
-                                       self::$error = L10n::t('Cannot locate DNS info for database server \'%s\'', $server);
-                                       self::$connected = false;
-                                       self::$db = null;
-                                       return false;
-                               }
-                       }
-               }
-
                if (class_exists('\PDO') && in_array('mysql', PDO::getAvailableDrivers())) {
                        self::$driver = 'pdo';
                        $connect = "mysql:host=".$server.";dbname=".$db;
@@ -81,7 +78,6 @@ class dba {
                                self::$db = @new PDO($connect, $user, $pass);
                                self::$connected = true;
                        } catch (PDOException $e) {
-                               self::$connected = false;
                        }
                }
 
@@ -99,14 +95,51 @@ class dba {
 
                // No suitable SQL driver was found.
                if (!self::$connected) {
+                       self::$driver = null;
                        self::$db = null;
-                       if (!$install) {
-                               System::unavailable();
-                       }
                }
                $a->save_timestamp($stamp1, "network");
 
-               return true;
+               return self::$connected;
+       }
+
+       /**
+        * Disconnects the current database connection
+        */
+       public static function disconnect()
+       {
+               if (is_null(self::$db)) {
+                       return;
+               }
+
+               switch (self::$driver) {
+                       case 'pdo':
+                               self::$db = null;
+                               break;
+                       case 'mysqli':
+                               self::$db->close();
+                               self::$db = null;
+                               break;
+               }
+       }
+
+       /**
+        * Perform a reconnect of an existing database connection
+        */
+       public static function reconnect() {
+               self::disconnect();
+
+               $ret = self::connect(self::$db_serveraddr, self::$db_user, self::$db_pass, self::$db_name);
+               return $ret;
+       }
+
+       /**
+        * Return the database object.
+        * @return PDO|mysqli
+        */
+       public static function get_db()
+       {
+               return self::$db;
        }
 
        /**
@@ -147,7 +180,7 @@ class dba {
         *
         * @param string $query The database query that will be analyzed
         */
-       private static function log_index($query) {
+       private static function logIndex($query) {
                $a = get_app();
 
                if (empty($a->config["system"]["db_log_index"])) {
@@ -274,7 +307,7 @@ class dba {
         * @param array $args The parameters that are to replace the ? placeholders
         * @return string The replaced SQL query
         */
-       private static function replace_parameters($sql, $args) {
+       private static function replaceParameters($sql, $args) {
                $offset = 0;
                foreach ($args AS $param => $value) {
                        if (is_int($args[$param]) || is_float($args[$param])) {
@@ -415,7 +448,7 @@ class dba {
 
                                // The fallback routine is called as well when there are no arguments
                                if (!$can_be_prepared || (count($args) == 0)) {
-                                       $retval = self::$db->query(self::replace_parameters($sql, $args));
+                                       $retval = self::$db->query(self::replaceParameters($sql, $args));
                                        if (self::$db->errno) {
                                                self::$error = self::$db->error;
                                                self::$errorno = self::$db->errno;
@@ -439,23 +472,23 @@ class dba {
                                        break;
                                }
 
-                               $params = '';
+                               $param_types = '';
                                $values = [];
                                foreach ($args AS $param => $value) {
                                        if (is_int($args[$param])) {
-                                               $params .= 'i';
+                                               $param_types .= 'i';
                                        } elseif (is_float($args[$param])) {
-                                               $params .= 'd';
+                                               $param_types .= 'd';
                                        } elseif (is_string($args[$param])) {
-                                               $params .= 's';
+                                               $param_types .= 's';
                                        } else {
-                                               $params .= 'b';
+                                               $param_types .= 'b';
                                        }
                                        $values[] = &$args[$param];
                                }
 
                                if (count($values) > 0) {
-                                       array_unshift($values, $params);
+                                       array_unshift($values, $param_types);
                                        call_user_func_array([$stmt, 'bind_param'], $values);
                                }
 
@@ -478,7 +511,27 @@ class dba {
                        $errorno = self::$errorno;
 
                        logger('DB Error '.self::$errorno.': '.self::$error."\n".
-                               System::callstack(8)."\n".self::replace_parameters($sql, $params));
+                               System::callstack(8)."\n".self::replaceParameters($sql, $args));
+
+                       // On a lost connection we try to reconnect - but only once.
+                       if ($errorno == 2006) {
+                               if (self::$in_retrial || !self::reconnect()) {
+                                       // It doesn't make sense to continue when the database connection was lost
+                                       if (self::$in_retrial) {
+                                               logger('Giving up retrial because of database error '.$errorno.': '.$error);
+                                       } else {
+                                               logger("Couldn't reconnect after database error ".$errorno.': '.$error);
+                                       }
+                                       exit(1);
+                               } else {
+                                       // We try it again
+                                       logger('Reconnected after database error '.$errorno.': '.$error);
+                                       self::$in_retrial = true;
+                                       $ret = self::p($sql, $args);
+                                       self::$in_retrial = false;
+                                       return $ret;
+                               }
+                       }
 
                        self::$error = $error;
                        self::$errorno = $errorno;
@@ -498,7 +551,7 @@ class dba {
                                @file_put_contents($a->config["system"]["db_log"], DateTimeFormat::utcNow()."\t".$duration."\t".
                                                basename($backtrace[1]["file"])."\t".
                                                $backtrace[1]["line"]."\t".$backtrace[2]["function"]."\t".
-                                               substr(self::replace_parameters($sql, $args), 0, 2000)."\n", FILE_APPEND);
+                                               substr(self::replaceParameters($sql, $args), 0, 2000)."\n", FILE_APPEND);
                        }
                }
                return $retval;
@@ -543,7 +596,7 @@ class dba {
                        $errorno = self::$errorno;
 
                        logger('DB Error '.self::$errorno.': '.self::$error."\n".
-                               System::callstack(8)."\n".self::replace_parameters($sql, $params));
+                               System::callstack(8)."\n".self::replaceParameters($sql, $params));
 
                        self::$error = $error;
                        self::$errorno = $errorno;
@@ -569,10 +622,10 @@ class dba {
 
                $fields = [];
 
-               $array_element = each($condition);
-               $array_key = $array_element['key'];
-               if (!is_int($array_key)) {
-                       $fields = [$array_key];
+               reset($condition);
+               $first_key = key($condition);
+               if (!is_int($first_key)) {
+                       $fields = [$first_key];
                }
 
                $stmt = self::select($table, $fields, $condition, ['limit' => 1]);
@@ -666,16 +719,24 @@ class dba {
         * @return array current row
         */
        public static function fetch($stmt) {
+               $a = get_app();
+
+               $stamp1 = microtime(true);
+
+               $columns = [];
+
                if (!is_object($stmt)) {
                        return false;
                }
 
                switch (self::$driver) {
                        case 'pdo':
-                               return $stmt->fetch(PDO::FETCH_ASSOC);
+                               $columns = $stmt->fetch(PDO::FETCH_ASSOC);
+                               break;
                        case 'mysqli':
                                if (get_class($stmt) == 'mysqli_result') {
-                                       return $stmt->fetch_assoc();
+                                       $columns = $stmt->fetch_assoc();
+                                       break;
                                }
 
                                // This code works, but is slow
@@ -700,12 +761,14 @@ class dba {
                                $result = $stmt->result_metadata();
                                $fields = $result->fetch_fields();
 
-                               $columns = [];
                                foreach ($cols_num AS $param => $col) {
                                        $columns[$fields[$param]->name] = $col;
                                }
-                               return $columns;
                }
+
+               $a->save_timestamp($stamp1, 'database');
+
+               return $columns;
        }
 
        /**
@@ -838,7 +901,7 @@ class dba {
         *
         * This process must only be started once, since the value is cached.
         */
-       private static function build_relation_data() {
+       private static function buildRelationData() {
                $definition = DBStructure::definition();
 
                foreach ($definition AS $table => $structure) {
@@ -857,12 +920,15 @@ class dba {
         *
         * @param string  $table       Table name
         * @param array   $conditions  Field condition(s)
+        * @param array   $options
+        *                - cascade: If true we delete records in other tables that depend on the one we're deleting through
+        *                           relations (default: true)
         * @param boolean $in_process  Internal use: Only do a commit after the last delete
         * @param array   $callstack   Internal use: prevent endless loops
         *
         * @return boolean|array was the delete successful? When $in_process is set: deletion data
         */
-       public static function delete($table, array $conditions, $in_process = false, array &$callstack = [])
+       public static function delete($table, array $conditions, array $options = [], $in_process = false, array &$callstack = [])
        {
                if (empty($table) || empty($conditions)) {
                        logger('Table and conditions have to be set');
@@ -885,13 +951,15 @@ class dba {
 
                $commands[$key] = ['table' => $table, 'conditions' => $conditions];
 
+               $cascade = defaults($options, 'cascade', true);
+
                // To speed up the whole process we cache the table relations
-               if (count(self::$relation) == 0) {
-                       self::build_relation_data();
+               if ($cascade && count(self::$relation) == 0) {
+                       self::buildRelationData();
                }
 
                // Is there a relation entry for the table?
-               if (isset(self::$relation[$table])) {
+               if ($cascade && isset(self::$relation[$table])) {
                        // We only allow a simple "one field" relation.
                        $field = array_keys(self::$relation[$table])[0];
                        $rel_def = array_values(self::$relation[$table])[0];
@@ -904,7 +972,7 @@ class dba {
                        if ((count($conditions) == 1) && ($field == array_keys($conditions)[0])) {
                                foreach ($rel_def AS $rel_table => $rel_fields) {
                                        foreach ($rel_fields AS $rel_field) {
-                                               $retval = self::delete($rel_table, [$rel_field => array_values($conditions)[0]], true, $callstack);
+                                               $retval = self::delete($rel_table, [$rel_field => array_values($conditions)[0]], $options, true, $callstack);
                                                $commands = array_merge($commands, $retval);
                                        }
                                }
@@ -918,7 +986,7 @@ class dba {
 
                                while ($row = self::fetch($data)) {
                                        // Now we accumulate the delete commands
-                                       $retval = self::delete($table, [$field => $row[$field]], true, $callstack);
+                                       $retval = self::delete($table, [$field => $row[$field]], $options, true, $callstack);
                                        $commands = array_merge($commands, $retval);
                                }
 
@@ -942,17 +1010,14 @@ class dba {
 
                        foreach ($commands AS $command) {
                                $conditions = $command['conditions'];
-                               $array_element = each($conditions);
-                               $array_key = $array_element['key'];
-                               if (is_int($array_key)) {
-                                       $condition_string = " WHERE " . array_shift($conditions);
-                               } else {
-                                       $condition_string = " WHERE `" . implode("` = ? AND `", array_keys($conditions)) . "` = ?";
-                               }
+                               reset($conditions);
+                               $first_key = key($conditions);
 
-                               if ((count($command['conditions']) > 1) || is_int($array_key)) {
+                               $condition_string = self::buildCondition($conditions);
+
+                               if ((count($command['conditions']) > 1) || is_int($first_key)) {
                                        $sql = "DELETE FROM `" . $command['table'] . "`" . $condition_string;
-                                       logger(self::replace_parameters($sql, $conditions), LOGGER_DATA);
+                                       logger(self::replaceParameters($sql, $conditions), LOGGER_DATA);
 
                                        if (!self::e($sql, $conditions)) {
                                                if ($do_transaction) {
@@ -968,7 +1033,7 @@ class dba {
                                        // Split the SQL queries in chunks of 100 values
                                        // We do the $i stuff here to make the code better readable
                                        $i = $counter[$key_table][$key_condition];
-                                       if (count($compacted[$key_table][$key_condition][$i]) > 100) {
+                                       if (isset($compacted[$key_table][$key_condition][$i]) && count($compacted[$key_table][$key_condition][$i]) > 100) {
                                                ++$i;
                                        }
 
@@ -982,7 +1047,7 @@ class dba {
                                                $sql = "DELETE FROM `" . $table . "` WHERE `" . $field . "` IN (" .
                                                        substr(str_repeat("?, ", count($field_values)), 0, -2) . ");";
 
-                                               logger(self::replace_parameters($sql, $field_values), LOGGER_DATA);
+                                               logger(self::replaceParameters($sql, $field_values), LOGGER_DATA);
 
                                                if (!self::e($sql, $field_values)) {
                                                        if ($do_transaction) {
@@ -1039,13 +1104,7 @@ class dba {
 
                $table = self::escape($table);
 
-               $array_element = each($condition);
-               $array_key = $array_element['key'];
-               if (is_int($array_key)) {
-                       $condition_string = " WHERE ".array_shift($condition);
-               } else {
-                       $condition_string = " WHERE `".implode("` = ? AND `", array_keys($condition))."` = ?";
-               }
+               $condition_string = self::buildCondition($condition);
 
                if (is_bool($old_fields)) {
                        $do_insert = $old_fields;
@@ -1140,6 +1199,8 @@ class dba {
                        return false;
                }
 
+               $table = self::escape($table);
+
                if (count($fields) > 0) {
                        $select_fields = "`" . implode("`, `", array_values($fields)) . "`";
                } else {
@@ -1148,29 +1209,9 @@ class dba {
 
                $condition_string = self::buildCondition($condition);
 
-               $order_string = '';
-               if (isset($params['order'])) {
-                       $order_string = " ORDER BY ";
-                       foreach ($params['order'] AS $fields => $order) {
-                               if (!is_int($fields)) {
-                                       $order_string .= "`" . $fields . "` " . ($order ? "DESC" : "ASC") . ", ";
-                               } else {
-                                       $order_string .= "`" . $order . "`, ";
-                               }
-                       }
-                       $order_string = substr($order_string, 0, -2);
-               }
+               $param_string = self::buildParameter($params);
 
-               $limit_string = '';
-               if (isset($params['limit']) && is_int($params['limit'])) {
-                       $limit_string = " LIMIT " . $params['limit'];
-               }
-
-               if (isset($params['limit']) && is_array($params['limit'])) {
-                       $limit_string = " LIMIT " . intval($params['limit'][0]) . ", " . intval($params['limit'][1]);
-               }
-
-               $sql = "SELECT " . $select_fields . " FROM `" . $table . "`" . $condition_string . $order_string . $limit_string;
+               $sql = "SELECT " . $select_fields . " FROM `" . $table . "`" . $condition_string . $param_string;
 
                $result = self::p($sql, $condition);
 
@@ -1227,22 +1268,71 @@ class dba {
         * @param array $condition
         * @return string
         */
-       private static function buildCondition(array &$condition = [])
+       public static function buildCondition(array &$condition = [])
        {
                $condition_string = '';
                if (count($condition) > 0) {
-                       $array_element = each($condition);
-                       $array_key = $array_element['key'];
-                       if (is_int($array_key)) {
-                               $condition_string = " WHERE ".array_shift($condition);
+                       reset($condition);
+                       $first_key = key($condition);
+                       if (is_int($first_key)) {
+                               $condition_string = " WHERE (" . array_shift($condition) . ")";
                        } else {
-                               $condition_string = " WHERE `".implode("` = ? AND `", array_keys($condition))."` = ?";
+                               $new_values = [];
+                               $condition_string = "";
+                               foreach ($condition as $field => $value) {
+                                       if ($condition_string != "") {
+                                               $condition_string .= " AND ";
+                                       }
+                                       if (is_array($value)) {
+                                               $new_values = array_merge($new_values, array_values($value));
+                                               $placeholders = substr(str_repeat("?, ", count($value)), 0, -2);
+                                               $condition_string .= "`" . $field . "` IN (" . $placeholders . ")";
+                                       } else {
+                                               $new_values[$field] = $value;
+                                               $condition_string .= "`" . $field . "` = ?";
+                                       }
+                               }
+                               $condition_string = " WHERE (" . $condition_string . ")";
+                               $condition = $new_values;
                        }
                }
 
                return $condition_string;
        }
 
+       /**
+        * @brief Returns the SQL parameter string built from the provided parameter array
+        *
+        * @param array $params
+        * @return string
+        */
+       public static function buildParameter(array $params = [])
+       {
+               $order_string = '';
+               if (isset($params['order'])) {
+                       $order_string = " ORDER BY ";
+                       foreach ($params['order'] AS $fields => $order) {
+                               if (!is_int($fields)) {
+                                       $order_string .= "`" . $fields . "` " . ($order ? "DESC" : "ASC") . ", ";
+                               } else {
+                                       $order_string .= "`" . $order . "`, ";
+                               }
+                       }
+                       $order_string = substr($order_string, 0, -2);
+               }
+
+               $limit_string = '';
+               if (isset($params['limit']) && is_int($params['limit'])) {
+                       $limit_string = " LIMIT " . $params['limit'];
+               }
+
+               if (isset($params['limit']) && is_array($params['limit'])) {
+                       $limit_string = " LIMIT " . intval($params['limit'][0]) . ", " . intval($params['limit'][1]);
+               }
+
+               return $order_string.$limit_string;
+       }
+
        /**
         * @brief Fills an array with data from a query
         *
@@ -1289,17 +1379,27 @@ class dba {
         * @return boolean was the close successful?
         */
        public static function close($stmt) {
+               $a = get_app();
+
+               $stamp1 = microtime(true);
+
                if (!is_object($stmt)) {
                        return false;
                }
 
                switch (self::$driver) {
                        case 'pdo':
-                               return $stmt->closeCursor();
+                               $ret = $stmt->closeCursor();
+                               break;
                        case 'mysqli':
                                $stmt->free_result();
-                               return $stmt->close();
+                               $ret = $stmt->close();
+                               break;
                }
+
+               $a->save_timestamp($stamp1, 'database');
+
+               return $ret;
        }
 }