help bugfix

[erebus.git] / modules / help.py

diff --git a/modules/help.py b/modules/help.py
index fe3340cc3721785c7062888562cc906801f5a682..c53500e7824ef68e5a1b4f4d3cfb1771156922d7 100644 (file)
--- a/modules/help.py
+++ b/modules/help.py
@@ -6,7 +6,7 @@
 modinfo = {
        'author': 'Erebus Team',
        'license': 'public domain',
-       'compatible': [1,2],
+       'compatible': [2],
        'depends': [],
        'softdeps': [],
 }
@@ -14,7 +14,12 @@ modinfo = {
 # preamble
 import modlib
 lib = modlib.modlib(__name__)
-modstart = lib.modstart
+def modstart(parent, *args, **kwargs):
+       if parent.cfg.getboolean('erebus', 'nofakelag'):
+               lib.hook('help', needchan=False)(lib.help('[@<module>|<command>]', 'lists commands or describes a command', 'with @<module>, lists all commands in <module>')(help_nolag))
+       else:
+               lib.hook(needchan=False)(lib.help("<command>", "describes a command")(help))
+       return lib.modstart(parent, *args, **kwargs)
 modstop = lib.modstop
 
 # module code
@@ -76,9 +81,9 @@ class HelpLine(object):
 
        def __str__(self):
                if self.admin:
-                       ret = "%-35s(%3s) - %-10s - " % (self.cmd+' '+self.syntax, self.glevel, self.module)
+                       ret = "%-25s(%3s) - %-10s - " % (self.cmd+' '+self.syntax, self.glevel, self.module)
                else:
-                       ret = "%-40s - " % (self.cmd+' '+self.syntax)
+                       ret = "%-30s - " % (self.cmd+' '+self.syntax)
                if self.clevel != 0:
                        ret += "(%s) " % (lib.clevs[self.clevel])
                ret += str(self.shorthelp)
@@ -94,31 +99,47 @@ def _mkhelp(level, func):
        return lines
 
 def _genhelp(bot, user, chan, realtarget, *args):
-       try:
-               filepath = bot.parent.cfg.get('help', 'path', default='./help/%d.txt')
-               for level in range(-1, 101):
+       module = None
+       minlevel = -1
+       maxlevel = 100
+       filepath = bot.parent.cfg.get('help', 'path', default='./help/%d.txt')
+       for arg in args:
+               if arg.startswith("@"):
+                       module = arg[1:]
+               elif arg.startswith("#") and user.glevel >= lib.ADMIN:
+                       minlevel = maxlevel = int(arg[1:])
+               else:
+                       filepath = arg
+                       if minlevel != maxlevel:
+                               minlevel = maxlevel
+       for level in range(minlevel, maxlevel+1):
+               if '%d' in filepath:
                        filename = filepath % (level)
-                       fo = open(filename, 'w')
-                       lines = []
-                       for func in helps.itervalues():
-                               lines += _mkhelp(level, func)
-                       for line in sorted(lines):
-                               fo.write(str(line)+"\n")
-       except Exception as e:
-               return e
+               else:
+                       filename = filepath
+               fo = open(filename, 'w')
+               lines = []
+               for func in helps.itervalues():
+                       if module is not None and func.module != module:
+                                       continue
+                       lines += _mkhelp(level, func)
+               for line in sorted(lines):
+                       fo.write(str(line)+"\n")
+               fo.close()
        return True
 
 @lib.hook(glevel=1, needchan=False)
-@lib.help(None, "generates help file", "default path: ./help/<level>.txt", "config as: [help]", "path = ./help/%d.txt")
+@lib.help("[@<module>] [#<level>] [file]", "generates help file", "arguments are all optional and may be specified in any order", "default file: ./help/<level>.txt", "config as: [help]", "path = ./help/%d.txt")
 def genhelp(bot, user, chan, realtarget, *args):
-       ret = _genhelp(bot, user, chan, realtarget, *args)
-       if not isinstance(ret, BaseException):
-               bot.msg(user, "Help written.")
-       else:
-               bot.msg(user, "Failed writing help. %s" % (ret))
+       try:
+               _genhelp(bot, user, chan, realtarget, *args)
+       except Exception as e:
+               bot.msg(user, "Failed writing help. %s" % (e))
+               return
+       bot.msg(user, "Help written.")
 
-@lib.hook(needchan=False)
-@lib.help("<command>", "describes a command")
+#@lib.hook(needchan=False)
+#@lib.help("<command>", "describes a command")
 @lib.argsGE(1)
 def help(bot, user, chan, realtarget, *args):
        cmd = str(' '.join(args)).lower()
@@ -127,7 +148,6 @@ def help(bot, user, chan, realtarget, *args):
                bot.slowmsg(user, str(HelpLine(func.cmd[0], func.syntax, func.shorthelp, (user.glevel > 0), func.reqglevel, func.module, func.reqclevel)))
                for line in func.longhelps:
                        bot.slowmsg(user, "  %s" % (line))
-               bot.slowmsg(user, "End of help for %s." % (func.cmd[0]))
                if len(func.cmd) > 1:
                        bot.slowmsg(user, "  Aliases: %s" % (' '.join(func.cmd[1:])))
        else:
@@ -137,7 +157,10 @@ def help(bot, user, chan, realtarget, *args):
 @lib.help(None, "provides command list")
 def showcommands(bot, user, chan, realtarget, *args):
        if bool(int(bot.parent.cfg.get('help', 'autogen', default=0))):
-               _genhelp(bot, user, chan, realtarget, *args)
+               try:
+                       _genhelp(bot, user, chan, realtarget, *args)
+               except: pass
+
        url = bot.parent.cfg.get('help', 'url', default=None)
        if url is None:
                try:
@@ -151,10 +174,9 @@ def showcommands(bot, user, chan, realtarget, *args):
        else:
                bot.msg(user, "I don't know where help is. Sorry. Contact my owner.")
 
-"""#DISABLED
-@lib.hook(needchan=False)
-@lib.help('[@<module>|<command>]', 'lists commands or describes a command', 'with @<module>, lists all commands in <module>')
-def help(bot, user, chan, realtarget, *args):
+#@lib.hook(needchan=False)
+#@lib.help('[@<module>|<command>]', 'lists commands or describes a command', 'with @<module>, lists all commands in <module>')
+def help_nolag(bot, user, chan, realtarget, *args):
        if len(args) == 0: # list commands
                lines = []
                for func in helps.itervalues():
@@ -162,7 +184,7 @@ def help(bot, user, chan, realtarget, *args):
                for line in sorted(lines):
                        bot.slowmsg(user, str(line))
                bot.slowmsg(user, "End of command listing.")
-       elif args[0][0] == "@":
+       elif args[0].startswith("@"):
                lines = []
                mod = args[0][1:].lower()
                for func in helps.itervalues():
@@ -184,5 +206,3 @@ def help(bot, user, chan, realtarget, *args):
                                bot.slowmsg(user, "  Aliases: %s" % (' '.join(func.cmd[1:])))
                else:
                        bot.slowmsg(user, "No help found for %s" % (cmd))
-"""
-pass