app.py 19 KB
Newer Older
okhin's avatar
okhin committed
1
2
3
#!/usr/bin/env python

import sqlite3
okhin's avatar
okhin committed
4
5
6
import datetime
import uuid
import json
7
8
9
import logging
import concurrent.futures
import asyncio
10
import re
11
12
import configparser
import argparse
13
14
import os.path
import sys
okhin's avatar
okhin committed
15
from operator import itemgetter
okhin's avatar
okhin committed
16
17

import jwt
18
19
import websockets
import requests
20
21
from bottle import request, abort, Bottle, JSONPlugin
from bottle_sqlite import SQLitePlugin
22
from daemonize import Daemonize
23

24
config = configparser.ConfigParser()
25
26
27
28
29
30
31
application = app = Bottle(autojson=False)
app.install(SQLitePlugin(dbfile='call.db'))
app.install(JSONPlugin(json_dumps=lambda s: json.dumps(s, cls=PiphoneJSONEncoder)))

threads = concurrent.futures.ThreadPoolExecutor()
loop = asyncio.get_event_loop()
db = sqlite3.connect('call.db')
okhin's avatar
okhin committed
32

33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
running = False
ws = None
debug = True

# Loggers
handler = logging.FileHandler('app.log')
phone_logger = logging.getLogger('piphone')
phone_logger.addHandler(handler)
phone_logger.setLevel(logging.DEBUG)
ws_logger = logging.getLogger('asterisk')
ws_logger.addHandler(handler)
ws_logger.setLevel(logging.DEBUG)
bottle_logger = logging.getLogger('bottle')
bottle_logger.addHandler(handler)
bottle_logger.setLevel(logging.DEBUG)
48
49
50
51
52
53
54
55
56
57
58
59
60
61

class PiphoneJSONEncoder(json.JSONEncoder):
    def default(self, obj):
        """
        We need to implement this to be able to JSONEncode
        """
        if isinstance(obj, Call):
            return {  'caller': obj.caller
                , 'callee': obj.callee
                , 'callid': obj.id
                , 'url': obj.url()
                , 'history': obj.history
                , 'owner': obj.owner }
        else:
62
            return json.JSONEncoder.default(self, obj)
okhin's avatar
okhin committed
63

64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
def authenticated(f):
    '''
    We need a decorator to check if our query is authenticated.
    We will store an API key and SECRET in ur database, the client
    needs to have both of them.
    He must then send us a JWT token with an API claim in the payload.
    The JWT token must be encoded and signed with the SECRET. If the
    token is bad, we return a 403.
    '''
    def wrapped(db, *args, **kwargs):
        # Let's get the JWT token. It should be a params (from get or post or whatev')
        bottle_logger.debug("Authentication: {}".format([':'.join([key, request.params[key]]) for key in request.params],))
        if 'token' not in request.params:
            bottle_logger.error("No token found in the params")
            abort(401, "No token found in the query")
        # We want the api id in the params to.
        if 'api' not in request.params:
            bottle_logger.error("No api id found in the params")
            abort(401, "No api id found in the params")
        # Now, let's get the token on our side
        try:
            results = db.execute('SELECT token FROM users WHERE api = ?', (request.params['api'],)).fetchall()
            assert len(results) == 1
            token = results[0][0]
            auth_token = jwt.decode(request.params['token'], token)
            assert auth_token['api'] == request.params['api']
            for key in auth_token:
                request.params[key] = auth_token[key]
        except (jwt.exceptions.InvalidTokenError, AssertionError) as e:
            bottle_logger.error("Access refused")
            bottle_logger.exception(e)
            abort(403, e)
        except Exception as e:
            abort(500, e)
        return f(db, *args, **kwargs)
    return wrapped

def connected(f):
    '''
    This is a decorator used to check if we are connected to a websocket or not. If we're not
    We're returning 500 error.
    '''
    def wrapped(db, *args, **kwargs):
        if isinstance(ws, websockets.client.WebSocketClientProtocol):
            if ws.open == True:
                return f(db, *args, **kwargs)
        ws_logger.error("Websocket connection is closed")
        abort(500, "Websocket isn't running")
    return wrapped

