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