HHH-17435 Allow input param as trim character and fix single quote

mbellade · beikov · commit 8daa7ced4931 · 2024-01-12T12:53:20.000+01:00
diff --git a/hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/AltibaseDialect.java b/hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/AltibaseDialect.java
@@ -138,23 +138,23 @@ public int getDefaultStatementBatchSize() {
 	}
 
 	@Override
-	public String trimPattern(TrimSpec specification, char character) {
+	public String trimPattern(TrimSpec specification, boolean isWhitespace) {
 		switch ( specification ) {
 			case BOTH:
-				return character == ' '
+				return isWhitespace
 						? "trim(?1)"
-						: "trim(?1, '" + character + "')";
+						: "trim(?1,?2)";
 			case LEADING:
-				return character == ' '
+				return isWhitespace
 						? "ltrim(?1)"
-						: "ltrim(?1,'" + character + "')";
+						: "ltrim(?1,?2)";
 			case TRAILING:
-				return character == ' '
+				return isWhitespace
 						? "rtrim(?1)"
-						: "rtrim(?1,'" + character + "')";
+						: "rtrim(?1,?2)";
 		}
 
-		return super.trimPattern( specification, character );
+		return super.trimPattern( specification, isWhitespace );
 	}
 
 	@Override
diff --git a/hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/DB2LegacyDialect.java b/hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/DB2LegacyDialect.java
@@ -33,6 +33,7 @@
 import org.hibernate.dialect.function.DB2FormatEmulation;
 import org.hibernate.dialect.function.DB2PositionFunction;
 import org.hibernate.dialect.function.DB2SubstringFunction;
+import org.hibernate.dialect.function.TrimFunction;
 import org.hibernate.dialect.identity.DB2IdentityColumnSupport;
 import org.hibernate.dialect.identity.IdentityColumnSupport;
 import org.hibernate.dialect.pagination.DB2LimitHandler;
@@ -398,6 +399,13 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 				.setArgumentListSignature("(STRING string, STRING pattern)")
 				.register();
 
+		//trim() requires trim characters to be constant literals
+		functionContributions.getFunctionRegistry().register( "trim", new TrimFunction(
+				this,
+				functionContributions.getTypeConfiguration(),
+				SqlAstNodeRenderingMode.INLINE_PARAMETERS
+		) );
+
 		functionFactory.windowFunctions();
 		if ( getDB2Version().isSameOrAfter( 9, 5 ) ) {
 			functionFactory.listagg( null );
diff --git a/hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/HSQLLegacyDialect.java b/hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/HSQLLegacyDialect.java
@@ -16,6 +16,7 @@
 import org.hibernate.boot.model.FunctionContributions;
 import org.hibernate.dialect.*;
 import org.hibernate.dialect.function.CommonFunctionFactory;
+import org.hibernate.dialect.function.TrimFunction;
 import org.hibernate.dialect.identity.HSQLIdentityColumnSupport;
 import org.hibernate.dialect.identity.IdentityColumnSupport;
 import org.hibernate.dialect.lock.LockingStrategy;
@@ -266,6 +267,13 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.arrayTrim_trim_array();
 		functionFactory.arrayFill_hsql();
 		functionFactory.arrayToString_hsql();
+
+		//trim() requires parameters to be cast when used as trim character
+		functionContributions.getFunctionRegistry().register( "trim", new TrimFunction(
+				this,
+				functionContributions.getTypeConfiguration(),
+				SqlAstNodeRenderingMode.NO_PLAIN_PARAMETER
+		) );
 	}
 
 	@Override
diff --git a/hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/MaxDBDialect.java b/hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/MaxDBDialect.java
@@ -203,8 +203,8 @@ protected <T extends JdbcOperation> SqlAstTranslator<T> buildTranslator(
 	}
 
 	@Override
-	public String trimPattern(TrimSpec specification, char character) {
-		return AbstractTransactSQLDialect.replaceLtrimRtrim( specification, character);
+	public String trimPattern(TrimSpec specification, boolean isWhitespace) {
+		return AbstractTransactSQLDialect.replaceLtrimRtrim( specification, isWhitespace );
 	}
 
 	@Override
diff --git a/hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/RDMSOS2200Dialect.java b/hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/RDMSOS2200Dialect.java
@@ -431,7 +431,7 @@ public void appendDatetimeFormat(SqlAppender appender, String format) {
 	}
 
 	@Override
-	public String trimPattern(TrimSpec specification, char character) {
-		return AbstractTransactSQLDialect.replaceLtrimRtrim( specification, character);
+	public String trimPattern(TrimSpec specification, boolean isWhitespace) {
+		return AbstractTransactSQLDialect.replaceLtrimRtrim( specification, isWhitespace );
 	}
 }
diff --git a/hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/SQLServerLegacyDialect.java b/hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/SQLServerLegacyDialect.java
@@ -385,25 +385,25 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 	}
 
 	@Override
-	public String trimPattern(TrimSpec specification, char character) {
+	public String trimPattern(TrimSpec specification, boolean isWhitespace) {
 		if ( getVersion().isSameOrAfter( 16 ) ) {
 			switch ( specification ) {
 				case BOTH:
-					return character == ' '
+					return isWhitespace
 							? "trim(?1)"
-							: "trim('" + character + "' from ?1)";
+							: "trim(?2 from ?1)";
 				case LEADING:
-					return character == ' '
+					return isWhitespace
 							? "ltrim(?1)"
-							: "ltrim(?1,'" + character + "')";
+							: "ltrim(?1,?2)";
 				case TRAILING:
-					return character == ' '
+					return isWhitespace
 							? "rtrim(?1)"
-							: "rtrim(?1,'" + character + "')";
+							: "rtrim(?1,?2)";
 			}
 			throw new UnsupportedOperationException( "Unsupported specification: " + specification );
 		}
-		return super.trimPattern( specification, character );
+		return super.trimPattern( specification, isWhitespace );
 	}
 
 	@Override
diff --git a/hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/SQLiteDialect.java b/hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/SQLiteDialect.java
@@ -353,20 +353,20 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 	}
 
 	@Override
-	public String trimPattern(TrimSpec specification, char character) {
+	public String trimPattern(TrimSpec specification, boolean isWhitespace) {
 		switch ( specification ) {
 			case BOTH:
-				return character == ' '
+				return isWhitespace
 						? "trim(?1)"
-						: "trim(?1,'" + character + "')";
+						: "trim(?1,?2)";
 			case LEADING:
-				return character == ' '
+				return isWhitespace
 						? "ltrim(?1)"
-						: "ltrim(?1,'" + character + "')";
+						: "ltrim(?1,?2)";
 			case TRAILING:
-				return character == ' '
+				return isWhitespace
 						? "rtrim(?1)"
-						: "rtrim(?1,'" + character + "')";
+						: "rtrim(?1,?2)";
 		}
 		throw new UnsupportedOperationException( "Unsupported specification: " + specification );
 	}
diff --git a/hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/SybaseLegacyDialect.java b/hibernate-community-dialects/src/main/java/org/hibernate/community/dialect/SybaseLegacyDialect.java
@@ -424,12 +424,6 @@ public String timestampdiffPattern(TemporalUnit unit, TemporalType fromTemporalT
 		return "datediff(?1,?2,?3)";
 	}
 
-	@Override
-	public String trimPattern(TrimSpec specification, char character) {
-		return super.trimPattern(specification, character)
-				.replace("replace", "str_replace");
-	}
-
 	@Override
 	public void appendDatetimeFormat(SqlAppender appender, String format) {
 		throw new UnsupportedOperationException( "format() function not supported on Sybase");
diff --git a/hibernate-core/src/main/antlr/org/hibernate/grammars/hql/HqlParser.g4 b/hibernate-core/src/main/antlr/org/hibernate/grammars/hql/HqlParser.g4
@@ -1357,6 +1357,7 @@ trimSpecification
 
 trimCharacter
 	: STRING_LITERAL
+	| parameter
 	;
 
 /**
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/AbstractTransactSQLDialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/AbstractTransactSQLDialect.java
@@ -166,28 +166,32 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 	}
 
 	@Override
-	public String trimPattern(TrimSpec specification, char character) {
-		return replaceLtrimRtrim(specification, character);
+	public String trimPattern(TrimSpec specification, boolean isWhitespace) {
+		return replaceLtrimRtrim( specification, isWhitespace );
 	}
 
+	/**
+	 * @deprecated Use {@link #replaceLtrimRtrim(TrimSpec, boolean)} instead.
+	 */
+	@Deprecated( forRemoval = true )
 	public static String replaceLtrimRtrim(TrimSpec specification, char character) {
-		boolean blank = character == ' ';
+		return replaceLtrimRtrim( specification, character == ' ' );
+	}
+
+	public static String replaceLtrimRtrim(TrimSpec specification, boolean isWhitespace) {
 		switch ( specification ) {
 			case LEADING:
-				return blank
+				return isWhitespace
 						? "ltrim(?1)"
-						: "replace(replace(ltrim(replace(replace(?1,' ','#%#%'),'@',' ')),' ','@'),'#%#%',' ')"
-								.replace('@', character);
+						: "substring(?1,patindex('%[^'+?2+']%',?1),len(?1)-patindex('%[^'+?2+']%',?1)+1)";
 			case TRAILING:
-				return blank
+				return isWhitespace
 						? "rtrim(?1)"
-						: "replace(replace(rtrim(replace(replace(?1,' ','#%#%'),'@',' ')),' ','@'),'#%#%',' ')"
-								.replace('@', character);
+						: "substring(?1,1,len(?1)-patindex('%[^'+?2+']%',reverse(?1))+1)";
 			default:
-				return blank
+				return isWhitespace
 						? "ltrim(rtrim(?1))"
-						: "replace(replace(ltrim(rtrim(replace(replace(?1,' ','#%#%'),'@',' '))),' ','@'),'#%#%',' ')"
-								.replace('@', character);
+						: "substring(?1,patindex('%[^'+?2+']%',?1),len(?1)-patindex('%[^'+?2+']%',?1)-patindex('%[^'+?2+']%',reverse(?1))+2)";
 		}
 	}
 
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/DB2Dialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/DB2Dialect.java
@@ -28,6 +28,7 @@
 import org.hibernate.dialect.function.DB2FormatEmulation;
 import org.hibernate.dialect.function.DB2PositionFunction;
 import org.hibernate.dialect.function.DB2SubstringFunction;
+import org.hibernate.dialect.function.TrimFunction;
 import org.hibernate.dialect.identity.DB2IdentityColumnSupport;
 import org.hibernate.dialect.identity.IdentityColumnSupport;
 import org.hibernate.dialect.pagination.DB2LimitHandler;
@@ -387,6 +388,13 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 				.setArgumentListSignature("(STRING string, STRING pattern)")
 				.register();
 
+		//trim() requires trim characters to be constant literals
+		functionContributions.getFunctionRegistry().register( "trim", new TrimFunction(
+				this,
+				functionContributions.getTypeConfiguration(),
+				SqlAstNodeRenderingMode.INLINE_PARAMETERS
+		) );
+
 		functionFactory.windowFunctions();
 		functionFactory.listagg( null );
 	}
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/Dialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/Dialect.java
@@ -1484,11 +1484,29 @@ public String castPattern(CastType from, CastType to) {
 	 *
 	 * @param specification {@code leading} or {@code trailing}
 	 * @param character the character to trim
+	 *
+	 * @deprecated Use {@link #trimPattern(TrimSpec, boolean)} instead.
 	 */
+	@Deprecated( forRemoval = true )
 	public String trimPattern(TrimSpec specification, char character) {
-		return character == ' '
-				? "trim(" + specification + " from ?1)"
-				: "trim(" + specification + " '" + character + "' from ?1)";
+		return trimPattern( specification, character == ' ' );
+	}
+
+	/**
+	 * Obtain a pattern for the SQL equivalent to a
+	 * {@code trim()} function call. The resulting
+	 * pattern must contain a ?1 placeholder for the
+	 * argument of type {@link String} and a ?2 placeholder
+	 * for the trim character if {@code isWhitespace}
+	 * was false.
+	 *
+	 * @param specification {@linkplain TrimSpec#LEADING leading}, {@linkplain TrimSpec#TRAILING trailing}
+	 * or {@linkplain TrimSpec#BOTH both}
+	 * @param isWhitespace {@code true} if the trim character is a whitespace and can be omitted,
+	 * {@code false} if it must be explicit and a ?2 placeholder should be included in the pattern
+	 */
+	public String trimPattern(TrimSpec specification, boolean isWhitespace) {
+		return "trim(" + specification + ( isWhitespace ? "" : " ?2" ) + " from ?1)";
 	}
 
 	/**
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/DialectDelegateWrapper.java b/hibernate-core/src/main/java/org/hibernate/dialect/DialectDelegateWrapper.java
@@ -290,6 +290,11 @@ public String trimPattern(TrimSpec specification, char character) {
 		return wrapped.trimPattern( specification, character );
 	}
 
+	@Override
+	public String trimPattern(TrimSpec specification, boolean isWhitespace) {
+		return wrapped.trimPattern( specification, isWhitespace );
+	}
+
 	@Override
 	public boolean supportsFractionalTimestampArithmetic() {
 		return wrapped.supportsFractionalTimestampArithmetic();
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/HSQLDialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/HSQLDialect.java
@@ -12,6 +12,7 @@
 
 import org.hibernate.boot.model.FunctionContributions;
 import org.hibernate.dialect.function.CommonFunctionFactory;
+import org.hibernate.dialect.function.TrimFunction;
 import org.hibernate.dialect.identity.HSQLIdentityColumnSupport;
 import org.hibernate.dialect.identity.IdentityColumnSupport;
 import org.hibernate.dialect.pagination.LimitHandler;
@@ -206,6 +207,13 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 		functionFactory.arrayTrim_trim_array();
 		functionFactory.arrayFill_hsql();
 		functionFactory.arrayToString_hsql();
+
+		//trim() requires parameters to be cast when used as trim character
+		functionContributions.getFunctionRegistry().register( "trim", new TrimFunction(
+				this,
+				functionContributions.getTypeConfiguration(),
+				SqlAstNodeRenderingMode.NO_PLAIN_PARAMETER
+		) );
 	}
 
 	@Override
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/SQLServerDialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/SQLServerDialect.java
@@ -396,25 +396,25 @@ public void initializeFunctionRegistry(FunctionContributions functionContributio
 	}
 
 	@Override
-	public String trimPattern(TrimSpec specification, char character) {
+	public String trimPattern(TrimSpec specification, boolean isWhitespace) {
 		if ( getVersion().isSameOrAfter( 16 ) ) {
 			switch ( specification ) {
 				case BOTH:
-					return character == ' '
+					return isWhitespace
 							? "trim(?1)"
-							: "trim('" + character + "' from ?1)";
+							: "trim(?2 from ?1)";
 				case LEADING:
-					return character == ' '
+					return isWhitespace
 							? "ltrim(?1)"
-							: "ltrim(?1,'" + character + "')";
+							: "ltrim(?1,?2)";
 				case TRAILING:
-					return character == ' '
+					return isWhitespace
 							? "rtrim(?1)"
-							: "rtrim(?1,'" + character + "')";
+							: "rtrim(?1,?2)";
 			}
 			throw new UnsupportedOperationException( "Unsupported specification: " + specification );
 		}
-		return super.trimPattern( specification, character );
+		return super.trimPattern( specification, isWhitespace );
 	}
 
 	@Override
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/SybaseDialect.java b/hibernate-core/src/main/java/org/hibernate/dialect/SybaseDialect.java
@@ -447,12 +447,6 @@ public String timestampdiffPattern(TemporalUnit unit, TemporalType fromTemporalT
 		return "datediff(?1,?2,?3)";
 	}
 
-	@Override
-	public String trimPattern(TrimSpec specification, char character) {
-		return super.trimPattern(specification, character)
-				.replace("replace", "str_replace");
-	}
-
 	@Override
 	public void appendDatetimeFormat(SqlAppender appender, String format) {
 		throw new UnsupportedOperationException( "format() function not supported on Sybase");
diff --git a/hibernate-core/src/main/java/org/hibernate/dialect/function/TrimFunction.java b/hibernate-core/src/main/java/org/hibernate/dialect/function/TrimFunction.java
diff --git a/hibernate-core/src/main/java/org/hibernate/query/hql/internal/SemanticQueryBuilder.java b/hibernate-core/src/main/java/org/hibernate/query/hql/internal/SemanticQueryBuilder.java
diff --git a/hibernate-core/src/test/java/org/hibernate/orm/test/dialect/function/AnsiTrimEmulationFunctionTest.java b/hibernate-core/src/test/java/org/hibernate/orm/test/dialect/function/AnsiTrimEmulationFunctionTest.java

Original file line number	Diff line number	Diff line change
`@@ -203,8 +203,8 @@ protected <T extends JdbcOperation> SqlAstTranslator<T> buildTranslator(`
`203`	`203`	`}`
`204`	`204`
`205`	`205`	`@Override`
`206`		`- public String trimPattern(TrimSpec specification, char character) {`
`207`		`- return AbstractTransactSQLDialect.replaceLtrimRtrim( specification, character);`
	`206`	`+ public String trimPattern(TrimSpec specification, boolean isWhitespace) {`
	`207`	`+ return AbstractTransactSQLDialect.replaceLtrimRtrim( specification, isWhitespace );`
`208`	`208`	`}`
`209`	`209`
`210`	`210`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -431,7 +431,7 @@ public void appendDatetimeFormat(SqlAppender appender, String format) {`
`431`	`431`	`}`
`432`	`432`
`433`	`433`	`@Override`
`434`		`- public String trimPattern(TrimSpec specification, char character) {`
`435`		`- return AbstractTransactSQLDialect.replaceLtrimRtrim( specification, character);`
	`434`	`+ public String trimPattern(TrimSpec specification, boolean isWhitespace) {`
	`435`	`+ return AbstractTransactSQLDialect.replaceLtrimRtrim( specification, isWhitespace );`
`436`	`436`	`}`
`437`	`437`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1357,6 +1357,7 @@ trimSpecification`
`1357`	`1357`
`1358`	`1358`	`trimCharacter`
`1359`	`1359`	`: STRING_LITERAL`
	`1360`	`+ \| parameter`
`1360`	`1361`	`;`
`1361`	`1362`
`1362`	`1363`	`/**`