3 # GC Dialer - Front end for Google's Grand Central service.
4 # Copyright (C) 2008 Mark Bergman bergman AT merctech DOT com
6 # This library is free software; you can redistribute it and/or
7 # modify it under the terms of the GNU Lesser General Public
8 # License as published by the Free Software Foundation; either
9 # version 2.1 of the License, or (at your option) any later version.
11 # This library is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 # Lesser General Public License for more details.
16 # You should have received a copy of the GNU Lesser General Public
17 # License along with this library; if not, write to the Free Software
18 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
60 from gc_backend import GCDialer
61 from evo_backend import EvolutionAddressBook
66 socket.setdefaulttimeout(5)
69 def make_ugly(prettynumber):
71 function to take a phone number and strip out all non-numeric
74 >>> make_ugly("+012-(345)-678-90")
77 uglynumber = re.sub('\D', '', prettynumber)
81 def make_pretty(phonenumber):
83 Function to take a phone number and return the pretty version
85 if phonenumber begins with 0:
87 if phonenumber begins with 1: ( for gizmo callback numbers )
89 if phonenumber is 13 digits:
91 if phonenumber is 10 digits:
95 >>> make_pretty("1234567")
97 >>> make_pretty("2345678901")
99 >>> make_pretty("12345678901")
101 >>> make_pretty("01234567890")
104 if phonenumber is None:
107 if len(phonenumber) < 3:
110 if phonenumber[0] == "0":
112 prettynumber += "+%s" % phonenumber[0:3]
113 if 3 < len(phonenumber):
114 prettynumber += "-(%s)" % phonenumber[3:6]
115 if 6 < len(phonenumber):
116 prettynumber += "-%s" % phonenumber[6:9]
117 if 9 < len(phonenumber):
118 prettynumber += "-%s" % phonenumber[9:]
120 elif len(phonenumber) <= 7:
121 prettynumber = "%s-%s" % (phonenumber[0:3], phonenumber[3:])
122 elif len(phonenumber) > 8 and phonenumber[0] == "1":
123 prettynumber = "1 (%s)-%s-%s" % (phonenumber[1:4], phonenumber[4:7], phonenumber[7:])
124 elif len(phonenumber) > 7:
125 prettynumber = "(%s)-%s-%s" % (phonenumber[0:3], phonenumber[3:6], phonenumber[6:])
129 def make_idler(func):
131 Decorator that makes a generator-function into a function that will continue execution on next call
135 def decorated_func(*args, **kwds):
137 a.append(func(*args, **kwds))
141 except StopIteration:
145 decorated_func.__name__ = func.__name__
146 decorated_func.__doc__ = func.__doc__
147 decorated_func.__dict__.update(func.__dict__)
149 return decorated_func
152 class DummyAddressBook(object):
154 Minimal example of both an addressbook factory and an addressbook
157 def get_addressbooks(self):
159 @returns Iterable of (Address Book Factory, Book Id, Book Name)
161 yield self, "", "None"
163 def open_addressbook(self, bookId):
167 def factory_short_name():
174 def get_contacts(self):
176 @returns Iterable of (contact id, contact name)
180 def get_contact_details(self, contactId):
182 @returns Iterable of (Phone Type, Phone Number)
187 class PhoneTypeSelector(object):
189 def __init__(self, widgetTree, gcBackend):
190 self._gcBackend = gcBackend
191 self._widgetTree = widgetTree
192 self._dialog = self._widgetTree.get_widget("phonetype_dialog")
194 self._selectButton = self._widgetTree.get_widget("select_button")
195 self._selectButton.connect("clicked", self._on_phonetype_select)
197 self._cancelButton = self._widgetTree.get_widget("cancel_button")
198 self._cancelButton.connect("clicked", self._on_phonetype_cancel)
200 self._typemodel = gtk.ListStore(gobject.TYPE_STRING, gobject.TYPE_STRING)
201 self._typeviewselection = None
203 typeview = self._widgetTree.get_widget("phonetypes")
204 typeview.connect("row-activated", self._on_phonetype_select)
205 typeview.set_model(self._typemodel)
206 textrenderer = gtk.CellRendererText()
208 # Add the column to the treeview
209 column = gtk.TreeViewColumn("Phone Numbers", textrenderer, text=1)
210 column.set_sizing(gtk.TREE_VIEW_COLUMN_FIXED)
212 typeview.append_column(column)
214 self._typeviewselection = typeview.get_selection()
215 self._typeviewselection.set_mode(gtk.SELECTION_SINGLE)
217 def run(self, contactDetails):
218 self._typemodel.clear()
220 for phoneType, phoneNumber in contactDetails:
221 self._typemodel.append((phoneNumber, "%s - %s" % (make_pretty(phoneNumber), phoneType)))
223 userResponse = self._dialog.run()
225 if userResponse == gtk.RESPONSE_OK:
226 model, itr = self._typeviewselection.get_selected()
228 phoneNumber = self._typemodel.get_value(itr, 0)
232 self._typeviewselection.unselect_all()
236 def _on_phonetype_select(self, *args):
237 self._dialog.response(gtk.RESPONSE_OK)
239 def _on_phonetype_cancel(self, *args):
240 self._dialog.response(gtk.RESPONSE_CANCEL)
243 class Dialpad(object):
245 __pretty_app_name__ = "Dialer"
246 __app_name__ = "gc_dialer"
247 __version__ = "0.8.0"
248 __app_magic__ = 0xdeadbeef
252 '../lib/gc_dialer.glade',
253 '/usr/local/lib/gc_dialer.glade',
257 self._phonenumber = ""
258 self._prettynumber = ""
259 self._areacode = "518"
261 self._clipboard = gtk.clipboard_get()
263 self._deviceIsOnline = True
264 self.callbacklist = None
265 self._callbackNeedsSetup = True
267 self._recenttime = 0.0
268 self._recentmodel = gtk.ListStore(gobject.TYPE_STRING, gobject.TYPE_STRING)
269 self._recentviewselection = None
271 self._contactstime = 0.0
272 self._contactsmodel = gtk.ListStore(gobject.TYPE_STRING, gobject.TYPE_STRING, gobject.TYPE_STRING, gobject.TYPE_STRING, gobject.TYPE_STRING)
273 self._contactsviewselection = None
275 for path in Dialpad._glade_files:
276 if os.path.isfile(path):
277 self._widgetTree = gtk.glade.XML(path)
280 self.display_error_message("Cannot find gc_dialer.glade")
284 aboutHeader = self._widgetTree.get_widget("about_title")
285 aboutHeader.set_label("%s\nVersion %s" % (aboutHeader.get_label(), Dialpad.__version__))
287 #Get the buffer associated with the number display
288 self._numberdisplay = self._widgetTree.get_widget("numberdisplay")
290 self._notebook = self._widgetTree.get_widget("notebook")
292 self._window = self._widgetTree.get_widget("Dialpad")
296 self._isFullScreen = False
297 if hildon is not None and self._window is gtk.Window:
298 warnings.warn("Hildon installed but glade file not updated to work with hildon", UserWarning, 2)
300 elif hildon is not None:
301 self._app = hildon.Program()
302 self._app.add_window(self._window)
303 self._widgetTree.get_widget("callbackcombo").get_child().set_property('hildon-input-mode', (1 << 4))
304 self._widgetTree.get_widget("usernameentry").set_property('hildon-input-mode', 7)
305 self._widgetTree.get_widget("passwordentry").set_property('hildon-input-mode', 7|(1 << 29))
307 gtkMenu = self._widgetTree.get_widget("dialpad_menubar")
309 for child in gtkMenu.get_children():
311 self._window.set_menu(menu)
314 self._window.connect("key-press-event", self._on_key_press)
315 self._window.connect("window-state-event", self._on_window_state_change)
317 warnings.warn("No Hildon", UserWarning, 2)
319 if hildon is not None:
320 self._window.set_title("Keypad")
322 self._window.set_title("%s - Keypad" % self.__pretty_app_name__)
327 self._osso = osso.Context(Dialpad.__app_name__, Dialpad.__version__, False)
328 device = osso.DeviceState(self._osso)
329 device.set_device_state_callback(self._on_device_state_change, 0)
331 warnings.warn("No OSSO", UserWarning, 2)
333 self._connection = None
334 if conic is not None:
335 self._connection = conic.Connection()
336 self._connection.connect("connection-event", self._on_connection_change, Dialpad.__app_magic__)
337 self._connection.request_connection(conic.CONNECT_FLAG_NONE)
339 warnings.warn("No Internet Connectivity API ", UserWarning, 2)
342 # Process signals from buttons
343 "on_loginbutton_clicked": self._on_loginbutton_clicked,
344 "on_loginclose_clicked": self._on_loginclose_clicked,
346 "on_dialpad_quit": self._on_close,
347 "on_paste": self._on_paste,
348 "on_clear_number": self._on_clear_number,
350 "on_clearcookies_clicked": self._on_clearcookies_clicked,
351 "on_notebook_switch_page": self._on_notebook_switch_page,
352 "on_recentview_row_activated": self._on_recentview_row_activated,
353 "on_contactsview_row_activated" : self._on_contactsview_row_activated,
355 "on_digit_clicked": self._on_digit_clicked,
356 "on_back_clicked": self._on_backspace,
357 "on_dial_clicked": self._on_dial_clicked,
359 self._widgetTree.signal_autoconnect(callbackMapping)
360 self._widgetTree.get_widget("callbackcombo").get_child().connect("changed", self._on_callbackentry_changed)
361 self._widgetTree.get_widget("addressbook_combo").get_child().connect("changed", self._on_addressbook_entry_changed)
364 self._window.connect("destroy", gtk.main_quit)
365 self._window.show_all()
367 self._gcBackend = GCDialer()
369 self._addressBookFactories = [
371 EvolutionAddressBook(),
374 self._addressBook = None
375 self.open_addressbook(*self.get_addressbooks().next()[0][0:2])
377 self._booksList = gtk.ListStore(gobject.TYPE_STRING, gobject.TYPE_STRING, gobject.TYPE_STRING)
378 for (factoryId, bookId), (factoryName, bookName) in self.get_addressbooks():
379 if factoryName and bookName:
380 entryName = "%s: %s" % (factoryName, bookName)
382 entryName = factoryName
386 entryName = "Bad name (%d)" % factoryId
387 row = (str(factoryId), bookId, entryName)
388 self._booksList.append(row)
390 combobox = self._widgetTree.get_widget("addressbook_combo")
391 combobox.set_model(self._booksList)
392 combobox.set_text_column(2)
393 combobox.set_active(0)
395 self._phoneTypeSelector = PhoneTypeSelector(self._widgetTree, self._gcBackend)
397 if not self._gcBackend.is_authed():
398 self.attempt_login(2)
400 self.set_account_number()
401 gobject.idle_add(self._idly_init_recent_view)
402 gobject.idle_add(self._idly_init_contacts_view)
404 def _idly_init_recent_view(self):
406 Deferred initalization of the recent view treeview
409 recentview = self._widgetTree.get_widget("recentview")
410 recentview.set_model(self._recentmodel)
411 textrenderer = gtk.CellRendererText()
413 # Add the column to the treeview
414 column = gtk.TreeViewColumn("Calls", textrenderer, text=1)
415 column.set_sizing(gtk.TREE_VIEW_COLUMN_FIXED)
417 recentview.append_column(column)
419 self._recentviewselection = recentview.get_selection()
420 self._recentviewselection.set_mode(gtk.SELECTION_SINGLE)
424 def _idly_init_contacts_view(self):
425 """ deferred initalization of the contacts view treeview """
427 contactsview = self._widgetTree.get_widget("contactsview")
428 contactsview.set_model(self._contactsmodel)
430 # Add the column to the treeview
431 column = gtk.TreeViewColumn("Contact")
433 textrenderer = gtk.CellRendererText()
434 column.pack_start(textrenderer, expand=True)
435 column.add_attribute(textrenderer, 'text', 1)
437 textrenderer = gtk.CellRendererText()
438 column.pack_start(textrenderer, expand=True)
439 column.add_attribute(textrenderer, 'text', 4)
441 column.set_sizing(gtk.TREE_VIEW_COLUMN_FIXED)
442 column.set_sort_column_id(1)
443 column.set_visible(True)
444 contactsview.append_column(column)
446 #textrenderer = gtk.CellRendererText()
447 #column = gtk.TreeViewColumn("Location", textrenderer, text=2)
448 #column.set_sizing(gtk.TREE_VIEW_COLUMN_FIXED)
449 #column.set_sort_column_id(2)
450 #column.set_visible(True)
451 #contactsview.append_column(column)
453 #textrenderer = gtk.CellRendererText()
454 #column = gtk.TreeViewColumn("Phone", textrenderer, text=3)
455 #column.set_sizing(gtk.TREE_VIEW_COLUMN_FIXED)
456 #column.set_sort_column_id(3)
457 #column.set_visible(True)
458 #contactsview.append_column(column)
460 self._contactsviewselection = contactsview.get_selection()
461 self._contactsviewselection.set_mode(gtk.SELECTION_SINGLE)
465 def _idly_setup_callback_combo(self):
466 self.callbacklist = gtk.ListStore(gobject.TYPE_STRING)
467 for number, description in self._gcBackend.get_callback_numbers().iteritems():
468 self.callbacklist.append((make_pretty(number),))
470 combobox = self._widgetTree.get_widget("callbackcombo")
471 combobox.set_model(self.callbacklist)
472 combobox.set_text_column(0)
474 combobox.get_child().set_text(make_pretty(self._gcBackend.get_callback_number()))
475 self._callbackNeedsSetup = False
477 def _idly_populate_recentview(self):
478 self._recentmodel.clear()
480 for personsName, phoneNumber, date, action in self._gcBackend.get_recent():
481 description = "%s on %s from/to %s - %s" % (action.capitalize(), date, personsName, phoneNumber)
482 item = (phoneNumber, description)
483 self._recentmodel.append(item)
485 self._recenttime = time.time()
489 def _idly_populate_contactsview(self):
490 self._contactsmodel.clear()
492 # completely disable updating the treeview while we populate the data
493 contactsview = self._widgetTree.get_widget("contactsview")
494 contactsview.freeze_child_notify()
495 contactsview.set_model(None)
497 contactType = (self._addressBook.factory_short_name(),)
498 for contactId, contactName in self._addressBook.get_contacts():
499 self._contactsmodel.append(contactType + (contactName, "", contactId) + ("",))
502 # restart the treeview data rendering
503 contactsview.set_model(self._contactsmodel)
504 contactsview.thaw_child_notify()
506 self._contactstime = time.time()
508 def attempt_login(self, numOfAttempts = 1):
510 @note Assumes that you are already logged in
512 assert 0 < numOfAttempts, "That was pointless having 0 or less login attempts"
513 dialog = self._widgetTree.get_widget("login_dialog")
515 for i in range(numOfAttempts):
518 username = self._widgetTree.get_widget("usernameentry").get_text()
519 password = self._widgetTree.get_widget("passwordentry").get_text()
520 self._widgetTree.get_widget("passwordentry").set_text("")
522 loggedIn = self._gcBackend.login(username, password)
525 if self._gcBackend.get_callback_number() is None:
526 self._gcBackend.set_sane_callback()
527 self.set_account_number()
532 def display_error_message(self, msg):
533 error_dialog = gtk.MessageDialog(None, 0, gtk.MESSAGE_ERROR, gtk.BUTTONS_CLOSE, msg)
535 def close(dialog, response, editor):
536 editor.about_dialog = None
538 error_dialog.connect("response", close, self)
541 def get_addressbooks(self):
543 @returns Iterable of ((Factory Id, Book Id), (Factory Name, Book Name))
545 for i, factory in enumerate(self._addressBookFactories):
546 for bookFactory, bookId, bookName in factory.get_addressbooks():
547 yield (i, bookId), (factory.factory_name(), bookName)
549 def open_addressbook(self, bookFactoryId, bookId):
550 self._addressBook = self._addressBookFactories[bookFactoryId].open_addressbook(bookId)
551 self._contactstime = 0
552 gobject.idle_add(self._idly_populate_contactsview)
554 def set_number(self, number):
556 Set the callback phonenumber
558 self._phonenumber = make_ugly(number)
559 self._prettynumber = make_pretty(self._phonenumber)
560 self._numberdisplay.set_label("<span size='30000' weight='bold'>%s</span>" % (self._prettynumber))
562 def set_account_number(self):
564 Displays current account number
566 accountnumber = self._gcBackend.get_account_number()
567 self._widgetTree.get_widget("gcnumber_display").set_label("<span size='23000' weight='bold'>%s</span>" % (accountnumber))
569 def _on_close(self, *args):
572 def _on_device_state_change(self, shutdown, save_unsaved_data, memory_low, system_inactivity, message, userData):
574 For shutdown or save_unsaved_data, our only state is cookies and I think the cookie manager handles that for us.
575 For system_inactivity, we have no background tasks to pause
577 @note Hildon specific
580 self._gcBackend.clear_caches()
584 def _on_connection_change(self, connection, event, magicIdentifier):
586 @note Hildon specific
588 status = event.get_status()
589 error = event.get_error()
590 iap_id = event.get_iap_id()
591 bearer = event.get_bearer_type()
593 if status == conic.STATUS_CONNECTED:
594 self._window.set_sensitive(True)
595 self._deviceIsOnline = True
596 elif status == conic.STATUS_DISCONNECTED:
597 self._window.set_sensitive(False)
598 self._deviceIsOnline = False
600 def _on_window_state_change(self, widget, event, *args):
602 @note Hildon specific
604 if event.new_window_state & gtk.gdk.WINDOW_STATE_FULLSCREEN:
605 self._isFullScreen = True
607 self._isFullScreen = False
609 def _on_key_press(self, widget, event, *args):
611 @note Hildon specific
613 if event.keyval == gtk.keysyms.F6:
614 if self._isFullScreen:
615 self._window.unfullscreen()
617 self._window.fullscreen()
619 def _on_loginbutton_clicked(self, *args):
620 self._widgetTree.get_widget("login_dialog").response(gtk.RESPONSE_OK)
622 def _on_loginclose_clicked(self, *args):
626 def _on_clearcookies_clicked(self, *args):
627 self._gcBackend.logout()
628 self._callbackNeedsSetup = True
629 self._recenttime = 0.0
630 self._contactstime = 0.0
631 self._recentmodel.clear()
632 self._widgetTree.get_widget("callbackcombo").get_child().set_text("")
634 # re-run the inital grandcentral setup
635 self.attempt_login(2)
636 gobject.idle_add(self._idly_setup_callback_combo)
638 def _on_callbackentry_changed(self, *args):
640 @todo Potential blocking on web access, maybe we should defer this or put up a dialog?
642 text = make_ugly(self._widgetTree.get_widget("callbackcombo").get_child().get_text())
643 if not self._gcBackend.is_valid_syntax(text):
644 warnings.warn("%s is not a valid callback number" % text, UserWarning, 2)
645 elif text != self._gcBackend.get_callback_number():
646 self._gcBackend.set_callback_number(text)
648 warnings.warn("Callback number already is %s" % self._gcBackend.get_callback_number(), UserWarning, 2)
650 def _on_recentview_row_activated(self, treeview, path, view_column):
651 model, itr = self._recentviewselection.get_selected()
655 self.set_number(self._recentmodel.get_value(itr, 0))
656 self._notebook.set_current_page(0)
657 self._recentviewselection.unselect_all()
659 def _on_addressbook_entry_changed(self, *args, **kwds):
660 combobox = self._widgetTree.get_widget("addressbook_combo")
661 itr = combobox.get_active_iter()
663 factoryId = int(self._booksList.get_value(itr, 0))
664 bookId = self._booksList.get_value(itr, 1)
665 self.open_addressbook(factoryId, bookId)
667 def _on_contactsview_row_activated(self, treeview, path, view_column):
668 model, itr = self._contactsviewselection.get_selected()
672 contactId = self._contactsmodel.get_value(itr, 3)
673 contactDetails = self._addressBook.get_contact_details(contactId)
674 contactDetails = [phoneNumber for phoneNumber in contactDetails]
676 if len(contactDetails) == 0:
678 elif len(contactDetails) == 1:
679 phoneNumber = contactDetails[0][1]
681 phoneNumber = self._phoneTypeSelector.run(contactDetails)
683 if 0 < len(phoneNumber):
684 self.set_number(phoneNumber)
685 self._notebook.set_current_page(0)
687 self._contactsviewselection.unselect_all()
689 def _on_notebook_switch_page(self, notebook, page, page_num):
690 if page_num == 1 and 300 < (time.time() - self._contactstime):
691 gobject.idle_add(self._idly_populate_contactsview)
692 elif page_num == 2 and 300 < (time.time() - self._recenttime):
693 gobject.idle_add(self._idly_populate_recentview)
694 elif page_num == 3 and self._callbackNeedsSetup:
695 gobject.idle_add(self._idly_setup_callback_combo)
697 tabTitle = self._notebook.get_tab_label(self._notebook.get_nth_page(page_num)).get_text()
698 if hildon is not None:
699 self._window.set_title(tabTitle)
701 self._window.set_title("%s - %s" % (self.__pretty_app_name__, tabTitle))
703 def _on_dial_clicked(self, widget):
705 @todo Potential blocking on web access, maybe we should defer parts of this or put up a dialog?
707 loggedIn = self._gcBackend.is_authed()
709 loggedIn = self.attempt_login(2)
711 if not loggedIn or not self._gcBackend.is_authed() or self._gcBackend.get_callback_number() == "":
712 self.display_error_message("Backend link with grandcentral is not working, please try again")
713 warnings.warn("Backend Status: Logged in? %s, Authenticated? %s, Callback=%s" % (loggedIn, self._gcBackend.is_authed(), self._gcBackend.get_callback_number()), UserWarning, 2)
717 callSuccess = self._gcBackend.dial(self._phonenumber)
718 except ValueError, e:
719 self._gcBackend._msg = e.message
723 self.display_error_message(self._gcBackend._msg)
727 self._recentmodel.clear()
728 self._recenttime = 0.0
730 def _on_paste(self, *args):
731 contents = self._clipboard.wait_for_text()
732 phoneNumber = re.sub('\D', '', contents)
733 self.set_number(phoneNumber)
735 def _on_clear_number(self, *args):
738 def _on_digit_clicked(self, widget):
739 self.set_number(self._phonenumber + widget.get_name()[5])
741 def _on_backspace(self, widget):
742 self.set_number(self._phonenumber[:-1])
746 failureCount, testCount = doctest.testmod()
748 print "Tests Successful"
755 gtk.gdk.threads_init()
761 class DummyOptions(object):
767 if __name__ == "__main__":
768 if hildon is not None:
769 gtk.set_application_name(Dialpad.__pretty_app_name__)
771 if optparse is not None:
772 parser = optparse.OptionParser()
773 parser.add_option("-t", "--test", action="store_true", dest="test", help="Run tests")
774 (commandOptions, commandArgs) = parser.parse_args()
776 commandOptions = DummyOptions()
779 if commandOptions.test: