Skip to content

Commit

Permalink
Remove TinyMCE paste plugin (#9091)
Browse files Browse the repository at this point in the history
* Use normal clipboard API

* Clean up

* Add clipboardData fallback for IE11

* Fix for IE11

* Better comments

* HTML => html

* docs: tweak comment placement
  • Loading branch information
ellatrix authored Aug 21, 2018
1 parent 6d1d284 commit 1d92884
Show file tree
Hide file tree
Showing 4 changed files with 39 additions and 54 deletions.
6 changes: 0 additions & 6 deletions lib/client-assets.php
Original file line number Diff line number Diff line change
Expand Up @@ -554,7 +554,6 @@ function gutenberg_register_scripts_and_styles() {
array(
'lodash',
'tinymce-latest-lists',
'tinymce-latest-paste',
'tinymce-latest-table',
'wp-a11y',
'wp-api-fetch',
Expand Down Expand Up @@ -797,11 +796,6 @@ function gutenberg_register_vendor_scripts() {
'https://unpkg.com/tinymce@' . $tinymce_version . '/plugins/lists/plugin' . $suffix . '.js',
array( 'wp-tinymce' )
);
gutenberg_register_vendor_script(
'tinymce-latest-paste',
'https://unpkg.com/tinymce@' . $tinymce_version . '/plugins/paste/plugin' . $suffix . '.js',
array( 'wp-tinymce' )
);
gutenberg_register_vendor_script(
'tinymce-latest-table',
'https://unpkg.com/tinymce@' . $tinymce_version . '/plugins/table/plugin' . $suffix . '.js',
Expand Down
8 changes: 4 additions & 4 deletions packages/blocks/src/api/raw-handling/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ import {
/**
* Browser dependencies
*/
const { log, warn } = window.console;
const { console } = window;

export { getPhrasingContentSchema };

Expand All @@ -50,7 +50,7 @@ function filterInlineHTML( HTML ) {
HTML = removeInvalidHTML( HTML, getPhrasingContentSchema(), { inline: true } );

// Allows us to ask for this information when we get a report.
log( 'Processed inline HTML:\n\n', HTML );
console.log( 'Processed inline HTML:\n\n', HTML );

return HTML;
}
Expand Down Expand Up @@ -173,7 +173,7 @@ export default function rawHandler( { HTML = '', plainText = '', mode = 'AUTO',
piece = normaliseBlocks( piece );

// Allows us to ask for this information when we get a report.
log( 'Processed HTML piece:\n\n', piece );
console.log( 'Processed HTML piece:\n\n', piece );

const doc = document.implementation.createHTMLDocument( '' );

Expand All @@ -183,7 +183,7 @@ export default function rawHandler( { HTML = '', plainText = '', mode = 'AUTO',
const rawTransformation = findTransform( rawTransformations, ( { isMatch } ) => isMatch( node ) );

if ( ! rawTransformation ) {
warn(
console.warn(
'A block registered a raw transformation schema for `' + node.nodeName + '` but did not match it. ' +
'Make sure there is a `selector` or `isMatch` property that can match the schema.\n' +
'Sanitized HTML: `' + node.outerHTML + '`'
Expand Down
74 changes: 33 additions & 41 deletions packages/editor/src/components/rich-text/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,6 @@ export class RichText extends Component {
this.onKeyUp = this.onKeyUp.bind( this );
this.changeFormats = this.changeFormats.bind( this );
this.onPropagateUndo = this.onPropagateUndo.bind( this );
this.onPastePreProcess = this.onPastePreProcess.bind( this );
this.onPaste = this.onPaste.bind( this );
this.onCreateUndoLevel = this.onCreateUndoLevel.bind( this );
this.setFocusedElement = this.setFocusedElement.bind( this );
Expand Down Expand Up @@ -162,8 +161,6 @@ export class RichText extends Component {
editor.on( 'keydown', this.onKeyDown );
editor.on( 'keyup', this.onKeyUp );
editor.on( 'BeforeExecCommand', this.onPropagateUndo );
editor.on( 'PastePreProcess', this.onPastePreProcess, true /* Add before core handlers */ );
editor.on( 'paste', this.onPaste, true /* Add before core handlers */ );
editor.on( 'focus', this.onFocus );
editor.on( 'input', this.onChange );
// The change event in TinyMCE fires every time an undo level is added.
Expand Down Expand Up @@ -255,21 +252,38 @@ export class RichText extends Component {
* @param {PasteEvent} event The paste event as triggered by TinyMCE.
*/
onPaste( event ) {
const dataTransfer =
event.clipboardData ||
event.dataTransfer ||
this.editor.getDoc().dataTransfer ||
// Removes the need for further `dataTransfer` checks.
{ getData: () => '' };

const { items = [], files = [], types = [] } = dataTransfer;
const clipboardData = event.clipboardData;
const { items = [], files = [] } = clipboardData;
const item = find( [ ...items, ...files ], ( { type } ) => /^image\/(?:jpe?g|png|gif)$/.test( type ) );
const plainText = dataTransfer.getData( 'text/plain' );
const HTML = dataTransfer.getData( 'text/html' );
let plainText = '';
let html = '';

// IE11 only supports `Text` as an argument for `getData` and will
// otherwise throw an invalid argument error, so we try the standard
// arguments first, then fallback to `Text` if they fail.
try {
plainText = clipboardData.getData( 'text/plain' );
html = clipboardData.getData( 'text/html' );
} catch ( error1 ) {
try {
html = clipboardData.getData( 'Text' );
} catch ( error2 ) {
// Some browsers like UC Browser paste plain text by default and
// don't support clipboardData at all, so allow default
// behaviour.
return;
}
}

event.preventDefault();

// Allows us to ask for this information when we get a report.
window.console.log( 'Received HTML:\n\n', html );
window.console.log( 'Received plain text:\n\n', plainText );

// Only process file if no HTML is present.
// Note: a pasted file may have the URL as plain text.
if ( item && ! HTML ) {
if ( item && ! html ) {
const file = item.getAsFile ? item.getAsFile() : item;
const content = rawHandler( {
HTML: `<img src="${ createBlobURL( file ) }">`,
Expand All @@ -290,36 +304,13 @@ export class RichText extends Component {
this.props.setTimeout( () => this.splitContent( content ) );
}

event.preventDefault();
return;
}

this.pastedPlainText = plainText;
this.isPlainTextPaste = types.length === 1 && types[ 0 ] === 'text/plain';
}

/**
* Handles a PrePasteProcess event from TinyMCE.
*
* Will call the paste handler with the pasted data. If it is a string tries
* to put it in the containing TinyMCE editor. Otherwise call the `onSplit`
* handler.
*
* @param {PrePasteProcessEvent} event The PrePasteProcess event as triggered
* by TinyMCE.
*/
onPastePreProcess( event ) {
const HTML = this.isPlainTextPaste ? '' : event.content;

event.preventDefault();

// Allows us to ask for this information when we get a report.
window.console.log( 'Received HTML:\n\n', HTML );
window.console.log( 'Received plain text:\n\n', this.pastedPlainText );

// There is a selection, check if a URL is pasted.
if ( ! this.editor.selection.isCollapsed() ) {
const linkRegExp = /^(?:https?:)?\/\/\S+$/i;
const pastedText = event.content.replace( /<[^>]+>/g, '' ).trim();
const pastedText = ( html || plainText ).replace( /<[^>]+>/g, '' ).trim();

// A URL was pasted, turn the selection into a link
if ( linkRegExp.test( pastedText ) ) {
Expand All @@ -345,8 +336,8 @@ export class RichText extends Component {
}

const content = rawHandler( {
HTML,
plainText: this.pastedPlainText,
HTML: html,
plainText,
mode,
tagName: this.props.tagName,
canUserUseUnfilteredHTML: this.props.canUserUseUnfilteredHTML,
Expand Down Expand Up @@ -975,6 +966,7 @@ export class RichText extends Component {
{ ...ariaProps }
className={ className }
key={ key }
onPaste={ this.onPaste }
/>
{ isPlaceholderVisible &&
<Tagname
Expand Down
5 changes: 2 additions & 3 deletions packages/editor/src/components/rich-text/tinymce.js
Original file line number Diff line number Diff line change
Expand Up @@ -164,8 +164,6 @@ export default class TinyMCE extends Component {
},
} );

settings.plugins.push( 'paste' );

tinymce.init( {
...settings,
target: this.editorNode,
Expand Down Expand Up @@ -194,7 +192,7 @@ export default class TinyMCE extends Component {
}

render() {
const { tagName = 'div', style, defaultValue, className, isPlaceholderVisible, format } = this.props;
const { tagName = 'div', style, defaultValue, className, isPlaceholderVisible, format, onPaste } = this.props;
const ariaProps = pickAriaProps( this.props );

/*
Expand All @@ -220,6 +218,7 @@ export default class TinyMCE extends Component {
style,
suppressContentEditableWarning: true,
dangerouslySetInnerHTML: { __html: valueToString( defaultValue, format ) },
onPaste,
} );
}
}

0 comments on commit 1d92884

Please sign in to comment.