* Made note of what widget callbacks could use some idle-action deferment for respon...
[gc-dialer] / gc_dialer / gc_dialer.py
index 93d6a1c..141a2c1 100755 (executable)
@@ -10,33 +10,51 @@ bergman@merctech.com
 
 
 import sys
+import gc
 import os
-import re
-import time
 import threading
-import contextlib
+import time
+import re
+import warnings
+
 import gobject
 import gtk
-import gc
-#import hildon
+import gtk.glade
+
+try:
+       import hildon
+except ImportError:
+       hildon = None
+
+try:
+       import osso
+       try:
+               import abook
+               import evolution.ebook as evobook
+       except ImportError:
+               abook = None
+               evobook = None
+except ImportError:
+       osso = None
+
+try:
+       import conic
+except ImportError:
+       conic = None
 
 try:
        import doctest
        import optparse
-except:
-       pass
+except ImportError:
+       doctest = None
+       optparse = None
 
 from gcbackend import GCDialer
 
 import socket
-socket.setdefaulttimeout(5)
 
-@contextlib.contextmanager
-def gtk_critical_section():
-       #The API changed and I hope these are the right calls
-       gtk.gdk.threads_enter()
-       yield
-       gtk.gdk.threads_leave()
+
+socket.setdefaulttimeout(5)
 
 
 def makeugly(prettynumber):
@@ -67,8 +85,10 @@ def makepretty(phonenumber):
        '12'
        >>> makepretty("1234567")
        '123-4567'
