]>
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 | ||
68dff4aa | 7 | import socket, sys, time, threading, os, random, struct |
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): |
b25d4368 | 30 | self.parent = parent |
31 | self.nick = nick | |
0784e720 | 32 | self.permnick = nick |
a12f7519 | 33 | self.user = user |
34 | self.realname = realname | |
5477b368 | 35 | |
0af282c6 | 36 | self.authname = authname |
37 | self.authpass = authpass | |
38 | ||
1e76e96c JR |
39 | self.connecttime = 0 # time at which we received numeric 001 |
40 | self.server = server # the address we try to (re-)connect to | |
41 | self.port = port | |
42 | self.servername = server # the name of the server we got connected to | |
43 | ||
50331d1a | 44 | curs = self.parent.query("SELECT chname FROM chans WHERE bot = %s AND active = 1", (self.permnick,)) |
2729abc8 | 45 | if curs: |
4fa1118b | 46 | chansres = curs.fetchall() |
47 | curs.close() | |
48 | self.chans = [self.parent.newchannel(self, row['chname']) for row in chansres] | |
6de27fd4 | 49 | else: |
50 | self.chans = [] | |
b25d4368 | 51 | |
a12f7519 | 52 | self.conn = BotConnection(self, bind, server, port) |
e64ac4a0 | 53 | |
2ffa3996 | 54 | self.lastreceived = time.time() #time we last received a line from the server |
d6c6516c | 55 | self.watchdog() |
2ffa3996 | 56 | |
e64ac4a0 | 57 | self.msgqueue = deque() |
2bb267e0 | 58 | self.slowmsgqueue = deque() |
82025c0a JR |
59 | self._makemsgtimer() |
60 | self._msgtimer.start() | |
04fe7fd8 | 61 | self.joined_chans = False |
e64ac4a0 | 62 | |
e40e5b39 | 63 | def __del__(self): |
2729abc8 | 64 | try: |
50331d1a | 65 | curs = self.parent.query("UPDATE bots SET connected = 0 WHERE nick = %s", (self.permnick,)) |
2729abc8 | 66 | curs.close() |
67 | except: pass | |
e40e5b39 | 68 | |
2ffa3996 | 69 | def watchdog(self): |
b8150e3d | 70 | if time.time() > int(self.parent.cfg.get('watchdog', 'maxtime', default=300))+self.lastreceived: |
2ffa3996 | 71 | self.parse("ERROR :Fake-error from watchdog timer.") |
b8150e3d JR |
72 | if self.conn.registered(): |
73 | self.conn.send("PING :%s" % (time.time())) | |
a46d97d3 | 74 | self._checknick() |
2a44c0cd JR |
75 | watchdogtimer = MyTimer(int(self.parent.cfg.get('watchdog', 'interval', default=30)), self.watchdog) |
76 | watchdogtimer.start() | |
e64ac4a0 | 77 | |
a8553c45 | 78 | def log(self, *args, **kwargs): |
79 | self.parent.log(self.nick, *args, **kwargs) | |
80 | ||
b25d4368 | 81 | def connect(self): |
d3531ad2 | 82 | self.log('!', "Connecting") |
b2a896c8 | 83 | if self.conn.connect(): |
b736b336 | 84 | self.log('!', "Connected") |
49a455aa | 85 | self.parent.newfd(self, self.conn.socket.fileno()) |
86 | ||
b25d4368 | 87 | def getdata(self): |
b8150e3d JR |
88 | try: |
89 | recvd = self.conn.read() | |
90 | self.lastreceived = time.time() | |
91 | return recvd | |
92 | except EOFError as e: | |
b736b336 | 93 | return [":%s ERROR :%s%r" % (self.nick, e.__class__.__name__, e.args)] |
a4eacae2 | 94 | |
0784e720 | 95 | def _checknick(self): # check if we're using the right nick, try changing |
96 | if self.nick != self.permnick and self.conn.registered(): | |
97 | self.conn.send("NICK %s" % (self.permnick)) | |
98 | ||
b25d4368 | 99 | def parse(self, line): |
6b6f9624 | 100 | if self.parent.cfg.getboolean('debug', 'io'): |
101 | self.log('I', line) | |
b25d4368 | 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: | |
137 | self.__debug_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: |
240 | user = self.parent.user(nick, justjoined=True) | |
241 | chan.userjoin(user) | |
242 | user.join(chan) | |
6de27fd4 | 243 | def _clientLeft(self, nick, chan): |
28d06664 | 244 | if nick != self.nick: |
14011220 | 245 | gone = self.parent.user(nick).part(chan) |
28d06664 | 246 | chan.userpart(self.parent.user(nick)) |
14011220 | 247 | if gone: |
248 | self.parent.user(nick).quit() | |
249 | del self.parent.users[nick.lower()] | |
6de27fd4 | 250 | def _gotpart(self, pieces): |
251 | nick = pieces[0].split('!')[0][1:] | |
252 | chan = self.parent.channel(pieces[2]) | |
253 | self._clientLeft(nick, chan) | |
254 | def _gotkick(self, pieces): | |
255 | nick = pieces[3] | |
256 | chan = self.parent.channel(pieces[2]) | |
257 | self._clientLeft(nick, chan) | |
28d06664 | 258 | def _gotquit(self, pieces): |
259 | nick = pieces[0].split('!')[0][1:] | |
260 | if nick != self.nick: | |
14011220 | 261 | for chan in self.parent.user(nick).chans: |
262 | chan.userpart(self.parent.user(nick)) | |
28d06664 | 263 | self.parent.user(nick).quit() |
264 | del self.parent.users[nick.lower()] | |
265 | def _gotnick(self, pieces): | |
266 | oldnick = pieces[0].split('!')[0][1:] | |
267 | newnick = pieces[2][1:] | |
f89262c4 | 268 | if oldnick == self.nick: |
269 | self.nick = newnick | |
270 | else: | |
271 | if newnick.lower() != oldnick.lower(): | |
272 | self.parent.users[newnick.lower()] = self.parent.users[oldnick.lower()] | |
273 | del self.parent.users[oldnick.lower()] | |
274 | self.parent.users[newnick.lower()].nickchange(newnick) | |
84b7c247 | 275 | def _gotmode(self, pieces): |
276 | source = pieces[0].split('!')[0][1:] | |
fe73f782 | 277 | chan = pieces[2] |
278 | if not chan.startswith("#"): return | |
84b7c247 | 279 | chan = self.parent.channel(pieces[2]) |
280 | mode = pieces[3] | |
281 | args = pieces[4:] | |
282 | ||
283 | adding = True | |
284 | for c in mode: | |
285 | if c == '+': | |
286 | adding = True | |
287 | elif c == '-': | |
288 | adding = False | |
289 | elif c == 'o': | |
290 | if adding: | |
291 | chan.userop(self.parent.user(args.pop(0))) | |
292 | else: | |
293 | chan.userdeop(self.parent.user(args.pop(0))) | |
294 | elif c == 'v': | |
295 | if adding: | |
296 | chan.uservoice(self.parent.user(args.pop(0))) | |
297 | else: | |
298 | chan.userdevoice(self.parent.user(args.pop(0))) | |
299 | else: | |
300 | pass # don't care about other modes | |
b6212f14 | 301 | |
a38e8be0 | 302 | def __debug_cbexception(self, source, *args, **kwargs): |
6b6f9624 | 303 | if self.parent.cfg.getboolean('debug', 'cbexc'): |
f59f8c9b | 304 | self.conn.send("PRIVMSG %s :%09.3f \ 34\1f!!! CBEXC\1f\ 3 %s" % (self.parent.cfg.get('debug', 'owner'), time.time() % 100000, source)) |
3d724d3a | 305 | __import__('traceback').print_exc() |
a8553c45 | 306 | self.log('!', "CBEXC %s %r %r" % (source, args, kwargs)) |
307 | # print "%09.3f %s [!] CBEXC %s %r %r" % (time.time() % 100000, self.nick, source, args, kwargs) | |
3d724d3a | 308 | |
309 | ||
839d2b35 | 310 | def parsemsg(self, user, target, msg): |
83c2f201 | 311 | if user.glevel <= -2: return # short circuit if user is IGNORED |
839d2b35 | 312 | chan = None |
6de27fd4 | 313 | chanparam = None # was the channel specified as part of the command? |
877cd61d | 314 | if len(msg) == 0: |
315 | return | |
316 | ||
839d2b35 | 317 | if target == self.nick: |
fd07173d | 318 | if msg.startswith("\001"): #ctcp |
a76c4bd8 | 319 | msg = msg.strip("\001") |
320 | if msg == "VERSION": | |
96afd8ed | 321 | self.msg(user, "\001VERSION Erebus v%d.%d - http://jfr.im/git/erebus.git" % (self.parent.APIVERSION, self.parent.RELEASE)) |
a76c4bd8 | 322 | return |
6de27fd4 | 323 | |
10b86b56 | 324 | triggerused = msg.startswith(self.parent.trigger) |
325 | if triggerused: msg = msg[len(self.parent.trigger):] | |
326 | pieces = msg.split() | |
327 | ||
3296dba1 | 328 | if len(pieces) == 0: |
329 | return | |
330 | ||
6de27fd4 | 331 | if target != self.nick: # message was sent to a channel |
90b64dc0 | 332 | try: |
3296dba1 | 333 | if pieces[0][:-1].lower() == self.nick.lower() and (pieces[0][-1] == ":" or pieces[0][-1] == ","): |
334 | pieces.pop(0) # command actually starts with next word | |
335 | if len(pieces) == 0: # is there still anything left? | |
336 | return | |
337 | msg = ' '.join(pieces) | |
338 | triggerused = True | |
90b64dc0 | 339 | except IndexError: |
a76c4bd8 | 340 | return # "message" is empty |
839d2b35 | 341 | |
827ec8f0 | 342 | if len(pieces) > 1: |
343 | chanword = pieces[1] | |
344 | if chanword.startswith('#'): | |
345 | chanparam = self.parent.channel(chanword) | |
346 | ||
347 | if target != self.nick: # message was sent to a channel | |
348 | chan = self.parent.channel(target) | |
349 | if not triggerused: | |
350 | if self.parent.haschanhook(target.lower()): | |
351 | for callback in self.parent.getchanhook(target.lower()): | |
352 | try: | |
353 | cbret = callback(self, user, chan, *pieces) | |
f89262c4 | 354 | if isinstance(cbret, stringbase): |
355 | self.reply(target, user, cbret) | |
827ec8f0 | 356 | except: |
357 | self.msg(user, "Command failed. Code: CBEXC%09.3f" % (time.time() % 100000)) | |
358 | self.__debug_cbexception("chanhook", user=user, target=target, msg=msg) | |
359 | return # not to bot, don't process! | |
360 | ||
db50981b | 361 | cmd = pieces[0].lower() |
6de27fd4 | 362 | rancmd = False |
db50981b | 363 | if self.parent.hashook(cmd): |
e4a4c762 | 364 | for callback in self.parent.gethook(cmd): |
827ec8f0 | 365 | if chanparam is not None and (callback.needchan or callback.wantchan): |
6de27fd4 | 366 | chan = chanparam |
367 | pieces.pop(1) | |
e4a4c762 | 368 | if chan is None and callback.needchan: |
6de27fd4 | 369 | rancmd = True |
e4a4c762 | 370 | self.msg(user, "You need to specify a channel for that command.") |
586997a7 | 371 | elif user.glevel >= callback.reqglevel and (not callback.needchan or chan.levelof(user.auth) >= callback.reqclevel): |
6de27fd4 | 372 | rancmd = True |
3d724d3a | 373 | try: |
374 | cbret = callback(self, user, chan, target, *pieces[1:]) | |
f89262c4 | 375 | if isinstance(cbret, stringbase): |
f2b6e85c | 376 | self.reply(target, user, cbret) |
3d724d3a | 377 | except Exception: |
378 | self.msg(user, "Command failed. Code: CBEXC%09.3f" % (time.time() % 100000)) | |
a38e8be0 | 379 | self.__debug_cbexception("hook", user=user, target=target, msg=msg) |
e40e5b39 | 380 | except SystemExit as e: |
2a44c0cd | 381 | self.parent.mustquit = e |
2729abc8 | 382 | try: |
383 | curs = self.parent.query("UPDATE bots SET connected = 0") | |
384 | curs.close() | |
385 | except: pass | |
e40e5b39 | 386 | raise e |
32b160dc | 387 | else: |
6de27fd4 | 388 | rancmd = True |
32b160dc | 389 | self.msg(user, "I don't know that command.") |
6de27fd4 | 390 | if not rancmd: |
391 | self.msg(user, "You don't have enough access to run that command.") | |
3d724d3a | 392 | |
393 | def __debug_nomsg(self, target, msg): | |
6b6f9624 | 394 | if self.parent.cfg.getboolean('debug', 'nomsg'): |
f59f8c9b | 395 | 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 | 396 | self.log('!', "!!! NOMSG") |
397 | # print "%09.3f %s [!] %s" % (time.time() % 100000, self.nick, "!!! NOMSG") | |
3d724d3a | 398 | __import__('traceback').print_stack() |
49a455aa | 399 | |
d6052ebf | 400 | |
401 | def reply(self, chan, user, msg): | |
f2b6e85c | 402 | if chan is not None and (isinstance(chan, self.parent.Channel) or (isinstance(chan, stringbase) and chan[0] == "#")): |
d6052ebf | 403 | self.msg(chan, "%s: %s" % (user, msg)) |
404 | else: | |
405 | self.msg(user, msg) | |
406 | ||
6f6d04b5 JR |
407 | """ |
408 | Does the work for msg/slowmsg/fastmsg. Uses the append_callback to append to the correct queue. | |
409 | ||
410 | 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. | |
411 | """ | |
e669bde0 | 412 | def _msg(self, target, msg, truncate, append_callback, msgtype): |
a9ba1edc | 413 | if self.parent.cfg.getboolean('erebus', 'nofakelag'): append_callback = self.conn.send |
6f6d04b5 | 414 | |
e669bde0 | 415 | cmd = self._formatmsg(target, msg, msgtype) |
992876fb JR |
416 | # The max length is much shorter than recvq (510) because of the length the server adds on about the source (us). |
417 | # If you know your hostmask, you can of course figure the exact length, but it's very difficult to reliably know your hostmask. | |
418 | maxlen = ( | |
419 | self.conn.recvq | |
420 | - 63 # max hostname len | |
421 | - 11 # max ident len | |
422 | - 3 # the symbols in :nick!user@host | |
423 | - len(self.nick) | |
424 | ) | |
425 | if len(cmd) > maxlen: | |
4d925ae3 | 426 | if not truncate: |
427 | return False | |
428 | else: | |
992876fb | 429 | cmd = cmd[:maxlen] |
6f6d04b5 | 430 | |
c6e6807f | 431 | if self.conn.exceeded or self.conn.bytessent+len(cmd) >= self.conn.recvq: |
6f6d04b5 | 432 | append_callback(cmd) |
c6e6807f | 433 | else: |
434 | self.conn.send(cmd) | |
6f6d04b5 | 435 | |
c6e6807f | 436 | self.conn.exceeded = True |
656dc5a4 | 437 | return True |
e64ac4a0 | 438 | |
e669bde0 JR |
439 | def msg(self, target, msg, truncate=False, *, msgtype=None): |
440 | """msgtype must be a valid IRC command, i.e. NOTICE or PRIVMSG; or leave as None to use default""" | |
441 | return self._msg(target, msg, truncate, self.msgqueue.append, msgtype) | |
6f6d04b5 | 442 | |
e669bde0 JR |
443 | def slowmsg(self, target, msg, truncate=False, *, msgtype=None): |
444 | return self._msg(target, msg, truncate, self.slowmsgqueue.append, msgtype) | |
2bb267e0 | 445 | |
e669bde0 JR |
446 | def fastmsg(self, target, msg, truncate=False, *, msgtype=None): |
447 | return self._msg(target, msg, truncate, self.conn.send, msgtype) | |
c6e6807f | 448 | |
e669bde0 | 449 | def _formatmsg(self, target, msg, msgtype): |
3d724d3a | 450 | if target is None or msg is None: |
28d06664 | 451 | return self.__debug_nomsg(target, msg) |
3d724d3a | 452 | |
6681579e | 453 | target = str(target) |
e64ac4a0 | 454 | |
e669bde0 JR |
455 | if msgtype is not None: command = "%s %s :%s" % (msgtype, target, msg) |
456 | elif target.startswith('#'): command = "PRIVMSG %s :%s" % (target, msg) | |
e64ac4a0 | 457 | else: command = "NOTICE %s :%s" % (target, msg) |
458 | ||
c6e6807f | 459 | return command |
e64ac4a0 | 460 | |
461 | def _popmsg(self): | |
82025c0a | 462 | self._makemsgtimer() |
c6e6807f | 463 | self.conn.bytessent -= self.conn.recvq/3 |
464 | if self.conn.bytessent < 0: self.conn.bytessent = 0 | |
82025c0a | 465 | self.conn.exceeded = True |
e64ac4a0 | 466 | |
82025c0a | 467 | cmd = None |
e64ac4a0 | 468 | try: |
c6e6807f | 469 | cmd = self.msgqueue.popleft() |
2bb267e0 | 470 | except IndexError: |
471 | try: | |
c6e6807f | 472 | cmd = self.slowmsgqueue.popleft() |
2bb267e0 | 473 | except IndexError: |
474 | pass | |
e64ac4a0 | 475 | |
82025c0a JR |
476 | if cmd is not None: |
477 | if self.conn.bytessent+len(cmd) > self.conn.recvq: # If it's too long | |
478 | if len(cmd) > self.conn.recvq: # Is the command itself somehow over max length??? | |
479 | self._msgtimer.start() | |
480 | raise ValueError('Somehow a command that was too long made it into the message queue. Uhoh!', cmd) | |
481 | # Discard the message. | |
482 | self.msgqueue.appendleft(cmd) # Phew, we've just sent too much recently. Put it (back) on the (primary) queue. | |
483 | else: | |
484 | self.conn.send(cmd) | |
485 | ||
486 | self._msgtimer.start() | |
487 | ||
488 | def _makemsgtimer(self): | |
489 | self._msgtimer = MyTimer(3, self._popmsg) | |
a4eacae2 | 490 | |
49a455aa | 491 | def join(self, chan): |
492 | self.conn.send("JOIN %s" % (chan)) | |
a4eacae2 | 493 | |
49a455aa | 494 | def part(self, chan): |
495 | self.conn.send("PART %s" % (chan)) | |
a4eacae2 | 496 | |
49a455aa | 497 | def quit(self, reason="Shutdown"): |
498 | self.conn.send("QUIT :%s" % (reason)) | |
b25d4368 | 499 | |
a12f7519 | 500 | def __str__(self): return self.nick |
501 | def __repr__(self): return "<Bot %r>" % (self.nick) | |
502 | ||
b25d4368 | 503 | class BotConnection(object): |
a12f7519 | 504 | def __init__(self, parent, bind, server, port): |
b25d4368 | 505 | self.parent = parent |
49601f9d | 506 | self.buffer = bytearray() |
b25d4368 | 507 | self.socket = None |
508 | ||
b25d4368 | 509 | self.bind = bind |
510 | self.server = server | |
511 | self.port = int(port) | |
b25d4368 | 512 | |
7631844f | 513 | self.state = 0 # 0=disconnected, 1=registering, 2=connected |
514 | ||
c6e6807f | 515 | self.bytessent = 0 |
992876fb | 516 | self.recvq = 510 |
c6e6807f | 517 | self.exceeded = False |
f2b6e85c | 518 | self._nowrite = False |
c6e6807f | 519 | |
b25d4368 | 520 | def connect(self): |
ab9f6124 | 521 | if self.parent.parent.cfg.getboolean('erebus', 'tls'): |
4c10a7da JR |
522 | import ssl |
523 | undersocket = socket.socket(socket.AF_INET, socket.SOCK_STREAM) | |
524 | context = ssl.create_default_context() | |
ab9f6124 | 525 | self.socket = context.wrap_socket(undersocket, server_hostname=self.server) |
4c10a7da JR |
526 | else: |
527 | self.socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM) | |
68dff4aa JR |
528 | 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. |
529 | self.socket.setsockopt(socket.SOL_SOCKET, socket.SO_LINGER, struct.pack('ii', 0, 0)) | |
530 | self.socket.setsockopt(socket.SOL_SOCKET, socket.SO_KEEPALIVE, 1) | |
b25d4368 | 531 | self.socket.bind((self.bind, 0)) |
532 | self.socket.connect((self.server, self.port)) | |
d1ea2946 | 533 | return True |
534 | def register(self): | |
535 | if self.state == 0: | |
536 | self.send("NICK %s" % (self.parent.nick)) | |
537 | self.send("USER %s 0 * :%s" % (self.parent.user, self.parent.realname)) | |
538 | self.state = 1 | |
49a455aa | 539 | return True |
b25d4368 | 540 | |
541 | def registered(self, done=False): | |
542 | if done: self.state = 2 | |
543 | return self.state == 2 | |
544 | ||
b25d4368 | 545 | def send(self, line): |
f2b6e85c | 546 | if not self._nowrite: |
547 | if self.parent.parent.cfg.getboolean('debug', 'io'): | |
548 | self.parent.log('O', line) | |
549 | self.bytessent += len(line) | |
550 | try: | |
551 | self._write(line) | |
552 | except socket.error as e: | |
553 | self._nowrite = True | |
554 | self.parent._goterror(repr(e)) | |
555 | else: | |
556 | if self.parent.parent.cfg.getboolean('debug', 'io'): | |
557 | self.parent.log('X', line) | |
a4eacae2 | 558 | |
7631844f | 559 | def _write(self, line): |
a28e2ae9 | 560 | self.socket.sendall(line.encode('utf-8', 'backslashreplace')+b"\r\n") |
a4eacae2 | 561 | |
b736b336 JR |
562 | def _getsockerr(self): |
563 | try: # SO_ERROR might not exist on all platforms | |
564 | return self.socket.getsockopt(socket.SOL_SOCKET, socket.SO_ERROR) | |
565 | except: | |
566 | return None | |
567 | ||
b25d4368 | 568 | def read(self): |
b8150e3d | 569 | recvd = self.socket.recv(8192) |
b736b336 JR |
570 | if recvd == b"": |
571 | raise EOFError("socket.recv returned empty", self.parent.nick, self._getsockerr()) | |
b8150e3d | 572 | self.buffer += recvd |
b25d4368 | 573 | lines = [] |
a4eacae2 | 574 | |
a28e2ae9 | 575 | while b"\r\n" in self.buffer: |
576 | pieces = self.buffer.split(b"\r\n", 1) | |
577 | lines.append(pieces[0].decode('utf-8', 'backslashreplace')) | |
b25d4368 | 578 | self.buffer = pieces[1] |
a4eacae2 | 579 | |
b25d4368 | 580 | return lines |
a12f7519 | 581 | |
28d06664 | 582 | def __str__(self): return self.parent.nick |
a12f7519 | 583 | def __repr__(self): return "<BotConnection %r (%r)>" % (self.socket.fileno(), self.parent.nick) |