DEADSOFTWARE

Net: Clean-up leftovers from using ENet sequencing channels
[d2df-sdl.git] / src / game / g_net.pas
index a743fa1cfad95dbe8791937cb819c12f72a23ff0..d97d4bd07675033281e6a61b888d390eb52a40ab 100644 (file)
@@ -22,22 +22,16 @@ uses
 
 const
   NET_PROTOCOL_VER = 188;
-
   NET_MAXCLIENTS = 24;
-  NET_CHANS = 12;
-
-  NET_CHAN_SERVICE = 0;
-  NET_CHAN_IMPORTANT = 1;
-  NET_CHAN_GAME = 2;
-  NET_CHAN_PLAYER = 3;
-  NET_CHAN_PLAYERPOS = 4;
-  NET_CHAN_MONSTER = 5;
-  NET_CHAN_MONSTERPOS = 6;
-  NET_CHAN_LARGEDATA = 7;
-  NET_CHAN_CHAT = 8;
-  NET_CHAN_DOWNLOAD = 9;
-  NET_CHAN_SHOTS = 10;
-  NET_CHAN_DOWNLOAD_EX = 11;
+
+  // NOTE: We use different channels for unreliable and reliable packets because ENet seems to
+  // discard preceeding RELIABLE packets if a later UNRELIABLE (but not UNSEQUENCED) packet sent
+  // on the same channel has arrived earlier, which is useful for occasional full-state updates.
+  // However, we use a separate download channel to avoid being delayed by other reliable packets.
+  NET_CHAN_UNRELIABLE = 2;
+  NET_CHAN_RELIABLE = 1;
+  NET_CHAN_DOWNLOAD = 11;
+  NET_CHANNELS = 12;  // TODO: Reduce to 3 and re-enumerate channels. Requires protocol increment.
 
   NET_NONE = 0;
   NET_SERVER = 1;
@@ -103,6 +97,7 @@ type
     Player:   Word;
     RequestedFullUpdate: Boolean;
     WaitForFirstSpawn: Boolean; // set to `true` in server, used to spawn a player on first full state request
+    FullUpdateSent: Boolean;
     RCONAuth: Boolean;
     Voted:    Boolean;
     Crimes:   Integer;
@@ -206,23 +201,19 @@ procedure g_Net_Flush();
 
 function  g_Net_Host(IPAddr: LongWord; Port: enet_uint16; MaxClients: Cardinal = 16): Boolean;
 procedure g_Net_Host_Die();
-procedure g_Net_Host_Send(ID: Integer; Reliable: Boolean; Chan: Byte = NET_CHAN_GAME);
+procedure g_Net_Host_Send(ID: Integer; Reliable: Boolean);
 procedure g_Net_Host_Update();
+procedure g_Net_Host_Kick(ID: Integer; Reason: enet_uint32);
 
 function  g_Net_Connect(IP: string; Port: enet_uint16): Boolean;
 procedure g_Net_Disconnect(Forced: Boolean = False);
-procedure g_Net_Client_Send(Reliable: Boolean; Chan: Byte = NET_CHAN_GAME);
+procedure g_Net_Client_Send(Reliable: Boolean);
 procedure g_Net_Client_Update();
-procedure g_Net_Client_UpdateWhileLoading();
 
 function  g_Net_Client_ByName(Name: string): pTNetClient;
 function  g_Net_Client_ByPlayer(PID: Word): pTNetClient;
 function  g_Net_ClientName_ByID(ID: Integer): string;
 
-procedure g_Net_SendData(Data: AByte; peer: pENetPeer; Reliable: Boolean; Chan: Byte = NET_CHAN_DOWNLOAD);
-//function  g_Net_Wait_Event(msgId: Word): TMemoryStream;
-//function g_Net_Wait_FileInfo (var tf: TNetFileTransfer; asMap: Boolean; out resList: TStringList): Integer;
-
 function  IpToStr(IP: LongWord): string;
 function  StrToIp(IPstr: string; var IP: LongWord): Boolean;
 
@@ -372,7 +363,7 @@ const
 procedure killClientByFT (var nc: TNetClient);
 begin
   e_LogWritefln('disconnected client #%d due to file transfer error', [nc.ID], TMsgType.Warning);
-  enet_peer_disconnect(nc.Peer, NET_DISC_FILE_TIMEOUT);
+  g_Net_Host_Kick(nc.ID, NET_DISC_FILE_TIMEOUT);
   clearNetClientTransfers(nc);
   g_Net_Slist_ServerPlayerLeaves();
 end;
@@ -387,7 +378,7 @@ begin
   if (m.CurSize < 1) then exit;
   pkt := enet_packet_create(m.Data, m.CurSize, ENET_PACKET_FLAG_RELIABLE);
   if not Assigned(pkt) then begin killClientByFT(nc); exit; end;
-  if (enet_peer_send(nc.Peer, NET_CHAN_DOWNLOAD_EX, pkt) <> 0) then begin killClientByFT(nc); exit; end;
+  if (enet_peer_send(nc.Peer, NET_CHAN_DOWNLOAD, pkt) <> 0) then begin killClientByFT(nc); exit; end;
   result := true;
 end;
 
@@ -401,7 +392,7 @@ begin
   if (m.CurSize < 1) then exit;
   pkt := enet_packet_create(m.Data, m.CurSize, ENET_PACKET_FLAG_RELIABLE);
   if not Assigned(pkt) then exit;
-  if (enet_peer_send(NetPeer, NET_CHAN_DOWNLOAD_EX, pkt) <> 0) then exit;
+  if (enet_peer_send(NetPeer, NET_CHAN_DOWNLOAD, pkt) <> 0) then exit;
   result := true;
 end;
 
@@ -814,7 +805,7 @@ begin
           ENET_EVENT_TYPE_RECEIVE:
             begin
               freePacket := true;
-              if (ev.channelID <> NET_CHAN_DOWNLOAD_EX) then
+              if (ev.channelID <> NET_CHAN_DOWNLOAD) then
               begin
                 //e_LogWritefln('g_Net_Wait_MapInfo: skip message from non-transfer channel', []);
                 freePacket := false;
@@ -863,7 +854,7 @@ begin
                   rc := msg.ReadLongInt();
                   if (rc < 0) or (rc > 1024) then
                   begin
-                    e_LogWritefln('g_Net_Wait_Event: invalid number of map external resources (%d)', [rc]);
+                    e_LogWritefln('g_Net_Wait_MapInfo: invalid number of map external resources (%d)', [rc]);
                     Result := -1;
                     exit;
                   end;
@@ -897,7 +888,7 @@ begin
                 end
                 else
                 begin
-                  e_LogWritefln('g_Net_Wait_Event: invalid server packet type', []);
+                  e_LogWritefln('g_Net_Wait_MapInfo: invalid server packet type', []);
                   Result := -1;
                   exit;
                 end;
@@ -919,7 +910,8 @@ begin
         end;
         if (freePacket) then begin freePacket := false; enet_packet_destroy(ev.packet); end;
       end;
-      ProcessLoading();
+
+      ProcessLoading(False);
       if g_Net_UserRequestExit() then
       begin
         g_Console_Add(_lc[I_NET_MSG_ERROR] + _lc[I_NET_ERR_CONN] + ' user abort', True);
@@ -995,9 +987,9 @@ begin
           ENET_EVENT_TYPE_RECEIVE:
             begin
               freePacket := true;
-              if (ev.channelID <> NET_CHAN_DOWNLOAD_EX) then
+              if (ev.channelID <> NET_CHAN_DOWNLOAD) then
               begin
-                //e_LogWriteln('g_Net_Wait_Event: skip message from non-transfer channel');
+                //e_LogWriteln('g_Net_RequestResFileInfo: skip message from non-transfer channel');
                 freePacket := false;
                 g_Net_Client_HandlePacket(ev.packet, g_Net_ClientLightMsgHandler);
                 if (g_Res_received_map_start < 0) then begin result := -666; exit; end;
@@ -1007,7 +999,7 @@ begin
                 ett := getNewTimeoutEnd();
                 if (ev.packet.dataLength < 1) then
                 begin
-                  e_LogWriteln('g_Net_Wait_Event: invalid server packet (no data)');
+                  e_LogWriteln('g_Net_RequestResFileInfo: invalid server packet (no data)');
                   Result := -1;
                   exit;
                 end;
@@ -1067,7 +1059,8 @@ begin
         end;
         if (freePacket) then begin freePacket := false; enet_packet_destroy(ev.packet); end;
       end;
-      ProcessLoading();
+
+      ProcessLoading(False);
       if g_Net_UserRequestExit() then
       begin
         g_Console_Add(_lc[I_NET_MSG_ERROR] + _lc[I_NET_ERR_CONN] + ' user abort', True);
@@ -1179,9 +1172,9 @@ begin
           ENET_EVENT_TYPE_RECEIVE:
             begin
               freePacket := true;
-              if (ev.channelID <> NET_CHAN_DOWNLOAD_EX) then
+              if (ev.channelID <> NET_CHAN_DOWNLOAD) then
               begin