-       >>> makepretty("1234567890")
-       '(123)-456-7890'
+       >>> makepretty("2345678901")
+       '(234)-567-8901'
+       >>> makepretty("12345678901")    
+       '1 (234)-567-8901'
        >>> makepretty("01234567890")
        '+012-(345)-678-90'
        """
@@ -99,87 +119,116 @@ def makepretty(phonenumber):
 
 class Dialpad(object):
 
+       __app_name__ = "gc_dialer"
+       __version__ = "0.7.0"
+       __app_magic__ = 0xdeadbeef
+
+       _glade_files = [
+               './gc_dialer.glade',
+               '../lib/gc_dialer.glade',
+               '/usr/local/lib/gc_dialer.glade',
+       ]
+
        def __init__(self):
-               self.phonenumber = ""
-               self.prettynumber = ""
-               self.areacode = "518"
-               self.clipboard = gtk.clipboard_get()
-               self.wTree = gtk.Builder()
-               self.recentmodel = gtk.ListStore(gobject.TYPE_STRING, gobject.TYPE_STRING)
-               self.recentviewselection = None
-               self.callbackNeedsSetup = True
-               self.recenttime = 0.0
-
-               for path in [ './gc_dialer.xml',
-                               '../lib/gc_dialer.xml',
-                               '/usr/local/lib/gc_dialer.xml' ]:
+               self._phonenumber = ""
+               self._prettynumber = ""
+               self._areacode = "518"
+
+               self._clipboard = gtk.clipboard_get()
+
+               self._deviceIsOnline = True
+               self._callbackNeedsSetup = True
+               self._recenttime = 0.0
+               self._recentmodel = gtk.ListStore(gobject.TYPE_STRING, gobject.TYPE_STRING)
+               self._recentviewselection = None
+
+               for path in Dialpad._glade_files:
                        if os.path.isfile(path):
-                               self.wTree.add_from_file(path)
+                               self._widgetTree = gtk.glade.XML(path)
                                break
                else:
-                       self.ErrPopUp("Cannot find gc_dialer.xml")
+                       self.ErrPopUp("Cannot find gc_dialer.glade")
                        gtk.main_quit()
                        return
 
+               self._widgetTree.get_widget("about_title").set_label(self._widgetTree.get_widget("about_title").get_label()+"\nVersion "+Dialpad.__version__)
 
                #Get the buffer associated with the number display
-               self.numberdisplay = self.wTree.get_object("numberdisplay")
+               self._numberdisplay = self._widgetTree.get_widget("numberdisplay")
                self.setNumber("")
-               self.notebook = self.wTree.get_object("notebook")
-
-               self.isHildon = False
+               self._notebook = self._widgetTree.get_widget("notebook")
+
+               self._window = self._widgetTree.get_widget("Dialpad")
+
+               global hildon
+               self._app = None
+               if hildon is not None and isinstance(self._window, gtk.Window):
+                       warnings.warn("Hildon installed but glade file not updated to work with hildon", UserWarning, 2)
+                       hildon = None
+               elif hildon is not None:
+                       self._app = hildon.Program()
+                       self._window.set_title("Keypad")
+                       self._app.add_window(self._window)
+                       self._widgetTree.get_widget("callbackcombo").get_child().set_property('hildon-input-mode', (1 << 4))
+                       self._widgetTree.get_widget("usernameentry").set_property('hildon-input-mode', 7)
+                       self._widgetTree.get_widget("passwordentry").set_property('hildon-input-mode', 7|(1 << 29))
+               else:
+                       warnings.warn("No Hildon", UserWarning, 2)
+
+               self._osso = None
+               self._ebook = None
+               if osso is not None:
+                       self._osso = osso.Context(Dialpad.__app_name__, Dialpad.__version__, False)
+                       device = osso.DeviceState(self._osso)
+                       device.set_device_state_callback(self._on_device_state_change, 0)
+                       if abook is not None and evobook is not None:
+                               abook.init_with_name(Dialpad.__app_name__, self._osso)
+                               self._ebook = evo.open_addressbook("default")
+                       else:
+                               warnings.warn("No abook and No evolution address book support", UserWarning, 2)
+               else:
+                       warnings.warn("No OSSO", UserWarning, 2)
 
-               self.window = self.wTree.get_object("Dialpad")
-               #if True:
-               try:
-                       #self.osso = osso.Context("gc_dialer", "0.6.0", False)
-                       #device = osso.DeviceState(self.osso)
-                       #device.set_device_state_callback(self.on_device_state_change, None)
-                       #abook.init_with_name("gc_dialer", self.osso)
-                       #self.ebook = evo.open_addressbook("default")
-                       self.app = hildon.Program()
-                       self.wTree.get_object("callbackentry").set_property('hildon-input-mode', (1 << 4))
-                       self.wTree.get_object("usernameentry").set_property('hildon-input-mode', 7)
-                       self.wTree.get_object("passwordentry").set_property('hildon-input-mode', 7)
-                       self.isHildon = True
-               except:
-                       print "No hildon"
+               self._connection = None
+               if conic is not None:
+                       self._connection = conic.Connection()
+                       self._connection.connect("connection-event", self._on_connection_change, Dialpad.__app_magic__)
+                       self._connection.request_connection(conic.CONNECT_FLAG_NONE)
+               else:
+                       warnings.warn("No Internet Connectivity API ", UserWarning, 2)
 
-               if self.window:
-                       self.window.connect("destroy", gtk.main_quit)
-                       self.window.show_all()
+               if self._window:
+                       self._window.connect("destroy", gtk.main_quit)
+                       self._window.show_all()
 
                callbackMapping = {
                        # Process signals from buttons
-                       "on_digit_clicked"  : self.on_digit_clicked,
-                       "on_dial_clicked"    : self.on_dial_clicked,
-                       "on_loginbutton_clicked" : self.on_loginbutton_clicked,
-                       "on_clearcookies_clicked" : self.on_clearcookies_clicked,
-                       "on_callbackentry_changed" : self.on_callbackentry_changed,
-                       "on_notebook_switch_page" : self.on_notebook_switch_page,
-                       "on_recentview_row_activated" : self.on_recentview_row_activated,
-                       "on_back_clicked" : self.Backspace
+                       "on_digit_clicked"  : self._on_digit_clicked,
+                       "on_dial_clicked"    : self._on_dial_clicked,
+                       "on_loginbutton_clicked" : self._on_loginbutton_clicked,
+                       "on_loginclose_clicked" : self._on_loginclose_clicked,
+                       "on_clearcookies_clicked" : self._on_clearcookies_clicked,
+                       "on_notebook_switch_page" : self._on_notebook_switch_page,
+                       "on_recentview_row_activated" : self._on_recentview_row_activated,
+                       "on_back_clicked" : self._on_backspace
                }
-               self.wTree.connect_signals(callbackMapping)
+               self._widgetTree.signal_autoconnect(callbackMapping)
+               self._widgetTree.get_widget("callbackcombo").get_child().connect("changed", self._on_callbackentry_changed)
 
                # Defer initalization of recent view
-               self.gcd = GCDialer()
+               self._gcBackend = GCDialer()
 
-               self.attemptLogin(2)
-               gobject.idle_add(self.init_grandcentral)
-               #self.init_grandcentral()
-               gobject.idle_add(self.init_recentview)
-
-               #self.reduce_memory()
+               self.attemptLogin(2) #@todo maybe we should disable the GUI and defer this?
+               gobject.idle_add(self._init_grandcentral)
+               gobject.idle_add(self._init_recent_view)
 
-       def init_grandcentral(self):
+       def _init_grandcentral(self):
                """ deferred initalization of the grandcentral info """
                
                try:
-                       #self.attemptLogin(2)
-                       if self.gcd.isAuthed():
-                               if self.gcd.getCallbackNumber() is None:
-                                       self.gcd.setSaneCallback()
+                       if self._gcBackend.isAuthed():
+                               if self._gcBackend.getCallbackNumber() is None:
+                                       self._gcBackend.setSaneCallback()
                except:
                        pass
                
@@ -187,11 +236,11 @@ class Dialpad(object):
                print "exit init_gc"
                return False
 
-       def init_recentview(self):
+       def _init_recent_view(self):
                """ deferred initalization of the recent view treeview """
 
-               recentview = self.wTree.get_object("recentview")
-               recentview.set_model(self.recentmodel)
+               recentview = self._widgetTree.get_widget("recentview")
+               recentview.set_model(self._recentmodel)
                textrenderer = gtk.CellRendererText()
 
                # Add the column to the treeview
@@ -200,91 +249,48 @@ class Dialpad(object):
 
                recentview.append_column(column)
 
-               self.recentviewselection = recentview.get_selection()
-               self.recentviewselection.set_mode(gtk.SELECTION_SINGLE)
+               self._recentviewselection = recentview.get_selection()
+               self._recentviewselection.set_mode(gtk.SELECTION_SINGLE)
 
                return False
 
-       def on_recentview_row_activated(self, treeview, path, view_column):
-               model, itr = self.recentviewselection.get_selected()
-               if not itr:
-                       return
-
-               self.setNumber(self.recentmodel.get_value(itr, 0))
-               self.notebook.set_current_page(0)
-               self.recentviewselection.unselect_all()
-
-       def on_notebook_switch_page(self, notebook, page, page_num):
-               if page_num == 1 and (time.time() - self.recenttime) > 300:
-                       gobject.idle_add(self.populate_recentview)
-               elif page_num ==2 and self.callbackNeedsSetup:
-                       gobject.idle_add(self.setupCallbackCombo)
-
-       def populate_recentview(self):
-               print "Populating"
-               self.recentmodel.clear()
-               for item in self.gcd.get_recent():
-                       self.recentmodel.append(item)
-               self.recenttime = time.time()
-
-               return False
-
-       def on_clearcookies_clicked(self, data=None):
-               self.gcd.reset()
-               self.callbackNeedsSetup = True
-               self.recenttime = 0.0
-       
-               # re-run the inital grandcentral setup
-               self.attemptLogin(2)
-               gobject.idle_add(self.init_grandcentral)
-
-       def setupCallbackCombo(self):
-               combobox = self.wTree.get_object("callbackcombo")
+       def _setupCallbackCombo(self):
+               combobox = self._widgetTree.get_widget("callbackcombo")
                self.callbacklist = gtk.ListStore(gobject.TYPE_STRING)
                combobox.set_model(self.callbacklist)
                combobox.set_text_column(0)
-               for number, description in self.gcd.getCallbackNumbers().iteritems():
+               for number, description in self._gcBackend.getCallbackNumbers().iteritems():
                        self.callbacklist.append([makepretty(number)] )
 
-               self.wTree.get_object("callbackentry").set_text(makepretty(self.gcd.getCallbackNumber()))
-               self.callbackNeedsSetup = False
+               self._widgetTree.get_widget("callbackcombo").get_child().set_text(makepretty(self._gcBackend.getCallbackNumber()))
+               self._callbackNeedsSetup = False
+
+       def populate_recentview(self):
+               print "Populating"
+               self._recentmodel.clear()
+               for item in self._gcBackend.get_recent():
+                       self._recentmodel.append(item)
+               self._recenttime = time.time()
 
-       def on_callbackentry_changed(self, data=None):
-               text = makeugly(self.wTree.get_object("callbackentry").get_text())
-               if self.gcd.validate(text) and text != self.gcd.getCallbackNumber():
-                       self.gcd.setCallbackNumber(text)
-                       self.wTree.get_object("callbackentry").set_text(self.wTree.get_object("callbackentry").get_text())
-               #self.reduce_memory()
+               return False
 
        def attemptLogin(self, times = 1):
-               #if self.isHildon:
-               #       dialog = hildon.LoginDialog(self.window)
-               #       dialog.set_message("Grandcentral Login")
-               #else:
-               dialog = self.wTree.get_object("login_dialog")
+               dialog = self._widgetTree.get_widget("login_dialog")
 
-               while (0 < times) and not self.gcd.isAuthed():
+               while (0 < times) and not self._gcBackend.isAuthed():
                        if dialog.run() != gtk.RESPONSE_OK:
                                times = 0
                                continue
 
-                       #if self.isHildon:
-                       #       username = dialog.get_username()
-                       #       password = dialog.get_password()
-                       #else:
-                       username = self.wTree.get_object("usernameentry").get_text()
-                       password = self.wTree.get_object("passwordentry").get_text()
-                       self.wTree.get_object("passwordentry").set_text("")
+                       username = self._widgetTree.get_widget("usernameentry").get_text()
+                       password = self._widgetTree.get_widget("passwordentry").get_text()
+                       self._widgetTree.get_widget("passwordentry").set_text("")
                        print "Attempting login"
-                       self.gcd.login(username, password)
+                       self._gcBackend.login(username, password)
                        print "hiding dialog"
                        dialog.hide()
                        times = times - 1
 
-               #if self.isHildon:
-               #       print "destroy dialog"
-               #       dialog.destroy()
-
                return False
 
        def ErrPopUp(self, msg):
@@ -294,58 +300,125 @@ class Dialpad(object):
                        editor.about_dialog = None
                        dialog.destroy()
                error_dialog.connect("response", close, self)
-               self.error_dialog = error_dialog
                error_dialog.run()
 
-       def on_paste(self, data=None):
-               contents = self.clipboard.wait_for_text()
-               phoneNumber = re.sub('\D', '', contents)
-               self.setNumber(phoneNumber)
+       def setNumber(self, number):
+               self._phonenumber = makeugly(number)
+               self._prettynumber = makepretty(self._phonenumber)
+               self._numberdisplay.set_label("<span size='30000' weight='bold'>%s</span>" % ( self._prettynumber ) )
+
+       def setAccountNumber(self):
+               accountnumber = self._gcBackend.getAccountNumber()
+               self._widgetTree.get_widget("gcnumberlabel").set_label("<span size='23000' weight='bold'>%s</span>" % (accountnumber))
+
+       def _on_device_state_change(self, shutdown, save_unsaved_data, memory_low, system_inactivity, message, userData):
+               """
+               For shutdown or save_unsaved_data, our only state is cookies and I think the cookie manager handles that for us.
+               For system_inactivity, we have no background tasks to pause
+
+               @note Hildon specific
+               """
+               if memory_low:
+                       self._gcBackend.clear_caches()
+                       re.purge()
+                       gc.collect()
+
+       def _on_connection_change(self, connection, event, magicIdentifier):
+               """
+               @note Hildon specific
+               """
+               status = event.get_status()
+               error = event.get_error()
+               iap_id = event.get_iap_id()
+               bearer = event.get_bearer_type()
+
+               if status == conic.STATUS_CONNECTED:
+                       self._window.set_sensitive(True)
+                       self._deviceIsOnline = True
+               elif status == conic.STATUS_DISCONNECTED:
+                       self._window.set_sensitive(False)
+                       self._deviceIsOnline = False
+
+       def _on_loginbutton_clicked(self, data=None):
+               self._widgetTree.get_widget("login_dialog").response(gtk.RESPONSE_OK)
+
+       def _on_loginclose_clicked(self, data=None):
+               sys.exit(0)
+
+       def _on_clearcookies_clicked(self, data=None):
+               self._gcBackend.reset()
+               self._callbackNeedsSetup = True
+               self._recenttime = 0.0
+               self._recentmodel.clear()
+               self._widgetTree.get_widget("callbackcombo").get_child().set_text("")
        
-       def on_loginbutton_clicked(self, data=None):
-               self.wTree.get_object("login_dialog").response(gtk.RESPONSE_OK)
+               # re-run the inital grandcentral setup
+               self.attemptLogin(2)
+               gobject.idle_add(self._init_grandcentral)
+
+       def _on_callbackentry_changed(self, data=None):
+               """
+               @todo Potential blocking on web access, maybe we should defer this or put up a dialog?
+               """
+               text = makeugly(self._widgetTree.get_widget("callbackcombo").get_child().get_text())
+               if self._gcBackend.validate(text) and text != self._gcBackend.getCallbackNumber():
+                       self._gcBackend.setCallbackNumber(text)
+
+       def _on_recentview_row_activated(self, treeview, path, view_column):
+               model, itr = self._recentviewselection.get_selected()
+               if not itr:
+                       return
+
+               self.setNumber(self._recentmodel.get_value(itr, 0))
+               self._notebook.set_current_page(0)
+               self._recentviewselection.unselect_all()
 
-       def on_dial_clicked(self, widget):
+       def _on_notebook_switch_page(self, notebook, page, page_num):
+               if page_num == 1 and (time.time() - self._recenttime) > 300:
+                       gobject.idle_add(self.populate_recentview)
+               elif page_num ==2 and self._callbackNeedsSetup:
+                       gobject.idle_add(self._setupCallbackCombo)
+
+               if hildon:
+                       try:
+                               self._window.set_title(self._notebook.get_tab_label(self._notebook.get_nth_page(page_num)).get_text())
+                       except:
+                               self._window.set_title("")
+
+       def _on_dial_clicked(self, widget):
+               """
+               @todo Potential blocking on web access, maybe we should defer parts of this or put up a dialog?
+               """
                self.attemptLogin(3)
 
-               if not self.gcd.isAuthed() or self.gcd.getCallbackNumber() == "":
+               if not self._gcBackend.isAuthed() or self._gcBackend.getCallbackNumber() == "":
                        self.ErrPopUp("Backend link with grandcentral is not working, please try again")
                        return
 
-               #if len(self.phonenumber) == 7:
-               #       #add default area code
-               #       self.phonenumber = self.areacode + self.phonenumber
+               try:
+                       callSuccess = self._gcBackend.dial(self._phonenumber)
+               except ValueError, e:
+                       self._gcBackend._msg = e.message
+                       callSuccess = False
 
-               if self.gcd.dial(self.phonenumber) is False:
-                       self.ErrPopUp(self.gcd._msg)
+               if not callSuccess:
+                       self.ErrPopUp(self._gcBackend._msg)
                else:
                        self.setNumber("")
 
-               self.recentmodel.clear()
-               self.recenttime = 0.0
-               #self.reduce_memory()
+               self._recentmodel.clear()
+               self._recenttime = 0.0
        
-       #def on_device_state_change(self, shutdown, save_unsaved_data, memory_low, system_inactivity, message, userData):
-       #       """
-       #       @todo Might be useful to do something when going in offline mode or low memory
-       #       @note Hildon specific
-       #       """
-       #       pass
-
-       def setNumber(self, number):
-               self.phonenumber = makeugly(number)
-               self.prettynumber = makepretty(self.phonenumber)
-               self.numberdisplay.set_label("<span size='30000' weight='bold'>%s</span>" % ( self.prettynumber ) )
-
-       def setAccountNumber(self):
-               accountnumber = self.gcd.getAccountNumber()
-               self.wTree.get_object("gcnumberlabel").set_label("<span size='23000' weight='bold'>%s</span>" % (accountnumber))
-
-       def Backspace(self, widget):
-               self.setNumber(self.phonenumber[:-1])
+       def _on_paste(self, data=None):
+               contents = self._clipboard.wait_for_text()
+               phoneNumber = re.sub('\D', '', contents)
+               self.setNumber(phoneNumber)
+       
+       def _on_digit_clicked(self, widget):
+               self.setNumber(self._phonenumber + widget.get_name()[5])
 
-       def on_digit_clicked(self, widget):
-               self.setNumber(self.phonenumber + widget.get_name()[5])
+       def _on_backspace(self, widget):
+               self.setNumber(self._phonenumber[:-1])
 
 
 def run_doctest():
@@ -358,12 +431,11 @@ def run_doctest():
 
 
 def run_dialpad():
-       gc.set_threshold(50, 3, 3)
        gtk.gdk.threads_init()
        title = 'Dialpad'
        handle = Dialpad()
        gtk.main()
-       sys.exit(1)
+       sys.exit(0)
 
 
 class DummyOptions(object):
@@ -372,6 +444,9 @@ class DummyOptions(object):
 
 
 if __name__ == "__main__":
+       if hildon:
+               gtk.set_application_name("Dialer")
+
        try:
                parser = optparse.OptionParser()
                parser.add_option("-t", "--test", action="store_true", dest="test", help="Run tests")