Merge pull request #13118 from codeconsole/decouple-sitemesh-2

Decouple Sitemesh - Step 2
grails · Sep 5, 2023 · 1c71351 · 1c71351
2 parents 56a6643 + d9c4352
commit 1c71351
Show file tree

Hide file tree

Showing 2 changed files with 363 additions and 5 deletions.
diff --git a/grails-encoder/src/main/groovy/org/grails/buffer/GrailsRoutablePrintWriter.java b/grails-encoder/src/main/groovy/org/grails/buffer/GrailsRoutablePrintWriter.java
@@ -0,0 +1,359 @@
+/*
+ * Copyright 2004-2005 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.grails.buffer;
+
+import groovy.lang.Writable;
+
+import java.io.IOException;
+import java.io.PrintWriter;
+import java.io.Writer;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.objenesis.ObjenesisStd;
+import org.springframework.objenesis.instantiator.ObjectInstantiator;
+
+// Moved from grails-gsp:
+// https://github.com/grails/grails-gsp/blob/v6.0.2/grails-web-sitemesh/src/main/groovy/org/grails/web/sitemesh/GrailsRoutablePrintWriter.java
+public class GrailsRoutablePrintWriter extends GrailsPrintWriterAdapter {
+    private static final Logger LOG = LoggerFactory.getLogger(GrailsRoutablePrintWriter.class);
+    private DestinationFactory factory;
+    private boolean blockFlush = true;
+    private boolean blockClose = true;
+    private boolean destinationActivated = false;
+    private static ObjectInstantiator instantiator=null;
+    static {
+        try {
+            instantiator = new ObjenesisStd(false).getInstantiatorOf(GrailsRoutablePrintWriter.class);
+        } catch (Exception e) {
+            LOG.debug("Couldn't get direct performance optimized instantiator for GrailsRoutablePrintWriter. Using default instantiation.", e);
+        }
+    }
+
+    /**
+     * Factory to lazily instantiate the destination.
+     */
+    public static interface DestinationFactory {
+        Writer activateDestination() throws IOException;
+    }
+
+    public GrailsRoutablePrintWriter(DestinationFactory factory) {
+        super(new NullWriter());
+        this.factory = factory;
+    }
+
+    public static GrailsRoutablePrintWriter newInstance(DestinationFactory factory) {
+        if (instantiator != null) {
+            GrailsRoutablePrintWriter instance = (GrailsRoutablePrintWriter)instantiator.newInstance();
+            instance.out = new NullWriter();
+            instance.factory = factory;
+            instance.blockFlush = true;
+            instance.blockClose = true;
+            return instance;
+        } else {
+            return new GrailsRoutablePrintWriter(factory);
+        }
+    }
+
+    protected void activateDestination() {
+        if (!destinationActivated && factory != null) {
+            try {
+                super.setTarget(factory.activateDestination());
+            }
+            catch (IOException e) {
+                setError();
+            }
+            destinationActivated = true;
+        }
+    }
+
+    @Override
+    public boolean isAllowUnwrappingOut() {
+        return destinationActivated ? super.isAllowUnwrappingOut() : false;
+    }
+
+    @Override
+    public Writer unwrap() {
+        return destinationActivated ? super.unwrap() : this;
+    }
+
+    public void updateDestination(DestinationFactory f) {
+        setDestinationActivated(false);
+        this.factory = f;
+    }
+
+    @Override
+    public void close() {
+        if (!isBlockClose() && isDestinationActivated()) {
+            super.close();
+        }
+    }
+
+    @Override
+    public void println(Object x) {
+        activateDestination();
+        super.println(x);
+    }
+
+    @Override
+    public void println(String x) {
+        activateDestination();
+        super.println(x);
+    }
+
+    @Override
+    public void println(char x[]) {
+        activateDestination();
+        super.println(x);
+    }
+
+    @Override
+    public void println(double x) {
+        activateDestination();
+        super.println(x);
+    }
+
+    @Override
+    public void println(float x) {
+        activateDestination();
+        super.println(x);
+    }
+
+    @Override
+    public void println(long x) {
+        activateDestination();
+        super.println(x);
+    }
+
+    @Override
+    public void println(int x) {
+        activateDestination();
+        super.println(x);
+    }
+
+    @Override
+    public void println(char x) {
+        activateDestination();
+        super.println(x);
+    }
+
+    @Override
+    public void println(boolean x) {
+        activateDestination();
+        super.println(x);
+    }
+
+    @Override
+    public void println() {
+        activateDestination();
+        super.println();
+    }
+
+    @Override
+    public void print(Object obj) {
+        activateDestination();
+        super.print(obj);
+    }
+
+    @Override
+    public void print(String s) {
+        activateDestination();
+        super.print(s);
+    }
+
+    @Override
+    public void print(char s[]) {
+        activateDestination();
+        super.print(s);
+    }
+
+    @Override
+    public void print(double d) {
+        activateDestination();
+        super.print(d);
+    }
+
+    @Override
+    public void print(float f) {
+        activateDestination();
+        super.print(f);
+    }
+
+    @Override
+    public void print(long l) {
+        activateDestination();
+        super.print(l);
+    }
+
+    @Override
+    public void print(int i) {
+        activateDestination();
+        super.print(i);
+    }
+
+    @Override
+    public void print(char c) {
+        activateDestination();
+        super.print(c);
+    }
+
+    @Override
+    public void print(boolean b) {
+        activateDestination();
+        super.print(b);
+    }
+
+    @Override
+    public void write(String s) {
+        activateDestination();
+        super.write(s);
+    }
+
+    @Override
+    public void write(String s, int off, int len) {
+        activateDestination();
+        super.write(s, off, len);
+    }
+
+    @Override
+    public void write(char buf[]) {
+        activateDestination();
+        super.write(buf);
+    }
+
+    @Override
+    public void write(char buf[], int off, int len) {
+        activateDestination();
+        super.write(buf, off, len);
+    }
+
+    @Override
+    public void write(int c) {
+        activateDestination();
+        super.write(c);
+    }
+
+    @Override
+    public boolean checkError() {
+        activateDestination();
+        return super.checkError();
+    }
+
+    @Override
+    public void flush() {
+        if (!isBlockFlush() && isDestinationActivated()) {
+            super.flush();
+        }
+    }
+
+    @Override
+    public PrintWriter append(char c) {
+        activateDestination();
+        return super.append(c);
+    }
+
+    @Override
+    public PrintWriter append(CharSequence csq, int start, int end) {
+        activateDestination();
+        return super.append(csq, start, end);
+    }
+
+    @Override
+    public PrintWriter append(CharSequence csq) {
+        activateDestination();
+        return super.append(csq);
+    }
+
+    /**
+     * Just to keep super constructor for PrintWriter happy - it's never
+     * actually used.
+     */
+    private static class NullWriter extends Writer {
+        protected NullWriter() {
+            super();
+        }
+
+        @Override
+        public void write(char cbuf[], int off, int len) throws IOException {
+            throw new UnsupportedOperationException();
+        }
+
+        @Override
+        public void flush() throws IOException {
+            throw new UnsupportedOperationException();
+        }
+
+        @Override
+        public void close() throws IOException {
+            throw new UnsupportedOperationException();
+        }
+    }
+
+    public boolean isBlockFlush() {
+        return blockFlush;
+    }
+
+    public void setBlockFlush(boolean blockFlush) {
+        this.blockFlush = blockFlush;
+    }
+
+    public boolean isBlockClose() {
+        return blockClose;
+    }
+
+    public void setBlockClose(boolean blockClose) {
+        this.blockClose = blockClose;
+    }
+
+    public void unBlockFlushAndClose() {
+        this.blockClose = false;
+        this.blockFlush = false;
+    }
+
+    public void blockFlushAndClose() {
+        this.blockClose = true;
+        this.blockFlush = true;
+    }
+
+    @Override
+    public GrailsPrintWriter leftShift(Object value) throws IOException {
+        activateDestination();
+        return super.leftShift(value);
+    }
+
+    @Override
+    public GrailsPrintWriter leftShift(StreamCharBuffer otherBuffer) {
+        activateDestination();
+        return super.leftShift(otherBuffer);
+    }
+
+    @Override
+    public GrailsPrintWriter leftShift(Writable writable) {
+        activateDestination();
+        return super.leftShift(writable);
+    }
+
+    public boolean isDestinationActivated() {
+        return destinationActivated;
+    }
+
+    public void setDestinationActivated(boolean destinationActivated) {
+        this.destinationActivated = destinationActivated;
+        if (!this.destinationActivated) {
+            super.setTarget(new NullWriter());
+        }
+    }
+}
diff --git a/...in-controllers/src/main/groovy/grails/artefact/controller/support/ResponseRenderer.groovy b/...in-controllers/src/main/groovy/grails/artefact/controller/support/ResponseRenderer.groovy
@@ -37,7 +37,6 @@ 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
 import org.grails.web.sitemesh.GroovyPageLayoutFinder
 import org.grails.web.util.GrailsApplicationAttributes
