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
):
133 self
.quit("Error detected: %s" % ' '.join(pieces
))
134 curs
= self
.parent
.query("UPDATE bots SET connected = 0")
139 def _got001(self
, pieces
):
140 pass # wait until the end of MOTD instead
141 def _gotRegistered(self
, pieces
):
142 self
.conn
.registered(True)
144 curs
= self
.parent
.query("UPDATE bots SET connected = 1 WHERE nick = %s", (self
.nick
,))
145 if curs
: curs
.close()
147 self
.conn
.send("MODE %s +x" % (pieces
[2]))
148 if self
.authname
is not None and self
.authpass
is not None:
149 self
.conn
.send("AUTH %s %s" % (self
.authname
, self
.authpass
))
152 def _gotprivmsg(self
, pieces
):
153 nick
= pieces
[0].split('!')[0][1:]
154 user
= self
.parent
.user(nick
)
156 msg
= ' '.join(pieces
[3:])[1:]
157 self
.parsemsg(user
, target
, msg
)
158 def _got353(self
, pieces
):
159 prefixes
= {'@': 'op', '+': 'voice'}
160 chan
= self
.parent
.channel(pieces
[4])
162 names
[0] = names
[0][1:] #remove colon
165 user
= self
.parent
.user(n
[1:])
166 chan
.userjoin(user
, prefixes
[n
[0]])
168 user
= self
.parent
.user(n
)
171 def _got354(self
, pieces
):
174 nick
, auth
= pieces
[4:6]
177 chan
, nick
, auth
= pieces
[4:7]
178 chan
= self
.parent
.channel(chan
)
179 user
= self
.parent
.user(nick
)
186 if qt
== 2: # triggered by !auth
189 self
.msg(nick
, "You are now known as #%s (access level: %s)" % (auth
, user
.glevel
))
191 self
.msg(nick
, "You are now known as #%s (not staff)" % (auth
))
193 self
.msg(nick
, "I tried, but you're not authed!")
194 def _got433(self
, pieces
):
195 if not self
.conn
.registered(): #we're trying to connect
196 newnick
= "%s%d" % (self
.nick
, random
.randint(111, 999))
197 self
.conn
.send("NICK %s" % (newnick
))
199 def _gotjoin(self
, pieces
):
200 nick
= pieces
[0].split('!')[0][1:]
201 chan
= self
.parent
.channel(pieces
[2])
203 if nick
== self
.nick
:
204 self
.conn
.send("WHO %s c%%cant,3" % (chan
))
206 user
= self
.parent
.user(nick
, justjoined
=True)
209 def _clientLeft(self
, nick
, chan
):
210 if nick
!= self
.nick
:
211 gone
= self
.parent
.user(nick
).part(chan
)
212 chan
.userpart(self
.parent
.user(nick
))
214 self
.parent
.user(nick
).quit()
215 del self
.parent
.users
[nick
.lower()]
216 def _gotpart(self
, pieces
):
217 nick
= pieces
[0].split('!')[0][1:]
218 chan
= self
.parent
.channel(pieces
[2])
219 self
._clientLeft
(nick
, chan
)
220 def _gotkick(self
, pieces
):
222 chan
= self
.parent
.channel(pieces
[2])
223 self
._clientLeft
(nick
, chan
)
224 def _gotquit(self
, pieces
):
225 nick
= pieces
[0].split('!')[0][1:]
226 if nick
!= self
.nick
:
227 for chan
in self
.parent
.user(nick
).chans
:
228 chan
.userpart(self
.parent
.user(nick
))
229 self
.parent
.user(nick
).quit()
230 del self
.parent
.users
[nick
.lower()]
231 def _gotnick(self
, pieces
):
232 oldnick
= pieces
[0].split('!')[0][1:]
233 newnick
= pieces
[2][1:]
234 if newnick
.lower() != oldnick
.lower():
235 self
.parent
.users
[newnick
.lower()] = self
.parent
.users
[oldnick
.lower()]
236 del self
.parent
.users
[oldnick
.lower()]
237 self
.parent
.users
[newnick
.lower()].nickchange(newnick
)
238 def _gotmode(self
, pieces
):
239 source
= pieces
[0].split('!')[0][1:]
241 if not chan
.startswith("#"): return
242 chan
= self
.parent
.channel(pieces
[2])
254 chan
.userop(self
.parent
.user(args
.pop(0)))
256 chan
.userdeop(self
.parent
.user(args
.pop(0)))
259 chan
.uservoice(self
.parent
.user(args
.pop(0)))
261 chan
.userdevoice(self
.parent
.user(args
.pop(0)))
263 pass # don't care about other modes
265 def __debug_cbexception(self
, source
, *args
, **kwargs
):
266 if self
.parent
.cfg
.getboolean('debug', 'cbexc'):
267 self
.conn
.send("PRIVMSG %s :%09.3f \ 34\1f!!! CBEXC\1f\ 3 %s" % (self
.parent
.cfg
.get('debug', 'owner'), time
.time() % 100000, source
))
268 __import__('traceback').print_exc()
269 self
.log('!', "CBEXC %s %r %r" % (source
, args
, kwargs
))
270 # print "%09.3f %s [!] CBEXC %s %r %r" % (time.time() % 100000, self.nick, source, args, kwargs)
273 def parsemsg(self
, user
, target
, msg
):
274 if user
.glevel
<= -2: return # short circuit if user is IGNORED
276 chanparam
= None # was the channel specified as part of the command?
280 if target
== self
.nick
:
281 if msg
.startswith("\001"): #ctcp
282 msg
= msg
.strip("\001")
284 self
.msg(user
, "\001VERSION Erebus v%d.%d - http://github.com/zonidjan/erebus" % (self
.parent
.APIVERSION
, self
.parent
.RELEASE
))
287 triggerused
= msg
.startswith(self
.parent
.trigger
)
288 if triggerused
: msg
= msg
[len(self
.parent
.trigger
):]
294 if target
!= self
.nick
: # message was sent to a channel
296 if pieces
[0][:-1].lower() == self
.nick
.lower() and (pieces
[0][-1] == ":" or pieces
[0][-1] == ","):
297 pieces
.pop(0) # command actually starts with next word
298 if len(pieces
) == 0: # is there still anything left?
300 msg
= ' '.join(pieces
)
303 return # "message" is empty
307 if chanword
.startswith('#'):
308 chanparam
= self
.parent
.channel(chanword
)
310 if target
!= self
.nick
: # message was sent to a channel
311 chan
= self
.parent
.channel(target
)
313 if self
.parent
.haschanhook(target
.lower()):
314 for callback
in self
.parent
.getchanhook(target
.lower()):
316 cbret
= callback(self
, user
, chan
, *pieces
)
317 except NotImplementedError:
318 self
.msg(user
, "Command not implemented.")
320 self
.msg(user
, "Command failed. Code: CBEXC%09.3f" % (time
.time() % 100000))
321 self
.__debug
_cbexception
("chanhook", user
=user
, target
=target
, msg
=msg
)
322 return # not to bot, don't process!
324 cmd
= pieces
[0].lower()
326 if self
.parent
.hashook(cmd
):
327 for callback
in self
.parent
.gethook(cmd
):
328 if chanparam
is not None and (callback
.needchan
or callback
.wantchan
):
331 if chan
is None and callback
.needchan
:
333 self
.msg(user
, "You need to specify a channel for that command.")
334 elif user
.glevel
>= callback
.reqglevel
and (not callback
.needchan
or chan
.levelof(user
.auth
) >= callback
.reqclevel
):
337 cbret
= callback(self
, user
, chan
, target
, *pieces
[1:])
338 if cbret
is NotImplemented:
339 raise NotImplementedError
340 elif isinstance(cbret
, stringbase
):
341 self
.reply(chan
, user
, cbret
)
342 except NotImplementedError:
343 self
.msg(user
, "Command not implemented.")
345 self
.msg(user
, "Command failed. Code: CBEXC%09.3f" % (time
.time() % 100000))
346 self
.__debug
_cbexception
("hook", user
=user
, target
=target
, msg
=msg
)
347 except SystemExit as e
:
349 curs
= self
.parent
.query("UPDATE bots SET connected = 0")
355 self
.msg(user
, "I don't know that command.")
357 self
.msg(user
, "You don't have enough access to run that command.")
359 def __debug_nomsg(self
, target
, msg
):
360 if self
.parent
.cfg
.getboolean('debug', 'nomsg'):
361 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
))
362 self
.log('!', "!!! NOMSG")
363 # print "%09.3f %s [!] %s" % (time.time() % 100000, self.nick, "!!! NOMSG")
364 __import__('traceback').print_stack()
367 def reply(self
, chan
, user
, msg
):
369 self
.msg(chan
, "%s: %s" % (user
, msg
))
373 def msg(self
, target
, msg
, truncate
=False):
374 if self
.parent
.cfg
.getboolean('erebus', 'nofakelag'): return self
.fastmsg(target
, msg
)
375 cmd
= self
._formatmsg
(target
, msg
)
376 if len(cmd
) > MAXLEN
:
381 if self
.conn
.exceeded
or self
.conn
.bytessent
+len(cmd
) >= self
.conn
.recvq
:
382 self
.msgqueue
.append(cmd
)
385 self
.conn
.exceeded
= True
388 def slowmsg(self
, target
, msg
, truncate
=False):
389 if self
.parent
.cfg
.getboolean('erebus', 'nofakelag'): return self
.fastmsg(target
, msg
)
390 cmd
= self
._formatmsg
(target
, msg
)
391 if len(cmd
) > MAXLEN
:
396 if self
.conn
.exceeded
or self
.conn
.bytessent
+len(cmd
) >= self
.conn
.recvq
:
397 self
.slowmsgqueue
.append(cmd
)
400 self
.conn
.exceeded
= True
403 def fastmsg(self
, target
, msg
, truncate
=False):
404 cmd
= self
._formatmsg
(target
, msg
)
405 if len(cmd
) > MAXLEN
:
411 self
.conn
.exceeded
= True
414 def _formatmsg(self
, target
, msg
):
415 if target
is None or msg
is None:
416 return self
.__debug
_nomsg
(target
, msg
)
420 if target
.startswith('#'): command
= "PRIVMSG %s :%s" % (target
, msg
)
421 else: command
= "NOTICE %s :%s" % (target
, msg
)
427 self
.conn
.bytessent
-= self
.conn
.recvq
/3
428 if self
.conn
.bytessent
< 0: self
.conn
.bytessent
= 0
429 self
.conn
.exceeded
= False
432 cmd
= self
.msgqueue
.popleft()
433 if not self
.conn
.exceeded
and self
.conn
.bytessent
+len(cmd
) < self
.conn
.recvq
:
435 self
.conn
.exceeded
= True
436 else: raise IndexError
439 cmd
= self
.slowmsgqueue
.popleft()
440 if not self
.conn
.exceeded
and self
.conn
.bytessent
+len(cmd
) < self
.conn
.recvq
:
442 self
.conn
.exceeded
= True
445 self
.msgtimer
.start()
447 def makemsgtimer(self
):
448 self
.msgtimer
= threading
.Timer(3, self
._popmsg
)
449 self
.msgtimer
.daemon
= True
451 def join(self
, chan
):
452 self
.conn
.send("JOIN %s" % (chan
))
454 def part(self
, chan
):
455 self
.conn
.send("PART %s" % (chan
))
457 def quit(self
, reason
="Shutdown"):
458 self
.conn
.send("QUIT :%s" % (reason
))
460 def __str__(self
): return self
.nick
461 def __repr__(self
): return "<Bot %r>" % (self
.nick
)
463 class BotConnection(object):
464 def __init__(self
, parent
, bind
, server
, port
):
466 self
.buffer = bytearray(8192)
471 self
.port
= int(port
)
473 self
.state
= 0 # 0=disconnected, 1=registering, 2=connected
477 self
.exceeded
= False
480 self
.socket
= socket
.socket(socket
.AF_INET
, socket
.SOCK_STREAM
)
481 self
.socket
.bind((self
.bind
, 0))
482 self
.socket
.connect((self
.server
, self
.port
))
486 self
.send("NICK %s" % (self
.parent
.nick
))
487 self
.send("USER %s 0 * :%s" % (self
.parent
.user
, self
.parent
.realname
))
491 def registered(self
, done
=False):
492 if done
: self
.state
= 2
493 return self
.state
== 2
495 def send(self
, line
):
496 if self
.parent
.parent
.cfg
.getboolean('debug', 'io'):
497 self
.parent
.log('O', line
)
498 self
.bytessent
+= len(line
)
501 def _write(self
, line
):
502 self
.socket
.sendall(line
.encode('utf-8', 'backslashreplace')+b
"\r\n")
505 self
.buffer += self
.socket
.recv(8192)
508 while b
"\r\n" in self
.buffer:
509 pieces
= self
.buffer.split(b
"\r\n", 1)
510 lines
.append(pieces
[0].decode('utf-8', 'backslashreplace'))
511 self
.buffer = pieces
[1]
515 def __str__(self
): return self
.parent
.nick
516 def __repr__(self
): return "<BotConnection %r (%r)>" % (self
.socket
.fileno(), self
.parent
.nick
)