Added detection of missed calls. As part of this I moved some of the connections...
[theonering] / src / connection.py
index 29fbf9a..41ea912 100644 (file)
@@ -1,28 +1,11 @@
-
-"""
-@todo Add params for different state machines update times
-@todo Add option to use screen name as callback
-@todo Get a callback for missed calls to force an update of the voicemail state machine
-@todo Get a callback on an incoming call and if its from GV, auto-pickup
-@todo Decide if we should do what the spec suggests and hold onto a singleton contactlist
-"""
-
-
 import os
 import weakref
 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
 
@@ -36,12 +19,35 @@ import simple_presence
 import presence
 import capabilities
 
+import autogv
 import channel_manager
 
 
 _moduleLogger = logging.getLogger("connection")
 
 
+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,
@@ -52,19 +58,29 @@ class TheOneRingConnection(
        capabilities.CapabilitiesMixin,
 ):
 
-       # Overriding a base class variable
-       # Should the forwarding number be handled by the alias or by an option?
+       # overiding base class variable
        _mandatory_parameters = {
-               'account' : 's',
-               'password' : 's',
+               'account': 's',
+               'password': 's',
        }
-       # Overriding a base class variable
+       # 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)
        def __init__(self, manager, parameters):
@@ -77,6 +93,15 @@ class TheOneRingConnection(
                        raise telepathy.errors.InvalidArgument("Invalid forwarding number")
 
                # Connection init must come first
+               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_,
@@ -98,13 +123,6 @@ class TheOneRingConnection(
                self.__callbackNumberParameter = encodedCallback
                self.__channelManager = channel_manager.ChannelManager(self)
 
-               self.__session = gvoice.session.Session(None)
-               if conic is not None:
-                       self.__connection = conic.Connection()
-                       self.__connectionEventId = None
-               else:
-                       self.__connection = None
-                       self.__connectionEventId = None
                self.__cachePath = os.sep.join((constants._data_path_, "cache", self.username))
                try:
                        os.makedirs(self.__cachePath)
@@ -113,8 +131,12 @@ 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)),
+               ]
 
-               self.__callback = None
                _moduleLogger.info("Connection to the account %s created" % account)
 
        @property
@@ -126,6 +148,10 @@ class TheOneRingConnection(
                return self.__session
 
        @property
+       def options(self):
+               return self.__options
+
+       @property
        def username(self):
                return self.__credentials[0]
 
@@ -136,11 +162,11 @@ class TheOneRingConnection(
        def get_handle_by_name(self, handleType, handleName):
                requestedHandleName = handleName.encode('utf-8')
                if handleType == telepathy.HANDLE_TYPE_CONTACT:
-                       _moduleLogger.info("get_handle_by_name Contact: %s" % requestedHandleName)
+                       _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.info("get_handle_by_name List: %s" % requestedHandleName)
+                       _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)
@@ -161,21 +187,10 @@ class TheOneRingConnection(
                        telepathy.CONNECTION_STATUS_REASON_REQUESTED
                )
                try:
-                       cookieFilePath = None
-                       self.__session = gvoice.session.Session(cookieFilePath)
                        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
-                       )
+                       for plumber in self._plumbing:
+                               plumber.start()
                        self.session.login(*self.__credentials)
                        if not self.__callbackNumberParameter:
                                callback = gvoice.backend.get_sane_callback(
@@ -183,6 +198,13 @@ class TheOneRingConnection(
                                )
                                self.__callbackNumberParameter = util_misc.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)
+                       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(
@@ -203,22 +225,20 @@ class TheOneRingConnection(
                        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)
        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
                )
-               try:
-                       self._disconnect()
-               except Exception:
-                       _moduleLogger.exception("Error durring disconnect")
 
        @gtk_toolbox.log_exception(_moduleLogger)
        def RequestChannel(self, type, handleType, handleId, suppressHandler):
@@ -234,15 +254,15 @@ 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)
                path = chan._object_path
-               _moduleLogger.info("RequestChannel Object Path: %s" % path)
+               _moduleLogger.info("RequestChannel Object Path (%s): %s" % (type.rsplit(".", 1)[-1], path))
                return path
 
-       def _generate_props(self, channelType, handle, suppressHandler, initiatorHandle=None):
+       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()
                props = {
@@ -257,56 +277,15 @@ class TheOneRingConnection(
 
                return props
 
-       def _disconnect(self):
+       def disconnect(self):
                _moduleLogger.info("Disconnecting")
-               self.session.voicemails.updateSignalHandler.unregister_sink(
-                       self.__callback
-               )
-               self.session.texts.updateSignalHandler.unregister_sink(
-                       self.__callback
-               )
-               self.__callback = None
+               for plumber in self._plumbing:
+                       plumber.stop()
 
                self.__channelManager.close()
                self.session.save(self.__cachePath)
                self.session.logout()
                self.session.close()
-               self.__session = None
-               if self.__connection is not None:
-                       self.__connection.disconnect(self.__connectionEventId)
-                       self.__connectionEventId = None
 
                self.manager.disconnected(self)
                _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)
-                       chan = self.__channelManager.channel_for_props(props, signal=True)
-
-       @gtk_toolbox.log_exception(_moduleLogger)
-       def _on_connection_change(self, connection, event):
-               """
-               @note Maemo specific
-
-               @todo Make this delayed to handle background switching of networks
-               """
-               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")