okhin's avatar
okhin committed
114
115
116
117
118
119
120
121
122
123
124
125
126
127
def sanitize_phonenumber(number):
    """
    This function is used to sanitize a phone number.
    If it starts with a +, it will be removed and replaced by 00.
    Any chars who do notbelong to [0-9] will be stripped.
    If the number doesn't starts with 00, a TypeError will be raised
    """
    if number[0] == '+':
        number = '00' + number[1:]
    number = ''.join([c for c in number if c in '0123456789'])
    if not number.startswith('00'):
        raise TypeError('{} is not a valid international number, it should start with 00')
    return number

128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
async def hold_bridge():
    '''
    We will create a bridge that will be used to park caller waiting for callee to join.
    It will play a song in a loop.
    '''
    payload = {}
    payload['app'] = 'piphone'
    payload['api_key'] = 'piphone:passpiphone'
    payload['mode'] = 'holding'
    try:
        r = requests.post('http://185.34.33.12:8088/ari/bridges/piphone-moh', data=payload)
        r.raise_for_status()
        payload['mohClass'] = 'piphone'
        r = requests.post('http://185.34.33.12:8088/ari/bridges/piphone-moh/moh', data=payload)
        r.raise_for_status()
    except Exception as e:
        phone_logger.error("Cannot start 'on hold' bridge")
        phone_logger.exception(e)
        raise e

async def listen():
    '''
    Start listening on the websocket
    '''
    global running
    global ws
    ws = await websockets.connect('ws://185.34.33.12:8088/ari/events?app=piphone&api_key=piphone:passpiphone')
    ws_logger.debug('Websocket connected: {}'.format(type(ws)))
    await hold_bridges()
    while running == True:
        try:
            event = await ws.recv()
            # Let's call the applications function
            await dispatch(json.loads(event))
        except websockets.exceptions.ConnectionClosed as e:
            ws_logger.warning("Connexion closed")
            ws_logger.exception(e)
            running = False
            ws.close()
            return
        except Exception as e:
            ws_logger.exception(e)
            continue
    ws.close()

async def dispatch(self, event):
    """
    Let's work on our events. Parse them and do request on the ARI API. Event is
    a dict loaded from JSON.
    """
    ws_logger.debug('Event received: {}'.format(event,))
    # Let's get the call ID, the call id isthe channel id minus the last -part.
    if 'channel' not in event:
        return
    call_id = re.sub('-\d+$', '', event['channel']['id'])
    call = Call.load(call_id, self.db)
    call.event_handler(event)

186
class Call(object):
okhin's avatar
okhin committed
187
188
189
    """
    This Class is used to manage operatiosn on a call, to print it and dump it.
    """
190
    history = []
191
    actions = {'Created': 'call_caller'
192
193
        , 'ChannelStateChange': 'change'
        , 'ChannelDtmfReceived': 'dtmf'}
okhin's avatar
okhin committed
194

195
    def __init__(self, caller, callee, owner, callid=None, db=None):
okhin's avatar
okhin committed
196
197
198
199
        try:
            self.caller = caller
            self.callee = callee
            self.owner = owner
200
            if callid == None:
201
202
                self.id = str(uuid.uuid4())
                self.db = db
203
                self.event_handler({'type': 'Created', 'timestamp': datetime.datetime.now().isoformat(), 'channel': {'id': 'Init'}})
204
205
            else:
                self.id = callid
okhin's avatar
okhin committed
206
        except Exception as e:
207
            phone_logger.exception(e)
okhin's avatar
okhin committed
208
209
210
211
212
            raise e

    def url(self):
        return ''.join(['/calls/', self.id])

okhin's avatar
okhin committed
213
214
215
216
    def state(self):
        sort = sorted(self.history, reverse=True, key=itemgetter(1))
        return sort[0][0]

okhin's avatar
okhin committed
217
218
    @classmethod
    def load(cls, callid, db):
219
        phone_logger.debug("Loading call {}".format(callid,))
okhin's avatar
okhin committed
220
        try:
221
            results = db.execute('SELECT caller, callee, owner, callid, history FROM calls WHERE callid = ?;', (callid,))
okhin's avatar
okhin committed
222
            result = results.fetchone()
