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          * @param {Object} imageInfo See mw.Upload#getImageInfo
 110          */
 111
 112         /**
 113          * The upload form has changed
 114          *
 115          * @event uploadValid
 116          * @param {boolean} isValid The form is valid
 117          */
 118
 119         /**
 120          * The info form has changed
 121          *
 122          * @event infoValid
 123          * @param {boolean} isValid The form is valid
 124          */
 125
 126         /* Properties */
 127
 128         /**
 129          * @property {OO.ui.FormLayout} uploadForm
 130          * The form rendered in the first step to get the file object.
 131          * Rendered in {@link #renderUploadForm renderUploadForm}.
 132          */
 133
 134         /**
 135          * @property {OO.ui.FormLayout} infoForm
 136          * The form rendered in the second step to get metadata.
 137          * Rendered in {@link #renderInfoForm renderInfoForm}
 138          */
 139
 140         /**
 141          * @property {OO.ui.FormLayout} insertForm
 142          * The form rendered in the third step to show usage
 143          * Rendered in {@link #renderInsertForm renderInsertForm}
 144          */
 145
 146         /* Methods */
 147
 148         /**
 149          * Initialize for a new upload
 150          *
 151          * @return {jQuery.Promise} Promise resolved when everything is initialized
 152          */
 153         mw.Upload.BookletLayout.prototype.initialize = function () {
 154                 this.clear();
 155                 this.upload = this.createUpload();
 156                 this.setPage( 'upload' );
 157                 return $.Deferred().resolve().promise();
 158         };
 159
 160         /**
 161          * Create a new upload model
 162          *
 163          * @protected
 164          * @return {mw.Upload} Upload model
 165          */
 166         mw.Upload.BookletLayout.prototype.createUpload = function () {
 167                 return new mw.Upload();
 168         };
 169
 170         /* Uploading */
 171
 172         /**
 173          * Uploads the file that was added in the upload form. Uses
 174          * {@link #getFile getFile} to get the HTML5
 175          * file object.
 176          *
 177          * @protected
 178          * @fires fileUploaded
 179          * @return {jQuery.Promise}
 180          */
 181         mw.Upload.BookletLayout.prototype.uploadFile = function () {
 182                 var deferred = $.Deferred(),
 183                         layout = this,
 184                         file = this.getFile();
 185
 186                 this.filenameWidget.setValue( file.name );
 187                 this.setPage( 'info' );
 188
 189                 if ( this.shouldRecordBucket ) {
 190                         this.upload.bucket = this.bucket;
 191                 }
 192
 193                 this.upload.setFile( file );
 194                 // Explicitly set the filename so that the old filename isn't used in case of retry
 195                 this.upload.setFilenameFromFile();
 196
 197                 this.uploadPromise = this.upload.uploadToStash();
 198                 this.uploadPromise.then( function () {
 199                         deferred.resolve();
 200                         layout.emit( 'fileUploaded' );
 201                 }, function () {
 202                         // These errors will be thrown while the user is on the info page.
 203                         // Pretty sure it's impossible to get a warning other than 'stashfailed' here, which should
 204                         // really be an error...
 205                         var errorMessage = layout.getErrorMessageForStateDetails();
 206                         deferred.reject( errorMessage );
 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          * @return {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.then( function () {
 236                         layout.upload.finishStashUpload().then( function () {
 237                                 var name;
 238
 239                                 // Normalize page name and localise the 'File:' prefix
 240                                 name = new mw.Title( 'File:' + layout.upload.getFilename() ).toString();
 241                                 layout.filenameUsageWidget.setValue( '[[' + name + ']]' );
 242                                 layout.setPage( 'insert' );
 243
 244                                 deferred.resolve();
 245                                 layout.emit( 'fileSaved', layout.upload.getImageInfo() );
 246                         }, function () {
 247                                 var errorMessage = layout.getErrorMessageForStateDetails();
 248                                 deferred.reject( errorMessage );
 249                         } );
 250                 } );
 251
 252                 return deferred.promise();
 253         };
 254
 255         /**
 256          * Get an error message (as OO.ui.Error object) that should be displayed to the user for current
 257          * state and state details.
 258          *
 259          * @protected
 260          * @return {OO.ui.Error} Error to display for given state and details.
 261          */
 262         mw.Upload.BookletLayout.prototype.getErrorMessageForStateDetails = function () {
 263                 var message,
 264                         state = this.upload.getState(),
 265                         stateDetails = this.upload.getStateDetails(),
 266                         error = stateDetails.error,
 267                         warnings = stateDetails.upload && stateDetails.upload.warnings;
 268
 269                 if ( state === mw.Upload.State.ERROR ) {
 270                         // HACK We should either have a hook here to allow TitleBlacklist to handle this, or just have
 271                         // TitleBlacklist produce sane error messages that can be displayed without arcane knowledge
 272                         if ( error.info === 'TitleBlacklist prevents this title from being created' ) {
 273                                 // HACK Apparently the only reliable way to determine whether TitleBlacklist was involved
 274                                 return new OO.ui.Error(
 275                                         $( '<p>' ).html(
 276                                                 // HACK TitleBlacklist doesn't have a sensible message, this one is from UploadWizard
 277                                                 mw.message( 'api-error-blacklisted' ).parse()
 278                                         ),
 279                                         { recoverable: false }
 280                                 );
 281                         }
 282
 283                         message = mw.message( 'api-error-' + error.code );
 284                         if ( !message.exists() ) {
 285                                 message = mw.message( 'api-error-unknownerror', JSON.stringify( stateDetails ) );
 286                         }
 287                         return new OO.ui.Error(
 288                                 $( '<p>' ).html(
 289                                         message.parse()
 290                                 ),
 291                                 { recoverable: false }
 292                         );
 293                 }
 294
 295                 if ( state === mw.Upload.State.WARNING ) {
 296                         // We could get more than one of these errors, these are in order
 297                         // of importance. For example fixing the thumbnail like file name
 298                         // won't help the fact that the file already exists.
 299                         if ( warnings.stashfailed !== undefined ) {
 300                                 return new OO.ui.Error(
 301                                         $( '<p>' ).msg( 'api-error-stashfailed' ),
 302                                         { recoverable: false }
 303                                 );
 304                         } else if ( warnings.exists !== undefined ) {
 305                                 return new OO.ui.Error(
 306                                         $( '<p>' ).msg( 'fileexists', 'File:' + warnings.exists ),
 307                                         { recoverable: false }
 308                                 );
 309                         } else if ( warnings[ 'page-exists' ] !== undefined ) {
 310                                 return new OO.ui.Error(
 311                                         $( '<p>' ).msg( 'filepageexists', 'File:' + warnings[ 'page-exists' ] ),
 312                                         { recoverable: false }
 313                                 );
 314                         } else if ( warnings.duplicate !== undefined ) {
 315                                 return new OO.ui.Error(
 316                                         $( '<p>' ).msg( 'api-error-duplicate', warnings.duplicate.length ),
 317                                         { recoverable: false }
 318                                 );
 319                         } else if ( warnings[ 'thumb-name' ] !== undefined ) {
 320                                 return new OO.ui.Error(
 321                                         $( '<p>' ).msg( 'filename-thumb-name' ),
 322                                         { recoverable: false }
 323                                 );
 324                         } else if ( warnings[ 'bad-prefix' ] !== undefined ) {
 325                                 return new OO.ui.Error(
 326                                         $( '<p>' ).msg( 'filename-bad-prefix', warnings[ 'bad-prefix' ] ),
 327                                         { recoverable: false }
 328                                 );
 329                         } else if ( warnings[ 'duplicate-archive' ] !== undefined ) {
 330                                 return new OO.ui.Error(
 331                                         $( '<p>' ).msg( 'api-error-duplicate-archive', 1 ),
 332                                         { recoverable: false }
 333                                 );
 334                         } else if ( warnings.badfilename !== undefined ) {
 335                                 // Change the name if the current name isn't acceptable
 336                                 // TODO This might not really be the best place to do this
 337                                 this.filenameWidget.setValue( warnings.badfilename );
 338                                 return new OO.ui.Error(
 339                                         $( '<p>' ).msg( 'badfilename', warnings.badfilename )
 340                                 );
 341                         } else {
 342                                 return new OO.ui.Error(
 343                                         $( '<p>' ).html(
 344                                                 // Let's get all the help we can if we can't pin point the error
 345                                                 mw.message( 'api-error-unknown-warning', JSON.stringify( stateDetails ) ).parse()
 346                                         ),
 347                                         { recoverable: false }
 348                                 );
 349                         }
 350                 }
 351         };
 352
 353         /* Form renderers */
 354
 355         /**
 356          * Renders and returns the upload form and sets the
 357          * {@link #uploadForm uploadForm} property.
 358          *
 359          * @protected
 360          * @fires selectFile
 361          * @return {OO.ui.FormLayout}
 362          */
 363         mw.Upload.BookletLayout.prototype.renderUploadForm = function () {
 364                 var fieldset;
 365
 366                 this.selectFileWidget = new OO.ui.SelectFileWidget();
 367                 fieldset = new OO.ui.FieldsetLayout( { label: mw.msg( 'upload-form-label-select-file' ) } );
 368                 fieldset.addItems( [ this.selectFileWidget ] );
 369                 this.uploadForm = new OO.ui.FormLayout( { items: [ fieldset ] } );
 370
 371                 // Validation
 372                 this.selectFileWidget.on( 'change', this.onUploadFormChange.bind( this ) );
 373
 374                 return this.uploadForm;
 375         };
 376
 377         /**
 378          * Handle change events to the upload form
 379          *
 380          * @protected
 381          * @fires uploadValid
 382          */
 383         mw.Upload.BookletLayout.prototype.onUploadFormChange = function () {
 384                 this.emit( 'uploadValid', !!this.selectFileWidget.getValue() );
 385         };
 386
 387         /**
 388          * Renders and returns the information form for collecting
 389          * metadata and sets the {@link #infoForm infoForm}
 390          * property.
 391          *
 392          * @protected
 393          * @return {OO.ui.FormLayout}
 394          */
 395         mw.Upload.BookletLayout.prototype.renderInfoForm = function () {
 396                 var fieldset;
 397
 398                 this.filenameWidget = new OO.ui.TextInputWidget( {
 399                         indicator: 'required',
 400                         required: true,
 401                         validate: /.+/
 402                 } );
 403                 this.descriptionWidget = new OO.ui.TextInputWidget( {
 404                         indicator: 'required',
 405                         required: true,
 406                         validate: /.+/,
 407                         multiline: true,
 408                         autosize: true
 409                 } );
 410
 411                 fieldset = new OO.ui.FieldsetLayout( {
 412                         label: mw.msg( 'upload-form-label-infoform-title' )
 413                 } );
 414                 fieldset.addItems( [
 415                         new OO.ui.FieldLayout( this.filenameWidget, {
 416                                 label: mw.msg( 'upload-form-label-infoform-name' ),
 417                                 align: 'top'
 418                         } ),
 419                         new OO.ui.FieldLayout( this.descriptionWidget, {
 420                                 label: mw.msg( 'upload-form-label-infoform-description' ),
 421                                 align: 'top'
 422                         } )
 423                 ] );
 424                 this.infoForm = new OO.ui.FormLayout( { items: [ fieldset ] } );
 425
 426                 this.filenameWidget.on( 'change', this.onInfoFormChange.bind( this ) );
 427                 this.descriptionWidget.on( 'change', this.onInfoFormChange.bind( this ) );
 428
 429                 return this.infoForm;
 430         };
 431
 432         /**
 433          * Handle change events to the info form
 434          *
 435          * @protected
 436          * @fires infoValid
 437          */
 438         mw.Upload.BookletLayout.prototype.onInfoFormChange = function () {
 439                 var layout = this;
 440                 $.when(
 441                         this.filenameWidget.getValidity(),
 442                         this.descriptionWidget.getValidity()
 443                 ).done( function () {
 444                         layout.emit( 'infoValid', true );
 445                 } ).fail( function () {
 446                         layout.emit( 'infoValid', false );
 447                 } );
 448         };
 449
 450         /**
 451          * Renders and returns the insert form to show file usage and
 452          * sets the {@link #insertForm insertForm} property.
 453          *
 454          * @protected
 455          * @return {OO.ui.FormLayout}
 456          */
 457         mw.Upload.BookletLayout.prototype.renderInsertForm = function () {
 458                 var fieldset;
 459
 460                 this.filenameUsageWidget = new OO.ui.TextInputWidget();
 461                 fieldset = new OO.ui.FieldsetLayout( {
 462                         label: mw.msg( 'upload-form-label-usage-title' )
 463                 } );
 464                 fieldset.addItems( [
 465                         new OO.ui.FieldLayout( this.filenameUsageWidget, {
 466                                 label: mw.msg( 'upload-form-label-usage-filename' ),
 467                                 align: 'top'
 468                         } )
 469                 ] );
 470                 this.insertForm = new OO.ui.FormLayout( { items: [ fieldset ] } );
 471
 472                 return this.insertForm;
 473         };
 474
 475         /* Getters */
 476
 477         /**
 478          * Gets the file object from the
 479          * {@link #uploadForm upload form}.
 480          *
 481          * @protected
 482          * @return {File|null}
 483          */
 484         mw.Upload.BookletLayout.prototype.getFile = function () {
 485                 return this.selectFileWidget.getValue();
 486         };
 487
 488         /**
 489          * Gets the file name from the
 490          * {@link #infoForm information form}.
 491          *
 492          * @protected
 493          * @return {string}
 494          */
 495         mw.Upload.BookletLayout.prototype.getFilename = function () {
 496                 return this.filenameWidget.getValue();
 497         };
 498
 499         /**
 500          * Gets the page text from the
 501          * {@link #infoForm information form}.
 502          *
 503          * @protected
 504          * @return {string}
 505          */
 506         mw.Upload.BookletLayout.prototype.getText = function () {
 507                 return this.descriptionWidget.getValue();
 508         };
 509
 510         /* Setters */
 511
 512         /**
 513          * Sets the file object
 514          *
 515          * @protected
 516          * @param {File|null} file File to select
 517          */
 518         mw.Upload.BookletLayout.prototype.setFile = function ( file ) {
 519                 this.selectFileWidget.setValue( file );
 520         };
 521
 522         /**
 523          * Clear the values of all fields
 524          *
 525          * @protected
 526          */
 527         mw.Upload.BookletLayout.prototype.clear = function () {
 528                 this.selectFileWidget.setValue( null );
 529                 this.filenameWidget.setValue( null ).setValidityFlag( true );
 530                 this.descriptionWidget.setValue( null ).setValidityFlag( true );
 531                 this.filenameUsageWidget.setValue( null );
 532         };
 533
 534 }( jQuery, mediaWiki ) );