ddnet/src/game/server/teehistorian.cpp

673 lines
16 KiB
C++
Raw Normal View History

#include "teehistorian.h"
#include <engine/shared/config.h>
2018-12-12 08:59:42 +00:00
#include <engine/shared/json.h>
#include <engine/shared/snapshot.h>
#include <game/gamecore.h>
static const char TEEHISTORIAN_NAME[] = "teehistorian@ddnet.tw";
static const CUuid TEEHISTORIAN_UUID = CalculateUuid(TEEHISTORIAN_NAME);
static const char TEEHISTORIAN_VERSION[] = "2";
#define UUID(id, name) static const CUuid UUID_##id = CalculateUuid(name);
2018-01-11 15:01:13 +00:00
#include <engine/shared/teehistorian_ex_chunks.h>
#undef UUID
enum
{
TEEHISTORIAN_NONE,
TEEHISTORIAN_FINISH,
TEEHISTORIAN_TICK_SKIP,
TEEHISTORIAN_PLAYER_NEW,
TEEHISTORIAN_PLAYER_OLD,
TEEHISTORIAN_INPUT_DIFF,
TEEHISTORIAN_INPUT_NEW,
TEEHISTORIAN_MESSAGE,
TEEHISTORIAN_JOIN,
TEEHISTORIAN_DROP,
TEEHISTORIAN_CONSOLE_COMMAND,
TEEHISTORIAN_EX,
};
CTeeHistorian::CTeeHistorian()
{
m_State = STATE_START;
m_pfnWriteCallback = 0;
m_pWriteCallbackUserdata = 0;
}
void CTeeHistorian::Reset(const CGameInfo *pGameInfo, WRITE_CALLBACK pfnWriteCallback, void *pUser)
{
dbg_assert(m_State == STATE_START || m_State == STATE_BEFORE_TICK, "invalid teehistorian state");
m_Debug = 0;
m_Tick = 0;
m_LastWrittenTick = 0;
// Tick 0 is implicit at the start, game starts as tick 1.
m_TickWritten = true;
m_MaxClientID = MAX_CLIENTS;
// `m_PrevMaxClientID` is initialized in `BeginTick`
for(int i = 0; i < MAX_CLIENTS; i++)
{
m_aPrevPlayers[i].m_Alive = false;
m_aPrevPlayers[i].m_InputExists = false;
}
m_pfnWriteCallback = pfnWriteCallback;
m_pWriteCallbackUserdata = pUser;
WriteHeader(pGameInfo);
m_State = STATE_START;
}
void CTeeHistorian::WriteHeader(const CGameInfo *pGameInfo)
{
Write(&TEEHISTORIAN_UUID, sizeof(TEEHISTORIAN_UUID));
char aGameUuid[UUID_MAXSTRSIZE];
char aStartTime[128];
char aMapSha256[SHA256_MAXSTRSIZE];
FormatUuid(pGameInfo->m_GameUuid, aGameUuid, sizeof(aGameUuid));
str_timestamp_ex(pGameInfo->m_StartTime, aStartTime, sizeof(aStartTime), "%Y-%m-%dT%H:%M:%S%z");
sha256_str(pGameInfo->m_MapSha256, aMapSha256, sizeof(aMapSha256));
char aCommentBuffer[128];
char aServerVersionBuffer[128];
char aStartTimeBuffer[128];
char aServerNameBuffer[128];
char aGameTypeBuffer[128];
char aMapNameBuffer[128];
char aMapSha256Buffer[256];
2020-05-25 13:08:24 +00:00
char aPrngDescription[128];
char aJson[2048];
#define E(buf, str) EscapeJson(buf, sizeof(buf), str)
2020-05-25 13:08:24 +00:00
str_format(aJson, sizeof(aJson), "{\"comment\":\"%s\",\"version\":\"%s\",\"game_uuid\":\"%s\",\"server_version\":\"%s\",\"start_time\":\"%s\",\"server_name\":\"%s\",\"server_port\":\"%d\",\"game_type\":\"%s\",\"map_name\":\"%s\",\"map_size\":\"%d\",\"map_sha256\":\"%s\",\"map_crc\":\"%08x\",\"prng_description\":\"%s\",\"config\":{",
E(aCommentBuffer, TEEHISTORIAN_NAME),
TEEHISTORIAN_VERSION,
aGameUuid,
E(aServerVersionBuffer, pGameInfo->m_pServerVersion),
E(aStartTimeBuffer, aStartTime),
E(aServerNameBuffer, pGameInfo->m_pServerName),
pGameInfo->m_ServerPort,
E(aGameTypeBuffer, pGameInfo->m_pGameType),
E(aMapNameBuffer, pGameInfo->m_pMapName),
pGameInfo->m_MapSize,
E(aMapSha256Buffer, aMapSha256),
2020-05-25 13:08:24 +00:00
pGameInfo->m_MapCrc,
E(aPrngDescription, pGameInfo->m_pPrngDescription));
Write(aJson, str_length(aJson));
char aBuffer1[1024];
char aBuffer2[1024];
bool First = true;
#define MACRO_CONFIG_INT(Name, ScriptName, Def, Min, Max, Flags, Desc) \
if((Flags)&CFGFLAG_SERVER && !((Flags)&CFGFLAG_NONTEEHISTORIC) && pGameInfo->m_pConfig->m_##Name != (Def)) \
{ \
str_format(aJson, sizeof(aJson), "%s\"%s\":\"%d\"", \
First ? "" : ",", \
E(aBuffer1, #ScriptName), \
pGameInfo->m_pConfig->m_##Name); \
Write(aJson, str_length(aJson)); \
First = false; \
}
#define MACRO_CONFIG_COL(Name, ScriptName, Def, Save, Desc) MACRO_CONFIG_INT(Name, ScriptName, Def, 0, 0, Save, Desc)
2019-04-25 11:48:53 +00:00
#define MACRO_CONFIG_STR(Name, ScriptName, Len, Def, Flags, Desc) \
if((Flags)&CFGFLAG_SERVER && !((Flags)&CFGFLAG_NONTEEHISTORIC) && str_comp(pGameInfo->m_pConfig->m_##Name, (Def)) != 0) \
{ \
str_format(aJson, sizeof(aJson), "%s\"%s\":\"%s\"", \
First ? "" : ",", \
E(aBuffer1, #ScriptName), \
E(aBuffer2, pGameInfo->m_pConfig->m_##Name)); \
Write(aJson, str_length(aJson)); \
First = false; \
}
#include <engine/shared/config_variables.h>
#undef MACRO_CONFIG_INT
#undef MACRO_CONFIG_COL
#undef MACRO_CONFIG_STR
str_format(aJson, sizeof(aJson), "},\"tuning\":{");
Write(aJson, str_length(aJson));
First = true;
static const float TicksPerSecond = 50.0f;
#define MACRO_TUNING_PARAM(Name, ScriptName, Value, Description) \
if(pGameInfo->m_pTuning->m_##Name.Get() != (int)((Value)*100)) \
{ \
str_format(aJson, sizeof(aJson), "%s\"%s\":\"%d\"", \
First ? "" : ",", \
E(aBuffer1, #ScriptName), \
pGameInfo->m_pTuning->m_##Name.Get()); \
Write(aJson, str_length(aJson)); \
First = false; \
}
#include <game/tuning.h>
#undef MACRO_TUNING_PARAM
str_format(aJson, sizeof(aJson), "},\"uuids\":[");
Write(aJson, str_length(aJson));
for(int i = 0; i < pGameInfo->m_pUuids->NumUuids(); i++)
{
str_format(aJson, sizeof(aJson), "%s\"%s\"",
i == 0 ? "" : ",",
E(aBuffer1, pGameInfo->m_pUuids->GetName(OFFSET_UUID + i)));
Write(aJson, str_length(aJson));
}
str_format(aJson, sizeof(aJson), "]}");
Write(aJson, str_length(aJson));
Write("", 1); // Null termination.
}
void CTeeHistorian::WriteExtra(CUuid Uuid, const void *pData, int DataSize)
{
EnsureTickWritten();
CPacker Ex;
Ex.Reset();
Ex.AddInt(-TEEHISTORIAN_EX);
Ex.AddRaw(&Uuid, sizeof(Uuid));
Ex.AddInt(DataSize);
Write(Ex.Data(), Ex.Size());
Write(pData, DataSize);
}
void CTeeHistorian::BeginTick(int Tick)
{
dbg_assert(m_State == STATE_START || m_State == STATE_BEFORE_TICK, "invalid teehistorian state");
m_Tick = Tick;
m_TickWritten = false;
if(m_Debug > 1)
{
dbg_msg("teehistorian", "tick %d", Tick);
}
m_State = STATE_BEFORE_PLAYERS;
}
void CTeeHistorian::BeginPlayers()
{
dbg_assert(m_State == STATE_BEFORE_PLAYERS, "invalid teehistorian state");
m_PrevMaxClientID = m_MaxClientID;
m_MaxClientID = -1;
m_State = STATE_PLAYERS;
}
void CTeeHistorian::EnsureTickWrittenPlayerData(int ClientID)
{
dbg_assert(ClientID > m_MaxClientID, "invalid player data order");
m_MaxClientID = ClientID;
if(!m_TickWritten && (ClientID > m_PrevMaxClientID || m_LastWrittenTick + 1 != m_Tick))
{
WriteTick();
}
else
{
// Tick is implicit.
m_LastWrittenTick = m_Tick;
m_TickWritten = true;
}
}
void CTeeHistorian::RecordPlayer(int ClientID, const CNetObj_CharacterCore *pChar)
{
dbg_assert(m_State == STATE_PLAYERS, "invalid teehistorian state");
CPlayer *pPrev = &m_aPrevPlayers[ClientID];
if(!pPrev->m_Alive || pPrev->m_X != pChar->m_X || pPrev->m_Y != pChar->m_Y)
{
EnsureTickWrittenPlayerData(ClientID);
CPacker Buffer;
Buffer.Reset();
if(pPrev->m_Alive)
{
int dx = pChar->m_X - pPrev->m_X;
int dy = pChar->m_Y - pPrev->m_Y;
Buffer.AddInt(ClientID);
Buffer.AddInt(dx);
Buffer.AddInt(dy);
if(m_Debug)
{
dbg_msg("teehistorian", "diff cid=%d dx=%d dy=%d", ClientID, dx, dy);
}
}
else
{
int x = pChar->m_X;
int y = pChar->m_Y;
Buffer.AddInt(-TEEHISTORIAN_PLAYER_NEW);
Buffer.AddInt(ClientID);
Buffer.AddInt(x);
Buffer.AddInt(y);
if(m_Debug)
{
dbg_msg("teehistorian", "new cid=%d x=%d y=%d", ClientID, x, y);
}
}
Write(Buffer.Data(), Buffer.Size());
}
pPrev->m_X = pChar->m_X;
pPrev->m_Y = pChar->m_Y;
pPrev->m_Alive = true;
}
void CTeeHistorian::RecordDeadPlayer(int ClientID)
{
dbg_assert(m_State == STATE_PLAYERS, "invalid teehistorian state");
CPlayer *pPrev = &m_aPrevPlayers[ClientID];
if(pPrev->m_Alive)
{
EnsureTickWrittenPlayerData(ClientID);
CPacker Buffer;
Buffer.Reset();
Buffer.AddInt(-TEEHISTORIAN_PLAYER_OLD);
Buffer.AddInt(ClientID);
if(m_Debug)
{
dbg_msg("teehistorian", "old cid=%d", ClientID);
}
Write(Buffer.Data(), Buffer.Size());
}
pPrev->m_Alive = false;
}
void CTeeHistorian::Write(const void *pData, int DataSize)
{
m_pfnWriteCallback(pData, DataSize, m_pWriteCallbackUserdata);
}
void CTeeHistorian::EnsureTickWritten()
{
if(!m_TickWritten)
{
WriteTick();
}
}
void CTeeHistorian::WriteTick()
{
CPacker TickPacker;
TickPacker.Reset();
int dt = m_Tick - m_LastWrittenTick - 1;
TickPacker.AddInt(-TEEHISTORIAN_TICK_SKIP);
TickPacker.AddInt(dt);
if(m_Debug)
{
dbg_msg("teehistorian", "skip_ticks dt=%d", dt);
}
Write(TickPacker.Data(), TickPacker.Size());
m_TickWritten = true;
m_LastWrittenTick = m_Tick;
}
void CTeeHistorian::EndPlayers()
{
dbg_assert(m_State == STATE_PLAYERS, "invalid teehistorian state");
m_State = STATE_BEFORE_INPUTS;
}
void CTeeHistorian::BeginInputs()
{
dbg_assert(m_State == STATE_BEFORE_INPUTS, "invalid teehistorian state");
m_State = STATE_INPUTS;
}
void CTeeHistorian::RecordPlayerInput(int ClientID, const CNetObj_PlayerInput *pInput)
{
CPacker Buffer;
CPlayer *pPrev = &m_aPrevPlayers[ClientID];
CNetObj_PlayerInput DiffInput;
if(pPrev->m_InputExists)
{
if(mem_comp(&pPrev->m_Input, pInput, sizeof(pPrev->m_Input)) == 0)
{
return;
}
EnsureTickWritten();
Buffer.Reset();
Buffer.AddInt(-TEEHISTORIAN_INPUT_DIFF);
CSnapshotDelta::DiffItem((int *)&pPrev->m_Input, (int *)pInput, (int *)&DiffInput, sizeof(DiffInput) / sizeof(int));
if(m_Debug)
{
const int *pData = (const int *)&DiffInput;
dbg_msg("teehistorian", "diff_input cid=%d %d %d %d %d %d %d %d %d %d %d", ClientID,
pData[0], pData[1], pData[2], pData[3], pData[4],
pData[5], pData[6], pData[7], pData[8], pData[9]);
}
}
else
{
EnsureTickWritten();
Buffer.Reset();
Buffer.AddInt(-TEEHISTORIAN_INPUT_NEW);
DiffInput = *pInput;
if(m_Debug)
{
dbg_msg("teehistorian", "new_input cid=%d", ClientID);
}
}
Buffer.AddInt(ClientID);
for(int i = 0; i < (int)(sizeof(DiffInput) / sizeof(int)); i++)
{
Buffer.AddInt(((int *)&DiffInput)[i]);
}
pPrev->m_InputExists = true;
pPrev->m_Input = *pInput;
Write(Buffer.Data(), Buffer.Size());
}
void CTeeHistorian::RecordPlayerMessage(int ClientID, const void *pMsg, int MsgSize)
{
EnsureTickWritten();
CPacker Buffer;
Buffer.Reset();
Buffer.AddInt(-TEEHISTORIAN_MESSAGE);
Buffer.AddInt(ClientID);
Buffer.AddInt(MsgSize);
Buffer.AddRaw(pMsg, MsgSize);
if(m_Debug)
{
CUnpacker Unpacker;
Unpacker.Reset(pMsg, MsgSize);
int MsgID = Unpacker.GetInt();
int Sys = MsgID & 1;
MsgID >>= 1;
dbg_msg("teehistorian", "msg cid=%d sys=%d msgid=%d", ClientID, Sys, MsgID);
}
Write(Buffer.Data(), Buffer.Size());
}
void CTeeHistorian::RecordPlayerJoin(int ClientID, int Protocol)
{
dbg_assert(Protocol == PROTOCOL_6 || Protocol == PROTOCOL_7, "invalid version");
EnsureTickWritten();
{
CPacker Buffer;
Buffer.Reset();
Buffer.AddInt(ClientID);
if(m_Debug)
{
dbg_msg("teehistorian", "joinver%d cid=%d", Protocol == PROTOCOL_6 ? 6 : 7, ClientID);
}
CUuid Uuid = Protocol == PROTOCOL_6 ? UUID_TEEHISTORIAN_JOINVER6 : UUID_TEEHISTORIAN_JOINVER7;
WriteExtra(Uuid, Buffer.Data(), Buffer.Size());
}
CPacker Buffer;
Buffer.Reset();
Buffer.AddInt(-TEEHISTORIAN_JOIN);
Buffer.AddInt(ClientID);
if(m_Debug)
{
dbg_msg("teehistorian", "join cid=%d", ClientID);
}
Write(Buffer.Data(), Buffer.Size());
}
void CTeeHistorian::RecordPlayerDrop(int ClientID, const char *pReason)
{
EnsureTickWritten();
CPacker Buffer;
Buffer.Reset();
Buffer.AddInt(-TEEHISTORIAN_DROP);
Buffer.AddInt(ClientID);
Buffer.AddString(pReason, 0);
if(m_Debug)
{
dbg_msg("teehistorian", "drop cid=%d reason='%s'", ClientID, pReason);
}
Write(Buffer.Data(), Buffer.Size());
}
void CTeeHistorian::RecordConsoleCommand(int ClientID, int FlagMask, const char *pCmd, IConsole::IResult *pResult)
{
EnsureTickWritten();
CPacker Buffer;
Buffer.Reset();
Buffer.AddInt(-TEEHISTORIAN_CONSOLE_COMMAND);
Buffer.AddInt(ClientID);
Buffer.AddInt(FlagMask);
Buffer.AddString(pCmd, 0);
Buffer.AddInt(pResult->NumArguments());
for(int i = 0; i < pResult->NumArguments(); i++)
{
Buffer.AddString(pResult->GetString(i), 0);
}
if(m_Debug)
{
dbg_msg("teehistorian", "ccmd cid=%d cmd='%s'", ClientID, pCmd);
}
Write(Buffer.Data(), Buffer.Size());
}
void CTeeHistorian::RecordTestExtra()
{
if(m_Debug)
{
dbg_msg("teehistorian", "test");
}
WriteExtra(UUID_TEEHISTORIAN_TEST, "", 0);
}
2020-06-20 14:19:49 +00:00
void CTeeHistorian::RecordTeamSaveSuccess(int Team, CUuid SaveID, const char *pTeamSave)
{
CPacker Buffer;
Buffer.Reset();
Buffer.AddInt(Team);
Buffer.AddRaw(&SaveID, sizeof(SaveID));
Buffer.AddString(pTeamSave, 0);
if(m_Debug)
{
char aSaveID[UUID_MAXSTRSIZE];
FormatUuid(SaveID, aSaveID, sizeof(aSaveID));
dbg_msg("teehistorian", "save_success team=%d save_id=%s team_save='%s'", Team, aSaveID, pTeamSave);
2020-06-20 14:19:49 +00:00
}
WriteExtra(UUID_TEEHISTORIAN_SAVE_SUCCESS, Buffer.Data(), Buffer.Size());
}
void CTeeHistorian::RecordTeamSaveFailure(int Team)
{
CPacker Buffer;
Buffer.Reset();
Buffer.AddInt(Team);
if(m_Debug)
{
dbg_msg("teehistorian", "save_failure team=%d", Team);
2020-06-20 14:19:49 +00:00
}
WriteExtra(UUID_TEEHISTORIAN_SAVE_FAILURE, Buffer.Data(), Buffer.Size());
}
void CTeeHistorian::RecordTeamLoadSuccess(int Team, CUuid SaveID, const char *pTeamSave)
{
CPacker Buffer;
Buffer.Reset();
Buffer.AddInt(Team);
Buffer.AddRaw(&SaveID, sizeof(SaveID));
Buffer.AddString(pTeamSave, 0);
if(m_Debug)
{
char aSaveID[UUID_MAXSTRSIZE];
FormatUuid(SaveID, aSaveID, sizeof(aSaveID));
dbg_msg("teehistorian", "load_success team=%d save_id=%s team_save='%s'", Team, aSaveID, pTeamSave);
2020-06-20 14:19:49 +00:00
}
WriteExtra(UUID_TEEHISTORIAN_LOAD_SUCCESS, Buffer.Data(), Buffer.Size());
}
void CTeeHistorian::RecordTeamLoadFailure(int Team)
{
CPacker Buffer;
Buffer.Reset();
Buffer.AddInt(Team);
if(m_Debug)
{
dbg_msg("teehistorian", "load_failure team=%d", Team);
2020-06-20 14:19:49 +00:00
}
WriteExtra(UUID_TEEHISTORIAN_LOAD_FAILURE, Buffer.Data(), Buffer.Size());
}
void CTeeHistorian::EndInputs()
{
dbg_assert(m_State == STATE_INPUTS, "invalid teehistorian state");
m_State = STATE_BEFORE_ENDTICK;
}
void CTeeHistorian::EndTick()
{
dbg_assert(m_State == STATE_BEFORE_ENDTICK, "invalid teehistorian state");
m_State = STATE_BEFORE_TICK;
}
void CTeeHistorian::RecordDDNetVersionOld(int ClientID, int DDNetVersion)
{
CPacker Buffer;
Buffer.Reset();
Buffer.AddInt(ClientID);
Buffer.AddInt(DDNetVersion);
if(m_Debug)
{
dbg_msg("teehistorian", "ddnetver_old cid=%d ddnet_version=%d", ClientID, DDNetVersion);
}
WriteExtra(UUID_TEEHISTORIAN_DDNETVER_OLD, Buffer.Data(), Buffer.Size());
}
void CTeeHistorian::RecordDDNetVersion(int ClientID, CUuid ConnectionID, int DDNetVersion, const char *pDDNetVersionStr)
{
CPacker Buffer;
Buffer.Reset();
Buffer.AddInt(ClientID);
Buffer.AddRaw(&ConnectionID, sizeof(ConnectionID));
Buffer.AddInt(DDNetVersion);
Buffer.AddString(pDDNetVersionStr, 0);
if(m_Debug)
{
char aConnnectionID[UUID_MAXSTRSIZE];
FormatUuid(ConnectionID, aConnnectionID, sizeof(aConnnectionID));
dbg_msg("teehistorian", "ddnetver cid=%d connection_id=%s ddnet_version=%d ddnet_version_str=%s", ClientID, aConnnectionID, DDNetVersion, pDDNetVersionStr);
}
WriteExtra(UUID_TEEHISTORIAN_DDNETVER, Buffer.Data(), Buffer.Size());
}
void CTeeHistorian::RecordAuthInitial(int ClientID, int Level, const char *pAuthName)
{
CPacker Buffer;
Buffer.Reset();
Buffer.AddInt(ClientID);
Buffer.AddInt(Level);
Buffer.AddString(pAuthName, 0);
if(m_Debug)
{
dbg_msg("teehistorian", "auth_init cid=%d level=%d auth_name=%s", ClientID, Level, pAuthName);
}
WriteExtra(UUID_TEEHISTORIAN_AUTH_INIT, Buffer.Data(), Buffer.Size());
}
void CTeeHistorian::RecordAuthLogin(int ClientID, int Level, const char *pAuthName)
{
CPacker Buffer;
Buffer.Reset();
Buffer.AddInt(ClientID);
Buffer.AddInt(Level);
Buffer.AddString(pAuthName, 0);
if(m_Debug)
{
dbg_msg("teehistorian", "auth_login cid=%d level=%d auth_name=%s", ClientID, Level, pAuthName);
}
WriteExtra(UUID_TEEHISTORIAN_AUTH_LOGIN, Buffer.Data(), Buffer.Size());
}
void CTeeHistorian::RecordAuthLogout(int ClientID)
{
CPacker Buffer;
Buffer.Reset();
Buffer.AddInt(ClientID);
if(m_Debug)
{
dbg_msg("teehistorian", "auth_logout cid=%d", ClientID);
}
WriteExtra(UUID_TEEHISTORIAN_AUTH_LOGOUT, Buffer.Data(), Buffer.Size());
}
void CTeeHistorian::Finish()
{
dbg_assert(m_State == STATE_START || m_State == STATE_INPUTS || m_State == STATE_BEFORE_ENDTICK || m_State == STATE_BEFORE_TICK, "invalid teehistorian state");
if(m_State == STATE_INPUTS)
{
EndInputs();
}
if(m_State == STATE_BEFORE_ENDTICK)
{
EndTick();
}
CPacker Buffer;
Buffer.Reset();
Buffer.AddInt(-TEEHISTORIAN_FINISH);
if(m_Debug)
{
dbg_msg("teehistorian", "finish");
}
Write(Buffer.Data(), Buffer.Size());
}