gecko/dom/tests/mochitest/general/test_clipboard_events.html

722 lines
25 KiB
HTML

<!DOCTYPE HTML>
<html>
<head>
<title>Test for Clipboard Events</title>
<script type="text/javascript" src="/MochiKit/MochiKit.js"></script>
<script type="text/javascript" src="/tests/SimpleTest/SimpleTest.js"></script>
<script type="application/javascript" src="/tests/SimpleTest/EventUtils.js"></script>
<link rel="stylesheet" type="text/css" href="/tests/SimpleTest/test.css" />
</head>
<body>
<p id="display"></p>
<div id="content" style="border: 3px solid black; padding: 3em;">CONTENT TEXT<input id="content-input" value="INPUT TEXT"></div>
<button id="button">Button</button>
<div id="syntheticSpot" oncut="compareSynthetic(event, 'cut')"
oncopy="compareSynthetic(event, 'copy')"
onpaste="compareSynthetic(event, 'paste')">Spot</div>
<pre id="test">
<script class="testbody" type="text/javascript;version=1.7">
// Enable full privledges for clipboard read/write operations.
netscape.security.PrivilegeManager.enablePrivilege('UniversalXPConnect');
var content = document.getElementById("content");
var contentInput = document.getElementById("content-input");
var clipboardInitialValue = "empty";
// Test that clearing and reading the clipboard works. A random number
// is used to make sure that leftover clipboard values from a previous
// test run don't cause a false-positive test.
var cb_text = "empty_" + Math.random();
setClipboardText(cb_text);
is(getClipboardText(), cb_text, "set/get clipboard text failed");
// Some test functions need to be run with delays.
var delayedTests = [];
var cachedCutData, cachedCopyData, cachedPasteData;
// Ensure window focus before running tests, otherwise key events can
// misfire. We set the onfocus event handler here to actually begin
// running tests, and call window.focus() afterwards.
window.onfocus = function()
{
window.onfocus = null;
netscape.security.PrivilegeManager.enablePrivilege('UniversalXPConnect');
// A list of test functions to run. Before each test function is run, the
// clipboard is initialized to clipboardInitialValue, and the contents of
// div#content are set as the window's selection.
var testFunctions = [
test_dom_oncopy,
test_dom_oncut,
test_dom_onpaste,
test_dom_oncopy_abort,
test_input_oncopy,
test_input_oncut,
test_input_onpaste,
test_input_oncopy_abort,
test_input_oncut_abort,
test_input_onpaste_abort,
test_input_cut_dataTransfer,
test_input_cut_abort_dataTransfer,
test_input_copy_dataTransfer,
test_input_paste_dataTransfer,
test_input_paste_abort_dataTransfer,
test_input_copypaste_dataTransfer_multiple,
test_input_copy_button_dataTransfer,
test_eventspref_disabled
];
// Run the main tests. This will also populate the delayedTests array
for (let i = 0; i < testFunctions.length; i++) {
// Init clipboard
setClipboardText(clipboardInitialValue);
// Reset value of contentInput.
contentInput.value = "INPUT TEXT";
var func = testFunctions[i];
func();
}
// Check if the cached clipboard data can be accessed or modified
// and whether it modifies the real clipboard
checkCachedDataTransfer(cachedCutData, "cut");
checkCachedDataTransfer(cachedCopyData, "copy");
checkCachedDataTransfer(cachedPasteData, "paste");
checkSyntheticEvents();
SimpleTest.finish();
}
// Calling .focus begins the test run.
SimpleTest.waitForExplicitFinish();
window.focus();
function getLoadContext() {
return window.QueryInterface(Components.interfaces.nsIInterfaceRequestor)
.getInterface(Components.interfaces.nsIWebNavigation)
.QueryInterface(Components.interfaces.nsILoadContext);
}
function getClipboardText() {
var trans = Components.classes["@mozilla.org/widget/transferable;1"]
.createInstance();
trans = trans.QueryInterface(Components.interfaces.nsITransferable);
trans.init(getLoadContext());
trans.addDataFlavor("text/unicode");
var clipboard = Components.classes["@mozilla.org/widget/clipboard;1"]
.getService();
clipboard = clipboard.QueryInterface(Components.interfaces.nsIClipboard);
clipboard.getData(trans, clipboard.kGlobalClipboard);
var str = new Object();
var strLen = new Object();
try {
trans.getTransferData("text/unicode", str, strLen);
} catch(e) {
// NS_ERROR_FAILURE will occur if the transferable object has no
// text/unicode data in it. In that case, it's not an error:
if (e instanceof Components.interfaces.nsIXPCException &&
e.result == Components.results.NS_ERROR_FAILURE) {
return null;
} else {
// if we don't know how to handle it then rethrow
throw e;
}
}
if (!str) return null;
str = str.value.QueryInterface(Components.interfaces.nsISupportsString);
if (!str) return null;
str = str.data.substring(0, strLen.value / 2);
if (!str) return null;
return str;
}
function setClipboardText(text) {
var helper = Components.classes["@mozilla.org/widget/clipboardhelper;1"]
.getService(Components.interfaces.nsIClipboardHelper);
helper.copyString(text);
}
function selectContentDiv() {
// Set selection
var selection = window.getSelection();
selection.removeAllRanges();
selection.selectAllChildren(content);
}
function selectContentInput() {
contentInput.select();
contentInput.focus();
}
function test_dom_oncopy() {
// Setup an oncopy event handler, fire copy. Ensure that the event
// handler was called, and the clipboard contents have set to CONTENT TEXT.
// Test firing oncopy event on ctrl-c:
selectContentDiv();
var oncopy_fired = false;
content.oncopy = function() { oncopy_fired = true; };
try {
synthesizeKey("c", {accelKey: 1});
ok(oncopy_fired, "copy event firing on DOM element");
is(getClipboardText(), "CONTENT TEXT",
"copy on DOM element set clipboard correctly");
} finally {
content.oncopy = null;
}
}
function test_dom_oncut() {
// Setup an oncut event handler, fire cut. Ensure that the event handler
// was called. The <div> doesn't handle a cut, so ensure that the
// clipboard text is clipboardInitialValue, NOT "CONTENT TEXT".
selectContentDiv();
var oncut_fired = false;
content.oncut = function() { oncut_fired = true; };
try {
synthesizeKey("x", {accelKey: 1});
ok(!oncut_fired, "cut event firing on DOM element")
is(getClipboardText(), clipboardInitialValue,
"cut on DOM element did not modify clipboard");
} finally {
content.oncut = null;
}
}
function test_dom_onpaste() {
// Setup an onpaste event handler, fire paste. Ensure that the event
// handler was called.
selectContentDiv();
var onpaste_fired = false;
content.onpaste = function() { onpaste_fired = true; };
try {
synthesizeKey("v", {accelKey: 1});
ok(!onpaste_fired, "paste event firing on DOM element");
} finally {
content.onpaste = null;
}
}
function test_dom_oncopy_abort() {
// Setup an oncopy event handler that aborts the copy, and fire the copy
// event. Ensure that the event handler was fired, and the clipboard
// contents have not been modified.
selectContentDiv();
var oncopy_fired = false;
content.oncopy = function() { oncopy_fired = true; return false; };
try {
synthesizeKey("c", {accelKey: 1});
ok(oncopy_fired, "copy event (to-be-cancelled) firing on DOM element");
is(getClipboardText(), clipboardInitialValue,
"aborted copy on DOM element did not modify clipboard");
} finally {
content.oncopy = null;
}
}
function test_input_oncopy() {
// Setup an oncopy event handler, fire copy. Ensure that the event
// handler was called, and the clipboard contents have been set to 'PUT TE',
// which is the part that is selected below.
selectContentInput();
contentInput.focus();
contentInput.setSelectionRange(2, 8);
var oncopy_fired = false;
contentInput.oncopy = function() { oncopy_fired = true; };
try {
synthesizeKey("c", {accelKey: 1});
ok(oncopy_fired, "copy event firing on plaintext editor");
is(getClipboardText(), "PUT TE",
"copy on plaintext editor set clipboard correctly");
} finally {
contentInput.oncopy = null;
}
}
function test_input_oncut() {
// Setup an oncut event handler, and fire cut. Ensure that the event
// handler was fired, the clipboard contains the INPUT TEXT, and
// that the input itself is empty.
selectContentInput();
var oncut_fired = false;
contentInput.oncut = function() { oncut_fired = true; };
try {
synthesizeKey("x", {accelKey: 1});
ok(oncut_fired, "cut event firing on plaintext editor");
is(getClipboardText(), "INPUT TEXT",
"cut on plaintext editor set clipboard correctly");
is(contentInput.value, "",
"cut on plaintext editor emptied editor");
} finally {
contentInput.oncut = null;
}
}
function test_input_onpaste() {
// Setup an onpaste event handler, and fire paste. Ensure that the event
// handler was fired, the clipboard contents didn't change, and that the
// input value did change (ie. paste succeeded).
selectContentInput();
var onpaste_fired = false;
contentInput.onpaste = function() { onpaste_fired = true; };
try {
synthesizeKey("v", {accelKey: 1});
ok(onpaste_fired, "paste event firing on plaintext editor");
is(getClipboardText(), clipboardInitialValue,
"paste on plaintext editor did not modify clipboard contents");
is(contentInput.value, clipboardInitialValue,
"paste on plaintext editor did modify editor value");
} finally {
contentInput.onpaste = null;
}
}
function test_input_oncopy_abort() {
// Setup an oncopy event handler, fire copy. Ensure that the event
// handler was called, and that the clipboard value did NOT change.
selectContentInput();
var oncopy_fired = false;
contentInput.oncopy = function() { oncopy_fired = true; return false; };
try {
synthesizeKey("c", {accelKey: 1});
ok(oncopy_fired, "copy event (to-be-cancelled) firing on plaintext editor");
is(getClipboardText(), clipboardInitialValue,
"aborted copy on plaintext editor did not modify clipboard");
} finally {
contentInput.oncopy = null;
}
}
function test_input_oncut_abort() {
// Setup an oncut event handler, and fire cut. Ensure that the event
// handler was fired, the clipboard contains the INPUT TEXT, and
// that the input itself is empty.
selectContentInput();
var oncut_fired = false;
contentInput.oncut = function() { oncut_fired = true; return false; };
try {
synthesizeKey("x", {accelKey: 1});
ok(oncut_fired, "cut event (to-be-cancelled) firing on plaintext editor");
is(getClipboardText(), clipboardInitialValue,
"aborted cut on plaintext editor did not modify clipboard.");
is(contentInput.value, "INPUT TEXT",
"aborted cut on plaintext editor did not modify editor contents");
} finally {
contentInput.oncut = null;
}
}
function test_input_onpaste_abort() {
// Setup an onpaste event handler, and fire paste. Ensure that the event
// handler was fired, the clipboard contents didn't change, and that the
// input value did change (ie. paste succeeded).
selectContentInput();
var onpaste_fired = false;
contentInput.onpaste = function() { onpaste_fired = true; return false; };
try {
synthesizeKey("v", {accelKey: 1});
ok(onpaste_fired,
"paste event (to-be-cancelled) firing on plaintext editor");
is(getClipboardText(), clipboardInitialValue,
"aborted paste on plaintext editor did not modify clipboard");
is(contentInput.value, "INPUT TEXT",
"aborted paste on plaintext editor did not modify modified editor value");
} finally {
contentInput.onpaste = null;
}
}
function test_input_cut_dataTransfer() {
// Cut using event.dataTransfer. The event is not cancelled so the default
// cut should occur
selectContentInput();
contentInput.oncut = function(event) {
ok(event instanceof ClipboardEvent, "cut event is a ClipboardEvent");
ok(event.clipboardData instanceof DataTransfer, "cut event dataTransfer is a DataTransfer");
is(event.target, contentInput, "cut event target");
is(event.clipboardData.mozItemCount, 0, "cut event mozItemCount");
is(event.clipboardData.getData("text/plain"), "", "cut event getData");
event.clipboardData.setData("text/plain", "This is some dataTransfer text");
cachedCutData = event.clipboardData;
};
try {
synthesizeKey("x", {accelKey: 1});
is(getClipboardText(), "INPUT TEXT",
"cut using dataTransfer on plaintext editor set clipboard correctly");
is(contentInput.value, "",
"cut using dataTransfer on plaintext editor cleared input");
} finally {
contentInput.oncut = null;
}
}
function test_input_cut_abort_dataTransfer() {
// Cut using event.dataTransfer but cancel the event. The data should be
// put on the clipboard but since we don't modify the input value, the input
// should have the same value.
selectContentInput();
contentInput.oncut = function(event) {
event.clipboardData.setData("text/plain", "Cut dataTransfer text");
return false;
};
try {
synthesizeKey("x", {accelKey: 1});
is(getClipboardText(), "Cut dataTransfer text",
"aborted cut using dataTransfer on plaintext editor set clipboard correctly");
is(contentInput.value, "INPUT TEXT",
"aborted cut using dataTransfer on plaintext editor did not modify input");
} finally {
contentInput.oncut = null;
}
}
function test_input_copy_dataTransfer() {
// Copy using event.dataTransfer
selectContentInput();
contentInput.oncopy = function(event) {
ok(event instanceof ClipboardEvent, "copy event is a ClipboardEvent");
ok(event.clipboardData instanceof DataTransfer, "copy event dataTransfer is a DataTransfer");
is(event.target, contentInput, "copy event target");
is(event.clipboardData.mozItemCount, 0, "copy event mozItemCount");
is(event.clipboardData.getData("text/plain"), "", "copy event getData");
event.clipboardData.setData("text/plain", "Copied dataTransfer text");
cachedCopyData = event.clipboardData;
};
try {
synthesizeKey("c", {accelKey: 1});
is(getClipboardText(), "INPUT TEXT",
"copy using dataTransfer on plaintext editor set clipboard correctly");
is(contentInput.value, "INPUT TEXT",
"copy using dataTransfer on plaintext editor did not modify input");
} finally {
contentInput.oncopy = null;
}
}
function test_input_copy_abort_dataTransfer() {
// Copy using event.dataTransfer but cancel the event.
selectContentInput();
contentInput.oncopy = function(event) {
event.clipboardData.setData("text/plain", "Copy dataTransfer text");
return false;
};
try {
synthesizeKey("x", {accelKey: 1});
is(getClipboardText(), "Copy dataTransfer text",
"aborted copy using dataTransfer on plaintext editor set clipboard correctly");
is(contentInput.value, "INPUT TEXT",
"aborted copy using dataTransfer on plaintext editor did not modify input");
} finally {
contentInput.oncopy = null;
}
}
function test_input_paste_dataTransfer() {
// Paste using event.dataTransfer
selectContentInput();
contentInput.onpaste = function(event) {
ok(event instanceof ClipboardEvent, "paste event is an ClipboardEvent");
ok(event.clipboardData instanceof DataTransfer, "paste event dataTransfer is a DataTransfer");
is(event.target, contentInput, "paste event target");
is(event.clipboardData.mozItemCount, 1, "paste event mozItemCount");
is(event.clipboardData.getData("text/plain"), clipboardInitialValue, "paste event getData");
cachedPasteData = event.clipboardData;
};
try {
synthesizeKey("v", {accelKey: 1});
is(getClipboardText(), clipboardInitialValue,
"paste using dataTransfer on plaintext editor did not modify clipboard contents");
is(contentInput.value, clipboardInitialValue,
"paste using dataTransfer on plaintext editor modified input");
} finally {
contentInput.onpaste = null;
}
}
function test_input_paste_abort_dataTransfer() {
// Paste using event.dataTransfer but cancel the event
selectContentInput();
contentInput.onpaste = function(event) {
is(event.clipboardData.getData("text/plain"), clipboardInitialValue, "get data on aborted paste");
contentInput.value = "Alternate Paste";
return false;
};
try {
synthesizeKey("v", {accelKey: 1});
is(getClipboardText(), clipboardInitialValue,
"aborted paste using dataTransfer on plaintext editor did not modify clipboard contents");
is(contentInput.value, "Alternate Paste",
"aborted paste using dataTransfer on plaintext editor modified input");
} finally {
contentInput.onpaste = null;
}
}
function test_input_copypaste_dataTransfer_multiple() {
// Cut several types of data and paste it again
contentInput.value = "This is a line of text";
contentInput.oncopy = function(event) {
var cd = event.clipboardData;
cd.setData("text/plain", "would be a phrase");
var exh = false;
try { cd.mozSetDataAt("text/plain", "Text", 1); } catch (ex) { exh = true; }
ok(exh, "exception occured mozSetDataAt 1");
exh = false;
try { cd.mozTypesAt(1); } catch (ex) { exh = true; }
ok(exh, "exception occured mozTypesAt 1");
exh = false;
try { cd.mozGetDataAt("text/plain", 1); } catch (ex) { exh = true; }
ok(exh, "exception occured mozGetDataAt 1");
exh = false;
try { cd.mozClearDataAt("text/plain", 1); } catch (ex) { exh = true; }
ok(exh, "exception occured mozClearDataAt 1");
cd.setData("text/x-moz-url", "http://www.mozilla.org");
cd.mozSetDataAt("text/x-custom", "Custom Text", 0);
is(cd.mozItemCount, 1, "mozItemCount after set multiple types");
return false;
};
try {
selectContentInput();
synthesizeKey("c", {accelKey: 1});
}
finally {
contentInput.oncopy = null;
}
is(getClipboardText(), "would be a phrase", "copy multiple types text");
contentInput.setSelectionRange(5, 14);
contentInput.onpaste = function(event) {
var cd = event.clipboardData;
is(cd.mozItemCount, 1, "paste after copy multiple types mozItemCount");
is(cd.getData("text/plain"), "would be a phrase", "paste text/plain multiple types");
// Firefox for Android's clipboard code doesn't handle x-moz-url. Therefore
// disabling the following test. Enable this once bug #840101 is fixed.
if (navigator.appVersion.indexOf("Android") == -1) {
is(cd.getData("text/x-moz-url"), "http://www.mozilla.org", "paste text/x-moz-url multiple types");
}
// this is empty because only the built-in types are supported at the moment
is(cd.getData("text/x-custom"), "", "paste text/custom multiple types");
exh = false;
try { cd.setData("text/plain", "Text on Paste"); } catch (ex) { exh = true; }
ok(exh, "exception occured setData on paste");
is(cd.getData("text/plain"), "would be a phrase", "text/plain data unchanged");
};
try {
synthesizeKey("v", {accelKey: 1});
is(contentInput.value, "This would be a phrase of text",
"default paste after copy multiple types");
} finally {
contentInput.onpaste = null;
}
}
function test_input_copy_button_dataTransfer() {
// Copy using event.dataTransfer when a button is focused.
var button = document.getElementById("button");
button.focus();
button.oncopy = function(event) {
ok(false, "should not be firing copy event on button");
return false;
};
try {
// copy should not occur here because buttons don't have any controller
// for the copy command
synthesizeKey("c", {accelKey: 1});
is(getClipboardText(), clipboardInitialValue,
"copy using dataTransfer on plaintext editor set clipboard correctly for button");
selectContentDiv();
synthesizeKey("c", {accelKey: 1});
is(getClipboardText(), "CONTENT TEXT",
"copy using dataTransfer with selection on plaintext editor set clipboard correctly for button");
} finally {
document.documentElement.oncopy = null;
}
}
function test_eventspref_disabled() {
// Disable clipboard events
SpecialPowers.setBoolPref("dom.event.clipboardevents.enabled", false);
var event_fired = false;
contentInput.oncut = function() { event_fired = true; };
contentInput.oncopy = function() { event_fired = true; };
contentInput.onpaste = function() { event_fired = true; };
try {
selectContentInput();
contentInput.setSelectionRange(1, 4);
synthesizeKey("x", {accelKey: 1});
is(contentInput.value, "IT TEXT", "cut changed text when preference is disabled");
is(getClipboardText(), "NPU", "cut changed clipboard when preference is disabled");
ok(!event_fired, "cut event did not fire when preference is disabled")
event_fired = false;
contentInput.setSelectionRange(3, 6);
synthesizeKey("c", {accelKey: 1});
is(getClipboardText(), "TEX", "copy changed clipboard when preference is disabled");
ok(!event_fired, "copy event did not fire when preference is disabled")
event_fired = false;
contentInput.setSelectionRange(0, 2);
synthesizeKey("v", {accelKey: 1});
is(contentInput.value, "TEX TEXT", "paste changed text when preference is disabled");
ok(!event_fired, "paste event did not fire when preference is disabled")
} finally {
contentInput.oncut = null;
contentInput.oncopy = null;
contentInput.onpaste = null;
}
SpecialPowers.clearUserPref("dom.event.clipboardevents.enabled");
}
let expectedData = [];
// Check to make that synthetic events do not change the clipboard
function checkSyntheticEvents()
{
let syntheticSpot = document.getElementById("syntheticSpot");
setClipboardText(clipboardInitialValue);
// No dataType specified
let event = new ClipboardEvent("cut", { data: "something" });
expectedData = { type: "cut", data: null }
compareSynthetic(event, "before");
syntheticSpot.dispatchEvent(event);
ok(expectedData.eventFired, "cut event fired");
compareSynthetic(event, "after");
event = new ClipboardEvent("cut", { dataType: "text/plain", data: "something" });
expectedData = { type: "cut", dataType: "text/plain", data: "something" }
compareSynthetic(event, "before");
syntheticSpot.dispatchEvent(event);
ok(expectedData.eventFired, "cut event fired");
compareSynthetic(event, "after");
event = new ClipboardEvent("copy", { dataType: "text/plain", data: "something" });
expectedData = { type: "copy", dataType: "text/plain", data: "something" }
compareSynthetic(event, "before");
syntheticSpot.dispatchEvent(event);
ok(expectedData.eventFired, "copy event fired");
compareSynthetic(event, "after");
event = new ClipboardEvent("copy", { dataType: "text/plain" });
expectedData = { type: "copy", dataType: "text/plain", data: "" }
compareSynthetic(event, "before");
syntheticSpot.dispatchEvent(event);
ok(expectedData.eventFired, "copy event fired");
compareSynthetic(event, "after");
event = new ClipboardEvent("paste", { dataType: "text/plain", data: "something" });
expectedData = { type: "paste", dataType: "text/plain", data: "something" }
compareSynthetic(event, "before");
syntheticSpot.dispatchEvent(event);
ok(expectedData.eventFired, "paste event fired");
compareSynthetic(event, "after");
event = new ClipboardEvent("paste", { dataType: "application/unknown", data: "unknown" });
expectedData = { type: "paste", dataType: "application/unknown", data: "unknown" }
compareSynthetic(event, "before");
syntheticSpot.dispatchEvent(event);
ok(expectedData.eventFired, "paste event fired");
compareSynthetic(event, "after");
}
function compareSynthetic(event, eventtype)
{
let step = (eventtype == "cut" || eventtype == "copy" || eventtype == "paste") ? "during" : eventtype;
if (step == "during") {
is(eventtype, expectedData.type, "synthetic " + eventtype + " event fired");
}
ok(event.clipboardData instanceof DataTransfer, "clipboardData is assigned");
is(event.type, expectedData.type, "synthetic " + eventtype + " event type");
if (expectedData.data === null) {
is(event.clipboardData.mozItemCount, 0, "synthetic " + eventtype + " empty data");
}
else {
is(event.clipboardData.mozItemCount, 1, "synthetic " + eventtype + " item count");
is(event.clipboardData.types.length, 1, "synthetic " + eventtype + " types length");
is(event.clipboardData.getData(expectedData.dataType), expectedData.data,
"synthetic " + eventtype + " data");
}
is(getClipboardText(), "empty", "event does not change the clipboard " + step + " dispatch");
if (step == "during") {
expectedData.eventFired = true;
}
}
function checkCachedDataTransfer(cd, eventtype)
{
var testprefix = "cached " + eventtype + " dataTransfer";
setClipboardText("Some Clipboard Text");
var oldtext = cd.getData("text/plain");
ok(oldtext != "Some Clipboard Text", "clipboard get using " + testprefix);
var exh = false;
try { cd.mozSetDataAt("text/plain", "Test Cache Data", 0); } catch (ex) { exh = true; }
ok(eventtype == "paste" ? exh : !exh, "exception occured setting " + testprefix);
var newtext = (eventtype == "paste") ? cd.getData("text/plain") :
cd.mozGetDataAt("text/plain", 0);
is(newtext, (eventtype == "paste") ? "" : "Test Cache Data",
" clipboardData not changed using " + testprefix);
is(getClipboardText(), "Some Clipboard Text", "clipboard not changed using " + testprefix);
var exh = false;
try { cd.mozClearDataAt("text/plain", 0); } catch (ex) { exh = true; }
ok(eventtype == "paste" ? exh : !exh, "exception occured clearing " + testprefix);
is(getClipboardText(), "Some Clipboard Text", "clipboard not changed using " + testprefix);
}
</script>
</pre>
</body>
</html>