source: skype/skyped.py @ 1130561

Last change on this file since 1130561 was 1130561, checked in by Philippe Crama <pcfeb0009@…>, at 2010-12-28T13:04:34Z

Check that connection is still valid before sending/retrying

Since another thread might close the socket, make sure after the
lock is acquired that the connection is still valid.

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