XEP-0306: Extensible Status Conditions for Multi-User Chat

Abstract:This document defines an extensible format for status conditions in Multi-User Chat, similar to the error format used in the core of XMPP.
Author:Peter Saint-Andre
Copyright:© 1999 - 2011 XMPP Standards Foundation. SEE LEGAL NOTICES.
Status:Experimental
Type:Standards Track
Version:0.1
Last Updated:2011-08-26

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.

Table of Contents


1. Introduction
2. Format
3. Mapping of Existing Codes
4. Security Considerations
5. IANA Considerations
6. XMPP Registrar Considerations
    6.1. Protocol Namespaces
    6.2. Protocol Versioning
    6.3. MUC Status Codes Registry
7. XML Schema

Appendices
    A: Document Information
    B: Author Information
    C: Legal Notices
    D: Relation to XMPP
    E: Discussion Venue
    F: Requirements Conformance
    G: Notes
    H: Revision History

1. Introduction

Traditionally, Multi-User Chat [1] has used numerical status codes similar to those used in HTTP and SMTP. Numerical codes were deprecated in the core of XMPP by RFC 3920 [2] and are no longer even defined in the core schemas provided in RFC 6120 [3] (see also Error Condition Mappings [4]). In an effort to modernize the Multi-User Chat (MUC) protocol, this document defines an extensible format for status conditions in MUC.

2. Format

XML elements describing status conditions defined by this specification SHALL be qualified by the 'urn:xmpp:muc:conditions:0' namespace.

The structure is as follows:

<conditions xmlns='urn:xmpp:muc:conditions:0'>
  <DEFINED-CONDITION>
    [<text xml:lang='langcode'>OPTIONAL descriptive text</text>]
    [OPTIONAL application-specific condition element]
  </DEFINED-CONDITION>
  [<DEFINED-CONDITION/>]
  [OPTIONAL application-specific condition element or elements]
</conditions>

That is, the <conditions/> element MAY contain one or more condition elements defined in this document (each of which MAY contain a human-readable <text/> element and MAY contain an application-specific condition element) and MAY contain one or more application-specific condition elements.

The <conditions/> element is intended to be a direct child of the <x/> element qualified by the 'http://jabber.org/protocol/muc#user' as used for status notifications in multi-user chat.

An example follows.

Example 1. Service Sends New Occupant's Presence to New Occupant

<presence
    from='coven@chat.shakespeare.lit/thirdwitch'
    id='n13mt3l'
    to='hag66@shakespeare.lit/pda'>
  <x xmlns='http://jabber.org/protocol/muc#user'>
    <item affiliation='member' role='participant'/>
    <status code='100'/>
    <status code='110'/>
    <conditions xmlns='urn:xmpp:muc:conditions:0'>
      <realjid-public/>
      <self-presence/>
    </conditions>
  </x>
</presence>

3. Mapping of Existing Codes

