src/Database/Database.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2021, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 namespace Friendica\Database;
  23
  24 use Friendica\Core\Config\Cache;
  25 use Friendica\Core\System;
  26 use Friendica\Network\HTTPException\InternalServerErrorException;
  27 use Friendica\Util\DateTimeFormat;
  28 use Friendica\Util\Profiler;
  29 use mysqli;
  30 use mysqli_result;
  31 use mysqli_stmt;
  32 use PDO;
  33 use PDOException;
  34 use PDOStatement;
  35 use Psr\Log\LoggerInterface;
  36
  37 /**
  38  * This class is for the low level database stuff that does driver specific things.
  39  */
  40 class Database
  41 {
  42         const PDO = 'pdo';
  43         const MYSQLI = 'mysqli';
  44
  45         const INSERT_DEFAULT = 0;
  46         const INSERT_UPDATE = 1;
  47         const INSERT_IGNORE = 2;
  48
  49         protected $connected = false;
  50
  51         /**
  52          * @var Cache
  53          */
  54         protected $configCache;
  55         /**
  56          * @var Profiler
  57          */
  58         protected $profiler;
  59         /**
  60          * @var LoggerInterface
  61          */
  62         protected $logger;
  63         protected $server_info    = '';
  64         /** @var PDO|mysqli */
  65         protected $connection;
  66         protected $driver;
  67         protected $pdo_emulate_prepares = false;
  68         private $error          = false;
  69         private $errorno        = 0;
  70         private $affected_rows  = 0;
  71         protected $in_transaction = false;
  72         protected $in_retrial     = false;
  73         protected $testmode       = false;
  74         private $relation       = [];
  75
  76         public function __construct(Cache $configCache, Profiler $profiler, LoggerInterface $logger)
  77         {
  78                 // We are storing these values for being able to perform a reconnect
  79                 $this->configCache   = $configCache;
  80                 $this->profiler      = $profiler;
  81                 $this->logger        = $logger;
  82
  83                 $this->connect();
  84
  85                 if ($this->isConnected()) {
  86                         // Loads DB_UPDATE_VERSION constant
  87                         DBStructure::definition($configCache->get('system', 'basepath'), false);
  88                 }
  89         }
  90
  91         public function connect()
  92         {
  93                 if (!is_null($this->connection) && $this->connected()) {
  94                         return $this->connected;
  95                 }
  96
  97                 // Reset connected state
  98                 $this->connected = false;
  99
 100                 $port       = 0;
 101                 $serveraddr = trim($this->configCache->get('database', 'hostname'));
 102                 $serverdata = explode(':', $serveraddr);
 103                 $server     = $serverdata[0];
 104                 if (count($serverdata) > 1) {
 105                         $port = trim($serverdata[1]);
 106                 }
 107
 108                 if (!empty(trim($this->configCache->get('database', 'port')))) {
 109                         $port = trim($this->configCache->get('database', 'port'));
 110                 }
 111
 112                 $server  = trim($server);
 113                 $user    = trim($this->configCache->get('database', 'username'));
 114                 $pass    = trim($this->configCache->get('database', 'password'));
 115                 $db      = trim($this->configCache->get('database', 'database'));
 116                 $charset = trim($this->configCache->get('database', 'charset'));
 117
 118                 if (!(strlen($server) && strlen($user))) {
 119                         return false;
 120                 }
 121
 122                 $persistent = (bool)$this->configCache->get('database', 'persistent');
 123
 124                 $this->pdo_emulate_prepares = (bool)$this->configCache->get('database', 'pdo_emulate_prepares');
 125
 126                 if (!$this->configCache->get('database', 'disable_pdo') && class_exists('\PDO') && in_array('mysql', PDO::getAvailableDrivers())) {
 127                         $this->driver = self::PDO;
 128                         $connect      = "mysql:host=" . $server . ";dbname=" . $db;
 129
 130                         if ($port > 0) {
 131                                 $connect .= ";port=" . $port;
 132                         }
 133
 134                         if ($charset) {
 135                                 $connect .= ";charset=" . $charset;
 136                         }
 137
 138                         try {
 139                                 $this->connection = @new PDO($connect, $user, $pass, [PDO::ATTR_PERSISTENT => $persistent]);
 140                                 $this->connection->setAttribute(PDO::ATTR_EMULATE_PREPARES, $this->pdo_emulate_prepares);
 141                                 $this->connected = true;
 142                         } catch (PDOException $e) {
 143                                 $this->connected = false;
 144                         }
 145                 }
 146
 147                 if (!$this->connected && class_exists('\mysqli')) {
 148                         $this->driver = self::MYSQLI;
 149
 150                         if ($port > 0) {
 151                                 $this->connection = @new mysqli($server, $user, $pass, $db, $port);
 152                         } else {
 153                                 $this->connection = @new mysqli($server, $user, $pass, $db);
 154                         }
 155
 156                         if (!mysqli_connect_errno()) {
 157                                 $this->connected = true;
 158
 159                                 if ($charset) {
 160                                         $this->connection->set_charset($charset);
 161                                 }
 162                         }
 163                 }
 164
 165                 // No suitable SQL driver was found.
 166                 if (!$this->connected) {
 167                         $this->driver     = null;
 168                         $this->connection = null;
 169                 }
 170
 171                 return $this->connected;
 172         }
 173
 174         public function setTestmode(bool $test)
 175         {
 176                 $this->testmode = $test;
 177         }
 178         /**
 179          * Sets the logger for DBA
 180          *
 181          * @note this is necessary because if we want to load the logger configuration
 182          *       from the DB, but there's an error, we would print out an exception.
 183          *       So the logger gets updated after the logger configuration can be retrieved
 184          *       from the database
 185          *
 186          * @param LoggerInterface $logger
 187          */
 188         public function setLogger(LoggerInterface $logger)
 189         {
 190                 $this->logger = $logger;
 191         }
 192
 193         /**
 194          * Sets the profiler for DBA
 195          *
 196          * @param Profiler $profiler
 197          */
 198         public function setProfiler(Profiler $profiler)
 199         {
 200                 $this->profiler = $profiler;
 201         }
 202         /**
 203          * Disconnects the current database connection
 204          */
 205         public function disconnect()
 206         {
 207                 if (!is_null($this->connection)) {
 208                         switch ($this->driver) {
 209                                 case self::PDO:
 210                                         $this->connection = null;
 211                                         break;
 212                                 case self::MYSQLI:
 213                                         $this->connection->close();
 214                                         $this->connection = null;
 215                                         break;
 216                         }
 217                 }
 218
 219                 $this->driver    = null;
 220                 $this->connected = false;
 221         }
 222
 223         /**
 224          * Perform a reconnect of an existing database connection
 225          */
 226         public function reconnect()
 227         {
 228                 $this->disconnect();
 229                 return $this->connect();
 230         }
 231
 232         /**
 233          * Return the database object.
 234          *
 235          * @return PDO|mysqli
 236          */
 237         public function getConnection()
 238         {
 239                 return $this->connection;
 240         }
 241
 242         /**
 243          * Return the database driver string
 244          *
 245          * @return string with either "pdo" or "mysqli"
 246          */
 247         public function getDriver()
 248         {
 249                 return $this->driver;
 250         }
 251
 252         /**
 253          * Returns the MySQL server version string
 254          *
 255          * This function discriminate between the deprecated mysql API and the current
 256          * object-oriented mysqli API. Example of returned string: 5.5.46-0+deb8u1
 257          *
 258          * @return string
 259          */
 260         public function serverInfo()
 261         {
 262                 if ($this->server_info == '') {
 263                         switch ($this->driver) {
 264                                 case self::PDO:
 265                                         $this->server_info = $this->connection->getAttribute(PDO::ATTR_SERVER_VERSION);
 266                                         break;
 267                                 case self::MYSQLI:
 268                                         $this->server_info = $this->connection->server_info;
 269                                         break;
 270                         }
 271                 }
 272                 return $this->server_info;
 273         }
 274
 275         /**
 276          * Returns the selected database name
 277          *
 278          * @return string
 279          * @throws \Exception
 280          */
 281         public function databaseName()
 282         {
 283                 $ret  = $this->p("SELECT DATABASE() AS `db`");
 284                 $data = $this->toArray($ret);
 285                 return $data[0]['db'];
 286         }
 287
 288         /**
 289          * Analyze a database query and log this if some conditions are met.
 290          *
 291          * @param string $query The database query that will be analyzed
 292          *
 293          * @throws \Exception
 294          */
 295         private function logIndex($query)
 296         {
 297
 298                 if (!$this->configCache->get('system', 'db_log_index')) {
 299                         return;
 300                 }
 301
 302                 // Don't explain an explain statement
 303                 if (strtolower(substr($query, 0, 7)) == "explain") {
 304                         return;
 305                 }
 306
 307                 // Only do the explain on "select", "update" and "delete"
 308                 if (!in_array(strtolower(substr($query, 0, 6)), ["select", "update", "delete"])) {
 309                         return;
 310                 }
 311
 312                 $r = $this->p("EXPLAIN " . $query);
 313                 if (!$this->isResult($r)) {
 314                         return;
 315                 }
 316
 317                 $watchlist = explode(',', $this->configCache->get('system', 'db_log_index_watch'));
 318                 $denylist = explode(',', $this->configCache->get('system', 'db_log_index_denylist'));
 319
 320                 while ($row = $this->fetch($r)) {
 321                         if ((intval($this->configCache->get('system', 'db_loglimit_index')) > 0)) {
 322                                 $log = (in_array($row['key'], $watchlist) &&
 323                                         ($row['rows'] >= intval($this->configCache->get('system', 'db_loglimit_index'))));
 324                         } else {
 325                                 $log = false;
 326                         }
 327
 328                         if ((intval($this->configCache->get('system', 'db_loglimit_index_high')) > 0) && ($row['rows'] >= intval($this->configCache->get('system', 'db_loglimit_index_high')))) {
 329                                 $log = true;
 330                         }
 331
 332                         if (in_array($row['key'], $denylist) || ($row['key'] == "")) {
 333                                 $log = false;
 334                         }
 335
 336                         if ($log) {
 337                                 $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
 338                                 @file_put_contents($this->configCache->get('system', 'db_log_index'), DateTimeFormat::utcNow() . "\t" .
 339                                                                                                       $row['key'] . "\t" . $row['rows'] . "\t" . $row['Extra'] . "\t" .
 340                                                                                                       basename($backtrace[1]["file"]) . "\t" .
 341                                                                                                       $backtrace[1]["line"] . "\t" . $backtrace[2]["function"] . "\t" .
 342                                                                                                       substr($query, 0, 4000) . "\n", FILE_APPEND);
 343                         }
 344                 }
 345         }
 346
 347         /**
 348          * Removes every not allowlisted character from the identifier string
 349          *
 350          * @param string $identifier
 351          *
 352          * @return string sanitized identifier
 353          * @throws \Exception
 354          */
 355         private function sanitizeIdentifier($identifier)
 356         {
 357                 return preg_replace('/[^A-Za-z0-9_\-]+/', '', $identifier);
 358         }
 359
 360         public function escape($str)
 361         {
 362                 if ($this->connected) {
 363                         switch ($this->driver) {
 364                                 case self::PDO:
 365                                         return substr(@$this->connection->quote($str, PDO::PARAM_STR), 1, -1);
 366
 367                                 case self::MYSQLI:
 368                                         return @$this->connection->real_escape_string($str);
 369                         }
 370                 } else {
 371                         return str_replace("'", "\\'", $str);
 372                 }
 373         }
 374
 375         public function isConnected()
 376         {
 377                 return $this->connected;
 378         }
 379
 380         public function connected()
 381         {
 382                 $connected = false;
 383
 384                 if (is_null($this->connection)) {
 385                         return false;
 386                 }
 387
 388                 switch ($this->driver) {
 389                         case self::PDO:
 390                                 $r = $this->p("SELECT 1");
 391                                 if ($this->isResult($r)) {
 392                                         $row       = $this->toArray($r);
 393                                         $connected = ($row[0]['1'] == '1');
 394                                 }
 395                                 break;
 396                         case self::MYSQLI:
 397                                 $connected = $this->connection->ping();
 398                                 break;
 399                 }
 400
 401                 return $connected;
 402         }
 403
 404         /**
 405          * Replaces ANY_VALUE() function by MIN() function,
 406          * if the database server does not support ANY_VALUE().
 407          *
 408          * Considerations for Standard SQL, or MySQL with ONLY_FULL_GROUP_BY (default since 5.7.5).
 409          * ANY_VALUE() is available from MySQL 5.7.5 https://dev.mysql.com/doc/refman/5.7/en/miscellaneous-functions.html
 410          * A standard fall-back is to use MIN().
 411          *
 412          * @param string $sql An SQL string without the values
 413          *
 414          * @return string The input SQL string modified if necessary.
 415          */
 416         public function anyValueFallback($sql)
 417         {
 418                 $server_info = $this->serverInfo();
 419                 if (version_compare($server_info, '5.7.5', '<') ||
 420                     (stripos($server_info, 'MariaDB') !== false)) {
 421                         $sql = str_ireplace('ANY_VALUE(', 'MIN(', $sql);
 422                 }
 423                 return $sql;
 424         }
 425
 426         /**
 427          * Replaces the ? placeholders with the parameters in the $args array
 428          *
 429          * @param string $sql  SQL query
 430          * @param array  $args The parameters that are to replace the ? placeholders
 431          *
 432          * @return string The replaced SQL query
 433          */
 434         private function replaceParameters($sql, $args)
 435         {
 436                 $offset = 0;
 437                 foreach ($args AS $param => $value) {
 438                         if (is_int($args[$param]) || is_float($args[$param]) || is_bool($args[$param])) {
 439                                 $replace = intval($args[$param]);
 440                         } elseif (is_null($args[$param])) {
 441                                 $replace = 'NULL';
 442                         } else {
 443                                 $replace = "'" . $this->escape($args[$param]) . "'";
 444                         }
 445
 446                         $pos = strpos($sql, '?', $offset);
 447                         if ($pos !== false) {
 448                                 $sql = substr_replace($sql, $replace, $pos, 1);
 449                         }
 450                         $offset = $pos + strlen($replace);
 451                 }
 452                 return $sql;
 453         }
 454
 455         /**
 456          * Executes a prepared statement that returns data
 457          *
 458          * @usage Example: $r = p("SELECT * FROM `post` WHERE `guid` = ?", $guid);
 459          *
 460          * Please only use it with complicated queries.
 461          * For all regular queries please use DBA::select or DBA::exists
 462          *
 463          * @param string $sql SQL statement
 464          *
 465          * @return bool|object statement object or result object
 466          * @throws \Exception
 467          */
 468         public function p($sql)
 469         {
 470
 471                 $this->profiler->startRecording('database');
 472                 $stamp1 = microtime(true);
 473
 474                 $params = DBA::getParam(func_get_args());
 475
 476                 // Renumber the array keys to be sure that they fit
 477                 $i    = 0;
 478                 $args = [];
 479                 foreach ($params AS $param) {
 480                         // Avoid problems with some MySQL servers and boolean values. See issue #3645
 481                         if (is_bool($param)) {
 482                                 $param = (int)$param;
 483                         }
 484                         $args[++$i] = $param;
 485                 }
 486
 487                 if (!$this->connected) {
 488                         return false;
 489                 }
 490
 491                 if ((substr_count($sql, '?') != count($args)) && (count($args) > 0)) {
 492                         // Question: Should we continue or stop the query here?
 493                         $this->logger->warning('Query parameters mismatch.', ['query' => $sql, 'args' => $args, 'callstack' => System::callstack()]);
 494                 }
 495
 496                 $sql = DBA::cleanQuery($sql);
 497                 $sql = $this->anyValueFallback($sql);
 498
 499                 $orig_sql = $sql;
 500
 501                 if ($this->configCache->get('system', 'db_callstack') !== null) {
 502                         $sql = "/*" . System::callstack() . " */ " . $sql;
 503                 }
 504
 505                 $is_error            = false;
 506                 $this->error         = '';
 507                 $this->errorno       = 0;
 508                 $this->affected_rows = 0;
 509
 510                 // We have to make some things different if this function is called from "e"
 511                 $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2);
 512
 513                 if (isset($trace[1])) {
 514                         $called_from = $trace[1];
 515                 } else {
 516                         // We use just something that is defined to avoid warnings
 517                         $called_from = $trace[0];
 518                 }
 519                 // We are having an own error logging in the function "e"
 520                 $called_from_e = ($called_from['function'] == 'e');
 521
 522                 if (!isset($this->connection)) {
 523                         throw new InternalServerErrorException('The Connection is empty, although connected is set true.');
 524                 }
 525
 526                 switch ($this->driver) {
 527                         case self::PDO:
 528                                 // If there are no arguments we use "query"
 529                                 if (count($args) == 0) {
 530                                         if (!$retval = $this->connection->query($this->replaceParameters($sql, $args))) {
 531                                                 $errorInfo     = $this->connection->errorInfo();
 532                                                 $this->error   = $errorInfo[2];
 533                                                 $this->errorno = $errorInfo[1];
 534                                                 $retval        = false;
 535                                                 $is_error      = true;
 536                                                 break;
 537                                         }
 538                                         $this->affected_rows = $retval->rowCount();
 539                                         break;
 540                                 }
 541
 542                                 /** @var $stmt mysqli_stmt|PDOStatement */
 543                                 if (!$stmt = $this->connection->prepare($sql)) {
 544                                         $errorInfo     = $this->connection->errorInfo();
 545                                         $this->error   = $errorInfo[2];
 546                                         $this->errorno = $errorInfo[1];
 547                                         $retval        = false;
 548                                         $is_error      = true;
 549                                         break;
 550                                 }
 551
 552                                 foreach ($args AS $param => $value) {
 553                                         if (is_int($args[$param])) {
 554                                                 $data_type = PDO::PARAM_INT;
 555                                         } else {
 556                                                 $data_type = PDO::PARAM_STR;
 557                                         }
 558                                         $stmt->bindParam($param, $args[$param], $data_type);
 559                                 }
 560
 561                                 if (!$stmt->execute()) {
 562                                         $errorInfo     = $stmt->errorInfo();
 563                                         $this->error   = $errorInfo[2];
 564                                         $this->errorno = $errorInfo[1];
 565                                         $retval        = false;
 566                                         $is_error      = true;
 567                                 } else {
 568                                         $retval              = $stmt;
 569                                         $this->affected_rows = $retval->rowCount();
 570                                 }
 571                                 break;
 572                         case self::MYSQLI:
 573                                 // There are SQL statements that cannot be executed with a prepared statement
 574                                 $parts           = explode(' ', $orig_sql);
 575                                 $command         = strtolower($parts[0]);
 576                                 $can_be_prepared = in_array($command, ['select', 'update', 'insert', 'delete']);
 577
 578                                 // The fallback routine is called as well when there are no arguments
 579                                 if (!$can_be_prepared || (count($args) == 0)) {
 580                                         $retval = $this->connection->query($this->replaceParameters($sql, $args));
 581                                         if ($this->connection->errno) {
 582                                                 $this->error   = $this->connection->error;
 583                                                 $this->errorno = $this->connection->errno;
 584                                                 $retval        = false;
 585                                                 $is_error      = true;
 586                                         } else {
 587                                                 if (isset($retval->num_rows)) {
 588                                                         $this->affected_rows = $retval->num_rows;
 589                                                 } else {
 590                                                         $this->affected_rows = $this->connection->affected_rows;
 591                                                 }
 592                                         }
 593                                         break;
 594                                 }
 595
 596                                 $stmt = $this->connection->stmt_init();
 597
 598                                 if (!$stmt->prepare($sql)) {
 599                                         $this->error   = $stmt->error;
 600                                         $this->errorno = $stmt->errno;
 601                                         $retval        = false;
 602                                         $is_error      = true;
 603                                         break;
 604                                 }
 605
 606                                 $param_types = '';
 607                                 $values      = [];
 608                                 foreach ($args AS $param => $value) {
 609                                         if (is_int($args[$param])) {
 610                                                 $param_types .= 'i';
 611                                         } elseif (is_float($args[$param])) {
 612                                                 $param_types .= 'd';
 613                                         } elseif (is_string($args[$param])) {
 614                                                 $param_types .= 's';
 615                                         } else {
 616                                                 $param_types .= 'b';
 617                                         }
 618                                         $values[] = &$args[$param];
 619                                 }
 620
 621                                 if (count($values) > 0) {
 622                                         array_unshift($values, $param_types);
 623                                         call_user_func_array([$stmt, 'bind_param'], $values);
 624                                 }
 625
 626                                 if (!$stmt->execute()) {
 627                                         $this->error   = $this->connection->error;
 628                                         $this->errorno = $this->connection->errno;
 629                                         $retval        = false;
 630                                         $is_error      = true;
 631                                 } else {
 632                                         $stmt->store_result();
 633                                         $retval              = $stmt;
 634                                         $this->affected_rows = $retval->affected_rows;
 635                                 }
 636                                 break;
 637                 }
 638
 639                 // See issue https://github.com/friendica/friendica/issues/8572
 640                 // Ensure that we always get an error message on an error.
 641                 if ($is_error && empty($this->errorno)) {
 642                         $this->errorno = -1;
 643                 }
 644
 645                 if ($is_error && empty($this->error)) {
 646                         $this->error = 'Unknown database error';
 647                 }
 648
 649                 // We are having an own error logging in the function "e"
 650                 if (($this->errorno != 0) && !$called_from_e) {
 651                         // We have to preserve the error code, somewhere in the logging it get lost
 652                         $error   = $this->error;
 653                         $errorno = $this->errorno;
 654
 655                         if ($this->testmode) {
 656                                 throw new DatabaseException($error, $errorno, $this->replaceParameters($sql, $args));
 657                         }
 658
 659                         $this->logger->error('DB Error', [
 660                                 'code'      => $errorno,
 661                                 'error'     => $error,
 662                                 'callstack' => System::callstack(8),
 663                                 'params'    => $this->replaceParameters($sql, $args),
 664                         ]);
 665
 666                         // On a lost connection we try to reconnect - but only once.
 667                         if ($errorno == 2006) {
 668                                 if ($this->in_retrial || !$this->reconnect()) {
 669                                         // It doesn't make sense to continue when the database connection was lost
 670                                         if ($this->in_retrial) {
 671                                                 $this->logger->notice('Giving up retrial because of database error', [
 672                                                         'code'  => $errorno,
 673                                                         'error' => $error,
 674                                                 ]);
 675                                         } else {
 676                                                 $this->logger->notice('Couldn\'t reconnect after database error', [
 677                                                         'code'  => $errorno,
 678                                                         'error' => $error,
 679                                                 ]);
 680                                         }
 681                                         exit(1);
 682                                 } else {
 683                                         // We try it again
 684                                         $this->logger->notice('Reconnected after database error', [
 685                                                 'code'  => $errorno,
 686                                                 'error' => $error,
 687                                         ]);
 688                                         $this->in_retrial = true;
 689                                         $ret              = $this->p($sql, $args);
 690                                         $this->in_retrial = false;
 691                                         return $ret;
 692                                 }
 693                         }
 694
 695                         $this->error   = $error;
 696                         $this->errorno = $errorno;
 697                 }
 698
 699                 $this->profiler->stopRecording();
 700
 701                 if ($this->configCache->get('system', 'db_log')) {
 702                         $stamp2   = microtime(true);
 703                         $duration = (float)($stamp2 - $stamp1);
 704
 705                         if (($duration > $this->configCache->get('system', 'db_loglimit'))) {
 706                                 $duration  = round($duration, 3);
 707                                 $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
 708
 709                                 @file_put_contents($this->configCache->get('system', 'db_log'), DateTimeFormat::utcNow() . "\t" . $duration . "\t" .
 710                                                                                                 basename($backtrace[1]["file"]) . "\t" .
 711                                                                                                 $backtrace[1]["line"] . "\t" . $backtrace[2]["function"] . "\t" .
 712                                                                                                 substr($this->replaceParameters($sql, $args), 0, 4000) . "\n", FILE_APPEND);
 713                         }
 714                 }
 715                 return $retval;
 716         }
 717
 718         /**
 719          * Executes a prepared statement like UPDATE or INSERT that doesn't return data
 720          *
 721          * Please use DBA::delete, DBA::insert, DBA::update, ... instead
 722          *
 723          * @param string $sql SQL statement
 724          *
 725          * @return boolean Was the query successfull? False is returned only if an error occurred
 726          * @throws \Exception
 727          */
 728         public function e($sql)
 729         {
 730
 731                 $this->profiler->startRecording('database_write');
 732
 733                 $params = DBA::getParam(func_get_args());
 734
 735                 // In a case of a deadlock we are repeating the query 20 times
 736                 $timeout = 20;
 737
 738                 do {
 739                         $stmt = $this->p($sql, $params);
 740
 741                         if (is_bool($stmt)) {
 742                                 $retval = $stmt;
 743                         } elseif (is_object($stmt)) {
 744                                 $retval = true;
 745                         } else {
 746                                 $retval = false;
 747                         }
 748
 749                         $this->close($stmt);
 750
 751                 } while (($this->errorno == 1213) && (--$timeout > 0));
 752
 753                 if ($this->errorno != 0) {
 754                         // We have to preserve the error code, somewhere in the logging it get lost
 755                         $error   = $this->error;
 756                         $errorno = $this->errorno;
 757
 758                         if ($this->testmode) {
 759                                 throw new DatabaseException($error, $errorno, $this->replaceParameters($sql, $params));
 760                         }
 761
 762                         $this->logger->error('DB Error', [
 763                                 'code'      => $errorno,
 764                                 'error'     => $error,
 765                                 'callstack' => System::callstack(8),
 766                                 'params'    => $this->replaceParameters($sql, $params),
 767                         ]);
 768
 769                         // On a lost connection we simply quit.
 770                         // A reconnect like in $this->p could be dangerous with modifications
 771                         if ($errorno == 2006) {
 772                                 $this->logger->notice('Giving up because of database error', [
 773                                         'code'  => $errorno,
 774                                         'error' => $error,
 775                                 ]);
 776                                 exit(1);
 777                         }
 778
 779                         $this->error   = $error;
 780                         $this->errorno = $errorno;
 781                 }
 782
 783                 $this->profiler->stopRecording();
 784
 785                 return $retval;
 786         }
 787
 788         /**
 789          * Check if data exists
 790          *
 791          * @param string|array $table     Table name or array [schema => table]
 792          * @param array        $condition array of fields for condition
 793          *
 794          * @return boolean Are there rows for that condition?
 795          * @throws \Exception
 796          */
 797         public function exists($table, $condition)
 798         {
 799                 if (empty($table)) {
 800                         return false;
 801                 }
 802
 803                 $fields = [];
 804
 805                 if (empty($condition)) {
 806                         return DBStructure::existsTable($table);
 807                 }
 808
 809                 reset($condition);
 810                 $first_key = key($condition);
 811                 if (!is_int($first_key)) {
 812                         $fields = [$first_key];
 813                 }
 814
 815                 $stmt = $this->select($table, $fields, $condition, ['limit' => 1]);
 816
 817                 if (is_bool($stmt)) {
 818                         $retval = $stmt;
 819                 } else {
 820                         $retval = ($this->numRows($stmt) > 0);
 821                 }
 822
 823                 $this->close($stmt);
 824
 825                 return $retval;
 826         }
 827
 828         /**
 829          * Fetches the first row
 830          *
 831          * Please use DBA::selectFirst or DBA::exists whenever this is possible.
 832          *
 833          * Fetches the first row
 834          *
 835          * @param string $sql SQL statement
 836          *
 837          * @return array first row of query
 838          * @throws \Exception
 839          */
 840         public function fetchFirst($sql)
 841         {
 842                 $params = DBA::getParam(func_get_args());
 843
 844                 $stmt = $this->p($sql, $params);
 845
 846                 if (is_bool($stmt)) {
 847                         $retval = $stmt;
 848                 } else {
 849                         $retval = $this->fetch($stmt);
 850                 }
 851
 852                 $this->close($stmt);
 853
 854                 return $retval;
 855         }
 856
 857         /**
 858          * Returns the number of affected rows of the last statement
 859          *
 860          * @return int Number of rows
 861          */
 862         public function affectedRows()
 863         {
 864                 return $this->affected_rows;
 865         }
 866
 867         /**
 868          * Returns the number of columns of a statement
 869          *
 870          * @param object Statement object
 871          *
 872          * @return int Number of columns
 873          */
 874         public function columnCount($stmt)
 875         {
 876                 if (!is_object($stmt)) {
 877                         return 0;
 878                 }
 879                 switch ($this->driver) {
 880                         case self::PDO:
 881                                 return $stmt->columnCount();
 882                         case self::MYSQLI:
 883                                 return $stmt->field_count;
 884                 }
 885                 return 0;
 886         }
 887
 888         /**
 889          * Returns the number of rows of a statement
 890          *
 891          * @param PDOStatement|mysqli_result|mysqli_stmt Statement object
 892          *
 893          * @return int Number of rows
 894          */
 895         public function numRows($stmt)
 896         {
 897                 if (!is_object($stmt)) {
 898                         return 0;
 899                 }
 900                 switch ($this->driver) {
 901                         case self::PDO:
 902                                 return $stmt->rowCount();
 903                         case self::MYSQLI:
 904                                 return $stmt->num_rows;
 905                 }
 906                 return 0;
 907         }
 908
 909         /**
 910          * Fetch a single row
 911          *
 912          * @param PDOStatement|mysqli_stmt $stmt statement object
 913          *
 914          * @return array|false current row
 915          */
 916         public function fetch($stmt)
 917         {
 918                 $this->profiler->startRecording('database');
 919
 920                 $columns = [];
 921
 922                 if (!is_object($stmt)) {
 923                         return false;
 924                 }
 925
 926                 switch ($this->driver) {
 927                         case self::PDO:
 928                                 $columns = $stmt->fetch(PDO::FETCH_ASSOC);
 929                                 if (!empty($stmt->table) && is_array($columns)) {
 930                                         $columns = $this->castFields($stmt->table, $columns);
 931                                 }
 932                                 break;
 933                         case self::MYSQLI:
 934                                 if (get_class($stmt) == 'mysqli_result') {
 935                                         $columns = $stmt->fetch_assoc() ?? false;
 936                                         break;
 937                                 }
 938
 939                                 // This code works, but is slow
 940
 941                                 // Bind the result to a result array
 942                                 $cols = [];
 943
 944                                 $cols_num = [];
 945                                 for ($x = 0; $x < $stmt->field_count; $x++) {
 946                                         $cols[] = &$cols_num[$x];
 947                                 }
 948
 949                                 call_user_func_array([$stmt, 'bind_result'], $cols);
 950
 951                                 if (!$stmt->fetch()) {
 952                                         return false;
 953                                 }
 954
 955                                 // The slow part:
 956                                 // We need to get the field names for the array keys
 957                                 // It seems that there is no better way to do this.
 958                                 $result = $stmt->result_metadata();
 959                                 $fields = $result->fetch_fields();
 960
 961                                 foreach ($cols_num AS $param => $col) {
 962                                         $columns[$fields[$param]->name] = $col;
 963                                 }
 964                 }
 965
 966                 $this->profiler->stopRecording();
 967
 968                 return $columns;
 969         }
 970
 971         /**
 972          * Insert a row into a table
 973          *
 974          * @param string|array $table          Table name or array [schema => table]
 975          * @param array        $param          parameter array
 976          * @param int          $duplicate_mode What to do on a duplicated entry
 977          *
 978          * @return boolean was the insert successful?
 979          * @throws \Exception
 980          */
 981         public function insert($table, array $param, int $duplicate_mode = self::INSERT_DEFAULT)
 982         {
 983                 if (empty($table) || empty($param)) {
 984                         $this->logger->info('Table and fields have to be set');
 985                         return false;
 986                 }
 987
 988                 $param = $this->castFields($table, $param);
 989
 990                 $table_string = DBA::buildTableString($table);
 991
 992                 $fields_string = implode(', ', array_map([DBA::class, 'quoteIdentifier'], array_keys($param)));
 993
 994                 $values_string = substr(str_repeat("?, ", count($param)), 0, -2);
 995
 996                 $sql = "INSERT ";
 997
 998                 if ($duplicate_mode == self::INSERT_IGNORE) {
 999                         $sql .= "IGNORE ";
1000                 }
1001
1002                 $sql .= "INTO " . $table_string . " (" . $fields_string . ") VALUES (" . $values_string . ")";
1003
1004                 if ($duplicate_mode == self::INSERT_UPDATE) {
1005                         $fields_string = implode(' = ?, ', array_map([DBA::class, 'quoteIdentifier'], array_keys($param)));
1006
1007                         $sql .= " ON DUPLICATE KEY UPDATE " . $fields_string . " = ?";
1008
1009                         $values = array_values($param);
1010                         $param  = array_merge_recursive($values, $values);
1011                 }
1012
1013                 $result = $this->e($sql, $param);
1014                 if (!$result || ($duplicate_mode != self::INSERT_IGNORE)) {
1015                         return $result;
1016                 }
1017
1018                 return $this->affectedRows() != 0;
1019         }
1020
1021         /**
1022          * Inserts a row with the provided data in the provided table.
1023          * If the data corresponds to an existing row through a UNIQUE or PRIMARY index constraints, it updates the row instead.
1024          *
1025          * @param string|array $table Table name or array [schema => table]
1026          * @param array        $param parameter array
1027          *
1028          * @return boolean was the insert successful?
1029          * @throws \Exception
1030          */
1031         public function replace($table, array $param)
1032         {
1033                 if (empty($table) || empty($param)) {
1034                         $this->logger->info('Table and fields have to be set');
1035                         return false;
1036                 }
1037
1038                 $param = $this->castFields($table, $param);
1039
1040                 $table_string = DBA::buildTableString($table);
1041
1042                 $fields_string = implode(', ', array_map([DBA::class, 'quoteIdentifier'], array_keys($param)));
1043
1044                 $values_string = substr(str_repeat("?, ", count($param)), 0, -2);
1045
1046                 $sql = "REPLACE " . $table_string . " (" . $fields_string . ") VALUES (" . $values_string . ")";
1047
1048                 return $this->e($sql, $param);
1049         }
1050
1051         /**
1052          * Fetch the id of the last insert command
1053          *
1054          * @return integer Last inserted id
1055          */
1056         public function lastInsertId()
1057         {
1058                 switch ($this->driver) {
1059                         case self::PDO:
1060                                 $id = $this->connection->lastInsertId();
1061                                 break;
1062                         case self::MYSQLI:
1063                                 $id = $this->connection->insert_id;
1064                                 break;
1065                 }
1066                 return (int)$id;
1067         }
1068
1069         /**
1070          * Locks a table for exclusive write access
1071          *
1072          * This function can be extended in the future to accept a table array as well.
1073          *
1074          * @param string|array $table Table name or array [schema => table]
1075          *
1076          * @return boolean was the lock successful?
1077          * @throws \Exception
1078          */
1079         public function lock($table)
1080         {
1081                 // See here: https://dev.mysql.com/doc/refman/5.7/en/lock-tables-and-transactions.html
1082                 if ($this->driver == self::PDO) {
1083                         $this->e("SET autocommit=0");
1084                         $this->connection->setAttribute(PDO::ATTR_EMULATE_PREPARES, true);
1085                 } else {
1086                         $this->connection->autocommit(false);
1087                 }
1088
1089                 $success = $this->e("LOCK TABLES " . DBA::buildTableString($table) . " WRITE");
1090
1091                 if ($this->driver == self::PDO) {
1092                         $this->connection->setAttribute(PDO::ATTR_EMULATE_PREPARES, $this->pdo_emulate_prepares);
1093                 }
1094
1095                 if (!$success) {
1096                         if ($this->driver == self::PDO) {
1097                                 $this->e("SET autocommit=1");
1098                         } else {
1099                                 $this->connection->autocommit(true);
1100                         }
1101                 } else {
1102                         $this->in_transaction = true;
1103                 }
1104                 return $success;
1105         }
1106
1107         /**
1108          * Unlocks all locked tables
1109          *
1110          * @return boolean was the unlock successful?
1111          * @throws \Exception
1112          */
1113         public function unlock()
1114         {
1115                 // See here: https://dev.mysql.com/doc/refman/5.7/en/lock-tables-and-transactions.html
1116                 $this->performCommit();
1117
1118                 if ($this->driver == self::PDO) {
1119                         $this->connection->setAttribute(PDO::ATTR_EMULATE_PREPARES, true);
1120                 }
1121
1122                 $success = $this->e("UNLOCK TABLES");
1123
1124                 if ($this->driver == self::PDO) {
1125                         $this->connection->setAttribute(PDO::ATTR_EMULATE_PREPARES, $this->pdo_emulate_prepares);
1126                         $this->e("SET autocommit=1");
1127                 } else {
1128                         $this->connection->autocommit(true);
1129                 }
1130
1131                 $this->in_transaction = false;
1132                 return $success;
1133         }
1134
1135         /**
1136          * Starts a transaction
1137          *
1138          * @return boolean Was the command executed successfully?
1139          */
1140         public function transaction()
1141         {
1142                 if (!$this->performCommit()) {
1143                         return false;
1144                 }
1145
1146                 switch ($this->driver) {
1147                         case self::PDO:
1148                                 if (!$this->connection->inTransaction() && !$this->connection->beginTransaction()) {
1149                                         return false;
1150                                 }
1151                                 break;
1152
1153                         case self::MYSQLI:
1154                                 if (!$this->connection->begin_transaction()) {
1155                                         return false;
1156                                 }
1157                                 break;
1158                 }
1159
1160                 $this->in_transaction = true;
1161                 return true;
1162         }
1163
1164         protected function performCommit()
1165         {
1166                 switch ($this->driver) {
1167                         case self::PDO:
1168                                 if (!$this->connection->inTransaction()) {
1169                                         return true;
1170                                 }
1171
1172                                 return $this->connection->commit();
1173
1174                         case self::MYSQLI:
1175                                 return $this->connection->commit();
1176                 }
1177
1178                 return true;
1179         }
1180
1181         /**
1182          * Does a commit
1183          *
1184          * @return boolean Was the command executed successfully?
1185          */
1186         public function commit()
1187         {
1188                 if (!$this->performCommit()) {
1189                         return false;
1190                 }
1191                 $this->in_transaction = false;
1192                 return true;
1193         }
1194
1195         /**
1196          * Does a rollback
1197          *
1198          * @return boolean Was the command executed successfully?
1199          */
1200         public function rollback()
1201         {
1202                 $ret = false;
1203
1204                 switch ($this->driver) {
1205                         case self::PDO:
1206                                 if (!$this->connection->inTransaction()) {
1207                                         $ret = true;
1208                                         break;
1209                                 }
1210                                 $ret = $this->connection->rollBack();
1211                                 break;
1212
1213                         case self::MYSQLI:
1214                                 $ret = $this->connection->rollback();
1215                                 break;
1216                 }
1217                 $this->in_transaction = false;
1218                 return $ret;
1219         }
1220
1221         /**
1222          * Delete a row from a table
1223          *
1224          * @param string $table      Table name
1225          * @param array  $conditions Field condition(s)
1226          *
1227          * @return boolean was the delete successful?
1228          * @throws \Exception
1229          */
1230         public function delete($table, array $conditions)
1231         {
1232                 if (empty($table) || empty($conditions)) {
1233                         $this->logger->info('Table and conditions have to be set');
1234                         return false;
1235                 }
1236
1237                 $table_string = DBA::buildTableString($table);
1238
1239                 $condition_string = DBA::buildCondition($conditions);
1240
1241                 $sql = "DELETE FROM " . $table_string . " " . $condition_string;
1242                 $this->logger->debug($this->replaceParameters($sql, $conditions), ['callstack' => System::callstack(6)]);
1243                 return $this->e($sql, $conditions);
1244         }
1245
1246         /**
1247          * Updates rows
1248          *
1249          * Updates rows in the database. When $old_fields is set to an array,
1250          * the system will only do an update if the fields in that array changed.
1251          *
1252          * Attention:
1253          * Only the values in $old_fields are compared.
1254          * This is an intentional behaviour.
1255          *
1256          * Example:
1257          * We include the timestamp field in $fields but not in $old_fields.
1258          * Then the row will only get the new timestamp when the other fields had changed.
1259          *
1260          * When $old_fields is set to a boolean value the system will do this compare itself.
1261          * When $old_fields is set to "true" the system will do an insert if the row doesn't exists.
1262          *
1263          * Attention:
1264          * Only set $old_fields to a boolean value when you are sure that you will update a single row.
1265          * When you set $old_fields to "true" then $fields must contain all relevant fields!
1266          *
1267          * @param string|array  $table      Table name or array [schema => table]
1268          * @param array         $fields     contains the fields that are updated
1269          * @param array         $condition  condition array with the key values
1270          * @param array|boolean $old_fields array with the old field values that are about to be replaced (true = update on duplicate, false = don't update identical fields)
1271          *
1272          * @return boolean was the update successfull?
1273          * @throws \Exception
1274          */
1275         public function update($table, $fields, $condition, $old_fields = [])
1276         {
1277                 if (empty($table) || empty($fields) || empty($condition)) {
1278                         $this->logger->info('Table, fields and condition have to be set');
1279                         return false;
1280                 }
1281
1282                 if (is_bool($old_fields)) {
1283                         $do_insert = $old_fields;
1284
1285                         $old_fields = $this->selectFirst($table, [], $condition);
1286
1287                         if (is_bool($old_fields)) {
1288                                 if ($do_insert) {
1289                                         $values = array_merge($condition, $fields);
1290                                         return $this->replace($table, $values);
1291                                 }
1292                                 $old_fields = [];
1293                         }
1294                 }
1295
1296                 foreach ($old_fields AS $fieldname => $content) {
1297                         if (isset($fields[$fieldname]) && !is_null($content) && ($fields[$fieldname] == $content)) {
1298                                 unset($fields[$fieldname]);
1299                         }
1300                 }
1301
1302                 if (count($fields) == 0) {
1303                         return true;
1304                 }
1305
1306                 $fields = $this->castFields($table, $fields);
1307
1308                 $table_string = DBA::buildTableString($table);
1309
1310                 $condition_string = DBA::buildCondition($condition);
1311
1312                 $sql = "UPDATE " . $table_string . " SET "
1313                         . implode(" = ?, ", array_map([DBA::class, 'quoteIdentifier'], array_keys($fields))) . " = ?"
1314                         . $condition_string;
1315
1316                 // Combines the updated fields parameter values with the condition parameter values
1317                 $params  = array_merge(array_values($fields), $condition);
1318
1319                 return $this->e($sql, $params);
1320         }
1321
1322         /**
1323          * Retrieve a single record from a table and returns it in an associative array
1324          *
1325          * @param string|array $table
1326          * @param array        $fields
1327          * @param array        $condition
1328          * @param array        $params
1329          *
1330          * @return bool|array
1331          * @throws \Exception
1332          * @see   $this->select
1333          */
1334         public function selectFirst($table, array $fields = [], array $condition = [], $params = [])
1335         {
1336                 $params['limit'] = 1;
1337                 $result          = $this->select($table, $fields, $condition, $params);
1338
1339                 if (is_bool($result)) {
1340                         return $result;
1341                 } else {
1342                         $row = $this->fetch($result);
1343                         $this->close($result);
1344                         return $row;
1345                 }
1346         }
1347
1348         /**
1349          * Select rows from a table and fills an array with the data
1350          *
1351          * @param string|array $table     Table name or array [schema => table]
1352          * @param array        $fields    Array of selected fields, empty for all
1353          * @param array        $condition Array of fields for condition
1354          * @param array        $params    Array of several parameters
1355          *
1356          * @return array Data array
1357          * @throws \Exception
1358          * @see   self::select
1359          */
1360         public function selectToArray($table, array $fields = [], array $condition = [], array $params = [])
1361         {
1362                 return $this->toArray($this->select($table, $fields, $condition, $params));
1363         }
1364
1365         /**
1366          * Select rows from a table
1367          *
1368          *
1369          * Example:
1370          * $table = 'post';
1371          * or:
1372          * $table = ['schema' => 'table'];
1373          * @see DBA::buildTableString()
1374          *
1375          * $fields = ['id', 'uri', 'uid', 'network'];
1376          *
1377          * $condition = ['uid' => 1, 'network' => 'dspr', 'blocked' => true];
1378          * or:
1379          * $condition = ['`uid` = ? AND `network` IN (?, ?)', 1, 'dfrn', 'dspr'];
1380          * @see DBA::buildCondition()
1381          *
1382          * $params = ['order' => ['id', 'received' => true, 'created' => 'ASC'), 'limit' => 10];
1383          * @see DBA::buildParameter()
1384          *
1385          * $data = DBA::select($table, $fields, $condition, $params);
1386          *
1387          * @param string|array $table     Table name or array [schema => table]
1388          * @param array        $fields    Array of selected fields, empty for all
1389          * @param array        $condition Array of fields for condition
1390          * @param array        $params    Array of several parameters
1391          * @return boolean|object
1392          * @throws \Exception
1393          */
1394         public function select($table, array $fields = [], array $condition = [], array $params = [])
1395         {
1396                 if (empty($table)) {
1397                         return false;
1398                 }
1399
1400                 if (count($fields) > 0) {
1401                         $select_string = implode(', ', array_map([DBA::class, 'quoteIdentifier'], $fields));
1402                 } else {
1403                         $select_string = '*';
1404                 }
1405
1406                 $table_string = DBA::buildTableString($table);
1407
1408                 $condition_string = DBA::buildCondition($condition);
1409
1410                 $param_string = DBA::buildParameter($params);
1411
1412                 $sql = "SELECT " . $select_string . " FROM " . $table_string . $condition_string . $param_string;
1413
1414                 $result = $this->p($sql, $condition);
1415
1416                 if (($this->driver == self::PDO) && !empty($result) && is_string($table)) {
1417                         $result->table = $table;
1418                 }
1419
1420                 return $result;
1421         }
1422
1423         /**
1424          * Counts the rows from a table satisfying the provided condition
1425          *
1426          * @param string|array $table     Table name or array [schema => table]
1427          * @param array        $condition Array of fields for condition
1428          * @param array        $params    Array of several parameters
1429          *
1430          * @return int
1431          *
1432          * Example:
1433          * $table = "post";
1434          *
1435          * $condition = ["uid" => 1, "network" => 'dspr'];
1436          * or:
1437          * $condition = ["`uid` = ? AND `network` IN (?, ?)", 1, 'dfrn', 'dspr'];
1438          *
1439          * $count = DBA::count($table, $condition);
1440          * @throws \Exception
1441          */
1442         public function count($table, array $condition = [], array $params = [])
1443         {
1444                 if (empty($table)) {
1445                         return false;
1446                 }
1447
1448                 $table_string = DBA::buildTableString($table);
1449
1450                 $condition_string = DBA::buildCondition($condition);
1451
1452                 if (empty($params['expression'])) {
1453                         $expression = '*';
1454                 } elseif (!empty($params['distinct'])) {
1455                         $expression = "DISTINCT " . DBA::quoteIdentifier($params['expression']);
1456                 } else {
1457                         $expression = DBA::quoteIdentifier($params['expression']);
1458                 }
1459
1460                 $sql = "SELECT COUNT(" . $expression . ") AS `count` FROM " . $table_string . $condition_string;
1461
1462                 $row = $this->fetchFirst($sql, $condition);
1463
1464                 if (!isset($row['count'])) {
1465                         $this->logger->notice('Invalid count.', ['table' => $table, 'expression' => $expression, 'condition' => $condition_string, 'callstack' => System::callstack()]);
1466                         return 0;
1467                 } else {
1468                         // Ensure to always return either a "null" or a numeric value
1469                         return is_numeric($row['count']) ? (int)$row['count'] : $row['count'];
1470                 }
1471         }
1472
1473         /**
1474          * Fills an array with data from a query
1475          *
1476          * @param object $stmt     statement object
1477          * @param bool   $do_close Close database connection after last row
1478          * @param int    $count    maximum number of rows to be fetched
1479          *
1480          * @return array Data array
1481          */
1482         public function toArray($stmt, $do_close = true, int $count = 0)
1483         {
1484                 if (is_bool($stmt)) {
1485                         return [];
1486                 }
1487
1488                 $data = [];
1489                 while ($row = $this->fetch($stmt)) {
1490                         $data[] = $row;
1491                         if (($count != 0) && (count($data) == $count)) {
1492                                 return $data;
1493                         }
1494                 }
1495
1496                 if ($do_close) {
1497                         $this->close($stmt);
1498                 }
1499
1500                 return $data;
1501         }
1502
1503         /**
1504          * Cast field types according to the table definition
1505          *
1506          * @param string $table
1507          * @param array  $fields
1508          * @return array casted fields
1509          */
1510         public function castFields(string $table, array $fields) {
1511                 // When there is no data, we don't need to do something
1512                 if (empty($fields)) {
1513                         return $fields;
1514                 }
1515
1516                 // We only need to cast fields with PDO
1517                 if ($this->driver != self::PDO) {
1518                         return $fields;
1519                 }
1520
1521                 // We only need to cast when emulating the prepares
1522                 if (!$this->connection->getAttribute(PDO::ATTR_EMULATE_PREPARES)) {
1523                         return $fields;
1524                 }
1525
1526                 $types = [];
1527
1528                 $tables = DBStructure::definition('', false);
1529                 if (empty($tables[$table])) {
1530                         // When a matching table wasn't found we check if it is a view
1531                         $views = View::definition('', false);
1532                         if (empty($views[$table])) {
1533                                 return $fields;
1534                         }
1535
1536                         foreach(array_keys($fields) as $field) {
1537                                 if (!empty($views[$table]['fields'][$field])) {
1538                                         $viewdef = $views[$table]['fields'][$field];
1539                                         if (!empty($tables[$viewdef[0]]['fields'][$viewdef[1]]['type'])) {
1540                                                 $types[$field] = $tables[$viewdef[0]]['fields'][$viewdef[1]]['type'];
1541                                         }
1542                                 }
1543                         }
1544                 } else {
1545                         foreach ($tables[$table]['fields'] as $field => $definition) {
1546                                 $types[$field] = $definition['type'];
1547                         }
1548                 }
1549
1550                 foreach ($fields as $field => $content) {
1551                         if (is_null($content) || empty($types[$field])) {
1552                                 continue;
1553                         }
1554
1555                         if ((substr($types[$field], 0, 7) == 'tinyint') || (substr($types[$field], 0, 8) == 'smallint') ||
1556                                 (substr($types[$field], 0, 9) == 'mediumint') || (substr($types[$field], 0, 3) == 'int') ||
1557                                 (substr($types[$field], 0, 6) == 'bigint') || (substr($types[$field], 0, 7) == 'boolean')) {
1558                                 $fields[$field] = (int)$content;
1559                         }
1560                         if ((substr($types[$field], 0, 5) == 'float') || (substr($types[$field], 0, 6) == 'double')) {
1561                                 $fields[$field] = (float)$content;
1562                         }
1563                 }
1564
1565                 return $fields;
1566         }
1567
1568         /**
1569          * Returns the error number of the last query
1570          *
1571          * @return string Error number (0 if no error)
1572          */
1573         public function errorNo()
1574         {
1575                 return $this->errorno;
1576         }
1577
1578         /**
1579          * Returns the error message of the last query
1580          *
1581          * @return string Error message ('' if no error)
1582          */
1583         public function errorMessage()
1584         {
1585                 return $this->error;
1586         }
1587
1588         /**
1589          * Closes the current statement
1590          *
1591          * @param object $stmt statement object
1592          *
1593          * @return boolean was the close successful?
1594          */
1595         public function close($stmt)
1596         {
1597
1598                 $this->profiler->startRecording('database');
1599
1600                 if (!is_object($stmt)) {
1601                         return false;
1602                 }
1603
1604                 switch ($this->driver) {
1605                         case self::PDO:
1606                                 $ret = $stmt->closeCursor();
1607                                 break;
1608                         case self::MYSQLI:
1609                                 // MySQLi offers both a mysqli_stmt and a mysqli_result class.
1610                                 // We should be careful not to assume the object type of $stmt
1611                                 // because DBA::p() has been able to return both types.
1612                                 if ($stmt instanceof mysqli_stmt) {
1613                                         $stmt->free_result();
1614                                         $ret = $stmt->close();
1615                                 } elseif ($stmt instanceof mysqli_result) {
1616                                         $stmt->free();
1617                                         $ret = true;
1618                                 } else {
1619                                         $ret = false;
1620                                 }
1621                                 break;
1622                 }
1623
1624                 $this->profiler->stopRecording();
1625
1626                 return $ret;
1627         }
1628
1629         /**
1630          * Return a list of database processes
1631          *
1632          * @return array
1633          *      'list' => List of processes, separated in their different states
1634          *      'amount' => Number of concurrent database processes
1635          * @throws \Exception
1636          */
1637         public function processlist()
1638         {
1639                 $ret  = $this->p("SHOW PROCESSLIST");
1640                 $data = $this->toArray($ret);
1641
1642                 $processes = 0;
1643                 $states    = [];
1644                 foreach ($data as $process) {
1645                         $state = trim($process["State"]);
1646
1647                         // Filter out all non blocking processes
1648                         if (!in_array($state, ["", "init", "statistics", "updating"])) {
1649                                 ++$states[$state];
1650                                 ++$processes;
1651                         }
1652                 }
1653
1654                 $statelist = "";
1655                 foreach ($states as $state => $usage) {
1656                         if ($statelist != "") {
1657                                 $statelist .= ", ";
1658                         }
1659                         $statelist .= $state . ": " . $usage;
1660                 }
1661                 return (["list" => $statelist, "amount" => $processes]);
1662         }
1663
1664         /**
1665          * Fetch a database variable
1666          *
1667          * @param string $name
1668          * @return string content
1669          */
1670         public function getVariable(string $name)
1671         {
1672                 $result = $this->fetchFirst("SHOW GLOBAL VARIABLES WHERE `Variable_name` = ?", $name);
1673                 return $result['Value'] ?? null;
1674         }
1675
1676         /**
1677          * Checks if $array is a filled array with at least one entry.
1678          *
1679          * @param mixed $array A filled array with at least one entry
1680          *
1681          * @return boolean Whether $array is a filled array or an object with rows
1682          */
1683         public function isResult($array)
1684         {
1685                 // It could be a return value from an update statement
1686                 if (is_bool($array)) {
1687                         return $array;
1688                 }
1689
1690                 if (is_object($array)) {
1691                         return $this->numRows($array) > 0;
1692                 }
1693
1694                 return (is_array($array) && (count($array) > 0));
1695         }
1696
1697         /**
1698          * Callback function for "esc_array"
1699          *
1700          * @param mixed   $value         Array value
1701          * @param string  $key           Array key
1702          * @param boolean $add_quotation add quotation marks for string values
1703          *
1704          * @return void
1705          */
1706         private function escapeArrayCallback(&$value, $key, $add_quotation)
1707         {
1708                 if (!$add_quotation) {
1709                         if (is_bool($value)) {
1710                                 $value = ($value ? '1' : '0');
1711                         } else {
1712                                 $value = $this->escape($value);
1713                         }
1714                         return;
1715                 }
1716
1717                 if (is_bool($value)) {
1718                         $value = ($value ? 'true' : 'false');
1719                 } elseif (is_float($value) || is_integer($value)) {
1720                         $value = (string)$value;
1721                 } else {
1722                         $value = "'" . $this->escape($value) . "'";
1723                 }
1724         }
1725
1726         /**
1727          * Escapes a whole array
1728          *
1729          * @param mixed   $arr           Array with values to be escaped
1730          * @param boolean $add_quotation add quotation marks for string values
1731          *
1732          * @return void
1733          */
1734         public function escapeArray(&$arr, $add_quotation = false)
1735         {
1736                 array_walk($arr, [$this, 'escapeArrayCallback'], $add_quotation);
1737         }
1738 }