Changeset 6022

Timestamp:

02/23/15 15:57:05 (9 years ago)

Author:

Twan Goosen

Message:

Parameters converter that maps to query facet selection now checks whether facets passed in as parameters do actually exist according to the configuration. If not, logs a debug message and notifies the user via a wicket error message

Location:

vlo/trunk/vlo-web-app/src

Files:

• main/java/eu/clarin/cmdi/vlo/config/VloServicesSpringConfig.java (modified) (1 diff)
• main/java/eu/clarin/cmdi/vlo/service/impl/QueryFacetsSelectionParametersConverter.java (modified) (5 diffs)
• test/java/eu/clarin/cmdi/vlo/service/impl/QueryFacetsSelectionParametersConverterTest.java (modified) (3 diffs)

vlo/trunk/vlo-web-app/src/main/java/eu/clarin/cmdi/vlo/config/VloServicesSpringConfig.java

@@ -88 +88 @@
     @Bean(name = "queryParametersConverter")
     public PageParametersConverter<QueryFacetsSelection> queryParametersConverter() {
-        return new QueryFacetsSelectionParametersConverter();
+        return new QueryFacetsSelectionParametersConverter(vloConfig);
     }
 

vlo/trunk/vlo-web-app/src/main/java/eu/clarin/cmdi/vlo/service/impl/QueryFacetsSelectionParametersConverter.java

@@ -18 +18 @@
 
 import com.google.common.base.Splitter;
+import com.google.common.collect.ImmutableSet;
 import com.google.common.collect.Maps;
 import static eu.clarin.cmdi.vlo.VloWebAppParameters.*;
+import eu.clarin.cmdi.vlo.config.VloConfig;
 import eu.clarin.cmdi.vlo.pojo.FacetSelection;
 import eu.clarin.cmdi.vlo.pojo.FacetSelectionType;
@@ -28 +30 @@
 import java.util.List;
 import java.util.Map.Entry;
+import java.util.Set;
+import org.apache.wicket.Session;
 import org.apache.wicket.request.mapper.parameter.PageParameters;
 import org.apache.wicket.util.string.StringValue;
@@ -48 +52 @@
     public final static Splitter FILTER_SPLITTER = Splitter.on(":").limit(2);
 
+    private final Set<String> facetsDefined;
+
+    public QueryFacetsSelectionParametersConverter(VloConfig config) {
+        facetsDefined = ImmutableSet.copyOf(config.getAllFacetFields());
+    }
+
     @Override
     public QueryFacetsSelection fromParameters(PageParameters params) {
@@ -64 +74 @@
                     final String type = fqType.get(1).toUpperCase();
 
-                    try {
-                        final FacetSelectionType facetSelectionType = FacetSelectionType.valueOf(type);
-                        selection.put(facet, new FacetSelection(facetSelectionType));
-                    } catch (IllegalArgumentException ex) {
-                        logger.warn("Unknown selection type passed into query parameter {}: {}", FILTER_QUERY_TYPE, type);
+                    if (facetsDefined.contains(facet)) {
+                        try {
+                            final FacetSelectionType facetSelectionType = FacetSelectionType.valueOf(type);
+                            selection.put(facet, new FacetSelection(facetSelectionType));
+                        } catch (IllegalArgumentException ex) {
+                            logger.warn("Unknown selection type passed into query parameter {}: {}", FILTER_QUERY_TYPE, type);
+                        }
                     }
                 } else {
@@ -84 +96 @@
                     final String facet = fq.get(0);
                     final String value = fq.get(1);
-                    if (selection.containsKey(facet)) {
-                        selection.get(facet).getValues().add(value);
+                    if (facetsDefined.contains(facet)) {
+                        if (selection.containsKey(facet)) {
+                            selection.get(facet).getValues().add(value);
+                        } else {
+                            selection.put(facet, new FacetSelection(Arrays.asList(value)));
+                        }
                     } else {
-                        selection.put(facet, new FacetSelection(Arrays.asList(value)));
+                        logger.debug("Undefined facet passed into query parameter {}: {}", FILTER_QUERY, facet);
+
+                        if (Session.exists()) {
+                            // generate Wicket error message
+                            Session.get().error("Unknown facet: " + facet);
+                        }
                     }
                 } else {

vlo/trunk/vlo-web-app/src/test/java/eu/clarin/cmdi/vlo/service/impl/QueryFacetsSelectionParametersConverterTest.java

@@ -17 +17 @@
 package eu.clarin.cmdi.vlo.service.impl;
 
+import com.google.common.collect.ImmutableList;
 import com.google.common.collect.Maps;
+import static eu.clarin.cmdi.vlo.FacetConstants.FIELD_COLLECTION;
+import static eu.clarin.cmdi.vlo.FacetConstants.FIELD_COUNTRY;
+import eu.clarin.cmdi.vlo.config.VloConfig;
 import eu.clarin.cmdi.vlo.pojo.FacetSelection;
 import eu.clarin.cmdi.vlo.pojo.FacetSelectionType;
@@ -44 +48 @@
     @Before
     public void setUp() {
-        instance = new QueryFacetsSelectionParametersConverter();
+        VloConfig config = new VloConfig() {
+
+            @Override
+            public List<String> getAllFacetFields() {
+                return ImmutableList.of("facet1", "facet2", "facet3", "facet4");
+            }
+
+        };
+        instance = new QueryFacetsSelectionParametersConverter(config);
     }
 
@@ -60 +72 @@
         params.add("fq", "facet2:value:C"); // has a colon in value
         params.add("fq", "illegal-no-colon"); //should get ignored
+        params.add("fq", "facet5:valueD"); //not in list, should get ignored
         params.add("fq", ""); // not a valid facet selection
         params.add("fq", "invalid"); // not a valid facet selection