SmrGame

Complexity

Total Complexity

104

Size/Duplication

Total Lines	467
Duplicated Lines	0 %

Importance

Changes

0

52 Methods

Rating	Name	Duplication	Size	Complexity
A	gameExists()	0	6	2
A	getEndTime()	0	2	1
A	getStartTime()	0	2	1
A	createGame()	0	5	2
A	hasStarted()	0	2	1
A	getDescription()	0	2	1
A	setStartTurnHours()	0	6	3
A	setDescription()	0	6	3
A	getMaxTurns()	0	2	1
A	getJoinTime()	0	2	1
A	setMaxTurns()	0	6	3
A	saveGames()	0	3	2
A	getStartTurnHours()	0	2	1
A	setStartTime()	0	6	3
A	getMaxPlayers()	0	2	1
A	getGame()	0	5	3
A	setJoinTime()	0	6	3
A	getGameID()	0	2	1
A	setName()	0	6	3
A	setMaxPlayers()	0	6	3
A	clearCache()	0	2	1
A	getName()	0	2	1
A	save()	0	42	3
A	setEndTime()	0	6	3
A	hasEnded()	0	2	1
A	__construct()	0	29	3
A	setStartingCredits()	0	6	3
A	setAllianceMaxVets()	0	6	3
A	getCreditsNeeded()	0	2	1
A	setGameTypeID()	0	6	3
A	getTotalPlayers()	0	6	2
A	getAllianceMaxPlayers()	0	2	1
A	setCreditsNeeded()	0	6	3
A	getStartingCredits()	0	2	1
A	isEnabled()	0	2	1
A	getGameType()	0	2	1
A	setIgnoreStats()	0	6	3
A	isIgnoreStats()	0	2	1
A	getAllianceMaxVets()	0	2	1
A	getNumberOfGalaxies()	0	2	1
A	getGameSpeed()	0	2	1
A	setGameSpeed()	0	6	3
A	getGalaxies()	0	2	1
A	setEnabled()	0	6	3
A	isGameType()	0	2	1
A	setAllianceMaxPlayers()	0	6	3
A	getPlayableRaceIDs()	0	15	3
A	timeUntilShipUnlock()	0	2	1
A	equals()	0	2	1
A	getLastSectorID()	0	6	2
A	getDisplayName()	0	2	1
B	setStartingRelations()	0	19	8

<?php declare(strict_types=1);

use Smr\Database;
use Smr\Epoch;
use Smr\Exceptions\GameNotFound;
use Smr\Race;

class SmrGame {

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

	protected Database $db;

	protected string $name;
	protected string $description;
	protected int $joinTime;
	protected int $startTime;
	protected int $endTime;
	protected int $maxPlayers;
	protected int $maxTurns;
	protected int $startTurnHours;
	protected int $gameTypeID;
	protected int $creditsNeeded;
	protected float $gameSpeed;
	protected bool $enabled;
	protected bool $ignoreStats;
	protected int $allianceMaxPlayers;
	protected int $allianceMaxVets;
	protected int $startingCredits;

	protected int $totalPlayers;
	/** @var array<int> */
	protected array $playableRaceIDs;

	protected bool $hasChanged = false;
	protected bool $isNew = false;

	public const GAME_TYPE_DEFAULT = 0;
	public const GAME_TYPE_HUNTER_WARS = 3;
	public const GAME_TYPE_SEMI_WARS = 4;
	public const GAME_TYPE_DRAFT = 5;
	public const GAME_TYPE_FFA = 6;
	public const GAME_TYPE_NEWBIE = 7;
	public const GAME_TYPES = [
		self::GAME_TYPE_DEFAULT => 'Default',
		self::GAME_TYPE_HUNTER_WARS => 'Hunter Wars',
		self::GAME_TYPE_SEMI_WARS => 'Semi Wars',
		self::GAME_TYPE_DRAFT => 'Draft',
		self::GAME_TYPE_FFA => 'FFA',
		self::GAME_TYPE_NEWBIE => 'Newbie',
	];

	/**
	 * Attempts to construct the game to determine if it exists.
	 */
	public static function gameExists(int $gameID): bool {
		try {
			self::getGame($gameID);
			return true;
		} catch (GameNotFound) {
			return false;
		}
	}

	public static function getGame(int $gameID, bool $forceUpdate = false): self {
		if ($forceUpdate || !isset(self::$CACHE_GAMES[$gameID])) {
			self::$CACHE_GAMES[$gameID] = new self($gameID);
		}
		return self::$CACHE_GAMES[$gameID];
	}

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

