feat(core): added server log for blocked joins of banned players

Author: tabarra

core/modules/Logger/handlers/server.js

@@ -153,17 +153,13 @@ export default class ServerLogger extends LoggerBase {
      * @param {String} mutex
      */
     processEvent(eventData, mutex) {
-        //Get source + handle playerJoining
+        //Get source
         let srcObject; //to be sent to the UI
         let srcString; //to ve saved to the log file
         if (eventData.src === 'tx') {
             srcObject = { id: false, name: 'txAdmin' };
             srcString = 'txAdmin';
 
-        } else if (typeof eventData.src === 0) {
-            srcObject = { id: false, name: 'CONSOLE' };
-            srcString = 'CONSOLE';
-
         } else if (typeof eventData.src === 'number' && eventData.src > 0) {
             const player = globals.playerlistManager.getPlayerById(eventData.src);
             if (player) {
@@ -182,8 +178,7 @@ export default class ServerLogger extends LoggerBase {
             srcString = 'UNKNOWN';
         }
 
-
-        //Process event types (except playerJoining)
+        //Process event types
         //TODO: normalize/padronize actions
         let eventMessage; //to be sent to the UI + saved to the log
         if (eventData.type === 'playerJoining') {
@@ -194,6 +189,10 @@ export default class ServerLogger extends LoggerBase {
             const reason = eventData.data.reason || 'UNKNOWN REASON';
             eventMessage = `disconnected (${reason})`;
 
+        } else if (eventData.type === 'playerJoinDenied') {
+            const reason = eventData.data.reason ?? 'UNKNOWN REASON';
+            eventMessage = `player join denied due to ${reason}`;
+
         } else if (eventData.type === 'ChatMessage') {
             const text = (typeof eventData.data.text === 'string') ? eventData.data.text.replace(/\^([0-9])/g, '') : 'unknown message';
             eventMessage = (typeof eventData.data.author === 'string' && eventData.data.author !== srcObject.name)

core/routes/player/checkJoin.ts

@@ -228,6 +228,23 @@ function checkBan(
             <span style="font-style: italic;">${note}</span>`
         );
 
+        //Send serverlog message
+        const matchingIds = ban.ids.filter(id => validIdsArray.includes(id));
+        const matchingHwids = ('hwids' in ban && ban.hwids)
+            ? ban.hwids.filter(hw => validHwidsArray.includes(hw))
+            : [];
+        const summarizedIds = [
+            ...matchingIds.map(shortenId),
+            ...matchingHwids.map(shortenId)
+        ];
+        const loggerReason = `active ban (${ban.id}) for identifiers [${summarizedIds.join(', ')}]`;
+        txAdmin.logger.server.write([{
+            src: 'tx',
+            type: 'playerJoinDenied',
+            ts,
+            data: { reason: loggerReason }
+        }]);
+
         return { allow: false, reason };
     } else {
         return { allow: true };

web/main/serverLog.ejs

@@ -371,7 +371,7 @@
         const getShowTypes = () => Object.keys(eventFilters)
             .filter(fn => eventFilters[fn])
             .flatMap(fn => {
-                if (fn === 'PlayerJoinLeave') return ['playerJoining', 'playerDropped'];
+                if (fn === 'PlayerJoinLeave') return ['playerJoining', 'playerDropped', 'playerJoinDenied'];
                 if(fn === 'System') return ['LoggerStarted', 'DebugMessage'];
                 return fn;
             });