EnlivenMinetest/minetestinfo.py

import os
from expertmm import *

#variables to eliminate from chunkymap-regen (and manage here instead):
#os_name
#self.config (use minetestinfo.get_val instead)
#config_name
#config_path
#profile_path

worldgen_mod_list = list()
worldgen_mod_list.append("caverealms")
worldgen_mod_list.append("ethereal")
worldgen_mod_list.append("lapis")
worldgen_mod_list.append("mines")
worldgen_mod_list.append("mg")  # this delays/prevents chunk generation and sometimes crashes in 0.4.13 release (tested on Windows 10)
worldgen_mod_list.append("moretrees")
worldgen_mod_list.append("moreores")
#worldgen_mod_list.append("nature_classic")  # NOTE: plantlife_modpack has this and other stuff, but detecting this could help since it is unique to the modpack
worldgen_mod_list.append("plantlife_modpack")  #ok if installed as modpack instead of putting individual mods in mods folder
worldgen_mod_list.append("pyramids")
worldgen_mod_list.append("railcorridors")
worldgen_mod_list.append("sea")
worldgen_mod_list.append("technic")
worldgen_mod_list.append("technic_worldgen")
worldgen_mod_list.append("tsm_mines")
worldgen_mod_list.append("tsm_pyramids")
worldgen_mod_list.append("tsm_railcorridors")

after_broken = {}
after_broken["default:stone"] = "default:cobble"
after_broken["default:stone_with_iron"] = "default:iron_lump"
after_broken["default:stone_with_copper"] = "default:copper_lump"
after_broken["default:stone_with_coal"] = "default:coal_lump"
after_broken["default:dirt_with_grass"] = "default:dirt"
after_broken["moreores:mineral_tin"] = "moreores:tin_lump"
after_broken["default:stone_with_mese"] = "default:mese_crystal"
after_broken["moreores:mineral_silver"] = "moreores:silver_lump"
after_broken["default:stone_with_gold"] = "default:gold_lump"
after_broken["default:stone_with_diamond"] = "default:diamond"
#after_broken[""] = ""
#after_broken[""] = ""
#after_broken[""] = ""
#after_broken[""] = ""
#after_broken[""] = ""


loaded_mod_list = list()

prepackaged_game_mod_list = list()
prepackaged_gameid = "minetest_game"
new_mod_list = list()

user_excluded_mod_count = 0

minetestinfo = ConfigManager(os.path.join(os.path.dirname(os.path.abspath(__file__)), "minetestmeta.yml"), ":")

os_name="linux"
if (os.path.sep!="/"):
    os_name="windows"
    print("Windows detected")
game_path_from_gameid_dict = {}

def get_gameid_from_game_path(path):
    result = None
    if path is not None:
        result = os.path.basename(path)
    return result

def get_game_name_from_game_path(path):
    result = None
    if path is not None:
        game_conf_path = os.path.join(path, "game.conf")
        if os.path.isfile(game_conf_path):
            game_conf_dict = get_dict_from_conf_file(game_conf_path)
            if "name" in game_conf_dict:
                result = game_conf_dict["name"]
                if (result is None) or (len(result.strip())<1):
                    result = None
                    print("WARNING: missing 'name' in game.conf in '"+path+"'")
                else:
                    result = result.strip()
        else:
            print("WARNING: no game.conf in '"+path+"'")
    return result

#This is case-insensitive
def get_game_path_from_gameid(gameid):
    result = None
    games_path = os.path.join(minetestinfo.get_var("shared_minetest_path"), "games")
    if gameid is not None:
        if os.path.isdir(games_path):
            game_count = 0
            for this_game_name in os.listdir(games_path):
                game_count += 1
                this_game_path = os.path.join(games_path, this_game_name)
                #for decachunk_z_basepath, decachunk_z_dirnames, decachunk_z_filenames in os.walk(this_game_dirnames):
                if this_game_name[:1]!="." and os.path.isdir(this_game_path):
                    this_gameid = get_gameid_from_game_path(this_game_path)
                    #print("get_game_path_from_gameid is seeing if '"+str(this_gameid)+"' is the desired '"+gameid+"'")
                    if this_gameid is not None:
                        if this_gameid.lower() == gameid.lower():
                            result = this_game_path
                            break
                #else:
                    #print("skipping '"+this_game_path+"'")
            if game_count<=0:
                print("WARNING: "+str(game_count)+" games in '"+games_path+"'.")
        else:
            print("ERROR: cannot get game_path from gameid since games path is not ready yet (or '"+games_path+"' does not exist for some other reason such as shared_minetest_path is wrong and does not contain games folder)")
    else:
        print("ERROR: can't try get_game_path_from_gameid since gameid param is None.")
    return result


