JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
vanilla ckeditor-3.6.6.1
[ckeditor.git] / _source / plugins / clipboard / plugin.js
index d647058..558ffd7 100644 (file)
@@ -1,5 +1,5 @@
 /*\r
-Copyright (c) 2003-2010, CKSource - Frederico Knabben. All rights reserved.\r
+Copyright (c) 2003-2013, CKSource - Frederico Knabben. All rights reserved.\r
 For licensing, see LICENSE.html or http://ckeditor.com/license\r
 */\r
 \r
@@ -16,10 +16,10 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                var doc = editor.document,\r
                        body = doc.getBody();\r
 \r
-               var enabled = 0;\r
+               var enabled = false;\r
                var onExec = function()\r
                {\r
-                       enabled = 1;\r
+                       enabled = true;\r
                };\r
 \r
                // The following seems to be the only reliable way to detect that\r
@@ -61,7 +61,8 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
        var cutCopyCmd = function( type )\r
        {\r
                this.type = type;\r
-               this.canUndo = ( this.type == 'cut' );          // We can't undo copy to clipboard.\r
+               this.canUndo = this.type == 'cut';              // We can't undo copy to clipboard.\r
+               this.startDisabled = true;\r
        };\r
 \r
        cutCopyCmd.prototype =\r
@@ -134,12 +135,10 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 \r
                                var body = this.document.getBody();\r
 \r
-                               // Simulate 'beforepaste' event for all none-IEs.\r
-                               if ( !CKEDITOR.env.ie && body.fire( 'beforepaste' ) )\r
-                                       event.cancel();\r
-                               // Simulate 'paste' event for Opera/Firefox2.\r
-                               else if ( CKEDITOR.env.opera\r
-                                                || CKEDITOR.env.gecko && CKEDITOR.env.version < 10900 )\r
+                               // 1. Opera just misses the "paste" event.\r
+                               // 2. Firefox's "paste" event comes too late to have the plain\r
+                               // text paste bin to work.\r
+                               if ( CKEDITOR.env.opera || CKEDITOR.env.gecko )\r
                                        body.fire( 'paste' );\r
                                return;\r
 \r
@@ -157,6 +156,8 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                }\r
        };\r
 \r
+       function cancel( evt ) { evt.cancel(); }\r
+\r
        // Allow to peek clipboard content by redirecting the\r
        // pasting content into a temporary bin and grab the content of it.\r
        function getClipboardData( evt, mode, callback )\r
@@ -207,22 +208,11 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 \r
                var bms = sel.createBookmarks();\r
 \r
+               this.on( 'selectionChange', cancel, null, null, 0 );\r
+\r
                // Turn off design mode temporarily before give focus to the paste bin.\r
                if ( mode == 'text' )\r
-               {\r
-                       if ( CKEDITOR.env.ie )\r
-                       {\r
-                               var ieRange = doc.getBody().$.createTextRange();\r
-                               ieRange.moveToElementText( pastebin.$ );\r
-                               ieRange.execCommand( 'Paste' );\r
-                               evt.data.preventDefault();\r
-                       }\r
-                       else\r
-                       {\r
-                               doc.$.designMode = 'off';\r
-                               pastebin.$.focus();\r
-                       }\r
-               }\r
+                       pastebin.$.focus();\r
                else\r
                {\r
                        range.setStartAt( pastebin, CKEDITOR.POSITION_AFTER_START );\r
@@ -230,11 +220,27 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                        range.select( true );\r
                }\r
 \r
+               var editor  = this;\r
                // Wait a while and grab the pasted contents\r
                window.setTimeout( function()\r
                {\r
-                       mode == 'text' && !CKEDITOR.env.ie && ( doc.$.designMode = 'on' );\r
-                       pastebin.remove();\r
+                       // Restore properly the document focus. (#5684, #8849)\r
+                       editor.document.getBody().focus();\r
+\r
+                       editor.removeListener( 'selectionChange', cancel );\r
+\r
+                       // IE7: selection must go before removing paste bin. (#8691)\r
+                       if ( CKEDITOR.env.ie7Compat )\r
+                       {\r
+                               sel.selectBookmarks( bms );\r
+                               pastebin.remove();\r
+                       }\r
+                       // Webkit: selection must go after removing paste bin. (#8921)\r
+                       else\r
+                       {\r
+                               pastebin.remove();\r
+                               sel.selectBookmarks( bms );\r
+                       }\r
 \r
                        // Grab the HTML contents.\r
                        // We need to look for a apple style wrapper on webkit it also adds\r
@@ -246,7 +252,6 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                                                 && ( bogusSpan.is && bogusSpan.hasClass( 'Apple-style-span' ) ) ?\r
                                                        bogusSpan : pastebin );\r
 \r
-                       sel.selectBookmarks( bms );\r
                        callback( pastebin[ 'get' + ( mode == 'text' ? 'Value' : 'Html' ) ]() );\r
                }, 0 );\r
        }\r
