summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLance Stout <lancestout@gmail.com>2012-09-25 02:45:48 -0700
committerLance Stout <lancestout@gmail.com>2012-09-25 02:45:48 -0700
commit73ce9a5eccb5fea6f9a6dd72410cdada2a43347f (patch)
tree8589f9f5e8c0730152779fc57c6a7d178a1cfb3b
parentd385b9e708e9e8904ed9a19ac01096c50d521eff (diff)
parent671f680bb39f366ad13bf937c7b611f667343314 (diff)
downloadslixmpp-73ce9a5eccb5fea6f9a6dd72410cdada2a43347f.tar.gz
slixmpp-73ce9a5eccb5fea6f9a6dd72410cdada2a43347f.tar.bz2
slixmpp-73ce9a5eccb5fea6f9a6dd72410cdada2a43347f.tar.xz
slixmpp-73ce9a5eccb5fea6f9a6dd72410cdada2a43347f.zip
Merge branch 'master' into develop
-rwxr-xr-xsetup.py2
-rw-r--r--sleekxmpp/plugins/__init__.py2
-rw-r--r--sleekxmpp/plugins/xep_0280/__init__.py17
-rw-r--r--sleekxmpp/plugins/xep_0280/carbons.py76
-rw-r--r--sleekxmpp/plugins/xep_0280/stanza.py64
-rw-r--r--sleekxmpp/plugins/xep_0297/__init__.py16
-rw-r--r--sleekxmpp/plugins/xep_0297/forwarded.py59
-rw-r--r--sleekxmpp/plugins/xep_0297/stanza.py34
-rw-r--r--sleekxmpp/xmlstream/stanzabase.py26
-rw-r--r--sleekxmpp/xmlstream/tostring.py17
-rw-r--r--sleekxmpp/xmlstream/xmlstream.py4
-rw-r--r--tests/test_tostring.py13
12 files changed, 289 insertions, 41 deletions
diff --git a/setup.py b/setup.py
index b5c8d340..d0845e34 100755
--- a/setup.py
+++ b/setup.py
@@ -103,6 +103,8 @@ packages = [ 'sleekxmpp',
'sleekxmpp/plugins/xep_0249',
'sleekxmpp/plugins/xep_0258',
'sleekxmpp/plugins/xep_0279',
+ 'sleekxmpp/plugins/xep_0280',
+ 'sleekxmpp/plugins/xep_0297',
'sleekxmpp/features',
'sleekxmpp/features/feature_mechanisms',
'sleekxmpp/features/feature_mechanisms/stanza',
diff --git a/sleekxmpp/plugins/__init__.py b/sleekxmpp/plugins/__init__.py
index c950e943..18b618ac 100644
--- a/sleekxmpp/plugins/__init__.py
+++ b/sleekxmpp/plugins/__init__.py
@@ -69,5 +69,7 @@ __all__ = [
'xep_0258', # Security Labels in XMPP
'xep_0270', # XMPP Compliance Suites 2010
'xep_0279', # Server IP Check
+ 'xep_0280', # Message Carbons
+ 'xep_0297', # Stanza Forwarding
'xep_0302', # XMPP Compliance Suites 2012
]
diff --git a/sleekxmpp/plugins/xep_0280/__init__.py b/sleekxmpp/plugins/xep_0280/__init__.py
new file mode 100644
index 00000000..8ed65346
--- /dev/null
+++ b/sleekxmpp/plugins/xep_0280/__init__.py
@@ -0,0 +1,17 @@
+"""
+ SleekXMPP: The Sleek XMPP Library
+ Copyright (C) 2011 Nathanael C. Fritz, Lance J.T. Stout
+ This file is part of SleekXMPP.
+
+ See the file LICENSE for copying permissio
+"""
+
+from sleekxmpp.plugins.base import register_plugin
+
+from sleekxmpp.plugins.xep_0280.stanza import ReceivedCarbon, SentCarbon
+from sleekxmpp.plugins.xep_0280.stanza import PrivateCarbon
+from sleekxmpp.plugins.xep_0280.stanza import CarbonEnable, CarbonDisable
+from sleekxmpp.plugins.xep_0280.carbons import XEP_0280
+
+
+register_plugin(XEP_0280)
diff --git a/sleekxmpp/plugins/xep_0280/carbons.py b/sleekxmpp/plugins/xep_0280/carbons.py
new file mode 100644
index 00000000..7eec7acd
--- /dev/null
+++ b/sleekxmpp/plugins/xep_0280/carbons.py
@@ -0,0 +1,76 @@
+"""
+ SleekXMPP: The Sleek XMPP Library
+ Copyright (C) 2011 Nathanael C. Fritz, Lance J.T. Stout
+ This file is part of SleekXMPP.
+
+ See the file LICENSE for copying permissio
+"""
+
+import logging
+
+import sleekxmpp
+from sleekxmpp.stanza import Message, Iq
+from sleekxmpp.xmlstream.handler import Callback
+from sleekxmpp.xmlstream.matcher import StanzaPath
+from sleekxmpp.xmlstream import register_stanza_plugin
+from sleekxmpp.plugins import BasePlugin
+from sleekxmpp.plugins.xep_0280 import stanza
+
+
+log = logging.getLogger(__name__)
+
+
+class XEP_0280(BasePlugin):
+
+ """
+ XEP-0280 Message Carbons
+ """
+
+ name = 'xep_0280'
+ description = 'XEP-0280: Message Carbons'
+ dependencies = set(['xep_0030', 'xep_0297'])
+ stanza = stanza
+
+ def plugin_init(self):
+ self.xmpp.register_handler(
+ Callback('Carbon Received',
+ StanzaPath('message/carbon_received'),
+ self._handle_carbon_received))
+ self.xmpp.register_handler(
+ Callback('Carbon Sent',
+ StanzaPath('message/carbon_sent'),
+ self._handle_carbon_sent))
+
+ register_stanza_plugin(Message, stanza.ReceivedCarbon)
+ register_stanza_plugin(Message, stanza.SentCarbon)
+ register_stanza_plugin(Message, stanza.PrivateCarbon)
+ register_stanza_plugin(Iq, stanza.CarbonEnable)
+ register_stanza_plugin(Iq, stanza.CarbonDisable)
+
+ def plugin_end(self):
+ self.xmpp.remove_handler('Carbon Received')
+ self.xmpp.remove_handler('Carbon Sent')
+ self.xmpp.plugin['xep_0030'].del_feature(feature='urn:xmpp:carbons:1')
+
+ def session_bind(self, jid):
+ self.xmpp.plugin['xep_0030'].add_feature('urn:xmpp:carbons:1')
+
+ def _handle_carbon_received(self, msg):
+ self.xmpp.event('carbon_received', msg)
+
+ def _handle_carbon_sent(self, msg):
+ self.xmpp.event('carbon_sent', msg)
+
+ def enable(self, ifrom=None, block=True, timeout=None, callback=None):
+ iq = self.xmpp.Iq()
+ iq['type'] = 'set'
+ iq['from'] = ifrom
+ iq.enable('carbon_enable')
+ return iq.send(block=block, timeout=timeout, callback=callback)
+
+ def disable(self, ifrom=None, block=True, timeout=None, callback=None):
+ iq = self.xmpp.Iq()
+ iq['type'] = 'set'
+ iq['from'] = ifrom
+ iq.enable('carbon_disable')
+ return iq.send(block=block, timeout=timeout, callback=callback)
diff --git a/sleekxmpp/plugins/xep_0280/stanza.py b/sleekxmpp/plugins/xep_0280/stanza.py
new file mode 100644
index 00000000..94b37823
--- /dev/null
+++ b/sleekxmpp/plugins/xep_0280/stanza.py
@@ -0,0 +1,64 @@
+"""
+ SleekXMPP: The Sleek XMPP Library
+ Copyright (C) 2012 Nathanael C. Fritz, Lance J.T. Stout
+ This file is part of SleekXMPP.
+
+ See the file LICENSE for copying permissio
+"""
+
+from sleekxmpp.xmlstream import ElementBase
+
+
+class ReceivedCarbon(ElementBase):
+ name = 'received'
+ namespace = 'urn:xmpp:carbons:1'
+ plugin_attrib = 'carbon_received'
+ interfaces = set(['carbon_received'])
+ is_extension = True
+
+ def get_carbon_received(self):
+ return self.parent()['forwarded']['stanza']
+
+ def del_carbon_received(self):
+ del self.parent()['forwarded']['stanza']
+
+ def set_carbon_received(self, stanza):
+ self.parent()['forwarded']['stanza'] = stanza
+
+
+class SentCarbon(ElementBase):
+ name = 'sent'
+ namespace = 'urn:xmpp:carbons:1'
+ plugin_attrib = 'carbon_sent'
+ interfaces = set(['carbon_sent'])
+ is_extension = True
+
+ def get_carbon_sent(self):
+ return self.parent()['forwarded']['stanza']
+
+ def del_carbon_sent(self):
+ del self.parent()['forwarded']['stanza']
+
+ def set_carbon_sent(self, stanza):
+ self.parent()['forwarded']['stanza'] = stanza
+
+
+class PrivateCarbon(ElementBase):
+ name = 'private'
+ namespace = 'urn:xmpp:carbons:1'
+ plugin_attrib = 'carbon_private'
+ interfaces = set()
+
+
+class CarbonEnable(ElementBase):
+ name = 'enable'
+ namespace = 'urn:xmpp:carbons:1'
+ plugin_attrib = 'carbon_enable'
+ interfaces = set()
+
+
+class CarbonDisable(ElementBase):
+ name = 'disable'
+ namespace = 'urn:xmpp:carbons:1'
+ plugin_attrib = 'carbon_disable'
+ interfaces = set()
diff --git a/sleekxmpp/plugins/xep_0297/__init__.py b/sleekxmpp/plugins/xep_0297/__init__.py
new file mode 100644
index 00000000..551d9420
--- /dev/null
+++ b/sleekxmpp/plugins/xep_0297/__init__.py
@@ -0,0 +1,16 @@
+"""
+ SleekXMPP: The Sleek XMPP Library
+ Copyright (C) 2012 Nathanael C. Fritz, Lance J.T. Stout
+ This file is part of SleekXMPP.
+
+ See the file LICENSE for copying permission.
+"""
+
+from sleekxmpp.plugins.base import register_plugin
+
+from sleekxmpp.plugins.xep_0297 import stanza
+from sleekxmpp.plugins.xep_0297.stanza import Forwarded
+from sleekxmpp.plugins.xep_0297.forwarded import XEP_0297
+
+
+register_plugin(XEP_0297)
diff --git a/sleekxmpp/plugins/xep_0297/forwarded.py b/sleekxmpp/plugins/xep_0297/forwarded.py
new file mode 100644
index 00000000..7876967c
--- /dev/null
+++ b/sleekxmpp/plugins/xep_0297/forwarded.py
@@ -0,0 +1,59 @@
+"""
+ SleekXMPP: The Sleek XMPP Library
+ Copyright (C) 2012 Nathanael C. Fritz, Lance J.T. Stout
+ This file is part of SleekXMPP.
+
+ See the file LICENSE for copying permission.
+"""
+
+
+import logging
+
+from sleekxmpp import Iq, Message, Presence
+from sleekxmpp.plugins import BasePlugin
+from sleekxmpp.xmlstream import register_stanza_plugin
+from sleekxmpp.xmlstream.handler import Callback
+from sleekxmpp.xmlstream.matcher import StanzaPath
+from sleekxmpp.plugins.xep_0297 import stanza, Forwarded
+
+
+class XEP_0297(BasePlugin):
+
+ name = 'xep_0297'
+ description = 'XEP-0297: Stanza Forwarding'
+ dependencies = set(['xep_0030', 'xep_0203'])
+ stanza = stanza
+
+ def plugin_init(self):
+ register_stanza_plugin(Message, Forwarded)
+ register_stanza_plugin(Forwarded, Message)
+ register_stanza_plugin(Forwarded, Presence)
+ register_stanza_plugin(Forwarded, Iq)
+ register_stanza_plugin(Forwarded, self.xmpp['xep_0203'].stanza.Delay)
+
+ self.xmpp.register_handler(
+ Callback('Forwarded Stanza',
+ StanzaPath('message/forwarded'),
+ self._handle_forwarded))
+
+ def session_bind(self, jid):
+ self.xmpp['xep_0030'].add_feature('urn:xmpp:forward:0')
+
+ def plugin_end(self):
+ self.xmpp['xep_0030'].del_feature(feature='urn:xmpp:forward:0')
+ self.xmpp.remove_handler('Forwarded Stanza')
+
+ def forward(self, stanza=None, mto=None, mbody=None, mfrom=None, delay=None):
+ stanza.stream = None
+
+ msg = self.xmpp.Message()
+ msg['to'] = mto
+ msg['from'] = mfrom
+ msg['body'] = mbody
+ msg['forwarded']['stanza'] = stanza
+ if delay is not None:
+ msg['forwarded']['delay']['stamp'] = delay
+ msg.send()
+
+ def _handle_forwarded(self, msg):
+ self.xmpp.event('forwarded_stanza', msg)
diff --git a/sleekxmpp/plugins/xep_0297/stanza.py b/sleekxmpp/plugins/xep_0297/stanza.py
new file mode 100644
index 00000000..1cf02f74
--- /dev/null
+++ b/sleekxmpp/plugins/xep_0297/stanza.py
@@ -0,0 +1,34 @@
+"""
+ SleekXMPP: The Sleek XMPP Library
+ Copyright (C) 2012 Nathanael C. Fritz, Lance J.T. Stout
+ This file is part of SleekXMPP.
+
+ See the file LICENSE for copying permission.
+"""
+
+from sleekxmpp.xmlstream import ElementBase
+
+
+class Forwarded(ElementBase):
+ name = 'forwarded'
+ namespace = 'urn:xmpp:forward:0'
+ plugin_attrib = 'forwarded'
+ interfaces = set(['stanza'])
+
+ def get_stanza(self):
+ if self.xml.find('{jabber:client}message') is not None:
+ return self['message']
+ elif self.xml.find('{jabber:client}presence') is not None:
+ return self['presence']
+ elif self.xml.find('{jabber:client}iq') is not None:
+ return self['iq']
+ return ''
+
+ def set_stanza(self, value):
+ self.del_stanza()
+ self.append(value)
+
+ def del_stanza(self):
+ del self['message']
+ del self['presence']
+ del self['iq']
diff --git a/sleekxmpp/xmlstream/stanzabase.py b/sleekxmpp/xmlstream/stanzabase.py
index abe0abdc..4f58953b 100644
--- a/sleekxmpp/xmlstream/stanzabase.py
+++ b/sleekxmpp/xmlstream/stanzabase.py
@@ -488,7 +488,7 @@ class ElementBase(object):
"""
return self.init_plugin(attrib, lang)
- def _get_plugin(self, name, lang=None):
+ def _get_plugin(self, name, lang=None, check=False):
if lang is None:
lang = self.get_lang()
@@ -501,12 +501,12 @@ class ElementBase(object):
if (name, None) in self.plugins:
return self.plugins[(name, None)]
else:
- return self.init_plugin(name, lang)
+ return None if check else self.init_plugin(name, lang)
else:
if (name, lang) in self.plugins:
return self.plugins[(name, lang)]
else:
- return self.init_plugin(name, lang)
+ return None if check else self.init_plugin(name, lang)
def init_plugin(self, attrib, lang=None, existing_xml=None, reuse=True):
"""Enable and initialize a stanza plugin.
@@ -525,13 +525,6 @@ class ElementBase(object):
if reuse and (attrib, lang) in self.plugins:
return self.plugins[(attrib, lang)]
- if existing_xml is None:
- existing_xml = self.xml.find(plugin_class.tag_name())
-
- if existing_xml is not None:
- if existing_xml.attrib.get('{%s}lang' % XML_NS, default_lang) != lang:
- existing_xml = None
-
plugin = plugin_class(parent=self, xml=existing_xml)
if plugin.is_extension:
@@ -862,7 +855,7 @@ class ElementBase(object):
else:
self._del_attr(attrib)
elif attrib in self.plugin_attrib_map:
- plugin = self._get_plugin(attrib, lang)
+ plugin = self._get_plugin(attrib, lang, check=True)
if not plugin:
return self
if plugin.is_extension:
@@ -1400,10 +1393,8 @@ class ElementBase(object):
: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)
+ top_level=True)
def __repr__(self):
"""Use the stanza's serialized XML as its representation."""
@@ -1592,11 +1583,10 @@ class StanzaBase(ElementBase):
:param bool top_level_ns: Display the top-most namespace.
Defaults to ``False``.
"""
- stanza_ns = '' if top_level_ns else self.namespace
- return tostring(self.xml, xmlns='',
- stanza_ns=stanza_ns,
+ xmlns = self.stream.default_ns if self.stream else ''
+ return tostring(self.xml, xmlns=xmlns,
stream=self.stream,
- top_level=not top_level_ns)
+ top_level=(self.stream is None))
#: A JSON/dictionary version of the XML content exposed through
diff --git a/sleekxmpp/xmlstream/tostring.py b/sleekxmpp/xmlstream/tostring.py
index f22e7770..0b73d8dc 100644
--- a/sleekxmpp/xmlstream/tostring.py
+++ b/sleekxmpp/xmlstream/tostring.py
@@ -24,19 +24,18 @@ if sys.version_info < (3, 0):
XML_NS = 'http://www.w3.org/XML/1998/namespace'
-def tostring(xml=None, xmlns='', stanza_ns='', stream=None,
+def tostring(xml=None, xmlns='', stream=None,
outbuffer='', top_level=False, open_only=False):
"""Serialize an XML object to a Unicode string.
- If namespaces are provided using ``xmlns`` or ``stanza_ns``, then
- elements that use those namespaces will not include the xmlns attribute
- in the output.
+ If an outer xmlns is provided using ``xmlns``, then the current element's
+ namespace will not be included if it matches the outer namespace. An
+ exception is made for elements that have an attached stream, and appear
+ at the stream root.
:param XML xml: The XML object to serialize.
:param string xmlns: Optional namespace of an element wrapping the XML
object.
- :param string stanza_ns: The namespace of the stanza object that contains
- the XML object.
:param stream: The XML stream that generated the XML object.
:param string outbuffer: Optional buffer for storing serializations
during recursive calls.
@@ -71,8 +70,8 @@ def tostring(xml=None, xmlns='', stanza_ns='', stream=None,
# Output the tag name and derived namespace of the element.
namespace = ''
- if top_level and tag_xmlns not in ['', default_ns, stream_ns] or \
- tag_xmlns not in ['', xmlns, stanza_ns, stream_ns]:
+ if top_level and tag_xmlns not in [default_ns, xmlns, stream_ns] \
+ or not top_level and tag_xmlns != xmlns:
namespace = ' xmlns="%s"' % tag_xmlns
if stream and tag_xmlns in stream.namespace_map:
mapped_namespace = stream.namespace_map[tag_xmlns]
@@ -110,7 +109,7 @@ def tostring(xml=None, xmlns='', stanza_ns='', stream=None,
output.append(escape(xml.text, use_cdata))
if len(xml):
for child in xml:
- output.append(tostring(child, tag_xmlns, stanza_ns, stream))
+ output.append(tostring(child, tag_xmlns, stream))
output.append("</%s>" % tag_name)
elif xml.text:
# If we only have text content.
diff --git a/sleekxmpp/xmlstream/xmlstream.py b/sleekxmpp/xmlstream/xmlstream.py
index a58b63d4..dff32461 100644
--- a/sleekxmpp/xmlstream/xmlstream.py
+++ b/sleekxmpp/xmlstream/xmlstream.py
@@ -1244,7 +1244,9 @@ class XMLStream(object):
data = filter(data)
if data is None:
return
- str_data = str(data)
+ str_data = tostring(data.xml, xmlns=self.default_ns,
+ stream=self,
+ top_level=True)
self.send_raw(str_data, now)
else:
self.send_raw(data, now)
diff --git a/tests/test_tostring.py b/tests/test_tostring.py
index cd50a7c1..8c04f00c 100644
--- a/tests/test_tostring.py
+++ b/tests/test_tostring.py
@@ -85,19 +85,6 @@ class TestToString(SleekTest):
original='<a>foo <b>bar</b> baz</a>',
message='Element tail content is incorrect.')
-
- def testStanzaNs(self):
- """
- Test using the stanza_ns tostring parameter, which will prevent
- adding an xmlns attribute to the serialized element if the
- element's namespace is the same.
- """
- self.tryTostring(
- original='<bar xmlns="foo" />',
- expected='<bar />',
- message="The stanza_ns parameter was not used properly.",
- stanza_ns='foo')
-
def testStanzaStr(self):
"""
Test that stanza objects are serialized properly.