fa12cc24b57114226af6c1aaba3478b0e663be69
[hermes] / package / src / org / maemo / hermes / engine / facebook / service.py
1 import org.maemo.hermes.engine.service
2
3 from org.maemo.hermes.engine.names import canonical
4 from org.maemo.hermes.engine.friend import Friend
5
6 class Service(org.maemo.hermes.engine.service.Service):
7     """Facebook backend for Hermes.
8                 
9        Copyright (c) Andrew Flegg <andrew@bleb.org> 2010.
10        Copyright (c) Fredrik Wendt <fredrik@wendt.se> 2010.
11        Released under the Artistic Licence."""
12        
13     attrs = ['uid', 'name', 'pic_big', 'birthday_date', 'profile_url', 'first_name', 'last_name', 'website']
14
15
16     # -----------------------------------------------------------------------
17     def __init__(self, facebook, create_birthday_only = False):
18         """Initialise the Facebook service, finding Facebook API keys in gconf and
19            having a gui_callback available."""
20         
21         self.fb = facebook
22         
23         self._friends_by_name = {}
24         self._friends_by_url = {}
25         self._friends_by_contact = {}
26         self._contacts_by_friend = {}
27         self._friends_without_contact = set()
28         self._known_urls = set()
29
30
31     # -----------------------------------------------------------------------
32     def get_name(self):
33         return "Facebook"
34     
35
36     # -----------------------------------------------------------------------
37     def get_friends(self):
38         return self._contacts_by_friend.keys()
39     
40     
41     def get_contacts_with_match(self):
42         return self._friends_by_contact
43     
44     def get_unmatched_friends(self):
45         return self._friends_by_name.values()
46
47
48     # -----------------------------------------------------------------------
49     def pre_process_contact(self, contact):
50         """Registers URLs of all previous mappings, and makes sure that any Friends with those
51            URLs don't get match by name."""
52         for url in contact.get_urls():
53             self._known_urls.add(url)
54     
55     
56     # -----------------------------------------------------------------------
57     def process_friends(self):
58         
59         def if_defined(data, key, callback):
60             if key in data and data[key]:
61                 callback(data[key])
62         
63         friends_data = self._get_friends_data()
64         for data in friends_data:
65             key = canonical(data['name']) # FIXME: deal with name collision
66             friend = self._create_friend(data['name'])
67         
68             if 'profile_url' not in data:
69                 data['profile_url'] = "http://www.facebook.com/profile.php?id=" + str(data['uid'])
70         
71             if_defined(data, 'website', friend.add_url)
72             if_defined(data, 'profile_url', friend.add_url)
73             if_defined(data, 'birthday_date', friend.set_birthday_date)
74
75             if_defined(data, 'pic_big', friend.set_photo_url)
76             
77             if friend.has_birthday_date(): # FIXME: remove this, either you want to add your contacts or not? 
78                 self._friends_without_contact.add(friend)
79             url = data['profile_url']
80             self._friends_by_url[url] = friend
81             
82             if url not in self._known_urls:
83                 self._friends_by_name[key] = friend
84
85
86     # -----------------------------------------------------------------------
87     def process_contact(self, contact):
88         matched_friend = None
89         if self._friends_by_contact.has_key(contact):
90             matched_friend = self._friends_by_contact[contact]
91         
92         # we might get a hit if the friend has setup a URL with another service,
93         # such as putting the id link to Facebook on the Twitter account's profile
94         if not matched_friend:
95             for url in contact.get_urls():
96                 if url in self._friends_by_url:
97                     matched_friend = self._friends_by_url[url]
98                     self._register_match(contact, matched_friend)
99                     break
100
101         if not matched_friend:
102             for id in contact.get_identifiers():
103                 if id in self._friends_by_name:
104                     matched_friend = self._friends_by_name.pop(id)
105                     self._register_match(contact, matched_friend)
106                     break
107                 
108         return matched_friend
109     
110
111     # -----------------------------------------------------------------------
112     def _register_match(self, contact, friend):
113         friend.set_contact(contact)
114         self._friends_without_contact.discard(friend)
115         self._friends_by_contact[contact] = friend
116         self._contacts_by_friend[friend] = contact
117
118
119     # -----------------------------------------------------------------------
120     def _get_friends_data(self):
121         """Returns a list of dicts, where each dict represents a friend/contact"""
122         
123         return self.fb.users.getInfo(self.fb.friends.get(), Service.attrs)