# 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:
else:
stringbase = str
+"""Used to return an error to the bot core."""
class error(object):
- """Used to return an error to the bot core."""
def __init__(self, desc):
self.errormsg = desc
def __nonzero__(self):
MANAGER = 99
ADMIN = 75
STAFF = 50
- AUTHED = 0
- ANYONE = -1
- IGNORED = -2
+ 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)
- BANNED = -1
+ 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', None]
+ clevs = [None, 'Friend', 'Voice', 'Op', 'Master', 'Owner', 'Banned']
# messages
WRONGARGS = "Wrong number of arguments."
def __init__(self, name):
- self.hooks = {}
- self.numhooks = {}
- self.chanhooks = {}
+ 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
#"specified" values will be printed. unspecified values will result in "OK" or "failed"
self.parent = parent
for cmd, func in self.hooks.items():
- self.parent.hook(cmd, func)
- self.parent.hook("%s.%s" % (self.name, cmd), func)
- for num, func in self.numhooks.items():
- self.parent.hooknum(num, func)
+ parent.hook(cmd, func)
+ parent.hook("%s.%s" % (self.name, cmd), func)
for chan, func in self.chanhooks.items():
- self.parent.hookchan(chan, func)
+ 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:
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 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:
pass
return True
- def hooknum(self, num):
- def realhook(func):
- self.numhooks[str(num)] = func
- if self.parent is not None:
- self.parent.hooknum(str(num), 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 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...
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
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
+
+ def hooknum(self, num):
+ def realhook(func):
+ self.numhooks[str(num)] = func
+ if self.parent is not None:
+ self.parent.hooknum(str(num), func)
+ return func
+ return realhook
+
+ def bind(self, bindto, data=None):
+ """Used as a decorator on a class which implements getdata and parse methods.
+ See modules/sockets.py for an example.
+ Takes an arg like:
+ [unix:]/foo/bar
+ [udp|tcp:][ip:]port
+ """
+ if len(bindto) == 0:
+ raise Exception('bindto must have a value')
+ if bindto[0] == '/':
+ return self._hooksocket(socket.AF_UNIX, socket.SOCK_STREAM, bindto)
+ if len(bindto) > 5 and bindto[0:5] == 'unix:':
+ return self._hooksocket(socket.AF_UNIX, socket.SOCK_STREAM, bindto[5:])
+ af = socket.AF_INET
+ ty = socket.SOCK_STREAM
+ host = '0.0.0.0'
+ if len(bindto) > 4 and bindto[0:4] == 'udp:':
+ ty = socket.SOCK_DGRAM
+ bindto = bindto[4:]
+ if len(bindto) > 4 and bindto[0:4] == 'tcp:':
+ bindto = bindto[4:]
+ if ':' in bindto:
+ pieces = bindto.rsplit(':', 1)
+ host = pieces[0]
+ bindto = pieces[1]
+ port = int(bindto)
+ return self._hooksocket(af, ty, (host, port), data)
+
+ def bind_tcp(self, host, port, data=None):
+ return self._hooksocket(socket.AF_INET, socket.SOCK_STREAM, (host, port), data)
+ def bind_udp(self, host, port, data=None):
+ return self._hooksocket(socket.AF_INET, socket.SOCK_DGRAM, (host, port), data)
+ def bind_unix(self, path, data=None):
+ return self._hooksocket(socket.AF_UNIX, socket.SOCK_STREAM, path, data)
+ def _hooksocket(self, af, ty, address, data):
+ 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, data))
+ if self.parent is not None:
+ self._create_socket(af, ty, address, cls, data)
+ return cls
+ return realhook
+ def _create_socket(self, af, ty, address, cls, data):
+ 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, data)
+ 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 (%r, %r, %r, %r)' % (af, ty, address, cls))
+ def _destroy_socket(self, sock, obj):
+ obj.close()
+
def mod(self, modname):
if self.parent is not None:
return self.parent.module(modname)
self.helps.append((func, args, kwargs))
return func
return realhook
+
+class _ListenSocket(object):
+ def __init__(self, lib, sock, cls, data):
+ self.clients = []
+ self.lib = lib
+ self.sock = sock
+ self.cls = cls
+ self.data = data
+
+ def _make_closer(self, obj, client):
+ def close():
+ 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, self.data)
+ 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