def init_minetestinfo():
    if not minetestinfo.contains("www_minetest_path"):
        default_www_minetest_path = "/var/www/html/minetest"
        if os_name=="windows":
            default_www_minetest_path = None
            prioritized_try_paths = list()
            prioritized_try_paths.append("C:\\wamp\\www")
            prioritized_try_paths.append("C:\\www")
            prioritized_try_paths.append("C:\\Program Files\\Apache Software Foundation\\Apache2.2\\htdocs")
            prioritized_try_paths.append("C:\\Inetpub\\Wwwroot")

            #prioritized_try_paths.append("C:\\Program Files\\Apache Software Foundation\\Apache2.2\\htdocs\\folder_test\\website")
            for try_path in prioritized_try_paths:
                try:
                    if os.path.isdir(try_path):
                        default_www_minetest_path = try_path
                        break
                except:
                    pass
            if default_www_minetest_path is None:
                print("WARNING: could not detect website directory automatically. You need WAMP or similar web server with php 5 or higher to use minetest website scripts. You can change www_minetest_path to your server's website root later by editing '"+minetestinfo._config_path+"'")
                default_www_minetest_path = os.path.dirname(os.path.abspath(__file__))

        minetestinfo.prepare_var("www_minetest_path", default_www_minetest_path, "your web server directory (or other folder where minetest website features and data should be placed)")

    profile_path = None
    if os_name=="windows":
        profile_path = os.environ['USERPROFILE']
    else:
        profile_path = os.environ['HOME']

    default_profile_minetest_path = os.path.join(profile_path,".minetest")
    if (os_name=="windows"):
        default_profile_minetest_path = "C:\\games\\Minetest"
    minetestinfo.prepare_var("profile_minetest_path", default_profile_minetest_path, "user minetest path containing worlds folder and debug.txt")
    if not os.path.isdir(minetestinfo.get_var("profile_minetest_path")):
        print("(WARNING: missing "+minetestinfo.get_var("profile_minetest_path")+", so please close and update profile_minetest_path in '"+minetestinfo._config_path+"' before next run)")
    print("")

    if not minetestinfo.contains("worlds_path"):
        minetestinfo._data["worlds_path"] = os.path.join(minetestinfo.get_var("profile_minetest_path"),"worlds")
        minetestinfo.save_yaml()

    default_shared_minetest_path = "/usr/share/games/minetest"
    try_path = "/usr/local/share/minetest"
    if os_name == "windows":
        default_shared_minetest_path = "C:\\Games\\Minetest"
    elif os.path.isdir(try_path):
        default_shared_minetest_path = try_path

    while True:
        minetestinfo.prepare_var("shared_minetest_path", default_shared_minetest_path, "path containing Minetest's games folder")
        games_path = os.path.join(minetestinfo.get_var("shared_minetest_path"), "games")
        if not os.path.isdir(games_path):
            answer=raw_input("WARNING: '"+minetestinfo.get_var("shared_minetest_path")+"' does not contain a games folder. If you use this shared_minetest_path, some features may not work correctly (such as adding worldgen mod labels to chunks, and future programs that may use this metadata to install minetest games). Are you sure you want to use y/n [blank for 'n' (no)]? ")
            if answer.lower()=="y" or answer.lower()=="yes":
                print("You can change the value of shared_minetest_path later by editing '"+minetestinfo._config_path+"'.")
                print("")
                break
            else:
                minetestinfo.remove_var("shared_minetest_path")
        else:
            break
    load_world_and_mod_data()


