Merge pull request #1269 from linkmauve/muc-avatar-historical

Historical ProtoXEP: MUC Avatars

inbox/muc-avatars.xml

@@ -6,12 +6,12 @@
 <?xml-stylesheet type='text/xsl' href='xep.xsl'?>
 <xep>
 <header>
-  <title>XMPP Resources Avatars</title>
+  <title>MUC Avatars</title>
-  <abstract>This specification describes how to publish and retrieve avatars from XMPP resources.</abstract>
+  <abstract>This specification describes how to publish and retrieve avatars in rooms.</abstract>
   &LEGALNOTICE;
   <number>xxxx</number>
   <status>ProtoXEP</status>
-  <type>Standard Track</type>
+  <type>Historical</type>
   <sig>Standards</sig>
   <approver>Council</approver>
   <dependencies>
@@ -25,18 +25,13 @@
   <supersedes/>
   <supersededby/>
   <shortname>NOT_YET_ASSIGNED</shortname>
-  <author>
+  &linkmauve;
-    <firstname>Emmanuel Gil</firstname>
+  <revision>
-    <surname>Peyrot</surname>
+    <version>0.0.3</version>
-    <email>linkmauve@linkmauve.fr</email>
+    <date>2023-02-15</date>
-    <jid>linkmauve@linkmauve.fr</jid>
+    <initials>egp</initials>
-  </author>
+    <remark><p>Restore to the first revision, and republish to the Historical track.</p></remark>
-  <author>
+  </revision>
-    <firstname>Timothée</firstname>
-    <surname>Jaussoin</surname>
-    <email>edhelas@movim.eu</email>
-    <jid>edhelas@movim.eu</jid>
-  </author>
   <revision>
     <version>0.0.2</version>
     <date>2018-11-03</date>
@@ -51,7 +46,7 @@
   </revision>
 </header>
 <section1 topic='Introduction' anchor='intro'>
-  <p>Avatars are small images people often use to identify each other very quickly in chat applications. They are well defined for users, in &xep0084; and &xep0153;, but until now chat rooms and Pubsub nodes all shared a default icon. This extension provides a way for owners to associates an avatar to the XMPP their resources and users to discover that an avatar is associated and display it accordingly.</p>
+  <p>Avatars are small images people often use to identify each other very quickly in chat applications.  They are well defined for users, in &xep0084; and &xep0153;, but until now chat rooms all shared a default icon.  This extension provides a way for owners to associates an avatar to their chat room, and for users to discover that an avatar is associated and display it accordingly.</p>
   <p>XMPP services have traditionally allowed owners to <link url='https://docs.ejabberd.im/tutorials/muc-vcard/'>set a vCard-temp on a MUC</link> using &xep0054;, this extension tries to keep as much of it as possible so existing applications don’t have to be modified too much.</p>
   <p>Some implementations recently chose to advertise those avatars using the existing &xep0153; extension in &lt;presence/&gt;, but it exposed issues in other implementations, and was only available when the user is already present in the room, not before joining it (for example when listing all available rooms).</p>
   <p>A future extension superseding this one could define a method based on &xep0084;, with a PubSub service on the room’s bare JID containing the metadata and data nodes.  Such a specification should also define a compatibility profile similar to &xep0398; for user avatars, enabling the coexistence of both versions until the present one is deemed obsolete.</p>
@@ -59,20 +54,18 @@
 <section1 topic='Requirements' anchor='reqs'>
   <p>This specification SHOULD:</p>
   <ul>
-    <li>Allow authorised entities to set an avatar on a MUC, user JID or Pubsub node.</li>
+    <li>Allow authorised entities to set an avatar on a MUC.</li>
-    <li>Allow authorised entities to remove a previously-set avatar on a MUC, user JID or Pubsub node.</li>
+    <li>Allow authorised entities to remove a previously-set avatar on a MUC.</li>
-    <li>Allow users to discover an avatar is set on a MUC, user JID or Pubsub node.</li>
+    <li>Allow users to discover an avatar is set on a MUC.</li>
-    <li>Allow users to request the avatar of a MUC, user JID or Pubsub node.</li>
+    <li>Allow users to request the avatar of a MUC.</li>
     <li>Let users know that the avatar of a MUC changed while they are present in said MUC.</li>
