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