Skip to content

Commit

Permalink
EL式、変数のときの不要な再帰評価を制限。
Browse files Browse the repository at this point in the history
  • Loading branch information
@mygreen
mygreen committed Aug 12, 2024
1 parent d4f6ac9 commit d3af59e
Show file tree
Hide file tree
Showing 2 changed files with 400 additions and 244 deletions.
139 changes: 127 additions & 12 deletions src/main/java/com/gh/mygreen/xlsmapper/localization/MessageInterpolator.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
* <br>ただし、メッセージ変数で指定されている変数が優先される。
* </p>
*
* @version 2.0
* @since 2.0
* @author T.TSUCHIE
*
*/
Expand All @@ -48,6 +48,21 @@ public MessageInterpolator() {

}

/**
* EL式のときは再帰的評価するかどうか。
*/
private boolean recursiveForEl = false;

/**
* リソースファイルのキーを除く変数のときは再帰的評価するかどうか。
*/
private boolean recursiveForVar = false;

/**
* 再帰処理の最大回数
*/
private int maxRecursiveDepth = 5;

/**
* 式言語の実装を指定するコンストラクタ
* @param expressionLanguage
Expand Down Expand Up @@ -77,7 +92,7 @@ public String interpolate(final String message, final Map<String, ?> vars) {
* @return 補完したメッセージ。
*/
public String interpolate(final String message, final Map<String, ?> vars, boolean recursive) {
return parse(message, vars, recursive, null);
return parse(message, vars, recursive, 0, null);
}

/**
Expand All @@ -92,17 +107,20 @@ public String interpolate(final String message, final Map<String, ?> vars, boole
*/
public String interpolate(final String message, final Map<String, ?> vars, boolean recursive,
final MessageResolver messageResolver) {
return parse(message, vars, recursive, messageResolver);
return parse(message, vars, recursive, 0, messageResolver);
}

