Mysqli.php

<?php /** @noinspection PhpComposerExtensionStubsInspection */

namespace Aternos\Model\Driver\Mysqli;

use Aternos\Model\{Driver\Driver,
    Driver\Features\CRUDAbleInterface,
    Driver\Features\CRUDQueryableInterface,
    ModelInterface,
    Query\DeleteQuery,
    Query\Generator\SQL,
    Query\Query,
    Query\QueryResult,
    Query\UpdateQuery
};
use Exception;
use mysqli_result;

/**
 * Class Mysqli
 *
 * Inherit this class, overwrite the connect function
 * and/or the protected connection specific properties
 * and register the new class in the driver factory
 * for other credentials or connect specifics
 *
 * @package Aternos\Model\Driver
 */
class Mysqli extends Driver implements CRUDAbleInterface, CRUDQueryableInterface
{
    public const ID = "mysqli";
    protected string $id = self::ID;

    /**
     * Host address
     *
     * @var string|null
     */
    protected ?string $host = null;

    /**
     * Host port
     *
     * @var int|null
     */
    protected ?int $port = null;

    /**
     * Authentication username
     *
     * @var string|null
     */
    protected ?string $username = null;

    /**
     * Authentication password
     *
     * @var string|null
     */
    protected ?string $password = null;

    /**
     * Socket path or pipe
     *
     * @var string|null
     */
    protected ?string $socket = null;

    /**
     * Database name
     *
     * @var string
     */
    protected string $database = "data";

    /**
     * @var \mysqli|null
     */
    protected ?\mysqli $connection = null;

    /**
     * Mysqli constructor.
     *
     * @param string|null $host
     * @param int|null $port
     * @param string|null $username
     * @param string|null $password
     * @param string|null $socket
     * @param string|null $database
     */
    public function __construct(?string $host = null, ?int $port = null, ?string $username = null, ?string $password = null, ?string $socket = null, ?string $database = null)
    {
        $this->host = $host ?? $this->host;
        $this->port = $port ?? $this->port;
        $this->username = $username ?? $this->username;
        $this->password = $password ?? $this->password;
        $this->socket = $socket ?? $this->socket;
        $this->database = $database ?? $this->database;
    }

    /**
     * Connect to database
     *
     * @throws Exception
     */
    protected function connect(): void
    {
        if (!$this->connection || !@mysqli_ping($this->connection)) {
            $this->connection = mysqli_connect($this->host, $this->username, $this->password, $this->database, $this->port, $this->socket);
            if (!$this->connection) {
                throw new Exception("Could not connect to Mysqli database. Error: " . mysqli_error($this->connection));
            }
        }
    }

    /**
     * Execute a mysql query
     *
     * @param string $query
     * @return bool|mysqli_result
     * @throws Exception
     */
    protected function rawQuery(string $query): mysqli_result|bool
    {
        $this->connect();
        $result = mysqli_query($this->connection, $query);

        if (mysqli_error($this->connection)) {
            throw new Exception("MySQLi Error #" . mysqli_errno($this->connection) . ": " . mysqli_error($this->connection));
        }

        return $result;
    }

    /**
     * Save the model
     *
     * @param ModelInterface $model
     * @return bool
     * @throws Exception
     */
    public function save(ModelInterface $model): bool
    {
        $this->connect();

        $table = $model::getName();

        $modelValues = get_object_vars($model);
        $columns = [];
        $values = [];
        foreach ($modelValues as $key => $value) {
            $columns[] = "`" . $key . "`";
            if (is_int($value) || is_float($value)) {
                $values[] = $value;
            } else if (is_null($value)) {
                $values[] = "NULL";
            } else {
                $values[] = "'" . mysqli_real_escape_string($this->connection, $value) . "'";
            }
        }

        $updates = [];
        foreach ($modelValues as $column => $modelValue) {
            if (is_int($modelValue) || is_float($modelValue)) {
                $updates[] = "`" . $column . "`=" . $modelValue;
            } else if (is_null($modelValue)) {
                $updates[] = "`" . $column . "`=NULL";
            } else {
                $updates[] = "`" . $column . "`='" . mysqli_real_escape_string($this->connection, $modelValue) . "'";
            }
        }

        $query = "INSERT INTO `" . $table . "` (" . implode(",", $columns) . ") VALUES (" . implode(",", $values) . ") ON DUPLICATE KEY UPDATE " . implode(",", $updates);
        $this->rawQuery($query);

        return true;
    }

