2 ( function ( $, mw
, moment
) {
5 * mw.Upload.BookletLayout encapsulates the process of uploading a file
6 * to MediaWiki using the {@link mw.Upload upload model}.
7 * The booklet emits events that can be used to get the stashed
8 * upload and the final file. It can be extended to accept
9 * additional fields from the user for specific scenarios like
10 * for Commons, or campaigns.
14 * The {@link OO.ui.BookletLayout booklet layout} has three steps:
16 * - **Upload**: Has a {@link OO.ui.SelectFileWidget field} to get the file object.
18 * - **Information**: Has a {@link OO.ui.FormLayout form} to collect metadata. This can be
21 * - **Insert**: Has details on how to use the file that was uploaded.
23 * Each step has a form associated with it defined in
24 * {@link #renderUploadForm renderUploadForm},
25 * {@link #renderInfoForm renderInfoForm}, and
26 * {@link #renderInsertForm renderInfoForm}. The
27 * {@link #getFile getFile},
28 * {@link #getFilename getFilename}, and
29 * {@link #getText getText} methods are used to get
30 * the information filled in these forms, required to call
31 * {@link mw.Upload mw.Upload}.
35 * See the {@link mw.Upload.Dialog upload dialog}.
37 * The {@link #event-fileUploaded fileUploaded},
38 * and {@link #event-fileSaved fileSaved} events can
39 * be used to get details of the upload.
43 * To extend using {@link mw.Upload mw.Upload}, override
44 * {@link #renderInfoForm renderInfoForm} to render
45 * the form required for the specific use-case. Update the
46 * {@link #getFilename getFilename}, and
47 * {@link #getText getText} methods to return data
48 * from your newly created form. If you added new fields you'll also have
49 * to update the {@link #clear} method.
51 * If you plan to use a different upload model, apart from what is mentioned
52 * above, you'll also have to override the
53 * {@link #createUpload createUpload} method to
54 * return the new model. The {@link #saveFile saveFile}, and
55 * the {@link #uploadFile uploadFile} methods need to be
56 * overridden to use the new model and data returned from the forms.
59 * @extends OO.ui.BookletLayout
62 * @param {Object} config Configuration options
63 * @cfg {jQuery} [$overlay] Overlay to use for widgets in the booklet
64 * @cfg {string} [filekey] Sets the stashed file to finish uploading. Overrides most of the file selection process, and fetches a thumbnail from the server.
66 mw
.Upload
.BookletLayout = function ( config
) {
68 mw
.Upload
.BookletLayout
.parent
.call( this, config
);
70 this.$overlay
= config
.$overlay
;
72 this.filekey
= config
.filekey
;
74 this.renderUploadForm();
75 this.renderInfoForm();
76 this.renderInsertForm();
79 new OO
.ui
.PageLayout( 'upload', {
82 content
: [ this.uploadForm
]
84 new OO
.ui
.PageLayout( 'info', {
87 content
: [ this.infoForm
]
89 new OO
.ui
.PageLayout( 'insert', {
92 content
: [ this.insertForm
]
99 OO
.inheritClass( mw
.Upload
.BookletLayout
, OO
.ui
.BookletLayout
);
104 * Progress events for the uploaded file
106 * @event fileUploadProgress
107 * @param {number} progress In percentage
108 * @param {Object} duration Duration object from `moment.duration()`
112 * The file has finished uploading
114 * @event fileUploaded
118 * The file has been saved to the database
121 * @param {Object} imageInfo See mw.Upload#getImageInfo
125 * The upload form has changed
128 * @param {boolean} isValid The form is valid
132 * The info form has changed
135 * @param {boolean} isValid The form is valid
141 * @property {OO.ui.FormLayout} uploadForm
142 * The form rendered in the first step to get the file object.
143 * Rendered in {@link #renderUploadForm renderUploadForm}.
147 * @property {OO.ui.FormLayout} infoForm
148 * The form rendered in the second step to get metadata.
149 * Rendered in {@link #renderInfoForm renderInfoForm}
153 * @property {OO.ui.FormLayout} insertForm
154 * The form rendered in the third step to show usage
155 * Rendered in {@link #renderInsertForm renderInsertForm}
161 * Initialize for a new upload
163 * @return {jQuery.Promise} Promise resolved when everything is initialized
165 mw
.Upload
.BookletLayout
.prototype.initialize = function () {
169 this.upload
= this.createUpload();
171 this.setPage( 'upload' );
173 if ( this.filekey
) {
174 this.setFilekey( this.filekey
);
177 return this.upload
.getApi().then(
179 // If the user can't upload anything, don't give them the option to.
180 return api
.getUserInfo().then(
181 function ( userInfo
) {
182 if ( userInfo
.rights
.indexOf( 'upload' ) === -1 ) {
183 if ( mw
.user
.isAnon() ) {
184 booklet
.getPage( 'upload' ).$element
.msg( 'apierror-mustbeloggedin', mw
.msg( 'action-upload' ) );
186 booklet
.getPage( 'upload' ).$element
.msg( 'apierror-permissiondenied', mw
.msg( 'action-upload' ) );
189 return $.Deferred().resolve();
191 // Always resolve, never reject
192 function () { return $.Deferred().resolve(); }
195 function ( errorMsg
) {
196 booklet
.getPage( 'upload' ).$element
.msg( errorMsg
);
197 return $.Deferred().resolve();
203 * Create a new upload model
206 * @return {mw.Upload} Upload model
208 mw
.Upload
.BookletLayout
.prototype.createUpload = function () {
209 return new mw
.Upload( {
212 errorlang
: mw
.config
.get( 'wgUserLanguage' ),
222 * Uploads the file that was added in the upload form. Uses
223 * {@link #getFile getFile} to get the HTML5
227 * @fires fileUploadProgress
228 * @fires fileUploaded
229 * @return {jQuery.Promise}
231 mw
.Upload
.BookletLayout
.prototype.uploadFile = function () {
232 var deferred
= $.Deferred(),
233 startTime
= mw
.now(),
235 file
= this.getFile();
237 this.setPage( 'info' );
239 if ( this.filekey
) {
240 if ( file
=== null ) {
241 // Someone gonna get-a hurt real bad
242 throw new Error( 'filekey not passed into file select widget, which is impossible. Quitting while we\'re behind.' );
245 // Stashed file already uploaded.
247 this.uploadPromise
= deferred
;
248 this.emit( 'fileUploaded' );
252 this.setFilename( file
.name
);
254 this.upload
.setFile( file
);
255 // The original file name might contain invalid characters, so use our sanitized one
256 this.upload
.setFilename( this.getFilename() );
258 this.uploadPromise
= this.upload
.uploadToStash();
259 this.uploadPromise
.then( function () {
261 layout
.emit( 'fileUploaded' );
263 // These errors will be thrown while the user is on the info page.
264 layout
.getErrorMessageForStateDetails().then( function ( errorMessage
) {
265 deferred
.reject( errorMessage
);
267 }, function ( progress
) {
268 var elapsedTime
= mw
.now() - startTime
,
269 estimatedTotalTime
= ( 1 / progress
) * elapsedTime
,
270 estimatedRemainingTime
= moment
.duration( estimatedTotalTime
- elapsedTime
);
271 layout
.emit( 'fileUploadProgress', progress
, estimatedRemainingTime
);
274 // If there is an error in uploading, come back to the upload page
275 deferred
.fail( function () {
276 layout
.setPage( 'upload' );
283 * Saves the stash finalizes upload. Uses
284 * {@link #getFilename getFilename}, and
285 * {@link #getText getText} to get details from
290 * @return {jQuery.Promise} Rejects the promise with an
291 * {@link OO.ui.Error error}, or resolves if the upload was successful.
293 mw
.Upload
.BookletLayout
.prototype.saveFile = function () {
295 deferred
= $.Deferred();
297 this.upload
.setFilename( this.getFilename() );
298 this.upload
.setText( this.getText() );
300 this.uploadPromise
.then( function () {
301 layout
.upload
.finishStashUpload().then( function () {
304 // Normalize page name and localise the 'File:' prefix
305 name
= new mw
.Title( 'File:' + layout
.upload
.getFilename() ).toString();
306 layout
.filenameUsageWidget
.setValue( '[[' + name
+ ']]' );
307 layout
.setPage( 'insert' );
310 layout
.emit( 'fileSaved', layout
.upload
.getImageInfo() );
312 layout
.getErrorMessageForStateDetails().then( function ( errorMessage
) {
313 deferred
.reject( errorMessage
);
318 return deferred
.promise();
322 * Get an error message (as OO.ui.Error object) that should be displayed to the user for current
323 * state and state details.
326 * @return {jQuery.Promise} A Promise that will be resolved with an OO.ui.Error.
328 mw
.Upload
.BookletLayout
.prototype.getErrorMessageForStateDetails = function () {
329 var state
= this.upload
.getState(),
330 stateDetails
= this.upload
.getStateDetails(),
331 error
= stateDetails
.errors
? stateDetails
.errors
[ 0 ] : false,
332 warnings
= stateDetails
.upload
&& stateDetails
.upload
.warnings
,
336 if ( state
=== mw
.Upload
.State
.ERROR
) {
338 if ( stateDetails
.textStatus
=== 'timeout' ) {
339 // in case of $.ajax.fail(), there is no response json
340 errorText
= mw
.message( 'apierror-timeout' ).parse();
341 } else if ( stateDetails
.xhr
&& stateDetails
.xhr
.status
=== 0 ) {
342 // failed to even connect to server
343 errorText
= mw
.message( 'apierror-offline' ).parse();
344 } else if ( stateDetails
.textStatus
) {
345 errorText
= stateDetails
.textStatus
;
347 errorText
= mw
.message( 'apierror-unknownerror', JSON
.stringify( stateDetails
) ).parse();
350 // If there's an 'exception' key, this might be a timeout, or other connection problem
351 return $.Deferred().resolve( new OO
.ui
.Error(
352 $( '<p>' ).html( errorText
),
353 { recoverable
: false }
357 return $.Deferred().resolve( new OO
.ui
.Error(
358 $( '<p>' ).html( error
.html
),
359 { recoverable
: false }
363 if ( state
=== mw
.Upload
.State
.WARNING
) {
364 // We could get more than one of these errors, these are in order
365 // of importance. For example fixing the thumbnail like file name
366 // won't help the fact that the file already exists.
367 if ( warnings
.exists
!== undefined ) {
368 return $.Deferred().resolve( new OO
.ui
.Error(
369 $( '<p>' ).msg( 'fileexists', 'File:' + warnings
.exists
),
370 { recoverable
: false }
372 } else if ( warnings
[ 'exists-normalized' ] !== undefined ) {
373 return $.Deferred().resolve( new OO
.ui
.Error(
374 $( '<p>' ).msg( 'fileexists', 'File:' + warnings
[ 'exists-normalized' ] ),
375 { recoverable
: false }
377 } else if ( warnings
[ 'page-exists' ] !== undefined ) {
378 return $.Deferred().resolve( new OO
.ui
.Error(
379 $( '<p>' ).msg( 'filepageexists', 'File:' + warnings
[ 'page-exists' ] ),
380 { recoverable
: false }
382 } else if ( Array
.isArray( warnings
.duplicate
) ) {
383 warnings
.duplicate
.forEach( function ( filename
) {
384 var $a
= $( '<a>' ).text( filename
),
385 href
= mw
.Title
.makeTitle( mw
.config
.get( 'wgNamespaceIds' ).file
, filename
).getUrl( {} );
387 $a
.attr( { href
: href
, target
: '_blank' } );
388 $ul
.append( $( '<li>' ).append( $a
) );
391 return $.Deferred().resolve( new OO
.ui
.Error(
392 $( '<p>' ).msg( 'file-exists-duplicate', warnings
.duplicate
.length
).append( $ul
),
393 { recoverable
: false }
395 } else if ( warnings
[ 'thumb-name' ] !== undefined ) {
396 return $.Deferred().resolve( new OO
.ui
.Error(
397 $( '<p>' ).msg( 'filename-thumb-name' ),
398 { recoverable
: false }
400 } else if ( warnings
[ 'bad-prefix' ] !== undefined ) {
401 return $.Deferred().resolve( new OO
.ui
.Error(
402 $( '<p>' ).msg( 'filename-bad-prefix', warnings
[ 'bad-prefix' ] ),
403 { recoverable
: false }
405 } else if ( warnings
[ 'duplicate-archive' ] !== undefined ) {
406 return $.Deferred().resolve( new OO
.ui
.Error(
407 $( '<p>' ).msg( 'file-deleted-duplicate', 'File:' + warnings
[ 'duplicate-archive' ] ),
408 { recoverable
: false }
410 } else if ( warnings
[ 'was-deleted' ] !== undefined ) {
411 return $.Deferred().resolve( new OO
.ui
.Error(
412 $( '<p>' ).msg( 'filewasdeleted', 'File:' + warnings
[ 'was-deleted' ] ),
413 { recoverable
: false }
415 } else if ( warnings
.badfilename
!== undefined ) {
416 // Change the name if the current name isn't acceptable
417 // TODO This might not really be the best place to do this
418 this.setFilename( warnings
.badfilename
);
419 return $.Deferred().resolve( new OO
.ui
.Error(
420 $( '<p>' ).msg( 'badfilename', warnings
.badfilename
)
423 return $.Deferred().resolve( new OO
.ui
.Error(
424 // Let's get all the help we can if we can't pin point the error
425 $( '<p>' ).msg( 'api-error-unknown-warning', JSON
.stringify( stateDetails
) ),
426 { recoverable
: false }
435 * Renders and returns the upload form and sets the
436 * {@link #uploadForm uploadForm} property.
440 * @return {OO.ui.FormLayout}
442 mw
.Upload
.BookletLayout
.prototype.renderUploadForm = function () {
446 this.selectFileWidget
= this.getFileWidget();
447 fieldset
= new OO
.ui
.FieldsetLayout();
448 fieldset
.addItems( [ this.selectFileWidget
] );
449 this.uploadForm
= new OO
.ui
.FormLayout( { items
: [ fieldset
] } );
451 // Validation (if the SFW is for a stashed file, this never fires)
452 this.selectFileWidget
.on( 'change', this.onUploadFormChange
.bind( this ) );
454 this.selectFileWidget
.on( 'change', function () {
455 layout
.updateFilePreview();
458 return this.uploadForm
;
462 * Gets the widget for displaying or inputting the file to upload.
464 * @return {OO.ui.SelectFileWidget|mw.widgets.StashedFileWidget}
466 mw
.Upload
.BookletLayout
.prototype.getFileWidget = function () {
467 if ( this.filekey
) {
468 return new mw
.widgets
.StashedFileWidget( {
469 filekey
: this.filekey
473 return new OO
.ui
.SelectFileWidget( {
479 * Updates the file preview on the info form when a file is added.
483 mw
.Upload
.BookletLayout
.prototype.updateFilePreview = function () {
484 this.selectFileWidget
.loadAndGetImageUrl().done( function ( url
) {
485 this.filePreview
.$element
.find( 'p' ).remove();
486 this.filePreview
.$element
.css( 'background-image', 'url(' + url
+ ')' );
487 this.infoForm
.$element
.addClass( 'mw-upload-bookletLayout-hasThumbnail' );
488 }.bind( this ) ).fail( function () {
489 this.filePreview
.$element
.find( 'p' ).remove();
490 if ( this.selectFileWidget
.getValue() ) {
491 this.filePreview
.$element
.append(
492 $( '<p>' ).text( this.selectFileWidget
.getValue().name
)
495 this.filePreview
.$element
.css( 'background-image', '' );
496 this.infoForm
.$element
.removeClass( 'mw-upload-bookletLayout-hasThumbnail' );
501 * Handle change events to the upload form
506 mw
.Upload
.BookletLayout
.prototype.onUploadFormChange = function () {
507 this.emit( 'uploadValid', !!this.selectFileWidget
.getValue() );
511 * Renders and returns the information form for collecting
512 * metadata and sets the {@link #infoForm infoForm}
516 * @return {OO.ui.FormLayout}
518 mw
.Upload
.BookletLayout
.prototype.renderInfoForm = function () {
521 this.filePreview
= new OO
.ui
.Widget( {
522 classes
: [ 'mw-upload-bookletLayout-filePreview' ]
524 this.progressBarWidget
= new OO
.ui
.ProgressBarWidget( {
527 this.filePreview
.$element
.append( this.progressBarWidget
.$element
);
529 this.filenameWidget
= new OO
.ui
.TextInputWidget( {
530 indicator
: 'required',
534 this.descriptionWidget
= new OO
.ui
.MultilineTextInputWidget( {
535 indicator
: 'required',
541 fieldset
= new OO
.ui
.FieldsetLayout( {
542 label
: mw
.msg( 'upload-form-label-infoform-title' )
545 new OO
.ui
.FieldLayout( this.filenameWidget
, {
546 label
: mw
.msg( 'upload-form-label-infoform-name' ),
548 help
: mw
.msg( 'upload-form-label-infoform-name-tooltip' )
550 new OO
.ui
.FieldLayout( this.descriptionWidget
, {
551 label
: mw
.msg( 'upload-form-label-infoform-description' ),
553 help
: mw
.msg( 'upload-form-label-infoform-description-tooltip' )
556 this.infoForm
= new OO
.ui
.FormLayout( {
557 classes
: [ 'mw-upload-bookletLayout-infoForm' ],
558 items
: [ this.filePreview
, fieldset
]
561 this.on( 'fileUploadProgress', function ( progress
) {
562 this.progressBarWidget
.setProgress( progress
* 100 );
565 this.filenameWidget
.on( 'change', this.onInfoFormChange
.bind( this ) );
566 this.descriptionWidget
.on( 'change', this.onInfoFormChange
.bind( this ) );
568 return this.infoForm
;
572 * Handle change events to the info form
577 mw
.Upload
.BookletLayout
.prototype.onInfoFormChange = function () {
580 this.filenameWidget
.getValidity(),
581 this.descriptionWidget
.getValidity()
582 ).done( function () {
583 layout
.emit( 'infoValid', true );
584 } ).fail( function () {
585 layout
.emit( 'infoValid', false );
590 * Renders and returns the insert form to show file usage and
591 * sets the {@link #insertForm insertForm} property.
594 * @return {OO.ui.FormLayout}
596 mw
.Upload
.BookletLayout
.prototype.renderInsertForm = function () {
599 this.filenameUsageWidget
= new OO
.ui
.TextInputWidget();
600 fieldset
= new OO
.ui
.FieldsetLayout( {
601 label
: mw
.msg( 'upload-form-label-usage-title' )
604 new OO
.ui
.FieldLayout( this.filenameUsageWidget
, {
605 label
: mw
.msg( 'upload-form-label-usage-filename' ),
609 this.insertForm
= new OO
.ui
.FormLayout( { items
: [ fieldset
] } );
611 return this.insertForm
;
617 * Gets the file object from the
618 * {@link #uploadForm upload form}.
621 * @return {File|null}
623 mw
.Upload
.BookletLayout
.prototype.getFile = function () {
624 return this.selectFileWidget
.getValue();
628 * Gets the file name from the
629 * {@link #infoForm information form}.
634 mw
.Upload
.BookletLayout
.prototype.getFilename = function () {
635 var filename
= this.filenameWidget
.getValue();
636 if ( this.filenameExtension
) {
637 filename
+= '.' + this.filenameExtension
;
643 * Prefills the {@link #infoForm information form} with the given filename.
646 * @param {string} filename
648 mw
.Upload
.BookletLayout
.prototype.setFilename = function ( filename
) {
649 var title
= mw
.Title
.newFromFileName( filename
);
652 this.filenameWidget
.setValue( title
.getNameText() );
653 this.filenameExtension
= mw
.Title
.normalizeExtension( title
.getExtension() );
655 // Seems to happen for files with no extension, which should fail some checks anyway...
656 this.filenameWidget
.setValue( filename
);
657 this.filenameExtension
= null;
662 * Gets the page text from the
663 * {@link #infoForm information form}.
668 mw
.Upload
.BookletLayout
.prototype.getText = function () {
669 return this.descriptionWidget
.getValue();
675 * Sets the file object
678 * @param {File|null} file File to select
680 mw
.Upload
.BookletLayout
.prototype.setFile = function ( file
) {
681 this.selectFileWidget
.setValue( file
);
685 * Sets the filekey of a file already stashed on the server
686 * as the target of this upload operation.
689 * @param {string} filekey
691 mw
.Upload
.BookletLayout
.prototype.setFilekey = function ( filekey
) {
692 this.upload
.setFilekey( this.filekey
);
693 this.selectFileWidget
.setValue( filekey
);
695 this.onUploadFormChange();
699 * Clear the values of all fields
703 mw
.Upload
.BookletLayout
.prototype.clear = function () {
704 this.selectFileWidget
.setValue( null );
705 this.progressBarWidget
.setProgress( 0 );
706 this.filenameWidget
.setValue( null ).setValidityFlag( true );
707 this.descriptionWidget
.setValue( null ).setValidityFlag( true );
708 this.filenameUsageWidget
.setValue( null );
711 }( jQuery
, mediaWiki
, moment
) );