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 MAXLEN
= 400 # arbitrary max length of a command generated by Bot.msg functions
12 if sys
.version_info
.major
< 3:
13 timerbase
= threading
._Timer
14 stringbase
= basestring
16 timerbase
= threading
.Timer
18 class MyTimer(timerbase
):
19 def __init__(self
, *args
, **kwargs
):
20 timerbase
.__init
__(self
, *args
, **kwargs
)
23 if sys
.version_info
.major
< 3:
24 stringbase
= basestring
28 #bots = {'erebus': bot.Bot(nick='Erebus', user='erebus', bind='', server='irc.quakenet.org', port=6667, realname='Erebus')}
30 def __init__(self
, parent
, nick
, user
, bind
, authname
, authpass
, server
, port
, realname
):
35 self
.realname
= realname
37 self
.authname
= authname
38 self
.authpass
= authpass
40 curs
= self
.parent
.query("SELECT chname FROM chans WHERE bot = %s AND active = 1", (self
.nick
,))
42 chansres
= curs
.fetchall()
44 self
.chans
= [self
.parent
.newchannel(self
, row
['chname']) for row
in chansres
]
48 self
.conn
= BotConnection(self
, bind
, server
, port
)
50 self
.lastreceived
= time
.time() #time we last received a line from the server
53 self
.msgqueue
= deque()
54 self
.slowmsgqueue
= deque()
60 curs
= self
.parent
.query("UPDATE bots SET connected = 0 WHERE nick = %s", (self
.nick
,))
65 if time
.time() > int(self
.parent
.cfg
.get('watchdog', 'maxtime', default
=300))+self
.lastreceived
:
66 self
.parse("ERROR :Fake-error from watchdog timer.")
67 self
.watchdogtimer
= MyTimer(int(self
.parent
.cfg
.get('watchdog', 'interval', default
=30)), self
.watchdog
)
69 def log(self
, *args
, **kwargs
):
70 self
.parent
.log(self
.nick
, *args
, **kwargs
)
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
.nick
,))
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 newnick
.lower() != oldnick
.lower():
238 self
.parent
.users
[newnick
.lower()] = self
.parent
.users
[oldnick
.lower()]
239 del self
.parent
.users
[oldnick
.lower()]
240 self
.parent
.users
[newnick
.lower()].nickchange(newnick
)
241 def _gotmode(self
, pieces
):
242 source
= pieces
[0].split('!')[0][1:]
244 if not chan
.startswith("#"): return
245 chan
= self
.parent
.channel(pieces
[2])
257 chan
.userop(self
.parent
.user(args
.pop(0)))
259 chan
.userdeop(self
.parent
.user(args
.pop(0)))
262 chan
.uservoice(self
.parent
.user(args
.pop(0)))
264 chan
.userdevoice(self
.parent
.user(args
.pop(0)))
266 pass # don't care about other modes
268 def __debug_cbexception(self
, source
, *args
, **kwargs
):
269 if self
.parent
.cfg
.getboolean('debug', 'cbexc'):
270 self
.conn
.send("PRIVMSG %s :%09.3f \ 34\1f!!! CBEXC\1f\ 3 %s" % (self
.parent
.cfg
.get('debug', 'owner'), time
.time() % 100000, source
))
271 __import__('traceback').print_exc()
272 self
.log('!', "CBEXC %s %r %r" % (source
, args
, kwargs
))
273 # print "%09.3f %s [!] CBEXC %s %r %r" % (time.time() % 100000, self.nick, source, args, kwargs)
276 def parsemsg(self
, user
, target
, msg
):
277 if user
.glevel
<= -2: return # short circuit if user is IGNORED
279 chanparam
= None # was the channel specified as part of the command?
283 if target
== self
.nick
:
284 if msg
.startswith("\001"): #ctcp
285 msg
= msg
.strip("\001")
287 self
.msg(user
, "\001VERSION Erebus v%d.%d - http://github.com/zonidjan/erebus" % (self
.parent
.APIVERSION
, self
.parent
.RELEASE
))
290 triggerused
= msg
.startswith(self
.parent
.trigger
)
291 if triggerused
: msg
= msg
[len(self
.parent
.trigger
):]
297 if target
!= self
.nick
: # message was sent to a channel
299 if pieces
[0][:-1].lower() == self
.nick
.lower() and (pieces
[0][-1] == ":" or pieces
[0][-1] == ","):
300 pieces
.pop(0) # command actually starts with next word
301 if len(pieces
) == 0: # is there still anything left?
303 msg
= ' '.join(pieces
)
306 return # "message" is empty
310 if chanword
.startswith('#'):
311 chanparam
= self
.parent
.channel(chanword
)
313 if target
!= self
.nick
: # message was sent to a channel
314 chan
= self
.parent
.channel(target
)
316 if self
.parent
.haschanhook(target
.lower()):
317 for callback
in self
.parent
.getchanhook(target
.lower()):
319 cbret
= callback(self
, user
, chan
, *pieces
)
320 except NotImplementedError:
321 self
.msg(user
, "Command not implemented.")
323 self
.msg(user
, "Command failed. Code: CBEXC%09.3f" % (time
.time() % 100000))
324 self
.__debug
_cbexception
("chanhook", user
=user
, target
=target
, msg
=msg
)
325 return # not to bot, don't process!
327 cmd
= pieces
[0].lower()
329 if self
.parent
.hashook(cmd
):
330 for callback
in self
.parent
.gethook(cmd
):
331 if chanparam
is not None and (callback
.needchan
or callback
.wantchan
):
334 if chan
is None and callback
.needchan
:
336 self
.msg(user
, "You need to specify a channel for that command.")
337 elif user
.glevel
>= callback
.reqglevel
and (not callback
.needchan
or chan
.levelof(user
.auth
) >= callback
.reqclevel
):
340 cbret
= callback(self
, user
, chan
, target
, *pieces
[1:])
341 if cbret
is NotImplemented:
342 raise NotImplementedError
343 elif isinstance(cbret
, stringbase
):
344 self
.reply(chan
, user
, cbret
)
345 except NotImplementedError:
346 self
.msg(user
, "Command not implemented.")
348 self
.msg(user
, "Command failed. Code: CBEXC%09.3f" % (time
.time() % 100000))
349 self
.__debug
_cbexception
("hook", user
=user
, target
=target
, msg
=msg
)
350 except SystemExit as e
:
352 curs
= self
.parent
.query("UPDATE bots SET connected = 0")
358 self
.msg(user
, "I don't know that command.")
360 self
.msg(user
, "You don't have enough access to run that command.")
362 def __debug_nomsg(self
, target
, msg
):
363 if self
.parent
.cfg
.getboolean('debug', 'nomsg'):
364 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
))
365 self
.log('!', "!!! NOMSG")
366 # print "%09.3f %s [!] %s" % (time.time() % 100000, self.nick, "!!! NOMSG")
367 __import__('traceback').print_stack()
370 def reply(self
, chan
, user
, msg
):
372 self
.msg(chan
, "%s: %s" % (user
, msg
))
376 def msg(self
, target
, msg
, truncate
=False):
377 if self
.parent
.cfg
.getboolean('erebus', 'nofakelag'): return self
.fastmsg(target
, msg
)
378 cmd
= self
._formatmsg
(target
, msg
)
379 if len(cmd
) > MAXLEN
:
384 if self
.conn
.exceeded
or self
.conn
.bytessent
+len(cmd
) >= self
.conn
.recvq
:
385 self
.msgqueue
.append(cmd
)
388 self
.conn
.exceeded
= True
391 def slowmsg(self
, target
, msg
, truncate
=False):
392 if self
.parent
.cfg
.getboolean('erebus', 'nofakelag'): return self
.fastmsg(target
, msg
)
393 cmd
= self
._formatmsg
(target
, msg
)
394 if len(cmd
) > MAXLEN
:
399 if self
.conn
.exceeded
or self
.conn
.bytessent
+len(cmd
) >= self
.conn
.recvq
:
400 self
.slowmsgqueue
.append(cmd
)
403 self
.conn
.exceeded
= True
406 def fastmsg(self
, target
, msg
, truncate
=False):
407 cmd
= self
._formatmsg
(target
, msg
)
408 if len(cmd
) > MAXLEN
:
414 self
.conn
.exceeded
= True
417 def _formatmsg(self
, target
, msg
):
418 if target
is None or msg
is None:
419 return self
.__debug
_nomsg
(target
, msg
)
423 if target
.startswith('#'): command
= "PRIVMSG %s :%s" % (target
, msg
)
424 else: command
= "NOTICE %s :%s" % (target
, msg
)
430 self
.conn
.bytessent
-= self
.conn
.recvq
/3
431 if self
.conn
.bytessent
< 0: self
.conn
.bytessent
= 0
432 self
.conn
.exceeded
= False
435 cmd
= self
.msgqueue
.popleft()
436 if not self
.conn
.exceeded
and self
.conn
.bytessent
+len(cmd
) < self
.conn
.recvq
:
438 self
.conn
.exceeded
= True
439 else: raise IndexError
442 cmd
= self
.slowmsgqueue
.popleft()
443 if not self
.conn
.exceeded
and self
.conn
.bytessent
+len(cmd
) < self
.conn
.recvq
:
445 self
.conn
.exceeded
= True
448 self
.msgtimer
.start()
450 def makemsgtimer(self
):
451 self
.msgtimer
= threading
.Timer(3, self
._popmsg
)
452 self
.msgtimer
.daemon
= True
454 def join(self
, chan
):
455 self
.conn
.send("JOIN %s" % (chan
))
457 def part(self
, chan
):
458 self
.conn
.send("PART %s" % (chan
))
460 def quit(self
, reason
="Shutdown"):
461 self
.conn
.send("QUIT :%s" % (reason
))
463 def __str__(self
): return self
.nick
464 def __repr__(self
): return "<Bot %r>" % (self
.nick
)
466 class BotConnection(object):
467 def __init__(self
, parent
, bind
, server
, port
):
469 self
.buffer = bytearray(8192)
474 self
.port
= int(port
)
476 self
.state
= 0 # 0=disconnected, 1=registering, 2=connected
480 self
.exceeded
= False
483 self
.socket
= socket
.socket(socket
.AF_INET
, socket
.SOCK_STREAM
)
484 self
.socket
.bind((self
.bind
, 0))
485 self
.socket
.connect((self
.server
, self
.port
))
489 self
.send("NICK %s" % (self
.parent
.nick
))
490 self
.send("USER %s 0 * :%s" % (self
.parent
.user
, self
.parent
.realname
))
494 def registered(self
, done
=False):
495 if done
: self
.state
= 2
496 return self
.state
== 2
498 def send(self
, line
):
499 if self
.parent
.parent
.cfg
.getboolean('debug', 'io'):
500 self
.parent
.log('O', line
)
501 self
.bytessent
+= len(line
)
504 except socket
.error
as e
:
505 self
.parent
._goterror
(repr(e
))
507 def _write(self
, line
):
508 self
.socket
.sendall(line
.encode('utf-8', 'backslashreplace')+b
"\r\n")
511 self
.buffer += self
.socket
.recv(8192)
514 while b
"\r\n" in self
.buffer:
515 pieces
= self
.buffer.split(b
"\r\n", 1)
516 lines
.append(pieces
[0].decode('utf-8', 'backslashreplace'))
517 self
.buffer = pieces
[1]
521 def __str__(self
): return self
.parent
.nick
522 def __repr__(self
): return "<BotConnection %r (%r)>" % (self
.socket
.fileno(), self
.parent
.nick
)