smrealms / smr

src/tools/npc/npc.php

<?php declare(strict_types=1);

use Smr\Container\DiContainer;
use Smr\Database;
use Smr\Epoch;
use Smr\Npc\Exceptions\FinalAction;
use Smr\Npc\Exceptions\ForwardAction;
use Smr\Npc\Exceptions\TradeRouteDrained;
use Smr\Npc\NpcActor;
use Smr\Page\Page;
use Smr\Pages\Account\ErrorDisplay;
use Smr\Pages\Player\CargoDumpProcessor;
use Smr\Pages\Player\CurrentSector;
use Smr\Pages\Player\PlotCourseConventionalProcessor;
use Smr\Pages\Player\PlotCourseNearestProcessor;
use Smr\Pages\Player\SectorMoveProcessor;
use Smr\Pages\Player\ShopGoodsProcessor;
use Smr\Race;
use Smr\Routes\RouteGenerator;
use Smr\SectorLock;
use Smr\TradeGood;
use Smr\TransactionType;

function overrideForward(Page $container): never {
	global $forwardedContainer;
	$forwardedContainer = $container;
	if ($container instanceof ErrorDisplay) {
		// We hit a create_error - this shouldn't happen for an NPC often,
		// for now we want to throw an exception for it for testing.
		debug('Hit an error');
		throw new Exception($container->message);
	}
	// We have to throw the exception to get back up the stack,
	// otherwise we quickly hit problems of overflowing the stack.
	throw new ForwardAction();
}
const OVERRIDE_FORWARD = true;

// global config
require_once(realpath(dirname(__FILE__)) . '/../../bootstrap.php');

// Enable NPC-specific conditions
DiContainer::getContainer()->set('NPC_SCRIPT', true);

// Raise exceptions for all types of errors for improved error reporting
// and to attempt to shut down the NPCs cleanly on errors.
set_error_handler('exception_error_handler');

const SHIP_UPGRADE_PATH = [
	RACE_ALSKANT => [
		SHIP_TYPE_TRADE_MASTER,
		SHIP_TYPE_DEEP_SPACER,
		SHIP_TYPE_DEAL_MAKER,
		SHIP_TYPE_TRIP_MAKER,
		SHIP_TYPE_SMALL_TIMER,
	],
	RACE_CREONTI => [
		SHIP_TYPE_DEVASTATOR,
		SHIP_TYPE_JUGGERNAUT,
		SHIP_TYPE_GOLIATH,
		SHIP_TYPE_LEVIATHAN,
		SHIP_TYPE_MEDIUM_CARGO_HULK,
	],
	RACE_HUMAN => [
		SHIP_TYPE_DESTROYER,
		SHIP_TYPE_BORDER_CRUISER,
		SHIP_TYPE_AMBASSADOR,
		SHIP_TYPE_RENAISSANCE,
		SHIP_TYPE_LIGHT_FREIGHTER,
	],
	RACE_IKTHORNE => [
		SHIP_TYPE_MOTHER_SHIP,
		SHIP_TYPE_ADVANCED_CARRIER,
		SHIP_TYPE_FAVOURED_OFFSPRING,
		SHIP_TYPE_PROTO_CARRIER,
		SHIP_TYPE_TINY_DELIGHT,
	],
	RACE_SALVENE => [
		SHIP_TYPE_EATER_OF_SOULS,
		SHIP_TYPE_RAVAGER,
		SHIP_TYPE_PREDATOR,
		SHIP_TYPE_DRUDGE,
		SHIP_TYPE_HATCHLINGS_DUE,
	],
	RACE_THEVIAN => [
		SHIP_TYPE_ASSAULT_CRAFT,
		SHIP_TYPE_CARAPACE,
		SHIP_TYPE_BOUNTY_HUNTER,
		SHIP_TYPE_EXPEDITER,
		SHIP_TYPE_SWIFT_VENTURE,
	],
	RACE_WQHUMAN => [
		SHIP_TYPE_DARK_MIRAGE,
		SHIP_TYPE_BLOCKADE_RUNNER,
		SHIP_TYPE_ROGUE,
		SHIP_TYPE_RESISTANCE,
		SHIP_TYPE_SLIP_FREIGHTER,
	],
	RACE_NIJARIN => [
		SHIP_TYPE_FURY,
		SHIP_TYPE_VINDICATOR,
		SHIP_TYPE_VENGEANCE,
		SHIP_TYPE_RETALIATION,
		SHIP_TYPE_REDEEMER,
	],
];