    /**
     * Get the model
     *
     * @param class-string<ModelInterface> $modelClass
     * @param mixed $id
     * @param ModelInterface|null $model
     * @return ModelInterface|null
     * @throws Exception
     */
    public function get(string $modelClass, mixed $id, ?ModelInterface $model = null): ?ModelInterface
    {
        $this->connect();
        $table = $modelClass::getName();

        $escapedId = mysqli_real_escape_string($this->connection, $id);
        $query = "SELECT * FROM `" . $table . "` WHERE `" . $modelClass::getIdField() . "` = '" . $escapedId . "'";
        $result = $this->rawQuery($query);
        if (!$result || mysqli_num_rows($result) === 0) {
            return null;
        }

        $row = mysqli_fetch_assoc($result);
        if ($model) {
            return $model->applyData($row);
        }
        return $modelClass::getModelFromData($row);
    }

    /**
     * Delete the model
     *
     * @param ModelInterface $model
     * @return bool
     * @throws Exception
     */
    public function delete(ModelInterface $model): bool
    {
        $this->connect();
        $table = $model::getName();

        $id = mysqli_real_escape_string($this->connection, $model->getId());
        $query = "DELETE FROM `" . $table . "` WHERE `" . $model->getIdField() . "` = '" . $id . "'";
        $this->rawQuery($query);

        return true;
    }

    /**
     * Execute a SELECT, UPDATE or DELETE query
     *
     * @param Query $query
     * @return QueryResult
     * @throws Exception
     */
    public function query(Query $query): QueryResult
    {
        $this->connect();

        $generator = new SQL(function ($value) {
            return mysqli_real_escape_string($this->connection, $value);
        });

        $queryString = $generator->generate($query);

        $rawQueryResult = $this->rawQuery($queryString);

        $result = new QueryResult((bool)$rawQueryResult);
        $result->setQueryString($queryString);
        if ($query instanceof UpdateQuery || $query instanceof DeleteQuery) {
            $result->setAffectedRows(mysqli_affected_rows($this->connection));
            return $result;
        }

        if (is_bool($rawQueryResult)) {
            return $result;
        }

        while ($row = mysqli_fetch_assoc($rawQueryResult)) {
            /** @var class-string<ModelInterface> $modelClass */
            $modelClass = $query->modelClassName;
            $model = $modelClass::getModelFromData($row);
            if ($model) {
                $result->add($model);
            }
        }

        return $result;
    }

    /**
     * @param string|null $host
     * @return Mysqli
     */
    public function setHost(?string $host): Mysqli
    {
        $this->host = $host;
        return $this;
    }

    /**
     * @param int|null $port
     * @return Mysqli
     */
    public function setPort(?int $port): Mysqli
    {
        $this->port = $port;
        return $this;
    }

    /**
     * @param string|null $username
     * @return Mysqli
     */
    public function setUsername(?string $username): Mysqli
    {
        $this->username = $username;
        return $this;
    }

    /**
     * @param string|null $password
     * @return Mysqli
     */
    public function setPassword(?string $password): Mysqli
    {
        $this->password = $password;
        return $this;
    }

    /**
     * @param string|null $socket
     * @return Mysqli
     */
    public function setSocket(?string $socket): Mysqli
    {
        $this->socket = $socket;
        return $this;
    }

    /**
     * @param string $database
     * @return Mysqli
     */
    public function setDatabase(string $database): Mysqli
    {
        $this->database = $database;
        return $this;
    }
}