3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU Lesser General Public License as published by
7 the Free Software Foundation; either version 2.1 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public License along
16 with this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
27 #include "serverlist.h"
31 #include "network/networkprotocol.h"
32 #include <json/json.h>
33 #include "convert_json.h"
34 #include "httpfetch.h"
35 #include "util/string.h"
40 std::string getFilePath()
42 std::string serverlist_file = g_settings->get("serverlist_file");
44 std::string dir_path = "client" DIR_DELIM "serverlist" DIR_DELIM;
45 fs::CreateDir(porting::path_user + DIR_DELIM "client");
46 fs::CreateDir(porting::path_user + DIR_DELIM + dir_path);
47 return porting::path_user + DIR_DELIM + dir_path + serverlist_file;
51 std::vector<ServerListSpec> getLocal()
53 std::string path = ServerList::getFilePath();
54 std::string liststring;
55 fs::ReadFile(path, liststring);
57 return deSerialize(liststring);
61 std::vector<ServerListSpec> getOnline()
63 std::ostringstream geturl;
65 u16 proto_version_min = CLIENT_PROTOCOL_VERSION_MIN;
67 geturl << g_settings->get("serverlist_url") <<
68 "/list?proto_version_min=" << proto_version_min <<
69 "&proto_version_max=" << CLIENT_PROTOCOL_VERSION_MAX;
70 Json::Value root = fetchJsonValue(geturl.str(), NULL);
72 std::vector<ServerListSpec> server_list;
74 if (!root.isObject()) {
79 if (!root.isArray()) {
83 for (const Json::Value &i : root) {
85 server_list.push_back(i);
93 // Delete a server from the local favorites list
94 bool deleteEntry(const ServerListSpec &server)
96 std::vector<ServerListSpec> serverlist = ServerList::getLocal();
97 for (std::vector<ServerListSpec>::iterator it = serverlist.begin();
98 it != serverlist.end();) {
99 if ((*it)["address"] == server["address"] &&
100 (*it)["port"] == server["port"]) {
101 it = serverlist.erase(it);
107 std::string path = ServerList::getFilePath();
108 std::ostringstream ss(std::ios_base::binary);
109 ss << ServerList::serialize(serverlist);
110 if (!fs::safeWriteToFile(path, ss.str()))
115 // Insert a server to the local favorites list
116 bool insert(const ServerListSpec &server)
119 ServerList::deleteEntry(server);
121 std::vector<ServerListSpec> serverlist = ServerList::getLocal();
123 // Insert new server at the top of the list
124 serverlist.insert(serverlist.begin(), server);
126 std::string path = ServerList::getFilePath();
127 std::ostringstream ss(std::ios_base::binary);
128 ss << ServerList::serialize(serverlist);
129 if (!fs::safeWriteToFile(path, ss.str()))
135 std::vector<ServerListSpec> deSerialize(const std::string &liststring)
137 std::vector<ServerListSpec> serverlist;
138 std::istringstream stream(liststring);
139 std::string line, tmp;
140 while (std::getline(stream, line)) {
141 std::transform(line.begin(), line.end(), line.begin(), ::toupper);
142 if (line == "[SERVER]") {
143 ServerListSpec server;
144 std::getline(stream, tmp);
145 server["name"] = tmp;
146 std::getline(stream, tmp);
147 server["address"] = tmp;
148 std::getline(stream, tmp);
149 server["port"] = tmp;
151 for (const ServerListSpec &added : serverlist) {
152 if (server["name"] == added["name"]
153 && server["port"] == added["port"]) {
160 std::getline(stream, tmp);
161 server["description"] = tmp;
162 serverlist.push_back(server);
168 const std::string serialize(const std::vector<ServerListSpec> &serverlist)
170 std::string liststring;
171 for (const ServerListSpec &it : serverlist) {
172 liststring += "[server]\n";
173 liststring += it["name"].asString() + '\n';
174 liststring += it["address"].asString() + '\n';
175 liststring += it["port"].asString() + '\n';
176 liststring += it["description"].asString() + '\n';
182 const std::string serializeJson(const std::vector<ServerListSpec> &serverlist)
185 Json::Value list(Json::arrayValue);
186 for (const ServerListSpec &it : serverlist) {
191 return fastWriteJson(root);
196 void sendAnnounce(AnnounceAction action,
198 const std::vector<std::string> &clients_names,
202 const std::string &gameid,
203 const std::string &mg_name,
204 const std::vector<ModSpec> &mods,
207 static const char *aa_names[] = {"start", "update", "delete"};
209 server["action"] = aa_names[action];
210 server["port"] = port;
211 if (g_settings->exists("server_address")) {
212 server["address"] = g_settings->get("server_address");
214 if (action != AA_DELETE) {
215 bool strict_checking = g_settings->getBool("strict_protocol_version_checking");
216 server["name"] = g_settings->get("server_name");
217 server["description"] = g_settings->get("server_description");
218 server["version"] = g_version_string;
219 server["proto_min"] = strict_checking ? LATEST_PROTOCOL_VERSION : SERVER_PROTOCOL_VERSION_MIN;
220 server["proto_max"] = strict_checking ? LATEST_PROTOCOL_VERSION : SERVER_PROTOCOL_VERSION_MAX;
221 server["url"] = g_settings->get("server_url");
222 server["creative"] = g_settings->getBool("creative_mode");
223 server["damage"] = g_settings->getBool("enable_damage");
224 server["password"] = g_settings->getBool("disallow_empty_password");
225 server["pvp"] = g_settings->getBool("enable_pvp");
226 server["uptime"] = (int) uptime;
227 server["game_time"] = game_time;
228 server["clients"] = (int) clients_names.size();
229 server["clients_max"] = g_settings->getU16("max_users");
230 server["clients_list"] = Json::Value(Json::arrayValue);
231 for (const std::string &clients_name : clients_names) {
232 server["clients_list"].append(clients_name);
235 server["gameid"] = gameid;
238 if (action == AA_START) {
239 server["dedicated"] = dedicated;
240 server["rollback"] = g_settings->getBool("enable_rollback_recording");
241 server["mapgen"] = mg_name;
242 server["privs"] = g_settings->get("default_privs");
243 server["can_see_far_names"] = g_settings->getS16("player_transfer_distance") <= 0;
244 server["mods"] = Json::Value(Json::arrayValue);
245 for (const ModSpec &mod : mods) {
246 server["mods"].append(mod.name);
248 } else if (action == AA_UPDATE) {
253 if (action == AA_START) {
254 actionstream << "Announcing " << aa_names[action] << " to " <<
255 g_settings->get("serverlist_url") << std::endl;
257 infostream << "Announcing " << aa_names[action] << " to " <<
258 g_settings->get("serverlist_url") << std::endl;
261 HTTPFetchRequest fetch_request;
262 fetch_request.url = g_settings->get("serverlist_url") + std::string("/announce");
263 fetch_request.method = HTTP_POST;
264 fetch_request.fields["json"] = fastWriteJson(server);
265 fetch_request.multipart = true;
266 httpfetch_async(fetch_request);
270 } // namespace ServerList