Big update to 0.1.0. Improved error handling, syncing, the works...
[hermes] / package / src / hermes.py
1 import os.path
2 import evolution
3 from facebook import Facebook, FacebookError
4 import twitter
5 import trans
6 import gnome.gconf
7 from contacts import ContactStore
8 import names
9
10 class Hermes:
11   """Encapsulate the process of syncing Facebook friends' information with the
12      Evolution contacts' database. This should be used as follows:
13      
14        * Initialise, passing in a callback (methods: need_auth(),
15          block_for_auth(), use_twitter(), use_facebook()).
16        * Call load_friends().
17        * Call sync_contacts().
18        * Retrieve information on changes effected.
19        
20      This requires two gconf paths to contain Facebook application keys:
21          /apps/maemo/hermes/key_app
22          /apps/maemo/hermes/key_secret
23        
24      Copyright (c) Andrew Flegg <andrew@bleb.org> 2009.
25      Released under the Artistic Licence."""
26
27
28   # -----------------------------------------------------------------------
29   def __init__(self, callback, twitter = None, facebook = False, empty = False):
30     """Constructor. Passed a callback which must implement three informational
31        methods:
32        
33          need_auth() - called to indicate a login is about to occur. The user
34                        should be informed.
35                        
36          block_for_auth() - prompt the user to take some action once they have
37                             successfully logged in to Facebook.
38                           
39          progress(i, j) - the application is currently processing friend 'i' of
40                           'j'. Should be used to provide the user a progress bar.
41                           
42       Other parameters:
43          twitter - a username/password tuple or None if Twitter should not be
44                    used. Defaults to None.
45                    
46          facebook - boolean indicating if Facebook should be used. Defaults to
47                     False.
48
49          empty - boolean indicating if 'empty' contacts consisting of a profile
50                  URL and birthday should be created.
51                           """
52
53     self.gc       = gnome.gconf.client_get_default()
54     self.callback = callback
55     self.twitter  = twitter
56     self.facebook = facebook
57     self.create_empty = empty
58
59     # -- Check the environment is going to work...
60     #
61     if (self.gc.get_string('/desktop/gnome/url-handlers/http/command') == 'epiphany %s'):
62       raise Exception('Browser in gconf invalid (see NB#136012). Installation error.')
63
64     # -- Get private keys for this app...
65     #
66     key_app    = self.gc.get_string('/apps/maemo/hermes/key_app')
67     key_secret = self.gc.get_string('/apps/maemo/hermes/key_secret')
68     if (key_app is None or key_secret is None):
69       raise Exception('No Facebook application keys found. Installation error.')
70
71     self.fb = Facebook(key_app, key_secret)
72     self.fb.desktop = True
73
74
75   # -----------------------------------------------------------------------
76   def do_fb_login(self):
77     """Perform authentication against Facebook and store the result in gconf
78          for later use. Uses the 'need_auth' and 'block_for_auth' methods on
79          the callback class. The former allows a message to warn the user
80          about what is about to happen to be shown; the second is to wait
81          for the user to confirm they have logged in."""
82     self.fb.session_key = None
83     self.fb.secret = None
84     self.fb.uid = None
85     
86     self.callback.need_auth()
87     self.fb.auth.createToken()
88     self.fb.login()
89     self.callback.block_for_auth()
90     session = self.fb.auth.getSession()
91
92     self.gc.set_string('/apps/maemo/hermes/session_key', session['session_key'])
93     self.gc.set_string('/apps/maemo/hermes/secret_key', session['secret'])
94     self.gc.set_int('/apps/maemo/hermes/uid', session['uid'])
95
96
97   # -----------------------------------------------------------------------
98   def load_friends(self):
99     """Load information on the authenticated user's friends. If no user is
100        currently authenticated, prompts for a login."""
101
102     self.friends = {}
103     self.blocked_pictures = []
104     self.callback.progress(0, 0)
105     
106     # -- Get a user session and retrieve Facebook friends...
107     #
108     if self.facebook:
109       if self.fb.session_key is None:
110         self.fb.session_key = self.gc.get_string('/apps/maemo/hermes/session_key')
111         self.fb.secret = self.gc.get_string('/apps/maemo/hermes/secret_key')
112         self.fb.uid = self.gc.get_int('/apps/maemo/hermes/uid')
113
114       # Check the available session is still valid...
115       while True:
116         try:
117           if self.fb.users.getLoggedInUser() and self.fb.session_key:
118             break
119         except FacebookError:
120           pass
121         self.do_fb_login()
122
123       # Get the list of friends...
124       attrs = ['uid', 'name', 'pic_big', 'birthday_date', 'profile_url', 'first_name', 'last_name', 'website']
125       for friend in self.fb.users.getInfo(self.fb.friends.get(), attrs):
126         key = unicode(friend['name']).encode('trans')
127         self.friends[key] = friend
128         friend['pic']  = friend[attrs[2]]
129         if friend['website']:
130           friend['homepage'] = friend['website']
131
132         if not friend['pic']:
133           self.blocked_pictures.append(friend)
134           
135     # -- Retrieve following information from Twitter...
136     #
137     if self.twitter is not None:
138       (user, passwd) = self.twitter
139       api = twitter.Api(username=user, password=passwd)
140       users = api.GetFriends()
141       for friend in api.GetFriends():
142         self.friends[friend.name] = {'name': unicode(friend.name).encode('trans'), 'pic': friend.profile_image_url, 'birthday_date': None, 'twitter_url': 'http://twitter.com/%s' % (friend.screen_name), 'homepage' : friend.url}
143   
144     # TODO What if the user has *no* contacts?
145
146   
147   # -----------------------------------------------------------------------
148   def sync_contacts(self, resync = False):
149     """Synchronise Facebook profiles to contact database. If resync is false,
150        no existing information will be overwritten."""
151
152     # -- Find addresses...
153     #
154     print "+++ Syncing contacts..."
155     addresses = evolution.ebook.open_addressbook('default')
156     print "+++ Addressbook opened..."
157     self.store = ContactStore(addresses)
158     print "+++ Contact store created..."
159     self.updated = []
160     self.unmatched = []
161     self.matched = []
162     contacts = addresses.get_all_contacts()
163     contacts.sort(key=lambda obj: obj.get_name())
164     current = 0
165     maximum = len(contacts)
166     for contact in contacts:
167       current += 1
168       self.callback.progress(current, maximum)
169       found = False
170       for name in names.variants(contact.get_name()):
171         if name in self.friends:
172           updated = self.update_contact(contact, self.friends[name], resync)
173           found = True
174    
175           if updated:
176             self.updated.append(contact)
177             addresses.commit_contact(contact)
178             print "Saved changes to [%s]" % (contact.get_name())
179             
180           break
181       
182       if found:
183         self.matched.append(contact)
184       else:
185         self.unmatched.append(contact)
186
187     # -- Create 'empty' contacts with birthdays...
188     #
189     if self.create_empty:
190       for name in self.friends:
191         friend = self.friends[name]
192         if 'contact' in friend or 'birthday_date' not in friend or not friend['birthday_date']:
193           continue
194
195         contact = evolution.ebook.EContact()
196         contact.props.full_name = friend['name']
197         contact.props.given_name = friend['first_name']
198         contact.props.family_name = friend['last_name']
199
200         self.update_contact(contact, friend)
201    
202         addresses.add_contact(contact)
203         self.updated.append(contact)
204         addresses.commit_contact(contact)
205
206         print "Created [%s]" % (contact.get_name())
207         self.matched.append(contact)
208
209     self.store.close()
210
211
212   # -----------------------------------------------------------------------
213   def update_contact(self, contact, friend, resync = False):
214     """Update the given contact with information from the 'friend'
215        dictionary."""
216
217     updated = False
218     friend['contact'] = contact
219       
220     if friend['pic'] and (resync or contact.get_property('photo') is None):
221       updated = self.store.set_photo(contact, friend['pic']) or updated
222         
223     if friend['birthday_date'] and (resync or contact.get_property('birth-date') is None):
224       date_str = friend['birthday_date'].split('/')
225       date_str.append('0')
226       updated = self.store.set_birthday(contact, int(date_str[1]),
227                                                  int(date_str[0]),
228                                                  int(date_str[2])) or updated
229
230     if 'profile_url' in friend and friend['profile_url']:
231       updated = self.store.add_url(contact, friend['profile_url'], unique='facebook.com') or updated
232             
233     if 'twitter_url' in friend and friend['twitter_url']:
234       updated = self.store.add_url(contact, friend['twitter_url'], unique='twitter.com') or updated
235             
236     if 'homepage' in friend and friend['homepage']:
237       updated = self.store.add_url(contact, friend['homepage']) or updated
238
239     return updated 
240