2 require_once("dbm.php");
4 # if PDO is avaible for mysql, use the new database abstraction
5 # TODO: PDO is disabled for release 3.3. We need to investigate why
6 # the update from 3.2 fails with pdo
8 if(class_exists('\PDO') && in_array('mysql', PDO::getAvailableDrivers())) {
9 require_once("library/dddbl2/dddbl.php");
10 require_once("include/dba_pdo.php");
15 require_once('include/datetime.php');
18 * @class MySQL database class
20 * For debugging, insert 'dbg(1);' anywhere in the program flow.
21 * dbg(0); will turn it off. Logging is performed at LOGGER_DATA level.
22 * When logging, all binary info is converted to text and html entities are escaped so that
23 * the debugging stream is safe to view within both terminals and web pages.
27 if(! class_exists('dba')) {
33 public $mysqli = true;
34 public $connected = false;
35 public $error = false;
37 function __construct($server,$user,$pass,$db,$install = false) {
40 $stamp1 = microtime(true);
42 $server = trim($server);
47 if (!(strlen($server) && strlen($user))){
48 $this->connected = false;
54 if(strlen($server) && ($server !== 'localhost') && ($server !== '127.0.0.1')) {
55 if(! dns_get_record($server, DNS_A + DNS_CNAME + DNS_PTR)) {
56 $this->error = sprintf( t('Cannot locate DNS info for database server \'%s\''), $server);
57 $this->connected = false;
64 if(class_exists('mysqli')) {
65 $this->db = @new mysqli($server,$user,$pass,$db);
66 if(! mysqli_connect_errno()) {
67 $this->connected = true;
69 if (isset($a->config["system"]["db_charset"]))
70 $this->db->set_charset($a->config["system"]["db_charset"]);
73 $this->mysqli = false;
74 $this->db = mysql_connect($server,$user,$pass);
75 if($this->db && mysql_select_db($db,$this->db)) {
76 $this->connected = true;
78 if (isset($a->config["system"]["db_charset"]))
79 mysql_set_charset($a->config["system"]["db_charset"], $this->db);
81 if(! $this->connected) {
87 $a->save_timestamp($stamp1, "network");
90 public function getdb() {
95 * @brief Returns the MySQL server version string
97 * This function discriminate between the deprecated mysql API and the current
98 * object-oriented mysqli API. Example of returned string: 5.5.46-0+deb8u1
102 public function server_info() {
104 $return = $this->db->server_info;
106 $return = mysql_get_server_info($this->db);
112 * @brief Returns the number of rows
116 public function num_rows() {
121 $return = $this->result->num_rows;
123 $return = mysql_num_rows($this->result);
128 public function q($sql, $onlyquery = false) {
131 if((! $this->db) || (! $this->connected))
136 // Check the connection (This can reconnect the connection - if configured)
138 $connected = $this->db->ping();
140 $connected = mysql_ping($this->db);
142 $connstr = ($connected ? "Connected": "Disonnected");
144 $stamp1 = microtime(true);
146 $sql = "/*".$a->callstack()." */ ".$sql;
149 $result = @$this->db->query($sql);
151 $result = @mysql_query($sql,$this->db);
153 $stamp2 = microtime(true);
154 $duration = (float)($stamp2-$stamp1);
156 $a->save_timestamp($stamp1, "database");
158 if (strtolower(substr($sql, 0, 6)) != "select")
159 $a->save_timestamp($stamp1, "database_write");
161 if(x($a->config,'system') && x($a->config['system'],'db_log')) {
162 if (($duration > $a->config["system"]["db_loglimit"])) {
163 $duration = round($duration, 3);
164 $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
165 @file_put_contents($a->config["system"]["db_log"], datetime_convert()."\t".$duration."\t".
166 basename($backtrace[1]["file"])."\t".
167 $backtrace[1]["line"]."\t".$backtrace[2]["function"]."\t".
168 substr($sql, 0, 2000)."\n", FILE_APPEND);
173 if($this->db->errno) {
174 $this->error = $this->db->error;
175 $this->errorno = $this->db->errno;
177 } elseif(mysql_errno($this->db)) {
178 $this->error = mysql_error($this->db);
179 $this->errorno = mysql_errno($this->db);
182 if(strlen($this->error)) {
183 logger('DB Error ('.$connstr.') '.$this->errorno.': '.$this->error);
190 if($result === false)
192 elseif($result === true)
196 $mesg = $result->num_rows . ' results' . EOL;
198 $mesg = mysql_num_rows($result) . ' results' . EOL;
201 $str = 'SQL = ' . printable($sql) . EOL . 'SQL returned ' . $mesg
202 . (($this->error) ? ' error: ' . $this->error : '')
205 logger('dba: ' . $str );
209 * If dbfail.out exists, we will write any failed calls directly to it,
210 * regardless of any logging that may or may nor be in effect.
211 * These usually indicate SQL syntax errors that need to be resolved.
214 if($result === false) {
215 logger('dba: ' . printable($sql) . ' returned false.' . "\n" . $this->error);
216 if(file_exists('dbfail.out'))
217 file_put_contents('dbfail.out', datetime_convert() . "\n" . printable($sql) . ' returned false' . "\n" . $this->error . "\n", FILE_APPEND);
220 if(($result === true) || ($result === false))
224 $this->result = $result;
230 if($result->num_rows) {
231 while($x = $result->fetch_array(MYSQLI_ASSOC))
233 $result->free_result();
237 if(mysql_num_rows($result)) {
238 while($x = mysql_fetch_array($result, MYSQL_ASSOC))
240 mysql_free_result($result);
244 //$a->save_timestamp($stamp1, "database");
247 logger('dba: ' . printable(print_r($r, true)));
251 public function qfetch() {
256 if($this->result->num_rows)
257 $x = $this->result->fetch_array(MYSQLI_ASSOC);
259 if(mysql_num_rows($this->result))
260 $x = mysql_fetch_array($this->result, MYSQL_ASSOC);
266 public function qclose() {
269 $this->result->free_result();
271 mysql_free_result($this->result);
275 public function dbg($dbg) {
279 public function escape($str) {
280 if($this->db && $this->connected) {
282 return @$this->db->real_escape_string($str);
284 return @mysql_real_escape_string($str,$this->db);
288 function connected() {
290 $connected = $this->db->ping();
292 $connected = mysql_ping($this->db);
297 function __destruct() {
302 mysql_close($this->db);
306 if(! function_exists('printable')) {
307 function printable($s) {
308 $s = preg_replace("~([\x01-\x08\x0E-\x0F\x10-\x1F\x7F-\xFF])~",".", $s);
309 $s = str_replace("\x00",'.',$s);
310 if(x($_SERVER,'SERVER_NAME'))
311 $s = escape_tags($s);
315 // Procedural functions
316 if(! function_exists('dbg')) {
317 function dbg($state) {
323 if(! function_exists('dbesc')) {
324 function dbesc($str) {
326 if($db && $db->connected)
327 return($db->escape($str));
329 return(str_replace("'","\\'",$str));
334 // Function: q($sql,$args);
335 // Description: execute SQL query with printf style args.
336 // Example: $r = q("SELECT * FROM `%s` WHERE `uid` = %d",
339 if(! function_exists('q')) {
343 $args = func_get_args();
346 if($db && $db->connected) {
347 $stmt = @vsprintf($sql,$args); // Disabled warnings
348 //logger("dba: q: $stmt", LOGGER_ALL);
350 logger('dba: vsprintf error: ' . print_r(debug_backtrace(),true), LOGGER_DEBUG);
351 return $db->q($stmt);
356 * This will happen occasionally trying to store the
357 * session data after abnormal program termination
360 logger('dba: no database: ' . print_r($args,true));
366 * @brief Performs a query with "dirty reads"
368 * By doing dirty reads (reading uncommitted data) no locks are performed
369 * This function can be used to fetch data that doesn't need to be reliable.
371 * @param $args Query parameters (1 to N parameters of different types)
372 * @return array Query array
377 $args = func_get_args();
380 if($db && $db->connected) {
381 $stmt = @vsprintf($sql,$args); // Disabled warnings
383 logger('dba: vsprintf error: ' . print_r(debug_backtrace(),true), LOGGER_DEBUG);
384 $db->q("SET TRANSACTION ISOLATION LEVEL READ UNCOMMITTED;");
385 $retval = $db->q($stmt);
392 * This will happen occasionally trying to store the
393 * session data after abnormal program termination
396 logger('dba: no database: ' . print_r($args,true));
403 * Raw db query, no arguments
407 if(! function_exists('dbq')) {
411 if($db && $db->connected)
419 // Caller is responsible for ensuring that any integer arguments to
420 // dbesc_array are actually integers and not malformed strings containing
421 // SQL injection vectors. All integer array elements should be specifically
422 // cast to int to avoid trouble.
425 if(! function_exists('dbesc_array_cb')) {
426 function dbesc_array_cb(&$item, $key) {
428 $item = dbesc($item);
432 if(! function_exists('dbesc_array')) {
433 function dbesc_array(&$arr) {
434 if(is_array($arr) && count($arr)) {
435 array_walk($arr,'dbesc_array_cb');
440 function dba_timer() {
441 return microtime(true);