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
):
36 self
.realname
= realname
38 self
.authname
= authname
39 self
.authpass
= authpass
41 self
.connecttime
= 0 # time at which we received numeric 001
42 self
.server
= server
# the address we try to (re-)connect to
44 self
.servername
= server
# the name of the server we got connected to
46 curs
= self
.parent
.query("SELECT chname FROM chans WHERE bot = %s AND active = 1", (self
.permnick
,))
48 chansres
= curs
.fetchall()
50 self
.chans
= [self
.parent
.newchannel(self
, row
['chname']) for row
in chansres
]
54 self
.conn
= BotConnection(self
, bind
, server
, port
)
56 self
.lastreceived
= time
.time() #time we last received a line from the server
59 self
.msgqueue
= deque()
60 self
.slowmsgqueue
= deque()
62 self
._msgtimer
.start()
63 self
.joined_chans
= False
67 curs
= self
.parent
.query("UPDATE bots SET connected = 0 WHERE nick = %s", (self
.permnick
,))
72 if time
.time() > int(self
.parent
.cfg
.get('watchdog', 'maxtime', default
=300))+self
.lastreceived
:
73 self
.parse("ERROR :Fake-error from watchdog timer.")
74 if self
.conn
.registered():
75 self
.conn
.send("PING :%s" % (time
.time()))
77 watchdogtimer
= MyTimer(int(self
.parent
.cfg
.get('watchdog', 'interval', default
=30)), self
.watchdog
)
80 def log(self
, *args
, **kwargs
):
81 self
.parent
.log(self
.nick
, *args
, **kwargs
)
84 self
.log('!', "Connecting")
85 if self
.conn
.connect():
86 self
.log('!', "Connected")
87 self
.parent
.newfd(self
, self
.conn
.socket
.fileno())
91 recvd
= self
.conn
.read()
92 self
.lastreceived
= time
.time()
95 return [":%s ERROR :%s%r" % (self
.nick
, e
.__class
__.__name
__, e
.args
)]
97 def _checknick(self
): # check if we're using the right nick, try changing
98 if self
.nick
!= self
.permnick
and self
.conn
.registered():
99 self
.conn
.send("NICK %s" % (self
.permnick
))
101 def parse(self
, line
):
102 if self
.parent
.cfg
.getboolean('debug', 'io'):
104 pieces
= line
.split()
106 if pieces
[0][0] == ":":
113 'NOTICE': self
._gotconnected
,
116 '376': self
._gotRegistered
,
117 '422': self
._gotRegistered
,
118 'PRIVMSG': self
._gotprivmsg
,
119 '353': self
._got
353, #NAMES
120 '354': self
._got
354, #WHO
121 '396': self
._gotHiddenHost
, # hidden host has been set
122 '433': self
._got
433, #nick in use
123 'JOIN': self
._gotjoin
,
124 'PART': self
._gotpart
,
125 'KICK': self
._gotkick
,
126 'QUIT': self
._gotquit
,
127 'NICK': self
._gotnick
,
128 'MODE': self
._gotmode
,
129 'PING': self
._gotping
,
130 'ERROR': self
._goterror
,
133 if self
.parent
.hasnumhook(numeric
):
134 hooks
= self
.parent
.getnumhook(numeric
)
135 for callback
in hooks
:
139 self
._cbexception
("numhook", line
)
141 if numeric
in dispatch
:
142 dispatch
[numeric
](pieces
)
144 def _gotconnected(self
, pieces
):
145 if not self
.conn
.registered():
147 def _gotping(self
, pieces
):
148 self
.conn
.send("PONG %s" % (pieces
[1]))
150 def _goterror(self
, pieces
):
151 # TODO: better handling, just reconnect that single bot
152 error
= ' '.join(pieces
)
154 raise Exception(error
)
155 except Exception as e
:
156 self
.parent
.mustquit
= e
158 self
.quit("Error detected: %s" % (error
))
161 curs
= self
.parent
.query("UPDATE bots SET connected = 0")
164 self
.log('!', 'Bot exiting due to: %s' % (error
))
165 def _got001(self
, pieces
):
166 # We wait until the end of MOTD instead to consider ourselves registered, but consider uptime as of 001
167 self
.connecttime
= time
.time()
168 def _got004(self
, pieces
):
169 self
.servername
= pieces
[3]
170 def _gotRegistered(self
, pieces
):
171 self
.conn
.registered(True)
173 curs
= self
.parent
.query("UPDATE bots SET connected = 1 WHERE nick = %s", (self
.permnick
,))
174 if curs
: curs
.close()
176 self
.conn
.send("MODE %s +x" % (pieces
[2]))
177 if self
.authname
is not None and self
.authpass
is not None:
178 self
.conn
.send(self
.parent
.cfg
.get('erebus', 'auth_command', "AUTH %s %s") % (self
.authname
, self
.authpass
))
179 if not self
.parent
.cfg
.getboolean('erebus', 'wait_for_hidden_host'):
182 self
.joined_chans
= True
183 def _gotHiddenHost(self
, pieces
):
184 if not self
.joined_chans
and self
.parent
.cfg
.getboolean('erebus', 'wait_for_hidden_host'):
187 self
.joined_chans
= True
188 def _gotprivmsg(self
, pieces
):
189 nick
= pieces
[0].split('!')[0][1:]
190 user
= self
.parent
.user(nick
)
192 msg
= ' '.join(pieces
[3:])[1:]
193 self
.parsemsg(user
, target
, msg
)
194 def _got353(self
, pieces
):
195 prefixes
= {'@': 'op', '+': 'voice'}
196 chan
= self
.parent
.channel(pieces
[4])
198 names
[0] = names
[0][1:] #remove colon
201 user
= self
.parent
.user(n
[1:])
202 chan
.userjoin(user
, prefixes
[n
[0]])
204 user
= self
.parent
.user(n
)
207 def _got354(self
, pieces
):
210 nick
, auth
= pieces
[4:6]
213 chan
, nick
, auth
= pieces
[4:7]
214 chan
= self
.parent
.channel(chan
)
215 user
= self
.parent
.user(nick
)
222 if qt
== 2: # triggered by !auth
225 self
.msg(nick
, "You are now known as #%s (access level: %s)" % (auth
, user
.glevel
))
227 self
.msg(nick
, "You are now known as #%s (not staff)" % (auth
))
229 self
.msg(nick
, "I tried, but you're not authed!")
230 def _got433(self
, pieces
):
231 if not self
.conn
.registered(): #we're trying to connect
232 newnick
= "%s%d" % (self
.nick
, random
.randint(111, 999))
233 self
.conn
.send("NICK %s" % (newnick
))
235 def _gotjoin(self
, pieces
):
236 nick
= pieces
[0].split('!')[0][1:]
237 chan
= self
.parent
.channel(pieces
[2])
239 if nick
== self
.nick
:
240 self
.conn
.send("WHO %s c%%cant,3" % (chan
))
242 user
= self
.parent
.user(nick
, send_who
=True)
245 def _clientLeft(self
, nick
, chan
):
246 if nick
== self
.nick
:
248 if u
.nick
!= self
.nick
:
249 self
._clientLeft
(u
.nick
, chan
)
251 user
= self
.parent
.user(nick
)
252 gone
= user
.part(chan
)
256 del self
.parent
.users
[nick
.lower()]
257 def _gotpart(self
, pieces
):
258 nick
= pieces
[0].split('!')[0][1:]
259 chan
= self
.parent
.channel(pieces
[2])
260 self
._clientLeft
(nick
, chan
)
261 def _gotkick(self
, pieces
):
263 chan
= self
.parent
.channel(pieces
[2])
264 self
._clientLeft
(nick
, chan
)
265 def _gotquit(self
, pieces
):
266 nick
= pieces
[0].split('!')[0][1:]
267 if nick
!= self
.nick
:
268 for chan
in self
.parent
.user(nick
).chans
:
269 chan
.userpart(self
.parent
.user(nick
))
270 self
.parent
.user(nick
).quit()
271 del self
.parent
.users
[nick
.lower()]
272 def _gotnick(self
, pieces
):
273 oldnick
= pieces
[0].split('!')[0][1:]
274 newnick
= pieces
[2][1:]
275 if oldnick
== self
.nick
:
278 if newnick
.lower() != oldnick
.lower():
279 self
.parent
.users
[newnick
.lower()] = self
.parent
.users
[oldnick
.lower()]
280 del self
.parent
.users
[oldnick
.lower()]
281 self
.parent
.users
[newnick
.lower()].nickchange(newnick
)
282 def _gotmode(self
, pieces
):
283 source
= pieces
[0].split('!')[0][1:]
285 if not chan
.startswith("#"): return
286 chan
= self
.parent
.channel(pieces
[2])
298 chan
.userop(self
.parent
.user(args
.pop(0)))
300 chan
.userdeop(self
.parent
.user(args
.pop(0)))
303 chan
.uservoice(self
.parent
.user(args
.pop(0)))
305 chan
.userdevoice(self
.parent
.user(args
.pop(0)))
307 pass # don't care about other modes
309 def _cbexception(self
, source
, *args
, chained
=False, **kwargs
):
310 if not chained
: # skip hooks if we were caused by a hook
311 exc
= sys
.exception()
312 if self
.parent
.hasexceptionhook(exc
):
313 for callback
in self
.parent
.getexceptionhook(exc
):
315 callback(self
, exc
, source
, *args
, **kwargs
)
317 self
._cbexception
('exceptionhook', chained
=True, module
=callback
.__module
__, function
=callback
.__name
__, underlying
=(source
, args
, kwargs
))
318 if self
.parent
.cfg
.getboolean('debug', 'cbexc'):
319 self
.conn
.send("PRIVMSG %s :%09.3f \ 34\1f!!! CBEXC\1f\ 3 %s" % (self
.parent
.cfg
.get('debug', 'owner'), time
.time() % 100000, source
))
320 traceback
.print_exc(chain
=not chained
)
321 self
.log('!', "CBEXC %s %r %r" % (source
, args
, kwargs
))
324 def parsemsg(self
, user
, target
, msg
):
325 if user
.glevel
<= -2: return # short circuit if user is IGNORED
327 chanparam
= None # was the channel specified as part of the command?
331 if target
== self
.nick
:
332 if msg
.startswith("\001"): #ctcp
333 msg
= msg
.strip("\001")
335 self
.msg(user
, "\001VERSION Erebus v%d.%d - http://jfr.im/git/erebus.git" % (self
.parent
.APIVERSION
, self
.parent
.RELEASE
))
338 triggerused
= msg
.startswith(self
.parent
.trigger
)
339 if triggerused
: msg
= msg
[len(self
.parent
.trigger
):]
345 if target
!= self
.nick
: # message was sent to a channel
347 if pieces
[0][:-1].lower() == self
.nick
.lower() and (pieces
[0][-1] == ":" or pieces
[0][-1] == ","):
348 pieces
.pop(0) # command actually starts with next word
349 if len(pieces
) == 0: # is there still anything left?
351 msg
= ' '.join(pieces
)
354 return # "message" is empty
358 if chanword
.startswith('#'):
359 chanparam
= self
.parent
.channel(chanword
)
361 if target
!= self
.nick
: # message was sent to a channel
362 chan
= self
.parent
.channel(target
)
364 if self
.parent
.haschanhook(target
.lower()):
365 for callback
in self
.parent
.getchanhook(target
.lower()):
367 cbret
= callback(self
, user
, chan
, *pieces
)
368 if isinstance(cbret
, stringbase
):
369 self
.reply(target
, user
, cbret
)
371 self
.msg(user
, "Command failed. Code: CBEXC%09.3f" % (time
.time() % 100000))
372 self
._cbexception
("chanhook", user
=user
, target
=target
, msg
=msg
)
373 return # not to bot, don't process!
375 cmd
= pieces
[0].lower()
377 if self
.parent
.hashook(cmd
):
378 for callback
in self
.parent
.gethook(cmd
):
379 if chanparam
is not None and (callback
.needchan
or callback
.wantchan
):
382 if chan
is None and callback
.needchan
:
384 self
.msg(user
, "You need to specify a channel for that command.")
385 elif user
.glevel
>= callback
.reqglevel
and (not callback
.needchan
or chan
.levelof(user
.auth
) >= callback
.reqclevel
):
388 cbret
= callback(self
, user
, chan
, target
, *pieces
[1:])
389 if isinstance(cbret
, stringbase
):
390 self
.reply(target
, user
, cbret
)
392 self
.msg(user
, "Command failed. Code: CBEXC%09.3f" % (time
.time() % 100000))
393 self
._cbexception
("hook", user
=user
, target
=target
, msg
=msg
)
394 except SystemExit as e
:
395 self
.parent
.mustquit
= e
397 curs
= self
.parent
.query("UPDATE bots SET connected = 0")
403 self
.msg(user
, "I don't know that command.")
405 self
.msg(user
, "You don't have enough access to run that command.")
407 def __debug_nomsg(self
, target
, msg
):
408 if self
.parent
.cfg
.getboolean('debug', 'nomsg'):
409 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
))
410 self
.log('!', "!!! NOMSG")
411 # print "%09.3f %s [!] %s" % (time.time() % 100000, self.nick, "!!! NOMSG")
412 traceback
.print_stack()
415 def reply(self
, chan
, user
, msg
):
416 if chan
is not None and (isinstance(chan
, self
.parent
.Channel
) or (isinstance(chan
, stringbase
) and chan
[0] == "#")):
417 self
.msg(chan
, "%s: %s" % (user
, msg
))
422 Does the work for msg/slowmsg/fastmsg. Uses the append_callback to append to the correct queue.
424 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.
426 def _msg(self
, target
, msg
, truncate
, append_callback
, msgtype
):
427 if self
.parent
.cfg
.getboolean('erebus', 'nofakelag'): append_callback
= self
.conn
.send
429 cmd
= self
._formatmsg
(target
, msg
, msgtype
)
430 # The max length is much shorter than conn.maxlen (510) because of the length the server adds on about the source (us).
431 # If you know your hostmask, you can of course figure the exact length, but it's very difficult to reliably know your hostmask.
432 maxlen
= self
.maxmsglen()
433 if len(cmd
) > maxlen
:
439 if self
.conn
.exceeded
or self
.conn
.bytessent
+len(cmd
) >= self
.conn
.recvq
:
444 self
.conn
.exceeded
= True
447 def msg(self
, target
, msg
, truncate
=False, *, msgtype
=None):
448 """msgtype must be a valid IRC command, i.e. NOTICE or PRIVMSG; or leave as None to use default"""
449 return self
._msg
(target
, msg
, truncate
, self
.msgqueue
.append
, msgtype
)
451 def slowmsg(self
, target
, msg
, truncate
=False, *, msgtype
=None):
452 return self
._msg
(target
, msg
, truncate
, self
.slowmsgqueue
.append
, msgtype
)
454 def fastmsg(self
, target
, msg
, truncate
=False, *, msgtype
=None):
455 return self
._msg
(target
, msg
, truncate
, self
.conn
.send
, msgtype
)
457 def _formatmsg(self
, target
, msg
, msgtype
):
458 if target
is None or msg
is None:
459 return self
.__debug
_nomsg
(target
, msg
)
463 if msgtype
is not None: command
= "%s %s :%s" % (msgtype
, target
, msg
)
464 elif target
.startswith('#'): command
= "PRIVMSG %s :%s" % (target
, msg
)
465 else: command
= "NOTICE %s :%s" % (target
, msg
)
471 self
.conn
.bytessent
-= self
.conn
.recvq
/3
472 if self
.conn
.bytessent
< 0: self
.conn
.bytessent
= 0
473 self
.conn
.exceeded
= True
477 cmd
= self
.msgqueue
.popleft()
480 cmd
= self
.slowmsgqueue
.popleft()
485 if self
.conn
.bytessent
+len(cmd
) > self
.conn
.recvq
: # If it's too long
486 if len(cmd
) > self
.conn
.recvq
: # Is the command itself somehow over max length???
487 self
._msgtimer
.start()
488 raise ValueError('Somehow a command that was too long made it into the message queue. Uhoh!', cmd
)
489 # Discard the message.
490 self
.msgqueue
.appendleft(cmd
) # Phew, we've just sent too much recently. Put it (back) on the (primary) queue.
494 self
._msgtimer
.start()
496 def _makemsgtimer(self
):
497 self
._msgtimer
= MyTimer(3, self
._popmsg
)
499 def join(self
, chan
):
500 self
.conn
.send("JOIN %s" % (chan
))
502 def part(self
, chan
):
503 self
.conn
.send("PART %s" % (chan
))
505 def quit(self
, reason
="Shutdown"):
506 self
.conn
.send("QUIT :%s" % (reason
))
511 - 63 # max hostname len
513 - 3 # the symbols in :nick!user@host
517 def __str__(self
): return self
.nick
518 def __repr__(self
): return "<Bot %r>" % (self
.nick
)
520 class BotConnection(object):
521 def __init__(self
, parent
, bind
, server
, port
):
523 self
.buffer = bytearray()
528 self
.port
= int(port
)
530 self
.state
= 0 # 0=disconnected, 1=registering, 2=connected
533 self
.recvq
= 510 # How much we can send per period
534 self
.exceeded
= False
535 self
._nowrite
= False
538 if self
.parent
.parent
.cfg
.getboolean('erebus', 'tls'):
540 undersocket
= socket
.socket(socket
.AF_INET
, socket
.SOCK_STREAM
)
541 context
= ssl
.create_default_context()
542 self
.socket
= context
.wrap_socket(undersocket
, server_hostname
=self
.server
)
544 self
.socket
= socket
.socket(socket
.AF_INET
, socket
.SOCK_STREAM
)
545 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.
546 self
.socket
.setsockopt(socket
.SOL_SOCKET
, socket
.SO_LINGER
, struct
.pack('ii', 0, 0))
547 self
.socket
.setsockopt(socket
.SOL_SOCKET
, socket
.SO_KEEPALIVE
, 1)
548 self
.socket
.bind((self
.bind
, 0))
549 self
.socket
.connect((self
.server
, self
.port
))
553 self
.send("NICK %s" % (self
.parent
.nick
))
554 self
.send("USER %s 0 * :%s" % (self
.parent
.user
, self
.parent
.realname
))
558 def registered(self
, done
=False):
559 if done
: self
.state
= 2
560 return self
.state
== 2
562 def send(self
, line
):
563 if not self
._nowrite
:
564 if self
.parent
.parent
.cfg
.getboolean('debug', 'io'):
565 self
.parent
.log('O', line
)
566 self
.bytessent
+= len(line
)
569 except socket
.error
as e
:
571 self
.parent
._goterror
(repr(e
))
573 if self
.parent
.parent
.cfg
.getboolean('debug', 'io'):
574 self
.parent
.log('X', line
)
576 def _write(self
, line
):
577 self
.socket
.sendall(line
.encode('utf-8', 'backslashreplace')+b
"\r\n")
579 def _getsockerr(self
):
580 try: # SO_ERROR might not exist on all platforms
581 return self
.socket
.getsockopt(socket
.SOL_SOCKET
, socket
.SO_ERROR
)
586 recvd
= self
.socket
.recv(8192)
588 raise EOFError("socket.recv returned empty", self
.parent
.nick
, self
._getsockerr
())
592 while b
"\r\n" in self
.buffer:
593 pieces
= self
.buffer.split(b
"\r\n", 1)
594 lines
.append(pieces
[0].decode('utf-8', 'backslashreplace'))
595 self
.buffer = pieces
[1]
599 def __str__(self
): return self
.parent
.nick
600 def __repr__(self
): return "<BotConnection %r (%r)>" % (self
.socket
.fileno(), self
.parent
.nick
)