XEP-xxxx: Multi-User Chat Extensions

Abstract
This specification definies optional extensions to Multi-User Chat (XEP-0045).
Author
Florian Schmaus
Copyright
© 1999 – 2020 XMPP Standards Foundation. SEE LEGAL NOTICES.
Status

ProtoXEP

WARNING: This document has not yet been accepted for consideration or approved in any official manner by the XMPP Standards Foundation, and this document is not yet an XMPP Extension Protocol (XEP). If this document is accepted as a XEP by the XMPP Council, it will be published at <http://xmpp.org/extensions/> and announced on the <standards@xmpp.org> mailing list.
Type
Standards Track
Version
0.0.1 (2015-05-12)
Document Lifecycle
  1. Experimental
  2. Proposed
  3. Draft
  4. Final

1. Introduction

This XEP provides some useful optional extensions to Multi-User Chat (XEP-0045) [1].

2. Requirements

STRONGLY RECOMMENDED.

3. Determing Support

An entity may wish to discover if a service implements the Multi-User Chat protocol and the optional extensions defined in this XEP; in order to do so, it sends a service discovery information ("disco#info") query to the MUC service's JID.

Example 1. Entity Queries Chat Service for MUC Support via Disco
<iq from='hag66@shakespeare.lit/pda'
    id='lx09df27'
    to='chat.shakespeare.lit'
    type='get'>
  <query xmlns='http://jabber.org/protocol/disco#info'/>
</iq>

The service MUST return its identity and the features it supports.

Example 2. Service Returns Disco Info Result
<iq from='chat.shakespeare.lit'
    id='lx09df27'
    to='hag66@shakespeare.lit/pda'
    type='result'>
  <query xmlns='http://jabber.org/protocol/disco#info'>
    <identity
        category='conference'
        name='Shakespearean Chat Service'
        type='text'/>
    <feature var='http://jabber.org/protocol/muc'/>
    <feature var='urn:xmpp:muc:mid'/>
    <feature var='urn:xmpp:muc:pmtag'/>
  </query>
</iq>

4. Extensions

4.1 Unique and stable message IDs

If the MUC service announces support for the 'urn:xmpp:muc:mid' feature, then he MUST handle the <message-id/> element as defined in TODO XEP-MID. Client can send messages with the <message-id/> extension element. Message Stanzas send from the MUC service to MUC participants MUST contain a unique and stable message ID witin <message-id/> element.

Example 3. A message stanza with the message ID extension.
<message xmlns='jabber:client'
         to='room@muc.example.org'
         type='groupchat'>
  <body>Typical body text</body>
  <message-id xmlns='urn:xmpp:mid:0' client-id='de305d54-75b4-431b-adb2-eb6b9e546013'/>
</message>

The server MAY override the ID. If so, the "message-id" element MUST contain an "id" and a "client-id" attribute.

Example 4. A message stanza with the message ID extension.
<message xmlns='jabber:client'
         to='room@muc.example.org'
         type='groupchat'>
  <body>Typical body text</body>
  <message-id xmlns='urn:xmpp:mid:0'
              id='new-id-overrides-client-id'
              client-id='de305d54-75b4-431b-adb2-eb6b9e546013'/>
</message>

Otherwise, if the server does not override the ID, he MAY omit the "client-id" attribute.

4.2 Taging private MUC messages

If the MUC service announces support for the 'urn:xmpp:muc:pmtag' feature, then he MUST tag private MUC messages with a <x/> element qualified by the 'http://jabber.org/protocol/muc#user' namespace before sending it to the recipient (see XEP-45 § 7.5 Sending a Private Message).

Example 5. Tagged private MUC message
<message
    from='coven@chat.shakespeare.lit/firstwitch'
    id='hgn27af1'
    to='crone1@shakespeare.lit/desktop'
    type='chat'>
  <body>I'll give thee a wind.</body>
  <x xmlns='http://jabber.org/protocol/muc#user'/>
</message>

This allows clients receiving the message by e.g. carbon copies to determine that it's a MUC private message.

4.3 Checking own occupant status

TODO: Provide a method to query if client is considered to be an occupant of a MUC by the MUC service.

5. Business Rules

OPTIONAL.

6. Implementation Notes

OPTIONAL.

7. Accessibility Considerations

OPTIONAL.

8. Internationalization Considerations

OPTIONAL.

9. Security Considerations

REQUIRED.

10. IANA Considerations

REQUIRED.

11. XMPP Registrar Considerations

REQUIRED.

12. XML Schema

REQUIRED for protocol specifications.


Appendices

Appendix A: Document Information

Series
XEP
Number
xxxx
Publisher
XMPP Standards Foundation
Status
ProtoXEP
Type
Standards Track
Version
0.0.1
Last Updated
2015-05-12
Approving Body
XMPP Council
Dependencies
XMPP Core, XEP-0030, XEP-0045
Supersedes
None
Superseded By
None
Short Name
NOT_YET_ASSIGNED

This document in other formats: XML  PDF

Appendix B: Author Information

Florian Schmaus
Email
flo@geekplace.eu
JabberID
flo@geekplace.eu

Copyright

This XMPP Extension Protocol is copyright (c) 1999 - 2014 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. In no event shall the XMPP Standards Foundation or the authors of this Specification be liable for any claim, damages, or other liability, whether in an action of contract, tort, or otherwise, arising from, out of, or in connection with the Specification or the implementation, deployment, or other use of the Specification. ##

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 out of the use or inability to use 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 may be found at <http://xmpp.org/extensions/ipr-policy.shtml> or obtained by writing to XSF, P.O. Box 1641, Denver, CO 80201 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 <http://xmpp.org/about/discuss.shtml> 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-0045: Multi-User Chat <https://xmpp.org/extensions/xep-0045.html>.

Appendix H: Revision History

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

  1. Version 0.0.1 (2015-05-12)

    First draft.

    fs

END