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                 -- Description Background
  91                 "label[0.25,1.6;" .. fgettext("Server Description") .. "]" ..
  92                 "box[0.25,1.85;5.25,2.7;#999999]"..
  93
  94                 -- Name / Password
  95                 "container[0,4.8]" ..
  96                 "label[0.25,0;" .. fgettext("Name") .. "]" ..
  97                 "label[2.875,0;" .. fgettext("Password") .. "]" ..
  98                 "field[0.25,0.2;2.625,0.75;te_name;;" .. core.formspec_escape(core.settings:get("name")) .. "]" ..
  99                 "pwdfield[2.875,0.2;2.625,0.75;te_pwd;]" ..
 100                 "container_end[]" ..
 101
 102                 -- Connect
 103                 "button[3,6;2.5,0.75;btn_mp_login;" .. fgettext("Login") .. "]"
 104
 105         if core.settings:get_bool("enable_split_login_register") then
 106                 retval = retval .. "button[0.25,6;2.5,0.75;btn_mp_register;" .. fgettext("Register") .. "]"
 107         end
 108
 109         if tabdata.selected then
 110                 if gamedata.fav then
 111                         retval = retval .. "tooltip[btn_delete_favorite;" .. fgettext("Remove favorite") .. "]"
 112                         retval = retval .. "style[btn_delete_favorite;padding=6]"
 113                         retval = retval .. "image_button[5,1.3;0.5,0.5;" .. core.formspec_escape(defaulttexturedir ..
 114                                 "server_favorite_delete.png") .. ";btn_delete_favorite;]"
 115                 end
 116                 if gamedata.serverdescription then
 117                         retval = retval .. "textarea[0.25,1.85;5.2,2.75;;;" ..
 118                                 core.formspec_escape(gamedata.serverdescription) .. "]"
 119                 end
 120         end
 121
 122         retval = retval .. "container_end[]"
 123
 124         -- Table
 125         retval = retval .. "tablecolumns[" ..
 126                 "image,tooltip=" .. fgettext("Ping") .. "," ..
 127                 "0=" .. core.formspec_escape(defaulttexturedir .. "blank.png") .. "," ..
 128                 "1=" .. core.formspec_escape(defaulttexturedir .. "server_ping_4.png") .. "," ..
 129                 "2=" .. core.formspec_escape(defaulttexturedir .. "server_ping_3.png") .. "," ..
 130                 "3=" .. core.formspec_escape(defaulttexturedir .. "server_ping_2.png") .. "," ..
 131                 "4=" .. core.formspec_escape(defaulttexturedir .. "server_ping_1.png") .. "," ..
 132                 "5=" .. core.formspec_escape(defaulttexturedir .. "server_favorite.png") .. "," ..
 133                 "6=" .. core.formspec_escape(defaulttexturedir .. "server_public.png") .. "," ..
 134                 "7=" .. core.formspec_escape(defaulttexturedir .. "server_incompatible.png") .. ";" ..
 135                 "color,span=1;" ..
 136                 "text,align=inline;"..
 137                 "color,span=1;" ..
 138                 "text,align=inline,width=4.25;" ..
 139                 "image,tooltip=" .. fgettext("Creative mode") .. "," ..
 140                 "0=" .. core.formspec_escape(defaulttexturedir .. "blank.png") .. "," ..
 141                 "1=" .. core.formspec_escape(defaulttexturedir .. "server_flags_creative.png") .. "," ..
 142                 "align=inline,padding=0.25,width=1.5;" ..
 143                 --~ PvP = Player versus Player
 144                 "image,tooltip=" .. fgettext("Damage / PvP") .. "," ..
 145                 "0=" .. core.formspec_escape(defaulttexturedir .. "blank.png") .. "," ..
 146                 "1=" .. core.formspec_escape(defaulttexturedir .. "server_flags_damage.png") .. "," ..
 147                 "2=" .. core.formspec_escape(defaulttexturedir .. "server_flags_pvp.png") .. "," ..
 148                 "align=inline,padding=0.25,width=1.5;" ..
 149                 "color,align=inline,span=1;" ..
 150                 "text,align=inline,padding=1]" ..
 151                 "table[0.25,1;9.25,5.75;servers;"
 152
 153         local servers = get_sorted_servers()
 154
 155         local dividers = {
 156                 fav = "5,#ffff00," .. fgettext("Favorites") .. ",,,0,0,,",
 157                 public = "6,#4bdd42," .. fgettext("Public Servers") .. ",,,0,0,,",
 158                 incompatible = "7,"..mt_color_grey.."," .. fgettext("Incompatible Servers") .. ",,,0,0,,"
 159         }
 160         local order = {"fav", "public", "incompatible"}
 161
 162         tabdata.lookup = {} -- maps row number to server
 163         local rows = {}
 164         for _, section in ipairs(order) do
 165                 local section_servers = servers[section]
 166                 if next(section_servers) ~= nil then
 167                         rows[#rows + 1] = dividers[section]
 168                         for _, server in ipairs(section_servers) do
 169                                 tabdata.lookup[#rows + 1] = server
 170                                 rows[#rows + 1] = render_serverlist_row(server)
 171                         end
 172                 end
 173         end
 174
 175         retval = retval .. table.concat(rows, ",")
 176
 177         if tabdata.selected then
 178                 retval = retval .. ";" .. tabdata.selected .. "]"
 179         else
 180                 retval = retval .. ";0]"
 181         end
 182
 183         return retval, "size[15.5,7,false]real_coordinates[true]"
 184 end
 185
 186 --------------------------------------------------------------------------------
 187
 188 local function search_server_list(input)
 189         menudata.search_result = nil
 190         if #serverlistmgr.servers < 2 then
 191                 return
 192         end
 193
 194         -- setup the keyword list
 195         local keywords = {}
 196         for word in input:gmatch("%S+") do
 197                 word = word:gsub("(%W)", "%%%1")
 198                 table.insert(keywords, word)
 199         end
 200
 201         if #keywords == 0 then
 202                 return
 203         end
 204
 205         menudata.search_result = {}
 206
 207         -- Search the serverlist
 208         local search_result = {}
 209         for i = 1, #serverlistmgr.servers do
 210                 local server = serverlistmgr.servers[i]
 211                 local found = 0
 212                 for k = 1, #keywords do
 213                         local keyword = keywords[k]
 214                         if server.name then
 215                                 local sername = server.name:lower()
 216                                 local _, count = sername:gsub(keyword, keyword)
 217                                 found = found + count * 4
 218                         end
 219
 220                         if server.description then
 221                                 local desc = server.description:lower()
 222                                 local _, count = desc:gsub(keyword, keyword)
 223                                 found = found + count * 2
 224                         end
 225                 end
 226                 if found > 0 then
 227                         local points = (#serverlistmgr.servers - i) / 5 + found
 228                         server.points = points
 229                         table.insert(search_result, server)
 230                 end
 231         end
 232
 233         if #search_result == 0 then
 234                 return
 235         end
 236
 237         table.sort(search_result, function(a, b)
 238                 return a.points > b.points
 239         end)
 240         menudata.search_result = search_result
 241 end
 242
 243 local function set_selected_server(tabdata, idx, server)
 244         -- reset selection
 245         if idx == nil or server == nil then
 246                 tabdata.selected = nil
 247
 248                 core.settings:set("address", "")
 249                 core.settings:set("remote_port", "30000")
 250                 return
 251         end
 252
 253         local address = server.address
 254         local port    = server.port
 255         gamedata.serverdescription = server.description
 256
 257         gamedata.fav = false
 258         for _, fav in ipairs(serverlistmgr.get_favorites()) do
 259                 if address == fav.address and port == fav.port then
 260                         gamedata.fav = true
 261                         break
 262                 end
 263         end
 264
 265         if address and port then
 266                 core.settings:set("address", address)
 267                 core.settings:set("remote_port", port)
 268         end
 269         tabdata.selected = idx
 270 end
 271
 272 local function main_button_handler(tabview, fields, name, tabdata)
 273         if fields.te_name then
 274                 gamedata.playername = fields.te_name
 275                 core.settings:set("name", fields.te_name)
 276         end
 277
 278         if fields.servers then
 279                 local event = core.explode_table_event(fields.servers)
 280                 local server = tabdata.lookup[event.row]
 281
 282                 if server then
 283                         if event.type == "DCL" then
 284                                 if not is_server_protocol_compat_or_error(
 285                                                         server.proto_min, server.proto_max) then
 286                                         return true
 287                                 end
 288
 289                                 gamedata.address    = server.address
 290                                 gamedata.port       = server.port
 291                                 gamedata.playername = fields.te_name
 292                                 gamedata.selected_world = 0
 293
 294                                 if fields.te_pwd then
 295                                         gamedata.password = fields.te_pwd
 296                                 end
 297
 298                                 gamedata.servername        = server.name
 299                                 gamedata.serverdescription = server.description
 300
 301                                 if gamedata.address and gamedata.port then
 302                                         core.settings:set("address", gamedata.address)
 303                                         core.settings:set("remote_port", gamedata.port)
 304                                         core.start()
 305                                 end
 306                                 return true
 307                         end
 308                         if event.type == "CHG" then
 309                                 set_selected_server(tabdata, event.row, server)
 310                                 return true
 311                         end
 312                 end
 313         end
 314
 315         if fields.btn_delete_favorite then
 316                 local idx = core.get_table_index("servers")
 317                 if not idx then return end
 318                 local server = tabdata.lookup[idx]
 319                 if not server then return end
 320
 321                 serverlistmgr.delete_favorite(server)
 322                 -- the server at [idx+1] will be at idx once list is refreshed
 323                 set_selected_server(tabdata, idx, tabdata.lookup[idx+1])
 324                 return true
 325         end
 326
 327         if fields.btn_mp_clear then
 328                 tabdata.search_for = ""
 329                 menudata.search_result = nil
 330                 return true
 331         end
 332
 333         if fields.btn_mp_search or fields.key_enter_field == "te_search" then
 334                 tabdata.search_for = fields.te_search
 335                 search_server_list(fields.te_search:lower())
 336                 if menudata.search_result then
 337                         -- first server in row 2 due to header
 338                         set_selected_server(tabdata, 2, menudata.search_result[1])
 339                 end
 340
 341                 return true
 342         end
 343
 344         if fields.btn_mp_refresh then
 345                 serverlistmgr.sync()
 346                 return true
 347         end
 348
 349         if (fields.btn_mp_login or fields.key_enter)
 350                         and fields.te_address ~= "" and fields.te_port then
 351                 gamedata.playername = fields.te_name
 352                 gamedata.password   = fields.te_pwd
 353                 gamedata.address    = fields.te_address
 354                 gamedata.port       = tonumber(fields.te_port)
 355
 356                 local enable_split_login_register = core.settings:get_bool("enable_split_login_register")
 357                 gamedata.allow_login_or_register = enable_split_login_register and "login" or "any"
 358                 gamedata.selected_world = 0
 359
 360                 local idx = core.get_table_index("servers")
 361                 local server = idx and tabdata.lookup[idx]
 362
 363                 set_selected_server(tabdata)
 364
 365                 if server and server.address == gamedata.address and
 366                                 server.port == gamedata.port then
 367
 368                         serverlistmgr.add_favorite(server)
 369
 370                         gamedata.servername        = server.name
 371                         gamedata.serverdescription = server.description
 372
 373                         if not is_server_protocol_compat_or_error(
 374                                                 server.proto_min, server.proto_max) then
 375                                 return true
 376                         end
 377                 else
 378                         gamedata.servername        = ""
 379                         gamedata.serverdescription = ""
 380
 381                         serverlistmgr.add_favorite({
 382                                 address = gamedata.address,
 383                                 port = gamedata.port,
 384                         })
 385                 end
 386
 387                 core.settings:set("address",     gamedata.address)
 388                 core.settings:set("remote_port", gamedata.port)
 389
 390                 core.start()
 391                 return true
 392         end
 393
 394         if fields.btn_mp_register and fields.te_address ~= "" and fields.te_port then
 395                 local idx = core.get_table_index("servers")
 396                 local server = idx and tabdata.lookup[idx]
 397                 if server and (server.address ~= fields.te_address or server.port ~= tonumber(fields.te_port)) then
 398                         server = nil
 399                 end
 400
 401                 if server and not is_server_protocol_compat_or_error(
 402                                         server.proto_min, server.proto_max) then
 403                         return true
 404                 end
 405
 406                 local dlg = create_register_dialog(fields.te_address, tonumber(fields.te_port), server)
 407                 dlg:set_parent(tabview)
 408                 tabview:hide()
 409                 dlg:show()
 410                 return true
 411         end
 412
 413         return false
 414 end
 415
 416 local function on_change(type, old_tab, new_tab)
 417         if type == "LEAVE" then return end
 418         serverlistmgr.sync()
 419 end
 420
 421 return {
 422         name = "online",
 423         caption = fgettext("Join Game"),
 424         cbf_formspec = get_formspec,
 425         cbf_button_handler = main_button_handler,
 426         on_change = on_change
 427 }