io.higgs.http.server.transformers.ThymeleafTransformer Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of http-s3 Show documentation
Show all versions of http-s3 Show documentation
Higgs HTTP S3 (Single Site Server)
package io.higgs.http.server.transformers;
import io.higgs.core.reflect.ReflectionUtil;
import io.higgs.http.server.HttpRequest;
import io.higgs.http.server.HttpResponse;
import io.higgs.http.server.HttpStatus;
import io.higgs.http.server.config.TemplateConfig;
import io.higgs.http.server.protocol.HttpMethod;
import io.higgs.http.server.resource.MediaType;
import io.higgs.http.server.transformers.thymeleaf.Thymeleaf;
import io.higgs.http.server.transformers.thymeleaf.WebContext;
import io.netty.channel.ChannelHandlerContext;
import io.netty.handler.codec.http.HttpHeaders;
import io.netty.handler.codec.http.HttpResponseStatus;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.thymeleaf.TemplateEngine;
import java.lang.reflect.Field;
import java.nio.charset.Charset;
import java.util.Collection;
import java.util.HashSet;
import java.util.Locale;
import java.util.Map;
import java.util.Set;
/**
* See {@link io.higgs.http.server.resource.template#value()} for a list of types that will be injected by default
*
* @author Courtney Robinson
*/
public class ThymeleafTransformer extends BaseTransformer {
protected TemplateConfig config;
protected Thymeleaf tl;
private Logger log = LoggerFactory.getLogger(getClass());
public ThymeleafTransformer(TemplateConfig config, boolean ignoreConfigPrefixAndSuffix) {
this.config = config;
tl = new Thymeleaf(this.config, ignoreConfigPrefixAndSuffix);
}
public ThymeleafTransformer(TemplateConfig template_config) {
this(template_config, false);
}
@Override
public boolean canTransform(Object response, HttpRequest request, MediaType mediaType,
HttpMethod method, ChannelHandlerContext ctx) {
//first and foremost an endpoint must have a template annotation to even be considered
if (!method.hasTemplate()) {
return false;
}
if (request.getMediaTypes().isEmpty()) {
return true; //assume */*
}
for (MediaType type : request.getMediaTypes()) {
if (type.isCompatible(MediaType.WILDCARD_TYPE) ||
type.isCompatible(MediaType.TEXT_HTML_TYPE) ||
type.isCompatible(MediaType.APPLICATION_FORM_URLENCODED_TYPE) ||
type.isCompatible(MediaType.APPLICATION_XHTML_XML_TYPE)) {
return true;
}
}
return false;
}
@Override
public void transform(Object response, HttpRequest request, HttpResponse httpResponse, MediaType mediaType,
HttpMethod method,
ChannelHandlerContext ctx) {
WebContext webContext = new WebContext();
String[] fragements = method.getFragments();
String template = method.getTemplate();
if (fragements.length > 0) {
template = tl.getFullTemplate(template, fragements);
}
transform(webContext, template, response, request, httpResponse, mediaType, method, ctx, null);
}
@Override
public ThymeleafTransformer instance() {
return new ThymeleafTransformer(config, false);
}
public void transform(WebContext webContext, String templateName, Object response, HttpRequest request,
HttpResponse res, MediaType mediaType, HttpMethod method,
ChannelHandlerContext ctx, HttpResponseStatus status) {
byte[] data = null;
try {
if (request != null) {
if (config.determine_language_from_accept_header) {
try {
webContext.setLocale(Locale.forLanguageTag(
request.headers().get(HttpHeaders.Names.ACCEPT_LANGUAGE)));
} catch (Throwable t) {
log.warn("Unable to set locale from accept header");
}
}
populateContext(webContext, response, request, method);
}
String content = tl.getTemplateEngine().process(templateName, webContext);
data = content.getBytes(Charset.forName(config.character_encoding));
} catch (Throwable e) {
log.warn("Unable to transform response to HTML using Thymeleaf transformer", e);
//todo use template to generate 500
res.setStatus(HttpStatus.INTERNAL_SERVER_ERROR);
}
if (data != null) {
res.setStatus(status == null ? HttpStatus.OK : status);
res.content().writeBytes(data);
HttpHeaders.setContentLength(res, data.length);
}
}
private void populateContext(final WebContext ctx, Object response, HttpRequest request, HttpMethod method) {
//set defaults first so that users can override
//${_query} ,${_form},${_files},${_session},${_cookies},${_request},${_response},${_server}
ctx.setVariable("_query", request.getQueryParams());
ctx.setVariable("_form", request.getFormParam());
ctx.setVariable("_files", request.getFormFiles());
ctx.setVariable("_session", request.getSession());
ctx.setVariable("_cookies", request.getCookies());
ctx.setVariable("_request", request);
ctx.setVariable("_response", response);
if (method != null) {
ctx.setVariable("_validation", method.getValidationResult());
}
//ctx.setVariable("_server", server);
//response already available under ${_response} so only include if is POJO or Map, then we can
//do a field to value setup
if (response instanceof Map || //only Map is allowed from the set of Collections
(response != null && !ReflectionUtil.isNumeric(response.getClass()) && !(response instanceof
Collection))) {
if (response instanceof Map && config.convert_map_responses_to_key_value_pairs) {
ctx.setVariables((Map) response);
} else {
//it must be a POJO otherwise (since its not a primitive or a Map,List or Set...)
if (config.convert_pojo_responses_to_key_value_pairs) {
//get fields going a max of 10 parent classes up in the chain
Set fields = ReflectionUtil.getAllFields(new HashSet(), response.getClass(), 10);
for (Field field : fields) {
try {
field.setAccessible(true);
ctx.setVariable(field.getName(), field.get(response));
} catch (IllegalAccessException e) {
log.warn(String.format("Unable to set template variable %s", field.getName()), e);
}
}
}
}
}
}
public TemplateConfig getConfig() {
return config;
}
/**
* Get the Thymeleaf template engine which can be used configured further.
*
* @return
*/
public TemplateEngine getTemplateEngine() {
return tl.getTemplateEngine();
}
@Override
public int priority() {
return 1;
}
}