-    <li>Let users know that the avatar of a Pubsub node changed while they are subscribed to this node.</li>
+    <li>Let users discover the avatar even when not present in the MUC.</li>
-    <li>Let users know that the avatar of a user JID changed while they are subscribed to this user.</li>
+    <li>Stay as compatible as possible with the current usage of avatars in MUC.</li>
-    <li>Let users discover the avatar even when not present in the MUC, user JID or Pubsub node.</li>
-    <li>Stay as compatible as possible with the current usage of avatars in MUC and user JID.</li>
   </ul>
 </section1>
 <section1 topic='Use Cases' anchor='usecases'>
   <section2 topic='Discover the features supported by a service' anchor='disco'>
-    <p>Before trying to use avatars, a client must check that the related service that is hosting the rooms or Pubsub nodes does support them.</p>
+    <p>Before trying to use avatars, a client must check that the group chat service hosting a room does support them.</p>
     <example caption='User’s client discovers the features of a MUC service'><![CDATA[
 <iq type='get'
     id='p87Ne'
@@ -95,32 +88,9 @@
     ...
   </query>
 </iq>]]></example>
-
-    <example caption='User’s client discovers the features of a Pubsub service'><![CDATA[
-<iq type='get'
-    id='p88Ne'
-    from='romeo@montague.example.net/garden'
-    to='pubsub.shakespeare.example.org'>
-  <query xmlns='http://jabber.org/protocol/disco#info'/>
-</iq>]]></example>
-    <example caption='Pubsub service advertises support for vcard-temp'><![CDATA[
-<iq type='result'
-    id='p88Ne'
-    to='romeo@montague.example.net/garden'
-    from='chat.shakespeare.example.org'>
-  <query xmlns='http://jabber.org/protocol/disco#info'>
-    <identity
-        category='pubsub'
-        type='service'
-        name='Shakespearean Pubsub Service'/>
-    <feature var='http://jabber.org/protocol/muc'/>
-    <feature var='vcard-temp'/>
-    ...
-  </query>
-</iq>]]></example>
   </section2>
-  <section2 topic='Owner of the resource Publishes Avatar' anchor='owner-publish'>
+  <section2 topic='Owner of the Room Publishes Avatar' anchor='owner-publish'>
-    <p>Before anyone can see an avatar attached to the resource, an owner or some other priviledged entity must publish a vCard-temp containing the avatar’s data, using the protocol defined in &xep0054;.</p>
+    <p>Before anyone can see an avatar attached to the room, an owner or some other priviledged entity must publish a vCard-temp containing the avatar’s data, using the protocol defined in &xep0054;.</p>
     <example caption='Owner’s client publishes avatar to the room'><![CDATA[
 <iq type='set'
     id='7fP13'
@@ -138,29 +108,8 @@
     id='7fP13'
     to='romeo@montague.example.net/garden'
     from='garden@chat.shakespeare.example.org'/>]]></example>
-
-    <example caption='Owner’s client publishes avatar to the Pubsub node'><![CDATA[
-<iq type='set'
-    id='7fP14'
-    from='romeo@montague.example.net/garden'
-    to='pubsub.shakespeare.example.org'>
-  <configure node='princely_musings'>
-    <vCard xmlns='vcard-temp'>
-      <PHOTO>
-        <TYPE>image/svg+xml</TYPE>
-        <BINVAL>PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIzMiIgaGVpZ2h0PSIzMiI+CiA8cmVjdCB4PSIwIiB5PSIwIiB3aWR0aD0iMzIiIGhlaWdodD0iMzIiIGZpbGw9InJlZCIvPgo8L3N2Zz4K</BINVAL>
-      </PHOTO>
-    </vCard>
-  </configure>
-</iq>]]></example>
-    <example caption='Pubsub node acknowledges publish action'><![CDATA[
-<iq type='result'
-    id='7fP14'
-    to='romeo@montague.example.net/garden'
-    from='pubsub.shakespeare.example.org'/>]]></example>
-
     <p>There is no other action required on the owner’s end.</p>
-    <p>If the service doesn’t support support avatars, it must return a service-unavailable error.</p>
+    <p>If the room doesn’t support support avatars, it must return a service-unavailable error.</p>
     <example caption='Room doesn’t support vCard-temp'><![CDATA[
 <iq type='error'
     id='7fP13'
@@ -170,7 +119,7 @@
     <service-unavailable xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/>
   </error>
 </iq>]]></example>
