added aliases for command hooks

[erebus.git] / modlib.py

diff --git a/modlib.py b/modlib.py
index 02b657e6859b11266e8a06130de708ce60d2cd18..30e07858987a5ee3f38cf7e92654e2534d97d956 100644 (file)
--- a/modlib.py
+++ b/modlib.py
@@ -14,19 +14,20 @@ class error(object):
 
 class modlib(object):
        # default (global) access levels
-       MANAGER = 100
-       ADMIN = 75
-       STAFF = 50
-       AUTHED = 0
-       ANYONE = -1
+       OWNER   = 100
+       MANAGER =  99
+       ADMIN   =  75
+       STAFF   =  50
+       AUTHED  =   0
+       ANYONE  =  -1
 
        # (channel) access levels
-       OWNER = 5
-       MASTER = 4
-       OP = 3
-       VOICE = 2
-       KNOWN = 1
-       PUBLIC = 0 #anyone (use glevel to control auth-needed)
+       OWNER   =   5
+       MASTER  =   4
+       OP      =   3
+       VOICE   =   2
+       KNOWN   =   1
+       PUBLIC  =   0 #anyone (use glevel to control auth-needed)
 
        # messages
        WRONGARGS = "Wrong number of arguments."
@@ -59,9 +60,9 @@ class modlib(object):
 
        def hooknum(self, num):
                def realhook(func):
-                       self.numhooks[num] = func
+                       self.numhooks[str(num)] = func
                        if self.parent is not None:
-                               self.parent.hooknum(num, func)
+                               self.parent.hooknum(str(num), func)
                        return func
                return realhook
 
@@ -73,18 +74,32 @@ class modlib(object):
                        return func
                return realhook
 
-       def hook(self, cmd, needchan=True, glevel=ANYONE, clevel=PUBLIC):
+       def hook(self, cmd=None, needchan=True, glevel=ANYONE, clevel=PUBLIC):
+               _cmd = cmd #save this since it gets wiped out...
                def realhook(func):
+                       cmd = _cmd #...and restore it
+                       if cmd is None:
+                               cmd = func.__name__ # default to function name
+
                        func.needchan = needchan
                        func.reqglevel = glevel
                        func.reqclevel = clevel
 
-                       self.hooks[cmd] = func
-                       if self.parent is not None:
-                               self.parent.hook(cmd, func)
+                       if isinstance(cmd, basestring):
+                               cmd = (cmd,)
+                       for c in cmd:
+                               self.hooks[c] = func
+                               if self.parent is not None:
+                                       self.parent.hook(c, func)
                        return func
                return realhook
 
+       def mod(self, modname):
+               if self.parent is not None:
+                       return self.parent.module(modname)
+               else:
+                       return error('unknown parent')
+
        def argsEQ(self, num):
                def realhook(func):
                        def checkargs(bot, user, chan, realtarget, *args):
@@ -92,6 +107,7 @@ class modlib(object):
                                        return func(bot, user, chan, realtarget, *args)
                                else:
                                        bot.msg(user, self.WRONGARGS)
+                       checkargs.__name__ = func.__name__
                        return checkargs
                return realhook
 
@@ -102,5 +118,22 @@ class modlib(object):
                                        return func(bot, user, chan, realtarget, *args)
                                else:
                                        bot.msg(user, self.WRONGARGS)
+                       checkargs.__name__ = func.__name__
                        return checkargs
                return realhook
+
+       def help(self, *args, **kwargs):
+               """help(syntax, shorthelp, longhelp, more lines longhelp, cmd=...?)
+               Example:
+               help("<user> <pass>", "login")
+                       ^ Help will only be one line. Command name determined based on function name.
+               help("<user> <level>", "add a user", cmd=("adduser", "useradd"))
+                       ^ Help will be listed under ADDUSER; USERADD will say "alias for adduser"
+               help(None, "do stuff", "This command is really complicated.")
+                       ^ Command takes no args. Short description (in overall HELP listing) is "do stuff".
+                       Long description (HELP <command>) will say "<command> - do stuff", newline, "This command is really complicated."
+               """
+               try:
+                       self.mod('help').reghelp(*args, **kwargs)
+               except:
+                       pass