Add an experimental /scanall command

Author: RussellLVP

data/messages.json

@@ -541,6 +541,7 @@
   "POSITIONING_FORWARD": "@success I like to move it, move it (forward)!",
 
   "PUNISHMENT_ADMIN_UNBAN": "%s (Id:%d) has unbanned %s: %s",
+  "PUNISHMENT_SCAN_ALL_STARTING": "{CCCCCC}* Started scanning %d players, this could take several seconds...",
   "PUNISHMENT_SCAN_ERROR_NPC": "@error It's not possible to scan non-player characters.",
   "PUNISHMENT_SCAN_RELOADED_ADMIN": "%s (Id:%d) has reloaded the SAMPCAC configuration.",
   "PUNISHMENT_SCAN_RELOADED": "@success The SAMPCAC configuration has been reloaded.",

javascript/features/punishments/punishment_commands.js

@@ -44,6 +44,12 @@ export class PunishmentCommands {
                 .build(PunishmentCommands.prototype.onScanReloadCommand.bind(this))
             .parameters([{ name: 'player', type: CommandBuilder.kTypePlayer }])
             .build(PunishmentCommands.prototype.onScanCommand.bind(this));
+
+        // /scanall
+        server.commandManager.buildCommand('scanall')
+            .description('Scans all players on the server for possible cheating.')
+            .restrict(Player.LEVEL_MANAGEMENT)
+            .build(PunishmentCommands.prototype.onScanAllCommand.bind(this));
     }
 
     // ---------------------------------------------------------------------------------------------
@@ -201,6 +207,74 @@ export class PunishmentCommands {
         await dialog.displayForPlayer(player);
     }
 
+    // Scans all players on the server for possible cheating. Will show a dialog of all in-game
+    // human players, their SA-MP version and whether anything was detected.
+    async onScanAllCommand(player) {
+        const resultPromises = [];
+
+        // (1) Start scans for all human players connected to the server.
+        for (const target of server.playerManager) {
+            if (target.isNonPlayerCharacter())
+                continue;
+
+            resultPromises.push(this.sampcac_().detect(target));
+        }
+
+        player.sendMessage(Message.PUNISHMENT_SCAN_ALL_STARTING, resultPromises.length);
+
+        // (2) Wait until all the scans have completed. They may not be complete.
+        const results = await Promise.all(resultPromises);
+        const dialog = new Menu('Scan results', [
+            'Player',
+            'Version',
+            'Minimized',
+            'Result'
+        ], { pageSize: 50 /* just in the odd case that there's >50 people in-game... */ });
+
+        for (const result of results) {
+            const nickname = format(
+                '{%s}%s', result.player.colors.currentColor.toHexRGB(), result.player.name);
+
+            let version = null;
+
+            // (a) Format the SA-MP version used. SAMPCAC users will be highlighted in green, where
+            // users for whom detections are supported will be yellow. All others will be red.
+            if (result.sampcacVersion)
+                version = '{4CAF50}' + result.version;
+            else if (result.supported)
+                version = '{CDDC39}' + result.version;
+            else
+                version = '{FF5722}' + result.version;
+
+            const minimized = !!result.minimized ? '{FF5722}yes' : '{9E9E9E}no';
+            const detections = [ ...result.detectors ].filter(detector => {
+                return detector[1] === DetectorResults.kResultDetected;
+            });
+
+            let detectionResult = null;
+
+            // (b) Format the detection result. There either are detections (red), no detections
+            // (green), or an unknown result because scans are not supported (grey).
+            if (detections.length > 1)
+                detectionResult = `{FF5722}${detectionResult.length} detections`;
+            else if (detections.length === 1)
+                detectionResult = `{FF5722}1 detection`;
+            else if (!result.supported)
+                detectionResult = `{9E9E9E}unknown`;
+            else
+                detectionResult = `{4CAF50}no detections`;
+
+            // (c) Add the data to the dialog. Selecting a particular player will act as if the
+            // administrator executed the `/scan` command on them, for more details.
+            dialog.addItem(nickname, version, minimized, detectionResult, () => {
+                return this.onScanCommand(player, result.player);
+            });
+        }
+
+        // (3) Display the results dialog to the current |player|.
+        dialog.displayForPlayer(player);
+    }
+
     // Called when someone wishes to reload the SAMPCAC definition file. Generally only needed when
     // changes have been made, but it's undesirable to reload the entire feature.
     onScanReloadCommand(player) {

javascript/features/punishments/punishment_commands.test.js

@@ -132,4 +132,25 @@ describe('PunishmentCommands', (it, beforeEach) => {
         assert.isTrue(await gunther.issueCommand('/scan reload'));
         assert.equal(gunther.messages.pop(), Message.PUNISHMENT_SCAN_RELOADED);
     });
+
+    it('should be able to run memory scans on all players', async (assert) => {
+        gunther.level = Player.LEVEL_MANAGEMENT;
+
+        // (2) Scans should return after a sensible amount of time, and explain that to the player.
+        gunther.respondToDialog({ response: 0 /* dismiss */ });
+
+        const [ commandResult, advanceResult ] = await Promise.all([
+            gunther.issueCommand('/scanall'),
+            server.clock.advance(30 * 1000 /* some excessively long amount of time*/),
+        ]);
+
+        assert.isTrue(commandResult);
+        assert.equal(gunther.messages.length, 1);
+        assert.equal(
+            gunther.messages[0],
+            Message.format(Message.PUNISHMENT_SCAN_ALL_STARTING, server.playerManager.count));
+
+        assert.includes(gunther.lastDialog, '0.3.7-R4-mock');
+        assert.includes(gunther.lastDialog, 'Lucy');
+    });
 });

javascript/features/sampcac/detector_manager.js

@@ -67,6 +67,7 @@ export class DetectorManager {
         const results = new DetectorResults();
 
         // (1) Populate the meta-data fields of the results.
+        results.player = player;
         results.version = player.version;
 
         // Append "-R1" to distinguish from R2, R3 and R4, which do include the revision.

javascript/features/sampcac/detector_results.js

@@ -14,6 +14,9 @@ export class DetectorResults {
     // Section: Meta-information about the player
     // ---------------------------------------------------------------------------------------------
 
+    // The player for whom this scan was started.
+    player = null;
+
     // Version of the SA-MP client that they're using.
     version = null;