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