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

   1 /*global moment*/
   2 ( function ( $, mw, moment ) {
   3
   4         /**
   5          * mw.Upload.BookletLayout encapsulates the process of uploading a file
   6          * to MediaWiki using the {@link mw.Upload upload model}.
   7          * The booklet emits events that can be used to get the stashed
   8          * upload and the final file. It can be extended to accept
   9          * additional fields from the user for specific scenarios like
  10          * for Commons, or campaigns.
  11          *
  12          * ## Structure
  13          *
  14          * The {@link OO.ui.BookletLayout booklet layout} has three steps:
  15          *
  16          *  - **Upload**: Has a {@link OO.ui.SelectFileWidget field} to get the file object.
  17          *
  18          * - **Information**: Has a {@link OO.ui.FormLayout form} to collect metadata. This can be
  19          *   extended.
  20          *
  21          * - **Insert**: Has details on how to use the file that was uploaded.
  22          *
  23          * Each step has a form associated with it defined in
  24          * {@link #renderUploadForm renderUploadForm},
  25          * {@link #renderInfoForm renderInfoForm}, and
  26          * {@link #renderInsertForm renderInfoForm}. The
  27          * {@link #getFile getFile},
  28          * {@link #getFilename getFilename}, and
  29          * {@link #getText getText} methods are used to get
  30          * the information filled in these forms, required to call
  31          * {@link mw.Upload mw.Upload}.
  32          *
  33          * ## Usage
  34          *
  35          * See the {@link mw.Upload.Dialog upload dialog}.
  36          *
  37          * The {@link #event-fileUploaded fileUploaded},
  38          * and {@link #event-fileSaved fileSaved} events can
  39          * be used to get details of the upload.
  40          *
  41          * ## Extending
  42          *
  43          * To extend using {@link mw.Upload mw.Upload}, override
  44          * {@link #renderInfoForm renderInfoForm} to render
  45          * the form required for the specific use-case. Update the
  46          * {@link #getFilename getFilename}, and
  47          * {@link #getText getText} methods to return data
  48          * from your newly created form. If you added new fields you'll also have
  49          * to update the {@link #clear} method.
  50          *
  51          * If you plan to use a different upload model, apart from what is mentioned
  52          * above, you'll also have to override the
  53          * {@link #createUpload createUpload} method to
  54          * return the new model. The {@link #saveFile saveFile}, and
  55          * the {@link #uploadFile uploadFile} methods need to be
  56          * overridden to use the new model and data returned from the forms.
  57          *
  58          * @class
  59          * @extends OO.ui.BookletLayout
  60          *
  61          * @constructor
  62          * @param {Object} config Configuration options
  63          * @cfg {jQuery} [$overlay] Overlay to use for widgets in the booklet
  64          * @cfg {string} [filekey] Sets the stashed file to finish uploading. Overrides most of the file selection process, and fetches a thumbnail from the server.
  65          */
  66         mw.Upload.BookletLayout = function ( config ) {
  67                 // Parent constructor
  68                 mw.Upload.BookletLayout.parent.call( this, config );
  69
  70                 this.$overlay = config.$overlay;
  71
  72                 this.filekey = config.filekey;
  73
  74                 this.renderUploadForm();
  75                 this.renderInfoForm();
  76                 this.renderInsertForm();
  77
  78                 this.addPages( [
  79                         new OO.ui.PageLayout( 'upload', {
  80                                 scrollable: true,
  81                                 padded: true,
  82                                 content: [ this.uploadForm ]
  83                         } ),
  84                         new OO.ui.PageLayout( 'info', {
  85                                 scrollable: true,
  86                                 padded: true,
  87                                 content: [ this.infoForm ]
  88                         } ),
  89                         new OO.ui.PageLayout( 'insert', {
  90                                 scrollable: true,
  91                                 padded: true,
  92                                 content: [ this.insertForm ]
  93                         } )
  94                 ] );
  95         };
  96
  97         /* Setup */
  98
  99         OO.inheritClass( mw.Upload.BookletLayout, OO.ui.BookletLayout );
 100
 101         /* Events */
 102
 103         /**
 104          * Progress events for the uploaded file
 105          *
 106          * @event fileUploadProgress
 107          * @param {number} progress In percentage
 108          * @param {Object} duration Duration object from `moment.duration()`
 109          */
 110
 111         /**
 112          * The file has finished uploading
 113          *
 114          * @event fileUploaded
 115          */
 116
 117         /**
 118          * The file has been saved to the database
 119          *
 120          * @event fileSaved
 121          * @param {Object} imageInfo See mw.Upload#getImageInfo
 122          */
 123
 124         /**
 125          * The upload form has changed
 126          *
 127          * @event uploadValid
 128          * @param {boolean} isValid The form is valid
 129          */
 130
 131         /**
 132          * The info form has changed
 133          *
 134          * @event infoValid
 135          * @param {boolean} isValid The form is valid
 136          */
 137
 138         /* Properties */
 139
 140         /**
 141          * @property {OO.ui.FormLayout} uploadForm
 142          * The form rendered in the first step to get the file object.
 143          * Rendered in {@link #renderUploadForm renderUploadForm}.
 144          */
 145
 146         /**
 147          * @property {OO.ui.FormLayout} infoForm
 148          * The form rendered in the second step to get metadata.
 149          * Rendered in {@link #renderInfoForm renderInfoForm}
 150          */
 151
 152         /**
 153          * @property {OO.ui.FormLayout} insertForm
 154          * The form rendered in the third step to show usage
 155          * Rendered in {@link #renderInsertForm renderInsertForm}
 156          */
 157
 158         /* Methods */
 159
 160         /**
 161          * Initialize for a new upload
 162          *
 163          * @return {jQuery.Promise} Promise resolved when everything is initialized
 164          */
 165         mw.Upload.BookletLayout.prototype.initialize = function () {
 166                 var booklet = this;
 167
 168                 this.clear();
 169                 this.upload = this.createUpload();
 170
 171                 this.setPage( 'upload' );
 172
 173                 if ( this.filekey ) {
 174                         this.setFilekey( this.filekey );
 175                 }
 176
 177                 return this.upload.getApi().then(
 178                         function ( api ) {
 179                                 return $.when(
 180                                         booklet.upload.loadConfig().then(
 181                                                 null,
 182                                                 function ( errorMsg ) {
 183                                                         booklet.getPage( 'upload' ).$element.msg( errorMsg );
 184                                                         return $.Deferred().resolve();
 185                                                 }
 186                                         ),
 187                                         // If the user can't upload anything, don't give them the option to.
 188                                         api.getUserInfo().then( function ( userInfo ) {
 189                                                 if ( userInfo.rights.indexOf( 'upload' ) === -1 ) {
 190                                                         // TODO Use a better error message when not all logged-in users can upload
 191                                                         booklet.getPage( 'upload' ).$element.msg( 'api-error-mustbeloggedin' );
 192                                                 }
 193                                                 return $.Deferred().resolve();
 194                                         } )
 195                                 ).then(
 196                                         null,
 197                                         // Always resolve, never reject
 198                                         function () { return $.Deferred().resolve(); }
 199                                 );
 200                         },
 201                         function ( errorMsg ) {
 202                                 booklet.getPage( 'upload' ).$element.msg( errorMsg );
 203                                 return $.Deferred().resolve();
 204                         }
 205                 );
 206         };
 207
 208         /**
 209          * Create a new upload model
 210          *
 211          * @protected
 212          * @return {mw.Upload} Upload model
 213          */
 214         mw.Upload.BookletLayout.prototype.createUpload = function () {
 215                 return new mw.Upload();
 216         };
 217
 218         /* Uploading */
 219
 220         /**
 221          * Uploads the file that was added in the upload form. Uses
 222          * {@link #getFile getFile} to get the HTML5
 223          * file object.
 224          *
 225          * @protected
 226          * @fires fileUploadProgress
 227          * @fires fileUploaded
 228          * @return {jQuery.Promise}
 229          */
 230         mw.Upload.BookletLayout.prototype.uploadFile = function () {
 231                 var deferred = $.Deferred(),
 232                         startTime = new Date(),
 233                         layout = this,
 234                         file = this.getFile();
 235
 236                 this.setPage( 'info' );
 237
 238                 if ( this.filekey ) {
 239                         if ( file === null ) {
 240                                 // Someone gonna get-a hurt real bad
 241                                 throw new Error( 'filekey not passed into file select widget, which is impossible. Quitting while we\'re behind.' );
 242                         }
 243
 244                         // Stashed file already uploaded.
 245                         deferred.resolve();
 246                         this.uploadPromise = deferred;
 247                         this.emit( 'fileUploaded' );
 248                         return deferred;
 249                 }
 250
 251                 this.setFilename( file.name );
 252
 253                 this.upload.setFile( file );
 254                 // The original file name might contain invalid characters, so use our sanitized one
 255                 this.upload.setFilename( this.getFilename() );
 256
 257                 this.uploadPromise = this.upload.uploadToStash();
 258                 this.uploadPromise.then( function () {
 259                         deferred.resolve();
 260                         layout.emit( 'fileUploaded' );
 261                 }, function () {
 262                         // These errors will be thrown while the user is on the info page.
 263                         layout.getErrorMessageForStateDetails().then( function ( errorMessage ) {
 264                                 deferred.reject( errorMessage );
 265                         } );
 266                 }, function ( progress ) {
 267                         var elapsedTime = new Date() - startTime,
 268                                 estimatedTotalTime = ( 1 / progress ) * elapsedTime,
 269                                 estimatedRemainingTime = moment.duration( estimatedTotalTime - elapsedTime );
 270                         layout.emit( 'fileUploadProgress', progress, estimatedRemainingTime );
 271                 } );
 272
 273                 // If there is an error in uploading, come back to the upload page
 274                 deferred.fail( function () {
 275                         layout.setPage( 'upload' );
 276                 } );
 277
 278                 return deferred;
 279         };
 280
 281         /**
 282          * Saves the stash finalizes upload. Uses
 283          * {@link #getFilename getFilename}, and
 284          * {@link #getText getText} to get details from
 285          * the form.
 286          *
 287          * @protected
 288          * @fires fileSaved
 289          * @return {jQuery.Promise} Rejects the promise with an
 290          * {@link OO.ui.Error error}, or resolves if the upload was successful.
 291          */
 292         mw.Upload.BookletLayout.prototype.saveFile = function () {
 293                 var layout = this,
 294                         deferred = $.Deferred();
 295
 296                 this.upload.setFilename( this.getFilename() );
 297                 this.upload.setText( this.getText() );
 298
 299                 this.uploadPromise.then( function () {
 300                         layout.upload.finishStashUpload().then( function () {
 301                                 var name;
 302
 303                                 // Normalize page name and localise the 'File:' prefix
 304                                 name = new mw.Title( 'File:' + layout.upload.getFilename() ).toString();
 305                                 layout.filenameUsageWidget.setValue( '[[' + name + ']]' );
 306                                 layout.setPage( 'insert' );
 307
 308                                 deferred.resolve();
 309                                 layout.emit( 'fileSaved', layout.upload.getImageInfo() );
 310                         }, function () {
 311                                 layout.getErrorMessageForStateDetails().then( function ( errorMessage ) {
 312                                         deferred.reject( errorMessage );
 313                                 } );
 314                         } );
 315                 } );
 316
 317                 return deferred.promise();
 318         };
 319
 320         /**
 321          * Get an error message (as OO.ui.Error object) that should be displayed to the user for current
 322          * state and state details.
 323          *
 324          * @protected
 325          * @return {jQuery.Promise} A Promise that will be resolved with an OO.ui.Error.
 326          */
 327         mw.Upload.BookletLayout.prototype.getErrorMessageForStateDetails = function () {
 328                 var message,
 329                         state = this.upload.getState(),
 330                         stateDetails = this.upload.getStateDetails(),
 331                         error = stateDetails.error,
 332                         warnings = stateDetails.upload && stateDetails.upload.warnings;
 333
 334                 if ( state === mw.Upload.State.ERROR ) {
 335                         if ( !error ) {
 336                                 // If there's an 'exception' key, this might be a timeout, or other connection problem
 337                                 return $.Deferred().resolve( new OO.ui.Error(
 338                                         $( '<p>' ).msg( 'api-error-unknownerror', JSON.stringify( stateDetails ) ),
 339                                         { recoverable: false }
 340                                 ) );
 341                         }
 342
 343                         // Errors in this format are produced by TitleBlacklist and AbuseFilter. Perhaps other
 344                         // extensions will follow this format in the future.
 345                         if ( error.message ) {
 346                                 return this.upload.getApi()
 347                                         .then( function ( api ) {
 348                                                 return api.loadMessagesIfMissing( [ error.message.key ] ).then( function () {
 349                                                         if ( !mw.message( error.message.key ).exists() ) {
 350                                                                 return $.Deferred().reject();
 351                                                         }
 352                                                         return new OO.ui.Error(
 353                                                                 $( '<p>' ).msg( error.message.key, error.message.params || [] ),
 354                                                                 { recoverable: false }
 355                                                         );
 356                                                 } );
 357                                         } )
 358                                         .then( null, function () {
 359                                                 // We failed when loading the error message, or it doesn't actually exist, fall back
 360                                                 return $.Deferred().resolve( new OO.ui.Error(
 361                                                         $( '<p>' ).msg( 'api-error-unknownerror', JSON.stringify( stateDetails ) ),
 362                                                         { recoverable: false }
 363                                                 ) );
 364                                         } );
 365                         }
 366
 367                         if ( error.code === 'protectedpage' ) {
 368                                 message = mw.message( 'protectedpagetext' );
 369                         } else {
 370                                 message = mw.message( 'api-error-' + error.code );
 371                                 if ( !message.exists() ) {
 372                                         message = mw.message( 'api-error-unknownerror', JSON.stringify( stateDetails ) );
 373                                 }
 374                         }
 375                         return $.Deferred().resolve( new OO.ui.Error(
 376                                 $( '<p>' ).append( message.parseDom() ),
 377                                 { recoverable: false }
 378                         ) );
 379                 }
 380
 381                 if ( state === mw.Upload.State.WARNING ) {
 382                         // We could get more than one of these errors, these are in order
 383                         // of importance. For example fixing the thumbnail like file name
 384                         // won't help the fact that the file already exists.
 385                         if ( warnings.stashfailed !== undefined ) {
 386                                 return $.Deferred().resolve( new OO.ui.Error(
 387                                         $( '<p>' ).msg( 'api-error-stashfailed' ),
 388                                         { recoverable: false }
 389                                 ) );
 390                         } else if ( warnings.exists !== undefined ) {
 391                                 return $.Deferred().resolve( new OO.ui.Error(
 392                                         $( '<p>' ).msg( 'fileexists', 'File:' + warnings.exists ),
 393                                         { recoverable: false }
 394                                 ) );
 395                         } else if ( warnings[ 'exists-normalized' ] !== undefined ) {
 396                                 return $.Deferred().resolve( new OO.ui.Error(
 397                                         $( '<p>' ).msg( 'fileexists', 'File:' + warnings[ 'exists-normalized' ] ),
 398                                         { recoverable: false }
 399                                 ) );
 400                         } else if ( warnings[ 'page-exists' ] !== undefined ) {
 401                                 return $.Deferred().resolve( new OO.ui.Error(
 402                                         $( '<p>' ).msg( 'filepageexists', 'File:' + warnings[ 'page-exists' ] ),
 403                                         { recoverable: false }
 404                                 ) );
 405                         } else if ( warnings.duplicate !== undefined ) {
 406                                 return $.Deferred().resolve( new OO.ui.Error(
 407                                         $( '<p>' ).msg( 'api-error-duplicate', warnings.duplicate.length ),
 408                                         { recoverable: false }
 409                                 ) );
 410                         } else if ( warnings[ 'thumb-name' ] !== undefined ) {
 411                                 return $.Deferred().resolve( new OO.ui.Error(
 412                                         $( '<p>' ).msg( 'filename-thumb-name' ),
 413                                         { recoverable: false }
 414                                 ) );
 415                         } else if ( warnings[ 'bad-prefix' ] !== undefined ) {
 416                                 return $.Deferred().resolve( new OO.ui.Error(
 417                                         $( '<p>' ).msg( 'filename-bad-prefix', warnings[ 'bad-prefix' ] ),
 418                                         { recoverable: false }
 419                                 ) );
 420                         } else if ( warnings[ 'duplicate-archive' ] !== undefined ) {
 421                                 return $.Deferred().resolve( new OO.ui.Error(
 422                                         $( '<p>' ).msg( 'api-error-duplicate-archive', 1 ),
 423                                         { recoverable: false }
 424                                 ) );
 425                         } else if ( warnings[ 'was-deleted' ] !== undefined ) {
 426                                 return $.Deferred().resolve( new OO.ui.Error(
 427                                         $( '<p>' ).msg( 'api-error-was-deleted' ),
 428                                         { recoverable: false }
 429                                 ) );
 430                         } else if ( warnings.badfilename !== undefined ) {
 431                                 // Change the name if the current name isn't acceptable
 432                                 // TODO This might not really be the best place to do this
 433                                 this.setFilename( warnings.badfilename );
 434                                 return $.Deferred().resolve( new OO.ui.Error(
 435                                         $( '<p>' ).msg( 'badfilename', warnings.badfilename )
 436                                 ) );
 437                         } else {
 438                                 return $.Deferred().resolve( new OO.ui.Error(
 439                                         // Let's get all the help we can if we can't pin point the error
 440                                         $( '<p>' ).msg( 'api-error-unknown-warning', JSON.stringify( stateDetails ) ),
 441                                         { recoverable: false }
 442                                 ) );
 443                         }
 444                 }
 445         };
 446
 447         /* Form renderers */
 448
 449         /**
 450          * Renders and returns the upload form and sets the
 451          * {@link #uploadForm uploadForm} property.
 452          *
 453          * @protected
 454          * @fires selectFile
 455          * @return {OO.ui.FormLayout}
 456          */
 457         mw.Upload.BookletLayout.prototype.renderUploadForm = function () {
 458                 var fieldset,
 459                         layout = this;
 460
 461                 this.selectFileWidget = this.getFileWidget();
 462                 fieldset = new OO.ui.FieldsetLayout();
 463                 fieldset.addItems( [ this.selectFileWidget ] );
 464                 this.uploadForm = new OO.ui.FormLayout( { items: [ fieldset ] } );
 465
 466                 // Validation (if the SFW is for a stashed file, this never fires)
 467                 this.selectFileWidget.on( 'change', this.onUploadFormChange.bind( this ) );
 468
 469                 this.selectFileWidget.on( 'change', function () {
 470                         layout.updateFilePreview();
 471                 } );
 472
 473                 return this.uploadForm;
 474         };
 475
 476         /**
 477          * Gets the widget for displaying or inputting the file to upload.
 478          *
 479          * @return {OO.ui.SelectFileWidget|mw.widgets.StashedFileWidget}
 480          */
 481         mw.Upload.BookletLayout.prototype.getFileWidget = function () {
 482                 if ( this.filekey ) {
 483                         return new mw.widgets.StashedFileWidget( {
 484                                 filekey: this.filekey
 485                         } );
 486                 }
 487
 488                 return new OO.ui.SelectFileWidget( {
 489                         showDropTarget: true
 490                 } );
 491         };
 492
 493         /**
 494          * Updates the file preview on the info form when a file is added.
 495          *
 496          * @protected
 497          */
 498         mw.Upload.BookletLayout.prototype.updateFilePreview = function () {
 499                 this.selectFileWidget.loadAndGetImageUrl().done( function ( url ) {
 500                         this.filePreview.$element.find( 'p' ).remove();
 501                         this.filePreview.$element.css( 'background-image', 'url(' + url + ')' );
 502                         this.infoForm.$element.addClass( 'mw-upload-bookletLayout-hasThumbnail' );
 503                 }.bind( this ) ).fail( function () {
 504                         this.filePreview.$element.find( 'p' ).remove();
 505                         if ( this.selectFileWidget.getValue() ) {
 506                                 this.filePreview.$element.append(
 507                                         $( '<p>' ).text( this.selectFileWidget.getValue().name )
 508                                 );
 509                         }
 510                         this.filePreview.$element.css( 'background-image', '' );
 511                         this.infoForm.$element.removeClass( 'mw-upload-bookletLayout-hasThumbnail' );
 512                 }.bind( this ) );
 513         };
 514
 515         /**
 516          * Handle change events to the upload form
 517          *
 518          * @protected
 519          * @fires uploadValid
 520          */
 521         mw.Upload.BookletLayout.prototype.onUploadFormChange = function () {
 522                 this.emit( 'uploadValid', !!this.selectFileWidget.getValue() );
 523         };
 524
 525         /**
 526          * Renders and returns the information form for collecting
 527          * metadata and sets the {@link #infoForm infoForm}
 528          * property.
 529          *
 530          * @protected
 531          * @return {OO.ui.FormLayout}
 532          */
 533         mw.Upload.BookletLayout.prototype.renderInfoForm = function () {
 534                 var fieldset;
 535
 536                 this.filePreview = new OO.ui.Widget( {
 537                         classes: [ 'mw-upload-bookletLayout-filePreview' ]
 538                 } );
 539                 this.progressBarWidget = new OO.ui.ProgressBarWidget( {
 540                         progress: 0
 541                 } );
 542                 this.filePreview.$element.append( this.progressBarWidget.$element );
 543
 544                 this.filenameWidget = new OO.ui.TextInputWidget( {
 545                         indicator: 'required',
 546                         required: true,
 547                         validate: /.+/
 548                 } );
 549                 this.descriptionWidget = new OO.ui.TextInputWidget( {
 550                         indicator: 'required',
 551                         required: true,
 552                         validate: /\S+/,
 553                         multiline: true,
 554                         autosize: true
 555                 } );
 556
 557                 fieldset = new OO.ui.FieldsetLayout( {
 558                         label: mw.msg( 'upload-form-label-infoform-title' )
 559                 } );
 560                 fieldset.addItems( [
 561                         new OO.ui.FieldLayout( this.filenameWidget, {
 562                                 label: mw.msg( 'upload-form-label-infoform-name' ),
 563                                 align: 'top',
 564                                 help: mw.msg( 'upload-form-label-infoform-name-tooltip' )
 565                         } ),
 566                         new OO.ui.FieldLayout( this.descriptionWidget, {
 567                                 label: mw.msg( 'upload-form-label-infoform-description' ),
 568                                 align: 'top',
 569                                 help: mw.msg( 'upload-form-label-infoform-description-tooltip' )
 570                         } )
 571                 ] );
 572                 this.infoForm = new OO.ui.FormLayout( {
 573                         classes: [ 'mw-upload-bookletLayout-infoForm' ],
 574                         items: [ this.filePreview, fieldset ]
 575                 } );
 576
 577                 this.on( 'fileUploadProgress', function ( progress ) {
 578                         this.progressBarWidget.setProgress( progress * 100 );
 579                 }.bind( this ) );
 580
 581                 this.filenameWidget.on( 'change', this.onInfoFormChange.bind( this ) );
 582                 this.descriptionWidget.on( 'change', this.onInfoFormChange.bind( this ) );
 583
 584                 return this.infoForm;
 585         };
 586
 587         /**
 588          * Handle change events to the info form
 589          *
 590          * @protected
 591          * @fires infoValid
 592          */
 593         mw.Upload.BookletLayout.prototype.onInfoFormChange = function () {
 594                 var layout = this;
 595                 $.when(
 596                         this.filenameWidget.getValidity(),
 597                         this.descriptionWidget.getValidity()
 598                 ).done( function () {
 599                         layout.emit( 'infoValid', true );
 600                 } ).fail( function () {
 601                         layout.emit( 'infoValid', false );
 602                 } );
 603         };
 604
 605         /**
 606          * Renders and returns the insert form to show file usage and
 607          * sets the {@link #insertForm insertForm} property.
 608          *
 609          * @protected
 610          * @return {OO.ui.FormLayout}
 611          */
 612         mw.Upload.BookletLayout.prototype.renderInsertForm = function () {
 613                 var fieldset;
 614
 615                 this.filenameUsageWidget = new OO.ui.TextInputWidget();
 616                 fieldset = new OO.ui.FieldsetLayout( {
 617                         label: mw.msg( 'upload-form-label-usage-title' )
 618                 } );
 619                 fieldset.addItems( [
 620                         new OO.ui.FieldLayout( this.filenameUsageWidget, {
 621                                 label: mw.msg( 'upload-form-label-usage-filename' ),
 622                                 align: 'top'
 623                         } )
 624                 ] );
 625                 this.insertForm = new OO.ui.FormLayout( { items: [ fieldset ] } );
 626
 627                 return this.insertForm;
 628         };
 629
 630         /* Getters */
 631
 632         /**
 633          * Gets the file object from the
 634          * {@link #uploadForm upload form}.
 635          *
 636          * @protected
 637          * @return {File|null}
 638          */
 639         mw.Upload.BookletLayout.prototype.getFile = function () {
 640                 return this.selectFileWidget.getValue();
 641         };
 642
 643         /**
 644          * Gets the file name from the
 645          * {@link #infoForm information form}.
 646          *
 647          * @protected
 648          * @return {string}
 649          */
 650         mw.Upload.BookletLayout.prototype.getFilename = function () {
 651                 var filename = this.filenameWidget.getValue();
 652                 if ( this.filenameExtension ) {
 653                         filename += '.' + this.filenameExtension;
 654                 }
 655                 return filename;
 656         };
 657
 658         /**
 659          * Prefills the {@link #infoForm information form} with the given filename.
 660          *
 661          * @protected
 662          * @param {string} filename
 663          */
 664         mw.Upload.BookletLayout.prototype.setFilename = function ( filename ) {
 665                 var title = mw.Title.newFromFileName( filename );
 666
 667                 if ( title ) {
 668                         this.filenameWidget.setValue( title.getNameText() );
 669                         this.filenameExtension = mw.Title.normalizeExtension( title.getExtension() );
 670                 } else {
 671                         // Seems to happen for files with no extension, which should fail some checks anyway...
 672                         this.filenameWidget.setValue( filename );
 673                         this.filenameExtension = null;
 674                 }
 675         };
 676
 677         /**
 678          * Gets the page text from the
 679          * {@link #infoForm information form}.
 680          *
 681          * @protected
 682          * @return {string}
 683          */
 684         mw.Upload.BookletLayout.prototype.getText = function () {
 685                 return this.descriptionWidget.getValue();
 686         };
 687
 688         /* Setters */
 689
 690         /**
 691          * Sets the file object
 692          *
 693          * @protected
 694          * @param {File|null} file File to select
 695          */
 696         mw.Upload.BookletLayout.prototype.setFile = function ( file ) {
 697                 this.selectFileWidget.setValue( file );
 698         };
 699
 700         /**
 701          * Sets the filekey of a file already stashed on the server
 702          * as the target of this upload operation.
 703          *
 704          * @protected
 705          * @param {string} filekey
 706          */
 707         mw.Upload.BookletLayout.prototype.setFilekey = function ( filekey ) {
 708                 this.upload.setFilekey( this.filekey );
 709                 this.selectFileWidget.setValue( filekey );
 710
 711                 this.onUploadFormChange();
 712         };
 713
 714         /**
 715          * Clear the values of all fields
 716          *
 717          * @protected
 718          */
 719         mw.Upload.BookletLayout.prototype.clear = function () {
 720                 this.selectFileWidget.setValue( null );
 721                 this.progressBarWidget.setProgress( 0 );
 722                 this.filenameWidget.setValue( null ).setValidityFlag( true );
 723                 this.descriptionWidget.setValue( null ).setValidityFlag( true );
 724                 this.filenameUsageWidget.setValue( null );
 725         };
 726
 727 }( jQuery, mediaWiki, moment ) );