xeps/xep-0083.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>Nested Roster Groups</title>
  <abstract>This document defines an XMPP 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.</abstract>
  &LEGALNOTICE;
  <number>0083</number>
  <status>Active</status>
  <type>Informational</type>
  <sig>Standards</sig>
  <dependencies>
    <spec>XMPP Core</spec>
    <spec>XMPP IM</spec>
    <spec>XEP-0049</spec>
  </dependencies>
  <supersedes/>
  <supersededby/>
  <shortname>nestedgroups</shortname>
  <schemaloc>
    <url>http://www.xmpp.org/schemas/delimiter.xsd</url>
  </schemaloc>
  <author>
    <firstname>Rachel</firstname>
    <surname>Blackman</surname>
    <email>rcb@ceruleanstudios.com</email>
    <jid>sparks@jabber.org</jid>
  </author>
  <revision>
    <version>1.0</version>
    <date>2004-10-11</date>
    <initials>psa</initials>
    <remark>Per a vote of the Jabber Council, advanced to a status of Active.</remark>
  </revision>
  <revision>
    <version>0.1</version>
    <date>2003-05-05</date>
    <initials>rcb</initials>
    <remark>Initial version.</remark>
  </revision>
</header>
<section1 topic='Introduction' anchor='intro'>
  <p>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 document aims to solve that problem within Jabber, by providing for a way to store sub-groups on the Jabber roster without breaking existing clients.</p>
</section1>
<section1 topic='roster:delimiter Namespace' anchor='namespace'>
  <p>Jabber already provides a useful method for storing client data on the server using &xep0049;.  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. <note>If the element does not contain XML character data, a compliant client SHOULD assume that nested groups are disabled for the user's account.</note></p>
  <p>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.</p>
  <p>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.</p>
</section1>
<section1 topic='Use Cases' anchor='usecases'>
  <p>Use cases for this extension are straightforward, and are shown below as examples.</p>
  <section2 topic='Querying for the delimiter' anchor='usecases-query'>
    <p>All compliant clients SHOULD query for an existing delimiter at login.</p>
    <example caption='Querying for the Delimiter'><![CDATA[
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>
]]></example>
  </section2>
  <section2 topic='Retrieving the Roster' anchor='usecases-retrieve'>
    <p>Now that the client has a delimiter, we can retrieve and parse the roster properly.</p>
    <example caption='Retrieving a Roster with Nested Groups'><![CDATA[

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>
]]></example>
  <p>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.</p>
  <p>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.</p>
  </section2>
</section1>
<section1 topic='Security Considerations' anchor='security'>
  <p>There are no security features or concerns related to this proposal above and beyond those specified for roster management in &xmppim; and for private XML storage in XEP-0049.</p>
</section1>
<section1 topic='IANA Considerations' anchor='iana'>
  <p>This document requires no interaction with &IANA;.</p>
</section1>
<section1 topic='XMPP Registrar Considerations' anchor='registrar'>
  <section2 topic='Protocol Namespaces' anchor='registrar-ns'>
    <p>The &REGISTRAR; includes 'roster:delimiter' in its registry of protocol namespaces.</p>
  </section2>
</section1>
<section1 topic='Schema' anchor='schema'>
  <code><![CDATA[
<?xml version='1.0' encoding='UTF-8'?>

<xs:schema
    xmlns:xs='http://www.w3.org/2001/XMLSchema'
    targetNamespace='roster:delimiter'
    xmlns='roster:delimiter'>

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

  <xs:element name='roster' type='xs:string'/>

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