@@ -281,6 +286,53 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                }\r
        }\r
 \r
+       var depressBeforeEvent,\r
+               inReadOnly;\r
+       function stateFromNamedCommand( command, editor )\r
+       {\r
+               var retval;\r
+\r
+               if ( inReadOnly && command in { Paste : 1, Cut : 1 } )\r
+                       return CKEDITOR.TRISTATE_DISABLED;\r
+\r
+               if ( command == 'Paste' )\r
+               {\r
+                       // IE Bug: queryCommandEnabled('paste') fires also 'beforepaste(copy/cut)',\r
+                       // guard to distinguish from the ordinary sources (either\r
+                       // keyboard paste or execCommand) (#4874).\r
+                       CKEDITOR.env.ie && ( depressBeforeEvent = 1 );\r
+                       try\r
+                       {\r
+                               // Always return true for Webkit (which always returns false).\r
+                               retval = editor.document.$.queryCommandEnabled( command ) || CKEDITOR.env.webkit;\r
+                       }\r
+                       catch( er ) {}\r
+                       depressBeforeEvent = 0;\r
+               }\r
+               // Cut, Copy - check if the selection is not empty\r
+               else\r
+               {\r
+                       var sel = editor.getSelection(),\r
+                               ranges = sel && sel.getRanges();\r
+                       retval = sel && !( ranges.length == 1 && ranges[ 0 ].collapsed );\r
+               }\r
+\r
+               return retval ? CKEDITOR.TRISTATE_OFF : CKEDITOR.TRISTATE_DISABLED;\r
+       }\r
+\r
+       function setToolbarStates()\r
+       {\r
+               if ( this.mode != 'wysiwyg' )\r
+                       return;\r
+\r
+               var pasteState = stateFromNamedCommand( 'Paste', this );\r
+\r
+               this.getCommand( 'cut' ).setState( stateFromNamedCommand( 'Cut', this ) );\r
+               this.getCommand( 'copy' ).setState( stateFromNamedCommand( 'Copy', this ) );\r
+               this.getCommand( 'paste' ).setState( pasteState );\r
+               this.fire( 'pasteState', pasteState );\r
+       }\r
+\r
        // Register the plugin.\r
        CKEDITOR.plugins.add( 'clipboard',\r
                {\r
@@ -297,6 +349,8 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                                                else if ( data[ 'text' ] )\r
                                                        editor.insertText( data[ 'text' ] );\r
 \r
+                                               setTimeout( function () { editor.fire( 'afterPaste' ); }, 0 );\r
+\r
                                        }, null, null, 1000 );\r
 \r
                                editor.on( 'pasteDialog', function( evt )\r
@@ -308,6 +362,11 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
                                                }, 0 );\r
                                        });\r
 \r
