X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FDatabase%2FDatabase.php;h=b5d4963923801ceddc50009a327f419753dc9847;hb=ce69026964ffe2eb514223c3458ac27cf6d049b9;hp=e5dec2d75e6b074b9da6802e9c9509b64ae2db8d;hpb=fa973d3b0f6459961ad0ded48626817147ccbc81;p=friendica.git diff --git a/src/Database/Database.php b/src/Database/Database.php index e5dec2d75e..b5d4963923 100644 --- a/src/Database/Database.php +++ b/src/Database/Database.php @@ -23,6 +23,8 @@ namespace Friendica\Database; 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; @@ -34,18 +36,19 @@ use PDO; 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; @@ -61,32 +64,35 @@ class Database * @var LoggerInterface */ protected $logger; - protected $server_info = ''; + protected $server_info = ''; /** @var PDO|mysqli */ protected $connection; 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(); } /** @@ -104,25 +110,24 @@ class Database $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; } @@ -132,19 +137,20 @@ class Database 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]); @@ -159,10 +165,12 @@ class Database 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()) { @@ -171,11 +179,6 @@ class Database if ($charset) { $this->connection->set_charset($charset); } - - if ($socket) { - $this->connection->set_socket($socket); - } - } } @@ -192,6 +195,7 @@ class Database { $this->testmode = $test; } + /** * Sets the logger for DBA * @@ -216,6 +220,7 @@ class Database { $this->profiler = $profiler; } + /** * Disconnects the current database connection */ @@ -332,12 +337,12 @@ class Database } $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; } @@ -352,11 +357,15 @@ class Database 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 + ); } } } @@ -443,7 +452,7 @@ class Database { $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; @@ -555,8 +564,8 @@ class Database 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; @@ -568,8 +577,8 @@ class Database /** @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; @@ -588,8 +597,8 @@ class Database 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 { @@ -607,8 +616,8 @@ class Database 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 { @@ -624,8 +633,8 @@ class Database $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; @@ -641,7 +650,7 @@ class Database } 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'; @@ -655,8 +664,8 @@ class Database } 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 { @@ -723,8 +732,8 @@ class Database } } - $this->error = $error; - $this->errorno = (int) $errorno; + $this->error = (string)$error; + $this->errorno = (int)$errorno; } $this->profiler->stopRecording(); @@ -737,10 +746,14 @@ class Database $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; @@ -820,11 +833,12 @@ class Database /** * Check if data exists * - * @param string $table Table name in format schema.table (while scheme is optiona) + * @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(string $table, array $condition): bool { @@ -1003,7 +1017,7 @@ class Database /** * Insert a row into a table. Field value objects will be cast as string. * - * @param string $table Table name in format schema.table (while scheme is optiona) + * @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 * @@ -1054,7 +1068,7 @@ class Database * 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 $table Table name in format schema.table (while scheme is optiona) + * @param string $table Table name in format [schema.]table * @param array $param parameter array * @return boolean was the insert successful? * @throws \Exception @@ -1102,7 +1116,7 @@ class Database * * This function can be extended in the future to accept a table array as well. * - * @param string $table Table name in format schema.table (while scheme is optiona) + * @param string $table Table name in format [schema.]table * @return boolean was the lock successful? * @throws \Exception */ @@ -1300,7 +1314,7 @@ class Database * 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 in format schema.table (while scheme is optiona) + * @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) @@ -1358,7 +1372,7 @@ class Database . $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); } @@ -1366,7 +1380,7 @@ class Database /** * Retrieve a single record from a table and returns it in an associative array * - * @param string $table Table name in format schema.table (while scheme is optiona) + * @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 @@ -1392,7 +1406,7 @@ class Database /** * Select rows from a table and fills an array with the data * - * @param string $table Table name in format schema.table (while scheme is optiona) + * @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 @@ -1408,8 +1422,8 @@ class Database /** * 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 @@ -1431,10 +1445,9 @@ class Database } } - 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; @@ -1466,7 +1479,7 @@ class Database * * $data = DBA::select($table, $fields, $condition, $params); * - * @param string $table Table name in format schema.table (while scheme is optiona) + * @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 @@ -1480,7 +1493,7 @@ class Database } if (count($fields) > 0) { - $fields = $this->escapeFields($fields, $params); + $fields = $this->escapeFields($fields, $params); $select_string = implode(', ', $fields); } else { $select_string = '*'; @@ -1506,7 +1519,7 @@ class Database /** * Counts the rows from a table satisfying the provided condition * - * @param string $table Table name in format schema.table (while scheme is optiona) + * @param string $table Table name in format [schema.]table * @param array $condition Array of fields for condition * @param array $params Array of several parameters * @@ -1608,10 +1621,10 @@ class Database $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; } @@ -1719,29 +1732,29 @@ class Database */ 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]); } /** @@ -1761,7 +1774,6 @@ class Database * 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 @@ -1821,16 +1833,16 @@ class Database /** * 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 $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); + $search = $this->escape($search); $replace = $this->escape($replace); $upd = []; @@ -1842,6 +1854,7 @@ class Database $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()); }