Add support for V3 tunnels

ClientCore/ProgramConstants.cs

@@ -26,7 +26,7 @@ public static class ProgramConstants
 
         public const string QRES_EXECUTABLE = "qres.dat";
 
-        public const string CNCNET_PROTOCOL_REVISION = "R13";
+        public const string CNCNET_PROTOCOL_REVISION = "R15";
         public const string LAN_PROTOCOL_REVISION = "RL8";
         public const int LAN_PORT = 1234;
         public const int LAN_INGAME_PORT = 1234;

ClientCore/Settings/UserINISettings.cs

@@ -141,6 +141,9 @@ protected UserINISettings(IniFile iniFile)
             MapSortState = new IntSetting(iniFile, MULTIPLAYER, "MapSortState", (int)SortDirection.None);
             SearchAllGameModes = new BoolSetting(iniFile, MULTIPLAYER, "SearchAllGameModes", false);
 
+            UseLegacyTunnels = new BoolSetting(iniFile, MULTIPLAYER, "UseLegacyTunnels", false);
+            UseDynamicTunnels = new BoolSetting(iniFile, MULTIPLAYER, "UseDynamicTunnels", true);
+
             CheckForUpdates = new BoolSetting(iniFile, OPTIONS, "CheckforUpdates", true);
 
             PrivacyPolicyAccepted = new BoolSetting(iniFile, OPTIONS, "PrivacyPolicyAccepted", false);
@@ -238,6 +241,9 @@ protected UserINISettings(IniFile iniFile)
         public BoolSetting SteamIntegration { get; private set; }
         public BoolSetting AllowGameInvitesFromFriendsOnly { get; private set; }
 
+        public BoolSetting UseLegacyTunnels { get; private set; }
+        public BoolSetting UseDynamicTunnels { get; private set; }
+
         public BoolSetting NotifyOnUserListChange { get; private set; }
 
         public BoolSetting DisablePrivateMessagePopups { get; private set; }

DXMainClient/DXGUI/Generic/OptionPanels/CnCNetOptionsPanel.cs

@@ -37,6 +37,9 @@ public CnCNetOptionsPanel(WindowManager windowManager, UserINISettings iniSettin
 
         XNAClientDropDown ddAllowPrivateMessagesFrom;
 
+        XNAClientCheckBox chkUseLegacyTunnels;
+        XNAClientCheckBox chkUseDynamicTunnels;
+
         GameCollection gameCollection;
 
         List<XNAClientCheckBox> followedGameChks = new List<XNAClientCheckBox>();
@@ -118,7 +121,7 @@ private void InitOptions()
             chkPersistentMode.Name = nameof(chkPersistentMode);
             chkPersistentMode.ClientRectangle = new Rectangle(
                 chkSkipLoginWindow.X,
-                chkSkipLoginWindow.Bottom + 12, 0, 0);
+                chkSkipLoginWindow.Bottom + 9, 0, 0);
             chkPersistentMode.Text = "Stay connected outside of the CnCNet lobby".L10N("Client:DTAConfig:StayConnect");
             chkPersistentMode.CheckedChanged += ChkPersistentMode_CheckedChanged;
 
@@ -128,7 +131,7 @@ private void InitOptions()
             chkConnectOnStartup.Name = nameof(chkConnectOnStartup);
             chkConnectOnStartup.ClientRectangle = new Rectangle(
                 chkSkipLoginWindow.X,
-                chkPersistentMode.Bottom + 12, 0, 0);
+                chkPersistentMode.Bottom + 9, 0, 0);
             chkConnectOnStartup.Text = "Connect automatically on client startup".L10N("Client:DTAConfig:ConnectOnStart");
             chkConnectOnStartup.AllowChecking = false;
 
@@ -138,7 +141,7 @@ private void InitOptions()
             chkDiscordIntegration.Name = nameof(chkDiscordIntegration);
             chkDiscordIntegration.ClientRectangle = new Rectangle(
                 chkSkipLoginWindow.X,
-                chkConnectOnStartup.Bottom + 12, 0, 0);
+                chkConnectOnStartup.Bottom + 9, 0, 0);
             chkDiscordIntegration.Text = "Show detailed game info in Discord status".L10N("Client:DTAConfig:DiscordStatus");
 
             if (ClientConfiguration.Instance.DiscordIntegrationGloballyDisabled)
