builtin/mainmenu/dlg_contentstore.lua

   1 --Minetest
   2 --Copyright (C) 2018-20 rubenwardy
   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 if not minetest.get_http_api then
  19         function create_store_dlg()
  20                 return messagebox("store",
  21                                 fgettext("ContentDB is not available when Minetest was compiled without cURL"))
  22         end
  23         return
  24 end
  25
  26 local store = { packages = {}, packages_full = {} }
  27
  28 local http = minetest.get_http_api()
  29
  30 -- Screenshot
  31 local screenshot_dir = core.get_cache_path() .. DIR_DELIM .. "cdb"
  32 assert(core.create_dir(screenshot_dir))
  33 local screenshot_downloading = {}
  34 local screenshot_downloaded = {}
  35
  36 -- Filter
  37 local search_string = ""
  38 local cur_page = 1
  39 local num_per_page = 5
  40 local filter_type = 1
  41 local filter_types_titles = {
  42         fgettext("All packages"),
  43         fgettext("Games"),
  44         fgettext("Mods"),
  45         fgettext("Texture packs"),
  46 }
  47
  48 local filter_types_type = {
  49         nil,
  50         "game",
  51         "mod",
  52         "txp",
  53 }
  54
  55
  56 local function download_package(param)
  57         if core.download_file(param.package.url, param.filename) then
  58                 return {
  59                         filename = param.filename,
  60                         successful = true,
  61                 }
  62         else
  63                 core.log("error", "downloading " .. dump(param.package.url) .. " failed")
  64                 return {
  65                         successful = false,
  66                 }
  67         end
  68 end
  69
  70 local function start_install(calling_dialog, package)
  71         local params = {
  72                 package = package,
  73                 filename = os.tempfolder() .. "_MODNAME_" .. package.name .. ".zip",
  74         }
  75
  76         local function callback(result)
  77                 if result.successful then
  78                         local path, msg = pkgmgr.install(package.type,
  79                                         result.filename, package.name,
  80                                         package.path)
  81                         if not path then
  82                                 gamedata.errormessage = msg
  83                         else
  84                                 core.log("action", "Installed package to " .. path)
  85
  86                                 local conf_path
  87                                 local name_is_title = false
  88                                 if package.type == "mod" then
  89                                         local actual_type = pkgmgr.get_folder_type(path)
  90                                         if actual_type.type == "modpack" then
  91                                                 conf_path = path .. DIR_DELIM .. "modpack.conf"
  92                                         else
  93                                                 conf_path = path .. DIR_DELIM .. "mod.conf"
  94                                         end
  95                                 elseif package.type == "game" then
  96                                         conf_path = path .. DIR_DELIM .. "game.conf"
  97                                         name_is_title = true
  98                                 elseif package.type == "txp" then
  99                                         conf_path = path .. DIR_DELIM .. "texture_pack.conf"
 100                                 end
 101
 102                                 if conf_path then
 103                                         local conf = Settings(conf_path)
 104                                         if name_is_title then
 105                                                 conf:set("name",   package.title)
 106                                         else
 107                                                 conf:set("title",  package.title)
 108                                                 conf:set("name",   package.name)
 109                                         end
 110                                         if not conf:get("description") then
 111                                                 conf:set("description", package.short_description)
 112                                         end
 113                                         conf:set("author",     package.author)
 114                                         conf:set("release",    package.release)
 115                                         conf:write()
 116                                 end
 117                         end
 118                         os.remove(result.filename)
 119                 else
 120                         gamedata.errormessage = fgettext("Failed to download $1", package.name)
 121                 end
 122
 123                 package.downloading = false
 124                 ui.update()
 125         end
 126
 127         package.downloading = true
 128
 129         if not core.handle_async(download_package, params, callback) then
 130                 core.log("error", "ERROR: async event failed")
 131                 gamedata.errormessage = fgettext("Failed to download $1", package.name)
 132                 return
 133         end
 134 end
 135
 136 local function get_screenshot(package)
 137         if not package.thumbnail then
 138                 return defaulttexturedir .. "no_screenshot.png"
 139         elseif screenshot_downloading[package.thumbnail] then
 140                 return defaulttexturedir .. "loading_screenshot.png"
 141         end
 142
 143         -- Get tmp screenshot path
 144         local filepath = screenshot_dir .. DIR_DELIM ..
 145                 package.type .. "-" .. package.author .. "-" .. package.name .. ".png"
 146
 147         -- Return if already downloaded
 148         local file = io.open(filepath, "r")
 149         if file then
 150                 file:close()
 151                 return filepath
 152         end
 153
 154         -- Show error if we've failed to download before
 155         if screenshot_downloaded[package.thumbnail] then
 156                 return defaulttexturedir .. "error_screenshot.png"
 157         end
 158
 159         -- Download
 160
 161         local function download_screenshot(params)
 162                 return core.download_file(params.url, params.dest)
 163         end
 164         local function callback(success)
 165                 screenshot_downloading[package.thumbnail] = nil
 166                 screenshot_downloaded[package.thumbnail] = true
 167                 if not success then
 168                         core.log("warning", "Screenshot download failed for some reason")
 169                 end
 170                 ui.update()
 171         end
 172         if core.handle_async(download_screenshot,
 173                         { dest = filepath, url = package.thumbnail }, callback) then
 174                 screenshot_downloading[package.thumbnail] = true
 175         else
 176                 core.log("error", "ERROR: async event failed")
 177                 return defaulttexturedir .. "error_screenshot.png"
 178         end
 179
 180         return defaulttexturedir .. "loading_screenshot.png"
 181 end
 182
 183 function store.load()
 184         local version = core.get_version()
 185         local base_url = core.settings:get("contentdb_url")
 186         local url = base_url ..
 187                 "/api/packages/?type=mod&type=game&type=txp&protocol_version=" ..
 188                 core.get_max_supp_proto() .. "&engine_version=" .. version.string
 189
 190         for _, item in pairs(core.settings:get("contentdb_flag_blacklist"):split(",")) do
 191                 item = item:trim()
 192                 if item ~= "" then
 193                         url = url .. "&hide=" .. item
 194                 end
 195         end
 196
 197         local timeout = tonumber(minetest.settings:get("curl_file_download_timeout"))
 198         local response = http.fetch_sync({ url = url, timeout = timeout })
 199         if not response.succeeded then
 200                 return
 201         end
 202
 203         store.packages_full = core.parse_json(response.data) or {}
 204
 205         for _, package in pairs(store.packages_full) do
 206                 package.url = base_url .. "/packages/" ..
 207                                 package.author .. "/" .. package.name ..
 208                                 "/releases/" .. package.release .. "/download/"
 209
 210                 local name_len = #package.name
 211                 if package.type == "game" and name_len > 5 and package.name:sub(name_len - 4) == "_game" then
 212                         package.id = package.author:lower() .. "/" .. package.name:sub(1, name_len - 5)
 213                 else
 214                         package.id = package.author:lower() .. "/" .. package.name
 215                 end
 216         end
 217
 218         store.packages = store.packages_full
 219         store.loaded = true
 220 end
 221
 222 function store.update_paths()
 223         local mod_hash = {}
 224         pkgmgr.refresh_globals()
 225         for _, mod in pairs(pkgmgr.global_mods:get_list()) do
 226                 if mod.author then
 227                         mod_hash[mod.author:lower() .. "/" .. mod.name] = mod
 228                 end
 229         end
 230
 231         local game_hash = {}
 232         pkgmgr.update_gamelist()
 233         for _, game in pairs(pkgmgr.games) do
 234                 if game.author ~= "" then
 235                         game_hash[game.author:lower() .. "/" .. game.id] = game
 236                 end
 237         end
 238
 239         local txp_hash = {}
 240         for _, txp in pairs(pkgmgr.get_texture_packs()) do
 241                 if txp.author then
 242                         txp_hash[txp.author:lower() .. "/" .. txp.name] = txp
 243                 end
 244         end
 245
 246         for _, package in pairs(store.packages_full) do
 247                 local content
 248                 if package.type == "mod" then
 249                         content = mod_hash[package.id]
 250                 elseif package.type == "game" then
 251                         content = game_hash[package.id]
 252                 elseif package.type == "txp" then
 253                         content = txp_hash[package.id]
 254                 end
 255
 256                 if content then
 257                         package.path = content.path
 258                         package.installed_release = content.release or 0
 259                 else
 260                         package.path = nil
 261                 end
 262         end
 263 end
 264
 265 function store.filter_packages(query)
 266         if query == "" and filter_type == 1 then
 267                 store.packages = store.packages_full
 268                 return
 269         end
 270
 271         local keywords = {}
 272         for word in query:lower():gmatch("%S+") do
 273                 table.insert(keywords, word)
 274         end
 275
 276         local function matches_keywords(package, keywords)
 277                 for k = 1, #keywords do
 278                         local keyword = keywords[k]
 279
 280                         if string.find(package.name:lower(), keyword, 1, true) or
 281                                         string.find(package.title:lower(), keyword, 1, true) or
 282                                         string.find(package.author:lower(), keyword, 1, true) or
 283                                         string.find(package.short_description:lower(), keyword, 1, true) then
 284                                 return true
 285                         end
 286                 end
 287
 288                 return false
 289         end
 290
 291         store.packages = {}
 292         for _, package in pairs(store.packages_full) do
 293                 if (query == "" or matches_keywords(package, keywords)) and
 294                                 (filter_type == 1 or package.type == filter_types_type[filter_type]) then
 295                         store.packages[#store.packages + 1] = package
 296                 end
 297         end
 298
 299 end
 300
 301 function store.get_formspec(dlgdata)
 302         store.update_paths()
 303
 304         dlgdata.pagemax = math.max(math.ceil(#store.packages / num_per_page), 1)
 305         if cur_page > dlgdata.pagemax then
 306                 cur_page = 1
 307         end
 308
 309         local W = 15.75
 310         local H = 9.5
 311
 312         local formspec
 313         if #store.packages_full > 0 then
 314                 formspec = {
 315                         "formspec_version[3]",
 316                         "size[15.75,9.5]",
 317                         "position[0.5,0.55]",
 318                         "container[0.375,0.375]",
 319                         "field[0,0;10.225,0.8;search_string;;", core.formspec_escape(search_string), "]",
 320                         "field_close_on_enter[search_string;false]",
 321                         "button[10.225,0;2,0.8;search;", fgettext("Search"), "]",
 322                         "dropdown[12.6,0;2.4,0.8;type;", table.concat(filter_types_titles, ","), ";", filter_type, "]",
 323                         "container_end[]",
 324
 325                         -- Page nav buttons
 326                         "container[0,", H - 0.8 - 0.375, "]",
 327                         "button[0.375,0;4,0.8;back;", fgettext("Back to Main Menu"), "]",
 328
 329                         "container[", W - 0.375 - 0.8*4 - 2,  ",0]",
 330                         "image_button[0,0;0.8,0.8;", defaulttexturedir, "start_icon.png;pstart;]",
 331                         "image_button[0.8,0;0.8,0.8;", defaulttexturedir, "prev_icon.png;pback;]",
 332                         "style[pagenum;border=false]",
 333                         "button[1.6,0;2,0.8;pagenum;", tonumber(cur_page), " / ", tonumber(dlgdata.pagemax), "]",
 334                         "image_button[3.6,0;0.8,0.8;", defaulttexturedir, "next_icon.png;pnext;]",
 335                         "image_button[4.4,0;0.8,0.8;", defaulttexturedir, "end_icon.png;pend;]",
 336                         "container_end[]",
 337
 338                         "container_end[]",
 339                 }
 340
 341                 if #store.packages == 0 then
 342                         formspec[#formspec + 1] = "label[4,3;"
 343                         formspec[#formspec + 1] = fgettext("No results")
 344                         formspec[#formspec + 1] = "]"
 345                 end
 346         else
 347                 formspec = {
 348                         "size[12,7]",
 349                         "position[0.5,0.55]",
 350                         "label[4,3;", fgettext("No packages could be retrieved"), "]",
 351                         "container[0,", H - 0.8 - 0.375, "]",
 352                         "button[0,0;4,0.8;back;", fgettext("Back to Main Menu"), "]",
 353                         "container_end[]",
 354                 }
 355         end
 356
 357         local start_idx = (cur_page - 1) * num_per_page + 1
 358         for i=start_idx, math.min(#store.packages, start_idx+num_per_page-1) do
 359                 local package = store.packages[i]
 360                 formspec[#formspec + 1] = "container[0.375,"
 361                 formspec[#formspec + 1] = (i - start_idx) * 1.375 + (2*0.375 + 0.8)
 362                 formspec[#formspec + 1] = "]"
 363
 364                 -- image
 365                 formspec[#formspec + 1] = "image[0,0;1.5,1;"
 366                 formspec[#formspec + 1] = core.formspec_escape(get_screenshot(package))
 367                 formspec[#formspec + 1] = "]"
 368
 369                 -- title
 370                 formspec[#formspec + 1] = "label[1.875,0.1;"
 371                 formspec[#formspec + 1] = core.formspec_escape(
 372                                 minetest.colorize(mt_color_green, package.title) ..
 373                                 minetest.colorize("#BFBFBF", " by " .. package.author))
 374                 formspec[#formspec + 1] = "]"
 375
 376                 -- buttons
 377                 local description_width = W - 0.375*5 - 1 - 2*1.5
 378                 formspec[#formspec + 1] = "container["
 379                 formspec[#formspec + 1] = W - 0.375*2
 380                 formspec[#formspec + 1] = ",0.1]"
 381
 382                 if package.downloading then
 383                         formspec[#formspec + 1] = "style[download;border=false]"
 384
 385                         formspec[#formspec + 1] = "button[-3.5,0;2,0.8;download;"
 386                         formspec[#formspec + 1] = fgettext("Downloading...")
 387                         formspec[#formspec + 1] = "]"
 388                 elseif not package.path then
 389                         formspec[#formspec + 1] = "button[-3,0;1.5,0.8;install_"
 390                         formspec[#formspec + 1] = tostring(i)
 391                         formspec[#formspec + 1] = ";"
 392                         formspec[#formspec + 1] = fgettext("Install")
 393                         formspec[#formspec + 1] = "]"
 394                 else
 395                         if package.installed_release < package.release then
 396                                 description_width = description_width - 1.5
 397
 398                                 -- The install_ action also handles updating
 399                                 formspec[#formspec + 1] = "button[-4.5,0;1.5,0.8;install_"
 400                                 formspec[#formspec + 1] = tostring(i)
 401                                 formspec[#formspec + 1] = ";"
 402                                 formspec[#formspec + 1] = fgettext("Update")
 403                                 formspec[#formspec + 1] = "]"
 404                         end
 405
 406                         formspec[#formspec + 1] = "button[-3,0;1.5,0.8;uninstall_"
 407                         formspec[#formspec + 1] = tostring(i)
 408                         formspec[#formspec + 1] = ";"
 409                         formspec[#formspec + 1] = fgettext("Uninstall")
 410                         formspec[#formspec + 1] = "]"
 411                 end
 412
 413                 formspec[#formspec + 1] = "button[-1.5,0;1.5,0.8;view_"
 414                 formspec[#formspec + 1] = tostring(i)
 415                 formspec[#formspec + 1] = ";"
 416                 formspec[#formspec + 1] = fgettext("View")
 417                 formspec[#formspec + 1] = "]"
 418                 formspec[#formspec + 1] = "container_end[]"
 419
 420                 -- description
 421                 formspec[#formspec + 1] = "textarea[1.855,0.3;"
 422                 formspec[#formspec + 1] = tostring(description_width)
 423                 formspec[#formspec + 1] = ",0.8;;;"
 424                 formspec[#formspec + 1] = core.formspec_escape(package.short_description)
 425                 formspec[#formspec + 1] = "]"
 426
 427                 formspec[#formspec + 1] = "container_end[]"
 428         end
 429
 430         return table.concat(formspec, "")
 431 end
 432
 433 function store.handle_submit(this, fields)
 434         if fields.search or fields.key_enter_field == "search_string" then
 435                 search_string = fields.search_string:trim()
 436                 cur_page = 1
 437                 store.filter_packages(search_string)
 438                 return true
 439         end
 440
 441         if fields.back then
 442                 this:delete()
 443                 return true
 444         end
 445
 446         if fields.pstart then
 447                 cur_page = 1
 448                 return true
 449         end
 450
 451         if fields.pend then
 452                 cur_page = this.data.pagemax
 453                 return true
 454         end
 455
 456         if fields.pnext then
 457                 cur_page = cur_page + 1
 458                 if cur_page > this.data.pagemax then
 459                         cur_page = 1
 460                 end
 461                 return true
 462         end
 463
 464         if fields.pback then
 465                 if cur_page == 1 then
 466                         cur_page = this.data.pagemax
 467                 else
 468                         cur_page = cur_page - 1
 469                 end
 470                 return true
 471         end
 472
 473         if fields.type then
 474                 local new_type = table.indexof(filter_types_titles, fields.type)
 475                 if new_type ~= filter_type then
 476                         filter_type = new_type
 477                         store.filter_packages(search_string)
 478                         return true
 479                 end
 480         end
 481
 482         local start_idx = (cur_page - 1) * num_per_page + 1
 483         assert(start_idx ~= nil)
 484         for i=start_idx, math.min(#store.packages, start_idx+num_per_page-1) do
 485                 local package = store.packages[i]
 486                 assert(package)
 487
 488                 if fields["install_" .. i] then
 489                         start_install(this, package)
 490                         return true
 491                 end
 492
 493                 if fields["uninstall_" .. i] then
 494                         local dlg_delmod = create_delete_content_dlg(package)
 495                         dlg_delmod:set_parent(this)
 496                         this:hide()
 497                         dlg_delmod:show()
 498                         return true
 499                 end
 500
 501                 if fields["view_" .. i] then
 502                         local url = ("%s/packages/%s?protocol_version=%d"):format(
 503                                         core.settings:get("contentdb_url"), package.id, core.get_max_supp_proto())
 504                         core.open_url(url)
 505                         return true
 506                 end
 507         end
 508
 509         return false
 510 end
 511
 512 function create_store_dlg(type)
 513         if not store.loaded or #store.packages_full == 0 then
 514                 store.load()
 515         end
 516
 517         search_string = ""
 518         cur_page = 1
 519
 520         if type then
 521                 -- table.indexof does not work on tables that contain `nil`
 522                 for i, v in pairs(filter_types_type) do
 523                         if v == type then
 524                                 filter_type = i
 525                                 break
 526                         end
 527                 end
 528         end
 529
 530         store.filter_packages(search_string)
 531
 532         return dialog_create("store",
 533                         store.get_formspec,
 534                         store.handle_submit,
 535                         nil)
 536 end