Improve migration to eosIDs

core/id-parser.js

@@ -0,0 +1,61 @@
+const ID_MATCHER = /\s*(?<name>[^\s:]+)\s*:\s*(?<id>[^\s]+)/g;
+
+// COMMON CONSTANTS
+
+/** All possible IDs that a player can have. */
+export const playerIdNames = ["steamID", "eosID"];
+
+// PARSING AND ITERATION
+
+/**
+ * Main function intended for parsing `Online IDs:` body.
+ * @arg {string} idsStr - String with ids. Extra whitespace is allowed,
+ *   Number of {platform: ID} pairs can be arbitrary. String example:
+     " platform1:id1 platform2: id2    platform3  :  id3   "
+     Keys and values are not allowed contain colons or whitespace
+     characters.
+ * @returns {IdsIterator} An iterator that yields {platform: ID} pairs.
+ */
+export const iterateIDs = (idsStr) => {
+  return new IdsIterator(idsStr.matchAll(ID_MATCHER));
+};
+
+class IdsIterator {
+  constructor(matchIterator) {
+    this.inner = matchIterator;
+  }
+
+  [Symbol.iterator]() {
+    return this;
+  }
+
+  next() {
+    const match = this.inner.next();
+    if (match.done) return { value: undefined, done: true };
+    return { value: { key: match.value[1], value: match.value[2] }, done: false };
+  }
+
+  forEach(callbackFn) {
+    for (const { key, value } of this) callbackFn(key, value);
+  }
+}
+
+// FORMATTING
+
+/**
+ * Generates capitalized ID names. Examples:
+ *   steam -> SteamID
+ *   EOSID -> EOSID
+ */
+export const capitalID = (str) => {
+  return str.charAt(0).toUpperCase() + str.slice(1) + 'ID';
+};
+
+/**
+ * Generates lowercase ID names. Examples:
+ *   steam -> steamID
+ *   EOSID -> eosID
+ */
+export const lowerID = (str) => {
+  return str.toLowerCase() + 'ID';
+};

core/log-parser/index.js

