builtin/mainmenu/tab_online.lua

   1 --Minetest
   2 --Copyright (C) 2014 sapier
   3 --
   4 --This program is free software; you can redistribute it and/or modify
   5 --it under the terms of the GNU Lesser General Public License as published by
   6 --the Free Software Foundation; either version 2.1 of the License, or
   7 --(at your option) any later version.
   8 --
   9 --This program is distributed in the hope that it will be useful,
  10 --but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 --MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 --GNU Lesser General Public License for more details.
  13 --
  14 --You should have received a copy of the GNU Lesser General Public License along
  15 --with this program; if not, write to the Free Software Foundation, Inc.,
  16 --51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  17
  18 local function get_sorted_servers()
  19         local servers = {
  20                 fav = {},
  21                 public = {},
  22                 incompatible = {}
  23         }
  24
  25         local favs = serverlistmgr.get_favorites()
  26         local taken_favs = {}
  27         local result = menudata.search_result or serverlistmgr.servers
  28         for _, server in ipairs(result) do
  29                 server.is_favorite = false
  30                 for index, fav in ipairs(favs) do
  31                         if server.address == fav.address and server.port == fav.port then
  32                                 taken_favs[index] = true
  33                                 server.is_favorite = true
  34                                 break
  35                         end
  36                 end
  37                 server.is_compatible = is_server_protocol_compat(server.proto_min, server.proto_max)
  38                 if server.is_favorite then
  39                         table.insert(servers.fav, server)
  40                 elseif server.is_compatible then
  41                         table.insert(servers.public, server)
  42                 else
  43                         table.insert(servers.incompatible, server)
  44                 end
  45         end
  46
  47         if not menudata.search_result then
  48                 for index, fav in ipairs(favs) do
  49                         if not taken_favs[index] then
  50                                 table.insert(servers.fav, fav)
  51                         end
  52                 end
  53         end
  54
  55         return servers
  56 end
  57
  58 local function get_formspec(tabview, name, tabdata)
  59         -- Update the cached supported proto info,
  60         -- it may have changed after a change by the settings menu.
  61         common_update_cached_supp_proto()
  62
  63         if not tabdata.search_for then
  64                 tabdata.search_for = ""
  65         end
  66
  67         local retval =
  68                 -- Search
  69                 "field[0.25,0.25;7,0.75;te_search;;" .. core.formspec_escape(tabdata.search_for) .. "]" ..
  70                 "container[7.25,0.25]" ..
  71                 "image_button[0,0;0.75,0.75;" .. core.formspec_escape(defaulttexturedir .. "search.png") .. ";btn_mp_search;]" ..
  72                 "image_button[0.75,0;0.75,0.75;" .. core.formspec_escape(defaulttexturedir .. "clear.png") .. ";btn_mp_clear;]" ..
  73                 "image_button[1.5,0;0.75,0.75;" .. core.formspec_escape(defaulttexturedir .. "refresh.png") .. ";btn_mp_refresh;]" ..
  74                 "tooltip[btn_mp_clear;" .. fgettext("Clear") .. "]" ..
  75                 "tooltip[btn_mp_search;" .. fgettext("Search") .. "]" ..
  76                 "tooltip[btn_mp_refresh;" .. fgettext("Refresh") .. "]" ..
  77                 "container_end[]" ..
  78
  79                 "container[9.75,0]" ..
  80                 "box[0,0;5.75,7;#666666]" ..
  81
  82                 -- Address / Port
  83                 "label[0.25,0.35;" .. fgettext("Address") .. "]" ..
  84                 "label[4.25,0.35;" .. fgettext("Port") .. "]" ..
  85                 "field[0.25,0.5;4,0.75;te_address;;" ..
  86                         core.formspec_escape(core.settings:get("address")) .. "]" ..
  87                 "field[4.25,0.5;1.25,0.75;te_port;;" ..
  88                         core.formspec_escape(core.settings:get("remote_port")) .. "]" ..
  89
  90                 -- Name / Password
  91                 "label[0.25,1.55;" .. fgettext("Name") .. "]" ..
  92                 "label[3,1.55;" .. fgettext("Password") .. "]" ..
  93                 "field[0.25,1.75;2.75,0.75;te_name;;" ..
  94                         core.formspec_escape(core.settings:get("name")) .. "]" ..
  95                 "pwdfield[3,1.75;2.5,0.75;te_pwd;]" ..
  96
  97                 -- Description Background
  98                 "label[0.25,2.75;" .. fgettext("Server Description") .. "]" ..
  99                 "box[0.25,3;5.25,2.75;#999999]"..
 100
 101                 -- Connect
 102                 "button[3,6;2.5,0.75;btn_mp_connect;" .. fgettext("Connect") .. "]"
 103
 104         if tabdata.selected then
 105                 if gamedata.fav then
 106                         retval = retval .. "button[0.25,6;2.5,0.75;btn_delete_favorite;" ..
 107                                 fgettext("Del. Favorite") .. "]"
 108                 end
 109                 if gamedata.serverdescription then
 110                         retval = retval .. "textarea[0.25,3;5.25,2.75;;;" ..
 111                                 core.formspec_escape(gamedata.serverdescription) .. "]"
 112                 end
 113         end
 114
 115         retval = retval .. "container_end[]"
 116
 117         -- Table
 118         retval = retval .. "tablecolumns[" ..
 119                 "image,tooltip=" .. fgettext("Ping") .. "," ..
 120                 "0=" .. core.formspec_escape(defaulttexturedir .. "blank.png") .. "," ..
 121                 "1=" .. core.formspec_escape(defaulttexturedir .. "server_ping_4.png") .. "," ..
 122                 "2=" .. core.formspec_escape(defaulttexturedir .. "server_ping_3.png") .. "," ..
 123                 "3=" .. core.formspec_escape(defaulttexturedir .. "server_ping_2.png") .. "," ..
 124                 "4=" .. core.formspec_escape(defaulttexturedir .. "server_ping_1.png") .. "," ..
 125                 "5=" .. core.formspec_escape(defaulttexturedir .. "server_favorite.png") .. "," ..
 126                 "6=" .. core.formspec_escape(defaulttexturedir .. "server_public.png") .. "," ..
 127                 "7=" .. core.formspec_escape(defaulttexturedir .. "server_incompatible.png") .. ";" ..
 128                 "color,span=1;" ..
 129                 "text,align=inline;"..
 130                 "color,span=1;" ..
 131                 "text,align=inline,width=4.25;" ..
 132                 "image,tooltip=" .. fgettext("Creative mode") .. "," ..
 133                 "0=" .. core.formspec_escape(defaulttexturedir .. "blank.png") .. "," ..
 134                 "1=" .. core.formspec_escape(defaulttexturedir .. "server_flags_creative.png") .. "," ..
 135                 "align=inline,padding=0.25,width=1.5;" ..
 136                 --~ PvP = Player versus Player
 137                 "image,tooltip=" .. fgettext("Damage / PvP") .. "," ..
 138                 "0=" .. core.formspec_escape(defaulttexturedir .. "blank.png") .. "," ..
 139                 "1=" .. core.formspec_escape(defaulttexturedir .. "server_flags_damage.png") .. "," ..
 140                 "2=" .. core.formspec_escape(defaulttexturedir .. "server_flags_pvp.png") .. "," ..
 141                 "align=inline,padding=0.25,width=1.5;" ..
 142                 "color,align=inline,span=1;" ..
 143                 "text,align=inline,padding=1]" ..
 144                 "table[0.25,1;9.25,5.75;servers;"
 145
 146         local servers = get_sorted_servers()
 147
 148         local dividers = {
 149                 fav = "5,#ffff00," .. fgettext("Favorites") .. ",,,0,0,,",
 150                 public = "6,#4bdd42," .. fgettext("Public Servers") .. ",,,0,0,,",
 151                 incompatible = "7,"..mt_color_grey.."," .. fgettext("Incompatible Servers") .. ",,,0,0,,"
 152         }
 153         local order = {"fav", "public", "incompatible"}
 154
 155         tabdata.lookup = {} -- maps row number to server
 156         local rows = {}
 157         for _, section in ipairs(order) do
 158                 local section_servers = servers[section]
 159                 if next(section_servers) ~= nil then
 160                         rows[#rows + 1] = dividers[section]
 161                         for _, server in ipairs(section_servers) do
 162                                 tabdata.lookup[#rows + 1] = server
 163                                 rows[#rows + 1] = render_serverlist_row(server)
 164                         end
 165                 end
 166         end
 167
 168         retval = retval .. table.concat(rows, ",")
 169
 170         if tabdata.selected then
 171                 retval = retval .. ";" .. tabdata.selected .. "]"
 172         else
 173                 retval = retval .. ";0]"
 174         end
 175
 176         return retval, "size[15.5,7,false]real_coordinates[true]"
 177 end
 178
 179 --------------------------------------------------------------------------------
 180
 181 local function search_server_list(input)
 182         menudata.search_result = nil
 183         if #serverlistmgr.servers < 2 then
 184                 return
 185         end
 186
 187         -- setup the keyword list
 188         local keywords = {}
 189         for word in input:gmatch("%S+") do
 190                 word = word:gsub("(%W)", "%%%1")
 191                 table.insert(keywords, word)
 192         end
 193
 194         if #keywords == 0 then
 195                 return
 196         end
 197
 198         menudata.search_result = {}
 199
 200         -- Search the serverlist
 201         local search_result = {}
 202         for i = 1, #serverlistmgr.servers do
 203                 local server = serverlistmgr.servers[i]
 204                 local found = 0
 205                 for k = 1, #keywords do
 206                         local keyword = keywords[k]
 207                         if server.name then
 208                                 local sername = server.name:lower()
 209                                 local _, count = sername:gsub(keyword, keyword)
 210                                 found = found + count * 4
 211                         end
 212
 213                         if server.description then
 214                                 local desc = server.description:lower()
 215                                 local _, count = desc:gsub(keyword, keyword)
 216                                 found = found + count * 2
 217                         end
 218                 end
 219                 if found > 0 then
 220                         local points = (#serverlistmgr.servers - i) / 5 + found
 221                         server.points = points
 222                         table.insert(search_result, server)
 223                 end
 224         end
 225
 226         if #search_result == 0 then
 227                 return
 228         end
 229
 230         table.sort(search_result, function(a, b)
 231                 return a.points > b.points
 232         end)
 233         menudata.search_result = search_result
 234 end
 235
 236 local function set_selected_server(tabdata, idx, server)
 237         -- reset selection
 238         if idx == nil or server == nil then
 239                 tabdata.selected = nil
 240
 241                 core.settings:set("address", "")
 242                 core.settings:set("remote_port", "30000")
 243                 return
 244         end
 245
 246         local address = server.address
 247         local port    = server.port
 248         gamedata.serverdescription = server.description
 249
 250         gamedata.fav = false
 251         for _, fav in ipairs(serverlistmgr.get_favorites()) do
 252                 if address == fav.address and port == fav.port then
 253                         gamedata.fav = true
 254                         break
 255                 end
 256         end
 257
 258         if address and port then
 259                 core.settings:set("address", address)
 260                 core.settings:set("remote_port", port)
 261         end
 262         tabdata.selected = idx
 263 end
 264
 265 local function main_button_handler(tabview, fields, name, tabdata)
 266         if fields.te_name then
 267                 gamedata.playername = fields.te_name
 268                 core.settings:set("name", fields.te_name)
 269         end
 270
 271         if fields.servers then
 272                 local event = core.explode_table_event(fields.servers)
 273                 local server = tabdata.lookup[event.row]
 274
 275                 if server then
 276                         if event.type == "DCL" then
 277                                 if not is_server_protocol_compat_or_error(
 278                                                         server.proto_min, server.proto_max) then
 279                                         return true
 280                                 end
 281
 282                                 gamedata.address    = server.address
 283                                 gamedata.port       = server.port
 284                                 gamedata.playername = fields.te_name
 285                                 gamedata.selected_world = 0
 286
 287                                 if fields.te_pwd then
 288                                         gamedata.password = fields.te_pwd
 289                                 end
 290
 291                                 gamedata.servername        = server.name
 292                                 gamedata.serverdescription = server.description
 293
 294                                 if gamedata.address and gamedata.port then
 295                                         core.settings:set("address", gamedata.address)
 296                                         core.settings:set("remote_port", gamedata.port)
 297                                         core.start()
 298                                 end
 299                                 return true
 300                         end
 301                         if event.type == "CHG" then
 302                                 set_selected_server(tabdata, event.row, server)
 303                                 return true
 304                         end
 305                 end
 306         end
 307
 308         if fields.btn_delete_favorite then
 309                 local idx = core.get_table_index("servers")
 310                 if not idx then return end
 311                 local server = tabdata.lookup[idx]
 312                 if not server then return end
 313
 314                 serverlistmgr.delete_favorite(server)
 315                 -- the server at [idx+1] will be at idx once list is refreshed
 316                 set_selected_server(tabdata, idx, tabdata.lookup[idx+1])
 317                 return true
 318         end
 319
 320         if fields.btn_mp_clear then
 321                 tabdata.search_for = ""
 322                 menudata.search_result = nil
 323                 return true
 324         end
 325
 326         if fields.btn_mp_search or fields.key_enter_field == "te_search" then
 327                 tabdata.search_for = fields.te_search
 328                 search_server_list(fields.te_search:lower())
 329                 if menudata.search_result then
 330                         -- first server in row 2 due to header
 331                         set_selected_server(tabdata, 2, menudata.search_result[1])
 332                 end
 333
 334                 return true
 335         end
 336
 337         if fields.btn_mp_refresh then
 338                 serverlistmgr.sync()
 339                 return true
 340         end
 341
 342         if (fields.btn_mp_connect or fields.key_enter)
 343                         and fields.te_address ~= "" and fields.te_port then
 344                 gamedata.playername = fields.te_name
 345                 gamedata.password   = fields.te_pwd
 346                 gamedata.address    = fields.te_address
 347                 gamedata.port       = tonumber(fields.te_port)
 348                 gamedata.selected_world = 0
 349
 350                 local idx = core.get_table_index("servers")
 351                 local server = idx and tabdata.lookup[idx]
 352
 353                 set_selected_server(tabdata)
 354
 355                 if server and server.address == gamedata.address and
 356                                 server.port == gamedata.port then
 357
 358                         serverlistmgr.add_favorite(server)
 359
 360                         gamedata.servername        = server.name
 361                         gamedata.serverdescription = server.description
 362
 363                         if not is_server_protocol_compat_or_error(
 364                                                 server.proto_min, server.proto_max) then
 365                                 return true
 366                         end
 367                 else
 368                         gamedata.servername        = ""
 369                         gamedata.serverdescription = ""
 370
 371                         serverlistmgr.add_favorite({
 372                                 address = gamedata.address,
 373                                 port = gamedata.port,
 374                         })
 375                 end
 376
 377                 core.settings:set("address",     gamedata.address)
 378                 core.settings:set("remote_port", gamedata.port)
 379
 380                 core.start()
 381                 return true
 382         end
 383
 384         return false
 385 end
 386
 387 local function on_change(type, old_tab, new_tab)
 388         if type == "LEAVE" then return end
 389         serverlistmgr.sync()
 390 end
 391
 392 return {
 393         name = "online",
 394         caption = fgettext("Join Game"),
 395         cbf_formspec = get_formspec,
 396         cbf_button_handler = main_button_handler,
 397         on_change = on_change
 398 }