Fixing some errors seen when account is cleared
[gc-dialer] / src / session.py
index afebf93..a50245a 100644 (file)
@@ -1,13 +1,25 @@
+from __future__ import with_statement
+
 import os
 import time
+import datetime
+import contextlib
 import logging
 
+try:
+       import cPickle
+       pickle = cPickle
+except ImportError:
+       import pickle
+
 from PyQt4 import QtCore
 
 from util import qore_utils
+from util import qui_utils
 from util import concurrent
+from util import misc as misc_utils
 
-from backends import gv_backend
+import constants
 
 
 _moduleLogger = logging.getLogger(__name__)
@@ -34,33 +46,58 @@ class Draft(QtCore.QObject):
 
        recipientsChanged = QtCore.pyqtSignal()
 
-       def __init__(self, pool):
+       def __init__(self, pool, backend, errorLog):
                QtCore.QObject.__init__(self)
+               self._errorLog = errorLog
                self._contacts = {}
                self._pool = pool
-
-       def send(self, text):
-               assert 0 < len(self._contacts)
+               self._backend = backend
+               self._busyReason = None
+               self._message = ""
+
+       def send(self):
+               assert 0 < len(self._contacts), "No contacts selected"
+               assert 0 < len(self._message), "No message to send"
+               numbers = [misc_utils.make_ugly(contact.selectedNumber) for contact in self._contacts.itervalues()]
                le = concurrent.AsyncLinearExecution(self._pool, self._send)
-               le.start(text)
+               le.start(numbers, self._message)
 
        def call(self):
-               assert len(self._contacts) == 1
+               assert len(self._contacts) == 1, "Must select 1 and only 1 contact"
+               assert len(self._message) == 0, "Cannot send message with call"
+               (contact, ) = self._contacts.itervalues()
+               number = misc_utils.make_ugly(contact.selectedNumber)
                le = concurrent.AsyncLinearExecution(self._pool, self._call)
-               le.start()
+               le.start(number)
 
        def cancel(self):
                le = concurrent.AsyncLinearExecution(self._pool, self._cancel)
                le.start()
 
+       def _get_message(self):
+               return self._message
+
+       def _set_message(self, message):
+               self._message = message
+
+       message = property(_get_message, _set_message)
+
        def add_contact(self, contactId, title, description, numbersWithDescriptions):
-               assert contactId not in self._contacts
+               if self._busyReason is not None:
+                       raise RuntimeError("Please wait for %r" % self._busyReason)
+               if contactId in self._contacts:
+                       _moduleLogger.info("Adding duplicate contact %r" % contactId)
+                       # @todo Remove this evil hack to re-popup the dialog
+                       self.recipientsChanged.emit()
+                       return
                contactDetails = _DraftContact(title, description, numbersWithDescriptions)
                self._contacts[contactId] = contactDetails
                self.recipientsChanged.emit()
 
        def remove_contact(self, contactId):
-               assert contactId in self._contacts
+               if self._busyReason is not None:
+                       raise RuntimeError("Please wait for %r" % self._busyReason)
+               assert contactId in self._contacts, "Contact missing"
                del self._contacts[contactId]
                self.recipientsChanged.emit()
 
@@ -85,47 +122,82 @@ class Draft(QtCore.QObject):
        def set_selected_number(self, cid, number):
                # @note I'm lazy, this isn't firing any kind of signal since only one
                # controller right now and that is the viewer
-               return self._contacts[cid].numbers
+               assert number in (nWD[0] for nWD in self._contacts[cid].numbers), "Number not selectable"
+               self._contacts[cid].selectedNumber = number
 
        def clear(self):
+               if self._busyReason is not None:
+                       raise RuntimeError("Please wait for %r" % self._busyReason)
+               self._clear()
+
+       def _clear(self):
                oldContacts = self._contacts
                self._contacts = {}
+               self._message = ""
                if oldContacts:
                        self.recipientsChanged.emit()
 
