mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-11-15 18:39:52 +00:00
7cec9ae04a
Allow pasting of rich (HTML) content. ve.ce.Surface * Use a sliced document clone for converting to DM HTML (copy) * Add full context to pasteTarget before copying * Add ve-pasteProtect class to spans to prevent them being dropped * Implement external paste by converting HTML to data and inserting with newFromDocumentInsertion * Remove clipboard key placeholder after read so they aren't picked up by rich paste. Hash no longer includes the placeholder. * Detect the corruption of important spans and fallback to clipboard data HTML if available. ve.dm.LinearData * Add clone method for copy ve.dm.ElementLinearData * Add compareUnannotated for use by context diffing. * Add sanitize method for cleaning data according to a set of rules. ve.dm.Transaction * Add range parameter for inserting a range of a document only, e.g. stripping the paste context. ve.dm.Document * Implement sliced document clone creation so that DM HTML is generated correctly in onCopy ve.dm.DocumentSlice * Replaces LinearDataSlice. Now has two ranges for balanced data and data with a full context. ve.init.Target.js * Define default, loose, paste rules (just remove aliens). ve.init.mw.ViewPageTarget * Define strict MW paste rules: + no links, spans, underlines + no images, divs, aliens + strip extra HTML attribues ve.init.sa.Target, ve.init.mw.ViewPageTarget, ve.ui.Surface * Pass through and store paste rules. Bug: 41193 Bug: 48170 Bug: 50128 Bug: 53828 Change-Id: I38d63e31ee3e3ee11707e3fffed5174e1d633b42
578 lines
15 KiB
JavaScript
578 lines
15 KiB
JavaScript
/*!
|
|
* VisualEditor ContentEditable Surface tests.
|
|
*
|
|
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
*/
|
|
|
|
QUnit.module( 've.ce.Surface' );
|
|
|
|
/* Tests */
|
|
|
|
ve.test.utils.runSurfaceHandleDeleteTest = function ( assert, html, range, operations, expectedData, expectedRange, msg ) {
|
|
var i, args,
|
|
selection,
|
|
deleteArgs = {
|
|
'backspace': [ {}, true ],
|
|
'delete': [ {}, false ],
|
|
'modifiedBackspace': [ { 'ctrlKey': true }, true ],
|
|
'modifiedDelete': [ { 'ctrlKey': true }, false ]
|
|
},
|
|
surface = ve.test.utils.createSurfaceFromHtml( html || ve.dm.example.html ),
|
|
view = surface.getView(),
|
|
model = surface.getModel(),
|
|
data = ve.copy( model.getDocument().getFullData() );
|
|
|
|
// TODO: model.getSelection() should be consistent after it has been
|
|
// changed but appears to behave differently depending on the browser.
|
|
// The selection from the select event is still consistent.
|
|
selection = range;
|
|
model.on( 'select', function( s ) {
|
|
selection = s;
|
|
} );
|
|
|
|
model.setSelection( range );
|
|
for ( i = 0; i < operations.length; i++ ) {
|
|
args = deleteArgs[operations[i]];
|
|
view.handleDelete( args[0], args[1] );
|
|
}
|
|
expectedData( data );
|
|
|
|
assert.deepEqualWithDomElements( model.getDocument().getFullData(), data, msg + ': data' );
|
|
assert.deepEqual( selection, expectedRange, msg + ': range' );
|
|
surface.destroy();
|
|
};
|
|
|
|
QUnit.test( 'handleDelete', function ( assert ) {
|
|
var i,
|
|
cases = [
|
|
{
|
|
'range': new ve.Range( 2 ),
|
|
'operations': ['backspace'],
|
|
'expectedData': function ( data ) {
|
|
data.splice( 1, 1 );
|
|
},
|
|
'expectedRange': new ve.Range( 1 ),
|
|
'msg': 'Character deleted by backspace'
|
|
},
|
|
{
|
|
'range': new ve.Range( 2 ),
|
|
'operations': ['delete'],
|
|
'expectedData': function ( data ) {
|
|
data.splice( 2, 1 );
|
|
},
|
|
'expectedRange': new ve.Range( 2 ),
|
|
'msg': 'Character deleted by delete'
|
|
},
|
|
{
|
|
'range': new ve.Range( 1, 4 ),
|
|
'operations': ['backspace'],
|
|
'expectedData': function ( data ) {
|
|
data.splice( 1, 3 );
|
|
},
|
|
'expectedRange': new ve.Range( 1 ),
|
|
'msg': 'Selection deleted by backspace'
|
|
},
|
|
{
|
|
'range': new ve.Range( 1, 4 ),
|
|
'operations': ['delete'],
|
|
'expectedData': function ( data ) {
|
|
data.splice( 1, 3 );
|
|
},
|
|
'expectedRange': new ve.Range( 1 ),
|
|
'msg': 'Selection deleted by delete'
|
|
},
|
|
{
|
|
'range': new ve.Range( 4 ),
|
|
'operations': ['modifiedBackspace'],
|
|
'expectedData': function ( data ) {
|
|
data.splice( 1, 3 );
|
|
},
|
|
'expectedRange': new ve.Range( 1 ),
|
|
'msg': 'Whole word deleted by modified backspace'
|
|
},
|
|
{
|
|
'range': new ve.Range( 1 ),
|
|
'operations': ['modifiedDelete'],
|
|
'expectedData': function ( data ) {
|
|
data.splice( 1, 3 );
|
|
},
|
|
'expectedRange': new ve.Range( 1 ),
|
|
'msg': 'Whole word deleted by modified delete'
|
|
},
|
|
{
|
|
'range': new ve.Range( 1, 4 ),
|
|
'operations': ['delete', 'delete'],
|
|
'expectedData': function ( data ) {
|
|
data.splice( 0, 5 );
|
|
},
|
|
'expectedRange': new ve.Range( 1 ),
|
|
'msg': 'Empty node deleted by delete'
|
|
},
|
|
{
|
|
'range': new ve.Range( 41 ),
|
|
'operations': ['backspace'],
|
|
'expectedData': function () {},
|
|
'expectedRange': new ve.Range( 39, 41 ),
|
|
'msg': 'Focusable node selected but not deleted by backspace'
|
|
},
|
|
{
|
|
'range': new ve.Range( 39 ),
|
|
'operations': ['delete'],
|
|
'expectedData': function () {},
|
|
'expectedRange': new ve.Range( 39, 41 ),
|
|
'msg': 'Focusable node selected but not deleted by delete'
|
|
},
|
|
{
|
|
'range': new ve.Range( 39, 41 ),
|
|
'operations': ['delete'],
|
|
'expectedData': function ( data ) {
|
|
data.splice( 39, 2 );
|
|
},
|
|
'expectedRange': new ve.Range( 39 ),
|
|
'msg': 'Focusable node deleted if selected first'
|
|
}
|
|
];
|
|
|
|
QUnit.expect( cases.length * 2 );
|
|
|
|
for ( i = 0; i < cases.length; i++ ) {
|
|
ve.test.utils.runSurfaceHandleDeleteTest(
|
|
assert, cases[i].html, cases[i].range, cases[i].operations,
|
|
cases[i].expectedData, cases[i].expectedRange, cases[i].msg
|
|
);
|
|
}
|
|
} );
|
|
|
|
QUnit.test( 'onContentChange', function ( assert ) {
|
|
var i,
|
|
cases = [
|
|
{
|
|
'prevHtml': '<p></p>',
|
|
'prevRange': new ve.Range( 1 ),
|
|
'nextHtml': '<p>A</p>',
|
|
'nextRange': new ve.Range( 2 ),
|
|
'expectedOps': [
|
|
[
|
|
{ 'type': 'retain', 'length': 1 },
|
|
{
|
|
'type': 'replace',
|
|
'insert': [ 'A' ],
|
|
'remove': []
|
|
},
|
|
{ 'type': 'retain', 'length': 3 }
|
|
]
|
|
],
|
|
'msg': 'Simple insertion into empty paragraph'
|
|
},
|
|
{
|
|
'prevHtml': '<p>A</p>',
|
|
'prevRange': new ve.Range( 1, 2 ),
|
|
'nextHtml': '<p>B</p>',
|
|
'nextRange': new ve.Range( 2 ),
|
|
'expectedOps': [
|
|
[
|
|
{ 'type': 'retain', 'length': 1 },
|
|
{
|
|
'type': 'replace',
|
|
'insert': [ 'B' ],
|
|
'remove': []
|
|
},
|
|
{ 'type': 'retain', 'length': 4 }
|
|
],
|
|
[
|
|
{ 'type': 'retain', 'length': 2 },
|
|
{
|
|
'type': 'replace',
|
|
'insert': [],
|
|
'remove': [ 'A' ]
|
|
},
|
|
{ 'type': 'retain', 'length': 3 }
|
|
]
|
|
],
|
|
'msg': 'Simple replace'
|
|
},
|
|
{
|
|
'prevHtml': '<p><a href="Foo">A</a><a href="Bar">FooX?</a></p>',
|
|
'prevRange': new ve.Range( 5, 6 ),
|
|
'nextHtml': '<p><a href="Foo">A</a><a href="Bar">FooB?</a></p>',
|
|
'nextRange': new ve.Range( 6 ),
|
|
'expectedOps': [
|
|
[
|
|
{ 'type': 'retain', 'length': 5 },
|
|
{
|
|
'type': 'replace',
|
|
'insert': [ ['B', [1]] ],
|
|
'remove': []
|
|
},
|
|
{ 'type': 'retain', 'length': 5 }
|
|
],
|
|
[
|
|
{ 'type': 'retain', 'length': 6 },
|
|
{
|
|
'type': 'replace',
|
|
'insert': [],
|
|
'remove': [ ['X', [1]] ]
|
|
},
|
|
{ 'type': 'retain', 'length': 4 }
|
|
]
|
|
],
|
|
'msg': 'Replace into non-zero annotation next to word break'
|
|
}
|
|
];
|
|
|
|
QUnit.expect( cases.length * 2 );
|
|
|
|
function testRunner( prevHtml, prevRange, nextHtml, nextRange, expectedOps, expectedRange, msg ) {
|
|
var txs, i, ops,
|
|
surface = ve.test.utils.createSurfaceFromHtml( prevHtml ),
|
|
view = surface.getView().getDocument().getDocumentNode().children[0],
|
|
prevNode = $( prevHtml )[0],
|
|
nextNode = $( nextHtml )[0],
|
|
prev = {
|
|
'text': ve.ce.getDomText( prevNode ),
|
|
'hash': ve.ce.getDomHash( prevNode ),
|
|
'range': prevRange
|
|
},
|
|
next = {
|
|
'text': ve.ce.getDomText( nextNode ),
|
|
'hash': ve.ce.getDomHash( nextNode ),
|
|
'range': nextRange
|
|
};
|
|
|
|
surface.getView().onContentChange( view, prev, next );
|
|
txs = surface.getModel().getHistory()[0].stack;
|
|
ops = [];
|
|
for ( i = 0; i < txs.length; i++ ) {
|
|
ops.push( txs[i].getOperations() );
|
|
}
|
|
assert.deepEqual( ops, expectedOps, msg + ': operations' );
|
|
assert.deepEqual( surface.getModel().getSelection(), expectedRange, msg + ': range' );
|
|
|
|
surface.destroy();
|
|
}
|
|
|
|
for ( i = 0; i < cases.length; i++ ) {
|
|
testRunner(
|
|
cases[i].prevHtml, cases[i].prevRange, cases[i].nextHtml, cases[i].nextRange,
|
|
cases[i].expectedOps, cases[i].expectedRange || cases[i].nextRange, cases[i].msg
|
|
);
|
|
}
|
|
|
|
} );
|
|
|
|
QUnit.test( 'getClipboardHash', 1, function ( assert ) {
|
|
assert.equal(
|
|
ve.ce.Surface.static.getClipboardHash(
|
|
$( $.parseHTML( ' <p class="foo"> Bar </p>\n\t<span class="baz"></span> Quux <h1><span></span>Whee</h1>' ) )
|
|
),
|
|
'Bar<SPAN>QuuxWhee',
|
|
'Simple usage'
|
|
);
|
|
} );
|
|
|
|
QUnit.test( 'onCopy', function ( assert ) {
|
|
var i, testClipboardData,
|
|
testEvent = {
|
|
'originalEvent': {
|
|
'clipboardData': {
|
|
'setData': function ( prop, val ) {
|
|
testClipboardData[prop] = val;
|
|
return true;
|
|
}
|
|
}
|
|
},
|
|
'preventDefault': function() {}
|
|
},
|
|
cases = [
|
|
{
|
|
'range': new ve.Range( 27, 32 ),
|
|
'expectedData': [
|
|
{ 'type': 'list', 'attributes': { 'style': 'number' } },
|
|
{ 'type': 'listItem' },
|
|
{ 'type': 'paragraph' },
|
|
'g',
|
|
{ 'type': '/paragraph' },
|
|
{ 'type': '/listItem' },
|
|
{ 'type': '/list' },
|
|
{ 'type': 'internalList' },
|
|
{ 'type': '/internalList' }
|
|
],
|
|
'expectedOriginalRange': new ve.Range( 1, 6 ),
|
|
'expectedBalancedRange': new ve.Range( 1, 6 ),
|
|
'msg': 'Copy list item'
|
|
}
|
|
];
|
|
|
|
QUnit.expect( cases.length * 4 );
|
|
|
|
function testRunner( doc, range, expectedData, expectedOriginalRange, expectedBalancedRange, msg ) {
|
|
var clipboardKey, parts, clipboardIndex, slice,
|
|
surface = ve.test.utils.createSurfaceFromDocument(
|
|
doc || ve.dm.example.createExampleDocument()
|
|
),
|
|
view = surface.getView(),
|
|
model = surface.getModel();
|
|
|
|
// Paste sequence
|
|
model.setSelection( range );
|
|
testClipboardData = {};
|
|
view.onCopy( testEvent );
|
|
|
|
clipboardKey = testClipboardData['text/xcustom'];
|
|
|
|
assert.equal( clipboardKey, view.clipboardId + '-0', msg + ': clipboardId set' );
|
|
|
|
parts = clipboardKey.split( '-' );
|
|
clipboardIndex = parts[1];
|
|
slice = view.clipboard[clipboardIndex].slice;
|
|
|
|
assert.deepEqual( slice.data.data, expectedData, msg + ': data' );
|
|
assert.deepEqual( slice.originalRange, expectedOriginalRange, msg + ': originalRange' );
|
|
assert.deepEqual( slice.balancedRange, expectedBalancedRange, msg + ': balancedRange' );
|
|
|
|
surface.destroy();
|
|
}
|
|
|
|
for ( i = 0; i < cases.length; i++ ) {
|
|
testRunner(
|
|
cases[i].doc, cases[i].range, cases[i].expectedData,
|
|
cases[i].expectedOriginalRange, cases[i].expectedBalancedRange, cases[i].msg
|
|
);
|
|
}
|
|
|
|
} );
|
|
|
|
QUnit.test( 'beforePaste/afterPaste', function ( assert ) {
|
|
var i, exampleDoc = '<p></p><p>Foo</p>',
|
|
TestEvent = function ( data ) {
|
|
this.originalEvent = {
|
|
'clipboardData': {
|
|
'getData': function ( prop ) {
|
|
return data[prop];
|
|
}
|
|
}
|
|
};
|
|
this.preventDefault = function() {};
|
|
},
|
|
cases = [
|
|
{
|
|
'range': new ve.Range( 1 ),
|
|
'pasteTargetHtml': 'Foo',
|
|
'expectedRange': new ve.Range( 4 ),
|
|
'expectedOps': [
|
|
[
|
|
{ 'type': 'retain', 'length': 1 },
|
|
{
|
|
'type': 'replace',
|
|
'insert': [
|
|
'F', 'o', 'o',
|
|
],
|
|
'remove': []
|
|
},
|
|
{ 'type': 'retain', 'length': 8 }
|
|
]
|
|
],
|
|
'msg': 'Text into empty paragraph'
|
|
},
|
|
{
|
|
'range': new ve.Range( 4 ),
|
|
'pasteTargetHtml': 'Bar',
|
|
'expectedRange': new ve.Range( 7 ),
|
|
'expectedOps': [
|
|
[
|
|
{ 'type': 'retain', 'length': 4 },
|
|
{
|
|
'type': 'replace',
|
|
'insert': [ 'B', 'a', 'r' ],
|
|
'remove': []
|
|
},
|
|
{ 'type': 'retain', 'length': 5 }
|
|
]
|
|
],
|
|
'msg': 'Text into paragraph'
|
|
},
|
|
{
|
|
'range': new ve.Range( 4 ),
|
|
'pasteTargetHtml': '<p>Bar</p>',
|
|
'expectedRange': new ve.Range( 7 ),
|
|
'expectedOps': [
|
|
[
|
|
{ 'type': 'retain', 'length': 4 },
|
|
{
|
|
'type': 'replace',
|
|
'insert': [ 'B', 'a', 'r' ],
|
|
'remove': []
|
|
},
|
|
{ 'type': 'retain', 'length': 5 }
|
|
]
|
|
],
|
|
'msg': 'Paragraph into paragraph'
|
|
},
|
|
{
|
|
'range': new ve.Range( 6 ),
|
|
'pasteTargetHtml': '<p>Bar</p>',
|
|
'expectedRange': new ve.Range( 9 ),
|
|
'expectedOps': [
|
|
[
|
|
{ 'type': 'retain', 'length': 6 },
|
|
{
|
|
'type': 'replace',
|
|
'insert': [ 'B', 'a', 'r' ],
|
|
'remove': []
|
|
},
|
|
{ 'type': 'retain', 'length': 3 }
|
|
]
|
|
],
|
|
'msg': 'Paragraph at end of paragraph'
|
|
},
|
|
{
|
|
'range': new ve.Range( 3 ),
|
|
'pasteTargetHtml': '<p>Bar</p>',
|
|
'expectedRange': new ve.Range( 6 ),
|
|
'expectedOps': [
|
|
[
|
|
{ 'type': 'retain', 'length': 3 },
|
|
{
|
|
'type': 'replace',
|
|
'insert': [ 'B', 'a', 'r' ],
|
|
'remove': []
|
|
},
|
|
{ 'type': 'retain', 'length': 6 }
|
|
]
|
|
],
|
|
'msg': 'Paragraph at start of paragraph'
|
|
},
|
|
{
|
|
'range': new ve.Range( 4 ),
|
|
'pasteTargetHtml': 'BfooA',
|
|
'expectedRange': new ve.Range( 9 ),
|
|
'expectedOps': [
|
|
[
|
|
{ 'type': 'retain', 'length': 4 },
|
|
{
|
|
'type': 'replace',
|
|
'insert': [ 'B', 'f', 'o', 'o', 'A' ],
|
|
'remove': []
|
|
},
|
|
{ 'type': 'retain', 'length': 5 }
|
|
]
|
|
],
|
|
'msg': 'Left/right placeholder characters'
|
|
},
|
|
{
|
|
'range': new ve.Range( 6 ),
|
|
'pasteTargetHtml': '<ul><li>Foo</li></ul>',
|
|
'expectedRange': new ve.Range( 6 ),
|
|
'expectedOps': [
|
|
[
|
|
{ 'type': 'retain', 'length': 7 },
|
|
{
|
|
'type': 'replace',
|
|
'insert': [
|
|
{ 'type': 'list', 'attributes': { 'style': 'bullet' } },
|
|
{ 'type': 'listItem' },
|
|
{ 'type': 'paragraph', 'internal': { 'generated': 'wrapper' } },
|
|
'F', 'o', 'o',
|
|
{ 'type': '/paragraph' },
|
|
{ 'type': '/listItem' },
|
|
{ 'type': '/list' }
|
|
],
|
|
'remove': []
|
|
},
|
|
{ 'type': 'retain', 'length': 2 }
|
|
]
|
|
],
|
|
'msg': 'List at end of paragraph (moves insertion point)'
|
|
}
|
|
];
|
|
|
|
QUnit.expect( cases.length * 2 );
|
|
|
|
function testRunner( documentHtml, pasteTargetHtml, clipboardHtml, range, expectedOps, expectedRange, msg ) {
|
|
var i, txs, ops,
|
|
surface = ve.test.utils.createSurfaceFromHtml( documentHtml || exampleDoc ),
|
|
view = surface.getView(),
|
|
model = surface.getModel();
|
|
|
|
// Paste sequence
|
|
model.setSelection( range );
|
|
if ( pasteTargetHtml ) {
|
|
view.beforePaste( { 'originalEvent': {} } );
|
|
document.execCommand( 'insertHTML', false, pasteTargetHtml ) ;
|
|
} else {
|
|
view.beforePaste( new TestEvent( { 'text/xcustom': '0.123-0', 'text/html': clipboardHtml } ) );
|
|
}
|
|
view.afterPaste();
|
|
|
|
txs = model.getHistory()[0].stack;
|
|
ops = [];
|
|
for ( i = 0; i < txs.length; i++ ) {
|
|
ops.push( txs[i].getOperations() );
|
|
}
|
|
assert.deepEqual( ops, expectedOps, msg + ': operations' );
|
|
assert.deepEqual( model.getSelection(), expectedRange, msg + ': range' );
|
|
|
|
surface.destroy();
|
|
}
|
|
|
|
for ( i = 0; i < cases.length; i++ ) {
|
|
testRunner(
|
|
cases[i].documentHtml, cases[i].pasteTargetHtml, cases[i].clipboardHtml,
|
|
cases[i].range, cases[i].expectedOps, cases[i].expectedRange, cases[i].msg
|
|
);
|
|
}
|
|
|
|
} );
|
|
|
|
/* Methods with return values */
|
|
// TODO: ve.ce.Surface#hasSlugAtOffset
|
|
// TODO: ve.ce.Surface#getClickCount
|
|
// TODO: ve.ce.Surface#needsPawn
|
|
// TODO: ve.ce.Surface#getSurface
|
|
// TODO: ve.ce.Surface#getModel
|
|
// TODO: ve.ce.Surface#getDocument
|
|
// TODO: ve.ce.Surface#getFocusedNode
|
|
// TODO: ve.ce.Surface#isRenderingLocked
|
|
// TODO: ve.ce.Surface#getDir
|
|
|
|
/* Methods without return values */
|
|
// TODO: ve.ce.Surface#getSelectionRect
|
|
// TODO: ve.ce.Surface#initialize
|
|
// TODO: ve.ce.Surface#enable
|
|
// TODO: ve.ce.Surface#disable
|
|
// TODO: ve.ce.Surface#destroy
|
|
// TODO: ve.ce.Surface#focus
|
|
// TODO: ve.ce.Surface#documentOnFocus
|
|
// TODO: ve.ce.Surface#documentOnBlur
|
|
// TODO: ve.ce.Surface#onDocumentMouseDown
|
|
// TODO: ve.ce.Surface#onDocumentMouseUp
|
|
// TODO: ve.ce.Surface#onDocumentMouseMove
|
|
// TODO: ve.ce.Surface#onDocumentDragOver
|
|
// TODO: ve.ce.Surface#onDocumentDrop
|
|
// TODO: ve.ce.Surface#onDocumentKeyDown
|
|
// TODO: ve.ce.Surface#onDocumentKeyPress
|
|
// TODO: ve.ce.Surface#afterDocumentKeyPress
|
|
// TODO: ve.ce.Surface#onDocumentKeyUp
|
|
// TODO: ve.ce.Surface#onCut
|
|
// TODO: ve.ce.Surface#onCopy
|
|
// TODO: ve.ce.Surface#onPaste
|
|
// TODO: ve.ce.Surface#onDocumentCompositionEnd
|
|
// TODO: ve.ce.Surface#onChange
|
|
// TODO: ve.ce.Surface#onSelectionChange
|
|
// TODO: ve.ce.Surface#onLock
|
|
// TODO: ve.ce.Surface#onUnlock
|
|
// TODO: ve.ce.Surface#startRelocation
|
|
// TODO: ve.ce.Surface#endRelocation
|
|
// TODO: ve.ce.Surface#handleLeftOrRightArrowKey
|
|
// TODO: ve.ce.Surface#handleUpOrDownArrowKey
|
|
// TODO: ve.ce.Surface#handleInsertion
|
|
// TODO: ve.ce.Surface#handleEnter
|
|
// TODO: ve.ce.Surface#handleDelete
|
|
// TODO: ve.ce.Surface#showSelection
|
|
// TODO: ve.ce.Surface#replacePhantoms
|
|
// TODO: ve.ce.Surface#replaceHighlight
|
|
// TODO: ve.ce.Surface#getNearestCorrectOffset
|
|
// TODO: ve.ce.Surface#incRenderLock
|
|
// TODO: ve.ce.Surface#decRenderLock
|