summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--itests/test_chatmarkers.py27
-rw-r--r--slixmpp/plugins/xep_0333/__init__.py2
-rw-r--r--slixmpp/plugins/xep_0333/markers.py (renamed from slixmpp/plugins/xep_0333/hints.py)31
-rw-r--r--slixmpp/plugins/xep_0333/stanza.py13
4 files changed, 67 insertions, 6 deletions
diff --git a/itests/test_chatmarkers.py b/itests/test_chatmarkers.py
new file mode 100644
index 00000000..f23833d8
--- /dev/null
+++ b/itests/test_chatmarkers.py
@@ -0,0 +1,27 @@
+import unittest
+from slixmpp.test.integration import SlixIntegration
+
+
+class TestMarkers(SlixIntegration):
+ async def asyncSetUp(self):
+ self.add_client(
+ self.envjid('CI_ACCOUNT1'),
+ self.envstr('CI_ACCOUNT1_PASSWORD'),
+ )
+ self.add_client(
+ self.envjid('CI_ACCOUNT2'),
+ self.envstr('CI_ACCOUNT2_PASSWORD'),
+ )
+ self.register_plugins(['xep_0333'])
+ await self.connect_clients()
+
+ async def test_send_marker(self):
+ """Send and receive a chat marker"""
+ self.clients[0]['xep_0333'].send_marker(
+ self.clients[1].boundjid.full,
+ 'toto',
+ 'displayed',
+ )
+ msg = await self.clients[1].wait_until('marker_displayed')
+
+suite = unittest.TestLoader().loadTestsFromTestCase(TestMarkers)
diff --git a/slixmpp/plugins/xep_0333/__init__.py b/slixmpp/plugins/xep_0333/__init__.py
index 472971d6..a50dbe2b 100644
--- a/slixmpp/plugins/xep_0333/__init__.py
+++ b/slixmpp/plugins/xep_0333/__init__.py
@@ -9,6 +9,6 @@
from slixmpp.plugins.base import register_plugin
from slixmpp.plugins.xep_0333.stanza import Markable, Received, Displayed, Acknowledged
-from slixmpp.plugins.xep_0333.hints import XEP_0333
+from slixmpp.plugins.xep_0333.markers import XEP_0333
register_plugin(XEP_0333)
diff --git a/slixmpp/plugins/xep_0333/hints.py b/slixmpp/plugins/xep_0333/markers.py
index 5a3d3f9a..b8a003df 100644
--- a/slixmpp/plugins/xep_0333/hints.py
+++ b/slixmpp/plugins/xep_0333/markers.py
@@ -7,8 +7,9 @@
"""
import logging
+from typing import Optional
-from slixmpp import Message
+from slixmpp import Message, JID
from slixmpp.plugins import BasePlugin
from slixmpp.xmlstream import register_stanza_plugin
from slixmpp.xmlstream.handler import Callback
@@ -22,6 +23,7 @@ class XEP_0333(BasePlugin):
name = 'xep_0333'
description = 'XEP-0333: Chat Markers'
stanza = stanza
+ dependencies = {'xep_0030'}
def plugin_init(self):
register_stanza_plugin(Message, Markable)
@@ -42,6 +44,12 @@ class XEP_0333(BasePlugin):
StanzaPath('message/acknowledged'),
self._handle_acknowledged))
+ def session_bind(self, jid):
+ self.xmpp.plugin['xep_0030'].add_feature(stanza.NS)
+
+ def plugin_end(self):
+ self.xmpp.plugin['xep_0030'].del_feature(feature=stanza.NS)
+
def _handle_received(self, message):
self.xmpp.event('marker_received', message)
self.xmpp.event('marker', message)
@@ -53,3 +61,24 @@ class XEP_0333(BasePlugin):
def _handle_acknowledged(self, message):
self.xmpp.event('marker_acknowledged', message)
self.xmpp.event('marker', message)
+
+ def send_marker(self, mto: JID, id: str, marker: str,
+ thread: Optional[str] = None, *,
+ mfrom: Optional[JID] = None):
+ """
+ Send a chat marker.
+
+ :param JID mto: recipient of the marker
+ :param str id: Identifier of the marked message
+ :param str marker: Marker to send (one of
+ displayed, retrieved, or acknowledged)
+ :param str thread: Message thread
+ :param str mfrom: Use a specific JID to send the message
+ """
+ if marker not in ('displayed', 'retrieved', 'acknowledged'):
+ raise ValueError('Invalid marker: %s' % marker)
+ msg = self.xmpp.make_message(mto=mto, mfrom=mfrom)
+ if thread:
+ msg['thread'] = thread
+ msg[marker]['id'] = id
+ msg.send()
diff --git a/slixmpp/plugins/xep_0333/stanza.py b/slixmpp/plugins/xep_0333/stanza.py
index 42cfc21a..77cd47a4 100644
--- a/slixmpp/plugins/xep_0333/stanza.py
+++ b/slixmpp/plugins/xep_0333/stanza.py
@@ -8,25 +8,30 @@
from slixmpp.xmlstream import ElementBase
+NS ='urn:xmpp:chat-markers:0'
+
class Markable(ElementBase):
name = 'markable'
plugin_attrib = 'markable'
- namespace = 'urn:xmpp:chat-markers:0'
+ namespace = NS
+
class Received(ElementBase):
name = 'received'
plugin_attrib = 'received'
- namespace = 'urn:xmpp:chat-markers:0'
+ namespace = NS
interfaces = {'id'}
+
class Displayed(ElementBase):
name = 'displayed'
plugin_attrib = 'displayed'
- namespace = 'urn:xmpp:chat-markers:0'
+ namespace = NS
interfaces = {'id'}
+
class Acknowledged(ElementBase):
name = 'acknowledged'
plugin_attrib = 'acknowledged'
- namespace = 'urn:xmpp:chat-markers:0'
+ namespace = NS
interfaces = {'id'}