update bot.config.example

[erebus.git] / modlib.py

# 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 '<modlib.error %r>' % self.errormsg
	def __str__(self):
		return str(self.errormsg)

class modlib(object):
	# default (global) access levels
	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
	COWNER  =   5
	MASTER  =   4
	OP      =   3
	VOICE   =   2
	#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."

	def __init__(self, name):
		self.hooks = {}
		self.numhooks = {}
		self.chanhooks = {}
		self.exceptionhooks = []
		self.helps = []
		self.parent = None

		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.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:
				self.mod('help').reghelp(func, *args, **kwargs)
			except:
				pass
		return True
	def modstop(self, parent):
		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:
				self.mod('help').dereghelp(func, *args, **kwargs)
			except:
				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
			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...
		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 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)
				else:
					bot.msg(user, self.WRONGARGS)
			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)
			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