xmpp-parsers: Implement XEP-0490: Message Displayed Synchronization

Emmanuel Gil Peyrot created 1 year ago

This XEP is used to synchronize where each client has stopped reading a
conversation, so that we can e.g. stop displaying a notification when
the user has read this particular message on a different device.

Change summary

parsers/ChangeLog                |  1 +
parsers/doap.xml                 |  8 ++++++++
parsers/src/lib.rs               |  3 +++
parsers/src/message_displayed.rs | 19 +++++++++++++++++++
parsers/src/ns.rs                |  3 +++
5 files changed, 34 insertions(+)

Detailed changes

parsers/ChangeLog

@@ -30,6 +30,7 @@ XXXX-YY-ZZ RELEASER <[e-mail]>
         - Extensible SASL Profile (XEP-0388)
         - SASL Channel-Binding Type Capability (XEP-0440)
         - Stream Limits Advertisement (XEP-0478)
+        - Message Displayed Synchronization (XEP-0490)
         - RFC 6120 stream errors
     * Improvements:
         - Add support for `<optional/> in XEP-0198 feature advertisment

parsers/doap.xml

@@ -674,6 +674,14 @@
             <xmpp:since>0.21.0</xmpp:since>
         </xmpp:SupportedXep>
     </implements>
+    <implements>
+        <xmpp:SupportedXep>
+            <xmpp:xep rdf:resource="https://xmpp.org/extensions/xep-0490.html"/>
+            <xmpp:status>complete</xmpp:status>
+            <xmpp:version>1.0.1</xmpp:version>
+            <xmpp:since>NEXT</xmpp:since>
+        </xmpp:SupportedXep>
+    </implements>
 
     <release>
         <Version>

parsers/src/lib.rs

@@ -290,3 +290,6 @@ pub mod stream_limits;
 
 /// XEP-0484: Fast Authentication Streamlining Tokens
 pub mod fast;
+
+/// XEP-0490: Message Displayed Synchronization
+pub mod message_displayed;

parsers/src/message_displayed.rs

@@ -0,0 +1,19 @@
+// Copyright (c) 2024 Emmanuel Gil Peyrot <[e-mail]>
+//
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+use xso::{AsXml, FromXml};
+
+use crate::ns;
+use crate::stanza_id::StanzaId;
+
+/// Mention that a particular message has been displayed by at least one client.
+#[derive(FromXml, AsXml, PartialEq, Debug, Clone)]
+#[xml(namespace = ns::MDS, name = "displayed")]
+pub struct Displayed {
+    /// Reference to the message having been displayed.
+    #[xml(child)]
+    pub stanza_id: StanzaId,
+}

parsers/src/ns.rs

@@ -308,6 +308,9 @@ pub const STREAM_LIMITS: &str = "urn:xmpp:stream-limits:0";
 /// XEP-0484: Fast Authentication Streamlining Tokens
 pub const FAST: &str = "urn:xmpp:fast:0";
 
+/// XEP-0490: Message Displayed Synchronization
+pub const MDS: &str = "urn:xmpp:mds:displayed:0";
+
 /// Alias for the main namespace of the stream, that is "jabber:client" when
 /// the component feature isn’t enabled.
 #[cfg(not(feature = "component"))]