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,2],
  10         'depends': [],
  11         'softdeps': [],
  12 }
  13
  14 # preamble
  15 import modlib
  16 lib = modlib.modlib(__name__)
  17 modstart = lib.modstart
  18 modstop = lib.modstop
  19
  20 # module code
  21 import os.path
  22 helps = {}
  23 cmds  = {}
  24
  25 # ! this is part of this module's API, called from modlib.help()
  26 def reghelp(func, *args, **kwargs):
  27         syntax = None
  28         shorthelp = None
  29         longhelps = []
  30
  31         if len(args) > 0:
  32                 syntax = args[0]
  33                 if len(args) > 1:
  34                         shorthelp = args[1]
  35                         if len(args) > 2:
  36                                 longhelps = args[2:]
  37
  38         if 'syntax' in kwargs:
  39                 syntax = kwargs['syntax']
  40         if 'shorthelp' in kwargs:
  41                 shorthelp = kwargs['shorthelp']
  42         if 'longhelps' in kwargs:
  43                 longhelps = kwargs['longhelps']
  44
  45         if syntax is None: syntax = ""
  46         if shorthelp is None: shorthelp = ""
  47
  48         func.syntax = syntax
  49         func.shorthelp = shorthelp
  50         func.longhelps = longhelps
  51         helps[func] = func
  52         for c in func.cmd:
  53                 cmds[c] = func
  54
  55 def dereghelp(func, *args, **kwargs):
  56         for c in func.cmd:
  57                 del cmds[c]
  58         del helps[func]
  59
  60 class HelpLine(object):
  61         def __init__(self, cmd, syntax, shorthelp, admin, glevel, module, clevel):
  62                 self.cmd = cmd
  63                 self.syntax = syntax
  64                 self.shorthelp = shorthelp
  65                 self.admin = admin
  66                 self.glevel = glevel
  67                 self.module = module
  68                 self.clevel = clevel
  69
  70         def __cmp__(self, other):
  71                 if self.glevel == other.glevel:
  72                         return cmp(self.cmd, other.cmd)
  73                 else:
  74                         return cmp(self.glevel, other.glevel)
  75
  76
  77         def __str__(self):
  78                 if self.admin:
  79                         ret = "%-35s(%3s) - %-10s - " % (self.cmd+' '+self.syntax, self.glevel, self.module)
  80                 else:
  81                         ret = "%-40s - " % (self.cmd+' '+self.syntax)
  82                 if self.clevel != 0:
  83                         ret += "(%s) " % (lib.clevs[self.clevel])
  84                 ret += str(self.shorthelp)
  85                 return ret
  86
  87 def _mkhelp(level, func):
  88         lines = []
  89         if level >= func.reqglevel:
  90                 lines.append(HelpLine(func.cmd[0], func.syntax, func.shorthelp, (level > 0), func.reqglevel, func.module, func.reqclevel))
  91                 if len(func.cmd) > 1:
  92                         for c in func.cmd[1:]:
  93                                 lines.append(HelpLine(c, "", "Alias of %s" % (func.cmd[0]), (level > 0), func.reqglevel, func.module, func.reqclevel))
  94         return lines
  95
  96 def _genhelp(bot, user, chan, realtarget, *args):
  97         try:
  98                 filepath = bot.parent.cfg.get('help', 'path', default='./help/%d.txt')
  99                 for level in range(-1, 101):
 100                         filename = filepath % (level)
 101                         fo = open(filename, 'w')
 102                         lines = []
 103                         for func in helps.itervalues():
 104                                 lines += _mkhelp(level, func)
 105                         for line in sorted(lines):
 106                                 fo.write(str(line)+"\n")
 107         except Exception as e:
 108                 return e
 109         return True
 110
 111 @lib.hook(glevel=1, needchan=False)
 112 @lib.help(None, "generates help file", "default path: ./help/<level>.txt", "config as: [help]", "path = ./help/%d.txt")
 113 #TODO: use args... "[@<module>] [#<level>] [<file>]"
 114 def genhelp(bot, user, chan, realtarget, *args):
 115         ret = _genhelp(bot, user, chan, realtarget, *args)
 116         if not isinstance(ret, BaseException):
 117                 bot.msg(user, "Help written.")
 118         else:
 119                 bot.msg(user, "Failed writing help. %s" % (ret))
 120
 121 @lib.hook(needchan=False)
 122 @lib.help("<command>", "describes a command")
 123 @lib.argsGE(1)
 124 def help(bot, user, chan, realtarget, *args):
 125         cmd = str(' '.join(args)).lower()
 126         if cmd in cmds and user.glevel >= cmds[cmd].reqglevel:
 127                 func = cmds[cmd]
 128                 bot.slowmsg(user, str(HelpLine(func.cmd[0], func.syntax, func.shorthelp, (user.glevel > 0), func.reqglevel, func.module, func.reqclevel)))
 129                 for line in func.longhelps:
 130                         bot.slowmsg(user, "  %s" % (line))
 131                 bot.slowmsg(user, "End of help for %s." % (func.cmd[0]))
 132                 if len(func.cmd) > 1:
 133                         bot.slowmsg(user, "  Aliases: %s" % (' '.join(func.cmd[1:])))
 134         else:
 135                 bot.slowmsg(user, "No help found for %s" % (cmd))
 136
 137 @lib.hook(needchan=False)
 138 @lib.help(None, "provides command list")
 139 def showcommands(bot, user, chan, realtarget, *args):
 140         if bool(int(bot.parent.cfg.get('help', 'autogen', default=0))):
 141                 _genhelp(bot, user, chan, realtarget, *args)
 142         url = bot.parent.cfg.get('help', 'url', default=None)
 143         if url is None:
 144                 try:
 145                         import urllib2
 146                         myip = urllib2.urlopen("https://api.ipify.org").read()
 147                         url = "http://%s/help/%%d.txt (maybe)" % (myip)
 148                 except: url = None
 149         if url is not None:
 150                 url = url % (user.glevel)
 151                 bot.msg(user, "Help is at: %s" % (url))
 152         else:
 153                 bot.msg(user, "I don't know where help is. Sorry. Contact my owner.")
 154
 155 """#DISABLED
 156 @lib.hook(needchan=False)
 157 @lib.help('[@<module>|<command>]', 'lists commands or describes a command', 'with @<module>, lists all commands in <module>')
 158 def help(bot, user, chan, realtarget, *args):
 159         if len(args) == 0: # list commands
 160                 lines = []
 161                 for func in helps.itervalues():
 162                         lines += _mkhelp(user, func)
 163                 for line in sorted(lines):
 164                         bot.slowmsg(user, str(line))
 165                 bot.slowmsg(user, "End of command listing.")
 166         elif args[0][0] == "@":
 167                 lines = []
 168                 mod = args[0][1:].lower()
 169                 for func in helps.itervalues():
 170                         if func.module == mod:
 171                                 lines += _mkhelp(user, func)
 172                 for line in sorted(lines):
 173                         bot.slowmsg(user, str(line))
 174                 bot.slowmsg(user, "End of command listing.")
 175         else: # help for a specific command/topic
 176                 cmd = str(' '.join(args)).lower()
 177                 if cmd in cmds and user.glevel >= cmds[cmd].reqglevel:
 178                         func = cmds[cmd]
 179                         bot.slowmsg(user, str(HelpLine(func.cmd[0], func.syntax, func.shorthelp, (user.glevel > 0), func.reqglevel, func.module)))
 180                         for line in func.longhelps:
 181                                 bot.slowmsg(user, "  %s" % (line))
 182                         bot.slowmsg(user, "End of help for %s." % (func.cmd[0]))
 183
 184                         if len(func.cmd) > 1:
 185                                 bot.slowmsg(user, "  Aliases: %s" % (' '.join(func.cmd[1:])))
 186                 else:
 187                         bot.slowmsg(user, "No help found for %s" % (cmd))
 188 """
 189 pass