resources/src/mediawiki.rcfilters/ui/mw.rcfilters.ui.FormWrapperWidget.js

   1 ( function ( mw ) {
   2         /**
   3          * Wrapper for the RC form with hide/show links
   4          * Must be constructed after the model is initialized.
   5          *
   6          * @extends OO.ui.Widget
   7          *
   8          * @constructor
   9          * @param {mw.rcfilters.dm.FiltersViewModel} filtersModel Changes list view model
  10          * @param {mw.rcfilters.dm.ChangesListViewModel} changeListModel Changes list view model
  11          * @param {mw.rcfilters.Controller} controller RCfilters controller
  12          * @param {jQuery} $formRoot Root element of the form to attach to
  13          * @param {Object} config Configuration object
  14          */
  15         mw.rcfilters.ui.FormWrapperWidget = function MwRcfiltersUiFormWrapperWidget( filtersModel, changeListModel, controller, $formRoot, config ) {
  16                 config = config || {};
  17
  18                 // Parent
  19                 mw.rcfilters.ui.FormWrapperWidget.parent.call( this, $.extend( {}, config, {
  20                         $element: $formRoot
  21                 } ) );
  22                 // Mixin constructors
  23                 OO.ui.mixin.PendingElement.call( this, config );
  24
  25                 this.changeListModel = changeListModel;
  26                 this.filtersModel = filtersModel;
  27                 this.controller = controller;
  28                 this.$submitButton = this.$element.find( 'form input[type=submit]' );
  29
  30                 this.$element
  31                         .on( 'click', 'a[data-params]', this.onLinkClick.bind( this ) );
  32
  33                 this.$element
  34                         .on( 'submit', 'form', this.onFormSubmit.bind( this ) );
  35
  36                 // Events
  37                 this.changeListModel.connect( this, {
  38                         invalidate: 'onChangesModelInvalidate',
  39                         update: 'onChangesModelUpdate'
  40                 } );
  41
  42                 // Initialize
  43                 this.cleanUpFieldset();
  44                 this.$element
  45                         .addClass( 'mw-rcfilters-ui-FormWrapperWidget' );
  46         };
  47
  48         /* Initialization */
  49
  50         OO.inheritClass( mw.rcfilters.ui.FormWrapperWidget, OO.ui.Widget );
  51         OO.mixinClass( mw.rcfilters.ui.FormWrapperWidget, OO.ui.mixin.PendingElement );
  52
  53         /**
  54          * Respond to link click
  55          *
  56          * @param {jQuery.Event} e Event
  57          * @return {boolean} false
  58          */
  59         mw.rcfilters.ui.FormWrapperWidget.prototype.onLinkClick = function ( e ) {
  60                 this.controller.updateChangesList( $( e.target ).data( 'params' ) );
  61                 return false;
  62         };
  63
  64         /**
  65          * Respond to form submit event
  66          *
  67          * @param {jQuery.Event} e Event
  68          * @return {boolean} false
  69          */
  70         mw.rcfilters.ui.FormWrapperWidget.prototype.onFormSubmit = function ( e ) {
  71                 var data = {};
  72
  73                 // Collect all data from form
  74                 $( e.target ).find( 'input:not([type="hidden"],[type="submit"]), select' ).each( function () {
  75                         var value = '';
  76
  77                         if ( !$( this ).is( ':checkbox' ) || $( this ).is( ':checked' ) ) {
  78                                 value = $( this ).val();
  79                         }
  80
  81                         data[ $( this ).prop( 'name' ) ] = value;
  82                 } );
  83
  84                 this.controller.updateChangesList( data );
  85                 return false;
  86         };
  87
  88         /**
  89          * Respond to model invalidate
  90          */
  91         mw.rcfilters.ui.FormWrapperWidget.prototype.onChangesModelInvalidate = function () {
  92                 this.pushPending();
  93                 this.$submitButton.prop( 'disabled', true );
  94         };
  95
  96         /**
  97          * Respond to model update, replace the show/hide links with the ones from the
  98          * server so they feature the correct state.
  99          *
 100          * @param {jQuery|string} $changesList Updated changes list
 101          * @param {jQuery} $fieldset Updated fieldset
 102          * @param {boolean} isInitialDOM Whether $changesListContent is the existing (already attached) DOM
 103          */
 104         mw.rcfilters.ui.FormWrapperWidget.prototype.onChangesModelUpdate = function ( $changesList, $fieldset, isInitialDOM ) {
 105                 this.$submitButton.prop( 'disabled', false );
 106
 107                 // Replace the entire fieldset
 108                 this.$element.empty().append( $fieldset.contents() );
 109
 110                 if ( !isInitialDOM ) {
 111                         // Make sure enhanced RC re-initializes correctly
 112                         mw.hook( 'wikipage.content' ).fire( this.$element );
 113                 }
 114
 115                 this.cleanUpFieldset();
 116
 117                 this.popPending();
 118         };
 119
 120         /**
 121          * Clean up the old-style show/hide that we have implemented in the filter list
 122          */
 123         mw.rcfilters.ui.FormWrapperWidget.prototype.cleanUpFieldset = function () {
 124                 var $namespaceSelect = this.$element.find( '#namespace' );
 125
 126                 this.$element.find( '.rcshowhideoption[data-feature-in-structured-ui=1]' ).each( function () {
 127                         // HACK: Remove the text node after the span.
 128                         // If there isn't one, we're at the end, so remove the text node before the span.
 129                         // This would be unnecessary if we added separators with CSS.
 130                         if ( this.nextSibling && this.nextSibling.nodeType === Node.TEXT_NODE ) {
 131                                 this.parentNode.removeChild( this.nextSibling );
 132                         } else if ( this.previousSibling && this.previousSibling.nodeType === Node.TEXT_NODE ) {
 133                                 this.parentNode.removeChild( this.previousSibling );
 134                         }
 135                         // Remove the span itself
 136                         this.parentNode.removeChild( this );
 137                 } );
 138
 139                 // Hide namespaces and tags
 140                 if ( mw.config.get( 'wgStructuredChangeFiltersEnableExperimentalViews' ) ) {
 141                         $namespaceSelect.closest( 'tr' ).detach();
 142                         this.$element.find( '.mw-tagfilter-label' ).closest( 'tr' ).detach();
 143                 }
 144
 145                 // Hide limit and days
 146                 this.$element.find( '.rclinks' ).detach();
 147
 148                 if ( !this.$element.find( '.mw-recentchanges-table tr' ).length ) {
 149                         this.$element.find( '.mw-recentchanges-table' ).detach();
 150                         this.$element.find( 'hr' ).detach();
 151                 }
 152                 if ( !this.$element.find( '.rcshowhide' ).contents().length ) {
 153                         this.$element.find( '.rcshowhide' ).detach();
 154                         // If we're hiding rcshowhide, the '<br>'s are around it,
 155                         // there's no need for them either.
 156                         this.$element.find( 'br' ).detach();
 157                 }
 158         };
 159 }( mediaWiki ) );