xep-0490.xml

<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE xep SYSTEM 'xep.dtd' [
  <!ENTITY % ents SYSTEM 'xep.ent'>
%ents;
]>
<?xml-stylesheet type='text/xsl' href='xep.xsl'?>
<xep>
<header>
  <title>Message Displayed Synchronization</title>
  <abstract>This specification allows multiple clients of the same user to synchronize the displayed state of their chats.</abstract>
  &LEGALNOTICE;
  <number>0490</number>
  <status>Draft</status>
  <lastcall>2024-10-31</lastcall>
  <type>Standards Track</type>
  <sig>Standards</sig>
  <approver>Council</approver>
  <dependencies>
    <spec>XMPP Core</spec>
    <spec>XEP-0001</spec>
    <spec>XEP-0163</spec>
  </dependencies>
  <supersedes/>
  <supersededby/>
  <shortname>mds</shortname>
  <author>
    <firstname>Daniel</firstname>
    <surname>Gultsch</surname>
    <email>daniel@gultsch.de</email>
    <jid>daniel@gultsch.de</jid>
  </author>
  <revision>
    <version>1.0.1</version>
    <date>2024-11-20</date>
    <initials>egp</initials>
    <remark>
      <ul>
        <li>Fix some examples, and their indentation.</li>
        <li>Add the XML Schema.</li>
      </ul>
    </remark>
  </revision>
  <revision>
    <version>1.0.0</version>
    <date>2024-11-06</date>
    <initials>XEP Editor (dg)</initials>
    <remark>Accept as Stable as per Council Vote from 2024-11-05.</remark>
  </revision>
  <revision>
    <version>0.1.0</version>
    <date>2024-03-26</date>
    <initials>XEP Editor: dg</initials>
    <remark>
      <ul>
        <li>Promoted to Experimental</li>
      </ul>
    </remark>
  </revision>
  <revision>
    <version>0.0.3</version>
    <date>2024-04-26</date>
    <initials>dg</initials>
    <remark>
      <p>Split Business Rules into Server and Client sections.</p>
    </remark>
  </revision>
  <revision>
    <version>0.0.2</version>
    <date>2024-03-14</date>
    <initials>dg</initials>
    <remark><p>Add Accessibility, Privacy and Design Considerations</p></remark>
  </revision>
  <revision>
    <version>0.0.1</version>
    <date>2024-02-21</date>
    <initials>dg</initials>
    <remark><p>First draft.</p></remark>
  </revision>
</header>
<section1 topic='Introduction' anchor='intro'>
  <p>In multi-device environments marking a chat as <em>displayed</em> on one device should mark that chat as <em>displayed</em> on all devices. Historically carbon copies (&xep0280;) of the &lt;displayed/> element of Displayed Markers (&xep0333;) have been used to achieve this effect. However this approach has a couple of downsides that this specification is trying eliminate:</p>
  <ul>
    <li>The contact has to request Displayed Markers by tagging a message with &lt;markable/>.</li>
    <li>Displayed Markers let the contact know that a device has displayed the message. This might not always be advisable when synchronization across multiple devices of the same user is the desired outcome.</li>
    <li>When used in large group chats Displayed Markers can create a lot of unwanted traffic.</li>
  </ul>
  <p>This specification isolates the task of multi-device synchronization from providing information to the contact, while borrowing some of the semantics of Displayed Markers such as <em>displayed</em> refering to all messages up to this point.</p>
</section1>
<section1 topic='Requirements' anchor='reqs'>
  <ul>
    <li>Basic functionality should only have minimal server requirements (&xep0163; and &xep0223;).</li>
    <li>Rely on server-injected &lt;stanza-id/> (see &xep0359;) to provide unique and stable IDs. While this is commonly done as part of &xep0313; it does not technically depend on the message being archived.</li>
    <li>Define the interaction with &xep0333;.</li>
    <li>Provide optional methods for traffic optimizations on supporting servers.</li>
    <li>Make no assertions on what constitutes an <em>open</em> or <em>archived</em> chat. This specification allows clients to state that they have displayed messages in a certain chat up to a certain point. It does not indicate that a chat is open or in case of group chats joined.</li>
  </ul>
