From 325d912a1d18d8552664e07e52a99f539f89d21c Mon Sep 17 00:00:00 2001 From: Sam Whited Date: Fri, 4 Nov 2016 11:23:43 -0500 Subject: [PATCH] XEP-0369: Remove lots of whitespace errors --- xep-0369.xml | 395 ++++++++++----------------------------------------- 1 file changed, 72 insertions(+), 323 deletions(-) diff --git a/xep-0369.xml b/xep-0369.xml index 03b9fab5..bfbd9d56 100644 --- a/xep-0369.xml +++ b/xep-0369.xml @@ -9,9 +9,6 @@
Mediated Information eXchange (MIX) This document defines Mediated Information eXchange (MIX), an XMPP protocol extension for the exchange of information among multiple users through a mediating service. The protocol can be used to provide human group communication and communication between non-human entities using channels, although with greater flexibility and extensibility than existing groupchat technologies such as Multi-User Chat (MUC). MIX uses Publish-Subscribe to provide flexible access and publication, and uses Message Archive Management (MAM) to provide storage and archiving. - - - &LEGALNOTICE; 0369 Experimental @@ -39,9 +36,8 @@ Steve.Kille@isode.com &stpeter; - - 0.5 + 0.5 (XEP Editor: ssw) 2016-11-04 sek

@@ -59,7 +55,6 @@ Conversion 1:1

- 0.4 2016-09-21 @@ -187,58 +182,43 @@

- A MIX channel does not send messages and presence directly to an XMPP MIX client. Instead it sends them to a MIX Proxy, which runs on the server which a MIX client accesses. MIX clients MUST make use of a MIX Proxy. Use of a MIX proxy enables flexible support of multiple clients for an XMPP user. + A MIX channel does not send messages and presence directly to an XMPP MIX client. Instead it sends them to a MIX Proxy, which runs on the server which a MIX client accesses. MIX clients MUST make use of a MIX Proxy. Use of a MIX proxy enables flexible support of multiple clients for an XMPP user. The primary model is that a user will join a channel over an extended period, and that the user (not a specific client used by the user) joins the channel. The primary subscription is with the client's bare JID. The MIX channel will send messages and presences to the MIX Proxy using the bare JID. The MIX Proxy will then send the messages and presence information to zero or more clients. The MIX Proxy provides a number of functions.

  1. Each MIX client will register with the MIX Proxy when it comes online. A key benefit of this approach is that MIX messages will only be sent to clients that support MIX. This enables use of clients that do not use MIX in conjunction with the MIX proxy.
    2. -
  2. MIX Service and Channel subscription and management is handled through the MIX proxy so that the MIX Proxy can track all subscription changes and share subscription information between MIX clients. To achieve this, a MIX client sends these MIX management queries to the MIX Proxy using the clients full JID and receives responses back from the MIX Proxy. The MIX Proxy will communicate these requests to a MIX channel from the MIX using the user's bare JID. Because the MIX Proxy is aware of subscription information, it can provide integrated support to a set of MIX clients.
    3. -
  3. Messages from a MIX client to a MIX channel will go direct to the MIX service and not through the MIX Proxy.
    4. -
  4. Messages from a MIX channel to a MIX client MUST be handled by a MIX Proxy.
    5. -
  5. The MIX Proxy will only send messages to online clients and will discard messages if no clients are online. This means that a MIX client needs to resynchronize with the MIX service when it comes online. This synchronization will happen directly between the MIX client and MIX channel.
    6. -
  6. The MIX Proxy will know which channels are subscribed to, and so can send this list to a MIX client. Because channel subscriptions are long term, this information will be used instead of the bookmark approach used with MUC.
    7. -
  7. The MIX Proxy will manage channel registration and de-registration in the user's roster.
    8. -
  8. Different clients may wish to access different channels (e.g., a mobile client may only access a subset of the channels in which a user is interested). The MIX Proxy MAY handle sending messages only to the clients that wish for them, perhaps using a profile mechanism.
    9. -

Messages being sent from MIX channel to MIX Proxy (which will be of type=groupchat) and presence information are sent to the bare JID. This means that the MIX Proxy will use a modification of the standard &rfc6121; rules.

-

The MIX standard specifies how the MIX channel interacts directly with XMPP clients and with the MIX Proxy. -

-

The behaviour of a MIX Proxy and the protocol between MIX Proxy and MIX Client is not currently defined in this specification. It will be defined in one of three places. - It may be desirable in some situations to provide different service to different clients. For example, a mobile client may participate in a smaller set of MIX channels than a desktop client. This needs support from the server to which the client connects, so that MIX client and the connected server can negotiate which channels to send. This is not supported by the core MIX specification, but it is anticipated that this will be specified in one of the following ways: - + It may be desirable in some situations to provide different service to different clients. For example, a mobile client may participate in a smaller set of MIX channels than a desktop client. This needs support from the server to which the client connects, so that MIX client and the connected server can negotiate which channels to send. This is not supported by the core MIX specification, but it is anticipated that this will be specified in one of the following ways:

  1. In an extension to &xep0376; (PAM) which follows a model close to MIX Proxy; or
    2. -
  2. In a new XEP specifically to defined MIX Proxy behavior; or
    3. -
  3. As a new section in a future version of the MIX Specification.
-

- MIX channels store presence in the presence node using the proxy JID of each online client for a user. User presence may be included for all or selected clients of a given user, based on client choice to publish presence. Where a user publishes presence for multiple clients, this information is available to all users subscribing to the channel presence. + MIX channels store presence in the presence node using the proxy JID of each online client for a user. User presence may be included for all or selected clients of a given user, based on client choice to publish presence. Where a user publishes presence for multiple clients, this information is available to all users subscribing to the channel presence.

- External XMPP entities can direct stanzas to clients publishing their presence by sending them to the appropriate full proxy JID in the presence node. These stanzas MAY be routed to the client by the MIX channel. The choice to do this is dependent on MIX channel policy. For example, a disco request MAY be routed through the MIX channel to the client. + External XMPP entities can direct stanzas to clients publishing their presence by sending them to the appropriate full proxy JID in the presence node. These stanzas MAY be routed to the client by the MIX channel. The choice to do this is dependent on MIX channel policy. For example, a disco request MAY be routed through the MIX channel to the client.