def load_world_and_mod_data():
    #if games_path =
    global loaded_mod_list
    global prepackaged_game_mod_list
    while len(loaded_mod_list) > 0 : loaded_mod_list.pop()  # instead of remaking, pop to ensure global is changed
    while len(prepackaged_game_mod_list) > 0 : prepackaged_game_mod_list.pop()
    while len(new_mod_list) > 0 : new_mod_list.pop()
    is_world_changed = False
    auto_chosen_world = False
    is_missing_world = False

    default_world_path = None
    if minetestinfo.contains("primary_world_path"):
        if not os.path.isdir(minetestinfo.get_var("primary_world_path")):
            is_missing_world = True
            print("primary_world_path ERROR: '"+minetestinfo.get_var("primary_world_path")+"' is not a folder.")


    if (not minetestinfo.contains("primary_world_path")) or is_missing_world:
        print ("LOOKING FOR WORLDS IN " + minetestinfo.get_var("worlds_path"))
        for base_path, dirnames, filenames in os.walk(minetestinfo.get_var("worlds_path")):
            #for j in range(0,len(dirnames)):
            #    i = len(dirnames) - 0 - 1
            #    if dirnames[i][0] == ".":
            #        print ("  SKIPPING "+dirnames[i])
            #        dirnames.remove_at(i)
            world_count = 0
            for subdirname in dirnames:
                #print ("  EXAMINING "+subdirname)
                if subdirname[0]!=".":
                    world_count += 1
            index = 0
            world_number = 0
            for subdirname in dirnames:
                print ("  "+subdirname)
                if subdirname[0]!=".":
                    #if (index == len(dirnames)-1):  # skip first one because the one on my computer is big
                    if (subdirname!="world") or (world_number==(world_count-1)):
                        default_world_path = os.path.join(base_path, subdirname) #  os.path.join(minetestinfo.get_var("worlds_path"), "try7amber")
                        auto_chosen_world = True
                        break
                    world_number += 1
                index += 1
            if auto_chosen_world:
                break

        if is_missing_world:
            print("MISSING WORLD '"+minetestinfo.get_var("primary_world_path")+"'")
            if default_world_path is not None:
                print("(so a default was picked below that you can change)")
            else:
                print("(and no world could be found in worlds_path '"+minetestinfo.get_var("worlds_path")+"')")

        default_message = ""
        if default_world_path is not None:
            default_message = " (or world name if above; blank for ["+default_world_path+"])"
        input_string = raw_input("World path"+default_message+": ")
        if (len(input_string)>0):
            try_path = os.path.join(minetestinfo.get_var("worlds_path"), input_string)
            this_primary_world_path = input_string
            if (not os.path.isdir(this_primary_world_path)) and os.path.isdir(try_path):
                this_primary_world_path = try_path
            minetestinfo._data["primary_world_path"] = this_primary_world_path
            auto_chosen_world = False
        else:
            if default_world_path is not None:
                minetestinfo._data["primary_world_path"] = default_world_path
        minetestinfo.save_yaml()
    print("Using world at '"+minetestinfo.get_var("primary_world_path")+"'")
    #game_name = None
    #if minetestinfo.contains("game_path"):
    #    game_name = os.path.basename(minetestinfo.get_var("game_path"))
    tmp_gameid = get_world_var("gameid")
    tmp_game_gameid = get_gameid_from_game_path( minetestinfo.get_var("game_path") )
    if tmp_game_gameid is not None:
        #print("World gameid is "+str(tmp_gameid))
        print(" (game.conf in game_path has 'gameid' "+str(tmp_game_gameid)+")")
    if minetestinfo.contains("game_path"):
        if (tmp_gameid is None) or (tmp_gameid.lower() != tmp_game_gameid.lower()):
            is_world_changed = True

    default_gameid = None
    games_path = os.path.join(minetestinfo.get_var("shared_minetest_path"), "games")
    if (not minetestinfo.contains("game_path")) or is_world_changed:
        if minetestinfo.contains("game_path"):
            default_gameid = get_gameid_from_game_path(minetestinfo.get_var("game_path"))
        if default_gameid is None:
            default_gameid = get_world_var("gameid")
        if default_gameid is not None:
            explained_string = ""
            if minetestinfo.contains("game_path"):
                explained_string = " is different than game_path in "+minetestinfo._config_path+" so game_path must be confirmed"
            print("")
            print("gameid '"+default_gameid+"' detected in world"+explained_string+".")
        game_folder_name_blacklist = list()  # is only used if there is no game defined in world
        game_folder_name_blacklist.append(prepackaged_gameid)
        games_list = list()
        if default_gameid is None:
            if os.path.isdir(games_path):
                folder_path = games_path
                sub_names = os.listdir(folder_path)
                real_count = 0
                for sub_name in sub_names:
                    if (sub_name[:1]!="."):
                        real_count += 1
                real_index = 0
                for sub_name in sub_names:
                    sub_path = os.path.join(folder_path,sub_name)
                    if os.path.isdir(sub_path):
                        if (sub_name[:1]!="."):
                            if (sub_name not in game_folder_name_blacklist) or (real_index>=real_count-1):
                                this_gameid = get_gameid_from_game_path(sub_path)
                                if default_gameid is None:
                                    default_gameid = this_gameid
                                games_list.append(this_gameid)
                    real_index += 1
        if default_gameid is not None:
            path_msg = ""
            default_game_path = get_game_path_from_gameid(default_gameid)
            if default_game_path is None:
                print("ERROR: got default gameid '"+default_gameid+"' but there is no matching game path that has this in game.conf.")
            if len(games_list)>0:
                for try_gameid in games_list:
                    print("  "+try_gameid)
                path_msg = " (or gameid if listed above)"
            minetestinfo.prepare_var("game_path",default_game_path,"game (your subgame) path"+path_msg)
            if minetestinfo.get_var("game_path") in games_list:
                #convert game_path to a game path (this is why intentionally used as param for get_game_path_from_gameid)
                try_path = get_game_path_from_gameid(minetestinfo.get_var("game_path"))
                if try_path is not None:
                    if os.path.isdir(try_path):
                        minetestinfo.set_var("game_path",try_path)
            elif (not os.path.isdir(minetestinfo.get_var("game_path"))):
                try_path = os.path.join(games_path,minetestinfo.get_var("game_path"))
                if os.path.isdir(try_path):
                    minetestinfo.set_var("game_path",try_path)
        else:
            print("WARNING: could not get default gameid--perhaps 'games_path' in '"+minetestinfo._config_path+"' is wrong.")

    mods_path = None
    prepackaged_game_path = None
    if games_path is not None:
        prepackaged_game_path = os.path.join(games_path, prepackaged_gameid)
    print("")
    if len(prepackaged_game_mod_list)<1:
        prepackaged_game_mod_list = get_modified_mod_list_from_game_path(prepackaged_game_mod_list, prepackaged_game_path)
        print(prepackaged_gameid+" has "+str(len(prepackaged_game_mod_list))+" mod(s): "+','.join(prepackaged_game_mod_list))

    if minetestinfo.contains("game_path") and os.path.isdir(minetestinfo.get_var("game_path")):
        loaded_mod_list = get_modified_mod_list_from_game_path(loaded_mod_list, minetestinfo.get_var("game_path"))
        #print("Mod list for current game: "+','.join(loaded_mod_list))

        for this_mod in loaded_mod_list:
            if this_mod not in prepackaged_game_mod_list:
                new_mod_list.append(this_mod)
        new_mod_list_msg = ""
        if len(new_mod_list)>0:
            new_mod_list_msg = ": "+','.join(new_mod_list)
        gameid = os.path.basename(minetestinfo.get_var("game_path"))
        print("")
        print(gameid+" has "+str(len(new_mod_list))+" mod(s) beyond "+prepackaged_gameid+new_mod_list_msg+")")
        if (user_excluded_mod_count>0):
            print("  (not including "+str(user_excluded_mod_count)+" mods(s) excluded by world.mt)")
    else:
        print("Could not find game folder '"+minetestinfo.get_var("game_path")+"'. Please fix game_path in '"+minetestinfo._config_path+"' to point to your subgame, so that game and mod management features will work.")

