builtin/mainmenu/pkgmgr.lua

   1 --Minetest
   2 --Copyright (C) 2013 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_last_folder(text,count)
  20         local parts = text:split(DIR_DELIM)
  21
  22         if count == nil then
  23                 return parts[#parts]
  24         end
  25
  26         local retval = ""
  27         for i=1,count,1 do
  28                 retval = retval .. parts[#parts - (count-i)] .. DIR_DELIM
  29         end
  30
  31         return retval
  32 end
  33
  34 local function cleanup_path(temppath)
  35
  36         local parts = temppath:split("-")
  37         temppath = ""
  38         for i=1,#parts,1 do
  39                 if temppath ~= "" then
  40                         temppath = temppath .. "_"
  41                 end
  42                 temppath = temppath .. parts[i]
  43         end
  44
  45         parts = temppath:split(".")
  46         temppath = ""
  47         for i=1,#parts,1 do
  48                 if temppath ~= "" then
  49                         temppath = temppath .. "_"
  50                 end
  51                 temppath = temppath .. parts[i]
  52         end
  53
  54         parts = temppath:split("'")
  55         temppath = ""
  56         for i=1,#parts,1 do
  57                 if temppath ~= "" then
  58                         temppath = temppath .. ""
  59                 end
  60                 temppath = temppath .. parts[i]
  61         end
  62
  63         parts = temppath:split(" ")
  64         temppath = ""
  65         for i=1,#parts,1 do
  66                 if temppath ~= "" then
  67                         temppath = temppath
  68                 end
  69                 temppath = temppath .. parts[i]
  70         end
  71
  72         return temppath
  73 end
  74
  75 local function load_texture_packs(txtpath, retval)
  76         local list = core.get_dir_list(txtpath, true)
  77         local current_texture_path = core.settings:get("texture_path")
  78
  79         for _, item in ipairs(list) do
  80                 if item ~= "base" then
  81                         local path = txtpath .. DIR_DELIM .. item .. DIR_DELIM
  82                         local conf = Settings(path .. "texture_pack.conf")
  83                         local enabled = path == current_texture_path
  84
  85                         local title = conf:get("title") or item
  86
  87                         -- list_* is only used if non-nil, else the regular versions are used.
  88                         retval[#retval + 1] = {
  89                                 name = item,
  90                                 title = title,
  91                                 list_name = enabled and fgettext("$1 (Enabled)", item) or nil,
  92                                 list_title = enabled and fgettext("$1 (Enabled)", title) or nil,
  93                                 author = conf:get("author"),
  94                                 release = tonumber(conf:get("release")) or 0,
  95                                 type = "txp",
  96                                 path = path,
  97                                 enabled = enabled,
  98                         }
  99                 end
 100         end
 101 end
 102
 103 function get_mods(path, virtual_path, retval, modpack)
 104         local mods = core.get_dir_list(path, true)
 105
 106         for _, name in ipairs(mods) do
 107                 if name:sub(1, 1) ~= "." then
 108                         local mod_path = path .. DIR_DELIM .. name
 109                         local mod_virtual_path = virtual_path .. "/" .. name
 110                         local toadd = {
 111                                 dir_name = name,
 112                                 parent_dir = path,
 113                         }
 114                         retval[#retval + 1] = toadd
 115
 116                         -- Get config file
 117                         local mod_conf
 118                         local modpack_conf = io.open(mod_path .. DIR_DELIM .. "modpack.conf")
 119                         if modpack_conf then
 120                                 toadd.is_modpack = true
 121                                 modpack_conf:close()
 122
 123                                 mod_conf = Settings(mod_path .. DIR_DELIM .. "modpack.conf"):to_table()
 124                                 if mod_conf.name then
 125                                         name = mod_conf.name
 126                                         toadd.is_name_explicit = true
 127                                 end
 128                         else
 129                                 mod_conf = Settings(mod_path .. DIR_DELIM .. "mod.conf"):to_table()
 130                                 if mod_conf.name then
 131                                         name = mod_conf.name
 132                                         toadd.is_name_explicit = true
 133                                 end
 134                         end
 135
 136                         -- Read from config
 137                         toadd.name = name
 138                         toadd.title = mod_conf.title
 139                         toadd.author = mod_conf.author
 140                         toadd.release = tonumber(mod_conf.release) or 0
 141                         toadd.path = mod_path
 142                         toadd.virtual_path = mod_virtual_path
 143                         toadd.type = "mod"
 144
 145                         -- Check modpack.txt
 146                         -- Note: modpack.conf is already checked above
 147                         local modpackfile = io.open(mod_path .. DIR_DELIM .. "modpack.txt")
 148                         if modpackfile then
 149                                 modpackfile:close()
 150                                 toadd.is_modpack = true
 151                         end
 152
 153                         -- Deal with modpack contents
 154                         if modpack and modpack ~= "" then
 155                                 toadd.modpack = modpack
 156                         elseif toadd.is_modpack then
 157                                 toadd.type = "modpack"
 158                                 toadd.is_modpack = true
 159                                 get_mods(mod_path, mod_virtual_path, retval, name)
 160                         end
 161                 end
 162         end
 163 end
 164
 165 --modmanager implementation
 166 pkgmgr = {}
 167
 168 function pkgmgr.get_texture_packs()
 169         local txtpath = core.get_texturepath()
 170         local txtpath_system = core.get_texturepath_share()
 171         local retval = {}
 172
 173         load_texture_packs(txtpath, retval)
 174         -- on portable versions these two paths coincide. It avoids loading the path twice
 175         if txtpath ~= txtpath_system then
 176                 load_texture_packs(txtpath_system, retval)
 177         end
 178
 179         table.sort(retval, function(a, b)
 180                 return a.name > b.name
 181         end)
 182
 183         return retval
 184 end
 185
 186 --------------------------------------------------------------------------------
 187 function pkgmgr.get_folder_type(path)
 188         local testfile = io.open(path .. DIR_DELIM .. "init.lua","r")
 189         if testfile ~= nil then
 190                 testfile:close()
 191                 return { type = "mod", path = path }
 192         end
 193
 194         testfile = io.open(path .. DIR_DELIM .. "modpack.conf","r")
 195         if testfile ~= nil then
 196                 testfile:close()
 197                 return { type = "modpack", path = path }
 198         end
 199
 200         testfile = io.open(path .. DIR_DELIM .. "modpack.txt","r")
 201         if testfile ~= nil then
 202                 testfile:close()
 203                 return { type = "modpack", path = path }
 204         end
 205
 206         testfile = io.open(path .. DIR_DELIM .. "game.conf","r")
 207         if testfile ~= nil then
 208                 testfile:close()
 209                 return { type = "game", path = path }
 210         end
 211
 212         testfile = io.open(path .. DIR_DELIM .. "texture_pack.conf","r")
 213         if testfile ~= nil then
 214                 testfile:close()
 215                 return { type = "txp", path = path }
 216         end
 217
 218         return nil
 219 end
 220
 221 -------------------------------------------------------------------------------
 222 function pkgmgr.get_base_folder(temppath)
 223         if temppath == nil then
 224                 return { type = "invalid", path = "" }
 225         end
 226
 227         local ret = pkgmgr.get_folder_type(temppath)
 228         if ret then
 229                 return ret
 230         end
 231
 232         local subdirs = core.get_dir_list(temppath, true)
 233         if #subdirs == 1 then
 234                 ret = pkgmgr.get_folder_type(temppath .. DIR_DELIM .. subdirs[1])
 235                 if ret then
 236                         return ret
 237                 else
 238                         return { type = "invalid", path = temppath .. DIR_DELIM .. subdirs[1] }
 239                 end
 240         end
 241
 242         return nil
 243 end
 244
 245 --------------------------------------------------------------------------------
 246 function pkgmgr.isValidModname(modpath)
 247         if modpath:find("-") ~= nil then
 248                 return false
 249         end
 250
 251         return true
 252 end
 253
 254 --------------------------------------------------------------------------------
 255 function pkgmgr.parse_register_line(line)
 256         local pos1 = line:find("\"")
 257         local pos2 = nil
 258         if pos1 ~= nil then
 259                 pos2 = line:find("\"",pos1+1)
 260         end
 261
 262         if pos1 ~= nil and pos2 ~= nil then
 263                 local item = line:sub(pos1+1,pos2-1)
 264
 265                 if item ~= nil and
 266                         item ~= "" then
 267                         local pos3 = item:find(":")
 268
 269                         if pos3 ~= nil then
 270                                 local retval = item:sub(1,pos3-1)
 271                                 if retval ~= nil and
 272                                         retval ~= "" then
 273                                         return retval
 274                                 end
 275                         end
 276                 end
 277         end
 278         return nil
 279 end
 280
 281 --------------------------------------------------------------------------------
 282 function pkgmgr.parse_dofile_line(modpath,line)
 283         local pos1 = line:find("\"")
 284         local pos2 = nil
 285         if pos1 ~= nil then
 286                 pos2 = line:find("\"",pos1+1)
 287         end
 288
 289         if pos1 ~= nil and pos2 ~= nil then
 290                 local filename = line:sub(pos1+1,pos2-1)
 291
 292                 if filename ~= nil and
 293                         filename ~= "" and
 294                         filename:find(".lua") then
 295                         return pkgmgr.identify_modname(modpath,filename)
 296                 end
 297         end
 298         return nil
 299 end
 300
 301 --------------------------------------------------------------------------------
 302 function pkgmgr.identify_modname(modpath,filename)
 303         local testfile = io.open(modpath .. DIR_DELIM .. filename,"r")
 304         if testfile ~= nil then
 305                 local line = testfile:read()
 306
 307                 while line~= nil do
 308                         local modname = nil
 309
 310                         if line:find("minetest.register_tool") then
 311                                 modname = pkgmgr.parse_register_line(line)
 312                         end
 313
 314                         if line:find("minetest.register_craftitem") then
 315                                 modname = pkgmgr.parse_register_line(line)
 316                         end
 317
 318
 319                         if line:find("minetest.register_node") then
 320                                 modname = pkgmgr.parse_register_line(line)
 321                         end
 322
 323                         if line:find("dofile") then
 324                                 modname = pkgmgr.parse_dofile_line(modpath,line)
 325                         end
 326
 327                         if modname ~= nil then
 328                                 testfile:close()
 329                                 return modname
 330                         end
 331
 332                         line = testfile:read()
 333                 end
 334                 testfile:close()
 335         end
 336
 337         return nil
 338 end
 339 --------------------------------------------------------------------------------
 340 function pkgmgr.render_packagelist(render_list, use_technical_names)
 341         if not render_list then
 342                 if not pkgmgr.global_mods then
 343                         pkgmgr.refresh_globals()
 344                 end
 345                 render_list = pkgmgr.global_mods
 346         end
 347
 348         local list = render_list:get_list()
 349         local retval = {}
 350         for i, v in ipairs(list) do
 351                 local color = ""
 352                 if v.is_modpack then
 353                         local rawlist = render_list:get_raw_list()
 354                         color = mt_color_dark_green
 355
 356                         for j = 1, #rawlist, 1 do
 357                                 if rawlist[j].modpack == list[i].name and
 358                                                 not rawlist[j].enabled then
 359                                         -- Modpack not entirely enabled so showing as grey
 360                                         color = mt_color_grey
 361                                         break
 362                                 end
 363                         end
 364                 elseif v.is_game_content or v.type == "game" then
 365                         color = mt_color_blue
 366                 elseif v.enabled or v.type == "txp" then
 367                         color = mt_color_green
 368                 end
 369
 370                 retval[#retval + 1] = color
 371                 if v.modpack ~= nil or v.loc == "game" then
 372                         retval[#retval + 1] = "1"
 373                 else
 374                         retval[#retval + 1] = "0"
 375                 end
 376
 377                 if use_technical_names then
 378                         retval[#retval + 1] = core.formspec_escape(v.list_name or v.name)
 379                 else
 380                         retval[#retval + 1] = core.formspec_escape(v.list_title or v.list_name or v.title or v.name)
 381                 end
 382         end
 383
 384         return table.concat(retval, ",")
 385 end
 386
 387 --------------------------------------------------------------------------------
 388 function pkgmgr.get_dependencies(path)
 389         if path == nil then
 390                 return {}, {}
 391         end
 392
 393         local info = core.get_content_info(path)
 394         return info.depends or {}, info.optional_depends or {}
 395 end
 396
 397 ----------- tests whether all of the mods in the modpack are enabled -----------
 398 function pkgmgr.is_modpack_entirely_enabled(data, name)
 399         local rawlist = data.list:get_raw_list()
 400         for j = 1, #rawlist do
 401                 if rawlist[j].modpack == name and not rawlist[j].enabled then
 402                         return false
 403                 end
 404         end
 405         return true
 406 end
 407
 408 local function disable_all_by_name(list, name, except)
 409         for i=1, #list do
 410                 if list[i].name == name and list[i] ~= except then
 411                         list[i].enabled = false
 412                 end
 413         end
 414 end
 415
 416 ---------- toggles or en/disables a mod or modpack and its dependencies --------
 417 local function toggle_mod_or_modpack(list, toggled_mods, enabled_mods, toset, mod)
 418         if not mod.is_modpack then
 419                 -- Toggle or en/disable the mod
 420                 if toset == nil then
 421                         toset = not mod.enabled
 422                 end
 423                 if mod.enabled ~= toset then
 424                         toggled_mods[#toggled_mods+1] = mod.name
 425                 end
 426                 if toset then
 427                         -- Mark this mod for recursive dependency traversal
 428                         enabled_mods[mod.name] = true
 429
 430                         -- Disable other mods with the same name
 431                         disable_all_by_name(list, mod.name, mod)
 432                 end
 433                 mod.enabled = toset
 434         else
 435                 -- Toggle or en/disable every mod in the modpack,
 436                 -- interleaved unsupported
 437                 for i = 1, #list do
 438                         if list[i].modpack == mod.name then
 439                                 toggle_mod_or_modpack(list, toggled_mods, enabled_mods, toset, list[i])
 440                         end
 441                 end
 442         end
 443 end
 444
 445 function pkgmgr.enable_mod(this, toset)
 446         local list = this.data.list:get_list()
 447         local mod = list[this.data.selected_mod]
 448
 449         -- Game mods can't be enabled or disabled
 450         if mod.is_game_content then
 451                 return
 452         end
 453
 454         local toggled_mods = {}
 455         local enabled_mods = {}
 456         toggle_mod_or_modpack(list, toggled_mods, enabled_mods, toset, mod)
 457         toset = mod.enabled -- Update if toggled
 458
 459         if not toset then
 460                 -- Mod(s) were disabled, so no dependencies need to be enabled
 461                 table.sort(toggled_mods)
 462                 core.log("info", "Following mods were disabled: " ..
 463                         table.concat(toggled_mods, ", "))
 464                 return
 465         end
 466
 467         -- Enable mods' depends after activation
 468
 469         -- Make a list of mod ids indexed by their names
 470         local mod_ids = {}
 471         for id, mod2 in pairs(list) do
 472                 if mod2.type == "mod" and not mod2.is_modpack then
 473                         mod_ids[mod2.name] = id
 474                 end
 475         end
 476
 477         -- to_enable is used as a DFS stack with sp as stack pointer
 478         local to_enable = {}
 479         local sp = 0
 480         for name in pairs(enabled_mods) do
 481                 local depends = pkgmgr.get_dependencies(list[mod_ids[name]].path)
 482                 for i = 1, #depends do
 483                         local dependency_name = depends[i]
 484                         if not enabled_mods[dependency_name] then
 485                                 sp = sp+1
 486                                 to_enable[sp] = dependency_name
 487                         end
 488                 end
 489         end
 490
 491         -- If sp is 0, every dependency is already activated
 492         while sp > 0 do
 493                 local name = to_enable[sp]
 494                 sp = sp-1
 495
 496                 if not enabled_mods[name] then
 497                         enabled_mods[name] = true
 498                         local mod_to_enable = list[mod_ids[name]]
 499                         if not mod_to_enable then
 500                                 core.log("warning", "Mod dependency \"" .. name ..
 501                                         "\" not found!")
 502                         else
 503                                 if not mod_to_enable.enabled then
 504                                         mod_to_enable.enabled = true
 505                                         toggled_mods[#toggled_mods+1] = mod_to_enable.name
 506                                 end
 507                                 -- Push the dependencies of the dependency onto the stack
 508                                 local depends = pkgmgr.get_dependencies(mod_to_enable.path)
 509                                 for i = 1, #depends do
 510                                         if not enabled_mods[depends[i]] then
 511                                                 sp = sp+1
 512                                                 to_enable[sp] = depends[i]
 513                                         end
 514                                 end
 515                         end
 516                 end
 517         end
 518
 519         -- Log the list of enabled mods
 520         table.sort(toggled_mods)
 521         core.log("info", "Following mods were enabled: " ..
 522                 table.concat(toggled_mods, ", "))
 523 end
 524
 525 --------------------------------------------------------------------------------
 526 function pkgmgr.get_worldconfig(worldpath)
 527         local filename = worldpath ..
 528                                 DIR_DELIM .. "world.mt"
 529
 530         local worldfile = Settings(filename)
 531
 532         local worldconfig = {}
 533         worldconfig.global_mods = {}
 534         worldconfig.game_mods = {}
 535
 536         for key,value in pairs(worldfile:to_table()) do
 537                 if key == "gameid" then
 538                         worldconfig.id = value
 539                 elseif key:sub(0, 9) == "load_mod_" then
 540                         -- Compatibility: Check against "nil" which was erroneously used
 541                         -- as value for fresh configured worlds
 542                         worldconfig.global_mods[key] = value ~= "false" and value ~= "nil"
 543                                 and value
 544                 else
 545                         worldconfig[key] = value
 546                 end
 547         end
 548
 549         --read gamemods
 550         local gamespec = pkgmgr.find_by_gameid(worldconfig.id)
 551         pkgmgr.get_game_mods(gamespec, worldconfig.game_mods)
 552
 553         return worldconfig
 554 end
 555
 556 --------------------------------------------------------------------------------
 557 function pkgmgr.install_dir(type, path, basename, targetpath)
 558         local basefolder = pkgmgr.get_base_folder(path)
 559
 560         -- There's no good way to detect a texture pack, so let's just assume
 561         -- it's correct for now.
 562         if type == "txp" then
 563                 if basefolder and basefolder.type ~= "invalid" and basefolder.type ~= "txp" then
 564                         return nil, fgettext("Unable to install a $1 as a texture pack", basefolder.type)
 565                 end
 566
 567                 local from = basefolder and basefolder.path or path
 568                 if targetpath then
 569                         core.delete_dir(targetpath)
 570                 else
 571                         targetpath = core.get_texturepath() .. DIR_DELIM .. basename
 572                 end
 573                 if not core.copy_dir(from, targetpath, false) then
 574                         return nil,
 575                                 fgettext("Failed to install $1 to $2", basename, targetpath)
 576                 end
 577                 return targetpath, nil
 578
 579         elseif not basefolder then
 580                 return nil, fgettext("Unable to find a valid mod or modpack")
 581         end
 582
 583         --
 584         -- Get destination
 585         --
 586         if basefolder.type == "modpack" then
 587                 if type ~= "mod" then
 588                         return nil, fgettext("Unable to install a modpack as a $1", type)
 589                 end
 590
 591                 -- Get destination name for modpack
 592                 if targetpath then
 593                         core.delete_dir(targetpath)
 594                 else
 595                         local clean_path = nil
 596                         if basename ~= nil then
 597                                 clean_path = basename
 598                         end
 599                         if not clean_path then
 600                                 clean_path = get_last_folder(cleanup_path(basefolder.path))
 601                         end
 602                         if clean_path then
 603                                 targetpath = core.get_modpath() .. DIR_DELIM .. clean_path
 604                         else
 605                                 return nil,
 606                                         fgettext("Install Mod: Unable to find suitable folder name for modpack $1",
 607                                         path)
 608                         end
 609                 end
 610         elseif basefolder.type == "mod" then
 611                 if type ~= "mod" then
 612                         return nil, fgettext("Unable to install a mod as a $1", type)
 613                 end
 614
 615                 if targetpath then
 616                         core.delete_dir(targetpath)
 617                 else
 618                         local targetfolder = basename
 619                         if targetfolder == nil then
 620                                 targetfolder = pkgmgr.identify_modname(basefolder.path, "init.lua")
 621                         end
 622
 623                         -- If heuristic failed try to use current foldername
 624                         if targetfolder == nil then
 625                                 targetfolder = get_last_folder(basefolder.path)
 626                         end
 627
 628                         if targetfolder ~= nil and pkgmgr.isValidModname(targetfolder) then
 629                                 targetpath = core.get_modpath() .. DIR_DELIM .. targetfolder
 630                         else
 631                                 return nil, fgettext("Install Mod: Unable to find real mod name for: $1", path)
 632                         end
 633                 end
 634
 635         elseif basefolder.type == "game" then
 636                 if type ~= "game" then
 637                         return nil, fgettext("Unable to install a game as a $1", type)
 638                 end
 639
 640                 if targetpath then
 641                         core.delete_dir(targetpath)
 642                 else
 643                         targetpath = core.get_gamepath() .. DIR_DELIM .. basename
 644                 end
 645         end
 646
 647         -- Copy it
 648         if not core.copy_dir(basefolder.path, targetpath, false) then
 649                 return nil,
 650                         fgettext("Failed to install $1 to $2", basename, targetpath)
 651         end
 652
 653         if basefolder.type == "game" then
 654                 pkgmgr.update_gamelist()
 655         else
 656                 pkgmgr.refresh_globals()
 657         end
 658
 659         return targetpath, nil
 660 end
 661
 662 --------------------------------------------------------------------------------
 663 function pkgmgr.preparemodlist(data)
 664         local retval = {}
 665
 666         local global_mods = {}
 667         local game_mods = {}
 668
 669         --read global mods
 670         local modpaths = core.get_modpaths()
 671         for key, modpath in pairs(modpaths) do
 672                 get_mods(modpath, key, global_mods)
 673         end
 674
 675         for i=1,#global_mods,1 do
 676                 global_mods[i].type = "mod"
 677                 global_mods[i].loc = "global"
 678                 global_mods[i].enabled = false
 679                 retval[#retval + 1] = global_mods[i]
 680         end
 681
 682         --read game mods
 683         local gamespec = pkgmgr.find_by_gameid(data.gameid)
 684         pkgmgr.get_game_mods(gamespec, game_mods)
 685
 686         if #game_mods > 0 then
 687                 -- Add title
 688                 retval[#retval + 1] = {
 689                         type = "game",
 690                         is_game_content = true,
 691                         name = fgettext("$1 mods", gamespec.name),
 692                         path = gamespec.path
 693                 }
 694         end
 695
 696         for i=1,#game_mods,1 do
 697                 game_mods[i].type = "mod"
 698                 game_mods[i].loc = "game"
 699                 game_mods[i].is_game_content = true
 700                 retval[#retval + 1] = game_mods[i]
 701         end
 702
 703         if data.worldpath == nil then
 704                 return retval
 705         end
 706
 707         --read world mod configuration
 708         local filename = data.worldpath ..
 709                                 DIR_DELIM .. "world.mt"
 710
 711         local worldfile = Settings(filename)
 712         for key, value in pairs(worldfile:to_table()) do
 713                 if key:sub(1, 9) == "load_mod_" then
 714                         key = key:sub(10)
 715                         local mod_found = false
 716
 717                         local fallback_found = false
 718                         local fallback_mod = nil
 719
 720                         for i=1, #retval do
 721                                 if retval[i].name == key and
 722                                                 not retval[i].is_modpack then
 723                                         if core.is_yes(value) or retval[i].virtual_path == value then
 724                                                 retval[i].enabled = true
 725                                                 mod_found = true
 726                                                 break
 727                                         elseif fallback_found then
 728                                                 -- Only allow fallback if only one mod matches
 729                                                 fallback_mod = nil
 730                                         else
 731                                                 fallback_found = true
 732                                                 fallback_mod = retval[i]
 733                                         end
 734                                 end
 735                         end
 736
 737                         if not mod_found then
 738                                 if fallback_mod and value:find("/") then
 739                                         fallback_mod.enabled = true
 740                                 else
 741                                         core.log("info", "Mod: " .. key .. " " .. dump(value) .. " but not found")
 742                                 end
 743                         end
 744                 end
 745         end
 746
 747         return retval
 748 end
 749
 750 function pkgmgr.compare_package(a, b)
 751         return a and b and a.name == b.name and a.path == b.path
 752 end
 753
 754 --------------------------------------------------------------------------------
 755 function pkgmgr.comparemod(elem1,elem2)
 756         if elem1 == nil or elem2 == nil then
 757                 return false
 758         end
 759         if elem1.name ~= elem2.name then
 760                 return false
 761         end
 762         if elem1.is_modpack ~= elem2.is_modpack then
 763                 return false
 764         end
 765         if elem1.type ~= elem2.type then
 766                 return false
 767         end
 768         if elem1.modpack ~= elem2.modpack then
 769                 return false
 770         end
 771
 772         if elem1.path ~= elem2.path then
 773                 return false
 774         end
 775
 776         return true
 777 end
 778
 779 --------------------------------------------------------------------------------
 780 function pkgmgr.mod_exists(basename)
 781
 782         if pkgmgr.global_mods == nil then
 783                 pkgmgr.refresh_globals()
 784         end
 785
 786         if pkgmgr.global_mods:raw_index_by_uid(basename) > 0 then
 787                 return true
 788         end
 789
 790         return false
 791 end
 792
 793 --------------------------------------------------------------------------------
 794 function pkgmgr.get_global_mod(idx)
 795
 796         if pkgmgr.global_mods == nil then
 797                 return nil
 798         end
 799
 800         if idx == nil or idx < 1 or
 801                 idx > pkgmgr.global_mods:size() then
 802                 return nil
 803         end
 804
 805         return pkgmgr.global_mods:get_list()[idx]
 806 end
 807
 808 --------------------------------------------------------------------------------
 809 function pkgmgr.refresh_globals()
 810         local function is_equal(element,uid) --uid match
 811                 if element.name == uid then
 812                         return true
 813                 end
 814         end
 815         pkgmgr.global_mods = filterlist.create(pkgmgr.preparemodlist,
 816                         pkgmgr.comparemod, is_equal, nil, {})
 817         pkgmgr.global_mods:add_sort_mechanism("alphabetic", sort_mod_list)
 818         pkgmgr.global_mods:set_sortmode("alphabetic")
 819 end
 820
 821 --------------------------------------------------------------------------------
 822 function pkgmgr.find_by_gameid(gameid)
 823         for i=1,#pkgmgr.games,1 do
 824                 if pkgmgr.games[i].id == gameid then
 825                         return pkgmgr.games[i], i
 826                 end
 827         end
 828         return nil, nil
 829 end
 830
 831 --------------------------------------------------------------------------------
 832 function pkgmgr.get_game_mods(gamespec, retval)
 833         if gamespec ~= nil and
 834                 gamespec.gamemods_path ~= nil and
 835                 gamespec.gamemods_path ~= "" then
 836                 get_mods(gamespec.gamemods_path, ("games/%s/mods"):format(gamespec.id), retval)
 837         end
 838 end
 839
 840 --------------------------------------------------------------------------------
 841 function pkgmgr.get_game_modlist(gamespec)
 842         local retval = ""
 843         local game_mods = {}
 844         pkgmgr.get_game_mods(gamespec, game_mods)
 845         for i=1,#game_mods,1 do
 846                 if retval ~= "" then
 847                         retval = retval..","
 848                 end
 849                 retval = retval .. game_mods[i].name
 850         end
 851         return retval
 852 end
 853
 854 --------------------------------------------------------------------------------
 855 function pkgmgr.get_game(index)
 856         if index > 0 and index <= #pkgmgr.games then
 857                 return pkgmgr.games[index]
 858         end
 859
 860         return nil
 861 end
 862
 863 --------------------------------------------------------------------------------
 864 function pkgmgr.update_gamelist()
 865         pkgmgr.games = core.get_games()
 866 end
 867
 868 --------------------------------------------------------------------------------
 869 function pkgmgr.gamelist()
 870         local retval = ""
 871         if #pkgmgr.games > 0 then
 872                 retval = retval .. core.formspec_escape(pkgmgr.games[1].name)
 873
 874                 for i=2,#pkgmgr.games,1 do
 875                         retval = retval .. "," .. core.formspec_escape(pkgmgr.games[i].name)
 876                 end
 877         end
 878         return retval
 879 end
 880
 881 --------------------------------------------------------------------------------
 882 -- read initial data
 883 --------------------------------------------------------------------------------
 884 pkgmgr.update_gamelist()