fr.sii.ogham.template.thymeleaf.configure.DefaultThymeleafEmailConfigurer Maven / Gradle / Ivy

Go to download
package fr.sii.ogham.template.thymeleaf.configure;

import static fr.sii.ogham.template.thymeleaf.ThymeleafConstants.DEFAULT_THYMELEAF_EMAIL_CONFIGURER_PRIORITY;

import fr.sii.ogham.core.builder.MessagingBuilder;
import fr.sii.ogham.core.builder.configurer.ConfigurerFor;
import fr.sii.ogham.core.builder.configurer.DefaultMessagingConfigurer;
import fr.sii.ogham.core.builder.configurer.MessagingConfigurer;
import fr.sii.ogham.core.builder.configurer.MessagingConfigurerAdapter;
import fr.sii.ogham.core.builder.env.EnvironmentBuilder;
import fr.sii.ogham.core.builder.resolution.ResourceResolutionBuilder;
import fr.sii.ogham.core.message.content.EmailVariant;
import fr.sii.ogham.core.util.ClasspathUtils;
import fr.sii.ogham.template.thymeleaf.ThymeleafTemplateDetector;
import fr.sii.ogham.template.thymeleaf.buider.ThymeleafEmailBuilder;
import fr.sii.ogham.template.thymeleaf.buider.ThymeleafSmsBuilder;

/**
 * Default configurer for Thymeleaf template engine that is automatically
 * applied every time a {@link MessagingBuilder} instance is created through
 * {@link MessagingBuilder#standard()} or {@link MessagingBuilder#minimal()}.
 * 
 * 
 * The configurer has a priority of 90000 in order to be applied after global
 * configurer but before any sender implementation.
 * 
 * 
 * This configurer is applied only if {@code org.thymeleaf.TemplateEngine} is
 * present in the classpath. If not present, template engine is not registered
 * at all.
 * 
 * 
 * This configurer inherits environment configuration (see
 * {@link EnvironmentBuilder},
 * {@link ThymeleafEmailBuilder#environment(EnvironmentBuilder)} and
 * {@link ThymeleafSmsBuilder#environment(EnvironmentBuilder)}).
 * 
 * 
 * It also copies resource resolution configuration of
 * {@link DefaultMessagingConfigurer} to inherit resource resolution lookups
 * (see {@link ResourceResolutionBuilder}).
 * 
 * 
 * 
 * This configurer applies the following configuration:
 * 

 * Configures template prefix/suffix paths:
 * 
 * Uses the first property that has a value for classpath resolution prefix:
 * 
 * "ogham.email.thymeleaf.classpath.path-prefix"
 * "ogham.email.template.classpath.path-prefix"
 * "ogham.email.thymeleaf.path-prefix"
 * "ogham.email.template.path-prefix"
 * "ogham.template.path-prefix"
 * 
 * 
 * Uses the first property that has a value for classpath resolution suffix:
 * 
 * "ogham.email.thymeleaf.classpath.path-suffix"
 * "ogham.email.template.classpath.path-suffix"
 * "ogham.email.thymeleaf.path-suffix"
 * "ogham.email.template.path-suffix"
 * "ogham.template.path-suffix"
 * 
 * 
 * Uses the first property that has a value for file resolution prefix:
 * 
 * "ogham.email.thymeleaf.file.path-prefix"
 * "ogham.email.template.file.path-prefix"
 * "ogham.email.thymeleaf.path-prefix"
 * "ogham.email.template.path-prefix"
 * "ogham.template.path-prefix"
 * 
 * 
 * Uses the first property that has a value for file resolution suffix:
 * 
 * "ogham.email.thymeleaf.file.path-suffix"
 * "ogham.email.template.file.path-suffix"
 * "ogham.email.thymeleaf.path-suffix"
 * "ogham.email.template.path-suffix"
 * "ogham.template.path-suffix"
 * 
 * 
 * 
 * 
 * Configures email alternative content:
 * 
 * Automatically loads HTML template if extension is .html
 * Automatically loads text template if extension is .txt
 * 
 * 
 * Configures template detection:
 * 
 * Uses {@link ThymeleafTemplateDetector} to detect if templates are
 * parseable by Thymeleaf
 * 
 * 
 * 
 * 
 * @author Aurélien Baudet
 *
 */
@ConfigurerFor(targetedBuilder = { "minimal", "standard" }, priority = DEFAULT_THYMELEAF_EMAIL_CONFIGURER_PRIORITY)
public class DefaultThymeleafEmailConfigurer implements MessagingConfigurer {
	private final MessagingConfigurerAdapter delegate;

	public DefaultThymeleafEmailConfigurer() {
		this(new DefaultMessagingConfigurer());
	}

	public DefaultThymeleafEmailConfigurer(MessagingConfigurerAdapter delegate) {
		super();
		this.delegate = delegate;
	}

	@Override
	public void configure(MessagingBuilder msgBuilder) {
		if (canUseThymeleaf()) {
			ThymeleafEmailBuilder builder = msgBuilder.email().template(ThymeleafEmailBuilder.class);
			// use same environment as parent builder
			builder.environment(msgBuilder.environment());
			// apply default resource resolution configuration
			if (delegate != null) {
				delegate.configure(builder);
			}
			// @formatter:off
			builder
				.classpath()
					.pathPrefix("${ogham.email.thymeleaf.classpath.path-prefix}", 
								"${ogham.email.template.classpath.path-prefix}", 
								"${ogham.email.thymeleaf.path-prefix}", 
								"${ogham.email.template.path-prefix}", 
								"${ogham.template.path-prefix}")
					.pathSuffix("${ogham.email.thymeleaf.classpath.path-suffix}", 
								"${ogham.email.template.classpath.path-suffix}", 
								"${ogham.email.thymeleaf.path-suffix}", 
								"${ogham.email.template.path-suffix}", 
								"${ogham.template.path-suffix}")
					.and()
				.file()
					.pathPrefix("${ogham.email.thymeleaf.file.path-prefix}", 
								"${ogham.email.template.file.path-prefix}", 
								"${ogham.email.thymeleaf.path-prefix}", 
								"${ogham.email.template.path-prefix}", 
								"${ogham.template.path-prefix}")
					.pathSuffix("${ogham.email.thymeleaf.file.path-suffix}", 
								"${ogham.email.template.file.path-suffix}", 
								"${ogham.email.thymeleaf.path-suffix}", 
								"${ogham.email.template.path-suffix}", 
								"${ogham.template.path-suffix}")
					.and()
				.string()
					.and()
				.variant(EmailVariant.HTML, "html")
				.variant(EmailVariant.TEXT, "txt");
			// @formatter:on
		}
	}

	private boolean canUseThymeleaf() {
		return ClasspathUtils.exists("org.thymeleaf.TemplateEngine");
	}

}