vcs.maemo.org Git - hermes/blob - package/src/org/maemo/hermes/engine/friend.py

   1 class Friend():
   2     """Encapsulate the data from a remote service.
   3
   4        Copyright (c) Fredrik Wendt <fredrik@wendt.se> 2010.
   5        Released under the Artistic Licence."""
   6
   7
   8     def __init__(self, name=None, source=None, props=None):
   9         """ source is source service, such as LinkedIn """
  10         self._attributes = {};
  11         if name: self._set('fn', name)
  12         self._multi_attributes = {}
  13         self._source = source
  14         if props:
  15             for key in props:
  16                 self._set(key, props[key])
  17
  18     def __getitem__(self, key):
  19         return self._safe_get(key)
  20
  21     def __unicode__(self):
  22         return self.__repr__()
  23
  24     def __repr__(self):
  25         return "Friend %s" % self.get_name()
  26
  27     # public accessors -----------------
  28
  29     def add_url(self, url):
  30         self._add('url', url)
  31
  32     def get_birthday_date(self):
  33         return self._safe_get('bday')
  34
  35     def get_contact(self):
  36         return self._safe_get('contact')
  37
  38     def get_name(self):
  39         return self._safe_get('fn')
  40
  41     def get_source(self):
  42         return self._source
  43
  44     def get_nickname(self):
  45         return self._safe_get("nickname")
  46
  47     def get_urls(self):
  48         try: return self._multi_attributes['url']
  49         except: return []
  50
  51     def get_photo_url(self):
  52         return self._safe_get('photo-url')
  53
  54     def has_birthday_date(self):
  55         return self._has('bday')
  56
  57     def is_empty(self):
  58         for a in self._attributes:
  59             return False
  60         for a in self._multi_attributes:
  61             return False
  62         return True
  63
  64     def set_name(self, name):
  65         self._set('fn', name)
  66
  67     def set_nickname(self, nickname):
  68         self._set('nickname', nickname)
  69
  70     def set_birthday_date(self, date):
  71         self._set('bday', date)
  72
  73     def set_contact(self, contact):
  74         self._set('contact', contact)
  75
  76     def set_photo_url(self, url):
  77         self._set('photo-url', url)
  78
  79     def update_from_friend(self, other_friend, overwrite=False):
  80         """
  81         Overwrites any attributes in this friend, with attributes from other_friend
  82         """
  83
  84         self._attributes.update(other_friend._attributes)
  85
  86         for key in other_friend._multi_attributes.keys():
  87             for value in other_friend._multi_attributes[key]:
  88                 self._add(key, value)
  89
  90     def update_contact(self, contact, overwrite=False):
  91         """
  92         Updates the contact with information from this object,
  93         without overwriting unless overwrite is set to True.
  94         """
  95
  96         # FIXME: currently we overwrite everything
  97         self._if_defined('photo-url', contact.set_photo)
  98         self._if_defined('nickname', contact.set_nickname)
  99         if self._multi_attributes.has_key('url'):
 100             for url in self._multi_attributes['url']:
 101                 contact.add_url(url)
 102
 103         def fixme(arg):
 104             pass
 105             #print "FIXME - birthday date needs to be parsed/fixed %s before calling contact.set_birthday" % arg
 106         self._if_defined('bday', fixme)
 107
 108     # private helpers -----------------------
 109     #
 110     def _add(self, key, value):
 111         if value is not None:
 112             if not self._multi_attributes.has_key(key):
 113                 self._multi_attributes[key] = []
 114 #            print "%s ADD %s to %s" % (self, key, value)
 115             self._multi_attributes[key].append(value)
 116
 117     def _contains(self, key, value):
 118         if self._attributes.has_key(key):
 119             return value == self._attributes[key]
 120         if self._multi_attributes.has_key(key):
 121             return value in self._multi_attributes[key]
 122         return False
 123
 124     def _if_defined(self, key, callback):
 125         if self._attributes.has_key(key):
 126             callback(self._attributes[key])
 127
 128     def _has(self, key):
 129         return self._attributes.has_key(key) or self._multi_attributes.has_key(key)
 130
 131     def _safe_get(self, key):
 132         try: return self._attributes[key]
 133         except: return None
 134
 135     def _set(self, key, value):
 136         if value is not None:
 137 #            print "%s SET %s to %s" % (self, key, value)
 138             self._attributes[key] = value
 139