3 * @copyright Copyright (C) 2020, Friendica
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;
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 $emulate_prepares = false;
68 protected $pdo_emulate_prepares = false;
69 private $error = false;
71 private $affected_rows = 0;
72 protected $in_transaction = false;
73 protected $in_retrial = false;
74 protected $testmode = false;
75 private $relation = [];
77 public function __construct(Cache $configCache, Profiler $profiler, LoggerInterface $logger)
79 // We are storing these values for being able to perform a reconnect
80 $this->configCache = $configCache;
81 $this->profiler = $profiler;
82 $this->logger = $logger;
86 if ($this->isConnected()) {
87 // Loads DB_UPDATE_VERSION constant
88 DBStructure::definition($configCache->get('system', 'basepath'), false);
92 public function connect()
94 if (!is_null($this->connection) && $this->connected()) {
95 return $this->connected;
98 // Reset connected state
99 $this->connected = false;
102 $serveraddr = trim($this->configCache->get('database', 'hostname'));
103 $serverdata = explode(':', $serveraddr);
104 $server = $serverdata[0];
105 if (count($serverdata) > 1) {
106 $port = trim($serverdata[1]);
109 if (!empty(trim($this->configCache->get('database', 'port')))) {
110 $port = trim($this->configCache->get('database', 'port'));
113 $server = trim($server);
114 $user = trim($this->configCache->get('database', 'username'));
115 $pass = trim($this->configCache->get('database', 'password'));
116 $db = trim($this->configCache->get('database', 'database'));
117 $charset = trim($this->configCache->get('database', 'charset'));
119 if (!(strlen($server) && strlen($user))) {
123 $persistent = (bool)$this->configCache->get('database', 'persistent');
125 $this->emulate_prepares = (bool)$this->configCache->get('database', 'emulate_prepares');
126 $this->pdo_emulate_prepares = (bool)$this->configCache->get('database', 'pdo_emulate_prepares');
128 if (!$this->configCache->get('database', 'disable_pdo') && class_exists('\PDO') && in_array('mysql', PDO::getAvailableDrivers())) {
129 $this->driver = self::PDO;
130 $connect = "mysql:host=" . $server . ";dbname=" . $db;
133 $connect .= ";port=" . $port;
137 $connect .= ";charset=" . $charset;
141 $this->connection = @new PDO($connect, $user, $pass, [PDO::ATTR_PERSISTENT => $persistent]);
142 $this->connection->setAttribute(PDO::ATTR_EMULATE_PREPARES, $this->pdo_emulate_prepares);
143 $this->connected = true;
144 } catch (PDOException $e) {
145 $this->connected = false;
149 if (!$this->connected && class_exists('\mysqli')) {
150 $this->driver = self::MYSQLI;
153 $this->connection = @new mysqli($server, $user, $pass, $db, $port);
155 $this->connection = @new mysqli($server, $user, $pass, $db);
158 if (!mysqli_connect_errno()) {
159 $this->connected = true;
162 $this->connection->set_charset($charset);
167 // No suitable SQL driver was found.
168 if (!$this->connected) {
169 $this->driver = null;
170 $this->connection = null;
173 return $this->connected;
176 public function setTestmode(bool $test)
178 $this->testmode = $test;
181 * Sets the logger for DBA
183 * @note this is necessary because if we want to load the logger configuration
184 * from the DB, but there's an error, we would print out an exception.
185 * So the logger gets updated after the logger configuration can be retrieved
188 * @param LoggerInterface $logger
190 public function setLogger(LoggerInterface $logger)
192 $this->logger = $logger;
196 * Sets the profiler for DBA
198 * @param Profiler $profiler
200 public function setProfiler(Profiler $profiler)
202 $this->profiler = $profiler;
205 * Disconnects the current database connection
207 public function disconnect()
209 if (!is_null($this->connection)) {
210 switch ($this->driver) {
212 $this->connection = null;
215 $this->connection->close();
216 $this->connection = null;
221 $this->driver = null;
222 $this->connected = false;
226 * Perform a reconnect of an existing database connection
228 public function reconnect()
231 return $this->connect();
235 * Return the database object.
239 public function getConnection()
241 return $this->connection;
245 * Return the database driver string
247 * @return string with either "pdo" or "mysqli"
249 public function getDriver()
251 return $this->driver;
255 * Returns the MySQL server version string
257 * This function discriminate between the deprecated mysql API and the current
258 * object-oriented mysqli API. Example of returned string: 5.5.46-0+deb8u1
262 public function serverInfo()
264 if ($this->server_info == '') {
265 switch ($this->driver) {
267 $this->server_info = $this->connection->getAttribute(PDO::ATTR_SERVER_VERSION);
270 $this->server_info = $this->connection->server_info;
274 return $this->server_info;
278 * Returns the selected database name
283 public function databaseName()
285 $ret = $this->p("SELECT DATABASE() AS `db`");
286 $data = $this->toArray($ret);
287 return $data[0]['db'];
291 * Analyze a database query and log this if some conditions are met.
293 * @param string $query The database query that will be analyzed
297 private function logIndex($query)
300 if (!$this->configCache->get('system', 'db_log_index')) {
304 // Don't explain an explain statement
305 if (strtolower(substr($query, 0, 7)) == "explain") {
309 // Only do the explain on "select", "update" and "delete"
310 if (!in_array(strtolower(substr($query, 0, 6)), ["select", "update", "delete"])) {
314 $r = $this->p("EXPLAIN " . $query);
315 if (!$this->isResult($r)) {
319 $watchlist = explode(',', $this->configCache->get('system', 'db_log_index_watch'));
320 $denylist = explode(',', $this->configCache->get('system', 'db_log_index_denylist'));
322 while ($row = $this->fetch($r)) {
323 if ((intval($this->configCache->get('system', 'db_loglimit_index')) > 0)) {
324 $log = (in_array($row['key'], $watchlist) &&
325 ($row['rows'] >= intval($this->configCache->get('system', 'db_loglimit_index'))));
330 if ((intval($this->configCache->get('system', 'db_loglimit_index_high')) > 0) && ($row['rows'] >= intval($this->configCache->get('system', 'db_loglimit_index_high')))) {
334 if (in_array($row['key'], $denylist) || ($row['key'] == "")) {
339 $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
340 @file_put_contents($this->configCache->get('system', 'db_log_index'), DateTimeFormat::utcNow() . "\t" .
341 $row['key'] . "\t" . $row['rows'] . "\t" . $row['Extra'] . "\t" .
342 basename($backtrace[1]["file"]) . "\t" .
343 $backtrace[1]["line"] . "\t" . $backtrace[2]["function"] . "\t" .
344 substr($query, 0, 4000) . "\n", FILE_APPEND);
350 * Removes every not allowlisted character from the identifier string
352 * @param string $identifier
354 * @return string sanitized identifier
357 private function sanitizeIdentifier($identifier)
359 return preg_replace('/[^A-Za-z0-9_\-]+/', '', $identifier);
362 public function escape($str)
364 if ($this->connected) {
365 switch ($this->driver) {
367 return substr(@$this->connection->quote($str, PDO::PARAM_STR), 1, -1);
370 return @$this->connection->real_escape_string($str);
373 return str_replace("'", "\\'", $str);
377 public function isConnected()
379 return $this->connected;
382 public function connected()
386 if (is_null($this->connection)) {
390 switch ($this->driver) {
392 $r = $this->p("SELECT 1");
393 if ($this->isResult($r)) {
394 $row = $this->toArray($r);
395 $connected = ($row[0]['1'] == '1');
399 $connected = $this->connection->ping();
407 * Replaces ANY_VALUE() function by MIN() function,
408 * if the database server does not support ANY_VALUE().
410 * Considerations for Standard SQL, or MySQL with ONLY_FULL_GROUP_BY (default since 5.7.5).
411 * ANY_VALUE() is available from MySQL 5.7.5 https://dev.mysql.com/doc/refman/5.7/en/miscellaneous-functions.html
412 * A standard fall-back is to use MIN().
414 * @param string $sql An SQL string without the values
416 * @return string The input SQL string modified if necessary.
418 public function anyValueFallback($sql)
420 $server_info = $this->serverInfo();
421 if (version_compare($server_info, '5.7.5', '<') ||
422 (stripos($server_info, 'MariaDB') !== false)) {
423 $sql = str_ireplace('ANY_VALUE(', 'MIN(', $sql);
429 * Replaces the ? placeholders with the parameters in the $args array
431 * @param string $sql SQL query
432 * @param array $args The parameters that are to replace the ? placeholders
434 * @return string The replaced SQL query
436 private function replaceParameters($sql, $args)
439 foreach ($args AS $param => $value) {
440 if (is_int($args[$param]) || is_float($args[$param]) || is_bool($args[$param])) {
441 $replace = intval($args[$param]);
442 } elseif (is_null($args[$param])) {
445 $replace = "'" . $this->escape($args[$param]) . "'";
448 $pos = strpos($sql, '?', $offset);
449 if ($pos !== false) {
450 $sql = substr_replace($sql, $replace, $pos, 1);
452 $offset = $pos + strlen($replace);
458 * Executes a prepared statement that returns data
460 * @usage Example: $r = p("SELECT * FROM `item` WHERE `guid` = ?", $guid);
462 * Please only use it with complicated queries.
463 * For all regular queries please use DBA::select or DBA::exists
465 * @param string $sql SQL statement
467 * @return bool|object statement object or result object
470 public function p($sql)
473 $stamp1 = microtime(true);
475 $params = DBA::getParam(func_get_args());
477 // Renumber the array keys to be sure that they fit
480 foreach ($params AS $param) {
481 // Avoid problems with some MySQL servers and boolean values. See issue #3645
482 if (is_bool($param)) {
483 $param = (int)$param;
485 $args[++$i] = $param;
488 if (!$this->connected) {
492 if ((substr_count($sql, '?') != count($args)) && (count($args) > 0)) {
493 // Question: Should we continue or stop the query here?
494 $this->logger->warning('Query parameters mismatch.', ['query' => $sql, 'args' => $args, 'callstack' => System::callstack()]);
497 $sql = DBA::cleanQuery($sql);
498 $sql = $this->anyValueFallback($sql);
502 if ($this->configCache->get('system', 'db_callstack') !== null) {
503 $sql = "/*" . System::callstack() . " */ " . $sql;
509 $this->affected_rows = 0;
511 // We have to make some things different if this function is called from "e"
512 $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2);
514 if (isset($trace[1])) {
515 $called_from = $trace[1];
517 // We use just something that is defined to avoid warnings
518 $called_from = $trace[0];
520 // We are having an own error logging in the function "e"
521 $called_from_e = ($called_from['function'] == 'e');
523 if (!isset($this->connection)) {
524 throw new InternalServerErrorException('The Connection is empty, although connected is set true.');
527 switch ($this->driver) {
529 // If there are no arguments we use "query"
530 if ($this->emulate_prepares || count($args) == 0) {
531 if (!$retval = $this->connection->query($this->replaceParameters($sql, $args))) {
532 $errorInfo = $this->connection->errorInfo();
533 $this->error = $errorInfo[2];
534 $this->errorno = $errorInfo[1];
539 $this->affected_rows = $retval->rowCount();
543 /** @var $stmt mysqli_stmt|PDOStatement */
544 if (!$stmt = $this->connection->prepare($sql)) {
545 $errorInfo = $this->connection->errorInfo();
546 $this->error = $errorInfo[2];
547 $this->errorno = $errorInfo[1];
553 foreach ($args AS $param => $value) {
554 if (is_int($args[$param])) {
555 $data_type = PDO::PARAM_INT;
557 $data_type = PDO::PARAM_STR;
559 $stmt->bindParam($param, $args[$param], $data_type);
562 if (!$stmt->execute()) {
563 $errorInfo = $stmt->errorInfo();
564 $this->error = $errorInfo[2];
565 $this->errorno = $errorInfo[1];
570 $this->affected_rows = $retval->rowCount();
574 // There are SQL statements that cannot be executed with a prepared statement
575 $parts = explode(' ', $orig_sql);
576 $command = strtolower($parts[0]);
577 $can_be_prepared = in_array($command, ['select', 'update', 'insert', 'delete']);
579 // The fallback routine is called as well when there are no arguments
580 if ($this->emulate_prepares || !$can_be_prepared || (count($args) == 0)) {
581 $retval = $this->connection->query($this->replaceParameters($sql, $args));
582 if ($this->connection->errno) {
583 $this->error = $this->connection->error;
584 $this->errorno = $this->connection->errno;
588 if (isset($retval->num_rows)) {
589 $this->affected_rows = $retval->num_rows;
591 $this->affected_rows = $this->connection->affected_rows;
597 $stmt = $this->connection->stmt_init();
599 if (!$stmt->prepare($sql)) {
600 $this->error = $stmt->error;
601 $this->errorno = $stmt->errno;
609 foreach ($args AS $param => $value) {
610 if (is_int($args[$param])) {
612 } elseif (is_float($args[$param])) {
614 } elseif (is_string($args[$param])) {
619 $values[] = &$args[$param];
622 if (count($values) > 0) {
623 array_unshift($values, $param_types);
624 call_user_func_array([$stmt, 'bind_param'], $values);
627 if (!$stmt->execute()) {
628 $this->error = $this->connection->error;
629 $this->errorno = $this->connection->errno;
633 $stmt->store_result();
635 $this->affected_rows = $retval->affected_rows;
640 // See issue https://github.com/friendica/friendica/issues/8572
641 // Ensure that we always get an error message on an error.
642 if ($is_error && empty($this->errorno)) {
646 if ($is_error && empty($this->error)) {
647 $this->error = 'Unknown database error';
650 // We are having an own error logging in the function "e"
651 if (($this->errorno != 0) && !$called_from_e) {
652 // We have to preserve the error code, somewhere in the logging it get lost
653 $error = $this->error;
654 $errorno = $this->errorno;
656 if ($this->testmode) {
657 throw new DatabaseException($error, $errorno, $this->replaceParameters($sql, $args));
660 $this->logger->error('DB Error', [
663 'callstack' => System::callstack(8),
664 'params' => $this->replaceParameters($sql, $args),
667 // On a lost connection we try to reconnect - but only once.
668 if ($errorno == 2006) {
669 if ($this->in_retrial || !$this->reconnect()) {
670 // It doesn't make sense to continue when the database connection was lost
671 if ($this->in_retrial) {
672 $this->logger->notice('Giving up retrial because of database error', [
677 $this->logger->notice('Couldn\'t reconnect after database error', [
685 $this->logger->notice('Reconnected after database error', [
689 $this->in_retrial = true;
690 $ret = $this->p($sql, $args);
691 $this->in_retrial = false;
696 $this->error = $error;
697 $this->errorno = $errorno;
700 $this->profiler->saveTimestamp($stamp1, 'database');
702 if ($this->configCache->get('system', 'db_log')) {
703 $stamp2 = microtime(true);
704 $duration = (float)($stamp2 - $stamp1);
706 if (($duration > $this->configCache->get('system', 'db_loglimit'))) {
707 $duration = round($duration, 3);
708 $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
710 @file_put_contents($this->configCache->get('system', 'db_log'), DateTimeFormat::utcNow() . "\t" . $duration . "\t" .
711 basename($backtrace[1]["file"]) . "\t" .
712 $backtrace[1]["line"] . "\t" . $backtrace[2]["function"] . "\t" .
713 substr($this->replaceParameters($sql, $args), 0, 4000) . "\n", FILE_APPEND);
720 * Executes a prepared statement like UPDATE or INSERT that doesn't return data
722 * Please use DBA::delete, DBA::insert, DBA::update, ... instead
724 * @param string $sql SQL statement
726 * @return boolean Was the query successfull? False is returned only if an error occurred
729 public function e($sql)
732 $stamp = microtime(true);
734 $params = DBA::getParam(func_get_args());
736 // In a case of a deadlock we are repeating the query 20 times
740 $stmt = $this->p($sql, $params);
742 if (is_bool($stmt)) {
744 } elseif (is_object($stmt)) {
752 } while (($this->errorno == 1213) && (--$timeout > 0));
754 if ($this->errorno != 0) {
755 // We have to preserve the error code, somewhere in the logging it get lost
756 $error = $this->error;
757 $errorno = $this->errorno;
759 if ($this->testmode) {
760 throw new DatabaseException($error, $errorno, $this->replaceParameters($sql, $params));
763 $this->logger->error('DB Error', [
766 'callstack' => System::callstack(8),
767 'params' => $this->replaceParameters($sql, $params),
770 // On a lost connection we simply quit.
771 // A reconnect like in $this->p could be dangerous with modifications
772 if ($errorno == 2006) {
773 $this->logger->notice('Giving up because of database error', [
780 $this->error = $error;
781 $this->errorno = $errorno;
784 $this->profiler->saveTimestamp($stamp, "database_write");
790 * Check if data exists
792 * @param string|array $table Table name or array [schema => table]
793 * @param array $condition array of fields for condition
795 * @return boolean Are there rows for that condition?
798 public function exists($table, $condition)
806 if (empty($condition)) {
807 return DBStructure::existsTable($table);
811 $first_key = key($condition);
812 if (!is_int($first_key)) {
813 $fields = [$first_key];
816 $stmt = $this->select($table, $fields, $condition, ['limit' => 1]);
818 if (is_bool($stmt)) {
821 $retval = ($this->numRows($stmt) > 0);
830 * Fetches the first row
832 * Please use DBA::selectFirst or DBA::exists whenever this is possible.
834 * Fetches the first row
836 * @param string $sql SQL statement
838 * @return array first row of query
841 public function fetchFirst($sql)
843 $params = DBA::getParam(func_get_args());
845 $stmt = $this->p($sql, $params);
847 if (is_bool($stmt)) {
850 $retval = $this->fetch($stmt);
859 * Returns the number of affected rows of the last statement
861 * @return int Number of rows
863 public function affectedRows()
865 return $this->affected_rows;
869 * Returns the number of columns of a statement
871 * @param object Statement object
873 * @return int Number of columns
875 public function columnCount($stmt)
877 if (!is_object($stmt)) {
880 switch ($this->driver) {
882 return $stmt->columnCount();
884 return $stmt->field_count;
890 * Returns the number of rows of a statement
892 * @param PDOStatement|mysqli_result|mysqli_stmt Statement object
894 * @return int Number of rows
896 public function numRows($stmt)
898 if (!is_object($stmt)) {
901 switch ($this->driver) {
903 return $stmt->rowCount();
905 return $stmt->num_rows;
913 * @param PDOStatement|mysqli_stmt $stmt statement object
915 * @return array|false current row
917 public function fetch($stmt)
919 $stamp1 = microtime(true);
923 if (!is_object($stmt)) {
927 switch ($this->driver) {
929 $columns = $stmt->fetch(PDO::FETCH_ASSOC);
930 if (!empty($stmt->table) && is_array($columns)) {
931 $columns = $this->castFields($stmt->table, $columns);
935 if (get_class($stmt) == 'mysqli_result') {
936 $columns = $stmt->fetch_assoc() ?? false;
940 // This code works, but is slow
942 // Bind the result to a result array
946 for ($x = 0; $x < $stmt->field_count; $x++) {
947 $cols[] = &$cols_num[$x];
950 call_user_func_array([$stmt, 'bind_result'], $cols);
952 if (!$stmt->fetch()) {
957 // We need to get the field names for the array keys
958 // It seems that there is no better way to do this.
959 $result = $stmt->result_metadata();
960 $fields = $result->fetch_fields();
962 foreach ($cols_num AS $param => $col) {
963 $columns[$fields[$param]->name] = $col;
967 $this->profiler->saveTimestamp($stamp1, 'database');
973 * Insert a row into a table
975 * @param string|array $table Table name or array [schema => table]
976 * @param array $param parameter array
977 * @param int $duplicate_mode What to do on a duplicated entry
979 * @return boolean was the insert successful?
982 public function insert($table, array $param, int $duplicate_mode = self::INSERT_DEFAULT)
984 if (empty($table) || empty($param)) {
985 $this->logger->info('Table and fields have to be set');
989 $param = $this->castFields($table, $param);
991 $table_string = DBA::buildTableString($table);
993 $fields_string = implode(', ', array_map([DBA::class, 'quoteIdentifier'], array_keys($param)));
995 $values_string = substr(str_repeat("?, ", count($param)), 0, -2);
999 if ($duplicate_mode == self::INSERT_IGNORE) {
1003 $sql .= "INTO " . $table_string . " (" . $fields_string . ") VALUES (" . $values_string . ")";
1005 if ($duplicate_mode == self::INSERT_UPDATE) {
1006 $fields_string = implode(' = ?, ', array_map([DBA::class, 'quoteIdentifier'], array_keys($param)));
1008 $sql .= " ON DUPLICATE KEY UPDATE " . $fields_string . " = ?";
1010 $values = array_values($param);
1011 $param = array_merge_recursive($values, $values);
1014 $result = $this->e($sql, $param);
1015 if (!$result || ($duplicate_mode != self::INSERT_IGNORE)) {
1019 return $this->affectedRows() != 0;
1023 * Inserts a row with the provided data in the provided table.
1024 * If the data corresponds to an existing row through a UNIQUE or PRIMARY index constraints, it updates the row instead.
1026 * @param string|array $table Table name or array [schema => table]
1027 * @param array $param parameter array
1029 * @return boolean was the insert successful?
1030 * @throws \Exception
1032 public function replace($table, array $param)
1034 if (empty($table) || empty($param)) {
1035 $this->logger->info('Table and fields have to be set');
1039 $param = $this->castFields($table, $param);
1041 $table_string = DBA::buildTableString($table);
1043 $fields_string = implode(', ', array_map([DBA::class, 'quoteIdentifier'], array_keys($param)));
1045 $values_string = substr(str_repeat("?, ", count($param)), 0, -2);
1047 $sql = "REPLACE " . $table_string . " (" . $fields_string . ") VALUES (" . $values_string . ")";
1049 return $this->e($sql, $param);
1053 * Fetch the id of the last insert command
1055 * @return integer Last inserted id
1057 public function lastInsertId()
1059 switch ($this->driver) {
1061 $id = $this->connection->lastInsertId();
1064 $id = $this->connection->insert_id;
1071 * Locks a table for exclusive write access
1073 * This function can be extended in the future to accept a table array as well.
1075 * @param string|array $table Table name or array [schema => table]
1077 * @return boolean was the lock successful?
1078 * @throws \Exception
1080 public function lock($table)
1082 // See here: https://dev.mysql.com/doc/refman/5.7/en/lock-tables-and-transactions.html
1083 if ($this->driver == self::PDO) {
1084 $this->e("SET autocommit=0");
1085 $this->connection->setAttribute(PDO::ATTR_EMULATE_PREPARES, true);
1087 $this->connection->autocommit(false);
1090 $success = $this->e("LOCK TABLES " . DBA::buildTableString($table) . " WRITE");
1092 if ($this->driver == self::PDO) {
1093 $this->connection->setAttribute(PDO::ATTR_EMULATE_PREPARES, $this->pdo_emulate_prepares);
1097 if ($this->driver == self::PDO) {
1098 $this->e("SET autocommit=1");
1100 $this->connection->autocommit(true);
1103 $this->in_transaction = true;
1109 * Unlocks all locked tables
1111 * @return boolean was the unlock successful?
1112 * @throws \Exception
1114 public function unlock()
1116 // See here: https://dev.mysql.com/doc/refman/5.7/en/lock-tables-and-transactions.html
1117 $this->performCommit();
1119 if ($this->driver == self::PDO) {
1120 $this->connection->setAttribute(PDO::ATTR_EMULATE_PREPARES, true);
1123 $success = $this->e("UNLOCK TABLES");
1125 if ($this->driver == self::PDO) {
1126 $this->connection->setAttribute(PDO::ATTR_EMULATE_PREPARES, $this->pdo_emulate_prepares);
1127 $this->e("SET autocommit=1");
1129 $this->connection->autocommit(true);
1132 $this->in_transaction = false;
1137 * Starts a transaction
1139 * @return boolean Was the command executed successfully?
1141 public function transaction()
1143 if (!$this->performCommit()) {
1147 switch ($this->driver) {
1149 if (!$this->connection->inTransaction() && !$this->connection->beginTransaction()) {
1155 if (!$this->connection->begin_transaction()) {
1161 $this->in_transaction = true;
1165 protected function performCommit()
1167 switch ($this->driver) {
1169 if (!$this->connection->inTransaction()) {
1173 return $this->connection->commit();
1176 return $this->connection->commit();
1185 * @return boolean Was the command executed successfully?
1187 public function commit()
1189 if (!$this->performCommit()) {
1192 $this->in_transaction = false;
1199 * @return boolean Was the command executed successfully?
1201 public function rollback()
1205 switch ($this->driver) {
1207 if (!$this->connection->inTransaction()) {
1211 $ret = $this->connection->rollBack();
1215 $ret = $this->connection->rollback();
1218 $this->in_transaction = false;
1223 * Build the array with the table relations
1225 * The array is build from the database definitions in DBStructure.php
1227 * This process must only be started once, since the value is cached.
1229 private function buildRelationData()
1231 $definition = DBStructure::definition($this->configCache->get('system', 'basepath'));
1233 foreach ($definition AS $table => $structure) {
1234 foreach ($structure['fields'] AS $field => $field_struct) {
1235 if (isset($field_struct['relation'])) {
1236 foreach ($field_struct['relation'] AS $rel_table => $rel_field) {
1237 $this->relation[$rel_table][$rel_field][$table][] = $field;
1245 * Delete a row from a table
1247 * Note: this methods does NOT accept schema => table arrays because of the complex relation stuff.
1249 * @param string $table Table name
1250 * @param array $conditions Field condition(s)
1251 * @param array $options
1252 * - cascade: If true we delete records in other tables that depend on the one we're deleting through
1253 * relations (default: true)
1254 * @param array $callstack Internal use: prevent endless loops
1256 * @return boolean was the delete successful?
1257 * @throws \Exception
1259 public function delete($table, array $conditions, array $options = [], array &$callstack = [])
1261 if (empty($table) || empty($conditions)) {
1262 $this->logger->info('Table and conditions have to be set');
1268 // Create a key for the loop prevention
1269 $key = $table . ':' . json_encode($conditions);
1271 // We quit when this key already exists in the callstack.
1272 if (isset($callstack[$key])) {
1276 $callstack[$key] = true;
1278 $commands[$key] = ['table' => $table, 'conditions' => $conditions];
1280 // Don't use "defaults" here, since it would set "false" to "true"
1281 if (isset($options['cascade'])) {
1282 $cascade = $options['cascade'];
1287 // To speed up the whole process we cache the table relations
1288 if ($cascade && count($this->relation) == 0) {
1289 $this->buildRelationData();
1292 // Is there a relation entry for the table?
1293 if ($cascade && isset($this->relation[$table])) {
1294 // We only allow a simple "one field" relation.
1295 $field = array_keys($this->relation[$table])[0];
1296 $rel_def = array_values($this->relation[$table])[0];
1298 // Create a key for preventing double queries
1299 $qkey = $field . '-' . $table . ':' . json_encode($conditions);
1301 // When the search field is the relation field, we don't need to fetch the rows
1302 // This is useful when the leading record is already deleted in the frontend but the rest is done in the backend
1303 if ((count($conditions) == 1) && ($field == array_keys($conditions)[0])) {
1304 foreach ($rel_def AS $rel_table => $rel_fields) {
1305 foreach ($rel_fields AS $rel_field) {
1306 $this->delete($rel_table, [$rel_field => array_values($conditions)[0]], $options, $callstack);
1309 // We quit when this key already exists in the callstack.
1310 } elseif (!isset($callstack[$qkey])) {
1311 $callstack[$qkey] = true;
1313 // Fetch all rows that are to be deleted
1314 $data = $this->select($table, [$field], $conditions);
1316 while ($row = $this->fetch($data)) {
1317 $this->delete($table, [$field => $row[$field]], $options, $callstack);
1320 $this->close($data);
1322 // Since we had split the delete command we don't need the original command anymore
1323 unset($commands[$key]);
1327 // Now we finalize the process
1328 $do_transaction = !$this->in_transaction;
1330 if ($do_transaction) {
1331 $this->transaction();
1337 foreach ($commands AS $command) {
1338 $conditions = $command['conditions'];
1340 $first_key = key($conditions);
1342 $condition_string = DBA::buildCondition($conditions);
1344 if ((count($command['conditions']) > 1) || is_int($first_key)) {
1345 $sql = "DELETE FROM " . DBA::quoteIdentifier($command['table']) . " " . $condition_string;
1346 $this->logger->info($this->replaceParameters($sql, $conditions), ['callstack' => System::callstack(6), 'internal_callstack' => $callstack]);
1348 if (!$this->e($sql, $conditions)) {
1349 if ($do_transaction) {
1355 $key_table = $command['table'];
1356 $key_condition = array_keys($command['conditions'])[0];
1357 $value = array_values($command['conditions'])[0];
1359 // Split the SQL queries in chunks of 100 values
1360 // We do the $i stuff here to make the code better readable
1361 $i = isset($counter[$key_table][$key_condition]) ? $counter[$key_table][$key_condition] : 0;
1362 if (isset($compacted[$key_table][$key_condition][$i]) && count($compacted[$key_table][$key_condition][$i]) > 100) {
1366 $compacted[$key_table][$key_condition][$i][$value] = $value;
1367 $counter[$key_table][$key_condition] = $i;
1370 foreach ($compacted AS $table => $values) {
1371 foreach ($values AS $field => $field_value_list) {
1372 foreach ($field_value_list AS $field_values) {
1373 $sql = "DELETE FROM " . DBA::quoteIdentifier($table) . " WHERE " . DBA::quoteIdentifier($field) . " IN (" .
1374 substr(str_repeat("?, ", count($field_values)), 0, -2) . ");";
1376 $this->logger->info($this->replaceParameters($sql, $field_values), ['callstack' => System::callstack(6), 'internal_callstack' => $callstack]);
1378 if (!$this->e($sql, $field_values)) {
1379 if ($do_transaction) {
1387 if ($do_transaction) {
1396 * Updates rows in the database. When $old_fields is set to an array,
1397 * the system will only do an update if the fields in that array changed.
1400 * Only the values in $old_fields are compared.
1401 * This is an intentional behaviour.
1404 * We include the timestamp field in $fields but not in $old_fields.
1405 * Then the row will only get the new timestamp when the other fields had changed.
1407 * When $old_fields is set to a boolean value the system will do this compare itself.
1408 * When $old_fields is set to "true" the system will do an insert if the row doesn't exists.
1411 * Only set $old_fields to a boolean value when you are sure that you will update a single row.
1412 * When you set $old_fields to "true" then $fields must contain all relevant fields!
1414 * @param string|array $table Table name or array [schema => table]
1415 * @param array $fields contains the fields that are updated
1416 * @param array $condition condition array with the key values
1417 * @param array|boolean $old_fields array with the old field values that are about to be replaced (true = update on duplicate)
1419 * @return boolean was the update successfull?
1420 * @throws \Exception
1422 public function update($table, $fields, $condition, $old_fields = [])
1424 if (empty($table) || empty($fields) || empty($condition)) {
1425 $this->logger->info('Table, fields and condition have to be set');
1429 if (is_bool($old_fields)) {
1430 $do_insert = $old_fields;
1432 $old_fields = $this->selectFirst($table, [], $condition);
1434 if (is_bool($old_fields)) {
1436 $values = array_merge($condition, $fields);
1437 return $this->replace($table, $values);
1443 foreach ($old_fields AS $fieldname => $content) {
1444 if (isset($fields[$fieldname]) && !is_null($content) && ($fields[$fieldname] == $content)) {
1445 unset($fields[$fieldname]);
1449 if (count($fields) == 0) {
1453 $fields = $this->castFields($table, $fields);
1455 $table_string = DBA::buildTableString($table);
1457 $condition_string = DBA::buildCondition($condition);
1459 $sql = "UPDATE " . $table_string . " SET "
1460 . implode(" = ?, ", array_map([DBA::class, 'quoteIdentifier'], array_keys($fields))) . " = ?"
1461 . $condition_string;
1463 // Combines the updated fields parameter values with the condition parameter values
1464 $params = array_merge(array_values($fields), $condition);
1466 return $this->e($sql, $params);
1470 * Retrieve a single record from a table and returns it in an associative array
1472 * @param string|array $table
1473 * @param array $fields
1474 * @param array $condition
1475 * @param array $params
1477 * @return bool|array
1478 * @throws \Exception
1479 * @see $this->select
1481 public function selectFirst($table, array $fields = [], array $condition = [], $params = [])
1483 $params['limit'] = 1;
1484 $result = $this->select($table, $fields, $condition, $params);
1486 if (is_bool($result)) {
1489 $row = $this->fetch($result);
1490 $this->close($result);
1496 * Select rows from a table and fills an array with the data
1498 * @param string|array $table Table name or array [schema => table]
1499 * @param array $fields Array of selected fields, empty for all
1500 * @param array $condition Array of fields for condition
1501 * @param array $params Array of several parameters
1503 * @return array Data array
1504 * @throws \Exception
1507 public function selectToArray($table, array $fields = [], array $condition = [], array $params = [])
1509 return $this->toArray($this->select($table, $fields, $condition, $params));
1513 * Select rows from a table
1519 * $table = ['schema' => 'table'];
1520 * @see DBA::buildTableString()
1522 * $fields = ['id', 'uri', 'uid', 'network'];
1524 * $condition = ['uid' => 1, 'network' => 'dspr', 'blocked' => true];
1526 * $condition = ['`uid` = ? AND `network` IN (?, ?)', 1, 'dfrn', 'dspr'];
1527 * @see DBA::buildCondition()
1529 * $params = ['order' => ['id', 'received' => true, 'created' => 'ASC'), 'limit' => 10];
1530 * @see DBA::buildParameter()
1532 * $data = DBA::select($table, $fields, $condition, $params);
1534 * @param string|array $table Table name or array [schema => table]
1535 * @param array $fields Array of selected fields, empty for all
1536 * @param array $condition Array of fields for condition
1537 * @param array $params Array of several parameters
1538 * @return boolean|object
1539 * @throws \Exception
1541 public function select($table, array $fields = [], array $condition = [], array $params = [])
1543 if (empty($table)) {
1547 if (count($fields) > 0) {
1548 $select_string = implode(', ', array_map([DBA::class, 'quoteIdentifier'], $fields));
1550 $select_string = '*';
1553 $table_string = DBA::buildTableString($table);
1555 $condition_string = DBA::buildCondition($condition);
1557 $param_string = DBA::buildParameter($params);
1559 $sql = "SELECT " . $select_string . " FROM " . $table_string . $condition_string . $param_string;
1561 $result = $this->p($sql, $condition);
1563 if (($this->driver == self::PDO) && !empty($result) && is_string($table)) {
1564 $result->table = $table;
1571 * Counts the rows from a table satisfying the provided condition
1573 * @param string|array $table Table name or array [schema => table]
1574 * @param array $condition Array of fields for condition
1575 * @param array $params Array of several parameters
1582 * $condition = ["uid" => 1, "network" => 'dspr'];
1584 * $condition = ["`uid` = ? AND `network` IN (?, ?)", 1, 'dfrn', 'dspr'];
1586 * $count = DBA::count($table, $condition);
1587 * @throws \Exception
1589 public function count($table, array $condition = [], array $params = [])
1591 if (empty($table)) {
1595 $table_string = DBA::buildTableString($table);
1597 $condition_string = DBA::buildCondition($condition);
1599 if (empty($params['expression'])) {
1601 } elseif (!empty($params['distinct'])) {
1602 $expression = "DISTINCT " . DBA::quoteIdentifier($params['expression']);
1604 $expression = DBA::quoteIdentifier($params['expression']);
1607 $sql = "SELECT COUNT(" . $expression . ") AS `count` FROM " . $table_string . $condition_string;
1609 $row = $this->fetchFirst($sql, $condition);
1611 // Ensure to always return either a "null" or a numeric value
1612 return is_numeric($row['count']) ? (int)$row['count'] : $row['count'];
1616 * Fills an array with data from a query
1618 * @param object $stmt statement object
1619 * @param bool $do_close
1621 * @return array Data array
1623 public function toArray($stmt, $do_close = true)
1625 if (is_bool($stmt)) {
1630 while ($row = $this->fetch($stmt)) {
1635 $this->close($stmt);
1642 * Cast field types according to the table definition
1644 * @param string $table
1645 * @param array $fields
1646 * @return array casted fields
1648 public function castFields(string $table, array $fields) {
1649 // When there is no data, we don't need to do something
1650 if (empty($fields)) {
1654 // We only need to cast fields with PDO
1655 if ($this->driver != self::PDO) {
1659 // We only need to cast when emulating the prepares
1660 if (!$this->connection->getAttribute(PDO::ATTR_EMULATE_PREPARES)) {
1666 $tables = DBStructure::definition('', false);
1667 if (empty($tables[$table])) {
1668 // When a matching table wasn't found we check if it is a view
1669 $views = View::definition('', false);
1670 if (empty($views[$table])) {
1674 foreach(array_keys($fields) as $field) {
1675 if (!empty($views[$table]['fields'][$field])) {
1676 $viewdef = $views[$table]['fields'][$field];
1677 if (!empty($tables[$viewdef[0]]['fields'][$viewdef[1]]['type'])) {
1678 $types[$field] = $tables[$viewdef[0]]['fields'][$viewdef[1]]['type'];
1683 foreach ($tables[$table]['fields'] as $field => $definition) {
1684 $types[$field] = $definition['type'];
1688 foreach ($fields as $field => $content) {
1689 if (is_null($content) || empty($types[$field])) {
1693 if ((substr($types[$field], 0, 7) == 'tinyint') || (substr($types[$field], 0, 8) == 'smallint') ||
1694 (substr($types[$field], 0, 9) == 'mediumint') || (substr($types[$field], 0, 3) == 'int') ||
1695 (substr($types[$field], 0, 6) == 'bigint') || (substr($types[$field], 0, 7) == 'boolean')) {
1696 $fields[$field] = (int)$content;
1698 if ((substr($types[$field], 0, 5) == 'float') || (substr($types[$field], 0, 6) == 'double')) {
1699 $fields[$field] = (float)$content;
1707 * Returns the error number of the last query
1709 * @return string Error number (0 if no error)
1711 public function errorNo()
1713 return $this->errorno;
1717 * Returns the error message of the last query
1719 * @return string Error message ('' if no error)
1721 public function errorMessage()
1723 return $this->error;
1727 * Closes the current statement
1729 * @param object $stmt statement object
1731 * @return boolean was the close successful?
1733 public function close($stmt)
1736 $stamp1 = microtime(true);
1738 if (!is_object($stmt)) {
1742 switch ($this->driver) {
1744 $ret = $stmt->closeCursor();
1747 // MySQLi offers both a mysqli_stmt and a mysqli_result class.
1748 // We should be careful not to assume the object type of $stmt
1749 // because DBA::p() has been able to return both types.
1750 if ($stmt instanceof mysqli_stmt) {
1751 $stmt->free_result();
1752 $ret = $stmt->close();
1753 } elseif ($stmt instanceof mysqli_result) {
1762 $this->profiler->saveTimestamp($stamp1, 'database');
1768 * Return a list of database processes
1771 * 'list' => List of processes, separated in their different states
1772 * 'amount' => Number of concurrent database processes
1773 * @throws \Exception
1775 public function processlist()
1777 $ret = $this->p("SHOW PROCESSLIST");
1778 $data = $this->toArray($ret);
1782 foreach ($data as $process) {
1783 $state = trim($process["State"]);
1785 // Filter out all non blocking processes
1786 if (!in_array($state, ["", "init", "statistics", "updating"])) {
1793 foreach ($states as $state => $usage) {
1794 if ($statelist != "") {
1797 $statelist .= $state . ": " . $usage;
1799 return (["list" => $statelist, "amount" => $processes]);
1803 * Fetch a database variable
1805 * @param string $name
1806 * @return string content
1808 public function getVariable(string $name)
1810 $result = $this->fetchFirst("SHOW GLOBAL VARIABLES WHERE `Variable_name` = ?", $name);
1811 return $result['Value'] ?? null;
1815 * Checks if $array is a filled array with at least one entry.
1817 * @param mixed $array A filled array with at least one entry
1819 * @return boolean Whether $array is a filled array or an object with rows
1821 public function isResult($array)
1823 // It could be a return value from an update statement
1824 if (is_bool($array)) {
1828 if (is_object($array)) {
1829 return $this->numRows($array) > 0;
1832 return (is_array($array) && (count($array) > 0));
1836 * Callback function for "esc_array"
1838 * @param mixed $value Array value
1839 * @param string $key Array key
1840 * @param boolean $add_quotation add quotation marks for string values
1844 private function escapeArrayCallback(&$value, $key, $add_quotation)
1846 if (!$add_quotation) {
1847 if (is_bool($value)) {
1848 $value = ($value ? '1' : '0');
1850 $value = $this->escape($value);
1855 if (is_bool($value)) {
1856 $value = ($value ? 'true' : 'false');
1857 } elseif (is_float($value) || is_integer($value)) {
1858 $value = (string)$value;
1860 $value = "'" . $this->escape($value) . "'";
1865 * Escapes a whole array
1867 * @param mixed $arr Array with values to be escaped
1868 * @param boolean $add_quotation add quotation marks for string values
1872 public function escapeArray(&$arr, $add_quotation = false)
1874 array_walk($arr, [$this, 'escapeArrayCallback'], $add_quotation);