smrealms / smr

src/lib/Default/SmrShip.php

<?php declare(strict_types=1);

use Smr\Database;
use Smr\ShipIllusion;

/**
 * Adds a database layer to an AbstractSmrShip instance.
 * Loads and saves ship properties from/to the database.
 */
class SmrShip extends AbstractSmrShip {

	/** @var array<int, array<int, self>> */
	protected static array $CACHE_SHIPS = [];

	protected readonly string $SQL;

	public static function clearCache(): void {
		self::$CACHE_SHIPS = [];
	}

	public static function saveShips(): void {
		foreach (self::$CACHE_SHIPS as $gameShips) {
			foreach ($gameShips as $ship) {
				$ship->update();
			}
		}
	}

	public static function getShip(AbstractSmrPlayer $player, bool $forceUpdate = false): self {
		if ($forceUpdate || !isset(self::$CACHE_SHIPS[$player->getGameID()][$player->getAccountID()])) {
			$s = new self($player);
			self::$CACHE_SHIPS[$player->getGameID()][$player->getAccountID()] = $s;
		}
		return self::$CACHE_SHIPS[$player->getGameID()][$player->getAccountID()];
	}

	protected function __construct(AbstractSmrPlayer $player) {
		parent::__construct($player);
		$db = Database::getInstance();
		$this->SQL = 'account_id=' . $db->escapeNumber($this->getAccountID()) . ' AND game_id=' . $db->escapeNumber($this->getGameID());

The property SQL is declared read-only in SmrShip.

		$this->loadHardware();
		$this->loadWeapons();
		$this->loadCargo();
		$this->loadCloak();
		$this->loadIllusion();
	}

	public function update(): void {
		$this->updateHardware();
		$this->updateWeapons();
		$this->updateCargo();
		$this->updateCloak();
		$this->updateIllusion();
		// note: SmrShip::setTypeID updates the SmrPlayer only
		$this->getPlayer()->update();
	}

