[erebus.git] / bot.py

#!/usr/bin/python

# Erebus IRC bot - Author: John Runyon
# "Bot" and "BotConnection" classes (handling a specific "arm")

import socket, sys, time, threading, os
from collections import deque

#bots = {'erebus': bot.Bot(nick='Erebus', user='erebus', bind='', server='irc.quakenet.org', port=6667, realname='Erebus')}
class Bot(object):
	def __init__(self, parent, nick, user, bind, authname, authpass, server, port, realname):
		self.parent = parent
		self.nick = nick
		self.user = user
		self.realname = realname

		self.authname = authname
		self.authpass = authpass

		curs = self.parent.db.cursor()
		if curs.execute("SELECT chname FROM chans WHERE bot = %s AND active = 1", (self.nick,)):
			chansres = curs.fetchall()
			curs.close()
			self.chans = [self.parent.newchannel(self, row['chname']) for row in chansres]

		self.conn = BotConnection(self, bind, server, port)

		self.msgqueue = deque()
		self.slowmsgqueue = deque()
		self.makemsgtimer()


	def connect(self):
		if self.conn.connect():
			self.parent.newfd(self, self.conn.socket.fileno())

	def getdata(self):
		return self.conn.read()

	def parse(self, line):
		pieces = line.split()

		# dispatch dict
		zero = { #things to look for without source
			'NOTICE': self._gotregistered,
			'PING': self._gotping,
			'ERROR': self._goterror,
		}
		one = { #things to look for after source
			'001': self._got001,
			'PRIVMSG': self._gotprivmsg,
			'354': self._got354,
			'JOIN': self._gotjoin,
			'PART': self._gotpart,
			'QUIT': self._gotquit,
			'NICK': self._gotnick,
			'MODE': self._gotmode,
		}

		if self.parent.hasnumhook(pieces[1]):
			hooks = self.parent.getnumhook(pieces[1])
			for callback in hooks:
				try:
					callback(self, line)
				except Exception:
					self.__debug_cbexception("numhook", line)

		if pieces[0] in zero:
			zero[pieces[0]](pieces)
		elif pieces[1] in one:
			one[pieces[1]](pieces)

	def _gotregistered(self, pieces):
		if not self.conn.registered():
			self.conn.register()
	def _gotping(self, pieces):
		self.conn.send("PONG %s" % (pieces[1]))
	def _goterror(self, pieces): #TODO handle better
		sys.exit(2)
		os._exit(2)
	def _got001(self, pieces):
		self.conn.registered(True)
		self.conn.send("MODE %s +x" % (pieces[2]))
		if self.authname is not None and self.authpass is not None:
			self.conn.send("AUTH %s %s" % (self.authname, self.authpass))
		for c in self.chans:
			self.join(c.name)
	def _gotprivmsg(self, pieces):
		nick = pieces[0].split('!')[0][1:]
		user = self.parent.user(nick)
		target = pieces[2]
		msg = ' '.join(pieces[3:])[1:]
		self.parsemsg(user, target, msg)
	def _got354(self, pieces):
		qt, nick, auth = pieces[3:6]
		self.parent.user(nick).authed(auth)
	def _gotjoin(self, pieces):
		nick = pieces[0].split('!')[0][1:]
		chan = self.parent.channel(pieces[2])

		if nick == self.nick:
			self.conn.send("WHO %s c%%ant,1" % (chan))
		else:
			user = self.parent.user(nick, justjoined=True)
			chan.userjoin(user)
			user.join(chan)
	def _gotpart(self, pieces):
		nick = pieces[0].split('!')[0][1:]
		chan = self.parent.channel(pieces[2])

		if nick != self.nick:
			self.parent.user(nick).part(chan)
			chan.userpart(self.parent.user(nick))
	def _gotquit(self, pieces):
		nick = pieces[0].split('!')[0][1:]
		if nick != self.nick:
			self.parent.user(nick).quit()
			del self.parent.users[nick.lower()]
	def _gotnick(self, pieces):
		oldnick = pieces[0].split('!')[0][1:]
		newnick = pieces[2][1:]
		if newnick.lower() != oldnick.lower():
			self.parent.users[newnick.lower()] = self.parent.users[oldnick.lower()]
			del self.parent.users[oldnick.lower()]
		self.parent.users[newnick.lower()].nickchange(newnick)
	def _gotmode(self, pieces): #TODO parse for ops/voices (at least)
		pass


	def __debug_cbexception(self, source, *args, **kwargs):
		if int(self.parent.cfg.get('debug', 'cbexc', default=0)) == 1:
			self.conn.send("PRIVMSG %s :%09.3f ^C4^B!!!^B^C CBEXC %s" % (self.parent.cfg.get('debug', 'owner'), time.time() % 100000, source))
			__import__('traceback').print_exc()
			print "%09.3f %s [!] CBEXC %s %r %r" % (time.time() % 100000, self.nick, source, args, kwargs)


	def parsemsg(self, user, target, msg):
		chan = None
		if len(msg) == 0:
			return

		triggerused = msg[0] == self.parent.trigger
		if triggerused: msg = msg[1:]
		pieces = msg.split()

		if target == self.nick:
			if msg[0] == "\001": #ctcp
				msg = msg.strip("\001")
				if msg == "VERSION":
					self.msg(user, "\001VERSION Erebus v%d.%d - http://github.com/zonidjan/erebus" % (self.parent.APIVERSION, self.parent.RELEASE))
				return
			if len(pieces) > 1:
				chanword = pieces[1]
				if chanword[0] == '#':
					chan = self.parent.channel(chanword)
					if chan is not None: #if chan is still none, there's no bot on "chanword", and chanword is used as a parameter.
						pieces.pop(1)

		else: # message was sent to a channel
			chan = self.parent.channel(target)
			try:
				if msg[0] == '*': # message may be addressed to bot by "*BOTNICK" trigger?
					if pieces[0][1:].lower() == self.nick.lower():
						pieces.pop(0) # command actually starts with next word
						msg = ' '.join(pieces) # command actually starts with next word
				elif not triggerused:
					if self.parent.haschanhook(target.lower()):
						for callback in self.parent.getchanhook(target.lower()):
							try:
								cbret = callback(self, user, chan, *pieces)
								if cbret is NotImplemented: self.msg(user, "Command not implemented.")
							except:
								self.msg(user, "Command failed. Code: CBEXC%09.3f" % (time.time() % 100000))
								self.__debug_cbexception("chanhook", user=user, target=target, msg=msg)
					return # not to bot, don't process!
			except IndexError:
				return # "message" is empty

		cmd = pieces[0].lower()

		if self.parent.hashook(cmd):
			for callback in self.parent.gethook(cmd):
				if chan is None and callback.needchan:
					self.msg(user, "You need to specify a channel for that command.")
				elif user.glevel >= callback.reqglevel and (not callback.needchan or chan.levelof(user.auth) >= callback.reqclevel):
					try:
						cbret = callback(self, user, chan, target, *pieces[1:])
						if cbret is NotImplemented: self.msg(user, "Command not implemented.")
					except Exception:
						self.msg(user, "Command failed. Code: CBEXC%09.3f" % (time.time() % 100000))
						self.__debug_cbexception("hook", user=user, target=target, msg=msg)

	def __debug_nomsg(self, target, msg):
		if int(self.parent.cfg.get('debug', 'nomsg', default=0)) == 1:
			self.conn.send("PRIVMSG %s :%09.3f \ 34\ 2!!!\ 2\ 3 NOMSG %r, %r" % (self.parent.cfg.get('debug', 'owner'), time.time() % 100000, target, msg))
			print "%09.3f %s [!] %s" % (time.time() % 100000, self.nick, "!!! NOMSG")
			__import__('traceback').print_stack()

	def msg(self, target, msg):
		if target is None or msg is None:
			return self.__debug_nomsg(target, msg)

		self.msgqueue.append((target, msg))
		if not self.msgtimer.is_alive():
			self.msgtimer.start()

	def slowmsg(self, target, msg):
		if target is None or msg is None:
			return self.__debug_nomsg(target, msg)

		self.slowmsgqueue.append((target, msg))
		if not self.msgtimer.is_alive():
			self.msgtimer.start()

	def fastmsg(self, target, msg):
		if target is None or msg is None:
			return self.__debug_nomsg(target, msg)

		target = str(target)

		if target[0] == '#': command = "PRIVMSG %s :%s" % (target, msg)
		else: command = "NOTICE %s :%s" % (target, msg)

		self.conn.send(command)

	def _popmsg(self):
		self.makemsgtimer()

		try:
			self.fastmsg(*self.msgqueue.popleft())
			self.msgtimer.start()
		except IndexError:
			try:
				self.fastmsg(*self.slowmsgqueue.popleft())
				self.msgtimer.start()
			except IndexError:
				pass

	def makemsgtimer(self):
		self.msgtimer = threading.Timer(2, self._popmsg)
		self.msgtimer.daemon = True

	def join(self, chan):
		self.conn.send("JOIN %s" % (chan))

	def part(self, chan):
		self.conn.send("PART %s" % (chan))

	def quit(self, reason="Shutdown"):
		self.conn.send("QUIT :%s" % (reason))

	def __str__(self): return self.nick
	def __repr__(self): return "<Bot %r>" % (self.nick)

