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

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