-       def _send(self, text):
+       @contextlib.contextmanager
+       def _busy(self, message):
+               if self._busyReason is not None:
+                       raise RuntimeError("Already busy doing %r" % self._busyReason)
+               try:
+                       self._busyReason = message
+                       yield
+               finally:
+                       self._busyReason = None
+
+       def _send(self, numbers, text):
                self.sendingMessage.emit()
                try:
-                       self.error.emit("Not Implemented")
-                       self.sentMessage.emit()
-                       self.clear()
+                       with self._busy("Sending Text"):
+                               with qui_utils.notify_busy(self._errorLog, "Sending Text"):
+                                       yield (
+                                               self._backend[0].send_sms,
+                                               (numbers, text),
+                                               {},
+                                       )
+                               self.sentMessage.emit()
+                               self._clear()
                except Exception, e:
+                       _moduleLogger.exception("Reporting error to user")
                        self.error.emit(str(e))
 
-       def _call(self):
+       def _call(self, number):
                self.calling.emit()
                try:
-                       self.error.emit("Not Implemented")
-                       self.called.emit()
-                       self.clear()
+                       with self._busy("Calling"):
+                               with qui_utils.notify_busy(self._errorLog, "Calling"):
+                                       yield (
+                                               self._backend[0].call,
+                                               (number, ),
+                                               {},
+                                       )
+                               self.called.emit()
+                               self._clear()
                except Exception, e:
+                       _moduleLogger.exception("Reporting error to user")
                        self.error.emit(str(e))
 
        def _cancel(self):
                self.cancelling.emit()
                try:
-                       yield (
-                               self._backend.cancel,
-                               (),
-                               {},
-                       )
+                       with qui_utils.notify_busy(self._errorLog, "Cancelling"):
+                               yield (
+                                       self._backend[0].cancel,
+                                       (),
+                                       {},
+                               )
                        self.cancelled.emit()
                except Exception, e:
+                       _moduleLogger.exception("Reporting error to user")
                        self.error.emit(str(e))
 
 
 class Session(QtCore.QObject):
 
+       # @todo Somehow add support for csv contacts
+
        stateChange = QtCore.pyqtSignal(str)
        loggedOut = QtCore.pyqtSignal()
        loggedIn = QtCore.pyqtSignal()
@@ -142,22 +214,28 @@ class Session(QtCore.QObject):
        LOGGINGIN_STATE = "logging in"
        LOGGEDIN_STATE = "logged in"
 
+       _OLDEST_COMPATIBLE_FORMAT_VERSION = misc_utils.parse_version("1.1.90")
+
        _LOGGEDOUT_TIME = -1
        _LOGGINGIN_TIME = 0
 
-       def __init__(self, cachePath = None):
+       def __init__(self, errorLog, cachePath = None):
                QtCore.QObject.__init__(self)
+               self._errorLog = errorLog
                self._pool = qore_utils.AsyncPool()
-               self._backend = None
+               self._backend = []
                self._loggedInTime = self._LOGGEDOUT_TIME
                self._loginOps = []
                self._cachePath = cachePath
                self._username = None
-               self._draft = Draft(self._pool)
+               self._draft = Draft(self._pool, self._backend, self._errorLog)
 
                self._contacts = {}
+               self._contactUpdateTime = datetime.datetime(1971, 1, 1)
                self._messages = []
+               self._messageUpdateTime = datetime.datetime(1971, 1, 1)
                self._history = []
+               self._historyUpdateTime = datetime.datetime(1971, 1, 1)
                self._dnd = False
                self._callback = ""
 
@@ -173,77 +251,104 @@ class Session(QtCore.QObject):
                return self._draft
 
        def login(self, username, password):
-               assert self.state == self.LOGGEDOUT_STATE
-               assert username != ""
+               assert self.state == self.LOGGEDOUT_STATE, "Can only log-in when logged out (currently %s" % self.state
+               assert username != "", "No username specified"
                if self._cachePath is not None:
                        cookiePath = os.path.join(self._cachePath, "%s.cookies" % username)
                else:
                        cookiePath = None
 
