revert sitemesh3 upgrade & rename sitemesh -> layout to ensure license compliance

Author: jdaugherty

LICENSE

@@ -263,4 +263,11 @@ This product includes the following files from Spring Framework 5.3, developed b
 
 See the above Apache License 2.0 for the terms governing these files.
 
+--------------------------------------------------------------------------
+
+This product includes software developed by the OpenSymphony Group (http://www.opensymphony.com/). It uses Sitemesh2,
+licensed under the OpenSymphony Software License, Version 1.1.
+
+See licenses/LICENSE-opensymphony.txt for the full license terms.
+
 --------------------------------------------------------------------------

NOTICE

@@ -25,4 +25,7 @@ http://www.oracle.com/webfolder/technetwork/jsc/xml/ns/javaee/index.html
 
 This product includes software from Spring Framework 5.3, developed by Pivotal Software, Inc.
 Copyright 2002-2020 the original author or authors.
-See the LICENSE file for the Apache License 2.0 terms.
+See the LICENSE file for the Apache License 2.0 terms.
+
+This product includes software developed by the OpenSymphony Group (http://www.opensymphony.com/). It uses Sitemesh2,
+licensed under the OpenSymphony Software License, Version 1.1. See licenses/LICENSE-opensymphony.txt for the full license terms.

RENAME.md

@@ -121,7 +121,7 @@ Below is a reference of all migrated artifacts - both their old and new name.
 | org.grails.plugins                | scaffolding                                     | org.apache.grails                               | grails-scaffolding                                            |                        |                        | grails-views           |
 | org.grails                        | grails-plugin-services                          | org.apache.grails                               | grails-services                                               |                        |                        | grails-core            |
 | org.grails                        | grails-shell                                    | org.apache.grails                               | grails-shell-cli                                              |                        |                        | grails-core            |
-| org.grails                        | grails-plugin-sitemesh3                         | org.apache.grails                               | grails-sitemesh3                                              |                        |                        | grails-views           |
+| org.grails.plugins                | sitemesh2                                       | org.apache.grails                               | grails-layout                                                 |                        |                        | grails-gsp             |
 | org.grails                        | grails-spring                                   | org.apache.grails                               | grails-spring                                                 |                        |                        | grails-core            |
 | org.grails.plugins                | spring-security-acl                             | org.apache.grails                               | grails-spring-security-acl                                    |                        |                        | grails-spring-security |
 | org.grails.plugins                | spring-security-cas                             | org.apache.grails                               | grails-spring-security-cas                                    |                        |                        | grails-spring-security |

UPGRADE7.md

@@ -48,6 +48,5 @@ Experienced while upgrading modules for Grails 7
 
 ### Cool New Features
 - Hello Exterminator, Good by bugs! Lot's of things started working... and working well! For instance, use of controller namespaces now work seemlessly.
-- Massive decoupling of dependencies and cleanup between modules.  SiteMesh dependencies are no longer compiled into controllers fused between numerous modules. SiteMesh isn't even required to use Grails!
-- GSP can now be used OUTSIDE of Grails! see grails-boot
+- Massive decoupling of dependencies and cleanup between modules.
 - Works with Spring Security 6 out of the box. No plugin needed!

dependencies.gradle

@@ -93,6 +93,7 @@ ext {
             'rxjava3.version'              : '3.1.10',
             'selenium.version'             : '4.25.0',
             'spock.version'                : '2.3-groovy-4.0',
+            'sitemesh.version'             : '2.6.0',
     ]
 
     // Note: the name of the dependency must be the prefix of the property name so properties in the pom are resolved correctly
@@ -123,6 +124,7 @@ ext {
             'rxjava'                   : "io.reactivex:rxjava:${bomDependencyVersions['rxjava.version']}",
             'rxjava2'                  : "io.reactivex.rxjava2:rxjava:${bomDependencyVersions['rxjava2.version']}",
             'rxjava3'                  : "io.reactivex.rxjava3:rxjava:${bomDependencyVersions['rxjava3.version']}",
+            'sitemesh'                 : "opensymphony:sitemesh:${bomDependencyVersions['sitemesh.version']}",
     ]
 
     // Because pom exclusions aren't properly supported by gradle, we can't inherit the grails-gradle-bom

etc/bin/rename_gradle_artifacts.sh

@@ -160,7 +160,9 @@ declare -a views_mappings=(
   "org[.]grails:grails-web-gsp-taglib|org.apache.grails.views:grails-web-gsp-taglib"
   "org[.]grails:grails-web-gsp|org.apache.grails.views:grails-web-gsp"
   "org[.]grails:grails-taglib|org.apache.grails.views:grails-taglib"
-  "org[.]grails:grails-plugin-sitemesh3|org.apache.grails:grails-sitemesh3"
+  #"org[.]grails:grails-plugin-sitemesh3|org.apache.grails:grails-sitemesh3"
+  "org[.]grails[.].plugins:sitemesh2|org.apache.grails:grails-layout"
+  "org[.]grails:grails-web-sitemesh|org.apache.grails:grails-web-layout"
   "org[.]grails:grails-gsp|org.apache.grails.views:grails-gsp-core"
 )
   declare -a excluded_gsp_mappings=(
@@ -171,7 +173,9 @@ declare -a views_mappings=(
   "exclude[[:space:]]+module[[:space:]]*:[[:space:]]*['\"]scaffolding['\"]|exclude module:'grails-scaffolding'"
   "exclude[[:space:]]+module[[:space:]]*:[[:space:]]*['\"]gsp['\"]|exclude module:'grails-gsp'"
   "exclude[[:space:]]+module[[:space:]]*:[[:space:]]*['\"]grails-web-testing-support['\"]|exclude module:'grails-testing-support-web'"
-  "exclude[[:space:]]+module[[:space:]]*:[[:space:]]*['\"]grails-plugin-sitemesh3['\"]|exclude module:'grails-sitemesh3'"
+  #"exclude[[:space:]]+module[[:space:]]*:[[:space:]]*['\"]grails-plugin-sitemesh3['\"]|exclude module:'grails-sitemesh3'"
+  "exclude[[:space:]]+module[[:space:]]*:[[:space:]]*['\"]sitemesh2['\"]|exclude module:'grails-layout'"
+  "exclude[[:space:]]+module[[:space:]]*:[[:space:]]*['\"]grails-web-sitemesh['\"]|exclude module:'grails-web-layout'"
   "exclude[[:space:]]+module[[:space:]]*:[[:space:]]*['\"]grails-gsp['\"]|exclude module:'grails-gsp-core'"
   "exclude[[:space:]]+module[[:space:]]*:[[:space:]]*['\"]fields['\"]|exclude module:'grails-fields'"
   )

gradle.properties

@@ -35,7 +35,6 @@ joddWotVersion=3.3.8
 elApiVersion=5.0.1
 defaultElImplementationVersion=5.0.0
 jspApiVersion=4.0.0
-sitemeshVersion=3.2.2
 javassistVersion=3.30.2-GA
 yakworksHibernateGroovyProxyVersion=1.1
 picocliVersion=4.7.6
@@ -60,7 +59,7 @@ org.gradle.jvmargs=-Dfile.encoding=UTF-8 -Xmx5G
 jbossTransactionApiVersion=2.0.0.Final
 micronautVersion=4.6.5
 micronautSerdeJacksonVersion=2.11.0
-grailsSpringSecurityVersion=7.0.0-SNAPSHOT
+grailsSpringSecurityVersion=7.0.0-M4
 
 # This prevents the Grails Gradle Plugin from unnecessarily excluding slf4j-simple in the generated POMs
 # https://github.com/apache/grails-gradle-plugin/issues/222

gradle/publish-root-config.gradle

@@ -67,7 +67,7 @@ def publishedProjects = [
         'grails-scaffolding',
         'grails-services',
         'grails-shell-cli',
-        'grails-sitemesh3',
+        'grails-layout',
         'grails-spring',
         'grails-taglib',
         'grails-test-core',
@@ -87,6 +87,7 @@ def publishedProjects = [
         'grails-web-gsp',
         'grails-web-gsp-taglib',
         'grails-web-jsp',
+        'grails-web-layout',
         'grails-web-mvc',
         'grails-web-taglib',
         'grails-web-url-mappings',

grails-controllers/build.gradle

@@ -35,6 +35,7 @@ dependencies {
     api project(':grails-mimetypes')
     api project(':grails-validation')
     api project(':grails-domain-class')
+    api project(':grails-web-layout')
 
     api 'org.apache.groovy:groovy'
     api 'org.springframework.boot:spring-boot-autoconfigure'

grails-controllers/src/main/groovy/grails/artefact/controller/support/ResponseRenderer.groovy

@@ -40,8 +40,11 @@ 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.apache.grails.web.layout.EmbeddedGrailsLayoutView
+import org.apache.grails.web.layout.GroovyPageLayoutFinder
 import org.grails.web.util.GrailsApplicationAttributes
 import org.grails.web.util.WebUtils
+import org.springframework.beans.factory.NoSuchBeanDefinitionException
 import org.springframework.beans.factory.annotation.Autowired
 import org.springframework.beans.factory.annotation.Qualifier
 import org.springframework.http.HttpStatus
@@ -54,6 +57,7 @@ import jakarta.servlet.http.HttpServletRequest
 import jakarta.servlet.http.HttpServletResponse
 
 import static org.grails.plugins.web.controllers.metaclass.RenderDynamicMethod.*
+
 /**
  *
  * A trait that adds behavior to allow rendering of objects to the response
@@ -70,8 +74,15 @@ trait ResponseRenderer extends WebAttributes {
 
 
     private MimeUtility mimeUtility
+    private GroovyPageLayoutFinder groovyPageLayoutFinder
     private GrailsPluginManager pluginManager
 
+    @Generated
+    @Autowired(required = false)
+    void setGroovyPageLayoutFinder(GroovyPageLayoutFinder groovyPageLayoutFinder) {
+        this.groovyPageLayoutFinder = groovyPageLayoutFinder
+    }
+
     @Generated
     @Autowired(required = false)
     @Qualifier("grailsMimeUtility")
@@ -142,7 +153,7 @@ trait ResponseRenderer extends WebAttributes {
         else {
             renderMarkupInternal webRequest, closure, response
         }
-        setLayout webRequest.currentRequest, layoutArg
+        applyGrailsLayout webRequest.currentRequest, false, layoutArg
     }
 
     private void renderJsonInternal(HttpServletResponse response, @DelegatesTo(value = StreamingJsonBuilder.StreamingJsonDelegate.class, strategy = Closure.DELEGATE_FIRST) Closure callable) {
@@ -166,7 +177,7 @@ trait ResponseRenderer extends WebAttributes {
         applyContentType response, argMap, body
         handleStatusArgument argMap, webRequest, response
         render body
-        setLayout webRequest.currentRequest, layoutArg
+        applyGrailsLayout webRequest.currentRequest, false, layoutArg
     }
 
     /**
@@ -210,7 +221,7 @@ trait ResponseRenderer extends WebAttributes {
         handleStatusArgument argMap, webRequest, response
         applyContentType response, argMap, writable
         renderWritable writable, response
-        setLayout webRequest.currentRequest, layoutArg
+        applyGrailsLayout webRequest.currentRequest, false, layoutArg
         webRequest.renderView = false
     }
 
@@ -238,7 +249,7 @@ trait ResponseRenderer extends WebAttributes {
                 CharSequence text = (textArg instanceof CharSequence) ? ((CharSequence)textArg) : textArg.toString()
                 render text
             }
-            setLayout webRequest.currentRequest, layoutArg
+            applyGrailsLayout webRequest.currentRequest, false, layoutArg
         }
         else if (argMap.containsKey(ARGUMENT_VIEW)) {
             String viewName = argMap[ARGUMENT_VIEW].toString()
@@ -266,7 +277,7 @@ trait ResponseRenderer extends WebAttributes {
             }
 
             ((GroovyObject)this).setProperty "modelAndView", new ModelAndView(viewUri, model)
-            setLayout webRequest.currentRequest, layoutArg
+            applyGrailsLayout webRequest.currentRequest, true, layoutArg
         }
         else if (argMap.containsKey(ARGUMENT_TEMPLATE)) {
             applyContentType response, argMap, null, false
@@ -301,9 +312,17 @@ trait ResponseRenderer extends WebAttributes {
 
                 boolean renderWithLayout = (layoutArg || webRequest.getCurrentRequest().getAttribute(WebUtils.LAYOUT_ATTRIBUTE))
                 // if automatic decoration occurred unwrap, since this is a partial
+                if(view instanceof EmbeddedGrailsLayoutView) {
+                    view = ((EmbeddedGrailsLayoutView)view).getInnerView()
+                }
 
-                if (renderWithLayout) {
-                    setLayout webRequest.currentRequest, layoutArg
+                if(renderWithLayout && groovyPageLayoutFinder) {
+                    applyGrailsLayout webRequest.currentRequest, false, layoutArg
+                    try {
+                        view = new EmbeddedGrailsLayoutView(groovyPageLayoutFinder, view)
+                    } catch (NoSuchBeanDefinitionException e) {
+                        // ignore
+                    }
                 }
 
 
@@ -535,9 +554,14 @@ trait ResponseRenderer extends WebAttributes {
         renderArgument instanceof GPathResult ? APPLICATION_XML : defaultEncoding
     }
 
-    private void setLayout(HttpServletRequest request, String layout) {
-        if (layout != null && request.getAttribute(WebUtils.LAYOUT_ATTRIBUTE) == null) {
-            request.setAttribute WebUtils.LAYOUT_ATTRIBUTE, layout
+    private void applyGrailsLayout(HttpServletRequest request, boolean renderView, String explicitLayoutArg) {
+        if(explicitLayoutArg == null && request.getAttribute(WebUtils.LAYOUT_ATTRIBUTE) != null) {
+            // layout has been set already
+            return
+        }
+        String selectedLayout = explicitLayoutArg != null ? explicitLayoutArg : (renderView ? null : GroovyPageLayoutFinder.NONE_LAYOUT)
+        if(selectedLayout != null) {
+            request.setAttribute WebUtils.LAYOUT_ATTRIBUTE, selectedLayout
         }
     }