Allow connection info to be missing from minetest.get_player_information() (#9739)

sfan5 · web-flow · commit ac368af4fe27 · 2020-05-01T21:44:28.000+02:00
fixes #9352 This reverts commit 23c907b.
diff --git a/doc/lua_api.txt b/doc/lua_api.txt
@@ -4160,17 +4160,18 @@ Utilities
       {
           address = "127.0.0.1",     -- IP address of client
           ip_version = 4,            -- IPv4 / IPv6
+          connection_uptime = 200,   -- seconds since client connected
+          protocol_version = 32,     -- protocol version used by client
+          formspec_version = 2,      -- supported formspec version
+          lang_code = "fr"           -- Language code used for translation
+          -- the following keys can be missing if no stats have been collected yet
           min_rtt = 0.01,            -- minimum round trip time
           max_rtt = 0.2,             -- maximum round trip time
           avg_rtt = 0.02,            -- average round trip time
           min_jitter = 0.01,         -- minimum packet time jitter
           max_jitter = 0.5,          -- maximum packet time jitter
           avg_jitter = 0.03,         -- average packet time jitter
-          connection_uptime = 200,   -- seconds since client connected
-          protocol_version = 32,     -- protocol version used by client
-          formspec_version = 2,      -- supported formspec version
-          lang_code = "fr"           -- Language code used for translation
-          -- following information is available on debug build only!!!
+          -- the following information is available in a debug build only!!!
           -- DO NOT USE IN MODS
           --ser_vers = 26,             -- serialization version used by client
           --major = 0,                 -- major version number
diff --git a/src/network/connection.h b/src/network/connection.h
@@ -612,16 +612,16 @@ class Peer {
 		struct rttstats {
 			float jitter_min = FLT_MAX;
 			float jitter_max = 0.0f;
-			float jitter_avg = -2.0f;
+			float jitter_avg = -1.0f;
 			float min_rtt = FLT_MAX;
 			float max_rtt = 0.0f;
-			float avg_rtt = -2.0f;
+			float avg_rtt = -1.0f;
 
 			rttstats() = default;
 		};
 
 		rttstats m_rtt;
-		float m_last_rtt = -2.0f;
+		float m_last_rtt = -1.0f;
 
 		// current usage count
 		unsigned int m_usage = 0;
diff --git a/src/script/lua_api/l_server.cpp b/src/script/lua_api/l_server.cpp
@@ -138,53 +138,54 @@ int ModApiServer::l_get_player_ip(lua_State *L)
 // get_player_information(name)
 int ModApiServer::l_get_player_information(lua_State *L)
 {
-
 	NO_MAP_LOCK_REQUIRED;
-	const char * name = luaL_checkstring(L, 1);
-	RemotePlayer *player = dynamic_cast<ServerEnvironment *>(getEnv(L))->getPlayer(name);
-	if (player == NULL) {
+
+	Server *server = getServer(L);
+
+	const char *name = luaL_checkstring(L, 1);
+	RemotePlayer *player = server->getEnv().getPlayer(name);
+	if (!player) {
 		lua_pushnil(L); // no such player
 		return 1;
 	}
 
 	Address addr;
-	try
-	{
-		addr = getServer(L)->getPeerAddress(player->getPeerId());
-	} catch(const con::PeerNotFoundException &) {
+	try {
+		addr = server->getPeerAddress(player->getPeerId());
+	} catch (const con::PeerNotFoundException &) {
 		dstream << FUNCTION_NAME << ": peer was not found" << std::endl;
 		lua_pushnil(L); // error
 		return 1;
 	}
 
-	float min_rtt,max_rtt,avg_rtt,min_jitter,max_jitter,avg_jitter;
+	float min_rtt, max_rtt, avg_rtt, min_jitter, max_jitter, avg_jitter;
 	ClientState state;
 	u32 uptime;
 	u16 prot_vers;
-	u8 ser_vers,major,minor,patch;
-	std::string vers_string;
-	std::string lang_code;
-
-#define ERET(code)                                                             \
-	if (!(code)) {                                                             \
-		dstream << FUNCTION_NAME << ": peer was not found" << std::endl;     \
-		lua_pushnil(L); /* error */                                            \
-		return 1;                                                              \
+	u8 ser_vers, major, minor, patch;
+	std::string vers_string, lang_code;
+
+	auto getConInfo = [&] (con::rtt_stat_type type, float *value) -> bool {
+		return server->getClientConInfo(player->getPeerId(), type, value);
+	};
+
+	bool have_con_info =
+		getConInfo(con::MIN_RTT, &min_rtt) &&
+		getConInfo(con::MAX_RTT, &max_rtt) &&
+		getConInfo(con::AVG_RTT, &avg_rtt) &&
+		getConInfo(con::MIN_JITTER, &min_jitter) &&
+		getConInfo(con::MAX_JITTER, &max_jitter) &&
+		getConInfo(con::AVG_JITTER, &avg_jitter);
+
+	bool r = server->getClientInfo(player->getPeerId(), &state, &uptime,
+		&ser_vers, &prot_vers, &major, &minor, &patch, &vers_string,
+		&lang_code);
+	if (!r) {
+		dstream << FUNCTION_NAME << ": peer was not found" << std::endl;
+		lua_pushnil(L); // error
+		return 1;
 	}
 
-	ERET(getServer(L)->getClientConInfo(player->getPeerId(), con::MIN_RTT, &min_rtt))
-	ERET(getServer(L)->getClientConInfo(player->getPeerId(), con::MAX_RTT, &max_rtt))
-	ERET(getServer(L)->getClientConInfo(player->getPeerId(), con::AVG_RTT, &avg_rtt))
-	ERET(getServer(L)->getClientConInfo(player->getPeerId(), con::MIN_JITTER,
-		&min_jitter))
-	ERET(getServer(L)->getClientConInfo(player->getPeerId(), con::MAX_JITTER,
-		&max_jitter))
-	ERET(getServer(L)->getClientConInfo(player->getPeerId(), con::AVG_JITTER,
-		&avg_jitter))
-
-	ERET(getServer(L)->getClientInfo(player->getPeerId(), &state, &uptime, &ser_vers,
-		&prot_vers, &major, &minor, &patch, &vers_string, &lang_code))
-
 	lua_newtable(L);
 	int table = lua_gettop(L);
 
@@ -202,29 +203,31 @@ int ModApiServer::l_get_player_information(lua_State *L)
 	}
 	lua_settable(L, table);
 
-	lua_pushstring(L,"min_rtt");
-	lua_pushnumber(L, min_rtt);
-	lua_settable(L, table);
+	if (have_con_info) { // may be missing
+		lua_pushstring(L, "min_rtt");
+		lua_pushnumber(L, min_rtt);
+		lua_settable(L, table);
 
-	lua_pushstring(L,"max_rtt");
-	lua_pushnumber(L, max_rtt);
-	lua_settable(L, table);
+		lua_pushstring(L, "max_rtt");
+		lua_pushnumber(L, max_rtt);
+		lua_settable(L, table);
 
-	lua_pushstring(L,"avg_rtt");
-	lua_pushnumber(L, avg_rtt);
-	lua_settable(L, table);
+		lua_pushstring(L, "avg_rtt");
+		lua_pushnumber(L, avg_rtt);
+		lua_settable(L, table);
 
-	lua_pushstring(L,"min_jitter");
-	lua_pushnumber(L, min_jitter);
-	lua_settable(L, table);
+		lua_pushstring(L, "min_jitter");
+		lua_pushnumber(L, min_jitter);
+		lua_settable(L, table);
 
-	lua_pushstring(L,"max_jitter");
-	lua_pushnumber(L, max_jitter);
-	lua_settable(L, table);
+		lua_pushstring(L, "max_jitter");
+		lua_pushnumber(L, max_jitter);
+		lua_settable(L, table);
 
-	lua_pushstring(L,"avg_jitter");
-	lua_pushnumber(L, avg_jitter);
-	lua_settable(L, table);
+		lua_pushstring(L, "avg_jitter");
+		lua_pushnumber(L, avg_jitter);
+		lua_settable(L, table);
+	}
 
 	lua_pushstring(L,"connection_uptime");
 	lua_pushnumber(L, uptime);
@@ -268,7 +271,6 @@ int ModApiServer::l_get_player_information(lua_State *L)
 	lua_settable(L, table);
 #endif
 
-#undef ERET
 	return 1;
 }
 
