]> jfr.im git - erebus.git/blobdiff - modules/help.py
module cleanup
[erebus.git] / modules / help.py
index b5029515b449aba1d5bb079095e2eb12da24acf5..27c80b7eafb48a19bb45f887a3966fc5f8e39db8 100644 (file)
@@ -6,7 +6,7 @@
 modinfo = {
        'author': 'Erebus Team',
        'license': 'public domain',
-       'compatible': [1,2],
+       'compatible': [2],
        'depends': [],
        'softdeps': [],
 }
@@ -94,19 +94,37 @@ def _mkhelp(level, func):
        return lines
 
 def _genhelp(bot, user, chan, realtarget, *args):
+       module = None
+       minlevel = -1
+       maxlevel = 100
        filepath = bot.parent.cfg.get('help', 'path', default='./help/%d.txt')
-       for level in range(-1, 101):
-               filename = filepath % (level)
+       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)
+               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):
        try:
                _genhelp(bot, user, chan, realtarget, *args)
@@ -125,7 +143,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:
@@ -163,7 +180,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():