diff options
author | Florent Le Coz <louiz@louiz.org> | 2014-07-17 14:19:04 +0200 |
---|---|---|
committer | Florent Le Coz <louiz@louiz.org> | 2014-07-17 14:19:04 +0200 |
commit | 5ab77c745270d7d5c016c1dc7ef2a82533a4b16e (patch) | |
tree | 259377cc666f8b9c7954fc4e7b8f7a912bcfe101 /sleekxmpp/xmlstream/matcher | |
parent | e5582694c07236e6830c20361840360a1dde37f3 (diff) | |
download | slixmpp-5ab77c745270d7d5c016c1dc7ef2a82533a4b16e.tar.gz slixmpp-5ab77c745270d7d5c016c1dc7ef2a82533a4b16e.tar.bz2 slixmpp-5ab77c745270d7d5c016c1dc7ef2a82533a4b16e.tar.xz slixmpp-5ab77c745270d7d5c016c1dc7ef2a82533a4b16e.zip |
Rename to slixmpp
Diffstat (limited to 'sleekxmpp/xmlstream/matcher')
-rw-r--r-- | sleekxmpp/xmlstream/matcher/__init__.py | 17 | ||||
-rw-r--r-- | sleekxmpp/xmlstream/matcher/base.py | 31 | ||||
-rw-r--r-- | sleekxmpp/xmlstream/matcher/id.py | 29 | ||||
-rw-r--r-- | sleekxmpp/xmlstream/matcher/idsender.py | 47 | ||||
-rw-r--r-- | sleekxmpp/xmlstream/matcher/many.py | 40 | ||||
-rw-r--r-- | sleekxmpp/xmlstream/matcher/stanzapath.py | 43 | ||||
-rw-r--r-- | sleekxmpp/xmlstream/matcher/xmlmask.py | 117 | ||||
-rw-r--r-- | sleekxmpp/xmlstream/matcher/xpath.py | 59 |
8 files changed, 0 insertions, 383 deletions
diff --git a/sleekxmpp/xmlstream/matcher/__init__.py b/sleekxmpp/xmlstream/matcher/__init__.py deleted file mode 100644 index aa74c434..00000000 --- a/sleekxmpp/xmlstream/matcher/__init__.py +++ /dev/null @@ -1,17 +0,0 @@ -""" - SleekXMPP: The Sleek XMPP Library - Copyright (C) 2010 Nathanael C. Fritz - This file is part of SleekXMPP. - - See the file LICENSE for copying permission. -""" - -from sleekxmpp.xmlstream.matcher.id import MatcherId -from sleekxmpp.xmlstream.matcher.idsender import MatchIDSender -from sleekxmpp.xmlstream.matcher.many import MatchMany -from sleekxmpp.xmlstream.matcher.stanzapath import StanzaPath -from sleekxmpp.xmlstream.matcher.xmlmask import MatchXMLMask -from sleekxmpp.xmlstream.matcher.xpath import MatchXPath - -__all__ = ['MatcherId', 'MatchMany', 'StanzaPath', - 'MatchXMLMask', 'MatchXPath'] diff --git a/sleekxmpp/xmlstream/matcher/base.py b/sleekxmpp/xmlstream/matcher/base.py deleted file mode 100644 index 83c26688..00000000 --- a/sleekxmpp/xmlstream/matcher/base.py +++ /dev/null @@ -1,31 +0,0 @@ -# -*- coding: utf-8 -*- -""" - sleekxmpp.xmlstream.matcher.base - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - Part of SleekXMPP: The Sleek XMPP Library - - :copyright: (c) 2011 Nathanael C. Fritz - :license: MIT, see LICENSE for more details -""" - - -class MatcherBase(object): - - """ - Base class for stanza matchers. Stanza matchers are used to pick - stanzas out of the XML stream and pass them to the appropriate - stream handlers. - - :param criteria: Object to compare some aspect of a stanza against. - """ - - def __init__(self, criteria): - self._criteria = criteria - - def match(self, xml): - """Check if a stanza matches the stored criteria. - - Meant to be overridden. - """ - return False diff --git a/sleekxmpp/xmlstream/matcher/id.py b/sleekxmpp/xmlstream/matcher/id.py deleted file mode 100644 index 11ab70bb..00000000 --- a/sleekxmpp/xmlstream/matcher/id.py +++ /dev/null @@ -1,29 +0,0 @@ -# -*- coding: utf-8 -*- -""" - sleekxmpp.xmlstream.matcher.id - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - Part of SleekXMPP: The Sleek XMPP Library - - :copyright: (c) 2011 Nathanael C. Fritz - :license: MIT, see LICENSE for more details -""" - -from sleekxmpp.xmlstream.matcher.base import MatcherBase - - -class MatcherId(MatcherBase): - - """ - The ID matcher selects stanzas that have the same stanza 'id' - interface value as the desired ID. - """ - - def match(self, xml): - """Compare the given stanza's ``'id'`` attribute to the stored - ``id`` value. - - :param xml: The :class:`~sleekxmpp.xmlstream.stanzabase.ElementBase` - stanza to compare against. - """ - return xml['id'] == self._criteria diff --git a/sleekxmpp/xmlstream/matcher/idsender.py b/sleekxmpp/xmlstream/matcher/idsender.py deleted file mode 100644 index 5c2c1f51..00000000 --- a/sleekxmpp/xmlstream/matcher/idsender.py +++ /dev/null @@ -1,47 +0,0 @@ -# -*- coding: utf-8 -*- -""" - sleekxmpp.xmlstream.matcher.id - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - Part of SleekXMPP: The Sleek XMPP Library - - :copyright: (c) 2011 Nathanael C. Fritz - :license: MIT, see LICENSE for more details -""" - -from sleekxmpp.xmlstream.matcher.base import MatcherBase - - -class MatchIDSender(MatcherBase): - - """ - The IDSender matcher selects stanzas that have the same stanza 'id' - interface value as the desired ID, and that the 'from' value is one - of a set of approved entities that can respond to a request. - """ - - def match(self, xml): - """Compare the given stanza's ``'id'`` attribute to the stored - ``id`` value, and verify the sender's JID. - - :param xml: The :class:`~sleekxmpp.xmlstream.stanzabase.ElementBase` - stanza to compare against. - """ - - selfjid = self._criteria['self'] - peerjid = self._criteria['peer'] - - allowed = {} - allowed[''] = True - allowed[selfjid.bare] = True - allowed[selfjid.host] = True - allowed[peerjid.full] = True - allowed[peerjid.bare] = True - allowed[peerjid.host] = True - - _from = xml['from'] - - try: - return xml['id'] == self._criteria['id'] and allowed[_from] - except KeyError: - return False diff --git a/sleekxmpp/xmlstream/matcher/many.py b/sleekxmpp/xmlstream/matcher/many.py deleted file mode 100644 index f470ec9c..00000000 --- a/sleekxmpp/xmlstream/matcher/many.py +++ /dev/null @@ -1,40 +0,0 @@ -""" - SleekXMPP: The Sleek XMPP Library - Copyright (C) 2010 Nathanael C. Fritz - This file is part of SleekXMPP. - - See the file LICENSE for copying permission. -""" - -from sleekxmpp.xmlstream.matcher.base import MatcherBase - - -class MatchMany(MatcherBase): - - """ - The MatchMany matcher may compare a stanza against multiple - criteria. It is essentially an OR relation combining multiple - matchers. - - Each of the criteria must implement a match() method. - - Methods: - match -- Overrides MatcherBase.match. - """ - - def match(self, xml): - """ - Match a stanza against multiple criteria. The match is successful - if one of the criteria matches. - - Each of the criteria must implement a match() method. - - Overrides MatcherBase.match. - - Arguments: - xml -- The stanza object to compare against. - """ - for m in self._criteria: - if m.match(xml): - return True - return False diff --git a/sleekxmpp/xmlstream/matcher/stanzapath.py b/sleekxmpp/xmlstream/matcher/stanzapath.py deleted file mode 100644 index a4c0fda0..00000000 --- a/sleekxmpp/xmlstream/matcher/stanzapath.py +++ /dev/null @@ -1,43 +0,0 @@ -# -*- coding: utf-8 -*- -""" - sleekxmpp.xmlstream.matcher.stanzapath - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - Part of SleekXMPP: The Sleek XMPP Library - - :copyright: (c) 2011 Nathanael C. Fritz - :license: MIT, see LICENSE for more details -""" - -from sleekxmpp.xmlstream.matcher.base import MatcherBase -from sleekxmpp.xmlstream.stanzabase import fix_ns - - -class StanzaPath(MatcherBase): - - """ - The StanzaPath matcher selects stanzas that match a given "stanza path", - which is similar to a normal XPath except that it uses the interfaces and - plugins of the stanza instead of the actual, underlying XML. - - :param criteria: Object to compare some aspect of a stanza against. - """ - - def __init__(self, criteria): - self._criteria = fix_ns(criteria, split=True, - propagate_ns=False, - default_ns='jabber:client') - self._raw_criteria = criteria - - def match(self, stanza): - """ - Compare a stanza against a "stanza path". A stanza path is similar to - an XPath expression, but uses the stanza's interfaces and plugins - instead of the underlying XML. See the documentation for the stanza - :meth:`~sleekxmpp.xmlstream.stanzabase.ElementBase.match()` method - for more information. - - :param stanza: The :class:`~sleekxmpp.xmlstream.stanzabase.ElementBase` - stanza to compare against. - """ - return stanza.match(self._criteria) or stanza.match(self._raw_criteria) diff --git a/sleekxmpp/xmlstream/matcher/xmlmask.py b/sleekxmpp/xmlstream/matcher/xmlmask.py deleted file mode 100644 index 56f728e1..00000000 --- a/sleekxmpp/xmlstream/matcher/xmlmask.py +++ /dev/null @@ -1,117 +0,0 @@ -""" - SleekXMPP: The Sleek XMPP Library - Copyright (C) 2010 Nathanael C. Fritz - This file is part of SleekXMPP. - - See the file LICENSE for copying permission. -""" - -import logging - -from xml.parsers.expat import ExpatError - -from sleekxmpp.xmlstream.stanzabase import ET -from sleekxmpp.xmlstream.matcher.base import MatcherBase - - -log = logging.getLogger(__name__) - - -class MatchXMLMask(MatcherBase): - - """ - The XMLMask matcher selects stanzas whose XML matches a given - XML pattern, or mask. For example, message stanzas with body elements - could be matched using the mask: - - .. code-block:: xml - - <message xmlns="jabber:client"><body /></message> - - Use of XMLMask is discouraged, and - :class:`~sleekxmpp.xmlstream.matcher.xpath.MatchXPath` or - :class:`~sleekxmpp.xmlstream.matcher.stanzapath.StanzaPath` - should be used instead. - - :param criteria: Either an :class:`~xml.etree.ElementTree.Element` XML - object or XML string to use as a mask. - """ - - def __init__(self, criteria, default_ns='jabber:client'): - MatcherBase.__init__(self, criteria) - if isinstance(criteria, str): - self._criteria = ET.fromstring(self._criteria) - self.default_ns = default_ns - - def setDefaultNS(self, ns): - """Set the default namespace to use during comparisons. - - :param ns: The new namespace to use as the default. - """ - self.default_ns = ns - - def match(self, xml): - """Compare a stanza object or XML object against the stored XML mask. - - Overrides MatcherBase.match. - - :param xml: The stanza object or XML object to compare against. - """ - if hasattr(xml, 'xml'): - xml = xml.xml - return self._mask_cmp(xml, self._criteria, True) - - def _mask_cmp(self, source, mask, use_ns=False, default_ns='__no_ns__'): - """Compare an XML object against an XML mask. - - :param source: The :class:`~xml.etree.ElementTree.Element` XML object - to compare against the mask. - :param mask: The :class:`~xml.etree.ElementTree.Element` XML object - serving as the mask. - :param use_ns: Indicates if namespaces should be respected during - the comparison. - :default_ns: The default namespace to apply to elements that - do not have a specified namespace. - Defaults to ``"__no_ns__"``. - """ - if source is None: - # If the element was not found. May happend during recursive calls. - return False - - # Convert the mask to an XML object if it is a string. - if not hasattr(mask, 'attrib'): - try: - mask = ET.fromstring(mask) - except ExpatError: - log.warning("Expat error: %s\nIn parsing: %s", '', mask) - - mask_ns_tag = "{%s}%s" % (self.default_ns, mask.tag) - if source.tag not in [mask.tag, mask_ns_tag]: - return False - - # If the mask includes text, compare it. - if mask.text and source.text and \ - source.text.strip() != mask.text.strip(): - return False - - # Compare attributes. The stanza must include the attributes - # defined by the mask, but may include others. - for name, value in mask.attrib.items(): - if source.attrib.get(name, "__None__") != value: - return False - - # Recursively check subelements. - matched_elements = {} - for subelement in mask: - matched = False - for other in source.findall(subelement.tag): - matched_elements[other] = False - if self._mask_cmp(other, subelement, use_ns): - if not matched_elements.get(other, False): - matched_elements[other] = True - matched = True - if not matched: - return False - - # Everything matches. - return True diff --git a/sleekxmpp/xmlstream/matcher/xpath.py b/sleekxmpp/xmlstream/matcher/xpath.py deleted file mode 100644 index f3d28429..00000000 --- a/sleekxmpp/xmlstream/matcher/xpath.py +++ /dev/null @@ -1,59 +0,0 @@ -# -*- coding: utf-8 -*- -""" - sleekxmpp.xmlstream.matcher.xpath - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - Part of SleekXMPP: The Sleek XMPP Library - - :copyright: (c) 2011 Nathanael C. Fritz - :license: MIT, see LICENSE for more details -""" - -from sleekxmpp.xmlstream.stanzabase import ET, fix_ns -from sleekxmpp.xmlstream.matcher.base import MatcherBase - - -class MatchXPath(MatcherBase): - - """ - The XPath matcher selects stanzas whose XML contents matches a given - XPath expression. - - .. warning:: - - 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. - - If the value of :data:`IGNORE_NS` is set to ``True``, then XPath - expressions will be matched without using namespaces. - """ - - def __init__(self, criteria): - self._criteria = fix_ns(criteria) - - def match(self, xml): - """ - Compare a stanza's XML contents to an XPath expression. - - If the value of :data:`IGNORE_NS` is set to ``True``, then XPath - expressions will be matched without using namespaces. - - .. warning:: - - 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. - - :param xml: The :class:`~sleekxmpp.xmlstream.stanzabase.ElementBase` - stanza to compare against. - """ - if hasattr(xml, 'xml'): - xml = xml.xml - x = ET.Element('x') - x.append(xml) - - return x.find(self._criteria) is not None |