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 * overridden 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
109 * @param {Object} imageInfo See mw.Upload#getImageInfo
113 * The upload form has changed
116 * @param {boolean} isValid The form is valid
120 * The info form has changed
123 * @param {boolean} isValid The form is valid
129 * @property {OO.ui.FormLayout} uploadForm
130 * The form rendered in the first step to get the file object.
131 * Rendered in {@link #renderUploadForm renderUploadForm}.
135 * @property {OO.ui.FormLayout} infoForm
136 * The form rendered in the second step to get metadata.
137 * Rendered in {@link #renderInfoForm renderInfoForm}
141 * @property {OO.ui.FormLayout} insertForm
142 * The form rendered in the third step to show usage
143 * Rendered in {@link #renderInsertForm renderInsertForm}
149 * Initialize for a new upload
151 * @return {jQuery.Promise} Promise resolved when everything is initialized
153 mw
.Upload
.BookletLayout
.prototype.initialize = function () {
157 this.upload
= this.createUpload();
158 this.setPage( 'upload' );
160 return this.upload
.getApi().then(
162 // If the user can't upload anything, don't give them the option to.
163 return api
.getUserInfo().then(
164 function ( userInfo
) {
165 if ( userInfo
.rights
.indexOf( 'upload' ) === -1 ) {
166 // TODO Use a better error message when not all logged-in users can upload
167 booklet
.getPage( 'upload' ).$element
.msg( 'api-error-mustbeloggedin' );
169 return $.Deferred().resolve();
172 return $.Deferred().resolve();
176 function ( errorMsg
) {
177 booklet
.getPage( 'upload' ).$element
.msg( errorMsg
);
178 return $.Deferred().resolve();
184 * Create a new upload model
187 * @return {mw.Upload} Upload model
189 mw
.Upload
.BookletLayout
.prototype.createUpload = function () {
190 return new mw
.Upload();
196 * Uploads the file that was added in the upload form. Uses
197 * {@link #getFile getFile} to get the HTML5
201 * @fires fileUploaded
202 * @return {jQuery.Promise}
204 mw
.Upload
.BookletLayout
.prototype.uploadFile = function () {
205 var deferred
= $.Deferred(),
207 file
= this.getFile();
209 this.setFilename( file
.name
);
211 this.setPage( 'info' );
213 if ( this.shouldRecordBucket
) {
214 this.upload
.bucket
= this.bucket
;
217 this.upload
.setFile( file
);
218 // The original file name might contain invalid characters, so use our sanitized one
219 this.upload
.setFilename( this.getFilename() );
221 this.uploadPromise
= this.upload
.uploadToStash();
222 this.uploadPromise
.then( function () {
224 layout
.emit( 'fileUploaded' );
226 // These errors will be thrown while the user is on the info page.
227 // Pretty sure it's impossible to get a warning other than 'stashfailed' here, which should
228 // really be an error...
229 var errorMessage
= layout
.getErrorMessageForStateDetails();
230 deferred
.reject( errorMessage
);
233 // If there is an error in uploading, come back to the upload page
234 deferred
.fail( function () {
235 layout
.setPage( 'upload' );
242 * Saves the stash finalizes upload. Uses
243 * {@link #getFilename getFilename}, and
244 * {@link #getText getText} to get details from
249 * @return {jQuery.Promise} Rejects the promise with an
250 * {@link OO.ui.Error error}, or resolves if the upload was successful.
252 mw
.Upload
.BookletLayout
.prototype.saveFile = function () {
254 deferred
= $.Deferred();
256 this.upload
.setFilename( this.getFilename() );
257 this.upload
.setText( this.getText() );
259 this.uploadPromise
.then( function () {
260 layout
.upload
.finishStashUpload().then( function () {
263 // Normalize page name and localise the 'File:' prefix
264 name
= new mw
.Title( 'File:' + layout
.upload
.getFilename() ).toString();
265 layout
.filenameUsageWidget
.setValue( '[[' + name
+ ']]' );
266 layout
.setPage( 'insert' );
269 layout
.emit( 'fileSaved', layout
.upload
.getImageInfo() );
271 var errorMessage
= layout
.getErrorMessageForStateDetails();
272 deferred
.reject( errorMessage
);
276 return deferred
.promise();
280 * Get an error message (as OO.ui.Error object) that should be displayed to the user for current
281 * state and state details.
284 * @return {OO.ui.Error} Error to display for given state and details.
286 mw
.Upload
.BookletLayout
.prototype.getErrorMessageForStateDetails = function () {
288 state
= this.upload
.getState(),
289 stateDetails
= this.upload
.getStateDetails(),
290 error
= stateDetails
.error
,
291 warnings
= stateDetails
.upload
&& stateDetails
.upload
.warnings
;
293 if ( state
=== mw
.Upload
.State
.ERROR
) {
295 // If there's an 'exception' key, this might be a timeout, or other connection problem
296 return new OO
.ui
.Error(
297 $( '<p>' ).msg( 'api-error-unknownerror', JSON
.stringify( stateDetails
) ),
298 { recoverable
: false }
302 // HACK We should either have a hook here to allow TitleBlacklist to handle this, or just have
303 // TitleBlacklist produce sane error messages that can be displayed without arcane knowledge
304 if ( error
.info
=== 'TitleBlacklist prevents this title from being created' ) {
305 // HACK Apparently the only reliable way to determine whether TitleBlacklist was involved
306 return new OO
.ui
.Error(
307 // HACK TitleBlacklist doesn't have a sensible message, this one is from UploadWizard
308 $( '<p>' ).msg( 'api-error-blacklisted' ),
309 { recoverable
: false }
313 message
= mw
.message( 'api-error-' + error
.code
);
314 if ( !message
.exists() ) {
315 message
= mw
.message( 'api-error-unknownerror', JSON
.stringify( stateDetails
) );
317 return new OO
.ui
.Error(
318 $( '<p>' ).append( message
.parseDom() ),
319 { recoverable
: false }
323 if ( state
=== mw
.Upload
.State
.WARNING
) {
324 // We could get more than one of these errors, these are in order
325 // of importance. For example fixing the thumbnail like file name
326 // won't help the fact that the file already exists.
327 if ( warnings
.stashfailed
!== undefined ) {
328 return new OO
.ui
.Error(
329 $( '<p>' ).msg( 'api-error-stashfailed' ),
330 { recoverable
: false }
332 } else if ( warnings
.exists
!== undefined ) {
333 return new OO
.ui
.Error(
334 $( '<p>' ).msg( 'fileexists', 'File:' + warnings
.exists
),
335 { recoverable
: false }
337 } else if ( warnings
[ 'page-exists' ] !== undefined ) {
338 return new OO
.ui
.Error(
339 $( '<p>' ).msg( 'filepageexists', 'File:' + warnings
[ 'page-exists' ] ),
340 { recoverable
: false }
342 } else if ( warnings
.duplicate
!== undefined ) {
343 return new OO
.ui
.Error(
344 $( '<p>' ).msg( 'api-error-duplicate', warnings
.duplicate
.length
),
345 { recoverable
: false }
347 } else if ( warnings
[ 'thumb-name' ] !== undefined ) {
348 return new OO
.ui
.Error(
349 $( '<p>' ).msg( 'filename-thumb-name' ),
350 { recoverable
: false }
352 } else if ( warnings
[ 'bad-prefix' ] !== undefined ) {
353 return new OO
.ui
.Error(
354 $( '<p>' ).msg( 'filename-bad-prefix', warnings
[ 'bad-prefix' ] ),
355 { recoverable
: false }
357 } else if ( warnings
[ 'duplicate-archive' ] !== undefined ) {
358 return new OO
.ui
.Error(
359 $( '<p>' ).msg( 'api-error-duplicate-archive', 1 ),
360 { recoverable
: false }
362 } else if ( warnings
.badfilename
!== undefined ) {
363 // Change the name if the current name isn't acceptable
364 // TODO This might not really be the best place to do this
365 this.setFilename( warnings
.badfilename
);
366 return new OO
.ui
.Error(
367 $( '<p>' ).msg( 'badfilename', warnings
.badfilename
)
370 return new OO
.ui
.Error(
371 // Let's get all the help we can if we can't pin point the error
372 $( '<p>' ).msg( 'api-error-unknown-warning', JSON
.stringify( stateDetails
) ),
373 { recoverable
: false }
382 * Renders and returns the upload form and sets the
383 * {@link #uploadForm uploadForm} property.
387 * @return {OO.ui.FormLayout}
389 mw
.Upload
.BookletLayout
.prototype.renderUploadForm = function () {
392 this.selectFileWidget
= new OO
.ui
.SelectFileWidget();
393 fieldset
= new OO
.ui
.FieldsetLayout( { label
: mw
.msg( 'upload-form-label-select-file' ) } );
394 fieldset
.addItems( [ this.selectFileWidget
] );
395 this.uploadForm
= new OO
.ui
.FormLayout( { items
: [ fieldset
] } );
398 this.selectFileWidget
.on( 'change', this.onUploadFormChange
.bind( this ) );
400 return this.uploadForm
;
404 * Handle change events to the upload form
409 mw
.Upload
.BookletLayout
.prototype.onUploadFormChange = function () {
410 this.emit( 'uploadValid', !!this.selectFileWidget
.getValue() );
414 * Renders and returns the information form for collecting
415 * metadata and sets the {@link #infoForm infoForm}
419 * @return {OO.ui.FormLayout}
421 mw
.Upload
.BookletLayout
.prototype.renderInfoForm = function () {
424 this.filenameWidget
= new OO
.ui
.TextInputWidget( {
425 indicator
: 'required',
429 this.descriptionWidget
= new OO
.ui
.TextInputWidget( {
430 indicator
: 'required',
437 fieldset
= new OO
.ui
.FieldsetLayout( {
438 label
: mw
.msg( 'upload-form-label-infoform-title' )
441 new OO
.ui
.FieldLayout( this.filenameWidget
, {
442 label
: mw
.msg( 'upload-form-label-infoform-name' ),
444 help
: mw
.msg( 'upload-form-label-infoform-name-tooltip' )
446 new OO
.ui
.FieldLayout( this.descriptionWidget
, {
447 label
: mw
.msg( 'upload-form-label-infoform-description' ),
449 help
: mw
.msg( 'upload-form-label-infoform-description-tooltip' )
452 this.infoForm
= new OO
.ui
.FormLayout( { items
: [ fieldset
] } );
454 this.filenameWidget
.on( 'change', this.onInfoFormChange
.bind( this ) );
455 this.descriptionWidget
.on( 'change', this.onInfoFormChange
.bind( this ) );
457 return this.infoForm
;
461 * Handle change events to the info form
466 mw
.Upload
.BookletLayout
.prototype.onInfoFormChange = function () {
469 this.filenameWidget
.getValidity(),
470 this.descriptionWidget
.getValidity()
471 ).done( function () {
472 layout
.emit( 'infoValid', true );
473 } ).fail( function () {
474 layout
.emit( 'infoValid', false );
479 * Renders and returns the insert form to show file usage and
480 * sets the {@link #insertForm insertForm} property.
483 * @return {OO.ui.FormLayout}
485 mw
.Upload
.BookletLayout
.prototype.renderInsertForm = function () {
488 this.filenameUsageWidget
= new OO
.ui
.TextInputWidget();
489 fieldset
= new OO
.ui
.FieldsetLayout( {
490 label
: mw
.msg( 'upload-form-label-usage-title' )
493 new OO
.ui
.FieldLayout( this.filenameUsageWidget
, {
494 label
: mw
.msg( 'upload-form-label-usage-filename' ),
498 this.insertForm
= new OO
.ui
.FormLayout( { items
: [ fieldset
] } );
500 return this.insertForm
;
506 * Gets the file object from the
507 * {@link #uploadForm upload form}.
510 * @return {File|null}
512 mw
.Upload
.BookletLayout
.prototype.getFile = function () {
513 return this.selectFileWidget
.getValue();
517 * Gets the file name from the
518 * {@link #infoForm information form}.
523 mw
.Upload
.BookletLayout
.prototype.getFilename = function () {
524 var filename
= this.filenameWidget
.getValue();
525 if ( this.filenameExtension
) {
526 filename
+= '.' + this.filenameExtension
;
532 * Prefills the {@link #infoForm information form} with the given filename.
535 * @param {string} filename
537 mw
.Upload
.BookletLayout
.prototype.setFilename = function ( filename
) {
538 var title
= mw
.Title
.newFromFileName( filename
);
541 this.filenameWidget
.setValue( title
.getNameText() );
542 this.filenameExtension
= mw
.Title
.normalizeExtension( title
.getExtension() );
544 // Seems to happen for files with no extension, which should fail some checks anyway...
545 this.filenameWidget
.setValue( filename
);
546 this.filenameExtension
= null;
551 * Gets the page text from the
552 * {@link #infoForm information form}.
557 mw
.Upload
.BookletLayout
.prototype.getText = function () {
558 return this.descriptionWidget
.getValue();
564 * Sets the file object
567 * @param {File|null} file File to select
569 mw
.Upload
.BookletLayout
.prototype.setFile = function ( file
) {
570 this.selectFileWidget
.setValue( file
);
574 * Clear the values of all fields
578 mw
.Upload
.BookletLayout
.prototype.clear = function () {
579 this.selectFileWidget
.setValue( null );
580 this.filenameWidget
.setValue( null ).setValidityFlag( true );
581 this.descriptionWidget
.setValue( null ).setValidityFlag( true );
582 this.filenameUsageWidget
.setValue( null );
585 }( jQuery
, mediaWiki
) );