resources/src/mediawiki.rcfilters/mw.rcfilters.Controller.js

   1 ( function ( mw, $ ) {
   2         /* eslint no-underscore-dangle: "off" */
   3         /**
   4          * Controller for the filters in Recent Changes
   5          * @class
   6          *
   7          * @constructor
   8          * @param {mw.rcfilters.dm.FiltersViewModel} filtersModel Filters view model
   9          * @param {mw.rcfilters.dm.ChangesListViewModel} changesListModel Changes list view model
  10          * @param {mw.rcfilters.dm.SavedQueriesModel} savedQueriesModel Saved queries model
  11          * @param {Object} config Additional configuration
  12          * @cfg {string} savedQueriesPreferenceName Where to save the saved queries
  13          */
  14         mw.rcfilters.Controller = function MwRcfiltersController( filtersModel, changesListModel, savedQueriesModel, config ) {
  15                 this.filtersModel = filtersModel;
  16                 this.changesListModel = changesListModel;
  17                 this.savedQueriesModel = savedQueriesModel;
  18                 this.savedQueriesPreferenceName = config.savedQueriesPreferenceName;
  19
  20                 this.requestCounter = {};
  21                 this.baseFilterState = {};
  22                 this.uriProcessor = null;
  23                 this.initializing = false;
  24                 this.wereSavedQueriesSaved = false;
  25
  26                 this.prevLoggedItems = [];
  27
  28                 this.FILTER_CHANGE = 'filterChange';
  29                 this.SHOW_NEW_CHANGES = 'showNewChanges';
  30                 this.LIVE_UPDATE = 'liveUpdate';
  31         };
  32
  33         /* Initialization */
  34         OO.initClass( mw.rcfilters.Controller );
  35
  36         /**
  37          * Initialize the filter and parameter states
  38          *
  39          * @param {Array} filterStructure Filter definition and structure for the model
  40          * @param {Object} [namespaceStructure] Namespace definition
  41          * @param {Object} [tagList] Tag definition
  42          */
  43         mw.rcfilters.Controller.prototype.initialize = function ( filterStructure, namespaceStructure, tagList ) {
  44                 var parsedSavedQueries,
  45                         displayConfig = mw.config.get( 'StructuredChangeFiltersDisplayConfig' ),
  46                         defaultSavedQueryExists = mw.config.get( 'wgStructuredChangeFiltersDefaultSavedQueryExists' ),
  47                         controller = this,
  48                         views = {},
  49                         items = [],
  50                         uri = new mw.Uri(),
  51                         $changesList = $( '.mw-changeslist' ).first().contents();
  52
  53                 // Prepare views
  54                 if ( namespaceStructure ) {
  55                         items = [];
  56                         $.each( namespaceStructure, function ( namespaceID, label ) {
  57                                 // Build and clean up the individual namespace items definition
  58                                 items.push( {
  59                                         name: namespaceID,
  60                                         label: label || mw.msg( 'blanknamespace' ),
  61                                         description: '',
  62                                         identifiers: [
  63                                                 ( namespaceID < 0 || namespaceID % 2 === 0 ) ?
  64                                                         'subject' : 'talk'
  65                                         ],
  66                                         cssClass: 'mw-changeslist-ns-' + namespaceID
  67                                 } );
  68                         } );
  69
  70                         views.namespaces = {
  71                                 title: mw.msg( 'namespaces' ),
  72                                 trigger: ':',
  73                                 groups: [ {
  74                                         // Group definition (single group)
  75                                         name: 'namespace', // parameter name is singular
  76                                         type: 'string_options',
  77                                         title: mw.msg( 'namespaces' ),
  78                                         labelPrefixKey: { 'default': 'rcfilters-tag-prefix-namespace', inverted: 'rcfilters-tag-prefix-namespace-inverted' },
  79                                         separator: ';',
  80                                         fullCoverage: true,
  81                                         filters: items
  82                                 },
  83                                 {
  84                                         name: 'invertGroup',
  85                                         type: 'boolean',
  86                                         hidden: true,
  87                                         filters: [ {
  88                                                 name: 'invert',
  89                                                 'default': '0'
  90                                         } ]
  91                                 } ]
  92                         };
  93                 }
  94                 if ( tagList ) {
  95                         views.tags = {
  96                                 title: mw.msg( 'rcfilters-view-tags' ),
  97                                 trigger: '#',
  98                                 groups: [ {
  99                                         // Group definition (single group)
 100                                         name: 'tagfilter', // Parameter name
 101                                         type: 'string_options',
 102                                         title: 'rcfilters-view-tags', // Message key
 103                                         labelPrefixKey: 'rcfilters-tag-prefix-tags',
 104                                         separator: '|',
 105                                         fullCoverage: false,
 106                                         filters: tagList
 107                                 } ]
 108                         };
 109                 }
 110
 111                 // Add parameter range operations
 112                 views.range = {
 113                         groups: [
 114                                 {
 115                                         name: 'limit',
 116                                         type: 'single_option',
 117                                         title: '', // Because it's a hidden group, this title actually appears nowhere
 118                                         hidden: true,
 119                                         allowArbitrary: true,
 120                                         validate: $.isNumeric,
 121                                         range: {
 122                                                 min: 0, // The server normalizes negative numbers to 0 results
 123                                                 max: 1000
 124                                         },
 125                                         sortFunc: function ( a, b ) { return Number( a.name ) - Number( b.name ); },
 126                                         'default': displayConfig.limitDefault,
 127                                         // Temporarily making this not sticky until we resolve the problem
 128                                         // with the misleading preference. Note that if this is to be permanent
 129                                         // we should remove all sticky behavior methods completely
 130                                         // See T172156
 131                                         // isSticky: true,
 132                                         excludedFromSavedQueries: true,
 133                                         filters: displayConfig.limitArray.map( function ( num ) {
 134                                                 return controller._createFilterDataFromNumber( num, num );
 135                                         } )
 136                                 },
 137                                 {
 138                                         name: 'days',
 139                                         type: 'single_option',
 140                                         title: '', // Because it's a hidden group, this title actually appears nowhere
 141                                         hidden: true,
 142                                         allowArbitrary: true,
 143                                         validate: $.isNumeric,
 144                                         range: {
 145                                                 min: 0,
 146                                                 max: displayConfig.maxDays
 147                                         },
 148                                         sortFunc: function ( a, b ) { return Number( a.name ) - Number( b.name ); },
 149                                         numToLabelFunc: function ( i ) {
 150                                                 return Number( i ) < 1 ?
 151                                                         ( Number( i ) * 24 ).toFixed( 2 ) :
 152                                                         Number( i );
 153                                         },
 154                                         'default': displayConfig.daysDefault,
 155                                         // Temporarily making this not sticky while limit is not sticky, see above
 156                                         // isSticky: true,
 157                                         excludedFromSavedQueries: true,
 158                                         filters: [
 159                                                 // Hours (1, 2, 6, 12)
 160                                                 0.04166, 0.0833, 0.25, 0.5
 161                                         // Days
 162                                         ].concat( displayConfig.daysArray )
 163                                                 .map( function ( num ) {
 164                                                         return controller._createFilterDataFromNumber(
 165                                                                 num,
 166                                                                 // Convert fractions of days to number of hours for the labels
 167                                                                 num < 1 ? Math.round( num * 24 ) : num
 168                                                         );
 169                                                 } )
 170                                 }
 171                         ]
 172                 };
 173
 174                 views.display = {
 175                         groups: [
 176                                 {
 177                                         name: 'display',
 178                                         type: 'boolean',
 179                                         title: '', // Because it's a hidden group, this title actually appears nowhere
 180                                         hidden: true,
 181                                         isSticky: true,
 182                                         filters: [
 183                                                 {
 184                                                         name: 'enhanced',
 185                                                         'default': String( mw.user.options.get( 'usenewrc', 0 ) )
 186                                                 }
 187                                         ]
 188                                 }
 189                         ]
 190                 };
 191
 192                 // Before we do anything, we need to see if we require additional items in the
 193                 // groups that have 'AllowArbitrary'. For the moment, those are only single_option
 194                 // groups; if we ever expand it, this might need further generalization:
 195                 $.each( views, function ( viewName, viewData ) {
 196                         viewData.groups.forEach( function ( groupData ) {
 197                                 var extraValues = [];
 198                                 if ( groupData.allowArbitrary ) {
 199                                         // If the value in the URI isn't in the group, add it
 200                                         if ( uri.query[ groupData.name ] !== undefined ) {
 201                                                 extraValues.push( uri.query[ groupData.name ] );
 202                                         }
 203                                         // If the default value isn't in the group, add it
 204                                         if ( groupData.default !== undefined ) {
 205                                                 extraValues.push( String( groupData.default ) );
 206                                         }
 207                                         controller.addNumberValuesToGroup( groupData, extraValues );
 208                                 }
 209                         } );
 210                 } );
 211
 212                 // Initialize the model
 213                 this.filtersModel.initializeFilters( filterStructure, views );
 214
 215                 this.uriProcessor = new mw.rcfilters.UriProcessor(
 216                         this.filtersModel
 217                 );
 218
 219                 if ( !mw.user.isAnon() ) {
 220                         try {
 221                                 parsedSavedQueries = JSON.parse( mw.user.options.get( this.savedQueriesPreferenceName ) || '{}' );
 222                         } catch ( err ) {
 223                                 parsedSavedQueries = {};
 224                         }
 225
 226                         // Initialize saved queries
 227                         this.savedQueriesModel.initialize( parsedSavedQueries );
 228                         if ( this.savedQueriesModel.isConverted() ) {
 229                                 // Since we know we converted, we're going to re-save
 230                                 // the queries so they are now migrated to the new format
 231                                 this._saveSavedQueries();
 232                         }
 233                 }
 234
 235                 // Check whether we need to load defaults.
 236                 // We do this by checking whether the current URI query
 237                 // contains any parameters recognized by the system.
 238                 // If it does, we load the given state.
 239                 // If it doesn't, we have no values at all, and we assume
 240                 // the user loads the base-page and we load defaults.
 241                 // Defaults should only be applied on load (if necessary)
 242                 // or on request
 243                 this.initializing = true;
 244
 245                 if ( defaultSavedQueryExists ) {
 246                         // This came from the server, meaning that we have a default
 247                         // saved query, but the server could not load it, probably because
 248                         // it was pre-conversion to the new format.
 249                         // We need to load this query again
 250                         this.applySavedQuery( this.savedQueriesModel.getDefault() );
 251                 } else {
 252                         // There are either recognized parameters in the URL
 253                         // or there are none, but there is also no default
 254                         // saved query (so defaults are from the backend)
 255                         // We want to update the state but not fetch results
 256                         // again
 257                         this.updateStateFromUrl( false );
 258
 259                         // Update the changes list with the existing data
 260                         // so it gets processed
 261                         this.changesListModel.update(
 262                                 $changesList.length ? $changesList : 'NO_RESULTS',
 263                                 $( 'fieldset.cloptions' ).first(),
 264                                 true // We're using existing DOM elements
 265                         );
 266                 }
 267
 268                 this.initializing = false;
 269                 this.switchView( 'default' );
 270
 271                 this.pollingRate = mw.config.get( 'StructuredChangeFiltersLiveUpdatePollingRate' );
 272                 if ( this.pollingRate ) {
 273                         this._scheduleLiveUpdate();
 274                 }
 275         };
 276
 277         /**
 278          * Create filter data from a number, for the filters that are numerical value
 279          *
 280          * @param {Number} num Number
 281          * @param {Number} numForDisplay Number for the label
 282          * @return {Object} Filter data
 283          */
 284         mw.rcfilters.Controller.prototype._createFilterDataFromNumber = function ( num, numForDisplay ) {
 285                 return {
 286                         name: String( num ),
 287                         label: mw.language.convertNumber( numForDisplay )
 288                 };
 289         };
 290
 291         /**
 292          * Add an arbitrary values to groups that allow arbitrary values
 293          *
 294          * @param {Object} groupData Group data
 295          * @param {string|string[]} arbitraryValues An array of arbitrary values to add to the group
 296          */
 297         mw.rcfilters.Controller.prototype.addNumberValuesToGroup = function ( groupData, arbitraryValues ) {
 298                 var controller = this,
 299                         normalizeWithinRange = function ( range, val ) {
 300                                 if ( val < range.min ) {
 301                                         return range.min; // Min
 302                                 } else if ( val >= range.max ) {
 303                                         return range.max; // Max
 304                                 }
 305                                 return val;
 306                         };
 307
 308                 arbitraryValues = Array.isArray( arbitraryValues ) ? arbitraryValues : [ arbitraryValues ];
 309
 310                 // Normalize the arbitrary values and the default value for a range
 311                 if ( groupData.range ) {
 312                         arbitraryValues = arbitraryValues.map( function ( val ) {
 313                                 return normalizeWithinRange( groupData.range, val );
 314                         } );
 315
 316                         // Normalize the default, since that's user defined
 317                         if ( groupData.default !== undefined ) {
 318                                 groupData.default = String( normalizeWithinRange( groupData.range, groupData.default ) );
 319                         }
 320                 }
 321
 322                 // This is only true for single_option group
 323                 // We assume these are the only groups that will allow for
 324                 // arbitrary, since it doesn't make any sense for the other
 325                 // groups.
 326                 arbitraryValues.forEach( function ( val ) {
 327                         if (
 328                                 // If the group allows for arbitrary data
 329                                 groupData.allowArbitrary &&
 330                                 // and it is single_option (or string_options, but we
 331                                 // don't have cases of those yet, nor do we plan to)
 332                                 groupData.type === 'single_option' &&
 333                                 // and, if there is a validate method and it passes on
 334                                 // the data
 335                                 ( !groupData.validate || groupData.validate( val ) ) &&
 336                                 // but if that value isn't already in the definition
 337                                 groupData.filters
 338                                         .map( function ( filterData ) {
 339                                                 return String( filterData.name );
 340                                         } )
 341                                         .indexOf( String( val ) ) === -1
 342                         ) {
 343                                 // Add the filter information
 344                                 groupData.filters.push( controller._createFilterDataFromNumber(
 345                                         val,
 346                                         groupData.numToLabelFunc ?
 347                                                 groupData.numToLabelFunc( val ) :
 348                                                 val
 349                                 ) );
 350
 351                                 // If there's a sort function set up, re-sort the values
 352                                 if ( groupData.sortFunc ) {
 353                                         groupData.filters.sort( groupData.sortFunc );
 354                                 }
 355                         }
 356                 } );
 357         };
 358
 359         /**
 360          * Switch the view of the filters model
 361          *
 362          * @param {string} view Requested view
 363          */
 364         mw.rcfilters.Controller.prototype.switchView = function ( view ) {
 365                 this.filtersModel.switchView( view );
 366         };
 367
 368         /**
 369          * Reset to default filters
 370          */
 371         mw.rcfilters.Controller.prototype.resetToDefaults = function () {
 372                 if ( this.applyParamChange( this._getDefaultParams() ) ) {
 373                         // Only update the changes list if there was a change to actual filters
 374                         this.updateChangesList();
 375                 }
 376         };
 377
 378         /**
 379          * Check whether the default values of the filters are all false.
 380          *
 381          * @return {boolean} Defaults are all false
 382          */
 383         mw.rcfilters.Controller.prototype.areDefaultsEmpty = function () {
 384                 return $.isEmptyObject( this._getDefaultParams( true ) );
 385         };
 386
 387         /**
 388          * Empty all selected filters
 389          */
 390         mw.rcfilters.Controller.prototype.emptyFilters = function () {
 391                 var highlightedFilterNames = this.filtersModel.getHighlightedItems()
 392                         .map( function ( filterItem ) { return { name: filterItem.getName() }; } );
 393
 394                 if ( this.applyParamChange( {} ) ) {
 395                         // Only update the changes list if there was a change to actual filters
 396                         this.updateChangesList();
 397                 }
 398
 399                 if ( highlightedFilterNames ) {
 400                         this._trackHighlight( 'clearAll', highlightedFilterNames );
 401                 }
 402         };
 403
 404         /**
 405          * Update the selected state of a filter
 406          *
 407          * @param {string} filterName Filter name
 408          * @param {boolean} [isSelected] Filter selected state
 409          */
 410         mw.rcfilters.Controller.prototype.toggleFilterSelect = function ( filterName, isSelected ) {
 411                 var filterItem = this.filtersModel.getItemByName( filterName );
 412
 413                 if ( !filterItem ) {
 414                         // If no filter was found, break
 415                         return;
 416                 }
 417
 418                 isSelected = isSelected === undefined ? !filterItem.isSelected() : isSelected;
 419
 420                 if ( filterItem.isSelected() !== isSelected ) {
 421                         this.filtersModel.toggleFilterSelected( filterName, isSelected );
 422
 423                         this.updateChangesList();
 424
 425                         // Check filter interactions
 426                         this.filtersModel.reassessFilterInteractions( filterItem );
 427                 }
 428         };
 429
 430         /**
 431          * Clear both highlight and selection of a filter
 432          *
 433          * @param {string} filterName Name of the filter item
 434          */
 435         mw.rcfilters.Controller.prototype.clearFilter = function ( filterName ) {
 436                 var filterItem = this.filtersModel.getItemByName( filterName ),
 437                         isHighlighted = filterItem.isHighlighted(),
 438                         isSelected = filterItem.isSelected();
 439
 440                 if ( isSelected || isHighlighted ) {
 441                         this.filtersModel.clearHighlightColor( filterName );
 442                         this.filtersModel.toggleFilterSelected( filterName, false );
 443
 444                         if ( isSelected ) {
 445                                 // Only update the changes list if the filter changed
 446                                 // its selection state. If it only changed its highlight
 447                                 // then don't reload
 448                                 this.updateChangesList();
 449                         }
 450
 451                         this.filtersModel.reassessFilterInteractions( filterItem );
 452
 453                         // Log filter grouping
 454                         this.trackFilterGroupings( 'removefilter' );
 455                 }
 456
 457                 if ( isHighlighted ) {
 458                         this._trackHighlight( 'clear', filterName );
 459                 }
 460         };
 461
 462         /**
 463          * Toggle the highlight feature on and off
 464          */
 465         mw.rcfilters.Controller.prototype.toggleHighlight = function () {
 466                 this.filtersModel.toggleHighlight();
 467                 this.uriProcessor.updateURL();
 468
 469                 if ( this.filtersModel.isHighlightEnabled() ) {
 470                         mw.hook( 'RcFilters.highlight.enable' ).fire();
 471                 }
 472         };
 473
 474         /**
 475          * Toggle the namespaces inverted feature on and off
 476          */
 477         mw.rcfilters.Controller.prototype.toggleInvertedNamespaces = function () {
 478                 this.filtersModel.toggleInvertedNamespaces();
 479
 480                 if (
 481                         this.filtersModel.getFiltersByView( 'namespaces' ).filter(
 482                                 function ( filterItem ) { return filterItem.isSelected(); }
 483                         ).length
 484                 ) {
 485                         // Only re-fetch results if there are namespace items that are actually selected
 486                         this.updateChangesList();
 487                 }
 488         };
 489
 490         /**
 491          * Set the highlight color for a filter item
 492          *
 493          * @param {string} filterName Name of the filter item
 494          * @param {string} color Selected color
 495          */
 496         mw.rcfilters.Controller.prototype.setHighlightColor = function ( filterName, color ) {
 497                 this.filtersModel.setHighlightColor( filterName, color );
 498                 this.uriProcessor.updateURL();
 499                 this._trackHighlight( 'set', { name: filterName, color: color } );
 500         };
 501
 502         /**
 503          * Clear highlight for a filter item
 504          *
 505          * @param {string} filterName Name of the filter item
 506          */
 507         mw.rcfilters.Controller.prototype.clearHighlightColor = function ( filterName ) {
 508                 this.filtersModel.clearHighlightColor( filterName );
 509                 this.uriProcessor.updateURL();
 510                 this._trackHighlight( 'clear', filterName );
 511         };
 512
 513         /**
 514          * Enable or disable live updates.
 515          * @param {boolean} enable True to enable, false to disable
 516          */
 517         mw.rcfilters.Controller.prototype.toggleLiveUpdate = function ( enable ) {
 518                 this.changesListModel.toggleLiveUpdate( enable );
 519                 if ( this.changesListModel.getLiveUpdate() && this.changesListModel.getNewChangesExist() ) {
 520                         this.updateChangesList( null, this.LIVE_UPDATE );
 521                 }
 522         };
 523
 524         /**
 525          * Set a timeout for the next live update.
 526          * @private
 527          */
 528         mw.rcfilters.Controller.prototype._scheduleLiveUpdate = function () {
 529                 setTimeout( this._doLiveUpdate.bind( this ), this.pollingRate * 1000 );
 530         };
 531
 532         /**
 533          * Perform a live update.
 534          * @private
 535          */
 536         mw.rcfilters.Controller.prototype._doLiveUpdate = function () {
 537                 if ( !this._shouldCheckForNewChanges() ) {
 538                         // skip this turn and check back later
 539                         this._scheduleLiveUpdate();
 540                         return;
 541                 }
 542
 543                 this._checkForNewChanges()
 544                         .then( function ( newChanges ) {
 545                                 if ( !this._shouldCheckForNewChanges() ) {
 546                                         // by the time the response is received,
 547                                         // it may not be appropriate anymore
 548                                         return;
 549                                 }
 550
 551                                 if ( newChanges ) {
 552                                         if ( this.changesListModel.getLiveUpdate() ) {
 553                                                 return this.updateChangesList( null, this.LIVE_UPDATE );
 554                                         } else {
 555                                                 this.changesListModel.setNewChangesExist( true );
 556                                         }
 557                                 }
 558                         }.bind( this ) )
 559                         .always( this._scheduleLiveUpdate.bind( this ) );
 560         };
 561
 562         /**
 563          * @return {boolean} It's appropriate to check for new changes now
 564          * @private
 565          */
 566         mw.rcfilters.Controller.prototype._shouldCheckForNewChanges = function () {
 567                 return !document.hidden &&
 568                         !this.filtersModel.hasConflict() &&
 569                         !this.changesListModel.getNewChangesExist() &&
 570                         !this.updatingChangesList &&
 571                         this.changesListModel.getNextFrom();
 572         };
 573
 574         /**
 575          * Check if new changes, newer than those currently shown, are available
 576          *
 577          * @return {jQuery.Promise} Promise object that resolves with a bool
 578          *      specifying if there are new changes or not
 579          *
 580          * @private
 581          */
 582         mw.rcfilters.Controller.prototype._checkForNewChanges = function () {
 583                 var params = {
 584                         limit: 1,
 585                         peek: 1, // bypasses ChangesList specific UI
 586                         from: this.changesListModel.getNextFrom()
 587                 };
 588                 return this._queryChangesList( 'liveUpdate', params ).then(
 589                         function ( data ) {
 590                                 // no result is 204 with the 'peek' param
 591                                 return data.status === 200;
 592                         }
 593                 );
 594         };
 595
 596         /**
 597          * Show the new changes
 598          *
 599          * @return {jQuery.Promise} Promise object that resolves after
 600          * fetching and showing the new changes
 601          */
 602         mw.rcfilters.Controller.prototype.showNewChanges = function () {
 603                 return this.updateChangesList( null, this.SHOW_NEW_CHANGES );
 604         };
 605
 606         /**
 607          * Save the current model state as a saved query
 608          *
 609          * @param {string} [label] Label of the saved query
 610          * @param {boolean} [setAsDefault=false] This query should be set as the default
 611          */
 612         mw.rcfilters.Controller.prototype.saveCurrentQuery = function ( label, setAsDefault ) {
 613                 // Add item
 614                 this.savedQueriesModel.addNewQuery(
 615                         label || mw.msg( 'rcfilters-savedqueries-defaultlabel' ),
 616                         this.filtersModel.getCurrentParameterState( true ),
 617                         setAsDefault
 618                 );
 619
 620                 // Save item
 621                 this._saveSavedQueries();
 622         };
 623
 624         /**
 625          * Remove a saved query
 626          *
 627          * @param {string} queryID Query id
 628          */
 629         mw.rcfilters.Controller.prototype.removeSavedQuery = function ( queryID ) {
 630                 this.savedQueriesModel.removeQuery( queryID );
 631
 632                 this._saveSavedQueries();
 633         };
 634
 635         /**
 636          * Rename a saved query
 637          *
 638          * @param {string} queryID Query id
 639          * @param {string} newLabel New label for the query
 640          */
 641         mw.rcfilters.Controller.prototype.renameSavedQuery = function ( queryID, newLabel ) {
 642                 var queryItem = this.savedQueriesModel.getItemByID( queryID );
 643
 644                 if ( queryItem ) {
 645                         queryItem.updateLabel( newLabel );
 646                 }
 647                 this._saveSavedQueries();
 648         };
 649
 650         /**
 651          * Set a saved query as default
 652          *
 653          * @param {string} queryID Query Id. If null is given, default
 654          *  query is reset.
 655          */
 656         mw.rcfilters.Controller.prototype.setDefaultSavedQuery = function ( queryID ) {
 657                 this.savedQueriesModel.setDefault( queryID );
 658                 this._saveSavedQueries();
 659         };
 660
 661         /**
 662          * Load a saved query
 663          *
 664          * @param {string} queryID Query id
 665          */
 666         mw.rcfilters.Controller.prototype.applySavedQuery = function ( queryID ) {
 667                 var currentMatchingQuery,
 668                         params = this.savedQueriesModel.getItemParams( queryID );
 669
 670                 currentMatchingQuery = this.findQueryMatchingCurrentState();
 671
 672                 if (
 673                         currentMatchingQuery &&
 674                         currentMatchingQuery.getID() === queryID
 675                 ) {
 676                         // If the query we want to load is the one that is already
 677                         // loaded, don't reload it
 678                         return;
 679                 }
 680
 681                 if ( this.applyParamChange( params ) ) {
 682                         // Update changes list only if there was a difference in filter selection
 683                         this.updateChangesList();
 684                 }
 685
 686                 // Log filter grouping
 687                 this.trackFilterGroupings( 'savedfilters' );
 688         };
 689
 690         /**
 691          * Check whether the current filter and highlight state exists
 692          * in the saved queries model.
 693          *
 694          * @return {boolean} Query exists
 695          */
 696         mw.rcfilters.Controller.prototype.findQueryMatchingCurrentState = function () {
 697                 return this.savedQueriesModel.findMatchingQuery(
 698                         this.filtersModel.getCurrentParameterState( true )
 699                 );
 700         };
 701
 702         /**
 703          * Save the current state of the saved queries model with all
 704          * query item representation in the user settings.
 705          */
 706         mw.rcfilters.Controller.prototype._saveSavedQueries = function () {
 707                 var stringified, oldPrefValue,
 708                         backupPrefName = this.savedQueriesPreferenceName + '-versionbackup',
 709                         state = this.savedQueriesModel.getState();
 710
 711                 // Stringify state
 712                 stringified = JSON.stringify( state );
 713
 714                 if ( $.byteLength( stringified ) > 65535 ) {
 715                         // Sanity check, since the preference can only hold that.
 716                         return;
 717                 }
 718
 719                 if ( !this.wereSavedQueriesSaved && this.savedQueriesModel.isConverted() ) {
 720                         // The queries were converted from the previous version
 721                         // Keep the old string in the [prefname]-versionbackup
 722                         oldPrefValue = mw.user.options.get( this.savedQueriesPreferenceName );
 723
 724                         // Save the old preference in the backup preference
 725                         new mw.Api().saveOption( backupPrefName, oldPrefValue );
 726                         // Update the preference for this session
 727                         mw.user.options.set( backupPrefName, oldPrefValue );
 728                 }
 729
 730                 // Save the preference
 731                 new mw.Api().saveOption( this.savedQueriesPreferenceName, stringified );
 732                 // Update the preference for this session
 733                 mw.user.options.set( this.savedQueriesPreferenceName, stringified );
 734
 735                 // Tag as already saved so we don't do this again
 736                 this.wereSavedQueriesSaved = true;
 737         };
 738
 739         /**
 740          * Update sticky preferences with current model state
 741          */
 742         mw.rcfilters.Controller.prototype.updateStickyPreferences = function () {
 743                 // Update default sticky values with selected, whether they came from
 744                 // the initial defaults or from the URL value that is being normalized
 745                 this.updateDaysDefault( this.filtersModel.getGroup( 'days' ).getSelectedItems()[ 0 ].getParamName() );
 746                 this.updateLimitDefault( this.filtersModel.getGroup( 'limit' ).getSelectedItems()[ 0 ].getParamName() );
 747
 748                 // TODO: Make these automatic by having the model go over sticky
 749                 // items and update their default values automatically
 750         };
 751
 752         /**
 753          * Update the limit default value
 754          *
 755          * param {number} newValue New value
 756          */
 757         mw.rcfilters.Controller.prototype.updateLimitDefault = function ( /* newValue */ ) {
 758                 // HACK: Temporarily remove this from being sticky
 759                 // See T172156
 760
 761                 /*
 762                 if ( !$.isNumeric( newValue ) ) {
 763                         return;
 764                 }
 765
 766                 newValue = Number( newValue );
 767
 768                 if ( mw.user.options.get( 'rcfilters-rclimit' ) !== newValue ) {
 769                         // Save the preference
 770                         new mw.Api().saveOption( 'rcfilters-rclimit', newValue );
 771                         // Update the preference for this session
 772                         mw.user.options.set( 'rcfilters-rclimit', newValue );
 773                 }
 774                 */
 775                 return;
 776         };
 777
 778         /**
 779          * Update the days default value
 780          *
 781          * param {number} newValue New value
 782          */
 783         mw.rcfilters.Controller.prototype.updateDaysDefault = function ( /* newValue */ ) {
 784                 // HACK: Temporarily remove this from being sticky
 785                 // See T172156
 786
 787                 /*
 788                 if ( !$.isNumeric( newValue ) ) {
 789                         return;
 790                 }
 791
 792                 newValue = Number( newValue );
 793
 794                 if ( mw.user.options.get( 'rcdays' ) !== newValue ) {
 795                         // Save the preference
 796                         new mw.Api().saveOption( 'rcdays', newValue );
 797                         // Update the preference for this session
 798                         mw.user.options.set( 'rcdays', newValue );
 799                 }
 800                 */
 801                 return;
 802         };
 803
 804         /**
 805          * Update the group by page default value
 806          *
 807          * @param {number} newValue New value
 808          */
 809         mw.rcfilters.Controller.prototype.updateGroupByPageDefault = function ( newValue ) {
 810                 if ( !$.isNumeric( newValue ) ) {
 811                         return;
 812                 }
 813
 814                 newValue = Number( newValue );
 815
 816                 if ( mw.user.options.get( 'usenewrc' ) !== newValue ) {
 817                         // Save the preference
 818                         new mw.Api().saveOption( 'usenewrc', newValue );
 819                         // Update the preference for this session
 820                         mw.user.options.set( 'usenewrc', newValue );
 821                 }
 822         };
 823
 824         /**
 825          * Synchronize the URL with the current state of the filters
 826          * without adding an history entry.
 827          */
 828         mw.rcfilters.Controller.prototype.replaceUrl = function () {
 829                 this.uriProcessor.replaceUpdatedUri();
 830         };
 831
 832         /**
 833          * Update filter state (selection and highlighting) based
 834          * on current URL values.
 835          *
 836          * @param {boolean} [fetchChangesList=true] Fetch new results into the changes
 837          *  list based on the updated model.
 838          */
 839         mw.rcfilters.Controller.prototype.updateStateFromUrl = function ( fetchChangesList ) {
 840                 fetchChangesList = fetchChangesList === undefined ? true : !!fetchChangesList;
 841
 842                 this.uriProcessor.updateModelBasedOnQuery( new mw.Uri().query );
 843
 844                 // Update the sticky preferences, in case we received a value
 845                 // from the URL
 846                 this.updateStickyPreferences();
 847
 848                 // Only update and fetch new results if it is requested
 849                 if ( fetchChangesList ) {
 850                         this.updateChangesList();
 851                 }
 852         };
 853
 854         /**
 855          * Update the list of changes and notify the model
 856          *
 857          * @param {Object} [params] Extra parameters to add to the API call
 858          * @param {string} [updateMode='filterChange'] One of 'filterChange', 'liveUpdate', 'showNewChanges', 'markSeen'
 859          * @return {jQuery.Promise} Promise that is resolved when the update is complete
 860          */
 861         mw.rcfilters.Controller.prototype.updateChangesList = function ( params, updateMode ) {
 862                 updateMode = updateMode === undefined ? this.FILTER_CHANGE : updateMode;
 863
 864                 if ( updateMode === this.FILTER_CHANGE ) {
 865                         this.uriProcessor.updateURL( params );
 866                 }
 867                 if ( updateMode === this.FILTER_CHANGE || updateMode === this.SHOW_NEW_CHANGES ) {
 868                         this.changesListModel.invalidate();
 869                 }
 870                 this.changesListModel.setNewChangesExist( false );
 871                 this.updatingChangesList = true;
 872                 return this._fetchChangesList()
 873                         .then(
 874                                 // Success
 875                                 function ( pieces ) {
 876                                         var $changesListContent = pieces.changes,
 877                                                 $fieldset = pieces.fieldset;
 878                                         this.changesListModel.update(
 879                                                 $changesListContent,
 880                                                 $fieldset,
 881                                                 false,
 882                                                 // separator between old and new changes
 883                                                 updateMode === this.SHOW_NEW_CHANGES || updateMode === this.LIVE_UPDATE
 884                                         );
 885                                 }.bind( this )
 886                                 // Do nothing for failure
 887                         )
 888                         .always( function () {
 889                                 this.updatingChangesList = false;
 890                         }.bind( this ) );
 891         };
 892
 893         /**
 894          * Get an object representing the default parameter state, whether
 895          * it is from the model defaults or from the saved queries.
 896          *
 897          * @param {boolean} [excludeHiddenParams] Exclude hidden and sticky params
 898          * @return {Object} Default parameters
 899          */
 900         mw.rcfilters.Controller.prototype._getDefaultParams = function ( excludeHiddenParams ) {
 901                 if ( this.savedQueriesModel.getDefault() ) {
 902                         return this.savedQueriesModel.getDefaultParams( excludeHiddenParams );
 903                 } else {
 904                         return this.filtersModel.getDefaultParams( excludeHiddenParams );
 905                 }
 906         };
 907
 908         /**
 909          * Query the list of changes from the server for the current filters
 910          *
 911          * @param {string} counterId Id for this request. To allow concurrent requests
 912          *  not to invalidate each other.
 913          * @param {Object} [params={}] Parameters to add to the query
 914          *
 915          * @return {jQuery.Promise} Promise object resolved with { content, status }
 916          */
 917         mw.rcfilters.Controller.prototype._queryChangesList = function ( counterId, params ) {
 918                 var uri = this.uriProcessor.getUpdatedUri(),
 919                         stickyParams = this.filtersModel.getStickyParamsValues(),
 920                         requestId,
 921                         latestRequest;
 922
 923                 params = params || {};
 924                 params.action = 'render'; // bypasses MW chrome
 925
 926                 uri.extend( params );
 927
 928                 this.requestCounter[ counterId ] = this.requestCounter[ counterId ] || 0;
 929                 requestId = ++this.requestCounter[ counterId ];
 930                 latestRequest = function () {
 931                         return requestId === this.requestCounter[ counterId ];
 932                 }.bind( this );
 933
 934                 // Sticky parameters override the URL params
 935                 // this is to make sure that whether we represent
 936                 // the sticky params in the URL or not (they may
 937                 // be normalized out) the sticky parameters are
 938                 // always being sent to the server with their
 939                 // current/default values
 940                 uri.extend( stickyParams );
 941
 942                 return $.ajax( uri.toString(), { contentType: 'html' } )
 943                         .then(
 944                                 function ( content, message, jqXHR ) {
 945                                         if ( !latestRequest() ) {
 946                                                 return $.Deferred().reject();
 947                                         }
 948                                         return {
 949                                                 content: content,
 950                                                 status: jqXHR.status
 951                                         };
 952                                 },
 953                                 // RC returns 404 when there is no results
 954                                 function ( jqXHR ) {
 955                                         if ( latestRequest() ) {
 956                                                 return $.Deferred().resolve(
 957                                                         {
 958                                                                 content: jqXHR.responseText,
 959                                                                 status: jqXHR.status
 960                                                         }
 961                                                 ).promise();
 962                                         }
 963                                 }
 964                         );
 965         };
 966
 967         /**
 968          * Fetch the list of changes from the server for the current filters
 969          *
 970          * @return {jQuery.Promise} Promise object that will resolve with the changes list
 971          *  and the fieldset.
 972          */
 973         mw.rcfilters.Controller.prototype._fetchChangesList = function () {
 974                 return this._queryChangesList( 'updateChangesList' )
 975                         .then(
 976                                 function ( data ) {
 977                                         var $parsed = $( '<div>' ).append( $( $.parseHTML( data.content ) ) ),
 978                                                 pieces = {
 979                                                         // Changes list
 980                                                         changes: $parsed.find( '.mw-changeslist' ).first().contents(),
 981                                                         // Fieldset
 982                                                         fieldset: $parsed.find( 'fieldset.cloptions' ).first()
 983                                                 };
 984
 985                                         if ( pieces.changes.length === 0 ) {
 986                                                 pieces.changes = 'NO_RESULTS';
 987                                         }
 988
 989                                         return pieces;
 990                                 }
 991                         );
 992         };
 993
 994         /**
 995          * Track usage of highlight feature
 996          *
 997          * @param {string} action
 998          * @param {Array|Object|string} filters
 999          */
1000         mw.rcfilters.Controller.prototype._trackHighlight = function ( action, filters ) {
1001                 filters = typeof filters === 'string' ? { name: filters } : filters;
1002                 filters = !Array.isArray( filters ) ? [ filters ] : filters;
1003                 mw.track(
1004                         'event.ChangesListHighlights',
1005                         {
1006                                 action: action,
1007                                 filters: filters,
1008                                 userId: mw.user.getId()
1009                         }
1010                 );
1011         };
1012
1013         /**
1014          * Track filter grouping usage
1015          *
1016          * @param {string} action Action taken
1017          */
1018         mw.rcfilters.Controller.prototype.trackFilterGroupings = function ( action ) {
1019                 var controller = this,
1020                         rightNow = new Date().getTime(),
1021                         randomIdentifier = String( mw.user.sessionId() ) + String( rightNow ) + String( Math.random() ),
1022                         // Get all current filters
1023                         filters = this.filtersModel.getSelectedItems().map( function ( item ) {
1024                                 return item.getName();
1025                         } );
1026
1027                 action = action || 'filtermenu';
1028
1029                 // Check if these filters were the ones we just logged previously
1030                 // (Don't log the same grouping twice, in case the user opens/closes)
1031                 // the menu without action, or with the same result
1032                 if (
1033                         // Only log if the two arrays are different in size
1034                         filters.length !== this.prevLoggedItems.length ||
1035                         // Or if any filters are not the same as the cached filters
1036                         filters.some( function ( filterName ) {
1037                                 return controller.prevLoggedItems.indexOf( filterName ) === -1;
1038                         } ) ||
1039                         // Or if any cached filters are not the same as given filters
1040                         this.prevLoggedItems.some( function ( filterName ) {
1041                                 return filters.indexOf( filterName ) === -1;
1042                         } )
1043                 ) {
1044                         filters.forEach( function ( filterName ) {
1045                                 mw.track(
1046                                         'event.ChangesListFilterGrouping',
1047                                         {
1048                                                 action: action,
1049                                                 groupIdentifier: randomIdentifier,
1050                                                 filter: filterName,
1051                                                 userId: mw.user.getId()
1052                                         }
1053                                 );
1054                         } );
1055
1056                         // Cache the filter names
1057                         this.prevLoggedItems = filters;
1058                 }
1059         };
1060
1061         /**
1062          * Apply a change of parameters to the model state, and check whether
1063          * the new state is different than the old state.
1064          *
1065          * @param  {Object} newParamState New parameter state to apply
1066          * @return {boolean} New applied model state is different than the previous state
1067          */
1068         mw.rcfilters.Controller.prototype.applyParamChange = function ( newParamState ) {
1069                 var after,
1070                         before = this.filtersModel.getSelectedState();
1071
1072                 this.filtersModel.updateStateFromParams( newParamState );
1073
1074                 after = this.filtersModel.getSelectedState();
1075
1076                 return !OO.compare( before, after );
1077         };
1078
1079         /**
1080          * Mark all changes as seen on Watchlist
1081          */
1082         mw.rcfilters.Controller.prototype.markAllChangesAsSeen = function () {
1083                 var api = new mw.Api();
1084                 api.postWithToken( 'csrf', {
1085                         formatversion: 2,
1086                         action: 'setnotificationtimestamp',
1087                         entirewatchlist: true
1088                 } ).then( function () {
1089                         this.updateChangesList( null, 'markSeen' );
1090                 }.bind( this ) );
1091         };
1092 }( mediaWiki, jQuery ) );