+@functools.total_ordering
+class HelpLine(object):
+ def __init__(self, cmd, syntax, shorthelp, admin, glevel, module, clevel):
+ self.cmd = cmd
+ self.syntax = syntax
+ self.shorthelp = shorthelp
+ self.admin = admin
+ self.glevel = glevel
+ self.module = module
+ self.clevel = clevel
+
+ def __lt__(self, other):
+ if self.glevel == other.glevel:
+ return self.cmd < other.cmd
+ else:
+ return self.glevel < other.glevel
+
+ def __eq__(self, other):
+ return self.glevel == other.glevel and self.cmd == other.cmd
+
+ def __cmp__(self, other):
+ if self.glevel == other.glevel:
+ return cmp(self.cmd, other.cmd)
+ else:
+ return cmp(self.glevel, other.glevel)
+
+
+ def __str__(self):
+ if self.admin:
+ ret = "%-25s(%3s) - %-10s - " % (self.cmd+' '+self.syntax, self.glevel, self.module)
+ else:
+ ret = "%-30s - " % (self.cmd+' '+self.syntax)
+ if self.clevel != 0:
+ ret += "(%s) " % (lib.clevs[self.clevel])
+ ret += str(self.shorthelp)
+ return ret
+
+def _mkhelp(level, func):
+ lines = []
+ if level >= func.reqglevel:
+ lines.append(HelpLine(func.cmd[0], func.syntax, func.shorthelp, (level > 0), func.reqglevel, func.module, func.reqclevel))
+ if len(func.cmd) > 1:
+ for c in func.cmd[1:]:
+ lines.append(HelpLine(c, "", "Alias of %s" % (func.cmd[0]), (level > 0), func.reqglevel, func.module, func.reqclevel))
+ return lines
+
+def _genhelp(bot, user, chan, realtarget, *args):
+ module = ''
+ minlevel = -1
+ maxlevel = 100
+ filepath = bot.parent.cfg.get('help', 'path', default='./help/%(@)s%(#)d.txt')
+ for arg in args:
+ if arg.startswith("@"):
+ if "." in arg[1:]:
+ raise Exception('Module option must not contain "."')
+ module = arg[1:]
+ elif arg.startswith("#") and user.glevel >= lib.ADMIN:
+ minlevel = maxlevel = int(arg[1:])
+ elif arg.startswith("+"):
+ maxlevel = int(arg[1:])
+ elif arg.startswith("-"):
+ minlevel = int(arg[1:])
+ elif arg.startswith("./"):
+ if "./" in arg[1:]:
+ raise Exception('Filename option must not contain "./" except as the first two characters')
+ else:
+ filepath = os.path.join('help', arg[2:])
+ else:
+ raise Exception('Unknown option given to GENHELP: %s' % (arg))
+ for level in range(minlevel, maxlevel+1):
+ filename = filepath % {'#': level, '+': maxlevel, '-': minlevel, '@': module}
+ fo = open(filename, 'w')
+ lines = []
+ for func in helps.values():
+ if module != '' 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("[@<module>] [#<exact_level>] [+<max_level>] [-<min_level>] [./<filename>]", "generates help file", "arguments are all optional and may be specified in any order", "default file: ./<module><level>.txt, with module blank if not supplied. will always be under help/", "filename can also contain %(@)s, %(#)s, %(+)s, %(-)s", "for module, current (single) level, max and min level, respectively")
+def genhelp(bot, user, chan, realtarget, *args):
+ 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.")
+
+# This is hooked in modstart
+#@lib.hook(needchan=False)
+#@lib.help("<command>", "describes a command")