source: protocols/skype/skyped.py @ 370899f

Last change on this file since 370899f was 43b1cd7, checked in by Miklos Vajna <vmiklos@…>, at 2011-04-12T00:10:57Z

Merge bitlbee-skype into bitlbee
  • Property mode set to 100644
File size: 14.1 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        sock = socket.socket()
183        sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
184        sock.bind((host, port))
185        sock.listen(1)
186        if hasgobject:
187                gobject.io_add_watch(sock, gobject.IO_IN, listener)
188        else:
189                dprint("Waiting for connection...")
190                listener(sock, skype)
191
192def listener(sock, skype):
193        global options
194        if not hasgobject:
195                if not(wait_for_lock(options.lock, 3, 10, "listener")): return False
196        rawsock, addr = sock.accept()
197        options.conn = ssl.wrap_socket(rawsock,
198                server_side=True,
199                certfile=options.config.sslcert,
200                keyfile=options.config.sslkey,
201                ssl_version=ssl.PROTOCOL_TLSv1)
202        if hasattr(options.conn, 'handshake'):
203                try:
204                        options.conn.handshake()
205                except Exception:
206                        if not hasgobject:
207                                options.lock.release()
208                        dprint("Warning, handshake failed, closing connection.")
209                        return False
210        ret = 0
211        try:
212                line = options.conn.recv(1024)
213                if line.startswith("USERNAME") and line.split(' ')[1].strip() == options.config.username:
214                        ret += 1
215                line = options.conn.recv(1024)
216                if line.startswith("PASSWORD") and hashlib.sha1(line.split(' ')[1].strip()).hexdigest() == options.config.password:
217                        ret += 1
218        except Exception, s:
219                dprint("Warning, receiving 1024 bytes failed (%s)." % s)
220                options.conn.close()
221                if not hasgobject:
222                        options.conn = False
223                        options.lock.release()
224                return False
225        if ret == 2:
226                dprint("Username and password OK.")
227                options.conn.send("PASSWORD OK\n")
228                if hasgobject:
229                        gobject.io_add_watch(options.conn, gobject.IO_IN, input_handler)
230                else:
231                        options.lock.release()
232                        serverloop(options, skype)
233                return True
234        else:
235                dprint("Username and/or password WRONG.")
236                options.conn.send("PASSWORD KO\n")
237                if not hasgobject:
238                        options.conn.close()
239                        options.conn = False
240                        options.lock.release()
241                return False
242
243def dprint(msg):
244        from time import strftime
245        global options
246
247        now = strftime("%Y-%m-%d %H:%M:%S")
248
249        if options.debug:
250                try:
251                        print now + ": " + msg
252                except Exception, s:
253                        try:
254                                sanitized = msg.encode("ascii", "backslashreplace")
255                        except Error, s:
256                                try:
257                                        sanitized = "hex [" + msg.encode("hex") + "]"
258                                except Error, s:
259                                        sanitized = "[unable to print debug message]"
260                        print now + "~=" + sanitized
261                sys.stdout.flush()
262        if options.log:
263                sock = open(options.log, "a")
264                sock.write("%s: %s\n" % (now, msg))
265                sock.close()
266
267class SkypeApi:
268        def __init__(self):
269                self.skype = Skype4Py.Skype()
270                self.skype.OnNotify = self.recv
271                self.skype.Client.Start()
272
273        def recv(self, msg_text):
274                global options
275                if msg_text == "PONG":
276                        return
277                if "\n" in msg_text:
278                        # crappy skype prefixes only the first line for
279                        # multiline messages so we need to do so for the other
280                        # lines, too. this is something like:
281                        # 'CHATMESSAGE id BODY first line\nsecond line' ->
282                        # 'CHATMESSAGE id BODY first line\nCHATMESSAGE id BODY second line'
283                        prefix = " ".join(msg_text.split(" ")[:3])
284                        msg_text = ["%s %s" % (prefix, i) for i in " ".join(msg_text.split(" ")[3:]).split("\n")]
285                else:
286                        msg_text = [msg_text]
287                for i in msg_text:
288                        try:
289                                # Internally, BitlBee always uses UTF-8 and encodes/decodes as
290                                # necessary to communicate with the IRC client; thus send the
291                                # UTF-8 it expects
292                                e = i.encode('UTF-8')
293                        except:
294                                # Should never happen, but it's better to send difficult to
295                                # read data than crash because some message couldn't be encoded
296                                e = i.encode('ascii', 'backslashreplace')
297                        if options.conn:
298                                dprint('<< ' + e)
299                                try:
300                                        send(options.conn, e + "\n")
301                                except Exception, s:
302                                        dprint("Warning, sending '%s' failed (%s)." % (e, s))
303                                        if options.conn: options.conn.close()
304                                        options.conn = False
305                        else:
306                                dprint('-- ' + e)
307
308        def send(self, msg_text):
309                if not len(msg_text) or msg_text == "PONG":
310                        if msg_text == "PONG":
311                                options.last_bitlbee_pong = time.time()
312                        return
313                try:
314                        # Internally, BitlBee always uses UTF-8 and encodes/decodes as
315                        # necessary to communicate with the IRC client; thus decode the
316                        # UTF-8 it sent us
317                        e = msg_text.decode('UTF-8')
318                except:
319                        # Should never happen, but it's better to send difficult to read
320                        # data to Skype than to crash
321                        e = msg_text.decode('ascii', 'backslashreplace')
322                dprint('>> ' + e)
323                try:
324                        c = self.skype.Command(e, Block=True)
325                        self.skype.SendCommand(c)
326                        self.recv(c.Reply)
327                except Skype4Py.SkypeError:
328                        pass
329                except Skype4Py.SkypeAPIError, s:
330                        dprint("Warning, sending '%s' failed (%s)." % (e, s))
331
332class Options:
333        def __init__(self):
334                self.cfgpath = os.path.join(os.environ['HOME'], ".skyped", "skyped.conf")
335                # for backwards compatibility
336                self.syscfgpath = "/usr/local/etc/skyped/skyped.conf"
337                if os.path.exists(self.syscfgpath):
338                        self.cfgpath = self.syscfgpath
339                self.daemon = True
340                self.debug = False
341                self.help = False
342                self.host = "0.0.0.0"
343                self.log = None
344                self.port = None
345                self.version = False
346                # well, this is a bit hackish. we store the socket of the last connected client
347                # here and notify it. maybe later notify all connected clients?
348                self.conn = None
349                # this will be read first by the input handler
350                self.buf = None
351
352
353        def usage(self, ret):
354                print """Usage: skyped [OPTION]...
355
356skyped is a daemon that acts as a tcp server on top of a Skype instance.
357
358Options:
359        -c      --config        path to configuration file (default: %s)
360        -d      --debug         enable debug messages
361        -h      --help          this help
362        -H      --host          set the tcp host (default: %s)
363        -l      --log           set the log file in background mode (default: none)
364        -n      --nofork        don't run as daemon in the background
365        -p      --port          set the tcp port (default: %s)
366        -v      --version       display version information""" % (self.cfgpath, self.host, self.port)
367                sys.exit(ret)
368
369def serverloop(options, skype):
370        timeout = 1; # in seconds
371        skype_ping_period = 5
372        bitlbee_ping_period = 10
373        bitlbee_pong_timeout = 30
374        now = time.time()
375        skype_ping_start_time = now
376        bitlbee_ping_start_time = now
377        options.last_bitlbee_pong = now
378        in_error = []
379        handler_ok = True
380        while (len(in_error) == 0) and handler_ok and options.conn:
381                ready_to_read, ready_to_write, in_error = \
382                        select.select([options.conn], [], [options.conn], \
383                                timeout)
384                now = time.time()
385                handler_ok = len(in_error) == 0
386                if (len(ready_to_read) == 1) and handler_ok:
387                        handler_ok = input_handler(ready_to_read.pop())
388                        # don't ping bitlbee/skype if they already received data
389                        now = time.time() # allow for the input_handler to take some time
390                        bitlbee_ping_start_time = now
391                        skype_ping_start_time = now
392                        options.last_bitlbee_pong = now
393                if (now - skype_ping_period > skype_ping_start_time) and handler_ok:
394                        handler_ok = skype_idle_handler(skype)
395                        skype_ping_start_time = now
396                if now - bitlbee_ping_period > bitlbee_ping_start_time:
397                        handler_ok = bitlbee_idle_handler(skype)
398                        bitlbee_ping_start_time = now
399                        if options.last_bitlbee_pong:
400                                if (now - options.last_bitlbee_pong) > bitlbee_pong_timeout:
401                                        dprint("Bitlbee pong timeout")
402                                        # TODO is following line necessary? Should there be a options.conn.unwrap() somewhere?
403                                        # options.conn.shutdown()
404                                        if options.conn:
405                                                options.conn.close()
406                                        options.conn = False
407                        else:
408                                options.last_bitlbee_pong = now
409
410if __name__=='__main__':
411        options = Options()
412        try:
413                opts, args = getopt.getopt(sys.argv[1:], "c:dhH:l:np:v", ["config=", "debug", "help", "host=", "log=", "nofork", "port=", "version"])
414        except getopt.GetoptError:
415                options.usage(1)
416        for opt, arg in opts:
417                if opt in ("-c", "--config"):
418                        options.cfgpath = arg
419                elif opt in ("-d", "--debug"):
420                        options.debug = True
421                elif opt in ("-h", "--help"):
422                        options.help = True
423                elif opt in ("-H", "--host"):
424                        options.host = arg
425                elif opt in ("-l", "--log"):
426                        options.log = arg
427                elif opt in ("-n", "--nofork"):
428                        options.daemon = False
429                elif opt in ("-p", "--port"):
430                        options.port = int(arg)
431                elif opt in ("-v", "--version"):
432                        options.version = True
433        if options.help:
434                options.usage(0)
435        elif options.version:
436                print "skyped %s" % __version__
437                sys.exit(0)
438        # parse our config
439        if not os.path.exists(options.cfgpath):
440                print "Can't find configuration file at '%s'." % options.cfgpath
441                print "Use the -c option to specify an alternate one."
442                sys.exit(1)
443        options.config = ConfigParser()
444        options.config.read(options.cfgpath)
445        options.config.username = options.config.get('skyped', 'username').split('#')[0]
446        options.config.password = options.config.get('skyped', 'password').split('#')[0]
447        options.config.sslkey = os.path.expanduser(options.config.get('skyped', 'key').split('#')[0])
448        options.config.sslcert = os.path.expanduser(options.config.get('skyped', 'cert').split('#')[0])
449        # hack: we have to parse the parameters first to locate the
450        # config file but the -p option should overwrite the value from
451        # the config file
452        try:
453                options.config.port = int(options.config.get('skyped', 'port').split('#')[0])
454                if not options.port:
455                        options.port = options.config.port
456        except NoOptionError:
457                pass
458        if not options.port:
459                options.port = 2727
460        dprint("Parsing config file '%s' done, username is '%s'." % (options.cfgpath, options.config.username))
461        if options.daemon:
462                pid = os.fork()
463                if pid == 0:
464                        nullin = file(os.devnull, 'r')
465                        nullout = file(os.devnull, 'w')
466                        os.dup2(nullin.fileno(), sys.stdin.fileno())
467                        os.dup2(nullout.fileno(), sys.stdout.fileno())
468                        os.dup2(nullout.fileno(), sys.stderr.fileno())
469                else:
470                        print 'skyped is started on port %s, pid: %d' % (options.port, pid)
471                        sys.exit(0)
472        else:
473                dprint('skyped is started on port %s' % options.port)
474        if hasgobject:
475                server(options.host, options.port)
476        try:
477                skype = SkypeApi()
478        except Skype4Py.SkypeAPIError, s:
479                sys.exit("%s. Are you sure you have started Skype?" % s)
480        if hasgobject:
481                gobject.timeout_add(2000, skype_idle_handler, skype)
482                gobject.timeout_add(60000, bitlbee_idle_handler, skype)
483                gobject.MainLoop().run()
484        else:
485                while 1:
486                        options.conn = False
487                        options.lock = threading.Lock()
488                        server(options.host, options.port, skype)
Note: See TracBrowser for help on using the repository browser.