try {
	while (npcDriver() === false) {
		// No actions taken, try another NPC
	}
} catch (Throwable $e) {
	logException($e);

The function logException was not found. Maybe you did not declare it correctly or list all dependencies?

}
// Try to shut down cleanly
exitNPC();


/**
 * @return bool If the NPC performed any actions
 */
function npcDriver(): bool {
	global $previousContainer;

	$session = Smr\Session::getInstance();
	$session->setCurrentVar(new Page()); // initialize fake var

	// Load the first available NPC
	changeNPCLogin();

	// We chose a new NPC, we don't care what we were doing beforehand.
	$previousContainer = null;

	try {
		$actor = new NpcActor($session->getGameID(), $session->getAccountID());
	} catch (FinalAction) {
		// Startup conditions not satisfied, try another NPC
		return false;
	}

	// Loop over actions for this NPC
	while (true) {
		try {
			$container = $actor->getNextAction();
			processContainer($container);
		} catch (ForwardAction) {
			// we took an action
		} catch (FinalAction) {
			$actor->shutdown();
			// switch to a new NPC if we haven't taken any actions yet
			return $actor->getNumActions() > 0;
		} finally {
			// Save any changes that we made during this action
			saveAllAndReleaseLock(updateSession: false);

			//Clean up the caches as the data may get changed by other players
			clearCaches();
		}

		//Have a sleep between actions
		sleepNPC();
	}
}

function clearCaches(): void {
	SmrSector::clearCache();
	SmrPlayer::clearCache();
	SmrShip::clearCache();
	SmrForce::clearCache();
	SmrPort::clearCache();
}

function debug(string $message, mixed $debugObject = null): void {
	echo date('Y-m-d H:i:s - ') . $message . ($debugObject !== null ? EOL . var_export($debugObject, true) : '') . EOL;
	if (NPC_LOG_TO_DATABASE) {
		$session = Smr\Session::getInstance();
		$accountID = $session->getAccountID();
		$var = $session->getCurrentVar();
		$db = Database::getInstance();
		$logID = $db->insert('npc_logs', [
			'script_id' => $db->escapeNumber(defined('SCRIPT_ID') ? SCRIPT_ID : 0),
			'npc_id' => $db->escapeNumber($accountID),
			'time' => 'NOW()',
			'message' => $db->escapeString($message),
			'debug_info' => $db->escapeString(var_export($debugObject, true)),
			'var' => $db->escapeString(var_export($var, true)),
		]);

		// On the first call to debug, we need to update the script_id retroactively
		if (!defined('SCRIPT_ID')) {
			define('SCRIPT_ID', $logID);
			$db->write('UPDATE npc_logs SET script_id=' . SCRIPT_ID . ' WHERE log_id=' . SCRIPT_ID);
		}
	}
}

/**
 * Determines if a player has enough turns to start taking actions
 */
function checkStartConditions(AbstractSmrPlayer $player): void {
	$minTurnsThreshold = rand($player->getMaxTurns() / 2, $player->getMaxTurns());
	if ($player->getTurns() < $minTurnsThreshold && !$player->canFight()) {
		debug('We don\'t have enough turns to bother starting trading, and we are protected: ' . $player->getTurns());
		throw new FinalAction();
	}
}

function processContainer(Page $container): never {
	global $forwardedContainer, $previousContainer;
	$session = Smr\Session::getInstance();
	$player = $session->getPlayer();
	if ($container == $previousContainer && $forwardedContainer->file != 'forces_attack.php') {
		debug('We are executing the same container twice?', ['ForwardedContainer' => $forwardedContainer, 'Container' => $container]);
		if (!$player->canFight()) {
			// Only throw the exception if we have protection, otherwise let's hope that the NPC will be able to find its way to safety rather than dying in the open.
			throw new Exception('We are executing the same container twice?');
		}
	}
	clearCaches(); //Clear caches of anything we have used for decision making before processing container and getting lock.
	$previousContainer = $container;
	debug('Executing container', $container);
	// The next "page request" must occur at an updated time.
	Epoch::update();
	$session->setCurrentVar($container);

	SectorLock::getInstance()->acquireForPlayer($player);
	$container->process();
	throw new Exception('Container did not forward as expected!');
}