@@ -16,12 +16,8 @@ export default class LogParser extends EventEmitter {
 
     this.eventStore = {
       disconnected: {}, // holding area, cleared on map change.
-      players: [], // persistent data, steamid, controller, suffix.
-      playersEOS: [], // proxies from EOSID to persistent data, steamid, controller, suffix.
-      connectionIdToSteamID: new Map(),
+      players: {}, // persistent data, steamid, controller, suffix.
       session: {}, // old eventstore, nonpersistent data
-      clients: {}, // used in the connection chain before we resolve a player.
-      lastConnection: {}, // used to store the last client connection data to then associate a steamid
       joinRequests: []
     };
 
@@ -74,10 +70,10 @@ export default class LogParser extends EventEmitter {
   clearEventStore() {
     Logger.verbose('LogParser', 2, 'Cleaning Eventstore');
     for (const player of Object.values(this.eventStore.players)) {
-      if (this.eventStore.disconnected[player.steamID] === true) {
-        Logger.verbose('LogParser', 2, `Removing ${player.steamID} from eventStore`);
-        delete this.eventStore.players[player.steamID];
-        delete this.eventStore.disconnected[player.steamID];
+      if (this.eventStore.disconnected[player.eosID] === true) {
+        Logger.verbose('LogParser', 2, `Removing ${player.eosID} from eventStore`);
+        delete this.eventStore.players[player.eosID];
+        delete this.eventStore.disconnected[player.eosID];
       }
     }
     this.eventStore.session = {};

core/package.json

@@ -5,6 +5,7 @@
   "exports": {
     "./log-parser": "./log-parser/index.js",
     "./constants": "./constants.js",
+    "./id-parser": "./id-parser.js",
     "./logger": "./logger.js",
     "./rcon": "./rcon.js"
   },

core/rcon.js

@@ -414,15 +414,15 @@ export default class Rcon extends EventEmitter {
     return util.inspect(decodedPacket, { breakLength: Infinity });
   }
 
-  async warn(steamID, message) {
-    await this.execute(`AdminWarn "${steamID}" ${message}`);
+  async warn(anyID, message) {
+    await this.execute(`AdminWarn "${anyID}" ${message}`);
   }
 
-  async kick(steamID, reason) {
-    await this.execute(`AdminKick "${steamID}" ${reason}`);
+  async kick(anyID, reason) {
+    await this.execute(`AdminKick "${anyID}" ${reason}`);
   }
 
-  async forceTeamChange(steamID) {
-    await this.execute(`AdminForceTeamChange "${steamID}"`);
+  async forceTeamChange(anyID) {
+    await this.execute(`AdminForceTeamChange "${anyID}"`);
   }
 }

squad-server/index.js

@@ -13,6 +13,8 @@ import Rcon from './rcon.js';
 import { SQUADJS_VERSION } from './utils/constants.js';
 
 import fetchAdminLists from './utils/admin-lists.js';
+import { anyIDToPlayer, anyIDsToPlayers } from './utils/any-id.js';
+import { playerIdNames } from 'core/id-parser';
 
 export default class SquadServer extends EventEmitter {
   constructor(options = {}) {
@@ -98,7 +100,7 @@ export default class SquadServer extends EventEmitter {
     });
 
     this.rcon.on('CHAT_MESSAGE', async (data) => {
-      data.player = await this.getPlayerBySteamID(data.steamID);
+      data.player = await this.getPlayerByEOSID(data.eosID);
       this.emit('CHAT_MESSAGE', data);
 
       const command = data.message.match(/!([^ ]+) ?(.*)/);
@@ -110,22 +112,22 @@ export default class SquadServer extends EventEmitter {
     });
 
     this.rcon.on('POSSESSED_ADMIN_CAMERA', async (data) => {
-      data.player = await this.getPlayerBySteamID(data.steamID);
+      data.player = await this.getPlayerByEOSID(data.eosID);
 
-      this.adminsInAdminCam[data.steamID] = data.time;
+      this.adminsInAdminCam[data.eosID] = data.time;
 
       this.emit('POSSESSED_ADMIN_CAMERA', data);
     });
 
     this.rcon.on('UNPOSSESSED_ADMIN_CAMERA', async (data) => {
-      data.player = await this.getPlayerBySteamID(data.steamID);
-      if (this.adminsInAdminCam[data.steamID]) {
-        data.duration = data.time.getTime() - this.adminsInAdminCam[data.steamID].getTime();
+      data.player = await this.getPlayerByEOSID(data.eosID);
+      if (this.adminsInAdminCam[data.eosID]) {
+        data.duration = data.time.getTime() - this.adminsInAdminCam[data.eosID].getTime();
       } else {
         data.duration = 0;
       }
 
-      delete this.adminsInAdminCam[data.steamID];
+      delete this.adminsInAdminCam[data.eosID];
 
       this.emit('UNPOSSESSED_ADMIN_CAMERA', data);
     });
@@ -141,13 +143,13 @@ export default class SquadServer extends EventEmitter {
     });
 
     this.rcon.on('PLAYER_KICKED', async (data) => {
-      data.player = await this.getPlayerBySteamID(data.steamID);
+      data.player = await this.getPlayerByEOSID(data.eosID);
 
       this.emit('PLAYER_KICKED', data);
     });
 
     this.rcon.on('PLAYER_BANNED', async (data) => {
-      data.player = await this.getPlayerBySteamID(data.steamID);
+      data.player = await this.getPlayerByEOSID(data.eosID);
 
       this.emit('PLAYER_BANNED', data);
     });
@@ -157,8 +159,7 @@ export default class SquadServer extends EventEmitter {
       data.player.squadID = data.squadID;
 
       delete data.playerName;
-      delete data.playerSteamID;
-      delete data.playerEOSID;
+      for (const k in data) if (k.startsWith('player') && k.endsWith('ID')) delete data[k];
 
       this.emit('SQUAD_CREATED', data);
     });
@@ -208,7 +209,7 @@ export default class SquadServer extends EventEmitter {
       this.emit('NEW_GAME', data);
     });
 
-    this.logParser.on('PLAYER_CONNECTED', async (data) => {
+    this.logParser.on('JOIN_SUCCEEDED', async (data) => {
       Logger.verbose(
         'SquadServer',
         1,
@@ -218,7 +219,7 @@ export default class SquadServer extends EventEmitter {
       data.player = await this.getPlayerByEOSID(data.eosID);
       if (data.player) data.player.suffix = data.playerSuffix;
 
-      delete data.steamID;
+      for (const k in data) if (playerIdNames.includes(k)) delete data[k];
       delete data.playerSuffix;
 
       this.emit('PLAYER_CONNECTED', data);
@@ -227,7 +228,7 @@ export default class SquadServer extends EventEmitter {
     this.logParser.on('PLAYER_DISCONNECTED', async (data) => {
       data.player = await this.getPlayerByEOSID(data.eosID);
 
-      delete data.steamID;
+      for (const k in data) if (playerIdNames.includes(k)) delete data[k];
 
       this.emit('PLAYER_DISCONNECTED', data);
     });
@@ -242,7 +243,7 @@ export default class SquadServer extends EventEmitter {
       if (data.victim && data.attacker) {
         data.teamkill =
           data.victim.teamID === data.attacker.teamID &&
-          data.victim.steamID !== data.attacker.steamID;
+          data.victim.eosID !== data.attacker.eosID;
       }
 
       delete data.victimName;
@@ -260,7 +261,7 @@ export default class SquadServer extends EventEmitter {
       if (data.victim && data.attacker)
         data.teamkill =
           data.victim.teamID === data.attacker.teamID &&
-          data.victim.steamID !== data.attacker.steamID;
+          data.victim.eosID !== data.attacker.eosID;
 
       delete data.victimName;
       delete data.attackerName;
@@ -278,7 +279,7 @@ export default class SquadServer extends EventEmitter {
       if (data.victim && data.attacker)
         data.teamkill =
           data.victim.teamID === data.attacker.teamID &&
-          data.victim.steamID !== data.attacker.steamID;
+          data.victim.eosID !== data.attacker.eosID;
 
       delete data.victimName;
       delete data.attackerName;
@@ -322,23 +323,6 @@ export default class SquadServer extends EventEmitter {
     this.logParser.on('TICK_RATE', (data) => {
       this.emit('TICK_RATE', data);
     });
-
-    this.logParser.on('CLIENT_EXTERNAL_ACCOUNT_INFO', (data) => {
-      this.rcon.addIds(data.steamID, data.eosID);
-    });
-    // this.logParser.on('CLIENT_CONNECTED', (data) => {
-    //   Logger.verbose("SquadServer", 1, `Client connected. Connection: ${data.connection} - SteamID: ${data.steamID}`)
-    // })
-    // this.logParser.on('CLIENT_LOGIN_REQUEST', (data) => {
-    //   Logger.verbose("SquadServer", 1, `Login request. ChainID: ${data.chainID} - Suffix: ${data.suffix} - EOSID: ${data.eosID}`)
-
-    // })
-    // this.logParser.on('RESOLVED_EOS_ID', (data) => {
-    //   Logger.verbose("SquadServer", 1, `Resolved EOSID. ChainID: ${data.chainID} - Suffix: ${data.suffix} - EOSID: ${data.eosID}`)
-    // })
-    // this.logParser.on('ADDING_CLIENT_CONNECTION', (data) => {
-    //   Logger.verbose("SquadServer", 1, `Adding client connection`, data)
-    // })
   }
 
   async restartLogParser() {
@@ -353,16 +337,28 @@ export default class SquadServer extends EventEmitter {
     await this.logParser.watch();
   }
 
+  /**
+   * @deprecated Kept for backwards compatibility with custom plugins.
+   */
   getAdminPermsBySteamID(steamID) {
-    return this.admins[steamID];
+    return this.getAdminPermsByAnyID(steamID);
+  }
+
+  getAdminPermsByAnyID(anyID) {
+    // using this.players directly to keep the function sync
+    const player = anyIDToPlayer(anyID, this.players);
+    if (player === undefined) return;
+    for (const idName of playerIdNames)
+      if (player[idName] in this.admins)
+        return this.admins[player[idName]];
   }
 
   getAdminsWithPermission(perm) {
     const ret = [];
-    for (const [steamID, perms] of Object.entries(this.admins)) {
-      if (perm in perms) ret.push(steamID);
+    for (const [anyID, perms] of Object.entries(this.admins)) {
+      if (perm in perms) ret.push(anyID);
     }
-    return ret;
+    return anyIDsToPlayers(ret, this.players).map(player => player.eosID);
   }
 
   async updateAdmins() {
@@ -377,34 +373,35 @@ export default class SquadServer extends EventEmitter {
     try {
       const oldPlayerInfo = {};
       for (const player of this.players) {
-        oldPlayerInfo[player.steamID] = player;
+        oldPlayerInfo[player.eosID] = player;
       }
 
       const players = [];
       for (const player of await this.rcon.getListPlayers(this))
         players.push({
-          ...oldPlayerInfo[player.steamID],
+          ...oldPlayerInfo[player.eosID],
           ...player,
-          playercontroller: this.logParser.eventStore.players[player.steamID]
-            ? this.logParser.eventStore.players[player.steamID].controller
+          playercontroller: this.logParser.eventStore.players[player.eosID]
+            ? this.logParser.eventStore.players[player.eosID].controller
             : null,
           squad: await this.getSquadByID(player.teamID, player.squadID)
         });
 
       this.players = players;
 
       for (const player of this.players) {
-        if (typeof oldPlayerInfo[player.steamID] === 'undefined') continue;
-        if (player.teamID !== oldPlayerInfo[player.steamID].teamID)
+        const oldInfo = oldPlayerInfo[player.eosID];
+        if (oldInfo === undefined) continue;
+        if (player.teamID !== oldInfo.teamID)
           this.emit('PLAYER_TEAM_CHANGE', {
             player: player,
-            oldTeamID: oldPlayerInfo[player.steamID].teamID,
+            oldTeamID: oldInfo.teamID,
             newTeamID: player.teamID
           });
-        if (player.squadID !== oldPlayerInfo[player.steamID].squadID)
+        if (player.squadID !== oldInfo.squadID)
           this.emit('PLAYER_SQUAD_CHANGE', {
             player: player,
-            oldSquadID: oldPlayerInfo[player.steamID].squadID,
+            oldSquadID: oldInfo.squadID,
             newSquadID: player.squadID
           });
       }
@@ -591,6 +588,9 @@ export default class SquadServer extends EventEmitter {
     );
   }
 
+  /**
+   * @deprecated Kept for backwards compatibility with custom plugins.
+   */
   async getPlayerBySteamID(steamID, forceUpdate) {
     return this.getPlayerByCondition((player) => player.steamID === steamID, forceUpdate);
   }
@@ -599,6 +599,14 @@ export default class SquadServer extends EventEmitter {
     return this.getPlayerByCondition((player) => player.eosID === eosID, forceUpdate);
   }
 
+  async getPlayerByAnyID(anyID, forceUpdate) {
+    return this.getPlayerByCondition(
+      (player) =>
+        Object.entries(player).filter(([parm, val]) => parm.endsWith('ID') && val === anyID).length,
+      forceUpdate
+    );
+  }
+
   async getPlayerByName(name, forceUpdate) {
     return this.getPlayerByCondition((player) => player.name === name, forceUpdate);
   }