include/dba.php

   1 <?php
   2 require_once("dbm.php");
   3
   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
   7 /*
   8 if (class_exists('\PDO') && in_array('mysql', PDO::getAvailableDrivers())) {
   9   require_once("library/dddbl2/dddbl.php");
  10   require_once("include/dba_pdo.php");
  11 }
  12 */
  13
  14
  15 require_once('include/datetime.php');
  16
  17 /**
  18  * @class MySQL database class
  19  *
  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.
  24  *
  25  */
  26
  27 if (! class_exists('dba')) {
  28 class dba {
  29
  30         private $debug = 0;
  31         private $db;
  32         private $result;
  33         public  $mysqli = true;
  34         public  $connected = false;
  35         public  $error = false;
  36
  37         function __construct($server,$user,$pass,$db,$install = false) {
  38                 global $a;
  39
  40                 $stamp1 = microtime(true);
  41
  42                 $server = trim($server);
  43                 $user = trim($user);
  44                 $pass = trim($pass);
  45                 $db = trim($db);
  46
  47                 if (!(strlen($server) && strlen($user))) {
  48                         $this->connected = false;
  49                         $this->db = null;
  50                         return;
  51                 }
  52
  53                 if ($install) {
  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;
  58                                         $this->db = null;
  59                                         return;
  60                                 }
  61                         }
  62                 }
  63
  64                 if (class_exists('mysqli')) {
  65                         $this->db = @new mysqli($server,$user,$pass,$db);
  66                         if (! mysqli_connect_errno()) {
  67                                 $this->connected = true;
  68                         }
  69                         if (isset($a->config["system"]["db_charset"])) {
  70                                 $this->db->set_charset($a->config["system"]["db_charset"]);
  71                         }
  72                 } else {
  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;
  77                         }
  78                         if (isset($a->config["system"]["db_charset"]))
  79                                 mysql_set_charset($a->config["system"]["db_charset"], $this->db);
  80                 }
  81                 if (!$this->connected) {
  82                         $this->db = null;
  83                         if (!$install)
  84                                 system_unavailable();
  85                 }
  86
  87                 $a->save_timestamp($stamp1, "network");
  88         }
  89
  90         public function getdb() {
  91                 return $this->db;
  92         }
  93
  94         /**
  95          * @brief Returns the MySQL server version string
  96          *
  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
  99          *
 100          * @return string
 101          */
 102         public function server_info() {
 103                 if ($this->mysqli) {
 104                         $return = $this->db->server_info;
 105                 } else {
 106                         $return = mysql_get_server_info($this->db);
 107                 }
 108                 return $return;
 109         }
 110
 111         /**
 112          * @brief Returns the number of rows
 113          *
 114          * @return integer
 115          */
 116         public function num_rows() {
 117                 if (!$this->result)
 118                         return 0;
 119
 120                 if ($this->mysqli) {
 121                         $return = $this->result->num_rows;
 122                 } else {
 123                         $return = mysql_num_rows($this->result);
 124                 }
 125                 return $return;
 126         }
 127
 128         public function q($sql, $onlyquery = false) {
 129                 global $a;
 130
 131                 if ((!$this->db) || (!$this->connected))
 132                         return false;
 133
 134                 $this->error = '';
 135
 136                 // Check the connection (This can reconnect the connection - if configured)
 137                 if ($this->mysqli) {
 138                         $connected = $this->db->ping();
 139                 } else {
 140                         $connected = mysql_ping($this->db);
 141                 }
 142                 $connstr = ($connected ? "Connected": "Disonnected");
 143
 144                 $stamp1 = microtime(true);
 145
 146                 $orig_sql = $sql;
 147
 148                 if (x($a->config,'system') && x($a->config['system'],'db_callstack')) {
 149                         $sql = "/*".$a->callstack()." */ ".$sql;
 150                 }
 151
 152                 if ($this->mysqli) {
 153                         $result = @$this->db->query($sql);
 154                 } else {
 155                         $result = @mysql_query($sql,$this->db);
 156                 }
 157                 $stamp2 = microtime(true);
 158                 $duration = (float)($stamp2-$stamp1);
 159
 160                 $a->save_timestamp($stamp1, "database");
 161
 162                 if (strtolower(substr($orig_sql, 0, 6)) != "select")
 163                         $a->save_timestamp($stamp1, "database_write");
 164
 165                 if (x($a->config,'system') && x($a->config['system'],'db_log')) {
 166                         if (($duration > $a->config["system"]["db_loglimit"])) {
 167                                 $duration = round($duration, 3);
 168                                 $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
 169                                 @file_put_contents($a->config["system"]["db_log"], datetime_convert()."\t".$duration."\t".
 170                                                 basename($backtrace[1]["file"])."\t".
 171                                                 $backtrace[1]["line"]."\t".$backtrace[2]["function"]."\t".
 172                                                 substr($sql, 0, 2000)."\n", FILE_APPEND);
 173                         }
 174                 }
 175
 176                 if ($this->mysqli) {
 177                         if ($this->db->errno) {
 178                                 $this->error = $this->db->error;
 179                                 $this->errorno = $this->db->errno;
 180                         }
 181                 } elseif (mysql_errno($this->db)) {
 182                         $this->error = mysql_error($this->db);
 183                         $this->errorno = mysql_errno($this->db);
 184                 }
 185
 186                 if (strlen($this->error)) {
 187                         logger('DB Error ('.$connstr.') '.$this->errorno.': '.$this->error);
 188                 }
 189
 190                 if ($this->debug) {
 191
 192                         $mesg = '';
 193
 194                         if ($result === false) {
 195                                 $mesg = 'false';
 196                         } elseif ($result === true) {
 197                                 $mesg = 'true';
 198                         } else {
 199                                 if ($this->mysqli) {
 200                                         $mesg = $result->num_rows . ' results' . EOL;
 201                                 } else {
 202                                         $mesg = mysql_num_rows($result) . ' results' . EOL;
 203                                 }
 204                         }
 205
 206                         $str =  'SQL = ' . printable($sql) . EOL . 'SQL returned ' . $mesg
 207                                 . (($this->error) ? ' error: ' . $this->error : '')
 208                                 . EOL;
 209
 210                         logger('dba: ' . $str );
 211                 }
 212
 213                 /**
 214                  * If dbfail.out exists, we will write any failed calls directly to it,
 215                  * regardless of any logging that may or may nor be in effect.
 216                  * These usually indicate SQL syntax errors that need to be resolved.
 217                  */
 218
 219                 if ($result === false) {
 220                         logger('dba: ' . printable($sql) . ' returned false.' . "\n" . $this->error);
 221                         if (file_exists('dbfail.out'))
 222                                 file_put_contents('dbfail.out', datetime_convert() . "\n" . printable($sql) . ' returned false' . "\n" . $this->error . "\n", FILE_APPEND);
 223                 }
 224
 225                 if (($result === true) || ($result === false))
 226                         return $result;
 227
 228                 if ($onlyquery) {
 229                         $this->result = $result;
 230                         return true;
 231                 }
 232
 233                 $r = array();
 234                 if ($this->mysqli) {
 235                         if ($result->num_rows) {
 236                                 while($x = $result->fetch_array(MYSQLI_ASSOC))
 237                                         $r[] = $x;
 238                                 $result->free_result();
 239                         }
 240                 } else {
 241                         if (mysql_num_rows($result)) {
 242                                 while($x = mysql_fetch_array($result, MYSQL_ASSOC))
 243                                         $r[] = $x;
 244                                 mysql_free_result($result);
 245                         }
 246                 }
 247
 248                 //$a->save_timestamp($stamp1, "database");
 249
 250                 if ($this->debug)
 251                         logger('dba: ' . printable(print_r($r, true)));
 252                 return($r);
 253         }
 254
 255         public function qfetch() {
 256                 $x = false;
 257
 258                 if ($this->result)
 259                         if ($this->mysqli) {
 260                                 if ($this->result->num_rows)
 261                                         $x = $this->result->fetch_array(MYSQLI_ASSOC);
 262                         } else {
 263                                 if (mysql_num_rows($this->result))
 264                                         $x = mysql_fetch_array($this->result, MYSQL_ASSOC);
 265                         }
 266
 267                 return($x);
 268         }
 269
 270         public function qclose() {
 271                 if ($this->result)
 272                         if ($this->mysqli) {
 273                                 $this->result->free_result();
 274                         } else {
 275                                 mysql_free_result($this->result);
 276                         }
 277         }
 278
 279         public function dbg($dbg) {
 280                 $this->debug = $dbg;
 281         }
 282
 283         public function escape($str) {
 284                 if ($this->db && $this->connected) {
 285                         if ($this->mysqli) {
 286                                 return @$this->db->real_escape_string($str);
 287                         } else {
 288                                 return @mysql_real_escape_string($str,$this->db);
 289                         }
 290                 }
 291         }
 292
 293         function connected() {
 294                 if ($this->mysqli) {
 295                         $connected = $this->db->ping();
 296                 } else {
 297                         $connected = mysql_ping($this->db);
 298                 }
 299                 return $connected;
 300         }
 301
 302         function __destruct() {
 303                 if ($this->db) {
 304                         if ($this->mysqli) {
 305                                 $this->db->close();
 306                         } else {
 307                                 mysql_close($this->db);
 308                         }
 309                 }
 310         }
 311 }}
 312
 313 if (! function_exists('printable')) {
 314 function printable($s) {
 315         $s = preg_replace("~([\x01-\x08\x0E-\x0F\x10-\x1F\x7F-\xFF])~",".", $s);
 316         $s = str_replace("\x00",'.',$s);
 317         if (x($_SERVER,'SERVER_NAME'))
 318                 $s = escape_tags($s);
 319         return $s;
 320 }}
 321
 322 // Procedural functions
 323 if (! function_exists('dbg')) {
 324 function dbg($state) {
 325         global $db;
 326         if ($db)
 327         $db->dbg($state);
 328 }}
 329
 330 if (! function_exists('dbesc')) {
 331 function dbesc($str) {
 332         global $db;
 333         if ($db && $db->connected) {
 334                 return($db->escape($str));
 335         } else {
 336                 return(str_replace("'","\\'",$str));
 337         }
 338 }}
 339
 340
 341
 342 // Function: q($sql,$args);
 343 // Description: execute SQL query with printf style args.
 344 // Example: $r = q("SELECT * FROM `%s` WHERE `uid` = %d",
 345 //                   'user', 1);
 346
 347 if (! function_exists('q')) {
 348 function q($sql) {
 349
 350         global $db;
 351         $args = func_get_args();
 352         unset($args[0]);
 353
 354         if ($db && $db->connected) {
 355                 $stmt = @vsprintf($sql,$args); // Disabled warnings
 356                 //logger("dba: q: $stmt", LOGGER_ALL);
 357                 if ($stmt === false)
 358                         logger('dba: vsprintf error: ' . print_r(debug_backtrace(),true), LOGGER_DEBUG);
 359                 return $db->q($stmt);
 360         }
 361
 362         /**
 363          *
 364          * This will happen occasionally trying to store the
 365          * session data after abnormal program termination
 366          *
 367          */
 368         logger('dba: no database: ' . print_r($args,true));
 369         return false;
 370
 371 }}
 372
 373 /**
 374  * @brief Performs a query with "dirty reads"
 375  *
 376  * By doing dirty reads (reading uncommitted data) no locks are performed
 377  * This function can be used to fetch data that doesn't need to be reliable.
 378  *
 379  * @param $args Query parameters (1 to N parameters of different types)
 380  * @return array Query array
 381  */
 382 function qu($sql) {
 383
 384         global $db;
 385         $args = func_get_args();
 386         unset($args[0]);
 387
 388         if ($db && $db->connected) {
 389                 $stmt = @vsprintf($sql,$args); // Disabled warnings
 390                 if ($stmt === false)
 391                         logger('dba: vsprintf error: ' . print_r(debug_backtrace(),true), LOGGER_DEBUG);
 392                 $db->q("SET TRANSACTION ISOLATION LEVEL READ UNCOMMITTED;");
 393                 $retval = $db->q($stmt);
 394                 $db->q("COMMIT;");
 395                 return $retval;
 396         }
 397
 398         /**
 399          *
 400          * This will happen occasionally trying to store the
 401          * session data after abnormal program termination
 402          *
 403          */
 404         logger('dba: no database: ' . print_r($args,true));
 405         return false;
 406
 407 }
 408
 409 /**
 410  *
 411  * Raw db query, no arguments
 412  *
 413  */
 414
 415 if (! function_exists('dbq')) {
 416 function dbq($sql) {
 417
 418         global $db;
 419         if ($db && $db->connected) {
 420                 $ret = $db->q($sql);
 421         } else {
 422                 $ret = false;
 423         }
 424         return $ret;
 425 }}
 426
 427
 428 // Caller is responsible for ensuring that any integer arguments to
 429 // dbesc_array are actually integers and not malformed strings containing
 430 // SQL injection vectors. All integer array elements should be specifically
 431 // cast to int to avoid trouble.
 432
 433
 434 if (! function_exists('dbesc_array_cb')) {
 435 function dbesc_array_cb(&$item, $key) {
 436         if (is_string($item))
 437                 $item = dbesc($item);
 438 }}
 439
 440
 441 if (! function_exists('dbesc_array')) {
 442 function dbesc_array(&$arr) {
 443         if (is_array($arr) && count($arr)) {
 444                 array_walk($arr,'dbesc_array_cb');
 445         }
 446 }}
 447
 448
 449 function dba_timer() {
 450         return microtime(true);
 451 }