223
224
            assert len(result) == 5
            object = cls(result[0], result[1], result[2], result[3])
okhin's avatar
okhin committed
225
            object.history = json.loads(result[4])
226
            object.db = db
okhin's avatar
okhin committed
227
            return object
228
        except Exception as e:
229
            phone_logger.exception(e)
230
            raise e
okhin's avatar
okhin committed
231

232
    def update(self, new_state):
233
        '''
234
        Let's update the state of the call. new_state is a tuple in the form (newstate, timestamp,)
235
        '''
236
        phone_logger.debug("Got a new state: {}".format(new_state,))
237
238
        self.history.append(new_state)
        self.save()
239
240
241
242
243
244

    def event_handler(self, event):
        '''
        There's a new event related to our call
        '''
        state = event['type']
245
        if state in self.actions:
246
            getattr(self, self.actions[state])(event=event)
247

okhin's avatar
okhin committed
248
249
250
251
252
    def dtmf(self, event):
        '''
        We received a DTMF sequence
        '''
        try:
253
            assert self.state().startswith('Up')
okhin's avatar
okhin committed
254
            # The only thing we want to do is to call the callee if we press 1
255
256
257
258
259
260
261
262
263
            if event['digit'] != '1':
                return
            # Now, we're connectig the other side
            # But first we should stop the playback
            results = self.db.execute('SELECT login_ari, pass_ari FROM users WHERE api = ?', (self.owner,))
            login_ari, token_ari = results.fetchone()
            payload = {}
            payload['app'] = 'piphone'
            payload['api_key'] = ':'.join([login_ari, token_ari])
264
            phone_logger.debug('Stopping the playback currently running'.format(payload,))
265
266
            # We're stoping the playback, with the same ID as the channel, to keep track of it
            r = requests.delete('http://185.34.33.12:8088/ari/playbacks/{0}'.format(event['channel']['id']), data=payload)
okhin's avatar
okhin committed
267
268
            # Now we're moving the channel to the MOH Bridge
            payload['channel'] = event['channel']['id']
269
            phone_logger.debug('Moving call {} to the garage'.format(payload['channel']))
okhin's avatar
okhin committed
270
            r = requests.post('http://185.34.33.12:8088/ari/bridges/piphone-moh/addChannel', data=payload)
271
            # Next we need to originate a call to the other side
272
            phone_logger.info('Will now connect {} to {}'.format(self.caller, self.callee,))
273
            payload['endpoint'] = 'SIP/' + sanitize_phonenumber(self.callee) + '@forfait-kwaoo'
274
            phone_logger.debug('Preparing to send a request to the ARI with payload {}'.format(payload,))
275
            r = requests.post('http://185.34.33.12:8088/ari/channels/{}-{}'.format(self.id, sanitize_phonenumber(self.callee),), data=payload)
okhin's avatar
okhin committed
276
        except AssertionError as e:
277
            logging.error("Received a DTMF sequence out le being in  a '{}' state, ignoring: {}".format(self.state(), event['digit']))
okhin's avatar
okhin committed
278

279
280
281
282
    def change(self, event):
        '''
        Let's change the state of the call
        '''
283
        self.update((':'.join([event['channel']['state'], event['channel']['id'].split('-')[-1]]), event['timestamp'],))
284
        phone_logger.info("New state for call {}: {}".format(event['channel']['id'], event['channel']['state']))
okhin's avatar
okhin committed
285
        # We now need to take action according to our new state
okhin's avatar
okhin committed
286
287
        results = self.db.execute('SELECT login_ari, pass_ari FROM users WHERE api = ?', (self.owner,))
        login_ari, token_ari = results.fetchone()
okhin's avatar
okhin committed
288
        if event['channel']['state'] == 'Up':
289
290
            # Are we the caller orthe callee?
            if event['channel']['id'].endswith(self.callee):
okhin's avatar
okhin committed
291
292
293
294
295
                # Step 1 create a bridge
                payload = {}
                payload['app'] = 'piphone'
                payload['api_key'] = ':'.join([login_ari, token_ari])
                payload['type'] = 'mixing'
296
                phone_logger.debug("Creating a bridges to connect {} to {}".format(self.caller, self.callee,))
