pokemon-showdown/server/room-battle.js
Guangcong Luo 93925a6308 Rename .players
.players -> .playerTable, .playerList -> .players
2019-05-12 12:54:13 +09:30

1199 lines
35 KiB
JavaScript

/**
* Room Battle
* Pokemon Showdown - http://pokemonshowdown.com/
*
* This file wraps the simulator in an implementation of the RoomGame
* interface. It also abstracts away the multi-process nature of the
* simulator.
*
* For the actual battle simulation, see sim/
*
* @license MIT
*/
'use strict';
/** @type {typeof import('../sim/battle-stream').BattleStream} */
const BattleStream = require(/** @type {any} */ ('../.sim-dist/battle-stream')).BattleStream;
/** @type {typeof import('../lib/fs').FS} */
const FS = require(/** @type {any} */('../.lib-dist/fs')).FS;
/** @type {typeof import('./room-game')} */
const RoomGames = require(/** @type {any} */ ('./room-game'));
/** 5 seconds */
const TICK_TIME = 5;
const SECONDS = 1000;
// Timer constants: In seconds, should be multiple of TICK_TIME
const STARTING_TIME = 150;
const MAX_TURN_TIME = 150;
const STARTING_TIME_CHALLENGE = 300;
const STARTING_GRACE_TIME = 60;
const MAX_TURN_TIME_CHALLENGE = 300;
const DISCONNECTION_TIME = 60;
const DISCONNECTION_BANK_TIME = 300;
// time after a player disabling the timer before they can re-enable it
const TIMER_COOLDOWN = 20 * SECONDS;
class RoomBattlePlayer extends RoomGames.RoomGamePlayer {
/**
* @param {User | string | null} user
* @param {RoomBattle} game
* @param {number} num
*/
constructor(user, game, num) {
super(user, game, num);
if (typeof user === 'string') user = null;
this.slot = /** @type {SideID} */ (`p${num}`);
this.channelIndex = /** @type {0 | 1 | 2 | 3 | 4} */
(game.gameType === 'multi' && num > 2 ? num - 2 : num);
/** @type {BattleRequestTracker} */
this.request = {rqid: 0, request: '', isWait: 'cantUndo', choice: ''};
this.active = true;
this.eliminated = false;
/**
* Total timer.
*
* Starts at 210 per player in a ladder battle. Goes down by 5
* every tick. Goes up by 10 every turn (with some complications -
* see `nextRequest`), capped at starting time. The player loses if
* this reaches 0.
*
* The equivalent of "Your Time" in VGC.
*
* @type {number}
*/
this.secondsLeft = 1;
/**
* Turn timer.
*
* Set equal to the player's overall timer, but capped at 150
* seconds in a ladder battle. Goes down by 5 every tick.
* Tracked separately from the overall timer, and the player also
* loses if this reaches 0.
*
* @type {number}
*/
this.turnSecondsLeft = 1;
/**
* Disconnect timer.
* Starts at 60 seconds. While the player is disconnected, this
* will go down by 5 every tick. Tracked separately from the
* overall timer, and the player also loses if this reaches 0.
*
* Mostly exists so impatient players don't have to wait the full
* 150 seconds against a disconnected opponent.
*
* @type {number}
*/
this.dcSecondsLeft = 1;
/**
* Used to track a user's last known connection status, and display
* the proper message when it changes.
* @type {boolean}
*/
this.connected = true;
if (user) {
user.games.add(this.game.id);
user.updateSearch();
for (const connection of user.connections) {
if (connection.inRooms.has(game.id)) {
Sockets.channelMove(connection.worker, this.game.id, this.channelIndex, connection.socketid);
}
}
}
}
getUser() {
return (this.userid && Users(this.userid)) || null;
}
destroy() {
const user = this.getUser();
if (user) {
for (const connection of user.connections) {
Sockets.channelMove(connection.worker, this.game.id, 0, connection.socketid);
}
user.games.delete(this.game.id);
user.updateSearch();
}
// @ts-ignore
this.game[this.slot] = null;
}
updateChannel(/** @type {User | Connection} */ user) {
if (user instanceof Users.Connection) {
// "user" is actually a connection
Sockets.channelMove(user.worker, this.game.id, this.channelIndex, user.socketid);
return;
}
for (const connection of user.connections) {
Sockets.channelMove(connection.worker, this.game.id, this.channelIndex, connection.socketid);
}
}
toString() {
return this.userid;
}
send(/** @type {string} */ data) {
const user = this.getUser();
if (user) user.send(data);
}
sendRoom(/** @type {string} */ data) {
const user = this.getUser();
if (user) user.sendTo(this.game.id, data);
}
}
class RoomBattleTimer {
/**
* @param {RoomBattle} battle
*/
constructor(battle) {
/** @type {RoomBattle} */
this.battle = battle;
/** @type {NodeJS.Timer?} */
this.timer = null;
/** @type {Set<string>} */
this.timerRequesters = new Set();
/**
* Last tick, as milliseconds since UNIX epoch.
* Represents the last time a tick happened.
*/
this.lastTick = 0;
/** Debug mode; true to output detailed timer info every tick */
this.debug = false;
this.lastDisabledTime = 0;
this.lastDisabledByUser = null;
const hasLongTurns = Dex.getFormat(battle.format, true).gameType !== 'singles';
const isChallenge = (!battle.rated && !battle.room.tour);
const timerSettings = Dex.getFormat(battle.format, true).timer;
// so that Object.assign doesn't overwrite anything with `undefined`
for (const k in timerSettings) {
// @ts-ignore
if (timerSettings[k] === undefined) delete timerSettings[k];
}
/** @type {GameTimerSettings} */
this.settings = Object.assign({
dcTimer: !isChallenge,
dcTimerBank: isChallenge,
starting: isChallenge ? STARTING_TIME_CHALLENGE : STARTING_TIME,
grace: STARTING_GRACE_TIME,
addPerTurn: hasLongTurns ? 25 : 10,
maxPerTurn: isChallenge ? MAX_TURN_TIME_CHALLENGE : MAX_TURN_TIME,
maxFirstTurn: isChallenge ? MAX_TURN_TIME_CHALLENGE : MAX_TURN_TIME,
timeoutAutoChoose: false,
accelerate: !timerSettings,
}, timerSettings);
if (this.settings.maxPerTurn <= 0) this.settings.maxPerTurn = Infinity;
for (const player of this.battle.players) {
player.secondsLeft = this.settings.starting + this.settings.grace;
player.turnSecondsLeft = -1;
player.dcSecondsLeft = this.settings.dcTimerBank ? DISCONNECTION_BANK_TIME : DISCONNECTION_TIME;
}
}
start(/** @type {User} */ requester) {
let userid = requester ? requester.userid : 'staff';
if (this.timerRequesters.has(userid)) return false;
if (this.timer) {
this.battle.room.add(`|inactive|${requester ? requester.name : userid} also wants the timer to be on.`).update();
this.timerRequesters.add(userid);
return false;
}
if (requester && this.battle.playerTable[requester.userid] && this.lastDisabledByUser === requester.userid) {
const remainingCooldownMs = (this.lastDisabledTime || 0) + TIMER_COOLDOWN - Date.now();
if (remainingCooldownMs > 0) {
this.battle.playerTable[requester.userid].sendRoom(`|inactiveoff|The timer can't be re-enabled so soon after disabling it (${Math.ceil(remainingCooldownMs / SECONDS)} seconds remaining).`);
return false;
}
}
this.timerRequesters.add(userid);
this.nextRequest(true);
const requestedBy = requester ? ` (requested by ${requester.name})` : ``;
this.battle.room.add(`|inactive|Battle timer is ON: inactive players will automatically lose when time's up.${requestedBy}`).update();
return true;
}
stop(/** @type {User} */ requester) {
if (requester) {
if (!this.timerRequesters.has(requester.userid)) return false;
this.timerRequesters.delete(requester.userid);
this.lastDisabledByUser = requester.userid;
this.lastDisabledTime = Date.now();
} else {
this.timerRequesters.clear();
}
if (this.timerRequesters.size) {
this.battle.room.add(`|inactive|${requester.name} no longer wants the timer on, but the timer is staying on because ${[...this.timerRequesters].join(', ')} still does.`).update();
return false;
}
if (!this.timer) return false;
clearTimeout(this.timer);
this.timer = null;
this.battle.room.add(`|inactiveoff|Battle timer is now OFF.`).update();
return true;
}
waitingForChoice(/** @type {SideID} */ slot) {
return !this.battle[slot].request.isWait;
}
nextRequest(isFirst = false) {
if (this.timer) clearTimeout(this.timer);
if (!this.timerRequesters.size) return;
const players = this.battle.players;
if (players.some(player => player.secondsLeft <= 0)) return;
const maxTurnTime = (isFirst ? this.settings.maxFirstTurn : 0) || this.settings.maxPerTurn;
let addPerTurn = isFirst ? 0 : this.settings.addPerTurn;
if (this.settings.accelerate && addPerTurn) {
// after turn 100ish: 15s/turn -> 10s/turn
if (this.battle.requestCount > 200) {
addPerTurn -= TICK_TIME;
}
// after turn 200ish: 10s/turn -> 7s/turn
if (this.battle.requestCount > 400 && Math.floor(this.battle.requestCount / 2) % 2) {
addPerTurn = 0;
}
}
const room = this.battle.room;
for (const player of players) {
if (!isFirst) {
player.secondsLeft = Math.min(player.secondsLeft + addPerTurn, this.settings.starting);
}
player.turnSecondsLeft = Math.min(player.secondsLeft, maxTurnTime);
const secondsLeft = player.turnSecondsLeft;
let grace = player.secondsLeft - this.settings.starting;
if (grace < 0) grace = 0;
if (player) player.sendRoom(`|inactive|Time left: ${secondsLeft} sec this turn | ${player.secondsLeft - grace} sec total` + (grace ? ` | ${grace} sec grace` : ``));
if (secondsLeft <= 30) {
room.add(`|inactive|${player.name} has ${secondsLeft} seconds left this turn.`);
}
if (this.debug) {
room.add(`||${player.name} | Time left: ${secondsLeft} sec this turn | ${player.secondsLeft} sec total | +${addPerTurn} seconds`);
}
}
room.update();
this.lastTick = Date.now();
this.timer = setTimeout(() => this.nextTick(), TICK_TIME * SECONDS);
}
nextTick() {
if (this.timer) clearTimeout(this.timer);
if (this.battle.ended) return;
const room = this.battle.room;
for (const player of this.battle.players) {
if (player.request.isWait) continue;
if (player.connected) {
player.secondsLeft -= TICK_TIME;
player.turnSecondsLeft -= TICK_TIME;
} else {
player.dcSecondsLeft -= TICK_TIME;
if (!this.settings.dcTimerBank) {
player.secondsLeft -= TICK_TIME;
player.turnSecondsLeft -= TICK_TIME;
}
}
let dcSecondsLeft = player.dcSecondsLeft;
if (dcSecondsLeft <= 0) player.turnSecondsLeft = 0;
const secondsLeft = player.turnSecondsLeft;
if (!secondsLeft) continue;
if (!player.connected && (dcSecondsLeft <= secondsLeft || this.settings.dcTimerBank)) {
// dc timer is shown only if it's lower than turn timer or you're in timer bank mode
if (dcSecondsLeft % 30 === 0 || dcSecondsLeft <= 20) {
room.add(`|inactive|${player.name} has ${dcSecondsLeft} seconds to reconnect!`);
}
} else {
// regular turn timer shown
if (secondsLeft % 30 === 0 || secondsLeft <= 20) {
room.add(`|inactive|${player.name} has ${secondsLeft} seconds left.`);
}
}
if (this.debug) {
room.add(`||[${player.name} has ${player.turnSecondsLeft}s this turn / ${player.secondsLeft}s total]`);
}
}
room.update();
if (!this.checkTimeout()) {
this.timer = setTimeout(() => this.nextTick(), TICK_TIME * 1000);
}
}
checkActivity() {
for (const player of this.battle.players) {
const isConnected = !!(player && player.active);
if (isConnected === player.connected) continue;
if (!isConnected) {
// player has disconnected
player.connected = false;
if (!this.settings.dcTimerBank) {
// don't wait longer than 6 ticks (1 minute)
if (this.settings.dcTimer) {
player.dcSecondsLeft = DISCONNECTION_TIME;
} else {
// arbitrary large number
player.dcSecondsLeft = DISCONNECTION_TIME * 10;
}
}
if (this.timerRequesters.size) {
let msg = `!`;
if (this.settings.dcTimer) {
msg = ` and has a minute to reconnect!`;
}
if (this.settings.dcTimerBank) {
if (player.dcSecondsLeft > 0) {
msg = ` and has ${player.dcSecondsLeft} seconds to reconnect!`;
} else {
msg = ` and has no disconnection time left!`;
}
}
this.battle.room.add(`|inactive|${player.name} disconnected${msg}`).update();
}
} else {
// player has reconnected
player.connected = true;
if (this.timerRequesters.size) {
let timeLeft = ``;
if (this.waitingForChoice(player.slot)) {
timeLeft = ` and has ${player.turnSecondsLeft} seconds left`;
}
this.battle.room.add(`|inactive|${player.name} reconnected${timeLeft}.`).update();
}
}
}
}
checkTimeout() {
const players = this.battle.players;
if (players.every(player => player.turnSecondsLeft <= 0)) {
if (!this.settings.timeoutAutoChoose || players.every(player => player.secondsLeft <= 0)) {
this.battle.room.add(`|-message|All players are inactive.`).update();
this.battle.tie();
return true;
}
}
let didSomething = false;
for (const player of players) {
if (player.turnSecondsLeft > 0) continue;
if (this.settings.timeoutAutoChoose && player.secondsLeft > 0 && player.connected) {
this.battle.stream.write(`>${player.slot} default`);
didSomething = true;
} else {
this.battle.forfeitPlayer(player, ' lost due to inactivity.');
return true;
}
}
return didSomething;
}
}
/**
* @typedef {object} BattleRequestTracker
* @property {number} rqid
* @property {string} request
* @property {'cantUndo' | true | false} isWait true = user has decided, false = user has yet to decide, 'cantUndo' = waiting on other user (U-turn, faint-switch) or uncancellable (trapping ability)
* @property {string} choice
*/
class RoomBattle extends RoomGames.RoomGame {
/**
* @param {GameRoom} room
* @param {string} formatid
* @param {AnyObject} options
*/
constructor(room, formatid, options) {
super(room);
let format = Dex.getFormat(formatid, true);
this.gameid = 'battle';
/** @type {GameRoom} */
this.room = room;
this.title = format.name;
if (!this.title.endsWith(" Battle")) this.title += " Battle";
this.allowRenames = options.allowRenames !== undefined ? !!options.allowRenames : (!options.rated && !options.tour);
this.format = formatid;
this.gameType = format.gameType;
/**
* The lower player's rating, for searching purposes.
* 0 for unrated battles. 1 for unknown ratings.
* @type {number}
*/
this.rated = options.rated || 0;
this.started = false;
this.ended = false;
this.active = false;
// TypeScript bug: no `T extends RoomGamePlayer`
/** @type {{[userid: string]: RoomBattlePlayer}} */
this.playerTable = Object.create(null);
// TypeScript bug: no `T extends RoomGamePlayer`
/** @type {RoomBattlePlayer[]} */
this.players = [];
this.playerCap = this.gameType === 'multi' || this.gameType === 'free-for-all' ? 4 : 2;
/** @type {RoomBattlePlayer} */
this.p1 = /** @type {any} */ (null);
/** @type {RoomBattlePlayer} */
this.p2 = /** @type {any} */ (null);
/** @type {RoomBattlePlayer} */
this.p3 = /** @type {any} */ (null);
/** @type {RoomBattlePlayer} */
this.p4 = /** @type {any} */ (null);
// data to be logged
/**
* Has this player consented to input log export? If so, set this
* to the userid allowed to export.
* @type {[string, string]?}
*/
this.allowExtraction = null;
this.logData = null;
this.endType = 'normal';
/**
* If the battle is ended: an array of the number of Pokemon left for each side.
*
* @type {number[] | null}
*/
this.score = null;
this.inputLog = null;
this.rqid = 1;
this.requestCount = 0;
this.stream = PM.createStream();
let ratedMessage = '';
if (options.ratedMessage) {
ratedMessage = options.ratedMessage;
} if (this.rated) {
ratedMessage = 'Rated battle';
} else if (this.room.tour) {
ratedMessage = 'Tournament battle';
}
this.room.battle = this;
let battleOptions = {
formatid: this.format,
id: this.id,
rated: ratedMessage,
seed: options.seed,
};
if (options.inputLog) {
this.stream.write(options.inputLog);
} else {
this.stream.write(`>start ` + JSON.stringify(battleOptions));
}
if (Config.forcetimer) this.timer.start();
this.listen();
this.addPlayer(options.p1, options.p1team || '');
this.addPlayer(options.p2, options.p2team || '');
if (this.playerCap > 2) {
this.addPlayer(options.p3, options.p3team || '');
this.addPlayer(options.p4, options.p4team || '');
}
this.timer = new RoomBattleTimer(this);
this.start();
}
checkActive() {
let active = true;
if (this.ended || !this.started) {
active = false;
} else if (!this.p1 || !this.p1.active) {
active = false;
} else if (!this.p2 || !this.p2.active) {
active = false;
} else if (this.playerCap > 2) {
if (!this.p3 || !this.p3.active) {
active = false;
} else if (!this.p4 || !this.p4.active) {
active = false;
}
}
Rooms.global.battleCount += (active ? 1 : 0) - (this.active ? 1 : 0);
this.room.active = active;
this.active = active;
if (Rooms.global.battleCount === 0) Rooms.global.automaticKillRequest();
}
/**
* @param {User} user
* @param {string} data
*/
choose(user, data) {
const player = this.playerTable[user.userid];
const [choice, rqid] = data.split('|', 2);
if (!player) return;
let request = player.request;
if (request.isWait !== false && request.isWait !== true) {
player.sendRoom(`|error|[Invalid choice] There's nothing to choose`);
return;
}
const allPlayersWait = this.players.every(player => !!player.request.isWait);
if (allPlayersWait || // too late
(rqid && rqid !== '' + request.rqid)) { // WAY too late
player.sendRoom(`|error|[Invalid choice] Sorry, too late to make a different move; the next turn has already started`);
return;
}
user.lastDecision = Date.now();
request.isWait = true;
request.choice = choice;
this.stream.write(`>${player.slot} ${choice}`);
}
/**
* @param {User} user
* @param {string} data
*/
undo(user, data) {
const player = this.playerTable[user.userid];
const [, rqid] = data.split('|', 2);
if (!player) return;
let request = player.request;
if (request.isWait !== true) {
player.sendRoom(`|error|[Invalid choice] There's nothing to cancel`);
return;
}
const allPlayersWait = this.players.every(player => !!player.request.isWait);
if (allPlayersWait || // too late
(rqid && rqid !== '' + request.rqid)) { // WAY too late
player.sendRoom(`|error|[Invalid choice] Sorry, too late to cancel; the next turn has already started`);
return;
}
request.isWait = false;
this.stream.write(`>${player.slot} undo`);
}
/**
* @param {User} user
* @param {SideID?} [slot]
*/
joinGame(user, slot) {
if (!user.can('joinbattle', null, this.room)) {
user.popup(`You must be a set as a player to join a battle you didn't start. Ask a player to use /addplayer on you to join this battle.`);
return false;
}
/** @type {SideID[]} */
let validSlots = [];
for (const player of this.players) {
if (!player.userid) validSlots.push(player.slot);
}
if (slot && !validSlots.includes(slot)) {
user.popup(`This battle already has a user in slot ${slot}.`);
return false;
}
if (!validSlots.length) {
user.popup(`This battle already has two players.`);
return false;
}
if (!slot && validSlots.length > 1) {
user.popup(`Which slot would you like to join into? Use something like \`/joingame ${validSlots[0]}\``);
return false;
}
if (!slot) slot = validSlots[0];
this.updatePlayer(this[slot], user);
this.room.update();
return true;
}
/**
* @param {User} user
*/
leaveGame(user) {
if (!user) return false; // ...
if (this.room.rated || this.room.tour) {
user.popup(`Players can't be swapped out in a ${this.room.tour ? "tournament" : "rated"} battle.`);
return false;
}
const player = this.playerTable[user.userid];
if (!player) {
user.popup(`Failed to leave battle - you're not a player.`);
return false;
}
this.updatePlayer(player, null);
this.room.auth[user.userid] = '+';
this.room.update();
return true;
}
async listen() {
let next;
while ((next = await this.stream.read())) {
this.receive(next.split('\n'));
}
if (!this.ended) {
this.room.add(`|bigerror|The simulator process has crashed. We've been notified and will fix this ASAP.`);
Monitor.crashlog(new Error(`Process disconnected`), `A battle`);
this.started = true;
this.ended = true;
this.checkActive();
}
}
receive(/** @type {string[]} */ lines) {
switch (lines[0]) {
case 'update':
for (const line of lines.slice(1)) {
this.room.add(line);
}
this.room.update();
if (!this.ended) this.timer.nextRequest();
this.checkActive();
break;
case 'sideupdate': {
let slot = /** @type {SideID} */ (lines[1]);
let player = this[slot];
if (lines[2].startsWith(`|error|[Invalid choice] Can't do anything`)) {
// ... should not happen
} else if (lines[2].startsWith(`|error|[Invalid choice]`)) {
let request = this[slot].request;
request.isWait = false;
request.choice = '';
} else if (lines[2].startsWith(`|request|`)) {
this.rqid++;
let request = JSON.parse(lines[2].slice(9));
request.rqid = this.rqid;
const requestJSON = JSON.stringify(request);
this[slot].request = {
rqid: this.rqid,
request: requestJSON,
isWait: request.wait ? 'cantUndo' : false,
choice: '',
};
this.requestCount++;
if (player) player.sendRoom(`|request|${requestJSON}`);
break;
}
if (player) player.sendRoom(lines[2]);
break;
}
case 'end':
this.logData = JSON.parse(lines[1]);
this.score = this.logData.score;
this.inputLog = this.logData.inputLog;
this.started = true;
if (!this.ended) {
this.ended = true;
this.onEnd(this.logData.winner);
this.clearPlayers();
}
this.checkActive();
break;
}
}
/**
* @param {any} winner
*/
async onEnd(winner) {
// Declare variables here in case we need them for non-rated battles logging.
let p1score = 0.5;
const winnerid = toId(winner);
// Check if the battle was rated to update the ladder, return its response, and log the battle.
let p1name = this.p1.name;
let p2name = this.p2.name;
let p1id = toId(p1name);
let p2id = toId(p2name);
if (this.room.rated) {
this.room.rated = 0;
if (winnerid === p1id) {
p1score = 1;
} else if (winnerid === p2id) {
p1score = 0;
}
winner = Users.get(winnerid);
if (winner && !winner.registered) {
this.room.sendUser(winner, '|askreg|' + winner.userid);
}
const [score, p1rating, p2rating] = await Ladders(this.format).updateRating(p1name, p2name, p1score, this.room);
this.logBattle(score, p1rating, p2rating);
} else if (Config.logchallenges) {
if (winnerid === p1id) {
p1score = 1;
} else if (winnerid === p2id) {
p1score = 0;
}
this.logBattle(p1score);
} else {
this.logData = null;
}
if (Config.autosavereplays) {
let uploader = Users.get(winnerid || p1id);
if (uploader && uploader.connections[0]) {
Chat.parse('/savereplay', this.room, uploader, uploader.connections[0]);
}
}
const parentGame = this.room.parent && this.room.parent.game;
if (parentGame && parentGame.onBattleWin) {
parentGame.onBattleWin(this.room, winnerid);
}
this.room.update();
}
/**
* @param {number} p1score
* @param {AnyObject?} p1rating
* @param {AnyObject?} p2rating
* @param {AnyObject?} p3rating
* @param {AnyObject?} p4rating
*/
async logBattle(p1score, p1rating = null, p2rating = null, p3rating = null, p4rating = null) {
if (Dex.getFormat(this.format, true).noLog) return;
let logData = this.logData;
if (!logData) return;
this.logData = null; // deallocate to save space
logData.log = this.room.getLog(3).split('\n'); // replay log (exact damage)
// delete some redundant data
for (const rating of [p1rating, p2rating, p3rating, p4rating]) {
if (rating) {
delete rating.formatid;
delete rating.username;
delete rating.rpsigma;
delete rating.sigma;
}
}
logData.p1rating = p1rating;
logData.p2rating = p2rating;
if (this.playerCap > 2) {
logData.p3rating = p3rating;
logData.p4rating = p4rating;
}
logData.endType = this.endType;
if (!p1rating) logData.ladderError = true;
const date = new Date();
logData.timestamp = '' + date;
logData.id = this.room.id;
logData.format = this.room.format;
const logsubfolder = Chat.toTimestamp(date).split(' ')[0];
const logfolder = logsubfolder.split('-', 2).join('-');
const tier = this.room.format.toLowerCase().replace(/[^a-z0-9]+/g, '');
const logpath = `logs/${logfolder}/${tier}/${logsubfolder}/`;
await FS(logpath).mkdirp();
await FS(logpath + this.room.id + '.log.json').write(JSON.stringify(logData));
//console.log(JSON.stringify(logData));
}
/**
* @param {User} user
* @param {Connection?} connection
*/
onConnect(user, connection = null) {
// this handles joining a battle in which a user is a participant,
// where the user has already identified before attempting to join
// the battle
const player = this.playerTable[user.userid];
if (!player) return;
player.updateChannel(connection || user);
const request = player.request;
if (request) {
let data = `|request|${request.request}`;
if (request.choice) data += `\n|sentchoice|${request.choice}`;
(connection || user).sendTo(this.id, data);
}
if (!player.active) this.onJoin(user);
}
/**
* @param {User} user
* @param {Connection?} connection
*/
onUpdateConnection(user, connection = null) {
this.onConnect(user, connection);
}
/**
* @param {User} user
* @param {string} oldUserid
* @param {boolean} isJoining
* @param {boolean} isForceRenamed
*/
onRename(user, oldUserid, isJoining, isForceRenamed) {
if (user.userid === oldUserid) return;
if (!this.playerTable) {
// !! should never happen but somehow still does
user.games.delete(this.id);
return;
}
if (!(oldUserid in this.playerTable)) {
if (user.userid in this.playerTable) {
// this handles a user renaming themselves into a user in the
// battle (e.g. by using /nick)
this.onConnect(user);
}
return;
}
if (!this.allowRenames) {
let player = this.playerTable[oldUserid];
if (player) {
const message = isForceRenamed ? " lost by having an inappropriate name." : " forfeited by changing their name.";
this.forfeitPlayer(player, message);
}
if (!(user.userid in this.playerTable)) {
user.games.delete(this.id);
}
return;
}
if (user.userid in this.playerTable) return;
let player = this.playerTable[oldUserid];
if (player) {
this.updatePlayer(player, user);
}
const options = {
name: user.name,
avatar: user.avatar,
};
this.stream.write(`>player ${player.slot} ` + JSON.stringify(options));
}
/**
* @param {User} user
*/
onJoin(user) {
let player = this.playerTable[user.userid];
if (player && !player.active) {
player.active = true;
this.timer.checkActivity();
this.room.add(`|player|${player.slot}|${user.name}|${user.avatar}`);
console.trace(player.userid);
}
}
/**
* @param {User} user
*/
onLeave(user) {
let player = this.playerTable[user.userid];
if (player && player.active) {
player.sendRoom(`|request|null`);
player.active = false;
this.timer.checkActivity();
this.room.add(`|player|${player.slot}|`);
}
}
/**
* @param {User} user
*/
win(user) {
if (!user) {
this.tie();
return true;
}
let player = this.playerTable[user.userid];
if (!player) return false;
this.stream.write(`>forcewin ${player.slot}`);
}
tie() {
this.stream.write(`>forcetie`);
}
tiebreak() {
this.stream.write(`>tiebreak`);
}
/**
* @param {User | string} user
* @param {string} message
*/
forfeit(user, message = '') {
if (typeof user !== 'string') user = user.userid;
else user = toId(user);
if (!(user in this.playerTable)) return false;
return this.forfeitPlayer(this.playerTable[user], message);
}
/**
* @param {RoomBattlePlayer} player
* @param {string} message
*/
forfeitPlayer(player, message = '') {
if (this.ended || !this.started) return false;
if (!message) message = ' forfeited.';
this.room.add(`|-message|${player.name}${message}`);
this.endType = 'forfeit';
const otherids = ['p2', 'p1'];
this.stream.write(`>forcewin ${otherids[player.num - 1]}`);
return true;
}
/**
* Team should be '' for random teams. `null` should be used only if importing
* an inputlog (so the player isn't recreated)
*
* @param {User | null} user
* @param {string?} team
*/
addPlayer(user, team) {
// TypeScript bug: no `T extends RoomGamePlayer`
const player = /** @type {RoomBattlePlayer} */ (super.addPlayer(user));
if (!player) return null;
const slot = player.slot;
this[slot] = player;
if (team !== null) {
const options = {
name: player.name,
avatar: user ? '' + user.avatar : '',
team: team,
};
this.stream.write(`>player ${slot} ` + JSON.stringify(options));
}
if (user && user.inRooms.has(this.id)) this.onConnect(user);
return player;
}
makePlayer(/** @type {User} */ user) {
const num = this.players.length + 1;
return new RoomBattlePlayer(user, this, num);
}
/**
* @param {RoomBattlePlayer} player
* @param {User?} user
*/
updatePlayer(player, user) {
super.updatePlayer(player, user);
const slot = player.slot;
if (user) {
const options = {
name: player.name,
avatar: user.avatar,
};
this.stream.write(`>player ${slot} ` + JSON.stringify(options));
this.room.add(`|player|${slot}|${player.name}|${user.avatar}`);
} else {
const options = {
name: '',
};
this.stream.write(`>player ${slot} ` + JSON.stringify(options));
this.room.add(`|player|${slot}|`);
}
}
start() {
// on start
this.started = true;
const users = this.players.map(player => {
const user = player.getUser();
if (!user) throw new Error(`User ${player.name} not found on ${this.id} battle creation`);
return user;
});
Rooms.global.onCreateBattleRoom(users, this.room, {rated: this.rated});
if (this.gameType === 'multi') {
// @ts-ignore
this.room.title = `Team ${this.p1.name} vs. Team ${this.p2.name}`;
} else if (this.gameType === 'free-for-all') {
// p1 vs. p2 vs. p3 vs. p4 is too long of a title
// @ts-ignore
this.room.title = `${this.p1.name} and friends`;
} else {
// @ts-ignore
this.room.title = `${this.p1.name} vs. ${this.p2.name}`;
}
this.room.send(`|title|${this.room.title}`);
}
clearPlayers() {
for (const player of this.players) {
player.destroy();
}
this.playerTable = {};
this.players = [];
// @ts-ignore
this.p1 = null;
// @ts-ignore
this.p2 = null;
// @ts-ignore
this.p3 = null;
// @ts-ignore
this.p4 = null;
}
destroy() {
this.ended = true;
this.stream.destroy();
if (this.active) {
Rooms.global.battleCount += -1;
this.active = false;
}
this.clearPlayers();
// @ts-ignore
this.room = null;
}
}
class RoomBattleStream extends BattleStream {
constructor() {
super({keepAlive: true});
/** @type {Battle} */
// @ts-ignore
this.battle = null;
}
/** @param {string} chunk */
_write(chunk) {
const startTime = Date.now();
try {
this._writeLines(chunk);
} catch (err) {
const battle = this.battle;
Monitor.crashlog(err, 'A battle', {
chunk,
inputLog: battle ? '\n' + battle.inputLog.join('\n') : '',
log: battle ? '\n' + battle.getDebugLog() : '',
});
this.push(`update\n|html|<div class="broadcast-red"><b>The battle crashed</b><br />Don't worry, we're working on fixing it.</div>`);
if (battle) {
for (const side of battle.sides) {
if (side && side.requestState) {
this.push(`sideupdate\n${side.id}\n|error|[Invalid choice] The battle crashed`);
}
}
}
}
if (this.battle) this.battle.sendUpdates();
const deltaTime = Date.now() - startTime;
if (deltaTime > 1000) {
console.log(`[slow battle] ${deltaTime}ms - ${chunk}`);
}
}
/**
* @param {string} type
* @param {string} message
*/
_writeLine(type, message) {
switch (type) {
case 'eval':
/* eslint-disable no-eval, no-unused-vars */
const battle = this.battle;
const p1 = battle && battle.sides[0];
const p2 = battle && battle.sides[1];
const p3 = battle && battle.sides[2];
const p4 = battle && battle.sides[3];
const p1active = p1 && p1.active[0];
const p2active = p2 && p2.active[0];
const p3active = p3 && p3.active[0];
const p4active = p4 && p4.active[0];
battle.inputLog.push(`${type} ${message}`);
message = message.replace(/\f/g, '\n');
battle.add('', '>>> ' + message.replace(/\n/g, '\n||'));
try {
let result = eval(message);
if (result && result.then) {
result.then((/** @type {any} */ unwrappedResult) => {
unwrappedResult = Chat.stringify(unwrappedResult);
battle.add('', 'Promise -> ' + unwrappedResult);
battle.sendUpdates();
}, (/** @type {Error} */ error) => {
battle.add('', '<<< error: ' + error.message);
battle.sendUpdates();
});
} else {
result = Chat.stringify(result);
result = result.replace(/\n/g, '\n||');
battle.add('', '<<< ' + result);
}
} catch (e) {
battle.add('', '<<< error: ' + e.message);
}
/* eslint-enable no-eval, no-unused-vars */
break;
default: super._writeLine(type, message);
}
}
}
exports.RoomBattlePlayer = RoomBattlePlayer;
exports.RoomBattleTimer = RoomBattleTimer;
exports.RoomBattle = RoomBattle;
exports.RoomBattleStream = RoomBattleStream;
/*********************************************************
* Process manager
*********************************************************/
/** @type {typeof import('../lib/process-manager').StreamProcessManager} */
const StreamProcessManager = require(/** @type {any} */('../.lib-dist/process-manager')).StreamProcessManager;
const PM = new StreamProcessManager(module, () => {
return new RoomBattleStream();
});
if (!PM.isParentProcess) {
// This is a child process!
// @ts-ignore This file doesn't exist on the repository, so Travis checks fail if this isn't ignored
global.Config = require('../config/config');
global.Chat = require('./chat');
// @ts-ignore ???
global.Monitor = {
/**
* @param {Error} error
* @param {string} source
* @param {{}?} details
*/
crashlog(error, source = 'A simulator process', details = null) {
const repr = JSON.stringify([error.name, error.message, source, details]);
// @ts-ignore
process.send(`THROW\n@!!@${repr}\n${error.stack}`);
},
};
global.__version = '';
try {
const execSync = require('child_process').execSync;
const out = execSync('git merge-base master HEAD', {
stdio: ['ignore', 'pipe', 'ignore'],
});
global.__version = ('' + out).trim();
} catch (e) {}
if (Config.crashguard) {
// graceful crash - allow current battles to finish before restarting
process.on('uncaughtException', err => {
Monitor.crashlog(err, 'A simulator process');
});
process.on('unhandledRejection', err => {
if (err instanceof Error) {
Monitor.crashlog(err, 'A simulator process Promise');
}
});
}
/** @type {typeof import('../lib/repl').Repl} */
const Repl = require(/** @type {any} */('../.lib-dist/repl')).Repl;
Repl.start(`sim-${process.pid}`, cmd => eval(cmd));
} else {
PM.spawn(global.Config ? Config.simulatorprocesses : 1);
}
exports.PM = PM;