git.maemo.org Git - gc-dialer/blob - src/views.py

   1 #!/usr/bin/python2.5
   2
   3 # DialCentral - Front end for Google's Grand Central service.
   4 # Copyright (C) 2008  Mark Bergman bergman AT merctech DOT com
   5 #
   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.
  10 #
  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.
  15 #
  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
  19
  20 import threading
  21 import time
  22 import warnings
  23
  24 import gobject
  25 import gtk
  26
  27 try:
  28         import hildon
  29 except ImportError:
  30         hildon = None
  31
  32
  33 def make_ugly(prettynumber):
  34         """
  35         function to take a phone number and strip out all non-numeric
  36         characters
  37
  38         >>> make_ugly("+012-(345)-678-90")
  39         '01234567890'
  40         """
  41         import re
  42         uglynumber = re.sub('\D', '', prettynumber)
  43         return uglynumber
  44
  45
  46 def make_pretty(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                 if phonenumber begins with 1: ( for gizmo callback numbers )
  53                         1 (...)-...-....
  54                 if phonenumber is 13 digits:
  55                         (...)-...-....
  56                 if phonenumber is 10 digits:
  57                         ...-....
  58         >>> make_pretty("12")
  59         '12'
  60         >>> make_pretty("1234567")
  61         '123-4567'
  62         >>> make_pretty("2345678901")
  63         '(234)-567-8901'
  64         >>> make_pretty("12345678901")
  65         '1 (234)-567-8901'
  66         >>> make_pretty("01234567890")
  67         '+012-(345)-678-90'
  68         """
  69         if phonenumber is None or phonenumber is "":
  70                 return ""
  71
  72         if len(phonenumber) < 3:
  73                 return phonenumber
  74
  75         if phonenumber[0] == "0":
  76                 prettynumber = ""
  77                 prettynumber += "+%s" % phonenumber[0:3]
  78                 if 3 < len(phonenumber):
  79                         prettynumber += "-(%s)" % phonenumber[3:6]
  80                         if 6 < len(phonenumber):
  81                                 prettynumber += "-%s" % phonenumber[6:9]
  82                                 if 9 < len(phonenumber):
  83                                         prettynumber += "-%s" % phonenumber[9:]
  84                 return prettynumber
  85         elif len(phonenumber) <= 7:
  86                 prettynumber = "%s-%s" % (phonenumber[0:3], phonenumber[3:])
  87         elif len(phonenumber) > 8 and phonenumber[0] == "1":
  88                 prettynumber = "1 (%s)-%s-%s" % (phonenumber[1:4], phonenumber[4:7], phonenumber[7:])
  89         elif len(phonenumber) > 7:
  90                 prettynumber = "(%s)-%s-%s" % (phonenumber[0:3], phonenumber[3:6], phonenumber[6:])
  91         return prettynumber
  92
  93
  94 def make_idler(func):
  95         """
  96         Decorator that makes a generator-function into a function that will continue execution on next call
  97         """
  98         a = []
  99
 100         def decorated_func(*args, **kwds):
 101                 if not a:
 102                         a.append(func(*args, **kwds))
 103                 try:
 104                         a[0].next()
 105                         return True
 106                 except StopIteration:
 107                         del a[:]
 108                         return False
 109
 110         decorated_func.__name__ = func.__name__
 111         decorated_func.__doc__ = func.__doc__
 112         decorated_func.__dict__.update(func.__dict__)
 113
 114         return decorated_func
 115
 116
 117 class DummyAddressBook(object):
 118         """
 119         Minimal example of both an addressbook factory and an addressbook
 120         """
 121
 122         def clear_caches(self):
 123                 pass
 124
 125         def get_addressbooks(self):
 126                 """
 127                 @returns Iterable of (Address Book Factory, Book Id, Book Name)
 128                 """
 129                 yield self, "", "None"
 130
 131         def open_addressbook(self, bookId):
 132                 return self
 133
 134         @staticmethod
 135         def contact_source_short_name(contactId):
 136                 return ""
 137
 138         @staticmethod
 139         def factory_name():
 140                 return ""
 141
 142         @staticmethod
 143         def get_contacts():
 144                 """
 145                 @returns Iterable of (contact id, contact name)
 146                 """
 147                 return []
 148
 149         @staticmethod
 150         def get_contact_details(contactId):
 151                 """
 152                 @returns Iterable of (Phone Type, Phone Number)
 153                 """
 154                 return []
 155
 156
 157 class MergedAddressBook(object):
 158         """
 159         Merger of all addressbooks
 160         """
 161
 162         def __init__(self, addressbooks, sorter = None):
 163                 self.__addressbooks = addressbooks
 164                 self.__sort_contacts = sorter if sorter is not None else self.null_sorter
 165
 166         def clear_caches(self):
 167                 for addressBook in self.__addressbooks:
 168                         addressBook.clear_caches()
 169
 170         def get_addressbooks(self):
 171                 """
 172                 @returns Iterable of (Address Book Factory, Book Id, Book Name)
 173                 """
 174                 yield self, "", ""
 175
 176         def open_addressbook(self, bookId):
 177                 return self
 178
 179         def contact_source_short_name(self, contactId):
 180                 bookIndex, originalId = contactId.split("-", 1)
 181                 return self.__addressbooks[int(bookIndex)].contact_source_short_name(originalId)
 182
 183         @staticmethod
 184         def factory_name():
 185                 return "All Contacts"
 186
 187         def get_contacts(self):
 188                 """
 189                 @returns Iterable of (contact id, contact name)
 190                 """
 191                 contacts = (
 192                         ("-".join([str(bookIndex), contactId]), contactName)
 193                                 for (bookIndex, addressbook) in enumerate(self.__addressbooks)
 194                                         for (contactId, contactName) in addressbook.get_contacts()
 195                 )
 196                 sortedContacts = self.__sort_contacts(contacts)
 197                 return sortedContacts
 198
 199         def get_contact_details(self, contactId):
 200                 """
 201                 @returns Iterable of (Phone Type, Phone Number)
 202                 """
 203                 bookIndex, originalId = contactId.split("-", 1)
 204                 return self.__addressbooks[int(bookIndex)].get_contact_details(originalId)
 205
 206         @staticmethod
 207         def null_sorter(contacts):
 208                 return contacts
 209
 210         @staticmethod
 211         def basic_lastname_sorter(contacts):
 212                 contactsWithKey = [
 213                         (contactName.rsplit(" ", 1)[-1], (contactId, contactName))
 214                                 for (contactId, contactName) in contacts
 215                 ]
 216                 contactsWithKey.sort()
 217                 return (contactData for (lastName, contactData) in contactsWithKey)
 218
 219
 220 class PhoneTypeSelector(object):
 221
 222         def __init__(self, widgetTree, gcBackend):
 223                 self._gcBackend = gcBackend
 224                 self._widgetTree = widgetTree
 225                 self._dialog = self._widgetTree.get_widget("phonetype_dialog")
 226
 227                 self._selectButton = self._widgetTree.get_widget("select_button")
 228                 self._selectButton.connect("clicked", self._on_phonetype_select)
 229
 230                 self._cancelButton = self._widgetTree.get_widget("cancel_button")
 231                 self._cancelButton.connect("clicked", self._on_phonetype_cancel)
 232
 233                 self._typemodel = gtk.ListStore(gobject.TYPE_STRING, gobject.TYPE_STRING)
 234                 self._typeviewselection = None
 235
 236                 typeview = self._widgetTree.get_widget("phonetypes")
 237                 typeview.connect("row-activated", self._on_phonetype_select)
 238                 typeview.set_model(self._typemodel)
 239                 textrenderer = gtk.CellRendererText()
 240
 241                 # Add the column to the treeview
 242                 column = gtk.TreeViewColumn("Phone Numbers", textrenderer, text=1)
 243                 column.set_sizing(gtk.TREE_VIEW_COLUMN_FIXED)
 244
 245                 typeview.append_column(column)
 246
 247                 self._typeviewselection = typeview.get_selection()
 248                 self._typeviewselection.set_mode(gtk.SELECTION_SINGLE)
 249
 250         def run(self, contactDetails):
 251                 self._typemodel.clear()
 252
 253                 for phoneType, phoneNumber in contactDetails:
 254                         self._typemodel.append((phoneNumber, "%s - %s" % (make_pretty(phoneNumber), phoneType)))
 255
 256                 userResponse = self._dialog.run()
 257
 258                 if userResponse == gtk.RESPONSE_OK:
 259                         model, itr = self._typeviewselection.get_selected()
 260                         if itr:
 261                                 phoneNumber = self._typemodel.get_value(itr, 0)
 262                 else:
 263                         phoneNumber = ""
 264
 265                 self._typeviewselection.unselect_all()
 266                 self._dialog.hide()
 267                 return phoneNumber
 268
 269         def _on_phonetype_select(self, *args):
 270                 self._dialog.response(gtk.RESPONSE_OK)
 271
 272         def _on_phonetype_cancel(self, *args):
 273                 self._dialog.response(gtk.RESPONSE_CANCEL)
 274
 275
 276 class Dialpad(object):
 277
 278         def __init__(self, widgetTree):
 279                 self._numberdisplay = widgetTree.get_widget("numberdisplay")
 280                 self._phonenumber = ""
 281                 self._prettynumber = ""
 282                 self._clearall_id = None
 283
 284                 callbackMapping = {
 285                         "on_dial_clicked": self._on_dial_clicked,
 286                         "on_digit_clicked": self._on_digit_clicked,
 287                         "on_clear_number": self._on_clear_number,
 288                         "on_back_clicked": self._on_backspace,
 289                         "on_back_pressed": self._on_back_pressed,
 290                         "on_back_released": self._on_back_released,
 291                 }
 292                 widgetTree.signal_autoconnect(callbackMapping)
 293                 widgetTree.get_widget("dial").grab_default()
 294                 widgetTree.get_widget("dial").grab_focus()
 295
 296         def dial(self, number):
 297                 raise NotImplementedError
 298
 299         def get_number(self):
 300                 return self._phonenumber
 301
 302         def set_number(self, number):
 303                 """
 304                 Set the callback phonenumber
 305                 """
 306                 self._phonenumber = make_ugly(number)
 307                 self._prettynumber = make_pretty(self._phonenumber)
 308                 self._numberdisplay.set_label("<span size='30000' weight='bold'>%s</span>" % (self._prettynumber))
 309
 310         def clear(self):
 311                 self.set_number("")
 312
 313         def _on_dial_clicked(self, widget):
 314                 self.dial(self.get_number())
 315
 316         def _on_clear_number(self, *args):
 317                 self.clear()
 318
 319         def _on_digit_clicked(self, widget):
 320                 self.set_number(self._phonenumber + widget.get_name()[-1])
 321
 322         def _on_backspace(self, widget):
 323                 self.set_number(self._phonenumber[:-1])
 324
 325         def _on_clearall(self):
 326                 self.clear()
 327                 return False
 328
 329         def _on_back_pressed(self, widget):
 330                 self._clearall_id = gobject.timeout_add(1000, self._on_clearall)
 331
 332         def _on_back_released(self, widget):
 333                 if self._clearall_id is not None:
 334                         gobject.source_remove(self._clearall_id)
 335                 self._clearall_id = None
 336
 337
 338 class AccountInfo(object):
 339
 340         def __init__(self, widgetTree, backend = None):
 341                 self._backend = backend
 342
 343                 self._callbackList = gtk.ListStore(gobject.TYPE_STRING)
 344                 self._accountViewNumberDisplay = widgetTree.get_widget("gcnumber_display")
 345                 self._callbackCombo = widgetTree.get_widget("callbackcombo")
 346                 if hildon is not None:
 347                         self._callbackCombo.get_child().set_property('hildon-input-mode', (1 << 4))
 348
 349                 callbackMapping = {
 350                 }
 351                 widgetTree.signal_autoconnect(callbackMapping)
 352                 self._callbackCombo.get_child().connect("changed", self._on_callbackentry_changed)
 353
 354                 self.set_account_number("")
 355
 356         def get_selected_callback_number(self):
 357                 return make_ugly(self._callbackCombo.get_child().get_text())
 358
 359         def set_account_number(self, number):
 360                 """
 361                 Displays current account number
 362                 """
 363                 self._accountViewNumberDisplay.set_label("<span size='23000' weight='bold'>%s</span>" % (number))
 364
 365         def update(self):
 366                 self.populate_callback_combo()
 367                 self.set_account_number(self._backend.get_account_number())
 368
 369         def clear(self):
 370                 self._callbackCombo.get_child().set_text("")
 371                 self.set_account_number("")
 372
 373         def populate_callback_combo(self):
 374                 self._callbackList.clear()
 375                 for number, description in self._backend.get_callback_numbers().iteritems():
 376                         self._callbackList.append((make_pretty(number),))
 377
 378                 self._callbackCombo.set_model(self._callbackList)
 379                 self._callbackCombo.set_text_column(0)
 380                 self._callbackCombo.get_child().set_text(make_pretty(self._backend.get_callback_number()))
 381
 382         def _on_callbackentry_changed(self, *args):
 383                 """
 384                 @todo Potential blocking on web access, maybe we should defer this or put up a dialog?
 385                 """
 386                 text = self.get_selected_callback_number()
 387                 if not self._backend.is_valid_syntax(text):
 388                         warnings.warn("%s is not a valid callback number" % text, UserWarning, 2)
 389                 elif text == self._backend.get_callback_number():
 390                         warnings.warn("Callback number already is %s" % self._backend.get_callback_number(), UserWarning, 2)
 391                 else:
 392                         self._backend.set_callback_number(text)
 393
 394
 395 class RecentCallsView(object):
 396
 397         def __init__(self, widgetTree, backend = None):
 398                 self._backend = backend
 399                 self._recenttime = 0.0
 400                 self._recentmodel = gtk.ListStore(gobject.TYPE_STRING, gobject.TYPE_STRING)
 401                 self._recentview = widgetTree.get_widget("recentview")
 402                 self._recentviewselection = None
 403
 404                 callbackMapping = {
 405                         "on_recentview_row_activated": self._on_recentview_row_activated,
 406                 }
 407                 widgetTree.signal_autoconnect(callbackMapping)
 408
 409                 self._init_recent_view()
 410                 if hildon is not None:
 411                         hildon.hildon_helper_set_thumb_scrollbar(widgetTree.get_widget('recent_scrolledwindow'), True)
 412
 413         def number_selected(self, number):
 414                 raise NotImplementedError
 415
 416         def update(self):
 417                 if (time.time() - self._recenttime) < 300:
 418                         return
 419                 backgroundPopulate = threading.Thread(target=self._idly_populate_recentview)
 420                 backgroundPopulate.setDaemon(True)
 421                 backgroundPopulate.start()
 422
 423         def clear(self):
 424                 self._recenttime = 0.0
 425                 self._recentmodel.clear()
 426
 427         def _init_recent_view(self):
 428                 self._recentview.set_model(self._recentmodel)
 429                 textrenderer = gtk.CellRendererText()
 430
 431                 # Add the column to the treeview
 432                 column = gtk.TreeViewColumn("Calls", textrenderer, text=1)
 433                 column.set_sizing(gtk.TREE_VIEW_COLUMN_FIXED)
 434
 435                 self._recentview.append_column(column)
 436
 437                 self._recentviewselection = self._recentview.get_selection()
 438                 self._recentviewselection.set_mode(gtk.SELECTION_SINGLE)
 439
 440         def _idly_populate_recentview(self):
 441                 self._recenttime = time.time()
 442                 self._recentmodel.clear()
 443
 444                 for personsName, phoneNumber, date, action in self._backend.get_recent():
 445                         description = "%s on %s from/to %s - %s" % (action.capitalize(), date, personsName, phoneNumber)
 446                         item = (phoneNumber, description)
 447                         gtk.gdk.threads_enter()
 448                         try:
 449                                 self._recentmodel.append(item)
 450                         finally:
 451                                 gtk.gdk.threads_leave()
 452
 453                 return False
 454
 455         def _on_recentview_row_activated(self, treeview, path, view_column):
 456                 model, itr = self._recentviewselection.get_selected()
 457                 if not itr:
 458                         return
 459
 460                 self.number_selected(self._recentmodel.get_value(itr, 0))
 461                 self._recentviewselection.unselect_all()
 462
 463
 464 class ContactsView(object):
 465
 466         def __init__(self, widgetTree, backend = None):
 467                 self._backend = backend
 468
 469                 self._addressBook = None
 470                 self._addressBookFactories = [DummyAddressBook()]
 471
 472                 self._booksList = gtk.ListStore(gobject.TYPE_STRING, gobject.TYPE_STRING, gobject.TYPE_STRING)
 473                 self._booksSelectionBox = widgetTree.get_widget("addressbook_combo")
 474
 475                 self._contactstime = 0.0
 476                 self._contactsmodel = gtk.ListStore(gobject.TYPE_STRING, gobject.TYPE_STRING, gobject.TYPE_STRING, gobject.TYPE_STRING, gobject.TYPE_STRING)
 477                 self._contactsviewselection = None
 478                 self._contactsview = widgetTree.get_widget("contactsview")
 479
 480                 self._phoneTypeSelector = PhoneTypeSelector(widgetTree, self._backend)
 481
 482                 callbackMapping = {
 483                         "on_contactsview_row_activated" : self._on_contactsview_row_activated,
 484                         "on_addressbook_combo_changed": self._on_addressbook_combo_changed,
 485                 }
 486                 widgetTree.signal_autoconnect(callbackMapping)
 487                 if hildon is not None:
 488                         hildon.hildon_helper_set_thumb_scrollbar(widgetTree.get_widget('contacts_scrolledwindow'), True)
 489
 490                 self._init_contacts_view()
 491
 492         def number_selected(self, number):
 493                 raise NotImplementedError
 494
 495         def get_addressbooks(self):
 496                 """
 497                 @returns Iterable of ((Factory Id, Book Id), (Factory Name, Book Name))
 498                 """
 499                 for i, factory in enumerate(self._addressBookFactories):
 500                         for bookFactory, bookId, bookName in factory.get_addressbooks():
 501                                 yield (i, bookId), (factory.factory_name(), bookName)
 502
 503         def open_addressbook(self, bookFactoryId, bookId):
 504                 self._addressBook = self._addressBookFactories[bookFactoryId].open_addressbook(bookId)
 505                 self._contactstime = 0
 506                 backgroundPopulate = threading.Thread(target=self._idly_populate_contactsview)
 507                 backgroundPopulate.setDaemon(True)
 508                 backgroundPopulate.start()
 509
 510         def update(self):
 511                 if (time.time() - self._contactstime) < 300:
 512                         return
 513                 backgroundPopulate = threading.Thread(target=self._idly_populate_contactsview)
 514                 backgroundPopulate.setDaemon(True)
 515                 backgroundPopulate.start()
 516
 517         def clear(self):
 518                 self._contactstime = 0.0
 519                 self._contactsmodel.clear()
 520
 521         def clear_caches(self):
 522                 for factory in self._addressBookFactories:
 523                         factory.clear_caches()
 524                 self._addressBook.clear_caches()
 525
 526         def append(self, book):
 527                 self._addressBookFactories.append(book)
 528
 529         def extend(self, books):
 530                 self._addressBookFactories.extend(books)
 531
 532         def _init_contacts_view(self):
 533                 self._contactsview.set_model(self._contactsmodel)
 534
 535                 # Add the column to the treeview
 536                 column = gtk.TreeViewColumn("Contact")
 537
 538                 #displayContactSource = False
 539                 displayContactSource = True
 540                 if displayContactSource:
 541                         textrenderer = gtk.CellRendererText()
 542                         column.pack_start(textrenderer, expand=False)
 543                         column.add_attribute(textrenderer, 'text', 0)
 544
 545                 textrenderer = gtk.CellRendererText()
 546                 column.pack_start(textrenderer, expand=True)
 547                 column.add_attribute(textrenderer, 'text', 1)
 548
 549                 textrenderer = gtk.CellRendererText()
 550                 column.pack_start(textrenderer, expand=True)
 551                 column.add_attribute(textrenderer, 'text', 4)
 552
 553                 column.set_sizing(gtk.TREE_VIEW_COLUMN_FIXED)
 554                 column.set_sort_column_id(1)
 555                 column.set_visible(True)
 556                 self._contactsview.append_column(column)
 557
 558                 self._contactsviewselection = self._contactsview.get_selection()
 559                 self._contactsviewselection.set_mode(gtk.SELECTION_SINGLE)
 560
 561         def _init_books_combo(self):
 562                 self._booksList.clear()
 563                 for (factoryId, bookId), (factoryName, bookName) in self.get_addressbooks():
 564                         if factoryName and bookName:
 565                                 entryName = "%s: %s" % (factoryName, bookName)
 566                         elif factoryName:
 567                                 entryName = factoryName
 568                         elif bookName:
 569                                 entryName = bookName
 570                         else:
 571                                 entryName = "Bad name (%d)" % factoryId
 572                         row = (str(factoryId), bookId, entryName)
 573                         self._booksList.append(row)
 574
 575                 self._booksSelectionBox.set_model(self._booksList)
 576                 cell = gtk.CellRendererText()
 577                 self._booksSelectionBox.pack_start(cell, True)
 578                 self._booksSelectionBox.add_attribute(cell, 'text', 2)
 579                 self._booksSelectionBox.set_active(0)
 580
 581         def _idly_populate_contactsview(self):
 582                 #@todo Add a lock so only one code path can be in here at a time
 583                 self.clear()
 584
 585                 # completely disable updating the treeview while we populate the data
 586                 self._contactsview.freeze_child_notify()
 587                 self._contactsview.set_model(None)
 588
 589                 addressBook = self._addressBook
 590                 for contactId, contactName in addressBook.get_contacts():
 591                         contactType = (addressBook.contact_source_short_name(contactId),)
 592                         self._contactsmodel.append(contactType + (contactName, "", contactId) + ("",))
 593
 594                 # restart the treeview data rendering
 595                 self._contactsview.set_model(self._contactsmodel)
 596                 self._contactsview.thaw_child_notify()
 597                 return False
 598
 599         def _on_addressbook_combo_changed(self, *args, **kwds):
 600                 itr = self._booksSelectionBox.get_active_iter()
 601                 if itr is None:
 602                         return
 603                 factoryId = int(self._booksList.get_value(itr, 0))
 604                 bookId = self._booksList.get_value(itr, 1)
 605                 self.open_addressbook(factoryId, bookId)
 606
 607         def _on_contactsview_row_activated(self, treeview, path, view_column):
 608                 model, itr = self._contactsviewselection.get_selected()
 609                 if not itr:
 610                         return
 611
 612                 contactId = self._contactsmodel.get_value(itr, 3)
 613                 contactDetails = self._addressBook.get_contact_details(contactId)
 614                 contactDetails = [phoneNumber for phoneNumber in contactDetails]
 615
 616                 if len(contactDetails) == 0:
 617                         phoneNumber = ""
 618                 elif len(contactDetails) == 1:
 619                         phoneNumber = contactDetails[0][1]
 620                 else:
 621                         phoneNumber = self._phoneTypeSelector.run(contactDetails)
 622
 623                 if 0 < len(phoneNumber):
 624                         self.number_selected(phoneNumber)
 625
 626                 self._contactsviewselection.unselect_all()