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 that returns data
 447          * @usage Example: $r = p("SELECT * FROM `item` WHERE `guid` = ?", $guid);
 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                 if (x($a->config,'system') && x($a->config['system'], 'db_callstack')) {
 466                         $sql = "/*".$a->callstack()." */ ".$sql;
 467                 }
 468
 469                 switch (self::$dbo->driver) {
 470                         case 'pdo':
 471                                 if (!$stmt = self::$dbo->db->prepare($sql)) {
 472                                         $errorInfo = self::$dbo->db->errorInfo();
 473                                         self::$dbo->error = $errorInfo[2];
 474                                         self::$dbo->errorno = $errorInfo[1];
 475                                         $retval = false;
 476                                         break;
 477                                 }
 478
 479                                 foreach ($args AS $param => $value) {
 480                                         $stmt->bindParam($param, $args[$param]);
 481                                 }
 482
 483                                 if (!$stmt->execute()) {
 484                                         $errorInfo = self::$dbo->db->errorInfo();
 485                                         self::$dbo->error = $errorInfo[2];
 486                                         self::$dbo->errorno = $errorInfo[1];
 487                                         $retval = false;
 488                                 } else {
 489                                         $retval = $stmt;
 490                                 }
 491                                 break;
 492                         case 'mysqli':
 493                                 $stmt = self::$dbo->db->stmt_init();
 494
 495                                 if (!$stmt->prepare($sql)) {
 496                                         self::$dbo->error = self::$dbo->db->error;
 497                                         self::$dbo->errorno = self::$dbo->db->errno;
 498                                         $retval = false;
 499                                         break;
 500                                 }
 501
 502                                 $params = '';
 503                                 $values = array();
 504                                 foreach ($args AS $param => $value) {
 505                                         if (is_int($args[$param])) {
 506                                                 $params .= 'i';
 507                                         } elseif (is_float($args[$param])) {
 508                                                 $params .= 'd';
 509                                         } elseif (is_string($args[$param])) {
 510                                                 $params .= 's';
 511                                         } else {
 512                                                 $params .= 'b';
 513                                         }
 514                                         $values[] = &$args[$param];
 515                                 }
 516
 517                                 array_unshift($values, $params);
 518
 519                                 call_user_func_array(array($stmt, 'bind_param'), $values);
 520
 521                                 if (!$stmt->execute()) {
 522                                         self::$dbo->error = self::$dbo->db->error;
 523                                         self::$dbo->errorno = self::$dbo->db->errno;
 524                                         $retval = false;
 525                                 } else {
 526                                         $stmt->store_result();
 527                                         $retval = $stmt;
 528                                 }
 529                                 break;
 530                         case 'mysql':
 531                                 // For the old "mysql" functions we cannot use prepared statements
 532                                 $offset = 0;
 533                                 foreach ($args AS $param => $value) {
 534                                         if (is_int($args[$param]) OR is_float($args[$param])) {
 535                                                 $replace = intval($args[$param]);
 536                                         } else {
 537                                                 $replace = "'".dbesc($args[$param])."'";
 538                                         }
 539
 540                                         $pos = strpos($sql, '?', $offset);
 541                                         if ($pos !== false) {
 542                                                 $sql = substr_replace($sql, $replace, $pos, 1);
 543                                         }
 544                                         $offset = $pos + strlen($replace);
 545                                 }
 546
 547                                 $retval = mysql_query($sql, self::$dbo->db);
 548                                 if (mysql_errno(self::$dbo->db)) {
 549                                         self::$dbo->error = mysql_error(self::$dbo->db);
 550                                         self::$dbo->errorno = mysql_errno(self::$dbo->db);
 551                                 }
 552                                 break;
 553                 }
 554
 555                 $a->save_timestamp($stamp1, 'database');
 556
 557                 if (x($a->config,'system') && x($a->config['system'], 'db_log')) {
 558
 559                         $stamp2 = microtime(true);
 560                         $duration = (float)($stamp2 - $stamp1);
 561
 562                         if (($duration > $a->config["system"]["db_loglimit"])) {
 563                                 $duration = round($duration, 3);
 564                                 $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
 565                                 @file_put_contents($a->config["system"]["db_log"], datetime_convert()."\t".$duration."\t".
 566                                                 basename($backtrace[1]["file"])."\t".
 567                                                 $backtrace[1]["line"]."\t".$backtrace[2]["function"]."\t".
 568                                                 substr($sql, 0, 2000)."\n", FILE_APPEND);
 569                         }
 570                 }
 571                 return $retval;
 572         }
 573
 574         /**
 575          * @brief Executes a prepared statement like UPDATE or INSERT that doesn't return data
 576          *
 577          * @param string $sql SQL statement
 578          * @return boolean Was the query successfull? False is returned only if an error occurred
 579          */
 580         static public function e($sql) {
 581                 $a = get_app();
 582
 583                 $stamp = microtime(true);
 584
 585                 $args = func_get_args();
 586
 587                 $stmt = call_user_func_array('self::p', $args);
 588
 589                 if (is_bool($stmt)) {
 590                         $retval = $stmt;
 591                 } elseif (is_object($stmt)) {
 592                         $retval = true;
 593                 } else {
 594                         $retval = false;
 595                 }
 596
 597                 self::close($stmt);
 598
 599                 $a->save_timestamp($stamp, "database_write");
 600
 601                 return $retval;
 602         }
 603
 604         /**
 605          * @brief Check if data exists
 606          *
 607          * @param string $sql SQL statement
 608          * @return boolean Are there rows for that query?
 609          */
 610         static public function exists($sql) {
 611                 $args = func_get_args();
 612
 613                 $stmt = call_user_func_array('self::p', $args);
 614
 615                 if (is_bool($stmt)) {
 616                         $retval = $stmt;
 617                 } else {
 618                         $retval = (self::rows($stmt) > 0);
 619                 }
 620
 621                 self::close($stmt);
 622
 623                 return $retval;
 624         }
 625
 626         /**
 627          * @brief Returns the number of rows of a statement
 628          *
 629          * @param object Statement object
 630          * @return int Number of rows
 631          */
 632         static public function num_rows($stmt) {
 633                 switch (self::$dbo->driver) {
 634                         case 'pdo':
 635                                 return $stmt->rowCount();
 636                         case 'mysqli':
 637                                 return $stmt->num_rows;
 638                         case 'mysql':
 639                                 return mysql_num_rows($stmt);
 640                 }
 641                 return 0;
 642         }
 643
 644         /**
 645          * @brief Fetch a single row
 646          *
 647          * @param object $stmt statement object
 648          * @return array current row
 649          */
 650         static public function fetch($stmt) {
 651                 if (!is_object($stmt)) {
 652                         return false;
 653                 }
 654
 655                 switch (self::$dbo->driver) {
 656                         case 'pdo':
 657                                 return $stmt->fetch(PDO::FETCH_ASSOC);
 658                         case 'mysqli':
 659                                 // This code works, but is slow
 660
 661                                 // Bind the result to a result array
 662                                 $cols = array();
 663
 664                                 $cols_num = array();
 665                                 for ($x = 0; $x < $stmt->field_count; $x++) {
 666                                         $cols[] = &$cols_num[$x];
 667                                 }
 668
 669                                 call_user_func_array(array($stmt, 'bind_result'), $cols);
 670
 671                                 if (!$stmt->fetch()) {
 672                                         return false;
 673                                 }
 674
 675                                 // The slow part:
 676                                 // We need to get the field names for the array keys
 677                                 // It seems that there is no better way to do this.
 678                                 $result = $stmt->result_metadata();
 679                                 $fields = $result->fetch_fields();
 680
 681                                 $columns = array();
 682                                 foreach ($cols_num AS $param => $col) {
 683                                         $columns[$fields[$param]->name] = $col;
 684                                 }
 685                                 return $columns;
 686                         case 'mysql':
 687                                 return mysql_fetch_array(self::$dbo->result, MYSQL_ASSOC);
 688                 }
 689         }
 690
 691         /**
 692          * @brief Closes the current statement
 693          *
 694          * @param object $stmt statement object
 695          * @return boolean was the close successfull?
 696          */
 697         static public function close($stmt) {
 698                 if (!is_object($stmt)) {
 699                         return false;
 700                 }
 701
 702                 switch (self::$dbo->driver) {
 703                         case 'pdo':
 704                                 return $stmt->closeCursor();
 705                         case 'mysqli':
 706                                 return $stmt->free_result();
 707                                 return $stmt->close();
 708                         case 'mysql':
 709                                 return mysql_free_result($stmt);
 710                 }
 711         }
 712 }
 713
 714 function printable($s) {
 715         $s = preg_replace("~([\x01-\x08\x0E-\x0F\x10-\x1F\x7F-\xFF])~",".", $s);
 716         $s = str_replace("\x00",'.',$s);
 717         if (x($_SERVER,'SERVER_NAME')) {
 718                 $s = escape_tags($s);
 719         }
 720         return $s;
 721 }
 722
 723 // Procedural functions
 724 function dbg($state) {
 725         global $db;
 726
 727         if ($db) {
 728                 $db->dbg($state);
 729         }
 730 }
 731
 732 function dbesc($str) {
 733         global $db;
 734
 735         if ($db && $db->connected) {
 736                 return($db->escape($str));
 737         } else {
 738                 return(str_replace("'","\\'",$str));
 739         }
 740 }
 741
 742 // Function: q($sql,$args);
 743 // Description: execute SQL query with printf style args.
 744 // Example: $r = q("SELECT * FROM `%s` WHERE `uid` = %d",
 745 //                   'user', 1);
 746 function q($sql) {
 747         global $db;
 748         $args = func_get_args();
 749         unset($args[0]);
 750
 751         if ($db && $db->connected) {
 752                 $sql = $db->any_value_fallback($sql);
 753                 $stmt = @vsprintf($sql,$args); // Disabled warnings
 754                 //logger("dba: q: $stmt", LOGGER_ALL);
 755                 if ($stmt === false)
 756                         logger('dba: vsprintf error: ' . print_r(debug_backtrace(),true), LOGGER_DEBUG);
 757
 758                 $db->log_index($stmt);
 759
 760                 return $db->q($stmt);
 761         }
 762
 763         /**
 764          *
 765          * This will happen occasionally trying to store the
 766          * session data after abnormal program termination
 767          *
 768          */
 769         logger('dba: no database: ' . print_r($args,true));
 770         return false;
 771 }
 772
 773 /**
 774  * @brief Performs a query with "dirty reads"
 775  *
 776  * By doing dirty reads (reading uncommitted data) no locks are performed
 777  * This function can be used to fetch data that doesn't need to be reliable.
 778  *
 779  * @param $args Query parameters (1 to N parameters of different types)
 780  * @return array Query array
 781  */
 782 function qu($sql) {
 783         global $db;
 784
 785         $args = func_get_args();
 786         unset($args[0]);
 787
 788         if ($db && $db->connected) {
 789                 $sql = $db->any_value_fallback($sql);
 790                 $stmt = @vsprintf($sql,$args); // Disabled warnings
 791                 if ($stmt === false)
 792                         logger('dba: vsprintf error: ' . print_r(debug_backtrace(),true), LOGGER_DEBUG);
 793
 794                 $db->log_index($stmt);
 795
 796                 $db->q("SET SESSION TRANSACTION ISOLATION LEVEL READ UNCOMMITTED;");
 797                 $retval = $db->q($stmt);
 798                 $db->q("SET SESSION TRANSACTION ISOLATION LEVEL REPEATABLE READ;");
 799                 return $retval;
 800         }
 801
 802         /**
 803          *
 804          * This will happen occasionally trying to store the
 805          * session data after abnormal program termination
 806          *
 807          */
 808         logger('dba: no database: ' . print_r($args,true));
 809         return false;
 810 }
 811
 812 /**
 813  *
 814  * Raw db query, no arguments
 815  *
 816  */
 817 function dbq($sql) {
 818         global $db;
 819
 820         if ($db && $db->connected) {
 821                 $ret = $db->q($sql);
 822         } else {
 823                 $ret = false;
 824         }
 825         return $ret;
 826 }
 827
 828 // Caller is responsible for ensuring that any integer arguments to
 829 // dbesc_array are actually integers and not malformed strings containing
 830 // SQL injection vectors. All integer array elements should be specifically
 831 // cast to int to avoid trouble.
 832 function dbesc_array_cb(&$item, $key) {
 833         if (is_string($item))
 834                 $item = dbesc($item);
 835 }
 836
 837 function dbesc_array(&$arr) {
 838         if (is_array($arr) && count($arr)) {
 839                 array_walk($arr,'dbesc_array_cb');
 840         }
 841 }
 842
 843 function dba_timer() {
 844         return microtime(true);
 845 }