Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Use JSON for favorites, move server list code to Lua (#10085)
Co-authored-by: sfan5 <sfan5@live.de>
- Loading branch information
1 parent
4fcd000
commit 67aa75d
Showing
17 changed files
with
388 additions
and
528 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,241 @@ | ||
| --Minetest | ||
| --Copyright (C) 2020 rubenwardy | ||
| -- | ||
| --This program is free software; you can redistribute it and/or modify | ||
| --it under the terms of the GNU Lesser General Public License as published by | ||
| --the Free Software Foundation; either version 2.1 of the License, or | ||
| --(at your option) any later version. | ||
| -- | ||
| --This program is distributed in the hope that it will be useful, | ||
| --but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| --MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| --GNU Lesser General Public License for more details. | ||
| -- | ||
| --You should have received a copy of the GNU Lesser General Public License along | ||
| --with this program; if not, write to the Free Software Foundation, Inc., | ||
| --51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. | ||
|
|
||
| serverlistmgr = {} | ||
|
|
||
| -------------------------------------------------------------------------------- | ||
| local function order_server_list(list) | ||
| local res = {} | ||
| --orders the favorite list after support | ||
| for i = 1, #list do | ||
| local fav = list[i] | ||
| if is_server_protocol_compat(fav.proto_min, fav.proto_max) then | ||
| res[#res + 1] = fav | ||
| end | ||
| end | ||
| for i = 1, #list do | ||
| local fav = list[i] | ||
| if not is_server_protocol_compat(fav.proto_min, fav.proto_max) then | ||
| res[#res + 1] = fav | ||
| end | ||
| end | ||
| return res | ||
| end | ||
|
|
||
| local public_downloading = false | ||
|
|
||
| -------------------------------------------------------------------------------- | ||
| function serverlistmgr.sync() | ||
| if not serverlistmgr.servers then | ||
| serverlistmgr.servers = {{ | ||
| name = fgettext("Loading..."), | ||
| description = fgettext_ne("Try reenabling public serverlist and check your internet connection.") | ||
| }} | ||
| end | ||
|
|
||
| if public_downloading then | ||
| return | ||
| end | ||
| public_downloading = true | ||
|
|
||
| core.handle_async( | ||
| function(param) | ||
| local http = core.get_http_api() | ||
| local url = ("%s/list?proto_version_min=%d&proto_version_max=%d"):format( | ||
| core.settings:get("serverlist_url"), | ||
| core.get_min_supp_proto(), | ||
| core.get_max_supp_proto()) | ||
|
|
||
| local response = http.fetch_sync({ url = url }) | ||
| if not response.succeeded then | ||
| return {} | ||
| end | ||
|
|
||
| local retval = core.parse_json(response.data) | ||
| return retval and retval.list or {} | ||
| end, | ||
| nil, | ||
| function(result) | ||
| public_downloading = nil | ||
| local favs = order_server_list(result) | ||
| if favs[1] then | ||
| serverlistmgr.servers = favs | ||
| end | ||
| core.event_handler("Refresh") | ||
| end | ||
| ) | ||
| end | ||
|
|
||
| -------------------------------------------------------------------------------- | ||
| local function get_favorites_path() | ||
| local base = core.get_user_path() .. DIR_DELIM .. "client" .. DIR_DELIM .. "serverlist" .. DIR_DELIM | ||
| return base .. core.settings:get("serverlist_file") | ||
| end | ||
|
|
||
| -------------------------------------------------------------------------------- | ||
| local function save_favorites(favorites) | ||
| local filename = core.settings:get("serverlist_file") | ||
| -- If setting specifies legacy format change the filename to the new one | ||
| if filename:sub(#filename - 3):lower() == ".txt" then | ||
| core.settings:set("serverlist_file", filename:sub(1, #filename - 4) .. ".json") | ||
| end | ||
|
|
||
| local path = get_favorites_path() | ||
| core.create_dir(path) | ||
| core.safe_file_write(path, core.write_json(favorites)) | ||
| end | ||
|
|
||
| -------------------------------------------------------------------------------- | ||
| function serverlistmgr.read_legacy_favorites(path) | ||
| local file = io.open(path, "r") | ||
| if not file then | ||
| return nil | ||
| end | ||
|
|
||
| local lines = {} | ||
| for line in file:lines() do | ||
| lines[#lines + 1] = line | ||
| end | ||
| file:close() | ||
|
|
||
| local favorites = {} | ||
|
|
||
| local i = 1 | ||
| while i < #lines do | ||
| local function pop() | ||
| local line = lines[i] | ||
| i = i + 1 | ||
| return line and line:trim() | ||
| end | ||
|
|
||
| if pop():lower() == "[server]" then | ||
| local name = pop() | ||
| local address = pop() | ||
| local port = tonumber(pop()) | ||
| local description = pop() | ||
|
|
||
| if name == "" then | ||
| name = nil | ||
| end | ||
|
|
||
| if description == "" then | ||
| description = nil | ||
| end | ||
|
|
||
| if not address or #address < 3 then | ||
| core.log("warning", "Malformed favorites file, missing address at line " .. i) | ||
| elseif not port or port < 1 or port > 65535 then | ||
| core.log("warning", "Malformed favorites file, missing port at line " .. i) | ||
| elseif (name and name:upper() == "[SERVER]") or | ||
| (address and address:upper() == "[SERVER]") or | ||
| (description and description:upper() == "[SERVER]") then | ||
| core.log("warning", "Potentially malformed favorites file, overran at line " .. i) | ||
| else | ||
| favorites[#favorites + 1] = { | ||
| name = name, | ||
| address = address, | ||
| port = port, | ||
| description = description | ||
| } | ||
| end | ||
| end | ||
| end | ||
|
|
||
| return favorites | ||
| end | ||
|
|
||
| -------------------------------------------------------------------------------- | ||
| local function read_favorites() | ||
| local path = get_favorites_path() | ||
|
|
||
| -- If new format configured fall back to reading the legacy file | ||
| if path:sub(#path - 4):lower() == ".json" then | ||
| local file = io.open(path, "r") | ||
| if file then | ||
| local json = file:read("*all") | ||
| file:close() | ||
| return core.parse_json(json) | ||
| end | ||
|
|
||
| path = path:sub(1, #path - 5) .. ".txt" | ||
| end | ||
|
|
||
| local favs = serverlistmgr.read_legacy_favorites(path) | ||
| if favs then | ||
| save_favorites(favs) | ||
| os.remove(path) | ||
| end | ||
| return favs | ||
| end | ||
|
|
||
| -------------------------------------------------------------------------------- | ||
| local function delete_favorite(favorites, del_favorite) | ||
| for i=1, #favorites do | ||
| local fav = favorites[i] | ||
|
|
||
| if fav.address == del_favorite.address and fav.port == del_favorite.port then | ||
| table.remove(favorites, i) | ||
| return | ||
| end | ||
| end | ||
| end | ||
|
|
||
| -------------------------------------------------------------------------------- | ||
| function serverlistmgr.get_favorites() | ||
| if serverlistmgr.favorites then | ||
| return serverlistmgr.favorites | ||
| end | ||
|
|
||
| serverlistmgr.favorites = {} | ||
|
|
||
| -- Add favorites, removing duplicates | ||
| local seen = {} | ||
| for _, fav in ipairs(read_favorites() or {}) do | ||
| local key = ("%s:%d"):format(fav.address:lower(), fav.port) | ||
| if not seen[key] then | ||
| seen[key] = true | ||
| serverlistmgr.favorites[#serverlistmgr.favorites + 1] = fav | ||
| end | ||
| end | ||
|
|
||
| return serverlistmgr.favorites | ||
| end | ||
|
|
||
| -------------------------------------------------------------------------------- | ||
| function serverlistmgr.add_favorite(new_favorite) | ||
| assert(type(new_favorite.port) == "number") | ||
|
|
||
| -- Whitelist favorite keys | ||
| new_favorite = { | ||
| name = new_favorite.name, | ||
| address = new_favorite.address, | ||
| port = new_favorite.port, | ||
| description = new_favorite.description, | ||
| } | ||
|
|
||
| local favorites = serverlistmgr.get_favorites() | ||
| delete_favorite(favorites, new_favorite) | ||
| table.insert(favorites, 1, new_favorite) | ||
| save_favorites(favorites) | ||
| end | ||
|
|
||
| -------------------------------------------------------------------------------- | ||
| function serverlistmgr.delete_favorite(del_favorite) | ||
| local favorites = serverlistmgr.get_favorites() | ||
| delete_favorite(favorites, del_favorite) | ||
| save_favorites(favorites) | ||
| end |
Oops, something went wrong.