Presence updates are distributed by a channel to the bare JID of subscribers and then the subscriber's server will distribute to each of the subscriber's currently online clients. @@ -246,8 +226,8 @@

- Private messages MAY be sent to channel participants if allowed by channel policy. Private messages are - addressed to the user's bare proxy JID determined from the participants node, and routed by the MIX to the user's bare real JID, where standard distribution rules will apply. + Private messages MAY be sent to channel participants if allowed by channel policy. Private messages are + addressed to the user's bare proxy JID determined from the participants node, and routed by the MIX to the user's bare real JID, where standard distribution rules will apply.

Private messages MAY also be sent to specific clients identified by the full proxy JID of the client in the participants list, if allowed by channel policy. @@ -260,10 +240,8 @@ -
ModeDescription
'JID Visible'In these channels, some or all participant JIDs are visible to all channel participants.
'JID Hidden'In these channels, no participant JIDs are visible to channel participants, but they are visible to channel administrators.
-

A channel participant may specify their preferences for JID visibility, with one of the following values:

@@ -274,7 +252,6 @@ 'Enforce Hidden'The user's JID will never be shown and the user will be removed from channel if channel administrator enforces visibility. 'Enforce Visible'The users JID will always be shown and the user will be removed from channel if mode is changed to 'JID Hidden'. -

The primary representation of a participant in a MIX channel is a proxy JID, which is an anonymized JID using the same domain as the channel and with the name of the channel encoded, using the format "<channel>+<generated identifier>@<mix domain>". They generated identifier MUST NOT contain the '+' characters. The Channel name MAY contain the '+' character. For example in the channel 'coven@mix.shakespeare.example', the user 'hag66@shakespeare.example' might have a proxy JID of 'coven+123456@mix.shakespeare.example'. The reason for the proxy JID is to support JID Hidden channels. Proxy JIDs are also used in JID Visible channels, for consistency and to enable switching of JID visibility. The "urn:xmpp:mix:nodes:jidmap" node maps from proxy JID to real JID. While a user is a participant in a Channel, the mapping between real JID and proxy JID MUST NOT be changed,

@@ -284,39 +261,25 @@

MIX defines a number standard nodes are as follows (although note that not every channel will necessarily use each node):

- - - - - - - - - -
NameNodeDescription
Messages'urn:xmpp:mix:nodes:messages'For publishing messages. Each item of this node will contain a message sent to the channel.
Subject'urn:xmpp:mix:nodes:subject'For publishing the subject of the channels
Participants'urn:xmpp:mix:nodes:participants'For publishing the list of participants (identified by anonymized bare proxy JID), and identifying the nick. This is a list of users who would receive messages (by subscription to the messages node) and/or would receive presence (by subscription to the presence node).
JID Map'urn:xmpp:mix:nodes:jidmap'For publishing a list of anonymized bare JIDs from the participants node with a 1:1 mapping to the corresponding real JIDs.
Presence'urn:xmpp:mix:nodes:presence'For publishing information about the availability status of online participants, which may include multiple clients for a single participant.
Information'urn:xmpp:mix:nodes:info'For storing general channel information, such as description.
Allowed'urn:xmpp:mix:nodes:allowed'For storing JIDs that are allowed to be channel participants.
Banned'urn:xmpp:mix:nodes:banned'For storing JIDs that are not allowed to be channel participants.
Configuration'urn:xmpp:mix:nodes:config'For storing channel configuration. This information will generally be restricted to the channel owners.
- -

All of the standard nodes are optional. A channel providing a service similar to MUC will typically use all of the standard nodes. MIX provides mechanisms to allow users to conveniently subscribe to a chosen set of nodes and to unsubscribe to all nodes with a single operation.

-

MIX also makes use of two nodes for support of Avatars. These nodes and their use is defined in &xep0084;. These nodes may be created as part of a MIX channel, where it is desired to publish an avatar associated with the channel.

- @@ -331,23 +294,16 @@

NameNodeDescription
Avatar Data'urn:xmpp:avatar:data'For publishing an Avatar
- - - - - -
RoleMembership and Rights
OwnersThese are owners of the list, as specified in the channel configuration node. Only owners are allowed to modify the channel configuration node.
AdministratorsAdministrators are defined in the channel configuration node. Administrators have update rights to the Allowed Node and Banned Node, so can control which users may participate in a channel.
ParticipantsParticipants are users listed by JID in the participants node.
AllowedAllowed is the set of JIDs that are participants or may be allowed to become participants. A JID is allowed if it does not match entry in the banned node and either it matches an entry in the allowed node or the allowed node is not present.
AnyoneAny user, including users in the banned node.

There will always be at lease one owner and "anyone" will always have role occupants. Other roles may not have any role occupants. Rights are defined in a strictly hierarchical manner, so that for example Owners will always have rights that Administrators have.

-

Items in this node will contain a message identified by a unique ID. A MIX implementation SHOULD NOT make messages available for retrieval from this node using pubsub. The recommended approach is that zero history is held in the messages node, and that this node is used for publication only. The recommended approach to retrieve message history is MAM. Users subscribe to this node to receive messages.

Private Messages are not stored in the messages node.

@@ -415,21 +371,16 @@

The Information node holds information about the channel. The information node contains a single item with the current information. Information node history is held in MAM. - - The information node is named by the date/time at which the item was created. Users MAY subscribe to this node to receive information updates. The Information node item may contain the following attributes, each of which is optional: -

+ The information node is named by the date/time at which the item was created. Users MAY subscribe to this node to receive information updates. The Information node item may contain the following attributes, each of which is optional: +

    -
  • 'Name'. A short string providing a name for the channel. The name and description values MUST contain a "text" element and MAY contain additional text elements. Where multiple text elements are provided, each MUST posses an xml:lang attribute that describes the natural language of the subject.
    • -
  • 'Description'. A longer description of the channel.
    • -
  • 'Contact'. The JID of the person or role responsible for the channel. This MAY be the JID of a MIX channel.
