4 use Friendica\Core\L10n;
5 use Friendica\Core\System;
6 use Friendica\Database\DBM;
7 use Friendica\Database\DBStructure;
8 use Friendica\Util\DateTimeFormat;
11 * @class MySQL database class
13 * This class is for the low level database stuff that does driver specific things.
17 public static $connected = false;
19 private static $_server_info = '';
21 private static $driver;
22 private static $error = false;
23 private static $errorno = 0;
24 private static $affected_rows = 0;
25 private static $in_transaction = false;
26 private static $in_retrial = false;
27 private static $relation = [];
28 private static $db_serveraddr = '';
29 private static $db_user = '';
30 private static $db_pass = '';
31 private static $db_name = '';
32 private static $db_charset = '';
34 public static function connect($serveraddr, $user, $pass, $db, $charset = null)
36 if (!is_null(self::$db) && self::connected()) {
40 // We are storing these values for being able to perform a reconnect
41 self::$db_serveraddr = $serveraddr;
42 self::$db_user = $user;
43 self::$db_pass = $pass;
45 self::$db_charset = $charset;
47 $serveraddr = trim($serveraddr);
49 $serverdata = explode(':', $serveraddr);
50 $server = $serverdata[0];
52 if (count($serverdata) > 1) {
53 $port = trim($serverdata[1]);
56 $server = trim($server);
60 $charset = trim($charset);
62 if (!(strlen($server) && strlen($user))) {
66 if (class_exists('\PDO') && in_array('mysql', PDO::getAvailableDrivers())) {
67 self::$driver = 'pdo';
68 $connect = "mysql:host=".$server.";dbname=".$db;
71 $connect .= ";port=".$port;
75 $connect .= ";charset=".$charset;
79 self::$db = @new PDO($connect, $user, $pass);
80 self::$db->setAttribute(PDO::ATTR_EMULATE_PREPARES, false);
81 self::$connected = true;
82 } catch (PDOException $e) {
86 if (!self::$connected && class_exists('mysqli')) {
87 self::$driver = 'mysqli';
88 self::$db = @new mysqli($server, $user, $pass, $db, $port);
89 if (!mysqli_connect_errno()) {
90 self::$connected = true;
93 self::$db->set_charset($charset);
98 // No suitable SQL driver was found.
99 if (!self::$connected) {
100 self::$driver = null;
104 return self::$connected;
108 * Disconnects the current database connection
110 public static function disconnect()
112 if (is_null(self::$db)) {
116 switch (self::$driver) {
128 * Perform a reconnect of an existing database connection
130 public static function reconnect() {
133 $ret = self::connect(self::$db_serveraddr, self::$db_user, self::$db_pass, self::$db_name, self::$db_charset);
138 * Return the database object.
141 public static function get_db()
147 * @brief Returns the MySQL server version string
149 * This function discriminate between the deprecated mysql API and the current
150 * object-oriented mysqli API. Example of returned string: 5.5.46-0+deb8u1
154 public static function server_info() {
155 if (self::$_server_info == '') {
156 switch (self::$driver) {
158 self::$_server_info = self::$db->getAttribute(PDO::ATTR_SERVER_VERSION);
161 self::$_server_info = self::$db->server_info;
165 return self::$_server_info;
169 * @brief Returns the selected database name
173 public static function database_name() {
174 $ret = self::p("SELECT DATABASE() AS `db`");
175 $data = self::inArray($ret);
176 return $data[0]['db'];
180 * @brief Analyze a database query and log this if some conditions are met.
182 * @param string $query The database query that will be analyzed
184 private static function logIndex($query) {
187 if (empty(Config::get('system', 'db_log_index'))) {
191 // Don't explain an explain statement
192 if (strtolower(substr($query, 0, 7)) == "explain") {
196 // Only do the explain on "select", "update" and "delete"
197 if (!in_array(strtolower(substr($query, 0, 6)), ["select", "update", "delete"])) {
201 $r = self::p("EXPLAIN ".$query);
202 if (!DBM::is_result($r)) {
206 $watchlist = explode(',', Config::get('system', 'db_log_index_watch'));
207 $blacklist = explode(',', Config::get('system', 'db_log_index_blacklist'));
209 while ($row = dba::fetch($r)) {
210 if ((intval(Config::get('system', 'db_loglimit_index')) > 0)) {
211 $log = (in_array($row['key'], $watchlist) &&
212 ($row['rows'] >= intval(Config::get('system', 'db_loglimit_index'))));
217 if ((intval(Config::get('system', 'db_loglimit_index_high')) > 0) && ($row['rows'] >= intval(Config::get('system', 'db_loglimit_index_high')))) {
221 if (in_array($row['key'], $blacklist) || ($row['key'] == "")) {
226 $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
227 @file_put_contents(Config::get('system', 'db_log_index'), DateTimeFormat::utcNow()."\t".
228 $row['key']."\t".$row['rows']."\t".$row['Extra']."\t".
229 basename($backtrace[1]["file"])."\t".
230 $backtrace[1]["line"]."\t".$backtrace[2]["function"]."\t".
231 substr($query, 0, 2000)."\n", FILE_APPEND);
236 public static function escape($str) {
237 switch (self::$driver) {
239 return substr(@self::$db->quote($str, PDO::PARAM_STR), 1, -1);
241 return @self::$db->real_escape_string($str);
245 public static function connected() {
248 switch (self::$driver) {
250 $r = dba::p("SELECT 1");
251 if (DBM::is_result($r)) {
252 $row = dba::inArray($r);
253 $connected = ($row[0]['1'] == '1');
257 $connected = self::$db->ping();
264 * @brief Replaces ANY_VALUE() function by MIN() function,
265 * if the database server does not support ANY_VALUE().
267 * Considerations for Standard SQL, or MySQL with ONLY_FULL_GROUP_BY (default since 5.7.5).
268 * ANY_VALUE() is available from MySQL 5.7.5 https://dev.mysql.com/doc/refman/5.7/en/miscellaneous-functions.html
269 * A standard fall-back is to use MIN().
271 * @param string $sql An SQL string without the values
272 * @return string The input SQL string modified if necessary.
274 public static function any_value_fallback($sql) {
275 $server_info = self::server_info();
276 if (version_compare($server_info, '5.7.5', '<') ||
277 (stripos($server_info, 'MariaDB') !== false)) {
278 $sql = str_ireplace('ANY_VALUE(', 'MIN(', $sql);
284 * @brief beautifies the query - useful for "SHOW PROCESSLIST"
286 * This is safe when we bind the parameters later.
287 * The parameter values aren't part of the SQL.
289 * @param string $sql An SQL string without the values
290 * @return string The input SQL string modified if necessary.
292 public static function clean_query($sql) {
293 $search = ["\t", "\n", "\r", " "];
294 $replace = [' ', ' ', ' ', ' '];
297 $sql = str_replace($search, $replace, $sql);
298 } while ($oldsql != $sql);
305 * @brief Replaces the ? placeholders with the parameters in the $args array
307 * @param string $sql SQL query
308 * @param array $args The parameters that are to replace the ? placeholders
309 * @return string The replaced SQL query
311 private static function replaceParameters($sql, $args) {
313 foreach ($args AS $param => $value) {
314 if (is_int($args[$param]) || is_float($args[$param])) {
315 $replace = intval($args[$param]);
317 $replace = "'".self::escape($args[$param])."'";
320 $pos = strpos($sql, '?', $offset);
321 if ($pos !== false) {
322 $sql = substr_replace($sql, $replace, $pos, 1);
324 $offset = $pos + strlen($replace);
330 * @brief Convert parameter array to an universal form
331 * @param array $args Parameter array
332 * @return array universalized parameter array
334 private static function getParam($args) {
337 // When the second function parameter is an array then use this as the parameter array
338 if ((count($args) > 0) && (is_array($args[1]))) {
346 * @brief Executes a prepared statement that returns data
347 * @usage Example: $r = p("SELECT * FROM `item` WHERE `guid` = ?", $guid);
349 * Please only use it with complicated queries.
350 * For all regular queries please use dba::select or dba::exists
352 * @param string $sql SQL statement
353 * @return bool|object statement object or result object
355 public static function p($sql) {
358 $stamp1 = microtime(true);
360 $params = self::getParam(func_get_args());
362 // Renumber the array keys to be sure that they fit
365 foreach ($params AS $param) {
366 // Avoid problems with some MySQL servers and boolean values. See issue #3645
367 if (is_bool($param)) {
368 $param = (int)$param;
370 $args[++$i] = $param;
373 if (!self::$connected) {
377 if ((substr_count($sql, '?') != count($args)) && (count($args) > 0)) {
378 // Question: Should we continue or stop the query here?
379 logger('Parameter mismatch. Query "'.$sql.'" - Parameters '.print_r($args, true), LOGGER_DEBUG);
382 $sql = self::clean_query($sql);
383 $sql = self::any_value_fallback($sql);
387 if (Config::get('system', 'db_callstack')) {
388 $sql = "/*".System::callstack()." */ ".$sql;
393 self::$affected_rows = 0;
395 // We have to make some things different if this function is called from "e"
396 $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2);
398 if (isset($trace[1])) {
399 $called_from = $trace[1];
401 // We use just something that is defined to avoid warnings
402 $called_from = $trace[0];
404 // We are having an own error logging in the function "e"
405 $called_from_e = ($called_from['function'] == 'e');
407 switch (self::$driver) {
409 // If there are no arguments we use "query"
410 if (count($args) == 0) {
411 if (!$retval = self::$db->query($sql)) {
412 $errorInfo = self::$db->errorInfo();
413 self::$error = $errorInfo[2];
414 self::$errorno = $errorInfo[1];
418 self::$affected_rows = $retval->rowCount();
422 if (!$stmt = self::$db->prepare($sql)) {
423 $errorInfo = self::$db->errorInfo();
424 self::$error = $errorInfo[2];
425 self::$errorno = $errorInfo[1];
430 foreach ($args AS $param => $value) {
431 if (is_int($args[$param])) {
432 $data_type = PDO::PARAM_INT;
434 $data_type = PDO::PARAM_STR;
436 $stmt->bindParam($param, $args[$param], $data_type);
439 if (!$stmt->execute()) {
440 $errorInfo = $stmt->errorInfo();
441 self::$error = $errorInfo[2];
442 self::$errorno = $errorInfo[1];
446 self::$affected_rows = $retval->rowCount();
450 // There are SQL statements that cannot be executed with a prepared statement
451 $parts = explode(' ', $orig_sql);
452 $command = strtolower($parts[0]);
453 $can_be_prepared = in_array($command, ['select', 'update', 'insert', 'delete']);
455 // The fallback routine is called as well when there are no arguments
456 if (!$can_be_prepared || (count($args) == 0)) {
457 $retval = self::$db->query(self::replaceParameters($sql, $args));
458 if (self::$db->errno) {
459 self::$error = self::$db->error;
460 self::$errorno = self::$db->errno;
463 if (isset($retval->num_rows)) {
464 self::$affected_rows = $retval->num_rows;
466 self::$affected_rows = self::$db->affected_rows;
472 $stmt = self::$db->stmt_init();
474 if (!$stmt->prepare($sql)) {
475 self::$error = $stmt->error;
476 self::$errorno = $stmt->errno;
483 foreach ($args AS $param => $value) {
484 if (is_int($args[$param])) {
486 } elseif (is_float($args[$param])) {
488 } elseif (is_string($args[$param])) {
493 $values[] = &$args[$param];
496 if (count($values) > 0) {
497 array_unshift($values, $param_types);
498 call_user_func_array([$stmt, 'bind_param'], $values);
501 if (!$stmt->execute()) {
502 self::$error = self::$db->error;
503 self::$errorno = self::$db->errno;
506 $stmt->store_result();
508 self::$affected_rows = $retval->affected_rows;
513 // We are having an own error logging in the function "e"
514 if ((self::$errorno != 0) && !$called_from_e) {
515 // We have to preserve the error code, somewhere in the logging it get lost
516 $error = self::$error;
517 $errorno = self::$errorno;
519 logger('DB Error '.self::$errorno.': '.self::$error."\n".
520 System::callstack(8)."\n".self::replaceParameters($sql, $args));
522 // On a lost connection we try to reconnect - but only once.
523 if ($errorno == 2006) {
524 if (self::$in_retrial || !self::reconnect()) {
525 // It doesn't make sense to continue when the database connection was lost
526 if (self::$in_retrial) {
527 logger('Giving up retrial because of database error '.$errorno.': '.$error);
529 logger("Couldn't reconnect after database error ".$errorno.': '.$error);
534 logger('Reconnected after database error '.$errorno.': '.$error);
535 self::$in_retrial = true;
536 $ret = self::p($sql, $args);
537 self::$in_retrial = false;
542 self::$error = $error;
543 self::$errorno = $errorno;
546 $a->save_timestamp($stamp1, 'database');
548 if (Config::get('system', 'db_log')) {
549 $stamp2 = microtime(true);
550 $duration = (float)($stamp2 - $stamp1);
552 if (($duration > Config::get('system', 'db_loglimit'))) {
553 $duration = round($duration, 3);
554 $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
556 @file_put_contents(Config::get('system', 'db_log'), DateTimeFormat::utcNow()."\t".$duration."\t".
557 basename($backtrace[1]["file"])."\t".
558 $backtrace[1]["line"]."\t".$backtrace[2]["function"]."\t".
559 substr(self::replaceParameters($sql, $args), 0, 2000)."\n", FILE_APPEND);
566 * @brief Executes a prepared statement like UPDATE or INSERT that doesn't return data
568 * Please use dba::delete, dba::insert, dba::update, ... instead
570 * @param string $sql SQL statement
571 * @return boolean Was the query successfull? False is returned only if an error occurred
573 public static function e($sql) {
576 $stamp = microtime(true);
578 $params = self::getParam(func_get_args());
580 // In a case of a deadlock we are repeating the query 20 times
584 $stmt = self::p($sql, $params);
586 if (is_bool($stmt)) {
588 } elseif (is_object($stmt)) {
596 } while ((self::$errorno == 1213) && (--$timeout > 0));
598 if (self::$errorno != 0) {
599 // We have to preserve the error code, somewhere in the logging it get lost
600 $error = self::$error;
601 $errorno = self::$errorno;
603 logger('DB Error '.self::$errorno.': '.self::$error."\n".
604 System::callstack(8)."\n".self::replaceParameters($sql, $params));
606 // On a lost connection we simply quit.
607 // A reconnect like in self::p could be dangerous with modifications
608 if ($errorno == 2006) {
609 logger('Giving up because of database error '.$errorno.': '.$error);
613 self::$error = $error;
614 self::$errorno = $errorno;
617 $a->save_timestamp($stamp, "database_write");
623 * @brief Check if data exists
625 * @param string $table Table name
626 * @param array $condition array of fields for condition
628 * @return boolean Are there rows for that condition?
630 public static function exists($table, $condition) {
638 $first_key = key($condition);
639 if (!is_int($first_key)) {
640 $fields = [$first_key];
643 $stmt = self::select($table, $fields, $condition, ['limit' => 1]);
645 if (is_bool($stmt)) {
648 $retval = (self::num_rows($stmt) > 0);
657 * Fetches the first row
659 * Please use dba::selectFirst or dba::exists whenever this is possible.
661 * @brief Fetches the first row
662 * @param string $sql SQL statement
663 * @return array first row of query
665 public static function fetch_first($sql) {
666 $params = self::getParam(func_get_args());
668 $stmt = self::p($sql, $params);
670 if (is_bool($stmt)) {
673 $retval = self::fetch($stmt);
682 * @brief Returns the number of affected rows of the last statement
684 * @return int Number of rows
686 public static function affected_rows() {
687 return self::$affected_rows;
691 * @brief Returns the number of columns of a statement
693 * @param object Statement object
694 * @return int Number of columns
696 public static function columnCount($stmt) {
697 if (!is_object($stmt)) {
700 switch (self::$driver) {
702 return $stmt->columnCount();
704 return $stmt->field_count;
709 * @brief Returns the number of rows of a statement
711 * @param PDOStatement|mysqli_result|mysqli_stmt Statement object
712 * @return int Number of rows
714 public static function num_rows($stmt) {
715 if (!is_object($stmt)) {
718 switch (self::$driver) {
720 return $stmt->rowCount();
722 return $stmt->num_rows;
728 * @brief Fetch a single row
730 * @param mixed $stmt statement object
731 * @return array current row
733 public static function fetch($stmt) {
736 $stamp1 = microtime(true);
740 if (!is_object($stmt)) {
744 switch (self::$driver) {
746 $columns = $stmt->fetch(PDO::FETCH_ASSOC);
749 if (get_class($stmt) == 'mysqli_result') {
750 $columns = $stmt->fetch_assoc();
754 // This code works, but is slow
756 // Bind the result to a result array
760 for ($x = 0; $x < $stmt->field_count; $x++) {
761 $cols[] = &$cols_num[$x];
764 call_user_func_array([$stmt, 'bind_result'], $cols);
766 if (!$stmt->fetch()) {
771 // We need to get the field names for the array keys
772 // It seems that there is no better way to do this.
773 $result = $stmt->result_metadata();
774 $fields = $result->fetch_fields();
776 foreach ($cols_num AS $param => $col) {
777 $columns[$fields[$param]->name] = $col;
781 $a->save_timestamp($stamp1, 'database');
787 * @brief Insert a row into a table
789 * @param string $table Table name
790 * @param array $param parameter array
791 * @param bool $on_duplicate_update Do an update on a duplicate entry
793 * @return boolean was the insert successfull?
795 public static function insert($table, $param, $on_duplicate_update = false) {
797 if (empty($table) || empty($param)) {
798 logger('Table and fields have to be set');
802 $sql = "INSERT INTO `".self::escape($table)."` (`".implode("`, `", array_keys($param))."`) VALUES (".
803 substr(str_repeat("?, ", count($param)), 0, -2).")";
805 if ($on_duplicate_update) {
806 $sql .= " ON DUPLICATE KEY UPDATE `".implode("` = ?, `", array_keys($param))."` = ?";
808 $values = array_values($param);
809 $param = array_merge_recursive($values, $values);
812 return self::e($sql, $param);
816 * @brief Fetch the id of the last insert command
818 * @return integer Last inserted id
820 public static function lastInsertId() {
821 switch (self::$driver) {
823 $id = self::$db->lastInsertId();
826 $id = self::$db->insert_id;
833 * @brief Locks a table for exclusive write access
835 * This function can be extended in the future to accept a table array as well.
837 * @param string $table Table name
839 * @return boolean was the lock successful?
841 public static function lock($table) {
842 // See here: https://dev.mysql.com/doc/refman/5.7/en/lock-tables-and-transactions.html
843 if (self::$driver == 'pdo') {
844 self::e("SET autocommit=0");
845 self::$db->setAttribute(PDO::ATTR_EMULATE_PREPARES, true);
847 self::$db->autocommit(false);
850 $success = self::e("LOCK TABLES `".self::escape($table)."` WRITE");
852 if (self::$driver == 'pdo') {
853 self::$db->setAttribute(PDO::ATTR_EMULATE_PREPARES, false);
857 if (self::$driver == 'pdo') {
858 self::e("SET autocommit=1");
860 self::$db->autocommit(true);
863 self::$in_transaction = true;
869 * @brief Unlocks all locked tables
871 * @return boolean was the unlock successful?
873 public static function unlock() {
874 // See here: https://dev.mysql.com/doc/refman/5.7/en/lock-tables-and-transactions.html
875 self::performCommit();
877 if (self::$driver == 'pdo') {
878 self::$db->setAttribute(PDO::ATTR_EMULATE_PREPARES, true);
881 $success = self::e("UNLOCK TABLES");
883 if (self::$driver == 'pdo') {
884 self::$db->setAttribute(PDO::ATTR_EMULATE_PREPARES, false);
885 self::e("SET autocommit=1");
887 self::$db->autocommit(true);
890 self::$in_transaction = false;
895 * @brief Starts a transaction
897 * @return boolean Was the command executed successfully?
899 public static function transaction() {
900 if (!self::performCommit()) {
904 switch (self::$driver) {
906 if (self::$db->inTransaction()) {
909 if (!self::$db->beginTransaction()) {
914 if (!self::$db->begin_transaction()) {
920 self::$in_transaction = true;
924 private static function performCommit()
926 switch (self::$driver) {
928 if (!self::$db->inTransaction()) {
931 return self::$db->commit();
933 return self::$db->commit();
939 * @brief Does a commit
941 * @return boolean Was the command executed successfully?
943 public static function commit() {
944 if (!self::performCommit()) {
947 self::$in_transaction = false;
952 * @brief Does a rollback
954 * @return boolean Was the command executed successfully?
956 public static function rollback() {
959 switch (self::$driver) {
961 if (!self::$db->inTransaction()) {
965 $ret = self::$db->rollBack();
968 $ret = self::$db->rollback();
971 self::$in_transaction = false;
976 * @brief Build the array with the table relations
978 * The array is build from the database definitions in DBStructure.php
980 * This process must only be started once, since the value is cached.
982 private static function buildRelationData() {
983 $definition = DBStructure::definition();
985 foreach ($definition AS $table => $structure) {
986 foreach ($structure['fields'] AS $field => $field_struct) {
987 if (isset($field_struct['relation'])) {
988 foreach ($field_struct['relation'] AS $rel_table => $rel_field) {
989 self::$relation[$rel_table][$rel_field][$table][] = $field;
997 * @brief Delete a row from a table
999 * @param string $table Table name
1000 * @param array $conditions Field condition(s)
1001 * @param array $options
1002 * - cascade: If true we delete records in other tables that depend on the one we're deleting through
1003 * relations (default: true)
1004 * @param boolean $in_process Internal use: Only do a commit after the last delete
1005 * @param array $callstack Internal use: prevent endless loops
1007 * @return boolean|array was the delete successful? When $in_process is set: deletion data
1009 public static function delete($table, array $conditions, array $options = [], $in_process = false, array &$callstack = [])
1011 if (empty($table) || empty($conditions)) {
1012 logger('Table and conditions have to be set');
1018 // Create a key for the loop prevention
1019 $key = $table . ':' . json_encode($conditions);
1021 // We quit when this key already exists in the callstack.
1022 if (isset($callstack[$key])) {
1026 $callstack[$key] = true;
1028 $table = self::escape($table);
1030 $commands[$key] = ['table' => $table, 'conditions' => $conditions];
1032 $cascade = defaults($options, 'cascade', true);
1034 // To speed up the whole process we cache the table relations
1035 if ($cascade && count(self::$relation) == 0) {
1036 self::buildRelationData();
1039 // Is there a relation entry for the table?
1040 if ($cascade && isset(self::$relation[$table])) {
1041 // We only allow a simple "one field" relation.
1042 $field = array_keys(self::$relation[$table])[0];
1043 $rel_def = array_values(self::$relation[$table])[0];
1045 // Create a key for preventing double queries
1046 $qkey = $field . '-' . $table . ':' . json_encode($conditions);
1048 // When the search field is the relation field, we don't need to fetch the rows
1049 // This is useful when the leading record is already deleted in the frontend but the rest is done in the backend
1050 if ((count($conditions) == 1) && ($field == array_keys($conditions)[0])) {
1051 foreach ($rel_def AS $rel_table => $rel_fields) {
1052 foreach ($rel_fields AS $rel_field) {
1053 $retval = self::delete($rel_table, [$rel_field => array_values($conditions)[0]], $options, true, $callstack);
1054 $commands = array_merge($commands, $retval);
1057 // We quit when this key already exists in the callstack.
1058 } elseif (!isset($callstack[$qkey])) {
1060 $callstack[$qkey] = true;
1062 // Fetch all rows that are to be deleted
1063 $data = self::select($table, [$field], $conditions);
1065 while ($row = self::fetch($data)) {
1066 // Now we accumulate the delete commands
1067 $retval = self::delete($table, [$field => $row[$field]], $options, true, $callstack);
1068 $commands = array_merge($commands, $retval);
1073 // Since we had split the delete command we don't need the original command anymore
1074 unset($commands[$key]);
1079 // Now we finalize the process
1080 $do_transaction = !self::$in_transaction;
1082 if ($do_transaction) {
1083 self::transaction();
1089 foreach ($commands AS $command) {
1090 $conditions = $command['conditions'];
1092 $first_key = key($conditions);
1094 $condition_string = self::buildCondition($conditions);
1096 if ((count($command['conditions']) > 1) || is_int($first_key)) {
1097 $sql = "DELETE FROM `" . $command['table'] . "`" . $condition_string;
1098 logger(self::replaceParameters($sql, $conditions), LOGGER_DATA);
1100 if (!self::e($sql, $conditions)) {
1101 if ($do_transaction) {
1107 $key_table = $command['table'];
1108 $key_condition = array_keys($command['conditions'])[0];
1109 $value = array_values($command['conditions'])[0];
1111 // Split the SQL queries in chunks of 100 values
1112 // We do the $i stuff here to make the code better readable
1113 $i = isset($counter[$key_table][$key_condition]) ? $counter[$key_table][$key_condition] : 0;
1114 if (isset($compacted[$key_table][$key_condition][$i]) && count($compacted[$key_table][$key_condition][$i]) > 100) {
1118 $compacted[$key_table][$key_condition][$i][$value] = $value;
1119 $counter[$key_table][$key_condition] = $i;
1122 foreach ($compacted AS $table => $values) {
1123 foreach ($values AS $field => $field_value_list) {
1124 foreach ($field_value_list AS $field_values) {
1125 $sql = "DELETE FROM `" . $table . "` WHERE `" . $field . "` IN (" .
1126 substr(str_repeat("?, ", count($field_values)), 0, -2) . ");";
1128 logger(self::replaceParameters($sql, $field_values), LOGGER_DATA);
1130 if (!self::e($sql, $field_values)) {
1131 if ($do_transaction) {
1139 if ($do_transaction) {
1149 * @brief Updates rows
1151 * Updates rows in the database. When $old_fields is set to an array,
1152 * the system will only do an update if the fields in that array changed.
1155 * Only the values in $old_fields are compared.
1156 * This is an intentional behaviour.
1159 * We include the timestamp field in $fields but not in $old_fields.
1160 * Then the row will only get the new timestamp when the other fields had changed.
1162 * When $old_fields is set to a boolean value the system will do this compare itself.
1163 * When $old_fields is set to "true" the system will do an insert if the row doesn't exists.
1166 * Only set $old_fields to a boolean value when you are sure that you will update a single row.
1167 * When you set $old_fields to "true" then $fields must contain all relevant fields!
1169 * @param string $table Table name
1170 * @param array $fields contains the fields that are updated
1171 * @param array $condition condition array with the key values
1172 * @param array|boolean $old_fields array with the old field values that are about to be replaced (true = update on duplicate)
1174 * @return boolean was the update successfull?
1176 public static function update($table, $fields, $condition, $old_fields = []) {
1178 if (empty($table) || empty($fields) || empty($condition)) {
1179 logger('Table, fields and condition have to be set');
1183 $table = self::escape($table);
1185 $condition_string = self::buildCondition($condition);
1187 if (is_bool($old_fields)) {
1188 $do_insert = $old_fields;
1190 $old_fields = self::selectFirst($table, [], $condition);
1192 if (is_bool($old_fields)) {
1194 $values = array_merge($condition, $fields);
1195 return self::insert($table, $values, $do_insert);
1201 $do_update = (count($old_fields) == 0);
1203 foreach ($old_fields AS $fieldname => $content) {
1204 if (isset($fields[$fieldname])) {
1205 if ($fields[$fieldname] == $content) {
1206 unset($fields[$fieldname]);
1213 if (!$do_update || (count($fields) == 0)) {
1217 $sql = "UPDATE `".$table."` SET `".
1218 implode("` = ?, `", array_keys($fields))."` = ?".$condition_string;
1220 $params1 = array_values($fields);
1221 $params2 = array_values($condition);
1222 $params = array_merge_recursive($params1, $params2);
1224 return self::e($sql, $params);
1228 * Retrieve a single record from a table and returns it in an associative array
1230 * @brief Retrieve a single record from a table
1231 * @param string $table
1232 * @param array $fields
1233 * @param array $condition
1234 * @param array $params
1235 * @return bool|array
1238 public static function selectFirst($table, array $fields = [], array $condition = [], $params = [])
1240 $params['limit'] = 1;
1241 $result = self::select($table, $fields, $condition, $params);
1243 if (is_bool($result)) {
1246 $row = self::fetch($result);
1247 self::close($result);
1253 * @brief Select rows from a table
1255 * @param string $table Table name
1256 * @param array $fields Array of selected fields, empty for all
1257 * @param array $condition Array of fields for condition
1258 * @param array $params Array of several parameters
1260 * @return boolean|object
1264 * $fields = array("id", "uri", "uid", "network");
1266 * $condition = array("uid" => 1, "network" => 'dspr');
1268 * $condition = array("`uid` = ? AND `network` IN (?, ?)", 1, 'dfrn', 'dspr');
1270 * $params = array("order" => array("id", "received" => true), "limit" => 10);
1272 * $data = dba::select($table, $fields, $condition, $params);
1274 public static function select($table, array $fields = [], array $condition = [], array $params = [])
1280 $table = self::escape($table);
1282 if (count($fields) > 0) {
1283 $select_fields = "`" . implode("`, `", array_values($fields)) . "`";
1285 $select_fields = "*";
1288 $condition_string = self::buildCondition($condition);
1290 $param_string = self::buildParameter($params);
1292 $sql = "SELECT " . $select_fields . " FROM `" . $table . "`" . $condition_string . $param_string;
1294 $result = self::p($sql, $condition);
1300 * @brief Counts the rows from a table satisfying the provided condition
1302 * @param string $table Table name
1303 * @param array $condition array of fields for condition
1310 * $condition = ["uid" => 1, "network" => 'dspr'];
1312 * $condition = ["`uid` = ? AND `network` IN (?, ?)", 1, 'dfrn', 'dspr'];
1314 * $count = dba::count($table, $condition);
1316 public static function count($table, array $condition = [])
1322 $condition_string = self::buildCondition($condition);
1324 $sql = "SELECT COUNT(*) AS `count` FROM `".$table."`".$condition_string;
1326 $row = self::fetch_first($sql, $condition);
1328 return $row['count'];
1332 * @brief Returns the SQL condition string built from the provided condition array
1334 * This function operates with two modes.
1335 * - Supplied with a filed/value associative array, it builds simple strict
1336 * equality conditions linked by AND.
1337 * - Supplied with a flat list, the first element is the condition string and
1338 * the following arguments are the values to be interpolated
1340 * $condition = ["uid" => 1, "network" => 'dspr'];
1342 * $condition = ["`uid` = ? AND `network` IN (?, ?)", 1, 'dfrn', 'dspr'];
1344 * In either case, the provided array is left with the parameters only
1346 * @param array $condition
1349 public static function buildCondition(array &$condition = [])
1351 $condition_string = '';
1352 if (count($condition) > 0) {
1354 $first_key = key($condition);
1355 if (is_int($first_key)) {
1356 $condition_string = " WHERE (" . array_shift($condition) . ")";
1359 $condition_string = "";
1360 foreach ($condition as $field => $value) {
1361 if ($condition_string != "") {
1362 $condition_string .= " AND ";
1364 if (is_array($value)) {
1365 /* Workaround for MySQL Bug #64791.
1366 * Never mix data types inside any IN() condition.
1367 * In case of mixed types, cast all as string.
1368 * Logic needs to be consistent with dba::p() data types.
1372 foreach ($value as $single_value) {
1373 if (is_int($single_value)) {
1380 if ($is_int && $is_alpha) {
1381 foreach ($value as &$ref) {
1383 $ref = (string)$ref;
1386 unset($ref); //Prevent accidental re-use.
1389 $new_values = array_merge($new_values, array_values($value));
1390 $placeholders = substr(str_repeat("?, ", count($value)), 0, -2);
1391 $condition_string .= "`" . $field . "` IN (" . $placeholders . ")";
1393 $new_values[$field] = $value;
1394 $condition_string .= "`" . $field . "` = ?";
1397 $condition_string = " WHERE (" . $condition_string . ")";
1398 $condition = $new_values;
1402 return $condition_string;
1406 * @brief Returns the SQL parameter string built from the provided parameter array
1408 * @param array $params
1411 public static function buildParameter(array $params = [])
1414 if (isset($params['order'])) {
1415 $order_string = " ORDER BY ";
1416 foreach ($params['order'] AS $fields => $order) {
1417 if (!is_int($fields)) {
1418 $order_string .= "`" . $fields . "` " . ($order ? "DESC" : "ASC") . ", ";
1420 $order_string .= "`" . $order . "`, ";
1423 $order_string = substr($order_string, 0, -2);
1427 if (isset($params['limit']) && is_int($params['limit'])) {
1428 $limit_string = " LIMIT " . $params['limit'];
1431 if (isset($params['limit']) && is_array($params['limit'])) {
1432 $limit_string = " LIMIT " . intval($params['limit'][0]) . ", " . intval($params['limit'][1]);
1435 return $order_string.$limit_string;
1439 * @brief Fills an array with data from a query
1441 * @param object $stmt statement object
1442 * @return array Data array
1444 public static function inArray($stmt, $do_close = true) {
1445 if (is_bool($stmt)) {
1450 while ($row = self::fetch($stmt)) {
1460 * @brief Returns the error number of the last query
1462 * @return string Error number (0 if no error)
1464 public static function errorNo() {
1465 return self::$errorno;
1469 * @brief Returns the error message of the last query
1471 * @return string Error message ('' if no error)
1473 public static function errorMessage() {
1474 return self::$error;
1478 * @brief Closes the current statement
1480 * @param object $stmt statement object
1481 * @return boolean was the close successful?
1483 public static function close($stmt) {
1486 $stamp1 = microtime(true);
1488 if (!is_object($stmt)) {
1492 switch (self::$driver) {
1494 $ret = $stmt->closeCursor();
1497 // MySQLi offers both a mysqli_stmt and a mysqli_result class.
1498 // We should be careful not to assume the object type of $stmt
1499 // because dba::p() has been able to return both types.
1500 if ($stmt instanceof mysqli_stmt) {
1501 $stmt->free_result();
1502 $ret = $stmt->close();
1503 } elseif ($stmt instanceof mysqli_result) {
1512 $a->save_timestamp($stamp1, 'database');
1518 function dbesc($str) {
1519 if (dba::$connected) {
1520 return(dba::escape($str));
1522 return(str_replace("'","\\'",$str));
1527 * @brief execute SQL query with printf style args - deprecated
1529 * Please use the dba:: functions instead:
1530 * dba::select, dba::exists, dba::insert
1531 * dba::delete, dba::update, dba::p, dba::e
1533 * @param $args Query parameters (1 to N parameters of different types)
1534 * @return array|bool Query array
1537 $args = func_get_args();
1540 if (!dba::$connected) {
1544 $sql = dba::clean_query($sql);
1545 $sql = dba::any_value_fallback($sql);
1547 $stmt = @vsprintf($sql, $args);
1549 $ret = dba::p($stmt);
1551 if (is_bool($ret)) {
1555 $columns = dba::columnCount($ret);
1557 $data = dba::inArray($ret);
1559 if ((count($data) == 0) && ($columns == 0)) {
1566 function dba_timer() {
1567 return microtime(true);