From c8aca67bc7c1ed2b7d0fbd33c62bc5e7d0aafb12 Mon Sep 17 00:00:00 2001 From: Peter Saint-Andre Date: Fri, 12 Mar 2010 17:04:29 +0000 Subject: [PATCH] 1.0 DRAFT git-svn-id: file:///home/ksmith/gitmigration/svn/xmpp/trunk@4074 4b5297f7-1745-476d-ba37-a9c6900126ab --- xep-0227.xml | 194 ++++++++++++++++++++++++++++----------------------- 1 file changed, 107 insertions(+), 87 deletions(-) diff --git a/xep-0227.xml b/xep-0227.xml index d0d41209..5aa40e7c 100644 --- a/xep-0227.xml +++ b/xep-0227.xml @@ -10,8 +10,7 @@ This document specifies a file format for importing and exporting user data to and from XMPP-IM servers. &LEGALNOTICE; 0227 - Proposed - 2009-11-06 + Draft Standards Track Standards Council @@ -22,7 +21,10 @@ - TO BE ASSIGNED + pie + + http://xmpp.org/schemas/pie.xsd + Magnus Henoch @@ -35,6 +37,12 @@ waqas20@gmail.com waqas@jaim.at + + 1.0 + 2010-03-12 + psa +

Per a vote of the XMPP Council, advanced specification from Experimental to Draft; simultaneously the XMPP Registrar issued a namespace of "urn:xmpp:pie:0".

 + 0.3 2009-10-16 @@ -100,11 +108,11 @@ -

Data is contained in an XML document, whose root element is <server-data/> qualified by the 'http://www.xmpp.org/extensions/xep-0227.html#ns' namespace &NSNOTE;.

+

Data is contained in an XML document, whose root element is <server-data/> qualified by the 'urn:xmpp:pie:0' namespace &NSNOTE;.

- + [ ... ] ]]> @@ -114,30 +122,30 @@

At any point in the file, an exporting server may put an XInclude <include/> element; see Use of XInclude.

- -

The child elements of the <server-data/> elements are <host/> elements. Each <host/> element describes a virtual host, and has a 'jid' attribute that contains its JID.

+ +

The child elements of the <server-data/> elements are <host/> elements. Each <host/> element describes a virtual host, and has a 'jid' attribute that contains its JID.

-

An importing server MAY automatically adjust its list of virtual hosts to fit the ones present in the data being imported. If it does not, it SHOULD notify the operator about any mismatch.

+

An importing server MAY automatically adjust its list of virtual hosts to fit the ones present in the data being imported. If it does not, it SHOULD notify the operator about any mismatch.

- - + [ ... ] [ ... ] - ]]> - - + + ]]> + - -

Each user is represented by a <user/> element under the <host/> element. The <user/> element MUST have a 'name' attribute, which contains the node part of the user's JID, and SHOULD have a 'password' attribute, which contains the user's password.

+ +

Each user is represented by a <user/> element under the <host/> element. The <user/> element MUST have a 'name' attribute, which contains the node part of the user's JID, and SHOULD have a 'password' attribute, which contains the user's password.

- - + [ ... ] @@ -149,15 +157,15 @@ ]]> - - + + - -

Each <user/> element SHOULD contain the user's roster in the form of a <query/> element qualified by the 'jabber:iq:roster' namespace. This element contains the user's roster in the same format as when retrieving the roster from the server, as described in section 7.3 of &xmppim;.

+ +

Each <user/> element SHOULD contain the user's roster in the form of a <query/> element qualified by the 'jabber:iq:roster' namespace. This element contains the user's roster in the same format as when retrieving the roster from the server, as described in section 7.3 of &xmppim;.

- - + @@ -169,16 +177,16 @@ - ]]> - - + + ]]> + - -

If the exporting server stores messages received while the user was offline, it SHOULD include an <offline-messages/> element as a child of the <user/> element. This element contains all the stored messages to the user, if any, as <message/> elements qualified by the 'jabber:client' namespace, starting with the oldest.

+ +

If the exporting server stores messages received while the user was offline, it SHOULD include an <offline-messages/> element as a child of the <user/> element. This element contains all the stored messages to the user, if any, as <message/> elements qualified by the 'jabber:client' namespace, starting with the oldest.

- - + @@ -196,16 +204,16 @@ - ]]> - - + + ]]> + - -

Private data stored by the server as specified in &xep0049; is represented in this format by including a <query/> element qualified by the 'jabber:iq:private' namespace as a child of the <user/> element. This <query/> element in turn contains all elements saved in private XML storage.

+ +

Private data stored by the server as specified in &xep0049; is represented in this format by including a <query/> element qualified by the 'jabber:iq:private' namespace as a child of the <user/> element. This <query/> element in turn contains all elements saved in private XML storage.

- - + @@ -215,16 +223,16 @@ - ]]> - - + + ]]> + - -

By &xep0054;, users can store vCards on the server. In this specification, vCards are child elements of the <user/> element, namely a <vCard/> element qualified by the 'vcard-temp' namespace.

+ +

