#!/usr/bin/env python3 import asyncio import aiohttp import logging import os import re import json from datetime import datetime as dt from datetime import timedelta as td from typing import Any, Optional from databases import Database from quart import jsonify, request, render_template_string, abort from quart.json import JSONEncoder from quart_openapi import Pint, Resource from http import HTTPStatus from panoramisk import Manager, Message from utils import * from cel import * from logging.config import dictConfig from pprint import pformat from inspect import getmembers class ApiJsonEncoder(JSONEncoder): def default(self, o): if isinstance(o, dt): return o.isoformat() if isinstance(o, CdrChannel): return str(o) if isinstance(o, CdrEvent): return o.__dict__ if isinstance(o, CdrEvents) or isinstance(o, CelEvents): return o.all if isinstance(o, CdrCall) or isinstance(o, CelCall): return o.__dict__ return JSONEncoder.default(self, o) class PintDB: def __init__(self, app: Optional[Pint] = None) -> None: self.init_app(app) self._db = Database(app.config["DB_URI"]) def init_app(self, app: Pint) -> None: app.before_serving(self._before_serving) app.after_serving(self._after_serving) async def _before_serving(self) -> None: await self._db.connect() async def _after_serving(self) -> None: await self._db.disconnect() def __getattr__(self, name: str) -> Any: return getattr(self._db, name) # One asyncio event loop is used for AMI communication and HTTP requests routing with Quart main_loop = asyncio.get_event_loop() app = Pint(__name__, title=os.getenv('APP_TITLE', 'PBX API'), no_openapi=True) app.json_encoder = ApiJsonEncoder app.config.update({ 'TITLE': os.getenv('APP_TITLE', 'PBX API'), 'APPLICATION_ROOT': os.getenv('APP_APPLICATION_ROOT', None), 'SCHEME': os.getenv('APP_SCHEME', 'http'), 'FQDN': os.getenv('APP_FQDN', '127.0.0.1'), 'PORT': int(os.getenv('APP_API_PORT', 8000)), 'BODY_TIMEOUT': int(os.getenv('APP_BODY_TIMEOUT', 60)), 'DEBUG': os.getenv('APP_DEBUG', 'False').lower() in TRUEs, 'MAX_CONTENT_LENGTH': int(os.getenv('APP_MAX_CONTENT_LENGTH', 16777216)), 'AMI_HOST': os.getenv('APP_AMI_HOST', '127.0.0.1'), 'AMI_PORT': int(os.getenv('APP_AMI_PORT', 5038)), 'AMI_USERNAME': os.getenv('APP_AMI_USERNAME', 'app'), 'AMI_SECRET': os.getenv('APP_AMI_SECRET', 'secret'), 'AMI_PING_DELAY': int(os.getenv('APP_AMI_PING_DELAY', 10)), 'AMI_PING_INTERVAL': int(os.getenv('APP_AMI_PING_INTERVAL', 10)), 'AMI_TIMEOUT': int(os.getenv('APP_AMI_TIMEOUT', 5)), 'AUTH_HEADER': os.getenv('APP_AUTH_HEADER', 'APP-auth-token'), 'AUTH_SECRET': os.getenv('APP_AUTH_SECRET', '3bfbeaabf363dd64fe263bd36830a6b6'), 'SWAGGER_JS_URL': os.getenv('APP_SWAGGER_JS_URL', SWAGGER_JS_URL), 'SWAGGER_CSS_URL': os.getenv('APP_SWAGGER_CSS_URL', SWAGGER_CSS_URL), 'STATE_CALLBACK_URL': os.getenv('APP_STATE_CALLBACK_URL', None), 'DB_URI': 'mysql://{}:{}@{}:{}/{}'.format(os.getenv('MYSQL_USER', 'asterisk'), os.getenv('MYSQL_PASSWORD', 'secret'), os.getenv('MYSQL_SERVER', 'db'), os.getenv('APP_PORT_MYSQL', '3306'), os.getenv('FREEPBX_CDRDBNAME', None)), 'EXTRA_API_URL': os.getenv('APP_EXTRA_API_URL', None)}) app.cache = {'devices':[], 'ustates':{}, 'pstates':{}, 'queues':{}} manager = Manager( loop=main_loop, host=app.config['AMI_HOST'], port=app.config['AMI_PORT'], username=app.config['AMI_USERNAME'], secret=app.config['AMI_SECRET'], ping_delay=app.config['AMI_PING_DELAY'], ping_interval=app.config['AMI_PING_INTERVAL'], reconnect_timeout=app.config['AMI_TIMEOUT'], ) class AuthMiddleware: '''ASGI process middleware that rejects requests missing the correct authentication header''' def __init__(self, app): self.app = app async def __call__(self, scope, receive, send): if 'headers' not in scope: return await self.app(scope, receive, send) for header, value in scope['headers']: if ((header == bytes(app.config['AUTH_HEADER'].lower(), 'utf-8')) and (value == bytes(app.config['AUTH_SECRET'], 'utf-8'))): return await self.app(scope, receive, send) for device in app.cache['devices']: if ((header == bytes('{}_{}'.format(app.config['AUTH_HEADER'].lower(), device), 'utf-8')) and (value == bytes(app.cache['devices'][device], 'utf-8'))): await send({'type': 'http.response.start', 'status': 200, 'headers': [(b'content-length', b'50000')]}) await send({'type': 'http.response.body', 'body': bytes('scope: {}'.format(pformat(getmembers(scope), indent=1)), 'utf-8'), 'more_body': False}) return await self.app(scope, receive, send) # Paths "/openapi.json" and "/ui" do not require auth if (('path' in scope) and ((scope['path'] in NO_AUTH_ROUTES) or (scope['path'].startswith('/static/records')))): return await self.app(scope, receive, send) return await self.error_response(receive, send) async def error_response(self, receive, send): await send({'type': 'http.response.start', 'status': 401, 'headers': [(b'content-length', b'21')]}) await send({'type': 'http.response.body', 'body': b'Authorization requred', 'more_body': False}) app.asgi_app = AuthMiddleware(app.asgi_app) db = PintDB(app) @manager.register_event('FullyBooted') @manager.register_event('Reload') async def reloadCallback(mngr: Manager, msg: Message): await refreshDevicesCache() await refreshStatesCache() await refreshQueuesCache() await rebindLostDevices() @manager.register_event('ExtensionStatus') async def extensionStatusCallback(mngr: Manager, msg: Message): user = msg.exten state = msg.statustext.lower() if user in app.cache['ustates']: prevState = getUserStateCombined(user) app.cache['ustates'][user] = state combinedState = getUserStateCombined(user) if combinedState != prevState: await userStateChangeCallback(user, combinedState, prevState) @manager.register_event('PresenceStatus') async def presenceStatusCallback(mngr: Manager, msg: Message): user = msg.exten #hint = msg.hint state = msg.status.lower() if user in app.cache['ustates']: prevState = getUserStateCombined(user) app.cache['pstates'][user] = state combinedState = getUserStateCombined(user) if combinedState != prevState: await userStateChangeCallback(user, combinedState, prevState) async def getCDR(start=None, end=None, table='cdr', field='calldate', sort='calldate, SUBSTR(uniqueid,1,10), sequence'): _cdr = {} if end is None: end = dt.now() if start is None: start=(end - td(hours=24)) async for row in db.iterate(query='''SELECT * FROM {table} WHERE linkedid IN (SELECT DISTINCT(linkedid) FROM {table} WHERE {field} BETWEEN :start AND :end) ORDER BY {sort};'''.format(table=table, field=field, sort=sort), values={'start':start, 'end':end}): if row['linkedid'] in _cdr: _cdr[row['linkedid']].events.add(row) else: _cdr[row['linkedid']]=CdrCall(row) cdr = [] for _id in sorted(_cdr.keys()): cdr.append(_cdr[_id]) return cdr async def getUserCDR(user, start=None, end=None, direction=None, limit=None, offset=None, order='ASC'): _q = f'''SELECT * FROM cdr AS c INNER JOIN (SELECT linkedid FROM cdr WHERE''' direction=direction.lower() if direction in ('in', True, '1', 'incoming', 'inbound'): direction = 'inbound' _q += f''' dst="{user}"''' elif direction in ('out', False, '0', 'outgoing', 'outbound'): direction = 'outbound' _q += f''' src="{user}"''' else: direction = None _q += f''' (src="{user}" or dst="{user}")''' if end is None: end = dt.now() if start is None: start=(end - td(hours=24)) _q += f''' AND calldate BETWEEN "{start}" AND "{end}" GROUP BY linkedid''' if None not in (limit, offset): _q += f''' LIMIT {offset},{limit}''' _q += f''') AS c2 ON c.linkedid = c2.linkedid;''' app.logger.warning('SQL: {}'.format(_q)) _cdr = {} async for row in db.iterate(query=_q): if row['linkedid'] in _cdr: _cdr[row['linkedid']].events.add(row) else: _cdr[row['linkedid']]=CdrUserCall(user, row) cdr = [] for _id in sorted(_cdr.keys(), reverse = True if (order.lower() == 'desc') else False): record = _cdr[_id].simple if (direction is not None) and (record['src'] == record['dst']) and (record['direction'] != direction): record['direction'] = direction if record['file'] is not None: record['file'] = '/static/records/{d.year}/{d.month:02}/{d.day:02}/{filename}'.format(d=record['start'], filename=record['file']) cdr.append(record) return cdr async def getCEL(start=None, end=None, table='cel', field='eventtime', sort='id'): return await getCDR(start, end, table, field, sort) @app.before_first_request async def initHttpClient(): app.config['HTTP_CLIENT'] = aiohttp.ClientSession(loop=main_loop) @app.route('/openapi.json') async def openapi(): '''Generates JSON that conforms OpenAPI Specification ''' schema = app.__schema__ schema['servers'] = [{'url':'{}://{}:{}'.format(app.config['SCHEME'], app.config['FQDN'], app.config['PORT'])}] if app.config['EXTRA_API_URL'] is not None: schema['servers'].append({'url':app.config['EXTRA_API_URL']}) schema['components'] = {'securitySchemes':{'ApiKey':{'type': 'apiKey', 'name': app.config['AUTH_HEADER'], 'in': 'header'}}} schema['security'] = [{'ApiKey':[]}] return jsonify(schema) @app.route('/ui') async def ui(): '''Swagger UI ''' return await render_template_string(SWAGGER_TEMPLATE, title=app.config['TITLE'], js_url=app.config['SWAGGER_JS_URL'], css_url=app.config['SWAGGER_CSS_URL']) @app.route('/ami/action', methods=['POST']) async def action(): _payload = await request.get_data() reply = await manager.send_action(json.loads(_payload)) return str(reply) @app.route('/ami/getvar/') async def amiGetVar(variable): '''AMI GetVar Returns value of requested variable using AMI action GetVar in background. Parameters: variable (string): Variable to query for Returns: string: Variable value or empty string if variable not found ''' reply = await manager.send_action({'Action': 'GetVar', 'Variable': variable}) app.logger.warning('GetVar({})->{}'.format(variable, reply.value)) return reply.value @app.route('/ami/auths') async def amiPJSIPShowAuths(): return successReply(app.cache['devices']) @app.route('/ami/aors') async def amiPJSIPShowAors(): aors = {} reply = await manager.send_action({'Action':'PJSIPShowAors'}) if len(reply) >= 2: for message in reply: if ((message.event == 'AorList') and ('objecttype' in message) and (message.objecttype == 'aor') and (int(message.maxcontacts) > 0)): aors[message.objectname] = message.contacts app.logger.warning('AorsList: {}'.format(','.join(aors.keys()))) return successReply(aors) async def amiSetVar(variable, value): '''AMI SetVar Sets variable using AMI action SetVar to value in background. Parameters: variable (string): Variable to set value (string): Value to set for variable Returns: string: None if SetVar was successfull, error message overwise ''' reply = await manager.send_action({'Action': 'SetVar', 'Variable': variable, 'Value': value}) app.logger.warning('SetVar({}, {})'.format(variable, value)) if isinstance(reply, Message): if reply.success: return None else: return reply.message return 'AMI error' async def amiDBGet(family, key): '''AMI DBGet Returns value of requested astdb key using AMI action DBGet in background. Parameters: family (string): astdb key family to query for key (string): astdb key to query for Returns: string: Value or empty string if variable not found ''' reply = await manager.send_action({'Action': 'DBGet', 'Family': family, 'Key': key}) if (isinstance(reply, list) and (len(reply) > 1)): for message in reply: if (message.event == 'DBGetResponse'): app.logger.warning('DBGet(/{}/{})->{}'.format(family, key, message.val)) return message.val app.logger.warning('DBGet(/{}/{})->Error!'.format(family, key)) return None async def amiDBPut(family, key, value): '''AMI DBPut Writes value to astdb by family and key using AMI action DBPut in background. Parameters: family (string): astdb key family to write to key (string): astdb key to write to value (string): value to write Returns: boolean: True if DBPut action was successfull, False overwise ''' reply = await manager.send_action({'Action': 'DBPut', 'Family': family, 'Key': key, 'Val': value}) app.logger.warning('DBPut(/{}/{}, {})'.format(family, key, value)) if (isinstance(reply, Message) and reply.success): return True return False async def amiDBDel(family, key): '''AMI DBDel Deletes key from family in astdb using AMI action DBDel in background. Parameters: family (string): astdb key family key (string): astdb key to delete Returns: boolean: True if DBDel action was successfull, False overwise ''' reply = await manager.send_action({'Action': 'DBDel', 'Family': family, 'Key': key}) app.logger.warning('DBDel(/{}/{})'.format(family, key)) if (isinstance(reply, Message) and reply.success): return True return False async def amiSetHint(context, user, hint): '''AMI SetHint Sets hint for user in context using AMI action DialplanUserAdd with Replace=true in background. Parameters: context (string): dialplan context user (string): user hint (string): hint for user Returns: boolean: True if DialplanUserAdd action was successfull, False overwise ''' reply = await manager.send_action({'Action': 'DialplanExtensionAdd', 'Context': context, 'Extension': user, 'Priority': 'hint', 'Application': hint, 'Replace': 'yes'}) app.logger.warning('SetHint({},{},{})'.format(context, user, hint)) if (isinstance(reply, Message) and reply.success): return True return False async def amiPresenceState(user): '''AMI PresenceState request for CustomPresence provider Parameters: user (string): user Returns: boolean, string: True and state or False and error message ''' reply = await manager.send_action({'Action': 'PresenceState', 'Provider': 'CustomPresence:{}'.format(user)}) app.logger.warning('PresenceState({})'.format(user)) if isinstance(reply, Message): if reply.success: return True, reply.state else: return False, reply.message return False, 'AMI error' async def amiPresenceStateList(): states = {} reply = await manager.send_action({'Action':'PresenceStateList'}) if len(reply) >= 2: for message in reply: if message.event == 'PresenceStateChange': user = re.search('CustomPresence:(\d+)', message.presentity).group(1) states[user] = message.status app.logger.warning('PresenceStateList: {}'.format(','.join(states.keys()))) return states async def amiExtensionStateList(): states = {} reply = await manager.send_action({'Action':'ExtensionStateList'}) if len(reply) >= 2: for message in reply: if ((message.event == 'ExtensionStatus') and (message.context == 'ext-local')): states[message.exten] = message.statustext.lower() app.logger.warning('ExtensionStateList: {}'.format(','.join(states.keys()))) return states async def amiCommand(command): '''AMI Command Runs specified command using AMI action Command in background. Parameters: command (string): command to run Returns: boolean, list: tuple representing the boolean result of request and list of lines of command output ''' reply = await manager.send_action({'Action': 'Command', 'Command': command}) result = [] if (isinstance(reply, Message) and reply.success): if isinstance(reply.output, list): result = reply.output else: result = reply.output.split('\n') app.logger.warning('Command({})->{}'.format(command, '\n'.join(result))) return True, result app.logger.warning('Command({})->Error!'.format(command)) return False, result async def amiReload(module='core'): '''AMI Reload Reload specified asterisk module using AMI action reload in background. Parameters: module (string): module to reload, defaults to core Returns: boolean: True if Reload action was successfull, False overwise ''' reply = await manager.send_action({'Action': 'Reload', 'Module': module}) app.logger.warning('Reload({})'.format(module)) if (isinstance(reply, Message) and reply.success): return True return False async def getGlobalVars(): globalVars = GlobalVars() for _var in globalVars.d(): setattr(globalVars, _var, await amiGetVar(_var)) return globalVars async def setUserHint(user, dial, ast): if dial in NONEs: hint = 'CustomPresence:{}'.format(user) else: _dial= [dial] if (ast.DNDDEVSTATE == 'TRUE'): _dial.append('Custom:DND{}'.format(user)) hint = '{},CustomPresence:{}'.format('&'.join(_dial), user) return await amiSetHint('ext-local', user, hint) async def amiQueues(): queues = {} reply = await manager.send_action({'Action':'QueueStatus'}) if len(reply) >= 2: for message in reply: if message.event == 'QueueMember': _qm = QueueMember(re.search('Local\/(\d+)', message.location).group(1)) queues.setdefault(message.queue, []).append(_qm.fromMessage(message)) app.logger.warning('QueuesList: {}'.format(','.join(queues.keys()))) return queues async def amiDeviceChannel(device): reply = await manager.send_action({'Action':'CoreShowChannels'}) if len(reply) >= 2: for message in reply: if message.event == 'CoreShowChannel': if message.calleridnum == device: return message.channel return None async def getUserChannel(user): device = await getUserDevice(user) if device in NONEs: return False channel = await amiDeviceChannel(device) if channel in NONEs: return False return channel async def setQueueStates(user, device, state): for queue in [_q for _q, _ma in app.cache['queues'].items() for _m in _ma if _m.user == user]: await amiSetVar('DEVICE_STATE(Custom:QUEUE{}*{})'.format(device, queue), state) async def getDeviceUser(device): return await amiDBGet('DEVICE', '{}/user'.format(device)) async def getDeviceType(device): return await amiDBGet('DEVICE', '{}/type'.format(device)) async def getDeviceDial(device): return await amiDBGet('DEVICE', '{}/dial'.format(device)) async def getUserCID(user): return await amiDBGet('AMPUSER', '{}/cidnum'.format(user)) async def setDeviceUser(device, user): return await amiDBPut('DEVICE', '{}/user'.format(device), user) async def getUserDevice(user): return await amiDBGet('AMPUSER', '{}/device'.format(user)) async def setUserDevice(user, device): if device is None: return await amiDBDel('AMPUSER', '{}/device'.format(user)) else: return await amiDBPut('AMPUSER', '{}/device'.format(user), device) async def unbindOtherDevices(user, newDevice, ast): '''Unbinds user from all devices except newDevice and sets all required device states. ''' devices = await amiDBGet('AMPUSER', '{}/device'.format(user)) if devices not in NONEs: for _device in sorted(set(devices.split('&')), key=int): if _device != newDevice: if ast.FMDEVSTATE == 'TRUE': await amiSetVar('DEVICE_STATE(Custom:FOLLOWME{})'.format(_device), 'INVALID') if ast.QUEDEVSTATE == 'TRUE': await setQueueStates(user, _device, 'NOT_INUSE') if ast.DNDDEVSTATE: await amiSetVar('DEVICE_STATE(Custom:DEVDND{})'.format(_device), 'NOT_INUSE') if ast.CFDEVSTATE: await amiSetVar('DEVICE_STATE(Custom:DEVCF{})'.format(_device), 'NOT_INUSE') await amiDBPut('DEVICE', '{}/user'.format(_device), 'none') async def setUserDeviceStates(user, device, ast): if ast.FMDEVSTATE == 'TRUE': _followMe = await amiDBGet('AMPUSER', '{}/followme/ddial'.format(user)) if _followMe is not None: await amiSetVar('DEVICE_STATE(Custom:FOLLOWME{})'.format(device), followMe2DevState(_followMe)) if ast.QUEDEVSTATE == 'TRUE': await setQueueStates(user, device, 'INUSE') if ast.DNDDEVSTATE: _dnd = await amiDBGet('DND', user) await amiSetVar('DEVICE_STATE(Custom:DEVDND{})'.format(device), 'INUSE' if _dnd == 'YES' else 'NOT_INUSE') if ast.CFDEVSTATE: _cf = await amiDBGet('CF', user) await amiSetVar('DEVICE_STATE(Custom:DEVCF{})'.format(device), 'INUSE' if _cf != '' else 'NOT_INUSE') async def refreshStatesCache(): app.cache['ustates'] = await amiExtensionStateList() app.cache['pstates'] = await amiPresenceStateList() return len(app.cache['ustates']) async def refreshDevicesCache(): auths = {} reply = await manager.send_action({'Action':'PJSIPShowAuths'}) if len(reply) >= 2: for message in reply: if ((message.event == 'AuthList') and ('objecttype' in message) and (message.objecttype == 'auth')): auths[message.username] = message.password app.cache['devices'] = auths return len(app.cache['devices']) async def refreshQueuesCache(): app.cache['queues'] = await amiQueues() return len(app.cache['queues']) async def rebindLostDevices(): ast = await getGlobalVars() for device in app.cache['devices']: user = await getDeviceUser(device) deviceType = await getDeviceType(device) if (deviceType != 'fixed') and (user != 'none') and (user in app.cache['ustates'].keys()): _device = await getUserDevice(user) if _device != device: app.logger.warning('Fixing bind user {} to device {}'.format(user, device)) dial = await getDeviceDial(device) await setUserHint(user, dial, ast) # Set hints for user on new device await setUserDeviceStates(user, device, ast) # Set device states for users device await setUserDevice(user, device) # Bind device to user async def userStateChangeCallback(user, state, prevState = None): reply = None if ((app.config['STATE_CALLBACK_URL'] not in NONEs) and ('HTTP_CLIENT' in app.config)): reply = await app.config['HTTP_CLIENT'].post(app.config['STATE_CALLBACK_URL'], json={'user': user, 'state': state, 'prev_state':prevState}) else: app.logger.warning('{} changed state to: {}'.format(user, state)) return reply def getUserStateCombined(user): _uCache = app.cache['ustates'] _pCache = app.cache['pstates'] return combinedStates[_uCache.get(user, 'unavailable')][_pCache.get(user, 'not_set')] def getUsersStatesCombined(): return {user:getUserStateCombined(user) for user in app.cache['ustates']} @app.route('/atxfer//') class AtXfer(Resource): @app.param('userA', 'User initiating the attended transfer', 'path') @app.param('userB', 'Transfer destination user', 'path') @app.response(HTTPStatus.OK, 'Json reply') @app.response(HTTPStatus.UNAUTHORIZED, 'Authorization required') async def get(self, userA, userB): '''Attended call transfer ''' channel = await getUserChannel(userA) if not channel: return noUserChannel(userA) reply = await manager.send_action({'Action':'Atxfer', 'Channel':channel, 'async':'false', 'Exten':userB}) if isinstance(reply, Message): if reply.success: return successfullyTransfered(userA, userB) else: return errorReply(reply.message) @app.route('/bxfer//') class BXfer(Resource): @app.param('userA', 'User initiating the blind transfer', 'path') @app.param('userB', 'Transfer destination user', 'path') @app.response(HTTPStatus.OK, 'Json reply') @app.response(HTTPStatus.UNAUTHORIZED, 'Authorization required') async def get(self, userA, userB): '''Blind call transfer ''' channel = await getUserChannel(userA) if not channel: return noUserChannel(userA) reply = await manager.send_action({'Action':'BlindTransfer', 'Channel':channel, 'async':'false', 'Exten':userB}) if isinstance(reply, Message): if reply.success: return successfullyTransfered(userA, userB) else: return errorReply(reply.message) @app.route('/originate//') class Originate(Resource): @app.param('user', 'User initiating the call', 'path') @app.param('number', 'Destination number', 'path') @app.response(HTTPStatus.OK, 'Json reply') @app.response(HTTPStatus.UNAUTHORIZED, 'Authorization required') async def get(self, user, number): '''Originate call ''' device = await getUserDevice(user) if device in NONEs: return noUserDevice(user) reply = await manager.send_action({'Action':'Originate', 'Channel':'PJSIP/{}'.format(device), 'Context':'from-internal', 'Exten':number, 'Priority': '1', 'async':'false', 'Callerid': user}) if isinstance(reply, Message): if reply.success: return successfullyOriginated(user, number) else: return errorReply(reply.message) @app.route('/hangup/') class Hangup(Resource): @app.param('user', 'User to hangup', 'path') @app.response(HTTPStatus.OK, 'Json reply') @app.response(HTTPStatus.UNAUTHORIZED, 'Authorization required') async def get(self, user): '''Call hangup ''' channel = await getUserChannel(user) if not channel: return noUserChannel(user) reply = await manager.send_action({'Action':'Hangup', 'Channel':channel}) if isinstance(reply, Message): if reply.success: return successfullyHungup(user) else: return errorReply(reply.message) @app.route('/users/states') class UsersStates(Resource): @app.response(HTTPStatus.OK, 'JSON reply with user:state map or error message') @app.response(HTTPStatus.UNAUTHORIZED, 'Authorization required') async def get(self): '''Returns all users with their combined states. Possible states are: available, away, dnd, inuse, busy, unavailable, ringing ''' usersCount = await refreshStatesCache() if usersCount == 0: return stateCacheEmpty() return successReply(getUsersStatesCombined()) @app.route('/user//state') class UserState(Resource): @app.param('user', 'User to query for combined state', 'path') @app.response(HTTPStatus.OK, 'JSON data {"user":user,"state":state}') @app.response(HTTPStatus.UNAUTHORIZED, 'Authorization required') async def get(self, user): '''Returns user's combined state. One of: available, away, dnd, inuse, busy, unavailable, ringing ''' if user not in app.cache['ustates']: return noUser(user) return successReply({'user':user,'state':getUserStateCombined(user)}) @app.route('/user//presence') class PresenceState(Resource): @app.param('user', 'User to query for presence state', 'path') @app.response(HTTPStatus.OK, 'JSON data {"user":user,"state":state}') @app.response(HTTPStatus.UNAUTHORIZED, 'Authorization required') async def get(self, user): '''Returns user's presence state. One of: not_set, unavailable, available, away, xa, chat, dnd ''' if user not in app.cache['ustates']: return noUser(user) return successReply({'user':user,'state':app.cache['pstates'].get(user, 'not_set')}) @app.route('/user//presence/') class SetPresenceState(Resource): @app.param('user', 'Target user to set the presence state', 'path') @app.param('state', 'The presence state for user, one of: not_set, unavailable, available, away, xa, chat or dnd', 'path') @app.response(HTTPStatus.OK, 'Json reply') @app.response(HTTPStatus.UNAUTHORIZED, 'Authorization required') async def get(self, user, state): '''Sets user's presence state. Allowed states: not_set | unavailable | available | away | xa | chat | dnd ''' if state not in presenceStates: return invalidState(state) if user not in app.cache['ustates']: return noUser(user) if (state.lower() in ('available','not_set','away','xa','chat')) and (getUserStateCombined(user) == 'dnd'): result = await amiDBDel('DND', '{}'.format(user)) result = await amiSetVar('PRESENCE_STATE(CustomPresence:{})'.format(user), state) if result is not None: return errorReply(result) if state.lower() == 'dnd': result = await amiDBPut('DND', '{}'.format(user), 'YES') return successfullySetState(user, state) @app.route('/users/devices') class UsersDevices(Resource): @app.response(HTTPStatus.OK, 'JSON reply with user:device map or error message') @app.response(HTTPStatus.UNAUTHORIZED, 'Authorization required') async def get(self): '''Returns all users with their combined states. Possible states are: available, away, dnd, inuse, busy, unavailable, ringing ''' data = {} for user in app.cache['ustates']: device = await getUserDevice(user) if ((device in NONEs) or (device == user)): device = None else: device = device.replace('{}&'.format(user), '') data[user]= device return successReply(data) @app.route('/device///on') @app.route('/user///on') class UserDeviceBind(Resource): @app.param('device', 'Device number to bind to', 'path') @app.param('user', 'User to bind to device', 'path') @app.response(HTTPStatus.OK, 'JSON reply with fields "success" and "result"') @app.response(HTTPStatus.UNAUTHORIZED, 'Authorization required') async def get(self, device, user): '''Binds user to device. Both user and device numbers are checked for existance. Any device user was previously bound to, is unbound. Any user previously bound to device is unbound also. ''' if user not in app.cache['ustates']: return noUser(user) dial = await getDeviceDial(device) # Check if device exists in astdb if dial is None: return noDevice(device) currentUser = await getDeviceUser(device) # Check if any user is already bound to device if currentUser == user: return alreadyBound(user, device) ast = await getGlobalVars() if currentUser not in NONEs: # If any other user is bound to device, unbind him, await setUserDevice(currentUser, None) if ast.QUEDEVSTATE == 'TRUE': # set device states for previous user queues await setQueueStates(currentUser, device, 'NOT_INUSE') await setUserHint(currentUser, None, ast) # set hints for previous user await setDeviceUser(device, user) # Bind user to device # If user is bound to some other devices, unbind him and set # device states for those devices await unbindOtherDevices(user, device, ast) if not (await setUserHint(user, dial, ast)): # Set hints for user on new device return hintError(user, device) await setUserDeviceStates(user, device, ast) # Set device states for users new device if not (await setUserDevice(user, device)): # Bind device to user return bindError(user, device) return successfullyBound(user, device) @app.route('/device//off') class DeviceUnBind(Resource): @app.param('device', 'Device number to unbind', 'path') @app.response(HTTPStatus.OK, 'JSON reply with fields "success" and "result"') @app.response(HTTPStatus.UNAUTHORIZED, 'Authorization required') async def get(self, device): '''Unbinds any user from device. Device is checked for existance. ''' dial = await getDeviceDial(device) # Check if device exists in astdb if dial is None: return noDevice(device) currentUser = await getDeviceUser(device) # Check if any user is bound to device if currentUser in NONEs: return noUserBound(device) else: ast = await getGlobalVars() await setUserDevice(currentUser, None) # Unbind device from current user if ast.QUEDEVSTATE == 'TRUE': # set device states for current user queues await setQueueStates(currentUser, device, 'NOT_INUSE') await setUserHint(currentUser, None, ast) # set hints for current user await setDeviceUser(device, 'none') # Unbind user from device return successfullyUnbound(currentUser, device) @app.route('/cdr') class CDR(Resource): @app.param('end', 'End of datetime range. Defaults to now. Allowed formats are: timestamp, ISO 8601 or YYYYMMDDhhmmss', 'query') @app.param('start', 'Start of datetime range. Defaults to end-24h. Allowed formats are: timestamp, ISO 8601 or YYYYMMDDhhmmss', 'query') @app.response(HTTPStatus.OK, 'JSON reply') @app.response(HTTPStatus.UNAUTHORIZED, 'Authorization required') async def get(self): '''Returns CDR data, groupped by logical call id. All request arguments are optional. ''' start = parseDatetime(request.args.get('start')) end = parseDatetime(request.args.get('end')) cdr = await getCDR(start, end) return successReply(cdr) @app.route('/cel') class CEL(Resource): @app.param('end', 'End of datetime range. Defaults to now. Allowed formats are: timestamp, ISO 8601 or YYYYMMDDhhmmss', 'query') @app.param('start', 'Start of datetime range. Defaults to end-24h. Allowed formats are: timestamp, ISO 8601 or YYYYMMDDhhmmss', 'query') @app.response(HTTPStatus.OK, 'JSON reply') @app.response(HTTPStatus.UNAUTHORIZED, 'Authorization required') async def get(self): '''Returns CEL data, groupped by logical call id. All request arguments are optional. ''' start = parseDatetime(request.args.get('start')) end = parseDatetime(request.args.get('end')) cel = await getCEL(start, end) return successReply(cel) @app.route('/calls') class Calls(Resource): @app.param('end', 'End of datetime range. Defaults to now. Allowed formats are: timestamp, ISO 8601 and YYYYMMDDhhmmss', 'query') @app.param('start', 'Start of datetime range. Defaults to end-24h. Allowed formats are: timestamp, ISO 8601 and YYYYMMDDhhmmss', 'query') @app.response(HTTPStatus.OK, 'JSON reply') @app.response(HTTPStatus.UNAUTHORIZED, 'Authorization required') async def get(self): '''Returns aggregated call data JSON. Draft implementation. All request arguments are optional. ''' calls = [] start = parseDatetime(request.args.get('start')) end = parseDatetime(request.args.get('end')) cdr = await getCDR(start, end) for c in cdr: _call = {'id':c.linkedid, 'start':c.start, 'type': c.direction, 'numberA': c.src, 'numberB': c.dst, 'line': c.did, 'duration': c.duration, 'waiting': c.waiting, 'status':c.disposition, 'url': c.file } calls.append(_call) return successReply(calls) @app.route('/user//calls') class UserCalls(Resource): @app.param('user', 'User to query for call stats', 'path') @app.param('end', 'End of datetime range. Defaults to now. Allowed formats are: timestamp, ISO 8601 and YYYYMMDDhhmmss', 'query') @app.param('start', 'Start of datetime range. Defaults to end-24h. Allowed formats are: timestamp, ISO 8601 and YYYYMMDDhhmmss', 'query') @app.param('direction', 'Calls direction, in or out. If not specified both are returned', 'query') @app.param('limit', 'Max number of returned records, defaults to unlimited. Use offset parameter together with limit', 'query') @app.param('offset', 'If limit is specified use offset parameter to request more results', 'query') @app.param('order', 'Calls sort order for datetime field. ASC or DESC. Defaults to ASC', 'query') @app.response(HTTPStatus.OK, 'JSON data {"user":user,"state":state}') @app.response(HTTPStatus.UNAUTHORIZED, 'Authorization required') async def get(self, user): '''Returns user's call stats. ''' if user not in app.cache['ustates']: return noUser(user) cdr = await getUserCDR(user, parseDatetime(request.args.get('start')), parseDatetime(request.args.get('end')), request.args.get('direction', None), request.args.get('limit', None), request.args.get('offset', None), request.args.get('order', 'ASC')) return successReply(cdr) manager.connect() app.run(loop=main_loop, host='0.0.0.0', port=app.config['PORT'])