diff --git a/sip-audio-session b/sip-audio-session index eca3cdb..847b1e6 100755 --- a/sip-audio-session +++ b/sip-audio-session @@ -1,1200 +1,1204 @@ #!/usr/bin/env python3 import atexit import os import platform import select import shutil import signal import sys import termios import uuid from datetime import datetime from itertools import chain from optparse import OptionParser from threading import Thread from time import sleep from lxml import html from application import log from application.notification import NotificationCenter, NotificationData from application.process import process from application.python.queue import EventQueue from application.system import makedirs from twisted.internet import reactor from sipsimple.account import Account, AccountManager, BonjourAccount from sipsimple.audio import WavePlayer from sipsimple.application import SIPApplication from sipsimple.configuration import ConfigurationError from sipsimple.configuration.settings import SIPSimpleSettings from sipsimple.core import Engine, SIPCoreError, SIPURI, ToHeader from sipsimple.lookup import DNSLookup from sipsimple.session import Session from sipsimple.streams import MediaStreamRegistry from sipsimple.storage import FileStorage from sipclient.configuration import config_directory from sipclient.configuration.account import AccountExtension from sipclient.configuration.datatypes import ResourcePath from sipclient.configuration.settings import SIPSimpleSettingsExtension from sipclient.log import Logger from sipclient.system import IPAddressMonitor class BonjourNeighbour(object): def __init__(self, neighbour, uri, display_name, host): self.display_name = display_name self.host = host self.neighbour = neighbour self.uri = uri class InputThread(Thread): def __init__(self): Thread.__init__(self) self.setDaemon(True) self._old_terminal_settings = None def start(self): atexit.register(self._termios_restore) Thread.start(self) def run(self): notification_center = NotificationCenter() while True: chars = list(self._getchars()) while chars: char = chars.pop(0) if char == '\x1b': # escape if len(chars) >= 2 and chars[0] == '[' and chars[1] in ('A', 'B', 'C', 'D'): # one of the arrow keys char = char + chars.pop(0) + chars.pop(0) notification_center.post_notification('SIPApplicationGotInput', sender=self, data=NotificationData(input=char)) def stop(self): self._termios_restore() def _termios_restore(self): if self._old_terminal_settings is not None: termios.tcsetattr(sys.stdin.fileno(), termios.TCSADRAIN, self._old_terminal_settings) def _getchars(self): fd = sys.stdin.fileno() if os.isatty(fd): self._old_terminal_settings = termios.tcgetattr(fd) new = termios.tcgetattr(fd) new[3] = new[3] & ~termios.ICANON & ~termios.ECHO new[6][termios.VMIN] = b'\000' try: termios.tcsetattr(fd, termios.TCSADRAIN, new) if select.select([fd], [], [], None)[0]: return sys.stdin.read(4192) finally: self._termios_restore() else: return os.read(fd, 4192) class RTPStatisticsThread(Thread): def __init__(self, application): Thread.__init__(self) self.setDaemon(True) self.application = application self.stopped = False def run(self): while not self.stopped: if self.application.active_session is not None and self.application.active_session.streams: audio_stream = self.application.active_session.streams[0] stats = audio_stream.statistics if stats is not None: self.application.output.put('%s RTP audio statistics: RTT=%d ms, packet loss=%.1f%%, jitter RX/TX=%d/%d ms\n' % (datetime.now().replace(microsecond=0), stats['rtt']['avg'] / 1000, 100.0 * stats['rx']['packets_lost'] / stats['rx']['packets'] if stats['rx']['packets'] else 0, stats['rx']['jitter']['avg'] / 1000, stats['tx']['jitter']['avg'] / 1000)) try: video_stream = self.application.active_session.streams[1] except IndexError: pass else: stats = video_stream.statistics if stats is not None: self.application.output.put('%s RTP video statistics: RTT=%d ms, packet loss=%.1f%%, jitter RX/TX=%d/%d ms\n' % (datetime.now().replace(microsecond=0), stats['rtt']['avg'] / 1000, 100.0 * stats['rx']['packets_lost'] / stats['rx']['packets'] if stats['rx']['packets'] else 0, stats['rx']['jitter']['avg'] / 1000, stats['tx']['jitter']['avg'] / 1000)) sleep(10) def stop(self): self.stopped = True class CancelThread(Thread): def __init__(self, application): Thread.__init__(self) self.setDaemon(True) self.application = application self.stopped = False def run(self): while not self.stopped: self.application.end_session_if_needed() sleep(1) def stop(self): self.stopped = True class SIPAudioApplication(SIPApplication): def __init__(self): self.account = None self.options = None self.target = None self.active_session = None self.answer_timers = {} self.hangup_timers = {} self.started_sessions = [] self.incoming_sessions = [] self.outgoing_session = None self.neighbours = {} self.registration_succeeded = False self.success = False self.input = None self.output = None self.ip_address_monitor = IPAddressMonitor() self.logger = None self.rtp_statistics = None self.alert_tone_generator = None self.voice_tone_generator = None self.wave_inbound_ringtone = None self.wave_outbound_ringtone = None self.tone_ringtone = None self.hold_tone = None self.ignore_local_hold = False self.ignore_local_unhold = False self.batch_mode = False self.stop_call_thread = None self.session_spool_dir = None def _write(self, message): sys.stdout.write(message) sys.stdout.flush() def start(self, target, options): notification_center = NotificationCenter() if options.daemonize: process.daemonize() self.options = options self.target = target self.batch_mode = options.batch_mode self.enable_video = options.enable_video self.input = InputThread() if not self.batch_mode else None self.output = EventQueue(self._write) self.logger = Logger(sip_to_stdout=options.trace_sip, pjsip_to_stdout=options.trace_pjsip, notifications_to_stdout=options.trace_notifications) notification_center.add_observer(self, sender=self) notification_center.add_observer(self, sender=self.input) notification_center.add_observer(self, name='SIPSessionNewIncoming') notification_center.add_observer(self, name='RTPStreamDidChangeRTPParameters') notification_center.add_observer(self, name='RTPStreamICENegotiationDidSucceed') notification_center.add_observer(self, name='RTPStreamICENegotiationDidFail') if self.input: self.input.start() self.output.start() log.level.current = log.level.WARNING # get rid of twisted messages Account.register_extension(AccountExtension) BonjourAccount.register_extension(AccountExtension) SIPSimpleSettings.register_extension(SIPSimpleSettingsExtension) self.config_directory = options.config_directory or config_directory try: self.output.put("Using config directory: %s\n" % self.config_directory) SIPApplication.start(self, FileStorage(self.config_directory)) except ConfigurationError as e: self.output.put("Failed to load sipclient's configuration: %s\n" % str(e)) self.output.put("If an old configuration file is in place, delete it or move it and recreate the configuration using the sip_settings script.\n") self.output.stop() if options.spool_dir: self.spool_dir = options.spool_dir else: self.spool_dir = "%s/spool/sesssions" % self.config_directory try: makedirs(self.spool_dir) except Exception as e: log.error('Failed to create spool directory at {directory}: {exception!s}'.format(directory=self.spool_dir, exception=e)) else: self.output.put("Using spool directory %s\n" % self.spool_dir) def print_help(self): message = 'Available control keys:\n' message += ' s: toggle SIP trace on the console\n' message += ' j: toggle PJSIP trace on the console\n' message += ' n: toggle notifications trace on the console\n' message += ' p: toggle printing RTP statistics on the console\n' message += ' h: hang-up the active session\n' message += ' r: toggle audio recording\n' message += ' m: mute the microphone\n' message += ' i: change audio input device\n' message += ' o: change audio output device\n' message += ' a: change audio alert device\n' message += ' SPACE: hold/unhold\n' message += ' Ctrl-d: quit the program\n' message += ' ?: display this help message\n' self.output.put('\n'+message+'\n') def _NH_SIPApplicationWillStart(self, notification): account_manager = AccountManager() notification_center = NotificationCenter() settings = SIPSimpleSettings() if 'armv7' in platform.platform() and settings.audio.echo_canceller.enabled: self.output.put("Disable echo canceller on ARM architecture\n") settings.audio.echo_canceller.enabled = False settings.save() for account in account_manager.iter_accounts(): if isinstance(account, Account): account.sip.register = False account.presence.enabled = False account.xcap.enabled = False account.message_summary.enabled = False if self.options.account is None: self.account = account_manager.default_account else: possible_accounts = [account for account in account_manager.iter_accounts() if self.options.account in account.id and account.enabled] if len(possible_accounts) > 1: self.output.put('More than one account exists which matches %s: %s\n' % (self.options.account, ', '.join(sorted(account.id for account in possible_accounts)))) self.output.stop() self.stop() self.end_cancel_thread() return elif len(possible_accounts) == 0: self.output.put('No enabled account that matches %s was found. Available and enabled accounts: %s\n' % (self.options.account, ', '.join(sorted(account.id for account in account_manager.get_accounts() if account.enabled)))) self.output.stop() self.stop() self.end_cancel_thread() return else: self.account = possible_accounts[0] notification_center.add_observer(self, sender=self.account) if isinstance(self.account, Account) and self.target is None: self.account.sip.register = True self.account.presence.enabled = False self.account.xcap.enabled = False self.account.message_summary.enabled = False self.output.put('Using account %s\n' % self.account.id) self.logger.start() if settings.logs.trace_sip and self.logger._siptrace_filename is not None: self.output.put('Logging SIP trace to file "%s"\n' % self.logger._siptrace_filename) if settings.logs.trace_pjsip and self.logger._pjsiptrace_filename is not None: self.output.put('Logging PJSIP trace to file "%s"\n' % self.logger._pjsiptrace_filename) if settings.logs.trace_notifications and self.logger._notifications_filename is not None: self.output.put('Logging notifications trace to file "%s"\n' % self.logger._notifications_filename) if self.options.disable_sound: settings.audio.input_device = None settings.audio.output_device = None settings.audio.alert_device = None if self.options.enable_default_devices: settings.audio.input_device = 'system_default' settings.audio.output_device = 'system_default' settings.audio.alert_device = 'system_default' def _NH_SIPApplicationDidStart(self, notification): engine = Engine() settings = SIPSimpleSettings() engine.trace_sip = self.logger.sip_to_stdout or settings.logs.trace_sip engine.log_level = settings.logs.pjsip_level if (self.logger.pjsip_to_stdout or settings.logs.trace_pjsip) else 0 self.ip_address_monitor.start() self.output.put('Available audio input devices: %s\n' % ', '.join(['None', 'system_default'] + sorted(engine.input_devices))) self.output.put('Available audio output devices: %s\n' % ', '.join(['None', 'system_default'] + sorted(engine.output_devices))) if engine.video_devices: self.output.put('Available cameras: %s\n' % ', '.join(sorted(engine.video_devices))) else: if self.enable_video: self.output.put('No camera present, video is disabled') self.enable_video = False if self.voice_audio_mixer.input_device == 'system_default': self.output.put('Using audio input device: %s (system default device)\n' % self.voice_audio_mixer.real_input_device) else: self.output.put('Using audio input device: %s\n' % self.voice_audio_mixer.input_device) if self.voice_audio_mixer.output_device == 'system_default': self.output.put('Using audio output device: %s (system default device)\n' % self.voice_audio_mixer.real_output_device) else: self.output.put('Using audio output device: %s\n' % self.voice_audio_mixer.output_device) if self.alert_audio_mixer.output_device == 'system_default': self.output.put('Using audio alert device: %s (system default device)\n' % self.alert_audio_mixer.real_output_device) else: self.output.put('Using audio alert device: %s\n' % self.alert_audio_mixer.output_device) if not self.batch_mode: self.print_help() inbound_ringtone = self.account.sounds.audio_inbound.sound_file if self.account.sounds.audio_inbound is not None else None outbound_ringtone = settings.sounds.audio_outbound if inbound_ringtone: self.wave_inbound_ringtone = WavePlayer(self.alert_audio_mixer, inbound_ringtone.path.normalized, volume=inbound_ringtone.volume, loop_count=0, pause_time=2) self.alert_audio_bridge.add(self.wave_inbound_ringtone) if outbound_ringtone: self.wave_outbound_ringtone = WavePlayer(self.voice_audio_mixer, outbound_ringtone.path.normalized, volume=outbound_ringtone.volume, loop_count=0, pause_time=2) self.voice_audio_bridge.add(self.wave_outbound_ringtone) self.tone_ringtone = WavePlayer(self.voice_audio_mixer, ResourcePath('sounds/ring_tone.wav').normalized, loop_count=0, pause_time=6) self.voice_audio_bridge.add(self.tone_ringtone) self.hold_tone = WavePlayer(self.voice_audio_mixer, ResourcePath('sounds/hold_tone.wav').normalized, loop_count=0, pause_time=30, volume=50) self.voice_audio_bridge.add(self.hold_tone) if self.target is not None: if isinstance(self.account, BonjourAccount) and '@' not in self.target: self.output.put('Bonjour mode requires a host in the destination address\n') self.stop() self.end_cancel_thread() return if '@' not in self.target: self.target = '%s@%s' % (self.target, self.account.id.domain) if not self.target.startswith('sip:') and not self.target.startswith('sips:'): self.target = 'sip:' + self.target try: self.target = SIPURI.parse(self.target) except SIPCoreError: self.output.put('Illegal SIP URI: %s\n' % self.target) self.stop() else: if '.' not in self.target.host.decode() and not isinstance(self.account, BonjourAccount): self.target.host = '%s.%s' % (self.target.host, self.account.id.domain) lookup = DNSLookup() notification_center = NotificationCenter() settings = SIPSimpleSettings() notification_center.add_observer(self, sender=lookup) if isinstance(self.account, Account) and self.account.sip.outbound_proxy is not None: uri = SIPURI(host=self.account.sip.outbound_proxy.host, port=self.account.sip.outbound_proxy.port, parameters={'transport': self.account.sip.outbound_proxy.transport}) elif isinstance(self.account, Account) and self.account.sip.always_use_my_proxy: uri = SIPURI(host=self.account.id.domain) else: uri = self.target self.session_spool_dir = self.spool_dir + "/" + (self.options.external_id or str(uuid.uuid1())) lookup.lookup_sip_proxy(uri, settings.sip.transport_list) try: makedirs(self.session_spool_dir) except Exception as e: log.error('Failed to create session spool directory at {directory}: {exception!s}'.format(directory=self.session_spool_dir, exception=e)) else: if self.stop_call_thread is None: self.stop_call_thread = CancelThread(self) self.stop_call_thread.start() self.output.put("To stop the call: touch %s/stop\n" % self.session_spool_dir) def _NH_SIPApplicationWillEnd(self, notification): if isinstance(self.account, Account): self.account.sip.register = False self.ip_address_monitor.stop() def _NH_SIPApplicationDidEnd(self, notification): if self.input: self.input.stop() self.output.stop() self.output.join() def _NH_SIPEngineDetectedNATType(self, notification): SIPApplication._NH_SIPEngineDetectedNATType(self, notification) if notification.data.succeeded: self.output.put('Detected NAT type: %s\n' % notification.data.nat_type) def _NH_SIPApplicationGotInput(self, notification): engine = Engine() notification_center = NotificationCenter() settings = SIPSimpleSettings() if notification.data.input == '\x04': if self.active_session is not None: self.output.put('Ending audio session...\n') self.active_session.end() elif self.outgoing_session is not None: self.output.put('Cancelling audio session...\n') self.outgoing_session.end() else: self.stop() self.end_cancel_thread() elif notification.data.input == '?': self.print_help() elif notification.data.input in ('y', 'n') and self.incoming_sessions: accepted_types = ['video', 'audio', 'chat'] if self.enable_video else ['audio', 'chat'] session = self.incoming_sessions.pop(0) if notification.data.input == 'y': session.accept([stream for stream in session.proposed_streams if stream.type in accepted_types]) else: session.reject() elif notification.data.input == 'm': self.voice_audio_mixer.muted = not self.voice_audio_mixer.muted self.output.put('The microphone is now %s\n' % ('muted' if self.voice_audio_mixer.muted else 'unmuted')) elif notification.data.input == 'i': input_devices = [None, 'system_default'] + sorted(engine.input_devices) if self.voice_audio_mixer.input_device in input_devices: old_input_device = self.voice_audio_mixer.input_device else: old_input_device = None tail_length = settings.audio.echo_canceller.tail_length if settings.audio.echo_canceller.enabled else 0 new_input_device = input_devices[(input_devices.index(old_input_device)+1) % len(input_devices)] try: self.voice_audio_mixer.set_sound_devices(new_input_device, self.voice_audio_mixer.output_device, tail_length) except SIPCoreError as e: self.output.put('Failed to set input device to %s: %s\n' % (new_input_device, str(e))) else: if new_input_device == 'system_default': self.output.put('Audio input device changed to %s (system default device)\n' % self.voice_audio_mixer.real_input_device) else: self.output.put('Audio input device changed to %s\n' % new_input_device) elif notification.data.input == 'o': output_devices = [None, 'system_default'] + sorted(engine.output_devices) if self.voice_audio_mixer.output_device in output_devices: old_output_device = self.voice_audio_mixer.output_device else: old_output_device = None tail_length = settings.audio.echo_canceller.tail_length if settings.audio.echo_canceller.enabled else 0 new_output_device = output_devices[(output_devices.index(old_output_device)+1) % len(output_devices)] try: self.voice_audio_mixer.set_sound_devices(self.voice_audio_mixer.input_device, new_output_device, tail_length) except SIPCoreError as e: self.output.put('Failed to set output device to %s: %s\n' % (new_output_device, str(e))) else: if new_output_device == 'system_default': self.output.put('Audio output device changed to %s (system default device)\n' % self.voice_audio_mixer.real_output_device) else: self.output.put('Audio output device changed to %s\n' % new_output_device) elif notification.data.input == 'a': output_devices = [None, 'system_default'] + sorted(engine.output_devices) if self.alert_audio_mixer.output_device in output_devices: old_output_device = self.alert_audio_mixer.output_device else: old_output_device = None tail_length = settings.audio.echo_canceller.tail_length if settings.audio.echo_canceller.enabled else 0 new_output_device = output_devices[(output_devices.index(old_output_device)+1) % len(output_devices)] try: self.alert_audio_mixer.set_sound_devices(self.alert_audio_mixer.input_device, new_output_device, tail_length) except SIPCoreError as e: self.output.put('Failed to set alert device to %s: %s\n' % (new_output_device, str(e))) else: if new_output_device == 'system_default': self.output.put('Audio alert device changed to %s (system default device)\n' % self.alert_audio_mixer.real_output_device) else: self.output.put('Audio alert device changed to %s\n' % new_output_device) elif notification.data.input == 'h': if self.active_session is not None: self.output.put('Ending audio session...\n') self.active_session.end() elif self.outgoing_session is not None: self.output.put('Cancelling audio session...\n') self.outgoing_session.end() elif notification.data.input == ' ': if self.active_session is not None: if self.active_session.on_hold: self.active_session.unhold() else: self.active_session.hold() elif notification.data.input in ('0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '*', '#', 'A', 'B', 'C', 'D'): if self.active_session is not None: try: audio_stream = self.active_session.streams[0] except IndexError: pass else: digit = notification.data.input filename = 'sounds/dtmf_%s_tone.wav' % {'*': 'star', '#': 'pound'}.get(digit, digit) wave_player = WavePlayer(self.voice_audio_mixer, ResourcePath(filename).normalized) notification_center.add_observer(self, sender=wave_player) audio_stream.send_dtmf(digit) if self.active_session.account.rtp.inband_dtmf: audio_stream.bridge.add(wave_player) self.voice_audio_bridge.add(wave_player) wave_player.start() elif notification.data.input in ('\x1b[A', '\x1b[D') and len(self.started_sessions) > 0: # UP and LEFT if self.active_session is None: self.active_session = self.started_sessions[0] self.active_session.unhold() self.ignore_local_unhold = True elif len(self.started_sessions) > 1: self.active_session.hold() self.active_session = self.started_sessions[self.started_sessions.index(self.active_session)-1] self.active_session.unhold() self.ignore_local_unhold = True else: return identity = str(self.active_session.remote_identity.uri) if self.active_session.remote_identity.display_name: identity = '"%s" <%s>' % (self.active_session.remote_identity.display_name, identity) self.output.put('Active audio session: "%s" (%d/%d)\n' % (identity, self.started_sessions.index(self.active_session)+1, len(self.started_sessions))) elif notification.data.input in ('\x1b[B', '\x1b[C') and len(self.started_sessions) > 0: # DOWN and RIGHT if self.active_session is None: self.active_session = self.started_sessions[0] self.active_session.unhold() self.ignore_local_unhold = True elif len(self.started_sessions) > 1: self.active_session.hold() self.active_session = self.started_sessions[(self.started_sessions.index(self.active_session)+1) % len(self.started_sessions)] self.active_session.unhold() self.ignore_local_unhold = True else: return identity = str(self.active_session.remote_identity.uri) if self.active_session.remote_identity.display_name: identity = '"%s" <%s>' % (self.active_session.remote_identity.display_name, identity) self.output.put('Active audio session: "%s" (%d/%d)\n' % (identity, self.started_sessions.index(self.active_session)+1, len(self.started_sessions))) elif notification.data.input == 'r': if self.active_session is None or not self.active_session.streams: return session = self.active_session audio_stream = self.active_session.streams[0] if audio_stream.recorder is not None: audio_stream.stop_recording() else: direction = session.direction remote = "%s@%s" % (session.remote_identity.uri.user, session.remote_identity.uri.host) filename = "%s-%s-%s.wav" % (datetime.now().strftime("%Y%m%d-%H%M%S"), remote, direction) path = os.path.join(settings.audio.directory.normalized, session.account.id) audio_stream.start_recording(os.path.join(path, filename)) elif notification.data.input == 'p': if self.rtp_statistics is None: self.rtp_statistics = RTPStatisticsThread(self) self.rtp_statistics.start() self.output.put('Output of RTP statistics on console is now activated\n') else: self.rtp_statistics.stop() self.rtp_statistics = None self.output.put('Output of RTP statistics on console is now dectivated\n') elif notification.data.input == 'j': self.logger.pjsip_to_stdout = not self.logger.pjsip_to_stdout engine.log_level = settings.logs.pjsip_level if (self.logger.pjsip_to_stdout or settings.logs.trace_pjsip) else 0 self.output.put('PJSIP tracing to console is now %s\n' % ('activated' if self.logger.pjsip_to_stdout else 'deactivated')) elif notification.data.input == 'n': self.logger.notifications_to_stdout = not self.logger.notifications_to_stdout self.output.put('Notification tracing to console is now %s.\n' % ('activated' if self.logger.notifications_to_stdout else 'deactivated')) elif notification.data.input == 's': self.logger.sip_to_stdout = not self.logger.sip_to_stdout engine.trace_sip = self.logger.sip_to_stdout or settings.logs.trace_sip self.output.put('SIP tracing to console is now %s\n' % ('activated' if self.logger.sip_to_stdout else 'deactivated')) def _NH_SIPEngineGotException(self, notification): self.output.put('An exception occured within the SIP core:\n%s\n' % notification.data.traceback) def _NH_SIPAccountRegistrationDidSucceed(self, notification): if self.registration_succeeded: return contact_header = notification.data.contact_header contact_header_list = notification.data.contact_header_list expires = notification.data.expires registrar = notification.data.registrar message = '%s Registered contact "%s" for sip:%s at %s:%d;transport=%s (expires in %d seconds).\n' % (datetime.now().replace(microsecond=0), contact_header.uri, self.account.id, registrar.address, registrar.port, registrar.transport, expires) if len(contact_header_list) > 1: message += 'Other registered contacts:\n%s\n' % '\n'.join([' %s (expires in %s seconds)' % (str(other_contact_header.uri), other_contact_header.expires) for other_contact_header in contact_header_list if other_contact_header.uri != notification.data.contact_header.uri]) self.output.put(message) self.registration_succeeded = True def _NH_SIPAccountRegistrationDidFail(self, notification): self.output.put('%s Failed to register contact for sip:%s: %s (retrying in %.2f seconds)\n' % (datetime.now().replace(microsecond=0), self.account.id, notification.data.error, notification.data.retry_after)) self.registration_succeeded = False def _NH_SIPAccountRegistrationDidEnd(self, notification): self.output.put('%s Registration ended.\n' % datetime.now().replace(microsecond=0)) def _NH_BonjourAccountRegistrationDidSucceed(self, notification): self.output.put('%s Registered Bonjour contact %s\n' % (datetime.now().replace(microsecond=0), notification.data.name)) def _NH_BonjourAccountRegistrationDidFail(self, notification): self.output.put('%s Failed to register Bonjour contact: %s\n' % (datetime.now().replace(microsecond=0), notification.data.reason)) def _NH_BonjourAccountRegistrationDidEnd(self, notification): self.output.put('%s Registration ended.\n' % datetime.now().replace(microsecond=0)) def _NH_BonjourAccountDidAddNeighbour(self, notification): neighbour, record = notification.data.neighbour, notification.data.record now = datetime.now().replace(microsecond=0) self.output.put('%s Discovered Bonjour neighbour: %s (%s) <%s>\n' % (now, record.name, record.host, record.uri)) self.neighbours[neighbour] = BonjourNeighbour(neighbour, record.uri, record.name, record.host) def _NH_BonjourAccountDidUpdateNeighbour(self, notification): neighbour, record = notification.data.neighbour, notification.data.record now = datetime.now().replace(microsecond=0) try: bonjour_neighbour = self.neighbours[neighbour] except KeyError: self.output.put('%s Discovered Bonjour neighbour: "%s (%s)" <%s>\n' % (now, record.name, record.host, record.uri)) self.neighbours[neighbour] = BonjourNeighbour(neighbour, record.uri, record.name, record.host) else: self.output.put('%s Updated Bonjour neighbour: "%s (%s)" <%s>\n' % (now, record.name, record.host, record.uri)) bonjour_neighbour.display_name = record.name bonjour_neighbour.host = record.host bonjour_neighbour.uri = record.uri def _NH_BonjourAccountDidRemoveNeighbour(self, notification): neighbour = notification.data.neighbour now = datetime.now().replace(microsecond=0) try: bonjour_neighbour = self.neighbours.pop(neighbour) except KeyError: pass else: self.output.put('%s Bonjour neighbour left: "%s (%s)" <%s>\n' % (now, bonjour_neighbour.display_name, bonjour_neighbour.host, bonjour_neighbour.uri)) def _NH_DNSLookupDidSucceed(self, notification): notification_center = NotificationCenter() result_text = ', '.join(('%s:%s (%s)' % (result.address, result.port, result.transport.upper()) for result in notification.data.result)) self.output.put("\nDNS lookup for %s succeeded: %s\n" % (self.target.host.decode(), result_text)) if self.end_session_if_needed(): self.stop() self.end_cancel_thread() self.outgoing_session = session = Session(self.account) notification_center.add_observer(self, sender=session) streams = [MediaStreamRegistry.AudioStream(), MediaStreamRegistry.VideoStream()] if self.enable_video else [MediaStreamRegistry.AudioStream()] session.connect(ToHeader(self.target), routes=notification.data.result, streams=streams) def _NH_DNSLookupDidFail(self, notification): self.output.put('DNS lookup failed: %s\n' % notification.data.error) self.stop() self.end_cancel_thread() def auto_answer_allowed(self, uri): if not self.options.auto_answer_uris: self.output.put('Auto answer allowed for %s\n' % uri) return True uri = uri.split(":")[1] auto_answer_uris = self.options.auto_answer_uris.split(",") if uri in auto_answer_uris: self.output.put('Auto answer allowed for %s\n' % uri) return True self.output.put('Auto answer denied for %s\n' % uri) return False def _NH_SIPSessionNewIncoming(self, notification): session = notification.sender for stream in notification.data.streams: if stream.type in ('audio', 'chat'): break else: - self.output.put('Session rejected with %d streams\n' % (len(notification.data.streams))) + remote_identity = str(session.remote_identity.uri) + if session.remote_identity.display_name: + remote_identity = '"%s" <%s>' % (session.remote_identity.display_name, remote_identity) + + self.output.put('Session from %s rejected due to incompatible media\n' % remote_identity) session.reject(415) return self.session_spool_dir = self.spool_dir + "/" + str(uuid.uuid1()) try: makedirs(self.session_spool_dir) except Exception as e: log.error('Failed to create session spool directory at {directory}: {exception!s}'.format(directory=self.session_spool_dir, exception=e)) else: if self.stop_call_thread is None: self.stop_call_thread = CancelThread(self) self.stop_call_thread.start() self.output.put("To stop the call: touch %s/stop\n" % self.session_spool_dir) notification_center = NotificationCenter() notification_center.add_observer(self, sender=session) accepted_types = ['video', 'audio', 'chat'] if self.enable_video else ['audio', 'chat'] if self.options.auto_answer_interval is not None and self.auto_answer_allowed(str(session.remote_identity.uri)): if self.options.auto_answer_interval == 0: session.accept([stream for stream in session.proposed_streams if stream.type in accepted_types]) return else: def auto_answer(): self.incoming_sessions.remove(session) session.accept([stream for stream in session.proposed_streams if stream.type in accepted_types]) timer = reactor.callLater(self.options.auto_answer_interval, auto_answer) self.answer_timers[id(session)] = timer session.send_ring_indication() self.incoming_sessions.append(session) if len(self.incoming_sessions) == 1: self._print_new_session() if not self.started_sessions: if self.wave_inbound_ringtone: self.wave_inbound_ringtone.start() else: self.tone_ringtone.start() def _NH_SIPSessionNewOutgoing(self, notification): session = notification.sender local_identity = str(session.local_identity.uri) if session.local_identity.display_name: local_identity = '"%s" <%s>' % (session.local_identity.display_name, local_identity) remote_identity = str(session.remote_identity.uri) if session.remote_identity.display_name: remote_identity = '"%s" <%s>' % (session.remote_identity.display_name, remote_identity) self.output.put("Initiating SIP %s session from '%s' to '%s' via %s...\n" % ('video' if self.enable_video else 'audio', local_identity, remote_identity, session.route)) def _NH_SIPSessionGotRingIndication(self, notification): if self.wave_outbound_ringtone: self.wave_outbound_ringtone.start() def _NH_SIPSessionDidFail(self, notification): session = notification.sender if session.direction == 'incoming' and session in self.incoming_sessions: if self.wave_inbound_ringtone: self.wave_inbound_ringtone.stop() self.tone_ringtone.stop() elif session.direction == 'outgoing': if self.wave_outbound_ringtone: self.wave_outbound_ringtone.stop() if notification.data.failure_reason == 'Call completed elsewhere' or notification.data.code == 487: self.output.put('Session cancelled\n') if session is self.outgoing_session: self.stop() self.end_cancel_thread() if session in self.incoming_sessions: self.incoming_sessions.remove(session) elif notification.data.failure_reason == 'user request': self.output.put('Session rejected by user (%d %s)\n' % (notification.data.code, notification.data.reason)) if notification.sender is self.outgoing_session: self.stop() self.end_cancel_thread() else: self.output.put('Session failed: %s\n' % notification.data.failure_reason) if session is self.outgoing_session: self.stop() self.end_cancel_thread() if id(session) in self.answer_timers: timer = self.answer_timers[id(session)] if timer.active(): timer.cancel() del self.answer_timers[id(session)] if self.incoming_sessions: self._print_new_session() elif session.direction == 'incoming': if self.wave_inbound_ringtone: self.wave_inbound_ringtone.stop() self.tone_ringtone.stop() self.success = False def _NH_SIPSessionWillStart(self, notification): session = notification.sender if session.direction == 'incoming': if self.wave_inbound_ringtone: self.wave_inbound_ringtone.stop() if not self.incoming_sessions: self.tone_ringtone.stop() else: if self.wave_outbound_ringtone: self.wave_outbound_ringtone.stop() if id(session) in self.answer_timers: timer = self.answer_timers[id(session)] if timer.active(): timer.cancel() del self.answer_timers[id(session)] def _NH_SIPSessionDidStart(self, notification): notification_center = NotificationCenter() session = notification.sender self.output.put('Session started with %d streams' % len(notification.data.streams)) if session.remote_user_agent is not None: self.output.put('Remote SIP User Agent is "%s"\n' % session.remote_user_agent) stream = notification.data.streams[0] if stream.type == 'audio': self.output.put('Audio stream established using "%s" codec at %sHz\n' % (stream.codec.decode(), stream.sample_rate)) if stream.ice_active: self.output.put('Audio RTP endpoints %s:%d (ICE type %s) <-> %s:%d (ICE type %s)\n' % (stream.local_rtp_address.decode(), stream.local_rtp_port, stream.local_rtp_candidate.type.lower(), stream.remote_rtp_address, stream.remote_rtp_port, stream.remote_rtp_candidate.type.lower())) else: self.output.put('Audio RTP endpoints %s:%d <-> %s:%d\n' % (stream.local_rtp_address.decode(), stream.local_rtp_port, stream.remote_rtp_address.decode(), stream.remote_rtp_port)) if stream.encryption.active: self.output.put('RTP audio stream is encrypted using %s (%s)\n' % (stream.encryption.type, stream.encryption.cipher)) try: video_stream = notification.data.streams[1] except IndexError: video_stream = None else: if video_stream.type == 'video': self.output.put('Video stream established using "%s" codec at %sHz\n' % (video_stream.codec, video_stream.sample_rate)) if video_stream.ice_active: self.output.put('Video RTP endpoints %s:%d (ICE type %s) <-> %s:%d (ICE type %s)\n' % (video_stream.local_rtp_address.decode(), video_stream.local_rtp_port, video_stream.local_rtp_candidate.type.lower(), video_stream.remote_rtp_address, video_stream.remote_rtp_port, video_stream.remote_rtp_candidate.type.lower())) else: self.output.put('Video RTP endpoints %s:%d <-> %s:%d\n' % (video_stream.local_rtp_address.decode(), video_stream.local_rtp_port, video_stream.remote_rtp_address.decode(), video_stream.remote_rtp_port)) if video_stream.encryption.active: self.output.put('RTP video stream is encrypted using %s (%s)\n' % (video_stream.encryption.type, video_stream.encryption.cipher)) self.started_sessions.append(session) if self.active_session is not None: self.active_session.hold() self.active_session = session if len(self.started_sessions) > 1: message = 'Connected sessions:\n' for session in self.started_sessions: identity = str(session.remote_identity.uri) if session.remote_identity.display_name: identity = '"%s" <%s>' % (session.remote_identity.display_name, identity) message += ' Session %s (%d/%d) - %s\n' % (identity, self.started_sessions.index(session)+1, len(self.started_sessions), 'active' if session is self.active_session else 'on hold') message += 'Press arrow keys to switch the active session\n' self.output.put(message) if self.incoming_sessions: self.tone_ringtone.start() self._print_new_session() for stream in notification.data.streams: notification_center.add_observer(self, sender=stream) if self.options.auto_hangup_interval is not None: if self.options.auto_hangup_interval == 0: session.end() else: timer = reactor.callLater(self.options.auto_hangup_interval, session.end) self.hangup_timers[id(session)] = timer def _NH_SIPSessionWillEnd(self, notification): notification_center = NotificationCenter() session = notification.sender if id(session) in self.hangup_timers: timer = self.hangup_timers[id(session)] if timer.active(): timer.cancel() del self.hangup_timers[id(session)] hangup_tone = WavePlayer(self.voice_audio_mixer, ResourcePath('sounds/hangup_tone.wav').normalized) notification_center.add_observer(self, sender=hangup_tone) self.voice_audio_bridge.add(hangup_tone) hangup_tone.start() def end_session_if_needed(self): if not self.session_spool_dir: return False stop_call_file = self.session_spool_dir + "/stop" if stop_call_file and os.path.exists(stop_call_file): if self.active_session is not None: self.output.put('Ending audio session...\n') self.active_session.end() elif self.outgoing_session is not None: self.outgoing_session.end() elif self.incoming_sessions: session = self.incoming_sessions.pop(0) session.reject() return True return False def end_cancel_thread(self): if self.stop_call_thread is not None: self.stop_call_thread.stop() self.stop_call_thread = None if self.session_spool_dir: try: shutil.rmtree(self.session_spool_dir) except OSError: pass self.session_spool_dir = None def _NH_SIPSessionDidEnd(self, notification): self.end_cancel_thread() session = notification.sender if session is not self.active_session: identity = str(session.remote_identity.uri) if session.remote_identity.display_name: identity = '"%s" <%s>' % (session.remote_identity.display_name, identity) else: identity = '\b' if notification.data.end_reason == 'user request': self.output.put('Session %s ended by %s party\n' % (identity, notification.data.originator)) else: self.output.put('Session %s ended due to error: %s\n' % (identity, notification.data.end_reason)) if session.end_time and session.start_time: duration = session.end_time - session.start_time seconds = duration.seconds if duration.microseconds < 500000 else duration.seconds+1 minutes, seconds = seconds / 60, seconds % 60 hours, minutes = minutes / 60, minutes % 60 hours += duration.days*24 if not minutes and not hours: duration_text = '%d seconds' % seconds elif not hours: duration_text = '%02d:%02d' % (minutes, seconds) else: duration_text = '%02d:%02d:%02d' % (hours, minutes, seconds) self.output.put('Session duration was %s\n' % duration_text) try: self.started_sessions.remove(session) except ValueError: self.output.put('Session ended without starting') return if session is self.active_session: if self.started_sessions: self.active_session = self.started_sessions[0] self.active_session.unhold() self.ignore_local_unhold = True identity = str(self.active_session.remote_identity.uri) if self.active_session.remote_identity.display_name: identity = '"%s" <%s>' % (self.active_session.remote_identity.display_name, identity) self.output.put('Active audio session: "%s" (%d/%d)\n' % (identity, self.started_sessions.index(self.active_session)+1, len(self.started_sessions))) else: self.active_session = None if session is self.outgoing_session: self.stop() self.end_cancel_thread() on_hold_streams = [stream for stream in chain(*(session.streams for session in self.started_sessions)) if stream.on_hold] if not on_hold_streams and self.hold_tone.is_active: self.hold_tone.stop() self.success = True def _NH_SIPSessionDidChangeHoldState(self, notification): session = notification.sender if notification.data.on_hold: if notification.data.originator == 'remote': if session is self.active_session: self.output.put('Remote party has put the audio session on hold\n') else: identity = str(session.remote_identity.uri) if session.remote_identity.display_name: identity = '"%s" <%s>' % (session.remote_identity.display_name, identity) self.output.put('%s has put the audio session on hold\n' % identity) elif not self.ignore_local_hold: if session is self.active_session: self.output.put('Session is put on hold\n') else: identity = str(session.remote_identity.uri) if session.remote_identity.display_name: identity = '"%s" <%s>' % (session.remote_identity.display_name, identity) self.output.put('Session %s is put on hold\n' % identity) else: self.ignore_local_hold = False else: if notification.data.originator == 'remote': if session is self.active_session: self.output.put('Remote party has taken the audio session out of hold\n') else: identity = str(session.remote_identity.uri) if session.remote_identity.display_name: identity = '"%s" <%s>' % (session.remote_identity.display_name, identity) self.output.put('%s has taken the audio session out of hold\n' % identity) elif not self.ignore_local_unhold: if session is self.active_session: self.output.put('Session is taken out of hold\n') else: identity = str(session.remote_identity.uri) if session.remote_identity.display_name: identity = '"%s" <%s>' % (session.remote_identity.display_name, identity) self.output.put('Session %s is taken out of hold\n' % identity) else: self.ignore_local_unhold = False def _NH_SIPSessionNewProposal(self, notification): if notification.data.originator == 'remote': session = notification.sender accepted_types = ['video', 'audio', 'chat'] if self.enable_video else ['audio', 'chat'] streams = [stream for stream in notification.data.proposed_streams if stream.type in accepted_types] if audio_streams: session.accept_proposal(streams) else: session.reject_proposal(488) def _NH_AudioStreamGotDTMF(self, notification): notification_center = NotificationCenter() digit = notification.data.digit filename = 'sounds/dtmf_%s_tone.wav' % {'*': 'star', '#': 'pound'}.get(digit, digit) self.output.put('DTMF code received: %s\n' % digit) wave_player = WavePlayer(self.voice_audio_mixer, ResourcePath(filename).normalized) notification_center.add_observer(self, sender=wave_player) self.voice_audio_bridge.add(wave_player) wave_player.start() def _NH_RTPStreamDidChangeHoldState(self, notification): if notification.data.on_hold: if not self.hold_tone.is_active: self.hold_tone.start() else: on_hold_streams = [stream for stream in chain(*(session.streams for session in self.started_sessions)) if stream is not notification.sender and stream.on_hold] if not on_hold_streams and self.hold_tone.is_active: self.hold_tone.stop() def _NH_RTPStreamDidChangeRTPParameters(self, notification): stream = notification.sender self.output.put('Audio RTP parameters changed:\n') self.output.put('Audio stream using "%s" codec at %sHz\n' % (stream.codec, stream.sample_rate)) self.output.put('Audio RTP endpoints %s:%d <-> %s:%d\n' % (stream.local_rtp_address, stream.local_rtp_port, stream.remote_rtp_address, stream.remote_rtp_port)) if stream.encryption.active: self.output.put('RTP audio stream is encrypted using %s (%s)\n' % (stream.encryption.type, stream.encryption.cipher)) def _NH_ChatStreamGotMessage(self, notification): if not notification.data.message.content_type.startswith("text/"): return self.output.put(notification.data.message.content) def _NH_AudioStreamDidStartRecording(self, notification): self.output.put('Recording audio to %s\n' % notification.data.filename) def _NH_AudioStreamDidStopRecording(self, notification): self.output.put('Stopped recording audio to %s\n' % notification.data.filename) def _NH_WavePlayerDidEnd(self, notification): notification_center = NotificationCenter() notification_center.remove_observer(self, sender=notification.sender) def _NH_WavePlayerDidFail(self, notification): notification_center = NotificationCenter() notification_center.remove_observer(self, sender=notification.sender) self.output.put('Failed to play %s: %s' % (notification.sender.filename, notification.data.error)) def _NH_DefaultAudioDeviceDidChange(self, notification): SIPApplication._NH_DefaultAudioDeviceDidChange(self, notification) if notification.data.changed_input and self.voice_audio_mixer.input_device=='system_default': self.output.put('Switched default input device to: %s\n' % self.voice_audio_mixer.real_input_device) if notification.data.changed_output and self.voice_audio_mixer.output_device=='system_default': self.output.put('Switched default output device to: %s\n' % self.voice_audio_mixer.real_output_device) if notification.data.changed_output and self.alert_audio_mixer.output_device=='system_default': self.output.put('Switched alert device to: %s\n' % self.alert_audio_mixer.real_output_device) def _NH_AudioDevicesDidChange(self, notification): old_devices = set(notification.data.old_devices) new_devices = set(notification.data.new_devices) added_devices = new_devices - old_devices removed_devices = old_devices - new_devices changed_input_device = self.voice_audio_mixer.real_input_device in removed_devices changed_output_device = self.voice_audio_mixer.real_output_device in removed_devices changed_alert_device = self.alert_audio_mixer.real_output_device in removed_devices SIPApplication._NH_AudioDevicesDidChange(self, notification) if added_devices: self.output.put('Added audio device(s): %s\n' % ', '.join(sorted(added_devices))) if removed_devices: self.output.put('Removed audio device(s): %s\n' % ', '.join(sorted(removed_devices))) if changed_input_device: self.output.put('Audio input device has been switched to: %s\n' % self.voice_audio_mixer.real_input_device) if changed_output_device: self.output.put('Audio output device has been switched to: %s\n' % self.voice_audio_mixer.real_output_device) if changed_alert_device: self.output.put('Audio alert device has been switched to: %s\n' % self.alert_audio_mixer.real_output_device) self.output.put('Available audio input devices: %s\n' % ', '.join(['None', 'system_default'] + sorted(self.engine.input_devices))) self.output.put('Available audio output devices: %s\n' % ', '.join(['None', 'system_default'] + sorted(self.engine.output_devices))) def _NH_RTPStreamICENegotiationDidSucceed(self, notification): self.output.put("ICE negotiation succeeded in %s\n" % notification.data.duration) def _NH_RTPStreamICENegotiationDidFail(self, notification): self.output.put("ICE negotiation failed: %s\n" % notification.data.reason) def _print_new_session(self): session = self.incoming_sessions[0] identity = str(session.remote_identity.uri) if session.remote_identity.display_name: identity = '"%s" <%s>' % (session.remote_identity.display_name, identity) video_streams = [stream for stream in session.proposed_streams if stream.type in ['video']] media_type = 'video' if video_streams else 'audio' self.output.put("Incoming %s session from '%s', do you want to accept? (y/n)\n" % (media_type, identity)) def parse_handle_call_option(option, opt_str, value, parser, name): try: value = parser.rargs[0] except IndexError: value = 0 else: if value == '' or value[0] == '-': value = 0 else: try: value = int(value) except ValueError: value = 0 else: del parser.rargs[0] setattr(parser.values, name, value) if __name__ == '__main__': description = 'This script can sit idle waiting for an incoming audio session, or initiate an outgoing audio session to a SIP address. The program will close the session and quit when Ctrl+D is pressed.' usage = '%prog [options] [user@domain]' parser = OptionParser(usage=usage, description=description) parser.print_usage = parser.print_help parser.add_option('-a', '--account', type='string', dest='account', help='The account name to use for any outgoing traffic. If not supplied, the default account will be used.', metavar='NAME') parser.add_option('-c', '--config-directory', type='string', dest='config_directory', help='The configuration directory to use. This overrides the default location.') parser.add_option('-s', '--trace-sip', action='store_true', dest='trace_sip', default=False, help='Dump the raw contents of incoming and outgoing SIP messages.') parser.add_option('-j', '--trace-pjsip', action='store_true', dest='trace_pjsip', default=False, help='Print PJSIP logging output.') parser.add_option('-n', '--trace-notifications', action='store_true', dest='trace_notifications', default=False, help='Print all notifications (disabled by default).') parser.add_option('-S', '--disable-sound', action='store_true', dest='disable_sound', default=False, help='Disables initializing the sound card.') parser.set_default('auto_answer_interval', None) parser.add_option('--auto-answer', action='callback', callback=parse_handle_call_option, callback_args=('auto_answer_interval',), help='Interval after which to answer an incoming session (disabled by default). If the option is specified but the interval is not, it defaults to 0 (accept the session as soon as it starts ringing).', metavar='[INTERVAL]') parser.add_option('-u', '--auto-answer-uris', type='string', dest='auto_answer_uris', default="", help='Optional list of SIP URIs for which auto-answer is allowed') parser.add_option('-i', '--external-id', type='string', dest='external_id', help='id used for call control from external application') parser.add_option('-v', '--spool-dir', type='string', dest='spool_dir', default=None, help='Spool dir for call control from external applications, default is /var/spool/sipclients/sessions') parser.add_option('-t', '--enable-default-devices', action='store_true', dest='enable_default_devices', help='Use default audio devices') parser.add_option('-V', '--enable-video', action='store_true', dest='enable_video', default=False, help='Enable video if camera is available') parser.set_default('auto_hangup_interval', None) parser.add_option('--auto-hangup', action='callback', callback=parse_handle_call_option, callback_args=('auto_hangup_interval',), help='Interval after which to hang up an established session (disabled by default). If the option is specified but the interval is not, it defaults to 0 (hangup the session as soon as it connects).', metavar='[INTERVAL]') parser.add_option('-b', '--batch', action='store_true', dest='batch_mode', default=False, help='Run the program in batch mode: reading input from the console is disabled and the option --auto-answer is implied. This is particularly useful when running this script in a non-interactive environment.') parser.add_option('-d', '--daemonize', action='store_true', dest='daemonize', default=False, help='Enable running this program as a deamon.') options, args = parser.parse_args() target = args[0] if args and not options.auto_answer_uris else None application = SIPAudioApplication() application.start(target, options) signal.signal(signal.SIGINT, signal.SIG_DFL) application.output.join() sleep(0.1) sys.exit(0 if application.success else 1) diff --git a/sip-session b/sip-session index cdd6192..2b092d8 100755 --- a/sip-session +++ b/sip-session @@ -1,2840 +1,2853 @@ #!/usr/bin/env python3 import os import re import signal import sys import urllib.request, urllib.parse, urllib.error import random import requests from collections import defaultdict from datetime import datetime, timedelta from dateutil.tz import tzlocal from itertools import chain from lxml import html from optparse import OptionParser from otr import OTRState, SMPStatus from threading import Event, Thread from time import sleep from application import log from application.notification import IObserver, NotificationCenter from application.python.queue import EventQueue from application.python import Null from eventlib import api from twisted.internet import reactor from zope.interface import implementer from otr import OTRSession, OTRTransport, OTRState, SMPStatus from otr.exceptions import IgnoreMessage, UnencryptedMessage, EncryptedMessageError, OTRError from sipsimple.core import Engine, FromHeader, Message, RouteHeader, SIPCoreError, SIPURI, ToHeader from sipsimple.account import Account, AccountManager, BonjourAccount from sipsimple.application import SIPApplication from sipsimple.audio import WavePlayer from sipsimple.configuration import ConfigurationError from sipsimple.configuration.settings import SIPSimpleSettings from sipsimple.lookup import DNSLookup from sipsimple.payloads.iscomposing import IsComposingMessage from sipsimple.session import IllegalStateError, Session from sipsimple.streams import MediaStreamRegistry from sipsimple.streams.msrp.filetransfer import FileSelector from sipsimple.streams.msrp.chat import CPIMPayload, SimplePayload, CPIMParserError, ChatIdentity, OTREncryption from sipsimple.storage import FileStorage from sipsimple.threading.green import run_in_green_thread from sipsimple.util import ISOTimestamp from sipclient.configuration import config_directory from sipclient.configuration.account import AccountExtension from sipclient.configuration.datatypes import ResourcePath from sipclient.configuration.settings import SIPSimpleSettingsExtension from sipclient.log import Logger from sipclient.system import IPAddressMonitor from sipclient.ui import Prompt, Question, RichText, UI # This is a helper function for sending formatted notice messages def show_notice(text, bold=True): ui = UI() if isinstance(text, list): ui.writelines([RichText(line, bold=bold) if not isinstance(line, RichText) else line for line in text]) elif isinstance(text, RichText): ui.write(text) else: ui.write(RichText(text, bold=bold)) # Utility classes # class BonjourNeighbour(object): def __init__(self, neighbour, uri, display_name, host): self.display_name = display_name self.host = host self.neighbour = neighbour self.uri = uri class RTPStatisticsThread(Thread): def __init__(self): Thread.__init__(self) self.setDaemon(True) self.stopped = False def run(self): application = SIPSessionApplication() while not self.stopped: if application.active_session is not None and application.active_session.streams: audio_stream = next((stream for stream in application.active_session.streams if stream.type == 'audio'), None) if audio_stream is not None: stats = audio_stream.statistics if stats is not None: reactor.callFromThread(show_notice, '%s RTP statistics: RTT=%d ms, packet loss=%.1f%%, jitter RX/TX=%d/%d ms' % (datetime.now().replace(microsecond=0), stats['rtt']['avg'] / 1000, 100.0 * stats['rx']['packets_lost'] / stats['rx']['packets'] if stats['rx']['packets'] else 0, stats['rx']['jitter']['avg'] / 1000, stats['tx']['jitter']['avg'] / 1000)) sleep(10) def stop(self): self.stopped = True class QueuedMessage(object): def __init__(self, msg_id, content, content_type='text/plain'): self.id = msg_id self.content = content self.timestamp = None self.content_type = content_type self.encrypted = False class OTRInternalMessage(QueuedMessage): def __init__(self, content): super(OTRInternalMessage, self).__init__('OTR', content, 'text/plain') @implementer(IObserver) class MessageSession(object): def __init__(self, account, target, use_cpim=False): self.account = account self.target = target self.routes = None self.use_cpim = use_cpim self.msg_id = 0 self.started = False self.msg_map = {} self.route = None self.ended = False self.encryption = OTREncryption(self) self.message_queue = EventQueue(self._send_message) target = self.target if '@' not in target: target = '%s@%s' % (target, self.account.id.domain) if not target.startswith('sip:') and not target.startswith('sips:'): target = 'sip:' + target self.remote_uri = str(target).split(":")[1] try: self.target_uri = SIPURI.parse(target) except SIPCoreError: show_notice('Illegal SIP URI: %s' % target) self.target_uri = None self.notification_center = NotificationCenter() show_notice('Message session started with %s' % self.target) def end(self): show_notice('Ending message session to %s' % self.target) if self.encryption.active: self.encryption.stop() self.notification_center = None self.message_queue = None self.encryption = None self.ended = True def start(self): if self.ended: return lookup = DNSLookup() self.notification_center.add_observer(self, sender=lookup) settings = SIPSimpleSettings() if isinstance(self.account, Account) and self.account.sip.outbound_proxy is not None: uri = SIPURI(host=self.account.sip.outbound_proxy.host, port=self.account.sip.outbound_proxy.port, parameters={'transport': self.account.sip.outbound_proxy.transport}) elif isinstance(self.account, Account) and self.account.sip.always_use_my_proxy: uri = SIPURI(host=self.account.id.domain) else: uri = self.target_uri lookup.lookup_sip_proxy(uri, settings.sip.transport_list) def handle_notification(self, notification): if self.ended: return handler = getattr(self, '_NH_%s' % notification.name, Null) handler(notification) def inject_otr_message(self, data): show_notice('Requesting %s of OTR encryption...' % 'stop' if self.encryption.active else 'start') messageObject = OTRInternalMessage(data) self.message_queue.put(messageObject) def _NH_DNSLookupDidSucceed(self, notification): self.notification_center.remove_observer(self, sender=notification.sender) self.routes = notification.data.result if not self.started: self.message_queue.start() if not self.encryption.active: self.encryption.start() show_notice('%s Session to %s will start via %s' % (datetime.now().replace(microsecond=0), self.remote_uri, self.routes[0])) self.started = True def _NH_DNSLookupDidFail(self, notification): self.notification_center.remove_observer(self, sender=notification.sender) show_notice('%s Session to %s failed: DNS lookup failed' % (datetime.now().replace(microsecond=0), self.remote_uri)) self.message_queue.stop() def send_message(self, text): if not self.routes: self.start() self.msg_id = self.msg_id + 1 messageObject = QueuedMessage(self.msg_id , text) self.message_queue.put(messageObject) return self.msg_id def _send_message(self, message): if not self.routes: return if not self.route: self.route = self.routes.pop(0) identity = str(self.account.uri) if self.account.display_name: identity = '"%s" <%s>' % (self.account.display_name, identity) if isinstance(message.content, str): charset = 'utf8' message.content = message.content.encode(charset) else: charset = None what_type = None if not isinstance(message, OTRInternalMessage): try: message.content = self.encryption.otr_session.handle_output(message.content, message.content_type) except OTRError as e: if 'has ended the private conversation' in str(e): show_notice('Encryption has been disabled by remote party, please resend the message again') self.encryption.stop() else: show_notice('Failed to encrypt outgoing message: %s' % str(e)) return else: what_type = 'OTR' if message.timestamp is None: message.timestamp = ISOTimestamp.now() if self.use_cpim: content_type = 'message/cpim' payload = CPIMPayload(message.content, 'text/plain', charset='utf-8', sender=ChatIdentity(self.account.uri, self.account.display_name), recipients=[ChatIdentity(self.remote_uri, None)]) else: payload = SimplePayload(message.content, message.content_type, charset) content, content_type = payload.encode() message_request = Message(FromHeader(self.account.uri, self.account.display_name), ToHeader(self.target_uri), RouteHeader(self.route.uri), content_type, content, credentials=self.account.credentials) self.notification_center.add_observer(self, sender=message_request) if message.id != 'OTR': if '?OTR:' in content: show_notice('Encrypted message %s sent to %s' % (message.id, self.route.uri)) message.encrypted = True else: show_notice('Message %s sent to %s' % (message.id, self.route.uri)) self.msg_map[message_request] = message message_request.send(15) def handle_incoming(self, from_header, content_type, data): self.msg_id = self.msg_id + 1 if content_type == 'message/cpim': try: payload = CPIMPayload.decode(content) except CPIMParserError as e: show_notice('CPIM parse error: %s' % str(e)) return None else: if payload.sender: identity = '%s@%s' % (payload.sender.uri.user, payload.sender.uri.host) if from_header.uri == cpim_message.sender.uri: if payload.sender.display_name: identity = '"%s" <%s>' % (payload.sender.display_name, identity) elif from_header.display_name: identity = '"%s" <%s>' % (from_header.display_name, identity) else: identity = from_header else: payload = SimplePayload.decode(data, content_type) from_header = FromHeader.new(from_header) identity = '%s@%s' % (str(from_header.uri.user), str(from_header.uri.host)) content = payload.content content_type = payload.content_type try: content = self.encryption.otr_session.handle_input(content, content_type) except IgnoreMessage: return None except UnencryptedMessage: encrypted = False encryption_active = True except EncryptedMessageError as e: show_notice('OTP encrypted message error: %s' % str(e)) return None except OTRError as e: show_notice('OTP error: %s' % str(e)) return None else: encrypted = encryption_active = self.encryption.active if payload.charset is not None: content = content.decode(payload.charset) elif payload.content_type.startswith('text/'): content.decode('utf8') return (content_type, content, identity, self.msg_id, encrypted) def _NH_SIPMessageDidSucceed(self, notification): self.notification_center.remove_observer(self, sender=notification.sender) try: message = self.msg_map[notification.sender] except KeyError: message = None else: del(self.msg_map[notification.sender]) if not message: return if message.id in (None, 'OTR'): return if notification.data.code == 202: show_notice('%s Message %s to %s will be delivered later by the server' % (datetime.now().replace(microsecond=0), message.id, self.remote_uri)) elif notification.data.code == 200: if message.encrypted: show_notice('%s Encrypted message %s received by %s' % (datetime.now().replace(microsecond=0), message.id, self.remote_uri)) else: show_notice('%s Message %s received by %s' % (datetime.now().replace(microsecond=0), message.id, self.remote_uri)) else: show_notice('%s Message %s received by %s (code %d)' % (datetime.now().replace(microsecond=0), message.id, self.remote_uri, notification.data.code )) def _NH_SIPMessageDidFail(self, notification): self.notification_center.remove_observer(self, sender=notification.sender) try: message = self.msg_map[notification.sender] except KeyError: message = None else: del(self.msg_map[notification.sender]) if not message: return if message.id in (None, 'OTR'): return server = notification.data.headers.get('Server', Null).body client = notification.data.headers.get('Client', Null).body if notification.data.code == 408 and self.routes: pass # self.route = self.routes.pop(0) # TO DO retry if message.encrypted: show_notice('%s Encrypted message %s to %s failed on %s: %s (%d)' % (datetime.now().replace(microsecond=0), message.id, self.remote_uri, server or client, notification.data.reason, notification.data.code)) else: show_notice('%s Message %s to %s failed on %s: %s (%d)' % (datetime.now().replace(microsecond=0), message.id, self.remote_uri, server or client, notification.data.reason, notification.data.code)) OTRTransport.register(MessageSession) @implementer(IObserver) class OutgoingCallInitializer(object): def __init__(self, account, target, audio=False, chat=False): self.account = account self.target = target self.streams = [] if audio: self.streams.append(MediaStreamRegistry.AudioStream()) if chat: self.streams.append(MediaStreamRegistry.ChatStream()) self.wave_ringtone = None def start(self): if isinstance(self.account, BonjourAccount) and '@' not in self.target: show_notice('Bonjour mode requires a host in the destination address') return if '@' not in self.target: self.target = '%s@%s' % (self.target, self.account.id.domain) if not self.target.startswith('sip:') and not self.target.startswith('sips:'): self.target = 'sip:' + self.target try: self.target = SIPURI.parse(self.target) except SIPCoreError: show_notice('Illegal SIP URI: %s' % self.target) else: if '.' not in self.target.host.decode() and not isinstance(self.account, BonjourAccount): self.target.host = '%s.%s' % (self.target.host, self.account.id.domain) lookup = DNSLookup() notification_center = NotificationCenter() notification_center.add_observer(self, sender=lookup) settings = SIPSimpleSettings() if isinstance(self.account, Account) and self.account.sip.outbound_proxy is not None: uri = SIPURI(host=self.account.sip.outbound_proxy.host, port=self.account.sip.outbound_proxy.port, parameters={'transport': self.account.sip.outbound_proxy.transport}) elif isinstance(self.account, Account) and self.account.sip.always_use_my_proxy: uri = SIPURI(host=self.account.id.domain) else: uri = self.target show_notice('DNS lookup for %s' % uri) lookup.lookup_sip_proxy(uri, settings.sip.transport_list) def handle_notification(self, notification): handler = getattr(self, '_NH_%s' % notification.name, Null) handler(notification) def _NH_DNSLookupDidSucceed(self, notification): notification_center = NotificationCenter() notification_center.remove_observer(self, sender=notification.sender) session = Session(self.account) notification_center.add_observer(self, sender=session) session.connect(ToHeader(self.target), routes=notification.data.result, streams=self.streams) application = SIPSessionApplication() application.outgoing_session = session def _NH_DNSLookupDidFail(self, notification): show_notice('Call to %s failed: DNS lookup error: %s' % (self.target, notification.data.error)) notification_center = NotificationCenter() notification_center.remove_observer(self, sender=notification.sender) def _NH_SIPSessionNewOutgoing(self, notification): session = notification.sender local_identity = str(session.local_identity.uri) if session.local_identity.display_name: local_identity = '"%s" <%s>' % (session.local_identity.display_name, local_identity) remote_identity = str(session.remote_identity.uri) if session.remote_identity.display_name: remote_identity = '"%s" <%s>' % (session.remote_identity.display_name, remote_identity) show_notice("Initiating SIP session from '%s' to '%s' via %s..." % (local_identity, remote_identity, session.route)) self.message_session_to = None def _NH_SIPSessionGotRingIndication(self, notification): settings = SIPSimpleSettings() ui = UI() ringtone = settings.sounds.audio_outbound if ringtone and self.wave_ringtone is None: self.wave_ringtone = WavePlayer(SIPApplication.voice_audio_mixer, ringtone.path.normalized, volume=ringtone.volume, loop_count=0, pause_time=2) SIPApplication.voice_audio_bridge.add(self.wave_ringtone) self.wave_ringtone.start() ui.status = 'Ringing...' def _NH_SIPSessionWillStart(self, notification): ui = UI() if self.wave_ringtone: self.wave_ringtone.stop() SIPApplication.voice_audio_bridge.remove(self.wave_ringtone) self.wave_ringtone = None ui.status = 'Connecting...' def _NH_SIPSessionDidStart(self, notification): notification_center = NotificationCenter() ui = UI() session = notification.sender notification_center.remove_observer(self, sender=session) ui.status = 'Connected' reactor.callLater(2, setattr, ui, 'status', None) application = SIPSessionApplication() application.outgoing_session = None for stream in notification.data.streams: if stream.type == 'audio': show_notice('Audio session established using "%s" codec at %sHz' % (stream.codec, stream.sample_rate)) if stream.ice_active: show_notice('Audio RTP endpoints %s:%d (ICE type %s) <-> %s:%d (ICE type %s)' % (stream.local_rtp_address, stream.local_rtp_port, stream.local_rtp_candidate.type.lower(), stream.remote_rtp_address, stream.remote_rtp_port, stream.remote_rtp_candidate.type.lower())) else: show_notice('Audio RTP endpoints %s:%d <-> %s:%d' % (stream.local_rtp_address, stream.local_rtp_port, stream.remote_rtp_address, stream.remote_rtp_port)) if session.remote_user_agent is not None: show_notice('Remote SIP User Agent is "%s"' % session.remote_user_agent) def _NH_SIPSessionDidFail(self, notification): notification_center = NotificationCenter() session = notification.sender notification_center.remove_observer(self, sender=session) ui = UI() ui.status = None application = SIPSessionApplication() application.outgoing_session = None if self.wave_ringtone: self.wave_ringtone.stop() SIPApplication.voice_audio_bridge.remove(self.wave_ringtone) self.wave_ringtone = None if notification.data.failure_reason == 'user request' and notification.data.code == 487: show_notice('SIP session cancelled') elif notification.data.failure_reason == 'user request': show_notice('SIP session rejected by user (%d %s)' % (notification.data.code, notification.data.reason)) else: show_notice('SIP session failed: %s' % notification.data.failure_reason) @implementer(IObserver) class IncomingCallInitializer(object): sessions = 0 tone_ringtone = None def __init__(self, session, auto_answer_interval=None): self.session = session self.auto_answer_interval = auto_answer_interval self.question = None def start(self): IncomingCallInitializer.sessions += 1 notification_center = NotificationCenter() notification_center.add_observer(self, sender=self.session) # start auto-answer self.answer_timer = None if self.auto_answer_interval == 0: self.session.accept(self.session.proposed_streams) return elif self.auto_answer_interval and self.auto_answer_interval > 0: self.answer_timer = reactor.callFromThread(reactor.callLater, self.auto_answer_interval, self.session.accept, self.session.proposed_streams) # start ringing application = SIPSessionApplication() self.wave_ringtone = None if application.active_session is None: if IncomingCallInitializer.sessions == 1: ringtone = self.session.account.sounds.audio_inbound.sound_file if self.session.account.sounds.audio_inbound is not None else None if ringtone: self.wave_ringtone = WavePlayer(SIPApplication.alert_audio_mixer, ringtone.path.normalized, volume=ringtone.volume, loop_count=0, pause_time=2) SIPApplication.alert_audio_bridge.add(self.wave_ringtone) self.wave_ringtone.start() elif IncomingCallInitializer.tone_ringtone is None: IncomingCallInitializer.tone_ringtone = WavePlayer(SIPApplication.voice_audio_mixer, ResourcePath('sounds/ring_tone.wav').normalized, loop_count=0, pause_time=6) SIPApplication.voice_audio_bridge.add(IncomingCallInitializer.tone_ringtone) IncomingCallInitializer.tone_ringtone.start() self.session.send_ring_indication() # ask question identity = str(self.session.remote_identity.uri) if self.session.remote_identity.display_name: identity = '"%s" <%s>' % (self.session.remote_identity.display_name, identity) streams = '/'.join(stream.type for stream in self.session.proposed_streams) self.question = Question("Incoming %s from '%s', do you want to accept? (a)ccept/(r)eject/(b)usy" % (streams, identity), 'arbi', bold=True) notification_center.add_observer(self, sender=self.question) ui = UI() ui.add_question(self.question) def handle_notification(self, notification): handler = getattr(self, '_NH_%s' % notification.name, Null) handler(notification) def _NH_UIQuestionGotAnswer(self, notification): notification_center = NotificationCenter() ui = UI() notification_center.remove_observer(self, sender=notification.sender) answer = notification.data.answer self.question = None if answer == 'a': self.session.accept(self.session.proposed_streams) ui.status = 'Accepting...' elif answer == 'r': self.session.reject() ui.status = 'Rejecting...' elif answer == 'b': self.session.reject(486) ui.status = 'Sending Busy Here...' if self.wave_ringtone: self.wave_ringtone.stop() self.wave_ringtone = None if IncomingCallInitializer.sessions > 1: if IncomingCallInitializer.tone_ringtone is None: IncomingCallInitializer.tone_ringtone = WavePlayer(SIPApplication.voice_audio_mixer, ResourcePath('sounds/ring_tone.wav').normalized, loop_count=0, pause_time=6) SIPApplication.voice_audio_bridge.add(IncomingCallInitializer.tone_ringtone) IncomingCallInitializer.tone_ringtone.start() elif IncomingCallInitializer.tone_ringtone: IncomingCallInitializer.tone_ringtone.stop() IncomingCallInitializer.tone_ringtone = None if self.answer_timer is not None and self.answer_timer.active(): self.answer_timer.cancel() def _NH_SIPSessionWillStart(self, notification): ui = UI() if self.question is not None: notification_center = NotificationCenter() notification_center.remove_observer(self, sender=self.question) ui.remove_question(self.question) self.question = None ui.status = 'Connecting...' def _NH_SIPSessionDidStart(self, notification): notification_center = NotificationCenter() session = notification.sender notification_center.remove_observer(self, sender=session) IncomingCallInitializer.sessions -= 1 ui = UI() ui.status = 'Connected' reactor.callLater(2, setattr, ui, 'status', None) identity = str(session.remote_identity.uri) if session.remote_identity.display_name: identity = '"%s" <%s>' % (session.remote_identity.display_name, identity) show_notice("SIP session with '%s' established" % identity) for stream in notification.data.streams: if stream.type == 'audio': show_notice('Audio stream using "%s" codec at %sHz' % (stream.codec, stream.sample_rate)) if stream.ice_active: show_notice('Audio RTP endpoints %s:%d (ICE type %s) <-> %s:%d (ICE type %s)' % (stream.local_rtp_address, stream.local_rtp_port, stream.local_rtp_candidate_type, stream.remote_rtp_address, stream.remote_rtp_port, stream.remote_rtp_candidate_type)) else: show_notice('Audio RTP endpoints %s:%d <-> %s:%d' % (stream.local_rtp_address, stream.local_rtp_port, stream.remote_rtp_address, stream.remote_rtp_port)) if stream.encryption.active: show_notice('RTP audio stream is encrypted using %s (%s)\n' % (stream.encryption.type, stream.encryption.cipher)) if session.remote_user_agent is not None: show_notice('Remote SIP User Agent is "%s"' % session.remote_user_agent) def _NH_SIPSessionDidFail(self, notification): notification_center = NotificationCenter() ui = UI() session = notification.sender notification_center.remove_observer(self, sender=session) ui.status = None if self.question is not None: notification_center.remove_observer(self, sender=self.question) ui.remove_question(self.question) self.question = None IncomingCallInitializer.sessions -= 1 if self.wave_ringtone: self.wave_ringtone.stop() self.wave_ringtone = None if IncomingCallInitializer.sessions == 0 and IncomingCallInitializer.tone_ringtone is not None: IncomingCallInitializer.tone_ringtone.stop() IncomingCallInitializer.tone_ringtone = None if notification.data.failure_reason == 'user request' and notification.data.code == 487: show_notice('SIP session cancelled by user') if notification.data.failure_reason == 'Call completed elsewhere' and notification.data.code == 487: show_notice('SIP session cancelled, call was answered elsewhere') elif notification.data.failure_reason == 'user request': show_notice('SIP session rejected (%d %s)' % (notification.data.code, notification.data.reason)) else: show_notice('SIP session failed: %s' % notification.data.failure_reason) @implementer(IObserver) class OutgoingProposalHandler(object): def __init__(self, session, audio=False, chat=False): self.session = session self.stream = None if audio: self.stream = MediaStreamRegistry.AudioStream() if chat: self.stream = MediaStreamRegistry.ChatStream() if not self.stream: raise ValueError("Need to specify exactly one stream") def start(self): notification_center = NotificationCenter() notification_center.add_observer(self, sender=self.session) try: self.session.add_stream(self.stream) except IllegalStateError: notification_center.remove_observer(self, sender=self.session) raise remote_identity = str(self.session.remote_identity.uri) if self.session.remote_identity.display_name: remote_identity = '"%s" <%s>' % (self.session.remote_identity.display_name, remote_identity) show_notice("Proposing %s to '%s'..." % (self.stream.type, remote_identity)) def handle_notification(self, notification): handler = getattr(self, '_NH_%s' % notification.name, Null) handler(notification) def _NH_SIPSessionProposalAccepted(self, notification): notification_center = NotificationCenter() notification_center.remove_observer(self, sender=self.session) application = SIPSessionApplication() application.sessions_with_proposals.remove(notification.sender) show_notice('Proposal accepted') def _NH_SIPSessionProposalRejected(self, notification): notification_center = NotificationCenter() notification_center.remove_observer(self, sender=self.session) application = SIPSessionApplication() application.sessions_with_proposals.remove(notification.sender) ui = UI() ui.status = None if notification.data.code == 487: show_notice('Proposal cancelled (%d %s)' % (notification.data.code, notification.data.reason)) else: show_notice('Proposal rejected (%d %s)' % (notification.data.code, notification.data.reason)) def _NH_SIPSessionDidEnd(self, notification): notification_center = NotificationCenter() notification_center.remove_observer(self, sender=self.session) @implementer(IObserver) class IncomingProposalHandler(object): sessions = 0 tone_ringtone = None def __init__(self, session): self.session = session self.question = None def start(self): IncomingProposalHandler.sessions += 1 notification_center = NotificationCenter() notification_center.add_observer(self, sender=self.session) # start ringing if IncomingProposalHandler.tone_ringtone is None: IncomingProposalHandler.tone_ringtone = WavePlayer(SIPApplication.voice_audio_mixer, ResourcePath('sounds/ring_tone.wav').normalized, loop_count=0, pause_time=6) SIPApplication.voice_audio_bridge.add(IncomingProposalHandler.tone_ringtone) IncomingProposalHandler.tone_ringtone.start() self.session.send_ring_indication() # ask question identity = str(self.session.remote_identity.uri) if self.session.remote_identity.display_name: identity = '"%s" <%s>' % (self.session.remote_identity.display_name, identity) streams = ', '.join(stream.type for stream in self.session.proposed_streams) self.question = Question("'%s' wants to add %s, do you want to accept? (a)ccept/(r)eject" % (identity, streams), 'ar', bold=True) notification_center.add_observer(self, sender=self.question) ui = UI() ui.add_question(self.question) def handle_notification(self, notification): handler = getattr(self, '_NH_%s' % notification.name, Null) handler(notification) def _NH_UIQuestionGotAnswer(self, notification): notification_center = NotificationCenter() ui = UI() notification_center.remove_observer(self, sender=notification.sender) answer = notification.data.answer self.question = None if answer == 'a': self.session.accept_proposal(self.session.proposed_streams) ui.status = 'Accepting proposal...' elif answer == 'r': self.session.reject_proposal() ui.status = 'Rejecting proposal...' if IncomingProposalHandler.sessions == 1 and IncomingProposalHandler.tone_ringtone: IncomingProposalHandler.tone_ringtone.stop() IncomingProposalHandler.tone_ringtone = None def _NH_SIPSessionProposalAccepted(self, notification): notification_center = NotificationCenter() session = notification.sender notification_center.remove_observer(self, sender=session) application = SIPSessionApplication() application.sessions_with_proposals.remove(notification.sender) IncomingProposalHandler.sessions -= 1 ui = UI() ui.status = None show_notice('Proposal accepted') def _NH_SIPSessionProposalRejected(self, notification): notification_center = NotificationCenter() session = notification.sender notification_center.remove_observer(self, sender=session) application = SIPSessionApplication() application.sessions_with_proposals.remove(notification.sender) IncomingProposalHandler.sessions -= 1 ui = UI() ui.status = None if notification.data.code == 487: show_notice('Proposal cancelled (%d %s)' % (notification.data.code, notification.data.reason)) else: show_notice('Proposal rejected (%d %s)' % (notification.data.code, notification.data.reason)) if IncomingProposalHandler.tone_ringtone: IncomingProposalHandler.tone_ringtone.stop() IncomingProposalHandler.tone_ringtone = None if self.question is not None: notification_center.remove_observer(self, sender=self.question) ui.remove_question(self.question) self.question = None def _NH_SIPSessionHadProposalFailure(self, notification): notification_center = NotificationCenter() session = notification.sender notification_center.remove_observer(self, sender=session) IncomingProposalHandler.sessions -= 1 ui = UI() ui.status = None show_notice('Proposal failed (%s)' % notification.data.failure_reason) def _NH_SIPSessionDidEnd(self, notification): notification_center = NotificationCenter() ui = UI() session = notification.sender notification_center.remove_observer(self, sender=session) ui.status = None if self.question is not None: notification_center.remove_observer(self, sender=self.question) ui.remove_question(self.question) self.question = None IncomingProposalHandler.sessions -= 1 if IncomingProposalHandler.sessions == 0 and IncomingProposalHandler.tone_ringtone is not None: IncomingProposalHandler.tone_ringtone.stop() IncomingProposalHandler.tone_ringtone = None @implementer(IObserver) class OutgoingTransferHandler(object): def __init__(self, account, target, filepath): self.account = account self.target = target self.filepath = filepath.decode(sys.getfilesystemencoding()) self.file_selector = None self.hash_compute_proc = None self.session = None self.stream = None self.handler = None self.wave_ringtone = None @run_in_green_thread def start(self): if isinstance(self.account, BonjourAccount) and '@' not in self.target: show_notice('Bonjour mode requires a host in the destination address') return if '@' not in self.target: self.target = '%s@%s' % (self.target, self.account.id.domain) if not self.target.startswith('sip:') and not self.target.startswith('sips:'): self.target = 'sip:' + self.target try: self.target = SIPURI.parse(self.target) except SIPCoreError: show_notice('Illegal SIP URI: %s' % self.target) return show_notice('Preparing transfer...') self.file_selector = FileSelector.for_file(self.filepath) if '.' not in self.target.host.decode() and not isinstance(self.account, BonjourAccount): self.target.host = '%s.%s' % (self.target.host, self.account.id.domain) lookup = DNSLookup() notification_center = NotificationCenter() notification_center.add_observer(self, sender=lookup) settings = SIPSimpleSettings() if isinstance(self.account, Account) and self.account.sip.outbound_proxy is not None: uri = SIPURI(host=self.account.sip.outbound_proxy.host, port=self.account.sip.outbound_proxy.port, parameters={'transport': self.account.sip.outbound_proxy.transport}) elif isinstance(self.account, Account) and self.account.sip.always_use_my_proxy: uri = SIPURI(host=self.account.id.domain) else: uri = self.target lookup.lookup_sip_proxy(uri, settings.sip.transport_list) def _terminate(self, failure_reason=None): notification_center = NotificationCenter() notification_center.remove_observer(self, sender=self.session) notification_center.remove_observer(self, sender=self.stream) notification_center.remove_observer(self, sender=self.handler) ui = UI() ui.status = None if self.wave_ringtone: self.wave_ringtone.stop() self.wave_ringtone = None if failure_reason is None: show_notice('File transfer of %s finished' % os.path.basename(self.filepath)) else: show_notice('File transfer of %s failed: %s' % (os.path.basename(self.filepath), failure_reason)) self.session = None self.stream = None self.handler = None def handle_notification(self, notification): handler = getattr(self, '_NH_%s' % notification.name, Null) handler(notification) def _NH_DNSLookupDidSucceed(self, notification): notification.center.remove_observer(self, sender=notification.sender) self.session = Session(self.account) self.stream = MediaStreamRegistry.FileTransferStream(self.file_selector, 'sendonly') self.handler = self.stream.handler notification.center.add_observer(self, sender=self.session) notification.center.add_observer(self, sender=self.stream) notification.center.add_observer(self, sender=self.handler) self.session.connect(ToHeader(self.target), routes=notification.data.result, streams=[self.stream]) def _NH_DNSLookupDidFail(self, notification): notification.center.remove_observer(self, sender=notification.sender) show_notice('File transfer to %s failed: DNS lookup error: %s' % (self.target, notification.data.error)) def _NH_SIPSessionNewOutgoing(self, notification): session = notification.sender local_identity = str(session.local_identity.uri) if session.local_identity.display_name: local_identity = '"%s" <%s>' % (session.local_identity.display_name, local_identity) remote_identity = str(session.remote_identity.uri) if session.remote_identity.display_name: remote_identity = '"%s" <%s>' % (session.remote_identity.display_name, remote_identity) show_notice("Initiating file transfer from '%s' to '%s' via %s..." % (local_identity, remote_identity, session.route)) def _NH_SIPSessionGotRingIndication(self, notification): settings = SIPSimpleSettings() ui = UI() ringtone = settings.sounds.audio_outbound if ringtone and self.wave_ringtone is None: self.wave_ringtone = WavePlayer(SIPApplication.voice_audio_mixer, ringtone.path.normalized, volume=ringtone.volume, loop_count=0, pause_time=2) SIPApplication.voice_audio_bridge.add(self.wave_ringtone) self.wave_ringtone.start() ui.status = 'Ringing...' def _NH_SIPSessionWillStart(self, notification): ui = UI() if self.wave_ringtone: self.wave_ringtone.stop() ui.status = 'Connecting...' def _NH_SIPSessionDidStart(self, notification): session = notification.sender ui = UI() ui.status = 'File transfer connected' identity = str(session.remote_identity.uri) if session.remote_identity.display_name: identity = '"%s" <%s>' % (session.remote_identity.display_name, identity) show_notice("File transfer for %s to '%s' started" % (os.path.basename(self.filepath), identity)) def _NH_MediaStreamDidNotInitialize(self, notification): self._terminate(failure_reason=notification.data.reason) def _NH_FileTransferHandlerDidEnd(self, notification): self.session.end() self._terminate(failure_reason=notification.data.reason) @implementer(IObserver) class IncomingTransferHandler(object): sessions = 0 tone_ringtone = None def __init__(self, session, auto_answer_interval=None): self.session = session self.stream = None self.handler = None self.auto_answer_interval = auto_answer_interval self.file = None self.filename = None self.finished = False self.hash = None self.question = None self.wave_ringtone = None def start(self): self.stream = self.session.proposed_streams[0] self.handler = self.stream.handler self.file_selector = self.stream.file_selector self.filename = self.file_selector.name IncomingTransferHandler.sessions += 1 notification_center = NotificationCenter() notification_center.add_observer(self, sender=self.session) notification_center.add_observer(self, sender=self.stream) notification_center.add_observer(self, sender=self.handler) # start auto-answer self.answer_timer = None if self.auto_answer_interval == 0: self.session.accept(self.session.proposed_streams) return - elif self.auto_answer_interval > 0: + elif (self.auto_answer_interval and self.auto_answer_interval > 0): self.answer_timer = reactor.callFromThread(reactor.callLater, self.auto_answer_interval, self.session.accept, self.session.proposed_streams) # start ringing application = SIPSessionApplication() if application.active_session is None: if IncomingTransferHandler.sessions == 1: ringtone = self.session.account.sounds.audio_inbound.sound_file if self.session.account.sounds.audio_inbound is not None else None if ringtone: self.wave_ringtone = WavePlayer(SIPApplication.alert_audio_mixer, ringtone.path.normalized, volume=ringtone.volume, loop_count=0, pause_time=2) SIPApplication.alert_audio_bridge.add(self.wave_ringtone) self.wave_ringtone.start() elif IncomingTransferHandler.tone_ringtone is None: IncomingTransferHandler.tone_ringtone = WavePlayer(SIPApplication.voice_audio_mixer, ResourcePath('sounds/ring_tone.wav').normalized, loop_count=0, pause_time=6) SIPApplication.voice_audio_bridge.add(IncomingTransferHandler.tone_ringtone) IncomingTransferHandler.tone_ringtone.start() self.session.send_ring_indication() # ask question identity = str(self.session.remote_identity.uri) if self.session.remote_identity.display_name: identity = '"%s" <%s>' % (self.session.remote_identity.display_name, identity) self.question = Question("Incoming file transfer for %s from '%s', do you want to accept? (a)ccept/(r)eject" % (os.path.basename(self.filename), identity), 'ari', bold=True) notification_center.add_observer(self, sender=self.question) ui = UI() ui.add_question(self.question) def _terminate(self, failure_reason=None): notification_center = NotificationCenter() notification_center.remove_observer(self, sender=self.session) notification_center.remove_observer(self, sender=self.stream) notification_center.remove_observer(self, sender=self.handler) ui = UI() ui.status = None if self.question is not None: notification_center.remove_observer(self, sender=self.question) ui.remove_question(self.question) self.question = None if self.wave_ringtone: self.wave_ringtone.stop() if failure_reason is None: show_notice('File transfer of %s finished' % os.path.basename(self.filename)) else: show_notice('File transfer of %s failed: %s' % (os.path.basename(self.filename), failure_reason)) self.session = None self.stream = None self.handler = None def handle_notification(self, notification): handler = getattr(self, '_NH_%s' % notification.name, Null) handler(notification) def _NH_UIQuestionGotAnswer(self, notification): notification_center = NotificationCenter() ui = UI() notification_center.remove_observer(self, sender=notification.sender) answer = notification.data.answer self.question = None if answer == 'a': self.session.accept(self.session.proposed_streams) ui.status = 'Accepting...' elif answer == 'r': self.session.reject() ui.status = 'Rejecting...' if IncomingTransferHandler.sessions == 1: if self.wave_ringtone: self.wave_ringtone.stop() self.wave_ringtone = None if IncomingTransferHandler.tone_ringtone: IncomingTransferHandler.tone_ringtone.stop() IncomingTransferHandler.tone_ringtone = None if self.answer_timer is not None and self.answer_timer.active(): self.answer_timer.cancel() def _NH_SIPSessionWillStart(self, notification): ui = UI() if self.question is not None: notification_center = NotificationCenter() notification_center.remove_observer(self, sender=self.question) ui.remove_question(self.question) self.question = None ui.status = 'Connecting...' notification_center = NotificationCenter() notification_center.add_observer(self, sender=notification.sender.proposed_streams[0]) def _NH_SIPSessionDidStart(self, notification): session = notification.sender IncomingCallInitializer.sessions -= 1 ui = UI() ui.status = 'File transfer connected' identity = str(session.remote_identity.uri) if session.remote_identity.display_name: identity = '"%s" <%s>' % (session.remote_identity.display_name, identity) - show_notice("File transfer for %s with '%s' started" % (os.path.basename(self.filename), identity)) + show_notice("File transfer for %s with %s started" % (os.path.basename(self.filename), identity)) if IncomingTransferHandler.sessions == 1: if self.wave_ringtone: self.wave_ringtone.stop() self.wave_ringtone = None if IncomingTransferHandler.tone_ringtone: IncomingTransferHandler.tone_ringtone.stop() IncomingTransferHandler.tone_ringtone = None def _NH_SIPSessionDidFail(self, notification): IncomingTransferHandler.sessions -= 1 if self.wave_ringtone: self.wave_ringtone.stop() self.wave_ringtone = None if IncomingTransferHandler.sessions == 0 and IncomingTransferHandler.tone_ringtone is not None: IncomingTransferHandler.tone_ringtone.stop() IncomingTransferHandler.tone_ringtone = None def _NH_MediaStreamDidNotInitialize(self, notification): self._terminate(failure_reason=notification.data.reason) def _NH_FileTransferHandlerDidInitialize(self, notification): self.filename = self.stream.file_selector.name def _NH_FileTransferHandlerProgress(self, notification): ui = UI() ui.status = '%s: %s%%' % (os.path.basename(self.filename), notification.data.transferred_bytes*100//notification.data.total_bytes) def _NH_FileTransferHandlerDidEnd(self, notification): reactor.callFromThread(reactor.callLater, 0, self.session.end) self._terminate(failure_reason=notification.data.reason) class SIPSessionApplication(SIPApplication): # public methods # def __init__(self): self.account = None self.options = None self.target = None self.active_session = None self.message_session_to = None self.outgoing_session = None self.connected_sessions = [] self.sessions_with_proposals = set() self.hangup_timers = {} self.neighbours = {} self.registration_succeeded = {} self.stopped_event = Event() self.received_message_ids = set() self.message_sessions = set() self.ip_address_monitor = IPAddressMonitor() self.logger = None self.rtp_statistics = None self.hold_tone = None self.ignore_local_hold = False self.ignore_local_unhold = False self.smp_verification_question = 'What is the ZRTP authentication string?' self.smp_verifified_using_zrtp = False self.smp_verification_delay = 0 self.smp_verification_tries = 5 self.smp_secret = None def start(self, target, options): notification_center = NotificationCenter() ui = UI() history_file = os.path.join(config_directory, 'input.history') ui.input.add_history(history_file) self.options = options self.target = target self.logger = Logger(sip_to_stdout=options.trace_sip, msrp_to_stdout=options.trace_msrp, pjsip_to_stdout=options.trace_pjsip, notifications_to_stdout=options.trace_notifications) notification_center.add_observer(self, sender=self) notification_center.add_observer(self, sender=ui) notification_center.add_observer(self, name='SIPSessionNewIncoming') notification_center.add_observer(self, name='SIPSessionNewOutgoing') notification_center.add_observer(self, name='RTPStreamDidChangeRTPParameters') notification_center.add_observer(self, name='RTPStreamICENegotiationDidSucceed') notification_center.add_observer(self, name='RTPStreamICENegotiationDidFail') notification_center.add_observer(self, name='SIPEngineGotMessage') log.level.current = log.level.WARNING # get rid of twisted messages control_bindings={'s': 'trace sip', 'm': 'trace msrp', 'j': 'trace pjsip', 'n': 'trace notifications', 'h': 'hangup', 'r': 'record', 'i': 'input', 'o': 'output', 'a': 'alert', 'u': 'mute', ' ': 'hold', 'q': 'quit', '/': 'help', '?': 'help', '0': 'dtmf 0', '1': 'dtmf 1', '2': 'dtmf 2', '3': 'dtmf 3', '4': 'dtmf 4', '5': 'dtmf 5', '6': 'dtmf 6', '7': 'dtmf 7', '8': 'dtmf 8', '9': 'dtmf 9', '*': 'dtmf *', '#': 'dtmf #', 'A': 'dtmf A', 'B': 'dtmf B', 'C': 'dtmf C', 'D': 'dtmf D'} ui.start(control_bindings=control_bindings, display_text=False) Account.register_extension(AccountExtension) BonjourAccount.register_extension(AccountExtension) SIPSimpleSettings.register_extension(SIPSimpleSettingsExtension) try: SIPApplication.start(self, FileStorage(options.config_directory or config_directory)) except ConfigurationError as e: show_notice("Failed to load sipclient's configuration: %s\n" % str(e), bold=False) show_notice("If an old configuration file is in place, delete it or move it and recreate the configuration using the sip_settings script.", bold=False) ui.stop() self.stopped_event.set() # notification handlers # def _NH_SIPApplicationWillStart(self, notification): account_manager = AccountManager() notification_center = NotificationCenter() settings = SIPSimpleSettings() ui = UI() settings.logs.trace_sip = self.options.trace_sip settings.logs.trace_msrp = self.options.trace_msrp settings.logs.trace_pjsip = self.options.trace_pjsip settings.logs.trace_notifications = self.options.trace_notifications settings.save() for account in account_manager.iter_accounts(): if isinstance(account, Account): account.sip.register = False account.presence.enabled = False account.xcap.enabled = False account.message_summary.enabled = False notification_center.add_observer(self, sender=account) if self.options.account is None: self.account = account_manager.default_account else: possible_accounts = [account for account in account_manager.iter_accounts() if self.options.account in account.id and account.enabled] if len(possible_accounts) > 1: show_notice('More than one account exists which matches %s: %s' % (self.options.account, ', '.join(sorted(account.id for account in possible_accounts))), bold=False) self.stop() return elif len(possible_accounts) == 0: show_notice('No enabled account which matches %s was found. Available and enabled accounts: %s' % (self.options.account, ', '.join(sorted(account.id for account in account_manager.get_accounts() if account.enabled))), bold=False) self.stop() return else: self.account = possible_accounts[0] if isinstance(self.account, Account): self.account.sip.register = True show_notice('Using account %s' % self.account.id, bold=False) ui.prompt = Prompt(self.account.id, foreground='default') self.logger.start() if settings.logs.trace_sip and self.logger._siptrace_filename is not None: show_notice('Logging SIP trace to file "%s"' % self.logger._siptrace_filename, bold=False) if settings.logs.trace_msrp and self.logger._msrptrace_filename is not None: show_notice('Logging MSRP trace to file "%s"' % self.logger._msrptrace_filename, bold=False) if settings.logs.trace_pjsip and self.logger._pjsiptrace_filename is not None: show_notice('Logging PJSIP trace to file "%s"' % self.logger._pjsiptrace_filename, bold=False) if settings.logs.trace_notifications and self.logger._notifications_filename is not None: show_notice('Logging notifications trace to file "%s"' % self.logger._notifications_filename, bold=False) if self.options.disable_sound: settings.audio.input_device = None settings.audio.output_device = None settings.audio.alert_device = None def _NH_SIPApplicationDidStart(self, notification): settings = SIPSimpleSettings() self.ip_address_monitor.start() # set the file transfer directory if it's not set if settings.file_transfer.directory is None: settings.file_transfer.directory = 'file_transfers' # display a list of available devices self._CH_devices() show_notice('Type /help to see a list of available commands.', bold=False) if self.target is not None: call_initializer = OutgoingCallInitializer(self.account, self.target, audio=True) call_initializer.start() def _NH_SIPApplicationWillEnd(self, notification): show_notice('Application will end') self.ip_address_monitor.stop() def _NH_SIPApplicationDidEnd(self, notification): ui = UI() ui.stop() self.stopped_event.set() def _NH_SIPEngineDetectedNATType(self, notification): SIPApplication._NH_SIPEngineDetectedNATType(self, notification) if notification.data.succeeded: show_notice('Detected NAT type: %s' % notification.data.nat_type) def _NH_UIInputGotCommand(self, notification): handler = getattr(self, '_CH_%s' % notification.data.command, None) if handler is not None: try: handler(*notification.data.args) except TypeError: show_notice('Illegal use of command /%s. Type /help for a list of available commands.' % notification.data.command) else: show_notice('Unknown command /%s. Type /help for a list of available commands.' % notification.data.command) def _NH_UIInputGotText(self, notification): msrp_chat = None message_text = notification.data.text local_identity = '%s@%s' % (self.account.id.username, self.account.id.domain) encrypted = False if self.active_session is not None: msrp_chat = next((stream for stream in self.active_session.streams if stream.type == 'chat'), None) if msrp_chat: msrp_chat.send_message(message_text) if msrp_chat.local_identity.display_name: local_identity = msrp_chat.local_identity.display_name else: local_identity = str(msrp_chat.local_identity.uri) else: # compose SMS message pass elif self.message_session_to: # compose SMS message message_session = self.message_session(self.message_session_to) msg_id = message_session.send_message(message_text) message_text = message_text + ' (%s)' % msg_id if message_session.encryption.active: local_identity = '%s encrypted text sent to %s' % (local_identity, self.message_session_to) else: local_identity = '%s clear text sent to %s' % (local_identity, self.message_session_to) else: show_notice('No active chat or message session') return ui = UI() ui.write(RichText('%s> ' % local_identity, foreground='darkred') + message_text) def message_session(self, recipient): try: message_session = next((session for session in self.message_sessions if session.target == recipient and self.account == session.account)) except StopIteration: message_session = MessageSession(self.account, recipient) self.message_sessions.add(message_session) return message_session def _NH_SIPEngineGotException(self, notification): lines = ['An exception occured within the SIP core:'] lines.extend(notification.data.traceback.split('\n')) show_notice(lines) def _NH_SIPAccountRegistrationDidSucceed(self, notification): account = notification.sender try: s = self.registration_succeeded[account.id] except KeyError: pass else: if s and notification.data.expires == 0: show_notice('%s Registration ended for %s' % (datetime.now().replace(microsecond=0), notification.sender.id)) return contact_header = notification.data.contact_header contact_header_list = notification.data.contact_header_list expires = notification.data.expires registrar = notification.data.registrar now = datetime.now().replace(microsecond=0) lines = ['%s Registered contact "%s" of %s at %s:%d;transport=%s for %d seconds' % (now, contact_header.uri, account.id, registrar.address, registrar.port, registrar.transport, expires)] if len(contact_header_list) > 1: lines.append('%s Other registered contacts of %s:' % (now, account.id)) lines.extend('%s %s of %s for %s seconds' % (now, str(other_contact_header.uri), account.id, other_contact_header.expires) for other_contact_header in contact_header_list if other_contact_header.uri != notification.data.contact_header.uri) if account.contact.public_gruu is not None: lines.append('%s Public GRUU: %s' % (now, account.contact.public_gruu)) if account.contact.temporary_gruu is not None: lines.append('%s Temporary GRUU: %s' % (now, account.contact.temporary_gruu)) show_notice(lines) self.registration_succeeded[account.id] = True def _NH_SIPAccountRegistrationDidFail(self, notification): account = notification.sender if self.active_session is None: show_notice('%s Failed to register contact for %s: %s (retrying in %.2f seconds)' % (datetime.now().replace(microsecond=0), account.id, notification.data.error, notification.data.retry_after)) self.registration_succeeded[notification.sender.id] = False def _NH_SIPAccountRegistrationDidEnd(self, notification): account = notification.sender show_notice('%s Registration ended for %s' % (datetime.now().replace(microsecond=0), account.id)) def _NH_BonjourAccountRegistrationDidSucceed(self, notification): show_notice('%s Registered Bonjour contact %s' % (datetime.now().replace(microsecond=0), notification.data.name)) def _NH_BonjourAccountRegistrationDidFail(self, notification): show_notice('%s Failed to register Bonjour contact: %s' % (datetime.now().replace(microsecond=0), notification.data.reason)) def _NH_BonjourAccountRegistrationDidEnd(self, notification): pass #show_notice('%s Bonjour registration ended for %s' % (datetime.now().replace(microsecond=0), notification.sender.id)) def _NH_BonjourAccountDidAddNeighbour(self, notification): neighbour, record = notification.data.neighbour, notification.data.record now = datetime.now().replace(microsecond=0) #show_notice('%s Discovered Bonjour neighbour: "%s (%s)" <%s>' % (now, record.name, record.host, record.uri)) self.neighbours[neighbour] = BonjourNeighbour(neighbour, record.uri, record.name, record.host) def _NH_BonjourAccountDidUpdateNeighbour(self, notification): neighbour, record = notification.data.neighbour, notification.data.record now = datetime.now().replace(microsecond=0) try: bonjour_neighbour = self.neighbours[neighbour] except KeyError: #show_notice('%s Discovered Bonjour neighbour: "%s (%s)" <%s>' % (now, record.name, record.host, record.uri)) self.neighbours[neighbour] = BonjourNeighbour(neighbour, record.uri, record.name, record.host) else: #show_notice('%s Updated Bonjour neighbour: "%s (%s)" <%s>' % (now, record.name, record.host, record.uri)) bonjour_neighbour.display_name = record.name bonjour_neighbour.host = record.host bonjour_neighbour.uri = record.uri def _NH_BonjourAccountDidRemoveNeighbour(self, notification): neighbour = notification.data.neighbour now = datetime.now().replace(microsecond=0) try: bonjour_neighbour = self.neighbours.pop(neighbour) except KeyError: pass else: pass #show_notice('%s Bonjour neighbour left: "%s (%s)" <%s>' % (now, bonjour_neighbour.display_name, bonjour_neighbour.host, bonjour_neighbour.uri)) def _NH_SIPEngineGotMessage(self, notification): data = notification.data call_id = data.headers.get('Call-ID', Null).body try: self.received_message_ids.remove(call_id) except KeyError: self.received_message_ids.add(call_id) else: # drop duplicate message received return content_type = data.content_type if content_type not in ('text/plain', 'text/html', 'message/cpim', 'application/im-iscomposing+xml'): return account = AccountManager().find_account(data.request_uri) is_composing = False from_header = FromHeader.new(data.from_header) identity = '%s@%s' % (str(from_header.uri.user), str(from_header.uri.host)) message_session = self.message_session(identity) parsed_payload = message_session.handle_incoming(data.from_header, content_type, data.body) if parsed_payload is None: return (content_type, content, identity, msg_id, encrypted) = parsed_payload if content_type == 'application/im-iscomposing+xml': # body must not be utf-8 decoded msg = IsComposingMessage.parse(content) state = msg.state.value refresh = msg.refresh.value if msg.refresh is not None else None content_type = msg.content_type.value if msg.content_type is not None else None last_active = msg.last_active.value if msg.last_active is not None else None sender_identity = data.from_header #show_notice('Is composing state=%s, refresh=%s, last_active=%s' % (state, refresh, last_active)) if state == 'active': if refresh is None: refresh = 120 if last_active is not None and (last_active - ISOTimestamp.now() > timedelta(seconds=refresh)): # message is old, discard it return elif state == 'idle': return is_composing = True if content_type != 'application/im-iscomposing+xml': if self.message_session_to != identity: show_notice('Message session started with %s' % identity) self.message_session_to = identity if from_header.display_name: identity = '"%s" <%s>' % (from_header.display_name, identity) if is_composing: show_notice("%s %s is composing a message" % (datetime.now().replace(microsecond=0), identity)) else: if encrypted: show_notice("%s %s wrote: %s (%s encrypted)" % (datetime.now().replace(microsecond=0), identity, content, msg_id)) else: if content.startswith('?OTR:'): show_notice("%s %s wrote a garbled message, probably encryption session must be reset using /otr command" % (datetime.now().replace(microsecond=0), identity)) else: show_notice("%s %s wrote: %s (%s)" % (datetime.now().replace(microsecond=0), identity, content, msg_id)) def _NH_SIPSessionNewIncoming(self, notification): session = notification.sender transfer_streams = [stream for stream in session.proposed_streams if stream.type == 'file-transfer' and stream.direction == 'recvonly'] # only allow sessions with 0 or 1 file transfers if transfer_streams: if len(transfer_streams) > 1: session.reject(488) return transfer_handler = IncomingTransferHandler(session, self.options.auto_answer_interval) transfer_handler.start() else: + for stream in notification.data.streams: + if stream.type in ('audio', 'chat'): + break + else: + remote_identity = str(session.remote_identity.uri) + if session.remote_identity.display_name: + remote_identity = '"%s" <%s>' % (session.remote_identity.display_name, remote_identity) + + show_notice('Session from %s rejected due to incompatible media' % remote_identity) + session.reject(415) + return + + notification_center = NotificationCenter() notification_center.add_observer(self, sender=session) call_initializer = IncomingCallInitializer(session, self.options.auto_answer_interval) call_initializer.start() def _NH_SIPSessionNewOutgoing(self, notification): session = notification.sender transfer_streams = [stream for stream in session.proposed_streams if stream.type == 'file-transfer'] if not transfer_streams: notification_center = NotificationCenter() notification_center.add_observer(self, sender=session) def _NH_SIPSessionDidFail(self, notification): notification_center = NotificationCenter() notification_center.remove_observer(self, sender=notification.sender) def _NH_SIPSessionWillStart(self, notification): notification_center = NotificationCenter() for stream in notification.sender.proposed_streams: notification_center.add_observer(self, sender=stream) def _NH_SIPSessionDidStart(self, notification): session = notification.sender self.connected_sessions.append(session) if self.active_session is not None: self.active_session.hold() self.active_session = session self.message_session_to = None self._update_prompt() if len(self.connected_sessions) > 1: # this displays the conencted sessions self._CH_sessions() if self.options.auto_hangup_interval is not None: if self.options.auto_hangup_interval == 0: session.end() else: timer = reactor.callLater(self.options.auto_hangup_interval, session.end) self.hangup_timers[id(session)] = timer def _NH_SIPSessionWillEnd(self, notification): notification_center = NotificationCenter() session = notification.sender if id(session) in self.hangup_timers: timer = self.hangup_timers[id(session)] if timer.active(): timer.cancel() del self.hangup_timers[id(session)] hangup_tone = WavePlayer(self.voice_audio_mixer, ResourcePath('sounds/hangup_tone.wav').normalized) notification_center.add_observer(self, sender=hangup_tone) self.voice_audio_bridge.add(hangup_tone) hangup_tone.start() def _NH_SIPSessionDidEnd(self, notification): notification_center = NotificationCenter() session = notification.sender notification_center.remove_observer(self, sender=session) for stream in session.streams or session.proposed_streams or []: notification_center.remove_observer(self, sender=stream) ui = UI() ui.status = None identity = str(session.remote_identity.uri) if session.remote_identity.display_name: identity = '"%s" <%s>' % (session.remote_identity.display_name, identity) if notification.data.end_reason == 'user request': show_notice('SIP session with %s ended by %s party' % (identity, notification.data.originator)) else: show_notice('SIP session with %s ended due to error: %s' % (identity, notification.data.end_reason)) if session.start_time: duration = session.end_time - session.start_time seconds = duration.seconds if duration.microseconds < 500000 else duration.seconds+1 minutes, seconds = seconds / 60, seconds % 60 hours, minutes = minutes / 60, minutes % 60 hours += duration.days*24 if not minutes and not hours: duration_text = '%d seconds' % seconds elif not hours: duration_text = '%02d:%02d' % (minutes, seconds) else: duration_text = '%02d:%02d:%02d' % (hours, minutes, seconds) else: duration_text = '0s' show_notice('Session duration was %s' % duration_text) if session in self.connected_sessions: self.connected_sessions.remove(session) if session is self.active_session: if self.connected_sessions: self.active_session = self.connected_sessions[0] self.message_session_to = None self.active_session.unhold() self.ignore_local_unhold = True identity = str(self.active_session.remote_identity.uri) if self.active_session.remote_identity.display_name: identity = '"%s" <%s>' % (self.active_session.remote_identity.display_name, identity) show_notice('Active SIP session: "%s" (%d/%d)' % (identity, self.connected_sessions.index(self.active_session)+1, len(self.connected_sessions))) else: self.active_session = None self._update_prompt() if session is self.outgoing_session: self.outgoing_session = None on_hold_streams = [stream for stream in chain(*(session.streams for session in self.connected_sessions)) if stream.on_hold] if not on_hold_streams and self.hold_tone is not None: self.hold_tone.stop() self.hold_tone = None def _NH_SIPSessionDidChangeHoldState(self, notification): session = notification.sender if notification.data.on_hold: if notification.data.originator == 'remote': if session is self.active_session: show_notice('Remote party has put the session on hold') else: identity = str(session.remote_identity.uri) if session.remote_identity.display_name: identity = '"%s" <%s>' % (session.remote_identity.display_name, identity) show_notice('%s has put the session on hold' % identity) elif not self.ignore_local_hold: if session is self.active_session: show_notice('Session was put on hold') else: identity = str(session.remote_identity.uri) if session.remote_identity.display_name: identity = '"%s" <%s>' % (session.remote_identity.display_name, identity) show_notice('Session with %s was put on hold' % identity) else: self.ignore_local_hold = False if self.hold_tone is None: self.hold_tone = WavePlayer(self.voice_audio_mixer, ResourcePath('sounds/hold_tone.wav').normalized, loop_count=0, pause_time=30, volume=50) self.voice_audio_bridge.add(self.hold_tone) self.hold_tone.start() else: if notification.data.originator == 'remote': if session is self.active_session: show_notice('Remote party has taken the session out of hold') else: identity = str(session.remote_identity.uri) if session.remote_identity.display_name: identity = '"%s" <%s>' % (session.remote_identity.display_name, identity) show_notice('%s has taken the session out of hold' % identity) elif not self.ignore_local_unhold: if session is self.active_session: show_notice('Session was taken out of hold') else: identity = str(session.remote_identity.uri) if session.remote_identity.display_name: identity = '"%s" <%s>' % (session.remote_identity.display_name, identity) show_notice('Session with %s was taken out of hold' % identity) else: self.ignore_local_unhold = False on_hold_streams = [stream for stream in chain(*(session.streams for session in self.connected_sessions)) if stream.on_hold] if not on_hold_streams and self.hold_tone is not None: self.hold_tone.stop() self.hold_tone = None def _NH_SIPSessionNewProposal(self, notification): self.sessions_with_proposals.add(notification.sender) if notification.data.originator == 'remote': proposal_handler = IncomingProposalHandler(notification.sender) proposal_handler.start() def _NH_SIPSessionDidRenegotiateStreams(self, notification): notification_center = NotificationCenter() for stream in notification.data.added_streams: notification_center.add_observer(self, sender=stream) for stream in notification.data.removed_streams: notification_center.remove_observer(self, sender=stream) session = notification.sender added_streams = ', '.join(stream.type for stream in notification.data.added_streams) removed_streams = ', '.join(stream.type for stream in notification.data.removed_streams) action = 'added' if added_streams else 'removed' message = '%s party %s %s' % (notification.data.originator.capitalize(), action, added_streams or removed_streams) if session is not self.active_session: identity = str(session.remote_identity.uri) if session.remote_identity.display_name: identity = '"%s" <%s>' % (session.remote_identity.display_name, identity) message = '%s in session with %s' % (message, identity) show_notice(message) self._update_prompt() def _NH_AudioStreamGotDTMF(self, notification): notification_center = NotificationCenter() digit = notification.data.digit filename = 'sounds/dtmf_%s_tone.wav' % {'*': 'star', '#': 'pound'}.get(digit, digit) wave_player = WavePlayer(self.voice_audio_mixer, ResourcePath(filename).normalized) notification_center.add_observer(self, sender=wave_player) self.voice_audio_bridge.add(wave_player) wave_player.start() show_notice('Got DMTF %s' % notification.data.digit) def _NH_RTPStreamZRTPVerifiedStateChanged(self, notification): self._update_prompt() def _NH_RTPStreamZRTPPeerNameChanged(self, notification): self._update_prompt() def _NH_RTPStreamDidEnableEncryption(self, notification): stream = notification.sender show_notice("%s encryption activated using %s (%s)" % (stream.type.title(), stream.encryption.type, stream.encryption.cipher)) if stream.encryption.type == 'ZRTP': peer_name = stream.encryption.zrtp.peer_name if stream.encryption.zrtp.peer_name else None show_notice("ZRTP secret is %s" % stream.encryption.zrtp.sas) show_notice("ZRTP peer name is %s, use /zrtp_name command to change it" % (peer_name or 'not set')) show_notice("ZRTP peer is %s, use /zrtp_verified command to toggle it" % ('verified' if stream.encryption.zrtp.verified else 'not verified')) self._update_prompt() def _NH_RTPStreamDidChangeRTPParameters(self, notification): stream = notification.sender show_notice('Audio RTP parameters changed:') show_notice('Audio stream using "%s" codec at %sHz' % (stream.codec, stream.sample_rate)) show_notice('Audio RTP endpoints %s:%d <-> %s:%d' % (stream.local_rtp_address, stream.local_rtp_port, stream.remote_rtp_address, stream.remote_rtp_port)) if stream.encryption.active: show_notice('RTP audio stream is encrypted using %s (%s)\n' % (stream.encryption.type, stream.encryption.cipher)) def _NH_AudioStreamDidStartRecordingAudio(self, notification): show_notice('Recording audio to %s' % notification.data.filename) def _NH_AudioStreamDidStopRecordingAudio(self, notification): show_notice('Stopped recording audio to %s' % notification.data.filename) def _NH_ChatStreamSMPVerificationDidStart(self, notification): show_notice('OTR verification started', bold=False) data = notification.data session = self.active_session stream = notification.sender if data.originator == 'remote': if data.question == self.smp_verification_question: try: audio_stream = next(stream for stream in session.streams if stream.type=='audio' and stream.encryption.type=='ZRTP' and stream.encryption.active and stream.encryption.zrtp.verified) except StopIteration: stream.encryption.smp_abort() else: show_notice("OTR verification requested by remote and replied automatically using ZRTP SAS", bold=False) stream.encryption.smp_answer(audio_stream.encryption.zrtp.sas) self.smp_verifified_using_zrtp = True else: show_notice("OTR verification requested by remote, reply using /otr_answer") show_notice('OTR verification question: %s' % data.question) self._update_prompt() else: try: audio_stream = next(stream for stream in session.streams if stream.type=='audio' and stream.encryption.type=='ZRTP' and stream.encryption.active and stream.encryption.zrtp.verified) except StopIteration: pass else: stream.encryption.smp_verify(audio_stream.encryption.zrtp.sas, question=self.smp_verification_question) show_notice("OTR verification performed automatically using ZRTP SAS...", bold=False) self._update_prompt() def _NH_ChatStreamSMPVerificationDidNotStart(self, notification): pass def _NH_ChatStreamSMPVerificationDidEnd(self, notification): data = notification.data stream = notification.sender if data.status is SMPStatus.Success: show_notice("OTR verification %s" % ('succeeded' if data.same_secrets else 'failed: the secret is wrong'), bold=False) stream.encryption.verified = data.same_secrets self._update_prompt() elif data.status is SMPStatus.Interrupted: show_notice("OTR verification aborted: %s" % data.reason, bold=False) elif data.status is SMPStatus.ProtocolError: show_notice("OTR verification error: %s" % data.reason, bold=False) if data.reason == 'startup collision': self.smp_verification_tries -= 1 self.smp_verification_delay *= 2 if self.smp_verification_tries > 0: # TODO verify later pass def _NH_ChatStreamOTRError(self, notification): show_notice("Chat encryption error: %s", notification.data.error, bold=False) def _NH_ChatStreamOTRVerifiedStateChanged(self, notification): self._update_prompt() def _NH_ChatStreamOTREncryptionStateChanged(self, notification): data = notification.data stream = notification.sender if data.new_state is OTRState.Encrypted: local_fingerprint = stream.encryption.key_fingerprint.upper() remote_fingerprint = stream.encryption.peer_fingerprint.upper() show_notice("Chat encryption activated using OTR protocol", bold=False) show_notice("OTR local fingerprint %s" % local_fingerprint, bold=False) show_notice("OTR remote fingerprint %s" % remote_fingerprint, bold=False) if stream.encryption.verified: show_notice("OTR remote fingerprint has been verified", bold=False) else: show_notice("OTR remote fingerprint has not yet been verified", bold=False) elif data.new_state is OTRState.Finished: show_notice("Chat encryption deactivated", bold=False) elif data.new_state is OTRState.Plaintext: show_notice("Chat encryption deactivated", bold=False) self._update_prompt() def _NH_ChatStreamGotMessage(self, notification): if not notification.data.message.content_type.startswith("text/"): return remote_identity = notification.data.message.sender.display_name or notification.data.message.sender.uri doc = html.fromstring(notification.data.message.content) if doc.body.text is not None: doc.body.text = doc.body.text.lstrip('\n') for br in doc.xpath('.//br'): br.tail = '\n' + (br.tail or '') head = RichText('%s> ' % remote_identity, foreground='blue') ui = UI() ui.writelines([head + line for line in doc.body.text_content().splitlines()]) def _NH_DefaultAudioDeviceDidChange(self, notification): SIPApplication._NH_DefaultAudioDeviceDidChange(self, notification) if notification.data.changed_input and self.voice_audio_mixer.input_device=='system_default': show_notice('Switched default input device to: %s' % self.voice_audio_mixer.real_input_device) if notification.data.changed_output and self.voice_audio_mixer.output_device=='system_default': show_notice('Switched default output device to: %s' % self.voice_audio_mixer.real_output_device) if notification.data.changed_output and self.alert_audio_mixer.output_device=='system_default': show_notice('Switched alert device to: %s' % self.alert_audio_mixer.real_output_device) def _NH_AudioDevicesDidChange(self, notification): old_devices = set(notification.data.old_devices) new_devices = set(notification.data.new_devices) added_devices = new_devices - old_devices removed_devices = old_devices - new_devices changed_input_device = self.voice_audio_mixer.real_input_device in removed_devices changed_output_device = self.voice_audio_mixer.real_output_device in removed_devices changed_alert_device = self.alert_audio_mixer.real_output_device in removed_devices SIPApplication._NH_AudioDevicesDidChange(self, notification) if added_devices: show_notice('Added audio device(s): %s' % ', '.join(sorted(added_devices))) if removed_devices: show_notice('Removed audio device(s): %s' % ', '.join(sorted(removed_devices))) if changed_input_device: show_notice('Input device has been switched to: %s' % self.voice_audio_mixer.real_input_device) if changed_output_device: show_notice('Output device has been switched to: %s' % self.voice_audio_mixer.real_output_device) if changed_alert_device: show_notice('Alert device has been switched to: %s' % self.alert_audio_mixer.real_output_device) def _NH_WavePlayerDidEnd(self, notification): notification_center = NotificationCenter() notification_center.remove_observer(self, sender=notification.sender) def _NH_RTPStreamICENegotiationDidSucceed(self, notification): show_notice(" ") show_notice("ICE negotiation succeeded in %s" % notification.data.duration) if self.rtp_statistics: show_notice(" ") show_notice("Local ICE candidates:") for candidate in notification.data.local_candidates: show_notice(str(candidate)) show_notice(" ") show_notice("Remote ICE candidates:") for candidate in notification.data.remote_candidates: show_notice(str(candidate)) show_notice(" ") show_notice("ICE connectivity valid pairs:") for check in notification.data.valid_pairs: show_notice(str(check)) show_notice(" ") def _NH_RTPStreamICENegotiationDidFail(self, notification): show_notice("\n") show_notice("ICE negotiation failed: %s" % notification.data.reason) # command handlers # def _CH_call(self, target): if self.outgoing_session is not None: show_notice('Please cancel any outgoing sessions before makeing any new ones') return call_initializer = OutgoingCallInitializer(self.account, target, audio=True, chat=True) call_initializer.start() def _CH_audio(self, target, chat_option=None): if chat_option and chat_option != '+chat': raise TypeError() if self.outgoing_session is not None: show_notice('Please cancel any outgoing sessions before makeing any new ones') return call_initializer = OutgoingCallInitializer(self.account, target, audio=True, chat=chat_option=='+chat') call_initializer.start() def _CH_message(self, target=None): if not target: show_notice('Usage: /message user@domain') try: SIPURI.parse('sip:%s' % target) if self.message_session_to != target: message_session = self.message_session(target) self.message_session_to = target except SIPCoreError: show_notice('Invalid SIP URI %s' % target) def _CH_chat(self, target, audio_option=None): if audio_option and audio_option != '+audio': raise TypeError() if self.outgoing_session is not None: show_notice('Please cancel any outgoing sessions before makeing any new ones') return call_initializer = OutgoingCallInitializer(self.account, target, audio=audio_option=='+audio', chat=True) call_initializer.start() def _CH_send(self, target, filepath): if '~' in filepath: filepath = os.path.expanduser(filepath) filepath = os.path.abspath(filepath) transfer_handler = OutgoingTransferHandler(self.account, target, filepath) transfer_handler.start() def _CH_next(self): if len(self.connected_sessions) > 1: self.active_session.hold() self.active_session = self.connected_sessions[(self.connected_sessions.index(self.active_session)+1) % len(self.connected_sessions)] self.message_session_to = None self.active_session.unhold() self.ignore_local_unhold = True identity = str(self.active_session.remote_identity.uri) if self.active_session.remote_identity.display_name: identity = '"%s" <%s>' % (self.active_session.remote_identity.display_name, identity) show_notice('Active SIP session: "%s" (%d/%d)' % (identity, self.connected_sessions.index(self.active_session)+1, len(self.connected_sessions))) self._update_prompt() def _CH_prev(self): if len(self.connected_sessions) > 1: self.active_session.hold() self.active_session = self.connected_sessions[self.connected_sessions.index(self.active_session)-1] self.message_session_to = None self.active_session.unhold() self.ignore_local_unhold = True identity = str(self.active_session.remote_identity.uri) if self.active_session.remote_identity.display_name: identity = '"%s" <%s>' % (self.active_session.remote_identity.display_name, identity) show_notice('Active SIP session: "%s" (%d/%d)' % (identity, self.connected_sessions.index(self.active_session)+1, len(self.connected_sessions))) self._update_prompt() def _CH_sessions(self): if self.connected_sessions: lines = ['Connected sessions:'] for session in self.connected_sessions: identity = str(session.remote_identity.uri) if session.remote_identity.display_name: identity = '"%s" <%s>' % (session.remote_identity.display_name, identity) lines.append(' SIP session with %s (%d/%d) - %s' % (identity, self.connected_sessions.index(session)+1, len(self.connected_sessions), 'active' if session is self.active_session else 'on hold')) if len(self.connected_sessions) > 1: lines.append('Use the /next and /prev commands to switch the active session') show_notice(lines) else: show_notice('There are no connected sessions') def _CH_neighbours(self): if not isinstance(self.account, BonjourAccount): show_notice('This command is only available if using the Bonjour account') return lines = ['Bonjour neighbours:'] for key, neighbour in self.neighbours.items(): lines.append(' "%s (%s)" <%s>' % (neighbour.display_name, neighbour.host, neighbour.uri)) show_notice(lines) def _CH_trace(self, *types): if not types: lines = [] lines.append('SIP tracing to console is now %s' % ('active' if self.logger.sip_to_stdout else 'inactive')) lines.append('MSRP tracing to console is now %s' % ('active' if self.logger.msrp_to_stdout else 'inactive')) lines.append('PJSIP tracing to console is now %s' % ('active' if self.logger.pjsip_to_stdout else 'inactive')) lines.append('Notification tracing to console is now %s' % ('active' if self.logger.notifications_to_stdout else 'inactive')) show_notice(lines) return add_types = [type[1:] for type in types if type[0] == '+'] remove_types = [type[1:] for type in types if type[0] == '-'] toggle_types = [type for type in types if type[0] not in ('+', '-')] settings = SIPSimpleSettings() if 'sip' in add_types or ('sip' in toggle_types and not self.logger.sip_to_stdout): self.logger.sip_to_stdout = True settings.logs.trace_sip = True show_notice('SIP tracing to console is now activated') elif 'sip' in remove_types or ('sip' in toggle_types and self.logger.sip_to_stdout): self.logger.sip_to_stdout = False settings.logs.trace_sip = False show_notice('SIP tracing to console is now deactivated') if 'msrp' in add_types or ('msrp' in toggle_types and not self.logger.msrp_to_stdout): self.logger.msrp_to_stdout = True settings.logs.trace_msrp = True show_notice('MSRP tracing to console is now activated') elif 'msrp' in remove_types or ('msrp' in toggle_types and self.logger.msrp_to_stdout): self.logger.msrp_to_stdout = False settings.logs.trace_msrp = False show_notice('MSRP tracing to console is now deactivated') if 'pjsip' in add_types or ('pjsip' in toggle_types and not self.logger.pjsip_to_stdout): self.logger.pjsip_to_stdout = True settings.logs.trace_pjsip = True show_notice('PJSIP tracing to console is now activated') elif 'pjsip' in remove_types or ('pjsip' in toggle_types and self.logger.pjsip_to_stdout): self.logger.pjsip_to_stdout = False settings.logs.trace_pjsip = False show_notice('PJSIP tracing to console is now deactivated') if 'notifications' in add_types or ('notifications' in toggle_types and not self.logger.notifications_to_stdout): self.logger.notifications_to_stdout = True settings.logs.trace_notifications = True show_notice('Notification tracing to console is now activated') elif 'notifications' in remove_types or ('notifications' in toggle_types and self.logger.notifications_to_stdout): self.logger.notifications_to_stdout = False settings.logs.trace_notifications = False show_notice('Notification tracing to console is now deactivated') settings.save() def _CH_rtp(self, state='toggle'): if state == 'toggle': new_state = self.rtp_statistics is None elif state == 'on': new_state = True elif state == 'off': new_state = False else: raise TypeError() if (self.rtp_statistics and new_state) or (not self.rtp_statistics and not new_state): return if new_state: self.rtp_statistics = RTPStatisticsThread() self.rtp_statistics.start() show_notice('Output of RTP statistics and ICE negotiation results on console is now activated') else: self.rtp_statistics.stop() self.rtp_statistics = None show_notice('Output of RTP statistics and ICE negotiation results on console is now dectivated') def _CH_mute(self, state='toggle'): if state == 'toggle': self.voice_audio_mixer.muted = not self.voice_audio_mixer.muted elif state == 'on': self.voice_audio_mixer.muted = True elif state == 'off': self.voice_audio_mixer.muted = False show_notice('The microphone is now %s' % ('muted' if self.voice_audio_mixer.muted else 'unmuted')) def _CH_input(self, device=None): engine = Engine() settings = SIPSimpleSettings() input_devices = [None, 'system_default'] + sorted(engine.input_devices) if device is None: if self.voice_audio_mixer.input_device in input_devices: old_input_device = self.voice_audio_mixer.input_device else: old_input_device = None tail_length = settings.audio.echo_canceller.tail_length if settings.audio.echo_canceller.enabled else 0 new_input_device = input_devices[(input_devices.index(old_input_device)+1) % len(input_devices)] try: self.voice_audio_mixer.set_sound_devices(new_input_device, self.voice_audio_mixer.output_device, tail_length) except SIPCoreError as e: show_notice('Failed to set input device to %s: %s' % (new_input_device, str(e))) else: if new_input_device == 'system_default': show_notice('Input device changed to %s (system default device)' % self.voice_audio_mixer.real_input_device) else: show_notice('Input device changed to %s' % new_input_device) else: device = device.decode(sys.getfilesystemencoding()) if device == 'None': device = None elif device not in input_devices: show_notice('Unknown input device %s. Type /devices to see a list of available devices' % device) return tail_length = settings.audio.echo_canceller.tail_length if settings.audio.echo_canceller.enabled else 0 try: self.voice_audio_mixer.set_sound_devices(device, self.voice_audio_mixer.output_device, self.voice_audio_mixer.tail_length) except SIPCoreError as e: show_notice('Failed to set input device to %s: %s' % (device, str(e))) else: if device == 'system_default': show_notice('Input device changed to %s (system default device)' % self.voice_audio_mixer.real_input_device) else: show_notice('Input device changed to %s' % device) def _CH_output(self, device=None): engine = Engine() settings = SIPSimpleSettings() output_devices = [None, 'system_default'] + sorted(engine.output_devices) if device is None: if self.voice_audio_mixer.output_device in output_devices: old_output_device = self.voice_audio_mixer.output_device else: old_output_device = None tail_length = settings.audio.echo_canceller.tail_length if settings.audio.echo_canceller.enabled else 0 new_output_device = output_devices[(output_devices.index(old_output_device)+1) % len(output_devices)] try: self.voice_audio_mixer.set_sound_devices(self.voice_audio_mixer.input_device, new_output_device, tail_length) except SIPCoreError as e: show_notice('Failed to set output device to %s: %s' % (new_output_device, str(e))) else: if new_output_device == 'system_default': show_notice('Output device changed to %s (system default device)' % self.voice_audio_mixer.real_output_device) else: show_notice('Output device changed to %s' % new_output_device) else: device = device.decode(sys.getfilesystemencoding()) if device == 'None': device = None elif device not in output_devices: show_notice('Unknown output device %s. Type /devices to see a list of available devices' % device) return tail_length = settings.audio.echo_canceller.tail_length if settings.audio.echo_canceller.enabled else 0 try: self.voice_audio_mixer.set_sound_devices(self.voice_audio_mixer.input_device, device, tail_length) except SIPCoreError as e: show_notice('Failed to set output device to %s: %s' % (device, str(e))) else: if device == 'system_default': show_notice('Output device changed to %s (system default device)' % self.voice_audio_mixer.real_output_device) else: show_notice('Output device changed to %s' % device) def _CH_alert(self, device=None): engine = Engine() settings = SIPSimpleSettings() output_devices = [None, 'system_default'] + sorted(engine.output_devices) if device is None: if self.alert_audio_mixer.output_device in output_devices: old_output_device = self.alert_audio_mixer.output_device else: old_output_device = None tail_length = settings.audio.echo_canceller.tail_length if settings.audio.echo_canceller.enabled else 0 new_output_device = output_devices[(output_devices.index(old_output_device)+1) % len(output_devices)] try: self.alert_audio_mixer.set_sound_devices(self.alert_audio_mixer.input_device, new_output_device, tail_length) except SIPCoreError as e: old_output_device = new_output_device show_notice('Failed to set alert device to %s: %s' % (new_output_device, str(e))) else: if new_output_device == 'system_default': show_notice('Alert device changed to %s (system default device)' % self.alert_audio_mixer.real_output_device) else: show_notice('Alert device changed to %s' % new_output_device) else: device = device.decode(sys.getfilesystemencoding()) if device == 'None': device = None elif device not in output_devices: show_notice('Unknown output device %s. Type /devices to see a list of available devices' % device) return tail_length = settings.audio.echo_canceller.tail_length if settings.audio.echo_canceller.enabled else 0 try: self.alert_audio_mixer.set_sound_devices(self.alert_audio_mixer.input_device, device, tail_length) except SIPCoreError as e: show_notice('Failed to set alert device to %s: %s' % (device, str(e))) else: if device == 'system_default': show_notice('Alert device changed to %s (system default device)' % self.alert_audio_mixer.real_output_device) else: show_notice('Alert device changed to %s' % device) def _CH_devices(self): engine = Engine() show_notice('Available audio input devices: %s' % ', '.join(['None', 'system_default'] + sorted(engine.input_devices)), bold=False) show_notice('Available audio output devices: %s' % ', '.join(['None', 'system_default'] + sorted(engine.output_devices)), bold=False) if self.voice_audio_mixer.input_device == 'system_default': show_notice('Using audio input device: %s (system default device)' % self.voice_audio_mixer.real_input_device, bold=False) else: show_notice('Using audio input device: %s' % self.voice_audio_mixer.input_device, bold=False) if self.voice_audio_mixer.output_device == 'system_default': show_notice('Using audio output device: %s (system default device)' % self.voice_audio_mixer.real_output_device, bold=False) else: show_notice('Using audio output device: %s' % self.voice_audio_mixer.output_device, bold=False) if self.alert_audio_mixer.output_device == 'system_default': show_notice('Using audio alert device: %s (system default device)' % self.alert_audio_mixer.real_output_device, bold=False) else: show_notice('Using audio alert device: %s' % self.alert_audio_mixer.output_device, bold=False) def _CH_help(self): self._print_help() def _CH_quit(self): self.stop() def _CH_eof(self): ui = UI() if self.active_session is not None: if self.active_session in self.sessions_with_proposals: ui.status = 'Cancelling proposal...' self.active_session.cancel_proposal() else: ui.status = 'Ending SIP session...' self.active_session.end() elif self.outgoing_session is not None: ui.status = 'Cancelling SIP session...' self.outgoing_session.end() else: self.stop() def _CH_hangup(self): if self.active_session is not None: show_notice('Ending SIP session...') self.active_session.end() elif self.outgoing_session is not None: show_notice('Cancelling SIP session...') self.outgoing_session.end() else: try: message_session = next((session for session in self.message_sessions if session.target == self.message_session_to and self.account == session.account)) except StopIteration: pass else: message_session.end() try: self.message_sessions.remove(message_session) except KeyError: show_notice('Message session not found') pass @run_in_green_thread def _CH_dtmf(self, tones): if self.active_session is not None: audio_stream = next((stream for stream in self.active_session.streams if stream.type == 'audio'), None) if audio_stream is not None: notification_center = NotificationCenter() for digit in tones: filename = 'sounds/dtmf_%s_tone.wav' % {'*': 'star', '#': 'pound'}.get(digit, digit) wave_player = WavePlayer(self.voice_audio_mixer, ResourcePath(filename).normalized) notification_center.add_observer(self, sender=wave_player) audio_stream.send_dtmf(digit) if self.active_session.account.rtp.inband_dtmf: audio_stream.bridge.add(wave_player) self.voice_audio_bridge.add(wave_player) wave_player.start() api.sleep(0.3) def _CH_record(self, state='toggle'): if self.active_session is None: return audio_stream = next((stream for stream in self.active_session.streams if stream.type == 'audio'), None) if audio_stream is not None: if state == 'toggle': new_state = audio_stream.recorder is None elif state == 'on': new_state = True elif state == 'off': new_state = False else: show_notice('Illegal argument to /record. Type /help for a list of available commands.') return if new_state: settings = SIPSimpleSettings() direction = self.active_session.direction remote = "%s@%s" % (self.active_session.remote_identity.uri.user, self.active_session.remote_identity.uri.host) filename = "%s-%s-%s.wav" % (datetime.now().strftime("%Y%m%d-%H%M%S"), remote, direction) path = os.path.join(settings.audio.directory.normalized, self.active_session.account.id) audio_stream.start_recording(os.path.join(path, filename)) else: audio_stream.stop_recording() def _CH_account(self, *args): account_manager = AccountManager() if not args or args[0] == 'list': show_notice('Accounts available: %s' % ", ".join(account.id for account in account_manager.iter_accounts() if account != self.account and account.enabled)) elif args and args[0] == 'register': if not self.account.sip.register: self.registration_succeeded[self.account.id] = False self.account.sip.register = not self.account.sip.register self.account.save() elif args and args[0] == 'enroll': settings = SIPSimpleSettings() try: username = args[1].strip() password = args[2].strip() email = args[3].strip() display_name = " ".join(args[4:]) if not "@" in email: show_notice('Email address is not valid, must be user@domain') return if not display_name: show_notice('Please specify a display name') return sip_address = '%s@%s' % (username, settings.enrollment.default_domain) if account_manager.has_account(sip_address): show_notice('Account %s is already defined' % sip_address) return except IndexError: show_notice('To enroll an account you must provide: username password email display_name') return else: data = self.enroll(username, password, email, display_name) if data['error']: show_notice(data['error']) else: show_notice('Account %s created' % data['sip_address']) elif args: new_account = args[0] possible_accounts = [account for account in account_manager.iter_accounts() if new_account in account.id and account.enabled] if len(possible_accounts) > 1: show_notice('More than one account exists which matches %s: %s' % (new_account, ', '.join(sorted(account.id for account in possible_accounts))), bold=False) elif len(possible_accounts) == 0: show_notice('No enabled account which matches %s was found. Available and enabled accounts: %s' % (self.options.account, ', '.join(sorted(possible_accounts))), bold=False) elif possible_accounts[0] == self.account: show_notice('Same account selected') elif possible_accounts[0] != self.account: self.switch_account(possible_accounts[0]) def switch_account(self, account): if isinstance(self.account, Account): self.account.sip.register = False self.account.save() self.registration_succeeded[self.account.id] = False self.account = account show_notice('Switching account to %s' % self.account.id) notification_center = NotificationCenter() notification_center.add_observer(self, sender=account) if isinstance(self.account, Account): self.account.sip.register = True self.account.save() self._update_prompt() def enroll(self, username, password, email, display_name): settings = SIPSimpleSettings() tzname = datetime.now(tzlocal()).tzname() or "" post_data = {'password' : password.encode("utf8"), 'username' : username.encode("utf8"), 'email' : email.encode("utf8"), 'display_name' : display_name.encode("utf8"), 'tzinfo' : tzname } return_data = {} try: r = requests.post(settings.enrollment.url, timeout=5, data=post_data) settings = SIPSimpleSettings() show_notice("Enrollment request sent to %s" % settings.enrollment.url) if r.status_code == 200: body = r.json() if not body["success"]: return_data['error'] = "Enrollment failed: %s" % body["error_message"] else: data = defaultdict(lambda: None, body) sip_address = data['sip_address'] outbound_proxy = data['outbound_proxy'] try: account = Account(sip_address) except ValueError as e: return_data['error'] = "Local account create error: %s" % str(e) else: account.auth.password = password account.sip.always_use_my_proxy = True account.sip.register = True account.rtp.srtp_encryption = 'opportunistic' account.nat_traversal.msrp_relay = data['msrp_relay'] if data['outbound_proxy']: account.sip.outbound_proxy = data['outbound_proxy'] if data['xcap_root']: account.xcap.xcap_root = data['xcap_root'] account.xcap.enabled = True account.enabled = True account.save() account_manager = AccountManager() account_manager.default_account = account self.switch_account(account) return_data = data else: return_data['error'] = "Enrollment server error code %s" % r.status_code except Exception as e: return_data['error'] = "Enrollment exception: %s" % str(e) return return_data def _CH_otr(self): if self.active_session is None: message_session = self.message_session(self.message_session_to) if not message_session: return if message_session.encryption.active: show_notice("Message encryption will stop") message_session.encryption.stop() else: show_notice("Message encryption will start") message_session.encryption.start() return chat_stream = next((stream for stream in self.active_session.streams if stream.type == 'chat'), None) if chat_stream is None: return if chat_stream.encryption.active: show_notice("Chat encryption will stop") chat_stream.encryption.stop() else: show_notice("Chat encryption will start") chat_stream.encryption.start() def _CH_otr_secret(self, *args): secret = " ".join(args) if args else None if secret is None and self.smp_secret: show_notice("OTR secret answer is: %s" % self.smp_secret) return self.smp_secret = secret show_notice("OTR secret answer is now set to: %s" % secret) def _CH_otr_answer(self, *args): answer = " ".join(args) if args else None if self.active_session is None: message_session = self.message_session(self.message_session_to) if not message_session: show_notice("OTR functions can be used only during active chat sessions") return message_session.encryption.smp_answer(answer) chat_stream = next((stream for stream in self.active_session.streams if stream.type == 'chat'), None) if chat_stream is None: show_notice("OTR functions can be used only during active chat sessions") return if answer: chat_stream.encryption.smp_answer(answer) def _CH_otr_question(self, *args): question = " ".join(args) if args else None if self.active_session is None: message_session = self.message_session(self.message_session_to) if not message_session: show_notice("OTR functions can be used only during active chat sessions") return if question: show_notice("OTR SMP verification question will be asked: %s" % question) message_session.encryption.verified = False message_session.encryption.smp_verify(self.smp_secret, question=question) return chat_stream = next((stream for stream in self.active_session.streams if stream.type == 'chat'), None) audio_stream = next((stream for stream in self.active_session.streams if stream.type == 'audio'), None) if chat_stream is None: show_notice("OTR functions can be used only during active chat sessions") return if self.smp_secret is None: show_notice("First set the SMP secret answer using /otr_secret command") return if question: show_notice("OTR SMP verification question will be asked: %s" % question) chat_stream.encryption.verified = False chat_stream.encryption.smp_verify(self.smp_secret, question=question) def _CH_zrtp_verified(self): if self.active_session is None: show_notice("ZRTP functions can be used only during active audio sessions") return audio_stream = next((stream for stream in self.active_session.streams if stream.type == 'audio'), None) if audio_stream is None: show_notice("ZRTP functions can be used only during active audio sessions") return audio_stream.encryption.zrtp.verified = not audio_stream.encryption.zrtp.verified def _CH_zrtp_name(self, *args): if self.active_session is None: show_notice("ZRTP functions can be used only during active audio sessions") return audio_stream = next((stream for stream in self.active_session.streams if stream.type == 'audio'), None) if audio_stream is None: show_notice("ZRTP functions can be used only during active audio sessions") return peer_name = " ".join(args) if args else None audio_stream.encryption.zrtp.peer_name = peer_name def _CH_hold(self, state='toggle'): if self.active_session is not None: if state == 'toggle': new_state = not self.active_session.on_hold elif state == 'on': new_state = True elif state == 'off': new_state = False else: show_notice('Illegal argument to /hold. Type /help for a list of available commands.') return if new_state: self.active_session.hold() else: self.active_session.unhold() def _CH_add(self, stream_name): if self.active_session is None: show_notice('There is no active session') return if stream_name in (stream.type for stream in self.active_session.streams): show_notice('The active session already has a %s stream' % stream_name) return proposal_handler = OutgoingProposalHandler(self.active_session, **{stream_name: True}) try: proposal_handler.start() except IllegalStateError: show_notice('Cannot add a stream while another transaction is in progress') def _CH_remove(self, stream_name): if self.active_session is None: show_notice('There is no active session') return try: stream = next((stream for stream in self.active_session.streams if stream.type==stream_name)) except StopIteration: show_notice('The current active session does not have any %s streams' % stream_name) else: try: self.active_session.remove_stream(stream) except IllegalStateError: show_notice('Cannot remove a stream while another transaction is in progress') def _CH_add_participant(self, uri): if self.active_session is None: show_notice('There is no active session') return if re.match('^(sip:|sips:)', uri) is None: uri = 'sip:%s' % uri try: uri = SIPURI.parse(uri) except SIPCoreError: show_notice('Invalid SIP URI') else: self.active_session.conference.add_participant(uri) def _CH_remove_participant(self, uri): if self.active_session is None: show_notice('There is no active session') return if re.match('^(sip:|sips:)', uri) is None: uri = 'sip:%s' % uri try: uri = SIPURI.parse(uri) except SIPCoreError: show_notice('Invalid SIP URI') else: self.active_session.conference.remove_participant(uri) def _CH_transfer(self, uri): if self.active_session is None: show_notice('There is no active session') return if re.match('^(sip:|sips:)', uri) is None: uri = 'sip:%s' % uri try: uri = SIPURI.parse(uri) except SIPCoreError: show_notice('Invalid SIP URI') else: self.active_session.transfer(uri) def _CH_nickname(self, nickname): if self.active_session is not None: try: chat_stream = next((stream for stream in self.active_session.streams if stream.type=='chat')) except StopIteration: return try: chat_stream.set_local_nickname(nickname) except Exception as e: show_notice('Error setting nickname: %s' % e) # private methods # def _print_help(self): lines = [] lines.append('General commands:') lines.append(' /account [list|register|user@domain|enroll user password email display_name]: account management') lines.append(' /call {user[@domain]}: call the specified user using audio and chat') lines.append(' /audio {user[@domain]} [+chat]: call the specified user using audio and possibly chat') lines.append(' /chat {user[@domain]} [+audio]: call the specified user using chat and possibly audio') lines.append(' /message {user[@domain]}: start a message session') lines.append(' /send {user[@domain]} {file}: initiate a file transfer with the specified user') lines.append(' /next: select the next connected session') lines.append(' /prev: select the previous connected session') lines.append(' /sessions: show the list of connected sessions') if isinstance(self.account, BonjourAccount): lines.append(' /neighbours: show the list of bonjour neighbours') lines.append(' /trace [[+|-]sip] [[+|-]msrp] [[+|-]pjsip] [[+|-]notifications]: toggle/set tracing on the console (ctrl-x s | ctrl-x m | ctrl-x j | ctrl-x n)') lines.append(' /rtp [on|off]: toggle/set printing RTP statistics and ICE negotiation results on the console (ctrl-x p)') lines.append(' /mute [on|off]: mute the microphone (ctrl-x u)') lines.append(' /input [device]: change audio input device (ctrl-x i)') lines.append(' /output [device]: change audio output device (ctrl-x o)') lines.append(' /alert [device]: change audio alert device (ctrl-x a)') lines.append(' /quit: quit the program (ctrl-x q)') lines.append(' /help: display this help message (ctrl-x ?)') lines.append('In call commands:') lines.append(' /hangup: hang-up the active session (ctrl-x h)') lines.append(' /dtmf {0-9|*|#|A-D}...: send DTMF tones (ctrl-x 0-9|*|#|A-D)') lines.append(' /record [on|off]: toggle/set audio recording (ctrl-x r)') lines.append(' /hold [on|off]: hold/unhold (ctrl-x SPACE)') lines.append(' /zrtp_verified: toggle verified flag for ZRTP peer (both parties must do it)') lines.append(' /zrtp_name name: set name for ZRTP peer') lines.append(' /otr: toggle OTR encryption for the chat stream') lines.append(' /otr_answer answer: Answer OTR verification question using SMP protocol') lines.append(' /otr_secret [secret]: show or set OTR secret') lines.append(' /otr_question question: Ask OTR verification question using SMP protocol') lines.append(' /add {chat|audio}: add a stream to the current session') lines.append(' /remove {chat|audio}: remove a stream from the current session') lines.append(' /add_participant {user@domain}: add the specified user to the conference') lines.append(' /remove_participant {user@domain}: remove the specified user from the conference') lines.append(' /transfer {user@domain}: transfer (using blind transfer) callee to the specified destination') lines.append(' /nickname nick: set the user nickname whithin a conference') show_notice(lines, bold=False) def _update_prompt(self): return ui = UI() session = self.active_session if session is None: ui.prompt = Prompt('%s@%s' % (self.account.id.username, self.account.id.domain), foreground='default') else: info = [] identity = '%s@%s' % (session.remote_identity.uri.user, session.remote_identity.uri.host) if session.remote_identity.display_name: identity = '%s (%s)' % (session.remote_identity.display_name, identity) streams = '/'.join(stream.type.capitalize() for stream in session.streams) chat_stream = next((stream for stream in session.streams if stream.type == 'chat'), None) audio_stream = next((stream for stream in session.streams if stream.type == 'audio'), None) if chat_stream and chat_stream.encryption.active: info.append('Chat encrypted verified' if chat_stream.encryption.verified else 'Chat encrypted NOT verified') if audio_stream and audio_stream.encryption.active: if audio_stream.encryption.zrtp: if audio_stream.encryption.zrtp.verified: if audio_stream.encryption.zrtp.peer_name: info.append('Audio encrypted verified with %s' % audio_stream.encryption.zrtp.peer_name) else: info.append('Audio encrypted verified') else: info.append('Audio encrypted NOT verified') else: info.append('Audio encrypted NOT verified') if not info: info = ['not encrypted'] ui.prompt = Prompt('%s to %s (%s)' % (streams, identity, ", ".join(info)), foreground='darkred') def parse_handle_call_option(option, opt_str, value, parser, name): try: value = parser.rargs[0] except IndexError: value = 0 else: if value == '' or value[0] == '-': value = 0 else: try: value = int(value) except ValueError: value = 0 else: del parser.rargs[0] setattr(parser.values, name, value) if __name__ == '__main__': description = '%prog is a command-line client for handling multiple audio, chat and file-transfer sessions' usage = '%prog [options] [user@domain]' parser = OptionParser(usage=usage, description=description) parser.print_usage = parser.print_help parser.add_option('-a', '--account', type='string', dest='account', help='The account name to use for any outgoing traffic. If not supplied, the default account will be used.', metavar='NAME') parser.add_option('-c', '--config-directory', type='string', dest='config_directory', help='The configuration directory to use. This overrides the default location.') parser.add_option('-s', '--trace-sip', action='store_true', dest='trace_sip', default=False, help='Dump the raw contents of incoming and outgoing SIP messages.') parser.add_option('-m', '--trace-msrp', action='store_true', dest='trace_msrp', default=False, help='Dump msrp logging information and the raw contents of incoming and outgoing MSRP messages.') parser.add_option('-j', '--trace-pjsip', action='store_true', dest='trace_pjsip', default=False, help='Print PJSIP logging output.') parser.add_option('-n', '--trace-notifications', action='store_true', dest='trace_notifications', default=False, help='Print all notifications (disabled by default).') parser.add_option('-S', '--disable-sound', action='store_true', dest='disable_sound', default=False, help='Disables initializing the sound card.') parser.set_default('auto_answer_interval', None) parser.add_option('--auto-answer', action='callback', callback=parse_handle_call_option, callback_args=('auto_answer_interval',), help='Interval after which to answer an incoming session (disabled by default). If the option is specified but the interval is not, it defaults to 0 (accept the session as soon as it starts ringing).', metavar='[INTERVAL]') parser.set_default('auto_hangup_interval', None) parser.add_option('--auto-hangup', action='callback', callback=parse_handle_call_option, callback_args=('auto_hangup_interval',), help='Interval after which to hang up an established session (disabled by default). If the option is specified but the interval is not, it defaults to 0 (hangup the session as soon as it connects).', metavar='[INTERVAL]') options, args = parser.parse_args() target = args[0] if args else None application = SIPSessionApplication() application.start(target, options) signal.signal(signal.SIGINT, signal.SIG_DFL) application.stopped_event.wait() sleep(0.1) diff --git a/sipclient/ui.py b/sipclient/ui.py index 06f2dcd..5bdba48 100644 --- a/sipclient/ui.py +++ b/sipclient/ui.py @@ -1,685 +1,685 @@ """ Implements a library that can be used for buildina a fully featured SIP User Agent working in a terminal text window. See sip_session.py script for an actual implementation. """ __all__ = ["RichText", "CompoundRichText", "Prompt", "Question", "UI"] import atexit import pickle as pickle import fcntl import os import re import select import signal import struct import sys import termios from collections import deque from threading import RLock, Thread from application.python.decorator import decorator, preserve_signature from application.python.queue import EventQueue from application.python.types import Singleton from application.system import openfile from application.notification import NotificationCenter, NotificationData @decorator def run_in_ui_thread(func): @preserve_signature(func) def wrapper(self, *args, **kwargs): self.event_queue.put((func, self, args, kwargs)) return wrapper class RichText(object): colors = {'default': 9, 'red': 61, 'darkred': 1, 'lightgreen': 62, 'darkgreen': 2, 'yellow': 63, 'darkyellow': 3, 'cyan': 66, 'lightblue': 6, 'blue': 64, 'darkblue': 4, 'magenta': 65, 'purple': 5, 'white': 67, 'lightgrey': 7, 'darkgrey': 60, 'black': 0} def __init__(self, text, foreground='default', background='default', bold=False, underline=False, blink=False): self.text = text self.foreground = foreground self.background = background self.bold = bold self.underline = underline self.blink = blink def __str__(self): if isinstance(self.text, str): text = self.text.encode(sys.getfilesystemencoding()) else: text = self.text return '\x1b[%sm%s\x1b[0m' % (self.mode, text) def __len__(self): return len(self.text) def __getitem__(self, index): return self.__class__(self.text.__getitem__(index), foreground=self.foreground, background=self.background, bold=self.bold, underline=self.underline, blink=self.blink) def __add__(self, other): return CompoundRichText([self, other]) @property def mode(self): attributes = [str(30+self.colors.get(self.foreground)), str(40+self.colors.get(self.background)), '1' if self.bold else '22', '4' if self.underline else '24', '5' if self.blink else '25'] return ';'.join(attributes) class CompoundRichText(RichText): def __init__(self, text_list): self.text_list = text_list def __str__(self): txt = '' for text in self.text_list: txt += str(text) return txt def __len__(self): return sum(len(text) for text in self.text_list) def __add__(self, other): if isinstance(other, CompoundRichText): return CompoundRichText(self.text_list+other.text_list) else: return CompoundRichText(self.text_list+[other]) def __iadd__(self, other): self.text_list.append(other) return self class Prompt(RichText): def __str__(self): if isinstance(self.text, str): text = self.text.encode(sys.getfilesystemencoding()) else: text = self.text return '\x1b[%sm%s>\x1b[0m ' % (self.mode, text) def __len__(self): return len(self.text)+2 class Question(RichText): def __init__(self, text, answers, *args, **kwargs): RichText.__init__(self, text, *args, **kwargs) self.answers = answers def __getitem__(self, index): return self.__class__(self.text.__getitem__(index), answers=self.answers, foreground=self.foreground, background=self.background, bold=self.bold, underline=self.underline, blink=self.blink) class Input(object): def __init__(self): self.history_file = None self.lines = [] self.current_line_index = None self.cursor_position = None def _get_current_line(self): if self.current_line_index is None: raise RuntimeError('no current line available') return self.lines[self.current_line_index] def _set_current_line(self, value): if value is None: self.current_line_index = None return if self.current_line_index is None: raise RuntimeError('no current line available') self.lines[self.current_line_index] = value current_line = property(_get_current_line, _set_current_line) del _get_current_line, _set_current_line def add_history(self, history_file): self.history_file = history_file try: self.lines = pickle.load(open(history_file, 'rb')) except (IOError, TypeError, EOFError): self.lines = [] def save_history(self): with openfile(self.history_file, 'wb', permissions=0o600) as history_file: pickle.dump(self.lines, history_file) def add_line(self, text=''): self.lines.append(text) self.current_line_index = len(self.lines)-1 self.cursor_position = len(text) def copy_current_line(self): if self.current_line_index != len(self.lines) - 1: self.lines[-1] = self.current_line def line_up(self, count=1): if self.current_line_index is None: raise RuntimeError('no current line available') if self.current_line_index - count < 0: raise KeyError('too many lines up') self.current_line_index -= count self.cursor_position = len(self.current_line) def line_down(self, count=1): if self.current_line_index is None: raise RuntimeError('no current line available') if self.current_line_index + count >= len(self.lines): raise KeyError('too many lines down') self.current_line_index += count self.cursor_position = len(self.current_line) class TTYFileWrapper(object): def __init__(self, file): if not file.isatty(): raise RuntimeError('TTYFileWrapper is supposed to wrap a tty file') self.file = file self.buffer = '' self.lock = RLock() # no-ops / simple ops def close(self): pass def fileno(self): return self.file.fileno() def isatty(self): return True def tell(self): return self.file.tell() def write(self, str): with self.lock: if not str: return ui = UI() if ui.stopping: self.file.write(str) else: lines = re.split(r'\r\n|\r|\n', str) lines[0] = self.buffer + lines[0] self.buffer = lines[-1] ui.writelines(lines[:-1]) def writelines(self, sequence): with self.lock: for text in sequence: self.write(text) def flush(self): with self.lock: if self.buffer: ui = UI() ui.writelines([self.buffer]) self.buffer = '' def send_to_file(self): if self.buffer: self.file.write(self.buffer) class UI(Thread, metaclass=Singleton): control_chars = {'\x01': 'home', '\x04': 'eof', '\x05': 'end', '\x0a': 'newline', '\x0d': 'newline', '\x1b[A': 'cursorup', '\x1b[B': 'cursordown', '\x1b[C': 'cursorright', '\x1b[D': 'cursorleft', '\x1b[F': 'end', '\x1b[H': 'home', '\x7f': 'delete'} # public functions # def __init__(self, history_file=None): Thread.__init__(self, target=self._run, name='UI-Thread') self.setDaemon(True) self.__dict__['prompt'] = Prompt('') self.__dict__['status'] = None self.command_sequence = '/' self.application_control_char = '\x18' # ctrl-X self.application_control_bindings = {} self.display_commands = True self.display_text = True self.cursor_x = None self.cursor_y = None self.displaying_question = False self.input = Input() self.input.add_history(history_file) self.last_window_size = None self.prompt_y = None self.questions = deque() self.stopping = False self.lock = RLock() self.event_queue = EventQueue(handler=lambda function_self_args_kwargs: function_self_args_kwargs[0](function_self_args_kwargs[1], *function_self_args_kwargs[2], **function_self_args_kwargs[3]), name='UI operation handling') def start(self, prompt='', command_sequence='/', control_char='\x18', control_bindings={}, display_commands=True, display_text=True): with self.lock: if self.isAlive(): raise RuntimeError('UI already active') if not sys.stdin.isatty(): raise RuntimeError('UI cannot be used on a non-TTY') if not sys.stdout.isatty(): raise RuntimeError('UI cannot be used on a non-TTY') stdin_fd = sys.stdin.fileno() self.command_sequence = command_sequence self.application_control_char = control_char self.application_control_bindings = control_bindings self.display_commands = display_commands self.display_text = display_text # wrap sys.stdout sys.stdout = TTYFileWrapper(sys.stdout) # and possibly sys.stderr if sys.stderr.isatty(): sys.stderr = TTYFileWrapper(sys.stderr) # change input to character-mode old_settings = termios.tcgetattr(stdin_fd) new_settings = termios.tcgetattr(stdin_fd) new_settings[3] &= ~termios.ECHO & ~termios.ICANON new_settings[6][termios.VMIN] = b'\000' termios.tcsetattr(stdin_fd, termios.TCSADRAIN, new_settings) atexit.register(termios.tcsetattr, stdin_fd, termios.TCSADRAIN, old_settings) # find out cursor position in terminal self._raw_write('\x1b[6n') if select.select([stdin_fd], [], [], None)[0]: line, col = os.read(stdin_fd, 10).decode()[2:-1].split(';') line = int(line) col = int(col) # scroll down the terminal until everything goes up self._scroll_up(line-1) # move the cursor to the upper left side corner self._raw_write('\x1b[H') self.cursor_x = 1 self.cursor_y = 1 # display the prompt self.prompt_y = 1 self.input.add_line() self._update_prompt() # make sure we know when the window gets resized self.last_window_size = self.window_size signal.signal(signal.SIGWINCH, lambda signum, frame: self._window_resized()) self.event_queue.start() Thread.start(self) # this will trigger the update of the prompt self.prompt = prompt @run_in_ui_thread def stop(self): with self.lock: self.stopping = True self.status = None sys.stdout.send_to_file() if isinstance(sys.stderr, TTYFileWrapper): sys.stderr.send_to_file() self._raw_write('\n\x1b[2K') self.input.save_history() def write(self, text): self.writelines([text]) @run_in_ui_thread def writelines(self, text_lines): with self.lock: if not text_lines: return # go to beginning of prompt line self._raw_write('\x1b[%d;%dH' % (self.prompt_y, 1)) # erase everything beneath it self._raw_write('\x1b[0J') # start writing lines window_size = self.window_size for text in text_lines: # write the line self._raw_write('%s\n' % text) # calculate the number of lines the text will produce text_lines = (len(text)-1)/window_size.x + 1 # calculate how much the text will automatically scroll the window window_height = struct.unpack('HHHH', fcntl.ioctl(sys.stdout.fileno(), termios.TIOCGWINSZ, struct.pack('HHHH', 0, 0, 0, 0)))[0] auto_scroll_amount = max(0, (self.prompt_y+text_lines-1) - (window_height-1)) # calculate the new position of the prompt self.prompt_y += text_lines - auto_scroll_amount # we might need to scroll up to make the prompt position visible again scroll_up = self.prompt_y - window_height if scroll_up > 0: self.prompt_y -= scroll_up self._scroll_up(scroll_up) # redraw the prompt self._update_prompt() @run_in_ui_thread def add_question(self, question): with self.lock: self.questions.append(question) if len(self.questions) == 1: self._update_prompt() @run_in_ui_thread def remove_question(self, question): with self.lock: first_question = (question == self.questions[0]) self.questions.remove(question) if not self.questions or first_question: self.displaying_question = False self._update_prompt() # properties # @property def window_size(self): class WindowSize(tuple): def __init__(ws_self, xxx_todo_changeme): (y, x) = xxx_todo_changeme ws_self.x = x ws_self.y = y if self.status is None else y-1 return WindowSize(struct.unpack('HHHH', fcntl.ioctl(sys.stdout.fileno(), termios.TIOCGWINSZ, struct.pack('HHHH', 0, 0, 0, 0)))[:2]) def _get_prompt(self): return self.__dict__['prompt'] @run_in_ui_thread def _set_prompt(self, value): with self.lock: if not isinstance(value, Prompt): value = Prompt(value) self.__dict__['prompt'] = value self._update_prompt() prompt = property(_get_prompt, _set_prompt) del _get_prompt, _set_prompt def _get_status(self): return self.__dict__['status'] @run_in_ui_thread def _set_status(self, status): with self.lock: if isinstance(status, str): status = status.encode(sys.getfilesystemencoding()) try: old_status = self.__dict__['status'] except KeyError: self.__dict__['status'] = status else: self.__dict__['status'] = status if old_status is not None and status is None: status_y, window_length = struct.unpack('HHHH', fcntl.ioctl(sys.stdout.fileno(), termios.TIOCGWINSZ, struct.pack('HHHH', 0, 0, 0, 0)))[:2] # save current cursor position self._raw_write('\x1b[s') # goto line status_y self._raw_write('\x1b[%d;%dH' % (status_y, 1)) # erase it self._raw_write('\x1b[2K') # restore the cursor position self._raw_write('\x1b[u') else: self._update_prompt() status = property(_get_status, _set_status) del _get_status, _set_status # private functions # def _run(self): wait_control_char = False while True: stdin_fd = sys.__stdin__.fileno() if select.select([stdin_fd], [], [], None)[0]: - chars = list(os.read(stdin_fd, 4096).decode('ascii')) + chars = list(os.read(stdin_fd, 4096).decode()) while chars: if self.stopping: return with self.lock: char = chars.pop(0) if ord(char) < 32 or ord(char) == 127: if char == '\x1b': if chars and chars[0] == '[': char += chars.pop(0) while chars and not chars[0].isalpha(): char += chars.pop(0) if chars: char += chars.pop(0) if self.questions: pass elif char == self.application_control_char: wait_control_char = not wait_control_char elif not self.questions: wait_control_char = False handler = getattr(self, '_CH_%s' % self.control_chars.get(char, 'default')) handler(char) elif wait_control_char: wait_control_char = False if char in self.application_control_bindings: notification_center = NotificationCenter() words = [word for word in re.split(r'\s+', self.application_control_bindings[char]) if word] if len(words) > 0: notification_center.post_notification('UIInputGotCommand', sender=self, data=NotificationData(command=words[0], args=words[1:])) elif self.questions: question = self.questions[0] if char in question.answers: self._raw_write(char) self.displaying_question = False self.remove_question(question) notification_center = NotificationCenter() notification_center.post_notification('UIQuestionGotAnswer', sender=question, data=NotificationData(answer=char)) else: # insert char in input.current_line at input.cursor_position and advance cursor self.input.current_line = self.input.current_line[:self.input.cursor_position] + char + self.input.current_line[self.input.cursor_position:] self.input.cursor_position += 1 self._update_prompt() def _raw_write(self, text): sys.__stdout__.write(str(text)) sys.__stdout__.flush() def _window_resized(self): pass def _update_prompt(self): # The (X-1)/window_size.x+1 are because the position in the terminal is # a 1-based index; the + 1 when calculating the indexes are because the # positions we keep are 0-based. if self.displaying_question or self.stopping: return if self.questions: window_size = self.window_size question = self.questions[0] # we also want to leave a space after the question and we need an # extra position for the cursor text_len = len(question) + 2 # calculate how much we need to scroll up text_lines = (text_len-1)/window_size.x + 1 scroll_up = text_lines - (window_size.y - self.prompt_y + 1) if scroll_up > 0: self._scroll_up(scroll_up) self.prompt_y -= scroll_up # go to the position where the question will be rendered self._raw_write('\x1b[%d;%dH' % (self.prompt_y, 1)) # erase everything beneath it self._raw_write('\x1b[0J') # might need to draw the status self._draw_status() # draw the question self._raw_write(question) # and a space self._raw_write(' ') # calculate the cursor position self.cursor_y = (text_len-1)/window_size.x + self.prompt_y # no need to add 1 since we had to subtract 1 self.cursor_x = (text_len-1)%window_size.x + 1 # the new prompt will now be just under the question self.prompt_y += text_lines self.displaying_question = True else: window_size = self.window_size text_len = len(self.prompt) + len(self.input.current_line) # we also need a position for the cursor if it's at the end of the line if self.input.cursor_position == len(self.input.current_line): text_len += 1 # calculate how much we need to scroll up text_lines = (text_len-1)/window_size.x + 1 scroll_up = text_lines - (window_size.y - self.prompt_y + 1) if scroll_up > 0: self._scroll_up(scroll_up) self.prompt_y -= scroll_up # goto the position of the new prompt self._raw_write('\x1b[%d;%dH' % (self.prompt_y, 1)) # erase everything beneath it self._raw_write('\x1b[0J') # might need to draw the status self._draw_status() # force going to the new prompt position self._raw_write('\x1b[%d;%dH' % (self.prompt_y, 1)) # draw the prompt and the text self._raw_write(self.prompt) self._raw_write(self.input.current_line) # move the cursor to it's correct position cursor_position = len(self.prompt) + self.input.cursor_position + 1 self.cursor_y = (cursor_position-1)/window_size.x + self.prompt_y # no need to add 1 since we had to subtract 1 self.cursor_x = (cursor_position-1)%window_size.x + 1 self._raw_write('\x1b[%d;%dH' % (self.cursor_y, self.cursor_x)) def _draw_status(self): status = self.status if status is not None: status_y, window_length = struct.unpack('HHHH', fcntl.ioctl(sys.stdout.fileno(), termios.TIOCGWINSZ, struct.pack('HHHH', 0, 0, 0, 0)))[:2] # save current cursor position self._raw_write('\x1b[s') # goto line status_y self._raw_write('\x1b[%d;%dH' % (status_y, 1)) # erase it self._raw_write('\x1b[2K') # display the status if len(status) > window_length: status = status[:window_length] self._raw_write(status) # restore the cursor position self._raw_write('\x1b[u') def _scroll_up(self, lines): window_height = struct.unpack('HHHH', fcntl.ioctl(sys.stdout.fileno(), termios.TIOCGWINSZ, struct.pack('HHHH', 0, 0, 0, 0)))[0] self._raw_write('\x1b[s\x1b[%d;1H' % int(window_height) + '\x1bD' * int(lines) + '\x1b[u') # control character handlers # def _CH_default(self, char): #print 'Got control char %s' % ''.join('%02X' % ord(c) for c in char) pass def _CH_home(self, char): if self.input.cursor_position > 0: self.input.cursor_position = 0 self._update_prompt() def _CH_eof(self, char): notification_center = NotificationCenter() notification_center.post_notification('UIInputGotCommand', sender=self, data=NotificationData(command='eof', args=[])) def _CH_end(self, char): if self.input.cursor_position < len(self.input.current_line): self.input.cursor_position = len(self.input.current_line) self._update_prompt() def _CH_newline(self, char): if self.input.current_line: # copy the current line to the last line self.input.copy_current_line() window_size = self.window_size # calculate the length of the line just entered text_len = len(self.prompt) + len(self.input.current_line) text_lines = (text_len-1)/window_size.x + 1 # save the current line and add a new input line current_line = self.input.current_line self.input.add_line() # see if it's a command or plain text notification_center = NotificationCenter() if current_line.startswith(self.command_sequence): # calculate the new position of the prompt if self.display_commands: self.prompt_y += text_lines # we need to scroll if the new prompt position is below the window margin, otherwise # some text might go over it scroll_up = self.prompt_y - window_size.y if scroll_up > 0: self.prompt_y -= scroll_up self._scroll_up(scroll_up) # send a notification about the new input words = [word for word in re.split(r'\s+', current_line[len(self.command_sequence):]) if word] if len(words) > 0: notification_center.post_notification('UIInputGotCommand', sender=self, data=NotificationData(command=words[0], args=words[1:])) else: # calculate the new position of the prompt if self.display_text: self.prompt_y += text_lines # we need to scroll if the new prompt position is below the window margin, otherwise # some text might go over it scroll_up = self.prompt_y - window_size.y if scroll_up > 0: self.prompt_y -= scroll_up self._scroll_up(scroll_up) # send a notification about the new input notification_center.post_notification('UIInputGotText', sender=self, data=NotificationData(text=current_line)) # redisplay the prompt self._update_prompt() def _CH_cursorup(self, char): try: self.input.line_up() except KeyError: pass else: self._update_prompt() def _CH_cursordown(self, char): try: self.input.line_down() except KeyError: pass else: self._update_prompt() def _CH_cursorright(self, char): if self.input.cursor_position < len(self.input.current_line): self.input.cursor_position += 1 self._update_prompt() def _CH_cursorleft(self, char): if self.input.cursor_position > 0: self.input.cursor_position -= 1 self._update_prompt() def _CH_delete(self, char): # delete the character in input.current_line at input.cursor_position if self.input.cursor_position > 0: self.input.current_line = self.input.current_line[:self.input.cursor_position-1]+self.input.current_line[self.input.cursor_position:] self.input.cursor_position -= 1 self._update_prompt()