-               if self._username != username or self._backend is None:
-                       self._backend = gv_backend.GVDialer(cookiePath)
+               if self._username != username or not self._backend:
+                       from backends import gv_backend
+                       del self._backend[:]
+                       self._backend[0:0] = [gv_backend.GVDialer(cookiePath)]
 
                self._pool.start()
                le = concurrent.AsyncLinearExecution(self._pool, self._login)
                le.start(username, password)
 
        def logout(self):
-               assert self.state != self.LOGGEDOUT_STATE
+               assert self.state != self.LOGGEDOUT_STATE, "Can only logout if logged in (currently %s" % self.state
+               _moduleLogger.info("Logging out")
                self._pool.stop()
                self._loggedInTime = self._LOGGEDOUT_TIME
-               self._backend.persist()
+               self._backend[0].persist()
                self._save_to_cache()
+               self.stateChange.emit(self.LOGGEDOUT_STATE)
+               self.loggedOut.emit()
 
        def clear(self):
-               assert self.state == self.LOGGEDOUT_STATE
-               self._backend.logout()
-               self._backend = None
+               assert self.state == self.LOGGEDOUT_STATE, "Can only clear when logged out (currently %s" % self.state
+               self._backend[0].logout()
+               del self._backend[0]
                self._clear_cache()
                self._draft.clear()
 
        def logout_and_clear(self):
-               assert self.state != self.LOGGEDOUT_STATE
+               assert self.state != self.LOGGEDOUT_STATE, "Can only logout if logged in (currently %s" % self.state
+               _moduleLogger.info("Logging out and clearing the account")
                self._pool.stop()
                self._loggedInTime = self._LOGGEDOUT_TIME
                self.clear()
+               self.stateChange.emit(self.LOGGEDOUT_STATE)
+               self.loggedOut.emit()
 
-       def update_contacts(self):
+       def update_contacts(self, force = True):
+               if not force and self._contacts:
+                       return
                le = concurrent.AsyncLinearExecution(self._pool, self._update_contacts)
                self._perform_op_while_loggedin(le)
 
        def get_contacts(self):
                return self._contacts
 
-       def update_messages(self):
+       def get_when_contacts_updated(self):
+               return self._contactUpdateTime
+
+       def update_messages(self, force = True):
+               if not force and self._messages:
+                       return
                le = concurrent.AsyncLinearExecution(self._pool, self._update_messages)
                self._perform_op_while_loggedin(le)
 
        def get_messages(self):
                return self._messages
 
-       def update_history(self):
+       def get_when_messages_updated(self):
+               return self._messageUpdateTime
+
+       def update_history(self, force = True):
+               if not force and self._history:
+                       return
                le = concurrent.AsyncLinearExecution(self._pool, self._update_history)
                self._perform_op_while_loggedin(le)
 
        def get_history(self):
                return self._history
 
+       def get_when_history_updated(self):
+               return self._historyUpdateTime
+
        def update_dnd(self):
                le = concurrent.AsyncLinearExecution(self._pool, self._update_dnd)
                self._perform_op_while_loggedin(le)
 
        def set_dnd(self, dnd):
-               # I'm paranoid about our state geting out of sync so we set no matter
-               # what but act as if we have the cannonical state
-               assert self.state == self.LOGGEDIN_STATE
+               le = concurrent.AsyncLinearExecution(self._pool, self._set_dnd)
+               le.start(dnd)
+
+       def _set_dnd(self, dnd):
                oldDnd = self._dnd
                try:
-                       yield (
-                               self._backend.set_dnd,
-                               (dnd),
-                               {},
-                       )
+                       assert self.state == self.LOGGEDIN_STATE, "DND requires being logged in (currently %s" % self.state
+                       with qui_utils.notify_busy(self._errorLog, "Setting DND Status"):
+                               yield (
+                                       self._backend[0].set_dnd,
+                                       (dnd, ),
+                                       {},
+                               )
                except Exception, e:
+                       _moduleLogger.exception("Reporting error to user")
                        self.error.emit(str(e))
                        return
                self._dnd = dnd
