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  * This class is for the low level database stuff that does driver specific things.
  14  */
  15
  16 class dba {
  17
  18         private $debug = 0;
  19         private $db;
  20         private $result;
  21         private $driver;
  22         public  $connected = false;
  23         public  $error = false;
  24         private $_server_info = '';
  25         private static $in_transaction = false;
  26         private static $dbo;
  27         private static $relation = array();
  28
  29         function __construct($serveraddr, $user, $pass, $db, $install = false) {
  30                 $a = get_app();
  31
  32                 $stamp1 = microtime(true);
  33
  34                 $serveraddr = trim($serveraddr);
  35
  36                 $serverdata = explode(':', $serveraddr);
  37                 $server = $serverdata[0];
  38
  39                 if (count($serverdata) > 1) {
  40                         $port = trim($serverdata[1]);
  41                 }
  42
  43                 $server = trim($server);
  44                 $user = trim($user);
  45                 $pass = trim($pass);
  46                 $db = trim($db);
  47
  48                 if (!(strlen($server) && strlen($user))) {
  49                         $this->connected = false;
  50                         $this->db = null;
  51                         return;
  52                 }
  53
  54                 if ($install) {
  55                         if (strlen($server) && ($server !== 'localhost') && ($server !== '127.0.0.1')) {
  56                                 if (! dns_get_record($server, DNS_A + DNS_CNAME + DNS_PTR)) {
  57                                         $this->error = sprintf(t('Cannot locate DNS info for database server \'%s\''), $server);
  58                                         $this->connected = false;
  59                                         $this->db = null;
  60                                         return;
  61                                 }
  62                         }
  63                 }
  64
  65                 if (class_exists('\PDO') && in_array('mysql', PDO::getAvailableDrivers())) {
  66                         $this->driver = 'pdo';
  67                         $connect = "mysql:host=".$server.";dbname=".$db;
  68
  69                         if (isset($port)) {
  70                                 $connect .= ";port=".$port;
  71                         }
  72
  73                         if (isset($a->config["system"]["db_charset"])) {
  74                                 $connect .= ";charset=".$a->config["system"]["db_charset"];
  75                         }
  76                         $this->db = @new PDO($connect, $user, $pass);
  77                         if (!$this->db->errorCode()) {
  78                                 $this->connected = true;
  79                         }
  80                 } elseif (class_exists('mysqli')) {
  81                         $this->driver = 'mysqli';
  82                         $this->db = @new mysqli($server, $user, $pass, $db, $port);
  83                         if (!mysqli_connect_errno()) {
  84                                 $this->connected = true;
  85
  86                                 if (isset($a->config["system"]["db_charset"])) {
  87                                         $this->db->set_charset($a->config["system"]["db_charset"]);
  88                                 }
  89                         }
  90                 } elseif (function_exists('mysql_connect')) {
  91                         $this->driver = 'mysql';
  92                         $this->db = mysql_connect($serveraddr, $user, $pass);
  93                         if ($this->db && mysql_select_db($db, $this->db)) {
  94                                 $this->connected = true;
  95
  96                                 if (isset($a->config["system"]["db_charset"])) {
  97                                         mysql_set_charset($a->config["system"]["db_charset"], $this->db);
  98                                 }
  99                         }
 100                 } else {
 101                         // No suitable SQL driver was found.
 102                         if (!$install) {
 103                                 system_unavailable();
 104                         }
 105                 }
 106
 107                 if (!$this->connected) {
 108                         $this->db = null;
 109                         if (!$install) {
 110                                 system_unavailable();
 111                         }
 112                 }
 113                 $a->save_timestamp($stamp1, "network");
 114
 115                 self::$dbo = $this;
 116         }
 117
 118         /**
 119          * @brief Returns the MySQL server version string
 120          *
 121          * This function discriminate between the deprecated mysql API and the current
 122          * object-oriented mysqli API. Example of returned string: 5.5.46-0+deb8u1
 123          *
 124          * @return string
 125          */
 126         public function server_info() {
 127                 if ($this->_server_info == '') {
 128                         switch ($this->driver) {
 129                                 case 'pdo':
 130                                         $this->_server_info = $this->db->getAttribute(PDO::ATTR_SERVER_VERSION);
 131                                         break;
 132                                 case 'mysqli':
 133                                         $this->_server_info = $this->db->server_info;
 134                                         break;
 135                                 case 'mysql':
 136                                         $this->_server_info = mysql_get_server_info($this->db);
 137                                         break;
 138                         }
 139                 }
 140                 return $this->_server_info;
 141         }
 142
 143         /**
 144          * @brief Returns the selected database name
 145          *
 146          * @return string
 147          */
 148         public function database_name() {
 149                 $r = $this->q("SELECT DATABASE() AS `db`");
 150
 151                 return $r[0]['db'];
 152         }
 153
 154         /**
 155          * @brief Analyze a database query and log this if some conditions are met.
 156          *
 157          * @param string $query The database query that will be analyzed
 158          */
 159         public function log_index($query) {
 160                 $a = get_app();
 161
 162                 if ($a->config["system"]["db_log_index"] == "") {
 163                         return;
 164                 }
 165
 166                 // Don't explain an explain statement
 167                 if (strtolower(substr($query, 0, 7)) == "explain") {
 168                         return;
 169                 }
 170
 171                 // Only do the explain on "select", "update" and "delete"
 172                 if (!in_array(strtolower(substr($query, 0, 6)), array("select", "update", "delete"))) {
 173                         return;
 174                 }
 175
 176                 $r = $this->q("EXPLAIN ".$query);
 177                 if (!dbm::is_result($r)) {
 178                         return;
 179                 }
 180
 181                 $watchlist = explode(',', $a->config["system"]["db_log_index_watch"]);
 182                 $blacklist = explode(',', $a->config["system"]["db_log_index_blacklist"]);
 183
 184                 foreach ($r AS $row) {
 185                         if ((intval($a->config["system"]["db_loglimit_index"]) > 0)) {
 186                                 $log = (in_array($row['key'], $watchlist) AND
 187                                         ($row['rows'] >= intval($a->config["system"]["db_loglimit_index"])));
 188                         } else {
 189                                 $log = false;
 190                         }
 191
 192                         if ((intval($a->config["system"]["db_loglimit_index_high"]) > 0) AND ($row['rows'] >= intval($a->config["system"]["db_loglimit_index_high"]))) {
 193                                 $log = true;
 194                         }
 195
 196                         if (in_array($row['key'], $blacklist) OR ($row['key'] == "")) {
 197                                 $log = false;
 198                         }
 199
 200                         if ($log) {
 201                                 $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
 202                                 @file_put_contents($a->config["system"]["db_log_index"], datetime_convert()."\t".
 203                                                 $row['key']."\t".$row['rows']."\t".$row['Extra']."\t".
 204                                                 basename($backtrace[1]["file"])."\t".
 205                                                 $backtrace[1]["line"]."\t".$backtrace[2]["function"]."\t".
 206                                                 substr($query, 0, 2000)."\n", FILE_APPEND);
 207                         }
 208                 }
 209         }
 210
 211         public function q($sql, $onlyquery = false) {
 212                 $a = get_app();
 213
 214                 if (!$this->db || !$this->connected) {
 215                         return false;
 216                 }
 217
 218                 $this->error = '';
 219
 220                 $connstr = ($this->connected() ? "Connected" : "Disonnected");
 221
 222                 $stamp1 = microtime(true);
 223
 224                 $orig_sql = $sql;
 225
 226                 if (x($a->config,'system') && x($a->config['system'], 'db_callstack')) {
 227                         $sql = "/*".$a->callstack()." */ ".$sql;
 228                 }
 229
 230                 $columns = 0;
 231
 232                 switch ($this->driver) {
 233                         case 'pdo':
 234                                 $result = @$this->db->query($sql);
 235                                 // Is used to separate between queries that returning data - or not
 236                                 if (!is_bool($result)) {
 237                                         $columns = $result->columnCount();
 238                                 }
 239                                 break;
 240                         case 'mysqli':
 241                                 $result = @$this->db->query($sql);
 242                                 break;
 243                         case 'mysql':
 244                                 $result = @mysql_query($sql,$this->db);
 245                                 break;
 246                 }
 247                 $stamp2 = microtime(true);
 248                 $duration = (float)($stamp2 - $stamp1);
 249
 250                 $a->save_timestamp($stamp1, "database");
 251
 252                 if (strtolower(substr($orig_sql, 0, 6)) != "select") {
 253                         $a->save_timestamp($stamp1, "database_write");
 254                 }
 255                 if (x($a->config,'system') && x($a->config['system'],'db_log')) {
 256                         if (($duration > $a->config["system"]["db_loglimit"])) {
 257                                 $duration = round($duration, 3);
 258                                 $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
 259                                 @file_put_contents($a->config["system"]["db_log"], datetime_convert()."\t".$duration."\t".
 260                                                 basename($backtrace[1]["file"])."\t".
 261                                                 $backtrace[1]["line"]."\t".$backtrace[2]["function"]."\t".
 262                                                 substr($sql, 0, 2000)."\n", FILE_APPEND);
 263                         }
 264                 }
 265
 266                 switch ($this->driver) {
 267                         case 'pdo':
 268                                 $errorInfo = $this->db->errorInfo();
 269                                 if ($errorInfo) {
 270                                         $this->error = $errorInfo[2];
 271                                         $this->errorno = $errorInfo[1];
 272                                 }
 273                                 break;
 274                         case 'mysqli':
 275                                 if ($this->db->errno) {
 276                                         $this->error = $this->db->error;
 277                                         $this->errorno = $this->db->errno;
 278                                 }
 279                                 break;
 280                         case 'mysql':
 281                                 if (mysql_errno($this->db)) {
 282                                         $this->error = mysql_error($this->db);
 283                                         $this->errorno = mysql_errno($this->db);
 284                                 }
 285                                 break;
 286                 }
 287                 if (strlen($this->error)) {
 288                         logger('DB Error ('.$connstr.') '.$this->errorno.': '.$this->error);
 289                 }
 290
 291                 if ($this->debug) {
 292
 293                         $mesg = '';
 294
 295                         if ($result === false) {
 296                                 $mesg = 'false';
 297                         } elseif ($result === true) {
 298                                 $mesg = 'true';
 299                         } else {
 300                                 switch ($this->driver) {
 301                                         case 'pdo':
 302                                                 $mesg = $result->rowCount().' results'.EOL;
 303                                                 break;
 304                                         case 'mysqli':
 305                                                 $mesg = $result->num_rows.' results'.EOL;
 306                                                 break;
 307                                         case 'mysql':
 308                                                 $mesg = mysql_num_rows($result).' results'.EOL;
 309                                                 break;
 310                                 }
 311                         }
 312
 313                         $str =  'SQL = ' . printable($sql) . EOL . 'SQL returned ' . $mesg
 314                                 . (($this->error) ? ' error: ' . $this->error : '')
 315                                 . EOL;
 316
 317                         logger('dba: ' . $str );
 318                 }
 319
 320                 /**
 321                  * If dbfail.out exists, we will write any failed calls directly to it,
 322                  * regardless of any logging that may or may nor be in effect.
 323                  * These usually indicate SQL syntax errors that need to be resolved.
 324                  */
 325
 326                 if ($result === false) {
 327                         logger('dba: ' . printable($sql) . ' returned false.' . "\n" . $this->error);
 328                         if (file_exists('dbfail.out')) {
 329                                 file_put_contents('dbfail.out', datetime_convert() . "\n" . printable($sql) . ' returned false' . "\n" . $this->error . "\n", FILE_APPEND);
 330                         }
 331                 }
 332
 333                 if (is_bool($result)) {
 334                         return $result;
 335                 }
 336                 if ($onlyquery) {
 337                         $this->result = $result;
 338                         return true;
 339                 }
 340
 341                 $r = array();
 342                 switch ($this->driver) {
 343                         case 'pdo':
 344                                 while ($x = $result->fetch(PDO::FETCH_ASSOC)) {
 345                                         $r[] = $x;
 346                                 }
 347                                 $result->closeCursor();
 348                                 break;
 349                         case 'mysqli':
 350                                 while ($x = $result->fetch_array(MYSQLI_ASSOC)) {
 351                                         $r[] = $x;
 352                                 }
 353                                 $result->free_result();
 354                                 break;
 355                         case 'mysql':
 356                                 while ($x = mysql_fetch_array($result, MYSQL_ASSOC)) {
 357                                         $r[] = $x;
 358                                 }
 359                                 mysql_free_result($result);
 360                                 break;
 361                 }
 362
 363                 // PDO doesn't return "true" on successful operations - like mysqli does
 364                 // Emulate this behaviour by checking if the query returned data and had columns
 365                 // This should be reliable enough
 366                 if (($this->driver == 'pdo') AND (count($r) == 0) AND ($columns == 0)) {
 367                         return true;
 368                 }
 369
 370                 //$a->save_timestamp($stamp1, "database");
 371
 372                 if ($this->debug) {
 373                         logger('dba: ' . printable(print_r($r, true)));
 374                 }
 375                 return($r);
 376         }
 377
 378         public function dbg($dbg) {
 379                 $this->debug = $dbg;
 380         }
 381
 382         public function escape($str) {
 383                 if ($this->db && $this->connected) {
 384                         switch ($this->driver) {
 385                                 case 'pdo':
 386                                         return substr(@$this->db->quote($str, PDO::PARAM_STR), 1, -1);
 387                                 case 'mysqli':
 388                                         return @$this->db->real_escape_string($str);
 389                                 case 'mysql':
 390                                         return @mysql_real_escape_string($str,$this->db);
 391                         }
 392                 }
 393         }
 394
 395         function connected() {
 396                 switch ($this->driver) {
 397                         case 'pdo':
 398                                 // Not sure if this really is working like expected
 399                                 $connected = ($this->db->getAttribute(PDO::ATTR_CONNECTION_STATUS) != "");
 400                                 break;
 401                         case 'mysqli':
 402                                 $connected = $this->db->ping();
 403                                 break;
 404                         case 'mysql':
 405                                 $connected = mysql_ping($this->db);
 406                                 break;
 407                 }
 408                 return $connected;
 409         }
 410
 411         function insert_id() {
 412                 switch ($this->driver) {
 413                         case 'pdo':
 414                                 $id = $this->db->lastInsertId();
 415                                 break;
 416                         case 'mysqli':
 417                                 $id = $this->db->insert_id;
 418                                 break;
 419                         case 'mysql':
 420                                 $id = mysql_insert_id($this->db);
 421                                 break;
 422                 }
 423                 return $id;
 424         }
 425
 426         function __destruct() {
 427                 if ($this->db) {
 428                         switch ($this->driver) {
 429                                 case 'pdo':
 430                                         $this->db = null;
 431                                         break;
 432                                 case 'mysqli':
 433                                         $this->db->close();
 434                                         break;
 435                                 case 'mysql':
 436                                         mysql_close($this->db);
 437                                         break;
 438                         }
 439                 }
 440         }
 441
 442         /**
 443          * @brief Replaces ANY_VALUE() function by MIN() function,
 444          *  if the database server does not support ANY_VALUE().
 445          *
 446          * Considerations for Standard SQL, or MySQL with ONLY_FULL_GROUP_BY (default since 5.7.5).
 447          * ANY_VALUE() is available from MySQL 5.7.5 https://dev.mysql.com/doc/refman/5.7/en/miscellaneous-functions.html
 448          * A standard fall-back is to use MIN().
 449          *
 450          * @param string $sql An SQL string without the values
 451          * @return string The input SQL string modified if necessary.
 452          */
 453         public function any_value_fallback($sql) {
 454                 $server_info = $this->server_info();
 455                 if (version_compare($server_info, '5.7.5', '<') ||
 456                         (stripos($server_info, 'MariaDB') !== false)) {
 457                         $sql = str_ireplace('ANY_VALUE(', 'MIN(', $sql);
 458                 }
 459                 return $sql;
 460         }
 461
 462         /**
 463          * @brief Replaces the ? placeholders with the parameters in the $args array
 464          *
 465          * @param string $sql SQL query
 466          * @param array $args The parameters that are to replace the ? placeholders
 467          * @return string The replaced SQL query
 468          */
 469         static private function replace_parameters($sql, $args) {
 470                 $offset = 0;
 471                 foreach ($args AS $param => $value) {
 472                         if (is_int($args[$param]) OR is_float($args[$param])) {
 473                                 $replace = intval($args[$param]);
 474                         } else {
 475                                 $replace = "'".self::$dbo->escape($args[$param])."'";
 476                         }
 477
 478                         $pos = strpos($sql, '?', $offset);
 479                         if ($pos !== false) {
 480                                 $sql = substr_replace($sql, $replace, $pos, 1);
 481                         }
 482                         $offset = $pos + strlen($replace);
 483                 }
 484                 return $sql;
 485         }
 486
 487         /**
 488          * @brief Executes a prepared statement that returns data
 489          * @usage Example: $r = p("SELECT * FROM `item` WHERE `guid` = ?", $guid);
 490          * @param string $sql SQL statement
 491          * @return object statement object
 492          */
 493         static public function p($sql) {
 494                 $a = get_app();
 495
 496                 $stamp1 = microtime(true);
 497
 498                 $args = func_get_args();
 499                 unset($args[0]);
 500
 501                 // When the second function parameter is an array then use this as the parameter array
 502                 if ((count($args) > 0) AND (is_array($args[1]))) {
 503                         $params = $args[1];
 504                 } else {
 505                         $params = $args;
 506                 }
 507
 508                 // Renumber the array keys to be sure that they fit
 509                 $i = 0;
 510                 $args = array();
 511                 foreach ($params AS $param) {
 512                         $args[++$i] = $param;
 513                 }
 514
 515                 if (!self::$dbo OR !self::$dbo->connected) {
 516                         return false;
 517                 }
 518
 519                 if (substr_count($sql, '?') != count($args)) {
 520                         // Question: Should we continue or stop the query here?
 521                         logger('Parameter mismatch. Query "'.$sql.'" - Parameters '.print_r($args, true), LOGGER_DEBUG);
 522                 }
 523
 524                 $sql = self::$dbo->any_value_fallback($sql);
 525
 526                 if (x($a->config,'system') && x($a->config['system'], 'db_callstack')) {
 527                         $sql = "/*".$a->callstack()." */ ".$sql;
 528                 }
 529
 530                 self::$dbo->error = '';
 531                 self::$dbo->errorno = 0;
 532
 533                 switch (self::$dbo->driver) {
 534                         case 'pdo':
 535                                 if (!$stmt = self::$dbo->db->prepare($sql)) {
 536                                         $errorInfo = self::$dbo->db->errorInfo();
 537                                         self::$dbo->error = $errorInfo[2];
 538                                         self::$dbo->errorno = $errorInfo[1];
 539                                         $retval = false;
 540                                         break;
 541                                 }
 542
 543                                 foreach ($args AS $param => $value) {
 544                                         $stmt->bindParam($param, $args[$param]);
 545                                 }
 546
 547                                 if (!$stmt->execute()) {
 548                                         $errorInfo = $stmt->errorInfo();
 549                                         self::$dbo->error = $errorInfo[2];
 550                                         self::$dbo->errorno = $errorInfo[1];
 551                                         $retval = false;
 552                                 } else {
 553                                         $retval = $stmt;
 554                                 }
 555                                 break;
 556                         case 'mysqli':
 557                                 $stmt = self::$dbo->db->stmt_init();
 558
 559                                 if (!$stmt->prepare($sql)) {
 560                                         self::$dbo->error = $stmt->error;
 561                                         self::$dbo->errorno = $stmt->errno;
 562                                         $retval = false;
 563                                         break;
 564                                 }
 565
 566                                 $params = '';
 567                                 $values = array();
 568                                 foreach ($args AS $param => $value) {
 569                                         if (is_int($args[$param])) {
 570                                                 $params .= 'i';
 571                                         } elseif (is_float($args[$param])) {
 572                                                 $params .= 'd';
 573                                         } elseif (is_string($args[$param])) {
 574                                                 $params .= 's';
 575                                         } else {
 576                                                 $params .= 'b';
 577                                         }
 578                                         $values[] = &$args[$param];
 579                                 }
 580
 581                                 if (count($values) > 0) {
 582                                         array_unshift($values, $params);
 583                                         call_user_func_array(array($stmt, 'bind_param'), $values);
 584                                 }
 585
 586                                 if (!$stmt->execute()) {
 587                                         self::$dbo->error = self::$dbo->db->error;
 588                                         self::$dbo->errorno = self::$dbo->db->errno;
 589                                         $retval = false;
 590                                 } else {
 591                                         $stmt->store_result();
 592                                         $retval = $stmt;
 593                                 }
 594                                 break;
 595                         case 'mysql':
 596                                 // For the old "mysql" functions we cannot use prepared statements
 597                                 $retval = mysql_query(self::replace_parameters($sql, $args), self::$dbo->db);
 598                                 if (mysql_errno(self::$dbo->db)) {
 599                                         self::$dbo->error = mysql_error(self::$dbo->db);
 600                                         self::$dbo->errorno = mysql_errno(self::$dbo->db);
 601                                 }
 602                                 break;
 603                 }
 604
 605                 if (self::$dbo->errorno != 0) {
 606                         logger('DB Error '.self::$dbo->errorno.': '.self::$dbo->error."\n".
 607                                 $a->callstack(8))."\n".self::replace_parameters($sql, $args);
 608                 }
 609
 610                 $a->save_timestamp($stamp1, 'database');
 611
 612                 if (x($a->config,'system') && x($a->config['system'], 'db_log')) {
 613
 614                         $stamp2 = microtime(true);
 615                         $duration = (float)($stamp2 - $stamp1);
 616
 617                         if (($duration > $a->config["system"]["db_loglimit"])) {
 618                                 $duration = round($duration, 3);
 619                                 $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
 620
 621                                 @file_put_contents($a->config["system"]["db_log"], datetime_convert()."\t".$duration."\t".
 622                                                 basename($backtrace[1]["file"])."\t".
 623                                                 $backtrace[1]["line"]."\t".$backtrace[2]["function"]."\t".
 624                                                 substr(self::replace_parameters($sql, $args), 0, 2000)."\n", FILE_APPEND);
 625                         }
 626                 }
 627                 return $retval;
 628         }
 629
 630         /**
 631          * @brief Executes a prepared statement like UPDATE or INSERT that doesn't return data
 632          *
 633          * @param string $sql SQL statement
 634          * @return boolean Was the query successfull? False is returned only if an error occurred
 635          */
 636         static public function e($sql) {
 637                 $a = get_app();
 638
 639                 $stamp = microtime(true);
 640
 641                 $args = func_get_args();
 642
 643                 $stmt = call_user_func_array('self::p', $args);
 644
 645                 if (is_bool($stmt)) {
 646                         $retval = $stmt;
 647                 } elseif (is_object($stmt)) {
 648                         $retval = true;
 649                 } else {
 650                         $retval = false;
 651                 }
 652
 653                 self::close($stmt);
 654
 655                 $a->save_timestamp($stamp, "database_write");
 656
 657                 return $retval;
 658         }
 659
 660         /**
 661          * @brief Check if data exists
 662          *
 663          * @param string $sql SQL statement
 664          * @return boolean Are there rows for that query?
 665          */
 666         static public function exists($sql) {
 667                 $args = func_get_args();
 668
 669                 $stmt = call_user_func_array('self::p', $args);
 670
 671                 if (is_bool($stmt)) {
 672                         $retval = $stmt;
 673                 } else {
 674                         $retval = (self::num_rows($stmt) > 0);
 675                 }
 676
 677                 self::close($stmt);
 678
 679                 return $retval;
 680         }
 681
 682         /**
 683          * @brief Fetches the first row
 684          *
 685          * @param string $sql SQL statement
 686          * @return array first row of query
 687          */
 688         static public function fetch_first($sql) {
 689                 $args = func_get_args();
 690
 691                 $stmt = call_user_func_array('self::p', $args);
 692
 693                 if (is_bool($stmt)) {
 694                         $retval = $stmt;
 695                 } else {
 696                         $retval = self::fetch($stmt);
 697                 }
 698
 699                 self::close($stmt);
 700
 701                 return $retval;
 702         }
 703
 704         /**
 705          * @brief Returns the number of rows of a statement
 706          *
 707          * @param object Statement object
 708          * @return int Number of rows
 709          */
 710         static public function num_rows($stmt) {
 711                 switch (self::$dbo->driver) {
 712                         case 'pdo':
 713                                 return $stmt->rowCount();
 714                         case 'mysqli':
 715                                 return $stmt->num_rows;
 716                         case 'mysql':
 717                                 return mysql_num_rows($stmt);
 718                 }
 719                 return 0;
 720         }
 721
 722         /**
 723          * @brief Fetch a single row
 724          *
 725          * @param object $stmt statement object
 726          * @return array current row
 727          */
 728         static public function fetch($stmt) {
 729                 if (!is_object($stmt)) {
 730                         return false;
 731                 }
 732
 733                 switch (self::$dbo->driver) {
 734                         case 'pdo':
 735                                 return $stmt->fetch(PDO::FETCH_ASSOC);
 736                         case 'mysqli':
 737                                 // This code works, but is slow
 738
 739                                 // Bind the result to a result array
 740                                 $cols = array();
 741
 742                                 $cols_num = array();
 743                                 for ($x = 0; $x < $stmt->field_count; $x++) {
 744                                         $cols[] = &$cols_num[$x];
 745                                 }
 746
 747                                 call_user_func_array(array($stmt, 'bind_result'), $cols);
 748
 749                                 if (!$stmt->fetch()) {
 750                                         return false;
 751                                 }
 752
 753                                 // The slow part:
 754                                 // We need to get the field names for the array keys
 755                                 // It seems that there is no better way to do this.
 756                                 $result = $stmt->result_metadata();
 757                                 $fields = $result->fetch_fields();
 758
 759                                 $columns = array();
 760                                 foreach ($cols_num AS $param => $col) {
 761                                         $columns[$fields[$param]->name] = $col;
 762                                 }
 763                                 return $columns;
 764                         case 'mysql':
 765                                 return mysql_fetch_array(self::$dbo->result, MYSQL_ASSOC);
 766                 }
 767         }
 768
 769         /**
 770          * @brief Insert a row into a table
 771          *
 772          * @param string $table Table name
 773          * @param array $param parameter array
 774          *
 775          * @return boolean was the insert successfull?
 776          */
 777         static public function insert($table, $param) {
 778                 $sql = "INSERT INTO `".self::$dbo->escape($table)."` (`".implode("`, `", array_keys($param))."`) VALUES (".
 779                         substr(str_repeat("?, ", count($param)), 0, -2).");";
 780
 781                 return self::e($sql, $param);
 782         }
 783
 784         /**
 785          * @brief Starts a transaction
 786          *
 787          * @return boolean Was the command executed successfully?
 788          */
 789         static public function transaction() {
 790                 if (!self::e('COMMIT')) {
 791                         return false;
 792                 }
 793                 if (!self::e('START TRANSACTION')) {
 794                         return false;
 795                 }
 796                 self::$in_transaction = true;
 797                 return true;
 798         }
 799
 800         /**
 801          * @brief Does a commit
 802          *
 803          * @return boolean Was the command executed successfully?
 804          */
 805         static public function commit() {
 806                 if (!self::e('COMMIT')) {
 807                         return false;
 808                 }
 809                 self::$in_transaction = false;
 810                 return true;
 811         }
 812
 813         /**
 814          * @brief Does a rollback
 815          *
 816          * @return boolean Was the command executed successfully?
 817          */
 818         static public function rollback() {
 819                 if (!self::e('ROLLBACK')) {
 820                         return false;
 821                 }
 822                 self::$in_transaction = false;
 823                 return true;
 824         }
 825
 826         /**
 827          * @brief Build the array with the table relations
 828          *
 829          * The array is build from the database definitions in dbstructure.php
 830          *
 831          * This process must only be started once, since the value is cached.
 832          */
 833         static private function build_relation_data() {
 834                 $definition = db_definition();
 835
 836                 foreach ($definition AS $table => $structure) {
 837                         foreach ($structure['fields'] AS $field => $field_struct) {
 838                                 if (isset($field_struct['relation'])) {
 839                                         foreach ($field_struct['relation'] AS $rel_table => $rel_field) {
 840                                                 self::$relation[$rel_table][$rel_field][$table][] = $field;
 841                                         }
 842                                 }
 843                         }
 844                 }
 845         }
 846
 847         /**
 848          * @brief Delete a row from a table
 849          *
 850          * @param string $table Table name
 851          * @param array $param parameter array
 852          * @param boolean $in_process Internal use: Only do a commit after the last delete
 853          * @param array $callstack Internal use: prevent endless loops
 854          *
 855          * @return boolean|array was the delete successfull? When $in_process is set: deletion data
 856          */
 857         static public function delete($table, $param, $in_process = false, &$callstack = array()) {
 858
 859                 $commands = array();
 860
 861                 // Create a key for the loop prevention
 862                 $key = $table.':'.implode(':', array_keys($param)).':'.implode(':', $param);
 863
 864                 // We quit when this key already exists in the callstack.
 865                 if (isset($callstack[$key])) {
 866                         return $commands;
 867                 }
 868
 869                 $callstack[$key] = true;
 870
 871                 $table = self::$dbo->escape($table);
 872
 873                 $commands[$key] = array('table' => $table, 'param' => $param);
 874
 875                 // To speed up the whole process we cache the table relations
 876                 if (count(self::$relation) == 0) {
 877                         self::build_relation_data();
 878                 }
 879
 880                 // Is there a relation entry for the table?
 881                 if (isset(self::$relation[$table])) {
 882                         // We only allow a simple "one field" relation.
 883                         $field = array_keys(self::$relation[$table])[0];
 884                         $rel_def = array_values(self::$relation[$table])[0];
 885
 886                         // Create a key for preventing double queries
 887                         $qkey = $field.'-'.$table.':'.implode(':', array_keys($param)).':'.implode(':', $param);
 888
 889                         // When the search field is the relation field, we don't need to fetch the rows
 890                         // This is useful when the leading record is already deleted in the frontend but the rest is done in the backend
 891                         if ((count($param) == 1) AND ($field == array_keys($param)[0])) {
 892                                 foreach ($rel_def AS $rel_table => $rel_fields) {
 893                                         foreach ($rel_fields AS $rel_field) {
 894                                                 $retval = self::delete($rel_table, array($rel_field => array_values($param)[0]), true, $callstack);
 895                                                 $commands = array_merge($commands, $retval);
 896                                         }
 897                                 }
 898                         // We quit when this key already exists in the callstack.
 899                         } elseif (!isset($callstack[$qkey])) {
 900
 901                                 $callstack[$qkey] = true;
 902
 903                                 // Fetch all rows that are to be deleted
 904                                 $sql = "SELECT ".self::$dbo->escape($field)." FROM `".$table."` WHERE `".
 905                                 implode("` = ? AND `", array_keys($param))."` = ?";
 906
 907                                 $data = self::p($sql, $param);
 908                                 while ($row = self::fetch($data)) {
 909                                         // Now we accumulate the delete commands
 910                                         $retval = self::delete($table, array($field => $row[$field]), true, $callstack);
 911                                         $commands = array_merge($commands, $retval);
 912                                 }
 913
 914                                 // Since we had split the delete command we don't need the original command anymore
 915                                 unset($commands[$key]);
 916                         }
 917                 }
 918
 919                 if (!$in_process) {
 920                         // Now we finalize the process
 921                         $do_transaction = !self::$in_transaction;
 922
 923                         if ($do_transaction) {
 924                                 self::transaction();
 925                         }
 926
 927                         $compacted = array();
 928                         $counter = array();
 929                         foreach ($commands AS $command) {
 930                                 if (count($command['param']) > 1) {
 931                                         $sql = "DELETE FROM `".$command['table']."` WHERE `".
 932                                                 implode("` = ? AND `", array_keys($command['param']))."` = ?";
 933
 934                                         logger(dba::replace_parameters($sql, $command['param']), LOGGER_DATA);
 935
 936                                         if (!self::e($sql, $command['param'])) {
 937                                                 if ($do_transaction) {
 938                                                         self::rollback();
 939                                                 }
 940                                                 return false;
 941                                         }
 942                                 } else {
 943                                         $key_table = $command['table'];
 944                                         $key_param = array_keys($command['param'])[0];
 945                                         $value = array_values($command['param'])[0];
 946
 947                                         // Split the SQL queries in chunks of 100 values
 948                                         // We do the $i stuff here to make the code better readable
 949                                         $i = $counter[$key_table][$key_param];
 950                                         if (count($compacted[$key_table][$key_param][$i]) > 100) {
 951                                                 ++$i;
 952                                         }
 953
 954                                         $compacted[$key_table][$key_param][$i][$value] = $value;
 955                                         $counter[$key_table][$key_param] = $i;
 956                                 }
 957                         }
 958                         foreach ($compacted AS $table => $values) {
 959                                 foreach ($values AS $field => $field_value_list) {
 960                                         foreach ($field_value_list AS $field_values) {
 961                                                 $sql = "DELETE FROM `".$table."` WHERE `".$field."` IN (".
 962                                                         substr(str_repeat("?, ", count($field_values)), 0, -2).");";
 963
 964                                                 logger(dba::replace_parameters($sql, $field_values), LOGGER_DATA);
 965
 966                                                 if (!self::e($sql, $field_values)) {
 967                                                         if ($do_transaction) {
 968                                                                 self::rollback();
 969                                                         }
 970                                                         return false;
 971                                                 }
 972                                         }
 973                                 }
 974                         }
 975                         if ($do_transaction) {
 976                                 self::commit();
 977                         }
 978                         return true;
 979                 }
 980
 981                 return $commands;
 982         }
 983
 984         /**
 985          * @brief Updates rows
 986          *
 987          * Updates rows in the database. When $old_fields is set to an array,
 988          * the system will only do an update if the fields in that array changed.
 989          *
 990          * Attention:
 991          * Only the values in $old_fields are compared.
 992          * This is an intentional behaviour.
 993          *
 994          * Example:
 995          * We include the timestamp field in $fields but not in $old_fields.
 996          * Then the row will only get the new timestamp when the other fields had changed.
 997          *
 998          * When $old_fields is set to a boolean value the system will do this compare itself.
 999          * When $old_fields is set to "true" the system will do an insert if the row doesn't exists.
1000          *
1001          * Attention:
1002          * Only set $old_fields to a boolean value when you are sure that you will update a single row.
1003          * When you set $old_fields to "true" then $fields must contain all relevant fields!
1004          *
1005          * @param string $table Table name
1006          * @param array $fields contains the fields that are updated
1007          * @param array $condition condition array with the key values
1008          * @param array|boolean $old_fields array with the old field values that are about to be replaced
1009          *
1010          * @return boolean was the update successfull?
1011          */
1012         static public function update($table, $fields, $condition, $old_fields = array()) {
1013
1014                 /** @todo We may use MySQL specific functions here:
1015                  * INSERT INTO `config` (`cat`, `k`, `v`) VALUES ('%s', '%s', '%s') ON DUPLICATE KEY UPDATE `v` = '%s'"
1016                  * But I think that it doesn't make sense here.
1017                 */
1018
1019                 $table = self::$dbo->escape($table);
1020
1021                 if (is_bool($old_fields)) {
1022                         $sql = "SELECT * FROM `".$table."` WHERE `".
1023                         implode("` = ? AND `", array_keys($condition))."` = ? LIMIT 1";
1024
1025                         $params = array();
1026                         foreach ($condition AS $value) {
1027                                 $params[] = $value;
1028                         }
1029
1030                         $do_insert = $old_fields;
1031
1032                         $old_fields = self::fetch_first($sql, $params);
1033                         if (is_bool($old_fields)) {
1034                                 if ($do_insert) {
1035                                         return self::insert($table, $fields);
1036                                 }
1037                                 $old_fields = array();
1038                         }
1039                 }
1040
1041                 $do_update = (count($old_fields) == 0);
1042
1043                 foreach ($old_fields AS $fieldname => $content) {
1044                         if (isset($fields[$fieldname])) {
1045                                 if ($fields[$fieldname] == $content) {
1046                                         unset($fields[$fieldname]);
1047                                 } else {
1048                                         $do_update = true;
1049                                 }
1050                         }
1051                 }
1052
1053                 if (!$do_update OR (count($fields) == 0)) {
1054                         return true;
1055                 }
1056
1057                 $sql = "UPDATE `".$table."` SET `".
1058                         implode("` = ?, `", array_keys($fields))."` = ? WHERE `".
1059                         implode("` = ? AND `", array_keys($condition))."` = ?";
1060
1061                 $params = array();
1062                 foreach ($fields AS $value) {
1063                         $params[] = $value;
1064                 }
1065                 foreach ($condition AS $value) {
1066                         $params[] = $value;
1067                 }
1068
1069                 return self::e($sql, $params);
1070         }
1071
1072         /**
1073          * @brief Select rows from a table
1074          *
1075          * @param string $table Table name
1076          * @param array $fields array of selected fields
1077          * @param array $condition array of fields for condition
1078          * @param array $params array of several parameters
1079          *
1080          * @return boolean|object If "limit" is equal "1" only a single row is returned, else a query object is returned
1081          *
1082          * Example:
1083          * $table = "item";
1084          * $fields = array("id", "uri", "uid", "network");
1085          * $condition = array("uid" => 1, "network" => 'dspr');
1086          * $params = array("order" => array("id", "received" => true), "limit" => 1);
1087          *
1088          * $data = dba::select($table, $fields, $condition, $params);
1089          */
1090         static public function select($table, $fields = array(), $condition = array(), $params = array()) {
1091                 if ($table == '') {
1092                         return false;
1093                 }
1094
1095                 if (count($fields) > 0) {
1096                         $select_fields = "`".implode("`, `", array_values($fields))."`";
1097                 } else {
1098                         $select_fields = "*";
1099                 }
1100
1101                 if (count($condition) > 0) {
1102                         $condition_string = " WHERE `".implode("` = ? AND `", array_keys($condition))."` = ?";
1103                 } else {
1104                         $condition_string = "";
1105                 }
1106
1107                 $param_string = '';
1108                 $single_row = false;
1109
1110                 if (isset($params['order'])) {
1111                         $param_string .= " ORDER BY ";
1112                         foreach ($params['order'] AS $fields => $order) {
1113                                 if (!is_int($fields)) {
1114                                         $param_string .= "`".$fields."` ".($order ? "DESC" : "ASC").", ";
1115                                 } else {
1116                                         $param_string .= "`".$order."`, ";
1117                                 }
1118                         }
1119                         $param_string = substr($param_string, 0, -2);
1120                 }
1121
1122                 if (isset($params['limit'])) {
1123                         if (is_int($params['limit'])) {
1124                                 $param_string .= " LIMIT ".$params['limit'];
1125                                 $single_row =($params['limit'] == 1);
1126                         }
1127                 }
1128
1129                 $sql = "SELECT ".$select_fields." FROM `".$table."`".$condition_string.$param_string;
1130
1131                 $result = self::p($sql, $condition);
1132
1133                 if (is_bool($result) OR !$single_row) {
1134                         return $result;
1135                 } else {
1136                         $row = self::fetch($result);
1137                         self::close($result);
1138                         return $row;
1139                 }
1140         }
1141
1142         /**
1143          * @brief Closes the current statement
1144          *
1145          * @param object $stmt statement object
1146          * @return boolean was the close successfull?
1147          */
1148         static public function close($stmt) {
1149                 if (!is_object($stmt)) {
1150                         return false;
1151                 }
1152
1153                 switch (self::$dbo->driver) {
1154                         case 'pdo':
1155                                 return $stmt->closeCursor();
1156                         case 'mysqli':
1157                                 return $stmt->free_result();
1158                                 return $stmt->close();
1159                         case 'mysql':
1160                                 return mysql_free_result($stmt);
1161                 }
1162         }
1163 }
1164
1165 function printable($s) {
1166         $s = preg_replace("~([\x01-\x08\x0E-\x0F\x10-\x1F\x7F-\xFF])~",".", $s);
1167         $s = str_replace("\x00",'.',$s);
1168         if (x($_SERVER,'SERVER_NAME')) {
1169                 $s = escape_tags($s);
1170         }
1171         return $s;
1172 }
1173
1174 // Procedural functions
1175 function dbg($state) {
1176         global $db;
1177
1178         if ($db) {
1179                 $db->dbg($state);
1180         }
1181 }
1182
1183 function dbesc($str) {
1184         global $db;
1185
1186         if ($db && $db->connected) {
1187                 return($db->escape($str));
1188         } else {
1189                 return(str_replace("'","\\'",$str));
1190         }
1191 }
1192
1193 // Function: q($sql,$args);
1194 // Description: execute SQL query with printf style args.
1195 // Example: $r = q("SELECT * FROM `%s` WHERE `uid` = %d",
1196 //                   'user', 1);
1197 function q($sql) {
1198         global $db;
1199         $args = func_get_args();
1200         unset($args[0]);
1201
1202         if ($db && $db->connected) {
1203                 $sql = $db->any_value_fallback($sql);
1204                 $stmt = @vsprintf($sql,$args); // Disabled warnings
1205                 //logger("dba: q: $stmt", LOGGER_ALL);
1206                 if ($stmt === false)
1207                         logger('dba: vsprintf error: ' . print_r(debug_backtrace(),true), LOGGER_DEBUG);
1208
1209                 $db->log_index($stmt);
1210
1211                 return $db->q($stmt);
1212         }
1213
1214         /**
1215          *
1216          * This will happen occasionally trying to store the
1217          * session data after abnormal program termination
1218          *
1219          */
1220         logger('dba: no database: ' . print_r($args,true));
1221         return false;
1222 }
1223
1224 /**
1225  * @brief Performs a query with "dirty reads"
1226  *
1227  * By doing dirty reads (reading uncommitted data) no locks are performed
1228  * This function can be used to fetch data that doesn't need to be reliable.
1229  *
1230  * @param $args Query parameters (1 to N parameters of different types)
1231  * @return array Query array
1232  */
1233 function qu($sql) {
1234         global $db;
1235
1236         $args = func_get_args();
1237         unset($args[0]);
1238
1239         if ($db && $db->connected) {
1240                 $sql = $db->any_value_fallback($sql);
1241                 $stmt = @vsprintf($sql,$args); // Disabled warnings
1242                 if ($stmt === false)
1243                         logger('dba: vsprintf error: ' . print_r(debug_backtrace(),true), LOGGER_DEBUG);
1244
1245                 $db->log_index($stmt);
1246
1247                 $db->q("SET SESSION TRANSACTION ISOLATION LEVEL READ UNCOMMITTED;");
1248                 $retval = $db->q($stmt);
1249                 $db->q("SET SESSION TRANSACTION ISOLATION LEVEL REPEATABLE READ;");
1250                 return $retval;
1251         }
1252
1253         /**
1254          *
1255          * This will happen occasionally trying to store the
1256          * session data after abnormal program termination
1257          *
1258          */
1259         logger('dba: no database: ' . print_r($args,true));
1260         return false;
1261 }
1262
1263 /**
1264  *
1265  * Raw db query, no arguments
1266  *
1267  */
1268 function dbq($sql) {
1269         global $db;
1270
1271         if ($db && $db->connected) {
1272                 $ret = $db->q($sql);
1273         } else {
1274                 $ret = false;
1275         }
1276         return $ret;
1277 }
1278
1279 // Caller is responsible for ensuring that any integer arguments to
1280 // dbesc_array are actually integers and not malformed strings containing
1281 // SQL injection vectors. All integer array elements should be specifically
1282 // cast to int to avoid trouble.
1283 function dbesc_array_cb(&$item, $key) {
1284         if (is_string($item))
1285                 $item = dbesc($item);
1286 }
1287
1288 function dbesc_array(&$arr) {
1289         if (is_array($arr) && count($arr)) {
1290                 array_walk($arr,'dbesc_array_cb');
1291         }
1292 }
1293
1294 function dba_timer() {
1295         return microtime(true);
1296 }