From a6ca6701a00337fa500340945d6e6065ba937b40 Mon Sep 17 00:00:00 2001
From: Lance Stout <lancestout@gmail.com>
Date: Tue, 25 Sep 2012 12:35:53 -0700
Subject: Add XEP-0308 Last Message Correction support

---
 setup.py                                 |  1 +
 sleekxmpp/plugins/__init__.py            |  1 +
 sleekxmpp/plugins/xep_0308/__init__.py   | 15 +++++++++
 sleekxmpp/plugins/xep_0308/correction.py | 52 ++++++++++++++++++++++++++++++++
 sleekxmpp/plugins/xep_0308/stanza.py     | 16 ++++++++++
 sleekxmpp/test/sleektest.py              |  5 +++
 6 files changed, 90 insertions(+)
 create mode 100644 sleekxmpp/plugins/xep_0308/__init__.py
 create mode 100644 sleekxmpp/plugins/xep_0308/correction.py
 create mode 100644 sleekxmpp/plugins/xep_0308/stanza.py

diff --git a/setup.py b/setup.py
index 4d97b90a..3ed1a3a9 100755
--- a/setup.py
+++ b/setup.py
@@ -104,6 +104,7 @@ packages     = [ 'sleekxmpp',
                  'sleekxmpp/plugins/xep_0279',
                  'sleekxmpp/plugins/xep_0280',
                  'sleekxmpp/plugins/xep_0297',
+                 'sleekxmpp/plugins/xep_0308',
                  'sleekxmpp/features',
                  'sleekxmpp/features/feature_mechanisms',
                  'sleekxmpp/features/feature_mechanisms/stanza',
diff --git a/sleekxmpp/plugins/__init__.py b/sleekxmpp/plugins/__init__.py
index 461d292d..66027fbf 100644
--- a/sleekxmpp/plugins/__init__.py
+++ b/sleekxmpp/plugins/__init__.py
@@ -71,4 +71,5 @@ __all__ = [
     'xep_0280',  # Message Carbons
     'xep_0297',  # Stanza Forwarding
     'xep_0302',  # XMPP Compliance Suites 2012
+    'xep_0308',  # Last Message Correction
 ]
diff --git a/sleekxmpp/plugins/xep_0308/__init__.py b/sleekxmpp/plugins/xep_0308/__init__.py
new file mode 100644
index 00000000..a6a100ee
--- /dev/null
+++ b/sleekxmpp/plugins/xep_0308/__init__.py
@@ -0,0 +1,15 @@
+"""
+    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.plugins.base import register_plugin
+
+from sleekxmpp.plugins.xep_0308.stanza import Replace
+from sleekxmpp.plugins.xep_0308.correction import XEP_0308
+
+
+register_plugin(XEP_0308)
diff --git a/sleekxmpp/plugins/xep_0308/correction.py b/sleekxmpp/plugins/xep_0308/correction.py
new file mode 100644
index 00000000..d32b4bc4
--- /dev/null
+++ b/sleekxmpp/plugins/xep_0308/correction.py
@@ -0,0 +1,52 @@
+"""
+    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
+"""
+
+import logging
+
+import sleekxmpp
+from sleekxmpp.stanza import Message
+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_0308 import stanza, Replace
+
+
+log = logging.getLogger(__name__)
+
+
+class XEP_0308(BasePlugin):
+
+    """
+    XEP-0308 Last Message Correction
+    """
+
+    name = 'xep_0308'
+    description = 'XEP-0308: Last Message Correction'
+    dependencies = set(['xep_0030'])
+    stanza = stanza
+
+    def plugin_init(self):
+        self.xmpp.register_handler(
+            Callback('Message Correction',
+                     StanzaPath('message/replace'),
+                     self._handle_correction))
+
+        register_stanza_plugin(Message, Replace)
+
+        self.xmpp.use_message_ids = True
+
+    def plugin_end(self):
+        self.xmpp.remove_handler('Message Correction')
+        self.xmpp.plugin['xep_0030'].del_feature(feature=Replace.namespace)
+
+    def session_bind(self, jid):
+        self.xmpp.plugin['xep_0030'].add_feature(Replace.namespace)
+
+    def _handle_correction(self, msg):
+        self.xmpp.event('message_correction', msg)
diff --git a/sleekxmpp/plugins/xep_0308/stanza.py b/sleekxmpp/plugins/xep_0308/stanza.py
new file mode 100644
index 00000000..8f88cbc0
--- /dev/null
+++ b/sleekxmpp/plugins/xep_0308/stanza.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 permissio
+"""
+
+from sleekxmpp.xmlstream import ElementBase
+
+
+class Replace(ElementBase):
+    name = 'replace'
+    namespace = 'urn:xmpp:message-correct:0'
+    plugin_attrib = 'replace'
+    interfaces = set(['id'])
diff --git a/sleekxmpp/test/sleektest.py b/sleekxmpp/test/sleektest.py
index 47af86cf..901c3a56 100644
--- a/sleekxmpp/test/sleektest.py
+++ b/sleekxmpp/test/sleektest.py
@@ -368,6 +368,11 @@ class SleekTest(unittest.TestCase):
         else:
             for plugin in plugins:
                 self.xmpp.register_plugin(plugin)
+
+        # Some plugins require messages to have ID values. Set
+        # this to True in tests related to those plugins.
+        self.xmpp.use_message_ids = False
+
         self.xmpp.process(threaded=True)
         if skip:
             if socket != 'live':
-- 
cgit v1.2.3