Session::getSN() - Code Metrics - Inspection of "Ajax updates" - smrealms/smr - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions
Pull Request — main (#1487)

by Dan
created 2022-12-11 21:47 UTC
Session::getSN() A

↳ Parent: Session
Complexity

Conditions	1
Paths	1
Size

Total Lines	2
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

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

namespace Smr;

use AbstractSmrPlayer;
use Page;
use Smr\Container\DiContainer;
use Smr\Exceptions\UserError;
use SmrAccount;
use SmrPlayer;

class Session {

	private const TIME_BEFORE_EXPIRY = 172800; // 2 days

	private const URL_LOAD_DELAY = [
		'configure_hardware.php' => .4,
		'forces_drop.php' => .4,
		'forces_drop_processing.php' => .5,
		'forces_refresh_processing.php' => .4,
		'sector_jump_processing.php' => .4,
		'sector_move_processing.php' => .4,
		'sector_scan.php' => .4,
		'shop_goods_processing.php' => .4,
		'trader_attack_processing.php' => .75,
		'trader_examine.php' => .75,
	];

	protected Database $db;

	private string $sessionID;
	private int $gameID;
	/** @var array<string, Page> */
	private array $links = [];
	private ?Page $currentPage = null;
	private bool $generate;
	public readonly bool $ajax;
	private string $SN;
	private string $lastSN;
	private int $accountID;
	private float $lastAccessed;

	/** @var ?array<string, string> */
	protected ?array $previousAjaxReturns;
	/** @var array<string, string> */
	protected array $ajaxReturns = [];

	/**
	 * Return the Smr\Session in 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);
	}

	/**
	 * Smr\Session constructor.
	 * Not intended to be constructed by hand. Use Smr\Session::getInstance().
	 */
	public function __construct() {
		// Initialize the db connector here
		$this->db = Database::getInstance();

		// now try the cookie
		$idLength = 32;
		if (isset($_COOKIE['session_id']) && strlen($_COOKIE['session_id']) === $idLength) {
			$this->sessionID = $_COOKIE['session_id'];
		} else {
			// create a new session id
			do {
				$this->sessionID = random_string($idLength);
				$this->sessionID = /** @scrutinizer ignore-call */ random_string($idLength);
				$dbResult = $this->db->read('SELECT 1 FROM active_session WHERE session_id = ' . $this->db->escapeString($this->sessionID));
			} while ($dbResult->hasRecord()); //Make sure we haven't somehow clashed with someone else's session.

			// This is a minor hack to make sure that setcookie is not called
			// for CLI programs and tests (to avoid "headers already sent").
			if (headers_sent() === false) {
				setcookie('session_id', $this->sessionID);
			}
		}

		// Delete any expired sessions
		$this->db->write('DELETE FROM active_session WHERE last_accessed < ' . $this->db->escapeNumber(time() - self::TIME_BEFORE_EXPIRY));

		// try to get current session
		$this->ajax = Request::getInt('ajax', 0) === 1;

		$this->SN = Request::get('sn', '');
		$this->fetchVarInfo();

		if (!$this->ajax && $this->hasCurrentVar()) {
			$file = $this->getCurrentVar()->file;
			$loadDelay = self::URL_LOAD_DELAY[$file] ?? 0;
			$timeBetweenLoads = microtime(true) - $this->lastAccessed;
			if ($timeBetweenLoads < $loadDelay) {
				$sleepTime = IRound(($loadDelay - $timeBetweenLoads) * 1000000);
				$sleepTime = /** @scrutinizer ignore-call */ IRound(($loadDelay - $timeBetweenLoads) * 1000000);
				//echo 'Sleeping for: ' . $sleepTime . 'us';
				usleep($sleepTime);
			}
			if (ENABLE_DEBUG) {
				$this->db->insert('debug', [
					'debug_type' => $this->db->escapeString('Delay: ' . $file),
					'account_id' => $this->db->escapeNumber($this->accountID),
					'value' => $this->db->escapeNumber($timeBetweenLoads),
				]);
			}
		}
	}

	public function fetchVarInfo(): void {
		$dbResult = $this->db->read('SELECT * FROM active_session WHERE session_id = ' . $this->db->escapeString($this->sessionID));
		if ($dbResult->hasRecord()) {
			$dbRecord = $dbResult->record();
			$this->generate = false;
			$this->sessionID = $dbRecord->getString('session_id');
			$this->accountID = $dbRecord->getInt('account_id');
			$this->gameID = $dbRecord->getInt('game_id');
			$this->lastAccessed = $dbRecord->getFloat('last_accessed');
			$this->lastSN = $dbRecord->getString('last_sn');
			// We may not have ajax_returns if ajax was disabled
			$this->previousAjaxReturns = $dbRecord->getObject('ajax_returns', true, true);

			[$this->links, $lastPage] = $dbRecord->getObject('session_var', true);

			$ajaxRefresh = $this->ajax && !$this->hasChangedSN();
			if ($ajaxRefresh) {
				$this->currentPage = $lastPage;
			} elseif (isset($this->links[$this->SN])) {
				// If the current page is modified during page processing, we need
				// to make sure the original link is unchanged. So we clone it here.
				$this->currentPage = clone $this->links[$this->SN];

				// If SN changes during an ajax update, it is an error unless user is
				// requesting a page that is allowed to be executed in an ajax call.
				$allowAjax = $this->currentPage['AJAX'] ?? false;
				if (!$allowAjax && $this->ajax && $this->hasChangedSN()) {
					throw new UserError('The previous page failed to auto-refresh properly!');
				}
			}

			if (!$ajaxRefresh) { // since form pages don't ajax refresh properly
				foreach ($this->links as $sn => $link) {
					if (!$link->reusable) {
						// This link is no longer valid
						unset($this->links[$sn]);
					}
				}
			}
		} else {
			$this->generate = true;
			$this->accountID = 0;
			$this->gameID = 0;
		}
	}

	public function update(): void {
		$sessionVar = [$this->links, $this->currentPage];
		if (!$this->generate) {
			$this->db->write('UPDATE active_session SET account_id=' . $this->db->escapeNumber($this->accountID) . ',game_id=' . $this->db->escapeNumber($this->gameID) . (!$this->ajax ? ',last_accessed=' . $this->db->escapeNumber(Epoch::microtime()) : '') . ',session_var=' . $this->db->escapeObject($sessionVar, true) .
					',last_sn=' . $this->db->escapeString($this->SN) .
					' WHERE session_id=' . $this->db->escapeString($this->sessionID) . ($this->ajax ? ' AND last_sn=' . $this->db->escapeString($this->lastSN) : ''));
		} else {
			$this->db->write('DELETE FROM active_session WHERE account_id = ' . $this->db->escapeNumber($this->accountID) . ' AND game_id = ' . $this->db->escapeNumber($this->gameID));
			$this->db->insert('active_session', [
				'session_id' => $this->db->escapeString($this->sessionID),
				'account_id' => $this->db->escapeNumber($this->accountID),
				'game_id' => $this->db->escapeNumber($this->gameID),
				'last_accessed' => $this->db->escapeNumber(Epoch::microtime()),
				'session_var' => $this->db->escapeObject($sessionVar, true),
			]);
			$this->generate = false;
		}
	}

	/**
	 * Uniquely identifies the session in the database.
	 */
	public function getSessionID(): string {
		return $this->sessionID;
	}

	/**
	 * Returns the Game ID associated with the session.
	 */
	public function getGameID(): int {
		return $this->gameID;
	}

	/**
	 * Returns true if the session is inside a game, false otherwise.
	 */
	public function hasGame(): bool {
		return $this->gameID != 0;
	}

	public function hasAccount(): bool {
		return $this->accountID > 0;
	}

	public function getAccountID(): int {
		return $this->accountID;
	}

	public function getAccount(): SmrAccount {
		return SmrAccount::getAccount($this->accountID);
	}

	public function getPlayer(bool $forceUpdate = false): AbstractSmrPlayer {
		return SmrPlayer::getPlayer($this->accountID, $this->gameID, $forceUpdate);
	}

	/**
	 * Sets the `accountID` attribute of this session.
	 */
	public function setAccount(SmrAccount $account): void {
		$this->accountID = $account->getAccountID();
	}

	/**
	 * Updates the `gameID` attribute of the session and deletes any other
	 * active sessions in this game for this account.
	 */
	public function updateGame(int $gameID): void {
		if ($this->gameID == $gameID) {
			return;
		}
		$this->gameID = $gameID;
		$this->db->write('DELETE FROM active_session WHERE account_id = ' . $this->db->escapeNumber($this->accountID) . ' AND game_id = ' . $this->gameID);
		$this->db->write('UPDATE active_session SET game_id=' . $this->db->escapeNumber($this->gameID) . ' WHERE session_id=' . $this->db->escapeString($this->sessionID));
	}

	/**
	 * The SN is the URL parameter that defines the page being requested.
	 */
	public function getSN(): string {
		return $this->SN;
	}

	/**
	 * Returns true if the current SN is different than the previous SN.
	 */
	public function hasChangedSN(): bool {
		return $this->SN != $this->lastSN;
	}

	public function destroy(): void {
		$this->db->write('DELETE FROM active_session WHERE session_id = ' . $this->db->escapeString($this->sessionID));
		unset($this->sessionID);
		unset($this->accountID);
		unset($this->gameID);
	}

	public function getLastAccessed(): float {
		return $this->lastAccessed;
	}

	/**
	 * Check if the session has a var associated with the current SN.
	 */
	public function hasCurrentVar(): bool {
		return $this->currentPage !== null;
	}

	/**
	 * Returns the session var associated with the current SN.
	 */
	public function getCurrentVar(): Page {
		return $this->currentPage;
	}

	/**
	 * Gets a var from $var, $_REQUEST, or $default. Then stores it in the
	 * session so that it can still be retrieved when the page auto-refreshes.
	 * This is the recommended way to get $_REQUEST data for display pages.
	 * For processing pages, see the Request class.
	 */
	public function getRequestVar(string $varName, string $default = null): string {
		$result = Request::getVar($varName, $default);
		$var = $this->getCurrentVar();
		$var[$varName] = $result;
		return $result;
	}

	public function getRequestVarInt(string $varName, int $default = null): int {
		$result = Request::getVarInt($varName, $default);
		$var = $this->getCurrentVar();
		$var[$varName] = $result;
		return $result;
	}

	/**
	 * @param ?array<int> $default
	 * @return array<int>
	 */
	public function getRequestVarIntArray(string $varName, array $default = null): array {
		$result = Request::getVarIntArray($varName, $default);
		$var = $this->getCurrentVar();
		$var[$varName] = $result;
		return $result;
	}

	/**
	 * Replace the global $var with the given $container.
	 */
	public function setCurrentVar(Page $container): void {
		$this->currentPage = $container;
	}

	public function clearLinks(): void {
		$this->links = [];
	}

	/**
	 * Add a page to the session so that it can be used on next page load.
	 * It will be associated with an SN that will be used for linking.
	 */
	public function addLink(Page $container): string {
		// If we already had a link to this exact page, use the existing SN for it.
		foreach ($this->links as $sn => $link) {
			if ($container == $link) { // loose equality to compare contents
				return $sn;
			}
		}
		// This page isn't an existing link, so give it a new SN.
		do {
			$sn = random_alphabetic_string(6);
			$sn = /** @scrutinizer ignore-call */ random_alphabetic_string(6);
		} while (isset($this->links[$sn]));
		$this->links[$sn] = $container;
		return $sn;
	}

	public function addAjaxReturns(string $element, string $contents): bool {
		$this->ajaxReturns[$element] = $contents;
		return isset($this->previousAjaxReturns[$element]) && $this->previousAjaxReturns[$element] == $contents;
	}

	public function saveAjaxReturns(): void {
		if (empty($this->ajaxReturns)) {
			return;
		}
		$this->db->write('UPDATE active_session SET ajax_returns=' . $this->db->escapeObject($this->ajaxReturns, true) .
				' WHERE session_id=' . $this->db->escapeString($this->sessionID));
	}

}

smrealms / smr

Scrutinizer GitHub App not installed

Pull Request — main (#1487)

Session::getSN() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
