XEP-0428: Fallback Indication

Abstract
This specification proposes a mechanism by which message bodies or parts thereof can be marked as being for fallback purposes, and therefore to be ignored by anything that understands the original intent of the message.
Authors
  • Dave Cridland
  • Marvin Wißfeld
Copyright
© 2019 – 2022 XMPP Standards Foundation. SEE LEGAL NOTICES.
Status

Experimental

WARNING: This Standards-Track document is Experimental. Publication as an XMPP Extension Protocol does not imply approval of this proposal by the XMPP Standards Foundation. Implementation of the protocol described herein is encouraged in exploratory implementations, but production systems are advised to carefully consider whether it is appropriate to deploy implementations of this protocol before it advances to a status of Draft.
Type
Standards Track
Version
0.2.0 (2022-07-17)
Document Lifecycle
  1. Experimental
  2. Proposed
  3. Stable
  4. Final

1. Introduction

A common and convenient practise for new extensions is to supply a fallback in the body. This provides immediate backwards compatibility for naive clients, since - not understanding the new protocol - they will gracefully degrade to displaying the body as an instant message.

By way of example, a recent Reactions proposal suggested including the emoji as a <body/> element, so that existing clients would simply display it as a normal message.

The downside of this approach is that servers and other intermediaries treat the presence of a <body/> as being an indicator that a message is indeed an instant message. They may errornously treat a message this way for archival purposes, etc, that only has a <body/> for fallback purposes, which might not be appropriate.

This specification tackles the problem by providing an element to be used as a hint that parts or all of the supplied <body/> and <subject/> elements are for fallback purposes, and the message may be treated as if they were not present if the processing entity understands what the message is a fallback for.

Additionally, the specification allows for transporting information about which parts of a <body/> are used for fallback purposes and for which reason, such that supporting clients can hide or dim those parts when displaying them to the user or otherwise treat those parts special as intended or encouraged by other specifications.

2. Overview

2.1 Discovering Support

Support for this protocol MAY be advertised by the Service Discovery protocol defined in Service Discovery (XEP-0030) [1] using a feature of urn:xmpp:fallback:0. Note that lack of support will result in the desired fallback behaviour.

2.2 Fallback Indicator

The fallback indicator is an element <fallback/> qualified by the urn:xmpp:fallback:0 namespace. It has an attribute for that indicates the specification that the fallback is meant to replace. This is typically the primary namespace of the respective specification, but may be specified otherwise. The <fallback/> element may have one or multiple <body/> or <subject/> child elements, that indicate the part of the message, that is a fallback. Both of these child elements may have a start and end attribute which point to the start and end of a fallback character sequence as defined in Character counting in message bodies (XEP-0426) [2] in the respective element in the message. If start and end attribute are not supplied, the whole respective message element should be assumed to be there for fallback purposes. If the <fallback/> element does not have any childs, it is assumed to apply to every message <body/> and <subject/> present in the message.

A previous version of this specification had an example using an encrypted message. It is suggested to use Explicit Message Encryption (XEP-0380) [3] instead of this specification for that usecase.

Example 1.
<message to='anna@example.com' id='message-id2' type='groupchat'>
  <body>
    > Anna wrote:
    > Hi, how are you?
    Great
  </body>
  <reply to='anna@example.com' id='message-id1' xmlns='urn:xmpp:reply:0' />
  <fallback xmlns='urn:xmpp:fallback:0' for='urn:xmpp:reply:0'>
    <body start='0' end='33' />
  </fallback>
</message>

Receiving the above message, a naive client will naturally display the full <body/> element text, but a client which supports this specification and the specification for urn:xmpp:reply:0 will know that a part of the message is merely a fallback placeholder, and to ignore (and not display) that part, if it has other ways to convey the intended meaning.

2.3 Alternatives

3. Schema

      
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" targetNamespace="urn:xmpp:fallback:0" xmlns="urn:xmpp:fallback:0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="fallback">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="subject" type="region" minOccurs="0" maxOccurs="unbounded" />
        <xs:element name="body" type="region" minOccurs="0" maxOccurs="unbounded" />
      </xs:sequence>
      <xs:attribute name="for" type="xs:string" />
    </xs:complexType>
  </xs:element>
  <xs:complexType name="region">
    <xs:attribute name="start" type="xs:integer" />
    <xs:attribute name="end" type="xs:integer" />
  </xs:complexType>
</xs:schema>
      
    

4. Security Considerations

This specification allows messages with a body (and real message content therein) to be treated by a server as if that body text does not exist. Servers MAY, particularly in a secure setting, wish to archive copies of the message even if they ordinarily would not archive a message with no body.

5. IANA Considerations

This XEP requires no interaction with the Internet Assigned Numbers Authority (IANA) [5].

6. XMPP Registrar Considerations

None.

7. Acknowledgements

The author wishes to share any credit with many members of the community.


Appendices

Appendix A: Document Information

