3 * @copyright Copyright (C) 2010-2021, the Friendica project
5 * @license GNU AGPL version 3 or any later version
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.
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.
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/>.
22 namespace Friendica\Database;
24 use Friendica\Core\Config\Cache\Cache;
25 use Friendica\Core\System;
26 use Friendica\Network\HTTPException\InternalServerErrorException;
27 use Friendica\Util\DateTimeFormat;
28 use Friendica\Util\Profiler;
35 use Psr\Log\LoggerInterface;
38 * This class is for the low level database stuff that does driver specific things.
43 const MYSQLI = 'mysqli';
45 const INSERT_DEFAULT = 0;
46 const INSERT_UPDATE = 1;
47 const INSERT_IGNORE = 2;
49 protected $connected = false;
54 protected $configCache;
60 * @var LoggerInterface
63 protected $server_info = '';
64 /** @var PDO|mysqli */
65 protected $connection;
67 protected $pdo_emulate_prepares = false;
68 private $error = false;
70 private $affected_rows = 0;
71 protected $in_transaction = false;
72 protected $in_retrial = false;
73 protected $testmode = false;
74 private $relation = [];
76 public function __construct(Cache $configCache, Profiler $profiler, LoggerInterface $logger)
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;
85 if ($this->isConnected()) {
86 // Loads DB_UPDATE_VERSION constant
87 DBStructure::definition($configCache->get('system', 'basepath'), false);
91 public function connect()
93 if (!is_null($this->connection) && $this->connected()) {
94 return $this->connected;
97 // Reset connected state
98 $this->connected = false;
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]);
108 if (!empty(trim($this->configCache->get('database', 'port')))) {
109 $port = trim($this->configCache->get('database', 'port'));
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'));
118 if (!(strlen($server) && strlen($user))) {
122 $persistent = (bool)$this->configCache->get('database', 'persistent');
124 $this->pdo_emulate_prepares = (bool)$this->configCache->get('database', 'pdo_emulate_prepares');
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;
131 $connect .= ";port=" . $port;
135 $connect .= ";charset=" . $charset;
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;
147 if (!$this->connected && class_exists('\mysqli')) {
148 $this->driver = self::MYSQLI;
151 $this->connection = @new mysqli($server, $user, $pass, $db, $port);
153 $this->connection = @new mysqli($server, $user, $pass, $db);
156 if (!mysqli_connect_errno()) {
157 $this->connected = true;
160 $this->connection->set_charset($charset);
165 // No suitable SQL driver was found.
166 if (!$this->connected) {
167 $this->driver = null;
168 $this->connection = null;
171 return $this->connected;
174 public function setTestmode(bool $test)
176 $this->testmode = $test;
179 * Sets the logger for DBA
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
186 * @param LoggerInterface $logger
188 public function setLogger(LoggerInterface $logger)
190 $this->logger = $logger;
194 * Sets the profiler for DBA
196 * @param Profiler $profiler
198 public function setProfiler(Profiler $profiler)
200 $this->profiler = $profiler;
203 * Disconnects the current database connection
205 public function disconnect()
207 if (!is_null($this->connection)) {
208 switch ($this->driver) {
210 $this->connection = null;
213 $this->connection->close();
214 $this->connection = null;
219 $this->driver = null;
220 $this->connected = false;
224 * Perform a reconnect of an existing database connection
226 public function reconnect()
229 return $this->connect();
233 * Return the database object.
237 public function getConnection()
239 return $this->connection;
243 * Return the database driver string
245 * @return string with either "pdo" or "mysqli"
247 public function getDriver()
249 return $this->driver;
253 * Returns the MySQL server version string
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
260 public function serverInfo()
262 if ($this->server_info == '') {
263 switch ($this->driver) {
265 $this->server_info = $this->connection->getAttribute(PDO::ATTR_SERVER_VERSION);
268 $this->server_info = $this->connection->server_info;
272 return $this->server_info;
276 * Returns the selected database name
281 public function databaseName()
283 $ret = $this->p("SELECT DATABASE() AS `db`");
284 $data = $this->toArray($ret);
285 return $data[0]['db'];
289 * Analyze a database query and log this if some conditions are met.
291 * @param string $query The database query that will be analyzed
295 private function logIndex($query)
298 if (!$this->configCache->get('system', 'db_log_index')) {
302 // Don't explain an explain statement
303 if (strtolower(substr($query, 0, 7)) == "explain") {
307 // Only do the explain on "select", "update" and "delete"
308 if (!in_array(strtolower(substr($query, 0, 6)), ["select", "update", "delete"])) {
312 $r = $this->p("EXPLAIN " . $query);
313 if (!$this->isResult($r)) {
317 $watchlist = explode(',', $this->configCache->get('system', 'db_log_index_watch'));
318 $denylist = explode(',', $this->configCache->get('system', 'db_log_index_denylist'));
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'))));
328 if ((intval($this->configCache->get('system', 'db_loglimit_index_high')) > 0) && ($row['rows'] >= intval($this->configCache->get('system', 'db_loglimit_index_high')))) {
332 if (in_array($row['key'], $denylist) || ($row['key'] == "")) {
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);
348 * Removes every not allowlisted character from the identifier string
350 * @param string $identifier
352 * @return string sanitized identifier
355 private function sanitizeIdentifier($identifier)
357 return preg_replace('/[^A-Za-z0-9_\-]+/', '', $identifier);
360 public function escape($str)
362 if ($this->connected) {
363 switch ($this->driver) {
365 return substr(@$this->connection->quote($str, PDO::PARAM_STR), 1, -1);
368 return @$this->connection->real_escape_string($str);
371 return str_replace("'", "\\'", $str);
375 public function isConnected()
377 return $this->connected;
380 public function connected()
384 if (is_null($this->connection)) {
388 switch ($this->driver) {
390 $r = $this->p("SELECT 1");
391 if ($this->isResult($r)) {
392 $row = $this->toArray($r);
393 $connected = ($row[0]['1'] == '1');
397 $connected = $this->connection->ping();
405 * Replaces ANY_VALUE() function by MIN() function,
406 * if the database server does not support ANY_VALUE().
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().
412 * @param string $sql An SQL string without the values
414 * @return string The input SQL string modified if necessary.
416 public function anyValueFallback($sql)
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);
427 * Replaces the ? placeholders with the parameters in the $args array
429 * @param string $sql SQL query
430 * @param array $args The parameters that are to replace the ? placeholders
432 * @return string The replaced SQL query
434 private function replaceParameters($sql, $args)
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])) {
443 $replace = "'" . $this->escape($args[$param]) . "'";
446 $pos = strpos($sql, '?', $offset);
447 if ($pos !== false) {
448 $sql = substr_replace($sql, $replace, $pos, 1);
450 $offset = $pos + strlen($replace);
456 * Executes a prepared statement that returns data
458 * @usage Example: $r = p("SELECT * FROM `post` WHERE `guid` = ?", $guid);
460 * Please only use it with complicated queries.
461 * For all regular queries please use DBA::select or DBA::exists
463 * @param string $sql SQL statement
465 * @return bool|object statement object or result object
468 public function p($sql)
471 $this->profiler->startRecording('database');
472 $stamp1 = microtime(true);
474 $params = DBA::getParam(func_get_args());
476 // Renumber the array keys to be sure that they fit
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;
484 $args[++$i] = $param;
487 if (!$this->connected) {
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()]);
496 $sql = DBA::cleanQuery($sql);
497 $sql = $this->anyValueFallback($sql);
501 if ($this->configCache->get('system', 'db_callstack') !== null) {
502 $sql = "/*" . System::callstack() . " */ " . $sql;
508 $this->affected_rows = 0;
510 // We have to make some things different if this function is called from "e"
511 $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2);
513 if (isset($trace[1])) {
514 $called_from = $trace[1];
516 // We use just something that is defined to avoid warnings
517 $called_from = $trace[0];
519 // We are having an own error logging in the function "e"
520 $called_from_e = ($called_from['function'] == 'e');
522 if (!isset($this->connection)) {
523 throw new InternalServerErrorException('The Connection is empty, although connected is set true.');
526 switch ($this->driver) {
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];
538 $this->affected_rows = $retval->rowCount();
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];
552 foreach (array_keys($args) as $param) {
553 $data_type = PDO::PARAM_STR;
554 if (is_int($args[$param])) {
555 $data_type = PDO::PARAM_INT;
556 } elseif ($args[$param] !== null) {
557 $args[$param] = (string)$args[$param];
560 $stmt->bindParam($param, $args[$param], $data_type);
563 if (!$stmt->execute()) {
564 $errorInfo = $stmt->errorInfo();
565 $this->error = $errorInfo[2];
566 $this->errorno = $errorInfo[1];
571 $this->affected_rows = $retval->rowCount();
575 // There are SQL statements that cannot be executed with a prepared statement
576 $parts = explode(' ', $orig_sql);
577 $command = strtolower($parts[0]);
578 $can_be_prepared = in_array($command, ['select', 'update', 'insert', 'delete']);
580 // The fallback routine is called as well when there are no arguments
581 if (!$can_be_prepared || (count($args) == 0)) {
582 $retval = $this->connection->query($this->replaceParameters($sql, $args));
583 if ($this->connection->errno) {
584 $this->error = $this->connection->error;
585 $this->errorno = $this->connection->errno;
589 if (isset($retval->num_rows)) {
590 $this->affected_rows = $retval->num_rows;
592 $this->affected_rows = $this->connection->affected_rows;
598 $stmt = $this->connection->stmt_init();
600 if (!$stmt->prepare($sql)) {
601 $this->error = $stmt->error;
602 $this->errorno = $stmt->errno;
610 foreach (array_keys($args) as $param) {
611 if (is_int($args[$param])) {
613 } elseif (is_float($args[$param])) {
615 } elseif (is_string($args[$param])) {
617 } elseif (is_object($args[$param]) && method_exists($args[$param], '__toString')) {
619 $args[$param] = (string)$args[$param];
623 $values[] = &$args[$param];
626 if (count($values) > 0) {
627 array_unshift($values, $param_types);
628 call_user_func_array([$stmt, 'bind_param'], $values);
631 if (!$stmt->execute()) {
632 $this->error = $this->connection->error;
633 $this->errorno = $this->connection->errno;
637 $stmt->store_result();
639 $this->affected_rows = $retval->affected_rows;
644 // See issue https://github.com/friendica/friendica/issues/8572
645 // Ensure that we always get an error message on an error.
646 if ($is_error && empty($this->errorno)) {
650 if ($is_error && empty($this->error)) {
651 $this->error = 'Unknown database error';
654 // We are having an own error logging in the function "e"
655 if (($this->errorno != 0) && !$called_from_e) {
656 // We have to preserve the error code, somewhere in the logging it get lost
657 $error = $this->error;
658 $errorno = $this->errorno;
660 if ($this->testmode) {
661 throw new DatabaseException($error, $errorno, $this->replaceParameters($sql, $args));
664 $this->logger->error('DB Error', [
667 'callstack' => System::callstack(8),
668 'params' => $this->replaceParameters($sql, $args),
671 // On a lost connection we try to reconnect - but only once.
672 if ($errorno == 2006) {
673 if ($this->in_retrial || !$this->reconnect()) {
674 // It doesn't make sense to continue when the database connection was lost
675 if ($this->in_retrial) {
676 $this->logger->notice('Giving up retrial because of database error', [
681 $this->logger->notice('Couldn\'t reconnect after database error', [
689 $this->logger->notice('Reconnected after database error', [
693 $this->in_retrial = true;
694 $ret = $this->p($sql, $args);
695 $this->in_retrial = false;
700 $this->error = $error;
701 $this->errorno = $errorno;
704 $this->profiler->stopRecording();
706 if ($this->configCache->get('system', 'db_log')) {
707 $stamp2 = microtime(true);
708 $duration = (float)($stamp2 - $stamp1);
710 if (($duration > $this->configCache->get('system', 'db_loglimit'))) {
711 $duration = round($duration, 3);
712 $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
714 @file_put_contents($this->configCache->get('system', 'db_log'), DateTimeFormat::utcNow() . "\t" . $duration . "\t" .
715 basename($backtrace[1]["file"]) . "\t" .
716 $backtrace[1]["line"] . "\t" . $backtrace[2]["function"] . "\t" .
717 substr($this->replaceParameters($sql, $args), 0, 4000) . "\n", FILE_APPEND);
724 * Executes a prepared statement like UPDATE or INSERT that doesn't return data
726 * Please use DBA::delete, DBA::insert, DBA::update, ... instead
728 * @param string $sql SQL statement
730 * @return boolean Was the query successfull? False is returned only if an error occurred
733 public function e($sql)
736 $this->profiler->startRecording('database_write');
738 $params = DBA::getParam(func_get_args());
740 // In a case of a deadlock we are repeating the query 20 times
744 $stmt = $this->p($sql, $params);
746 if (is_bool($stmt)) {
748 } elseif (is_object($stmt)) {
756 } while (($this->errorno == 1213) && (--$timeout > 0));
758 if ($this->errorno != 0) {
759 // We have to preserve the error code, somewhere in the logging it get lost
760 $error = $this->error;
761 $errorno = $this->errorno;
763 if ($this->testmode) {
764 throw new DatabaseException($error, $errorno, $this->replaceParameters($sql, $params));
767 $this->logger->error('DB Error', [
770 'callstack' => System::callstack(8),
771 'params' => $this->replaceParameters($sql, $params),
774 // On a lost connection we simply quit.
775 // A reconnect like in $this->p could be dangerous with modifications
776 if ($errorno == 2006) {
777 $this->logger->notice('Giving up because of database error', [
784 $this->error = $error;
785 $this->errorno = $errorno;
788 $this->profiler->stopRecording();
794 * Check if data exists
796 * @param string|array $table Table name or array [schema => table]
797 * @param array $condition array of fields for condition
799 * @return boolean Are there rows for that condition?
802 public function exists($table, $condition)
810 if (empty($condition)) {
811 return DBStructure::existsTable($table);
815 $first_key = key($condition);
816 if (!is_int($first_key)) {
817 $fields = [$first_key];
820 $stmt = $this->select($table, $fields, $condition, ['limit' => 1]);
822 if (is_bool($stmt)) {
825 $retval = ($this->numRows($stmt) > 0);
834 * Fetches the first row
836 * Please use DBA::selectFirst or DBA::exists whenever this is possible.
838 * Fetches the first row
840 * @param string $sql SQL statement
842 * @return array first row of query
845 public function fetchFirst($sql)
847 $params = DBA::getParam(func_get_args());
849 $stmt = $this->p($sql, $params);
851 if (is_bool($stmt)) {
854 $retval = $this->fetch($stmt);
863 * Returns the number of affected rows of the last statement
865 * @return int Number of rows
867 public function affectedRows()
869 return $this->affected_rows;
873 * Returns the number of columns of a statement
875 * @param object Statement object
877 * @return int Number of columns
879 public function columnCount($stmt)
881 if (!is_object($stmt)) {
884 switch ($this->driver) {
886 return $stmt->columnCount();
888 return $stmt->field_count;
894 * Returns the number of rows of a statement
896 * @param PDOStatement|mysqli_result|mysqli_stmt Statement object
898 * @return int Number of rows
900 public function numRows($stmt)
902 if (!is_object($stmt)) {
905 switch ($this->driver) {
907 return $stmt->rowCount();
909 return $stmt->num_rows;
917 * @param bool|PDOStatement|mysqli_stmt $stmt statement object
919 * @return array|false current row
921 public function fetch($stmt)
923 $this->profiler->startRecording('database');
927 if (!is_object($stmt)) {
931 switch ($this->driver) {
933 $columns = $stmt->fetch(PDO::FETCH_ASSOC);
934 if (!empty($stmt->table) && is_array($columns)) {
935 $columns = $this->castFields($stmt->table, $columns);
939 if (get_class($stmt) == 'mysqli_result') {
940 $columns = $stmt->fetch_assoc() ?? false;
944 // This code works, but is slow
946 // Bind the result to a result array
950 for ($x = 0; $x < $stmt->field_count; $x++) {
951 $cols[] = &$cols_num[$x];
954 call_user_func_array([$stmt, 'bind_result'], $cols);
956 if (!$stmt->fetch()) {
961 // We need to get the field names for the array keys
962 // It seems that there is no better way to do this.
963 $result = $stmt->result_metadata();
964 $fields = $result->fetch_fields();
966 foreach ($cols_num as $param => $col) {
967 $columns[$fields[$param]->name] = $col;
971 $this->profiler->stopRecording();
977 * Insert a row into a table. Field value objects will be cast as string.
979 * @param string|array $table Table name or array [schema => table]
980 * @param array $param parameter array
981 * @param int $duplicate_mode What to do on a duplicated entry
983 * @return boolean was the insert successful?
986 public function insert($table, array $param, int $duplicate_mode = self::INSERT_DEFAULT)
988 if (empty($table) || empty($param)) {
989 $this->logger->info('Table and fields have to be set');
993 $param = $this->castFields($table, $param);
995 $table_string = DBA::buildTableString($table);
997 $fields_string = implode(', ', array_map([DBA::class, 'quoteIdentifier'], array_keys($param)));
999 $values_string = substr(str_repeat("?, ", count($param)), 0, -2);
1003 if ($duplicate_mode == self::INSERT_IGNORE) {
1007 $sql .= "INTO " . $table_string . " (" . $fields_string . ") VALUES (" . $values_string . ")";
1009 if ($duplicate_mode == self::INSERT_UPDATE) {
1010 $fields_string = implode(' = ?, ', array_map([DBA::class, 'quoteIdentifier'], array_keys($param)));
1012 $sql .= " ON DUPLICATE KEY UPDATE " . $fields_string . " = ?";
1014 $values = array_values($param);
1015 $param = array_merge_recursive($values, $values);
1018 $result = $this->e($sql, $param);
1019 if (!$result || ($duplicate_mode != self::INSERT_IGNORE)) {
1023 return $this->affectedRows() != 0;
1027 * Inserts a row with the provided data in the provided table.
1028 * If the data corresponds to an existing row through a UNIQUE or PRIMARY index constraints, it updates the row instead.
1030 * @param string|array $table Table name or array [schema => table]
1031 * @param array $param parameter array
1033 * @return boolean was the insert successful?
1034 * @throws \Exception
1036 public function replace($table, array $param)
1038 if (empty($table) || empty($param)) {
1039 $this->logger->info('Table and fields have to be set');
1043 $param = $this->castFields($table, $param);
1045 $table_string = DBA::buildTableString($table);
1047 $fields_string = implode(', ', array_map([DBA::class, 'quoteIdentifier'], array_keys($param)));
1049 $values_string = substr(str_repeat("?, ", count($param)), 0, -2);
1051 $sql = "REPLACE " . $table_string . " (" . $fields_string . ") VALUES (" . $values_string . ")";
1053 return $this->e($sql, $param);
1057 * Fetch the id of the last insert command
1059 * @return integer Last inserted id
1061 public function lastInsertId()
1063 switch ($this->driver) {
1065 $id = $this->connection->lastInsertId();
1068 $id = $this->connection->insert_id;
1075 * Locks a table for exclusive write access
1077 * This function can be extended in the future to accept a table array as well.
1079 * @param string|array $table Table name or array [schema => table]
1081 * @return boolean was the lock successful?
1082 * @throws \Exception
1084 public function lock($table)
1086 // See here: https://dev.mysql.com/doc/refman/5.7/en/lock-tables-and-transactions.html
1087 if ($this->driver == self::PDO) {
1088 $this->e("SET autocommit=0");
1089 $this->connection->setAttribute(PDO::ATTR_EMULATE_PREPARES, true);
1091 $this->connection->autocommit(false);
1094 $success = $this->e("LOCK TABLES " . DBA::buildTableString($table) . " WRITE");
1096 if ($this->driver == self::PDO) {
1097 $this->connection->setAttribute(PDO::ATTR_EMULATE_PREPARES, $this->pdo_emulate_prepares);
1101 if ($this->driver == self::PDO) {
1102 $this->e("SET autocommit=1");
1104 $this->connection->autocommit(true);
1107 $this->in_transaction = true;
1113 * Unlocks all locked tables
1115 * @return boolean was the unlock successful?
1116 * @throws \Exception
1118 public function unlock()
1120 // See here: https://dev.mysql.com/doc/refman/5.7/en/lock-tables-and-transactions.html
1121 $this->performCommit();
1123 if ($this->driver == self::PDO) {
1124 $this->connection->setAttribute(PDO::ATTR_EMULATE_PREPARES, true);
1127 $success = $this->e("UNLOCK TABLES");
1129 if ($this->driver == self::PDO) {
1130 $this->connection->setAttribute(PDO::ATTR_EMULATE_PREPARES, $this->pdo_emulate_prepares);
1131 $this->e("SET autocommit=1");
1133 $this->connection->autocommit(true);
1136 $this->in_transaction = false;
1141 * Starts a transaction
1143 * @return boolean Was the command executed successfully?
1145 public function transaction()
1147 if (!$this->performCommit()) {
1151 switch ($this->driver) {
1153 if (!$this->connection->inTransaction() && !$this->connection->beginTransaction()) {
1159 if (!$this->connection->begin_transaction()) {
1165 $this->in_transaction = true;
1169 protected function performCommit()
1171 switch ($this->driver) {
1173 if (!$this->connection->inTransaction()) {
1177 return $this->connection->commit();
1180 return $this->connection->commit();
1189 * @return boolean Was the command executed successfully?
1191 public function commit()
1193 if (!$this->performCommit()) {
1196 $this->in_transaction = false;
1203 * @return boolean Was the command executed successfully?
1205 public function rollback()
1209 switch ($this->driver) {
1211 if (!$this->connection->inTransaction()) {
1215 $ret = $this->connection->rollBack();
1219 $ret = $this->connection->rollback();
1222 $this->in_transaction = false;
1227 * Delete a row from a table
1229 * @param string $table Table name
1230 * @param array $conditions Field condition(s)
1232 * @return boolean was the delete successful?
1233 * @throws \Exception
1235 public function delete($table, array $conditions)
1237 if (empty($table) || empty($conditions)) {
1238 $this->logger->info('Table and conditions have to be set');
1242 $table_string = DBA::buildTableString($table);
1244 $condition_string = DBA::buildCondition($conditions);
1246 $sql = "DELETE FROM " . $table_string . " " . $condition_string;
1247 $this->logger->debug($this->replaceParameters($sql, $conditions), ['callstack' => System::callstack(6)]);
1248 return $this->e($sql, $conditions);
1252 * Updates rows in the database. Field value objects will be cast as string.
1254 * When $old_fields is set to an array,
1255 * the system will only do an update if the fields in that array changed.
1258 * Only the values in $old_fields are compared.
1259 * This is an intentional behaviour.
1262 * We include the timestamp field in $fields but not in $old_fields.
1263 * Then the row will only get the new timestamp when the other fields had changed.
1265 * When $old_fields is set to a boolean value the system will do this compare itself.
1266 * When $old_fields is set to "true" the system will do an insert if the row doesn't exists.
1269 * Only set $old_fields to a boolean value when you are sure that you will update a single row.
1270 * When you set $old_fields to "true" then $fields must contain all relevant fields!
1272 * @param string|array $table Table name or array [schema => table]
1273 * @param array $fields contains the fields that are updated
1274 * @param array $condition condition array with the key values
1275 * @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)
1277 * @return boolean was the update successfull?
1278 * @throws \Exception
1280 public function update($table, $fields, $condition, $old_fields = [])
1282 if (empty($table) || empty($fields) || empty($condition)) {
1283 $this->logger->info('Table, fields and condition have to be set');
1287 if (is_bool($old_fields)) {
1288 $do_insert = $old_fields;
1290 $old_fields = $this->selectFirst($table, [], $condition);
1292 if (is_bool($old_fields)) {
1294 $values = array_merge($condition, $fields);
1295 return $this->replace($table, $values);
1301 foreach ($old_fields as $fieldname => $content) {
1302 if (isset($fields[$fieldname]) && !is_null($content) && ($fields[$fieldname] == $content)) {
1303 unset($fields[$fieldname]);
1307 if (count($fields) == 0) {
1311 $fields = $this->castFields($table, $fields);
1313 $table_string = DBA::buildTableString($table);
1315 $condition_string = DBA::buildCondition($condition);
1317 $sql = "UPDATE " . $table_string . " SET "
1318 . implode(" = ?, ", array_map([DBA::class, 'quoteIdentifier'], array_keys($fields))) . " = ?"
1319 . $condition_string;
1321 // Combines the updated fields parameter values with the condition parameter values
1322 $params = array_merge(array_values($fields), $condition);
1324 return $this->e($sql, $params);
1328 * Retrieve a single record from a table and returns it in an associative array
1330 * @param string|array $table
1331 * @param array $fields
1332 * @param array $condition
1333 * @param array $params
1335 * @return bool|array
1336 * @throws \Exception
1337 * @see $this->select
1339 public function selectFirst($table, array $fields = [], array $condition = [], $params = [])
1341 $params['limit'] = 1;
1342 $result = $this->select($table, $fields, $condition, $params);
1344 if (is_bool($result)) {
1347 $row = $this->fetch($result);
1348 $this->close($result);
1354 * Select rows from a table and fills an array with the data
1356 * @param string|array $table Table name or array [schema => table]
1357 * @param array $fields Array of selected fields, empty for all
1358 * @param array $condition Array of fields for condition
1359 * @param array $params Array of several parameters
1361 * @return array Data array
1362 * @throws \Exception
1365 public function selectToArray($table, array $fields = [], array $condition = [], array $params = [])
1367 return $this->toArray($this->select($table, $fields, $condition, $params));
1371 * Select rows from a table
1377 * $table = ['schema' => 'table'];
1378 * @see DBA::buildTableString()
1380 * $fields = ['id', 'uri', 'uid', 'network'];
1382 * $condition = ['uid' => 1, 'network' => 'dspr', 'blocked' => true];
1384 * $condition = ['`uid` = ? AND `network` IN (?, ?)', 1, 'dfrn', 'dspr'];
1385 * @see DBA::buildCondition()
1387 * $params = ['order' => ['id', 'received' => true, 'created' => 'ASC'), 'limit' => 10];
1388 * @see DBA::buildParameter()
1390 * $data = DBA::select($table, $fields, $condition, $params);
1392 * @param string|array $table Table name or array [schema => table]
1393 * @param array $fields Array of selected fields, empty for all
1394 * @param array $condition Array of fields for condition
1395 * @param array $params Array of several parameters
1396 * @return boolean|object
1397 * @throws \Exception
1399 public function select($table, array $fields = [], array $condition = [], array $params = [])
1401 if (empty($table)) {
1405 if (count($fields) > 0) {
1406 $select_string = implode(', ', array_map([DBA::class, 'quoteIdentifier'], $fields));
1408 $select_string = '*';
1411 $table_string = DBA::buildTableString($table);
1413 $condition_string = DBA::buildCondition($condition);
1415 $param_string = DBA::buildParameter($params);
1417 $sql = "SELECT " . $select_string . " FROM " . $table_string . $condition_string . $param_string;
1419 $result = $this->p($sql, $condition);
1421 if (($this->driver == self::PDO) && !empty($result) && is_string($table)) {
1422 $result->table = $table;
1429 * Counts the rows from a table satisfying the provided condition
1431 * @param string|array $table Table name or array [schema => table]
1432 * @param array $condition Array of fields for condition
1433 * @param array $params Array of several parameters
1440 * $condition = ["uid" => 1, "network" => 'dspr'];
1442 * $condition = ["`uid` = ? AND `network` IN (?, ?)", 1, 'dfrn', 'dspr'];
1444 * $count = DBA::count($table, $condition);
1445 * @throws \Exception
1447 public function count($table, array $condition = [], array $params = [])
1449 if (empty($table)) {
1453 $table_string = DBA::buildTableString($table);
1455 $condition_string = DBA::buildCondition($condition);
1457 if (empty($params['expression'])) {
1459 } elseif (!empty($params['distinct'])) {
1460 $expression = "DISTINCT " . DBA::quoteIdentifier($params['expression']);
1462 $expression = DBA::quoteIdentifier($params['expression']);
1465 $sql = "SELECT COUNT(" . $expression . ") AS `count` FROM " . $table_string . $condition_string;
1467 $row = $this->fetchFirst($sql, $condition);
1469 if (!isset($row['count'])) {
1470 $this->logger->notice('Invalid count.', ['table' => $table, 'row' => $row, 'expression' => $expression, 'condition' => $condition_string, 'callstack' => System::callstack()]);
1473 return (int)$row['count'];
1478 * Fills an array with data from a query
1480 * @param object $stmt statement object
1481 * @param bool $do_close Close database connection after last row
1482 * @param int $count maximum number of rows to be fetched
1484 * @return array Data array
1486 public function toArray($stmt, $do_close = true, int $count = 0)
1488 if (is_bool($stmt)) {
1493 while ($row = $this->fetch($stmt)) {
1495 if (($count != 0) && (count($data) == $count)) {
1501 $this->close($stmt);
1508 * Cast field types according to the table definition
1510 * @param string $table
1511 * @param array $fields
1512 * @return array casted fields
1514 public function castFields(string $table, array $fields) {
1515 // When there is no data, we don't need to do something
1516 if (empty($fields)) {
1520 // We only need to cast fields with PDO
1521 if ($this->driver != self::PDO) {
1525 // We only need to cast when emulating the prepares
1526 if (!$this->connection->getAttribute(PDO::ATTR_EMULATE_PREPARES)) {
1532 $tables = DBStructure::definition('', false);
1533 if (empty($tables[$table])) {
1534 // When a matching table wasn't found we check if it is a view
1535 $views = View::definition('', false);
1536 if (empty($views[$table])) {
1540 foreach(array_keys($fields) as $field) {
1541 if (!empty($views[$table]['fields'][$field])) {
1542 $viewdef = $views[$table]['fields'][$field];
1543 if (!empty($tables[$viewdef[0]]['fields'][$viewdef[1]]['type'])) {
1544 $types[$field] = $tables[$viewdef[0]]['fields'][$viewdef[1]]['type'];
1549 foreach ($tables[$table]['fields'] as $field => $definition) {
1550 $types[$field] = $definition['type'];
1554 foreach ($fields as $field => $content) {
1555 if (is_null($content) || empty($types[$field])) {
1559 if ((substr($types[$field], 0, 7) == 'tinyint') || (substr($types[$field], 0, 8) == 'smallint') ||
1560 (substr($types[$field], 0, 9) == 'mediumint') || (substr($types[$field], 0, 3) == 'int') ||
1561 (substr($types[$field], 0, 6) == 'bigint') || (substr($types[$field], 0, 7) == 'boolean')) {
1562 $fields[$field] = (int)$content;
1564 if ((substr($types[$field], 0, 5) == 'float') || (substr($types[$field], 0, 6) == 'double')) {
1565 $fields[$field] = (float)$content;
1573 * Returns the error number of the last query
1575 * @return string Error number (0 if no error)
1577 public function errorNo()
1579 return $this->errorno;
1583 * Returns the error message of the last query
1585 * @return string Error message ('' if no error)
1587 public function errorMessage()
1589 return $this->error;
1593 * Closes the current statement
1595 * @param object $stmt statement object
1597 * @return boolean was the close successful?
1599 public function close($stmt)
1602 $this->profiler->startRecording('database');
1604 if (!is_object($stmt)) {
1608 switch ($this->driver) {
1610 $ret = $stmt->closeCursor();
1613 // MySQLi offers both a mysqli_stmt and a mysqli_result class.
1614 // We should be careful not to assume the object type of $stmt
1615 // because DBA::p() has been able to return both types.
1616 if ($stmt instanceof mysqli_stmt) {
1617 $stmt->free_result();
1618 $ret = $stmt->close();
1619 } elseif ($stmt instanceof mysqli_result) {
1628 $this->profiler->stopRecording();
1634 * Return a list of database processes
1637 * 'list' => List of processes, separated in their different states
1638 * 'amount' => Number of concurrent database processes
1639 * @throws \Exception
1641 public function processlist()
1643 $ret = $this->p("SHOW PROCESSLIST");
1644 $data = $this->toArray($ret);
1648 foreach ($data as $process) {
1649 $state = trim($process["State"]);
1651 // Filter out all non blocking processes
1652 if (!in_array($state, ["", "init", "statistics", "updating"])) {
1659 foreach ($states as $state => $usage) {
1660 if ($statelist != "") {
1663 $statelist .= $state . ": " . $usage;
1665 return (["list" => $statelist, "amount" => $processes]);
1669 * Fetch a database variable
1671 * @param string $name
1672 * @return string content
1674 public function getVariable(string $name)
1676 $result = $this->fetchFirst("SHOW GLOBAL VARIABLES WHERE `Variable_name` = ?", $name);
1677 return $result['Value'] ?? null;
1681 * Checks if $array is a filled array with at least one entry.
1683 * @param mixed $array A filled array with at least one entry
1685 * @return boolean Whether $array is a filled array or an object with rows
1687 public function isResult($array)
1689 // It could be a return value from an update statement
1690 if (is_bool($array)) {
1694 if (is_object($array)) {
1695 return $this->numRows($array) > 0;
1698 return (is_array($array) && (count($array) > 0));
1702 * Callback function for "esc_array"
1704 * @param mixed $value Array value
1705 * @param string $key Array key
1706 * @param boolean $add_quotation add quotation marks for string values
1710 private function escapeArrayCallback(&$value, $key, $add_quotation)
1712 if (!$add_quotation) {
1713 if (is_bool($value)) {
1714 $value = ($value ? '1' : '0');
1716 $value = $this->escape($value);
1721 if (is_bool($value)) {
1722 $value = ($value ? 'true' : 'false');
1723 } elseif (is_float($value) || is_integer($value)) {
1724 $value = (string)$value;
1726 $value = "'" . $this->escape($value) . "'";
1731 * Escapes a whole array
1733 * @param mixed $arr Array with values to be escaped
1734 * @param boolean $add_quotation add quotation marks for string values
1738 public function escapeArray(&$arr, $add_quotation = false)
1740 array_walk($arr, [$this, 'escapeArrayCallback'], $add_quotation);