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 = '';
33 public static function connect($serveraddr, $user, $pass, $db) {
34 if (!is_null(self::$db) && self::connected()) {
40 $stamp1 = microtime(true);
42 // We are storing these values for being able to perform a reconnect
43 self::$db_serveraddr = $serveraddr;
44 self::$db_user = $user;
45 self::$db_pass = $pass;
48 $serveraddr = trim($serveraddr);
50 $serverdata = explode(':', $serveraddr);
51 $server = $serverdata[0];
53 if (count($serverdata) > 1) {
54 $port = trim($serverdata[1]);
57 $server = trim($server);
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;
74 if (isset($a->config["system"]["db_charset"])) {
75 $connect .= ";charset=".$a->config["system"]["db_charset"];
78 self::$db = @new PDO($connect, $user, $pass);
79 self::$connected = true;
80 } catch (PDOException $e) {
84 if (!self::$connected && class_exists('mysqli')) {
85 self::$driver = 'mysqli';
86 self::$db = @new mysqli($server, $user, $pass, $db, $port);
87 if (!mysqli_connect_errno()) {
88 self::$connected = true;
90 if (isset($a->config["system"]["db_charset"])) {
91 self::$db->set_charset($a->config["system"]["db_charset"]);
96 // No suitable SQL driver was found.
97 if (!self::$connected) {
101 $a->save_timestamp($stamp1, "network");
103 return self::$connected;
107 * Disconnects the current database connection
109 public static function disconnect()
111 if (is_null(self::$db)) {
115 switch (self::$driver) {
127 * Perform a reconnect of an existing database connection
129 public static function reconnect() {
132 $ret = self::connect(self::$db_serveraddr, self::$db_user, self::$db_pass, self::$db_name);
137 * Return the database object.
140 public static function get_db()
146 * @brief Returns the MySQL server version string
148 * This function discriminate between the deprecated mysql API and the current
149 * object-oriented mysqli API. Example of returned string: 5.5.46-0+deb8u1
153 public static function server_info() {
154 if (self::$_server_info == '') {
155 switch (self::$driver) {
157 self::$_server_info = self::$db->getAttribute(PDO::ATTR_SERVER_VERSION);
160 self::$_server_info = self::$db->server_info;
164 return self::$_server_info;
168 * @brief Returns the selected database name
172 public static function database_name() {
173 $ret = self::p("SELECT DATABASE() AS `db`");
174 $data = self::inArray($ret);
175 return $data[0]['db'];
179 * @brief Analyze a database query and log this if some conditions are met.
181 * @param string $query The database query that will be analyzed
183 private static function logIndex($query) {
186 if (empty($a->config["system"]["db_log_index"])) {
190 // Don't explain an explain statement
191 if (strtolower(substr($query, 0, 7)) == "explain") {
195 // Only do the explain on "select", "update" and "delete"
196 if (!in_array(strtolower(substr($query, 0, 6)), ["select", "update", "delete"])) {
200 $r = self::p("EXPLAIN ".$query);
201 if (!DBM::is_result($r)) {
205 $watchlist = explode(',', $a->config["system"]["db_log_index_watch"]);
206 $blacklist = explode(',', $a->config["system"]["db_log_index_blacklist"]);
208 while ($row = dba::fetch($r)) {
209 if ((intval($a->config["system"]["db_loglimit_index"]) > 0)) {
210 $log = (in_array($row['key'], $watchlist) &&
211 ($row['rows'] >= intval($a->config["system"]["db_loglimit_index"])));
216 if ((intval($a->config["system"]["db_loglimit_index_high"]) > 0) && ($row['rows'] >= intval($a->config["system"]["db_loglimit_index_high"]))) {
220 if (in_array($row['key'], $blacklist) || ($row['key'] == "")) {
225 $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
226 @file_put_contents($a->config["system"]["db_log_index"], DateTimeFormat::utcNow()."\t".
227 $row['key']."\t".$row['rows']."\t".$row['Extra']."\t".
228 basename($backtrace[1]["file"])."\t".
229 $backtrace[1]["line"]."\t".$backtrace[2]["function"]."\t".
230 substr($query, 0, 2000)."\n", FILE_APPEND);
235 public static function escape($str) {
236 switch (self::$driver) {
238 return substr(@self::$db->quote($str, PDO::PARAM_STR), 1, -1);
240 return @self::$db->real_escape_string($str);
244 public static function connected() {
247 switch (self::$driver) {
249 $r = dba::p("SELECT 1");
250 if (DBM::is_result($r)) {
251 $row = dba::inArray($r);
252 $connected = ($row[0]['1'] == '1');
256 $connected = self::$db->ping();
263 * @brief Replaces ANY_VALUE() function by MIN() function,
264 * if the database server does not support ANY_VALUE().
266 * Considerations for Standard SQL, or MySQL with ONLY_FULL_GROUP_BY (default since 5.7.5).
267 * ANY_VALUE() is available from MySQL 5.7.5 https://dev.mysql.com/doc/refman/5.7/en/miscellaneous-functions.html
268 * A standard fall-back is to use MIN().
270 * @param string $sql An SQL string without the values
271 * @return string The input SQL string modified if necessary.
273 public static function any_value_fallback($sql) {
274 $server_info = self::server_info();
275 if (version_compare($server_info, '5.7.5', '<') ||
276 (stripos($server_info, 'MariaDB') !== false)) {
277 $sql = str_ireplace('ANY_VALUE(', 'MIN(', $sql);
283 * @brief beautifies the query - useful for "SHOW PROCESSLIST"
285 * This is safe when we bind the parameters later.
286 * The parameter values aren't part of the SQL.
288 * @param string $sql An SQL string without the values
289 * @return string The input SQL string modified if necessary.
291 public static function clean_query($sql) {
292 $search = ["\t", "\n", "\r", " "];
293 $replace = [' ', ' ', ' ', ' '];
296 $sql = str_replace($search, $replace, $sql);
297 } while ($oldsql != $sql);
304 * @brief Replaces the ? placeholders with the parameters in the $args array
306 * @param string $sql SQL query
307 * @param array $args The parameters that are to replace the ? placeholders
308 * @return string The replaced SQL query
310 private static function replaceParameters($sql, $args) {
312 foreach ($args AS $param => $value) {
313 if (is_int($args[$param]) || is_float($args[$param])) {
314 $replace = intval($args[$param]);
316 $replace = "'".self::escape($args[$param])."'";
319 $pos = strpos($sql, '?', $offset);
320 if ($pos !== false) {
321 $sql = substr_replace($sql, $replace, $pos, 1);
323 $offset = $pos + strlen($replace);
329 * @brief Convert parameter array to an universal form
330 * @param array $args Parameter array
331 * @return array universalized parameter array
333 private static function getParam($args) {
336 // When the second function parameter is an array then use this as the parameter array
337 if ((count($args) > 0) && (is_array($args[1]))) {
345 * @brief Executes a prepared statement that returns data
346 * @usage Example: $r = p("SELECT * FROM `item` WHERE `guid` = ?", $guid);
348 * Please only use it with complicated queries.
349 * For all regular queries please use dba::select or dba::exists
351 * @param string $sql SQL statement
352 * @return bool|object statement object
354 public static function p($sql) {
357 $stamp1 = microtime(true);
359 $params = self::getParam(func_get_args());
361 // Renumber the array keys to be sure that they fit
364 foreach ($params AS $param) {
365 // Avoid problems with some MySQL servers and boolean values. See issue #3645
366 if (is_bool($param)) {
367 $param = (int)$param;
369 $args[++$i] = $param;
372 if (!self::$connected) {
376 if ((substr_count($sql, '?') != count($args)) && (count($args) > 0)) {
377 // Question: Should we continue or stop the query here?
378 logger('Parameter mismatch. Query "'.$sql.'" - Parameters '.print_r($args, true), LOGGER_DEBUG);
381 $sql = self::clean_query($sql);
382 $sql = self::any_value_fallback($sql);
386 if (x($a->config,'system') && x($a->config['system'], 'db_callstack')) {
387 $sql = "/*".System::callstack()." */ ".$sql;
392 self::$affected_rows = 0;
394 // We have to make some things different if this function is called from "e"
395 $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2);
397 if (isset($trace[1])) {
398 $called_from = $trace[1];
400 // We use just something that is defined to avoid warnings
401 $called_from = $trace[0];
403 // We are having an own error logging in the function "e"
404 $called_from_e = ($called_from['function'] == 'e');
406 switch (self::$driver) {
408 // If there are no arguments we use "query"
409 if (count($args) == 0) {
410 if (!$retval = self::$db->query($sql)) {
411 $errorInfo = self::$db->errorInfo();
412 self::$error = $errorInfo[2];
413 self::$errorno = $errorInfo[1];
417 self::$affected_rows = $retval->rowCount();
421 if (!$stmt = self::$db->prepare($sql)) {
422 $errorInfo = self::$db->errorInfo();
423 self::$error = $errorInfo[2];
424 self::$errorno = $errorInfo[1];
429 foreach ($args AS $param => $value) {
430 $stmt->bindParam($param, $args[$param]);
433 if (!$stmt->execute()) {
434 $errorInfo = $stmt->errorInfo();
435 self::$error = $errorInfo[2];
436 self::$errorno = $errorInfo[1];
440 self::$affected_rows = $retval->rowCount();
444 // There are SQL statements that cannot be executed with a prepared statement
445 $parts = explode(' ', $orig_sql);
446 $command = strtolower($parts[0]);
447 $can_be_prepared = in_array($command, ['select', 'update', 'insert', 'delete']);
449 // The fallback routine is called as well when there are no arguments
450 if (!$can_be_prepared || (count($args) == 0)) {
451 $retval = self::$db->query(self::replaceParameters($sql, $args));
452 if (self::$db->errno) {
453 self::$error = self::$db->error;
454 self::$errorno = self::$db->errno;
457 if (isset($retval->num_rows)) {
458 self::$affected_rows = $retval->num_rows;
460 self::$affected_rows = self::$db->affected_rows;
466 $stmt = self::$db->stmt_init();
468 if (!$stmt->prepare($sql)) {
469 self::$error = $stmt->error;
470 self::$errorno = $stmt->errno;
477 foreach ($args AS $param => $value) {
478 if (is_int($args[$param])) {
480 } elseif (is_float($args[$param])) {
482 } elseif (is_string($args[$param])) {
487 $values[] = &$args[$param];
490 if (count($values) > 0) {
491 array_unshift($values, $param_types);
492 call_user_func_array([$stmt, 'bind_param'], $values);
495 if (!$stmt->execute()) {
496 self::$error = self::$db->error;
497 self::$errorno = self::$db->errno;
500 $stmt->store_result();
502 self::$affected_rows = $retval->affected_rows;
507 // We are having an own error logging in the function "e"
508 if ((self::$errorno != 0) && !$called_from_e) {
509 // We have to preserve the error code, somewhere in the logging it get lost
510 $error = self::$error;
511 $errorno = self::$errorno;
513 logger('DB Error '.self::$errorno.': '.self::$error."\n".
514 System::callstack(8)."\n".self::replaceParameters($sql, $args));
516 // On a lost connection we try to reconnect - but only once.
517 if ($errorno == 2006) {
518 if (self::$in_retrial || !self::reconnect()) {
519 // It doesn't make sense to continue when the database connection was lost
520 if (self::$in_retrial) {
521 logger('Giving up retrial because of database error '.$errorno.': '.$error);
523 logger("Couldn't reconnect after database error ".$errorno.': '.$error);
528 logger('Reconnected after database error '.$errorno.': '.$error);
529 self::$in_retrial = true;
530 $ret = self::p($sql, $args);
531 self::$in_retrial = false;
536 self::$error = $error;
537 self::$errorno = $errorno;
540 $a->save_timestamp($stamp1, 'database');
542 if (x($a->config,'system') && x($a->config['system'], 'db_log')) {
544 $stamp2 = microtime(true);
545 $duration = (float)($stamp2 - $stamp1);
547 if (($duration > $a->config["system"]["db_loglimit"])) {
548 $duration = round($duration, 3);
549 $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
551 @file_put_contents($a->config["system"]["db_log"], DateTimeFormat::utcNow()."\t".$duration."\t".
552 basename($backtrace[1]["file"])."\t".
553 $backtrace[1]["line"]."\t".$backtrace[2]["function"]."\t".
554 substr(self::replaceParameters($sql, $args), 0, 2000)."\n", FILE_APPEND);
561 * @brief Executes a prepared statement like UPDATE or INSERT that doesn't return data
563 * Please use dba::delete, dba::insert, dba::update, ... instead
565 * @param string $sql SQL statement
566 * @return boolean Was the query successfull? False is returned only if an error occurred
568 public static function e($sql) {
571 $stamp = microtime(true);
573 $params = self::getParam(func_get_args());
575 // In a case of a deadlock we are repeating the query 20 times
579 $stmt = self::p($sql, $params);
581 if (is_bool($stmt)) {
583 } elseif (is_object($stmt)) {
591 } while ((self::$errorno == 1213) && (--$timeout > 0));
593 if (self::$errorno != 0) {
594 // We have to preserve the error code, somewhere in the logging it get lost
595 $error = self::$error;
596 $errorno = self::$errorno;
598 logger('DB Error '.self::$errorno.': '.self::$error."\n".
599 System::callstack(8)."\n".self::replaceParameters($sql, $params));
601 // On a lost connection we simply quit.
602 // A reconnect like in self::p could be dangerous with modifications
603 if ($errorno == 2006) {
604 logger('Giving up because of database error '.$errorno.': '.$error);
608 self::$error = $error;
609 self::$errorno = $errorno;
612 $a->save_timestamp($stamp, "database_write");
618 * @brief Check if data exists
620 * @param string $table Table name
621 * @param array $condition array of fields for condition
623 * @return boolean Are there rows for that condition?
625 public static function exists($table, $condition) {
633 $first_key = key($condition);
634 if (!is_int($first_key)) {
635 $fields = [$first_key];
638 $stmt = self::select($table, $fields, $condition, ['limit' => 1]);
640 if (is_bool($stmt)) {
643 $retval = (self::num_rows($stmt) > 0);
652 * Fetches the first row
654 * Please use dba::selectFirst or dba::exists whenever this is possible.
656 * @brief Fetches the first row
657 * @param string $sql SQL statement
658 * @return array first row of query
660 public static function fetch_first($sql) {
661 $params = self::getParam(func_get_args());
663 $stmt = self::p($sql, $params);
665 if (is_bool($stmt)) {
668 $retval = self::fetch($stmt);
677 * @brief Returns the number of affected rows of the last statement
679 * @return int Number of rows
681 public static function affected_rows() {
682 return self::$affected_rows;
686 * @brief Returns the number of columns of a statement
688 * @param object Statement object
689 * @return int Number of columns
691 public static function columnCount($stmt) {
692 if (!is_object($stmt)) {
695 switch (self::$driver) {
697 return $stmt->columnCount();
699 return $stmt->field_count;
704 * @brief Returns the number of rows of a statement
706 * @param PDOStatement|mysqli_result|mysqli_stmt Statement object
707 * @return int Number of rows
709 public static function num_rows($stmt) {
710 if (!is_object($stmt)) {
713 switch (self::$driver) {
715 return $stmt->rowCount();
717 return $stmt->num_rows;
723 * @brief Fetch a single row
725 * @param mixed $stmt statement object
726 * @return array current row
728 public static function fetch($stmt) {
731 $stamp1 = microtime(true);
735 if (!is_object($stmt)) {
739 switch (self::$driver) {
741 $columns = $stmt->fetch(PDO::FETCH_ASSOC);
744 if (get_class($stmt) == 'mysqli_result') {
745 $columns = $stmt->fetch_assoc();
749 // This code works, but is slow
751 // Bind the result to a result array
755 for ($x = 0; $x < $stmt->field_count; $x++) {
756 $cols[] = &$cols_num[$x];
759 call_user_func_array([$stmt, 'bind_result'], $cols);
761 if (!$stmt->fetch()) {
766 // We need to get the field names for the array keys
767 // It seems that there is no better way to do this.
768 $result = $stmt->result_metadata();
769 $fields = $result->fetch_fields();
771 foreach ($cols_num AS $param => $col) {
772 $columns[$fields[$param]->name] = $col;
776 $a->save_timestamp($stamp1, 'database');
782 * @brief Insert a row into a table
784 * @param string $table Table name
785 * @param array $param parameter array
786 * @param bool $on_duplicate_update Do an update on a duplicate entry
788 * @return boolean was the insert successfull?
790 public static function insert($table, $param, $on_duplicate_update = false) {
792 if (empty($table) || empty($param)) {
793 logger('Table and fields have to be set');
797 $sql = "INSERT INTO `".self::escape($table)."` (`".implode("`, `", array_keys($param))."`) VALUES (".
798 substr(str_repeat("?, ", count($param)), 0, -2).")";
800 if ($on_duplicate_update) {
801 $sql .= " ON DUPLICATE KEY UPDATE `".implode("` = ?, `", array_keys($param))."` = ?";
803 $values = array_values($param);
804 $param = array_merge_recursive($values, $values);
807 return self::e($sql, $param);
811 * @brief Fetch the id of the last insert command
813 * @return integer Last inserted id
815 public static function lastInsertId() {
816 switch (self::$driver) {
818 $id = self::$db->lastInsertId();
821 $id = self::$db->insert_id;
828 * @brief Locks a table for exclusive write access
830 * This function can be extended in the future to accept a table array as well.
832 * @param string $table Table name
834 * @return boolean was the lock successful?
836 public static function lock($table) {
837 // See here: https://dev.mysql.com/doc/refman/5.7/en/lock-tables-and-transactions.html
838 self::e("SET autocommit=0");
839 $success = self::e("LOCK TABLES `".self::escape($table)."` WRITE");
841 self::e("SET autocommit=1");
843 self::$in_transaction = true;
849 * @brief Unlocks all locked tables
851 * @return boolean was the unlock successful?
853 public static function unlock() {
854 // See here: https://dev.mysql.com/doc/refman/5.7/en/lock-tables-and-transactions.html
856 $success = self::e("UNLOCK TABLES");
857 self::e("SET autocommit=1");
858 self::$in_transaction = false;
863 * @brief Starts a transaction
865 * @return boolean Was the command executed successfully?
867 public static function transaction() {
868 if (!self::e('COMMIT')) {
871 if (!self::e('START TRANSACTION')) {
874 self::$in_transaction = true;
879 * @brief Does a commit
881 * @return boolean Was the command executed successfully?
883 public static function commit() {
884 if (!self::e('COMMIT')) {
887 self::$in_transaction = false;
892 * @brief Does a rollback
894 * @return boolean Was the command executed successfully?
896 public static function rollback() {
897 if (!self::e('ROLLBACK')) {
900 self::$in_transaction = false;
905 * @brief Build the array with the table relations
907 * The array is build from the database definitions in DBStructure.php
909 * This process must only be started once, since the value is cached.
911 private static function buildRelationData() {
912 $definition = DBStructure::definition();
914 foreach ($definition AS $table => $structure) {
915 foreach ($structure['fields'] AS $field => $field_struct) {
916 if (isset($field_struct['relation'])) {
917 foreach ($field_struct['relation'] AS $rel_table => $rel_field) {
918 self::$relation[$rel_table][$rel_field][$table][] = $field;
926 * @brief Delete a row from a table
928 * @param string $table Table name
929 * @param array $conditions Field condition(s)
930 * @param array $options
931 * - cascade: If true we delete records in other tables that depend on the one we're deleting through
932 * relations (default: true)
933 * @param boolean $in_process Internal use: Only do a commit after the last delete
934 * @param array $callstack Internal use: prevent endless loops
936 * @return boolean|array was the delete successful? When $in_process is set: deletion data
938 public static function delete($table, array $conditions, array $options = [], $in_process = false, array &$callstack = [])
940 if (empty($table) || empty($conditions)) {
941 logger('Table and conditions have to be set');
947 // Create a key for the loop prevention
948 $key = $table . ':' . implode(':', array_keys($conditions)) . ':' . implode(':', $conditions);
950 // We quit when this key already exists in the callstack.
951 if (isset($callstack[$key])) {
955 $callstack[$key] = true;
957 $table = self::escape($table);
959 $commands[$key] = ['table' => $table, 'conditions' => $conditions];
961 $cascade = defaults($options, 'cascade', true);
963 // To speed up the whole process we cache the table relations
964 if ($cascade && count(self::$relation) == 0) {
965 self::buildRelationData();
968 // Is there a relation entry for the table?
969 if ($cascade && isset(self::$relation[$table])) {
970 // We only allow a simple "one field" relation.
971 $field = array_keys(self::$relation[$table])[0];
972 $rel_def = array_values(self::$relation[$table])[0];
974 // Create a key for preventing double queries
975 $qkey = $field . '-' . $table . ':' . implode(':', array_keys($conditions)) . ':' . implode(':', $conditions);
977 // When the search field is the relation field, we don't need to fetch the rows
978 // This is useful when the leading record is already deleted in the frontend but the rest is done in the backend
979 if ((count($conditions) == 1) && ($field == array_keys($conditions)[0])) {
980 foreach ($rel_def AS $rel_table => $rel_fields) {
981 foreach ($rel_fields AS $rel_field) {
982 $retval = self::delete($rel_table, [$rel_field => array_values($conditions)[0]], $options, true, $callstack);
983 $commands = array_merge($commands, $retval);
986 // We quit when this key already exists in the callstack.
987 } elseif (!isset($callstack[$qkey])) {
989 $callstack[$qkey] = true;
991 // Fetch all rows that are to be deleted
992 $data = self::select($table, [$field], $conditions);
994 while ($row = self::fetch($data)) {
995 // Now we accumulate the delete commands
996 $retval = self::delete($table, [$field => $row[$field]], $options, true, $callstack);
997 $commands = array_merge($commands, $retval);
1002 // Since we had split the delete command we don't need the original command anymore
1003 unset($commands[$key]);
1008 // Now we finalize the process
1009 $do_transaction = !self::$in_transaction;
1011 if ($do_transaction) {
1012 self::transaction();
1018 foreach ($commands AS $command) {
1019 $conditions = $command['conditions'];
1021 $first_key = key($conditions);
1023 $condition_string = self::buildCondition($conditions);
1025 if ((count($command['conditions']) > 1) || is_int($first_key)) {
1026 $sql = "DELETE FROM `" . $command['table'] . "`" . $condition_string;
1027 logger(self::replaceParameters($sql, $conditions), LOGGER_DATA);
1029 if (!self::e($sql, $conditions)) {
1030 if ($do_transaction) {
1036 $key_table = $command['table'];
1037 $key_condition = array_keys($command['conditions'])[0];
1038 $value = array_values($command['conditions'])[0];
1040 // Split the SQL queries in chunks of 100 values
1041 // We do the $i stuff here to make the code better readable
1042 $i = $counter[$key_table][$key_condition];
1043 if (isset($compacted[$key_table][$key_condition][$i]) && count($compacted[$key_table][$key_condition][$i]) > 100) {
1047 $compacted[$key_table][$key_condition][$i][$value] = $value;
1048 $counter[$key_table][$key_condition] = $i;
1051 foreach ($compacted AS $table => $values) {
1052 foreach ($values AS $field => $field_value_list) {
1053 foreach ($field_value_list AS $field_values) {
1054 $sql = "DELETE FROM `" . $table . "` WHERE `" . $field . "` IN (" .
1055 substr(str_repeat("?, ", count($field_values)), 0, -2) . ");";
1057 logger(self::replaceParameters($sql, $field_values), LOGGER_DATA);
1059 if (!self::e($sql, $field_values)) {
1060 if ($do_transaction) {
1068 if ($do_transaction) {
1078 * @brief Updates rows
1080 * Updates rows in the database. When $old_fields is set to an array,
1081 * the system will only do an update if the fields in that array changed.
1084 * Only the values in $old_fields are compared.
1085 * This is an intentional behaviour.
1088 * We include the timestamp field in $fields but not in $old_fields.
1089 * Then the row will only get the new timestamp when the other fields had changed.
1091 * When $old_fields is set to a boolean value the system will do this compare itself.
1092 * When $old_fields is set to "true" the system will do an insert if the row doesn't exists.
1095 * Only set $old_fields to a boolean value when you are sure that you will update a single row.
1096 * When you set $old_fields to "true" then $fields must contain all relevant fields!
1098 * @param string $table Table name
1099 * @param array $fields contains the fields that are updated
1100 * @param array $condition condition array with the key values
1101 * @param array|boolean $old_fields array with the old field values that are about to be replaced (true = update on duplicate)
1103 * @return boolean was the update successfull?
1105 public static function update($table, $fields, $condition, $old_fields = []) {
1107 if (empty($table) || empty($fields) || empty($condition)) {
1108 logger('Table, fields and condition have to be set');
1112 $table = self::escape($table);
1114 $condition_string = self::buildCondition($condition);
1116 if (is_bool($old_fields)) {
1117 $do_insert = $old_fields;
1119 $old_fields = self::selectFirst($table, [], $condition);
1121 if (is_bool($old_fields)) {
1123 $values = array_merge($condition, $fields);
1124 return self::insert($table, $values, $do_insert);
1130 $do_update = (count($old_fields) == 0);
1132 foreach ($old_fields AS $fieldname => $content) {
1133 if (isset($fields[$fieldname])) {
1134 if ($fields[$fieldname] == $content) {
1135 unset($fields[$fieldname]);
1142 if (!$do_update || (count($fields) == 0)) {
1146 $sql = "UPDATE `".$table."` SET `".
1147 implode("` = ?, `", array_keys($fields))."` = ?".$condition_string;
1149 $params1 = array_values($fields);
1150 $params2 = array_values($condition);
1151 $params = array_merge_recursive($params1, $params2);
1153 return self::e($sql, $params);
1157 * Retrieve a single record from a table and returns it in an associative array
1159 * @brief Retrieve a single record from a table
1160 * @param string $table
1161 * @param array $fields
1162 * @param array $condition
1163 * @param array $params
1164 * @return bool|array
1167 public static function selectFirst($table, array $fields = [], array $condition = [], $params = [])
1169 $params['limit'] = 1;
1170 $result = self::select($table, $fields, $condition, $params);
1172 if (is_bool($result)) {
1175 $row = self::fetch($result);
1176 self::close($result);
1182 * @brief Select rows from a table
1184 * @param string $table Table name
1185 * @param array $fields Array of selected fields, empty for all
1186 * @param array $condition Array of fields for condition
1187 * @param array $params Array of several parameters
1189 * @return boolean|object
1193 * $fields = array("id", "uri", "uid", "network");
1195 * $condition = array("uid" => 1, "network" => 'dspr');
1197 * $condition = array("`uid` = ? AND `network` IN (?, ?)", 1, 'dfrn', 'dspr');
1199 * $params = array("order" => array("id", "received" => true), "limit" => 10);
1201 * $data = dba::select($table, $fields, $condition, $params);
1203 public static function select($table, array $fields = [], array $condition = [], array $params = [])
1209 $table = self::escape($table);
1211 if (count($fields) > 0) {
1212 $select_fields = "`" . implode("`, `", array_values($fields)) . "`";
1214 $select_fields = "*";
1217 $condition_string = self::buildCondition($condition);
1219 $param_string = self::buildParameter($params);
1221 $sql = "SELECT " . $select_fields . " FROM `" . $table . "`" . $condition_string . $param_string;
1223 $result = self::p($sql, $condition);
1229 * @brief Counts the rows from a table satisfying the provided condition
1231 * @param string $table Table name
1232 * @param array $condition array of fields for condition
1239 * $condition = ["uid" => 1, "network" => 'dspr'];
1241 * $condition = ["`uid` = ? AND `network` IN (?, ?)", 1, 'dfrn', 'dspr'];
1243 * $count = dba::count($table, $condition);
1245 public static function count($table, array $condition = [])
1251 $condition_string = self::buildCondition($condition);
1253 $sql = "SELECT COUNT(*) AS `count` FROM `".$table."`".$condition_string;
1255 $row = self::fetch_first($sql, $condition);
1257 return $row['count'];
1261 * @brief Returns the SQL condition string built from the provided condition array
1263 * This function operates with two modes.
1264 * - Supplied with a filed/value associative array, it builds simple strict
1265 * equality conditions linked by AND.
1266 * - Supplied with a flat list, the first element is the condition string and
1267 * the following arguments are the values to be interpolated
1269 * $condition = ["uid" => 1, "network" => 'dspr'];
1271 * $condition = ["`uid` = ? AND `network` IN (?, ?)", 1, 'dfrn', 'dspr'];
1273 * In either case, the provided array is left with the parameters only
1275 * @param array $condition
1278 public static function buildCondition(array &$condition = [])
1280 $condition_string = '';
1281 if (count($condition) > 0) {
1283 $first_key = key($condition);
1284 if (is_int($first_key)) {
1285 $condition_string = " WHERE (" . array_shift($condition) . ")";
1288 $condition_string = "";
1289 foreach ($condition as $field => $value) {
1290 if ($condition_string != "") {
1291 $condition_string .= " AND ";
1293 if (is_array($value)) {
1294 $new_values = array_merge($new_values, array_values($value));
1295 $placeholders = substr(str_repeat("?, ", count($value)), 0, -2);
1296 $condition_string .= "`" . $field . "` IN (" . $placeholders . ")";
1298 $new_values[$field] = $value;
1299 $condition_string .= "`" . $field . "` = ?";
1302 $condition_string = " WHERE (" . $condition_string . ")";
1303 $condition = $new_values;
1307 return $condition_string;
1311 * @brief Returns the SQL parameter string built from the provided parameter array
1313 * @param array $params
1316 public static function buildParameter(array $params = [])
1319 if (isset($params['order'])) {
1320 $order_string = " ORDER BY ";
1321 foreach ($params['order'] AS $fields => $order) {
1322 if (!is_int($fields)) {
1323 $order_string .= "`" . $fields . "` " . ($order ? "DESC" : "ASC") . ", ";
1325 $order_string .= "`" . $order . "`, ";
1328 $order_string = substr($order_string, 0, -2);
1332 if (isset($params['limit']) && is_int($params['limit'])) {
1333 $limit_string = " LIMIT " . $params['limit'];
1336 if (isset($params['limit']) && is_array($params['limit'])) {
1337 $limit_string = " LIMIT " . intval($params['limit'][0]) . ", " . intval($params['limit'][1]);
1340 return $order_string.$limit_string;
1344 * @brief Fills an array with data from a query
1346 * @param object $stmt statement object
1347 * @return array Data array
1349 public static function inArray($stmt, $do_close = true) {
1350 if (is_bool($stmt)) {
1355 while ($row = self::fetch($stmt)) {
1365 * @brief Returns the error number of the last query
1367 * @return string Error number (0 if no error)
1369 public static function errorNo() {
1370 return self::$errorno;
1374 * @brief Returns the error message of the last query
1376 * @return string Error message ('' if no error)
1378 public static function errorMessage() {
1379 return self::$error;
1383 * @brief Closes the current statement
1385 * @param object $stmt statement object
1386 * @return boolean was the close successful?
1388 public static function close($stmt) {
1391 $stamp1 = microtime(true);
1393 if (!is_object($stmt)) {
1397 switch (self::$driver) {
1399 $ret = $stmt->closeCursor();
1402 $stmt->free_result();
1403 $ret = $stmt->close();
1407 $a->save_timestamp($stamp1, 'database');
1413 function dbesc($str) {
1414 if (dba::$connected) {
1415 return(dba::escape($str));
1417 return(str_replace("'","\\'",$str));
1422 * @brief execute SQL query with printf style args - deprecated
1424 * Please use the dba:: functions instead:
1425 * dba::select, dba::exists, dba::insert
1426 * dba::delete, dba::update, dba::p, dba::e
1428 * @param $args Query parameters (1 to N parameters of different types)
1429 * @return array|bool Query array
1432 $args = func_get_args();
1435 if (!dba::$connected) {
1439 $sql = dba::clean_query($sql);
1440 $sql = dba::any_value_fallback($sql);
1442 $stmt = @vsprintf($sql, $args);
1444 $ret = dba::p($stmt);
1446 if (is_bool($ret)) {
1450 $columns = dba::columnCount($ret);
1452 $data = dba::inArray($ret);
1454 if ((count($data) == 0) && ($columns == 0)) {
1461 function dba_timer() {
1462 return microtime(true);