Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
org.dbflute.mail.send.embedded.proofreader.SMailPmCommentProofreader Maven / Gradle / Ivy
/*
* Copyright 2015-2024 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.dbflute.mail.send.embedded.proofreader;
import java.time.format.DateTimeFormatter;
import java.time.temporal.TemporalAccessor;
import java.util.List;
import java.util.Map;
import org.dbflute.mail.send.SMailTextProofreader;
import org.dbflute.twowaysql.SqlAnalyzer;
import org.dbflute.twowaysql.context.CommandContext;
import org.dbflute.twowaysql.context.CommandContextCreator;
import org.dbflute.twowaysql.factory.NodeAdviceFactory;
import org.dbflute.twowaysql.node.BoundValue;
import org.dbflute.twowaysql.node.EmbeddedVariableNode;
import org.dbflute.twowaysql.node.Node;
import org.dbflute.twowaysql.pmbean.SimpleMapPmb;
import org.dbflute.util.Srl;
import org.dbflute.util.Srl.ScopeInfo;
/**
* @author jflute
* @since 0.4.0 (2015/05/05 Tuesday at nakameguro)
*/
public class SMailPmCommentProofreader implements SMailTextProofreader {
// ===================================================================================
// Definition
// ==========
protected static final String IF_PREFIX = "/*IF ";
protected static final String FOR_PREFIX = "/*FOR ";
protected static final String END_COMMENT = "/*END*/";
protected static final String CLOSE_MARK = "*/";
protected static final String LF = "\n";
protected static final String CRLF = "\r\n";
// ===================================================================================
// Proofread
// =========
@Override
public String proofread(String templateText, Map variableMap) {
final SimpleMapPmb pmb = new SimpleMapPmb();
variableMap.forEach((key, value) -> pmb.addParameter(key, value));
return evaluate(templateText, pmb);
}
// ===================================================================================
// Evaluate
// ========
// very similar to simple template manager of LastaFlute but no recycle to be independent
protected String evaluate(String templateText, Object pmb) {
final Node node = analyze(filterTemplateText(templateText, pmb));
final CommandContext ctx = prepareContext(pmb);
node.accept(ctx);
return ctx.getSql();
}
// ===================================================================================
// Line Adjustment
// ===============
protected String filterTemplateText(String templateText, Object pmb) {
// #for_now jflute pending, IF in FOR comment becomes empty line when false (2019/02/21)
// basically it may be unneeded because it should be structured in Java
// and modification is very difficult so pending, waiting for next request
final String replaced = Srl.replace(templateText, CRLF, LF);
final List lineList = Srl.splitList(replaced, LF);
final StringBuilder sb = new StringBuilder(templateText.length());
boolean nextNoLine = false;
int lineNumber = 0;
for (String line : lineList) {
++lineNumber;
if (nextNoLine) {
sb.append(line);
nextNoLine = false;
continue;
}
if (isIfEndCommentLine(line) || isForEndCommentLine(line)) {
appendLfLine(sb, lineNumber, Srl.substringLastFront(line, END_COMMENT));
sb.append(LF).append(END_COMMENT);
nextNoLine = true;
continue;
}
final String realLine;
if (isOnlyIfCommentLine(line) || isOnlyForCommentLine(line) || isOnlyEndCommentLine(line)) {
nextNoLine = true;
realLine = Srl.ltrim(line);
} else {
realLine = line;
}
appendLfLine(sb, lineNumber, realLine);
}
return sb.toString();
}
protected boolean isOnlyIfCommentLine(String line) {
final String trimmed = line.trim();
return trimmed.startsWith(IF_PREFIX) && trimmed.endsWith(CLOSE_MARK) && Srl.count(line, CLOSE_MARK) == 1;
}
protected boolean isOnlyForCommentLine(String line) {
final String trimmed = line.trim();
return trimmed.startsWith(FOR_PREFIX) && trimmed.endsWith(CLOSE_MARK) && Srl.count(line, CLOSE_MARK) == 1;
}
protected boolean isOnlyEndCommentLine(String line) {
return line.trim().equals(END_COMMENT);
}
protected boolean isIfEndCommentLine(String line) {
return line.startsWith(IF_PREFIX) && line.endsWith(END_COMMENT) && Srl.count(line, CLOSE_MARK) > 1;
}
protected boolean isForEndCommentLine(String line) {
return line.startsWith(FOR_PREFIX) && line.endsWith(END_COMMENT) && Srl.count(line, CLOSE_MARK) > 1;
}
protected void appendLfLine(final StringBuilder sb, int lineNumber, String line) {
sb.append(lineNumber > 1 ? LF : "").append(line);
}
// ===================================================================================
// Analyze Template
// ================
protected Node analyze(String templateText) {
return createMailikeSqlAnalyzer(templateText).analyze();
}
protected SqlAnalyzer createMailikeSqlAnalyzer(String templateText) {
final SqlAnalyzer analyzer = new SqlAnalyzer(templateText, true) {
@Override
protected String filterAtFirst(String sql) {
return sql; // keep body
}
@Override
protected EmbeddedVariableNode newEmbeddedVariableNode(String expr, String testValue, String specifiedSql,
boolean blockNullParameter, NodeAdviceFactory adviceFactory, boolean replaceOnly, boolean terminalDot,
boolean overlookNativeBinding) {
return createMailikeEmbeddedVariableNode(expr, testValue, specifiedSql, blockNullParameter, adviceFactory, replaceOnly,
terminalDot, overlookNativeBinding);
}
}.overlookNativeBinding().switchBindingToReplaceOnlyEmbedded(); // adjust for plain template
return analyzer;
}
protected EmbeddedVariableNode createMailikeEmbeddedVariableNode(String expr, String testValue, String specifiedSql,
boolean blockNullParameter, NodeAdviceFactory adviceFactory, boolean replaceOnly, boolean terminalDot,
boolean overlookNativeBinding) {
return new EmbeddedVariableNode(expr, testValue, specifiedSql, blockNullParameter, adviceFactory, replaceOnly, terminalDot,
overlookNativeBinding) {
@Override
protected void setupBoundValue(BoundValue boundValue) {
super.setupBoundValue(boundValue);
setupOrElseValueIfNeeds(boundValue, _optionDef);
setupFormatAsValueIfNeeds(boundValue, _optionDef);
}
@Override
protected boolean processDynamicBinding(CommandContext ctx, Object firstValue, Class firstType, String embeddedString) {
return isDynamicBindingEnabled(); // to avoid unexpected error by '/*xxx*/' in parameter
}
};
}
protected boolean isDynamicBindingEnabled() {
return false; // fixedly invalid as default, unneeded in mailflute
}
// -----------------------------------------------------
// orElse()
// --------
protected void setupOrElseValueIfNeeds(BoundValue boundValue, String optionDef) {
if (Srl.is_Null_or_TrimmedEmpty(optionDef)) {
return;
}
final Object targetValue = boundValue.getTargetValue();
if (targetValue != null) {
return;
}
final List optionList = Srl.splitListTrimmed(optionDef, "|");
final String orElseBegin = "orElse(";
final String orElseEnd = ")";
optionList.stream().filter(op -> {
return op.startsWith(orElseBegin) && op.endsWith(orElseEnd);
}).findFirst().ifPresent(op -> { // e.g. /*pmb.sea:orElse('land')*/
final ScopeInfo scope = Srl.extractScopeWide(op, orElseBegin, orElseEnd);
final String content = scope.getContent().trim();
if (!Srl.isQuotedSingle(content)) { // string only supported, is enough here
throwMailOrElseValueNotQuotedException(optionDef);
}
boundValue.setTargetValue(Srl.unquoteSingle(content));
});
}
protected void throwMailOrElseValueNotQuotedException(String optionDef) {
String msg = "The orElse() value for mail should be single-quoted e.g. orElse('sea') but: " + optionDef;
throw new IllegalStateException(msg);
}
// -----------------------------------------------------
// formatAs()
// ----------
protected void setupFormatAsValueIfNeeds(BoundValue boundValue, String optionDef) {
if (Srl.is_Null_or_TrimmedEmpty(optionDef)) {
return;
}
final Object targetValue = boundValue.getTargetValue();
if (targetValue == null) {
return;
}
if (targetValue instanceof TemporalAccessor) { // e.g. LocalDate, LocalDateTime
final TemporalAccessor temporal = (TemporalAccessor) targetValue;
final List optionList = Srl.splitListTrimmed(optionDef, "|");
final String formatAsBegin = "formatAs(";
final String formatAsEnd = ")";
optionList.stream().filter(op -> {
return op.startsWith(formatAsBegin) && op.endsWith(formatAsEnd);
}).findFirst().ifPresent(op -> { // e.g. /*pmb.sea:formatAs('yyyy/MM/dd')*/
final ScopeInfo scope = Srl.extractScopeWide(op, formatAsBegin, formatAsEnd);
final String content = scope.getContent().trim();
if (!Srl.isQuotedSingle(content)) {
throwMailFormatAsValueNotQuotedException(optionDef);
}
final String datePattern = Srl.unquoteSingle(content);
final DateTimeFormatter formatter = DateTimeFormatter.ofPattern(datePattern);
boundValue.setTargetValue(formatter.format(temporal));
});
}
}
protected void throwMailFormatAsValueNotQuotedException(String optionDef) {
String msg = "The formatAs() value for mail should be single-quoted e.g. formatAs('sea') but: " + optionDef;
throw new IllegalStateException(msg);
}
// ===================================================================================
// Command Context
// ===============
protected CommandContext prepareContext(Object pmb) {
final Object filteredPmb = filterPmb(pmb);
final String[] argNames = new String[] { "pmb" };
final Class[] argTypes = new Class[] { filteredPmb.getClass() };
final CommandContextCreator creator = newCommandContextCreator(argNames, argTypes);
return creator.createCommandContext(new Object[] { filteredPmb });
}
protected static CommandContextCreator newCommandContextCreator(String[] argNames, Class[] argTypes) {
return new CommandContextCreator(argNames, argTypes);
}
protected Object filterPmb(Object pmb) {
if (pmb instanceof Map) {
@SuppressWarnings("unchecked")
final Map variableMap = ((Map) pmb);
final SimpleMapPmb mapPmb = new SimpleMapPmb();
variableMap.forEach((key, value) -> mapPmb.addParameter(key, value));
return mapPmb;
} else {
return pmb;
}
}
// ===================================================================================
// Dispose
// =======
@Override
public void workingDispose() {
}
// ===================================================================================
// Basic Override
// ==============
@Override
public String toString() {
return "proofreader:{pmcomment}";
}
}