	/**
	 * Initialize the weapons onboard this ship.
	 */
	protected function loadWeapons(): void {
		// determine weapon
		$db = Database::getInstance();
		$dbResult = $db->read('SELECT * FROM ship_has_weapon JOIN weapon_type USING (weapon_type_id)
							WHERE ' . $this->SQL . '
							ORDER BY order_id LIMIT ' . $db->escapeNumber($this->getHardpoints()));

		$this->weapons = [];
		// generate list of weapon names the user transports
		foreach ($dbResult->records() as $dbRecord) {
			$weaponTypeID = $dbRecord->getInt('weapon_type_id');
			$orderID = $dbRecord->getInt('order_id');
			$weapon = SmrWeapon::getWeapon($weaponTypeID, $dbRecord);
			$weapon->setBonusAccuracy($dbRecord->getBoolean('bonus_accuracy'));
			$weapon->setBonusDamage($dbRecord->getBoolean('bonus_damage'));
			$this->weapons[$orderID] = $weapon;
		}
		$this->checkForExcessWeapons();
	}

	protected function loadHardware(): void {
		$this->hardware = [];

		// get currently hardware from db
		$db = Database::getInstance();
		$dbResult = $db->read('SELECT *
							FROM ship_has_hardware
							JOIN hardware_type USING(hardware_type_id)
							WHERE ' . $this->SQL);

		foreach ($dbResult->records() as $dbRecord) {
			$hardwareTypeID = $dbRecord->getInt('hardware_type_id');

			// adding hardware to array
			$this->hardware[$hardwareTypeID] = $dbRecord->getInt('amount');
		}
		$this->checkForExcessHardware();
	}

	protected function loadCargo(): void {
		// initialize cargo array
		$this->cargo = [];

		// get cargo from db
		$db = Database::getInstance();
		$dbResult = $db->read('SELECT * FROM ship_has_cargo WHERE ' . $this->SQL);
		foreach ($dbResult->records() as $dbRecord) {
			// adding cargo and amount to array
			$this->cargo[$dbRecord->getInt('good_id')] = $dbRecord->getInt('amount');
		}
		$this->checkForExcessCargo();
	}

	public function updateCargo(): void {
		if ($this->hasChangedCargo === false) {
			return;
		}
		// write cargo info
		$db = Database::getInstance();
		foreach ($this->getCargo() as $id => $amount) {
			if ($amount > 0) {
				$db->replace('ship_has_cargo', [
					'account_id' => $db->escapeNumber($this->getAccountID()),
					'game_id' => $db->escapeNumber($this->getGameID()),
					'good_id' => $db->escapeNumber($id),
					'amount' => $db->escapeNumber($amount),
				]);
			} else {
				$db->write('DELETE FROM ship_has_cargo WHERE ' . $this->SQL . ' AND good_id = ' . $db->escapeNumber($id));
				// Unset now to omit displaying this good with 0 amount
				// before the next page is loaded.
				unset($this->cargo[$id]);
			}
		}
		$this->hasChangedCargo = false;
	}

	public function updateHardware(): void {
		// write hardware info only for hardware that has changed
		$db = Database::getInstance();
		foreach ($this->hasChangedHardware as $hardwareTypeID => $hasChanged) {
			if ($hasChanged === false) {
				continue;
			}
			$amount = $this->getHardware($hardwareTypeID);
			if ($amount > 0) {
				$db->replace('ship_has_hardware', [
					'account_id' => $db->escapeNumber($this->getAccountID()),
					'game_id' => $db->escapeNumber($this->getGameID()),
					'hardware_type_id' => $db->escapeNumber($hardwareTypeID),
					'amount' => $db->escapeNumber($amount),
				]);
			} else {
				$db->write('DELETE FROM ship_has_hardware WHERE ' . $this->SQL . ' AND hardware_type_id = ' . $db->escapeNumber($hardwareTypeID));
			}
		}
		$this->hasChangedHardware = [];
	}

	private function updateWeapons(): void {
		if ($this->hasChangedWeapons === false) {
			return;
		}
		// write weapon info
		$db = Database::getInstance();
		$db->write('DELETE FROM ship_has_weapon WHERE ' . $this->SQL);
		foreach ($this->weapons as $orderID => $weapon) {
			$db->insert('ship_has_weapon', [
				'account_id' => $db->escapeNumber($this->getAccountID()),
				'game_id' => $db->escapeNumber($this->getGameID()),
				'order_id' => $db->escapeNumber($orderID),
				'weapon_type_id' => $db->escapeNumber($weapon->getWeaponTypeID()),
				'bonus_accuracy' => $db->escapeBoolean($weapon->hasBonusAccuracy()),
				'bonus_damage' => $db->escapeBoolean($weapon->hasBonusDamage()),
			]);
		}
		$this->hasChangedWeapons = false;
	}

	public function loadCloak(): void {
		$this->isCloaked = false;
		if ($this->hasCloak() === false) {
			return;
		}
		$db = Database::getInstance();
		$dbResult = $db->read('SELECT 1 FROM ship_is_cloaked WHERE ' . $this->SQL);
		$this->isCloaked = $dbResult->hasRecord();
	}

	public function updateCloak(): void {
		if ($this->hasChangedCloak === false) {
			return;
		}
		$db = Database::getInstance();
		if ($this->isCloaked === false) {
			$db->write('DELETE FROM ship_is_cloaked WHERE ' . $this->SQL);
		} else {
			$db->insert('ship_is_cloaked', [
				'account_id' => $db->escapeNumber($this->getAccountID()),
				'game_id' => $db->escapeNumber($this->getGameID()),
			]);
		}
		$this->hasChangedCloak = false;
	}

	public function loadIllusion(): void {
		$this->illusionShip = false;
		if ($this->hasIllusion() === false) {
			return;
		}
		$db = Database::getInstance();
		$dbResult = $db->read('SELECT * FROM ship_has_illusion WHERE ' . $this->SQL);
		if ($dbResult->hasRecord()) {
			$dbRecord = $dbResult->record();
			$this->illusionShip = new ShipIllusion(
				shipTypeID: $dbRecord->getInt('ship_type_id'),
				attackRating: $dbRecord->getInt('attack'),
				defenseRating: $dbRecord->getInt('defense'),
			);
		}
	}

	public function updateIllusion(): void {
		if ($this->hasChangedIllusion === false) {
			return;
		}
		$db = Database::getInstance();
		if ($this->illusionShip === false) {
			$db->write('DELETE FROM ship_has_illusion WHERE ' . $this->SQL);
		} else {
			$db->replace('ship_has_illusion', [
				'account_id' => $db->escapeNumber($this->getAccountID()),
				'game_id' => $db->escapeNumber($this->getGameID()),
				'ship_type_id' => $db->escapeNumber($this->illusionShip->shipTypeID),
				'attack' => $db->escapeNumber($this->illusionShip->attackRating),
				'defense' => $db->escapeNumber($this->illusionShip->defenseRating),
			]);
		}
		$this->hasChangedIllusion = false;
	}

}