@@ -157,7 +160,7 @@ private void InitOptions()
             chkAllowGameInvitesFromFriendsOnly.Name = nameof(chkAllowGameInvitesFromFriendsOnly);
             chkAllowGameInvitesFromFriendsOnly.ClientRectangle = new Rectangle(
                 chkDiscordIntegration.X,
-                chkDiscordIntegration.Bottom + 12, 0, 0);
+                chkDiscordIntegration.Bottom + 9, 0, 0);
             chkAllowGameInvitesFromFriendsOnly.Text = "Only receive game invitations from friends".L10N("Client:DTAConfig:FriendsOnly");
 
             AddChild(chkAllowGameInvitesFromFriendsOnly);
@@ -167,17 +170,35 @@ private void InitOptions()
             chkSteamIntegration.Name = nameof(chkSteamIntegration);
             chkSteamIntegration.ClientRectangle = new Rectangle(
                 chkAllowGameInvitesFromFriendsOnly.X,
-                chkAllowGameInvitesFromFriendsOnly.Bottom + 12, 0, 0);
+                chkAllowGameInvitesFromFriendsOnly.Bottom + 9, 0, 0);
             chkSteamIntegration.Text = "Show the game being played in Steam".L10N("Client:DTAConfig:SteamStatus");
 
             AddChild(chkSteamIntegration);
+
+            chkUseLegacyTunnels = new XNAClientCheckBox(WindowManager);
+            chkUseLegacyTunnels.Name = nameof(chkUseLegacyTunnels);
+            chkUseLegacyTunnels.ClientRectangle = new Rectangle(
+                chkSteamIntegration.X,
+                chkSteamIntegration.Bottom + 9, 0, 0);
+            chkUseLegacyTunnels.Text = "Use legacy tunnels when hosting".L10N("Client:DTAConfig:LegacyTunnels");
+            chkUseLegacyTunnels.CheckedChanged += ChkUseLegacyTunnels_CheckedChanged;
+
+            AddChild(chkUseLegacyTunnels);
+
+            chkUseDynamicTunnels = new XNAClientCheckBox(WindowManager);
+            chkUseDynamicTunnels.Name = nameof(chkUseDynamicTunnels);
+            chkUseDynamicTunnels.ClientRectangle = new Rectangle(
+                chkUseLegacyTunnels.X,
+                chkUseLegacyTunnels.Bottom + 9, 0, 0);
+            chkUseDynamicTunnels.Text = "Use dynamic tunnels when hosting".L10N("Client:DTAConfig:DynamicTunnels");
+            AddChild(chkUseDynamicTunnels);
         }
 
         private void InitAllowPrivateMessagesFromDropdown()
         {
             XNALabel lblAllPrivateMessagesFrom = new XNALabel(WindowManager);
             lblAllPrivateMessagesFrom.Name = nameof(lblAllPrivateMessagesFrom);
-            lblAllPrivateMessagesFrom.Text = "Allow Private Messages From:".L10N("Client:DTAConfig:AllowPMFrom");
+            lblAllPrivateMessagesFrom.Text = "Allow private messages from:".L10N("Client:DTAConfig:AllowPMFrom");
             lblAllPrivateMessagesFrom.ClientRectangle = new Rectangle(
                 chkDisablePrivateMessagePopup.X,
                 chkDisablePrivateMessagePopup.Bottom + 12, 165, 0);
@@ -187,8 +208,8 @@ private void InitAllowPrivateMessagesFromDropdown()
             ddAllowPrivateMessagesFrom = new XNAClientDropDown(WindowManager);
             ddAllowPrivateMessagesFrom.Name = nameof(ddAllowPrivateMessagesFrom);
             ddAllowPrivateMessagesFrom.ClientRectangle = new Rectangle(
-                lblAllPrivateMessagesFrom.Right,
-                lblAllPrivateMessagesFrom.Y - 2, 110, 0);
+                lblAllPrivateMessagesFrom.Right - 110,
+                lblAllPrivateMessagesFrom.Y + 22, 110, 0);
 
             ddAllowPrivateMessagesFrom.AddItem(new XNADropDownItem()
             {
@@ -298,6 +319,11 @@ private void InitGameListPanel()
             }
         }
 
