]> jfr.im git - erebus.git/blob - bot.py
config - add delete method
[erebus.git] / bot.py
1 #!/usr/bin/python
2 # vim: fileencoding=utf-8
3
4 # Erebus IRC bot - Author: John Runyon
5 # "Bot" and "BotConnection" classes (handling a specific "arm")
6
7 import socket, sys, time, threading, os, random, struct
8 from collections import deque
9
10 if sys.version_info.major < 3:
11 timerbase = threading._Timer
12 stringbase = basestring
13 else:
14 timerbase = threading.Timer
15 stringbase = str
16
17 class MyTimer(timerbase):
18 def __init__(self, *args, **kwargs):
19 timerbase.__init__(self, *args, **kwargs)
20 self.daemon = True
21
22 if sys.version_info.major < 3:
23 stringbase = basestring
24 else:
25 stringbase = str
26
27 #bots = {'erebus': bot.Bot(nick='Erebus', user='erebus', bind='', server='irc.quakenet.org', port=6667, realname='Erebus')}
28 class Bot(object):
29 def __init__(self, parent, nick, user, bind, authname, authpass, server, port, realname):
30 self.parent = parent
31 self.nick = nick
32 self.permnick = nick
33 self.user = user
34 self.realname = realname
35
36 self.authname = authname
37 self.authpass = authpass
38
39 self.connecttime = 0 # time at which we received numeric 001
40 self.server = server # the address we try to (re-)connect to
41 self.port = port
42 self.servername = server # the name of the server we got connected to
43
44 curs = self.parent.query("SELECT chname FROM chans WHERE bot = %s AND active = 1", (self.permnick,))
45 if curs:
46 chansres = curs.fetchall()
47 curs.close()
48 self.chans = [self.parent.newchannel(self, row['chname']) for row in chansres]
49 else:
50 self.chans = []
51
52 self.conn = BotConnection(self, bind, server, port)
53
54 self.lastreceived = time.time() #time we last received a line from the server
55 self.watchdog()
56
57 self.msgqueue = deque()
58 self.slowmsgqueue = deque()
59 self._makemsgtimer()
60 self._msgtimer.start()
61 self.joined_chans = False
62
63 def __del__(self):
64 try:
65 curs = self.parent.query("UPDATE bots SET connected = 0 WHERE nick = %s", (self.permnick,))
66 curs.close()
67 except: pass
68
69 def watchdog(self):
70 if time.time() > int(self.parent.cfg.get('watchdog', 'maxtime', default=300))+self.lastreceived:
71 self.parse("ERROR :Fake-error from watchdog timer.")
72 if self.conn.registered():
73 self.conn.send("PING :%s" % (time.time()))
74 self._checknick()
75 watchdogtimer = MyTimer(int(self.parent.cfg.get('watchdog', 'interval', default=30)), self.watchdog)
76 watchdogtimer.start()
77
78 def log(self, *args, **kwargs):
79 self.parent.log(self.nick, *args, **kwargs)
80
81 def connect(self):
82 self.log('!', "Connecting")
83 if self.conn.connect():
84 self.log('!', "Connected")
85 self.parent.newfd(self, self.conn.socket.fileno())
86
87 def getdata(self):
88 try:
89 recvd = self.conn.read()
90 self.lastreceived = time.time()
91 return recvd
92 except EOFError as e:
93 return [":%s ERROR :%s%r" % (self.nick, e.__class__.__name__, e.args)]
94
95 def _checknick(self): # check if we're using the right nick, try changing
96 if self.nick != self.permnick and self.conn.registered():
97 self.conn.send("NICK %s" % (self.permnick))
98
99 def parse(self, line):
100 if self.parent.cfg.getboolean('debug', 'io'):
101 self.log('I', line)
102 pieces = line.split()
103
104 if pieces[0][0] == ":":
105 numeric = pieces[1]
106 else:
107 numeric = pieces[0]
108
109 # dispatch dict
110 dispatch = {
111 'NOTICE': self._gotconnected,
112 '001': self._got001,
113 '004': self._got004,
114 '376': self._gotRegistered,
115 '422': self._gotRegistered,
116 'PRIVMSG': self._gotprivmsg,
117 '353': self._got353, #NAMES
118 '354': self._got354, #WHO
119 '396': self._gotHiddenHost, # hidden host has been set
120 '433': self._got433, #nick in use
121 'JOIN': self._gotjoin,
122 'PART': self._gotpart,
123 'KICK': self._gotkick,
124 'QUIT': self._gotquit,
125 'NICK': self._gotnick,
126 'MODE': self._gotmode,
127 'PING': self._gotping,
128 'ERROR': self._goterror,
129 }
130
131 if self.parent.hasnumhook(numeric):
132 hooks = self.parent.getnumhook(numeric)
133 for callback in hooks:
134 try:
135 callback(self, line)
136 except Exception:
137 self.__debug_cbexception("numhook", line)
138
139 if numeric in dispatch:
140 dispatch[numeric](pieces)
141
142 def _gotconnected(self, pieces):
143 if not self.conn.registered():
144 self.conn.register()
145 def _gotping(self, pieces):
146 self.conn.send("PONG %s" % (pieces[1]))
147 self._checknick()
148 def _goterror(self, pieces):
149 # TODO: better handling, just reconnect that single bot
150 error = ' '.join(pieces)
151 try:
152 raise Exception(error)
153 except Exception as e:
154 self.parent.mustquit = e
155 try:
156 self.quit("Error detected: %s" % (error))
157 except: pass
158 try:
159 curs = self.parent.query("UPDATE bots SET connected = 0")
160 curs.close()
161 except: pass
162 self.log('!', 'Bot exiting due to: %s' % (error))
163 def _got001(self, pieces):
164 # We wait until the end of MOTD instead to consider ourselves registered, but consider uptime as of 001
165 self.connecttime = time.time()
166 def _got004(self, pieces):
167 self.servername = pieces[3]
168 def _gotRegistered(self, pieces):
169 self.conn.registered(True)
170
171 curs = self.parent.query("UPDATE bots SET connected = 1 WHERE nick = %s", (self.permnick,))
172 if curs: curs.close()
173
174 self.conn.send("MODE %s +x" % (pieces[2]))
175 if self.authname is not None and self.authpass is not None:
176 self.conn.send(self.parent.cfg.get('erebus', 'auth_command', "AUTH %s %s") % (self.authname, self.authpass))
177 if not self.parent.cfg.getboolean('erebus', 'wait_for_hidden_host'):
178 for c in self.chans:
179 self.join(c.name)
180 self.joined_chans = True
181 def _gotHiddenHost(self, pieces):
182 if not self.joined_chans and self.parent.cfg.getboolean('erebus', 'wait_for_hidden_host'):
183 for c in self.chans:
184 self.join(c.name)
185 self.joined_chans = True
186 def _gotprivmsg(self, pieces):
187 nick = pieces[0].split('!')[0][1:]
188 user = self.parent.user(nick)
189 target = pieces[2]
190 msg = ' '.join(pieces[3:])[1:]
191 self.parsemsg(user, target, msg)
192 def _got353(self, pieces):
193 prefixes = {'@': 'op', '+': 'voice'}
194 chan = self.parent.channel(pieces[4])
195 names = pieces[5:]
196 names[0] = names[0][1:] #remove colon
197 for n in names:
198 if n[0] in prefixes:
199 user = self.parent.user(n[1:])
200 chan.userjoin(user, prefixes[n[0]])
201 else:
202 user = self.parent.user(n)
203 chan.userjoin(user)
204 user.join(chan)
205 def _got354(self, pieces):
206 qt = int(pieces[3])
207 if qt < 3:
208 nick, auth = pieces[4:6]
209 chan = None
210 else:
211 chan, nick, auth = pieces[4:7]
212 chan = self.parent.channel(chan)
213 user = self.parent.user(nick)
214 user.authed(auth)
215
216 if chan is not None:
217 user.join(chan)
218 chan.userjoin(user)
219
220 if qt == 2: # triggered by !auth
221 if user.isauthed():
222 if user.glevel > 0:
223 self.msg(nick, "You are now known as #%s (access level: %s)" % (auth, user.glevel))
224 else:
225 self.msg(nick, "You are now known as #%s (not staff)" % (auth))
226 else:
227 self.msg(nick, "I tried, but you're not authed!")
228 def _got433(self, pieces):
229 if not self.conn.registered(): #we're trying to connect
230 newnick = "%s%d" % (self.nick, random.randint(111, 999))
231 self.conn.send("NICK %s" % (newnick))
232 self.nick = newnick
233 def _gotjoin(self, pieces):
234 nick = pieces[0].split('!')[0][1:]
235 chan = self.parent.channel(pieces[2])
236
237 if nick == self.nick:
238 self.conn.send("WHO %s c%%cant,3" % (chan))
239 else:
240 user = self.parent.user(nick, justjoined=True)
241 chan.userjoin(user)
242 user.join(chan)
243 def _clientLeft(self, nick, chan):
244 if nick != self.nick:
245 gone = self.parent.user(nick).part(chan)
246 chan.userpart(self.parent.user(nick))
247 if gone:
248 self.parent.user(nick).quit()
249 del self.parent.users[nick.lower()]
250 def _gotpart(self, pieces):
251 nick = pieces[0].split('!')[0][1:]
252 chan = self.parent.channel(pieces[2])
253 self._clientLeft(nick, chan)
254 def _gotkick(self, pieces):
255 nick = pieces[3]
256 chan = self.parent.channel(pieces[2])
257 self._clientLeft(nick, chan)
258 def _gotquit(self, pieces):
259 nick = pieces[0].split('!')[0][1:]
260 if nick != self.nick:
261 for chan in self.parent.user(nick).chans:
262 chan.userpart(self.parent.user(nick))
263 self.parent.user(nick).quit()
264 del self.parent.users[nick.lower()]
265 def _gotnick(self, pieces):
266 oldnick = pieces[0].split('!')[0][1:]
267 newnick = pieces[2][1:]
268 if oldnick == self.nick:
269 self.nick = newnick
270 else:
271 if newnick.lower() != oldnick.lower():
272 self.parent.users[newnick.lower()] = self.parent.users[oldnick.lower()]
273 del self.parent.users[oldnick.lower()]
274 self.parent.users[newnick.lower()].nickchange(newnick)
275 def _gotmode(self, pieces):
276 source = pieces[0].split('!')[0][1:]
277 chan = pieces[2]
278 if not chan.startswith("#"): return
279 chan = self.parent.channel(pieces[2])
280 mode = pieces[3]
281 args = pieces[4:]
282
283 adding = True
284 for c in mode:
285 if c == '+':
286 adding = True
287 elif c == '-':
288 adding = False
289 elif c == 'o':
290 if adding:
291 chan.userop(self.parent.user(args.pop(0)))
292 else:
293 chan.userdeop(self.parent.user(args.pop(0)))
294 elif c == 'v':
295 if adding:
296 chan.uservoice(self.parent.user(args.pop(0)))
297 else:
298 chan.userdevoice(self.parent.user(args.pop(0)))
299 else:
300 pass # don't care about other modes
301
302 def __debug_cbexception(self, source, *args, **kwargs):
303 if self.parent.cfg.getboolean('debug', 'cbexc'):
304 self.conn.send("PRIVMSG %s :%09.3f \ 34\1f!!! CBEXC\1f\ 3 %s" % (self.parent.cfg.get('debug', 'owner'), time.time() % 100000, source))
305 __import__('traceback').print_exc()
306 self.log('!', "CBEXC %s %r %r" % (source, args, kwargs))
307 # print "%09.3f %s [!] CBEXC %s %r %r" % (time.time() % 100000, self.nick, source, args, kwargs)
308
309
310 def parsemsg(self, user, target, msg):
311 if user.glevel <= -2: return # short circuit if user is IGNORED
312 chan = None
313 chanparam = None # was the channel specified as part of the command?
314 if len(msg) == 0:
315 return
316
317 if target == self.nick:
318 if msg.startswith("\001"): #ctcp
319 msg = msg.strip("\001")
320 if msg == "VERSION":
321 self.msg(user, "\001VERSION Erebus v%d.%d - http://jfr.im/git/erebus.git" % (self.parent.APIVERSION, self.parent.RELEASE))
322 return
323
324 triggerused = msg.startswith(self.parent.trigger)
325 if triggerused: msg = msg[len(self.parent.trigger):]
326 pieces = msg.split()
327
328 if len(pieces) == 0:
329 return
330
331 if target != self.nick: # message was sent to a channel
332 try:
333 if pieces[0][:-1].lower() == self.nick.lower() and (pieces[0][-1] == ":" or pieces[0][-1] == ","):
334 pieces.pop(0) # command actually starts with next word
335 if len(pieces) == 0: # is there still anything left?
336 return
337 msg = ' '.join(pieces)
338 triggerused = True
339 except IndexError:
340 return # "message" is empty
341
342 if len(pieces) > 1:
343 chanword = pieces[1]
344 if chanword.startswith('#'):
345 chanparam = self.parent.channel(chanword)
346
347 if target != self.nick: # message was sent to a channel
348 chan = self.parent.channel(target)
349 if not triggerused:
350 if self.parent.haschanhook(target.lower()):
351 for callback in self.parent.getchanhook(target.lower()):
352 try:
353 cbret = callback(self, user, chan, *pieces)
354 if isinstance(cbret, stringbase):
355 self.reply(target, user, cbret)
356 except:
357 self.msg(user, "Command failed. Code: CBEXC%09.3f" % (time.time() % 100000))
358 self.__debug_cbexception("chanhook", user=user, target=target, msg=msg)
359 return # not to bot, don't process!
360
361 cmd = pieces[0].lower()
362 rancmd = False
363 if self.parent.hashook(cmd):
364 for callback in self.parent.gethook(cmd):
365 if chanparam is not None and (callback.needchan or callback.wantchan):
366 chan = chanparam
367 pieces.pop(1)
368 if chan is None and callback.needchan:
369 rancmd = True
370 self.msg(user, "You need to specify a channel for that command.")
371 elif user.glevel >= callback.reqglevel and (not callback.needchan or chan.levelof(user.auth) >= callback.reqclevel):
372 rancmd = True
373 try:
374 cbret = callback(self, user, chan, target, *pieces[1:])
375 if isinstance(cbret, stringbase):
376 self.reply(target, user, cbret)
377 except Exception:
378 self.msg(user, "Command failed. Code: CBEXC%09.3f" % (time.time() % 100000))
379 self.__debug_cbexception("hook", user=user, target=target, msg=msg)
380 except SystemExit as e:
381 self.parent.mustquit = e
382 try:
383 curs = self.parent.query("UPDATE bots SET connected = 0")
384 curs.close()
385 except: pass
386 raise e
387 else:
388 rancmd = True
389 self.msg(user, "I don't know that command.")
390 if not rancmd:
391 self.msg(user, "You don't have enough access to run that command.")
392
393 def __debug_nomsg(self, target, msg):
394 if self.parent.cfg.getboolean('debug', 'nomsg'):
395 self.conn.send("PRIVMSG %s :%09.3f \ 34\1f!!! NOMSG\1f\ 3 %r, %r" % (self.parent.cfg.get('debug', 'owner'), time.time() % 100000, target, msg))
396 self.log('!', "!!! NOMSG")
397 # print "%09.3f %s [!] %s" % (time.time() % 100000, self.nick, "!!! NOMSG")
398 __import__('traceback').print_stack()
399
400
401 def reply(self, chan, user, msg):
402 if chan is not None and (isinstance(chan, self.parent.Channel) or (isinstance(chan, stringbase) and chan[0] == "#")):
403 self.msg(chan, "%s: %s" % (user, msg))
404 else:
405 self.msg(user, msg)
406
407 """
408 Does the work for msg/slowmsg/fastmsg. Uses the append_callback to append to the correct queue.
409
410 In the case of fastmsg, self.conn.exceeded may be True, however, in this case append_callback=self.conn.send, so it will still be sent immediately.
411 """
412 def _msg(self, target, msg, truncate, append_callback, msgtype):
413 if self.parent.cfg.getboolean('erebus', 'nofakelag'): append_callback = self.conn.send
414
415 cmd = self._formatmsg(target, msg, msgtype)
416 # The max length is much shorter than recvq (510) because of the length the server adds on about the source (us).
417 # If you know your hostmask, you can of course figure the exact length, but it's very difficult to reliably know your hostmask.
418 maxlen = (
419 self.conn.recvq
420 - 63 # max hostname len
421 - 11 # max ident len
422 - 3 # the symbols in :nick!user@host
423 - len(self.nick)
424 )
425 if len(cmd) > maxlen:
426 if not truncate:
427 return False
428 else:
429 cmd = cmd[:maxlen]
430
431 if self.conn.exceeded or self.conn.bytessent+len(cmd) >= self.conn.recvq:
432 append_callback(cmd)
433 else:
434 self.conn.send(cmd)
435
436 self.conn.exceeded = True
437 return True
438
439 def msg(self, target, msg, truncate=False, *, msgtype=None):
440 """msgtype must be a valid IRC command, i.e. NOTICE or PRIVMSG; or leave as None to use default"""
441 return self._msg(target, msg, truncate, self.msgqueue.append, msgtype)
442
443 def slowmsg(self, target, msg, truncate=False, *, msgtype=None):
444 return self._msg(target, msg, truncate, self.slowmsgqueue.append, msgtype)
445
446 def fastmsg(self, target, msg, truncate=False, *, msgtype=None):
447 return self._msg(target, msg, truncate, self.conn.send, msgtype)
448
449 def _formatmsg(self, target, msg, msgtype):
450 if target is None or msg is None:
451 return self.__debug_nomsg(target, msg)
452
453 target = str(target)
454
455 if msgtype is not None: command = "%s %s :%s" % (msgtype, target, msg)
456 elif target.startswith('#'): command = "PRIVMSG %s :%s" % (target, msg)
457 else: command = "NOTICE %s :%s" % (target, msg)
458
459 return command
460
461 def _popmsg(self):
462 self._makemsgtimer()
463 self.conn.bytessent -= self.conn.recvq/3
464 if self.conn.bytessent < 0: self.conn.bytessent = 0
465 self.conn.exceeded = True
466
467 cmd = None
468 try:
469 cmd = self.msgqueue.popleft()
470 except IndexError:
471 try:
472 cmd = self.slowmsgqueue.popleft()
473 except IndexError:
474 pass
475
476 if cmd is not None:
477 if self.conn.bytessent+len(cmd) > self.conn.recvq: # If it's too long
478 if len(cmd) > self.conn.recvq: # Is the command itself somehow over max length???
479 self._msgtimer.start()
480 raise ValueError('Somehow a command that was too long made it into the message queue. Uhoh!', cmd)
481 # Discard the message.
482 self.msgqueue.appendleft(cmd) # Phew, we've just sent too much recently. Put it (back) on the (primary) queue.
483 else:
484 self.conn.send(cmd)
485
486 self._msgtimer.start()
487
488 def _makemsgtimer(self):
489 self._msgtimer = MyTimer(3, self._popmsg)
490
491 def join(self, chan):
492 self.conn.send("JOIN %s" % (chan))
493
494 def part(self, chan):
495 self.conn.send("PART %s" % (chan))
496
497 def quit(self, reason="Shutdown"):
498 self.conn.send("QUIT :%s" % (reason))
499
500 def __str__(self): return self.nick
501 def __repr__(self): return "<Bot %r>" % (self.nick)
502
503 class BotConnection(object):
504 def __init__(self, parent, bind, server, port):
505 self.parent = parent
506 self.buffer = bytearray()
507 self.socket = None
508
509 self.bind = bind
510 self.server = server
511 self.port = int(port)
512
513 self.state = 0 # 0=disconnected, 1=registering, 2=connected
514
515 self.bytessent = 0
516 self.recvq = 510
517 self.exceeded = False
518 self._nowrite = False
519
520 def connect(self):
521 if self.parent.parent.cfg.getboolean('erebus', 'tls'):
522 import ssl
523 undersocket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
524 context = ssl.create_default_context()
525 self.socket = context.wrap_socket(undersocket, server_hostname=self.server)
526 else:
527 self.socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
528 self.socket.setsockopt(socket.SOL_TCP, socket.TCP_NODELAY, 1) # Does Python make SOL_TCP portable? Who knows, it's not documented, and it appears to come from the _socket C lib.
529 self.socket.setsockopt(socket.SOL_SOCKET, socket.SO_LINGER, struct.pack('ii', 0, 0))
530 self.socket.setsockopt(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1)
531 self.socket.bind((self.bind, 0))
532 self.socket.connect((self.server, self.port))
533 return True
534 def register(self):
535 if self.state == 0:
536 self.send("NICK %s" % (self.parent.nick))
537 self.send("USER %s 0 * :%s" % (self.parent.user, self.parent.realname))
538 self.state = 1
539 return True
540
541 def registered(self, done=False):
542 if done: self.state = 2
543 return self.state == 2
544
545 def send(self, line):
546 if not self._nowrite:
547 if self.parent.parent.cfg.getboolean('debug', 'io'):
548 self.parent.log('O', line)
549 self.bytessent += len(line)
550 try:
551 self._write(line)
552 except socket.error as e:
553 self._nowrite = True
554 self.parent._goterror(repr(e))
555 else:
556 if self.parent.parent.cfg.getboolean('debug', 'io'):
557 self.parent.log('X', line)
558
559 def _write(self, line):
560 self.socket.sendall(line.encode('utf-8', 'backslashreplace')+b"\r\n")
561
562 def _getsockerr(self):
563 try: # SO_ERROR might not exist on all platforms
564 return self.socket.getsockopt(socket.SOL_SOCKET, socket.SO_ERROR)
565 except:
566 return None
567
568 def read(self):
569 recvd = self.socket.recv(8192)
570 if recvd == b"":
571 raise EOFError("socket.recv returned empty", self.parent.nick, self._getsockerr())
572 self.buffer += recvd
573 lines = []
574
575 while b"\r\n" in self.buffer:
576 pieces = self.buffer.split(b"\r\n", 1)
577 lines.append(pieces[0].decode('utf-8', 'backslashreplace'))
578 self.buffer = pieces[1]
579
580 return lines
581
582 def __str__(self): return self.parent.nick
583 def __repr__(self): return "<BotConnection %r (%r)>" % (self.socket.fileno(), self.parent.nick)