source: protocols/skype/skyped.py @ d717020

Last change on this file since d717020 was 2ff0f37, checked in by Miklos Vajna <vmiklos@…>, at 2011-06-29T23:25:02Z

skyped: user configuration should have priority
  • Property mode set to 100644
File size: 14.2 KB
Line 
1#!/usr/bin/env python2.7
2#
3#   skyped.py
4# 
5#   Copyright (c) 2007, 2008, 2009, 2010, 2011 by Miklos Vajna <vmiklos@frugalware.org>
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
23import sys
24import os
25import signal
26import locale
27import time
28import socket
29import getopt
30import Skype4Py
31import hashlib
32from ConfigParser import ConfigParser, NoOptionError
33from traceback import print_exception
34import ssl
35
36__version__ = "0.1.1"
37
38try:
39        import gobject
40        hasgobject = True
41except ImportError:
42        import select
43        import threading
44        hasgobject = False
45
46def eh(type, value, tb):
47        global options
48
49        if type != KeyboardInterrupt:
50                print_exception(type, value, tb)
51        if hasgobject:
52                gobject.MainLoop().quit()
53        if options.conn:
54                options.conn.close()
55        # shut down client if it's running
56        try:
57                skype.skype.Client.Shutdown()
58        except NameError:
59                pass
60        sys.exit("Exiting.")
61
62sys.excepthook = eh
63
64def wait_for_lock(lock, timeout_to_print, timeout, msg):
65        start = time.time()
66        locked = lock.acquire(0)
67        while not(locked):
68                time.sleep(0.5)
69                if timeout_to_print and (time.time() - timeout_to_print > start):
70                        dprint("%s: Waited %f seconds" % \
71                                        (msg, time.time() - start))
72                        timeout_to_print = False
73                if timeout and (time.time() - timeout > start):
74                        dprint("%s: Waited %f seconds, giving up" % \
75                                        (msg, time.time() - start))
76                        return False
77                locked = lock.acquire(0)
78        return True
79
80def input_handler(fd, io_condition = None):
81        global options
82        global skype
83        if options.buf:
84                for i in options.buf:
85                        skype.send(i.strip())
86                options.buf = None
87                if not hasgobject:
88                        return True
89        else:
90                if not hasgobject:
91                        close_socket = False
92                        if wait_for_lock(options.lock, 3, 10, "input_handler"):
93                                try:
94                                                input = fd.recv(1024)
95                                                options.lock.release()
96                                except Exception, s:
97                                        dprint("Warning, receiving 1024 bytes failed (%s)." % s)
98                                        fd.close()
99                                        options.conn = False
100                                        options.lock.release()
101                                        return False
102                                for i in input.split("\n"):
103                                        if i.strip() == "SET USERSTATUS OFFLINE":
104                                                close_socket = True
105                                        skype.send(i.strip())
106                        return not(close_socket)
107                try:
108                        input = fd.recv(1024)
109                except Exception, s:
110                        dprint("Warning, receiving 1024 bytes failed (%s)." % s)
111                        fd.close()
112                        return False
113                for i in input.split("\n"):
114                        skype.send(i.strip())
115                return True
116
117def skype_idle_handler(skype):
118        try:
119                c = skype.skype.Command("PING", Block=True)
120                skype.skype.SendCommand(c)
121        except Skype4Py.SkypeAPIError, s:
122                dprint("Warning, pinging Skype failed (%s)." % (s))
123        return True
124
125def send(sock, txt):
126        global options
127        from time import sleep
128        count = 1
129        done = False
130        if hasgobject:
131                while (not done) and (count < 10):
132                        try:
133                                sock.send(txt)
134                                done = True
135                        except Exception, s:
136                                count += 1
137                                dprint("Warning, sending '%s' failed (%s). count=%d" % (txt, s, count))
138                                sleep(1)
139                if not done:
140                        options.conn.close()
141        else:
142                while (not done) and (count < 10) and options.conn:
143                        if wait_for_lock(options.lock, 3, 10, "socket send"):
144                                try:
145                                         if options.conn: sock.send(txt)
146                                         options.lock.release()
147                                         done = True
148                                except Exception, s:
149                                        options.lock.release()
150                                        count += 1
151                                        dprint("Warning, sending '%s' failed (%s). count=%d" % (txt, s, count))
152                                        sleep(1)
153                if not done:
154                        if options.conn:
155                                options.conn.close()
156                        options.conn = False
157                return done
158
159def bitlbee_idle_handler(skype):
160        global options
161        done = False
162        if options.conn:
163                try:
164                        e = "PING"
165                        done = send(options.conn, "%s\n" % e)
166                except Exception, s:
167                        dprint("Warning, sending '%s' failed (%s)." % (e, s))
168                        if hasgobject:
169                                options.conn.close()
170                        else:
171                                if options.conn: options.conn.close()
172                                options.conn = False
173                                done = False
174        if hasgobject:
175                return True
176        else:
177                return done
178        return True
179
180def server(host, port, skype = None):
181        global options
182        if ":" in host:
183                sock = socket.socket(socket.AF_INET6)
184        else:
185                sock = socket.socket()
186        sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
187        sock.bind((host, port))
188        sock.listen(1)
189        if hasgobject:
190                gobject.io_add_watch(sock, gobject.IO_IN, listener)
191        else:
192                dprint("Waiting for connection...")
193                listener(sock, skype)
194
195def listener(sock, skype):
196        global options
197        if not hasgobject:
198                if not(wait_for_lock(options.lock, 3, 10, "listener")): return False
199        rawsock, addr = sock.accept()
200        options.conn = ssl.wrap_socket(rawsock,
201                server_side=True,
202                certfile=options.config.sslcert,
203                keyfile=options.config.sslkey,
204                ssl_version=ssl.PROTOCOL_TLSv1)
205        if hasattr(options.conn, 'handshake'):
206                try:
207                        options.conn.handshake()
208                except Exception:
209                        if not hasgobject:
210                                options.lock.release()
211                        dprint("Warning, handshake failed, closing connection.")
212                        return False
213        ret = 0
214        try:
215                line = options.conn.recv(1024)
216                if line.startswith("USERNAME") and line.split(' ')[1].strip() == options.config.username:
217                        ret += 1
218                line = options.conn.recv(1024)
219                if line.startswith("PASSWORD") and hashlib.sha1(line.split(' ')[1].strip()).hexdigest() == options.config.password:
220                        ret += 1
221        except Exception, s:
222                dprint("Warning, receiving 1024 bytes failed (%s)." % s)
223                options.conn.close()
224                if not hasgobject:
225                        options.conn = False
226                        options.lock.release()
227                return False
228        if ret == 2:
229                dprint("Username and password OK.")
230                options.conn.send("PASSWORD OK\n")
231                if hasgobject:
232                        gobject.io_add_watch(options.conn, gobject.IO_IN, input_handler)
233                else:
234                        options.lock.release()
235                        serverloop(options, skype)
236                return True
237        else:
238                dprint("Username and/or password WRONG.")
239                options.conn.send("PASSWORD KO\n")
240                if not hasgobject:
241                        options.conn.close()
242                        options.conn = False
243                        options.lock.release()
244                return False
245
246def dprint(msg):
247        from time import strftime
248        global options
249
250        now = strftime("%Y-%m-%d %H:%M:%S")
251
252        if options.debug:
253                try:
254                        print now + ": " + msg
255                except Exception, s:
256                        try:
257                                sanitized = msg.encode("ascii", "backslashreplace")
258                        except Error, s:
259                                try:
260                                        sanitized = "hex [" + msg.encode("hex") + "]"
261                                except Error, s:
262                                        sanitized = "[unable to print debug message]"
263                        print now + "~=" + sanitized
264                sys.stdout.flush()
265        if options.log:
266                sock = open(options.log, "a")
267                sock.write("%s: %s\n" % (now, msg))
268                sock.close()
269
270class SkypeApi:
271        def __init__(self):
272                self.skype = Skype4Py.Skype()
273                self.skype.OnNotify = self.recv
274                self.skype.Client.Start()
275
276        def recv(self, msg_text):
277                global options
278                if msg_text == "PONG":
279                        return
280                if "\n" in msg_text:
281                        # crappy skype prefixes only the first line for
282                        # multiline messages so we need to do so for the other
283                        # lines, too. this is something like:
284                        # 'CHATMESSAGE id BODY first line\nsecond line' ->
285                        # 'CHATMESSAGE id BODY first line\nCHATMESSAGE id BODY second line'
286                        prefix = " ".join(msg_text.split(" ")[:3])
287                        msg_text = ["%s %s" % (prefix, i) for i in " ".join(msg_text.split(" ")[3:]).split("\n")]
288                else:
289                        msg_text = [msg_text]
290                for i in msg_text:
291                        try:
292                                # Internally, BitlBee always uses UTF-8 and encodes/decodes as
293                                # necessary to communicate with the IRC client; thus send the
294                                # UTF-8 it expects
295                                e = i.encode('UTF-8')
296                        except:
297                                # Should never happen, but it's better to send difficult to
298                                # read data than crash because some message couldn't be encoded
299                                e = i.encode('ascii', 'backslashreplace')
300                        if options.conn:
301                                dprint('<< ' + e)
302                                try:
303                                        send(options.conn, e + "\n")
304                                except Exception, s:
305                                        dprint("Warning, sending '%s' failed (%s)." % (e, s))
306                                        if options.conn: options.conn.close()
307                                        options.conn = False
308                        else:
309                                dprint('-- ' + e)
310
311        def send(self, msg_text):
312                if not len(msg_text) or msg_text == "PONG":
313                        if msg_text == "PONG":
314                                options.last_bitlbee_pong = time.time()
315                        return
316                try:
317                        # Internally, BitlBee always uses UTF-8 and encodes/decodes as
318                        # necessary to communicate with the IRC client; thus decode the
319                        # UTF-8 it sent us
320                        e = msg_text.decode('UTF-8')
321                except:
322                        # Should never happen, but it's better to send difficult to read
323                        # data to Skype than to crash
324                        e = msg_text.decode('ascii', 'backslashreplace')
325                dprint('>> ' + e)
326                try:
327                        c = self.skype.Command(e, Block=True)
328                        self.skype.SendCommand(c)
329                        self.recv(c.Reply)
330                except Skype4Py.SkypeError:
331                        pass
332                except Skype4Py.SkypeAPIError, s:
333                        dprint("Warning, sending '%s' failed (%s)." % (e, s))
334
335class Options:
336        def __init__(self):
337                self.cfgpath = os.path.join(os.environ['HOME'], ".skyped", "skyped.conf")
338                # fall back to system-wide settings
339                self.syscfgpath = "/usr/local/etc/skyped/skyped.conf"
340                if os.path.exists(self.syscfgpath) and not os.path.exists(self.cfgpath):
341                        self.cfgpath = self.syscfgpath
342                self.daemon = True
343                self.debug = False
344                self.help = False
345                self.host = "0.0.0.0"
346                self.log = None
347                self.port = None
348                self.version = False
349                # well, this is a bit hackish. we store the socket of the last connected client
350                # here and notify it. maybe later notify all connected clients?
351                self.conn = None
352                # this will be read first by the input handler
353                self.buf = None
354
355
356        def usage(self, ret):
357                print """Usage: skyped [OPTION]...
358
359skyped is a daemon that acts as a tcp server on top of a Skype instance.
360
361Options:
362        -c      --config        path to configuration file (default: %s)
363        -d      --debug         enable debug messages
364        -h      --help          this help
365        -H      --host          set the tcp host, supports IPv4 and IPv6 (default: %s)
366        -l      --log           set the log file in background mode (default: none)
367        -n      --nofork        don't run as daemon in the background
368        -p      --port          set the tcp port (default: %s)
369        -v      --version       display version information""" % (self.cfgpath, self.host, self.port)
370                sys.exit(ret)
371
372def serverloop(options, skype):
373        timeout = 1; # in seconds
374        skype_ping_period = 5
375        bitlbee_ping_period = 10
376        bitlbee_pong_timeout = 30
377        now = time.time()
378        skype_ping_start_time = now
379        bitlbee_ping_start_time = now
380        options.last_bitlbee_pong = now
381        in_error = []
382        handler_ok = True
383        while (len(in_error) == 0) and handler_ok and options.conn:
384                ready_to_read, ready_to_write, in_error = \
385                        select.select([options.conn], [], [options.conn], \
386                                timeout)
387                now = time.time()
388                handler_ok = len(in_error) == 0
389                if (len(ready_to_read) == 1) and handler_ok:
390                        handler_ok = input_handler(ready_to_read.pop())
391                        # don't ping bitlbee/skype if they already received data
392                        now = time.time() # allow for the input_handler to take some time
393                        bitlbee_ping_start_time = now
394                        skype_ping_start_time = now
395                        options.last_bitlbee_pong = now
396                if (now - skype_ping_period > skype_ping_start_time) and handler_ok:
397                        handler_ok = skype_idle_handler(skype)
398                        skype_ping_start_time = now
399                if now - bitlbee_ping_period > bitlbee_ping_start_time:
400                        handler_ok = bitlbee_idle_handler(skype)
401                        bitlbee_ping_start_time = now
402                        if options.last_bitlbee_pong:
403                                if (now - options.last_bitlbee_pong) > bitlbee_pong_timeout:
404                                        dprint("Bitlbee pong timeout")
405                                        # TODO is following line necessary? Should there be a options.conn.unwrap() somewhere?
406                                        # options.conn.shutdown()
407                                        if options.conn:
408                                                options.conn.close()
409                                        options.conn = False
410                        else:
411                                options.last_bitlbee_pong = now
412
413if __name__=='__main__':
414        options = Options()
415        try:
416                opts, args = getopt.getopt(sys.argv[1:], "c:dhH:l:np:v", ["config=", "debug", "help", "host=", "log=", "nofork", "port=", "version"])
417        except getopt.GetoptError:
418                options.usage(1)
419        for opt, arg in opts:
420                if opt in ("-c", "--config"):
421                        options.cfgpath = arg
422                elif opt in ("-d", "--debug"):
423                        options.debug = True
424                elif opt in ("-h", "--help"):
425                        options.help = True
426                elif opt in ("-H", "--host"):
427                        options.host = arg
428                elif opt in ("-l", "--log"):
429                        options.log = arg
430                elif opt in ("-n", "--nofork"):
431                        options.daemon = False
432                elif opt in ("-p", "--port"):
433                        options.port = int(arg)
434                elif opt in ("-v", "--version"):
435                        options.version = True
436        if options.help:
437                options.usage(0)
438        elif options.version:
439                print "skyped %s" % __version__
440                sys.exit(0)
441        # parse our config
442        if not os.path.exists(options.cfgpath):
443                print "Can't find configuration file at '%s'." % options.cfgpath
444                print "Use the -c option to specify an alternate one."
445                sys.exit(1)
446        options.config = ConfigParser()
447        options.config.read(options.cfgpath)
448        options.config.username = options.config.get('skyped', 'username').split('#')[0]
449        options.config.password = options.config.get('skyped', 'password').split('#')[0]
450        options.config.sslkey = os.path.expanduser(options.config.get('skyped', 'key').split('#')[0])
451        options.config.sslcert = os.path.expanduser(options.config.get('skyped', 'cert').split('#')[0])
452        # hack: we have to parse the parameters first to locate the
453        # config file but the -p option should overwrite the value from
454        # the config file
455        try:
456                options.config.port = int(options.config.get('skyped', 'port').split('#')[0])
457                if not options.port:
458                        options.port = options.config.port
459        except NoOptionError:
460                pass
461        if not options.port:
462                options.port = 2727
463        dprint("Parsing config file '%s' done, username is '%s'." % (options.cfgpath, options.config.username))
464        if options.daemon:
465                pid = os.fork()
466                if pid == 0:
467                        nullin = file(os.devnull, 'r')
468                        nullout = file(os.devnull, 'w')
469                        os.dup2(nullin.fileno(), sys.stdin.fileno())
470                        os.dup2(nullout.fileno(), sys.stdout.fileno())
471                        os.dup2(nullout.fileno(), sys.stderr.fileno())
472                else:
473                        print 'skyped is started on port %s, pid: %d' % (options.port, pid)
474                        sys.exit(0)
475        else:
476                dprint('skyped is started on port %s' % options.port)
477        if hasgobject:
478                server(options.host, options.port)
479        try:
480                skype = SkypeApi()
481        except Skype4Py.SkypeAPIError, s:
482                sys.exit("%s. Are you sure you have started Skype?" % s)
483        if hasgobject:
484                gobject.timeout_add(2000, skype_idle_handler, skype)
485                gobject.timeout_add(60000, bitlbee_idle_handler, skype)
486                gobject.MainLoop().run()
487        else:
488                while 1:
489                        options.conn = False
490                        options.lock = threading.Lock()
491                        server(options.host, options.port, skype)
Note: See TracBrowser for help on using the repository browser.