-                //e_LogWritefln('g_Net_Wait_Event: skip message from non-transfer channel', []);
+                //e_LogWritefln('g_Net_ReceiveResourceFile: skip message from non-transfer channel', []);
                 freePacket := false;
                 g_Net_Client_HandlePacket(ev.packet, g_Net_ClientLightMsgHandler);
                 if (g_Res_received_map_start < 0) then begin result := -666; exit; end;
@@ -1266,7 +1259,8 @@ begin
         end;
         if (freePacket) then begin freePacket := false; enet_packet_destroy(ev.packet); end;
       end;
-      ProcessLoading();
+
+      ProcessLoading(False);
       if g_Net_UserRequestExit() then
       begin
         g_Console_Add(_lc[I_NET_MSG_ERROR] + _lc[I_NET_ERR_CONN] + ' user abort', True);
@@ -1387,19 +1381,11 @@ var
   I: Integer;
 begin
   F := 0;
-  Chan := NET_CHAN_GAME;
+  Chan := NET_CHAN_UNRELIABLE;
 
   if NetMode = NET_SERVER then
     for T := NET_UNRELIABLE to NET_RELIABLE do
     begin
-      if NetBuf[T].CurSize > 0 then
-      begin
-        P := enet_packet_create(NetBuf[T].Data, NetBuf[T].CurSize, F);
-        if not Assigned(P) then continue;
-        enet_host_broadcast(NetHost, Chan, P);
-        NetBuf[T].Clear();
-      end;
-
       for I := Low(NetClients) to High(NetClients) do
       begin
         if not NetClients[I].Used then continue;
@@ -1412,7 +1398,7 @@ begin
 
       // next and last iteration is always RELIABLE
       F := LongWord(ENET_PACKET_FLAG_RELIABLE);
-      Chan := NET_CHAN_IMPORTANT;
+      Chan := NET_CHAN_RELIABLE;
     end
   else if NetMode = NET_CLIENT then
     for T := NET_UNRELIABLE to NET_RELIABLE do
@@ -1426,7 +1412,7 @@ begin
       end;
       // next and last iteration is always RELIABLE
       F := LongWord(ENET_PACKET_FLAG_RELIABLE);
-      Chan := NET_CHAN_IMPORTANT;
+      Chan := NET_CHAN_RELIABLE;
     end;
 end;
 
@@ -1515,7 +1501,7 @@ begin
   NetAddr.host := IPAddr;
   NetAddr.port := Port;
 
-  NetHost := enet_host_create(@NetAddr, NET_MAXCLIENTS, NET_CHANS, 0, 0);
+  NetHost := enet_host_create(@NetAddr, NET_MAXCLIENTS, NET_CHANNELS, 0, 0);
 
   if (NetHost = nil) then
   begin
@@ -1596,14 +1582,13 @@ begin
 end;
 
 
-procedure g_Net_Host_Send(ID: Integer; Reliable: Boolean; Chan: Byte = NET_CHAN_GAME);
+procedure g_Net_Host_Send(ID: Integer; Reliable: Boolean);
 var
   T: Integer;
 begin
-  if (Reliable) then
-    T := NET_RELIABLE
-  else
-    T := NET_UNRELIABLE;
+  if Reliable
+    then T := NET_RELIABLE
+    else T := NET_UNRELIABLE;
 
   if (ID >= 0) then
   begin
@@ -1615,9 +1600,15 @@ begin
   end
   else
   begin
-    // write size first
-    NetBuf[T].Write(Integer(NetOut.CurSize));
-    NetBuf[T].Write(NetOut);
+    for ID := Low(NetClients) to High(NetClients) do
+    begin
+      if NetClients[ID].Used then
+      begin
+        // write size first
+        NetClients[ID].NetOut[T].Write(Integer(NetOut.CurSize));
+        NetClients[ID].NetOut[T].Write(NetOut);
+      end;
+    end;
   end;
 
   if NetDump then g_Net_DumpSendBuffer();
@@ -1662,6 +1653,7 @@ begin
   TC^.AuthTime := 0;
   TC^.MsgTime := 0;
   TC^.RequestedFullUpdate := False;
+  TC^.FullUpdateSent := False;
   TC^.WaitForFirstSpawn := False;
   TC^.NetOut[NET_UNRELIABLE].Free();
   TC^.NetOut[NET_RELIABLE].Free();
@@ -1672,6 +1664,20 @@ begin
   if NetUseMaster then g_Net_Slist_ServerPlayerLeaves();
 end;
 