	public static function saveGames(): void {
		foreach (self::$CACHE_GAMES as $game) {
			$game->save();
		}
	}

	public static function createGame(int $gameID): self {
		if (!isset(self::$CACHE_GAMES[$gameID])) {
			self::$CACHE_GAMES[$gameID] = new self($gameID, true);
		}
		return self::$CACHE_GAMES[$gameID];
	}

	protected function __construct(
		protected readonly int $gameID,
		bool $create = false
	) {
		$this->db = Database::getInstance();

		$dbResult = $this->db->read('SELECT * FROM game WHERE game_id = ' . $this->db->escapeNumber($gameID));
		if ($dbResult->hasRecord()) {
			$dbRecord = $dbResult->record();
			$this->name = $dbRecord->getString('game_name');
			$this->description = $dbRecord->getString('game_description');
			$this->joinTime = $dbRecord->getInt('join_time');
			$this->startTime = $dbRecord->getInt('start_time');
			$this->endTime = $dbRecord->getInt('end_time');
			$this->maxPlayers = $dbRecord->getInt('max_players');
			$this->maxTurns = $dbRecord->getInt('max_turns');
			$this->startTurnHours = $dbRecord->getInt('start_turns');
			$this->gameTypeID = $dbRecord->getInt('game_type');
			$this->creditsNeeded = $dbRecord->getInt('credits_needed');
			$this->gameSpeed = $dbRecord->getFloat('game_speed');
			$this->enabled = $dbRecord->getBoolean('enabled');
			$this->ignoreStats = $dbRecord->getBoolean('ignore_stats');
			$this->allianceMaxPlayers = $dbRecord->getInt('alliance_max_players');
			$this->allianceMaxVets = $dbRecord->getInt('alliance_max_vets');
			$this->startingCredits = $dbRecord->getInt('starting_credits');
		} elseif ($create === true) {
			$this->isNew = true;
		} else {
			throw new GameNotFound('No such game: ' . $gameID);
		}
	}

	public function save(): void {
		if ($this->isNew) {
			$this->db->insert('game', [
				'game_id' => $this->db->escapeNumber($this->getGameID()),
				'game_name' => $this->db->escapeString($this->getName()),
				'game_description' => $this->db->escapeString($this->getDescription()),
				'join_time' => $this->db->escapeNumber($this->getJoinTime()),
				'start_time' => $this->db->escapeNumber($this->getStartTime()),
				'end_time' => $this->db->escapeNumber($this->getEndTime()),
				'max_players' => $this->db->escapeNumber($this->getMaxPlayers()),
				'max_turns' => $this->db->escapeNumber($this->getMaxTurns()),
				'start_turns' => $this->db->escapeNumber($this->getStartTurnHours()),
				'game_type' => $this->db->escapeNumber($this->gameTypeID),
				'credits_needed' => $this->db->escapeNumber($this->getCreditsNeeded()),
				'game_speed' => $this->db->escapeNumber($this->getGameSpeed()),
				'enabled' => $this->db->escapeBoolean($this->isEnabled()),
				'ignore_stats' => $this->db->escapeBoolean($this->isIgnoreStats()),
				'alliance_max_players' => $this->db->escapeNumber($this->getAllianceMaxPlayers()),
				'alliance_max_vets' => $this->db->escapeNumber($this->getAllianceMaxVets()),
				'starting_credits' => $this->db->escapeNumber($this->getStartingCredits()),
			]);
		} elseif ($this->hasChanged) {
			$this->db->write('UPDATE game SET game_name = ' . $this->db->escapeString($this->getName()) .
										', game_description = ' . $this->db->escapeString($this->getDescription()) .
										', join_time = ' . $this->db->escapeNumber($this->getJoinTime()) .
										', start_time = ' . $this->db->escapeNumber($this->getStartTime()) .
										', end_time = ' . $this->db->escapeNumber($this->getEndTime()) .
										', max_players = ' . $this->db->escapeNumber($this->getMaxPlayers()) .
										', max_turns = ' . $this->db->escapeNumber($this->getMaxTurns()) .
										', start_turns = ' . $this->db->escapeNumber($this->getStartTurnHours()) .
										', game_type = ' . $this->db->escapeNumber($this->gameTypeID) .
										', credits_needed = ' . $this->db->escapeNumber($this->getCreditsNeeded()) .
										', game_speed = ' . $this->db->escapeNumber($this->getGameSpeed()) .
										', enabled = ' . $this->db->escapeBoolean($this->isEnabled()) .
										', ignore_stats = ' . $this->db->escapeBoolean($this->isIgnoreStats()) .
										', alliance_max_players = ' . $this->db->escapeNumber($this->getAllianceMaxPlayers()) .
										', alliance_max_vets = ' . $this->db->escapeNumber($this->getAllianceMaxVets()) .
										', starting_credits = ' . $this->db->escapeNumber($this->getStartingCredits()) .
									' WHERE game_id = ' . $this->db->escapeNumber($this->getGameID()));
		}
		$this->isNew = false;
		$this->hasChanged = false;
	}

