3 use Friendica\Core\Config;
4 use Friendica\Core\System;
5 use Friendica\Database\DBM;
6 use Friendica\Database\DBStructure;
7 use Friendica\Util\DateTimeFormat;
10 * @class MySQL database class
12 * This class is for the low level database stuff that does driver specific things.
16 public static $connected = false;
18 private static $_server_info = '';
20 private static $driver;
21 private static $error = false;
22 private static $errorno = 0;
23 private static $affected_rows = 0;
24 private static $in_transaction = false;
25 private static $in_retrial = false;
26 private static $relation = [];
27 private static $db_serveraddr = '';
28 private static $db_user = '';
29 private static $db_pass = '';
30 private static $db_name = '';
31 private static $db_charset = '';
33 public static function connect($serveraddr, $user, $pass, $db, $charset = null)
35 if (!is_null(self::$db) && self::connected()) {
39 // We are storing these values for being able to perform a reconnect
40 self::$db_serveraddr = $serveraddr;
41 self::$db_user = $user;
42 self::$db_pass = $pass;
44 self::$db_charset = $charset;
46 $serveraddr = trim($serveraddr);
48 $serverdata = explode(':', $serveraddr);
49 $server = $serverdata[0];
51 if (count($serverdata) > 1) {
52 $port = trim($serverdata[1]);
55 $server = trim($server);
59 $charset = trim($charset);
61 if (!(strlen($server) && strlen($user))) {
65 if (class_exists('\PDO') && in_array('mysql', PDO::getAvailableDrivers())) {
66 self::$driver = 'pdo';
67 $connect = "mysql:host=".$server.";dbname=".$db;
70 $connect .= ";port=".$port;
74 $connect .= ";charset=".$charset;
78 self::$db = @new PDO($connect, $user, $pass);
79 self::$db->setAttribute(PDO::ATTR_EMULATE_PREPARES, false);
80 self::$connected = true;
81 } catch (PDOException $e) {
85 if (!self::$connected && class_exists('mysqli')) {
86 self::$driver = 'mysqli';
87 self::$db = @new mysqli($server, $user, $pass, $db, $port);
88 if (!mysqli_connect_errno()) {
89 self::$connected = true;
92 self::$db->set_charset($charset);
97 // No suitable SQL driver was found.
98 if (!self::$connected) {
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, self::$db_charset);
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(Config::get('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(',', Config::get('system', 'db_log_index_watch'));
206 $blacklist = explode(',', Config::get('system', 'db_log_index_blacklist'));
208 while ($row = dba::fetch($r)) {
209 if ((intval(Config::get('system', 'db_loglimit_index')) > 0)) {
210 $log = (in_array($row['key'], $watchlist) &&
211 ($row['rows'] >= intval(Config::get('system', 'db_loglimit_index'))));
216 if ((intval(Config::get('system', 'db_loglimit_index_high')) > 0) && ($row['rows'] >= intval(Config::get('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(Config::get('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 or result 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 (Config::get('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 if (is_int($args[$param])) {
431 $data_type = PDO::PARAM_INT;
433 $data_type = PDO::PARAM_STR;
435 $stmt->bindParam($param, $args[$param], $data_type);
438 if (!$stmt->execute()) {
439 $errorInfo = $stmt->errorInfo();
440 self::$error = $errorInfo[2];
441 self::$errorno = $errorInfo[1];
445 self::$affected_rows = $retval->rowCount();
449 // There are SQL statements that cannot be executed with a prepared statement
450 $parts = explode(' ', $orig_sql);
451 $command = strtolower($parts[0]);
452 $can_be_prepared = in_array($command, ['select', 'update', 'insert', 'delete']);
454 // The fallback routine is called as well when there are no arguments
455 if (!$can_be_prepared || (count($args) == 0)) {
456 $retval = self::$db->query(self::replaceParameters($sql, $args));
457 if (self::$db->errno) {
458 self::$error = self::$db->error;
459 self::$errorno = self::$db->errno;
462 if (isset($retval->num_rows)) {
463 self::$affected_rows = $retval->num_rows;
465 self::$affected_rows = self::$db->affected_rows;
471 $stmt = self::$db->stmt_init();
473 if (!$stmt->prepare($sql)) {
474 self::$error = $stmt->error;
475 self::$errorno = $stmt->errno;
482 foreach ($args AS $param => $value) {
483 if (is_int($args[$param])) {
485 } elseif (is_float($args[$param])) {
487 } elseif (is_string($args[$param])) {
492 $values[] = &$args[$param];
495 if (count($values) > 0) {
496 array_unshift($values, $param_types);
497 call_user_func_array([$stmt, 'bind_param'], $values);
500 if (!$stmt->execute()) {
501 self::$error = self::$db->error;
502 self::$errorno = self::$db->errno;
505 $stmt->store_result();
507 self::$affected_rows = $retval->affected_rows;
512 // We are having an own error logging in the function "e"
513 if ((self::$errorno != 0) && !$called_from_e) {
514 // We have to preserve the error code, somewhere in the logging it get lost
515 $error = self::$error;
516 $errorno = self::$errorno;
518 logger('DB Error '.self::$errorno.': '.self::$error."\n".
519 System::callstack(8)."\n".self::replaceParameters($sql, $args));
521 // On a lost connection we try to reconnect - but only once.
522 if ($errorno == 2006) {
523 if (self::$in_retrial || !self::reconnect()) {
524 // It doesn't make sense to continue when the database connection was lost
525 if (self::$in_retrial) {
526 logger('Giving up retrial because of database error '.$errorno.': '.$error);
528 logger("Couldn't reconnect after database error ".$errorno.': '.$error);
533 logger('Reconnected after database error '.$errorno.': '.$error);
534 self::$in_retrial = true;
535 $ret = self::p($sql, $args);
536 self::$in_retrial = false;
541 self::$error = $error;
542 self::$errorno = $errorno;
545 $a->save_timestamp($stamp1, 'database');
547 if (Config::get('system', 'db_log')) {
548 $stamp2 = microtime(true);
549 $duration = (float)($stamp2 - $stamp1);
551 if (($duration > Config::get('system', 'db_loglimit'))) {
552 $duration = round($duration, 3);
553 $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
555 @file_put_contents(Config::get('system', 'db_log'), DateTimeFormat::utcNow()."\t".$duration."\t".
556 basename($backtrace[1]["file"])."\t".
557 $backtrace[1]["line"]."\t".$backtrace[2]["function"]."\t".
558 substr(self::replaceParameters($sql, $args), 0, 2000)."\n", FILE_APPEND);
565 * @brief Executes a prepared statement like UPDATE or INSERT that doesn't return data
567 * Please use dba::delete, dba::insert, dba::update, ... instead
569 * @param string $sql SQL statement
570 * @return boolean Was the query successfull? False is returned only if an error occurred
572 public static function e($sql) {
575 $stamp = microtime(true);
577 $params = self::getParam(func_get_args());
579 // In a case of a deadlock we are repeating the query 20 times
583 $stmt = self::p($sql, $params);
585 if (is_bool($stmt)) {
587 } elseif (is_object($stmt)) {
595 } while ((self::$errorno == 1213) && (--$timeout > 0));
597 if (self::$errorno != 0) {
598 // We have to preserve the error code, somewhere in the logging it get lost
599 $error = self::$error;
600 $errorno = self::$errorno;
602 logger('DB Error '.self::$errorno.': '.self::$error."\n".
603 System::callstack(8)."\n".self::replaceParameters($sql, $params));
605 // On a lost connection we simply quit.
606 // A reconnect like in self::p could be dangerous with modifications
607 if ($errorno == 2006) {
608 logger('Giving up because of database error '.$errorno.': '.$error);
612 self::$error = $error;
613 self::$errorno = $errorno;
616 $a->save_timestamp($stamp, "database_write");
622 * @brief Check if data exists
624 * @param string $table Table name
625 * @param array $condition array of fields for condition
627 * @return boolean Are there rows for that condition?
629 public static function exists($table, $condition) {
637 $first_key = key($condition);
638 if (!is_int($first_key)) {
639 $fields = [$first_key];
642 $stmt = self::select($table, $fields, $condition, ['limit' => 1]);
644 if (is_bool($stmt)) {
647 $retval = (self::num_rows($stmt) > 0);
656 * Fetches the first row
658 * Please use dba::selectFirst or dba::exists whenever this is possible.
660 * @brief Fetches the first row
661 * @param string $sql SQL statement
662 * @return array first row of query
664 public static function fetch_first($sql) {
665 $params = self::getParam(func_get_args());
667 $stmt = self::p($sql, $params);
669 if (is_bool($stmt)) {
672 $retval = self::fetch($stmt);
681 * @brief Returns the number of affected rows of the last statement
683 * @return int Number of rows
685 public static function affected_rows() {
686 return self::$affected_rows;
690 * @brief Returns the number of columns of a statement
692 * @param object Statement object
693 * @return int Number of columns
695 public static function columnCount($stmt) {
696 if (!is_object($stmt)) {
699 switch (self::$driver) {
701 return $stmt->columnCount();
703 return $stmt->field_count;
708 * @brief Returns the number of rows of a statement
710 * @param PDOStatement|mysqli_result|mysqli_stmt Statement object
711 * @return int Number of rows
713 public static function num_rows($stmt) {
714 if (!is_object($stmt)) {
717 switch (self::$driver) {
719 return $stmt->rowCount();
721 return $stmt->num_rows;
727 * @brief Fetch a single row
729 * @param mixed $stmt statement object
730 * @return array current row
732 public static function fetch($stmt) {
735 $stamp1 = microtime(true);
739 if (!is_object($stmt)) {
743 switch (self::$driver) {
745 $columns = $stmt->fetch(PDO::FETCH_ASSOC);
748 if (get_class($stmt) == 'mysqli_result') {
749 $columns = $stmt->fetch_assoc();
753 // This code works, but is slow
755 // Bind the result to a result array
759 for ($x = 0; $x < $stmt->field_count; $x++) {
760 $cols[] = &$cols_num[$x];
763 call_user_func_array([$stmt, 'bind_result'], $cols);
765 if (!$stmt->fetch()) {
770 // We need to get the field names for the array keys
771 // It seems that there is no better way to do this.
772 $result = $stmt->result_metadata();
773 $fields = $result->fetch_fields();
775 foreach ($cols_num AS $param => $col) {
776 $columns[$fields[$param]->name] = $col;
780 $a->save_timestamp($stamp1, 'database');
786 * @brief Insert a row into a table
788 * @param string $table Table name
789 * @param array $param parameter array
790 * @param bool $on_duplicate_update Do an update on a duplicate entry
792 * @return boolean was the insert successfull?
794 public static function insert($table, $param, $on_duplicate_update = false) {
796 if (empty($table) || empty($param)) {
797 logger('Table and fields have to be set');
801 $sql = "INSERT INTO `".self::escape($table)."` (`".implode("`, `", array_keys($param))."`) VALUES (".
802 substr(str_repeat("?, ", count($param)), 0, -2).")";
804 if ($on_duplicate_update) {
805 $sql .= " ON DUPLICATE KEY UPDATE `".implode("` = ?, `", array_keys($param))."` = ?";
807 $values = array_values($param);
808 $param = array_merge_recursive($values, $values);
811 return self::e($sql, $param);
815 * @brief Fetch the id of the last insert command
817 * @return integer Last inserted id
819 public static function lastInsertId() {
820 switch (self::$driver) {
822 $id = self::$db->lastInsertId();
825 $id = self::$db->insert_id;
832 * @brief Locks a table for exclusive write access
834 * This function can be extended in the future to accept a table array as well.
836 * @param string $table Table name
838 * @return boolean was the lock successful?
840 public static function lock($table) {
841 // See here: https://dev.mysql.com/doc/refman/5.7/en/lock-tables-and-transactions.html
842 if (self::$driver == 'pdo') {
843 self::e("SET autocommit=0");
844 self::$db->setAttribute(PDO::ATTR_EMULATE_PREPARES, true);
846 self::$db->autocommit(false);
849 $success = self::e("LOCK TABLES `".self::escape($table)."` WRITE");
851 if (self::$driver == 'pdo') {
852 self::$db->setAttribute(PDO::ATTR_EMULATE_PREPARES, false);
856 if (self::$driver == 'pdo') {
857 self::e("SET autocommit=1");
859 self::$db->autocommit(true);
862 self::$in_transaction = true;
868 * @brief Unlocks all locked tables
870 * @return boolean was the unlock successful?
872 public static function unlock() {
873 // See here: https://dev.mysql.com/doc/refman/5.7/en/lock-tables-and-transactions.html
874 self::performCommit();
876 if (self::$driver == 'pdo') {
877 self::$db->setAttribute(PDO::ATTR_EMULATE_PREPARES, true);
880 $success = self::e("UNLOCK TABLES");
882 if (self::$driver == 'pdo') {
883 self::$db->setAttribute(PDO::ATTR_EMULATE_PREPARES, false);
884 self::e("SET autocommit=1");
886 self::$db->autocommit(true);
889 self::$in_transaction = false;
894 * @brief Starts a transaction
896 * @return boolean Was the command executed successfully?
898 public static function transaction() {
899 if (!self::performCommit()) {
903 switch (self::$driver) {
905 if (self::$db->inTransaction()) {
908 if (!self::$db->beginTransaction()) {
913 if (!self::$db->begin_transaction()) {
919 self::$in_transaction = true;
923 private static function performCommit()
925 switch (self::$driver) {
927 if (!self::$db->inTransaction()) {
930 return self::$db->commit();
932 return self::$db->commit();
938 * @brief Does a commit
940 * @return boolean Was the command executed successfully?
942 public static function commit() {
943 if (!self::performCommit()) {
946 self::$in_transaction = false;
951 * @brief Does a rollback
953 * @return boolean Was the command executed successfully?
955 public static function rollback() {
958 switch (self::$driver) {
960 if (!self::$db->inTransaction()) {
964 $ret = self::$db->rollBack();
967 $ret = self::$db->rollback();
970 self::$in_transaction = false;
975 * @brief Build the array with the table relations
977 * The array is build from the database definitions in DBStructure.php
979 * This process must only be started once, since the value is cached.
981 private static function buildRelationData() {
982 $definition = DBStructure::definition();
984 foreach ($definition AS $table => $structure) {
985 foreach ($structure['fields'] AS $field => $field_struct) {
986 if (isset($field_struct['relation'])) {
987 foreach ($field_struct['relation'] AS $rel_table => $rel_field) {
988 self::$relation[$rel_table][$rel_field][$table][] = $field;
996 * @brief Delete a row from a table
998 * @param string $table Table name
999 * @param array $conditions Field condition(s)
1000 * @param array $options
1001 * - cascade: If true we delete records in other tables that depend on the one we're deleting through
1002 * relations (default: true)
1003 * @param boolean $in_process Internal use: Only do a commit after the last delete
1004 * @param array $callstack Internal use: prevent endless loops
1006 * @return boolean|array was the delete successful? When $in_process is set: deletion data
1008 public static function delete($table, array $conditions, array $options = [], $in_process = false, array &$callstack = [])
1010 if (empty($table) || empty($conditions)) {
1011 logger('Table and conditions have to be set');
1017 // Create a key for the loop prevention
1018 $key = $table . ':' . json_encode($conditions);
1020 // We quit when this key already exists in the callstack.
1021 if (isset($callstack[$key])) {
1025 $callstack[$key] = true;
1027 $table = self::escape($table);
1029 $commands[$key] = ['table' => $table, 'conditions' => $conditions];
1031 $cascade = defaults($options, 'cascade', true);
1033 // To speed up the whole process we cache the table relations
1034 if ($cascade && count(self::$relation) == 0) {
1035 self::buildRelationData();
1038 // Is there a relation entry for the table?
1039 if ($cascade && isset(self::$relation[$table])) {
1040 // We only allow a simple "one field" relation.
1041 $field = array_keys(self::$relation[$table])[0];
1042 $rel_def = array_values(self::$relation[$table])[0];
1044 // Create a key for preventing double queries
1045 $qkey = $field . '-' . $table . ':' . json_encode($conditions);
1047 // When the search field is the relation field, we don't need to fetch the rows
1048 // This is useful when the leading record is already deleted in the frontend but the rest is done in the backend
1049 if ((count($conditions) == 1) && ($field == array_keys($conditions)[0])) {
1050 foreach ($rel_def AS $rel_table => $rel_fields) {
1051 foreach ($rel_fields AS $rel_field) {
1052 $retval = self::delete($rel_table, [$rel_field => array_values($conditions)[0]], $options, true, $callstack);
1053 $commands = array_merge($commands, $retval);
1056 // We quit when this key already exists in the callstack.
1057 } elseif (!isset($callstack[$qkey])) {
1059 $callstack[$qkey] = true;
1061 // Fetch all rows that are to be deleted
1062 $data = self::select($table, [$field], $conditions);
1064 while ($row = self::fetch($data)) {
1065 // Now we accumulate the delete commands
1066 $retval = self::delete($table, [$field => $row[$field]], $options, true, $callstack);
1067 $commands = array_merge($commands, $retval);
1072 // Since we had split the delete command we don't need the original command anymore
1073 unset($commands[$key]);
1078 // Now we finalize the process
1079 $do_transaction = !self::$in_transaction;
1081 if ($do_transaction) {
1082 self::transaction();
1088 foreach ($commands AS $command) {
1089 $conditions = $command['conditions'];
1091 $first_key = key($conditions);
1093 $condition_string = self::buildCondition($conditions);
1095 if ((count($command['conditions']) > 1) || is_int($first_key)) {
1096 $sql = "DELETE FROM `" . $command['table'] . "`" . $condition_string;
1097 logger(self::replaceParameters($sql, $conditions), LOGGER_DATA);
1099 if (!self::e($sql, $conditions)) {
1100 if ($do_transaction) {
1106 $key_table = $command['table'];
1107 $key_condition = array_keys($command['conditions'])[0];
1108 $value = array_values($command['conditions'])[0];
1110 // Split the SQL queries in chunks of 100 values
1111 // We do the $i stuff here to make the code better readable
1112 $i = isset($counter[$key_table][$key_condition]) ? $counter[$key_table][$key_condition] : 0;
1113 if (isset($compacted[$key_table][$key_condition][$i]) && count($compacted[$key_table][$key_condition][$i]) > 100) {
1117 $compacted[$key_table][$key_condition][$i][$value] = $value;
1118 $counter[$key_table][$key_condition] = $i;
1121 foreach ($compacted AS $table => $values) {
1122 foreach ($values AS $field => $field_value_list) {
1123 foreach ($field_value_list AS $field_values) {
1124 $sql = "DELETE FROM `" . $table . "` WHERE `" . $field . "` IN (" .
1125 substr(str_repeat("?, ", count($field_values)), 0, -2) . ");";
1127 logger(self::replaceParameters($sql, $field_values), LOGGER_DATA);
1129 if (!self::e($sql, $field_values)) {
1130 if ($do_transaction) {
1138 if ($do_transaction) {
1148 * @brief Updates rows
1150 * Updates rows in the database. When $old_fields is set to an array,
1151 * the system will only do an update if the fields in that array changed.
1154 * Only the values in $old_fields are compared.
1155 * This is an intentional behaviour.
1158 * We include the timestamp field in $fields but not in $old_fields.
1159 * Then the row will only get the new timestamp when the other fields had changed.
1161 * When $old_fields is set to a boolean value the system will do this compare itself.
1162 * When $old_fields is set to "true" the system will do an insert if the row doesn't exists.
1165 * Only set $old_fields to a boolean value when you are sure that you will update a single row.
1166 * When you set $old_fields to "true" then $fields must contain all relevant fields!
1168 * @param string $table Table name
1169 * @param array $fields contains the fields that are updated
1170 * @param array $condition condition array with the key values
1171 * @param array|boolean $old_fields array with the old field values that are about to be replaced (true = update on duplicate)
1173 * @return boolean was the update successfull?
1175 public static function update($table, $fields, $condition, $old_fields = []) {
1177 if (empty($table) || empty($fields) || empty($condition)) {
1178 logger('Table, fields and condition have to be set');
1182 $table = self::escape($table);
1184 $condition_string = self::buildCondition($condition);
1186 if (is_bool($old_fields)) {
1187 $do_insert = $old_fields;
1189 $old_fields = self::selectFirst($table, [], $condition);
1191 if (is_bool($old_fields)) {
1193 $values = array_merge($condition, $fields);
1194 return self::insert($table, $values, $do_insert);
1200 $do_update = (count($old_fields) == 0);
1202 foreach ($old_fields AS $fieldname => $content) {
1203 if (isset($fields[$fieldname])) {
1204 if ($fields[$fieldname] == $content) {
1205 unset($fields[$fieldname]);
1212 if (!$do_update || (count($fields) == 0)) {
1216 $sql = "UPDATE `".$table."` SET `".
1217 implode("` = ?, `", array_keys($fields))."` = ?".$condition_string;
1219 $params1 = array_values($fields);
1220 $params2 = array_values($condition);
1221 $params = array_merge_recursive($params1, $params2);
1223 return self::e($sql, $params);
1227 * Retrieve a single record from a table and returns it in an associative array
1229 * @brief Retrieve a single record from a table
1230 * @param string $table
1231 * @param array $fields
1232 * @param array $condition
1233 * @param array $params
1234 * @return bool|array
1237 public static function selectFirst($table, array $fields = [], array $condition = [], $params = [])
1239 $params['limit'] = 1;
1240 $result = self::select($table, $fields, $condition, $params);
1242 if (is_bool($result)) {
1245 $row = self::fetch($result);
1246 self::close($result);
1252 * @brief Select rows from a table
1254 * @param string $table Table name
1255 * @param array $fields Array of selected fields, empty for all
1256 * @param array $condition Array of fields for condition
1257 * @param array $params Array of several parameters
1259 * @return boolean|object
1263 * $fields = array("id", "uri", "uid", "network");
1265 * $condition = array("uid" => 1, "network" => 'dspr');
1267 * $condition = array("`uid` = ? AND `network` IN (?, ?)", 1, 'dfrn', 'dspr');
1269 * $params = array("order" => array("id", "received" => true), "limit" => 10);
1271 * $data = dba::select($table, $fields, $condition, $params);
1273 public static function select($table, array $fields = [], array $condition = [], array $params = [])
1279 $table = self::escape($table);
1281 if (count($fields) > 0) {
1282 $select_fields = "`" . implode("`, `", array_values($fields)) . "`";
1284 $select_fields = "*";
1287 $condition_string = self::buildCondition($condition);
1289 $param_string = self::buildParameter($params);
1291 $sql = "SELECT " . $select_fields . " FROM `" . $table . "`" . $condition_string . $param_string;
1293 $result = self::p($sql, $condition);
1299 * @brief Counts the rows from a table satisfying the provided condition
1301 * @param string $table Table name
1302 * @param array $condition array of fields for condition
1309 * $condition = ["uid" => 1, "network" => 'dspr'];
1311 * $condition = ["`uid` = ? AND `network` IN (?, ?)", 1, 'dfrn', 'dspr'];
1313 * $count = dba::count($table, $condition);
1315 public static function count($table, array $condition = [])
1321 $condition_string = self::buildCondition($condition);
1323 $sql = "SELECT COUNT(*) AS `count` FROM `".$table."`".$condition_string;
1325 $row = self::fetch_first($sql, $condition);
1327 return $row['count'];
1331 * @brief Returns the SQL condition string built from the provided condition array
1333 * This function operates with two modes.
1334 * - Supplied with a filed/value associative array, it builds simple strict
1335 * equality conditions linked by AND.
1336 * - Supplied with a flat list, the first element is the condition string and
1337 * the following arguments are the values to be interpolated
1339 * $condition = ["uid" => 1, "network" => 'dspr'];
1341 * $condition = ["`uid` = ? AND `network` IN (?, ?)", 1, 'dfrn', 'dspr'];
1343 * In either case, the provided array is left with the parameters only
1345 * @param array $condition
1348 public static function buildCondition(array &$condition = [])
1350 $condition_string = '';
1351 if (count($condition) > 0) {
1353 $first_key = key($condition);
1354 if (is_int($first_key)) {
1355 $condition_string = " WHERE (" . array_shift($condition) . ")";
1358 $condition_string = "";
1359 foreach ($condition as $field => $value) {
1360 if ($condition_string != "") {
1361 $condition_string .= " AND ";
1363 if (is_array($value)) {
1364 /* Workaround for MySQL Bug #64791.
1365 * Never mix data types inside any IN() condition.
1366 * In case of mixed types, cast all as string.
1367 * Logic needs to be consistent with dba::p() data types.
1371 foreach ($value as $single_value) {
1372 if (is_int($single_value)) {
1379 if ($is_int && $is_alpha) {
1380 foreach ($value as &$ref) {
1382 $ref = (string)$ref;
1385 unset($ref); //Prevent accidental re-use.
1388 $new_values = array_merge($new_values, array_values($value));
1389 $placeholders = substr(str_repeat("?, ", count($value)), 0, -2);
1390 $condition_string .= "`" . $field . "` IN (" . $placeholders . ")";
1392 $new_values[$field] = $value;
1393 $condition_string .= "`" . $field . "` = ?";
1396 $condition_string = " WHERE (" . $condition_string . ")";
1397 $condition = $new_values;
1401 return $condition_string;
1405 * @brief Returns the SQL parameter string built from the provided parameter array
1407 * @param array $params
1410 public static function buildParameter(array $params = [])
1413 if (isset($params['order'])) {
1414 $order_string = " ORDER BY ";
1415 foreach ($params['order'] AS $fields => $order) {
1416 if (!is_int($fields)) {
1417 $order_string .= "`" . $fields . "` " . ($order ? "DESC" : "ASC") . ", ";
1419 $order_string .= "`" . $order . "`, ";
1422 $order_string = substr($order_string, 0, -2);
1426 if (isset($params['limit']) && is_int($params['limit'])) {
1427 $limit_string = " LIMIT " . $params['limit'];
1430 if (isset($params['limit']) && is_array($params['limit'])) {
1431 $limit_string = " LIMIT " . intval($params['limit'][0]) . ", " . intval($params['limit'][1]);
1434 return $order_string.$limit_string;
1438 * @brief Fills an array with data from a query
1440 * @param object $stmt statement object
1441 * @return array Data array
1443 public static function inArray($stmt, $do_close = true) {
1444 if (is_bool($stmt)) {
1449 while ($row = self::fetch($stmt)) {
1459 * @brief Returns the error number of the last query
1461 * @return string Error number (0 if no error)
1463 public static function errorNo() {
1464 return self::$errorno;
1468 * @brief Returns the error message of the last query
1470 * @return string Error message ('' if no error)
1472 public static function errorMessage() {
1473 return self::$error;
1477 * @brief Closes the current statement
1479 * @param object $stmt statement object
1480 * @return boolean was the close successful?
1482 public static function close($stmt) {
1485 $stamp1 = microtime(true);
1487 if (!is_object($stmt)) {
1491 switch (self::$driver) {
1493 $ret = $stmt->closeCursor();
1496 // MySQLi offers both a mysqli_stmt and a mysqli_result class.
1497 // We should be careful not to assume the object type of $stmt
1498 // because dba::p() has been able to return both types.
1499 if ($stmt instanceof mysqli_stmt) {
1500 $stmt->free_result();
1501 $ret = $stmt->close();
1502 } elseif ($stmt instanceof mysqli_result) {
1511 $a->save_timestamp($stamp1, 'database');
1517 function dbesc($str) {
1518 if (dba::$connected) {
1519 return(dba::escape($str));
1521 return(str_replace("'","\\'",$str));
1526 * @brief execute SQL query with printf style args - deprecated
1528 * Please use the dba:: functions instead:
1529 * dba::select, dba::exists, dba::insert
1530 * dba::delete, dba::update, dba::p, dba::e
1532 * @param $args Query parameters (1 to N parameters of different types)
1533 * @return array|bool Query array
1536 $args = func_get_args();
1539 if (!dba::$connected) {
1543 $sql = dba::clean_query($sql);
1544 $sql = dba::any_value_fallback($sql);
1546 $stmt = @vsprintf($sql, $args);
1548 $ret = dba::p($stmt);
1550 if (is_bool($ret)) {
1554 $columns = dba::columnCount($ret);
1556 $data = dba::inArray($ret);
1558 if ((count($data) == 0) && ($columns == 0)) {
1565 function dba_timer() {
1566 return microtime(true);