RCFilters: Allows specifying default highlights from the server

Bug: T172757
Change-Id: I0545b4e0222e14be99d567e7890ccf33722a5d1e

diff --git a/includes/changes/ChangesListFilter.php b/includes/changes/ChangesListFilter.php
index 2fc1006..2546f2b 100644 (file)
--- a/includes/changes/ChangesListFilter.php
+++ b/includes/changes/ChangesListFilter.php
@@ -103,6 +103,12 @@ abstract class ChangesListFilter {
         */
        protected $priority;
 
+       /**
+        *
+        * @var string $defaultHighlightColor
+        */
+       protected $defaultHighlightColor;
+
        const RESERVED_NAME_CHAR = '_';
 
        /**
@@ -368,6 +374,7 @@ abstract class ChangesListFilter {
                        'priority' => $this->priority,
                        'subset' => $this->subsetFilters,
                        'conflicts' => [],
+                       'defaultHighlightColor' => $this->defaultHighlightColor
                ];
 
                $output['messageKeys'] = [
@@ -494,4 +501,11 @@ abstract class ChangesListFilter {
                        }
                );
        }
+
+       /**
+        * @param string $defaultHighlightColor
+        */
+       public function setDefaultHighlightColor( $defaultHighlightColor ) {
+               $this->defaultHighlightColor = $defaultHighlightColor;
+       }
 }

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 309978f..57d1b41 100644 (file)
--- a/resources/src/mediawiki.rcfilters/dm/mw.rcfilters.dm.FilterGroup.js
+++ b/resources/src/mediawiki.rcfilters/dm/mw.rcfilters.dm.FilterGroup.js
@@ -93,6 +93,7 @@
         */
        mw.rcfilters.dm.FilterGroup.prototype.initializeFilters = function ( filterDefinition, groupDefault ) {
                var defaultParam,
+                       anyHighlighted,
                        supersetMap = {},
                        model = this,
                        items = [];
@@ -106,7 +107,8 @@
                                        description: filter.description || '',
                                        labelPrefixKey: model.labelPrefixKey,
                                        cssClass: filter.cssClass,
-                                       identifiers: filter.identifiers
+                                       identifiers: filter.identifiers,
+                                       defaultHighlightColor: filter.defaultHighlightColor
                                } );
 
                        if ( filter.subset ) {
@@ -188,6 +190,18 @@
                        this.defaultParams[ this.getName() ] = defaultParam;
                }
 
+               // add highlights to defaultParams
+               anyHighlighted = false;
+               this.getItems().forEach( function ( filterItem ) {
+                       if ( filterItem.isHighlighted() ) {
+                               anyHighlighted = true;
+                               this.defaultParams[ filterItem.getName() + '_color' ] = filterItem.getHighlightColor();
+                       }
+               }.bind( this ) );
+               if ( anyHighlighted ) {
+                       this.defaultParams.highlight = '1';
+               }
+
                // Store default filter state based on default params
                this.defaultFilters = this.getFilterRepresentation( this.getDefaultParams() );
 

diff --git a/resources/src/mediawiki.rcfilters/dm/mw.rcfilters.dm.FiltersViewModel.js b/resources/src/mediawiki.rcfilters/dm/mw.rcfilters.dm.FiltersViewModel.js
index 5013c08..772ed92 100644 (file)
--- a/resources/src/mediawiki.rcfilters/dm/mw.rcfilters.dm.FiltersViewModel.js
+++ b/resources/src/mediawiki.rcfilters/dm/mw.rcfilters.dm.FiltersViewModel.js
@@ -410,6 +410,10 @@
 
                this.currentView = 'default';
 
+               if ( this.getHighlightedItems().length > 0 ) {
+                       this.toggleHighlight( true );
+               }
+
                // Finish initialization
                this.emit( 'initialize' );
        };
@@ -725,6 +729,22 @@
                return result;
        };
 
