2 require_once("dbm.php");
3 require_once('include/datetime.php');
6 * @class MySQL database class
8 * For debugging, insert 'dbg(1);' anywhere in the program flow.
9 * dbg(0); will turn it off. Logging is performed at LOGGER_DATA level.
10 * When logging, all binary info is converted to text and html entities are escaped so that
11 * the debugging stream is safe to view within both terminals and web pages.
13 * This class is for the low level database stuff that does driver specific things.
22 public $connected = false;
23 public $error = false;
25 public $affected_rows = 0;
26 private $_server_info = '';
27 private static $in_transaction = false;
29 private static $relation = array();
31 function __construct($serveraddr, $user, $pass, $db, $install = false) {
34 $stamp1 = microtime(true);
36 $serveraddr = trim($serveraddr);
38 $serverdata = explode(':', $serveraddr);
39 $server = $serverdata[0];
41 if (count($serverdata) > 1) {
42 $port = trim($serverdata[1]);
45 $server = trim($server);
50 if (!(strlen($server) && strlen($user))) {
51 $this->connected = false;
57 if (strlen($server) && ($server !== 'localhost') && ($server !== '127.0.0.1')) {
58 if (! dns_get_record($server, DNS_A + DNS_CNAME + DNS_PTR)) {
59 $this->error = sprintf(t('Cannot locate DNS info for database server \'%s\''), $server);
60 $this->connected = false;
67 if (class_exists('\PDO') && in_array('mysql', PDO::getAvailableDrivers())) {
68 $this->driver = 'pdo';
69 $connect = "mysql:host=".$server.";dbname=".$db;
72 $connect .= ";port=".$port;
75 if (isset($a->config["system"]["db_charset"])) {
76 $connect .= ";charset=".$a->config["system"]["db_charset"];
79 $this->db = @new PDO($connect, $user, $pass);
80 $this->connected = true;
81 } catch (PDOException $e) {
82 $this->connected = false;
86 if (!$this->connected && class_exists('mysqli')) {
87 $this->driver = 'mysqli';
88 $this->db = @new mysqli($server, $user, $pass, $db, $port);
89 if (!mysqli_connect_errno()) {
90 $this->connected = true;
92 if (isset($a->config["system"]["db_charset"])) {
93 $this->db->set_charset($a->config["system"]["db_charset"]);
98 if (!$this->connected && function_exists('mysql_connect')) {
99 $this->driver = 'mysql';
100 $this->db = mysql_connect($serveraddr, $user, $pass);
101 if ($this->db && mysql_select_db($db, $this->db)) {
102 $this->connected = true;
104 if (isset($a->config["system"]["db_charset"])) {
105 mysql_set_charset($a->config["system"]["db_charset"], $this->db);
110 // No suitable SQL driver was found.
111 if (!$this->connected) {
114 system_unavailable();
117 $a->save_timestamp($stamp1, "network");
123 * @brief Returns the MySQL server version string
125 * This function discriminate between the deprecated mysql API and the current
126 * object-oriented mysqli API. Example of returned string: 5.5.46-0+deb8u1
130 public function server_info() {
131 if ($this->_server_info == '') {
132 switch ($this->driver) {
134 $this->_server_info = $this->db->getAttribute(PDO::ATTR_SERVER_VERSION);
137 $this->_server_info = $this->db->server_info;
140 $this->_server_info = mysql_get_server_info($this->db);
144 return $this->_server_info;
148 * @brief Returns the selected database name
152 public function database_name() {
153 $r = $this->q("SELECT DATABASE() AS `db`");
159 * @brief Analyze a database query and log this if some conditions are met.
161 * @param string $query The database query that will be analyzed
163 public function log_index($query) {
166 if (empty($a->config["system"]["db_log_index"])) {
170 // Don't explain an explain statement
171 if (strtolower(substr($query, 0, 7)) == "explain") {
175 // Only do the explain on "select", "update" and "delete"
176 if (!in_array(strtolower(substr($query, 0, 6)), array("select", "update", "delete"))) {
180 $r = $this->q("EXPLAIN ".$query);
181 if (!dbm::is_result($r)) {
185 $watchlist = explode(',', $a->config["system"]["db_log_index_watch"]);
186 $blacklist = explode(',', $a->config["system"]["db_log_index_blacklist"]);
188 foreach ($r AS $row) {
189 if ((intval($a->config["system"]["db_loglimit_index"]) > 0)) {
190 $log = (in_array($row['key'], $watchlist) &&
191 ($row['rows'] >= intval($a->config["system"]["db_loglimit_index"])));
196 if ((intval($a->config["system"]["db_loglimit_index_high"]) > 0) && ($row['rows'] >= intval($a->config["system"]["db_loglimit_index_high"]))) {
200 if (in_array($row['key'], $blacklist) || ($row['key'] == "")) {
205 $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
206 @file_put_contents($a->config["system"]["db_log_index"], datetime_convert()."\t".
207 $row['key']."\t".$row['rows']."\t".$row['Extra']."\t".
208 basename($backtrace[1]["file"])."\t".
209 $backtrace[1]["line"]."\t".$backtrace[2]["function"]."\t".
210 substr($query, 0, 2000)."\n", FILE_APPEND);
215 public function q($sql, $onlyquery = false) {
218 if (!$this->db || !$this->connected) {
224 $connstr = ($this->connected() ? "Connected" : "Disonnected");
226 $stamp1 = microtime(true);
230 if (x($a->config,'system') && x($a->config['system'], 'db_callstack')) {
231 $sql = "/*".$a->callstack()." */ ".$sql;
236 switch ($this->driver) {
238 $result = @$this->db->query($sql);
239 // Is used to separate between queries that returning data - or not
240 if (!is_bool($result)) {
241 $columns = $result->columnCount();
245 $result = @$this->db->query($sql);
248 $result = @mysql_query($sql,$this->db);
251 $stamp2 = microtime(true);
252 $duration = (float)($stamp2 - $stamp1);
254 $a->save_timestamp($stamp1, "database");
256 if (strtolower(substr($orig_sql, 0, 6)) != "select") {
257 $a->save_timestamp($stamp1, "database_write");
259 if (x($a->config,'system') && x($a->config['system'],'db_log')) {
260 if (($duration > $a->config["system"]["db_loglimit"])) {
261 $duration = round($duration, 3);
262 $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
263 @file_put_contents($a->config["system"]["db_log"], datetime_convert()."\t".$duration."\t".
264 basename($backtrace[1]["file"])."\t".
265 $backtrace[1]["line"]."\t".$backtrace[2]["function"]."\t".
266 substr($sql, 0, 2000)."\n", FILE_APPEND);
270 switch ($this->driver) {
272 $errorInfo = $this->db->errorInfo();
274 $this->error = $errorInfo[2];
275 $this->errorno = $errorInfo[1];
279 if ($this->db->errno) {
280 $this->error = $this->db->error;
281 $this->errorno = $this->db->errno;
285 if (mysql_errno($this->db)) {
286 $this->error = mysql_error($this->db);
287 $this->errorno = mysql_errno($this->db);
291 if (strlen($this->error)) {
292 logger('DB Error ('.$connstr.') '.$this->errorno.': '.$this->error);
299 if ($result === false) {
301 } elseif ($result === true) {
304 switch ($this->driver) {
306 $mesg = $result->rowCount().' results'.EOL;
309 $mesg = $result->num_rows.' results'.EOL;
312 $mesg = mysql_num_rows($result).' results'.EOL;
317 $str = 'SQL = ' . printable($sql) . EOL . 'SQL returned ' . $mesg
318 . (($this->error) ? ' error: ' . $this->error : '')
321 logger('dba: ' . $str );
325 * If dbfail.out exists, we will write any failed calls directly to it,
326 * regardless of any logging that may or may nor be in effect.
327 * These usually indicate SQL syntax errors that need to be resolved.
330 if ($result === false) {
331 logger('dba: ' . printable($sql) . ' returned false.' . "\n" . $this->error);
332 if (file_exists('dbfail.out')) {
333 file_put_contents('dbfail.out', datetime_convert() . "\n" . printable($sql) . ' returned false' . "\n" . $this->error . "\n", FILE_APPEND);
337 if (is_bool($result)) {
341 $this->result = $result;
346 switch ($this->driver) {
348 while ($x = $result->fetch(PDO::FETCH_ASSOC)) {
351 $result->closeCursor();
354 while ($x = $result->fetch_array(MYSQLI_ASSOC)) {
357 $result->free_result();
360 while ($x = mysql_fetch_array($result, MYSQL_ASSOC)) {
363 mysql_free_result($result);
367 // PDO doesn't return "true" on successful operations - like mysqli does
368 // Emulate this behaviour by checking if the query returned data and had columns
369 // This should be reliable enough
370 if (($this->driver == 'pdo') && (count($r) == 0) && ($columns == 0)) {
374 //$a->save_timestamp($stamp1, "database");
377 logger('dba: ' . printable(print_r($r, true)));
382 public function dbg($dbg) {
386 public function escape($str) {
387 if ($this->db && $this->connected) {
388 switch ($this->driver) {
390 return substr(@$this->db->quote($str, PDO::PARAM_STR), 1, -1);
392 return @$this->db->real_escape_string($str);
394 return @mysql_real_escape_string($str,$this->db);
399 function connected() {
400 switch ($this->driver) {
402 // Not sure if this really is working like expected
403 $connected = ($this->db->getAttribute(PDO::ATTR_CONNECTION_STATUS) != "");
406 $connected = $this->db->ping();
409 $connected = mysql_ping($this->db);
415 function __destruct() {
417 switch ($this->driver) {
425 mysql_close($this->db);
432 * @brief Replaces ANY_VALUE() function by MIN() function,
433 * if the database server does not support ANY_VALUE().
435 * Considerations for Standard SQL, or MySQL with ONLY_FULL_GROUP_BY (default since 5.7.5).
436 * ANY_VALUE() is available from MySQL 5.7.5 https://dev.mysql.com/doc/refman/5.7/en/miscellaneous-functions.html
437 * A standard fall-back is to use MIN().
439 * @param string $sql An SQL string without the values
440 * @return string The input SQL string modified if necessary.
442 public function any_value_fallback($sql) {
443 $server_info = $this->server_info();
444 if (version_compare($server_info, '5.7.5', '<') ||
445 (stripos($server_info, 'MariaDB') !== false)) {
446 $sql = str_ireplace('ANY_VALUE(', 'MIN(', $sql);
452 * @brief beautifies the query - useful for "SHOW PROCESSLIST"
454 * This is safe when we bind the parameters later.
455 * The parameter values aren't part of the SQL.
457 * @param string $sql An SQL string without the values
458 * @return string The input SQL string modified if necessary.
460 public function clean_query($sql) {
461 $search = array("\t", "\n", "\r", " ");
462 $replace = array(' ', ' ', ' ', ' ');
465 $sql = str_replace($search, $replace, $sql);
466 } while ($oldsql != $sql);
473 * @brief Replaces the ? placeholders with the parameters in the $args array
475 * @param string $sql SQL query
476 * @param array $args The parameters that are to replace the ? placeholders
477 * @return string The replaced SQL query
479 static private function replace_parameters($sql, $args) {
481 foreach ($args AS $param => $value) {
482 if (is_int($args[$param]) || is_float($args[$param])) {
483 $replace = intval($args[$param]);
485 $replace = "'".self::$dbo->escape($args[$param])."'";
488 $pos = strpos($sql, '?', $offset);
489 if ($pos !== false) {
490 $sql = substr_replace($sql, $replace, $pos, 1);
492 $offset = $pos + strlen($replace);
498 * @brief Convert parameter array to an universal form
499 * @param array $args Parameter array
500 * @return array universalized parameter array
502 private static function getParam($args) {
505 // When the second function parameter is an array then use this as the parameter array
506 if ((count($args) > 0) && (is_array($args[1]))) {
514 * @brief Executes a prepared statement that returns data
515 * @usage Example: $r = p("SELECT * FROM `item` WHERE `guid` = ?", $guid);
516 * @param string $sql SQL statement
517 * @return object statement object
519 static public function p($sql) {
522 $stamp1 = microtime(true);
524 $params = self::getParam(func_get_args());
526 // Renumber the array keys to be sure that they fit
529 foreach ($params AS $param) {
530 $args[++$i] = $param;
533 if (!self::$dbo || !self::$dbo->connected) {
537 if (substr_count($sql, '?') != count($args)) {
538 // Question: Should we continue or stop the query here?
539 logger('Parameter mismatch. Query "'.$sql.'" - Parameters '.print_r($args, true), LOGGER_DEBUG);
542 $sql = self::$dbo->clean_query($sql);
543 $sql = self::$dbo->any_value_fallback($sql);
547 if (x($a->config,'system') && x($a->config['system'], 'db_callstack')) {
548 $sql = "/*".$a->callstack()." */ ".$sql;
551 self::$dbo->error = '';
552 self::$dbo->errorno = 0;
553 self::$dbo->affected_rows = 0;
555 // We have to make some things different if this function is called from "e"
556 $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2);
558 if (isset($trace[1])) {
559 $called_from = $trace[1];
561 // We use just something that is defined to avoid warnings
562 $called_from = $trace[0];
564 // We are having an own error logging in the function "e"
565 $called_from_e = ($called_from['function'] == 'e');
567 switch (self::$dbo->driver) {
569 if (!$stmt = self::$dbo->db->prepare($sql)) {
570 $errorInfo = self::$dbo->db->errorInfo();
571 self::$dbo->error = $errorInfo[2];
572 self::$dbo->errorno = $errorInfo[1];
577 foreach ($args AS $param => $value) {
578 $stmt->bindParam($param, $args[$param]);
581 if (!$stmt->execute()) {
582 $errorInfo = $stmt->errorInfo();
583 self::$dbo->error = $errorInfo[2];
584 self::$dbo->errorno = $errorInfo[1];
588 self::$dbo->affected_rows = $retval->rowCount();
592 // There are SQL statements that cannot be executed with a prepared statement
593 $parts = explode(' ', $orig_sql);
594 $command = strtolower($parts[0]);
595 $can_be_prepared = in_array($command, array('select', 'update', 'insert', 'delete'));
597 // The fallback routine currently only works with statements that doesn't return values
598 if (!$can_be_prepared && $called_from_e) {
599 $retval = self::$dbo->db->query(self::replace_parameters($sql, $args));
600 if (self::$dbo->db->errno) {
601 self::$dbo->error = self::$dbo->db->error;
602 self::$dbo->errorno = self::$dbo->db->errno;
605 if (isset($retval->num_rows)) {
606 self::$dbo->affected_rows = $retval->num_rows;
608 self::$dbo->affected_rows = self::$dbo->db->affected_rows;
614 $stmt = self::$dbo->db->stmt_init();
616 if (!$stmt->prepare($sql)) {
617 self::$dbo->error = $stmt->error;
618 self::$dbo->errorno = $stmt->errno;
625 foreach ($args AS $param => $value) {
626 if (is_int($args[$param])) {
628 } elseif (is_float($args[$param])) {
630 } elseif (is_string($args[$param])) {
635 $values[] = &$args[$param];
638 if (count($values) > 0) {
639 array_unshift($values, $params);
640 call_user_func_array(array($stmt, 'bind_param'), $values);
643 if (!$stmt->execute()) {
644 self::$dbo->error = self::$dbo->db->error;
645 self::$dbo->errorno = self::$dbo->db->errno;
648 $stmt->store_result();
650 self::$dbo->affected_rows = $retval->affected_rows;
654 // For the old "mysql" functions we cannot use prepared statements
655 $retval = mysql_query(self::replace_parameters($sql, $args), self::$dbo->db);
656 if (mysql_errno(self::$dbo->db)) {
657 self::$dbo->error = mysql_error(self::$dbo->db);
658 self::$dbo->errorno = mysql_errno(self::$dbo->db);
660 self::$dbo->affected_rows = mysql_affected_rows($retval);
662 // Due to missing mysql_* support this here wasn't tested at all
663 // See here: http://php.net/manual/en/function.mysql-num-rows.php
664 if (self::$dbo->affected_rows <= 0) {
665 self::$dbo->affected_rows = mysql_num_rows($retval);
671 // We are having an own error logging in the function "e"
672 if ((self::$dbo->errorno != 0) && !$called_from_e) {
673 // We have to preserve the error code, somewhere in the logging it get lost
674 $error = self::$dbo->error;
675 $errorno = self::$dbo->errorno;
677 logger('DB Error '.self::$dbo->errorno.': '.self::$dbo->error."\n".
678 $a->callstack(8)."\n".self::replace_parameters($sql, $params));
680 self::$dbo->error = $error;
681 self::$dbo->errorno = $errorno;
684 $a->save_timestamp($stamp1, 'database');
686 if (x($a->config,'system') && x($a->config['system'], 'db_log')) {
688 $stamp2 = microtime(true);
689 $duration = (float)($stamp2 - $stamp1);
691 if (($duration > $a->config["system"]["db_loglimit"])) {
692 $duration = round($duration, 3);
693 $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
695 @file_put_contents($a->config["system"]["db_log"], datetime_convert()."\t".$duration."\t".
696 basename($backtrace[1]["file"])."\t".
697 $backtrace[1]["line"]."\t".$backtrace[2]["function"]."\t".
698 substr(self::replace_parameters($sql, $args), 0, 2000)."\n", FILE_APPEND);
705 * @brief Executes a prepared statement like UPDATE or INSERT that doesn't return data
707 * @param string $sql SQL statement
708 * @return boolean Was the query successfull? False is returned only if an error occurred
710 static public function e($sql) {
713 $stamp = microtime(true);
715 $params = self::getParam(func_get_args());
717 // In a case of a deadlock we are repeating the query 20 times
721 $stmt = self::p($sql, $params);
723 if (is_bool($stmt)) {
725 } elseif (is_object($stmt)) {
733 } while ((self::$dbo->errorno == 1213) && (--$timeout > 0));
735 if (self::$dbo->errorno != 0) {
736 // We have to preserve the error code, somewhere in the logging it get lost
737 $error = self::$dbo->error;
738 $errorno = self::$dbo->errorno;
740 logger('DB Error '.self::$dbo->errorno.': '.self::$dbo->error."\n".
741 $a->callstack(8)."\n".self::replace_parameters($sql, $params));
743 self::$dbo->error = $error;
744 self::$dbo->errorno = $errorno;
747 $a->save_timestamp($stamp, "database_write");
753 * @brief Check if data exists
755 * @param string $table Table name
756 * @param array $condition array of fields for condition
758 * @return boolean Are there rows for that condition?
760 static public function exists($table, $condition) {
767 $array_element = each($condition);
768 $array_key = $array_element['key'];
769 if (!is_int($array_key)) {
770 $fields = array($array_key);
773 $stmt = self::select($table, $fields, $condition, array('limit' => 1, 'only_query' => true));
775 if (is_bool($stmt)) {
778 $retval = (self::num_rows($stmt) > 0);
787 * @brief Fetches the first row
789 * @param string $sql SQL statement
790 * @return array first row of query
792 static public function fetch_first($sql) {
793 $params = self::getParam(func_get_args());
795 $stmt = self::p($sql, $params);
797 if (is_bool($stmt)) {
800 $retval = self::fetch($stmt);
809 * @brief Returns the number of affected rows of the last statement
811 * @return int Number of rows
813 static public function affected_rows() {
814 return self::$dbo->affected_rows;
818 * @brief Returns the number of rows of a statement
820 * @param object Statement object
821 * @return int Number of rows
823 static public function num_rows($stmt) {
824 if (!is_object($stmt)) {
827 switch (self::$dbo->driver) {
829 return $stmt->rowCount();
831 return $stmt->num_rows;
833 return mysql_num_rows($stmt);
839 * @brief Fetch a single row
841 * @param object $stmt statement object
842 * @return array current row
844 static public function fetch($stmt) {
845 if (!is_object($stmt)) {
849 switch (self::$dbo->driver) {
851 return $stmt->fetch(PDO::FETCH_ASSOC);
853 // This code works, but is slow
855 // Bind the result to a result array
859 for ($x = 0; $x < $stmt->field_count; $x++) {
860 $cols[] = &$cols_num[$x];
863 call_user_func_array(array($stmt, 'bind_result'), $cols);
865 if (!$stmt->fetch()) {
870 // We need to get the field names for the array keys
871 // It seems that there is no better way to do this.
872 $result = $stmt->result_metadata();
873 $fields = $result->fetch_fields();
876 foreach ($cols_num AS $param => $col) {
877 $columns[$fields[$param]->name] = $col;
881 return mysql_fetch_array(self::$dbo->result, MYSQL_ASSOC);
886 * @brief Insert a row into a table
888 * @param string $table Table name
889 * @param array $param parameter array
890 * @param bool $on_duplicate_update Do an update on a duplicate entry
892 * @return boolean was the insert successfull?
894 static public function insert($table, $param, $on_duplicate_update = false) {
895 $sql = "INSERT INTO `".self::$dbo->escape($table)."` (`".implode("`, `", array_keys($param))."`) VALUES (".
896 substr(str_repeat("?, ", count($param)), 0, -2).")";
898 if ($on_duplicate_update) {
899 $sql .= " ON DUPLICATE KEY UPDATE `".implode("` = ?, `", array_keys($param))."` = ?";
901 $values = array_values($param);
902 $param = array_merge_recursive($values, $values);
905 return self::e($sql, $param);
909 * @brief Fetch the id of the last insert command
911 * @return integer Last inserted id
913 function lastInsertId() {
914 switch (self::$dbo->driver) {
916 $id = self::$dbo->db->lastInsertId();
919 $id = self::$dbo->db->insert_id;
922 $id = mysql_insert_id(self::$dbo);
929 * @brief Locks a table for exclusive write access
931 * This function can be extended in the future to accept a table array as well.
933 * @param string $table Table name
935 * @return boolean was the lock successful?
937 static public function lock($table) {
938 // See here: https://dev.mysql.com/doc/refman/5.7/en/lock-tables-and-transactions.html
939 self::e("SET autocommit=0");
940 $success = self::e("LOCK TABLES `".self::$dbo->escape($table)."` WRITE");
942 self::e("SET autocommit=1");
944 self::$in_transaction = true;
950 * @brief Unlocks all locked tables
952 * @return boolean was the unlock successful?
954 static public function unlock() {
955 // See here: https://dev.mysql.com/doc/refman/5.7/en/lock-tables-and-transactions.html
957 $success = self::e("UNLOCK TABLES");
958 self::e("SET autocommit=1");
959 self::$in_transaction = false;
964 * @brief Starts a transaction
966 * @return boolean Was the command executed successfully?
968 static public function transaction() {
969 if (!self::e('COMMIT')) {
972 if (!self::e('START TRANSACTION')) {
975 self::$in_transaction = true;
980 * @brief Does a commit
982 * @return boolean Was the command executed successfully?
984 static public function commit() {
985 if (!self::e('COMMIT')) {
988 self::$in_transaction = false;
993 * @brief Does a rollback
995 * @return boolean Was the command executed successfully?
997 static public function rollback() {
998 if (!self::e('ROLLBACK')) {
1001 self::$in_transaction = false;
1006 * @brief Build the array with the table relations
1008 * The array is build from the database definitions in dbstructure.php
1010 * This process must only be started once, since the value is cached.
1012 static private function build_relation_data() {
1013 $definition = db_definition();
1015 foreach ($definition AS $table => $structure) {
1016 foreach ($structure['fields'] AS $field => $field_struct) {
1017 if (isset($field_struct['relation'])) {
1018 foreach ($field_struct['relation'] AS $rel_table => $rel_field) {
1019 self::$relation[$rel_table][$rel_field][$table][] = $field;
1027 * @brief Delete a row from a table
1029 * @param string $table Table name
1030 * @param array $param parameter array
1031 * @param boolean $in_process Internal use: Only do a commit after the last delete
1032 * @param array $callstack Internal use: prevent endless loops
1034 * @return boolean|array was the delete successfull? When $in_process is set: deletion data
1036 static public function delete($table, $param, $in_process = false, &$callstack = array()) {
1038 $commands = array();
1040 // Create a key for the loop prevention
1041 $key = $table.':'.implode(':', array_keys($param)).':'.implode(':', $param);
1043 // We quit when this key already exists in the callstack.
1044 if (isset($callstack[$key])) {
1048 $callstack[$key] = true;
1050 $table = self::$dbo->escape($table);
1052 $commands[$key] = array('table' => $table, 'param' => $param);
1054 // To speed up the whole process we cache the table relations
1055 if (count(self::$relation) == 0) {
1056 self::build_relation_data();
1059 // Is there a relation entry for the table?
1060 if (isset(self::$relation[$table])) {
1061 // We only allow a simple "one field" relation.
1062 $field = array_keys(self::$relation[$table])[0];
1063 $rel_def = array_values(self::$relation[$table])[0];
1065 // Create a key for preventing double queries
1066 $qkey = $field.'-'.$table.':'.implode(':', array_keys($param)).':'.implode(':', $param);
1068 // When the search field is the relation field, we don't need to fetch the rows
1069 // This is useful when the leading record is already deleted in the frontend but the rest is done in the backend
1070 if ((count($param) == 1) && ($field == array_keys($param)[0])) {
1071 foreach ($rel_def AS $rel_table => $rel_fields) {
1072 foreach ($rel_fields AS $rel_field) {
1073 $retval = self::delete($rel_table, array($rel_field => array_values($param)[0]), true, $callstack);
1074 $commands = array_merge($commands, $retval);
1077 // We quit when this key already exists in the callstack.
1078 } elseif (!isset($callstack[$qkey])) {
1080 $callstack[$qkey] = true;
1082 // Fetch all rows that are to be deleted
1083 $sql = "SELECT ".self::$dbo->escape($field)." FROM `".$table."` WHERE `".
1084 implode("` = ? AND `", array_keys($param))."` = ?";
1086 $data = self::p($sql, $param);
1087 while ($row = self::fetch($data)) {
1088 // Now we accumulate the delete commands
1089 $retval = self::delete($table, array($field => $row[$field]), true, $callstack);
1090 $commands = array_merge($commands, $retval);
1093 // Since we had split the delete command we don't need the original command anymore
1094 unset($commands[$key]);
1099 // Now we finalize the process
1100 $do_transaction = !self::$in_transaction;
1102 if ($do_transaction) {
1103 self::transaction();
1106 $compacted = array();
1108 foreach ($commands AS $command) {
1109 if (count($command['param']) > 1) {
1110 $sql = "DELETE FROM `".$command['table']."` WHERE `".
1111 implode("` = ? AND `", array_keys($command['param']))."` = ?";
1113 logger(self::replace_parameters($sql, $command['param']), LOGGER_DATA);
1115 if (!self::e($sql, $command['param'])) {
1116 if ($do_transaction) {
1122 $key_table = $command['table'];
1123 $key_param = array_keys($command['param'])[0];
1124 $value = array_values($command['param'])[0];
1126 // Split the SQL queries in chunks of 100 values
1127 // We do the $i stuff here to make the code better readable
1128 $i = $counter[$key_table][$key_param];
1129 if (count($compacted[$key_table][$key_param][$i]) > 100) {
1133 $compacted[$key_table][$key_param][$i][$value] = $value;
1134 $counter[$key_table][$key_param] = $i;
1137 foreach ($compacted AS $table => $values) {
1138 foreach ($values AS $field => $field_value_list) {
1139 foreach ($field_value_list AS $field_values) {
1140 $sql = "DELETE FROM `".$table."` WHERE `".$field."` IN (".
1141 substr(str_repeat("?, ", count($field_values)), 0, -2).");";
1143 logger(self::replace_parameters($sql, $field_values), LOGGER_DATA);
1145 if (!self::e($sql, $field_values)) {
1146 if ($do_transaction) {
1154 if ($do_transaction) {
1164 * @brief Updates rows
1166 * Updates rows in the database. When $old_fields is set to an array,
1167 * the system will only do an update if the fields in that array changed.
1170 * Only the values in $old_fields are compared.
1171 * This is an intentional behaviour.
1174 * We include the timestamp field in $fields but not in $old_fields.
1175 * Then the row will only get the new timestamp when the other fields had changed.
1177 * When $old_fields is set to a boolean value the system will do this compare itself.
1178 * When $old_fields is set to "true" the system will do an insert if the row doesn't exists.
1181 * Only set $old_fields to a boolean value when you are sure that you will update a single row.
1182 * When you set $old_fields to "true" then $fields must contain all relevant fields!
1184 * @param string $table Table name
1185 * @param array $fields contains the fields that are updated
1186 * @param array $condition condition array with the key values
1187 * @param array|boolean $old_fields array with the old field values that are about to be replaced (true = update on duplicate)
1189 * @return boolean was the update successfull?
1191 static public function update($table, $fields, $condition, $old_fields = array()) {
1193 $table = self::$dbo->escape($table);
1195 if (count($condition) > 0) {
1196 $array_element = each($condition);
1197 $array_key = $array_element['key'];
1198 if (is_int($array_key)) {
1199 $condition_string = " WHERE ".array_shift($condition);
1201 $condition_string = " WHERE `".implode("` = ? AND `", array_keys($condition))."` = ?";
1204 $condition_string = "";
1207 if (is_bool($old_fields)) {
1208 $do_insert = $old_fields;
1210 $old_fields = self::select($table, array(), $condition, array('limit' => 1));
1212 if (is_bool($old_fields)) {
1214 $values = array_merge($condition, $fields);
1215 return self::insert($table, $values, $do_insert);
1217 $old_fields = array();
1221 $do_update = (count($old_fields) == 0);
1223 foreach ($old_fields AS $fieldname => $content) {
1224 if (isset($fields[$fieldname])) {
1225 if ($fields[$fieldname] == $content) {
1226 unset($fields[$fieldname]);
1233 if (!$do_update || (count($fields) == 0)) {
1237 $sql = "UPDATE `".$table."` SET `".
1238 implode("` = ?, `", array_keys($fields))."` = ?".$condition_string;
1240 $params1 = array_values($fields);
1241 $params2 = array_values($condition);
1242 $params = array_merge_recursive($params1, $params2);
1244 return self::e($sql, $params);
1248 * @brief Select rows from a table
1250 * @param string $table Table name
1251 * @param array $fields array of selected fields
1252 * @param array $condition array of fields for condition
1253 * @param array $params array of several parameters
1255 * @return boolean|object If "limit" is equal "1" only a single row is returned, else a query object is returned
1259 * $fields = array("id", "uri", "uid", "network");
1260 * $condition = array("uid" => 1, "network" => 'dspr');
1261 * $params = array("order" => array("id", "received" => true), "limit" => 1);
1263 * $data = dba::select($table, $fields, $condition, $params);
1265 static public function select($table, $fields = array(), $condition = array(), $params = array()) {
1270 if (count($fields) > 0) {
1271 $select_fields = "`".implode("`, `", array_values($fields))."`";
1273 $select_fields = "*";
1276 if (count($condition) > 0) {
1277 $array_element = each($condition);
1278 $array_key = $array_element['key'];
1279 if (is_int($array_key)) {
1280 $condition_string = " WHERE ".array_shift($condition);
1282 $condition_string = " WHERE `".implode("` = ? AND `", array_keys($condition))."` = ?";
1285 $condition_string = "";
1289 $single_row = false;
1291 if (isset($params['order'])) {
1292 $param_string .= " ORDER BY ";
1293 foreach ($params['order'] AS $fields => $order) {
1294 if (!is_int($fields)) {
1295 $param_string .= "`".$fields."` ".($order ? "DESC" : "ASC").", ";
1297 $param_string .= "`".$order."`, ";
1300 $param_string = substr($param_string, 0, -2);
1303 if (isset($params['limit']) && is_int($params['limit'])) {
1304 $param_string .= " LIMIT ".$params['limit'];
1305 $single_row = ($params['limit'] == 1);
1308 if (isset($params['only_query']) && $params['only_query']) {
1309 $single_row = !$params['only_query'];
1312 $sql = "SELECT ".$select_fields." FROM `".$table."`".$condition_string.$param_string;
1314 $result = self::p($sql, $condition);
1316 if (is_bool($result) || !$single_row) {
1319 $row = self::fetch($result);
1320 self::close($result);
1327 * @brief Fills an array with data from a query
1329 * @param object $stmt statement object
1330 * @return array Data array
1332 static public function inArray($stmt, $do_close = true) {
1334 while ($row = self::fetch($stmt)) {
1344 * @brief Closes the current statement
1346 * @param object $stmt statement object
1347 * @return boolean was the close successfull?
1349 static public function close($stmt) {
1350 if (!is_object($stmt)) {
1354 switch (self::$dbo->driver) {
1356 return $stmt->closeCursor();
1358 return $stmt->free_result();
1359 return $stmt->close();
1361 return mysql_free_result($stmt);
1366 function printable($s) {
1367 $s = preg_replace("~([\x01-\x08\x0E-\x0F\x10-\x1F\x7F-\xFF])~",".", $s);
1368 $s = str_replace("\x00",'.',$s);
1369 if (x($_SERVER,'SERVER_NAME')) {
1370 $s = escape_tags($s);
1375 // Procedural functions
1376 function dbg($state) {
1384 function dbesc($str) {
1387 if ($db && $db->connected) {
1388 return($db->escape($str));
1390 return(str_replace("'","\\'",$str));
1394 // Function: q($sql,$args);
1395 // Description: execute SQL query with printf style args.
1396 // Example: $r = q("SELECT * FROM `%s` WHERE `uid` = %d",
1400 $args = func_get_args();
1403 if ($db && $db->connected) {
1404 $sql = $db->clean_query($sql);
1405 $sql = $db->any_value_fallback($sql);
1406 $stmt = @vsprintf($sql,$args); // Disabled warnings
1407 //logger("dba: q: $stmt", LOGGER_ALL);
1408 if ($stmt === false)
1409 logger('dba: vsprintf error: ' . print_r(debug_backtrace(),true), LOGGER_DEBUG);
1411 $db->log_index($stmt);
1413 return $db->q($stmt);
1418 * This will happen occasionally trying to store the
1419 * session data after abnormal program termination
1422 logger('dba: no database: ' . print_r($args,true));
1427 * @brief Performs a query with "dirty reads"
1429 * By doing dirty reads (reading uncommitted data) no locks are performed
1430 * This function can be used to fetch data that doesn't need to be reliable.
1432 * @param $args Query parameters (1 to N parameters of different types)
1433 * @return array Query array
1438 $args = func_get_args();
1441 if ($db && $db->connected) {
1442 $sql = $db->clean_query($sql);
1443 $sql = $db->any_value_fallback($sql);
1444 $stmt = @vsprintf($sql,$args); // Disabled warnings
1445 if ($stmt === false)
1446 logger('dba: vsprintf error: ' . print_r(debug_backtrace(),true), LOGGER_DEBUG);
1448 $db->log_index($stmt);
1450 $db->q("SET SESSION TRANSACTION ISOLATION LEVEL READ UNCOMMITTED;");
1451 $retval = $db->q($stmt);
1452 $db->q("SET SESSION TRANSACTION ISOLATION LEVEL REPEATABLE READ;");
1458 * This will happen occasionally trying to store the
1459 * session data after abnormal program termination
1462 logger('dba: no database: ' . print_r($args,true));
1468 * Raw db query, no arguments
1471 function dbq($sql) {
1474 if ($db && $db->connected) {
1475 $ret = $db->q($sql);
1482 // Caller is responsible for ensuring that any integer arguments to
1483 // dbesc_array are actually integers and not malformed strings containing
1484 // SQL injection vectors. All integer array elements should be specifically
1485 // cast to int to avoid trouble.
1486 function dbesc_array_cb(&$item, $key) {
1487 if (is_string($item))
1488 $item = dbesc($item);
1491 function dbesc_array(&$arr) {
1492 if (is_array($arr) && count($arr)) {
1493 array_walk($arr,'dbesc_array_cb');
1497 function dba_timer() {
1498 return microtime(true);