1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
|
/* This file is part of the Spring engine (GPL v2 or later), see LICENSE.html */
#include "DemoReader.h"
#include "Game/GameVersion.h"
#include "Sim/Misc/GlobalConstants.h"
#ifndef TOOLS
#include "System/Config/ConfigHandler.h"
CONFIG(bool, DisableDemoVersionCheck).defaultValue(false).description("Allow to play every replay file (may crash / cause undefined behaviour in replays)");
#endif
#include "System/Exceptions.h"
#include "System/FileSystem/GZFileHandler.h"
#include "System/FileSystem/FileSystem.h"
#include "System/Log/ILog.h"
#include "System/Net/RawPacket.h"
#include <array>
#include <climits>
#include <stdexcept>
#include <cassert>
#include <cstring>
static bool CheckDemoHeader(const DemoFileHeader& fileHeader)
{
if (memcmp(fileHeader.magic, DEMOFILE_MAGIC, sizeof(fileHeader.magic)) != 0)
return false;
if (fileHeader.version != DEMOFILE_VERSION)
return false;
if (fileHeader.headerSize != sizeof(DemoFileHeader))
return false;
if (fileHeader.playerStatElemSize != sizeof(PlayerStatistics))
return false;
if (fileHeader.teamStatElemSize != sizeof(TeamStatistics))
return false;
// do not compare Spring version in debug mode: we do not want to make
// debugging dev-version demos impossible (because the version differs
// each build)
#ifndef _DEBUG
return (!SpringVersion::IsRelease() || strcmp(fileHeader.versionString, SpringVersion::GetSync().c_str()) == 0);
#endif
return true;
}
CDemoReader::CDemoReader(const std::string& filename, float curTime): playbackDemo(new CGZFileHandler(filename, SPRING_VFS_PWD_ALL))
{
if (FileSystem::GetExtension(filename) != "sdfz")
throw content_error("Unknown demo extension: " + FileSystem::GetExtension(filename));
// file not found -> exception
if (!playbackDemo->FileExists())
throw user_error("Demofile not found: " + filename);
playbackDemo->Read((char*)&fileHeader, sizeof(fileHeader));
fileHeader.swab();
if (!CheckDemoHeader(fileHeader)) {
char buf[1024];
const char* fmt = "[%s] demo-file \"%s\" (%d bytes, magic \"%s\") corrupt or created by a different Spring version, expected \"%s\"";
memset(buf, 0, sizeof(buf));
snprintf(buf, sizeof(buf) - 1, fmt, __func__, filename.c_str(), playbackDemo->FileSize(), fileHeader.magic, fileHeader.versionString);
#ifndef TOOLS
if (!configHandler->GetBool("DisableDemoVersionCheck"))
throw std::runtime_error(buf);
#endif
LOG_L(L_WARNING, "%s", buf);
}
if (fileHeader.scriptSize != 0) {
setupScript.resize(fileHeader.scriptSize, 0);
playbackDemo->Read(const_cast<char*>(setupScript.data()), setupScript.size());
}
playbackDemo->Read((char*)&chunkHeader, sizeof(chunkHeader));
chunkHeader.swab();
demoTimeOffset = curTime - chunkHeader.modGameTime - 0.1f;
nextDemoReadTime = curTime - 0.01f;
const long curPos = playbackDemo->GetPos();
playbackDemo->Seek(0, std::ios::end);
playbackDemoSize = playbackDemo->GetPos();
if (fileHeader.demoStreamSize != 0) {
bytesRemaining = fileHeader.demoStreamSize;
} else {
// Spring crashed while recording the demo: replay until EOF,
// but at most filesize bytes to block watching demo of running game.
// For this we must determine the file size.
// (if this had still used CFileHandler that would have been easier ;-))
bytesRemaining = playbackDemoSize - curPos;
}
playbackDemo->Seek(curPos);
}
CDemoReader::~CDemoReader()
{
delete playbackDemo;
}
netcode::RawPacket* CDemoReader::GetData(const float readTime)
{
if (ReachedEnd())
return nullptr;
// when paused, modGameTime does not increase (ie. we
// always pass the same readTime value) so no seperate
// check needed
if (readTime >= nextDemoReadTime) {
netcode::RawPacket* buf = new netcode::RawPacket(chunkHeader.length);
if (playbackDemo->Read((char*)(buf->data), chunkHeader.length) < chunkHeader.length) {
delete buf;
bytesRemaining = 0;
return nullptr;
}
bytesRemaining -= chunkHeader.length;
if (!ReachedEnd()) {
// read next chunk header
if (playbackDemo->Read((char*)&chunkHeader, sizeof(chunkHeader)) < sizeof(chunkHeader)) {
delete buf;
bytesRemaining = 0;
return nullptr;
}
chunkHeader.swab();
nextDemoReadTime = chunkHeader.modGameTime + demoTimeOffset;
bytesRemaining -= sizeof(chunkHeader);
}
if (readTime < 0) {
delete buf;
return nullptr;
}
return buf;
}
return nullptr;
}
bool CDemoReader::ReachedEnd()
{
return (bytesRemaining <= 0 || playbackDemo->Eof() || (playbackDemo->GetPos() > playbackDemoSize));
}
void CDemoReader::LoadStats()
{
// Stats are not available if Spring crashed while writing the demo.
if (fileHeader.demoStreamSize == 0)
return;
const int curPos = playbackDemo->GetPos();
playbackDemo->Seek(fileHeader.headerSize + fileHeader.scriptSize + fileHeader.demoStreamSize);
winningAllyTeams.clear();
playerStats.clear();
teamStats.clear();
for (int allyTeamNum = 0; allyTeamNum < fileHeader.winningAllyTeamsSize; ++allyTeamNum) {
unsigned char winnerAllyTeam;
playbackDemo->Read((char*) &winnerAllyTeam, sizeof(unsigned char));
winningAllyTeams.push_back(winnerAllyTeam);
}
for (int playerNum = 0; playerNum < fileHeader.numPlayers; ++playerNum) {
PlayerStatistics buf;
playbackDemo->Read(reinterpret_cast<char*>(&buf), sizeof(PlayerStatistics));
buf.swab();
playerStats.push_back(buf);
}
{ // Team statistics follow player statistics.
teamStats.resize(fileHeader.numTeams);
// Read the array containing the number of team stats for each team.
std::array<int, MAX_TEAMS> numStatsPerTeam;
assert(fileHeader.numTeams <= numStatsPerTeam.size());
numStatsPerTeam.fill(0);
playbackDemo->Read(reinterpret_cast<char*>(numStatsPerTeam.data()), fileHeader.numTeams);
for (int teamNum = 0; teamNum < fileHeader.numTeams; ++teamNum) {
for (int i = 0; i < numStatsPerTeam[teamNum]; ++i) {
TeamStatistics buf;
playbackDemo->Read(reinterpret_cast<char*>(&buf), sizeof(TeamStatistics));
buf.swab();
teamStats[teamNum].push_back(buf);
}
}
}
playbackDemo->Seek(curPos);
}
|