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 InvalidArgumentException;
use mysqli;
use mysqli_result;
use mysqli_stmt;
protected $server_info = '';
/** @var PDO|mysqli */
protected $connection;
- protected $driver;
+ protected $driver = '';
protected $pdo_emulate_prepares = false;
private $error = false;
private $errorno = 0;
protected $in_retrial = false;
protected $testmode = false;
private $relation = [];
+ /** @var DbaDefinition */
+ protected $dbaDefinition;
+ /** @var ViewDefinition */
+ protected $viewDefinition;
- public function __construct(Cache $configCache, Profiler $profiler, LoggerInterface $logger)
+ public function __construct(Cache $configCache, Profiler $profiler, DbaDefinition $dbaDefinition, ViewDefinition $viewDefinition, LoggerInterface $logger)
{
// 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->logger = $logger;
+ $this->dbaDefinition = $dbaDefinition;
+ $this->viewDefinition = $viewDefinition;
$this->connect();
-
- if ($this->isConnected()) {
- // Loads DB_UPDATE_VERSION constant
- DBStructure::definition($configCache->get('system', 'basepath'), false);
- }
}
- public function connect()
+ /**
+ * Tries to connect to database
+ *
+ * @return bool Success
+ */
+ public function connect(): bool
{
if (!is_null($this->connection) && $this->connected()) {
return $this->connected;
$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'));
+ $socket = trim($this->configCache->get('database', 'socket'));
if (!(strlen($server) && strlen($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 . ";unix_socket=" . $socket;
+ $connect = "mysql:host=" . $server . ";dbname=" . $db;
if ($port > 0) {
$connect .= ";port=" . $port;
$connect .= ";charset=" . $charset;
}
+ if ($socket) {
+ $connect .= ";$unix_socket=" . $socket;
+ }
+
try {
$this->connection = @new PDO($connect, $user, $pass, [PDO::ATTR_PERSISTENT => $persistent]);
$this->connection->setAttribute(PDO::ATTR_EMULATE_PREPARES, $this->pdo_emulate_prepares);
$this->driver = self::MYSQLI;
if ($port > 0) {
- $this->connection = @new mysqli($server, $user, $pass, $db, $port, $socket);
+ $this->connection = @new mysqli($server, $user, $pass, $db, $port);
} else {
- $this->connection = @new mysqli($server, $user, $pass, $db, $socket);
+ $this->connection = @new mysqli($server, $user, $pass, $db);
}
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->driver = null;
+ $this->driver = '';
$this->connected = false;
}
*
* @return string with either "pdo" or "mysqli"
*/
- public function getDriver()
+ public function getDriver(): string
{
return $this->driver;
}
* 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
+ * @return string Database server information
*/
- public function serverInfo()
+ public function serverInfo(): string
{
if ($this->server_info == '') {
switch ($this->driver) {
/**
* Returns the selected database name
*
- * @return string
+ * @return string Database name
* @throws \Exception
*/
- public function databaseName()
+ public function databaseName(): string
{
$ret = $this->p("SELECT DATABASE() AS `db`");
$data = $this->toArray($ret);
* Analyze a database query and log this if some conditions are met.
*
* @param string $query The database query that will be analyzed
- *
+ * @return void
* @throws \Exception
*/
- private function logIndex($query)
+ private function logIndex(string $query)
{
if (!$this->configCache->get('system', 'db_log_index')) {
* Removes every not allowlisted character from the identifier string
*
* @param string $identifier
- *
* @return string sanitized identifier
* @throws \Exception
*/
- private function sanitizeIdentifier($identifier)
+ private function sanitizeIdentifier(string $identifier): string
{
return preg_replace('/[^A-Za-z0-9_\-]+/', '', $identifier);
}
}
}
- public function isConnected()
+ /**
+ * Returns connected flag
+ *
+ * @return bool Whether connection to database was success
+ */
+ public function isConnected(): bool
{
return $this->connected;
}
+ /**
+ * Checks connection status
+ *
+ * @return bool Whether connection to database was success
+ */
public function connected()
{
$connected = false;
*
* @return string The input SQL string modified if necessary.
*/
- public function anyValueFallback($sql)
+ public function anyValueFallback(string $sql): string
{
$server_info = $this->serverInfo();
if (version_compare($server_info, '5.7.5', '<') ||
*
* @return string The replaced SQL query
*/
- private function replaceParameters($sql, $args)
+ private function replaceParameters(string $sql, array $args): string
{
$offset = 0;
foreach ($args as $param => $value) {
* @return bool|object statement object or result object
* @throws \Exception
*/
- public function p($sql)
+ public function p(string $sql)
{
$this->profiler->startRecording('database');
if (!$retval = $this->connection->query($this->replaceParameters($sql, $args))) {
$errorInfo = $this->connection->errorInfo();
$this->error = $errorInfo[2];
- $this->errorno = $errorInfo[1];
+ $this->errorno = (int) $errorInfo[1];
$retval = false;
$is_error = true;
break;
if (!$stmt = $this->connection->prepare($sql)) {
$errorInfo = $this->connection->errorInfo();
$this->error = $errorInfo[2];
- $this->errorno = $errorInfo[1];
+ $this->errorno = (int) $errorInfo[1];
$retval = false;
$is_error = true;
break;
if (!$stmt->execute()) {
$errorInfo = $stmt->errorInfo();
$this->error = $errorInfo[2];
- $this->errorno = $errorInfo[1];
+ $this->errorno = (int) $errorInfo[1];
$retval = false;
$is_error = true;
} else {
}
$this->error = $error;
- $this->errorno = $errorno;
+ $this->errorno = (int) $errorno;
}
$this->profiler->stopRecording();
* @return boolean Was the query successfull? False is returned only if an error occurred
* @throws \Exception
*/
- public function e($sql)
+ public function e(string $sql): bool
{
+ $retval = false;
$this->profiler->startRecording('database_write');
/**
* 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 (while scheme is optiona)
+ * @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, $condition)
+ public function exists(string $table, array $condition): bool
{
if (empty($table)) {
return false;
*
* @param string $sql SQL statement
*
- * @return array first row of query
+ * @return array|bool first row of query or false on failure
* @throws \Exception
*/
- public function fetchFirst($sql)
+ public function fetchFirst(string $sql)
{
$params = DBA::getParam(func_get_args());
*
* @return int Number of rows
*/
- public function affectedRows()
+ public function affectedRows(): int
{
return $this->affected_rows;
}
*
* @return int Number of columns
*/
- public function columnCount($stmt)
+ public function columnCount($stmt): int
{
if (!is_object($stmt)) {
return 0;
*
* @return int Number of rows
*/
- public function numRows($stmt)
+ public function numRows($stmt): int
{
if (!is_object($stmt)) {
return 0;
*
* @param bool|PDOStatement|mysqli_stmt $stmt statement object
*
- * @return array|false current row
+ * @return array|bool Current row or false on failure
*/
public function fetch($stmt)
{
/**
* 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 (while scheme is optiona)
+ * @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)
+ 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 (while scheme is optiona)
+ * @param array $param parameter array
* @return boolean was the insert successful?
* @throws \Exception
*/
- public function replace($table, array $param)
+ 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)));
*
* @return integer Last inserted id
*/
- public function lastInsertId()
+ public function lastInsertId(): int
{
switch ($this->driver) {
case self::PDO:
*
* 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 (while scheme is optiona)
* @return boolean was the lock successful?
* @throws \Exception
*/
- public function lock($table)
+ 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 unlock successful?
* @throws \Exception
*/
- public function unlock()
+ public function unlock(): bool
{
// See here: https://dev.mysql.com/doc/refman/5.7/en/lock-tables-and-transactions.html
$this->performCommit();
*
* @return boolean Was the command executed successfully?
*/
- public function transaction()
+ public function transaction(): bool
{
if (!$this->performCommit()) {
return false;
return true;
}
- protected function performCommit()
+ /**
+ * Performs the commit
+ *
+ * @return boolean Was the command executed successfully?
+ */
+ protected function performCommit(): bool
{
switch ($this->driver) {
case self::PDO:
*
* @return boolean Was the command executed successfully?
*/
- public function commit()
+ public function commit(): bool
{
if (!$this->performCommit()) {
return false;
*
* @return boolean Was the command executed successfully?
*/
- public function rollback()
+ public function rollback(): bool
{
$ret = false;
$ret = $this->connection->rollback();
break;
}
+
$this->in_transaction = false;
return $ret;
}
* @return boolean was the delete successful?
* @throws \Exception
*/
- public function delete($table, array $conditions)
+ 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 (while scheme is optiona)
* @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)
+ * @param array $params Parameters: "ignore" If set to "true" then the update is done with the ignore parameter
*
* @return boolean was the update successfull?
* @throws \Exception
+ * @todo Implement "bool $update_on_duplicate" to avoid mixed type for $old_fields
*/
- public function update($table, $fields, $condition, $old_fields = [])
+ 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);
- $sql = "UPDATE " . $table_string . " SET "
+ if (!empty($params['ignore'])) {
+ $ignore = 'IGNORE ';
+ } else {
+ $ignore = '';
+ }
+
+ $sql = "UPDATE " . $ignore . $table_string . " SET "
. implode(" = ?, ", array_map([DBA::class, 'quoteIdentifier'], array_keys($fields))) . " = ?"
. $condition_string;
/**
* 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 (while scheme is optiona)
+ * @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 = [], $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 (while scheme is optiona)
+ * @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));
}
*
* @param array $fields
* @param array $options
- * @return array
+ * @return array Escaped fields
*/
- private function escapeFields(array $fields, array $options)
+ private function escapeFields(array $fields, array $options): array
{
// In the case of a "GROUP BY" we have to add all the ORDER fields to the fieldlist.
// This needs to done to apply the "ANY_VALUE(...)" treatment from below to them.
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 (while scheme is optiona)
+ * @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;
$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 (while scheme is optiona)
+ * @param array $condition Array of fields for condition
+ * @param array $params Array of several parameters
*
- * @return int
+ * @return int Count of rows
*
* Example:
* $table = "post";
* $count = DBA::count($table, $condition);
* @throws \Exception
*/
- public function count($table, array $condition = [], array $params = [])
+ public function count(string $table, array $condition = [], array $params = []): int
{
if (empty($table)) {
- return false;
+ throw new InvalidArgumentException('Parameter "table" cannot be empty.');
}
- $table_string = DBA::buildTableString($table);
+ $table_string = DBA::buildTableString([$table]);
$condition_string = DBA::buildCondition($condition);
*
* @return array Data array
*/
- public function toArray($stmt, $do_close = true, int $count = 0)
+ public function toArray($stmt, bool $do_close = true, int $count = 0): array
{
if (is_bool($stmt)) {
return [];
* @param array $fields
* @return array casted fields
*/
- public function castFields(string $table, array $fields) {
+ public function castFields(string $table, array $fields): array
+ {
// When there is no data, we don't need to do something
if (empty($fields)) {
return $fields;
$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'])) {
*
* @return string Error number (0 if no error)
*/
- public function errorNo()
+ public function errorNo(): int
{
return $this->errorno;
}
*
* @return string Error message ('' if no error)
*/
- public function errorMessage()
+ public function errorMessage(): string
{
return $this->error;
}
*
* @return boolean was the close successful?
*/
- public function close($stmt)
+ public function close($stmt): bool
{
$this->profiler->startRecording('database');
* 'amount' => Number of concurrent database processes
* @throws \Exception
*/
- public function processlist()
+ 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)
{
* 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)
+ public function isResult($array): bool
{
// It could be a return value from an update statement
if (is_bool($array)) {
* @param mixed $value Array value
* @param string $key Array key
* @param boolean $add_quotation add quotation marks for string values
- *
* @return void
*/
- private function escapeArrayCallback(&$value, $key, $add_quotation)
+ private function escapeArrayCallback(&$value, string $key, bool $add_quotation)
{
if (!$add_quotation) {
if (is_bool($value)) {
*
* @param mixed $arr Array with values to be escaped
* @param boolean $add_quotation add quotation marks for string values
- *
* @return void
*/
- public function escapeArray(&$arr, $add_quotation = false)
+ public function escapeArray(&$arr, bool $add_quotation = false)
{
array_walk($arr, [$this, 'escapeArrayCallback'], $add_quotation);
}
+
+ /**
+ * Replaces a string in the provided fields of the provided table
+ *
+ * @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, array $fields, string $search, string $replace)
+ {
+ $search = $this->escape($search);
+ $replace = $this->escape($replace);
+
+ $upd = [];
+ foreach ($fields as $field) {
+ $field = DBA::quoteIdentifier($field);
+ $upd[] = "$field = REPLACE($field, '$search', '$replace')";
+ }
+
+ $upds = implode(', ', $upd);
+
+ $r = $this->e(sprintf("UPDATE %s SET %s;", DBA::quoteIdentifier($table), $upds));
+
+ if (!$this->isResult($r)) {
+ throw new \RuntimeException("Failed updating `$table`: " . $this->errorMessage());
+ }
+ }
}