By &xep0054;, users can store vCards on the server. In this specification, vCards are child elements of the <user/> element, namely a <vCard/> element qualified by the 'vcard-temp' namespace.

- - + @@ -232,16 +240,16 @@ - ]]> - - + + ]]> + - -

Privacy lists, as specified in &xep0016;, are represented in this format by including a <query/> element qualified by the 'jabber:iq:privacy' namespace as a child of the <user/> element. This element should contain all privacy lists associated with the user. A default privacy list, if set, is specified by including a <default/> element as a child of the <query/> element.

+ +

Privacy lists, as specified in &xep0016;, are represented in this format by including a <query/> element qualified by the 'jabber:iq:privacy' namespace as a child of the <user/> element. This element should contain all privacy lists associated with the user. A default privacy list, if set, is specified by including a <default/> element as a child of the <query/> element.

- - + @@ -263,16 +271,16 @@ - ]]> - - + + ]]> + - -

Each <user/> element SHOULD contain pending incoming subscription requests associated with the user's account. Incoming subscription requests are represented by including <presence/> elements qualified by the 'jabber:client' namespace with the 'type' attribute set to a value of 'subscribe' as children of the <user/> element.

+ +

Each <user/> element SHOULD contain pending incoming subscription requests associated with the user's account. Incoming subscription requests are represented by including <presence/> elements qualified by the 'jabber:client' namespace with the 'type' attribute set to a value of 'subscribe' as children of the <user/> element.

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

An exporting server may split the data in several files by using the XInclude <include/> element. An importing server MUST support <include/> elements having an 'href' attribute containing a relative URI, having no 'parse' attribute, and having no 'xpointer' attribute; it MAY support other kinds of <include/> elements. An exporting server SHOULD NOT include and an importing server SHOULD NOT process <include/> elements which are descendants, but not children of the <user/> element (since these may be part of user data).

- -

If an exporting server chooses to split the data into several files, it SHOULD use the following scheme:

+ +

If an exporting server chooses to split the data into several files, it SHOULD use the following scheme:

-

The main file contains the <server-data/> element, which contains nothing but one <include/> element for each host. The file included for a certain host is placed in the same directory as the main file, and is named by appending ".xml" to the JID of the host, e.g. "capulet.com.xml".

+

The main file contains the <server-data/> element, which contains nothing but one <include/> element for each host. The file included for a certain host is placed in the same directory as the main file, and is named by appending ".xml" to the JID of the host, e.g. "capulet.com.xml".

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

Each host file contains a <host/> element, which contains nothing but one <include/> element for each user of the host. The file included for a certain user is placed in a subdirectory whose name is the JID of the host, and is named by appending ".xml" to the node part of the user's JID, e.g. "capulet.com/juliet.xml".

+

Each host file contains a <host/> element, which contains nothing but one <include/> element for each user of the host. The file included for a certain user is placed in a subdirectory whose name is the JID of the host, and is named by appending ".xml" to the node part of the user's JID, e.g. "capulet.com/juliet.xml".

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

Each user file contains a <user/> element, and includes all data relating to that user.

-

Each user file contains a <user/> element, and includes all data relating to that user.

- - - ]]> - + -

The definition of JIDs ensures that this generates valid file names on traditional Unix-like file systems, except for possible length constraints. However, various constraints may force an exporting server to alter this scheme. In any case, the importing server MUST NOT rely on this layout, but MUST do proper XInclude processing.

- +

The definition of JIDs ensures that this generates valid file names on traditional Unix-like file systems, except for possible length constraints. However, various constraints may force an exporting server to alter this scheme. In any case, the importing server MUST NOT rely on this layout, but MUST do proper XInclude processing.

+ + -

Exported data files are to be handled with care, since they contain data that users expect to be protected, in particular passwords. An exporting server SHOULD make sure that the generated file is not accessible to unauthorized persons, e.g. by enforcing strict file permissions.

-

XInclude <include/> elements which are indirect descendants of the <user/> element SHOULD be treated as opaque user data, and SHOULD NOT be processed.

+

Exported data files are to be handled with care, since they contain data that users expect to be protected, in particular passwords. An exporting server SHOULD make sure that the generated file is not accessible to unauthorized persons, e.g. by enforcing strict file permissions.

+

XInclude <include/> elements which are indirect descendants of the <user/> element SHOULD be treated as opaque user data, and SHOULD NOT be processed.

 -

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

+

This document requires no interaction with &IANA;.

 - -

Until this specification advances to a status of Draft, its associated namespace shall be "http://www.xmpp.org/extensions/xep-0227.html#ns"; upon advancement of this specification, the ®ISTRAR; shall issue a permanent namespace in accordance with the process defined in Section 4 of &xep0053;.

+ +

This specification defines the following XML namespace:

+
    +
  • urn:xmpp:pie:0
    • +
+

The ®ISTRAR; includes the foregoing namespace in its registry at &NAMESPACES;, as described in Section 4 of &xep0053;.

+ + + &NSVER; @@ -383,10 +396,17 @@ + + + The protocol documented by this schema is defined in + XEP-0227: http://xmpp.org/extensions/xep-0227.html + + +