class BotConnection(object):
	def __init__(self, parent, bind, server, port):
		self.parent = parent
		self.buffer = ''
		self.socket = None

		self.bind = bind
		self.server = server
		self.port = int(port)

		self.state = 0 # 0=disconnected, 1=registering, 2=connected

	def connect(self):
		self.socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
		self.socket.bind((self.bind, 0))
		self.socket.connect((self.server, self.port))
		return True
	def register(self):
		if self.state == 0:
			self.send("NICK %s" % (self.parent.nick))
			self.send("USER %s 0 * :%s" % (self.parent.user, self.parent.realname))
			self.state = 1
		return True

	def registered(self, done=False):
		if done: self.state = 2
		return self.state == 2

	def send(self, line):
		print "%09.3f %s [O] %s" % (time.time() % 100000, self.parent.nick, line)
		self._write(line)

	def _write(self, line):
		self.socket.sendall(line+"\r\n")

	def read(self):
		self.buffer += self.socket.recv(8192)
		lines = []

		while "\r\n" in self.buffer:
			pieces = self.buffer.split("\r\n", 1)
			print "%09.3f %s [I] %s" % (time.time() % 100000, self.parent.nick, pieces[0])
#			print (time.time() % 1460000000), self.parent.nick, '[I]', pieces[0]
			lines.append(pieces[0])
			self.buffer = pieces[1]

		return lines

	def __str__(self): return self.parent.nick
	def __repr__(self): return "<BotConnection %r (%r)>" % (self.socket.fileno(), self.parent.nick)