- -

The format of the Information node follows &xep0004;. This allows configuration to be updated by MIX defined commands and that the results of update commands are the same as the PubSub node. - The following example shows the format of a item in the information node for the example coven@mix.shakespeare.example channel. +

The format of the Information node follows &xep0004;. This allows configuration to be updated by MIX defined commands and that the results of update commands are the same as the PubSub node. + The following example shows the format of a item in the information node for the example coven@mix.shakespeare.example channel.

@@ -452,12 +403,10 @@ ]]> -

- This node represents a list of JIDs that are allowed to become participants. If the allowed node is not present, all JIDs are allowed. The allowed list is always considered in conjunction with the banned list, stored in the banned node. Only Administrators and Owners have write permission to the allowed node and are also the only roles that are allows to subscribe to this node. Each item contains a real bare JID. The following example shows how the allowed list can specify single JIDs and domains. + This node represents a list of JIDs that are allowed to become participants. If the allowed node is not present, all JIDs are allowed. The allowed list is always considered in conjunction with the banned list, stored in the banned node. Only Administrators and Owners have write permission to the allowed node and are also the only roles that are allows to subscribe to this node. Each item contains a real bare JID. The following example shows how the allowed list can specify single JIDs and domains.

- @@ -465,86 +414,49 @@ ]]> - -

- This node represents a list of JIDs that are explicitly not allowed to become participants. The values in this list take priority over values in the allowed node. Only Administrators and Owners have write permission to the allowed node and are also the only roles that are allows to subscribe to this node. Each item contains a real bare JID. - + This node represents a list of JIDs that are explicitly not allowed to become participants. The values in this list take priority over values in the allowed node. Only Administrators and Owners have write permission to the allowed node and are also the only roles that are allows to subscribe to this node. Each item contains a real bare JID.

- ]]> - - - - +

The Configuration node holds the configuration of the channel as a single item, named by the date-time of the last update to the configuration. A single item is stored in the node, with previous configuration history accessed by MAM. Users MAY subscribe to the configuration node to get notification of configuration change. The configuration node is optional for a MIX channel. For example, configuration choices could be fixed and not exposed. A subset of the defined configuration options may be used and additional non-standard configuration options may be added. If configuration options to control functionality of the nature described here are provided, the options defined in this standard MUST be used. The following configuration options are defined:

- - - - + - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionField TypeValuesDefault
'Last Change Made By'Bare JID of the user making the last change.jid-single--
'Owner'Dare JIDs with Owner rights as defined in ACL node. When a channel is created, the JID creating the channel is configured as an owner, unless this attribute is explicitly configured to another value.jid-multi--
'Owner'Dare JIDs with Owner rights as defined in ACL node. When a channel is created, the JID creating the channel is configured as an owner, unless this attribute is explicitly configured to another value.jid-multi--
'Administrator'Bare JIDs with Administrator rights.jid-multi--
'End of Life'The date and time at which the channel will be automatically removed by the server. If this is not set, the channel is permanent.text-single--
'Nodes Present'Specifies which nodes are present. Presence of config nodes is implicit. Jidmap node MUST be present if participants node is present. 'avatar' means that both Avatar Data and Avatar Metadata nodes are present.list-multi'participants'; 'presence'; 'subject'; 'information'; 'allowed'; 'banned'; 'avatar'-
'Message Node Subscription'Controls who can subscribe to messages node.list-single'participants'; 'allowed'; 'anyone''participants'
'Presence Node Subscription'Controls who can subscribe to presence node.list-single'participants'; 'allowed'; 'anyone''participants'
'Participants Node Subscription'Controls who can subscribe to participants node.list-single'participants'; 'allowed'; 'anyone'; 'nobody'; 'admins'; 'owners''participants'
'Subject Node Subscription'Controls who can subscribe to subject node.list-single'participants'; 'allowed'; 'anyone' 'participants'
'Information Node Subscription'Controls who can subscribe to the information node.list-single'participants'; 'allowed'; 'anyone''participants'
'Allowed Node Subscription'Controls who can subscribe to allowed node.list-single'participants'; 'allowed'; 'nobody'; 'admins'; 'owners' 'admins'
'Banned Node Subscription'Controls who can subscribe to banned node.list-single'participants'; 'allowed'; 'nobody'; 'admins'; 'owners' 'admins'
'Configuration Node Access'Controls who can subscribe to configuration node and who has read access to it.list-single'participants'; 'allowed'; 'nobody'; 'admins'; 'owners' 'owners'
'Information Node Update Rights'Controls who can make changes to the information nodelist-single'participants'; 'admins'; 'owners' 'admins'
'Avatar Nodes Update Rights'Controls who can make changes to the avatar data and metadata nodeslist-single'participants'; 'admins'; 'owners' 'admins'
'JID Visibility'Controls JID visibility in the channel.list-single'jid-hidden'; 'jid-optionally-visible'; 'jid-mandatory-visible''jid-hidden'
'Open Presence'If selected, any client may register presence. If not selected, only clients with bare JID in the participants list may register presence.boolean-false
'Participants Must Provide Presence'If selected, all channel participants are required to share presence information with the channel.boolean-false
'Allow User Message Retraction'If this option is selected users will be able to retract messages sent to the MIX channel.boolean-false
'Administrator Message Retraction Rights'This controls which group is able to retract messages sent to the MIX channel.list-single'nobody'; 'admins'; 'owners''owners'
'Participation Addition by Invitation from Participant'This option extends a channel so that a channel participant has rights to invite and enable other users as participants.boolean-false
'No Private Messages'If this option is selected, private messages may not be used with the channel.boolean-false
- -