	public function getGameID(): int {
		return $this->gameID;
	}

	public function getName(): string {
		return $this->name;
	}

	public function setName(string $name): void {
		if (!$this->isNew && $this->name === $name) {
			return;
		}
		$this->name = $name;
		$this->hasChanged = true;
	}

	public function getDescription(): string {
		return $this->description;
	}

	public function setDescription(string $description): void {
		if (!$this->isNew && $this->description === $description) {
			return;
		}
		$this->description = $description;
		$this->hasChanged = true;
	}

	public function hasStarted(): bool {
		return Epoch::time() >= $this->getStartTime();
	}

	/**
	 * Returns the epoch time when the game starts,
	 * i.e. when players can move, turns are gained, etc.
	 */
	public function getStartTime(): int {
		return $this->startTime;
	}

	public function setStartTime(int $startTime): void {
		if (!$this->isNew && $this->startTime === $startTime) {
			return;
		}
		$this->startTime = $startTime;
		$this->hasChanged = true;
	}

	/**
	 * Returns the epoch time when players can begin to join the game.
	 */
	public function getJoinTime(): int {
		return $this->joinTime;
	}

	public function setJoinTime(int $joinTime): void {
		if (!$this->isNew && $this->joinTime === $joinTime) {
			return;
		}
		$this->joinTime = $joinTime;
		$this->hasChanged = true;
	}

	public function hasEnded(): bool {
		return $this->getEndTime() < Epoch::time();
	}

	/**
	 * Returns the epoch time when the game ends.
	 */
	public function getEndTime(): int {
		return $this->endTime;
	}

	public function setEndTime(int $endTime): void {
		if (!$this->isNew && $this->endTime === $endTime) {
			return;
		}
		$this->endTime = $endTime;
		$this->hasChanged = true;
	}

	public function getMaxPlayers(): int {
		return $this->maxPlayers;
	}

	public function setMaxPlayers(int $maxPlayers): void {
		if (!$this->isNew && $this->maxPlayers === $maxPlayers) {
			return;
		}
		$this->maxPlayers = $maxPlayers;
		$this->hasChanged = true;
	}

	public function getMaxTurns(): int {
		return $this->maxTurns;
	}

	public function setMaxTurns(int $int): void {
		if (!$this->isNew && $this->maxTurns === $int) {
			return;
		}
		$this->maxTurns = $int;
		$this->hasChanged = true;
	}

	public function getStartTurnHours(): int {
		return $this->startTurnHours;
	}

	public function setStartTurnHours(int $int): void {
		if (!$this->isNew && $this->startTurnHours === $int) {
			return;
		}
		$this->startTurnHours = $int;
		$this->hasChanged = true;
	}

	public function isGameType(int $gameTypeID): bool {
		return $this->gameTypeID === $gameTypeID;
	}

	public function getGameType(): string {
		return self::GAME_TYPES[$this->gameTypeID];
	}

	public function setGameTypeID(int $gameTypeID): void {
		if (!$this->isNew && $this->gameTypeID === $gameTypeID) {
			return;
		}
		$this->gameTypeID = $gameTypeID;
		$this->hasChanged = true;
	}

	public function getCreditsNeeded(): int {
		return $this->creditsNeeded;
	}

	public function setCreditsNeeded(int $creditsNeeded): void {
		if (!$this->isNew && $this->creditsNeeded === $creditsNeeded) {
			return;
		}
		$this->creditsNeeded = $creditsNeeded;
		$this->hasChanged = true;
	}

	public function getGameSpeed(): float {
		return $this->gameSpeed;
	}

	public function setGameSpeed(float $gameSpeed): void {
		if (!$this->isNew && $this->gameSpeed === $gameSpeed) {
			return;
		}
		$this->gameSpeed = $gameSpeed;
		$this->hasChanged = true;
	}

	public function isEnabled(): bool {
		return $this->enabled;
	}

	public function setEnabled(bool $bool): void {
		if (!$this->isNew && $this->enabled === $bool) {
			return;
		}
		$this->enabled = $bool;
		$this->hasChanged = true;
	}

	public function isIgnoreStats(): bool {
		return $this->ignoreStats;
	}