+        private void ChkUseLegacyTunnels_CheckedChanged(object sender, EventArgs e)
+        {
+            chkUseDynamicTunnels.AllowChecking = !chkUseLegacyTunnels.Checked;
+        }
+
         private void ChkSkipLoginWindow_CheckedChanged(object sender, EventArgs e)
         {
             CheckConnectOnStartupAllowance();
@@ -334,6 +360,8 @@ public override void Load()
             chkSkipLoginWindow.Checked = IniSettings.SkipConnectDialog;
             chkPersistentMode.Checked = IniSettings.PersistentMode;
             chkSteamIntegration.Checked = IniSettings.SteamIntegration;
+            chkUseLegacyTunnels.Checked = IniSettings.UseLegacyTunnels;
+            chkUseDynamicTunnels.Checked = IniSettings.UseDynamicTunnels;
 
             chkDiscordIntegration.Checked = !ClientConfiguration.Instance.DiscordIntegrationGloballyDisabled
                 && IniSettings.DiscordIntegration;
@@ -354,6 +382,8 @@ public override void Load()
 
                 chkBox.Checked = IniSettings.IsGameFollowed(chkBox.Name);
             }
+
+            ChkUseLegacyTunnels_CheckedChanged(null, EventArgs.Empty);
         }
 
         public override bool Save()
@@ -370,6 +400,8 @@ public override bool Save()
             IniSettings.SkipConnectDialog.Value = chkSkipLoginWindow.Checked;
             IniSettings.PersistentMode.Value = chkPersistentMode.Checked;
             IniSettings.SteamIntegration.Value = chkSteamIntegration.Checked;
