forwardURL() - Code Metrics - Inspection of "Remove forwardURL function" - smrealms/smr - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 2bbb94...dae5f6 )

by Dan
created 2021-03-29 10:59 UTC
forwardURL() A

↳ Parent: transfer()
Complexity

Conditions	1
Paths	1
Size

Total Lines	4
Code Lines	3
Duplication

Lines	0
Ratio	0 %
Importance

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

function htmliseMessage($message) {
	$message = htmlentities($message, ENT_COMPAT, 'utf-8');
	$message = str_replace('&lt;br /&gt;', '<br />', $message);
	return $message;
}

function parseBoolean($check) {
	// Only negative strings are not implicitly converted to the correct bool
	if (is_string($check) && (strcasecmp($check, 'NO') == 0 || strcasecmp($check, 'FALSE') == 0)) {
		return false;
	}
	return (bool)$check;
}

function linkCombatLog($logID) {
	$container = create_container('combat_log_viewer_verify.php');
	$container['log_id'] = $logID;
	return '<a href="' . SmrSession::getNewHREF($container) . '"><img src="images/notify.gif" width="14" height="11" border="0" title="View the combat log" /></a>';
}

/**
 * Converts a BBCode tag into some other text depending on the tag and value.
 * This is called in two stages: first with action BBCODE_CHECK (where the
 * returned value must be a boolean) and second, if the first check passes,
 * with action BBCODE_OUTPUT.
 */