	public function setIgnoreStats(bool $bool): void {
		if (!$this->isNew && $this->ignoreStats === $bool) {
			return;
		}
		$this->ignoreStats = $bool;
		$this->hasChanged = true;
	}

	public function getAllianceMaxPlayers(): int {
		return $this->allianceMaxPlayers;
	}

	public function setAllianceMaxPlayers(int $int): void {
		if (!$this->isNew && $this->allianceMaxPlayers === $int) {
			return;
		}
		$this->allianceMaxPlayers = $int;
		$this->hasChanged = true;
	}

	public function getAllianceMaxVets(): int {
		return $this->allianceMaxVets;
	}

	public function setAllianceMaxVets(int $int): void {
		if (!$this->isNew && $this->allianceMaxVets === $int) {
			return;
		}
		$this->allianceMaxVets = $int;
		$this->hasChanged = true;
	}

	public function getStartingCredits(): int {
		return $this->startingCredits;
	}

	public function setStartingCredits(int $int): void {
		if (!$this->isNew && $this->startingCredits === $int) {
			return;
		}
		$this->startingCredits = $int;
		$this->hasChanged = true;
	}

	public function getTotalPlayers(): int {
		if (!isset($this->totalPlayers)) {
			$dbResult = $this->db->read('SELECT count(*) FROM player WHERE game_id = ' . $this->db->escapeNumber($this->getGameID()));
			$this->totalPlayers = $dbResult->record()->getInt('count(*)');
		}
		return $this->totalPlayers;
	}

	/**
	 * @return array<int, \SmrGalaxy>
	 */
	public function getGalaxies(): array {
		return SmrGalaxy::getGameGalaxies($this->gameID);
	}

	public function getNumberOfGalaxies(): int {
		return count($this->getGalaxies());
	}

	public function getLastSectorID(): int {
		$galaxies = $this->getGalaxies();
		if (count($galaxies) == 0) {
			throw new Exception('There are no galaxies in this game yet!');
		}
		return end($galaxies)->getEndSector();
	}

	public function equals(self $otherGame): bool {
		return $otherGame->getGameID() == $this->getGameID();
	}

	// Convenience function for printing the game name with id
	public function getDisplayName(): string {
		return $this->getName() . ' (' . $this->getGameID() . ')';
	}

	/**
	 * Set the starting political relations between races.
	 */
	public function setStartingRelations(int $relations): void {
		if ($relations < MIN_GLOBAL_RELATIONS || $relations > MAX_GLOBAL_RELATIONS) {
			throw new Exception('Invalid relations: ' . $relations);
		}
		foreach (Race::getAllIDs() as $raceID1) {
			foreach (Race::getAllIDs() as $raceID2) {
				if ($raceID1 == $raceID2) {
					// Max relations for a race with itself
					$amount = MAX_GLOBAL_RELATIONS;
				} elseif ($raceID1 == RACE_NEUTRAL || $raceID2 == RACE_NEUTRAL) {
					$amount = 0; //0 relations with neutral
				} else {
					$amount = $relations;
				}
				$this->db->replace('race_has_relation', [
					'game_id' => $this->db->escapeNumber($this->getGameID()),
					'race_id_1' => $this->db->escapeNumber($raceID1),
					'race_id_2' => $this->db->escapeNumber($raceID2),
					'relation' => $this->db->escapeNumber($amount),
				]);
			}
		}
	}

	/**
	 * Get the list of playable Race IDs based on which Racial HQ's
	 * are locations in this game.
	 *
	 * @return array<int>
	 */
	public function getPlayableRaceIDs(): array {
		if (!isset($this->playableRaceIDs)) {
			// Get a unique set of HQ's available in game
			$dbResult = $this->db->read('SELECT DISTINCT location_type_id
				FROM location
				WHERE location_type_id > ' . $this->db->escapeNumber(UNDERGROUND) . '
					AND location_type_id < ' . $this->db->escapeNumber(FED) . '
					AND game_id = ' . $this->db->escapeNumber($this->getGameID()) . '
				ORDER BY location_type_id');
			$this->playableRaceIDs = [];
			foreach ($dbResult->records() as $dbRecord) {
				$this->playableRaceIDs[] = $dbRecord->getInt('location_type_id') - GOVERNMENT;
			}
		}
		return $this->playableRaceIDs;
	}

	/**
	 * Returns the time (in seconds) until restricted ships are unlocked.
	 */
	public function timeUntilShipUnlock(): int {
		return $this->getStartTime() + TIME_FOR_RAIDER_UNLOCK - Epoch::time();
	}

}