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 $relation = [];
28 public static function connect($serveraddr, $user, $pass, $db) {
29 if (!is_null(self::$db)) {
35 $stamp1 = microtime(true);
37 $serveraddr = trim($serveraddr);
39 $serverdata = explode(':', $serveraddr);
40 $server = $serverdata[0];
42 if (count($serverdata) > 1) {
43 $port = trim($serverdata[1]);
46 $server = trim($server);
51 if (!(strlen($server) && strlen($user))) {
55 if ($a->mode == App::MODE_INSTALL) {
56 // server has to be a non-empty string that is not 'localhost' and not an IP
57 if (strlen($server) && ($server !== 'localhost') && filter_var($server, FILTER_VALIDATE_IP) === false) {
58 if (! dns_get_record($server, DNS_A + DNS_CNAME)) {
59 self::$error = L10n::t('Cannot locate DNS info for database server \'%s\'', $server);
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;
73 if (isset($a->config["system"]["db_charset"])) {
74 $connect .= ";charset=".$a->config["system"]["db_charset"];
77 self::$db = @new PDO($connect, $user, $pass);
78 self::$connected = true;
79 } catch (PDOException $e) {
83 if (!self::$connected && class_exists('mysqli')) {
84 self::$driver = 'mysqli';
85 self::$db = @new mysqli($server, $user, $pass, $db, $port);
86 if (!mysqli_connect_errno()) {
87 self::$connected = true;
89 if (isset($a->config["system"]["db_charset"])) {
90 self::$db->set_charset($a->config["system"]["db_charset"]);
95 // No suitable SQL driver was found.
96 if (!self::$connected) {
100 $a->save_timestamp($stamp1, "network");
102 return self::$connected;
106 * @brief Returns the MySQL server version string
108 * This function discriminate between the deprecated mysql API and the current
109 * object-oriented mysqli API. Example of returned string: 5.5.46-0+deb8u1
113 public static function server_info() {
114 if (self::$_server_info == '') {
115 switch (self::$driver) {
117 self::$_server_info = self::$db->getAttribute(PDO::ATTR_SERVER_VERSION);
120 self::$_server_info = self::$db->server_info;
124 return self::$_server_info;
128 * @brief Returns the selected database name
132 public static function database_name() {
133 $ret = self::p("SELECT DATABASE() AS `db`");
134 $data = self::inArray($ret);
135 return $data[0]['db'];
139 * @brief Analyze a database query and log this if some conditions are met.
141 * @param string $query The database query that will be analyzed
143 private static function logIndex($query) {
146 if (empty($a->config["system"]["db_log_index"])) {
150 // Don't explain an explain statement
151 if (strtolower(substr($query, 0, 7)) == "explain") {
155 // Only do the explain on "select", "update" and "delete"
156 if (!in_array(strtolower(substr($query, 0, 6)), ["select", "update", "delete"])) {
160 $r = self::p("EXPLAIN ".$query);
161 if (!DBM::is_result($r)) {
165 $watchlist = explode(',', $a->config["system"]["db_log_index_watch"]);
166 $blacklist = explode(',', $a->config["system"]["db_log_index_blacklist"]);
168 while ($row = dba::fetch($r)) {
169 if ((intval($a->config["system"]["db_loglimit_index"]) > 0)) {
170 $log = (in_array($row['key'], $watchlist) &&
171 ($row['rows'] >= intval($a->config["system"]["db_loglimit_index"])));
176 if ((intval($a->config["system"]["db_loglimit_index_high"]) > 0) && ($row['rows'] >= intval($a->config["system"]["db_loglimit_index_high"]))) {
180 if (in_array($row['key'], $blacklist) || ($row['key'] == "")) {
185 $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
186 @file_put_contents($a->config["system"]["db_log_index"], DateTimeFormat::utcNow()."\t".
187 $row['key']."\t".$row['rows']."\t".$row['Extra']."\t".
188 basename($backtrace[1]["file"])."\t".
189 $backtrace[1]["line"]."\t".$backtrace[2]["function"]."\t".
190 substr($query, 0, 2000)."\n", FILE_APPEND);
195 public static function escape($str) {
196 switch (self::$driver) {
198 return substr(@self::$db->quote($str, PDO::PARAM_STR), 1, -1);
200 return @self::$db->real_escape_string($str);
204 public static function connected() {
207 switch (self::$driver) {
209 $r = dba::p("SELECT 1");
210 if (DBM::is_result($r)) {
211 $row = dba::inArray($r);
212 $connected = ($row[0]['1'] == '1');
216 $connected = self::$db->ping();
223 * @brief Replaces ANY_VALUE() function by MIN() function,
224 * if the database server does not support ANY_VALUE().
226 * Considerations for Standard SQL, or MySQL with ONLY_FULL_GROUP_BY (default since 5.7.5).
227 * ANY_VALUE() is available from MySQL 5.7.5 https://dev.mysql.com/doc/refman/5.7/en/miscellaneous-functions.html
228 * A standard fall-back is to use MIN().
230 * @param string $sql An SQL string without the values
231 * @return string The input SQL string modified if necessary.
233 public static function any_value_fallback($sql) {
234 $server_info = self::server_info();
235 if (version_compare($server_info, '5.7.5', '<') ||
236 (stripos($server_info, 'MariaDB') !== false)) {
237 $sql = str_ireplace('ANY_VALUE(', 'MIN(', $sql);
243 * @brief beautifies the query - useful for "SHOW PROCESSLIST"
245 * This is safe when we bind the parameters later.
246 * The parameter values aren't part of the SQL.
248 * @param string $sql An SQL string without the values
249 * @return string The input SQL string modified if necessary.
251 public static function clean_query($sql) {
252 $search = ["\t", "\n", "\r", " "];
253 $replace = [' ', ' ', ' ', ' '];
256 $sql = str_replace($search, $replace, $sql);
257 } while ($oldsql != $sql);
264 * @brief Replaces the ? placeholders with the parameters in the $args array
266 * @param string $sql SQL query
267 * @param array $args The parameters that are to replace the ? placeholders
268 * @return string The replaced SQL query
270 private static function replaceParameters($sql, $args) {
272 foreach ($args AS $param => $value) {
273 if (is_int($args[$param]) || is_float($args[$param])) {
274 $replace = intval($args[$param]);
276 $replace = "'".self::escape($args[$param])."'";
279 $pos = strpos($sql, '?', $offset);
280 if ($pos !== false) {
281 $sql = substr_replace($sql, $replace, $pos, 1);
283 $offset = $pos + strlen($replace);
289 * @brief Convert parameter array to an universal form
290 * @param array $args Parameter array
291 * @return array universalized parameter array
293 private static function getParam($args) {
296 // When the second function parameter is an array then use this as the parameter array
297 if ((count($args) > 0) && (is_array($args[1]))) {
305 * @brief Executes a prepared statement that returns data
306 * @usage Example: $r = p("SELECT * FROM `item` WHERE `guid` = ?", $guid);
308 * Please only use it with complicated queries.
309 * For all regular queries please use dba::select or dba::exists
311 * @param string $sql SQL statement
312 * @return bool|object statement object
314 public static function p($sql) {
317 $stamp1 = microtime(true);
319 $params = self::getParam(func_get_args());
321 // Renumber the array keys to be sure that they fit
324 foreach ($params AS $param) {
325 // Avoid problems with some MySQL servers and boolean values. See issue #3645
326 if (is_bool($param)) {
327 $param = (int)$param;
329 $args[++$i] = $param;
332 if (!self::$connected) {
336 if ((substr_count($sql, '?') != count($args)) && (count($args) > 0)) {
337 // Question: Should we continue or stop the query here?
338 logger('Parameter mismatch. Query "'.$sql.'" - Parameters '.print_r($args, true), LOGGER_DEBUG);
341 $sql = self::clean_query($sql);
342 $sql = self::any_value_fallback($sql);
346 if (x($a->config,'system') && x($a->config['system'], 'db_callstack')) {
347 $sql = "/*".System::callstack()." */ ".$sql;
352 self::$affected_rows = 0;
354 // We have to make some things different if this function is called from "e"
355 $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2);
357 if (isset($trace[1])) {
358 $called_from = $trace[1];
360 // We use just something that is defined to avoid warnings
361 $called_from = $trace[0];
363 // We are having an own error logging in the function "e"
364 $called_from_e = ($called_from['function'] == 'e');
366 switch (self::$driver) {
368 // If there are no arguments we use "query"
369 if (count($args) == 0) {
370 if (!$retval = self::$db->query($sql)) {
371 $errorInfo = self::$db->errorInfo();
372 self::$error = $errorInfo[2];
373 self::$errorno = $errorInfo[1];
377 self::$affected_rows = $retval->rowCount();
381 if (!$stmt = self::$db->prepare($sql)) {
382 $errorInfo = self::$db->errorInfo();
383 self::$error = $errorInfo[2];
384 self::$errorno = $errorInfo[1];
389 foreach ($args AS $param => $value) {
390 $stmt->bindParam($param, $args[$param]);
393 if (!$stmt->execute()) {
394 $errorInfo = $stmt->errorInfo();
395 self::$error = $errorInfo[2];
396 self::$errorno = $errorInfo[1];
400 self::$affected_rows = $retval->rowCount();
404 // There are SQL statements that cannot be executed with a prepared statement
405 $parts = explode(' ', $orig_sql);
406 $command = strtolower($parts[0]);
407 $can_be_prepared = in_array($command, ['select', 'update', 'insert', 'delete']);
409 // The fallback routine is called as well when there are no arguments
410 if (!$can_be_prepared || (count($args) == 0)) {
411 $retval = self::$db->query(self::replaceParameters($sql, $args));
412 if (self::$db->errno) {
413 self::$error = self::$db->error;
414 self::$errorno = self::$db->errno;
417 if (isset($retval->num_rows)) {
418 self::$affected_rows = $retval->num_rows;
420 self::$affected_rows = self::$db->affected_rows;
426 $stmt = self::$db->stmt_init();
428 if (!$stmt->prepare($sql)) {
429 self::$error = $stmt->error;
430 self::$errorno = $stmt->errno;
437 foreach ($args AS $param => $value) {
438 if (is_int($args[$param])) {
440 } elseif (is_float($args[$param])) {
442 } elseif (is_string($args[$param])) {
447 $values[] = &$args[$param];
450 if (count($values) > 0) {
451 array_unshift($values, $params);
452 call_user_func_array([$stmt, 'bind_param'], $values);
455 if (!$stmt->execute()) {
456 self::$error = self::$db->error;
457 self::$errorno = self::$db->errno;
460 $stmt->store_result();
462 self::$affected_rows = $retval->affected_rows;
467 // We are having an own error logging in the function "e"
468 if ((self::$errorno != 0) && !$called_from_e) {
469 // We have to preserve the error code, somewhere in the logging it get lost
470 $error = self::$error;
471 $errorno = self::$errorno;
473 logger('DB Error '.self::$errorno.': '.self::$error."\n".
474 System::callstack(8)."\n".self::replaceParameters($sql, $params));
476 // It doesn't make sense to continue when the database connection was lost
477 if ($errorno == 2006) {
478 logger('Giving up because of database error '.$errorno.': '.$error);
482 self::$error = $error;
483 self::$errorno = $errorno;
486 $a->save_timestamp($stamp1, 'database');
488 if (x($a->config,'system') && x($a->config['system'], 'db_log')) {
490 $stamp2 = microtime(true);
491 $duration = (float)($stamp2 - $stamp1);
493 if (($duration > $a->config["system"]["db_loglimit"])) {
494 $duration = round($duration, 3);
495 $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
497 @file_put_contents($a->config["system"]["db_log"], DateTimeFormat::utcNow()."\t".$duration."\t".
498 basename($backtrace[1]["file"])."\t".
499 $backtrace[1]["line"]."\t".$backtrace[2]["function"]."\t".
500 substr(self::replaceParameters($sql, $args), 0, 2000)."\n", FILE_APPEND);
507 * @brief Executes a prepared statement like UPDATE or INSERT that doesn't return data
509 * Please use dba::delete, dba::insert, dba::update, ... instead
511 * @param string $sql SQL statement
512 * @return boolean Was the query successfull? False is returned only if an error occurred
514 public static function e($sql) {
517 $stamp = microtime(true);
519 $params = self::getParam(func_get_args());
521 // In a case of a deadlock we are repeating the query 20 times
525 $stmt = self::p($sql, $params);
527 if (is_bool($stmt)) {
529 } elseif (is_object($stmt)) {
537 } while ((self::$errorno == 1213) && (--$timeout > 0));
539 if (self::$errorno != 0) {
540 // We have to preserve the error code, somewhere in the logging it get lost
541 $error = self::$error;
542 $errorno = self::$errorno;
544 logger('DB Error '.self::$errorno.': '.self::$error."\n".
545 System::callstack(8)."\n".self::replaceParameters($sql, $params));
547 self::$error = $error;
548 self::$errorno = $errorno;
551 $a->save_timestamp($stamp, "database_write");
557 * @brief Check if data exists
559 * @param string $table Table name
560 * @param array $condition array of fields for condition
562 * @return boolean Are there rows for that condition?
564 public static function exists($table, $condition) {
572 $first_key = key($condition);
573 if (!is_int($first_key)) {
574 $fields = [$first_key];
577 $stmt = self::select($table, $fields, $condition, ['limit' => 1]);
579 if (is_bool($stmt)) {
582 $retval = (self::num_rows($stmt) > 0);
591 * Fetches the first row
593 * Please use dba::selectFirst or dba::exists whenever this is possible.
595 * @brief Fetches the first row
596 * @param string $sql SQL statement
597 * @return array first row of query
599 public static function fetch_first($sql) {
600 $params = self::getParam(func_get_args());
602 $stmt = self::p($sql, $params);
604 if (is_bool($stmt)) {
607 $retval = self::fetch($stmt);
616 * @brief Returns the number of affected rows of the last statement
618 * @return int Number of rows
620 public static function affected_rows() {
621 return self::$affected_rows;
625 * @brief Returns the number of columns of a statement
627 * @param object Statement object
628 * @return int Number of columns
630 public static function columnCount($stmt) {
631 if (!is_object($stmt)) {
634 switch (self::$driver) {
636 return $stmt->columnCount();
638 return $stmt->field_count;
643 * @brief Returns the number of rows of a statement
645 * @param PDOStatement|mysqli_result|mysqli_stmt Statement object
646 * @return int Number of rows
648 public static function num_rows($stmt) {
649 if (!is_object($stmt)) {
652 switch (self::$driver) {
654 return $stmt->rowCount();
656 return $stmt->num_rows;
662 * @brief Fetch a single row
664 * @param mixed $stmt statement object
665 * @return array current row
667 public static function fetch($stmt) {
670 $stamp1 = microtime(true);
674 if (!is_object($stmt)) {
678 switch (self::$driver) {
680 $columns = $stmt->fetch(PDO::FETCH_ASSOC);
683 if (get_class($stmt) == 'mysqli_result') {
684 $columns = $stmt->fetch_assoc();
688 // This code works, but is slow
690 // Bind the result to a result array
694 for ($x = 0; $x < $stmt->field_count; $x++) {
695 $cols[] = &$cols_num[$x];
698 call_user_func_array([$stmt, 'bind_result'], $cols);
700 if (!$stmt->fetch()) {
705 // We need to get the field names for the array keys
706 // It seems that there is no better way to do this.
707 $result = $stmt->result_metadata();
708 $fields = $result->fetch_fields();
710 foreach ($cols_num AS $param => $col) {
711 $columns[$fields[$param]->name] = $col;
715 $a->save_timestamp($stamp1, 'database');
721 * @brief Insert a row into a table
723 * @param string $table Table name
724 * @param array $param parameter array
725 * @param bool $on_duplicate_update Do an update on a duplicate entry
727 * @return boolean was the insert successfull?
729 public static function insert($table, $param, $on_duplicate_update = false) {
731 if (empty($table) || empty($param)) {
732 logger('Table and fields have to be set');
736 $sql = "INSERT INTO `".self::escape($table)."` (`".implode("`, `", array_keys($param))."`) VALUES (".
737 substr(str_repeat("?, ", count($param)), 0, -2).")";
739 if ($on_duplicate_update) {
740 $sql .= " ON DUPLICATE KEY UPDATE `".implode("` = ?, `", array_keys($param))."` = ?";
742 $values = array_values($param);
743 $param = array_merge_recursive($values, $values);
746 return self::e($sql, $param);
750 * @brief Fetch the id of the last insert command
752 * @return integer Last inserted id
754 public static function lastInsertId() {
755 switch (self::$driver) {
757 $id = self::$db->lastInsertId();
760 $id = self::$db->insert_id;
767 * @brief Locks a table for exclusive write access
769 * This function can be extended in the future to accept a table array as well.
771 * @param string $table Table name
773 * @return boolean was the lock successful?
775 public static function lock($table) {
776 // See here: https://dev.mysql.com/doc/refman/5.7/en/lock-tables-and-transactions.html
777 self::e("SET autocommit=0");
778 $success = self::e("LOCK TABLES `".self::escape($table)."` WRITE");
780 self::e("SET autocommit=1");
782 self::$in_transaction = true;
788 * @brief Unlocks all locked tables
790 * @return boolean was the unlock successful?
792 public static function unlock() {
793 // See here: https://dev.mysql.com/doc/refman/5.7/en/lock-tables-and-transactions.html
795 $success = self::e("UNLOCK TABLES");
796 self::e("SET autocommit=1");
797 self::$in_transaction = false;
802 * @brief Starts a transaction
804 * @return boolean Was the command executed successfully?
806 public static function transaction() {
807 if (!self::e('COMMIT')) {
810 if (!self::e('START TRANSACTION')) {
813 self::$in_transaction = true;
818 * @brief Does a commit
820 * @return boolean Was the command executed successfully?
822 public static function commit() {
823 if (!self::e('COMMIT')) {
826 self::$in_transaction = false;
831 * @brief Does a rollback
833 * @return boolean Was the command executed successfully?
835 public static function rollback() {
836 if (!self::e('ROLLBACK')) {
839 self::$in_transaction = false;
844 * @brief Build the array with the table relations
846 * The array is build from the database definitions in DBStructure.php
848 * This process must only be started once, since the value is cached.
850 private static function buildRelationData() {
851 $definition = DBStructure::definition();
853 foreach ($definition AS $table => $structure) {
854 foreach ($structure['fields'] AS $field => $field_struct) {
855 if (isset($field_struct['relation'])) {
856 foreach ($field_struct['relation'] AS $rel_table => $rel_field) {
857 self::$relation[$rel_table][$rel_field][$table][] = $field;
865 * @brief Delete a row from a table
867 * @param string $table Table name
868 * @param array $conditions Field condition(s)
869 * @param array $options
870 * - cascade: If true we delete records in other tables that depend on the one we're deleting through
871 * relations (default: true)
872 * @param boolean $in_process Internal use: Only do a commit after the last delete
873 * @param array $callstack Internal use: prevent endless loops
875 * @return boolean|array was the delete successful? When $in_process is set: deletion data
877 public static function delete($table, array $conditions, array $options = [], $in_process = false, array &$callstack = [])
879 if (empty($table) || empty($conditions)) {
880 logger('Table and conditions have to be set');
886 // Create a key for the loop prevention
887 $key = $table . ':' . implode(':', array_keys($conditions)) . ':' . implode(':', $conditions);
889 // We quit when this key already exists in the callstack.
890 if (isset($callstack[$key])) {
894 $callstack[$key] = true;
896 $table = self::escape($table);
898 $commands[$key] = ['table' => $table, 'conditions' => $conditions];
900 $cascade = defaults($options, 'cascade', true);
902 // To speed up the whole process we cache the table relations
903 if ($cascade && count(self::$relation) == 0) {
904 self::buildRelationData();
907 // Is there a relation entry for the table?
908 if ($cascade && isset(self::$relation[$table])) {
909 // We only allow a simple "one field" relation.
910 $field = array_keys(self::$relation[$table])[0];
911 $rel_def = array_values(self::$relation[$table])[0];
913 // Create a key for preventing double queries
914 $qkey = $field . '-' . $table . ':' . implode(':', array_keys($conditions)) . ':' . implode(':', $conditions);
916 // When the search field is the relation field, we don't need to fetch the rows
917 // This is useful when the leading record is already deleted in the frontend but the rest is done in the backend
918 if ((count($conditions) == 1) && ($field == array_keys($conditions)[0])) {
919 foreach ($rel_def AS $rel_table => $rel_fields) {
920 foreach ($rel_fields AS $rel_field) {
921 $retval = self::delete($rel_table, [$rel_field => array_values($conditions)[0]], $options, true, $callstack);
922 $commands = array_merge($commands, $retval);
925 // We quit when this key already exists in the callstack.
926 } elseif (!isset($callstack[$qkey])) {
928 $callstack[$qkey] = true;
930 // Fetch all rows that are to be deleted
931 $data = self::select($table, [$field], $conditions);
933 while ($row = self::fetch($data)) {
934 // Now we accumulate the delete commands
935 $retval = self::delete($table, [$field => $row[$field]], $options, true, $callstack);
936 $commands = array_merge($commands, $retval);
941 // Since we had split the delete command we don't need the original command anymore
942 unset($commands[$key]);
947 // Now we finalize the process
948 $do_transaction = !self::$in_transaction;
950 if ($do_transaction) {
957 foreach ($commands AS $command) {
958 $conditions = $command['conditions'];
960 $first_key = key($conditions);
962 $condition_string = self::buildCondition($conditions);
964 if ((count($command['conditions']) > 1) || is_int($first_key)) {
965 $sql = "DELETE FROM `" . $command['table'] . "`" . $condition_string;
966 logger(self::replaceParameters($sql, $conditions), LOGGER_DATA);
968 if (!self::e($sql, $conditions)) {
969 if ($do_transaction) {
975 $key_table = $command['table'];
976 $key_condition = array_keys($command['conditions'])[0];
977 $value = array_values($command['conditions'])[0];
979 // Split the SQL queries in chunks of 100 values
980 // We do the $i stuff here to make the code better readable
981 $i = $counter[$key_table][$key_condition];
982 if (isset($compacted[$key_table][$key_condition][$i]) && count($compacted[$key_table][$key_condition][$i]) > 100) {
986 $compacted[$key_table][$key_condition][$i][$value] = $value;
987 $counter[$key_table][$key_condition] = $i;
990 foreach ($compacted AS $table => $values) {
991 foreach ($values AS $field => $field_value_list) {
992 foreach ($field_value_list AS $field_values) {
993 $sql = "DELETE FROM `" . $table . "` WHERE `" . $field . "` IN (" .
994 substr(str_repeat("?, ", count($field_values)), 0, -2) . ");";
996 logger(self::replaceParameters($sql, $field_values), LOGGER_DATA);
998 if (!self::e($sql, $field_values)) {
999 if ($do_transaction) {
1007 if ($do_transaction) {
1017 * @brief Updates rows
1019 * Updates rows in the database. When $old_fields is set to an array,
1020 * the system will only do an update if the fields in that array changed.
1023 * Only the values in $old_fields are compared.
1024 * This is an intentional behaviour.
1027 * We include the timestamp field in $fields but not in $old_fields.
1028 * Then the row will only get the new timestamp when the other fields had changed.
1030 * When $old_fields is set to a boolean value the system will do this compare itself.
1031 * When $old_fields is set to "true" the system will do an insert if the row doesn't exists.
1034 * Only set $old_fields to a boolean value when you are sure that you will update a single row.
1035 * When you set $old_fields to "true" then $fields must contain all relevant fields!
1037 * @param string $table Table name
1038 * @param array $fields contains the fields that are updated
1039 * @param array $condition condition array with the key values
1040 * @param array|boolean $old_fields array with the old field values that are about to be replaced (true = update on duplicate)
1042 * @return boolean was the update successfull?
1044 public static function update($table, $fields, $condition, $old_fields = []) {
1046 if (empty($table) || empty($fields) || empty($condition)) {
1047 logger('Table, fields and condition have to be set');
1051 $table = self::escape($table);
1053 $condition_string = self::buildCondition($condition);
1055 if (is_bool($old_fields)) {
1056 $do_insert = $old_fields;
1058 $old_fields = self::selectFirst($table, [], $condition);
1060 if (is_bool($old_fields)) {
1062 $values = array_merge($condition, $fields);
1063 return self::insert($table, $values, $do_insert);
1069 $do_update = (count($old_fields) == 0);
1071 foreach ($old_fields AS $fieldname => $content) {
1072 if (isset($fields[$fieldname])) {
1073 if ($fields[$fieldname] == $content) {
1074 unset($fields[$fieldname]);
1081 if (!$do_update || (count($fields) == 0)) {
1085 $sql = "UPDATE `".$table."` SET `".
1086 implode("` = ?, `", array_keys($fields))."` = ?".$condition_string;
1088 $params1 = array_values($fields);
1089 $params2 = array_values($condition);
1090 $params = array_merge_recursive($params1, $params2);
1092 return self::e($sql, $params);
1096 * Retrieve a single record from a table and returns it in an associative array
1098 * @brief Retrieve a single record from a table
1099 * @param string $table
1100 * @param array $fields
1101 * @param array $condition
1102 * @param array $params
1103 * @return bool|array
1106 public static function selectFirst($table, array $fields = [], array $condition = [], $params = [])
1108 $params['limit'] = 1;
1109 $result = self::select($table, $fields, $condition, $params);
1111 if (is_bool($result)) {
1114 $row = self::fetch($result);
1115 self::close($result);
1121 * @brief Select rows from a table
1123 * @param string $table Table name
1124 * @param array $fields Array of selected fields, empty for all
1125 * @param array $condition Array of fields for condition
1126 * @param array $params Array of several parameters
1128 * @return boolean|object
1132 * $fields = array("id", "uri", "uid", "network");
1134 * $condition = array("uid" => 1, "network" => 'dspr');
1136 * $condition = array("`uid` = ? AND `network` IN (?, ?)", 1, 'dfrn', 'dspr');
1138 * $params = array("order" => array("id", "received" => true), "limit" => 10);
1140 * $data = dba::select($table, $fields, $condition, $params);
1142 public static function select($table, array $fields = [], array $condition = [], array $params = [])
1148 $table = self::escape($table);
1150 if (count($fields) > 0) {
1151 $select_fields = "`" . implode("`, `", array_values($fields)) . "`";
1153 $select_fields = "*";
1156 $condition_string = self::buildCondition($condition);
1159 if (isset($params['order'])) {
1160 $order_string = " ORDER BY ";
1161 foreach ($params['order'] AS $fields => $order) {
1162 if (!is_int($fields)) {
1163 $order_string .= "`" . $fields . "` " . ($order ? "DESC" : "ASC") . ", ";
1165 $order_string .= "`" . $order . "`, ";
1168 $order_string = substr($order_string, 0, -2);
1172 if (isset($params['limit']) && is_int($params['limit'])) {
1173 $limit_string = " LIMIT " . $params['limit'];
1176 if (isset($params['limit']) && is_array($params['limit'])) {
1177 $limit_string = " LIMIT " . intval($params['limit'][0]) . ", " . intval($params['limit'][1]);
1180 $sql = "SELECT " . $select_fields . " FROM `" . $table . "`" . $condition_string . $order_string . $limit_string;
1182 $result = self::p($sql, $condition);
1188 * @brief Counts the rows from a table satisfying the provided condition
1190 * @param string $table Table name
1191 * @param array $condition array of fields for condition
1198 * $condition = ["uid" => 1, "network" => 'dspr'];
1200 * $condition = ["`uid` = ? AND `network` IN (?, ?)", 1, 'dfrn', 'dspr'];
1202 * $count = dba::count($table, $condition);
1204 public static function count($table, array $condition = [])
1210 $condition_string = self::buildCondition($condition);
1212 $sql = "SELECT COUNT(*) AS `count` FROM `".$table."`".$condition_string;
1214 $row = self::fetch_first($sql, $condition);
1216 return $row['count'];
1220 * @brief Returns the SQL condition string built from the provided condition array
1222 * This function operates with two modes.
1223 * - Supplied with a filed/value associative array, it builds simple strict
1224 * equality conditions linked by AND.
1225 * - Supplied with a flat list, the first element is the condition string and
1226 * the following arguments are the values to be interpolated
1228 * $condition = ["uid" => 1, "network" => 'dspr'];
1230 * $condition = ["`uid` = ? AND `network` IN (?, ?)", 1, 'dfrn', 'dspr'];
1232 * In either case, the provided array is left with the parameters only
1234 * @param array $condition
1237 private static function buildCondition(array &$condition = [])
1239 $condition_string = '';
1240 if (count($condition) > 0) {
1242 $first_key = key($condition);
1243 if (is_int($first_key)) {
1244 $condition_string = " WHERE ".array_shift($condition);
1247 $condition_string = "";
1248 foreach ($condition as $field => $value) {
1249 if ($condition_string != "") {
1250 $condition_string .= " AND ";
1252 if (is_array($value)) {
1253 $new_values = array_merge($new_values, array_values($value));
1254 $placeholders = substr(str_repeat("?, ", count($value)), 0, -2);
1255 $condition_string .= "`" . $field . "` IN (" . $placeholders . ")";
1257 $new_values[$field] = $value;
1258 $condition_string .= "`" . $field . "` = ?";
1261 $condition_string = " WHERE " . $condition_string;
1262 $condition = $new_values;
1266 return $condition_string;
1270 * @brief Fills an array with data from a query
1272 * @param object $stmt statement object
1273 * @return array Data array
1275 public static function inArray($stmt, $do_close = true) {
1276 if (is_bool($stmt)) {
1281 while ($row = self::fetch($stmt)) {
1291 * @brief Returns the error number of the last query
1293 * @return string Error number (0 if no error)
1295 public static function errorNo() {
1296 return self::$errorno;
1300 * @brief Returns the error message of the last query
1302 * @return string Error message ('' if no error)
1304 public static function errorMessage() {
1305 return self::$error;
1309 * @brief Closes the current statement
1311 * @param object $stmt statement object
1312 * @return boolean was the close successful?
1314 public static function close($stmt) {
1317 $stamp1 = microtime(true);
1319 if (!is_object($stmt)) {
1323 switch (self::$driver) {
1325 $ret = $stmt->closeCursor();
1328 $stmt->free_result();
1329 $ret = $stmt->close();
1333 $a->save_timestamp($stamp1, 'database');
1339 function dbesc($str) {
1340 if (dba::$connected) {
1341 return(dba::escape($str));
1343 return(str_replace("'","\\'",$str));
1348 * @brief execute SQL query with printf style args - deprecated
1350 * Please use the dba:: functions instead:
1351 * dba::select, dba::exists, dba::insert
1352 * dba::delete, dba::update, dba::p, dba::e
1354 * @param $args Query parameters (1 to N parameters of different types)
1355 * @return array|bool Query array
1358 $args = func_get_args();
1361 if (!dba::$connected) {
1365 $sql = dba::clean_query($sql);
1366 $sql = dba::any_value_fallback($sql);
1368 $stmt = @vsprintf($sql, $args);
1370 $ret = dba::p($stmt);
1372 if (is_bool($ret)) {
1376 $columns = dba::columnCount($ret);
1378 $data = dba::inArray($ret);
1380 if ((count($data) == 0) && ($columns == 0)) {
1387 function dba_timer() {
1388 return microtime(true);