</section1>
<section1 topic='Glossary' anchor='glossary'>
  <dl>
    <di>
      <dt>Displayed</dt>
      <dd>
          Colloquially this is also known as <em>read</em>. However since a common implementation of <em>read</em> is: "shown on screen, in full, in the context of the chat", and this gives no indication on whether the user has actually read a message, <em>displayed</em> was chosen as a more accurate terminology. A message might also be manually acknowledged by the user, for example via a <em>mark as read</em> action in a notification. Implementations are also possible, for example in smart home devices or infotainment systems, where the message is read aloud by a Text-to-Speech system, but never actually displayed. It is up to the implementors discretion to determine what the best approximation of <em>the user has had a reasonable chance to mentally process the message</em> is.          
      </dd>
    </di>
  </dl>
</section1>
<section1 topic='Use Cases' anchor='usecases'>
  <section2 topic="Server-side persistence" anchor='pep-node'>
    <p>Clients use items in a private PEP (&xep0163;) node called 'urn:xmpp:mds:displayed:0' to synchronize and persist the displayed state (See &xep0223;). The item ID corresponds to the JID of the respective chat. For normal, 1:1 chats this SHOULD be the bare JID of the contact, for group chats this SHOULD be the bare JID of the room and for private messages in group chats the full JID of the participant.</p>
    <p>The item contains a single &lt;displayed/> element qualified by the 'xrn:xmpp:mds:displayed:0' namespace. The &lt;displayed/> element MUST contain exactly one &xep0359; &lt;stanza-id/> element that corresponds to the stanza-id of the most recent, displayed message, in that particular chat.</p>
  </section2>
  <section2 topic="Flagging chat as displayed" anchor='publish'>
  <p>Only messages <strong>received</strong> by the user (meaning sent by third parties such as a contact, a participant in a group chat, etc) SHOULD be flagged as 'displayed'. However since 'displayed' means <em>all messages up to this point</em> and the stanza-id of a message <strong>sent</strong> by the user indicates a valid point in the chat history, sent messages MAY be flagged as well.</p>
  <p>Flagging a chat as <em>displayed up to this point</em> happens by publishing a PEP item with an id corresponding to the JID of the chat and a &lt;displayed/> payload element into the 'urn:xmpp:mds:displayed:0' node.</p>
  <p>For group chats the &lt;stanza-id/> child of the &lt;displayed/> element refers to the stanza-id injected by the room. For all other chats the stanza-id child refers to the stanza-id injected by the user’s server (the server hosting the user account).</p>
  <p>The client MUST include appropriate publish-options in the publication, including, but not limited to, setting the access model to whitelist and the max-items to max.</p>
  <example caption='Client marks a chat as display'><![CDATA[
<iq from='juliet@capulet.lit/balcony' type='set' id='flag-as-displayed-1'>
  <pubsub xmlns='http://jabber.org/protocol/pubsub'>
    <publish node='urn:xmpp:mds:displayed:0'>
      <item id='romeo@montegue.lit'>
        <displayed xmlns='urn:xmpp:mds:displayed:0'>
          <stanza-id xmlns='urn:xmpp:sid:0'
                     by='juliet@capulet.lit'
                     id='0f710f2b-52ed-4d52-b928-784dad74a52b'/>
        </displayed>
      </item>
    </publish>
    <publish-options>
      <x xmlns='jabber:x:data' type='submit'>
        <field var='FORM_TYPE' type='hidden'>
          <value>http://jabber.org/protocol/pubsub#publish-options</value>
        </field>
        <field var='pubsub#persist_items'>
          <value>true</value>
        </field>
        <field var='pubsub#max_items'>
          <value>max</value>
        </field>
        <field var='pubsub#send_last_published_item'>
          <value>never</value>
        </field>
        <field var='pubsub#access_model'>
          <value>whitelist</value>
        </field>
      </x>
    </publish-options>
  </pubsub>
</iq>
]]></example>
    <example caption="Server acknowledges successful storage"><![CDATA[
<iq to='juliet@capulet.lit/balcony' type='result' id='flag-as-displayed-1'/>
]]></example>
  </section2>
  <section2 topic="Retrieving notifications" anchor="notify">
    <p>A client interested in synchronizing the displayed state with other clients SHOULD include the 'urn:xmpp:mds:displayed:0+notify' feature in its &xep0115;, as per &xep0163; rules.</p>
  </section2>
  <section2 topic="Catching up" anchor="catchup">
    <p>Upon bind and initial presence a client retrieves all items in the 'urn:xmpp:mds:displayed:0' node to learn what changes to the displayed state have occured while the client was offline.</p>
    <example caption="Client retrieves all displayed items"><![CDATA[
<iq from='juliet@capulet.lit/balcony' type='get' id='catchup-1'>
  <pubsub xmlns='http://jabber.org/protocol/pubsub'>
    <items node='urn:xmpp:mds:displayed:0'/>
  </pubsub>
</iq>
]]></example>
    <example caption="Server returns the displayed states for various chat"><![CDATA[
<iq type='result'
    to='juliet@capulet.lit/balcony'
    id='catchup-1'>
  <pubsub xmlns='http://jabber.org/protocol/pubsub'>
    <items node='urn:xmpp:mds:displayed:0'>
      <item id='romeo@montegue.lit'>
        <displayed xmlns='urn:xmpp:mds:displayed:0'>
          <stanza-id xmlns='urn:xmpp:sid:0'
                     id='0f710f2b-52ed-4d52-b928-784dad74a52b'
                     by='juliet@capulet.lit'/>
        </displayed>
      </item>
      <item id='example@conference.shakespeare.lit'>
        <displayed xmlns='urn:xmpp:mds:displayed:0'>
          <stanza-id xmlns='urn:xmpp:sid:0'
                     id='ca21deaf-812c-48f1-8f16-339a674f2864'
                     by='example@conference.shakespeare.lit'/>
        </displayed>
      </item>
    </items>
  </pubsub>
</iq>
]]></example>
  </section2>
  <section2 topic="Interaction with Displayed Markers and Server Assist" anchor="interaction">
    <p>A &xep0333; displayed marker refers to the message id set by the sender of the message whereas the displayed element defined in this specification refers to the stanza-id injected by the user’s server.</p>
    <p>In the likely scenario that a client wishes to share the displayed state with their own devices and the sender of the message, a client SHOULD sent a &xep0333; displayed marker and ensure that the 'urn:xmpp:mds:displayed:0' node gets updated.</p>
    <section3 topic="Server assist">
      <p>A &xep0060; item publication is a fairly verbose operation for something that is expected to happen rather frequently. Therfore this specification defines an optional way to combine the PEP node item update and the Displayed Marker in one simple message.</p>
    </section3>
    <section3 topic="Discovering support">
      <p>Server assisted displayed node updates are an optional feature a user’s server can provide. To signal support the server announces an &xep0115; feature of 'urn:xmpp:mds:server-assist:0' on the account.</p>
      <example caption="Client queries for server features"><![CDATA[
<iq type='get' id='disco-1' to='juliet@capulet.lit' from='juliet@capulet.lit/balcony'>
  <query xmlns='http://jabber.org/protocol/disco#info'/>
</iq>
]]></example>
      <example caption="Server responds with features"><![CDATA[
<iq type='result' id='disco1' from='juliet@capulet.lit' to='juliet@capulet.lit/balcony'>
  <query xmlns='http://jabber.org/protocol/disco#info'>
    <feature var='urn:xmpp:mds:server-assist:0'/>
  </query>
</iq>
]]></example>
    </section3>
    <section3 topic="Sending assisted displayed">
      <p>To update the displayed item in the 'urn:xmpp:mds:displayed:0' PEP node more efficiently a client MAY send a message with the 'to' attribute set to the item id (which is equivalent to the JID of the contact) and with a &lt;displayed/> element qualified by the 'urn:xmpp:mds:displayed:0' namespace. The server MUST strip the &lt;displayed/> element from the message and continue to process it normally. The server MUST publish a PEP item on the 'urn:xmpp:mds:displayed:0' node where the item id is taken from the 'to' attribute and the payload is the &lt;displayed/> element. A client MUST NOT include the &lt;displayed/> element qualified by the 'urn:xmpp:mds:displayed:0' namespace if the message would otherwise be empty. A client that wishes to update the device synchronized displayed state but not inform the sender of the message via Displayed Markers SHOULD use the regular PubSub publication process.</p>
      <example caption="Juliet receives a message from Romeo"><![CDATA[
<message to='juliet@capulet.lit' from='romeo@montegue.lit/orchard' id='the-msg-1'>
  <body>Hi. How are you?</body>
  <markable xmlns='urn:xmpp:chat-markers:0'/>
  <stanza-id xmlns='urn:xmpp:sid:0' by='juliet@capulet.lit' id='0423e3a9-d516-493d-bb06-bee0e51ab9fb'/>
</message>
]]></example>
      <example caption="Juliet lets both Romeo and her other devices know she has displayed the message"><![CDATA[
<message to='romeo@montegue.lit'>
  <displayed xmlns='urn:xmpp:chat-markers:0' id='the-msg-1'/>
  <displayed xmlns='urn:xmpp:mds:displayed:0'>
    <stanza-id xmlns='urn:xmpp:sid:0' by='juliet@capulet.lit' id='0423e3a9-d516-493d-bb06-bee0e51ab9fb'/>
  </displayed>
</message>
]]></example>
   <example caption="Juliet’s server strips the displayed element used for server assist and forwards the stanza to Romeo"><![CDATA[
<message to='romeo@montegue.lit' from='juliet@capulet.let/balcony'>
  <displayed xmlns='urn:xmpp:chat-markers:0' id='the-msg-1'/>
</message>
]]></example>
      <example caption="Server sends out PEP notifications to Juliets connected devices"><![CDATA[
<message from='juliet@capulet.lit' to='juliet@capulet.lit/balcony' type='headline' id='new-displayed-pep-event'>
  <event xmlns='http://jabber.org/protocol/pubsub#event'>
    <items node='urn:xmpp:mds:displayed:0'>
      <item id='romeo@montegue.lit'>
        <displayed xmlns='urn:xmpp:mds:displayed:0'>
          <stanza-id xmlns='urn:xmpp:sid:0' by='juliet@capulet.lit' id='0423e3a9-d516-493d-bb06-bee0e51ab9fb'/>
        </displayed>
      </item>
    </items>
  </event>
</message>
]]></example>
    </section3>
  </section2>
