X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=resources%2Fsrc%2Fmediawiki.rcfilters%2Fdm%2Fmw.rcfilters.dm.FilterGroup.js;h=6acc44dc5b41ca1934e3698f6580a0e8c7fcc09c;hb=a2c8c2969420a0f150c03f76e3a0bf9028fcda43;hp=4915803c9f7cdf27c3de2dff9dc2f57024a29e67;hpb=f22ed7a94758561ace10ef9506425134b293cb13;p=lhc%2Fweb%2Fwiklou.git diff --git a/resources/src/mediawiki.rcfilters/dm/mw.rcfilters.dm.FilterGroup.js b/resources/src/mediawiki.rcfilters/dm/mw.rcfilters.dm.FilterGroup.js index 4915803c9f..a62acc5b9e 100644 --- a/resources/src/mediawiki.rcfilters/dm/mw.rcfilters.dm.FilterGroup.js +++ b/resources/src/mediawiki.rcfilters/dm/mw.rcfilters.dm.FilterGroup.js @@ -11,8 +11,17 @@ * @cfg {string} [type='send_unselected_if_any'] Group type * @cfg {string} [view='default'] Name of the display group this group * is a part of. + * @cfg {boolean} [sticky] This group is 'sticky'. It is synchronized + * with a preference, does not participate in Saved Queries, and is + * not shown in the active filters area. * @cfg {string} [title] Group title * @cfg {boolean} [hidden] This group is hidden from the regular menu views + * and the active filters area. + * @cfg {boolean} [allowArbitrary] Allows for an arbitrary value to be added to the + * group from the URL, even if it wasn't initially set up. + * @cfg {number} [range] An object defining minimum and maximum values for numeric + * groups. { min: x, max: y } + * @cfg {number} [minValue] Minimum value for numeric groups * @cfg {string} [separator='|'] Value separator for 'string_options' groups * @cfg {boolean} [active] Group is active * @cfg {boolean} [fullCoverage] This filters in this group collectively cover all results @@ -25,6 +34,7 @@ * @cfg {string} [whatsThis.body] The body of the whatsThis popup message * @cfg {string} [whatsThis.url] The url for the link in the whatsThis popup message * @cfg {string} [whatsThis.linkMessage] The text for the link in the whatsThis popup message + * @cfg {boolean} [visible=true] The visibility of the group */ mw.rcfilters.dm.FilterGroup = function MwRcfiltersDmFilterGroup( name, config ) { config = config || {}; @@ -36,11 +46,16 @@ this.name = name; this.type = config.type || 'send_unselected_if_any'; this.view = config.view || 'default'; + this.sticky = !!config.sticky; this.title = config.title || name; this.hidden = !!config.hidden; + this.allowArbitrary = !!config.allowArbitrary; + this.numericRange = config.range; this.separator = config.separator || '|'; this.labelPrefixKey = config.labelPrefixKey; + this.visible = config.visible === undefined ? true : !!config.visible; + this.currSelected = null; this.active = !!config.active; this.fullCoverage = !!config.fullCoverage; @@ -48,6 +63,7 @@ this.conflicts = config.conflicts || {}; this.defaultParams = {}; + this.defaultFilters = {}; this.aggregate( { update: 'filterItemUpdate' } ); this.connect( this, { filterItemUpdate: 'onFilterItemUpdate' } ); @@ -75,7 +91,8 @@ * @param {string|Object} [groupDefault] Definition of the group default */ mw.rcfilters.dm.FilterGroup.prototype.initializeFilters = function ( filterDefinition, groupDefault ) { - var supersetMap = {}, + var defaultParam, + supersetMap = {}, model = this, items = []; @@ -88,7 +105,8 @@ description: filter.description || '', labelPrefixKey: model.labelPrefixKey, cssClass: filter.cssClass, - identifiers: filter.identifiers + identifiers: filter.identifiers, + defaultHighlightColor: filter.defaultHighlightColor } ); if ( filter.subset ) { @@ -126,11 +144,16 @@ items.push( filterItem ); // Store default parameter state; in this case, default is defined per filter - if ( model.getType() === 'send_unselected_if_any' ) { + if ( + model.getType() === 'send_unselected_if_any' || + model.getType() === 'boolean' + ) { // Store the default parameter state // For this group type, parameter values are direct // We need to convert from a boolean to a string ('1' and '0') - model.defaultParams[ filter.name ] = String( Number( !!filter.default ) ); + model.defaultParams[ filter.name ] = String( Number( filter.default || 0 ) ); + } else if ( model.getType() === 'any_value' ) { + model.defaultParams[ filter.name ] = filter.default; } } ); @@ -159,11 +182,43 @@ } ) ).join( this.getSeparator() ); } else if ( this.getType() === 'single_option' ) { + defaultParam = groupDefault !== undefined ? + groupDefault : this.getItems()[ 0 ].getParamName(); + // For this group, the parameter is the group name, - // and a single item can be selected, or none at all - // The item also must be recognized or none is set as - // default - model.defaultParams[ this.getName() ] = this.getItemByParamName( groupDefault ) ? groupDefault : ''; + // and a single item can be selected: default or first item + this.defaultParams[ this.getName() ] = defaultParam; + } + + // add highlights to defaultParams + this.getItems().forEach( function ( filterItem ) { + if ( filterItem.isHighlighted() ) { + this.defaultParams[ filterItem.getName() + '_color' ] = filterItem.getHighlightColor(); + } + }.bind( this ) ); + + // Store default filter state based on default params + this.defaultFilters = this.getFilterRepresentation( this.getDefaultParams() ); + + // Check for filters that should be initially selected by their default value + if ( this.isSticky() ) { + $.each( this.defaultFilters, function ( filterName, filterValue ) { + model.getItemByName( filterName ).toggleSelected( filterValue ); + } ); + } + + // Verify that single_option group has at least one item selected + if ( + this.getType() === 'single_option' && + this.findSelectedItems().length === 0 + ) { + defaultParam = groupDefault !== undefined ? + groupDefault : this.getItems()[ 0 ].getParamName(); + + // Single option means there must be a single option + // selected, so we have to either select the default + // or select the first option + this.selectItemByParamName( defaultParam ); } }; @@ -175,20 +230,56 @@ */ mw.rcfilters.dm.FilterGroup.prototype.onFilterItemUpdate = function ( item ) { // Update state - var active = this.areAnySelected(), - itemName = item && item.getName(); + var changed = false, + active = this.areAnySelected(), + model = this; + + if ( this.getType() === 'single_option' ) { + // This group must have one item selected always + // and must never have more than one item selected at a time + if ( this.findSelectedItems().length === 0 ) { + // Nothing is selected anymore + // Select the default or the first item + this.currSelected = this.getItemByParamName( this.defaultParams[ this.getName() ] ) || + this.getItems()[ 0 ]; + this.currSelected.toggleSelected( true ); + changed = true; + } else if ( this.findSelectedItems().length > 1 ) { + // There is more than one item selected + // This should only happen if the item given + // is the one that is selected, so unselect + // all items that is not it + this.findSelectedItems().forEach( function ( itemModel ) { + // Note that in case the given item is actually + // not selected, this loop will end up unselecting + // all items, which would trigger the case above + // when the last item is unselected anyways + var selected = itemModel.getName() === item.getName() && + item.isSelected(); + + itemModel.toggleSelected( selected ); + if ( selected ) { + model.currSelected = itemModel; + } + } ); + changed = true; + } + } - if ( item.isSelected() && this.getType() === 'single_option' ) { - // Change the selection to only be the newly selected item - this.getItems().forEach( function ( filterItem ) { - if ( filterItem.getName() !== itemName ) { - filterItem.toggleSelected( false ); - } - } ); + if ( this.isSticky() ) { + // If this group is sticky, then change the default according to the + // current selection. + this.defaultParams = this.getParamRepresentation( this.getSelectedState() ); } - if ( this.active !== active ) { + if ( + changed || + this.active !== active || + this.currSelected !== item + ) { this.active = active; + this.currSelected = item; + this.emit( 'update' ); } }; @@ -211,6 +302,35 @@ return this.hidden; }; + /** + * Get group allow arbitrary state + * + * @return {boolean} Group allows an arbitrary value from the URL + */ + mw.rcfilters.dm.FilterGroup.prototype.isAllowArbitrary = function () { + return this.allowArbitrary; + }; + + /** + * Get group maximum value for numeric groups + * + * @return {number|null} Group max value + */ + mw.rcfilters.dm.FilterGroup.prototype.getMaxValue = function () { + return this.numericRange && this.numericRange.max !== undefined ? + this.numericRange.max : null; + }; + + /** + * Get group minimum value for numeric groups + * + * @return {number|null} Group max value + */ + mw.rcfilters.dm.FilterGroup.prototype.getMinValue = function () { + return this.numericRange && this.numericRange.min !== undefined ? + this.numericRange.min : null; + }; + /** * Get group name * @@ -229,6 +349,24 @@ return this.defaultParams; }; + /** + * Get the default filter state of this group + * + * @return {Object} Default filter state + */ + mw.rcfilters.dm.FilterGroup.prototype.getDefaultFilters = function () { + return this.defaultFilters; + }; + + /** + * This is for a single_option and string_options group types + * it returns the value of the default + * + * @return {string} Value of the default + */ + mw.rcfilters.dm.FilterGroup.prototype.getDefaulParamValue = function () { + return this.defaultParams[ this.getName() ]; + }; /** * Get the messags defining the 'whats this' popup for this group * @@ -356,7 +494,7 @@ * @param {mw.rcfilters.dm.FilterItem} [excludeItem] Item to exclude from the list * @return {mw.rcfilters.dm.FilterItem[]} Selected items */ - mw.rcfilters.dm.FilterGroup.prototype.getSelectedItems = function ( excludeItem ) { + mw.rcfilters.dm.FilterGroup.prototype.findSelectedItems = function ( excludeItem ) { var excludeName = ( excludeItem && excludeItem.getName() ) || ''; return this.getItems().filter( function ( item ) { @@ -371,7 +509,7 @@ * @return {boolean} All selected items are in conflict with this item */ mw.rcfilters.dm.FilterGroup.prototype.areAllSelectedInConflictWith = function ( filterItem ) { - var selectedItems = this.getSelectedItems( filterItem ); + var selectedItems = this.findSelectedItems( filterItem ); return selectedItems.length > 0 && ( @@ -391,7 +529,7 @@ * @return {boolean} Any of the selected items are in conflict with this item */ mw.rcfilters.dm.FilterGroup.prototype.areAnySelectedInConflictWith = function ( filterItem ) { - var selectedItems = this.getSelectedItems( filterItem ); + var selectedItems = this.findSelectedItems( filterItem ); return selectedItems.length > 0 && ( // The group as a whole is in conflict with this item @@ -415,6 +553,7 @@ var values, areAnySelected = false, buildFromCurrentState = !filterRepresentation, + defaultFilters = this.getDefaultFilters(), result = {}, model = this, filterParamNames = {}, @@ -443,12 +582,16 @@ if ( buildFromCurrentState ) { // This means we have not been given a filter representation // so we are building one based on current state - filterRepresentation[ item.getName() ] = item.isSelected(); - } else if ( !filterRepresentation[ item.getName() ] ) { + filterRepresentation[ item.getName() ] = item.getValue(); + } else if ( filterRepresentation[ item.getName() ] === undefined ) { // We are given a filter representation, but we have to make // sure that we fill in the missing filters if there are any // we will assume they are all falsey - filterRepresentation[ item.getName() ] = false; + if ( model.isSticky() ) { + filterRepresentation[ item.getName() ] = !!defaultFilters[ item.getName() ]; + } else { + filterRepresentation[ item.getName() ] = false; + } } if ( filterRepresentation[ item.getName() ] ) { @@ -457,7 +600,11 @@ } ); // Build result - if ( this.getType() === 'send_unselected_if_any' ) { + if ( + this.getType() === 'send_unselected_if_any' || + this.getType() === 'boolean' || + this.getType() === 'any_value' + ) { // First, check if any of the items are selected at all. // If none is selected, we're treating it as if they are // all false @@ -465,9 +612,17 @@ // Go over the items and define the correct values $.each( filterRepresentation, function ( name, value ) { // We must store all parameter values as strings '0' or '1' - result[ filterParamNames[ name ] ] = areAnySelected ? - String( Number( !value ) ) : - '0'; + if ( model.getType() === 'send_unselected_if_any' ) { + result[ filterParamNames[ name ] ] = areAnySelected ? + String( Number( !value ) ) : + '0'; + } else if ( model.getType() === 'boolean' ) { + // Representation is straight-forward and direct from + // the parameter value to the filter state + result[ filterParamNames[ name ] ] = String( Number( !!value ) ); + } else if ( model.getType() === 'any_value' ) { + result[ filterParamNames[ name ] ] = value; + } } ); } else if ( this.getType() === 'string_options' ) { values = []; @@ -492,25 +647,39 @@ * Get the filter representation this group would provide * based on given parameter states. * - * @param {Object|string} [paramRepresentation] An object defining a parameter + * @param {Object} [paramRepresentation] An object defining a parameter * state to translate the filter state from. If not given, an object * representing all filters as falsey is returned; same as if the parameter * given were an empty object, or had some of the filters missing. * @return {Object} Filter representation */ mw.rcfilters.dm.FilterGroup.prototype.getFilterRepresentation = function ( paramRepresentation ) { - var areAnySelected, paramValues, + var areAnySelected, paramValues, item, currentValue, + oneWasSelected = false, + defaultParams = this.getDefaultParams(), + expandedParams = $.extend( true, {}, paramRepresentation ), model = this, paramToFilterMap = {}, result = {}; - if ( this.getType() === 'send_unselected_if_any' ) { - paramRepresentation = paramRepresentation || {}; - // Expand param representation to include all filters in the group + if ( this.isSticky() ) { + // If the group is sticky, check if all parameters are represented + // and for those that aren't represented, add them with their default + // values + paramRepresentation = $.extend( true, {}, this.getDefaultParams(), paramRepresentation ); + } + + paramRepresentation = paramRepresentation || {}; + if ( + this.getType() === 'send_unselected_if_any' || + this.getType() === 'boolean' || + this.getType() === 'any_value' + ) { + // Go over param representation; map and check for selections this.getItems().forEach( function ( filterItem ) { var paramName = filterItem.getParamName(); - paramRepresentation[ paramName ] = paramRepresentation[ paramName ] || '0'; + expandedParams[ paramName ] = paramRepresentation[ paramName ] || '0'; paramToFilterMap[ paramName ] = filterItem; if ( Number( paramRepresentation[ filterItem.getParamName() ] ) ) { @@ -518,25 +687,32 @@ } } ); - $.each( paramRepresentation, function ( paramName, paramValue ) { + $.each( expandedParams, function ( paramName, paramValue ) { var filterItem = paramToFilterMap[ paramName ]; - // Flip the definition between the parameter - // state and the filter state - // This is what the 'toggleSelected' value of the filter is - result[ filterItem.getName() ] = areAnySelected ? - !Number( paramValue ) : - // Otherwise, there are no selected items in the - // group, which means the state is false - false; + if ( model.getType() === 'send_unselected_if_any' ) { + // Flip the definition between the parameter + // state and the filter state + // This is what the 'toggleSelected' value of the filter is + result[ filterItem.getName() ] = areAnySelected ? + !Number( paramValue ) : + // Otherwise, there are no selected items in the + // group, which means the state is false + false; + } else if ( model.getType() === 'boolean' ) { + // Straight-forward definition of state + result[ filterItem.getName() ] = !!Number( paramRepresentation[ filterItem.getParamName() ] ); + } else if ( model.getType() === 'any_value' ) { + result[ filterItem.getName() ] = paramRepresentation[ filterItem.getParamName() ]; + } } ); } else if ( this.getType() === 'string_options' ) { - paramRepresentation = paramRepresentation || ''; + currentValue = paramRepresentation[ this.getName() ] || ''; // Normalize the given parameter values paramValues = mw.rcfilters.utils.normalizeParamOptions( // Given - paramRepresentation.split( + currentValue.split( this.getSeparator() ), // Allowed values @@ -559,21 +735,65 @@ paramValues.indexOf( filterItem.getParamName() ) > -1; } ); } else if ( this.getType() === 'single_option' ) { - // There is parameter that fits a single filter, or none at all + // There is parameter that fits a single filter and if not, get the default this.getItems().forEach( function ( filterItem ) { - result[ filterItem.getName() ] = filterItem.getParamName() === paramRepresentation; + var selected = filterItem.getParamName() === paramRepresentation[ model.getName() ]; + + result[ filterItem.getName() ] = selected; + oneWasSelected = oneWasSelected || selected; } ); } // Go over result and make sure all filters are represented. // If any filters are missing, they will get a falsey value this.getItems().forEach( function ( filterItem ) { - result[ filterItem.getName() ] = !!result[ filterItem.getName() ]; - } ); + if ( result[ filterItem.getName() ] === undefined ) { + result[ filterItem.getName() ] = this.getFalsyValue(); + } + }.bind( this ) ); + + // Make sure that at least one option is selected in + // single_option groups, no matter what path was taken + // If none was selected by the given definition, then + // we need to select the one in the base state -- either + // the default given, or the first item + if ( + this.getType() === 'single_option' && + !oneWasSelected + ) { + item = this.getItems()[ 0 ]; + if ( defaultParams[ this.getName() ] ) { + item = this.getItemByParamName( defaultParams[ this.getName() ] ); + } + + result[ item.getName() ] = true; + } return result; }; + /** + * @return {*} The appropriate falsy value for this group type + */ + mw.rcfilters.dm.FilterGroup.prototype.getFalsyValue = function () { + return this.getType() === 'any_value' ? '' : false; + }; + + /** + * Get current selected state of all filter items in this group + * + * @return {Object} Selected state + */ + mw.rcfilters.dm.FilterGroup.prototype.getSelectedState = function () { + var state = {}; + + this.getItems().forEach( function ( filterItem ) { + state[ filterItem.getName() ] = filterItem.getValue(); + } ); + + return state; + }; + /** * Get item by its filter name * @@ -586,6 +806,17 @@ } )[ 0 ]; }; + /** + * Select an item by its parameter name + * + * @param {string} paramName Filter parameter name + */ + mw.rcfilters.dm.FilterGroup.prototype.selectItemByParamName = function ( paramName ) { + this.getItems().forEach( function ( item ) { + item.toggleSelected( item.getParamName() === String( paramName ) ); + } ); + }; + /** * Get item by its parameter name * @@ -594,7 +825,7 @@ */ mw.rcfilters.dm.FilterGroup.prototype.getItemByParamName = function ( paramName ) { return this.getItems().filter( function ( item ) { - return item.getParamName() === paramName; + return item.getParamName() === String( paramName ); } )[ 0 ]; }; @@ -607,6 +838,19 @@ return this.type; }; + /** + * Check whether this group is represented by a single parameter + * or whether each item is its own parameter + * + * @return {boolean} This group is a single parameter + */ + mw.rcfilters.dm.FilterGroup.prototype.isPerGroupRequestParameter = function () { + return ( + this.getType() === 'string_options' || + this.getType() === 'single_option' + ); + }; + /** * Get display group * @@ -662,4 +906,78 @@ mw.rcfilters.dm.FilterGroup.prototype.isFullCoverage = function () { return this.fullCoverage; }; + + /** + * Check whether the group is defined as sticky default + * + * @return {boolean} Group is sticky default + */ + mw.rcfilters.dm.FilterGroup.prototype.isSticky = function () { + return this.sticky; + }; + + /** + * Normalize a value given to this group. This is mostly for correcting + * arbitrary values for 'single option' groups, given by the user settings + * or the URL that can go outside the limits that are allowed. + * + * @param {string} value Given value + * @return {string} Corrected value + */ + mw.rcfilters.dm.FilterGroup.prototype.normalizeArbitraryValue = function ( value ) { + if ( + this.getType() === 'single_option' && + this.isAllowArbitrary() + ) { + if ( + this.getMaxValue() !== null && + value > this.getMaxValue() + ) { + // Change the value to the actual max value + return String( this.getMaxValue() ); + } else if ( + this.getMinValue() !== null && + value < this.getMinValue() + ) { + // Change the value to the actual min value + return String( this.getMinValue() ); + } + } + + return value; + }; + + /** + * Toggle the visibility of this group + * + * @param {boolean} [isVisible] Item is visible + */ + mw.rcfilters.dm.FilterGroup.prototype.toggleVisible = function ( isVisible ) { + isVisible = isVisible === undefined ? !this.visible : isVisible; + + if ( this.visible !== isVisible ) { + this.visible = isVisible; + this.emit( 'update' ); + } + }; + + /** + * Check whether the group is visible + * + * @return {boolean} Group is visible + */ + mw.rcfilters.dm.FilterGroup.prototype.isVisible = function () { + return this.visible; + }; + + /** + * Set the visibility of the items under this group by the given items array + * + * @param {mw.rcfilters.dm.ItemModel[]} visibleItems An array of visible items + */ + mw.rcfilters.dm.FilterGroup.prototype.setVisibleItems = function ( visibleItems ) { + this.getItems().forEach( function ( itemModel ) { + itemModel.toggleVisible( visibleItems.indexOf( itemModel ) !== -1 ); + } ); + }; }( mediaWiki ) );