Ticket #3241: t3241_kick_v6.2.patch

binaries/data/mods/public/gui/common/network.js

@@ -1 @@
-function getDisconnectReason(id)
+/**
+ * Get a human readable version of the given disconnect reason.
+ *
+ * @param {number} reason - as defined in the enum in source/network/NetHost.h
+ * @returns {string} human readable version of the reason
+ */
+function getDisconnectReason(reason)
 {
-    // Must be kept in sync with source/network/NetHost.h
-    switch (id)
+    switch (reason)
     {
     case 0: return translate("Unknown reason");
     case 1: return translate("Unexpected shutdown");
     case 2: return translate("Incorrect network protocol version");
     case 3: return translate("Game is loading, please try later");
     case 4: return translate("Game has already started, no observers allowed");
-    default: return sprintf(translate("\\[Invalid value %(id)s]"), { "id": id });
+    case 5: return translate("You have been kicked from the match");
+    case 6: return translate("You have been banned from the match");
+    default: return sprintf(translate("\\[Invalid value %(id)s]"), { "id": reason });
     }
 }
 
+/**
+ * Shows a message box stating the disconnect reason.
+ *
+ * @param {number} reason - as defined in the enum in source/network/NetHost.h
+ */
 function reportDisconnect(reason)
 {
-    var reasontext = getDisconnectReason(reason);
-
     messageBox(400, 200,
-        translate("Lost connection to the server.") + "\n\n" + sprintf(translate("Reason: %(reason)s."), { reason: reasontext }),
+        translate("Lost connection to the server.") + "\n\n" +
+            sprintf(translate("Reason: %(reason)s."), { "reason": getDisconnectReason(reason) }),
         translate("Disconnected"), 2);
 }
+
+/**
+ * Get usernames sorted by player slot, observers last.
+ * Requires g_PlayerAssignments.
+ *
+ * @returns {string[]} the usernames
+ */
+function getUsernameList()
+{
+    // First sort, then lookup name
+    return Object.keys(g_PlayerAssignments).sort((guidA, guidB) =>
+    {
+        let slotA = g_PlayerAssignments[guidA].player;
+        let slotB = g_PlayerAssignments[guidB].player;
+        if (slotA == -1) return 1;
+        if (slotB == -1) return -1;
+        return slotA - slotB;
+    }).map(guid => g_PlayerAssignments[guid].name);
+}
+
+/**
+ * Execute a commands locally. Requires addChatMessage.
+ *
+ * @param {string} input - What the user typed
+ * @returns {Boolean} true if the command was executed
+ */
+function executeNetworkCommand(input)
+{
+    // Must start with slash
+    if (input.indexOf("/") != 0)
+        return false;
+
+    // Split command and argument
+    var command = input.split(" ", 1)[0];
+    var argument = input.substr(command.length).trim();
+
+    // Execute command
+    switch (command)
+    {
+    case "/list":
+        addChatMessage({ "type": "clientlist", "guid": "local" });
+        return true;
+
+    case "/kick":
+        Engine.KickPlayer(argument, false);
+        return true;
+
+    case "/ban":
+        Engine.KickPlayer(argument, true);
+        return true;
+
+    default:
+        return false;
+    }
+}

binaries/data/mods/public/gui/gamesetup/gamesetup.js

@@ -518 +518 @@
 
     case "chat":
         addChatMessage({ "type": "message", "guid": message.guid, "text": message.text });
         break;
 
+    case "kicked":
+        addChatMessage({ "type": message.ban ? "banned" : "kicked", "username": message.username });
+        break;
+
     // Singular client to host message
     case "ready":
         g_ReadyChanged -= 1;
         if (g_ReadyChanged < 1 && g_PlayerAssignments[message.guid].player != -1)
             addChatMessage({ "type": "ready", "guid": message.guid, "ready": +message.status == 1 });
@@ -1706 +1710 @@
 
     // Remove AI from this player slot
     g_GameAttributes.settings.PlayerData[newSlot].AI = "";
 }
 
+// Called when pressing enter or clicking the send button. May call network commands.
 function submitChatInput()
 {
     var input = Engine.GetGUIObjectByName("chatInput");
-    var text = input.caption;
-    if (text.length)
-    {
-        Engine.SendNetworkChat(text);
-        input.caption = "";
-    }
+    var text = input.caption.trim();
+
+    if (!text.length)
+        return;
+
+    input.caption = "";
+
+    if (executeNetworkCommand(text))
+        return;
+
+    Engine.SendNetworkChat(text);
 }
 