function sleepNPC(): void {
	usleep(rand(NPC_MIN_SLEEP_TIME, NPC_MAX_SLEEP_TIME)); //Sleep for a random time
}

// Releases an NPC when it is done working
function releaseNPC(): void {
	$session = Smr\Session::getInstance();
	if (!$session->hasAccount()) {
		debug('releaseNPC: no NPC to release');
		return;
	}
	$login = $session->getAccount()->getLogin();
	$db = Database::getInstance();
	$db->write('UPDATE npc_logins SET working=' . $db->escapeBoolean(false) . ' WHERE login=' . $db->escapeString($login));
	if ($db->getChangedRows() > 0) {
		debug('Released NPC: ' . $login);
	} else {
		debug('Failed to release NPC: ' . $login);
	}

	// Delete sector lock associated with this NPC
	SectorLock::resetInstance();
}

function exitNPC(): void {
	debug('Exiting NPC script.');
	releaseNPC();
	exit;

Using exit here is not recommended.

}

function changeNPCLogin(): void {
	// Release previous NPC, if any
	releaseNPC();

	// Lacking a convenient way to get up-to-date turns, order NPCs by how
	// recently they have taken an action.
	debug('Choosing new NPC');
	static $availableNpcs = null;

	$db = Database::getInstance();
	$session = Smr\Session::getInstance();

	if ($availableNpcs === null) {
		// Make sure NPC's have been set up in the database
		$dbResult = $db->read('SELECT 1 FROM npc_logins LIMIT 1');
		if (!$dbResult->hasRecord()) {
			debug('No NPCs have been created yet!');
			exitNPC();
		}

		// Make sure to select NPCs from active games only
		$dbResult = $db->read('SELECT account_id, game_id FROM player JOIN account USING(account_id) JOIN npc_logins USING(login) JOIN game USING(game_id) WHERE active=\'TRUE\' AND working=\'FALSE\' AND start_time < ' . $db->escapeNumber(Epoch::time()) . ' AND end_time > ' . $db->escapeNumber(Epoch::time()) . ' ORDER BY last_turn_update ASC');
		foreach ($dbResult->records() as $dbRecord) {
			$availableNpcs[] = [
				'account_id' => $dbRecord->getInt('account_id'),
				'game_id' => $dbRecord->getInt('game_id'),
			];
		}
	}

	if (empty($availableNpcs)) {
		debug('No free NPCs');
		exitNPC();
	}

	// Pop an NPC off the top of the stack to activate
	$npc = array_shift($availableNpcs);

	// Update session info for this chosen NPC
	$account = SmrAccount::getAccount($npc['account_id']);
	$session->setAccount($account);
	$session->updateGame($npc['game_id']);

	$db->write('UPDATE npc_logins SET working=' . $db->escapeBoolean(true) . ' WHERE login=' . $db->escapeString($account->getLogin()));
	debug('Chosen NPC: login = ' . $account->getLogin() . ', game = ' . $session->getGameID() . ', player = ' . $session->getPlayer()->getPlayerName());
}

function tradeGoods(int $goodID, AbstractSmrPlayer $player, SmrPort $port): Page {
	sleepNPC(); //We have an extra sleep at port to make the NPC more vulnerable.
	$ship = $player->getShip();
	$relations = $player->getRelation($port->getRaceID());

	$transaction = $port->getGoodTransaction($goodID);

	if ($transaction === TransactionType::Buy) {
		debug('Buy Goods');
		$amount = $ship->getEmptyHolds();
	} else {
		debug('Sell Goods');
		$amount = $ship->getCargo($goodID);
	}

	if ($port->getGoodAmount($goodID) < $amount) {
		throw new TradeRouteDrained();
	}

	$idealPrice = $port->getIdealPrice($goodID, $transaction, $amount, $relations);
	$offeredPrice = $port->getOfferPrice($idealPrice, $relations, $transaction);

	return new ShopGoodsProcessor(
		goodID: $goodID,
		amount: $amount,
		bargainNumber: 1,
		bargainPrice: $offeredPrice // take the offered price
	);
}

