NIHVIVO-3114 Fix problems with dump of IndividualTemplateModel.qrData()

webapp/src/edu/cornell/mannlib/vitro/webapp/controller/freemarker/IndividualController.java

@@ -58,9 +58,9 @@ import edu.cornell.mannlib.vitro.webapp.utils.NamespaceMapper;
 import edu.cornell.mannlib.vitro.webapp.utils.NamespaceMapperFactory;
 import edu.cornell.mannlib.vitro.webapp.utils.jena.ExtendedLinkedDataUtils;
 import edu.cornell.mannlib.vitro.webapp.web.ContentType;
+import edu.cornell.mannlib.vitro.webapp.web.beanswrappers.ReadOnlyBeansWrapper;
 import edu.cornell.mannlib.vitro.webapp.web.templatemodels.individual.IndividualTemplateModel;
 import edu.cornell.mannlib.vitro.webapp.web.templatemodels.individuallist.ListedIndividual;
-import freemarker.ext.beans.ReadOnlyBeansWrapper;
 
 /**
  * Handles requests for entity information.

webapp/src/edu/cornell/mannlib/vitro/webapp/web/beanswrappers/ReadOnlyBeansWrapper.java

@@ -1,16 +1,20 @@
 /* $This file is distributed under the terms of the license in /doc/license.txt$ */
 
-package freemarker.ext.beans;
+package edu.cornell.mannlib.vitro.webapp.web.beanswrappers;
 
 import java.lang.reflect.Method;
 
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 
-/** BeansWrapper that is more restrictive than EXPOSE_SAFE, by
+import freemarker.ext.beans.BeansWrapper;
+import freemarker.ext.beans.BeansWrapper.MethodAppearanceDecision;
+
+/** A BeansWrapper that is more restrictive than EXPOSE_SAFE, by
  * exposing getters but not setters. A setter is defined for this
  * purpose as a method that returns void, or whose name
- * starts with "set". 
+ * starts with "set". It also hides built-in methods of Java
+ * utility classes like Map.put(), etc.
  * 
  * @author rjy7
  *
@@ -27,12 +31,26 @@ public class ReadOnlyBeansWrapper extends BeansWrapper {
     @Override
     protected void finetuneMethodAppearance(Class cls, Method method, MethodAppearanceDecision decision) {
         
-        // How to define a setter? This is an approximation: a method whose name
+        // How to define a setter? This is a weak approximation: a method whose name
         // starts with "set" or returns void.
         if ( method.getName().startsWith("set") ) {
             decision.setExposeMethodAs(null);
+            
         } else if ( method.getReturnType().getName().equals("void") ) {
             decision.setExposeMethodAs(null);
+            
+        } else {
+            
+            Class<?> declaringClass = method.getDeclaringClass();
+            if (declaringClass.equals(java.lang.Object.class)) {
+                decision.setExposeMethodAs(null);
+                
+            } else {
+                Package pkg = declaringClass.getPackage();
+                if (pkg.getName().equals("java.util")) {
+                    decision.setExposeMethodAs(null);
+                }
+            }
         }
     }
     

webapp/src/freemarker/ext/beans/WrapperExtractor.java

@@ -2,6 +2,8 @@
 
 package freemarker.ext.beans;
 
+import java.util.Set;
+
 /**
  * Class to extract wrapper used to wrap an object into a template model object. 
  * Used as workaround to gap in Freemarker template model API (can't get wrapper
@@ -16,4 +18,5 @@ public class WrapperExtractor {
     public static int getWrapperExposureLevel(BeanModel model) {
         return model.wrapper.getExposureLevel();
     }
+
 }

webapp/src/freemarker/ext/dump/BaseDumpDirective.java

@@ -25,6 +25,7 @@ import freemarker.core.Environment;
 import freemarker.ext.beans.BeanModel;
 import freemarker.ext.beans.BeansWrapper;
 import freemarker.ext.beans.CollectionModel;
+import freemarker.ext.beans.MapModel;
 import freemarker.ext.beans.SimpleMethodModel;
 import freemarker.ext.beans.StringModel;
 import freemarker.ext.beans.WrapperExtractor;
@@ -175,6 +176,7 @@ public abstract class BaseDumpDirective implements TemplateDirectiveModel {
     }
 
     private Map<String, Object> getDump(TemplateModel model) throws TemplateModelException {
+        
         Map<String, Object> map = new HashMap<String, Object>();
         
         // Don't return null if model == null. We still want to send the map to the template.
@@ -308,7 +310,8 @@ public abstract class BaseDumpDirective implements TemplateDirectiveModel {
         if ( unwrappedModel instanceof Map ) {
             return getMapDump(model);
         }
-        // Java objects are wrapped as TemplateHashModelEx-s.
+        
+         // Java objects are wrapped as TemplateHashModelEx-s.
         return getObjectDump(model, unwrappedModel);
     }
     
@@ -320,13 +323,18 @@ public abstract class BaseDumpDirective implements TemplateDirectiveModel {
         TemplateModelIterator iModel = keys.iterator();
         while (iModel.hasNext()) {
             String key = iModel.next().toString();
+            // Workaround this oddity: model.object does not contain
+            // values for "empty" and "keys", but model.keys() does. 
+            if ("class".equals(key) || "empty".equals(key)) {
+                continue;
+            }
             TemplateModel value = model.get(key);
-            items.put(key, getDump(value));
+            items.put(key, getDump(value)); 
-        }        
+        }   
         map.put(Key.VALUE.toString(), items);  
         return map;
     }
-
+    
     private Map<String, Object> getObjectDump(TemplateHashModelEx model, Object object) throws TemplateModelException {
         
         Map<String, Object> map = new HashMap<String, Object>();
@@ -388,11 +396,9 @@ public abstract class BaseDumpDirective implements TemplateDirectiveModel {
                         continue;
                     }
                 }
-                // Else look for the entire methodName in the key set. Include those 
+                
-                // starting with "get" or "is" that were not found above.
+                // Else look for the entire methodName in the key set, to include
-                // NB This does not properly account for methods exposed as properties
+                // those that are exposed as methods rather than properties. 
-                // using BeansWrapper.finetuneMethodAppearance(), and perhaps other
-                // changes to method exposure through that method. 
                 if (keySet.contains(methodName)) {               
                     String methodDisplayName = getMethodDisplayName(method);  
                     // If no arguments, invoke the method to get the result