2 /* eslint no-underscore-dangle: "off" */
4 * Controller for the filters in Recent Changes
6 * @param {mw.rcfilters.dm.FiltersViewModel} filtersModel Filters view model
7 * @param {mw.rcfilters.dm.ChangesListViewModel} changesListModel Changes list view model
8 * @param {mw.rcfilters.dm.SavedQueriesModel} savedQueriesModel Saved queries model
10 mw
.rcfilters
.Controller
= function MwRcfiltersController( filtersModel
, changesListModel
, savedQueriesModel
) {
11 this.filtersModel
= filtersModel
;
12 this.changesListModel
= changesListModel
;
13 this.savedQueriesModel
= savedQueriesModel
;
14 this.requestCounter
= 0;
15 this.baseFilterState
= {};
16 this.uriProcessor
= null;
17 this.initializing
= false;
21 OO
.initClass( mw
.rcfilters
.Controller
);
24 * Initialize the filter and parameter states
26 * @param {Array} filterStructure Filter definition and structure for the model
27 * @param {Object} [namespaceStructure] Namespace definition
28 * @param {Object} [tagList] Tag definition
30 mw
.rcfilters
.Controller
.prototype.initialize = function ( filterStructure
, namespaceStructure
, tagList
) {
31 var parsedSavedQueries
,
35 $changesList
= $( '.mw-changeslist' ).first().contents();
38 if ( namespaceStructure
) {
40 $.each( namespaceStructure
, function ( namespaceID
, label
) {
41 // Build and clean up the individual namespace items definition
44 label
: label
|| mw
.msg( 'blanknamespace' ),
47 ( namespaceID
< 0 || namespaceID
% 2 === 0 ) ?
50 cssClass
: 'mw-changeslist-ns-' + namespaceID
55 title
: mw
.msg( 'namespaces' ),
58 // Group definition (single group)
60 type
: 'string_options',
61 title
: mw
.msg( 'namespaces' ),
62 labelPrefixKey
: { 'default': 'rcfilters-tag-prefix-namespace', inverted
: 'rcfilters-tag-prefix-namespace-inverted' },
71 title
: mw
.msg( 'rcfilters-view-tags' ),
74 // Group definition (single group)
75 name
: 'tagfilter', // Parameter name
76 type
: 'string_options',
77 title
: 'rcfilters-view-tags', // Message key
78 labelPrefixKey
: 'rcfilters-tag-prefix-tags',
86 // Initialize the model
87 this.filtersModel
.initializeFilters( filterStructure
, views
);
89 this._buildBaseFilterState();
91 this.uriProcessor
= new mw
.rcfilters
.UriProcessor(
96 parsedSavedQueries
= JSON
.parse( mw
.user
.options
.get( 'rcfilters-saved-queries' ) || '{}' );
98 parsedSavedQueries
= {};
101 // The queries are saved in a minimized state, so we need
102 // to send over the base state so the saved queries model
103 // can normalize them per each query item
104 this.savedQueriesModel
.initialize(
106 this._getBaseFilterState()
109 // Check whether we need to load defaults.
110 // We do this by checking whether the current URI query
111 // contains any parameters recognized by the system.
112 // If it does, we load the given state.
113 // If it doesn't, we have no values at all, and we assume
114 // the user loads the base-page and we load defaults.
115 // Defaults should only be applied on load (if necessary)
117 this.initializing
= true;
119 this.savedQueriesModel
.getDefault() &&
120 !this.uriProcessor
.doesQueryContainRecognizedParams( uri
.query
)
122 // We have defaults from a saved query.
123 // We will load them straight-forward (as if
124 // they were clicked in the menu) so we trigger
125 // a full ajax request and change of URL
126 this.applySavedQuery( this.savedQueriesModel
.getDefault() );
128 // There are either recognized parameters in the URL
129 // or there are none, but there is also no default
130 // saved query (so defaults are from the backend)
131 // We want to update the state but not fetch results
133 this.updateStateFromUrl( false );
135 // Update the changes list with the existing data
136 // so it gets processed
137 this.changesListModel
.update(
138 $changesList
.length
? $changesList
: 'NO_RESULTS',
139 $( 'fieldset.rcoptions' ).first()
143 this.initializing
= false;
144 this.switchView( 'default' );
148 * Switch the view of the filters model
150 * @param {string} view Requested view
152 mw
.rcfilters
.Controller
.prototype.switchView = function ( view
) {
153 this.filtersModel
.switchView( view
);
157 * Reset to default filters
159 mw
.rcfilters
.Controller
.prototype.resetToDefaults = function () {
160 this.uriProcessor
.updateModelBasedOnQuery( this._getDefaultParams() );
161 this.updateChangesList();
165 * Empty all selected filters
167 mw
.rcfilters
.Controller
.prototype.emptyFilters = function () {
168 var highlightedFilterNames
= this.filtersModel
169 .getHighlightedItems()
170 .map( function ( filterItem
) { return { name
: filterItem
.getName() }; } );
172 this.filtersModel
.emptyAllFilters();
173 this.filtersModel
.clearAllHighlightColors();
174 // Check all filter interactions
175 this.filtersModel
.reassessFilterInteractions();
177 this.updateChangesList();
179 if ( highlightedFilterNames
) {
180 this._trackHighlight( 'clearAll', highlightedFilterNames
);
185 * Update the selected state of a filter
187 * @param {string} filterName Filter name
188 * @param {boolean} [isSelected] Filter selected state
190 mw
.rcfilters
.Controller
.prototype.toggleFilterSelect = function ( filterName
, isSelected
) {
191 var filterItem
= this.filtersModel
.getItemByName( filterName
);
194 // If no filter was found, break
198 isSelected
= isSelected
=== undefined ? !filterItem
.isSelected() : isSelected
;
200 if ( filterItem
.isSelected() !== isSelected
) {
201 this.filtersModel
.toggleFilterSelected( filterName
, isSelected
);
203 this.updateChangesList();
205 // Check filter interactions
206 this.filtersModel
.reassessFilterInteractions( filterItem
);
211 * Clear both highlight and selection of a filter
213 * @param {string} filterName Name of the filter item
215 mw
.rcfilters
.Controller
.prototype.clearFilter = function ( filterName
) {
216 var filterItem
= this.filtersModel
.getItemByName( filterName
),
217 isHighlighted
= filterItem
.isHighlighted();
219 if ( filterItem
.isSelected() || isHighlighted
) {
220 this.filtersModel
.clearHighlightColor( filterName
);
221 this.filtersModel
.toggleFilterSelected( filterName
, false );
222 this.updateChangesList();
223 this.filtersModel
.reassessFilterInteractions( filterItem
);
226 if ( isHighlighted
) {
227 this._trackHighlight( 'clear', filterName
);
232 * Toggle the highlight feature on and off
234 mw
.rcfilters
.Controller
.prototype.toggleHighlight = function () {
235 this.filtersModel
.toggleHighlight();
238 if ( this.filtersModel
.isHighlightEnabled() ) {
239 mw
.hook( 'RcFilters.highlight.enable' ).fire();
244 * Toggle the namespaces inverted feature on and off
246 mw
.rcfilters
.Controller
.prototype.toggleInvertedNamespaces = function () {
247 this.filtersModel
.toggleInvertedNamespaces();
248 this.updateChangesList();
252 * Set the highlight color for a filter item
254 * @param {string} filterName Name of the filter item
255 * @param {string} color Selected color
257 mw
.rcfilters
.Controller
.prototype.setHighlightColor = function ( filterName
, color
) {
258 this.filtersModel
.setHighlightColor( filterName
, color
);
260 this._trackHighlight( 'set', { name
: filterName
, color
: color
} );
264 * Clear highlight for a filter item
266 * @param {string} filterName Name of the filter item
268 mw
.rcfilters
.Controller
.prototype.clearHighlightColor = function ( filterName
) {
269 this.filtersModel
.clearHighlightColor( filterName
);
271 this._trackHighlight( 'clear', filterName
);
275 * Save the current model state as a saved query
277 * @param {string} [label] Label of the saved query
279 mw
.rcfilters
.Controller
.prototype.saveCurrentQuery = function ( label
) {
280 var highlightedItems
= {},
281 highlightEnabled
= this.filtersModel
.isHighlightEnabled();
283 // Prepare highlights
284 this.filtersModel
.getHighlightedItems().forEach( function ( item
) {
285 highlightedItems
[ item
.getName() ] = highlightEnabled
?
286 item
.getHighlightColor() : null;
288 // These are filter states; highlight is stored as boolean
289 highlightedItems
.highlight
= this.filtersModel
.isHighlightEnabled();
292 this.savedQueriesModel
.addNewQuery(
293 label
|| mw
.msg( 'rcfilters-savedqueries-defaultlabel' ),
295 filters
: this.filtersModel
.getSelectedState(),
296 highlights
: highlightedItems
,
297 invert
: this.filtersModel
.areNamespacesInverted()
302 this._saveSavedQueries();
306 * Remove a saved query
308 * @param {string} queryID Query id
310 mw
.rcfilters
.Controller
.prototype.removeSavedQuery = function ( queryID
) {
311 var query
= this.savedQueriesModel
.getItemByID( queryID
);
313 this.savedQueriesModel
.removeItems( [ query
] );
315 // Check if this item was the default
316 if ( this.savedQueriesModel
.getDefault() === queryID
) {
317 // Nulify the default
318 this.savedQueriesModel
.setDefault( null );
320 this._saveSavedQueries();
324 * Rename a saved query
326 * @param {string} queryID Query id
327 * @param {string} newLabel New label for the query
329 mw
.rcfilters
.Controller
.prototype.renameSavedQuery = function ( queryID
, newLabel
) {
330 var queryItem
= this.savedQueriesModel
.getItemByID( queryID
);
333 queryItem
.updateLabel( newLabel
);
335 this._saveSavedQueries();
339 * Set a saved query as default
341 * @param {string} queryID Query Id. If null is given, default
344 mw
.rcfilters
.Controller
.prototype.setDefaultSavedQuery = function ( queryID
) {
345 this.savedQueriesModel
.setDefault( queryID
);
346 this._saveSavedQueries();
352 * @param {string} queryID Query id
354 mw
.rcfilters
.Controller
.prototype.applySavedQuery = function ( queryID
) {
355 var data
, highlights
,
356 queryItem
= this.savedQueriesModel
.getItemByID( queryID
);
359 data
= queryItem
.getData();
360 highlights
= data
.highlights
;
362 // Backwards compatibility; initial version mispelled 'highlight' with 'highlights'
363 highlights
.highlight
= highlights
.highlights
|| highlights
.highlight
;
365 // Update model state from filters
366 this.filtersModel
.toggleFiltersSelected( data
.filters
);
368 // Update namespace inverted property
369 this.filtersModel
.toggleInvertedNamespaces( !!Number( data
.invert
) );
371 // Update highlight state
372 this.filtersModel
.toggleHighlight( !!Number( highlights
.highlight
) );
373 this.filtersModel
.getItems().forEach( function ( filterItem
) {
374 var color
= highlights
[ filterItem
.getName() ];
376 filterItem
.setHighlightColor( color
);
378 filterItem
.clearHighlightColor();
382 // Check all filter interactions
383 this.filtersModel
.reassessFilterInteractions();
385 this.updateChangesList();
390 * Check whether the current filter and highlight state exists
391 * in the saved queries model.
393 * @return {boolean} Query exists
395 mw
.rcfilters
.Controller
.prototype.findQueryMatchingCurrentState = function () {
396 var highlightedItems
= {};
398 // Prepare highlights of the current query
399 this.filtersModel
.getItemsSupportingHighlights().forEach( function ( item
) {
400 highlightedItems
[ item
.getName() ] = item
.getHighlightColor();
402 highlightedItems
.highlight
= this.filtersModel
.isHighlightEnabled();
404 return this.savedQueriesModel
.findMatchingQuery(
406 filters
: this.filtersModel
.getSelectedState(),
407 highlights
: highlightedItems
,
408 invert
: this.filtersModel
.areNamespacesInverted()
414 * Get an object representing the base state of parameters
417 * This is meant to make sure that the saved queries that are
418 * in memory are always the same structure as what we would get
419 * by calling the current model's "getSelectedState" and by checking
422 * In cases where a user saved a query when the system had a certain
423 * set of filters, and then a filter was added to the system, we want
424 * to make sure that the stored queries can still be comparable to
425 * the current state, which means that we need the base state for
428 * - Saved queries are stored in "minimal" view (only changed filters
429 * are stored); When we initialize the system, we merge each minimal
430 * query with the base state (using 'getNormalizedFilters') so all
431 * saved queries have the exact same structure as what we would get
432 * by checking the getSelectedState of the filter.
433 * - When we save the queries, we minimize the object to only represent
434 * whatever has actually changed, rather than store the entire
435 * object. To check what actually is different so we can store it,
436 * we need to obtain a base state to compare against, this is
437 * what #_getMinimalFilterList does
439 mw
.rcfilters
.Controller
.prototype._buildBaseFilterState = function () {
440 var defaultParams
= this.filtersModel
.getDefaultParams(),
441 highlightedItems
= {};
443 // Prepare highlights
444 this.filtersModel
.getItemsSupportingHighlights().forEach( function ( item
) {
445 highlightedItems
[ item
.getName() ] = null;
447 highlightedItems
.highlight
= false;
449 this.baseFilterState
= {
450 filters
: this.filtersModel
.getFiltersFromParameters( defaultParams
),
451 highlights
: highlightedItems
,
457 * Get an object representing the base filter state of both
458 * filters and highlights. The structure is similar to what we use
459 * to store each query in the saved queries object:
465 * filterName: (string|null)
469 * @return {Object} Object representing the base state of
470 * parameters and highlights
472 mw
.rcfilters
.Controller
.prototype._getBaseFilterState = function () {
473 return this.baseFilterState
;
477 * Get an object that holds only the parameters and highlights that have
478 * values different than the base default value.
480 * This is the reverse of the normalization we do initially on loading and
481 * initializing the saved queries model.
483 * @param {Object} valuesObject Object representing the state of both
484 * filters and highlights in its normalized version, to be minimized.
485 * @return {Object} Minimal filters and highlights list
487 mw
.rcfilters
.Controller
.prototype._getMinimalFilterList = function ( valuesObject
) {
488 var result
= { filters
: {}, highlights
: {} },
489 baseState
= this._getBaseFilterState();
492 $.each( valuesObject
.filters
, function ( name
, value
) {
493 if ( baseState
.filters
!== undefined && baseState
.filters
[ name
] !== value
) {
494 result
.filters
[ name
] = value
;
498 $.each( valuesObject
.highlights
, function ( name
, value
) {
499 if ( baseState
.highlights
!== undefined && baseState
.highlights
[ name
] !== value
) {
500 result
.highlights
[ name
] = value
;
508 * Save the current state of the saved queries model with all
509 * query item representation in the user settings.
511 mw
.rcfilters
.Controller
.prototype._saveSavedQueries = function () {
513 state
= this.savedQueriesModel
.getState(),
516 // Minimize before save
517 $.each( state
.queries
, function ( queryID
, info
) {
518 state
.queries
[ queryID
].data
= controller
._getMinimalFilterList( info
.data
);
522 stringified
= JSON
.stringify( state
);
524 if ( stringified
.length
> 65535 ) {
525 // Sanity check, since the preference can only hold that.
529 // Save the preference
530 new mw
.Api().saveOption( 'rcfilters-saved-queries', stringified
);
531 // Update the preference for this session
532 mw
.user
.options
.set( 'rcfilters-saved-queries', stringified
);
536 * Synchronize the URL with the current state of the filters
537 * without adding an history entry.
539 mw
.rcfilters
.Controller
.prototype.replaceUrl = function () {
540 mw
.rcfilters
.UriProcessor
.static.replaceState( this._getUpdatedUri() );
544 * Update filter state (selection and highlighting) based
545 * on current URL values.
547 * @param {boolean} [fetchChangesList=true] Fetch new results into the changes
548 * list based on the updated model.
550 mw
.rcfilters
.Controller
.prototype.updateStateFromUrl = function ( fetchChangesList
) {
551 fetchChangesList
= fetchChangesList
=== undefined ? true : !!fetchChangesList
;
553 this.uriProcessor
.updateModelBasedOnQuery( new mw
.Uri().query
);
555 // Only update and fetch new results if it is requested
556 if ( fetchChangesList
) {
557 this.updateChangesList();
562 * Update the list of changes and notify the model
564 * @param {Object} [params] Extra parameters to add to the API call
566 mw
.rcfilters
.Controller
.prototype.updateChangesList = function ( params
) {
567 this._updateURL( params
);
568 this.changesListModel
.invalidate();
569 this._fetchChangesList()
572 function ( pieces
) {
573 var $changesListContent
= pieces
.changes
,
574 $fieldset
= pieces
.fieldset
;
575 this.changesListModel
.update( $changesListContent
, $fieldset
);
577 // Do nothing for failure
582 * Get an object representing the default parameter state, whether
583 * it is from the model defaults or from the saved queries.
585 * @return {Object} Default parameters
587 mw
.rcfilters
.Controller
.prototype._getDefaultParams = function () {
588 var data
, queryHighlights
,
590 savedHighlights
= {},
591 defaultSavedQueryItem
= this.savedQueriesModel
.getItemByID( this.savedQueriesModel
.getDefault() );
593 if ( mw
.config
.get( 'wgStructuredChangeFiltersEnableSaving' ) &&
594 defaultSavedQueryItem
) {
596 data
= defaultSavedQueryItem
.getData();
598 queryHighlights
= data
.highlights
|| {};
599 savedParams
= this.filtersModel
.getParametersFromFilters( data
.filters
|| {} );
601 // Translate highlights to parameters
602 savedHighlights
.highlight
= String( Number( queryHighlights
.highlight
) );
603 $.each( queryHighlights
, function ( filterName
, color
) {
604 if ( filterName
!== 'highlights' ) {
605 savedHighlights
[ filterName
+ '_color' ] = color
;
609 return $.extend( true, {}, savedParams
, savedHighlights
, { invert
: data
.invert
} );
614 this.filtersModel
.getDefaultParams()
619 * Get an object representing the default parameter state, whether
620 * it is from the model defaults or from the saved queries.
622 * @return {Object} Default parameters
624 mw
.rcfilters
.Controller
.prototype._getDefaultParams = function () {
625 var data
, queryHighlights
,
627 savedHighlights
= {},
628 defaultSavedQueryItem
= this.savedQueriesModel
.getItemByID( this.savedQueriesModel
.getDefault() );
630 if ( mw
.config
.get( 'wgStructuredChangeFiltersEnableSaving' ) &&
631 defaultSavedQueryItem
) {
633 data
= defaultSavedQueryItem
.getData();
635 queryHighlights
= data
.highlights
|| {};
636 savedParams
= this.filtersModel
.getParametersFromFilters( data
.filters
|| {} );
638 // Translate highlights to parameters
639 savedHighlights
.highlight
= String( Number( queryHighlights
.highlight
) );
640 $.each( queryHighlights
, function ( filterName
, color
) {
641 if ( filterName
!== 'highlights' ) {
642 savedHighlights
[ filterName
+ '_color' ] = color
;
646 return $.extend( true, {}, savedParams
, savedHighlights
);
649 return this.filtersModel
.getDefaultParams();
653 * Update the URL of the page to reflect current filters
655 * This should not be called directly from outside the controller.
656 * If an action requires changing the URL, it should either use the
657 * highlighting actions below, or call #updateChangesList which does
658 * the uri corrections already.
660 * @param {Object} [params] Extra parameters to add to the API call
662 mw
.rcfilters
.Controller
.prototype._updateURL = function ( params
) {
663 var currentUri
= new mw
.Uri(),
664 updatedUri
= this._getUpdatedUri();
666 updatedUri
.extend( params
|| {} );
669 this.uriProcessor
.getVersion( currentUri
.query
) !== 2 ||
670 this.uriProcessor
.isNewState( currentUri
.query
, updatedUri
.query
)
672 mw
.rcfilters
.UriProcessor
.static.replaceState( updatedUri
);
677 * Get an updated mw.Uri object based on the model state
679 * @return {mw.Uri} Updated Uri
681 mw
.rcfilters
.Controller
.prototype._getUpdatedUri = function () {
682 var uri
= new mw
.Uri();
685 uri
.query
= this.uriProcessor
.minimizeQuery(
689 // We want to retain unrecognized params
690 // The uri params from model will override
691 // any recognized value in the current uri
692 // query, retain unrecognized params, and
693 // the result will then be minimized
695 this.uriProcessor
.getUriParametersFromModel(),
704 * Fetch the list of changes from the server for the current filters
706 * @return {jQuery.Promise} Promise object that will resolve with the changes list
707 * or with a string denoting no results.
709 mw
.rcfilters
.Controller
.prototype._fetchChangesList = function () {
710 var uri
= this._getUpdatedUri(),
711 requestId
= ++this.requestCounter
,
712 latestRequest = function () {
713 return requestId
=== this.requestCounter
;
716 return $.ajax( uri
.toString(), { contentType
: 'html' } )
721 if ( !latestRequest() ) {
722 return $.Deferred().reject();
725 $parsed
= $( $.parseHTML( html
) );
729 changes
: $parsed
.find( '.mw-changeslist' ).first().contents(),
731 fieldset
: $parsed
.find( 'fieldset.rcoptions' ).first()
735 function ( responseObj
) {
738 if ( !latestRequest() ) {
739 return $.Deferred().reject();
742 $parsed
= $( $.parseHTML( responseObj
.responseText
) );
744 // Force a resolve state to this promise
745 return $.Deferred().resolve( {
746 changes
: 'NO_RESULTS',
747 fieldset
: $parsed
.find( 'fieldset.rcoptions' ).first()
754 * Track usage of highlight feature
756 * @param {string} action
757 * @param {array|object|string} filters
759 mw
.rcfilters
.Controller
.prototype._trackHighlight = function ( action
, filters
) {
760 filters
= typeof filters
=== 'string' ? { name
: filters
} : filters
;
761 filters
= !Array
.isArray( filters
) ? [ filters
] : filters
;
763 'event.ChangesListHighlights',
767 userId
: mw
.user
.getId()
772 }( mediaWiki
, jQuery
) );