RCFilters: Minimize saved query before comparison

[lhc/web/wiklou.git] / resources / src / mediawiki.rcfilters / dm / mw.rcfilters.dm.SavedQueriesModel.js

diff --git a/resources/src/mediawiki.rcfilters/dm/mw.rcfilters.dm.SavedQueriesModel.js b/resources/src/mediawiki.rcfilters/dm/mw.rcfilters.dm.SavedQueriesModel.js
index 3ffc12e..d87ef73 100644 (file)
--- a/resources/src/mediawiki.rcfilters/dm/mw.rcfilters.dm.SavedQueriesModel.js
+++ b/resources/src/mediawiki.rcfilters/dm/mw.rcfilters.dm.SavedQueriesModel.js
@@ -2,6 +2,7 @@
        /**
         * View model for saved queries
         *
+        * @class
         * @mixins OO.EventEmitter
         * @mixins OO.EmitterList
         *
@@ -17,6 +18,7 @@
                OO.EmitterList.call( this );
 
                this.default = config.default;
+               this.baseState = {};
 
                // Events
                this.aggregate( { update: 'itemUpdate' } );
@@ -65,18 +67,24 @@
         *  the above structure.
         * @param {Object} [baseState] An object representing the base state
         *  so we can normalize the data
+        * @param {string[]} [ignoreFilters] Filters to ignore and remove from
+        *  the data
         * @fires initialize
         */
-       mw.rcfilters.dm.SavedQueriesModel.prototype.initialize = function ( savedQueries, baseState ) {
-               var items = [];
+       mw.rcfilters.dm.SavedQueriesModel.prototype.initialize = function ( savedQueries, baseState, ignoreFilters ) {
+               var items = [],
+                       defaultItem = null;
 
                savedQueries = savedQueries || {};
+               ignoreFilters = ignoreFilters || {};
 
                this.baseState = baseState;
 
                this.clearItems();
                $.each( savedQueries.queries || {}, function ( id, obj ) {
-                       var normalizedData = $.extend( true, {}, baseState, obj.data );
+                       var item,
+                               normalizedData = $.extend( true, {}, baseState, obj.data ),
+                               isDefault = String( savedQueries.default ) === String( id );
 
                        // Backwards-compat fix: We stored the 'highlight' state with
                        // "1" and "0" instead of true/false; for already-stored states,
@@ -87,17 +95,28 @@
                        // for existing users, who are only betalabs users at the moment.
                        normalizedData.highlights.highlight = !!Number( normalizedData.highlights.highlight );
 
-                       items.push(
-                               new mw.rcfilters.dm.SavedQueryItemModel(
-                                       id,
-                                       obj.label,
-                                       normalizedData,
-                                       { 'default': savedQueries.default === id }
-                               )
+                       // Backwards-compat fix: Remove sticky parameters from the 'ignoreFilters' list
+                       ignoreFilters.forEach( function ( name ) {
+                               delete normalizedData.filters[ name ];
+                       } );
+
+                       item = new mw.rcfilters.dm.SavedQueryItemModel(
+                               id,
+                               obj.label,
+                               normalizedData,
+                               { 'default': isDefault }
                        );
+
+                       if ( isDefault ) {
+                               defaultItem = item;
+                       }
+
+                       items.push( item );
                } );
 
-               this.default = savedQueries.default;
+               if ( defaultItem ) {
+                       this.default = defaultItem.getID();
+               }
 
                this.addItems( items );
 
@@ -109,6 +128,7 @@
         *
         * @param {string} label Label for the new query
         * @param {Object} data Data for the new query
+        * @return {string} ID of the newly added query
         */
        mw.rcfilters.dm.SavedQueriesModel.prototype.addNewQuery = function ( label, data ) {
                var randomID = ( new Date() ).getTime(),
@@ -122,6 +142,27 @@
                                normalizedData
                        )
                ] );
+
+               return randomID;
+       };
+
+       /**
+        * Remove query from model
+        *
+        * @param {string} queryID Query ID
+        */
+       mw.rcfilters.dm.SavedQueriesModel.prototype.removeQuery = function ( queryID ) {
+               var query = this.getItemByID( queryID );
+
+               if ( query ) {
+                       // Check if this item was the default
+                       if ( String( this.getDefault() ) === String( queryID ) ) {
+                               // Nulify the default
+                               this.setDefault( null );
+                       }
+
+                       this.removeItems( [ query ] );
+               }
        };
 
        /**
@@ -131,14 +172,44 @@
         * @return {mw.rcfilters.dm.SavedQueryItemModel} Matching item model
         */
        mw.rcfilters.dm.SavedQueriesModel.prototype.findMatchingQuery = function ( fullQueryComparison ) {
+               var model = this;
+
+               fullQueryComparison = this.getDifferenceFromBase( fullQueryComparison );
+
                return this.getItems().filter( function ( item ) {
+                       var comparedData = model.getDifferenceFromBase( item.getData() );
                        return OO.compare(
-                               item.getData(),
+                               comparedData,
                                fullQueryComparison
                        );
                } )[ 0 ];
        };
 
+       /**
+        * Get a minimal representation of the state for comparison
+        *
+        * @param {Object} state Given state
+        * @return {Object} Minimal state
+        */
+       mw.rcfilters.dm.SavedQueriesModel.prototype.getDifferenceFromBase = function ( state ) {
+               var result = { filters: {}, highlights: {}, invert: state.invert },
+                       baseState = this.baseState;
+
+               // XOR results
+               $.each( state.filters, function ( name, value ) {
+                       if ( baseState.filters !== undefined && baseState.filters[ name ] !== value ) {
+                               result.filters[ name ] = value;
+                       }
+               } );
+
+               $.each( state.highlights, function ( name, value ) {
+                       if ( baseState.highlights !== undefined && baseState.highlights[ name ] !== value && name !== 'highlight' ) {
+                               result.highlights[ name ] = value;
+                       }
+               } );
+
+               return result;
+       };
        /**
         * Get query by its identifier
         *