strk/friendica
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Merge pull request #3702 from annando/new-dba

Browse source 
The old database function is now replaced with a wrapper
This commit is contained in:
Tobias Diekershoff 2017-09-15 08:31:25 +02:00 committed by GitHub
parent 3d4ae91569 f8d34e35e7
commit 0384e875a2
3 changed files with 126 additions and 207 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

297
include/dba.php
View file

@ -214,171 +214,32 @@ 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 = "/*".System::callstack()." */ ".$sql;
}
$columns = 0;
switch ($this->driver) {
case 'pdo':
$result = @$this->db->query($sql);
// Is used to separate between queries that returning data - or not
if (!is_bool($result)) {
$columns = $result->columnCount();
}
break;
case 'mysqli':
$result = @$this->db->query($sql);
break;
case 'mysql':
$result = @mysql_query($sql,$this->db);
break;
}
$stamp2 = microtime(true);
$duration = (float)($stamp2 - $stamp1);
$a->save_timestamp($stamp1, "database");
if (strtolower(substr($orig_sql, 0, 6)) != "select") {
$a->save_timestamp($stamp1, "database_write");
}
if (x($a->config,'system') && x($a->config['system'],'db_log')) {
if (($duration > $a->config["system"]["db_loglimit"])) {
$duration = round($duration, 3);
$backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
@file_put_contents($a->config["system"]["db_log"], datetime_convert()."\t".$duration."\t".
basename($backtrace[1]["file"])."\t".
$backtrace[1]["line"]."\t".$backtrace[2]["function"]."\t".
substr($sql, 0, 2000)."\n", FILE_APPEND);
}
}
switch ($this->driver) {
case 'pdo':
$errorInfo = $this->db->errorInfo();
if ($errorInfo) {
$this->error = $errorInfo[2];
$this->errorno = $errorInfo[1];
}
break;
case 'mysqli':
if ($this->db->errno) {
$this->error = $this->db->error;
$this->errorno = $this->db->errno;
}
break;
case 'mysql':
if (mysql_errno($this->db)) {
$this->error = mysql_error($this->db);
$this->errorno = mysql_errno($this->db);
}
break;
}
if (strlen($this->error)) {
logger('DB Error ('.$connstr.') '.$this->errorno.': '.$this->error);
}
if ($this->debug) {
$mesg = '';
if ($result === false) {
$mesg = 'false';
} elseif ($result === true) {
$mesg = 'true';
} else {
switch ($this->driver) {
case 'pdo':
$mesg = $result->rowCount().' results'.EOL;
break;
case 'mysqli':
$mesg = $result->num_rows.' results'.EOL;
break;
case 'mysql':
$mesg = mysql_num_rows($result).' results'.EOL;
break;
}
}
$str = 'SQL = ' . printable($sql) . EOL . 'SQL returned ' . $mesg
. (($this->error) ? ' error: ' . $this->error : '')
. EOL;
logger('dba: ' . $str );
}
/** /**
* If dbfail.out exists, we will write any failed calls directly to it, * @brief execute SQL query - deprecated
* regardless of any logging that may or may nor be in effect. *
* These usually indicate SQL syntax errors that need to be resolved. * 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);
if ($result === false) { if (is_bool($ret)) {
logger('dba: ' . printable($sql) . ' returned false.' . "\n" . $this->error); return $ret;
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)) { $columns = self::columnCount($ret);
return $result;
} $data = self::inArray($ret);
if ($onlyquery) {
$this->result = $result; if ((count($data) == 0) && ($columns == 0)) {
return true; return true;
} }
$r = array(); return $data;
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) { public function dbg($dbg) {
@ -515,6 +376,10 @@ class dba {
/** /**
* @brief Executes a prepared statement that returns data * @brief Executes a prepared statement that returns data
* @usage Example: $r = p("SELECT * FROM `item` WHERE `guid` = ?", $guid); * @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 * @param string $sql SQL statement
* @return object statement object * @return object statement object
*/ */
@ -540,7 +405,7 @@ class dba {
return false; 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? // Question: Should we continue or stop the query here?
logger('Parameter mismatch. Query "'.$sql.'" - Parameters '.print_r($args, true), LOGGER_DEBUG); logger('Parameter mismatch. Query "'.$sql.'" - Parameters '.print_r($args, true), LOGGER_DEBUG);
} }
@ -572,6 +437,19 @@ class dba {
switch (self::$dbo->driver) { switch (self::$dbo->driver) {
case 'pdo': 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)) { if (!$stmt = self::$dbo->db->prepare($sql)) {
$errorInfo = self::$dbo->db->errorInfo(); $errorInfo = self::$dbo->db->errorInfo();
self::$dbo->error = $errorInfo[2]; self::$dbo->error = $errorInfo[2];
@ -600,8 +478,8 @@ class dba {
$command = strtolower($parts[0]); $command = strtolower($parts[0]);
$can_be_prepared = in_array($command, array('select', 'update', 'insert', 'delete')); $can_be_prepared = in_array($command, array('select', 'update', 'insert', 'delete'));
// The fallback routine currently only works with statements that doesn't return values // The fallback routine is called as well when there are no arguments
if (!$can_be_prepared && $called_from_e) { if (!$can_be_prepared || (count($args) == 0)) {
$retval = self::$dbo->db->query(self::replace_parameters($sql, $args)); $retval = self::$dbo->db->query(self::replace_parameters($sql, $args));
if (self::$dbo->db->errno) { if (self::$dbo->db->errno) {
self::$dbo->error = self::$dbo->db->error; self::$dbo->error = self::$dbo->db->error;
@ -710,6 +588,8 @@ class dba {
/** /**
* @brief Executes a prepared statement like UPDATE or INSERT that doesn't return data * @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 * @param string $sql SQL statement
* @return boolean Was the query successfull? False is returned only if an error occurred * @return boolean Was the query successfull? False is returned only if an error occurred
*/ */
@ -792,6 +672,8 @@ class dba {
/** /**
* @brief Fetches the first row * @brief Fetches the first row
* *
* Please use dba::select or dba::exists whenever this is possible.
*
* @param string $sql SQL statement * @param string $sql SQL statement
* @return array first row of query * @return array first row of query
*/ */
@ -820,6 +702,26 @@ class dba {
return self::$dbo->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 * @brief Returns the number of rows of a statement
* *
@ -856,6 +758,10 @@ class dba {
case 'pdo': case 'pdo':
return $stmt->fetch(PDO::FETCH_ASSOC); return $stmt->fetch(PDO::FETCH_ASSOC);
case 'mysqli': case 'mysqli':
if (get_class($stmt) == 'mysqli_result') {
return $stmt->fetch_assoc();
}
// This code works, but is slow // This code works, but is slow
// Bind the result to a result array // Bind the result to a result array
@ -1271,7 +1177,11 @@ class dba {
* Example: * Example:
* $table = "item"; * $table = "item";
* $fields = array("id", "uri", "uid", "network"); * $fields = array("id", "uri", "uid", "network");
*
* $condition = array("uid" => 1, "network" => 'dspr'); * $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); * $params = array("order" => array("id", "received" => true), "limit" => 1);
* *
* $data = dba::select($table, $fields, $condition, $params); * $data = dba::select($table, $fields, $condition, $params);
@ -1409,43 +1319,54 @@ function dbesc($str) {
} }
} }
// Function: q($sql,$args); /**
// Description: execute SQL query with printf style args. * @brief execute SQL query with printf style args - deprecated
// Example: $r = q("SELECT * FROM `%s` WHERE `uid` = %d", *
// 'user', 1); * 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) { function q($sql) {
global $db; global $db;
$args = func_get_args(); $args = func_get_args();
unset($args[0]); unset($args[0]);
if ($db && $db->connected) { 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; return false;
} }
$sql = $db->clean_query($sql);
$sql = $db->any_value_fallback($sql);
$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;
}
/** /**
* @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 * Please use the dba:: functions instead:
* This function can be used to fetch data that doesn't need to be reliable. * 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) * @param $args Query parameters (1 to N parameters of different types)
* @return array Query array * @return array Query array
@ -1465,9 +1386,7 @@ function qu($sql) {
$db->log_index($stmt); $db->log_index($stmt);
$db->q("SET SESSION TRANSACTION ISOLATION LEVEL READ UNCOMMITTED;");
$retval = $db->q($stmt); $retval = $db->q($stmt);
$db->q("SET SESSION TRANSACTION ISOLATION LEVEL REPEATABLE READ;");
return $retval; return $retval;
} }

18
include/dbstructure.php
View file

@ -31,7 +31,7 @@ function convert_to_innodb() {
$sql = sprintf("ALTER TABLE `%s` engine=InnoDB;", dbesc($table['TABLE_NAME'])); $sql = sprintf("ALTER TABLE `%s` engine=InnoDB;", dbesc($table['TABLE_NAME']));
echo $sql."\n"; echo $sql."\n";
$result = $db->q($sql); $result = dba::e($sql);
if (!dbm::is_result($result)) { if (!dbm::is_result($result)) {
print_update_error($db, $sql); print_update_error($db, $sql);
} }
@ -442,9 +442,9 @@ function update_structure($verbose, $action, $tables=null, $definition=null) {
// Ensure index conversion to unique removes duplicates // Ensure index conversion to unique removes duplicates
if ($is_unique) { if ($is_unique) {
if ($ignore != "") { if ($ignore != "") {
$db->q("SET session old_alter_table=1;"); dba::e("SET session old_alter_table=1;");
} else { } else {
$r = $db->q("CREATE TABLE `".$temp_name."` LIKE `".$name."`;"); $r = dba::e("CREATE TABLE `".$temp_name."` LIKE `".$name."`;");
if (!dbm::is_result($r)) { if (!dbm::is_result($r)) {
$errors .= print_update_error($db, $sql3); $errors .= print_update_error($db, $sql3);
return $errors; return $errors;
@ -452,25 +452,25 @@ function update_structure($verbose, $action, $tables=null, $definition=null) {
} }
} }
$r = @$db->q($sql3); $r = @dba::e($sql3);
if (!dbm::is_result($r)) { if (!dbm::is_result($r)) {
$errors .= print_update_error($db, $sql3); $errors .= print_update_error($db, $sql3);
} }
if ($is_unique) { if ($is_unique) {
if ($ignore != "") { if ($ignore != "") {
$db->q("SET session old_alter_table=0;"); dba::e("SET session old_alter_table=0;");
} else { } else {
$r = $db->q("INSERT INTO `".$temp_name."` SELECT ".$field_list." FROM `".$name."`".$group_by.";"); $r = dba::e("INSERT INTO `".$temp_name."` SELECT ".$field_list." FROM `".$name."`".$group_by.";");
if (!dbm::is_result($r)) { if (!dbm::is_result($r)) {
$errors .= print_update_error($db, $sql3); $errors .= print_update_error($db, $sql3);
return $errors; return $errors;
} }
$r = $db->q("DROP TABLE `".$name."`;"); $r = dba::e("DROP TABLE `".$name."`;");
if (!dbm::is_result($r)) { if (!dbm::is_result($r)) {
$errors .= print_update_error($db, $sql3); $errors .= print_update_error($db, $sql3);
return $errors; return $errors;
} }
$r = $db->q("RENAME TABLE `".$temp_name."` TO `".$name."`;"); $r = dba::e("RENAME TABLE `".$temp_name."` TO `".$name."`;");
if (!dbm::is_result($r)) { if (!dbm::is_result($r)) {
$errors .= print_update_error($db, $sql3); $errors .= print_update_error($db, $sql3);
return $errors; return $errors;
@ -551,7 +551,7 @@ function db_create_table($name, $fields, $verbose, $action, $indexes=null) {
echo $sql.";\n"; echo $sql.";\n";
if ($action) if ($action)
$r = @$db->q($sql); $r = @dba::e($sql);
return $r; return $r;
} }

6
mod/directory.php
View file

@ -71,7 +71,7 @@ function directory_content(App $a) {
$publish = ((get_config('system','publish_all')) ? '' : " AND `publish` = 1 " ); $publish = ((get_config('system','publish_all')) ? '' : " AND `publish` = 1 " );
$r = $db->q("SELECT COUNT(*) AS `total` FROM `profile` $r = q("SELECT COUNT(*) AS `total` FROM `profile`
LEFT JOIN `user` ON `user`.`uid` = `profile`.`uid` LEFT JOIN `user` ON `user`.`uid` = `profile`.`uid`
WHERE `is-default` = 1 $publish AND `user`.`blocked` = 0 $sql_extra "); WHERE `is-default` = 1 $publish AND `user`.`blocked` = 0 $sql_extra ");
if (dbm::is_result($r)) if (dbm::is_result($r))
@ -81,11 +81,11 @@ function directory_content(App $a) {
$limit = intval($a->pager['start']).",".intval($a->pager['itemspage']); $limit = intval($a->pager['start']).",".intval($a->pager['itemspage']);
$r = $db->q("SELECT `profile`.*, `profile`.`uid` AS `profile_uid`, `user`.`nickname`, `user`.`timezone` , `user`.`page-flags`, $r = q("SELECT `profile`.*, `profile`.`uid` AS `profile_uid`, `user`.`nickname`, `user`.`timezone` , `user`.`page-flags`,
`contact`.`addr`, `contact`.`url` AS profile_url FROM `profile` `contact`.`addr`, `contact`.`url` AS profile_url FROM `profile`
LEFT JOIN `user` ON `user`.`uid` = `profile`.`uid` LEFT JOIN `user` ON `user`.`uid` = `profile`.`uid`
LEFT JOIN `contact` ON `contact`.`uid` = `user`.`uid` LEFT JOIN `contact` ON `contact`.`uid` = `user`.`uid`
WHERE `is-default` = 1 $publish AND `user`.`blocked` = 0 AND `contact`.`self` $sql_extra $order LIMIT ".$limit); WHERE `is-default` $publish AND `user`.`blocked` = 0 AND `contact`.`self` $sql_extra $order LIMIT ".$limit);
if (dbm::is_result($r)) { if (dbm::is_result($r)) {
if (in_array('small', $a->argv)) { if (in_array('small', $a->argv)) {