<?php
-require_once("dbm.php");
+use \Friendica\Core\System;
+use Friendica\Database\DBM;
+
require_once('include/datetime.php');
/**
* @class MySQL database class
*
- * For debugging, insert 'dbg(1);' anywhere in the program flow.
- * dbg(0); will turn it off. Logging is performed at LOGGER_DATA level.
- * When logging, all binary info is converted to text and html entities are escaped so that
- * the debugging stream is safe to view within both terminals and web pages.
- *
* This class is for the low level database stuff that does driver specific things.
*/
class dba {
-
- private $debug = 0;
- private $db;
- private $result;
- private $driver;
- public $connected = false;
- public $error = false;
- private $_server_info = '';
+ public static $connected = true;
+
+ private static $_server_info = '';
+ private static $db;
+ private static $driver;
+ private static $error = false;
+ private static $errorno = 0;
+ private static $affected_rows = 0;
private static $in_transaction = false;
- private static $dbo;
private static $relation = array();
- function __construct($serveraddr, $user, $pass, $db, $install = false) {
+ public static function connect($serveraddr, $user, $pass, $db, $install = false) {
+ if (!is_null(self::$db)) {
+ return true;
+ }
+
$a = get_app();
$stamp1 = microtime(true);
$db = trim($db);
if (!(strlen($server) && strlen($user))) {
- $this->connected = false;
- $this->db = null;
- return;
+ self::$connected = false;
+ self::$db = null;
+ return false;
}
if ($install) {
if (strlen($server) && ($server !== 'localhost') && ($server !== '127.0.0.1')) {
if (! dns_get_record($server, DNS_A + DNS_CNAME + DNS_PTR)) {
- $this->error = sprintf(t('Cannot locate DNS info for database server \'%s\''), $server);
- $this->connected = false;
- $this->db = null;
- return;
+ self::$error = sprintf(t('Cannot locate DNS info for database server \'%s\''), $server);
+ self::$connected = false;
+ self::$db = null;
+ return false;
}
}
}
if (class_exists('\PDO') && in_array('mysql', PDO::getAvailableDrivers())) {
- $this->driver = 'pdo';
+ self::$driver = 'pdo';
$connect = "mysql:host=".$server.";dbname=".$db;
if (isset($port)) {
if (isset($a->config["system"]["db_charset"])) {
$connect .= ";charset=".$a->config["system"]["db_charset"];
}
- $this->db = @new PDO($connect, $user, $pass);
- if (!$this->db->errorCode()) {
- $this->connected = true;
+ try {
+ self::$db = @new PDO($connect, $user, $pass);
+ self::$connected = true;
+ } catch (PDOException $e) {
+ self::$connected = false;
}
- } elseif (class_exists('mysqli')) {
- $this->driver = 'mysqli';
- $this->db = @new mysqli($server, $user, $pass, $db, $port);
- if (!mysqli_connect_errno()) {
- $this->connected = true;
+ }
- if (isset($a->config["system"]["db_charset"])) {
- $this->db->set_charset($a->config["system"]["db_charset"]);
- }
- }
- } elseif (function_exists('mysql_connect')) {
- $this->driver = 'mysql';
- $this->db = mysql_connect($serveraddr, $user, $pass);
- if ($this->db && mysql_select_db($db, $this->db)) {
- $this->connected = true;
+ if (!self::$connected && class_exists('mysqli')) {
+ self::$driver = 'mysqli';
+ self::$db = @new mysqli($server, $user, $pass, $db, $port);
+ if (!mysqli_connect_errno()) {
+ self::$connected = true;
if (isset($a->config["system"]["db_charset"])) {
- mysql_set_charset($a->config["system"]["db_charset"], $this->db);
+ self::$db->set_charset($a->config["system"]["db_charset"]);
}
}
- } else {
- // No suitable SQL driver was found.
- if (!$install) {
- system_unavailable();
- }
}
- if (!$this->connected) {
- $this->db = null;
+ // No suitable SQL driver was found.
+ if (!self::$connected) {
+ self::$db = null;
if (!$install) {
- system_unavailable();
+ System::unavailable();
}
}
$a->save_timestamp($stamp1, "network");
- self::$dbo = $this;
+ return true;
}
/**
* @brief Returns the MySQL server version string
- *
+ *
* This function discriminate between the deprecated mysql API and the current
* object-oriented mysqli API. Example of returned string: 5.5.46-0+deb8u1
*
* @return string
*/
- public function server_info() {
- if ($this->_server_info == '') {
- switch ($this->driver) {
+ public static function server_info() {
+ if (self::$_server_info == '') {
+ switch (self::$driver) {
case 'pdo':
- $this->_server_info = $this->db->getAttribute(PDO::ATTR_SERVER_VERSION);
+ self::$_server_info = self::$db->getAttribute(PDO::ATTR_SERVER_VERSION);
break;
case 'mysqli':
- $this->_server_info = $this->db->server_info;
- break;
- case 'mysql':
- $this->_server_info = mysql_get_server_info($this->db);
+ self::$_server_info = self::$db->server_info;
break;
}
}
- return $this->_server_info;
+ return self::$_server_info;
}
/**
*
* @return string
*/
- public function database_name() {
- $r = $this->q("SELECT DATABASE() AS `db`");
-
- return $r[0]['db'];
+ public static function database_name() {
+ $ret = self::p("SELECT DATABASE() AS `db`");
+ $data = self::inArray($ret);
+ return $data[0]['db'];
}
/**
*
* @param string $query The database query that will be analyzed
*/
- public function log_index($query) {
+ private static function log_index($query) {
$a = get_app();
- if ($a->config["system"]["db_log_index"] == "") {
+ if (empty($a->config["system"]["db_log_index"])) {
return;
}
return;
}
- $r = $this->q("EXPLAIN ".$query);
- if (!dbm::is_result($r)) {
+ $r = self::p("EXPLAIN ".$query);
+ if (!DBM::is_result($r)) {
return;
}
$watchlist = explode(',', $a->config["system"]["db_log_index_watch"]);
$blacklist = explode(',', $a->config["system"]["db_log_index_blacklist"]);
- foreach ($r AS $row) {
+ while ($row = dba::fetch($r)) {
if ((intval($a->config["system"]["db_loglimit_index"]) > 0)) {
- $log = (in_array($row['key'], $watchlist) AND
+ $log = (in_array($row['key'], $watchlist) &&
($row['rows'] >= intval($a->config["system"]["db_loglimit_index"])));
} else {
$log = false;
}
- if ((intval($a->config["system"]["db_loglimit_index_high"]) > 0) AND ($row['rows'] >= intval($a->config["system"]["db_loglimit_index_high"]))) {
+ if ((intval($a->config["system"]["db_loglimit_index_high"]) > 0) && ($row['rows'] >= intval($a->config["system"]["db_loglimit_index_high"]))) {
$log = true;
}
- if (in_array($row['key'], $blacklist) OR ($row['key'] == "")) {
+ if (in_array($row['key'], $blacklist) || ($row['key'] == "")) {
$log = false;
}
}
}
- public function q($sql, $onlyquery = false) {
- $a = get_app();
-
- if (!$this->db || !$this->connected) {
- return false;
- }
-
- $this->error = '';
-
- $connstr = ($this->connected() ? "Connected" : "Disonnected");
-
- $stamp1 = microtime(true);
-
- $orig_sql = $sql;
-
- if (x($a->config,'system') && x($a->config['system'], 'db_callstack')) {
- $sql = "/*".$a->callstack()." */ ".$sql;
- }
-
- $columns = 0;
-
- switch ($this->driver) {
- case 'pdo':
- $result = @$this->db->query($sql);
- // Is used to separate between queries that returning data - or not
- if (!is_bool($result)) {
- $columns = $result->columnCount();
- }
- break;
- case 'mysqli':
- $result = @$this->db->query($sql);
- break;
- case 'mysql':
- $result = @mysql_query($sql,$this->db);
- break;
- }
- $stamp2 = microtime(true);
- $duration = (float)($stamp2 - $stamp1);
-
- $a->save_timestamp($stamp1, "database");
-
- if (strtolower(substr($orig_sql, 0, 6)) != "select") {
- $a->save_timestamp($stamp1, "database_write");
- }
- if (x($a->config,'system') && x($a->config['system'],'db_log')) {
- if (($duration > $a->config["system"]["db_loglimit"])) {
- $duration = round($duration, 3);
- $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
- @file_put_contents($a->config["system"]["db_log"], datetime_convert()."\t".$duration."\t".
- basename($backtrace[1]["file"])."\t".
- $backtrace[1]["line"]."\t".$backtrace[2]["function"]."\t".
- substr($sql, 0, 2000)."\n", FILE_APPEND);
- }
- }
-
- switch ($this->driver) {
+ public static function escape($str) {
+ switch (self::$driver) {
case 'pdo':
- $errorInfo = $this->db->errorInfo();
- if ($errorInfo) {
- $this->error = $errorInfo[2];
- $this->errorno = $errorInfo[1];
- }
- break;
- case 'mysqli':
- if ($this->db->errno) {
- $this->error = $this->db->error;
- $this->errorno = $this->db->errno;
- }
- break;
- case 'mysql':
- if (mysql_errno($this->db)) {
- $this->error = mysql_error($this->db);
- $this->errorno = mysql_errno($this->db);
- }
- break;
- }
- if (strlen($this->error)) {
- logger('DB Error ('.$connstr.') '.$this->errorno.': '.$this->error);
- }
-
- if ($this->debug) {
-
- $mesg = '';
-
- if ($result === false) {
- $mesg = 'false';
- } elseif ($result === true) {
- $mesg = 'true';
- } else {
- switch ($this->driver) {
- case 'pdo':
- $mesg = $result->rowCount().' results'.EOL;
- break;
- case 'mysqli':
- $mesg = $result->num_rows.' results'.EOL;
- break;
- case 'mysql':
- $mesg = mysql_num_rows($result).' results'.EOL;
- break;
- }
- }
-
- $str = 'SQL = ' . printable($sql) . EOL . 'SQL returned ' . $mesg
- . (($this->error) ? ' error: ' . $this->error : '')
- . EOL;
-
- logger('dba: ' . $str );
- }
-
- /**
- * If dbfail.out exists, we will write any failed calls directly to it,
- * regardless of any logging that may or may nor be in effect.
- * These usually indicate SQL syntax errors that need to be resolved.
- */
-
- if ($result === false) {
- logger('dba: ' . printable($sql) . ' returned false.' . "\n" . $this->error);
- if (file_exists('dbfail.out')) {
- file_put_contents('dbfail.out', datetime_convert() . "\n" . printable($sql) . ' returned false' . "\n" . $this->error . "\n", FILE_APPEND);
- }
- }
-
- if (is_bool($result)) {
- return $result;
- }
- if ($onlyquery) {
- $this->result = $result;
- return true;
- }
-
- $r = array();
- switch ($this->driver) {
- case 'pdo':
- while ($x = $result->fetch(PDO::FETCH_ASSOC)) {
- $r[] = $x;
- }
- $result->closeCursor();
- break;
+ return substr(@self::$db->quote($str, PDO::PARAM_STR), 1, -1);
case 'mysqli':
- while ($x = $result->fetch_array(MYSQLI_ASSOC)) {
- $r[] = $x;
- }
- $result->free_result();
- break;
- case 'mysql':
- while ($x = mysql_fetch_array($result, MYSQL_ASSOC)) {
- $r[] = $x;
- }
- mysql_free_result($result);
- break;
- }
-
- // PDO doesn't return "true" on successful operations - like mysqli does
- // Emulate this behaviour by checking if the query returned data and had columns
- // This should be reliable enough
- if (($this->driver == 'pdo') AND (count($r) == 0) AND ($columns == 0)) {
- return true;
- }
-
- //$a->save_timestamp($stamp1, "database");
-
- if ($this->debug) {
- logger('dba: ' . printable(print_r($r, true)));
+ return @self::$db->real_escape_string($str);
}
- return($r);
}
- public function dbg($dbg) {
- $this->debug = $dbg;
- }
+ public static function connected() {
+ $connected = false;
- public function escape($str) {
- if ($this->db && $this->connected) {
- switch ($this->driver) {
- case 'pdo':
- return substr(@$this->db->quote($str, PDO::PARAM_STR), 1, -1);
- case 'mysqli':
- return @$this->db->real_escape_string($str);
- case 'mysql':
- return @mysql_real_escape_string($str,$this->db);
- }
- }
- }
-
- function connected() {
- switch ($this->driver) {
+ switch (self::$driver) {
case 'pdo':
- // Not sure if this really is working like expected
- $connected = ($this->db->getAttribute(PDO::ATTR_CONNECTION_STATUS) != "");
+ $r = dba::p("SELECT 1");
+ if (DBM::is_result($r)) {
+ $row = dba::inArray($r);
+ $connected = ($row[0]['1'] == '1');
+ }
break;
case 'mysqli':
- $connected = $this->db->ping();
- break;
- case 'mysql':
- $connected = mysql_ping($this->db);
+ $connected = self::$db->ping();
break;
}
return $connected;
}
- function insert_id() {
- switch ($this->driver) {
- case 'pdo':
- $id = $this->db->lastInsertId();
- break;
- case 'mysqli':
- $id = $this->db->insert_id;
- break;
- case 'mysql':
- $id = mysql_insert_id($this->db);
- break;
- }
- return $id;
- }
-
- function __destruct() {
- if ($this->db) {
- switch ($this->driver) {
- case 'pdo':
- $this->db = null;
- break;
- case 'mysqli':
- $this->db->close();
- break;
- case 'mysql':
- mysql_close($this->db);
- break;
- }
- }
- }
-
/**
* @brief Replaces ANY_VALUE() function by MIN() function,
* if the database server does not support ANY_VALUE().
* @param string $sql An SQL string without the values
* @return string The input SQL string modified if necessary.
*/
- public function any_value_fallback($sql) {
- $server_info = $this->server_info();
+ public static function any_value_fallback($sql) {
+ $server_info = self::server_info();
if (version_compare($server_info, '5.7.5', '<') ||
(stripos($server_info, 'MariaDB') !== false)) {
$sql = str_ireplace('ANY_VALUE(', 'MIN(', $sql);
* @param string $sql An SQL string without the values
* @return string The input SQL string modified if necessary.
*/
- public function clean_query($sql) {
+ public static function clean_query($sql) {
$search = array("\t", "\n", "\r", " ");
$replace = array(' ', ' ', ' ', ' ');
do {
* @param array $args The parameters that are to replace the ? placeholders
* @return string The replaced SQL query
*/
- static private function replace_parameters($sql, $args) {
+ private static function replace_parameters($sql, $args) {
$offset = 0;
foreach ($args AS $param => $value) {
- if (is_int($args[$param]) OR is_float($args[$param])) {
+ if (is_int($args[$param]) || is_float($args[$param])) {
$replace = intval($args[$param]);
} else {
- $replace = "'".self::$dbo->escape($args[$param])."'";
+ $replace = "'".self::escape($args[$param])."'";
}
$pos = strpos($sql, '?', $offset);
return $sql;
}
+ /**
+ * @brief Convert parameter array to an universal form
+ * @param array $args Parameter array
+ * @return array universalized parameter array
+ */
+ private static function getParam($args) {
+ unset($args[0]);
+
+ // When the second function parameter is an array then use this as the parameter array
+ if ((count($args) > 0) && (is_array($args[1]))) {
+ return $args[1];
+ } else {
+ return $args;
+ }
+ }
+
/**
* @brief Executes a prepared statement that returns data
* @usage Example: $r = p("SELECT * FROM `item` WHERE `guid` = ?", $guid);
+ *
+ * Please only use it with complicated queries.
+ * For all regular queries please use dba::select or dba::exists
+ *
* @param string $sql SQL statement
* @return object statement object
*/
- static public function p($sql) {
+ public static function p($sql) {
$a = get_app();
$stamp1 = microtime(true);
- $args = func_get_args();
- unset($args[0]);
-
- // When the second function parameter is an array then use this as the parameter array
- if ((count($args) > 0) AND (is_array($args[1]))) {
- $params = $args[1];
- } else {
- $params = $args;
- }
+ $params = self::getParam(func_get_args());
// Renumber the array keys to be sure that they fit
$i = 0;
$args = array();
foreach ($params AS $param) {
+ // Avoid problems with some MySQL servers and boolean values. See issue #3645
+ if (is_bool($param)) {
+ $param = (int)$param;
+ }
$args[++$i] = $param;
}
- if (!self::$dbo OR !self::$dbo->connected) {
+ if (!self::$connected) {
return false;
}
- if (substr_count($sql, '?') != count($args)) {
+ if ((substr_count($sql, '?') != count($args)) && (count($args) > 0)) {
// Question: Should we continue or stop the query here?
logger('Parameter mismatch. Query "'.$sql.'" - Parameters '.print_r($args, true), LOGGER_DEBUG);
}
- $sql = self::$dbo->clean_query($sql);
- $sql = self::$dbo->any_value_fallback($sql);
+ $sql = self::clean_query($sql);
+ $sql = self::any_value_fallback($sql);
+
+ $orig_sql = $sql;
if (x($a->config,'system') && x($a->config['system'], 'db_callstack')) {
- $sql = "/*".$a->callstack()." */ ".$sql;
+ $sql = "/*".System::callstack()." */ ".$sql;
}
- self::$dbo->error = '';
- self::$dbo->errorno = 0;
+ self::$error = '';
+ self::$errorno = 0;
+ self::$affected_rows = 0;
+
+ // We have to make some things different if this function is called from "e"
+ $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2);
- switch (self::$dbo->driver) {
+ if (isset($trace[1])) {
+ $called_from = $trace[1];
+ } else {
+ // We use just something that is defined to avoid warnings
+ $called_from = $trace[0];
+ }
+ // We are having an own error logging in the function "e"
+ $called_from_e = ($called_from['function'] == 'e');
+
+ switch (self::$driver) {
case 'pdo':
- if (!$stmt = self::$dbo->db->prepare($sql)) {
- $errorInfo = self::$dbo->db->errorInfo();
- self::$dbo->error = $errorInfo[2];
- self::$dbo->errorno = $errorInfo[1];
+ // If there are no arguments we use "query"
+ if (count($args) == 0) {
+ if (!$retval = self::$db->query($sql)) {
+ $errorInfo = self::$db->errorInfo();
+ self::$error = $errorInfo[2];
+ self::$errorno = $errorInfo[1];
+ $retval = false;
+ break;
+ }
+ self::$affected_rows = $retval->rowCount();
+ break;
+ }
+
+ if (!$stmt = self::$db->prepare($sql)) {
+ $errorInfo = self::$db->errorInfo();
+ self::$error = $errorInfo[2];
+ self::$errorno = $errorInfo[1];
$retval = false;
break;
}
if (!$stmt->execute()) {
$errorInfo = $stmt->errorInfo();
- self::$dbo->error = $errorInfo[2];
- self::$dbo->errorno = $errorInfo[1];
+ self::$error = $errorInfo[2];
+ self::$errorno = $errorInfo[1];
$retval = false;
} else {
$retval = $stmt;
+ self::$affected_rows = $retval->rowCount();
}
break;
case 'mysqli':
- $stmt = self::$dbo->db->stmt_init();
+ // There are SQL statements that cannot be executed with a prepared statement
+ $parts = explode(' ', $orig_sql);
+ $command = strtolower($parts[0]);
+ $can_be_prepared = in_array($command, array('select', 'update', 'insert', 'delete'));
+
+ // The fallback routine is called as well when there are no arguments
+ if (!$can_be_prepared || (count($args) == 0)) {
+ $retval = self::$db->query(self::replace_parameters($sql, $args));
+ if (self::$db->errno) {
+ self::$error = self::$db->error;
+ self::$errorno = self::$db->errno;
+ $retval = false;
+ } else {
+ if (isset($retval->num_rows)) {
+ self::$affected_rows = $retval->num_rows;
+ } else {
+ self::$affected_rows = self::$db->affected_rows;
+ }
+ }
+ break;
+ }
+
+ $stmt = self::$db->stmt_init();
if (!$stmt->prepare($sql)) {
- self::$dbo->error = $stmt->error;
- self::$dbo->errorno = $stmt->errno;
+ self::$error = $stmt->error;
+ self::$errorno = $stmt->errno;
$retval = false;
break;
}
}
if (!$stmt->execute()) {
- self::$dbo->error = self::$dbo->db->error;
- self::$dbo->errorno = self::$dbo->db->errno;
+ self::$error = self::$db->error;
+ self::$errorno = self::$db->errno;
$retval = false;
} else {
$stmt->store_result();
$retval = $stmt;
- }
- break;
- case 'mysql':
- // For the old "mysql" functions we cannot use prepared statements
- $retval = mysql_query(self::replace_parameters($sql, $args), self::$dbo->db);
- if (mysql_errno(self::$dbo->db)) {
- self::$dbo->error = mysql_error(self::$dbo->db);
- self::$dbo->errorno = mysql_errno(self::$dbo->db);
+ self::$affected_rows = $retval->affected_rows;
}
break;
}
- if (self::$dbo->errorno != 0) {
- logger('DB Error '.self::$dbo->errorno.': '.self::$dbo->error."\n".
- $a->callstack(8))."\n".self::replace_parameters($sql, $args);
+ // We are having an own error logging in the function "e"
+ if ((self::$errorno != 0) && !$called_from_e) {
+ // We have to preserve the error code, somewhere in the logging it get lost
+ $error = self::$error;
+ $errorno = self::$errorno;
+
+ logger('DB Error '.self::$errorno.': '.self::$error."\n".
+ System::callstack(8)."\n".self::replace_parameters($sql, $params));
+
+ self::$error = $error;
+ self::$errorno = $errorno;
}
$a->save_timestamp($stamp1, 'database');
/**
* @brief Executes a prepared statement like UPDATE or INSERT that doesn't return data
*
+ * Please use dba::delete, dba::insert, dba::update, ... instead
+ *
* @param string $sql SQL statement
* @return boolean Was the query successfull? False is returned only if an error occurred
*/
- static public function e($sql) {
+ public static function e($sql) {
$a = get_app();
$stamp = microtime(true);
- $args = func_get_args();
+ $params = self::getParam(func_get_args());
- $stmt = call_user_func_array('self::p', $args);
+ // In a case of a deadlock we are repeating the query 20 times
+ $timeout = 20;
- if (is_bool($stmt)) {
- $retval = $stmt;
- } elseif (is_object($stmt)) {
- $retval = true;
- } else {
- $retval = false;
- }
+ do {
+ $stmt = self::p($sql, $params);
- self::close($stmt);
+ if (is_bool($stmt)) {
+ $retval = $stmt;
+ } elseif (is_object($stmt)) {
+ $retval = true;
+ } else {
+ $retval = false;
+ }
+
+ self::close($stmt);
+
+ } while ((self::$errorno == 1213) && (--$timeout > 0));
+
+ if (self::$errorno != 0) {
+ // We have to preserve the error code, somewhere in the logging it get lost
+ $error = self::$error;
+ $errorno = self::$errorno;
+
+ logger('DB Error '.self::$errorno.': '.self::$error."\n".
+ System::callstack(8)."\n".self::replace_parameters($sql, $params));
+
+ self::$error = $error;
+ self::$errorno = $errorno;
+ }
$a->save_timestamp($stamp, "database_write");
/**
* @brief Check if data exists
*
- * @param string $sql SQL statement
- * @return boolean Are there rows for that query?
+ * @param string $table Table name
+ * @param array $condition array of fields for condition
+ *
+ * @return boolean Are there rows for that condition?
*/
- static public function exists($sql) {
- $args = func_get_args();
+ public static function exists($table, $condition) {
+ if (empty($table)) {
+ return false;
+ }
- $stmt = call_user_func_array('self::p', $args);
+ $fields = array();
+
+ $array_element = each($condition);
+ $array_key = $array_element['key'];
+ if (!is_int($array_key)) {
+ $fields = array($array_key);
+ }
+
+ $stmt = self::select($table, $fields, $condition, array('limit' => 1, 'only_query' => true));
if (is_bool($stmt)) {
$retval = $stmt;
/**
* @brief Fetches the first row
*
+ * Please use dba::select or dba::exists whenever this is possible.
+ *
* @param string $sql SQL statement
* @return array first row of query
*/
- static public function fetch_first($sql) {
- $args = func_get_args();
+ public static function fetch_first($sql) {
+ $params = self::getParam(func_get_args());
- $stmt = call_user_func_array('self::p', $args);
+ $stmt = self::p($sql, $params);
if (is_bool($stmt)) {
$retval = $stmt;
return $retval;
}
+ /**
+ * @brief Returns the number of affected rows of the last statement
+ *
+ * @return int Number of rows
+ */
+ public static function affected_rows() {
+ return self::$affected_rows;
+ }
+
+ /**
+ * @brief Returns the number of columns of a statement
+ *
+ * @param object Statement object
+ * @return int Number of columns
+ */
+ public static function columnCount($stmt) {
+ if (!is_object($stmt)) {
+ return 0;
+ }
+ switch (self::$driver) {
+ case 'pdo':
+ return $stmt->columnCount();
+ case 'mysqli':
+ return $stmt->field_count;
+ }
+ return 0;
+ }
/**
* @brief Returns the number of rows of a statement
*
* @param object Statement object
* @return int Number of rows
*/
- static public function num_rows($stmt) {
+ public static function num_rows($stmt) {
if (!is_object($stmt)) {
return 0;
}
- switch (self::$dbo->driver) {
+ switch (self::$driver) {
case 'pdo':
return $stmt->rowCount();
case 'mysqli':
return $stmt->num_rows;
- case 'mysql':
- return mysql_num_rows($stmt);
}
return 0;
}
* @param object $stmt statement object
* @return array current row
*/
- static public function fetch($stmt) {
+ public static function fetch($stmt) {
if (!is_object($stmt)) {
return false;
}
- switch (self::$dbo->driver) {
+ switch (self::$driver) {
case 'pdo':
return $stmt->fetch(PDO::FETCH_ASSOC);
case 'mysqli':
+ if (get_class($stmt) == 'mysqli_result') {
+ return $stmt->fetch_assoc();
+ }
+
// This code works, but is slow
// Bind the result to a result array
$columns[$fields[$param]->name] = $col;
}
return $columns;
- case 'mysql':
- return mysql_fetch_array(self::$dbo->result, MYSQL_ASSOC);
}
}
*
* @param string $table Table name
* @param array $param parameter array
+ * @param bool $on_duplicate_update Do an update on a duplicate entry
*
* @return boolean was the insert successfull?
*/
- static public function insert($table, $param) {
- $sql = "INSERT INTO `".self::$dbo->escape($table)."` (`".implode("`, `", array_keys($param))."`) VALUES (".
- substr(str_repeat("?, ", count($param)), 0, -2).");";
+ public static function insert($table, $param, $on_duplicate_update = false) {
+
+ if (empty($table) || empty($param)) {
+ logger('Table and fields have to be set');
+ return false;
+ }
+
+ $sql = "INSERT INTO `".self::escape($table)."` (`".implode("`, `", array_keys($param))."`) VALUES (".
+ substr(str_repeat("?, ", count($param)), 0, -2).")";
+
+ if ($on_duplicate_update) {
+ $sql .= " ON DUPLICATE KEY UPDATE `".implode("` = ?, `", array_keys($param))."` = ?";
+
+ $values = array_values($param);
+ $param = array_merge_recursive($values, $values);
+ }
return self::e($sql, $param);
}
+ /**
+ * @brief Fetch the id of the last insert command
+ *
+ * @return integer Last inserted id
+ */
+ public static function lastInsertId() {
+ switch (self::$driver) {
+ case 'pdo':
+ $id = self::$db->lastInsertId();
+ break;
+ case 'mysqli':
+ $id = self::$db->insert_id;
+ break;
+ }
+ return $id;
+ }
+
/**
* @brief Locks a table for exclusive write access
*
*
* @return boolean was the lock successful?
*/
- static public function lock($table) {
+ public static function lock($table) {
// See here: https://dev.mysql.com/doc/refman/5.7/en/lock-tables-and-transactions.html
self::e("SET autocommit=0");
- $success = self::e("LOCK TABLES `".self::$dbo->escape($table)."` WRITE");
+ $success = self::e("LOCK TABLES `".self::escape($table)."` WRITE");
if (!$success) {
self::e("SET autocommit=1");
} else {
*
* @return boolean was the unlock successful?
*/
- static public function unlock() {
+ public static function unlock() {
// See here: https://dev.mysql.com/doc/refman/5.7/en/lock-tables-and-transactions.html
self::e("COMMIT");
$success = self::e("UNLOCK TABLES");
*
* @return boolean Was the command executed successfully?
*/
- static public function transaction() {
+ public static function transaction() {
if (!self::e('COMMIT')) {
return false;
}
*
* @return boolean Was the command executed successfully?
*/
- static public function commit() {
+ public static function commit() {
if (!self::e('COMMIT')) {
return false;
}
*
* @return boolean Was the command executed successfully?
*/
- static public function rollback() {
+ public static function rollback() {
if (!self::e('ROLLBACK')) {
return false;
}
*
* This process must only be started once, since the value is cached.
*/
- static private function build_relation_data() {
+ private static function build_relation_data() {
$definition = db_definition();
foreach ($definition AS $table => $structure) {
- foreach ($structure['fields'] AS $field => $field_struct) {
- if (isset($field_struct['relation'])) {
- foreach ($field_struct['relation'] AS $rel_table => $rel_field) {
- self::$relation[$rel_table][$rel_field][$table][] = $field;
- }
- }
- }
+ foreach ($structure['fields'] AS $field => $field_struct) {
+ if (isset($field_struct['relation'])) {
+ foreach ($field_struct['relation'] AS $rel_table => $rel_field) {
+ self::$relation[$rel_table][$rel_field][$table][] = $field;
+ }
+ }
+ }
}
}
*
* @return boolean|array was the delete successfull? When $in_process is set: deletion data
*/
- static public function delete($table, $param, $in_process = false, &$callstack = array()) {
+ public static function delete($table, $param, $in_process = false, &$callstack = array()) {
+
+ if (empty($table) || empty($param)) {
+ logger('Table and condition have to be set');
+ return false;
+ }
$commands = array();
$callstack[$key] = true;
- $table = self::$dbo->escape($table);
+ $table = self::escape($table);
$commands[$key] = array('table' => $table, 'param' => $param);
// When the search field is the relation field, we don't need to fetch the rows
// This is useful when the leading record is already deleted in the frontend but the rest is done in the backend
- if ((count($param) == 1) AND ($field == array_keys($param)[0])) {
+ if ((count($param) == 1) && ($field == array_keys($param)[0])) {
foreach ($rel_def AS $rel_table => $rel_fields) {
foreach ($rel_fields AS $rel_field) {
$retval = self::delete($rel_table, array($rel_field => array_values($param)[0]), true, $callstack);
$callstack[$qkey] = true;
// Fetch all rows that are to be deleted
- $sql = "SELECT ".self::$dbo->escape($field)." FROM `".$table."` WHERE `".
- implode("` = ? AND `", array_keys($param))."` = ?";
+ $data = self::select($table, array($field), $param);
- $data = self::p($sql, $param);
while ($row = self::fetch($data)) {
// Now we accumulate the delete commands
$retval = self::delete($table, array($field => $row[$field]), true, $callstack);
$commands = array_merge($commands, $retval);
}
+ self::close($data);
+
// Since we had split the delete command we don't need the original command anymore
unset($commands[$key]);
}
$compacted = array();
$counter = array();
+
foreach ($commands AS $command) {
- if (count($command['param']) > 1) {
- $sql = "DELETE FROM `".$command['table']."` WHERE `".
- implode("` = ? AND `", array_keys($command['param']))."` = ?";
+ $condition = $command['param'];
+ $array_element = each($condition);
+ $array_key = $array_element['key'];
+ if (is_int($array_key)) {
+ $condition_string = " WHERE ".array_shift($condition);
+ } else {
+ $condition_string = " WHERE `".implode("` = ? AND `", array_keys($condition))."` = ?";
+ }
- logger(dba::replace_parameters($sql, $command['param']), LOGGER_DATA);
+ if ((count($command['param']) > 1) || is_int($array_key)) {
+ $sql = "DELETE FROM `".$command['table']."`".$condition_string;
+ logger(self::replace_parameters($sql, $condition), LOGGER_DATA);
- if (!self::e($sql, $command['param'])) {
+ if (!self::e($sql, $condition)) {
if ($do_transaction) {
self::rollback();
}
$sql = "DELETE FROM `".$table."` WHERE `".$field."` IN (".
substr(str_repeat("?, ", count($field_values)), 0, -2).");";
- logger(dba::replace_parameters($sql, $field_values), LOGGER_DATA);
+ logger(self::replace_parameters($sql, $field_values), LOGGER_DATA);
if (!self::e($sql, $field_values)) {
if ($do_transaction) {
* @param string $table Table name
* @param array $fields contains the fields that are updated
* @param array $condition condition array with the key values
- * @param array|boolean $old_fields array with the old field values that are about to be replaced
+ * @param array|boolean $old_fields array with the old field values that are about to be replaced (true = update on duplicate)
*
* @return boolean was the update successfull?
*/
- static public function update($table, $fields, $condition, $old_fields = array()) {
-
- /** @todo We may use MySQL specific functions here:
- * INSERT INTO `config` (`cat`, `k`, `v`) VALUES ('%s', '%s', '%s') ON DUPLICATE KEY UPDATE `v` = '%s'"
- * But I think that it doesn't make sense here.
- */
+ public static function update($table, $fields, $condition, $old_fields = array()) {
- $table = self::$dbo->escape($table);
+ if (empty($table) || empty($fields) || empty($condition)) {
+ logger('Table, fields and condition have to be set');
+ return false;
+ }
- if (is_bool($old_fields)) {
- $sql = "SELECT * FROM `".$table."` WHERE `".
- implode("` = ? AND `", array_keys($condition))."` = ? LIMIT 1";
+ $table = self::escape($table);
- $params = array();
- foreach ($condition AS $value) {
- $params[] = $value;
- }
+ $array_element = each($condition);
+ $array_key = $array_element['key'];
+ if (is_int($array_key)) {
+ $condition_string = " WHERE ".array_shift($condition);
+ } else {
+ $condition_string = " WHERE `".implode("` = ? AND `", array_keys($condition))."` = ?";
+ }
+ if (is_bool($old_fields)) {
$do_insert = $old_fields;
- $old_fields = self::fetch_first($sql, $params);
+ $old_fields = self::select($table, array(), $condition, array('limit' => 1));
+
if (is_bool($old_fields)) {
if ($do_insert) {
- return self::insert($table, $fields);
+ $values = array_merge($condition, $fields);
+ return self::insert($table, $values, $do_insert);
}
$old_fields = array();
}
}
}
- if (!$do_update OR (count($fields) == 0)) {
+ if (!$do_update || (count($fields) == 0)) {
return true;
}
$sql = "UPDATE `".$table."` SET `".
- implode("` = ?, `", array_keys($fields))."` = ? WHERE `".
- implode("` = ? AND `", array_keys($condition))."` = ?";
+ implode("` = ?, `", array_keys($fields))."` = ?".$condition_string;
- $params = array();
- foreach ($fields AS $value) {
- $params[] = $value;
- }
- foreach ($condition AS $value) {
- $params[] = $value;
- }
+ $params1 = array_values($fields);
+ $params2 = array_values($condition);
+ $params = array_merge_recursive($params1, $params2);
return self::e($sql, $params);
}
* Example:
* $table = "item";
* $fields = array("id", "uri", "uid", "network");
+ *
* $condition = array("uid" => 1, "network" => 'dspr');
+ * or:
+ * $condition = array("`uid` = ? AND `network` IN (?, ?)", 1, 'dfrn', 'dspr');
+ *
* $params = array("order" => array("id", "received" => true), "limit" => 1);
*
* $data = dba::select($table, $fields, $condition, $params);
*/
- static public function select($table, $fields = array(), $condition = array(), $params = array()) {
+ public static function select($table, array $fields = [], array $condition = [], array $params = [])
+ {
if ($table == '') {
return false;
}
$select_fields = "*";
}
- if (count($condition) > 0) {
- $condition_string = " WHERE `".implode("` = ? AND `", array_keys($condition))."` = ?";
- } else {
- $condition_string = "";
- }
+ $condition_string = self::buildCondition($condition);
$param_string = '';
$single_row = false;
$param_string = substr($param_string, 0, -2);
}
- if (isset($params['limit'])) {
- if (is_int($params['limit'])) {
- $param_string .= " LIMIT ".$params['limit'];
- $single_row =($params['limit'] == 1);
- }
+ if (isset($params['limit']) && is_int($params['limit'])) {
+ $param_string .= " LIMIT ".$params['limit'];
+ $single_row = ($params['limit'] == 1);
+ }
+
+ if (isset($params['limit']) && is_array($params['limit'])) {
+ $param_string .= " LIMIT ".intval($params['limit'][0]).", ".intval($params['limit'][1]);
+ $single_row = ($params['limit'][1] == 1);
+ }
+
+ if (isset($params['only_query']) && $params['only_query']) {
+ $single_row = !$params['only_query'];
}
$sql = "SELECT ".$select_fields." FROM `".$table."`".$condition_string.$param_string;
$result = self::p($sql, $condition);
- if (is_bool($result) OR !$single_row) {
+ if (is_bool($result) || !$single_row) {
return $result;
} else {
$row = self::fetch($result);
}
/**
- * @brief Closes the current statement
+ * @brief Counts the rows from a table satisfying the provided condition
*
- * @param object $stmt statement object
- * @return boolean was the close successfull?
+ * @param string $table Table name
+ * @param array $condition array of fields for condition
+ *
+ * @return int
+ *
+ * Example:
+ * $table = "item";
+ *
+ * $condition = ["uid" => 1, "network" => 'dspr'];
+ * or:
+ * $condition = ["`uid` = ? AND `network` IN (?, ?)", 1, 'dfrn', 'dspr'];
+ *
+ * $count = dba::count($table, $condition);
*/
- static public function close($stmt) {
- if (!is_object($stmt)) {
+ public static function count($table, array $condition = [])
+ {
+ if ($table == '') {
return false;
}
- switch (self::$dbo->driver) {
- case 'pdo':
- return $stmt->closeCursor();
- case 'mysqli':
- return $stmt->free_result();
- return $stmt->close();
- case 'mysql':
- return mysql_free_result($stmt);
- }
- }
-}
+ $condition_string = self::buildCondition($condition);
-function printable($s) {
- $s = preg_replace("~([\x01-\x08\x0E-\x0F\x10-\x1F\x7F-\xFF])~",".", $s);
- $s = str_replace("\x00",'.',$s);
- if (x($_SERVER,'SERVER_NAME')) {
- $s = escape_tags($s);
- }
- return $s;
-}
+ $sql = "SELECT COUNT(*) AS `count` FROM `".$table."`".$condition_string;
-// Procedural functions
-function dbg($state) {
- global $db;
+ $row = self::fetch_first($sql, $condition);
- if ($db) {
- $db->dbg($state);
+ return $row['count'];
}
-}
-function dbesc($str) {
- global $db;
+ /**
+ * @brief Returns the SQL condition string built from the provided condition array
+ *
+ * This function operates with two modes.
+ * - Supplied with a filed/value associative array, it builds simple strict
+ * equality conditions linked by AND.
+ * - Supplied with a flat list, the first element is the condition string and
+ * the following arguments are the values to be interpolated
+ *
+ * $condition = ["uid" => 1, "network" => 'dspr'];
+ * or:
+ * $condition = ["`uid` = ? AND `network` IN (?, ?)", 1, 'dfrn', 'dspr'];
+ *
+ * In either case, the provided array is left with the parameters only
+ *
+ * @param array $condition
+ * @return string
+ */
+ private static function buildCondition(array &$condition = [])
+ {
+ $condition_string = '';
+ if (count($condition) > 0) {
+ $array_element = each($condition);
+ $array_key = $array_element['key'];
+ if (is_int($array_key)) {
+ $condition_string = " WHERE ".array_shift($condition);
+ } else {
+ $condition_string = " WHERE `".implode("` = ? AND `", array_keys($condition))."` = ?";
+ }
+ }
- if ($db && $db->connected) {
- return($db->escape($str));
- } else {
- return(str_replace("'","\\'",$str));
+ return $condition_string;
}
-}
-// Function: q($sql,$args);
-// Description: execute SQL query with printf style args.
-// Example: $r = q("SELECT * FROM `%s` WHERE `uid` = %d",
-// 'user', 1);
-function q($sql) {
- global $db;
- $args = func_get_args();
- unset($args[0]);
-
- if ($db && $db->connected) {
- $sql = $db->clean_query($sql);
- $sql = $db->any_value_fallback($sql);
- $stmt = @vsprintf($sql,$args); // Disabled warnings
- //logger("dba: q: $stmt", LOGGER_ALL);
- if ($stmt === false)
- logger('dba: vsprintf error: ' . print_r(debug_backtrace(),true), LOGGER_DEBUG);
+ /**
+ * @brief Fills an array with data from a query
+ *
+ * @param object $stmt statement object
+ * @return array Data array
+ */
+ public static function inArray($stmt, $do_close = true) {
+ if (is_bool($stmt)) {
+ return $stmt;
+ }
- $db->log_index($stmt);
+ $data = array();
+ while ($row = self::fetch($stmt)) {
+ $data[] = $row;
+ }
+ if ($do_close) {
+ self::close($stmt);
+ }
+ return $data;
+ }
- return $db->q($stmt);
+ /**
+ * @brief Returns the error number of the last query
+ *
+ * @return string Error number (0 if no error)
+ */
+ public static function errorNo() {
+ return self::$errorno;
}
/**
+ * @brief Returns the error message of the last query
*
- * This will happen occasionally trying to store the
- * session data after abnormal program termination
+ * @return string Error message ('' if no error)
+ */
+ public static function errorMessage() {
+ return self::$error;
+ }
+
+ /**
+ * @brief Closes the current statement
*
+ * @param object $stmt statement object
+ * @return boolean was the close successfull?
*/
- logger('dba: no database: ' . print_r($args,true));
- return false;
+ public static function close($stmt) {
+ if (!is_object($stmt)) {
+ return false;
+ }
+
+ switch (self::$driver) {
+ case 'pdo':
+ return $stmt->closeCursor();
+ case 'mysqli':
+ $stmt->free_result();
+ return $stmt->close();
+ }
+ }
+}
+
+function dbesc($str) {
+ if (dba::$connected) {
+ return(dba::escape($str));
+ } else {
+ return(str_replace("'","\\'",$str));
+ }
}
/**
- * @brief Performs a query with "dirty reads"
+ * @brief execute SQL query with printf style args - deprecated
*
- * By doing dirty reads (reading uncommitted data) no locks are performed
- * This function can be used to fetch data that doesn't need to be reliable.
+ * Please use the dba:: functions instead:
+ * dba::select, dba::exists, dba::insert
+ * dba::delete, dba::update, dba::p, dba::e
*
* @param $args Query parameters (1 to N parameters of different types)
* @return array Query array
*/
-function qu($sql) {
- global $db;
-
+function q($sql) {
$args = func_get_args();
unset($args[0]);
- if ($db && $db->connected) {
- $sql = $db->clean_query($sql);
- $sql = $db->any_value_fallback($sql);
- $stmt = @vsprintf($sql,$args); // Disabled warnings
- if ($stmt === false)
- logger('dba: vsprintf error: ' . print_r(debug_backtrace(),true), LOGGER_DEBUG);
-
- $db->log_index($stmt);
-
- $db->q("SET SESSION TRANSACTION ISOLATION LEVEL READ UNCOMMITTED;");
- $retval = $db->q($stmt);
- $db->q("SET SESSION TRANSACTION ISOLATION LEVEL REPEATABLE READ;");
- return $retval;
+ if (!dba::$connected) {
+ return false;
}
- /**
- *
- * This will happen occasionally trying to store the
- * session data after abnormal program termination
- *
- */
- logger('dba: no database: ' . print_r($args,true));
- return false;
-}
+ $sql = dba::clean_query($sql);
+ $sql = dba::any_value_fallback($sql);
-/**
- *
- * Raw db query, no arguments
- *
- */
-function dbq($sql) {
- global $db;
+ $stmt = @vsprintf($sql, $args);
- if ($db && $db->connected) {
- $ret = $db->q($sql);
- } else {
- $ret = false;
+ $ret = dba::p($stmt);
+
+ if (is_bool($ret)) {
+ return $ret;
}
- return $ret;
-}
-// Caller is responsible for ensuring that any integer arguments to
-// dbesc_array are actually integers and not malformed strings containing
-// SQL injection vectors. All integer array elements should be specifically
-// cast to int to avoid trouble.
-function dbesc_array_cb(&$item, $key) {
- if (is_string($item))
- $item = dbesc($item);
-}
+ $columns = dba::columnCount($ret);
+
+ $data = dba::inArray($ret);
-function dbesc_array(&$arr) {
- if (is_array($arr) && count($arr)) {
- array_walk($arr,'dbesc_array_cb');
+ if ((count($data) == 0) && ($columns == 0)) {
+ return true;
}
+
+ return $data;
}
function dba_timer() {