function smrBBCode($bbParser, $action, $tagName, $default, $tagParams, $tagContent) {
function smrBBCode(/** @scrutinizer ignore-unused */ $bbParser, $action, $tagName, $default, $tagParams, $tagContent) {
	global $overrideGameID, $disableBBLinks, $player, $account, $var;
	try {
		switch ($tagName) {
			case 'combatlog':
				if ($action == \Nbbc\BBCode::BBCODE_CHECK) {
					return is_numeric($default);
				}
				$logID = (int)$default;
				return linkCombatLog($logID);
			break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
			case 'player':
				if ($action == \Nbbc\BBCode::BBCODE_CHECK) {
					return is_numeric($default);
				}
				$playerID = (int)$default;
				$bbPlayer = SmrPlayer::getPlayerByPlayerID($playerID, $overrideGameID);
				$showAlliance = isset($tagParams['showalliance']) ? parseBoolean($tagParams['showalliance']) : false;
				if ($disableBBLinks === false && $overrideGameID == SmrSession::getGameID()) {
					return $bbPlayer->getLinkedDisplayName($showAlliance);
				}
				return $bbPlayer->getDisplayName($showAlliance);
			break;
			case 'alliance':
				if ($action == \Nbbc\BBCode::BBCODE_CHECK) {
					return is_numeric($default);
				}
				$allianceID = (int)$default;
				$alliance = SmrAlliance::getAlliance($allianceID, $overrideGameID);
				if ($disableBBLinks === false && $overrideGameID == SmrSession::getGameID()) {
					$container = create_container('skeleton.php');
					$container['alliance_id'] = $alliance->getAllianceID();
					if (is_object($player) && $alliance->getAllianceID() == $player->getAllianceID()) {
						$container['body'] = 'alliance_mod.php';
					} else {
						$container['body'] = 'alliance_roster.php';
					}
					return create_link($container, $alliance->getAllianceDisplayName());
				}
				return $alliance->getAllianceDisplayName();
			break;
			case 'race':
				$raceNameID = $default;
				foreach (Globals::getRaces() as $raceID => $raceInfo) {
					if ((is_numeric($raceNameID) && $raceNameID == $raceID)
						|| $raceNameID == $raceInfo['Race Name']) {
						if ($action == \Nbbc\BBCode::BBCODE_CHECK) {
							return true;
						}
						$linked = $disableBBLinks === false && $overrideGameID == SmrSession::getGameID();
						return AbstractSmrPlayer::getColouredRaceNameOrDefault($raceID, $player, $linked);
					}
				}
			break;
			case 'servertimetouser':
				if ($action == \Nbbc\BBCode::BBCODE_CHECK) {
					return true;
				}
				$timeString = $default;
				if ($timeString != '' && ($time = strtotime($timeString)) !== false) {
					if (is_object($account)) {
						$time += $account->getOffset() * 3600;
					}
					return date(DATE_FULL_SHORT, $time);
				}
			break;
			case 'chess':
				if ($action == \Nbbc\BBCode::BBCODE_CHECK) {
					return is_numeric($default);
				}
				$chessGameID = (int)$default;
				$chessGame = ChessGame::getChessGame($chessGameID);
				return '<a href="' . $chessGame->getPlayGameHREF() . '">chess game (' . $chessGame->getChessGameID() . ')</a>';
			break;

			case 'sector':
				if ($action == \Nbbc\BBCode::BBCODE_CHECK) {
					return is_numeric($default);
				}

				$sectorID = (int)$default;
				$sectorTag = '<span class="sectorColour">#' . $sectorID . '</span>';

				// The use of $var here is for a corner case where an admin can check reported messages whilst being in-game.
				// Ugly but working, probably want a better mechanism to check if more BBCode tags get added
				if ($disableBBLinks === false
					&& SmrSession::hasGame()
					&& SmrSession::getGameID() == $overrideGameID
					&& SmrSector::sectorExists($overrideGameID, $sectorID)) {
					return '<a href="' . Globals::getPlotCourseHREF($player->getSectorID(), $sectorID) . '">' . $sectorTag . '</a>';
				}

				return $sectorTag;
			break;
			case 'join_alliance':
				if ($action == \Nbbc\BBCode::BBCODE_CHECK) {
					return is_numeric($default);
				}
				$allianceID = (int)$default;
				$alliance = SmrAlliance::getAlliance($allianceID, $overrideGameID);
				$container = create_container('alliance_invite_accept_processing.php');
				$container['alliance_id'] = $alliance->getAllianceID();
				return '<div class="buttonA"><a class="buttonA" href="' . SmrSession::getNewHREF($container) . '">Join ' . $alliance->getAllianceDisplayName() . '</a></div>';
			break;
		}
	} catch (Throwable $e) {
		// If there's an error, we will silently display the original text
	}
	if ($action == \Nbbc\BBCode::BBCODE_CHECK) {
		return false;
	}
	return htmlspecialchars($tagParams['_tag']) . $tagContent . htmlspecialchars($tagParams['_endtag']);
}

function xmlify($str) {
	$xml = htmlspecialchars($str, ENT_XML1, 'utf-8');
	return $xml;
}

function inify($text) {
	return str_replace(',', '', html_entity_decode($text));
}

function bbifyMessage($message, $noLinks = false) {
	static $bbParser;
	if (!isset($bbParser)) {
		$bbParser = new \Nbbc\BBCode();
		$bbParser->SetEnableSmileys(false);
		$bbParser->RemoveRule('wiki');
		$bbParser->RemoveRule('img');
		$bbParser->SetURLTarget('_blank');
		$bbParser->SetURLTargetable('override');
		$bbParser->setEscapeContent(false); // don't escape HTML, needed for News etc.
		$smrRule = array(
				'mode' => \Nbbc\BBCode::BBCODE_MODE_CALLBACK,
				'method' => 'smrBBCode',
				'class' => 'link',
				'allow_in' => Array('listitem', 'block', 'columns', 'inline'),
				'end_tag' => \Nbbc\BBCode::BBCODE_PROHIBIT,
				'content' => \Nbbc\BBCode::BBCODE_PROHIBIT,
			);
		$bbParser->AddRule('combatlog', $smrRule);
		$bbParser->AddRule('player', $smrRule);
		$bbParser->AddRule('alliance', $smrRule);
		$bbParser->AddRule('race', $smrRule);
		$bbParser->AddRule('servertimetouser', $smrRule);
		$bbParser->AddRule('chess', $smrRule);
		$bbParser->AddRule('sector', $smrRule);
		$bbParser->addRule('join_alliance', $smrRule);
	}
	global $disableBBLinks;
	if ($noLinks === true) {
		$disableBBLinks = true;
	} else {
		$disableBBLinks = false;
	}
	if (strpos($message, '[') !== false) { //We have BBCode so let's do a full parse.
		$message = $bbParser->parse($message);
		$message = str_replace('&lt;br /&gt;', '<br />', $message);
	} else { //Otherwise just convert newlines
		$message = nl2br($message, true);
	}
	return $message;
}

function create_error($message) {
	$container = create_container('skeleton.php', 'error.php');
	$container['message'] = $message;
	if (USING_AJAX) {
		// To avoid the page just not refreshing when an error is encountered
		// during ajax updates, use javascript to auto-redirect to the
		// appropriate error page.
		global $template;
		if (is_object($template) && method_exists($template, 'addJavascriptForAjax')) {
			$errorHREF = SmrSession::getNewHREF($container);
			// json_encode the HREF as a safety precaution
			$template->addJavascriptForAjax('EVAL', 'location.href = ' . json_encode($errorHREF));
		}
	}
	forward($container);
}

function resetContainer($new_container, $sn = null) {
	global $container, $var;

	// this sn identifies our container later
	if (!is_null($sn)) {
		SmrSession::resetLink($new_container, $sn);
	}

	$var = $new_container;
	$container = $new_container;
}

function forward($new_container) {
	global $sn;
	if (defined('OVERRIDE_FORWARD') && OVERRIDE_FORWARD === true) {
		return overrideForward($new_container);
	}
	resetContainer($new_container, $sn);
	do_voodoo();
}

function transfer($what) {
	global $var, $container;

	// transfer this value to next container
	if (isset($var[$what])) {
		$container[$what] = $var[$what];
	}
}

function create_container($file, $body = '', array $extra = array(), $remainingPageLoads = null) {
	$container = $extra;
	$container['url'] = $file;
	$container['body'] = $body;
	if ($remainingPageLoads) {
		$container['RemainingPageLoads'] = $remainingPageLoads;
	}
	return $container;
}

function create_link($container, $text, $class = null) {
	return '<a' . ($class == null ? '' : ' class="' . $class . '"') . ' href="' . (is_array($container) ?SmrSession::getNewHREF($container) : $container) . '">' . $text . '</a>';
}

function create_submit_link($container, $text) {
	return '<a href="' . SmrSession::getNewHREF($container) . '" class="submitStyle">' . $text . '</a>';
}

function get_colored_text_range($value, $maxValue, $text = null, $minValue = 0, $type = 'Game', $return_type = 'Normal') {
	if ($text == null) {
		$text = number_format($value);
	}
	if ($maxValue - $minValue == 0) {
		return $text;
	} else {
		$normalisedValue = IRound(510 * max(0, min($maxValue, $value) - $minValue) / ($maxValue - $minValue)) - 255;
	}
	if ($type == 'Game') {
		if ($normalisedValue < 0) {
			$r_component = 'ff';
			$g_component = dechex(255 + $normalisedValue);
			if (strlen($g_component) == 1) {
				$g_component = '0' . $g_component;
			}
		} else if ($normalisedValue > 0) {
			$g_component = 'ff';
			$r_component = dechex(255 - $normalisedValue);
			if (strlen($r_component) == 1) {
				$r_component = '0' . $r_component;
			}
		} else {
			$r_component = 'ff';
			$g_component = 'ff';
		}
		$colour = $r_component . $g_component . '00';
		if ($return_type == 'Colour') {
			return $colour;
		}
		return '<span style="color:#' . $colour . '">' . $text . '</span>';
	} elseif ($type == 'IRC') {
		//IRC color codes
		if ($normalisedValue == 255) {
			$colour = '[k03]';
		} elseif ($normalisedValue == -255) {
			$colour = '[k04]';
		} else {
			$colour = '[k08]';
		}
		if ($return_type == 'Colour') {
			return $colour;
		}
		return $colour . $text;
	}
}

function get_colored_text($value, $text = null, $type = 'Game', $return_type = 'Normal') {
	return get_colored_text_range($value, 300, $text, -300, $type, $return_type);
}

function word_filter($string) {
	static $words;

	if (!is_array($words)) {
		$db = MySqlDatabase::getInstance();
		$db->query('SELECT word_value, word_replacement FROM word_filter');
		$words = array();
		while ($db->nextRecord()) {
			$row = $db->getRow();
			$words[] = array('word_value' => '/' . str_replace('/', '\/', $row['word_value']) . '/i', 'word_replacement'=> $row['word_replacement']);
		}
	}

	foreach ($words as $word) {
		$string = preg_replace($word['word_value'], $word['word_replacement'], $string);
	}

	return $string;
}

// choose correct pluralization based on amount
function pluralise($word, $count = 0) {
	if ($count == 1) {
		return $word;
	}
	if (strtolower($word) == 'is') {
		return 'are';
	}
	return $word . 's';
}

/**
 * This function is a hack around the old style http forward mechanism.
 * It is also responsible for setting most of the global variables
 * (see loader.php for the initialization of the globals).
 */
function do_voodoo() {
	global $lock, $var, $container, $player, $ship, $sector, $account, $db, $template;

	if (!defined('AJAX_CONTAINER')) {
		define('AJAX_CONTAINER', isset($var['AJAX']) && $var['AJAX'] === true);
	}
	if (!AJAX_CONTAINER && USING_AJAX && SmrSession::hasChangedSN()) {
		exit;

	}
//	ob_clean();

	// create account object
	$account = SmrSession::getAccount();

	if (!defined('DATE_DATE_SHORT')) {
		define('DATE_DATE_SHORT', $account->getShortDateFormat());
	}
	if (!defined('DATE_TIME_SHORT')) {
		define('DATE_TIME_SHORT', $account->getShortTimeFormat());
	}
	if (!defined('DATE_FULL_SHORT')) {
		define('DATE_FULL_SHORT', DATE_DATE_SHORT . ' ' . DATE_TIME_SHORT);
	}
	if (!defined('DATE_FULL_SHORT_SPLIT')) {
		define('DATE_FULL_SHORT_SPLIT', DATE_DATE_SHORT . '\<b\r /\>' . DATE_TIME_SHORT);
	}

	// initialize objects we usually need, like player, ship
	if (SmrSession::hasGame()) {
		if (SmrGame::getGame(SmrSession::getGameID())->hasEnded()) {
			forward(create_container('game_leave_processing.php', 'game_play.php', array('errorMsg' => 'The game has ended.')));
		}
		// We need to acquire locks BEFORE getting the player information
		// Otherwise we could be working on stale information
		$db->query('SELECT sector_id FROM player WHERE account_id=' . $db->escapeNumber($account->getAccountID()) . ' AND game_id=' . $db->escapeNumber(SmrSession::getGameID()) . ' LIMIT 1');
		$db->requireRecord();
		$sector_id = $db->getInt('sector_id');

		global $locksFailed;
		if (!USING_AJAX //AJAX should never do anything that requires a lock.
//			&& !isset($var['url']) && ($var['body'] == 'current_sector.php' || $var['body'] == 'map_local.php') //Neither should CS or LM and they gets loaded a lot so should reduce lag issues with big groups.
			) {
			if (!$lock && !isset($locksFailed[$sector_id])) {
				if (!acquire_lock($sector_id)) {
					create_error('Failed to acquire sector lock');
				}
				//Refetch var info in case it changed between grabbing lock.
				SmrSession::fetchVarInfo();
				if (!($var = SmrSession::retrieveVar())) {
					if (ENABLE_DEBUG) {
						$db->query('INSERT INTO debug VALUES (\'SPAM\',' . $db->escapeNumber($account->getAccountID()) . ',0,0)');
					}
					create_error('Please do not spam click!');
				}
			}
		}

		// Now that they've acquire a lock we can move on
		$player = SmrPlayer::getPlayer($account->getAccountID(), SmrSession::getGameID());

		if ($player->isDead() && $var['url'] != 'death_processing.php' && !isset($var['override_death'])) {
			forward(create_container('death_processing.php'));
		}

		$ship = $player->getShip();
		$sector = $player->getSector();

		// update turns on that player
		$player->updateTurns();

		if (!$player->isDead() && $player->getNewbieTurns() <= NEWBIE_TURNS_WARNING_LIMIT &&
			$player->getNewbieWarning() &&
			$var['url'] != 'newbie_warning_processing.php')
			forward(create_container('newbie_warning_processing.php'));
	}

	// Initialize the template
	$template = new Template();

	if ($var['url'] != 'skeleton.php') {
		require(get_file_loc($var['url']));
	}
	if ($var['body']) {
		if ($var['body'] == 'error.php') { // infinite includes for error pages
			require(get_file_loc($var['body']));
		} else {
			require_once(get_file_loc($var['body']));
		}
	}

	if (SmrSession::hasGame()) {
		$template->assign('UnderAttack', $player->removeUnderAttack());
	}

	if ($lock) { //Only save if we have the lock.
		SmrSector::saveSectors();
		SmrShip::saveShips();
		SmrPlayer::savePlayers();
		SmrForce::saveForces();
		SmrPort::savePorts();
		SmrPlanet::savePlanets();
		if (class_exists('WeightedRandom', false)) {
			WeightedRandom::saveWeightedRandoms();
		}
		//Update session here to make sure current page $var is up to date before releasing lock.
		SmrSession::update();
		release_lock();
	}

	//Nothing below this point should require the lock.

	$template->assign('TemplateBody', $var['body']);
	if (SmrSession::hasGame()) {
		$template->assign('ThisSector', $sector);
		$template->assign('ThisPlayer', $player);
		$template->assign('ThisShip', $ship);
	}
	$template->assign('ThisAccount', $account);
	if ($account->getCssLink() != null) {

		$template->assign('ExtraCSSLink', $account->getCssLink());
	}
	doSkeletonAssigns($template, $player, $ship, $sector, $db, $account, $var);

	// Set ajax refresh time
	$ajaxRefresh = $var['AllowAjax'] ?? true; // hack for bar_gambling_processing.php
	if (!$account->isUseAJAX()) {
		$ajaxRefresh = false;
	}
	if ($ajaxRefresh) {
		// If we can refresh, specify the refresh interval in millisecs
		if (SmrSession::hasGame() && $player->canFight()) {
			$ajaxRefresh = AJAX_UNPROTECTED_REFRESH_TIME;
		} else {
			$ajaxRefresh = AJAX_DEFAULT_REFRESH_TIME;
		}
	}
	$template->assign('AJAX_ENABLE_REFRESH', $ajaxRefresh);

	$template->display($var['url'], USING_AJAX || AJAX_CONTAINER);

	SmrSession::update();

	exit;

}

//xdebug_dump_function_profile(2);

// This is hackish, but without row level locking it's the best we can do
function acquire_lock($sector) {
	global $db, $lock, $locksFailed;

	if ($lock) {
		return true;
	}

	// Insert ourselves into the queue.
	$db->query('INSERT INTO locks_queue (game_id,account_id,sector_id,timestamp) VALUES(' . $db->escapeNumber(SmrSession::getGameID()) . ',' . $db->escapeNumber(SmrSession::getAccountID()) . ',' . $db->escapeNumber($sector) . ',' . $db->escapeNumber(SmrSession::getTime()) . ')');
	$lock = $db->getInsertID();

	for ($i = 0; $i < 250; ++$i) {
		if (time() - SmrSession::getTime() >= LOCK_DURATION - LOCK_BUFFER) {
			break;
		}
		// If there is someone else before us in the queue we sleep for a while
		$db->query('SELECT COUNT(*) FROM locks_queue WHERE lock_id<' . $db->escapeNumber($lock) . ' AND sector_id=' . $db->escapeNumber($sector) . ' AND game_id=' . $db->escapeNumber(SmrSession::getGameID()) . ' AND timestamp > ' . $db->escapeNumber(SmrSession::getTime() - LOCK_DURATION));
		$locksInQueue = -1;

		if ($db->nextRecord() && ($locksInQueue = $db->getInt('COUNT(*)')) > 0) {
			//usleep(100000 + mt_rand(0,50000));

			// We can only have one lock in the queue, anything more means someone is screwing around
			$db->query('SELECT COUNT(*) FROM locks_queue WHERE account_id=' . $db->escapeNumber(SmrSession::getAccountID()) . ' AND sector_id=' . $db->escapeNumber($sector) . ' AND timestamp > ' . $db->escapeNumber(SmrSession::getTime() - LOCK_DURATION));
			if ($db->nextRecord() && $db->getInt('COUNT(*)') > 1) {
				release_lock();
				$locksFailed[$sector] = true;
				create_error('Multiple actions cannot be performed at the same time!');
			}

			usleep(25000 * $locksInQueue);
			continue;
		} else {
			return true;
		}
	}

	release_lock();
	$locksFailed[$sector] = true;
	return false;
}

function release_lock() {
	global $db, $lock;
	if ($lock) {
		$db->query('DELETE from locks_queue WHERE lock_id=' . $db->escapeNumber($lock) . ' OR timestamp<' . $db->escapeNumber(SmrSession::getTime() - LOCK_DURATION));
	}

	$lock = false;
}

function doTickerAssigns($template, $player, $db) {
	//any ticker news?
	if ($player->hasTickers()) {
		$ticker = array();
		$max = SmrSession::getTime() - 60;
		if ($player->hasTicker('NEWS')) {
			//get recent news (5 mins)
			$db->query('SELECT time,news_message FROM news WHERE game_id = ' . $db->escapeNumber($player->getGameID()) . ' AND time >= ' . $max . ' ORDER BY time DESC LIMIT 4');
			while ($db->nextRecord()) {
				$ticker[] = array('Time' => date(DATE_FULL_SHORT, $db->getInt('time')),
								'Message'=>$db->getField('news_message'));
			}
		}
		if ($player->hasTicker('SCOUT')) {
			$db->query('SELECT message_text,send_time FROM message
						WHERE account_id=' . $db->escapeNumber($player->getAccountID()) . '
						AND game_id=' . $db->escapeNumber($player->getGameID()) . '
						AND message_type_id=' . $db->escapeNumber(MSG_SCOUT) . '
						AND send_time>=' . $db->escapeNumber($max) . '
						AND sender_id NOT IN (SELECT account_id FROM player_has_ticker WHERE type='.$db->escapeString('BLOCK') . ' AND expires > ' . $db->escapeNumber(SmrSession::getTime()) . ' AND game_id = ' . $db->escapeNumber($player->getGameID()) . ') AND receiver_delete = \'FALSE\'
						ORDER BY send_time DESC
						LIMIT 4');
			while ($db->nextRecord()) {
				$ticker[] = array('Time' => date(DATE_FULL_SHORT, $db->getInt('send_time')),
								'Message'=>$db->getField('message_text'));
			}
		}
		$template->assign('Ticker', $ticker);
	}
}

function doSkeletonAssigns($template, $player, $ship, $sector, $db, $account, $var) {
function doSkeletonAssigns($template, $player, $ship, /** @scrutinizer ignore-unused */ $sector, $db, $account, $var) {
	$template->assign('CSSLink', $account->getCssUrl());
	$template->assign('CSSColourLink', $account->getCssColourUrl());

	$template->assign('FontSize', $account->getFontSize() - 20);
	$template->assign('timeDisplay', date(DATE_FULL_SHORT_SPLIT, SmrSession::getTime()));

	$container = create_container('skeleton.php');


	if (SmrSession::hasGame()) {
		$template->assign('GameName', SmrGame::getGame(SmrSession::getGameID())->getName());
		$template->assign('GameID', SmrSession::getGameID());

		$template->assign('PlotCourseLink', Globals::getPlotCourseHREF());

		$template->assign('TraderLink', Globals::getTraderStatusHREF());

		$template->assign('PoliticsLink', Globals::getPoliticsHREF());

		$container['body'] = 'combat_log_list.php';
		$template->assign('CombatLogsLink', SmrSession::getNewHREF($container));

		$template->assign('PlanetLink', Globals::getPlanetListHREF($player->getAllianceID()));

		$container['body'] = 'forces_list.php';
		$template->assign('ForcesLink', SmrSession::getNewHREF($container));

		$template->assign('MessagesLink', Globals::getViewMessageBoxesHREF());

		$container['body'] = 'news_read_current.php';
		$template->assign('ReadNewsLink', SmrSession::getNewHREF($container));

		$container['body'] = 'galactic_post_current.php';
		$template->assign('GalacticPostLink', SmrSession::getNewHREF($container));

		$container['body'] = 'trader_search.php';
		$template->assign('SearchForTraderLink', SmrSession::getNewHREF($container));

		$container['body'] = 'rankings_player_experience.php';
		$template->assign('RankingsLink', SmrSession::getNewHREF($container));

		$container['body'] = 'hall_of_fame_new.php';
		$container['game_id'] = $player->getGameID();
		$template->assign('CurrentHallOfFameLink', SmrSession::getNewHREF($container));
	}

	if (SmrSession::hasAccount()) {
		$container = create_container('skeleton.php', 'hall_of_fame_new.php');
		$template->assign('HallOfFameLink', SmrSession::getNewHREF($container));

		$template->assign('AccountID', SmrSession::getAccountID());
		$template->assign('PlayGameLink', SmrSession::getNewHREF(create_container('game_leave_processing.php', 'game_play.php')));

		$template->assign('LogoutLink', SmrSession::getNewHREF(create_container('logoff.php')));
	}

	$container = create_container('game_leave_processing.php', 'admin_tools.php');
	$template->assign('AdminToolsLink', SmrSession::getNewHREF($container));

	$container = create_container('skeleton.php', 'preferences.php');
	$template->assign('PreferencesLink', SmrSession::getNewHREF($container));

	$container['body'] = 'album_edit.php';
	$template->assign('EditPhotoLink', SmrSession::getNewHREF($container));

	$container['body'] = 'bug_report.php';
	$template->assign('ReportABugLink', SmrSession::getNewHREF($container));

	$container['body'] = 'contact.php';
	$template->assign('ContactFormLink', SmrSession::getNewHREF($container));

	$container['body'] = 'chat_rules.php';
	$template->assign('IRCLink', SmrSession::getNewHREF($container));

	$container['body'] = 'donation.php';
	$template->assign('DonateLink', SmrSession::getNewHREF($container));



	if (SmrSession::hasGame()) {
		$db->query('SELECT message_type_id,COUNT(*) FROM player_has_unread_messages WHERE ' . $player->getSQL() . ' GROUP BY message_type_id');

		if ($db->getNumRows()) {
			$messages = array();
			while ($db->nextRecord()) {
				$messages[$db->getInt('message_type_id')] = $db->getInt('COUNT(*)');
			}

			$container = create_container('skeleton.php', 'message_view.php');

			if (isset($messages[MSG_GLOBAL])) {
				$container['folder_id'] = MSG_GLOBAL;
				$template->assign('MessageGlobalLink', SmrSession::getNewHREF($container));
				$template->assign('MessageGlobalNum', $messages[MSG_GLOBAL]);
			}

			if (isset($messages[MSG_PLAYER])) {
				$container['folder_id'] = MSG_PLAYER;
				$template->assign('MessagePersonalLink', SmrSession::getNewHREF($container));
				$template->assign('MessagePersonalNum', $messages[MSG_PLAYER]);
			}

			if (isset($messages[MSG_SCOUT])) {
				$container['folder_id'] = MSG_SCOUT;
				$template->assign('MessageScoutLink', SmrSession::getNewHREF($container));
				$template->assign('MessageScoutNum', $messages[MSG_SCOUT]);
			}

			if (isset($messages[MSG_POLITICAL])) {
				$container['folder_id'] = MSG_POLITICAL;
				$template->assign('MessagePoliticalLink', SmrSession::getNewHREF($container));
				$template->assign('MessagePoliticalNum', $messages[MSG_POLITICAL]);
			}

			if (isset($messages[MSG_ALLIANCE])) {
				$container['folder_id'] = MSG_ALLIANCE;
				$template->assign('MessageAllianceLink', SmrSession::getNewHREF($container));
				$template->assign('MessageAllianceNum', $messages[MSG_ALLIANCE]);
			}

			if (isset($messages[MSG_ADMIN])) {
				$container['folder_id'] = MSG_ADMIN;
				$template->assign('MessageAdminLink', SmrSession::getNewHREF($container));
				$template->assign('MessageAdminNum', $messages[MSG_ADMIN]);
			}

			if (isset($messages[MSG_CASINO])) {
				$container['folder_id'] = MSG_CASINO;
				$template->assign('MessageCasinoLink', SmrSession::getNewHREF($container));
				$template->assign('MessageCasinoNum', $messages[MSG_CASINO]);
			}

			if (isset($messages[MSG_PLANET])) {
				$container = create_container('planet_msg_processing.php');
				$template->assign('MessagePlanetLink', SmrSession::getNewHREF($container));
				$template->assign('MessagePlanetNum', $messages[MSG_PLANET]);
			}
		}

		$container = create_container('skeleton.php', 'trader_search_result.php');
		$container['player_id'] = $player->getPlayerID();
		$template->assign('PlayerNameLink', SmrSession::getNewHREF($container));

		if (is_array(Globals::getHiddenPlayers()) && in_array($player->getAccountID(), Globals::getHiddenPlayers())) {
			$template->assign('PlayerInvisible', true);
		}

		// ******* Hardware *******
		$container = create_container('skeleton.php', 'configure_hardware.php');

		$template->assign('HardwareLink', SmrSession::getNewHREF($container));

		// ******* Forces *******
		$template->assign('ForceDropLink', SmrSession::getNewHREF(create_container('skeleton.php', 'forces_drop.php')));

		if ($ship->hasMines()) {
			$container = create_container('forces_drop_processing.php');
			$container['owner_id'] = $player->getAccountID();
			$container['drop_mines'] = 1;
			$container['referrer'] = $var['body'];
			$template->assign('DropMineLink', SmrSession::getNewHREF($container));
		}
		if ($ship->hasCDs()) {
			$container = create_container('forces_drop_processing.php');
			$container['owner_id'] = $player->getAccountID();
			$container['drop_combat_drones'] = 1;
			$container['referrer'] = $var['body'];
			$template->assign('DropCDLink', SmrSession::getNewHREF($container));
		}

		if ($ship->hasSDs()) {
			$container = create_container('forces_drop_processing.php');
			$container['owner_id'] = $player->getAccountID();
			$container['drop_scout_drones'] = 1;
			$container['referrer'] = $var['body'];
			$template->assign('DropSDLink', SmrSession::getNewHREF($container));
		}

		$template->assign('CargoJettisonLink', SmrSession::getNewHREF(create_container('skeleton.php', 'cargo_dump.php')));

		$template->assign('WeaponReorderLink', SmrSession::getNewHREF(create_container('skeleton.php', 'weapon_reorder.php')));

	}

	// ------- VOTING --------
	$voteSites = array();
	foreach (VoteSite::getAllSites() as $site) {
		$voteSites[] = array(
			'img' => $site->getLinkImg($account->getAccountID(), SmrSession::getGameID()),
			'url' => $site->getLinkUrl($account->getAccountID(), SmrSession::getGameID()),
			'sn' => $site->getSN($account->getAccountID(), SmrSession::getGameID()),
		);
	}
	$template->assign('VoteSites', $voteSites);

	// Determine the minimum time until the next vote across all sites
	$minVoteWait = VoteSite::getMinTimeUntilFreeTurns($account->getAccountID());
	if ($minVoteWait <= 0) {
		$template->assign('TimeToNextVote', 'now');
	} else {
		$template->assign('TimeToNextVote', 'in ' . format_time($minVoteWait, true));
	}

	// ------- VERSION --------
	$db->query('SELECT * FROM version ORDER BY went_live DESC LIMIT 1');
	$version = '';
	if ($db->nextRecord()) {
		$container = create_container('skeleton.php', 'changelog_view.php');
		$version = create_link($container, 'v' . $db->getField('major_version') . '.' . $db->getField('minor_version') . '.' . $db->getField('patch_level'));
	}

	$template->assign('Version', $version);
	$template->assign('CurrentYear', date('Y', SmrSession::getTime()));
}

/**
 * Convert an integer number of seconds into a human-readable time.
 * Seconds are omitted to avoid frequent and disruptive ajax updates.
 * Use short=true to use 1-letter units (e.g. "1h and 3m").
 * If seconds is negative, will append "ago" to the result.
 * If seconds is zero, will return only "now".
 * If seconds is <60, will prefix "less than" or "<" (HTML-safe).
 */
function format_time($seconds, $short = false) {
	if ($seconds == 0) {
		return "now";
	}

	if ($seconds < 0) {
		$past = true;
		$seconds = abs($seconds);
	} else {
		$past = false;
	}

	$minutes = ceil($seconds / 60);
	$hours = 0;
	$days = 0;
	$weeks = 0;
	if ($minutes >= 60) {
		$hours = floor($minutes / 60);
		$minutes = $minutes % 60;
	}
	if ($hours >= 24) {
		$days = floor($hours / 24);
		$hours = $hours % 24;
	}
	if ($days >= 7) {
		$weeks = floor($days / 7);
		$days = $days % 7;
	}
	$times = [
		'week' => $weeks,
		'day' => $days,
		'hour' => $hours,
		'minute' => $minutes,
	];
	$parts = [];
	foreach ($times as $unit => $amount) {
		if ($amount > 0) {
			if ($short) {
				$parts[] = $amount . $unit[0];
			} else {
				$parts[] = $amount . ' ' . pluralise($unit, $amount);
			}
		}
	}

	if (count($parts) == 1) {
		$result = $parts[0];
	} else {
		// e.g. 5h, 10m and 30s
		$result = join(', ', array_slice($parts, 0, -1)) . ' and ' . end($parts);
	}

	if ($seconds < 60) {
		$result = ($short ? '&lt;' : 'less than ') . $result;
	}

	if ($past) {
		$result .= ' ago';
	}
	return $result;
}

function number_colour_format($number, $justSign = false) {
	$formatted = '<span';
	if ($number > 0) {
		$formatted .= ' class="green">+';
	} else if ($number < 0) {
		$formatted .= ' class="red">-';
	} else {
		$formatted .= '>';
	}
	if ($justSign === false) {
		$decimalPlaces = 0;
		if (($pos = strpos((string)$number, '.')) !== false) {
			$decimalPlaces = strlen(substr((string)$number, $pos + 1));
		}
		$formatted .= number_format(abs($number), $decimalPlaces);
	}
	$formatted .= '</span>';
	return $formatted;
}


/**
 * Randomly choose an array key weighted by the array values.
 * Probabilities are relative to the total weight. For example:
 *
 * array(
 *    'A' => 1, // 10% chance
 *    'B' => 3, // 30% chance
 *    'C' => 6, // 60% chance
 * );
 */
function getWeightedRandom(array $choices) : string|int {
	// Normalize the weights so that their sum is much larger than 1.
	$maxWeight = max($choices);
	foreach ($choices as $key => $weight) {
		$choices[$key] = IRound($weight * 1000 / $maxWeight);
	}

	// Generate a random number that is lower than the sum of the weights.
	$rand = rand(1, array_sum($choices));
	$rand = rand(1, /** @scrutinizer ignore-type */ array_sum($choices));

	// Subtract weights from the random number until it is negative,
	// then return the key associated with that weight.
	foreach ($choices as $key => $weight) {
		$rand -= $weight;
		if ($rand <= 0) {
			return $key;
		}
	}
	throw new Exception('Internal error computing weights');
}

smrealms / smr

Scrutinizer GitHub App not installed

Push — master ( 2bbb94...dae5f6 )

forwardURL() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
