1244 lines
32 KiB
PHP
1244 lines
32 KiB
PHP
<?php
|
|
require_once("dbm.php");
|
|
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 = '';
|
|
private static $dbo;
|
|
private static $relation = array();
|
|
|
|
function __construct($serveraddr, $user, $pass, $db, $install = false) {
|
|
$a = get_app();
|
|
|
|
$stamp1 = microtime(true);
|
|
|
|
$serveraddr = trim($serveraddr);
|
|
|
|
$serverdata = explode(':', $serveraddr);
|
|
$server = $serverdata[0];
|
|
|
|
if (count($serverdata) > 1) {
|
|
$port = trim($serverdata[1]);
|
|
}
|
|
|
|
$server = trim($server);
|
|
$user = trim($user);
|
|
$pass = trim($pass);
|
|
$db = trim($db);
|
|
|
|
if (!(strlen($server) && strlen($user))) {
|
|
$this->connected = false;
|
|
$this->db = null;
|
|
return;
|
|
}
|
|
|
|
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;
|
|
}
|
|
}
|
|
}
|
|
|
|
if (class_exists('\PDO') && in_array('mysql', PDO::getAvailableDrivers())) {
|
|
$this->driver = 'pdo';
|
|
$connect = "mysql:host=".$server.";dbname=".$db;
|
|
|
|
if (isset($port)) {
|
|
$connect .= ";port=".$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;
|
|
}
|
|
} 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 (isset($a->config["system"]["db_charset"])) {
|
|
mysql_set_charset($a->config["system"]["db_charset"], $this->db);
|
|
}
|
|
}
|
|
} else {
|
|
// No suitable SQL driver was found.
|
|
if (!$install) {
|
|
system_unavailable();
|
|
}
|
|
}
|
|
|
|
if (!$this->connected) {
|
|
$this->db = null;
|
|
if (!$install) {
|
|
system_unavailable();
|
|
}
|
|
}
|
|
$a->save_timestamp($stamp1, "network");
|
|
|
|
self::$dbo = $this;
|
|
}
|
|
|
|
/**
|
|
* @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) {
|
|
case 'pdo':
|
|
$this->_server_info = $this->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);
|
|
break;
|
|
}
|
|
}
|
|
return $this->_server_info;
|
|
}
|
|
|
|
/**
|
|
* @brief Returns the selected database name
|
|
*
|
|
* @return string
|
|
*/
|
|
public function database_name() {
|
|
$r = $this->q("SELECT DATABASE() AS `db`");
|
|
|
|
return $r[0]['db'];
|
|
}
|
|
|
|
/**
|
|
* @brief Analyze a database query and log this if some conditions are met.
|
|
*
|
|
* @param string $query The database query that will be analyzed
|
|
*/
|
|
public function log_index($query) {
|
|
$a = get_app();
|
|
|
|
if ($a->config["system"]["db_log_index"] == "") {
|
|
return;
|
|
}
|
|
|
|
// Don't explain an explain statement
|
|
if (strtolower(substr($query, 0, 7)) == "explain") {
|
|
return;
|
|
}
|
|
|
|
// Only do the explain on "select", "update" and "delete"
|
|
if (!in_array(strtolower(substr($query, 0, 6)), array("select", "update", "delete"))) {
|
|
return;
|
|
}
|
|
|
|
$r = $this->q("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) {
|
|
if ((intval($a->config["system"]["db_loglimit_index"]) > 0)) {
|
|
$log = (in_array($row['key'], $watchlist) AND
|
|
($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"]))) {
|
|
$log = true;
|
|
}
|
|
|
|
if (in_array($row['key'], $blacklist) OR ($row['key'] == "")) {
|
|
$log = false;
|
|
}
|
|
|
|
if ($log) {
|
|
$backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
|
|
@file_put_contents($a->config["system"]["db_log_index"], datetime_convert()."\t".
|
|
$row['key']."\t".$row['rows']."\t".$row['Extra']."\t".
|
|
basename($backtrace[1]["file"])."\t".
|
|
$backtrace[1]["line"]."\t".$backtrace[2]["function"]."\t".
|
|
substr($query, 0, 2000)."\n", FILE_APPEND);
|
|
}
|
|
}
|
|
}
|
|
|
|
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) {
|
|
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;
|
|
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($r);
|
|
}
|
|
|
|
public function dbg($dbg) {
|
|
$this->debug = $dbg;
|
|
}
|
|
|
|
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) {
|
|
case 'pdo':
|
|
// Not sure if this really is working like expected
|
|
$connected = ($this->db->getAttribute(PDO::ATTR_CONNECTION_STATUS) != "");
|
|
break;
|
|
case 'mysqli':
|
|
$connected = $this->db->ping();
|
|
break;
|
|
case 'mysql':
|
|
$connected = mysql_ping($this->db);
|
|
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().
|
|
*
|
|
* Considerations for Standard SQL, or MySQL with ONLY_FULL_GROUP_BY (default since 5.7.5).
|
|
* ANY_VALUE() is available from MySQL 5.7.5 https://dev.mysql.com/doc/refman/5.7/en/miscellaneous-functions.html
|
|
* A standard fall-back is to use MIN().
|
|
*
|
|
* @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();
|
|
if (version_compare($server_info, '5.7.5', '<') ||
|
|
(stripos($server_info, 'MariaDB') !== false)) {
|
|
$sql = str_ireplace('ANY_VALUE(', 'MIN(', $sql);
|
|
}
|
|
return $sql;
|
|
}
|
|
|
|
/**
|
|
* @brief Replaces the ? placeholders with the parameters in the $args array
|
|
*
|
|
* @param string $sql SQL query
|
|
* @param array $args The parameters that are to replace the ? placeholders
|
|
* @return string The replaced SQL query
|
|
*/
|
|
static private function replace_parameters($sql, $args) {
|
|
$offset = 0;
|
|
foreach ($args AS $param => $value) {
|
|
if (is_int($args[$param]) OR is_float($args[$param])) {
|
|
$replace = intval($args[$param]);
|
|
} else {
|
|
$replace = "'".self::$dbo->escape($args[$param])."'";
|
|
}
|
|
|
|
$pos = strpos($sql, '?', $offset);
|
|
if ($pos !== false) {
|
|
$sql = substr_replace($sql, $replace, $pos, 1);
|
|
}
|
|
$offset = $pos + strlen($replace);
|
|
}
|
|
return $sql;
|
|
}
|
|
|
|
/**
|
|
* @brief Executes a prepared statement that returns data
|
|
* @usage Example: $r = p("SELECT * FROM `item` WHERE `guid` = ?", $guid);
|
|
* @param string $sql SQL statement
|
|
* @return object statement object
|
|
*/
|
|
static public 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;
|
|
}
|
|
|
|
// Renumber the array keys to be sure that they fit
|
|
$i = 0;
|
|
$args = array();
|
|
foreach ($params AS $param) {
|
|
$args[++$i] = $param;
|
|
}
|
|
|
|
if (!self::$dbo OR !self::$dbo->connected) {
|
|
return false;
|
|
}
|
|
|
|
if (substr_count($sql, '?') != count($args)) {
|
|
// Question: Should we continue or stop the query here?
|
|
logger('Parameter mismatch. Query "'.$sql.'" - Parameters '.print_r($args, true), LOGGER_DEBUG);
|
|
}
|
|
|
|
$sql = self::$dbo->any_value_fallback($sql);
|
|
|
|
if (x($a->config,'system') && x($a->config['system'], 'db_callstack')) {
|
|
$sql = "/*".$a->callstack()." */ ".$sql;
|
|
}
|
|
|
|
self::$dbo->error = '';
|
|
self::$dbo->errorno = 0;
|
|
|
|
switch (self::$dbo->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];
|
|
$retval = false;
|
|
break;
|
|
}
|
|
|
|
foreach ($args AS $param => $value) {
|
|
$stmt->bindParam($param, $args[$param]);
|
|
}
|
|
|
|
if (!$stmt->execute()) {
|
|
$errorInfo = $stmt->errorInfo();
|
|
self::$dbo->error = $errorInfo[2];
|
|
self::$dbo->errorno = $errorInfo[1];
|
|
$retval = false;
|
|
} else {
|
|
$retval = $stmt;
|
|
}
|
|
break;
|
|
case 'mysqli':
|
|
$stmt = self::$dbo->db->stmt_init();
|
|
|
|
if (!$stmt->prepare($sql)) {
|
|
self::$dbo->error = $stmt->error;
|
|
self::$dbo->errorno = $stmt->errno;
|
|
$retval = false;
|
|
break;
|
|
}
|
|
|
|
$params = '';
|
|
$values = array();
|
|
foreach ($args AS $param => $value) {
|
|
if (is_int($args[$param])) {
|
|
$params .= 'i';
|
|
} elseif (is_float($args[$param])) {
|
|
$params .= 'd';
|
|
} elseif (is_string($args[$param])) {
|
|
$params .= 's';
|
|
} else {
|
|
$params .= 'b';
|
|
}
|
|
$values[] = &$args[$param];
|
|
}
|
|
|
|
if (count($values) > 0) {
|
|
array_unshift($values, $params);
|
|
call_user_func_array(array($stmt, 'bind_param'), $values);
|
|
}
|
|
|
|
if (!$stmt->execute()) {
|
|
self::$dbo->error = self::$dbo->db->error;
|
|
self::$dbo->errorno = self::$dbo->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);
|
|
}
|
|
break;
|
|
}
|
|
|
|
if (self::$dbo->errorno != 0) {
|
|
logger('DB Error '.self::$dbo->errorno.': '.self::$dbo->error."\n".self::replace_parameters($sql, $args));
|
|
}
|
|
|
|
$a->save_timestamp($stamp1, 'database');
|
|
|
|
if (x($a->config,'system') && x($a->config['system'], 'db_log')) {
|
|
|
|
$stamp2 = microtime(true);
|
|
$duration = (float)($stamp2 - $stamp1);
|
|
|
|
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(self::replace_parameters($sql, $args), 0, 2000)."\n", FILE_APPEND);
|
|
}
|
|
}
|
|
return $retval;
|
|
}
|
|
|
|
/**
|
|
* @brief Executes a prepared statement like UPDATE or INSERT that doesn't return data
|
|
*
|
|
* @param string $sql SQL statement
|
|
* @return boolean Was the query successfull? False is returned only if an error occurred
|
|
*/
|
|
static public function e($sql) {
|
|
$a = get_app();
|
|
|
|
$stamp = microtime(true);
|
|
|
|
$args = func_get_args();
|
|
|
|
$stmt = call_user_func_array('self::p', $args);
|
|
|
|
if (is_bool($stmt)) {
|
|
$retval = $stmt;
|
|
} elseif (is_object($stmt)) {
|
|
$retval = true;
|
|
} else {
|
|
$retval = false;
|
|
}
|
|
|
|
self::close($stmt);
|
|
|
|
$a->save_timestamp($stamp, "database_write");
|
|
|
|
return $retval;
|
|
}
|
|
|
|
/**
|
|
* @brief Check if data exists
|
|
*
|
|
* @param string $sql SQL statement
|
|
* @return boolean Are there rows for that query?
|
|
*/
|
|
static public function exists($sql) {
|
|
$args = func_get_args();
|
|
|
|
$stmt = call_user_func_array('self::p', $args);
|
|
|
|
if (is_bool($stmt)) {
|
|
$retval = $stmt;
|
|
} else {
|
|
$retval = (self::num_rows($stmt) > 0);
|
|
}
|
|
|
|
self::close($stmt);
|
|
|
|
return $retval;
|
|
}
|
|
|
|
/**
|
|
* @brief Fetches the first row
|
|
*
|
|
* @param string $sql SQL statement
|
|
* @return array first row of query
|
|
*/
|
|
static public function fetch_first($sql) {
|
|
$args = func_get_args();
|
|
|
|
$stmt = call_user_func_array('self::p', $args);
|
|
|
|
if (is_bool($stmt)) {
|
|
$retval = $stmt;
|
|
} else {
|
|
$retval = self::fetch($stmt);
|
|
}
|
|
|
|
self::close($stmt);
|
|
|
|
return $retval;
|
|
}
|
|
|
|
/**
|
|
* @brief Returns the number of rows of a statement
|
|
*
|
|
* @param object Statement object
|
|
* @return int Number of rows
|
|
*/
|
|
static public function num_rows($stmt) {
|
|
switch (self::$dbo->driver) {
|
|
case 'pdo':
|
|
return $stmt->rowCount();
|
|
case 'mysqli':
|
|
return $stmt->num_rows;
|
|
case 'mysql':
|
|
return mysql_num_rows($stmt);
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
/**
|
|
* @brief Fetch a single row
|
|
*
|
|
* @param object $stmt statement object
|
|
* @return array current row
|
|
*/
|
|
static public function fetch($stmt) {
|
|
if (!is_object($stmt)) {
|
|
return false;
|
|
}
|
|
|
|
switch (self::$dbo->driver) {
|
|
case 'pdo':
|
|
return $stmt->fetch(PDO::FETCH_ASSOC);
|
|
case 'mysqli':
|
|
// This code works, but is slow
|
|
|
|
// Bind the result to a result array
|
|
$cols = array();
|
|
|
|
$cols_num = array();
|
|
for ($x = 0; $x < $stmt->field_count; $x++) {
|
|
$cols[] = &$cols_num[$x];
|
|
}
|
|
|
|
call_user_func_array(array($stmt, 'bind_result'), $cols);
|
|
|
|
if (!$stmt->fetch()) {
|
|
return false;
|
|
}
|
|
|
|
// The slow part:
|
|
// We need to get the field names for the array keys
|
|
// It seems that there is no better way to do this.
|
|
$result = $stmt->result_metadata();
|
|
$fields = $result->fetch_fields();
|
|
|
|
$columns = array();
|
|
foreach ($cols_num AS $param => $col) {
|
|
$columns[$fields[$param]->name] = $col;
|
|
}
|
|
return $columns;
|
|
case 'mysql':
|
|
return mysql_fetch_array(self::$dbo->result, MYSQL_ASSOC);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @brief Insert a row into a table
|
|
*
|
|
* @param string $table Table name
|
|
* @param array $param parameter array
|
|
*
|
|
* @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).");";
|
|
|
|
return self::e($sql, $param);
|
|
}
|
|
|
|
/**
|
|
* @brief Build the array with the table relations
|
|
*
|
|
* The array is build from the database definitions in dbstructure.php
|
|
*
|
|
* This process must only be started once, since the value is cached.
|
|
*/
|
|
static private 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;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @brief Insert a row into a table
|
|
*
|
|
* @param string $table Table name
|
|
* @param array $param parameter array
|
|
* @param boolean $in_commit Internal use: Only do a commit after the last delete
|
|
* @param array $callstack Internal use: prevent endless loops
|
|
*
|
|
* @return boolean|array was the delete successfull? When $in_commit is set: deletion data
|
|
*/
|
|
static public function delete($table, $param, $in_commit = false, &$callstack = array()) {
|
|
|
|
$commands = array();
|
|
|
|
// Create a key for the loop prevention
|
|
$key = $table.':'.implode(':', array_keys($param)).':'.implode(':', $param);
|
|
|
|
// We quit when this key already exists in the callstack.
|
|
if (isset($callstack[$key])) {
|
|
return $commands;
|
|
}
|
|
|
|
$callstack[$key] = true;
|
|
|
|
$table = self::$dbo->escape($table);
|
|
|
|
$commands[$key] = array('table' => $table, 'param' => $param);
|
|
|
|
// To speed up the whole process we cache the table relations
|
|
if (count(self::$relation) == 0) {
|
|
self::build_relation_data();
|
|
}
|
|
|
|
// Is there a relation entry for the table?
|
|
if (isset(self::$relation[$table])) {
|
|
// We only allow a simple "one field" relation.
|
|
$field = array_keys(self::$relation[$table])[0];
|
|
$rel_def = array_values(self::$relation[$table])[0];
|
|
|
|
// Create a key for preventing double queries
|
|
$qkey = $field.'-'.$table.':'.implode(':', array_keys($param)).':'.implode(':', $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])) {
|
|
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);
|
|
$commands = array_merge($commands, $retval);
|
|
}
|
|
}
|
|
// We quit when this key already exists in the callstack.
|
|
} elseif (!isset($callstack[$qkey])) {
|
|
|
|
$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::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);
|
|
}
|
|
|
|
// Since we had split the delete command we don't need the original command anymore
|
|
unset($commands[$key]);
|
|
}
|
|
}
|
|
|
|
if (!$in_commit) {
|
|
// Now we finalize the process
|
|
self::p("COMMIT");
|
|
self::p("START TRANSACTION");
|
|
|
|
$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']))."` = ?";
|
|
|
|
logger(dba::replace_parameters($sql, $command['param']), LOGGER_DATA);
|
|
|
|
if (!self::e($sql, $param)) {
|
|
self::p("ROLLBACK");
|
|
return false;
|
|
}
|
|
} else {
|
|
$key_table = $command['table'];
|
|
$key_param = array_keys($command['param'])[0];
|
|
$value = array_values($command['param'])[0];
|
|
|
|
// Split the SQL queries in chunks of 100 values
|
|
// We do the $i stuff here to make the code better readable
|
|
$i = $counter[$key_table][$key_param];
|
|
if (count($compacted[$key_table][$key_param][$i]) > 100) {
|
|
++$i;
|
|
}
|
|
|
|
$compacted[$key_table][$key_param][$i][$value] = $value;
|
|
$counter[$key_table][$key_param] = $i;
|
|
}
|
|
}
|
|
foreach ($compacted AS $table => $values) {
|
|
foreach ($values AS $field => $field_value_list) {
|
|
foreach ($field_value_list AS $field_values) {
|
|
$sql = "DELETE FROM `".$table."` WHERE `".$field."` IN (".
|
|
substr(str_repeat("?, ", count($field_values)), 0, -2).");";
|
|
|
|
logger(dba::replace_parameters($sql, $field_values), LOGGER_DATA);
|
|
|
|
if (!self::e($sql, $param)) {
|
|
self::p("ROLLBACK");
|
|
return false;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
self::p("COMMIT");
|
|
return true;
|
|
}
|
|
|
|
return $commands;
|
|
}
|
|
|
|
/**
|
|
* @brief Updates rows
|
|
*
|
|
* Updates rows in the database. When $old_fields is set to an array,
|
|
* the system will only do an update if the fields in that array changed.
|
|
*
|
|
* Attention:
|
|
* Only the values in $old_fields are compared.
|
|
* This is an intentional behaviour.
|
|
*
|
|
* Example:
|
|
* We include the timestamp field in $fields but not in $old_fields.
|
|
* Then the row will only get the new timestamp when the other fields had changed.
|
|
*
|
|
* When $old_fields is set to a boolean value the system will do this compare itself.
|
|
* When $old_fields is set to "true" the system will do an insert if the row doesn't exists.
|
|
*
|
|
* Attention:
|
|
* Only set $old_fields to a boolean value when you are sure that you will update a single row.
|
|
* When you set $old_fields to "true" then $fields must contain all relevant fields!
|
|
*
|
|
* @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
|
|
*
|
|
* @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.
|
|
*/
|
|
|
|
$table = self::$dbo->escape($table);
|
|
|
|
if (is_bool($old_fields)) {
|
|
$sql = "SELECT * FROM `".$table."` WHERE `".
|
|
implode("` = ? AND `", array_keys($condition))."` = ? LIMIT 1";
|
|
|
|
$params = array();
|
|
foreach ($condition AS $value) {
|
|
$params[] = $value;
|
|
}
|
|
|
|
$do_insert = $old_fields;
|
|
|
|
$old_fields = self::fetch_first($sql, $params);
|
|
if (is_bool($old_fields)) {
|
|
if ($do_insert) {
|
|
return self::insert($table, $fields);
|
|
}
|
|
$old_fields = array();
|
|
}
|
|
}
|
|
|
|
$do_update = (count($old_fields) == 0);
|
|
|
|
foreach ($old_fields AS $fieldname => $content) {
|
|
if (isset($fields[$fieldname])) {
|
|
if ($fields[$fieldname] == $content) {
|
|
unset($fields[$fieldname]);
|
|
} else {
|
|
$do_update = true;
|
|
}
|
|
}
|
|
}
|
|
|
|
if (!$do_update OR (count($fields) == 0)) {
|
|
return true;
|
|
}
|
|
|
|
$sql = "UPDATE `".$table."` SET `".
|
|
implode("` = ?, `", array_keys($fields))."` = ? WHERE `".
|
|
implode("` = ? AND `", array_keys($condition))."` = ?";
|
|
|
|
$params = array();
|
|
foreach ($fields AS $value) {
|
|
$params[] = $value;
|
|
}
|
|
foreach ($condition AS $value) {
|
|
$params[] = $value;
|
|
}
|
|
|
|
return self::e($sql, $params);
|
|
}
|
|
|
|
/**
|
|
* @brief Select rows from a table
|
|
*
|
|
* @param string $table Table name
|
|
* @param array $fields array of selected fields
|
|
* @param array $condition array of fields for condition
|
|
* @param array $params array of several parameters
|
|
*
|
|
* @return boolean|object If "limit" is equal "1" only a single row is returned, else a query object is returned
|
|
*
|
|
* Example:
|
|
* $table = "item";
|
|
* $fields = array("id", "uri", "uid", "network");
|
|
* $condition = array("uid" => 1, "network" => '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()) {
|
|
if ($table == '') {
|
|
return false;
|
|
}
|
|
|
|
if (count($fields) > 0) {
|
|
$select_fields = "`".implode("`, `", array_values($fields))."`";
|
|
} else {
|
|
$select_fields = "*";
|
|
}
|
|
|
|
if (count($condition) > 0) {
|
|
$condition_string = " WHERE `".implode("` = ? AND `", array_keys($condition))."` = ?";
|
|
} else {
|
|
$condition_string = "";
|
|
}
|
|
|
|
$param_string = '';
|
|
$single_row = false;
|
|
|
|
if (isset($params['order'])) {
|
|
$param_string .= " ORDER BY ";
|
|
foreach ($params['order'] AS $fields => $order) {
|
|
if (!is_int($fields)) {
|
|
$param_string .= "`".$fields."` ".($order ? "ASC" : "DESC").", ";
|
|
} else {
|
|
$param_string .= "`".$order."`, ";
|
|
}
|
|
}
|
|
$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);
|
|
}
|
|
}
|
|
|
|
$sql = "SELECT ".$select_fields." FROM `".$table."`".$condition_string.$param_string;
|
|
|
|
$result = self::p($sql, $condition);
|
|
|
|
if (is_bool($result) OR !$single_row) {
|
|
return $result;
|
|
} else {
|
|
$row = self::fetch($result);
|
|
self::close($result);
|
|
return $row;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @brief Closes the current statement
|
|
*
|
|
* @param object $stmt statement object
|
|
* @return boolean was the close successfull?
|
|
*/
|
|
static public function close($stmt) {
|
|
if (!is_object($stmt)) {
|
|
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);
|
|
}
|
|
}
|
|
}
|
|
|
|
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;
|
|
}
|
|
|
|
// Procedural functions
|
|
function dbg($state) {
|
|
global $db;
|
|
|
|
if ($db) {
|
|
$db->dbg($state);
|
|
}
|
|
}
|
|
|
|
function dbesc($str) {
|
|
global $db;
|
|
|
|
if ($db && $db->connected) {
|
|
return($db->escape($str));
|
|
} else {
|
|
return(str_replace("'","\\'",$str));
|
|
}
|
|
}
|
|
|
|
// 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->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);
|
|
|
|
$db->log_index($stmt);
|
|
|
|
return $db->q($stmt);
|
|
}
|
|
|
|
/**
|
|
*
|
|
* This will happen occasionally trying to store the
|
|
* session data after abnormal program termination
|
|
*
|
|
*/
|
|
logger('dba: no database: ' . print_r($args,true));
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* @brief Performs a query with "dirty reads"
|
|
*
|
|
* 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.
|
|
*
|
|
* @param $args Query parameters (1 to N parameters of different types)
|
|
* @return array Query array
|
|
*/
|
|
function qu($sql) {
|
|
global $db;
|
|
|
|
$args = func_get_args();
|
|
unset($args[0]);
|
|
|
|
if ($db && $db->connected) {
|
|
$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;
|
|
}
|
|
|
|
/**
|
|
*
|
|
* This will happen occasionally trying to store the
|
|
* session data after abnormal program termination
|
|
*
|
|
*/
|
|
logger('dba: no database: ' . print_r($args,true));
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
*
|
|
* Raw db query, no arguments
|
|
*
|
|
*/
|
|
function dbq($sql) {
|
|
global $db;
|
|
|
|
if ($db && $db->connected) {
|
|
$ret = $db->q($sql);
|
|
} else {
|
|
$ret = false;
|
|
}
|
|
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);
|
|
}
|
|
|
|
function dbesc_array(&$arr) {
|
|
if (is_array($arr) && count($arr)) {
|
|
array_walk($arr,'dbesc_array_cb');
|
|
}
|
|
}
|
|
|
|
function dba_timer() {
|
|
return microtime(true);
|
|
}
|