moparisthebest/xeps
1
0
Fork 0
mirror of https://github.com/moparisthebest/xeps synced 2024-11-21 16:55:07 -05:00
Code Issues Releases Wiki Activity

0.9

Browse Source
This commit is contained in:
stpeter 2011-10-09 19:38:47 -06:00
parent 57fa0c2086
commit 04f2b7087e
1 changed files with 355 additions and 156 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

257
xep-0292.xml
View File

@ -31,6 +31,12 @@
<email>samizzi@cisco.com</email> <email>samizzi@cisco.com</email>
<jid>samizzi@cisco.com</jid> <jid>samizzi@cisco.com</jid>
</author> </author>
<revision>
<version>0.9</version>
<date>2011-10-09</date>
<initials>psa</initials>
<remark><p>Described how to use the vCard format for storing private data about one's contacts; added XMPP Registrar considerations.</p></remark>
</revision>
<revision> <revision>
<version>0.8</version> <version>0.8</version>
<date>2011-08-31</date> <date>2011-08-31</date>
@ -132,21 +138,25 @@
<p>The vCard XML format defined at the IETF specifies that the root element is &lt;vcards/&gt;, where the only defined child element is &lt;vcard/&gt;. For use in XMPP, we specify that the root element shall be &lt;vcard/&gt;, not &lt;vcards/&gt;.</p> <p>The vCard XML format defined at the IETF specifies that the root element is &lt;vcards/&gt;, where the only defined child element is &lt;vcard/&gt;. For use in XMPP, we specify that the root element shall be &lt;vcard/&gt;, not &lt;vcards/&gt;.</p>
</section1> </section1>
<section1 topic='IQ-Based Publication and Retrieval' anchor='iq'> <section1 topic='Self vCards' anchor='public'>
<p>As in <cite>XEP-0054</cite>, the primary method for publishing and retrieving vCards is the XMPP &IQ; stanza.</p>
<section2 topic='Retrieval' anchor='iq-retrieval'> <p>This section describes the use of the vCard format for self-publication and retrieval of publicly-accessible information about any entity on an XMPP network, thus fulfilling all the use cases of the old vcard-temp format.</p>
<section2 topic='IQ-Based Publication and Retrieval' anchor='self-iq'>
<p>As in <cite>XEP-0054</cite>, the primary method for publishing and retrieving vCards is the XMPP &IQ; stanza. (Although it would have been possible to use &xep0222; for public storage and retrieval, community consensus is that storage via IQ is more backward-compatible with <cite>XEP-0054</cite>, and that publish-subscribe is more appropriate only for event notifications.)</p>
<section3 topic='Retrieval' anchor='self-iq-retrieval'>
<p>An XMPP entity retrieves the vCard of another entity (or itself) by sending an IQ-get to the target entity containing a &lt;vcard/&gt; child element (note the lowercase "c"!) qualified by the 'urn:ietf:params:xml:ns:vcard-4.0' namespace.</p> <p>An XMPP entity retrieves the vCard of another entity (or itself) by sending an IQ-get to the target entity containing a &lt;vcard/&gt; child element (note the lowercase "c"!) qualified by the 'urn:ietf:params:xml:ns:vcard-4.0' namespace.</p>
<example caption="vCard Retrieval Request"><![CDATA[ <example caption="vCard Retrieval Request"><![CDATA[
<iq from='samizzi@cisco.com/foo' <iq from='samizzi@cisco.com/foo'
id='bx81v356' id='bx81v356'
to='stpeter@jabber.org' to='stpeter@jabber.org'
type='get'> type='get'>
<vcard xmlns='urn:ietf:params:xml:ns:vcard-4.0'/> <vcard xmlns='urn:ietf:params:xml:ns:vcard-4.0'/>
</iq> </iq>
]]></example> ]]></example>
<p>If a vCard exists for the target entity, the responsible entity (e.g., the XMPP server that hosts the account for a bare JID) MUST return the data in an IQ-result:</p> <p>If a vCard exists for the target entity, the responsible entity (e.g., the XMPP server that hosts the account for a bare JID) MUST return the data in an IQ-result:</p>
<example caption="Server Returns vCard"><![CDATA[ <example caption="Server Returns vCard"><![CDATA[
<iq from='stpeter@jabber.org' <iq from='stpeter@jabber.org'
id='bx81v356' id='bx81v356'
to='samizzi@cisco.com/foo' to='samizzi@cisco.com/foo'
type='result'> type='result'>
@ -232,58 +242,59 @@
<uri>https://stpeter.im/stpeter.asc</uri> <uri>https://stpeter.im/stpeter.asc</uri>
</key> </key>
</vcard> </vcard>
</iq> </iq>
]]></example> ]]></example>
<p>If no vCard exists, the server MUST return an IQ-result containing an empty &lt;vcard/&gt; element.</p> <p>If no vCard exists, the server MUST return an IQ-result containing an empty &lt;vcard/&gt; element.</p>
<example caption="No vCard (empty element)"><![CDATA[ <example caption="No vCard (empty element)"><![CDATA[
<iq from='stpeter@jabber.org' <iq from='stpeter@jabber.org'
id='bx81v356' id='bx81v356'
to='samizzi@cisco.com/foo' to='samizzi@cisco.com/foo'
type='result'> type='result'>
<vcard xmlns='urn:ietf:params:xml:ns:vcard-4.0'/> <vcard xmlns='urn:ietf:params:xml:ns:vcard-4.0'/>
</iq> </iq>
]]></example> ]]></example>
</section2> </section3>
<section2 topic='Publication' anchor='iq-publication'> <section3 topic='Publication' anchor='self-iq-publication'>
<p>An XMPP entity publishes or updates its vCard by sending an IQ-set to itself, containing a &lt;vcard/&gt; child element qualified by the 'urn:ietf:params:xml:ns:vcard-4.0' namespace. The publication request needs to include the entire vCard, not a "diff" against the prior data (if any).</p> <p>An XMPP entity publishes or updates its vCard by sending an IQ-set to itself, containing a &lt;vcard/&gt; child element qualified by the 'urn:ietf:params:xml:ns:vcard-4.0' namespace. The publication request needs to include the entire vCard, not a "diff" against the prior data (if any).</p>
<example caption="vCard Publication Request"><![CDATA[ <example caption="vCard Publication Request"><![CDATA[
<iq from='stpeter@jabber.org/squire <iq from='stpeter@jabber.org/squire
id='h3vz319m' id='h3vz319m'
to='stpeter@jabber.org' to='stpeter@jabber.org'
type='set'> type='set'>
<vcard xmlns='urn:ietf:params:xml:ns:vcard-4.0'> <vcard xmlns='urn:ietf:params:xml:ns:vcard-4.0'>
[...] [...]
</vcard> </vcard>
</iq> </iq>
]]></example> ]]></example>
<p>If no error occurs, the responsible entity returns an IQ-result.</p> <p>If no error occurs, the responsible entity returns an IQ-result.</p>
<example caption="Server Acknowledges Publication"><![CDATA[ <example caption="Server Acknowledges Publication"><![CDATA[
<iq from='stpeter@jabber.org' <iq from='stpeter@jabber.org'
id='bx81v356' id='bx81v356'
to='stpeter@jabber.org/squire' to='stpeter@jabber.org/squire'
type='result'/> type='result'/>
]]></example> ]]></example>
<p>Note: An entity MAY have authorization to update the vCard of another entity (e.g., a server administrator might have authorization to modify the server's vCard).</p> <p>Note: An entity MAY have authorization to update the vCard of another entity (e.g., a server administrator might have authorization to modify the server's vCard).</p>
</section2> </section3>
</section1>
<section1 topic='Event Notifications' anchor='pep'>
<p>&xep0060; provides a way to subscribe to events, and &xep0163; defines a pubsub profile for events associated with instant messaging (IM) accounts. If PEP is supported by an IM server, it can be used to automatically generate event notifications when a user's vCard is modified.</p>
<section2 topic='Location' anchor='pubsub-location'>
<p>The canonical location for notifications regarding a user's vCard is a pubsub node whose name is "urn:xmpp:vcard4".</p>
</section2> </section2>
<section2 topic='Subscribing to vCard Notifications' anchor='pubsub-subscribe'>
<section2 topic='Event Notifications' anchor='self-pubsub'>
<p>&xep0060; provides a way to subscribe to events, and &xep0163; defines a pubsub profile for events associated with instant messaging (IM) accounts. If PEP is supported by an IM server, it can be used to automatically generate event notifications when a user's vCard is modified.</p>
<section3 topic='Location' anchor='self-pubsub-location'>
<p>The canonical location for notifications regarding a user's vCard is a pubsub node whose name is "urn:xmpp:vcard4".</p>
</section3>
<section3 topic='Subscribing to vCard Notifications' anchor='self-pubsub-subscribe'>
<p>Let us imagine that Juliet wishes to receive the updates that Romeo publishes to his vCard. She has two options: <p>Let us imagine that Juliet wishes to receive the updates that Romeo publishes to his vCard. She has two options:
<ol> <ol>
<li>Implicitly subscribe by advertising support for "urn:xmpp:vcard4+notify" in her &xep0115; data. Romeo's PEP service then automatically sends vCard updates to her when it receives presence from her, until and unless she sends presence of type unavailable or stops advertising an interest in vCard updates. This is in accordance with XEP-0060, section 6.1.</li> <li>Implicitly subscribe by advertising support for "urn:xmpp:vcard4+notify" in her &xep0115; data. Romeo's PEP service then automatically sends vCard updates to her when it receives presence from her, until and unless she sends presence of type unavailable or stops advertising an interest in vCard updates. This is in accordance with XEP-0060, section 6.1.</li>
<li>Explicitly subscribe by sending a formal subscription request to the "urn:xmpp:vcard4" node at Romeo's JabberID. Romeo's PEP service may send her all vCard updates even if she is offline at the time (depending on service policies regarding presence integration).</li> <li>Explicitly subscribe by sending a formal subscription request to the "urn:xmpp:vcard4" node at Romeo's JabberID. Romeo's PEP service may send her all vCard updates even if she is offline at the time (depending on service policies regarding presence integration).</li>
</ol> </ol>
</p> </p>
</section2> </section3>
<section2 topic='Receiving a vCard Notification'> <section3 topic='Receiving a vCard Notification'>
<p>Because Juliet has sent presence to Romeo including Entity Capabilities data that includes the "urn:xmpp:vcard4+notify" feature, Romeo's XMPP server will send a PEP notification to Juliet. The notification can include an XMPP message body for backwards-compatibility with XMPP clients that are not pubsub-capable (see Message Body). This is in accordance with XEP-0060, second 6.1.7.</p> <p>Because Juliet has sent presence to Romeo including Entity Capabilities data that includes the "urn:xmpp:vcard4+notify" feature, Romeo's XMPP server will send a PEP notification to Juliet. The notification can include an XMPP message body for backwards-compatibility with XMPP clients that are not pubsub-capable (see Message Body). This is in accordance with XEP-0060, second 6.1.7.</p>
<example caption="Receiving a vCard publication/update"><![CDATA[ <example caption="Receiving a vCard publication/update"><![CDATA[
<message from='romeo@montague.lit' <message from='romeo@montague.lit'
to='juliet@capulet.lit' to='juliet@capulet.lit'
type='headline'> type='headline'>
<event xmlns='http://jabber.org/protocol/pubsub#event'> <event xmlns='http://jabber.org/protocol/pubsub#event'>
@ -291,10 +302,173 @@
<item id='current'/> <item id='current'/>
</items> </items>
</event> </event>
</message> </message>
]]></example> ]]></example>
<p>Note: There is no payload, because this is a pure notification (the receiver needs to retrieve the vCard using an IQ-get as described earlier.</p> <p>Note: There is no payload, because this is a pure notification (the receiver needs to retrieve the vCard using an IQ-get as described earlier.</p>
</section3>
</section2> </section2>
</section1>
<section1 topic='Contact vCards' anchor='contacts'>
<p>In addition to enabling the publication and retrieval of vCards about any entity on an XMPP network, the vCard format can also be used to store information about an entity's contacts.</p>
<section2 topic='Format' anchor='contacts-format'>
<p>A contact is simply a vCard about someone else (or something else, in the case of automated entities). If the other person or entity is in the user's roster &rfc6121;, the vCard SHOULD contain the Jabber ID of the person or entity. This enables a user to store information about the contact outside of the roster, thus obviating the need for changes or extensions to the roster namespace itself (as in &xep0145;).</p>
<example caption="Contact"><![CDATA[
<vcard xmlns="urn:ietf:params:xml:ns:vcard-4.0">
<fn><text>Samantha Mizzi</text></fn>
<n>
<surname>Mizzi</surname>
<given>Samantha</given>
<middle></middle>
</n>
<nickname><text>Sam</text></nickname>
<nickname><text>samizzi</text></nickname>
<geo><uri>geo:39.59,-105.01</uri></geo>
<org>
<parameters><type><text>work</text></type></parameters>
<text>Cisco</text>
</org>
<note>
<text>
My co-author on XEP-0292. She's cool!
</text>
</note>
<impp>
<parameters><type><text>work</text></type></parameters>
<uri>xmpp:samizzi@cisco.com</uri>
</impp>
</vcard>
]]></example>
</section2>
<section2 topic='Storage' anchor='contacts-storage'>
<p>Because contact vCards are private information, they are best stored using &xep0223;. The canonical location is a well-known pubsub node "urn:xmpp:contacts". In accordance with <cite>XEP-0223</cite>, this node MUST have an access type of "whitelist" by default. When a client stores items at this node, it SHOULD NOT include an ItemID, so that the pubsub service can assign those identifiers.</p>
<example caption='Storing a Contact vCard'><![CDATA[
<iq from='stpeter@stpeter.im/squire' type='set' id='h3vs7163'>
<pubsub xmlns='http://jabber.org/protocol/pubsub'>
<publish node='urn:xmpp:contacts'>
<item>
<vcard xmlns="urn:ietf:params:xml:ns:vcard-4.0">
<fn><text>Samantha Mizzi</text></fn>
<n>
<surname>Mizzi</surname>
<given>Samantha</given>
<middle></middle>
</n>
<nickname><text>Sam</text></nickname>
<nickname><text>samizzi</text></nickname>
<geo><uri>geo:39.59,-105.01</uri></geo>
<org>
<parameters><type><text>work</text></type></parameters>
<text>Cisco</text>
</org>
<note>
<text>
My co-author on XEP-0292. She's cool!
</text>
</note>
<impp>
<parameters><type><text>work</text></type></parameters>
<uri>xmpp:samizzi@cisco.com</uri>
</impp>
</vcard>
</item>
</publish>
<publish-options>
<x xmlns='jabber:x:data' type='submit'>
<field var='FORM_TYPE' type='hidden'>
<value>http://jabber.org/protocol/pubsub#publish-options</value>
</field>
<field var='pubsub#persist_items'>
<value>true</value>
</field>
<field var='pubsub#access_model'>
<value>whitelist</value>
</field>
</x>
</publish-options>
</pubsub>
</iq>
]]></example>
<p>When a contact's vCard is stored in a private node, it is pushed out to all of the user's resources that have included in their entity capabilities (XEP-0115) data a service discovery feature of "urn:xmpp:contacts+notify" (in the following example those resources are "squire" and "roundabout").</p>
<example caption='Publisher resources receive event notification'><![CDATA[
<message from='stpeter@stpeter.im'
to='stpeter@stpeter.im/squire'
type='headline'
id='ka92g1b5'>
<event xmlns='http://jabber.org/protocol/pubsub#event'>
<items node='urn:xmpp:contacts'>
<item id='9703CC4E-CF7E-4A86-9E61-2C670235F9CB'>
<vcard xmlns="urn:ietf:params:xml:ns:vcard-4.0">
<fn><text>Samantha Mizzi</text></fn>
<n>
<surname>Mizzi</surname>
<given>Samantha</given>
<middle></middle>
</n>
<nickname><text>Sam</text></nickname>
<nickname><text>samizzi</text></nickname>
<geo><uri>geo:39.59,-105.01</uri></geo>
<org>
<parameters><type><text>work</text></type></parameters>
<text>Cisco</text>
</org>
<note>
<text>
My co-author on XEP-0292. She's cool!
</text>
</note>
<impp>
<parameters><type><text>work</text></type></parameters>
<uri>xmpp:samizzi@cisco.com</uri>
</impp>
</vcard>
</item>
</items>
</event>
</message>
<message from='stpeter@stpeter.im'
to='stpeter@stpeter.im/roundabout'
type='headline'
id='pty14x69'>
<event xmlns='http://jabber.org/protocol/pubsub#event'>
<items node='urn:xmpp:contacts'>
<item id='9703CC4E-CF7E-4A86-9E61-2C670235F9CB'>
<vcard xmlns="urn:ietf:params:xml:ns:vcard-4.0">
<fn><text>Samantha Mizzi</text></fn>
<n>
<surname>Mizzi</surname>
<given>Samantha</given>
<middle></middle>
</n>
<nickname><text>Sam</text></nickname>
<nickname><text>samizzi</text></nickname>
<geo><uri>geo:39.59,-105.01</uri></geo>
<org>
<parameters><type><text>work</text></type></parameters>
<text>Cisco</text>
</org>
<note>
<text>
My co-author on XEP-0292. She's cool!
</text>
</note>
<impp>
<parameters><type><text>work</text></type></parameters>
<uri>xmpp:samizzi@cisco.com</uri>
</impp>
</vcard>
</item>
</items>
</event>
</message>
]]></example>
</section2>
</section1> </section1>
<section1 topic='vCards of Automated Entities' anchor='apps'> <section1 topic='vCards of Automated Entities' anchor='apps'>
@ -330,6 +504,12 @@
<p>This document does not require interaction with &IANA;.</p> <p>This document does not require interaction with &IANA;.</p>
</section1> </section1>
<section1 topic='XMPP Registrar Considerations' anchor='registrar'>
<section2 topic='Well-Known Service Discovery Nodes' anchor='registrar-nodes'>
<p>The &REGISTRAR; shall include 'urn:xmpp:contact' in its registry of Nodes for Service Discovery and Publish-Subscribe at &NODES;.</p>
</section2>
</section1>
<section1 topic='Mapping from vcard-temp to vCard4' anchor='mapping'> <section1 topic='Mapping from vcard-temp to vCard4' anchor='mapping'>
<p>This section provides a more detailed description of mapping vcard-temp properties to vcard4 properties.</p> <p>This section provides a more detailed description of mapping vcard-temp properties to vcard4 properties.</p>
<section2 topic='Properties Defined in vcard-temp but not in vCard3 or vCard4' anchor='mapping-temponly'> <section2 topic='Properties Defined in vcard-temp but not in vCard3 or vCard4' anchor='mapping-temponly'>
@ -589,7 +769,11 @@ OR OTHER DEALINGS IN THE SOFTWARE.
<photo><uri><xsl:value-of select='EXTVAL'/></uri></photo> <photo><uri><xsl:value-of select='EXTVAL'/></uri></photo>
</xsl:when> </xsl:when>
<xsl:otherwise> <xsl:otherwise>
<photo><uri><xsl:text>data:</xsl:text><xsl:value-of select='TYPE'/><xsl:text>;</xsl:text><xsl:value-of select='BINVAL'/></uri></photo> <photo>
<uri>
<xsl:text>data:</xsl:text><xsl:value-of select='TYPE'/><xsl:text>;</xsl:text><xsl:value-of select='BINVAL'/>
</uri>
</photo>
</xsl:otherwise> </xsl:otherwise>
</xsl:choose> </xsl:choose>
</xsl:for-each> </xsl:for-each>
@ -658,7 +842,10 @@ OR OTHER DEALINGS IN THE SOFTWARE.
<logo><uri><xsl:value-of select='EXTVAL'/></uri></logo> <logo><uri><xsl:value-of select='EXTVAL'/></uri></logo>
</xsl:when> </xsl:when>
<xsl:otherwise> <xsl:otherwise>
<logo><uri><xsl:text>data:</xsl:text><xsl:value-of select='TYPE'/><xsl:text>;</xsl:text><xsl:value-of select='BINVAL'/></uri></logo> <logo>
<uri><xsl:text>data:</xsl:text><xsl:value-of select='TYPE'/><xsl:text>;</xsl:text><xsl:value-of select='BINVAL'/>
</uri>
</logo>
</xsl:otherwise> </xsl:otherwise>
</xsl:choose> </xsl:choose>
</xsl:for-each> </xsl:for-each>
@ -735,7 +922,10 @@ OR OTHER DEALINGS IN THE SOFTWARE.
<sound><uri><xsl:value-of select='EXTVAL'/></uri></sound> <sound><uri><xsl:value-of select='EXTVAL'/></uri></sound>
</xsl:when> </xsl:when>
<xsl:when test='$SOUND.ext=1'> <xsl:when test='$SOUND.ext=1'>
<sound><uri><xsl:text>data:audio/basic;base64,</xsl:text><xsl:value-of select='BINVAL'/></uri></sound> <sound>
<uri><xsl:text>data:audio/basic;base64,</xsl:text><xsl:value-of select='BINVAL'/>
</uri>
</sound>
</xsl:when> </xsl:when>
<xsl:otherwise> <xsl:otherwise>
</xsl:otherwise> </xsl:otherwise>
@ -873,7 +1063,16 @@ OR OTHER DEALINGS IN THE SOFTWARE.
<xsl:variable name='PREF.count' select='count(PREF)'/> <xsl:variable name='PREF.count' select='count(PREF)'/>
<xsl:variable name='NUMBER.count' select='count(NUMBER)'/> <xsl:variable name='NUMBER.count' select='count(NUMBER)'/>
<!-- first we count the number of vCard TYPE parameters --> <!-- first we count the number of vCard TYPE parameters -->
<xsl:variable name='TYPE.count' select='$HOME.count + $WORK.count + $TEXT.count + $VOICE.count + $FAX.count + $CELL.count + $VIDEO.count + $PAGER.count + $TEXTPHONE.count'/> <xsl:variable name='TYPE.count'
select='$HOME.count
+ $WORK.count
+ $TEXT.count
+ $VOICE.count
+ $FAX.count
+ $CELL.count
+ $VIDEO.count
+ $PAGER.count
+ $TEXTPHONE.count'/>
<!-- now we output all the parameters --> <!-- now we output all the parameters -->
<xsl:if test='$TYPE.count &gt; 0'> <xsl:if test='$TYPE.count &gt; 0'>
<parameters> <parameters>