+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 gvoice
import handle
+
+import requests
+import contacts
+import aliasing
+import simple_presence
+import presence
+import capabilities
+
import channel_manager
_moduleLogger = logging.getLogger("connection")
-class TheOneRingConnection(telepathy.server.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']
- # Overriding a base class variable
+
+class TheOneRingConnection(
+ tp.Connection,
+ requests.RequestsMixin,
+ contacts.ContactsMixin,
+ aliasing.AliasingMixin,
+ simple_presence.SimplePresenceMixin,
+ presence.PresenceMixin,
+ capabilities.CapabilitiesMixin,
+):
+
+ # overiding base class variable
_mandatory_parameters = {
- 'username' : 's',
- 'password' : 's',
- 'forward' : 's',
+ 'account': 's',
+ 'password': 's',
}
- # Overriding a base class variable
+ # overiding base class variable
_optional_parameters = {
+ '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': '',
+ '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):
- try:
- self.check_parameters(parameters)
- account = unicode(parameters['username'])
-
- telepathy.server.Connection.__init__(
- self,
- constants._telepathy_protocol_name_,
- account,
- constants._telepathy_implementation_name_
- )
+ 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):
+ raise telepathy.errors.InvalidArgument("Invalid forwarding number")
- self._manager = weakref.proxy(manager)
- self._credentials = (
- parameters['username'].encode('utf-8'),
- parameters['password'].encode('utf-8'),
- )
- self._callbackNumber = parameters['forward'].encode('utf-8')
- self._channelManager = channel_manager.ChannelManager(self)
+ # 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_,
+ 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)
+ capabilities.CapabilitiesMixin.__init__(self)
+
+ self.__manager = weakref.proxy(manager)
+ self.__credentials = (
+ encodedAccount,
+ encodedPassword,
+ )
+ self.__callbackNumberParameter = encodedCallback
+ self.__channelManager = channel_manager.ChannelManager(self)
- cookieFilePath = "%s/cookies.txt" % constants._data_path_
- self._session = gvoice.session.Session(cookieFilePath)
+ 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)
+ except OSError, e:
+ if e.errno != 17:
+ raise
- self.set_self_handle(handle.create_handle(self, 'connection'))
+ self.set_self_handle(handle.create_handle(self, 'connection'))
- _moduleLogger.info("Connection to the account %s created" % account)
- except Exception, e:
- _moduleLogger.exception("Failed to create Connection")
- raise
+ self.__callback = None
+ self.__connectionEventId = None
+ self.__delayedDisconnectEventId = None
+ _moduleLogger.info("Connection to the account %s created" % account)
@property
def manager(self):
- return self._manager
+ return self.__manager
@property
def session(self):
- return self._session
+ return self.__session
+
+ @property
+ def options(self):
+ return self.__options
@property
def username(self):
- return self._credentials[0]
+ return self.__credentials[0]
- def handle(self, handleType, handleId):
- self.check_handle(handleType, handleId)
- return self._handles[handleType, handleId]
+ @property
+ def callbackNumberParameter(self):
+ return self.__callbackNumberParameter
+ def get_handle_by_name(self, handleType, handleName):
+ requestedHandleName = handleName.encode('utf-8')
+ 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)
+ return h
+
+ @property
+ def _channel_manager(self):
+ return self.__channelManager
+
+ @gtk_toolbox.log_exception(_moduleLogger)
def Connect(self):
"""
For org.freedesktop.telepathy.Connection
telepathy.CONNECTION_STATUS_REASON_REQUESTED
)
try:
- self.session.login(*self._credentials)
- self.session.backend.set_callback_number(self._callbackNumber)
+ 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)
+ if not self.__callbackNumberParameter:
+ callback = gvoice.backend.get_sane_callback(
+ self.session.backend
+ )
+ 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(
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
)
- else:
- _moduleLogger.info("Connected")
- self.StatusChanged(
- telepathy.CONNECTION_STATUS_CONNECTED,
- telepathy.CONNECTION_STATUS_REASON_REQUESTED
- )
+ return
+ _moduleLogger.info("Connected")
+ 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)
def Disconnect(self):
"""
For org.freedesktop.telepathy.Connection
- @bug Not properly logging out. Cookie files need to be per connection and removed
"""
- _moduleLogger.info("Disconnecting")
try:
- self.session.logout()
- _moduleLogger.info("Disconnected")
+ self._disconnect()
except Exception:
- _moduleLogger.exception("Disconnecting Failed")
+ _moduleLogger.exception("Error durring disconnect")
self.StatusChanged(
telepathy.CONNECTION_STATUS_DISCONNECTED,
telepathy.CONNECTION_STATUS_REASON_REQUESTED
)
+ @gtk_toolbox.log_exception(_moduleLogger)
def RequestChannel(self, type, handleType, handleId, suppressHandler):
"""
For org.freedesktop.telepathy.Connection
self.check_connected()
self.check_handle(handleType, handleId)
- channel = None
- channelManager = self._channelManager
- handle = self.handle(handleType, handleId)
-
- if type == telepathy.CHANNEL_TYPE_CONTACT_LIST:
- _moduleLogger.info("RequestChannel ContactList")
- channel = channelManager.channel_for_list(handle, suppressHandler)
- elif type == telepathy.CHANNEL_TYPE_TEXT:
- _moduleLogger.info("RequestChannel Text")
- channel = channelManager.channel_for_text(handle, None, suppressHandler)
- elif type == telepathy.CHANNEL_TYPE_STREAMED_MEDIA:
- _moduleLogger.info("RequestChannel Media")
- channel = channelManager.channel_for_text(handle, None, suppressHandler)
- else:
- raise telepathy.NotImplemented("unknown channel type %s" % type)
+ h = self.get_handle_by_id(handleType, handleId) if handleId != 0 else None
+ 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): %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()
+ props = {
+ telepathy.CHANNEL_INTERFACE + '.ChannelType': channelType,
+ telepathy.CHANNEL_INTERFACE + '.TargetHandle': targetHandle,
+ telepathy.CHANNEL_INTERFACE + '.TargetHandleType': targetHandleType,
+ telepathy.CHANNEL_INTERFACE + '.Requested': suppressHandler
+ }
+
+ if initiatorHandle is not None:
+ props[telepathy.CHANNEL_INTERFACE + '.InitiatorHandle'] = initiatorHandle.id
+
+ return props
+
+ 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
- _moduleLogger.info("RequestChannel Object Path: %s" % channel._object_path)
- return channel._object_path
+ self.__channelManager.close()
+ self.session.save(self.__cachePath)
+ self.session.logout()
+ self.session.close()
- def RequestHandles(self, handleType, names, sender):
+ self.manager.disconnected(self)
+
+ 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):
"""
- For org.freedesktop.telepathy.Connection
- Overiding telepathy.server.Connecton to allow custom handles
+ @note Maemo specific
"""
- self.check_connected()
- self.check_handle_type(handleType)
-
- handles = []
- for name in names:
- name = name.encode('utf-8')
- if handleType == telepathy.HANDLE_TYPE_CONTACT:
- _moduleLogger.info("RequestHandles Contact: %s" % name)
- h = self._create_contact_handle(name)
- elif handleType == telepathy.HANDLE_TYPE_LIST:
- # Support only server side (immutable) lists
- _moduleLogger.info("RequestHandles List: %s" % name)
- h = handle.create_handle(self, 'list', name)
- else:
- raise telepathy.NotAvailable('Handle type unsupported %d' % handleType)
- handles.append(h.id)
- self.add_client_handle(h, sender)
- return handles
-
- def _create_contact_handle(self, name):
- requestedContactId = name
-
- contacts = self.session.addressbook.get_contacts()
- contactsFound = [
- contactId for contactId in contacts
- if contactId == requestedContactId
- ]
-
- if 0 < len(contactsFound):
- contactId = contactsFound[0]
- if len(contactsFound) != 1:
- _moduleLogger.error("Contact ID was not unique: %s for %s" % (contactId, ))
+ 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:
- contactId = requestedContactId
- h = handle.create_handle(self, 'contact', contactId)
+ _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