Commit	Line	Data
b25d4368	1	#!/usr/bin/python
b25d4368	2
931c88a4	3	# Erebus IRC bot - Author: John Runyon
	4	# "Bot" and "BotConnection" classes (handling a specific "arm")
	5
28d06664	6	import socket, sys, time, threading, os
e64ac4a0	7	from collections import deque
b25d4368	8
	9	#bots = {'erebus': bot.Bot(nick='Erebus', user='erebus', bind='', server='irc.quakenet.org', port=6667, realname='Erebus')}
	10	class Bot(object):
0af282c6	11	def __init__(self, parent, nick, user, bind, authname, authpass, server, port, realname):
b25d4368	12	self.parent = parent
b25d4368	13	self.nick = nick
a12f7519	14	self.user = user
a12f7519	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
e64ac4a0	28	self.msgqueue = deque()
2bb267e0	29	self.slowmsgqueue = deque()
e64ac4a0	30	self.makemsgtimer()
	31
	32
b25d4368	33	def connect(self):
b2a896c8	34	if self.conn.connect():
49a455aa	35	self.parent.newfd(self, self.conn.socket.fileno())
49a455aa	36
b25d4368	37	def getdata(self):
d1ea2946	38	return self.conn.read()
a4eacae2	39
b25d4368	40	def parse(self, line):
b25d4368	41	pieces = line.split()
a4eacae2	42
a38e8be0	43	# dispatch dict
a38e8be0	44	zero = { #things to look for without source
28d06664	45	'NOTICE': self._gotregistered,
	46	'PING': self._gotping,
	47	'ERROR': self._goterror,
	48	}
