2 Copyright (c) 2003-2011, CKSource - Frederico Knabben. All rights reserved.
3 For licensing, see LICENSE.html or http://ckeditor.com/license
7 * @fileOverview The "filebrowser" plugin that adds support for file uploads and
10 * When a file is uploaded or selected inside the file browser, its URL is
11 * inserted automatically into a field defined in the <code>filebrowser</code>
12 * attribute. In order to specify a field that should be updated, pass the tab ID and
13 * the element ID, separated with a colon.<br /><br />
15 * <strong>Example 1: (Browse)</strong>
21 * filebrowser : 'tabId:elementId',
22 * label : editor.lang.common.browseServer
26 * If you set the <code>filebrowser</code> attribute for an element other than
27 * the <code>fileButton</code>, the <code>Browse</code> action will be triggered.<br /><br />
29 * <strong>Example 2: (Quick Upload)</strong>
33 * type : 'fileButton',
34 * id : 'uploadButton',
35 * filebrowser : 'tabId:elementId',
36 * label : editor.lang.common.uploadSubmit,
37 * 'for' : [ 'upload', 'upload' ]
41 * If you set the <code>filebrowser</code> attribute for a <code>fileButton</code>
42 * element, the <code>QuickUpload</code> action will be executed.<br /><br />
44 * The filebrowser plugin also supports more advanced configuration performed through
45 * a JavaScript object.
47 * The following settings are supported:
50 * <li><code>action</code> – <code>Browse</code> or <code>QuickUpload</code>.</li>
51 * <li><code>target</code> – the field to update in the <code><em>tabId:elementId</em></code> format.</li>
52 * <li><code>params</code> – additional arguments to be passed to the server connector (optional).</li>
53 * <li><code>onSelect</code> – a function to execute when the file is selected/uploaded (optional).</li>
54 * <li><code>url</code> – the URL to be called (optional).</li>
57 * <strong>Example 3: (Quick Upload)</strong>
61 * type : 'fileButton',
62 * label : editor.lang.common.uploadSubmit,
66 * action : 'QuickUpload', // required
67 * target : 'tab1:elementId', // required
68 * params : // optional
71 * currentFolder : '/folder/'
73 * onSelect : function( fileUrl, errorMessage ) // optional
75 * // Do not call the built-in selectFuntion.
79 * 'for' : [ 'tab1', 'myFile' ]
83 * Suppose you have a file element with an ID of <code>myFile</code>, a text
84 * field with an ID of <code>elementId</code> and a <code>fileButton</code>.
85 * If the <code>filebowser.url</code> attribute is not specified explicitly,
86 * the form action will be set to <code>filebrowser[<em>DialogWindowName</em>]UploadUrl</code>
87 * or, if not specified, to <code>filebrowserUploadUrl</code>. Additional parameters
88 * from the <code>params</code> object will be added to the query string. It is
89 * possible to create your own <code>uploadHandler</code> and cancel the built-in
90 * <code>updateTargetElement</code> command.<br /><br />
92 * <strong>Example 4: (Browse)</strong>
98 * label : editor.lang.common.browseServer,
102 * url : '/ckfinder/ckfinder.html&type=Images',
103 * target : 'tab1:elementId'
108 * In this example, when the button is pressed, the file browser will be opened in a
109 * popup window. If you do not specify the <code>filebrowser.url</code> attribute,
110 * <code>filebrowser[<em>DialogName</em>]BrowseUrl</code> or
111 * <code>filebrowserBrowseUrl</code> will be used. After selecting a file in the file
112 * browser, an element with an ID of <code>elementId</code> will be updated. Just
113 * like in the third example, a custom <code>onSelect</code> function may be defined.
118 * Adds (additional) arguments to given url.
123 * params Additional parameters.
125 function addQueryString( url, params )
127 var queryString = [];
133 for ( var i in params )
134 queryString.push( i + "=" + encodeURIComponent( params[ i ] ) );
137 return url + ( ( url.indexOf( "?" ) != -1 ) ? "&" : "?" ) + queryString.join( "&" );
141 * Make a string's first character uppercase.
146 function ucFirst( str )
149 var f = str.charAt( 0 ).toUpperCase();
150 return f + str.substr( 1 );
154 * The onlick function assigned to the 'Browse Server' button. Opens the
155 * file browser and updates target field when file is selected.
157 * @param {CKEDITOR.event}
158 * evt The event object.
160 function browseServer( evt )
162 var dialog = this.getDialog();
163 var editor = dialog.getParentEditor();
165 editor._.filebrowserSe = this;
167 var width = editor.config[ 'filebrowser' + ucFirst( dialog.getName() ) + 'WindowWidth' ]
168 || editor.config.filebrowserWindowWidth || '80%';
169 var height = editor.config[ 'filebrowser' + ucFirst( dialog.getName() ) + 'WindowHeight' ]
170 || editor.config.filebrowserWindowHeight || '70%';
172 var params = this.filebrowser.params || {};
173 params.CKEditor = editor.name;
174 params.CKEditorFuncNum = editor._.filebrowserFn;
175 if ( !params.langCode )
176 params.langCode = editor.langCode;
178 var url = addQueryString( this.filebrowser.url, params );
179 // TODO: V4: Remove backward compatibility (#8163).
180 editor.popup( url, width, height, editor.config.filebrowserWindowFeatures || editor.config.fileBrowserWindowFeatures );
184 * The onlick function assigned to the 'Upload' button. Makes the final
185 * decision whether form is really submitted and updates target field when
188 * @param {CKEDITOR.event}
189 * evt The event object.
191 function uploadFile( evt )
193 var dialog = this.getDialog();
194 var editor = dialog.getParentEditor();
196 editor._.filebrowserSe = this;
198 // If user didn't select the file, stop the upload.
199 if ( !dialog.getContentElement( this[ 'for' ][ 0 ], this[ 'for' ][ 1 ] ).getInputElement().$.value )
202 if ( !dialog.getContentElement( this[ 'for' ][ 0 ], this[ 'for' ][ 1 ] ).getAction() )
209 * Setups the file element.
211 * @param {CKEDITOR.ui.dialog.file}
212 * fileInput The file element used during file upload.
214 * filebrowser Object containing filebrowser settings assigned to
215 * the fileButton associated with this file element.
217 function setupFileElement( editor, fileInput, filebrowser )
219 var params = filebrowser.params || {};
220 params.CKEditor = editor.name;
221 params.CKEditorFuncNum = editor._.filebrowserFn;
222 if ( !params.langCode )
223 params.langCode = editor.langCode;
225 fileInput.action = addQueryString( filebrowser.url, params );
226 fileInput.filebrowser = filebrowser;
230 * Traverse through the content definition and attach filebrowser to
231 * elements with 'filebrowser' attribute.
234 * dialogName Dialog name.
235 * @param {CKEDITOR.dialog.definitionObject}
236 * definition Dialog definition.
238 * elements Array of {@link CKEDITOR.dialog.definition.content}
241 function attachFileBrowser( editor, dialogName, definition, elements )
243 var element, fileInput;
245 for ( var i in elements )
247 element = elements[ i ];
249 if ( element.type == 'hbox' || element.type == 'vbox' )
250 attachFileBrowser( editor, dialogName, definition, element.children );
252 if ( !element.filebrowser )
255 if ( typeof element.filebrowser == 'string' )
259 action : ( element.type == 'fileButton' ) ? 'QuickUpload' : 'Browse',
260 target : element.filebrowser
262 element.filebrowser = fb;
265 if ( element.filebrowser.action == 'Browse' )
267 var url = element.filebrowser.url;
268 if ( url === undefined )
270 url = editor.config[ 'filebrowser' + ucFirst( dialogName ) + 'BrowseUrl' ];
271 if ( url === undefined )
272 url = editor.config.filebrowserBrowseUrl;
277 element.onClick = browseServer;
278 element.filebrowser.url = url;
279 element.hidden = false;
282 else if ( element.filebrowser.action == 'QuickUpload' && element[ 'for' ] )
284 url = element.filebrowser.url;
285 if ( url === undefined )
287 url = editor.config[ 'filebrowser' + ucFirst( dialogName ) + 'UploadUrl' ];
288 if ( url === undefined )
289 url = editor.config.filebrowserUploadUrl;
294 var onClick = element.onClick;
295 element.onClick = function( evt )
297 // "element" here means the definition object, so we need to find the correct
298 // button to scope the event call
299 var sender = evt.sender;
300 if ( onClick && onClick.call( sender, evt ) === false )
303 return uploadFile.call( sender, evt );
306 element.filebrowser.url = url;
307 element.hidden = false;
308 setupFileElement( editor, definition.getContents( element[ 'for' ][ 0 ] ).get( element[ 'for' ][ 1 ] ), element.filebrowser );
315 * Updates the target element with the url of uploaded/selected file.
318 * url The url of a file.
320 function updateTargetElement( url, sourceElement )
322 var dialog = sourceElement.getDialog();
323 var targetElement = sourceElement.filebrowser.target || null;
324 url = url.replace( /#/g, '%23' );
326 // If there is a reference to targetElement, update it.
329 var target = targetElement.split( ':' );
330 var element = dialog.getContentElement( target[ 0 ], target[ 1 ] );
333 element.setValue( url );
334 dialog.selectPage( target[ 0 ] );
340 * Returns true if filebrowser is configured in one of the elements.
342 * @param {CKEDITOR.dialog.definitionObject}
343 * definition Dialog definition.
345 * tabId The tab id where element(s) can be found.
347 * elementId The element id (or ids, separated with a semicolon) to check.
349 function isConfigured( definition, tabId, elementId )
351 if ( elementId.indexOf( ";" ) !== -1 )
353 var ids = elementId.split( ";" );
354 for ( var i = 0 ; i < ids.length ; i++ )
356 if ( isConfigured( definition, tabId, ids[i] ) )
362 var elementFileBrowser = definition.getContents( tabId ).get( elementId ).filebrowser;
363 return ( elementFileBrowser && elementFileBrowser.url );
366 function setUrl( fileUrl, data )
368 var dialog = this._.filebrowserSe.getDialog(),
369 targetInput = this._.filebrowserSe[ 'for' ],
370 onSelect = this._.filebrowserSe.filebrowser.onSelect;
373 dialog.getContentElement( targetInput[ 0 ], targetInput[ 1 ] ).reset();
375 if ( typeof data == 'function' && data.call( this._.filebrowserSe ) === false )
378 if ( onSelect && onSelect.call( this._.filebrowserSe, fileUrl, data ) === false )
381 // The "data" argument may be used to pass the error message to the editor.
382 if ( typeof data == 'string' && data )
386 updateTargetElement( fileUrl, this._.filebrowserSe );
389 CKEDITOR.plugins.add( 'filebrowser',
391 init : function( editor, pluginPath )
393 editor._.filebrowserFn = CKEDITOR.tools.addFunction( setUrl, editor );
394 editor.on( 'destroy', function () { CKEDITOR.tools.removeFunction( this._.filebrowserFn ); } );
398 CKEDITOR.on( 'dialogDefinition', function( evt )
400 var definition = evt.data.definition,
402 // Associate filebrowser to elements with 'filebrowser' attribute.
403 for ( var i in definition.contents )
405 if ( ( element = definition.contents[ i ] ) )
407 attachFileBrowser( evt.editor, evt.data.name, definition, element.elements );
408 if ( element.hidden && element.filebrowser )
410 element.hidden = !isConfigured( definition, element[ 'id' ], element.filebrowser );
419 * The location of an external file browser that should be launched when the <strong>Browse Server</strong>
420 * button is pressed. If configured, the <strong>Browse Server</strong> button will appear in the
421 * <strong>Link</strong>, <strong>Image</strong>, and <strong>Flash</strong> dialog windows.
422 * @see The <a href="http://docs.cksource.com/CKEditor_3.x/Developers_Guide/File_Browser_(Uploader)">File Browser/Uploader</a> documentation.
423 * @name CKEDITOR.config.filebrowserBrowseUrl
426 * @default <code>''</code> (empty string = disabled)
428 * config.filebrowserBrowseUrl = '/browser/browse.php';
432 * The location of the script that handles file uploads.
433 * If set, the <strong>Upload</strong> tab will appear in the <strong>Link</strong>, <strong>Image</strong>,
434 * and <strong>Flash</strong> dialog windows.
435 * @name CKEDITOR.config.filebrowserUploadUrl
436 * @see The <a href="http://docs.cksource.com/CKEditor_3.x/Developers_Guide/File_Browser_(Uploader)">File Browser/Uploader</a> documentation.
439 * @default <code>''</code> (empty string = disabled)
441 * config.filebrowserUploadUrl = '/uploader/upload.php';
445 * The location of an external file browser that should be launched when the <strong>Browse Server</strong>
446 * button is pressed in the <strong>Image</strong> dialog window.
447 * If not set, CKEditor will use <code>{@link CKEDITOR.config.filebrowserBrowseUrl}</code>.
448 * @name CKEDITOR.config.filebrowserImageBrowseUrl
451 * @default <code>''</code> (empty string = disabled)
453 * config.filebrowserImageBrowseUrl = '/browser/browse.php?type=Images';
457 * The location of an external file browser that should be launched when the <strong>Browse Server</strong>
458 * button is pressed in the <strong>Flash</strong> dialog window.
459 * If not set, CKEditor will use <code>{@link CKEDITOR.config.filebrowserBrowseUrl}</code>.
460 * @name CKEDITOR.config.filebrowserFlashBrowseUrl
463 * @default <code>''</code> (empty string = disabled)
465 * config.filebrowserFlashBrowseUrl = '/browser/browse.php?type=Flash';
469 * The location of the script that handles file uploads in the <strong>Image</strong> dialog window.
470 * If not set, CKEditor will use <code>{@link CKEDITOR.config.filebrowserUploadUrl}</code>.
471 * @name CKEDITOR.config.filebrowserImageUploadUrl
474 * @default <code>''</code> (empty string = disabled)
476 * config.filebrowserImageUploadUrl = '/uploader/upload.php?type=Images';
480 * The location of the script that handles file uploads in the <strong>Flash</strong> dialog window.
481 * If not set, CKEditor will use <code>{@link CKEDITOR.config.filebrowserUploadUrl}</code>.
482 * @name CKEDITOR.config.filebrowserFlashUploadUrl
485 * @default <code>''</code> (empty string = disabled)
487 * config.filebrowserFlashUploadUrl = '/uploader/upload.php?type=Flash';
491 * The location of an external file browser that should be launched when the <strong>Browse Server</strong>
492 * button is pressed in the <strong>Link</strong> tab of the <strong>Image</strong> dialog window.
493 * If not set, CKEditor will use <code>{@link CKEDITOR.config.filebrowserBrowseUrl}</code>.
494 * @name CKEDITOR.config.filebrowserImageBrowseLinkUrl
497 * @default <code>''</code> (empty string = disabled)
499 * config.filebrowserImageBrowseLinkUrl = '/browser/browse.php';
503 * The features to use in the file browser popup window.
504 * @name CKEDITOR.config.filebrowserWindowFeatures
507 * @default <code>'location=no,menubar=no,toolbar=no,dependent=yes,minimizable=no,modal=yes,alwaysRaised=yes,resizable=yes,scrollbars=yes'</code>
509 * config.filebrowserWindowFeatures = 'resizable=yes,scrollbars=no';
513 * The width of the file browser popup window. It can be a number denoting a value in
514 * pixels or a percent string.
515 * @name CKEDITOR.config.filebrowserWindowWidth
516 * @type Number|String
517 * @default <code>'80%'</code>
519 * config.filebrowserWindowWidth = 750;
521 * config.filebrowserWindowWidth = '50%';
525 * The height of the file browser popup window. It can be a number denoting a value in
526 * pixels or a percent string.
527 * @name CKEDITOR.config.filebrowserWindowHeight
528 * @type Number|String
529 * @default <code>'70%'</code>
531 * config.filebrowserWindowHeight = 580;
533 * config.filebrowserWindowHeight = '50%';