Adding some comments
[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                 for bookId in evolution.ebook.list_addressbooks():
57                         yield self, bookId[1], bookId[0]
58         
59         def open_addressbook(self, bookId):
60                 self._bookId = bookId
61                 self._book = evolution.ebook.open_addressbook(self._bookId)
62                 return self
63
64         @staticmethod
65         def factory_name():
66                 return "Evo"
67
68         def get_contacts(self):
69                 """
70                 @returns Iterable of (contact id, contact name)
71                 """
72                 if not self.is_supported():
73                         return
74
75                 for contact in self._book.get_all_contacts():
76                         yield contact.get_uid(), contact.props.full_name
77         
78         def get_contact_details(self, contactId):
79                 """
80                 @returns Iterable of (Phone Type, Phone Number)
81                 """
82                 contact = self._book.get_contact(contactId)
83
84                 if self._phoneTypes is None and contact is not None:
85                         self._phoneTypes = [pt for pt in dir(contact.props) if "phone" in pt.lower()]
86
87                 for phoneType in self._phoneTypes:
88                         phoneNumber = getattr(contact.props, phoneType)
89                         if isinstance(phoneNumber, str):
90                                 yield phoneType, phoneNumber
91
92 def print_addressbooks():
93         """
94         Included here for debugging.
95
96         Either insert it into the code or launch python with the "-i" flag
97         """
98         if not EvolutionAddressBook.is_supported():
99                 print "No Evolution Support"
100                 return
101
102         eab = EvolutionAddressBook()
103         for book in eab.get_addressbooks():
104                 eab = eab.open_addressbook(book[1])
105                 print book
106                 for contact in eab.get_contacts():
107                         print "\t", contact
108                         for details in eab.get_contact_details(contact[0]):
109                                 print "\t\t", details