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(
180 booklet
.upload
.loadConfig().then(
182 function ( errorMsg
) {
183 booklet
.getPage( 'upload' ).$element
.msg( errorMsg
);
184 return $.Deferred().resolve();
187 // If the user can't upload anything, don't give them the option to.
188 api
.getUserInfo().then( function ( userInfo
) {
189 if ( userInfo
.rights
.indexOf( 'upload' ) === -1 ) {
190 // TODO Use a better error message when not all logged-in users can upload
191 booklet
.getPage( 'upload' ).$element
.msg( 'api-error-mustbeloggedin' );
193 return $.Deferred().resolve();
197 // Always resolve, never reject
198 function () { return $.Deferred().resolve(); }
201 function ( errorMsg
) {
202 booklet
.getPage( 'upload' ).$element
.msg( errorMsg
);
203 return $.Deferred().resolve();
209 * Create a new upload model
212 * @return {mw.Upload} Upload model
214 mw
.Upload
.BookletLayout
.prototype.createUpload = function () {
215 return new mw
.Upload();
221 * Uploads the file that was added in the upload form. Uses
222 * {@link #getFile getFile} to get the HTML5
226 * @fires fileUploadProgress
227 * @fires fileUploaded
228 * @return {jQuery.Promise}
230 mw
.Upload
.BookletLayout
.prototype.uploadFile = function () {
231 var deferred
= $.Deferred(),
232 startTime
= new Date(),
234 file
= this.getFile();
236 this.setPage( 'info' );
238 if ( this.filekey
) {
239 if ( file
=== null ) {
240 // Someone gonna get-a hurt real bad
241 throw new Error( 'filekey not passed into file select widget, which is impossible. Quitting while we\'re behind.' );
244 // Stashed file already uploaded.
246 this.uploadPromise
= deferred
;
247 this.emit( 'fileUploaded' );
251 this.setFilename( file
.name
);
253 this.upload
.setFile( file
);
254 // The original file name might contain invalid characters, so use our sanitized one
255 this.upload
.setFilename( this.getFilename() );
257 this.uploadPromise
= this.upload
.uploadToStash();
258 this.uploadPromise
.then( function () {
260 layout
.emit( 'fileUploaded' );
262 // These errors will be thrown while the user is on the info page.
263 // Pretty sure it's impossible to get a warning other than 'stashfailed' here, which should
264 // really be an error...
265 var errorMessage
= layout
.getErrorMessageForStateDetails();
266 deferred
.reject( errorMessage
);
267 }, function ( progress
) {
268 var elapsedTime
= new Date() - 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 var errorMessage
= layout
.getErrorMessageForStateDetails();
313 deferred
.reject( errorMessage
);
317 return deferred
.promise();
321 * Get an error message (as OO.ui.Error object) that should be displayed to the user for current
322 * state and state details.
325 * @return {OO.ui.Error} Error to display for given state and details.
327 mw
.Upload
.BookletLayout
.prototype.getErrorMessageForStateDetails = function () {
329 state
= this.upload
.getState(),
330 stateDetails
= this.upload
.getStateDetails(),
331 error
= stateDetails
.error
,
332 warnings
= stateDetails
.upload
&& stateDetails
.upload
.warnings
;
334 if ( state
=== mw
.Upload
.State
.ERROR
) {
336 // If there's an 'exception' key, this might be a timeout, or other connection problem
337 return new OO
.ui
.Error(
338 $( '<p>' ).msg( 'api-error-unknownerror', JSON
.stringify( stateDetails
) ),
339 { recoverable
: false }
343 // HACK We should either have a hook here to allow TitleBlacklist to handle this, or just have
344 // TitleBlacklist produce sane error messages that can be displayed without arcane knowledge
345 if ( error
.info
=== 'TitleBlacklist prevents this title from being created' ) {
346 // HACK Apparently the only reliable way to determine whether TitleBlacklist was involved
347 return new OO
.ui
.Error(
348 // HACK TitleBlacklist doesn't have a sensible message, this one is from UploadWizard
349 $( '<p>' ).msg( 'api-error-blacklisted' ),
350 { recoverable
: false }
354 if ( error
.code
=== 'protectedpage' ) {
355 message
= mw
.message( 'protectedpagetext' );
357 message
= mw
.message( 'api-error-' + error
.code
);
358 if ( !message
.exists() ) {
359 message
= mw
.message( 'api-error-unknownerror', JSON
.stringify( stateDetails
) );
362 return new OO
.ui
.Error(
363 $( '<p>' ).append( message
.parseDom() ),
364 { recoverable
: false }
368 if ( state
=== mw
.Upload
.State
.WARNING
) {
369 // We could get more than one of these errors, these are in order
370 // of importance. For example fixing the thumbnail like file name
371 // won't help the fact that the file already exists.
372 if ( warnings
.stashfailed
!== undefined ) {
373 return new OO
.ui
.Error(
374 $( '<p>' ).msg( 'api-error-stashfailed' ),
375 { recoverable
: false }
377 } else if ( warnings
.exists
!== undefined ) {
378 return new OO
.ui
.Error(
379 $( '<p>' ).msg( 'fileexists', 'File:' + warnings
.exists
),
380 { recoverable
: false }
382 } else if ( warnings
[ 'exists-normalized' ] !== undefined ) {
383 return new OO
.ui
.Error(
384 $( '<p>' ).msg( 'fileexists', 'File:' + warnings
[ 'exists-normalized' ] ),
385 { recoverable
: false }
387 } else if ( warnings
[ 'page-exists' ] !== undefined ) {
388 return new OO
.ui
.Error(
389 $( '<p>' ).msg( 'filepageexists', 'File:' + warnings
[ 'page-exists' ] ),
390 { recoverable
: false }
392 } else if ( warnings
.duplicate
!== undefined ) {
393 return new OO
.ui
.Error(
394 $( '<p>' ).msg( 'api-error-duplicate', warnings
.duplicate
.length
),
395 { recoverable
: false }
397 } else if ( warnings
[ 'thumb-name' ] !== undefined ) {
398 return new OO
.ui
.Error(
399 $( '<p>' ).msg( 'filename-thumb-name' ),
400 { recoverable
: false }
402 } else if ( warnings
[ 'bad-prefix' ] !== undefined ) {
403 return new OO
.ui
.Error(
404 $( '<p>' ).msg( 'filename-bad-prefix', warnings
[ 'bad-prefix' ] ),
405 { recoverable
: false }
407 } else if ( warnings
[ 'duplicate-archive' ] !== undefined ) {
408 return new OO
.ui
.Error(
409 $( '<p>' ).msg( 'api-error-duplicate-archive', 1 ),
410 { recoverable
: false }
412 } else if ( warnings
[ 'was-deleted' ] !== undefined ) {
413 return new OO
.ui
.Error(
414 $( '<p>' ).msg( 'api-error-was-deleted' ),
415 { recoverable
: false }
417 } else if ( warnings
.badfilename
!== undefined ) {
418 // Change the name if the current name isn't acceptable
419 // TODO This might not really be the best place to do this
420 this.setFilename( warnings
.badfilename
);
421 return new OO
.ui
.Error(
422 $( '<p>' ).msg( 'badfilename', warnings
.badfilename
)
425 return new OO
.ui
.Error(
426 // Let's get all the help we can if we can't pin point the error
427 $( '<p>' ).msg( 'api-error-unknown-warning', JSON
.stringify( stateDetails
) ),
428 { recoverable
: false }
437 * Renders and returns the upload form and sets the
438 * {@link #uploadForm uploadForm} property.
442 * @return {OO.ui.FormLayout}
444 mw
.Upload
.BookletLayout
.prototype.renderUploadForm = function () {
448 this.selectFileWidget
= this.getFileWidget();
449 fieldset
= new OO
.ui
.FieldsetLayout();
450 fieldset
.addItems( [ this.selectFileWidget
] );
451 this.uploadForm
= new OO
.ui
.FormLayout( { items
: [ fieldset
] } );
453 // Validation (if the SFW is for a stashed file, this never fires)
454 this.selectFileWidget
.on( 'change', this.onUploadFormChange
.bind( this ) );
456 this.selectFileWidget
.on( 'change', function () {
457 layout
.updateFilePreview();
460 return this.uploadForm
;
464 * Gets the widget for displaying or inputting the file to upload.
466 * @return {OO.ui.SelectFileWidget|mw.widgets.StashedFileWidget}
468 mw
.Upload
.BookletLayout
.prototype.getFileWidget = function () {
469 if ( this.filekey
) {
470 return new mw
.widgets
.StashedFileWidget( {
471 filekey
: this.filekey
475 return new OO
.ui
.SelectFileWidget( {
481 * Updates the file preview on the info form when a file is added.
485 mw
.Upload
.BookletLayout
.prototype.updateFilePreview = function () {
486 this.selectFileWidget
.loadAndGetImageUrl().done( function ( url
) {
487 this.filePreview
.$element
.find( 'p' ).remove();
488 this.filePreview
.$element
.css( 'background-image', 'url(' + url
+ ')' );
489 this.infoForm
.$element
.addClass( 'mw-upload-bookletLayout-hasThumbnail' );
490 }.bind( this ) ).fail( function () {
491 this.filePreview
.$element
.find( 'p' ).remove();
492 if ( this.selectFileWidget
.getValue() ) {
493 this.filePreview
.$element
.append(
494 $( '<p>' ).text( this.selectFileWidget
.getValue().name
)
497 this.filePreview
.$element
.css( 'background-image', '' );
498 this.infoForm
.$element
.removeClass( 'mw-upload-bookletLayout-hasThumbnail' );
503 * Handle change events to the upload form
508 mw
.Upload
.BookletLayout
.prototype.onUploadFormChange = function () {
509 this.emit( 'uploadValid', !!this.selectFileWidget
.getValue() );
513 * Renders and returns the information form for collecting
514 * metadata and sets the {@link #infoForm infoForm}
518 * @return {OO.ui.FormLayout}
520 mw
.Upload
.BookletLayout
.prototype.renderInfoForm = function () {
523 this.filePreview
= new OO
.ui
.Widget( {
524 classes
: [ 'mw-upload-bookletLayout-filePreview' ]
526 this.progressBarWidget
= new OO
.ui
.ProgressBarWidget( {
529 this.filePreview
.$element
.append( this.progressBarWidget
.$element
);
531 this.filenameWidget
= new OO
.ui
.TextInputWidget( {
532 indicator
: 'required',
536 this.descriptionWidget
= new OO
.ui
.TextInputWidget( {
537 indicator
: 'required',
544 fieldset
= new OO
.ui
.FieldsetLayout( {
545 label
: mw
.msg( 'upload-form-label-infoform-title' )
548 new OO
.ui
.FieldLayout( this.filenameWidget
, {
549 label
: mw
.msg( 'upload-form-label-infoform-name' ),
551 help
: mw
.msg( 'upload-form-label-infoform-name-tooltip' )
553 new OO
.ui
.FieldLayout( this.descriptionWidget
, {
554 label
: mw
.msg( 'upload-form-label-infoform-description' ),
556 help
: mw
.msg( 'upload-form-label-infoform-description-tooltip' )
559 this.infoForm
= new OO
.ui
.FormLayout( {
560 classes
: [ 'mw-upload-bookletLayout-infoForm' ],
561 items
: [ this.filePreview
, fieldset
]
564 this.on( 'fileUploadProgress', function ( progress
) {
565 this.progressBarWidget
.setProgress( progress
* 100 );
568 this.filenameWidget
.on( 'change', this.onInfoFormChange
.bind( this ) );
569 this.descriptionWidget
.on( 'change', this.onInfoFormChange
.bind( this ) );
571 return this.infoForm
;
575 * Handle change events to the info form
580 mw
.Upload
.BookletLayout
.prototype.onInfoFormChange = function () {
583 this.filenameWidget
.getValidity(),
584 this.descriptionWidget
.getValidity()
585 ).done( function () {
586 layout
.emit( 'infoValid', true );
587 } ).fail( function () {
588 layout
.emit( 'infoValid', false );
593 * Renders and returns the insert form to show file usage and
594 * sets the {@link #insertForm insertForm} property.
597 * @return {OO.ui.FormLayout}
599 mw
.Upload
.BookletLayout
.prototype.renderInsertForm = function () {
602 this.filenameUsageWidget
= new OO
.ui
.TextInputWidget();
603 fieldset
= new OO
.ui
.FieldsetLayout( {
604 label
: mw
.msg( 'upload-form-label-usage-title' )
607 new OO
.ui
.FieldLayout( this.filenameUsageWidget
, {
608 label
: mw
.msg( 'upload-form-label-usage-filename' ),
612 this.insertForm
= new OO
.ui
.FormLayout( { items
: [ fieldset
] } );
614 return this.insertForm
;
620 * Gets the file object from the
621 * {@link #uploadForm upload form}.
624 * @return {File|null}
626 mw
.Upload
.BookletLayout
.prototype.getFile = function () {
627 return this.selectFileWidget
.getValue();
631 * Gets the file name from the
632 * {@link #infoForm information form}.
637 mw
.Upload
.BookletLayout
.prototype.getFilename = function () {
638 var filename
= this.filenameWidget
.getValue();
639 if ( this.filenameExtension
) {
640 filename
+= '.' + this.filenameExtension
;
646 * Prefills the {@link #infoForm information form} with the given filename.
649 * @param {string} filename
651 mw
.Upload
.BookletLayout
.prototype.setFilename = function ( filename
) {
652 var title
= mw
.Title
.newFromFileName( filename
);
655 this.filenameWidget
.setValue( title
.getNameText() );
656 this.filenameExtension
= mw
.Title
.normalizeExtension( title
.getExtension() );
658 // Seems to happen for files with no extension, which should fail some checks anyway...
659 this.filenameWidget
.setValue( filename
);
660 this.filenameExtension
= null;
665 * Gets the page text from the
666 * {@link #infoForm information form}.
671 mw
.Upload
.BookletLayout
.prototype.getText = function () {
672 return this.descriptionWidget
.getValue();
678 * Sets the file object
681 * @param {File|null} file File to select
683 mw
.Upload
.BookletLayout
.prototype.setFile = function ( file
) {
684 this.selectFileWidget
.setValue( file
);
688 * Sets the filekey of a file already stashed on the server
689 * as the target of this upload operation.
692 * @param {string} filekey
694 mw
.Upload
.BookletLayout
.prototype.setFilekey = function ( filekey
) {
695 this.upload
.setFilekey( this.filekey
);
696 this.selectFileWidget
.setValue( filekey
);
698 this.onUploadFormChange();
702 * Clear the values of all fields
706 mw
.Upload
.BookletLayout
.prototype.clear = function () {
707 this.selectFileWidget
.setValue( null );
708 this.progressBarWidget
.setProgress( 0 );
709 this.filenameWidget
.setValue( null ).setValidityFlag( true );
710 this.descriptionWidget
.setValue( null ).setValidityFlag( true );
711 this.filenameUsageWidget
.setValue( null );
714 }( jQuery
, mediaWiki
, moment
) );