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

   1 /**
   2  * Wrapper for the RC form with hide/show links
   3  * Must be constructed after the model is initialized.
   4  *
   5  * @class mw.rcfilters.ui.FormWrapperWidget
   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 var FormWrapperWidget = function MwRcfiltersUiFormWrapperWidget( filtersModel, changeListModel, controller, $formRoot, config ) {
  16         config = config || {};
  17
  18         // Parent
  19         FormWrapperWidget.parent.call( this, $.extend( {}, config, {
  20                 $element: $formRoot
  21         } ) );
  22
  23         this.changeListModel = changeListModel;
  24         this.filtersModel = filtersModel;
  25         this.controller = controller;
  26         this.$submitButton = this.$element.find( 'form input[type=submit]' );
  27
  28         this.$element
  29                 .on( 'click', 'a[data-params]', this.onLinkClick.bind( this ) );
  30
  31         this.$element
  32                 .on( 'submit', 'form', this.onFormSubmit.bind( this ) );
  33
  34         // Events
  35         this.changeListModel.connect( this, {
  36                 invalidate: 'onChangesModelInvalidate',
  37                 update: 'onChangesModelUpdate'
  38         } );
  39
  40         // Initialize
  41         this.cleanUpFieldset();
  42         this.$element
  43                 .addClass( 'mw-rcfilters-ui-FormWrapperWidget' );
  44 };
  45
  46 /* Initialization */
  47
  48 OO.inheritClass( FormWrapperWidget, OO.ui.Widget );
  49
  50 /**
  51  * Respond to link click
  52  *
  53  * @param {jQuery.Event} e Event
  54  * @return {boolean} false
  55  */
  56 FormWrapperWidget.prototype.onLinkClick = function ( e ) {
  57         this.controller.updateChangesList( $( e.target ).data( 'params' ) );
  58         return false;
  59 };
  60
  61 /**
  62  * Respond to form submit event
  63  *
  64  * @param {jQuery.Event} e Event
  65  * @return {boolean} false
  66  */
  67 FormWrapperWidget.prototype.onFormSubmit = function ( e ) {
  68         var data = {};
  69
  70         // Collect all data from form
  71         $( e.target ).find( 'input:not([type="hidden"],[type="submit"]), select' ).each( function () {
  72                 var value = '';
  73
  74                 if ( !$( this ).is( ':checkbox' ) || $( this ).is( ':checked' ) ) {
  75                         value = $( this ).val();
  76                 }
  77
  78                 data[ $( this ).prop( 'name' ) ] = value;
  79         } );
  80
  81         this.controller.updateChangesList( data );
  82         return false;
  83 };
  84
  85 /**
  86  * Respond to model invalidate
  87  */
  88 FormWrapperWidget.prototype.onChangesModelInvalidate = function () {
  89         this.$submitButton.prop( 'disabled', true );
  90 };
  91
  92 /**
  93  * Respond to model update, replace the show/hide links with the ones from the
  94  * server so they feature the correct state.
  95  *
  96  * @param {jQuery|string} $changesList Updated changes list
  97  * @param {jQuery} $fieldset Updated fieldset
  98  * @param {string} noResultsDetails Type of no result error
  99  * @param {boolean} isInitialDOM Whether $changesListContent is the existing (already attached) DOM
 100  */
 101 FormWrapperWidget.prototype.onChangesModelUpdate = function ( $changesList, $fieldset, noResultsDetails, isInitialDOM ) {
 102         this.$submitButton.prop( 'disabled', false );
 103
 104         // Replace the entire fieldset
 105         this.$element.empty().append( $fieldset.contents() );
 106
 107         if ( !isInitialDOM ) {
 108                 // Make sure enhanced RC re-initializes correctly
 109                 mw.hook( 'wikipage.content' ).fire( this.$element );
 110         }
 111
 112         this.cleanUpFieldset();
 113 };
 114
 115 /**
 116  * Clean up the old-style show/hide that we have implemented in the filter list
 117  */
 118 FormWrapperWidget.prototype.cleanUpFieldset = function () {
 119         this.$element.find( '.clshowhideoption[data-feature-in-structured-ui=1]' ).each( function () {
 120                 // HACK: Remove the text node after the span.
 121                 // If there isn't one, we're at the end, so remove the text node before the span.
 122                 // This would be unnecessary if we added separators with CSS.
 123                 if ( this.nextSibling && this.nextSibling.nodeType === Node.TEXT_NODE ) {
 124                         this.parentNode.removeChild( this.nextSibling );
 125                 } else if ( this.previousSibling && this.previousSibling.nodeType === Node.TEXT_NODE ) {
 126                         this.parentNode.removeChild( this.previousSibling );
 127                 }
 128                 // Remove the span itself
 129                 this.parentNode.removeChild( this );
 130         } );
 131
 132         // Hide namespaces and tags
 133         this.$element.find( '.namespaceForm' ).detach();
 134         this.$element.find( '.mw-tagfilter-label' ).closest( 'tr' ).detach();
 135
 136         // Hide Related Changes page name form
 137         this.$element.find( '.targetForm' ).detach();
 138
 139         // misc: limit, days, watchlist info msg
 140         this.$element.find( '.rclinks, .cldays, .wlinfo' ).detach();
 141
 142         if ( !this.$element.find( '.mw-recentchanges-table tr' ).length ) {
 143                 this.$element.find( '.mw-recentchanges-table' ).detach();
 144                 this.$element.find( 'hr' ).detach();
 145         }
 146
 147         // Get rid of all <br>s, which are inside rcshowhide
 148         // If we still have content in rcshowhide, the <br>s are
 149         // gone. Instead, the CSS now has a rule to mark all <span>s
 150         // inside .rcshowhide with display:block; to simulate newlines
 151         // where they're actually needed.
 152         this.$element.find( 'br' ).detach();
 153         if ( !this.$element.find( '.rcshowhide' ).contents().length ) {
 154                 this.$element.find( '.rcshowhide' ).detach();
 155         }
 156
 157         if ( this.$element.find( '.cloption' ).text().trim() === '' ) {
 158                 this.$element.find( '.cloption-submit' ).detach();
 159         }
 160
 161         this.$element.find(
 162                 '.rclistfrom, .rcnotefrom, .rcoptions-listfromreset'
 163         ).detach();
 164
 165         // Get rid of the legend
 166         this.$element.find( 'legend' ).detach();
 167
 168         // Check if the element is essentially empty, and detach it if it is
 169         if ( !this.$element.text().trim().length ) {
 170                 this.$element.detach();
 171         }
 172 };
 173
 174 module.exports = FormWrapperWidget;