sleekxmpp/plugins/xep_0033/stanza.py

   1 """
   2     SleekXMPP: The Sleek XMPP Library
   3     Copyright (C) 2012 Nathanael C. Fritz, Lance J.T. Stout
   4     This file is part of SleekXMPP.
   5
   6     See the file LICENSE for copying permission.
   7 """
   8
   9 from sleekxmpp.xmlstream import JID, ElementBase, ET, register_stanza_plugin
  10
  11
  12 class Addresses(ElementBase):
  13
  14     name = 'addresses'
  15     namespace = 'http://jabber.org/protocol/address'
  16     plugin_attrib = 'addresses'
  17     interfaces = set()
  18
  19     def add_address(self, atype='to', jid='', node='', uri='',
  20                           desc='', delivered=False):
  21         addr = Address(parent=self)
  22         addr['type'] = atype
  23         addr['jid'] = jid
  24         addr['node'] = node
  25         addr['uri'] = uri
  26         addr['desc'] = desc
  27         addr['delivered'] = delivered
  28
  29         return addr
  30
  31     # Additional methods for manipulating sets of addresses
  32     # based on type are generated below.
  33
  34
  35 class Address(ElementBase):
  36
  37     name = 'address'
  38     namespace = 'http://jabber.org/protocol/address'
  39     plugin_attrib = 'address'
  40     interfaces = set(['type', 'jid', 'node', 'uri', 'desc', 'delivered'])
  41
  42     address_types = set(('bcc', 'cc', 'noreply', 'replyroom', 'replyto', 'to'))
  43
  44     def get_jid(self):
  45         return JID(self._get_attr('jid'))
  46
  47     def set_jid(self, value):
  48         self._set_attr('jid', str(value))
  49
  50     def get_delivered(self):
  51         value = self._get_attr('delivered', False)
  52         return value and value.lower() in ('true', '1')
  53
  54     def set_delivered(self, delivered):
  55         if delivered:
  56             self._set_attr('delivered', 'true')
  57         else:
  58             del self['delivered']
  59
  60     def set_uri(self, uri):
  61         if uri:
  62             del self['jid']
  63             del self['node']
  64             self._set_attr('uri', uri)
  65         else:
  66             self._del_attr('uri')
  67
  68
  69 # =====================================================================
  70 # Auto-generate address type filters for the Addresses class.
  71
  72 def _addr_filter(atype):
  73     def _type_filter(addr):
  74         if isinstance(addr, Address):
  75             if atype == 'all' or addr['type'] == atype:
  76                 return True
  77         return False
  78     return _type_filter
  79
  80
  81 def _build_methods(atype):
  82
  83     def get_multi(self):
  84         return list(filter(_addr_filter(atype), self))
  85
  86     def set_multi(self, value):
  87         del self[atype]
  88         for addr in value:
  89
  90             # Support assigning dictionary versions of addresses
  91             # instead of full Address objects.
  92             if not isinstance(addr, Address):
  93                 if atype != 'all':
  94                     addr['type'] = atype
  95                 elif 'atype' in addr and 'type' not in addr:
  96                     addr['type'] = addr['atype']
  97                 addrObj = Address()
  98                 addrObj.values = addr
  99                 addr = addrObj
 100
 101             self.append(addr)
 102
 103     def del_multi(self):
 104         res = list(filter(_addr_filter(atype), self))
 105         for addr in res:
 106             self.iterables.remove(addr)
 107             self.xml.remove(addr.xml)
 108
 109     return get_multi, set_multi, del_multi
 110
 111
 112 for atype in ('all', 'bcc', 'cc', 'noreply', 'replyroom', 'replyto', 'to'):
 113     get_multi, set_multi, del_multi = _build_methods(atype)
 114
 115     Addresses.interfaces.add(atype)
 116     setattr(Addresses, "get_%s" % atype, get_multi)
 117     setattr(Addresses, "set_%s" % atype, set_multi)
 118     setattr(Addresses, "del_%s" % atype, del_multi)
 119
 120     # To retain backwards compatibility:
 121     setattr(Addresses, "get%s" % atype.title(), get_multi)
 122     setattr(Addresses, "set%s" % atype.title(), set_multi)
 123     setattr(Addresses, "del%s" % atype.title(), del_multi)
 124     if atype == 'all':
 125         Addresses.interfaces.add('addresses')
 126         setattr(Addresses, "getAddresses", get_multi)
 127         setattr(Addresses, "setAddresses", set_multi)
 128         setattr(Addresses, "delAddresses", del_multi)
 129
 130
 131 register_stanza_plugin(Addresses, Address, iterable=True)