modules/control.py

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