xep-0411.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>Bookmarks Conversion</title>
  <abstract>This specification describes a method to migrate to PEP based bookmarks without loosing compatibility with client that still use Private XML.</abstract>
  &LEGALNOTICE;
  <number>0411</number>
  <status>Deprecated</status>
  <lastcall>2020-10-14</lastcall>
  <type>Standards Track</type>
  <sig>Standards</sig>
  <approver>Council</approver>
  <dependencies>
    <spec>XMPP Core</spec>
    <spec>XEP-0049</spec>
    <spec>XEP-0153</spec>
  </dependencies>
  <supersedes/>
  <supersededby>
    <spec>XEP-0402</spec>
  </supersededby>
  <shortname>bookmarks-conversion</shortname>
  <author>
    <firstname>Daniel</firstname>
    <surname>Gultsch</surname>
    <email>daniel@gultsch.de</email>
    <jid>daniel@gultsch.de</jid>
  </author>
  <revision>
    <version>1.1.0</version>
    <date>2021-10-19</date>
    <initials>XEP Editor (jsc)</initials>
    <remark>Deprecated by vote of Council on 2021-10-06.</remark>
  </revision>
  <revision>
    <version>1.0.0</version>
    <date>2020-10-20</date>
    <initials>XEP Editor (jsc)</initials>
    <remark>Accepted as Draft by vote of Council on 2020-10-14.</remark>
  </revision>
  <revision>
    <version>0.2.1</version>
    <date>2020-05-25</date>
    <initials>mb</initials>
    <remark>Fix XEP numbers</remark>
  </revision>
  <revision>
    <version>0.2.0</version>
    <date>2018-11-08</date>
    <initials>XEP Editor (jsc)</initials>
    <remark>Accepted by vote of Council on 2018-10-03.</remark>
  </revision>
  <revision>
    <version>0.1.0</version>
    <date>2018-09-18</date>
    <initials>dg</initials>
    <remark><p>First draft.</p></remark>
  </revision>
</header>
<section1 topic='Introduction' anchor='intro'>
  <p>&xep0048; has a long time ago moved from &xep0049; as a storage backend to using &xep0163; instead. However lots of implementations are still using Private XML which creates a bit of a chicken and egg problem since clients who want to use the more efficient PEP method would either have to support both and synchronize them properly or render themselves incompatible with other clients. An easy way out of that conundrum is to have the server do the conversion for us.</p>
  <p>This XEP defines a method to convert between the different storage backends of XEP-0048 and is not influenced by the existence of &xep0402;. Bookmarks 2 defines its own conversion mechanism but the adoption of Bookmarks 2 - at the time of writing this XEP - is questionable.</p>
</section1>
<section1 topic='Discovery' anchor='disco'>
  <p>The conversion is transparent to the publishing entity. However an entity might want to discover if a service will be performing the conversion and soley rely on PEP to access bookmarks without segregating clients that only support Private XML.</p>
  <p>The service MUST include a &xep0030; feature of "urn:xmpp:bookmarks-conversion:0" on the account.</p>
  <example caption='Client sends service discovery request to own account'><![CDATA[
<iq from='romeo@montague.tld/garden'
    id='01'
    type='get'
    to='remeo@montague.tld'>
  <query xmlns='http://jabber.org/protocol/disco#info'/>
</iq>]]></example>
  <example caption='Server includes feature namespace in response'><![CDATA[
<iq from='romeo@montague.tld'
    id='01'
    type='result'
    to='romeo@montague.tld/garden'>
  <query  xmlns='http://jabber.org/protocol/disco#info'>
    <feature var='urn:xmpp:bookmarks-conversion:0'/>
  </query>
</iq>]]></example>  
  </section1>
<section1 topic='Conversion' anchor='conversion'>
  <p>Modern clients are expected to use PEP (<strong>XEP-0163</strong>) as interface to upload and retrieve their bookmarks and not explicitly request bookmarks from private XML anymore. Thus a service MUST support conversion from PEP to Private XML and vice versa. Whether PEP and Private XML are fed from the same data source or if they get copied over when ever one of them gets written is out of scope of this document.</p>
  <p>When a legacy client modifies bookmarks over Private XML the service MUST send out notification messages to all subscribers of the 'storage:bookmarks' node.</p>
</section1>
<section1 topic='Implementation Notes' anchor='impl'>
  <p>For server implementations where the data is just copied over the server should make sure that the data gets copied from Private XML to PEP before the user logs in for the first time. Otherwise it won’t generate a PEP notification and clients that only rely on PEP will not be aware of any preexisting bookmarks.</p>
</section1>
<section1 topic='Security Considerations' anchor='security'>
  <p>PEP nodes can have an access model other than 'whitelist'. When copying data over from Private XML Storage to PEP the service MUST make that the user is the only one who has access to that node. This can happen by either changing the access model accordingly or not doing the conversion.</p>
</section1>
<section1 topic='IANA Considerations' anchor='iana'>
  <p>This document requires no interaction with the Internet Assigned Numbers Authority (IANA).</p>
</section1>
<section1 topic='XMPP Registrar Considerations' anchor='registrar'>
  <p>This specification defines the following XML namespace:</p>
  <ul>
    <li>urn:xmpp:bookmarks-conversion:0</li>
  </ul>
</section1>
<section1 topic='XML Schema' anchor='schema'>
  <p>tbd</p>
</section1>
<section1 topic='Acknowledgements' anchor='ack'>
  <p>Special thanks to Emmanuel Gil Peyrot who created a proof of concept module for Prosody.</p>
</section1>
</xep>