X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=include%2Fdba.php;h=586fc092fb764c51b9c54587f167b30570b51c20;hb=61050c8e301d7965ca927a7f31656de665358e83;hp=ab93598cdd60e3e3684f6a15480d166744c48fcb;hpb=e2b37fd7e4c3d2b6ee487ff1e086d5878ac98b88;p=friendica.git diff --git a/include/dba.php b/include/dba.php index ab93598cdd..586fc092fb 100644 --- a/include/dba.php +++ b/include/dba.php @@ -1,34 +1,34 @@ connected = false; - $this->db = null; - return; + 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 = L10n::t('Cannot locate DNS info for database server \'%s\'', $server); + 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)) { @@ -76,47 +72,31 @@ class dba { $connect .= ";charset=".$a->config["system"]["db_charset"]; } try { - $this->db = @new PDO($connect, $user, $pass); - $this->connected = true; + self::$db = @new PDO($connect, $user, $pass); + self::$connected = true; } catch (PDOException $e) { - $this->connected = false; } } - if (!$this->connected && class_exists('mysqli')) { - $this->driver = 'mysqli'; - $this->db = @new mysqli($server, $user, $pass, $db, $port); + if (!self::$connected && class_exists('mysqli')) { + self::$driver = 'mysqli'; + self::$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"]); - } - } - } - - if (!$this->connected && 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; + 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"]); } } } // No suitable SQL driver was found. - if (!$this->connected) { - $this->db = null; - if (!$install) { - system_unavailable(); - } + if (!self::$connected) { + self::$db = null; } $a->save_timestamp($stamp1, "network"); - self::$dbo = $this; + return self::$connected; } /** @@ -127,21 +107,18 @@ class dba { * * @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; } /** @@ -149,10 +126,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']; } /** @@ -160,7 +137,7 @@ class dba { * * @param string $query The database query that will be analyzed */ - public function log_index($query) { + private static function logIndex($query) { $a = get_app(); if (empty($a->config["system"]["db_log_index"])) { @@ -173,19 +150,19 @@ class dba { } // Only do the explain on "select", "update" and "delete" - if (!in_array(strtolower(substr($query, 0, 6)), array("select", "update", "delete"))) { + if (!in_array(strtolower(substr($query, 0, 6)), ["select", "update", "delete"])) { 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) && ($row['rows'] >= intval($a->config["system"]["db_loglimit_index"]))); @@ -203,7 +180,7 @@ class dba { if ($log) { $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS); - @file_put_contents($a->config["system"]["db_log_index"], datetime_convert()."\t". + @file_put_contents($a->config["system"]["db_log_index"], DateTimeFormat::utcNow()."\t". $row['key']."\t".$row['rows']."\t".$row['Extra']."\t". basename($backtrace[1]["file"])."\t". $backtrace[1]["line"]."\t".$backtrace[2]["function"]."\t". @@ -212,222 +189,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') && (count($r) == 0) && ($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 __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(). @@ -439,8 +227,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); @@ -457,9 +245,9 @@ class dba { * @param string $sql An SQL string without the values * @return string The input SQL string modified if necessary. */ - public function clean_query($sql) { - $search = array("\t", "\n", "\r", " "); - $replace = array(' ', ' ', ' ', ' '); + public static function clean_query($sql) { + $search = ["\t", "\n", "\r", " "]; + $replace = [' ', ' ', ' ', ' ']; do { $oldsql = $sql; $sql = str_replace($search, $replace, $sql); @@ -476,13 +264,13 @@ class dba { * @param array $args The parameters that are to replace the ? placeholders * @return string The replaced SQL query */ - private static function replace_parameters($sql, $args) { + private static function replaceParameters($sql, $args) { $offset = 0; foreach ($args AS $param => $value) { 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); @@ -513,8 +301,12 @@ class dba { /** * @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 + * @return bool|object statement object */ public static function p($sql) { $a = get_app(); @@ -525,7 +317,7 @@ class dba { // Renumber the array keys to be sure that they fit $i = 0; - $args = array(); + $args = []; foreach ($params AS $param) { // Avoid problems with some MySQL servers and boolean values. See issue #3645 if (is_bool($param)) { @@ -534,27 +326,27 @@ class dba { $args[++$i] = $param; } - if (!self::$dbo || !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::$dbo->affected_rows = 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); @@ -568,12 +360,25 @@ class dba { // We are having an own error logging in the function "e" $called_from_e = ($called_from['function'] == 'e'); - switch (self::$dbo->driver) { + 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; } @@ -584,48 +389,48 @@ class dba { 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::$dbo->affected_rows = $retval->rowCount(); + self::$affected_rows = $retval->rowCount(); } break; case 'mysqli': // 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 currently only works with statements that doesn't return values - if (!$can_be_prepared && $called_from_e) { - $retval = self::$dbo->db->query(self::replace_parameters($sql, $args)); - if (self::$dbo->db->errno) { - self::$dbo->error = self::$dbo->db->error; - self::$dbo->errorno = self::$dbo->db->errno; + $can_be_prepared = in_array($command, ['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::replaceParameters($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::$dbo->affected_rows = $retval->num_rows; + self::$affected_rows = $retval->num_rows; } else { - self::$dbo->affected_rows = self::$dbo->db->affected_rows; + self::$affected_rows = self::$db->affected_rows; } } break; } - $stmt = self::$dbo->db->stmt_init(); + $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; } $params = ''; - $values = array(); + $values = []; foreach ($args AS $param => $value) { if (is_int($args[$param])) { $params .= 'i'; @@ -641,48 +446,32 @@ class dba { if (count($values) > 0) { array_unshift($values, $params); - call_user_func_array(array($stmt, 'bind_param'), $values); + call_user_func_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; - self::$dbo->affected_rows = $retval->affected_rows; - } - 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); - } else { - self::$dbo->affected_rows = mysql_affected_rows($retval); - - // Due to missing mysql_* support this here wasn't tested at all - // See here: http://php.net/manual/en/function.mysql-num-rows.php - if (self::$dbo->affected_rows <= 0) { - self::$dbo->affected_rows = mysql_num_rows($retval); - } + self::$affected_rows = $retval->affected_rows; } break; } // We are having an own error logging in the function "e" - if ((self::$dbo->errorno != 0) && !$called_from_e) { + if ((self::$errorno != 0) && !$called_from_e) { // We have to preserve the error code, somewhere in the logging it get lost - $error = self::$dbo->error; - $errorno = self::$dbo->errorno; + $error = self::$error; + $errorno = self::$errorno; - logger('DB Error '.self::$dbo->errorno.': '.self::$dbo->error."\n". - $a->callstack(8)."\n".self::replace_parameters($sql, $params)); + logger('DB Error '.self::$errorno.': '.self::$error."\n". + System::callstack(8)."\n".self::replaceParameters($sql, $params)); - self::$dbo->error = $error; - self::$dbo->errorno = $errorno; + self::$error = $error; + self::$errorno = $errorno; } $a->save_timestamp($stamp1, 'database'); @@ -696,10 +485,10 @@ class dba { $duration = round($duration, 3); $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS); - @file_put_contents($a->config["system"]["db_log"], datetime_convert()."\t".$duration."\t". + @file_put_contents($a->config["system"]["db_log"], DateTimeFormat::utcNow()."\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); + substr(self::replaceParameters($sql, $args), 0, 2000)."\n", FILE_APPEND); } } return $retval; @@ -708,6 +497,8 @@ 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 */ @@ -734,18 +525,18 @@ class dba { self::close($stmt); - } while ((self::$dbo->errorno == 1213) && (--$timeout > 0)); + } while ((self::$errorno == 1213) && (--$timeout > 0)); - if (self::$dbo->errorno != 0) { + if (self::$errorno != 0) { // We have to preserve the error code, somewhere in the logging it get lost - $error = self::$dbo->error; - $errorno = self::$dbo->errorno; + $error = self::$error; + $errorno = self::$errorno; - logger('DB Error '.self::$dbo->errorno.': '.self::$dbo->error."\n". - $a->callstack(8)."\n".self::replace_parameters($sql, $params)); + logger('DB Error '.self::$errorno.': '.self::$error."\n". + System::callstack(8)."\n".self::replaceParameters($sql, $params)); - self::$dbo->error = $error; - self::$dbo->errorno = $errorno; + self::$error = $error; + self::$errorno = $errorno; } $a->save_timestamp($stamp, "database_write"); @@ -766,15 +557,15 @@ class dba { return false; } - $fields = array(); + $fields = []; - $array_element = each($condition); - $array_key = $array_element['key']; - if (!is_int($array_key)) { - $fields = array($array_key); + reset($condition); + $first_key = key($condition); + if (!is_int($first_key)) { + $fields = [$first_key]; } - $stmt = self::select($table, $fields, $condition, array('limit' => 1, 'only_query' => true)); + $stmt = self::select($table, $fields, $condition, ['limit' => 1]); if (is_bool($stmt)) { $retval = $stmt; @@ -788,8 +579,11 @@ class dba { } /** - * @brief Fetches the first row + * Fetches the first row + * + * Please use dba::selectFirst or dba::exists whenever this is possible. * + * @brief Fetches the first row * @param string $sql SQL statement * @return array first row of query */ @@ -815,26 +609,42 @@ class dba { * @return int Number of rows */ public static function affected_rows() { - return self::$dbo->affected_rows; + return self::$affected_rows; } /** - * @brief Returns the number of rows of a statement + * @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 PDOStatement|mysqli_result|mysqli_stmt Statement object * @return int Number of rows */ 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; } @@ -842,29 +652,41 @@ class dba { /** * @brief Fetch a single row * - * @param object $stmt statement object + * @param mixed $stmt statement object * @return array current row */ public static function fetch($stmt) { + $a = get_app(); + + $stamp1 = microtime(true); + + $columns = []; + if (!is_object($stmt)) { return false; } - switch (self::$dbo->driver) { + switch (self::$driver) { case 'pdo': - return $stmt->fetch(PDO::FETCH_ASSOC); + $columns = $stmt->fetch(PDO::FETCH_ASSOC); + break; case 'mysqli': + if (get_class($stmt) == 'mysqli_result') { + $columns = $stmt->fetch_assoc(); + break; + } + // This code works, but is slow // Bind the result to a result array - $cols = array(); + $cols = []; - $cols_num = array(); + $cols_num = []; for ($x = 0; $x < $stmt->field_count; $x++) { $cols[] = &$cols_num[$x]; } - call_user_func_array(array($stmt, 'bind_result'), $cols); + call_user_func_array([$stmt, 'bind_result'], $cols); if (!$stmt->fetch()) { return false; @@ -876,14 +698,14 @@ class dba { $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); } + + $a->save_timestamp($stamp1, 'database'); + + return $columns; } /** @@ -896,7 +718,13 @@ class dba { * @return boolean was the insert successfull? */ public static function insert($table, $param, $on_duplicate_update = false) { - $sql = "INSERT INTO `".self::$dbo->escape($table)."` (`".implode("`, `", array_keys($param))."`) VALUES (". + + 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) { @@ -914,16 +742,13 @@ class dba { * * @return integer Last inserted id */ - function lastInsertId() { - switch (self::$dbo->driver) { + public static function lastInsertId() { + switch (self::$driver) { case 'pdo': - $id = self::$dbo->db->lastInsertId(); + $id = self::$db->lastInsertId(); break; case 'mysqli': - $id = self::$dbo->db->insert_id; - break; - case 'mysql': - $id = mysql_insert_id(self::$dbo); + $id = self::$db->insert_id; break; } return $id; @@ -941,7 +766,7 @@ class dba { 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 { @@ -1009,40 +834,45 @@ class dba { /** * @brief Build the array with the table relations * - * The array is build from the database definitions in dbstructure.php + * 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(); + private static function buildRelationData() { + $definition = DBStructure::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; + } + } + } } } /** * @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 + * @param string $table Table name + * @param array $conditions Field condition(s) + * @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 + * @return boolean|array was the delete successful? When $in_process is set: deletion data */ - public static function delete($table, $param, $in_process = false, &$callstack = array()) { + public static function delete($table, array $conditions, $in_process = false, array &$callstack = []) + { + if (empty($table) || empty($conditions)) { + logger('Table and conditions have to be set'); + return false; + } - $commands = array(); + $commands = []; // Create a key for the loop prevention - $key = $table.':'.implode(':', array_keys($param)).':'.implode(':', $param); + $key = $table . ':' . implode(':', array_keys($conditions)) . ':' . implode(':', $conditions); // We quit when this key already exists in the callstack. if (isset($callstack[$key])) { @@ -1051,13 +881,13 @@ class dba { $callstack[$key] = true; - $table = self::$dbo->escape($table); + $table = self::escape($table); - $commands[$key] = array('table' => $table, 'param' => $param); + $commands[$key] = ['table' => $table, 'conditions' => $conditions]; // To speed up the whole process we cache the table relations if (count(self::$relation) == 0) { - self::build_relation_data(); + self::buildRelationData(); } // Is there a relation entry for the table? @@ -1067,28 +897,28 @@ class dba { $rel_def = array_values(self::$relation[$table])[0]; // Create a key for preventing double queries - $qkey = $field.'-'.$table.':'.implode(':', array_keys($param)).':'.implode(':', $param); + $qkey = $field . '-' . $table . ':' . implode(':', array_keys($conditions)) . ':' . implode(':', $conditions); // 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])) { + if ((count($conditions) == 1) && ($field == array_keys($conditions)[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); + $retval = self::delete($rel_table, [$rel_field => array_values($conditions)[0]], true, $callstack); $commands = array_merge($commands, $retval); } } - // We quit when this key already exists in the callstack. + // 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); + $data = self::select($table, [$field], $conditions); while ($row = self::fetch($data)) { // Now we accumulate the delete commands - $retval = self::delete($table, array($field => $row[$field]), true, $callstack); + $retval = self::delete($table, [$field => $row[$field]], true, $callstack); $commands = array_merge($commands, $retval); } @@ -1107,24 +937,21 @@ class dba { self::transaction(); } - $compacted = array(); - $counter = array(); + $compacted = []; + $counter = []; 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))."` = ?"; - } + $conditions = $command['conditions']; + reset($conditions); + $first_key = key($conditions); - if ((count($command['param']) > 1) || is_int($array_key)) { - $sql = "DELETE FROM `".$command['table']."`".$condition_string; - logger(self::replace_parameters($sql, $condition), LOGGER_DATA); + $condition_string = self::buildCondition($conditions); - if (!self::e($sql, $condition)) { + if ((count($command['conditions']) > 1) || is_int($first_key)) { + $sql = "DELETE FROM `" . $command['table'] . "`" . $condition_string; + logger(self::replaceParameters($sql, $conditions), LOGGER_DATA); + + if (!self::e($sql, $conditions)) { if ($do_transaction) { self::rollback(); } @@ -1132,27 +959,27 @@ class dba { } } else { $key_table = $command['table']; - $key_param = array_keys($command['param'])[0]; - $value = array_values($command['param'])[0]; + $key_condition = array_keys($command['conditions'])[0]; + $value = array_values($command['conditions'])[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 = $counter[$key_table][$key_condition]; + if (count($compacted[$key_table][$key_condition][$i]) > 100) { ++$i; } - $compacted[$key_table][$key_param][$i][$value] = $value; - $counter[$key_table][$key_param] = $i; + $compacted[$key_table][$key_condition][$i][$value] = $value; + $counter[$key_table][$key_condition] = $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).");"; + $sql = "DELETE FROM `" . $table . "` WHERE `" . $field . "` IN (" . + substr(str_repeat("?, ", count($field_values)), 0, -2) . ");"; - logger(self::replace_parameters($sql, $field_values), LOGGER_DATA); + logger(self::replaceParameters($sql, $field_values), LOGGER_DATA); if (!self::e($sql, $field_values)) { if ($do_transaction) { @@ -1200,33 +1027,28 @@ class dba { * * @return boolean was the update successfull? */ - public static function update($table, $fields, $condition, $old_fields = array()) { - - $table = self::$dbo->escape($table); + public static function update($table, $fields, $condition, $old_fields = []) { - 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))."` = ?"; - } - } else { - $condition_string = ""; + if (empty($table) || empty($fields) || empty($condition)) { + logger('Table, fields and condition have to be set'); + return false; } + $table = self::escape($table); + + $condition_string = self::buildCondition($condition); + if (is_bool($old_fields)) { $do_insert = $old_fields; - $old_fields = self::select($table, array(), $condition, array('limit' => 1)); + $old_fields = self::selectFirst($table, [], $condition); if (is_bool($old_fields)) { if ($do_insert) { $values = array_merge($condition, $fields); return self::insert($table, $values, $do_insert); } - $old_fields = array(); + $old_fields = []; } } @@ -1256,84 +1078,179 @@ class dba { return self::e($sql, $params); } + /** + * Retrieve a single record from a table and returns it in an associative array + * + * @brief Retrieve a single record from a table + * @param string $table + * @param array $fields + * @param array $condition + * @param array $params + * @return bool|array + * @see dba::select + */ + public static function selectFirst($table, array $fields = [], array $condition = [], $params = []) + { + $params['limit'] = 1; + $result = self::select($table, $fields, $condition, $params); + + if (is_bool($result)) { + return $result; + } else { + $row = self::fetch($result); + self::close($result); + return $row; + } + } + /** * @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 + * @param string $table Table name + * @param array $fields Array of selected fields, empty for all + * @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 + * @return boolean|object * * Example: * $table = "item"; * $fields = array("id", "uri", "uid", "network"); + * * $condition = array("uid" => 1, "network" => 'dspr'); - * $params = array("order" => array("id", "received" => true), "limit" => 1); + * or: + * $condition = array("`uid` = ? AND `network` IN (?, ?)", 1, 'dfrn', 'dspr'); + * + * $params = array("order" => array("id", "received" => true), "limit" => 10); * * $data = dba::select($table, $fields, $condition, $params); */ - public static function select($table, $fields = array(), $condition = array(), $params = array()) { + public static function select($table, array $fields = [], array $condition = [], array $params = []) + { if ($table == '') { return false; } + $table = self::escape($table); + if (count($fields) > 0) { - $select_fields = "`".implode("`, `", array_values($fields))."`"; + $select_fields = "`" . implode("`, `", array_values($fields)) . "`"; } else { $select_fields = "*"; } - 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))."` = ?"; - } - } else { - $condition_string = ""; - } - - $param_string = ''; - $single_row = false; + $condition_string = self::buildCondition($condition); + $order_string = ''; if (isset($params['order'])) { - $param_string .= " ORDER BY "; + $order_string = " ORDER BY "; foreach ($params['order'] AS $fields => $order) { if (!is_int($fields)) { - $param_string .= "`".$fields."` ".($order ? "DESC" : "ASC").", "; + $order_string .= "`" . $fields . "` " . ($order ? "DESC" : "ASC") . ", "; } else { - $param_string .= "`".$order."`, "; + $order_string .= "`" . $order . "`, "; } } - $param_string = substr($param_string, 0, -2); + $order_string = substr($order_string, 0, -2); } + $limit_string = ''; if (isset($params['limit']) && is_int($params['limit'])) { - $param_string .= " LIMIT ".$params['limit']; - $single_row = ($params['limit'] == 1); + $limit_string = " LIMIT " . $params['limit']; } - if (isset($params['only_query']) && $params['only_query']) { - $single_row = !$params['only_query']; + if (isset($params['limit']) && is_array($params['limit'])) { + $limit_string = " LIMIT " . intval($params['limit'][0]) . ", " . intval($params['limit'][1]); } - $sql = "SELECT ".$select_fields." FROM `".$table."`".$condition_string.$param_string; + $sql = "SELECT " . $select_fields . " FROM `" . $table . "`" . $condition_string . $order_string . $limit_string; $result = self::p($sql, $condition); - if (is_bool($result) || !$single_row) { - return $result; - } else { - $row = self::fetch($result); - self::close($result); - return $row; + return $result; + } + + /** + * @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 + * + * Example: + * $table = "item"; + * + * $condition = ["uid" => 1, "network" => 'dspr']; + * or: + * $condition = ["`uid` = ? AND `network` IN (?, ?)", 1, 'dfrn', 'dspr']; + * + * $count = dba::count($table, $condition); + */ + public static function count($table, array $condition = []) + { + if ($table == '') { + return false; } + + $condition_string = self::buildCondition($condition); + + $sql = "SELECT COUNT(*) AS `count` FROM `".$table."`".$condition_string; + + $row = self::fetch_first($sql, $condition); + + return $row['count']; } + /** + * @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) { + reset($condition); + $first_key = key($condition); + if (is_int($first_key)) { + $condition_string = " WHERE ".array_shift($condition); + } else { + $new_values = []; + $condition_string = ""; + foreach ($condition as $field => $value) { + if ($condition_string != "") { + $condition_string .= " AND "; + } + if (is_array($value)) { + $new_values = array_merge($new_values, array_values($value)); + $placeholders = substr(str_repeat("?, ", count($value)), 0, -2); + $condition_string .= "`" . $field . "` IN (" . $placeholders . ")"; + } else { + $new_values[$field] = $value; + $condition_string .= "`" . $field . "` = ?"; + } + } + $condition_string = " WHERE " . $condition_string; + $condition = $new_values; + } + } + + return $condition_string; + } /** * @brief Fills an array with data from a query @@ -1346,7 +1263,7 @@ class dba { return $stmt; } - $data = array(); + $data = []; while ($row = self::fetch($stmt)) { $data[] = $row; } @@ -1356,158 +1273,101 @@ class dba { 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) + */ + public static function errorMessage() { + return self::$error; + } + /** * @brief Closes the current statement * * @param object $stmt statement object - * @return boolean was the close successfull? + * @return boolean was the close successful? */ public static function close($stmt) { + $a = get_app(); + + $stamp1 = microtime(true); + if (!is_object($stmt)) { return false; } - switch (self::$dbo->driver) { + switch (self::$driver) { case 'pdo': - return $stmt->closeCursor(); + $ret = $stmt->closeCursor(); + break; case 'mysqli': - return $stmt->free_result(); - return $stmt->close(); - case 'mysql': - return mysql_free_result($stmt); + $stmt->free_result(); + $ret = $stmt->close(); + break; } - } -} - -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; + $a->save_timestamp($stamp1, 'database'); - if ($db) { - $db->dbg($state); + return $ret; } } function dbesc($str) { - global $db; - - if ($db && $db->connected) { - return($db->escape($str)); + if (dba::$connected) { + return(dba::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->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); - - $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" + * @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 + * @return array|bool 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() {