2011-12-05 00:26:14 +00:00
|
|
|
# -*- coding: utf-8 -*-
|
2010-03-26 21:32:16 +00:00
|
|
|
"""
|
2011-12-05 00:26:14 +00:00
|
|
|
sleekxmpp.xmlstream.matcher.xpath
|
|
|
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
2010-03-26 21:32:16 +00:00
|
|
|
|
2011-12-05 00:26:14 +00:00
|
|
|
Part of SleekXMPP: The Sleek XMPP Library
|
|
|
|
|
|
|
|
|
|
:copyright: (c) 2011 Nathanael C. Fritz
|
|
|
|
|
:license: MIT, see LICENSE for more details
|
2010-03-26 21:32:16 +00:00
|
|
|
"""
|
2010-09-01 18:28:43 +00:00
|
|
|
|
2013-01-20 23:43:02 +00:00
|
|
|
from sleekxmpp.xmlstream.stanzabase import ET, fix_ns
|
2010-09-01 18:28:43 +00:00
|
|
|
from sleekxmpp.xmlstream.matcher.base import MatcherBase
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class MatchXPath(MatcherBase):
|
|
|
|
|
|
|
|
|
|
"""
|
|
|
|
|
The XPath matcher selects stanzas whose XML contents matches a given
|
|
|
|
|
XPath expression.
|
|
|
|
|
|
2011-12-05 00:26:14 +00:00
|
|
|
.. warning::
|
2010-09-01 18:28:43 +00:00
|
|
|
|
2011-12-05 00:26:14 +00:00
|
|
|
Using this matcher may not produce expected behavior when using
|
|
|
|
|
attribute selectors. For Python 2.6 and 3.1, the ElementTree
|
|
|
|
|
:meth:`~xml.etree.ElementTree.Element.find()` method does
|
|
|
|
|
not support the use of attribute selectors. If you need to
|
|
|
|
|
support Python 2.6 or 3.1, it might be more useful to use a
|
|
|
|
|
:class:`~sleekxmpp.xmlstream.matcher.stanzapath.StanzaPath` matcher.
|
2010-09-01 18:28:43 +00:00
|
|
|
|
2011-12-05 00:26:14 +00:00
|
|
|
If the value of :data:`IGNORE_NS` is set to ``True``, then XPath
|
|
|
|
|
expressions will be matched without using namespaces.
|
2010-09-01 18:28:43 +00:00
|
|
|
"""
|
|
|
|
|
|
2013-01-20 23:43:02 +00:00
|
|
|
def __init__(self, criteria):
|
|
|
|
|
self._criteria = fix_ns(criteria)
|
|
|
|
|
|
2010-09-01 18:28:43 +00:00
|
|
|
def match(self, xml):
|
|
|
|
|
"""
|
|
|
|
|
Compare a stanza's XML contents to an XPath expression.
|
|
|
|
|
|
2011-12-05 00:26:14 +00:00
|
|
|
If the value of :data:`IGNORE_NS` is set to ``True``, then XPath
|
|
|
|
|
expressions will be matched without using namespaces.
|
|
|
|
|
|
|
|
|
|
.. warning::
|
2010-09-01 18:28:43 +00:00
|
|
|
|
2011-12-05 00:26:14 +00:00
|
|
|
In Python 2.6 and 3.1 the ElementTree
|
|
|
|
|
:meth:`~xml.etree.ElementTree.Element.find()` method does not
|
|
|
|
|
support attribute selectors in the XPath expression.
|
2010-09-01 18:28:43 +00:00
|
|
|
|
2011-12-05 00:26:14 +00:00
|
|
|
:param xml: The :class:`~sleekxmpp.xmlstream.stanzabase.ElementBase`
|
|
|
|
|
stanza to compare against.
|
2010-09-01 18:28:43 +00:00
|
|
|
"""
|
|
|
|
|
if hasattr(xml, 'xml'):
|
|
|
|
|
xml = xml.xml
|
|
|
|
|
x = ET.Element('x')
|
|
|
|
|
x.append(xml)
|
|
|
|
|
|
2013-01-20 23:43:02 +00:00
|
|
|
return x.find(self._criteria) is not None
|