okhin's avatar
okhin committed
297
298
299
                r = requests.post('http://185.34.33.12:8088/ari/bridges/{}'.format(self.id), data=payload)
                # Step 2, moving channels
                payload['channel'] = ",".join([self.id + '-' + self.caller, self.id + '-' + self.callee])
300
                phone_logger.debug("Moving channels to the created bridge: {}".format(payload['channel']))
okhin's avatar
okhin committed
301
                r = requests.post('http://185.34.33.12:8088/ari/bridges/{}/addChannel'.format(self.id), data=payload)
302
                phone_logger.info("Call now fully connected: {} <-> {}".format(self.caller, self.callee))
303
                return
okhin's avatar
okhin committed
304
305
306
307
308
309
310
311
312
            # Call is being picked up, we want to play a song
            payload = {}
            try:
                payload['app'] = 'piphone'
                payload['api_key'] = ':'.join([login_ari, token_ari])
                payload['media'] = 'sound:mario'
                payload['lang'] = 'en_US'
                logging.debug('Preparing to send a request to the ARI with payload {}'.format(payload,))
                # We're starting a playback, with the same ID as the channel, to keep track of it
313
                r = requests.post('http://185.34.33.12:8088/ari/channels/{0}/play/{0}'.format(event['channel']['id']), data=payload)
okhin's avatar
okhin committed
314
315
                logging.debug("Now playing a sound on channel {}".format(self.id))
            except Exception as e:
316
                logging.exception(e)
okhin's avatar
okhin committed
317
                raise e
318
319

    def call_caller(self, event):
320
        '''
okhin's avatar
okhin committed
321
322
        Let's call the caller. It's a simple originate. We will also check if the MoH bridge is ready,
        because it will be used to store people in it waiting for the callee to pick up the phone.
323

okhin's avatar
okhin committed
324
        The bridge needed to connect the calls together will be created later.
325
        '''
326
327
328
329
330
331
        self.update((':'.join([event['type'], event['channel']['id'].split('-')[-1]]), event['timestamp'],))
        results = self.db.execute('SELECT login_ari, pass_ari FROM users WHERE api = ?', (self.owner,))
        login_ari, token_ari = results.fetchone()
        payload = {}
        payload['app'] = 'piphone'
        payload['api_key'] = ':'.join([login_ari, token_ari])
okhin's avatar
okhin committed
332
        # We want to check if the moh bridge is opened
333
        try:
okhin's avatar
okhin committed
334
335
336
337
338
            r = requests.get('http://185.34.33.12:8088/ari/bridges/{}-moh'.format(payload['app']), data=payload)
            r.raise_for_status()
        except HTTPError as e:
            # The bridge dos not exist
            logging.error("The Hold bridges does not exists")
339
340
341
342
343
344
            raise e

        # Now, let's create the channel
        payload = {}
        payload['app'] = 'piphone'
        payload['api_key'] = ':'.join([login_ari, token_ari])
345
346
347
        try:
            payload['endpoint'] = 'SIP/' + sanitize_phonenumber(self.caller) + '@forfait-kwaoo'
            logging.debug('Preparing to send a request to the ARI with payload {}'.format(payload,))
348
            r = requests.post('http://185.34.33.12:8088/ari/channels/{}-{}'.format(self.id, sanitize_phonenumber(self.caller),), data=payload)
349
        except Exception as e:
350
351
            logging.exception(e)
            raise e
352
353

    def save(self):
354
355
356
        '''
        Save the Call to database.
        '''
357
        phone_logger.debug("Saving call {}: {}".format(self.id, json.dumps(self, cls=PiphoneJSONEncoder)))
358
359
360
361
362
363
        try:
            self.db.execute('''INSERT OR REPLACE INTO calls (caller, callee, owner, callid, history)
                VALUES (?, ?, ?, ?, ?) '''
                , (self.caller, self.callee, self.owner, self.id, json.dumps(self.history)))
            self.db.commit()
        except Exception as e:
364
            phone_logger.exception(e)
365
            raise e
366

367
368
369
370
371
372
def start():
    global running
    running = True
    threads.submit(app.run)
    loop.run_until_complete(listen())

373
374
def stop():
    global running
375
    running = False
