Added XEP-0224 Attention plugin.

4 files changed, 124 insertions, 1 deletions

diff --git a/sleekxmpp/plugins/__init__.py b/sleekxmpp/plugins/__init__.py
index 5630c1d9..b48a4c03 100644
--- a/sleekxmpp/plugins/__init__.py
+++ b/sleekxmpp/plugins/__init__.py
@@ -8,4 +8,4 @@
 __all__ = ['xep_0004', 'xep_0009', 'xep_0012', 'xep_0030', 'xep_0033',
            'xep_0045', 'xep_0050', 'xep_0060', 'xep_0066', 'xep_0082',
            'xep_0085', 'xep_0086', 'xep_0092', 'xep_0128', 'xep_0199',
-           'xep_0202', 'xep_0203', 'gmail_notify']
+           'xep_0202', 'xep_0203', 'xep_0224', 'xep_0249', 'gmail_notify']
diff --git a/sleekxmpp/plugins/xep_0224/__init__.py b/sleekxmpp/plugins/xep_0224/__init__.py
new file mode 100644
index 00000000..62f5bf82
--- /dev/null
+++ b/sleekxmpp/plugins/xep_0224/__init__.py
@@ -0,0 +1,11 @@
+"""
+    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 permission.
+"""
+
+from sleekxmpp.plugins.xep_0224 import stanza
+from sleekxmpp.plugins.xep_0224.stanza import Attention
+from sleekxmpp.plugins.xep_0224.attention import xep_0224
diff --git a/sleekxmpp/plugins/xep_0224/attention.py b/sleekxmpp/plugins/xep_0224/attention.py
new file mode 100644
index 00000000..41d7a0f1
--- /dev/null
+++ b/sleekxmpp/plugins/xep_0224/attention.py
@@ -0,0 +1,72 @@
+"""
+    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 permission.
+"""
+
+import logging
+
+from sleekxmpp.stanza import Message
+from sleekxmpp.xmlstream import register_stanza_plugin
+from sleekxmpp.xmlstream.handler import Callback
+from sleekxmpp.xmlstream.matcher import StanzaPath
+from sleekxmpp.plugins.base import base_plugin
+from sleekxmpp.plugins.xep_0224 import stanza
+
+
+log = logging.getLogger(__name__)
+
+
+class xep_0224(base_plugin):
+
+    """
+    XEP-0224: Attention
+    """
+
+    def plugin_init(self):
+        """Start the XEP-0224 plugin."""
+        self.xep = '0224'
+        self.description = 'Attention'
+        self.stanza = stanza
+
+        register_stanza_plugin(Message, stanza.Attention)
+
+        self.xmpp.register_handler(
+                Callback('Attention',
+                    StanzaPath('message/attention'),
+                    self._handle_attention))
+
+    def post_init(self):
+        """Handle cross-plugin dependencies."""
+        base_plugin.post_init(self)
+        self.xmpp['xep_0030'].add_feature(stanza.Attention.namespace)
+
+    def request_attention(self, to, mfrom=None, mbody=''):
+        """
+        Send an attention message with an optional body.
+
+        Arguments:
+            to    -- The attention request recipient's JID.
+            mfrom -- Optionally specify the sender of the attention request.
+            mbody -- An optional message body to include in the request.
+        """
+        m = self.xmpp.Message()
+        m['to'] = to
+        m['type'] = 'headline'
+        m['attention'] = True
+        if mfrom:
+            m['from'] = mfrom
+        m['body'] = mbody
+        m.send()
+
+    def _handle_attention(self, msg):
+        """
+        Raise an event after receiving a message with an attention request.
+
+        Arguments:
+            msg -- A message stanza with an attention element.
+        """
+        log.debug("Received attention request from: %s" % msg['from'])
+        self.xmpp.event('attention', msg)
diff --git a/sleekxmpp/plugins/xep_0224/stanza.py b/sleekxmpp/plugins/xep_0224/stanza.py
new file mode 100644
index 00000000..f15172d9
--- /dev/null
+++ b/sleekxmpp/plugins/xep_0224/stanza.py
@@ -0,0 +1,40 @@
+"""
+    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 permission.
+"""
+
+from sleekxmpp.xmlstream import ElementBase, ET
+
+
+class Attention(ElementBase):
+
+    """
+    """
+
+    name = 'attention'
+    namespace = 'urn:xmpp:attention:0'
+    plugin_attrib = 'attention'
+    interfaces = set(('attention',))
+    is_extension = True
+
+    def setup(self, xml):
+        return True
+
+    def set_attention(self, value):
+        if value:
+            xml = ET.Element(self.tag_name())
+            self.parent().xml.append(xml)
+        else:
+            self.del_attention()
+
+    def get_attention(self):
+        xml = self.parent().xml.find(self.tag_name())
+        return xml is not None
+
+    def del_attention(self):
+        xml = self.parent().xml.find(self.tag_name())
+        if xml is not None:
+            self.parent().xml.remove(xml)