a38e8be0	49	one = { #things to look for after source
28d06664	50	'001': self._got001,
	51	'PRIVMSG': self._gotprivmsg,
	52	'354': self._got354,
	53	'JOIN': self._gotjoin,
	54	'PART': self._gotpart,
	55	'QUIT': self._gotquit,
	56	'NICK': self._gotnick,
	57	'MODE': self._gotmode,
	58	}
d1ea2946	59
e4a4c762	60	if self.parent.hasnumhook(pieces[1]):
	61	hooks = self.parent.getnumhook(pieces[1])
	62	for callback in hooks:
a38e8be0	63	try:
	64	callback(self, line)
	65	except Exception:
	66	self.__debug_cbexception("numhook", line)
e4a4c762	67
28d06664	68	if pieces[0] in zero:
	69	zero[pieces[0]](pieces)
	70	elif pieces[1] in one:
	71	one[pieces[1]](pieces)
	72
	73	def _gotregistered(self, pieces):
	74	if not self.conn.registered():
	75	self.conn.register()
	76	def _gotping(self, pieces):
	77	self.conn.send("PONG %s" % (pieces[1]))
	78	def _goterror(self, pieces): #TODO handle better
	79	sys.exit(2)
	80	os._exit(2)
	81	def _got001(self, pieces):
	82	self.conn.registered(True)
	83	self.conn.send("MODE %s +x" % (pieces[2]))
	84	if self.authname is not None and self.authpass is not None:
	85	self.conn.send("AUTH %s %s" % (self.authname, self.authpass))
	86	for c in self.chans:
	87	self.join(c.name)
	88	def _gotprivmsg(self, pieces):
	89	nick = pieces[0].split('!')[0][1:]
	90	user = self.parent.user(nick)
	91	target = pieces[2]
	92	msg = ' '.join(pieces[3:])[1:]
	93	self.parsemsg(user, target, msg)
	94	def _got354(self, pieces):
	95	qt, nick, auth = pieces[3:6]
	96	self.parent.user(nick).authed(auth)
	97	def _gotjoin(self, pieces):
	98	nick = pieces[0].split('!')[0][1:]
	99	chan = self.parent.channel(pieces[2])
	100
	101	if nick == self.nick:
	102	self.conn.send("WHO %s c%%ant,1" % (chan))
	103	else:
	104	user = self.parent.user(nick, justjoined=True)
	105	chan.userjoin(user)
	106	user.join(chan)
	107	def _gotpart(self, pieces):
	108	nick = pieces[0].split('!')[0][1:]
	109	chan = self.parent.channel(pieces[2])
	110
	111	if nick != self.nick:
	112	self.parent.user(nick).part(chan)
	113	chan.userpart(self.parent.user(nick))
	114	def _gotquit(self, pieces):
	115	nick = pieces[0].split('!')[0][1:]
	116	if nick != self.nick:
	117	self.parent.user(nick).quit()
	118	del self.parent.users[nick.lower()]
	119	def _gotnick(self, pieces):
	120	oldnick = pieces[0].split('!')[0][1:]
	121	newnick = pieces[2][1:]
	122	if newnick.lower() != oldnick.lower():
	123	self.parent.users[newnick.lower()] = self.parent.users[oldnick.lower()]
	124	del self.parent.users[oldnick.lower()]
	125	self.parent.users[newnick.lower()].nickchange(newnick)
	126	def _gotmode(self, pieces): #TODO parse for ops/voices (at least)
	127	pass
a5ceff24	128
b6212f14	129
a38e8be0	130	def __debug_cbexception(self, source, args, *kwargs):
3d724d3a	131	if int(self.parent.cfg.get('debug', 'cbexc', default=0)) == 1:
a38e8be0	132	self.conn.send("PRIVMSG %s :%09.3f ^C4^B!!!^B^C CBEXC %s" % (self.parent.cfg.get('debug', 'owner'), time.time() % 100000, source))
3d724d3a	133	__import__('traceback').print_exc()
a38e8be0	134	print "%09.3f %s [!] CBEXC %s %r %r" % (time.time() % 100000, self.nick, source, args, kwargs)
3d724d3a	135
3d724d3a	136
839d2b35	137	def parsemsg(self, user, target, msg):
839d2b35	138	chan = None
877cd61d	139	if len(msg) == 0:
	140	return
	141
	142	triggerused = msg[0] == self.parent.trigger
