6 Python front-end to a wget script to use grandcentral.com to place outbound VOIP calls.
33 import evolution.ebook as evobook
52 from gcbackend import GCDialer
57 socket.setdefaulttimeout(5)
60 def make_ugly(prettynumber):
62 function to take a phone number and strip out all non-numeric
65 >>> make_ugly("+012-(345)-678-90")
68 uglynumber = re.sub('\D', '', prettynumber)
72 def make_pretty(phonenumber):
74 Function to take a phone number and return the pretty version
76 if phonenumber begins with 0:
78 if phonenumber begins with 1: ( for gizmo callback numbers )
80 if phonenumber is 13 digits:
82 if phonenumber is 10 digits:
86 >>> make_pretty("1234567")
88 >>> make_pretty("2345678901")
90 >>> make_pretty("12345678901")
92 >>> make_pretty("01234567890")
95 if phonenumber is None:
98 if len(phonenumber) < 3:
101 if phonenumber[0] == "0":
103 prettynumber += "+%s" % phonenumber[0:3]
104 if 3 < len(phonenumber):
105 prettynumber += "-(%s)" % phonenumber[3:6]
106 if 6 < len(phonenumber):
107 prettynumber += "-%s" % phonenumber[6:9]
108 if 9 < len(phonenumber):
109 prettynumber += "-%s" % phonenumber[9:]
111 elif len(phonenumber) <= 7:
112 prettynumber = "%s-%s" % (phonenumber[0:3], phonenumber[3:])
113 elif len(phonenumber) > 8 and phonenumber[0] == "1":
114 prettynumber = "1 (%s)-%s-%s" % (phonenumber[1:4], phonenumber[4:7], phonenumber[7:])
115 elif len(phonenumber) > 7:
116 prettynumber = "(%s)-%s-%s" % (phonenumber[0:3], phonenumber[3:6], phonenumber[6:])
120 class PhoneTypeSelector(object):
122 def __init__(self, widgetTree, gcBackend):
123 self._gcBackend = gcBackend
124 self._widgetTree = widgetTree
125 self._dialog = self._widgetTree.get_widget("phonetype_dialog")
127 self._selectButton = self._widgetTree.get_widget("select_button")
128 self._selectButton.connect("clicked", self._on_phonetype_select)
130 self._cancelButton = self._widgetTree.get_widget("cancel_button")
131 self._cancelButton.connect("clicked", self._on_phonetype_cancel)
133 self._typemodel = gtk.ListStore(gobject.TYPE_STRING, gobject.TYPE_STRING)
134 self._typeviewselection = None
136 typeview = self._widgetTree.get_widget("phonetypes")
137 typeview.connect("row-activated", self._on_phonetype_select)
138 typeview.set_model(self._typemodel)
139 textrenderer = gtk.CellRendererText()
141 # Add the column to the treeview
142 column = gtk.TreeViewColumn("Phone Numbers", textrenderer, text=1)
143 column.set_sizing(gtk.TREE_VIEW_COLUMN_FIXED)
145 typeview.append_column(column)
147 self._typeviewselection = typeview.get_selection()
148 self._typeviewselection.set_mode(gtk.SELECTION_SINGLE)
150 def run(self, contactDetails):
151 self._typemodel.clear()
153 for phoneType, phoneNumber in contactDetails:
154 self._typemodel.append((phoneNumber, "%s - %s" % (make_pretty(phoneNumber), phoneType)))
156 userResponse = self._dialog.run()
158 if userResponse == gtk.RESPONSE_OK:
159 model, itr = self._typeviewselection.get_selected()
161 phoneNumber = self._typemodel.get_value(itr, 0)
165 self._typeviewselection.unselect_all()
169 def _on_phonetype_select(self, *args):
170 self._dialog.response(gtk.RESPONSE_OK)
172 def _on_phonetype_cancel(self, *args):
173 self._dialog.response(gtk.RESPONSE_CANCEL)
176 class Dialpad(object):
178 __app_name__ = "gc_dialer"
179 __version__ = "0.7.0"
180 __app_magic__ = 0xdeadbeef
184 '../lib/gc_dialer.glade',
185 '/usr/local/lib/gc_dialer.glade',
189 self._phonenumber = ""
190 self._prettynumber = ""
191 self._areacode = "518"
193 self._clipboard = gtk.clipboard_get()
195 self._deviceIsOnline = True
196 self._callbackNeedsSetup = True
198 self._recenttime = 0.0
199 self._recentmodel = gtk.ListStore(gobject.TYPE_STRING, gobject.TYPE_STRING)
200 self._recentviewselection = None
202 self._contactstime = 0.0
203 self._contactsmodel = gtk.ListStore(gtk.gdk.Pixbuf, gobject.TYPE_STRING, gobject.TYPE_STRING, gobject.TYPE_STRING, gobject.TYPE_STRING)
204 self._contactsviewselection = None
206 for path in Dialpad._glade_files:
207 if os.path.isfile(path):
208 self._widgetTree = gtk.glade.XML(path)
211 self.display_error_message("Cannot find gc_dialer.glade")
215 aboutHeader = self._widgetTree.get_widget("about_title")
216 aboutHeader.set_label("%s\nVersion %s" % (aboutHeader.get_label(), Dialpad.__version__))
218 #Get the buffer associated with the number display
219 self._numberdisplay = self._widgetTree.get_widget("numberdisplay")
221 self._notebook = self._widgetTree.get_widget("notebook")
223 self._window = self._widgetTree.get_widget("Dialpad")
227 self._isFullScreen = False
228 if hildon is not None and isinstance(self._window, gtk.Window):
229 warnings.warn("Hildon installed but glade file not updated to work with hildon", UserWarning, 2)
231 elif hildon is not None:
232 self._app = hildon.Program()
233 self._window.set_title("Keypad")
234 self._app.add_window(self._window)
235 self._widgetTree.get_widget("callbackcombo").get_child().set_property('hildon-input-mode', (1 << 4))
236 self._widgetTree.get_widget("usernameentry").set_property('hildon-input-mode', 7)
237 self._widgetTree.get_widget("passwordentry").set_property('hildon-input-mode', 7|(1 << 29))
239 gtkMenu = self._widgetTree.get_widget("menubar1")
241 for child in gtkMenu.get_children():
243 self._window.set_menu(menu)
246 self._window.connect("key-press-event", self._on_key_press)
247 self._window.connect("window-state-event", self._on_window_state_change)
249 warnings.warn("No Hildon", UserWarning, 2)
254 self._osso = osso.Context(Dialpad.__app_name__, Dialpad.__version__, False)
255 device = osso.DeviceState(self._osso)
256 device.set_device_state_callback(self._on_device_state_change, 0)
257 if abook is not None and evobook is not None:
258 abook.init_with_name(Dialpad.__app_name__, self._osso)
259 self._ebook = evobook.open_addressbook("default")
261 warnings.warn("No abook and No evolution address book support", UserWarning, 2)
263 warnings.warn("No OSSO", UserWarning, 2)
265 self._connection = None
266 if conic is not None:
267 self._connection = conic.Connection()
268 self._connection.connect("connection-event", self._on_connection_change, Dialpad.__app_magic__)
269 self._connection.request_connection(conic.CONNECT_FLAG_NONE)
271 warnings.warn("No Internet Connectivity API ", UserWarning, 2)
274 # Process signals from buttons
275 "on_loginbutton_clicked": self._on_loginbutton_clicked,
276 "on_loginclose_clicked": self._on_loginclose_clicked,
278 "on_dialpad_quit": (lambda data: gtk.main_quit()),
279 "on_paste": self._on_paste,
280 "on_clear_number": self._on_clear_number,
282 "on_clearcookies_clicked": self._on_clearcookies_clicked,
283 "on_notebook_switch_page": self._on_notebook_switch_page,
284 "on_recentview_row_activated": self._on_recentview_row_activated,
285 "on_contactsview_row_activated" : self._on_contactsview_row_activated,
287 "on_digit_clicked": self._on_digit_clicked,
288 "on_back_clicked": self._on_backspace,
289 "on_dial_clicked": self._on_dial_clicked,
291 self._widgetTree.signal_autoconnect(callbackMapping)
292 self._widgetTree.get_widget("callbackcombo").get_child().connect("changed", self._on_callbackentry_changed)
295 self._window.connect("destroy", gtk.main_quit)
296 self._window.show_all()
298 self._gcBackend = GCDialer()
300 self._phoneTypeSelector = PhoneTypeSelector(self._widgetTree, self._gcBackend)
302 if not self._gcBackend.is_authed():
303 self.attempt_login(2)
304 gobject.idle_add(self._init_grandcentral)
305 gobject.idle_add(self._init_recent_view)
306 gobject.idle_add(self._init_contacts_view)
308 def _init_grandcentral(self):
309 """ Deferred initalization of the grandcentral info """
311 if self._gcBackend.is_authed():
312 if self._gcBackend.get_callback_number() is None:
313 self._gcBackend.set_sane_callback()
314 self.set_account_number()
318 def _init_recent_view(self):
319 """ Deferred initalization of the recent view treeview """
321 recentview = self._widgetTree.get_widget("recentview")
322 recentview.set_model(self._recentmodel)
323 textrenderer = gtk.CellRendererText()
325 # Add the column to the treeview
326 column = gtk.TreeViewColumn("Calls", textrenderer, text=1)
327 column.set_sizing(gtk.TREE_VIEW_COLUMN_FIXED)
329 recentview.append_column(column)
331 self._recentviewselection = recentview.get_selection()
332 self._recentviewselection.set_mode(gtk.SELECTION_SINGLE)
336 def _init_contacts_view(self):
337 """ deferred initalization of the contacts view treeview """
339 contactsview = self._widgetTree.get_widget("contactsview")
340 contactsview.set_model(self._contactsmodel)
342 # Add the column to the treeview
343 column = gtk.TreeViewColumn("Contact")
345 iconrenderer = gtk.CellRendererPixbuf()
346 column.pack_start(iconrenderer, expand=False)
347 column.add_attribute(iconrenderer, 'pixbuf', 0)
349 textrenderer = gtk.CellRendererText()
350 column.pack_start(textrenderer, expand=True)
351 column.add_attribute(textrenderer, 'text', 1)
353 textrenderer = gtk.CellRendererText()
354 column.pack_start(textrenderer, expand=True)
355 column.add_attribute(textrenderer, 'text', 4)
357 column.set_sizing(gtk.TREE_VIEW_COLUMN_FIXED)
358 column.set_sort_column_id(1)
359 column.set_visible(True)
360 contactsview.append_column(column)
362 #textrenderer = gtk.CellRendererText()
363 #column = gtk.TreeViewColumn("Location", textrenderer, text=2)
364 #column.set_sizing(gtk.TREE_VIEW_COLUMN_FIXED)
365 #column.set_sort_column_id(2)
366 #column.set_visible(True)
367 #contactsview.append_column(column)
369 #textrenderer = gtk.CellRendererText()
370 #column = gtk.TreeViewColumn("Phone", textrenderer, text=3)
371 #column.set_sizing(gtk.TREE_VIEW_COLUMN_FIXED)
372 #column.set_sort_column_id(3)
373 #column.set_visible(True)
374 #contactsview.append_column(column)
376 self._contactsviewselection = contactsview.get_selection()
377 self._contactsviewselection.set_mode(gtk.SELECTION_SINGLE)
381 def _setup_callback_combo(self):
382 combobox = self._widgetTree.get_widget("callbackcombo")
383 self.callbacklist = gtk.ListStore(gobject.TYPE_STRING)
384 combobox.set_model(self.callbacklist)
385 combobox.set_text_column(0)
386 for number, description in self._gcBackend.get_callback_numbers().iteritems():
387 self.callbacklist.append([make_pretty(number)])
389 combobox.get_child().set_text(make_pretty(self._gcBackend.get_callback_number()))
390 self._callbackNeedsSetup = False
392 def populate_recentview(self):
393 self._recentmodel.clear()
395 for personsName, phoneNumber, date, action in self._gcBackend.get_recent():
396 item = (phoneNumber, "%s on %s from/to %s - %s" % (action.capitalize(), date, personsName, phoneNumber))
397 self._recentmodel.append(item)
399 self._recenttime = time.time()
402 def populate_contactsview(self):
403 self._contactsmodel.clear()
405 # completely disable updating the treeview while we populate the data
406 contactsview = self._widgetTree.get_widget("contactsview")
407 contactsview.freeze_child_notify()
408 contactsview.set_model(None)
411 gc_icon = gtk.gdk.pixbuf_new_from_file_at_size('gc_contact.png', 16, 16)
412 for contactId, contactName in self._gcBackend.get_contacts():
413 self._contactsmodel.append((gc_icon,) + (contactName, "", contactId) + ("",))
415 # restart the treeview data rendering
416 contactsview.set_model(self._contactsmodel)
417 contactsview.thaw_child_notify()
419 self._contactstime = time.time()
422 def attempt_login(self, numOfAttempts = 1):
424 @note Assumes that you are already logged in
426 assert 0 < numOfAttempts, "That was pointless having 0 or less login attempts"
427 dialog = self._widgetTree.get_widget("login_dialog")
429 for i in range(numOfAttempts):
432 username = self._widgetTree.get_widget("usernameentry").get_text()
433 password = self._widgetTree.get_widget("passwordentry").get_text()
434 self._widgetTree.get_widget("passwordentry").set_text("")
436 loggedIn = self._gcBackend.login(username, password)
443 def display_error_message(self, msg):
444 error_dialog = gtk.MessageDialog(None, 0, gtk.MESSAGE_ERROR, gtk.BUTTONS_CLOSE, msg)
446 def close(dialog, response, editor):
447 editor.about_dialog = None
449 error_dialog.connect("response", close, self)
452 def set_number(self, number):
453 self._phonenumber = make_ugly(number)
454 self._prettynumber = make_pretty(self._phonenumber)
455 self._numberdisplay.set_label("<span size='30000' weight='bold'>%s</span>" % ( self._prettynumber ) )
457 def set_account_number(self):
458 accountnumber = self._gcBackend.get_account_number()
459 self._widgetTree.get_widget("gcnumberlabel").set_label("<span size='23000' weight='bold'>%s</span>" % (accountnumber))
461 def _on_device_state_change(self, shutdown, save_unsaved_data, memory_low, system_inactivity, message, userData):
463 For shutdown or save_unsaved_data, our only state is cookies and I think the cookie manager handles that for us.
464 For system_inactivity, we have no background tasks to pause
466 @note Hildon specific
469 self._gcBackend.clear_caches()
473 def _on_connection_change(self, connection, event, magicIdentifier):
475 @note Hildon specific
477 status = event.get_status()
478 error = event.get_error()
479 iap_id = event.get_iap_id()
480 bearer = event.get_bearer_type()
482 if status == conic.STATUS_CONNECTED:
483 self._window.set_sensitive(True)
484 self._deviceIsOnline = True
485 elif status == conic.STATUS_DISCONNECTED:
486 self._window.set_sensitive(False)
487 self._deviceIsOnline = False
489 def _on_window_state_change(self, widget, event, *args):
491 @note Hildon specific
493 if event.new_window_state & gtk.gdk.WINDOW_STATE_FULLSCREEN:
494 self._isFullScreen = True
496 self._isFullScreen = False
498 def _on_key_press(self, widget, event, *args):
500 @note Hildon specific
502 if event.keyval == gtk.keysyms.F6:
503 if self._isFullScreen:
504 self._window.unfullscreen()
506 self._window.fullscreen()
508 def _on_loginbutton_clicked(self, *args):
509 self._widgetTree.get_widget("login_dialog").response(gtk.RESPONSE_OK)
511 def _on_loginclose_clicked(self, *args):
515 def _on_clearcookies_clicked(self, *args):
516 self._gcBackend.reset()
517 self._callbackNeedsSetup = True
518 self._recenttime = 0.0
519 self._contactstime = 0.0
520 self._recentmodel.clear()
521 self._widgetTree.get_widget("callbackcombo").get_child().set_text("")
523 # re-run the inital grandcentral setup
524 self.attempt_login(2)
525 gobject.idle_add(self._init_grandcentral)
527 def _on_callbackentry_changed(self, *args):
529 @todo Potential blocking on web access, maybe we should defer this or put up a dialog?
531 text = make_ugly(self._widgetTree.get_widget("callbackcombo").get_child().get_text())
532 if not self._gcBackend.is_valid_syntax(text):
533 warnings.warn("%s is not a valid callback number" % text, UserWarning, 2)
534 elif text != self._gcBackend.get_callback_number():
535 self._gcBackend.set_callback_number(text)
537 warnings.warn("Callback number already is %s" % self._gcBackend.get_callback_number(), UserWarning, 2)
539 def _on_recentview_row_activated(self, treeview, path, view_column):
540 model, itr = self._recentviewselection.get_selected()
544 self.set_number(self._recentmodel.get_value(itr, 0))
545 self._notebook.set_current_page(0)
546 self._recentviewselection.unselect_all()
548 def _on_contactsview_row_activated(self, treeview, path, view_column):
549 model, itr = self._contactsviewselection.get_selected()
553 contactId = self._contactsmodel.get_value(itr, 3)
554 contactDetails = self._gcBackend.get_contact_details(contactId)
555 contactDetails = [phoneNumber for phoneNumber in contactDetails]
557 if len(contactDetails) == 0:
559 elif len(contactDetails) == 1:
560 phoneNumber = contactDetails[0][1]
562 phoneNumber = self._phoneTypeSelector.run(contactDetails)
564 if 0 < len(phoneNumber):
565 self.set_number(phoneNumber)
566 self._notebook.set_current_page(0)
568 self._contactsviewselection.unselect_all()
570 def _on_notebook_switch_page(self, notebook, page, page_num):
571 if page_num == 1 and 300 < (time.time() - self._contactstime):
572 gobject.idle_add(self.populate_contactsview)
573 elif page_num == 2 and 300 < (time.time() - self._recenttime):
574 gobject.idle_add(self.populate_recentview)
575 elif page_num == 3 and self._callbackNeedsSetup:
576 gobject.idle_add(self._setup_callback_combo)
579 self._window.set_title(self._notebook.get_tab_label(self._notebook.get_nth_page(page_num)).get_text())
581 def _on_dial_clicked(self, widget):
583 @todo Potential blocking on web access, maybe we should defer parts of this or put up a dialog?
585 if not self._gcBackend.is_authed():
586 loggedIn = self.attempt_login(2)
588 if not loggedIn or not self._gcBackend.is_authed() or self._gcBackend.get_callback_number() == "":
589 self.display_error_message("Backend link with grandcentral is not working, please try again")
590 warnings.warn("Backend Status: Logged in? %s, Authenticated? %s, Callback=%s" % (loggedIn, self._gcBackend.is_authed(), self._gcBackend.get_callback_number()), UserWarning, 2)
594 callSuccess = self._gcBackend.dial(self._phonenumber)
595 except ValueError, e:
596 self._gcBackend._msg = e.message
600 self.display_error_message(self._gcBackend._msg)
604 self._recentmodel.clear()
605 self._recenttime = 0.0
607 def _on_paste(self, *args):
608 contents = self._clipboard.wait_for_text()
609 phoneNumber = re.sub('\D', '', contents)
610 self.set_number(phoneNumber)
612 def _on_clear_number(self, *args):
615 def _on_digit_clicked(self, widget):
616 self.set_number(self._phonenumber + widget.get_name()[5])
618 def _on_backspace(self, widget):
619 self.set_number(self._phonenumber[:-1])
623 failureCount, testCount = doctest.testmod()
625 print "Tests Successful"
632 gtk.gdk.threads_init()
638 class DummyOptions(object):
644 if __name__ == "__main__":
645 if hildon is not None:
646 gtk.set_application_name("Dialer")
648 if optparse is not None:
649 parser = optparse.OptionParser()
650 parser.add_option("-t", "--test", action="store_true", dest="test", help="Run tests")
651 (commandOptions, commandArgs) = parser.parse_args()
653 commandOptions = DummyOptions()
656 if commandOptions.test: