Support rendering GSON templates via controllers. Fixes #9593

graemerocher · graemerocher · commit b6a690fafbf5 · 2016-02-01T14:46:36.000+01:00
diff --git a/grails-plugin-controllers/src/main/groovy/grails/artefact/controller/support/ResponseRenderer.groovy b/grails-plugin-controllers/src/main/groovy/grails/artefact/controller/support/ResponseRenderer.groovy
@@ -30,20 +30,18 @@ import grails.web.http.HttpHeaders
 import grails.web.mime.MimeType
 import grails.web.mime.MimeUtility
 import groovy.json.StreamingJsonBuilder
-import groovy.text.Template
 import groovy.transform.CompileStatic
 import groovy.util.slurpersupport.GPathResult
 import groovy.xml.StreamingMarkupBuilder
 import org.codehaus.groovy.grails.web.metaclass.ControllerDynamicMethods
 import org.grails.gsp.GroovyPageTemplate
-import org.grails.gsp.ResourceAwareTemplateEngine
-import org.grails.io.support.GrailsResourceUtils
 import org.grails.io.support.SpringIOUtils
 import org.grails.web.converters.Converter
 import org.grails.web.json.JSONElement
 import org.grails.web.servlet.mvc.ActionResultTransformer
 import org.grails.web.servlet.mvc.GrailsWebRequest
 import org.grails.web.servlet.mvc.exceptions.ControllerExecutionException
+import org.grails.web.servlet.view.CompositeViewResolver
 import org.grails.web.servlet.view.GroovyPageView
 import org.grails.web.sitemesh.GrailsLayoutDecoratorMapper
 import org.grails.web.sitemesh.GrailsLayoutView
@@ -300,46 +298,32 @@ trait ResponseRenderer extends WebAttributes {
                 modelObject = argMap[ARGUMENT_MODEL]
             }
             String templateName = argMap[ARGUMENT_TEMPLATE].toString()
-            String contextPath = getContextPath(webRequest, argMap)
-
             String var
             if (argMap.containsKey(ARGUMENT_VAR)) {
                 var = String.valueOf( argMap[ARGUMENT_VAR] )
             }
 
             // get the template uri
-            String templateUri = applicationAttributes.getTemplateURI((GroovyObject)this, templateName)
+            String templateUri = applicationAttributes.getTemplateURI((GroovyObject)this, templateName, false)
 
