resources/src/mediawiki.legacy/protect.js

   1 /* eslint-disable no-restricted-properties */
   2 ( function ( mw, $ ) {
   3         var ProtectionForm,
   4                 reasonCodePointLimit = mw.config.get( 'wgCommentCodePointLimit' ),
   5                 reasonByteLimit = mw.config.get( 'wgCommentByteLimit' );
   6
   7         ProtectionForm = window.ProtectionForm = {
   8                 /**
   9                  * Set up the protection chaining interface (i.e. "unlock move permissions" checkbox)
  10                  * on the protection form
  11                  *
  12                  * @return {boolean}
  13                  */
  14                 init: function () {
  15                         var $cell = $( '<td>' ),
  16                                 $row = $( '<tr>' ).append( $cell );
  17
  18                         if ( !$( '#mwProtectSet' ).length ) {
  19                                 return false;
  20                         }
  21
  22                         if ( mw.config.get( 'wgCascadeableLevels' ) !== undefined ) {
  23                                 $( 'form#mw-Protect-Form' ).submit( this.toggleUnchainedInputs.bind( ProtectionForm, true ) );
  24                         }
  25                         this.getExpirySelectors().each( function () {
  26                                 $( this ).change( ProtectionForm.updateExpiryList.bind( ProtectionForm, this ) );
  27                         } );
  28                         this.getExpiryInputs().each( function () {
  29                                 $( this ).on( 'keyup change', ProtectionForm.updateExpiry.bind( ProtectionForm, this ) );
  30                         } );
  31                         this.getLevelSelectors().each( function () {
  32                                 $( this ).change( ProtectionForm.updateLevels.bind( ProtectionForm, this ) );
  33                         } );
  34
  35                         $( '#mwProtectSet > tbody > tr:first' ).after( $row );
  36
  37                         // If there is only one protection type, there is nothing to chain
  38                         if ( $( '[id ^= mw-protect-table-]' ).length > 1 ) {
  39                                 $cell.append(
  40                                         $( '<input>' )
  41                                                 .attr( { id: 'mwProtectUnchained', type: 'checkbox' } )
  42                                                 .click( this.onChainClick.bind( this ) )
  43                                                 .prop( 'checked', !this.areAllTypesMatching() ),
  44                                         document.createTextNode( ' ' ),
  45                                         $( '<label>' )
  46                                                 .attr( 'for', 'mwProtectUnchained' )
  47                                                 .text( mw.msg( 'protect-unchain-permissions' ) )
  48                                 );
  49
  50                                 this.toggleUnchainedInputs( !this.areAllTypesMatching() );
  51                         }
  52
  53                         // Arbitrary 75 to leave some space for the autogenerated null edit's summary
  54                         if ( reasonCodePointLimit ) {
  55                                 $( '#mwProtect-reason' ).codePointLimit( reasonCodePointLimit - 75 );
  56                         } else if ( reasonByteLimit ) {
  57                                 $( '#mwProtect-reason' ).byteLimit( reasonByteLimit - 75 );
  58                         }
  59
  60                         this.updateCascadeCheckbox();
  61                         return true;
  62                 },
  63
  64                 /**
  65                  * Sets the disabled attribute on the cascade checkbox depending on the current selected levels
  66                  */
  67                 updateCascadeCheckbox: function () {
  68                         this.getLevelSelectors().each( function () {
  69                                 if ( !ProtectionForm.isCascadeableLevel( $( this ).val() ) ) {
  70                                         $( '#mwProtect-cascade' ).prop( { checked: false, disabled: true } );
  71                                         return false;
  72                                 } else {
  73                                         $( '#mwProtect-cascade' ).prop( 'disabled', false );
  74                                 }
  75                         } );
  76                 },
  77
  78                 /**
  79                  * Checks if a certain protection level is cascadeable.
  80                  *
  81                  * @param {string} level
  82                  * @return {boolean}
  83                  */
  84                 isCascadeableLevel: function ( level ) {
  85                         return $.inArray( level, mw.config.get( 'wgCascadeableLevels' ) ) !== -1;
  86                 },
  87
  88                 /**
  89                  * When protection levels are locked together, update the rest
  90                  * when one action's level changes
  91                  *
  92                  * @param {Element} source Level selector that changed
  93                  */
  94                 updateLevels: function ( source ) {
  95                         if ( !this.isUnchained() ) {
  96                                 this.setAllSelectors( source.selectedIndex );
  97                         }
  98                         this.updateCascadeCheckbox();
  99                 },
 100
 101                 /**
 102                  * When protection levels are locked together, update the
 103                  * expiries when one changes
 104                  *
 105                  * @param {Element} source expiry input that changed
 106                  */
 107
 108                 updateExpiry: function ( source ) {
 109                         if ( !this.isUnchained() ) {
 110                                 this.getExpiryInputs().each( function () {
 111                                         this.value = source.value;
 112                                 } );
 113                         }
 114                         if ( this.isUnchained() ) {
 115                                 $( '#' + source.id.replace( /^mwProtect-(\w+)-expires$/, 'mwProtectExpirySelection-$1' ) ).val( 'othertime' );
 116                         } else {
 117                                 this.getExpirySelectors().each( function () {
 118                                         this.value = 'othertime';
 119                                 } );
 120                         }
 121                 },
 122
 123                 /**
 124                  * When protection levels are locked together, update the
 125                  * expiry lists when one changes and clear the custom inputs
 126                  *
 127                  * @param {Element} source Expiry selector that changed
 128                  */
 129                 updateExpiryList: function ( source ) {
 130                         if ( !this.isUnchained() ) {
 131                                 this.getExpirySelectors().each( function () {
 132                                         this.value = source.value;
 133                                 } );
 134                                 this.getExpiryInputs().each( function () {
 135                                         this.value = '';
 136                                 } );
 137                         }
 138                 },
 139
 140                 /**
 141                  * Update chain status and enable/disable various bits of the UI
 142                  * when the user changes the "unlock move permissions" checkbox
 143                  */
 144                 onChainClick: function () {
 145                         this.toggleUnchainedInputs( this.isUnchained() );
 146                         if ( !this.isUnchained() ) {
 147                                 this.setAllSelectors( this.getMaxLevel() );
 148                         }
 149                         this.updateCascadeCheckbox();
 150                 },
 151
 152                 /**
 153                  * Returns true if the named attribute in all objects in the given array are matching
 154                  *
 155                  * @param {Object[]} objects
 156                  * @param {string} attrName
 157                  * @return {boolean}
 158                  */
 159                 matchAttribute: function ( objects, attrName ) {
 160                         return $.map( objects, function ( object ) {
 161                                 return object[ attrName ];
 162                         } ).filter( function ( item, index, a ) {
 163                                 return index === a.indexOf( item );
 164                         } ).length === 1;
 165                 },
 166
 167                 /**
 168                  * Are all actions protected at the same level, with the same expiry time?
 169                  *
 170                  * @return {boolean}
 171                  */
 172                 areAllTypesMatching: function () {
 173                         return this.matchAttribute( this.getLevelSelectors(), 'selectedIndex' ) &&
 174                                 this.matchAttribute( this.getExpirySelectors(), 'selectedIndex' ) &&
 175                                 this.matchAttribute( this.getExpiryInputs(), 'value' );
 176                 },
 177
 178                 /**
 179                  * Is protection chaining off?
 180                  *
 181                  * @return {boolean}
 182                  */
 183                 isUnchained: function () {
 184                         var element = document.getElementById( 'mwProtectUnchained' );
 185                         return element ?
 186                                 element.checked :
 187                                 true; // No control, so we need to let the user set both levels
 188                 },
 189
 190                 /**
 191                  * Find the highest protection level in any selector
 192                  *
 193                  * @return {number}
 194                  */
 195                 getMaxLevel: function () {
 196                         return Math.max.apply( Math, this.getLevelSelectors().map( function () {
 197                                 return this.selectedIndex;
 198                         } ) );
 199                 },
 200
 201                 /**
 202                  * Protect all actions at the specified level
 203                  *
 204                  * @param {number} index Protection level
 205                  */
 206                 setAllSelectors: function ( index ) {
 207                         this.getLevelSelectors().each( function () {
 208                                 this.selectedIndex = index;
 209                         } );
 210                 },
 211
 212                 /**
 213                  * Get a list of all protection selectors on the page
 214                  *
 215                  * @return {jQuery}
 216                  */
 217                 getLevelSelectors: function () {
 218                         return $( 'select[id ^= mwProtect-level-]' );
 219                 },
 220
 221                 /**
 222                  * Get a list of all expiry inputs on the page
 223                  *
 224                  * @return {jQuery}
 225                  */
 226                 getExpiryInputs: function () {
 227                         return $( 'input[id ^= mwProtect-][id $= -expires]' );
 228                 },
 229
 230                 /**
 231                  * Get a list of all expiry selector lists on the page
 232                  *
 233                  * @return {jQuery}
 234                  */
 235                 getExpirySelectors: function () {
 236                         return $( 'select[id ^= mwProtectExpirySelection-]' );
 237                 },
 238
 239                 /**
 240                  * Enable/disable protection selectors and expiry inputs
 241                  *
 242                  * @param {boolean} val Enable?
 243                  */
 244                 toggleUnchainedInputs: function ( val ) {
 245                         var setDisabled = function () { this.disabled = !val; };
 246                         this.getLevelSelectors().slice( 1 ).each( setDisabled );
 247                         this.getExpiryInputs().slice( 1 ).each( setDisabled );
 248                         this.getExpirySelectors().slice( 1 ).each( setDisabled );
 249                 }
 250         };
 251
 252         $( ProtectionForm.init.bind( ProtectionForm ) );
 253
 254 }( mediaWiki, jQuery ) );