</section1>
<section1 topic='Business Rules' anchor='rules'>
  <section2 topic='Client' anchor='rules-client'>
    <ul>
      <li>The displayed state only moves forward. Receiving a displayed state with a stanza-id that references a message older than the current local representation is considered redundant and MUST be ignored.</li>
      <li>Displayed states with a stanza-id not found in the respective chat MUST be ignored.</li>
      <li>Receiving an outgoing message (for example via &xep0280; or &xep0313;) SHOULD NOT mark the chat as displayed. Outgoing messages are neutral towards the overall displayed state of a given chat. For example if the <em>displayed up to</em> state references the most recent incoming message and this message is only followed by outgoing messages the overall state of that chat SHOULD be considered <em>displayed</em>.</li>
      <li>A client receiving an outgoing message MAY NOT update the displayed node item with that stanza-id. However clients SHOULD be able to handle displayed states that use stanza-ids that refer to outgoing messages and simply consider the chat as displayed up to that point.</li>
      <li>While Displayed Markers (&xep0333;), in 1:1 chats, MAY be sent to a full JID, a client combining both &lt;displayed/> elements in a single message MUST address that message to the bare JID, as the server will use the verbatim 'to' attribute as the item ID.</li>
    </ul>
  </section2>
  <section2 topic='Server' anchor='rules-server'>
    <ul>
      <li>The PEP item id (or 'to' attribute when using server-assist) and the stanza-id are opaque values that MAY NOT be validated by the server beyond the requirements of &xep0060;.</li>
      <li>Processing and stripping of the &lt;displayed/> element qualified by the 'urn:xmpp:mds:displayed:0' namespace on the server MUST happen before the message is stored in the archive (&xep0313;) and before it is reflected back to the sender via &xep0280; or &xep0409;.</li>
      <li>If processing the &lt;displayed/> element would implicitly create the PEP node the server MUST ensure that an appropriate node configuration is applied (see the Security Considerations of this specification).</li>
    </ul>
  </section2>
