* Improved error reporting
[gc-dialer] / gc_dialer / gc_dialer.py
1 #!/usr/bin/python2.5
2
3
4 """
5 Grandcentral Dialer
6 Python front-end to a wget script to use grandcentral.com to place outbound VOIP calls.
7 (C) 2008 Mark Bergman
8 bergman@merctech.com
9 """
10
11
12 import sys
13 import gc
14 import os
15 import re
16 import time
17 import threading
18 import contextlib
19 import gobject
20 import gtk
21
22 try:
23         import hildon
24 except ImportError:
25         hildon = None
26
27 try:
28         if hasattr(gtk, "Builder"):
29                 #detected that this is not a legacy system
30                 raise ImportError 
31         #Legacy support
32         import gtk.glade
33 except ImportError:
34         gtk.glade = None
35
36 try:
37         import osso
38         try:
39                 import abook
40                 import evolution.ebook as evobook
41         except ImportError:
42                 abook = None
43                 evobook = None
44 except ImportError:
45         osso = None
46
47 try:
48         import doctest
49         import optparse
50 except ImportError:
51         doctest = None
52         optparse = None
53
54 from gcbackend import GCDialer
55
56 import socket
57 socket.setdefaulttimeout(5)
58
59 @contextlib.contextmanager
60 def gtk_critical_section():
61         #The API changed and I hope these are the right calls
62         gtk.gdk.threads_enter()
63         yield
64         gtk.gdk.threads_leave()
65
66
67 def makeugly(prettynumber):
68         """
69         function to take a phone number and strip out all non-numeric
70         characters
71
72         >>> makeugly("+012-(345)-678-90")
73         '01234567890'
74         """
75         uglynumber = re.sub('\D', '', prettynumber)
76         return uglynumber
77
78
79 def makepretty(phonenumber):
80         """
81         Function to take a phone number and return the pretty version
82          pretty numbers:
83                 if phonenumber begins with 0:
84                         ...-(...)-...-....
85                 if phonenumber begins with 1: ( for gizmo callback numbers )
86                         1 (...)-...-....
87                 if phonenumber is 13 digits:
88                         (...)-...-....
89                 if phonenumber is 10 digits:
90                         ...-....
91         >>> makepretty("12")
92         '12'
93         >>> makepretty("1234567")
94         '123-4567'
95         >>> makepretty("2345678901")
96         '(234)-567-8901'
97         >>> makepretty("12345678901")    
98         '1 (234)-567-8901'
99         >>> makepretty("01234567890")
100         '+012-(345)-678-90'
101         """
102         if phonenumber is None:
103                 return ""
104
105         if len(phonenumber) < 3:
106                 return phonenumber
107
108         if phonenumber[0] == "0":
109                 prettynumber = ""
110                 prettynumber += "+%s" % phonenumber[0:3]
111                 if 3 < len(phonenumber):
112                         prettynumber += "-(%s)" % phonenumber[3:6]
113                         if 6 < len(phonenumber):
114                                 prettynumber += "-%s" % phonenumber[6:9]
115                                 if 9 < len(phonenumber):
116                                         prettynumber += "-%s" % phonenumber[9:]
117                 return prettynumber
118         elif len(phonenumber) <= 7:
119                 prettynumber = "%s-%s" % (phonenumber[0:3], phonenumber[3:])
120         elif len(phonenumber) > 8 and phonenumber[0] == "1":
121                 prettynumber = "1 (%s)-%s-%s" %(phonenumber[1:4], phonenumber[4:7], phonenumber[7:]) 
122         elif len(phonenumber) > 7:
123                 prettynumber = "(%s)-%s-%s" % (phonenumber[0:3], phonenumber[3:6], phonenumber[6:])
124         return prettynumber
125
126
127 class Dialpad(object):
128
129         def __init__(self):
130                 self.phonenumber = ""
131                 self.prettynumber = ""
132                 self.areacode = "518"
133                 self.clipboard = gtk.clipboard_get()
134                 self.recentmodel = gtk.ListStore(gobject.TYPE_STRING, gobject.TYPE_STRING)
135                 self.recentviewselection = None
136                 self.callbackNeedsSetup = True
137                 self.recenttime = 0.0
138
139                 for path in [ './gc_dialer.xml',
140                                 '../lib/gc_dialer.xml',
141                                 '/usr/local/lib/gc_dialer.xml' ]:
142                         if os.path.isfile(path):
143                                 if gtk.glade is None:
144                                         self.wTree = gtk.Builder()
145                                         self.wTree.add_from_file(path)
146                                 else:
147                                         self.wTree = gtk.glade.XML(path)
148                                         self.wTree.get_object = self.wTree.get_widget
149                                 break
150                 else:
151                         self.ErrPopUp("Cannot find gc_dialer.xml")
152                         gtk.main_quit()
153                         return
154
155
156                 #Get the buffer associated with the number display
157                 self.numberdisplay = self.wTree.get_object("numberdisplay")
158                 self.setNumber("")
159                 self.notebook = self.wTree.get_object("notebook")
160
161                 self.window = self.wTree.get_object("Dialpad")
162                 if hildon is not None:
163                         self.app = hildon.Program()
164                         self.window.set_title("Keypad")
165                         self.app.add_window(self.window)
166                         self.wTree.get_object("callbackentry").set_property('hildon-input-mode', (1 << 4))
167                         self.wTree.get_object("usernameentry").set_property('hildon-input-mode', 7)
168                         self.wTree.get_object("passwordentry").set_property('hildon-input-mode', 7)
169                 else:
170                         print "No Hildon"
171
172                 if osso is not None:
173                         self.osso = osso.Context("gc_dialer", "0.6.0", False)
174                         device = osso.DeviceState(self.osso)
175                         device.set_device_state_callback(self.on_device_state_change, 0)
176                         if abook is not None and evobook is not None:
177                                 abook.init_with_name("gc_dialer", self.osso)
178                                 self.ebook = evo.open_addressbook("default")
179                         else:
180                                 print "No abook and No evolution address book support"
181                 else:
182                         print "No OSSO"
183
184                 if self.window:
185                         self.window.connect("destroy", gtk.main_quit)
186                         self.window.show_all()
187
188                 callbackMapping = {
189                         # Process signals from buttons
190                         "on_digit_clicked"  : self.on_digit_clicked,
191                         "on_dial_clicked"    : self.on_dial_clicked,
192                         "on_loginbutton_clicked" : self.on_loginbutton_clicked,
193                         "on_clearcookies_clicked" : self.on_clearcookies_clicked,
194                         "on_callbackentry_changed" : self.on_callbackentry_changed,
195                         "on_notebook_switch_page" : self.on_notebook_switch_page,
196                         "on_recentview_row_activated" : self.on_recentview_row_activated,
197                         "on_back_clicked" : self.Backspace
198                 }
199                 self.wTree.connect_signals(callbackMapping)
200
201                 # Defer initalization of recent view
202                 self.gcd = GCDialer()
203
204                 self.attemptLogin(2)
205                 gobject.idle_add(self.init_grandcentral)
206                 #self.init_grandcentral()
207                 gobject.idle_add(self.init_recentview)
208
209                 #self.reduce_memory()
210
211         def init_grandcentral(self):
212                 """ deferred initalization of the grandcentral info """
213                 
214                 try:
215                         #self.attemptLogin(2)
216                         if self.gcd.isAuthed():
217                                 if self.gcd.getCallbackNumber() is None:
218                                         self.gcd.setSaneCallback()
219                 except:
220                         pass
221                 
222                 self.setAccountNumber()
223                 print "exit init_gc"
224                 return False
225
226         def init_recentview(self):
227                 """ deferred initalization of the recent view treeview """
228
229                 recentview = self.wTree.get_object("recentview")
230                 recentview.set_model(self.recentmodel)
231                 textrenderer = gtk.CellRendererText()
232
233                 # Add the column to the treeview
234                 column = gtk.TreeViewColumn("Calls", textrenderer, text=1)
235                 column.set_sizing(gtk.TREE_VIEW_COLUMN_FIXED)
236
237                 recentview.append_column(column)
238
239                 self.recentviewselection = recentview.get_selection()
240                 self.recentviewselection.set_mode(gtk.SELECTION_SINGLE)
241
242                 return False
243
244         def on_recentview_row_activated(self, treeview, path, view_column):
245                 model, itr = self.recentviewselection.get_selected()
246                 if not itr:
247                         return
248
249                 self.setNumber(self.recentmodel.get_value(itr, 0))
250                 self.notebook.set_current_page(0)
251                 self.recentviewselection.unselect_all()
252
253         def on_notebook_switch_page(self, notebook, page, page_num):
254                 if page_num == 1 and (time.time() - self.recenttime) > 300:
255                         gobject.idle_add(self.populate_recentview)
256                 elif page_num ==2 and self.callbackNeedsSetup:
257                         gobject.idle_add(self.setupCallbackCombo)
258                 if hildon:
259                         try:
260                                 self.window.set_title(self.notebook.get_tab_label(self.notebook.get_nth_page(page_num)).get_text())
261                         except:
262                                 self.window.set_title("")
263
264         def populate_recentview(self):
265                 print "Populating"
266                 self.recentmodel.clear()
267                 for item in self.gcd.get_recent():
268                         self.recentmodel.append(item)
269                 self.recenttime = time.time()
270
271                 return False
272
273         def on_clearcookies_clicked(self, data=None):
274                 self.gcd.reset()
275                 self.callbackNeedsSetup = True
276                 self.recenttime = 0.0
277                 self.recentmodel.clear()
278                 self.wTree.get_object("callbackentry").set_text("")
279         
280                 # re-run the inital grandcentral setup
281                 self.attemptLogin(2)
282                 gobject.idle_add(self.init_grandcentral)
283
284         def setupCallbackCombo(self):
285                 combobox = self.wTree.get_object("callbackcombo")
286                 self.callbacklist = gtk.ListStore(gobject.TYPE_STRING)
287                 combobox.set_model(self.callbacklist)
288                 combobox.set_text_column(0)
289                 for number, description in self.gcd.getCallbackNumbers().iteritems():
290                         self.callbacklist.append([makepretty(number)] )
291
292                 self.wTree.get_object("callbackentry").set_text(makepretty(self.gcd.getCallbackNumber()))
293                 self.callbackNeedsSetup = False
294
295         def on_callbackentry_changed(self, data=None):
296                 text = makeugly(self.wTree.get_object("callbackentry").get_text())
297                 if self.gcd.validate(text) and text != self.gcd.getCallbackNumber():
298                         self.gcd.setCallbackNumber(text)
299                         self.wTree.get_object("callbackentry").set_text(self.wTree.get_object("callbackentry").get_text())
300                 #self.reduce_memory()
301
302         def attemptLogin(self, times = 1):
303                 #if self.isHildon:
304                 #       dialog = hildon.LoginDialog(self.window)
305                 #       dialog.set_message("Grandcentral Login")
306                 #else:
307                 dialog = self.wTree.get_object("login_dialog")
308
309                 while (0 < times) and not self.gcd.isAuthed():
310                         if dialog.run() != gtk.RESPONSE_OK:
311                                 times = 0
312                                 continue
313
314                         #if self.isHildon:
315                         #       username = dialog.get_username()
316                         #       password = dialog.get_password()
317                         #else:
318                         username = self.wTree.get_object("usernameentry").get_text()
319                         password = self.wTree.get_object("passwordentry").get_text()
320                         self.wTree.get_object("passwordentry").set_text("")
321                         print "Attempting login"
322                         self.gcd.login(username, password)
323                         print "hiding dialog"
324                         dialog.hide()
325                         times = times - 1
326
327                 #if self.isHildon:
328                 #       print "destroy dialog"
329                 #       dialog.destroy()
330
331                 return False
332
333         def ErrPopUp(self, msg):
334                 error_dialog = gtk.MessageDialog(None, 0, gtk.MESSAGE_ERROR, gtk.BUTTONS_CLOSE, msg)
335
336                 def close(dialog, response, editor):
337                         editor.about_dialog = None
338                         dialog.destroy()
339                 error_dialog.connect("response", close, self)
340                 self.error_dialog = error_dialog
341                 error_dialog.run()
342
343         def on_paste(self, data=None):
344                 contents = self.clipboard.wait_for_text()
345                 phoneNumber = re.sub('\D', '', contents)
346                 self.setNumber(phoneNumber)
347         
348         def on_loginbutton_clicked(self, data=None):
349                 self.wTree.get_object("login_dialog").response(gtk.RESPONSE_OK)
350
351         def on_dial_clicked(self, widget):
352                 self.attemptLogin(3)
353
354                 if not self.gcd.isAuthed() or self.gcd.getCallbackNumber() == "":
355                         self.ErrPopUp("Backend link with grandcentral is not working, please try again")
356                         return
357
358                 #if len(self.phonenumber) == 7:
359                 #       #add default area code
360                 #       self.phonenumber = self.areacode + self.phonenumber
361
362                 try:
363                         callSuccess = self.gcd.dial(self.phonenumber)
364                 except ValueError, e:
365                         self.gcd._msg = e.message
366                         callSuccess = False
367
368                 if not callSuccess:
369                         self.ErrPopUp(self.gcd._msg)
370                 else:
371                         self.setNumber("")
372
373                 self.recentmodel.clear()
374                 self.recenttime = 0.0
375                 #self.reduce_memory()
376         
377         def on_device_state_change(self, shutdown, save_unsaved_data, memory_low, system_inactivity, message, userData):
378                 """
379                 @todo Might be useful to do something when going in offline mode or low memory
380                 @note Hildon specific
381                 """
382                 pass
383
384         def setNumber(self, number):
385                 self.phonenumber = makeugly(number)
386                 self.prettynumber = makepretty(self.phonenumber)
387                 self.numberdisplay.set_label("<span size='30000' weight='bold'>%s</span>" % ( self.prettynumber ) )
388
389         def setAccountNumber(self):
390                 accountnumber = self.gcd.getAccountNumber()
391                 self.wTree.get_object("gcnumberlabel").set_label("<span size='23000' weight='bold'>%s</span>" % (accountnumber))
392
393         def Backspace(self, widget):
394                 self.setNumber(self.phonenumber[:-1])
395
396         def on_digit_clicked(self, widget):
397                 self.setNumber(self.phonenumber + widget.get_name()[5])
398
399
400 def run_doctest():
401         failureCount, testCount = doctest.testmod()
402         if not failureCount:
403                 print "Tests Successful"
404                 sys.exit(0)
405         else:
406                 sys.exit(1)
407
408
409 def run_dialpad():
410         gc.set_threshold(50, 3, 3)
411         gtk.gdk.threads_init()
412         title = 'Dialpad'
413         handle = Dialpad()
414         gtk.main()
415         sys.exit(1)
416
417
418 class DummyOptions(object):
419         def __init__(self):
420                 self.test = False
421
422
423 if __name__ == "__main__":
424         if hildon:
425                 gtk.set_application_name("Dialer")
426
427         try:
428                 parser = optparse.OptionParser()
429                 parser.add_option("-t", "--test", action="store_true", dest="test", help="Run tests")
430                 (options, args) = parser.parse_args()
431         except:
432                 args = []
433                 options = DummyOptions()
434
435         if options.test:
436                 run_doctest()
437         else:
438                 run_dialpad()