Add Attention (XEP-0224) support

4 files changed, 61 insertions, 0 deletions

diff --git a/nbxmpp/dispatcher.py b/nbxmpp/dispatcher.py
index dfae173..86ac7fe 100644
--- a/nbxmpp/dispatcher.py
+++ b/nbxmpp/dispatcher.py
@@ -75,6 +75,7 @@ from nbxmpp.modules.chat_markers import ChatMarkers
 from nbxmpp.modules.receipts import Receipts
 from nbxmpp.modules.oob import OOB
 from nbxmpp.modules.correction import Correction
+from nbxmpp.modules.attention import Attention
 from nbxmpp.modules.misc import unwrap_carbon
 from nbxmpp.modules.misc import unwrap_mam
 from nbxmpp.util import get_properties_struct
@@ -217,6 +218,7 @@ class XMPPDispatcher(PlugIn):
         self._modules['Receipts'] = Receipts(self._owner)
         self._modules['OOB'] = OOB(self._owner)
         self._modules['Correction'] = Correction(self._owner)
+        self._modules['Attention'] = Attention(self._owner)
 
         for instance in self._modules.values():
             for handler in instance.handlers:
diff --git a/nbxmpp/modules/attention.py b/nbxmpp/modules/attention.py
new file mode 100644
index 0000000..15a93ae
--- /dev/null
+++ b/nbxmpp/modules/attention.py
@@ -0,0 +1,51 @@
+# Copyright (C) 2018 Philipp Hörist <philipp AT hoerist.com>
+#
+# This file is part of nbxmpp.
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 3
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; If not, see <http://www.gnu.org/licenses/>.
+
+import logging
+
+from nbxmpp.protocol import NS_ATTENTION
+from nbxmpp.protocol import NS_DELAY2
+from nbxmpp.structs import StanzaHandler
+
+log = logging.getLogger('nbxmpp.m.attention')
+
+
+class Attention:
+    def __init__(self, client):
+        self._client = client
+        self.handlers = [
+            StanzaHandler(name='message',
+                          callback=self._process_message_attention,
+                          ns=NS_ATTENTION,
+                          priority=15),
+        ]
+
+    def _process_message_attention(self, _con, stanza, properties):
+        attention = stanza.getTag('attention', namespace=NS_ATTENTION)
+        if attention is None:
+            return
+
+        if properties.is_mam_message:
+            return
+
+        if properties.is_carbon_message and properties.carbon.is_sent:
+            return
+
+        if stanza.getTag('x', namespace=NS_DELAY2) is not None:
+            return
+
+        properties.attention = True
diff --git a/nbxmpp/protocol.py b/nbxmpp/protocol.py
index ccf1e78..7bad8c7 100644
--- a/nbxmpp/protocol.py
+++ b/nbxmpp/protocol.py
@@ -1372,6 +1372,9 @@ class Message(Protocol):
     def setCorrection(self, id_):
         self.setTag('replace', namespace=NS_CORRECT, attrs={'id': id_})
 
+    def setAttention(self):
+        self.setTag('attention', namespace=NS_ATTENTION)
+
 
 class Presence(Protocol):
 
diff --git a/nbxmpp/structs.py b/nbxmpp/structs.py
index 3476fe5..44317f5 100644
--- a/nbxmpp/structs.py
+++ b/nbxmpp/structs.py
@@ -551,6 +551,7 @@ class MessageProperties:
         self.receipt = None
         self.oob = None
         self.correction = None
+        self.attention = False
 
     @property
     def has_user_delay(self):
@@ -639,6 +640,10 @@ class MessageProperties:
     def is_correction(self):
         return self.correction is not None
 
+    @property
+    def has_attention(self):
+        return self.attention
+
 
 class IqProperties:
     def __init__(self):