From 7b355e910561dc4bd3e998f13ff8f17657219ad0 Mon Sep 17 00:00:00 2001 From: stpeter Date: Tue, 20 Jul 2010 10:22:59 -0600 Subject: [PATCH] 0.2 --- xep-0281.xml | 263 +++++++++++++++++++++++++++++++++++---------------- 1 file changed, 179 insertions(+), 84 deletions(-) diff --git a/xep-0281.xml b/xep-0281.xml index 6c86af6b..4e0a9fad 100644 --- a/xep-0281.xml +++ b/xep-0281.xml @@ -23,6 +23,12 @@ NOT-YET-ASSIGNED &stpeter; + + 0.2 + 2010-07-20 + psa +

Added protocol flows for finding and joining shadow rooms, thus removing dependency on communication with firsthost; changed examples to mimic XEP-0045.

 + 0.1 2010-06-11 @@ -44,10 +50,13 @@ +

This document is one of several proposals for distributing XMPP chat rooms across multiple chat services. It is expected that the various approaches will be refined and harmonized before a final protocol is developed.

+

&xep0045; defines a full-featured technology for multi-user text conferencing in XMPP. By design, XEP-0045 assumes that a conference room is hosted at a single service, which can be accessed from any point on the network. However, this assumption introduces a single point of failure for the conference room, since if occupants at a using domain lose connectivity to the hosting domain then they also lose connectivity to the room. In some deployment scenarios (and even on the open Internet) this behavior is suboptimal. Therefore, this document attempts to define a technology for distributing MUC rooms across multiple services.

 +

This specification addresses the following requirements:

    @@ -58,6 +67,7 @@
  1. Enable syncing of history, configuration, and room rosters on reconnect.
 +

The basic approach to distribution of MUC rooms is as follows:

    @@ -70,36 +80,42 @@

The room IDs of source rooms SHOULD be opaque to users and unique across all possible peerhosts, for example by generating a UUID in accordance with &rfc4122; or by hashing the human-readable name of the room using the SHA-256 algorithm in accordance with &nistfips180-2;.

 + +

This document adds the following terms to those defined in XEP-0045:

  • Firsthost -- The MUC service at which a room is created.
  • Peerhost -- Any MUC service (other than the firsthost) that hosts an instance of the room.
    • -
  • Shadow -- An instance of the room at a peerhost.
  • Source -- The canonical instance of the room at the firsthost.
    • +
  • Shadow -- An instance of the room at a peerhost.
 +

In this document, the examples use the following entities.

    -
  • Firsthost: firsthost.example.com
    • -
  • Peerhosts: peer1.example.net and peer2.example.org
    • -
  • Shadows: f609923deb78718a125b93d32609bd5265dd927242ac93a99eb366109df2bd39@peer1.example.net and f609923deb78718a125b93d32609bd5265dd927242ac93a99eb366109df2bd39@peer2.example.org
    • -
  • Source: f609923deb78718a125b93d32609bd5265dd927242ac93a99eb366109df2bd39@firsthost.example.com
    • +
  • Firsthost: chat.shakespeare.lit
    • +
  • Peerhosts: rooms.macbeth.lit and conference.marlowe.lit
    • +
  • Source: coven@chat.shakespeare.lit
    • +
  • Shadows: theroom@rooms.macbeth.lit and theroom@conference.marlowe.lit
 + + -

When the original room owner creates the room (or subsequently configures the room), the service MAY offer the option of making the room a "distributed room". This is done by including the "muc#roomconfig_distributed" feature in the room configuration form:

+

When the original room owner creates the room (or subsequently configures the room), the service MAY simply default all rooms to "distributed".

+

Alternatively, the server MAY offer the option of making the room a "distributed room". This is done by including the "muc#roomconfig_distributed" feature in the room configuration form:

@@ -120,9 +136,9 @@ ]]>

The room owner specifies a value of "1" or "true" &BOOLEANNOTE; if room distribution is desired:

@@ -140,23 +156,24 @@ ]]>

Alternatively, the firsthost can choose to perform room distribution in the background, rather than exposing the 'muc#roomconfig_distributed' option to the user.

 +

When a firsthost would like a peerhost to provide a shadow, it sends a replication request to the peerhost.

- + ]]>

If the peerhost is willing and able to replicate the room, it returns an IQ-result:

]]>

Several error cases are possible (the peerhost is resource constrained, the firsthost is forbidden to peer with the peerhost, etc.); these will be specified more fully in a future version of this specification.