+procedure g_Net_Host_Kick(ID: Integer; Reason: enet_uint32);
+var
+  Peer: pENetPeer;
+  TC: pTNetClient;
+begin
+  TC := @NetClients[ID];
+  if (TC <> nil) and TC^.Used and (TC^.Peer <> nil) then
+  begin
+    Peer := TC^.Peer;
+    g_Net_Host_Disconnect_Client(ID);
+    enet_peer_disconnect(Peer, Reason);
+  end;
+end;
+
 procedure g_Net_Host_CheckPings();
 var
   ClAddr: ENetAddress;
@@ -1778,10 +1784,7 @@ begin
             _lc[I_NET_DISC_PROTOCOL]);
           e_WriteLog('NET: Connection request from ' + IP + ' rejected: version mismatch',
             TMsgType.Notify);
-          NetEvent.peer^.data := GetMemory(SizeOf(Byte));
-          Byte(NetEvent.peer^.data^) := 255;
           enet_peer_disconnect(NetEvent.peer, NET_DISC_PROTOCOL);
-          enet_host_flush(NetHost);
           Exit;
         end;
 
@@ -1791,10 +1794,7 @@ begin
             _lc[I_NET_DISC_BAN]);
           e_WriteLog('NET: Connection request from ' + IP + ' rejected: banned',
             TMsgType.Notify);
-          NetEvent.peer^.data := GetMemory(SizeOf(Byte));
-          Byte(NetEvent.peer^.data^) := 255;
           enet_peer_disconnect(NetEvent.Peer, NET_DISC_BAN);
-          enet_host_flush(NetHost);
           Exit;
         end;
 
@@ -1806,10 +1806,7 @@ begin
             _lc[I_NET_DISC_FULL]);
           e_WriteLog('NET: Connection request from ' + IP + ' rejected: server full',
             TMsgType.Notify);
-          NetEvent.Peer^.data := GetMemory(SizeOf(Byte));
-          Byte(NetEvent.peer^.data^) := 255;
           enet_peer_disconnect(NetEvent.peer, NET_DISC_FULL);
-          enet_host_flush(NetHost);
           Exit;
         end;
 
@@ -1841,12 +1838,14 @@ begin
       ENET_EVENT_TYPE_RECEIVE:
       begin
         //e_LogWritefln('RECEIVE: chan=%u', [NetEvent.channelID]);
-        if (NetEvent.channelID = NET_CHAN_DOWNLOAD_EX) then
+        if (NetEvent.channelID = NET_CHAN_DOWNLOAD) then
         begin
           ProcessDownloadExPacket();
         end
         else
         begin
+          if NetEvent.peer^.data = nil then Exit;
+
           ID := Byte(NetEvent.peer^.data^);
           if ID > High(NetClients) then Exit;
           TC := @NetClients[ID];
@@ -1861,9 +1860,12 @@ begin
 
       ENET_EVENT_TYPE_DISCONNECT:
       begin
-        ID := Byte(NetEvent.peer^.data^);
-        if ID > High(NetClients) then Exit;
-        g_Net_Host_Disconnect_Client(ID);
+        if NetEvent.peer^.data <> nil then
+        begin
+          ID := Byte(NetEvent.peer^.data^);
+          if ID > High(NetClients) then Exit;
+          g_Net_Host_Disconnect_Client(ID);
+        end;
       end;
     end;
   end;
@@ -1922,14 +1924,13 @@ begin
   e_WriteLog('NET: Disconnected', TMsgType.Notify);
 end;
 
-procedure g_Net_Client_Send(Reliable: Boolean; Chan: Byte = NET_CHAN_GAME);
+procedure g_Net_Client_Send(Reliable: Boolean);
 var
   T: Integer;
 begin
-  if (Reliable) then
-    T := NET_RELIABLE
-  else
-    T := NET_UNRELIABLE;
+  if Reliable
+    then T := NET_RELIABLE
+    else T := NET_UNRELIABLE;
 
   // write size first
   NetBuf[T].Write(Integer(NetOut.CurSize));
@@ -1947,7 +1948,6 @@ begin
     case NetEvent.kind of
       ENET_EVENT_TYPE_RECEIVE:
       begin
-        if (NetEvent.channelID = NET_CHAN_DOWNLOAD_EX) then continue; // ignore all download packets, they're processed by separate code
         if NetDump then g_Net_DumpRecvBuffer(NetEvent.packet^.data, NetEvent.packet^.dataLength);
         g_Net_Client_HandlePacket(NetEvent.packet, g_Net_ClientMsgHandler);
       end;
@@ -1961,28 +1961,6 @@ begin
   end
 end;
 
