# Erebus IRC bot - Author: Erebus Team
+# vim: fileencoding=utf-8
# help module
# This file is released into the public domain; see http://unlicense.org/
modinfo = {
'author': 'Erebus Team',
'license': 'public domain',
- 'compatible': [1,2],
+ 'compatible': [0],
'depends': [],
'softdeps': [],
}
# 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('help', needchan=False)(lib.help("<command>", "describes a command", "see also: showcommands")(help))
+ return lib.modstart(parent, *args, **kwargs)
modstop = lib.modstop
# module code
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)
return lines
def _genhelp(bot, user, chan, realtarget, *args):
- module = None
+ module = ''
minlevel = -1
maxlevel = 100
- filepath = bot.parent.cfg.get('help', 'path', default='./help/%d.txt')
+ filepath = bot.parent.cfg.get('help', 'path', default='./help/%(@)s%(#)d.txt')
for arg in args:
- if arg[0] == "@":
+ if arg.startswith("@"):
+ if "." in arg[1:]:
+ raise Exception('Module option must not contain "."')
module = arg[1:]
- elif arg[0] == "#" and user.glevel >= lib.OWNER:
+ 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:
- filepath = arg
- if minlevel != maxlevel:
- minlevel = maxlevel
- print "%r %r %r %r" % (module, minlevel, maxlevel, filepath)
+ raise Exception('Unknown option given to GENHELP: %s' % (arg))
for level in range(minlevel, maxlevel+1):
- if '%d' in filepath:
- filename = filepath % (level)
- else:
- filename = filepath
+ filename = filepath % {'#': level, '+': maxlevel, '-': minlevel, '@': module}
fo = open(filename, 'w')
lines = []
- for func in helps.itervalues():
- if module is not None and func.module != module:
+ for func in helps.values():
+ if module != '' and func.module != module:
continue
lines += _mkhelp(level, func)
for line in sorted(lines):
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>] [#<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)
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()
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:
@lib.hook(needchan=False)
@lib.help(None, "provides command list")
def showcommands(bot, user, chan, realtarget, *args):
- if bool(int(bot.parent.cfg.get('help', 'autogen', default=0))):
+ if bot.parent.cfg.getboolean('help', 'autogen'):
try:
_genhelp(bot, user, chan, realtarget, *args)
except: pass
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():
+ for func in helps.values():
lines += _mkhelp(user, func)
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():
+ for func in helps.values():
if func.module == mod:
lines += _mkhelp(user, func)
for line in sorted(lines):
cmd = str(' '.join(args)).lower()
if cmd in cmds and user.glevel >= cmds[cmd].reqglevel:
func = cmds[cmd]
- bot.slowmsg(user, str(HelpLine(func.cmd[0], func.syntax, func.shorthelp, (user.glevel > 0), func.reqglevel, func.module)))
+ 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]))
bot.slowmsg(user, " Aliases: %s" % (' '.join(func.cmd[1:])))
else:
bot.slowmsg(user, "No help found for %s" % (cmd))
-"""
-pass
projects / erebus.git / blobdiff