modules/control.py

   1 # Erebus IRC bot - Author: Erebus Team
   2 # vim: fileencoding=utf-8
   3 # Various highly recommended "control" commands.
   4 # This file is released into the public domain; see http://unlicense.org/
   5
   6 # module info
   7 modinfo = {
   8         'author': 'Erebus Team',
   9         'license': 'public domain',
  10         'compatible': [0],
  11         'depends': [],
  12         'softdeps': ['help'],
  13 }
  14
  15 # preamble
  16 import modlib
  17 lib = modlib.modlib(__name__)
  18 modstart = lib.modstart
  19 modstop = lib.modstop
  20
  21 # module code
  22 import sys, os
  23 import ctlmod
  24 from collections import deque
  25
  26
  27 @lib.hook(('die','restart'), needchan=False, glevel=lib.MANAGER)
  28 @lib.help(None, "stops the bot")
  29 def die(bot, user, chan, realtarget, *args):
  30         quitmsg = ' '.join(args)
  31         for botitem in bot.parent.bots.values():
  32                 bot.conn.send("QUIT :Restarting. %s" % (quitmsg))
  33         sys.exit(0)
  34         os._exit(0)
  35
  36 @lib.hook(needchan=False, glevel=lib.MANAGER)
  37 @lib.help("<mod>", "loads a module")
  38 @lib.argsEQ(1)
  39 def modload(bot, user, chan, realtarget, *args):
  40         okay = ctlmod.load(bot.parent, args[0])
  41         if okay:
  42                 bot.msg(user, "Loaded %s" % (args[0]))
  43         else:
  44                 bot.msg(user, "Error loading %s: %r" % (args[0], okay))
  45
  46 @lib.hook(needchan=False, glevel=lib.MANAGER)
  47 @lib.help("<mod> [FORCE]", "unloads a module", "will refuse to unload a module which is depended on by others", "unless you specify FORCE.")
  48 @lib.argsGE(1)
  49 def modunload(bot, user, chan, realtarget, *args):
  50         if not ctlmod.isloaded(args[0]):
  51                 bot.msg(user, "%s is not loaded" % (args[0]))
  52                 return
  53         if len(ctlmod.dependents[args[0]]) > 0:
  54                 if len(args) == 1 or args[1].lower() != "force":
  55                         bot.msg(user, "That module has dependents! Say MODUNLOAD %s FORCE to unload it and any dependents." % (args[0]))
  56                         return
  57
  58         okay = ctlmod.unload(bot.parent, args[0])
  59         if okay:
  60                 bot.msg(user, "Unloaded %s" % (args[0]))
  61         else:
  62                 bot.msg(user, "Error unloading %s: %r" % (args[0], okay))
  63
  64 @lib.hook(needchan=False, glevel=lib.MANAGER)
  65 @lib.help("<mod>", "reloads a module")
  66 @lib.argsEQ(1)
  67 def modreload(bot, user, chan, realtarget, *args):
  68         if not ctlmod.isloaded(args[0]):
  69                 bot.msg(user, "%s is not loaded" % (args[0]))
  70                 return
  71
  72         okay = ctlmod.reloadmod(bot.parent, args[0])
  73         if okay:
  74                 bot.msg(user, "Reloaded %s" % (args[0]))
  75         else:
  76                 bot.msg(user, "Error occurred: %r" % (okay))
  77
  78 @lib.hook(needchan=False, glevel=lib.STAFF)
  79 @lib.help(None, "list loaded modules")
  80 @lib.argsEQ(0)
  81 def modlist(bot, user, chan, realtarget, *args):
  82         mods = ctlmod.modules
  83         for modname, mod in sorted(mods.items()):
  84                 bot.msg(user, "- %s (%s) [%s]" % ((modname, mod.__file__, ', '.join(ctlmod.dependents[modname]))))
  85         bot.msg(user, "Done.")
  86
  87 def _whois(user, chan, showglevel=True, showclevel=True):
  88         if not user.isauthed():
  89                 return "not authed."
  90
  91         fillers = {'auth': user.auth}
  92         fmt = "%(auth)s"
  93
  94         if showglevel and user.glevel >= 1:
  95                         fillers['glevel'] = user.glevel
  96                         fmt += " (global access: %(glevel)s)"
  97         elif user.glevel >= 1:
  98                 fmt += " (staff)"
  99         else:
 100                 fmt += " (not staff)"
 101
 102         if (showclevel or showglevel) and chan is not None:
 103                 clev = chan.levelof(user.auth)
 104                 if clev >= 1:
 105                         fillers['clevel'] = (lib.clevs[clev] if clev < len(lib.clevs) else clev)
 106                         fmt += " (channel access: %(clevel)s)"
 107                 else:
 108                         fmt += " (not a channel user)"
 109         return fmt % fillers
 110
 111 @lib.hook(needchan=False, wantchan=True)
 112 @lib.help("<user|#auth>", "shows who someone is")
 113 @lib.argsEQ(1)
 114 def whois(bot, user, chan, realtarget, *args):
 115         name = args[0]
 116         if name.startswith("#"):
 117                 target = bot.parent.User(name, name[1:])
 118         else:
 119                 target = bot.parent.user(name, create=False)
 120         if target is None:
 121                 return  "I don't know %s." % (args[0])
 122         else:
 123                 return "%s is %s" % (args[0], _whois(target, chan, (user.glevel >= 1), (chan is not None and chan.levelof(user.auth) >= 1)))
 124
 125 @lib.hook(needchan=False, wantchan=True)
 126 @lib.help(None, "shows who you are")
 127 def whoami(bot, user, chan, realtarget, *args):
 128         return "You are %s" % (_whois(user, chan))
 129
 130 @lib.hook(needchan=False)
 131 @lib.help(None, "tries to read your auth and access level again")
 132 def auth(bot, user, chan, realtarget, *args):
 133         bot.msg(user, "Okay, give me a second.")
 134         bot.conn.send("WHO %s n%%ant,2" % (user))
 135
 136 @lib.hook(needchan=False, glevel=1)
 137 @lib.help(None, "displays length of each msgqueue")
 138 def qstat(bot, user, chan, realtarget, *args):
 139         bot.fastmsg(user, "Regular: %d -- Slow: %d" % (len(bot.msgqueue), len(bot.slowmsgqueue)))
 140
 141 @lib.hook(('qclear','cq','clearq','clearqueue'), needchan=False, glevel=lib.ADMIN)
 142 @lib.help("[regular|slow]", "clears both or a specific msgqueue")
 143 def qclear(bot, user, chan, realtarget, *args):
 144         if len(args) == 0:
 145                 bot.msgqueue = deque()
 146                 bot.slowmsgqueue = deque()
 147                 bot.fastmsg(user, "Cleared both msgqueues.")
 148         else:
 149                 if args[0] == 'regular':
 150                         bot.msgqueue = deque()
 151                 elif args[0] == 'slow':
 152                         bot.slowmsgqueue = deque()
 153                 else:
 154                         bot.fastmsg(user, "Syntax: QCLEAR [regular|slow]")
 155                         return #short-circuit
 156                 bot.fastmsg(user, "Cleared that msgqueue.")