include/dba.php

   1 <?php
   2 require_once("dbm.php");
   3 require_once('include/datetime.php');
   4
   5 /**
   6  * @class MySQL database class
   7  *
   8  * For debugging, insert 'dbg(1);' anywhere in the program flow.
   9  * dbg(0); will turn it off. Logging is performed at LOGGER_DATA level.
  10  * When logging, all binary info is converted to text and html entities are escaped so that
  11  * the debugging stream is safe to view within both terminals and web pages.
  12  *
  13  */
  14
  15 class dba {
  16
  17         private $debug = 0;
  18         private $db;
  19         private $result;
  20         private $driver;
  21         public  $connected = false;
  22         public  $error = false;
  23         private $_server_info = '';
  24         private static $dbo;
  25
  26         function __construct($server, $user, $pass, $db, $install = false) {
  27                 $a = get_app();
  28
  29                 $stamp1 = microtime(true);
  30
  31                 $server = trim($server);
  32                 $user = trim($user);
  33                 $pass = trim($pass);
  34                 $db = trim($db);
  35
  36                 if (!(strlen($server) && strlen($user))) {
  37                         $this->connected = false;
  38                         $this->db = null;
  39                         return;
  40                 }
  41
  42                 if ($install) {
  43                         if (strlen($server) && ($server !== 'localhost') && ($server !== '127.0.0.1')) {
  44                                 if (! dns_get_record($server, DNS_A + DNS_CNAME + DNS_PTR)) {
  45                                         $this->error = sprintf(t('Cannot locate DNS info for database server \'%s\''), $server);
  46                                         $this->connected = false;
  47                                         $this->db = null;
  48                                         return;
  49                                 }
  50                         }
  51                 }
  52
  53                 if (class_exists('\PDO') && in_array('mysql', PDO::getAvailableDrivers())) {
  54                         $this->driver = 'pdo';
  55                         $connect = "mysql:host=".$server.";dbname=".$db;
  56                         if (isset($a->config["system"]["db_charset"])) {
  57                                 $connect .= ";charset=".$a->config["system"]["db_charset"];
  58                         }
  59                         $this->db = @new PDO($connect, $user, $pass);
  60                         if (!$this->db->errorCode()) {
  61                                 $this->connected = true;
  62                         }
  63                 } elseif (class_exists('mysqli')) {
  64                         $this->driver = '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                         }
  73                 } elseif (function_exists('mysql_connect')) {
  74                         $this->driver = 'mysql';
  75                         $this->db = mysql_connect($server,$user,$pass);
  76                         if ($this->db && mysql_select_db($db,$this->db)) {
  77                                 $this->connected = true;
  78
  79                                 if (isset($a->config["system"]["db_charset"])) {
  80                                         mysql_set_charset($a->config["system"]["db_charset"], $this->db);
  81                                 }
  82                         }
  83                 } else {
  84                         // No suitable SQL driver was found.
  85                         if (!$install) {
  86                                 system_unavailable();
  87                         }
  88                 }
  89
  90                 if (!$this->connected) {
  91                         $this->db = null;
  92                         if (!$install) {
  93                                 system_unavailable();
  94                         }
  95                 }
  96                 $a->save_timestamp($stamp1, "network");
  97
  98                 self::$dbo = $this;
  99         }
 100
 101         /**
 102          * @brief Returns the MySQL server version string
 103          *
 104          * This function discriminate between the deprecated mysql API and the current
 105          * object-oriented mysqli API. Example of returned string: 5.5.46-0+deb8u1
 106          *
 107          * @return string
 108          */
 109         public function server_info() {
 110                 if ($this->_server_info == '') {
 111                         switch ($this->driver) {
 112                                 case 'pdo':
 113                                         $this->_server_info = $this->db->getAttribute(PDO::ATTR_SERVER_VERSION);
 114                                         break;
 115                                 case 'mysqli':
 116                                         $this->_server_info = $this->db->server_info;
 117                                         break;
 118                                 case 'mysql':
 119                                         $this->_server_info = mysql_get_server_info($this->db);
 120                                         break;
 121                         }
 122                 }
 123                 return $this->_server_info;
 124         }
 125
 126         /**
 127          * @brief Returns the selected database name
 128          *
 129          * @return string
 130          */
 131         public function database_name() {
 132                 $r = $this->q("SELECT DATABASE() AS `db`");
 133
 134                 return $r[0]['db'];
 135         }
 136
 137         /**
 138          * @brief Analyze a database query and log this if some conditions are met.
 139          *
 140          * @param string $query The database query that will be analyzed
 141          */
 142         public function log_index($query) {
 143                 $a = get_app();
 144
 145                 if ($a->config["system"]["db_log_index"] == "") {
 146                         return;
 147                 }
 148
 149                 // Don't explain an explain statement
 150                 if (strtolower(substr($query, 0, 7)) == "explain") {
 151                         return;
 152                 }
 153
 154                 // Only do the explain on "select", "update" and "delete"
 155                 if (!in_array(strtolower(substr($query, 0, 6)), array("select", "update", "delete"))) {
 156                         return;
 157                 }
 158
 159                 $r = $this->q("EXPLAIN ".$query);
 160                 if (!dbm::is_result($r)) {
 161                         return;
 162                 }
 163
 164                 $watchlist = explode(',', $a->config["system"]["db_log_index_watch"]);
 165                 $blacklist = explode(',', $a->config["system"]["db_log_index_blacklist"]);
 166
 167                 foreach ($r AS $row) {
 168                         if ((intval($a->config["system"]["db_loglimit_index"]) > 0)) {
 169                                 $log = (in_array($row['key'], $watchlist) AND
 170                                         ($row['rows'] >= intval($a->config["system"]["db_loglimit_index"])));
 171                         } else {
 172                                 $log = false;
 173                         }
 174
 175                         if ((intval($a->config["system"]["db_loglimit_index_high"]) > 0) AND ($row['rows'] >= intval($a->config["system"]["db_loglimit_index_high"]))) {
 176                                 $log = true;
 177                         }
 178
 179                         if (in_array($row['key'], $blacklist) OR ($row['key'] == "")) {
 180                                 $log = false;
 181                         }
 182
 183                         if ($log) {
 184                                 $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
 185                                 @file_put_contents($a->config["system"]["db_log_index"], datetime_convert()."\t".
 186                                                 $row['key']."\t".$row['rows']."\t".$row['Extra']."\t".
 187                                                 basename($backtrace[1]["file"])."\t".
 188                                                 $backtrace[1]["line"]."\t".$backtrace[2]["function"]."\t".
 189                                                 substr($query, 0, 2000)."\n", FILE_APPEND);
 190                         }
 191                 }
 192         }
 193
 194         public function q($sql, $onlyquery = false) {
 195                 $a = get_app();
 196
 197                 if (!$this->db || !$this->connected) {
 198                         return false;
 199                 }
 200
 201                 $this->error = '';
 202
 203                 $connstr = ($this->connected() ? "Connected" : "Disonnected");
 204
 205                 $stamp1 = microtime(true);
 206
 207                 $orig_sql = $sql;
 208
 209                 if (x($a->config,'system') && x($a->config['system'], 'db_callstack')) {
 210                         $sql = "/*".$a->callstack()." */ ".$sql;
 211                 }
 212
 213                 $columns = 0;
 214
 215                 switch ($this->driver) {
 216                         case 'pdo':
 217                                 $result = @$this->db->query($sql);
 218                                 // Is used to separate between queries that returning data - or not
 219                                 if (!is_bool($result)) {
 220                                         $columns = $result->columnCount();
 221                                 }
 222                                 break;
 223                         case 'mysqli':
 224                                 $result = @$this->db->query($sql);
 225                                 break;
 226                         case 'mysql':
 227                                 $result = @mysql_query($sql,$this->db);
 228                                 break;
 229                 }
 230                 $stamp2 = microtime(true);
 231                 $duration = (float)($stamp2 - $stamp1);
 232
 233                 $a->save_timestamp($stamp1, "database");
 234
 235                 if (strtolower(substr($orig_sql, 0, 6)) != "select") {
 236                         $a->save_timestamp($stamp1, "database_write");
 237                 }
 238                 if (x($a->config,'system') && x($a->config['system'],'db_log')) {
 239                         if (($duration > $a->config["system"]["db_loglimit"])) {
 240                                 $duration = round($duration, 3);
 241                                 $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
 242                                 @file_put_contents($a->config["system"]["db_log"], datetime_convert()."\t".$duration."\t".
 243                                                 basename($backtrace[1]["file"])."\t".
 244                                                 $backtrace[1]["line"]."\t".$backtrace[2]["function"]."\t".
 245                                                 substr($sql, 0, 2000)."\n", FILE_APPEND);
 246                         }
 247                 }
 248
 249                 switch ($this->driver) {
 250                         case 'pdo':
 251                                 $errorInfo = $this->db->errorInfo();
 252                                 if ($errorInfo) {
 253                                         $this->error = $errorInfo[2];
 254                                         $this->errorno = $errorInfo[1];
 255                                 }
 256                                 break;
 257                         case 'mysqli':
 258                                 if ($this->db->errno) {
 259                                         $this->error = $this->db->error;
 260                                         $this->errorno = $this->db->errno;
 261                                 }
 262                                 break;
 263                         case 'mysql':
 264                                 if (mysql_errno($this->db)) {
 265                                         $this->error = mysql_error($this->db);
 266                                         $this->errorno = mysql_errno($this->db);
 267                                 }
 268                                 break;
 269                 }
 270                 if (strlen($this->error)) {
 271                         logger('DB Error ('.$connstr.') '.$this->errorno.': '.$this->error);
 272                 }
 273
 274                 if ($this->debug) {
 275
 276                         $mesg = '';
 277
 278                         if ($result === false) {
 279                                 $mesg = 'false';
 280                         } elseif ($result === true) {
 281                                 $mesg = 'true';
 282                         } else {
 283                                 switch ($this->driver) {
 284                                         case 'pdo':
 285                                                 $mesg = $result->rowCount().' results'.EOL;
 286                                                 break;
 287                                         case 'mysqli':
 288                                                 $mesg = $result->num_rows.' results'.EOL;
 289                                                 break;
 290                                         case 'mysql':
 291                                                 $mesg = mysql_num_rows($result).' results'.EOL;
 292                                                 break;
 293                                 }
 294                         }
 295
 296                         $str =  'SQL = ' . printable($sql) . EOL . 'SQL returned ' . $mesg
 297                                 . (($this->error) ? ' error: ' . $this->error : '')
 298                                 . EOL;
 299
 300                         logger('dba: ' . $str );
 301                 }
 302
 303                 /**
 304                  * If dbfail.out exists, we will write any failed calls directly to it,
 305                  * regardless of any logging that may or may nor be in effect.
 306                  * These usually indicate SQL syntax errors that need to be resolved.
 307                  */
 308
 309                 if ($result === false) {
 310                         logger('dba: ' . printable($sql) . ' returned false.' . "\n" . $this->error);
 311                         if (file_exists('dbfail.out')) {
 312                                 file_put_contents('dbfail.out', datetime_convert() . "\n" . printable($sql) . ' returned false' . "\n" . $this->error . "\n", FILE_APPEND);
 313                         }
 314                 }
 315
 316                 if (is_bool($result)) {
 317                         return $result;
 318                 }
 319                 if ($onlyquery) {
 320                         $this->result = $result;
 321                         return true;
 322                 }
 323
 324                 $r = array();
 325                 switch ($this->driver) {
 326                         case 'pdo':
 327                                 while ($x = $result->fetch(PDO::FETCH_ASSOC)) {
 328                                         $r[] = $x;
 329                                 }
 330                                 $result->closeCursor();
 331                                 break;
 332                         case 'mysqli':
 333                                 while ($x = $result->fetch_array(MYSQLI_ASSOC)) {
 334                                         $r[] = $x;
 335                                 }
 336                                 $result->free_result();
 337                                 break;
 338                         case 'mysql':
 339                                 while ($x = mysql_fetch_array($result, MYSQL_ASSOC)) {
 340                                         $r[] = $x;
 341                                 }
 342                                 mysql_free_result($result);
 343                                 break;
 344                 }
 345
 346                 // PDO doesn't return "true" on successful operations - like mysqli does
 347                 // Emulate this behaviour by checking if the query returned data and had columns
 348                 // This should be reliable enough
 349                 if (($this->driver == 'pdo') AND (count($r) == 0) AND ($columns == 0)) {
 350                         return true;
 351                 }
 352
 353                 //$a->save_timestamp($stamp1, "database");
 354
 355                 if ($this->debug) {
 356                         logger('dba: ' . printable(print_r($r, true)));
 357                 }
 358                 return($r);
 359         }
 360
 361         public function dbg($dbg) {
 362                 $this->debug = $dbg;
 363         }
 364
 365         public function escape($str) {
 366                 if ($this->db && $this->connected) {
 367                         switch ($this->driver) {
 368                                 case 'pdo':
 369                                         return substr(@$this->db->quote($str, PDO::PARAM_STR), 1, -1);
 370                                 case 'mysqli':
 371                                         return @$this->db->real_escape_string($str);
 372                                 case 'mysql':
 373                                         return @mysql_real_escape_string($str,$this->db);
 374                         }
 375                 }
 376         }
 377
 378         function connected() {
 379                 switch ($this->driver) {
 380                         case 'pdo':
 381                                 // Not sure if this really is working like expected
 382                                 $connected = ($this->db->getAttribute(PDO::ATTR_CONNECTION_STATUS) != "");
 383                                 break;
 384                         case 'mysqli':
 385                                 $connected = $this->db->ping();
 386                                 break;
 387                         case 'mysql':
 388                                 $connected = mysql_ping($this->db);
 389                                 break;
 390                 }
 391                 return $connected;
 392         }
 393
 394         function insert_id() {
 395                 switch ($this->driver) {
 396                         case 'pdo':
 397                                 $id = $this->db->lastInsertId();
 398                                 break;
 399                         case 'mysqli':
 400                                 $id = $this->db->insert_id;
 401                                 break;
 402                         case 'mysql':
 403                                 $id = mysql_insert_id($this->db);
 404                                 break;
 405                 }
 406                 return $id;
 407         }
 408
 409         function __destruct() {
 410                 if ($this->db) {
 411                         switch ($this->driver) {
 412                                 case 'pdo':
 413                                         $this->db = null;
 414                                         break;
 415                                 case 'mysqli':
 416                                         $this->db->close();
 417                                         break;
 418                                 case 'mysql':
 419                                         mysql_close($this->db);
 420                                         break;
 421                         }
 422                 }
 423         }
 424
 425         /**
 426          * @brief Replaces ANY_VALUE() function by MIN() function,
 427          *  if the database server does not support ANY_VALUE().
 428          *
 429          * Considerations for Standard SQL, or MySQL with ONLY_FULL_GROUP_BY (default since 5.7.5).
 430          * ANY_VALUE() is available from MySQL 5.7.5 https://dev.mysql.com/doc/refman/5.7/en/miscellaneous-functions.html
 431          * A standard fall-back is to use MIN().
 432          *
 433          * @param string $sql An SQL string without the values
 434          * @return string The input SQL string modified if necessary.
 435          */
 436         public function any_value_fallback($sql) {
 437                 $server_info = $this->server_info();
 438                 if (version_compare($server_info, '5.7.5', '<') ||
 439                         (stripos($server_info, 'MariaDB') !== false)) {
 440                         $sql = str_ireplace('ANY_VALUE(', 'MIN(', $sql);
 441                 }
 442                 return $sql;
 443         }
 444
 445         /**
 446          * @brief Executes a prepared statement
 447          *
 448          * @param string $sql SQL statement
 449          * @return object statement object
 450          */
 451         static public function p($sql) {
 452                 $a = get_app();
 453
 454                 $stamp1 = microtime(true);
 455
 456                 $args = func_get_args();
 457                 unset($args[0]);
 458
 459                 if (!self::$dbo OR !self::$dbo->connected) {
 460                         return false;
 461                 }
 462
 463                 $sql = self::$dbo->any_value_fallback($sql);
 464
 465                 $orig_sql = $sql;
 466
 467                 if (x($a->config,'system') && x($a->config['system'], 'db_callstack')) {
 468                         $sql = "/*".$a->callstack()." */ ".$sql;
 469                 }
 470
 471                 switch (self::$dbo->driver) {
 472                         case 'pdo':
 473                                 if (!$stmt = self::$dbo->db->prepare($sql)) {
 474                                         $errorInfo = self::$dbo->db->errorInfo();
 475                                         self::$dbo->error = $errorInfo[2];
 476                                         self::$dbo->errorno = $errorInfo[1];
 477                                         $retval = false;
 478                                         break;
 479                                 }
 480
 481                                 foreach ($args AS $param => $value) {
 482                                         $stmt->bindParam($param, $args[$param]);
 483                                 }
 484
 485                                 if (!$stmt->execute()) {
 486                                         $errorInfo = self::$dbo->db->errorInfo();
 487                                         self::$dbo->error = $errorInfo[2];
 488                                         self::$dbo->errorno = $errorInfo[1];
 489                                         $retval = false;
 490                                 } else {
 491                                         $retval = $stmt;
 492                                 }
 493                                 break;
 494                         case 'mysqli':
 495                                 $stmt = self::$dbo->db->stmt_init();
 496
 497                                 if (!$stmt->prepare($sql)) {
 498                                         self::$dbo->error = self::$dbo->db->error;
 499                                         self::$dbo->errorno = self::$dbo->db->errno;
 500                                         $retval = false;
 501                                         break;
 502                                 }
 503
 504                                 $params = '';
 505                                 $values = array();
 506                                 foreach ($args AS $param => $value) {
 507                                         if (is_int($args[$param])) {
 508                                                 $params .= 'i';
 509                                         } elseif (is_float($args[$param])) {
 510                                                 $params .= 'd';
 511                                         } elseif (is_string($args[$param])) {
 512                                                 $params .= 's';
 513                                         } else {
 514                                                 $params .= 'b';
 515                                         }
 516                                         $values[] = &$args[$param];
 517                                 }
 518
 519                                 array_unshift($values, $params);
 520
 521                                 call_user_func_array(array($stmt, 'bind_param'), $values);
 522
 523                                 if (!$stmt->execute()) {
 524                                         self::$dbo->error = self::$dbo->db->error;
 525                                         self::$dbo->errorno = self::$dbo->db->errno;
 526                                         $retval = false;
 527                                 } elseif (method_exists($stmt, 'get_result')) {
 528                                         // Is mysqlnd installed?
 529                                         $retval = $stmt->get_result();
 530                                 } else {
 531                                         $stmt->store_result();
 532                                         $retval = $stmt;
 533                                 }
 534                                 break;
 535                         case 'mysql':
 536                                 // For the old "mysql" functions we cannot use prepared statements
 537                                 foreach ($args AS $param => $value) {
 538                                         if (is_int($args[$param]) OR is_float($args[$param])) {
 539                                                 $replace = intval($args[$param]);
 540                                         } else {
 541                                                 $replace = "'".dbesc($args[$param])."'";
 542                                         }
 543
 544                                         $pos = strpos($sql, '?');
 545                                         if ($pos !== false) {
 546                                                 $sql = substr_replace($sql, $replace, $pos, 1);
 547                                         }
 548                                 }
 549
 550                                 $retval = mysql_query($sql, self::$dbo->db);
 551                                 if (mysql_errno(self::$dbo->db)) {
 552                                         self::$dbo->error = mysql_error(self::$dbo->db);
 553                                         self::$dbo->errorno = mysql_errno(self::$dbo->db);
 554                                 }
 555                                 break;
 556                 }
 557
 558                 $a->save_timestamp($stamp1, 'database');
 559
 560                 if (x($a->config,'system') && x($a->config['system'], 'db_log')) {
 561
 562                         $stamp2 = microtime(true);
 563                         $duration = (float)($stamp2 - $stamp1);
 564
 565                         if (($duration > $a->config["system"]["db_loglimit"])) {
 566                                 $duration = round($duration, 3);
 567                                 $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
 568                                 @file_put_contents($a->config["system"]["db_log"], datetime_convert()."\t".$duration."\t".
 569                                                 basename($backtrace[1]["file"])."\t".
 570                                                 $backtrace[1]["line"]."\t".$backtrace[2]["function"]."\t".
 571                                                 substr($sql, 0, 2000)."\n", FILE_APPEND);
 572                         }
 573                 }
 574                 return $retval;
 575         }
 576
 577         /**
 578          * @brief Executes a prepared statement
 579          *
 580          * @param string $sql SQL statement
 581          * @return boolean Was the query successfull?
 582          */
 583         static public function e($sql) {
 584                 $a = get_app();
 585
 586                 $stamp = microtime(true);
 587
 588                 $args = func_get_args();
 589
 590                 $stmt = call_user_func_array('self::p', $args);
 591
 592                 if (is_bool($stmt)) {
 593                         $retval = $stmt;
 594                 } elseif (is_object($stmt)) {
 595                         $retval = true;
 596                 } else {
 597                         $retval = false;
 598                 }
 599
 600                 self::close($stmt);
 601
 602                 $a->save_timestamp($stamp, "database_write");
 603
 604                 return $retval;
 605         }
 606
 607         /**
 608          * @brief Check if data exists
 609          *
 610          * @param string $sql SQL statement
 611          * @return boolean Are there rows for that query?
 612          */
 613         static public function exists($sql) {
 614                 $args = func_get_args();
 615
 616                 $stmt = call_user_func_array('self::p', $args);
 617
 618                 if (is_bool($stmt)) {
 619                         $retval = $stmt;
 620                 } else {
 621                         $retval = (self::rows($stmt) > 0);
 622                 }
 623
 624                 self::close($stmt);
 625
 626                 return $retval;
 627         }
 628
 629         /**
 630          * @brief Returnr the number of rows of a statement
 631          *
 632          * @param object Statement object
 633          * @return int Number of rows
 634          */
 635         static public function num_rows($stmt) {
 636                 switch (self::$dbo->driver) {
 637                         case 'pdo':
 638                                 return $stmt->rowCount();
 639                         case 'mysqli':
 640                                 return $stmt->num_rows;
 641                         case 'mysql':
 642                                 return mysql_num_rows($stmt);
 643                 }
 644                 return 0;
 645         }
 646
 647         /**
 648          * @brief Fetch a single row
 649          *
 650          * @param object $stmt statement object
 651          * @return array current row
 652          */
 653         static public function fetch($stmt) {
 654                 if (!is_object($stmt)) {
 655                         return false;
 656                 }
 657
 658                 switch (self::$dbo->driver) {
 659                         case 'pdo':
 660                                 return $stmt->fetch(PDO::FETCH_ASSOC);
 661                         case 'mysqli':
 662                                 // When mysqlnd is installed, we can use a shortcut
 663                                 if (method_exists($stmt, 'fetch_array')) {
 664                                         return $stmt->fetch_array(MYSQLI_ASSOC);
 665                                 }
 666
 667                                 // This code works, but is slow
 668
 669                                 // Bind the result to a result array
 670                                 $cols = array();
 671
 672                                 $cols_num = array();
 673                                 for ($x = 0; $x < $stmt->field_count; $x++) {
 674                                         $cols[] = &$cols_num[$x];
 675                                 }
 676
 677                                 call_user_func_array(array($stmt, 'bind_result'), $cols);
 678
 679                                 $success = $stmt->fetch();
 680
 681                                 if (!$success) {
 682                                         return false;
 683                                 }
 684
 685                                 // The slow part:
 686                                 // We need to get the field names for the array keys
 687                                 // It seems that there is no better way to do this.
 688                                 $result = $stmt->result_metadata();
 689                                 $fields = $result->fetch_fields();
 690
 691                                 $columns = array();
 692                                 foreach ($cols_num AS $param => $col) {
 693                                         $columns[$fields[$param]->name] = $col;
 694                                 }
 695                                 return $columns;
 696                         case 'mysql':
 697                                 return mysql_fetch_array(self::$dbo->result, MYSQL_ASSOC);
 698                 }
 699         }
 700
 701         /**
 702          * @brief Closes the current statement
 703          *
 704          * @param object $stmt statement object
 705          * @return boolean was the close successfull?
 706          */
 707         static public function close($stmt) {
 708                 if (!is_object($stmt)) {
 709                         return false;
 710                 }
 711
 712                 switch (self::$dbo->driver) {
 713                         case 'pdo':
 714                                 return $stmt->closeCursor();
 715                         case 'mysqli':
 716                                 return $stmt->close();
 717                         case 'mysql':
 718                                 return mysql_free_result($stmt);
 719                 }
 720         }
 721 }
 722
 723 function printable($s) {
 724         $s = preg_replace("~([\x01-\x08\x0E-\x0F\x10-\x1F\x7F-\xFF])~",".", $s);
 725         $s = str_replace("\x00",'.',$s);
 726         if (x($_SERVER,'SERVER_NAME')) {
 727                 $s = escape_tags($s);
 728         }
 729         return $s;
 730 }
 731
 732 // Procedural functions
 733 function dbg($state) {
 734         global $db;
 735
 736         if ($db) {
 737                 $db->dbg($state);
 738         }
 739 }
 740
 741 function dbesc($str) {
 742         global $db;
 743
 744         if ($db && $db->connected) {
 745                 return($db->escape($str));
 746         } else {
 747                 return(str_replace("'","\\'",$str));
 748         }
 749 }
 750
 751 // Function: q($sql,$args);
 752 // Description: execute SQL query with printf style args.
 753 // Example: $r = q("SELECT * FROM `%s` WHERE `uid` = %d",
 754 //                   'user', 1);
 755 function q($sql) {
 756         global $db;
 757         $args = func_get_args();
 758         unset($args[0]);
 759
 760         if ($db && $db->connected) {
 761                 $sql = $db->any_value_fallback($sql);
 762                 $stmt = @vsprintf($sql,$args); // Disabled warnings
 763                 //logger("dba: q: $stmt", LOGGER_ALL);
 764                 if ($stmt === false)
 765                         logger('dba: vsprintf error: ' . print_r(debug_backtrace(),true), LOGGER_DEBUG);
 766
 767                 $db->log_index($stmt);
 768
 769                 return $db->q($stmt);
 770         }
 771
 772         /**
 773          *
 774          * This will happen occasionally trying to store the
 775          * session data after abnormal program termination
 776          *
 777          */
 778         logger('dba: no database: ' . print_r($args,true));
 779         return false;
 780 }
 781
 782 /**
 783  * @brief Performs a query with "dirty reads"
 784  *
 785  * By doing dirty reads (reading uncommitted data) no locks are performed
 786  * This function can be used to fetch data that doesn't need to be reliable.
 787  *
 788  * @param $args Query parameters (1 to N parameters of different types)
 789  * @return array Query array
 790  */
 791 function qu($sql) {
 792         global $db;
 793
 794         $args = func_get_args();
 795         unset($args[0]);
 796
 797         if ($db && $db->connected) {
 798                 $sql = $db->any_value_fallback($sql);
 799                 $stmt = @vsprintf($sql,$args); // Disabled warnings
 800                 if ($stmt === false)
 801                         logger('dba: vsprintf error: ' . print_r(debug_backtrace(),true), LOGGER_DEBUG);
 802
 803                 $db->log_index($stmt);
 804
 805                 $db->q("SET SESSION TRANSACTION ISOLATION LEVEL READ UNCOMMITTED;");
 806                 $retval = $db->q($stmt);
 807                 $db->q("SET SESSION TRANSACTION ISOLATION LEVEL REPEATABLE READ;");
 808                 return $retval;
 809         }
 810
 811         /**
 812          *
 813          * This will happen occasionally trying to store the
 814          * session data after abnormal program termination
 815          *
 816          */
 817         logger('dba: no database: ' . print_r($args,true));
 818         return false;
 819 }
 820
 821 /**
 822  *
 823  * Raw db query, no arguments
 824  *
 825  */
 826 function dbq($sql) {
 827         global $db;
 828
 829         if ($db && $db->connected) {
 830                 $ret = $db->q($sql);
 831         } else {
 832                 $ret = false;
 833         }
 834         return $ret;
 835 }
 836
 837 // Caller is responsible for ensuring that any integer arguments to
 838 // dbesc_array are actually integers and not malformed strings containing
 839 // SQL injection vectors. All integer array elements should be specifically
 840 // cast to int to avoid trouble.
 841 function dbesc_array_cb(&$item, $key) {
 842         if (is_string($item))
 843                 $item = dbesc($item);
 844 }
 845
 846 function dbesc_array(&$arr) {
 847         if (is_array($arr) && count($arr)) {
 848                 array_walk($arr,'dbesc_array_cb');
 849         }
 850 }
 851
 852 function dba_timer() {
 853         return microtime(true);
 854 }