fa2fb0b831bd15b933cb2d4f2f02cb9cb5c90312
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 this.uploadPromise
= this.upload
.uploadToStash();
187 this.uploadPromise
.then( function () {
189 layout
.emit( 'fileUploaded' );
191 this.uploadPromise
.always( function () {
192 if ( layout
.upload
.getState() === mw
.Upload
.State
.ERROR
) {
193 deferred
.reject( new OO
.ui
.Error( mw
.msg( 'upload-process-error' ) ) );
196 if ( layout
.upload
.getState() === mw
.Upload
.State
.WARNING
) {
197 deferred
.reject( new OO
.ui
.Error( mw
.msg( 'upload-process-error' ) ) );
206 * Saves the stash finalizes upload. Uses
207 * {@link #getFilename getFilename}, and
208 * {@link #getText getText} to get details from
213 * @returns {jQuery.Promise} Rejects the promise with an
214 * {@link OO.ui.Error error}, or resolves if the upload was successful.
216 mw
.Upload
.BookletLayout
.prototype.saveFile = function () {
218 deferred
= $.Deferred();
220 this.upload
.setFilename( this.getFilename() );
221 this.upload
.setText( this.getText() );
223 this.uploadPromise
.always( function () {
224 layout
.upload
.finishStashUpload().always( function () {
227 if ( layout
.upload
.getState() === mw
.Upload
.State
.ERROR
) {
228 deferred
.reject( new OO
.ui
.Error( mw
.msg( 'upload-process-error' ) ) );
232 if ( layout
.upload
.getState() === mw
.Upload
.State
.WARNING
) {
233 deferred
.reject( new OO
.ui
.Error( mw
.msg( 'upload-process-warning' ) ) );
237 // Normalize page name and localise the 'File:' prefix
238 name
= new mw
.Title( 'File:' + layout
.upload
.getFilename() ).toString();
239 layout
.filenameUsageWidget
.setValue( '[[' + name
+ ']]' );
240 layout
.setPage( 'insert' );
243 layout
.emit( 'fileSaved' );
247 return deferred
.promise();
253 * Renders and returns the upload form and sets the
254 * {@link #uploadForm uploadForm} property.
258 * @returns {OO.ui.FormLayout}
260 mw
.Upload
.BookletLayout
.prototype.renderUploadForm = function () {
263 this.selectFileWidget
= new OO
.ui
.SelectFileWidget();
264 fieldset
= new OO
.ui
.FieldsetLayout( { label
: mw
.msg( 'upload-form-label-select-file' ) } );
265 fieldset
.addItems( [ this.selectFileWidget
] );
266 this.uploadForm
= new OO
.ui
.FormLayout( { items
: [ fieldset
] } );
269 this.selectFileWidget
.on( 'change', this.onUploadFormChange
.bind( this ) );
271 return this.uploadForm
;
275 * Handle change events to the upload form
280 mw
.Upload
.BookletLayout
.prototype.onUploadFormChange = function () {
281 this.emit( 'uploadValid', !!this.selectFileWidget
.getValue() );
285 * Renders and returns the information form for collecting
286 * metadata and sets the {@link #infoForm infoForm}
290 * @returns {OO.ui.FormLayout}
292 mw
.Upload
.BookletLayout
.prototype.renderInfoForm = function () {
295 this.filenameWidget
= new OO
.ui
.TextInputWidget( {
296 indicator
: 'required',
300 this.descriptionWidget
= new OO
.ui
.TextInputWidget( {
301 indicator
: 'required',
308 fieldset
= new OO
.ui
.FieldsetLayout( {
309 label
: mw
.msg( 'upload-form-label-infoform-title' )
312 new OO
.ui
.FieldLayout( this.filenameWidget
, {
313 label
: mw
.msg( 'upload-form-label-infoform-name' ),
316 new OO
.ui
.FieldLayout( this.descriptionWidget
, {
317 label
: mw
.msg( 'upload-form-label-infoform-description' ),
321 this.infoForm
= new OO
.ui
.FormLayout( { items
: [ fieldset
] } );
323 this.filenameWidget
.on( 'change', this.onInfoFormChange
.bind( this ) );
324 this.descriptionWidget
.on( 'change', this.onInfoFormChange
.bind( this ) );
326 return this.infoForm
;
330 * Handle change events to the info form
335 mw
.Upload
.BookletLayout
.prototype.onInfoFormChange = function () {
338 this.filenameWidget
.getValidity(),
339 this.descriptionWidget
.getValidity()
340 ).done( function () {
341 layout
.emit( 'infoValid', true );
342 } ).fail( function () {
343 layout
.emit( 'infoValid', false );
348 * Renders and returns the insert form to show file usage and
349 * sets the {@link #insertForm insertForm} property.
352 * @returns {OO.ui.FormLayout}
354 mw
.Upload
.BookletLayout
.prototype.renderInsertForm = function () {
357 this.filenameUsageWidget
= new OO
.ui
.TextInputWidget();
358 fieldset
= new OO
.ui
.FieldsetLayout( {
359 label
: mw
.msg( 'upload-form-label-usage-title' )
362 new OO
.ui
.FieldLayout( this.filenameUsageWidget
, {
363 label
: mw
.msg( 'upload-form-label-usage-filename' ),
367 this.insertForm
= new OO
.ui
.FormLayout( { items
: [ fieldset
] } );
369 return this.insertForm
;
375 * Gets the file object from the
376 * {@link #uploadForm upload form}.
379 * @returns {File|null}
381 mw
.Upload
.BookletLayout
.prototype.getFile = function () {
382 return this.selectFileWidget
.getValue();
386 * Gets the file name from the
387 * {@link #infoForm information form}.
392 mw
.Upload
.BookletLayout
.prototype.getFilename = function () {
393 return this.filenameWidget
.getValue();
397 * Gets the page text from the
398 * {@link #infoForm information form}.
403 mw
.Upload
.BookletLayout
.prototype.getText = function () {
404 return this.descriptionWidget
.getValue();
410 * Clear the values of all fields
414 mw
.Upload
.BookletLayout
.prototype.clear = function () {
415 this.selectFileWidget
.setValue( null );
416 this.filenameWidget
.setValue( null ).setValidityFlag( true );
417 this.descriptionWidget
.setValue( null ).setValidityFlag( true );
418 this.filenameUsageWidget
.setValue( null );
421 }( jQuery
, mediaWiki
) );