@@ -306,7 +305,7 @@ trait ResponseRenderer extends WebAttributes {
                 }
 
 
-                boolean renderWithLayout = (explicitSiteMeshLayout || webRequest.getCurrentRequest().getAttribute(GrailsLayoutDecoratorMapper.LAYOUT_ATTRIBUTE))
+                boolean renderWithLayout = (explicitSiteMeshLayout || webRequest.getCurrentRequest().getAttribute(GroovyPageLayoutFinder.LAYOUT_ATTRIBUTE))
                 // if automatic decoration occurred unwrap, since this is a partial
                 if(view instanceof GrailsLayoutView) {
                     view = ((GrailsLayoutView)view).getInnerView()
@@ -551,13 +550,13 @@ trait ResponseRenderer extends WebAttributes {
     }
 
     private void applySiteMeshLayout(HttpServletRequest request, boolean renderView, String explicitSiteMeshLayout) {
-        if(explicitSiteMeshLayout == null && request.getAttribute(GrailsLayoutDecoratorMapper.LAYOUT_ATTRIBUTE) != null) {
+        if(explicitSiteMeshLayout == null && request.getAttribute(GroovyPageLayoutFinder.LAYOUT_ATTRIBUTE) != null) {
             // layout has been set already
             return
         }
-        String siteMeshLayout = explicitSiteMeshLayout != null ? explicitSiteMeshLayout : (renderView ? null : GrailsLayoutDecoratorMapper.NONE_LAYOUT)
+        String siteMeshLayout = explicitSiteMeshLayout != null ? explicitSiteMeshLayout : (renderView ? null : GroovyPageLayoutFinder.NONE_LAYOUT)
         if(siteMeshLayout != null) {
-            request.setAttribute GrailsLayoutDecoratorMapper.LAYOUT_ATTRIBUTE, siteMeshLayout
+            request.setAttribute GroovyPageLayoutFinder.LAYOUT_ATTRIBUTE, siteMeshLayout
         }
     }