Database::write() - Code Metrics - Inspection of "Merge pull request #1094 from hemberger/database-r..." - smrealms/smr - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions
Push — master ( f174b5...646f17 )

by Dan
created 2021-07-01 07:44 UTC
Database::write() A

↳ Parent: Database
Complexity

Conditions	2
Paths	2
Size

Total Lines	4
Code Lines	3
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	2
eloc	3
c	0
b	0
f	0
nc	2
nop	1
dl	0
loc	4
rs	10
<?php declare(strict_types=1);

namespace Smr;

use mysqli;
use mysqli_result;
use RuntimeException;
use Smr\Container\DiContainer;
use Smr\DatabaseProperties;

/**
 * Wraps an active connection to the database.
 * Primarily provides query, escaping, and locking methods.
 */
class Database {

	/**
	 * Returns the instance of this class from the DI container.
	 * If one does not exist yet, it will be created.
	 * This is the intended way to construct this class.
	 */
	public static function getInstance() : self {
		return DiContainer::get(self::class);
	}

	/**
	 * Used by the DI container to construct a mysqli instance.
	 * Not intended to be used outside the DI context.
	 */
	public static function mysqliFactory(DatabaseProperties $dbProperties) : mysqli {
		if (!mysqli_report(MYSQLI_REPORT_ERROR|MYSQLI_REPORT_STRICT)) {
			throw new RuntimeException('Failed to enable mysqli error reporting');
		}
		$mysql = new mysqli(
			$dbProperties->getHost(),
			$dbProperties->getUser(),
			$dbProperties->getPassword(),
			$dbProperties->getDatabaseName());
		$charset = $mysql->character_set_name();
		if ($charset != 'utf8') {
			throw new RuntimeException('Unexpected charset: ' . $charset);
		}
		return $mysql;
	}

	/**
	 * Database constructor.
	 * Not intended to be constructed by hand. If you need an instance of Database,
	 * use Database::getInstance();
	 * @param mysqli $dbConn The mysqli instance
	 * @param DatabaseProperties $dbProperties The properties object that was used to construct the mysqli instance
	 */
	public function __construct(
		private mysqli $dbConn,
		private DatabaseProperties $dbProperties,
	) {}

	/**
	 * This method will switch the connection to the specified database.
	 * Useful for switching back and forth between historical, and live databases.
	 *
	 * @param string $databaseName The name of the database to switch to
	 */
	public function switchDatabases(string $databaseName) : void {
		$this->dbConn->select_db($databaseName);
	}

	/**
	 * Switch back to the configured live database
	 */
	public function switchDatabaseToLive() : void {
		$this->switchDatabases($this->dbProperties->getDatabaseName());
	}

	/**
	 * Returns the size of the live database in bytes.
	 */
	public function getDbBytes() : int {
		$query = 'SELECT SUM(data_length + index_length) as db_bytes FROM information_schema.tables WHERE table_schema=' . $this->escapeString($this->dbProperties->getDatabaseName());
		return $this->read($query)->record()->getInt('db_bytes');
	}

	/**
	 * This should not be needed except perhaps by persistent connections
	 *
	 * Closes the connection to the MySQL database. After closing this connection,
	 * this instance is no longer valid, and will subsequently throw exceptions when
	 * attempting to perform database operations.
	 *
	 * Once the connection is closed, you must call Database::reconnect() before
	 * any further database queries can be made.
	 *
	 * @return bool Whether the underlying connection was closed by this call.
	 */
	public function close() : bool {
		if (!isset($this->dbConn)) {
			// Connection is already closed; nothing to do.
			return false;
		}
		$this->dbConn->close();
		unset($this->dbConn);
		// Set the mysqli instance in the dependency injection container to
		// null so that we don't accidentally try to use it.
		DiContainer::getContainer()->set(mysqli::class, null);
		return true;
	}

	/**
	 * Reconnects to the MySQL database, and replaces the managed mysqli instance
	 * in the dependency injection container for future retrievals.
	 * @throws \DI\DependencyException
	 * @throws \DI\NotFoundException
	 */
	public function reconnect() : void {
		if (isset($this->dbConn)) {
			return; // No reconnect needed
		}
		$newMysqli = DiContainer::make(mysqli::class);
		DiContainer::getContainer()->set(mysqli::class, $newMysqli);
		$this->dbConn = $newMysqli;
	}

	/**
	 * Perform a write-only query on the database.
	 * Used for UPDATE, DELETE, REPLACE and INSERT queries, for example.
	 */
	public function write(string $query) : void {
		$result = $this->dbConn->query($query);
		if ($result !== true) {
			throw new RuntimeException('Wrong query type');
		}
	}

	/**
	 * Perform a read-only query on the database.
	 * Used for SELECT queries, for example.
	 */
	public function read(string $query) : DatabaseResult {
		return new DatabaseResult($this->dbConn->query($query));
		return new DatabaseResult(/** @scrutinizer ignore-type */ $this->dbConn->query($query));
	}

	public function lockTable(string $table) : void {
		$this->write('LOCK TABLES ' . $table . ' WRITE');
	}

	public function unlock() : void {
		$this->write('UNLOCK TABLES');
	}

	public function getChangedRows() : int {
		return $this->dbConn->affected_rows;
	}

	public function getInsertID() : int {
		return $this->dbConn->insert_id;
	}

	public function escape($escape) {
		if (is_bool($escape)) {
			return $this->escapeBoolean($escape);
		}
		if (is_numeric($escape)) {
			return $this->escapeNumber($escape);
		}
		if (is_string($escape)) {
			return $this->escapeString($escape);
		}
		if (is_array($escape)) {
			return $this->escapeArray($escape);
		}
		if (is_object($escape)) {
			return $this->escapeObject($escape);
		}
	}

	public function escapeString(?string $string, bool $nullable = false) : string {
		if ($nullable === true && ($string === null || $string === '')) {
			return 'NULL';
		}
		return '\'' . $this->dbConn->real_escape_string($string) . '\'';
	}

	public function escapeBinary($binary) {
		return '0x' . bin2hex($binary);
	}

	/**
	 * Warning: If escaping a nested array, use escapeIndividually=true,
	 * but beware that the escaped array is flattened!
	 */
	public function escapeArray(array $array, string $delimiter = ',', bool $escapeIndividually = true) : string {
		if ($escapeIndividually) {
			$string = join($delimiter, array_map(function($item) { return $this->escape($item); }, $array));
		} else {
			$string = $this->escape(join($delimiter, $array));
		}
		return $string;
	}

	public function escapeNumber(mixed $num) : mixed {
		// Numbers need not be quoted in MySQL queries, so if we know $num is
		// numeric, we can simply return its value (no quoting or escaping).
		if (!is_numeric($num)) {
			throw new RuntimeException('Not a number: ' . $num);
		}
		return $num;
	}

	public function escapeMicrotime(float $microtime) : string {
		// Retain all digits of precision for storing in a MySQL bigint
		return sprintf('%d', $microtime * 1E6);
	}

	public function escapeBoolean(bool $bool) : string {
		// We store booleans as an enum
		if ($bool) {
			return '\'TRUE\'';
		} else {
			return '\'FALSE\'';
		}
	}

	public function escapeObject(mixed $object, bool $compress = false, bool $nullable = false) : string {
		if ($nullable === true && $object === null) {
			return 'NULL';
		}
		if ($compress === true) {
			return $this->escapeBinary(gzcompress(serialize($object)));
		}
		return $this->escapeString(serialize($object));
	}
}

smrealms / smr

Scrutinizer GitHub App not installed

Push — master ( f174b5...646f17 )

Database::write() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