-procedure g_Net_Client_UpdateWhileLoading();
-begin
-  while (enet_host_service(NetHost, @NetEvent, 0) > 0) do
-  begin
-    case NetEvent.kind of
-      ENET_EVENT_TYPE_RECEIVE:
-      begin
-        if (NetEvent.channelID = NET_CHAN_DOWNLOAD_EX) then continue; // ignore all download packets, they're processed by separate code
-        if NetDump then g_Net_DumpRecvBuffer(NetEvent.packet^.data, NetEvent.packet^.dataLength);
-        g_Net_Client_HandlePacket(NetEvent.packet, g_Net_ClientLightMsgHandler);
-      end;
-
-      ENET_EVENT_TYPE_DISCONNECT:
-      begin
-        g_Net_Disconnect(True);
-        Exit;
-      end;
-    end;
-  end;
-  g_Net_Flush();
-end;
-
 function g_Net_Connect(IP: string; Port: enet_uint16): Boolean;
 var
   OuterLoop: Boolean;
@@ -2011,7 +1989,7 @@ begin
       NetInitDone := True;
   end;
 
-  NetHost := enet_host_create(nil, 1, NET_CHANS, 0, 0);
+  NetHost := enet_host_create(nil, 1, NET_CHANNELS, 0, 0);
 
   if (NetHost = nil) then
   begin
@@ -2024,7 +2002,7 @@ begin
   enet_address_set_host(@NetAddr, PChar(Addr(IP[1])));
   NetAddr.port := Port;
 
-  NetPeer := enet_host_connect(NetHost, @NetAddr, NET_CHANS, NET_PROTOCOL_VER);
+  NetPeer := enet_host_connect(NetHost, @NetAddr, NET_CHANNELS, NET_PROTOCOL_VER);
 
   if (NetPeer = nil) then
   begin
@@ -2065,8 +2043,7 @@ begin
       g_Console_Add(Format(_lc[I_NET_MSG_PORTS], [Integer(Port), Integer(NET_PING_PORT)]), True);
     end;
 
-    ProcessLoading(true);
-
+    ProcessLoading(True);
     if e_KeyPressed(IK_SPACE) or e_KeyPressed(IK_ESCAPE) or e_KeyPressed(VK_ESCAPE) or
        e_KeyPressed(JOY0_JUMP) or e_KeyPressed(JOY1_JUMP) or e_KeyPressed(JOY2_JUMP) or e_KeyPressed(JOY3_JUMP) then
       OuterLoop := False;
@@ -2154,35 +2131,6 @@ begin
     end;
 end;
 
-procedure g_Net_SendData(Data: AByte; peer: pENetPeer; Reliable: Boolean; Chan: Byte = NET_CHAN_DOWNLOAD);
-var
-  P: pENetPacket;
-  F: enet_uint32;
-  dataLength: Cardinal;
-begin
-  dataLength := Length(Data);
-
-  if (Reliable) then
-    F := LongWord(ENET_PACKET_FLAG_RELIABLE)
-  else
-    F := 0;
-
-  if (peer <> nil) then
-  begin
-    P := enet_packet_create(@Data[0], dataLength, F);
-    if not Assigned(P) then Exit;
-    enet_peer_send(peer, Chan, P);
-  end
-  else
-  begin
-    P := enet_packet_create(@Data[0], dataLength, F);
-    if not Assigned(P) then Exit;
-    enet_host_broadcast(NetHost, Chan, P);
-  end;
-
-  enet_host_flush(NetHost);
-end;
-
 function g_Net_IsHostBanned(IP: LongWord; Perm: Boolean = False): Boolean;
 var
   I: Integer;
@@ -2324,7 +2272,7 @@ begin
   begin
     s := '#' + IntToStr(C^.ID); // can't be arsed
     g_Net_BanHost(C^.Peer^.address.host, NetAutoBanPerm);
-    enet_peer_disconnect(C^.Peer, NET_DISC_BAN);
+    g_Net_Host_Kick(C^.ID, NET_DISC_BAN);
     g_Console_Add(Format(_lc[I_PLAYER_BAN], [s]));
     MH_SEND_GameEvent(NET_EV_PLAYER_BAN, 0, s);
     g_Net_Slist_ServerPlayerLeaves();
@@ -2534,7 +2482,7 @@ begin
                 if b > NetMaxClients then
                 begin
                   s := g_Player_Get(NetClients[a].Player).Name;
-                  enet_peer_disconnect(NetClients[a].Peer, NET_DISC_FULL);
+                  g_Net_Host_Kick(NetClients[a].ID, NET_DISC_FULL);
                   g_Console_Add(Format(_lc[I_PLAYER_KICK], [s]));
                   MH_SEND_GameEvent(NET_EV_PLAYER_KICK, 0, s);
                 end;