1 from __future__ import with_statement
15 from PyQt4 import QtCore
17 from util import qore_utils
18 from util import qui_utils
19 from util import concurrent
20 from util import misc as misc_utils
25 _moduleLogger = logging.getLogger(__name__)
28 class _DraftContact(object):
30 def __init__(self, title, description, numbersWithDescriptions):
32 self.description = description
33 self.numbers = numbersWithDescriptions
34 self.selectedNumber = numbersWithDescriptions[0][0]
37 class Draft(QtCore.QObject):
39 sendingMessage = QtCore.pyqtSignal()
40 sentMessage = QtCore.pyqtSignal()
41 calling = QtCore.pyqtSignal()
42 called = QtCore.pyqtSignal()
43 cancelling = QtCore.pyqtSignal()
44 cancelled = QtCore.pyqtSignal()
45 error = QtCore.pyqtSignal(str)
47 recipientsChanged = QtCore.pyqtSignal()
49 def __init__(self, pool, backend, errorLog):
50 QtCore.QObject.__init__(self)
51 self._errorLog = errorLog
54 self._backend = backend
55 self._busyReason = None
59 assert 0 < len(self._contacts), "No contacts selected"
60 assert 0 < len(self._message), "No message to send"
61 numbers = [misc_utils.make_ugly(contact.selectedNumber) for contact in self._contacts.itervalues()]
62 le = concurrent.AsyncLinearExecution(self._pool, self._send)
63 le.start(numbers, self._message)
66 assert len(self._contacts) == 1, "Must select 1 and only 1 contact"
67 assert len(self._message) == 0, "Cannot send message with call"
68 (contact, ) = self._contacts.itervalues()
69 number = misc_utils.make_ugly(contact.selectedNumber)
70 le = concurrent.AsyncLinearExecution(self._pool, self._call)
74 le = concurrent.AsyncLinearExecution(self._pool, self._cancel)
77 def _get_message(self):
80 def _set_message(self, message):
81 self._message = message
83 message = property(_get_message, _set_message)
85 def add_contact(self, contactId, title, description, numbersWithDescriptions):
86 if self._busyReason is not None:
87 raise RuntimeError("Please wait for %r" % self._busyReason)
88 if contactId in self._contacts:
89 _moduleLogger.info("Adding duplicate contact %r" % contactId)
90 # @todo Remove this evil hack to re-popup the dialog
91 self.recipientsChanged.emit()
93 contactDetails = _DraftContact(title, description, numbersWithDescriptions)
94 self._contacts[contactId] = contactDetails
95 self.recipientsChanged.emit()
97 def remove_contact(self, contactId):
98 if self._busyReason is not None:
99 raise RuntimeError("Please wait for %r" % self._busyReason)
100 assert contactId in self._contacts, "Contact missing"
101 del self._contacts[contactId]
102 self.recipientsChanged.emit()
104 def get_contacts(self):
105 return self._contacts.iterkeys()
107 def get_num_contacts(self):
108 return len(self._contacts)
110 def get_title(self, cid):
111 return self._contacts[cid].title
113 def get_description(self, cid):
114 return self._contacts[cid].description
116 def get_numbers(self, cid):
117 return self._contacts[cid].numbers
119 def get_selected_number(self, cid):
120 return self._contacts[cid].selectedNumber
122 def set_selected_number(self, cid, number):
123 # @note I'm lazy, this isn't firing any kind of signal since only one
124 # controller right now and that is the viewer
125 assert number in (nWD[0] for nWD in self._contacts[cid].numbers), "Number not selectable"
126 self._contacts[cid].selectedNumber = number
129 if self._busyReason is not None:
130 raise RuntimeError("Please wait for %r" % self._busyReason)
134 oldContacts = self._contacts
138 self.recipientsChanged.emit()
140 @contextlib.contextmanager
141 def _busy(self, message):
142 if self._busyReason is not None:
143 raise RuntimeError("Already busy doing %r" % self._busyReason)
145 self._busyReason = message
148 self._busyReason = None
150 def _send(self, numbers, text):
151 self.sendingMessage.emit()
153 with self._busy("Sending Text"):
154 with qui_utils.notify_busy(self._errorLog, "Sending Text"):
156 self._backend[0].send_sms,
160 self.sentMessage.emit()
163 _moduleLogger.exception("Reporting error to user")
164 self.error.emit(str(e))
166 def _call(self, number):
169 with self._busy("Calling"):
170 with qui_utils.notify_busy(self._errorLog, "Calling"):
172 self._backend[0].call,
179 _moduleLogger.exception("Reporting error to user")
180 self.error.emit(str(e))
183 self.cancelling.emit()
185 with qui_utils.notify_busy(self._errorLog, "Cancelling"):
187 self._backend[0].cancel,
191 self.cancelled.emit()
193 _moduleLogger.exception("Reporting error to user")
194 self.error.emit(str(e))
197 class Session(QtCore.QObject):
199 # @todo Somehow add support for csv contacts
201 stateChange = QtCore.pyqtSignal(str)
202 loggedOut = QtCore.pyqtSignal()
203 loggedIn = QtCore.pyqtSignal()
204 callbackNumberChanged = QtCore.pyqtSignal(str)
206 contactsUpdated = QtCore.pyqtSignal()
207 messagesUpdated = QtCore.pyqtSignal()
208 historyUpdated = QtCore.pyqtSignal()
209 dndStateChange = QtCore.pyqtSignal(bool)
211 error = QtCore.pyqtSignal(str)
213 LOGGEDOUT_STATE = "logged out"
214 LOGGINGIN_STATE = "logging in"
215 LOGGEDIN_STATE = "logged in"
217 _OLDEST_COMPATIBLE_FORMAT_VERSION = misc_utils.parse_version("1.1.90")
222 def __init__(self, errorLog, cachePath = None):
223 QtCore.QObject.__init__(self)
224 self._errorLog = errorLog
225 self._pool = qore_utils.AsyncPool()
227 self._loggedInTime = self._LOGGEDOUT_TIME
229 self._cachePath = cachePath
230 self._username = None
231 self._draft = Draft(self._pool, self._backend, self._errorLog)
234 self._contactUpdateTime = datetime.datetime(1971, 1, 1)
236 self._messageUpdateTime = datetime.datetime(1971, 1, 1)
238 self._historyUpdateTime = datetime.datetime(1971, 1, 1)
245 self._LOGGEDOUT_TIME: self.LOGGEDOUT_STATE,
246 self._LOGGINGIN_TIME: self.LOGGINGIN_STATE,
247 }.get(self._loggedInTime, self.LOGGEDIN_STATE)
253 def login(self, username, password):
254 assert self.state == self.LOGGEDOUT_STATE, "Can only log-in when logged out (currently %s" % self.state
255 assert username != "", "No username specified"
256 if self._cachePath is not None:
257 cookiePath = os.path.join(self._cachePath, "%s.cookies" % username)
261 if self._username != username or not self._backend:
262 from backends import gv_backend
264 self._backend[0:0] = [gv_backend.GVDialer(cookiePath)]
267 le = concurrent.AsyncLinearExecution(self._pool, self._login)
268 le.start(username, password)
271 assert self.state != self.LOGGEDOUT_STATE, "Can only logout if logged in (currently %s" % self.state
272 _moduleLogger.info("Logging out")
274 self._loggedInTime = self._LOGGEDOUT_TIME
275 self._backend[0].persist()
276 self._save_to_cache()
277 self.stateChange.emit(self.LOGGEDOUT_STATE)
278 self.loggedOut.emit()
281 assert self.state == self.LOGGEDOUT_STATE, "Can only clear when logged out (currently %s" % self.state
282 self._backend[0].logout()
287 def logout_and_clear(self):
288 assert self.state != self.LOGGEDOUT_STATE, "Can only logout if logged in (currently %s" % self.state
289 _moduleLogger.info("Logging out and clearing the account")
291 self._loggedInTime = self._LOGGEDOUT_TIME
293 self.stateChange.emit(self.LOGGEDOUT_STATE)
294 self.loggedOut.emit()
296 def update_contacts(self, force = True):
297 if not force and self._contacts:
299 le = concurrent.AsyncLinearExecution(self._pool, self._update_contacts)
300 self._perform_op_while_loggedin(le)
302 def get_contacts(self):
303 return self._contacts
305 def get_when_contacts_updated(self):
306 return self._contactUpdateTime
308 def update_messages(self, force = True):
309 if not force and self._messages:
311 le = concurrent.AsyncLinearExecution(self._pool, self._update_messages)
312 self._perform_op_while_loggedin(le)
314 def get_messages(self):
315 return self._messages
317 def get_when_messages_updated(self):
318 return self._messageUpdateTime
320 def update_history(self, force = True):
321 if not force and self._history:
323 le = concurrent.AsyncLinearExecution(self._pool, self._update_history)
324 self._perform_op_while_loggedin(le)
326 def get_history(self):
329 def get_when_history_updated(self):
330 return self._historyUpdateTime
332 def update_dnd(self):
333 le = concurrent.AsyncLinearExecution(self._pool, self._update_dnd)
334 self._perform_op_while_loggedin(le)
336 def set_dnd(self, dnd):
337 le = concurrent.AsyncLinearExecution(self._pool, self._set_dnd)
340 def _set_dnd(self, dnd):
343 assert self.state == self.LOGGEDIN_STATE, "DND requires being logged in (currently %s" % self.state
344 with qui_utils.notify_busy(self._errorLog, "Setting DND Status"):
346 self._backend[0].set_dnd,
351 _moduleLogger.exception("Reporting error to user")
352 self.error.emit(str(e))
355 if oldDnd != self._dnd:
356 self.dndStateChange.emit(self._dnd)
361 def get_account_number(self):
362 return self._backend[0].get_account_number()
364 def get_callback_numbers(self):
365 # @todo Remove evilness (might call is_authed which can block)
366 return self._backend[0].get_callback_numbers()
368 def get_callback_number(self):
369 return self._callback
371 def set_callback_number(self, callback):
372 le = concurrent.AsyncLinearExecution(self._pool, self._set_callback_number)
375 def _set_callback_number(self, callback):
376 oldCallback = self._callback
378 assert self.state == self.LOGGEDIN_STATE, "Callbacks configurable only when logged in (currently %s" % self.state
380 self._backend[0].set_callback_number,
385 _moduleLogger.exception("Reporting error to user")
386 self.error.emit(str(e))
388 self._callback = callback
389 if oldCallback != self._callback:
390 self.callbackNumberChanged.emit(self._callback)
392 def _login(self, username, password):
393 with qui_utils.notify_busy(self._errorLog, "Logging In"):
394 self._loggedInTime = self._LOGGINGIN_TIME
395 self.stateChange.emit(self.LOGGINGIN_STATE)
396 finalState = self.LOGGEDOUT_STATE
399 if not isLoggedIn and self._backend[0].is_quick_login_possible():
401 self._backend[0].is_authed,
406 _moduleLogger.info("Logged in through cookies")
408 # Force a clearing of the cookies
410 self._backend[0].logout,
417 self._backend[0].login,
418 (username, password),
422 _moduleLogger.info("Logged in through credentials")
425 self._loggedInTime = int(time.time())
426 oldUsername = self._username
427 self._username = username
428 finalState = self.LOGGEDIN_STATE
429 if oldUsername != self._username:
430 needOps = not self._load()
435 self.stateChange.emit(finalState)
436 finalState = None # Mark it as already set
439 loginOps = self._loginOps[:]
442 del self._loginOps[:]
443 for asyncOp in loginOps:
446 self._loggedInTime = self._LOGGEDOUT_TIME
447 self.error.emit("Error logging in")
449 self._loggedInTime = self._LOGGEDOUT_TIME
450 _moduleLogger.exception("Reporting error to user")
451 self.error.emit(str(e))
453 if finalState is not None:
454 self.stateChange.emit(finalState)
455 if isLoggedIn and self._callback:
456 self.set_callback_number(self._callback)
459 updateContacts = len(self._contacts) != 0
460 updateMessages = len(self._messages) != 0
461 updateHistory = len(self._history) != 0
463 oldCallback = self._callback
471 loadedFromCache = self._load_from_cache()
473 updateContacts = True
474 updateMessages = True
478 self.contactsUpdated.emit()
480 self.messagesUpdated.emit()
482 self.historyUpdated.emit()
483 if oldDnd != self._dnd:
484 self.dndStateChange.emit(self._dnd)
485 if oldCallback != self._callback:
486 self.callbackNumberChanged.emit(self._callback)
488 return loadedFromCache
490 def _load_from_cache(self):
491 if self._cachePath is None:
493 cachePath = os.path.join(self._cachePath, "%s.cache" % self._username)
496 with open(cachePath, "rb") as f:
497 dumpedData = pickle.load(f)
498 except (pickle.PickleError, IOError, EOFError, ValueError):
499 _moduleLogger.exception("Pickle fun loading")
502 _moduleLogger.exception("Weirdness loading")
507 contacts, contactUpdateTime,
508 messages, messageUpdateTime,
509 history, historyUpdateTime,
513 if misc_utils.compare_versions(
514 self._OLDEST_COMPATIBLE_FORMAT_VERSION,
515 misc_utils.parse_version(version),
517 _moduleLogger.info("Loaded cache")
518 self._contacts = contacts
519 self._contactUpdateTime = contactUpdateTime
520 self._messages = messages
521 self._messageUpdateTime = messageUpdateTime
522 self._history = history
523 self._historyUpdateTime = historyUpdateTime
525 self._callback = callback
529 "Skipping cache due to version mismatch (%s-%s)" % (
535 def _save_to_cache(self):
536 _moduleLogger.info("Saving cache")
537 if self._cachePath is None:
539 cachePath = os.path.join(self._cachePath, "%s.cache" % self._username)
543 constants.__version__, constants.__build__,
544 self._contacts, self._contactUpdateTime,
545 self._messages, self._messageUpdateTime,
546 self._history, self._historyUpdateTime,
547 self._dnd, self._callback
549 with open(cachePath, "wb") as f:
550 pickle.dump(dataToDump, f, pickle.HIGHEST_PROTOCOL)
551 _moduleLogger.info("Cache saved")
552 except (pickle.PickleError, IOError):
553 _moduleLogger.exception("While saving")
555 def _clear_cache(self):
556 updateContacts = len(self._contacts) != 0
557 updateMessages = len(self._messages) != 0
558 updateHistory = len(self._history) != 0
560 oldCallback = self._callback
563 self._contactUpdateTime = datetime.datetime(1971, 1, 1)
565 self._messageUpdateTime = datetime.datetime(1971, 1, 1)
567 self._historyUpdateTime = datetime.datetime(1971, 1, 1)
572 self.contactsUpdated.emit()
574 self.messagesUpdated.emit()
576 self.historyUpdated.emit()
577 if oldDnd != self._dnd:
578 self.dndStateChange.emit(self._dnd)
579 if oldCallback != self._callback:
580 self.callbackNumberChanged.emit(self._callback)
582 self._save_to_cache()
584 def _update_contacts(self):
586 assert self.state == self.LOGGEDIN_STATE, "Contacts requires being logged in (currently %s" % self.state
587 with qui_utils.notify_busy(self._errorLog, "Updating Contacts"):
588 self._contacts = yield (
589 self._backend[0].get_contacts,
594 _moduleLogger.exception("Reporting error to user")
595 self.error.emit(str(e))
597 self._contactUpdateTime = datetime.datetime.now()
598 self.contactsUpdated.emit()
600 def _update_messages(self):
602 assert self.state == self.LOGGEDIN_STATE, "Messages requires being logged in (currently %s" % self.state
603 with qui_utils.notify_busy(self._errorLog, "Updating Messages"):
604 self._messages = yield (
605 self._backend[0].get_messages,
610 _moduleLogger.exception("Reporting error to user")
611 self.error.emit(str(e))
613 self._messageUpdateTime = datetime.datetime.now()
614 self.messagesUpdated.emit()
616 def _update_history(self):
618 assert self.state == self.LOGGEDIN_STATE, "History requires being logged in (currently %s" % self.state
619 with qui_utils.notify_busy(self._errorLog, "Updating History"):
620 self._history = yield (
621 self._backend[0].get_recent,
626 _moduleLogger.exception("Reporting error to user")
627 self.error.emit(str(e))
629 self._historyUpdateTime = datetime.datetime.now()
630 self.historyUpdated.emit()
632 def _update_dnd(self):
635 assert self.state == self.LOGGEDIN_STATE, "DND requires being logged in (currently %s" % self.state
637 self._backend[0].is_dnd,
642 _moduleLogger.exception("Reporting error to user")
643 self.error.emit(str(e))
645 if oldDnd != self._dnd:
646 self.dndStateChange(self._dnd)
648 def _perform_op_while_loggedin(self, op):
649 if self.state == self.LOGGEDIN_STATE:
652 self._push_login_op(op)
654 def _push_login_op(self, asyncOp):
655 assert self.state != self.LOGGEDIN_STATE, "Can only queue work when logged out"
656 if asyncOp in self._loginOps:
657 _moduleLogger.info("Skipping queueing duplicate op: %r" % asyncOp)
659 self._loginOps.append(asyncOp)