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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
|
#include "OptionsDB.h"
#include "SaveGamePreviewUtils.h"
#include "i18n.h"
#include "Directories.h"
#include "Logger.h"
#include "Serialize.h"
#include "Serialize.ipp"
#include "ScopedTimer.h"
#include <boost/filesystem.hpp>
#include <boost/filesystem/operations.hpp>
#include <boost/filesystem/fstream.hpp>
#include <boost/date_time/posix_time/posix_time.hpp>
#include <boost/graph/graph_concepts.hpp>
#include <boost/iostreams/filter/zlib.hpp>
#include <boost/iostreams/filtering_streambuf.hpp>
#include <boost/iostreams/copy.hpp>
#include <boost/iostreams/device/back_inserter.hpp>
#include <boost/iostreams/stream.hpp>
#include <fstream>
namespace fs = boost::filesystem;
namespace {
constexpr std::string_view UNABLE_TO_OPEN_FILE("Unable to open file");
constexpr std::string_view XML_SAVE_FILE_DESCRIPTION("This is an XML archive FreeOrion saved game. Initial header information is uncompressed. The main gamestate information follows, possibly stored as zlib-comprssed XML archive in the last entry in the main archive.");
constexpr std::string_view BIN_SAVE_FILE_DESCRIPTION("This is binary archive FreeOrion saved game.");
const std::string XML_COMPRESSED_MARKER("zlib-xml");
/// Splits time and date on separate lines for an ISO datetime string
std::string split_time(std::string time) {
auto pos = time.find('T');
if (pos != std::string::npos)
time.replace(pos, 1, "\n");
return time;
}
/// Populates a SaveGamePreviewData from a given file
/// returns true on success, false if preview data could not be found
bool LoadSaveGamePreviewData(const fs::path& path, FullPreview& full) {
if (!fs::exists(path)) {
DebugLogger() << "LoadSaveGamePreviewData: Save file note found: " << path.string();
return false;
}
fs::ifstream ifs(path, std::ios_base::binary);
full.filename = PathToString(path.filename());
if (!ifs)
throw std::runtime_error(UNABLE_TO_OPEN_FILE.data());
// alias structs so variable passed into NVP deserialization macro has the
// same name as that passed into serialization macro in SaveGame function.
SaveGamePreviewData& save_preview_data = full.preview;
GalaxySetupData& galaxy_setup_data = full.galaxy;
DebugLogger() << "LoadSaveGamePreviewData: Loading preview from: " << path.string();
try {
// read the first five letters of the stream and check if it is opening an xml file
std::array<std::string::value_type, 5> xxx5{};
ifs.read(xxx5.data(), xxx5.size());
static constexpr std::array<std::string::value_type, 5> xml5{'<', '?', 'x', 'm', 'l'};
// reset to start of stream
boost::iostreams::seek(ifs, 0, std::ios_base::beg);
// binary deserialization iff document is not xml
if (xml5 != xxx5) {
// first attempt binary deserialziation
freeorion_bin_iarchive ia(ifs);
ia >> BOOST_SERIALIZATION_NVP(save_preview_data);
ia >> BOOST_SERIALIZATION_NVP(galaxy_setup_data);
} else {
freeorion_xml_iarchive ia(ifs);
ia >> BOOST_SERIALIZATION_NVP(save_preview_data);
if (save_preview_data.save_format_marker == XML_COMPRESSED_MARKER)
throw std::invalid_argument("Save Format Not Compatible with Boost Version " BOOST_LIB_VERSION);
ia >> BOOST_SERIALIZATION_NVP(galaxy_setup_data);
}
DebugLogger() << "Loaded preview with: " << save_preview_data.number_of_human_players << " human players";
} catch (const std::exception& e) {
ErrorLogger() << "LoadSaveGamePreviewData: Failed to read preview of " << path.string() << " because: " << e.what();
return false;
}
if (full.preview.Valid()) {
DebugLogger() << "LoadSaveGamePreviewData: Successfully loaded preview from: " << path.string();
return true;
} else {
DebugLogger() << "LoadSaveGamePreviewData: Passing save file with no preview: " << path.string();
return false;
}
}
}
SaveGamePreviewData::SaveGamePreviewData() :
magic_number(PREVIEW_PRESENT_MARKER),
freeorion_version(UserString("UNKNOWN_VALUE_SYMBOL_2")),
main_player_name(UserString("UNKNOWN_VALUE_SYMBOL_2")),
main_player_empire_name(UserString("UNKNOWN_VALUE_SYMBOL_2"))
{}
bool SaveGamePreviewData::Valid() const
{ return magic_number == SaveGamePreviewData::PREVIEW_PRESENT_MARKER && current_turn >= -1; }
void SaveGamePreviewData::SetBinary(bool bin)
{ description = bin ? BIN_SAVE_FILE_DESCRIPTION : XML_SAVE_FILE_DESCRIPTION; }
bool SaveFileWithValidHeader(const boost::filesystem::path& path) {
if (!fs::exists(path))
return false;
fs::ifstream ifs(path, std::ios_base::binary);
if (!ifs)
return false;
// dummy holders for deserialized data
SaveGamePreviewData ignored_save_preview_data;
GalaxySetupData ignored_galaxy_setup_data;
ServerSaveGameData ignored_server_save_game_data;
std::vector<PlayerSaveHeaderData> ignored_player_save_header_data;
std::map<int, SaveGameEmpireData> ignored_empire_save_game_data;
DebugLogger() << "SaveFileWithValidHeader: Loading headers from: " << path.string();
try {
// read the first five letters of the stream and check if it is opening an xml file
std::array<std::string::value_type, 5> xxx5{};
ifs.read(xxx5.data(), xxx5.size());
static constexpr std::array<std::string::value_type, 5> xml5{'<', '?', 'x', 'm', 'l'};
// reset to start of stream
boost::iostreams::seek(ifs, 0, std::ios_base::beg);
// binary deserialization iff document is not xml
if (xml5 != xxx5) {
ScopedTimer timer("SaveFileWithValidHeader (binary): " + path.string(), true);
freeorion_bin_iarchive ia(ifs);
ia >> BOOST_SERIALIZATION_NVP(ignored_save_preview_data);
ia >> BOOST_SERIALIZATION_NVP(ignored_galaxy_setup_data);
ia >> BOOST_SERIALIZATION_NVP(ignored_server_save_game_data);
ia >> BOOST_SERIALIZATION_NVP(ignored_player_save_header_data);
ia >> BOOST_SERIALIZATION_NVP(ignored_empire_save_game_data);
} else {
DebugLogger() << "Deserializing XML data";
freeorion_xml_iarchive ia(ifs);
ia >> BOOST_SERIALIZATION_NVP(ignored_save_preview_data);
if (ignored_save_preview_data.save_format_marker == XML_COMPRESSED_MARKER)
throw std::invalid_argument("Save Format Not Compatible with Boost Version " BOOST_LIB_VERSION);
ia >> BOOST_SERIALIZATION_NVP(ignored_galaxy_setup_data);
ia >> BOOST_SERIALIZATION_NVP(ignored_server_save_game_data);
ia >> BOOST_SERIALIZATION_NVP(ignored_player_save_header_data);
ia >> BOOST_SERIALIZATION_NVP(ignored_empire_save_game_data);
}
} catch (const std::exception& e) {
ErrorLogger() << "SaveFileWithValidHeader: Failed to read headers of " << path.string() << " because: " << e.what();
return false;
}
return true;
}
std::string ColumnInPreview(const FullPreview& full, const std::string& name, bool thin) {
if (name == "player") {
return full.preview.main_player_name;
} else if (name == "empire") {
return full.preview.main_player_empire_name;
} else if (name == "turn") {
return std::to_string(full.preview.current_turn);
} else if (name == "time") {
if (thin) {
return split_time(full.preview.save_time);
} else {
return full.preview.save_time;
}
} else if (name == "file") {
return full.filename;
} else if (name == "galaxy_size") {
return std::to_string(full.galaxy.size);
} else if (name == "seed") {
return full.galaxy.seed;
} else if (name == "galaxy_age") {
return TextForGalaxySetupSetting(full.galaxy.age);
} else if (name == "monster_freq") {
return TextForGalaxySetupSetting(full.galaxy.monster_freq);
} else if (name == "native_freq") {
return TextForGalaxySetupSetting(full.galaxy.native_freq);
} else if (name == "planet_freq") {
return TextForGalaxySetupSetting(full.galaxy.planet_density);
} else if (name == "specials_freq") {
return TextForGalaxySetupSetting(full.galaxy.specials_freq);
} else if (name == "starlane_freq") {
return TextForGalaxySetupSetting(full.galaxy.starlane_freq);
} else if (name == "galaxy_shape") {
return TextForGalaxyShape(full.galaxy.shape);
} else if (name == "ai_aggression") {
return TextForAIAggression(full.galaxy.ai_aggr);
} else if (name == "number_of_empires") {
return std::to_string(full.preview.number_of_empires);
} else if (name == "number_of_humans") {
return std::to_string(full.preview.number_of_human_players);
} else {
ErrorLogger() << "FullPreview::Value Error: no such preview field: " << name;
return "??";
}
}
void LoadSaveGamePreviews(const fs::path& orig_path, const std::string& extension, std::vector<FullPreview>& previews) {
fs::directory_iterator end_it;
fs::path path = orig_path;
// Relative path relative to the save directory
if (path.is_relative()) {
ErrorLogger() << "LoadSaveGamePreviews: supplied path must not be relative, \"" << path << "\" ";
return;
}
if (!fs::exists(path)) {
ErrorLogger() << "LoadSaveGamePreviews: Save Game directory \"" << path << "\" not found";
return;
}
if (!fs::is_directory(path)) {
ErrorLogger() << "LoadSaveGamePreviews: Save Game directory \"" << path << "\" was not a directory";
return;
}
for (fs::directory_iterator it(path); it != end_it; ++it) {
try {
if ((it->path().filename().extension() == extension) && !fs::is_directory(it->path())) {
FullPreview data;
if (LoadSaveGamePreviewData(*it, data)) {
// Add preview entry to list
previews.push_back(std::move(data));
}
}
} catch (const std::exception& e) {
ErrorLogger() << "LoadSaveGamePreviews: Failed loading preview from " << it->path() << " because: " << e.what();
}
}
}
|
