# 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
+import socket
+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 '<modlib.error %r>' % self.errormsg
def __str__(self):
- return self.errormsg
+ return str(self.errormsg)
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
+ 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
- OWNER = -10
- MASTER = -8 #master is {-8,-9}
- OP = -5 #op is {-5,-6,-7}
- VOICE = -4
- KNOWN = -3
- PUBLIC = -2 #anyone (use glevel to control auth-needed)
+ COWNER = 5
+ MASTER = 4
+ OP = 3
+ VOICE = 2
+ FRIEND = 1
+ 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', 'Banned']
# messages
WRONGARGS = "Wrong number of arguments."
def __init__(self, name):
- self.hooks = {}
+ self.hooks = {} # {command:handler}
+ self.chanhooks = {} # {channel:handler}
+ self.exceptionhooks = [] # [(exception,handler)]
+ self.numhooks = {} # {numeric:handler}
+ self.sockhooks = [] # [(af,ty,address,handler_class)]
+ self.sockets = [] # [(sock,obj)]
+ self.helps = []
self.parent = None
- self.name = name
+ self.name = (name.split("."))[-1]
def modstart(self, parent):
+ #modstart can return a few things...
+ # None: unspecified success
+ # False: unspecified error
+ # modlib.error (or anything else False-y): specified error
+ # True: unspecified success
+ # 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)
+ for cmd, func in self.hooks.items():
+ parent.hook(cmd, func)
+ parent.hook("%s.%s" % (self.name, cmd), func)
+ for chan, func in self.chanhooks.items():
+ parent.hookchan(chan, func)
+ for exc, func in self.exceptionhooks:
+ parent.hookexception(exc, func)
+ for num, func in self.numhooks.items():
+ parent.hooknum(num, func)
+ for hookdata in self.sockhooks:
+ self._create_socket(*hookdata)
+
+ 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)
+ for cmd, func in self.hooks.items():
+ parent.unhook(cmd, func)
+ parent.unhook("%s.%s" % (self.name, cmd), func)
+ for chan, func in self.chanhooks.items():
+ parent.unhookchan(chan, func)
+ for exc, func in self.exceptionhooks:
+ parent.unhookexception(exc, func)
+ for num, func in self.numhooks.items():
+ parent.unhooknum(num, func)
+ for sock, obj in self.sockets:
+ self._destroy_socket(sock, obj)
+
+ for func, args, kwargs in self.helps:
+ try:
+ self.mod('help').dereghelp(func, *args, **kwargs)
+ except:
+ pass
return True
- def hook(self, cmd, 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, 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
+ 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 hookchan(self, chan, glevel=ANYONE, clevel=PUBLIC):
+ def realhook(func):
+ self.chanhooks[chan] = func
+ if self.parent is not None:
+ self.parent.hookchan(chan, func)
+ return func
+ return realhook
+
+ 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
- self.hooks[cmd] = func
+ def hooknum(self, num):
+ def realhook(func):
+ self.numhooks[str(num)] = func
if self.parent is not None:
- self.parent.hook(cmd, func)
+ self.parent.hooknum(str(num), func)
return func
return realhook
+ def bind_tcp(self, host, port):
+ return self._hooksocket(socket.AF_INET, socket.SOCK_STREAM, (host, port))
+ def bind_udp(self, host, port):
+ return self._hooksocket(socket.AF_INET, socket.SOCK_DGRAM, (host, port))
+ def bind_unix(self, path):
+ return self._hooksocket(socket.AF_UNIX, socket.SOCK_STREAM, path)
+ def _hooksocket(self, af, ty, address):
+ def realhook(cls):
+ if not (hasattr(cls, 'getdata') and callable(cls.getdata)):
+ # Check early that the object implements getdata.
+ # If getdata ever returns a non-empty list, then a parse method must also exist, but we don't check that.
+ raise Exception('Attempted to hook a socket without a class to process data')
+ self.sockhooks.append((af, ty, address, cls))
+ if self.parent is not None:
+ self._create_socket(af, ty, address, cls)
+ return cls
+ return realhook
+ def _create_socket(self, af, ty, address, cls):
+ ty = ty | socket.SOCK_NONBLOCK
+ sock = socket.socket(af, ty)
+ sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
+ sock.bind(address)
+ obj = _ListenSocket(self, sock, cls)
+ self.sockets.append((sock,obj))
+ sock.listen(5)
+ self.parent.newfd(obj, sock.fileno())
+ self.parent.log(repr(obj), '?', 'Socket ready to accept new connections')
+ def _destroy_socket(self, sock, obj):
+ obj.close()
+
+ 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):
+ @wraps(func)
def checkargs(bot, user, chan, realtarget, *args):
if len(args) == num:
return func(bot, user, chan, realtarget, *args)
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)
bot.msg(user, self.WRONGARGS)
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
+
+class _ListenSocket(object):
+ def __init__(self, lib, sock, cls):
+ self.clients = []
+ self.lib = lib
+ self.sock = sock
+ self.cls = cls
+
+ def _make_closer(self, obj, client):
+ def close():
+ print(repr(self), repr(obj))
+ self.lib.parent.log(repr(self), '?', 'Closing child socket %d' % (client.fileno()))
+ try:
+ obj.closing()
+ except AttributeError:
+ pass
+ self.lib.parent.delfd(client.fileno())
+ client.shutdown(socket.SHUT_RDWR)
+ client.close()
+ self.clients.remove((client,obj))
+ return close
+
+ def getdata(self):
+ client, addr = self.sock.accept()
+ obj = self.cls(client)
+ obj.close = self._make_closer(obj, client)
+ self.lib.parent.log(repr(self), '?', 'New connection %d from %s' % (client.fileno(), addr))
+ self.clients.append((client,obj))
+ self.lib.parent.newfd(obj, client.fileno())
+ return []
+
+ def close(self):
+ self.lib.parent.log(repr(self), '?', 'Socket closing')
+ if self.sock.fileno() != -1:
+ self.lib.parent.delfd(self.sock.fileno())
+ self.sock.shutdown(socket.SHUT_RDWR)
+ self.sock.close()
+ for client, obj in self.clients:
+ obj.close()
+
+ def __repr__(self): return '<_ListenSocket #%d>' % (self.sock.fileno())
projects / erebus.git / blobdiff