Add support for XEP-0280 Message Carbons

4 files changed, 158 insertions, 0 deletions

diff --git a/sleekxmpp/plugins/__init__.py b/sleekxmpp/plugins/__init__.py
index f09a26f1..461d292d 100644
--- a/sleekxmpp/plugins/__init__.py
+++ b/sleekxmpp/plugins/__init__.py
@@ -68,6 +68,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()