mirror of
https://github.com/moparisthebest/xeps
synced 2024-11-21 08:45:04 -05:00
Merge branch 'premerge' into 'main'
Premerge See merge request xsf/xeps!15
This commit is contained in:
Jonas Schäfer
commit
91a2702203
186
inbox/xep-mam-prefs.xml
Normal file
186
inbox/xep-mam-prefs.xml
Normal file
@ -0,0 +1,186 @@
|
|||||||
|
<?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>Message Archive Management Preferences</title>
|
||||||
|
<abstract>This document defines a protocol to control a user's archiving preferences.</abstract>
|
||||||
|
&LEGALNOTICE;
|
||||||
|
<number>xxxx</number>
|
||||||
|
<status>ProtoXEP</status>
|
||||||
|
<type>Standards Track</type>
|
||||||
|
<sig>Standards</sig>
|
||||||
|
<dependencies>
|
||||||
|
<spec>XMPP Core</spec>
|
||||||
|
<spec>XEP-0030</spec>
|
||||||
|
<spec>XEP-0313</spec>
|
||||||
|
</dependencies>
|
||||||
|
<supersedes/>
|
||||||
|
<supersededby/>
|
||||||
|
<shortname>mamprefs</shortname>
|
||||||
|
&mwild;
|
||||||
|
&ksmith;
|
||||||
|
<revision>
|
||||||
|
<version>0.1</version>
|
||||||
|
<date>2020-04-03</date>
|
||||||
|
<initials>mw</initials>
|
||||||
|
<remark>
|
||||||
|
<p>Split from XEP-0313, no protocol changes</p>
|
||||||
|
</remark>
|
||||||
|
</revision>
|
||||||
|
</header>
|
||||||
|
|
||||||
|
<section1 topic='Introduction' anchor='intro'>
|
||||||
|
<p>This specification describes a protocol for a server to allow a client to configure a user's
|
||||||
|
message archiving preferences. It is intended to be used in conjunction with &xep0313;.</p>
|
||||||
|
|
||||||
|
<p>After observing XEP-0313 usage in the wild, it became apparent that preferences were not often
|
||||||
|
used, and can interfere with clients that use the archive for synchronization of messages received
|
||||||
|
by the user while disconnected. Therefore it is not actively encouraged for an implementation/deployment
|
||||||
|
to offer this functionality.</p>
|
||||||
|
</section1>
|
||||||
|
|
||||||
|
<section1 topic='Archiving Preferences' anchor='prefs'>
|
||||||
|
<p>Depending on implementation and deployment policies, a server MAY allow the user to have control
|
||||||
|
over the server's archiving behaviour. This specification defines a basic protocol for this, and
|
||||||
|
also allows a server to offer more advanced configuration to a user.</p>
|
||||||
|
<section2 topic='Simple configuration' anchor='config'>
|
||||||
|
<p>If the server supports and allows configuration of the preferences described below then it SHOULD implement the protocol defined
|
||||||
|
in this section. This allows the user to retrieve and configure the following preferences:</p>
|
||||||
|
<ul>
|
||||||
|
<li>A list of JIDs that should always have messages to/from archived in the user's store.</li>
|
||||||
|
<li>A list of JIDs that should never have messages to/from archived in the user's store.</li>
|
||||||
|
<li>The default archiving behaviour (for JIDs in neither of the above lists).</li>
|
||||||
|
</ul>
|
||||||
|
<example caption='Retrieving archiving preferences'><![CDATA[
|
||||||
|
<iq type='get' id='juliet2'>
|
||||||
|
<prefs xmlns='urn:xmpp:mam:2'/>
|
||||||
|
</iq>
|
||||||
|
]]></example>
|
||||||
|
|
||||||
|
<p>The server replies with the user's current archiving preferences. The <prefs> element
|
||||||
|
MUST be present and contain the current default archiving policy. The <always> and <never>
|
||||||
|
MUST also be present (even if empty), and contain a list of JIDs enclosed in <jid> elements.</p>
|
||||||
|
|
||||||
|
<example caption='Server responds with current preferences'><![CDATA[
|
||||||
|
<iq type='result' id='juliet2'>
|
||||||
|
<prefs xmlns='urn:xmpp:mam:2' default='roster'>
|
||||||
|
<always/>
|
||||||
|
<never/>
|
||||||
|
</prefs>
|
||||||
|
</iq>
|
||||||
|
]]></example>
|
||||||
|
|
||||||
|
<p>It is also possible that the server may respond with a stanza error, for example the standard
|
||||||
|
'feature-not-implemented' (server does not support MAM configuration) defined in &rfc6120;.</p>
|
||||||
|
|
||||||
|
<example caption='Server does not support archive configuration'><![CDATA[
|
||||||
|
<iq type='error' id='juliet2'>
|
||||||
|
<error type='cancel'>
|
||||||
|
<feature-not-implemented xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/>
|
||||||
|
</error>
|
||||||
|
</iq>
|
||||||
|
]]></example>
|
||||||
|
|
||||||
|
<p>To update the preferences, the client can simply send an iq stanza with a type of 'set':</p>
|
||||||
|
|
||||||
|
<example caption='Updating archiving preferences'><![CDATA[
|
||||||
|
<iq type='set' id='juliet3'>
|
||||||
|
<prefs xmlns='urn:xmpp:mam:2' default='roster'>
|
||||||
|
<always>
|
||||||
|
<jid>romeo@montague.lit</jid>
|
||||||
|
</always>
|
||||||
|
<never>
|
||||||
|
<jid>montague@montague.lit</jid>
|
||||||
|
</never>
|
||||||
|
</prefs>
|
||||||
|
</iq>
|
||||||
|
]]></example>
|
||||||
|
<p>The server then replies with the applied preferences (note that due to server policies these
|
||||||
|
MAY be different to the preferences sent by the client):</p>
|
||||||
|
<example caption='Server responds with updated preferences'><![CDATA[
|
||||||
|
<iq type='result' id='juliet3'>
|
||||||
|
<prefs xmlns='urn:xmpp:mam:2' default='roster'>
|
||||||
|
<always>
|
||||||
|
<jid>romeo@montague.lit</jid>
|
||||||
|
</always>
|
||||||
|
<never>
|
||||||
|
<jid>montague@montague.lit</jid>
|
||||||
|
</never>
|
||||||
|
</prefs>
|
||||||
|
</iq>
|
||||||
|
]]></example>
|
||||||
|
|
||||||
|
<p>It is also possible for the server to respond with an error, for example (but not limited to)
|
||||||
|
the standard 'feature-not-implemented' (the server does not support configuration of preferences),
|
||||||
|
'forbidden' (the user is not authorized to change their preferences) or 'not-allowed' (the server
|
||||||
|
generally does not allow changing of configuration preferences).</p>
|
||||||
|
|
||||||
|
<section3 topic='Default behaviour' anchor='config-default'>
|
||||||
|
<p>If a JID is in neither the 'always archive' nor the 'never archive' list then whether it
|
||||||
|
is archived depends on this setting, the default.
|
||||||
|
</p>
|
||||||
|
<p>The 'default' attribute of the 'prefs' element MUST be one of the following values:</p>
|
||||||
|
<ul>
|
||||||
|
<li>'always' - all messages are archived by default.</li>
|
||||||
|
<li>'never' - messages are never archived by default.</li>
|
||||||
|
<li>'roster' - messages are archived only if the contact's bare JID is in the user's roster.</li>
|
||||||
|
</ul>
|
||||||
|
</section3>
|
||||||
|
<section3 topic='Always archive' anchor='config-always'>
|
||||||
|
<p>The <prefs/> element MAY contain an <always/> child element. If present, it
|
||||||
|
contains a list of <jid/> elements, each containing a single JID. The server SHOULD
|
||||||
|
archive any messages to/from this JID (see 'JID matching').
|
||||||
|
</p>
|
||||||
|
<p>If missing from the preferences, <always/> SHOULD be assumed by the server to be an
|
||||||
|
empty list.
|
||||||
|
</p>
|
||||||
|
</section3>
|
||||||
|
<section3 topic='Never archive' anchor='config-never'>
|
||||||
|
<p>The <prefs/> element MAY contain an <never/> child element. If present, it
|
||||||
|
contains a list of <jid/> elements, each containing a single JID. The server SHOULD
|
||||||
|
NOT archive any messages to/from this JID (see 'JID matching').
|
||||||
|
</p>
|
||||||
|
<p>If missing from the preferences, <never/> SHOULD be assumed by the server to be an
|
||||||
|
empty list.
|
||||||
|
</p>
|
||||||
|
</section3>
|
||||||
|
</section2>
|
||||||
|
<section2 topic='Advanced configuration' anchor='advanced-config'>
|
||||||
|
<p>In addition to this protocol, a server MAY offer more advanced configuration to the user
|
||||||
|
through &xep0050;. Such an interface might, for example, allow the user to configure what
|
||||||
|
types of messages to store, or set a limit on how long messages should remain in the
|
||||||
|
archive.</p>
|
||||||
|
<p>If supported, such a configuration command SHOULD be presented on the well-defined
|
||||||
|
command node of "urn:xmpp:mam#configure".</p>
|
||||||
|
</section2>
|
||||||
|
<section2 topic='JID matching' anchor='match'>
|
||||||
|
<section3 topic='General rules' anchor='match-rules'>
|
||||||
|
<p>When comparing the message target JID against the user's roster (ie. when the user has
|
||||||
|
set default='roster') the comparison MUST use the bare target JID (that is, stripped of
|
||||||
|
any resource).
|
||||||
|
</p>
|
||||||
|
<p>For matching against entries in either the 'allow' or 'never' lists, for each listed
|
||||||
|
JID:
|
||||||
|
</p>
|
||||||
|
<ul>
|
||||||
|
<li>If the listed JID contains a resource, compare against the target JID as-is.</li>
|
||||||
|
<li>If the listed JID has no resource (it is a bare JID) then first strip any resource
|
||||||
|
from the target JID prior to comparison.
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</section3>
|
||||||
|
<section3 topic='Outgoing messages' anchor='match-out'>
|
||||||
|
<p>For outgoing messages, the server MUST use the value of the 'to' attribute as the target JID.
|
||||||
|
</p>
|
||||||
|
</section3>
|
||||||
|
<section3 topic='Incoming messages' anchor='match-in'>
|
||||||
|
<p>For incoming messages, the server MUST use the value of the 'from' attribute as the target JID.
|
||||||
|
</p>
|
||||||
|
</section3>
|
||||||
|
</section2>
|
||||||
|
</section1>
|
||||||
|
</xep>
|
||||||
86
inbox/xep-pubsub-mam.xml
Normal file
86
inbox/xep-pubsub-mam.xml
Normal file
@ -0,0 +1,86 @@
|
|||||||
|
<?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>Pubsub Message Archive Management</title>
|
||||||
|
<abstract>This document defines a protocol to query and control a pubsub node's message archive.</abstract>
|
||||||
|
&LEGALNOTICE;
|
||||||
|
<number>xxxx</number>
|
||||||
|
<status>ProtoXEP</status>
|
||||||
|
<type>Standards Track</type>
|
||||||
|
<sig>Standards</sig>
|
||||||
|
<dependencies>
|
||||||
|
<spec>XMPP Core</spec>
|
||||||
|
<spec>XEP-0030</spec>
|
||||||
|
<spec>XEP-0059</spec>
|
||||||
|
<spec>XEP-0060</spec>
|
||||||
|
<spec>XEP-0297</spec>
|
||||||
|
<spec>XEP-0313</spec>
|
||||||
|
</dependencies>
|
||||||
|
<supersedes/>
|
||||||
|
<supersededby/>
|
||||||
|
<shortname>pubsub-mam</shortname>
|
||||||
|
&mwild;
|
||||||
|
&ksmith;
|
||||||
|
<revision>
|
||||||
|
<version>0.1.0</version>
|
||||||
|
<date>2020-03-30</date>
|
||||||
|
<initials>mw</initials>
|
||||||
|
<remark>
|
||||||
|
<p>Split off from XEP-0313 v0.6.3 to ease advancement of that XEP and allow further clarification and expansion of pubsub use cases.</p>
|
||||||
|
</remark>
|
||||||
|
</revision>
|
||||||
|
</header>
|
||||||
|
|
||||||
|
<section1 topic='Introduction' anchor='intro'>
|
||||||
|
<p>This document specifies how to use &xep0313; in combination with &xep0060; to host and query archives on pubsub nodes.</p>
|
||||||
|
</section1>
|
||||||
|
|
||||||
|
<section1 topic='Querying a pubsub archive' anchor='querying'>
|
||||||
|
<p>When querying a pubsub node's archive, the 'node' attribute is added to the <query> element.</p>
|
||||||
|
<example caption='A user queries a pubsub node's archive for messages'><![CDATA[
|
||||||
|
<iq to='pubsub.shakespeare.lit' type='set' id='juliet1'>
|
||||||
|
<query xmlns='urn:xmpp:mam:2' queryid='f28' node='fdp/submitted/capulet.lit/sonnets'/>
|
||||||
|
</iq>]]></example>
|
||||||
|
|
||||||
|
<example caption='Server returns pubsub messages'><![CDATA[
|
||||||
|
<message id='iasd208' to='juliet@capulet.lit/chamber'>
|
||||||
|
<result xmlns='urn:xmpp:mam:2' queryid='g28' id='28482-20987-73623'>
|
||||||
|
<forwarded xmlns='urn:xmpp:forward:0'>
|
||||||
|
<delay xmlns='urn:xmpp:delay' stamp='2010-07-10T23:08:25Z'/>
|
||||||
|
<message xmlns="jabber:client">
|
||||||
|
<event xmlns='http://jabber.org/protocol/pubsub#event'>
|
||||||
|
<items node='princely_musings'>
|
||||||
|
<item id='ae890ac52d0df67ed7cfdf51b644e901'>
|
||||||
|
<entry xmlns='http://www.w3.org/2005/Atom'>
|
||||||
|
<title>Soliloquy</title>
|
||||||
|
<summary>
|
||||||
|
To be, or not to be: that is the question:
|
||||||
|
Whether 'tis nobler in the mind to suffer
|
||||||
|
The slings and arrows of outrageous fortune,
|
||||||
|
Or to take arms against a sea of troubles,
|
||||||
|
And by opposing end them?
|
||||||
|
</summary>
|
||||||
|
<link rel='alternate' type='text/html'
|
||||||
|
href='http://denmark.lit/2003/12/13/atom03'/>
|
||||||
|
<id>tag:denmark.lit,2003:entry-32397</id>
|
||||||
|
<published>2003-12-13T18:30:02Z</published>
|
||||||
|
<updated>2003-12-13T18:30:02Z</updated>
|
||||||
|
</entry>
|
||||||
|
</item>
|
||||||
|
</items>
|
||||||
|
</event>
|
||||||
|
</message>
|
||||||
|
</forwarded>
|
||||||
|
</result>
|
||||||
|
</message>]]></example>
|
||||||
|
</section1>
|
||||||
|
|
||||||
|
<section1 topic="Business Rules" anchor='business-rules'>
|
||||||
|
<p>A PubSub service offering MAM SHOULD store each of the items published to each node. When responding to MAM requests it MUST construct the message stanza within the <forwarded> element in the same manner as the notifications sent to subscribers for the item, except that specifying the 'from' 'to' and 'id' attributes are OPTIONAL. Pubsub items must be returned one per message stanza (i.e. there MUST NOT be multiple <item> elements within the <items> element).</p>
|
||||||
|
</section1>
|
||||||
|
</xep>
|
||||||
@ -22,6 +22,12 @@
|
|||||||
<shortname>N/A</shortname>
|
<shortname>N/A</shortname>
|
||||||
&stpeter;
|
&stpeter;
|
||||||
&pgmillard;
|
&pgmillard;
|
||||||
|
<revision>
|
||||||
|
<version>1.2</version>
|
||||||
|
<date>2020-08-19</date>
|
||||||
|
<initials>@woj-tek</initials>
|
||||||
|
<remark><p>Add fallback to dialback if EXTERNAL authentication fails due to practical experience.</p></remark>
|
||||||
|
</revision>
|
||||||
<revision>
|
<revision>
|
||||||
<version>1.1</version>
|
<version>1.1</version>
|
||||||
<date>2011-05-25</date>
|
<date>2011-05-25</date>
|
||||||
@ -379,7 +385,7 @@
|
|||||||
<p>Implementation Note: If Server2 needs to assign an authorization identity during SASL negotiation, it SHOULD use the value of the 'from' attribute of the stream header sent by Server1.</p>
|
<p>Implementation Note: If Server2 needs to assign an authorization identity during SASL negotiation, it SHOULD use the value of the 'from' attribute of the stream header sent by Server1.</p>
|
||||||
</li>
|
</li>
|
||||||
<li>
|
<li>
|
||||||
<p>Else Server2 SHOULD return a ¬authorized; stream error and close the stream.</p>
|
<p>Else Server2 SHOULD return a ¬authorized; error and either close Server1's TCP connection or continue with a Server Dialback (XEP-0220) [8] negotiation.</p>
|
||||||
<example><![CDATA[
|
<example><![CDATA[
|
||||||
<failure xmlns='urn:ietf:params:xml:ns:xmpp-sasl'>
|
<failure xmlns='urn:ietf:params:xml:ns:xmpp-sasl'>
|
||||||
<not-authorized/>
|
<not-authorized/>
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user