function dumpCargo(AbstractSmrPlayer $player): Page {
	$ship = $player->getShip();
	$cargo = $ship->getCargo();
	debug('Ship Cargo', $cargo);
	foreach ($cargo as $goodID => $amount) {
		if ($amount > 0) {
			return new CargoDumpProcessor($goodID, $amount);
		}
	}
	throw new Exception('Called dumpCargo without any cargo!');
}

function plotToSector(AbstractSmrPlayer $player, int $sectorID): Page {
	return new PlotCourseConventionalProcessor(from: $player->getSectorID(), to: $sectorID);
}

function plotToFed(AbstractSmrPlayer $player): Page {
	debug('Plotting To Fed');

	// Always drop illegal goods before heading to fed space
	if ($player->getShip()->hasIllegalGoods()) {
		debug('Dumping illegal goods');
		processContainer(dumpCargo($player));
	}

	$fedLocID = $player->getRaceID() + LOCATION_GROUP_RACIAL_BEACONS;
	$container = plotToNearest($player, SmrLocation::getLocation($player->getGameID(), $fedLocID));
	if ($container === false) {

The condition $container === false is always false.

		debug('Plotted to fed whilst in fed, switch NPC and wait for turns');
		throw new FinalAction();
	}
	return $container;
}

function plotToNearest(AbstractSmrPlayer $player, mixed $realX): Page|false {
	debug('Plotting To: ', $realX); //TODO: Can we make the debug output a bit nicer?

	if ($player->getSector()->hasX($realX)) { //Check if current sector has what we're looking for before we attempt to plot and get error.
		debug('Already available in sector');
		return false;
	}

	return new PlotCourseNearestProcessor($realX);
}

function moveToSector(AbstractSmrPlayer $player, int $targetSector): Page {
	debug('Moving from #' . $player->getSectorID() . ' to #' . $targetSector);
	return new SectorMoveProcessor($targetSector, new CurrentSector());
}

function checkForShipUpgrade(AbstractSmrPlayer $player): void {
	foreach (SHIP_UPGRADE_PATH[$player->getRaceID()] as $upgradeShipID) {
		if ($player->getShipTypeID() == $upgradeShipID) {
			//We can't upgrade, only downgrade.
			return;
		}
		$cost = $player->getShip()->getCostToUpgrade($upgradeShipID);
		$balance = $player->getCredits() - $cost;
		if ($balance > NPC_MINIMUM_RESERVE_CREDITS) {
			debug('Upgrading to ship type: ' . $upgradeShipID);
			$player->setCredits($balance);
			$player->getShip()->setTypeID($upgradeShipID);
			return;
		}
	}
}

function setupShip(AbstractSmrPlayer $player): void {
	// Upgrade ships if we can
	checkForShipUpgrade($player);

	// Start the NPC with max hardware
	$ship = $player->getShip();
	$ship->setHardwareToMax();

	// Equip the ship with as many lasers as it can hold
	$weaponIDs = [
		WEAPON_TYPE_PLANETARY_PULSE_LASER,
		WEAPON_TYPE_HUGE_PULSE_LASER,
		WEAPON_TYPE_HUGE_PULSE_LASER,
		WEAPON_TYPE_LARGE_PULSE_LASER,
		WEAPON_TYPE_LARGE_PULSE_LASER,
		WEAPON_TYPE_LARGE_PULSE_LASER,
		WEAPON_TYPE_LASER,
	];
	$ship->removeAllWeapons();
	while ($ship->hasOpenWeaponSlots()) {
		$weapon = SmrWeapon::getWeapon(array_shift($weaponIDs));
		$ship->addWeapon($weapon);
	}

	// Enable special hardware
	if ($ship->hasCloak()) {
		$ship->enableCloak();
	}
	if ($ship->hasIllusion()) {
		$illusionShipID = array_rand_value(SHIP_UPGRADE_PATH[$player->getRaceID()]);

The function array_rand_value was not found. Maybe you did not declare it correctly or list all dependencies?

		$ship->setIllusion($illusionShipID, rand(8, 25), rand(6, 20));
	}

	// Update database (not essential to have a lock here)
	$player->update();
	$ship->update();
}

