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