control - update help text

[erebus.git] / modules / control.py

diff --git a/modules/control.py b/modules/control.py
index 5c95b0b6cad5f8ab0e6aad491ea1df73cf0ad2b0..34018fc0e775f6b87b9323f38b4d43c94267d6ff 100644 (file)
--- a/modules/control.py
+++ b/modules/control.py
@@ -6,8 +6,9 @@
 modinfo = {
        'author': 'Erebus Team',
        'license': 'public domain',
-       'compatible': [1],
+       'compatible': [1,2],
        'depends': [],
+       'softdeps': ['help'],
 }
 
 # preamble
@@ -23,6 +24,7 @@ from collections import deque
 
 
 @lib.hook(('die','restart'), needchan=False, glevel=lib.MANAGER)
+@lib.help(None, "stops the bot")
 def die(bot, user, chan, realtarget, *args):
        for botitem in bot.parent.bots.itervalues():
                for chan in botitem.chans:
@@ -32,6 +34,7 @@ def die(bot, user, chan, realtarget, *args):
        os._exit(0)
 
 @lib.hook(needchan=False, glevel=lib.MANAGER)
+@lib.help("<mod>", "loads a module")
 @lib.argsEQ(1)
 def modload(bot, user, chan, realtarget, *args):
        okay = ctlmod.load(bot.parent, args[0])
@@ -41,8 +44,13 @@ def modload(bot, user, chan, realtarget, *args):
                bot.msg(user, "Error loading %s: %r" % (args[0], okay))
 
 @lib.hook(needchan=False, glevel=lib.MANAGER)
-@lib.argsEQ(1)
+@lib.help("<mod> [FORCE]", "unloads a module", "will refuse to unload a module which is depended on by others", "unless you specify FORCE.")
+@lib.argsGE(1)
 def modunload(bot, user, chan, realtarget, *args):
+       if len(ctlmod.dependents[args[0]]) > 0:
+               if len(args) == 1 or args[1].lower() != "force":
+                       bot.msg(user, "That module has dependents! Say MODUNLOAD %s FORCE to unload it and any dependents." % (args[0]))
+                       return
        okay = ctlmod.unload(bot.parent, args[0])
        if okay:
                bot.msg(user, "Unloaded %s" % (args[0]))
@@ -50,6 +58,7 @@ def modunload(bot, user, chan, realtarget, *args):
                bot.msg(user, "Error unloading %s: %r" % (args[0], okay))
 
 @lib.hook(needchan=False, glevel=lib.MANAGER)
+@lib.help("<mod>", "reloads a module")
 @lib.argsEQ(1)
 def modreload(bot, user, chan, realtarget, *args):
        okay = ctlmod.reloadmod(bot.parent, args[0])
@@ -59,11 +68,12 @@ def modreload(bot, user, chan, realtarget, *args):
                bot.msg(user, "Error occurred: %r" % (okay))
 
 @lib.hook(needchan=False, glevel=lib.STAFF)
+@lib.help(None, "list loaded modules")
 @lib.argsEQ(0)
 def modlist(bot, user, chan, realtarget, *args):
        mods = ctlmod.modules
-       for mod in mods.itervalues():
-               bot.msg(user, "- %s %r" % (mod.__name__, mod))
+       for modname, mod in mods.iteritems():
+               bot.msg(user, "- %s (%s) [%s]" % ((modname, mod.__file__, ', '.join(ctlmod.dependents[modname]))))
        bot.msg(user, "Done.")
 
 def _whois(user, chan, showglevel=True, showclevel=True):
@@ -90,23 +100,37 @@ def _whois(user, chan, showglevel=True, showclevel=True):
        return fmt % fillers
 
 @lib.hook(needchan=False)
+@lib.help("<user|#auth>", "shows who someone is")
 @lib.argsEQ(1)
 def whois(bot, user, chan, realtarget, *args):
-       target = bot.parent.user(args[0], create=False)
+       name = args[0]
+       if name.startswith("#"):
+               target = bot.parent.User(name, name[1:])
+       else:
+               target = bot.parent.user(name, create=False)
        if target is None:
                bot.msg(user, "I don't know %s." % (args[0]))
        else:
                bot.msg(user, "%s is %s" % (args[0], _whois(target, chan, (user.glevel >= 1), (chan is not None and chan.levelof(user.auth) >= 1))))
 
 @lib.hook(needchan=False)
+@lib.help(None, "shows who you are")
 def whoami(bot, user, chan, realtarget, *args):
        bot.msg(user, "You are %s" % (_whois(user, chan)))
 
+@lib.hook(needchan=False)
+@lib.help(None, "tries to read your auth and access level again")
+def auth(bot, user, chan, realtarget, *args):
+       bot.msg(user, "Okay, give me a second.")
+       bot.conn.send("WHO %s n%%ant,2" % (user))
+
 @lib.hook(needchan=False, glevel=1)
+@lib.help(None, "displays length of each msgqueue")
 def qstat(bot, user, chan, realtarget, *args):
        bot.fastmsg(user, "Regular: %d -- Slow: %d" % (len(bot.msgqueue), len(bot.slowmsgqueue)))
 
 @lib.hook(needchan=False, glevel=lib.ADMIN)
+@lib.help("[regular|slow]", "clears both or a specific msgqueue")
 def qclear(bot, user, chan, realtarget, *args):
        if len(args) == 0:
                bot.msgqueue = deque()