3 # Erebus IRC bot - Author: John Runyon
4 # "Bot" and "BotConnection" classes (handling a specific "arm")
6 import socket
, sys
, time
, threading
, os
, random
7 from collections
import deque
9 MAXLEN
= 400 # arbitrary max length of a command generated by Bot.msg functions
11 class MyTimer(threading
._Timer
):
12 def __init__(self
, *args
, **kwargs
):
13 threading
._Timer
.__init
__(self
, *args
, **kwargs
)
17 #bots = {'erebus': bot.Bot(nick='Erebus', user='erebus', bind='', server='irc.quakenet.org', port=6667, realname='Erebus')}
19 def __init__(self
, parent
, nick
, user
, bind
, authname
, authpass
, server
, port
, realname
):
24 self
.realname
= realname
26 self
.authname
= authname
27 self
.authpass
= authpass
29 curs
= self
.parent
.query("SELECT chname FROM chans WHERE bot = %s AND active = 1", (self
.nick
,))
31 chansres
= curs
.fetchall()
33 self
.chans
= [self
.parent
.newchannel(self
, row
['chname']) for row
in chansres
]
37 self
.conn
= BotConnection(self
, bind
, server
, port
)
39 self
.lastreceived
= time
.time() #time we last received a line from the server
42 self
.msgqueue
= deque()
43 self
.slowmsgqueue
= deque()
49 curs
= self
.parent
.query("UPDATE bots SET connected = 0 WHERE nick = %s", (self
.nick
,))
54 if time
.time() > self
.parent
.cfg
.get('watchdog', 'maxtime', default
=300)+self
.lastreceived
:
55 self
.parse("ERROR :Fake-error from watchdog timer.")
56 self
.watchdogtimer
= MyTimer(self
.parent
.cfg
.get('watchdog', 'interval', default
=30), self
.watchdog
)
58 def log(self
, *args
, **kwargs
):
59 self
.parent
.log(self
.nick
, *args
, **kwargs
)
62 if self
.conn
.connect():
63 self
.parent
.newfd(self
, self
.conn
.socket
.fileno())
66 self
.lastreceived
= time
.time()
67 return self
.conn
.read()
69 def _checknick(self
): # check if we're using the right nick, try changing
70 if self
.nick
!= self
.permnick
and self
.conn
.registered():
71 self
.conn
.send("NICK %s" % (self
.permnick
))
73 def parse(self
, line
):
74 if self
.parent
.cfg
.getboolean('debug', 'io'):
79 zero
= { #things to look for without source
80 'NOTICE': self
._gotconnected
,
81 'PING': self
._gotping
,
82 'ERROR': self
._goterror
,
84 one
= { #things to look for after source
86 '376': self
._gotRegistered
,
87 '422': self
._gotRegistered
,
88 'PRIVMSG': self
._gotprivmsg
,
89 '353': self
._got
353, #NAMES
90 '354': self
._got
354, #WHO
91 '433': self
._got
433, #nick in use
92 'JOIN': self
._gotjoin
,
93 'PART': self
._gotpart
,
94 'KICK': self
._gotkick
,
95 'QUIT': self
._gotquit
,
96 'NICK': self
._gotnick
,
97 'MODE': self
._gotmode
,
100 if self
.parent
.hasnumhook(pieces
[1]):
101 hooks
= self
.parent
.getnumhook(pieces
[1])
102 for callback
in hooks
:
106 self
.__debug
_cbexception
("numhook", line
)
108 if pieces
[0] in zero
:
109 zero
[pieces
[0]](pieces
)
110 elif pieces
[1] in one
:
111 one
[pieces
[1]](pieces
)
113 def _gotconnected(self
, pieces
):
114 if not self
.conn
.registered():
116 def _gotping(self
, pieces
):
117 self
.conn
.send("PONG %s" % (pieces
[1]))
119 def _goterror(self
, pieces
):
121 self
.quit("Error detected: %s" % ' '.join(pieces
))
122 curs
= self
.parent
.query("UPDATE bots SET connected = 0")
127 def _got001(self
, pieces
):
128 pass # wait until the end of MOTD instead
129 def _gotRegistered(self
, pieces
):
130 self
.conn
.registered(True)
132 curs
= self
.parent
.query("UPDATE bots SET connected = 1 WHERE nick = %s", (self
.nick
,))
133 if curs
: curs
.close()
135 self
.conn
.send("MODE %s +x" % (pieces
[2]))
136 if self
.authname
is not None and self
.authpass
is not None:
137 self
.conn
.send("AUTH %s %s" % (self
.authname
, self
.authpass
))
140 def _gotprivmsg(self
, pieces
):
141 nick
= pieces
[0].split('!')[0][1:]
142 user
= self
.parent
.user(nick
)
144 msg
= ' '.join(pieces
[3:])[1:]
145 self
.parsemsg(user
, target
, msg
)
146 def _got353(self
, pieces
):
147 prefixes
= {'@': 'op', '+': 'voice'}
148 chan
= self
.parent
.channel(pieces
[4])
150 names
[0] = names
[0][1:] #remove colon
153 user
= self
.parent
.user(n
[1:])
154 chan
.userjoin(user
, prefixes
[n
[0]])
156 user
= self
.parent
.user(n
)
159 def _got354(self
, pieces
):
162 nick
, auth
= pieces
[4:6]
165 chan
, nick
, auth
= pieces
[4:7]
166 chan
= self
.parent
.channel(chan
)
167 user
= self
.parent
.user(nick
)
174 if qt
== 2: # triggered by !auth
177 self
.msg(nick
, "You are now known as #%s (access level: %s)" % (auth
, user
.glevel
))
179 self
.msg(nick
, "You are now known as #%s (not staff)" % (auth
))
181 self
.msg(nick
, "I tried, but you're not authed!")
182 def _got433(self
, pieces
):
183 if not self
.conn
.registered(): #we're trying to connect
184 newnick
= "%s%d" % (self
.nick
, random
.randint(111,999))
185 self
.conn
.send("NICK %s" % (newnick
))
187 def _gotjoin(self
, pieces
):
188 nick
= pieces
[0].split('!')[0][1:]
189 chan
= self
.parent
.channel(pieces
[2])
191 if nick
== self
.nick
:
192 self
.conn
.send("WHO %s c%%cant,3" % (chan
))
194 user
= self
.parent
.user(nick
, justjoined
=True)
197 def _clientLeft(self
, nick
, chan
):
198 if nick
!= self
.nick
:
199 gone
= self
.parent
.user(nick
).part(chan
)
200 chan
.userpart(self
.parent
.user(nick
))
202 self
.parent
.user(nick
).quit()
203 del self
.parent
.users
[nick
.lower()]
204 def _gotpart(self
, pieces
):
205 nick
= pieces
[0].split('!')[0][1:]
206 chan
= self
.parent
.channel(pieces
[2])
207 self
._clientLeft
(nick
, chan
)
208 def _gotkick(self
, pieces
):
210 chan
= self
.parent
.channel(pieces
[2])
211 self
._clientLeft
(nick
, chan
)
212 def _gotquit(self
, pieces
):
213 nick
= pieces
[0].split('!')[0][1:]
214 if nick
!= self
.nick
:
215 for chan
in self
.parent
.user(nick
).chans
:
216 chan
.userpart(self
.parent
.user(nick
))
217 self
.parent
.user(nick
).quit()
218 del self
.parent
.users
[nick
.lower()]
219 def _gotnick(self
, pieces
):
220 oldnick
= pieces
[0].split('!')[0][1:]
221 newnick
= pieces
[2][1:]
222 if newnick
.lower() != oldnick
.lower():
223 self
.parent
.users
[newnick
.lower()] = self
.parent
.users
[oldnick
.lower()]
224 del self
.parent
.users
[oldnick
.lower()]
225 self
.parent
.users
[newnick
.lower()].nickchange(newnick
)
226 def _gotmode(self
, pieces
):
227 source
= pieces
[0].split('!')[0][1:]
229 if not chan
.startswith("#"): return
230 chan
= self
.parent
.channel(pieces
[2])
242 chan
.userop(self
.parent
.user(args
.pop(0)))
244 chan
.userdeop(self
.parent
.user(args
.pop(0)))
247 chan
.uservoice(self
.parent
.user(args
.pop(0)))
249 chan
.userdevoice(self
.parent
.user(args
.pop(0)))
251 pass # don't care about other modes
253 def __debug_cbexception(self
, source
, *args
, **kwargs
):
254 if self
.parent
.cfg
.getboolean('debug', 'cbexc'):
255 self
.conn
.send("PRIVMSG %s :%09.3f \ 34\1f!!! CBEXC\1f\ 3 %s" % (self
.parent
.cfg
.get('debug', 'owner'), time
.time() % 100000, source
))
256 __import__('traceback').print_exc()
257 self
.log('!', "CBEXC %s %r %r" % (source
, args
, kwargs
))
258 # print "%09.3f %s [!] CBEXC %s %r %r" % (time.time() % 100000, self.nick, source, args, kwargs)
261 def parsemsg(self
, user
, target
, msg
):
262 if user
.glevel
<= -2: return # short circuit if user is IGNORED
264 chanparam
= None # was the channel specified as part of the command?
268 triggerused
= msg
.startswith(self
.parent
.trigger
)
269 if triggerused
: msg
= msg
[len(self
.parent
.trigger
):]
272 if target
== self
.nick
:
273 if msg
.startswith("\001"): #ctcp
274 msg
= msg
.strip("\001")
276 self
.msg(user
, "\001VERSION Erebus v%d.%d - http://github.com/zonidjan/erebus" % (self
.parent
.APIVERSION
, self
.parent
.RELEASE
))
279 if target
!= self
.nick
: # message was sent to a channel
281 if msg
.startswith('*'): # message may be addressed to bot by "*BOTNICK" trigger?
282 if pieces
[0][1:].lower() == self
.nick
.lower():
283 pieces
.pop(0) # command actually starts with next word
284 msg
= ' '.join(pieces
) # command actually starts with next word
287 return # "message" is empty
291 if chanword
.startswith('#'):
292 chanparam
= self
.parent
.channel(chanword
)
294 if target
!= self
.nick
: # message was sent to a channel
295 chan
= self
.parent
.channel(target
)
297 if self
.parent
.haschanhook(target
.lower()):
298 for callback
in self
.parent
.getchanhook(target
.lower()):
300 cbret
= callback(self
, user
, chan
, *pieces
)
301 except NotImplementedError:
302 self
.msg(user
, "Command not implemented.")
304 self
.msg(user
, "Command failed. Code: CBEXC%09.3f" % (time
.time() % 100000))
305 self
.__debug
_cbexception
("chanhook", user
=user
, target
=target
, msg
=msg
)
306 return # not to bot, don't process!
308 cmd
= pieces
[0].lower()
310 if self
.parent
.hashook(cmd
):
311 for callback
in self
.parent
.gethook(cmd
):
312 if chanparam
is not None and (callback
.needchan
or callback
.wantchan
):
315 if chan
is None and callback
.needchan
:
317 self
.msg(user
, "You need to specify a channel for that command.")
318 elif user
.glevel
>= callback
.reqglevel
and (not callback
.needchan
or chan
.levelof(user
.auth
) >= callback
.reqclevel
):
321 cbret
= callback(self
, user
, chan
, target
, *pieces
[1:])
322 except NotImplementedError:
323 self
.msg(user
, "Command not implemented.")
325 self
.msg(user
, "Command failed. Code: CBEXC%09.3f" % (time
.time() % 100000))
326 self
.__debug
_cbexception
("hook", user
=user
, target
=target
, msg
=msg
)
327 except SystemExit as e
:
329 curs
= self
.parent
.query("UPDATE bots SET connected = 0")
335 self
.msg(user
, "I don't know that command.")
337 self
.msg(user
, "You don't have enough access to run that command.")
339 def __debug_nomsg(self
, target
, msg
):
340 if self
.parent
.cfg
.getboolean('debug', 'nomsg'):
341 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
))
342 self
.log('!', "!!! NOMSG")
343 # print "%09.3f %s [!] %s" % (time.time() % 100000, self.nick, "!!! NOMSG")
344 __import__('traceback').print_stack()
346 def msg(self
, target
, msg
):
347 if self
.parent
.cfg
.getboolean('erebus', 'nofakelag'): return self
.fastmsg(target
, msg
)
348 cmd
= self
._formatmsg
(target
, msg
)
349 if len(cmd
) > MAXLEN
: return False
350 if self
.conn
.exceeded
or self
.conn
.bytessent
+len(cmd
) >= self
.conn
.recvq
:
351 self
.msgqueue
.append(cmd
)
354 self
.conn
.exceeded
= True
357 def slowmsg(self
, target
, msg
):
358 if self
.parent
.cfg
.getboolean('erebus', 'nofakelag'): return self
.fastmsg(target
, msg
)
359 cmd
= self
._formatmsg
(target
, msg
)
360 if len(cmd
) > MAXLEN
: return False
361 if self
.conn
.exceeded
or self
.conn
.bytessent
+len(cmd
) >= self
.conn
.recvq
:
362 self
.slowmsgqueue
.append(cmd
)
365 self
.conn
.exceeded
= True
368 def fastmsg(self
, target
, msg
):
369 cmd
= self
._formatmsg
(target
, msg
)
370 if len(cmd
) > MAXLEN
: return False
372 self
.conn
.exceeded
= True
375 def _formatmsg(self
, target
, msg
):
376 if target
is None or msg
is None:
377 return self
.__debug
_nomsg
(target
, msg
)
381 if target
.startswith('#'): command
= "PRIVMSG %s :%s" % (target
, msg
)
382 else: command
= "NOTICE %s :%s" % (target
, msg
)
388 self
.conn
.bytessent
-= self
.conn
.recvq
/3
389 if self
.conn
.bytessent
< 0: self
.conn
.bytessent
= 0
390 self
.conn
.exceeded
= False
393 cmd
= self
.msgqueue
.popleft()
394 if not self
.conn
.exceeded
and self
.conn
.bytessent
+len(cmd
) < self
.conn
.recvq
:
396 self
.conn
.exceeded
= True
397 else: raise IndexError
400 cmd
= self
.slowmsgqueue
.popleft()
401 if not self
.conn
.exceeded
and self
.conn
.bytessent
+len(cmd
) < self
.conn
.recvq
:
403 self
.conn
.exceeded
= True
406 self
.msgtimer
.start()
408 def makemsgtimer(self
):
409 self
.msgtimer
= threading
.Timer(3, self
._popmsg
)
410 self
.msgtimer
.daemon
= True
412 def join(self
, chan
):
413 self
.conn
.send("JOIN %s" % (chan
))
415 def part(self
, chan
):
416 self
.conn
.send("PART %s" % (chan
))
418 def quit(self
, reason
="Shutdown"):
419 self
.conn
.send("QUIT :%s" % (reason
))
421 def __str__(self
): return self
.nick
422 def __repr__(self
): return "<Bot %r>" % (self
.nick
)
424 class BotConnection(object):
425 def __init__(self
, parent
, bind
, server
, port
):
432 self
.port
= int(port
)
434 self
.state
= 0 # 0=disconnected, 1=registering, 2=connected
438 self
.exceeded
= False
441 self
.socket
= socket
.socket(socket
.AF_INET
, socket
.SOCK_STREAM
)
442 self
.socket
.bind((self
.bind
, 0))
443 self
.socket
.connect((self
.server
, self
.port
))
447 self
.send("NICK %s" % (self
.parent
.nick
))
448 self
.send("USER %s 0 * :%s" % (self
.parent
.user
, self
.parent
.realname
))
452 def registered(self
, done
=False):
453 if done
: self
.state
= 2
454 return self
.state
== 2
456 def send(self
, line
):
457 if self
.parent
.cfg
.getboolean('debug', 'io'):
458 self
.parent
.log('O', line
)
459 # print "%09.3f %s [O] %s" % (time.time() % 100000, self.parent.nick, line)
460 self
.bytessent
+= len(line
)
463 def _write(self
, line
):
464 self
.socket
.sendall(line
+"\r\n")
467 self
.buffer += self
.socket
.recv(8192)
470 while "\r\n" in self
.buffer:
471 pieces
= self
.buffer.split("\r\n", 1)
472 # self.parent.log('I', pieces[0]) # replaced by statement in Bot.parse()
473 # print "%09.3f %s [I] %s" % (time.time() % 100000, self.parent.nick, pieces[0])
474 lines
.append(pieces
[0])
475 self
.buffer = pieces
[1]
479 def __str__(self
): return self
.parent
.nick
480 def __repr__(self
): return "<BotConnection %r (%r)>" % (self
.socket
.fileno(), self
.parent
.nick
)