4 * mw.Upload.BookletLayout encapsulates the process of uploading a file
5 * to MediaWiki using the {@link mw.Upload upload model}.
6 * The booklet emits events that can be used to get the stashed
7 * upload and the final file. It can be extended to accept
8 * additional fields from the user for specific scenarios like
9 * for Commons, or campaigns.
13 * The {@link OO.ui.BookletLayout booklet layout} has three steps:
15 * - **Upload**: Has a {@link OO.ui.SelectFileWidget field} to get the file object.
17 * - **Information**: Has a {@link OO.ui.FormLayout form} to collect metadata. This can be
20 * - **Insert**: Has details on how to use the file that was uploaded.
22 * Each step has a form associated with it defined in
23 * {@link #renderUploadForm renderUploadForm},
24 * {@link #renderInfoForm renderInfoForm}, and
25 * {@link #renderInsertForm renderInfoForm}. The
26 * {@link #getFile getFile},
27 * {@link #getFilename getFilename}, and
28 * {@link #getText getText} methods are used to get
29 * the information filled in these forms, required to call
30 * {@link mw.Upload mw.Upload}.
34 * See the {@link mw.Upload.Dialog upload dialog}.
36 * The {@link #event-fileUploaded fileUploaded},
37 * and {@link #event-fileSaved fileSaved} events can
38 * be used to get details of the upload.
42 * To extend using {@link mw.Upload mw.Upload}, override
43 * {@link #renderInfoForm renderInfoForm} to render
44 * the form required for the specific use-case. Update the
45 * {@link #getFilename getFilename}, and
46 * {@link #getText getText} methods to return data
47 * from your newly created form. If you added new fields you'll also have
48 * to update the {@link #clear} method.
50 * If you plan to use a different upload model, apart from what is mentioned
51 * above, you'll also have to override the
52 * {@link #createUpload createUpload} method to
53 * return the new model. The {@link #saveFile saveFile}, and
54 * the {@link #uploadFile uploadFile} methods need to be
55 * overriden to use the new model and data returned from the forms.
58 * @extends OO.ui.BookletLayout
61 * @param {Object} config Configuration options
62 * @cfg {jQuery} [$overlay] Overlay to use for widgets in the booklet
64 mw
.Upload
.BookletLayout = function ( config
) {
66 mw
.Upload
.BookletLayout
.parent
.call( this, config
);
68 this.$overlay
= config
.$overlay
;
70 this.renderUploadForm();
71 this.renderInfoForm();
72 this.renderInsertForm();
75 new OO
.ui
.PageLayout( 'upload', {
78 content
: [ this.uploadForm
]
80 new OO
.ui
.PageLayout( 'info', {
83 content
: [ this.infoForm
]
85 new OO
.ui
.PageLayout( 'insert', {
88 content
: [ this.insertForm
]
95 OO
.inheritClass( mw
.Upload
.BookletLayout
, OO
.ui
.BookletLayout
);
100 * The file has finished uploading
102 * @event fileUploaded
106 * The file has been saved to the database
112 * The upload form has changed
115 * @param {boolean} isValid The form is valid
119 * The info form has changed
122 * @param {boolean} isValid The form is valid
128 * @property {OO.ui.FormLayout} uploadForm
129 * The form rendered in the first step to get the file object.
130 * Rendered in {@link #renderUploadForm renderUploadForm}.
134 * @property {OO.ui.FormLayout} infoForm
135 * The form rendered in the second step to get metadata.
136 * Rendered in {@link #renderInfoForm renderInfoForm}
140 * @property {OO.ui.FormLayout} insertForm
141 * The form rendered in the third step to show usage
142 * Rendered in {@link #renderInsertForm renderInsertForm}
148 * Initialize for a new upload
150 mw
.Upload
.BookletLayout
.prototype.initialize = function () {
152 this.upload
= this.createUpload();
153 this.setPage( 'upload' );
157 * Create a new upload model
160 * @return {mw.Upload} Upload model
162 mw
.Upload
.BookletLayout
.prototype.createUpload = function () {
163 return new mw
.Upload();
169 * Uploads the file that was added in the upload form. Uses
170 * {@link #getFile getFile} to get the HTML5
174 * @fires fileUploaded
175 * @return {jQuery.Promise}
177 mw
.Upload
.BookletLayout
.prototype.uploadFile = function () {
178 var deferred
= $.Deferred(),
180 file
= this.getFile();
182 this.filenameWidget
.setValue( file
.name
);
183 this.setPage( 'info' );
185 this.upload
.setFile( file
);
186 // Explicitly set the filename so that the old filename isn't used in case of retry
187 this.upload
.setFilenameFromFile();
189 this.uploadPromise
= this.upload
.uploadToStash();
190 this.uploadPromise
.then( function () {
192 layout
.emit( 'fileUploaded' );
194 // These errors will be thrown while the user is on the info page.
195 // Pretty sure it's impossible to get a warning other than 'stashfailed' here, which should
196 // really be an error...
197 var errorMessage
= layout
.getErrorMessageForStateDetails();
198 deferred
.reject( errorMessage
);
201 // If there is an error in uploading, come back to the upload page
202 deferred
.fail( function () {
203 layout
.setPage( 'upload' );
210 * Saves the stash finalizes upload. Uses
211 * {@link #getFilename getFilename}, and
212 * {@link #getText getText} to get details from
217 * @returns {jQuery.Promise} Rejects the promise with an
218 * {@link OO.ui.Error error}, or resolves if the upload was successful.
220 mw
.Upload
.BookletLayout
.prototype.saveFile = function () {
222 deferred
= $.Deferred();
224 this.upload
.setFilename( this.getFilename() );
225 this.upload
.setText( this.getText() );
227 this.uploadPromise
.then( function () {
228 layout
.upload
.finishStashUpload().then( function () {
231 // Normalize page name and localise the 'File:' prefix
232 name
= new mw
.Title( 'File:' + layout
.upload
.getFilename() ).toString();
233 layout
.filenameUsageWidget
.setValue( '[[' + name
+ ']]' );
234 layout
.setPage( 'insert' );
237 layout
.emit( 'fileSaved' );
239 var errorMessage
= layout
.getErrorMessageForStateDetails();
240 deferred
.reject( errorMessage
);
244 return deferred
.promise();
248 * Get an error message (as OO.ui.Error object) that should be displayed to the user for current
249 * state and state details.
252 * @returns {OO.ui.Error} Error to display for given state and details.
254 mw
.Upload
.BookletLayout
.prototype.getErrorMessageForStateDetails = function () {
256 state
= this.upload
.getState(),
257 stateDetails
= this.upload
.getStateDetails(),
258 error
= stateDetails
.error
,
259 warnings
= stateDetails
.upload
&& stateDetails
.upload
.warnings
;
261 if ( state
=== mw
.Upload
.State
.ERROR
) {
262 message
= mw
.message( 'api-error-' + error
.code
);
263 if ( !message
.exists() ) {
264 message
= mw
.message( 'api-error-unknownerror', JSON
.stringify( stateDetails
) );
266 return new OO
.ui
.Error(
270 { recoverable
: false }
274 if ( state
=== mw
.Upload
.State
.WARNING
) {
275 // We could get more than one of these errors, these are in order
276 // of importance. For example fixing the thumbnail like file name
277 // won't help the fact that the file already exists.
278 if ( warnings
.stashfailed
!== undefined ) {
279 return new OO
.ui
.Error(
281 mw
.message( 'api-error-stashfailed' ).parse()
283 { recoverable
: false }
285 } else if ( warnings
.exists
!== undefined ) {
286 return new OO
.ui
.Error(
288 mw
.message( 'fileexists', warnings
.exists
).parse()
290 { recoverable
: false }
292 } else if ( warnings
[ 'page-exists' ] !== undefined ) {
293 return new OO
.ui
.Error(
295 mw
.message( 'filepageexists', warnings
[ 'page-exists' ] ).parse()
297 { recoverable
: false }
299 } else if ( warnings
.duplicate
!== undefined ) {
300 return new OO
.ui
.Error(
302 mw
.message( 'api-error-duplicate', warnings
.duplicate
[ 0 ] ).parse()
304 { recoverable
: false }
306 } else if ( warnings
[ 'thumb-name' ] !== undefined ) {
307 return new OO
.ui
.Error(
309 mw
.message( 'filename-thumb-name' ).parse()
311 { recoverable
: false }
313 } else if ( warnings
[ 'bad-prefix' ] !== undefined ) {
314 return new OO
.ui
.Error(
316 mw
.message( 'filename-bad-prefix', warnings
[ 'bad-prefix' ] ).parse()
318 { recoverable
: false }
320 } else if ( warnings
[ 'duplicate-archive' ] !== undefined ) {
321 return new OO
.ui
.Error(
323 mw
.message( 'api-error-duplicate-archive', warnings
[ 'duplicate-archive' ] ).parse()
325 { recoverable
: false }
327 } else if ( warnings
.badfilename
!== undefined ) {
328 // Change the name if the current name isn't acceptable
329 // TODO This might not really be the best place to do this
330 this.filenameWidget
.setValue( warnings
.badfilename
);
331 return new OO
.ui
.Error(
333 mw
.message( 'badfilename', warnings
.badfilename
).parse()
337 return new OO
.ui
.Error(
339 // Let's get all the help we can if we can't pin point the error
340 mw
.message( 'api-error-unknown-warning', JSON
.stringify( stateDetails
) ).parse()
342 { recoverable
: false }
351 * Renders and returns the upload form and sets the
352 * {@link #uploadForm uploadForm} property.
356 * @returns {OO.ui.FormLayout}
358 mw
.Upload
.BookletLayout
.prototype.renderUploadForm = function () {
361 this.selectFileWidget
= new OO
.ui
.SelectFileWidget();
362 fieldset
= new OO
.ui
.FieldsetLayout( { label
: mw
.msg( 'upload-form-label-select-file' ) } );
363 fieldset
.addItems( [ this.selectFileWidget
] );
364 this.uploadForm
= new OO
.ui
.FormLayout( { items
: [ fieldset
] } );
367 this.selectFileWidget
.on( 'change', this.onUploadFormChange
.bind( this ) );
369 return this.uploadForm
;
373 * Handle change events to the upload form
378 mw
.Upload
.BookletLayout
.prototype.onUploadFormChange = function () {
379 this.emit( 'uploadValid', !!this.selectFileWidget
.getValue() );
383 * Renders and returns the information form for collecting
384 * metadata and sets the {@link #infoForm infoForm}
388 * @returns {OO.ui.FormLayout}
390 mw
.Upload
.BookletLayout
.prototype.renderInfoForm = function () {
393 this.filenameWidget
= new OO
.ui
.TextInputWidget( {
394 indicator
: 'required',
398 this.descriptionWidget
= new OO
.ui
.TextInputWidget( {
399 indicator
: 'required',
406 fieldset
= new OO
.ui
.FieldsetLayout( {
407 label
: mw
.msg( 'upload-form-label-infoform-title' )
410 new OO
.ui
.FieldLayout( this.filenameWidget
, {
411 label
: mw
.msg( 'upload-form-label-infoform-name' ),
414 new OO
.ui
.FieldLayout( this.descriptionWidget
, {
415 label
: mw
.msg( 'upload-form-label-infoform-description' ),
419 this.infoForm
= new OO
.ui
.FormLayout( { items
: [ fieldset
] } );
421 this.filenameWidget
.on( 'change', this.onInfoFormChange
.bind( this ) );
422 this.descriptionWidget
.on( 'change', this.onInfoFormChange
.bind( this ) );
424 return this.infoForm
;
428 * Handle change events to the info form
433 mw
.Upload
.BookletLayout
.prototype.onInfoFormChange = function () {
436 this.filenameWidget
.getValidity(),
437 this.descriptionWidget
.getValidity()
438 ).done( function () {
439 layout
.emit( 'infoValid', true );
440 } ).fail( function () {
441 layout
.emit( 'infoValid', false );
446 * Renders and returns the insert form to show file usage and
447 * sets the {@link #insertForm insertForm} property.
450 * @returns {OO.ui.FormLayout}
452 mw
.Upload
.BookletLayout
.prototype.renderInsertForm = function () {
455 this.filenameUsageWidget
= new OO
.ui
.TextInputWidget();
456 fieldset
= new OO
.ui
.FieldsetLayout( {
457 label
: mw
.msg( 'upload-form-label-usage-title' )
460 new OO
.ui
.FieldLayout( this.filenameUsageWidget
, {
461 label
: mw
.msg( 'upload-form-label-usage-filename' ),
465 this.insertForm
= new OO
.ui
.FormLayout( { items
: [ fieldset
] } );
467 return this.insertForm
;
473 * Gets the file object from the
474 * {@link #uploadForm upload form}.
477 * @returns {File|null}
479 mw
.Upload
.BookletLayout
.prototype.getFile = function () {
480 return this.selectFileWidget
.getValue();
484 * Gets the file name from the
485 * {@link #infoForm information form}.
490 mw
.Upload
.BookletLayout
.prototype.getFilename = function () {
491 return this.filenameWidget
.getValue();
495 * Gets the page text from the
496 * {@link #infoForm information form}.
501 mw
.Upload
.BookletLayout
.prototype.getText = function () {
502 return this.descriptionWidget
.getValue();
508 * Sets the file object
511 * @param {File|null} file File to select
513 mw
.Upload
.BookletLayout
.prototype.setFile = function ( file
) {
514 this.selectFileWidget
.setValue( file
);
518 * Clear the values of all fields
522 mw
.Upload
.BookletLayout
.prototype.clear = function () {
523 this.selectFileWidget
.setValue( null );
524 this.filenameWidget
.setValue( null ).setValidityFlag( true );
525 this.descriptionWidget
.setValue( null ).setValidityFlag( true );
526 this.filenameUsageWidget
.setValue( null );
529 }( jQuery
, mediaWiki
) );