Context Navigation

source: skype/skyped.py @ 3423be0

Last change on this file since 3423be0 was 3423be0, checked in by Miklos Vajna <vmiklos@…>, at 2011-02-07T23:24:37Z

Always use UTF-8 encoding when dealing with BitlBee

BitlBee internally always uses UTF-8 (see initialization of
irc->iconv and irc->oconv in set_eval_charset in irc.c of
BitlBee's source and their usage in eg irc_vawrite in the
same file; confirmed on #bitlbee), so it makes no sense to
either get an encoding from the current locale or to make it
a runtime setting.

Property mode set to 100644

File size: 12.8 KB

Rev	Line
[47c590c]	1	#!/usr/bin/env python2.7
[cd3022c]	2	#
	3	# skyped.py
	4	#
[7cf146f]	5	# Copyright (c) 2007, 2008, 2009, 2010 by Miklos Vajna <vmiklos@frugalware.org>
[cd3022c]	6	#
	7	# This program is free software; you can redistribute it and/or modify
	8	# it under the terms of the GNU General Public License as published by
	9	# the Free Software Foundation; either version 2 of the License, or
	10	# (at your option) any later version.
	11	#
	12	# This program is distributed in the hope that it will be useful,
	13	# but WITHOUT ANY WARRANTY; without even the implied warranty of
	14	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	15	# GNU General Public License for more details.
	16	#
	17	# You should have received a copy of the GNU General Public License
	18	# along with this program; if not, write to the Free Software
	19	# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
	20	# USA.
	21	#
	22
[4ddda13]	23	import sys
[8237df5]	24	import os
[4ddda13]	25	import signal
	26	import locale
	27	import time
	28	import socket
[8237df5]	29	import getopt
[c15f71a]	30	import Skype4Py
[8edfc90]	31	import hashlib
[d891915]	32	from ConfigParser import ConfigParser, NoOptionError
[eeeb30e]	33	from traceback import print_exception
[c7000bb]	34	import ssl
[eeab8bc]	35	import select
[d45adcf]	36	import threading
[4ddda13]	37
[8237df5]	38	__version__ = "0.1.1"
[4ddda13]	39
[eeeb30e]	40	def eh(type, value, tb):
[a618ea6]	41	global options
	42
[3a2a0b2]	43	if type != KeyboardInterrupt:
	44	print_exception(type, value, tb)
[53eb75c]	45	if options.conn:
	46	options.conn.close()
[7415989]	47	# shut down client if it's running
	48	try:
	49	skype.skype.Client.Shutdown()
	50	except NameError:
	51	pass
[3a2a0b2]	52	sys.exit("Exiting.")
[eeeb30e]	53
	54	sys.excepthook = eh
	55
[d45adcf]	56	def wait_for_lock(lock, timeout_to_print, timeout, msg):
	57	start = time.time()
	58	locked = lock.acquire(0)
	59	while not(locked):
	60	time.sleep(0.5)
	61	if timeout_to_print and (time.time() - timeout_to_print > start):
	62	dprint("%s: Waited %f seconds" % \
	63	(msg, time.time() - start))
	64	timeout_to_print = False
	65	if timeout and (time.time() - timeout > start):
	66	dprint("%s: Waited %f seconds, giving up" % \
	67	(msg, time.time() - start))
	68	return False
	69	locked = lock.acquire(0)
	70	return True
	71
[e530abd]	72	def input_handler(fd):
[5245e9d]	73	global options
[e530abd]	74	global skype
[5245e9d]	75	if options.buf:
	76	for i in options.buf:
	77	skype.send(i.strip())
	78	options.buf = None
[e530abd]	79	return True
[5245e9d]	80	else:
[f85837a]	81	close_socket = False
[d45adcf]	82	if wait_for_lock(options.lock, 3, 10, "input_handler"):
	83	try:
	84	input = fd.recv(1024)
	85	options.lock.release()
	86	except Exception, s:
	87	dprint("Warning, receiving 1024 bytes failed (%s)." % s)
	88	fd.close()
	89	options.conn = False
	90	options.lock.release()
	91	return False
	92	for i in input.split("\n"):
[f85837a]	93	if i.strip() == "SET USERSTATUS OFFLINE":
	94	close_socket = True
[d45adcf]	95	skype.send(i.strip())
[f85837a]	96	return not(close_socket)
[c15f71a]	97
[4b0092e]	98	def skype_idle_handler(skype):
[3922d44]	99	try:
[6af541d]	100	c = skype.skype.Command("PING", Block=True)
	101	skype.skype.SendCommand(c)
[3922d44]	102	except Skype4Py.SkypeAPIError, s:
	103	dprint("Warning, pinging Skype failed (%s)." % (s))
[94bd28f]	104	return True
[4ddda13]	105
[a618ea6]	106	def send(sock, txt):
[1130561]	107	global options
[a618ea6]	108	count = 1
	109	done = False
[1130561]	110	while (not done) and (count < 10) and options.conn:
[d45adcf]	111	if wait_for_lock(options.lock, 3, 10, "socket send"):
	112	try:
[1130561]	113	if options.conn: sock.send(txt)
[d45adcf]	114	options.lock.release()
	115	done = True
	116	except Exception, s:
	117	options.lock.release()
	118	count += 1
	119	dprint("Warning, sending '%s' failed (%s). count=%d" % (txt, s, count))
	120	time.sleep(1)
[a618ea6]	121	if not done:
[53eb75c]	122	if options.conn:
	123	options.conn.close()
[e530abd]	124	options.conn = False
	125	return done
[a618ea6]	126
[4b0092e]	127	def bitlbee_idle_handler(skype):
[eeab8bc]	128	global options
[e530abd]	129	done = False
[4b0092e]	130	if options.conn:
	131	try:
	132	e = "PING"
[e530abd]	133	done = send(options.conn, "%s\n" % e)
[4b0092e]	134	except Exception, s:
	135	dprint("Warning, sending '%s' failed (%s)." % (e, s))
[e530abd]	136	if options.conn: options.conn.close()
	137	options.conn = False
	138	done = False
	139	return done
[4b0092e]	140
[eeab8bc]	141	def server(host, port, skype):
[c7304b2]	142	global options
[c7000bb]	143	sock = socket.socket()
[a316c4e]	144	sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
	145	sock.bind((host, port))
	146	sock.listen(1)
[eeab8bc]	147	dprint("Waiting for connection...")
	148	listener(sock, skype)
[a316c4e]	149
[eeab8bc]	150	def listener(sock, skype):
[5245e9d]	151	global options
[d45adcf]	152	if not(wait_for_lock(options.lock, 3, 10, "listener")): return False
[c7000bb]	153	rawsock, addr = sock.accept()
	154	options.conn = ssl.wrap_socket(rawsock,
	155	server_side=True,
	156	certfile=options.config.sslcert,
	157	keyfile=options.config.sslkey,
	158	ssl_version=ssl.PROTOCOL_TLSv1)
[b0d40f5]	159	if hasattr(options.conn, 'handshake'):
[5588f7c4]	160	try:
	161	options.conn.handshake()
	162	except Exception:
[d45adcf]	163	options.lock.release()
[5588f7c4]	164	dprint("Warning, handshake failed, closing connection.")
	165	return False
[5245e9d]	166	ret = 0
[6b9cab1]	167	try:
	168	line = options.conn.recv(1024)
	169	if line.startswith("USERNAME") and line.split(' ')[1].strip() == options.config.username:
	170	ret += 1
	171	line = options.conn.recv(1024)
[8edfc90]	172	if line.startswith("PASSWORD") and hashlib.sha1(line.split(' ')[1].strip()).hexdigest() == options.config.password:
[6b9cab1]	173	ret += 1
	174	except Exception, s:
	175	dprint("Warning, receiving 1024 bytes failed (%s)." % s)
	176	options.conn.close()
[e530abd]	177	options.conn = False
[d45adcf]	178	options.lock.release()
[6b9cab1]	179	return False
[5245e9d]	180	if ret == 2:
	181	dprint("Username and password OK.")
[c7304b2]	182	options.conn.send("PASSWORD OK\n")
[d45adcf]	183	options.lock.release()
[eeab8bc]	184	serverloop(options, skype)
[5245e9d]	185	return True
	186	else:
	187	dprint("Username and/or password WRONG.")
[c7304b2]	188	options.conn.send("PASSWORD KO\n")
[e530abd]	189	options.conn.close()
	190	options.conn = False
[d45adcf]	191	options.lock.release()
[5245e9d]	192	return False
[a316c4e]	193
	194	def dprint(msg):
[ffd078a]	195	from time import strftime
[8237df5]	196	global options
	197
[ffd078a]	198	now = strftime("%Y-%m-%d %H:%M:%S")
	199
[8237df5]	200	if options.debug:
[f503585]	201	try:
	202	print now + ": " + msg
	203	except Exception, s:
	204	try:
	205	sanitized = msg.encode("ascii", "backslashreplace")
	206	except Error, s:
	207	try:
	208	sanitized = "hex [" + msg.encode("hex") + "]"
	209	except Error, s:
	210	sanitized = "[unable to print debug message]"
	211	print now + "~=" + sanitized
[a618ea6]	212	sys.stdout.flush()
[bcdc24b]	213	if options.log:
	214	sock = open(options.log, "a")
[ea1d796]	215	sock.write("%s: %s\n" % (now, msg))
[bcdc24b]	216	sock.close()
[a316c4e]	217
[944a941]	218	class SkypeApi:
[94bd28f]	219	def __init__(self):
[c15f71a]	220	self.skype = Skype4Py.Skype()
[5268bd7]	221	self.skype.OnNotify = self.recv
[6af541d]	222	self.skype.Client.Start()
[94bd28f]	223
[5268bd7]	224	def recv(self, msg_text):
[5245e9d]	225	global options
[d86dfb1]	226	if msg_text == "PONG":
	227	return
[c15f71a]	228	if "\n" in msg_text:
[7613670]	229	# crappy skype prefixes only the first line for
	230	# multiline messages so we need to do so for the other
	231	# lines, too. this is something like:
	232	# 'CHATMESSAGE id BODY first line\nsecond line' ->
	233	# 'CHATMESSAGE id BODY first line\nCHATMESSAGE id BODY second line'
[c15f71a]	234	prefix = " ".join(msg_text.split(" ")[:3])
	235	msg_text = ["%s %s" % (prefix, i) for i in " ".join(msg_text.split(" ")[3:]).split("\n")]
[7613670]	236	else:
[c15f71a]	237	msg_text = [msg_text]
	238	for i in msg_text:
[3423be0]	239	try:
	240	# Internally, BitlBee always uses UTF-8 and encodes/decodes as
	241	# necessary to communicate with the IRC client; thus send the
	242	# UTF-8 it expects
	243	e = i.encode('UTF-8')
	244	except:
	245	# Should never happen, but it's better to send difficult to
	246	# read data than crash because some message couldn't be encoded
	247	e = i.encode('ascii', 'backslashreplace')
[5245e9d]	248	if options.conn:
[e530abd]	249	dprint('<< ' + e)
[af8675f]	250	try:
[a618ea6]	251	send(options.conn, e + "\n")
[80dfdce]	252	except Exception, s:
[a75f2a7]	253	dprint("Warning, sending '%s' failed (%s)." % (e, s))
[e530abd]	254	if options.conn: options.conn.close()
	255	options.conn = False
	256	else:
[53eb75c]	257	dprint('-- ' + e)
[c15f71a]	258
	259	def send(self, msg_text):
[4b0092e]	260	if not len(msg_text) or msg_text == "PONG":
[53eb75c]	261	if msg_text == "PONG":
	262	options.last_bitlbee_pong = time.time()
[c15f71a]	263	return
[885e563e]	264	try:
[3423be0]	265	# Internally, BitlBee always uses UTF-8 and encodes/decodes as
	266	# necessary to communicate with the IRC client; thus decode the
	267	# UTF-8 it sent us
[885e563e]	268	e = msg_text.decode('UTF-8')
[3423be0]	269	except:
	270	# Should never happen, but it's better to send difficult to read
	271	# data to Skype than to crash
	272	e = msg_text.decode('ascii', 'backslashreplace')
[52d779e]	273	dprint('>> ' + e)
[c15f71a]	274	try:
[05cf927]	275	c = self.skype.Command(e, Block=True)
	276	self.skype.SendCommand(c)
	277	self.recv(c.Reply)
	278	except Skype4Py.SkypeError:
[c15f71a]	279	pass
[8b3beef]	280	except Skype4Py.SkypeAPIError, s:
[a75f2a7]	281	dprint("Warning, sending '%s' failed (%s)." % (e, s))
[4ddda13]	282
[8237df5]	283	class Options:
	284	def __init__(self):
[1b48afb]	285	self.cfgpath = os.path.join(os.environ['HOME'], ".skyped", "skyped.conf")
[1a575f69]	286	# for backwards compatibility
	287	self.syscfgpath = "/usr/local/etc/skyped/skyped.conf"
	288	if os.path.exists(self.syscfgpath):
	289	self.cfgpath = self.syscfgpath
[8237df5]	290	self.daemon = True
	291	self.debug = False
	292	self.help = False
[7e450c3]	293	self.host = "0.0.0.0"
[bcdc24b]	294	self.log = None
[d891915]	295	self.port = None
[8237df5]	296	self.version = False
[5245e9d]	297	# well, this is a bit hackish. we store the socket of the last connected client
	298	# here and notify it. maybe later notify all connected clients?
	299	self.conn = None
	300	# this will be read first by the input handler
	301	self.buf = None
	302
[8237df5]	303
	304	def usage(self, ret):
	305	print """Usage: skyped [OPTION]...
	306
	307	skyped is a daemon that acts as a tcp server on top of a Skype instance.
	308
	309	Options:
[5245e9d]	310	-c --config path to configuration file (default: %s)
[8237df5]	311	-d --debug enable debug messages
	312	-h --help this help
[7e450c3]	313	-H --host set the tcp host (default: %s)
[bcdc24b]	314	-l --log set the log file in background mode (default: none)
[8237df5]	315	-n --nofork don't run as daemon in the background
[a349932]	316	-p --port set the tcp port (default: %s)
[5245e9d]	317	-v --version display version information""" % (self.cfgpath, self.host, self.port)
[8237df5]	318	sys.exit(ret)
	319
[eeab8bc]	320	def serverloop(options, skype):
	321	timeout = 1; # in seconds
	322	skype_ping_period = 5
[e530abd]	323	bitlbee_ping_period = 10
	324	bitlbee_pong_timeout = 30
	325	now = time.time()
	326	skype_ping_start_time = now
	327	bitlbee_ping_start_time = now
	328	options.last_bitlbee_pong = now
	329	in_error = []
	330	handler_ok = True
	331	while (len(in_error) == 0) and handler_ok and options.conn:
[eeab8bc]	332	ready_to_read, ready_to_write, in_error = \
[9c51166]	333	select.select([options.conn], [], [options.conn], \
	334	timeout)
[eeab8bc]	335	now = time.time()
[9c51166]	336	handler_ok = len(in_error) == 0
	337	if (len(ready_to_read) == 1) and handler_ok:
[e530abd]	338	handler_ok = input_handler(ready_to_read.pop())
[eeab8bc]	339	# don't ping bitlbee/skype if they already received data
[9c51166]	340	now = time.time() # allow for the input_handler to take some time
[eeab8bc]	341	bitlbee_ping_start_time = now
	342	skype_ping_start_time = now
[9c51166]	343	options.last_bitlbee_pong = now
[e530abd]	344	if (now - skype_ping_period > skype_ping_start_time) and handler_ok:
	345	handler_ok = skype_idle_handler(skype)
[eeab8bc]	346	skype_ping_start_time = now
	347	if now - bitlbee_ping_period > bitlbee_ping_start_time:
[e530abd]	348	handler_ok = bitlbee_idle_handler(skype)
[eeab8bc]	349	bitlbee_ping_start_time = now
[e530abd]	350	if options.last_bitlbee_pong:
	351	if (now - options.last_bitlbee_pong) > bitlbee_pong_timeout:
	352	dprint("Bitlbee pong timeout")
	353	# TODO is following line necessary? Should there be a options.conn.unwrap() somewhere?
	354	# options.conn.shutdown()
[53eb75c]	355	if options.conn:
	356	options.conn.close()
[e530abd]	357	options.conn = False
	358	else:
	359	options.last_bitlbee_pong = now
[eeab8bc]	360
[4ddda13]	361	if __name__=='__main__':
[8237df5]	362	options = Options()
	363	try:
[a985369]	364	opts, args = getopt.getopt(sys.argv[1:], "c:dhH:l:np:v", ["config=", "debug", "help", "host=", "log=", "nofork", "port=", "version"])
[8237df5]	365	except getopt.GetoptError:
	366	options.usage(1)
	367	for opt, arg in opts:
[5245e9d]	368	if opt in ("-c", "--config"):
	369	options.cfgpath = arg
	370	elif opt in ("-d", "--debug"):
[8237df5]	371	options.debug = True
	372	elif opt in ("-h", "--help"):
	373	options.help = True
[7e450c3]	374	elif opt in ("-H", "--host"):
	375	options.host = arg
[bcdc24b]	376	elif opt in ("-l", "--log"):
	377	options.log = arg
[8237df5]	378	elif opt in ("-n", "--nofork"):
	379	options.daemon = False
	380	elif opt in ("-p", "--port"):
[d891915]	381	options.port = int(arg)
[8237df5]	382	elif opt in ("-v", "--version"):
	383	options.version = True
	384	if options.help:
	385	options.usage(0)
	386	elif options.version:
	387	print "skyped %s" % __version__
	388	sys.exit(0)
[5245e9d]	389	# parse our config
	390	if not os.path.exists(options.cfgpath):
	391	print "Can't find configuration file at '%s'." % options.cfgpath
	392	print "Use the -c option to specify an alternate one."
	393	sys.exit(1)
	394	options.config = ConfigParser()
	395	options.config.read(options.cfgpath)
	396	options.config.username = options.config.get('skyped', 'username').split('#')[0]
	397	options.config.password = options.config.get('skyped', 'password').split('#')[0]
[7cc2c1e]	398	options.config.sslkey = os.path.expanduser(options.config.get('skyped', 'key').split('#')[0])
	399	options.config.sslcert = os.path.expanduser(options.config.get('skyped', 'cert').split('#')[0])
[d891915]	400	# hack: we have to parse the parameters first to locate the
	401	# config file but the -p option should overwrite the value from
	402	# the config file
	403	try:
	404	options.config.port = int(options.config.get('skyped', 'port').split('#')[0])
	405	if not options.port:
	406	options.port = options.config.port
	407	except NoOptionError:
	408	pass
	409	if not options.port:
	410	options.port = 2727
[5245e9d]	411	dprint("Parsing config file '%s' done, username is '%s'." % (options.cfgpath, options.config.username))
	412	if options.daemon:
[8237df5]	413	pid = os.fork()
	414	if pid == 0:
[56ae398]	415	nullin = file(os.devnull, 'r')
	416	nullout = file(os.devnull, 'w')
[8237df5]	417	os.dup2(nullin.fileno(), sys.stdin.fileno())
	418	os.dup2(nullout.fileno(), sys.stdout.fileno())
	419	os.dup2(nullout.fileno(), sys.stderr.fileno())
	420	else:
	421	print 'skyped is started on port %s, pid: %d' % (options.port, pid)
	422	sys.exit(0)
[d891915]	423	else:
	424	dprint('skyped is started on port %s' % options.port)
[c15f71a]	425	try:
[3953172]	426	skype = SkypeApi()
[8b3beef]	427	except Skype4Py.SkypeAPIError, s:
[c15f71a]	428	sys.exit("%s. Are you sure you have started Skype?" % s)
[e530abd]	429	while 1:
	430	options.conn = False
[d45adcf]	431	options.lock = threading.Lock()
[e530abd]	432	server(options.host, options.port, skype)

Note: See TracBrowser for help on using the repository browser.

Download in other formats: