9 import util.go_utils as gobject_utils
10 import util.misc as misc_utils
21 import simple_presence
24 import channel_manager
27 _moduleLogger = logging.getLogger(__name__)
30 class TheOneRingOptions(object):
34 assert gvoice.session.Session._DEFAULTS["contacts"][1] == "hours"
35 contactsPollPeriodInHours = gvoice.session.Session._DEFAULTS["contacts"][0]
37 assert gvoice.session.Session._DEFAULTS["voicemail"][1] == "minutes"
38 voicemailPollPeriodInMinutes = gvoice.session.Session._DEFAULTS["voicemail"][0]
40 assert gvoice.session.Session._DEFAULTS["texts"][1] == "minutes"
41 textsPollPeriodInMinutes = gvoice.session.Session._DEFAULTS["texts"][0]
43 def __init__(self, parameters = None):
44 if parameters is None:
46 self.useGVContacts = parameters["use-gv-contacts"]
47 self.contactsPollPeriodInHours = parameters['contacts-poll-period-in-hours']
48 self.voicemailPollPeriodInMinutes = parameters['voicemail-poll-period-in-minutes']
49 self.textsPollPeriodInMinutes = parameters['texts-poll-period-in-minutes']
52 class TheOneRingConnection(
54 aliasing.AliasingMixin,
56 capabilities.CapabilitiesMixin,
57 contacts.ContactsMixin,
58 presence.PresenceMixin,
59 requests.RequestsMixin,
60 simple_presence.SimplePresenceMixin,
63 # overiding base class variable
64 _mandatory_parameters = {
68 # overiding base class variable
69 _optional_parameters = {
71 'use-gv-contacts': 'b',
72 'contacts-poll-period-in-hours': 'i',
73 'voicemail-poll-period-in-minutes': 'i',
74 'texts-poll-period-in-minutes': 'i',
76 _parameter_defaults = {
78 'use-gv-contacts': TheOneRingOptions.useGVContacts,
79 'contacts-poll-period-in-hours': TheOneRingOptions.contactsPollPeriodInHours,
80 'voicemail-poll-period-in-minutes': TheOneRingOptions.voicemailPollPeriodInMinutes,
81 'texts-poll-period-in-minutes': TheOneRingOptions.textsPollPeriodInMinutes,
83 _secret_parameters = set((
87 @misc_utils.log_exception(_moduleLogger)
88 def __init__(self, manager, parameters):
89 self.check_parameters(parameters)
90 account = unicode(parameters['account'])
91 encodedAccount = parameters['account'].encode('utf-8')
92 encodedPassword = parameters['password'].encode('utf-8')
93 encodedCallback = misc_utils.normalize_number(parameters['forward'].encode('utf-8'))
94 if encodedCallback and not misc_utils.is_valid_number(encodedCallback):
95 raise telepathy.errors.InvalidArgument("Invalid forwarding number")
97 # Connection init must come first
98 self.__options = TheOneRingOptions(parameters)
99 self.__session = gvoice.session.Session(
102 "contacts": (self.__options.contactsPollPeriodInHours, "hours"),
103 "voicemail": (self.__options.voicemailPollPeriodInMinutes, "minutes"),
104 "texts": (self.__options.textsPollPeriodInMinutes, "minutes"),
107 tp.Connection.__init__(
109 constants._telepathy_protocol_name_,
111 constants._telepathy_implementation_name_
113 aliasing.AliasingMixin.__init__(self)
114 avatars.AvatarsMixin.__init__(self)
115 capabilities.CapabilitiesMixin.__init__(self)
116 contacts.ContactsMixin.__init__(self)
117 presence.PresenceMixin.__init__(self)
118 requests.RequestsMixin.__init__(self)
119 simple_presence.SimplePresenceMixin.__init__(self)
121 self.__manager = weakref.proxy(manager)
122 self.__credentials = (
126 self.__callbackNumberParameter = encodedCallback
127 self.__channelManager = channel_manager.ChannelManager(self)
129 self.__cachePath = os.sep.join((constants._data_path_, "cache", self.username))
131 os.makedirs(self.__cachePath)
136 self.set_self_handle(handle.create_handle(self, 'connection'))
138 autogv.NewGVConversations(weakref.ref(self)),
139 autogv.RefreshVoicemail(weakref.ref(self)),
140 autogv.AutoDisconnect(weakref.ref(self)),
142 self._delayedConnect = gobject_utils.Async(self._delayed_connect)
144 _moduleLogger.info("Connection to the account %s created" % account)
145 self._timedDisconnect = autogv.TimedDisconnect(weakref.ref(self))
146 self._timedDisconnect.start()
150 return self.__manager
154 return self.__session
158 return self.__options
162 return self.__credentials[0]
165 def callbackNumberParameter(self):
166 return self.__callbackNumberParameter
168 def get_handle_by_name(self, handleType, handleName):
169 requestedHandleName = handleName.encode('utf-8')
170 if handleType == telepathy.HANDLE_TYPE_CONTACT:
171 h = handle.create_handle(self, 'contact', requestedHandleName)
172 elif handleType == telepathy.HANDLE_TYPE_LIST:
173 # Support only server side (immutable) lists
174 h = handle.create_handle(self, 'list', requestedHandleName)
176 raise telepathy.errors.NotAvailable('Handle type unsupported %d' % handleType)
180 def _channel_manager(self):
181 return self.__channelManager
183 @misc_utils.log_exception(_moduleLogger)
186 For org.freedesktop.telepathy.Connection
188 if self._status != telepathy.CONNECTION_STATUS_DISCONNECTED:
189 _moduleLogger.info("Attempting connect when not disconnected")
191 _moduleLogger.info("Kicking off connect")
192 self._delayedConnect.start()
193 self._timedDisconnect.stop()
195 @misc_utils.log_exception(_moduleLogger)
196 def _delayed_connect(self):
197 _moduleLogger.info("Connecting...")
199 telepathy.CONNECTION_STATUS_CONNECTING,
200 telepathy.CONNECTION_STATUS_REASON_REQUESTED
203 self.__session.load(self.__cachePath)
205 for plumber in self._plumbing:
207 self.session.login(*self.__credentials)
208 if not self.__callbackNumberParameter:
209 callback = gvoice.backend.get_sane_callback(
212 self.__callbackNumberParameter = misc_utils.normalize_number(callback)
213 self.session.backend.set_callback_number(self.__callbackNumberParameter)
215 subscribeHandle = self.get_handle_by_name(telepathy.HANDLE_TYPE_LIST, "subscribe")
216 subscribeProps = self.generate_props(telepathy.CHANNEL_TYPE_CONTACT_LIST, subscribeHandle, False)
217 self.__channelManager.channel_for_props(subscribeProps, signal=True)
218 publishHandle = self.get_handle_by_name(telepathy.HANDLE_TYPE_LIST, "publish")
219 publishProps = self.generate_props(telepathy.CHANNEL_TYPE_CONTACT_LIST, publishHandle, False)
220 self.__channelManager.channel_for_props(publishProps, signal=True)
221 except gvoice.backend.NetworkError:
222 _moduleLogger.exception("Connection Failed")
223 self.disconnect(telepathy.CONNECTION_STATUS_REASON_NETWORK_ERROR)
226 _moduleLogger.exception("Connection Failed")
227 self.disconnect(telepathy.CONNECTION_STATUS_REASON_AUTHENTICATION_FAILED)
230 _moduleLogger.info("Connected")
232 telepathy.CONNECTION_STATUS_CONNECTED,
233 telepathy.CONNECTION_STATUS_REASON_REQUESTED
236 @misc_utils.log_exception(_moduleLogger)
237 def Disconnect(self):
239 For org.freedesktop.telepathy.Connection
241 _moduleLogger.info("Kicking off disconnect")
242 self.disconnect(telepathy.CONNECTION_STATUS_REASON_REQUESTED)
244 @misc_utils.log_exception(_moduleLogger)
245 def RequestChannel(self, type, handleType, handleId, suppressHandler):
247 For org.freedesktop.telepathy.Connection
249 @param type DBus interface name for base channel type
250 @param handleId represents a contact, list, etc according to handleType
252 @returns DBus object path for the channel created or retrieved
254 self.check_connected()
255 self.check_handle(handleType, handleId)
257 h = self.get_handle_by_id(handleType, handleId) if handleId != 0 else None
258 props = self.generate_props(type, h, suppressHandler)
259 self._validate_handle(props)
261 chan = self.__channelManager.channel_for_props(props, signal=True)
262 path = chan._object_path
263 _moduleLogger.info("RequestChannel Object Path (%s): %s" % (type.rsplit(".", 1)[-1], path))
266 def generate_props(self, channelType, handleObj, suppressHandler, initiatorHandle=None):
267 targetHandle = 0 if handleObj is None else handleObj.get_id()
268 targetHandleType = telepathy.HANDLE_TYPE_NONE if handleObj is None else handleObj.get_type()
270 telepathy.CHANNEL_INTERFACE + '.ChannelType': channelType,
271 telepathy.CHANNEL_INTERFACE + '.TargetHandle': targetHandle,
272 telepathy.CHANNEL_INTERFACE + '.TargetHandleType': targetHandleType,
273 telepathy.CHANNEL_INTERFACE + '.Requested': suppressHandler
276 if initiatorHandle is not None:
277 props[telepathy.CHANNEL_INTERFACE + '.InitiatorHandle'] = initiatorHandle.id
281 def disconnect(self, reason):
282 _moduleLogger.info("Disconnecting")
284 self._delayedConnect.cancel()
285 self._timedDisconnect.stop()
287 # Not having the disconnect first can cause weird behavior with clients
288 # including not being able to reconnect or even crashing
290 telepathy.CONNECTION_STATUS_DISCONNECTED,
294 for plumber in self._plumbing:
297 self.__channelManager.close()
298 self.manager.disconnected(self)
300 self.session.save(self.__cachePath)
301 self.session.logout()
304 _moduleLogger.info("Disconnected")