2 /* eslint no-underscore-dangle: "off" */
4 * Controller for the filters in Recent Changes
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
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
;
20 this.requestCounter
= {};
21 this.baseFilterState
= {};
22 this.uriProcessor
= null;
23 this.initializing
= false;
25 this.prevLoggedItems
= [];
27 this.FILTER_CHANGE
= 'filterChange';
28 this.SHOW_NEW_CHANGES
= 'showNewChanges';
29 this.LIVE_UPDATE
= 'liveUpdate';
33 OO
.initClass( mw
.rcfilters
.Controller
);
36 * Initialize the filter and parameter states
38 * @param {Array} filterStructure Filter definition and structure for the model
39 * @param {Object} [namespaceStructure] Namespace definition
40 * @param {Object} [tagList] Tag definition
42 mw
.rcfilters
.Controller
.prototype.initialize = function ( filterStructure
, namespaceStructure
, tagList
) {
43 var parsedSavedQueries
,
44 displayConfig
= mw
.config
.get( 'StructuredChangeFiltersDisplayConfig' ),
49 $changesList
= $( '.mw-changeslist' ).first().contents();
52 if ( namespaceStructure
) {
54 $.each( namespaceStructure
, function ( namespaceID
, label
) {
55 // Build and clean up the individual namespace items definition
58 label
: label
|| mw
.msg( 'blanknamespace' ),
61 ( namespaceID
< 0 || namespaceID
% 2 === 0 ) ?
64 cssClass
: 'mw-changeslist-ns-' + namespaceID
69 title
: mw
.msg( 'namespaces' ),
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' },
85 title
: mw
.msg( 'rcfilters-view-tags' ),
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',
100 // Add parameter range operations
105 type
: 'single_option',
106 title
: '', // Because it's a hidden group, this title actually appears nowhere
108 allowArbitrary
: true,
109 validate
: $.isNumeric
,
111 min
: 0, // The server normalizes negative numbers to 0 results
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
121 excludedFromSavedQueries
: true,
122 filters
: displayConfig
.limitArray
.map( function ( num
) {
123 return controller
._createFilterDataFromNumber( num
, num
);
128 type
: 'single_option',
129 title
: '', // Because it's a hidden group, this title actually appears nowhere
131 allowArbitrary
: true,
132 validate
: $.isNumeric
,
135 max
: displayConfig
.maxDays
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 ) :
143 'default': displayConfig
.daysDefault
,
144 // Temporarily making this not sticky while limit is not sticky, see above
146 excludedFromSavedQueries
: true,
148 // Hours (1, 2, 6, 12)
149 0.04166, 0.0833, 0.25, 0.5
151 ].concat( displayConfig
.daysArray
)
152 .map( function ( num
) {
153 return controller
._createFilterDataFromNumber(
155 // Convert fractions of days to number of hours for the labels
156 num
< 1 ? Math
.round( num
* 24 ) : num
168 title
: '', // Because it's a hidden group, this title actually appears nowhere
174 'default': String( mw
.user
.options
.get( 'usenewrc', 0 ) )
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
] );
192 // If the default value isn't in the group, add it
193 if ( groupData
.default !== undefined ) {
194 extraValues
.push( String( groupData
.default ) );
196 controller
.addNumberValuesToGroup( groupData
, extraValues
);
201 // Initialize the model
202 this.filtersModel
.initializeFilters( filterStructure
, views
);
204 this._buildBaseFilterState();
206 this.uriProcessor
= new mw
.rcfilters
.UriProcessor(
210 if ( !mw
.user
.isAnon() ) {
212 parsedSavedQueries
= JSON
.parse( mw
.user
.options
.get( this.savedQueriesPreferenceName
) || '{}' );
214 parsedSavedQueries
= {};
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(
222 this._getBaseFilterState(),
223 // This is for backwards compatibility - delete all excluded filter states
224 Object
.keys( this.filtersModel
.getExcludedFiltersState() )
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)
236 this.initializing
= true;
238 !mw
.user
.isAnon() && this.savedQueriesModel
.getDefault() &&
239 !this.uriProcessor
.doesQueryContainRecognizedParams( uri
.query
)
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() );
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
252 this.updateStateFromUrl( false );
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
263 this.initializing
= false;
264 this.switchView( 'default' );
266 this._scheduleLiveUpdate();
270 * Create filter data from a number, for the filters that are numerical value
272 * @param {Number} num Number
273 * @param {Number} numForDisplay Number for the label
274 * @return {Object} Filter data
276 mw
.rcfilters
.Controller
.prototype._createFilterDataFromNumber = function ( num
, numForDisplay
) {
279 label
: mw
.language
.convertNumber( numForDisplay
)
284 * Add an arbitrary values to groups that allow arbitrary values
286 * @param {Object} groupData Group data
287 * @param {string|string[]} arbitraryValues An array of arbitrary values to add to the group
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
300 arbitraryValues
= Array
.isArray( arbitraryValues
) ? arbitraryValues
: [ arbitraryValues
];
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
);
308 // Normalize the default, since that's user defined
309 if ( groupData
.default !== undefined ) {
310 groupData
.default = String( normalizeWithinRange( groupData
.range
, groupData
.default ) );
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
318 arbitraryValues
.forEach( function ( val
) {
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
327 ( !groupData
.validate
|| groupData
.validate( val
) ) &&
328 // but if that value isn't already in the definition
330 .map( function ( filterData
) {
331 return String( filterData
.name
);
333 .indexOf( String( val
) ) === -1
335 // Add the filter information
336 groupData
.filters
.push( controller
._createFilterDataFromNumber(
338 groupData
.numToLabelFunc
?
339 groupData
.numToLabelFunc( val
) :
343 // If there's a sort function set up, re-sort the values
344 if ( groupData
.sortFunc
) {
345 groupData
.filters
.sort( groupData
.sortFunc
);
352 * Switch the view of the filters model
354 * @param {string} view Requested view
356 mw
.rcfilters
.Controller
.prototype.switchView = function ( view
) {
357 this.filtersModel
.switchView( view
);
361 * Reset to default filters
363 mw
.rcfilters
.Controller
.prototype.resetToDefaults = function () {
364 this.uriProcessor
.updateModelBasedOnQuery( this._getDefaultParams() );
366 this.updateChangesList();
370 * Check whether the default values of the filters are all false.
372 * @return {boolean} Defaults are all false
374 mw
.rcfilters
.Controller
.prototype.areDefaultsEmpty = function () {
375 var defaultFilters
= this.filtersModel
.getFiltersFromParameters( this._getDefaultParams() );
377 this._deleteExcludedValuesFromFilterState( defaultFilters
);
379 // Defaults can change in a session, so we need to do this every time
380 return Object
.keys( defaultFilters
).every( function ( filterName
) {
381 return !defaultFilters
[ filterName
];
386 * Empty all selected filters
388 mw
.rcfilters
.Controller
.prototype.emptyFilters = function () {
389 var highlightedFilterNames
= this.filtersModel
390 .getHighlightedItems()
391 .map( function ( filterItem
) { return { name
: filterItem
.getName() }; } );
393 this.filtersModel
.emptyAllFilters();
394 this.filtersModel
.clearAllHighlightColors();
395 // Check all filter interactions
396 this.filtersModel
.reassessFilterInteractions();
398 this.updateChangesList();
400 if ( highlightedFilterNames
) {
401 this._trackHighlight( 'clearAll', highlightedFilterNames
);
406 * Update the selected state of a filter
408 * @param {string} filterName Filter name
409 * @param {boolean} [isSelected] Filter selected state
411 mw
.rcfilters
.Controller
.prototype.toggleFilterSelect = function ( filterName
, isSelected
) {
412 var filterItem
= this.filtersModel
.getItemByName( filterName
);
415 // If no filter was found, break
419 isSelected
= isSelected
=== undefined ? !filterItem
.isSelected() : isSelected
;
421 if ( filterItem
.isSelected() !== isSelected
) {
422 this.filtersModel
.toggleFilterSelected( filterName
, isSelected
);
424 this.updateChangesList();
426 // Check filter interactions
427 this.filtersModel
.reassessFilterInteractions( filterItem
);
432 * Clear both highlight and selection of a filter
434 * @param {string} filterName Name of the filter item
436 mw
.rcfilters
.Controller
.prototype.clearFilter = function ( filterName
) {
437 var filterItem
= this.filtersModel
.getItemByName( filterName
),
438 isHighlighted
= filterItem
.isHighlighted();
440 if ( filterItem
.isSelected() || isHighlighted
) {
441 this.filtersModel
.clearHighlightColor( filterName
);
442 this.filtersModel
.toggleFilterSelected( filterName
, false );
443 this.updateChangesList();
444 this.filtersModel
.reassessFilterInteractions( filterItem
);
446 // Log filter grouping
447 this.trackFilterGroupings( 'removefilter' );
450 if ( isHighlighted
) {
451 this._trackHighlight( 'clear', filterName
);
456 * Toggle the highlight feature on and off
458 mw
.rcfilters
.Controller
.prototype.toggleHighlight = function () {
459 this.filtersModel
.toggleHighlight();
462 if ( this.filtersModel
.isHighlightEnabled() ) {
463 mw
.hook( 'RcFilters.highlight.enable' ).fire();
468 * Toggle the namespaces inverted feature on and off
470 mw
.rcfilters
.Controller
.prototype.toggleInvertedNamespaces = function () {
471 this.filtersModel
.toggleInvertedNamespaces();
474 this.filtersModel
.getFiltersByView( 'namespaces' ).filter(
475 function ( filterItem
) { return filterItem
.isSelected(); }
478 // Only re-fetch results if there are namespace items that are actually selected
479 this.updateChangesList();
484 * Set the highlight color for a filter item
486 * @param {string} filterName Name of the filter item
487 * @param {string} color Selected color
489 mw
.rcfilters
.Controller
.prototype.setHighlightColor = function ( filterName
, color
) {
490 this.filtersModel
.setHighlightColor( filterName
, color
);
492 this._trackHighlight( 'set', { name
: filterName
, color
: color
} );
496 * Clear highlight for a filter item
498 * @param {string} filterName Name of the filter item
500 mw
.rcfilters
.Controller
.prototype.clearHighlightColor = function ( filterName
) {
501 this.filtersModel
.clearHighlightColor( filterName
);
503 this._trackHighlight( 'clear', filterName
);
507 * Enable or disable live updates.
508 * @param {boolean} enable True to enable, false to disable
510 mw
.rcfilters
.Controller
.prototype.toggleLiveUpdate = function ( enable
) {
511 this.changesListModel
.toggleLiveUpdate( enable
);
512 if ( this.changesListModel
.getLiveUpdate() && this.changesListModel
.getNewChangesExist() ) {
513 this.updateChangesList( null, this.LIVE_UPDATE
);
518 * Set a timeout for the next live update.
521 mw
.rcfilters
.Controller
.prototype._scheduleLiveUpdate = function () {
522 setTimeout( this._doLiveUpdate
.bind( this ), 3000 );
526 * Perform a live update.
529 mw
.rcfilters
.Controller
.prototype._doLiveUpdate = function () {
530 if ( !this._shouldCheckForNewChanges() ) {
531 // skip this turn and check back later
532 this._scheduleLiveUpdate();
536 this._checkForNewChanges()
537 .then( function ( newChanges
) {
538 if ( !this._shouldCheckForNewChanges() ) {
539 // by the time the response is received,
540 // it may not be appropriate anymore
545 if ( this.changesListModel
.getLiveUpdate() ) {
546 return this.updateChangesList( null, this.LIVE_UPDATE
);
548 this.changesListModel
.setNewChangesExist( true );
552 .always( this._scheduleLiveUpdate
.bind( this ) );
556 * @return {boolean} It's appropriate to check for new changes now
559 mw
.rcfilters
.Controller
.prototype._shouldCheckForNewChanges = function () {
560 return !document
.hidden
&&
561 !this.filtersModel
.hasConflict() &&
562 !this.changesListModel
.getNewChangesExist() &&
563 !this.updatingChangesList
&&
564 this.changesListModel
.getNextFrom();
568 * Check if new changes, newer than those currently shown, are available
570 * @return {jQuery.Promise} Promise object that resolves with a bool
571 * specifying if there are new changes or not
575 mw
.rcfilters
.Controller
.prototype._checkForNewChanges = function () {
578 peek
: 1, // bypasses ChangesList specific UI
579 from: this.changesListModel
.getNextFrom()
581 return this._queryChangesList( 'liveUpdate', params
).then(
583 // no result is 204 with the 'peek' param
584 return data
.status
=== 200;
590 * Show the new changes
592 * @return {jQuery.Promise} Promise object that resolves after
593 * fetching and showing the new changes
595 mw
.rcfilters
.Controller
.prototype.showNewChanges = function () {
596 return this.updateChangesList( null, this.SHOW_NEW_CHANGES
);
600 * Save the current model state as a saved query
602 * @param {string} [label] Label of the saved query
603 * @param {boolean} [setAsDefault=false] This query should be set as the default
605 mw
.rcfilters
.Controller
.prototype.saveCurrentQuery = function ( label
, setAsDefault
) {
607 highlightedItems
= {},
608 highlightEnabled
= this.filtersModel
.isHighlightEnabled(),
609 selectedState
= this.filtersModel
.getSelectedState();
611 // Prepare highlights
612 this.filtersModel
.getHighlightedItems().forEach( function ( item
) {
613 highlightedItems
[ item
.getName() ] = highlightEnabled
?
614 item
.getHighlightColor() : null;
616 // These are filter states; highlight is stored as boolean
617 highlightedItems
.highlight
= this.filtersModel
.isHighlightEnabled();
619 // Delete all excluded filters
620 this._deleteExcludedValuesFromFilterState( selectedState
);
623 queryID
= this.savedQueriesModel
.addNewQuery(
624 label
|| mw
.msg( 'rcfilters-savedqueries-defaultlabel' ),
626 filters
: selectedState
,
627 highlights
: highlightedItems
,
628 invert
: this.filtersModel
.areNamespacesInverted()
632 if ( setAsDefault
) {
633 this.savedQueriesModel
.setDefault( queryID
);
637 this._saveSavedQueries();
641 * Remove a saved query
643 * @param {string} queryID Query id
645 mw
.rcfilters
.Controller
.prototype.removeSavedQuery = function ( queryID
) {
646 this.savedQueriesModel
.removeQuery( queryID
);
648 this._saveSavedQueries();
652 * Rename a saved query
654 * @param {string} queryID Query id
655 * @param {string} newLabel New label for the query
657 mw
.rcfilters
.Controller
.prototype.renameSavedQuery = function ( queryID
, newLabel
) {
658 var queryItem
= this.savedQueriesModel
.getItemByID( queryID
);
661 queryItem
.updateLabel( newLabel
);
663 this._saveSavedQueries();
667 * Set a saved query as default
669 * @param {string} queryID Query Id. If null is given, default
672 mw
.rcfilters
.Controller
.prototype.setDefaultSavedQuery = function ( queryID
) {
673 this.savedQueriesModel
.setDefault( queryID
);
674 this._saveSavedQueries();
680 * @param {string} queryID Query id
682 mw
.rcfilters
.Controller
.prototype.applySavedQuery = function ( queryID
) {
683 var data
, highlights
,
684 queryItem
= this.savedQueriesModel
.getItemByID( queryID
),
685 currentMatchingQuery
= this.findQueryMatchingCurrentState();
690 // If there's already a query, don't reload it
691 // if it's the same as the one that already exists
692 !currentMatchingQuery
||
693 currentMatchingQuery
.getID() !== queryItem
.getID()
696 data
= queryItem
.getData();
697 highlights
= data
.highlights
;
699 // Backwards compatibility; initial version mispelled 'highlight' with 'highlights'
700 highlights
.highlight
= highlights
.highlights
|| highlights
.highlight
;
702 // Update model state from filters
703 this.filtersModel
.toggleFiltersSelected(
704 // Merge filters with excluded values
705 $.extend( true, {}, data
.filters
, this.filtersModel
.getExcludedFiltersState() )
708 // Update namespace inverted property
709 this.filtersModel
.toggleInvertedNamespaces( !!Number( data
.invert
) );
711 // Update highlight state
712 this.filtersModel
.toggleHighlight( !!Number( highlights
.highlight
) );
713 this.filtersModel
.getItems().forEach( function ( filterItem
) {
714 var color
= highlights
[ filterItem
.getName() ];
716 filterItem
.setHighlightColor( color
);
718 filterItem
.clearHighlightColor();
722 // Check all filter interactions
723 this.filtersModel
.reassessFilterInteractions();
725 this.updateChangesList();
727 // Log filter grouping
728 this.trackFilterGroupings( 'savedfilters' );
733 * Check whether the current filter and highlight state exists
734 * in the saved queries model.
736 * @return {boolean} Query exists
738 mw
.rcfilters
.Controller
.prototype.findQueryMatchingCurrentState = function () {
739 var highlightedItems
= {},
740 selectedState
= this.filtersModel
.getSelectedState();
742 // Prepare highlights of the current query
743 this.filtersModel
.getItemsSupportingHighlights().forEach( function ( item
) {
744 highlightedItems
[ item
.getName() ] = item
.getHighlightColor();
746 highlightedItems
.highlight
= this.filtersModel
.isHighlightEnabled();
748 // Remove anything that should be excluded from the saved query
749 // this includes sticky filters and filters marked with 'excludedFromSavedQueries'
750 this._deleteExcludedValuesFromFilterState( selectedState
);
752 return this.savedQueriesModel
.findMatchingQuery(
754 filters
: selectedState
,
755 highlights
: highlightedItems
,
756 invert
: this.filtersModel
.areNamespacesInverted()
762 * Delete sticky filters from given object
764 * @param {Object} filterState Filter state
766 mw
.rcfilters
.Controller
.prototype._deleteExcludedValuesFromFilterState = function ( filterState
) {
767 // Remove excluded filters
768 $.each( this.filtersModel
.getExcludedFiltersState(), function ( filterName
) {
769 delete filterState
[ filterName
];
774 * Get an object representing the base state of parameters
777 * This is meant to make sure that the saved queries that are
778 * in memory are always the same structure as what we would get
779 * by calling the current model's "getSelectedState" and by checking
782 * In cases where a user saved a query when the system had a certain
783 * set of filters, and then a filter was added to the system, we want
784 * to make sure that the stored queries can still be comparable to
785 * the current state, which means that we need the base state for
788 * - Saved queries are stored in "minimal" view (only changed filters
789 * are stored); When we initialize the system, we merge each minimal
790 * query with the base state (using 'getNormalizedFilters') so all
791 * saved queries have the exact same structure as what we would get
792 * by checking the getSelectedState of the filter.
793 * - When we save the queries, we minimize the object to only represent
794 * whatever has actually changed, rather than store the entire
795 * object. To check what actually is different so we can store it,
796 * we need to obtain a base state to compare against, this is
797 * what #_getMinimalFilterList does
799 mw
.rcfilters
.Controller
.prototype._buildBaseFilterState = function () {
800 var defaultParams
= this.filtersModel
.getDefaultParams(),
801 highlightedItems
= {};
803 // Prepare highlights
804 this.filtersModel
.getItemsSupportingHighlights().forEach( function ( item
) {
805 highlightedItems
[ item
.getName() ] = null;
807 highlightedItems
.highlight
= false;
809 this.baseFilterState
= {
810 filters
: this.filtersModel
.getFiltersFromParameters( defaultParams
),
811 highlights
: highlightedItems
,
817 * Get an object representing the base filter state of both
818 * filters and highlights. The structure is similar to what we use
819 * to store each query in the saved queries object:
825 * filterName: (string|null)
829 * @return {Object} Object representing the base state of
830 * parameters and highlights
832 mw
.rcfilters
.Controller
.prototype._getBaseFilterState = function () {
833 return this.baseFilterState
;
837 * Get an object that holds only the parameters and highlights that have
838 * values different than the base default value.
840 * This is the reverse of the normalization we do initially on loading and
841 * initializing the saved queries model.
843 * @param {Object} valuesObject Object representing the state of both
844 * filters and highlights in its normalized version, to be minimized.
845 * @return {Object} Minimal filters and highlights list
847 mw
.rcfilters
.Controller
.prototype._getMinimalFilterList = function ( valuesObject
) {
848 var result
= { filters
: {}, highlights
: {}, invert
: valuesObject
.invert
},
849 baseState
= this._getBaseFilterState();
852 $.each( valuesObject
.filters
, function ( name
, value
) {
853 if ( baseState
.filters
!== undefined && baseState
.filters
[ name
] !== value
) {
854 result
.filters
[ name
] = value
;
858 $.each( valuesObject
.highlights
, function ( name
, value
) {
859 if ( baseState
.highlights
!== undefined && baseState
.highlights
[ name
] !== value
) {
860 result
.highlights
[ name
] = value
;
868 * Save the current state of the saved queries model with all
869 * query item representation in the user settings.
871 mw
.rcfilters
.Controller
.prototype._saveSavedQueries = function () {
873 state
= this.savedQueriesModel
.getState(),
876 // Minimize before save
877 $.each( state
.queries
, function ( queryID
, info
) {
878 state
.queries
[ queryID
].data
= controller
._getMinimalFilterList( info
.data
);
882 stringified
= JSON
.stringify( state
);
884 if ( $.byteLength( stringified
) > 65535 ) {
885 // Sanity check, since the preference can only hold that.
889 // Save the preference
890 new mw
.Api().saveOption( this.savedQueriesPreferenceName
, stringified
);
891 // Update the preference for this session
892 mw
.user
.options
.set( this.savedQueriesPreferenceName
, stringified
);
896 * Update sticky preferences with current model state
898 mw
.rcfilters
.Controller
.prototype.updateStickyPreferences = function () {
899 // Update default sticky values with selected, whether they came from
900 // the initial defaults or from the URL value that is being normalized
901 this.updateDaysDefault( this.filtersModel
.getGroup( 'days' ).getSelectedItems()[ 0 ].getParamName() );
902 this.updateLimitDefault( this.filtersModel
.getGroup( 'limit' ).getSelectedItems()[ 0 ].getParamName() );
904 // TODO: Make these automatic by having the model go over sticky
905 // items and update their default values automatically
909 * Update the limit default value
911 * param {number} newValue New value
913 mw
.rcfilters
.Controller
.prototype.updateLimitDefault = function ( /* newValue */ ) {
914 // HACK: Temporarily remove this from being sticky
918 if ( !$.isNumeric( newValue ) ) {
922 newValue = Number( newValue );
924 if ( mw.user.options.get( 'rcfilters-rclimit' ) !== newValue ) {
925 // Save the preference
926 new mw.Api().saveOption( 'rcfilters-rclimit', newValue );
927 // Update the preference for this session
928 mw.user.options.set( 'rcfilters-rclimit', newValue );
935 * Update the days default value
937 * param {number} newValue New value
939 mw
.rcfilters
.Controller
.prototype.updateDaysDefault = function ( /* newValue */ ) {
940 // HACK: Temporarily remove this from being sticky
944 if ( !$.isNumeric( newValue ) ) {
948 newValue = Number( newValue );
950 if ( mw.user.options.get( 'rcdays' ) !== newValue ) {
951 // Save the preference
952 new mw.Api().saveOption( 'rcdays', newValue );
953 // Update the preference for this session
954 mw.user.options.set( 'rcdays', newValue );
961 * Update the group by page default value
963 * @param {number} newValue New value
965 mw
.rcfilters
.Controller
.prototype.updateGroupByPageDefault = function ( newValue
) {
966 if ( !$.isNumeric( newValue
) ) {
970 newValue
= Number( newValue
);
972 if ( mw
.user
.options
.get( 'usenewrc' ) !== newValue
) {
973 // Save the preference
974 new mw
.Api().saveOption( 'usenewrc', newValue
);
975 // Update the preference for this session
976 mw
.user
.options
.set( 'usenewrc', newValue
);
981 * Synchronize the URL with the current state of the filters
982 * without adding an history entry.
984 mw
.rcfilters
.Controller
.prototype.replaceUrl = function () {
985 mw
.rcfilters
.UriProcessor
.static.replaceState( this._getUpdatedUri() );
989 * Update filter state (selection and highlighting) based
990 * on current URL values.
992 * @param {boolean} [fetchChangesList=true] Fetch new results into the changes
993 * list based on the updated model.
995 mw
.rcfilters
.Controller
.prototype.updateStateFromUrl = function ( fetchChangesList
) {
996 fetchChangesList
= fetchChangesList
=== undefined ? true : !!fetchChangesList
;
998 this.uriProcessor
.updateModelBasedOnQuery( new mw
.Uri().query
);
1000 // Update the sticky preferences, in case we received a value
1002 this.updateStickyPreferences();
1004 // Only update and fetch new results if it is requested
1005 if ( fetchChangesList
) {
1006 this.updateChangesList();
1011 * Update the list of changes and notify the model
1013 * @param {Object} [params] Extra parameters to add to the API call
1014 * @param {string} [updateMode='filterChange'] One of 'filterChange', 'liveUpdate', 'showNewChanges', 'markSeen'
1015 * @return {jQuery.Promise} Promise that is resolved when the update is complete
1017 mw
.rcfilters
.Controller
.prototype.updateChangesList = function ( params
, updateMode
) {
1018 updateMode
= updateMode
=== undefined ? this.FILTER_CHANGE
: updateMode
;
1020 if ( updateMode
=== this.FILTER_CHANGE
) {
1021 this._updateURL( params
);
1023 if ( updateMode
=== this.FILTER_CHANGE
|| updateMode
=== this.SHOW_NEW_CHANGES
) {
1024 this.changesListModel
.invalidate();
1026 this.changesListModel
.setNewChangesExist( false );
1027 this.updatingChangesList
= true;
1028 return this._fetchChangesList()
1031 function ( pieces
) {
1032 var $changesListContent
= pieces
.changes
,
1033 $fieldset
= pieces
.fieldset
;
1034 this.changesListModel
.update(
1035 $changesListContent
,
1038 // separator between old and new changes
1039 updateMode
=== this.SHOW_NEW_CHANGES
|| updateMode
=== this.LIVE_UPDATE
1042 // Do nothing for failure
1044 .always( function () {
1045 this.updatingChangesList
= false;
1050 * Get an object representing the default parameter state, whether
1051 * it is from the model defaults or from the saved queries.
1053 * @return {Object} Default parameters
1055 mw
.rcfilters
.Controller
.prototype._getDefaultParams = function () {
1056 var data
, queryHighlights
,
1058 savedHighlights
= {},
1059 defaultSavedQueryItem
= !mw
.user
.isAnon() && this.savedQueriesModel
.getItemByID( this.savedQueriesModel
.getDefault() );
1061 if ( defaultSavedQueryItem
) {
1062 data
= defaultSavedQueryItem
.getData();
1064 queryHighlights
= data
.highlights
|| {};
1065 savedParams
= this.filtersModel
.getParametersFromFilters(
1066 $.extend( true, {}, data
.filters
, this.filtersModel
.getStickyFiltersState() )
1069 // Translate highlights to parameters
1070 savedHighlights
.highlight
= String( Number( queryHighlights
.highlight
) );
1071 $.each( queryHighlights
, function ( filterName
, color
) {
1072 if ( filterName
!== 'highlights' ) {
1073 savedHighlights
[ filterName
+ '_color' ] = color
;
1077 return $.extend( true, {}, savedParams
, savedHighlights
, { invert
: String( Number( data
.invert
|| 0 ) ) } );
1080 return this.filtersModel
.getDefaultParams();
1084 * Update the URL of the page to reflect current filters
1086 * This should not be called directly from outside the controller.
1087 * If an action requires changing the URL, it should either use the
1088 * highlighting actions below, or call #updateChangesList which does
1089 * the uri corrections already.
1091 * @param {Object} [params] Extra parameters to add to the API call
1093 mw
.rcfilters
.Controller
.prototype._updateURL = function ( params
) {
1094 var currentUri
= new mw
.Uri(),
1095 updatedUri
= this._getUpdatedUri();
1097 updatedUri
.extend( params
|| {} );
1100 this.uriProcessor
.getVersion( currentUri
.query
) !== 2 ||
1101 this.uriProcessor
.isNewState( currentUri
.query
, updatedUri
.query
)
1103 mw
.rcfilters
.UriProcessor
.static.replaceState( updatedUri
);
1108 * Get an updated mw.Uri object based on the model state
1110 * @return {mw.Uri} Updated Uri
1112 mw
.rcfilters
.Controller
.prototype._getUpdatedUri = function () {
1113 var uri
= new mw
.Uri();
1116 uri
.query
= this.uriProcessor
.minimizeQuery(
1120 // We want to retain unrecognized params
1121 // The uri params from model will override
1122 // any recognized value in the current uri
1123 // query, retain unrecognized params, and
1124 // the result will then be minimized
1126 this.uriProcessor
.getUriParametersFromModel(),
1135 * Query the list of changes from the server for the current filters
1137 * @param {string} counterId Id for this request. To allow concurrent requests
1138 * not to invalidate each other.
1139 * @param {Object} [params={}] Parameters to add to the query
1141 * @return {jQuery.Promise} Promise object resolved with { content, status }
1143 mw
.rcfilters
.Controller
.prototype._queryChangesList = function ( counterId
, params
) {
1144 var uri
= this._getUpdatedUri(),
1145 stickyParams
= this.filtersModel
.getStickyParams(),
1149 params
= params
|| {};
1150 params
.action
= 'render'; // bypasses MW chrome
1152 uri
.extend( params
);
1154 this.requestCounter
[ counterId
] = this.requestCounter
[ counterId
] || 0;
1155 requestId
= ++this.requestCounter
[ counterId
];
1156 latestRequest = function () {
1157 return requestId
=== this.requestCounter
[ counterId
];
1160 // Sticky parameters override the URL params
1161 // this is to make sure that whether we represent
1162 // the sticky params in the URL or not (they may
1163 // be normalized out) the sticky parameters are
1164 // always being sent to the server with their
1165 // current/default values
1166 uri
.extend( stickyParams
);
1168 return $.ajax( uri
.toString(), { contentType
: 'html' } )
1170 function ( content
, message
, jqXHR
) {
1171 if ( !latestRequest() ) {
1172 return $.Deferred().reject();
1176 status
: jqXHR
.status
1179 // RC returns 404 when there is no results
1180 function ( jqXHR
) {
1181 if ( latestRequest() ) {
1182 return $.Deferred().resolve(
1184 content
: jqXHR
.responseText
,
1185 status
: jqXHR
.status
1194 * Fetch the list of changes from the server for the current filters
1196 * @return {jQuery.Promise} Promise object that will resolve with the changes list
1199 mw
.rcfilters
.Controller
.prototype._fetchChangesList = function () {
1200 return this._queryChangesList( 'updateChangesList' )
1203 var $parsed
= $( '<div>' ).append( $( $.parseHTML( data
.content
) ) ),
1206 changes
: $parsed
.find( '.mw-changeslist' ).first().contents(),
1208 fieldset
: $parsed
.find( 'fieldset.cloptions' ).first()
1211 if ( pieces
.changes
.length
=== 0 ) {
1212 pieces
.changes
= 'NO_RESULTS';
1221 * Track usage of highlight feature
1223 * @param {string} action
1224 * @param {Array|Object|string} filters
1226 mw
.rcfilters
.Controller
.prototype._trackHighlight = function ( action
, filters
) {
1227 filters
= typeof filters
=== 'string' ? { name
: filters
} : filters
;
1228 filters
= !Array
.isArray( filters
) ? [ filters
] : filters
;
1230 'event.ChangesListHighlights',
1234 userId
: mw
.user
.getId()
1240 * Track filter grouping usage
1242 * @param {string} action Action taken
1244 mw
.rcfilters
.Controller
.prototype.trackFilterGroupings = function ( action
) {
1245 var controller
= this,
1246 rightNow
= new Date().getTime(),
1247 randomIdentifier
= String( mw
.user
.sessionId() ) + String( rightNow
) + String( Math
.random() ),
1248 // Get all current filters
1249 filters
= this.filtersModel
.getSelectedItems().map( function ( item
) {
1250 return item
.getName();
1253 action
= action
|| 'filtermenu';
1255 // Check if these filters were the ones we just logged previously
1256 // (Don't log the same grouping twice, in case the user opens/closes)
1257 // the menu without action, or with the same result
1259 // Only log if the two arrays are different in size
1260 filters
.length
!== this.prevLoggedItems
.length
||
1261 // Or if any filters are not the same as the cached filters
1262 filters
.some( function ( filterName
) {
1263 return controller
.prevLoggedItems
.indexOf( filterName
) === -1;
1265 // Or if any cached filters are not the same as given filters
1266 this.prevLoggedItems
.some( function ( filterName
) {
1267 return filters
.indexOf( filterName
) === -1;
1270 filters
.forEach( function ( filterName
) {
1272 'event.ChangesListFilterGrouping',
1275 groupIdentifier
: randomIdentifier
,
1277 userId
: mw
.user
.getId()
1282 // Cache the filter names
1283 this.prevLoggedItems
= filters
;
1288 * Mark all changes as seen on Watchlist
1290 mw
.rcfilters
.Controller
.prototype.markAllChangesAsSeen = function () {
1291 var api
= new mw
.Api();
1292 api
.postWithToken( 'csrf', {
1294 action
: 'setnotificationtimestamp',
1295 entirewatchlist
: true
1296 } ).then( function () {
1297 this.updateChangesList( null, 'markSeen' );
1300 }( mediaWiki
, jQuery
) );