839d2b35	143	if triggerused: msg = msg[1:]
49a455aa	144	pieces = msg.split()
839d2b35	145
839d2b35	146	if target == self.nick:
a76c4bd8	147	if msg[0] == "\001": #ctcp
	148	msg = msg.strip("\001")
	149	if msg == "VERSION":
	150	self.msg(user, "\001VERSION Erebus v%d.%d - http://github.com/zonidjan/erebus" % (self.parent.APIVERSION, self.parent.RELEASE))
	151	return
d1ea2946	152	if len(pieces) > 1:
	153	chanword = pieces[1]
	154	if chanword[0] == '#':
	155	chan = self.parent.channel(chanword)
f5e736ee	156	if chan is not None: #if chan is still none, there's no bot on "chanword", and chanword is used as a parameter.
f5e736ee	157	pieces.pop(1)
839d2b35	158
839d2b35	159	else: # message was sent to a channel
c9db2d7e	160	chan = self.parent.channel(target)
90b64dc0 CS	161	try:
	162	if msg[0] == '': # message may be addressed to bot by "BOTNICK" trigger?
	163	if pieces[0][1:].lower() == self.nick.lower():
	164	pieces.pop(0) # command actually starts with next word
	165	msg = ' '.join(pieces) # command actually starts with next word
	166	elif not triggerused:
9557ee54	167	if self.parent.haschanhook(target.lower()):
2a1a69a6	168	for callback in self.parent.getchanhook(target.lower()):
3d724d3a	169	try:
	170	cbret = callback(self, user, chan, *pieces)
	171	if cbret is NotImplemented: self.msg(user, "Command not implemented.")
6681579e	172	except:
3d724d3a	173	self.msg(user, "Command failed. Code: CBEXC%09.3f" % (time.time() % 100000))
a38e8be0	174	self.__debug_cbexception("chanhook", user=user, target=target, msg=msg)
a76c4bd8	175	return # not to bot, don't process!
90b64dc0	176	except IndexError:
a76c4bd8	177	return # "message" is empty
839d2b35	178
db50981b	179	cmd = pieces[0].lower()
a4eacae2	180
db50981b	181	if self.parent.hashook(cmd):
e4a4c762	182	for callback in self.parent.gethook(cmd):
	183	if chan is None and callback.needchan:
	184	self.msg(user, "You need to specify a channel for that command.")
586997a7	185	elif user.glevel >= callback.reqglevel and (not callback.needchan or chan.levelof(user.auth) >= callback.reqclevel):
3d724d3a	186	try:
	187	cbret = callback(self, user, chan, target, *pieces[1:])
	188	if cbret is NotImplemented: self.msg(user, "Command not implemented.")
	189	except Exception:
	190	self.msg(user, "Command failed. Code: CBEXC%09.3f" % (time.time() % 100000))
a38e8be0	191	self.__debug_cbexception("hook", user=user, target=target, msg=msg)
3d724d3a	192
	193	def __debug_nomsg(self, target, msg):
	194	if int(self.parent.cfg.get('debug', 'nomsg', default=0)) == 1:
06a27ea5	195	self.conn.send("PRIVMSG %s :%09.3f \ 34\ 2!!!\ 2\ 3 NOMSG %r, %r" % (self.parent.cfg.get('debug', 'owner'), time.time() % 100000, target, msg))
3d724d3a	196	print "%09.3f %s [!] %s" % (time.time() % 100000, self.nick, "!!! NOMSG")
3d724d3a	197	__import__('traceback').print_stack()
49a455aa	198
49a455aa	199	def msg(self, target, msg):
3d724d3a	200	if target is None or msg is None:
3d724d3a	201	return self.__debug_nomsg(target, msg)
a83e1f9c	202
2bb267e0	203	self.msgqueue.append((target, msg))
e64ac4a0	204	if not self.msgtimer.is_alive():
	205	self.msgtimer.start()
	206
