* Switching to docstrings
[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 from __future__ import with_statement
13 import sys
14 import os
15 import re
16 import time
17 import threading
18 import contextlib
19 import gobject
20 import gtk
21 import gc
22 #import hildon
23
24 from gcbackend import GCDialer
25
26
27 @contextlib.contextmanager
28 def gtk_critical_section():
29         gtk.thread_enter()
30         yield
31         gtk.thread_exit()
32
33
34 def makeugly(prettynumber):
35         """
36         function to take a phone number and strip out all non-numeric
37         characters
38
39         >>> makeugly("+012-(345)-678-90")
40         '01234567890'
41         """
42         uglynumber = re.sub('\D','',prettynumber)
43         return uglynumber
44
45
46 def makepretty(phonenumber):
47         """
48         Function to take a phone number and return the pretty version
49          pretty numbers:
50                 if phonenumber begins with 0:
51                         ...-(...)-...-....
52                 else
53                         if phonenumber is 13 digits:
54                                 (...)-...-....
55                         else if phonenumber is 10 digits:
56                                 ...-....
57         >>> makepretty("12")
58         '12'
59         >>> makepretty("1234567")
60         '123-4567'
61         >>> makepretty("1234567890")
62         '(123)-456-7890'
63         >>> makepretty("01234567890")
64         '+012-(345)-678-90'
65         """
66         if phonenumber is None:
67                 return ""
68
69         if len(phonenumber) < 3:
70                 return phonenumber
71
72         if phonenumber[0] == "0":
73                 prettynumber = ""
74                 prettynumber += "+" + phonenumber[0:3] 
75                 if 3 < len(phonenumber):
76                         prettynumber += "-(" + phonenumber[3:6] + ")"
77                         if 6 < len(phonenumber):
78                                 prettynumber += "-" + phonenumber[6:9]
79                                 if 9 < len(phonenumber):
80                                         prettynumber += "-" + phonenumber[9:]
81                 return prettynumber
82         elif len(phonenumber) <= 7:
83                         prettynumber = "%s-%s" % (phonenumber[0:3], phonenumber[3:])
84         elif 7 < len(phonenumber):
85                         prettynumber = "(%s)-%s-%s" % (phonenumber[0:3], phonenumber[3:6], phonenumber[6:])
86         return prettynumber
87
88
89 class Dialpad(object):
90
91         def __init__(self):
92                 self.phonenumber = ""
93                 self.prettynumber = ""
94                 self.areacode = "518"
95                 self.gcd = GCDialer()
96                 self.wTree = gtk.Builder()
97
98                 for path in [ './gc_dialer.xml',
99                                 '../lib/gc_dialer.xml',
100                                 '/usr/local/lib/gc_dialer.xml' ]:
101                         if os.path.isfile(path):
102                                 self.wTree.add_from_file(path)
103                                 break
104
105                 self.window = self.wTree.get_object("Dialpad")
106                 #Get the buffer associated with the number display
107                 self.numberdisplay = self.wTree.get_object("numberdisplay")
108                 self.setNumber("")
109
110                 self.recentview = self.wTree.get_object("recentview")
111                 self.recentmodel = gtk.ListStore(gobject.TYPE_STRING, gobject.TYPE_STRING)
112                 self.recentview.set_model(self.recentmodel)
113                 textrenderer = gtk.CellRendererText()
114
115                 # Add the column to the treeview
116                 column = gtk.TreeViewColumn("Calls", textrenderer, text=1)
117                 column.set_sizing(gtk.TREE_VIEW_COLUMN_FIXED)
118                 self.recentview.append_column(column)
119
120                 self.recentviewselection = self.recentview.get_selection()
121                 self.recentviewselection.set_mode(gtk.SELECTION_SINGLE)
122                 self.recenttime = 0.0
123
124                 self.notebook = self.wTree.get_object("notebook")
125
126                 self.isHildon = False
127                 #if True:
128                 try:
129                         self.app = hildon.Program()
130                         self.wTree.get_object("callbackentry").set_property('hildon-input-mode', 1|(1 << 4))
131                         self.isHildon = True
132                 except:
133                         print "No hildon"
134
135                 if (self.window):
136                         self.window.connect("destroy", gtk.main_quit)
137                         self.window.show_all()
138
139                 dic = {
140                         # Process signals from buttons
141                         "on_digit_clicked"  : self.on_digit_clicked,
142                         "on_dial_clicked"    : self.on_dial_clicked,
143                         "on_loginbutton_clicked" : self.on_loginbutton_clicked,
144                         "on_clearcookies_clicked" : self.on_clearcookies_clicked,
145                         "on_callbackentry_changed" : self.on_callbackentry_changed,
146                         "on_notebook_switch_page" : self.on_notebook_switch_page,
147                         "on_recentview_row_activated" : self.on_recentview_row_activated,
148                         "on_back_clicked" : self.Backspace
149                 }
150                 self.wTree.connect_signals(dic)
151
152                 self.attemptLogin(3)
153                 if self.gcd.getCallbackNumber() is None:
154                         self.gcd.setSaneCallback()
155                 
156                 self.setAccountNumber()
157                 self.setupCallbackCombo()
158                 self.reduce_memory()
159
160         def reduce_memory(self):
161                 re.purge()
162                 num = gc.collect()
163                 #print "collect %d objects" % ( num )
164
165         def on_recentview_row_activated(self, treeview, path, view_column):
166                 model, iter = self.recentviewselection.get_selected()
167                 if iter:
168                         self.setNumber(self.recentmodel.get_value(iter,0))
169                         self.notebook.set_current_page(0)
170                         self.recentviewselection.unselect_all()
171
172         def on_notebook_switch_page(self, notebook, page, page_num):
173                 if page_num == 1 and (time.time() - self.recenttime) > 300:
174                         self.populate_recentview()
175
176         def populate_recentview(self):
177                 print "Populating"
178                 self.recentmodel.clear()
179                 for item in self.gcd.get_recent():
180                         self.recentmodel.append(item)
181                 self.recenttime = time.time()
182
183         def on_clearcookies_clicked(self, data=None):
184                 self.gcd.reset()
185                 self.attemptLogin(3)
186
187         def setupCallbackCombo(self):
188                 combobox = self.wTree.get_object("callbackcombo")
189                 self.callbacklist = gtk.ListStore(gobject.TYPE_STRING)
190                 combobox.set_model(self.callbacklist)
191                 combobox.set_text_column(0)
192                 for k,v in self.gcd.getCallbackNumbers().iteritems():
193                         self.callbacklist.append([makepretty(k)] )
194                 
195                 self.wTree.get_object("callbackentry").set_text(makepretty(self.gcd.getCallbackNumber()))
196
197         def on_callbackentry_changed(self, data=None):
198                 text = makeugly(self.wTree.get_object("callbackentry").get_text())
199                 if self.gcd.validate(text) and text != self.gcd.getCallbackNumber():
200                         self.gcd.setCallbackNumber(text)
201                         self.wTree.get_object("callbackentry").set_text(self.wTree.get_object("callbackentry").get_text())
202                 self.reduce_memory()
203
204         def attemptLogin(self, times = 1):
205                 if self.isHildon:
206                         dialog = hildon.LoginDialog(self.window)
207                         dialog.set_message("Grandcentral Login")
208                 else:
209                         dialog = self.wTree.get_object("login_dialog")
210
211                 while ( (times > 0) and (self.gcd.isAuthed() == False) ):
212                         if dialog.run() == gtk.RESPONSE_OK:
213                                 if self.isHildon:
214                                         username = dialog.get_username()
215                                         password = dialog.get_password()
216                                 else:
217                                         username = self.wTree.get_object("usernameentry").get_text()
218                                         password = self.wTree.get_object("passwordentry").get_text()
219                                         self.wTree.get_object("passwordentry").set_text("")
220                                 self.gcd.login(username, password)
221                                 dialog.hide()
222                                 times = times - 1
223                         else:
224                                 times = 0
225
226                 if self.isHildon:
227                         dialog.destroy()
228
229         def ErrPopUp(self,msg):
230                 error_dialog = gtk.MessageDialog(None,0,gtk.MESSAGE_ERROR,gtk.BUTTONS_CLOSE,msg)
231                 def close(dialog, response, editor):
232                         editor.about_dialog = None
233                         dialog.destroy()
234                 error_dialog.connect("response", close, self)
235                 self.error_dialog = error_dialog
236                 error_dialog.run()
237
238         def on_loginbutton_clicked(self, data=None):
239                 self.wTree.get_object("login_dialog").response(gtk.RESPONSE_OK)
240
241         def on_dial_clicked(self, widget):
242                 self.attemptLogin(3)
243
244                 if not self.gcd.isAuthed() or self.gcd.getCallbackNumber() == "":
245                         self.ErrPopUp("Backend link with grandcentral is not working, please try again")
246                         return
247
248                 #if len(self.phonenumber) == 7:
249                 #       #add default area code
250                 #       self.phonenumber = self.areacode + self.phonenumber
251                         
252                 if self.gcd.dial(self.phonenumber) == False: 
253                         self.ErrPopUp(self.gcd._msg)
254                 else:
255                         self.setNumber("")
256
257                 self.recentmodel.clear()
258                 self.recenttime = 0.0
259                 self.reduce_memory()
260
261         def setNumber(self, number):
262                 self.phonenumber = makeugly(number)
263                 self.prettynumber = makepretty(self.phonenumber)
264                 self.numberdisplay.set_label("<span size='30000' weight='bold'>%s</span>" % ( self.prettynumber ) )
265
266         def setAccountNumber(self):
267                 accountnumber = self.gcd.getAccountNumber()
268                 self.wTree.get_object("gcnumberlabel").set_label("<span size='23000' weight='bold'>%s</span>" % (accountnumber))
269
270         def Backspace(self, widget):
271                 self.setNumber(self.phonenumber[:-1])
272
273         def on_digit_clicked(self, widget):
274                 self.setNumber(self.phonenumber + re.sub('\D','',widget.get_label()))
275
276
277 def doctest():
278         import doctest
279         failureCount, testCount = doctest.testmod()
280         if not failureCount:
281                 print "Tests Successful"
282                 sys.exit(0)
283         else:
284                 sys.exit(1)
285
286
287 def run_dialpad():
288         gc.set_threshold(50,3,3)
289         gtk.gdk.threads_init
290         title = 'Dialpad'
291         handle = Dialpad()
292         gtk.main()
293         sys.exit(1)
294
295
296 if __name__ == "__main__":
297         from optparse import OptionParser
298
299         parser = OptionParser()
300         parser.add_option("-t", "--test", action="store_true", dest="test", help="Run tests")
301         (options, args) = parser.parse_args()
302
303         if options.test:
304                 doctest()
305         else:
306                 run_dialpad()