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 # Allow overwriting of contacts so that the message can be updated and the SMS dialog popped back up
89 contactDetails = _DraftContact(title, description, numbersWithDescriptions)
90 self._contacts[contactId] = contactDetails
91 self.recipientsChanged.emit()
93 def remove_contact(self, contactId):
94 if self._busyReason is not None:
95 raise RuntimeError("Please wait for %r" % self._busyReason)
96 assert contactId in self._contacts, "Contact missing"
97 del self._contacts[contactId]
98 self.recipientsChanged.emit()
100 def get_contacts(self):
101 return self._contacts.iterkeys()
103 def get_num_contacts(self):
104 return len(self._contacts)
106 def get_title(self, cid):
107 return self._contacts[cid].title
109 def get_description(self, cid):
110 return self._contacts[cid].description
112 def get_numbers(self, cid):
113 return self._contacts[cid].numbers
115 def get_selected_number(self, cid):
116 return self._contacts[cid].selectedNumber
118 def set_selected_number(self, cid, number):
119 # @note I'm lazy, this isn't firing any kind of signal since only one
120 # controller right now and that is the viewer
121 assert number in (nWD[0] for nWD in self._contacts[cid].numbers), "Number not selectable"
122 self._contacts[cid].selectedNumber = number
125 if self._busyReason is not None:
126 raise RuntimeError("Please wait for %r" % self._busyReason)
130 oldContacts = self._contacts
134 self.recipientsChanged.emit()
136 @contextlib.contextmanager
137 def _busy(self, message):
138 if self._busyReason is not None:
139 raise RuntimeError("Already busy doing %r" % self._busyReason)
141 self._busyReason = message
144 self._busyReason = None
146 def _send(self, numbers, text):
147 self.sendingMessage.emit()
149 with self._busy("Sending Text"):
150 with qui_utils.notify_busy(self._errorLog, "Sending Text"):
152 self._backend[0].send_sms,
156 self.sentMessage.emit()
159 _moduleLogger.exception("Reporting error to user")
160 self.error.emit(str(e))
162 def _call(self, number):
165 with self._busy("Calling"):
166 with qui_utils.notify_busy(self._errorLog, "Calling"):
168 self._backend[0].call,
175 _moduleLogger.exception("Reporting error to user")
176 self.error.emit(str(e))
179 self.cancelling.emit()
181 with qui_utils.notify_busy(self._errorLog, "Cancelling"):
183 self._backend[0].cancel,
187 self.cancelled.emit()
189 _moduleLogger.exception("Reporting error to user")
190 self.error.emit(str(e))
193 class Session(QtCore.QObject):
195 # @todo Somehow add support for csv contacts
196 # @BUG When loading without caches, downloads messages twice
198 stateChange = QtCore.pyqtSignal(str)
199 loggedOut = QtCore.pyqtSignal()
200 loggedIn = QtCore.pyqtSignal()
201 callbackNumberChanged = QtCore.pyqtSignal(str)
203 contactsUpdated = QtCore.pyqtSignal()
204 messagesUpdated = QtCore.pyqtSignal()
205 historyUpdated = QtCore.pyqtSignal()
206 dndStateChange = QtCore.pyqtSignal(bool)
208 error = QtCore.pyqtSignal(str)
210 LOGGEDOUT_STATE = "logged out"
211 LOGGINGIN_STATE = "logging in"
212 LOGGEDIN_STATE = "logged in"
214 _OLDEST_COMPATIBLE_FORMAT_VERSION = misc_utils.parse_version("1.1.90")
219 def __init__(self, errorLog, cachePath = None):
220 QtCore.QObject.__init__(self)
221 self._errorLog = errorLog
222 self._pool = qore_utils.AsyncPool()
224 self._loggedInTime = self._LOGGEDOUT_TIME
226 self._cachePath = cachePath
227 self._username = None
228 self._draft = Draft(self._pool, self._backend, self._errorLog)
231 self._contactUpdateTime = datetime.datetime(1971, 1, 1)
233 self._messageUpdateTime = datetime.datetime(1971, 1, 1)
235 self._historyUpdateTime = datetime.datetime(1971, 1, 1)
242 self._LOGGEDOUT_TIME: self.LOGGEDOUT_STATE,
243 self._LOGGINGIN_TIME: self.LOGGINGIN_STATE,
244 }.get(self._loggedInTime, self.LOGGEDIN_STATE)
250 def login(self, username, password):
251 assert self.state == self.LOGGEDOUT_STATE, "Can only log-in when logged out (currently %s" % self.state
252 assert username != "", "No username specified"
253 if self._cachePath is not None:
254 cookiePath = os.path.join(self._cachePath, "%s.cookies" % username)
258 if self._username != username or not self._backend:
259 from backends import gv_backend
261 self._backend[0:0] = [gv_backend.GVDialer(cookiePath)]
264 le = concurrent.AsyncLinearExecution(self._pool, self._login)
265 le.start(username, password)
268 assert self.state != self.LOGGEDOUT_STATE, "Can only logout if logged in (currently %s" % self.state
269 _moduleLogger.info("Logging out")
271 self._loggedInTime = self._LOGGEDOUT_TIME
272 self._backend[0].persist()
273 self._save_to_cache()
274 self.stateChange.emit(self.LOGGEDOUT_STATE)
275 self.loggedOut.emit()
278 assert self.state == self.LOGGEDOUT_STATE, "Can only clear when logged out (currently %s" % self.state
279 self._backend[0].logout()
284 def logout_and_clear(self):
285 assert self.state != self.LOGGEDOUT_STATE, "Can only logout if logged in (currently %s" % self.state
286 _moduleLogger.info("Logging out and clearing the account")
288 self._loggedInTime = self._LOGGEDOUT_TIME
290 self.stateChange.emit(self.LOGGEDOUT_STATE)
291 self.loggedOut.emit()
293 def update_contacts(self, force = True):
294 if not force and self._contacts:
296 le = concurrent.AsyncLinearExecution(self._pool, self._update_contacts)
297 self._perform_op_while_loggedin(le)
299 def get_contacts(self):
300 return self._contacts
302 def get_when_contacts_updated(self):
303 return self._contactUpdateTime
305 def update_messages(self, force = True):
306 if not force and self._messages:
308 le = concurrent.AsyncLinearExecution(self._pool, self._update_messages)
309 self._perform_op_while_loggedin(le)
311 def get_messages(self):
312 return self._messages
314 def get_when_messages_updated(self):
315 return self._messageUpdateTime
317 def update_history(self, force = True):
318 if not force and self._history:
320 le = concurrent.AsyncLinearExecution(self._pool, self._update_history)
321 self._perform_op_while_loggedin(le)
323 def get_history(self):
326 def get_when_history_updated(self):
327 return self._historyUpdateTime
329 def update_dnd(self):
330 le = concurrent.AsyncLinearExecution(self._pool, self._update_dnd)
331 self._perform_op_while_loggedin(le)
333 def set_dnd(self, dnd):
334 le = concurrent.AsyncLinearExecution(self._pool, self._set_dnd)
337 def _set_dnd(self, dnd):
340 assert self.state == self.LOGGEDIN_STATE, "DND requires being logged in (currently %s" % self.state
341 with qui_utils.notify_busy(self._errorLog, "Setting DND Status"):
343 self._backend[0].set_dnd,
348 _moduleLogger.exception("Reporting error to user")
349 self.error.emit(str(e))
352 if oldDnd != self._dnd:
353 self.dndStateChange.emit(self._dnd)
358 def get_account_number(self):
359 if self.state != self.LOGGEDIN_STATE:
361 return self._backend[0].get_account_number()
363 def get_callback_numbers(self):
364 if self.state != self.LOGGEDIN_STATE:
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")
508 contacts, contactUpdateTime,
509 messages, messageUpdateTime,
510 history, historyUpdateTime,
514 _moduleLogger.exception("Upgrade/downgrade fun")
517 _moduleLogger.exception("Weirdlings")
519 if misc_utils.compare_versions(
520 self._OLDEST_COMPATIBLE_FORMAT_VERSION,
521 misc_utils.parse_version(version),
523 _moduleLogger.info("Loaded cache")
524 self._contacts = contacts
525 self._contactUpdateTime = contactUpdateTime
526 self._messages = messages
527 self._messageUpdateTime = messageUpdateTime
528 self._history = history
529 self._historyUpdateTime = historyUpdateTime
531 self._callback = callback
535 "Skipping cache due to version mismatch (%s-%s)" % (
541 def _save_to_cache(self):
542 _moduleLogger.info("Saving cache")
543 if self._cachePath is None:
545 cachePath = os.path.join(self._cachePath, "%s.cache" % self._username)
549 constants.__version__, constants.__build__,
550 self._contacts, self._contactUpdateTime,
551 self._messages, self._messageUpdateTime,
552 self._history, self._historyUpdateTime,
553 self._dnd, self._callback
555 with open(cachePath, "wb") as f:
556 pickle.dump(dataToDump, f, pickle.HIGHEST_PROTOCOL)
557 _moduleLogger.info("Cache saved")
558 except (pickle.PickleError, IOError):
559 _moduleLogger.exception("While saving")
561 def _clear_cache(self):
562 updateContacts = len(self._contacts) != 0
563 updateMessages = len(self._messages) != 0
564 updateHistory = len(self._history) != 0
566 oldCallback = self._callback
569 self._contactUpdateTime = datetime.datetime(1971, 1, 1)
571 self._messageUpdateTime = datetime.datetime(1971, 1, 1)
573 self._historyUpdateTime = datetime.datetime(1971, 1, 1)
578 self.contactsUpdated.emit()
580 self.messagesUpdated.emit()
582 self.historyUpdated.emit()
583 if oldDnd != self._dnd:
584 self.dndStateChange.emit(self._dnd)
585 if oldCallback != self._callback:
586 self.callbackNumberChanged.emit(self._callback)
588 self._save_to_cache()
590 def _update_contacts(self):
592 assert self.state == self.LOGGEDIN_STATE, "Contacts requires being logged in (currently %s" % self.state
593 with qui_utils.notify_busy(self._errorLog, "Updating Contacts"):
594 self._contacts = yield (
595 self._backend[0].get_contacts,
600 _moduleLogger.exception("Reporting error to user")
601 self.error.emit(str(e))
603 self._contactUpdateTime = datetime.datetime.now()
604 self.contactsUpdated.emit()
606 def _update_messages(self):
608 assert self.state == self.LOGGEDIN_STATE, "Messages requires being logged in (currently %s" % self.state
609 with qui_utils.notify_busy(self._errorLog, "Updating Messages"):
610 self._messages = yield (
611 self._backend[0].get_messages,
616 _moduleLogger.exception("Reporting error to user")
617 self.error.emit(str(e))
619 self._messageUpdateTime = datetime.datetime.now()
620 self.messagesUpdated.emit()
622 def _update_history(self):
624 assert self.state == self.LOGGEDIN_STATE, "History requires being logged in (currently %s" % self.state
625 with qui_utils.notify_busy(self._errorLog, "Updating History"):
626 self._history = yield (
627 self._backend[0].get_recent,
632 _moduleLogger.exception("Reporting error to user")
633 self.error.emit(str(e))
635 self._historyUpdateTime = datetime.datetime.now()
636 self.historyUpdated.emit()
638 def _update_dnd(self):
641 assert self.state == self.LOGGEDIN_STATE, "DND requires being logged in (currently %s" % self.state
643 self._backend[0].is_dnd,
648 _moduleLogger.exception("Reporting error to user")
649 self.error.emit(str(e))
651 if oldDnd != self._dnd:
652 self.dndStateChange(self._dnd)
654 def _perform_op_while_loggedin(self, op):
655 if self.state == self.LOGGEDIN_STATE:
658 self._push_login_op(op)
660 def _push_login_op(self, asyncOp):
661 assert self.state != self.LOGGEDIN_STATE, "Can only queue work when logged out"
662 if asyncOp in self._loginOps:
663 _moduleLogger.info("Skipping queueing duplicate op: %r" % asyncOp)
665 self._loginOps.append(asyncOp)