forked from mirrors/gecko-dev
14d41cb7f9
In bug 1755863, we introduce two async APIs in `nsIClipboard` to make async clipboard API reads the clipboard data asynchronously. When reading, async clipboard API first check the available types, and then retrieve the actual data for that type. This process has a potential race condition: the clipboard content might change between the time between the time we check the types and when we retrieve the data. Although we currently fetch the actual data immediately after checking available types (in line with the spec), this minimizes the chance of encountering this race condition. However, if we would like to support retrieving the data only when `getType()` is invoked (bug 1691825), this potential race condition could become a significant issue. Furthermore, bug 1777448 aims to have a way to track the clipboard data and suppress the paste context menu when the clipboard data originates from a same-origin page. This also requires a better way to track read requests, clipboard content and invalidate the request when the system's clipboard content is changed. After some refacting around nsBaseClipboard, all platform now use sequence number to track clipboard content, so `nsIAsyncGetClipboardData` can be associated with a sequence number and deemed invalid if the associated sequence number isn't matched the latest system value. With these new API, it also becomes possible to write some tests. Depends on D191409 Differential Revision: https://phabricator.services.mozilla.com/D182108
224 lines
5.9 KiB
JavaScript
224 lines
5.9 KiB
JavaScript
/* Any copyright is dedicated to the Public Domain.
|
|
http://creativecommons.org/publicdomain/zero/1.0/ */
|
|
|
|
"use strict";
|
|
|
|
const Cc = SpecialPowers.Cc;
|
|
const Ci = SpecialPowers.Ci;
|
|
const Cr = SpecialPowers.Cr;
|
|
const clipboard = SpecialPowers.Services.clipboard;
|
|
const clipboardTypes = [
|
|
clipboard.kGlobalClipboard,
|
|
clipboard.kSelectionClipboard,
|
|
clipboard.kFindClipboard,
|
|
clipboard.kSelectionCache,
|
|
];
|
|
|
|
function emptyClipboardData(aType) {
|
|
// XXX gtk doesn't support emptying clipboard data which is stored from
|
|
// other application (bug 1853884). As a workaround, we set dummy data
|
|
// to the clipboard first to ensure the subsequent emptyClipboard call
|
|
// works.
|
|
if (navigator.platform.includes("Linux")) {
|
|
writeStringToClipboard("foo", "text/plain", aType);
|
|
}
|
|
|
|
clipboard.emptyClipboard(aType);
|
|
}
|
|
|
|
function cleanupAllClipboard() {
|
|
clipboardTypes.forEach(function (type) {
|
|
if (clipboard.isClipboardTypeSupported(type)) {
|
|
info(`cleanup clipboard ${type}`);
|
|
emptyClipboardData(type);
|
|
}
|
|
});
|
|
}
|
|
|
|
function generateRandomString() {
|
|
return "random number: " + Math.random();
|
|
}
|
|
|
|
function generateNewTransferable(aFlavor, aStr) {
|
|
let trans = Cc["@mozilla.org/widget/transferable;1"].createInstance(
|
|
Ci.nsITransferable
|
|
);
|
|
trans.init(null);
|
|
trans.addDataFlavor(aFlavor);
|
|
|
|
let supportsStr = Cc["@mozilla.org/supports-string;1"].createInstance(
|
|
Ci.nsISupportsString
|
|
);
|
|
supportsStr.data = aStr;
|
|
trans.setTransferData(aFlavor, supportsStr);
|
|
|
|
return trans;
|
|
}
|
|
|
|
function addStringToTransferable(aFlavor, aStr, aTrans) {
|
|
aTrans.addDataFlavor(aFlavor);
|
|
|
|
let supportsStr = Cc["@mozilla.org/supports-string;1"].createInstance(
|
|
Ci.nsISupportsString
|
|
);
|
|
supportsStr.data = aStr;
|
|
aTrans.setTransferData(aFlavor, supportsStr);
|
|
}
|
|
|
|
function updateStringToTransferable(aFlavor, aStr, aTrans) {
|
|
let supportsStr = Cc["@mozilla.org/supports-string;1"].createInstance(
|
|
Ci.nsISupportsString
|
|
);
|
|
supportsStr.data = aStr;
|
|
aTrans.setTransferData(aFlavor, supportsStr);
|
|
}
|
|
|
|
function writeStringToClipboard(
|
|
aStr,
|
|
aFlavor,
|
|
aClipboardType,
|
|
aClipboardOwner = null,
|
|
aAsync = false
|
|
) {
|
|
let trans = Cc["@mozilla.org/widget/transferable;1"].createInstance(
|
|
Ci.nsITransferable
|
|
);
|
|
trans.init(null);
|
|
trans.addDataFlavor(aFlavor);
|
|
|
|
let supportsStr = Cc["@mozilla.org/supports-string;1"].createInstance(
|
|
Ci.nsISupportsString
|
|
);
|
|
supportsStr.data = aStr;
|
|
trans.setTransferData(aFlavor, supportsStr);
|
|
|
|
if (aAsync) {
|
|
let request = clipboard.asyncSetData(aClipboardType);
|
|
request.setData(trans, aClipboardOwner);
|
|
return;
|
|
}
|
|
|
|
clipboard.setData(trans, aClipboardOwner, aClipboardType);
|
|
// XXX gtk doesn't support get empty text data from clipboard, bug 1852983.
|
|
if (aStr == "" && navigator.platform.includes("Linux")) {
|
|
todo_is(
|
|
getClipboardData(aFlavor, aClipboardType),
|
|
"",
|
|
`Should get empty string on clipboard type ${aClipboardType}`
|
|
);
|
|
} else {
|
|
is(
|
|
getClipboardData(aFlavor, aClipboardType),
|
|
// On Windows, widget adds extra data into HTML clipboard.
|
|
aFlavor == "text/html" && navigator.platform.includes("Win")
|
|
? `<html><body>\n<!--StartFragment-->${aStr}<!--EndFragment-->\n</body>\n</html>`
|
|
: aStr,
|
|
"ensure clipboard data is set"
|
|
);
|
|
}
|
|
}
|
|
|
|
function writeRandomStringToClipboard(
|
|
aFlavor,
|
|
aClipboardType,
|
|
aClipboardOwner = null,
|
|
aAsync = false
|
|
) {
|
|
let randomString = generateRandomString();
|
|
writeStringToClipboard(
|
|
randomString,
|
|
aFlavor,
|
|
aClipboardType,
|
|
aClipboardOwner,
|
|
aAsync
|
|
);
|
|
return randomString;
|
|
}
|
|
|
|
function getClipboardData(aFlavor, aClipboardType) {
|
|
var trans = Cc["@mozilla.org/widget/transferable;1"].createInstance(
|
|
Ci.nsITransferable
|
|
);
|
|
trans.init(null);
|
|
trans.addDataFlavor(aFlavor);
|
|
clipboard.getData(trans, aClipboardType);
|
|
|
|
try {
|
|
var data = SpecialPowers.createBlankObject();
|
|
trans.getTransferData(aFlavor, data);
|
|
return data.value.QueryInterface(SpecialPowers.Ci.nsISupportsString).data;
|
|
} catch (ex) {
|
|
// If the clipboard is empty getTransferData will throw.
|
|
return null;
|
|
}
|
|
}
|
|
|
|
function asyncGetClipboardData(aClipboardType) {
|
|
return new Promise((resolve, reject) => {
|
|
try {
|
|
clipboard.asyncGetData(
|
|
["text/plain", "text/html", "image/png"],
|
|
aClipboardType,
|
|
{
|
|
QueryInterface: SpecialPowers.ChromeUtils.generateQI([
|
|
"nsIAsyncClipboardGetCallback",
|
|
]),
|
|
// nsIAsyncClipboardGetCallback
|
|
onSuccess: SpecialPowers.wrapCallback(function (
|
|
aAsyncGetClipboardData
|
|
) {
|
|
resolve(aAsyncGetClipboardData);
|
|
}),
|
|
onError: SpecialPowers.wrapCallback(function (aResult) {
|
|
reject(aResult);
|
|
}),
|
|
}
|
|
);
|
|
} catch (e) {
|
|
ok(false, `asyncGetData should not throw`);
|
|
reject(e);
|
|
}
|
|
});
|
|
}
|
|
|
|
function asyncClipboardRequestGetData(aRequest, aFlavor, aThrows = false) {
|
|
return new Promise((resolve, reject) => {
|
|
var trans = Cc["@mozilla.org/widget/transferable;1"].createInstance(
|
|
Ci.nsITransferable
|
|
);
|
|
trans.init(null);
|
|
trans.addDataFlavor(aFlavor);
|
|
try {
|
|
aRequest.getData(trans, aResult => {
|
|
if (aResult != Cr.NS_OK) {
|
|
reject(aResult);
|
|
return;
|
|
}
|
|
|
|
try {
|
|
var data = SpecialPowers.createBlankObject();
|
|
trans.getTransferData(aFlavor, data);
|
|
resolve(data.value.QueryInterface(Ci.nsISupportsString).data);
|
|
} catch (ex) {
|
|
// XXX: should widget set empty string to transferable when there no
|
|
// data in system clipboard?
|
|
resolve("");
|
|
}
|
|
});
|
|
ok(
|
|
!aThrows,
|
|
`nsIAsyncGetClipboardData.getData should ${
|
|
aThrows ? "throw" : "success"
|
|
}`
|
|
);
|
|
} catch (e) {
|
|
ok(
|
|
aThrows,
|
|
`nsIAsyncGetClipboardData.getData should ${
|
|
aThrows ? "throw" : "success"
|
|
}`
|
|
);
|
|
reject(e);
|
|
}
|
|
});
|
|
}
|