vcs.maemo.org Git - hermes/blob - 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, service_id, facebook, create_birthday_only = False):
  18         self.fb = facebook
  19         self._service_id = service_id
  20         self._create_birthday_only = create_birthday_only
  21
  22         self._friends_by_name = {}
  23         self._friends_by_url = {}
  24         self._friends_by_contact = {}
  25         self._contacts_by_friend = {}
  26         self._friends_without_contact = set()
  27         self._known_urls = set()
  28
  29
  30     # -----------------------------------------------------------------------
  31     def get_friends_to_create_contacts_for(self):
  32         friends = []
  33         if self._create_birthday_only:
  34             for friend in self._friends_without_contact:
  35                 if friend.has_birthday_date():
  36                     friends.append(friend)
  37
  38         return friends
  39
  40
  41     # -----------------------------------------------------------------------
  42     def get_friends(self):
  43         """Returns all friends on Facebook"""
  44
  45         return self._friends_by_url.values()
  46
  47
  48     # -----------------------------------------------------------------------
  49     def get_contacts_with_match(self):
  50         """Returns a dict, where each key value pair is a contact (key) that
  51            matched a friend (value)"""
  52
  53         return self._friends_by_contact
  54
  55
  56     # -----------------------------------------------------------------------
  57     def get_unmatched_friends(self):
  58         """Returns a list of all friends that didn't match a contact."""
  59
  60         return self._friends_without_contact
  61
  62
  63     # -----------------------------------------------------------------------
  64     def pre_process_contact(self, contact):
  65         """Registers URLs of all previous mappings, and makes sure that any
  66            friend with such a URL don't get match by name."""
  67
  68         for url in contact.get_urls():
  69             self._known_urls.add(url)
  70
  71
  72     # -----------------------------------------------------------------------
  73     def process_friends(self):
  74         """Retreives data from Facebook and parse that into Friend
  75            objects."""
  76
  77         def if_defined(data, key, callback):
  78             if key in data and data[key]:
  79                 print key, data[key]
  80                 callback(data[key])
  81
  82         friends_data = self._get_friends_data()
  83         for data in friends_data:
  84             friend = Friend(data['name'])
  85
  86             if 'profile_url' not in data:
  87                 data['profile_url'] = "http://www.facebook.com/profile.php?id=" + str(data['uid'])
  88
  89             if_defined(data, 'website', friend.add_url)
  90             if_defined(data, 'profile_url', friend.add_url)
  91             if_defined(data, 'birthday_date', friend.set_birthday_date)
  92
  93             if_defined(data, 'pic_big', friend.set_photo_url)
  94
  95             url = data['profile_url']
  96             friend.add_url(url)
  97             self._register_friend(friend)
  98
  99
 100     # -----------------------------------------------------------------------
 101     def process_contact(self, contact):
 102         """If the contact is matched with a friend, that friend is returned,
 103            otherwise None."""
 104
 105         matched_friend = None
 106         if self._friends_by_contact.has_key(contact):
 107             matched_friend = self._friends_by_contact[contact]
 108
 109         # we might get a hit if the friend has setup a URL with another service,
 110         # such as putting the id link to Facebook on the Twitter account's profile
 111         if not matched_friend:
 112             for url in contact.get_urls():
 113                 if url in self._friends_by_url:
 114                     matched_friend = self._friends_by_url[url]
 115                     self._register_match(contact, matched_friend)
 116                     break
 117
 118         if not matched_friend:
 119             for id in contact.get_identifiers():
 120                 if id in self._friends_by_name:
 121                     matched_friend = self._friends_by_name.pop(id)
 122                     self._register_match(contact, matched_friend)
 123                     break
 124
 125         return matched_friend
 126
 127
 128     # -----------------------------------------------------------------------
 129     def _register_friend(self, friend):
 130         self._friends_without_contact.add(friend)
 131
 132         for url in friend.get_urls():
 133             if self.is_profile_url(url):
 134                 self._friends_by_url[url] = friend
 135
 136         if self._allow_friend_to_match_by_name(friend):
 137             key = canonical(friend.get_name())
 138             self._friends_by_name[key] = friend
 139
 140
 141     # -----------------------------------------------------------------------
 142     def is_profile_url(self, url):
 143         """Return True if this is a URL for this service."""
 144
 145         return url and "facebook.com" in url
 146
 147
 148     # -----------------------------------------------------------------------
 149     def _allow_friend_to_match_by_name(self, friend):
 150         for url in friend.get_urls():
 151             if url in self._known_urls:
 152                 return False
 153         return True
 154
 155
 156     # -----------------------------------------------------------------------
 157     def _register_match(self, contact, friend):
 158         friend.set_contact(contact)
 159         self._friends_without_contact.discard(friend)
 160         self._friends_by_contact[contact] = friend
 161         self._contacts_by_friend[friend] = contact
 162
 163
 164     # -----------------------------------------------------------------------
 165     def _get_friends_data(self):
 166         """Returns a list of dicts, where each dict represents the raw data
 167            of a friend"""
 168
 169         return self.fb.users.getInfo(self.fb.friends.get(), Service.attrs)