Merge pull request #62 from ckeditor/t/61

Feature: Prevent of bolding entire content pasted from Google Docs. Closes #61.

Author: jodator

src/filters/removeboldwrapper.js

@@ -0,0 +1,25 @@
+/**
+ * @license Copyright (c) 2003-2019, CKSource - Frederico Knabben. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+
+/**
+ * @module paste-from-office/filters/removeboldwrapper
+ */
+
+/**
+ * Removes `<b>` tag wrapper added by Google Docs to a copied content.
+ *
+ * @param {module:engine/view/documentfragment~DocumentFragment} documentFragment element `data.content` obtained from clipboard
+ * @param {module:engine/view/upcastwriter~UpcastWriter} writer
+ */
+export default function removeBoldWrapper( documentFragment, writer ) {
+	for ( const child of documentFragment.getChildren() ) {
+		if ( child.is( 'b' ) && child.getStyle( 'font-weight' ) === 'normal' ) {
+			const childIndex = documentFragment.getChildIndex( child );
+
+			writer.remove( child );
+			writer.insertChild( childIndex, child.getChildren(), documentFragment );
+		}
+	}
+}

src/normalizer.jsdoc

@@ -0,0 +1,34 @@
+/**
+ * @license Copyright (c) 2003-2019, CKSource - Frederico Knabben. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+
+/**
+ * @module paste-from-office/normalizer
+ */
+
+/**
+ * Interface defining a content transformation pasted from an external editor.
+ *
+ * Normalizers are registered by the {@link module:paste-from-office/pastefromoffice~PasteFromOffice} plugin and run on
+ * {@link module:clipboard/clipboard~Clipboard#event:inputTransformation inputTransformation event}. They detect environment-specific
+ * quirks and transform it into a form compatible with other CKEditor features.
+ *
+ * @interface Normalizer
+ */
+
+/**
+ * Must return `true` if the `htmlString` contains content which this normalizer can transform.
+ *
+ * @method #isActive
+ * @param {String} htmlString full content of `dataTransfer.getData( 'text/html' )`
+ * @returns {Boolean}
+ */
+
+/**
+ * Executes the normalization of a given data.
+ *
+ * @method #execute
+ * @param {Object} data object obtained from
+ * {@link module:clipboard/clipboard~Clipboard#event:inputTransformation inputTransformation event}.
+ */

src/normalizers/googledocsnormalizer.js

