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 if (fs::PathExists(path)) {
56 std::ifstream istream(path.c_str());
57 if (istream.is_open()) {
58 std::ostringstream ostream;
59 ostream << istream.rdbuf();
60 liststring = ostream.str();
65 return deSerialize(liststring);
69 std::vector<ServerListSpec> getOnline()
71 std::ostringstream geturl;
73 u16 proto_version_min = g_settings->getFlag("send_pre_v25_init") ?
74 CLIENT_PROTOCOL_VERSION_MIN_LEGACY : CLIENT_PROTOCOL_VERSION_MIN;
76 geturl << g_settings->get("serverlist_url") <<
77 "/list?proto_version_min=" << proto_version_min <<
78 "&proto_version_max=" << CLIENT_PROTOCOL_VERSION_MAX;
79 Json::Value root = fetchJsonValue(geturl.str(), NULL);
81 std::vector<ServerListSpec> server_list;
83 if (!root.isObject()) {
88 if (!root.isArray()) {
92 for (const Json::Value &i : root) {
94 server_list.push_back(i);
102 // Delete a server from the local favorites list
103 bool deleteEntry(const ServerListSpec &server)
105 std::vector<ServerListSpec> serverlist = ServerList::getLocal();
106 for (std::vector<ServerListSpec>::iterator it = serverlist.begin();
107 it != serverlist.end();) {
108 if ((*it)["address"] == server["address"] &&
109 (*it)["port"] == server["port"]) {
110 it = serverlist.erase(it);
116 std::string path = ServerList::getFilePath();
117 std::ostringstream ss(std::ios_base::binary);
118 ss << ServerList::serialize(serverlist);
119 if (!fs::safeWriteToFile(path, ss.str()))
124 // Insert a server to the local favorites list
125 bool insert(const ServerListSpec &server)
128 ServerList::deleteEntry(server);
130 std::vector<ServerListSpec> serverlist = ServerList::getLocal();
132 // Insert new server at the top of the list
133 serverlist.insert(serverlist.begin(), server);
135 std::string path = ServerList::getFilePath();
136 std::ostringstream ss(std::ios_base::binary);
137 ss << ServerList::serialize(serverlist);
138 if (!fs::safeWriteToFile(path, ss.str()))
144 std::vector<ServerListSpec> deSerialize(const std::string &liststring)
146 std::vector<ServerListSpec> serverlist;
147 std::istringstream stream(liststring);
148 std::string line, tmp;
149 while (std::getline(stream, line)) {
150 std::transform(line.begin(), line.end(), line.begin(), ::toupper);
151 if (line == "[SERVER]") {
152 ServerListSpec server;
153 std::getline(stream, tmp);
154 server["name"] = tmp;
155 std::getline(stream, tmp);
156 server["address"] = tmp;
157 std::getline(stream, tmp);
158 server["port"] = tmp;
159 std::getline(stream, tmp);
160 server["description"] = tmp;
161 serverlist.push_back(server);
167 const std::string serialize(const std::vector<ServerListSpec> &serverlist)
169 std::string liststring;
170 for (const ServerListSpec &it : serverlist) {
171 liststring += "[server]\n";
172 liststring += it["name"].asString() + '\n';
173 liststring += it["address"].asString() + '\n';
174 liststring += it["port"].asString() + '\n';
175 liststring += it["description"].asString() + '\n';
181 const std::string serializeJson(const std::vector<ServerListSpec> &serverlist)
184 Json::Value list(Json::arrayValue);
185 for (const ServerListSpec &it : serverlist) {
189 Json::FastWriter writer;
190 return writer.write(root);
195 void sendAnnounce(AnnounceAction action,
197 const std::vector<std::string> &clients_names,
201 const std::string &gameid,
202 const std::string &mg_name,
203 const std::vector<ModSpec> &mods,
206 static const char *aa_names[] = {"start", "update", "delete"};
208 server["action"] = aa_names[action];
209 server["port"] = port;
210 if (g_settings->exists("server_address")) {
211 server["address"] = g_settings->get("server_address");
213 if (action != AA_DELETE) {
214 bool strict_checking = g_settings->getBool("strict_protocol_version_checking");
215 server["name"] = g_settings->get("server_name");
216 server["description"] = g_settings->get("server_description");
217 server["version"] = g_version_string;
218 server["proto_min"] = strict_checking ? LATEST_PROTOCOL_VERSION : SERVER_PROTOCOL_VERSION_MIN;
219 server["proto_max"] = strict_checking ? LATEST_PROTOCOL_VERSION : SERVER_PROTOCOL_VERSION_MAX;
220 server["url"] = g_settings->get("server_url");
221 server["creative"] = g_settings->getBool("creative_mode");
222 server["damage"] = g_settings->getBool("enable_damage");
223 server["password"] = g_settings->getBool("disallow_empty_password");
224 server["pvp"] = g_settings->getBool("enable_pvp");
225 server["uptime"] = (int) uptime;
226 server["game_time"] = game_time;
227 server["clients"] = (int) clients_names.size();
228 server["clients_max"] = g_settings->getU16("max_users");
229 server["clients_list"] = Json::Value(Json::arrayValue);
230 for (const std::string &clients_name : clients_names) {
231 server["clients_list"].append(clients_name);
234 server["gameid"] = gameid;
237 if (action == AA_START) {
238 server["dedicated"] = dedicated;
239 server["rollback"] = g_settings->getBool("enable_rollback_recording");
240 server["mapgen"] = mg_name;
241 server["privs"] = g_settings->get("default_privs");
242 server["can_see_far_names"] = g_settings->getS16("player_transfer_distance") <= 0;
243 server["mods"] = Json::Value(Json::arrayValue);
244 for (const ModSpec &mod : mods) {
245 server["mods"].append(mod.name);
247 actionstream << "Announcing to " << g_settings->get("serverlist_url") << std::endl;
248 } else if (action == AA_UPDATE) {
253 Json::FastWriter writer;
254 HTTPFetchRequest fetch_request;
255 fetch_request.url = g_settings->get("serverlist_url") + std::string("/announce");
256 fetch_request.post_fields["json"] = writer.write(server);
257 fetch_request.multipart = true;
258 httpfetch_async(fetch_request);
262 } // namespace ServerList