src/web/org/codehaus/groovy/grails/web/binding/DataBindingUtils.java

   1 /* Copyright 2006-2007 Graeme Rocher
   2  *
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at
   6  *
   7  *      http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15 package org.codehaus.groovy.grails.web.binding;
  16
  17 import groovy.lang.GroovySystem;
  18 import groovy.lang.MetaClass;
  19 import org.apache.commons.collections.CollectionUtils;
  20 import org.codehaus.groovy.grails.web.servlet.mvc.GrailsParameterMap;
  21 import org.codehaus.groovy.grails.web.servlet.mvc.GrailsWebRequest;
  22 import org.springframework.beans.MutablePropertyValues;
  23 import org.springframework.validation.BindingResult;
  24 import org.springframework.web.context.request.RequestContextHolder;
  25
  26 import javax.servlet.http.HttpServletRequest;
  27 import java.util.ArrayList;
  28 import java.util.Collections;
  29 import java.util.List;
  30 import java.util.Map;
  31
  32 /**
  33  * Utility methods to perform data binding from Grails objects
  34  *
  35  * @author Graeme Rocher
  36  * @since 1.0
  37  *
  38  *        <p/>
  39  *        Created: Sep 13, 2007
  40  *        Time: 2:34:11 PM
  41  */
  42 public class DataBindingUtils {
  43
  44     /**
  45      * Binds the given source object to the given target object performing type conversion if necessary
  46      *
  47      * @param object The object to bind to
  48      * @param source The source object
  49      * @return A BindingResult or null if it wasn't successful
  50      */
  51     public static BindingResult bindObjectToInstance(Object object, Object source) {
  52         return bindObjectToInstance(object, source, Collections.EMPTY_LIST,Collections.EMPTY_LIST, null);
  53     }
  54
  55     /**
  56      * Binds the given source object to the given target object performing type conversion if necessary
  57      *
  58      * @param object The object to bind to
  59      * @param source The source object
  60      * @param include The list of properties to include
  61      * @param exclude The list of properties to exclude
  62      *
  63      * @return A BindingResult or null if it wasn't successful
  64      */
  65     public static BindingResult bindObjectToInstance(Object object, Object source, List include, List exclude, String filter) {
  66         BindingResult bindingResult = null;
  67         if(source instanceof GrailsParameterMap) {
  68                         GrailsParameterMap parameterMap = (GrailsParameterMap)source;
  69                         HttpServletRequest request = parameterMap.getRequest();
  70                         GrailsDataBinder dataBinder = createDataBinder(object, include, exclude, request);
  71                         dataBinder.bind(parameterMap);
  72             bindingResult = dataBinder.getBindingResult();
  73         }
  74         else if (source instanceof HttpServletRequest) {
  75             HttpServletRequest request = (HttpServletRequest)source;
  76             GrailsDataBinder dataBinder = createDataBinder(object, include, exclude, request);
  77             dataBinder.bind(request);
  78             performBindFromRequest(dataBinder, request,filter);
  79             bindingResult = dataBinder.getBindingResult();
  80         }
  81         else if(source instanceof Map) {
  82                         Map propertyMap = (Map)source;
  83             propertyMap = convertPotentialGStrings(propertyMap);
  84             GrailsDataBinder binder = createDataBinder(object, include, exclude, null);
  85
  86             performBindFromPropertyValues(binder, new MutablePropertyValues(propertyMap),filter);
  87             bindingResult = binder.getBindingResult();
  88         }
  89         else {
  90                 GrailsWebRequest webRequest = (GrailsWebRequest) RequestContextHolder.getRequestAttributes();
  91             if(webRequest != null) {
  92                 GrailsDataBinder binder = createDataBinder(object, include, exclude, webRequest.getCurrentRequest());
  93                 HttpServletRequest request = webRequest.getCurrentRequest();
  94                 performBindFromRequest(binder, request,filter);
  95             }
  96
  97
  98         }
  99         MetaClass mc = GroovySystem.getMetaClassRegistry().getMetaClass(object.getClass());
 100         if(mc.hasProperty(object, "errors")!=null && bindingResult!=null) {
 101             mc.setProperty(object,"errors", bindingResult);
 102         }
 103         return bindingResult;
 104     }
 105
 106     private static void performBindFromPropertyValues(GrailsDataBinder binder, MutablePropertyValues mutablePropertyValues, String filter) {
 107         if(filter!=null) {
 108             binder.bind(mutablePropertyValues,filter);
 109         }
 110         else {
 111             binder.bind(mutablePropertyValues);
 112         }
 113     }
 114
 115     private static void performBindFromRequest(GrailsDataBinder binder, HttpServletRequest request,String filter) {
 116         if(filter!=null) {
 117             binder.bind(request,filter);
 118         }
 119         else {
 120             binder.bind(request);
 121         }
 122     }
 123
 124     private static GrailsDataBinder createDataBinder(Object object, List include, List exclude, HttpServletRequest request) {
 125
 126         GrailsDataBinder binder;
 127         if(request!=null) {
 128             binder = GrailsDataBinder.createBinder(object, object.getClass().getName(), request);
 129         }
 130         else {
 131             binder = GrailsDataBinder.createBinder(object, object.getClass().getName());
 132         }
 133         includeExcludeFields(binder, include, exclude);
 134         return binder;
 135     }
 136
 137     private static Map convertPotentialGStrings(Map args) {
 138                 Map newArgs = new java.util.HashMap();
 139                 for(java.util.Iterator i = args.keySet().iterator(); i.hasNext();) {
 140                         Object key = i.next();
 141                         Object value = args.get(key);
 142                         if(key instanceof groovy.lang.GString) {
 143                                 key = key.toString();
 144                         }
 145                         if(value instanceof groovy.lang.GString) {
 146                                 value = value.toString();
 147                         }
 148                         newArgs.put(key,value);
 149                 }
 150                 return newArgs;
 151         }
 152
 153     private static void includeExcludeFields(GrailsDataBinder dataBinder, List allowed, List disallowed) {
 154         updateAllowed( dataBinder, allowed);
 155         updateDisallowed( dataBinder, disallowed);
 156     }
 157
 158     private static void updateAllowed(GrailsDataBinder binder, List allowed) {
 159           if (allowed != null) {
 160             String[] currentAllowed = binder.getAllowedFields();
 161             List newAllowed = new ArrayList(allowed);
 162             CollectionUtils.addAll( newAllowed, currentAllowed);
 163             String[] value = new String[newAllowed.size()];
 164             newAllowed.toArray(value);
 165             binder.setAllowedFields(value);
 166         }
 167     }
 168
 169     private static void updateDisallowed( GrailsDataBinder binder, List disallowed) {
 170         if (disallowed != null) {
 171             String[] currentDisallowed = binder.getDisallowedFields();
 172             List newDisallowed = new ArrayList(disallowed);
 173             CollectionUtils.addAll( newDisallowed, currentDisallowed);
 174             String[] value = new String[newDisallowed.size()];
 175             newDisallowed.toArray(value);
 176             binder.setDisallowedFields(value);
 177         }
 178     }
 179 }