Adjusted view engines to provide access to HttpServletRequest

Author: chkal

ext/freemarker/src/main/java/org/mvcspec/ozark/ext/freemarker/FreemarkerViewEngine.java

@@ -15,20 +15,23 @@
  */
 package org.mvcspec.ozark.ext.freemarker;
 
-import org.mvcspec.ozark.engine.ViewEngineBase;
-import org.mvcspec.ozark.engine.ViewEngineConfig;
 import freemarker.template.Configuration;
 import freemarker.template.Template;
 import freemarker.template.TemplateException;
+import org.mvcspec.ozark.engine.ViewEngineBase;
+import org.mvcspec.ozark.engine.ViewEngineConfig;
 
 import javax.enterprise.context.ApplicationScoped;
 import javax.inject.Inject;
 import javax.mvc.engine.ViewEngineContext;
 import javax.mvc.engine.ViewEngineException;
+import javax.servlet.http.HttpServletRequest;
 import java.io.IOException;
 import java.io.OutputStreamWriter;
 import java.io.Writer;
 import java.nio.charset.Charset;
+import java.util.HashMap;
+import java.util.Map;
 
 /**
  * Class FreemarkerViewEngine.
@@ -49,10 +52,18 @@ public boolean supports(String view) {
 
     @Override
     public void processView(ViewEngineContext context) throws ViewEngineException {
+
         Charset charset = resolveCharsetAndSetContentType(context);
+
         try (Writer writer = new OutputStreamWriter(context.getOutputStream(), charset)) {
-            final Template template = configuration.getTemplate(resolveView(context));
-            template.process(context.getModels(), writer);
+
+            Template template = configuration.getTemplate(resolveView(context));
+
+            Map<String, Object> model = new HashMap<>(context.getModels());
+            model.put("request", context.getRequest(HttpServletRequest.class));
+
+            template.process(model, writer);
+
         } catch (TemplateException | IOException e) {
             throw new ViewEngineException(e);
         }

ext/handlebars/src/main/java/org/mvcspec/ozark/ext/handlebars/HandlebarsViewEngine.java

@@ -22,17 +22,19 @@
 
 import javax.enterprise.context.ApplicationScoped;
 import javax.inject.Inject;
-import javax.mvc.Models;
 import javax.mvc.engine.ViewEngineContext;
 import javax.mvc.engine.ViewEngineException;
 import javax.servlet.ServletContext;
+import javax.servlet.http.HttpServletRequest;
 import java.io.BufferedReader;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.InputStreamReader;
 import java.io.OutputStreamWriter;
 import java.io.Writer;
 import java.nio.charset.Charset;
+import java.util.HashMap;
+import java.util.Map;
 import java.util.stream.Collectors;
 
 /**
@@ -57,18 +59,23 @@ public boolean supports(String view) {
 
     @Override
     public void processView(ViewEngineContext context) throws ViewEngineException {
-        Models models = context.getModels();
+
+        Map<String, Object> model = new HashMap<>(context.getModels());
+        model.put("request", context.getRequest(HttpServletRequest.class));
+        
         Charset charset = resolveCharsetAndSetContentType(context);
 
         try (Writer writer = new OutputStreamWriter(context.getOutputStream(), charset);
+             
             InputStream resourceAsStream = servletContext.getResourceAsStream(resolveView(context));
             InputStreamReader in = new InputStreamReader(resourceAsStream, "UTF-8");
             BufferedReader bufferedReader = new BufferedReader(in);) {
 
             String viewContent = bufferedReader.lines().collect(Collectors.joining());
 
             Template template = handlebars.compileInline(viewContent);
-            template.apply(models, writer);
+            template.apply(model, writer);
+            
         } catch (IOException e) {
             throw new ViewEngineException(e);
         }

ext/jade/src/main/java/org/mvcspec/ozark/ext/jade/JadeViewEngine.java

@@ -17,17 +17,21 @@
 
 import de.neuland.jade4j.JadeConfiguration;
 import de.neuland.jade4j.exceptions.JadeException;
+import de.neuland.jade4j.template.JadeTemplate;
 import org.mvcspec.ozark.engine.ViewEngineBase;
 import org.mvcspec.ozark.engine.ViewEngineConfig;
 
 import javax.enterprise.context.ApplicationScoped;
 import javax.inject.Inject;
 import javax.mvc.engine.ViewEngineContext;
 import javax.mvc.engine.ViewEngineException;
+import javax.servlet.http.HttpServletRequest;
 import java.io.IOException;
 import java.io.OutputStreamWriter;
 import java.io.Writer;
 import java.nio.charset.Charset;
+import java.util.HashMap;
+import java.util.Map;
 
 /**
  * The Jade View Engine.
@@ -50,10 +54,18 @@ public boolean supports(String view) {
 
     @Override
     public void processView(ViewEngineContext context) throws ViewEngineException {
-        String viewPath = resolveView(context);
+
         Charset charset = resolveCharsetAndSetContentType(context);
+
         try (Writer writer = new OutputStreamWriter(context.getOutputStream(), charset)) {
-            jade.renderTemplate(jade.getTemplate(viewPath), context.getModels(), writer);
+
+            JadeTemplate template = jade.getTemplate(resolveView(context));
+
+            Map<String, Object> model = new HashMap<>(context.getModels());
+            model.put("request", context.getRequest(HttpServletRequest.class));
+
+            jade.renderTemplate(template, model, writer);
+
         } catch (JadeException | IOException ex) {
             throw new ViewEngineException(String.format("Could not process view %s.", context.getView()), ex);
         }

ext/jetbrick/src/main/java/org/mvcspec/ozark/ext/jetbrick/JetbrickViewEngine.java

@@ -27,10 +27,13 @@
 import javax.mvc.engine.ViewEngineContext;
 import javax.mvc.engine.ViewEngineException;
 import javax.servlet.ServletContext;
+import javax.servlet.http.HttpServletRequest;
 import java.io.IOException;
 import java.io.OutputStreamWriter;
 import java.io.Writer;
 import java.nio.charset.Charset;
+import java.util.HashMap;
+import java.util.Map;
 
 /**
  * @author Daniel Dias
@@ -55,10 +58,18 @@ public boolean supports(String view) {
 
     @Override
     public void processView(ViewEngineContext context) throws ViewEngineException {
+
         Charset charset = resolveCharsetAndSetContentType(context);
+
         try (Writer writer = new OutputStreamWriter(context.getOutputStream(), charset)) {
+
             JetTemplate template = jetEngine.getTemplate(resolveView(context));
-            template.render(context.getModels(), writer);
+
+            Map<String, Object> model = new HashMap<>(context.getModels());
+            model.put("request", context.getRequest(HttpServletRequest.class));
+
+            template.render(model, writer);
+
         } catch (TemplateException | IOException e) {
             throw new ViewEngineException(e);
         }

ext/mustache/src/main/java/org/mvcspec/ozark/ext/mustache/MustacheViewEngine.java

@@ -24,10 +24,13 @@
 import javax.inject.Inject;
 import javax.mvc.engine.ViewEngineContext;
 import javax.mvc.engine.ViewEngineException;
+import javax.servlet.http.HttpServletRequest;
 import java.io.IOException;
 import java.io.OutputStreamWriter;
 import java.io.Writer;
 import java.nio.charset.Charset;
+import java.util.HashMap;
+import java.util.Map;
 
 /**
  * Class MustacheViewEngine.
@@ -48,10 +51,18 @@ public boolean supports(String view) {
 
     @Override
     public void processView(ViewEngineContext context) throws ViewEngineException {
-        Mustache mustache = factory.compile(resolveView(context));
+
         Charset charset = resolveCharsetAndSetContentType(context);
+
         try (Writer writer = new OutputStreamWriter(context.getOutputStream(), charset)) {
-            mustache.execute(writer, context.getModels()).flush();
+
+            Mustache mustache = factory.compile(resolveView(context));
+
+            Map<String, Object> model = new HashMap<>(context.getModels());
+            model.put("request", context.getRequest(HttpServletRequest.class));
+
+            mustache.execute(writer, model).flush();
+
         } catch (IOException e) {
             throw new ViewEngineException(e);
         }

ext/pebble/src/main/java/org/mvcspec/ozark/ext/pebble/PebbleViewEngine.java

@@ -17,6 +17,7 @@
 
 import com.mitchellbosecke.pebble.PebbleEngine;
 import com.mitchellbosecke.pebble.error.PebbleException;
+import com.mitchellbosecke.pebble.template.PebbleTemplate;
 import org.mvcspec.ozark.engine.ViewEngineBase;
 
 import javax.enterprise.context.ApplicationScoped;
@@ -26,7 +27,11 @@
 import java.io.OutputStreamWriter;
 import java.io.Writer;
 import java.nio.charset.Charset;
+import java.util.HashMap;
+import java.util.Map;
 import javax.inject.Inject;
+import javax.servlet.http.HttpServletRequest;
+
 import org.mvcspec.ozark.engine.ViewEngineConfig;
 
 /**
@@ -49,11 +54,18 @@ public boolean supports(String view) {
 
   @Override
   public void processView(ViewEngineContext context) throws ViewEngineException {
-    String viewPath = resolveView(context);
 
     Charset charset = resolveCharsetAndSetContentType(context);
+    
     try(Writer writer = new OutputStreamWriter(context.getOutputStream(), charset)) {
-      pebbleEngine.getTemplate(viewPath).evaluate(writer, context.getModels());
+
+      PebbleTemplate template = pebbleEngine.getTemplate(resolveView(context));
+      
+      Map<String, Object> model = new HashMap<>(context.getModels());
+      model.put("request", context.getRequest(HttpServletRequest.class));
+      
+      template.evaluate(writer, model);
+      
     } catch (PebbleException | IOException ex) {
       throw new ViewEngineException(String.format("Could not process view %s.", context.getView()), ex);
     }

ext/thymeleaf/src/main/java/org/mvcspec/ozark/ext/thymeleaf/ThymeleafViewEngine.java

@@ -28,6 +28,8 @@
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 import java.io.IOException;
+import java.util.HashMap;
+import java.util.Map;
 
 /**
  * Class Thymeleaf ViewEngine.
@@ -51,12 +53,19 @@ public boolean supports(String view) {
 
 	@Override
 	public void processView(ViewEngineContext context) throws ViewEngineException {
+		
 		try {
+			
 			HttpServletRequest request = context.getRequest(HttpServletRequest.class);
 			HttpServletResponse response = context.getResponse(HttpServletResponse.class);
 			WebContext ctx = new WebContext(request, response, servletContext, request.getLocale());
-			ctx.setVariables(context.getModels());
+
+			Map<String, Object> model = new HashMap<>(context.getModels());
+			model.put("request", request);
+			ctx.setVariables(model);
+			
 			engine.process(resolveView(context), ctx, response.getWriter());
+			
 		} catch (IOException e) {
 			throw new ViewEngineException(e);
 		}

ext/velocity/src/main/java/org/mvcspec/ozark/ext/velocity/VelocityViewEngine.java

@@ -25,10 +25,13 @@
 import javax.inject.Inject;
 import javax.mvc.engine.ViewEngineContext;
 import javax.mvc.engine.ViewEngineException;
+import javax.servlet.http.HttpServletRequest;
 import java.io.IOException;
 import java.io.OutputStreamWriter;
 import java.io.Writer;
 import java.nio.charset.Charset;
+import java.util.HashMap;
+import java.util.Map;
 
 /**
  * Class VelocityViewEngine.
@@ -49,11 +52,19 @@ public boolean supports(String view) {
 
     @Override
     public void processView(ViewEngineContext context) throws ViewEngineException {
+        
         Charset charset = resolveCharsetAndSetContentType(context);
+        
         try (Writer writer = new OutputStreamWriter(context.getOutputStream(), charset)) {
+            
             Template template = velocityEngine.getTemplate(resolveView(context));
-            VelocityContext velocityContext = new VelocityContext(context.getModels());
+
+            Map<String, Object> model = new HashMap<>(context.getModels());
+            model.put("request", context.getRequest(HttpServletRequest.class));
+            VelocityContext velocityContext = new VelocityContext(model);
+            
             template.merge(velocityContext, writer);
+            
         } catch (IOException e) {
             throw new ViewEngineException(e);
         }