3 * View model for the filters selection and display
5 * @mixins OO.EventEmitter
6 * @mixins OO.EmitterList
10 mw
.rcfilters
.dm
.FiltersViewModel
= function MwRcfiltersDmFiltersViewModel() {
12 OO
.EventEmitter
.call( this );
13 OO
.EmitterList
.call( this );
16 this.defaultParams
= {};
17 this.defaultFiltersEmpty
= null;
18 this.highlightEnabled
= false;
19 this.parameterMap
= {};
22 this.aggregate( { update
: 'filterItemUpdate' } );
23 this.connect( this, { filterItemUpdate
: [ 'emit', 'itemUpdate' ] } );
27 OO
.initClass( mw
.rcfilters
.dm
.FiltersViewModel
);
28 OO
.mixinClass( mw
.rcfilters
.dm
.FiltersViewModel
, OO
.EventEmitter
);
29 OO
.mixinClass( mw
.rcfilters
.dm
.FiltersViewModel
, OO
.EmitterList
);
36 * Filter list is initialized
41 * @param {mw.rcfilters.dm.FilterItem} item Filter item updated
43 * Filter item has changed
47 * @event highlightChange
48 * @param {boolean} Highlight feature is enabled
50 * Highlight feature has been toggled enabled or disabled
56 * Re-assess the states of filter items based on the interactions between them
58 * @param {mw.rcfilters.dm.FilterItem} [item] Changed item. If not given, the
59 * method will go over the state of all items
61 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.reassessFilterInteractions = function ( item
) {
64 iterationItems
= item
!== undefined ? [ item
] : this.getItems();
66 iterationItems
.forEach( function ( checkedItem
) {
67 var allCheckedItems
= checkedItem
.getSubset().concat( [ checkedItem
.getName() ] ),
68 groupModel
= checkedItem
.getGroupModel();
70 // Check for subsets (included filters) plus the item itself:
71 allCheckedItems
.forEach( function ( filterItemName
) {
72 var itemInSubset
= model
.getItemByName( filterItemName
);
74 itemInSubset
.toggleIncluded(
75 // If any of itemInSubset's supersets are selected, this item
77 itemInSubset
.getSuperset().some( function ( supersetName
) {
78 return ( model
.getItemByName( supersetName
).isSelected() );
83 // Update coverage for the changed group
84 if ( groupModel
.isFullCoverage() ) {
85 allSelected
= groupModel
.areAllSelected();
86 groupModel
.getItems().forEach( function ( filterItem
) {
87 filterItem
.toggleFullyCovered( allSelected
);
92 // Check for conflicts
93 // In this case, we must go over all items, since
94 // conflicts are bidirectional and depend not only on
95 // individual items, but also on the selected states of
96 // the groups they're in.
97 this.getItems().forEach( function ( filterItem
) {
98 var inConflict
= false,
99 filterItemGroup
= filterItem
.getGroupModel();
101 // For each item, see if that item is still conflicting
102 $.each( model
.groups
, function ( groupName
, groupModel
) {
103 if ( filterItem
.getGroupName() === groupName
) {
104 // Check inside the group
105 inConflict
= groupModel
.areAnySelectedInConflictWith( filterItem
);
107 // According to the spec, if two items conflict from two different
108 // groups, the conflict only lasts if the groups **only have selected
109 // items that are conflicting**. If a group has selected items that
110 // are conflicting and non-conflicting, the scope of the result has
111 // expanded enough to completely remove the conflict.
113 // For example, see two groups with conflicts:
116 // name: 'experienced',
117 // conflicts: [ 'unregistered' ]
122 // name: 'registered',
125 // name: 'unregistered',
128 // If we select 'experienced', then 'unregistered' is in conflict (and vice versa),
129 // because, inherently, 'experienced' filter only includes registered users, and so
130 // both filters are in conflict with one another.
131 // However, the minute we select 'registered', the scope of our results
132 // has expanded to no longer have a conflict with 'experienced' filter, and
133 // so the conflict is removed.
135 // In our case, we need to check if the entire group conflicts with
136 // the entire item's group, so we follow the above spec
138 // The foreign group is in conflict with this item
139 groupModel
.areAllSelectedInConflictWith( filterItem
) &&
140 // Every selected member of the item's own group is also
141 // in conflict with the other group
142 filterItemGroup
.getSelectedItems().every( function ( otherGroupItem
) {
143 return groupModel
.areAllSelectedInConflictWith( otherGroupItem
);
148 // If we're in conflict, this will return 'false' which
149 // will break the loop. Otherwise, we're not in conflict
150 // and the loop continues
154 // Toggle the item state
155 filterItem
.toggleConflicted( inConflict
);
160 * Set filters and preserve a group relationship based on
161 * the definition given by an object
163 * @param {Array} filters Filter group definition
165 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.initializeFilters = function ( filters
) {
166 var i
, filterItem
, selectedFilterNames
, filterConflictResult
, groupConflictResult
, subsetNames
,
170 groupConflictMap
= {},
171 filterConflictMap
= {},
172 addArrayElementsUnique = function ( arr
, elements
) {
173 elements
= Array
.isArray( elements
) ? elements
: [ elements
];
175 elements
.forEach( function ( element
) {
176 if ( arr
.indexOf( element
) === -1 ) {
183 expandConflictDefinitions = function ( obj
) {
186 $.each( obj
, function ( key
, conflicts
) {
188 adjustedConflicts
= {};
190 conflicts
.forEach( function ( conflict
) {
191 if ( conflict
.filter
) {
192 filterName
= model
.groups
[ conflict
.group
].getNamePrefix() + conflict
.filter
;
195 adjustedConflicts
[ filterName
] = $.extend(
198 { filter
: filterName
}
201 // This conflict is for an entire group. Split it up to
202 // represent each filter
204 // Get the relevant group items
205 model
.groups
[ conflict
.group
].getItems().forEach( function ( groupItem
) {
206 // Rebuild the conflict
207 adjustedConflicts
[ groupItem
.getName() ] = $.extend(
210 { filter
: groupItem
.getName() }
216 result
[ key
] = adjustedConflicts
;
226 filters
.forEach( function ( data
) {
227 var group
= data
.name
;
229 if ( !model
.groups
[ group
] ) {
230 model
.groups
[ group
] = new mw
.rcfilters
.dm
.FilterGroup( group
, {
232 title
: mw
.msg( data
.title
),
233 separator
: data
.separator
,
234 fullCoverage
: !!data
.fullCoverage
,
236 body
: data
.whatsThisBody
,
237 header
: data
.whatsThisHeader
,
238 linkText
: data
.whatsThisLinkText
,
239 url
: data
.whatsThisUrl
244 if ( data
.conflicts
) {
245 groupConflictMap
[ group
] = data
.conflicts
;
248 selectedFilterNames
= [];
249 for ( i
= 0; i
< data
.filters
.length
; i
++ ) {
250 data
.filters
[ i
].subset
= data
.filters
[ i
].subset
|| [];
251 data
.filters
[ i
].subset
= data
.filters
[ i
].subset
.map( function ( el
) {
255 filterItem
= new mw
.rcfilters
.dm
.FilterItem( data
.filters
[ i
].name
, model
.groups
[ group
], {
257 label
: mw
.msg( data
.filters
[ i
].label
),
258 description
: mw
.msg( data
.filters
[ i
].description
),
259 cssClass
: data
.filters
[ i
].cssClass
262 if ( data
.filters
[ i
].subset
) {
264 data
.filters
[ i
].subset
.forEach( function ( subsetFilterName
) { // eslint-disable-line no-loop-func
265 var subsetName
= model
.groups
[ group
].getNamePrefix() + subsetFilterName
;
266 // For convenience, we should store each filter's "supersets" -- these are
267 // the filters that have that item in their subset list. This will just
268 // make it easier to go through whether the item has any other items
269 // that affect it (and are selected) at any given time
270 supersetMap
[ subsetName
] = supersetMap
[ subsetName
] || [];
271 addArrayElementsUnique(
272 supersetMap
[ subsetName
],
276 // Translate subset param name to add the group name, so we
277 // get consistent naming. We know that subsets are only within
279 subsetNames
.push( subsetName
);
282 // Set translated subset
283 filterItem
.setSubset( subsetNames
);
287 if ( data
.filters
[ i
].conflicts
) {
288 filterConflictMap
[ filterItem
.getName() ] = data
.filters
[ i
].conflicts
;
291 if ( data
.type
=== 'send_unselected_if_any' ) {
292 // Store the default parameter state
293 // For this group type, parameter values are direct
294 model
.defaultParams
[ data
.filters
[ i
].name
] = Number( !!data
.filters
[ i
].default );
296 data
.type
=== 'string_options' &&
297 data
.filters
[ i
].default
299 selectedFilterNames
.push( data
.filters
[ i
].name
);
302 model
.groups
[ group
].addItems( filterItem
);
303 items
.push( filterItem
);
306 if ( data
.type
=== 'string_options' ) {
307 // Store the default parameter group state
308 // For this group, the parameter is group name and value is the names
310 model
.defaultParams
[ group
] = model
.sanitizeStringOptionGroup( group
, selectedFilterNames
).join( model
.groups
[ group
].getSeparator() );
315 groupConflictResult
= expandConflictDefinitions( groupConflictMap
);
316 filterConflictResult
= expandConflictDefinitions( filterConflictMap
);
318 // Set conflicts for groups
319 $.each( groupConflictResult
, function ( group
, conflicts
) {
320 model
.groups
[ group
].setConflicts( conflicts
);
323 items
.forEach( function ( filterItem
) {
324 // Apply the superset map
325 filterItem
.setSuperset( supersetMap
[ filterItem
.getName() ] );
327 // set conflicts for item
328 if ( filterConflictResult
[ filterItem
.getName() ] ) {
329 filterItem
.setConflicts( filterConflictResult
[ filterItem
.getName() ] );
333 // Create a map between known parameters and their models
334 $.each( this.groups
, function ( group
, groupModel
) {
335 if ( groupModel
.getType() === 'send_unselected_if_any' ) {
336 // Individual filters
337 groupModel
.getItems().forEach( function ( filterItem
) {
338 model
.parameterMap
[ filterItem
.getParamName() ] = filterItem
;
340 } else if ( groupModel
.getType() === 'string_options' ) {
342 model
.parameterMap
[ groupModel
.getName() ] = groupModel
;
346 // Add items to the model
347 this.addItems( items
);
349 this.emit( 'initialize' );
353 * Get the names of all available filters
355 * @return {string[]} An array of filter names
357 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.getFilterNames = function () {
358 return this.getItems().map( function ( item
) { return item
.getName(); } );
362 * Get the object that defines groups by their name.
364 * @return {Object} Filter groups
366 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.getFilterGroups = function () {
371 * Get the value of a specific parameter
373 * @param {string} name Parameter name
374 * @return {number|string} Parameter value
376 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.getParamValue = function ( name
) {
377 return this.parameters
[ name
];
381 * Get the current selected state of the filters
383 * @return {Object} Filters selected state
385 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.getSelectedState = function () {
387 items
= this.getItems(),
390 for ( i
= 0; i
< items
.length
; i
++ ) {
391 result
[ items
[ i
].getName() ] = items
[ i
].isSelected();
398 * Get the current full state of the filters
400 * @return {Object} Filters full state
402 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.getFullState = function () {
404 items
= this.getItems(),
407 for ( i
= 0; i
< items
.length
; i
++ ) {
408 result
[ items
[ i
].getName() ] = {
409 selected
: items
[ i
].isSelected(),
410 conflicted
: items
[ i
].isConflicted(),
411 included
: items
[ i
].isIncluded()
419 * Get the default parameters object
421 * @return {Object} Default parameter values
423 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.getDefaultParams = function () {
424 return this.defaultParams
;
428 * Set all filter states to default values
430 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.setFiltersToDefaults = function () {
431 var defaultFilterStates
= this.getFiltersFromParameters( this.getDefaultParams() );
433 this.toggleFiltersSelected( defaultFilterStates
);
437 * Analyze the groups and their filters and output an object representing
438 * the state of the parameters they represent.
440 * @param {Object} [filterGroups] An object defining the filter groups to
441 * translate to parameters. Its structure must follow that of this.groups
442 * see #getFilterGroups
443 * @return {Object} Parameter state object
445 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.getParametersFromFilters = function ( filterGroups
) {
447 groupItems
= filterGroups
|| this.getFilterGroups();
449 $.each( groupItems
, function ( group
, model
) {
450 $.extend( result
, model
.getParamRepresentation() );
457 * Get the highlight parameters based on current filter configuration
459 * @return {object} Object where keys are "<filter name>_color" and values
460 * are the selected highlight colors.
462 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.getHighlightParameters = function () {
463 var result
= { highlight
: Number( this.isHighlightEnabled() ) };
465 this.getItems().forEach( function ( filterItem
) {
466 result
[ filterItem
.getName() + '_color' ] = filterItem
.getHighlightColor();
472 * Sanitize value group of a string_option groups type
473 * Remove duplicates and make sure to only use valid
477 * @param {string} groupName Group name
478 * @param {string[]} valueArray Array of values
479 * @return {string[]} Array of valid values
481 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.sanitizeStringOptionGroup = function( groupName
, valueArray
) {
483 validNames
= this.getGroupFilters( groupName
).map( function ( filterItem
) {
484 return filterItem
.getParamName();
487 if ( valueArray
.indexOf( 'all' ) > -1 ) {
488 // If anywhere in the values there's 'all', we
489 // treat it as if only 'all' was selected.
490 // Example: param=valid1,valid2,all
495 // Get rid of any dupe and invalid parameter, only output
497 // Example: param=valid1,valid2,invalid1,valid1
498 // Result: param=valid1,valid2
499 valueArray
.forEach( function ( value
) {
501 validNames
.indexOf( value
) > -1 &&
502 result
.indexOf( value
) === -1
504 result
.push( value
);
512 * Check whether the current filter state is set to all false.
514 * @return {boolean} Current filters are all empty
516 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.areCurrentFiltersEmpty = function () {
517 // Check if there are either any selected items or any items
518 // that have highlight enabled
519 return !this.getItems().some( function ( filterItem
) {
520 return filterItem
.isSelected() || filterItem
.isHighlighted();
525 * Check whether the default values of the filters are all false.
527 * @return {boolean} Default filters are all false
529 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.areDefaultFiltersEmpty = function () {
532 if ( this.defaultFiltersEmpty
!== null ) {
533 // We only need to do this test once,
534 // because defaults are set once per session
535 defaultFilters
= this.getFiltersFromParameters();
536 this.defaultFiltersEmpty
= Object
.keys( defaultFilters
).every( function ( filterName
) {
537 return !defaultFilters
[ filterName
];
541 return this.defaultFiltersEmpty
;
545 * This is the opposite of the #getParametersFromFilters method; this goes over
546 * the given parameters and translates into a selected/unselected value in the filters.
548 * @param {Object} params Parameters query object
549 * @return {Object} Filter state object
551 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.getFiltersFromParameters = function ( params
) {
555 base
= this.getDefaultParams(),
558 params
= $.extend( {}, base
, params
);
560 // Go over the given parameters
561 $.each( params
, function ( paramName
, paramValue
) {
562 var itemOrGroup
= model
.parameterMap
[ paramName
];
564 if ( itemOrGroup
instanceof mw
.rcfilters
.dm
.FilterItem
) {
565 // Mark the group if it has any items that are selected
566 groupMap
[ itemOrGroup
.getGroupName() ] = groupMap
[ itemOrGroup
.getGroupName() ] || {};
567 groupMap
[ itemOrGroup
.getGroupName() ].hasSelected
= (
568 groupMap
[ itemOrGroup
.getGroupName() ].hasSelected
||
569 !!Number( paramValue
)
573 groupMap
[ itemOrGroup
.getGroupName() ].filters
= groupMap
[ itemOrGroup
.getGroupName() ].filters
|| [];
574 groupMap
[ itemOrGroup
.getGroupName() ].filters
.push( itemOrGroup
);
575 } else if ( itemOrGroup
instanceof mw
.rcfilters
.dm
.FilterGroup
) {
576 groupMap
[ itemOrGroup
.getName() ] = groupMap
[ itemOrGroup
.getName() ] || {};
577 // This parameter represents a group (values are the filters)
578 // this is equivalent to checking if the group is 'string_options'
579 groupMap
[ itemOrGroup
.getName() ].filters
= itemOrGroup
.getItems();
583 // Now that we know the groups' selection states, we need to go over
584 // the filters in the groups and mark their selected states appropriately
585 $.each( groupMap
, function ( group
, data
) {
586 var paramValues
, filterItem
,
587 allItemsInGroup
= data
.filters
;
589 if ( model
.groups
[ group
].getType() === 'send_unselected_if_any' ) {
590 for ( i
= 0; i
< allItemsInGroup
.length
; i
++ ) {
591 filterItem
= allItemsInGroup
[ i
];
593 result
[ filterItem
.getName() ] = groupMap
[ filterItem
.getGroupName() ].hasSelected
?
594 // Flip the definition between the parameter
595 // state and the filter state
596 // This is what the 'toggleSelected' value of the filter is
597 !Number( params
[ filterItem
.getParamName() ] ) :
598 // Otherwise, there are no selected items in the
599 // group, which means the state is false
602 } else if ( model
.groups
[ group
].getType() === 'string_options' ) {
603 paramValues
= model
.sanitizeStringOptionGroup(
605 params
[ group
].split(
606 model
.groups
[ group
].getSeparator()
610 for ( i
= 0; i
< allItemsInGroup
.length
; i
++ ) {
611 filterItem
= allItemsInGroup
[ i
];
613 result
[ filterItem
.getName() ] = (
614 // If it is the word 'all'
615 paramValues
.length
=== 1 && paramValues
[ 0 ] === 'all' ||
616 // All values are written
617 paramValues
.length
=== model
.groups
[ group
].getItemCount()
619 // All true (either because all values are written or the term 'all' is written)
620 // is the same as all filters set to false
622 // Otherwise, the filter is selected only if it appears in the parameter values
623 paramValues
.indexOf( filterItem
.getParamName() ) > -1;
632 * Get the item that matches the given name
634 * @param {string} name Filter name
635 * @return {mw.rcfilters.dm.FilterItem} Filter item
637 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.getItemByName = function ( name
) {
638 return this.getItems().filter( function ( item
) {
639 return name
=== item
.getName();
644 * Set all filters to false or empty/all
645 * This is equivalent to display all.
647 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.emptyAllFilters = function () {
648 this.getItems().forEach( function ( filterItem
) {
649 this.toggleFilterSelected( filterItem
.getName(), false );
654 * Toggle selected state of one item
656 * @param {string} name Name of the filter item
657 * @param {boolean} [isSelected] Filter selected state
659 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.toggleFilterSelected = function ( name
, isSelected
) {
660 var item
= this.getItemByName( name
);
663 item
.toggleSelected( isSelected
);
668 * Toggle selected state of items by their names
670 * @param {Object} filterDef Filter definitions
672 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.toggleFiltersSelected = function ( filterDef
) {
673 Object
.keys( filterDef
).forEach( function ( name
) {
674 this.toggleFilterSelected( name
, filterDef
[ name
] );
679 * Get a group model from its name
681 * @param {string} groupName Group name
682 * @return {mw.rcfilters.dm.FilterGroup} Group model
684 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.getGroup = function ( groupName
) {
685 return this.groups
[ groupName
];
689 * Get all filters within a specified group by its name
691 * @param {string} groupName Group name
692 * @return {mw.rcfilters.dm.FilterItem[]} Filters belonging to this group
694 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.getGroupFilters = function ( groupName
) {
695 return ( this.getGroup( groupName
) && this.getGroup( groupName
).getItems() ) || [];
699 * Find items whose labels match the given string
701 * @param {string} query Search string
702 * @return {Object} An object of items to show
703 * arranged by their group names
705 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.findMatches = function ( query
) {
709 items
= this.getItems();
711 // Normalize so we can search strings regardless of case
712 query
= query
.toLowerCase();
714 // item label starting with the query string
715 for ( i
= 0; i
< items
.length
; i
++ ) {
716 if ( items
[ i
].getLabel().toLowerCase().indexOf( query
) === 0 ) {
717 result
[ items
[ i
].getGroupName() ] = result
[ items
[ i
].getGroupName() ] || [];
718 result
[ items
[ i
].getGroupName() ].push( items
[ i
] );
722 if ( $.isEmptyObject( result
) ) {
723 // item containing the query string in their label, description, or group title
724 for ( i
= 0; i
< items
.length
; i
++ ) {
725 groupTitle
= items
[ i
].getGroupModel().getTitle();
727 items
[ i
].getLabel().toLowerCase().indexOf( query
) > -1 ||
728 items
[ i
].getDescription().toLowerCase().indexOf( query
) > -1 ||
729 groupTitle
.toLowerCase().indexOf( query
) > -1
731 result
[ items
[ i
].getGroupName() ] = result
[ items
[ i
].getGroupName() ] || [];
732 result
[ items
[ i
].getGroupName() ].push( items
[ i
] );
741 * Get items that are highlighted
743 * @return {mw.rcfilters.dm.FilterItem[]} Highlighted items
745 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.getHighlightedItems = function () {
746 return this.getItems().filter( function ( filterItem
) {
747 return filterItem
.isHighlightSupported() &&
748 filterItem
.getHighlightColor();
753 * Toggle the highlight feature on and off.
754 * Propagate the change to filter items.
756 * @param {boolean} enable Highlight should be enabled
757 * @fires highlightChange
759 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.toggleHighlight = function ( enable
) {
760 enable
= enable
=== undefined ? !this.highlightEnabled
: enable
;
762 if ( this.highlightEnabled
!== enable
) {
763 this.highlightEnabled
= enable
;
765 this.getItems().forEach( function ( filterItem
) {
766 filterItem
.toggleHighlight( this.highlightEnabled
);
769 this.emit( 'highlightChange', this.highlightEnabled
);
774 * Check if the highlight feature is enabled
777 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.isHighlightEnabled = function () {
778 return !!this.highlightEnabled
;
782 * Set highlight color for a specific filter item
784 * @param {string} filterName Name of the filter item
785 * @param {string} color Selected color
787 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.setHighlightColor = function ( filterName
, color
) {
788 this.getItemByName( filterName
).setHighlightColor( color
);
792 * Clear highlight for a specific filter item
794 * @param {string} filterName Name of the filter item
796 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.clearHighlightColor = function ( filterName
) {
797 this.getItemByName( filterName
).clearHighlightColor();
801 * Clear highlight for all filter items
803 mw
.rcfilters
.dm
.FiltersViewModel
.prototype.clearAllHighlightColors = function () {
804 this.getItems().forEach( function ( filterItem
) {
805 filterItem
.clearHighlightColor();
808 }( mediaWiki
, jQuery
) );