Add keyword based search to serverlist
[oweals/minetest.git] / builtin / mainmenu / tab_multiplayer.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 --------------------------------------------------------------------------------
19 local function get_formspec(tabview, name, tabdata)
20         -- Update the cached supported proto info,
21         -- it may have changed after a change by the settings menu.
22         common_update_cached_supp_proto()
23         local fav_selected = nil
24         if menudata.search_result then
25                 fav_selected = menudata.search_result[tabdata.fav_selected]
26         else
27                 fav_selected = menudata.favorites[tabdata.fav_selected]
28         end
29
30         if not tabdata.search_for then
31                 tabdata.search_for = ""
32         end
33
34         local retval =
35                 "label[7.75,-0.15;" .. fgettext("Address / Port") .. "]" ..
36                 "label[7.75,1.05;" .. fgettext("Name / Password") .. "]" ..
37                 "field[8,0.75;3.3,0.5;te_address;;" ..
38                         core.formspec_escape(core.setting_get("address")) .. "]" ..
39                 "field[11.15,0.75;1.4,0.5;te_port;;" ..
40                         core.formspec_escape(core.setting_get("remote_port")) .. "]" ..
41                 "button[10.1,4.9;2,0.5;btn_mp_connect;" .. fgettext("Connect") .. "]" ..
42                 "field[8,1.95;2.95,0.5;te_name;;" ..
43                         core.formspec_escape(core.setting_get("name")) .. "]" ..
44                 "pwdfield[10.78,1.95;1.77,0.5;te_pwd;]" ..
45                 "box[7.73,2.35;4.3,2.28;#999999]"..
46                 "field[0.15,0.25;4.5,0.27;te_search;;"..core.formspec_escape(tabdata.search_for).."]"..
47                 "button[4.8,0;2.7,0.1;btn_mp_search;" .. fgettext("Search") .. "]"
48
49         if tabdata.fav_selected and fav_selected then
50                 if gamedata.fav then
51                         retval = retval .. "button[7.85,4.9;2.3,0.5;btn_delete_favorite;" ..
52                                 fgettext("Del. Favorite") .. "]"
53                 end
54                 if fav_selected.description then
55                         retval = retval .. "textarea[8.1,2.4;4.26,2.6;;" ..
56                                 core.formspec_escape((gamedata.serverdescription or ""), true) .. ";]"
57                 end
58         end
59
60         --favourites
61         retval = retval .. "tablecolumns[" ..
62                 image_column(fgettext("Favorite"), "favorite") .. ";" ..
63                 "color,span=3;" ..
64                 "text,align=right;" ..                -- clients
65                 "text,align=center,padding=0.25;" ..  -- "/"
66                 "text,align=right,padding=0.25;" ..   -- clients_max
67                 image_column(fgettext("Creative mode"), "creative") .. ",padding=1;" ..
68                 image_column(fgettext("Damage enabled"), "damage") .. ",padding=0.25;" ..
69                 image_column(fgettext("PvP enabled"), "pvp") .. ",padding=0.25;" ..
70                 "color,span=1;" ..
71                 "text,padding=1]" ..
72                 "table[-0.15,0.4;7.75,5.35;favourites;"
73
74         if menudata.search_result then
75                 for i = 1, #menudata.search_result do
76                         local favs = core.get_favorites("local")
77                         local server = menudata.search_result[i]
78
79                         for fav_id = 1, #favs do
80                                 if server.address == favs[fav_id].address and
81                                                 server.port == favs[fav_id].port then
82                                         server.is_favorite = true
83                                 end
84                         end
85
86                         if i ~= 1 then
87                                 retval = retval .. ","
88                         end
89
90                         retval = retval .. render_serverlist_row(server, server.is_favorite)
91                 end
92         elseif #menudata.favorites > 0 then
93                 local favs = core.get_favorites("local")
94                 if #favs > 0 then
95                         for i = 1, #favs do
96                         for j = 1, #menudata.favorites do
97                                 if menudata.favorites[j].address == favs[i].address and
98                                                 menudata.favorites[j].port == favs[i].port then
99                                         table.insert(menudata.favorites, i, table.remove(menudata.favorites, j))
100                                 end
101                         end
102                                 if favs[i].address ~= menudata.favorites[i].address then
103                                         table.insert(menudata.favorites, i, favs[i])
104                                 end
105                         end
106                 end
107                 retval = retval .. render_serverlist_row(menudata.favorites[1], (#favs > 0))
108                 for i = 2, #menudata.favorites do
109                         retval = retval .. "," .. render_serverlist_row(menudata.favorites[i], (i <= #favs))
110                 end
111         end
112
113         if tabdata.fav_selected then
114                 retval = retval .. ";" .. tabdata.fav_selected .. "]"
115         else
116                 retval = retval .. ";0]"
117         end
118
119         return retval
120 end
121
122 --------------------------------------------------------------------------------
123 local function main_button_handler(tabview, fields, name, tabdata)
124         local serverlist = menudata.search_result or menudata.favorites
125
126         if fields.te_name then
127                 gamedata.playername = fields.te_name
128                 core.setting_set("name", fields.te_name)
129         end
130
131         if fields.favourites then
132                 local event = core.explode_table_event(fields.favourites)
133                 local fav = serverlist[event.row]
134
135                 if event.type == "DCL" then
136                         if event.row <= #serverlist then
137                                 if menudata.favorites_is_public and
138                                                 not is_server_protocol_compat_or_error(
139                                                         fav.proto_min, fav.proto_max) then
140                                         return true
141                                 end
142
143                                 gamedata.address    = fav.address
144                                 gamedata.port       = fav.port
145                                 gamedata.playername = fields.te_name
146                                 gamedata.selected_world = 0
147
148                                 if fields.te_pwd then
149                                         gamedata.password = fields.te_pwd
150                                 end
151
152                                 gamedata.servername        = fav.name
153                                 gamedata.serverdescription = fav.description
154
155                                 if gamedata.address and gamedata.port then
156                                         core.setting_set("address", gamedata.address)
157                                         core.setting_set("remote_port", gamedata.port)
158                                         core.start()
159                                 end
160                         end
161                         return true
162                 end
163
164                 if event.type == "CHG" then
165                         if event.row <= #serverlist then
166                                 gamedata.fav = false
167                                 local favs = core.get_favorites("local")
168                                 local address = fav.address
169                                 local port    = fav.port
170                                 gamedata.serverdescription = fav.description
171
172                                 for i = 1, #favs do
173                                         if fav.address == favs[i].address and
174                                                         fav.port == favs[i].port then
175                                                 gamedata.fav = true
176                                         end
177                                 end
178
179                                 if address and port then
180                                         core.setting_set("address", address)
181                                         core.setting_set("remote_port", port)
182                                 end
183                                 tabdata.fav_selected = event.row
184                         end
185                         return true
186                 end
187         end
188
189         if fields.key_up or fields.key_down then
190                 local fav_idx = core.get_table_index("favourites")
191                 local fav = serverlist[fav_idx]
192
193                 if fav_idx then
194                         if fields.key_up and fav_idx > 1 then
195                                 fav_idx = fav_idx - 1
196                         elseif fields.key_down and fav_idx < #menudata.favorites then
197                                 fav_idx = fav_idx + 1
198                         end
199                 else
200                         fav_idx = 1
201                 end
202
203                 if not menudata.favorites or not fav then
204                         tabdata.fav_selected = 0
205                         return true
206                 end
207
208                 local address = fav.address
209                 local port    = fav.port
210                 gamedata.serverdescription = fav.description
211                 if address and port then
212                         core.setting_set("address", address)
213                         core.setting_set("remote_port", port)
214                 end
215
216                 tabdata.fav_selected = fav_idx
217                 return true
218         end
219
220         if fields.btn_delete_favorite then
221                 local current_favourite = core.get_table_index("favourites")
222                 if not current_favourite then return end
223
224                 core.delete_favorite(current_favourite)
225                 asyncOnlineFavourites()
226                 tabdata.fav_selected = nil
227
228                 core.setting_set("address", "")
229                 core.setting_set("remote_port", "30000")
230                 return true
231         end
232
233         if fields.btn_mp_search or fields.key_enter_field == "te_search" then
234                 tabdata.fav_selected = 1
235                 local input = fields.te_search:lower()
236                 tabdata.search_for = fields.te_search
237
238                 if #menudata.favorites < 2 then
239                         return true
240                 end
241
242                 menudata.search_result = {}
243
244                 -- setup the keyword list
245                 local keywords = {}
246                 for word in input:gmatch("%S+") do
247                         table.insert(keywords, word)
248                 end
249
250                 if #keywords == 0 then
251                         menudata.search_result = nil
252                         return true
253                 end
254
255                 -- Search the serverlist
256                 local search_result = {}
257                 for i = 1, #menudata.favorites do
258                         local server = menudata.favorites[i]
259                         local found = 0
260                         for k = 1, #keywords do
261                                 local keyword = keywords[k]
262                                 if server.name then
263                                         local name = server.name:lower()
264                                         local _, count = name:gsub(keyword, keyword)
265                                         found = found + count * 4
266                                 end
267
268                                 if server.description then
269                                         local desc = server.description:lower()
270                                         local _, count = desc:gsub(keyword, keyword)
271                                         found = found + count * 2
272                                 end
273                         end
274                         if found > 0 then
275                                 local points = (#menudata.favorites - i) / 5 + found
276                                 server.points = points
277                                 table.insert(search_result, server)
278                         end
279                 end
280                 if #search_result > 0 then
281                         table.sort(search_result, function(a, b)
282                                 return a.points > b.points
283                         end)
284                         menudata.search_result = search_result
285                         local first_server = search_result[1]
286                         core.setting_set("address",     first_server.address)
287                         core.setting_set("remote_port", first_server.port)
288                 end
289                 return true
290         end
291
292         if (fields.btn_mp_connect or fields.key_enter) and fields.te_address and fields.te_port then
293                 gamedata.playername = fields.te_name
294                 gamedata.password   = fields.te_pwd
295                 gamedata.address    = fields.te_address
296                 gamedata.port       = fields.te_port
297                 gamedata.selected_world = 0
298                 local fav_idx = core.get_table_index("favourites")
299                 local fav = serverlist[fav_idx]
300
301                 if fav_idx and fav_idx <= #serverlist and
302                                 fav.address == fields.te_address and
303                                 fav.port    == fields.te_port then
304
305                         gamedata.servername        = fav.name
306                         gamedata.serverdescription = fav.description
307
308                         if menudata.favorites_is_public and
309                                         not is_server_protocol_compat_or_error(
310                                                 fav.proto_min, fav.proto_max) then
311                                 return true
312                         end
313                 else
314                         gamedata.servername        = ""
315                         gamedata.serverdescription = ""
316                 end
317
318                 core.setting_set("address",     fields.te_address)
319                 core.setting_set("remote_port", fields.te_port)
320
321                 core.start()
322                 return true
323         end
324         return false
325 end
326
327 local function on_change(type, old_tab, new_tab)
328         if type == "LEAVE" then return end
329         asyncOnlineFavourites()
330 end
331
332 --------------------------------------------------------------------------------
333 return {
334         name = "multiplayer",
335         caption = fgettext("Client"),
336         cbf_formspec = get_formspec,
337         cbf_button_handler = main_button_handler,
338         on_change = on_change
339 }