376
377
378
    ws.close()
    loop.close()
    threads.shutdown(wait=False)
379
    sys.exit(0)
okhin's avatar
okhin committed
380

381
@app.get('/calls/<callid>')
382
@app.get('/calls/')
okhin's avatar
okhin committed
383
@authenticated
384
@connected
385
def calls(db, callid=None):
okhin's avatar
okhin committed
386
387
388
389
    """
    Return the list of calls associated to the connected user.
    The call has a status, caller, callee and history (status change+timestamp)
    """
390
    bottle_logger.debug("GET {}".format(request.fullpath))
391
392
393
394
395
396
    if callid == None:
        try:
            results = db.execute('SELECT callid FROM calls WHERE owner = ?;', (request.params['api'],))
            calls = []
            for row in results.fetchall():
                call = Call.load(row[0], db)
397
                bottle_logger.debug("Call fetched: {}".format(json.dumps(call, cls=PiphoneJSONEncoder)))
398
399
400
401
                calls.append(call)
            head = {'call': request.fullpath, 'user': request.params['api'], 'hits': len(calls)}
            return {'head': head, 'data': calls}
        except Exception as e:
402
            bottle_logger.exception(e)
403
404
405
406
407
408
            abort(500, "Exception")
    # We first need to check if we can access the callid we asked for
    try:
        results = db.execute('SELECT callid FROM calls WHERE owner = ? AND callid = ? ;'
                , (request.params['api'], callid,))
        rows = results.fetchall()
409
        bottle_logger.debug("Found {} results: {}".format(len(rows), rows))
410
411
412
413
414
        assert len(rows) == 1
        call = Call.load(callid, db)
        head = {'call': call.url(), 'user': request.params['api'], 'hits': 1}
        return {'head': head, 'data': call}
    except AssertionError as e:
415
416
        bottle_logger.debug("Not exactly one results found, this is an issue")
        bottle_logger.error("Unauthorized access to call {} from user {}".format(callid, request.params['api']))
417
418
        abort(403, "You do not have the authorization to get this call")
    except Exception as e:
419
420
        bottle_logger.debug("Exception catched: {}".format(e,))
        bottle_logger.error("Call not found {}".format(callid,))
421
422
423
424
        abort(404, "This call does not exist")

@app.post('/calls/')
@app.post('/calls/<callid>')
425
@authenticated
426
@connected
427
def originate(db, callid=None):
428
    bottle_logger.debug("POST {}".format(request.fullpath))
429
430
431
432
433
    try:
        if callid is not None:
            call = Call(request.params['caller'], request.params['callee'], request.params['api'], callid=request.params['callid'], db=db)
        else:
            call = Call(request.params['caller'], request.params['callee'], request.params['api'], db=db)
434
        bottle_logger.debug("Originate a call: {}".format(json.dumps(call, cls=PiphoneJSONEncoder)))
435
        head = {'call': call.url()
436
437
            , 'user': request.params['api']
            , 'hits': 1}
438
439
        return {'header': head, 'data': call}
    except Exception as e:
440
441
        bottle_logger.debug("Missing params : {}".format([p for p in request.params],))
        bottle_logger.exception(e)
442
        abort(400, "Missing or incorrect fields, the call cannot be processed")
443
444

if __name__ == '__main__':
445
446
447
    arg_parser = argparse.ArgumentParser(description='Manage the SIP Backend for the piphone')
    arg_parser.add_argument('-c', '--config', help="Config file")
    arg_parser.parse_args()
448
    try:
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
        logging.debug("Let's use {} as a config file".config(arg_parser.config,))
        config.read(arg_parser.config)
    except AttributeError:
        try:
            if os.path.isfile('config.ini'):
                logging.debug("Let's use config.ini as a config file")
                config.read('config.ini')
            elif os.path.isfile('/etc/piphone/config.ini'):
                logging.debug("Let's use /etc/iphone/config.ini as a config file")
                config.read('/etc/piphone/config.ini')
            else:
                raise Exception("No configuration file found (tried ./config.ini and /etc/piphone/config.ini")
        except Exception as e:
            phone_logger.error("Config file cannot be read")
            arg_parser.print_help()
            sys.exit(1)
    try:
        start()
467
468
    except:
        stop()