+            IniSettings.UseLegacyTunnels.Value = chkUseLegacyTunnels.Checked;
+            IniSettings.UseDynamicTunnels.Value = chkUseDynamicTunnels.Checked;
 
             if (!ClientConfiguration.Instance.DiscordIntegrationGloballyDisabled)
             {

DXMainClient/DXGUI/Multiplayer/CnCNet/CnCNetGameLoadingLobby.cs

@@ -265,12 +265,12 @@ public void OnJoined()
             {
                 channel.SendCTCPMessage(FILE_HASH_CTCP_COMMAND + " " + fhc.GetCompleteHash(), QueuedMessageType.SYSTEM_MESSAGE, 10);
 
-                channel.SendCTCPMessage(TUNNEL_PING_CTCP_COMMAND + " " + tunnelHandler.CurrentTunnel.PingInMs, QueuedMessageType.SYSTEM_MESSAGE, 10);
+                channel.SendCTCPMessage(TUNNEL_PING_CTCP_COMMAND + " " + tunnelHandler.CurrentTunnel.Ping.Milliseconds, QueuedMessageType.SYSTEM_MESSAGE, 10);
 
-                if (tunnelHandler.CurrentTunnel.PingInMs < 0)
+                if (tunnelHandler.CurrentTunnel.Ping.IsUnknown())
                     AddNotice(string.Format("{0} - unknown ping to tunnel server.".L10N("Client:Main:PlayerUnknownPing"), ProgramConstants.PLAYERNAME));
                 else
-                    AddNotice(string.Format("{0} - ping to tunnel server: {1} ms".L10N("Client:Main:PlayerPing"), ProgramConstants.PLAYERNAME, tunnelHandler.CurrentTunnel.PingInMs));
+                    AddNotice(string.Format("{0} - ping to tunnel server: {1} ms".L10N("Client:Main:PlayerPing"), ProgramConstants.PLAYERNAME, tunnelHandler.CurrentTunnel.Ping.Milliseconds));
             }
 
             topBar.AddPrimarySwitchable(this);

DXMainClient/DXGUI/Multiplayer/CnCNet/CnCNetLobby.cs

@@ -1543,9 +1543,17 @@ private void GameBroadcastChannel_CTCPReceived(object sender, ChannelCTCPEventAr
                 string mapName = splitMessage[7];
                 string gameMode = splitMessage[8];
 
-                string[] tunnelAddressAndPort = splitMessage[9].Split(':');
-                string tunnelAddress = tunnelAddressAndPort[0];
-                int tunnelPort = int.Parse(tunnelAddressAndPort[1]);
+                bool isDynamicTunnels = splitMessage[9] == "[DYN]";
+                CnCNetTunnel tunnel = null;
+                if (!isDynamicTunnels)
+                {
+                    string[] tunnelAddressAndPort = splitMessage[9].Split(':');
+                    string tunnelAddress = tunnelAddressAndPort[0];
+                    int tunnelPort = int.Parse(tunnelAddressAndPort[1]);
+                    tunnel = tunnelHandler.Tunnels.Find(t => t.Address == tunnelAddress && t.Port == tunnelPort);
+                    if (tunnel == null)
+                        return;
+                }
 
                 string loadedGameId = splitMessage[10];
                 int skillLevel = int.Parse(splitMessage[11]);
@@ -1556,51 +1564,8 @@ private void GameBroadcastChannel_CTCPReceived(object sender, ChannelCTCPEventAr
                 if (cncnetGame == null)
                     return;
 
-                // Find the tunnel server specified in the game message
-
-                if (tunnelHandler.Tunnels.Count == 0)
-                {
-                    Logger.Log("Ignoring CTCP game message because there are no tunnels at all. Available tunnel count: 0. Is the connection to CnCNet HTTP service broken?");
-
-                    // Remind users that the game is ignored because of no tunnel
-                    if (lbGameList.Items.Count == 0 && lbGameList.HostedGames.Count == 0)
-                    {
-                        string message = ("There are no games listed. The client did receive a valid game message but can't add it to the list because there are no available tunnels. " +
-                            "You can ignore this prompt if there are games listed later. Otherwise, it might indicate a network problem to CnCNet HTTP service.").L10N("Client:Main:NoTunnels");
-
-                        if ((lbChatMessages.Items.LastOrDefault()?.Tag as ChatMessage)?.Message != message)
-                        {
-                            lbChatMessages.AddMessage(new ChatMessage(Color.Gray, message));
-                        }
-                    }
-
-                    return;
-                }
-
-                CnCNetTunnel tunnel = tunnelHandler.Tunnels.Find(t => t.Address == tunnelAddress && t.Port == tunnelPort);
-
-                if (tunnel == null)
-                {
-                    Logger.Log(string.Format("Ignoring CTCP game message because the specified tunnel {0}:{1} is not available. Available tunnel count: {2}",
-                        tunnelAddress, tunnelPort, tunnelHandler.Tunnels.Count));
-
-                    // Remind users that the game is ignored because of no specified tunnel
-                    if (lbGameList.Items.Count == 0 && lbGameList.HostedGames.Count == 0)
-                    {
-                        string message = string.Format(("There are no games listed. The client did receive a valid game message but can't add it to the list because the specified tunnel is not available. " +
-                            "You can ignore this prompt if there are games listed later. Otherwise, please contact support at {0}.").L10N("Client:Main:NoTunnelForGames"), ClientConfiguration.Instance.LongSupportURL);
-
-                        if ((lbChatMessages.Items.LastOrDefault()?.Tag as ChatMessage)?.Message != message)
-                        {
-                            lbChatMessages.AddMessage(new ChatMessage(Color.Gray, message));
-                        }
-                    }
-
-                    return;
-                }
-
                 HostedCnCNetGame game = new HostedCnCNetGame(gameRoomChannelName, revision, gameVersion, maxPlayers,
-                    gameRoomDisplayName, isCustomPassword, true, players,
+                    gameRoomDisplayName, isCustomPassword, !isDynamicTunnels, players,
                     e.UserName, mapName, gameMode, mapHash);
                 game.IsLoadedGame = isLoadedGame;
                 game.MatchID = loadedGameId;

DXMainClient/DXGUI/Multiplayer/CnCNet/GameCreationWindow.cs

@@ -37,6 +37,7 @@ public GameCreationWindow(WindowManager windowManager, TunnelHandler tunnelHandl
         private XNALabel lblPassword;
 
         private XNALabel lblTunnelServer;
+        private XNALabel lblDynamicTunnels;
         private TunnelListBox lbTunnelList;
 
         private XNAClientButton btnCreateGame;
@@ -53,6 +54,8 @@ public override void Initialize()
             lbTunnelList = new TunnelListBox(WindowManager, tunnelHandler);
             lbTunnelList.Name = nameof(lbTunnelList);
 
+            lbTunnelList.TargetVersion = UserINISettings.Instance.UseLegacyTunnels ? 2 : 3;
+
             SkillLevelOptions = ClientConfiguration.Instance.SkillLevelOptions.Split(',');
 
             Name = "GameCreationWindow";
@@ -136,6 +139,14 @@ public override void Initialize()
             lblTunnelServer.Enabled = false;
             lblTunnelServer.Visible = false;
 
+            lblDynamicTunnels = new XNALabel(WindowManager);
+            lblDynamicTunnels.Name = nameof(lblDynamicTunnels);
+            lblDynamicTunnels.ClientRectangle = new Rectangle(UIDesignConstants.EMPTY_SPACE_SIDES +
+                UIDesignConstants.CONTROL_HORIZONTAL_MARGIN, lblTunnelServer.Y, 0, 0);
+            lblDynamicTunnels.Text = "Dynamic tunnels are enabled. You can change this in the settings.".L10N("Client:Main:DynamicTunnelsInfo");
+            lblDynamicTunnels.Enabled = false;
+            lblDynamicTunnels.Visible = false;
+
             lbTunnelList.X = UIDesignConstants.EMPTY_SPACE_SIDES +
                 UIDesignConstants.CONTROL_HORIZONTAL_MARGIN;
             lbTunnelList.Y = lblTunnelServer.Bottom + UIDesignConstants.CONTROL_VERTICAL_MARGIN;
@@ -174,6 +185,7 @@ public override void Initialize()
             AddChild(tbPassword);
             AddChild(lblPassword);
             AddChild(btnDisplayAdvancedOptions);
+            AddChild(lblDynamicTunnels);
             AddChild(lblTunnelServer);
             AddChild(lbTunnelList);
             AddChild(btnCreateGame);
@@ -240,8 +252,7 @@ private void BtnLoadMPGame_LeftClick(object sender, EventArgs e)
 
             GameCreationEventArgs ea = new GameCreationEventArgs(gameName,
                 spawnSGIni.GetIntValue("Settings", "PlayerCount", 2), password,
-                tunnelHandler.Tunnels[lbTunnelList.SelectedIndex], ddSkillLevel.SelectedIndex);
-
+                lbTunnelList.GetSelectedTunnel(), ddSkillLevel.SelectedIndex);
             LoadedGameCreated?.Invoke(this, ea);
         }
 
@@ -257,15 +268,17 @@ private void BtnCreateGame_LeftClick(object sender, EventArgs e)
                 return;
             }
 
-            if (!lbTunnelList.IsValidIndexSelected())
+            CnCNetTunnel selectedTunnel = null;
+            if (!UserINISettings.Instance.UseDynamicTunnels)
             {
-                return;
+                if (!lbTunnelList.IsValidIndexSelected())
+                    return;
+                selectedTunnel = lbTunnelList.GetSelectedTunnel();
             }
 
             GameCreated?.Invoke(this,
-                new GameCreationEventArgs(gameName,int.Parse(ddMaxPlayers.SelectedItem.Text),
-                tbPassword.Text,tunnelHandler.Tunnels[lbTunnelList.SelectedIndex],
-                ddSkillLevel.SelectedIndex)
+                new GameCreationEventArgs(gameName, int.Parse(ddMaxPlayers.SelectedItem.Text),
+                    tbPassword.Text, selectedTunnel, ddSkillLevel.SelectedIndex)
             );
         }
 