@@ -168,9 +185,9 @@
  • The firsthost informs other peerhosts about the new peerhost.
    • @@ -183,147 +200,170 @@ ]]> ]]> - - - + + + ]]> ]]>

    The new shadow SHOULD request the room history. This is done by sending an IQ-get from the shadow to the source, containing a <history/> element qualified by the 'http://jabber.org/protocol/muc' namespace (the syntax and semantics of this element are described in XEP-0045).

    + id='theroom'> ]]>

    The history request MAY include any of the attributes specified in XEP-0045:: 'maxchars', 'maxstanzas', 'seconds', and 'since'.

    Message 1. Message 2. Message 3. ]]> ]]>

    The firsthost also informs other connected peerhosts about the new peerhost.

    - + ]]> ]]>     - -

    When a user attempts to join a source room, the firsthost determines if it will invite the user to join a shadow at a peerhost instead. The process for determining when to send invitations is implementation specific and might be subject to configuration at the firsthost (e.g., the firsthost might send invitations only to users of a domain associated with the peerhost and only after a certain number of such users have joined the room at the firsthost).

    -

    To begin, a user at the peerhost attempts to join the source room at the firsthost:

    - - - + + +

    XEP-0045 specifies that rooms can be found on a chat service using &xep0030;.

    +

    A user at a peerhost could send a service discovery items ("disco#items") request to the firsthost in order to find the source room. However, this introduces a dependency on communication with the firsthost, and we have stipulated that such communication might not be available.

    +

    Alternatively, the peerhost could keep a list of the shadow rooms that it hosts. From the perspective of the user at the peerhost, these rooms are local in the sense that the user can join the shadow and thereby interact with the occupants of the shadow (and, if server-to-server communication is working, with the occupants of the source). This approach is RECOMMENDED.

    +

    Note: If the peerhost frequently loses communications with the firsthost and the list of rooms located at the firsthost is large, the peerhost will want to use a more efficient method of synchronizing its room list than sending disco#items requests and receiving large disco#items results. However, methods for optimizing this synchronization process are out of scope for this specification.

    +

    To find rooms on the peerhost, the local user sends a "disco#items" request to the peerhost.

    + + + ]]> -

    The source room returns a <redirect/> presence error to the user and invites the user to join a shadow room instead.

    - - - peer1.example.net - - +

    The service returns a list of the public rooms it hosts, which includes any shadow rooms.

    + + + + + + + + ]]> -

    Then the source invites the user to the shadow using the protocol defined in &xep0249;.

    - - +

    The user can then send a disco#info request to each room. If the room is a shadow, the service MUST include extended information about the room using the &xep0128; format, specifically with a "http://jabber.org/protocol/muc#roominfo" FORM_TYPE and a (newly-defined) "dmuc-source" field.

    + + + + + + + http://jabber.org/protocol/muc#roominfo + + + coven@chat.shakespeare.lit + + + + ]]> -

    The user then joins the shadow.

    - This informs the user that the source room is "coven@chat.shakespeare.lit"; as a result, the user's client can trap any outbound requests destined for the source room (service discovery, room join, etc.) and redirect them to the shadow.

    +     + + +

    The process of joining a shadow is exactly as described in XEP-0045.

    + + from='somewitch@macbeth.lit/mobile' + to='coven@rooms.macbeth.lit/anotherwitch'> ]]>

    The shadow then informs the source (and any other shadows) of the user's presence; it does so by sending presence from the roomjid of the user at the shadow to a roomjid with the same roomnick at the source and shadow(s).

    + from='theroom@rooms.macbeth.lit/anotherwitch' + to='coven@chat.shakespeare.lit/anotherwitch'> @@ -331,40 +371,95 @@ ]]>

    The source then delivers that presence stanza to its local users. (Note: The shadow needs to send only one presence stanza to the source, thus reducing the number of stanzas sent over the server-to-server link between the peerhost and the firsthost.)

     + + +

    If there is no local shadow available at the peerhost, or if the peerhost does not support extended service discovery information as described above, then the local user at the peerhost will end up sending a join request to the source room instead of the shadow room.

    +

    When this happens, the firsthost determines if it will invite the user to join a shadow at a peerhost instead. The process for determining when to send invitations is implementation specific and might be subject to configuration at the firsthost (e.g., the firsthost might send invitations only to users of a domain associated with the peerhost and only after a certain number of such users have joined the room at the firsthost).

    +

    To begin, a user at the peerhost attempts to join the source room at the firsthost:

    + + + + ]]> +

    The source room returns a <redirect/> presence error to the user and invites the user to join a shadow room instead.

    + + + rooms.macbeth.lit + + + ]]> +

    Then the source invites the user to the shadow using the protocol defined in &xep0249;.

    + + + ]]> +

    The user then joins the shadow.

    + + + + ]]> +

    The shadow then informs the source (and any other shadows) of the user's presence; it does so by sending presence from the roomjid of the user at the shadow to a roomjid with the same roomnick at the source and shadow(s).

    + + + + + + ]]> +

    The source then delivers that presence stanza to its local users. (Note: The shadow needs to send only one presence stanza to the source, thus reducing the number of stanzas sent over the server-to-server link between the peerhost and the firsthost.)

    +     +

    When a user sends a message to an instance, the instance sends the message to its local occupants and to other instances.

    Message 4. ]]> Message 4. Message 4. ]]>

    The source then delivers that message stanza to its local users. (Note: The shadow needs to send only one message stanza to the source, thus reducing the number of stanzas sent over the server-to-server link between the peerhost and the firsthost.)

     +

    To follow.

     +     -

    If a MUC service supports distributed rooms, it MUST return a feature of "urn:xmpp:dmuc:0" &NSVER; in response to &xep0030; information requests.

    +

    If a MUC service supports distributed rooms, it MUST return a feature of "urn:xmpp:dmuc:0" &NSVER; in response to service discovery information requests.