-    <p>If the user trying to publish an avatar isn’t allowed to do so, the resource must return a forbidden error, see the <link url='#security'>Security Considerations</link>.</p>
+    <p>If the user trying to publish an avatar isn’t allowed to do so, the room must return a forbidden error, see the <link url='#security'>Security Considerations</link>.</p>
     <example caption='User is not allowed to set vCard-temp'><![CDATA[
 <iq type='error'
     id='7fP13'
@@ -181,7 +130,7 @@
     <text>Only owners are allowed to set avatars.</text>
   </error>
 </iq>]]></example>
-    <p>The resource should then broadcast a notification that the configuration changed to all users present or subscribed.</p>
+    <p>The room should then broadcast a notification that the configuration changed to all users present.</p>
     <example caption='Room broadcasts a configuration change'><![CDATA[
 <message type='groupchat'
          to='romeo@montague.example.net/garden'
@@ -198,16 +147,6 @@
     <status code='104'/>
   </x>
 </message>]]></example>
-
-    <p>For Pubsub nodes, the service broadcast a configuration change to all the subscribed users as described in the section 8.2.5.3 of &xep0060;.</p>
-
-    <example caption='User is not allowed to set vCard-temp'><![CDATA[
-<message from='pubsub.shakespeare.lit' to='francisco@denmark.lit' id='foo'>
-  <event xmlns='http://jabber.org/protocol/pubsub#event'>
-    <configuration node='princely_musings'/>
-  </event>
-</message>]]></example>
-
     <p>Setting an empty vCard unpublishes the avatar.</p>
     <example caption='Owner’s client removes a room’s avatar'><![CDATA[
 <iq type='set'
@@ -218,7 +157,7 @@
 </iq>]]></example>
   </section2>
   <section2 topic='User Discovers the Avatar' anchor='disco-avatar-hash'>
-    <p>At any point, whether it is during a join in order to display it in its UI, after having discovered the list of the rooms or Pubsub nodes and to list them with additional information, or when receiving a configuration change notification, a user’s client can discover information about a resource.</p>
+    <p>At any point, whether it is during a join in order to display it in its UI, after having discovered the list of the rooms and to list them with additional information, or when receiving a &lt;status code='104'/&gt; configuration change notification, a user’s client can discover information about a room.</p>
     <example caption='User’s client discovers information about a room'><![CDATA[
 <iq type='get'
     id='K92am'
@@ -226,7 +165,7 @@
     to='garden@chat.shakespeare.example.org'>
   <query xmlns='http://jabber.org/protocol/disco#info'/>
 </iq>]]></example>
-    <p>If the resource has had <link url='#owner-publish'>an avatar published</link>, it should advertise it in its 'muc#roominfo' or 'pubsub#meta-data' (see the section 5.4 of &xep0060;) extension form, using the &xep0153; hash computation method.</p>
+    <p>If the room has had <link url='#owner-publish'>an avatar published</link>, it should advertise it in its 'muc#roominfo' extension form, using the &xep0153; hash computation method.</p>
     <example caption='Room advertises its avatar hash'><![CDATA[
 <iq type='result'
     id='K92am'
@@ -254,35 +193,11 @@
     </x>
   </query>
 </iq>]]></example>
-
+    <p>This 'muc#roominfo_avatarhash' will not be present when the room doesn’t have an avatar set.</p>
-    <example caption='Pubsub node advertises its avatar hash'><![CDATA[
-<iq type='result'
-    from='pubsub.shakespeare.lit'
-    to='francisco@denmark.lit/barracks'
-    id='meta1'>
-  <query xmlns='http://jabber.org/protocol/disco#info'
-         node='princely_musings'>
-    <identity category='pubsub' type='leaf'/>
-    <feature var='http://jabber.org/protocol/pubsub'/>
-    <x xmlns='jabber:x:data' type='result'>
-      <field var='FORM_TYPE' type='hidden'>
-        <value>http://jabber.org/protocol/pubsub#meta-data</value>
-      </field>
-      ...
-      <field var='pubsub#meta-data_avatarhash'
-             type='text-multi'
-             label='Avatar hash'>
-        <value>a31c4bd04de69663cfd7f424a8453f4674da37ff</value>
-      </field>
-      ...
-    </x>
-  </query>
-</iq>]]></example>
-    <p>This 'muc#roominfo_avatarhash' or 'pubsubmuc#meta-data_avatarhash' are not present when the resource doesn’t have an avatar set.</p>
   </section2>
   <section2 topic='User Retrieves the vCard' anchor='retrieve-vcard'>
