3 * View model for saved queries
6 * @mixins OO.EventEmitter
7 * @mixins OO.EmitterList
10 * @param {mw.rcfilters.dm.FiltersViewModel} filtersModel Filters model
11 * @param {Object} [config] Configuration options
12 * @cfg {string} [default] Default query ID
14 mw
.rcfilters
.dm
.SavedQueriesModel
= function MwRcfiltersDmSavedQueriesModel( filtersModel
, config
) {
15 config
= config
|| {};
18 OO
.EventEmitter
.call( this );
19 OO
.EmitterList
.call( this );
21 this.default = config
.default;
22 this.filtersModel
= filtersModel
;
23 this.converted
= false;
26 this.aggregate( { update
: 'itemUpdate' } );
31 OO
.initClass( mw
.rcfilters
.dm
.SavedQueriesModel
);
32 OO
.mixinClass( mw
.rcfilters
.dm
.SavedQueriesModel
, OO
.EventEmitter
);
33 OO
.mixinClass( mw
.rcfilters
.dm
.SavedQueriesModel
, OO
.EmitterList
);
40 * Model is initialized
45 * @param {mw.rcfilters.dm.SavedQueryItemModel} Changed item
52 * @param {string} New default ID
54 * The default has changed
60 * Initialize the saved queries model by reading it from the user's settings.
61 * The structure of the saved queries is:
63 * version: (string) Version number; if version 2, the query represents
64 * parameters. Otherwise, the older version represented filters
65 * and needs to be readjusted,
66 * default: (string) Query ID
70 * filters: (Object) Minimal definition of the filters
71 * highlights: (Object) Definition of the highlights
73 * label: (optional) Name of this query
78 * @param {Object} [savedQueries] An object with the saved queries with
79 * the above structure.
82 mw
.rcfilters
.dm
.SavedQueriesModel
.prototype.initialize = function ( savedQueries
) {
85 savedQueries
= savedQueries
|| {};
89 this.converted
= false;
91 if ( savedQueries
.version
!== '2' ) {
92 // Old version dealt with filter names. We need to migrate to the new structure
95 // version: (string) '2',
96 // default: (string) Query ID,
99 // label: (string) Name of the query
101 // params: (object) Representing all the parameter states
102 // highlights: (object) Representing all the filter highlight states
106 $.each( savedQueries
.queries
|| {}, function ( id
, obj
) {
107 if ( obj
.data
&& obj
.data
.filters
) {
108 obj
.data
= model
.convertToParameters( obj
.data
);
112 this.converted
= true;
113 savedQueries
.version
= '2';
116 // Initialize the query items
117 $.each( savedQueries
.queries
|| {}, function ( id
, obj
) {
118 var normalizedData
= obj
.data
,
119 isDefault
= String( savedQueries
.default ) === String( id
);
121 if ( normalizedData
&& normalizedData
.params
) {
122 // Backwards-compat fix: Remove excluded parameters from
123 // the given data, if they exist
124 normalizedData
.params
= model
.filtersModel
.removeExcludedParams( normalizedData
.params
);
126 model
.cleanupHighlights( normalizedData
);
130 // Skip the addNewQuery method because we don't want to unnecessarily manipulate
131 // the given saved queries unless we literally intend to (like in backwards compat fixes)
132 // And the addNewQuery method also uses a minimization routine that checks for the
133 // validity of items and minimizes the query. This isn't necessary for queries loaded
134 // from the backend, and has the risk of removing values if they're temporarily
135 // invalid (example: if we temporarily removed a cssClass from a filter in the backend)
137 new mw
.rcfilters
.dm
.SavedQueryItemModel(
141 { 'default': isDefault
}
151 this.emit( 'initialize' );
155 * Clean up highlight parameters.
156 * 'highlight' used to be stored, it's not inferred based on the presence of absence of
159 * @param {Object} data Saved query data
161 mw
.rcfilters
.dm
.SavedQueriesModel
.prototype.cleanupHighlights = function ( data
) {
163 data
.params
.highlight
=== '0' &&
164 data
.highlights
&& Object
.keys( data
.highlights
).length
166 data
.highlights
= {};
168 delete data
.params
.highlight
;
172 * Convert from representation of filters to representation of parameters
174 * @param {Object} data Query data
175 * @return {Object} New converted query data
177 mw
.rcfilters
.dm
.SavedQueriesModel
.prototype.convertToParameters = function ( data
) {
179 defaultFilters
= this.filtersModel
.getFiltersFromParameters( this.filtersModel
.getDefaultParams() ),
180 fullFilterRepresentation
= $.extend( true, {}, defaultFilters
, data
.filters
),
181 highlightEnabled
= data
.highlights
.highlight
;
183 delete data
.highlights
.highlight
;
186 newData
.params
= this.filtersModel
.getMinimizedParamRepresentation(
187 this.filtersModel
.getParametersFromFilters( fullFilterRepresentation
)
190 // Highlights: appending _color to keys
191 newData
.highlights
= {};
192 $.each( data
.highlights
, function ( highlightedFilterName
, value
) {
194 newData
.highlights
[ highlightedFilterName
+ '_color' ] = data
.highlights
[ highlightedFilterName
];
199 newData
.params
.highlight
= String( Number( highlightEnabled
|| 0 ) );
207 * @param {string} label Label for the new query
208 * @param {Object} fulldata Full data representation for the new query, combining highlights and filters
209 * @param {boolean} isDefault Item is default
210 * @param {string} [id] Query ID, if exists. If this isn't given, a random
211 * new ID will be created.
212 * @return {string} ID of the newly added query
214 mw
.rcfilters
.dm
.SavedQueriesModel
.prototype.addNewQuery = function ( label
, fulldata
, isDefault
, id
) {
215 var normalizedData
= { params
: {}, highlights
: {} },
216 highlightParamNames
= Object
.keys( this.filtersModel
.getEmptyHighlightParameters() ),
217 randomID
= String( id
|| ( new Date() ).getTime() ),
218 data
= this.filtersModel
.getMinimizedParamRepresentation( fulldata
);
220 // Split highlight/params
221 $.each( data
, function ( param
, value
) {
222 if ( param
!== 'highlight' && highlightParamNames
.indexOf( param
) > -1 ) {
223 normalizedData
.highlights
[ param
] = value
;
225 normalizedData
.params
[ param
] = value
;
231 new mw
.rcfilters
.dm
.SavedQueryItemModel(
235 { 'default': isDefault
}
240 this.setDefault( randomID
);
247 * Remove query from model
249 * @param {string} queryID Query ID
251 mw
.rcfilters
.dm
.SavedQueriesModel
.prototype.removeQuery = function ( queryID
) {
252 var query
= this.getItemByID( queryID
);
255 // Check if this item was the default
256 if ( String( this.getDefault() ) === String( queryID
) ) {
257 // Nulify the default
258 this.setDefault( null );
261 this.removeItems( [ query
] );
266 * Get an item that matches the requested query
268 * @param {Object} fullQueryComparison Object representing all filters and highlights to compare
269 * @return {mw.rcfilters.dm.SavedQueryItemModel} Matching item model
271 mw
.rcfilters
.dm
.SavedQueriesModel
.prototype.findMatchingQuery = function ( fullQueryComparison
) {
272 // Minimize before comparison
273 fullQueryComparison
= this.filtersModel
.getMinimizedParamRepresentation( fullQueryComparison
);
275 return this.getItems().filter( function ( item
) {
277 item
.getCombinedData(),
284 * Get query by its identifier
286 * @param {string} queryID Query identifier
287 * @return {mw.rcfilters.dm.SavedQueryItemModel|undefined} Item matching
288 * the search. Undefined if not found.
290 mw
.rcfilters
.dm
.SavedQueriesModel
.prototype.getItemByID = function ( queryID
) {
291 return this.getItems().filter( function ( item
) {
292 return item
.getID() === queryID
;
297 * Get the full data representation of the default query, if it exists
299 * @param {boolean} [excludeHiddenParams] Exclude hidden parameters in the result
300 * @return {Object|null} Representation of the default params if exists.
301 * Null if default doesn't exist or if the user is not logged in.
303 mw
.rcfilters
.dm
.SavedQueriesModel
.prototype.getDefaultParams = function ( excludeHiddenParams
) {
304 var data
= ( !mw
.user
.isAnon() && this.getItemParams( this.getDefault() ) ) || {};
306 if ( excludeHiddenParams
) {
307 Object
.keys( this.filtersModel
.getDefaultHiddenParams() ).forEach( function ( paramName
) {
308 delete data
[ paramName
];
316 * Get a full parameter representation of an item data
318 * @param {Object} queryID Query ID
319 * @return {Object} Parameter representation
321 mw
.rcfilters
.dm
.SavedQueriesModel
.prototype.getItemParams = function ( queryID
) {
322 var item
= this.getItemByID( queryID
),
323 data
= item
? item
.getData() : {};
325 return !$.isEmptyObject( data
) ? this.buildParamsFromData( data
) : {};
329 * Build a full parameter representation given item data and model sticky values state
331 * @param {Object} data Item data
332 * @return {Object} Full param representation
334 mw
.rcfilters
.dm
.SavedQueriesModel
.prototype.buildParamsFromData = function ( data
) {
335 // Merge saved filter state with sticky filter values
340 // In order to merge sticky filters with the data, we have to
341 // transform this to filters first, merge, and then back to
343 savedFilters
= $.extend(
345 this.filtersModel
.getFiltersFromParameters( data
.params
),
346 this.filtersModel
.getStickyFiltersState()
349 // Return parameter representation
350 return this.filtersModel
.getMinimizedParamRepresentation( $.extend( true, {},
351 this.filtersModel
.getParametersFromFilters( savedFilters
),
353 { highlight
: data
.params
.highlight
}
358 * Get the object representing the state of the entire model and items
360 * @return {Object} Object representing the state of the model and items
362 mw
.rcfilters
.dm
.SavedQueriesModel
.prototype.getState = function () {
363 var obj
= { queries
: {}, version
: '2' };
365 // Translate the items to the saved object
366 this.getItems().forEach( function ( item
) {
367 obj
.queries
[ item
.getID() ] = item
.getState();
370 if ( this.getDefault() ) {
371 obj
.default = this.getDefault();
378 * Set a default query. Null to unset default.
380 * @param {string} itemID Query identifier
383 mw
.rcfilters
.dm
.SavedQueriesModel
.prototype.setDefault = function ( itemID
) {
384 if ( this.default !== itemID
) {
385 this.default = itemID
;
387 // Set for individual itens
388 this.getItems().forEach( function ( item
) {
389 item
.toggleDefault( item
.getID() === itemID
);
392 this.emit( 'default', itemID
);
397 * Get the default query ID
399 * @return {string} Default query identifier
401 mw
.rcfilters
.dm
.SavedQueriesModel
.prototype.getDefault = function () {
406 * Check if the saved queries were converted
408 * @return {boolean} Saved queries were converted from the previous
409 * version to the new version
411 mw
.rcfilters
.dm
.SavedQueriesModel
.prototype.isConverted = function () {
412 return this.converted
;
414 }( mediaWiki
, jQuery
) );