]> jfr.im git - erebus.git/blobdiff - modlib.py
modlib - fix argsGE/argsEQ
[erebus.git] / modlib.py
index 313f03348a81d63b54ad760eae00d30c975615dc..199c67f3109810b6b1d616ee585fb63479d4af35 100644 (file)
--- a/modlib.py
+++ b/modlib.py
@@ -22,7 +22,7 @@ class modlib(object):
        ANYONE  =  -1
 
        # (channel) access levels
-       OWNER   =   5
+       COWNER  =   5
        MASTER  =   4
        OP      =   3
        VOICE   =   2
@@ -36,6 +36,7 @@ class modlib(object):
                self.hooks = {}
                self.numhooks = {}
                self.chanhooks = {}
+               self.helps = []
                self.parent = None
 
                self.name = name
@@ -44,18 +45,32 @@ class modlib(object):
                self.parent = parent
                for cmd, func in self.hooks.iteritems():
                        self.parent.hook(cmd, func)
+                       self.parent.hook("%s.%s" % (self.name, cmd), func)
                for num, func in self.numhooks.iteritems():
                        self.parent.hooknum(num, func)
                for chan, func in self.chanhooks.iteritems():
                        self.parent.hookchan(chan, func)
+
+               for func, args, kwargs in self.helps:
+                       try:
+                               self.mod('help').reghelp(func, *args, **kwargs)
+                       except:
+                               pass
                return True
        def modstop(self, parent):
                for cmd, func in self.hooks.iteritems():
                        self.parent.unhook(cmd, func)
+                       self.parent.unhook("%s.%s" % (self.name, cmd), func)
                for num, func in self.numhooks.iteritems():
                        self.parent.unhooknum(num, func)
                for chan, func in self.chanhooks.iteritems():
                        self.parent.unhookchan(chan, func)
+
+               for func, args, kwargs in self.helps:
+                       try:
+                               self.mod('help').dereghelp(func, *args, **kwargs)
+                       except:
+                               pass
                return True
 
        def hooknum(self, num):
@@ -80,14 +95,19 @@ class modlib(object):
                        cmd = _cmd #...and restore it
                        if cmd is None:
                                cmd = func.__name__ # default to function name
+                       if isinstance(cmd, basestring):
+                               cmd = (cmd,)
 
                        func.needchan = needchan
                        func.reqglevel = glevel
                        func.reqclevel = clevel
+                       func.cmd = cmd
 
-                       self.hooks[cmd] = func
-                       if self.parent is not None:
-                               self.parent.hook(cmd, func)
+                       for c in cmd:
+                               self.hooks[c] = func
+                               if self.parent is not None:
+                                       self.parent.hook(c, func)
+                                       self.parent.hook("%s.%s" % (self.name, c), func)
                        return func
                return realhook
 
@@ -105,6 +125,7 @@ class modlib(object):
                                else:
                                        bot.msg(user, self.WRONGARGS)
                        checkargs.__name__ = func.__name__
+                       checkargs.__module__ = func.__module__
                        return checkargs
                return realhook
 
@@ -116,5 +137,27 @@ class modlib(object):
                                else:
                                        bot.msg(user, self.WRONGARGS)
                        checkargs.__name__ = func.__name__
+                       checkargs.__module__ = func.__module__
                        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."
+               """
+               def realhook(func):
+                       if self.parent is not None:
+                               try:
+                                       self.mod('help').reghelp(func, *args, **kwargs)
+                               except:
+                                       pass
+                       self.helps.append((func,args,kwargs))
+                       return func
+               return realhook