1/* (c) Magnus Auvinen. See licence.txt in the root of the distribution for more information. */
2/* If you are missing that file, acquire a complete release at teeworlds.com. */
3#ifndef ENGINE_SERVER_H
4#define ENGINE_SERVER_H
5
6#include "kernel.h"
7#include "message.h"
8
9#include <base/hash.h>
10#include <base/math.h>
11#include <base/system.h>
12
13#include <engine/shared/jsonwriter.h>
14#include <engine/shared/protocol.h>
15
16#include <generated/protocol.h>
17#include <generated/protocol7.h>
18#include <generated/protocolglue.h>
19
20#include <array>
21#include <optional>
22#include <type_traits>
23
24struct CAntibotRoundData;
25
26// When recording a demo on the server, the ClientId -1 is used
27enum
28{
29 SERVER_DEMO_CLIENT = -1
30};
31
32class IServer : public IInterface
33{
34 MACRO_INTERFACE("server")
35protected:
36 int m_CurrentGameTick;
37
38public:
39 /*
40 Structure: CClientInfo
41 */
42 struct CClientInfo
43 {
44 const char *m_pName;
45 int m_Latency;
46 bool m_GotDDNetVersion;
47 int m_DDNetVersion;
48 const char *m_pDDNetVersionStr;
49 const CUuid *m_pConnectionId;
50 };
51
52 int Tick() const { return m_CurrentGameTick; }
53 int TickSpeed() const { return SERVER_TICK_SPEED; }
54
55 virtual int Port() const = 0;
56 virtual int MaxClients() const = 0;
57 virtual int ClientCount() const = 0;
58 virtual int DistinctClientCount() const = 0;
59 virtual const char *ClientName(int ClientId) const = 0;
60 virtual const char *ClientClan(int ClientId) const = 0;
61 virtual int ClientCountry(int ClientId) const = 0;
62 virtual bool ClientSlotEmpty(int ClientId) const = 0;
63 virtual bool ClientIngame(int ClientId) const = 0;
64 virtual bool GetClientInfo(int ClientId, CClientInfo *pInfo) const = 0;
65 virtual void SetClientDDNetVersion(int ClientId, int DDNetVersion) = 0;
66 virtual const NETADDR *ClientAddr(int ClientId) const = 0;
67 virtual const std::array<char, NETADDR_MAXSTRSIZE> &ClientAddrStringImpl(int ClientId, bool IncludePort) const = 0;
68 const char *ClientAddrString(int ClientId, bool IncludePort) const { return ClientAddrStringImpl(ClientId, IncludePort).data(); }
69
70 /**
71 * Returns the version of the client with the given client ID.
72 *
73 * @param ClientId the client Id, which must be between 0 and
74 * MAX_CLIENTS - 1, or equal to SERVER_DEMO_CLIENT for server demos.
75 *
76 * @return The version of the client with the given client ID.
77 * For server demos this is always the latest client version.
78 * On errors, VERSION_NONE is returned.
79 */
80 virtual int GetClientVersion(int ClientId) const = 0;
81 virtual int SendMsg(CMsgPacker *pMsg, int Flags, int ClientId) = 0;
82
83 template<class T, typename std::enable_if<!protocol7::is_sixup<T>::value, int>::type = 0>
84 int SendPackMsg(const T *pMsg, int Flags, int ClientId)
85 {
86 int Result = 0;
87 if(ClientId == -1)
88 {
89 for(int i = 0; i < MaxClients(); i++)
90 if(ClientIngame(ClientId: i))
91 Result = SendPackMsgTranslate(pMsg, Flags, i);
92 }
93 else
94 {
95 Result = SendPackMsgTranslate(pMsg, Flags, ClientId);
96 }
97 return Result;
98 }
99
100 template<class T, typename std::enable_if<protocol7::is_sixup<T>::value, int>::type = 1>
101 int SendPackMsg(const T *pMsg, int Flags, int ClientId)
102 {
103 int Result = 0;
104 if(ClientId == -1)
105 {
106 for(int i = 0; i < MaxClients(); i++)
107 if(ClientIngame(ClientId: i) && IsSixup(ClientId: i))
108 Result = SendPackMsgOne(pMsg, Flags, i);
109 }
110 else if(IsSixup(ClientId))
111 Result = SendPackMsgOne(pMsg, Flags, ClientId);
112
113 return Result;
114 }
115
116 template<class T>
117 int SendPackMsgTranslate(const T *pMsg, int Flags, int ClientId)
118 {
119 return SendPackMsgOne(pMsg, Flags, ClientId);
120 }
121
122 int SendPackMsgTranslate(const CNetMsg_Sv_Emoticon *pMsg, int Flags, int ClientId)
123 {
124 CNetMsg_Sv_Emoticon MsgCopy;
125 mem_copy(dest: &MsgCopy, source: pMsg, size: sizeof(MsgCopy));
126 return Translate(Target&: MsgCopy.m_ClientId, Client: ClientId) && SendPackMsgOne(pMsg: &MsgCopy, Flags, ClientId);
127 }
128
129 int SendPackMsgTranslate(const CNetMsg_Sv_Chat *pMsg, int Flags, int ClientId)
130 {
131 CNetMsg_Sv_Chat MsgCopy;
132 mem_copy(dest: &MsgCopy, source: pMsg, size: sizeof(MsgCopy));
133
134 char aBuf[1000];
135 if(MsgCopy.m_ClientId >= 0 && !Translate(Target&: MsgCopy.m_ClientId, Client: ClientId))
136 {
137 str_format(buffer: aBuf, buffer_size: sizeof(aBuf), format: "%s: %s", ClientName(ClientId: MsgCopy.m_ClientId), MsgCopy.m_pMessage);
138 MsgCopy.m_pMessage = aBuf;
139 MsgCopy.m_ClientId = VANILLA_MAX_CLIENTS - 1;
140 }
141
142 if(IsSixup(ClientId))
143 {
144 protocol7::CNetMsg_Sv_Chat Msg7;
145 Msg7.m_ClientId = MsgCopy.m_ClientId;
146 Msg7.m_pMessage = MsgCopy.m_pMessage;
147 Msg7.m_Mode = MsgCopy.m_Team > 0 ? protocol7::CHAT_TEAM : protocol7::CHAT_ALL;
148 Msg7.m_TargetId = -1;
149 return SendPackMsgOne(pMsg: &Msg7, Flags, ClientId);
150 }
151
152 return SendPackMsgOne(pMsg: &MsgCopy, Flags, ClientId);
153 }
154
155 int SendPackMsgTranslate(const CNetMsg_Sv_KillMsg *pMsg, int Flags, int ClientId)
156 {
157 CNetMsg_Sv_KillMsg MsgCopy;
158 mem_copy(dest: &MsgCopy, source: pMsg, size: sizeof(MsgCopy));
159 if(!Translate(Target&: MsgCopy.m_Victim, Client: ClientId))
160 return 0;
161 if(!Translate(Target&: MsgCopy.m_Killer, Client: ClientId))
162 MsgCopy.m_Killer = MsgCopy.m_Victim;
163 return SendPackMsgOne(pMsg: &MsgCopy, Flags, ClientId);
164 }
165
166 int SendPackMsgTranslate(const CNetMsg_Sv_RaceFinish *pMsg, int Flags, int ClientId)
167 {
168 if(IsSixup(ClientId))
169 {
170 protocol7::CNetMsg_Sv_RaceFinish Msg7;
171 Msg7.m_ClientId = pMsg->m_ClientId;
172 Msg7.m_Diff = pMsg->m_Diff;
173 Msg7.m_Time = pMsg->m_Time;
174 Msg7.m_RecordPersonal = pMsg->m_RecordPersonal;
175 Msg7.m_RecordServer = pMsg->m_RecordServer;
176 return SendPackMsgOne(pMsg: &Msg7, Flags, ClientId);
177 }
178 return SendPackMsgOne(pMsg, Flags, ClientId);
179 }
180
181 template<class T>
182 int SendPackMsgOne(const T *pMsg, int Flags, int ClientId)
183 {
184 dbg_assert(ClientId != -1, "SendPackMsgOne called with -1");
185 CMsgPacker Packer(T::ms_MsgId, false, protocol7::is_sixup<T>::value);
186
187 if(pMsg->Pack(&Packer))
188 return -1;
189 return SendMsg(pMsg: &Packer, Flags, ClientId);
190 }
191
192 bool Translate(int &Target, int Client)
193 {
194 if(IsSixup(ClientId: Client))
195 return true;
196 if(GetClientVersion(ClientId: Client) >= VERSION_DDNET_OLD)
197 return true;
198 int *pMap = GetIdMap(ClientId: Client);
199 bool Found = false;
200 for(int i = 0; i < VANILLA_MAX_CLIENTS; i++)
201 {
202 if(Target == pMap[i])
203 {
204 Target = i;
205 Found = true;
206 break;
207 }
208 }
209 return Found;
210 }
211
212 bool ReverseTranslate(int &Target, int Client)
213 {
214 if(IsSixup(ClientId: Client))
215 return true;
216 if(GetClientVersion(ClientId: Client) >= VERSION_DDNET_OLD)
217 return true;
218 Target = std::clamp(val: Target, lo: 0, hi: VANILLA_MAX_CLIENTS - 1);
219 int *pMap = GetIdMap(ClientId: Client);
220 if(pMap[Target] == -1)
221 return false;
222 Target = pMap[Target];
223 return true;
224 }
225
226 virtual void GetMapInfo(char *pMapName, int MapNameSize, int *pMapSize, SHA256_DIGEST *pSha256, int *pMapCrc) = 0;
227
228 virtual bool WouldClientNameChange(int ClientId, const char *pNameRequest) = 0;
229 virtual bool WouldClientClanChange(int ClientId, const char *pClanRequest) = 0;
230 virtual void SetClientName(int ClientId, const char *pName) = 0;
231 virtual void SetClientClan(int ClientId, const char *pClan) = 0;
232 virtual void SetClientCountry(int ClientId, int Country) = 0;
233 virtual void SetClientScore(int ClientId, std::optional<int> Score) = 0;
234 virtual void SetClientFlags(int ClientId, int Flags) = 0;
235
236 virtual int SnapNewId() = 0;
237 virtual void SnapFreeId(int Id) = 0;
238 virtual void *SnapNewItem(int Type, int Id, int Size) = 0;
239
240 template<typename T>
241 T *SnapNewItem(int Id)
242 {
243 const int Type = protocol7::is_sixup<T>::value ? -T::ms_MsgId : T::ms_MsgId;
244 return static_cast<T *>(SnapNewItem(Type, Id, Size: sizeof(T)));
245 }
246
247 virtual void SnapSetStaticsize(int ItemType, int Size) = 0;
248
249 enum
250 {
251 RCON_CID_SERV = -1,
252 RCON_CID_VOTE = -2,
253 };
254 virtual void SetRconCid(int ClientId) = 0;
255 virtual int GetAuthedState(int ClientId) const = 0;
256 virtual bool IsRconAuthed(int ClientId) const = 0;
257 virtual bool IsRconAuthedAdmin(int ClientId) const = 0;
258 virtual const char *GetAuthName(int ClientId) const = 0;
259 virtual bool HasAuthHidden(int ClientId) const = 0;
260 virtual void Kick(int ClientId, const char *pReason) = 0;
261 virtual void Ban(int ClientId, int Seconds, const char *pReason, bool VerbatimReason) = 0;
262 virtual void RedirectClient(int ClientId, int Port) = 0;
263 virtual void ChangeMap(const char *pMap) = 0;
264 virtual void ReloadMap() = 0;
265
266 virtual void DemoRecorder_HandleAutoStart() = 0;
267
268 // DDRace
269
270 virtual void SaveDemo(int ClientId, float Time) = 0;
271 virtual void StartRecord(int ClientId) = 0;
272 virtual void StopRecord(int ClientId) = 0;
273 virtual bool IsRecording(int ClientId) = 0;
274 virtual void StopDemos() = 0;
275
276 virtual int *GetIdMap(int ClientId) = 0;
277
278 virtual bool DnsblWhite(int ClientId) = 0;
279 virtual bool DnsblPending(int ClientId) = 0;
280 virtual bool DnsblBlack(int ClientId) = 0;
281 virtual const char *GetAnnouncementLine() = 0;
282 virtual bool ClientPrevIngame(int ClientId) = 0;
283 virtual const char *GetNetErrorString(int ClientId) = 0;
284 virtual void ResetNetErrorString(int ClientId) = 0;
285 virtual bool SetTimedOut(int ClientId, int OrigId) = 0;
286 virtual void SetTimeoutProtected(int ClientId) = 0;
287
288 virtual void SetErrorShutdown(const char *pReason) = 0;
289 virtual void ExpireServerInfo() = 0;
290
291 virtual void FillAntibot(CAntibotRoundData *pData) = 0;
292
293 virtual void SendMsgRaw(int ClientId, const void *pData, int Size, int Flags) = 0;
294
295 virtual const char *GetMapName() const = 0;
296
297 virtual bool IsSixup(int ClientId) const = 0;
298};
299
300class IGameServer : public IInterface
301{
302 MACRO_INTERFACE("gameserver")
303protected:
304public:
305 // `pPersistentData` may be null if this is the first time `IGameServer`
306 // is instantiated.
307 virtual void OnInit(const void *pPersistentData) = 0;
308 virtual void OnConsoleInit() = 0;
309 // Returns `true` if map change accepted.
310 [[nodiscard]] virtual bool OnMapChange(char *pNewMapName, int MapNameSize) = 0;
311 // `pPersistentData` may be null if this is the last time `IGameServer`
312 // is destroyed.
313 virtual void OnShutdown(void *pPersistentData) = 0;
314
315 virtual void OnTick() = 0;
316
317 // Snap for a specific client.
318 //
319 // GlobalSnap is true when sending snapshots to all clients,
320 // otherwise only forced high bandwidth clients would receive snap.
321 virtual void OnSnap(int ClientId, bool GlobalSnap) = 0;
322
323 // Called after sending snapshots to all clients.
324 //
325 // Note if any client has force high bandwidth enabled,
326 // this will not be called when only sending snapshots to these clients.
327 virtual void OnPostGlobalSnap() = 0;
328
329 virtual void OnMessage(int MsgId, CUnpacker *pUnpacker, int ClientId) = 0;
330
331 // Called before map reload, for any data that the game wants to
332 // persist to the next map.
333 //
334 // Has the size of the return value of `PersistentClientDataSize()`.
335 //
336 // Returns whether the game should be supplied with the data when the
337 // client connects for the next map.
338 virtual bool OnClientDataPersist(int ClientId, void *pData) = 0;
339
340 // Called when a client connects.
341 //
342 // If it is reconnecting to the game after a map change, the
343 // `pPersistentData` point is nonnull and contains the data the game
344 // previously stored.
345 virtual void OnClientConnected(int ClientId, void *pPersistentData) = 0;
346
347 virtual void OnClientEnter(int ClientId) = 0;
348 virtual void OnClientDrop(int ClientId, const char *pReason) = 0;
349 virtual void OnClientPrepareInput(int ClientId, void *pInput) = 0;
350 virtual void OnClientDirectInput(int ClientId, const void *pInput) = 0;
351 virtual void OnClientPredictedInput(int ClientId, const void *pInput) = 0;
352 virtual void OnClientPredictedEarlyInput(int ClientId, const void *pInput) = 0;
353
354 virtual void PreInputClients(int ClientId, bool *pClients) = 0;
355
356 virtual bool IsClientReady(int ClientId) const = 0;
357 virtual bool IsClientPlayer(int ClientId) const = 0;
358 virtual bool IsClientHighBandwidth(int ClientId) const = 0;
359
360 virtual int PersistentDataSize() const = 0;
361 virtual int PersistentClientDataSize() const = 0;
362
363 virtual CUuid GameUuid() const = 0;
364 virtual const char *GameType() const = 0;
365 virtual const char *Version() const = 0;
366 virtual const char *NetVersion() const = 0;
367
368 virtual CNetObjHandler *GetNetObjHandler() = 0;
369 virtual protocol7::CNetObjHandler *GetNetObjHandler7() = 0;
370
371 // DDRace
372
373 virtual void OnPreTickTeehistorian() = 0;
374
375 virtual void OnSetAuthed(int ClientId, int Level) = 0;
376 virtual bool PlayerExists(int ClientId) const = 0;
377
378 virtual void TeehistorianRecordAntibot(const void *pData, int DataSize) = 0;
379 virtual void TeehistorianRecordPlayerJoin(int ClientId, bool Sixup) = 0;
380 virtual void TeehistorianRecordPlayerDrop(int ClientId, const char *pReason) = 0;
381 virtual void TeehistorianRecordPlayerRejoin(int ClientId) = 0;
382 virtual void TeehistorianRecordPlayerName(int ClientId, const char *pName) = 0;
383 virtual void TeehistorianRecordPlayerFinish(int ClientId, int TimeTicks) = 0;
384 virtual void TeehistorianRecordTeamFinish(int TeamId, int TimeTicks) = 0;
385 virtual void TeehistorianRecordAuthLogin(int ClientId, int Level, const char *pAuthName) = 0;
386
387 virtual void FillAntibot(CAntibotRoundData *pData) = 0;
388
389 /**
390 * Used to report custom player info to the master server.
391 *
392 * @param pJsonWriter A pointer to a @link CJsonWriter @endlink to which the custom data will written.
393 * @param ClientId The client ID.
394 */
395 virtual void OnUpdatePlayerServerInfo(CJsonWriter *pJsonWriter, int ClientId) = 0;
396};
397
398extern IGameServer *CreateGameServer();
399#endif
400