2bb267e0	207	def slowmsg(self, target, msg):
3d724d3a	208	if target is None or msg is None:
3d724d3a	209	return self.__debug_nomsg(target, msg)
e64ac4a0	210
28d06664	211	self.slowmsgqueue.append((target, msg))
2bb267e0	212	if not self.msgtimer.is_alive():
2bb267e0	213	self.msgtimer.start()
2bb267e0	214
2bb267e0	215	def fastmsg(self, target, msg):
3d724d3a	216	if target is None or msg is None:
28d06664	217	return self.__debug_nomsg(target, msg)
3d724d3a	218
6681579e	219	target = str(target)
e64ac4a0	220
	221	if target[0] == '#': command = "PRIVMSG %s :%s" % (target, msg)
	222	else: command = "NOTICE %s :%s" % (target, msg)
	223
	224	self.conn.send(command)
	225
	226	def _popmsg(self):
	227	self.makemsgtimer()
	228
	229	try:
	230	self.fastmsg(*self.msgqueue.popleft())
	231	self.msgtimer.start()
2bb267e0	232	except IndexError:
	233	try:
	234	self.fastmsg(*self.slowmsgqueue.popleft())
	235	self.msgtimer.start()
	236	except IndexError:
	237	pass
e64ac4a0	238
	239	def makemsgtimer(self):
	240	self.msgtimer = threading.Timer(2, self._popmsg)
	241	self.msgtimer.daemon = True
a4eacae2	242
49a455aa	243	def join(self, chan):
49a455aa	244	self.conn.send("JOIN %s" % (chan))
a4eacae2	245
49a455aa	246	def part(self, chan):
49a455aa	247	self.conn.send("PART %s" % (chan))
a4eacae2	248
49a455aa	249	def quit(self, reason="Shutdown"):
49a455aa	250	self.conn.send("QUIT :%s" % (reason))
b25d4368	251
a12f7519	252	def __str__(self): return self.nick
	253	def __repr__(self): return "<Bot %r>" % (self.nick)
	254
b25d4368	255	class BotConnection(object):
a12f7519	256	def __init__(self, parent, bind, server, port):
b25d4368	257	self.parent = parent
	258	self.buffer = ''
	259	self.socket = None
	260
b25d4368	261	self.bind = bind
	262	self.server = server
	263	self.port = int(port)
b25d4368	264
7631844f	265	self.state = 0 # 0=disconnected, 1=registering, 2=connected
7631844f	266
b25d4368	267	def connect(self):
	268	self.socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
	269	self.socket.bind((self.bind, 0))
	270	self.socket.connect((self.server, self.port))
d1ea2946	271	return True
	272	def register(self):
	273	if self.state == 0:
	274	self.send("NICK %s" % (self.parent.nick))
	275	self.send("USER %s 0 * :%s" % (self.parent.user, self.parent.realname))
	276	self.state = 1
49a455aa	277	return True
b25d4368	278
	279	def registered(self, done=False):
	280	if done: self.state = 2
	281	return self.state == 2
	282
b25d4368	283	def send(self, line):
3d724d3a	284	print "%09.3f %s [O] %s" % (time.time() % 100000, self.parent.nick, line)
7631844f	285	self._write(line)
a4eacae2	286
7631844f	287	def _write(self, line):
b25d4368	288	self.socket.sendall(line+"\r\n")
a4eacae2	289
b25d4368	290	def read(self):
	291	self.buffer += self.socket.recv(8192)
	292	lines = []
a4eacae2	293
7631844f	294	while "\r\n" in self.buffer:
7631844f	295	pieces = self.buffer.split("\r\n", 1)
3d724d3a	296	print "%09.3f %s [I] %s" % (time.time() % 100000, self.parent.nick, pieces[0])
dcb94ddc	297	# print (time.time() % 1460000000), self.parent.nick, '[I]', pieces[0]
b25d4368	298	lines.append(pieces[0])
b25d4368	299	self.buffer = pieces[1]
a4eacae2	300
b25d4368	301	return lines
a12f7519	302
28d06664	303	def __str__(self): return self.parent.nick
a12f7519	304	def __repr__(self): return "<BotConnection %r (%r)>" % (self.socket.fileno(), self.parent.nick)