c094c2ec279a7f5e536e1b8e745eb27c73cc3f67
[gc-dialer] / src / evo_backend.py
1 #!/usr/bin/python
2
3 # GC Dialer - Front end for Google's Grand Central service.
4 # Copyright (C) 2008  Eric Warnke ericew AT gmail 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
21 """
22 Evolution Contact Support
23 """
24
25
26 try:
27         import evolution
28 except ImportError:
29         evolution = None
30
31
32 class EvolutionAddressBook(object):
33         """
34         @note Combined the factory and the addressbook for "simplicity" and "cutting down" the number of allocations/deallocations
35         """
36
37         def __init__(self, bookId = None):
38                 if not self.is_supported():
39                         return
40
41                 self._phoneTypes = None
42                 self._bookId = bookId if bookId is not None else self.get_addressbooks().next()[1]
43                 self._book = evolution.ebook.open_addressbook(self._bookId)
44         
45         @classmethod
46         def is_supported(cls):
47                 return evolution is not None
48
49         def get_addressbooks(self):
50                 """
51                 @returns Iterable of (Address Book Factory, Book Id, Book Name)
52                 """
53                 if not self.is_supported():
54                         return
55
56                 if len(evolution.ebook.list_addressbooks()) == 0 and evolution.ebook.open_addressbook('default') is not None:
57                         # It appears that Maemo's e-d-s does not always list the default addressbook, so we're faking it being listed
58                         yield self, "default", "Maemo"
59
60                 for bookId in evolution.ebook.list_addressbooks():
61                         yield self, bookId[1], bookId[0]
62         
63         def open_addressbook(self, bookId):
64                 self._bookId = bookId
65                 self._book = evolution.ebook.open_addressbook(self._bookId)
66                 return self
67
68         @staticmethod
69         def factory_short_name():
70                 return "Evo"
71
72         @staticmethod
73         def factory_name():
74                 return "Evolution"
75
76         def get_contacts(self):
77                 """
78                 @returns Iterable of (contact id, contact name)
79                 """
80                 if not self.is_supported():
81                         return
82
83                 for contact in self._book.get_all_contacts():
84                         yield contact.get_uid(), contact.props.full_name
85         
86         def get_contact_details(self, contactId):
87                 """
88                 @returns Iterable of (Phone Type, Phone Number)
89                 """
90                 contact = self._book.get_contact(contactId)
91
92                 if self._phoneTypes is None and contact is not None:
93                         self._phoneTypes = [pt for pt in dir(contact.props) if "phone" in pt.lower()]
94
95                 for phoneType in self._phoneTypes:
96                         phoneNumber = getattr(contact.props, phoneType)
97                         if isinstance(phoneNumber, str):
98                                 yield phoneType, phoneNumber
99
100 def print_addressbooks():
101         """
102         Included here for debugging.
103
104         Either insert it into the code or launch python with the "-i" flag
105         """
106         if not EvolutionAddressBook.is_supported():
107                 print "No Evolution Support"
108                 return
109
110         eab = EvolutionAddressBook()
111         for book in eab.get_addressbooks():
112                 eab = eab.open_addressbook(book[1])
113                 print book
114                 for contact in eab.get_contacts():
115                         print "\t", contact
116                         for details in eab.get_contact_details(contact[0]):
117                                 print "\t\t", details