diff --git a/xep-0402.xml b/xep-0402.xml index 7efd7fc2..c04820a1 100644 --- a/xep-0402.xml +++ b/xep-0402.xml @@ -1,13 +1,13 @@ + %ents; ]>
- Bookmarks 2 (This Time it's Serious) + PEP Native Bookmarks This specification defines a syntax and storage profile for keeping a list of chatroom bookmarks on the server. &LEGALNOTICE; 0402 @@ -26,6 +26,17 @@ standards &dcridland; &jcbrand; + + 0.4.0 + 2020-02-13 + dwd +
    +
  • Remove sense of humour
    • +
  • Re-add Password field
    • +
  • Add metadata container
    • +
  • Show edit flow
    • +
+ 0.3.0 2019-09-28 @@ -75,15 +86,21 @@ containing all bookmarks inside a single Pubsub item.

Most implementations have kept to the original, Private XML Storage based solution, and while some newer implementations have used Pubsub, these are limited in capability by the use of - a single item.

-

This specification resolves both issues by providing a new Bookmarks specification to migrate to, + a single item, which prevents safe atomic updates of individual bookmarks.

+

Finally, while some clients used custom XML elements to store additional private metadata about + bookmarks, this was usually stripped when any bookmark was edited by another client.

+

This specification resolves all three issues by providing a new Bookmarks specification to migrate to, and takes the opportunity to update the XML namespace in use as well. The URL storage is dropped, since it is rarely used. Storage of URL bookmarks is therefore out of scope.

+

This specification was originally entitled "Bookmarks 2: This Time It's Serious". Any implication of a sense + of humour has been removed with the change in title.

Clients store each bookmarked chatroom as a Pubsub item within the '&namespace;' node. Each - item SHALL have, as item id, the Room JID of the chatroom (eg, coven@chat.shakespeare.lit).

+ item SHALL have, as item id, the Room JID of the chatroom (eg, coven@chat.shakespeare.lit). While a client can + typically assume a chatroom based on &xep0045;, clients are free to store chatrooms based on any particular groupchat + protocol.

The payload of the item SHALL be a conference element qualified by the '&namespace;' namespace, with the following syntax:

@@ -100,16 +117,28 @@ - + - + - + + + + + + + + + + + + +
'name' attributeA friendly name for the bookmark.A friendly name for the bookmark, specified by the user. Clients SHOULD NOT attempt to autogenerate this from the JID. stringRECOMMENDEDOPTIONAL
<nick/> elementThe user's preferred roomnick for the chatroom.The user's preferred roomnick for the chatroom, if different to that specified by &xep0172;. In the absence of this element being present, the nickname from &xep0172; SHOULD be used if present. string OPTIONAL
<password/> elementA password used to access the chatroom. Note this is not intended to be a secure storage.stringOPTIONAL
<extensions/> elementA set of child elements (of potentially any namespace). Clients MUST preserve these (particularly preserving unknown elements) when editing items.XML ElementsOPTIONAL

Note: The datatypes are as defined in &w3xmlschema2;.

-

A client interested in bookmarks SHOULD include the 'urn:xmpp:bookmarks:0+notify' feature in its &xep0115;, as per &xep0163;, so that it receives notifications for updates done by other clients of the user, and reacts accordingly. The actual notifications are explained in the Bookmark Notifications section of this specification.

+

A client interested in bookmarks SHOULD include the '&namespace;+notify' feature in its &xep0115;, as per &xep0163;, so that it receives notifications for updates done by other clients of the user, and reacts accordingly. The actual notifications are explained in the Bookmark Notifications section of this specification.

- + @@ -150,7 +179,7 @@ - + ]]> @@ -159,7 +188,7 @@ to='juliet@capulet.lit/balcony' id='retrieve1'> - + JC + + + @@ -187,7 +219,7 @@ - + + +

Editing a bookmark means republishing the item, with the same bookmark JID as id, to the '&namespace;' node.

+

Note that clients MUST preserve any XML elements they do not understand, particularly including unknown elements, within the <extensions/> element of the bookmark.

+

publish-options (as defined in XEP-0060) MUST be supported by the server in order to check that the node is correctly configured before publishing a new conference. This is especially important to avoid leaking your bookmarks to your contacts for instance.

+ + + + + + + JC + + + + + + + + + + http://jabber.org/protocol/pubsub#publish-options + + + true + + + 10000 + + + never + + + whitelist + + + + + +]]> + +]]> + +

Removing a bookmark means retracting an existing item, identified by the bookmark's JID, form the '&namespace;' node.

This implies that server support for the "delete-items" pubsub feature is REQUIRED.

@@ -231,7 +310,7 @@ - + @@ -251,7 +330,7 @@ - + ]]> -

On the other hand, if the 'autojoin' attribute is absent or false, or when the event is a retract notification, the client SHOULD leave the room immediately.

+

On the other hand, if the event is a retract notification, the client SHOULD leave the room immediately.

- + @@ -291,8 +370,8 @@

A server MAY choose to unify the bookmarks from both &xep0049; based and the current &xep0048;.

It is encouraged to at least support unification between Private XML Storage because as of 2019 this is still the storage backend that is implemented in the majority of clients.

-

A server that supports unifying bookmarks from &xep0049; and &xep0402; SHOULD announce the "urn:xmpp:bookmarks:0#compat" feature on the account. Clients may use that feature as an indication that it is safe to store bookmarks using only &xep0402; without losing backward compatibility to clients that are only using &xep0049;.

-

A server that supports unifying bookmarks between &xep0223; and &xep0402; SHOULD announce the "urn:xmpp:bookmarks:0#compat-pep" feature on the account.

+

A server that supports unifying bookmarks from &xep0049; and &xep0402; SHOULD announce the "&namespace;#compat" feature on the account. Clients may use that feature as an indication that it is safe to store bookmarks using only &xep0402; without losing backward compatibility to clients that are only using &xep0049;.

+

A server that supports unifying bookmarks between &xep0223; and &xep0402; SHOULD announce the "&namespace;#compat-pep" feature on the account.

When a client publishes a new item, the server MAY collate all items, casting them into the 'storage:bookmarks' namespace and setting the jid attribute to the item id in each case. When contained within a storage element qualified by the 'storage:bookmarks' namespace, this will be the correct format for both current and previous variants of &xep0048;

 @@ -304,8 +383,8 @@

This specification relies fully on a number of others. Most particularly, support for this protocol is available if &xep0223; is supported.

-

Server side unification between &xep0049; bookmarks and Bookmarks 2 is announced with the feature "urn:xmpp:bookmarks:0#compat" on the account.

-

Server side unification between the current use of XEP-0048 bookmarks (PEP) is annouced with the feature "urn:xmpp:bookmarks:0#compat-pep" on the account.

+

Server side unification between &xep0049; bookmarks and PEP Native Bookmarks is announced with the feature "&namespace;#compat" on the account.

+

Server side unification between the current use of XEP-0048 bookmarks (PEP) is annouced with the feature "&namespace;#compat-pep" on the account.