git.maemo.org Git - theonering/blob - src/connection.py

   1
   2 """
   3 @todo Add params for different state machines update times
   4 @todo Add option to use screen name as callback
   5 @todo Get a callback for missed calls to force an update of the voicemail state machine
   6 @todo Get a callback on an incoming call and if its from GV, auto-pickup
   7 """
   8
   9
  10 import weakref
  11 import logging
  12
  13 import telepathy
  14
  15 try:
  16         import conic as _conic
  17         conic = _conic
  18 except (ImportError, OSError):
  19         conic = None
  20
  21 import constants
  22 import tp
  23 import util.coroutines as coroutines
  24 import gtk_toolbox
  25
  26 import gvoice
  27 import handle
  28
  29 import requests
  30 import contacts
  31 import aliasing
  32 import simple_presence
  33 import presence
  34 import capabilities
  35
  36 import channel_manager
  37
  38
  39 _moduleLogger = logging.getLogger("connection")
  40
  41
  42 class TheOneRingConnection(
  43         tp.Connection,
  44         requests.RequestsMixin,
  45         contacts.ContactsMixin,
  46         aliasing.AliasingMixin,
  47         simple_presence.SimplePresenceMixin,
  48         presence.PresenceMixin,
  49         capabilities.CapabilitiesMixin,
  50 ):
  51
  52         # Overriding a base class variable
  53         # Should the forwarding number be handled by the alias or by an option?
  54         _mandatory_parameters = {
  55                 'account' : 's',
  56                 'password' : 's',
  57                 'forward' : 's',
  58         }
  59         # Overriding a base class variable
  60         _optional_parameters = {
  61         }
  62         _parameter_defaults = {
  63         }
  64
  65         @gtk_toolbox.log_exception(_moduleLogger)
  66         def __init__(self, manager, parameters):
  67                 self.check_parameters(parameters)
  68                 account = unicode(parameters['account'])
  69                 encodedAccount = parameters['account'].encode('utf-8')
  70                 encodedPassword = parameters['password'].encode('utf-8')
  71                 encodedCallback = parameters['forward'].encode('utf-8')
  72                 if not encodedCallback:
  73                         raise telepathy.errors.InvalidArgument("User must specify what number GV forwards calls to")
  74
  75                 # Connection init must come first
  76                 tp.Connection.__init__(
  77                         self,
  78                         constants._telepathy_protocol_name_,
  79                         account,
  80                         constants._telepathy_implementation_name_
  81                 )
  82                 requests.RequestsMixin.__init__(self)
  83                 contacts.ContactsMixin.__init__(self)
  84                 aliasing.AliasingMixin.__init__(self)
  85                 simple_presence.SimplePresenceMixin.__init__(self)
  86                 presence.PresenceMixin.__init__(self)
  87                 capabilities.CapabilitiesMixin.__init__(self)
  88
  89                 self.__manager = weakref.proxy(manager)
  90                 self.__credentials = (
  91                         encodedAccount,
  92                         encodedPassword,
  93                 )
  94                 self.__callbackNumber = encodedCallback
  95                 self.__channelManager = channel_manager.ChannelManager(self)
  96
  97                 self.__session = gvoice.session.Session(None)
  98                 if conic is not None:
  99                         self.__connection = conic.Connection()
 100                         self.__connectionEventId = None
 101                 else:
 102                         self.__connection = None
 103                         self.__connectionEventId = None
 104
 105                 self.set_self_handle(handle.create_handle(self, 'connection'))
 106
 107                 self.__callback = None
 108                 _moduleLogger.info("Connection to the account %s created" % account)
 109
 110         @property
 111         def manager(self):
 112                 return self.__manager
 113
 114         @property
 115         def session(self):
 116                 return self.__session
 117
 118         @property
 119         def username(self):
 120                 return self.__credentials[0]
 121
 122         @property
 123         def userAliasType(self):
 124                 return self.USER_ALIAS_ACCOUNT
 125
 126         def get_handle_by_name(self, handleType, handleName):
 127                 requestedHandleName = handleName.encode('utf-8')
 128                 if handleType == telepathy.HANDLE_TYPE_CONTACT:
 129                         _moduleLogger.info("RequestHandles Contact: %s" % requestedHandleName)
 130                         requestedContactId, requestedContactNumber = handle.ContactHandle.from_handle_name(
 131                                 requestedHandleName
 132                         )
 133                         h = handle.create_handle(self, 'contact', requestedContactId, requestedContactNumber)
 134                 elif handleType == telepathy.HANDLE_TYPE_LIST:
 135                         # Support only server side (immutable) lists
 136                         _moduleLogger.info("RequestHandles List: %s" % requestedHandleName)
 137                         h = handle.create_handle(self, 'list', requestedHandleName)
 138                 else:
 139                         raise telepathy.errors.NotAvailable('Handle type unsupported %d' % handleType)
 140                 return h
 141
 142         @property
 143         def _channel_manager(self):
 144                 return self.__channelManager
 145
 146         @gtk_toolbox.log_exception(_moduleLogger)
 147         def Connect(self):
 148                 """
 149                 For org.freedesktop.telepathy.Connection
 150                 """
 151                 _moduleLogger.info("Connecting...")
 152                 self.StatusChanged(
 153                         telepathy.CONNECTION_STATUS_CONNECTING,
 154                         telepathy.CONNECTION_STATUS_REASON_REQUESTED
 155                 )
 156                 try:
 157                         cookieFilePath = None
 158                         self.__session = gvoice.session.Session(cookieFilePath)
 159
 160                         self.__callback = coroutines.func_sink(
 161                                 coroutines.expand_positional(
 162                                         self._on_conversations_updated
 163                                 )
 164                         )
 165                         self.session.voicemails.updateSignalHandler.register_sink(
 166                                 self.__callback
 167                         )
 168                         self.session.texts.updateSignalHandler.register_sink(
 169                                 self.__callback
 170                         )
 171                         self.session.login(*self.__credentials)
 172                         self.session.backend.set_callback_number(self.__callbackNumber)
 173                 except gvoice.backend.NetworkError, e:
 174                         _moduleLogger.exception("Connection Failed")
 175                         self.StatusChanged(
 176                                 telepathy.CONNECTION_STATUS_DISCONNECTED,
 177                                 telepathy.CONNECTION_STATUS_REASON_NETWORK_ERROR
 178                         )
 179                         return
 180                 except Exception, e:
 181                         _moduleLogger.exception("Connection Failed")
 182                         self.StatusChanged(
 183                                 telepathy.CONNECTION_STATUS_DISCONNECTED,
 184                                 telepathy.CONNECTION_STATUS_REASON_AUTHENTICATION_FAILED
 185                         )
 186                         return
 187
 188                 _moduleLogger.info("Connected")
 189                 self.StatusChanged(
 190                         telepathy.CONNECTION_STATUS_CONNECTED,
 191                         telepathy.CONNECTION_STATUS_REASON_REQUESTED
 192                 )
 193                 if self.__connection is not None:
 194                         self.__connectionEventId = self.__connection.connect("connection-event", self._on_connection_change)
 195
 196         @gtk_toolbox.log_exception(_moduleLogger)
 197         def Disconnect(self):
 198                 """
 199                 For org.freedesktop.telepathy.Connection
 200                 """
 201                 self.StatusChanged(
 202                         telepathy.CONNECTION_STATUS_DISCONNECTED,
 203                         telepathy.CONNECTION_STATUS_REASON_REQUESTED
 204                 )
 205                 try:
 206                         self._disconnect()
 207                 except Exception:
 208                         _moduleLogger.exception("Error durring disconnect")
 209
 210         @gtk_toolbox.log_exception(_moduleLogger)
 211         def RequestChannel(self, type, handleType, handleId, suppressHandler):
 212                 """
 213                 For org.freedesktop.telepathy.Connection
 214
 215                 @param type DBus interface name for base channel type
 216                 @param handleId represents a contact, list, etc according to handleType
 217
 218                 @returns DBus object path for the channel created or retrieved
 219                 """
 220                 self.check_connected()
 221                 self.check_handle(handleType, handleId)
 222
 223                 h = self.get_handle_by_id(handleType, handleId) if handleId != 0 else None
 224                 props = self._generate_props(type, h, suppressHandler)
 225                 self._validate_handle(props)
 226
 227                 chan = self.__channelManager.channel_for_props(props, signal=True)
 228                 path = chan._object_path
 229                 _moduleLogger.info("RequestChannel Object Path: %s" % path)
 230                 return path
 231
 232         def _generate_props(self, channelType, handle, suppressHandler, initiatorHandle=None):
 233                 targetHandle = 0 if handle is None else handle.get_id()
 234                 targetHandleType = telepathy.HANDLE_TYPE_NONE if handle is None else handle.get_type()
 235                 props = {
 236                         telepathy.CHANNEL_INTERFACE + '.ChannelType': channelType,
 237                         telepathy.CHANNEL_INTERFACE + '.TargetHandle': targetHandle,
 238                         telepathy.CHANNEL_INTERFACE + '.TargetHandleType': targetHandleType,
 239                         telepathy.CHANNEL_INTERFACE + '.Requested': suppressHandler
 240                 }
 241
 242                 if initiatorHandle is not None:
 243                         props[telepathy.CHANNEL_INTERFACE + '.InitiatorHandle'] = initiatorHandle.id
 244
 245                 return props
 246
 247         def _disconnect(self):
 248                 _moduleLogger.info("Disconnecting")
 249                 self.session.voicemails.updateSignalHandler.unregister_sink(
 250                         self.__callback
 251                 )
 252                 self.session.texts.updateSignalHandler.unregister_sink(
 253                         self.__callback
 254                 )
 255                 self.__callback = None
 256
 257                 self.__channelManager.close()
 258                 self.session.logout()
 259                 self.session.close()
 260                 self.__session = None
 261                 if self.__connection is not None:
 262                         self.__connection.disconnect(self.__connectionEventId)
 263                         self.__connectionEventId = None
 264
 265                 self.manager.disconnected(self)
 266                 _moduleLogger.info("Disconnected")
 267
 268         @gtk_toolbox.log_exception(_moduleLogger)
 269         def _on_conversations_updated(self, conv, conversationIds):
 270                 _moduleLogger.debug("Incoming messages from: %r" % (conversationIds, ))
 271                 for contactId, phoneNumber in conversationIds:
 272                         h = handle.create_handle(self, 'contact', contactId, phoneNumber)
 273                         # Just let the TextChannel decide whether it should be reported to the user or not
 274                         props = self._generate_props(telepathy.CHANNEL_TYPE_TEXT, h, False)
 275                         channel = self.__channelManager.channel_for_props(props, signal=True)
 276
 277         @gtk_toolbox.log_exception(_moduleLogger)
 278         def _on_connection_change(self, connection, event):
 279                 """
 280                 @note Maemo specific
 281                 """
 282                 status = event.get_status()
 283                 error = event.get_error()
 284                 iap_id = event.get_iap_id()
 285                 bearer = event.get_bearer_type()
 286
 287                 if status == conic.STATUS_DISCONNECTED:
 288                         _moduleLogger.info("Disconnecting due to loss of network connection")
 289                         self.StatusChanged(
 290                                 telepathy.CONNECTION_STATUS_DISCONNECTED,
 291                                 telepathy.CONNECTION_STATUS_REASON_NETWORK_ERROR
 292                         )
 293                         try:
 294                                 self._disconnect()
 295                         except Exception:
 296                                 _moduleLogger.exception("Error durring disconnect")