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 insert_id() {
416 switch ($this->driver) {
418 $id = $this->db->lastInsertId();
421 $id = $this->db->insert_id;
424 $id = mysql_insert_id($this->db);
430 function __destruct() {
432 switch ($this->driver) {
440 mysql_close($this->db);
447 * @brief Replaces ANY_VALUE() function by MIN() function,
448 * if the database server does not support ANY_VALUE().
450 * Considerations for Standard SQL, or MySQL with ONLY_FULL_GROUP_BY (default since 5.7.5).
451 * ANY_VALUE() is available from MySQL 5.7.5 https://dev.mysql.com/doc/refman/5.7/en/miscellaneous-functions.html
452 * A standard fall-back is to use MIN().
454 * @param string $sql An SQL string without the values
455 * @return string The input SQL string modified if necessary.
457 public function any_value_fallback($sql) {
458 $server_info = $this->server_info();
459 if (version_compare($server_info, '5.7.5', '<') ||
460 (stripos($server_info, 'MariaDB') !== false)) {
461 $sql = str_ireplace('ANY_VALUE(', 'MIN(', $sql);
467 * @brief beautifies the query - useful for "SHOW PROCESSLIST"
469 * This is safe when we bind the parameters later.
470 * The parameter values aren't part of the SQL.
472 * @param string $sql An SQL string without the values
473 * @return string The input SQL string modified if necessary.
475 public function clean_query($sql) {
476 $search = array("\t", "\n", "\r", " ");
477 $replace = array(' ', ' ', ' ', ' ');
480 $sql = str_replace($search, $replace, $sql);
481 } while ($oldsql != $sql);
488 * @brief Replaces the ? placeholders with the parameters in the $args array
490 * @param string $sql SQL query
491 * @param array $args The parameters that are to replace the ? placeholders
492 * @return string The replaced SQL query
494 static private function replace_parameters($sql, $args) {
496 foreach ($args AS $param => $value) {
497 if (is_int($args[$param]) || is_float($args[$param])) {
498 $replace = intval($args[$param]);
500 $replace = "'".self::$dbo->escape($args[$param])."'";
503 $pos = strpos($sql, '?', $offset);
504 if ($pos !== false) {
505 $sql = substr_replace($sql, $replace, $pos, 1);
507 $offset = $pos + strlen($replace);
513 * @brief Convert parameter array to an universal form
514 * @param array $args Parameter array
515 * @return array universalized parameter array
517 private static function getParam($args) {
520 // When the second function parameter is an array then use this as the parameter array
521 if ((count($args) > 0) && (is_array($args[1]))) {
529 * @brief Executes a prepared statement that returns data
530 * @usage Example: $r = p("SELECT * FROM `item` WHERE `guid` = ?", $guid);
531 * @param string $sql SQL statement
532 * @return object statement object
534 static public function p($sql) {
537 $stamp1 = microtime(true);
539 $params = self::getParam(func_get_args());
541 // Renumber the array keys to be sure that they fit
544 foreach ($params AS $param) {
545 $args[++$i] = $param;
548 if (!self::$dbo || !self::$dbo->connected) {
552 if (substr_count($sql, '?') != count($args)) {
553 // Question: Should we continue or stop the query here?
554 logger('Parameter mismatch. Query "'.$sql.'" - Parameters '.print_r($args, true), LOGGER_DEBUG);
557 $sql = self::$dbo->clean_query($sql);
558 $sql = self::$dbo->any_value_fallback($sql);
562 if (x($a->config,'system') && x($a->config['system'], 'db_callstack')) {
563 $sql = "/*".$a->callstack()." */ ".$sql;
566 self::$dbo->error = '';
567 self::$dbo->errorno = 0;
568 self::$dbo->affected_rows = 0;
570 // We have to make some things different if this function is called from "e"
571 $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2);
573 if (isset($trace[1])) {
574 $called_from = $trace[1];
576 // We use just something that is defined to avoid warnings
577 $called_from = $trace[0];
579 // We are having an own error logging in the function "e"
580 $called_from_e = ($called_from['function'] == 'e');
582 switch (self::$dbo->driver) {
584 if (!$stmt = self::$dbo->db->prepare($sql)) {
585 $errorInfo = self::$dbo->db->errorInfo();
586 self::$dbo->error = $errorInfo[2];
587 self::$dbo->errorno = $errorInfo[1];
592 foreach ($args AS $param => $value) {
593 $stmt->bindParam($param, $args[$param]);
596 if (!$stmt->execute()) {
597 $errorInfo = $stmt->errorInfo();
598 self::$dbo->error = $errorInfo[2];
599 self::$dbo->errorno = $errorInfo[1];
603 self::$dbo->affected_rows = $retval->rowCount();
607 // There are SQL statements that cannot be executed with a prepared statement
608 $parts = explode(' ', $orig_sql);
609 $command = strtolower($parts[0]);
610 $can_be_prepared = in_array($command, array('select', 'update', 'insert', 'delete'));
612 // The fallback routine currently only works with statements that doesn't return values
613 if (!$can_be_prepared && $called_from_e) {
614 $retval = self::$dbo->db->query(self::replace_parameters($sql, $args));
615 if (self::$dbo->db->errno) {
616 self::$dbo->error = self::$dbo->db->error;
617 self::$dbo->errorno = self::$dbo->db->errno;
620 if (isset($retval->num_rows)) {
621 self::$dbo->affected_rows = $retval->num_rows;
623 self::$dbo->affected_rows = self::$dbo->db->affected_rows;
629 $stmt = self::$dbo->db->stmt_init();
631 if (!$stmt->prepare($sql)) {
632 self::$dbo->error = $stmt->error;
633 self::$dbo->errorno = $stmt->errno;
640 foreach ($args AS $param => $value) {
641 if (is_int($args[$param])) {
643 } elseif (is_float($args[$param])) {
645 } elseif (is_string($args[$param])) {
650 $values[] = &$args[$param];
653 if (count($values) > 0) {
654 array_unshift($values, $params);
655 call_user_func_array(array($stmt, 'bind_param'), $values);
658 if (!$stmt->execute()) {
659 self::$dbo->error = self::$dbo->db->error;
660 self::$dbo->errorno = self::$dbo->db->errno;
663 $stmt->store_result();
665 self::$dbo->affected_rows = $retval->affected_rows;
669 // For the old "mysql" functions we cannot use prepared statements
670 $retval = mysql_query(self::replace_parameters($sql, $args), self::$dbo->db);
671 if (mysql_errno(self::$dbo->db)) {
672 self::$dbo->error = mysql_error(self::$dbo->db);
673 self::$dbo->errorno = mysql_errno(self::$dbo->db);
675 self::$dbo->affected_rows = mysql_affected_rows($retval);
677 // Due to missing mysql_* support this here wasn't tested at all
678 // See here: http://php.net/manual/en/function.mysql-num-rows.php
679 if (self::$dbo->affected_rows <= 0) {
680 self::$dbo->affected_rows = mysql_num_rows($retval);
686 // We are having an own error logging in the function "e"
687 if ((self::$dbo->errorno != 0) && !$called_from_e) {
688 // We have to preserve the error code, somewhere in the logging it get lost
689 $error = self::$dbo->error;
690 $errorno = self::$dbo->errorno;
692 logger('DB Error '.self::$dbo->errorno.': '.self::$dbo->error."\n".
693 $a->callstack(8)."\n".self::replace_parameters($sql, $params));
695 self::$dbo->error = $error;
696 self::$dbo->errorno = $errorno;
699 $a->save_timestamp($stamp1, 'database');
701 if (x($a->config,'system') && x($a->config['system'], 'db_log')) {
703 $stamp2 = microtime(true);
704 $duration = (float)($stamp2 - $stamp1);
706 if (($duration > $a->config["system"]["db_loglimit"])) {
707 $duration = round($duration, 3);
708 $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
710 @file_put_contents($a->config["system"]["db_log"], datetime_convert()."\t".$duration."\t".
711 basename($backtrace[1]["file"])."\t".
712 $backtrace[1]["line"]."\t".$backtrace[2]["function"]."\t".
713 substr(self::replace_parameters($sql, $args), 0, 2000)."\n", FILE_APPEND);
720 * @brief Executes a prepared statement like UPDATE or INSERT that doesn't return data
722 * @param string $sql SQL statement
723 * @return boolean Was the query successfull? False is returned only if an error occurred
725 static public function e($sql) {
728 $stamp = microtime(true);
730 $params = self::getParam(func_get_args());
732 // In a case of a deadlock we are repeating the query 20 times
736 $stmt = self::p($sql, $params);
738 if (is_bool($stmt)) {
740 } elseif (is_object($stmt)) {
748 } while ((self::$dbo->errorno == 1213) && (--$timeout > 0));
750 if (self::$dbo->errorno != 0) {
751 // We have to preserve the error code, somewhere in the logging it get lost
752 $error = self::$dbo->error;
753 $errorno = self::$dbo->errorno;
755 logger('DB Error '.self::$dbo->errorno.': '.self::$dbo->error."\n".
756 $a->callstack(8)."\n".self::replace_parameters($sql, $params));
758 self::$dbo->error = $error;
759 self::$dbo->errorno = $errorno;
762 $a->save_timestamp($stamp, "database_write");
768 * @brief Check if data exists
770 * @param string $sql SQL statement
771 * @return boolean Are there rows for that query?
773 static public function exists($sql) {
774 $params = self::getParam(func_get_args());
776 $stmt = self::p($sql, $params);
778 if (is_bool($stmt)) {
781 $retval = (self::num_rows($stmt) > 0);
790 * @brief Fetches the first row
792 * @param string $sql SQL statement
793 * @return array first row of query
795 static public function fetch_first($sql) {
796 $params = self::getParam(func_get_args());
798 $stmt = self::p($sql, $params);
800 if (is_bool($stmt)) {
803 $retval = self::fetch($stmt);
812 * @brief Returns the number of affected rows of the last statement
814 * @return int Number of rows
816 static public function affected_rows() {
817 return self::$dbo->affected_rows;
821 * @brief Returns the number of rows of a statement
823 * @param object Statement object
824 * @return int Number of rows
826 static public function num_rows($stmt) {
827 if (!is_object($stmt)) {
830 switch (self::$dbo->driver) {
832 return $stmt->rowCount();
834 return $stmt->num_rows;
836 return mysql_num_rows($stmt);
842 * @brief Fetch a single row
844 * @param object $stmt statement object
845 * @return array current row
847 static public function fetch($stmt) {
848 if (!is_object($stmt)) {
852 switch (self::$dbo->driver) {
854 return $stmt->fetch(PDO::FETCH_ASSOC);
856 // This code works, but is slow
858 // Bind the result to a result array
862 for ($x = 0; $x < $stmt->field_count; $x++) {
863 $cols[] = &$cols_num[$x];
866 call_user_func_array(array($stmt, 'bind_result'), $cols);
868 if (!$stmt->fetch()) {
873 // We need to get the field names for the array keys
874 // It seems that there is no better way to do this.
875 $result = $stmt->result_metadata();
876 $fields = $result->fetch_fields();
879 foreach ($cols_num AS $param => $col) {
880 $columns[$fields[$param]->name] = $col;
884 return mysql_fetch_array(self::$dbo->result, MYSQL_ASSOC);
889 * @brief Insert a row into a table
891 * @param string $table Table name
892 * @param array $param parameter array
893 * @param bool $on_duplicate_update Do an update on a duplicate entry
895 * @return boolean was the insert successfull?
897 static public function insert($table, $param, $on_duplicate_update = false) {
898 $sql = "INSERT INTO `".self::$dbo->escape($table)."` (`".implode("`, `", array_keys($param))."`) VALUES (".
899 substr(str_repeat("?, ", count($param)), 0, -2).")";
901 if ($on_duplicate_update) {
902 $sql .= " ON DUPLICATE KEY UPDATE `".implode("` = ?, `", array_keys($param))."` = ?";
904 $values = array_values($param);
905 $param = array_merge_recursive($values, $values);
908 return self::e($sql, $param);
912 * @brief Locks a table for exclusive write access
914 * This function can be extended in the future to accept a table array as well.
916 * @param string $table Table name
918 * @return boolean was the lock successful?
920 static public function lock($table) {
921 // See here: https://dev.mysql.com/doc/refman/5.7/en/lock-tables-and-transactions.html
922 self::e("SET autocommit=0");
923 $success = self::e("LOCK TABLES `".self::$dbo->escape($table)."` WRITE");
925 self::e("SET autocommit=1");
927 self::$in_transaction = true;
933 * @brief Unlocks all locked tables
935 * @return boolean was the unlock successful?
937 static public function unlock() {
938 // See here: https://dev.mysql.com/doc/refman/5.7/en/lock-tables-and-transactions.html
940 $success = self::e("UNLOCK TABLES");
941 self::e("SET autocommit=1");
942 self::$in_transaction = false;
947 * @brief Starts a transaction
949 * @return boolean Was the command executed successfully?
951 static public function transaction() {
952 if (!self::e('COMMIT')) {
955 if (!self::e('START TRANSACTION')) {
958 self::$in_transaction = true;
963 * @brief Does a commit
965 * @return boolean Was the command executed successfully?
967 static public function commit() {
968 if (!self::e('COMMIT')) {
971 self::$in_transaction = false;
976 * @brief Does a rollback
978 * @return boolean Was the command executed successfully?
980 static public function rollback() {
981 if (!self::e('ROLLBACK')) {
984 self::$in_transaction = false;
989 * @brief Build the array with the table relations
991 * The array is build from the database definitions in dbstructure.php
993 * This process must only be started once, since the value is cached.
995 static private function build_relation_data() {
996 $definition = db_definition();
998 foreach ($definition AS $table => $structure) {
999 foreach ($structure['fields'] AS $field => $field_struct) {
1000 if (isset($field_struct['relation'])) {
1001 foreach ($field_struct['relation'] AS $rel_table => $rel_field) {
1002 self::$relation[$rel_table][$rel_field][$table][] = $field;
1010 * @brief Delete a row from a table
1012 * @param string $table Table name
1013 * @param array $param parameter array
1014 * @param boolean $in_process Internal use: Only do a commit after the last delete
1015 * @param array $callstack Internal use: prevent endless loops
1017 * @return boolean|array was the delete successfull? When $in_process is set: deletion data
1019 static public function delete($table, $param, $in_process = false, &$callstack = array()) {
1021 $commands = array();
1023 // Create a key for the loop prevention
1024 $key = $table.':'.implode(':', array_keys($param)).':'.implode(':', $param);
1026 // We quit when this key already exists in the callstack.
1027 if (isset($callstack[$key])) {
1031 $callstack[$key] = true;
1033 $table = self::$dbo->escape($table);
1035 $commands[$key] = array('table' => $table, 'param' => $param);
1037 // To speed up the whole process we cache the table relations
1038 if (count(self::$relation) == 0) {
1039 self::build_relation_data();
1042 // Is there a relation entry for the table?
1043 if (isset(self::$relation[$table])) {
1044 // We only allow a simple "one field" relation.
1045 $field = array_keys(self::$relation[$table])[0];
1046 $rel_def = array_values(self::$relation[$table])[0];
1048 // Create a key for preventing double queries
1049 $qkey = $field.'-'.$table.':'.implode(':', array_keys($param)).':'.implode(':', $param);
1051 // When the search field is the relation field, we don't need to fetch the rows
1052 // This is useful when the leading record is already deleted in the frontend but the rest is done in the backend
1053 if ((count($param) == 1) && ($field == array_keys($param)[0])) {
1054 foreach ($rel_def AS $rel_table => $rel_fields) {
1055 foreach ($rel_fields AS $rel_field) {
1056 $retval = self::delete($rel_table, array($rel_field => array_values($param)[0]), true, $callstack);
1057 $commands = array_merge($commands, $retval);
1060 // We quit when this key already exists in the callstack.
1061 } elseif (!isset($callstack[$qkey])) {
1063 $callstack[$qkey] = true;
1065 // Fetch all rows that are to be deleted
1066 $sql = "SELECT ".self::$dbo->escape($field)." FROM `".$table."` WHERE `".
1067 implode("` = ? AND `", array_keys($param))."` = ?";
1069 $data = self::p($sql, $param);
1070 while ($row = self::fetch($data)) {
1071 // Now we accumulate the delete commands
1072 $retval = self::delete($table, array($field => $row[$field]), true, $callstack);
1073 $commands = array_merge($commands, $retval);
1076 // Since we had split the delete command we don't need the original command anymore
1077 unset($commands[$key]);
1082 // Now we finalize the process
1083 $do_transaction = !self::$in_transaction;
1085 if ($do_transaction) {
1086 self::transaction();
1089 $compacted = array();
1091 foreach ($commands AS $command) {
1092 if (count($command['param']) > 1) {
1093 $sql = "DELETE FROM `".$command['table']."` WHERE `".
1094 implode("` = ? AND `", array_keys($command['param']))."` = ?";
1096 logger(self::replace_parameters($sql, $command['param']), LOGGER_DATA);
1098 if (!self::e($sql, $command['param'])) {
1099 if ($do_transaction) {
1105 $key_table = $command['table'];
1106 $key_param = array_keys($command['param'])[0];
1107 $value = array_values($command['param'])[0];
1109 // Split the SQL queries in chunks of 100 values
1110 // We do the $i stuff here to make the code better readable
1111 $i = $counter[$key_table][$key_param];
1112 if (count($compacted[$key_table][$key_param][$i]) > 100) {
1116 $compacted[$key_table][$key_param][$i][$value] = $value;
1117 $counter[$key_table][$key_param] = $i;
1120 foreach ($compacted AS $table => $values) {
1121 foreach ($values AS $field => $field_value_list) {
1122 foreach ($field_value_list AS $field_values) {
1123 $sql = "DELETE FROM `".$table."` WHERE `".$field."` IN (".
1124 substr(str_repeat("?, ", count($field_values)), 0, -2).");";
1126 logger(self::replace_parameters($sql, $field_values), LOGGER_DATA);
1128 if (!self::e($sql, $field_values)) {
1129 if ($do_transaction) {
1137 if ($do_transaction) {
1147 * @brief Updates rows
1149 * Updates rows in the database. When $old_fields is set to an array,
1150 * the system will only do an update if the fields in that array changed.
1153 * Only the values in $old_fields are compared.
1154 * This is an intentional behaviour.
1157 * We include the timestamp field in $fields but not in $old_fields.
1158 * Then the row will only get the new timestamp when the other fields had changed.
1160 * When $old_fields is set to a boolean value the system will do this compare itself.
1161 * When $old_fields is set to "true" the system will do an insert if the row doesn't exists.
1164 * Only set $old_fields to a boolean value when you are sure that you will update a single row.
1165 * When you set $old_fields to "true" then $fields must contain all relevant fields!
1167 * @param string $table Table name
1168 * @param array $fields contains the fields that are updated
1169 * @param array $condition condition array with the key values
1170 * @param array|boolean $old_fields array with the old field values that are about to be replaced (true = update on duplicate)
1172 * @return boolean was the update successfull?
1174 static public function update($table, $fields, $condition, $old_fields = array()) {
1176 $table = self::$dbo->escape($table);
1178 if (is_bool($old_fields)) {
1179 $sql = "SELECT * FROM `".$table."` WHERE `".
1180 implode("` = ? AND `", array_keys($condition))."` = ? LIMIT 1";
1182 $params = array_values($condition);
1184 $do_insert = $old_fields;
1186 $old_fields = self::fetch_first($sql, $params);
1187 if (is_bool($old_fields)) {
1189 $values = array_merge($condition, $fields);
1190 return self::insert($table, $values, $do_insert);
1192 $old_fields = array();
1196 $do_update = (count($old_fields) == 0);
1198 foreach ($old_fields AS $fieldname => $content) {
1199 if (isset($fields[$fieldname])) {
1200 if ($fields[$fieldname] == $content) {
1201 unset($fields[$fieldname]);
1208 if (!$do_update || (count($fields) == 0)) {
1212 $sql = "UPDATE `".$table."` SET `".
1213 implode("` = ?, `", array_keys($fields))."` = ? WHERE `".
1214 implode("` = ? AND `", array_keys($condition))."` = ?";
1216 $params1 = array_values($fields);
1217 $params2 = array_values($condition);
1218 $params = array_merge_recursive($params1, $params2);
1220 return self::e($sql, $params);
1224 * @brief Select rows from a table
1226 * @param string $table Table name
1227 * @param array $fields array of selected fields
1228 * @param array $condition array of fields for condition
1229 * @param array $params array of several parameters
1231 * @return boolean|object If "limit" is equal "1" only a single row is returned, else a query object is returned
1235 * $fields = array("id", "uri", "uid", "network");
1236 * $condition = array("uid" => 1, "network" => 'dspr');
1237 * $params = array("order" => array("id", "received" => true), "limit" => 1);
1239 * $data = dba::select($table, $fields, $condition, $params);
1241 static public function select($table, $fields = array(), $condition = array(), $params = array()) {
1246 if (count($fields) > 0) {
1247 $select_fields = "`".implode("`, `", array_values($fields))."`";
1249 $select_fields = "*";
1252 if (count($condition) > 0) {
1253 $condition_string = " WHERE `".implode("` = ? AND `", array_keys($condition))."` = ?";
1255 $condition_string = "";
1259 $single_row = false;
1261 if (isset($params['order'])) {
1262 $param_string .= " ORDER BY ";
1263 foreach ($params['order'] AS $fields => $order) {
1264 if (!is_int($fields)) {
1265 $param_string .= "`".$fields."` ".($order ? "DESC" : "ASC").", ";
1267 $param_string .= "`".$order."`, ";
1270 $param_string = substr($param_string, 0, -2);
1273 if (isset($params['limit'])) {
1274 if (is_int($params['limit'])) {
1275 $param_string .= " LIMIT ".$params['limit'];
1276 $single_row =($params['limit'] == 1);
1280 $sql = "SELECT ".$select_fields." FROM `".$table."`".$condition_string.$param_string;
1282 $result = self::p($sql, $condition);
1284 if (is_bool($result) || !$single_row) {
1287 $row = self::fetch($result);
1288 self::close($result);
1294 * @brief Closes the current statement
1296 * @param object $stmt statement object
1297 * @return boolean was the close successfull?
1299 static public function close($stmt) {
1300 if (!is_object($stmt)) {
1304 switch (self::$dbo->driver) {
1306 return $stmt->closeCursor();
1308 return $stmt->free_result();
1309 return $stmt->close();
1311 return mysql_free_result($stmt);
1316 function printable($s) {
1317 $s = preg_replace("~([\x01-\x08\x0E-\x0F\x10-\x1F\x7F-\xFF])~",".", $s);
1318 $s = str_replace("\x00",'.',$s);
1319 if (x($_SERVER,'SERVER_NAME')) {
1320 $s = escape_tags($s);
1325 // Procedural functions
1326 function dbg($state) {
1334 function dbesc($str) {
1337 if ($db && $db->connected) {
1338 return($db->escape($str));
1340 return(str_replace("'","\\'",$str));
1344 // Function: q($sql,$args);
1345 // Description: execute SQL query with printf style args.
1346 // Example: $r = q("SELECT * FROM `%s` WHERE `uid` = %d",
1350 $args = func_get_args();
1353 if ($db && $db->connected) {
1354 $sql = $db->clean_query($sql);
1355 $sql = $db->any_value_fallback($sql);
1356 $stmt = @vsprintf($sql,$args); // Disabled warnings
1357 //logger("dba: q: $stmt", LOGGER_ALL);
1358 if ($stmt === false)
1359 logger('dba: vsprintf error: ' . print_r(debug_backtrace(),true), LOGGER_DEBUG);
1361 $db->log_index($stmt);
1363 return $db->q($stmt);
1368 * This will happen occasionally trying to store the
1369 * session data after abnormal program termination
1372 logger('dba: no database: ' . print_r($args,true));
1377 * @brief Performs a query with "dirty reads"
1379 * By doing dirty reads (reading uncommitted data) no locks are performed
1380 * This function can be used to fetch data that doesn't need to be reliable.
1382 * @param $args Query parameters (1 to N parameters of different types)
1383 * @return array Query array
1388 $args = func_get_args();
1391 if ($db && $db->connected) {
1392 $sql = $db->clean_query($sql);
1393 $sql = $db->any_value_fallback($sql);
1394 $stmt = @vsprintf($sql,$args); // Disabled warnings
1395 if ($stmt === false)
1396 logger('dba: vsprintf error: ' . print_r(debug_backtrace(),true), LOGGER_DEBUG);
1398 $db->log_index($stmt);
1400 $db->q("SET SESSION TRANSACTION ISOLATION LEVEL READ UNCOMMITTED;");
1401 $retval = $db->q($stmt);
1402 $db->q("SET SESSION TRANSACTION ISOLATION LEVEL REPEATABLE READ;");
1408 * This will happen occasionally trying to store the
1409 * session data after abnormal program termination
1412 logger('dba: no database: ' . print_r($args,true));
1418 * Raw db query, no arguments
1421 function dbq($sql) {
1424 if ($db && $db->connected) {
1425 $ret = $db->q($sql);
1432 // Caller is responsible for ensuring that any integer arguments to
1433 // dbesc_array are actually integers and not malformed strings containing
1434 // SQL injection vectors. All integer array elements should be specifically
1435 // cast to int to avoid trouble.
1436 function dbesc_array_cb(&$item, $key) {
1437 if (is_string($item))
1438 $item = dbesc($item);
1441 function dbesc_array(&$arr) {
1442 if (is_array($arr) && count($arr)) {
1443 array_walk($arr,'dbesc_array_cb');
1447 function dba_timer() {
1448 return microtime(true);