diff --git a/sylk/applications/webrtcgateway/configuration.py b/sylk/applications/webrtcgateway/configuration.py index db91ea7..61f7784 100644 --- a/sylk/applications/webrtcgateway/configuration.py +++ b/sylk/applications/webrtcgateway/configuration.py @@ -1,212 +1,213 @@ import os import re from application.configuration import ConfigFile, ConfigSection, ConfigSetting from application.configuration.datatypes import NetworkAddress, StringList, HostnameList from sylk.configuration import ServerConfig from sylk.configuration.datatypes import Path, SIPProxyAddress, VideoBitrate, VideoCodec __all__ = 'GeneralConfig', 'JanusConfig', 'get_room_config', 'ExternalAuthConfig', 'get_auth_config', 'CassandraConfig' # Datatypes class AccessPolicyValue(str): allowed_values = ('allow,deny', 'deny,allow') def __new__(cls, value): value = re.sub('\s', '', value) if value not in cls.allowed_values: raise ValueError('invalid value, allowed values are: %s' % ' | '.join(cls.allowed_values)) return str.__new__(cls, value) class Domain(str): domain_re = re.compile(r"^[a-zA-Z0-9\-_]+(\.[a-zA-Z0-9\-_]+)*$") def __new__(cls, value): value = str(value) if not cls.domain_re.match(value): raise ValueError("illegal domain: %s" % value) return str.__new__(cls, value) class SIPAddress(str): def __new__(cls, address): address = str(address) address = address.replace('@', '%40', address.count('@')-1) try: username, domain = address.split('@') Domain(domain) except ValueError: raise ValueError("illegal SIP address: %s, must be in user@domain format" % address) return str.__new__(cls, address) class PolicyItem(object): def __new__(cls, item): lowercase_item = item.lower() if lowercase_item in ('none', ''): return 'none' elif lowercase_item in ('any', 'all', '*'): return 'all' elif '@' in item: return SIPAddress(item) else: return Domain(item) class PolicySettingValue(object): def __init__(self, value): if isinstance(value, (tuple, list)): items = [str(x) for x in value] elif isinstance(value, str): items = re.split(r'\s*,\s*', value) else: raise TypeError("value must be a string, list or tuple") self.items = {PolicyItem(item) for item in items} self.items.discard('none') def __repr__(self): return '{0.__class__.__name__}({1})'.format(self, sorted(self.items)) def match(self, uri): if 'all' in self.items: return True elif not self.items: return False uri = re.sub('^(sip:|sips:)', '', str(uri)) domain = uri.split('@')[-1] return uri in self.items or domain in self.items class ManagementInterfaceAddress(NetworkAddress): default_port = 20888 class AuthType(str): allowed_values = ('SIP', 'IMAP') def __new__(cls, value): value = re.sub('\s', '', value) if value not in cls.allowed_values: raise ValueError('invalid value, allowed values are: %s' % ' | '.join(cls.allowed_values)) return str.__new__(cls, value) # Configuration objects class GeneralConfig(ConfigSection): __cfgfile__ = 'webrtcgateway.ini' __section__ = 'General' web_origins = ConfigSetting(type=StringList, value=['*']) sip_domains = ConfigSetting(type=StringList, value=['*']) outbound_sip_proxy = ConfigSetting(type=SIPProxyAddress, value=None) trace_client = False websocket_ping_interval = 120 recording_dir = ConfigSetting(type=Path, value=Path(os.path.join(ServerConfig.spool_dir.normalized, 'videoconference', 'recordings'))) filesharing_dir = ConfigSetting(type=Path, value=Path(os.path.join(ServerConfig.spool_dir.normalized, 'videoconference', 'files'))) http_management_interface = ConfigSetting(type=ManagementInterfaceAddress, value=ManagementInterfaceAddress('127.0.0.1')) http_management_auth_secret = ConfigSetting(type=str, value=None) sylk_push_url = ConfigSetting(type=str, value=None) local_sip_messages = False class JanusConfig(ConfigSection): __cfgfile__ = 'webrtcgateway.ini' __section__ = 'Janus' api_url = 'ws://127.0.0.1:8188' api_secret = '0745f2f74f34451c89343afcdcae5809' trace_janus = False max_bitrate = ConfigSetting(type=VideoBitrate, value=VideoBitrate(2016000)) # ~2 MBits/s video_codec = ConfigSetting(type=VideoCodec, value=VideoCodec('vp9')) decline_code = 486 class CassandraConfig(ConfigSection): __cfgfile__ = 'webrtcgateway.ini' __section__ = 'Cassandra' cluster_contact_points = ConfigSetting(type=HostnameList, value=None) keyspace = ConfigSetting(type=str, value='') push_tokens_table = ConfigSetting(type=str, value='') class RoomConfig(ConfigSection): __cfgfile__ = 'webrtcgateway.ini' record = False access_policy = ConfigSetting(type=AccessPolicyValue, value=AccessPolicyValue('allow, deny')) allow = ConfigSetting(type=PolicySettingValue, value=PolicySettingValue('all')) deny = ConfigSetting(type=PolicySettingValue, value=PolicySettingValue('none')) max_bitrate = ConfigSetting(type=VideoBitrate, value=JanusConfig.max_bitrate) video_codec = ConfigSetting(type=VideoCodec, value=JanusConfig.video_codec) + video_disabled = False class VideoroomConfiguration(object): video_codec = 'vp9' max_bitrate = 2016000 record = False recording_dir = None filesharing_dir = None def __init__(self, data): self.__dict__.update(data) @property def janus_data(self): return dict(videocodec=self.video_codec, bitrate=self.max_bitrate, record=self.record, rec_dir=self.recording_dir) def get_room_config(room): config_file = ConfigFile(RoomConfig.__cfgfile__) section = config_file.get_section(room) if section is not None: RoomConfig.read(section=room) config = VideoroomConfiguration(dict(RoomConfig)) RoomConfig.reset() else: config = VideoroomConfiguration(dict(RoomConfig)) # use room defaults config.recording_dir = os.path.join(GeneralConfig.recording_dir, room) config.filesharing_dir = os.path.join(GeneralConfig.filesharing_dir, room) return config class ExternalAuthConfig(ConfigSection): __cfgfile__ = 'auth.ini' __section__ = 'ExternalAuth' enable = False # this can't be per-server due to limitations in imaplib imap_ca_cert_file = ConfigSetting(type=str, value='/etc/ssl/certs/ca-certificates.crt') class AuthConfig(ConfigSection): __cfgfile__ = 'auth.ini' auth_type = ConfigSetting(type=AuthType, value=AuthType('SIP')) imap_server = ConfigSetting(type=str, value='') class AuthConfiguration(object): auth_type = AuthType('SIP') def __init__(self, data): self.__dict__.update(data) def get_auth_config(domain): config_file = ConfigFile(AuthConfig.__cfgfile__) section = config_file.get_section(domain) if section is not None: AuthConfig.read(section=domain) config = AuthConfiguration(dict(AuthConfig)) AuthConfig.reset() else: config = AuthConfiguration(dict(AuthConfig)) # use auth defaults return config diff --git a/sylk/applications/webrtcgateway/handler.py b/sylk/applications/webrtcgateway/handler.py index 61d4789..b9ffa50 100644 --- a/sylk/applications/webrtcgateway/handler.py +++ b/sylk/applications/webrtcgateway/handler.py @@ -1,2065 +1,2067 @@ import base64 import hashlib import json import random import os import time import uuid from application.notification import IObserver, NotificationCenter, NotificationData from application.python import Null, limit from application.python.weakref import defaultweakobjectmap from application.system import makedirs, unlink from collections import deque from eventlib import coros, proc from itertools import count from sipsimple.configuration.settings import SIPSimpleSettings from sipsimple.core import SIPURI, FromHeader, ToHeader, Credentials, Message, RouteHeader, Route, Header from sipsimple.lookup import DNSLookup, DNSLookupError from sipsimple.payloads.imdn import IMDNDocument, DeliveryNotification, DisplayNotification from sipsimple.streams import MediaStreamRegistry from sipsimple.streams.msrp.chat import CPIMPayload, CPIMParserError, ChatIdentity, CPIMHeader, CPIMNamespace from sipsimple.threading import run_in_thread, run_in_twisted_thread from sipsimple.threading.green import call_in_green_thread, run_in_green_thread from sipsimple.util import ISOTimestamp from shutil import copyfileobj, rmtree from twisted.internet import reactor, defer from typing import Generic, Container, Iterable, Sized, TypeVar, Dict, Set, Optional, Union from werkzeug.exceptions import InternalServerError from zope.interface import implementer from sylk.accounts import DefaultAccount from sylk.configuration import SIPConfig from sylk.session import Session from . import push from .configuration import GeneralConfig, get_room_config, ExternalAuthConfig, JanusConfig from .janus import JanusBackend, JanusError, JanusSession, SIPPluginHandle, VideoroomPluginHandle from .logger import ConnectionLogger, VideoroomLogger from .models import sylkrtc, janus from .storage import TokenStorage, MessageStorage from .auth import AuthHandler class AccountInfo(object): # noinspection PyShadowingBuiltins def __init__(self, id, password, display_name=None, user_agent=None): self.id = id self.password = password self.display_name = display_name self.user_agent = user_agent self.registration_state = None self.janus_handle = None # type: Optional[SIPPluginHandle] self.contact_params = {} self.auth_handle = None self.auth_state = None @property def uri(self): return 'sip:' + self.id @property def user_data(self): return dict(username=self.uri, display_name=self.display_name, user_agent=self.user_agent, ha1_secret=self.password, contact_params=self.contact_params) class SessionPartyIdentity(object): def __init__(self, uri, display_name=None): self.uri = uri self.display_name = display_name # todo: might need to replace this auto-resetting descriptor with a timer in case we need to know when the slow link state expired class SlowLinkState(object): def __init__(self): self.slow_link = False self.last_reported = 0 class SlowLinkDescriptor(object): __timeout__ = 30 # 30 seconds def __init__(self): self.values = defaultweakobjectmap(SlowLinkState) def __get__(self, instance, owner): if instance is None: return self state = self.values[instance] if state.slow_link and time.time() - state.last_reported > self.__timeout__: state.slow_link = False return state.slow_link def __set__(self, instance, value): state = self.values[instance] if value: state.last_reported = time.time() state.slow_link = bool(value) def __delete__(self, instance): raise AttributeError('Attribute cannot be deleted') class SIPSessionInfo(object): slow_download = SlowLinkDescriptor() slow_upload = SlowLinkDescriptor() # noinspection PyShadowingBuiltins def __init__(self, id): self.id = id self.direction = None self.state = None self.account = None # type: Optional[AccountInfo] self.local_identity = None # type: Optional[SessionPartyIdentity] self.remote_identity = None # type: Optional[SessionPartyIdentity] self.janus_handle = None # type: Optional[SIPPluginHandle] self.slow_download = False self.slow_upload = False def init_outgoing(self, account, destination): self.account = account self.direction = 'outgoing' self.state = 'connecting' self.local_identity = SessionPartyIdentity(account.id) self.remote_identity = SessionPartyIdentity(destination) def init_incoming(self, account, originator, originator_display_name=''): self.account = account self.direction = 'incoming' self.state = 'connecting' self.local_identity = SessionPartyIdentity(account.id) self.remote_identity = SessionPartyIdentity(originator, originator_display_name) class VideoroomSessionInfo(object): slow_download = SlowLinkDescriptor() slow_upload = SlowLinkDescriptor() # noinspection PyShadowingBuiltins def __init__(self, id, owner, janus_handle): self.type = None # publisher / subscriber self.id = id self.owner = owner # type: ConnectionHandler self.janus_handle = janus_handle # type: VideoroomPluginHandle self.chat_handler = None # type: Optional[VideoroomChatHandler] self.account = None # type: Optional[AccountInfo] self.room = None # type: Optional[Videoroom] self.bitrate = None self.parent_session = None # type: Optional[VideoroomSessionInfo] # for subscribers this is their main session (the one used to join), for publishers is None self.publisher_id = None # janus publisher ID for publishers / publisher session ID for subscribers self.slow_download = False self.slow_upload = False self.feeds = PublisherFeedContainer() # keeps references to all the other participant's publisher feeds that we subscribed to def init_publisher(self, account, room): self.type = 'publisher' self.account = account self.room = room self.bitrate = room.config.max_bitrate self.chat_handler = VideoroomChatHandler(session=self) def init_subscriber(self, publisher_session, parent_session): assert publisher_session.type == parent_session.type == 'publisher' self.type = 'subscriber' self.publisher_id = publisher_session.id self.parent_session = parent_session self.account = parent_session.account self.room = parent_session.room self.bitrate = self.room.config.max_bitrate def __repr__(self): return '<{0.__class__.__name__}: type={0.type!r} id={0.id!r} janus_handle={0.janus_handle!r}>'.format(self) class PublisherFeedContainer(object): """A container for the other participant's publisher sessions that we have subscribed to""" def __init__(self): self._publishers = set() self._id_map = {} # map publisher.id -> publisher and publisher.publisher_id -> publisher def add(self, session): assert session not in self._publishers assert session.id not in self._id_map and session.publisher_id not in self._id_map self._publishers.add(session) self._id_map[session.id] = self._id_map[session.publisher_id] = session def discard(self, item): # item can be any of session, session.id or session.publisher_id session = self._id_map[item] if item in self._id_map else item if item in self._publishers else None if session is not None: self._publishers.discard(session) self._id_map.pop(session.id, None) self._id_map.pop(session.publisher_id, None) def remove(self, item): # item can be any of session, session.id or session.publisher_id session = self._id_map[item] if item in self._id_map else item self._publishers.remove(session) self._id_map.pop(session.id) self._id_map.pop(session.publisher_id) def pop(self, item): # item can be any of session, session.id or session.publisher_id session = self._id_map[item] if item in self._id_map else item self._publishers.remove(session) self._id_map.pop(session.id) self._id_map.pop(session.publisher_id) return session def clear(self): self._publishers.clear() self._id_map.clear() def __len__(self): return len(self._publishers) def __iter__(self): return iter(self._publishers) def __getitem__(self, key): return self._id_map[key] def __contains__(self, item): return item in self._id_map or item in self._publishers class Videoroom(object): def __init__(self, uri, audio, video): self.id = random.getrandbits(32) # janus needs numeric room names self.uri = uri self.audio = audio self.video = video self.config = get_room_config(uri) self.log = VideoroomLogger(self) self._active_participants = [] self._sessions = set() # type: Set[VideoroomSessionInfo] self._id_map = {} # type: Dict[Union[str, int], VideoroomSessionInfo] # map session.id -> session and session.publisher_id -> session self._shared_files = [] self._raised_hands = [] if self.config.record: makedirs(self.config.recording_dir, 0o755) self.log.info('created (recording on)') else: self.log.info('created') + if self.config.video_disabled: + self.video = False @property def active_participants(self): return self._active_participants @active_participants.setter def active_participants(self, participant_list): unknown_participants = set(participant_list).difference(self._id_map) if unknown_participants: raise ValueError('unknown participant session id: {}'.format(', '.join(unknown_participants))) if self._active_participants != participant_list: self._active_participants = participant_list self.log.info('active participants: {}'.format(', '.join(self._active_participants) or None)) self._update_bitrate() @property def raised_hands(self): return self._raised_hands @raised_hands.setter def raised_hands(self, session_id): if session_id in self._raised_hands: self.log.info('{session} lowers hand '.format(session=session_id)) self._raised_hands.remove(session_id) else: self.log.info('{session} raises hand '.format(session=session_id)) self._raised_hands.append(session_id) def add(self, session): assert session not in self._sessions assert session.publisher_id is not None assert session.publisher_id not in self._id_map and session.id not in self._id_map self._sessions.add(session) self._id_map[session.id] = self._id_map[session.publisher_id] = session self.log.info('{session.account.id} has joined'.format(session=session)) self._update_bitrate() if self._active_participants: session.owner.send(sylkrtc.VideoroomConfigureEvent(session=session.id, active_participants=self._active_participants, originator='videoroom')) if self._shared_files: session.owner.send(sylkrtc.VideoroomFileSharingEvent(session=session.id, files=self._shared_files)) if self._raised_hands: session.owner.send(sylkrtc.VideoroomRaisedHandsEvent(session=session.id, raised_hands=self._raised_hands)) # noinspection DuplicatedCode def discard(self, session): if session in self._sessions: self._sessions.discard(session) self._id_map.pop(session.id, None) self._id_map.pop(session.publisher_id, None) self.log.info('{session.account.id} has left'.format(session=session)) if session.id in self._active_participants: self._active_participants.remove(session.id) self.log.info('active participants: {}'.format(', '.join(self._active_participants) or None)) for session in self._sessions: session.owner.send(sylkrtc.VideoroomConfigureEvent(session=session.id, active_participants=self._active_participants, originator='videoroom')) self._update_bitrate() # noinspection DuplicatedCode def remove(self, session): self._sessions.remove(session) self._id_map.pop(session.id) self._id_map.pop(session.publisher_id) self.log.info('{session.account.id} has left'.format(session=session)) if session.id in self._active_participants: self._active_participants.remove(session.id) self.log.info('active participants: {}'.format(', '.join(self._active_participants) or None)) for session in self._sessions: session.owner.send(sylkrtc.VideoroomConfigureEvent(session=session.id, active_participants=self._active_participants, originator='videoroom')) self._update_bitrate() def clear(self): for session in self._sessions: self.log.info('{session.account.id} has left'.format(session=session)) self._active_participants = [] self._shared_files = [] self._sessions.clear() self._id_map.clear() def allow_uri(self, uri): config = self.config if config.access_policy == 'allow,deny': return config.allow.match(uri) and not config.deny.match(uri) else: return not config.deny.match(uri) or config.allow.match(uri) def add_file(self, upload_request): self._write_file(upload_request) def get_file(self, filename): path = os.path.join(self.config.filesharing_dir, filename) if os.path.exists(path): return path else: raise LookupError('file does not exist') @staticmethod def _fix_path(path): name, extension = os.path.splitext(path) for x in count(0, step=-1): path = '{}{}{}'.format(name, x or '', extension) if not os.path.exists(path) and not os.path.islink(path): return path @run_in_thread('file-io') def _write_file(self, upload_request): makedirs(self.config.filesharing_dir) path = self._fix_path(os.path.join(self.config.filesharing_dir, upload_request.shared_file.filename)) upload_request.shared_file.filename = os.path.basename(path) try: with open(path, 'wb') as output_file: copyfileobj(upload_request.content, output_file) except (OSError, IOError): upload_request.had_error = True unlink(path) self._write_file_done(upload_request) @run_in_twisted_thread def _write_file_done(self, upload_request): if upload_request.had_error: upload_request.deferred.errback(InternalServerError('could not save file')) else: self._shared_files.append(upload_request.shared_file) for session in self._sessions: session.owner.send(sylkrtc.VideoroomFileSharingEvent(session=session.id, files=[upload_request.shared_file])) upload_request.deferred.callback('OK') def cleanup(self): self._remove_files() @run_in_thread('file-io') def _remove_files(self): rmtree(self.config.filesharing_dir, ignore_errors=True) def _update_bitrate(self): if self._sessions: if self._active_participants: # todo: should we use max_bitrate / 2 or max_bitrate for each active participant if there are 2 active participants? active_participant_bitrate = self.config.max_bitrate // len(self._active_participants) other_participant_bitrate = 100000 self.log.debug('participant bitrate is {} (active) / {} (others)'.format(active_participant_bitrate, other_participant_bitrate)) for session in self._sessions: if session.id in self._active_participants: bitrate = active_participant_bitrate else: bitrate = other_participant_bitrate if session.bitrate != bitrate: session.bitrate = bitrate session.janus_handle.message(janus.VideoroomUpdatePublisher(bitrate=bitrate), _async=True) else: bitrate = self.config.max_bitrate // limit(len(self._sessions) - 1, min=1) self.log.debug('participant bitrate is {}'.format(bitrate)) for session in self._sessions: if session.bitrate != bitrate: session.bitrate = bitrate session.janus_handle.message(janus.VideoroomUpdatePublisher(bitrate=bitrate), _async=True) # todo: make Videoroom be a context manager that is retained/released on enter/exit and implement __nonzero__ to be different from __len__ # todo: so that a videoroom is not accidentally released by the last participant leaving while a new participant waits to join # todo: this needs a new model for communication with janus and the client that is pseudo-synchronous (uses green threads) def __len__(self): return len(self._sessions) def __iter__(self): return iter(self._sessions) def __getitem__(self, key): return self._id_map[key] def __contains__(self, item): return item in self._id_map or item in self._sessions SessionT = TypeVar('SessionT', SIPSessionInfo, VideoroomSessionInfo) class SessionContainer(Sized, Iterable[SessionT], Container[SessionT], Generic[SessionT]): def __init__(self): self._sessions = set() self._id_map = {} # map session.id -> session and session.janus_handle.id -> session def add(self, session): assert session not in self._sessions assert session.id not in self._id_map and session.janus_handle.id not in self._id_map self._sessions.add(session) self._id_map[session.id] = self._id_map[session.janus_handle.id] = session def discard(self, item): # item can be any of session, session.id or session.janus_handle.id session = self._id_map[item] if item in self._id_map else item if item in self._sessions else None if session is not None: self._sessions.discard(session) self._id_map.pop(session.id, None) self._id_map.pop(session.janus_handle.id, None) def remove(self, item): # item can be any of session, session.id or session.janus_handle.id session = self._id_map[item] if item in self._id_map else item self._sessions.remove(session) self._id_map.pop(session.id) self._id_map.pop(session.janus_handle.id) def pop(self, item): # item can be any of session, session.id or session.janus_handle.id session = self._id_map[item] if item in self._id_map else item self._sessions.remove(session) self._id_map.pop(session.id) self._id_map.pop(session.janus_handle.id) return session def clear(self): self._sessions.clear() self._id_map.clear() def __len__(self): return len(self._sessions) def __iter__(self): return iter(self._sessions) def __getitem__(self, key): return self._id_map[key] def __contains__(self, item): return item in self._id_map or item in self._sessions class OperationName(str): __normalizer__ = str.maketrans('-', '_') @property def normalized(self): return self.translate(self.__normalizer__) class Operation(object): __slots__ = 'type', 'name', 'data' __types__ = 'request', 'event' # noinspection PyShadowingBuiltins def __init__(self, type, name, data): if type not in self.__types__: raise ValueError("Can't instantiate class {.__class__.__name__} with unknown type: {!r}".format(self, type)) self.type = type self.name = OperationName(name) self.data = data class APIError(Exception): pass class GreenEvent(object): def __init__(self): self._event = coros.event() def set(self): if self._event.ready(): return self._event.send(True) def is_set(self): return self._event.ready() def clear(self): if self._event.ready(): self._event.reset() def wait(self): return self._event.wait() # noinspection PyPep8Naming @implementer(IObserver) class ConnectionHandler(object): janus = JanusBackend() def __init__(self, protocol): self.protocol = protocol self.device_id = base64.b64encode(hashlib.md5(protocol.peer.encode('utf-8')).digest()).rstrip(b'=\n').decode('utf-8') self.janus_session = None # type: Optional[JanusSession] self.accounts_map = {} # account ID -> account self.devices_map = {} # device ID -> account self.connections_map = {} # peer connection -> account self.account_handles_map = {} # Janus handle ID -> account self.sip_sessions = SessionContainer() # type: SessionContainer[SIPSessionInfo] # incoming and outgoing SIP sessions self.videoroom_sessions = SessionContainer() # type: SessionContainer[VideoroomSessionInfo] # publisher and subscriber sessions in video rooms self.ready_event = GreenEvent() self.resolver = DNSLookup() self.proc = proc.spawn(self._operations_handler) self.operations_queue = coros.queue() self.log = ConnectionLogger(self) self.state = None self._stop_pending = False self.decline_code = JanusConfig.decline_code or 486 @run_in_green_thread def start(self): self.state = 'starting' try: self.janus_session = JanusSession() except Exception as e: self.state = 'failed' self.log.warning('could not create session, disconnecting: %s' % e) if self._stop_pending: # if stop was already called it means we were already disconnected self.stop() else: self.protocol.disconnect(3000, str(e)) else: self.state = 'started' self.ready_event.set() if self._stop_pending: self.stop() else: self.send(sylkrtc.ReadyEvent()) def stop(self): if self.state in (None, 'starting'): self._stop_pending = True return self.state = 'stopping' self._stop_pending = False if self.proc is not None: # Kill the operation's handler proc first, in order to not have any operations active while we cleanup. self.proc.kill() # Also proc.kill() will switch to another green thread, which is another reason to do it first so that self.proc = None # we do not switch to another green thread in the middle of the cleanup with a partially deleted handler if self.ready_event.is_set(): # Do not explicitly detach the janus plugin handles before destroying the janus session. Janus runs each request in a different # thread, so making detach and destroy request without waiting for the detach to finish can result in errors from race conditions. # Because we do not want to wait for them, we will rely instead on the fact that janus automatically detaches the plugin handles # when it destroys a session, so we only remove our event handlers and issue a destroy request for the session. for account_info in list(self.accounts_map.values()): if account_info.janus_handle is not None: self.janus.set_event_handler(account_info.janus_handle.id, None) notification_center = NotificationCenter() notification_center.remove_observer(self, sender=account_info.id) for session in self.sip_sessions: if session.janus_handle is not None: self.janus.set_event_handler(session.janus_handle.id, None) for session in self.videoroom_sessions: if session.janus_handle is not None: self.janus.set_event_handler(session.janus_handle.id, None) if session.chat_handler is not None: notification_center = NotificationCenter() notification_center.remove_observer(self, sender=session.chat_handler) session.chat_handler.end() session.chat_handler = None if session in session.room: # We need to check if the room can be destroyed, else this will never happen reactor.callLater(2, call_in_green_thread, self._maybe_destroy_videoroom_after_disconnect, session.room) session.room.discard(session) session.feeds.clear() self.janus_session.destroy() # this automatically detaches all plugin handles associated with it, no need to manually do it # cleanup self.ready_event.clear() self.accounts_map.clear() self.devices_map.clear() self.connections_map.clear() self.account_handles_map.clear() self.sip_sessions.clear() self.videoroom_sessions.clear() self.janus_session = None self.protocol = None self.state = 'stopped' def handle_notification(self, notification): handler = getattr(self, '_NH_%s' % notification.name, Null) handler(notification) def handle_message(self, message): try: request = sylkrtc.SylkRTCRequest.from_message(message) except sylkrtc.ProtocolError as e: self.log.error(str(e)) except Exception as e: self.log.error('{request_type}: {exception!s}'.format(request_type=message['sylkrtc'], exception=e)) if 'transaction' in message: self.send(sylkrtc.ErrorResponse(transaction=message['transaction'], error=str(e))) else: operation = Operation(type='request', name=request.sylkrtc, data=request) self.operations_queue.send(operation) def send(self, message): if self.protocol is not None: self.protocol.sendMessage(json.dumps(message.__data__)) # internal methods (not overriding / implementing the protocol API) def _cleanup_session(self, session): # should only be called from a green thread. if self.janus_session is None: # The connection was closed, there is noting to do return if session in self.sip_sessions: self.sip_sessions.remove(session) if session.direction == 'outgoing': # Destroy plugin handle for outgoing sessions. For incoming ones it's the same as the account handle, so don't session.janus_handle.detach() def _cleanup_videoroom_session(self, session): # should only be called from a green thread. if self.janus_session is None: # The connection was closed, there is noting to do return if session in self.videoroom_sessions: self.videoroom_sessions.remove(session) if session.type == 'publisher': notification_center = NotificationCenter() notification_center.remove_observer(self, sender=session.chat_handler) session.room.discard(session) session.feeds.clear() session.janus_handle.detach() session.chat_handler.end() self._maybe_destroy_videoroom(session.room) else: session.parent_session.feeds.discard(session.publisher_id) session.janus_handle.detach() def _maybe_destroy_videoroom(self, videoroom): # should only be called from a green thread. if self.protocol is None or self.janus_session is None: # The connection was closed, there is nothing to do return if videoroom in self.protocol.factory.videorooms and not videoroom: self.protocol.factory.videorooms.remove(videoroom) videoroom.cleanup() with VideoroomPluginHandle(self.janus_session, event_handler=self._handle_janus_videoroom_event) as videoroom_handle: videoroom_handle.destroy(room=videoroom.id) videoroom.log.info('destroyed') def _maybe_destroy_videoroom_after_disconnect(self, videoroom): # should only be called from a green thread. if self.protocol is None and not videoroom: videoroom.cleanup() videoroom.log.info('destroyed') def _lookup_sip_proxy(self, uri): # The proxy dance: Sofia-SIP seems to do a DNS lookup per SIP message when a domain is passed # as the proxy, so do the resolution ourselves and give it pre-resolver proxy URL. Since we use # caching to avoid long delays, we randomize the results matching the highest priority route's # transport. proxy = GeneralConfig.outbound_sip_proxy if proxy is not None: sip_uri = SIPURI(host=proxy.host, port=proxy.port, parameters={'transport': proxy.transport}) else: sip_uri = SIPURI.parse('sip:%s' % uri) settings = SIPSimpleSettings() try: routes = self.resolver.lookup_sip_proxy(sip_uri, settings.sip.transport_list).wait() except DNSLookupError as e: raise DNSLookupError('DNS lookup error: {exception!s}'.format(exception=e)) if not routes: raise DNSLookupError('DNS lookup error: no results found') route = random.choice([r for r in routes if r.transport == routes[0].transport]) self.log.debug('DNS lookup for SIP proxy for {} yielded {}'.format(uri, route)) # Build a proxy URI Sofia-SIP likes return 'sips:{route.address}:{route.port}'.format(route=route) if route.transport == 'tls' else str(route.uri) def _callid_to_uuid(self, callid): hexa = hashlib.md5(callid.encode()).hexdigest() uuidv4 = '%s-%s-%s-%s-%s' % (hexa[:8], hexa[8:12], hexa[12:16], hexa[16:20], hexa[20:]) return uuidv4 def _lookup_sip_target_route(self, uri): # TODO - add support for outbound proxy setting from server configuration -adi if GeneralConfig.local_sip_messages: return Route(address=SIPConfig.local_ip, port=SIPConfig.local_tcp_port, transport='tcp') sip_uri = SIPURI.parse('sip:%s' % uri) settings = SIPSimpleSettings() try: routes = self.resolver.lookup_sip_proxy(sip_uri, settings.sip.transport_list).wait() except DNSLookupError as e: raise DNSLookupError('DNS lookup error: {exception!s}'.format(exception=e)) if not routes: raise DNSLookupError('DNS lookup error: no results found') route = random.choice([r for r in routes if r.transport == routes[0].transport]) self.log.debug('DNS lookup for SIP message proxy for {} yielded {}'.format(uri, route)) return route def _send_sip_message(self, account, uri, message_id, content, content_type='text/plain', timestamp=None, add_disposition=True): route = self._lookup_sip_target_route(uri) sip_uri = SIPURI.parse('sip:%s' % uri) if route: identity = str(account.uri) if account.display_name: identity = '"%s" <%s>' % (account.display_name, identity) self.log.debug("sending message from '%s' to '%s' using proxy %s" % (identity, uri, route)) from_uri = SIPURI.parse(account.uri) content = content if isinstance(content, bytes) else content.encode() ns = CPIMNamespace('urn:ietf:params:imdn', 'imdn') additional_headers = [CPIMHeader('Message-ID', ns, message_id)] additional_sip_headers = [] if add_disposition: additional_headers.append(CPIMHeader('Disposition-Notification', ns, 'positive-delivery, display')) if GeneralConfig.local_sip_messages: additional_sip_headers.append(Header('X-Sylk-App', 'webrtcgateway')) payload = CPIMPayload(content, content_type, charset='utf-8', sender=ChatIdentity(from_uri, account.display_name), recipients=[ChatIdentity(sip_uri, None)], timestamp=timestamp if timestamp is not None else str(ISOTimestamp.now()), additional_headers=additional_headers) payload, content_type = payload.encode() credentials = Credentials(username=from_uri.user, password=account.password.encode('utf-8'), digest=True) message_request = Message(FromHeader(from_uri, account.display_name), ToHeader(sip_uri), RouteHeader(route.uri), content_type, payload, credentials=credentials, extra_headers=additional_sip_headers) notification_center = NotificationCenter() notification_center.add_observer(self, sender=message_request) #self._message_queue.append((message_id, content, content_type)) message_request.send() def _fork_event_to_online_accounts(self, account_info, event): for protocol in self.protocol.factory.connections.difference([self.protocol]): connection_handler = protocol.connection_handler try: connection_handler.accounts_map[account_info.id] except KeyError: pass else: connection_handler.send(event) def _handle_janus_sip_event(self, event): operation = Operation(type='event', name='janus-sip', data=event) self.operations_queue.send(operation) def _handle_janus_videoroom_event(self, event): operation = Operation(type='event', name='janus-videoroom', data=event) self.operations_queue.send(operation) def _operations_handler(self): self.ready_event.wait() while True: operation = self.operations_queue.wait() handler = getattr(self, '_OH_' + operation.type) handler(operation) del operation, handler def _OH_request(self, operation): handler = getattr(self, '_RH_' + operation.name.normalized) request = operation.data try: handler(request) except (APIError, DNSLookupError, JanusError) as e: self.log.error('{operation.name}: {exception!s}'.format(operation=operation, exception=e)) self.send(sylkrtc.ErrorResponse(transaction=request.transaction, error=str(e))) except Exception as e: self.log.exception('{operation.type} {operation.name}: {exception!s}'.format(operation=operation, exception=e)) self.send(sylkrtc.ErrorResponse(transaction=request.transaction, error='Internal error')) else: self.send(sylkrtc.AckResponse(transaction=request.transaction)) def _OH_event(self, operation): handler = getattr(self, '_EH_' + operation.name.normalized) try: handler(operation.data) except Exception as e: self.log.exception('{operation.type} {operation.name}: {exception!s}'.format(operation=operation, exception=e)) # Request handlers def _RH_ping(self, request): pass def _RH_lookup_public_key(self, request): storage = MessageStorage() public_key = storage.get_public_key(account=request.uri) if isinstance(public_key, defer.Deferred): public_key.addCallback(lambda result: self.send(sylkrtc.LookupPublicKeyEvent(uri=request.uri, public_key=result))) def _RH_account_add(self, request): if request.account in self.accounts_map: raise APIError('Account {request.account} already added'.format(request=request)) # check if domain is acceptable domain = request.account.partition('@')[2] if not {'*', domain}.intersection(GeneralConfig.sip_domains): raise APIError('SIP domain not allowed: %s' % domain) # Create and store our mapping account_info = AccountInfo(request.account, request.password, request.display_name, request.user_agent) # get the auth config for domain account_info.auth_handle = AuthHandler(account_info, self) self.accounts_map[account_info.id] = account_info self.devices_map[self.device_id] = account_info.id self.connections_map[self.protocol.peer] = account_info.id notification_center = NotificationCenter() notification_center.add_observer(self, sender=account_info.id) self.log.info('added using {request.user_agent}'.format(request=request)) def _RH_account_remove(self, request): try: account_info = self.accounts_map.pop(request.account) except KeyError: raise APIError('Unknown account specified for remove: {request.account}'.format(request=request)) # cleanup in case the client didn't unregister before removing the account if account_info.janus_handle is not None: account_info.janus_handle.detach() self.account_handles_map.pop(account_info.janus_handle.id) notification_center = NotificationCenter() notification_center.remove_observer(self, sender=account_info.id) self.log.info('removed') try: del(self.devices_map[request.account]) except KeyError: pass try: del(self.connections_map[request.account]) except KeyError: pass def _RH_account_register(self, request): try: account_info = self.accounts_map[request.account] except KeyError: raise APIError('Unknown account specified for register: {request.account}'.format(request=request)) proxy = self._lookup_sip_proxy(request.account) if account_info.janus_handle is not None: # Destroy the existing plugin handle account_info.janus_handle.detach() self.account_handles_map.pop(account_info.janus_handle.id) account_info.janus_handle = None # Create a plugin handle account_info.janus_handle = SIPPluginHandle(self.janus_session, event_handler=self._handle_janus_sip_event) self.account_handles_map[account_info.janus_handle.id] = account_info if ExternalAuthConfig.enable: account_info.auth_handle.authenticate(proxy) else: account_info.janus_handle.register(account_info, proxy=proxy) self.log.info('registering to SIP Proxy {proxy}...'.format(proxy=proxy)) def _RH_account_unregister(self, request): try: account_info = self.accounts_map[request.account] except KeyError: raise APIError('Unknown account specified for unregister: {request.account}'.format(request=request)) if account_info.janus_handle is not None: account_info.janus_handle.detach() self.account_handles_map.pop(account_info.janus_handle.id) account_info.janus_handle = None if 'pn_app' in account_info.contact_params: storage = TokenStorage() storage.remove(request.account, account_info.contact_params['pn_app'], account_info.contact_params['pn_device']) self.log.info('registered') def _RH_account_devicetoken(self, request): if request.account not in self.accounts_map: raise APIError('Unknown account specified for token: {request.account}'.format(request=request)) if request.token is not None: account_info = self.accounts_map[request.account] account_info.contact_params = { 'pn_app': request.app, 'pn_tok': request.token, 'pn_type': request.platform, 'pn_device': request.device, 'pn_silent': str(int(request.silent is True)) # janus expects a string } storage = TokenStorage() storage.add(request.account, account_info.contact_params, account_info.user_agent) self.log.info('added token on {request.platform} device {request.device})'.format(request=request)) def _RH_account_message(self, request): try: account_info = self.accounts_map[request.account] except KeyError: raise APIError('Unknown account specified: {request.account}'.format(request=request)) uri = request.uri content_type = request.content_type content = request.content if content_type.startswith('text') else request.content.encode('latin1') message_id = request.message_id timestamp = request.timestamp storage = MessageStorage() storage.add(account=account_info.id, contact=uri, direction="outgoing", content = content if isinstance(content, str) else content.decode('latin1'), content_type=content_type, timestamp=timestamp, disposition_notification=['positive-delivery', 'display'], message_id=message_id, state='pending') self.log.info('sending message ({content_type}) to: {uri}'.format(content_type=content_type, uri=uri)) self._send_sip_message(account_info, uri, message_id, content, content_type, timestamp=timestamp) event = sylkrtc.AccountSyncEvent(account=account_info.id, type='message', action='add', content=request) self._fork_event_to_online_accounts(account_info, event) def _RH_account_disposition_notification(self, request): try: account_info = self.accounts_map[request.account] except KeyError: raise APIError('Unknown account specified: {request.account}'.format(request=request)) uri = request.uri message_id = request.message_id state = request.state if state == 'delivered': notification = DeliveryNotification(state) elif state == 'displayed': notification = DisplayNotification(state) content = IMDNDocument.create(message_id=message_id, datetime=request.timestamp, recipient_uri=uri, notification=notification) storage = MessageStorage() storage.update(account=account_info.id, state=state, message_id=message_id) self.log.info('sending IMDN message ({status}) to: {uri}'.format(status=state, uri=uri)) self._send_sip_message(account_info, uri, str(uuid.uuid4()), content, IMDNDocument.content_type, add_disposition=False) def _RH_account_sync_conversations(self, request): try: account_info = self.accounts_map[request.account] except KeyError: raise APIError('Unknown account specified: {request.account}'.format(request=request)) storage = MessageStorage() messages = storage[[account_info.id, request.message_id]] if isinstance(messages, defer.Deferred): messages.addCallback(lambda result: self.send(sylkrtc.AccountSyncConversationsEvent(account=account_info.id, messages=result))) def _RH_account_mark_conversation_read(self, request): try: account_info = self.accounts_map[request.account] except KeyError: raise APIError('Unknown account specified: {request.account}'.format(request=request)) contact = request.contact event = sylkrtc.AccountMarkConversationReadEventData(contact=request.contact) storage = MessageStorage() storage.mark_conversation_read(account_info.id, contact) storage.add(account=account_info.id, contact=request.contact, direction='', content=request.contact, content_type='application/sylk-conversation-read', timestamp=str(ISOTimestamp.now()), disposition_notification='', message_id=str(uuid.uuid4())) event = sylkrtc.AccountSyncEvent(account=account_info.id, type='conversation', action='read', content=event) self._fork_event_to_online_accounts(account_info, event) def _RH_account_remove_message(self, request): try: account_info = self.accounts_map[request.account] except KeyError: raise APIError('Unknown account specified: {request.account}'.format(request=request)) contact = request.contact message_id = request.message_id storage = MessageStorage() storage.removeMessage(account=account_info.id, message_id=message_id) content = sylkrtc.AccountMessageRemoveEventData(contact=contact, message_id=message_id) storage.add(account=account_info.id, contact=contact, direction='', content=json.dumps(content.__data__), content_type='application/sylk-message-remove', timestamp=str(ISOTimestamp.now()), disposition_notification='', message_id=str(uuid.uuid4())) event = sylkrtc.AccountSyncEvent(account=account_info.id, type='message', action='remove', content=content) self._fork_event_to_online_accounts(account_info, event) # Delete from receiver def receiver_remove_message(msg_id, messages): for message in messages: if message.message_id == msg_id and message.direction == 'incoming': account = message.account message_id = message.message_id storage = MessageStorage() storage.removeMessage(account=account, message_id=message_id) content = sylkrtc.AccountMessageRemoveEventData(contact=message.contact, message_id=message_id) storage.add(account=account, contact=message.contact, direction='', content=json.dumps(content.__data__), content_type='application/sylk-message-remove', timestamp=str(ISOTimestamp.now()), disposition_notification='', message_id=str(uuid.uuid4())) event = sylkrtc.AccountSyncEvent(account=account, type='message', action='remove', content=content) account_object = type('account_object', (object,), {'id': account}) self._fork_event_to_online_accounts(account_object, event) self.log.info("Removed receiver message") break messages = storage[[contact, '']] if isinstance(messages, defer.Deferred): messages.addCallback(lambda result: receiver_remove_message(msg_id=request.message_id, messages=result)) def _RH_account_remove_conversation(self, request): try: account_info = self.accounts_map[request.account] except KeyError: raise APIError('Unknown account specified: {request.account}'.format(request=request)) contact = request.contact storage = MessageStorage() storage.removeChat(account=account_info.id, contact=contact) storage.add(account=account_info.id, contact=contact, direction='', content=contact, content_type='application/sylk-conversation-remove', timestamp=str(ISOTimestamp.now()), disposition_notification='', message_id=str(uuid.uuid4())) content = sylkrtc.AccountConversationRemoveEventData(contact=contact) event = sylkrtc.AccountSyncEvent(account=account_info.id, type='conversation', action='remove', content=content) self._fork_event_to_online_accounts(account_info, event) def _RH_session_create(self, request): if request.session in self.sip_sessions: raise APIError('Session ID {request.session} already in use'.format(request=request)) try: account_info = self.accounts_map[request.account] except KeyError: raise APIError('Unknown account specified: {request.account}'.format(request=request)) proxy = self._lookup_sip_proxy(request.uri) # Create a new plugin handle and 'register' it, without actually doing so janus_handle = SIPPluginHandle(self.janus_session, event_handler=self._handle_janus_sip_event) try: janus_handle.call(account_info, uri=request.uri, sdp=request.sdp, proxy=proxy) except Exception: janus_handle.detach() raise session_info = SIPSessionInfo(request.session) session_info.janus_handle = janus_handle session_info.init_outgoing(account_info, request.uri) self.sip_sessions.add(session_info) self.log.info('outgoing session {request.session} to {request.uri}'.format(request=request)) def _RH_session_answer(self, request): try: session_info = self.sip_sessions[request.session] except KeyError: raise APIError('Unknown session {request.session}'.format(request=request)) if session_info.direction != 'incoming': raise APIError('Cannot answer outgoing session {request.session}'.format(request=request)) if session_info.state != 'connecting': raise APIError('Invalid state for answering session {session.id}: {session.state}'.format(session=session_info)) session_info.janus_handle.accept(sdp=request.sdp) self.log.info('incoming session {session.id} answered'.format(session=session_info)) def _RH_session_trickle(self, request): try: session_info = self.sip_sessions[request.session] except KeyError: raise APIError('Unknown session {request.session}'.format(request=request)) if session_info.state == 'terminated': raise APIError('Session {request.session} is terminated'.format(request=request)) session_info.janus_handle.trickle(request.candidates) if not request.candidates: self.log.debug('session {session.id} negotiated ICE'.format(session=session_info)) def _RH_session_terminate(self, request): try: session_info = self.sip_sessions[request.session] except KeyError: raise APIError('Unknown session {request.session}'.format(request=request)) if session_info.state not in ('connecting', 'progress', 'early_media', 'accepted', 'established'): raise APIError('Invalid state for terminating session {session.id}: {session.state}'.format(session=session_info)) if session_info.direction == 'incoming' and session_info.state == 'connecting': session_info.janus_handle.decline(self.decline_code) else: session_info.janus_handle.hangup() self.log.info('{session.direction} session {session.id} will terminate'.format(session=session_info)) def _RH_videoroom_join(self, request): if request.session in self.videoroom_sessions: raise APIError('Session ID {request.session} already in use'.format(request=request)) try: account_info = self.accounts_map[request.account] except KeyError: raise APIError('Unknown account specified: {request.account}'.format(request=request)) try: videoroom = self.protocol.factory.videorooms[request.uri] except KeyError: videoroom = Videoroom(request.uri, request.audio, request.video) self.protocol.factory.videorooms.add(videoroom) if not videoroom.allow_uri(request.account): self._maybe_destroy_videoroom(videoroom) raise APIError('is not allowed to join room {request.uri}'.format(request=request)) if ('m=video' in request.sdp and 'm=audio' in request.sdp): media = 'audio/video' elif ('m=video' in request.sdp): media = 'video only' elif ('m=audio' in request.sdp): media = 'audio only' else: media = 'unknown' try: videoroom_handle = VideoroomPluginHandle(self.janus_session, event_handler=self._handle_janus_videoroom_event) try: try: videoroom_handle.create(room=videoroom.id, config=videoroom.config, publishers=10) except JanusError as e: if e.code != 427: # 427 means room already exists raise else: self.log.info('created room {room}'.format(room=request.uri)) videoroom_handle.join(room=videoroom.id, sdp=request.sdp, display_name=account_info.display_name, audio=videoroom.audio, video=videoroom.video) except Exception: videoroom_handle.detach() raise except Exception: self._maybe_destroy_videoroom(videoroom) raise videoroom_session = VideoroomSessionInfo(request.session, owner=self, janus_handle=videoroom_handle) videoroom_session.init_publisher(account=account_info, room=videoroom) self.log.info('publish {media} to room {room}'.format(room=request.uri, media=media)) self.videoroom_sessions.add(videoroom_session) notification_center = NotificationCenter() notification_center.add_observer(self, sender=videoroom_session.chat_handler) videoroom_session.chat_handler.start() self.send(sylkrtc.VideoroomSessionProgressEvent(session=videoroom_session.id)) def _RH_videoroom_leave(self, request): try: videoroom_session = self.videoroom_sessions[request.session] except KeyError: raise APIError('Unknown room session: {request.session}'.format(request=request)) videoroom_session.janus_handle.leave() self.send(sylkrtc.VideoroomSessionTerminatedEvent(session=videoroom_session.id)) # safety net in case we do not get any answer for the leave request # todo: to be adjusted later after pseudo-synchronous communication with janus is implemented reactor.callLater(2, call_in_green_thread, self._cleanup_videoroom_session, videoroom_session) self.log.debug('leaving room {session.room.uri}'.format(session=videoroom_session)) def _RH_videoroom_configure(self, request): try: videoroom_session = self.videoroom_sessions[request.session] except KeyError: raise APIError('Unknown room session: {request.session}'.format(request=request)) videoroom = videoroom_session.room # todo: should we send out events if the active participant list did not change? try: videoroom.active_participants = request.active_participants except ValueError as e: raise APIError(str(e)) for session in videoroom: session.owner.send(sylkrtc.VideoroomConfigureEvent(session=session.id, active_participants=videoroom.active_participants, originator=request.session)) def _RH_videoroom_feed_attach(self, request): # sent when a feed is subscribed for a given publisher if request.feed in self.videoroom_sessions: raise APIError('Video room session ID {request.feed} already in use'.format(request=request)) try: base_session = self.videoroom_sessions[request.session] # our 'base' session (the one used to join and publish) except KeyError: raise APIError('Unknown room session: {request.session}'.format(request=request)) try: publisher_session = base_session.room[request.publisher] # the publisher's session (the one we want to subscribe to) except KeyError: raise APIError('Unknown publisher room session to attach to: {request.publisher}'.format(request=request)) if publisher_session.publisher_id is None: raise APIError('Video room session {session.id} does not have a publisher ID'.format(session=publisher_session)) videoroom_handle = VideoroomPluginHandle(self.janus_session, event_handler=self._handle_janus_videoroom_event) try: videoroom_handle.feed_attach(room=base_session.room.id, feed=publisher_session.publisher_id, offer_audio=base_session.room.audio, offer_video=base_session.room.video) except Exception: videoroom_handle.detach() raise videoroom_session = VideoroomSessionInfo(request.feed, owner=self, janus_handle=videoroom_handle) videoroom_session.init_subscriber(publisher_session, parent_session=base_session) self.videoroom_sessions.add(videoroom_session) base_session.feeds.add(publisher_session) self.log.debug('subscribe to {account} in room {session.room.uri} {feeds}'.format(account=publisher_session.account.id, session=videoroom_session, feeds=len(base_session.feeds))) def _RH_videoroom_feed_answer(self, request): try: videoroom_session = self.videoroom_sessions[request.feed] except KeyError: raise APIError('Unknown room session: {request.feed}'.format(request=request)) if videoroom_session.parent_session.id != request.session: raise APIError('{request.feed} is not an attached feed of {request.session}'.format(request=request)) if ('m=video' in request.sdp and 'm=audio' in request.sdp): media = 'audio/video' elif ('m=video' in request.sdp): media = 'video only' elif ('m=audio' in request.sdp): media = 'audio only' else: media = 'unknown' self.log.debug('{media} media accepted by room {session.room.uri}'.format(media=media, session=videoroom_session)) videoroom_session.janus_handle.feed_start(sdp=request.sdp) def _RH_videoroom_feed_detach(self, request): try: videoroom_session = self.videoroom_sessions[request.feed] except KeyError: raise APIError('Unknown room session to detach: {request.feed}'.format(request=request)) if videoroom_session.parent_session.id != request.session: raise APIError('{request.feed} is not an attached feed of {request.session}'.format(request=request)) videoroom_session.janus_handle.feed_detach() # safety net in case we do not get any answer for the feed_detach request # todo: to be adjusted later after pseudo-synchronous communication with janus is implemented self.log.debug('unsubscribe from {account} in room {session.room.uri}'.format(account=videoroom_session.room[videoroom_session.publisher_id].account.id, session=videoroom_session)) reactor.callLater(2, call_in_green_thread, self._cleanup_videoroom_session, videoroom_session) def _RH_videoroom_invite(self, request): try: base_session = self.videoroom_sessions[request.session] except KeyError: raise APIError('Unknown room session: {request.session}'.format(request=request)) room = base_session.room participants = set(request.participants) originator = sylkrtc.SIPIdentity(uri=base_session.account.id, display_name=base_session.account.display_name) session_id = str(random.getrandbits(32)) event = sylkrtc.AccountConferenceInviteEvent(account='placeholder', room=room.uri, originator=originator, session_id=self._callid_to_uuid(session_id)) for protocol in self.protocol.factory.connections.difference([self.protocol]): connection_handler = protocol.connection_handler for account in participants.intersection(connection_handler.accounts_map): event.account = account connection_handler.send(event) room.log.info('invitation from %s for %s', originator.uri, account) room.log.debug('invitation from %s for %s with session-id %s', originator.uri, account, session_id) connection_handler.log.info('received an invitation from %s for %s to join room %s', originator.uri, account, room.uri) for participant in participants.difference([base_session.account.id]): if not any(session.account.id == participant for session in base_session.room): push.conference_invite(originator=originator, destination=participant, room=room.uri, call_id=session_id, audio=room.audio, video=room.video) def _RH_videoroom_session_trickle(self, request): try: videoroom_session = self.videoroom_sessions[request.session] except KeyError: raise APIError('Unknown room session: {request.session}'.format(request=request)) videoroom_session.janus_handle.trickle(request.candidates) if not request.candidates and videoroom_session.type == 'publisher': self.log.debug('ICE negotiation to room {session.room.uri} completed'.format(session=videoroom_session)) def _RH_videoroom_session_update(self, request): try: videoroom_session = self.videoroom_sessions[request.session] except KeyError: raise APIError('Unknown room session: {request.session}'.format(request=request)) options = request.options.__data__ if options: videoroom_session.janus_handle.update_publisher(options) modified = ', '.join('{}={}'.format(key, options[key]) for key in options) media = 'video' try: has_video = options['video'] except KeyError: pass else: if not has_video: media = 'audio only' self.log.info('switched to {media} media to {account} in room {session.room.uri}'.format(account=videoroom_session.room[videoroom_session.publisher_id].account.id, session=videoroom_session, media=media)) def _RH_videoroom_message(self, request): try: videoroom_session = self.videoroom_sessions[request.session] except KeyError: raise APIError('Unknown room session: {request.session}'.format(request=request)) content_type = request.content_type content = request.content if content_type.startswith('text') else request.content.encode('latin1') message_id = request.message_id videoroom_session.chat_handler.send_message(message_id, content, content_type) def _RH_videoroom_composing_indication(self, request): try: videoroom_session = self.videoroom_sessions[request.session] except KeyError: raise APIError('Unknown room session: {request.session}'.format(request=request)) videoroom_session.chat_handler.send_composing_indication(request.state, request.refresh) def _RH_videoroom_mute_audio_participants(self, request): try: videoroom_session = self.videoroom_sessions[request.session] except KeyError: raise APIError('Unknown room session: {request.session}'.format(request=request)) videoroom = videoroom_session.room for session in videoroom: session.owner.send(sylkrtc.VideoroomMuteAudioEvent(session=session.id, originator=request.session)) def _RH_videoroom_toggle_hand(self, request): try: videoroom_session = self.videoroom_sessions[request.session] except KeyError: raise APIError('Unknown room session: {request.session}'.format(request=request)) videoroom = videoroom_session.room if request.session_id: request_session = request.session_id else: request_session = request.session videoroom.raised_hands = request_session for session in videoroom: session.owner.send(sylkrtc.VideoroomRaisedHandsEvent(session=session.id, raised_hands=videoroom.raised_hands)) # Event handlers def _EH_janus_sip(self, event): if isinstance(event, janus.PluginEvent): event_id = event.plugindata.data.__id__ try: handler = getattr(self, '_EH_janus_' + '_'.join(event_id)) except AttributeError: self.log.warning('unhandled Janus SIP event: {event_name}'.format(event_name=event_id[-1])) else: self.log.debug('janus SIP event: {event_name} (handle_id={event.sender})'.format(event=event, event_name=event_id[-1])) handler(event) else: # janus.CoreEvent try: handler = getattr(self, '_EH_janus_sip_' + event.janus) except AttributeError: self.log.warning('unhandled Janus SIP event: {event.janus}'.format(event=event)) else: self.log.debug('janus SIP event: {event.janus} (handle_id={event.sender})'.format(event=event)) handler(event) def _EH_janus_sip_error(self, event): # fixme: implement error handling self.log.error('got SIP error event: {}'.format(event.__data__)) handle_id = event.sender if handle_id in self.sip_sessions: pass # this is a session related event elif handle_id in self.account_handles_map: pass # this is an account related event def _EH_janus_sip_webrtcup(self, event): try: session_info = self.sip_sessions[event.sender] except KeyError: self.log.warning('could not find SIP session with handle ID {event.sender} for webrtcup event'.format(event=event)) return session_info.state = 'established' self.send(sylkrtc.SessionEstablishedEvent(session=session_info.id)) self.log.info('{session.direction} session {session.id} established'.format(session=session_info)) def _EH_janus_sip_hangup(self, event): try: session_info = self.sip_sessions[event.sender] except KeyError: return if session_info.state != 'terminated': session_info.state = 'terminated' reason = event.reason or 'unspecified reason' self.send(sylkrtc.SessionTerminatedEvent(session=session_info.id, reason=reason)) self.log.info('{session.direction} session {session.id} terminated ({reason})'.format(session=session_info, reason=reason)) self._cleanup_session(session_info) def _EH_janus_sip_slowlink(self, event): try: session_info = self.sip_sessions[event.sender] except KeyError: self.log.warning('could not find SIP session with handle ID {event.sender} for slowlink event'.format(event=event)) return if event.uplink: # uplink is from janus' point of view if not session_info.slow_download: self.log.debug('poor download connectivity for session {session.id}'.format(session=session_info)) session_info.slow_download = True else: if not session_info.slow_upload: self.log.debug('poor upload connectivity for session {session.id}'.format(session=session_info)) session_info.slow_upload = True def _EH_janus_sip_media(self, event): pass def _EH_janus_sip_detached(self, event): pass def _EH_janus_sip_event_registering(self, event): try: account_info = self.account_handles_map[event.sender] except KeyError: self.log.warning('could not find account with handle ID {event.sender} for registering event'.format(event=event)) return if account_info.registration_state != 'registering': account_info.registration_state = 'registering' self.send(sylkrtc.AccountRegisteringEvent(account=account_info.id)) def _EH_janus_sip_event_registered(self, event): if event.sender in self.sip_sessions: # skip 'registered' events from outgoing session handles return try: account_info = self.account_handles_map[event.sender] except KeyError: self.log.warning('could not find account with handle ID {event.sender} for registered event'.format(event=event)) return if account_info.registration_state != 'registered': account_info.registration_state = 'registered' self.send(sylkrtc.AccountRegisteredEvent(account=account_info.id)) self.log.info('registered') storage = MessageStorage() storage.add_account(account=account_info.id) def _EH_janus_sip_event_registration_failed(self, event): try: account_info = self.account_handles_map[event.sender] except KeyError: self.log.warning('could not find account with handle ID {event.sender} for registration failed event'.format(event=event)) return if account_info.registration_state != 'failed': account_info.registration_state = 'failed' reason = '{result.code} {result.reason}'.format(result=event.plugindata.data.result) self.send(sylkrtc.AccountRegistrationFailedEvent(account=account_info.id, reason=reason)) self.log.info('registration failed: {reason}'.format(reason=reason)) def _EH_janus_sip_event_incomingcall(self, event): try: account_info = self.account_handles_map[event.sender] except KeyError: self.log.warning('could not find account with handle ID {event.sender} for incoming call event'.format(event=event)) return assert event.jsep is not None data = event.plugindata.data.result # type: janus.SIPResultIncomingCall call_id = event.plugindata.data.call_id originator = sylkrtc.SIPIdentity(uri=data.username, display_name=data.displayname) session = SIPSessionInfo(self._callid_to_uuid(call_id)) session.janus_handle = account_info.janus_handle session.init_incoming(account_info, originator.uri, originator.display_name) self.sip_sessions.add(session) self.send(sylkrtc.AccountIncomingSessionEvent(account=account_info.id, session=session.id, originator=originator, sdp=event.jsep.sdp, call_id=call_id)) self.log.info('incoming session {session.id} from {session.remote_identity.uri!s}'.format(session=session)) def _EH_janus_sip_event_missed_call(self, event): try: account_info = self.account_handles_map[event.sender] except KeyError: self.log.warning('could not find account with handle ID {event.sender} for missed call event'.format(event=event)) return data = event.plugindata.data.result # type: janus.SIPResultMissedCall originator = sylkrtc.SIPIdentity(uri=data.caller, display_name=data.displayname) self.send(sylkrtc.AccountMissedSessionEvent(account=account_info.id, originator=originator)) self.log.info('missed incoming call from {originator.uri}'.format(originator=originator)) def _EH_janus_sip_event_calling(self, event): try: session_info = self.sip_sessions[event.sender] except KeyError: self.log.warning('could not find SIP session with handle ID {event.sender} for calling event'.format(event=event)) return session_info.state = 'progress' self.send(sylkrtc.SessionProgressEvent(session=session_info.id)) self.log.debug('{session.direction} session {session.id} state: {session.state}'.format(session=session_info)) def _EH_janus_sip_event_accepted(self, event): try: session_info = self.sip_sessions[event.sender] except KeyError: self.log.warning('could not find SIP session with handle ID {event.sender} for accepted event'.format(event=event)) return if session_info.state == 'established': # We had early media session_info.state = 'accepted' self.send(sylkrtc.SessionAcceptedEvent(session=session_info.id)) self.log.debug('{session.direction} session {session.id} state: {session.state}'.format(session=session_info)) return session_info.state = 'accepted' if session_info.direction == 'outgoing': assert event.jsep is not None self.send(sylkrtc.SessionAcceptedEvent(session=session_info.id, sdp=event.jsep.sdp, call_id=event.plugindata.data.call_id)) else: self.send(sylkrtc.SessionAcceptedEvent(session=session_info.id)) self.log.debug('{session.direction} session {session.id} state: {session.state}'.format(session=session_info)) def _EH_janus_sip_event_hangup(self, event): try: session_info = self.sip_sessions[event.sender] except KeyError: self.log.warning('could not find SIP session with handle ID {event.sender} for hangup event'.format(event=event)) return if session_info.state != 'terminated': session_info.state = 'terminated' data = event.plugindata.data.result # type: janus.SIPResultHangup reason = '{0.code} {0.reason}'.format(data) self.send(sylkrtc.SessionTerminatedEvent(session=session_info.id, reason=reason)) if session_info.direction == 'incoming' and data.code == 487: # incoming call was cancelled -> missed self.send(sylkrtc.AccountMissedSessionEvent(account=session_info.account.id, originator=session_info.remote_identity.__dict__)) if data.code >= 300: self.log.info('{session.direction} session {session.id} terminated ({reason})'.format(session=session_info, reason=reason)) else: self.log.info('{session.direction} session {session.id} terminated'.format(session=session_info)) self._cleanup_session(session_info) def _EH_janus_sip_event_declining(self, event): pass def _EH_janus_sip_event_hangingup(self, event): pass def _EH_janus_sip_event_proceeding(self, event): pass def _EH_janus_sip_event_progress(self, event): if (event.jsep): try: session_info = self.sip_sessions[event.sender] except KeyError: self.log.warning('could not find SIP session with handle ID {event.sender} for progress event'.format(event=event)) return session_info.state = 'early_media' self.log.info('{session.direction} session {session.id} has early media'.format(session=session_info)) self.send(sylkrtc.SessionEarlyMediaEvent(session=session_info.id, sdp=event.jsep.sdp, call_id=event.plugindata.data.call_id)) self.log.debug('{session.direction} session {session.id} state: {session.state}'.format(session=session_info)) def _EH_janus_sip_event_ringing(self, event): pass def _EH_janus_sip_event_message(self, event): pass def _EH_janus_videoroom(self, event): if isinstance(event, janus.PluginEvent): event_id = event.plugindata.data.__id__ try: handler = getattr(self, '_EH_janus_' + '_'.join(event_id)) except AttributeError: self.log.warning('unhandled Janus videoroom event: {event_name}'.format(event_name=event_id[-1])) else: self.log.debug('janus videoroom event: {event_name} (handle_id={event.sender})'.format(event=event, event_name=event_id[-1])) handler(event) else: # janus.CoreEvent try: handler = getattr(self, '_EH_janus_videoroom_' + event.janus) except AttributeError: self.log.warning('unhandled Janus videoroom event: {event.janus}'.format(event=event)) else: self.log.debug('janus videoroom event: {event.janus} (handle_id={event.sender})'.format(event=event)) handler(event) def _EH_janus_videoroom_error(self, event): # fixme: implement error handling self.log.error('got videoroom error event: {}'.format(event.__data__)) try: videoroom_session = self.videoroom_sessions[event.sender] except KeyError: self.log.warning('could not find room session with handle ID {event.sender} for error event'.format(event=event)) return if videoroom_session.type == 'publisher': pass else: pass def _EH_janus_videoroom_webrtcup(self, event): try: videoroom_session = self.videoroom_sessions[event.sender] except KeyError: self.log.warning('could not find room session with handle ID {event.sender} for webrtcup event'.format(event=event)) return if videoroom_session.type == 'publisher': self.log.debug('media published to room {session.room.uri}'.format(session=videoroom_session)) self.send(sylkrtc.VideoroomSessionEstablishedEvent(session=videoroom_session.id)) else: self.send(sylkrtc.VideoroomFeedEstablishedEvent(session=videoroom_session.parent_session.id, feed=videoroom_session.id)) def _EH_janus_videoroom_hangup(self, event): try: videoroom_session = self.videoroom_sessions[event.sender] except KeyError: return reactor.callLater(2, call_in_green_thread, self._cleanup_videoroom_session, videoroom_session) self.log.debug('session with room {session.room.uri} ended'.format(session=videoroom_session)) def _EH_janus_videoroom_slowlink(self, event): try: videoroom_session = self.videoroom_sessions[event.sender] except KeyError: self.log.warning('could not find room session with handle ID {event.sender} for slowlink event'.format(event=event)) return if event.uplink: # uplink is from janus' point of view if not videoroom_session.slow_download: self.log.debug('poor download connectivity to room {session.room.uri} with session {session.id}'.format(session=videoroom_session)) videoroom_session.slow_download = True else: if not videoroom_session.slow_upload: self.log.debug('poor upload connectivity to room {session.room.uri} with session {session.id}'.format(session=videoroom_session)) videoroom_session.slow_upload = True def _EH_janus_videoroom_media(self, event): pass def _EH_janus_videoroom_detached(self, event): pass def _EH_janus_videoroom_joined(self, event): # send when a publisher successfully joined a room try: videoroom_session = self.videoroom_sessions[event.sender] except KeyError: self.log.warning('could not find room session with handle ID {event.sender} for joined event'.format(event=event)) return if ('m=video' in event.jsep.sdp and 'm=audio' in event.jsep.sdp): media = 'audio/video' elif ('m=video' in event.jsep.sdp): media = 'video only' elif ('m=audio' in event.jsep.sdp): media = 'audio only' else: media = 'unknown' self.log.info('joined room {session.room.uri} with {media}'.format(session=videoroom_session, media=media)) self.log.debug('joined room {session.room.uri} with session {session.id}'.format(session=videoroom_session)) data = event.plugindata.data # type: janus.VideoroomJoined videoroom_session.publisher_id = data.id room = videoroom_session.room assert event.jsep is not None self.send(sylkrtc.VideoroomSessionAcceptedEvent(session=videoroom_session.id, sdp=event.jsep.sdp, audio=room.audio, video=room.video)) # send information about existing publishers publishers = [] for publisher in data.publishers: # type: janus.VideoroomPublisher try: publisher_session = room[publisher.id] except KeyError: self.log.warning('could not find matching session for publisher {publisher.id} during joined event'.format(publisher=publisher)) else: publishers.append(dict(id=publisher_session.id, uri=publisher_session.account.id, display_name=publisher.display or '')) self.send(sylkrtc.VideoroomInitialPublishersEvent(session=videoroom_session.id, publishers=publishers)) room.add(videoroom_session) # adding the session to the room might also trigger sending an event with the active participants which must be sent last def _EH_janus_videoroom_attached(self, event): try: videoroom_session = self.videoroom_sessions[event.sender] except KeyError: self.log.warning('could not find room session with handle ID {event.sender} for attached event'.format(event=event)) return # get the session which originated the subscription base_session = videoroom_session.parent_session assert base_session is not None assert event.jsep is not None and event.jsep.type == 'offer' if ('m=video' in event.jsep.sdp and 'm=audio' in event.jsep.sdp): media = 'audio/video' elif ('m=video' in event.jsep.sdp): media = 'video only' elif ('m=audio' in event.jsep.sdp): media = 'audio only' else: media = 'unknown' self.log.debug('{media} media proposed to room {session.room.uri}'.format(session=videoroom_session, media=media)) self.send(sylkrtc.VideoroomFeedAttachedEvent(session=base_session.id, feed=videoroom_session.id, sdp=event.jsep.sdp)) def _EH_janus_videoroom_slow_link(self, event): pass def _EH_janus_videoroom_event_publishers(self, event): try: videoroom_session = self.videoroom_sessions[event.sender] except KeyError: self.log.warning('could not find room session with handle ID {event.sender} for publishers event'.format(event=event)) return room = videoroom_session.room # send information about new publishers publishers = [] for publisher in event.plugindata.data.publishers: # type: janus.VideoroomPublisher try: publisher_session = room[publisher.id] except KeyError: self.log.warning('could not find matching session for publisher {publisher.id} during publishers event'.format(publisher=publisher)) continue publishers.append(dict(id=publisher_session.id, uri=publisher_session.account.id, display_name=publisher.display or '')) self.send(sylkrtc.VideoroomPublishersJoinedEvent(session=videoroom_session.id, publishers=publishers)) def _EH_janus_videoroom_event_leaving(self, event): # this is a publisher publisher_id = event.plugindata.data.leaving # publisher_id == 'ok' when the event is about ourselves leaving the room, else the publisher's janus ID try: base_session = self.videoroom_sessions[event.sender] except KeyError: if publisher_id != 'ok': self.log.warning('could not find room session with handle ID {event.sender} for leaving event'.format(event=event)) return if publisher_id == 'ok': self.log.info('left room {session.room.uri}'.format(session=base_session)) self.log.debug('left room {session.room.uri} with session {session.id}'.format(session=base_session)) self._cleanup_videoroom_session(base_session) return try: publisher_session = base_session.feeds.pop(publisher_id) except KeyError: return self.send(sylkrtc.VideoroomPublishersLeftEvent(session=base_session.id, publishers=[publisher_session.id])) def _EH_janus_videoroom_event_left(self, event): # this is a subscriber try: videoroom_session = self.videoroom_sessions[event.sender] except KeyError: pass else: self._cleanup_videoroom_session(videoroom_session) def _EH_janus_videoroom_event_configured(self, event): pass def _EH_janus_videoroom_event_started(self, event): pass def _EH_janus_videoroom_event_unpublished(self, event): pass # Notification handlers def _NH_ChatSessionGotMessage(self, notification): session = notification.sender.sylk_session # type: VideoroomSessionInfo message = notification.data.message sender = sylkrtc.SIPIdentity(uri=str(message.sender.uri), display_name=message.sender.display_name) content = message.content if isinstance(message.content, str) else message.content.decode('latin1') # preserve binary data for transmitting over JSON if any(header.name == 'Message-Type' and header.value == 'status' and header.namespace == 'urn:ag-projects:xml:ns:cpim' for header in message.additional_headers): message_type = 'status' else: message_type = 'normal' self.send(sylkrtc.VideoroomMessageEvent(session=session.id, content=content, content_type=message.content_type, sender=sender, timestamp=str(message.timestamp), type=message_type)) def _NH_ChatSessionGotComposingIndication(self, notification): session = notification.sender.sylk_session # type: VideoroomSessionInfo composing = notification.data sender = sylkrtc.SIPIdentity(uri=str(composing.sender.uri), display_name=composing.sender.display_name) self.send(sylkrtc.VideoroomComposingIndicationEvent(session=session.id, state=composing.state, refresh=composing.refresh, content_type=composing.content_type, sender=sender)) def _NH_ChatSessionDidDeliverMessage(self, notification): session = notification.sender.sylk_session # type: VideoroomSessionInfo data = notification.data self.send(sylkrtc.VideoroomMessageDeliveryEvent(session=session.id, delivered=True, message_id=data.message_id, code=data.code, reason=data.reason)) def _NH_ChatSessionDidNotDeliverMessage(self, notification): session = notification.sender.sylk_session # type: VideoroomSessionInfo data = notification.data self.send(sylkrtc.VideoroomMessageDeliveryEvent(session=session.id, delivered=False, message_id=data.message_id, code=data.code, reason=data.reason)) def _NH_SIPApplicationGotAccountDispositionNotification(self, notification): try: self.accounts_map[notification.sender] except KeyError: return message = notification.data.message self.log.info('received IMDN message ({status}) from: {originator.uri}'.format(status=message.state, originator=notification.data.sender)) self.send(message) def _NH_SIPApplicationGotAccountMessage(self, notification): try: self.accounts_map[notification.sender] except KeyError: return message = notification.data self.log.info('received message ({content_type}) from: {originator.uri}'.format(content_type=message.content_type, originator=message.sender)) self.send(message) def _NH_SIPMessageDidSucceed(self, notification): self.log.info('message was accepted by remote party') data = notification.data body = CPIMPayload.decode(notification.sender.body) message_id = next((header.value for header in body.additional_headers if header.name == 'Message-ID'), None) account_info = self.accounts_map['{}@{}'.format(body.sender.uri.user.decode('utf-8'), body.sender.uri.host.decode('utf-8'))] timestamp = body.timestamp if body.content_type != IMDNDocument.content_type: storage = MessageStorage() storage.update(account=account_info.id, state='accepted', message_id=message_id) event = sylkrtc.AccountDispositionNotificationEvent(account=account_info.id, state='accepted', message_id=message_id, message_timestamp=str(timestamp), code=data.code, reason=data.reason, timestamp=str(ISOTimestamp.now())) self.send(event) self._fork_event_to_online_accounts(account_info, event) def _NH_SIPMessageDidFail(self, notification): notification_center = NotificationCenter() notification_center.remove_observer(self, sender=notification.sender) data = notification.data body = CPIMPayload.decode(notification.sender.body) reason = data.reason.decode() if isinstance(data.reason, bytes) else data.reason callid = data.headers.get('Call-ID', Null).body if hasattr(data, 'headers') else None self.log.warning('could not deliver message to %s: %d %s (%s)' % (', '.join(([str(item.uri) for item in body.recipients])), data.code, reason, callid)) message_id = next((header.value for header in body.additional_headers if header.name == 'Message-ID'), None) account_info = self.accounts_map['{}@{}'.format(body.sender.uri.user.decode('utf-8'), body.sender.uri.host.decode('utf-8'))] timestamp = body.timestamp if body.content_type != IMDNDocument.content_type: storage = MessageStorage() storage.update(account=account_info.id, state='failed', message_id=message_id) event = sylkrtc.AccountDispositionNotificationEvent(account=account_info.id, state='failed', message_id=message_id, code=data.code, reason=reason, message_timestamp=str(timestamp), timestamp=str(ISOTimestamp.now())) self.send(event) self._fork_event_to_online_accounts(account_info, event) # noinspection PyPep8Naming @implementer(IObserver) class VideoroomChatHandler(object): def __init__(self, session): self.sylk_session = session # type: VideoroomSessionInfo self.sip_session = None # type: Optional[Session] self.chat_stream = None self._started = False self._ended = False self._message_queue = deque() @property def account(self): return self.sylk_session.account @property def room(self): return self.sylk_session.room @run_in_green_thread def start(self): if self._started: return self._started = True notification_center = NotificationCenter() from_uri = SIPURI.parse(self.account.uri) to_uri = SIPURI.parse('sip:{}'.format(self.room.uri)) to_uri.host = to_uri.host.replace(b'videoconference', b'conference', 1) # TODO: find a way to define this credentials = Credentials(username=from_uri.user, password=self.account.password.encode('utf-8'), digest=True) sip_account = DefaultAccount() sip_settings = SIPSimpleSettings() if sip_account.sip.outbound_proxy is not None: uri = SIPURI(host=sip_account.sip.outbound_proxy.host, port=sip_account.sip.outbound_proxy.port, parameters={'transport': sip_account.sip.outbound_proxy.transport}) else: uri = to_uri lookup = DNSLookup() try: route = lookup.lookup_sip_proxy(uri, sip_settings.sip.transport_list).wait()[0] except (DNSLookupError, IndexError): self.end() self.room.log.error('DNS lookup for SIP proxy for {} failed'.format(uri)) self.room.log.error('chat session for {} failed: DNS lookup error'.format(self.account.id)) notification_center.post_notification('ChatSessionDidFail', sender=self, data=NotificationData(originator='local', code=0, reason=None, failure_reason='DNS lookup error')) return if self._ended: # end was called during DNS lookup self.room.log.debug('chat session for {} ended'.format(self.account.id)) notification_center.post_notification('ChatSessionDidEnd', sender=self) return self.sip_session = Session(sip_account) self.chat_stream = MediaStreamRegistry.ChatStream() notification_center.add_observer(self, sender=self.sip_session) notification_center.add_observer(self, sender=self.chat_stream) self.room.log.debug('chat {} starting at {}'.format(to_uri, route)) self.sip_session.connect(FromHeader(from_uri, self.account.display_name), ToHeader(to_uri), route=route, streams=[self.chat_stream], credentials=credentials) @run_in_twisted_thread def end(self): if self._ended: return notification_center = NotificationCenter() if self.sip_session is not None: notification_center.remove_observer(self, sender=self.sip_session) notification_center.remove_observer(self, sender=self.chat_stream) self.sip_session.end() self.sip_session = None self.chat_stream = None self.room.log.debug('chat session for {} ended'.format(self.account.id)) notification_center.post_notification('ChatSessionDidEnd', sender=self) while self._message_queue: message_id, content, content_type = self._message_queue.popleft() data = NotificationData(message_id=message_id, message=None, code=0, reason='Chat session ended') notification_center.post_notification('ChatSessionDidNotDeliverMessage', sender=self, data=data) self._ended = True @run_in_twisted_thread def send_message(self, message_id, content, content_type='text/plain'): if self._ended: notification_center = NotificationCenter() data = NotificationData(message_id=message_id, message=None, code=0, reason='Chat session ended') notification_center.post_notification('ChatSessionDidNotDeliverMessage', sender=self, data=data) else: self._message_queue.append((message_id, content, content_type)) if self.chat_stream is not None: self._send_queued_messages() @run_in_twisted_thread def send_composing_indication(self, state, refresh=None): if self.chat_stream is not None: self.chat_stream.send_composing_indication(state, refresh=refresh) def _send_queued_messages(self): while self._message_queue: message_id, content, content_type = self._message_queue.popleft() self.chat_stream.send_message(content, content_type, message_id=message_id) def handle_notification(self, notification): handler = getattr(self, '_NH_%s' % notification.name, Null) handler(notification) def _NH_SIPSessionDidStart(self, notification): self.room.log.debug('chat session for {} started'.format(self.account.id)) notification.center.post_notification('ChatSessionDidStart', sender=self) self._send_queued_messages() def _NH_SIPSessionDidEnd(self, notification): notification.center.remove_observer(self, sender=self.sip_session) notification.center.remove_observer(self, sender=self.chat_stream) self.sip_session = None self.chat_stream = None self.end() self.room.log.debug('chat session for {} ended'.format(self.account.id)) notification.center.post_notification('ChatSessionDidEnd', sender=self, data=notification.data) def _NH_SIPSessionDidFail(self, notification): notification.center.remove_observer(self, sender=self.sip_session) notification.center.remove_observer(self, sender=self.chat_stream) self.sip_session = None self.chat_stream = None self.end() self.room.log.error('chat session for {} failed: {}'.format(self.account.id, notification.data.failure_reason)) notification.center.post_notification('ChatSessionDidFail', sender=self, data=notification.data) # noinspection PyUnusedLocal def _NH_SIPSessionNewProposal(self, notification): self.sip_session.reject_proposal() def _NH_SIPSessionTransferNewIncoming(self, notification): # sylkserver's SIP Session class doesn't implement the transfer API # self.sip_session.reject_transfer(403) pass def _NH_ChatStreamGotMessage(self, notification): self.chat_stream.msrp_session.send_report(notification.data.chunk, 200, 'OK') notification.center.post_notification('ChatSessionGotMessage', sender=self, data=notification.data) def _NH_ChatStreamGotComposingIndication(self, notification): notification.center.post_notification('ChatSessionGotComposingIndication', sender=self, data=notification.data) def _NH_ChatStreamDidSendMessage(self, notification): notification.center.post_notification('ChatSessionDidSendMessage', sender=self, data=notification.data) def _NH_ChatStreamDidDeliverMessage(self, notification): notification.center.post_notification('ChatSessionDidDeliverMessage', sender=self, data=notification.data) def _NH_ChatStreamDidNotDeliverMessage(self, notification): notification.center.post_notification('ChatSessionDidNotDeliverMessage', sender=self, data=notification.data) diff --git a/webrtcgateway.ini.sample b/webrtcgateway.ini.sample index 86dedc1..0be208b 100644 --- a/webrtcgateway.ini.sample +++ b/webrtcgateway.ini.sample @@ -1,89 +1,90 @@ ; SylkServer WebRTC gateway configuration file ; ; For the gateway to work Janus needs to be properly installed and configured, ; please refer to README.webrtc for detailed instructions ; [General] ; List of allowed web origins. The connection origin (Origin header in the ; HTTP request) will be checked against the list defined here, if the domain ; is no allowed the connection will be refused. ; * (the default) means any ; web_origins = * ; Proxy used for outbound SIP traffic ; outbound_sip_proxy = ; List of allowed SIP domains for managing accounts ; sip_domains = * ; Boolean indicating if the WebSocket messages sent to/from clients should be ; logged to a file ; trace_client = False ; WebSocket Ping frames are sent at the configured interval, this helps detect ; dead client connections ; websocket_ping_interval = 120 ; IP and port for the HTTP management interface as IP[:PORT] ; http_management_interface = 127.0.0.1:20888 ; Shared secret for the HTTP management interface (Authorization: THE_KEY) ; http_management_auth_secret = ; Sylk-push URL to send conference push notification ; sylk_push_url = ; Send sip messages only to ourself, skipping any outbound destination. ; This setting should be enabled if you have no SIP proxy, no outbound proxy ; configured and a different authentication method. You should also add the ; listening IP to the trusted list in the main configuration ; local_sip_messages = [Janus] ; URL pointing to the Janus API endpoint (only WebSocket is supported) ; api_url = ws://127.0.0.1:8188 ; API secret shared with Janus (must match the value in janus.cfg) ; A random UUID value is recommended, a new value can be generated with ; the following command: ; python -c 'import uuid; print(uuid.uuid4().hex)' api_secret = 0745f2f74f34451c89343afcdcae5809 ; Boolean indicating if the messages between SylkServer and Janus should be ; logged to a file ; trace_janus = False ; Maximum video bitrate allowed per sender in a room in bits/s. This value is ; applied to any room that doesn't define its own. The value is any integer ; number between 64000 and 4194304. Default value is 2016000 (~2Mb/s). ; max_bitrate = 2016000 ; The video codec to be used by all participants in a room. This value is ; applied to any room that doesn't define its own. ; Possible values are: h264, vp8 and vp9. Default is vp9. ; video_codec = vp9 ; code used to decline the calls (usually, 486 busy, 603 busy everywhere). ; For 4XX codes, tipically a SIP Proxy will wait until other devices answer, ; for 6XX codes, tipically a SIP Proxy will end the call forking ; decline_code = 486 [Cassandra] ; Contact points to cassandra cluster ; cluster_contact_points = ; Keyspace to use for storage ; keyspace = ; Table name for token storage ; push_tokens_table = push_tokens ; Per room configuration options ; [room1@videoconference.example.com] ; record = True ; access_policy = deny, allow ; deny = all ; allow = domain1.com, test1@example.com, test2@example.com ; max_bitrate = 512000 ; video_codec = h264 +; video_disabled = False