]>
Commit | Line | Data |
---|---|---|
b25d4368 | 1 | #!/usr/bin/python |
4477123d | 2 | # vim: fileencoding=utf-8 |
b25d4368 | 3 | |
931c88a4 | 4 | # Erebus IRC bot - Author: John Runyon |
5 | # "Bot" and "BotConnection" classes (handling a specific "arm") | |
6 | ||
e8885384 | 7 | import os, random, socket, struct, sys, threading, time, traceback |
e64ac4a0 | 8 | from collections import deque |
b25d4368 | 9 | |
a28e2ae9 | 10 | if sys.version_info.major < 3: |
11 | timerbase = threading._Timer | |
d6052ebf | 12 | stringbase = basestring |
a28e2ae9 | 13 | else: |
14 | timerbase = threading.Timer | |
d6052ebf | 15 | stringbase = str |
f89262c4 | 16 | |
a28e2ae9 | 17 | class MyTimer(timerbase): |
2ffa3996 | 18 | def __init__(self, *args, **kwargs): |
a28e2ae9 | 19 | timerbase.__init__(self, *args, **kwargs) |
2ffa3996 | 20 | self.daemon = True |
21 | ||
d6052ebf | 22 | if sys.version_info.major < 3: |
23 | stringbase = basestring | |
24 | else: | |
25 | stringbase = str | |
2ffa3996 | 26 | |
b25d4368 | 27 | #bots = {'erebus': bot.Bot(nick='Erebus', user='erebus', bind='', server='irc.quakenet.org', port=6667, realname='Erebus')} |
28 | class Bot(object): | |
0af282c6 | 29 | def __init__(self, parent, nick, user, bind, authname, authpass, server, port, realname): |
a9a00d34 JR |
30 | self.maxlen = 510 |
31 | ||
b25d4368 | 32 | self.parent = parent |
33 | self.nick = nick | |
0784e720 | 34 | self.permnick = nick |
a12f7519 | 35 | self.user = user |
36 | self.realname = realname | |
5477b368 | 37 | |
0af282c6 | 38 | self.authname = authname |
39 | self.authpass = authpass | |
40 | ||
1e76e96c JR |
41 | self.connecttime = 0 # time at which we received numeric 001 |
42 | self.server = server # the address we try to (re-)connect to | |
43 | self.port = port | |
44 | self.servername = server # the name of the server we got connected to | |
45 | ||
50331d1a | 46 | curs = self.parent.query("SELECT chname FROM chans WHERE bot = %s AND active = 1", (self.permnick,)) |
2729abc8 | 47 | if curs: |
4fa1118b | 48 | chansres = curs.fetchall() |
49 | curs.close() | |
50 | self.chans = [self.parent.newchannel(self, row['chname']) for row in chansres] | |
6de27fd4 | 51 | else: |
52 | self.chans = [] | |
b25d4368 | 53 | |
a12f7519 | 54 | self.conn = BotConnection(self, bind, server, port) |
e64ac4a0 | 55 | |
2ffa3996 | 56 | self.lastreceived = time.time() #time we last received a line from the server |
d6c6516c | 57 | self.watchdog() |
2ffa3996 | 58 | |
e64ac4a0 | 59 | self.msgqueue = deque() |
2bb267e0 | 60 | self.slowmsgqueue = deque() |
82025c0a JR |
61 | self._makemsgtimer() |
62 | self._msgtimer.start() | |
04fe7fd8 | 63 | self.joined_chans = False |
e64ac4a0 | 64 | |
e40e5b39 | 65 | def __del__(self): |
2729abc8 | 66 | try: |
50331d1a | 67 | curs = self.parent.query("UPDATE bots SET connected = 0 WHERE nick = %s", (self.permnick,)) |
2729abc8 | 68 | curs.close() |
69 | except: pass | |
e40e5b39 | 70 | |
2ffa3996 | 71 | def watchdog(self): |
b8150e3d | 72 | if time.time() > int(self.parent.cfg.get('watchdog', 'maxtime', default=300))+self.lastreceived: |
2ffa3996 | 73 | self.parse("ERROR :Fake-error from watchdog timer.") |
b8150e3d JR |
74 | if self.conn.registered(): |
75 | self.conn.send("PING :%s" % (time.time())) | |
a46d97d3 | 76 | self._checknick() |
2a44c0cd JR |
77 | watchdogtimer = MyTimer(int(self.parent.cfg.get('watchdog', 'interval', default=30)), self.watchdog) |
78 | watchdogtimer.start() | |
e64ac4a0 | 79 | |
a8553c45 | 80 | def log(self, *args, **kwargs): |
81 | self.parent.log(self.nick, *args, **kwargs) | |
82 | ||
b25d4368 | 83 | def connect(self): |
d3531ad2 | 84 | self.log('!', "Connecting") |
b2a896c8 | 85 | if self.conn.connect(): |
b736b336 | 86 | self.log('!', "Connected") |
49a455aa | 87 | self.parent.newfd(self, self.conn.socket.fileno()) |
88 | ||
b25d4368 | 89 | def getdata(self): |
b8150e3d JR |
90 | try: |
91 | recvd = self.conn.read() | |
92 | self.lastreceived = time.time() | |
93 | return recvd | |
94 | except EOFError as e: | |
b736b336 | 95 | return [":%s ERROR :%s%r" % (self.nick, e.__class__.__name__, e.args)] |
a4eacae2 | 96 | |
0784e720 | 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)) | |
100 | ||
b25d4368 | 101 | def parse(self, line): |
102 | pieces = line.split() | |
a4eacae2 | 103 | |
a99afee6 JR |
104 | if pieces[0][0] == ":": |
105 | numeric = pieces[1] | |
106 | else: | |
107 | numeric = pieces[0] | |
108 | ||
a38e8be0 | 109 | # dispatch dict |
b8150e3d | 110 | dispatch = { |
c22ee2ba | 111 | 'NOTICE': self._gotconnected, |
28d06664 | 112 | '001': self._got001, |
1e76e96c | 113 | '004': self._got004, |
0784e720 | 114 | '376': self._gotRegistered, |
115 | '422': self._gotRegistered, | |
28d06664 | 116 | 'PRIVMSG': self._gotprivmsg, |
84b7c247 | 117 | '353': self._got353, #NAMES |
118 | '354': self._got354, #WHO | |
1aba32fb | 119 | '396': self._gotHiddenHost, # hidden host has been set |
0784e720 | 120 | '433': self._got433, #nick in use |
28d06664 | 121 | 'JOIN': self._gotjoin, |
122 | 'PART': self._gotpart, | |
6de27fd4 | 123 | 'KICK': self._gotkick, |
28d06664 | 124 | 'QUIT': self._gotquit, |
125 | 'NICK': self._gotnick, | |
126 | 'MODE': self._gotmode, | |
a99afee6 JR |
127 | 'PING': self._gotping, |
128 | 'ERROR': self._goterror, | |
28d06664 | 129 | } |
d1ea2946 | 130 | |
a99afee6 JR |
131 | if self.parent.hasnumhook(numeric): |
132 | hooks = self.parent.getnumhook(numeric) | |
e4a4c762 | 133 | for callback in hooks: |
a38e8be0 | 134 | try: |
135 | callback(self, line) | |
136 | except Exception: | |
e8885384 | 137 | self._cbexception("numhook", line) |
e4a4c762 | 138 | |
a99afee6 JR |
139 | if numeric in dispatch: |
140 | dispatch[numeric](pieces) | |
28d06664 | 141 | |
0784e720 | 142 | def _gotconnected(self, pieces): |
28d06664 | 143 | if not self.conn.registered(): |
144 | self.conn.register() | |
145 | def _gotping(self, pieces): | |
146 | self.conn.send("PONG %s" % (pieces[1])) | |
0784e720 | 147 | self._checknick() |
f5f2b592 | 148 | def _goterror(self, pieces): |
666366fd | 149 | # TODO: better handling, just reconnect that single bot |
dc0f891b | 150 | error = ' '.join(pieces) |
2729abc8 | 151 | try: |
dc0f891b JR |
152 | raise Exception(error) |
153 | except Exception as e: | |
154 | self.parent.mustquit = e | |
155 | try: | |
156 | self.quit("Error detected: %s" % (error)) | |
666366fd | 157 | except: pass |
158 | try: | |
2729abc8 | 159 | curs = self.parent.query("UPDATE bots SET connected = 0") |
160 | curs.close() | |
2ffa3996 | 161 | except: pass |
dc0f891b | 162 | self.log('!', 'Bot exiting due to: %s' % (error)) |
28d06664 | 163 | def _got001(self, pieces): |
1e76e96c JR |
164 | # We wait until the end of MOTD instead to consider ourselves registered, but consider uptime as of 001 |
165 | self.connecttime = time.time() | |
166 | def _got004(self, pieces): | |
167 | self.servername = pieces[3] | |
0784e720 | 168 | def _gotRegistered(self, pieces): |
28d06664 | 169 | self.conn.registered(True) |
e40e5b39 | 170 | |
50331d1a | 171 | curs = self.parent.query("UPDATE bots SET connected = 1 WHERE nick = %s", (self.permnick,)) |
2729abc8 | 172 | if curs: curs.close() |
e40e5b39 | 173 | |
28d06664 | 174 | self.conn.send("MODE %s +x" % (pieces[2])) |
175 | if self.authname is not None and self.authpass is not None: | |
04fe7fd8 | 176 | self.conn.send(self.parent.cfg.get('erebus', 'auth_command', "AUTH %s %s") % (self.authname, self.authpass)) |
1aba32fb JR |
177 | if not self.parent.cfg.getboolean('erebus', 'wait_for_hidden_host'): |
178 | for c in self.chans: | |
179 | self.join(c.name) | |
04fe7fd8 | 180 | self.joined_chans = True |
1aba32fb | 181 | def _gotHiddenHost(self, pieces): |
04fe7fd8 | 182 | if not self.joined_chans and self.parent.cfg.getboolean('erebus', 'wait_for_hidden_host'): |
1aba32fb JR |
183 | for c in self.chans: |
184 | self.join(c.name) | |
04fe7fd8 | 185 | self.joined_chans = True |
28d06664 | 186 | def _gotprivmsg(self, pieces): |
187 | nick = pieces[0].split('!')[0][1:] | |
188 | user = self.parent.user(nick) | |
189 | target = pieces[2] | |
190 | msg = ' '.join(pieces[3:])[1:] | |
191 | self.parsemsg(user, target, msg) | |
84b7c247 | 192 | def _got353(self, pieces): |
2591a1c8 | 193 | prefixes = {'@': 'op', '+': 'voice'} |
84b7c247 | 194 | chan = self.parent.channel(pieces[4]) |
195 | names = pieces[5:] | |
196 | names[0] = names[0][1:] #remove colon | |
197 | for n in names: | |
2591a1c8 | 198 | if n[0] in prefixes: |
199 | user = self.parent.user(n[1:]) | |
200 | chan.userjoin(user, prefixes[n[0]]) | |
84b7c247 | 201 | else: |
2591a1c8 | 202 | user = self.parent.user(n) |
84b7c247 | 203 | chan.userjoin(user) |
204 | user.join(chan) | |
28d06664 | 205 | def _got354(self, pieces): |
14011220 | 206 | qt = int(pieces[3]) |
207 | if qt < 3: | |
208 | nick, auth = pieces[4:6] | |
209 | chan = None | |
210 | else: | |
211 | chan, nick, auth = pieces[4:7] | |
212 | chan = self.parent.channel(chan) | |
e40e5b39 | 213 | user = self.parent.user(nick) |
214 | user.authed(auth) | |
14011220 | 215 | |
216 | if chan is not None: | |
217 | user.join(chan) | |
218 | chan.userjoin(user) | |
219 | ||
220 | if qt == 2: # triggered by !auth | |
e40e5b39 | 221 | if user.isauthed(): |
222 | if user.glevel > 0: | |
223 | self.msg(nick, "You are now known as #%s (access level: %s)" % (auth, user.glevel)) | |
224 | else: | |
225 | self.msg(nick, "You are now known as #%s (not staff)" % (auth)) | |
226 | else: | |
227 | self.msg(nick, "I tried, but you're not authed!") | |
0784e720 | 228 | def _got433(self, pieces): |
229 | if not self.conn.registered(): #we're trying to connect | |
71ef8273 | 230 | newnick = "%s%d" % (self.nick, random.randint(111, 999)) |
0784e720 | 231 | self.conn.send("NICK %s" % (newnick)) |
232 | self.nick = newnick | |
28d06664 | 233 | def _gotjoin(self, pieces): |
234 | nick = pieces[0].split('!')[0][1:] | |
235 | chan = self.parent.channel(pieces[2]) | |
236 | ||
237 | if nick == self.nick: | |
14011220 | 238 | self.conn.send("WHO %s c%%cant,3" % (chan)) |
28d06664 | 239 | else: |
f6386fa7 | 240 | user = self.parent.user(nick, send_who=True) |
28d06664 | 241 | chan.userjoin(user) |
242 | user.join(chan) | |
6de27fd4 | 243 | def _clientLeft(self, nick, chan): |
f6386fa7 JR |
244 | if nick == self.nick: |
245 | for u in chan.users: | |
246 | if u.nick != self.nick: | |
247 | self._clientLeft(u.nick, chan) | |
248 | else: | |
249 | user = self.parent.user(nick) | |
250 | gone = user.part(chan) | |
251 | chan.userpart(user) | |
14011220 | 252 | if gone: |
f6386fa7 | 253 | user.quit() |
14011220 | 254 | del self.parent.users[nick.lower()] |
6de27fd4 | 255 | def _gotpart(self, pieces): |
256 | nick = pieces[0].split('!')[0][1:] | |
257 | chan = self.parent.channel(pieces[2]) | |
258 | self._clientLeft(nick, chan) | |
259 | def _gotkick(self, pieces): | |
260 | nick = pieces[3] | |
261 | chan = self.parent.channel(pieces[2]) | |
262 | self._clientLeft(nick, chan) | |
28d06664 | 263 | def _gotquit(self, pieces): |
264 | nick = pieces[0].split('!')[0][1:] | |
265 | if nick != self.nick: | |
14011220 | 266 | for chan in self.parent.user(nick).chans: |
267 | chan.userpart(self.parent.user(nick)) | |
28d06664 | 268 | self.parent.user(nick).quit() |
269 | del self.parent.users[nick.lower()] | |
270 | def _gotnick(self, pieces): | |
271 | oldnick = pieces[0].split('!')[0][1:] | |
272 | newnick = pieces[2][1:] | |
f89262c4 | 273 | if oldnick == self.nick: |
274 | self.nick = newnick | |
275 | else: | |
276 | if newnick.lower() != oldnick.lower(): | |
277 | self.parent.users[newnick.lower()] = self.parent.users[oldnick.lower()] | |
278 | del self.parent.users[oldnick.lower()] | |
279 | self.parent.users[newnick.lower()].nickchange(newnick) | |
84b7c247 | 280 | def _gotmode(self, pieces): |
281 | source = pieces[0].split('!')[0][1:] | |
fe73f782 | 282 | chan = pieces[2] |
283 | if not chan.startswith("#"): return | |
84b7c247 | 284 | chan = self.parent.channel(pieces[2]) |
285 | mode = pieces[3] | |
286 | args = pieces[4:] | |
287 | ||
288 | adding = True | |
289 | for c in mode: | |
290 | if c == '+': | |
291 | adding = True | |
292 | elif c == '-': | |
293 | adding = False | |
294 | elif c == 'o': | |
295 | if adding: | |
296 | chan.userop(self.parent.user(args.pop(0))) | |
297 | else: | |
298 | chan.userdeop(self.parent.user(args.pop(0))) | |
299 | elif c == 'v': | |
300 | if adding: | |
301 | chan.uservoice(self.parent.user(args.pop(0))) | |
302 | else: | |
303 | chan.userdevoice(self.parent.user(args.pop(0))) | |
304 | else: | |
305 | pass # don't care about other modes | |
b6212f14 | 306 | |
e8885384 JR |
307 | def _cbexception(self, source, *args, chained=False, **kwargs): |
308 | if not chained: # skip hooks if we were caused by a hook | |
309 | exc = sys.exception() | |
310 | if self.parent.hasexceptionhook(exc): | |
311 | for callback in self.parent.getexceptionhook(exc): | |
312 | try: | |
313 | callback(self, exc, source, *args, **kwargs) | |
314 | except Exception: | |
315 | self._cbexception('exceptionhook', chained=True, module=callback.__module__, function=callback.__name__, underlying=(source, args, kwargs)) | |
6b6f9624 | 316 | if self.parent.cfg.getboolean('debug', 'cbexc'): |
f59f8c9b | 317 | self.conn.send("PRIVMSG %s :%09.3f \ 34\1f!!! CBEXC\1f\ 3 %s" % (self.parent.cfg.get('debug', 'owner'), time.time() % 100000, source)) |
e8885384 | 318 | traceback.print_exc(chain=not chained) |
a8553c45 | 319 | self.log('!', "CBEXC %s %r %r" % (source, args, kwargs)) |
3d724d3a | 320 | |
321 | ||
839d2b35 | 322 | def parsemsg(self, user, target, msg): |
83c2f201 | 323 | if user.glevel <= -2: return # short circuit if user is IGNORED |
839d2b35 | 324 | chan = None |
6de27fd4 | 325 | chanparam = None # was the channel specified as part of the command? |
877cd61d | 326 | if len(msg) == 0: |
327 | return | |
328 | ||
8545c1b1 JR |
329 | if target == self.nick and msg.startswith("\001"): #ctcp |
330 | msg = msg.strip("\001") | |
331 | if msg: | |
332 | pieces = msg.split() | |
333 | if pieces[0] == "CLIENTINFO": | |
334 | self.msg(user, "\001CLIENTINFO VERSION PING\001") | |
335 | elif pieces[0] == "VERSION": | |
336 | self.msg(user, "\001VERSION Erebus v%d.%d - http://jfr.im/git/erebus.git\001" % (self.parent.APIVERSION, self.parent.RELEASE)) | |
337 | elif pieces[0] == "PING": | |
338 | if len(pieces) > 1: | |
339 | self.msg(user, "\001PING %s\001" % (' '.join(pieces[1:]))) | |
340 | else: | |
341 | self.msg(user, "\001PING\001") | |
342 | return | |
6de27fd4 | 343 | |
10b86b56 | 344 | triggerused = msg.startswith(self.parent.trigger) |
345 | if triggerused: msg = msg[len(self.parent.trigger):] | |
346 | pieces = msg.split() | |
347 | ||
3296dba1 | 348 | if len(pieces) == 0: |
349 | return | |
350 | ||
6de27fd4 | 351 | if target != self.nick: # message was sent to a channel |
90b64dc0 | 352 | try: |
3296dba1 | 353 | if pieces[0][:-1].lower() == self.nick.lower() and (pieces[0][-1] == ":" or pieces[0][-1] == ","): |
354 | pieces.pop(0) # command actually starts with next word | |
355 | if len(pieces) == 0: # is there still anything left? | |
356 | return | |
357 | msg = ' '.join(pieces) | |
358 | triggerused = True | |
90b64dc0 | 359 | except IndexError: |
a76c4bd8 | 360 | return # "message" is empty |
839d2b35 | 361 | |
827ec8f0 | 362 | if len(pieces) > 1: |
363 | chanword = pieces[1] | |
364 | if chanword.startswith('#'): | |
365 | chanparam = self.parent.channel(chanword) | |
366 | ||
367 | if target != self.nick: # message was sent to a channel | |
368 | chan = self.parent.channel(target) | |
369 | if not triggerused: | |
370 | if self.parent.haschanhook(target.lower()): | |
371 | for callback in self.parent.getchanhook(target.lower()): | |
372 | try: | |
373 | cbret = callback(self, user, chan, *pieces) | |
f89262c4 | 374 | if isinstance(cbret, stringbase): |
375 | self.reply(target, user, cbret) | |
827ec8f0 | 376 | except: |
377 | self.msg(user, "Command failed. Code: CBEXC%09.3f" % (time.time() % 100000)) | |
e8885384 | 378 | self._cbexception("chanhook", user=user, target=target, msg=msg) |
827ec8f0 | 379 | return # not to bot, don't process! |
380 | ||
db50981b | 381 | cmd = pieces[0].lower() |
6de27fd4 | 382 | rancmd = False |
db50981b | 383 | if self.parent.hashook(cmd): |
e4a4c762 | 384 | for callback in self.parent.gethook(cmd): |
827ec8f0 | 385 | if chanparam is not None and (callback.needchan or callback.wantchan): |
6de27fd4 | 386 | chan = chanparam |
387 | pieces.pop(1) | |
e4a4c762 | 388 | if chan is None and callback.needchan: |
6de27fd4 | 389 | rancmd = True |
e4a4c762 | 390 | self.msg(user, "You need to specify a channel for that command.") |
586997a7 | 391 | elif user.glevel >= callback.reqglevel and (not callback.needchan or chan.levelof(user.auth) >= callback.reqclevel): |
6de27fd4 | 392 | rancmd = True |
3d724d3a | 393 | try: |
394 | cbret = callback(self, user, chan, target, *pieces[1:]) | |
f89262c4 | 395 | if isinstance(cbret, stringbase): |
f2b6e85c | 396 | self.reply(target, user, cbret) |
3d724d3a | 397 | except Exception: |
398 | self.msg(user, "Command failed. Code: CBEXC%09.3f" % (time.time() % 100000)) | |
e8885384 | 399 | self._cbexception("hook", user=user, target=target, msg=msg) |
e40e5b39 | 400 | except SystemExit as e: |
2a44c0cd | 401 | self.parent.mustquit = e |
2729abc8 | 402 | try: |
403 | curs = self.parent.query("UPDATE bots SET connected = 0") | |
404 | curs.close() | |
405 | except: pass | |
e40e5b39 | 406 | raise e |
32b160dc | 407 | else: |
6de27fd4 | 408 | rancmd = True |
32b160dc | 409 | self.msg(user, "I don't know that command.") |
6de27fd4 | 410 | if not rancmd: |
411 | self.msg(user, "You don't have enough access to run that command.") | |
3d724d3a | 412 | |
413 | def __debug_nomsg(self, target, msg): | |
6b6f9624 | 414 | if self.parent.cfg.getboolean('debug', 'nomsg'): |
f59f8c9b | 415 | 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)) |
a8553c45 | 416 | self.log('!', "!!! NOMSG") |
417 | # print "%09.3f %s [!] %s" % (time.time() % 100000, self.nick, "!!! NOMSG") | |
e8885384 | 418 | traceback.print_stack() |
49a455aa | 419 | |
d6052ebf | 420 | |
421 | def reply(self, chan, user, msg): | |
f2b6e85c | 422 | if chan is not None and (isinstance(chan, self.parent.Channel) or (isinstance(chan, stringbase) and chan[0] == "#")): |
d6052ebf | 423 | self.msg(chan, "%s: %s" % (user, msg)) |
424 | else: | |
425 | self.msg(user, msg) | |
426 | ||
6f6d04b5 JR |
427 | """ |
428 | Does the work for msg/slowmsg/fastmsg. Uses the append_callback to append to the correct queue. | |
429 | ||
430 | 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. | |
431 | """ | |
e669bde0 | 432 | def _msg(self, target, msg, truncate, append_callback, msgtype): |
a9ba1edc | 433 | if self.parent.cfg.getboolean('erebus', 'nofakelag'): append_callback = self.conn.send |
6f6d04b5 | 434 | |
e669bde0 | 435 | cmd = self._formatmsg(target, msg, msgtype) |
a9a00d34 | 436 | # The max length is much shorter than conn.maxlen (510) because of the length the server adds on about the source (us). |
992876fb | 437 | # If you know your hostmask, you can of course figure the exact length, but it's very difficult to reliably know your hostmask. |
a9a00d34 | 438 | maxlen = self.maxmsglen() |
992876fb | 439 | if len(cmd) > maxlen: |
4d925ae3 | 440 | if not truncate: |
441 | return False | |
442 | else: | |
992876fb | 443 | cmd = cmd[:maxlen] |
6f6d04b5 | 444 | |
c6e6807f | 445 | if self.conn.exceeded or self.conn.bytessent+len(cmd) >= self.conn.recvq: |
6f6d04b5 | 446 | append_callback(cmd) |
c6e6807f | 447 | else: |
448 | self.conn.send(cmd) | |
6f6d04b5 | 449 | |
c6e6807f | 450 | self.conn.exceeded = True |
656dc5a4 | 451 | return True |
e64ac4a0 | 452 | |
e669bde0 JR |
453 | def msg(self, target, msg, truncate=False, *, msgtype=None): |
454 | """msgtype must be a valid IRC command, i.e. NOTICE or PRIVMSG; or leave as None to use default""" | |
455 | return self._msg(target, msg, truncate, self.msgqueue.append, msgtype) | |
6f6d04b5 | 456 | |
e669bde0 JR |
457 | def slowmsg(self, target, msg, truncate=False, *, msgtype=None): |
458 | return self._msg(target, msg, truncate, self.slowmsgqueue.append, msgtype) | |
2bb267e0 | 459 | |
e669bde0 JR |
460 | def fastmsg(self, target, msg, truncate=False, *, msgtype=None): |
461 | return self._msg(target, msg, truncate, self.conn.send, msgtype) | |
c6e6807f | 462 | |
e669bde0 | 463 | def _formatmsg(self, target, msg, msgtype): |
3d724d3a | 464 | if target is None or msg is None: |
28d06664 | 465 | return self.__debug_nomsg(target, msg) |
3d724d3a | 466 | |
6681579e | 467 | target = str(target) |
e64ac4a0 | 468 | |
e669bde0 JR |
469 | if msgtype is not None: command = "%s %s :%s" % (msgtype, target, msg) |
470 | elif target.startswith('#'): command = "PRIVMSG %s :%s" % (target, msg) | |
e64ac4a0 | 471 | else: command = "NOTICE %s :%s" % (target, msg) |
472 | ||
c6e6807f | 473 | return command |
e64ac4a0 | 474 | |
475 | def _popmsg(self): | |
82025c0a | 476 | self._makemsgtimer() |
c6e6807f | 477 | self.conn.bytessent -= self.conn.recvq/3 |
478 | if self.conn.bytessent < 0: self.conn.bytessent = 0 | |
82025c0a | 479 | self.conn.exceeded = True |
e64ac4a0 | 480 | |
82025c0a | 481 | cmd = None |
e64ac4a0 | 482 | try: |
c6e6807f | 483 | cmd = self.msgqueue.popleft() |
2bb267e0 | 484 | except IndexError: |
485 | try: | |
c6e6807f | 486 | cmd = self.slowmsgqueue.popleft() |
2bb267e0 | 487 | except IndexError: |
488 | pass | |
e64ac4a0 | 489 | |
82025c0a JR |
490 | if cmd is not None: |
491 | if self.conn.bytessent+len(cmd) > self.conn.recvq: # If it's too long | |
492 | if len(cmd) > self.conn.recvq: # Is the command itself somehow over max length??? | |
493 | self._msgtimer.start() | |
494 | raise ValueError('Somehow a command that was too long made it into the message queue. Uhoh!', cmd) | |
495 | # Discard the message. | |
496 | self.msgqueue.appendleft(cmd) # Phew, we've just sent too much recently. Put it (back) on the (primary) queue. | |
497 | else: | |
498 | self.conn.send(cmd) | |
499 | ||
500 | self._msgtimer.start() | |
501 | ||
502 | def _makemsgtimer(self): | |
503 | self._msgtimer = MyTimer(3, self._popmsg) | |
a4eacae2 | 504 | |
49a455aa | 505 | def join(self, chan): |
506 | self.conn.send("JOIN %s" % (chan)) | |
a4eacae2 | 507 | |
49a455aa | 508 | def part(self, chan): |
509 | self.conn.send("PART %s" % (chan)) | |
a4eacae2 | 510 | |
49a455aa | 511 | def quit(self, reason="Shutdown"): |
512 | self.conn.send("QUIT :%s" % (reason)) | |
b25d4368 | 513 | |
a9a00d34 JR |
514 | def maxmsglen(self): |
515 | return ( | |
516 | self.maxlen | |
517 | - 63 # max hostname len | |
518 | - 11 # max ident len | |
519 | - 3 # the symbols in :nick!user@host | |
520 | - len(self.nick) | |
521 | ) | |
522 | ||
a12f7519 | 523 | def __str__(self): return self.nick |
524 | def __repr__(self): return "<Bot %r>" % (self.nick) | |
525 | ||
b25d4368 | 526 | class BotConnection(object): |
a12f7519 | 527 | def __init__(self, parent, bind, server, port): |
b25d4368 | 528 | self.parent = parent |
49601f9d | 529 | self.buffer = bytearray() |
b25d4368 | 530 | self.socket = None |
531 | ||
b25d4368 | 532 | self.bind = bind |
533 | self.server = server | |
534 | self.port = int(port) | |
b25d4368 | 535 | |
7631844f | 536 | self.state = 0 # 0=disconnected, 1=registering, 2=connected |
537 | ||
c6e6807f | 538 | self.bytessent = 0 |
a9a00d34 | 539 | self.recvq = 510 # How much we can send per period |
c6e6807f | 540 | self.exceeded = False |
f2b6e85c | 541 | self._nowrite = False |
c6e6807f | 542 | |
b25d4368 | 543 | def connect(self): |
ab9f6124 | 544 | if self.parent.parent.cfg.getboolean('erebus', 'tls'): |
4c10a7da JR |
545 | import ssl |
546 | undersocket = socket.socket(socket.AF_INET, socket.SOCK_STREAM) | |
547 | context = ssl.create_default_context() | |
ab9f6124 | 548 | self.socket = context.wrap_socket(undersocket, server_hostname=self.server) |
4c10a7da JR |
549 | else: |
550 | self.socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM) | |
68dff4aa JR |
551 | 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. |
552 | self.socket.setsockopt(socket.SOL_SOCKET, socket.SO_LINGER, struct.pack('ii', 0, 0)) | |
553 | self.socket.setsockopt(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1) | |
b25d4368 | 554 | self.socket.bind((self.bind, 0)) |
555 | self.socket.connect((self.server, self.port)) | |
d1ea2946 | 556 | return True |
557 | def register(self): | |
558 | if self.state == 0: | |
559 | self.send("NICK %s" % (self.parent.nick)) | |
560 | self.send("USER %s 0 * :%s" % (self.parent.user, self.parent.realname)) | |
561 | self.state = 1 | |
49a455aa | 562 | return True |
b25d4368 | 563 | |
564 | def registered(self, done=False): | |
565 | if done: self.state = 2 | |
566 | return self.state == 2 | |
567 | ||
b25d4368 | 568 | def send(self, line): |
f2b6e85c | 569 | if not self._nowrite: |
570 | if self.parent.parent.cfg.getboolean('debug', 'io'): | |
571 | self.parent.log('O', line) | |
572 | self.bytessent += len(line) | |
573 | try: | |
574 | self._write(line) | |
575 | except socket.error as e: | |
576 | self._nowrite = True | |
577 | self.parent._goterror(repr(e)) | |
578 | else: | |
579 | if self.parent.parent.cfg.getboolean('debug', 'io'): | |
580 | self.parent.log('X', line) | |
a4eacae2 | 581 | |
7631844f | 582 | def _write(self, line): |
a28e2ae9 | 583 | self.socket.sendall(line.encode('utf-8', 'backslashreplace')+b"\r\n") |
a4eacae2 | 584 | |
b736b336 JR |
585 | def _getsockerr(self): |
586 | try: # SO_ERROR might not exist on all platforms | |
587 | return self.socket.getsockopt(socket.SOL_SOCKET, socket.SO_ERROR) | |
588 | except: | |
589 | return None | |
590 | ||
b25d4368 | 591 | def read(self): |
b8150e3d | 592 | recvd = self.socket.recv(8192) |
b736b336 JR |
593 | if recvd == b"": |
594 | raise EOFError("socket.recv returned empty", self.parent.nick, self._getsockerr()) | |
b8150e3d | 595 | self.buffer += recvd |
b25d4368 | 596 | lines = [] |
a4eacae2 | 597 | |
a28e2ae9 | 598 | while b"\r\n" in self.buffer: |
599 | pieces = self.buffer.split(b"\r\n", 1) | |
600 | lines.append(pieces[0].decode('utf-8', 'backslashreplace')) | |
b25d4368 | 601 | self.buffer = pieces[1] |
a4eacae2 | 602 | |
b25d4368 | 603 | return lines |
a12f7519 | 604 | |
28d06664 | 605 | def __str__(self): return self.parent.nick |
a12f7519 | 606 | def __repr__(self): return "<BotConnection %r (%r)>" % (self.socket.fileno(), self.parent.nick) |