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