/** * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved. * For licensing, see LICENSE.md. */ /** * @module typing/input */ import Plugin from '@ckeditor/ckeditor5-core/src/plugin'; import ModelRange from '@ckeditor/ckeditor5-engine/src/model/range'; import ViewPosition from '@ckeditor/ckeditor5-engine/src/view/position'; import ViewText from '@ckeditor/ckeditor5-engine/src/view/text'; import diff from '@ckeditor/ckeditor5-utils/src/diff'; import diffToChanges from '@ckeditor/ckeditor5-utils/src/difftochanges'; import { getCode } from '@ckeditor/ckeditor5-utils/src/keyboard'; import DomConverter from '@ckeditor/ckeditor5-engine/src/view/domconverter'; import InputCommand from './inputcommand'; /** * Handles text input coming from the keyboard or other input methods. * * @extends module:core/plugin~Plugin */ export default class Input extends Plugin { /** * @inheritDoc */ static get pluginName() { return 'Input'; } /** * @inheritDoc */ init() { const editor = this.editor; const editingView = editor.editing.view; const inputCommand = new InputCommand( editor, editor.config.get( 'typing.undoStep' ) || 20 ); // TODO The above default configuration value should be defined using editor.config.define() once it's fixed. editor.commands.add( 'input', inputCommand ); this.listenTo( editingView, 'keydown', ( evt, data ) => { this._handleKeydown( data, inputCommand ); }, { priority: 'lowest' } ); this.listenTo( editingView, 'mutations', ( evt, mutations, viewSelection ) => { this._handleMutations( mutations, viewSelection ); } ); } /** * Handles the keydown event. We need to guess whether such keystroke is going to result * in typing. If so, then before character insertion happens, any selected content needs * to be deleted. Otherwise the default browser deletion mechanism would be * triggered, resulting in: * * * Hundreds of mutations which could not be handled. * * But most importantly, loss of control over how the content is being deleted. * * The method is used in a low-priority listener, hence allowing other listeners (e.g. delete or enter features) * to handle the event. * * @private * @param {module:engine/view/observer/keyobserver~KeyEventData} evtData * @param {module:typing/inputcommand~InputCommand} inputCommand */ _handleKeydown( evtData, inputCommand ) { const doc = this.editor.document; const buffer = inputCommand.buffer; // By relying on the state of the input command we allow disabling the entire input easily // by just disabling the input command. We could’ve used here the delete command but that // would mean requiring the delete feature which would block loading one without the other. // We could also check the editor.isReadOnly property, but that wouldn't allow to block // the input without blocking other features. if ( !inputCommand.isEnabled ) { return; } if ( isSafeKeystroke( evtData ) || doc.selection.isCollapsed ) { return; } buffer.lock(); doc.enqueueChanges( () => { this.editor.data.deleteContent( doc.selection, buffer.batch ); } ); buffer.unlock(); } /** * Handles DOM mutations. * * @private * @param {Array.} mutations * @param {module:engine/view/selection~Selection|null} viewSelection */ _handleMutations( mutations, viewSelection ) { new MutationHandler( this.editor ).handle( mutations, viewSelection ); } } /** * Helper class for translating DOM mutations into model changes. * * @private */ class MutationHandler { /** * Creates an instance of the mutation handler. * * @param {module:core/editor/editor~Editor} editor */ constructor( editor ) { /** * Editor instance for which mutations are handled. * * @readonly * @member {module:core/editor/editor~Editor} #editor */ this.editor = editor; /** * The editing controller. * * @readonly * @member {module:engine/controller/editingcontroller~EditingController} #editing */ this.editing = this.editor.editing; } /** * Handles given mutations. * * @param {Array.} mutations * @param {module:engine/view/selection~Selection|null} viewSelection */ handle( mutations, viewSelection ) { if ( containerChildrenMutated( mutations ) ) { this._handleContainerChildrenMutations( mutations, viewSelection ); } else { for ( const mutation of mutations ) { // Fortunately it will never be both. this._handleTextMutation( mutation, viewSelection ); this._handleTextNodeInsertion( mutation ); } } } /** * Handles situations when container's children mutated during input. This can happen when * browser is trying to "fix" DOM in certain situations. For example, when user starts to type * in `

Link{}

` browser might change order of elements * to `

Linkx{}

`. Similar situation happens when spell checker * replaces a word wrapped with `` to a word wrapped with `` element. * * To handle such situations, DOM common ancestor of all mutations is converted to the model representation * and then compared with current model to calculate proper text change. * * NOTE: Single text node insertion is handled in {@link #_handleTextNodeInsertion} and text node mutation is handled * in {@link #_handleTextMutation}). * * @private * @param {Array.} mutations * @param {module:engine/view/selection~Selection|null} viewSelection */ _handleContainerChildrenMutations( mutations, viewSelection ) { // Get common ancestor of all mutations. const mutationsCommonAncestor = getMutationsCommonAncestor( mutations ); // Quit if there is no common ancestor. if ( !mutationsCommonAncestor ) { return; } const domConverter = this.editor.editing.view.domConverter; // Get common ancestor in DOM. const domMutationCommonAncestor = domConverter.mapViewToDom( mutationsCommonAncestor ); if ( !domMutationCommonAncestor ) { return; } // Create fresh DomConverter so it will not use existing mapping and convert current DOM to model. // This wouldn't be needed if DomConverter would allow to create fresh view without checking any mappings. const freshDomConverter = new DomConverter(); const modelFromCurrentDom = this.editor.data.toModel( freshDomConverter.domToView( domMutationCommonAncestor ) ).getChild( 0 ); // Current model. const currentModel = this.editor.editing.mapper.toModelElement( mutationsCommonAncestor ); // Get children from both ancestors. const modelFromDomChildren = [ ...modelFromCurrentDom.getChildren() ]; const currentModelChildren = [ ...currentModel.getChildren() ]; // Fix situations when common ancestor has only text nodes inside. if ( !containsOnlyTextNodes( modelFromDomChildren ) || !containsOnlyTextNodes( currentModelChildren ) ) { return; } // Replace   inserted by the browser with normal space. // See comment in `_handleTextMutation`. const newText = modelFromDomChildren.map( item => item.data ).join( '' ).replace( /\u00A0/g, ' ' ); const oldText = currentModelChildren.map( item => item.data ).join( '' ); // Do nothing if mutations created same text. if ( oldText === newText ) { return; } const diffResult = diff( oldText, newText ); const { firstChangeAt, insertions, deletions } = calculateChanges( diffResult ); // Try setting new model selection according to passed view selection. let modelSelectionRange = null; if ( viewSelection ) { modelSelectionRange = this.editing.mapper.toModelRange( viewSelection.getFirstRange() ); } const insertText = newText.substr( firstChangeAt, insertions ); const removeRange = ModelRange.createFromParentsAndOffsets( currentModel, firstChangeAt, currentModel, firstChangeAt + deletions ); this.editor.execute( 'input', { text: insertText, range: removeRange, resultRange: modelSelectionRange } ); } _handleTextMutation( mutation, viewSelection ) { if ( mutation.type != 'text' ) { return; } // Replace   inserted by the browser with normal space. // We want only normal spaces in the model and in the view. Renderer and DOM Converter will be then responsible // for rendering consecutive spaces using  , but the model and the view has to be clear. // Other feature may introduce inserting non-breakable space on specific key stroke (for example shift + space). // However then it will be handled outside of mutations, like enter key is. // The replacing is here because it has to be done before `diff` and `diffToChanges` functions, as they // take `newText` and compare it to (cleaned up) view. // It could also be done in mutation observer too, however if any outside plugin would like to // introduce additional events for mutations, they would get already cleaned up version (this may be good or not). const newText = mutation.newText.replace( /\u00A0/g, ' ' ); // To have correct `diffResult`, we also compare view node text data with   replaced by space. const oldText = mutation.oldText.replace( /\u00A0/g, ' ' ); const diffResult = diff( oldText, newText ); const { firstChangeAt, insertions, deletions } = calculateChanges( diffResult ); // Try setting new model selection according to passed view selection. let modelSelectionRange = null; if ( viewSelection ) { modelSelectionRange = this.editing.mapper.toModelRange( viewSelection.getFirstRange() ); } // Get the position in view and model where the changes will happen. const viewPos = new ViewPosition( mutation.node, firstChangeAt ); const modelPos = this.editing.mapper.toModelPosition( viewPos ); const removeRange = ModelRange.createFromPositionAndShift( modelPos, deletions ); const insertText = newText.substr( firstChangeAt, insertions ); this.editor.execute( 'input', { text: insertText, range: removeRange, resultRange: modelSelectionRange } ); } _handleTextNodeInsertion( mutation ) { if ( mutation.type != 'children' ) { return; } const change = getSingleTextNodeChange( mutation ); if ( !change ) { return; } const viewPos = new ViewPosition( mutation.node, change.index ); const modelPos = this.editing.mapper.toModelPosition( viewPos ); const insertedText = change.values[ 0 ].data; this.editor.execute( 'input', { // Replace   inserted by the browser with normal space. // See comment in `_handleTextMutation`. // In this case we don't need to do this before `diff` because we diff whole nodes. // Just change   in case there are some. text: insertedText.replace( /\u00A0/g, ' ' ), range: new ModelRange( modelPos ) } ); } } const safeKeycodes = [ getCode( 'arrowUp' ), getCode( 'arrowRight' ), getCode( 'arrowDown' ), getCode( 'arrowLeft' ), 9, // Tab 16, // Shift 17, // Ctrl 18, // Alt 20, // CapsLock 27, // Escape 33, // PageUp 34, // PageDown 35, // Home 36, // End 229 // Composition start key ]; // Function keys. for ( let code = 112; code <= 135; code++ ) { safeKeycodes.push( code ); } // Returns `true` if a keystroke should not cause any content change caused by "typing". // // Note: This implementation is very simple and will need to be refined with time. // // @private // @param {engine.view.observer.keyObserver.KeyEventData} keyData // @returns {Boolean} function isSafeKeystroke( keyData ) { // Keystrokes which contain Ctrl don't represent typing. if ( keyData.ctrlKey ) { return true; } return safeKeycodes.includes( keyData.keyCode ); } // Helper function that compares whether two given view nodes are same. It is used in `diff` when it's passed an array // with child nodes. function compareChildNodes( oldChild, newChild ) { if ( oldChild instanceof ViewText && newChild instanceof ViewText ) { return oldChild.data === newChild.data; } else { return oldChild === newChild; } } // Returns change made to a single text node. Returns `undefined` if more than a single text node was changed. // // @private // @param mutation function getSingleTextNodeChange( mutation ) { // One new node. if ( mutation.newChildren.length - mutation.oldChildren.length != 1 ) { return; } // Which is text. const diffResult = diff( mutation.oldChildren, mutation.newChildren, compareChildNodes ); const changes = diffToChanges( diffResult, mutation.newChildren ); // In case of [ delete, insert, insert ] the previous check will not exit. if ( changes.length > 1 ) { return; } const change = changes[ 0 ]; // Which is text. if ( !( change.values[ 0 ] instanceof ViewText ) ) { return; } return change; } // Returns first common ancestor of all mutations. // // @private // @param {Array.} mutations function getMutationsCommonAncestor( mutations ) { // If just 1 mutation present - return mutation node. if ( mutations.length == 1 ) { return mutations[ 0 ].node; } // Get array of ancestor lists without root element. const ancestorsLists = mutations .map( mutation => mutation.node.getAncestors( { includeNode: true } ).filter( ancestor => !ancestor.is( 'rootElement' ) ) ); // Calculate shortest ancestors lists. const shortestListLength = Math.min( ...ancestorsLists.map( list => list.length ) ); let i = 0; // Check if all mutations have common ancestor. while ( i < shortestListLength ) { const ancestor = ancestorsLists[ 0 ][ i ]; let same = true; for ( let j = 1; j < ancestorsLists.length; j++ ) { if ( ancestorsLists[ j ][ i ] !== ancestor ) { same = false; break; } } if ( !same ) { break; } i++; } return i == 0 ? null : ancestorsLists[ 0 ][ i - 1 ]; } // Returns true if container children have mutated and more than a single text node was changed. Single text node // child insertion is handled in {@link module:typing/input~MutationHandler#_handleTextNodeInsertion} and text // mutation is handled in {@link module:typing/input~MutationHandler#_handleTextMutation}. // // @private // @param {Array.} mutations // @returns {Boolean} function containerChildrenMutated( mutations ) { if ( mutations.length == 0 ) { return false; } // Check if all mutations are `children` type, and there is no single text node mutation for ( const mutation of mutations ) { if ( mutation.type !== 'children' || getSingleTextNodeChange( mutation ) ) { return false; } } return true; } // Returns true if provided array contains only {@link module:engine/model/text~Text model text nodes}. // // @param {Array} children // @returns {Boolean} function containsOnlyTextNodes( children ) { for ( const child of children ) { if ( !child.is( 'text' ) ) { return false; } } return true; } // Calculates first change index and number of characters that should be inserted and deleted starting from that index. // // @private // @param diffResult // @return {{insertions: number, deletions: number, firstChangeAt: *}} function calculateChanges( diffResult ) { // Index where the first change happens. Used to set the position from which nodes will be removed and where will be inserted. let firstChangeAt = null; // Index where the last change happens. Used to properly count how many characters have to be removed and inserted. let lastChangeAt = null; // Get `firstChangeAt` and `lastChangeAt`. for ( let i = 0; i < diffResult.length; i++ ) { const change = diffResult[ i ]; if ( change != 'equal' ) { firstChangeAt = firstChangeAt === null ? i : firstChangeAt; lastChangeAt = i; } } // How many characters, starting from `firstChangeAt`, should be removed. let deletions = 0; // How many characters, starting from `firstChangeAt`, should be inserted. let insertions = 0; for ( let i = firstChangeAt; i <= lastChangeAt; i++ ) { // If there is no change (equal) or delete, the character is existing in `oldText`. We count it for removing. if ( diffResult[ i ] != 'insert' ) { deletions++; } // If there is no change (equal) or insert, the character is existing in `newText`. We count it for inserting. if ( diffResult[ i ] != 'delete' ) { insertions++; } } return { insertions, deletions, firstChangeAt }; }