- The configuration node is in &xep0004; format and includes all of the options used by the channel, including values for options using default values. This means that the value in the form can be directly mapped with the form returned by configuration administration commands. Configuration nodes will typically have a large number of elements. The following short example is provided to illustrate the syntax of the configuration node. + The configuration node is in &xep0004; format and includes all of the options used by the channel, including values for options using default values. This means that the value in the form can be directly mapped with the form returned by configuration administration commands. Configuration nodes will typically have a large number of elements. The following short example is provided to illustrate the syntax of the configuration node.

- - - @@ -569,15 +481,10 @@ - + ]]> - - - - -

The MIX standard allows channels to use non-standard nodes, using names that do no conflict with the standard nodes. The capabilities of these nodes may be specified in a future XEP or be for private agreement. Non-Standard nodes MUST NOT duplicate or otherwise provide capability that can be provided by standard nodes. @@ -587,11 +494,9 @@ -

An entity may discover a MIX service or MIX services by sending a Service Discovery items ("disco#items") request to its own server.

- ]]> - -

To determine if a domain hosts a MIX service, a &xep0030; info query should be sent in the usual manner to determine capabilities.

]]>

The MIX service then MUST return its identity and the features it supports, which MUST include the 'urn:xmpp:mix:0' feature, and the identity MUST have a category of 'conference' and a type of 'text'.

- A MIX service may return the following features:

-
  • 'urn:xmpp:mix:0': This indicates support of MIX, and is returned by all MIX services.
    • -
  • 'searchable': This is shown in the above example and indicates that a the MIX Service may be searched for channels. This presence of this feature can be used by a client to guide the user to search for channels in a MIX service.
    • -
  • 'create-channel': This is described in Checking for Permission to Create a Channel in support of channel administration. An end user client may need to create channels, perhaps for short term usage. This feature helps the client to identify an MIX channel to use. It enables a configuration where permanent (searchable) channels are placed in one MIX service and clients will be able to create channels in another MIX service which is not searchable.
-

A MIX service MUST NOT advertise support for &xep0313;, as MAM is supported by the channels and not by the service. A MIX service MUST NOT advertise support for generic &xep0060;, as although MIX makes use of PubSub it is not a generic PubSub service.

-

The list of channels supported by a MIX service is obtained by a disco#items command. The MIX server MUST only return channel that exist and that the user making the query has rights to subscribe to. This query MAY be made directly by and XMPP client or by a MIX Proxy.

- ]]> - -

In order to find out more information about a given channel, a user can send a disco#info query to the channel. This query MUST be made by a MIX Proxy and not the end client.

@@ -738,11 +632,8 @@ ]]> -

The Information Node contains various information about the channel that may be useful to the user. This can be read by the XMPP Client directly or by a MIX Proxy.

- - ]]> -

- Online clients in the channel are determined from the presence node. Participants in the channel are determined from the Participants Node which will give proxy JID and nick. The jidmap node is used to map to real JIDs. An operation is provided to list channel participants. For JID Hidden channels, only the nicks are returned. For JID Visible channels, nicks and real JIDs are returned.

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

Where a client supports MIX, it MUST advertise this capability in response to a Disco request. This will enable other entities to determine if a client supports MIX. The following example shows a Disco response from a client that supports both MIX and MUC.

- @@ -867,12 +750,8 @@ ]]> - - - -

- If a user cannot be subscribed to one or more of the requested nodes (e.g., because the node does not exist), but can be subscribed to some the response simply lists the nodes successfully subscribed. If none of the nodes requested are successfully subscribed to, an error response is sent indicating the reason that the first node requested was not subscribed to. This response will also include other nodes requested where subscription failed for the same reason. The following response example shows a response to the initial request example where + If a user cannot be subscribed to one or more of the requested nodes (e.g., because the node does not exist), but can be subscribed to some the response simply lists the nodes successfully subscribed. If none of the nodes requested are successfully subscribed to, an error response is sent indicating the reason that the first node requested was not subscribed to. This response will also include other nodes requested where subscription failed for the same reason. The following response example shows a response to the initial request example where the participant is not be subscribed to all nodes associated with the channel (in this case only messages, participants, and subject).

]]>

The user that has been added to the channel is identified by the item id of the item added to the pubsub node, which is the proxy JID of the new channel participant. Each <participant> element will include the nick of the user being added, which will be how the user will typically be shown in the channel.

-

A user may subsequently modify subscription to nodes in a channel by sending a subscription modification request, as shown in the following example.

- ]]> - - - -

- After the user has jointed the channel, the user's MIX Proxy MAY add the MIX channel to the user's roster using standard XMPP to update the roster. This is done to share the user's presence status with the channel and so the MIX channel will get presence information from the user. This roster entry will lead to the user's server correctly sending user's presence from all clients to the MIX channel. The roster subscription is configured with one way presence, as presence is sent to the MIX channel but no presence information is sent about the MIX channel. The user's MIX Proxy MUST remove this roster entry after the user leaves the channel. +

+ After the user has jointed the channel, the user's MIX Proxy MAY add the MIX channel to the user's roster using standard XMPP to update the roster. This is done to share the user's presence status with the channel and so the MIX channel will get presence information from the user. This roster entry will lead to the user's server correctly sending user's presence from all clients to the MIX channel. The roster subscription is configured with one way presence, as presence is sent to the MIX channel but no presence information is sent about the MIX channel. The user's MIX Proxy MUST remove this roster entry after the user leaves the channel.

-

If the user does not wish to publish presence information to the channel, the user will not add the roster entry. A channel may require presence to be provided by all channel participants, which is controlled by the 'Participants Must Provide Presence' option. The channel MAY check that channel participants have done this and MAY remove participants that do not do this.

-

A channel MAY publish an Avatar following &xep0084;. A client MAY make use of this information to associate an Avatar with the roster entry for a channel.