def get_modified_mod_list_from_game_path(mod_list, game_path):
    global user_excluded_mod_count
    if mod_list is None:
        mod_list = list()
    if game_path is not None and os.path.isdir(game_path):
        mods_path = os.path.join(game_path, "mods")
        folder_path = mods_path
        missing_load_mod_setting_count = 0
        check_world_mt()
        user_excluded_mod_count = 0
        for sub_name in os.listdir(folder_path):
            sub_path = os.path.join(folder_path,sub_name)
            if os.path.isdir(sub_path):
                if (sub_name[:1]!="."):
                    load_this_mod = True
                    load_mod_variable_name = "load_mod_"+sub_name
                    if (world_mt_mapvars is not None) and (load_mod_variable_name in world_mt_mapvars):
                        load_this_mod = get_world_var(load_mod_variable_name)
                        if load_this_mod != True:
                            user_excluded_mod_count += 1
                    if load_this_mod == True:
                        if sub_name not in mod_list:
                            mod_list.append(sub_name)
    return mod_list

world_mt_mapvars = None
world_mt_mapvars_world_path = None
def get_world_var(name):
    result = None
    check_world_mt()
    if (world_mt_mapvars is not None):
        if name in world_mt_mapvars:
            result = world_mt_mapvars[name]
        else:
            print("WARNING: Tried to get '"+name+"' from world but this world.mt does not have the variable")
    return result

def check_world_mt():
    global world_mt_mapvars_world_path
    world_path = minetestinfo.get_var("primary_world_path")
    #world_mt_mapvars = None
    global world_mt_mapvars
    if world_mt_mapvars is None or (world_path != world_mt_mapvars_world_path):
        if world_mt_mapvars is not None:
            print("WARNING: reloading world.mt since was using '"+world_mt_mapvars_world_path+"' but now using '"+world_path+"'")
        world_mt_mapvars_world_path = world_path
        if world_path is not None:
            this_world_mt_path = os.path.join(world_path, "world.mt")
            #DO convert strings to autodetected types:
            world_mt_mapvars = get_dict_from_conf_file(this_world_mt_path,"=")
            if world_mt_mapvars is None:
                print("ERROR: Tried to get world.mt settings but couldn't read '"+this_world_mt_path+"'")
        else:
            print("ERROR: Tried to get '"+name+"' but primary_world_path is None")


init_minetestinfo()