--- /dev/null
+/*\r
+Copyright (c) 2003-2009, CKSource - Frederico Knabben. All rights reserved.\r
+For licensing, see LICENSE.html or http://ckeditor.com/license\r
+*/\r
+\r
+/**\r
+ * @fileOverview The "filebrowser" plugin, it adds support for file uploads and\r
+ * browsing.\r
+ *\r
+ * When file is selected inside of the file browser or uploaded, its url is\r
+ * inserted automatically to a field, which is described in the 'filebrowser'\r
+ * attribute. To specify field that should be updated, pass the tab id and\r
+ * element id, separated with a colon.\r
+ *\r
+ * Example 1: (Browse)\r
+ *\r
+ * <pre>\r
+ * {\r
+ * type : 'button',\r
+ * id : 'browse',\r
+ * filebrowser : 'tabId:elementId',\r
+ * label : editor.lang.common.browseServer\r
+ * }\r
+ * </pre>\r
+ *\r
+ * If you set the 'filebrowser' attribute on any element other than\r
+ * 'fileButton', the 'Browse' action will be triggered.\r
+ *\r
+ * Example 2: (Quick Upload)\r
+ *\r
+ * <pre>\r
+ * {\r
+ * type : 'fileButton',\r
+ * id : 'uploadButton',\r
+ * filebrowser : 'tabId:elementId',\r
+ * label : editor.lang.common.uploadSubmit,\r
+ * 'for' : [ 'upload', 'upload' ]\r
+ * }\r
+ * </pre>\r
+ *\r
+ * If you set the 'filebrowser' attribute on a fileButton element, the\r
+ * 'QuickUpload' action will be executed.\r
+ *\r
+ * Filebrowser plugin also supports more advanced configuration (through\r
+ * javascript object).\r
+ *\r
+ * The following settings are supported:\r
+ *\r
+ * <pre>\r
+ * [action] - Browse or QuickUpload\r
+ * [target] - field to update, tabId:elementId\r
+ * [params] - additional arguments to be passed to the server connector (optional)\r
+ * [onSelect] - function to execute when file is selected/uploaded (optional)\r
+ * [url] - the URL to be called (optional)\r
+ * </pre>\r
+ *\r
+ * Example 3: (Quick Upload)\r
+ *\r
+ * <pre>\r
+ * {\r
+ * type : 'fileButton',\r
+ * label : editor.lang.common.uploadSubmit,\r
+ * id : 'buttonId',\r
+ * filebrowser :\r
+ * {\r
+ * action : 'QuickUpload', //required\r
+ * target : 'tab1:elementId', //required\r
+ * params : //optional\r
+ * {\r
+ * type : 'Files',\r
+ * currentFolder : '/folder/'\r
+ * },\r
+ * onSelect : function( fileUrl, errorMessage ) //optional\r
+ * {\r
+ * // Do not call the built-in selectFuntion\r
+ * // return false;\r
+ * }\r
+ * },\r
+ * 'for' : [ 'tab1', 'myFile' ]\r
+ * }\r
+ * </pre>\r
+ *\r
+ * Suppose we have a file element with id 'myFile', text field with id\r
+ * 'elementId' and a fileButton. If filebowser.url is not specified explicitly,\r
+ * form action will be set to 'filebrowser[DialogName]UploadUrl' or, if not\r
+ * specified, to 'filebrowserUploadUrl'. Additional parameters from 'params'\r
+ * object will be added to the query string. It is possible to create your own\r
+ * uploadHandler and cancel the built-in updateTargetElement command.\r
+ *\r
+ * Example 4: (Browse)\r
+ *\r
+ * <pre>\r
+ * {\r
+ * type : 'button',\r
+ * id : 'buttonId',\r
+ * label : editor.lang.common.browseServer,\r
+ * filebrowser :\r
+ * {\r
+ * action : 'Browse',\r
+ * url : '/ckfinder/ckfinder.html&type=Images',\r
+ * target : 'tab1:elementId'\r
+ * }\r
+ * }\r
+ * </pre>\r
+ *\r
+ * In this example, after pressing a button, file browser will be opened in a\r
+ * popup. If we don't specify filebrowser.url attribute,\r
+ * 'filebrowser[DialogName]BrowseUrl' or 'filebrowserBrowseUrl' will be used.\r
+ * After selecting a file in a file browser, an element with id 'elementId' will\r
+ * be updated. Just like in the third example, a custom 'onSelect' function may be\r
+ * defined.\r
+ */\r
+( function()\r
+{\r
+ /**\r
+ * Adds (additional) arguments to given url.\r
+ *\r
+ * @param {String}\r
+ * url The url.\r
+ * @param {Object}\r
+ * params Additional parameters.\r
+ */\r
+ function addQueryString( url, params )\r
+ {\r
+ var queryString = [];\r
+\r
+ if ( !params )\r
+ return url;\r
+ else\r
+ {\r
+ for ( var i in params )\r
+ queryString.push( i + "=" + encodeURIComponent( params[ i ] ) );\r
+ }\r
+\r
+ return url + ( ( url.indexOf( "?" ) != -1 ) ? "&" : "?" ) + queryString.join( "&" );\r
+ }\r
+\r
+ /**\r
+ * Make a string's first character uppercase.\r
+ *\r
+ * @param {String}\r
+ * str String.\r
+ */\r
+ function ucFirst( str )\r
+ {\r
+ str += '';\r
+ var f = str.charAt( 0 ).toUpperCase();\r
+ return f + str.substr( 1 );\r
+ }\r
+\r
+ /**\r
+ * The onlick function assigned to the 'Browse Server' button. Opens the\r
+ * file browser and updates target field when file is selected.\r
+ *\r
+ * @param {CKEDITOR.event}\r
+ * evt The event object.\r
+ */\r
+ function browseServer( evt )\r
+ {\r
+ var dialog = this.getDialog();\r
+ var editor = dialog.getParentEditor();\r
+\r
+ editor._.filebrowserSe = this;\r
+\r
+ var width = editor.config[ 'filebrowser' + ucFirst( dialog.getName() ) + 'WindowWidth' ]\r
+ || editor.config.filebrowserWindowWidth || '80%';\r
+ var height = editor.config[ 'filebrowser' + ucFirst( dialog.getName() ) + 'WindowHeight' ]\r
+ || editor.config.filebrowserWindowHeight || '70%';\r
+\r
+ var params = this.filebrowser.params || {};\r
+ params.CKEditor = editor.name;\r
+ params.CKEditorFuncNum = editor._.filebrowserFn;\r
+ if ( !params.langCode )\r
+ params.langCode = editor.langCode;\r
+\r
+ var url = addQueryString( this.filebrowser.url, params );\r
+ editor.popup( url, width, height );\r
+ }\r
+\r
+ /**\r
+ * The onlick function assigned to the 'Upload' button. Makes the final\r
+ * decision whether form is really submitted and updates target field when\r
+ * file is uploaded.\r
+ *\r
+ * @param {CKEDITOR.event}\r
+ * evt The event object.\r
+ */\r
+ function uploadFile( evt )\r
+ {\r
+ var dialog = this.getDialog();\r
+ var editor = dialog.getParentEditor();\r
+\r
+ editor._.filebrowserSe = this;\r
+\r
+ // If user didn't select the file, stop the upload.\r
+ if ( !dialog.getContentElement( this[ 'for' ][ 0 ], this[ 'for' ][ 1 ] ).getInputElement().$.value )\r
+ return false;\r
+\r
+ if ( !dialog.getContentElement( this[ 'for' ][ 0 ], this[ 'for' ][ 1 ] ).getAction() )\r
+ return false;\r
+\r
+ return true;\r
+ }\r
+\r
+ /**\r
+ * Setups the file element.\r
+ *\r
+ * @param {CKEDITOR.ui.dialog.file}\r
+ * fileInput The file element used during file upload.\r
+ * @param {Object}\r
+ * filebrowser Object containing filebrowser settings assigned to\r
+ * the fileButton associated with this file element.\r
+ */\r
+ function setupFileElement( editor, fileInput, filebrowser )\r
+ {\r
+ var params = filebrowser.params || {};\r
+ params.CKEditor = editor.name;\r
+ params.CKEditorFuncNum = editor._.filebrowserFn;\r
+ if ( !params.langCode )\r
+ params.langCode = editor.langCode;\r
+\r
+ fileInput.action = addQueryString( filebrowser.url, params );\r
+ fileInput.filebrowser = filebrowser;\r
+ }\r
+\r
+ /**\r
+ * Traverse through the content definition and attach filebrowser to\r
+ * elements with 'filebrowser' attribute.\r
+ *\r
+ * @param String\r
+ * dialogName Dialog name.\r
+ * @param {CKEDITOR.dialog.dialogDefinitionObject}\r
+ * definition Dialog definition.\r
+ * @param {Array}\r
+ * elements Array of {@link CKEDITOR.dialog.contentDefinition}\r
+ * objects.\r
+ */\r
+ function attachFileBrowser( editor, dialogName, definition, elements )\r
+ {\r
+ var element, fileInput;\r
+\r
+ for ( var i in elements )\r
+ {\r
+ element = elements[ i ];\r
+\r
+ if ( element.type == 'hbox' || element.type == 'vbox' )\r
+ attachFileBrowser( editor, dialogName, definition, element.children );\r
+\r
+ if ( !element.filebrowser )\r
+ continue;\r
+\r
+ if ( typeof element.filebrowser == 'string' )\r
+ {\r
+ var fb =\r
+ {\r
+ action : ( element.type == 'fileButton' ) ? 'QuickUpload' : 'Browse',\r
+ target : element.filebrowser\r
+ };\r
+ element.filebrowser = fb;\r
+ }\r
+\r
+ if ( element.filebrowser.action == 'Browse' )\r
+ {\r
+ var url = element.filebrowser.url || editor.config[ 'filebrowser' + ucFirst( dialogName ) + 'BrowseUrl' ]\r
+ || editor.config.filebrowserBrowseUrl;\r
+\r
+ if ( url )\r
+ {\r
+ element.onClick = browseServer;\r
+ element.filebrowser.url = url;\r
+ element.hidden = false;\r
+ }\r
+ }\r
+ else if ( element.filebrowser.action == 'QuickUpload' && element[ 'for' ] )\r
+ {\r
+ url = element.filebrowser.url || editor.config[ 'filebrowser' + ucFirst( dialogName ) + 'UploadUrl' ]\r
+ || editor.config.filebrowserUploadUrl;\r
+\r
+ if ( url )\r
+ {\r
+ element.onClick = uploadFile;\r
+ element.filebrowser.url = url;\r
+ element.hidden = false;\r
+ setupFileElement( editor, definition.getContents( element[ 'for' ][ 0 ] ).get( element[ 'for' ][ 1 ] ), element.filebrowser );\r
+ }\r
+ }\r
+ }\r
+ }\r
+\r
+ /**\r
+ * Updates the target element with the url of uploaded/selected file.\r
+ *\r
+ * @param {String}\r
+ * url The url of a file.\r
+ */\r
+ function updateTargetElement( url, sourceElement )\r
+ {\r
+ var dialog = sourceElement.getDialog();\r
+ var targetElement = sourceElement.filebrowser.target || null;\r
+ url = url.replace( /#/g, '%23' );\r
+\r
+ // If there is a reference to targetElement, update it.\r
+ if ( targetElement )\r
+ {\r
+ var target = targetElement.split( ':' );\r
+ var element = dialog.getContentElement( target[ 0 ], target[ 1 ] );\r
+ if ( element )\r
+ {\r
+ element.setValue( url );\r
+ dialog.selectPage( target[ 0 ] );\r
+ }\r
+ }\r
+ }\r
+\r
+ /**\r
+ * Returns true if filebrowser is configured in one of the elements.\r
+ *\r
+ * @param {CKEDITOR.dialog.dialogDefinitionObject}\r
+ * definition Dialog definition.\r
+ * @param String\r
+ * tabId The tab id where element(s) can be found.\r
+ * @param String\r
+ * elementId The element id (or ids, separated with a semicolon) to check.\r
+ */\r
+ function isConfigured( definition, tabId, elementId )\r
+ {\r
+ if ( elementId.indexOf( ";" ) !== -1 )\r
+ {\r
+ var ids = elementId.split( ";" );\r
+ for ( var i = 0 ; i < ids.length ; i++ )\r
+ {\r
+ if ( isConfigured( definition, tabId, ids[i]) )\r
+ return true;\r
+ }\r
+ return false;\r
+ }\r
+\r
+ return ( definition.getContents( tabId ).get( elementId ).filebrowser && definition.getContents( tabId ).get( elementId ).filebrowser.url );\r
+ }\r
+\r
+ function setUrl( fileUrl, data )\r
+ {\r
+ var dialog = this._.filebrowserSe.getDialog(),\r
+ targetInput = this._.filebrowserSe[ 'for' ],\r
+ onSelect = this._.filebrowserSe.filebrowser.onSelect;\r
+\r
+ if ( targetInput )\r
+ dialog.getContentElement( targetInput[ 0 ], targetInput[ 1 ] ).reset();\r
+\r
+ if ( onSelect && onSelect.call( this._.filebrowserSe, fileUrl, data ) === false )\r
+ return;\r
+\r
+ // The "data" argument may be used to pass the error message to the editor.\r
+ if ( typeof data == 'string' && data )\r
+ alert( data );\r
+\r
+ if ( fileUrl )\r
+ updateTargetElement( fileUrl, this._.filebrowserSe );\r
+ }\r
+\r
+ CKEDITOR.plugins.add( 'filebrowser',\r
+ {\r
+ init : function( editor, pluginPath )\r
+ {\r
+ editor._.filebrowserFn = CKEDITOR.tools.addFunction( setUrl, editor );\r
+\r
+ CKEDITOR.on( 'dialogDefinition', function( evt )\r
+ {\r
+ // Associate filebrowser to elements with 'filebrowser' attribute.\r
+ for ( var i in evt.data.definition.contents )\r
+ {\r
+ attachFileBrowser( evt.editor, evt.data.name, evt.data.definition, evt.data.definition.contents[ i ].elements );\r
+ if ( evt.data.definition.contents[ i ].hidden && evt.data.definition.contents[ i ].filebrowser )\r
+ {\r
+ evt.data.definition.contents[ i ].hidden =\r
+ !isConfigured( evt.data.definition, evt.data.definition.contents[ i ][ 'id' ], evt.data.definition.contents[ i ].filebrowser );\r
+ }\r
+ }\r
+ } );\r
+ }\r
+ } );\r
+\r
+} )();\r
Got questions, comments, patches, etc.? Contact Jason Woofenden