command_toggler.py

"""
command_toggler - Runtime enable/disable toggle for registered modules.

Provides a Toggler singleton and the !toggler admin command. Other modules
register themselves with init/deinit callbacks; admins can then flip them on
or off live without restarting the server. Calling !toggler with no arguments
lists all registered modules and their current state.

Usage:
    !toggler                  # list all modules and their status
    !toggler <module_name>    # toggle the named module on or off

Initialization:
    import command_toggler
    command_toggler.init()    # creates the global Toggler and registers !toggler

Registering a module:
    from command_toggler import g_toggler
    # enabled=True means the module starts active (init already called by you);
    # enabled=False means it starts inactive (deinit already called / never init'd).
    g_toggler.register("mymodule", mymodule.init, mymodule.deinit, enabled=True)
"""

import realityadmin as radmin


g_toggler = None


TOGGLER_PERMISSIONS = 0


def init():
    global g_toggler
    g_toggler = Toggler()


class Toggler(object):
    def __init__(self):
        self.modules = {}
        self.toggles = {}
        radmin.addCommand("toggler", self.commandHandler, TOGGLER_PERMISSIONS)

    def register(self, name, init, deinit, enabled=True):
        if self.modules.get(name, None) is not None:
            raise Exception("Module %s already registered" % name)
        self.modules[name] = (init, deinit)
        self.toggles[name] = enabled

    def commandHandler(self, args, player):
        response, outcome = self.handle(args, player)
        radmin.personalMessage(response, player)
        return outcome

    def handle(self, args, player):
        if len(args) < 1:
            # List all modules and their status
            response = "Modules:\n"
            for name, (init, deinit) in self.modules.items():
                status = "enabled" if self.toggles[name] else "disabled"
                response += "%s: %s\n" % (name, status)
            return response, True

        name = args[0]
        if self.modules.get(name, None) is None:
            return "No such module: %s" % name, False

        init, deinit = self.modules[name]
        if self.toggles[name]:
            deinit()
            self.toggles[name] = False
            return "Module %s disabled" % name, True
        else:
            init()
            self.toggles[name] = True
            return "Module %s enabled" % name, True