X-Git-Url: https://jfr.im/git/erebus.git/blobdiff_plain/36411de919ae2db1ff5b5376e11739c464cec7ae..1bdecfcd0989938a9dbb54227262d2511f34bb09:/modlib.py

diff --git a/modlib.py b/modlib.py
index 2b67c5c..7686536 100644
--- a/modlib.py
+++ b/modlib.py
@@ -22,7 +22,7 @@ class modlib(object):
 	ANYONE  =  -1
 
 	# (channel) access levels
-	OWNER   =   5
+	COWNER  =   5
 	MASTER  =   4
 	OP      =   3
 	VOICE   =   2
@@ -36,26 +36,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():
 			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 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)
+			parent.unhook(cmd, func)
+			parent.unhook("%s.%s" % (self.name, cmd), func)
 		for num, func in self.numhooks.iteritems():
-			self.parent.unhooknum(num, func)
+			parent.unhooknum(num, func)
 		for chan, func in self.chanhooks.iteritems():
-			self.parent.unhookchan(chan, func)
+			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,15 +96,26 @@ class modlib(object):
 			return func
 		return realhook
 
-	def hook(self, cmd, needchan=True, glevel=ANYONE, clevel=PUBLIC):
+	def hook(self, cmd=None, needchan=True, glevel=ANYONE, clevel=PUBLIC):
+		_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):
+				cmd = (cmd,)
+
 			func.needchan = needchan
 			func.reqglevel = glevel
 			func.reqclevel = clevel
+			func.cmd = cmd
+			func.module = func.__module__.split('.')[1]
 
-			self.hooks[cmd] = func
-			if self.parent is not None:
-				self.parent.hook(cmd, func)
+			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
 
@@ -99,6 +132,8 @@ class modlib(object):
 					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
 
@@ -109,5 +144,28 @@ class modlib(object):
 					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 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