@@ -253,25 +358,34 @@ class Session(QtCore.QObject):
        def get_dnd(self):
                return self._dnd
 
+       def get_account_number(self):
+               if self.state != self.LOGGEDIN_STATE:
+                       return ""
+               return self._backend[0].get_account_number()
+
        def get_callback_numbers(self):
-               # @todo Remove evilness
-               return self._backend.get_callback_numbers()
+               if self.state != self.LOGGEDIN_STATE:
+                       return {}
+               return self._backend[0].get_callback_numbers()
 
        def get_callback_number(self):
                return self._callback
 
        def set_callback_number(self, callback):
-               # I'm paranoid about our state geting out of sync so we set no matter
-               # what but act as if we have the cannonical state
-               assert self.state == self.LOGGEDIN_STATE
+               le = concurrent.AsyncLinearExecution(self._pool, self._set_callback_number)
+               le.start(callback)
+
+       def _set_callback_number(self, callback):
                oldCallback = self._callback
                try:
+                       assert self.state == self.LOGGEDIN_STATE, "Callbacks configurable only when logged in (currently %s" % self.state
                        yield (
-                               self._backend.set_callback_number,
-                               (callback),
+                               self._backend[0].set_callback_number,
+                               (callback, ),
                                {},
                        )
                except Exception, e:
+                       _moduleLogger.exception("Reporting error to user")
                        self.error.emit(str(e))
                        return
                self._callback = callback
@@ -279,55 +393,72 @@ class Session(QtCore.QObject):
                        self.callbackNumberChanged.emit(self._callback)
 
        def _login(self, username, password):
-               self._loggedInTime = self._LOGGINGIN_TIME
-               self.stateChange.emit(self.LOGGINGIN_STATE)
-               finalState = self.LOGGEDOUT_STATE
-               try:
+               with qui_utils.notify_busy(self._errorLog, "Logging In"):
+                       self._loggedInTime = self._LOGGINGIN_TIME
+                       self.stateChange.emit(self.LOGGINGIN_STATE)
+                       finalState = self.LOGGEDOUT_STATE
                        isLoggedIn = False
