e9f36fecfaeb88f24364c741dd91a75c3a99942a
[hermes] / package / src / org / maemo / hermes / engine / contact.py
1 import urllib
2 import Image
3 import ImageOps
4 import StringIO
5 import datetime
6 import re
7 from org.maemo.hermes.engine.names import canonical, variants
8 from pygobject import *
9 from ctypes import *
10
11 # Constants from http://library.gnome.org/devel/libebook/stable/EContact.html#EContactField
12 ebook = CDLL('libebook-1.2.so.5')
13 E_CONTACT_HOMEPAGE_URL = 42
14 E_CONTACT_PHOTO = 94
15 E_CONTACT_EMAIL = 97
16 E_CONTACT_BIRTHDAY_DATE = 107
17
18
19 class Contact:
20     """Provide an abstraction of contact, working around limitations
21        in the evolution-python bindings. Properties are defined at:
22        
23           http://library.gnome.org/devel/libebook/stable/EContact.html#id3066469
24
25        Copyright (c) Andrew Flegg <andrew@bleb.org> 2009.
26        Released under the Artistic Licence."""
27
28        
29     # -----------------------------------------------------------------------
30     def __init__(self, book, econtact):
31         """Create a new contact store for modifying contacts in the given
32            EBook."""
33         
34         self._book = book
35         self._contact = econtact
36         self._identifiers = self._find_ids()
37         self._mapped_to = set([])
38         
39         
40     # -----------------------------------------------------------------------
41     def _find_ids(self):
42         """Return a set of the identifiers which should be used to match this
43            contact. Includes variants of first name, last name, nickname and
44            email address. These are all Unicode-normalised into the traditional
45            US-ASCII namespace"""
46            
47         result = set()
48         for name in variants(self._contact.get_name()):
49             result.add(canonical(name))
50             
51         for name in variants(self._contact.get_property('nickname')):
52             result.add(canonical(name))
53             
54         for email in self.get_emails():
55             user = canonical(email.split('@')[0])
56             if len(user) > 4:
57                 result.add(user)
58
59         return result
60     
61     
62     # -----------------------------------------------------------------------
63     def get_name(self):
64         """Return this contact's name."""
65         
66         return self._contact.get_name() or self._contact.get_property('nickname')
67     
68     
69     # -----------------------------------------------------------------------
70     def get_identifiers(self):
71         """Return the lowercase, Unicode-normalised, all-alphabetic
72            versions of identifiers for this contact."""
73            
74         return self._identifiers
75
76     
77     # -----------------------------------------------------------------------
78     def get_econtact(self):
79         """Return the EContact which backs this contact."""
80         
81         return self._econtact
82     
83     
84     # -----------------------------------------------------------------------
85     def add_mapping(self, id):
86         """Record the fact that this contact is mapped against a provider.
87            'id' MUST match the string returned by Provider.get_id()."""
88         
89         self._mapped_to.add(id)
90         
91         
92     # ----------------------------------------------------------------------
93     def get_mappings(self):
94         """Return the set of IDs of providers which are mapped to this contact.
95            The data can only be relied upon after services have run."""
96            
97         return self._mapped_to
98
99
100     # -----------------------------------------------------------------------
101     def get_photo(self):
102         """Return the photo property, or None. The result is of type
103         EContactPhoto."""
104         
105         photo = self._contact.get_property('photo')
106         return cast(c_void_p(hash(photo)), POINTER(EContactPhoto))
107     
108     
109     # -----------------------------------------------------------------------
110     def set_photo(self, url):
111         """Set the given contact's photo to the picture found at the URL. If the
112            photo is wider than it is tall, it will be cropped with a bias towards
113            the top of the photo."""
114         
115         try:
116             f = urllib.urlopen(url)
117             data = ''
118             while True:
119                 read_data = f.read()
120                 data += read_data
121                 if not read_data:
122                     break
123             
124             im = Image.open(StringIO.StringIO(data))
125             (w, h) = im.size
126             if (h > w):
127                 ##print u"Shrinking photo for %s as it's %d x %d" % (self._contact.get_name(), w, h)
128                 im = ImageOps.fit(im, (w, w), Image.NEAREST, 0, (0, 0.1))
129               
130             ## print u"Updating photo for %s" % (self._contact.get_name())
131             f = StringIO.StringIO()
132             im.save(f, "JPEG")
133             image_data = f.getvalue()
134             photo = EContactPhoto()
135             photo.type = 0
136             photo.data = EContactPhoto_data()
137             photo.data.inlined = EContactPhoto_inlined()
138             photo.data.inlined.mime_type = cast(create_string_buffer("image/jpeg"), c_char_p)
139             photo.data.inlined.length = len(image_data)
140             photo.data.inlined.data = cast(create_string_buffer(image_data), c_void_p)
141             ebook.e_contact_set(hash(self._contact), E_CONTACT_PHOTO, addressof(photo))
142             return True
143         except:
144             print "FAILED to get photo from URL %s" % url
145             return False
146       
147       
148     # -----------------------------------------------------------------------
149     def set_birthday(self, day, month, year = 0):
150         """Set the birthday for this contact to the given day, month and year."""
151         
152         if year == 0:
153             year = datetime.date.today().year
154           
155         birthday = EContactDate()
156         birthday.year = year
157         birthday.month = month
158         birthday.day = day
159         print u"Setting birthday for [%s] to %d-%d-%d" % (self._contact.get_name(), year, month, day)
160         ebook.e_contact_set(hash(self._contact), E_CONTACT_BIRTHDAY_DATE, addressof(birthday))
161         return True
162     
163     
164     # -----------------------------------------------------------------------
165     def set_nickname(self, nickname):
166         """Set the nickname for this contact to the given nickname."""
167         
168         # FIXME does this work?
169         self._contact.set_property('nickname', nickname)
170         #ebook.e_contact_set(hash(self._contact), E_NICKNAME, addressof(nickname))
171     
172     
173     # -----------------------------------------------------------------------
174     def get_emails(self):
175         """Return the email addresses associated with this contact."""
176         
177         emails = []
178         ai = GList.new(ebook.e_contact_get_attributes(hash(self._contact), E_CONTACT_EMAIL))
179         while ai.has_next():
180             attr = ai.next(as_a = EVCardAttribute)
181             if not attr:
182                 raise Exception(u"Unexpected null attribute for [" + self._contact.get_name() + "] with emails " + emails)
183             emails.append(string_at(attr.value().next()))
184           
185         return emails
186         
187       
188       
189     # -----------------------------------------------------------------------
190     def get_urls(self):
191         """Return a list of URLs which are associated with this contact."""
192         
193         urls = []
194         ai = GList.new(ebook.e_contact_get_attributes(hash(self._contact), E_CONTACT_HOMEPAGE_URL))
195         while ai.has_next():
196             attr = ai.next(as_a = EVCardAttribute)
197             if not attr:
198                 raise Exception(u"Unexpected null attribute for [" + self._contact.get_name() + "] with URLs " + urls)
199             urls.append(string_at(attr.value().next()))
200           
201         return urls
202     
203       
204     # -----------------------------------------------------------------------
205     def add_url(self, str, unique = ''):
206         """Add a new URL to the set of URLs for the given contact."""
207         
208         urls = re.findall('(?:(?:ftp|https?):\/\/|\\bwww\.|\\bftp\.)[,\w\.\-\/@:%?&=%+#~_$\*]+[\w=\/&=+#]', str, re.I | re.S)
209         updated = False
210         for url in urls:
211             updated = self._add_url(url, unique or re.sub('(?:.*://)?(\w+(?:[\w\.])*).*', '\\1', url)) or updated
212         
213         return updated
214     
215     
216     # -----------------------------------------------------------------------
217     def _add_url(self, url, unique):
218         """Do the work of adding a unique URL to a contact."""
219         
220         url_attr = None
221         ai = GList.new(ebook.e_contact_get_attributes(hash(self._contact), E_CONTACT_HOMEPAGE_URL))
222         while ai.has_next():
223             attr = ai.next(as_a = EVCardAttribute)
224             existing = string_at(attr.value().next())
225             #print "Existing URL [%s] when adding [%s] to [%s] with constraint [%s]" % (existing, url, contact.get_name(), unique)
226             if existing == unique or existing == url:
227                 return False
228             elif existing.find(unique) > -1:
229                 url_attr = attr
230           
231         if not url_attr:
232             ai.add()
233             url_attr = EVCardAttribute()
234             url_attr.group = ''
235             url_attr.name = 'URL'
236         
237         val = GList()
238         ##print u"Setting URL for [%s] to [%s]" % (self._contact.get_name(), url)
239         val.set(create_string_buffer(url))
240         ai.set(addressof(url_attr))
241         url_attr.values = cast(addressof(val), POINTER(GList))
242         ebook.e_contact_set_attributes(hash(self._contact), E_CONTACT_HOMEPAGE_URL, addressof(ai))
243         return True
244