@@ -959,25 +831,19 @@ the participant is not be subscribed to all nodes associated with the channel (i The user may specify that no Private Messages are to be sent from the channel, and allow vCard retrieval.

- The user may specify that presence is not to be shared, which will prevent the MIX Channel from sending a presence probe for the user on channel start-up. The user will also choose to not include the MIX channel in the user's roster, so that presence will not be updated. Where the channel configuration sets 'Participants Must Provide Presence', this variable MUST be set to 'Share'. + The user may specify that presence is not to be shared, which will prevent the MIX Channel from sending a presence probe for the user on channel start-up. The user will also choose to not include the MIX channel in the user's roster, so that presence will not be updated. Where the channel configuration sets 'Participants Must Provide Presence', this variable MUST be set to 'Share'.

The following table sets out the standardized user preference values. A MIX implementation may use other values.

- - - -
Option ValuesDefault
'JID Visibility' 'Default', 'Never', 'Prefer Not' 'Use Channel Default'
'Private Messages''Allow', 'Block' 'Allow'
'vCard''Allow', 'Block' 'Block'
'Presence''Share', 'Not Share''Share'
-

When joining a channel, the client may specify one or more preference options as a &xep0004; form. In the response, the server MUST specify all of the user preferences supported by the server, with default values if the user has not requested a different value. The following example shows joining a channel and setting a preference.

- ]]> -

The client may also query the channel in order to find out which user preferences are supported and the options available. This will allow users to set options not specified in the standard, by providing a form template in the result.

- + ]]> -

A user may modify preferences using the corresponding set operation. The set may specify values for some or all attributes. All attributes are returned in the result.

