X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=include%2Fdba.php;h=fe191a9e21b3bf46f2043119b0d669a19b75c634;hb=755f6e8cc1ceb5fab0c0f63deb3ca7048d1ea48d;hp=93df40b401c8b9e2f93da6116718a18fafacb847;hpb=782783aa52f504811aa13b7495880e1d6f758fd2;p=friendica.git diff --git a/include/dba.php b/include/dba.php index 93df40b401..fe191a9e21 100644 --- a/include/dba.php +++ b/include/dba.php @@ -1,127 +1,130 @@ 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; + 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)) { + $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; + 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); - 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($server,$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(); } } $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; } /** @@ -129,10 +132,10 @@ class dba { * * @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']; } /** @@ -140,10 +143,10 @@ class dba { * * @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; } @@ -157,27 +160,27 @@ class dba { 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; } @@ -192,237 +195,33 @@ class dba { } } - 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) { + public static function escape($str) { + switch (self::$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; + return substr(@self::$db->quote($str, PDO::PARAM_STR), 1, -1); case 'mysqli': - $result = @$this->db->query($sql); - break; - case 'mysql': - $result = @mysql_query($sql,$this->db); - break; + return @self::$db->real_escape_string($str); } - $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); - } - } - } + public static function connected() { + $connected = false; - 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(). @@ -434,8 +233,8 @@ class dba { * @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); @@ -443,6 +242,27 @@ class dba { return $sql; } + /** + * @brief beautifies the query - useful for "SHOW PROCESSLIST" + * + * This is safe when we bind the parameters later. + * The parameter values aren't part of the SQL. + * + * @param string $sql An SQL string without the values + * @return string The input SQL string modified if necessary. + */ + public static function clean_query($sql) { + $search = array("\t", "\n", "\r", " "); + $replace = array(' ', ' ', ' ', ' '); + do { + $oldsql = $sql; + $sql = str_replace($search, $replace, $sql); + } while ($oldsql != $sql); + + return $sql; + } + + /** * @brief Replaces the ? placeholders with the parameters in the $args array * @@ -450,13 +270,13 @@ class dba { * @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); @@ -468,48 +288,103 @@ class dba { 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]); + $params = self::getParam(func_get_args()); - // When the second function parameter is an array then use this as the parameter array - if ((count($args) == 1) AND (is_array($args[1]))) { - $params = $args[1]; - $i = 0; - foreach ($params AS $param) { - $args[++$i] = $param; + // 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; } - $sql = self::$dbo->any_value_fallback($sql); + 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::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; } @@ -519,20 +394,43 @@ class dba { } if (!$stmt->execute()) { - $errorInfo = self::$dbo->db->errorInfo(); - self::$dbo->error = $errorInfo[2]; - self::$dbo->errorno = $errorInfo[1]; + $errorInfo = $stmt->errorInfo(); + 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 = self::$dbo->db->error; - self::$dbo->errorno = self::$dbo->db->errno; + self::$error = $stmt->error; + self::$errorno = $stmt->errno; $retval = false; break; } @@ -552,31 +450,34 @@ class dba { $values[] = &$args[$param]; } - array_unshift($values, $params); - - call_user_func_array(array($stmt, 'bind_param'), $values); + 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; + 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); + // 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'); @@ -602,27 +503,47 @@ class dba { /** * @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"); @@ -632,13 +553,25 @@ class dba { /** * @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; @@ -654,13 +587,15 @@ class dba { /** * @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; @@ -673,20 +608,48 @@ class dba { 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) { - switch (self::$dbo->driver) { + public static function num_rows($stmt) { + if (!is_object($stmt)) { + return 0; + } + switch (self::$driver) { case 'pdo': return $stmt->rowCount(); case 'mysqli': return $stmt->num_rows; - case 'mysql': - return mysql_num_rows($stmt); } return 0; } @@ -697,15 +660,19 @@ class dba { * @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 @@ -733,8 +700,6 @@ class dba { $columns[$fields[$param]->name] = $col; } return $columns; - case 'mysql': - return mysql_fetch_array(self::$dbo->result, MYSQL_ASSOC); } } @@ -743,192 +708,630 @@ class dba { * * @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 + * + * This function can be extended in the future to accept a table array as well. + * + * @param string $table Table name + * + * @return boolean was the lock successful? + */ + 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::escape($table)."` WRITE"); + if (!$success) { + self::e("SET autocommit=1"); + } else { + self::$in_transaction = true; + } + return $success; + } + + /** + * @brief Unlocks all locked tables + * + * @return boolean was the unlock successful? + */ + 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"); + self::e("SET autocommit=1"); + self::$in_transaction = false; + return $success; + } + + /** + * @brief Starts a transaction + * + * @return boolean Was the command executed successfully? + */ + public static function transaction() { + if (!self::e('COMMIT')) { + return false; + } + if (!self::e('START TRANSACTION')) { + return false; + } + self::$in_transaction = true; + return true; + } + + /** + * @brief Does a commit + * + * @return boolean Was the command executed successfully? + */ + public static function commit() { + if (!self::e('COMMIT')) { + return false; + } + self::$in_transaction = false; + return true; + } + + /** + * @brief Does a rollback + * + * @return boolean Was the command executed successfully? + */ + public static function rollback() { + if (!self::e('ROLLBACK')) { + return false; + } + self::$in_transaction = false; + return true; + } + + /** + * @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. + */ + 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; + } + } + } + } + } + + /** + * @brief Delete a row from a table + * + * @param string $table Table name + * @param array $param parameter array + * @param boolean $in_process 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_process is set: deletion data + */ + 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(); + + // 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::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) && ($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 + $data = self::select($table, array($field), $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]); + } + } + + if (!$in_process) { + // Now we finalize the process + $do_transaction = !self::$in_transaction; + + if ($do_transaction) { + self::transaction(); + } + + $compacted = array(); + $counter = array(); + + foreach ($commands AS $command) { + $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))."` = ?"; + } + + 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, $condition)) { + if ($do_transaction) { + self::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(self::replace_parameters($sql, $field_values), LOGGER_DATA); + + if (!self::e($sql, $field_values)) { + if ($do_transaction) { + self::rollback(); + } + return false; + } + } + } + } + if ($do_transaction) { + self::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 (true = update on duplicate) * * @return boolean was the update successfull? */ - static public function update($table, $fields, $condition) { + public static function update($table, $fields, $condition, $old_fields = array()) { + + if (empty($table) || empty($fields) || empty($condition)) { + logger('Table, fields and condition have to be set'); + return false; + } + + $table = self::escape($table); - $sql = "UPDATE `".self::$dbo->escape($table)."` SET `". - implode("` = ?, `", array_keys($fields))."` = ? WHERE `". - implode("` = ? AND `", array_keys($condition))."` = ?"; + $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::select($table, array(), $condition, array('limit' => 1)); - $params = array(); - foreach ($fields AS $value) { - $params[] = $value; + if (is_bool($old_fields)) { + if ($do_insert) { + $values = array_merge($condition, $fields); + return self::insert($table, $values, $do_insert); + } + $old_fields = array(); + } } - foreach ($condition AS $value) { - $params[] = $value; + + $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; + } + } } - self::e($sql, $params); + if (!$do_update || (count($fields) == 0)) { + return true; + } + + $sql = "UPDATE `".$table."` SET `". + implode("` = ?, `", array_keys($fields))."` = ?".$condition_string; + + $params1 = array_values($fields); + $params2 = array_values($condition); + $params = array_merge_recursive($params1, $params2); + + return self::e($sql, $params); } /** - * @brief Closes the current statement + * @brief Select rows from a table * - * @param object $stmt statement object - * @return boolean was the close successfull? + * @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'); + * 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 close($stmt) { - if (!is_object($stmt)) { + public static function select($table, array $fields = [], array $condition = [], array $params = []) + { + 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); + if (count($fields) > 0) { + $select_fields = "`".implode("`, `", array_values($fields))."`"; + } else { + $select_fields = "*"; } - } -} -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; -} + $condition_string = self::buildCondition($condition); -// Procedural functions -function dbg($state) { - global $db; + $param_string = ''; + $single_row = false; - if ($db) { - $db->dbg($state); - } -} + if (isset($params['order'])) { + $param_string .= " ORDER BY "; + foreach ($params['order'] AS $fields => $order) { + if (!is_int($fields)) { + $param_string .= "`".$fields."` ".($order ? "DESC" : "ASC").", "; + } else { + $param_string .= "`".$order."`, "; + } + } + $param_string = substr($param_string, 0, -2); + } -function dbesc($str) { - global $db; + if (isset($params['limit']) && is_int($params['limit'])) { + $param_string .= " LIMIT ".$params['limit']; + $single_row = ($params['limit'] == 1); + } - if ($db && $db->connected) { - return($db->escape($str)); - } else { - return(str_replace("'","\\'",$str)); - } -} + 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); + } -// 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 (isset($params['only_query']) && $params['only_query']) { + $single_row = !$params['only_query']; + } - 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); + $sql = "SELECT ".$select_fields." FROM `".$table."`".$condition_string.$param_string; - $db->log_index($stmt); + $result = self::p($sql, $condition); - return $db->q($stmt); + if (is_bool($result) || !$single_row) { + return $result; + } else { + $row = self::fetch($result); + self::close($result); + return $row; + } } /** + * @brief Counts the rows from a table satisfying the provided condition + * + * @param string $table Table name + * @param array $condition array of fields for condition + * + * @return int * - * This will happen occasionally trying to store the - * session data after abnormal program termination + * Example: + * $table = "item"; * + * $condition = ["uid" => 1, "network" => 'dspr']; + * or: + * $condition = ["`uid` = ? AND `network` IN (?, ?)", 1, 'dfrn', 'dspr']; + * + * $count = dba::count($table, $condition); */ - logger('dba: no database: ' . print_r($args,true)); - return false; -} + public static function count($table, array $condition = []) + { + if ($table == '') { + 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; + $condition_string = self::buildCondition($condition); - $args = func_get_args(); - unset($args[0]); + $sql = "SELECT COUNT(*) AS `count` FROM `".$table."`".$condition_string; - 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); + $row = self::fetch_first($sql, $condition); - $db->log_index($stmt); + return $row['count']; + } - $db->q("SET SESSION TRANSACTION ISOLATION LEVEL READ UNCOMMITTED;"); - $retval = $db->q($stmt); - $db->q("SET SESSION TRANSACTION ISOLATION LEVEL REPEATABLE READ;"); - return $retval; + /** + * @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))."` = ?"; + } + } + + return $condition_string; } /** + * @brief Fills an array with data from a query * - * This will happen occasionally trying to store the - * session data after abnormal program termination + * @param object $stmt statement object + * @return array Data array + */ + public static function inArray($stmt, $do_close = true) { + if (is_bool($stmt)) { + return $stmt; + } + + $data = array(); + while ($row = self::fetch($stmt)) { + $data[] = $row; + } + if ($do_close) { + self::close($stmt); + } + return $data; + } + + /** + * @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 * + * @return string Error message ('' if no error) */ - logger('dba: no database: ' . print_r($args,true)); - return false; + public static function errorMessage() { + return self::$error; + } + + /** + * @brief Closes the current statement + * + * @param object $stmt statement object + * @return boolean was the close successfull? + */ + 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 execute SQL query with printf style args - deprecated * - * Raw db query, no arguments + * 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 dbq($sql) { - global $db; +function q($sql) { + $args = func_get_args(); + unset($args[0]); - if ($db && $db->connected) { - $ret = $db->q($sql); - } else { - $ret = false; + if (!dba::$connected) { + return 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); -} + $sql = dba::clean_query($sql); + $sql = dba::any_value_fallback($sql); -function dbesc_array(&$arr) { - if (is_array($arr) && count($arr)) { - array_walk($arr,'dbesc_array_cb'); + $stmt = @vsprintf($sql, $args); + + $ret = dba::p($stmt); + + if (is_bool($ret)) { + return $ret; } + + $columns = dba::columnCount($ret); + + $data = dba::inArray($ret); + + if ((count($data) == 0) && ($columns == 0)) { + return true; + } + + return $data; } function dba_timer() {