This JEP defines a protocol extension that enables nested sub-groups to exist within the Jabber roster, while retaining backwards compatibility and ensuring that the roster remains usable by all clients.
NOTICE: This JEP is currently within Last Call or under consideration by the Jabber Council for advancement to the next stage in the JSF standards process. For further details, visit <http://www.jabber.org/council/queue.php>.
Status: Proposed
Type: Informational
Number: 0083
Version: 0.1
Last Updated: 2003-05-05
JIG: Standards JIG
Approving Body: Jabber Council
Dependencies: XMPP Core, XMPP IM, JEP-0049
Supersedes: None
Superseded By: None
Short Name: N/A
Email: rcb@ceruleanstudios.com
JID: sparks@jabber.org
This Jabber Enhancement Proposal is copyright 1999 - 2004 by the Jabber Software Foundation (JSF) and is in full conformance with the JSF's Intellectual Property Rights Policy <http://www.jabber.org/jsf/ipr-policy.php>. This material may be distributed only subject to the terms and conditions set forth in the Open Publication License, v1.0 or later (the latest version is presently available at <http://www.opencontent.org/openpub/>).
The preferred venue for discussion of this document is the Standards-JIG discussion list: <http://mail.jabber.org/mailman/listinfo/standards-jig>.
The Extensible Messaging and Presence Protocol (XMPP) is defined in the XMPP Core and XMPP IM specifications contributed by the Jabber Software Foundation to the Internet Standards Process, which is managed by the Internet Engineering Task Force in accordance with RFC 2026. Any protocols defined in this JEP have been developed outside the Internet Standards Process and are to be understood as extensions to XMPP rather than as an evolution, development, or modification of XMPP itself.
The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.
In many modern instant messaging clients, client authors implement a way to nest contact groups within other contact groups. Usually this is implemented on the client side, since many instant messaging networks do not support nesting contact groups in this manner. The limitation of this system is that if the user changes from one client to another, or even a second installation of the same client, the user loses all of his or her sub-group information. This JEP aims to solve that problem within Jabber, by providing for a way to store sub-groups on the Jabber roster without breaking existing clients.
Jabber already provides a useful method for storing client data on the server using Private XML Storage [1]. All we need to do is create a new roster element and a namespace to store the delimiter for nested groups, roster:delimiter. This element MUST contain XML character data that defines a string to be used as a delimiter in the roster groups. [2]
A single-character roster delimiter (e.g., "/") would make client implementation easier, but be more limiting to the end-user in terms of choices for naming roster groups, so a string is ideal. Therefore, the delimiter SHOULD contain multiple characters in order to avoid inconveniencing the user, but single-character delimiters MUST be honored by the client. The exception is if the delimiter is a single alphanumeric character (a-z, A-Z, 0-9); in this case compliant clients MUST treat the situation as if nesting were disabled, to avoid malicious use of this element by setting 'e' or 'm' or some other common single character as a delimiter.
A compliant client SHOULD ask for the nested delimiter before requesting the user's roster, in order to know whether or not to parse the roster 'group' fields accordingly. If there is no delimiter stored, a client MAY set a delimiter but MUST either prompt the user for a delimiter, or use a user-configurable default.
Use cases for this extension are straightforward, and are shown below as examples.
All compliant clients SHOULD query for an existing delimiter at login.
Example 1. Querying for the Delimiter
CLIENT:
<iq type='get'
id='1'>
<query xmlns='jabber:iq:private'>
<roster xmlns='roster:delimiter'/>
</query>
</iq>
SERVER:
<iq type='result'
id='1'
from='bill@shakespeare.lit/Globe'
to='bill@shakespeare.lit/Globe'>
<query xmlns='jabber:iq:private'>
<roster xmlns='roster:delimiter'>::</roster>
</query>
</iq>
Now that the client has a delimiter, we can retrieve and parse the roster properly.
Example 2. Retrieving a Roster with Nested Groups
CLIENT:
<iq type='get'
id='2'>
<query xmlns='jabber:iq:roster'/>
</iq>
SERVER:
<iq type='result'
to='bill@shakespeare.lit/Globe'
id='2'>
<query xmlns='jabber:iq:roster'>
<item jid='bottom@athens.gr' subscription='both'>
<group>Midsummer::Actors</group>
</item>
<item jid='quince@athens.gr' subscription='both'>
<group>Midsummer::Actors</group>
</item>
<item jid='snug@athens.gr' subscription='both'>
<group>Midsummer::Actors</group>
</item>
<item jid='theseus@athens.gr' subscription='both'>
<group>Midsummer::Royalty</group>
</item>
<item jid='hippolyta@athens.gr' subscription='both'>
<group>Midsummer::Royalty</group>
</item>
<item jid='robin@faeries.underhill.org' subscription='both'>
<group>Midsummer</group>
</item>
<item jid='hamlet@denmark.net' subscription='both'>
<group>Hamlet</group>
</item>
<item jid='gertrude@denmark.net' subscription='both'>
<group>Hamlet</group>
</item>
</query>
</iq>
Bottom, Quince and Snug should be grouped together in a group 'Actors' underneath the group 'Midsummer'. Theseus and Hippolyta should be grouped together in a group 'Royalty' under 'Midsummer'. Robin Goodfellow, meanwhile, being in a class unto himself, is a plain contact under the 'Midsummer' group rather than in an actual sub-group. The group Hamlet, containing only one melancholy prince and his mother, contains no sub-groups at all.
As should be apparent, a client which does not support the delimiter will instead create a separate group -- such as 'Midsummer::Actors' -- and thus will still have each set of contacts grouped with the other appropriate contacts.
There are no security features or concerns related to this proposal above and beyond those specified for roster management in XMPP IM [3].
This JEP requires no interaction with the Internet Assigned Numbers Authority (IANA) [4].
No namespaces or parameters need to be registered with the Jabber Registrar [5] as a result of this JEP.
As the private storage element is simple, the schema is similarly simple.
<?xml version='1.0' encoding='UTF-8'?>
<xs:schema
xmlns:xs='http://www.w3.org/2001/XMLSchema'
targetNamespace='roster:delimiter'
xmlns='roster:delimiter'>
<xs:element name='roster' type='xs:string'/>
1. JEP-0049: Private XML Storage <http://www.jabber.org/jeps/jep-0049.html>.
2. If the element does not contain XML character data, a compliant client SHOULD assume that nested groups are disabled for the user's account.
3. RFC 3921: Extensible Messaging and Presence Protocol (XMPP): Instant Messaging and Presence <http://www.ietf.org/rfc/rfc3921.txt>.
4. 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/>.
5. The Jabber Registrar maintains a list of reserved Jabber protocol namespaces as well as registries of parameters used in the context of protocols approved by the Jabber Software Foundation. For further information, see <http://www.jabber.org/registrar/>.
END