]> jfr.im git - erebus.git/blob - modules/help.py
help - make response format match for cmd list vs single cmd
[erebus.git] / modules / help.py
1 # Erebus IRC bot - Author: Erebus Team
2 # help module
3 # This file is released into the public domain; see http://unlicense.org/
4
5 # module info
6 modinfo = {
7 'author': 'Erebus Team',
8 'license': 'public domain',
9 'compatible': [1], # compatible module API versions
10 'depends': [], # other modules required to work properly?
11 }
12
13 # preamble
14 import modlib
15 lib = modlib.modlib(__name__)
16 modstart = lib.modstart
17 modstop = lib.modstop
18
19 # module code
20 helps = {}
21 cmds = {}
22
23 # ! this is part of this module's API, called from modlib.help()
24 # this function only handles the command name and aliases - the rest is passed directly to _reghelp()
25 def reghelp(func, *args, **kwargs):
26 syntax = None
27 shorthelp = None
28 longhelps = []
29
30 if len(args) > 0:
31 syntax = args[0]
32 if len(args) > 1:
33 shorthelp = args[1]
34 if len(args) > 2:
35 longhelps = args[2:]
36
37 if 'syntax' in kwargs:
38 syntax = kwargs['syntax']
39 if 'shorthelp' in kwargs:
40 shorthelp = kwargs['shorthelp']
41 if 'longhelps' in kwargs:
42 longhelps = kwargs['longhelps']
43
44 if syntax is None: syntax = ""
45 if shorthelp is None: shorthelp = ""
46
47 func.syntax = syntax
48 func.shorthelp = shorthelp
49 func.longhelps = longhelps
50 helps[func] = func
51 for c in func.cmd:
52 cmds[c] = func
53
54 def dereghelp(func, *args, **kwargs):
55 for c in func.cmd:
56 del cmds[cmd]
57 del helps[func]
58
59 class HelpLine(object):
60 def __init__(self, cmd, syntax, shorthelp, admin, level, module):
61 self.cmd = cmd
62 self.syntax = syntax
63 self.shorthelp = shorthelp
64 self.admin = admin
65 self.level = level
66 self.module = module
67
68 def __cmp__(self, other):
69 if self.level == other.level:
70 return cmp(self.cmd, other.cmd)
71 else:
72 return cmp(self.level, other.level)
73
74
75 def __str__(self):
76 if self.admin:
77 return "%-35s(%3s) - %-10s - %-50s" % (self.cmd+' '+self.syntax, self.level, self.module, self.shorthelp)
78 else:
79 return "%-40s - %-50s" % (self.cmd+' '+self.syntax, self.shorthelp)
80
81 @lib.hook(needchan=False)
82 @lib.help('[<command>]', 'lists commands or describes a command')
83 def help(bot, user, chan, realtarget, *args):
84 if len(args) == 0: # list commands
85 lines = []
86 for func in helps.itervalues():
87 if user.glevel >= func.reqglevel:
88 lines.append(HelpLine(func.cmd[0], func.syntax, func.shorthelp, (user.glevel > 0), func.reqglevel, func.__module__))
89 if len(func.cmd) > 1:
90 for c in func.cmd[1:]:
91 lines.append(HelpLine(c, "", "Alias of %s" % (func.cmd[0]), (user.glevel > 0), func.reqglevel, func.__module__))
92 for line in sorted(lines):
93 bot.slowmsg(user, str(line))
94 else: # help for a specific command/topic
95 cmd = str(' '.join(args))
96 if cmd in cmds and user.glevel >= cmds[cmd].reqglevel:
97 func = cmds[cmd]
98 bot.slowmsg(user, str(HelpLine(func.cmd[0], func.syntax, func.shorthelp, (user.glevel > 0), func.reqglevel, func.__module__)))
99 for line in func.longhelps:
100 bot.slowmsg(user, " %s" % (line))
101
102 if len(func.cmd) > 1:
103 bot.slowmsg(user, " Aliases: %s" % (' '.join(func.cmd[1:])))
104 else:
105 bot.slowmsg(user, "No help found for %s" % (cmd))