From 03f70629342b065f6d078214d13cca2477dca02d Mon Sep 17 00:00:00 2001 From: Marvin W Date: Sun, 17 Jul 2022 22:39:26 +0200 Subject: [PATCH] XEP-0447: Stateless File Sharing v0.2.0 Add disposition attribute to signal when inlining is desired. --- xep-0447.xml | 31 +++++++++++++++++++++++++------ 1 file changed, 25 insertions(+), 6 deletions(-) diff --git a/xep-0447.xml b/xep-0447.xml index 0b5eff47..18f7139b 100644 --- a/xep-0447.xml +++ b/xep-0447.xml @@ -17,12 +17,18 @@ XMPP Core XEP-0001 - XEP-xxxx + XEP-0446 sfs &larma; + + 0.2.0 + 2022-08-03 + lmw + Add disposition attribute to signal when inlining is desired. + 0.1.2 2022-02-10 @@ -77,12 +83,13 @@

To share a file, a user sends a message stanza including <file-sharing/> to the inteded recipient contact or group. + The <file-sharing/> element MAY have a disposition attribute with a value of either attachment or inline. The <file-sharing/> element includes a <file/> metadata element as described in &xep0446; as well as a <sources/> element. The <sources/> element provides one or multiple sources that the receiving client may use to obtain the file.

- + image/jpeg summit.jpg @@ -113,7 +120,7 @@

- + Photo from the summit: https://download.montague.lit/4a771ac1-f0b2-4a4a-9700-f2a26fa2bb67/summit.jpg @@ -123,7 +130,7 @@

If the message has an empty body, it is RECOMMENDED to add a message processing hint, see &xep0334;, to indicate the message to be stored in message stores like &xep0313;.

- + @@ -139,6 +146,10 @@ If the file is not available locally, the file can be obtained by one of the sources listed in the <sources/> element. If further sources have been attached (as described in Attaching a source), the receiving entity may also try to obtain the file from any of those.

+

+ The receiving entity SHOULD NOT fetch the file without prior user interaction if the disposition attribute is set to attachment. + The receiving entity MAY fetch the file without prior user interaction otherwise, but when doing so, user's privacy, security (see Security Considerations) and network constraints should be considered. +

When the source is an <url-data/> element as described in &xep0103;, the receiving entity MAY obtain the file by downloading it from the specified URL. If the URL uses HTTP or HTTPS and additional HTTP request information as specified in &xep0104; is provided, the receiving entity SHOULD use such information when obtaining the file. @@ -154,9 +165,13 @@ The details of obtaining such file are out of scope of this document.

- If the <media-type/> of the shared file is such that it can be displayed inline, the receiving entity MAY display the file inline. - If no <media-type/> is provided or the <media-type/> indicates that the file can not be displayed inline, i.e. when the media type is application/octet-stream, the receiving entity SHOULD NOT display the file inline and instead offer to download it or save it on the users file system. + The intended method to provide or display a file to the user depends on the disposition attribute, <media-type/> and file type support of the receiving entity:

+
    +
  • If the disposition attribute is set to attachment, no <media-type/> is provided or the <media-type/> indicates that the file can not be displayed inline, i.e. when the media type is application/octet-stream, the receiving entity SHOULD NOT display the file inline and instead offer to download it or save it on the user's file system.
    • +
  • If the disposition attribute is set to inline, the receiving entity SHOULD attempt to display the file inline. When displaying the file inline fails, the receiving entity SHOULD indicate to the user that the file was meant to be displayed inline but that the file type was not supported for inline display and offer to open the file using an external viewer or to download the file or save it to the user's file system instead.
    • +
  • If no disposition attribute is set and the <media-type/> of the shared file indicates that it can be displayed inline, the receiving entity MAY display the file inline. When displaying the file inline fails, the receiving entity SHOULD NOT display any error and instead offer to open the file using an external viewer or to download the file or safe it to the user's file system.
    • +

TODO: The following section relies on &xep0367;, however other methods to attach information to another message like the recently proposed &xep0422; might be suitable here as well. This is to be clarified before advancing to Draft.

@@ -183,6 +198,10 @@ ]]> + +

Entities that support displaying moving images inline SHOULD have an option to turn this functionality off and display a still image instead.

+

Entities that support displaying files inline SHOULD have an option to turn this functionality off entirely.

+

If a <hash/> using any supported algorithm is provided, the receiving client SHOULD verify that the <hash/> of the announced file matches the obained file before presenting it to the user.