- - The user explicitly sets the nick, as described in this section.
  • The MIX service generates the nick. In this case it is recommended that the assigned nick is a UUID following &rfc4122;.
    • -

    A user will typically set a nick when joining a channel and may update this nick from time to time. The user does this by sending a command to the channel to set the nick. If the user wishes the channel to assign a nick (or knows that the channel will assign a nick) the nick field can be left blank, so that the user can see what is assigned in the result.

    @@ -1218,7 +1079,6 @@ the participant is not be subscribed to all nodes associated with the channel (i

    MIX services SHOULD apply the "nickname" profile of the PRECIS OpaqueString class, as defined in &rfc7700;.

    - dnd Making a Brew ]]> -

    The user's presence information is then published by the service to the "urn:xmpp:mix:nodes:presence" node, with the 'publisher' attribute set to the user's participant identifier (the proxy JID. The MIX channel then broadcasts the presence change to all users who are subscribed to the "urn:xmpp:mix:nodes:presence" node. The presence stanza is sent from the proxy (anonymized) full JID of the user. +

    The user's presence information is then published by the service to the "urn:xmpp:mix:nodes:presence" node, with the 'publisher' attribute set to the user's participant identifier (the proxy JID. The MIX channel then broadcasts the presence change to all users who are subscribed to the "urn:xmpp:mix:nodes:presence" node. The presence stanza is sent from the proxy (anonymized) full JID of the user. Note that presence is associated with a client and so will have a full JID as it comes directly from the client and not through the MIX Proxy.

    Harpier cries: 'tis time, 'tis time. ]]> - -

    The MIX channel then puts a copy of the message into the MAM archive for the channel and sends a copy of the message to each participant in +

    The MIX channel then puts a copy of the message into the MAM archive for the channel and sends a copy of the message to each participant in standard groupchat format. These messages sent by the channel are addressed to the bare JID of each participant and this will be handled by the participant's MIX Proxy. The message from value is the full Proxy JID of the message sender. The id of the message is the ID from the MAM archive.

    - Harpier cries: 'tis time, 'tis time. ]]> -

    The messages sent to participants have a different message id to the originally submitted message. This does not impact most recipients, but it does not allow the message originator to correlate the message with the submitted message. To address this the MIX channel MUST include an additional element of the message copy going back to the originator's bare JID that includes the original id. This enables the originator to correlate the received message with the message submitted.

    - - Harpier cries: 'tis time, 'tis time. 92vax143g -]]> - - +]]>

    A MIX channel MAY support message retraction, where the sender of a messages or an administrator deletes a message. If this is done the original message MUST be replaced by a tombstone. The protocol to request retraction does this by a message with a <retract> element as shown in the following example.

    - - -]]> - +]]>

    The MIX channel will allow a user to retract a message sent by the user if the 'Allow User Message Retraction' option is configured. The MIX channel will allow a user to retract any message if the user is in the group specified by the 'Administrator Message Retraction Rights' option.

    @@ -1401,7 +1251,6 @@ the participant is not be subscribed to all nodes associated with the channel (i

    When a message is retracted the original message <body> MUST be removed and MUST be replaced with a tombstone using the <retracted> element that shows the JID of user performing the retraction and the time of the retraction.

    - @@ -1413,13 +1262,8 @@ the participant is not be subscribed to all nodes associated with the channel (i -]]> - - - +]]>     - -

    Setting the subject for a channel follows a similar procedure to sending a message. An XMPP client will send a message setting the subject directly to the MIX channel. @@ -1436,7 +1280,7 @@ the participant is not be subscribed to all nodes associated with the channel (i -]]> +]]>

    This message is received by the MIX channel, which will set the Subject Node for the channel, and then distribute the message to participants that are subscribed to the Subject Node, with the message addressed to the MIX Proxy.

    @@ -1452,22 +1296,18 @@ the participant is not be subscribed to all nodes associated with the channel (i -]]> +]]>

    When a new Participant joins a channel and subscribes to the Subject Node, the channel MUST send to the user's MIX Proxy a message with the current subject. An XMPP Client MAY directly read the Subject node using &xep0060;.

    -

    - A convenient way to reference another channel is to use &xep0372; which enables the JID of a channel to be shared. This might be used simply to inform the message recipient about the channel or as mechanism to invite the user to join the channel. This is useful as an invitation mechanism to a channel that any user can join or where the invitee knows that the user may join (e.g., because the channel is for all users in an organization). + A convenient way to reference another channel is to use &xep0372; which enables the JID of a channel to be shared. This might be used simply to inform the message recipient about the channel or as mechanism to invite the user to join the channel. This is useful as an invitation mechanism to a channel that any user can join or where the invitee knows that the user may join (e.g., because the channel is for all users in an organization).

    -

    Invitation by reference, as described in the previous section, is a convenient approach to invite a user to join a channel that the user has permission to join. This section describes the approach used when the inviter has permission to grant rights for the invitee to become a channel participant. This might be because the inviter is an administrator of the channel or the channel may have a special mode where channel participants may grant rights for other users to join a channel ('Participation Addition by Invitation from Participant' enabled). This approach is used to avoid cluttering the allowed node with JIDs of users who are invited to join, but do not accept the invitation. - - When a channel participant(the inviter) invites another user (the invitee) to join a channel, the following sequence of steps is followed:

    @@ -1478,10 +1318,9 @@ the participant is not be subscribed to all nodes associated with the channel (i
  • The invitee MAY use the invitation to join the channel.
  • The invitee MAY send a response to the inviter, indicating if the invitation was accepted or declined.
    • -

    +

    The first step is for the inviter to request an invitation from the channel. The invitation contains inviter, invitee and a token. The channel will evaluate if the inviter has rights to issue the invitation. This will be because the inviter is a channel administrator or if the inviter is a channel participant and the channel has 'Participation Addition by Invitation from Participant' mode enable. If the inviter has rights to make the invitation, the channel will return a token. The token is a string that the channel can subsequently use to validate an invitation. The format of the token is not specified in this standard. The encoded token MAY reflect a validity time.

    - ABCDEF -]]> - +]]>

    The inviter can now send the invitee a message containing the invitation, as shown in the following example.

    - Would you like to join the coven? - + hag66@shakespeare.lit cat@shakespeare.lit coven@mix.shakespeare.lit ABCDEF -]]> - - -

    The invitation can now be used by the invitee to join a channel. The invitation is simply added to the standard channel join, so that the channel can validate the invitation using the token. If the allowed node is present and the invitee is not matched against any item, the channel MUST add the invitee to the allowed node as part of the join.

    - - +]]> +

    The invitation can now be used by the invitee to join a channel. The invitation is simply added to the standard channel join, so that the channel can validate the invitation using the token. If the allowed node is present and the invitee is not matched against any item, the channel MUST add the invitee to the allowed node as part of the join.

    - + hag66@shakespeare.lit cat@shakespeare.lit coven@mix.shakespeare.lit @@ -1544,14 +1377,12 @@ the participant is not be subscribed to all nodes associated with the channel (i ]]> -

    The invitee may send an acknowledgement back to the inviter, noting the status of the invitation. Values are:

    • 'Joined': The invitee has joined the channel.
    • 'Declined': The invitee is not taking up the invitation.
    • 'Acknowledged': The invitation is acknowledged, without information on action taken or planned.
    - No Thanks - too busy chasing mice.... Declined - + hag66@shakespeare.lit cat@shakespeare.lit coven@mix.shakespeare.lit @@ -1567,8 +1398,7 @@ the participant is not be subscribed to all nodes associated with the channel (i -]]> - +]]>     @@ -1577,20 +1407,15 @@ the participant is not be subscribed to all nodes associated with the channel (i

    Private Messages are used to provide communication with another channel participant through the MIX channel, without the initiating user knowing the real JID of the channel participant. A channel MAY support use of Private Messages. Private messages are standard XMPP messages. A message goes through a number of stages with different addressing. This is set out in the following table.

    - - - - -
    MessageFromTo
    First Message from Client to MIX ChannelFull JID of initiator's clientProxy bare JID of responder
    First Message from MIX Channel to responder's MIX ProxyProxy full JID of initiator's clientBare JID of responder
    First Message from responder's MIX Proxy to one or more of the responder's clientsProxy full JID of initiatorFull JID of responder's client
    Messages from responder's client to MIX ChannelFull JID of responder's clientProxy full JID of initiator's client
    Messages from MIX channel to initiator's clientProxy full JID of responder's clientFull JID of initiator's client
    Messages from initiator's client to MIX ChannelFull JID of initiator's clientProxy full JID of responder's client
    Message from MIX Channel to responder's clientProxy full JID of initiator's clientFull JID of responder's client

    Private Messages MAY be archived using MAM by the XMPP servers associated with initiator and responder. Private Messages MUST NOT be archived by the MIX channel.

    @@ -1599,10 +1424,6 @@ the participant is not be subscribed to all nodes associated with the channel (i

    A user may request the vCard of a channel participant by sending a request through the channel. The request may be sent directly by the client or through a MIX Proxy. The MIX channel MAY pass this request on or may block it. In the following example, the requesting client sends a message to the anonymized bare JID of the channel participant for which the vCard is desired.

    - - - - ]]>

    The MIX channel MAY pass on the vCard request or may reject with an error, dependent on channel policy. The MIX service will then address the vCard request to the MIX proxy (bare JID) using an anonymous full proxy JID to hide the requester.

    - -]]> - +]]>

    The MIX Proxy, on behalf of the user, MAY send a response or reject with an error. The MIX Proxy will send the vCard back to the channel. -

    +

    stpeter http://www.xmpp.org/xsf/people/stpeter.shtml - ]]> -

    The MIX channel will then send the vCard response to the requesting client on behalf of the client sending the response.

    - stpeter http://www.xmpp.org/xsf/people/stpeter.shtml - + ]]> - -     @@ -1676,15 +1490,13 @@ the participant is not be subscribed to all nodes associated with the channel (i For an active MIX Channel, the presence node is updated as channel participants change status and presence information is sent to the channel. When a MIX channel starts, typically when the associated MIX Service and Server start, there is a need to initialize the presence node. This is done by the XMPP server associated with the MIX channel sending out a presence probe for each channel participant, following the presence probe process specified in &rfc6121;. A presence probe MUST NOT be sent for users who have set presence preference to not sharing.

    -

    It is important that messages are all transferred from the MIX channel to the server associated with the each channel participant. Transfer between servers will typically happen quickly and &xep0198; will deal with short connection failures between servers. Longer connection failures could lead to message loss. This would lead to online users (who remain connected to their servers) missing messages, and to messages being missed out of the user archive. This section describes how MIX addresses this.

    - When there is a long term connection failure, the MIX channel will receive an error from the XMPP server indicating that a message failed to transfer to a recipient. When this happens, the MIX channel must take responsibility to ensure that the message is retransmitted and delivered. When the MIX channel detects a failure it will make use of an IQ Marker message to determine when the connection to the peer server is working again. Once the channel has received a response to the marker IQ it will retransmit the pending messages. + When there is a long term connection failure, the MIX channel will receive an error from the XMPP server indicating that a message failed to transfer to a recipient. When this happens, the MIX channel must take responsibility to ensure that the message is retransmitted and delivered. When the MIX channel detects a failure it will make use of an IQ Marker message to determine when the connection to the peer server is working again. Once the channel has received a response to the marker IQ it will retransmit the pending messages.

    - All messages sent to a MIX channel MUST be archived using MAM in association with the MIX channel. All messages MUST also be archived on the server associated with each channel participant receiving the message, which enables clients to always retrieve messages from the clients MAM archive. Other channel nodes MAY be archived.

    -

    Messages sent to participants MUST be archived by both the MIX channel and by the user's server. This MUST include messages setting subject and MAY include presence messages. Correct MIX operation relies on messages being archived.

    -

    Clients will retrieve MIX messages using standard MAM protocol from the user's archive. The MAM query will filter based on the channel JID to enable access to messages from a given channel. This gives the user a simple mechanism to access all messages sent to the channel. MAM can be used to retrieve older messages that have not been cached by the client.

    - Messages may also be retrieved from the channel by addressing MAM queries to the channel JID. This will behave like a standard MAM archive. This can be useful for administrators to access archived messages. It can also be useful for new channel participants to access the historical archives. + Messages may also be retrieved from the channel by addressing MAM queries to the channel JID. This will behave like a standard MAM archive. This can be useful for administrators to access archived messages. It can also be useful for new channel participants to access the historical archives.

    - - -

    - A MIX Channel MAY use MAM to archive nodes other than message nodes. Clients with rights to access these archives may use MAM to do this, specifying the PubSub node in the MAM query addressed to the channel. + A MIX Channel MAY use MAM to archive nodes other than message nodes. Clients with rights to access these archives may use MAM to do this, specifying the PubSub node in the MAM query addressed to the channel.

    @@ -1737,9 +1544,8 @@ the participant is not be subscribed to all nodes associated with the channel (i

    - MIX does not standardize an access control model for creating and deleting MIX channels. The choice is left to the MIX implementer, and could be a very simple or complex approach. A client can determine if it has permission to create a channel on a MIX service, which may be used to control options presented to the user. This is achieved by a disco command on the MIX service. If the 'create-channel' feature is returned, the user is able to create a channel. + MIX does not standardize an access control model for creating and deleting MIX channels. The choice is left to the MIX implementer, and could be a very simple or complex approach. A client can determine if it has permission to create a channel on a MIX service, which may be used to control options presented to the user. This is achieved by a disco command on the MIX service. If the 'create-channel' feature is returned, the user is able to create a channel.

    - ]]>     - - -

    A client creates a channel by sending a simple request to the MIX service. A channel may be created with default parameters, as shown in the following example. The result MUST include the name of the channel which MUST match the channel name in the request (if present). @@ -1785,11 +1588,9 @@ A client creates a channel by sending a simple request to the MIX service. A c ]]> -

    The client may also include parameters in &xep0004; format as part of channel creation. If the client wishes to inspect configuration, channel administration procedures should be used.

    - - + ]]>     @@ -1850,12 +1651,10 @@ A client creates a channel by sending a simple request to the MIX service. A c ]]>     -

    - A common use case for an ad hoc channel is where two users are engaged in a 1:1 chat and wish to broaden the discussion. Prior to bringing more users into a channel, using standard invitation process, there is a need to move a dialogue. The first step is for one of the two users to create an ad hoc channel, as described in the previous section. The other user will then be invited, and can switch to the new channel. It may also be useful to share some or all of the messages from the 1:1 discussion into the new channel. This is done by sending these messages to the channel. These messages are marked as <resend> which includes the original message time to facilitate appropriate display. + A common use case for an ad hoc channel is where two users are engaged in a 1:1 chat and wish to broaden the discussion. Prior to bringing more users into a channel, using standard invitation process, there is a need to move a dialogue. The first step is for one of the two users to create an ad hoc channel, as described in the previous section. The other user will then be invited, and can switch to the new channel. It may also be useful to share some or all of the messages from the 1:1 discussion into the new channel. This is done by sending these messages to the channel. These messages are marked as <resend> which includes the original message time to facilitate appropriate display.

    - ]]> -

    - MIX channels are always explicitly destroyed by an owner of the channel or by a server operator. There is no concept of temporary channel, equivalent to &xep0045; temporary room which is automatically destroyed by the server when the users leave. However, channels MAY be configured with an explicit lifetime, after which the channel MUST be removed by the MIX server. Where a channel is created for ad hoc use, it may be desirable to keep the channel for history reference or for re-use by the same set of users. Note that the owner of the channel does not need to have presence registered in the channel in order to destroy it. + MIX channels are always explicitly destroyed by an owner of the channel or by a server operator. There is no concept of temporary channel, equivalent to &xep0045; temporary room which is automatically destroyed by the server when the users leave. However, channels MAY be configured with an explicit lifetime, after which the channel MUST be removed by the MIX server. Where a channel is created for ad hoc use, it may be desirable to keep the channel for history reference or for re-use by the same set of users. Note that the owner of the channel does not need to have presence registered in the channel in order to destroy it.

    -

    - A client destroys a channel using a simple set operation, as shown in the following example. + A client destroys a channel using a simple set operation, as shown in the following example.

    - - + ]]> -     -

    A server MUST destroy a channel that has exceeded its specified explicit lifetime. Servers may destroy channels which have no participants and/or presence according to local policy. There will often be good reasons to not destroy rooms in these scenarios, in particular to facilitate channel re-use and history access. -

    -     -

    Authorized users, typically owners and sometimes administrators, may modify the channel information. The client MAY issue a get command to obtain a form that will facilitate update of the information node. The values in the form show current values, which be defaults or may have been explicitly set. In the following example, the channel name was previously set, but other values were not.

    - - + ]]> -

    Updating the information node is done using a set command of type info. The MIX channel MUST update the fields with values provided, leaving other fields unchanged. The result returns the id used in the information node item, which is the date/time of the modification.

    - - - + ]]>     - - - -

    Channel owners may modify the channel configuration. The client MAY issue a get command "config" to obtain a form that will facilitate update of the configuration node. Other clients MAY be authorized to use this command to see the channel configuration, but only owners may update the configuration. The values in the form show current values, which be defaults or may have been explicitly set. The following example shows a short form returned to illustrate the syntax. A typical configuration form will be much larger with many fields.

    - - + ]]> -

    Updating the information node is done using a set command of type config. The MIX channel MUST update the fields with values provided, leaving other fields unchanged. The result returns the id used in the configuration node item, which is the date/time of the modification.

    - - - + ]]>     - -

    - Owners and Administrators may control which users can participate in a channel by use of Allowed and Banned lists using PubSub. These operations follow &xep0060; which sets out detailed protocol use and error handling. + Owners and Administrators may control which users can participate in a channel by use of Allowed and Banned lists using PubSub. These operations follow &xep0060; which sets out detailed protocol use and error handling. Allowed and Banned lists may be read by PubSub get of the Banned and Allowed Nodes. This operation may be used by users as controlled by 'Allowed Node Subscription' and 'Banned Node Subscription' configuration node options (default Administrators).

    - + @@ -2069,18 +1846,16 @@ A client creates a channel by sending a simple request to the MIX service. A c to='hag66@shakespeare.example/intibo24' type='result'> - + - - + + ]]> -

    - JIDs can be added to the Allowed and Banned nodes by a pubsub set command. This is used to add one item to a node. + JIDs can be added to the Allowed and Banned nodes by a pubsub set command. This is used to add one item to a node.

    - - + ]]> - -

    JIDs can be removed from the Allowed and Banned nodes by pubsub retract command.

    - - - - + @@ -2125,14 +1895,12 @@ A client creates a channel by sending a simple request to the MIX service. A c to='hag66@shakespeare.example/intibo24' type='result'> - + ]]> -

    - When the MIX channel adds a JID to the banned node, other nodes in the MIX channel will be appropriately updated to reflect this change. In particular, the participants nodes and presence nodes will be updated to remove matching JIDs. This will have the effect of immediately removing the user from the channel. For this reason, there is no requirement to have the "kick" functionality of MUC, as this is achieved by banning the user. + When the MIX channel adds a JID to the banned node, other nodes in the MIX channel will be appropriately updated to reflect this change. In particular, the participants nodes and presence nodes will be updated to remove matching JIDs. This will have the effect of immediately removing the user from the channel. For this reason, there is no requirement to have the "kick" functionality of MUC, as this is achieved by banning the user.

    - -     +     @@ -2145,14 +1913,10 @@ A client creates a channel by sending a simple request to the MIX service. A c

    1. Entirely separate MIX and MUC implementation, with MIX and MUC using separate domains and MIX channels being completely separate from MUC rooms.
      2. -
    2. Fully integrated MIX and MUC implementation, with MIX and MUC sharing a single domain and rooms/channels equivalent.
      3. -
    3. Partially integrated MIX and MUC implementation, with MIX and MUC using separate domains, but rooms/channel are common. This means that each MIX channel will have MUC room of the same name and same participants.
    -

    The fully integrated approach would be transparent to clients. Disco of a room or channel would show support for both MUC and MIX, which would enable a client to choose whether to use MUC or MIX. The following example shows how a MIX service that also supported MUC would respond:

    - ]]> - -

    For the partially integrated service, it will be useful for clients that support both MIX and MUC to be able to determine that the server supports both protocols. For a MIX client, it will be useful to know the MUC service, so that this information can be shared with a MUC client invitation. This information is provided by the initial service discovery:

    - - ]]> -

    The result is returned in an extended disco results in a form whose type value is 'urn:xmpp:mix:0#serviceinfo'. The field with var='muc-mirror' is the value of which is the mirrored MUC domain's JID.

    -

    Where a client supporting both MIX and MUC is given a reference to a MUC room, it is desirable that the client can determine the MIX channel and join using MIX. This is achieved by an equivalent extension to MUC service discover.

    - - + urn:xmpp:mix:0#serviceinfo @@ -2231,16 +1988,12 @@ A client creates a channel by sending a simple request to the MIX service. A c ]]> -

    The result is returned in an extended disco results in a form whose type value is 'urn:xmpp:mix:0#serviceinfo'. The field with var='mix-mirror' is the value of which is the mirrored MIX domain's JID.

    -

    - Where a client supports MUC and MIX and has determined that for a channel that the server also supports a MUC room, the client has a choice as to which type of invite to send. This SHOULD be done by determining if the client support MIX using the mechanism specified in - Discovering Client MIX Capability. If the client supports MIX a MIX invite SHOULD be sent. - + Where a client supports MUC and MIX and has determined that for a channel that the server also supports a MUC room, the client has a choice as to which type of invite to send. This SHOULD be done by determining if the client support MIX using the mechanism specified in + Discovering Client MIX Capability. If the client supports MIX a MIX invite SHOULD be sent.

    -     @@ -2260,14 +2013,10 @@ A client creates a channel by sending a simple request to the MIX service. A c &xep0045; provides a mechanism to control access to MUC rooms using passwords. An equivalent mechanism is not included in MIX, as it has a number of security issues. Control of access to channels is better achieved using an explicit list of participants.

    - - -

    &xep0045; defines a mechanism so that MUC moderators can control who is able to send messages to a MUC room using a "voice" mechanism. The current version of MIX does not include this. This might be added to a future version of this XEP or as a separate XEP if this capability becomes an agreed requirement.

    -