X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=include%2Fdba.php;h=fa33f245aeb0210c3a23030f16c4f3d72e3ceaf1;hb=6d7ececc4206dd9b5dc06cdf4454a93bf54a664e;hp=dd95a74c53c5a7285daf9d643f2eefd3bb371a6f;hpb=e6e8ebbac5ec0b7d93c164c2ffd4c6c80fb845fc;p=friendica.git diff --git a/include/dba.php b/include/dba.php index dd95a74c53..fa33f245ae 100644 --- a/include/dba.php +++ b/include/dba.php @@ -1,4 +1,6 @@ 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; + /** + * @brief execute SQL query - deprecated + * + * Please use the dba:: functions instead: + * dba::select, dba::exists, dba::insert + * dba::delete, dba::update, dba::p, dba::e + * + * @param string $sql SQL query + * @return array Query array + */ + public function q($sql) { + $ret = self::p($sql); - logger('dba: ' . $str ); + if (is_bool($ret)) { + return $ret; } - /** - * 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. - */ + $columns = self::columnCount($ret); - 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); - } - } + $data = self::inArray($ret); - if (is_bool($result)) { - return $result; - } - if ($onlyquery) { - $this->result = $result; + if ((count($data) == 0) && ($columns == 0)) { 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); + return $data; } public function dbg($dbg) { @@ -412,21 +275,6 @@ class dba { 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) { @@ -491,7 +339,7 @@ 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]) || is_float($args[$param])) { @@ -528,10 +376,14 @@ 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 */ - static public function p($sql) { + public static function p($sql) { $a = get_app(); $stamp1 = microtime(true); @@ -542,6 +394,10 @@ class dba { $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; } @@ -549,7 +405,7 @@ class dba { 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); } @@ -560,7 +416,7 @@ class dba { $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 = ''; @@ -581,6 +437,19 @@ class dba { switch (self::$dbo->driver) { case 'pdo': + // If there are no arguments we use "query" + if (count($args) == 0) { + if (!$retval = self::$dbo->db->query($sql)) { + $errorInfo = self::$dbo->db->errorInfo(); + self::$dbo->error = $errorInfo[2]; + self::$dbo->errorno = $errorInfo[1]; + $retval = false; + break; + } + self::$dbo->affected_rows = $retval->rowCount(); + break; + } + if (!$stmt = self::$dbo->db->prepare($sql)) { $errorInfo = self::$dbo->db->errorInfo(); self::$dbo->error = $errorInfo[2]; @@ -609,8 +478,8 @@ class dba { $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) { + // The fallback routine is called as well when there are no arguments + if (!$can_be_prepared || (count($args) == 0)) { $retval = self::$dbo->db->query(self::replace_parameters($sql, $args)); if (self::$dbo->db->errno) { self::$dbo->error = self::$dbo->db->error; @@ -690,7 +559,7 @@ class dba { $errorno = self::$dbo->errorno; logger('DB Error '.self::$dbo->errorno.': '.self::$dbo->error."\n". - $a->callstack(8)."\n".self::replace_parameters($sql, $params)); + System::callstack(8)."\n".self::replace_parameters($sql, $params)); self::$dbo->error = $error; self::$dbo->errorno = $errorno; @@ -719,10 +588,12 @@ 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); @@ -753,7 +624,7 @@ class dba { $errorno = self::$dbo->errorno; logger('DB Error '.self::$dbo->errorno.': '.self::$dbo->error."\n". - $a->callstack(8)."\n".self::replace_parameters($sql, $params)); + System::callstack(8)."\n".self::replace_parameters($sql, $params)); self::$dbo->error = $error; self::$dbo->errorno = $errorno; @@ -767,13 +638,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) { - $params = self::getParam(func_get_args()); + public static function exists($table, $condition) { + if (empty($table)) { + return false; + } - $stmt = self::p($sql, $params); + $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; @@ -789,10 +672,12 @@ 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) { + public static function fetch_first($sql) { $params = self::getParam(func_get_args()); $stmt = self::p($sql, $params); @@ -813,17 +698,37 @@ class dba { * * @return int Number of rows */ - static public function affected_rows() { + public static function affected_rows() { return self::$dbo->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::$dbo->driver) { + case 'pdo': + return $stmt->columnCount(); + case 'mysqli': + return $stmt->field_count; + case 'mysql': + return mysql_affected_rows($stmt); + } + return 0; + } /** * @brief Returns the number of rows of a statement * * @param object Statement object * @return int Number of rows */ - static public function num_rows($stmt) { + public static function num_rows($stmt) { if (!is_object($stmt)) { return 0; } @@ -844,7 +749,7 @@ 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; } @@ -853,6 +758,10 @@ class dba { 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 @@ -894,7 +803,7 @@ class dba { * * @return boolean was the insert successfull? */ - static public function insert($table, $param, $on_duplicate_update = false) { + public static function insert($table, $param, $on_duplicate_update = false) { $sql = "INSERT INTO `".self::$dbo->escape($table)."` (`".implode("`, `", array_keys($param))."`) VALUES (". substr(str_repeat("?, ", count($param)), 0, -2).")"; @@ -908,6 +817,26 @@ class dba { 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::$dbo->driver) { + case 'pdo': + $id = self::$dbo->db->lastInsertId(); + break; + case 'mysqli': + $id = self::$dbo->db->insert_id; + break; + case 'mysql': + $id = mysql_insert_id(self::$dbo); + break; + } + return $id; + } + /** * @brief Locks a table for exclusive write access * @@ -917,7 +846,7 @@ class dba { * * @return boolean was the lock successful? */ - static public function lock($table) { + public static function lock($table) { // See here: https://dev.mysql.com/doc/refman/5.7/en/lock-tables-and-transactions.html self::e("SET autocommit=0"); $success = self::e("LOCK TABLES `".self::$dbo->escape($table)."` WRITE"); @@ -934,7 +863,7 @@ class dba { * * @return boolean was the unlock successful? */ - static public function unlock() { + public static function unlock() { // See here: https://dev.mysql.com/doc/refman/5.7/en/lock-tables-and-transactions.html self::e("COMMIT"); $success = self::e("UNLOCK TABLES"); @@ -948,7 +877,7 @@ class dba { * * @return boolean Was the command executed successfully? */ - static public function transaction() { + public static function transaction() { if (!self::e('COMMIT')) { return false; } @@ -964,7 +893,7 @@ class dba { * * @return boolean Was the command executed successfully? */ - static public function commit() { + public static function commit() { if (!self::e('COMMIT')) { return false; } @@ -977,7 +906,7 @@ class dba { * * @return boolean Was the command executed successfully? */ - static public function rollback() { + public static function rollback() { if (!self::e('ROLLBACK')) { return false; } @@ -992,17 +921,17 @@ class dba { * * This process must only be started once, since the value is cached. */ - static private function build_relation_data() { + private static function build_relation_data() { $definition = db_definition(); foreach ($definition AS $table => $structure) { - foreach ($structure['fields'] AS $field => $field_struct) { - if (isset($field_struct['relation'])) { - foreach ($field_struct['relation'] AS $rel_table => $rel_field) { - self::$relation[$rel_table][$rel_field][$table][] = $field; - } - } - } + foreach ($structure['fields'] AS $field => $field_struct) { + if (isset($field_struct['relation'])) { + foreach ($field_struct['relation'] AS $rel_table => $rel_field) { + self::$relation[$rel_table][$rel_field][$table][] = $field; + } + } + } } } @@ -1016,7 +945,7 @@ class dba { * * @return boolean|array was the delete successfull? When $in_process is set: deletion data */ - static public function delete($table, $param, $in_process = false, &$callstack = array()) { + public static function delete($table, $param, $in_process = false, &$callstack = array()) { $commands = array(); @@ -1063,16 +992,16 @@ class dba { $callstack[$qkey] = true; // Fetch all rows that are to be deleted - $sql = "SELECT ".self::$dbo->escape($field)." FROM `".$table."` WHERE `". - implode("` = ? AND `", array_keys($param))."` = ?"; + $data = self::select($table, array($field), $param); - $data = self::p($sql, $param); while ($row = self::fetch($data)) { // Now we accumulate the delete commands $retval = self::delete($table, array($field => $row[$field]), true, $callstack); $commands = array_merge($commands, $retval); } + self::close($data); + // Since we had split the delete command we don't need the original command anymore unset($commands[$key]); } @@ -1088,14 +1017,22 @@ class dba { $compacted = array(); $counter = array(); + foreach ($commands AS $command) { - if (count($command['param']) > 1) { - $sql = "DELETE FROM `".$command['table']."` WHERE `". - implode("` = ? AND `", array_keys($command['param']))."` = ?"; + $condition = $command['param']; + $array_element = each($condition); + $array_key = $array_element['key']; + if (is_int($array_key)) { + $condition_string = " WHERE ".array_shift($condition); + } else { + $condition_string = " WHERE `".implode("` = ? AND `", array_keys($condition))."` = ?"; + } - logger(self::replace_parameters($sql, $command['param']), LOGGER_DATA); + if ((count($command['param']) > 1) || is_int($array_key)) { + $sql = "DELETE FROM `".$command['table']."`".$condition_string; + logger(self::replace_parameters($sql, $condition), LOGGER_DATA); - if (!self::e($sql, $command['param'])) { + if (!self::e($sql, $condition)) { if ($do_transaction) { self::rollback(); } @@ -1171,19 +1108,27 @@ class dba { * * @return boolean was the update successfull? */ - static public function update($table, $fields, $condition, $old_fields = array()) { + public static function update($table, $fields, $condition, $old_fields = array()) { $table = self::$dbo->escape($table); - if (is_bool($old_fields)) { - $sql = "SELECT * FROM `".$table."` WHERE `". - implode("` = ? AND `", array_keys($condition))."` = ? LIMIT 1"; - - $params = array_values($condition); + 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 (is_bool($old_fields)) { $do_insert = $old_fields; - $old_fields = self::fetch_first($sql, $params); + $old_fields = self::select($table, array(), $condition, array('limit' => 1)); + if (is_bool($old_fields)) { if ($do_insert) { $values = array_merge($condition, $fields); @@ -1210,8 +1155,7 @@ class dba { } $sql = "UPDATE `".$table."` SET `". - implode("` = ?, `", array_keys($fields))."` = ? WHERE `". - implode("` = ? AND `", array_keys($condition))."` = ?"; + implode("` = ?, `", array_keys($fields))."` = ?".$condition_string; $params1 = array_values($fields); $params2 = array_values($condition); @@ -1233,12 +1177,16 @@ class dba { * Example: * $table = "item"; * $fields = array("id", "uri", "uid", "network"); + * * $condition = array("uid" => 1, "network" => 'dspr'); + * or: + * $condition = array("`uid` = ? AND `network` IN (?, ?)", 1, 'dfrn', 'dspr'); + * * $params = array("order" => array("id", "received" => true), "limit" => 1); * * $data = dba::select($table, $fields, $condition, $params); */ - static public function select($table, $fields = array(), $condition = array(), $params = array()) { + public static function select($table, $fields = array(), $condition = array(), $params = array()) { if ($table == '') { return false; } @@ -1250,7 +1198,13 @@ class dba { } if (count($condition) > 0) { - $condition_string = " 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))."` = ?"; + } } else { $condition_string = ""; } @@ -1270,11 +1224,13 @@ class dba { $param_string = substr($param_string, 0, -2); } - if (isset($params['limit'])) { - if (is_int($params['limit'])) { - $param_string .= " LIMIT ".$params['limit']; - $single_row =($params['limit'] == 1); - } + if (isset($params['limit']) && is_int($params['limit'])) { + $param_string .= " LIMIT ".$params['limit']; + $single_row = ($params['limit'] == 1); + } + + if (isset($params['only_query']) && $params['only_query']) { + $single_row = !$params['only_query']; } $sql = "SELECT ".$select_fields." FROM `".$table."`".$condition_string.$param_string; @@ -1290,13 +1246,35 @@ class dba { } } + + /** + * @brief Fills an array with data from a query + * + * @param object $stmt statement object + * @return array Data array + */ + public static function inArray($stmt, $do_close = true) { + if (is_bool($stmt)) { + return $stmt; + } + + $data = array(); + while ($row = self::fetch($stmt)) { + $data[] = $row; + } + if ($do_close) { + self::close($stmt); + } + return $data; + } + /** * @brief Closes the current statement * * @param object $stmt statement object * @return boolean was the close successfull? */ - static public function close($stmt) { + public static function close($stmt) { if (!is_object($stmt)) { return false; } @@ -1341,43 +1319,54 @@ function dbesc($str) { } } -// Function: q($sql,$args); -// Description: execute SQL query with printf style args. -// Example: $r = q("SELECT * FROM `%s` WHERE `uid` = %d", -// 'user', 1); +/** + * @brief execute SQL query with printf style args - deprecated + * + * 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 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); + if (!$db || !$db->connected) { + return false; + } - $db->log_index($stmt); + $sql = $db->clean_query($sql); + $sql = $db->any_value_fallback($sql); + + $stmt = @vsprintf($sql, $args); + + $ret = dba::p($stmt); - return $db->q($stmt); + if (is_bool($ret)) { + return $ret; } - /** - * - * This will happen occasionally trying to store the - * session data after abnormal program termination - * - */ - logger('dba: no database: ' . print_r($args,true)); - return false; + $columns = dba::columnCount($ret); + + $data = dba::inArray($ret); + + if ((count($data) == 0) && ($columns == 0)) { + return true; + } + + return $data; } /** - * @brief Performs a query with "dirty reads" + * @brief Performs a query with "dirty reads" - 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 @@ -1397,9 +1386,7 @@ function qu($sql) { $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; } @@ -1413,37 +1400,6 @@ function qu($sql) { 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); }