<?php
+/**
+ * @copyright Copyright (C) 2010-2023, the Friendica project
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
namespace Friendica\Database;
-use Friendica\Core\Config\Cache\IConfigCache;
-use Friendica\Core\System;
-use Friendica\Util\DateTimeFormat;
-use Friendica\Util\Profiler;
+use Friendica\DI;
use mysqli;
use mysqli_result;
use mysqli_stmt;
use PDO;
-use PDOException;
use PDOStatement;
-use Psr\Log\LoggerInterface;
/**
- * @class MySQL database class
- *
* This class is for the low level database stuff that does driver specific things.
*/
class DBA
*/
const NULL_DATETIME = '0001-01-01 00:00:00';
- public static $connected = false;
-
- /**
- * @var IConfigCache
- */
- private static $configCache;
- /**
- * @var Profiler
- */
- private static $profiler;
- /**
- * @var LoggerInterface
- */
- private static $logger;
- private static $server_info = '';
- private static $connection;
- private static $driver;
- private static $error = false;
- private static $errorno = 0;
- private static $affected_rows = 0;
- private static $in_transaction = false;
- private static $in_retrial = false;
- private static $relation = [];
- private static $db_serveraddr = '';
- private static $db_user = '';
- private static $db_pass = '';
- private static $db_name = '';
- private static $db_charset = '';
-
- public static function connect(IConfigCache $configCache, Profiler $profiler, LoggerInterface $logger, $serveraddr, $user, $pass, $db, $charset = null)
+ public static function connect(): bool
{
- if (!is_null(self::$connection) && self::connected()) {
- return true;
- }
-
- // We are storing these values for being able to perform a reconnect
- self::$configCache = $configCache;
- self::$profiler = $profiler;
- self::$logger = $logger;
- self::$db_serveraddr = $serveraddr;
- self::$db_user = $user;
- self::$db_pass = $pass;
- self::$db_name = $db;
- self::$db_charset = $charset;
-
- $port = 0;
- $serveraddr = trim($serveraddr);
-
- $serverdata = explode(':', $serveraddr);
- $server = $serverdata[0];
-
- if (count($serverdata) > 1) {
- $port = trim($serverdata[1]);
- }
-
- $server = trim($server);
- $user = trim($user);
- $pass = trim($pass);
- $db = trim($db);
- $charset = trim($charset);
-
- if (!(strlen($server) && strlen($user))) {
- return false;
- }
-
- if (class_exists('\PDO') && in_array('mysql', PDO::getAvailableDrivers())) {
- self::$driver = 'pdo';
- $connect = "mysql:host=".$server.";dbname=".$db;
-
- if ($port > 0) {
- $connect .= ";port=".$port;
- }
-
- if ($charset) {
- $connect .= ";charset=".$charset;
- }
-
- try {
- self::$connection = @new PDO($connect, $user, $pass);
- self::$connection->setAttribute(PDO::ATTR_EMULATE_PREPARES, false);
- self::$connected = true;
- } catch (PDOException $e) {
- /// @TODO At least log exception, don't ignore it!
- }
- }
-
- if (!self::$connected && class_exists('\mysqli')) {
- self::$driver = 'mysqli';
-
- if ($port > 0) {
- self::$connection = @new mysqli($server, $user, $pass, $db, $port);
- } else {
- self::$connection = @new mysqli($server, $user, $pass, $db);
- }
-
- if (!mysqli_connect_errno()) {
- self::$connected = true;
-
- if ($charset) {
- self::$connection->set_charset($charset);
- }
- }
- }
-
- // No suitable SQL driver was found.
- if (!self::$connected) {
- self::$driver = null;
- self::$connection = null;
- }
-
- return self::$connected;
- }
-
- /**
- * Sets the logger for DBA
- *
- * @note this is necessary because if we want to load the logger configuration
- * from the DB, but there's an error, we would print out an exception.
- * So the logger gets updated after the logger configuration can be retrieved
- * from the database
- *
- * @param LoggerInterface $logger
- */
- public static function setLogger(LoggerInterface $logger)
- {
- self::$logger = $logger;
+ return DI::dba()->connect();
}
/**
*/
public static function disconnect()
{
- if (is_null(self::$connection)) {
- return;
- }
-
- switch (self::$driver) {
- case 'pdo':
- self::$connection = null;
- break;
- case 'mysqli':
- self::$connection->close();
- self::$connection = null;
- break;
- }
+ DI::dba()->disconnect();
}
/**
* Perform a reconnect of an existing database connection
*/
- public static function reconnect() {
- self::disconnect();
-
- $ret = self::connect(self::$configCache, self::$profiler, self::$logger, self::$db_serveraddr, self::$db_user, self::$db_pass, self::$db_name, self::$db_charset);
- return $ret;
+ public static function reconnect(): bool
+ {
+ return DI::dba()->reconnect();
}
/**
*/
public static function getConnection()
{
- return self::$connection;
+ return DI::dba()->getConnection();
}
/**
- * @brief Returns the MySQL server version string
+ * Return the database driver string
+ *
+ * @return string with either "pdo" or "mysqli"
+ */
+ public static function getDriver(): string
+ {
+ return DI::dba()->getDriver();
+ }
+
+ /**
+ * Returns the MySQL server version string
*
* This function discriminate between the deprecated mysql API and the current
* object-oriented mysqli API. Example of returned string: 5.5.46-0+deb8u1
*
* @return string
*/
- public static function serverInfo() {
- if (self::$server_info == '') {
- switch (self::$driver) {
- case 'pdo':
- self::$server_info = self::$connection->getAttribute(PDO::ATTR_SERVER_VERSION);
- break;
- case 'mysqli':
- self::$server_info = self::$connection->server_info;
- break;
- }
- }
- return self::$server_info;
+ public static function serverInfo(): string
+ {
+ return DI::dba()->serverInfo();
}
/**
- * @brief Returns the selected database name
+ * Returns the selected database name
*
* @return string
* @throws \Exception
*/
- public static function databaseName() {
- $ret = self::p("SELECT DATABASE() AS `db`");
- $data = self::toArray($ret);
- return $data[0]['db'];
+ public static function databaseName(): string
+ {
+ return DI::dba()->databaseName();
}
/**
- * @brief Analyze a database query and log this if some conditions are met.
+ * Escape all SQL unsafe data
*
- * @param string $query The database query that will be analyzed
- * @throws \Exception
+ * @param string $str
+ * @return string escaped string
*/
- private static function logIndex($query) {
-
- if (!self::$configCache->get('system', 'db_log_index')) {
- return;
- }
-
- // Don't explain an explain statement
- if (strtolower(substr($query, 0, 7)) == "explain") {
- return;
- }
-
- // Only do the explain on "select", "update" and "delete"
- if (!in_array(strtolower(substr($query, 0, 6)), ["select", "update", "delete"])) {
- return;
- }
-
- $r = self::p("EXPLAIN ".$query);
- if (!self::isResult($r)) {
- return;
- }
-
- $watchlist = explode(',', self::$configCache->get('system', 'db_log_index_watch'));
- $blacklist = explode(',', self::$configCache->get('system', 'db_log_index_blacklist'));
-
- while ($row = self::fetch($r)) {
- if ((intval(self::$configCache->get('system', 'db_loglimit_index')) > 0)) {
- $log = (in_array($row['key'], $watchlist) &&
- ($row['rows'] >= intval(self::$configCache->get('system', 'db_loglimit_index'))));
- } else {
- $log = false;
- }
-
- if ((intval(self::$configCache->get('system', 'db_loglimit_index_high')) > 0) && ($row['rows'] >= intval(self::$configCache->get('system', 'db_loglimit_index_high')))) {
- $log = true;
- }
-
- if (in_array($row['key'], $blacklist) || ($row['key'] == "")) {
- $log = false;
- }
-
- if ($log) {
- $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
- @file_put_contents(self::$configCache->get('system', 'db_log_index'), DateTimeFormat::utcNow()."\t".
- $row['key']."\t".$row['rows']."\t".$row['Extra']."\t".
- basename($backtrace[1]["file"])."\t".
- $backtrace[1]["line"]."\t".$backtrace[2]["function"]."\t".
- substr($query, 0, 2000)."\n", FILE_APPEND);
- }
- }
- }
-
- public static function escape($str) {
- if (self::$connected) {
- switch (self::$driver) {
- case 'pdo':
- return substr(@self::$connection->quote($str, PDO::PARAM_STR), 1, -1);
-
- case 'mysqli':
- return @self::$connection->real_escape_string($str);
- }
- } else {
- return str_replace("'", "\\'", $str);
- }
+ public static function escape(string $str): string
+ {
+ return DI::dba()->escape($str);
}
- public static function connected() {
- $connected = false;
-
- if (is_null(self::$connection)) {
- return false;
- }
-
- switch (self::$driver) {
- case 'pdo':
- $r = self::p("SELECT 1");
- if (self::isResult($r)) {
- $row = self::toArray($r);
- $connected = ($row[0]['1'] == '1');
- }
- break;
- case 'mysqli':
- $connected = self::$connection->ping();
- break;
- }
- return $connected;
+ /**
+ * Checks if the database is connected
+ *
+ * @return boolean is the database connected?
+ */
+ public static function connected(): bool
+ {
+ return DI::dba()->connected();
}
/**
- * @brief Replaces ANY_VALUE() function by MIN() function,
- * if the database server does not support ANY_VALUE().
+ * Replaces ANY_VALUE() function by MIN() function,
+ * if the database server does not support ANY_VALUE().
*
* Considerations for Standard SQL, or MySQL with ONLY_FULL_GROUP_BY (default since 5.7.5).
* ANY_VALUE() is available from MySQL 5.7.5 https://dev.mysql.com/doc/refman/5.7/en/miscellaneous-functions.html
* @param string $sql An SQL string without the values
* @return string The input SQL string modified if necessary.
*/
- public static function anyValueFallback($sql) {
- $server_info = self::serverInfo();
- if (version_compare($server_info, '5.7.5', '<') ||
- (stripos($server_info, 'MariaDB') !== false)) {
- $sql = str_ireplace('ANY_VALUE(', 'MIN(', $sql);
- }
- return $sql;
+ public static function anyValueFallback(string $sql): string
+ {
+ return DI::dba()->anyValueFallback($sql);
}
/**
- * @brief beautifies the query - useful for "SHOW PROCESSLIST"
+ * beautifies the query - useful for "SHOW PROCESSLIST"
*
* This is safe when we bind the parameters later.
* The parameter values aren't part of the SQL.
* @param string $sql An SQL string without the values
* @return string The input SQL string modified if necessary.
*/
- public static function cleanQuery($sql) {
+ public static function cleanQuery(string $sql): string
+ {
$search = ["\t", "\n", "\r", " "];
$replace = [' ', ' ', ' ', ' '];
do {
return $sql;
}
-
/**
- * @brief Replaces the ? placeholders with the parameters in the $args array
- *
- * @param string $sql SQL query
- * @param array $args The parameters that are to replace the ? placeholders
- * @return string The replaced SQL query
- */
- private static function replaceParameters($sql, $args) {
- $offset = 0;
- foreach ($args AS $param => $value) {
- if (is_int($args[$param]) || is_float($args[$param])) {
- $replace = intval($args[$param]);
- } else {
- $replace = "'".self::escape($args[$param])."'";
- }
-
- $pos = strpos($sql, '?', $offset);
- if ($pos !== false) {
- $sql = substr_replace($sql, $replace, $pos, 1);
- }
- $offset = $pos + strlen($replace);
- }
- return $sql;
- }
-
- /**
- * @brief Convert parameter array to an universal form
+ * Convert parameter array to an universal form
* @param array $args Parameter array
* @return array universalized parameter array
*/
- private static function getParam($args) {
+ public static function getParam(array $args): array
+ {
unset($args[0]);
// When the second function parameter is an array then use this as the parameter array
}
/**
- * @brief Executes a prepared statement that returns data
- * @usage Example: $r = p("SELECT * FROM `item` WHERE `guid` = ?", $guid);
+ * Executes a prepared statement that returns data
+ * Example: $r = p("SELECT * FROM `post` WHERE `guid` = ?", $guid);
*
* Please only use it with complicated queries.
* For all regular queries please use DBA::select or DBA::exists
* @return bool|object statement object or result object
* @throws \Exception
*/
- public static function p($sql) {
-
- $stamp1 = microtime(true);
-
+ public static function p(string $sql)
+ {
$params = self::getParam(func_get_args());
- // Renumber the array keys to be sure that they fit
- $i = 0;
- $args = [];
- foreach ($params AS $param) {
- // Avoid problems with some MySQL servers and boolean values. See issue #3645
- if (is_bool($param)) {
- $param = (int)$param;
- }
- $args[++$i] = $param;
- }
-
- if (!self::$connected) {
- return false;
- }
-
- if ((substr_count($sql, '?') != count($args)) && (count($args) > 0)) {
- // Question: Should we continue or stop the query here?
- self::$logger->warning('Query parameters mismatch.', ['query' => $sql, 'args' => $args, 'callstack' => System::callstack()]);
- }
-
- $sql = self::cleanQuery($sql);
- $sql = self::anyValueFallback($sql);
-
- $orig_sql = $sql;
-
- if (self::$configCache->get('system', 'db_callstack') !== null) {
- $sql = "/*".System::callstack()." */ ".$sql;
- }
-
- self::$error = '';
- self::$errorno = 0;
- self::$affected_rows = 0;
-
- // We have to make some things different if this function is called from "e"
- $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2);
-
- if (isset($trace[1])) {
- $called_from = $trace[1];
- } else {
- // We use just something that is defined to avoid warnings
- $called_from = $trace[0];
- }
- // We are having an own error logging in the function "e"
- $called_from_e = ($called_from['function'] == 'e');
-
- switch (self::$driver) {
- case 'pdo':
- // If there are no arguments we use "query"
- if (count($args) == 0) {
- if (!$retval = self::$connection->query($sql)) {
- $errorInfo = self::$connection->errorInfo();
- self::$error = $errorInfo[2];
- self::$errorno = $errorInfo[1];
- $retval = false;
- break;
- }
- self::$affected_rows = $retval->rowCount();
- break;
- }
-
- if (!$stmt = self::$connection->prepare($sql)) {
- $errorInfo = self::$connection->errorInfo();
- self::$error = $errorInfo[2];
- self::$errorno = $errorInfo[1];
- $retval = false;
- break;
- }
-
- foreach ($args AS $param => $value) {
- if (is_int($args[$param])) {
- $data_type = PDO::PARAM_INT;
- } else {
- $data_type = PDO::PARAM_STR;
- }
- $stmt->bindParam($param, $args[$param], $data_type);
- }
-
- if (!$stmt->execute()) {
- $errorInfo = $stmt->errorInfo();
- self::$error = $errorInfo[2];
- self::$errorno = $errorInfo[1];
- $retval = false;
- } else {
- $retval = $stmt;
- self::$affected_rows = $retval->rowCount();
- }
- break;
- case 'mysqli':
- // There are SQL statements that cannot be executed with a prepared statement
- $parts = explode(' ', $orig_sql);
- $command = strtolower($parts[0]);
- $can_be_prepared = in_array($command, ['select', 'update', 'insert', 'delete']);
-
- // The fallback routine is called as well when there are no arguments
- if (!$can_be_prepared || (count($args) == 0)) {
- $retval = self::$connection->query(self::replaceParameters($sql, $args));
- if (self::$connection->errno) {
- self::$error = self::$connection->error;
- self::$errorno = self::$connection->errno;
- $retval = false;
- } else {
- if (isset($retval->num_rows)) {
- self::$affected_rows = $retval->num_rows;
- } else {
- self::$affected_rows = self::$connection->affected_rows;
- }
- }
- break;
- }
-
- $stmt = self::$connection->stmt_init();
-
- if (!$stmt->prepare($sql)) {
- self::$error = $stmt->error;
- self::$errorno = $stmt->errno;
- $retval = false;
- break;
- }
-
- $param_types = '';
- $values = [];
- foreach ($args AS $param => $value) {
- if (is_int($args[$param])) {
- $param_types .= 'i';
- } elseif (is_float($args[$param])) {
- $param_types .= 'd';
- } elseif (is_string($args[$param])) {
- $param_types .= 's';
- } else {
- $param_types .= 'b';
- }
- $values[] = &$args[$param];
- }
-
- if (count($values) > 0) {
- array_unshift($values, $param_types);
- call_user_func_array([$stmt, 'bind_param'], $values);
- }
-
- if (!$stmt->execute()) {
- self::$error = self::$connection->error;
- self::$errorno = self::$connection->errno;
- $retval = false;
- } else {
- $stmt->store_result();
- $retval = $stmt;
- self::$affected_rows = $retval->affected_rows;
- }
- break;
- }
-
- // We are having an own error logging in the function "e"
- if ((self::$errorno != 0) && !$called_from_e) {
- // We have to preserve the error code, somewhere in the logging it get lost
- $error = self::$error;
- $errorno = self::$errorno;
-
- self::$logger->error('DB Error', [
- 'code' => self::$errorno,
- 'error' => self::$error,
- 'callstack' => System::callstack(8),
- 'params' => self::replaceParameters($sql, $args),
- ]);
-
- // On a lost connection we try to reconnect - but only once.
- if ($errorno == 2006) {
- if (self::$in_retrial || !self::reconnect()) {
- // It doesn't make sense to continue when the database connection was lost
- if (self::$in_retrial) {
- self::$logger->notice('Giving up retrial because of database error', [
- 'code' => self::$errorno,
- 'error' => self::$error,
- ]);
- } else {
- self::$logger->notice('Couldn\'t reconnect after database error', [
- 'code' => self::$errorno,
- 'error' => self::$error,
- ]);
- }
- exit(1);
- } else {
- // We try it again
- self::$logger->notice('Reconnected after database error', [
- 'code' => self::$errorno,
- 'error' => self::$error,
- ]);
- self::$in_retrial = true;
- $ret = self::p($sql, $args);
- self::$in_retrial = false;
- return $ret;
- }
- }
-
- self::$error = $error;
- self::$errorno = $errorno;
- }
-
- self::$profiler->saveTimestamp($stamp1, 'database', System::callstack());
-
- if (self::$configCache->get('system', 'db_log')) {
- $stamp2 = microtime(true);
- $duration = (float)($stamp2 - $stamp1);
-
- if (($duration > self::$configCache->get('system', 'db_loglimit'))) {
- $duration = round($duration, 3);
- $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
-
- @file_put_contents(self::$configCache->get('system', 'db_log'), DateTimeFormat::utcNow()."\t".$duration."\t".
- basename($backtrace[1]["file"])."\t".
- $backtrace[1]["line"]."\t".$backtrace[2]["function"]."\t".
- substr(self::replaceParameters($sql, $args), 0, 2000)."\n", FILE_APPEND);
- }
- }
- return $retval;
+ return DI::dba()->p($sql, $params);
}
/**
- * @brief Executes a prepared statement like UPDATE or INSERT that doesn't return data
+ * Executes a prepared statement like UPDATE or INSERT that doesn't return data
*
* Please use DBA::delete, DBA::insert, DBA::update, ... instead
*
* @param string $sql SQL statement
- * @return boolean Was the query successfull? False is returned only if an error occurred
+ * @return boolean Was the query successful? False is returned only if an error occurred
* @throws \Exception
*/
- public static function e($sql) {
-
- $stamp = microtime(true);
-
+ public static function e(string $sql): bool
+ {
$params = self::getParam(func_get_args());
- // In a case of a deadlock we are repeating the query 20 times
- $timeout = 20;
-
- do {
- $stmt = self::p($sql, $params);
-
- if (is_bool($stmt)) {
- $retval = $stmt;
- } elseif (is_object($stmt)) {
- $retval = true;
- } else {
- $retval = false;
- }
-
- self::close($stmt);
-
- } while ((self::$errorno == 1213) && (--$timeout > 0));
-
- if (self::$errorno != 0) {
- // We have to preserve the error code, somewhere in the logging it get lost
- $error = self::$error;
- $errorno = self::$errorno;
-
- self::$logger->error('DB Error', [
- 'code' => self::$errorno,
- 'error' => self::$error,
- 'callstack' => System::callstack(8),
- 'params' => self::replaceParameters($sql, $params),
- ]);
-
- // On a lost connection we simply quit.
- // A reconnect like in self::p could be dangerous with modifications
- if ($errorno == 2006) {
- self::$logger->notice('Giving up because of database error', [
- 'code' => self::$errorno,
- 'error' => self::$error,
- ]);
- exit(1);
- }
-
- self::$error = $error;
- self::$errorno = $errorno;
- }
-
- self::$profiler->saveTimestamp($stamp, "database_write", System::callstack());
-
- return $retval;
+ return DI::dba()->e($sql, $params);
}
/**
- * @brief Check if data exists
- *
- * @param string $table Table name
- * @param array $condition array of fields for condition
+ * Check if data exists
*
+ * @param string $table Table name in format schema.table (where schema is optional)
+ * @param array $condition Array of fields for condition
* @return boolean Are there rows for that condition?
* @throws \Exception
*/
- public static function exists($table, $condition) {
- if (empty($table)) {
- return false;
- }
-
- $fields = [];
-
- if (empty($condition)) {
- return DBStructure::existsTable($table);
- }
-
- reset($condition);
- $first_key = key($condition);
- if (!is_int($first_key)) {
- $fields = [$first_key];
- }
-
- $stmt = self::select($table, $fields, $condition, ['limit' => 1]);
-
- if (is_bool($stmt)) {
- $retval = $stmt;
- } else {
- $retval = (self::numRows($stmt) > 0);
- }
-
- self::close($stmt);
-
- return $retval;
+ public static function exists(string $table, array $condition): bool
+ {
+ return DI::dba()->exists($table, $condition);
}
/**
*
* Please use DBA::selectFirst or DBA::exists whenever this is possible.
*
- * @brief Fetches the first row
* @param string $sql SQL statement
* @return array first row of query
* @throws \Exception
*/
- public static function fetchFirst($sql) {
+ public static function fetchFirst(string $sql)
+ {
$params = self::getParam(func_get_args());
- $stmt = self::p($sql, $params);
-
- if (is_bool($stmt)) {
- $retval = $stmt;
- } else {
- $retval = self::fetch($stmt);
- }
-
- self::close($stmt);
-
- return $retval;
+ return DI::dba()->fetchFirst($sql, $params);
}
/**
- * @brief Returns the number of affected rows of the last statement
+ * Returns the number of affected rows of the last statement
*
* @return int Number of rows
*/
- public static function affectedRows() {
- return self::$affected_rows;
+ public static function affectedRows(): int
+ {
+ return DI::dba()->affectedRows();
}
/**
- * @brief Returns the number of columns of a statement
+ * Returns the number of columns of a statement
*
* @param object Statement object
* @return int Number of columns
*/
- public static function columnCount($stmt) {
- if (!is_object($stmt)) {
- return 0;
- }
- switch (self::$driver) {
- case 'pdo':
- return $stmt->columnCount();
- case 'mysqli':
- return $stmt->field_count;
- }
- return 0;
+ public static function columnCount($stmt): int
+ {
+ return DI::dba()->columnCount($stmt);
}
/**
- * @brief Returns the number of rows of a statement
+ * Returns the number of rows of a statement
*
* @param PDOStatement|mysqli_result|mysqli_stmt Statement object
* @return int Number of rows
*/
- public static function numRows($stmt) {
- if (!is_object($stmt)) {
- return 0;
- }
- switch (self::$driver) {
- case 'pdo':
- return $stmt->rowCount();
- case 'mysqli':
- return $stmt->num_rows;
- }
- return 0;
+ public static function numRows($stmt): int
+ {
+ return DI::dba()->numRows($stmt);
}
/**
- * @brief Fetch a single row
+ * Fetch a single row
*
* @param mixed $stmt statement object
* @return array current row
*/
- public static function fetch($stmt) {
-
- $stamp1 = microtime(true);
-
- $columns = [];
-
- if (!is_object($stmt)) {
- return false;
- }
-
- switch (self::$driver) {
- case 'pdo':
- $columns = $stmt->fetch(PDO::FETCH_ASSOC);
- break;
- case 'mysqli':
- if (get_class($stmt) == 'mysqli_result') {
- $columns = $stmt->fetch_assoc();
- break;
- }
-
- // This code works, but is slow
-
- // Bind the result to a result array
- $cols = [];
-
- $cols_num = [];
- for ($x = 0; $x < $stmt->field_count; $x++) {
- $cols[] = &$cols_num[$x];
- }
-
- call_user_func_array([$stmt, 'bind_result'], $cols);
-
- if (!$stmt->fetch()) {
- return false;
- }
-
- // The slow part:
- // We need to get the field names for the array keys
- // It seems that there is no better way to do this.
- $result = $stmt->result_metadata();
- $fields = $result->fetch_fields();
-
- foreach ($cols_num AS $param => $col) {
- $columns[$fields[$param]->name] = $col;
- }
- }
-
- self::$profiler->saveTimestamp($stamp1, 'database', System::callstack());
-
- return $columns;
+ public static function fetch($stmt)
+ {
+ return DI::dba()->fetch($stmt);
}
/**
- * @brief Insert a row into a table
- *
- * @param string $table Table name
- * @param array $param parameter array
- * @param bool $on_duplicate_update Do an update on a duplicate entry
+ * Insert a row into a table
*
+ * @param string $table Table name in format schema.table (where schema is optional)
+ * @param array $param parameter array
+ * @param int $duplicate_mode What to do on a duplicated entry
* @return boolean was the insert successful?
* @throws \Exception
*/
- public static function insert($table, $param, $on_duplicate_update = false) {
-
- if (empty($table) || empty($param)) {
- self::$logger->info('Table and fields have to be set');
- return false;
- }
-
- $sql = "INSERT INTO `".self::escape($table)."` (`".implode("`, `", array_keys($param))."`) VALUES (".
- substr(str_repeat("?, ", count($param)), 0, -2).")";
-
- if ($on_duplicate_update) {
- $sql .= " ON DUPLICATE KEY UPDATE `".implode("` = ?, `", array_keys($param))."` = ?";
-
- $values = array_values($param);
- $param = array_merge_recursive($values, $values);
- }
-
- return self::e($sql, $param);
- }
-
- /**
- * @brief Fetch the id of the last insert command
- *
- * @return integer Last inserted id
- */
- public static function lastInsertId() {
- switch (self::$driver) {
- case 'pdo':
- $id = self::$connection->lastInsertId();
- break;
- case 'mysqli':
- $id = self::$connection->insert_id;
- break;
- }
- return $id;
+ public static function insert(string $table, array $param, int $duplicate_mode = Database::INSERT_DEFAULT): bool
+ {
+ return DI::dba()->insert($table, $param, $duplicate_mode);
}
/**
- * @brief Locks a table for exclusive write access
+ * Inserts a row with the provided data in the provided table.
+ * If the data corresponds to an existing row through a UNIQUE or PRIMARY index constraints, it updates the row instead.
*
- * This function can be extended in the future to accept a table array as well.
- *
- * @param string $table Table name
- *
- * @return boolean was the lock successful?
+ * @param string $table Table name in format schema.table (where schema is optional)
+ * @param array $param parameter array
+ * @return boolean was the insert successful?
* @throws \Exception
*/
- public static function lock($table) {
- // See here: https://dev.mysql.com/doc/refman/5.7/en/lock-tables-and-transactions.html
- if (self::$driver == 'pdo') {
- self::e("SET autocommit=0");
- self::$connection->setAttribute(PDO::ATTR_EMULATE_PREPARES, true);
- } else {
- self::$connection->autocommit(false);
- }
-
- $success = self::e("LOCK TABLES `".self::escape($table)."` WRITE");
-
- if (self::$driver == 'pdo') {
- self::$connection->setAttribute(PDO::ATTR_EMULATE_PREPARES, false);
- }
-
- if (!$success) {
- if (self::$driver == 'pdo') {
- self::e("SET autocommit=1");
- } else {
- self::$connection->autocommit(true);
- }
- } else {
- self::$in_transaction = true;
- }
- return $success;
+ public static function replace(string $table, array $param): bool
+ {
+ return DI::dba()->replace($table, $param);
}
/**
- * @brief Unlocks all locked tables
+ * Fetch the id of the last insert command
*
- * @return boolean was the unlock successful?
- * @throws \Exception
+ * @return integer Last inserted id
*/
- public static function unlock() {
- // See here: https://dev.mysql.com/doc/refman/5.7/en/lock-tables-and-transactions.html
- self::performCommit();
-
- if (self::$driver == 'pdo') {
- self::$connection->setAttribute(PDO::ATTR_EMULATE_PREPARES, true);
- }
-
- $success = self::e("UNLOCK TABLES");
-
- if (self::$driver == 'pdo') {
- self::$connection->setAttribute(PDO::ATTR_EMULATE_PREPARES, false);
- self::e("SET autocommit=1");
- } else {
- self::$connection->autocommit(true);
- }
-
- self::$in_transaction = false;
- return $success;
+ public static function lastInsertId(): int
+ {
+ return DI::dba()->lastInsertId();
}
/**
- * @brief Starts a transaction
+ * Locks a table for exclusive write access
*
- * @return boolean Was the command executed successfully?
+ * This function can be extended in the future to accept a table array as well.
+ *
+ * @param string $table Table name in format schema.table (where schema is optional)
+ * @return boolean was the lock successful?
+ * @throws \Exception
*/
- public static function transaction() {
- if (!self::performCommit()) {
- return false;
- }
-
- switch (self::$driver) {
- case 'pdo':
- if (!self::$connection->inTransaction() && !self::$connection->beginTransaction()) {
- return false;
- }
- break;
-
- case 'mysqli':
- if (!self::$connection->begin_transaction()) {
- return false;
- }
- break;
- }
-
- self::$in_transaction = true;
- return true;
+ public static function lock(string $table): bool
+ {
+ return DI::dba()->lock($table);
}
- private static function performCommit()
+ /**
+ * Unlocks all locked tables
+ *
+ * @return boolean was the unlock successful?
+ * @throws \Exception
+ */
+ public static function unlock(): bool
{
- switch (self::$driver) {
- case 'pdo':
- if (!self::$connection->inTransaction()) {
- return true;
- }
-
- return self::$connection->commit();
-
- case 'mysqli':
- return self::$connection->commit();
- }
-
- return true;
+ return DI::dba()->unlock();
}
/**
- * @brief Does a commit
+ * Starts a transaction
*
* @return boolean Was the command executed successfully?
*/
- public static function commit() {
- if (!self::performCommit()) {
- return false;
- }
- self::$in_transaction = false;
- return true;
+ public static function transaction(): bool
+ {
+ return DI::dba()->transaction();
}
/**
- * @brief Does a rollback
+ * Does a commit
*
* @return boolean Was the command executed successfully?
*/
- public static function rollback() {
- $ret = false;
-
- switch (self::$driver) {
- case 'pdo':
- if (!self::$connection->inTransaction()) {
- $ret = true;
- break;
- }
- $ret = self::$connection->rollBack();
- break;
-
- case 'mysqli':
- $ret = self::$connection->rollback();
- break;
- }
- self::$in_transaction = false;
- return $ret;
+ public static function commit(): bool
+ {
+ return DI::dba()->commit();
}
/**
- * @brief Build the array with the table relations
+ * Does a rollback
*
- * The array is build from the database definitions in DBStructure.php
- *
- * This process must only be started once, since the value is cached.
+ * @return boolean Was the command executed successfully?
*/
- private static function buildRelationData() {
- $definition = DBStructure::definition(self::$configCache->get('system', 'basepath'));
-
- foreach ($definition AS $table => $structure) {
- foreach ($structure['fields'] AS $field => $field_struct) {
- if (isset($field_struct['relation'])) {
- foreach ($field_struct['relation'] AS $rel_table => $rel_field) {
- self::$relation[$rel_table][$rel_field][$table][] = $field;
- }
- }
- }
- }
+ public static function rollback(): bool
+ {
+ return DI::dba()->rollback();
}
/**
- * @brief Delete a row from a table
+ * Delete a row from a table
*
* @param string $table Table name
* @param array $conditions Field condition(s)
- * @param array $options
- * - cascade: If true we delete records in other tables that depend on the one we're deleting through
- * relations (default: true)
- * @param array $callstack Internal use: prevent endless loops
*
* @return boolean was the delete successful?
* @throws \Exception
*/
- public static function delete($table, array $conditions, array $options = [], array &$callstack = [])
+ public static function delete(string $table, array $conditions, array $options = []): bool
{
- if (empty($table) || empty($conditions)) {
- self::$logger->info('Table and conditions have to be set');
- return false;
- }
-
- $commands = [];
-
- // Create a key for the loop prevention
- $key = $table . ':' . json_encode($conditions);
-
- // We quit when this key already exists in the callstack.
- if (isset($callstack[$key])) {
- return $commands;
- }
-
- $callstack[$key] = true;
-
- $table = self::escape($table);
-
- $commands[$key] = ['table' => $table, 'conditions' => $conditions];
-
- // Don't use "defaults" here, since it would set "false" to "true"
- if (isset($options['cascade'])) {
- $cascade = $options['cascade'];
- } else {
- $cascade = true;
- }
-
- // To speed up the whole process we cache the table relations
- if ($cascade && count(self::$relation) == 0) {
- self::buildRelationData();
- }
-
- // Is there a relation entry for the table?
- if ($cascade && isset(self::$relation[$table])) {
- // We only allow a simple "one field" relation.
- $field = array_keys(self::$relation[$table])[0];
- $rel_def = array_values(self::$relation[$table])[0];
-
- // Create a key for preventing double queries
- $qkey = $field . '-' . $table . ':' . json_encode($conditions);
-
- // When the search field is the relation field, we don't need to fetch the rows
- // This is useful when the leading record is already deleted in the frontend but the rest is done in the backend
- if ((count($conditions) == 1) && ($field == array_keys($conditions)[0])) {
- foreach ($rel_def AS $rel_table => $rel_fields) {
- foreach ($rel_fields AS $rel_field) {
- self::delete($rel_table, [$rel_field => array_values($conditions)[0]], $options, $callstack);
- }
- }
- // We quit when this key already exists in the callstack.
- } elseif (!isset($callstack[$qkey])) {
- $callstack[$qkey] = true;
-
- // Fetch all rows that are to be deleted
- $data = self::select($table, [$field], $conditions);
-
- while ($row = self::fetch($data)) {
- self::delete($table, [$field => $row[$field]], $options, $callstack);
- }
-
- self::close($data);
-
- // Since we had split the delete command we don't need the original command anymore
- unset($commands[$key]);
- }
- }
-
- // Now we finalize the process
- $do_transaction = !self::$in_transaction;
-
- if ($do_transaction) {
- self::transaction();
- }
-
- $compacted = [];
- $counter = [];
-
- foreach ($commands AS $command) {
- $conditions = $command['conditions'];
- reset($conditions);
- $first_key = key($conditions);
-
- $condition_string = self::buildCondition($conditions);
-
- if ((count($command['conditions']) > 1) || is_int($first_key)) {
- $sql = "DELETE FROM `" . $command['table'] . "`" . $condition_string;
- self::$logger->debug(self::replaceParameters($sql, $conditions));
-
- if (!self::e($sql, $conditions)) {
- if ($do_transaction) {
- self::rollback();
- }
- return false;
- }
- } else {
- $key_table = $command['table'];
- $key_condition = array_keys($command['conditions'])[0];
- $value = array_values($command['conditions'])[0];
-
- // Split the SQL queries in chunks of 100 values
- // We do the $i stuff here to make the code better readable
- $i = isset($counter[$key_table][$key_condition]) ? $counter[$key_table][$key_condition] : 0;
- if (isset($compacted[$key_table][$key_condition][$i]) && count($compacted[$key_table][$key_condition][$i]) > 100) {
- ++$i;
- }
-
- $compacted[$key_table][$key_condition][$i][$value] = $value;
- $counter[$key_table][$key_condition] = $i;
- }
- }
- foreach ($compacted AS $table => $values) {
- foreach ($values AS $field => $field_value_list) {
- foreach ($field_value_list AS $field_values) {
- $sql = "DELETE FROM `" . $table . "` WHERE `" . $field . "` IN (" .
- substr(str_repeat("?, ", count($field_values)), 0, -2) . ");";
-
- self::$logger->debug(self::replaceParameters($sql, $field_values));
-
- if (!self::e($sql, $field_values)) {
- if ($do_transaction) {
- self::rollback();
- }
- return false;
- }
- }
- }
- }
- if ($do_transaction) {
- self::commit();
- }
- return true;
+ return DI::dba()->delete($table, $conditions, $options);
}
/**
- * @brief Updates rows
+ * Updates rows in the database.
*
- * Updates rows in the database. When $old_fields is set to an array,
+ * When $old_fields is set to an array,
* the system will only do an update if the fields in that array changed.
*
* Attention:
* Only set $old_fields to a boolean value when you are sure that you will update a single row.
* When you set $old_fields to "true" then $fields must contain all relevant fields!
*
- * @param string $table Table name
+ * @param string $table Table name in format schema.table (where schema is optional)
* @param array $fields contains the fields that are updated
* @param array $condition condition array with the key values
- * @param array|boolean $old_fields array with the old field values that are about to be replaced (true = update on duplicate)
+ * @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)
+ * @param array $params Parameters: "ignore" If set to "true" then the update is done with the ignore parameter
*
- * @return boolean was the update successfull?
+ * @return boolean was the update successful?
* @throws \Exception
*/
- public static function update($table, $fields, $condition, $old_fields = []) {
-
- if (empty($table) || empty($fields) || empty($condition)) {
- self::$logger->info('Table, fields and condition have to be set');
- return false;
- }
-
- $table = self::escape($table);
-
- $condition_string = self::buildCondition($condition);
-
- if (is_bool($old_fields)) {
- $do_insert = $old_fields;
-
- $old_fields = self::selectFirst($table, [], $condition);
-
- if (is_bool($old_fields)) {
- if ($do_insert) {
- $values = array_merge($condition, $fields);
- return self::insert($table, $values, $do_insert);
- }
- $old_fields = [];
- }
- }
-
- $do_update = (count($old_fields) == 0);
-
- foreach ($old_fields AS $fieldname => $content) {
- if (isset($fields[$fieldname])) {
- if (($fields[$fieldname] == $content) && !is_null($content)) {
- unset($fields[$fieldname]);
- } else {
- $do_update = true;
- }
- }
- }
-
- if (!$do_update || (count($fields) == 0)) {
- return true;
- }
-
- $sql = "UPDATE `".$table."` SET `".
- implode("` = ?, `", array_keys($fields))."` = ?".$condition_string;
-
- $params1 = array_values($fields);
- $params2 = array_values($condition);
- $params = array_merge_recursive($params1, $params2);
-
- return self::e($sql, $params);
+ public static function update(string $table, array $fields, array $condition, $old_fields = [], array $params = []): bool
+ {
+ return DI::dba()->update($table, $fields, $condition, $old_fields, $params);
}
/**
* Retrieve a single record from a table and returns it in an associative array
*
- * @brief Retrieve a single record from a table
- * @param string $table
- * @param array $fields
- * @param array $condition
- * @param array $params
+ * @param string|array $table Table name in format schema.table (where schema is optional)
+ * @param array $fields
+ * @param array $condition
+ * @param array $params
* @return bool|array
* @throws \Exception
* @see self::select
*/
- public static function selectFirst($table, array $fields = [], array $condition = [], $params = [])
+ public static function selectFirst($table, array $fields = [], array $condition = [], array $params = [])
{
- $params['limit'] = 1;
- $result = self::select($table, $fields, $condition, $params);
+ return DI::dba()->selectFirst($table, $fields, $condition, $params);
+ }
- if (is_bool($result)) {
- return $result;
- } else {
- $row = self::fetch($result);
- self::close($result);
- return $row;
- }
+ /**
+ * Select rows from a table and fills an array with the data
+ *
+ * @param string $table Table name in format schema.table (where schema is optional)
+ * @param array $fields Array of selected fields, empty for all
+ * @param array $condition Array of fields for condition
+ * @param array $params Array of several parameters
+ *
+ * @return array Data array
+ * @throws \Exception
+ * @see self::select
+ */
+ public static function selectToArray(string $table, array $fields = [], array $condition = [], array $params = [])
+ {
+ return DI::dba()->selectToArray($table, $fields, $condition, $params);
}
/**
- * @brief Select rows from a table
+ * Select rows from a table
*
- * @param string $table Table name
+ * @param string $table Table name in format schema.table (where schema is optional)
* @param array $fields Array of selected fields, empty for all
* @param array $condition Array of fields for condition
* @param array $params Array of several parameters
* @return boolean|object
*
* Example:
- * $table = "item";
+ * $table = "post";
* $fields = array("id", "uri", "uid", "network");
*
* $condition = array("uid" => 1, "network" => 'dspr');
* $data = DBA::select($table, $fields, $condition, $params);
* @throws \Exception
*/
- public static function select($table, array $fields = [], array $condition = [], array $params = [])
+ public static function select(string $table, array $fields = [], array $condition = [], array $params = [])
{
- if ($table == '') {
- return false;
- }
-
- $table = self::escape($table);
-
- if (count($fields) > 0) {
- $select_fields = "`" . implode("`, `", array_values($fields)) . "`";
- } else {
- $select_fields = "*";
- }
-
- $condition_string = self::buildCondition($condition);
-
- $param_string = self::buildParameter($params);
-
- $sql = "SELECT " . $select_fields . " FROM `" . $table . "`" . $condition_string . $param_string;
-
- $result = self::p($sql, $condition);
-
- return $result;
+ return DI::dba()->select($table, $fields, $condition, $params);
}
/**
- * @brief Counts the rows from a table satisfying the provided condition
+ * Counts the rows from a table satisfying the provided condition
*
- * @param string $table Table name
+ * @param string $table Table name in format schema.table (where schema is optional)
* @param array $condition array of fields for condition
+ * @param array $params Array of several parameters
*
* @return int
*
* Example:
- * $table = "item";
+ * $table = "post";
*
* $condition = ["uid" => 1, "network" => 'dspr'];
* or:
* $count = DBA::count($table, $condition);
* @throws \Exception
*/
- public static function count($table, array $condition = [])
+ public static function count(string $table, array $condition = [], array $params = []): int
{
- if ($table == '') {
- return false;
- }
-
- $condition_string = self::buildCondition($condition);
-
- $sql = "SELECT COUNT(*) AS `count` FROM `".$table."`".$condition_string;
+ return DI::dba()->count($table, $condition, $params);
+ }
- $row = self::fetchFirst($sql, $condition);
+ /**
+ * Build the table query substring from one or more tables, with or without a schema.
+ *
+ * Expected formats:
+ * - [table]
+ * - [table1, table2, ...]
+ * - [schema1 => table1, schema2 => table2, table3, ...]
+ *
+ * @param array $tables Table names
+ * @return string
+ */
+ public static function buildTableString(array $tables): string
+ {
+ // Quote each entry
+ return implode(',', array_map([self::class, 'quoteIdentifier'], $tables));
+ }
- return $row['count'];
+ /**
+ * Escape an identifier (table or field name) optional with a schema like ((schema.)table.)field
+ *
+ * @param string $identifier Table, field name
+ * @return string Quotes table or field name
+ */
+ public static function quoteIdentifier(string $identifier): string
+ {
+ return implode(
+ '.',
+ array_map(
+ function (string $identifier) { return '`' . str_replace('`', '``', $identifier) . '`'; },
+ explode('.', $identifier)
+ )
+ );
}
/**
- * @brief Returns the SQL condition string built from the provided condition array
+ * Returns the SQL condition string built from the provided condition array
*
* This function operates with two modes.
- * - Supplied with a filed/value associative array, it builds simple strict
+ * - Supplied with a field/value associative array, it builds simple strict
* equality conditions linked by AND.
* - Supplied with a flat list, the first element is the condition string and
* the following arguments are the values to be interpolated
* @param array $condition
* @return string
*/
- public static function buildCondition(array &$condition = [])
+ public static function buildCondition(array &$condition = []): string
{
+ $condition = self::collapseCondition($condition);
+
$condition_string = '';
if (count($condition) > 0) {
- reset($condition);
- $first_key = key($condition);
- if (is_int($first_key)) {
- $condition_string = " WHERE (" . array_shift($condition) . ")";
- } else {
- $new_values = [];
- $condition_string = "";
- foreach ($condition as $field => $value) {
- if ($condition_string != "") {
- $condition_string .= " AND ";
- }
- if (is_array($value)) {
- /* Workaround for MySQL Bug #64791.
- * Never mix data types inside any IN() condition.
- * In case of mixed types, cast all as string.
- * Logic needs to be consistent with DBA::p() data types.
- */
- $is_int = false;
- $is_alpha = false;
- foreach ($value as $single_value) {
- if (is_int($single_value)) {
- $is_int = true;
- } else {
- $is_alpha = true;
- }
+ $condition_string = " WHERE (" . array_shift($condition) . ")";
+ }
+
+ return $condition_string;
+ }
+
+ /**
+ * Collapse an associative array condition into a SQL string + parameters condition array.
+ *
+ * ['uid' => 1, 'network' => ['dspr', 'apub']]
+ *
+ * gets transformed into
+ *
+ * ["`uid` = ? AND `network` IN (?, ?)", 1, 'dspr', 'apub']
+ *
+ * @param array $condition
+ * @return array
+ */
+ public static function collapseCondition(array $condition): array
+ {
+ // Ensures an always true condition is returned
+ if (count($condition) < 1) {
+ return ['1'];
+ }
+
+ reset($condition);
+ $first_key = key($condition);
+
+ if (is_int($first_key)) {
+ // Already collapsed
+ return $condition;
+ }
+
+ $values = [];
+ $condition_string = "";
+ foreach ($condition as $field => $value) {
+ if ($condition_string != "") {
+ $condition_string .= " AND ";
+ }
+
+ if (is_array($value)) {
+ if (count($value)) {
+ /* Workaround for MySQL Bug #64791.
+ * Never mix data types inside any IN() condition.
+ * In case of mixed types, cast all as string.
+ * Logic needs to be consistent with DBA::p() data types.
+ */
+ $is_int = false;
+ $is_alpha = false;
+ foreach ($value as $single_value) {
+ if (is_int($single_value)) {
+ $is_int = true;
+ } else {
+ $is_alpha = true;
}
+ }
- if ($is_int && $is_alpha) {
- foreach ($value as &$ref) {
- if (is_int($ref)) {
- $ref = (string)$ref;
- }
+ if ($is_int && $is_alpha) {
+ foreach ($value as &$ref) {
+ if (is_int($ref)) {
+ $ref = (string)$ref;
}
- unset($ref); //Prevent accidental re-use.
}
-
- $new_values = array_merge($new_values, array_values($value));
- $placeholders = substr(str_repeat("?, ", count($value)), 0, -2);
- $condition_string .= "`" . $field . "` IN (" . $placeholders . ")";
- } elseif (is_null($value)) {
- $condition_string .= "`" . $field . "` IS NULL";
- } else {
- $new_values[$field] = $value;
- $condition_string .= "`" . $field . "` = ?";
+ unset($ref); //Prevent accidental re-use.
}
+
+ $values = array_merge($values, array_values($value));
+ $placeholders = substr(str_repeat("?, ", count($value)), 0, -2);
+ $condition_string .= self::quoteIdentifier($field) . " IN (" . $placeholders . ")";
+ } else {
+ // Empty value array isn't supported by IN and is logically equivalent to no match
+ $condition_string .= "FALSE";
}
- $condition_string = " WHERE (" . $condition_string . ")";
- $condition = $new_values;
+ } elseif (is_null($value)) {
+ $condition_string .= self::quoteIdentifier($field) . " IS NULL";
+ } else {
+ $values[$field] = $value;
+ $condition_string .= self::quoteIdentifier($field) . " = ?";
}
}
- return $condition_string;
+ $condition = array_merge([$condition_string], array_values($values));
+
+ return $condition;
+ }
+
+ /**
+ * Merges the provided conditions into a single collapsed one
+ *
+ * @param array ...$conditions One or more condition arrays
+ * @return array A collapsed condition
+ * @see DBA::collapseCondition() for the condition array formats
+ */
+ public static function mergeConditions(array ...$conditions): array
+ {
+ if (count($conditions) == 1) {
+ return current($conditions);
+ }
+
+ $conditionStrings = [];
+ $result = [];
+
+ foreach ($conditions as $key => $condition) {
+ if (!$condition) {
+ continue;
+ }
+
+ $condition = self::collapseCondition($condition);
+
+ $conditionStrings[] = array_shift($condition);
+ // The result array holds the eventual parameter values
+ $result = array_merge($result, $condition);
+ }
+
+ if (count($conditionStrings)) {
+ // We prepend the condition string at the end to form a collapsed condition array again
+ array_unshift($result, implode(' AND ', $conditionStrings));
+ }
+
+ return $result;
}
/**
- * @brief Returns the SQL parameter string built from the provided parameter array
+ * Returns the SQL parameter string built from the provided parameter array
+ *
+ * Expected format for each key:
+ *
+ * group_by:
+ * - list of column names
+ *
+ * order:
+ * - numeric keyed column name => ASC
+ * - associative element with boolean value => DESC (true), ASC (false)
+ * - associative element with string value => 'ASC' or 'DESC' literally
+ *
+ * limit:
+ * - single numeric value => count
+ * - list with two numeric values => offset, count
*
* @param array $params
* @return string
*/
- public static function buildParameter(array $params = [])
+ public static function buildParameter(array $params = []): string
{
$groupby_string = '';
- if (isset($params['group_by'])) {
- $groupby_string = " GROUP BY ";
- foreach ($params['group_by'] as $fields) {
- $groupby_string .= "`" . $fields . "`, ";
- }
- $groupby_string = substr($groupby_string, 0, -2);
+ if (!empty($params['group_by'])) {
+ $groupby_string = " GROUP BY " . implode(', ', array_map([self::class, 'quoteIdentifier'], $params['group_by']));
}
$order_string = '';
if (isset($params['order'])) {
$order_string = " ORDER BY ";
- foreach ($params['order'] AS $fields => $order) {
+ foreach ($params['order'] as $fields => $order) {
if ($order === 'RAND()') {
$order_string .= "RAND(), ";
} elseif (!is_int($fields)) {
- $order_string .= "`" . $fields . "` " . ($order ? "DESC" : "ASC") . ", ";
+ if ($order !== 'DESC' && $order !== 'ASC') {
+ $order = $order ? 'DESC' : 'ASC';
+ }
+
+ $order_string .= self::quoteIdentifier($fields) . " " . $order . ", ";
} else {
- $order_string .= "`" . $order . "`, ";
+ $order_string .= self::quoteIdentifier($order) . ", ";
}
}
$order_string = substr($order_string, 0, -2);
}
/**
- * @brief Fills an array with data from a query
+ * Fills an array with data from a query
+ *
+ * @param object $stmt statement object
+ * @param bool $do_close Close database connection after last row
+ * @param int $count maximum number of rows to be fetched
*
- * @param object $stmt statement object
- * @param bool $do_close
* @return array Data array
*/
- public static function toArray($stmt, $do_close = true) {
- if (is_bool($stmt)) {
- return $stmt;
- }
+ public static function toArray($stmt, bool $do_close = true, int $count = 0): array
+ {
+ return DI::dba()->toArray($stmt, $do_close, $count);
+ }
- $data = [];
- while ($row = self::fetch($stmt)) {
- $data[] = $row;
- }
- if ($do_close) {
- self::close($stmt);
- }
- return $data;
+ /**
+ * Cast field types according to the table definition
+ *
+ * @param string $table
+ * @param array $fields
+ * @return array casted fields
+ */
+ public static function castFields(string $table, array $fields): array
+ {
+ return DI::dba()->castFields($table, $fields);
}
/**
- * @brief Returns the error number of the last query
+ * Returns the error number of the last query
*
* @return string Error number (0 if no error)
*/
- public static function errorNo() {
- return self::$errorno;
+ public static function errorNo(): int
+ {
+ return DI::dba()->errorNo();
}
/**
- * @brief Returns the error message of the last query
+ * Returns the error message of the last query
*
* @return string Error message ('' if no error)
*/
- public static function errorMessage() {
- return self::$error;
+ public static function errorMessage(): string
+ {
+ return DI::dba()->errorMessage();
}
/**
- * @brief Closes the current statement
+ * Closes the current statement
*
* @param object $stmt statement object
* @return boolean was the close successful?
*/
- public static function close($stmt) {
-
- $stamp1 = microtime(true);
-
- if (!is_object($stmt)) {
- return false;
- }
-
- switch (self::$driver) {
- case 'pdo':
- $ret = $stmt->closeCursor();
- break;
- case 'mysqli':
- // MySQLi offers both a mysqli_stmt and a mysqli_result class.
- // We should be careful not to assume the object type of $stmt
- // because DBA::p() has been able to return both types.
- if ($stmt instanceof mysqli_stmt) {
- $stmt->free_result();
- $ret = $stmt->close();
- } elseif ($stmt instanceof mysqli_result) {
- $stmt->free();
- $ret = true;
- } else {
- $ret = false;
- }
- break;
- }
-
- self::$profiler->saveTimestamp($stamp1, 'database', System::callstack());
-
- return $ret;
+ public static function close($stmt): bool
+ {
+ return DI::dba()->close($stmt);
}
/**
- * @brief Return a list of database processes
+ * Return a list of database processes
*
* @return array
* 'list' => List of processes, separated in their different states
* 'amount' => Number of concurrent database processes
* @throws \Exception
*/
- public static function processlist()
+ public static function processlist(): array
{
- $ret = self::p("SHOW PROCESSLIST");
- $data = self::toArray($ret);
-
- $processes = 0;
- $states = [];
- foreach ($data as $process) {
- $state = trim($process["State"]);
-
- // Filter out all non blocking processes
- if (!in_array($state, ["", "init", "statistics", "updating"])) {
- ++$states[$state];
- ++$processes;
- }
- }
-
- $statelist = "";
- foreach ($states as $state => $usage) {
- if ($statelist != "") {
- $statelist .= ", ";
- }
- $statelist .= $state.": ".$usage;
- }
- return(["list" => $statelist, "amount" => $processes]);
+ return DI::dba()->processlist();
}
/**
- * Checks if $array is a filled array with at least one entry.
- *
- * @param mixed $array A filled array with at least one entry
+ * Fetch a database variable
*
- * @return boolean Whether $array is a filled array or an object with rows
+ * @param string $name
+ * @return string content
*/
- public static function isResult($array)
+ public static function getVariable(string $name)
{
- // It could be a return value from an update statement
- if (is_bool($array)) {
- return $array;
- }
-
- if (is_object($array)) {
- return self::numRows($array) > 0;
- }
-
- return (is_array($array) && (count($array) > 0));
+ return DI::dba()->getVariable($name);
}
/**
- * @brief Callback function for "esc_array"
+ * Checks if $array is a filled array with at least one entry.
*
- * @param mixed $value Array value
- * @param string $key Array key
- * @param boolean $add_quotation add quotation marks for string values
- * @return void
+ * @param mixed $array A filled array with at least one entry
+ * @return boolean Whether $array is a filled array or an object with rows
*/
- private static function escapeArrayCallback(&$value, $key, $add_quotation)
+ public static function isResult($array): bool
{
- if (!$add_quotation) {
- if (is_bool($value)) {
- $value = ($value ? '1' : '0');
- } else {
- $value = self::escape($value);
- }
- return;
- }
-
- if (is_bool($value)) {
- $value = ($value ? 'true' : 'false');
- } elseif (is_float($value) || is_integer($value)) {
- $value = (string) $value;
- } else {
- $value = "'" . self::escape($value) . "'";
- }
+ return DI::dba()->isResult($array);
}
/**
- * @brief Escapes a whole array
+ * Escapes a whole array
*
* @param mixed $arr Array with values to be escaped
* @param boolean $add_quotation add quotation marks for string values
* @return void
*/
- public static function escapeArray(&$arr, $add_quotation = false)
+ public static function escapeArray(&$arr, bool $add_quotation = false)
{
- array_walk($arr, 'self::escapeArrayCallback', $add_quotation);
+ DI::dba()->escapeArray($arr, $add_quotation);
}
}
projects / friendica.git / blobdiff