X-Git-Url: http://git.maemo.org/git/?p=theonering;a=blobdiff_plain;f=src%2Fconnection.py;h=59ffa76932a8e89e0ea8874ab5ec9466727f517a;hp=567d3992b379c726724d67dbb2f5d32afe960574;hb=afa4cdb64e451070cf87cc02f257c582fa057f53;hpb=7912b2aa8daf492f3933d975fab97e59937981e1 diff --git a/src/connection.py b/src/connection.py index 567d399..59ffa76 100644 --- a/src/connection.py +++ b/src/connection.py @@ -1,117 +1,269 @@ +import os import weakref import logging import telepathy import constants -import gv_backend +import tp +import util.misc as misc_utils + +import gvoice import handle -import channel_manager + +import aliasing +import avatars +import capabilities +import contacts +import presence +import requests import simple_presence +import autogv +import channel_manager + + +_moduleLogger = logging.getLogger(__name__) + + +class TheOneRingOptions(object): + + useGVContacts = True -_moduleLogger = logging.getLogger("connection") + 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] -class TheOneRingConnection(telepathy.server.Connection, simple_presence.SimplePresenceMixin): + assert gvoice.session.Session._DEFAULTS["texts"][1] == "minutes" + textsPollPeriodInMinutes = gvoice.session.Session._DEFAULTS["texts"][0] - MANDATORY_PARAMETERS = { - 'account' : 's', - 'password' : 's', - 'forward' : 's', + 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, + aliasing.AliasingMixin, + avatars.AvatarsMixin, + capabilities.CapabilitiesMixin, + contacts.ContactsMixin, + presence.PresenceMixin, + requests.RequestsMixin, + simple_presence.SimplePresenceMixin, +): + + # overiding base class variable + _mandatory_parameters = { + 'account': 's', + 'password': 's', } - OPTIONAL_PARAMETERS = { + # 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 = { + _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", + )) + @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 = 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.__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_ + ) + aliasing.AliasingMixin.__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 = ( + encodedAccount, + encodedPassword, + ) + self.__callbackNumberParameter = encodedCallback + self.__channelManager = channel_manager.ChannelManager(self) + + self.__cachePath = os.sep.join((constants._data_path_, "cache", self.username)) try: - self.check_parameters(parameters) - account = unicode(parameters['account']) - - telepathy.server.Connection.__init__( - self, - constants._telepathy_protocol_name_, - account, - constants._telepathy_implementation_name_ - ) - - self._manager = weakref.proxy(manager) - self._credentials = ( - parameters['account'].encode('utf-8'), - parameters['password'].encode('utf-8'), - ) - self._callbackNumber = parameters['forward'].encode('utf-8') - self._channelManager = channel_manager.ChannelManager(self) - - cookieFilePath = "%s/cookies.txt" % constants._data_path_ - self._backend = gv_backend.GVDialer(cookieFilePath) - - 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 + os.makedirs(self.__cachePath) + except OSError, e: + if e.errno != 17: + 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_), + ] + + _moduleLogger.info("Connection to the account %s created" % account) + self._timedDisconnect = autogv.TimedDisconnect(weakref.ref(self)) + self._timedDisconnect.start() @property def manager(self): - return self._manager + return self.__manager @property - def gvoice_backend(self): - return self._backend + def session(self): + return self.__session + + @property + def options(self): + return self.__options @property def username(self): - 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') + # 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: + h = handle.create_handle(self, 'contact', requestedHandleName) + elif handleType == telepathy.HANDLE_TYPE_LIST: + # Support only server side (immutable) lists + 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 + + @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._backend.login(*self._credentials) - self._backend.set_callback_number(self._callbackNumber) - except gv_backend.NetworkError: - self.StatusChanged( - telepathy.CONNECTION_STATUS_DISCONNECTED, - telepathy.CONNECTION_STATUS_REASON_NETWORK_ERROR - ) + self.__session.load(self.__cachePath) + + for plumber in self._plumbing: + plumber.start() + if not self.__callbackNumberParameter: + callback = gvoice.backend.get_sane_callback( + self.session.backend + ) + 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) + 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 Exception: - self.StatusChanged( - telepathy.CONNECTION_STATUS_DISCONNECTED, - telepathy.CONNECTION_STATUS_REASON_AUTHENTICATION_FAILED - ) + _moduleLogger.exception("Setup failed") + self.disconnect(telepathy.CONNECTION_STATUS_REASON_AUTHENTICATION_FAILED) + return + + _moduleLogger.info("Connected and set up") + self.StatusChanged( + telepathy.CONNECTION_STATUS_CONNECTED, + telepathy.CONNECTION_STATUS_REASON_REQUESTED + ) + + @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.StatusChanged( - telepathy.CONNECTION_STATUS_CONNECTED, - telepathy.CONNECTION_STATUS_REASON_REQUESTED - ) + self.disconnect(telepathy.CONNECTION_STATUS_REASON_AUTHENTICATION_FAILED) + @misc_utils.log_exception(_moduleLogger) def Disconnect(self): """ For org.freedesktop.telepathy.Connection """ - try: - self._backend.logout() - _moduleLogger.info("Disconnected") - except Exception: - _moduleLogger.exception("Disconnecting Failed") - self.StatusChanged( - telepathy.CONNECTION_STATUS_DISCONNECTED, - telepathy.CONNECTION_STATUS_REASON_REQUESTED - ) + _moduleLogger.info("Kicking off disconnect") + self.disconnect(telepathy.CONNECTION_STATUS_REASON_REQUESTED) + @misc_utils.log_exception(_moduleLogger) def RequestChannel(self, type, handleType, handleId, suppressHandler): """ For org.freedesktop.telepathy.Connection @@ -122,61 +274,57 @@ class TheOneRingConnection(telepathy.server.Connection, simple_presence.SimplePr @returns DBus object path for the channel created or retrieved """ 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: - channel = channelManager.channel_for_list(handle, suppressHandler) - elif type == telepathy.CHANNEL_TYPE_TEXT: - if handleType != telepathy.HANDLE_TYPE_CONTACT: - raise telepathy.NotImplemented("Only Contacts are allowed") - channel = channelManager.channel_for_text(handle, None, suppressHandler) - elif type == telepathy.CHANNEL_TYPE_STREAMED_MEDIA: - if handleType != telepathy.HANDLE_TYPE_CONTACT: - raise telepathy.NotImplemented("Only Contacts are allowed") - 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) - return channel._object_path + 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 RequestHandles(self, handleType, names, sender): - """ - For org.freedesktop.telepathy.Connection - """ - self.check_connected() - self.check_handle_type(handleType) - - handles = [] - for name in names: - name = name.encode('utf-8') - if handleType == telepathy.HANDLE_TYPE_CONTACT: - h = self._create_contact_handle(name) - elif handleType == telepathy.HANDLE_TYPE_LIST: - h = handle.create_handle(self, 'list', name) - elif handleType == telepathy.HANDLE_TYPE_GROUP: - h = handle.create_handle(self, 'group', name) - else: - raise telepathy.NotAvailable('Handle type unsupported %d' % handleType) - handles.append(h.id) - self.add_client_handle(handle, sender) - return handles - - def _create_contact_handle(self, name): - requestedContactId = name - - contacts = self._backend.get_contacts() - contactsFound = [ - (contactId, contactName) for (contactId, contactName) in contacts - if contactId == requestedContactId - ] + 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, + telepathy.CHANNEL_INTERFACE + '.TargetHandleType': targetHandleType, + telepathy.CHANNEL_INTERFACE + '.Requested': suppressHandler + } - if 0 < len(contactsFound): - contactId, contactName = contactsFound[0] - if len(contactsFound) != 1: - _moduleLogger.error("Contact ID was not unique: %s for %s" % (contactId, contactName)) - else: - contactId, contactName = requestedContactId, "" - h = handle.create_handle(self, 'contact', contactId, contactName) + if initiatorHandle is not None: + props[telepathy.CHANNEL_INTERFACE + '.InitiatorHandle'] = initiatorHandle.id + + return props + + def disconnect(self, reason): + _moduleLogger.info("Disconnecting") + + 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, + ) + + 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() + + # 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() + + _moduleLogger.info("Disconnected")