-            // retrieve gsp engine
-            ResourceAwareTemplateEngine engine = applicationAttributes.getPagesTemplateEngine()
+            // retrieve view resolver
+            def applicationContext = applicationAttributes.getApplicationContext()
+            def viewResolver = applicationContext.getBean(CompositeViewResolver.BEAN_NAME, CompositeViewResolver)
             try {
-                Template t = engine.createTemplateForUri([
-                        GrailsResourceUtils.appendPiecesForUri(contextPath, templateUri),
-                        GrailsResourceUtils.appendPiecesForUri(contextPath, "/grails-app/views/", templateUri)] as String[])
-
-                if (t == null) {
-                    throw new ControllerExecutionException("Unable to load template for uri [$templateUri]. Template not found.")
-                }
 
-                if (t instanceof GroovyPageTemplate) {
-                    ((GroovyPageTemplate)t).allowSettingContentType = true
+                View view = viewResolver.resolveView(templateUri, webRequest.locale)
+                if(view instanceof GroovyPageView) {
+                    ((GroovyPageTemplate)((GroovyPageView)view).template).allowSettingContentType = true
                 }
-
-                def gspView = new GroovyPageView()
-                gspView.template = t
-
-                try {
-                    gspView.afterPropertiesSet()
-                } catch (Exception e) {
-                    throw new RuntimeException("Problem initializing view", e)
+                if (view == null) {
+                    throw new ControllerExecutionException("Unable to load template for uri [$templateUri]. Template not found.")
                 }
 
-                View view = gspView
                 boolean renderWithLayout = (explicitSiteMeshLayout || webRequest.getCurrentRequest().getAttribute(GrailsLayoutDecoratorMapper.LAYOUT_ATTRIBUTE))
                 if(renderWithLayout && groovyPageLayoutFinder) {
                     applySiteMeshLayout webRequest.currentRequest, false, explicitSiteMeshLayout
                     try {
-                        view = new GrailsLayoutView(groovyPageLayoutFinder, gspView)
+                        view = new GrailsLayoutView(groovyPageLayoutFinder, view)
                     } catch (NoSuchBeanDefinitionException e) {
                         // ignore
                     }
diff --git a/grails-plugin-controllers/src/main/groovy/org/grails/plugins/web/controllers/ControllersGrailsPlugin.groovy b/grails-plugin-controllers/src/main/groovy/org/grails/plugins/web/controllers/ControllersGrailsPlugin.groovy
@@ -31,6 +31,7 @@ import org.grails.web.mapping.mvc.UrlMappingsInfoHandlerAdapter
 import org.grails.web.servlet.mvc.GrailsDispatcherServlet
 import org.grails.web.servlet.mvc.GrailsWebRequestFilter
 import org.grails.web.servlet.mvc.TokenResponseActionResultTransformer
+import org.grails.web.servlet.view.CompositeViewResolver
 import org.springframework.beans.factory.support.AbstractBeanDefinition
 import org.springframework.boot.context.embedded.FilterRegistrationBean
 import org.springframework.boot.context.embedded.ServletRegistrationBean
@@ -123,6 +124,9 @@ class ControllersGrailsPlugin extends Plugin {
         }
 
         multipartResolver(StandardServletMultipartResolver)
+
+        "${CompositeViewResolver.BEAN_NAME}"(CompositeViewResolver)
+
         multipartConfigElement(MultipartConfigElement, uploadTmpDir, maxFileSize, maxRequestSize, fileSizeThreashold)
 
         def handlerInterceptors = springConfig.containsBean("localeChangeInterceptor") ? [ref("localeChangeInterceptor")] : []
diff --git a/grails-plugin-gsp/src/main/groovy/org/grails/plugins/web/GroovyPagesGrailsPlugin.groovy b/grails-plugin-gsp/src/main/groovy/org/grails/plugins/web/GroovyPagesGrailsPlugin.groovy
@@ -263,7 +263,6 @@ class GroovyPagesGrailsPlugin extends Plugin {
             grailsLayoutViewResolverPostProcessor(GrailsLayoutViewResolverPostProcessor)
         }
 
-        final pluginManager = manager
         // Now go through tag libraries and configure them in Spring too. With AOP proxies and so on
         for (taglib in application.tagLibClasses) {
 
diff --git a/grails-plugin-testing/src/main/groovy/grails/test/runtime/ControllerTestPlugin.groovy b/grails-plugin-testing/src/main/groovy/grails/test/runtime/ControllerTestPlugin.groovy
@@ -26,6 +26,9 @@ import grails.web.CamelCaseUrlConverter
 import grails.web.HyphenatedUrlConverter
 import groovy.transform.CompileStatic
 import groovy.transform.TypeCheckingMode
+import org.grails.web.servlet.view.CompositeViewResolver
+import org.grails.web.servlet.view.GroovyPageViewResolver
+import org.grails.web.util.GrailsApplicationAttributes
 
 import javax.servlet.ServletContext
 
@@ -92,11 +95,14 @@ class ControllerTestPlugin implements TestPlugin {
                 grailsApplication.addArtefact(UrlMappingsArtefactHandler.TYPE, classLoader.loadClass(urlMappingsClass))
             }
 
+            localeResolver(SessionLocaleResolver)
             multipartResolver(StandardServletMultipartResolver)
             grailsUrlMappingsHolder(UrlMappingsHolderFactoryBean) {
                 grailsApplication = grailsApplication
             }
 
+            "${CompositeViewResolver.BEAN_NAME}"(CompositeViewResolver)
+
             if(ClassUtils.isPresent("org.grails.plugins.web.GroovyPagesGrailsPlugin", classLoader)) {
                 def lazyBean = { bean ->
                     bean.lazyInit = true
@@ -120,6 +126,13 @@ class ControllerTestPlugin implements TestPlugin {
                     groovyPagesTemplateEngine = ref("groovyPagesTemplateEngine")
                 }
 
+                // Configure a Spring MVC view resolver
+                jspViewResolver(GroovyPageViewResolver) { bean ->
+                    prefix = GrailsApplicationAttributes.PATH_TO_VIEWS
+                    suffix = GroovyPageViewResolver.GSP_SUFFIX
+                    templateEngine = groovyPagesTemplateEngine
+                    groovyPageLocator = groovyPageLocator
+                }
             }
             filteringCodecsByContentTypeSettings(FilteringCodecsByContentTypeSettings, grailsApplication)
             
diff --git a/grails-web-common/src/main/groovy/grails/web/pages/GroovyPagesUriService.java b/grails-web-common/src/main/groovy/grails/web/pages/GroovyPagesUriService.java
@@ -46,6 +46,8 @@ public interface GroovyPagesUriService {
 
     void clear();
 
+    String getTemplateURI(String controllerName, String templateName, boolean includeExtension);
+
     String getAbsoluteTemplateURI(String templateName);
 
     String getAbsoluteViewURI(String viewName);
@@ -60,4 +62,6 @@ public interface GroovyPagesUriService {
      * @return The view URI
      */
     String getViewURI(String controllerName, String viewName);
+
+    String getTemplateURI(GroovyObject controller, String templateName, boolean includeExtension);
 }
diff --git a/grails-web-common/src/main/groovy/org/grails/web/pages/GroovyPagesUriSupport.java b/grails-web-common/src/main/groovy/org/grails/web/pages/GroovyPagesUriSupport.java
@@ -50,6 +50,11 @@ public String getTemplateURI(GroovyObject controller, String templateName) {
         return getTemplateURI(getLogicalControllerName(controller),templateName);
     }
 
+    @Override
+    public String getTemplateURI(GroovyObject controller, String templateName, boolean includeExtension) {
+        return getTemplateURI(getLogicalControllerName(controller),templateName, includeExtension);
+    }
+
     public void clear() {
         // do nothing
     }
@@ -98,6 +103,16 @@ public String getLogicalControllerName(GroovyObject controller) {
      * @return The template URI
      */
     public String getTemplateURI(String controllerName, String templateName) {
+        return getTemplateURI(controllerName, templateName, true);
+    }
+    /**
+     * Obtains the URI to a template using the controller name and template name
+     * @param controllerName The controller name
+     * @param templateName The template name
+     * @return The template URI
+     */
+    @Override
+    public String getTemplateURI(String controllerName, String templateName, boolean includeExtension) {
         if (templateName.startsWith(SLASH_STR)) {
             return getAbsoluteTemplateURI(templateName);
         }
@@ -112,15 +127,22 @@ public String getTemplateURI(String controllerName, String templateName) {
         }
         if(controllerName != null) {
             buf.append(SLASH)
-               .append(controllerName);
+                    .append(controllerName);
         }
         buf.append(SLASH)
-           .append(pathToTemplate)
-           .append(UNDERSCORE)
-           .append(templateName);
-        return buf.append(EXTENSION).toString();
+                .append(pathToTemplate)
+                .append(UNDERSCORE)
+                .append(templateName);
+
+        if(includeExtension) {
+            return buf.append(EXTENSION).toString();
+        }
+        else {
+            return buf.toString();
+        }
     }
 
+
     /**
      * Used to resolve template names that are not relative to a controller.
      *
diff --git a/grails-web-common/src/main/groovy/org/grails/web/servlet/DefaultGrailsApplicationAttributes.java b/grails-web-common/src/main/groovy/org/grails/web/servlet/DefaultGrailsApplicationAttributes.java
@@ -242,6 +242,11 @@ public String getTemplateURI(GroovyObject controller, String templateName) {
         return getGroovyPagesUriService().getTemplateURI(controller, templateName);
     }
 
+    @Override
+    public String getTemplateURI(GroovyObject controller, String templateName, boolean includeExtension) {
+        return getGroovyPagesUriService().getTemplateURI(controller, templateName, includeExtension);
+    }
+
     public GroovyPagesUriService getGroovyPagesUriService() {
         if (groovyPagesUriService == null) {
             groovyPagesUriService = fetchBeanFromAppCtx(GroovyPagesUriService.BEAN_ID);
diff --git a/grails-web-common/src/main/groovy/org/grails/web/servlet/view/CompositeViewResolver.groovy b/grails-web-common/src/main/groovy/org/grails/web/servlet/view/CompositeViewResolver.groovy
@@ -0,0 +1,33 @@
+package org.grails.web.servlet.view
+
+import groovy.transform.CompileStatic
+import org.springframework.beans.factory.annotation.Autowired
+import org.springframework.web.servlet.View
+import org.springframework.web.servlet.ViewResolver
+
+/**
+ * Performs the job of iterating across registered view resolvers and returning the first matching view similar to the
+ * hard coded behavior in DispatcherServlet
+ *
+ * @author Graeme Rocher
+ * @since 3.1.1
+ */
+@CompileStatic
+class CompositeViewResolver {
+
+    public static final String BEAN_NAME = "compositeViewResolver"
+
+    @Autowired(required = false)
+    List<ViewResolver> viewResolvers = []
+
+    View resolveView(String viewName, Locale locale) {
+        for(resolver in viewResolvers) {
+
+            def view = resolver.resolveViewName(viewName, locale)
+            if(view != null) {
+                return view
+            }
+        }
+        return null
+    }
+}
diff --git a/grails-web-common/src/main/groovy/org/grails/web/util/GrailsApplicationAttributes.java b/grails-web-common/src/main/groovy/org/grails/web/util/GrailsApplicationAttributes.java
@@ -99,8 +99,25 @@ public interface GrailsApplicationAttributes extends ApplicationAttributes, org.
      */
     String getApplicationUri(ServletRequest request);
 
+    /**
+     * Resolve the URI for a template
+     *
+     * @param controller The controller
+     * @param templateName The name of the template
+     * @return The template name
+     */
     String getTemplateURI(GroovyObject controller, String templateName);
 
+    /**
+     * Resolve the URI for a template
+     *
+     * @param controller The controller
+     * @param templateName The name of the template
+     * @param includeExtension Whether to include the GSP etension
+     * @return The template name
+     */
+    String getTemplateURI(GroovyObject controller, String templateName, boolean includeExtension);
+
     String getNoSuffixViewURI(GroovyObject controller, String viewName);
 
     /**

Original file line number	Diff line number	Diff line change
`@@ -263,7 +263,6 @@ class GroovyPagesGrailsPlugin extends Plugin {`
`263`	`263`	`grailsLayoutViewResolverPostProcessor(GrailsLayoutViewResolverPostProcessor)`
`264`	`264`	`}`
`265`	`265`
`266`		`- final pluginManager = manager`
`267`	`266`	`// Now go through tag libraries and configure them in Spring too. With AOP proxies and so on`
`268`	`267`	`for (taglib in application.tagLibClasses) {`
`269`	`268`