/**
* メッセージをパースし、変数に値を差し込み、EL式を評価する。
* @param message 対象のメッセージ。
* @param vars メッセージ中の変数に対する値のマップ。
* @param recursive 変換したメッセージに対しても再帰的に処理するかどうか。
* @param currentRecursiveDepth 現在の再帰処理回数。
* @param messageResolver メッセージを解決するクラス。nullの場合、指定しないと同じ意味になります。
* @return 補完したメッセージ。
*/
protected String parse(final String message, final Map<String, ?> vars, boolean recursive, final MessageResolver messageResolver) {
protected String parse(final String message, final Map<String, ?> vars, boolean recursive, final int currentRecursiveDepth,
final MessageResolver messageResolver) {

// 評価したメッセージを格納するバッファ。
final StringBuilder sb = new StringBuilder(message.length());
Expand Down Expand Up @@ -160,7 +178,7 @@ protected String parse(final String message, final Map<String, ?> vars, boolean
// エスケープを解除する
expression = Utils.removeEscapeChar(expression, '\\');

String result = evaluate(expression, vars, recursive, messageResolver);
String result = evaluate(expression, vars, recursive, currentRecursiveDepth, messageResolver);
sb.append(result);

} else {
Expand Down Expand Up @@ -191,7 +209,7 @@ protected String parse(final String message, final Map<String, ?> vars, boolean
}

private String evaluate(final String expression, final Map<String, ?> values, final boolean recursive,
final MessageResolver messageResolver) {
final int currentRecursiveDepth, final MessageResolver messageResolver) {

if(expression.startsWith("{")) {
// 変数の置換の場合
Expand All @@ -201,8 +219,8 @@ private String evaluate(final String expression, final Map<String, ?> values, fi
// 該当するキーが存在する場合
final Object value = values.get(varName);
final String eval = (value == null) ? "" : value.toString();
if(!eval.isEmpty() && recursive) {
return parse(eval, values, recursive, messageResolver);
if(!eval.isEmpty() && recursivable(recursive && recursiveForVar, maxRecursiveDepth, currentRecursiveDepth, eval)) {
return parse(eval, values, recursive, currentRecursiveDepth + 1, messageResolver);
} else {
return eval;
}
Expand All @@ -215,8 +233,8 @@ private String evaluate(final String expression, final Map<String, ?> values, fi
return String.format("{%s}", varName);
}

if(recursive) {
return parse(eval.get(), values, recursive, messageResolver);
if(recursivable(recursive, maxRecursiveDepth, currentRecursiveDepth, eval.get())) {
return parse(eval.get(), values, recursive, currentRecursiveDepth + 1, messageResolver);
} else {
return eval.get();
}
Expand All @@ -230,8 +248,8 @@ private String evaluate(final String expression, final Map<String, ?> values, fi
// EL式で処理する
final String expr = expression.substring(2, expression.length()-1);
final String eval = evaluateExpression(expr, values);
if(recursive) {
return parse(eval, values, recursive, messageResolver);
if(recursivable(recursive && recursiveForEl, maxRecursiveDepth, currentRecursiveDepth, eval)) {
return parse(eval, values, recursive, currentRecursiveDepth + 1, messageResolver);
} else {
return eval;
}
Expand All @@ -242,6 +260,37 @@ private String evaluate(final String expression, final Map<String, ?> values, fi

}

/**
* 現在の再帰回数が最大回数に達しているかどうか。
*
* @param recursive 再帰的に処理するかどうか。
* @param maxRecursion 最大再帰回数
* @param currentDepth 再帰回数
* @param expression 再帰対象のメッセージ
* @return 最大再帰回数を超えていなければfalseを返す。
*/
private boolean recursivable(final boolean recursive, final int maxRecursion, final int currentDepth,
String message) {

if(!recursive) {
return false;
}

if(maxRecursion <= 0) {
// 再帰回数の制限なし。
return true;
}

if(currentDepth <= maxRecursion) {
return true;
}

logger.warn("Over recursive depth : currentDepth={}, maxDepth={}, message={}.", currentDepth, maxRecursion, message);

return false;

}

/**
* EL式を評価する。
* @param expression EL式
Expand Down Expand Up @@ -286,4 +335,70 @@ public void setExpressionLanguage(ExpressionLanguage expressionLanguage) {
this.expressionLanguage = expressionLanguage;
}

/**
* EL式の場合は再帰的評価するか判定する。
*
* @since 2.3
* @return {@literal true}のとき再帰的評価する。
*/
public boolean isRecursiveForEl() {
return recursiveForEl;
}

/**
* EL式の場合は再帰的評価するかどうか設定する。
* <p>入力値などの任意の値がEL式(<code>${...}</code>)の形式の場合、
* 不要に再帰的に評価されてELインジェクションが発生してしまうのを防ぐために設定します。
* <p>デフォルト値は、{@literal false} で再帰的に評価しない。
*
* @since 2.3
* @param recursiveForEl {@literal true} のとき再帰的評価する。
*/
public void setRecursiveForEl(boolean recursiveForEl) {
this.recursiveForEl = recursiveForEl;
}

/**
* リソースファイルのキーを除く変数を再帰的に評価するかどうか判定する。
*
* @since 2.3
* @return {@literal true}のとき再帰的に評価する。
*/
public boolean isRecursiveForVar() {
return recursiveForVar;
}

/**
* リソースファイルのキーを除く変数を再帰的評価するかどうか設定する。
* <p>入力値などの任意の値が変数(<code>{...}</code>)の形式の場合、
* 不要に再帰的に評価されてELインジェクションが発生してしまうのを防ぐために設定します。
* <p>デフォルト値は、{@literal false} で再帰的に評価しない。
*
* @since 2.3
* @param recursiveForVar {@literal true} のとき再帰的評価する。
*/
public void setRecursiveForVar(boolean recursiveForVar) {
this.recursiveForVar = recursiveForVar;
}

/**
* 評価した変数やEL式を再帰的に処するときの最大回数を取得します。
*
* @since 2.3
* @return 再帰的に処するときの最大回数。
*/
public int getMaxRecursiveDepth() {
return maxRecursiveDepth;
}

/**
* 評価した変数やEL式を再帰的に処するときの最大回数を設定します。
*
* @since 2.3
* @param maxRecursiveDepth 再帰的に処するときの最大回数。{@literal -1} のとき制限はありません。
*/
public void setMaxRecursiveDepth(int maxRecursiveDepth) {
this.maxRecursiveDepth = maxRecursiveDepth;
}

}
Loading

0 comments on commit d3af59e

Please sign in to comment.