/**
 * @return array<Smr\Routes\MultiplePortRoute>
 */
function findRoutes(AbstractSmrPlayer $player): array {
	debug('Finding Routes');

	$tradeGoods = [GOODS_NOTHING => false];
	foreach (TradeGood::getAll() as $goodID => $good) {
		if ($player->meetsAlignmentRestriction($good->alignRestriction)) {
			$tradeGoods[$goodID] = true;
		} else {
			$tradeGoods[$goodID] = false;
		}
	}

	// Only allow NPCs to trade at ports of their race and neutral ports
	$tradeRaces = [];
	foreach (Race::getAllIDs() as $raceID) {
		$tradeRaces[$raceID] = false;
	}
	$tradeRaces[$player->getRaceID()] = true;
	$tradeRaces[RACE_NEUTRAL] = true;

	// Trade in all Racial/Neutral galaxies up until the first Planet galaxy
	$galaxies = [];
	foreach ($player->getGame()->getGalaxies() as $galaxy) {
		if ($galaxy->getGalaxyType() == SmrGalaxy::TYPE_PLANET) {
			break;
		}
		$galaxies[] = $galaxy;
	}
	// Fallback to current galaxy in case this has selected no galaxies
	if (count($galaxies) == 0) {
		$galaxies[] = $player->getSector()->getGalaxy();
	}

	// Determine the trade area (start of first galaxy to end of last)
	$startSectorID = reset($galaxies)->getStartSector();
	$endSectorID = end($galaxies)->getEndSector();

	$maxNumberOfPorts = 2;
	$routesForPort = -1;
	$numberOfRoutes = 100;
	$maxDistance = 15;

	$db = Database::getInstance();
	$dbResult = $db->read('SELECT routes FROM route_cache WHERE game_id=' . $db->escapeNumber($player->getGameID()) . ' AND max_ports=' . $db->escapeNumber($maxNumberOfPorts) . ' AND goods_allowed=' . $db->escapeObject($tradeGoods) . ' AND races_allowed=' . $db->escapeObject($tradeRaces) . ' AND start_sector_id=' . $db->escapeNumber($startSectorID) . ' AND end_sector_id=' . $db->escapeNumber($endSectorID) . ' AND routes_for_port=' . $db->escapeNumber($routesForPort) . ' AND max_distance=' . $db->escapeNumber($maxDistance));
	if ($dbResult->hasRecord()) {
		$routes = $dbResult->record()->getObject('routes', true);
		debug('Using Cached Routes: #' . count($routes));
		return $routes;
	}

	debug('Generating Routes');
	$ports = [];
	foreach ($galaxies as $galaxy) {
		$ports += $galaxy->getPorts(); // Merge arrays
	}

	$distances = Plotter::calculatePortToPortDistances($ports, $tradeRaces, $maxDistance, $startSectorID, $endSectorID);

	$allRoutes = RouteGenerator::generateMultiPortRoutes($maxNumberOfPorts, $ports, $tradeGoods, $tradeRaces, $distances, $routesForPort, $numberOfRoutes);

	unset($distances);

	$routesMerged = [];
	foreach ($allRoutes[RouteGenerator::MONEY_ROUTE] as $routesByMulti) {
		$routesMerged += $routesByMulti; //Merge arrays
	}

	SmrPort::clearCache();
	SmrSector::clearCache();

	if (count($routesMerged) == 0) {
		debug('Could not find any routes! Try another NPC.');
		throw new FinalAction();
	}

	$db->insert('route_cache', [
		'game_id' => $db->escapeNumber($player->getGameID()),
		'max_ports' => $db->escapeNumber($maxNumberOfPorts),
		'goods_allowed' => $db->escapeObject($tradeGoods),
		'races_allowed' => $db->escapeObject($tradeRaces),
		'start_sector_id' => $db->escapeNumber($startSectorID),
		'end_sector_id' => $db->escapeNumber($endSectorID),
		'routes_for_port' => $db->escapeNumber($routesForPort),
		'max_distance' => $db->escapeNumber($maxDistance),
		'routes' => $db->escapeObject($routesMerged, true),
	]);
	debug('Found Routes: #' . count($routesMerged));
	return $routesMerged;
}