@@ -0,0 +1,36 @@
+/**
+ * @license Copyright (c) 2003-2019, CKSource - Frederico Knabben. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+
+/**
+ * @module paste-from-office/normalizers/googledocsnormalizer
+ */
+
+import removeBoldWrapper from '../filters/removeboldwrapper';
+import UpcastWriter from '@ckeditor/ckeditor5-engine/src/view/upcastwriter';
+
+const googleDocsMatch = /id=("|')docs-internal-guid-[-0-9a-f]+("|')/i;
+
+/**
+ * Normalizer for the content pasted from Google Docs.
+ *
+ * @implements module:paste-from-office/normalizer~Normalizer
+ */
+export default class GoogleDocsNormalizer {
+	/**
+	 * @inheritDoc
+	 */
+	isActive( htmlString ) {
+		return googleDocsMatch.test( htmlString );
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	execute( data ) {
+		const writer = new UpcastWriter();
+
+		removeBoldWrapper( data.content, writer );
+	}
+}

src/normalizers/mswordnormalizer.js

@@ -0,0 +1,41 @@
+/**
+ * @license Copyright (c) 2003-2019, CKSource - Frederico Knabben. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+
+/**
+ * @module paste-from-office/normalizers/mswordnormalizer
+ */
+
+import { parseHtml } from '../filters/parse';
+import { transformListItemLikeElementsIntoLists } from '../filters/list';
+import { replaceImagesSourceWithBase64 } from '../filters/image';
+
+const msWordMatch1 = /<meta\s*name="?generator"?\s*content="?microsoft\s*word\s*\d+"?\/?>/i;
+const msWordMatch2 = /xmlns:o="urn:schemas-microsoft-com/i;
+
+/**
+ * Normalizer for the content pasted from Microsoft Word.
+ *
+ * @implements module:paste-from-office/normalizer~Normalizer
+ */
+export default class MSWordNormalizer {
+	/**
+	 * @inheritDoc
+	 */
+	isActive( htmlString ) {
+		return msWordMatch1.test( htmlString ) || msWordMatch2.test( htmlString );
+	}
+
+	/**
+	 * @inheritDoc
+	 */
+	execute( data ) {
+		const { body, stylesString } = parseHtml( data.dataTransfer.getData( 'text/html' ) );
+
+		transformListItemLikeElementsIntoLists( body, stylesString );
+		replaceImagesSourceWithBase64( body, data.dataTransfer.getData( 'text/rtf' ) );
+
+		data.content = body;
+	}
+}

src/pastefromoffice.js

@@ -9,16 +9,21 @@
 
 import Plugin from '@ckeditor/ckeditor5-core/src/plugin';
 
-import { parseHtml } from './filters/parse';
-import { transformListItemLikeElementsIntoLists } from './filters/list';
-import { replaceImagesSourceWithBase64 } from './filters/image';
+import GoogleDocsNormalizer from './normalizers/googledocsnormalizer';
+import MSWordNormalizer from './normalizers/mswordnormalizer';
+import Clipboard from '@ckeditor/ckeditor5-clipboard/src/clipboard';
 
 /**
  * The Paste from Office plugin.
  *
- * This plugin handles content pasted from Office apps (for now only Word) and transforms it (if necessary)
+ * This plugin handles content pasted from Office apps and transforms it (if necessary)
  * to a valid structure which can then be understood by the editor features.
  *
+ * Transformation is made by a set of predefined {@link module:paste-from-office/normalizer~Normalizer normalizers}.
+ * This plugin includes following normalizers:
+ *   * {@link module:paste-from-office/normalizer/mswordnormalizer~MSWordNormalizer Microsoft Word normalizer}
+ *   * {@link module:paste-from-office/normalizer/googledocsnormalizer~GoogleDocsNormalizer Google Docs normalizer}
+ *
  * For more information about this feature check the {@glink api/paste-from-office package page}.
  *
  * @extends module:core/plugin~Plugin
@@ -31,49 +36,40 @@ export default class PasteFromOffice extends Plugin {
 		return 'PasteFromOffice';
 	}
 
+	/**
+	 * @inheritDoc
+	 */
+	static get requires() {
+		return [ Clipboard ];
+	}
+
 	/**
 	 * @inheritDoc
 	 */
 	init() {
 		const editor = this.editor;
+		const normalizers = [];
 
-		this.listenTo( editor.plugins.get( 'Clipboard' ), 'inputTransformation', ( evt, data ) => {
-			const html = data.dataTransfer.getData( 'text/html' );
+		normalizers.push( new MSWordNormalizer() );
+		normalizers.push( new GoogleDocsNormalizer() );
 
-			if ( data.pasteFromOfficeProcessed !== true && isWordInput( html ) ) {
-				data.content = this._normalizeWordInput( html, data.dataTransfer );
+		editor.plugins.get( 'Clipboard' ).on(
+			'inputTransformation',
+			( evt, data ) => {
+				if ( data.isTransformedWithPasteFromOffice ) {
+					return;
+				}
 
-				// Set the flag so if `inputTransformation` is re-fired, PFO will not process it again (#44).
-				data.pasteFromOfficeProcessed = true;
-			}
-		}, { priority: 'high' } );
-	}
-
-	/**
-	 * Normalizes input pasted from Word to format suitable for editor {@link module:engine/model/model~Model}.
-	 *
-	 * **Note**: this function was exposed mainly for testing purposes and should not be called directly.
-	 *
-	 * @protected
-	 * @param {String} input Word input.
-	 * @param {module:clipboard/datatransfer~DataTransfer} dataTransfer Data transfer instance.
-	 * @returns {module:engine/view/documentfragment~DocumentFragment} Normalized input.
-	 */
-	_normalizeWordInput( input, dataTransfer ) {
-		const { body, stylesString } = parseHtml( input );
+				const htmlString = data.dataTransfer.getData( 'text/html' );
+				const activeNormalizer = normalizers.find( normalizer => normalizer.isActive( htmlString ) );
 
-		transformListItemLikeElementsIntoLists( body, stylesString );
-		replaceImagesSourceWithBase64( body, dataTransfer.getData( 'text/rtf' ) );
+				if ( activeNormalizer ) {
+					activeNormalizer.execute( data );
 
-		return body;
+					data.isTransformedWithPasteFromOffice = true;
+				}
+			},
+			{ priority: 'high' }
+		);
 	}
 }
-
-// Checks if given HTML string is a result of pasting content from Word.
-//
-// @param {String} html HTML string to test.
-// @returns {Boolean} True if given HTML string is a Word HTML.
-function isWordInput( html ) {
-	return !!( html && ( html.match( /<meta\s*name="?generator"?\s*content="?microsoft\s*word\s*\d+"?\/?>/gi ) ||
-		html.match( /xmlns:o="urn:schemas-microsoft-com/gi ) ) );
-}

tests/_data/paste-from-google-docs/bold-wrapper/index.js

@@ -0,0 +1,51 @@
+/**
+ * @license Copyright (c) 2003-2019, CKSource - Frederico Knabben. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+
+import simpleText from './simple-text/input.html';
+import simpleTextWindows from './simple-text-windows/input.html';
+
+import simpleTextNormalized from './simple-text/normalized.html';
+import simpleTextWindowsNormalized from './simple-text-windows/normalized.html';
+
+import simpleTextModel from './simple-text/model.html';
+import simpleTextWindowsModel from './simple-text-windows/model.html';
+
+export const fixtures = {
+	input: {
+		simpleText,
+		simpleTextWindows
+	},
+	normalized: {
+		simpleText: simpleTextNormalized,
+		simpleTextWindows: simpleTextWindowsNormalized
+	},
+	model: {
+		simpleText: simpleTextModel,
+		simpleTextWindows: simpleTextWindowsModel
+	}
+};
+
+import simpleTextFirefox from './simple-text/input.firefox.html';
+import simpleTextWindowsFirefox from './simple-text-windows/input.firefox.html';
+
+import simpleTextNormalizedFirefox from './simple-text/normalized.firefox.html';
+import simpleTextWindowsNormalizedFirefox from './simple-text-windows/normalized.firefox.html';
+
+export const browserFixtures = {
+	firefox: {
+		input: {
+			simpleText: simpleTextFirefox,
+			simpleTextWindows: simpleTextWindowsFirefox
+		},
+		normalized: {
+			simpleText: simpleTextNormalizedFirefox,
+			simpleTextWindows: simpleTextWindowsNormalizedFirefox
+		},
+		model: {
+			simpleText: simpleTextModel,
+			simpleTextWindows: simpleTextWindowsModel
+		}
+	}
+};

tests/_data/paste-from-google-docs/bold-wrapper/simple-text-windows/input.firefox.html

@@ -0,0 +1,4 @@
+<html><body>
+<!--StartFragment--><p dir="ltr" style="line-height:1.38;margin-top:0pt;margin-bottom:0pt;" id="docs-internal-guid-f8b26bf1-7fff-40c0-af18-1234567890ab"><span style="font-size:11pt;font-family:Arial;color:#000000;background-color:transparent;font-weight:400;font-style:normal;font-variant:normal;text-decoration:none;vertical-align:baseline;white-space:pre;white-space:pre-wrap;">Hello world</span></p><!--EndFragment-->
+</body>
+</html>

tests/_data/paste-from-google-docs/bold-wrapper/simple-text-windows/input.html

@@ -0,0 +1,5 @@
+<html>
+<body>
+<!--StartFragment--><b style="font-weight:normal;" id="docs-internal-guid-0954d9f2-7fff-2b3c-4978-1234567890ab"><p dir="ltr" style="line-height:1.38;margin-top:0pt;margin-bottom:0pt;"><span style="font-size:11pt;font-family:Arial;color:#000000;background-color:transparent;font-weight:400;font-style:normal;font-variant:normal;text-decoration:none;vertical-align:baseline;white-space:pre;white-space:pre-wrap;">Hello world</span></p></b><br class="Apple-interchange-newline"><!--EndFragment-->
+</body>
+</html>

tests/_data/paste-from-google-docs/bold-wrapper/simple-text-windows/model.html

@@ -0,0 +1 @@
+<paragraph>Hello world</paragraph>

tests/_data/paste-from-google-docs/bold-wrapper/simple-text-windows/normalized.firefox.html

@@ -0,0 +1 @@
+<p dir="ltr" id="docs-internal-guid-f8b26bf1-7fff-40c0-af18-1234567890ab" style="line-height:1.38;margin-bottom:0pt;margin-top:0pt"><span style="background-color:transparent;color:#000000;font-family:Arial;font-size:11pt;font-style:normal;font-variant:normal;font-weight:400;text-decoration:none;vertical-align:baseline;white-space:pre-wrap">Hello world</span></p>