resources/src/mediawiki/mediawiki.Upload.BookletLayout.js

   1 ( function ( $, mw ) {
   2
   3         /**
   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.
  10          *
  11          * ## Structure
  12          *
  13          * The {@link OO.ui.BookletLayout booklet layout} has three steps:
  14          *
  15          *  - **Upload**: Has a {@link OO.ui.SelectFileWidget field} to get the file object.
  16          *
  17          * - **Information**: Has a {@link OO.ui.FormLayout form} to collect metadata. This can be
  18          *   extended.
  19          *
  20          * - **Insert**: Has details on how to use the file that was uploaded.
  21          *
  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}.
  31          *
  32          * ## Usage
  33          *
  34          * See the {@link mw.Upload.Dialog upload dialog}.
  35          *
  36          * The {@link #event-fileUploaded fileUploaded},
  37          * and {@link #event-fileSaved fileSaved} events can
  38          * be used to get details of the upload.
  39          *
  40          * ## Extending
  41          *
  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.
  49          *
  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.
  56          *
  57          * @class
  58          * @extends OO.ui.BookletLayout
  59          *
  60          * @constructor
  61          * @param {Object} config Configuration options
  62          * @cfg {jQuery} [$overlay] Overlay to use for widgets in the booklet
  63          */
  64         mw.Upload.BookletLayout = function ( config ) {
  65                 // Parent constructor
  66                 mw.Upload.BookletLayout.parent.call( this, config );
  67
  68                 this.$overlay = config.$overlay;
  69
  70                 this.renderUploadForm();
  71                 this.renderInfoForm();
  72                 this.renderInsertForm();
  73
  74                 this.addPages( [
  75                         new OO.ui.PageLayout( 'upload', {
  76                                 scrollable: true,
  77                                 padded: true,
  78                                 content: [ this.uploadForm ]
  79                         } ),
  80                         new OO.ui.PageLayout( 'info', {
  81                                 scrollable: true,
  82                                 padded: true,
  83                                 content: [ this.infoForm ]
  84                         } ),
  85                         new OO.ui.PageLayout( 'insert', {
  86                                 scrollable: true,
  87                                 padded: true,
  88                                 content: [ this.insertForm ]
  89                         } )
  90                 ] );
  91         };
  92
  93         /* Setup */
  94
  95         OO.inheritClass( mw.Upload.BookletLayout, OO.ui.BookletLayout );
  96
  97         /* Events */
  98
  99         /**
 100          * The file has finished uploading
 101          *
 102          * @event fileUploaded
 103          */
 104
 105         /**
 106          * The file has been saved to the database
 107          *
 108          * @event fileSaved
 109          */
 110
 111         /**
 112          * The upload form has changed
 113          *
 114          * @event uploadValid
 115          * @param {boolean} isValid The form is valid
 116          */
 117
 118         /**
 119          * The info form has changed
 120          *
 121          * @event infoValid
 122          * @param {boolean} isValid The form is valid
 123          */
 124
 125         /* Properties */
 126
 127         /**
 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}.
 131          */
 132
 133         /**
 134          * @property {OO.ui.FormLayout} infoForm
 135          * The form rendered in the second step to get metadata.
 136          * Rendered in {@link #renderInfoForm renderInfoForm}
 137          */
 138
 139         /**
 140          * @property {OO.ui.FormLayout} insertForm
 141          * The form rendered in the third step to show usage
 142          * Rendered in {@link #renderInsertForm renderInsertForm}
 143          */
 144
 145         /* Methods */
 146
 147         /**
 148          * Initialize for a new upload
 149          */
 150         mw.Upload.BookletLayout.prototype.initialize = function () {
 151                 this.clear();
 152                 this.upload = this.createUpload();
 153                 this.setPage( 'upload' );
 154         };
 155
 156         /**
 157          * Create a new upload model
 158          *
 159          * @protected
 160          * @return {mw.Upload} Upload model
 161          */
 162         mw.Upload.BookletLayout.prototype.createUpload = function () {
 163                 return new mw.Upload();
 164         };
 165
 166         /* Uploading */
 167
 168         /**
 169          * Uploads the file that was added in the upload form. Uses
 170          * {@link #getFile getFile} to get the HTML5
 171          * file object.
 172          *
 173          * @protected
 174          * @fires fileUploaded
 175          * @return {jQuery.Promise}
 176          */
 177         mw.Upload.BookletLayout.prototype.uploadFile = function () {
 178                 var deferred = $.Deferred(),
 179                         layout = this,
 180                         file = this.getFile();
 181
 182                 this.filenameWidget.setValue( file.name );
 183                 this.setPage( 'info' );
 184
 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();
 188
 189                 this.uploadPromise = this.upload.uploadToStash();
 190                 this.uploadPromise.then( function () {
 191                         deferred.resolve();
 192                         layout.emit( 'fileUploaded' );
 193                 } );
 194
 195                 // These errors will be thrown while the user is on the info page
 196                 this.uploadPromise.always( function () {
 197                         if ( layout.upload.getState() === mw.Upload.State.ERROR ) {
 198                                 deferred.reject( new OO.ui.Error( mw.msg( 'upload-process-error' )  ) );
 199                                 return false;
 200                         }
 201                         if ( layout.upload.getState() === mw.Upload.State.WARNING ) {
 202                                 deferred.reject( new OO.ui.Error( mw.msg( 'upload-process-error' )  ) );
 203                                 return false;
 204                         }
 205                 } );
 206
 207                 // If there is an error in uploading, come back to the upload page
 208                 deferred.fail( function () {
 209                         layout.setPage( 'upload' );
 210                 } );
 211
 212                 return deferred;
 213         };
 214
 215         /**
 216          * Saves the stash finalizes upload. Uses
 217          * {@link #getFilename getFilename}, and
 218          * {@link #getText getText} to get details from
 219          * the form.
 220          *
 221          * @protected
 222          * @fires fileSaved
 223          * @returns {jQuery.Promise} Rejects the promise with an
 224          * {@link OO.ui.Error error}, or resolves if the upload was successful.
 225          */
 226         mw.Upload.BookletLayout.prototype.saveFile = function () {
 227                 var layout = this,
 228                         deferred = $.Deferred();
 229
 230                 this.upload.setFilename( this.getFilename() );
 231                 this.upload.setText( this.getText() );
 232
 233                 this.uploadPromise.always( function () {
 234                         layout.upload.finishStashUpload().always( function () {
 235                                 var name;
 236
 237                                 if ( layout.upload.getState() === mw.Upload.State.ERROR ) {
 238                                         deferred.reject( new OO.ui.Error( mw.msg( 'upload-process-error' ) ) );
 239                                         return false;
 240                                 }
 241
 242                                 if ( layout.upload.getState() === mw.Upload.State.WARNING ) {
 243                                         deferred.reject( new OO.ui.Error( mw.msg( 'upload-process-warning' ) ) );
 244                                         return false;
 245                                 }
 246
 247                                 // Normalize page name and localise the 'File:' prefix
 248                                 name = new mw.Title( 'File:' + layout.upload.getFilename() ).toString();
 249                                 layout.filenameUsageWidget.setValue( '[[' + name + ']]' );
 250                                 layout.setPage( 'insert' );
 251
 252                                 deferred.resolve();
 253                                 layout.emit( 'fileSaved' );
 254                         } );
 255                 } );
 256
 257                 return deferred.promise();
 258         };
 259
 260         /* Form renderers */
 261
 262         /**
 263          * Renders and returns the upload form and sets the
 264          * {@link #uploadForm uploadForm} property.
 265          *
 266          * @protected
 267          * @fires selectFile
 268          * @returns {OO.ui.FormLayout}
 269          */
 270         mw.Upload.BookletLayout.prototype.renderUploadForm = function () {
 271                 var fieldset;
 272
 273                 this.selectFileWidget = new OO.ui.SelectFileWidget();
 274                 fieldset = new OO.ui.FieldsetLayout( { label: mw.msg( 'upload-form-label-select-file' ) } );
 275                 fieldset.addItems( [ this.selectFileWidget ] );
 276                 this.uploadForm = new OO.ui.FormLayout( { items: [ fieldset ] } );
 277
 278                 // Validation
 279                 this.selectFileWidget.on( 'change', this.onUploadFormChange.bind( this ) );
 280
 281                 return this.uploadForm;
 282         };
 283
 284         /**
 285          * Handle change events to the upload form
 286          *
 287          * @protected
 288          * @fires uploadValid
 289          */
 290         mw.Upload.BookletLayout.prototype.onUploadFormChange = function () {
 291                 this.emit( 'uploadValid', !!this.selectFileWidget.getValue() );
 292         };
 293
 294         /**
 295          * Renders and returns the information form for collecting
 296          * metadata and sets the {@link #infoForm infoForm}
 297          * property.
 298          *
 299          * @protected
 300          * @returns {OO.ui.FormLayout}
 301          */
 302         mw.Upload.BookletLayout.prototype.renderInfoForm = function () {
 303                 var fieldset;
 304
 305                 this.filenameWidget = new OO.ui.TextInputWidget( {
 306                         indicator: 'required',
 307                         required: true,
 308                         validate: /.+/
 309                 } );
 310                 this.descriptionWidget = new OO.ui.TextInputWidget( {
 311                         indicator: 'required',
 312                         required: true,
 313                         validate: /.+/,
 314                         multiline: true,
 315                         autosize: true
 316                 } );
 317
 318                 fieldset = new OO.ui.FieldsetLayout( {
 319                         label: mw.msg( 'upload-form-label-infoform-title' )
 320                 } );
 321                 fieldset.addItems( [
 322                         new OO.ui.FieldLayout( this.filenameWidget, {
 323                                 label: mw.msg( 'upload-form-label-infoform-name' ),
 324                                 align: 'top'
 325                         } ),
 326                         new OO.ui.FieldLayout( this.descriptionWidget, {
 327                                 label: mw.msg( 'upload-form-label-infoform-description' ),
 328                                 align: 'top'
 329                         } )
 330                 ] );
 331                 this.infoForm = new OO.ui.FormLayout( { items: [ fieldset ] } );
 332
 333                 this.filenameWidget.on( 'change', this.onInfoFormChange.bind( this ) );
 334                 this.descriptionWidget.on( 'change', this.onInfoFormChange.bind( this ) );
 335
 336                 return this.infoForm;
 337         };
 338
 339         /**
 340          * Handle change events to the info form
 341          *
 342          * @protected
 343          * @fires infoValid
 344          */
 345         mw.Upload.BookletLayout.prototype.onInfoFormChange = function () {
 346                 var layout = this;
 347                 $.when(
 348                         this.filenameWidget.getValidity(),
 349                         this.descriptionWidget.getValidity()
 350                 ).done( function () {
 351                         layout.emit( 'infoValid', true );
 352                 } ).fail( function () {
 353                         layout.emit( 'infoValid', false );
 354                 } );
 355         };
 356
 357         /**
 358          * Renders and returns the insert form to show file usage and
 359          * sets the {@link #insertForm insertForm} property.
 360          *
 361          * @protected
 362          * @returns {OO.ui.FormLayout}
 363          */
 364         mw.Upload.BookletLayout.prototype.renderInsertForm = function () {
 365                 var fieldset;
 366
 367                 this.filenameUsageWidget = new OO.ui.TextInputWidget();
 368                 fieldset = new OO.ui.FieldsetLayout( {
 369                         label: mw.msg( 'upload-form-label-usage-title' )
 370                 } );
 371                 fieldset.addItems( [
 372                         new OO.ui.FieldLayout( this.filenameUsageWidget, {
 373                                 label: mw.msg( 'upload-form-label-usage-filename' ),
 374                                 align: 'top'
 375                         } )
 376                 ] );
 377                 this.insertForm = new OO.ui.FormLayout( { items: [ fieldset ] } );
 378
 379                 return this.insertForm;
 380         };
 381
 382         /* Getters */
 383
 384         /**
 385          * Gets the file object from the
 386          * {@link #uploadForm upload form}.
 387          *
 388          * @protected
 389          * @returns {File|null}
 390          */
 391         mw.Upload.BookletLayout.prototype.getFile = function () {
 392                 return this.selectFileWidget.getValue();
 393         };
 394
 395         /**
 396          * Gets the file name from the
 397          * {@link #infoForm information form}.
 398          *
 399          * @protected
 400          * @returns {string}
 401          */
 402         mw.Upload.BookletLayout.prototype.getFilename = function () {
 403                 return this.filenameWidget.getValue();
 404         };
 405
 406         /**
 407          * Gets the page text from the
 408          * {@link #infoForm information form}.
 409          *
 410          * @protected
 411          * @returns {string}
 412          */
 413         mw.Upload.BookletLayout.prototype.getText = function () {
 414                 return this.descriptionWidget.getValue();
 415         };
 416
 417         /* Setters */
 418
 419         /**
 420          * Clear the values of all fields
 421          *
 422          * @protected
 423          */
 424         mw.Upload.BookletLayout.prototype.clear = function () {
 425                 this.selectFileWidget.setValue( null );
 426                 this.filenameWidget.setValue( null ).setValidityFlag( true );
 427                 this.descriptionWidget.setValue( null ).setValidityFlag( true );
 428                 this.filenameUsageWidget.setValue( null );
 429         };
 430
 431 }( jQuery, mediaWiki ) );