Forcing calls to quit immediately rather than giving time to cancel to fix issues...
[theonering] / src / connection.py
index e2e53b4..71e3920 100644 (file)
@@ -2,40 +2,34 @@ import os
 import weakref
 import logging
 
-import gobject
 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.go_utils as gobject_utils
-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):
 
+       ignoreDND = True
+
        useGVContacts = True
 
        assert gvoice.session.Session._DEFAULTS["contacts"][1] == "hours"
@@ -50,6 +44,7 @@ class TheOneRingOptions(object):
        def __init__(self, parameters = None):
                if parameters is None:
                        return
+               self.ignoreDND = parameters["ignore-dnd"]
                self.useGVContacts = parameters["use-gv-contacts"]
                self.contactsPollPeriodInHours = parameters['contacts-poll-period-in-hours']
                self.voicemailPollPeriodInMinutes = parameters['voicemail-poll-period-in-minutes']
@@ -58,12 +53,14 @@ class TheOneRingOptions(object):
 
 class TheOneRingConnection(
        tp.Connection,
-       requests.RequestsMixin,
-       contacts.ContactsMixin,
        aliasing.AliasingMixin,
+       avatars.AvatarsMixin,
+       capabilities.CapabilitiesMixin,
+       contacts.ContactsMixin,
+       requests.RequestsMixin,
+       simple_presence.TheOneRingPresence,
        simple_presence.SimplePresenceMixin,
        presence.PresenceMixin,
-       capabilities.CapabilitiesMixin,
 ):
 
        # overiding base class variable
@@ -74,13 +71,15 @@ class TheOneRingConnection(
        # overiding base class variable
        _optional_parameters = {
                'forward': 's',
+               'ignore-dnd': 'b',
                'use-gv-contacts': 'b',
-               'contacts-poll-period': 'i',
-               'voicemail-poll-period': 'i',
-               'texts-poll-period': 'i',
+               'contacts-poll-period-in-hours': 'i',
+               'voicemail-poll-period-in-minutes': 'i',
+               'texts-poll-period-in-minutes': 'i',
        }
        _parameter_defaults = {
                'forward': '',
+               'ignore-dnd': TheOneRingOptions.ignoreDND,
                'use-gv-contacts': TheOneRingOptions.useGVContacts,
                'contacts-poll-period-in-hours': TheOneRingOptions.contactsPollPeriodInHours,
                'voicemail-poll-period-in-minutes': TheOneRingOptions.voicemailPollPeriodInMinutes,
@@ -90,31 +89,36 @@ class TheOneRingConnection(
                "password",
        ))
 
-       @gtk_toolbox.log_exception(_moduleLogger)
+       @misc_utils.log_exception(_moduleLogger)
        def __init__(self, manager, parameters):
+               self._loggers = []
+
                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.__accountName = account
+               self.__session = None
                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)
+               requests.RequestsMixin.__init__(self)
+               simple_presence.TheOneRingPresence.__init__(self, self.__options.ignoreDND)
+               simple_presence.SimplePresenceMixin.__init__(self, self)
+               presence.PresenceMixin.__init__(self, self)
 
                self.__manager = weakref.proxy(manager)
                self.__credentials = (
@@ -124,10 +128,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)
@@ -136,11 +136,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
-               self.__connectionEventId = None
-               self.__delayedDisconnectEventId = None
                _moduleLogger.info("Connection to the account %s created" % account)
+               self._timedDisconnect = autogv.TimedDisconnect(weakref.ref(self))
+               self._timedDisconnect.start()
 
        @property
        def manager(self):
@@ -164,97 +169,130 @@ 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.debug("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.debug("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
 
+       def force_log_display(self):
+               accountNumber = misc_utils.normalize_number(self.session.backend.get_account_number())
+               debugHandle = self.get_handle_by_name(
+                       telepathy.HANDLE_TYPE_CONTACT,
+                       accountNumber,
+               )
+               debugPromptProps = self.generate_props(telepathy.CHANNEL_TYPE_TEXT, debugHandle, False)
+               self.__channelManager.channel_for_props(debugPromptProps, signal=True)
+
+       def log_to_user(self, component, message):
+               for logger in self._loggers:
+                       logger.log_message(component, message)
+
+       def add_logger(self, logger):
+               self._loggers.append(logger)
+
+       def remove_logger(self, logger):
+               self._loggers.remove(logger)
+
        @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.__session is None:
+                       self.__session = gvoice.session.Session(
+                               cookiePath = os.path.join(constants._data_path_, "%s.cookies" % self.__accountName),
+                               defaults = {
+                                       "contacts": (self.__options.contactsPollPeriodInHours, "hours"),
+                                       "voicemail": (self.__options.voicemailPollPeriodInMinutes, "minutes"),
+                                       "texts": (self.__options.textsPollPeriodInMinutes, "minutes"),
+                               },
+                       )
+
+               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.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)
-                       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
                """
-               try:
-                       self._disconnect()
-               except Exception:
-                       _moduleLogger.exception("Error durring disconnect")
-               self.StatusChanged(
-                       telepathy.CONNECTION_STATUS_DISCONNECTED,
-                       telepathy.CONNECTION_STATUS_REASON_REQUESTED
-               )
+               _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
@@ -268,7 +306,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)
@@ -276,9 +314,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,
@@ -291,90 +329,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.shutdown()
                self.session.close()
 
-               self.manager.disconnected(self)
+               # 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()
 
-               self._cancel_delayed_disconnect()
-               self.__connection = None
                _moduleLogger.info("Disconnected")
-
-       @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
-               """
-               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("Disconnected from network, starting countdown to logoff")
-                       self.__delayedDisconnectEventId = gobject_utils.timeout_add_seconds(
-                               5, self._on_delayed_disconnect
-                       )
-               elif status == conic.STATUS_CONNECTED:
-                       _moduleLogger.info("Connected to network")
-                       self._cancel_delayed_disconnect()
-               else:
-                       _moduleLogger.info("Other status: %r" % (status, ))
-
-       def _cancel_delayed_disconnect(self):
-               if self.__delayedDisconnectEventId is None:
-                       return
-               _moduleLogger.info("Cancelling auto-log off")
-               gobject.source_reove(self.__delayedDisconnectEventId)
-               self.__delayedDisconnectEventId = None
-
-       @gtk_toolbox.log_exception(_moduleLogger)
-       def _on_delayed_disconnect(self):
-               if not self.session.is_logged_in():
-                       _moduleLogger.info("Received connection change event when not logged in")
-                       return
-               try:
-                       self._disconnect()
-               except Exception:
-                       _moduleLogger.exception("Error durring disconnect")
-               self.StatusChanged(
-                       telepathy.CONNECTION_STATUS_DISCONNECTED,
-                       telepathy.CONNECTION_STATUS_REASON_NETWORK_ERROR
-               )
-               self.__delayedDisconnectEventId = None
-               return False