friendica/include/dba.php

533 lines
12 KiB
PHP
Raw Normal View History

2010-07-01 23:48:07 +00:00
<?php
2016-07-02 07:31:28 +00:00
require_once("dbm.php");
2014-05-09 18:43:06 +00:00
# if PDO is avaible for mysql, use the new database abstraction
# TODO: PDO is disabled for release 3.3. We need to investigate why
# the update from 3.2 fails with pdo
/*
if (class_exists('\PDO') && in_array('mysql', PDO::getAvailableDrivers())) {
2014-05-09 18:43:06 +00:00
require_once("library/dddbl2/dddbl.php");
require_once("include/dba_pdo.php");
}
*/
require_once('include/datetime.php');
/**
* @class MySQL database class
*
* For debugging, insert 'dbg(1);' anywhere in the program flow.
* dbg(0); will turn it off. Logging is performed at LOGGER_DATA level.
* When logging, all binary info is converted to text and html entities are escaped so that
* the debugging stream is safe to view within both terminals and web pages.
*
*/
if (! class_exists('dba')) {
class dba {
private $debug = 0;
private $db;
private $result;
public $mysqli = true;
public $connected = false;
public $error = false;
2016-10-23 22:12:45 +00:00
function __construct($server, $user, $pass, $db, $install = false) {
$a = get_app();
$stamp1 = microtime(true);
$server = trim($server);
$user = trim($user);
$pass = trim($pass);
$db = trim($db);
if (!(strlen($server) && strlen($user))) {
$this->connected = false;
$this->db = null;
2012-05-19 22:11:32 +00:00
return;
}
2012-05-19 22:11:32 +00:00
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;
}
2011-11-26 06:41:50 +00:00
}
}
if (class_exists('mysqli')) {
$this->db = @new mysqli($server,$user,$pass,$db);
if (! mysqli_connect_errno()) {
$this->connected = true;
2011-11-26 06:41:50 +00:00
}
if (isset($a->config["system"]["db_charset"])) {
$this->db->set_charset($a->config["system"]["db_charset"]);
}
} else {
$this->mysqli = false;
$this->db = mysql_connect($server,$user,$pass);
if ($this->db && mysql_select_db($db,$this->db)) {
$this->connected = true;
}
if (isset($a->config["system"]["db_charset"]))
mysql_set_charset($a->config["system"]["db_charset"], $this->db);
}
if (!$this->connected) {
$this->db = null;
2016-10-23 22:12:45 +00:00
if (!$install) {
system_unavailable();
2016-10-23 22:12:45 +00:00
}
}
$a->save_timestamp($stamp1, "network");
}
2010-07-01 23:48:07 +00:00
public function getdb() {
return $this->db;
}
2016-10-07 12:33:13 +00:00
/**
* @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->mysqli) {
$return = $this->db->server_info;
} else {
$return = mysql_get_server_info($this->db);
}
return $return;
}
/**
* @brief Returns the selected database name
*
* @return string
*/
public function database_name() {
$r = $this->q("SELECT DATABASE() AS `db`");
return $r[0]['db'];
}
/**
* @brief Returns the number of rows
*
* @return integer
*/
public function num_rows() {
2016-10-23 22:12:45 +00:00
if (!$this->result) {
return 0;
2016-10-23 22:12:45 +00:00
}
if ($this->mysqli) {
$return = $this->result->num_rows;
} else {
$return = mysql_num_rows($this->result);
}
return $return;
}
2017-01-21 20:15:49 +00:00
/**
* @brief Analyze a database query and log this if some conditions are met.
*
* @param string $query The database query that will be analyzed
*/
public function log_index($query) {
$a = get_app();
if ($a->config["system"]["db_log_index"] == "") {
return;
}
// Don't explain an explain statement
if (strtolower(substr($query, 0, 7)) == "explain") {
return;
}
// Only do the explain on "select", "update" and "delete"
if (!in_array(strtolower(substr($query, 0, 6)), array("select", "update", "delete"))) {
return;
}
$r = $this->q("EXPLAIN ".$query);
if (!dbm::is_result($r)) {
return;
}
$watchlist = explode(',', $a->config["system"]["db_log_index_watch"]);
$blacklist = explode(',', $a->config["system"]["db_log_index_blacklist"]);
foreach ($r AS $row) {
if ((intval($a->config["system"]["db_loglimit_index"]) > 0)) {
$log = (in_array($row['key'], $watchlist) AND
($row['rows'] >= intval($a->config["system"]["db_loglimit_index"])));
} else
$log = false;
if ((intval($a->config["system"]["db_loglimit_index_high"]) > 0) AND ($row['rows'] >= intval($a->config["system"]["db_loglimit_index_high"]))) {
$log = true;
}
if (in_array($row['key'], $blacklist) OR ($row['key'] == "")) {
$log = false;
}
if ($log) {
$backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
@file_put_contents($a->config["system"]["db_log_index"], datetime_convert()."\t".
2017-01-15 12:36:06 +00:00
$row['key']."\t".$row['rows']."\t".$row['Extra']."\t".
basename($backtrace[1]["file"])."\t".
$backtrace[1]["line"]."\t".$backtrace[2]["function"]."\t".
substr($query, 0, 2000)."\n", FILE_APPEND);
}
}
}
public function q($sql, $onlyquery = false) {
$a = get_app();
2012-05-19 22:11:32 +00:00
2016-10-23 22:12:45 +00:00
if (!$this->db || !$this->connected) {
return false;
2016-10-23 22:12:45 +00:00
}
2012-05-19 22:11:32 +00:00
2012-04-30 02:41:17 +00:00
$this->error = '';
// Check the connection (This can reconnect the connection - if configured)
if ($this->mysqli) {
$connected = $this->db->ping();
} else {
$connected = mysql_ping($this->db);
}
2016-10-23 22:12:45 +00:00
$connstr = ($connected ? "Connected" : "Disonnected");
$stamp1 = microtime(true);
2012-05-19 22:11:32 +00:00
$orig_sql = $sql;
2016-10-23 22:12:45 +00:00
if (x($a->config,'system') && x($a->config['system'], 'db_callstack')) {
$sql = "/*".$a->callstack()." */ ".$sql;
}
if ($this->mysqli) {
$result = @$this->db->query($sql);
} else {
$result = @mysql_query($sql,$this->db);
}
$stamp2 = microtime(true);
$duration = (float)($stamp2-$stamp1);
$a->save_timestamp($stamp1, "database");
2016-10-22 10:21:43 +00:00
if (strtolower(substr($orig_sql, 0, 6)) != "select") {
$a->save_timestamp($stamp1, "database_write");
2016-10-22 10:21:43 +00:00
}
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);
}
}
2012-05-19 22:11:32 +00:00
if ($this->mysqli) {
if ($this->db->errno) {
2012-04-30 00:34:54 +00:00
$this->error = $this->db->error;
$this->errorno = $this->db->errno;
}
} elseif (mysql_errno($this->db)) {
$this->error = mysql_error($this->db);
$this->errorno = mysql_errno($this->db);
2012-04-30 00:34:54 +00:00
}
if (strlen($this->error)) {
logger('DB Error ('.$connstr.') '.$this->errorno.': '.$this->error);
2012-04-30 00:34:54 +00:00
}
if ($this->debug) {
2010-07-01 23:48:07 +00:00
$mesg = '';
if ($result === false) {
$mesg = 'false';
} elseif ($result === true) {
$mesg = 'true';
} else {
if ($this->mysqli) {
$mesg = $result->num_rows . ' results' . EOL;
} else {
$mesg = mysql_num_rows($result) . ' results' . EOL;
}
}
2012-05-19 22:11:32 +00:00
$str = 'SQL = ' . printable($sql) . EOL . 'SQL returned ' . $mesg
2012-04-30 00:34:54 +00:00
. (($this->error) ? ' error: ' . $this->error : '')
. EOL;
2010-07-01 23:48:07 +00:00
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) {
2012-04-30 02:41:17 +00:00
logger('dba: ' . printable($sql) . ' returned false.' . "\n" . $this->error);
2016-10-23 23:14:35 +00:00
if (file_exists('dbfail.out')) {
2012-04-30 00:34:54 +00:00
file_put_contents('dbfail.out', datetime_convert() . "\n" . printable($sql) . ' returned false' . "\n" . $this->error . "\n", FILE_APPEND);
2016-10-23 23:14:35 +00:00
}
2010-10-07 01:14:11 +00:00
}
2010-07-01 23:48:07 +00:00
2016-10-23 23:14:35 +00:00
if (($result === true) || ($result === false)) {
return $result;
2016-10-23 23:14:35 +00:00
}
if ($onlyquery) {
$this->result = $result;
return true;
}
$r = array();
if ($this->mysqli) {
if ($result->num_rows) {
while($x = $result->fetch_array(MYSQLI_ASSOC))
$r[] = $x;
$result->free_result();
}
} else {
if (mysql_num_rows($result)) {
while($x = mysql_fetch_array($result, MYSQL_ASSOC))
$r[] = $x;
mysql_free_result($result);
}
}
2010-07-01 23:48:07 +00:00
//$a->save_timestamp($stamp1, "database");
2012-05-19 22:11:32 +00:00
2016-10-23 23:14:35 +00:00
if ($this->debug) {
logger('dba: ' . printable(print_r($r, true)));
2016-10-23 23:14:35 +00:00
}
return($r);
2010-07-01 23:48:07 +00:00
}
public function qfetch() {
$x = false;
2016-10-23 22:12:45 +00:00
if ($this->result) {
if ($this->mysqli) {
if ($this->result->num_rows)
$x = $this->result->fetch_array(MYSQLI_ASSOC);
} else {
if (mysql_num_rows($this->result))
$x = mysql_fetch_array($this->result, MYSQL_ASSOC);
}
2016-10-23 22:12:45 +00:00
}
return($x);
}
public function qclose() {
2016-10-23 22:12:45 +00:00
if ($this->result) {
if ($this->mysqli) {
$this->result->free_result();
} else {
mysql_free_result($this->result);
}
2016-10-23 22:12:45 +00:00
}
}
public function dbg($dbg) {
$this->debug = $dbg;
}
2010-08-12 05:24:08 +00:00
public function escape($str) {
if ($this->db && $this->connected) {
if ($this->mysqli) {
return @$this->db->real_escape_string($str);
} else {
return @mysql_real_escape_string($str,$this->db);
}
}
}
2010-07-01 23:48:07 +00:00
2016-09-22 02:57:40 +00:00
function connected() {
if ($this->mysqli) {
2016-09-22 02:57:40 +00:00
$connected = $this->db->ping();
} else {
2016-09-22 02:57:40 +00:00
$connected = mysql_ping($this->db);
}
2016-09-22 02:57:40 +00:00
return $connected;
}
function __destruct() {
if ($this->db) {
if ($this->mysqli) {
$this->db->close();
} else {
mysql_close($this->db);
}
}
}
}}
2010-07-01 23:48:07 +00:00
if (! function_exists('printable')) {
function printable($s) {
$s = preg_replace("~([\x01-\x08\x0E-\x0F\x10-\x1F\x7F-\xFF])~",".", $s);
$s = str_replace("\x00",'.',$s);
2016-10-23 23:14:35 +00:00
if (x($_SERVER,'SERVER_NAME')) {
$s = escape_tags($s);
2016-10-23 23:14:35 +00:00
}
return $s;
}}
2010-08-12 05:24:08 +00:00
2010-07-01 23:48:07 +00:00
// Procedural functions
if (! function_exists('dbg')) {
function dbg($state) {
global $db;
2016-10-23 23:14:35 +00:00
if ($db) {
$db->dbg($state);
}
}}
2010-07-01 23:48:07 +00:00
if (! function_exists('dbesc')) {
function dbesc($str) {
global $db;
if ($db && $db->connected) {
return($db->escape($str));
} else {
return(str_replace("'","\\'",$str));
}
}}
2010-07-01 23:48:07 +00:00
2010-07-01 23:48:07 +00:00
// Function: q($sql,$args);
// Description: execute SQL query with printf style args.
// Example: $r = q("SELECT * FROM `%s` WHERE `uid` = %d",
// 'user', 1);
if (! function_exists('q')) {
function q($sql) {
2010-07-01 23:48:07 +00:00
global $db;
$args = func_get_args();
unset($args[0]);
if ($db && $db->connected) {
$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;
}}
2010-07-01 23:48:07 +00:00
/**
* @brief Performs a query with "dirty reads"
*
* By doing dirty reads (reading uncommitted data) no locks are performed
* This function can be used to fetch data that doesn't need to be reliable.
*
* @param $args Query parameters (1 to N parameters of different types)
* @return array Query array
*/
function qu($sql) {
global $db;
$args = func_get_args();
unset($args[0]);
if ($db && $db->connected) {
$stmt = @vsprintf($sql,$args); // Disabled warnings
if ($stmt === false)
logger('dba: vsprintf error: ' . print_r(debug_backtrace(),true), LOGGER_DEBUG);
$db->log_index($stmt);
$db->q("SET SESSION TRANSACTION ISOLATION LEVEL READ UNCOMMITTED;");
$retval = $db->q($stmt);
$db->q("SET SESSION TRANSACTION ISOLATION LEVEL REPEATABLE READ;");
return $retval;
}
/**
*
* This will happen occasionally trying to store the
* session data after abnormal program termination
*
*/
logger('dba: no database: ' . print_r($args,true));
return false;
}
/**
*
* Raw db query, no arguments
*
*/
if (! function_exists('dbq')) {
function dbq($sql) {
global $db;
if ($db && $db->connected) {
$ret = $db->q($sql);
} else {
$ret = false;
}
return $ret;
}}
2010-07-01 23:48:07 +00:00
// Caller is responsible for ensuring that any integer arguments to
2010-07-01 23:48:07 +00:00
// 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.
2010-07-01 23:48:07 +00:00
if (! function_exists('dbesc_array_cb')) {
function dbesc_array_cb(&$item, $key) {
if (is_string($item))
$item = dbesc($item);
}}
2010-07-01 23:48:07 +00:00
if (! function_exists('dbesc_array')) {
function dbesc_array(&$arr) {
if (is_array($arr) && count($arr)) {
array_walk($arr,'dbesc_array_cb');
2010-07-01 23:48:07 +00:00
}
2012-04-14 11:35:11 +00:00
}}
function dba_timer() {
return microtime(true);
}