Skip to content

various minor refactorings to AST conversion code #10446

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 1, 2025
Merged

various minor refactorings to AST conversion code #10446

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 38 additions & 53 deletions hibernate-core/src/main/java/org/hibernate/query/hql/internal/SqmTreeCreationHelper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,9 @@
import java.util.Locale;
import java.util.Set;

import org.hibernate.AssertionFailure;
import org.hibernate.grammars.hql.HqlParser;
import org.hibernate.jpa.spi.JpaCompliance;
import org.hibernate.query.hql.spi.SqmCreationProcessingState;
import org.hibernate.query.hql.spi.SqmPathRegistry;
import org.hibernate.query.sqm.SqmTreeCreationLogger;
import org.hibernate.query.sqm.StrictJpaComplianceViolation;
import org.hibernate.query.sqm.tree.SqmJoinType;
Expand Down Expand Up @@ -136,8 +135,7 @@ public static <E> void handleRootAsCrossJoin(
HqlParser.EntityWithJoinsContext entityWithJoinsContext,
SqmRoot<E> sqmPrimaryRoot,
SemanticQueryBuilder<?> sqmBuilder) {
final HqlParser.RootEntityContext fromRootContext =
(HqlParser.RootEntityContext) entityWithJoinsContext.fromRoot();
final var fromRootContext = (HqlParser.RootEntityContext) entityWithJoinsContext.fromRoot();

//noinspection unchecked
final SqmRoot<E> sqmRoot = (SqmRoot<E>) fromRootContext.accept( sqmBuilder );
Expand All @@ -150,9 +148,8 @@ public static <E> void handleRootAsCrossJoin(
);
sqmPrimaryRoot.addSqmJoin( pseudoCrossJoin );

final SqmCreationProcessingState processingState = sqmBuilder.getProcessingStateStack().getCurrent();
final SqmPathRegistry pathRegistry = processingState.getPathRegistry();
pathRegistry.replace( pseudoCrossJoin, sqmRoot );
sqmBuilder.getProcessingStateStack().getCurrent().getPathRegistry()
.replace( pseudoCrossJoin, sqmRoot );

final int size = entityWithJoinsContext.getChildCount();
for ( int i = 1; i < size; i++ ) {
Expand Down Expand Up @@ -196,61 +193,49 @@ public static String extractVariable(HqlParser.VariableContext ctx, SemanticQuer
if ( ctx == null ) {
return null;
}

final ParseTree lastChild = ctx.getChild( ctx.getChildCount() - 1 );
if ( lastChild instanceof HqlParser.IdentifierContext identifierContext ) {
// in this branch, the alias could be a reserved word ("keyword as identifier")
// which JPA disallows...
if ( sqmBuilder.getCreationOptions().useStrictJpaCompliance() ) {
final Token identificationVariableToken = identifierContext.getStart();
if ( RESERVED_WORDS.contains( identificationVariableToken.getText().toLowerCase( Locale.ENGLISH ) ) ) {
throw new StrictJpaComplianceViolation(
String.format(
Locale.ROOT,
"Strict JPQL compliance was violated : %s [%s]",
StrictJpaComplianceViolation.Type.RESERVED_WORD_USED_AS_ALIAS.description(),
identificationVariableToken.getText()
),
StrictJpaComplianceViolation.Type.RESERVED_WORD_USED_AS_ALIAS
);
}
else {
final ParseTree lastChild = ctx.getChild( ctx.getChildCount() - 1 );
if ( lastChild instanceof HqlParser.IdentifierContext identifierContext ) {
// in this branch, the alias could be a reserved word ("keyword as identifier")
// which JPA disallows...
checkJpaCompliance( sqmBuilder, identifierContext.getStart() );
return sqmBuilder.visitIdentifier( identifierContext );
}
else if ( lastChild instanceof HqlParser.NakedIdentifierContext identifierContext ) {
// in this branch, the alias could be a reserved word ("keyword as identifier")
// which JPA disallows...
checkJpaCompliance( sqmBuilder, identifierContext.getStart() );
return sqmBuilder.visitNakedIdentifier( identifierContext );
}
else {
throw new AssertionFailure( "Unexpected type parse of tree" );
}
return sqmBuilder.visitIdentifier( identifierContext );
}
else {
final HqlParser.NakedIdentifierContext identifierContext = (HqlParser.NakedIdentifierContext) lastChild;
// in this branch, the alias could be a reserved word ("keyword as identifier")
// which JPA disallows...
if ( sqmBuilder.getCreationOptions().useStrictJpaCompliance() ) {
final Token identificationVariableToken = identifierContext.getStart();
if ( RESERVED_WORDS.contains( identificationVariableToken.getText().toLowerCase( Locale.ENGLISH ) ) ) {
throw new StrictJpaComplianceViolation(
String.format(
Locale.ROOT,
"Strict JPQL compliance was violated : %s [%s]",
StrictJpaComplianceViolation.Type.RESERVED_WORD_USED_AS_ALIAS.description(),
identificationVariableToken.getText()
),
StrictJpaComplianceViolation.Type.RESERVED_WORD_USED_AS_ALIAS
);
}
}

private static void checkJpaCompliance(SemanticQueryBuilder<?> sqmBuilder, Token identificationVariable) {
if ( sqmBuilder.getCreationOptions().useStrictJpaCompliance() ) {
if ( RESERVED_WORDS.contains( identificationVariable.getText().toLowerCase( Locale.ENGLISH ) ) ) {
throw new StrictJpaComplianceViolation(
String.format(
Locale.ROOT,
"Strict JPQL compliance was violated : %s [%s]",
StrictJpaComplianceViolation.Type.RESERVED_WORD_USED_AS_ALIAS.description(),
identificationVariable.getText()
),
StrictJpaComplianceViolation.Type.RESERVED_WORD_USED_AS_ALIAS
);
}
return sqmBuilder.visitNakedIdentifier( identifierContext );
}
}

/**
* Handle JPA requirement that variables (aliases) be case-insensitive
*/
public static String applyJpaCompliance(String text, SemanticQueryBuilder<?> sqmBuilder) {
if ( text == null ) {
return null;
}

if ( sqmBuilder.getCreationOptions().useStrictJpaCompliance() ) {
return text.toLowerCase( Locale.getDefault() );
}

return text;
return text != null
&& sqmBuilder.getCreationOptions().useStrictJpaCompliance()
? text.toLowerCase( Locale.getDefault() )
: text;
}
}
Loading