import EventEmitter from 'events'; import axios from 'axios'; import Gamedig from 'gamedig'; import Logger from 'core/logger'; import { SQUADJS_API_DOMAIN } from 'core/constants'; import LogParser from './log-parser/index.js'; import Rcon from './rcon.js'; import { SQUADJS_VERSION } from './utils/constants.js'; import { SquadLayers } from './utils/squad-layers.js'; import fetchAdminLists from './utils/admin-lists.js'; export default class SquadServer extends EventEmitter { constructor(options = {}) { super(); for (const option of ['host', 'queryPort']) if (!(option in options)) throw new Error(`${option} must be specified.`); this.id = options.id; this.options = options; this.layerHistory = []; this.layerHistoryMaxLength = options.layerHistoryMaxLength || 20; this.players = []; this.plugins = []; this.squadLayers = new SquadLayers(options.squadLayersSource); this.setupRCON(); this.setupLogParser(); this.updatePlayerList = this.updatePlayerList.bind(this); this.updatePlayerListInterval = 30 * 1000; this.updatePlayerListTimeout = null; this.updateLayerInformation = this.updateLayerInformation.bind(this); this.updateLayerInformationInterval = 30 * 1000; this.updateLayerInformationTimeout = null; this.updateA2SInformation = this.updateA2SInformation.bind(this); this.updateA2SInformationInterval = 30 * 1000; this.updateA2SInformationTimeout = null; this.pingSquadJSAPI = this.pingSquadJSAPI.bind(this); this.pingSquadJSAPIInterval = 5 * 60 * 1000; this.pingSquadJSAPITimeout = null; } async watch() { Logger.verbose( 'SquadServer', 1, `Beginning to watch ${this.options.host}:${this.options.queryPort}...` ); await this.squadLayers.pull(); this.admins = await fetchAdminLists(this.options.adminLists); await this.rcon.connect(); await this.logParser.watch(); await this.updatePlayerList(); await this.updateLayerInformation(); await this.updateA2SInformation(); Logger.verbose('SquadServer', 1, `Watching ${this.serverName}...`); await this.pingSquadJSAPI(); } async unwatch() { await this.rcon.disconnect(); await this.logParser.unwatch(); } setupRCON() { this.rcon = new Rcon({ host: this.options.rconHost || this.options.host, port: this.options.rconPort, password: this.options.rconPassword, autoReconnectInterval: this.options.rconAutoReconnectInterval }); this.rcon.on('CHAT_MESSAGE', async (data) => { data.player = await this.getPlayerBySteamID(data.steamID); this.emit('CHAT_MESSAGE', data); const command = data.message.match(/!([^ ]+) ?(.*)/); if (command) this.emit(`CHAT_COMMAND:${command[1].toLowerCase()}`, { ...data, message: command[2].trim() }); }); this.rcon.on('RCON_ERROR', (data) => { this.emit('RCON_ERROR', data); }); } async restartRCON() { try { await this.rcon.disconnect(); } catch (err) { Logger.verbose('SquadServer', 1, 'Failed to stop RCON instance when restarting.', err); } Logger.verbose('SquadServer', 1, 'Setting up new RCON instance...'); this.setupRCON(); await this.rcon.connect(); } setupLogParser() { this.logParser = new LogParser( Object.assign(this.options.ftp, { mode: this.options.logReaderMode, logDir: this.options.logDir, host: this.options.ftp.host || this.options.host }) ); this.logParser.on('ADMIN_BROADCAST', (data) => { this.emit('ADMIN_BROADCAST', data); }); this.logParser.on('NEW_GAME', (data) => { data.layer = this.squadLayers.getLayerByLayerClassname(data.layerClassname); this.layerHistory.unshift({ ...data.layer, time: data.time }); this.layerHistory = this.layerHistory.slice(0, this.layerHistoryMaxLength); this.emit('NEW_GAME', data); }); this.logParser.on('PLAYER_CONNECTED', async (data) => { data.player = await this.getPlayerBySteamID(data.steamID); if (data.player) data.player.suffix = data.playerSuffix; delete data.steamID; delete data.playerSuffix; this.emit('PLAYER_CONNECTED', data); }); this.logParser.on('PLAYER_DAMAGED', async (data) => { data.victim = await this.getPlayerByName(data.victimName); data.attacker = await this.getPlayerByName(data.attackerName); if (data.victim && data.attacker) data.teamkill = data.victim.teamID === data.attacker.teamID && data.victim.steamID !== data.attacker.steamID; delete data.victimName; delete data.attackerName; this.emit('PLAYER_DAMAGED', data); }); this.logParser.on('PLAYER_WOUNDED', async (data) => { data.victim = await this.getPlayerByName(data.victimName); data.attacker = await this.getPlayerByName(data.attackerName); if (data.victim && data.attacker) data.teamkill = data.victim.teamID === data.attacker.teamID && data.victim.steamID !== data.attacker.steamID; delete data.victimName; delete data.attackerName; this.emit('PLAYER_WOUNDED', data); if (data.teamkill) this.emit('TEAMKILL', data); }); this.logParser.on('PLAYER_DIED', async (data) => { data.victim = await this.getPlayerByName(data.victimName); if (data.victim && data.attacker) data.teamkill = data.victim.teamID === data.attacker.teamID && data.victim.steamID !== data.attacker.steamID; delete data.victimName; delete data.attackerName; this.emit('PLAYER_DIED', data); }); this.logParser.on('PLAYER_REVIVED', async (data) => { data.victim = await this.getPlayerByName(data.victimName); data.attacker = await this.getPlayerByName(data.attackerName); data.reviver = await this.getPlayerByName(data.reviverName); delete data.victimName; delete data.attackerName; delete data.reviverName; this.emit('PLAYER_REVIVED', data); }); this.logParser.on('PLAYER_POSSESS', async (data) => { data.player = await this.getPlayerByNameSuffix(data.playerSuffix); if (data.player) data.player.possessClassname = data.possessClassname; delete data.playerSuffix; this.emit('PLAYER_POSSESS', data); }); this.logParser.on('PLAYER_UNPOSSESS', async (data) => { data.player = await this.getPlayerByNameSuffix(data.playerSuffix); delete data.playerSuffix; this.emit('PLAYER_UNPOSSESS', data); }); this.logParser.on('TICK_RATE', (data) => { this.emit('TICK_RATE', data); }); } async restartLogParser() { try { await this.logParser.unwatch(); } catch (err) { Logger.verbose('SquadServer', 1, 'Failed to stop LogParser instance when restarting.', err); } Logger.verbose('SquadServer', 1, 'Setting up new LogParser instance...'); this.setupLogParser(); await this.logParser.watch(); } async getAdminBySteamID(steamID) { return this.admins[steamID]; } async getAdminsWithPermission(perm) { const ret = []; for (const [steamID, perms] of Object.entries(this.admins)) { if (perm in perms) ret.push(this.admins[steamID]); } return ret; } async updatePlayerList() { if (this.updatePlayerListTimeout) clearTimeout(this.updatePlayerListTimeout); Logger.verbose('SquadServer', 1, `Updating player list...`); try { const oldPlayerInfo = {}; for (const player of this.players) { oldPlayerInfo[player.steamID] = player; } this.players = (await this.rcon.getListPlayers()).map((player) => ({ ...oldPlayerInfo[player.steamID], ...player })); for (const player of this.players) { if (typeof oldPlayerInfo[player.steamID] === 'undefined') continue; if (player.teamID !== oldPlayerInfo[player.steamID].teamID) this.emit('PLAYER_TEAM_CHANGE', { player: player, oldTeamID: oldPlayerInfo[player.steamID].teamID, newTeamID: player.teamID }); if (player.squadID !== oldPlayerInfo[player.steamID].squadID) this.emit('PLAYER_SQUAD_CHANGE', { player: player, oldSquadID: oldPlayerInfo[player.steamID].squadID, newSquadID: player.squadID }); } this.emit('UPDATED_PLAYER_INFORMATION'); } catch (err) { Logger.verbose('SquadServer', 1, 'Failed to update player list.', err); } Logger.verbose('SquadServer', 1, `Updated player list.`); this.updatePlayerListTimeout = setTimeout(this.updatePlayerList, this.updatePlayerListInterval); } async updateLayerInformation() { if (this.updateLayerInformationTimeout) clearTimeout(this.updateLayerInformationTimeout); Logger.verbose('SquadServer', 1, `Updating layer information...`); try { const layerInfo = await this.rcon.getLayerInfo(); if (this.layerHistory.length === 0) { const layer = this.squadLayers.getLayerByLayerName(layerInfo.currentLayer); this.layerHistory.unshift({ ...layer, time: Date.now() }); this.layerHistory = this.layerHistory.slice(0, this.layerHistoryMaxLength); } this.nextLayer = layerInfo.nextLayer; this.emit('UPDATED_LAYER_INFORMATION'); } catch (err) { Logger.verbose('SquadServer', 1, 'Failed to update layer information.', err); } Logger.verbose('SquadServer', 1, `Updated layer information.`); this.updateLayerInformationTimeout = setTimeout( this.updateLayerInformation, this.updateLayerInformationInterval ); } async updateA2SInformation() { if (this.updateA2SInformationTimeout) clearTimeout(this.updateA2SInformationTimeout); Logger.verbose('SquadServer', 1, `Updating A2S information...`); try { const data = await Gamedig.query({ type: 'squad', host: this.options.host, port: this.options.queryPort }); this.serverName = data.name; this.maxPlayers = parseInt(data.maxplayers); this.publicSlots = parseInt(data.raw.rules.NUMPUBCONN); this.reserveSlots = parseInt(data.raw.rules.NUMPRIVCONN); this.a2sPlayerCount = parseInt(data.raw.rules.PlayerCount_i); this.publicQueue = parseInt(data.raw.rules.PublicQueue_i); this.reserveQueue = parseInt(data.raw.rules.ReservedQueue_i); this.matchTimeout = parseFloat(data.raw.rules.MatchTimeout_f); this.gameVersion = data.raw.version; this.emit('UPDATED_A2S_INFORMATION'); } catch (err) { Logger.verbose('SquadServer', 1, 'Failed to update A2S information.', err); } Logger.verbose('SquadServer', 1, `Updated A2S information.`); this.updateA2SInformationTimeout = setTimeout( this.updateA2SInformation, this.updateA2SInformationInterval ); } async getPlayerByCondition(condition, forceUpdate = false, retry = true) { let matches; if (!forceUpdate) { matches = this.players.filter(condition); if (matches.length === 1) return matches[0]; if (!retry) return null; } await this.updatePlayerList(); matches = this.players.filter(condition); if (matches.length === 1) return matches[0]; return null; } async getPlayerBySteamID(steamID, forceUpdate) { return this.getPlayerByCondition((player) => player.steamID === steamID, forceUpdate); } async getPlayerByName(name, forceUpdate) { return this.getPlayerByCondition((player) => player.name === name, forceUpdate); } async getPlayerByNameSuffix(suffix, forceUpdate) { return this.getPlayerByCondition((player) => player.suffix === suffix, forceUpdate, false); } async pingSquadJSAPI() { if (this.pingSquadJSAPITimeout) clearTimeout(this.pingSquadJSAPITimeout); Logger.verbose('SquadServer', 1, 'Pinging SquadJS API...'); const payload = { // Send information about the server. server: { host: this.options.host, queryPort: this.options.queryPort, name: this.serverName, playerCount: this.players.length }, // Send information about SquadJS. squadjs: { version: SQUADJS_VERSION, logReaderMode: this.options.logReaderMode, // Send the plugin config so we can see what plugins they're using (none of the config is sensitive). plugins: this.plugins.map((plugin) => ({ ...plugin.rawOptions, plugin: plugin.constructor.name })) } }; try { const { data } = await axios.post(SQUADJS_API_DOMAIN + '/api/v1/ping', payload); if (data.error) Logger.verbose( 'SquadServer', 1, `Successfully pinged the SquadJS API. Got back error: ${data.error}` ); else Logger.verbose( 'SquadServer', 1, `Successfully pinged the SquadJS API. Got back message: ${data.message}` ); } catch (err) { Logger.verbose('SquadServer', 1, 'Failed to ping the SquadJS API: ', err); } this.pingSquadJSAPITimeout = setTimeout(this.pingSquadJSAPI, this.pingSquadJSAPIInterval); } }