X-Git-Url: https://jfr.im/git/erebus.git/blobdiff_plain/b670c2f4e7385c688ffb2e0d05d607a8946e12eb..7c4a7d0ac3865f38f18c91ef6725c1408195c387:/modlib.py

diff --git a/modlib.py b/modlib.py
index 43187f9..e5c8d81 100644
--- a/modlib.py
+++ b/modlib.py
@@ -2,11 +2,20 @@
 # module helper functions, see modules/modtest.py for usage
 # This file is released into the public domain; see http://unlicense.org/
 
+import sys
+
+if sys.version_info.major < 3:
+	stringbase = basestring
+else:
+	stringbase = str
+
 class error(object):
+	"""Used to return an error to the bot core."""
 	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):
@@ -20,14 +29,18 @@ class modlib(object):
 	STAFF   =  50
 	AUTHED  =   0
 	ANYONE  =  -1
+	IGNORED =  -2
 
 	# (channel) access levels
-	OWNER   =   5
+	COWNER  =   5
 	MASTER  =   4
 	OP      =   3
 	VOICE   =   2
 	KNOWN   =   1
 	PUBLIC  =   0 #anyone (use glevel to control auth-needed)
+	BANNED  =  -1
+	#         [   0         1        2     3         4        5    -1]
+	clevs   = [None, 'Friend', 'Voice', 'Op', 'Master', 'Owner', None]
 
 	# messages
 	WRONGARGS = "Wrong number of arguments."
@@ -36,26 +49,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):
+		#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():
+		for cmd, func in self.hooks.items():
 			self.parent.hook(cmd, func)
-		for num, func in self.numhooks.iteritems():
+			self.parent.hook("%s.%s" % (self.name, cmd), func)
+		for num, func in self.numhooks.items():
 			self.parent.hooknum(num, func)
-		for chan, func in self.chanhooks.iteritems():
+		for chan, func in self.chanhooks.items():
 			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)
-		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 func, args, kwargs in self.helps:
+			try:
+				self.mod('help').dereghelp(func, *args, **kwargs)
+			except:
+				pass
 		return True
 
 	def hooknum(self, num):
@@ -74,20 +109,28 @@ 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, stringbase):
+				cmd = (cmd,)
 
 			func.needchan = needchan
+			func.wantchan = wantchan
 			func.reqglevel = glevel
 			func.reqclevel = clevel
-
-			self.hooks[cmd] = func
-			if self.parent is not None:
-				self.parent.hook(cmd, func)
+			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
 
@@ -105,6 +148,7 @@ class modlib(object):
 				else:
 					bot.msg(user, self.WRONGARGS)
 			checkargs.__name__ = func.__name__
+			checkargs.__module__ = func.__module__
 			return checkargs
 		return realhook
 
@@ -116,11 +160,12 @@ class modlib(object):
 				else:
 					bot.msg(user, self.WRONGARGS)
 			checkargs.__name__ = func.__name__
+			checkargs.__module__ = func.__module__
 			return checkargs
 		return realhook
 
-	def help(*args, **kwargs):
-		"""help(args, shorthelp, longhelp, more lines longhelp, cmd=...?)
+	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.
@@ -130,7 +175,12 @@ class modlib(object):
 			^ 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."
 		"""
-		try:
-			self.mod('help').reghelp(*args, **kwargs)
-		except:
-			pass
+		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