XEP-0333: Add missing feature, and a send_marker method
This commit is contained in:
parent
11ac5867ff
commit
b3e2a8eb91
2 changed files with 39 additions and 5 deletions
|
@ -7,8 +7,9 @@
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import logging
|
import logging
|
||||||
|
from typing import Optional
|
||||||
|
|
||||||
from slixmpp import Message
|
from slixmpp import Message, JID
|
||||||
from slixmpp.plugins import BasePlugin
|
from slixmpp.plugins import BasePlugin
|
||||||
from slixmpp.xmlstream import register_stanza_plugin
|
from slixmpp.xmlstream import register_stanza_plugin
|
||||||
from slixmpp.xmlstream.handler import Callback
|
from slixmpp.xmlstream.handler import Callback
|
||||||
|
@ -22,6 +23,7 @@ class XEP_0333(BasePlugin):
|
||||||
name = 'xep_0333'
|
name = 'xep_0333'
|
||||||
description = 'XEP-0333: Chat Markers'
|
description = 'XEP-0333: Chat Markers'
|
||||||
stanza = stanza
|
stanza = stanza
|
||||||
|
dependencies = {'xep_0030'}
|
||||||
|
|
||||||
def plugin_init(self):
|
def plugin_init(self):
|
||||||
register_stanza_plugin(Message, Markable)
|
register_stanza_plugin(Message, Markable)
|
||||||
|
@ -42,6 +44,12 @@ class XEP_0333(BasePlugin):
|
||||||
StanzaPath('message/acknowledged'),
|
StanzaPath('message/acknowledged'),
|
||||||
self._handle_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):
|
def _handle_received(self, message):
|
||||||
self.xmpp.event('marker_received', message)
|
self.xmpp.event('marker_received', message)
|
||||||
self.xmpp.event('marker', message)
|
self.xmpp.event('marker', message)
|
||||||
|
@ -53,3 +61,24 @@ class XEP_0333(BasePlugin):
|
||||||
def _handle_acknowledged(self, message):
|
def _handle_acknowledged(self, message):
|
||||||
self.xmpp.event('marker_acknowledged', message)
|
self.xmpp.event('marker_acknowledged', message)
|
||||||
self.xmpp.event('marker', 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()
|
||||||
|
|
|
@ -8,25 +8,30 @@
|
||||||
|
|
||||||
from slixmpp.xmlstream import ElementBase
|
from slixmpp.xmlstream import ElementBase
|
||||||
|
|
||||||
|
NS ='urn:xmpp:chat-markers:0'
|
||||||
|
|
||||||
class Markable(ElementBase):
|
class Markable(ElementBase):
|
||||||
name = 'markable'
|
name = 'markable'
|
||||||
plugin_attrib = 'markable'
|
plugin_attrib = 'markable'
|
||||||
namespace = 'urn:xmpp:chat-markers:0'
|
namespace = NS
|
||||||
|
|
||||||
|
|
||||||
class Received(ElementBase):
|
class Received(ElementBase):
|
||||||
name = 'received'
|
name = 'received'
|
||||||
plugin_attrib = 'received'
|
plugin_attrib = 'received'
|
||||||
namespace = 'urn:xmpp:chat-markers:0'
|
namespace = NS
|
||||||
interfaces = {'id'}
|
interfaces = {'id'}
|
||||||
|
|
||||||
|
|
||||||
class Displayed(ElementBase):
|
class Displayed(ElementBase):
|
||||||
name = 'displayed'
|
name = 'displayed'
|
||||||
plugin_attrib = 'displayed'
|
plugin_attrib = 'displayed'
|
||||||
namespace = 'urn:xmpp:chat-markers:0'
|
namespace = NS
|
||||||
interfaces = {'id'}
|
interfaces = {'id'}
|
||||||
|
|
||||||
|
|
||||||
class Acknowledged(ElementBase):
|
class Acknowledged(ElementBase):
|
||||||
name = 'acknowledged'
|
name = 'acknowledged'
|
||||||
plugin_attrib = 'acknowledged'
|
plugin_attrib = 'acknowledged'
|
||||||
namespace = 'urn:xmpp:chat-markers:0'
|
namespace = NS
|
||||||
interfaces = {'id'}
|
interfaces = {'id'}
|
||||||
|
|
Loading…
Reference in a new issue