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