X-Git-Url: https://jfr.im/git/erebus.git/blobdiff_plain/a62d0d18bbb5926d22df18db5eba53eb21a10817..92da6dea5d37a76b9ecfe5dec365c14c0574ddb0:/modlib.py diff --git a/modlib.py b/modlib.py index 05ecf53..b09272e 100644 --- a/modlib.py +++ b/modlib.py @@ -1,12 +1,23 @@ # Erebus IRC bot - Author: John Runyon +# vim: fileencoding=utf-8 # module helper functions, see modules/modtest.py for usage # This file is released into the public domain; see http://unlicense.org/ +import sys +from functools import wraps + +if sys.version_info.major < 3: + stringbase = basestring +else: + stringbase = str + +"""Used to return an error to the bot core.""" class error(object): def __init__(self, desc): self.errormsg = desc def __nonzero__(self): return False #object will test to False + __bool__ = __nonzero__ #py3 compat def __repr__(self): return '' % self.errormsg def __str__(self): @@ -18,16 +29,31 @@ class modlib(object): MANAGER = 99 ADMIN = 75 STAFF = 50 - AUTHED = 0 - ANYONE = -1 + KNOWN = 1 + AUTHED = 0 # Users which have are known to be authed + ANYONE = -1 # non-authed users have glevel set to -1 + IGNORED = -2 # The default reqglevel is ANYONE, so any commands will be ignored from IGNORED users unless the command reglevel=-2 + glevs = { + 'OWNER': OWNER, + 'MANAGER': MANAGER, + 'ADMIN': ADMIN, + 'STAFF': STAFF, + 'KNOWN': KNOWN, + 'AUTHED': AUTHED, + 'ANYONE': ANYONE, + 'IGNORED': IGNORED, + } # (channel) access levels COWNER = 5 MASTER = 4 OP = 3 VOICE = 2 - KNOWN = 1 - PUBLIC = 0 #anyone (use glevel to control auth-needed) + #KNOWN = 1 is set above by glevels + PUBLIC = 0 # Anyone (use glevel to control whether auth is needed) + BANNED = -1 # The default reqclevel is PUBLIC, so any commands which needchan will be ignored from BANNED users unless the command reqclevel=-1 + # [ 0 1 2 3 4 5 -1] + clevs = [None, 'Friend', 'Voice', 'Op', 'Master', 'Owner', None] # messages WRONGARGS = "Wrong number of arguments." @@ -36,6 +62,7 @@ class modlib(object): self.hooks = {} self.numhooks = {} self.chanhooks = {} + self.exceptionhooks = [] self.helps = [] self.parent = None @@ -50,13 +77,15 @@ class modlib(object): # non-empty string (or anything else True-y): specified success #"specified" values will be printed. unspecified values will result in "OK" or "failed" 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 cmd, func in self.hooks.items(): + parent.hook(cmd, func) + parent.hook("%s.%s" % (self.name, cmd), func) + for num, func in self.numhooks.items(): + parent.hooknum(num, func) + for chan, func in self.chanhooks.items(): + parent.hookchan(chan, func) + for exc, func in self.exceptionhooks: + parent.hookexception(exc, func) for func, args, kwargs in self.helps: try: @@ -65,13 +94,15 @@ class modlib(object): 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 cmd, func in self.hooks.items(): + parent.unhook(cmd, func) + parent.unhook("%s.%s" % (self.name, cmd), func) + for num, func in self.numhooks.items(): + parent.unhooknum(num, func) + for chan, func in self.chanhooks.items(): + parent.unhookchan(chan, func) + for exc, func in self.exceptionhooks: + parent.unhookexception(exc, func) for func, args, kwargs in self.helps: try: @@ -80,6 +111,14 @@ class modlib(object): pass return True + def hookexception(self, exc): + def realhook(func): + self.exceptionhooks.append((exc, func)) + if self.parent is not None: + self.parent.hookexception(exc, func) + return func + return realhook + def hooknum(self, num): def realhook(func): self.numhooks[str(num)] = func @@ -96,19 +135,25 @@ class modlib(object): return func return realhook - def hook(self, cmd=None, needchan=True, glevel=ANYONE, clevel=PUBLIC): + def hook(self, cmd=None, needchan=True, glevel=ANYONE, clevel=PUBLIC, wantchan=None): + if wantchan is None: wantchan = needchan _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): + if isinstance(cmd, stringbase): cmd = (cmd,) + if clevel > self.PUBLIC and not needchan: + raise Exception('clevel must be left at default if needchan is False') + func.needchan = needchan + func.wantchan = wantchan func.reqglevel = glevel func.reqclevel = clevel func.cmd = cmd + func.module = func.__module__.split('.')[1] for c in cmd: self.hooks[c] = func @@ -126,25 +171,23 @@ class modlib(object): def argsEQ(self, num): def realhook(func): + @wraps(func) def checkargs(bot, user, chan, realtarget, *args): if len(args) == num: 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 argsGE(self, num): def realhook(func): + @wraps(func) def checkargs(bot, user, chan, realtarget, *args): if len(args) >= num: 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 @@ -165,6 +208,6 @@ class modlib(object): self.mod('help').reghelp(func, *args, **kwargs) except: pass - self.helps.append((func,args,kwargs)) + self.helps.append((func, args, kwargs)) return func return realhook