</section1>
<section1 topic='Accessibility Considerations' anchor='access'>
  <p>This specification comes with no accessibility considerations that go beyond what is required of any client (i.e. providing an accessible distinction between <em>read</em> and <em>unread</em> chats).</p>
</section1>
<section1 topic='Security Considerations' anchor='security'>
  <ul>
    <li>When publishing displayed states via &xep0060; the client MUST use publish-options to set the access model on the node to <em>whitelist</em>. To ensure the server supports publish-options the client MUST first check for the "http://jabber.org/protocol/pubsub#publish-options" feature.</li>
    <li>Servers that support the server assist feature MUST strip the &lt;displayed/> element in the "urn:xmpp:mds:displayed:0" namespace from the message to avoid the stanza-id being leaked to the recipient of that message.</li>
    <li>Clients MUST NOT put the &lt;displayed/> into a message to trigger server-assisted displayed synchronization unless the server announces the "urn:xmpp:mds:server-assist:0" feature.</li>
    <li>This specification provides a convenient process to synchronize a user’s own devices and informing the third party in one, single message. However letting the third party know is not always desirable, for example when the user has generally opted out of transmitting the displayed status or when a non-contact initiated a chat. In those cases the client MUST use the &xep0060; method instead of server-assist.</li>
  </ul>
