]>
Commit | Line | Data |
---|---|---|
1 | #!/usr/bin/python | |
2 | ||
3 | # Erebus IRC bot - Author: John Runyon | |
4 | # "Bot" and "BotConnection" classes (handling a specific "arm") | |
5 | ||
6 | import socket, sys, time, threading | |
7 | from collections import deque | |
8 | ||
9 | #bots = {'erebus': bot.Bot(nick='Erebus', user='erebus', bind='', server='irc.quakenet.org', port=6667, realname='Erebus')} | |
10 | class Bot(object): | |
11 | def __init__(self, parent, nick, user, bind, authname, authpass, server, port, realname): | |
12 | self.parent = parent | |
13 | self.nick = nick | |
14 | self.user = user | |
15 | self.realname = realname | |
16 | ||
17 | self.authname = authname | |
18 | self.authpass = authpass | |
19 | ||
20 | curs = self.parent.db.cursor() | |
21 | if curs.execute("SELECT chname FROM chans WHERE bot = %s AND active = 1", (self.nick,)): | |
22 | chansres = curs.fetchall() | |
23 | curs.close() | |
24 | self.chans = [self.parent.newchannel(self, row['chname']) for row in chansres] | |
25 | ||
26 | self.conn = BotConnection(self, bind, server, port) | |
27 | ||
28 | self.msgqueue = deque() | |
29 | self.slowmsgqueue = deque() | |
30 | self.makemsgtimer() | |
31 | ||
32 | ||
33 | def connect(self): | |
34 | if self.conn.connect(): | |
35 | self.parent.newfd(self, self.conn.socket.fileno()) | |
36 | ||
37 | def getdata(self): | |
38 | return self.conn.read() | |
39 | ||
40 | def parse(self, line): | |
41 | pieces = line.split() | |
42 | ||
43 | if not self.conn.registered() and pieces[0] == "NOTICE": | |
44 | self.conn.register() | |
45 | return | |
46 | ||
47 | if self.parent.hasnumhook(pieces[1]): | |
48 | hooks = self.parent.getnumhook(pieces[1]) | |
49 | for callback in hooks: | |
50 | callback(self, line) | |
51 | ||
52 | if pieces[1] == "001": | |
53 | self.conn.registered(True) | |
54 | self.conn.send("MODE %s +x" % (pieces[2])) | |
55 | if self.authname is not None and self.authpass is not None: | |
56 | self.conn.send("AUTH %s %s" % (self.authname, self.authpass)) | |
57 | for c in self.chans: | |
58 | self.join(c.name) | |
59 | ||
60 | elif pieces[1] == "PRIVMSG": | |
61 | nick = pieces[0].split('!')[0][1:] | |
62 | user = self.parent.user(nick) | |
63 | target = pieces[2] | |
64 | msg = ' '.join(pieces[3:])[1:] | |
65 | self.parsemsg(user, target, msg) | |
66 | ||
67 | elif pieces[0] == "PING": | |
68 | self.conn.send("PONG %s" % (pieces[1])) | |
69 | ||
70 | elif pieces[1] == "354": # WHOX | |
71 | qt = pieces[3] | |
72 | nick = pieces[4] | |
73 | auth = pieces[5] | |
74 | self.parent.user(nick).authed(auth) | |
75 | ||
76 | elif pieces[1] == "JOIN": | |
77 | nick = pieces[0].split('!')[0][1:] | |
78 | chan = self.parent.channel(pieces[2]) | |
79 | ||
80 | if nick == self.nick: | |
81 | self.conn.send("WHO %s c%%ant,1" % (chan)) | |
82 | else: | |
83 | user = self.parent.user(nick, justjoined=True) | |
84 | chan.userjoin(user) | |
85 | user.join(chan) | |
86 | ||
87 | elif pieces[1] == "PART": | |
88 | nick = pieces[0].split('!')[0][1:] | |
89 | chan = self.parent.channel(pieces[2]) | |
90 | ||
91 | if nick != self.nick: | |
92 | self.parent.user(nick).part(chan) | |
93 | chan.userpart(self.parent.user(nick)) | |
94 | ||
95 | elif pieces[1] == "QUIT": | |
96 | nick = pieces[0].split('!')[0][1:] | |
97 | if nick != self.nick: | |
98 | self.parent.user(nick).quit() | |
99 | del self.parent.users[nick.lower()] | |
100 | ||
101 | elif pieces[1] == "NICK": | |
102 | oldnick = pieces[0].split('!')[0][1:] | |
103 | newnick = pieces[2][1:] | |
104 | if newnick.lower() != oldnick.lower(): | |
105 | self.parent.users[newnick.lower()] = self.parent.users[oldnick.lower()] | |
106 | del self.parent.users[oldnick.lower()] | |
107 | self.parent.users[newnick.lower()].nickchange(newnick) | |
108 | ||
109 | elif pieces[0] == "ERROR": #TODO handle better | |
110 | sys.exit(2) | |
111 | os._exit(2) | |
112 | ||
113 | elif pieces[1] == "MODE": #TODO parse for ops/voices (at least) | |
114 | pass | |
115 | ||
116 | ||
117 | def parsemsg(self, user, target, msg): | |
118 | chan = None | |
119 | if len(msg) == 0: | |
120 | return | |
121 | ||
122 | triggerused = msg[0] == self.parent.trigger | |
123 | if triggerused: msg = msg[1:] | |
124 | pieces = msg.split() | |
125 | ||
126 | if target == self.nick: | |
127 | if msg[0] == "\001": #ctcp | |
128 | msg = msg.strip("\001") | |
129 | if msg == "VERSION": | |
130 | self.msg(user, "\001VERSION Erebus v%d.%d - http://github.com/zonidjan/erebus" % (self.parent.APIVERSION, self.parent.RELEASE)) | |
131 | return | |
132 | if len(pieces) > 1: | |
133 | chanword = pieces[1] | |
134 | if chanword[0] == '#': | |
135 | chan = self.parent.channel(chanword) | |
136 | if chan is not None: #if chan is still none, there's no bot on "chanword", and chanword is used as a parameter. | |
137 | pieces.pop(1) | |
138 | ||
139 | else: # message was sent to a channel | |
140 | chan = self.parent.channel(target) | |
141 | try: | |
142 | if msg[0] == '*': # message may be addressed to bot by "*BOTNICK" trigger? | |
143 | if pieces[0][1:].lower() == self.nick.lower(): | |
144 | pieces.pop(0) # command actually starts with next word | |
145 | msg = ' '.join(pieces) # command actually starts with next word | |
146 | elif not triggerused: | |
147 | if self.parent.haschanhook(target.lower()): | |
148 | for callback in self.parent.getchanhook(target.lower()): | |
149 | cbret = callback(self, user, chan, *pieces) | |
150 | if cbret is NotImplemented: | |
151 | self.msg(user, "Command not implemented.") | |
152 | return # not to bot, don't process! | |
153 | except IndexError: | |
154 | return # "message" is empty | |
155 | ||
156 | cmd = pieces[0].lower() | |
157 | ||
158 | if self.parent.hashook(cmd): | |
159 | for callback in self.parent.gethook(cmd): | |
160 | if chan is None and callback.needchan: | |
161 | self.msg(user, "You need to specify a channel for that command.") | |
162 | elif user.glevel >= callback.reqglevel and (not callback.needchan or chan.levelof(user.auth) >= callback.reqclevel): | |
163 | cbret = callback(self, user, chan, target, *pieces[1:]) | |
164 | if cbret is NotImplemented: | |
165 | self.msg(user, "Command not implemented.") | |
166 | ||
167 | def msg(self, target, msg): | |
168 | if target is None or msg is None: return False | |
169 | ||
170 | self.msgqueue.append((target, msg)) | |
171 | if not self.msgtimer.is_alive(): | |
172 | self.msgtimer.start() | |
173 | return True | |
174 | ||
175 | def slowmsg(self, target, msg): | |
176 | if target is None or msg is None: return False | |
177 | ||
178 | self.slowmsgqueue.append((target,msg)) | |
179 | if not self.msgtimer.is_alive(): | |
180 | self.msgtimer.start() | |
181 | return True | |
182 | ||
183 | def fastmsg(self, target, msg): | |
184 | if isinstance(target, self.parent.User): target = target.nick | |
185 | elif isinstance(target, self.parent.Channel): target = target.name | |
186 | elif not isinstance(target, basestring): raise TypeError('Bot.msg() "target" must be Erebus.User, Erebus.Channel, or string') | |
187 | ||
188 | if target[0] == '#': command = "PRIVMSG %s :%s" % (target, msg) | |
189 | else: command = "NOTICE %s :%s" % (target, msg) | |
190 | ||
191 | self.conn.send(command) | |
192 | ||
193 | def _popmsg(self): | |
194 | self.makemsgtimer() | |
195 | ||
196 | try: | |
197 | self.fastmsg(*self.msgqueue.popleft()) | |
198 | self.msgtimer.start() | |
199 | except IndexError: | |
200 | try: | |
201 | self.fastmsg(*self.slowmsgqueue.popleft()) | |
202 | self.msgtimer.start() | |
203 | except IndexError: | |
204 | pass | |
205 | ||
206 | def makemsgtimer(self): | |
207 | self.msgtimer = threading.Timer(2, self._popmsg) | |
208 | self.msgtimer.daemon = True | |
209 | ||
210 | def join(self, chan): | |
211 | self.conn.send("JOIN %s" % (chan)) | |
212 | ||
213 | def part(self, chan): | |
214 | self.conn.send("PART %s" % (chan)) | |
215 | ||
216 | def quit(self, reason="Shutdown"): | |
217 | self.conn.send("QUIT :%s" % (reason)) | |
218 | ||
219 | def __str__(self): return self.nick | |
220 | def __repr__(self): return "<Bot %r>" % (self.nick) | |
221 | ||
222 | class BotConnection(object): | |
223 | def __init__(self, parent, bind, server, port): | |
224 | self.parent = parent | |
225 | self.buffer = '' | |
226 | self.socket = None | |
227 | ||
228 | self.bind = bind | |
229 | self.server = server | |
230 | self.port = int(port) | |
231 | ||
232 | self.state = 0 # 0=disconnected, 1=registering, 2=connected | |
233 | ||
234 | def connect(self): | |
235 | self.socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM) | |
236 | self.socket.bind((self.bind, 0)) | |
237 | self.socket.connect((self.server, self.port)) | |
238 | return True | |
239 | def register(self): | |
240 | if self.state == 0: | |
241 | self.send("NICK %s" % (self.parent.nick)) | |
242 | self.send("USER %s 0 * :%s" % (self.parent.user, self.parent.realname)) | |
243 | self.state = 1 | |
244 | return True | |
245 | ||
246 | def registered(self, done=False): | |
247 | if done: self.state = 2 | |
248 | return self.state == 2 | |
249 | ||
250 | #TODO: rewrite send() to queue | |
251 | def send(self, line): | |
252 | print "%05.3f %s [O] %s" % (time.time() % 100000, self.parent.nick, line) | |
253 | sys.stdout.flush() | |
254 | # print (time.time() % 1466400000), self.parent.nick, '[O]', str(line) | |
255 | self._write(line) | |
256 | ||
257 | def _write(self, line): | |
258 | self.socket.sendall(line+"\r\n") | |
259 | ||
260 | def read(self): | |
261 | self.buffer += self.socket.recv(8192) | |
262 | lines = [] | |
263 | ||
264 | while "\r\n" in self.buffer: | |
265 | pieces = self.buffer.split("\r\n", 1) | |
266 | print "%05.3f %s [I] %s" % (time.time() % 100000, self.parent.nick, pieces[0]) | |
267 | sys.stdout.flush() | |
268 | # print (time.time() % 1460000000), self.parent.nick, '[I]', pieces[0] | |
269 | lines.append(pieces[0]) | |
270 | self.buffer = pieces[1] | |
271 | ||
272 | return lines | |
273 | ||
274 | def __str__(self): return self.nick | |
275 | def __repr__(self): return "<BotConnection %r (%r)>" % (self.socket.fileno(), self.parent.nick) |