Series
XEP
Number
0428
Publisher
XMPP Standards Foundation
Status
Experimental
Type
Standards Track
Version
0.2.0
Last Updated
2022-07-17
Approving Body
XMPP Council
Dependencies
XMPP Core
Supersedes
None
Superseded By
None
Short Name
fallback
Source Control
HTML

This document in other formats: XML  PDF

Appendix B: Author Information

Dave Cridland
Email
dave@hellopando.com
JabberID
dwd@dave.cridland.net
Marvin Wißfeld
Email
xmpp@larma.de
JabberID
jabber@larma.de

Copyright

This XMPP Extension Protocol is copyright © 1999 – 2020 by the XMPP Standards Foundation (XSF).

Permissions

Permission is hereby granted, free of charge, to any person obtaining a copy of this specification (the "Specification"), to make use of the Specification without restriction, including without limitation the rights to implement the Specification in a software program, deploy the Specification in a network service, and copy, modify, merge, publish, translate, distribute, sublicense, or sell copies of the Specification, and to permit persons to whom the Specification is furnished to do so, subject to the condition that the foregoing copyright notice and this permission notice shall be included in all copies or substantial portions of the Specification. Unless separate permission is granted, modified works that are redistributed shall not contain misleading information regarding the authors, title, number, or publisher of the Specification, and shall not claim endorsement of the modified works by the authors, any organization or project to which the authors belong, or the XMPP Standards Foundation.

Disclaimer of Warranty

## NOTE WELL: This Specification is provided on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. ##

Limitation of Liability

In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall the XMPP Standards Foundation or any author of this Specification be liable for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising from, out of, or in connection with the Specification or the implementation, deployment, or other use of the Specification (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if the XMPP Standards Foundation or such author has been advised of the possibility of such damages.

IPR Conformance

This XMPP Extension Protocol has been contributed in full conformance with the XSF's Intellectual Property Rights Policy (a copy of which can be found at <https://xmpp.org/about/xsf/ipr-policy> or obtained by writing to XMPP Standards Foundation, P.O. Box 787, Parker, CO 80134 USA).

Visual Presentation

The HTML representation (you are looking at) is maintained by the XSF. It is based on the YAML CSS Framework, which is licensed under the terms of the CC-BY-SA 2.0 license.

Appendix D: Relation to XMPP

The Extensible Messaging and Presence Protocol (XMPP) is defined in the XMPP Core (RFC 6120) and XMPP IM (RFC 6121) specifications contributed by the XMPP Standards Foundation to the Internet Standards Process, which is managed by the Internet Engineering Task Force in accordance with RFC 2026. Any protocol defined in this document has been developed outside the Internet Standards Process and is to be understood as an extension to XMPP rather than as an evolution, development, or modification of XMPP itself.

Appendix E: Discussion Venue

The primary venue for discussion of XMPP Extension Protocols is the <standards@xmpp.org> discussion list.

Discussion on other xmpp.org discussion lists might also be appropriate; see <https://xmpp.org/community/> for a complete list.

Errata can be sent to <editor@xmpp.org>.

Appendix F: Requirements Conformance

The following requirements keywords as used in this document are to be interpreted as described in RFC 2119: "MUST", "SHALL", "REQUIRED"; "MUST NOT", "SHALL NOT"; "SHOULD", "RECOMMENDED"; "SHOULD NOT", "NOT RECOMMENDED"; "MAY", "OPTIONAL".

Appendix G: Notes

1. XEP-0030: Service Discovery <https://xmpp.org/extensions/xep-0030.html>.

2. XEP-0426: Character counting in message bodies <https://xmpp.org/extensions/xep-0426.html>.

3. XEP-0380: Explicit Message Encryption <https://xmpp.org/extensions/xep-0380.html>.

4. XEP-0334: Message Processing Hints <https://xmpp.org/extensions/xep-0334.html>.

5. The Internet Assigned Numbers Authority (IANA) is the central coordinator for the assignment of unique parameter values for Internet protocols, such as port numbers and URI schemes. For further information, see <http://www.iana.org/>.

Appendix H: Revision History

Note: Older versions of this specification might be available at https://xmpp.org/extensions/attic/

  1. Version 0.2.0 (2022-07-17)
    lmw
  2. Version 0.1.1 (2020-03-03)
    Minor editorial fixes
    ps
  3. Version 0.1.0 (2020-01-28)
    Accepted by vote of Council on 2020-01-02.
    XEP Editor (jsc)
  4. Version 0.0.1 (2019-12-30)
    dwd

Appendix I: Bib(La)TeX Entry

@report{cridland2019fallback,
  title = {Fallback Indication},
  author = {Cridland, Dave and Wißfeld, Marvin},
  type = {XEP},
  number = {0428},
  version = {0.2.0},
  institution = {XMPP Standards Foundation},
  url = {https://xmpp.org/extensions/xep-0428.html},
  date = {2019-12-30/2022-07-17},
}

END