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
13 * @cfg {string} daysPreferenceName Preference name for the days filter
14 * @cfg {string} limitPreferenceName Preference name for the limit filter
16 mw
.rcfilters
.Controller
= function MwRcfiltersController( filtersModel
, changesListModel
, savedQueriesModel
, config
) {
17 this.filtersModel
= filtersModel
;
18 this.changesListModel
= changesListModel
;
19 this.savedQueriesModel
= savedQueriesModel
;
20 this.savedQueriesPreferenceName
= config
.savedQueriesPreferenceName
;
21 this.daysPreferenceName
= config
.daysPreferenceName
;
22 this.limitPreferenceName
= config
.limitPreferenceName
;
24 this.requestCounter
= {};
25 this.baseFilterState
= {};
26 this.uriProcessor
= null;
27 this.initializing
= false;
28 this.wereSavedQueriesSaved
= false;
30 this.prevLoggedItems
= [];
32 this.FILTER_CHANGE
= 'filterChange';
33 this.SHOW_NEW_CHANGES
= 'showNewChanges';
34 this.LIVE_UPDATE
= 'liveUpdate';
38 OO
.initClass( mw
.rcfilters
.Controller
);
41 * Initialize the filter and parameter states
43 * @param {Array} filterStructure Filter definition and structure for the model
44 * @param {Object} [namespaceStructure] Namespace definition
45 * @param {Object} [tagList] Tag definition
47 mw
.rcfilters
.Controller
.prototype.initialize = function ( filterStructure
, namespaceStructure
, tagList
) {
48 var parsedSavedQueries
, pieces
,
49 displayConfig
= mw
.config
.get( 'StructuredChangeFiltersDisplayConfig' ),
50 defaultSavedQueryExists
= mw
.config
.get( 'wgStructuredChangeFiltersDefaultSavedQueryExists' ),
57 if ( namespaceStructure
) {
59 $.each( namespaceStructure
, function ( namespaceID
, label
) {
60 // Build and clean up the individual namespace items definition
63 label
: label
|| mw
.msg( 'blanknamespace' ),
66 ( namespaceID
< 0 || namespaceID
% 2 === 0 ) ?
69 cssClass
: 'mw-changeslist-ns-' + namespaceID
74 title
: mw
.msg( 'namespaces' ),
77 // Group definition (single group)
78 name
: 'namespace', // parameter name is singular
79 type
: 'string_options',
80 title
: mw
.msg( 'namespaces' ),
81 labelPrefixKey
: { 'default': 'rcfilters-tag-prefix-namespace', inverted
: 'rcfilters-tag-prefix-namespace-inverted' },
102 title
: mw
.msg( 'rcfilters-view-tags' ),
105 // Group definition (single group)
106 name
: 'tagfilter', // Parameter name
107 type
: 'string_options',
108 title
: 'rcfilters-view-tags', // Message key
109 labelPrefixKey
: 'rcfilters-tag-prefix-tags',
117 // Add parameter range operations
122 type
: 'single_option',
123 title
: '', // Because it's a hidden group, this title actually appears nowhere
125 allowArbitrary
: true,
126 validate
: $.isNumeric
,
128 min
: 0, // The server normalizes negative numbers to 0 results
131 sortFunc: function ( a
, b
) { return Number( a
.name
) - Number( b
.name
); },
132 'default': mw
.user
.options
.get( this.limitPreferenceName
, displayConfig
.limitDefault
),
134 filters
: displayConfig
.limitArray
.map( function ( num
) {
135 return controller
._createFilterDataFromNumber( num
, num
);
140 type
: 'single_option',
141 title
: '', // Because it's a hidden group, this title actually appears nowhere
143 allowArbitrary
: true,
144 validate
: $.isNumeric
,
147 max
: displayConfig
.maxDays
149 sortFunc: function ( a
, b
) { return Number( a
.name
) - Number( b
.name
); },
150 numToLabelFunc: function ( i
) {
151 return Number( i
) < 1 ?
152 ( Number( i
) * 24 ).toFixed( 2 ) :
155 'default': mw
.user
.options
.get( this.daysPreferenceName
, displayConfig
.daysDefault
),
158 // Hours (1, 2, 6, 12)
159 0.04166, 0.0833, 0.25, 0.5
161 ].concat( displayConfig
.daysArray
)
162 .map( function ( num
) {
163 return controller
._createFilterDataFromNumber(
165 // Convert fractions of days to number of hours for the labels
166 num
< 1 ? Math
.round( num
* 24 ) : num
178 title
: '', // Because it's a hidden group, this title actually appears nowhere
184 'default': String( mw
.user
.options
.get( 'usenewrc', 0 ) )
191 views
.recentChangesLinked
= {
214 name
: 'showlinkedto',
222 // Before we do anything, we need to see if we require additional items in the
223 // groups that have 'AllowArbitrary'. For the moment, those are only single_option
224 // groups; if we ever expand it, this might need further generalization:
225 $.each( views
, function ( viewName
, viewData
) {
226 viewData
.groups
.forEach( function ( groupData
) {
227 var extraValues
= [];
228 if ( groupData
.allowArbitrary
) {
229 // If the value in the URI isn't in the group, add it
230 if ( uri
.query
[ groupData
.name
] !== undefined ) {
231 extraValues
.push( uri
.query
[ groupData
.name
] );
233 // If the default value isn't in the group, add it
234 if ( groupData
.default !== undefined ) {
235 extraValues
.push( String( groupData
.default ) );
237 controller
.addNumberValuesToGroup( groupData
, extraValues
);
242 // Initialize the model
243 this.filtersModel
.initializeFilters( filterStructure
, views
);
245 this.uriProcessor
= new mw
.rcfilters
.UriProcessor(
249 if ( !mw
.user
.isAnon() ) {
251 parsedSavedQueries
= JSON
.parse( mw
.user
.options
.get( this.savedQueriesPreferenceName
) || '{}' );
253 parsedSavedQueries
= {};
256 // Initialize saved queries
257 this.savedQueriesModel
.initialize( parsedSavedQueries
);
258 if ( this.savedQueriesModel
.isConverted() ) {
259 // Since we know we converted, we're going to re-save
260 // the queries so they are now migrated to the new format
261 this._saveSavedQueries();
265 // Check whether we need to load defaults.
266 // We do this by checking whether the current URI query
267 // contains any parameters recognized by the system.
268 // If it does, we load the given state.
269 // If it doesn't, we have no values at all, and we assume
270 // the user loads the base-page and we load defaults.
271 // Defaults should only be applied on load (if necessary)
273 this.initializing
= true;
275 if ( defaultSavedQueryExists
) {
276 // This came from the server, meaning that we have a default
277 // saved query, but the server could not load it, probably because
278 // it was pre-conversion to the new format.
279 // We need to load this query again
280 this.applySavedQuery( this.savedQueriesModel
.getDefault() );
282 // There are either recognized parameters in the URL
283 // or there are none, but there is also no default
284 // saved query (so defaults are from the backend)
285 // We want to update the state but not fetch results
287 this.updateStateFromUrl( false );
289 pieces
= this._extractChangesListInfo( $( '#mw-content-text' ) );
291 // Update the changes list with the existing data
292 // so it gets processed
293 this.changesListModel
.update(
296 pieces
.noResultsDetails
,
297 true // We're using existing DOM elements
301 this.initializing
= false;
302 this.switchView( 'default' );
304 this.pollingRate
= mw
.config
.get( 'StructuredChangeFiltersLiveUpdatePollingRate' );
305 if ( this.pollingRate
) {
306 this._scheduleLiveUpdate();
311 * Extracts information from the changes list DOM
313 * @param {jQuery} $root Root DOM to find children from
314 * @return {Object} Information about changes list
315 * @return {Object|string} return.changes Changes list, or 'NO_RESULTS' if there are no results
316 * (either normally or as an error)
317 * @return {string} [return.noResultsDetails] 'NO_RESULTS_NORMAL' for a normal 0-result set,
318 * 'NO_RESULTS_TIMEOUT' for no results due to a timeout, or omitted for more than 0 results
319 * @return {jQuery} return.fieldset Fieldset
321 mw
.rcfilters
.Controller
.prototype._extractChangesListInfo = function ( $root
) {
323 $changesListContents
= $root
.find( '.mw-changeslist' ).first().contents(),
324 areResults
= !!$changesListContents
.length
;
327 changes
: $changesListContents
.length
? $changesListContents
: 'NO_RESULTS',
328 fieldset
: $root
.find( 'fieldset.cloptions' ).first()
332 isTimeout
= !!$root
.find( '.mw-changeslist-timeout' ).length
;
333 info
.noResultsDetails
= isTimeout
? 'NO_RESULTS_TIMEOUT' : 'NO_RESULTS_NORMAL';
340 * Create filter data from a number, for the filters that are numerical value
342 * @param {Number} num Number
343 * @param {Number} numForDisplay Number for the label
344 * @return {Object} Filter data
346 mw
.rcfilters
.Controller
.prototype._createFilterDataFromNumber = function ( num
, numForDisplay
) {
349 label
: mw
.language
.convertNumber( numForDisplay
)
354 * Add an arbitrary values to groups that allow arbitrary values
356 * @param {Object} groupData Group data
357 * @param {string|string[]} arbitraryValues An array of arbitrary values to add to the group
359 mw
.rcfilters
.Controller
.prototype.addNumberValuesToGroup = function ( groupData
, arbitraryValues
) {
360 var controller
= this,
361 normalizeWithinRange = function ( range
, val
) {
362 if ( val
< range
.min
) {
363 return range
.min
; // Min
364 } else if ( val
>= range
.max
) {
365 return range
.max
; // Max
370 arbitraryValues
= Array
.isArray( arbitraryValues
) ? arbitraryValues
: [ arbitraryValues
];
372 // Normalize the arbitrary values and the default value for a range
373 if ( groupData
.range
) {
374 arbitraryValues
= arbitraryValues
.map( function ( val
) {
375 return normalizeWithinRange( groupData
.range
, val
);
378 // Normalize the default, since that's user defined
379 if ( groupData
.default !== undefined ) {
380 groupData
.default = String( normalizeWithinRange( groupData
.range
, groupData
.default ) );
384 // This is only true for single_option group
385 // We assume these are the only groups that will allow for
386 // arbitrary, since it doesn't make any sense for the other
388 arbitraryValues
.forEach( function ( val
) {
390 // If the group allows for arbitrary data
391 groupData
.allowArbitrary
&&
392 // and it is single_option (or string_options, but we
393 // don't have cases of those yet, nor do we plan to)
394 groupData
.type
=== 'single_option' &&
395 // and, if there is a validate method and it passes on
397 ( !groupData
.validate
|| groupData
.validate( val
) ) &&
398 // but if that value isn't already in the definition
400 .map( function ( filterData
) {
401 return String( filterData
.name
);
403 .indexOf( String( val
) ) === -1
405 // Add the filter information
406 groupData
.filters
.push( controller
._createFilterDataFromNumber(
408 groupData
.numToLabelFunc
?
409 groupData
.numToLabelFunc( val
) :
413 // If there's a sort function set up, re-sort the values
414 if ( groupData
.sortFunc
) {
415 groupData
.filters
.sort( groupData
.sortFunc
);
422 * Switch the view of the filters model
424 * @param {string} view Requested view
426 mw
.rcfilters
.Controller
.prototype.switchView = function ( view
) {
427 this.filtersModel
.switchView( view
);
431 * Reset to default filters
433 mw
.rcfilters
.Controller
.prototype.resetToDefaults = function () {
434 var params
= this._getDefaultParams();
435 if ( this.applyParamChange( params
) ) {
436 // Only update the changes list if there was a change to actual filters
437 this.updateChangesList();
439 this.uriProcessor
.updateURL( params
);
444 * Check whether the default values of the filters are all false.
446 * @return {boolean} Defaults are all false
448 mw
.rcfilters
.Controller
.prototype.areDefaultsEmpty = function () {
449 return $.isEmptyObject( this._getDefaultParams() );
453 * Empty all selected filters
455 mw
.rcfilters
.Controller
.prototype.emptyFilters = function () {
456 var highlightedFilterNames
= this.filtersModel
.getHighlightedItems()
457 .map( function ( filterItem
) { return { name
: filterItem
.getName() }; } );
459 if ( this.applyParamChange( {} ) ) {
460 // Only update the changes list if there was a change to actual filters
461 this.updateChangesList();
463 this.uriProcessor
.updateURL();
466 if ( highlightedFilterNames
) {
467 this._trackHighlight( 'clearAll', highlightedFilterNames
);
472 * Update the selected state of a filter
474 * @param {string} filterName Filter name
475 * @param {boolean} [isSelected] Filter selected state
477 mw
.rcfilters
.Controller
.prototype.toggleFilterSelect = function ( filterName
, isSelected
) {
478 var filterItem
= this.filtersModel
.getItemByName( filterName
);
481 // If no filter was found, break
485 isSelected
= isSelected
=== undefined ? !filterItem
.isSelected() : isSelected
;
487 if ( filterItem
.isSelected() !== isSelected
) {
488 this.filtersModel
.toggleFilterSelected( filterName
, isSelected
);
490 this.updateChangesList();
492 // Check filter interactions
493 this.filtersModel
.reassessFilterInteractions( filterItem
);
498 * Clear both highlight and selection of a filter
500 * @param {string} filterName Name of the filter item
502 mw
.rcfilters
.Controller
.prototype.clearFilter = function ( filterName
) {
503 var filterItem
= this.filtersModel
.getItemByName( filterName
),
504 isHighlighted
= filterItem
.isHighlighted(),
505 isSelected
= filterItem
.isSelected();
507 if ( isSelected
|| isHighlighted
) {
508 this.filtersModel
.clearHighlightColor( filterName
);
509 this.filtersModel
.toggleFilterSelected( filterName
, false );
512 // Only update the changes list if the filter changed
513 // its selection state. If it only changed its highlight
515 this.updateChangesList();
518 this.filtersModel
.reassessFilterInteractions( filterItem
);
520 // Log filter grouping
521 this.trackFilterGroupings( 'removefilter' );
524 if ( isHighlighted
) {
525 this._trackHighlight( 'clear', filterName
);
530 * Toggle the highlight feature on and off
532 mw
.rcfilters
.Controller
.prototype.toggleHighlight = function () {
533 this.filtersModel
.toggleHighlight();
534 this.uriProcessor
.updateURL();
536 if ( this.filtersModel
.isHighlightEnabled() ) {
537 mw
.hook( 'RcFilters.highlight.enable' ).fire();
542 * Toggle the namespaces inverted feature on and off
544 mw
.rcfilters
.Controller
.prototype.toggleInvertedNamespaces = function () {
545 this.filtersModel
.toggleInvertedNamespaces();
547 this.filtersModel
.getFiltersByView( 'namespaces' ).filter(
548 function ( filterItem
) { return filterItem
.isSelected(); }
551 // Only re-fetch results if there are namespace items that are actually selected
552 this.updateChangesList();
554 this.uriProcessor
.updateURL();
559 * Set the value of the 'showlinkedto' parameter
560 * @param {boolean} value
562 mw
.rcfilters
.Controller
.prototype.setShowLinkedTo = function ( value
) {
563 var targetItem
= this.filtersModel
.getGroup( 'page' ).getItemByParamName( 'target' ),
564 showLinkedToItem
= this.filtersModel
.getGroup( 'toOrFrom' ).getItemByParamName( 'showlinkedto' );
566 this.filtersModel
.toggleFilterSelected( showLinkedToItem
.getName(), value
);
567 this.uriProcessor
.updateURL();
568 // reload the results only when target is set
569 if ( targetItem
.getValue() ) {
570 this.updateChangesList();
575 * Set the target page
576 * @param {string} page
578 mw
.rcfilters
.Controller
.prototype.setTargetPage = function ( page
) {
579 var targetItem
= this.filtersModel
.getGroup( 'page' ).getItemByParamName( 'target' );
580 targetItem
.setValue( page
);
581 this.uriProcessor
.updateURL();
582 this.updateChangesList();
586 * Set the highlight color for a filter item
588 * @param {string} filterName Name of the filter item
589 * @param {string} color Selected color
591 mw
.rcfilters
.Controller
.prototype.setHighlightColor = function ( filterName
, color
) {
592 this.filtersModel
.setHighlightColor( filterName
, color
);
593 this.uriProcessor
.updateURL();
594 this._trackHighlight( 'set', { name
: filterName
, color
: color
} );
598 * Clear highlight for a filter item
600 * @param {string} filterName Name of the filter item
602 mw
.rcfilters
.Controller
.prototype.clearHighlightColor = function ( filterName
) {
603 this.filtersModel
.clearHighlightColor( filterName
);
604 this.uriProcessor
.updateURL();
605 this._trackHighlight( 'clear', filterName
);
609 * Enable or disable live updates.
610 * @param {boolean} enable True to enable, false to disable
612 mw
.rcfilters
.Controller
.prototype.toggleLiveUpdate = function ( enable
) {
613 this.changesListModel
.toggleLiveUpdate( enable
);
614 if ( this.changesListModel
.getLiveUpdate() && this.changesListModel
.getNewChangesExist() ) {
615 this.updateChangesList( null, this.LIVE_UPDATE
);
620 * Set a timeout for the next live update.
623 mw
.rcfilters
.Controller
.prototype._scheduleLiveUpdate = function () {
624 setTimeout( this._doLiveUpdate
.bind( this ), this.pollingRate
* 1000 );
628 * Perform a live update.
631 mw
.rcfilters
.Controller
.prototype._doLiveUpdate = function () {
632 if ( !this._shouldCheckForNewChanges() ) {
633 // skip this turn and check back later
634 this._scheduleLiveUpdate();
638 this._checkForNewChanges()
639 .then( function ( newChanges
) {
640 if ( !this._shouldCheckForNewChanges() ) {
641 // by the time the response is received,
642 // it may not be appropriate anymore
647 if ( this.changesListModel
.getLiveUpdate() ) {
648 return this.updateChangesList( null, this.LIVE_UPDATE
);
650 this.changesListModel
.setNewChangesExist( true );
654 .always( this._scheduleLiveUpdate
.bind( this ) );
658 * @return {boolean} It's appropriate to check for new changes now
661 mw
.rcfilters
.Controller
.prototype._shouldCheckForNewChanges = function () {
662 return !document
.hidden
&&
663 !this.filtersModel
.hasConflict() &&
664 !this.changesListModel
.getNewChangesExist() &&
665 !this.updatingChangesList
&&
666 this.changesListModel
.getNextFrom();
670 * Check if new changes, newer than those currently shown, are available
672 * @return {jQuery.Promise} Promise object that resolves with a bool
673 * specifying if there are new changes or not
677 mw
.rcfilters
.Controller
.prototype._checkForNewChanges = function () {
680 peek
: 1, // bypasses ChangesList specific UI
681 from: this.changesListModel
.getNextFrom()
683 return this._queryChangesList( 'liveUpdate', params
).then(
685 // no result is 204 with the 'peek' param
686 return data
.status
=== 200;
692 * Show the new changes
694 * @return {jQuery.Promise} Promise object that resolves after
695 * fetching and showing the new changes
697 mw
.rcfilters
.Controller
.prototype.showNewChanges = function () {
698 return this.updateChangesList( null, this.SHOW_NEW_CHANGES
);
702 * Save the current model state as a saved query
704 * @param {string} [label] Label of the saved query
705 * @param {boolean} [setAsDefault=false] This query should be set as the default
707 mw
.rcfilters
.Controller
.prototype.saveCurrentQuery = function ( label
, setAsDefault
) {
709 this.savedQueriesModel
.addNewQuery(
710 label
|| mw
.msg( 'rcfilters-savedqueries-defaultlabel' ),
711 this.filtersModel
.getCurrentParameterState( true ),
716 this._saveSavedQueries();
720 * Remove a saved query
722 * @param {string} queryID Query id
724 mw
.rcfilters
.Controller
.prototype.removeSavedQuery = function ( queryID
) {
725 this.savedQueriesModel
.removeQuery( queryID
);
727 this._saveSavedQueries();
731 * Rename a saved query
733 * @param {string} queryID Query id
734 * @param {string} newLabel New label for the query
736 mw
.rcfilters
.Controller
.prototype.renameSavedQuery = function ( queryID
, newLabel
) {
737 var queryItem
= this.savedQueriesModel
.getItemByID( queryID
);
740 queryItem
.updateLabel( newLabel
);
742 this._saveSavedQueries();
746 * Set a saved query as default
748 * @param {string} queryID Query Id. If null is given, default
751 mw
.rcfilters
.Controller
.prototype.setDefaultSavedQuery = function ( queryID
) {
752 this.savedQueriesModel
.setDefault( queryID
);
753 this._saveSavedQueries();
759 * @param {string} queryID Query id
761 mw
.rcfilters
.Controller
.prototype.applySavedQuery = function ( queryID
) {
762 var currentMatchingQuery
,
763 params
= this.savedQueriesModel
.getItemParams( queryID
);
765 currentMatchingQuery
= this.findQueryMatchingCurrentState();
768 currentMatchingQuery
&&
769 currentMatchingQuery
.getID() === queryID
771 // If the query we want to load is the one that is already
772 // loaded, don't reload it
776 if ( this.applyParamChange( params
) ) {
777 // Update changes list only if there was a difference in filter selection
778 this.updateChangesList();
780 this.uriProcessor
.updateURL( params
);
783 // Log filter grouping
784 this.trackFilterGroupings( 'savedfilters' );
788 * Check whether the current filter and highlight state exists
789 * in the saved queries model.
791 * @return {mw.rcfilters.dm.SavedQueryItemModel} Matching item model
793 mw
.rcfilters
.Controller
.prototype.findQueryMatchingCurrentState = function () {
794 return this.savedQueriesModel
.findMatchingQuery(
795 this.filtersModel
.getCurrentParameterState( true )
800 * Save the current state of the saved queries model with all
801 * query item representation in the user settings.
803 mw
.rcfilters
.Controller
.prototype._saveSavedQueries = function () {
804 var stringified
, oldPrefValue
,
805 backupPrefName
= this.savedQueriesPreferenceName
+ '-versionbackup',
806 state
= this.savedQueriesModel
.getState();
809 stringified
= JSON
.stringify( state
);
811 if ( $.byteLength( stringified
) > 65535 ) {
812 // Sanity check, since the preference can only hold that.
816 if ( !this.wereSavedQueriesSaved
&& this.savedQueriesModel
.isConverted() ) {
817 // The queries were converted from the previous version
818 // Keep the old string in the [prefname]-versionbackup
819 oldPrefValue
= mw
.user
.options
.get( this.savedQueriesPreferenceName
);
821 // Save the old preference in the backup preference
822 new mw
.Api().saveOption( backupPrefName
, oldPrefValue
);
823 // Update the preference for this session
824 mw
.user
.options
.set( backupPrefName
, oldPrefValue
);
827 // Save the preference
828 new mw
.Api().saveOption( this.savedQueriesPreferenceName
, stringified
);
829 // Update the preference for this session
830 mw
.user
.options
.set( this.savedQueriesPreferenceName
, stringified
);
832 // Tag as already saved so we don't do this again
833 this.wereSavedQueriesSaved
= true;
837 * Update sticky preferences with current model state
839 mw
.rcfilters
.Controller
.prototype.updateStickyPreferences = function () {
840 // Update default sticky values with selected, whether they came from
841 // the initial defaults or from the URL value that is being normalized
842 this.updateDaysDefault( this.filtersModel
.getGroup( 'days' ).getSelectedItems()[ 0 ].getParamName() );
843 this.updateLimitDefault( this.filtersModel
.getGroup( 'limit' ).getSelectedItems()[ 0 ].getParamName() );
845 // TODO: Make these automatic by having the model go over sticky
846 // items and update their default values automatically
850 * Update the limit default value
852 * @param {number} newValue New value
854 mw
.rcfilters
.Controller
.prototype.updateLimitDefault = function ( newValue
) {
855 this.updateNumericPreference( this.limitPreferenceName
, newValue
);
859 * Update the days default value
861 * @param {number} newValue New value
863 mw
.rcfilters
.Controller
.prototype.updateDaysDefault = function ( newValue
) {
864 this.updateNumericPreference( this.daysPreferenceName
, newValue
);
868 * Update the group by page default value
870 * @param {boolean} newValue New value
872 mw
.rcfilters
.Controller
.prototype.updateGroupByPageDefault = function ( newValue
) {
873 this.updateNumericPreference( 'usenewrc', Number( newValue
) );
877 * Update a numeric preference with a new value
879 * @param {string} prefName Preference name
880 * @param {number|string} newValue New value
882 mw
.rcfilters
.Controller
.prototype.updateNumericPreference = function ( prefName
, newValue
) {
883 if ( !$.isNumeric( newValue
) ) {
887 newValue
= Number( newValue
);
889 if ( mw
.user
.options
.get( prefName
) !== newValue
) {
890 // Save the preference
891 new mw
.Api().saveOption( prefName
, newValue
);
892 // Update the preference for this session
893 mw
.user
.options
.set( prefName
, newValue
);
898 * Synchronize the URL with the current state of the filters
899 * without adding an history entry.
901 mw
.rcfilters
.Controller
.prototype.replaceUrl = function () {
902 this.uriProcessor
.updateURL();
906 * Update filter state (selection and highlighting) based
907 * on current URL values.
909 * @param {boolean} [fetchChangesList=true] Fetch new results into the changes
910 * list based on the updated model.
912 mw
.rcfilters
.Controller
.prototype.updateStateFromUrl = function ( fetchChangesList
) {
913 fetchChangesList
= fetchChangesList
=== undefined ? true : !!fetchChangesList
;
915 this.uriProcessor
.updateModelBasedOnQuery();
917 // Update the sticky preferences, in case we received a value
919 this.updateStickyPreferences();
921 // Only update and fetch new results if it is requested
922 if ( fetchChangesList
) {
923 this.updateChangesList();
928 * Update the list of changes and notify the model
930 * @param {Object} [params] Extra parameters to add to the API call
931 * @param {string} [updateMode='filterChange'] One of 'filterChange', 'liveUpdate', 'showNewChanges', 'markSeen'
932 * @return {jQuery.Promise} Promise that is resolved when the update is complete
934 mw
.rcfilters
.Controller
.prototype.updateChangesList = function ( params
, updateMode
) {
935 updateMode
= updateMode
=== undefined ? this.FILTER_CHANGE
: updateMode
;
937 if ( updateMode
=== this.FILTER_CHANGE
) {
938 this.uriProcessor
.updateURL( params
);
940 if ( updateMode
=== this.FILTER_CHANGE
|| updateMode
=== this.SHOW_NEW_CHANGES
) {
941 this.changesListModel
.invalidate();
943 this.changesListModel
.setNewChangesExist( false );
944 this.updatingChangesList
= true;
945 return this._fetchChangesList()
948 function ( pieces
) {
949 var $changesListContent
= pieces
.changes
,
950 $fieldset
= pieces
.fieldset
;
951 this.changesListModel
.update(
954 pieces
.noResultsDetails
,
956 // separator between old and new changes
957 updateMode
=== this.SHOW_NEW_CHANGES
|| updateMode
=== this.LIVE_UPDATE
960 // Do nothing for failure
962 .always( function () {
963 this.updatingChangesList
= false;
968 * Get an object representing the default parameter state, whether
969 * it is from the model defaults or from the saved queries.
971 * @return {Object} Default parameters
973 mw
.rcfilters
.Controller
.prototype._getDefaultParams = function () {
974 if ( this.savedQueriesModel
.getDefault() ) {
975 return this.savedQueriesModel
.getDefaultParams();
977 return this.filtersModel
.getDefaultParams();
982 * Query the list of changes from the server for the current filters
984 * @param {string} counterId Id for this request. To allow concurrent requests
985 * not to invalidate each other.
986 * @param {Object} [params={}] Parameters to add to the query
988 * @return {jQuery.Promise} Promise object resolved with { content, status }
990 mw
.rcfilters
.Controller
.prototype._queryChangesList = function ( counterId
, params
) {
991 var uri
= this.uriProcessor
.getUpdatedUri(),
992 stickyParams
= this.filtersModel
.getStickyParamsValues(),
996 params
= params
|| {};
997 params
.action
= 'render'; // bypasses MW chrome
999 uri
.extend( params
);
1001 this.requestCounter
[ counterId
] = this.requestCounter
[ counterId
] || 0;
1002 requestId
= ++this.requestCounter
[ counterId
];
1003 latestRequest = function () {
1004 return requestId
=== this.requestCounter
[ counterId
];
1007 // Sticky parameters override the URL params
1008 // this is to make sure that whether we represent
1009 // the sticky params in the URL or not (they may
1010 // be normalized out) the sticky parameters are
1011 // always being sent to the server with their
1012 // current/default values
1013 uri
.extend( stickyParams
);
1015 return $.ajax( uri
.toString(), { contentType
: 'html' } )
1017 function ( content
, message
, jqXHR
) {
1018 if ( !latestRequest() ) {
1019 return $.Deferred().reject();
1023 status
: jqXHR
.status
1026 // RC returns 404 when there is no results
1027 function ( jqXHR
) {
1028 if ( latestRequest() ) {
1029 return $.Deferred().resolve(
1031 content
: jqXHR
.responseText
,
1032 status
: jqXHR
.status
1041 * Fetch the list of changes from the server for the current filters
1043 * @return {jQuery.Promise} Promise object that will resolve with the changes list
1046 mw
.rcfilters
.Controller
.prototype._fetchChangesList = function () {
1047 return this._queryChangesList( 'updateChangesList' )
1052 // Status code 0 is not HTTP status code,
1053 // but is valid value of XMLHttpRequest status.
1054 // It is used for variety of network errors, for example
1055 // when an AJAX call was cancelled before getting the response
1056 if ( data
&& data
.status
=== 0 ) {
1058 changes
: 'NO_RESULTS',
1059 // We need empty result set, to avoid exceptions because of undefined value
1061 noResultsDetails
: 'NO_RESULTS_NETWORK_ERROR'
1065 $parsed
= $( '<div>' ).append( $( $.parseHTML(
1066 data
? data
.content
: ''
1069 return this._extractChangesListInfo( $parsed
);
1075 * Track usage of highlight feature
1077 * @param {string} action
1078 * @param {Array|Object|string} filters
1080 mw
.rcfilters
.Controller
.prototype._trackHighlight = function ( action
, filters
) {
1081 filters
= typeof filters
=== 'string' ? { name
: filters
} : filters
;
1082 filters
= !Array
.isArray( filters
) ? [ filters
] : filters
;
1084 'event.ChangesListHighlights',
1088 userId
: mw
.user
.getId()
1094 * Track filter grouping usage
1096 * @param {string} action Action taken
1098 mw
.rcfilters
.Controller
.prototype.trackFilterGroupings = function ( action
) {
1099 var controller
= this,
1100 rightNow
= new Date().getTime(),
1101 randomIdentifier
= String( mw
.user
.sessionId() ) + String( rightNow
) + String( Math
.random() ),
1102 // Get all current filters
1103 filters
= this.filtersModel
.getSelectedItems().map( function ( item
) {
1104 return item
.getName();
1107 action
= action
|| 'filtermenu';
1109 // Check if these filters were the ones we just logged previously
1110 // (Don't log the same grouping twice, in case the user opens/closes)
1111 // the menu without action, or with the same result
1113 // Only log if the two arrays are different in size
1114 filters
.length
!== this.prevLoggedItems
.length
||
1115 // Or if any filters are not the same as the cached filters
1116 filters
.some( function ( filterName
) {
1117 return controller
.prevLoggedItems
.indexOf( filterName
) === -1;
1119 // Or if any cached filters are not the same as given filters
1120 this.prevLoggedItems
.some( function ( filterName
) {
1121 return filters
.indexOf( filterName
) === -1;
1124 filters
.forEach( function ( filterName
) {
1126 'event.ChangesListFilterGrouping',
1129 groupIdentifier
: randomIdentifier
,
1131 userId
: mw
.user
.getId()
1136 // Cache the filter names
1137 this.prevLoggedItems
= filters
;
1142 * Apply a change of parameters to the model state, and check whether
1143 * the new state is different than the old state.
1145 * @param {Object} newParamState New parameter state to apply
1146 * @return {boolean} New applied model state is different than the previous state
1148 mw
.rcfilters
.Controller
.prototype.applyParamChange = function ( newParamState
) {
1150 before
= this.filtersModel
.getSelectedState();
1152 this.filtersModel
.updateStateFromParams( newParamState
);
1154 after
= this.filtersModel
.getSelectedState();
1156 return !OO
.compare( before
, after
);
1160 * Mark all changes as seen on Watchlist
1162 mw
.rcfilters
.Controller
.prototype.markAllChangesAsSeen = function () {
1163 var api
= new mw
.Api();
1164 api
.postWithToken( 'csrf', {
1166 action
: 'setnotificationtimestamp',
1167 entirewatchlist
: true
1168 } ).then( function () {
1169 this.updateChangesList( null, 'markSeen' );
1172 }( mediaWiki
, jQuery
) );