def get_body(self, lang=None):
"""Return the contents of the HTML body."""
if lang is None:
lang = self.get_lang()
bodies = self.xml.findall('{%s}body' % XHTML_NS)
if lang == '*':
result = OrderedDict()
for body in bodies:
body_lang = body.attrib.get('{%s}lang' % self.xml_ns, '')
body_result = []
body_result.append(body.text if body.text else '')
for child in body:
body_result.append(tostring(child, xmlns=XHTML_NS))
body_result.append(body.tail if body.tail else '')
result[body_lang] = ''.join(body_result)
return result
else:
for body in bodies:
if body.attrib.get('{%s}lang' % self.xml_ns, self.get_lang()) == lang:
result = []
result.append(body.text if body.text else '')
for child in body:
result.append(tostring(child, xmlns=XHTML_NS))
result.append(body.tail if body.tail else '')
return ''.join(result)
return ''
def get_features(self):
"""
"""
features = OrderedDict()
for (name, lang), plugin in self.plugins.items():
features[name] = plugin
return features
def get_fields(self, use_dict=False):
fields = OrderedDict()
fields_xml = self.xml.findall('{%s}field' % self.namespace)
for field_xml in fields_xml:
field = FormField(xml=field_xml)
fields[field['var']] = field
return fields
def get_fields(self, use_dict=False):
fields = OrderedDict()
fieldsXML = self.xml.findall('{%s}field' % FormField.namespace)
for fieldXML in fieldsXML:
field = FormField(xml=fieldXML)
fields[field['var']] = field
return fields
def testCancelType(self):
"""Test that setting type to 'cancel' clears all fields"""
msg = self.Message()
form = msg['form']
fields = OrderedDict()
fields['f1'] = {'type': 'text-single',
'label': 'Username',
'required': True}
fields['f2'] = {'type': 'text-private',
'label': 'Password',
'required': True}
fields['f3'] = {'type': 'text-multi',
'label': 'Message',
'value': 'Enter message.\nA long one even.'}
fields['f4'] = {'type': 'list-single',
'label': 'Message Type',
'options': [{'label': 'Cool!',
'value': 'cool'},
{'label': 'Urgh!',
'value': 'urgh'}]}
form['fields'] = fields
form['type'] = 'cancel'
self.check(form, """
<x xmlns="jabber:x:data" type="cancel" />
""")
def get_reported(self):
fields = OrderedDict()
xml = self.xml.findall('{%s}reported/{%s}field' %
(self.namespace, FormField.namespace))
for field in xml:
field = FormField(xml=field)
fields[field['var']] = field
return fields
def get_body(self, lang=None):
"""Return the contents of the HTML body."""
if lang is None:
lang = self.get_lang()
bodies = self.xml.findall('{%s}body' % XHTML_NS)
if lang == '*':
result = OrderedDict()
for body in bodies:
body_lang = body.attrib.get('{%s}lang' % self.xml_ns, '')
body_result = []
body_result.append(body.text if body.text else '')
for child in body:
body_result.append(tostring(child, xmlns=XHTML_NS))
body_result.append(body.tail if body.tail else '')
result[body_lang] = ''.join(body_result)
return result
else:
for body in bodies:
if body.attrib.get('{%s}lang' % self.xml_ns, self.get_lang()) == lang:
result = []
result.append(body.text if body.text else '')
for child in body:
result.append(tostring(child, xmlns=XHTML_NS))
result.append(body.tail if body.tail else '')
return ''.join(result)
return ''
def get_reported(self):
reported = OrderedDict()
fields = self.xml.findall('{%s}reported/{%s}field' %
(self.namespace, self.namespace))
for field_xml in fields:
field = FormField(xml=field_xml)
reported[field['var']] = field
return reported
def __init__(self, xml=None, parent=None):
self._index = 0
#: The underlying XML object for the stanza. It is a standard
#: :class:`xml.etree.cElementTree` object.
self.xml = xml
#: An ordered dictionary of plugin stanzas, mapped by their
#: :attr:`plugin_attrib` value.
self.plugins = OrderedDict()
#: A list of child stanzas whose class is included in
#: :attr:`plugin_iterables`.
self.iterables = []
#: The name of the tag for the stanza's root element. It is the
#: same as calling :meth:`tag_name()` and is formatted as
#: ``'{namespace}elementname'``.
self.tag = self.tag_name()
#: A :class:`weakref.weakref` to the parent stanza, if there is one.
#: If not, then :attr:`parent` is ``None``.
self.parent = None
if parent is not None:
self.parent = weakref.ref(parent)
if self.subitem is not None:
for sub in self.subitem:
self.plugin_iterables.add(sub)
if self.setup(xml):
# If we generated our own XML, then everything is ready.
return
# Initialize values using provided XML
for child in self.xml.getchildren():
if child.tag in self.plugin_tag_map:
plugin_class = self.plugin_tag_map[child.tag]
plugin = plugin_class(child, self)
self.plugins[plugin.plugin_attrib] = plugin
if plugin_class in self.plugin_iterables:
self.iterables.append(plugin)
def get_items(self):
items = []
itemsXML = self.xml.findall('{%s}item' % self.namespace)
for itemXML in itemsXML:
item = OrderedDict()
fieldsXML = itemXML.findall('{%s}field' % FormField.namespace)
for fieldXML in fieldsXML:
field = FormField(xml=fieldXML)
item[field['var']] = field['value']
items.append(item)
return items
def __init__(self, xml=None, parent=None):
"""
Create a new stanza object.
Arguments:
xml -- Initialize the stanza with optional existing XML.
parent -- Optional stanza object that contains this stanza.
"""
self.xml = xml
self.plugins = OrderedDict()
self.iterables = []
self._index = 0
self.tag = self.tag_name()
if parent is None:
self.parent = None
else:
self.parent = weakref.ref(parent)
ElementBase.values = property(ElementBase._get_stanza_values,
ElementBase._set_stanza_values)
if self.subitem is not None:
for sub in self.subitem:
self.plugin_iterables.add(sub)
if self.setup(xml):
# If we generated our own XML, then everything is ready.
return
# Initialize values using provided XML
for child in self.xml.getchildren():
if child.tag in self.plugin_tag_map:
plugin = self.plugin_tag_map[child.tag]
self.plugins[plugin.plugin_attrib] = plugin(child, self)
for sub in self.plugin_iterables:
if child.tag == "{%s}%s" % (sub.namespace, sub.name):
self.iterables.append(sub(child, self))
break
def get_headers(self):
result = OrderedDict()
headers = self.xml.findall('{%s}header' % self.namespace)
for header in headers:
name = header.attrib.get('name', '')
value = header.text
if name in result:
if not isinstance(result[name], set):
result[name] = [result[name]]
else:
result[name] = []
result[name].add(value)
else:
result[name] = value
return result
def testSubmitType(self):
"""Test that setting type to 'submit' clears extra details"""
msg = self.Message()
form = msg['form']
fields = OrderedDict()
fields['f1'] = {'type': 'text-single',
'label': 'Username',
'required': True}
fields['f2'] = {'type': 'text-private',
'label': 'Password',
'required': True}
fields['f3'] = {'type': 'text-multi',
'label': 'Message',
'value': 'Enter message.\nA long one even.'}
fields['f4'] = {'type': 'list-single',
'label': 'Message Type',
'options': [{'label': 'Cool!',
'value': 'cool'},
{'label': 'Urgh!',
'value': 'urgh'}]}
form['fields'] = fields
form['type'] = 'submit'
form['values'] = {'f1': 'username',
'f2': 'hunter2',
'f3': 'A long\nmultiline\nmessage',
'f4': 'cool'}
self.check(form, """
<x xmlns="jabber:x:data" type="submit">
<field var="f1">
<value>username</value>
</field>
<field var="f2">
<value>hunter2</value>
</field>
<field var="f3">
<value>A long</value>
<value>multiline</value>
<value>message</value>
</field>
<field var="f4">
<value>cool</value>
</field>
</x>
""", use_values=False)
def __init__(self, xml=None, parent=None):
self._index = 0
#: The underlying XML object for the stanza. It is a standard
#: :class:`xml.etree.cElementTree` object.
self.xml = xml
#: An ordered dictionary of plugin stanzas, mapped by their
#: :attr:`plugin_attrib` value.
self.plugins = OrderedDict()
#: A list of child stanzas whose class is included in
#: :attr:`plugin_iterables`.
self.iterables = []
#: The name of the tag for the stanza's root element. It is the
#: same as calling :meth:`tag_name()` and is formatted as
#: ``'{namespace}elementname'``.
self.tag = self.tag_name()
#: A :class:`weakref.weakref` to the parent stanza, if there is one.
#: If not, then :attr:`parent` is ``None``.
self.parent = None
if parent is not None:
self.parent = weakref.ref(parent)
if self.subitem is not None:
for sub in self.subitem:
self.plugin_iterables.add(sub)
if self.setup(xml):
# If we generated our own XML, then everything is ready.
return
# Initialize values using provided XML
for child in self.xml.getchildren():
if child.tag in self.plugin_tag_map:
plugin_class = self.plugin_tag_map[child.tag]
plugin = plugin_class(child, self)
self.plugins[plugin.plugin_attrib] = plugin
if plugin_class in self.plugin_iterables:
self.iterables.append(plugin)
def __init__(self, xml=None, parent=None):
"""
Create a new stanza object.
Arguments:
xml -- Initialize the stanza with optional existing XML.
parent -- Optional stanza object that contains this stanza.
"""
self._getitem_cache = {}
self.xml = xml
self.plugins = OrderedDict()
self.iterables = []
self._index = 0
self.tag = self.tag_name()
if parent is None:
self.parent = None
else:
self.parent = weakref.ref(parent)
ElementBase.values = property(ElementBase._get_stanza_values,
ElementBase._set_stanza_values)
if self.subitem is not None:
for sub in self.subitem:
self.plugin_iterables.add(sub)
if self.setup(xml):
# If we generated our own XML, then everything is ready.
return
# Initialize values using provided XML
for child in self.xml.getchildren():
if child.tag in self.plugin_tag_map:
plugin = self.plugin_tag_map[child.tag]
self.plugins[plugin.plugin_attrib] = plugin(child, self)
for sub in self.plugin_iterables:
if child.tag == "{%s}%s" % (sub.namespace, sub.name):
self.iterables.append(sub(child, self))
break
def __init__(self, *args, **kwargs):
"""
"""
ElementBase.__init__(self, *args, **kwargs)
self.field = OrderedDict()
self.addField = self.add_field
self.addReported = self.add_reported
self.addItem = self.add_item
self.setItems = self.set_items
self.delItems = self.del_items
self.getItems = self.get_items
self.getInstructions = self.get_instructions
self.setInstructions = self.set_instructions
self.delInstructions = self.del_instructions
self.getFields = self.get_fields
self.setFields = self.set_fields
self.delFields = self.del_fields
self.getValues = self.get_values
self.setValues = self.set_values
self.getReported = self.get_reported
self.setReported = self.set_reported
self.delReported = self.del_reported
def testStarLang(self):
"""Test using interface|*."""
class TestStanza(ElementBase):
name = 'foo'
namespace = 'test'
interfaces = set(['test'])
sub_interfaces = interfaces
lang_interfaces = interfaces
data = OrderedDict()
data['en'] = 'hi'
data['fr'] = 'bonjour'
data['no'] = 'hej'
stanza = TestStanza()
stanza['test|*'] = data
self.check(
stanza, """
<foo xmlns="test">
<test xml:lang="en">hi</test>
<test xml:lang="fr">bonjour</test>
<test xml:lang="no">hej</test>
</foo>
""")
data2 = stanza['test|*']
self.assertEqual(data, data2,
"Did not extract expected language data: %s" % data2)
del stanza['test|*']
self.check(stanza, """
<foo xmlns="test" />
""")
#: The reverse mapping of escape sequences to their original forms.
JID_UNESCAPE_TRANSFORMATIONS = {
'\\20': ' ',
'\\22': '"',
'\\26': '&',
'\\27': "'",
'\\2f': '/',
'\\3a': ':',
'\\3c': '<',
'\\3e': '>',
'\\40': '@',
'\\5c': '\\'
}
JID_CACHE = OrderedDict()
JID_CACHE_LOCK = threading.Lock()
JID_CACHE_MAX_SIZE = 1024
def _cache(key, parts, locked):
JID_CACHE[key] = (parts, locked)
if len(JID_CACHE) > JID_CACHE_MAX_SIZE:
with JID_CACHE_LOCK:
while len(JID_CACHE) > JID_CACHE_MAX_SIZE:
found = None
for key, item in JID_CACHE.items():
if not item[1]: # if not locked
found = key
break
if not found: # more than MAX_SIZE locked
class ElementBase(object):
"""
The core of SleekXMPP's stanza XML manipulation and handling is provided
by ElementBase. ElementBase wraps XML cElementTree objects and enables
access to the XML contents through dictionary syntax, similar in style
to the Ruby XMPP library Blather's stanza implementation.
Stanzas are defined by their name, namespace, and interfaces. For
example, a simplistic Message stanza could be defined as::
>>> class Message(ElementBase):
... name = "message"
... namespace = "jabber:client"
... interfaces = set(('to', 'from', 'type', 'body'))
... sub_interfaces = set(('body',))
The resulting Message stanza's contents may be accessed as so::
>>> message['to'] = "*****@*****.**"
>>> message['body'] = "Hi!"
>>> message['body']
"Hi!"
>>> del message['body']
>>> message['body']
""
The interface values map to either custom access methods, stanza
XML attributes, or (if the interface is also in sub_interfaces) the
text contents of a stanza's subelement.
Custom access methods may be created by adding methods of the
form "getInterface", "setInterface", or "delInterface", where
"Interface" is the titlecase version of the interface name.
Stanzas may be extended through the use of plugins. A plugin
is simply a stanza that has a plugin_attrib value. For example::
>>> class MessagePlugin(ElementBase):
... name = "custom_plugin"
... namespace = "custom"
... interfaces = set(('useful_thing', 'custom'))
... plugin_attrib = "custom"
The plugin stanza class must be associated with its intended
container stanza by using register_stanza_plugin as so::
>>> register_stanza_plugin(Message, MessagePlugin)
The plugin may then be accessed as if it were built-in to the parent
stanza::
>>> message['custom']['useful_thing'] = 'foo'
If a plugin provides an interface that is the same as the plugin's
plugin_attrib value, then the plugin's interface may be assigned
directly from the parent stanza, as shown below, but retrieving
information will require all interfaces to be used, as so::
>>> message['custom'] = 'bar' # Same as using message['custom']['custom']
>>> message['custom']['custom'] # Must use all interfaces
'bar'
If the plugin sets :attr:`is_extension` to ``True``, then both setting
and getting an interface value that is the same as the plugin's
plugin_attrib value will work, as so::
>>> message['custom'] = 'bar' # Using is_extension=True
>>> message['custom']
'bar'
:param xml: Initialize the stanza object with an existing XML object.
:param parent: Optionally specify a parent stanza object will will
contain this substanza.
"""
#: The XML tag name of the element, not including any namespace
#: prefixes. For example, an :class:`ElementBase` object for ``<message />``
#: would use ``name = 'message'``.
name = 'stanza'
#: The XML namespace for the element. Given ``<foo xmlns="bar" />``,
#: then ``namespace = "bar"`` should be used. The default namespace
#: is ``jabber:client`` since this is being used in an XMPP library.
namespace = 'jabber:client'
#: For :class:`ElementBase` subclasses which are intended to be used
#: as plugins, the ``plugin_attrib`` value defines the plugin name.
#: Plugins may be accessed by using the ``plugin_attrib`` value as
#: the interface. An example using ``plugin_attrib = 'foo'``::
#:
#: register_stanza_plugin(Message, FooPlugin)
#: msg = Message()
#: msg['foo']['an_interface_from_the_foo_plugin']
plugin_attrib = 'plugin'
#: The set of keys that the stanza provides for accessing and
#: manipulating the underlying XML object. This set may be augmented
#: with the :attr:`plugin_attrib` value of any registered
#: stanza plugins.
interfaces = set(('type', 'to', 'from', 'id', 'payload'))
#: A subset of :attr:`interfaces` which maps interfaces to direct
#: subelements of the underlying XML object. Using this set, the text
#: of these subelements may be set, retrieved, or removed without
#: needing to define custom methods.
sub_interfaces = tuple()
#: In some cases you may wish to override the behaviour of one of the
#: parent stanza's interfaces. The ``overrides`` list specifies the
#: interface name and access method to be overridden. For example,
#: to override setting the parent's ``'condition'`` interface you
#: would use::
#:
#: overrides = ['set_condition']
#:
#: Getting and deleting the ``'condition'`` interface would not
#: be affected.
#:
#: .. versionadded:: 1.0-Beta5
overrides = []
#: If you need to add a new interface to an existing stanza, you
#: can create a plugin and set ``is_extension = True``. Be sure
#: to set the :attr:`plugin_attrib` value to the desired interface
#: name, and that it is the only interface listed in
#: :attr:`interfaces`. Requests for the new interface from the
#: parent stanza will be passed to the plugin directly.
#:
#: .. versionadded:: 1.0-Beta5
is_extension = False
#: A map of interface operations to the overriding functions.
#: For example, after overriding the ``set`` operation for
#: the interface ``body``, :attr:`plugin_overrides` would be::
#:
#: {'set_body': <some function>}
#:
#: .. versionadded: 1.0-Beta5
plugin_overrides = {}
#: A mapping of the :attr:`plugin_attrib` values of registered
#: plugins to their respective classes.
plugin_attrib_map = {}
#: A mapping of root element tag names (in ``'{namespace}elementname'``
#: format) to the plugin classes responsible for them.
plugin_tag_map = {}
#: The set of stanza classes that can be iterated over using
#: the 'substanzas' interface. Classes are added to this set
#: when registering a plugin with ``iterable=True``::
#:
#: register_stanza_plugin(DiscoInfo, DiscoItem, iterable=True)
#:
#: .. versionadded:: 1.0-Beta5
plugin_iterables = set()
#: A deprecated version of :attr:`plugin_iterables` that remains
#: for backward compatibility. It required a parent stanza to
#: know beforehand what stanza classes would be iterable::
#:
#: class DiscoItem(ElementBase):
#: ...
#:
#: class DiscoInfo(ElementBase):
#: subitem = (DiscoItem, )
#: ...
#:
#: .. deprecated:: 1.0-Beta5
subitem = set()
#: The default XML namespace: ``http://www.w3.org/XML/1998/namespace``.
xml_ns = 'http://www.w3.org/XML/1998/namespace'
def __init__(self, xml=None, parent=None):
self._index = 0
#: The underlying XML object for the stanza. It is a standard
#: :class:`xml.etree.cElementTree` object.
self.xml = xml
#: An ordered dictionary of plugin stanzas, mapped by their
#: :attr:`plugin_attrib` value.
self.plugins = OrderedDict()
#: A list of child stanzas whose class is included in
#: :attr:`plugin_iterables`.
self.iterables = []
#: The name of the tag for the stanza's root element. It is the
#: same as calling :meth:`tag_name()` and is formatted as
#: ``'{namespace}elementname'``.
self.tag = self.tag_name()
#: A :class:`weakref.weakref` to the parent stanza, if there is one.
#: If not, then :attr:`parent` is ``None``.
self.parent = None
if parent is not None:
self.parent = weakref.ref(parent)
if self.subitem is not None:
for sub in self.subitem:
self.plugin_iterables.add(sub)
if self.setup(xml):
# If we generated our own XML, then everything is ready.
return
# Initialize values using provided XML
for child in self.xml.getchildren():
if child.tag in self.plugin_tag_map:
plugin_class = self.plugin_tag_map[child.tag]
plugin = plugin_class(child, self)
self.plugins[plugin.plugin_attrib] = plugin
if plugin_class in self.plugin_iterables:
self.iterables.append(plugin)
def setup(self, xml=None):
"""Initialize the stanza's XML contents.
Will return ``True`` if XML was generated according to the stanza's
definition instead of building a stanza object from an existing
XML object.
:param xml: An existing XML object to use for the stanza's content
instead of generating new XML.
"""
if self.xml is None:
self.xml = xml
if self.xml is None:
# Generate XML from the stanza definition
for ename in self.name.split('/'):
new = ET.Element("{%s}%s" % (self.namespace, ename))
if self.xml is None:
self.xml = new
else:
last_xml.append(new)
last_xml = new
if self.parent is not None:
self.parent().xml.append(self.xml)
# We had to generate XML
return True
else:
# We did not generate XML
return False
def enable(self, attrib):
"""Enable and initialize a stanza plugin.
Alias for :meth:`init_plugin`.
:param string attrib: The :attr:`plugin_attrib` value of the
plugin to enable.
"""
return self.init_plugin(attrib)
def init_plugin(self, attrib):
"""Enable and initialize a stanza plugin.
:param string attrib: The :attr:`plugin_attrib` value of the
plugin to enable.
"""
if attrib not in self.plugins:
plugin_class = self.plugin_attrib_map[attrib]
plugin = plugin_class(parent=self)
self.plugins[attrib] = plugin
if plugin_class in self.plugin_iterables:
self.iterables.append(plugin)
return self
def _get_stanza_values(self):
"""Return A JSON/dictionary version of the XML content
exposed through the stanza's interfaces::
>>> msg = Message()
>>> msg.values
{'body': '', 'from': , 'mucnick': '', 'mucroom': '',
'to': , 'type': 'normal', 'id': '', 'subject': ''}
Likewise, assigning to :attr:`values` will change the XML
content::
>>> msg = Message()
>>> msg.values = {'body': 'Hi!', 'to': '*****@*****.**'}
>>> msg
'<message to="*****@*****.**"><body>Hi!</body></message>'
.. versionadded:: 1.0-Beta1
"""
values = {}
for interface in self.interfaces:
values[interface] = self[interface]
for plugin, stanza in self.plugins.items():
values[plugin] = stanza.values
if self.iterables:
iterables = []
for stanza in self.iterables:
iterables.append(stanza.values)
iterables[-1]['__childtag__'] = stanza.tag
values['substanzas'] = iterables
return values
def _set_stanza_values(self, values):
"""Set multiple stanza interface values using a dictionary.
Stanza plugin values may be set using nested dictionaries.
:param values: A dictionary mapping stanza interface with values.
Plugin interfaces may accept a nested dictionary that
will be used recursively.
.. versionadded:: 1.0-Beta1
"""
iterable_interfaces = [p.plugin_attrib for \
p in self.plugin_iterables]
for interface, value in values.items():
if interface == 'substanzas':
# Remove existing substanzas
for stanza in self.iterables:
self.xml.remove(stanza.xml)
self.iterables = []
# Add new substanzas
for subdict in value:
if '__childtag__' in subdict:
for subclass in self.plugin_iterables:
child_tag = "{%s}%s" % (subclass.namespace,
subclass.name)
if subdict['__childtag__'] == child_tag:
sub = subclass(parent=self)
sub.values = subdict
self.iterables.append(sub)
break
elif interface in self.interfaces:
self[interface] = value
elif interface in self.plugin_attrib_map:
if interface not in iterable_interfaces:
if interface not in self.plugins:
self.init_plugin(interface)
self.plugins[interface].values = value
return self
def __getitem__(self, attrib):
"""Return the value of a stanza interface using dict-like syntax.
Example::
>>> msg['body']
'Message contents'
Stanza interfaces are typically mapped directly to the underlying XML
object, but can be overridden by the presence of a ``get_attrib``
method (or ``get_foo`` where the interface is named ``'foo'``, etc).
The search order for interface value retrieval for an interface
named ``'foo'`` is:
1. The list of substanzas (``'substanzas'``)
2. The result of calling the ``get_foo`` override handler.
3. The result of calling ``get_foo``.
4. The result of calling ``getFoo``.
5. The contents of the ``foo`` subelement, if ``foo`` is listed
in :attr:`sub_interfaces`.
6. The value of the ``foo`` attribute of the XML object.
7. The plugin named ``'foo'``
8. An empty string.
:param string attrib: The name of the requested stanza interface.
"""
if attrib == 'substanzas':
return self.iterables
elif attrib in self.interfaces:
get_method = "get_%s" % attrib.lower()
get_method2 = "get%s" % attrib.title()
if self.plugin_overrides:
plugin = self.plugin_overrides.get(get_method, None)
if plugin:
if plugin not in self.plugins:
self.init_plugin(plugin)
handler = getattr(self.plugins[plugin], get_method, None)
if handler:
return handler()
if hasattr(self, get_method):
return getattr(self, get_method)()
elif hasattr(self, get_method2):
return getattr(self, get_method2)()
else:
if attrib in self.sub_interfaces:
return self._get_sub_text(attrib)
else:
return self._get_attr(attrib)
elif attrib in self.plugin_attrib_map:
if attrib not in self.plugins:
self.init_plugin(attrib)
if self.plugins[attrib].is_extension:
return self.plugins[attrib][attrib]
return self.plugins[attrib]
else:
return ''
def __setitem__(self, attrib, value):
"""Set the value of a stanza interface using dictionary-like syntax.
Example::
>>> msg['body'] = "Hi!"
>>> msg['body']
'Hi!'
Stanza interfaces are typically mapped directly to the underlying XML
object, but can be overridden by the presence of a ``set_attrib``
method (or ``set_foo`` where the interface is named ``'foo'``, etc).
The effect of interface value assignment for an interface
named ``'foo'`` will be one of:
1. Delete the interface's contents if the value is None.
2. Call the ``set_foo`` override handler, if it exists.
3. Call ``set_foo``, if it exists.
4. Call ``setFoo``, if it exists.
5. Set the text of a ``foo`` element, if ``'foo'`` is
in :attr:`sub_interfaces`.
6. Set the value of a top level XML attribute named ``foo``.
7. Attempt to pass the value to a plugin named ``'foo'`` using
the plugin's ``'foo'`` interface.
8. Do nothing.
:param string attrib: The name of the stanza interface to modify.
:param value: The new value of the stanza interface.
"""
if attrib in self.interfaces:
if value is not None:
set_method = "set_%s" % attrib.lower()
set_method2 = "set%s" % attrib.title()
if self.plugin_overrides:
plugin = self.plugin_overrides.get(set_method, None)
if plugin:
if plugin not in self.plugins:
self.init_plugin(plugin)
handler = getattr(self.plugins[plugin],
set_method, None)
if handler:
return handler(value)
if hasattr(self, set_method):
getattr(self, set_method)(value,)
elif hasattr(self, set_method2):
getattr(self, set_method2)(value,)
else:
if attrib in self.sub_interfaces:
return self._set_sub_text(attrib, text=value)
else:
self._set_attr(attrib, value)
else:
self.__delitem__(attrib)
elif attrib in self.plugin_attrib_map:
if attrib not in self.plugins:
self.init_plugin(attrib)
self.plugins[attrib][attrib] = value
return self
def __delitem__(self, attrib):
"""Delete the value of a stanza interface using dict-like syntax.
Example::
>>> msg['body'] = "Hi!"
>>> msg['body']
'Hi!'
>>> del msg['body']
>>> msg['body']
''
Stanza interfaces are typically mapped directly to the underlyig XML
object, but can be overridden by the presence of a ``del_attrib``
method (or ``del_foo`` where the interface is named ``'foo'``, etc).
The effect of deleting a stanza interface value named ``foo`` will be
one of:
1. Call ``del_foo`` override handler, if it exists.
2. Call ``del_foo``, if it exists.
3. Call ``delFoo``, if it exists.
4. Delete ``foo`` element, if ``'foo'`` is in
:attr:`sub_interfaces`.
5. Delete top level XML attribute named ``foo``.
6. Remove the ``foo`` plugin, if it was loaded.
7. Do nothing.
:param attrib: The name of the affected stanza interface.
"""
if attrib in self.interfaces:
del_method = "del_%s" % attrib.lower()
del_method2 = "del%s" % attrib.title()
if self.plugin_overrides:
plugin = self.plugin_overrides.get(del_method, None)
if plugin:
if plugin not in self.plugins:
self.init_plugin(plugin)
handler = getattr(self.plugins[plugin], del_method, None)
if handler:
return handler()
if hasattr(self, del_method):
getattr(self, del_method)()
elif hasattr(self, del_method2):
getattr(self, del_method2)()
else:
if attrib in self.sub_interfaces:
return self._del_sub(attrib)
else:
self._del_attr(attrib)
elif attrib in self.plugin_attrib_map:
if attrib in self.plugins:
xml = self.plugins[attrib].xml
if self.plugins[attrib].is_extension:
del self.plugins[attrib][attrib]
del self.plugins[attrib]
try:
self.xml.remove(xml)
except:
pass
return self
def _set_attr(self, name, value):
"""Set the value of a top level attribute of the XML object.
If the new value is None or an empty string, then the attribute will
be removed.
:param name: The name of the attribute.
:param value: The new value of the attribute, or None or '' to
remove it.
"""
if value is None or value == '':
self.__delitem__(name)
else:
self.xml.attrib[name] = value
def _del_attr(self, name):
"""Remove a top level attribute of the XML object.
:param name: The name of the attribute.
"""
if name in self.xml.attrib:
del self.xml.attrib[name]
def _get_attr(self, name, default=''):
"""Return the value of a top level attribute of the XML object.
In case the attribute has not been set, a default value can be
returned instead. An empty string is returned if no other default
is supplied.
:param name: The name of the attribute.
:param default: Optional value to return if the attribute has not
been set. An empty string is returned otherwise.
"""
return self.xml.attrib.get(name, default)
def _get_sub_text(self, name, default=''):
"""Return the text contents of a sub element.
In case the element does not exist, or it has no textual content,
a default value can be returned instead. An empty string is returned
if no other default is supplied.
:param name: The name or XPath expression of the element.
:param default: Optional default to return if the element does
not exists. An empty string is returned otherwise.
"""
name = self._fix_ns(name)
stanza = self.xml.find(name)
if stanza is None or stanza.text is None:
return default
else:
return stanza.text
def _set_sub_text(self, name, text=None, keep=False):
"""Set the text contents of a sub element.
In case the element does not exist, a element will be created,
and its text contents will be set.
If the text is set to an empty string, or None, then the
element will be removed, unless keep is set to True.
:param name: The name or XPath expression of the element.
:param text: The new textual content of the element. If the text
is an empty string or None, the element will be removed
unless the parameter keep is True.
:param keep: Indicates if the element should be kept if its text is
removed. Defaults to False.
"""
path = self._fix_ns(name, split=True)
element = self.xml.find(name)
if not text and not keep:
return self._del_sub(name)
if element is None:
# We need to add the element. If the provided name was
# an XPath expression, some of the intermediate elements
# may already exist. If so, we want to use those instead
# of generating new elements.
last_xml = self.xml
walked = []
for ename in path:
walked.append(ename)
element = self.xml.find("/".join(walked))
if element is None:
element = ET.Element(ename)
last_xml.append(element)
last_xml = element
element = last_xml
element.text = text
return element
def _del_sub(self, name, all=False):
"""Remove sub elements that match the given name or XPath.
If the element is in a path, then any parent elements that become
empty after deleting the element may also be deleted if requested
by setting all=True.
:param name: The name or XPath expression for the element(s) to remove.
:param bool all: If True, remove all empty elements in the path to the
deleted element. Defaults to False.
"""
path = self._fix_ns(name, split=True)
original_target = path[-1]
for level, _ in enumerate(path):
# Generate the paths to the target elements and their parent.
element_path = "/".join(path[:len(path) - level])
parent_path = "/".join(path[:len(path) - level - 1])
elements = self.xml.findall(element_path)
parent = self.xml.find(parent_path)
if elements:
if parent is None:
parent = self.xml
for element in elements:
if element.tag == original_target or \
not element.getchildren():
# Only delete the originally requested elements, and
# any parent elements that have become empty.
parent.remove(element)
if not all:
# If we don't want to delete elements up the tree, stop
# after deleting the first level of elements.
return
def match(self, xpath):
"""Compare a stanza object with an XPath-like expression.
If the XPath matches the contents of the stanza object, the match
is successful.
The XPath expression may include checks for stanza attributes.
For example::
'presence@show=xa@priority=2/status'
Would match a presence stanza whose show value is set to ``'xa'``,
has a priority value of ``'2'``, and has a status element.
:param string xpath: The XPath expression to check against. It
may be either a string or a list of element
names with attribute checks.
"""
if isinstance(xpath, str):
xpath = self._fix_ns(xpath, split=True, propagate_ns=False)
# Extract the tag name and attribute checks for the first XPath node.
components = xpath[0].split('@')
tag = components[0]
attributes = components[1:]
if tag not in (self.name, "{%s}%s" % (self.namespace, self.name)) and \
tag not in self.plugins and tag not in self.plugin_attrib:
# The requested tag is not in this stanza, so no match.
return False
# Check the rest of the XPath against any substanzas.
matched_substanzas = False
for substanza in self.iterables:
if xpath[1:] == []:
break
matched_substanzas = substanza.match(xpath[1:])
if matched_substanzas:
break
# Check attribute values.
for attribute in attributes:
name, value = attribute.split('=')
if self[name] != value:
return False
# Check sub interfaces.
if len(xpath) > 1:
next_tag = xpath[1]
if next_tag in self.sub_interfaces and self[next_tag]:
return True
# Attempt to continue matching the XPath using the stanza's plugins.
if not matched_substanzas and len(xpath) > 1:
# Convert {namespace}tag@attribs to just tag
next_tag = xpath[1].split('@')[0].split('}')[-1]
if next_tag in self.plugins:
return self.plugins[next_tag].match(xpath[1:])
else:
return False
# Everything matched.
return True
def find(self, xpath):
"""Find an XML object in this stanza given an XPath expression.
Exposes ElementTree interface for backwards compatibility.
.. note::
Matching on attribute values is not supported in Python 2.6
or Python 3.1
:param string xpath: An XPath expression matching a single
desired element.
"""
return self.xml.find(xpath)
def findall(self, xpath):
"""Find multiple XML objects in this stanza given an XPath expression.
Exposes ElementTree interface for backwards compatibility.
.. note::
Matching on attribute values is not supported in Python 2.6
or Python 3.1.
:param string xpath: An XPath expression matching multiple
desired elements.
"""
return self.xml.findall(xpath)
def get(self, key, default=None):
"""Return the value of a stanza interface.
If the found value is None or an empty string, return the supplied
default value.
Allows stanza objects to be used like dictionaries.
:param string key: The name of the stanza interface to check.
:param default: Value to return if the stanza interface has a value
of ``None`` or ``""``. Will default to returning None.
"""
value = self[key]
if value is None or value == '':
return default
return value
def keys(self):
"""Return the names of all stanza interfaces provided by the
stanza object.
Allows stanza objects to be used like dictionaries.
"""
out = []
out += [x for x in self.interfaces]
out += [x for x in self.plugins]
if self.iterables:
out.append('substanzas')
return out
def append(self, item):
"""Append either an XML object or a substanza to this stanza object.
If a substanza object is appended, it will be added to the list
of iterable stanzas.
Allows stanza objects to be used like lists.
:param item: Either an XML object or a stanza object to add to
this stanza's contents.
"""
if not isinstance(item, ElementBase):
if type(item) == XML_TYPE:
return self.appendxml(item)
else:
raise TypeError
self.xml.append(item.xml)
self.iterables.append(item)
return self
def appendxml(self, xml):
"""Append an XML object to the stanza's XML.
The added XML will not be included in the list of
iterable substanzas.
:param XML xml: The XML object to add to the stanza.
"""
self.xml.append(xml)
return self
def pop(self, index=0):
"""Remove and return the last substanza in the list of
iterable substanzas.
Allows stanza objects to be used like lists.
:param int index: The index of the substanza to remove.
"""
substanza = self.iterables.pop(index)
self.xml.remove(substanza.xml)
return substanza
def next(self):
"""Return the next iterable substanza."""
return self.__next__()
def clear(self):
"""Remove all XML element contents and plugins.
Any attribute values will be preserved.
"""
for child in self.xml.getchildren():
self.xml.remove(child)
for plugin in list(self.plugins.keys()):
del self.plugins[plugin]
return self
@classmethod
def tag_name(cls):
"""Return the namespaced name of the stanza's root element.
The format for the tag name is::
'{namespace}elementname'
For example, for the stanza ``<foo xmlns="bar" />``,
``stanza.tag_name()`` would return ``"{bar}foo"``.
"""
return "{%s}%s" % (cls.namespace, cls.name)
@property
def attrib(self):
"""Return the stanza object itself.
Older implementations of stanza objects used XML objects directly,
requiring the use of ``.attrib`` to access attribute values.
Use of the dictionary syntax with the stanza object itself for
accessing stanza interfaces is preferred.
.. deprecated:: 1.0
"""
return self
def _fix_ns(self, xpath, split=False, propagate_ns=True):
"""Apply the stanza's namespace to elements in an XPath expression.
:param string xpath: The XPath expression to fix with namespaces.
:param bool split: Indicates if the fixed XPath should be left as a
list of element names with namespaces. Defaults to
False, which returns a flat string path.
:param bool propagate_ns: Overrides propagating parent element
namespaces to child elements. Useful if
you wish to simply split an XPath that has
non-specified namespaces, and child and
parent namespaces are known not to always
match. Defaults to True.
"""
fixed = []
# Split the XPath into a series of blocks, where a block
# is started by an element with a namespace.
ns_blocks = xpath.split('{')
for ns_block in ns_blocks:
if '}' in ns_block:
# Apply the found namespace to following elements
# that do not have namespaces.
namespace = ns_block.split('}')[0]
elements = ns_block.split('}')[1].split('/')
else:
# Apply the stanza's namespace to the following
# elements since no namespace was provided.
namespace = self.namespace
elements = ns_block.split('/')
for element in elements:
if element:
# Skip empty entry artifacts from splitting.
if propagate_ns:
tag = '{%s}%s' % (namespace, element)
else:
tag = element
fixed.append(tag)
if split:
return fixed
return '/'.join(fixed)
def __eq__(self, other):
"""Compare the stanza object with another to test for equality.
Stanzas are equal if their interfaces return the same values,
and if they are both instances of ElementBase.
:param ElementBase other: The stanza object to compare against.
"""
if not isinstance(other, ElementBase):
return False
# Check that this stanza is a superset of the other stanza.
values = self.values
for key in other.keys():
if key not in values or values[key] != other[key]:
return False
# Check that the other stanza is a superset of this stanza.
values = other.values
for key in self.keys():
if key not in values or values[key] != self[key]:
return False
# Both stanzas are supersets of each other, therefore they
# must be equal.
return True
def __ne__(self, other):
"""Compare the stanza object with another to test for inequality.
Stanzas are not equal if their interfaces return different values,
or if they are not both instances of ElementBase.
:param ElementBase other: The stanza object to compare against.
"""
return not self.__eq__(other)
def __bool__(self):
"""Stanza objects should be treated as True in boolean contexts.
Python 3.x version.
"""
return True
def __nonzero__(self):
"""Stanza objects should be treated as True in boolean contexts.
Python 2.x version.
"""
return True
def __len__(self):
"""Return the number of iterable substanzas in this stanza."""
return len(self.iterables)
def __iter__(self):
"""Return an iterator object for the stanza's substanzas.
The iterator is the stanza object itself. Attempting to use two
iterators on the same stanza at the same time is discouraged.
"""
self._index = 0
return self
def __next__(self):
"""Return the next iterable substanza."""
self._index += 1
if self._index > len(self.iterables):
self._index = 0
raise StopIteration
return self.iterables[self._index - 1]
def __copy__(self):
"""Return a copy of the stanza object that does not share the same
underlying XML object.
"""
return self.__class__(xml=copy.deepcopy(self.xml), parent=self.parent)
def __str__(self, top_level_ns=True):
"""Return a string serialization of the underlying XML object.
.. seealso:: :ref:`tostring`
:param bool top_level_ns: Display the top-most namespace.
Defaults to True.
"""
stanza_ns = '' if top_level_ns else self.namespace
return tostring(self.xml, xmlns='',
stanza_ns=stanza_ns,
top_level=not top_level_ns)
def __repr__(self):
"""Use the stanza's serialized XML as its representation."""
return self.__str__()
def testAddField(self):
"""Testing adding fields to a data form."""
msg = self.Message()
form = msg['form']
form.addField(var='f1',
ftype='text-single',
label='Text',
desc='A text field',
required=True,
value='Some text!')
self.check(msg, """
<message>
<x xmlns="jabber:x:data" type="form">
<field var="f1" type="text-single" label="Text">
<desc>A text field</desc>
<required />
<value>Some text!</value>
</field>
</x>
</message>
""")
fields = OrderedDict()
fields['f1'] = {'type': 'text-single',
'label': 'Username',
'required': True}
fields['f2'] = {'type': 'text-private',
'label': 'Password',
'required': True}
fields['f3'] = {'type': 'text-multi',
'label': 'Message',
'value': 'Enter message.\nA long one even.'}
fields['f4'] = {'type': 'list-single',
'label': 'Message Type',
'options': [{'label': 'Cool!',
'value': 'cool'},
{'label': 'Urgh!',
'value': 'urgh'}]}
form['fields'] = fields
self.check(msg, """
<message>
<x xmlns="jabber:x:data" type="form">
<field var="f1" type="text-single" label="Username">
<required />
</field>
<field var="f2" type="text-private" label="Password">
<required />
</field>
<field var="f3" type="text-multi" label="Message">
<value>Enter message.</value>
<value>A long one even.</value>
</field>
<field var="f4" type="list-single" label="Message Type">
<option label="Cool!">
<value>cool</value>
</option>
<option label="Urgh!">
<value>urgh</value>
</option>
</field>
</x>
</message>
""")
def get_fields(self, use_dict=False):
fields = OrderedDict()
for stanza in self['substanzas']:
if isinstance(stanza, FormField):
fields[stanza['var']] = stanza
return fields
class ElementBase(object):
"""
The core of SleekXMPP's stanza XML manipulation and handling is provided
by ElementBase. ElementBase wraps XML cElementTree objects and enables
access to the XML contents through dictionary syntax, similar in style
to the Ruby XMPP library Blather's stanza implementation.
Stanzas are defined by their name, namespace, and interfaces. For
example, a simplistic Message stanza could be defined as:
>>> class Message(ElementBase):
... name = "message"
... namespace = "jabber:client"
... interfaces = set(('to', 'from', 'type', 'body'))
... sub_interfaces = set(('body',))
The resulting Message stanza's contents may be accessed as so:
>>> message['to'] = "*****@*****.**"
>>> message['body'] = "Hi!"
>>> message['body']
"Hi!"
>>> del message['body']
>>> message['body']
""
The interface values map to either custom access methods, stanza
XML attributes, or (if the interface is also in sub_interfaces) the
text contents of a stanza's subelement.
Custom access methods may be created by adding methods of the
form "getInterface", "setInterface", or "delInterface", where
"Interface" is the titlecase version of the interface name.
Stanzas may be extended through the use of plugins. A plugin
is simply a stanza that has a plugin_attrib value. For example:
>>> class MessagePlugin(ElementBase):
... name = "custom_plugin"
... namespace = "custom"
... interfaces = set(('useful_thing', 'custom'))
... plugin_attrib = "custom"
The plugin stanza class must be associated with its intended
container stanza by using register_stanza_plugin as so:
>>> register_stanza_plugin(Message, MessagePlugin)
The plugin may then be accessed as if it were built-in to the parent
stanza.
>>> message['custom']['useful_thing'] = 'foo'
If a plugin provides an interface that is the same as the plugin's
plugin_attrib value, then the plugin's interface may be assigned
directly from the parent stanza, as shown below, but retrieving
information will require all interfaces to be used, as so:
>>> message['custom'] = 'bar' # Same as using message['custom']['custom']
>>> message['custom']['custom'] # Must use all interfaces
'bar'
If the plugin sets the value is_extension = True, then both setting
and getting an interface value that is the same as the plugin's
plugin_attrib value will work, as so:
>>> message['custom'] = 'bar' # Using is_extension=True
>>> message['custom']
'bar'
Class Attributes:
name -- The name of the stanza's main element.
namespace -- The namespace of the stanza's main element.
interfaces -- A set of attribute and element names that may
be accessed using dictionary syntax.
sub_interfaces -- A subset of the set of interfaces which map
to subelements instead of attributes.
subitem -- A set of stanza classes which are allowed to
be added as substanzas. Deprecated version
of plugin_iterables.
overrides -- A list of interfaces prepended with 'get_',
'set_', or 'del_'. If the stanza is registered
as a plugin with overrides=True, then the
parent's interface handlers will be
overridden by the plugin's matching handler.
types -- A set of generic type attribute values.
tag -- The namespaced name of the stanza's root
element. Example: "{foo_ns}bar"
plugin_attrib -- The interface name that the stanza uses to be
accessed as a plugin from another stanza.
plugin_attrib_map -- A mapping of plugin attribute names with the
associated plugin stanza classes.
plugin_iterables -- A set of stanza classes which are allowed to
be added as substanzas.
plugin_overrides -- A mapping of interfaces prepended with 'get_',
'set_' or 'del_' to plugin attrib names. Allows
a plugin to override the behaviour of a parent
stanza's interface handlers.
plugin_tag_map -- A mapping of plugin stanza tag names with
the associated plugin stanza classes.
is_extension -- When True, allows the stanza to provide one
additional interface to the parent stanza,
extending the interfaces supported by the
parent. Defaults to False.
xml_ns -- The XML namespace,
http://www.w3.org/XML/1998/namespace,
for use with xml:lang values.
Instance Attributes:
xml -- The stanza's XML contents.
parent -- The parent stanza of this stanza.
plugins -- A map of enabled plugin names with the
initialized plugin stanza objects.
values -- A dictionary of the stanza's interfaces
and interface values, including plugins.
Class Methods
tag_name -- Return the namespaced version of the stanza's
root element's name.
Methods:
setup -- Initialize the stanza's XML contents.
enable -- Instantiate a stanza plugin.
Alias for init_plugin.
init_plugin -- Instantiate a stanza plugin.
_get_stanza_values -- Return a dictionary of stanza interfaces and
their values.
_set_stanza_values -- Set stanza interface values given a dictionary
of interfaces and values.
__getitem__ -- Return the value of a stanza interface.
__setitem__ -- Set the value of a stanza interface.
__delitem__ -- Remove the value of a stanza interface.
_set_attr -- Set an attribute value of the main
stanza element.
_del_attr -- Remove an attribute from the main
stanza element.
_get_attr -- Return an attribute's value from the main
stanza element.
_get_sub_text -- Return the text contents of a subelement.
_set_sub_text -- Set the text contents of a subelement.
_del_sub -- Remove a subelement.
match -- Compare the stanza against an XPath expression.
find -- Return subelement matching an XPath expression.
findall -- Return subelements matching an XPath expression.
get -- Return the value of a stanza interface, with an
optional default value.
keys -- Return the set of interface names accepted by
the stanza.
append -- Add XML content or a substanza to the stanza.
appendxml -- Add XML content to the stanza.
pop -- Remove a substanza.
next -- Return the next iterable substanza.
clear -- Reset the stanza's XML contents.
_fix_ns -- Apply the stanza's namespace to non-namespaced
elements in an XPath expression.
"""
name = 'stanza'
plugin_attrib = 'plugin'
namespace = 'jabber:client'
interfaces = set(('type', 'to', 'from', 'id', 'payload'))
types = set(('get', 'set', 'error', None, 'unavailable', 'normal', 'chat'))
sub_interfaces = tuple()
overrides = {}
plugin_attrib_map = {}
plugin_overrides = {}
plugin_iterables = set()
plugin_tag_map = {}
subitem = set()
is_extension = False
xml_ns = 'http://www.w3.org/XML/1998/namespace'
@clear_cache
def __init__(self, xml=None, parent=None):
"""
Create a new stanza object.
Arguments:
xml -- Initialize the stanza with optional existing XML.
parent -- Optional stanza object that contains this stanza.
"""
self._getitem_cache = {}
self.xml = xml
self.plugins = OrderedDict()
self.iterables = []
self._index = 0
self.tag = self.tag_name()
if parent is None:
self.parent = None
else:
self.parent = weakref.ref(parent)
ElementBase.values = property(ElementBase._get_stanza_values,
ElementBase._set_stanza_values)
if self.subitem is not None:
for sub in self.subitem:
self.plugin_iterables.add(sub)
if self.setup(xml):
# If we generated our own XML, then everything is ready.
return
# Initialize values using provided XML
for child in self.xml.getchildren():
if child.tag in self.plugin_tag_map:
plugin = self.plugin_tag_map[child.tag]
self.plugins[plugin.plugin_attrib] = plugin(child, self)
for sub in self.plugin_iterables:
if child.tag == "{%s}%s" % (sub.namespace, sub.name):
self.iterables.append(sub(child, self))
break
@clear_cache
def setup(self, xml=None):
"""
Initialize the stanza's XML contents.
Will return True if XML was generated according to the stanza's
definition.
Arguments:
xml -- Optional XML object to use for the stanza's content
instead of generating XML.
"""
if self.xml is None:
self.xml = xml
if self.xml is None:
# Generate XML from the stanza definition
for ename in self.name.split('/'):
new = ET.Element("{%s}%s" % (self.namespace, ename))
if self.xml is None:
self.xml = new
else:
last_xml.append(new)
last_xml = new
if self.parent is not None:
self.parent().xml.append(self.xml)
# We had to generate XML
return True
else:
# We did not generate XML
return False
def enable(self, attrib):
"""
Enable and initialize a stanza plugin.
Alias for init_plugin.
Arguments:
attrib -- The stanza interface for the plugin.
"""
return self.init_plugin(attrib)
@clear_cache
def init_plugin(self, attrib):
"""
Enable and initialize a stanza plugin.
Arguments:
attrib -- The stanza interface for the plugin.
"""
if attrib not in self.plugins:
plugin_class = self.plugin_attrib_map[attrib]
self.plugins[attrib] = plugin_class(parent=self)
return self
def _get_stanza_values(self):
"""
Return a dictionary of the stanza's interface values.
Stanza plugin values are included as nested dictionaries.
"""
values = {}
for interface in self.interfaces:
values[interface] = self[interface]
for plugin, stanza in self.plugins.items():
values[plugin] = stanza.values
if self.iterables:
iterables = []
for stanza in self.iterables:
iterables.append(stanza.values)
iterables[-1]['__childtag__'] = stanza.tag
values['substanzas'] = iterables
return values
@clear_cache
def _set_stanza_values(self, values):
"""
Set multiple stanza interface values using a dictionary.
Stanza plugin values may be set using nested dictionaries.
Arguments:
values -- A dictionary mapping stanza interface with values.
Plugin interfaces may accept a nested dictionary that
will be used recursively.
"""
iterable_interfaces = [p.plugin_attrib for \
p in self.plugin_iterables]
for interface, value in values.items():
if interface == 'substanzas':
# Remove existing substanzas
for stanza in self.iterables:
self.xml.remove(stanza.xml)
self.iterables = []
# Add new substanzas
for subdict in value:
if '__childtag__' in subdict:
for subclass in self.plugin_iterables:
child_tag = "{%s}%s" % (subclass.namespace,
subclass.name)
if subdict['__childtag__'] == child_tag:
sub = subclass(parent=self)
sub.values = subdict
self.iterables.append(sub)
break
elif interface in self.interfaces:
self[interface] = value
elif interface in self.plugin_attrib_map:
if interface not in iterable_interfaces:
if interface not in self.plugins:
self.init_plugin(interface)
self.plugins[interface].values = value
return self
def __getitem__(self, attrib):
if attrib not in self._getitem_cache:
self._getitem_cache[attrib] = self.__getitem_internal(attrib)
return self._getitem_cache[attrib]
def __getitem_internal(self, attrib):
"""
Return the value of a stanza interface using dictionary-like syntax.
Example:
>>> msg['body']
'Message contents'
Stanza interfaces are typically mapped directly to the underlying XML
object, but can be overridden by the presence of a get_attrib method
(or get_foo where the interface is named foo, etc).
The search order for interface value retrieval for an interface
named 'foo' is:
1. The list of substanzas.
2. The result of calling the get_foo override handler.
3. The result of calling get_foo.
4. The result of calling getFoo.
5. The contents of the foo subelement, if foo is a sub interface.
6. The value of the foo attribute of the XML object.
7. The plugin named 'foo'
8. An empty string.
Arguments:
attrib -- The name of the requested stanza interface.
"""
if attrib == 'substanzas':
return self.iterables
elif attrib in self.interfaces:
get_method = "get_%s" % attrib.lower()
get_method2 = "get%s" % attrib.title()
if self.plugin_overrides:
plugin = self.plugin_overrides.get(get_method, None)
if plugin:
if plugin not in self.plugins:
self.init_plugin(plugin)
handler = getattr(self.plugins[plugin], get_method, None)
if handler:
return handler()
if hasattr(self, get_method):
return getattr(self, get_method)()
elif hasattr(self, get_method2):
return getattr(self, get_method2)()
else:
if attrib in self.sub_interfaces:
return self._get_sub_text(attrib)
else:
return self._get_attr(attrib)
elif attrib in self.plugin_attrib_map:
if attrib not in self.plugins:
self.init_plugin(attrib)
if self.plugins[attrib].is_extension:
return self.plugins[attrib][attrib]
return self.plugins[attrib]
else:
return ''
@clear_cache
def __setitem__(self, attrib, value):
"""
Set the value of a stanza interface using dictionary-like syntax.
Example:
>>> msg['body'] = "Hi!"
>>> msg['body']
'Hi!'
Stanza interfaces are typically mapped directly to the underlying XML
object, but can be overridden by the presence of a set_attrib method
(or set_foo where the interface is named foo, etc).
The effect of interface value assignment for an interface
named 'foo' will be one of:
1. Delete the interface's contents if the value is None.
2. Call the set_foo override handler, if it exists.
3. Call set_foo, if it exists.
4. Call setFoo, if it exists.
5. Set the text of a foo element, if foo is in sub_interfaces.
6. Set the value of a top level XML attribute name foo.
7. Attempt to pass value to a plugin named foo using the plugin's
foo interface.
8. Do nothing.
Arguments:
attrib -- The name of the stanza interface to modify.
value -- The new value of the stanza interface.
"""
# TODO: we should be able to delete only the attribute being set,
# but I am not convinced this is safe in all circumstances.
# setitem should be rare, anyway.
if attrib in self.interfaces:
if value is not None:
set_method = "set_%s" % attrib.lower()
set_method2 = "set%s" % attrib.title()
if self.plugin_overrides:
plugin = self.plugin_overrides.get(set_method, None)
if plugin:
if plugin not in self.plugins:
self.init_plugin(plugin)
handler = getattr(self.plugins[plugin],
set_method, None)
if handler:
return handler(value)
if hasattr(self, set_method):
getattr(self, set_method)(value,)
elif hasattr(self, set_method2):
getattr(self, set_method2)(value,)
else:
if attrib in self.sub_interfaces:
return self._set_sub_text(attrib, text=value)
else:
self._set_attr(attrib, value)
else:
self.__delitem__(attrib)
elif attrib in self.plugin_attrib_map:
if attrib not in self.plugins:
self.init_plugin(attrib)
self.plugins[attrib][attrib] = value
return self
@clear_cache
def __delitem__(self, attrib):
"""
Delete the value of a stanza interface using dictionary-like syntax.
Example:
>>> msg['body'] = "Hi!"
>>> msg['body']
'Hi!'
>>> del msg['body']
>>> msg['body']
''
Stanza interfaces are typically mapped directly to the underlyig XML
object, but can be overridden by the presence of a del_attrib method
(or del_foo where the interface is named foo, etc).
The effect of deleting a stanza interface value named foo will be
one of:
1. Call del_foo override handler, if it exists.
2. Call del_foo, if it exists.
3. Call delFoo, if it exists.
4. Delete foo element, if foo is in sub_interfaces.
5. Delete top level XML attribute named foo.
6. Remove the foo plugin, if it was loaded.
7. Do nothing.
Arguments:
attrib -- The name of the affected stanza interface.
"""
if attrib in self.interfaces:
del_method = "del_%s" % attrib.lower()
del_method2 = "del%s" % attrib.title()
if self.plugin_overrides:
plugin = self.plugin_overrides.get(del_method, None)
if plugin:
if plugin not in self.plugins:
self.init_plugin(plugin)
handler = getattr(self.plugins[plugin], del_method, None)
if handler:
return handler()
if hasattr(self, del_method):
getattr(self, del_method)()
elif hasattr(self, del_method2):
getattr(self, del_method2)()
else:
if attrib in self.sub_interfaces:
return self._del_sub(attrib)
else:
self._del_attr(attrib)
elif attrib in self.plugin_attrib_map:
if attrib in self.plugins:
xml = self.plugins[attrib].xml
if self.plugins[attrib].is_extension:
del self.plugins[attrib][attrib]
del self.plugins[attrib]
try:
self.xml.remove(xml)
except:
pass
return self
@clear_cache
def _set_attr(self, name, value):
"""
Set the value of a top level attribute of the underlying XML object.
If the new value is None or an empty string, then the attribute will
be removed.
Arguments:
name -- The name of the attribute.
value -- The new value of the attribute, or None or '' to
remove it.
"""
if value is None or value == '':
self.__delitem__(name)
else:
self.xml.attrib[name] = value
@clear_cache
def _del_attr(self, name):
"""
Remove a top level attribute of the underlying XML object.
Arguments:
name -- The name of the attribute.
"""
if name in self.xml.attrib:
del self.xml.attrib[name]
def _get_attr(self, name, default=''):
"""
Return the value of a top level attribute of the underlying
XML object.
In case the attribute has not been set, a default value can be
returned instead. An empty string is returned if no other default
is supplied.
Arguments:
name -- The name of the attribute.
default -- Optional value to return if the attribute has not
been set. An empty string is returned otherwise.
"""
return self.xml.attrib.get(name, default)
def _get_sub_text(self, name, default=''):
"""
Return the text contents of a sub element.
In case the element does not exist, or it has no textual content,
a default value can be returned instead. An empty string is returned
if no other default is supplied.
Arguments:
name -- The name or XPath expression of the element.
default -- Optional default to return if the element does
not exists. An empty string is returned otherwise.
"""
name = self._fix_ns(name)
stanza = self.xml.find(name)
if stanza is None or stanza.text is None:
return default
else:
return stanza.text
@clear_cache
def _set_sub_text(self, name, text=None, keep=False):
"""
Set the text contents of a sub element.
In case the element does not exist, a element will be created,
and its text contents will be set.
If the text is set to an empty string, or None, then the
element will be removed, unless keep is set to True.
Arguments:
name -- The name or XPath expression of the element.
text -- The new textual content of the element. If the text
is an empty string or None, the element will be removed
unless the parameter keep is True.
keep -- Indicates if the element should be kept if its text is
removed. Defaults to False.
"""
path = self._fix_ns(name, split=True)
element = self.xml.find(name)
if not text and not keep:
return self._del_sub(name)
if element is None:
# We need to add the element. If the provided name was
# an XPath expression, some of the intermediate elements
# may already exist. If so, we want to use those instead
# of generating new elements.
last_xml = self.xml
walked = []
for ename in path:
walked.append(ename)
element = self.xml.find("/".join(walked))
if element is None:
element = ET.Element(ename)
last_xml.append(element)
last_xml = element
element = last_xml
element.text = text
return element
@clear_cache
def _del_sub(self, name, all=False):
"""
Remove sub elements that match the given name or XPath.
If the element is in a path, then any parent elements that become
empty after deleting the element may also be deleted if requested
by setting all=True.
Arguments:
name -- The name or XPath expression for the element(s) to remove.
all -- If True, remove all empty elements in the path to the
deleted element. Defaults to False.
"""
path = self._fix_ns(name, split=True)
original_target = path[-1]
for level, _ in enumerate(path):
# Generate the paths to the target elements and their parent.
element_path = "/".join(path[:len(path) - level])
parent_path = "/".join(path[:len(path) - level - 1])
elements = self.xml.findall(element_path)
parent = self.xml.find(parent_path)
if elements:
if parent is None:
parent = self.xml
for element in elements:
if element.tag == original_target or \
not element.getchildren():
# Only delete the originally requested elements, and
# any parent elements that have become empty.
parent.remove(element)
if not all:
# If we don't want to delete elements up the tree, stop
# after deleting the first level of elements.
return
@clear_cache
def match(self, xpath):
"""
Compare a stanza object with an XPath expression. If the XPath matches
the contents of the stanza object, the match is successful.
The XPath expression may include checks for stanza attributes.
For example:
presence@show=xa@priority=2/status
Would match a presence stanza whose show value is set to 'xa', has a
priority value of '2', and has a status element.
Arguments:
xpath -- The XPath expression to check against. It may be either a
string or a list of element names with attribute checks.
"""
if isinstance(xpath, str):
xpath = self._fix_ns(xpath, split=True, propagate_ns=False)
# Extract the tag name and attribute checks for the first XPath node.
components = xpath[0].split('@')
tag = components[0]
attributes = components[1:]
if tag not in (self.name, "{%s}%s" % (self.namespace, self.name)) and \
tag not in self.plugins and tag not in self.plugin_attrib:
# The requested tag is not in this stanza, so no match.
return False
# Check the rest of the XPath against any substanzas.
matched_substanzas = False
for substanza in self.iterables:
if xpath[1:] == []:
break
matched_substanzas = substanza.match(xpath[1:])
if matched_substanzas:
break
# Check attribute values.
for attribute in attributes:
name, value = attribute.split('=')
if self[name] != value:
return False
# Check sub interfaces.
if len(xpath) > 1:
next_tag = xpath[1]
if next_tag in self.sub_interfaces and self[next_tag]:
return True
# Attempt to continue matching the XPath using the stanza's plugins.
if not matched_substanzas and len(xpath) > 1:
# Convert {namespace}tag@attribs to just tag
next_tag = xpath[1].split('@')[0].split('}')[-1]
if next_tag in self.plugins:
return self.plugins[next_tag].match(xpath[1:])
else:
return False
# Everything matched.
return True
def find(self, xpath):
"""
Find an XML object in this stanza given an XPath expression.
Exposes ElementTree interface for backwards compatibility.
Note that matching on attribute values is not supported in Python 2.6
or Python 3.1
Arguments:
xpath -- An XPath expression matching a single desired element.
"""
return self.xml.find(xpath)
def findall(self, xpath):
"""
Find multiple XML objects in this stanza given an XPath expression.
Exposes ElementTree interface for backwards compatibility.
Note that matching on attribute values is not supported in Python 2.6
or Python 3.1.
Arguments:
xpath -- An XPath expression matching multiple desired elements.
"""
return self.xml.findall(xpath)
def get(self, key, default=None):
"""
Return the value of a stanza interface. If the found value is None
or an empty string, return the supplied default value.
Allows stanza objects to be used like dictionaries.
Arguments:
key -- The name of the stanza interface to check.
default -- Value to return if the stanza interface has a value
of None or "". Will default to returning None.
"""
value = self[key]
if value is None or value == '':
return default
return value
def keys(self):
"""
Return the names of all stanza interfaces provided by the
stanza object.
Allows stanza objects to be used like dictionaries.
"""
out = []
out += [x for x in self.interfaces]
out += [x for x in self.plugins]
if self.iterables:
out.append('substanzas')
return out
@clear_cache
def append(self, item):
"""
Append either an XML object or a substanza to this stanza object.
If a substanza object is appended, it will be added to the list
of iterable stanzas.
Allows stanza objects to be used like lists.
Arguments:
item -- Either an XML object or a stanza object to add to
this stanza's contents.
"""
if not isinstance(item, ElementBase):
if type(item) == XML_TYPE:
return self.appendxml(item)
else:
raise TypeError
self.xml.append(item.xml)
self.iterables.append(item)
return self
@clear_cache
def appendxml(self, xml):
"""
Append an XML object to the stanza's XML.
The added XML will not be included in the list of
iterable substanzas.
Arguments:
xml -- The XML object to add to the stanza.
"""
self.xml.append(xml)
return self
def pop(self, index=0):
"""
Remove and return the last substanza in the list of
iterable substanzas.
Allows stanza objects to be used like lists.
Arguments:
index -- The index of the substanza to remove.
"""
substanza = self.iterables.pop(index)
self.xml.remove(substanza.xml)
return substanza
def next(self):
"""
Return the next iterable substanza.
"""
return self.__next__()
def clear(self):
"""
Remove all XML element contents and plugins.
Any attribute values will be preserved.
"""
for child in self.xml.getchildren():
self.xml.remove(child)
for plugin in list(self.plugins.keys()):
del self.plugins[plugin]
return self
@classmethod
def tag_name(cls):
"""
Return the namespaced name of the stanza's root element.
For example, for the stanza <foo xmlns="bar" />,
stanza.tag would return "{bar}foo".
"""
return "{%s}%s" % (cls.namespace, cls.name)
@property
def attrib(self):
"""
DEPRECATED
For backwards compatibility, stanza.attrib returns the stanza itself.
Older implementations of stanza objects used XML objects directly,
requiring the use of .attrib to access attribute values.
Use of the dictionary syntax with the stanza object itself for
accessing stanza interfaces is preferred.
"""
return self
def _fix_ns(self, xpath, split=False, propagate_ns=True):
"""
Apply the stanza's namespace to elements in an XPath expression.
Arguments:
xpath -- The XPath expression to fix with namespaces.
split -- Indicates if the fixed XPath should be left as a
list of element names with namespaces. Defaults to
False, which returns a flat string path.
propagate_ns -- Overrides propagating parent element namespaces
to child elements. Useful if you wish to simply
split an XPath that has non-specified namespaces,
and child and parent namespaces are known not to
always match. Defaults to True.
"""
fixed = []
# Split the XPath into a series of blocks, where a block
# is started by an element with a namespace.
ns_blocks = xpath.split('{')
for ns_block in ns_blocks:
if '}' in ns_block:
# Apply the found namespace to following elements
# that do not have namespaces.
namespace = ns_block.split('}')[0]
elements = ns_block.split('}')[1].split('/')
else:
# Apply the stanza's namespace to the following
# elements since no namespace was provided.
namespace = self.namespace
elements = ns_block.split('/')
for element in elements:
if element:
# Skip empty entry artifacts from splitting.
if propagate_ns:
tag = '{%s}%s' % (namespace, element)
else:
tag = element
fixed.append(tag)
if split:
return fixed
return '/'.join(fixed)
def __eq__(self, other):
"""
Compare the stanza object with another to test for equality.
Stanzas are equal if their interfaces return the same values,
and if they are both instances of ElementBase.
Arguments:
other -- The stanza object to compare against.
"""
if not isinstance(other, ElementBase):
return False
# Check that this stanza is a superset of the other stanza.
values = self.values
for key in other.keys():
if key not in values or values[key] != other[key]:
return False
# Check that the other stanza is a superset of this stanza.
values = other.values
for key in self.keys():
if key not in values or values[key] != self[key]:
return False
# Both stanzas are supersets of each other, therefore they
# must be equal.
return True
def __ne__(self, other):
"""
Compare the stanza object with another to test for inequality.
Stanzas are not equal if their interfaces return different values,
or if they are not both instances of ElementBase.
Arguments:
other -- The stanza object to compare against.
"""
return not self.__eq__(other)
def __bool__(self):
"""
Stanza objects should be treated as True in boolean contexts.
Python 3.x version.
"""
return True
def __nonzero__(self):
"""
Stanza objects should be treated as True in boolean contexts.
Python 2.x version.
"""
return True
def __len__(self):
"""
Return the number of iterable substanzas contained in this stanza.
"""
return len(self.iterables)
def __iter__(self):
"""
Return an iterator object for iterating over the stanza's substanzas.
The iterator is the stanza object itself. Attempting to use two
iterators on the same stanza at the same time is discouraged.
"""
self._index = 0
return self
def __next__(self):
"""
Return the next iterable substanza.
"""
self._index += 1
if self._index > len(self.iterables):
self._index = 0
raise StopIteration
return self.iterables[self._index - 1]
def __copy__(self):
"""
Return a copy of the stanza object that does not share the same
underlying XML object.
"""
return self.__class__(xml=copy.deepcopy(self.xml), parent=self.parent)
def __str__(self, top_level_ns=True):
"""
Return a string serialization of the underlying XML object.
Arguments:
top_level_ns -- Display the top-most namespace.
Defaults to True.
"""
stanza_ns = '' if top_level_ns else self.namespace
return tostring(self.xml, xmlns='',
stanza_ns=stanza_ns,
top_level=not top_level_ns)
def __repr__(self):
"""
Use the stanza's serialized XML as its representation.
"""
return self.__str__()
class ElementBase(object):
"""
The core of SleekXMPP's stanza XML manipulation and handling is provided
by ElementBase. ElementBase wraps XML cElementTree objects and enables
access to the XML contents through dictionary syntax, similar in style
to the Ruby XMPP library Blather's stanza implementation.
Stanzas are defined by their name, namespace, and interfaces. For
example, a simplistic Message stanza could be defined as::
>>> class Message(ElementBase):
... name = "message"
... namespace = "jabber:client"
... interfaces = set(('to', 'from', 'type', 'body'))
... sub_interfaces = set(('body',))
The resulting Message stanza's contents may be accessed as so::
>>> message['to'] = "*****@*****.**"
>>> message['body'] = "Hi!"
>>> message['body']
"Hi!"
>>> del message['body']
>>> message['body']
""
The interface values map to either custom access methods, stanza
XML attributes, or (if the interface is also in sub_interfaces) the
text contents of a stanza's subelement.
Custom access methods may be created by adding methods of the
form "getInterface", "setInterface", or "delInterface", where
"Interface" is the titlecase version of the interface name.
Stanzas may be extended through the use of plugins. A plugin
is simply a stanza that has a plugin_attrib value. For example::
>>> class MessagePlugin(ElementBase):
... name = "custom_plugin"
... namespace = "custom"
... interfaces = set(('useful_thing', 'custom'))
... plugin_attrib = "custom"
The plugin stanza class must be associated with its intended
container stanza by using register_stanza_plugin as so::
>>> register_stanza_plugin(Message, MessagePlugin)
The plugin may then be accessed as if it were built-in to the parent
stanza::
>>> message['custom']['useful_thing'] = 'foo'
If a plugin provides an interface that is the same as the plugin's
plugin_attrib value, then the plugin's interface may be assigned
directly from the parent stanza, as shown below, but retrieving
information will require all interfaces to be used, as so::
>>> message['custom'] = 'bar' # Same as using message['custom']['custom']
>>> message['custom']['custom'] # Must use all interfaces
'bar'
If the plugin sets :attr:`is_extension` to ``True``, then both setting
and getting an interface value that is the same as the plugin's
plugin_attrib value will work, as so::
>>> message['custom'] = 'bar' # Using is_extension=True
>>> message['custom']
'bar'
:param xml: Initialize the stanza object with an existing XML object.
:param parent: Optionally specify a parent stanza object will will
contain this substanza.
"""
#: The XML tag name of the element, not including any namespace
#: prefixes. For example, an :class:`ElementBase` object for ``<message />``
#: would use ``name = 'message'``.
name = 'stanza'
#: The XML namespace for the element. Given ``<foo xmlns="bar" />``,
#: then ``namespace = "bar"`` should be used. The default namespace
#: is ``jabber:client`` since this is being used in an XMPP library.
namespace = 'jabber:client'
#: For :class:`ElementBase` subclasses which are intended to be used
#: as plugins, the ``plugin_attrib`` value defines the plugin name.
#: Plugins may be accessed by using the ``plugin_attrib`` value as
#: the interface. An example using ``plugin_attrib = 'foo'``::
#:
#: register_stanza_plugin(Message, FooPlugin)
#: msg = Message()
#: msg['foo']['an_interface_from_the_foo_plugin']
plugin_attrib = 'plugin'
#: The set of keys that the stanza provides for accessing and
#: manipulating the underlying XML object. This set may be augmented
#: with the :attr:`plugin_attrib` value of any registered
#: stanza plugins.
interfaces = set(('type', 'to', 'from', 'id', 'payload'))
#: A subset of :attr:`interfaces` which maps interfaces to direct
#: subelements of the underlying XML object. Using this set, the text
#: of these subelements may be set, retrieved, or removed without
#: needing to define custom methods.
sub_interfaces = tuple()
#: In some cases you may wish to override the behaviour of one of the
#: parent stanza's interfaces. The ``overrides`` list specifies the
#: interface name and access method to be overridden. For example,
#: to override setting the parent's ``'condition'`` interface you
#: would use::
#:
#: overrides = ['set_condition']
#:
#: Getting and deleting the ``'condition'`` interface would not
#: be affected.
#:
#: .. versionadded:: 1.0-Beta5
overrides = []
#: If you need to add a new interface to an existing stanza, you
#: can create a plugin and set ``is_extension = True``. Be sure
#: to set the :attr:`plugin_attrib` value to the desired interface
#: name, and that it is the only interface listed in
#: :attr:`interfaces`. Requests for the new interface from the
#: parent stanza will be passed to the plugin directly.
#:
#: .. versionadded:: 1.0-Beta5
is_extension = False
#: A map of interface operations to the overriding functions.
#: For example, after overriding the ``set`` operation for
#: the interface ``body``, :attr:`plugin_overrides` would be::
#:
#: {'set_body': <some function>}
#:
#: .. versionadded: 1.0-Beta5
plugin_overrides = {}
#: A mapping of the :attr:`plugin_attrib` values of registered
#: plugins to their respective classes.
plugin_attrib_map = {}
#: A mapping of root element tag names (in ``'{namespace}elementname'``
#: format) to the plugin classes responsible for them.
plugin_tag_map = {}
#: The set of stanza classes that can be iterated over using
#: the 'substanzas' interface. Classes are added to this set
#: when registering a plugin with ``iterable=True``::
#:
#: register_stanza_plugin(DiscoInfo, DiscoItem, iterable=True)
#:
#: .. versionadded:: 1.0-Beta5
plugin_iterables = set()
#: A deprecated version of :attr:`plugin_iterables` that remains
#: for backward compatibility. It required a parent stanza to
#: know beforehand what stanza classes would be iterable::
#:
#: class DiscoItem(ElementBase):
#: ...
#:
#: class DiscoInfo(ElementBase):
#: subitem = (DiscoItem, )
#: ...
#:
#: .. deprecated:: 1.0-Beta5
subitem = set()
#: The default XML namespace: ``http://www.w3.org/XML/1998/namespace``.
xml_ns = 'http://www.w3.org/XML/1998/namespace'
def __init__(self, xml=None, parent=None):
self._index = 0
#: The underlying XML object for the stanza. It is a standard
#: :class:`xml.etree.cElementTree` object.
self.xml = xml
#: An ordered dictionary of plugin stanzas, mapped by their
#: :attr:`plugin_attrib` value.
self.plugins = OrderedDict()
#: A list of child stanzas whose class is included in
#: :attr:`plugin_iterables`.
self.iterables = []
#: The name of the tag for the stanza's root element. It is the
#: same as calling :meth:`tag_name()` and is formatted as
#: ``'{namespace}elementname'``.
self.tag = self.tag_name()
#: A :class:`weakref.weakref` to the parent stanza, if there is one.
#: If not, then :attr:`parent` is ``None``.
self.parent = None
if parent is not None:
self.parent = weakref.ref(parent)
if self.subitem is not None:
for sub in self.subitem:
self.plugin_iterables.add(sub)
if self.setup(xml):
# If we generated our own XML, then everything is ready.
return
# Initialize values using provided XML
for child in self.xml.getchildren():
if child.tag in self.plugin_tag_map:
plugin_class = self.plugin_tag_map[child.tag]
plugin = plugin_class(child, self)
self.plugins[plugin.plugin_attrib] = plugin
if plugin_class in self.plugin_iterables:
self.iterables.append(plugin)
def setup(self, xml=None):
"""Initialize the stanza's XML contents.
Will return ``True`` if XML was generated according to the stanza's
definition instead of building a stanza object from an existing
XML object.
:param xml: An existing XML object to use for the stanza's content
instead of generating new XML.
"""
if self.xml is None:
self.xml = xml
if self.xml is None:
# Generate XML from the stanza definition
for ename in self.name.split('/'):
new = ET.Element("{%s}%s" % (self.namespace, ename))
if self.xml is None:
self.xml = new
else:
last_xml.append(new)
last_xml = new
if self.parent is not None:
self.parent().xml.append(self.xml)
# We had to generate XML
return True
else:
# We did not generate XML
return False
def enable(self, attrib):
"""Enable and initialize a stanza plugin.
Alias for :meth:`init_plugin`.
:param string attrib: The :attr:`plugin_attrib` value of the
plugin to enable.
"""
return self.init_plugin(attrib)
def init_plugin(self, attrib):
"""Enable and initialize a stanza plugin.
:param string attrib: The :attr:`plugin_attrib` value of the
plugin to enable.
"""
if attrib not in self.plugins:
plugin_class = self.plugin_attrib_map[attrib]
plugin = plugin_class(parent=self)
self.plugins[attrib] = plugin
if plugin_class in self.plugin_iterables:
self.iterables.append(plugin)
return self
def _get_stanza_values(self):
"""Return A JSON/dictionary version of the XML content
exposed through the stanza's interfaces::
>>> msg = Message()
>>> msg.values
{'body': '', 'from': , 'mucnick': '', 'mucroom': '',
'to': , 'type': 'normal', 'id': '', 'subject': ''}
Likewise, assigning to :attr:`values` will change the XML
content::
>>> msg = Message()
>>> msg.values = {'body': 'Hi!', 'to': '*****@*****.**'}
>>> msg
'<message to="*****@*****.**"><body>Hi!</body></message>'
.. versionadded:: 1.0-Beta1
"""
values = {}
for interface in self.interfaces:
values[interface] = self[interface]
for plugin, stanza in self.plugins.items():
values[plugin] = stanza.values
if self.iterables:
iterables = []
for stanza in self.iterables:
iterables.append(stanza.values)
iterables[-1]['__childtag__'] = stanza.tag
values['substanzas'] = iterables
return values
def _set_stanza_values(self, values):
"""Set multiple stanza interface values using a dictionary.
Stanza plugin values may be set using nested dictionaries.
:param values: A dictionary mapping stanza interface with values.
Plugin interfaces may accept a nested dictionary that
will be used recursively.
.. versionadded:: 1.0-Beta1
"""
iterable_interfaces = [p.plugin_attrib for \
p in self.plugin_iterables]
for interface, value in values.items():
if interface == 'substanzas':
# Remove existing substanzas
for stanza in self.iterables:
self.xml.remove(stanza.xml)
self.iterables = []
# Add new substanzas
for subdict in value:
if '__childtag__' in subdict:
for subclass in self.plugin_iterables:
child_tag = "{%s}%s" % (subclass.namespace,
subclass.name)
if subdict['__childtag__'] == child_tag:
sub = subclass(parent=self)
sub.values = subdict
self.iterables.append(sub)
break
elif interface in self.interfaces:
self[interface] = value
elif interface in self.plugin_attrib_map:
if interface not in iterable_interfaces:
if interface not in self.plugins:
self.init_plugin(interface)
self.plugins[interface].values = value
return self
def __getitem__(self, attrib):
"""Return the value of a stanza interface using dict-like syntax.
Example::
>>> msg['body']
'Message contents'
Stanza interfaces are typically mapped directly to the underlying XML
object, but can be overridden by the presence of a ``get_attrib``
method (or ``get_foo`` where the interface is named ``'foo'``, etc).
The search order for interface value retrieval for an interface
named ``'foo'`` is:
1. The list of substanzas (``'substanzas'``)
2. The result of calling the ``get_foo`` override handler.
3. The result of calling ``get_foo``.
4. The result of calling ``getFoo``.
5. The contents of the ``foo`` subelement, if ``foo`` is listed
in :attr:`sub_interfaces`.
6. The value of the ``foo`` attribute of the XML object.
7. The plugin named ``'foo'``
8. An empty string.
:param string attrib: The name of the requested stanza interface.
"""
if attrib == 'substanzas':
return self.iterables
elif attrib in self.interfaces:
get_method = "get_%s" % attrib.lower()
get_method2 = "get%s" % attrib.title()
if self.plugin_overrides:
plugin = self.plugin_overrides.get(get_method, None)
if plugin:
if plugin not in self.plugins:
self.init_plugin(plugin)
handler = getattr(self.plugins[plugin], get_method, None)
if handler:
return handler()
if hasattr(self, get_method):
return getattr(self, get_method)()
elif hasattr(self, get_method2):
return getattr(self, get_method2)()
else:
if attrib in self.sub_interfaces:
return self._get_sub_text(attrib)
else:
return self._get_attr(attrib)
elif attrib in self.plugin_attrib_map:
if attrib not in self.plugins:
self.init_plugin(attrib)
if self.plugins[attrib].is_extension:
return self.plugins[attrib][attrib]
return self.plugins[attrib]
else:
return ''
def __setitem__(self, attrib, value):
"""Set the value of a stanza interface using dictionary-like syntax.
Example::
>>> msg['body'] = "Hi!"
>>> msg['body']
'Hi!'
Stanza interfaces are typically mapped directly to the underlying XML
object, but can be overridden by the presence of a ``set_attrib``
method (or ``set_foo`` where the interface is named ``'foo'``, etc).
The effect of interface value assignment for an interface
named ``'foo'`` will be one of:
1. Delete the interface's contents if the value is None.
2. Call the ``set_foo`` override handler, if it exists.
3. Call ``set_foo``, if it exists.
4. Call ``setFoo``, if it exists.
5. Set the text of a ``foo`` element, if ``'foo'`` is
in :attr:`sub_interfaces`.
6. Set the value of a top level XML attribute named ``foo``.
7. Attempt to pass the value to a plugin named ``'foo'`` using
the plugin's ``'foo'`` interface.
8. Do nothing.
:param string attrib: The name of the stanza interface to modify.
:param value: The new value of the stanza interface.
"""
if attrib in self.interfaces:
if value is not None:
set_method = "set_%s" % attrib.lower()
set_method2 = "set%s" % attrib.title()
if self.plugin_overrides:
plugin = self.plugin_overrides.get(set_method, None)
if plugin:
if plugin not in self.plugins:
self.init_plugin(plugin)
handler = getattr(self.plugins[plugin], set_method,
None)
if handler:
return handler(value)
if hasattr(self, set_method):
getattr(self, set_method)(value, )
elif hasattr(self, set_method2):
getattr(self, set_method2)(value, )
else:
if attrib in self.sub_interfaces:
return self._set_sub_text(attrib, text=value)
else:
self._set_attr(attrib, value)
else:
self.__delitem__(attrib)
elif attrib in self.plugin_attrib_map:
if attrib not in self.plugins:
self.init_plugin(attrib)
self.plugins[attrib][attrib] = value
return self
def __delitem__(self, attrib):
"""Delete the value of a stanza interface using dict-like syntax.
Example::
>>> msg['body'] = "Hi!"
>>> msg['body']
'Hi!'
>>> del msg['body']
>>> msg['body']
''
Stanza interfaces are typically mapped directly to the underlyig XML
object, but can be overridden by the presence of a ``del_attrib``
method (or ``del_foo`` where the interface is named ``'foo'``, etc).
The effect of deleting a stanza interface value named ``foo`` will be
one of:
1. Call ``del_foo`` override handler, if it exists.
2. Call ``del_foo``, if it exists.
3. Call ``delFoo``, if it exists.
4. Delete ``foo`` element, if ``'foo'`` is in
:attr:`sub_interfaces`.
5. Delete top level XML attribute named ``foo``.
6. Remove the ``foo`` plugin, if it was loaded.
7. Do nothing.
:param attrib: The name of the affected stanza interface.
"""
if attrib in self.interfaces:
del_method = "del_%s" % attrib.lower()
del_method2 = "del%s" % attrib.title()
if self.plugin_overrides:
plugin = self.plugin_overrides.get(del_method, None)
if plugin:
if plugin not in self.plugins:
self.init_plugin(plugin)
handler = getattr(self.plugins[plugin], del_method, None)
if handler:
return handler()
if hasattr(self, del_method):
getattr(self, del_method)()
elif hasattr(self, del_method2):
getattr(self, del_method2)()
else:
if attrib in self.sub_interfaces:
return self._del_sub(attrib)
else:
self._del_attr(attrib)
elif attrib in self.plugin_attrib_map:
if attrib in self.plugins:
xml = self.plugins[attrib].xml
if self.plugins[attrib].is_extension:
del self.plugins[attrib][attrib]
del self.plugins[attrib]
try:
self.xml.remove(xml)
except:
pass
return self
def _set_attr(self, name, value):
"""Set the value of a top level attribute of the XML object.
If the new value is None or an empty string, then the attribute will
be removed.
:param name: The name of the attribute.
:param value: The new value of the attribute, or None or '' to
remove it.
"""
if value is None or value == '':
self.__delitem__(name)
else:
self.xml.attrib[name] = value
def _del_attr(self, name):
"""Remove a top level attribute of the XML object.
:param name: The name of the attribute.
"""
if name in self.xml.attrib:
del self.xml.attrib[name]
def _get_attr(self, name, default=''):
"""Return the value of a top level attribute of the XML object.
In case the attribute has not been set, a default value can be
returned instead. An empty string is returned if no other default
is supplied.
:param name: The name of the attribute.
:param default: Optional value to return if the attribute has not
been set. An empty string is returned otherwise.
"""
return self.xml.attrib.get(name, default)
def _get_sub_text(self, name, default=''):
"""Return the text contents of a sub element.
In case the element does not exist, or it has no textual content,
a default value can be returned instead. An empty string is returned
if no other default is supplied.
:param name: The name or XPath expression of the element.
:param default: Optional default to return if the element does
not exists. An empty string is returned otherwise.
"""
name = self._fix_ns(name)
stanza = self.xml.find(name)
if stanza is None or stanza.text is None:
return default
else:
return stanza.text
def _set_sub_text(self, name, text=None, keep=False):
"""Set the text contents of a sub element.
In case the element does not exist, a element will be created,
and its text contents will be set.
If the text is set to an empty string, or None, then the
element will be removed, unless keep is set to True.
:param name: The name or XPath expression of the element.
:param text: The new textual content of the element. If the text
is an empty string or None, the element will be removed
unless the parameter keep is True.
:param keep: Indicates if the element should be kept if its text is
removed. Defaults to False.
"""
path = self._fix_ns(name, split=True)
element = self.xml.find(name)
if not text and not keep:
return self._del_sub(name)
if element is None:
# We need to add the element. If the provided name was
# an XPath expression, some of the intermediate elements
# may already exist. If so, we want to use those instead
# of generating new elements.
last_xml = self.xml
walked = []
for ename in path:
walked.append(ename)
element = self.xml.find("/".join(walked))
if element is None:
element = ET.Element(ename)
last_xml.append(element)
last_xml = element
element = last_xml
element.text = text
return element
def _del_sub(self, name, all=False):
"""Remove sub elements that match the given name or XPath.
If the element is in a path, then any parent elements that become
empty after deleting the element may also be deleted if requested
by setting all=True.
:param name: The name or XPath expression for the element(s) to remove.
:param bool all: If True, remove all empty elements in the path to the
deleted element. Defaults to False.
"""
path = self._fix_ns(name, split=True)
original_target = path[-1]
for level, _ in enumerate(path):
# Generate the paths to the target elements and their parent.
element_path = "/".join(path[:len(path) - level])
parent_path = "/".join(path[:len(path) - level - 1])
elements = self.xml.findall(element_path)
parent = self.xml.find(parent_path)
if elements:
if parent is None:
parent = self.xml
for element in elements:
if element.tag == original_target or \
not element.getchildren():
# Only delete the originally requested elements, and
# any parent elements that have become empty.
parent.remove(element)
if not all:
# If we don't want to delete elements up the tree, stop
# after deleting the first level of elements.
return
def match(self, xpath):
"""Compare a stanza object with an XPath-like expression.
If the XPath matches the contents of the stanza object, the match
is successful.
The XPath expression may include checks for stanza attributes.
For example::
'presence@show=xa@priority=2/status'
Would match a presence stanza whose show value is set to ``'xa'``,
has a priority value of ``'2'``, and has a status element.
:param string xpath: The XPath expression to check against. It
may be either a string or a list of element
names with attribute checks.
"""
if isinstance(xpath, str):
xpath = self._fix_ns(xpath, split=True, propagate_ns=False)
# Extract the tag name and attribute checks for the first XPath node.
components = xpath[0].split('@')
tag = components[0]
attributes = components[1:]
if tag not in (self.name, "{%s}%s" % (self.namespace, self.name)) and \
tag not in self.plugins and tag not in self.plugin_attrib:
# The requested tag is not in this stanza, so no match.
return False
# Check the rest of the XPath against any substanzas.
matched_substanzas = False
for substanza in self.iterables:
if xpath[1:] == []:
break
matched_substanzas = substanza.match(xpath[1:])
if matched_substanzas:
break
# Check attribute values.
for attribute in attributes:
name, value = attribute.split('=')
if self[name] != value:
return False
# Check sub interfaces.
if len(xpath) > 1:
next_tag = xpath[1]
if next_tag in self.sub_interfaces and self[next_tag]:
return True
# Attempt to continue matching the XPath using the stanza's plugins.
if not matched_substanzas and len(xpath) > 1:
# Convert {namespace}tag@attribs to just tag
next_tag = xpath[1].split('@')[0].split('}')[-1]
if next_tag in self.plugins:
return self.plugins[next_tag].match(xpath[1:])
else:
return False
# Everything matched.
return True
def find(self, xpath):
"""Find an XML object in this stanza given an XPath expression.
Exposes ElementTree interface for backwards compatibility.
.. note::
Matching on attribute values is not supported in Python 2.6
or Python 3.1
:param string xpath: An XPath expression matching a single
desired element.
"""
return self.xml.find(xpath)
def findall(self, xpath):
"""Find multiple XML objects in this stanza given an XPath expression.
Exposes ElementTree interface for backwards compatibility.
.. note::
Matching on attribute values is not supported in Python 2.6
or Python 3.1.
:param string xpath: An XPath expression matching multiple
desired elements.
"""
return self.xml.findall(xpath)
def get(self, key, default=None):
"""Return the value of a stanza interface.
If the found value is None or an empty string, return the supplied
default value.
Allows stanza objects to be used like dictionaries.
:param string key: The name of the stanza interface to check.
:param default: Value to return if the stanza interface has a value
of ``None`` or ``""``. Will default to returning None.
"""
value = self[key]
if value is None or value == '':
return default
return value
def keys(self):
"""Return the names of all stanza interfaces provided by the
stanza object.
Allows stanza objects to be used like dictionaries.
"""
out = []
out += [x for x in self.interfaces]
out += [x for x in self.plugins]
if self.iterables:
out.append('substanzas')
return out
def append(self, item):
"""Append either an XML object or a substanza to this stanza object.
If a substanza object is appended, it will be added to the list
of iterable stanzas.
Allows stanza objects to be used like lists.
:param item: Either an XML object or a stanza object to add to
this stanza's contents.
"""
if not isinstance(item, ElementBase):
if type(item) == XML_TYPE:
return self.appendxml(item)
else:
raise TypeError
self.xml.append(item.xml)
self.iterables.append(item)
return self
def appendxml(self, xml):
"""Append an XML object to the stanza's XML.
The added XML will not be included in the list of
iterable substanzas.
:param XML xml: The XML object to add to the stanza.
"""
self.xml.append(xml)
return self
def pop(self, index=0):
"""Remove and return the last substanza in the list of
iterable substanzas.
Allows stanza objects to be used like lists.
:param int index: The index of the substanza to remove.
"""
substanza = self.iterables.pop(index)
self.xml.remove(substanza.xml)
return substanza
def next(self):
"""Return the next iterable substanza."""
return self.__next__()
def clear(self):
"""Remove all XML element contents and plugins.
Any attribute values will be preserved.
"""
for child in self.xml.getchildren():
self.xml.remove(child)
for plugin in list(self.plugins.keys()):
del self.plugins[plugin]
return self
@classmethod
def tag_name(cls):
"""Return the namespaced name of the stanza's root element.
The format for the tag name is::
'{namespace}elementname'
For example, for the stanza ``<foo xmlns="bar" />``,
``stanza.tag_name()`` would return ``"{bar}foo"``.
"""
return "{%s}%s" % (cls.namespace, cls.name)
@property
def attrib(self):
"""Return the stanza object itself.
Older implementations of stanza objects used XML objects directly,
requiring the use of ``.attrib`` to access attribute values.
Use of the dictionary syntax with the stanza object itself for
accessing stanza interfaces is preferred.
.. deprecated:: 1.0
"""
return self
def _fix_ns(self, xpath, split=False, propagate_ns=True):
"""Apply the stanza's namespace to elements in an XPath expression.
:param string xpath: The XPath expression to fix with namespaces.
:param bool split: Indicates if the fixed XPath should be left as a
list of element names with namespaces. Defaults to
False, which returns a flat string path.
:param bool propagate_ns: Overrides propagating parent element
namespaces to child elements. Useful if
you wish to simply split an XPath that has
non-specified namespaces, and child and
parent namespaces are known not to always
match. Defaults to True.
"""
fixed = []
# Split the XPath into a series of blocks, where a block
# is started by an element with a namespace.
ns_blocks = xpath.split('{')
for ns_block in ns_blocks:
if '}' in ns_block:
# Apply the found namespace to following elements
# that do not have namespaces.
namespace = ns_block.split('}')[0]
elements = ns_block.split('}')[1].split('/')
else:
# Apply the stanza's namespace to the following
# elements since no namespace was provided.
namespace = self.namespace
elements = ns_block.split('/')
for element in elements:
if element:
# Skip empty entry artifacts from splitting.
if propagate_ns:
tag = '{%s}%s' % (namespace, element)
else:
tag = element
fixed.append(tag)
if split:
return fixed
return '/'.join(fixed)
def __eq__(self, other):
"""Compare the stanza object with another to test for equality.
Stanzas are equal if their interfaces return the same values,
and if they are both instances of ElementBase.
:param ElementBase other: The stanza object to compare against.
"""
if not isinstance(other, ElementBase):
return False
# Check that this stanza is a superset of the other stanza.
values = self.values
for key in other.keys():
if key not in values or values[key] != other[key]:
return False
# Check that the other stanza is a superset of this stanza.
values = other.values
for key in self.keys():
if key not in values or values[key] != self[key]:
return False
# Both stanzas are supersets of each other, therefore they
# must be equal.
return True
def __ne__(self, other):
"""Compare the stanza object with another to test for inequality.
Stanzas are not equal if their interfaces return different values,
or if they are not both instances of ElementBase.
:param ElementBase other: The stanza object to compare against.
"""
return not self.__eq__(other)
def __bool__(self):
"""Stanza objects should be treated as True in boolean contexts.
Python 3.x version.
"""
return True
def __nonzero__(self):
"""Stanza objects should be treated as True in boolean contexts.
Python 2.x version.
"""
return True
def __len__(self):
"""Return the number of iterable substanzas in this stanza."""
return len(self.iterables)
def __iter__(self):
"""Return an iterator object for the stanza's substanzas.
The iterator is the stanza object itself. Attempting to use two
iterators on the same stanza at the same time is discouraged.
"""
self._index = 0
return self
def __next__(self):
"""Return the next iterable substanza."""
self._index += 1
if self._index > len(self.iterables):
self._index = 0
raise StopIteration
return self.iterables[self._index - 1]
def __copy__(self):
"""Return a copy of the stanza object that does not share the same
underlying XML object.
"""
return self.__class__(xml=copy.deepcopy(self.xml), parent=self.parent)
def __str__(self, top_level_ns=True):
"""Return a string serialization of the underlying XML object.
.. seealso:: :ref:`tostring`
:param bool top_level_ns: Display the top-most namespace.
Defaults to True.
"""
stanza_ns = '' if top_level_ns else self.namespace
return tostring(self.xml,
xmlns='',
stanza_ns=stanza_ns,
top_level=not top_level_ns)
def __repr__(self):
"""Use the stanza's serialized XML as its representation."""
return self.__str__()
def get_values(self):
values = OrderedDict()
fields = self['fields']
for var in fields:
values[var] = fields[var]['value']
return values
class ElementBase(object):
"""
The core of SleekXMPP's stanza XML manipulation and handling is provided
by ElementBase. ElementBase wraps XML cElementTree objects and enables
access to the XML contents through dictionary syntax, similar in style
to the Ruby XMPP library Blather's stanza implementation.
Stanzas are defined by their name, namespace, and interfaces. For
example, a simplistic Message stanza could be defined as:
>>> class Message(ElementBase):
... name = "message"
... namespace = "jabber:client"
... interfaces = set(('to', 'from', 'type', 'body'))
... sub_interfaces = set(('body',))
The resulting Message stanza's contents may be accessed as so:
>>> message['to'] = "*****@*****.**"
>>> message['body'] = "Hi!"
>>> message['body']
"Hi!"
>>> del message['body']
>>> message['body']
""
The interface values map to either custom access methods, stanza
XML attributes, or (if the interface is also in sub_interfaces) the
text contents of a stanza's subelement.
Custom access methods may be created by adding methods of the
form "getInterface", "setInterface", or "delInterface", where
"Interface" is the titlecase version of the interface name.
Stanzas may be extended through the use of plugins. A plugin
is simply a stanza that has a plugin_attrib value. For example:
>>> class MessagePlugin(ElementBase):
... name = "custom_plugin"
... namespace = "custom"
... interfaces = set(('useful_thing', 'custom'))
... plugin_attrib = "custom"
The plugin stanza class must be associated with its intended
container stanza by using register_stanza_plugin as so:
>>> register_stanza_plugin(Message, MessagePlugin)
The plugin may then be accessed as if it were built-in to the parent
stanza.
>>> message['custom']['useful_thing'] = 'foo'
If a plugin provides an interface that is the same as the plugin's
plugin_attrib value, then the plugin's interface may be assigned
directly from the parent stanza, as shown below, but retrieving
information will require all interfaces to be used, as so:
>>> message['custom'] = 'bar' # Same as using message['custom']['custom']
>>> message['custom']['custom'] # Must use all interfaces
'bar'
If the plugin sets the value is_extension = True, then both setting
and getting an interface value that is the same as the plugin's
plugin_attrib value will work, as so:
>>> message['custom'] = 'bar' # Using is_extension=True
>>> message['custom']
'bar'
Class Attributes:
name -- The name of the stanza's main element.
namespace -- The namespace of the stanza's main element.
interfaces -- A set of attribute and element names that may
be accessed using dictionary syntax.
sub_interfaces -- A subset of the set of interfaces which map
to subelements instead of attributes.
subitem -- A set of stanza classes which are allowed to
be added as substanzas. Deprecated version
of plugin_iterables.
overrides -- A list of interfaces prepended with 'get_',
'set_', or 'del_'. If the stanza is registered
as a plugin with overrides=True, then the
parent's interface handlers will be
overridden by the plugin's matching handler.
types -- A set of generic type attribute values.
tag -- The namespaced name of the stanza's root
element. Example: "{foo_ns}bar"
plugin_attrib -- The interface name that the stanza uses to be
accessed as a plugin from another stanza.
plugin_attrib_map -- A mapping of plugin attribute names with the
associated plugin stanza classes.
plugin_iterables -- A set of stanza classes which are allowed to
be added as substanzas.
plugin_overrides -- A mapping of interfaces prepended with 'get_',
'set_' or 'del_' to plugin attrib names. Allows
a plugin to override the behaviour of a parent
stanza's interface handlers.
plugin_tag_map -- A mapping of plugin stanza tag names with
the associated plugin stanza classes.
is_extension -- When True, allows the stanza to provide one
additional interface to the parent stanza,
extending the interfaces supported by the
parent. Defaults to False.
xml_ns -- The XML namespace,
http://www.w3.org/XML/1998/namespace,
for use with xml:lang values.
Instance Attributes:
xml -- The stanza's XML contents.
parent -- The parent stanza of this stanza.
plugins -- A map of enabled plugin names with the
initialized plugin stanza objects.
values -- A dictionary of the stanza's interfaces
and interface values, including plugins.
Class Methods
tag_name -- Return the namespaced version of the stanza's
root element's name.
Methods:
setup -- Initialize the stanza's XML contents.
enable -- Instantiate a stanza plugin.
Alias for init_plugin.
init_plugin -- Instantiate a stanza plugin.
_get_stanza_values -- Return a dictionary of stanza interfaces and
their values.
_set_stanza_values -- Set stanza interface values given a dictionary
of interfaces and values.
__getitem__ -- Return the value of a stanza interface.
__setitem__ -- Set the value of a stanza interface.
__delitem__ -- Remove the value of a stanza interface.
_set_attr -- Set an attribute value of the main
stanza element.
_del_attr -- Remove an attribute from the main
stanza element.
_get_attr -- Return an attribute's value from the main
stanza element.
_get_sub_text -- Return the text contents of a subelement.
_set_sub_text -- Set the text contents of a subelement.
_del_sub -- Remove a subelement.
match -- Compare the stanza against an XPath expression.
find -- Return subelement matching an XPath expression.
findall -- Return subelements matching an XPath expression.
get -- Return the value of a stanza interface, with an
optional default value.
keys -- Return the set of interface names accepted by
the stanza.
append -- Add XML content or a substanza to the stanza.
appendxml -- Add XML content to the stanza.
pop -- Remove a substanza.
next -- Return the next iterable substanza.
clear -- Reset the stanza's XML contents.
_fix_ns -- Apply the stanza's namespace to non-namespaced
elements in an XPath expression.
"""
name = 'stanza'
plugin_attrib = 'plugin'
namespace = 'jabber:client'
interfaces = set(('type', 'to', 'from', 'id', 'payload'))
types = set(('get', 'set', 'error', None, 'unavailable', 'normal', 'chat'))
sub_interfaces = tuple()
overrides = {}
plugin_attrib_map = {}
plugin_overrides = {}
plugin_iterables = set()
plugin_tag_map = {}
subitem = set()
is_extension = False
xml_ns = 'http://www.w3.org/XML/1998/namespace'
def __init__(self, xml=None, parent=None):
"""
Create a new stanza object.
Arguments:
xml -- Initialize the stanza with optional existing XML.
parent -- Optional stanza object that contains this stanza.
"""
self.xml = xml
self.plugins = OrderedDict()
self.iterables = []
self._index = 0
self.tag = self.tag_name()
if parent is None:
self.parent = None
else:
self.parent = weakref.ref(parent)
ElementBase.values = property(ElementBase._get_stanza_values,
ElementBase._set_stanza_values)
if self.subitem is not None:
for sub in self.subitem:
self.plugin_iterables.add(sub)
if self.setup(xml):
# If we generated our own XML, then everything is ready.
return
# Initialize values using provided XML
for child in self.xml.getchildren():
if child.tag in self.plugin_tag_map:
plugin = self.plugin_tag_map[child.tag]
self.plugins[plugin.plugin_attrib] = plugin(child, self)
for sub in self.plugin_iterables:
if child.tag == "{%s}%s" % (sub.namespace, sub.name):
self.iterables.append(sub(child, self))
break
def setup(self, xml=None):
"""
Initialize the stanza's XML contents.
Will return True if XML was generated according to the stanza's
definition.
Arguments:
xml -- Optional XML object to use for the stanza's content
instead of generating XML.
"""
if self.xml is None:
self.xml = xml
if self.xml is None:
# Generate XML from the stanza definition
for ename in self.name.split('/'):
new = ET.Element("{%s}%s" % (self.namespace, ename))
if self.xml is None:
self.xml = new
else:
last_xml.append(new)
last_xml = new
if self.parent is not None:
self.parent().xml.append(self.xml)
# We had to generate XML
return True
else:
# We did not generate XML
return False
def enable(self, attrib):
"""
Enable and initialize a stanza plugin.
Alias for init_plugin.
Arguments:
attrib -- The stanza interface for the plugin.
"""
return self.init_plugin(attrib)
def init_plugin(self, attrib):
"""
Enable and initialize a stanza plugin.
Arguments:
attrib -- The stanza interface for the plugin.
"""
if attrib not in self.plugins:
plugin_class = self.plugin_attrib_map[attrib]
self.plugins[attrib] = plugin_class(parent=self)
return self
def _get_stanza_values(self):
"""
Return a dictionary of the stanza's interface values.
Stanza plugin values are included as nested dictionaries.
"""
values = {}
for interface in self.interfaces:
values[interface] = self[interface]
for plugin, stanza in self.plugins.items():
values[plugin] = stanza.values
if self.iterables:
iterables = []
for stanza in self.iterables:
iterables.append(stanza.values)
iterables[-1]['__childtag__'] = stanza.tag
values['substanzas'] = iterables
return values
def _set_stanza_values(self, values):
"""
Set multiple stanza interface values using a dictionary.
Stanza plugin values may be set using nested dictionaries.
Arguments:
values -- A dictionary mapping stanza interface with values.
Plugin interfaces may accept a nested dictionary that
will be used recursively.
"""
iterable_interfaces = [p.plugin_attrib for \
p in self.plugin_iterables]
for interface, value in values.items():
if interface == 'substanzas':
# Remove existing substanzas
for stanza in self.iterables:
self.xml.remove(stanza.xml)
self.iterables = []
# Add new substanzas
for subdict in value:
if '__childtag__' in subdict:
for subclass in self.plugin_iterables:
child_tag = "{%s}%s" % (subclass.namespace,
subclass.name)
if subdict['__childtag__'] == child_tag:
sub = subclass(parent=self)
sub.values = subdict
self.iterables.append(sub)
break
elif interface in self.interfaces:
self[interface] = value
elif interface in self.plugin_attrib_map:
if interface not in iterable_interfaces:
if interface not in self.plugins:
self.init_plugin(interface)
self.plugins[interface].values = value
return self
def __getitem__(self, attrib):
"""
Return the value of a stanza interface using dictionary-like syntax.
Example:
>>> msg['body']
'Message contents'
Stanza interfaces are typically mapped directly to the underlying XML
object, but can be overridden by the presence of a get_attrib method
(or get_foo where the interface is named foo, etc).
The search order for interface value retrieval for an interface
named 'foo' is:
1. The list of substanzas.
2. The result of calling the get_foo override handler.
3. The result of calling get_foo.
4. The result of calling getFoo.
5. The contents of the foo subelement, if foo is a sub interface.
6. The value of the foo attribute of the XML object.
7. The plugin named 'foo'
8. An empty string.
Arguments:
attrib -- The name of the requested stanza interface.
"""
if attrib == 'substanzas':
return self.iterables
elif attrib in self.interfaces:
get_method = "get_%s" % attrib.lower()
get_method2 = "get%s" % attrib.title()
if self.plugin_overrides:
plugin = self.plugin_overrides.get(get_method, None)
if plugin:
if plugin not in self.plugins:
self.init_plugin(plugin)
handler = getattr(self.plugins[plugin], get_method, None)
if handler:
return handler()
if hasattr(self, get_method):
return getattr(self, get_method)()
elif hasattr(self, get_method2):
return getattr(self, get_method2)()
else:
if attrib in self.sub_interfaces:
return self._get_sub_text(attrib)
else:
return self._get_attr(attrib)
elif attrib in self.plugin_attrib_map:
if attrib not in self.plugins:
self.init_plugin(attrib)
if self.plugins[attrib].is_extension:
return self.plugins[attrib][attrib]
return self.plugins[attrib]
else:
return ''
def __setitem__(self, attrib, value):
"""
Set the value of a stanza interface using dictionary-like syntax.
Example:
>>> msg['body'] = "Hi!"
>>> msg['body']
'Hi!'
Stanza interfaces are typically mapped directly to the underlying XML
object, but can be overridden by the presence of a set_attrib method
(or set_foo where the interface is named foo, etc).
The effect of interface value assignment for an interface
named 'foo' will be one of:
1. Delete the interface's contents if the value is None.
2. Call the set_foo override handler, if it exists.
3. Call set_foo, if it exists.
4. Call setFoo, if it exists.
5. Set the text of a foo element, if foo is in sub_interfaces.
6. Set the value of a top level XML attribute name foo.
7. Attempt to pass value to a plugin named foo using the plugin's
foo interface.
8. Do nothing.
Arguments:
attrib -- The name of the stanza interface to modify.
value -- The new value of the stanza interface.
"""
if attrib in self.interfaces:
if value is not None:
set_method = "set_%s" % attrib.lower()
set_method2 = "set%s" % attrib.title()
if self.plugin_overrides:
plugin = self.plugin_overrides.get(set_method, None)
if plugin:
if plugin not in self.plugins:
self.init_plugin(plugin)
handler = getattr(self.plugins[plugin], set_method,
None)
if handler:
return handler(value)
if hasattr(self, set_method):
getattr(self, set_method)(value, )
elif hasattr(self, set_method2):
getattr(self, set_method2)(value, )
else:
if attrib in self.sub_interfaces:
return self._set_sub_text(attrib, text=value)
else:
self._set_attr(attrib, value)
else:
self.__delitem__(attrib)
elif attrib in self.plugin_attrib_map:
if attrib not in self.plugins:
self.init_plugin(attrib)
self.plugins[attrib][attrib] = value
return self
def __delitem__(self, attrib):
"""
Delete the value of a stanza interface using dictionary-like syntax.
Example:
>>> msg['body'] = "Hi!"
>>> msg['body']
'Hi!'
>>> del msg['body']
>>> msg['body']
''
Stanza interfaces are typically mapped directly to the underlyig XML
object, but can be overridden by the presence of a del_attrib method
(or del_foo where the interface is named foo, etc).
The effect of deleting a stanza interface value named foo will be
one of:
1. Call del_foo override handler, if it exists.
2. Call del_foo, if it exists.
3. Call delFoo, if it exists.
4. Delete foo element, if foo is in sub_interfaces.
5. Delete top level XML attribute named foo.
6. Remove the foo plugin, if it was loaded.
7. Do nothing.
Arguments:
attrib -- The name of the affected stanza interface.
"""
if attrib in self.interfaces:
del_method = "del_%s" % attrib.lower()
del_method2 = "del%s" % attrib.title()
if self.plugin_overrides:
plugin = self.plugin_overrides.get(del_method, None)
if plugin:
if plugin not in self.plugins:
self.init_plugin(plugin)
handler = getattr(self.plugins[plugin], del_method, None)
if handler:
return handler()
if hasattr(self, del_method):
getattr(self, del_method)()
elif hasattr(self, del_method2):
getattr(self, del_method2)()
else:
if attrib in self.sub_interfaces:
return self._del_sub(attrib)
else:
self._del_attr(attrib)
elif attrib in self.plugin_attrib_map:
if attrib in self.plugins:
xml = self.plugins[attrib].xml
if self.plugins[attrib].is_extension:
del self.plugins[attrib][attrib]
del self.plugins[attrib]
try:
self.xml.remove(xml)
except:
pass
return self
def _set_attr(self, name, value):
"""
Set the value of a top level attribute of the underlying XML object.
If the new value is None or an empty string, then the attribute will
be removed.
Arguments:
name -- The name of the attribute.
value -- The new value of the attribute, or None or '' to
remove it.
"""
if value is None or value == '':
self.__delitem__(name)
else:
self.xml.attrib[name] = value
def _del_attr(self, name):
"""
Remove a top level attribute of the underlying XML object.
Arguments:
name -- The name of the attribute.
"""
if name in self.xml.attrib:
del self.xml.attrib[name]
def _get_attr(self, name, default=''):
"""
Return the value of a top level attribute of the underlying
XML object.
In case the attribute has not been set, a default value can be
returned instead. An empty string is returned if no other default
is supplied.
Arguments:
name -- The name of the attribute.
default -- Optional value to return if the attribute has not
been set. An empty string is returned otherwise.
"""
return self.xml.attrib.get(name, default)
def _get_sub_text(self, name, default=''):
"""
Return the text contents of a sub element.
In case the element does not exist, or it has no textual content,
a default value can be returned instead. An empty string is returned
if no other default is supplied.
Arguments:
name -- The name or XPath expression of the element.
default -- Optional default to return if the element does
not exists. An empty string is returned otherwise.
"""
name = self._fix_ns(name)
stanza = self.xml.find(name)
if stanza is None or stanza.text is None:
return default
else:
return stanza.text
def _set_sub_text(self, name, text=None, keep=False):
"""
Set the text contents of a sub element.
In case the element does not exist, a element will be created,
and its text contents will be set.
If the text is set to an empty string, or None, then the
element will be removed, unless keep is set to True.
Arguments:
name -- The name or XPath expression of the element.
text -- The new textual content of the element. If the text
is an empty string or None, the element will be removed
unless the parameter keep is True.
keep -- Indicates if the element should be kept if its text is
removed. Defaults to False.
"""
path = self._fix_ns(name, split=True)
element = self.xml.find(name)
if not text and not keep:
return self._del_sub(name)
if element is None:
# We need to add the element. If the provided name was
# an XPath expression, some of the intermediate elements
# may already exist. If so, we want to use those instead
# of generating new elements.
last_xml = self.xml
walked = []
for ename in path:
walked.append(ename)
element = self.xml.find("/".join(walked))
if element is None:
element = ET.Element(ename)
last_xml.append(element)
last_xml = element
element = last_xml
element.text = text
return element
def _del_sub(self, name, all=False):
"""
Remove sub elements that match the given name or XPath.
If the element is in a path, then any parent elements that become
empty after deleting the element may also be deleted if requested
by setting all=True.
Arguments:
name -- The name or XPath expression for the element(s) to remove.
all -- If True, remove all empty elements in the path to the
deleted element. Defaults to False.
"""
path = self._fix_ns(name, split=True)
original_target = path[-1]
for level, _ in enumerate(path):
# Generate the paths to the target elements and their parent.
element_path = "/".join(path[:len(path) - level])
parent_path = "/".join(path[:len(path) - level - 1])
elements = self.xml.findall(element_path)
parent = self.xml.find(parent_path)
if elements:
if parent is None:
parent = self.xml
for element in elements:
if element.tag == original_target or \
not element.getchildren():
# Only delete the originally requested elements, and
# any parent elements that have become empty.
parent.remove(element)
if not all:
# If we don't want to delete elements up the tree, stop
# after deleting the first level of elements.
return
def match(self, xpath):
"""
Compare a stanza object with an XPath expression. If the XPath matches
the contents of the stanza object, the match is successful.
The XPath expression may include checks for stanza attributes.
For example:
presence@show=xa@priority=2/status
Would match a presence stanza whose show value is set to 'xa', has a
priority value of '2', and has a status element.
Arguments:
xpath -- The XPath expression to check against. It may be either a
string or a list of element names with attribute checks.
"""
if isinstance(xpath, str):
xpath = self._fix_ns(xpath, split=True, propagate_ns=False)
# Extract the tag name and attribute checks for the first XPath node.
components = xpath[0].split('@')
tag = components[0]
attributes = components[1:]
if tag not in (self.name, "{%s}%s" % (self.namespace, self.name)) and \
tag not in self.plugins and tag not in self.plugin_attrib:
# The requested tag is not in this stanza, so no match.
return False
# Check the rest of the XPath against any substanzas.
matched_substanzas = False
for substanza in self.iterables:
if xpath[1:] == []:
break
matched_substanzas = substanza.match(xpath[1:])
if matched_substanzas:
break
# Check attribute values.
for attribute in attributes:
name, value = attribute.split('=')
if self[name] != value:
return False
# Check sub interfaces.
if len(xpath) > 1:
next_tag = xpath[1]
if next_tag in self.sub_interfaces and self[next_tag]:
return True
# Attempt to continue matching the XPath using the stanza's plugins.
if not matched_substanzas and len(xpath) > 1:
# Convert {namespace}tag@attribs to just tag
next_tag = xpath[1].split('@')[0].split('}')[-1]
if next_tag in self.plugins:
return self.plugins[next_tag].match(xpath[1:])
else:
return False
# Everything matched.
return True
def find(self, xpath):
"""
Find an XML object in this stanza given an XPath expression.
Exposes ElementTree interface for backwards compatibility.
Note that matching on attribute values is not supported in Python 2.6
or Python 3.1
Arguments:
xpath -- An XPath expression matching a single desired element.
"""
return self.xml.find(xpath)
def findall(self, xpath):
"""
Find multiple XML objects in this stanza given an XPath expression.
Exposes ElementTree interface for backwards compatibility.
Note that matching on attribute values is not supported in Python 2.6
or Python 3.1.
Arguments:
xpath -- An XPath expression matching multiple desired elements.
"""
return self.xml.findall(xpath)
def get(self, key, default=None):
"""
Return the value of a stanza interface. If the found value is None
or an empty string, return the supplied default value.
Allows stanza objects to be used like dictionaries.
Arguments:
key -- The name of the stanza interface to check.
default -- Value to return if the stanza interface has a value
of None or "". Will default to returning None.
"""
value = self[key]
if value is None or value == '':
return default
return value
def keys(self):
"""
Return the names of all stanza interfaces provided by the
stanza object.
Allows stanza objects to be used like dictionaries.
"""
out = []
out += [x for x in self.interfaces]
out += [x for x in self.plugins]
if self.iterables:
out.append('substanzas')
return out
def append(self, item):
"""
Append either an XML object or a substanza to this stanza object.
If a substanza object is appended, it will be added to the list
of iterable stanzas.
Allows stanza objects to be used like lists.
Arguments:
item -- Either an XML object or a stanza object to add to
this stanza's contents.
"""
if not isinstance(item, ElementBase):
if type(item) == XML_TYPE:
return self.appendxml(item)
else:
raise TypeError
self.xml.append(item.xml)
self.iterables.append(item)
return self
def appendxml(self, xml):
"""
Append an XML object to the stanza's XML.
The added XML will not be included in the list of
iterable substanzas.
Arguments:
xml -- The XML object to add to the stanza.
"""
self.xml.append(xml)
return self
def pop(self, index=0):
"""
Remove and return the last substanza in the list of
iterable substanzas.
Allows stanza objects to be used like lists.
Arguments:
index -- The index of the substanza to remove.
"""
substanza = self.iterables.pop(index)
self.xml.remove(substanza.xml)
return substanza
def next(self):
"""
Return the next iterable substanza.
"""
return self.__next__()
def clear(self):
"""
Remove all XML element contents and plugins.
Any attribute values will be preserved.
"""
for child in self.xml.getchildren():
self.xml.remove(child)
for plugin in list(self.plugins.keys()):
del self.plugins[plugin]
return self
@classmethod
def tag_name(cls):
"""
Return the namespaced name of the stanza's root element.
For example, for the stanza <foo xmlns="bar" />,
stanza.tag would return "{bar}foo".
"""
return "{%s}%s" % (cls.namespace, cls.name)
@property
def attrib(self):
"""
DEPRECATED
For backwards compatibility, stanza.attrib returns the stanza itself.
Older implementations of stanza objects used XML objects directly,
requiring the use of .attrib to access attribute values.
Use of the dictionary syntax with the stanza object itself for
accessing stanza interfaces is preferred.
"""
return self
def _fix_ns(self, xpath, split=False, propagate_ns=True):
"""
Apply the stanza's namespace to elements in an XPath expression.
Arguments:
xpath -- The XPath expression to fix with namespaces.
split -- Indicates if the fixed XPath should be left as a
list of element names with namespaces. Defaults to
False, which returns a flat string path.
propagate_ns -- Overrides propagating parent element namespaces
to child elements. Useful if you wish to simply
split an XPath that has non-specified namespaces,
and child and parent namespaces are known not to
always match. Defaults to True.
"""
fixed = []
# Split the XPath into a series of blocks, where a block
# is started by an element with a namespace.
ns_blocks = xpath.split('{')
for ns_block in ns_blocks:
if '}' in ns_block:
# Apply the found namespace to following elements
# that do not have namespaces.
namespace = ns_block.split('}')[0]
elements = ns_block.split('}')[1].split('/')
else:
# Apply the stanza's namespace to the following
# elements since no namespace was provided.
namespace = self.namespace
elements = ns_block.split('/')
for element in elements:
if element:
# Skip empty entry artifacts from splitting.
if propagate_ns:
tag = '{%s}%s' % (namespace, element)
else:
tag = element
fixed.append(tag)
if split:
return fixed
return '/'.join(fixed)
def __eq__(self, other):
"""
Compare the stanza object with another to test for equality.
Stanzas are equal if their interfaces return the same values,
and if they are both instances of ElementBase.
Arguments:
other -- The stanza object to compare against.
"""
if not isinstance(other, ElementBase):
return False
# Check that this stanza is a superset of the other stanza.
values = self.values
for key in other.keys():
if key not in values or values[key] != other[key]:
return False
# Check that the other stanza is a superset of this stanza.
values = other.values
for key in self.keys():
if key not in values or values[key] != self[key]:
return False
# Both stanzas are supersets of each other, therefore they
# must be equal.
return True
def __ne__(self, other):
"""
Compare the stanza object with another to test for inequality.
Stanzas are not equal if their interfaces return different values,
or if they are not both instances of ElementBase.
Arguments:
other -- The stanza object to compare against.
"""
return not self.__eq__(other)
def __bool__(self):
"""
Stanza objects should be treated as True in boolean contexts.
Python 3.x version.
"""
return True
def __nonzero__(self):
"""
Stanza objects should be treated as True in boolean contexts.
Python 2.x version.
"""
return True
def __len__(self):
"""
Return the number of iterable substanzas contained in this stanza.
"""
return len(self.iterables)
def __iter__(self):
"""
Return an iterator object for iterating over the stanza's substanzas.
The iterator is the stanza object itself. Attempting to use two
iterators on the same stanza at the same time is discouraged.
"""
self._index = 0
return self
def __next__(self):
"""
Return the next iterable substanza.
"""
self._index += 1
if self._index > len(self.iterables):
self._index = 0
raise StopIteration
return self.iterables[self._index - 1]
def __copy__(self):
"""
Return a copy of the stanza object that does not share the same
underlying XML object.
"""
return self.__class__(xml=copy.deepcopy(self.xml), parent=self.parent)
def __str__(self, top_level_ns=True):
"""
Return a string serialization of the underlying XML object.
Arguments:
top_level_ns -- Display the top-most namespace.
Defaults to True.
"""
stanza_ns = '' if top_level_ns else self.namespace
return tostring(self.xml,
xmlns='',
stanza_ns=stanza_ns,
top_level=not top_level_ns)
def __repr__(self):
"""
Use the stanza's serialized XML as its representation.
"""
return self.__str__()
