git.maemo.org Git - hermes/blob - package/src/org/maemo/hermes/engine/gravatar/service.py

   1 import urllib, hashlib, xmlrpclib
   2 import org.maemo.hermes.engine.service
   3
   4 class Service(org.maemo.hermes.engine.service.Service):
   5     """Gravatar backend for Hermes.
   6
   7        Copyright (c) Fredrik Wendt <fredrik@wendt.se> 2010.
   8        Released under the Artistic Licence."""
   9
  10     _image_url_base = "http://www.gravatar.com/avatar.php?"
  11
  12     # -----------------------------------------------------------------------
  13     def __init__(self, api_email, api_key):
  14         """Initialise the Gravatar service.
  15
  16         api_email is the email address to use when talking to the backend.
  17         api_key is the "secret" key used when talking to the backend
  18         """
  19         self._api_email = api_email
  20         self._api_key = api_key
  21         if self._api_key is None or self._api_email is None:
  22             raise Exception('No Gravatar application keys found. Installation error.')
  23
  24         self._address_to_contact = {}
  25         self._hash_to_address = {}
  26         self._hash_has_gravatar = {}
  27         self._empty_cache = True
  28
  29         self._friends_by_contact = {}
  30         self._contacts_by_friend = {}
  31
  32         self._api_url = 'https://secure.gravatar.com/xmlrpc?user=' + hashlib.md5(self._api_email).hexdigest()
  33
  34
  35     # -----------------------------------------------------------------------
  36     def get_name(self):
  37         return "Gravatar"
  38
  39
  40     # -----------------------------------------------------------------------
  41     def pre_process_contact(self, contact):
  42         """Extracts addresses from the contact."""
  43         for address in contact.get_emails():
  44             self._address_to_contact[address] = contact
  45
  46
  47     # -----------------------------------------------------------------------
  48     def process_contact(self, contact):
  49         """On first call (with a contact missing a photo), go get data from Gravatar's servers."""
  50
  51         if not self._has_photo(contact):
  52             for address in contact.get_emails():
  53                 hash = self._get_hash_for_address(address)
  54                 if (self._hash_has_gravatar.has_key(hash) and self._hash_has_gravatar[hash]):
  55                     friend = self._create_friend(contact.get_name())
  56                     friend.set_photo_url(self._get_url_for_email_hash(hash))
  57                     self._register_match(contact, friend)
  58                     return friend
  59
  60         return None
  61
  62
  63     # -----------------------------------------------------------------------
  64     def process_friends(self):
  65         self._lookup_addresses()
  66
  67
  68     # -----------------------------------------------------------------------
  69     def get_friends(self):
  70         return self._contacts_by_friend.keys()
  71
  72
  73     def get_contacts_with_match(self):
  74         """Returns a dict with Contact objects as keys and Friend objects as values"""
  75         return self._friends_by_contact
  76
  77
  78     def get_unmatched_friends(self):
  79         """Will always return None - Gravatar only reacts on e-mail address input."""
  80         return None
  81
  82
  83
  84
  85     # -----------------------------------------------------------------------
  86     def _register_match(self, contact, friend):
  87         friend.set_contact(contact)
  88         self._friends_by_contact[contact] = friend
  89         self._contacts_by_friend[friend] = contact
  90
  91     # -----------------------------------------------------------------------
  92     # FIXME
  93     def _has_photo(self, contact):
  94         return False
  95
  96
  97     # -----------------------------------------------------------------------
  98     def _lookup_addresses(self):
  99         """Constructs hashes for address_to_contact, makes call to the Gravatar.com service and updates
 100         self._hash_has_gravatar"""
 101
 102         addresses = self._address_to_contact.keys()
 103         if len(addresses) == 0:
 104             self._set_hash_information({})
 105         else:
 106             args = { "apikey" : self._api_key}
 107             hashes = self._construct_hashes(addresses)
 108             args["hashes"] = list(hashes)
 109             url = self._api_url
 110             self._set_hash_information(self._get_hash_info_from_server(args, url))
 111
 112
 113     # -----------------------------------------------------------------------
 114     def _get_hash_info_from_server(self, args, url):
 115         """Makes the actual XML-RPC call - override this for testing"""
 116
 117         service = xmlrpclib.ServerProxy(url)
 118         return service.grav.exists(args)
 119
 120
 121     # -----------------------------------------------------------------------
 122     def _set_hash_information(self, hash_info):
 123         self._hash_has_gravatar = hash_info
 124         self._empty_cache = False
 125
 126
 127     # -----------------------------------------------------------------------
 128     def _get_url_for_email_hash(self, hash, default="404", size="128"):
 129         """Assembles the URL to a gravatar, based on a hash of an e-mail address"""
 130
 131         return self._image_url_base + urllib.urlencode({'gravatar_id':hash, 'd':default, 'size':size})
 132
 133
 134     # -----------------------------------------------------------------------
 135     def _construct_hashes(self, addresses):
 136         """Creates hashes for all addresses specified, returning a set of hashes"""
 137
 138         result = set()
 139         for address in addresses:
 140             hash = self._get_hash_for_address(address)
 141             self._hash_to_address[hash] = address
 142             result.add(hash)
 143
 144         return result
 145
 146     # -----------------------------------------------------------------------
 147     def _get_hash_for_address(self, address):
 148         return hashlib.md5(address.lower()).hexdigest()