2 # vim: fileencoding=utf-8
4 # Erebus IRC bot - Author: John Runyon
5 # "Bot" and "BotConnection" classes (handling a specific "arm")
7 import socket
, sys
, time
, threading
, os
, random
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 curs
= self
.parent
.query("SELECT chname FROM chans WHERE bot = %s AND active = 1", (self
.permnick
,))
41 chansres
= curs
.fetchall()
43 self
.chans
= [self
.parent
.newchannel(self
, row
['chname']) for row
in chansres
]
47 self
.conn
= BotConnection(self
, bind
, server
, port
)
49 self
.lastreceived
= time
.time() #time we last received a line from the server
52 self
.msgqueue
= deque()
53 self
.slowmsgqueue
= deque()
55 self
._msgtimer
.start()
59 curs
= self
.parent
.query("UPDATE bots SET connected = 0 WHERE nick = %s", (self
.permnick
,))
64 if time
.time() > int(self
.parent
.cfg
.get('watchdog', 'maxtime', default
=300))+self
.lastreceived
:
65 self
.parse("ERROR :Fake-error from watchdog timer.")
66 self
.watchdogtimer
= MyTimer(int(self
.parent
.cfg
.get('watchdog', 'interval', default
=30)), self
.watchdog
)
68 def log(self
, *args
, **kwargs
):
69 self
.parent
.log(self
.nick
, *args
, **kwargs
)
72 self
.log('!', "Connecting")
73 if self
.conn
.connect():
74 self
.parent
.newfd(self
, self
.conn
.socket
.fileno())
77 self
.lastreceived
= time
.time()
78 return self
.conn
.read()
80 def _checknick(self
): # check if we're using the right nick, try changing
81 if self
.nick
!= self
.permnick
and self
.conn
.registered():
82 self
.conn
.send("NICK %s" % (self
.permnick
))
84 def parse(self
, line
):
85 if self
.parent
.cfg
.getboolean('debug', 'io'):
90 zero
= { #things to look for without source
91 'NOTICE': self
._gotconnected
,
92 'PING': self
._gotping
,
93 'ERROR': self
._goterror
,
95 one
= { #things to look for after source
96 'NOTICE': self
._gotconnected
,
98 '376': self
._gotRegistered
,
99 '422': self
._gotRegistered
,
100 'PRIVMSG': self
._gotprivmsg
,
101 '353': self
._got
353, #NAMES
102 '354': self
._got
354, #WHO
103 '433': self
._got
433, #nick in use
104 'JOIN': self
._gotjoin
,
105 'PART': self
._gotpart
,
106 'KICK': self
._gotkick
,
107 'QUIT': self
._gotquit
,
108 'NICK': self
._gotnick
,
109 'MODE': self
._gotmode
,
112 if self
.parent
.hasnumhook(pieces
[1]):
113 hooks
= self
.parent
.getnumhook(pieces
[1])
114 for callback
in hooks
:
118 self
.__debug
_cbexception
("numhook", line
)
120 if pieces
[0] in zero
:
121 zero
[pieces
[0]](pieces
)
122 elif pieces
[1] in one
:
123 one
[pieces
[1]](pieces
)
125 def _gotconnected(self
, pieces
):
126 if not self
.conn
.registered():
128 def _gotping(self
, pieces
):
129 self
.conn
.send("PONG %s" % (pieces
[1]))
131 def _goterror(self
, pieces
):
132 # TODO: better handling, just reconnect that single bot
134 self
.quit("Error detected: %s" % ' '.join(pieces
))
137 curs
= self
.parent
.query("UPDATE bots SET connected = 0")
142 def _got001(self
, pieces
):
143 pass # wait until the end of MOTD instead
144 def _gotRegistered(self
, pieces
):
145 self
.conn
.registered(True)
147 curs
= self
.parent
.query("UPDATE bots SET connected = 1 WHERE nick = %s", (self
.permnick
,))
148 if curs
: curs
.close()
150 self
.conn
.send("MODE %s +x" % (pieces
[2]))
151 if self
.authname
is not None and self
.authpass
is not None:
152 self
.conn
.send("AUTH %s %s" % (self
.authname
, self
.authpass
))
155 def _gotprivmsg(self
, pieces
):
156 nick
= pieces
[0].split('!')[0][1:]
157 user
= self
.parent
.user(nick
)
159 msg
= ' '.join(pieces
[3:])[1:]
160 self
.parsemsg(user
, target
, msg
)
161 def _got353(self
, pieces
):
162 prefixes
= {'@': 'op', '+': 'voice'}
163 chan
= self
.parent
.channel(pieces
[4])
165 names
[0] = names
[0][1:] #remove colon
168 user
= self
.parent
.user(n
[1:])
169 chan
.userjoin(user
, prefixes
[n
[0]])
171 user
= self
.parent
.user(n
)
174 def _got354(self
, pieces
):
177 nick
, auth
= pieces
[4:6]
180 chan
, nick
, auth
= pieces
[4:7]
181 chan
= self
.parent
.channel(chan
)
182 user
= self
.parent
.user(nick
)
189 if qt
== 2: # triggered by !auth
192 self
.msg(nick
, "You are now known as #%s (access level: %s)" % (auth
, user
.glevel
))
194 self
.msg(nick
, "You are now known as #%s (not staff)" % (auth
))
196 self
.msg(nick
, "I tried, but you're not authed!")
197 def _got433(self
, pieces
):
198 if not self
.conn
.registered(): #we're trying to connect
199 newnick
= "%s%d" % (self
.nick
, random
.randint(111, 999))
200 self
.conn
.send("NICK %s" % (newnick
))
202 def _gotjoin(self
, pieces
):
203 nick
= pieces
[0].split('!')[0][1:]
204 chan
= self
.parent
.channel(pieces
[2])
206 if nick
== self
.nick
:
207 self
.conn
.send("WHO %s c%%cant,3" % (chan
))
209 user
= self
.parent
.user(nick
, justjoined
=True)
212 def _clientLeft(self
, nick
, chan
):
213 if nick
!= self
.nick
:
214 gone
= self
.parent
.user(nick
).part(chan
)
215 chan
.userpart(self
.parent
.user(nick
))
217 self
.parent
.user(nick
).quit()
218 del self
.parent
.users
[nick
.lower()]
219 def _gotpart(self
, pieces
):
220 nick
= pieces
[0].split('!')[0][1:]
221 chan
= self
.parent
.channel(pieces
[2])
222 self
._clientLeft
(nick
, chan
)
223 def _gotkick(self
, pieces
):
225 chan
= self
.parent
.channel(pieces
[2])
226 self
._clientLeft
(nick
, chan
)
227 def _gotquit(self
, pieces
):
228 nick
= pieces
[0].split('!')[0][1:]
229 if nick
!= self
.nick
:
230 for chan
in self
.parent
.user(nick
).chans
:
231 chan
.userpart(self
.parent
.user(nick
))
232 self
.parent
.user(nick
).quit()
233 del self
.parent
.users
[nick
.lower()]
234 def _gotnick(self
, pieces
):
235 oldnick
= pieces
[0].split('!')[0][1:]
236 newnick
= pieces
[2][1:]
237 if oldnick
== self
.nick
:
240 if newnick
.lower() != oldnick
.lower():
241 self
.parent
.users
[newnick
.lower()] = self
.parent
.users
[oldnick
.lower()]
242 del self
.parent
.users
[oldnick
.lower()]
243 self
.parent
.users
[newnick
.lower()].nickchange(newnick
)
244 def _gotmode(self
, pieces
):
245 source
= pieces
[0].split('!')[0][1:]
247 if not chan
.startswith("#"): return
248 chan
= self
.parent
.channel(pieces
[2])
260 chan
.userop(self
.parent
.user(args
.pop(0)))
262 chan
.userdeop(self
.parent
.user(args
.pop(0)))
265 chan
.uservoice(self
.parent
.user(args
.pop(0)))
267 chan
.userdevoice(self
.parent
.user(args
.pop(0)))
269 pass # don't care about other modes
271 def __debug_cbexception(self
, source
, *args
, **kwargs
):
272 if self
.parent
.cfg
.getboolean('debug', 'cbexc'):
273 self
.conn
.send("PRIVMSG %s :%09.3f \ 34\1f!!! CBEXC\1f\ 3 %s" % (self
.parent
.cfg
.get('debug', 'owner'), time
.time() % 100000, source
))
274 __import__('traceback').print_exc()
275 self
.log('!', "CBEXC %s %r %r" % (source
, args
, kwargs
))
276 # print "%09.3f %s [!] CBEXC %s %r %r" % (time.time() % 100000, self.nick, source, args, kwargs)
279 def parsemsg(self
, user
, target
, msg
):
280 if user
.glevel
<= -2: return # short circuit if user is IGNORED
282 chanparam
= None # was the channel specified as part of the command?
286 if target
== self
.nick
:
287 if msg
.startswith("\001"): #ctcp
288 msg
= msg
.strip("\001")
290 self
.msg(user
, "\001VERSION Erebus v%d.%d - http://github.com/zonidjan/erebus" % (self
.parent
.APIVERSION
, self
.parent
.RELEASE
))
293 triggerused
= msg
.startswith(self
.parent
.trigger
)
294 if triggerused
: msg
= msg
[len(self
.parent
.trigger
):]
300 if target
!= self
.nick
: # message was sent to a channel
302 if pieces
[0][:-1].lower() == self
.nick
.lower() and (pieces
[0][-1] == ":" or pieces
[0][-1] == ","):
303 pieces
.pop(0) # command actually starts with next word
304 if len(pieces
) == 0: # is there still anything left?
306 msg
= ' '.join(pieces
)
309 return # "message" is empty
313 if chanword
.startswith('#'):
314 chanparam
= self
.parent
.channel(chanword
)
316 if target
!= self
.nick
: # message was sent to a channel
317 chan
= self
.parent
.channel(target
)
319 if self
.parent
.haschanhook(target
.lower()):
320 for callback
in self
.parent
.getchanhook(target
.lower()):
322 cbret
= callback(self
, user
, chan
, *pieces
)
323 if isinstance(cbret
, stringbase
):
324 self
.reply(target
, user
, cbret
)
326 self
.msg(user
, "Command failed. Code: CBEXC%09.3f" % (time
.time() % 100000))
327 self
.__debug
_cbexception
("chanhook", user
=user
, target
=target
, msg
=msg
)
328 return # not to bot, don't process!
330 cmd
= pieces
[0].lower()
332 if self
.parent
.hashook(cmd
):
333 for callback
in self
.parent
.gethook(cmd
):
334 if chanparam
is not None and (callback
.needchan
or callback
.wantchan
):
337 if chan
is None and callback
.needchan
:
339 self
.msg(user
, "You need to specify a channel for that command.")
340 elif user
.glevel
>= callback
.reqglevel
and (not callback
.needchan
or chan
.levelof(user
.auth
) >= callback
.reqclevel
):
343 cbret
= callback(self
, user
, chan
, target
, *pieces
[1:])
344 if isinstance(cbret
, stringbase
):
345 self
.reply(target
, user
, cbret
)
347 self
.msg(user
, "Command failed. Code: CBEXC%09.3f" % (time
.time() % 100000))
348 self
.__debug
_cbexception
("hook", user
=user
, target
=target
, msg
=msg
)
349 except SystemExit as e
:
351 curs
= self
.parent
.query("UPDATE bots SET connected = 0")
357 self
.msg(user
, "I don't know that command.")
359 self
.msg(user
, "You don't have enough access to run that command.")
361 def __debug_nomsg(self
, target
, msg
):
362 if self
.parent
.cfg
.getboolean('debug', 'nomsg'):
363 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
))
364 self
.log('!', "!!! NOMSG")
365 # print "%09.3f %s [!] %s" % (time.time() % 100000, self.nick, "!!! NOMSG")
366 __import__('traceback').print_stack()
369 def reply(self
, chan
, user
, msg
):
370 if chan
is not None and (isinstance(chan
, self
.parent
.Channel
) or (isinstance(chan
, stringbase
) and chan
[0] == "#")):
371 self
.msg(chan
, "%s: %s" % (user
, msg
))
376 Does the work for msg/slowmsg/fastmsg. Uses the append_callback to append to the correct queue.
378 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.
380 def _msg(self
, target
, msg
, truncate
, append_callback
):
381 if self
.parent
.cfg
.getboolean('erebus', 'nofakelag'): return self
.fastmsg(target
, msg
)
383 cmd
= self
._formatmsg
(target
, msg
)
384 # The max length is much shorter than recvq (510) because of the length the server adds on about the source (us).
385 # If you know your hostmask, you can of course figure the exact length, but it's very difficult to reliably know your hostmask.
388 - 63 # max hostname len
390 - 3 # the symbols in :nick!user@host
393 if len(cmd
) > maxlen
:
399 if self
.conn
.exceeded
or self
.conn
.bytessent
+len(cmd
) >= self
.conn
.recvq
:
404 self
.conn
.exceeded
= True
407 def msg(self
, target
, msg
, truncate
=False):
408 return self
._msg
(target
, msg
, truncate
, self
.msgqueue
.append
)
410 def slowmsg(self
, target
, msg
, truncate
=False):
411 return self
._msg
(target
, msg
, truncate
, self
.slowmsgqueue
.append
)
413 def fastmsg(self
, target
, msg
, truncate
=False):
414 return self
._msg
(target
, msg
, truncate
, self
.conn
.send
)
416 def _formatmsg(self
, target
, msg
):
417 if target
is None or msg
is None:
418 return self
.__debug
_nomsg
(target
, msg
)
422 if target
.startswith('#'): command
= "PRIVMSG %s :%s" % (target
, msg
)
423 else: command
= "NOTICE %s :%s" % (target
, msg
)
429 self
.conn
.bytessent
-= self
.conn
.recvq
/3
430 if self
.conn
.bytessent
< 0: self
.conn
.bytessent
= 0
431 self
.conn
.exceeded
= True
435 cmd
= self
.msgqueue
.popleft()
438 cmd
= self
.slowmsgqueue
.popleft()
443 if self
.conn
.bytessent
+len(cmd
) > self
.conn
.recvq
: # If it's too long
444 if len(cmd
) > self
.conn
.recvq
: # Is the command itself somehow over max length???
445 self
._msgtimer
.start()
446 raise ValueError('Somehow a command that was too long made it into the message queue. Uhoh!', cmd
)
447 # Discard the message.
448 self
.msgqueue
.appendleft(cmd
) # Phew, we've just sent too much recently. Put it (back) on the (primary) queue.
452 self
._msgtimer
.start()
454 def _makemsgtimer(self
):
455 self
._msgtimer
= MyTimer(3, self
._popmsg
)
457 def join(self
, chan
):
458 self
.conn
.send("JOIN %s" % (chan
))
460 def part(self
, chan
):
461 self
.conn
.send("PART %s" % (chan
))
463 def quit(self
, reason
="Shutdown"):
464 self
.conn
.send("QUIT :%s" % (reason
))
466 def __str__(self
): return self
.nick
467 def __repr__(self
): return "<Bot %r>" % (self
.nick
)
469 class BotConnection(object):
470 def __init__(self
, parent
, bind
, server
, port
):
472 self
.buffer = bytearray()
477 self
.port
= int(port
)
479 self
.state
= 0 # 0=disconnected, 1=registering, 2=connected
483 self
.exceeded
= False
484 self
._nowrite
= False
487 self
.socket
= socket
.socket(socket
.AF_INET
, socket
.SOCK_STREAM
)
488 self
.socket
.bind((self
.bind
, 0))
489 self
.socket
.connect((self
.server
, self
.port
))
493 self
.send("NICK %s" % (self
.parent
.nick
))
494 self
.send("USER %s 0 * :%s" % (self
.parent
.user
, self
.parent
.realname
))
498 def registered(self
, done
=False):
499 if done
: self
.state
= 2
500 return self
.state
== 2
502 def send(self
, line
):
503 if not self
._nowrite
:
504 if self
.parent
.parent
.cfg
.getboolean('debug', 'io'):
505 self
.parent
.log('O', line
)
506 self
.bytessent
+= len(line
)
509 except socket
.error
as e
:
511 self
.parent
._goterror
(repr(e
))
513 if self
.parent
.parent
.cfg
.getboolean('debug', 'io'):
514 self
.parent
.log('X', line
)
516 def _write(self
, line
):
517 self
.socket
.sendall(line
.encode('utf-8', 'backslashreplace')+b
"\r\n")
520 self
.buffer += self
.socket
.recv(8192)
523 while b
"\r\n" in self
.buffer:
524 pieces
= self
.buffer.split(b
"\r\n", 1)
525 lines
.append(pieces
[0].decode('utf-8', 'backslashreplace'))
526 self
.buffer = pieces
[1]
530 def __str__(self
): return self
.parent
.nick
531 def __repr__(self
): return "<BotConnection %r (%r)>" % (self
.socket
.fileno(), self
.parent
.nick
)