@@ -285,8 +298,15 @@ private void BtnDisplayAdvancedOptions_LeftClick(object sender, EventArgs e)
 
             Height = btnCreateGame.Bottom + UIDesignConstants.CONTROL_VERTICAL_MARGIN + UIDesignConstants.EMPTY_SPACE_BOTTOM;
 
+            bool showTunnelList = ShouldShowTunnelList();
             lblTunnelServer.Enable();
-            lbTunnelList.Enable();
+            lblTunnelServer.Visible = showTunnelList;
+
+            if (showTunnelList)
+                lbTunnelList.Enable();
+            else
+                lbTunnelList.Disable();
+
             btnDisplayAdvancedOptions.Disable();
 
             SetAttributesFromIni();
@@ -296,6 +316,26 @@ private void BtnDisplayAdvancedOptions_LeftClick(object sender, EventArgs e)
 
         public void Refresh()
         {
+            bool showTunnelList = ShouldShowTunnelList();
+            bool isAdvancedMode = Name == "GameCreationWindow_Advanced";
+
+            if (!showTunnelList)
+            {
+                lblDynamicTunnels.Visible = true;
+                lbTunnelList.Visible = false;
+                lblTunnelServer.Visible = false;
+                btnDisplayAdvancedOptions.Visible = false;
+            }
+            else
+            {
+                lblDynamicTunnels.Visible = false;
+                lbTunnelList.Visible = isAdvancedMode;
+                lblTunnelServer.Visible = isAdvancedMode;
+                btnDisplayAdvancedOptions.Visible = !isAdvancedMode;
+            }
+
+            lbTunnelList.TargetVersion = UserINISettings.Instance.UseLegacyTunnels ? 2 : 3;
+
             btnLoadMPGame.AllowClick = AllowLoadingGame();
         }
 
@@ -316,5 +356,14 @@ private bool AllowLoadingGame()
 
             return true;
         }
+
+        /// <summary>
+        /// Determines if the tunnel list should be shown.
+        /// The tunnel list is visible when legacy tunnels are enabled or dynamic tunnels are disabled.
+        /// </summary>
+        private bool ShouldShowTunnelList()
+        {
+            return UserINISettings.Instance.UseLegacyTunnels || !UserINISettings.Instance.UseDynamicTunnels;
+        }
     }
 }