</section1>
<section1 topic='Privacy Considerations' anchor='privacy'>
  <p>Implementing this specification gives the server the opportunity to perform activity tracking of a similiar scope than implementing &xep0085; or &xep0333; would.</p>
  <p>When using the server assist feature in conjunction with &xep0333; the Privacy Considerations of <em>Display Markers</em> apply.</p>
</section1>
<section1 topic='IANA Considerations' anchor='iana'>
  <p>This document requires no interaction with the Internet Assigned Numbers Authority (IANA).</p>
</section1>
<section1 topic='Design Considerations' anchor='design'>
  <section2 topic='Distinct Element for Server Assist' anchor='distinct-element'>
    <p>This specification introduces a distinct element to enable server assist instead of utilizing &xep0333; because Displayed Markers use the message id instead of stanza-ids. Translating between message id and stanza-id would require that the message (or parts of it) are archived on the server. Archiving should not be a requirement to offer server assist. (Especially since archived or not can depend on user settings.)</p>
  </section2>
  <section2 topic='Server Assist without Display Markers' anchor='server-assist-wo-marker'>
    <p>Server assist is not allowed in messages that would otherwise be empty. Overloading the semantic of sending a stanza to a third party entity solely to perform an action on the account that involves said third party is a dangerous example to set. (For example if server assit fails due to implementation errors a third party can be flooded with messages.) While stripping elements from stanzas is a common requirement on XMPP dropping entire stanzas without error is not.</p>
  </section2>
</section1>
<section1 topic='XMPP Registrar Considerations' anchor='registrar'>
  <p>This specification defines the following XML namespace:</p>
  <ul>
    <li>urn:xmpp:mds:displayed:0</li>
  </ul>
</section1>
<section1 topic='XML Schema' anchor='schema'>
  <code><![CDATA[<?xml version='1.0' encoding='UTF-8'?>

<xs:schema
    xmlns:xs='http://www.w3.org/2001/XMLSchema'
    xmlns:sid='urn:xmpp:sid:0'
    xmlns='urn:xmpp:mds:displayed:0'
    targetNamespace='urn:xmpp:mds:displayed:0'
    elementFormDefault='qualified'>

  <xs:annotation>
    <xs:documentation>
      The protocol documented by this schema is defined in
      XEP-0490: https://xmpp.org/extensions/xep-0490.html
    </xs:documentation>
  </xs:annotation>

  <xs:import namespace='urn:xmpp:sid:0'
    schemaLocation='xep-0359.xsd'/>

  <xs:element name='displayed'>
    <xs:complexType>
      <xs:sequence>
        <xs:element ref='sid:stanza-id'/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

</xs:schema>]]></code>
</section1>
</xep>