-    <p>At this point the client knows the hash and can retrieve the resource's vCard-temp.</p>
+    <p>At this point the client knows the hash and can retrieve the room’s vCard-temp.</p>
-    <example caption='User’s client retrieves the vCard-temp from a room'><![CDATA[
+    <example caption='User’s client retrieves the vCard-temp'><![CDATA[
 <iq type='get'
     id='uD10h'
     from='juliet@capulet.example.com/balcony'
@@ -301,44 +216,16 @@
     </PHOTO>
   </vCard>
 </iq>]]></example>
-    <p>To retrieve the vCard-temp of a Pubsub node the client is then doing a specific request on the Node metadata (see the section 5.4 of &xep0060;).</p>
+    <p>The client then has to decode the &lt;BINVAL/&gt; content from base64, hash it with sha1 and compare it with the advertised hash, and if it matches uses it as the room avatar under the &lt;TYPE/&gt; media type.</p>
-
-    <example caption='User’s client retrieves the vCard-temp from a Pubsub node'><![CDATA[
-<iq type='get'
-    from='francisco@denmark.lit/barracks'
-    to='pubsub.shakespeare.lit'
-    id='meta1'>
-  <query xmlns='http://jabber.org/protocol/disco#info'
-         node='princely_musings'>
-    <vCard xmlns='vcard-temp'/>
-  </query>
-</iq>]]></example>
-    <example caption='Pubsub node returns the vCard-temp containing the avatar'><![CDATA[
-<iq type='result'
-    from='pubsub.shakespeare.lit'
-    to='francisco@denmark.lit/barracks'
-    id='meta1'>
-  <query xmlns='http://jabber.org/protocol/disco#info'
-         node='princely_musings'>
-    <vCard xmlns='vcard-temp'>
-      <PHOTO>
-        <TYPE>image/svg+xml</TYPE>
-        <BINVAL>PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIzMiIgaGVpZ2h0PSIzMiI+CiA8cmVjdCB4PSIwIiB5PSIwIiB3aWR0aD0iMzIiIGhlaWdodD0iMzIiIGZpbGw9InJlZCIvPgo8L3N2Zz4K</BINVAL>
-      </PHOTO>
-    </vCard>
-  </query>
-</iq>]]></example>
-
-    <p>The client then has to decode the &lt;BINVAL/&gt; content from base64, hash it with sha1 and compare it with the advertised hash, and if it matches uses it as the resource avatar under the &lt;TYPE/&gt; media type.</p>
   </section2>
 </section1>
 <section1 topic='Business Rules' anchor='rules'>
   <p>An application MUST support the image/png media type, SHOULD support image/jpeg, image/gif and image/svg+xml, and MAY support additional formats.</p>
-  <p>A room or a Pubsub node SHOULD NOT include a 'muc#roominfo_avatarhash' or 'pubsubmuc#meta-data_avatarhash' field if it doesn’t have an avatar set.</p>
+  <p>A room SHOULD NOT include a 'muc#roominfo_avatarhash' field if it doesn’t have an avatar set.</p>
 </section1>
 <section1 topic='Implementation Notes' anchor='impl'>
   <section2 topic='Multiple Stored Version of an Avatar' anchor='multiple'>
-    <p>Multiple &lt;PHOTO/&gt; elements may be present in a vCard, in which case they should all represent the same image and the hash field must contain a hash of all of them.</p>
+    <p>Multiple &lt;PHOTO/&gt; elements may be present in a vCard, in which case they should all represent the same image and the 'muc#roominfo_avatarhash' field must contain a hash of all of them.</p>
     <example caption='Owner’s client publishes avatar in two different formats'><![CDATA[
 <iq type='set'
     id='7fP13'
@@ -416,19 +303,6 @@
       type='text-multi'
       label='Hash of the vCard-temp avatar of this room'/>
 </form_type>
-]]></code>
-    </section3>
-    <section3 topic='pubsub#meta-data FORM_TYPE' anchor='registrar-formtype-roominfo'>
-      <code caption='Registry Submission'><![CDATA[
-<form_type>
-  <name>http://jabber.org/protocol/pubsub#meta-data</name>
-  <doc>XEP-XXXX</doc>
-  <desc>Form extension for avatar support in a Pubsub node.</desc>
-  <field
-      var='pubsub#meta-data_avatarhash'
-      type='text-multi'
-      label='Hash of the vCard-temp avatar of this node'/>
-</form_type>
 ]]></code>
     </section3>
   </section2>