-
-                       if not isLoggedIn and self._backend.is_quick_login_possible():
-                               isLoggedIn = yield (
-                                       self._backend.is_authed,
-                                       (),
-                                       {},
-                               )
-                               if isLoggedIn:
-                                       _moduleLogger.info("Logged in through cookies")
-                               else:
-                                       # Force a clearing of the cookies
-                                       yield (
-                                               self._backend.logout,
+                       try:
+                               if not isLoggedIn and self._backend[0].is_quick_login_possible():
+                                       isLoggedIn = yield (
+                                               self._backend[0].is_authed,
                                                (),
                                                {},
                                        )
+                                       if isLoggedIn:
+                                               _moduleLogger.info("Logged in through cookies")
+                                       else:
+                                               # Force a clearing of the cookies
+                                               yield (
+                                                       self._backend[0].logout,
+                                                       (),
+                                                       {},
+                                               )
+
+                               if not isLoggedIn:
+                                       isLoggedIn = yield (
+                                               self._backend[0].login,
+                                               (username, password),
+                                               {},
+                                       )
+                                       if isLoggedIn:
+                                               _moduleLogger.info("Logged in through credentials")
 
-                       if not isLoggedIn:
-                               isLoggedIn = yield (
-                                       self._backend.login,
-                                       (username, password),
-                                       {},
-                               )
                                if isLoggedIn:
-                                       _moduleLogger.info("Logged in through credentials")
-
-                       if isLoggedIn:
-                               self._loggedInTime = int(time.time())
-                               oldUsername = self._username
-                               self._username = username
-                               finalState = self.LOGGEDIN_STATE
-                               self.loggedIn.emit()
-                               if oldUsername != self._username:
-                                       self._load_from_cache()
-                               loginOps = self._loginOps[:]
-                               del self._loginOps[:]
-                               for asyncOp in loginOps:
-                                       asyncOp.start()
-               except Exception, e:
-                       self.error.emit(str(e))
-               finally:
-                       self.stateChange.emit(finalState)
-
-       def _load_from_cache(self):
+                                       self._loggedInTime = int(time.time())
+                                       oldUsername = self._username
+                                       self._username = username
+                                       finalState = self.LOGGEDIN_STATE
+                                       if oldUsername != self._username:
+                                               needOps = not self._load()
+                                       else:
+                                               needOps = True
+
+                                       self.loggedIn.emit()
+                                       self.stateChange.emit(finalState)
+                                       finalState = None # Mark it as already set
+
+                                       if needOps:
+                                               loginOps = self._loginOps[:]
+                                       else:
+                                               loginOps = []
+                                       del self._loginOps[:]
+                                       for asyncOp in loginOps:
+                                               asyncOp.start()
+                               else:
+                                       self._loggedInTime = self._LOGGEDOUT_TIME
+                                       self.error.emit("Error logging in")
+                       except Exception, e:
+                               self._loggedInTime = self._LOGGEDOUT_TIME
+                               _moduleLogger.exception("Reporting error to user")
+                               self.error.emit(str(e))
+                       finally:
+                               if finalState is not None:
+                                       self.stateChange.emit(finalState)
+                       if isLoggedIn and self._callback:
+                               self.set_callback_number(self._callback)
+
+       def _load(self):
                updateContacts = len(self._contacts) != 0
                updateMessages = len(self._messages) != 0
                updateHistory = len(self._history) != 0
@@ -340,6 +471,12 @@ class Session(QtCore.QObject):
                self._dnd = False
                self._callback = ""
 
+               loadedFromCache = self._load_from_cache()
+               if loadedFromCache:
+                       updateContacts = True
+                       updateMessages = True
+                       updateHistory = True
+
                if updateContacts:
                        self.contactsUpdated.emit()
                if updateMessages:
@@ -351,9 +488,72 @@ class Session(QtCore.QObject):
                if oldCallback != self._callback:
                        self.callbackNumberChanged.emit(self._callback)
 
+               return loadedFromCache
+
+       def _load_from_cache(self):
+               if self._cachePath is None:
+                       return False
+               cachePath = os.path.join(self._cachePath, "%s.cache" % self._username)
+
+               try:
+                       with open(cachePath, "rb") as f:
+                               dumpedData = pickle.load(f)
+               except (pickle.PickleError, IOError, EOFError, ValueError):
+                       _moduleLogger.exception("Pickle fun loading")
+                       return False
+               except:
+                       _moduleLogger.exception("Weirdness loading")
+                       return False
+
+               (
+                       version, build,
+                       contacts, contactUpdateTime,
+                       messages, messageUpdateTime,
+                       history, historyUpdateTime,
+                       dnd, callback
+               ) = dumpedData
+
+               if misc_utils.compare_versions(
+                       self._OLDEST_COMPATIBLE_FORMAT_VERSION,
+                       misc_utils.parse_version(version),
+               ) <= 0:
+                       _moduleLogger.info("Loaded cache")
+                       self._contacts = contacts
+                       self._contactUpdateTime = contactUpdateTime
+                       self._messages = messages
+                       self._messageUpdateTime = messageUpdateTime
+                       self._history = history
+                       self._historyUpdateTime = historyUpdateTime
+                       self._dnd = dnd
+                       self._callback = callback
+                       return True
+               else:
+                       _moduleLogger.debug(
+                               "Skipping cache due to version mismatch (%s-%s)" % (
+                                       version, build
+                               )
+                       )
+                       return False
+
        def _save_to_cache(self):
-               # @todo
-               pass
+               _moduleLogger.info("Saving cache")
+               if self._cachePath is None:
+                       return
+               cachePath = os.path.join(self._cachePath, "%s.cache" % self._username)
+
+               try:
+                       dataToDump = (
+                               constants.__version__, constants.__build__,
+                               self._contacts, self._contactUpdateTime,
+                               self._messages, self._messageUpdateTime,
+                               self._history, self._historyUpdateTime,
+                               self._dnd, self._callback
+                       )
+                       with open(cachePath, "wb") as f:
+                               pickle.dump(dataToDump, f, pickle.HIGHEST_PROTOCOL)
+                       _moduleLogger.info("Cache saved")
+               except (pickle.PickleError, IOError):
+                       _moduleLogger.exception("While saving")
 
        def _clear_cache(self):
                updateContacts = len(self._contacts) != 0
@@ -363,8 +563,11 @@ class Session(QtCore.QObject):
                oldCallback = self._callback
 
                self._contacts = {}
+               self._contactUpdateTime = datetime.datetime(1971, 1, 1)
                self._messages = []
+               self._messageUpdateTime = datetime.datetime(1971, 1, 1)
                self._history = []
+               self._historyUpdateTime = datetime.datetime(1971, 1, 1)
                self._dnd = False
                self._callback = ""
 
@@ -383,49 +586,63 @@ class Session(QtCore.QObject):
 
        def _update_contacts(self):
                try:
-                       self._contacts = yield (
-                               self._backend.get_contacts,
-                               (),
-                               {},
-                       )
+                       assert self.state == self.LOGGEDIN_STATE, "Contacts requires being logged in (currently %s" % self.state
+                       with qui_utils.notify_busy(self._errorLog, "Updating Contacts"):
+                               self._contacts = yield (
+                                       self._backend[0].get_contacts,
+                                       (),
+                                       {},
+                               )
                except Exception, e:
+                       _moduleLogger.exception("Reporting error to user")
                        self.error.emit(str(e))
                        return
+               self._contactUpdateTime = datetime.datetime.now()
                self.contactsUpdated.emit()
 
        def _update_messages(self):
                try:
-                       self._messages = yield (
-                               self._backend.get_messages,
-                               (),
-                               {},
-                       )
+                       assert self.state == self.LOGGEDIN_STATE, "Messages requires being logged in (currently %s" % self.state
+                       with qui_utils.notify_busy(self._errorLog, "Updating Messages"):
+                               self._messages = yield (
+                                       self._backend[0].get_messages,
+                                       (),
+                                       {},
+                               )
                except Exception, e:
+                       _moduleLogger.exception("Reporting error to user")
                        self.error.emit(str(e))
                        return
+               self._messageUpdateTime = datetime.datetime.now()
                self.messagesUpdated.emit()
 
        def _update_history(self):
                try:
-                       self._history = yield (
-                               self._backend.get_recent,
-                               (),
-                               {},
-                       )
+                       assert self.state == self.LOGGEDIN_STATE, "History requires being logged in (currently %s" % self.state
+                       with qui_utils.notify_busy(self._errorLog, "Updating History"):
+                               self._history = yield (
+                                       self._backend[0].get_recent,
+                                       (),
+                                       {},
+                               )
                except Exception, e:
+                       _moduleLogger.exception("Reporting error to user")
                        self.error.emit(str(e))
                        return
+               self._historyUpdateTime = datetime.datetime.now()
                self.historyUpdated.emit()
 
        def _update_dnd(self):
                oldDnd = self._dnd
                try:
+                       assert self.state == self.LOGGEDIN_STATE, "DND requires being logged in (currently %s" % self.state
                        self._dnd = yield (
-                               self._backend.is_dnd,
+                               self._backend[0].is_dnd,
                                (),
                                {},
                        )
                except Exception, e:
+                       _moduleLogger.exception("Reporting error to user")
                        self.error.emit(str(e))
                        return
                if oldDnd != self._dnd:
@@ -438,7 +655,7 @@ class Session(QtCore.QObject):
                        self._push_login_op(op)
 
        def _push_login_op(self, asyncOp):
-               assert self.state != self.LOGGEDIN_STATE
+               assert self.state != self.LOGGEDIN_STATE, "Can only queue work when logged out"
                if asyncOp in self._loginOps:
                        _moduleLogger.info("Skipping queueing duplicate op: %r" % asyncOp)
                        return