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                 }, function () {
 194                         // These errors will be thrown while the user is on the info page
 195                         if ( layout.upload.getState() === mw.Upload.State.ERROR ) {
 196                                 deferred.reject( new OO.ui.Error( layout.upload.getStateDetails(), {
 197                                         recoverable: false
 198                                 } ) );
 199                                 return false;
 200                         }
 201                         if ( layout.upload.getState() === mw.Upload.State.WARNING ) {
 202                                 deferred.reject( new OO.ui.Error( layout.upload.getStateDetails(), {
 203                                         recoverable: false
 204                                 } ) );
 205                                 return false;
 206                         }
 207                 } );
 208
 209                 // If there is an error in uploading, come back to the upload page
 210                 deferred.fail( function () {
 211                         layout.setPage( 'upload' );
 212                 } );
 213
 214                 return deferred;
 215         };
 216
 217         /**
 218          * Saves the stash finalizes upload. Uses
 219          * {@link #getFilename getFilename}, and
 220          * {@link #getText getText} to get details from
 221          * the form.
 222          *
 223          * @protected
 224          * @fires fileSaved
 225          * @returns {jQuery.Promise} Rejects the promise with an
 226          * {@link OO.ui.Error error}, or resolves if the upload was successful.
 227          */
 228         mw.Upload.BookletLayout.prototype.saveFile = function () {
 229                 var layout = this,
 230                         deferred = $.Deferred();
 231
 232                 this.upload.setFilename( this.getFilename() );
 233                 this.upload.setText( this.getText() );
 234
 235                 this.uploadPromise.always( function () {
 236                         layout.upload.finishStashUpload().always( function () {
 237                                 var name;
 238
 239                                 if ( layout.upload.getState() === mw.Upload.State.ERROR ) {
 240                                         deferred.reject( new OO.ui.Error( mw.msg( 'upload-process-error' ), {
 241                                                 recoverable: false
 242                                         } ) );
 243                                         return false;
 244                                 }
 245
 246                                 if ( layout.upload.getState() === mw.Upload.State.WARNING ) {
 247                                         deferred.reject( new OO.ui.Error( mw.msg( 'upload-process-warning' ), {
 248                                                 recoverable: false
 249                                         } ) );
 250                                         return false;
 251                                 }
 252
 253                                 // Normalize page name and localise the 'File:' prefix
 254                                 name = new mw.Title( 'File:' + layout.upload.getFilename() ).toString();
 255                                 layout.filenameUsageWidget.setValue( '[[' + name + ']]' );
 256                                 layout.setPage( 'insert' );
 257
 258                                 deferred.resolve();
 259                                 layout.emit( 'fileSaved' );
 260                         } );
 261                 } );
 262
 263                 return deferred.promise();
 264         };
 265
 266         /* Form renderers */
 267
 268         /**
 269          * Renders and returns the upload form and sets the
 270          * {@link #uploadForm uploadForm} property.
 271          *
 272          * @protected
 273          * @fires selectFile
 274          * @returns {OO.ui.FormLayout}
 275          */
 276         mw.Upload.BookletLayout.prototype.renderUploadForm = function () {
 277                 var fieldset;
 278
 279                 this.selectFileWidget = new OO.ui.SelectFileWidget();
 280                 fieldset = new OO.ui.FieldsetLayout( { label: mw.msg( 'upload-form-label-select-file' ) } );
 281                 fieldset.addItems( [ this.selectFileWidget ] );
 282                 this.uploadForm = new OO.ui.FormLayout( { items: [ fieldset ] } );
 283
 284                 // Validation
 285                 this.selectFileWidget.on( 'change', this.onUploadFormChange.bind( this ) );
 286
 287                 return this.uploadForm;
 288         };
 289
 290         /**
 291          * Handle change events to the upload form
 292          *
 293          * @protected
 294          * @fires uploadValid
 295          */
 296         mw.Upload.BookletLayout.prototype.onUploadFormChange = function () {
 297                 this.emit( 'uploadValid', !!this.selectFileWidget.getValue() );
 298         };
 299
 300         /**
 301          * Renders and returns the information form for collecting
 302          * metadata and sets the {@link #infoForm infoForm}
 303          * property.
 304          *
 305          * @protected
 306          * @returns {OO.ui.FormLayout}
 307          */
 308         mw.Upload.BookletLayout.prototype.renderInfoForm = function () {
 309                 var fieldset;
 310
 311                 this.filenameWidget = new OO.ui.TextInputWidget( {
 312                         indicator: 'required',
 313                         required: true,
 314                         validate: /.+/
 315                 } );
 316                 this.descriptionWidget = new OO.ui.TextInputWidget( {
 317                         indicator: 'required',
 318                         required: true,
 319                         validate: /.+/,
 320                         multiline: true,
 321                         autosize: true
 322                 } );
 323
 324                 fieldset = new OO.ui.FieldsetLayout( {
 325                         label: mw.msg( 'upload-form-label-infoform-title' )
 326                 } );
 327                 fieldset.addItems( [
 328                         new OO.ui.FieldLayout( this.filenameWidget, {
 329                                 label: mw.msg( 'upload-form-label-infoform-name' ),
 330                                 align: 'top'
 331                         } ),
 332                         new OO.ui.FieldLayout( this.descriptionWidget, {
 333                                 label: mw.msg( 'upload-form-label-infoform-description' ),
 334                                 align: 'top'
 335                         } )
 336                 ] );
 337                 this.infoForm = new OO.ui.FormLayout( { items: [ fieldset ] } );
 338
 339                 this.filenameWidget.on( 'change', this.onInfoFormChange.bind( this ) );
 340                 this.descriptionWidget.on( 'change', this.onInfoFormChange.bind( this ) );
 341
 342                 return this.infoForm;
 343         };
 344
 345         /**
 346          * Handle change events to the info form
 347          *
 348          * @protected
 349          * @fires infoValid
 350          */
 351         mw.Upload.BookletLayout.prototype.onInfoFormChange = function () {
 352                 var layout = this;
 353                 $.when(
 354                         this.filenameWidget.getValidity(),
 355                         this.descriptionWidget.getValidity()
 356                 ).done( function () {
 357                         layout.emit( 'infoValid', true );
 358                 } ).fail( function () {
 359                         layout.emit( 'infoValid', false );
 360                 } );
 361         };
 362
 363         /**
 364          * Renders and returns the insert form to show file usage and
 365          * sets the {@link #insertForm insertForm} property.
 366          *
 367          * @protected
 368          * @returns {OO.ui.FormLayout}
 369          */
 370         mw.Upload.BookletLayout.prototype.renderInsertForm = function () {
 371                 var fieldset;
 372
 373                 this.filenameUsageWidget = new OO.ui.TextInputWidget();
 374                 fieldset = new OO.ui.FieldsetLayout( {
 375                         label: mw.msg( 'upload-form-label-usage-title' )
 376                 } );
 377                 fieldset.addItems( [
 378                         new OO.ui.FieldLayout( this.filenameUsageWidget, {
 379                                 label: mw.msg( 'upload-form-label-usage-filename' ),
 380                                 align: 'top'
 381                         } )
 382                 ] );
 383                 this.insertForm = new OO.ui.FormLayout( { items: [ fieldset ] } );
 384
 385                 return this.insertForm;
 386         };
 387
 388         /* Getters */
 389
 390         /**
 391          * Gets the file object from the
 392          * {@link #uploadForm upload form}.
 393          *
 394          * @protected
 395          * @returns {File|null}
 396          */
 397         mw.Upload.BookletLayout.prototype.getFile = function () {
 398                 return this.selectFileWidget.getValue();
 399         };
 400
 401         /**
 402          * Gets the file name from the
 403          * {@link #infoForm information form}.
 404          *
 405          * @protected
 406          * @returns {string}
 407          */
 408         mw.Upload.BookletLayout.prototype.getFilename = function () {
 409                 return this.filenameWidget.getValue();
 410         };
 411
 412         /**
 413          * Gets the page text from the
 414          * {@link #infoForm information form}.
 415          *
 416          * @protected
 417          * @returns {string}
 418          */
 419         mw.Upload.BookletLayout.prototype.getText = function () {
 420                 return this.descriptionWidget.getValue();
 421         };
 422
 423         /* Setters */
 424
 425         /**
 426          * Clear the values of all fields
 427          *
 428          * @protected
 429          */
 430         mw.Upload.BookletLayout.prototype.clear = function () {
 431                 this.selectFileWidget.setValue( null );
 432                 this.filenameWidget.setValue( null ).setValidityFlag( true );
 433                 this.descriptionWidget.setValue( null ).setValidityFlag( true );
 434                 this.filenameUsageWidget.setValue( null );
 435         };
 436
 437 }( jQuery, mediaWiki ) );