The following table maps the existing numerical status codes (registered with the XMPP Registrar [5] at <http://xmpp.org/registrar/mucstatus.html>) to XML elements.

Table 1: Error Codes for http://jabber.org/protocol/muc#user Namespace

Code Element
100 <realjid-public/>
101 <affiliation-changed/>
102 <unavailable-shown/>
103 <unavailable-not-shown/>
104 <configuration-changed/>
110 <self-presence/>
170 <logging-enabled/>
171 <logging-disabled/>
172 <non-anonymous/>
173 <semi-anonymous/>
174 <fully-anonymous/>
201 <room-created/>
210 <nick-assigned/>
301 <banned/>
303 <new-nick/>
307 <kicked/>
321 <removed-affiliation/>
322 <removed-membership/>
332 <removed-shutdown/>

4. Security Considerations

The security considerations of XEP-0045 apply.

5. IANA Considerations

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

6. XMPP Registrar Considerations

6.1 Protocol Namespaces

This specification defines the following XML namespace:

Upon advancement of this specification from a status of Experimental to a status of Draft, the XMPP Registrar [7] shall add the foregoing namespace to the registry located at <http://xmpp.org/registrar/namespaces.html>, as described in Section 4 of XMPP Registrar Function [8].

6.2 Protocol Versioning

If the protocol defined in this specification undergoes a revision that is not fully backwards-compatible with an older version, the XMPP Registrar shall increment the protocol version number found at the end of the XML namespaces defined herein, as described in Section 4 of XEP-0053.

6.3 MUC Status Codes Registry

The XMPP Registrar is requested to add the elements defined in this specification to the existing registry for MUC status codes at <http://xmpp.org/registrar/mucstatus.html>.

7. XML Schema

<?xml version='1.0' encoding='UTF-8'?>

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

  <xs:element name='conditions'>
    <xs:complexType>
      <xs:sequence>
        <xs:choice minOccurs='0' maxOccurs='unbounded'>
          <xs:element name='affiliation-changed' type='MucStatusType'/>
          <xs:element name='banned' type='MucStatusType'/>
          <xs:element name='configuration-changed' type='MucStatusType'/>
          <xs:element name='fully-anonymous' type='MucStatusType'/>
          <xs:element name='kicked' type='MucStatusType'/>
          <xs:element name='logging-disabled' type='MucStatusType'/>
          <xs:element name='logging-enabled' type='MucStatusType'/>
          <xs:element name='new-nick' type='MucStatusType'/>
          <xs:element name='nick-assigned' type='MucStatusType'/>
          <xs:element name='non-anonymous' type='MucStatusType'/>
          <xs:element name='realjid-public' type='MucStatusType'/>
          <xs:element name='removed-affiliation' type='MucStatusType'/>
          <xs:element name='removed-membership' type='MucStatusType'/>
          <xs:element name='removed-shutdown' type='MucStatusType'/>
          <xs:element name='room-created' type='MucStatusType'/>
          <xs:element name='self-presence' type='MucStatusType'/>
          <xs:element name='semi-anonymous' type='MucStatusType'/>
          <xs:element name='unavailable-not-shown' type='MucStatusType'/>
          <xs:element name='unavailable-shown' type='MucStatusType'/>
        </xs:choice>
        <xs:any namespace='##other' minOccurs='0' maxOccurs='unbounded' processContents='lax'/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

  <xs:complexType name='MucStatusType'>
    <xs:sequence>
      <xs:element ref='text'/>
      <xs:any namespace='##other' minOccurs='0' maxOccurs='unbounded' processContents='lax'/>
    </xs:sequence>
  </xs:complexType>
</xs:schema>

  <xs:element name='text'>
    <xs:complexType>
      <xs:simpleContent>
        <xs:extension base='xs:string'>
          <xs:attribute ref='xml:lang' use='optional'/>
        </xs:extension>
      </xs:simpleContent>
    </xs:complexType>
  </xs:element>

Appendices

Appendix A: Document Information

Series: XEP
Number: 0306
Publisher: XMPP Standards Foundation
Status: Experimental
Type: Standards Track
Version: 0.1
Last Updated: 2011-08-26
Approving Body: XMPP Council
Dependencies: RFC 6120, XEP-0045
Supersedes: None
Superseded By: None
Short Name: N/A
Source Control: HTML
This document in other formats: XML  PDF

Appendix B: Author Information

Peter Saint-Andre

Email: stpeter@jabber.org
JabberID: stpeter@jabber.org
URI: https://stpeter.im/

Appendix C: Legal Notices

Copyright

This XMPP Extension Protocol is copyright © 1999 - 2011 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 <http://xmpp.org/about-xmpp/xsf/xsf-ipr-policy/> or obtained by writing to XMPP Standards Foundation, 1899 Wynkoop Street, Suite 600, Denver, CO 80202 USA).

Appendix D: Relation to XMPP

The Extensible Messaging and Presence Protocol (XMPP) is defined in the XMPP Core (RFC 3920) and XMPP IM (RFC 3921) 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.

Given that this XMPP Extension Protocol normatively references IETF technologies, discussion on the <xsf-ietf@xmpp.org> list might also be appropriate.

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 <http://xmpp.org/extensions/xep-0045.html>.

2. RFC 3920: Extensible Messaging and Presence Protocol (XMPP): Core <http://tools.ietf.org/html/rfc3920>.

3. RFC 6120: Extensible Messaging and Presence Protocol (XMPP): Core <http://tools.ietf.org/html/rfc6120>.

4. XEP-0086: Error Condition Mappings <http://xmpp.org/extensions/xep-0086.html>.

5. The XMPP Registrar maintains a list of reserved protocol namespaces as well as registries of parameters used in the context of XMPP extension protocols approved by the XMPP Standards Foundation. For further information, see <http://xmpp.org/registrar/>.

6. 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/>.

7. The XMPP Registrar maintains a list of reserved protocol namespaces as well as registries of parameters used in the context of XMPP extension protocols approved by the XMPP Standards Foundation. For further information, see <http://xmpp.org/registrar/>.

8. XEP-0053: XMPP Registrar Function <http://xmpp.org/extensions/xep-0053.html>.

Appendix H: Revision History

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

Version 0.1 (2011-08-26)

Initial published version.

(psa)

Version 0.0.1 (2011-08-12)

Rough draft.

(psa)

END