2 # vim: fileencoding=utf-8
4 # Erebus IRC bot - Author: John Runyon
5 # "Bot" and "BotConnection" classes (handling a specific "arm")
7 import os
, random
, socket
, struct
, sys
, threading
, time
, traceback
8 from collections
import deque
10 if sys
.version_info
.major
< 3:
11 timerbase
= threading
._Timer
12 stringbase
= basestring
14 timerbase
= threading
.Timer
17 class MyTimer(timerbase
):
18 def __init__(self
, *args
, **kwargs
):
19 timerbase
.__init
__(self
, *args
, **kwargs
)
22 if sys
.version_info
.major
< 3:
23 stringbase
= basestring
27 #bots = {'erebus': bot.Bot(nick='Erebus', user='erebus', bind='', server='irc.quakenet.org', port=6667, realname='Erebus')}
29 def __init__(self
, parent
, nick
, user
, bind
, authname
, authpass
, server
, port
, realname
):
34 self
.realname
= realname
36 self
.authname
= authname
37 self
.authpass
= authpass
39 self
.connecttime
= 0 # time at which we received numeric 001
40 self
.server
= server
# the address we try to (re-)connect to
42 self
.servername
= server
# the name of the server we got connected to
44 curs
= self
.parent
.query("SELECT chname FROM chans WHERE bot = %s AND active = 1", (self
.permnick
,))
46 chansres
= curs
.fetchall()
48 self
.chans
= [self
.parent
.newchannel(self
, row
['chname']) for row
in chansres
]
52 self
.conn
= BotConnection(self
, bind
, server
, port
)
54 self
.lastreceived
= time
.time() #time we last received a line from the server
57 self
.msgqueue
= deque()
58 self
.slowmsgqueue
= deque()
60 self
._msgtimer
.start()
61 self
.joined_chans
= False
65 curs
= self
.parent
.query("UPDATE bots SET connected = 0 WHERE nick = %s", (self
.permnick
,))
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()))
75 watchdogtimer
= MyTimer(int(self
.parent
.cfg
.get('watchdog', 'interval', default
=30)), self
.watchdog
)
78 def log(self
, *args
, **kwargs
):
79 self
.parent
.log(self
.nick
, *args
, **kwargs
)
82 self
.log('!', "Connecting")
83 if self
.conn
.connect():
84 self
.log('!', "Connected")
85 self
.parent
.newfd(self
, self
.conn
.socket
.fileno())
89 recvd
= self
.conn
.read()
90 self
.lastreceived
= time
.time()
93 return [":%s ERROR :%s%r" % (self
.nick
, e
.__class
__.__name
__, e
.args
)]
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
))
99 def parse(self
, line
):
100 if self
.parent
.cfg
.getboolean('debug', 'io'):
102 pieces
= line
.split()
104 if pieces
[0][0] == ":":
111 'NOTICE': self
._gotconnected
,
114 '376': self
._gotRegistered
,
115 '422': self
._gotRegistered
,
116 'PRIVMSG': self
._gotprivmsg
,
117 '353': self
._got
353, #NAMES
118 '354': self
._got
354, #WHO
119 '396': self
._gotHiddenHost
, # hidden host has been set
120 '433': self
._got
433, #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
,
131 if self
.parent
.hasnumhook(numeric
):
132 hooks
= self
.parent
.getnumhook(numeric
)
133 for callback
in hooks
:
137 self
._cbexception
("numhook", line
)
139 if numeric
in dispatch
:
140 dispatch
[numeric
](pieces
)
142 def _gotconnected(self
, pieces
):
143 if not self
.conn
.registered():
145 def _gotping(self
, pieces
):
146 self
.conn
.send("PONG %s" % (pieces
[1]))
148 def _goterror(self
, pieces
):
149 # TODO: better handling, just reconnect that single bot
150 error
= ' '.join(pieces
)
152 raise Exception(error
)
153 except Exception as e
:
154 self
.parent
.mustquit
= e
156 self
.quit("Error detected: %s" % (error
))
159 curs
= self
.parent
.query("UPDATE bots SET connected = 0")
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)
171 curs
= self
.parent
.query("UPDATE bots SET connected = 1 WHERE nick = %s", (self
.permnick
,))
172 if curs
: curs
.close()
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'):
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'):
185 self
.joined_chans
= True
186 def _gotprivmsg(self
, pieces
):
187 nick
= pieces
[0].split('!')[0][1:]
188 user
= self
.parent
.user(nick
)
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])
196 names
[0] = names
[0][1:] #remove colon
199 user
= self
.parent
.user(n
[1:])
200 chan
.userjoin(user
, prefixes
[n
[0]])
202 user
= self
.parent
.user(n
)
205 def _got354(self
, pieces
):
208 nick
, auth
= pieces
[4:6]
211 chan
, nick
, auth
= pieces
[4:7]
212 chan
= self
.parent
.channel(chan
)
213 user
= self
.parent
.user(nick
)
220 if qt
== 2: # triggered by !auth
223 self
.msg(nick
, "You are now known as #%s (access level: %s)" % (auth
, user
.glevel
))
225 self
.msg(nick
, "You are now known as #%s (not staff)" % (auth
))
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
))
233 def _gotjoin(self
, pieces
):
234 nick
= pieces
[0].split('!')[0][1:]
235 chan
= self
.parent
.channel(pieces
[2])
237 if nick
== self
.nick
:
238 self
.conn
.send("WHO %s c%%cant,3" % (chan
))
240 user
= self
.parent
.user(nick
, justjoined
=True)
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
))
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
):
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
:
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:]
278 if not chan
.startswith("#"): return
279 chan
= self
.parent
.channel(pieces
[2])
291 chan
.userop(self
.parent
.user(args
.pop(0)))
293 chan
.userdeop(self
.parent
.user(args
.pop(0)))
296 chan
.uservoice(self
.parent
.user(args
.pop(0)))
298 chan
.userdevoice(self
.parent
.user(args
.pop(0)))
300 pass # don't care about other modes
302 def _cbexception(self
, source
, *args
, chained
=False, **kwargs
):
303 if not chained
: # skip hooks if we were caused by a hook
304 exc
= sys
.exception()
305 if self
.parent
.hasexceptionhook(exc
):
306 for callback
in self
.parent
.getexceptionhook(exc
):
308 callback(self
, exc
, source
, *args
, **kwargs
)
310 self
._cbexception
('exceptionhook', chained
=True, module
=callback
.__module
__, function
=callback
.__name
__, underlying
=(source
, args
, kwargs
))
311 if self
.parent
.cfg
.getboolean('debug', 'cbexc'):
312 self
.conn
.send("PRIVMSG %s :%09.3f \ 34\1f!!! CBEXC\1f\ 3 %s" % (self
.parent
.cfg
.get('debug', 'owner'), time
.time() % 100000, source
))
313 traceback
.print_exc(chain
=not chained
)
314 self
.log('!', "CBEXC %s %r %r" % (source
, args
, kwargs
))
317 def parsemsg(self
, user
, target
, msg
):
318 if user
.glevel
<= -2: return # short circuit if user is IGNORED
320 chanparam
= None # was the channel specified as part of the command?
324 if target
== self
.nick
:
325 if msg
.startswith("\001"): #ctcp
326 msg
= msg
.strip("\001")
328 self
.msg(user
, "\001VERSION Erebus v%d.%d - http://jfr.im/git/erebus.git" % (self
.parent
.APIVERSION
, self
.parent
.RELEASE
))
331 triggerused
= msg
.startswith(self
.parent
.trigger
)
332 if triggerused
: msg
= msg
[len(self
.parent
.trigger
):]
338 if target
!= self
.nick
: # message was sent to a channel
340 if pieces
[0][:-1].lower() == self
.nick
.lower() and (pieces
[0][-1] == ":" or pieces
[0][-1] == ","):
341 pieces
.pop(0) # command actually starts with next word
342 if len(pieces
) == 0: # is there still anything left?
344 msg
= ' '.join(pieces
)
347 return # "message" is empty
351 if chanword
.startswith('#'):
352 chanparam
= self
.parent
.channel(chanword
)
354 if target
!= self
.nick
: # message was sent to a channel
355 chan
= self
.parent
.channel(target
)
357 if self
.parent
.haschanhook(target
.lower()):
358 for callback
in self
.parent
.getchanhook(target
.lower()):
360 cbret
= callback(self
, user
, chan
, *pieces
)
361 if isinstance(cbret
, stringbase
):
362 self
.reply(target
, user
, cbret
)
364 self
.msg(user
, "Command failed. Code: CBEXC%09.3f" % (time
.time() % 100000))
365 self
._cbexception
("chanhook", user
=user
, target
=target
, msg
=msg
)
366 return # not to bot, don't process!
368 cmd
= pieces
[0].lower()
370 if self
.parent
.hashook(cmd
):
371 for callback
in self
.parent
.gethook(cmd
):
372 if chanparam
is not None and (callback
.needchan
or callback
.wantchan
):
375 if chan
is None and callback
.needchan
:
377 self
.msg(user
, "You need to specify a channel for that command.")
378 elif user
.glevel
>= callback
.reqglevel
and (not callback
.needchan
or chan
.levelof(user
.auth
) >= callback
.reqclevel
):
381 cbret
= callback(self
, user
, chan
, target
, *pieces
[1:])
382 if isinstance(cbret
, stringbase
):
383 self
.reply(target
, user
, cbret
)
385 self
.msg(user
, "Command failed. Code: CBEXC%09.3f" % (time
.time() % 100000))
386 self
._cbexception
("hook", user
=user
, target
=target
, msg
=msg
)
387 except SystemExit as e
:
388 self
.parent
.mustquit
= e
390 curs
= self
.parent
.query("UPDATE bots SET connected = 0")
396 self
.msg(user
, "I don't know that command.")
398 self
.msg(user
, "You don't have enough access to run that command.")
400 def __debug_nomsg(self
, target
, msg
):
401 if self
.parent
.cfg
.getboolean('debug', 'nomsg'):
402 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
))
403 self
.log('!', "!!! NOMSG")
404 # print "%09.3f %s [!] %s" % (time.time() % 100000, self.nick, "!!! NOMSG")
405 traceback
.print_stack()
408 def reply(self
, chan
, user
, msg
):
409 if chan
is not None and (isinstance(chan
, self
.parent
.Channel
) or (isinstance(chan
, stringbase
) and chan
[0] == "#")):
410 self
.msg(chan
, "%s: %s" % (user
, msg
))
415 Does the work for msg/slowmsg/fastmsg. Uses the append_callback to append to the correct queue.
417 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.
419 def _msg(self
, target
, msg
, truncate
, append_callback
, msgtype
):
420 if self
.parent
.cfg
.getboolean('erebus', 'nofakelag'): append_callback
= self
.conn
.send
422 cmd
= self
._formatmsg
(target
, msg
, msgtype
)
423 # The max length is much shorter than recvq (510) because of the length the server adds on about the source (us).
424 # If you know your hostmask, you can of course figure the exact length, but it's very difficult to reliably know your hostmask.
427 - 63 # max hostname len
429 - 3 # the symbols in :nick!user@host
432 if len(cmd
) > maxlen
:
438 if self
.conn
.exceeded
or self
.conn
.bytessent
+len(cmd
) >= self
.conn
.recvq
:
443 self
.conn
.exceeded
= True
446 def msg(self
, target
, msg
, truncate
=False, *, msgtype
=None):
447 """msgtype must be a valid IRC command, i.e. NOTICE or PRIVMSG; or leave as None to use default"""
448 return self
._msg
(target
, msg
, truncate
, self
.msgqueue
.append
, msgtype
)
450 def slowmsg(self
, target
, msg
, truncate
=False, *, msgtype
=None):
451 return self
._msg
(target
, msg
, truncate
, self
.slowmsgqueue
.append
, msgtype
)
453 def fastmsg(self
, target
, msg
, truncate
=False, *, msgtype
=None):
454 return self
._msg
(target
, msg
, truncate
, self
.conn
.send
, msgtype
)
456 def _formatmsg(self
, target
, msg
, msgtype
):
457 if target
is None or msg
is None:
458 return self
.__debug
_nomsg
(target
, msg
)
462 if msgtype
is not None: command
= "%s %s :%s" % (msgtype
, target
, msg
)
463 elif target
.startswith('#'): command
= "PRIVMSG %s :%s" % (target
, msg
)
464 else: command
= "NOTICE %s :%s" % (target
, msg
)
470 self
.conn
.bytessent
-= self
.conn
.recvq
/3
471 if self
.conn
.bytessent
< 0: self
.conn
.bytessent
= 0
472 self
.conn
.exceeded
= True
476 cmd
= self
.msgqueue
.popleft()
479 cmd
= self
.slowmsgqueue
.popleft()
484 if self
.conn
.bytessent
+len(cmd
) > self
.conn
.recvq
: # If it's too long
485 if len(cmd
) > self
.conn
.recvq
: # Is the command itself somehow over max length???
486 self
._msgtimer
.start()
487 raise ValueError('Somehow a command that was too long made it into the message queue. Uhoh!', cmd
)
488 # Discard the message.
489 self
.msgqueue
.appendleft(cmd
) # Phew, we've just sent too much recently. Put it (back) on the (primary) queue.
493 self
._msgtimer
.start()
495 def _makemsgtimer(self
):
496 self
._msgtimer
= MyTimer(3, self
._popmsg
)
498 def join(self
, chan
):
499 self
.conn
.send("JOIN %s" % (chan
))
501 def part(self
, chan
):
502 self
.conn
.send("PART %s" % (chan
))
504 def quit(self
, reason
="Shutdown"):
505 self
.conn
.send("QUIT :%s" % (reason
))
507 def __str__(self
): return self
.nick
508 def __repr__(self
): return "<Bot %r>" % (self
.nick
)
510 class BotConnection(object):
511 def __init__(self
, parent
, bind
, server
, port
):
513 self
.buffer = bytearray()
518 self
.port
= int(port
)
520 self
.state
= 0 # 0=disconnected, 1=registering, 2=connected
524 self
.exceeded
= False
525 self
._nowrite
= False
528 if self
.parent
.parent
.cfg
.getboolean('erebus', 'tls'):
530 undersocket
= socket
.socket(socket
.AF_INET
, socket
.SOCK_STREAM
)
531 context
= ssl
.create_default_context()
532 self
.socket
= context
.wrap_socket(undersocket
, server_hostname
=self
.server
)
534 self
.socket
= socket
.socket(socket
.AF_INET
, socket
.SOCK_STREAM
)
535 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.
536 self
.socket
.setsockopt(socket
.SOL_SOCKET
, socket
.SO_LINGER
, struct
.pack('ii', 0, 0))
537 self
.socket
.setsockopt(socket
.SOL_SOCKET
, socket
.SO_KEEPALIVE
, 1)
538 self
.socket
.bind((self
.bind
, 0))
539 self
.socket
.connect((self
.server
, self
.port
))
543 self
.send("NICK %s" % (self
.parent
.nick
))
544 self
.send("USER %s 0 * :%s" % (self
.parent
.user
, self
.parent
.realname
))
548 def registered(self
, done
=False):
549 if done
: self
.state
= 2
550 return self
.state
== 2
552 def send(self
, line
):
553 if not self
._nowrite
:
554 if self
.parent
.parent
.cfg
.getboolean('debug', 'io'):
555 self
.parent
.log('O', line
)
556 self
.bytessent
+= len(line
)
559 except socket
.error
as e
:
561 self
.parent
._goterror
(repr(e
))
563 if self
.parent
.parent
.cfg
.getboolean('debug', 'io'):
564 self
.parent
.log('X', line
)
566 def _write(self
, line
):
567 self
.socket
.sendall(line
.encode('utf-8', 'backslashreplace')+b
"\r\n")
569 def _getsockerr(self
):
570 try: # SO_ERROR might not exist on all platforms
571 return self
.socket
.getsockopt(socket
.SOL_SOCKET
, socket
.SO_ERROR
)
576 recvd
= self
.socket
.recv(8192)
578 raise EOFError("socket.recv returned empty", self
.parent
.nick
, self
._getsockerr
())
582 while b
"\r\n" in self
.buffer:
583 pieces
= self
.buffer.split(b
"\r\n", 1)
584 lines
.append(pieces
[0].decode('utf-8', 'backslashreplace'))
585 self
.buffer = pieces
[1]
589 def __str__(self
): return self
.parent
.nick
590 def __repr__(self
): return "<BotConnection %r (%r)>" % (self
.socket
.fileno(), self
.parent
.nick
)