+       /**
+        * Get an object representing the complete empty state of highlights
+        *
+        * @return {Object} Object containing all the highlight parameters set to their negative value
+        */
+       mw.rcfilters.dm.FiltersViewModel.prototype.getEmptyHighlightParameters = function () {
+               var result = {};
+
+               this.getItems().forEach( function ( filterItem ) {
+                       result[ filterItem.getName() + '_color' ] = null;
+               } );
+               result.highlight = '0';
+
+               return result;
+       };
+
        /**
         * Extract the highlight values from given object. Since highlights are
         * the same for filter and parameters, it doesn't matter which one is

diff --git a/resources/src/mediawiki.rcfilters/dm/mw.rcfilters.dm.ItemModel.js b/resources/src/mediawiki.rcfilters/dm/mw.rcfilters.dm.ItemModel.js
index aa82e21..9c56f09 100644 (file)
--- a/resources/src/mediawiki.rcfilters/dm/mw.rcfilters.dm.ItemModel.js
+++ b/resources/src/mediawiki.rcfilters/dm/mw.rcfilters.dm.ItemModel.js
@@ -21,6 +21,7 @@
         * @cfg {string} [cssClass] The class identifying the results that match this filter
         * @cfg {string[]} [identifiers] An array of identifiers for this item. They will be
         *  added and considered in the view.
+        * @cfg {string} [defaultHighlightColor] If set, highlight this filter by default with this color
         */
        mw.rcfilters.dm.ItemModel = function MwRcfiltersDmItemModel( param, config ) {
                config = config || {};
@@ -42,8 +43,8 @@
 
                // Highlight
                this.cssClass = config.cssClass;
-               this.highlightColor = null;
-               this.highlightEnabled = false;
+               this.highlightColor = config.defaultHighlightColor;
+               this.highlightEnabled = !!config.defaultHighlightColor;
        };
 
        /* Initialization */

