X-Git-Url: https://jasonwoof.com/gitweb/?a=blobdiff_plain;f=_source%2Fplugins%2Fclipboard%2Fplugin.js;h=3c53ab1007fd63f9f395502127f6bac600976ef0;hb=f0610347140239143439a511ee2bd48cb784f470;hp=c063b417a6a2275e18f495713cf1ea9dd4548dd7;hpb=ea7e3453c7b0f023b050aca6d9f83ab372860d91;p=ckeditor.git diff --git a/_source/plugins/clipboard/plugin.js b/_source/plugins/clipboard/plugin.js index c063b41..3c53ab1 100644 --- a/_source/plugins/clipboard/plugin.js +++ b/_source/plugins/clipboard/plugin.js @@ -1,5 +1,5 @@ /* -Copyright (c) 2003-2009, CKSource - Frederico Knabben. All rights reserved. +Copyright (c) 2003-2011, CKSource - Frederico Knabben. All rights reserved. For licensing, see LICENSE.html or http://ckeditor.com/license */ @@ -16,10 +16,10 @@ For licensing, see LICENSE.html or http://ckeditor.com/license var doc = editor.document, body = doc.getBody(); - var enabled = false; + var enabled = 0; var onExec = function() { - enabled = true; + enabled = 1; }; // The following seems to be the only reliable way to detect that @@ -28,7 +28,8 @@ For licensing, see LICENSE.html or http://ckeditor.com/license // the command to execute. body.on( command, onExec ); - doc.$.execCommand( command ); + // IE6/7: document.execCommand has problem to paste into positioned element. + ( CKEDITOR.env.version > 7 ? doc.$ : doc.$.selection.createRange() ) [ 'execCommand' ]( command ); body.removeListener( command, onExec ); @@ -48,7 +49,7 @@ For licensing, see LICENSE.html or http://ckeditor.com/license try { // Other browsers throw an error if the command is disabled. - return editor.document.$.execCommand( type ); + return editor.document.$.execCommand( type, false, null ); } catch( e ) { @@ -60,13 +61,16 @@ For licensing, see LICENSE.html or http://ckeditor.com/license var cutCopyCmd = function( type ) { this.type = type; - this.canUndo = ( this.type == 'cut' ); // We can't undo copy to clipboard. + this.canUndo = this.type == 'cut'; // We can't undo copy to clipboard. + this.startDisabled = true; }; cutCopyCmd.prototype = { exec : function( editor, data ) { + this.type == 'cut' && fixCut( editor ); + var success = tryToCutCopy( editor, this.type ); if ( !success ) @@ -78,59 +82,66 @@ For licensing, see LICENSE.html or http://ckeditor.com/license // Paste command. var pasteCmd = - CKEDITOR.env.ie ? - { - exec : function( editor, data ) + { + canUndo : false, + + exec : + CKEDITOR.env.ie ? + function( editor ) { // Prevent IE from pasting at the begining of the document. editor.focus(); - if ( !editor.fire( 'beforePaste' ) - && !execIECommand( editor, 'paste' ) ) + if ( !editor.document.getBody().fire( 'beforepaste' ) + && !execIECommand( editor, 'paste' ) ) { - editor.openDialog( 'paste' ); + editor.fire( 'pasteDialog' ); + return false; } } - } - : - { - exec : function( editor ) + : + function( editor ) { try { - if ( !editor.fire( 'beforePaste' ) - && !editor.document.$.execCommand( 'Paste', false, null ) ) + if ( !editor.document.getBody().fire( 'beforepaste' ) + && !editor.document.$.execCommand( 'Paste', false, null ) ) { throw 0; } } catch ( e ) { - // Open the paste dialog. - editor.openDialog( 'paste' ); + setTimeout( function() + { + editor.fire( 'pasteDialog' ); + }, 0 ); + return false; } } - }; + }; // Listens for some clipboard related keystrokes, so they get customized. var onKey = function( event ) { + if ( this.mode != 'wysiwyg' ) + return; + switch ( event.data.keyCode ) { // Paste case CKEDITOR.CTRL + 86 : // CTRL+V case CKEDITOR.SHIFT + 45 : // SHIFT+INS - var editor = this; - editor.fire( 'saveSnapshot' ); // Save before paste + var body = this.document.getBody(); - if ( editor.fire( 'beforePaste' ) ) + // Simulate 'beforepaste' event for all none-IEs. + if ( !CKEDITOR.env.ie && body.fire( 'beforepaste' ) ) event.cancel(); - - setTimeout( function() - { - editor.fire( 'saveSnapshot' ); // Save after paste - }, 0 ); + // Simulate 'paste' event for Opera/Firefox2. + else if ( CKEDITOR.env.opera + || CKEDITOR.env.gecko && CKEDITOR.env.version < 10900 ) + body.fire( 'paste' ); return; // Cut @@ -138,8 +149,8 @@ For licensing, see LICENSE.html or http://ckeditor.com/license case CKEDITOR.SHIFT + 46 : // SHIFT+DEL // Save Undo snapshot. - editor = this; - editor.fire( 'saveSnapshot' ); // Save before paste + var editor = this; + this.fire( 'saveSnapshot' ); // Save before paste setTimeout( function() { editor.fire( 'saveSnapshot' ); // Save after paste @@ -147,11 +158,185 @@ For licensing, see LICENSE.html or http://ckeditor.com/license } }; + function cancel( evt ) { evt.cancel(); } + + // Allow to peek clipboard content by redirecting the + // pasting content into a temporary bin and grab the content of it. + function getClipboardData( evt, mode, callback ) + { + var doc = this.document; + + // Avoid recursions on 'paste' event or consequent paste too fast. (#5730) + if ( doc.getById( 'cke_pastebin' ) ) + return; + + // If the browser supports it, get the data directly + if ( mode == 'text' && evt.data && evt.data.$.clipboardData ) + { + // evt.data.$.clipboardData.types contains all the flavours in Mac's Safari, but not on windows. + var plain = evt.data.$.clipboardData.getData( 'text/plain' ); + if ( plain ) + { + evt.data.preventDefault(); + callback( plain ); + return; + } + } + + var sel = this.getSelection(), + range = new CKEDITOR.dom.range( doc ); + + // Create container to paste into + var pastebin = new CKEDITOR.dom.element( mode == 'text' ? 'textarea' : CKEDITOR.env.webkit ? 'body' : 'div', doc ); + pastebin.setAttribute( 'id', 'cke_pastebin' ); + // Safari requires a filler node inside the div to have the content pasted into it. (#4882) + CKEDITOR.env.webkit && pastebin.append( doc.createText( '\xa0' ) ); + doc.getBody().append( pastebin ); + + pastebin.setStyles( + { + position : 'absolute', + // Position the bin exactly at the position of the selected element + // to avoid any subsequent document scroll. + top : sel.getStartElement().getDocumentPosition().y + 'px', + width : '1px', + height : '1px', + overflow : 'hidden' + }); + + // It's definitely a better user experience if we make the paste-bin pretty unnoticed + // by pulling it off the screen. + pastebin.setStyle( this.config.contentsLangDirection == 'ltr' ? 'left' : 'right', '-1000px' ); + + var bms = sel.createBookmarks(); + + this.on( 'selectionChange', cancel, null, null, 0 ); + + // Turn off design mode temporarily before give focus to the paste bin. + if ( mode == 'text' ) + pastebin.$.focus(); + else + { + range.setStartAt( pastebin, CKEDITOR.POSITION_AFTER_START ); + range.setEndAt( pastebin, CKEDITOR.POSITION_BEFORE_END ); + range.select( true ); + } + + var editor = this; + // Wait a while and grab the pasted contents + window.setTimeout( function() + { + mode == 'text' && CKEDITOR.env.gecko && editor.focusGrabber.focus(); + pastebin.remove(); + editor.removeListener( 'selectionChange', cancel ); + + // Grab the HTML contents. + // We need to look for a apple style wrapper on webkit it also adds + // a div wrapper if you copy/paste the body of the editor. + // Remove hidden div and restore selection. + var bogusSpan; + pastebin = ( CKEDITOR.env.webkit + && ( bogusSpan = pastebin.getFirst() ) + && ( bogusSpan.is && bogusSpan.hasClass( 'Apple-style-span' ) ) ? + bogusSpan : pastebin ); + + sel.selectBookmarks( bms ); + callback( pastebin[ 'get' + ( mode == 'text' ? 'Value' : 'Html' ) ]() ); + }, 0 ); + } + + // Cutting off control type element in IE standards breaks the selection entirely. (#4881) + function fixCut( editor ) + { + if ( !CKEDITOR.env.ie || CKEDITOR.env.quirks ) + return; + + var sel = editor.getSelection(); + var control; + if( ( sel.getType() == CKEDITOR.SELECTION_ELEMENT ) && ( control = sel.getSelectedElement() ) ) + { + var range = sel.getRanges()[ 0 ]; + var dummy = editor.document.createText( '' ); + dummy.insertBefore( control ); + range.setStartBefore( dummy ); + range.setEndAfter( control ); + sel.selectRanges( [ range ] ); + + // Clear up the fix if the paste wasn't succeeded. + setTimeout( function() + { + // Element still online? + if ( control.getParent() ) + { + dummy.remove(); + sel.selectElement( control ); + } + }, 0 ); + } + } + + var depressBeforeEvent; + function stateFromNamedCommand( command, editor ) + { + // IE Bug: queryCommandEnabled('paste') fires also 'beforepaste(copy/cut)', + // guard to distinguish from the ordinary sources( either + // keyboard paste or execCommand ) (#4874). + CKEDITOR.env.ie && ( depressBeforeEvent = 1 ); + + var retval = CKEDITOR.TRISTATE_OFF; + try { retval = editor.document.$.queryCommandEnabled( command ) ? CKEDITOR.TRISTATE_OFF : CKEDITOR.TRISTATE_DISABLED; }catch( er ){} + + depressBeforeEvent = 0; + return retval; + } + + var inReadOnly; + function setToolbarStates() + { + if ( this.mode != 'wysiwyg' ) + return; + + this.getCommand( 'cut' ).setState( inReadOnly ? CKEDITOR.TRISTATE_DISABLED : stateFromNamedCommand( 'Cut', this ) ); + this.getCommand( 'copy' ).setState( stateFromNamedCommand( 'Copy', this ) ); + var pasteState = inReadOnly ? CKEDITOR.TRISTATE_DISABLED : + CKEDITOR.env.webkit ? CKEDITOR.TRISTATE_OFF : stateFromNamedCommand( 'Paste', this ); + this.fire( 'pasteState', pasteState ); + } + // Register the plugin. CKEDITOR.plugins.add( 'clipboard', { + requires : [ 'dialog', 'htmldataprocessor' ], init : function( editor ) { + // Inserts processed data into the editor at the end of the + // events chain. + editor.on( 'paste', function( evt ) + { + var data = evt.data; + if ( data[ 'html' ] ) + editor.insertHtml( data[ 'html' ] ); + else if ( data[ 'text' ] ) + editor.insertText( data[ 'text' ] ); + + setTimeout( function () { editor.fire( 'afterPaste' ); }, 0 ); + + }, null, null, 1000 ); + + editor.on( 'pasteDialog', function( evt ) + { + setTimeout( function() + { + // Open default paste dialog. + editor.openDialog( 'paste' ); + }, 0 ); + }); + + editor.on( 'pasteState', function( evt ) + { + editor.getCommand( 'paste' ).setState( evt.data ); + }); + function addButtonCommand( buttonName, commandName, command, ctxMenuOrder ) { var lang = editor.lang[ commandName ]; @@ -184,25 +369,85 @@ For licensing, see LICENSE.html or http://ckeditor.com/license editor.on( 'key', onKey, editor ); - // If the "contextmenu" plugin is loaded, register the listeners. - if ( editor.contextMenu ) + // We'll be catching all pasted content in one line, regardless of whether the + // it's introduced by a document command execution (e.g. toolbar buttons) or + // user paste behaviors. (e.g. Ctrl-V) + editor.on( 'contentDom', function() { - function stateFromNamedCommand( command ) + var body = editor.document.getBody(); + body.on( CKEDITOR.env.webkit ? 'paste' : 'beforepaste', function( evt ) + { + if ( depressBeforeEvent ) + return; + + // Fire 'beforePaste' event so clipboard flavor get customized + // by other plugins. + var eventData = { mode : 'html' }; + editor.fire( 'beforePaste', eventData ); + + getClipboardData.call( editor, evt, eventData.mode, function ( data ) + { + // The very last guard to make sure the + // paste has successfully happened. + if ( !( data = CKEDITOR.tools.trim( data.replace( /]+data-cke-bookmark[^<]*?<\/span>/ig,'' ) ) ) ) + return; + + var dataTransfer = {}; + dataTransfer[ eventData.mode ] = data; + editor.fire( 'paste', dataTransfer ); + } ); + }); + + // Dismiss the (wrong) 'beforepaste' event fired on context menu open. (#7953) + body.on( 'contextmenu', function() { - return editor.document.$.queryCommandEnabled( command ) ? CKEDITOR.TRISTATE_OFF : CKEDITOR.TRISTATE_DISABLED; - } + depressBeforeEvent = 1; + setTimeout( function() { depressBeforeEvent = 0; }, 10 ); + }); - editor.contextMenu.addListener( function() + body.on( 'beforecut', function() { !depressBeforeEvent && fixCut( editor ); } ); + + body.on( 'mouseup', function(){ setTimeout( function(){ setToolbarStates.call( editor ); }, 0 ); }, editor ); + body.on( 'keyup', setToolbarStates, editor ); + }); + + // For improved performance, we're checking the readOnly state on selectionChange instead of hooking a key event for that. + editor.on( 'selectionChange', function( evt ) + { + inReadOnly = evt.data.selection.getRanges()[ 0 ].checkReadOnly(); + setToolbarStates.call( editor ); + }); + + // If the "contextmenu" plugin is loaded, register the listeners. + if ( editor.contextMenu ) + { + editor.contextMenu.addListener( function( element, selection ) { + var readOnly = selection.getRanges()[ 0 ].checkReadOnly(); return { - cut : stateFromNamedCommand( 'Cut' ), - - // Browser bug: 'Cut' has the correct states for both Copy and Cut. - copy : stateFromNamedCommand( 'Cut' ), - paste : CKEDITOR.env.webkit ? CKEDITOR.TRISTATE_OFF : stateFromNamedCommand( 'Paste' ) + cut : !readOnly && stateFromNamedCommand( 'Cut', editor ), + copy : stateFromNamedCommand( 'Copy', editor ), + paste : !readOnly && ( CKEDITOR.env.webkit ? CKEDITOR.TRISTATE_OFF : stateFromNamedCommand( 'Paste', editor ) ) }; }); } } }); })(); + +/** + * Fired when a clipboard operation is about to be taken into the editor. + * Listeners can manipulate the data to be pasted before having it effectively + * inserted into the document. + * @name CKEDITOR.editor#paste + * @since 3.1 + * @event + * @param {String} [data.html] The HTML data to be pasted. If not available, e.data.text will be defined. + * @param {String} [data.text] The plain text data to be pasted, available when plain text operations are to used. If not available, e.data.html will be defined. + */ + +/** + * Internal event to open the Paste dialog + * @name CKEDITOR.editor#pasteDialog + * @event + */