+// Displays a given chat message.
 function addChatMessage(msg)
 {
     var username = "";
     if (msg.username)
         username = escapeText(msg.username);
@@ -1750 +1761 @@
     var formatted;
     switch (msg.type)
     {
     case "connect":
         var formattedUsername = '[color="'+ color +'"]' + username + '[/color]';
-        formatted = '[font="sans-bold-13"] ' + sprintf(translate("== %(message)s"), { message: sprintf(translate("%(username)s has joined"), { username: formattedUsername }) }) + '[/font]';
+        formatted = '[font="sans-bold-13"] ' + sprintf(translate("== %(message)s"), { "message": sprintf(translate("%(username)s has joined"), { "username": formattedUsername }) }) + '[/font]';
         break;
 
     case "disconnect":
         var formattedUsername = '[color="'+ color +'"]' + username + '[/color]';
-        formatted = '[font="sans-bold-13"] ' + sprintf(translate("== %(message)s"), { message: sprintf(translate("%(username)s has left"), { username: formattedUsername }) }) + '[/font]';
+        formatted = '[font="sans-bold-13"] ' + sprintf(translate("== %(message)s"), { "message": sprintf(translate("%(username)s has left"), { "username": formattedUsername }) }) + '[/font]';
+        break;
+
+    case "clientlist":
+        formatted = sprintf(translate("Users: %(users)s"), { "users": getUsernameList().join(",") });
+        break;
+
+    case "kicked":
+        formatted = '[font="sans-bold-13"] ' + sprintf(translate("== %(message)s"), { "message": sprintf(translate("%(username)s has been kicked."), { "username": username }) }) + '[/font]';
+        break;
+
+    case "banned":
+        formatted = '[font="sans-bold-13"] ' + sprintf(translate("== %(message)s"), { "message": sprintf(translate("%(username)s has been banned."), { "username": username }) }) + '[/font]';
         break;
 
     case "message":
         var formattedUsername = '[color="'+ color +'"]' + username + '[/color]';
-        var formattedUsernamePrefix = '[font="sans-bold-13"]' + sprintf(translate("<%(username)s>"), { username: formattedUsername }) + '[/font]'
-        formatted = sprintf(translate("%(username)s %(message)s"), { username: formattedUsernamePrefix, message: message });
+        var formattedUsernamePrefix = '[font="sans-bold-13"]' + sprintf(translate("<%(username)s>"), { "username": formattedUsername }) + '[/font]'
+        formatted = sprintf(translate("%(username)s %(message)s"), { "username": formattedUsernamePrefix, "message": message });
         break;
 
     case "ready":
         var formattedUsername = '[font="sans-bold-13"][color="'+ color +'"]' + username + '[/color][/font]'
         if (msg.ready)
-            formatted = ' ' + sprintf(translate("* %(username)s is ready!"), { username: formattedUsername });
+            formatted = ' ' + sprintf(translate("* %(username)s is ready!"), { "username": formattedUsername });
         else
-            formatted = ' ' + sprintf(translate("* %(username)s is not ready."), { username: formattedUsername });
+            formatted = ' ' + sprintf(translate("* %(username)s is not ready."), { "username": formattedUsername });
         break;
 
     case "settings":
-        formatted = '[font="sans-bold-13"] ' + sprintf(translate("== %(message)s"), { message: translate('Game settings have been changed') }) + '[/font]';
+        formatted = '[font="sans-bold-13"] ' + sprintf(translate("== %(message)s"), { "message": translate('Game settings have been changed') }) + '[/font]';
         break;
 
     default:
-        error(sprintf("Invalid chat message '%(message)s'", { message: uneval(msg) }));
+        error(sprintf("Invalid chat message '%(message)s'", { "message": uneval(msg) }));
         return;
     }
 
     g_ChatMessages.push(formatted);
 

binaries/data/mods/public/gui/gamesetup/gamesetup_mp.xml

@@ -2 +2 @@
 
 <objects>
 
     <script file="gui/common/network.js"/>
     <script file="gui/common/functions_global_object.js"/>
+    <script file="gui/common/functions_utility.js"/>
     <script file="gui/gamesetup/gamesetup_mp.js"/>
 
     <!-- Add a translucent black background to fade out the menu page -->
     <object type="image" sprite="ModernFade"/>
 
@@ -46 +47 @@
             </object>
 
             <object hotkey="confirm" type="button" size="50%+5 100%-45 100%-18 100%-17" style="ModernButtonRed">
                 <translatableAttribute id="caption">Continue</translatableAttribute>
                 <action on="Press">
-                    var joinPlayerName = Engine.GetGUIObjectByName("joinPlayerName").caption;
+                    var joinPlayerName = sanitizePlayerName(Engine.GetGUIObjectByName("joinPlayerName").caption, true, true);
                     var joinServer = Engine.GetGUIObjectByName("joinServer").caption;
                     if (startJoin(joinPlayerName, joinServer))
                         switchSetupPage("pageJoin", "pageConnecting");
                 </action>
             </object>
@@ -88 +89 @@
             </object>
 
             <object type="button" size="50%+5 100%-45 100%-18 100%-17" style="ModernButtonRed">
                 <translatableAttribute id="caption">Continue</translatableAttribute>
                 <action on="Press">
-                    var hostPlayerName = Engine.GetGUIObjectByName("hostPlayerName").caption;
+                    var hostPlayerName = sanitizePlayerName(Engine.GetGUIObjectByName("hostPlayerName").caption, true, true);
                     var hostServerName = Engine.GetGUIObjectByName("hostServerName").caption;
                     if (startHost(hostPlayerName, hostServerName))
                         switchSetupPage("pageHost", "pageConnecting");
                 </action>
             </object>

binaries/data/mods/public/gui/session/messages.js

@@ -7 +7 @@
 // Notification Data
 const NOTIFICATION_TIMEOUT = 10000;
 const MAX_NUM_NOTIFICATION_LINES = 3;
 var notifications = [];
 var notificationsTimers = [];
-var cheats = getCheatsData();
+var g_Cheats = getCheatsData();
 
+// Loads available cheats
 function getCheatsData()
 {
     var cheats = {};
     var cheatFileList = getJSONFileList("simulation/data/cheats/");
-    for each (var fileName in cheatFileList)
+    for (let fileName of cheatFileList)
     {
-        var currentCheat = Engine.ReadJSONFile("simulation/data/cheats/"+fileName+".json");
+        let currentCheat = Engine.ReadJSONFile("simulation/data/cheats/" + fileName + ".json");
         if (!currentCheat)
             continue;
         if (Object.keys(cheats).indexOf(currentCheat.Name) !== -1)
             warn("Cheat name '" + currentCheat.Name + "' is already present");
         else
             cheats[currentCheat.Name] = currentCheat.Data;
     }
     return cheats;
 }
 
+// Returns true if a cheat was executed.
+function executeCheat(text)
+{
+    // Cheats only if allowed
+    if (g_IsObserver || !g_Players[Engine.GetPlayerID()].cheatsEnabled)
+        return false;
+
+    // Find the cheat code that is a prefix of the user input
+    var cheatCode = Object.keys(g_Cheats).find(cheatCode => text.indexOf(cheatCode) == 0);
+
+    // Cancel if not found
+    if (!cheatCode)
+        return false;
+
+    // Parse parameter from user input
+    var parameter = text.substr(cheatCode.length);
+
+    // Load cheat object
+    var cheat = g_Cheats[cheatCode];
+
+    // Parse parameter as number
+    if (cheat.isNumeric)
+        parameter = +parameter;
+
+    // Use default value if the user didn't specify the parameter properly
+    if (cheat.DefaultParameter && (isNaN(parameter) || parameter < 0))
+        parameter = cheat.DefaultParameter;
+
+    // Execute Cheat
+    Engine.PostNetworkCommand(
+    {
+        "type": "cheat",
+        "action": cheat.Action,
+        "text": cheat.Type,
+        "templates": cheat.Templates,
+        "parameter": parameter,
+        "player": Engine.GetPlayerID(),
+        "selected": g_Selection.toList()
+    });
+
+    return true;
+}
+
 var g_NotificationsTypes =
 {
     "chat": function(notification, player)
     {
         var message = {
@@ -204 +248 @@
         escapeText(g_Players[player].name),
         color.r + " " + color.g + " " + color.b,
     ];
 }
 
-// Messages
 function handleNetMessage(message)
 {
-    log(sprintf(translate("Net message: %(message)s"), { message: uneval(message) }));
+    log(sprintf(translate("Net message: %(message)s"), { "message": uneval(message) }));
 
     switch (message.type)
     {
     case "netstatus":
         // If we lost connection, further netstatus messages are useless
@@ -241 +284 @@
             obj.caption = translate("Connection to the server has been authenticated.");
             obj.hidden = false;
             break;
         case "disconnected":
             g_Disconnected = true;
-            obj.caption = translate("Connection to the server has been lost.") + "\n\n" + translate("The game has ended.");
+            obj.caption = translate("Connection to the server has been lost.") + "\n" +
+                sprintf(translate("Reason: %(reason)s."), { "reason": getDisconnectReason(message.reason) }) + "\n" +
+                translate("The game has ended.");
             obj.hidden = false;
             break;
         default:
             error("Unrecognised netstatus type '" + message.status + "'");
             break;
@@ -296 +341 @@
     case "aichat":
         addChatMessage({ "type": "message", "guid": message.guid, "text": message.text, "translate": true });
         break;
 
     case "rejoined":
-        addChatMessage({ "type": "rejoined", "guid": message.guid});
+        addChatMessage({ "type": "rejoined", "guid": message.guid });
         break;
-        
+
+    case "kicked":
+        addChatMessage({ "type": message.ban ? "banned" : "kicked", "username": message.username });
+        break;
+
     // To prevent errors, ignore these message types that occur during autostart
     case "gamesetup":
     case "start":
         break;
 
     default:
         error("Unrecognised net message type '" + message.type + "'");
     }
 }
 
+// Sends or displays the given text as chat.
 function submitChatDirectly(text)
 {
     if (text.length)
     {
         if (g_IsNetworked)
@@ -320 +370 @@
         else
             addChatMessage({ "type": "message", "guid": "local", "text": text });
     }
 }
 
+// Called when pressing enter or clicking the send button. May call cheats and commands.
 function submitChatInput()
 {
+    // Get user input
     var input = Engine.GetGUIObjectByName("chatInput");
-    var text = input.caption;
-    var isCheat = false;
-    if (text.length)
-    {
-        if (!g_IsObserver && g_Players[Engine.GetPlayerID()].cheatsEnabled)
-        {
-            for each (var cheat in Object.keys(cheats))
-            {
-                // Line must start with the cheat.
-                if (text.indexOf(cheat) !== 0)
-                    continue;
+    var user_input = input.caption.trim();
 
-                // test for additional parameter which is the rest of the string after the cheat
-                var parameter = "";
-                if (cheats[cheat].DefaultParameter !== undefined)
-                {
-                    var par = text.substr(cheat.length);
-                    par = par.replace(/^\W+/, '').replace(/\W+$/, ''); // remove whitespaces at start and end
-
-                    // check, if the isNumeric flag is set
-                    if (cheats[cheat].isNumeric)
-                    {
-                        // Match the first word in the substring.
-                        var match = par.match(/\S+/);
-                        if (match && match[0])
-                            par = Math.floor(match[0]);
-                        // check, if valid number could be parsed
-                        if (par <= 0 || isNaN(par))
-                            par = "";
-                    }
-
-                    // replace default parameter, if not empty or number
-                    if (par.length > 0 || parseFloat(par) === par)
-                        parameter = par;
-                    else
-                        parameter = cheats[cheat].DefaultParameter;
-                }
-
-                Engine.PostNetworkCommand({
-                    "type": "cheat",
-                    "action": cheats[cheat].Action,
-                    "parameter": parameter,
-                    "text": cheats[cheat].Type,
-                    "selected": g_Selection.toList(),
-                    "templates": cheats[cheat].Templates,
-                    "player": Engine.GetPlayerID()});
-                isCheat = true;
-                break;
-            }
-        }
+    // Clear chat input, remove focus and close window
+    input.caption = "";
+    input.blur();
+    toggleChatWindow();
 
-        // Observers should only send messages to "/all"
-        if (!isCheat && (!g_IsObserver || text.indexOf("/") == -1 || text.indexOf("/all ") == 0))
-        {
-            if (Engine.GetGUIObjectByName("toggleTeamChat").checked)
-                text = "/team " + text;
+    if (!user_input.length)
+        return;
 
-            if (g_IsNetworked)
-                Engine.SendNetworkChat(text);
-            else
-                addChatMessage({ "type": "message", "guid": "local", "text": text });
-        }
-        input.caption = ""; // Clear chat input
-    }
+    if (executeCheat(user_input))
+        return;
 
-    input.blur(); // Remove focus
+    if (executeNetworkCommand(user_input))
+        return;
 
-    toggleChatWindow();
+    // Prohibit observers from sending private messages
+    if (g_IsObserver && user_input.indexOf("/all") != 0)
+        return;
+
+    // Optionally tag as team chat
+    if (Engine.GetGUIObjectByName("toggleTeamChat").checked)
+        user_input = "/team " + user_input;
+
+    submitChatDirectly(user_input);
 }
 
-function addChatMessage(msg, playerAssignments)
+// Displays a given chat message.
+function addChatMessage(msg)
 {
-    // Default to global assignments, but allow overriding for when reporting
-    // new players joining
-    if (!playerAssignments)
-        playerAssignments = g_PlayerAssignments;
-
     var playerColor, username;
 
     // No context by default. May be set by parseChatCommands().
     msg.context = "";
 
-    if ("guid" in msg && playerAssignments[msg.guid])
+    if ("guid" in msg && g_PlayerAssignments[msg.guid])
     {
-        var n = playerAssignments[msg.guid].player;
+        var n = g_PlayerAssignments[msg.guid].player;
         // Observers have an ID of -1 which is not a valid index.
         if (n < 0)
             n = 0;
         playerColor = g_Players[n].color.r + " " + g_Players[n].color.g + " " + g_Players[n].color.b;
-        username = escapeText(playerAssignments[msg.guid].name);
+        username = escapeText(g_PlayerAssignments[msg.guid].name);
 
         // Parse in-line commands in regular messages.
         if (msg.type == "message")
-            parseChatCommands(msg, playerAssignments);
+            parseChatCommands(msg);
     }
     else if (msg.type == "defeat" && msg.player)
     {
         [username, playerColor] = getUsernameAndColor(msg.player);
     }
     else if (msg.type == "message")
     {
         [username, playerColor] = getUsernameAndColor(msg.player);
-        parseChatCommands(msg, playerAssignments);
+        parseChatCommands(msg);
     }
     else
     {
         playerColor = "255 255 255";
         username = translate("Unknown player");
@@ -438 +443 @@
     var formatted;
 
     switch (msg.type)
     {
     case "connect":
-        formatted = sprintf(translate("%(player)s is starting to rejoin the game."), { player: "[color=\"" + playerColor + "\"]" + username + "[/color]" });
+        formatted = sprintf(translate("%(player)s is starting to rejoin the game."), { "player": "[color=\"" + playerColor + "\"]" + username + "[/color]" });
         break;
     case "disconnect":
-        formatted = sprintf(translate("%(player)s has left the game."), { player: "[color=\"" + playerColor + "\"]" + username + "[/color]" });
+        formatted = sprintf(translate("%(player)s has left the game."), { "player": "[color=\"" + playerColor + "\"]" + username + "[/color]" });
         break;
     case "rejoined":
-        formatted = sprintf(translate("%(player)s has rejoined the game."), { player: "[color=\"" + playerColor + "\"]" + username + "[/color]" });
+        formatted = sprintf(translate("%(player)s has rejoined the game."), { "player": "[color=\"" + playerColor + "\"]" + username + "[/color]" });
+        break;
+    case "clientlist":
+        formatted = sprintf(translate("Users: %(users)s"), { "users": getUsernameList().join(",") });
+        break;
+    case "kicked":
+        formatted = sprintf(translate("%(username)s has been kicked."), { "username": msg.username });
+        break;
+    case "banned":
+        formatted = sprintf(translate("%(username)s has been banned."), { "username": msg.username });
         break;
     case "defeat":
         // In singleplayer, the local player is "You". "You has" is incorrect.
         if (!g_IsNetworked && msg.player == Engine.GetPlayerID())
             formatted = translate("You have been defeated.");
         else
-            formatted = sprintf(translate("%(player)s has been defeated."), { player: "[color=\"" + playerColor + "\"]" + username + "[/color]" });
+            formatted = sprintf(translate("%(player)s has been defeated."), { "player": "[color=\"" + playerColor + "\"]" + username + "[/color]" });
         break;
     case "diplomacy":
         var message;
         if (msg.player == Engine.GetPlayerID())
         {
@@ -598 +612 @@
     chatTimers.shift();
     chatMessages.shift();
     Engine.GetGUIObjectByName("chatText").caption = chatMessages.join("\n");
 }
 
-// Parses chat messages for commands.
-function parseChatCommands(msg, playerAssignments)
+// Parses commands that are specific to the chat.
+function parseChatCommands(msg)
 {
     // Only interested in messages that start with '/'.
     if (!msg.text || msg.text[0] != '/')
         return;
 
     var sender;
-    if (playerAssignments[msg.guid])
-        sender = playerAssignments[msg.guid].player;
+    if (g_PlayerAssignments[msg.guid])
+        sender = g_PlayerAssignments[msg.guid].player;
     else
         sender = msg.player;
 
     // TODO: It would be nice to display multiple different contexts.
     // It should be made clear that only players matching the union of those receive the message.
@@ -666 +680 @@
     case "/msg":
         var trimmed = msg.text.substr(split[0].length + 1);
         var matched = "";
 
         // Reject names which don't match or are a superset of the intended name.
-        for each (var player in playerAssignments)
+        for (let player of g_PlayerAssignments)
             if (trimmed.indexOf(player.name + " ") == 0 && player.name.length > matched.length)
                 matched = player.name;
 
         // If the local player's name was the longest one matched, show the message.
         var playerName = g_Players[Engine.GetPlayerID()].name;
@@ -694 +708 @@
     if (!msg.text.length)
         msg.hide = true;
 
     // Attempt to parse more commands if the current command allows it.
     if (recurse)
-        parseChatCommands(msg, playerAssignments);
+        parseChatCommands(msg);
 }
 
 function sendDialogAnswer(guiObject, dialogName)
 {
     Engine.GetGUIObjectByName(dialogName+"-dialog").hidden = true;

binaries/data/mods/public/gui/session/session.xml

@@ -5 +5 @@
 <script file="gui/common/colorFades.js"/>
 <script file="gui/common/functions_civinfo.js"/>
 <script file="gui/common/functions_global_object.js"/>
 <script file="gui/common/functions_utility.js"/>
 <script file="gui/common/l10n.js"/>
+<script file="gui/common/network.js"/>
 <script file="gui/common/music.js"/>
 <script file="gui/common/timer.js"/>
 <script file="gui/common/tooltips.js"/>
 <!-- load all scripts in this directory -->
 <script directory="gui/session/"/>

source/gui/scripting/ScriptFunctions.cpp

@@ -345 +345 @@
     SAFE_DELETE(g_NetServer);
     SAFE_DELETE(g_NetClient);
     SAFE_DELETE(g_Game);
 }
 
+void KickPlayer(ScriptInterface::CxPrivate* UNUSED(pCxPrivate), CStrW playerName, bool ban)
+{
+    if (g_NetServer)
+        g_NetServer->KickPlayer(playerName, ban);
+}
+
 JS::Value PollNetworkClient(ScriptInterface::CxPrivate* pCxPrivate)
 {
     if (!g_NetClient)
         return JS::UndefinedValue();
 
@@ -954 +960 @@
     scriptInterface.RegisterFunction<void, JS::HandleValue, int, &StartGame>("StartGame");
     scriptInterface.RegisterFunction<void, &Script_EndGame>("EndGame");
     scriptInterface.RegisterFunction<void, std::wstring, &StartNetworkHost>("StartNetworkHost");
     scriptInterface.RegisterFunction<void, std::wstring, std::string, &StartNetworkJoin>("StartNetworkJoin");
     scriptInterface.RegisterFunction<void, &DisconnectNetworkGame>("DisconnectNetworkGame");
+    scriptInterface.RegisterFunction<void, CStrW, bool, &KickPlayer>("KickPlayer");
     scriptInterface.RegisterFunction<JS::Value, &PollNetworkClient>("PollNetworkClient");
     scriptInterface.RegisterFunction<void, JS::HandleValue, &SetNetworkGameAttributes>("SetNetworkGameAttributes");
     scriptInterface.RegisterFunction<void, int, std::string, &AssignNetworkPlayer>("AssignNetworkPlayer");
     scriptInterface.RegisterFunction<void, std::string, int, &SetNetworkPlayerStatus>("SetNetworkPlayerStatus");
     scriptInterface.RegisterFunction<void, &ClearAllPlayerReady>("ClearAllPlayerReady");

source/network/NetClient.cpp

@@ -91 +91 @@
 
     AddTransition(NCS_PREGAME, (uint)NMT_CHAT, NCS_PREGAME, (void*)&OnChat, context);
     AddTransition(NCS_PREGAME, (uint)NMT_READY, NCS_PREGAME, (void*)&OnReady, context);
     AddTransition(NCS_PREGAME, (uint)NMT_GAME_SETUP, NCS_PREGAME, (void*)&OnGameSetup, context);
     AddTransition(NCS_PREGAME, (uint)NMT_PLAYER_ASSIGNMENT, NCS_PREGAME, (void*)&OnPlayerAssignment, context);
+    AddTransition(NCS_PREGAME, (uint)NMT_KICKED, NCS_PREGAME, (void*)&OnKicked, context);
     AddTransition(NCS_PREGAME, (uint)NMT_GAME_START, NCS_LOADING, (void*)&OnGameStart, context);
     AddTransition(NCS_PREGAME, (uint)NMT_JOIN_SYNC_START, NCS_JOIN_SYNCING, (void*)&OnJoinSyncStart, context);
 
     AddTransition(NCS_JOIN_SYNCING, (uint)NMT_CHAT, NCS_JOIN_SYNCING, (void*)&OnChat, context);
     AddTransition(NCS_JOIN_SYNCING, (uint)NMT_GAME_SETUP, NCS_JOIN_SYNCING, (void*)&OnGameSetup, context);
@@ -108 +109 @@
     AddTransition(NCS_LOADING, (uint)NMT_GAME_SETUP, NCS_LOADING, (void*)&OnGameSetup, context);
     AddTransition(NCS_LOADING, (uint)NMT_PLAYER_ASSIGNMENT, NCS_LOADING, (void*)&OnPlayerAssignment, context);
     AddTransition(NCS_LOADING, (uint)NMT_LOADED_GAME, NCS_INGAME, (void*)&OnLoadedGame, context);
 
     AddTransition(NCS_INGAME, (uint)NMT_REJOINED, NCS_INGAME, (void*)&OnRejoined, context);
+    AddTransition(NCS_INGAME, (uint)NMT_KICKED, NCS_INGAME, (void*)&OnKicked, context);
     AddTransition(NCS_INGAME, (uint)NMT_CHAT, NCS_INGAME, (void*)&OnChat, context);
     AddTransition(NCS_INGAME, (uint)NMT_GAME_SETUP, NCS_INGAME, (void*)&OnGameSetup, context);
     AddTransition(NCS_INGAME, (uint)NMT_PLAYER_ASSIGNMENT, NCS_INGAME, (void*)&OnPlayerAssignment, context);
     AddTransition(NCS_INGAME, (uint)NMT_SIMULATION_COMMAND, NCS_INGAME, (void*)&OnInGame, context);
     AddTransition(NCS_INGAME, (uint)NMT_SYNC_ERROR, NCS_INGAME, (void*)&OnInGame, context);
@@ -605 +607 @@
     client->PushGuiMessage(msg);
 
     return true;
 }
 
+bool CNetClient::OnKicked(void *context, CFsmEvent* event)
+{
+    ENSURE(event->GetType() == (uint)NMT_KICKED);
+
+    CNetClient* client = (CNetClient*)context;
+    JSContext* cx = client->GetScriptInterface().GetContext();
+
+    CKickedMessage* message = (CKickedMessage*)event->GetParamRef();
+    JS::RootedValue msg(cx);
+    client->GetScriptInterface().Eval("({ 'type': 'kicked' })", &msg);
+    client->GetScriptInterface().SetProperty(msg, "username", message->m_Name, false);
+    client->GetScriptInterface().SetProperty(msg, "ban", message->m_Ban, false);
+    client->PushGuiMessage(msg);
+
+    return true;
+}
+
 bool CNetClient::OnLoadedGame(void* context, CFsmEvent* event)
 {
     ENSURE(event->GetType() == (uint)NMT_LOADED_GAME);
 
     CNetClient* client = (CNetClient*)context;

source/network/NetClient.h

@@ -199 +199 @@
     static bool OnInGame(void* context, CFsmEvent* event);
     static bool OnGameStart(void* context, CFsmEvent* event);
     static bool OnJoinSyncStart(void* context, CFsmEvent* event);
     static bool OnJoinSyncEndCommandBatch(void* context, CFsmEvent* event);
     static bool OnRejoined(void* context, CFsmEvent* event);
+    static bool OnKicked(void* context, CFsmEvent* event);
     static bool OnLoadedGame(void* context, CFsmEvent* event);
 
     /**
      * Take ownership of a session object, and use it for all network communication.
      */

source/network/NetHost.h

@@ -61 +61 @@
 {
     NDR_UNKNOWN = 0,
     NDR_UNEXPECTED_SHUTDOWN,
     NDR_INCORRECT_PROTOCOL_VERSION,
     NDR_SERVER_LOADING,
-    NDR_SERVER_ALREADY_IN_GAME
+    NDR_SERVER_ALREADY_IN_GAME,
+    NDR_KICKED,
+    NDR_BANNED
 };
 
 class CNetHost
 {
 public:

source/network/NetMessage.cpp

@@ -133 +133 @@
 
     case NMT_REJOINED:
         pNewMessage = new CRejoinedMessage;
         break;
 
+    case NMT_KICKED:
+        pNewMessage = new CKickedMessage;
+        break;
+
     case NMT_LOADED_GAME:
         pNewMessage = new CLoadedGameMessage;
         break;
 
     case NMT_SERVER_HANDSHAKE:

source/network/NetMessages.h

@@ -26 +26 @@
 #include "ps/CStr.h"
 #include "scriptinterface/ScriptVal.h"
 
 #define PS_PROTOCOL_MAGIC               0x5073013f      // 'P', 's', 0x01, '?'
 #define PS_PROTOCOL_MAGIC_RESPONSE      0x50630121      // 'P', 'c', 0x01, '!'
-#define PS_PROTOCOL_VERSION             0x01010007      // Arbitrary protocol
+#define PS_PROTOCOL_VERSION             0x01010008      // Arbitrary protocol
 #define PS_DEFAULT_PORT                 0x5073          // 'P', 's'
 
 // Defines the list of message types. The order of the list must not change.
 // The message types having a negative value are used internally and not sent
 // over the network. The message types used for network communication have 
@@ -56 +56 @@
     NMT_FILE_TRANSFER_ACK,
 
     NMT_JOIN_SYNC_START,
 
     NMT_REJOINED,
+    NMT_KICKED,
 
     NMT_LOADED_GAME,
     NMT_GAME_START,
     NMT_END_COMMAND_BATCH,
     NMT_SYNC_CHECK, // OOS-detection hash checking
@@ -159 +160 @@
 
 START_NMT_CLASS_(Rejoined, NMT_REJOINED)
     NMT_FIELD(CStr8, m_GUID)
 END_NMT_CLASS()
 
+START_NMT_CLASS_(Kicked, NMT_KICKED)
+    NMT_FIELD(CStrW, m_Name)
+    NMT_FIELD_INT(m_Ban, bool, 1)
+END_NMT_CLASS()
+
 START_NMT_CLASS_(LoadedGame, NMT_LOADED_GAME)
     NMT_FIELD_INT(m_CurrentTurn, u32, 4)
 END_NMT_CLASS()
 
 START_NMT_CLASS_(GameStart, NMT_GAME_START)

source/network/NetServer.cpp

@@ -119 +119 @@
 
 CNetServerWorker::CNetServerWorker(int autostartPlayers) :
     m_AutostartPlayers(autostartPlayers),
     m_Shutdown(false),
     m_ScriptInterface(NULL),
-    m_NextHostID(1), m_Host(NULL), m_Stats(NULL)
+    m_NextHostID(1), m_Host(NULL), m_HostGUID(), m_Stats(NULL)
 {
     m_State = SERVER_STATE_UNCONNECTED;
 
     m_ServerTurnManager = NULL;
 
@@ -604 +604 @@
     session->SetFirstState(NSS_HANDSHAKE);
 }
 
 bool CNetServerWorker::HandleConnect(CNetServerSession* session)
 {
+    CNetServerWorker& server = session->GetServer();
+
+    // Disconnect banned IPs
+    if (std::find(server.m_BannedIPs.begin(), server.m_BannedIPs.end(), session->GetIPAddress()) != server.m_BannedIPs.end())
+    {
+        session->Disconnect(NDR_BANNED);
+        return false;
+    }
+
+    // Send handshake challenge
     CSrvHandshakeMessage handshake;
     handshake.m_Magic = PS_PROTOCOL_MAGIC;
     handshake.m_ProtocolVersion = PS_PROTOCOL_VERSION;
     handshake.m_SoftwareVersion = PS_PROTOCOL_VERSION;
     return session->SendMessage(&handshake);
@@ -615 +625 @@
 
 void CNetServerWorker::OnUserJoin(CNetServerSession* session)
 {
     AddPlayer(session->GetGUID(), session->GetUserName());
 
+    if (m_HostGUID.empty())
+        m_HostGUID = session->GetGUID();
+
     CGameSetupMessage gameSetupMessage(GetScriptInterface());
     gameSetupMessage.m_Data = m_GameAttributes.get();
     session->SendMessage(&gameSetupMessage);
 
     CPlayerAssignmentMessage assignMessage;
@@ -630 +643 @@
 {
     RemovePlayer(session->GetGUID());
 
     if (m_ServerTurnManager && session->GetCurrState() != NSS_JOIN_SYNCING)
         m_ServerTurnManager->UninitialiseClient(session->GetHostID()); // TODO: only for non-observers
-
-    // TODO: ought to switch the player controlled by that client
-    // back to AI control, or something?
 }
 
 void CNetServerWorker::AddPlayer(const CStr& guid, const CStrW& name)
 {
     // Find all player IDs in active use; we mustn't give them to a second player (excluding the unassigned ID: -1)
@@ -707 +717 @@
         it->second.m_Status = 0;
 
     SendPlayerAssignments();
 }
 
+void CNetServerWorker::KickPlayer(const CStrW& playerName, const bool ban)
+{
+    // Find the user with that name
+    std::vector<CNetServerSession*>::iterator it = std::find_if(m_Sessions.begin(), m_Sessions.end(),
+        [&](CNetServerSession* session) { return session->GetUserName() == playerName; });
+
+    // and return if no one or the host has that name
+    if (it == m_Sessions.end() || (*it)->GetGUID() == m_HostGUID)
+        return;
+
+    if (ban)
+    {
+        // Remember name
+        if (std::find(m_BannedPlayers.begin(), m_BannedPlayers.end(), playerName) == m_BannedPlayers.end())
+            m_BannedPlayers.push_back(playerName);
+
+        // Remember IP address
+        CStr ipAddress = GetPlayerIPAddress(playerName);
+        if (std::find(m_BannedIPs.begin(), m_BannedIPs.end(), ipAddress) == m_BannedIPs.end())
+            m_BannedIPs.push_back(ipAddress);
+    }
+
+    // Disconnect that user
+    (*it)->Disconnect(ban ? NDR_BANNED : NDR_KICKED);
+
+    // Send message notifying other clients
+    CKickedMessage kickedMessage;
+    kickedMessage.m_Name = playerName;
+    kickedMessage.m_Ban = ban;
+    Broadcast(&kickedMessage);
+}
+
+CStr CNetServerWorker::GetPlayerIPAddress(const CStrW& playerName)
+{
+    for (CNetServerSession* session : m_Sessions)
+        if (session->GetUserName() == playerName)
+            return session->GetIPAddress();
+    return "(error)";
+}
+
 void CNetServerWorker::AssignPlayer(int playerID, const CStr& guid)
 {
     // Remove anyone who's already assigned to this player
     for (PlayerAssignmentMap::iterator it = m_PlayerAssignments.begin(); it != m_PlayerAssignments.end(); ++it)
     {
@@ -764 +814 @@
     ENSURE(event->GetType() == (uint)NMT_CLIENT_HANDSHAKE);
 
     CNetServerSession* session = (CNetServerSession*)context;
     CNetServerWorker& server = session->GetServer();
 
+    // Check protocol version
     CCliHandshakeMessage* message = (CCliHandshakeMessage*)event->GetParamRef();
     if (message->m_ProtocolVersion != PS_PROTOCOL_VERSION)
     {
         session->Disconnect(NDR_INCORRECT_PROTOCOL_VERSION);
         return false;
     }
 
+    // Send handshake response
     CSrvHandshakeResponseMessage handshakeResponse;
     handshakeResponse.m_UseProtocolVersion = PS_PROTOCOL_VERSION;
     handshakeResponse.m_Message = server.m_WelcomeMessage;
     handshakeResponse.m_Flags = 0;
     session->SendMessage(&handshakeResponse);
@@ -798 +850 @@
     }
 
     CAuthenticateMessage* message = (CAuthenticateMessage*)event->GetParamRef();
     CStrW username = server.DeduplicatePlayerName(SanitisePlayerName(message->m_Name));
 
+    // Disconnect banned usernames
+    if (std::find(server.m_BannedPlayers.begin(), server.m_BannedPlayers.end(), username) != server.m_BannedPlayers.end())
+    {
+        session->Disconnect(NDR_BANNED);
+        return true;
+    }
+
     // Optionally allow observers to join after the game has started
     bool observerLateJoin = false;
     ScriptInterface& scriptInterface = server.GetScriptInterface();
     JSContext* cx = scriptInterface.GetContext();
     JSAutoRequest rq(cx);
@@ -1147 +1206 @@
 bool CNetServer::SetupConnection()
 {
     return m_Worker->SetupConnection();
 }
 
+void CNetServer::KickPlayer(const CStrW& playerName, const bool ban)
+{
+    CScopeLock lock(m_Worker->m_WorkerMutex);
+    m_Worker->KickPlayer(playerName, ban);
+}
+
 void CNetServer::AssignPlayer(int playerID, const CStr& guid)
 {
     CScopeLock lock(m_Worker->m_WorkerMutex);
     m_Worker->m_AssignPlayerQueue.emplace_back(playerID, guid);
 }

source/network/NetServer.h

@@ -120 +120 @@
      * The given GUID will be (re)assigned to the given player ID.
      * Any player currently using that ID will be unassigned.
      * The changes will be asynchronously propagated to all clients.
      */
     void AssignPlayer(int playerID, const CStr& guid);
-    
+
     /**
      * Call from the GUI to update the player readiness.
      * The changes will be asynchronously propagated to all clients.
      */
     void SetPlayerReady(const CStr& guid, int ready);
@@ -132 +132 @@
     /**
      * Call from the GUI to set the all player readiness to 0.
      * The changes will be asynchronously propagated to all clients.
      */
     void ClearAllPlayerReady();
-    
+
+    /**
+     * Disconnects a player from the gamesetup / session.
+     */
+    void KickPlayer(const CStrW& playerName, const bool ban);
+
     /**
      * Call from the GUI to asynchronously notify all clients that they should start loading the game.
      */
     void StartGame();
 
@@ -181 +186 @@
      * Send a message to the given network peer.
      */
     bool SendMessage(ENetPeer* peer, const CNetMessage* message);
 
     /**
+     * Disconnected a player from the match / gamesetup and optionally prevents him/her from rejoining.
+     */
+    void KickPlayer(const CStrW& playerName, const bool ban);
+
+    /**
      * Send a message to all clients who have completed the full connection process
      * (i.e. are in the pre-game or in-game states).
      */
     bool Broadcast(const CNetMessage* message);
 
+    /**
+     * Returns the IP address of the given connected player.
+     */
+    CStr GetPlayerIPAddress(const CStrW& playerName);
+
 private:
     friend class CNetServer;
     friend class CNetFileReceiveTask_ServerRejoin;
 
     CNetServerWorker(int autostartPlayers);
@@ -243 +258 @@
      */
     void SetTurnLength(u32 msecs);
 
     void AddPlayer(const CStr& guid, const CStrW& name);
     void RemovePlayer(const CStr& guid);
-    void SetPlayerReady(const CStr& guid, const int ready); 
+    void SetPlayerReady(const CStr& guid, const int ready);
+    CStr GetHostGUID();
     void SendPlayerAssignments();
     void ClearAllPlayerReady();
 
     void SetupSession(CNetServerSession* session);
     bool HandleConnect(CNetServerSession* session);
@@ -297 +313 @@
     NetServerState m_State;
 
     CStrW m_ServerName;
     CStrW m_WelcomeMessage;
 
+    std::vector<CStr> m_BannedIPs;
+    std::vector<CStrW> m_BannedPlayers;
+
     u32 m_NextHostID;
 
     CNetServerTurnManager* m_ServerTurnManager;
 
+    CStr m_HostGUID;
+
     /**
      * A copy of all simulation commands received so far, indexed by
      * turn number, to simplify support for rejoining etc.
      * TODO: verify this doesn't use too much RAM.
      */

source/network/NetSession.cpp

@@ -1 @@
-/* Copyright (C) 2011 Wildfire Games.
+/* Copyright (C) 2015 Wildfire Games.
  * This file is part of 0 A.D.
  *
  * 0 A.D. is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation, either version 2 of the License, or
@@ -173 +173 @@
 CNetServerSession::CNetServerSession(CNetServerWorker& server, ENetPeer* peer) :
     m_Server(server), m_FileTransferer(this), m_Peer(peer)
 {
 }
 
+CStr CNetServerSession::GetIPAddress()
+{
+    char ipAddress[256] = "(error)";
+    enet_address_get_host_ip(&(m_Peer->address), ipAddress, ARRAY_SIZE(ipAddress));
+    return CStr(ipAddress);
+}
+
 void CNetServerSession::Disconnect(u32 reason)
 {
     Update((uint)NMT_CONNECTION_LOST, NULL);
 
     enet_peer_disconnect(m_Peer, reason);

source/network/NetSession.h

@@ -1 @@
-/* Copyright (C) 2011 Wildfire Games.
+/* Copyright (C) 2015 Wildfire Games.
  * This file is part of 0 A.D.
  *
  * 0 A.D. is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation, either version 2 of the License, or
@@ -121 +121 @@
 
     u32 GetHostID() const { return m_HostID; }
     void SetHostID(u32 id) { m_HostID = id; }
 
     /**
+     * Returns the IP address of the client.
+     */
+    CStr GetIPAddress();
+
+    /**
      * Sends a disconnection notification to the client,
      * and sends a NMT_CONNECTION_LOST message to the session FSM.
      * The server will receive a disconnection notification after a while.
      * The server will not receive any further messages sent via this session.
      */