include/dba.php

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