X-Git-Url: https://jfr.im/git/erebus.git/blobdiff_plain/69071d33cc3db3ecc258b945dd7a9d9d4d92b391..591964e837ca06bef75e99a022dbb09582488f51:/modlib.py diff --git a/modlib.py b/modlib.py index d2fe492..89a75d4 100644 --- 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,33 +36,48 @@ class modlib(object): self.hooks = {} self.numhooks = {} self.chanhooks = {} + self.helps = [] self.parent = None - self.name = name + self.name = (name.split("."))[-1] def modstart(self, parent): 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): 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 @@ -74,18 +89,34 @@ 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 + 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 + 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): @@ -93,6 +124,8 @@ class modlib(object): return func(bot, user, chan, realtarget, *args) else: bot.msg(user, self.WRONGARGS) + checkargs.__name__ = func.__name__ + checkargs.__module__ = func.__module__ return checkargs return realhook @@ -103,5 +136,28 @@ class modlib(object): return func(bot, user, chan, realtarget, *args) 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(" ", "login") + ^ Help will only be one line. Command name determined based on function name. + help(" ", "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 ) will say " - 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