pluginLoader.py

#!/usr/bin/python
# -*- coding: utf-8 -*-

"""
Copyright (c) 2014 trgk

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
"""

import itertools
import os
import sys
import types
import warnings
from importlib.machinery import SourceFileLoader

_suppress_warnings = False


def suppress_warnings(flag: bool):
    global _suppress_warnings
    _suppress_warnings = flag


# Get absolute path of current executable
if getattr(sys, "frozen", False):
    # frozen
    basepath = os.path.dirname(sys.executable)
else:
    # unfrozen
    basepath = os.path.dirname(os.path.realpath(__file__))


def getGlobalPluginDirectory():
    return os.path.join(basepath, "plugins")


def getPluginPath(pluginName):
    if pluginName[-3:] == ".py" or pluginName[-4:] == ".eps":
        pluginPath = os.path.abspath(pluginName)
    else:
        # Try eps
        pluginPath = os.path.join(basepath, "plugins", "%s.eps" % pluginName)
        if not os.path.exists(pluginPath):
            pluginPath = os.path.join(basepath, "plugins", "%s.py" % pluginName)

    return pluginPath


def empty():
    pass


freeze_enabled = True
prompt_enabled = False
scbank_enabled = False
scbankSettings = None


def isFreezeIssued():
    return freeze_enabled


def isPromptIssued():
    return prompt_enabled


def isSCBankIssued():
    return scbank_enabled


def getSCBankSettings():
    return scbankSettings


def loadPluginsFromConfig(ep, config):
    from eudplib.maprw.injector.mainloop import _set_game_loop_start

    global freeze_enabled, prompt_enabled, scbank_enabled, scbankSettings

    """ Load plugin from config file """
    pluginList = [name for name in config.keys() if name != "main"]

    # detect [unlimiter] plugin and its variants
    if any("unlimiter" in name.casefold() for name in pluginList):
        from eudplib.eudlib.utilf.unlimiterflag import _turnUnlimiterOn

        _turnUnlimiterOn()

    # Get stat_txt.tbl entries to parse
    for pluginName in pluginList:
        if pluginName == "dataDumper":
            dataDumperConfig = config[pluginName]
            for dataPath, outOffsetStr in dataDumperConfig.items():
                flags = []
                outOffsets = []
                unknownArg = []
                for outOffset in outOffsetStr.split(","):
                    outOffset = outOffset.strip()
                    if outOffset == "copy" or outOffset == "unpatchable":
                        flags.append(outOffset)
                        continue
                    try:
                        outOffset = int(outOffset, base=0)
                    except ValueError:
                        unknownArg.append(outOffset)
                    else:
                        outOffsets.append(outOffset)

                # ..\temp\custom_txt.tbl : 0x6D5A30, copy
                tblOffset = 0x6D5A30
                if tblOffset in outOffsets:
                    from eudplib.string.tblprint import _AddStatText

                    outOffsets = list(filter(lambda x: x != tblOffset, outOffsets))
                    print((' - Loading stat_txt.tbl file "{}"...').format(dataPath))
                    with open(dataPath, "rb") as file:
                        _AddStatText(file.read())
                if not outOffsets and not unknownArg:
                    dataDumperConfig[dataPath] = None
                    continue
                outOffsets = map(str, outOffsets)
                dataDumperConfig[dataPath] = ", ".join(
                    itertools.chain(flags, outOffsets, unknownArg)
                )

    onPluginStarts = []
    beforeTriggerExecs = [lambda: _set_game_loop_start()]
    afterTriggerExecs = []

    initialDirectory = os.getcwd()
    initialPath = sys.path[:]
    initial_warnfilters = warnings.filters.copy()

    for pluginName in pluginList:
        if pluginName == "freeze":
            if "freeze" in config[pluginName]:
                freeze_enabled = False
                continue
            print("Freeze plugin loaded")
            if "prompt" in config[pluginName]:
                prompt_enabled = True
            continue

        elif pluginName == "SCBank":
            scbank_enabled = True
            print("SCBank plugin loaded")
            SCBankSettings = config[pluginName]
            try:
                msqc_settings = config["MSQC"]
            except KeyError:
                raise Exception("MSQC must be enabled to use SCBank")
            if pluginList.index("SCBank") > pluginList.index("MSQC"):
                raise Exception("SCBank should be written before MSQC")
            try:
                scbank_key = SCBankSettings["key"]
            except KeyError:
                raise Exception("SCBank key must be provided")
            import base64
            import binascii

            try:
                base64.b64decode(scbank_key)
            except binascii.Error:
                raise Exception("SCBank key must be base64 encoded")
            from scbank_core import init_settings

            msqc_scbank = init_settings(SCBankSettings)
            msqc_settings.update(msqc_scbank)
            config["MSQC"] = msqc_settings
            continue

        pluginSettings = config[pluginName]

        print("Loading plugin %s..." % pluginName)

        # real python name
        pluginPath = getPluginPath(pluginName)

        try:
            if _suppress_warnings:
                warnings.filterwarnings("ignore")
                warnings.filterwarnings("ignore", category=DeprecationWarning)
            else:
                warnings.simplefilter("always")
            pluginDir = os.path.dirname(pluginPath)
            if pluginDir and pluginDir not in sys.path:
                sys.path.insert(1, os.path.abspath(pluginDir))

            moduleName = os.path.splitext(os.path.basename(pluginPath))[0]
            pluginModule = types.ModuleType(moduleName)
            pluginModule.__dict__["settings"] = pluginSettings

            if pluginPath.endswith(".eps"):
                loader = ep.EPSLoader(moduleName, pluginPath)
            else:
                loader = SourceFileLoader(moduleName, pluginPath)

            pluginModule.__name__ = moduleName
            pluginModule.__loader__ = loader
            sys.modules[moduleName] = pluginModule

            loader.exec_module(pluginModule)

            pluginDict = pluginModule.__dict__

            if pluginDict:
                onPluginStarts.append(pluginDict.get("onPluginStart", empty))
                beforeTriggerExecs.append(pluginDict.get("beforeTriggerExec", empty))
                afterTriggerExecs.append(pluginDict.get("afterTriggerExec", empty))

        except (KeyboardInterrupt, SystemExit):
            raise

        except Exception:
            raise RuntimeError('Error loading plugin "%s"' % pluginName)

        finally:
            os.chdir(initialDirectory)
            sys.path[:] = initialPath[:]
            warnings.fliters = initial_warnfilters

    if isFreezeIssued():
        print(
            """\
                          *                                         *
        *                                        *
                        [[ freeze activated ]]
                                  *                       *
                *                                                          *\
"""
        )

    return {
        "onPluginStart": onPluginStarts,
        "beforeTriggerExec": beforeTriggerExecs,
        "afterTriggerExec": afterTriggerExecs,
    }