Merge pull request BroadleafCommerce#1512 from BroadleafCommerce/qa-738-field-data-validation

Provide mechanism to skip validation for MVEL strings in FieldData

Author: phillipuniverse

admin/broadleaf-open-admin-platform/src/main/java/org/broadleafcommerce/openadmin/web/rulebuilder/dto/FieldData.java

@@ -17,6 +17,7 @@
  * limitations under the License.
  * #L%
  */
+
 package org.broadleafcommerce.openadmin.web.rulebuilder.dto;
 
 import org.broadleafcommerce.common.presentation.client.SupportedFieldType;
@@ -38,6 +39,7 @@ public class FieldData {
     protected String options;
     protected SupportedFieldType fieldType;
     protected SupportedFieldType secondaryFieldType;
+    protected boolean skipValidation;
 
     private FieldData(Builder builder) {
         this.fieldLabel = builder.fieldLabel;
@@ -46,21 +48,25 @@ private FieldData(Builder builder) {
         this.options = builder.options;
         this.fieldType = builder.fieldType;
         this.secondaryFieldType = builder.secondaryFieldType;
+        this.skipValidation = builder.skipValidation;
     }
 
     public static class Builder {
+
         protected String fieldLabel = null;
         protected String fieldName = null;
         protected String operators = null;
         protected String options = null;
         protected SupportedFieldType fieldType = null;
         protected SupportedFieldType secondaryFieldType = null;
+        protected boolean skipValidation;
 
         public FieldData build() {
             return new FieldData(this);
         }
 
-        public Builder() {}
+        public Builder() {
+        }
 
         public Builder label(String fieldLabel) {
             this.fieldLabel = fieldLabel;
@@ -91,6 +97,11 @@ public Builder secondaryType(SupportedFieldType fieldType) {
             this.secondaryFieldType = fieldType;
             return this;
         }
+
+        public Builder skipValidation(boolean skipValidation) {
+            this.skipValidation = skipValidation;
+            return this;
+        }
     }
 
     public String getFieldLabel() {
@@ -116,4 +127,13 @@ public SupportedFieldType getFieldType() {
     public SupportedFieldType getSecondaryFieldType() {
         return secondaryFieldType;
     }
+
+    public boolean getSkipValidation() {
+        return skipValidation;
+    }
+
+    public void setSkipValidation(boolean skipValidation) {
+        this.skipValidation = skipValidation;
+    }
+
 }

admin/broadleaf-open-admin-platform/src/main/java/org/broadleafcommerce/openadmin/web/rulebuilder/service/AbstractRuleBuilderFieldService.java

@@ -17,6 +17,7 @@
  * limitations under the License.
  * #L%
  */
+
 package org.broadleafcommerce.openadmin.web.rulebuilder.service;
 
 import org.apache.commons.lang.ArrayUtils;
@@ -77,14 +78,14 @@ public FieldWrapper buildFields() {
         for (FieldData field : getFields()) {
             FieldDTO fieldDTO = new FieldDTO();
             fieldDTO.setLabel(field.getFieldLabel());
-            
+
             //translate the label to display
             String label = field.getFieldLabel();
             BroadleafRequestContext context = BroadleafRequestContext.getBroadleafRequestContext();
             MessageSource messages = context.getMessageSource();
             label = messages.getMessage(label, null, label, context.getJavaLocale());
             fieldDTO.setLabel(label);
-            
+
             fieldDTO.setName(field.getFieldName());
             fieldDTO.setOperators(field.getOperators());
             fieldDTO.setOptions(field.getOptions());
@@ -99,7 +100,7 @@ public SupportedFieldType getSupportedFieldType(String fieldName) {
         SupportedFieldType type = null;
         if (fieldName != null) {
             for (FieldData field : getFields()) {
-                if (fieldName.equals(field.getFieldName())){
+                if (fieldName.equals(field.getFieldName())) {
                     return field.getFieldType();
                 }
             }
@@ -112,7 +113,7 @@ public SupportedFieldType getSecondaryFieldType(String fieldName) {
         SupportedFieldType type = null;
         if (fieldName != null) {
             for (FieldData field : getFields()) {
-                if (fieldName.equals(field.getFieldName())){
+                if (fieldName.equals(field.getFieldName())) {
                     return field.getSecondaryFieldType();
                 }
             }
@@ -155,7 +156,8 @@ public List<FieldData> getFields() {
     @Override
     @SuppressWarnings("unchecked")
     public void setFields(final List<FieldData> fields) {
-        List<FieldData> proxyFields = (List<FieldData>) Proxy.newProxyInstance(getClass().getClassLoader(), new Class<?>[]{List.class}, new InvocationHandler() {
+        List<FieldData> proxyFields = (List<FieldData>) Proxy.newProxyInstance(getClass().getClassLoader(), new Class<?>[] { List.class }, new InvocationHandler() {
+
             @Override
             public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
                 if (method.getName().equals("add")) {
@@ -174,20 +176,22 @@ public Object invoke(Object proxy, Method method, Object[] args) throws Throwabl
             }
 
             private void testFieldName(FieldData fieldData) throws ClassNotFoundException {
-                if (!StringUtils.isEmpty(fieldData.getFieldName()) && dynamicEntityDao != null) {
-                    Class<?>[] dtos = dynamicEntityDao.getAllPolymorphicEntitiesFromCeiling(Class.forName(getDtoClassName()));
-                    if (ArrayUtils.isEmpty(dtos)) {
-                        dtos = new Class<?>[]{Class.forName(getDtoClassName())};
-                    }
-                    Field field = null;
-                    for (Class<?> dto : dtos) {
-                        field = dynamicEntityDao.getFieldManager().getField(dto, fieldData.getFieldName());
-                        if (field != null) {
-                            break;
+                if (!fieldData.getSkipValidation()) {
+                    if (!StringUtils.isEmpty(fieldData.getFieldName()) && dynamicEntityDao != null) {
+                        Class<?>[] dtos = dynamicEntityDao.getAllPolymorphicEntitiesFromCeiling(Class.forName(getDtoClassName()));
+                        if (ArrayUtils.isEmpty(dtos)) {
+                            dtos = new Class<?>[] { Class.forName(getDtoClassName()) };
+                        }
+                        Field field = null;
+                        for (Class<?> dto : dtos) {
+                            field = dynamicEntityDao.getFieldManager().getField(dto, fieldData.getFieldName());
+                            if (field != null) {
+                                break;
+                            }
+                        }
+                        if (field == null) {
+                            throw new IllegalArgumentException("Unable to find the field declared in FieldData (" + fieldData.getFieldName() + ") on the target class (" + getDtoClassName() + "), or any registered entity class that derives from it.");
                         }
-                    }
-                    if (field == null) {
-                        throw new IllegalArgumentException("Unable to find the field declared in FieldData (" + fieldData.getFieldName() + ") on the target class (" + getDtoClassName() + "), or any registered entity class that derives from it.");
                     }
                 }
             }
@@ -221,7 +225,7 @@ public void afterPropertiesSet() throws Exception {
             PersistenceManager persistenceManager = PersistenceManagerFactory.getPersistenceManager(TargetModeType.SANDBOX);
             dynamicEntityDao = persistenceManager.getDynamicEntityDao();
             setFields(new ArrayList<FieldData>());
-            
+
             // This cannot be null during startup as we do not want to remove the null safety checks in a multi-tenant env.
             boolean contextWasNull = false;
             if (BroadleafRequestContext.getBroadleafRequestContext() == null) {

common/src/main/java/org/broadleafcommerce/common/RequestDTOImpl.java

@@ -17,13 +17,16 @@
  * limitations under the License.
  * #L%
  */
+
 package org.broadleafcommerce.common;
 
 import org.apache.commons.lang3.StringUtils;
 import org.broadleafcommerce.common.presentation.AdminPresentation;
+import org.broadleafcommerce.common.web.BroadleafRequestContext;
 import org.springframework.web.context.request.WebRequest;
 
 import java.io.Serializable;
+import java.util.Map;
 
 import javax.servlet.http.HttpServletRequest;
 
@@ -37,7 +40,6 @@ public class RequestDTOImpl implements RequestDTO, Serializable {
     @AdminPresentation(friendlyName = "RequestDTOImpl_Request_URI")
     private String requestURI;
 
-
     @AdminPresentation(friendlyName = "RequestDTOImpl_Full_Url")
     private String fullUrlWithQueryString;
 
@@ -102,4 +104,12 @@ public void setRequestURI(String requestURI) {
         this.requestURI = requestURI;
     }
 
+    public Map<String, Object> getProperties() {
+        if (BroadleafRequestContext.getBroadleafRequestContext() != null) {
+            return BroadleafRequestContext.getBroadleafRequestContext().getAdditionalProperties();
+        } else {
+            return null;
+        }
+    }
+
 }