Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add unsanitized option to async clipboard API. #197

Merged
merged 10 commits into from Nov 21, 2023
Merged

Add unsanitized option to async clipboard API. #197

Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
dcf28f6
Add `unsanitized` option to async clipboard API.
snianu Oct 30, 2023
e8c1a9b
Address PR comments.
snianu Oct 31, 2023
26100d7
Address PR comments.
snianu Oct 31, 2023
ddb5503
Address PR comments.
snianu Nov 10, 2023
9da00db
Addressed PR comments.
snianu Nov 15, 2023
ad4077b
Addressed PR comments.
snianu Nov 16, 2023
4211ab2
Addressed comments.
snianu Nov 16, 2023
f96a21c
Address comments.
snianu Nov 18, 2023
9e5e1b7
Address comments.
snianu Nov 18, 2023
0312e3e
Add clarification.
snianu Nov 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
47 changes: 43 additions & 4 deletions index.bs
View file
Open in desktop
Expand Up @@ -542,6 +542,18 @@ url: https://w3c.github.io/permissions/#permissions-task-source; type: dfn;
* Custom format [=string/starts with=] `"web "`("web" followed by U+0020 SPACE) prefix
and suffix (after stripping out `"web "`) passes the [=parsing a MIME type=] check.

<h3 id="unsanitized-data-types-x"><dfn>Unsanitized data types</dfn></h3>

These data types MUST NOT be sanitized by UAs:

* image/png
snianu marked this conversation as resolved.
Show resolved Hide resolved

* [=optional unsanitized data types=]

<dfn>Optional unsanitized data types</dfn> are [=representation/mime type=]s specified by the web authors that MUST NOT be sanitized by the user agent.
The valid [=optional unsanitized data types=] are listed below:

* text/html

<h2 id="async-clipboard-api">Asynchronous Clipboard API</h2>

Expand Down Expand Up @@ -620,6 +632,7 @@ url: https://w3c.github.io/permissions/#permissions-task-source; type: dfn;
Some platforms may support having more than one [=/clipboard item=] at a time on the [=clipboard=], while other platforms replace the previous [=/clipboard item=] with the new one.

A [=/clipboard item=] has a <dfn>list of representations</dfn>, each <dfn>representation</dfn> with an associated <dfn for=representation>mime type</dfn> (a [=/MIME type=]), an <dfn for="representation">isCustom</dfn> flag, initially |false|, that indicates if this [=representation=] should be treated as a [=web custom format=] (as opposed to a well-known format of the [=system clipboard=]), and <dfn for=representation>data</dfn> (a {{ClipboardItemData}}).

A <dfn>web custom format</dfn> has [=representation/isCustom=] set to |true|.

<p class=note>
Expand Down Expand Up @@ -782,11 +795,15 @@ url: https://w3c.github.io/permissions/#permissions-task-source; type: dfn;

[SecureContext, Exposed=Window]
interface Clipboard : EventTarget {
Promise&lt;ClipboardItems&gt; read();
Promise&lt;ClipboardItems&gt; read(optional ClipboardUnsanitizedFormats formats = {});
snianu marked this conversation as resolved.
Show resolved Hide resolved
Promise&lt;DOMString&gt; readText();
Promise&lt;undefined&gt; write(ClipboardItems data);
Promise&lt;undefined&gt; writeText(DOMString data);
};

dictionary ClipboardUnsanitizedFormats {
sequence&lt;DOMString&gt; unsanitized;
};
</pre>

Some methods of the {{Clipboard}} interface take or return multiple {{ClipboardItem}} objects. However, not all platforms support more than one [=/clipboard item=]; on such platforms, the algorithms below will ignore any {{ClipboardItem}} objects beyond the first one that are passed to {{Clipboard/write()}}, and {{Clipboard/read()}} and {{Clipboard/readText()}} only get one clipboard item from the OS.
Expand All @@ -798,17 +815,25 @@ url: https://w3c.github.io/permissions/#permissions-task-source; type: dfn;
{{Clipboard/read()}} returns a {{Promise}} to [=clipboard items=] object that represents contents of [=system clipboard data=].
</p>

{{ClipboardUnsanitizedFormats/unsanitized}} is a [=sequence=] of {{DOMString}}s corresponding to the [=representation/mime type=] that the author wants to be treated as [=optional unsanitized data types=].

The <dfn>clipboard task source</dfn> is triggered in response to reading or writing of [=system clipboard data=].

<div id="clipboard-idl" dfn-for="Clipboard">
<div class="algorithm" data-algorithm="clipboard-read">
<h4 method for="Clipboard">read()</h4>
The {{Clipboard/read()}} method must run these steps:
<h4 method for="Clipboard">read(|formats|)</h4>
The {{Clipboard/read(formats)}} method must run these steps:

1. Let |realm| be [=this=]'s [=relevant realm=].

1. Let |p| be [=a new promise=] in |realm|.

1. If |formats| is not empty, then:

1. For each |format| in |formats|["{{ClipboardUnsanitizedFormats/unsanitized}}"]:

1. If |format| is not in [=optional unsanitized data types=], then [=reject=] |p| with |format| {{"NotAllowedError"}} {{DOMException}} in |realm|.
sanketj marked this conversation as resolved.
Show resolved Hide resolved

1. Run the following steps [=in parallel=]:

1. Let |r| be the result of running [=check clipboard read permission=].
Expand Down Expand Up @@ -837,13 +862,27 @@ url: https://w3c.github.io/permissions/#permissions-task-source; type: dfn;

1. Set |representation|'s [=representation/MIME type=] to |mimeType|.

1. Let |isUnsanitized| be |false|.
snianu marked this conversation as resolved.
Show resolved Hide resolved

1. If |formats| is not empty, then:

1. For each |format| in |formats|["{{ClipboardUnsanitizedFormats/unsanitized}}"]:

1. If |format| is equal to [=representation/MIME type=], set |isUnsanitized| to true.

1. Set |representation|'s [=representation/data=] to |systemClipboardRepresentation|'s [=system clipboard representation/data=].

Issue: It should be possible to read the data asynchronously from the system clipboard after the author calls getType, however, this set of steps implies that data will be provided at the time of read.

1. The user agent, MAY sanitize |representation|'s [=representation/data=], unless |representation|'s [=representation/MIME type=]'s essence is "image/png", which should remain unsanitized to preserve meta data.
1. The user agent, MUST NOT sanitize |representation|'s [=representation/data=], if it satisfies the below conditions:

1. |representation|'s [=representation/MIME type=] is in [=unsanitized data types=] list.
snianu marked this conversation as resolved.
Show resolved Hide resolved

1. |isUnsanitized| is true.

1. Append |representation| to |item|'s [=list of representations=].

1. Set |isUnsanitized| to |false|.

1. If |item|'s [=list of representations=] size is greater than 0, append |item| to |items|.

Expand Down