+                               editor.on( 'pasteState', function( evt )\r
+                                       {\r
+                                               editor.getCommand( 'paste' ).setState( evt.data );\r
+                                       });\r
+\r
                                function addButtonCommand( buttonName, commandName, command, ctxMenuOrder )\r
                                {\r
                                        var lang = editor.lang[ commandName ];\r
@@ -340,59 +399,91 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
 \r
                                editor.on( 'key', onKey, editor );\r
 \r
-                               var mode = editor.config.forcePasteAsPlainText ? 'text' : 'html';\r
-\r
                                // We'll be catching all pasted content in one line, regardless of whether the\r
                                // it's introduced by a document command execution (e.g. toolbar buttons) or\r
                                // user paste behaviors. (e.g. Ctrl-V)\r
                                editor.on( 'contentDom', function()\r
                                {\r
                                        var body = editor.document.getBody();\r
-                                       body.on( ( (mode == 'text' && CKEDITOR.env.ie ) || CKEDITOR.env.webkit ) ? 'paste' : 'beforepaste',\r
-                                               function( evt )\r
+\r
+                                       // Intercept the paste before it actually takes place.\r
+                                       body.on( !CKEDITOR.env.ie ? 'paste' : 'beforepaste', function( evt )\r
                                                {\r
                                                        if ( depressBeforeEvent )\r
                                                                return;\r
 \r
-                                                       getClipboardData.call( editor, evt, mode, function ( data )\r
+                                                       // Dismiss the (wrong) 'beforepaste' event fired on toolbar menu open.\r
+                                                       var domEvent = evt.data && evt.data.$;\r
+                                                       if ( CKEDITOR.env.ie && domEvent && !domEvent.ctrlKey )\r
+                                                               return;\r
+\r
+                                                       // Fire 'beforePaste' event so clipboard flavor get customized\r
+                                                       // by other plugins.\r
+                                                       var eventData =  { mode : 'html' };\r
+                                                       editor.fire( 'beforePaste', eventData );\r
+\r
+                                                       getClipboardData.call( editor, evt, eventData.mode, function ( data )\r
                                                        {\r
                                                                // The very last guard to make sure the\r
                                                                // paste has successfully happened.\r
-                                                               if ( !data )\r
+                                                               if ( !( data = CKEDITOR.tools.trim( data.replace( /<span[^>]+data-cke-bookmark[^<]*?<\/span>/ig,'' ) ) ) )\r
                                                                        return;\r
 \r
                                                                var dataTransfer = {};\r
-                                                               dataTransfer[ mode ] = data;\r
+                                                               dataTransfer[ eventData.mode ] = data;\r
                                                                editor.fire( 'paste', dataTransfer );\r
                                                        } );\r
                                                });\r
 \r
+                                       if ( CKEDITOR.env.ie )\r
+                                       {\r
+                                               // Dismiss the (wrong) 'beforepaste' event fired on context menu open. (#7953)\r
+                                               body.on( 'contextmenu', function()\r
+                                               {\r
+                                                       depressBeforeEvent = 1;\r
+                                                       // Important: The following timeout will be called only after menu closed.\r
+                                                       setTimeout( function() { depressBeforeEvent = 0; }, 0 );\r
+                                               } );\r
+\r
+                                               // Handle IE's late coming "paste" event when pasting from\r
+                                               // browser toolbar/context menu.\r
+                                               body.on( 'paste', function( evt )\r
+                                               {\r
+                                                       if ( !editor.document.getById( 'cke_pastebin' ) )\r
+                                                       {\r
+                                                               // Prevent native paste.\r
+                                                               evt.data.preventDefault();\r
+\r
+                                                               depressBeforeEvent = 0;\r
+                                                               // Resort to the paste command.\r
+                                                               pasteCmd.exec( editor );\r
+                                                       }\r
+                                               } );\r
+                                       }\r
+\r
                                        body.on( 'beforecut', function() { !depressBeforeEvent && fixCut( editor ); } );\r
+\r
+                                       body.on( 'mouseup', function(){ setTimeout( function(){ setToolbarStates.call( editor ); }, 0 ); }, editor );\r
+                                       body.on( 'keyup', setToolbarStates, editor );\r
+                               });\r
+\r
+                               // For improved performance, we're checking the readOnly state on selectionChange instead of hooking a key event for that.\r
+                               editor.on( 'selectionChange', function( evt )\r
+                               {\r
+                                       inReadOnly = evt.data.selection.getRanges()[ 0 ].checkReadOnly();\r
+                                       setToolbarStates.call( editor );\r
                                });\r
 \r
                                // If the "contextmenu" plugin is loaded, register the listeners.\r
                                if ( editor.contextMenu )\r
                                {\r
-                                       var depressBeforeEvent;\r
-                                       function stateFromNamedCommand( command )\r
-                                       {\r
-                                               // IE Bug: queryCommandEnabled('paste') fires also 'beforepaste(copy/cut)',\r
-                                               // guard to distinguish from the ordinary sources( either\r
-                                               // keyboard paste or execCommand ) (#4874).\r
-                                               CKEDITOR.env.ie && ( depressBeforeEvent = 1 );\r
-\r
-                                               var retval = editor.document.$.queryCommandEnabled( command ) ? CKEDITOR.TRISTATE_OFF : CKEDITOR.TRISTATE_DISABLED;\r
-                                               depressBeforeEvent = 0;\r
-                                               return retval;\r
-                                       }\r
-\r
                                        editor.contextMenu.addListener( function( element, selection )\r
                                                {\r
-                                                       var readOnly = selection.getCommonAncestor().isReadOnly();\r
+                                                       var readOnly = selection.getRanges()[ 0 ].checkReadOnly();\r
                                                        return {\r
-                                                               cut : !readOnly && stateFromNamedCommand( 'Cut' ),\r
-                                                               copy : stateFromNamedCommand( 'Copy' ),\r
-                                                               paste : !readOnly && ( CKEDITOR.env.webkit ? CKEDITOR.TRISTATE_OFF : stateFromNamedCommand( 'Paste' ) )\r
+                                                               cut : stateFromNamedCommand( 'Cut', editor ),\r
+                                                               copy : stateFromNamedCommand( 'Copy', editor ),\r
+                                                               paste : stateFromNamedCommand( 'Paste', editor )\r
                                                        };\r
                                                });\r
                                }\r
@@ -410,3 +501,9 @@ For licensing, see LICENSE.html or http://ckeditor.com/license
  * @param {String} [data.html] The HTML data to be pasted. If not available, e.data.text will be defined.\r
  * @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.\r
  */\r
+\r
+/**\r
+ * Internal event to open the Paste dialog\r
+ * @name CKEDITOR.editor#pasteDialog\r
+ * @event\r
+ */\r