use Friendica\Core\Config\ValueObject\Cache;
use Friendica\Core\System;
+use Friendica\Database\Definition\DbaDefinition;
+use Friendica\Database\Definition\ViewDefinition;
use Friendica\Network\HTTPException\ServiceUnavailableException;
use Friendica\Util\DateTimeFormat;
use Friendica\Util\Profiler;
use PDOException;
use PDOStatement;
use Psr\Log\LoggerInterface;
+use Psr\Log\NullLogger;
/**
* This class is for the low level database stuff that does driver specific things.
*/
class Database
{
- const PDO = 'pdo';
+ const PDO = 'pdo';
const MYSQLI = 'mysqli';
const INSERT_DEFAULT = 0;
- const INSERT_UPDATE = 1;
- const INSERT_IGNORE = 2;
+ const INSERT_UPDATE = 1;
+ const INSERT_IGNORE = 2;
protected $connected = false;
* @var LoggerInterface
*/
protected $logger;
- protected $server_info = '';
+ protected $server_info = '';
/** @var PDO|mysqli */
protected $connection;
- protected $driver;
+ protected $driver = '';
protected $pdo_emulate_prepares = false;
- private $error = false;
- private $errorno = 0;
- private $affected_rows = 0;
+ private $error = '';
+ private $errorno = 0;
+ private $affected_rows = 0;
protected $in_transaction = false;
- protected $in_retrial = false;
- protected $testmode = false;
- private $relation = [];
-
- public function __construct(Cache $configCache, Profiler $profiler, LoggerInterface $logger)
+ protected $in_retrial = false;
+ protected $testmode = false;
+ private $relation = [];
+ /** @var DbaDefinition */
+ protected $dbaDefinition;
+ /** @var ViewDefinition */
+ protected $viewDefinition;
+
+ public function __construct(Cache $configCache, Profiler $profiler, DbaDefinition $dbaDefinition, ViewDefinition $viewDefinition)
{
// We are storing these values for being able to perform a reconnect
- $this->configCache = $configCache;
- $this->profiler = $profiler;
- $this->logger = $logger;
+ $this->configCache = $configCache;
+ $this->profiler = $profiler;
+ $this->dbaDefinition = $dbaDefinition;
+ $this->viewDefinition = $viewDefinition;
- $this->connect();
+ // Temporary NullLogger until we can fetch the logger class from the config
+ $this->logger = new NullLogger();
- if ($this->isConnected()) {
- // Loads DB_UPDATE_VERSION constant
- DBStructure::definition($configCache->get('system', 'basepath'), false);
- }
+ $this->connect();
}
/**
$this->connected = false;
$port = 0;
- $serveraddr = trim($this->configCache->get('database', 'hostname'));
+ $serveraddr = trim($this->configCache->get('database', 'hostname') ?? '');
$serverdata = explode(':', $serveraddr);
- $server = $serverdata[0];
+ $host = trim($serverdata[0]);
if (count($serverdata) > 1) {
$port = trim($serverdata[1]);
}
- if (!empty(trim($this->configCache->get('database', 'port')))) {
- $port = trim($this->configCache->get('database', 'port'));
+ if (trim($this->configCache->get('database', 'port') ?? 0)) {
+ $port = trim($this->configCache->get('database', 'port') ?? 0);
}
- $server = trim($server);
- $user = trim($this->configCache->get('database', 'username'));
- $pass = trim($this->configCache->get('database', 'password'));
- $db = trim($this->configCache->get('database', 'database'));
- $charset = trim($this->configCache->get('database', 'charset'));
- $socket = trim($this->configCache->get('database', 'socket'));
+ $user = trim($this->configCache->get('database', 'username'));
+ $pass = trim($this->configCache->get('database', 'password'));
+ $database = trim($this->configCache->get('database', 'database'));
+ $charset = trim($this->configCache->get('database', 'charset'));
+ $socket = trim($this->configCache->get('database', 'socket'));
- if (!(strlen($server) && strlen($user))) {
+ if (!$host && !$socket || !$user) {
return false;
}
if (!$this->configCache->get('database', 'disable_pdo') && class_exists('\PDO') && in_array('mysql', PDO::getAvailableDrivers())) {
$this->driver = self::PDO;
- $connect = "mysql:host=" . $server . ";dbname=" . $db;
-
- if ($port > 0) {
- $connect .= ";port=" . $port;
+ if ($socket) {
+ $connect = 'mysql:unix_socket=' . $socket;
+ } else {
+ $connect = 'mysql:host=' . $host;
+ if ($port > 0) {
+ $connect .= ';port=' . $port;
+ }
}
if ($charset) {
- $connect .= ";charset=" . $charset;
+ $connect .= ';charset=' . $charset;
}
- if ($socket) {
- $connect .= ";$unix_socket=" . $socket;
- }
+ $connect .= ';dbname=' . $database;
try {
$this->connection = @new PDO($connect, $user, $pass, [PDO::ATTR_PERSISTENT => $persistent]);
if (!$this->connected && class_exists('\mysqli')) {
$this->driver = self::MYSQLI;
- if ($port > 0) {
- $this->connection = @new mysqli($server, $user, $pass, $db, $port);
+ if ($socket) {
+ $this->connection = @new mysqli(null, $user, $pass, $database, null, $socket);
+ } elseif ($port > 0) {
+ $this->connection = @new mysqli($host, $user, $pass, $database, $port);
} else {
- $this->connection = @new mysqli($server, $user, $pass, $db);
+ $this->connection = @new mysqli($host, $user, $pass, $database);
}
if (!mysqli_connect_errno()) {
if ($charset) {
$this->connection->set_charset($charset);
}
-
- if ($socket) {
- $this->connection->set_socket($socket);
- }
-
}
}
// No suitable SQL driver was found.
if (!$this->connected) {
- $this->driver = null;
+ $this->driver = '';
$this->connection = null;
}
{
$this->testmode = $test;
}
+
/**
* Sets the logger for DBA
*
{
$this->profiler = $profiler;
}
+
/**
* Disconnects the current database connection
*/
}
}
- $this->driver = null;
+ $this->driver = '';
$this->connected = false;
}
}
$watchlist = explode(',', $this->configCache->get('system', 'db_log_index_watch'));
- $denylist = explode(',', $this->configCache->get('system', 'db_log_index_denylist'));
+ $denylist = explode(',', $this->configCache->get('system', 'db_log_index_denylist'));
while ($row = $this->fetch($r)) {
if ((intval($this->configCache->get('system', 'db_loglimit_index')) > 0)) {
$log = (in_array($row['key'], $watchlist) &&
- ($row['rows'] >= intval($this->configCache->get('system', 'db_loglimit_index'))));
+ ($row['rows'] >= intval($this->configCache->get('system', 'db_loglimit_index'))));
} else {
$log = false;
}
if ($log) {
$backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
- @file_put_contents($this->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, 4000) . "\n", FILE_APPEND);
+ @file_put_contents(
+ $this->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, 4000) . "\n",
+ FILE_APPEND
+ );
}
}
}
{
$server_info = $this->serverInfo();
if (version_compare($server_info, '5.7.5', '<') ||
- (stripos($server_info, 'MariaDB') !== false)) {
+ (stripos($server_info, 'MariaDB') !== false)) {
$sql = str_ireplace('ANY_VALUE(', 'MIN(', $sql);
}
return $sql;
if (count($args) == 0) {
if (!$retval = $this->connection->query($this->replaceParameters($sql, $args))) {
$errorInfo = $this->connection->errorInfo();
- $this->error = $errorInfo[2];
- $this->errorno = (int) $errorInfo[1];
+ $this->error = (string)$errorInfo[2];
+ $this->errorno = (int)$errorInfo[1];
$retval = false;
$is_error = true;
break;
/** @var $stmt mysqli_stmt|PDOStatement */
if (!$stmt = $this->connection->prepare($sql)) {
$errorInfo = $this->connection->errorInfo();
- $this->error = $errorInfo[2];
- $this->errorno = (int) $errorInfo[1];
+ $this->error = (string)$errorInfo[2];
+ $this->errorno = (int)$errorInfo[1];
$retval = false;
$is_error = true;
break;
if (!$stmt->execute()) {
$errorInfo = $stmt->errorInfo();
- $this->error = $errorInfo[2];
- $this->errorno = (int) $errorInfo[1];
+ $this->error = (string)$errorInfo[2];
+ $this->errorno = (int)$errorInfo[1];
$retval = false;
$is_error = true;
} else {
if (!$can_be_prepared || (count($args) == 0)) {
$retval = $this->connection->query($this->replaceParameters($sql, $args));
if ($this->connection->errno) {
- $this->error = $this->connection->error;
- $this->errorno = $this->connection->errno;
+ $this->error = (string)$this->connection->error;
+ $this->errorno = (int)$this->connection->errno;
$retval = false;
$is_error = true;
} else {
$stmt = $this->connection->stmt_init();
if (!$stmt->prepare($sql)) {
- $this->error = $stmt->error;
- $this->errorno = $stmt->errno;
+ $this->error = (string)$stmt->error;
+ $this->errorno = (int)$stmt->errno;
$retval = false;
$is_error = true;
break;
} elseif (is_string($args[$param])) {
$param_types .= 's';
} elseif (is_object($args[$param]) && method_exists($args[$param], '__toString')) {
- $param_types .= 's';
+ $param_types .= 's';
$args[$param] = (string)$args[$param];
} else {
$param_types .= 'b';
}
if (!$stmt->execute()) {
- $this->error = $this->connection->error;
- $this->errorno = $this->connection->errno;
+ $this->error = (string)$this->connection->error;
+ $this->errorno = (int)$this->connection->errno;
$retval = false;
$is_error = true;
} else {
}
}
- $this->error = $error;
- $this->errorno = (int) $errorno;
+ $this->error = (string)$error;
+ $this->errorno = (int)$errorno;
}
$this->profiler->stopRecording();
$duration = round($duration, 3);
$backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
- @file_put_contents($this->configCache->get('system', 'db_log'), DateTimeFormat::utcNow() . "\t" . $duration . "\t" .
- basename($backtrace[1]["file"]) . "\t" .
- $backtrace[1]["line"] . "\t" . $backtrace[2]["function"] . "\t" .
- substr($this->replaceParameters($sql, $args), 0, 4000) . "\n", FILE_APPEND);
+ @file_put_contents(
+ $this->configCache->get('system', 'db_log'),
+ DateTimeFormat::utcNow() . "\t" . $duration . "\t" .
+ basename($backtrace[1]["file"]) . "\t" .
+ $backtrace[1]["line"] . "\t" . $backtrace[2]["function"] . "\t" .
+ substr($this->replaceParameters($sql, $args), 0, 4000) . "\n",
+ FILE_APPEND
+ );
}
}
return $retval;
/**
* Check if data exists
*
- * @param string|array $table Table name or array [schema => table]
- * @param array $condition array of fields for condition
+ * @param string $table Table name in format [schema.]table
+ * @param array $condition Array of fields for condition
*
* @return boolean Are there rows for that condition?
* @throws \Exception
+ * @todo Please unwrap the DBStructure::existsTable() call so this method has one behavior only: checking existence on records
*/
- public function exists($table, array $condition): bool
+ public function exists(string $table, array $condition): bool
{
if (empty($table)) {
return false;
/**
* Insert a row into a table. Field value objects will be cast as string.
*
- * @param string|array $table Table name or array [schema => table]
- * @param array $param parameter array
- * @param int $duplicate_mode What to do on a duplicated entry
+ * @param string $table Table name in format [schema.]table
+ * @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 function insert($table, array $param, int $duplicate_mode = self::INSERT_DEFAULT): bool
+ public function insert(string $table, array $param, int $duplicate_mode = self::INSERT_DEFAULT): bool
{
if (empty($table) || empty($param)) {
$this->logger->info('Table and fields have to be set');
$param = $this->castFields($table, $param);
- $table_string = DBA::buildTableString($table);
+ $table_string = DBA::buildTableString([$table]);
$fields_string = implode(', ', array_map([DBA::class, 'quoteIdentifier'], array_keys($param)));
* 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.
*
- * @param string|array $table Table name or array [schema => table]
- * @param array $param parameter array
- *
+ * @param string $table Table name in format [schema.]table
+ * @param array $param parameter array
* @return boolean was the insert successful?
* @throws \Exception
*/
- public function replace($table, array $param): bool
+ public function replace(string $table, array $param): bool
{
if (empty($table) || empty($param)) {
$this->logger->info('Table and fields have to be set');
$param = $this->castFields($table, $param);
- $table_string = DBA::buildTableString($table);
+ $table_string = DBA::buildTableString([$table]);
$fields_string = implode(', ', array_map([DBA::class, 'quoteIdentifier'], array_keys($param)));
*
* This function can be extended in the future to accept a table array as well.
*
- * @param string|array $table Table name or array [schema => table]
- *
+ * @param string $table Table name in format [schema.]table
* @return boolean was the lock successful?
* @throws \Exception
*/
- public function lock($table): bool
+ public function lock(string $table): bool
{
// See here: https://dev.mysql.com/doc/refman/5.7/en/lock-tables-and-transactions.html
if ($this->driver == self::PDO) {
$this->connection->autocommit(false);
}
- $success = $this->e("LOCK TABLES " . DBA::buildTableString($table) . " WRITE");
+ $success = $this->e("LOCK TABLES " . DBA::buildTableString([$table]) . " WRITE");
if ($this->driver == self::PDO) {
$this->connection->setAttribute(PDO::ATTR_EMULATE_PREPARES, $this->pdo_emulate_prepares);
* @return boolean was the delete successful?
* @throws \Exception
*/
- public function delete($table, array $conditions): bool
+ public function delete(string $table, array $conditions): bool
{
if (empty($table) || empty($conditions)) {
$this->logger->info('Table and conditions have to be set');
return false;
}
- $table_string = DBA::buildTableString($table);
+ $table_string = DBA::buildTableString([$table]);
$condition_string = DBA::buildCondition($conditions);
* 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|array $table Table name or array [schema => table]
+ * @param string $table Table name in format [schema.]table
* @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, false = don't update identical fields)
* @throws \Exception
* @todo Implement "bool $update_on_duplicate" to avoid mixed type for $old_fields
*/
- public function update($table, array $fields, array $condition, $old_fields = [], array $params = [])
+ public function update(string $table, array $fields, array $condition, $old_fields = [], array $params = [])
{
if (empty($table) || empty($fields) || empty($condition)) {
$this->logger->info('Table, fields and condition have to be set');
$fields = $this->castFields($table, $fields);
- $table_string = DBA::buildTableString($table);
+ $table_string = DBA::buildTableString([$table]);
$condition_string = DBA::buildCondition($condition);
. $condition_string;
// Combines the updated fields parameter values with the condition parameter values
- $params = array_merge(array_values($fields), $condition);
+ $params = array_merge(array_values($fields), $condition);
return $this->e($sql, $params);
}
/**
* Retrieve a single record from a table and returns it in an associative array
*
- * @param string|array $table
- * @param array $fields
- * @param array $condition
- * @param array $params
+ * @param string $table Table name in format [schema.]table
+ * @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 bool|array
* @throws \Exception
* @see $this->select
*/
- public function selectFirst($table, array $fields = [], array $condition = [], array $params = [])
+ public function selectFirst(string $table, array $fields = [], array $condition = [], array $params = [])
{
$params['limit'] = 1;
$result = $this->select($table, $fields, $condition, $params);
/**
* Select rows from a table and fills an array with the data
*
- * @param string|array $table Table name or array [schema => table]
- * @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
- *
+ * @param string $table Table name in format [schema.]table
+ * @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 function selectToArray($table, array $fields = [], array $condition = [], array $params = [])
+ public function selectToArray(string $table, array $fields = [], array $condition = [], array $params = [])
{
return $this->toArray($this->select($table, $fields, $condition, $params));
}
/**
* Escape fields, adding special treatment for "group by" handling
*
- * @param array $fields
- * @param array $options
+ * @param array $fields
+ * @param array $options
* @return array Escaped fields
*/
private function escapeFields(array $fields, array $options): array
}
}
- array_walk($fields, function(&$value, $key) use ($options)
- {
+ array_walk($fields, function (&$value, $key) use ($options) {
$field = $value;
- $value = '`' . str_replace('`', '``', $value) . '`';
+ $value = DBA::quoteIdentifier($field);
if (!empty($options['group_by']) && !in_array($field, $options['group_by'])) {
$value = 'ANY_VALUE(' . $value . ') AS ' . $value;
*
* $data = DBA::select($table, $fields, $condition, $params);
*
- * @param string|array $table Table name or array [schema => table]
- * @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
+ * @param string $table Table name in format [schema.]table
+ * @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
* @throws \Exception
*/
- public function select($table, array $fields = [], array $condition = [], array $params = [])
+ public function select(string $table, array $fields = [], array $condition = [], array $params = [])
{
if (empty($table)) {
return false;
}
if (count($fields) > 0) {
- $fields = $this->escapeFields($fields, $params);
+ $fields = $this->escapeFields($fields, $params);
$select_string = implode(', ', $fields);
} else {
$select_string = '*';
}
- $table_string = DBA::buildTableString($table);
+ $table_string = DBA::buildTableString([$table]);
$condition_string = DBA::buildCondition($condition);
/**
* Counts the rows from a table satisfying the provided condition
*
- * @param string|array $table Table name or array [schema => table]
- * @param array $condition Array of fields for condition
- * @param array $params Array of several parameters
+ * @param string $table Table name in format [schema.]table
+ * @param array $condition Array of fields for condition
+ * @param array $params Array of several parameters
*
* @return int Count of rows
*
* $count = DBA::count($table, $condition);
* @throws \Exception
*/
- public function count($table, array $condition = [], array $params = []): int
+ public function count(string $table, array $condition = [], array $params = []): int
{
if (empty($table)) {
throw new InvalidArgumentException('Parameter "table" cannot be empty.');
}
- $table_string = DBA::buildTableString($table);
+ $table_string = DBA::buildTableString([$table]);
$condition_string = DBA::buildCondition($condition);
$types = [];
- $tables = DBStructure::definition('', false);
+ $tables = $this->dbaDefinition->getAll();
if (empty($tables[$table])) {
// When a matching table wasn't found we check if it is a view
- $views = View::definition('', false);
+ $views = $this->viewDefinition->getAll();
if (empty($views[$table])) {
return $fields;
}
- foreach(array_keys($fields) as $field) {
+ foreach (array_keys($fields) as $field) {
if (!empty($views[$table]['fields'][$field])) {
$viewdef = $views[$table]['fields'][$field];
if (!empty($tables[$viewdef[0]]['fields'][$viewdef[1]]['type'])) {
*/
public function processlist(): array
{
- $ret = $this->p("SHOW PROCESSLIST");
+ $ret = $this->p('SHOW PROCESSLIST');
$data = $this->toArray($ret);
$processes = 0;
$states = [];
foreach ($data as $process) {
- $state = trim($process["State"]);
+ $state = trim($process['State']);
// Filter out all non blocking processes
- if (!in_array($state, ["", "init", "statistics", "updating"])) {
+ if (!in_array($state, ['', 'init', 'statistics', 'updating'])) {
++$states[$state];
++$processes;
}
}
- $statelist = "";
+ $statelist = '';
foreach ($states as $state => $usage) {
- if ($statelist != "") {
- $statelist .= ", ";
+ if ($statelist != '') {
+ $statelist .= ', ';
}
- $statelist .= $state . ": " . $usage;
+ $statelist .= $state . ': ' . $usage;
}
- return (["list" => $statelist, "amount" => $processes]);
+ return (['list' => $statelist, 'amount' => $processes]);
}
/**
* Fetch a database variable
*
* @param string $name
- * @return string content
+ * @return string|null content or null if inexistent
+ * @throws \Exception
*/
- public function getVariable(string $name): string
+ public function getVariable(string $name)
{
$result = $this->fetchFirst("SHOW GLOBAL VARIABLES WHERE `Variable_name` = ?", $name);
return $result['Value'] ?? null;
* Checks if $array is a filled array with at least one entry.
*
* @param mixed $array A filled array with at least one entry
- *
* @return boolean Whether $array is a filled array or an object with rows
*/
public function isResult($array): bool
/**
* Replaces a string in the provided fields of the provided table
*
- * @param string $table_name Table name
- * @param array $fields List of field names in the provided table
- * @param string $search
- * @param string $replace
+ * @param string $table Table name
+ * @param array $fields List of field names in the provided table
+ * @param string $search String to search for
+ * @param string $replace String to replace with
* @return void
* @throws \Exception
*/
- public function replaceInTableFields(string $table_name, array $fields, string $search, string $replace)
+ public function replaceInTableFields(string $table, array $fields, string $search, string $replace)
{
- $search = $this->escape($search);
+ $search = $this->escape($search);
$replace = $this->escape($replace);
$upd = [];
$upds = implode(', ', $upd);
- $r = $this->e(sprintf("UPDATE %s SET %s;", $table_name, $upds));
+ $r = $this->e(sprintf("UPDATE %s SET %s;", DBA::quoteIdentifier($table), $upds));
+
if (!$this->isResult($r)) {
- throw new \RuntimeException("Failed updating `$table_name`: " . $this->errorMessage());
+ throw new \RuntimeException("Failed updating `$table`: " . $this->errorMessage());
}
}
}
projects / friendica.git / blobdiff