diff --git a/resources/src/mediawiki.rcfilters/mw.rcfilters.UriProcessor.js b/resources/src/mediawiki.rcfilters/mw.rcfilters.UriProcessor.js
index 1894b61..c9436f4 100644 (file)
--- a/resources/src/mediawiki.rcfilters/mw.rcfilters.UriProcessor.js
+++ b/resources/src/mediawiki.rcfilters/mw.rcfilters.UriProcessor.js
@@ -300,7 +300,7 @@
         */
        mw.rcfilters.UriProcessor.prototype._buildEmptyParameterState = function () {
                var emptyParams = this.filtersModel.getParametersFromFilters( {} ),
-                       emptyHighlights = this.filtersModel.getHighlightParameters();
+                       emptyHighlights = this.filtersModel.getEmptyHighlightParameters();
 
                this.emptyParameterState = $.extend(
                        true,

diff --git a/tests/phpunit/includes/changes/ChangesListBooleanFilterGroupTest.php b/tests/phpunit/includes/changes/ChangesListBooleanFilterGroupTest.php
index 07dec05..d80b6c1 100644 (file)
--- a/tests/phpunit/includes/changes/ChangesListBooleanFilterGroupTest.php
+++ b/tests/phpunit/includes/changes/ChangesListBooleanFilterGroupTest.php
@@ -63,6 +63,7 @@ class ChangesListBooleanFilterGroupTest extends MediaWikiTestCase {
                                                'cssClass' => null,
                                                'conflicts' => [],
                                                'subset' => [],
+                                               'defaultHighlightColor' => null,
                                        ],
                                        [
                                                'name' => 'hidefoo',
@@ -73,6 +74,7 @@ class ChangesListBooleanFilterGroupTest extends MediaWikiTestCase {
                                                'cssClass' => null,
                                                'conflicts' => [],
                                                'subset' => [],
+                                               'defaultHighlightColor' => null,
                                        ],
                                ],
                                'conflicts' => [],

diff --git a/tests/phpunit/includes/changes/ChangesListBooleanFilterTest.php b/tests/phpunit/includes/changes/ChangesListBooleanFilterTest.php
index 000f017..35dc1a8 100644 (file)
--- a/tests/phpunit/includes/changes/ChangesListBooleanFilterTest.php
+++ b/tests/phpunit/includes/changes/ChangesListBooleanFilterTest.php
@@ -49,6 +49,7 @@ class ChangesListBooleanFilterTest extends MediaWikiTestCase {
                                'default' => 1,
                                'priority' => 1,
                                'cssClass' => null,
+                               'defaultHighlightColor' => null,
                                'conflicts' => [
                                        [
                                                'group' => 'group',
@@ -85,6 +86,7 @@ class ChangesListBooleanFilterTest extends MediaWikiTestCase {
                                'default' => 1,
                                'priority' => 1,
                                'cssClass' => null,
+                               'defaultHighlightColor' => null,
                                'conflicts' => [
                                        [
                                                'group' => 'group',

diff --git a/tests/phpunit/includes/changes/ChangesListStringOptionsFilterGroupTest.php b/tests/phpunit/includes/changes/ChangesListStringOptionsFilterGroupTest.php
index 4f917e9..dd27e32 100644 (file)
--- a/tests/phpunit/includes/changes/ChangesListStringOptionsFilterGroupTest.php
+++ b/tests/phpunit/includes/changes/ChangesListStringOptionsFilterGroupTest.php
@@ -247,6 +247,7 @@ class ChangesListStringOptionsFilterGroupTest extends MediaWikiTestCase {
                                                'cssClass' => null,
                                                'conflicts' => [],
                                                'subset' => [],
+                                               'defaultHighlightColor' => null,
                                        ],
                                        [
                                                'name' => 'foo',
@@ -256,6 +257,7 @@ class ChangesListStringOptionsFilterGroupTest extends MediaWikiTestCase {
                                                'cssClass' => null,
                                                'conflicts' => [],
                                                'subset' => [],
+                                               'defaultHighlightColor' => null,
                                        ],
                                ],
                                'conflicts' => [],

diff --git a/tests/phpunit/includes/specialpage/ChangesListSpecialPageTest.php b/tests/phpunit/includes/specialpage/ChangesListSpecialPageTest.php
index fd7e0f1..d967588 100644 (file)
--- a/tests/phpunit/includes/specialpage/ChangesListSpecialPageTest.php
+++ b/tests/phpunit/includes/specialpage/ChangesListSpecialPageTest.php
@@ -736,6 +736,7 @@ class ChangesListSpecialPageTest extends AbstractChangesListSpecialPageTestCase
                                                                'cssClass' => null,
                                                                'conflicts' => [],
                                                                'subset' => [],
+                                                               'defaultHighlightColor' => null
                                                        ],
                                                        [
                                                                'name' => 'hidefoo',
@@ -746,6 +747,7 @@ class ChangesListSpecialPageTest extends AbstractChangesListSpecialPageTestCase
                                                                'cssClass' => null,
                                                                'conflicts' => [],
                                                                'subset' => [],
+                                                               'defaultHighlightColor' => null
                                                        ],
                                                ],
                                                'fullCoverage' => true,
@@ -767,6 +769,7 @@ class ChangesListSpecialPageTest extends AbstractChangesListSpecialPageTestCase
                                                                'priority' => -2,
                                                                'conflicts' => [],
                                                                'subset' => [],
+                                                               'defaultHighlightColor' => null
                                                        ],
                                                        [
                                                                'name' => 'garply',
@@ -776,6 +779,7 @@ class ChangesListSpecialPageTest extends AbstractChangesListSpecialPageTestCase
                                                                'priority' => -3,
                                                                'conflicts' => [],
                                                                'subset' => [],
+                                                               'defaultHighlightColor' => null
                                                        ],
                                                ],
                                                'conflicts' => [],