Merge branch 't/13519' into major

Author: Piotr Jasiun

CHANGES.md

@@ -6,6 +6,7 @@ CKEditor 4 Changelog
 New Features:
 
 * [#12077](https://dev.ckeditor.com/ticket/12077): Add support for HTML5 "download" attribute in link (a) elements. Thanks to [sbusse](https://github.com/sbusse)!
+* [#13519](http://dev.ckeditor.com/ticket/13519): (http://docs.ckeditor.com/#!/api/CKEDITOR.fileTools) response is now more flexible.
 
 ## CKEditor 4.5.5
 

plugins/filetools/plugin.js

@@ -58,7 +58,7 @@
 			 * @since 4.5
 			 * @event fileUploadResponse
 			 * @member CKEDITOR.editor
-			 * @param data
+			 * @param data All data will be passed to the {@link CKEDITOR.fileTools.fileLoader#responseData}.
 			 * @param {CKEDITOR.fileTools.fileLoader} data.fileLoader A file loader instance.
 			 * @param {String} data.message The message from the server. Needs to be set in the listener — see the example above.
 			 * @param {String} data.fileName The file name on server. Needs to be set in the listener — see the example above.
@@ -82,8 +82,9 @@
 					if ( !response.uploaded ) {
 						evt.cancel();
 					} else {
-						data.fileName = response.fileName;
-						data.url = response.url;
+						for ( var i in response ) {
+							data[ i ] = response[ i ];
+						}
 					}
 				} catch ( err ) {
 					// Response parsing error.
@@ -278,6 +279,8 @@
 		this.uploaded = 0;
 		this.uploadTotal = null;
 
+		this.responseData = null;
+
 		this.status = 'created';
 
 		this.abort = function() {
@@ -344,6 +347,16 @@
 	 * @property {Number} total
 	 */
 
+	/**
+	 * All data received in the response from the server. If server return addition data they will be available
+	 * in this property.
+	 *
+	 * It contains all data set in the {@link CKEDITOR.editor#fileUploadResponse} event listener.
+	 *
+	 * @readonly
+	 * @property {Object} responseData
+	 */
+
 	/**
 	 * The total size of upload data in bytes.
 	 * If the `xhr.upload` object is present, this value will indicate the total size of the request payload, not only the file
@@ -595,6 +608,11 @@
 						}
 					}
 
+					// The whole response is also hold for use by uploadwidgets (#13519).
+					loader.responseData = data;
+					// But without reference to the loader itself.
+					delete loader.responseData.fileLoader;
+
 					if ( success === false ) {
 						loader.changeStatus( 'error' );
 					} else {

tests/plugins/filetools/fileloader.js

@@ -768,6 +768,27 @@
 			wait();
 		},
 
+		'test response with custom fields (#13519)': function() {
+			var loader = new FileLoader( editorMock, testFile ),
+				response = {
+					fileName: 'name2.png',
+					uploaded: 1,
+					url: 'http:\/\/url\/name2.png',
+					foo: 'bar'
+				};
+
+			createXMLHttpRequestMock( [ 'progress', 'load' ],
+				{ responseText: JSON.stringify( response ) } );
+
+			resumeAfter( loader, 'uploaded', function() {
+				objectAssert.areEqual( response, loader.responseData );
+			} );
+
+			loader.upload( 'http:\/\/url\/' );
+
+			wait();
+		},
+
 		'test error 404 with message': function() {
 			editorMock.lang = { filetools: { httpError404: 'httpError404' } };
 
@@ -866,6 +887,31 @@
 			wait();
 		},
 
+		'test additional data in fileUploadResponse (#13519)': function() {
+			var data,
+				loader = new FileLoader( editorMock, testFile );
+
+			createXMLHttpRequestMock( [ 'progress', 'load' ],
+				{ responseText: '{' +
+					'"fileName":"name2.png",' +
+					'"uploaded":1,' +
+					'"url":"http:\/\/url\/name2.png",' +
+					'"foo":"bar"' +
+				'}' } );
+
+			attachListener( editorMock, 'fileUploadResponse', function( evt ) {
+				data = evt.data;
+			} );
+
+			resumeAfter( editorMock, 'fileUploadResponse', function() {
+				assert.areSame( 'bar', data.foo );
+			} );
+
+			loader.upload( 'http:\/\/url\/' );
+
+			wait();
+		},
+
 		'test custom fileUploadRequest and fileUploadResponse': function() {
 			editorMock.lang = { filetools: { responseError: 'err' } };