X-Git-Url: http://git.maemo.org/git/?p=theonering;a=blobdiff_plain;f=src%2Fconnection.py;h=59ffa76932a8e89e0ea8874ab5ec9466727f517a;hp=c58aa28cf262325dc06edb76a804b3fcdb22ee04;hb=afa4cdb64e451070cf87cc02f257c582fa057f53;hpb=4f7f7378a6bcd5ed4bc332659a133fcd67dfda22 diff --git a/src/connection.py b/src/connection.py index c58aa28..59ffa76 100644 --- a/src/connection.py +++ b/src/connection.py @@ -4,84 +4,118 @@ import logging import telepathy -try: - import conic as _conic - conic = _conic -except (ImportError, OSError): - conic = None - import constants import tp -import util.coroutines as coroutines -import util.misc as util_misc -import gtk_toolbox +import util.misc as misc_utils import gvoice import handle -import requests -import contacts import aliasing -import simple_presence -import presence +import avatars import capabilities +import contacts +import presence +import requests +import simple_presence +import autogv import channel_manager -_moduleLogger = logging.getLogger("connection") +_moduleLogger = logging.getLogger(__name__) + + +class TheOneRingOptions(object): + + useGVContacts = True + + assert gvoice.session.Session._DEFAULTS["contacts"][1] == "hours" + contactsPollPeriodInHours = gvoice.session.Session._DEFAULTS["contacts"][0] + + assert gvoice.session.Session._DEFAULTS["voicemail"][1] == "minutes" + voicemailPollPeriodInMinutes = gvoice.session.Session._DEFAULTS["voicemail"][0] + + assert gvoice.session.Session._DEFAULTS["texts"][1] == "minutes" + textsPollPeriodInMinutes = gvoice.session.Session._DEFAULTS["texts"][0] + + def __init__(self, parameters = None): + if parameters is None: + return + self.useGVContacts = parameters["use-gv-contacts"] + self.contactsPollPeriodInHours = parameters['contacts-poll-period-in-hours'] + self.voicemailPollPeriodInMinutes = parameters['voicemail-poll-period-in-minutes'] + self.textsPollPeriodInMinutes = parameters['texts-poll-period-in-minutes'] class TheOneRingConnection( tp.Connection, - requests.RequestsMixin, - contacts.ContactsMixin, aliasing.AliasingMixin, - simple_presence.SimplePresenceMixin, - presence.PresenceMixin, + avatars.AvatarsMixin, capabilities.CapabilitiesMixin, + contacts.ContactsMixin, + presence.PresenceMixin, + requests.RequestsMixin, + simple_presence.SimplePresenceMixin, ): # overiding base class variable _mandatory_parameters = { - 'account' : 's', - 'password' : 's', + 'account': 's', + 'password': 's', } # overiding base class variable _optional_parameters = { - 'forward' : 's', + 'forward': 's', + 'use-gv-contacts': 'b', + 'contacts-poll-period-in-hours': 'i', + 'voicemail-poll-period-in-minutes': 'i', + 'texts-poll-period-in-minutes': 'i', } _parameter_defaults = { - 'forward' : '', + 'forward': '', + 'use-gv-contacts': TheOneRingOptions.useGVContacts, + 'contacts-poll-period-in-hours': TheOneRingOptions.contactsPollPeriodInHours, + 'voicemail-poll-period-in-minutes': TheOneRingOptions.voicemailPollPeriodInMinutes, + 'texts-poll-period-in-minutes': TheOneRingOptions.textsPollPeriodInMinutes, } _secret_parameters = set(( "password", )) - @gtk_toolbox.log_exception(_moduleLogger) + @misc_utils.log_exception(_moduleLogger) def __init__(self, manager, parameters): self.check_parameters(parameters) account = unicode(parameters['account']) encodedAccount = parameters['account'].encode('utf-8') encodedPassword = parameters['password'].encode('utf-8') - encodedCallback = util_misc.normalize_number(parameters['forward'].encode('utf-8')) - if encodedCallback and not util_misc.is_valid_number(encodedCallback): + encodedCallback = misc_utils.normalize_number(parameters['forward'].encode('utf-8')) + if encodedCallback and not misc_utils.is_valid_number(encodedCallback): raise telepathy.errors.InvalidArgument("Invalid forwarding number") # Connection init must come first - self.__session = gvoice.session.Session(None) + self.__options = TheOneRingOptions(parameters) + self.__session = gvoice.session.Session( + cookiePath = None, + defaults = { + "contacts": (self.__options.contactsPollPeriodInHours, "hours"), + "voicemail": (self.__options.voicemailPollPeriodInMinutes, "minutes"), + "texts": (self.__options.textsPollPeriodInMinutes, "minutes"), + }, + ) tp.Connection.__init__( self, constants._telepathy_protocol_name_, account, constants._telepathy_implementation_name_ ) - requests.RequestsMixin.__init__(self) - contacts.ContactsMixin.__init__(self) aliasing.AliasingMixin.__init__(self) - simple_presence.SimplePresenceMixin.__init__(self) - presence.PresenceMixin.__init__(self) + avatars.AvatarsMixin.__init__(self) capabilities.CapabilitiesMixin.__init__(self) + contacts.ContactsMixin.__init__(self) + presence.PresenceMixin.__init__(self) + requests.RequestsMixin.__init__(self) + simple_presence.SimplePresenceMixin.__init__(self) self.__manager = weakref.proxy(manager) self.__credentials = ( @@ -91,10 +125,6 @@ class TheOneRingConnection( self.__callbackNumberParameter = encodedCallback self.__channelManager = channel_manager.ChannelManager(self) - if conic is not None: - self.__connection = conic.Connection() - else: - self.__connection = None self.__cachePath = os.sep.join((constants._data_path_, "cache", self.username)) try: os.makedirs(self.__cachePath) @@ -103,9 +133,16 @@ class TheOneRingConnection( raise self.set_self_handle(handle.create_handle(self, 'connection')) + self._plumbing = [ + autogv.NewGVConversations(weakref.ref(self)), + autogv.RefreshVoicemail(weakref.ref(self)), + autogv.AutoDisconnect(weakref.ref(self)), + autogv.DelayEnableContactIntegration(constants._telepathy_implementation_name_), + ] - self.__callback = None _moduleLogger.info("Connection to the account %s created" % account) + self._timedDisconnect = autogv.TimedDisconnect(weakref.ref(self)) + self._timedDisconnect.start() @property def manager(self): @@ -116,6 +153,10 @@ class TheOneRingConnection( return self.__session @property + def options(self): + return self.__options + + @property def username(self): return self.__credentials[0] @@ -125,97 +166,104 @@ class TheOneRingConnection( def get_handle_by_name(self, handleType, handleName): requestedHandleName = handleName.encode('utf-8') + + # We need to return an existing or create a new handle. Unfortunately + # handle init's take care of normalizing the handle name. So we have + # to create a new handle regardless and burn some handle id's and burn + # some extra memory of creating objects we throw away if the handle + # already exists. if handleType == telepathy.HANDLE_TYPE_CONTACT: - _moduleLogger.info("get_handle_by_name Contact: %s" % requestedHandleName) h = handle.create_handle(self, 'contact', requestedHandleName) elif handleType == telepathy.HANDLE_TYPE_LIST: # Support only server side (immutable) lists - _moduleLogger.info("get_handle_by_name List: %s" % requestedHandleName) h = handle.create_handle(self, 'list', requestedHandleName) else: raise telepathy.errors.NotAvailable('Handle type unsupported %d' % handleType) + + for candidate in self._handles.itervalues(): + if candidate.get_name() == h.get_name(): + h = candidate + _moduleLogger.debug("Re-used handle for %s, I hoped this helped" % handleName) + break + return h @property def _channel_manager(self): return self.__channelManager - @gtk_toolbox.log_exception(_moduleLogger) + @misc_utils.log_exception(_moduleLogger) def Connect(self): """ For org.freedesktop.telepathy.Connection """ + if self._status != telepathy.CONNECTION_STATUS_DISCONNECTED: + _moduleLogger.info("Attempting connect when not disconnected") + return _moduleLogger.info("Connecting...") self.StatusChanged( telepathy.CONNECTION_STATUS_CONNECTING, telepathy.CONNECTION_STATUS_REASON_REQUESTED ) + self._timedDisconnect.stop() + self.session.login( + self.__credentials[0], + self.__credentials[1], + self._on_login, + self._on_login_error, + ) + + @misc_utils.log_exception(_moduleLogger) + def _on_login(self, *args): + _moduleLogger.info("Connected, setting up...") try: self.__session.load(self.__cachePath) - self.__callback = coroutines.func_sink( - coroutines.expand_positional( - self._on_conversations_updated - ) - ) - self.session.voicemails.updateSignalHandler.register_sink( - self.__callback - ) - self.session.texts.updateSignalHandler.register_sink( - self.__callback - ) - self.session.login(*self.__credentials) + for plumber in self._plumbing: + plumber.start() if not self.__callbackNumberParameter: callback = gvoice.backend.get_sane_callback( self.session.backend ) - self.__callbackNumberParameter = util_misc.normalize_number(callback) + self.__callbackNumberParameter = misc_utils.normalize_number(callback) self.session.backend.set_callback_number(self.__callbackNumberParameter) subscribeHandle = self.get_handle_by_name(telepathy.HANDLE_TYPE_LIST, "subscribe") - subscribeProps = self._generate_props(telepathy.CHANNEL_TYPE_CONTACT_LIST, subscribeHandle, False) + subscribeProps = self.generate_props(telepathy.CHANNEL_TYPE_CONTACT_LIST, subscribeHandle, False) self.__channelManager.channel_for_props(subscribeProps, signal=True) publishHandle = self.get_handle_by_name(telepathy.HANDLE_TYPE_LIST, "publish") - publishProps = self._generate_props(telepathy.CHANNEL_TYPE_CONTACT_LIST, publishHandle, False) + publishProps = self.generate_props(telepathy.CHANNEL_TYPE_CONTACT_LIST, publishHandle, False) self.__channelManager.channel_for_props(publishProps, signal=True) - except gvoice.backend.NetworkError, e: - _moduleLogger.exception("Connection Failed") - self.StatusChanged( - telepathy.CONNECTION_STATUS_DISCONNECTED, - telepathy.CONNECTION_STATUS_REASON_NETWORK_ERROR - ) - return - except Exception, e: - _moduleLogger.exception("Connection Failed") - self.StatusChanged( - telepathy.CONNECTION_STATUS_DISCONNECTED, - telepathy.CONNECTION_STATUS_REASON_AUTHENTICATION_FAILED - ) + except Exception: + _moduleLogger.exception("Setup failed") + self.disconnect(telepathy.CONNECTION_STATUS_REASON_AUTHENTICATION_FAILED) return - _moduleLogger.info("Connected") + _moduleLogger.info("Connected and set up") self.StatusChanged( telepathy.CONNECTION_STATUS_CONNECTED, telepathy.CONNECTION_STATUS_REASON_REQUESTED ) - if self.__connection is not None: - self.__connectionEventId = self.__connection.connect("connection-event", self._on_connection_change) - @gtk_toolbox.log_exception(_moduleLogger) + @misc_utils.log_exception(_moduleLogger) + def _on_login_error(self, error): + _moduleLogger.error(error) + if isinstance(error, StopIteration): + pass + elif isinstance(error, gvoice.backend.NetworkError): + self.disconnect(telepathy.CONNECTION_STATUS_REASON_NETWORK_ERROR) + else: + self.disconnect(telepathy.CONNECTION_STATUS_REASON_AUTHENTICATION_FAILED) + + @misc_utils.log_exception(_moduleLogger) def Disconnect(self): """ For org.freedesktop.telepathy.Connection """ - self.StatusChanged( - telepathy.CONNECTION_STATUS_DISCONNECTED, - telepathy.CONNECTION_STATUS_REASON_REQUESTED - ) - try: - self._disconnect() - except Exception: - _moduleLogger.exception("Error durring disconnect") + _moduleLogger.info("Kicking off disconnect") + self.disconnect(telepathy.CONNECTION_STATUS_REASON_REQUESTED) - @gtk_toolbox.log_exception(_moduleLogger) + @misc_utils.log_exception(_moduleLogger) def RequestChannel(self, type, handleType, handleId, suppressHandler): """ For org.freedesktop.telepathy.Connection @@ -229,7 +277,7 @@ class TheOneRingConnection( self.check_handle(handleType, handleId) h = self.get_handle_by_id(handleType, handleId) if handleId != 0 else None - props = self._generate_props(type, h, suppressHandler) + props = self.generate_props(type, h, suppressHandler) self._validate_handle(props) chan = self.__channelManager.channel_for_props(props, signal=True) @@ -237,9 +285,9 @@ class TheOneRingConnection( _moduleLogger.info("RequestChannel Object Path (%s): %s" % (type.rsplit(".", 1)[-1], path)) return path - def _generate_props(self, channelType, handle, suppressHandler, initiatorHandle=None): - targetHandle = 0 if handle is None else handle.get_id() - targetHandleType = telepathy.HANDLE_TYPE_NONE if handle is None else handle.get_type() + def generate_props(self, channelType, handleObj, suppressHandler, initiatorHandle=None): + targetHandle = 0 if handleObj is None else handleObj.get_id() + targetHandleType = telepathy.HANDLE_TYPE_NONE if handleObj is None else handleObj.get_type() props = { telepathy.CHANNEL_INTERFACE + '.ChannelType': channelType, telepathy.CHANNEL_INTERFACE + '.TargetHandle': targetHandle, @@ -252,69 +300,31 @@ class TheOneRingConnection( return props - def _disconnect(self): + def disconnect(self, reason): _moduleLogger.info("Disconnecting") - self.session.voicemails.updateSignalHandler.unregister_sink( - self.__callback - ) - self.session.texts.updateSignalHandler.unregister_sink( - self.__callback + + self._timedDisconnect.stop() + + # Not having the disconnect first can cause weird behavior with clients + # including not being able to reconnect or even crashing + self.StatusChanged( + telepathy.CONNECTION_STATUS_DISCONNECTED, + reason, ) - self.__callback = None + + for plumber in self._plumbing: + plumber.stop() self.__channelManager.close() + self.manager.disconnected(self) + self.session.save(self.__cachePath) self.session.logout() self.session.close() - self.manager.disconnected(self) - _moduleLogger.info("Disconnected") + # In case one of the above items takes too long (which it should never + # do), we leave the starting of the shutdown-on-idle counter to the + # very end + self.manager.disconnect_completed() - @gtk_toolbox.log_exception(_moduleLogger) - def _on_conversations_updated(self, conv, conversationIds): - _moduleLogger.debug("Incoming messages from: %r" % (conversationIds, )) - for phoneNumber in conversationIds: - h = self.get_handle_by_name(telepathy.HANDLE_TYPE_CONTACT, phoneNumber) - # Just let the TextChannel decide whether it should be reported to the user or not - props = self._generate_props(telepathy.CHANNEL_TYPE_TEXT, h, False) - if self.__channelManager.channel_exists(props): - continue - - # Maemo 4.1's RTComm opens a window for a chat regardless if a - # message is received or not, so we need to do some filtering here - mergedConv = conv.get_conversation(phoneNumber) - unreadConvs = [ - conversation - for conversation in mergedConv.conversations - if not conversation.isRead and not conversation.isArchived - ] - if not unreadConvs: - continue - - chan = self.__channelManager.channel_for_props(props, signal=True) - - @gtk_toolbox.log_exception(_moduleLogger) - def _on_connection_change(self, connection, event): - """ - @note Maemo specific - """ - if not self.session.is_logged_in(): - _moduleLogger.info("Received connection change event when not logged in") - return - status = event.get_status() - error = event.get_error() - iap_id = event.get_iap_id() - bearer = event.get_bearer_type() - - if status == conic.STATUS_DISCONNECTED: - _moduleLogger.info("Disconnecting due to loss of network connection") - self.StatusChanged( - telepathy.CONNECTION_STATUS_DISCONNECTED, - telepathy.CONNECTION_STATUS_REASON_NETWORK_ERROR - ) - try: - self._disconnect() - except Exception: - _moduleLogger.exception("Error durring disconnect") - else: - _moduleLogger.info("Other status: %r" % (status, )) + _moduleLogger.info("Disconnected")