Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
13 changes: 13 additions & 0 deletions common/src/main/java/dev/cel/common/CelOptions.java
Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,8 @@ public enum ProtoUnsetFieldOptions {

public abstract boolean enableHiddenAccumulatorVar();

public abstract boolean enableQuotedIdentifierSyntax();

// Type-Checker related options

public abstract boolean enableCompileTimeOverloadResolution();
Expand DownExpand Up@@ -191,6 +193,7 @@ public static Builder newBuilder() {
.retainRepeatedUnaryOperators(false)
.retainUnbalancedLogicalExpressions(false)
.enableHiddenAccumulatorVar(false)
.enableQuotedIdentifierSyntax(false)
// Type-Checker options
.enableCompileTimeOverloadResolution(false)
.enableHomogeneousLiterals(false)
Expand DownExpand Up@@ -332,6 +335,16 @@ public abstract static class Builder {
*/
public abstract Builder enableHiddenAccumulatorVar(boolean value);

/**
* Enable quoted identifier syntax.
*
* <p>This enables the use of quoted identifier syntax when parsing CEL expressions. When
* enabled, the parser will accept identifiers that are surrounded by backticks (`) and will
* treat them as a single identifier. Currently, this is only supported for field specifiers
* over a limited character set.
*/
public abstract Builder enableQuotedIdentifierSyntax(boolean value);

// Type-Checker related options

/**
Expand Down
2 changes: 2 additions & 0 deletions parser/src/main/java/dev/cel/parser/BUILD.bazel
Original file line numberDiff line numberDiff line change
Expand Up@@ -127,6 +127,8 @@ java_library(
"//common",
"//common/ast",
"//common/ast:cel_expr_visitor",
"@maven//:com_google_guava_guava",
"@maven//:com_google_protobuf_protobuf_java",
"@maven//:com_google_re2j_re2j",
],
)
18 changes: 16 additions & 2 deletions parser/src/main/java/dev/cel/parser/CelUnparserVisitor.java
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,9 @@
// limitations under the License.
package dev.cel.parser;

import com.google.common.collect.ImmutableSet;
import com.google.protobuf.ByteString;
import com.google.re2j.Pattern;
import dev.cel.common.CelAbstractSyntaxTree;
import dev.cel.common.CelSource;
import dev.cel.common.ast.CelConstant;
Expand DownExpand Up@@ -43,6 +45,10 @@ public class CelUnparserVisitor extends CelExprVisitor {
protected static final String RIGHT_BRACE = "}";
protected static final String COLON = ":";
protected static final String QUESTION_MARK = "?";
protected static final String BACKTICK = "`";
private static final Pattern IDENTIFIER_SEGMENT_PATTERN =
Pattern.compile("[a-zA-Z_][a-zA-Z0-9_]*");
private static final ImmutableSet<String> RESTRICTED_FIELD_NAMES = ImmutableSet.of("in");

protected final CelAbstractSyntaxTree ast;
protected final CelSource sourceInfo;
Expand All@@ -60,6 +66,14 @@ public String unparse() {
return stringBuilder.toString();
}

private static String maybeQuoteField(String field) {
if (RESTRICTED_FIELD_NAMES.contains(field)
|| !IDENTIFIER_SEGMENT_PATTERN.matcher(field).matches()) {
return BACKTICK + field + BACKTICK;
}
return field;
}

@Override
public void visit(CelExpr expr) {
if (sourceInfo.getMacroCalls().containsKey(expr.id())) {
Expand DownExpand Up@@ -191,7 +205,7 @@ protected void visit(CelExpr expr, CelStruct struct) {
if (e.optionalEntry()) {
stringBuilder.append(QUESTION_MARK);
}
stringBuilder.append(e.fieldKey());
stringBuilder.append(maybeQuoteField(e.fieldKey()));
stringBuilder.append(COLON).append(SPACE);
visit(e.value());
}
Expand DownExpand Up@@ -263,7 +277,7 @@ private void visitSelect(CelExpr operand, boolean testOnly, String op, String fi
}
boolean nested = !testOnly && isBinaryOrTernaryOperator(operand);
visitMaybeNested(operand, nested);
stringBuilder.append(op).append(field);
stringBuilder.append(op).append(maybeQuoteField(field));
if (testOnly) {
stringBuilder.append(RIGHT_PAREN);
}
Expand Down
58 changes: 47 additions & 11 deletions parser/src/main/java/dev/cel/parser/Parser.java
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,10 +33,13 @@
import cel.parser.internal.CELParser.CreateMapContext;
import cel.parser.internal.CELParser.CreateMessageContext;
import cel.parser.internal.CELParser.DoubleContext;
import cel.parser.internal.CELParser.EscapeIdentContext;
import cel.parser.internal.CELParser.EscapedIdentifierContext;
import cel.parser.internal.CELParser.ExprContext;
import cel.parser.internal.CELParser.ExprListContext;
import cel.parser.internal.CELParser.FieldInitializerListContext;
import cel.parser.internal.CELParser.IdentOrGlobalCallContext;
import cel.parser.internal.CELParser.GlobalCallContext;
import cel.parser.internal.CELParser.IdentContext;
import cel.parser.internal.CELParser.IndexContext;
import cel.parser.internal.CELParser.IntContext;
import cel.parser.internal.CELParser.ListInitContext;
Expand All@@ -52,6 +55,7 @@
import cel.parser.internal.CELParser.PrimaryExprContext;
import cel.parser.internal.CELParser.RelationContext;
import cel.parser.internal.CELParser.SelectContext;
import cel.parser.internal.CELParser.SimpleIdentifierContext;
import cel.parser.internal.CELParser.StartContext;
import cel.parser.internal.CELParser.StringContext;
import cel.parser.internal.CELParser.UintContext;
Expand DownExpand Up@@ -438,7 +442,7 @@ public CelExpr visitSelect(SelectContext context) {
if (context.id == null) {
return exprFactory.newExprBuilder(context).build();
}
String id = context.id.getText();
String id = normalizeEscapedIdent(context.id);

if (context.opt != null && context.opt.getText().equals("?")) {
if (!options.enableOptionalSyntax()) {
Expand DownExpand Up@@ -535,7 +539,7 @@ public CelExpr visitCreateMessage(CreateMessageContext context) {
}

@Override
public CelExpr visitIdentOrGlobalCall(IdentOrGlobalCallContext context) {
public CelExpr visitIdent(IdentContext context) {
checkNotNull(context);
if (context.id == null) {
return exprFactory.newExprBuilder(context).build();
Expand All@@ -547,11 +551,25 @@ public CelExpr visitIdentOrGlobalCall(IdentOrGlobalCallContext context) {
if (context.leadingDot != null) {
id = "." + id;
}
if (context.op == null) {
return exprFactory
.newExprBuilder(context.id)
.setIdent(CelExpr.CelIdent.newBuilder().setName(id).build())
.build();

return exprFactory
.newExprBuilder(context.id)
.setIdent(CelExpr.CelIdent.newBuilder().setName(id).build())
.build();
}

@Override
public CelExpr visitGlobalCall(GlobalCallContext context) {
checkNotNull(context);
if (context.id == null) {
return exprFactory.newExprBuilder(context).build();
}
String id = context.id.getText();
if (options.enableReservedIds() && RESERVED_IDS.contains(id)) {
return exprFactory.reportError(context, "reserved identifier: %s", id);
}
if (context.leadingDot != null) {
id = "." + id;
}

return globalCallOrMacro(context, id);
Expand DownExpand Up@@ -671,6 +689,24 @@ private Optional<CelExpr> visitMacro(
return expandedMacro;
}

private String normalizeEscapedIdent(EscapeIdentContext context) {
if (context instanceof SimpleIdentifierContext) {
return ((SimpleIdentifierContext) context).getText();
} else if (context instanceof EscapedIdentifierContext) {
if (!options.enableQuotedIdentifierSyntax()) {
exprFactory.reportError(context, "unsupported syntax '`'");
return "";
}
String escaped = ((EscapedIdentifierContext) context).getText();
return escaped.substring(1, escaped.length() - 1);
}

// This is normally unreachable, but might happen if the parser is in an error state or if the
// grammar is updated and not handled here.
exprFactory.reportError(context, "unsupported identifier");
return "";
}

private CelExpr.CelStruct.Builder visitStructFields(FieldInitializerListContext context) {
if (context == null
|| context.cols == null
Expand All@@ -692,10 +728,10 @@ private CelExpr.CelStruct.Builder visitStructFields(FieldInitializerListContext
}

// The field may be empty due to a prior error.
if (fieldContext.IDENTIFIER() == null) {
if (fieldContext.escapeIdent() == null) {
return CelExpr.CelStruct.newBuilder();
}
String fieldName = fieldContext.IDENTIFIER().getText();
String fieldName = normalizeEscapedIdent(fieldContext.escapeIdent());

CelExpr.CelStruct.Entry.Builder exprBuilder =
CelExpr.CelStruct.Entry.newBuilder()
Expand DownExpand Up@@ -872,7 +908,7 @@ private CelExpr receiverCallOrMacro(MemberCallContext context, String id, CelExp
return macroOrCall(context.args, context.open, id, Optional.of(member), true);
}

private CelExpr globalCallOrMacro(IdentOrGlobalCallContext context, String id) {
private CelExpr globalCallOrMacro(GlobalCallContext context, String id) {
return macroOrCall(context.args, context.op, id, Optional.empty(), false);
}

Expand Down
36 changes: 22 additions & 14 deletions parser/src/main/java/dev/cel/parser/gen/CEL.g4
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
// 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.

grammar CEL;

// Grammar Rules
Expand DownExpand Up@@ -44,26 +45,27 @@ calc
;

unary
: member # MemberExpr
| (ops+='!')+ member # LogicalNot
| (ops+='-')+ member # Negate
: member # MemberExpr
| (ops+='!')+ member # LogicalNot
| (ops+='-')+ member # Negate
;

member
: primary # PrimaryExpr
| member op='.' (opt='?')? id=IDENTIFIER # Select
| member op='.' id=IDENTIFIER open='(' args=exprList? ')' # MemberCall
| member op='[' (opt='?')? index=expr ']' # Index
: primary # PrimaryExpr
| member op='.' (opt='?')? id=escapeIdent # Select
| member op='.' id=IDENTIFIER open='(' args=exprList? ')' # MemberCall
| member op='[' (opt='?')? index=expr ']' # Index
;

primary
: leadingDot='.'? id=IDENTIFIER (op='(' args=exprList? ')')? # IdentOrGlobalCall
| '(' e=expr ')' # Nested
| op='[' elems=listInit? ','? ']' # CreateList
| op='{' entries=mapInitializerList? ','? '}' # CreateMap
: leadingDot='.'? id=IDENTIFIER # Ident
| leadingDot='.'? id=IDENTIFIER (op='(' args=exprList? ')') # GlobalCall
| '(' e=expr ')' # Nested
| op='[' elems=listInit? ','? ']' # CreateList
| op='{' entries=mapInitializerList? ','? '}' # CreateMap
| leadingDot='.'? ids+=IDENTIFIER (ops+='.' ids+=IDENTIFIER)*
op='{' entries=fieldInitializerList? ','? '}' # CreateMessage
| literal # ConstantLiteral
op='{' entries=fieldInitializerList? ','? '}' # CreateMessage
| literal # ConstantLiteral
;

exprList
Expand All@@ -79,13 +81,18 @@ fieldInitializerList
;

optField
: (opt='?')? IDENTIFIER
: (opt='?')? escapeIdent
;

mapInitializerList
: keys+=optExpr cols+=':' values+=expr (',' keys+=optExpr cols+=':' values+=expr)*
;

escapeIdent
: id=IDENTIFIER # SimpleIdentifier
| id=ESC_IDENTIFIER # EscapedIdentifier
;

optExpr
: (opt='?')? e=expr
;
Expand DownExpand Up@@ -197,3 +204,4 @@ STRING
BYTES : ('b' | 'B') STRING;

IDENTIFIER : (LETTER | '_') ( LETTER | DIGIT | '_')*;
ESC_IDENTIFIER : '`' (LETTER | DIGIT | '_' | '.' | '-' | '/' | ' ')+ '`';
Original file line numberDiff line numberDiff line change
Expand Up@@ -205,6 +205,18 @@ public void parser() {
.setOptions(CelOptions.current().enableReservedIds(false).build())
.build(),
"while");
CelParser parserWithQuotedFields =
CelParserImpl.newBuilder()
.setOptions(CelOptions.current().enableQuotedIdentifierSyntax(true).build())
.build();
runTest(parserWithQuotedFields, "foo.`bar`");
runTest(parserWithQuotedFields, "foo.`bar-baz`");
runTest(parserWithQuotedFields, "foo.`bar baz`");
runTest(parserWithQuotedFields, "foo.`bar.baz`");
runTest(parserWithQuotedFields, "foo.`bar/baz`");
runTest(parserWithQuotedFields, "foo.`bar_baz`");
runTest(parserWithQuotedFields, "foo.`in`");
runTest(parserWithQuotedFields, "Struct{`in`: false}");
}

@Test
Expand DownExpand Up@@ -273,6 +285,21 @@ public void parser_errors() {
runTest(parserWithoutOptionalSupport, "a.?b && a[?b]");
runTest(parserWithoutOptionalSupport, "Msg{?field: value} && {?'key': value}");
runTest(parserWithoutOptionalSupport, "[?a, ?b]");

CelParser parserWithQuotedFields =
CelParserImpl.newBuilder()
.setOptions(CelOptions.current().enableQuotedIdentifierSyntax(true).build())
.build();
runTest(parserWithQuotedFields, "`bar`");
runTest(parserWithQuotedFields, "foo.``");
runTest(parserWithQuotedFields, "foo.`$bar`");

CelParser parserWithoutQuotedFields =
CelParserImpl.newBuilder()
.setOptions(CelOptions.current().enableQuotedIdentifierSyntax(false).build())
.build();
runTest(parserWithoutQuotedFields, "foo.`bar`");
runTest(parserWithoutQuotedFields, "Struct{`bar`: false}");
}

@Test
Expand Down
16 changes: 15 additions & 1 deletion parser/src/test/java/dev/cel/parser/CelUnparserImplTest.java
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,11 @@ public final class CelUnparserImplTest {

private final CelParser parser =
CelParserImpl.newBuilder()
.setOptions(CelOptions.newBuilder().populateMacroCalls(true).build())
.setOptions(
CelOptions.newBuilder()
.enableQuotedIdentifierSyntax(true)
.populateMacroCalls(true)
.build())
.addLibraries(CelOptionalLibrary.INSTANCE)
.setStandardMacros(CelStandardMacro.STANDARD_MACROS)
.build();
Expand DownExpand Up@@ -99,6 +103,15 @@ public List<String> provideValues(Context context) {
"a ? (b1 || b2) : (c1 && c2)",
"(a ? b : c).method(d)",
"a + b + c + d",
"foo.`a.b`",
"foo.`a/b`",
"foo.`a-b`",
"foo.`a b`",
"foo.`in`",
"Foo{`a.b`: foo}",
"Foo{`a/b`: foo}",
"Foo{`a-b`: foo}",
"Foo{`a b`: foo}",

// Constants
"true",
Expand DownExpand Up@@ -140,6 +153,7 @@ public List<String> provideValues(Context context) {

// Macros
"has(x[\"a\"].single_int32)",
"has(x.`foo-bar`.single_int32)",

// This is a filter expression but is decompiled back to
// map(x, filter_function, x) for which the evaluation is
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
13 changes: 13 additions & 0 deletions common/src/main/java/dev/cel/common/CelOptions.java
Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,8 @@ public enum ProtoUnsetFieldOptions {

public abstract boolean enableHiddenAccumulatorVar();

public abstract boolean enableQuotedIdentifierSyntax();

// Type-Checker related options

public abstract boolean enableCompileTimeOverloadResolution();
Expand DownExpand Up@@ -191,6 +193,7 @@ public static Builder newBuilder() {
.retainRepeatedUnaryOperators(false)
.retainUnbalancedLogicalExpressions(false)
.enableHiddenAccumulatorVar(false)
.enableQuotedIdentifierSyntax(false)
// Type-Checker options
.enableCompileTimeOverloadResolution(false)
.enableHomogeneousLiterals(false)
Expand DownExpand Up@@ -332,6 +335,16 @@ public abstract static class Builder {
*/
public abstract Builder enableHiddenAccumulatorVar(boolean value);

/**
* Enable quoted identifier syntax.
*
* <p>This enables the use of quoted identifier syntax when parsing CEL expressions. When
* enabled, the parser will accept identifiers that are surrounded by backticks (`) and will
* treat them as a single identifier. Currently, this is only supported for field specifiers
* over a limited character set.
*/
public abstract Builder enableQuotedIdentifierSyntax(boolean value);

// Type-Checker related options

/**
Expand Down
2 changes: 2 additions & 0 deletions parser/src/main/java/dev/cel/parser/BUILD.bazel
Original file line numberDiff line numberDiff line change
Expand Up@@ -127,6 +127,8 @@ java_library(
"//common",
"//common/ast",
"//common/ast:cel_expr_visitor",
"@maven//:com_google_guava_guava",
"@maven//:com_google_protobuf_protobuf_java",
"@maven//:com_google_re2j_re2j",
],
)
18 changes: 16 additions & 2 deletions parser/src/main/java/dev/cel/parser/CelUnparserVisitor.java
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,9 @@
// limitations under the License.
package dev.cel.parser;

import com.google.common.collect.ImmutableSet;
import com.google.protobuf.ByteString;
import com.google.re2j.Pattern;
import dev.cel.common.CelAbstractSyntaxTree;
import dev.cel.common.CelSource;
import dev.cel.common.ast.CelConstant;
Expand DownExpand Up@@ -43,6 +45,10 @@ public class CelUnparserVisitor extends CelExprVisitor {
protected static final String RIGHT_BRACE = "}";
protected static final String COLON = ":";
protected static final String QUESTION_MARK = "?";
protected static final String BACKTICK = "`";
private static final Pattern IDENTIFIER_SEGMENT_PATTERN =
Pattern.compile("[a-zA-Z_][a-zA-Z0-9_]*");
private static final ImmutableSet<String> RESTRICTED_FIELD_NAMES = ImmutableSet.of("in");

protected final CelAbstractSyntaxTree ast;
protected final CelSource sourceInfo;
Expand All@@ -60,6 +66,14 @@ public String unparse() {
return stringBuilder.toString();
}

private static String maybeQuoteField(String field) {
if (RESTRICTED_FIELD_NAMES.contains(field)
|| !IDENTIFIER_SEGMENT_PATTERN.matcher(field).matches()) {
return BACKTICK + field + BACKTICK;
}
return field;
}

@Override
public void visit(CelExpr expr) {
if (sourceInfo.getMacroCalls().containsKey(expr.id())) {
Expand DownExpand Up@@ -191,7 +205,7 @@ protected void visit(CelExpr expr, CelStruct struct) {
if (e.optionalEntry()) {
stringBuilder.append(QUESTION_MARK);
}
stringBuilder.append(e.fieldKey());
stringBuilder.append(maybeQuoteField(e.fieldKey()));
stringBuilder.append(COLON).append(SPACE);
visit(e.value());
}
Expand DownExpand Up@@ -263,7 +277,7 @@ private void visitSelect(CelExpr operand, boolean testOnly, String op, String fi
}
boolean nested = !testOnly && isBinaryOrTernaryOperator(operand);
visitMaybeNested(operand, nested);
stringBuilder.append(op).append(field);
stringBuilder.append(op).append(maybeQuoteField(field));
if (testOnly) {
stringBuilder.append(RIGHT_PAREN);
}
Expand Down
58 changes: 47 additions & 11 deletions parser/src/main/java/dev/cel/parser/Parser.java
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,10 +33,13 @@
import cel.parser.internal.CELParser.CreateMapContext;
import cel.parser.internal.CELParser.CreateMessageContext;
import cel.parser.internal.CELParser.DoubleContext;
import cel.parser.internal.CELParser.EscapeIdentContext;
import cel.parser.internal.CELParser.EscapedIdentifierContext;
import cel.parser.internal.CELParser.ExprContext;
import cel.parser.internal.CELParser.ExprListContext;
import cel.parser.internal.CELParser.FieldInitializerListContext;
import cel.parser.internal.CELParser.IdentOrGlobalCallContext;
import cel.parser.internal.CELParser.GlobalCallContext;
import cel.parser.internal.CELParser.IdentContext;
import cel.parser.internal.CELParser.IndexContext;
import cel.parser.internal.CELParser.IntContext;
import cel.parser.internal.CELParser.ListInitContext;
Expand All@@ -52,6 +55,7 @@
import cel.parser.internal.CELParser.PrimaryExprContext;
import cel.parser.internal.CELParser.RelationContext;
import cel.parser.internal.CELParser.SelectContext;
import cel.parser.internal.CELParser.SimpleIdentifierContext;
import cel.parser.internal.CELParser.StartContext;
import cel.parser.internal.CELParser.StringContext;
import cel.parser.internal.CELParser.UintContext;
Expand DownExpand Up@@ -438,7 +442,7 @@ public CelExpr visitSelect(SelectContext context) {
if (context.id == null) {
return exprFactory.newExprBuilder(context).build();
}
String id = context.id.getText();
String id = normalizeEscapedIdent(context.id);

if (context.opt != null && context.opt.getText().equals("?")) {
if (!options.enableOptionalSyntax()) {
Expand DownExpand Up@@ -535,7 +539,7 @@ public CelExpr visitCreateMessage(CreateMessageContext context) {
}

@Override
public CelExpr visitIdentOrGlobalCall(IdentOrGlobalCallContext context) {
public CelExpr visitIdent(IdentContext context) {
checkNotNull(context);
if (context.id == null) {
return exprFactory.newExprBuilder(context).build();
Expand All@@ -547,11 +551,25 @@ public CelExpr visitIdentOrGlobalCall(IdentOrGlobalCallContext context) {
if (context.leadingDot != null) {
id = "." + id;
}
if (context.op == null) {
return exprFactory
.newExprBuilder(context.id)
.setIdent(CelExpr.CelIdent.newBuilder().setName(id).build())
.build();

return exprFactory
.newExprBuilder(context.id)
.setIdent(CelExpr.CelIdent.newBuilder().setName(id).build())
.build();
}

@Override
public CelExpr visitGlobalCall(GlobalCallContext context) {
checkNotNull(context);
if (context.id == null) {
return exprFactory.newExprBuilder(context).build();
}
String id = context.id.getText();
if (options.enableReservedIds() && RESERVED_IDS.contains(id)) {
return exprFactory.reportError(context, "reserved identifier: %s", id);
}
if (context.leadingDot != null) {
id = "." + id;
}

return globalCallOrMacro(context, id);
Expand DownExpand Up@@ -671,6 +689,24 @@ private Optional<CelExpr> visitMacro(
return expandedMacro;
}

private String normalizeEscapedIdent(EscapeIdentContext context) {
if (context instanceof SimpleIdentifierContext) {
return ((SimpleIdentifierContext) context).getText();
} else if (context instanceof EscapedIdentifierContext) {
if (!options.enableQuotedIdentifierSyntax()) {
exprFactory.reportError(context, "unsupported syntax '`'");
return "";
}
String escaped = ((EscapedIdentifierContext) context).getText();
return escaped.substring(1, escaped.length() - 1);
}

// This is normally unreachable, but might happen if the parser is in an error state or if the
// grammar is updated and not handled here.
exprFactory.reportError(context, "unsupported identifier");
return "";
}

private CelExpr.CelStruct.Builder visitStructFields(FieldInitializerListContext context) {
if (context == null
|| context.cols == null
Expand All@@ -692,10 +728,10 @@ private CelExpr.CelStruct.Builder visitStructFields(FieldInitializerListContext
}

// The field may be empty due to a prior error.
if (fieldContext.IDENTIFIER() == null) {
if (fieldContext.escapeIdent() == null) {
return CelExpr.CelStruct.newBuilder();
}
String fieldName = fieldContext.IDENTIFIER().getText();
String fieldName = normalizeEscapedIdent(fieldContext.escapeIdent());

CelExpr.CelStruct.Entry.Builder exprBuilder =
CelExpr.CelStruct.Entry.newBuilder()
Expand DownExpand Up@@ -872,7 +908,7 @@ private CelExpr receiverCallOrMacro(MemberCallContext context, String id, CelExp
return macroOrCall(context.args, context.open, id, Optional.of(member), true);
}

private CelExpr globalCallOrMacro(IdentOrGlobalCallContext context, String id) {
private CelExpr globalCallOrMacro(GlobalCallContext context, String id) {
return macroOrCall(context.args, context.op, id, Optional.empty(), false);
}

Expand Down
36 changes: 22 additions & 14 deletions parser/src/main/java/dev/cel/parser/gen/CEL.g4
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
// 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.

grammar CEL;

// Grammar Rules
Expand DownExpand Up@@ -44,26 +45,27 @@ calc
;

unary
: member # MemberExpr
| (ops+='!')+ member # LogicalNot
| (ops+='-')+ member # Negate
: member # MemberExpr
| (ops+='!')+ member # LogicalNot
| (ops+='-')+ member # Negate
;

member
: primary # PrimaryExpr
| member op='.' (opt='?')? id=IDENTIFIER # Select
| member op='.' id=IDENTIFIER open='(' args=exprList? ')' # MemberCall
| member op='[' (opt='?')? index=expr ']' # Index
: primary # PrimaryExpr
| member op='.' (opt='?')? id=escapeIdent # Select
| member op='.' id=IDENTIFIER open='(' args=exprList? ')' # MemberCall
| member op='[' (opt='?')? index=expr ']' # Index
;

primary
: leadingDot='.'? id=IDENTIFIER (op='(' args=exprList? ')')? # IdentOrGlobalCall
| '(' e=expr ')' # Nested
| op='[' elems=listInit? ','? ']' # CreateList
| op='{' entries=mapInitializerList? ','? '}' # CreateMap
: leadingDot='.'? id=IDENTIFIER # Ident
| leadingDot='.'? id=IDENTIFIER (op='(' args=exprList? ')') # GlobalCall
| '(' e=expr ')' # Nested
| op='[' elems=listInit? ','? ']' # CreateList
| op='{' entries=mapInitializerList? ','? '}' # CreateMap
| leadingDot='.'? ids+=IDENTIFIER (ops+='.' ids+=IDENTIFIER)*
op='{' entries=fieldInitializerList? ','? '}' # CreateMessage
| literal # ConstantLiteral
op='{' entries=fieldInitializerList? ','? '}' # CreateMessage
| literal # ConstantLiteral
;

exprList
Expand All@@ -79,13 +81,18 @@ fieldInitializerList
;

optField
: (opt='?')? IDENTIFIER
: (opt='?')? escapeIdent
;

mapInitializerList
: keys+=optExpr cols+=':' values+=expr (',' keys+=optExpr cols+=':' values+=expr)*
;

escapeIdent
: id=IDENTIFIER # SimpleIdentifier
| id=ESC_IDENTIFIER # EscapedIdentifier
;

optExpr
: (opt='?')? e=expr
;
Expand DownExpand Up@@ -197,3 +204,4 @@ STRING
BYTES : ('b' | 'B') STRING;

IDENTIFIER : (LETTER | '_') ( LETTER | DIGIT | '_')*;
ESC_IDENTIFIER : '`' (LETTER | DIGIT | '_' | '.' | '-' | '/' | ' ')+ '`';
Original file line numberDiff line numberDiff line change
Expand Up@@ -205,6 +205,18 @@ public void parser() {
.setOptions(CelOptions.current().enableReservedIds(false).build())
.build(),
"while");
CelParser parserWithQuotedFields =
CelParserImpl.newBuilder()
.setOptions(CelOptions.current().enableQuotedIdentifierSyntax(true).build())
.build();
runTest(parserWithQuotedFields, "foo.`bar`");
runTest(parserWithQuotedFields, "foo.`bar-baz`");
runTest(parserWithQuotedFields, "foo.`bar baz`");
runTest(parserWithQuotedFields, "foo.`bar.baz`");
runTest(parserWithQuotedFields, "foo.`bar/baz`");
runTest(parserWithQuotedFields, "foo.`bar_baz`");
runTest(parserWithQuotedFields, "foo.`in`");
runTest(parserWithQuotedFields, "Struct{`in`: false}");
}

@Test
Expand DownExpand Up@@ -273,6 +285,21 @@ public void parser_errors() {
runTest(parserWithoutOptionalSupport, "a.?b && a[?b]");
runTest(parserWithoutOptionalSupport, "Msg{?field: value} && {?'key': value}");
runTest(parserWithoutOptionalSupport, "[?a, ?b]");

CelParser parserWithQuotedFields =
CelParserImpl.newBuilder()
.setOptions(CelOptions.current().enableQuotedIdentifierSyntax(true).build())
.build();
runTest(parserWithQuotedFields, "`bar`");
runTest(parserWithQuotedFields, "foo.``");
runTest(parserWithQuotedFields, "foo.`$bar`");

CelParser parserWithoutQuotedFields =
CelParserImpl.newBuilder()
.setOptions(CelOptions.current().enableQuotedIdentifierSyntax(false).build())
.build();
runTest(parserWithoutQuotedFields, "foo.`bar`");
runTest(parserWithoutQuotedFields, "Struct{`bar`: false}");
}

@Test
Expand Down
16 changes: 15 additions & 1 deletion parser/src/test/java/dev/cel/parser/CelUnparserImplTest.java
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,11 @@ public final class CelUnparserImplTest {

private final CelParser parser =
CelParserImpl.newBuilder()
.setOptions(CelOptions.newBuilder().populateMacroCalls(true).build())
.setOptions(
CelOptions.newBuilder()
.enableQuotedIdentifierSyntax(true)
.populateMacroCalls(true)
.build())
.addLibraries(CelOptionalLibrary.INSTANCE)
.setStandardMacros(CelStandardMacro.STANDARD_MACROS)
.build();
Expand DownExpand Up@@ -99,6 +103,15 @@ public List<String> provideValues(Context context) {
"a ? (b1 || b2) : (c1 && c2)",
"(a ? b : c).method(d)",
"a + b + c + d",
"foo.`a.b`",
"foo.`a/b`",
"foo.`a-b`",
"foo.`a b`",
"foo.`in`",
"Foo{`a.b`: foo}",
"Foo{`a/b`: foo}",
"Foo{`a-b`: foo}",
"Foo{`a b`: foo}",

// Constants
"true",
Expand DownExpand Up@@ -140,6 +153,7 @@ public List<String> provideValues(Context context) {

// Macros
"has(x[\"a\"].single_int32)",
"has(x.`foo-bar`.single_int32)",

// This is a filter expression but is decompiled back to
// map(x, filter_function, x) for which the evaluation is
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
13 changes: 13 additions & 0 deletions common/src/main/java/dev/cel/common/CelOptions.java
Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,8 @@ public enum ProtoUnsetFieldOptions {

public abstract boolean enableHiddenAccumulatorVar();

public abstract boolean enableQuotedIdentifierSyntax();

// Type-Checker related options

public abstract boolean enableCompileTimeOverloadResolution();
Expand DownExpand Up@@ -191,6 +193,7 @@ public static Builder newBuilder() {
.retainRepeatedUnaryOperators(false)
.retainUnbalancedLogicalExpressions(false)
.enableHiddenAccumulatorVar(false)
.enableQuotedIdentifierSyntax(false)
// Type-Checker options
.enableCompileTimeOverloadResolution(false)
.enableHomogeneousLiterals(false)
Expand DownExpand Up@@ -332,6 +335,16 @@ public abstract static class Builder {
*/
public abstract Builder enableHiddenAccumulatorVar(boolean value);

/**
* Enable quoted identifier syntax.
*
* <p>This enables the use of quoted identifier syntax when parsing CEL expressions. When
* enabled, the parser will accept identifiers that are surrounded by backticks (`) and will
* treat them as a single identifier. Currently, this is only supported for field specifiers
* over a limited character set.
*/
public abstract Builder enableQuotedIdentifierSyntax(boolean value);

// Type-Checker related options

/**
Expand Down
2 changes: 2 additions & 0 deletions parser/src/main/java/dev/cel/parser/BUILD.bazel
Original file line numberDiff line numberDiff line change
Expand Up@@ -127,6 +127,8 @@ java_library(
"//common",
"//common/ast",
"//common/ast:cel_expr_visitor",
"@maven//:com_google_guava_guava",
"@maven//:com_google_protobuf_protobuf_java",
"@maven//:com_google_re2j_re2j",
],
)
18 changes: 16 additions & 2 deletions parser/src/main/java/dev/cel/parser/CelUnparserVisitor.java
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,9 @@
// limitations under the License.
package dev.cel.parser;

import com.google.common.collect.ImmutableSet;
import com.google.protobuf.ByteString;
import com.google.re2j.Pattern;
import dev.cel.common.CelAbstractSyntaxTree;
import dev.cel.common.CelSource;
import dev.cel.common.ast.CelConstant;
Expand DownExpand Up@@ -43,6 +45,10 @@ public class CelUnparserVisitor extends CelExprVisitor {
protected static final String RIGHT_BRACE = "}";
protected static final String COLON = ":";
protected static final String QUESTION_MARK = "?";
protected static final String BACKTICK = "`";
private static final Pattern IDENTIFIER_SEGMENT_PATTERN =
Pattern.compile("[a-zA-Z_][a-zA-Z0-9_]*");
private static final ImmutableSet<String> RESTRICTED_FIELD_NAMES = ImmutableSet.of("in");

protected final CelAbstractSyntaxTree ast;
protected final CelSource sourceInfo;
Expand All@@ -60,6 +66,14 @@ public String unparse() {
return stringBuilder.toString();
}

private static String maybeQuoteField(String field) {
if (RESTRICTED_FIELD_NAMES.contains(field)
|| !IDENTIFIER_SEGMENT_PATTERN.matcher(field).matches()) {
return BACKTICK + field + BACKTICK;
}
return field;
}

@Override
public void visit(CelExpr expr) {
if (sourceInfo.getMacroCalls().containsKey(expr.id())) {
Expand DownExpand Up@@ -191,7 +205,7 @@ protected void visit(CelExpr expr, CelStruct struct) {
if (e.optionalEntry()) {
stringBuilder.append(QUESTION_MARK);
}
stringBuilder.append(e.fieldKey());
stringBuilder.append(maybeQuoteField(e.fieldKey()));
stringBuilder.append(COLON).append(SPACE);
visit(e.value());
}
Expand DownExpand Up@@ -263,7 +277,7 @@ private void visitSelect(CelExpr operand, boolean testOnly, String op, String fi
}
boolean nested = !testOnly && isBinaryOrTernaryOperator(operand);
visitMaybeNested(operand, nested);
stringBuilder.append(op).append(field);
stringBuilder.append(op).append(maybeQuoteField(field));
if (testOnly) {
stringBuilder.append(RIGHT_PAREN);
}
Expand Down
58 changes: 47 additions & 11 deletions parser/src/main/java/dev/cel/parser/Parser.java
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,10 +33,13 @@
import cel.parser.internal.CELParser.CreateMapContext;
import cel.parser.internal.CELParser.CreateMessageContext;
import cel.parser.internal.CELParser.DoubleContext;
import cel.parser.internal.CELParser.EscapeIdentContext;
import cel.parser.internal.CELParser.EscapedIdentifierContext;
import cel.parser.internal.CELParser.ExprContext;
import cel.parser.internal.CELParser.ExprListContext;
import cel.parser.internal.CELParser.FieldInitializerListContext;
import cel.parser.internal.CELParser.IdentOrGlobalCallContext;
import cel.parser.internal.CELParser.GlobalCallContext;
import cel.parser.internal.CELParser.IdentContext;
import cel.parser.internal.CELParser.IndexContext;
import cel.parser.internal.CELParser.IntContext;
import cel.parser.internal.CELParser.ListInitContext;
Expand All@@ -52,6 +55,7 @@
import cel.parser.internal.CELParser.PrimaryExprContext;
import cel.parser.internal.CELParser.RelationContext;
import cel.parser.internal.CELParser.SelectContext;
import cel.parser.internal.CELParser.SimpleIdentifierContext;
import cel.parser.internal.CELParser.StartContext;
import cel.parser.internal.CELParser.StringContext;
import cel.parser.internal.CELParser.UintContext;
Expand DownExpand Up@@ -438,7 +442,7 @@ public CelExpr visitSelect(SelectContext context) {
if (context.id == null) {
return exprFactory.newExprBuilder(context).build();
}
String id = context.id.getText();
String id = normalizeEscapedIdent(context.id);

if (context.opt != null && context.opt.getText().equals("?")) {
if (!options.enableOptionalSyntax()) {
Expand DownExpand Up@@ -535,7 +539,7 @@ public CelExpr visitCreateMessage(CreateMessageContext context) {
}

@Override
public CelExpr visitIdentOrGlobalCall(IdentOrGlobalCallContext context) {
public CelExpr visitIdent(IdentContext context) {
checkNotNull(context);
if (context.id == null) {
return exprFactory.newExprBuilder(context).build();
Expand All@@ -547,11 +551,25 @@ public CelExpr visitIdentOrGlobalCall(IdentOrGlobalCallContext context) {
if (context.leadingDot != null) {
id = "." + id;
}
if (context.op == null) {
return exprFactory
.newExprBuilder(context.id)
.setIdent(CelExpr.CelIdent.newBuilder().setName(id).build())
.build();

return exprFactory
.newExprBuilder(context.id)
.setIdent(CelExpr.CelIdent.newBuilder().setName(id).build())
.build();
}

@Override
public CelExpr visitGlobalCall(GlobalCallContext context) {
checkNotNull(context);
if (context.id == null) {
return exprFactory.newExprBuilder(context).build();
}
String id = context.id.getText();
if (options.enableReservedIds() && RESERVED_IDS.contains(id)) {
return exprFactory.reportError(context, "reserved identifier: %s", id);
}
if (context.leadingDot != null) {
id = "." + id;
}

return globalCallOrMacro(context, id);
Expand DownExpand Up@@ -671,6 +689,24 @@ private Optional<CelExpr> visitMacro(
return expandedMacro;
}

private String normalizeEscapedIdent(EscapeIdentContext context) {
if (context instanceof SimpleIdentifierContext) {
return ((SimpleIdentifierContext) context).getText();
} else if (context instanceof EscapedIdentifierContext) {
if (!options.enableQuotedIdentifierSyntax()) {
exprFactory.reportError(context, "unsupported syntax '`'");
return "";
}
String escaped = ((EscapedIdentifierContext) context).getText();
return escaped.substring(1, escaped.length() - 1);
}

// This is normally unreachable, but might happen if the parser is in an error state or if the
// grammar is updated and not handled here.
exprFactory.reportError(context, "unsupported identifier");
return "";
}

private CelExpr.CelStruct.Builder visitStructFields(FieldInitializerListContext context) {
if (context == null
|| context.cols == null
Expand All@@ -692,10 +728,10 @@ private CelExpr.CelStruct.Builder visitStructFields(FieldInitializerListContext
}

// The field may be empty due to a prior error.
if (fieldContext.IDENTIFIER() == null) {
if (fieldContext.escapeIdent() == null) {
return CelExpr.CelStruct.newBuilder();
}
String fieldName = fieldContext.IDENTIFIER().getText();
String fieldName = normalizeEscapedIdent(fieldContext.escapeIdent());

CelExpr.CelStruct.Entry.Builder exprBuilder =
CelExpr.CelStruct.Entry.newBuilder()
Expand DownExpand Up@@ -872,7 +908,7 @@ private CelExpr receiverCallOrMacro(MemberCallContext context, String id, CelExp
return macroOrCall(context.args, context.open, id, Optional.of(member), true);
}

private CelExpr globalCallOrMacro(IdentOrGlobalCallContext context, String id) {
private CelExpr globalCallOrMacro(GlobalCallContext context, String id) {
return macroOrCall(context.args, context.op, id, Optional.empty(), false);
}

Expand Down
36 changes: 22 additions & 14 deletions parser/src/main/java/dev/cel/parser/gen/CEL.g4
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
// 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.

grammar CEL;

// Grammar Rules
Expand DownExpand Up@@ -44,26 +45,27 @@ calc
;

unary
: member # MemberExpr
| (ops+='!')+ member # LogicalNot
| (ops+='-')+ member # Negate
: member # MemberExpr
| (ops+='!')+ member # LogicalNot
| (ops+='-')+ member # Negate
;

member
: primary # PrimaryExpr
| member op='.' (opt='?')? id=IDENTIFIER # Select
| member op='.' id=IDENTIFIER open='(' args=exprList? ')' # MemberCall
| member op='[' (opt='?')? index=expr ']' # Index
: primary # PrimaryExpr
| member op='.' (opt='?')? id=escapeIdent # Select
| member op='.' id=IDENTIFIER open='(' args=exprList? ')' # MemberCall
| member op='[' (opt='?')? index=expr ']' # Index
;

primary
: leadingDot='.'? id=IDENTIFIER (op='(' args=exprList? ')')? # IdentOrGlobalCall
| '(' e=expr ')' # Nested
| op='[' elems=listInit? ','? ']' # CreateList
| op='{' entries=mapInitializerList? ','? '}' # CreateMap
: leadingDot='.'? id=IDENTIFIER # Ident
| leadingDot='.'? id=IDENTIFIER (op='(' args=exprList? ')') # GlobalCall
| '(' e=expr ')' # Nested
| op='[' elems=listInit? ','? ']' # CreateList
| op='{' entries=mapInitializerList? ','? '}' # CreateMap
| leadingDot='.'? ids+=IDENTIFIER (ops+='.' ids+=IDENTIFIER)*
op='{' entries=fieldInitializerList? ','? '}' # CreateMessage
| literal # ConstantLiteral
op='{' entries=fieldInitializerList? ','? '}' # CreateMessage
| literal # ConstantLiteral
;

exprList
Expand All@@ -79,13 +81,18 @@ fieldInitializerList
;

optField
: (opt='?')? IDENTIFIER
: (opt='?')? escapeIdent
;

mapInitializerList
: keys+=optExpr cols+=':' values+=expr (',' keys+=optExpr cols+=':' values+=expr)*
;

escapeIdent
: id=IDENTIFIER # SimpleIdentifier
| id=ESC_IDENTIFIER # EscapedIdentifier
;

optExpr
: (opt='?')? e=expr
;
Expand DownExpand Up@@ -197,3 +204,4 @@ STRING
BYTES : ('b' | 'B') STRING;

IDENTIFIER : (LETTER | '_') ( LETTER | DIGIT | '_')*;
ESC_IDENTIFIER : '`' (LETTER | DIGIT | '_' | '.' | '-' | '/' | ' ')+ '`';
Original file line numberDiff line numberDiff line change
Expand Up@@ -205,6 +205,18 @@ public void parser() {
.setOptions(CelOptions.current().enableReservedIds(false).build())
.build(),
"while");
CelParser parserWithQuotedFields =
CelParserImpl.newBuilder()
.setOptions(CelOptions.current().enableQuotedIdentifierSyntax(true).build())
.build();
runTest(parserWithQuotedFields, "foo.`bar`");
runTest(parserWithQuotedFields, "foo.`bar-baz`");
runTest(parserWithQuotedFields, "foo.`bar baz`");
runTest(parserWithQuotedFields, "foo.`bar.baz`");
runTest(parserWithQuotedFields, "foo.`bar/baz`");
runTest(parserWithQuotedFields, "foo.`bar_baz`");
runTest(parserWithQuotedFields, "foo.`in`");
runTest(parserWithQuotedFields, "Struct{`in`: false}");
}

@Test
Expand DownExpand Up@@ -273,6 +285,21 @@ public void parser_errors() {
runTest(parserWithoutOptionalSupport, "a.?b && a[?b]");
runTest(parserWithoutOptionalSupport, "Msg{?field: value} && {?'key': value}");
runTest(parserWithoutOptionalSupport, "[?a, ?b]");

CelParser parserWithQuotedFields =
CelParserImpl.newBuilder()
.setOptions(CelOptions.current().enableQuotedIdentifierSyntax(true).build())
.build();
runTest(parserWithQuotedFields, "`bar`");
runTest(parserWithQuotedFields, "foo.``");
runTest(parserWithQuotedFields, "foo.`$bar`");

CelParser parserWithoutQuotedFields =
CelParserImpl.newBuilder()
.setOptions(CelOptions.current().enableQuotedIdentifierSyntax(false).build())
.build();
runTest(parserWithoutQuotedFields, "foo.`bar`");
runTest(parserWithoutQuotedFields, "Struct{`bar`: false}");
}

@Test
Expand Down
16 changes: 15 additions & 1 deletion parser/src/test/java/dev/cel/parser/CelUnparserImplTest.java
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,11 @@ public final class CelUnparserImplTest {

private final CelParser parser =
CelParserImpl.newBuilder()
.setOptions(CelOptions.newBuilder().populateMacroCalls(true).build())
.setOptions(
CelOptions.newBuilder()
.enableQuotedIdentifierSyntax(true)
.populateMacroCalls(true)
.build())
.addLibraries(CelOptionalLibrary.INSTANCE)
.setStandardMacros(CelStandardMacro.STANDARD_MACROS)
.build();
Expand DownExpand Up@@ -99,6 +103,15 @@ public List<String> provideValues(Context context) {
"a ? (b1 || b2) : (c1 && c2)",
"(a ? b : c).method(d)",
"a + b + c + d",
"foo.`a.b`",
"foo.`a/b`",
"foo.`a-b`",
"foo.`a b`",
"foo.`in`",
"Foo{`a.b`: foo}",
"Foo{`a/b`: foo}",
"Foo{`a-b`: foo}",
"Foo{`a b`: foo}",

// Constants
"true",
Expand DownExpand Up@@ -140,6 +153,7 @@ public List<String> provideValues(Context context) {

// Macros
"has(x[\"a\"].single_int32)",
"has(x.`foo-bar`.single_int32)",

// This is a filter expression but is decompiled back to
// map(x, filter_function, x) for which the evaluation is
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
13 changes: 13 additions & 0 deletions common/src/main/java/dev/cel/common/CelOptions.java
Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,8 @@ public enum ProtoUnsetFieldOptions {

public abstract boolean enableHiddenAccumulatorVar();

public abstract boolean enableQuotedIdentifierSyntax();

// Type-Checker related options

public abstract boolean enableCompileTimeOverloadResolution();
Expand DownExpand Up@@ -191,6 +193,7 @@ public static Builder newBuilder() {
.retainRepeatedUnaryOperators(false)
.retainUnbalancedLogicalExpressions(false)
.enableHiddenAccumulatorVar(false)
.enableQuotedIdentifierSyntax(false)
// Type-Checker options
.enableCompileTimeOverloadResolution(false)
.enableHomogeneousLiterals(false)
Expand DownExpand Up@@ -332,6 +335,16 @@ public abstract static class Builder {
*/
public abstract Builder enableHiddenAccumulatorVar(boolean value);

/**
* Enable quoted identifier syntax.
*
* <p>This enables the use of quoted identifier syntax when parsing CEL expressions. When
* enabled, the parser will accept identifiers that are surrounded by backticks (`) and will
* treat them as a single identifier. Currently, this is only supported for field specifiers
* over a limited character set.
*/
public abstract Builder enableQuotedIdentifierSyntax(boolean value);

// Type-Checker related options

/**
Expand Down
2 changes: 2 additions & 0 deletions parser/src/main/java/dev/cel/parser/BUILD.bazel
Original file line numberDiff line numberDiff line change
Expand Up@@ -127,6 +127,8 @@ java_library(
"//common",
"//common/ast",
"//common/ast:cel_expr_visitor",
"@maven//:com_google_guava_guava",
"@maven//:com_google_protobuf_protobuf_java",
"@maven//:com_google_re2j_re2j",
],
)
18 changes: 16 additions & 2 deletions parser/src/main/java/dev/cel/parser/CelUnparserVisitor.java
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,9 @@
// limitations under the License.
package dev.cel.parser;

import com.google.common.collect.ImmutableSet;
import com.google.protobuf.ByteString;
import com.google.re2j.Pattern;
import dev.cel.common.CelAbstractSyntaxTree;
import dev.cel.common.CelSource;
import dev.cel.common.ast.CelConstant;
Expand DownExpand Up@@ -43,6 +45,10 @@ public class CelUnparserVisitor extends CelExprVisitor {
protected static final String RIGHT_BRACE = "}";
protected static final String COLON = ":";
protected static final String QUESTION_MARK = "?";
protected static final String BACKTICK = "`";
private static final Pattern IDENTIFIER_SEGMENT_PATTERN =
Pattern.compile("[a-zA-Z_][a-zA-Z0-9_]*");
private static final ImmutableSet<String> RESTRICTED_FIELD_NAMES = ImmutableSet.of("in");

protected final CelAbstractSyntaxTree ast;
protected final CelSource sourceInfo;
Expand All@@ -60,6 +66,14 @@ public String unparse() {
return stringBuilder.toString();
}

private static String maybeQuoteField(String field) {
if (RESTRICTED_FIELD_NAMES.contains(field)
|| !IDENTIFIER_SEGMENT_PATTERN.matcher(field).matches()) {
return BACKTICK + field + BACKTICK;
}
return field;
}

@Override
public void visit(CelExpr expr) {
if (sourceInfo.getMacroCalls().containsKey(expr.id())) {
Expand DownExpand Up@@ -191,7 +205,7 @@ protected void visit(CelExpr expr, CelStruct struct) {
if (e.optionalEntry()) {
stringBuilder.append(QUESTION_MARK);
}
stringBuilder.append(e.fieldKey());
stringBuilder.append(maybeQuoteField(e.fieldKey()));
stringBuilder.append(COLON).append(SPACE);
visit(e.value());
}
Expand DownExpand Up@@ -263,7 +277,7 @@ private void visitSelect(CelExpr operand, boolean testOnly, String op, String fi
}
boolean nested = !testOnly && isBinaryOrTernaryOperator(operand);
visitMaybeNested(operand, nested);
stringBuilder.append(op).append(field);
stringBuilder.append(op).append(maybeQuoteField(field));
if (testOnly) {
stringBuilder.append(RIGHT_PAREN);
}
Expand Down
58 changes: 47 additions & 11 deletions parser/src/main/java/dev/cel/parser/Parser.java
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,10 +33,13 @@
import cel.parser.internal.CELParser.CreateMapContext;
import cel.parser.internal.CELParser.CreateMessageContext;
import cel.parser.internal.CELParser.DoubleContext;
import cel.parser.internal.CELParser.EscapeIdentContext;
import cel.parser.internal.CELParser.EscapedIdentifierContext;
import cel.parser.internal.CELParser.ExprContext;
import cel.parser.internal.CELParser.ExprListContext;
import cel.parser.internal.CELParser.FieldInitializerListContext;
import cel.parser.internal.CELParser.IdentOrGlobalCallContext;
import cel.parser.internal.CELParser.GlobalCallContext;
import cel.parser.internal.CELParser.IdentContext;
import cel.parser.internal.CELParser.IndexContext;
import cel.parser.internal.CELParser.IntContext;
import cel.parser.internal.CELParser.ListInitContext;
Expand All@@ -52,6 +55,7 @@
import cel.parser.internal.CELParser.PrimaryExprContext;
import cel.parser.internal.CELParser.RelationContext;
import cel.parser.internal.CELParser.SelectContext;
import cel.parser.internal.CELParser.SimpleIdentifierContext;
import cel.parser.internal.CELParser.StartContext;
import cel.parser.internal.CELParser.StringContext;
import cel.parser.internal.CELParser.UintContext;
Expand DownExpand Up@@ -438,7 +442,7 @@ public CelExpr visitSelect(SelectContext context) {
if (context.id == null) {
return exprFactory.newExprBuilder(context).build();
}
String id = context.id.getText();
String id = normalizeEscapedIdent(context.id);

if (context.opt != null && context.opt.getText().equals("?")) {
if (!options.enableOptionalSyntax()) {
Expand DownExpand Up@@ -535,7 +539,7 @@ public CelExpr visitCreateMessage(CreateMessageContext context) {
}

@Override
public CelExpr visitIdentOrGlobalCall(IdentOrGlobalCallContext context) {
public CelExpr visitIdent(IdentContext context) {
checkNotNull(context);
if (context.id == null) {
return exprFactory.newExprBuilder(context).build();
Expand All@@ -547,11 +551,25 @@ public CelExpr visitIdentOrGlobalCall(IdentOrGlobalCallContext context) {
if (context.leadingDot != null) {
id = "." + id;
}
if (context.op == null) {
return exprFactory
.newExprBuilder(context.id)
.setIdent(CelExpr.CelIdent.newBuilder().setName(id).build())
.build();

return exprFactory
.newExprBuilder(context.id)
.setIdent(CelExpr.CelIdent.newBuilder().setName(id).build())
.build();
}

@Override
public CelExpr visitGlobalCall(GlobalCallContext context) {
checkNotNull(context);
if (context.id == null) {
return exprFactory.newExprBuilder(context).build();
}
String id = context.id.getText();
if (options.enableReservedIds() && RESERVED_IDS.contains(id)) {
return exprFactory.reportError(context, "reserved identifier: %s", id);
}
if (context.leadingDot != null) {
id = "." + id;
}

return globalCallOrMacro(context, id);
Expand DownExpand Up@@ -671,6 +689,24 @@ private Optional<CelExpr> visitMacro(
return expandedMacro;
}

private String normalizeEscapedIdent(EscapeIdentContext context) {
if (context instanceof SimpleIdentifierContext) {
return ((SimpleIdentifierContext) context).getText();
} else if (context instanceof EscapedIdentifierContext) {
if (!options.enableQuotedIdentifierSyntax()) {
exprFactory.reportError(context, "unsupported syntax '`'");
return "";
}
String escaped = ((EscapedIdentifierContext) context).getText();
return escaped.substring(1, escaped.length() - 1);
}

// This is normally unreachable, but might happen if the parser is in an error state or if the
// grammar is updated and not handled here.
exprFactory.reportError(context, "unsupported identifier");
return "";
}

private CelExpr.CelStruct.Builder visitStructFields(FieldInitializerListContext context) {
if (context == null
|| context.cols == null
Expand All@@ -692,10 +728,10 @@ private CelExpr.CelStruct.Builder visitStructFields(FieldInitializerListContext
}

// The field may be empty due to a prior error.
if (fieldContext.IDENTIFIER() == null) {
if (fieldContext.escapeIdent() == null) {
return CelExpr.CelStruct.newBuilder();
}
String fieldName = fieldContext.IDENTIFIER().getText();
String fieldName = normalizeEscapedIdent(fieldContext.escapeIdent());

CelExpr.CelStruct.Entry.Builder exprBuilder =
CelExpr.CelStruct.Entry.newBuilder()
Expand DownExpand Up@@ -872,7 +908,7 @@ private CelExpr receiverCallOrMacro(MemberCallContext context, String id, CelExp
return macroOrCall(context.args, context.open, id, Optional.of(member), true);
}

private CelExpr globalCallOrMacro(IdentOrGlobalCallContext context, String id) {
private CelExpr globalCallOrMacro(GlobalCallContext context, String id) {
return macroOrCall(context.args, context.op, id, Optional.empty(), false);
}

Expand Down
36 changes: 22 additions & 14 deletions parser/src/main/java/dev/cel/parser/gen/CEL.g4
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
// 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.

grammar CEL;

// Grammar Rules
Expand DownExpand Up@@ -44,26 +45,27 @@ calc
;

unary
: member # MemberExpr
| (ops+='!')+ member # LogicalNot
| (ops+='-')+ member # Negate
: member # MemberExpr
| (ops+='!')+ member # LogicalNot
| (ops+='-')+ member # Negate
;

member
: primary # PrimaryExpr
| member op='.' (opt='?')? id=IDENTIFIER # Select
| member op='.' id=IDENTIFIER open='(' args=exprList? ')' # MemberCall
| member op='[' (opt='?')? index=expr ']' # Index
: primary # PrimaryExpr
| member op='.' (opt='?')? id=escapeIdent # Select
| member op='.' id=IDENTIFIER open='(' args=exprList? ')' # MemberCall
| member op='[' (opt='?')? index=expr ']' # Index
;

primary
: leadingDot='.'? id=IDENTIFIER (op='(' args=exprList? ')')? # IdentOrGlobalCall
| '(' e=expr ')' # Nested
| op='[' elems=listInit? ','? ']' # CreateList
| op='{' entries=mapInitializerList? ','? '}' # CreateMap
: leadingDot='.'? id=IDENTIFIER # Ident
| leadingDot='.'? id=IDENTIFIER (op='(' args=exprList? ')') # GlobalCall
| '(' e=expr ')' # Nested
| op='[' elems=listInit? ','? ']' # CreateList
| op='{' entries=mapInitializerList? ','? '}' # CreateMap
| leadingDot='.'? ids+=IDENTIFIER (ops+='.' ids+=IDENTIFIER)*
op='{' entries=fieldInitializerList? ','? '}' # CreateMessage
| literal # ConstantLiteral
op='{' entries=fieldInitializerList? ','? '}' # CreateMessage
| literal # ConstantLiteral
;

exprList
Expand All@@ -79,13 +81,18 @@ fieldInitializerList
;

optField
: (opt='?')? IDENTIFIER
: (opt='?')? escapeIdent
;

mapInitializerList
: keys+=optExpr cols+=':' values+=expr (',' keys+=optExpr cols+=':' values+=expr)*
;

escapeIdent
: id=IDENTIFIER # SimpleIdentifier
| id=ESC_IDENTIFIER # EscapedIdentifier
;

optExpr
: (opt='?')? e=expr
;
Expand DownExpand Up@@ -197,3 +204,4 @@ STRING
BYTES : ('b' | 'B') STRING;

IDENTIFIER : (LETTER | '_') ( LETTER | DIGIT | '_')*;
ESC_IDENTIFIER : '`' (LETTER | DIGIT | '_' | '.' | '-' | '/' | ' ')+ '`';
Original file line numberDiff line numberDiff line change
Expand Up@@ -205,6 +205,18 @@ public void parser() {
.setOptions(CelOptions.current().enableReservedIds(false).build())
.build(),
"while");
CelParser parserWithQuotedFields =
CelParserImpl.newBuilder()
.setOptions(CelOptions.current().enableQuotedIdentifierSyntax(true).build())
.build();
runTest(parserWithQuotedFields, "foo.`bar`");
runTest(parserWithQuotedFields, "foo.`bar-baz`");
runTest(parserWithQuotedFields, "foo.`bar baz`");
runTest(parserWithQuotedFields, "foo.`bar.baz`");
runTest(parserWithQuotedFields, "foo.`bar/baz`");
runTest(parserWithQuotedFields, "foo.`bar_baz`");
runTest(parserWithQuotedFields, "foo.`in`");
runTest(parserWithQuotedFields, "Struct{`in`: false}");
}

@Test
Expand DownExpand Up@@ -273,6 +285,21 @@ public void parser_errors() {
runTest(parserWithoutOptionalSupport, "a.?b && a[?b]");
runTest(parserWithoutOptionalSupport, "Msg{?field: value} && {?'key': value}");
runTest(parserWithoutOptionalSupport, "[?a, ?b]");

CelParser parserWithQuotedFields =
CelParserImpl.newBuilder()
.setOptions(CelOptions.current().enableQuotedIdentifierSyntax(true).build())
.build();
runTest(parserWithQuotedFields, "`bar`");
runTest(parserWithQuotedFields, "foo.``");
runTest(parserWithQuotedFields, "foo.`$bar`");

CelParser parserWithoutQuotedFields =
CelParserImpl.newBuilder()
.setOptions(CelOptions.current().enableQuotedIdentifierSyntax(false).build())
.build();
runTest(parserWithoutQuotedFields, "foo.`bar`");
runTest(parserWithoutQuotedFields, "Struct{`bar`: false}");
}

@Test
Expand Down
16 changes: 15 additions & 1 deletion parser/src/test/java/dev/cel/parser/CelUnparserImplTest.java
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,11 @@ public final class CelUnparserImplTest {

private final CelParser parser =
CelParserImpl.newBuilder()
.setOptions(CelOptions.newBuilder().populateMacroCalls(true).build())
.setOptions(
CelOptions.newBuilder()
.enableQuotedIdentifierSyntax(true)
.populateMacroCalls(true)
.build())
.addLibraries(CelOptionalLibrary.INSTANCE)
.setStandardMacros(CelStandardMacro.STANDARD_MACROS)
.build();
Expand DownExpand Up@@ -99,6 +103,15 @@ public List<String> provideValues(Context context) {
"a ? (b1 || b2) : (c1 && c2)",
"(a ? b : c).method(d)",
"a + b + c + d",
"foo.`a.b`",
"foo.`a/b`",
"foo.`a-b`",
"foo.`a b`",
"foo.`in`",
"Foo{`a.b`: foo}",
"Foo{`a/b`: foo}",
"Foo{`a-b`: foo}",
"Foo{`a b`: foo}",

// Constants
"true",
Expand DownExpand Up@@ -140,6 +153,7 @@ public List<String> provideValues(Context context) {

// Macros
"has(x[\"a\"].single_int32)",
"has(x.`foo-bar`.single_int32)",

// This is a filter expression but is decompiled back to
// map(x, filter_function, x) for which the evaluation is
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
13 changes: 13 additions & 0 deletions common/src/main/java/dev/cel/common/CelOptions.java
Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,8 @@ public enum ProtoUnsetFieldOptions {

public abstract boolean enableHiddenAccumulatorVar();

public abstract boolean enableQuotedIdentifierSyntax();

// Type-Checker related options

public abstract boolean enableCompileTimeOverloadResolution();
Expand DownExpand Up@@ -191,6 +193,7 @@ public static Builder newBuilder() {
.retainRepeatedUnaryOperators(false)
.retainUnbalancedLogicalExpressions(false)
.enableHiddenAccumulatorVar(false)
.enableQuotedIdentifierSyntax(false)
// Type-Checker options
.enableCompileTimeOverloadResolution(false)
.enableHomogeneousLiterals(false)
Expand DownExpand Up@@ -332,6 +335,16 @@ public abstract static class Builder {
*/
public abstract Builder enableHiddenAccumulatorVar(boolean value);

/**
* Enable quoted identifier syntax.
*
* <p>This enables the use of quoted identifier syntax when parsing CEL expressions. When
* enabled, the parser will accept identifiers that are surrounded by backticks (`) and will
* treat them as a single identifier. Currently, this is only supported for field specifiers
* over a limited character set.
*/
public abstract Builder enableQuotedIdentifierSyntax(boolean value);

// Type-Checker related options

/**
Expand Down
2 changes: 2 additions & 0 deletions parser/src/main/java/dev/cel/parser/BUILD.bazel
Original file line numberDiff line numberDiff line change
Expand Up@@ -127,6 +127,8 @@ java_library(
"//common",
"//common/ast",
"//common/ast:cel_expr_visitor",
"@maven//:com_google_guava_guava",
"@maven//:com_google_protobuf_protobuf_java",
"@maven//:com_google_re2j_re2j",
],
)
18 changes: 16 additions & 2 deletions parser/src/main/java/dev/cel/parser/CelUnparserVisitor.java
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,9 @@
// limitations under the License.
package dev.cel.parser;

import com.google.common.collect.ImmutableSet;
import com.google.protobuf.ByteString;
import com.google.re2j.Pattern;
import dev.cel.common.CelAbstractSyntaxTree;
import dev.cel.common.CelSource;
import dev.cel.common.ast.CelConstant;
Expand DownExpand Up@@ -43,6 +45,10 @@ public class CelUnparserVisitor extends CelExprVisitor {
protected static final String RIGHT_BRACE = "}";
protected static final String COLON = ":";
protected static final String QUESTION_MARK = "?";
protected static final String BACKTICK = "`";
private static final Pattern IDENTIFIER_SEGMENT_PATTERN =
Pattern.compile("[a-zA-Z_][a-zA-Z0-9_]*");
private static final ImmutableSet<String> RESTRICTED_FIELD_NAMES = ImmutableSet.of("in");

protected final CelAbstractSyntaxTree ast;
protected final CelSource sourceInfo;
Expand All@@ -60,6 +66,14 @@ public String unparse() {
return stringBuilder.toString();
}

private static String maybeQuoteField(String field) {
if (RESTRICTED_FIELD_NAMES.contains(field)
|| !IDENTIFIER_SEGMENT_PATTERN.matcher(field).matches()) {
return BACKTICK + field + BACKTICK;
}
return field;
}

@Override
public void visit(CelExpr expr) {
if (sourceInfo.getMacroCalls().containsKey(expr.id())) {
Expand DownExpand Up@@ -191,7 +205,7 @@ protected void visit(CelExpr expr, CelStruct struct) {
if (e.optionalEntry()) {
stringBuilder.append(QUESTION_MARK);
}
stringBuilder.append(e.fieldKey());
stringBuilder.append(maybeQuoteField(e.fieldKey()));
stringBuilder.append(COLON).append(SPACE);
visit(e.value());
}
Expand DownExpand Up@@ -263,7 +277,7 @@ private void visitSelect(CelExpr operand, boolean testOnly, String op, String fi
}
boolean nested = !testOnly && isBinaryOrTernaryOperator(operand);
visitMaybeNested(operand, nested);
stringBuilder.append(op).append(field);
stringBuilder.append(op).append(maybeQuoteField(field));
if (testOnly) {
stringBuilder.append(RIGHT_PAREN);
}
Expand Down
58 changes: 47 additions & 11 deletions parser/src/main/java/dev/cel/parser/Parser.java
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,10 +33,13 @@
import cel.parser.internal.CELParser.CreateMapContext;
import cel.parser.internal.CELParser.CreateMessageContext;
import cel.parser.internal.CELParser.DoubleContext;
import cel.parser.internal.CELParser.EscapeIdentContext;
import cel.parser.internal.CELParser.EscapedIdentifierContext;
import cel.parser.internal.CELParser.ExprContext;
import cel.parser.internal.CELParser.ExprListContext;
import cel.parser.internal.CELParser.FieldInitializerListContext;
import cel.parser.internal.CELParser.IdentOrGlobalCallContext;
import cel.parser.internal.CELParser.GlobalCallContext;
import cel.parser.internal.CELParser.IdentContext;
import cel.parser.internal.CELParser.IndexContext;
import cel.parser.internal.CELParser.IntContext;
import cel.parser.internal.CELParser.ListInitContext;
Expand All@@ -52,6 +55,7 @@
import cel.parser.internal.CELParser.PrimaryExprContext;
import cel.parser.internal.CELParser.RelationContext;
import cel.parser.internal.CELParser.SelectContext;
import cel.parser.internal.CELParser.SimpleIdentifierContext;
import cel.parser.internal.CELParser.StartContext;
import cel.parser.internal.CELParser.StringContext;
import cel.parser.internal.CELParser.UintContext;
Expand DownExpand Up@@ -438,7 +442,7 @@ public CelExpr visitSelect(SelectContext context) {
if (context.id == null) {
return exprFactory.newExprBuilder(context).build();
}
String id = context.id.getText();
String id = normalizeEscapedIdent(context.id);

if (context.opt != null && context.opt.getText().equals("?")) {
if (!options.enableOptionalSyntax()) {
Expand DownExpand Up@@ -535,7 +539,7 @@ public CelExpr visitCreateMessage(CreateMessageContext context) {
}

@Override
public CelExpr visitIdentOrGlobalCall(IdentOrGlobalCallContext context) {
public CelExpr visitIdent(IdentContext context) {
checkNotNull(context);
if (context.id == null) {
return exprFactory.newExprBuilder(context).build();
Expand All@@ -547,11 +551,25 @@ public CelExpr visitIdentOrGlobalCall(IdentOrGlobalCallContext context) {
if (context.leadingDot != null) {
id = "." + id;
}
if (context.op == null) {
return exprFactory
.newExprBuilder(context.id)
.setIdent(CelExpr.CelIdent.newBuilder().setName(id).build())
.build();

return exprFactory
.newExprBuilder(context.id)
.setIdent(CelExpr.CelIdent.newBuilder().setName(id).build())
.build();
}

@Override
public CelExpr visitGlobalCall(GlobalCallContext context) {
checkNotNull(context);
if (context.id == null) {
return exprFactory.newExprBuilder(context).build();
}
String id = context.id.getText();
if (options.enableReservedIds() && RESERVED_IDS.contains(id)) {
return exprFactory.reportError(context, "reserved identifier: %s", id);
}
if (context.leadingDot != null) {
id = "." + id;
}

return globalCallOrMacro(context, id);
Expand DownExpand Up@@ -671,6 +689,24 @@ private Optional<CelExpr> visitMacro(
return expandedMacro;
}

private String normalizeEscapedIdent(EscapeIdentContext context) {
if (context instanceof SimpleIdentifierContext) {
return ((SimpleIdentifierContext) context).getText();
} else if (context instanceof EscapedIdentifierContext) {
if (!options.enableQuotedIdentifierSyntax()) {
exprFactory.reportError(context, "unsupported syntax '`'");
return "";
}
String escaped = ((EscapedIdentifierContext) context).getText();
return escaped.substring(1, escaped.length() - 1);
}

// This is normally unreachable, but might happen if the parser is in an error state or if the
// grammar is updated and not handled here.
exprFactory.reportError(context, "unsupported identifier");
return "";
}

private CelExpr.CelStruct.Builder visitStructFields(FieldInitializerListContext context) {
if (context == null
|| context.cols == null
Expand All@@ -692,10 +728,10 @@ private CelExpr.CelStruct.Builder visitStructFields(FieldInitializerListContext
}

// The field may be empty due to a prior error.
if (fieldContext.IDENTIFIER() == null) {
if (fieldContext.escapeIdent() == null) {
return CelExpr.CelStruct.newBuilder();
}
String fieldName = fieldContext.IDENTIFIER().getText();
String fieldName = normalizeEscapedIdent(fieldContext.escapeIdent());

CelExpr.CelStruct.Entry.Builder exprBuilder =
CelExpr.CelStruct.Entry.newBuilder()
Expand DownExpand Up@@ -872,7 +908,7 @@ private CelExpr receiverCallOrMacro(MemberCallContext context, String id, CelExp
return macroOrCall(context.args, context.open, id, Optional.of(member), true);
}

private CelExpr globalCallOrMacro(IdentOrGlobalCallContext context, String id) {
private CelExpr globalCallOrMacro(GlobalCallContext context, String id) {
return macroOrCall(context.args, context.op, id, Optional.empty(), false);
}

Expand Down
36 changes: 22 additions & 14 deletions parser/src/main/java/dev/cel/parser/gen/CEL.g4
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
// 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.

grammar CEL;

// Grammar Rules
Expand DownExpand Up@@ -44,26 +45,27 @@ calc
;

unary
: member # MemberExpr
| (ops+='!')+ member # LogicalNot
| (ops+='-')+ member # Negate
: member # MemberExpr
| (ops+='!')+ member # LogicalNot
| (ops+='-')+ member # Negate
;

member
: primary # PrimaryExpr
| member op='.' (opt='?')? id=IDENTIFIER # Select
| member op='.' id=IDENTIFIER open='(' args=exprList? ')' # MemberCall
| member op='[' (opt='?')? index=expr ']' # Index
: primary # PrimaryExpr
| member op='.' (opt='?')? id=escapeIdent # Select
| member op='.' id=IDENTIFIER open='(' args=exprList? ')' # MemberCall
| member op='[' (opt='?')? index=expr ']' # Index
;

primary
: leadingDot='.'? id=IDENTIFIER (op='(' args=exprList? ')')? # IdentOrGlobalCall
| '(' e=expr ')' # Nested
| op='[' elems=listInit? ','? ']' # CreateList
| op='{' entries=mapInitializerList? ','? '}' # CreateMap
: leadingDot='.'? id=IDENTIFIER # Ident
| leadingDot='.'? id=IDENTIFIER (op='(' args=exprList? ')') # GlobalCall
| '(' e=expr ')' # Nested
| op='[' elems=listInit? ','? ']' # CreateList
| op='{' entries=mapInitializerList? ','? '}' # CreateMap
| leadingDot='.'? ids+=IDENTIFIER (ops+='.' ids+=IDENTIFIER)*
op='{' entries=fieldInitializerList? ','? '}' # CreateMessage
| literal # ConstantLiteral
op='{' entries=fieldInitializerList? ','? '}' # CreateMessage
| literal # ConstantLiteral
;

exprList
Expand All@@ -79,13 +81,18 @@ fieldInitializerList
;

optField
: (opt='?')? IDENTIFIER
: (opt='?')? escapeIdent
;

mapInitializerList
: keys+=optExpr cols+=':' values+=expr (',' keys+=optExpr cols+=':' values+=expr)*
;

escapeIdent
: id=IDENTIFIER # SimpleIdentifier
| id=ESC_IDENTIFIER # EscapedIdentifier
;

optExpr
: (opt='?')? e=expr
;
Expand DownExpand Up@@ -197,3 +204,4 @@ STRING
BYTES : ('b' | 'B') STRING;

IDENTIFIER : (LETTER | '_') ( LETTER | DIGIT | '_')*;
ESC_IDENTIFIER : '`' (LETTER | DIGIT | '_' | '.' | '-' | '/' | ' ')+ '`';
Original file line numberDiff line numberDiff line change
Expand Up@@ -205,6 +205,18 @@ public void parser() {
.setOptions(CelOptions.current().enableReservedIds(false).build())
.build(),
"while");
CelParser parserWithQuotedFields =
CelParserImpl.newBuilder()
.setOptions(CelOptions.current().enableQuotedIdentifierSyntax(true).build())
.build();
runTest(parserWithQuotedFields, "foo.`bar`");
runTest(parserWithQuotedFields, "foo.`bar-baz`");
runTest(parserWithQuotedFields, "foo.`bar baz`");
runTest(parserWithQuotedFields, "foo.`bar.baz`");
runTest(parserWithQuotedFields, "foo.`bar/baz`");
runTest(parserWithQuotedFields, "foo.`bar_baz`");
runTest(parserWithQuotedFields, "foo.`in`");
runTest(parserWithQuotedFields, "Struct{`in`: false}");
}

@Test
Expand DownExpand Up@@ -273,6 +285,21 @@ public void parser_errors() {
runTest(parserWithoutOptionalSupport, "a.?b && a[?b]");
runTest(parserWithoutOptionalSupport, "Msg{?field: value} && {?'key': value}");
runTest(parserWithoutOptionalSupport, "[?a, ?b]");

CelParser parserWithQuotedFields =
CelParserImpl.newBuilder()
.setOptions(CelOptions.current().enableQuotedIdentifierSyntax(true).build())
.build();
runTest(parserWithQuotedFields, "`bar`");
runTest(parserWithQuotedFields, "foo.``");
runTest(parserWithQuotedFields, "foo.`$bar`");

CelParser parserWithoutQuotedFields =
CelParserImpl.newBuilder()
.setOptions(CelOptions.current().enableQuotedIdentifierSyntax(false).build())
.build();
runTest(parserWithoutQuotedFields, "foo.`bar`");
runTest(parserWithoutQuotedFields, "Struct{`bar`: false}");
}

@Test
Expand Down
16 changes: 15 additions & 1 deletion parser/src/test/java/dev/cel/parser/CelUnparserImplTest.java
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,11 @@ public final class CelUnparserImplTest {

private final CelParser parser =
CelParserImpl.newBuilder()
.setOptions(CelOptions.newBuilder().populateMacroCalls(true).build())
.setOptions(
CelOptions.newBuilder()
.enableQuotedIdentifierSyntax(true)
.populateMacroCalls(true)
.build())
.addLibraries(CelOptionalLibrary.INSTANCE)
.setStandardMacros(CelStandardMacro.STANDARD_MACROS)
.build();
Expand DownExpand Up@@ -99,6 +103,15 @@ public List<String> provideValues(Context context) {
"a ? (b1 || b2) : (c1 && c2)",
"(a ? b : c).method(d)",
"a + b + c + d",
"foo.`a.b`",
"foo.`a/b`",
"foo.`a-b`",
"foo.`a b`",
"foo.`in`",
"Foo{`a.b`: foo}",
"Foo{`a/b`: foo}",
"Foo{`a-b`: foo}",
"Foo{`a b`: foo}",

// Constants
"true",
Expand DownExpand Up@@ -140,6 +153,7 @@ public List<String> provideValues(Context context) {

// Macros
"has(x[\"a\"].single_int32)",
"has(x.`foo-bar`.single_int32)",

// This is a filter expression but is decompiled back to
// map(x, filter_function, x) for which the evaluation is
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
13 changes: 13 additions & 0 deletions common/src/main/java/dev/cel/common/CelOptions.java
Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,8 @@ public enum ProtoUnsetFieldOptions {

public abstract boolean enableHiddenAccumulatorVar();

public abstract boolean enableQuotedIdentifierSyntax();

// Type-Checker related options

public abstract boolean enableCompileTimeOverloadResolution();
Expand DownExpand Up@@ -191,6 +193,7 @@ public static Builder newBuilder() {
.retainRepeatedUnaryOperators(false)
.retainUnbalancedLogicalExpressions(false)
.enableHiddenAccumulatorVar(false)
.enableQuotedIdentifierSyntax(false)
// Type-Checker options
.enableCompileTimeOverloadResolution(false)
.enableHomogeneousLiterals(false)
Expand DownExpand Up@@ -332,6 +335,16 @@ public abstract static class Builder {
*/
public abstract Builder enableHiddenAccumulatorVar(boolean value);

/**
* Enable quoted identifier syntax.
*
* <p>This enables the use of quoted identifier syntax when parsing CEL expressions. When
* enabled, the parser will accept identifiers that are surrounded by backticks (`) and will
* treat them as a single identifier. Currently, this is only supported for field specifiers
* over a limited character set.
*/
public abstract Builder enableQuotedIdentifierSyntax(boolean value);

// Type-Checker related options

/**
Expand Down
2 changes: 2 additions & 0 deletions parser/src/main/java/dev/cel/parser/BUILD.bazel
Original file line numberDiff line numberDiff line change
Expand Up@@ -127,6 +127,8 @@ java_library(
"//common",
"//common/ast",
"//common/ast:cel_expr_visitor",
"@maven//:com_google_guava_guava",
"@maven//:com_google_protobuf_protobuf_java",
"@maven//:com_google_re2j_re2j",
],
)
18 changes: 16 additions & 2 deletions parser/src/main/java/dev/cel/parser/CelUnparserVisitor.java
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,9 @@
// limitations under the License.
package dev.cel.parser;

import com.google.common.collect.ImmutableSet;
import com.google.protobuf.ByteString;
import com.google.re2j.Pattern;
import dev.cel.common.CelAbstractSyntaxTree;
import dev.cel.common.CelSource;
import dev.cel.common.ast.CelConstant;
Expand DownExpand Up@@ -43,6 +45,10 @@ public class CelUnparserVisitor extends CelExprVisitor {
protected static final String RIGHT_BRACE = "}";
protected static final String COLON = ":";
protected static final String QUESTION_MARK = "?";
protected static final String BACKTICK = "`";
private static final Pattern IDENTIFIER_SEGMENT_PATTERN =
Pattern.compile("[a-zA-Z_][a-zA-Z0-9_]*");
private static final ImmutableSet<String> RESTRICTED_FIELD_NAMES = ImmutableSet.of("in");

protected final CelAbstractSyntaxTree ast;
protected final CelSource sourceInfo;
Expand All@@ -60,6 +66,14 @@ public String unparse() {
return stringBuilder.toString();
}

private static String maybeQuoteField(String field) {
if (RESTRICTED_FIELD_NAMES.contains(field)
|| !IDENTIFIER_SEGMENT_PATTERN.matcher(field).matches()) {
return BACKTICK + field + BACKTICK;
}
return field;
}

@Override
public void visit(CelExpr expr) {
if (sourceInfo.getMacroCalls().containsKey(expr.id())) {
Expand DownExpand Up@@ -191,7 +205,7 @@ protected void visit(CelExpr expr, CelStruct struct) {
if (e.optionalEntry()) {
stringBuilder.append(QUESTION_MARK);
}
stringBuilder.append(e.fieldKey());
stringBuilder.append(maybeQuoteField(e.fieldKey()));
stringBuilder.append(COLON).append(SPACE);
visit(e.value());
}
Expand DownExpand Up@@ -263,7 +277,7 @@ private void visitSelect(CelExpr operand, boolean testOnly, String op, String fi
}
boolean nested = !testOnly && isBinaryOrTernaryOperator(operand);
visitMaybeNested(operand, nested);
stringBuilder.append(op).append(field);
stringBuilder.append(op).append(maybeQuoteField(field));
if (testOnly) {
stringBuilder.append(RIGHT_PAREN);
}
Expand Down
58 changes: 47 additions & 11 deletions parser/src/main/java/dev/cel/parser/Parser.java
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,10 +33,13 @@
import cel.parser.internal.CELParser.CreateMapContext;
import cel.parser.internal.CELParser.CreateMessageContext;
import cel.parser.internal.CELParser.DoubleContext;
import cel.parser.internal.CELParser.EscapeIdentContext;
import cel.parser.internal.CELParser.EscapedIdentifierContext;
import cel.parser.internal.CELParser.ExprContext;
import cel.parser.internal.CELParser.ExprListContext;
import cel.parser.internal.CELParser.FieldInitializerListContext;
import cel.parser.internal.CELParser.IdentOrGlobalCallContext;
import cel.parser.internal.CELParser.GlobalCallContext;
import cel.parser.internal.CELParser.IdentContext;
import cel.parser.internal.CELParser.IndexContext;
import cel.parser.internal.CELParser.IntContext;
import cel.parser.internal.CELParser.ListInitContext;
Expand All@@ -52,6 +55,7 @@
import cel.parser.internal.CELParser.PrimaryExprContext;
import cel.parser.internal.CELParser.RelationContext;
import cel.parser.internal.CELParser.SelectContext;
import cel.parser.internal.CELParser.SimpleIdentifierContext;
import cel.parser.internal.CELParser.StartContext;
import cel.parser.internal.CELParser.StringContext;
import cel.parser.internal.CELParser.UintContext;
Expand DownExpand Up@@ -438,7 +442,7 @@ public CelExpr visitSelect(SelectContext context) {
if (context.id == null) {
return exprFactory.newExprBuilder(context).build();
}
String id = context.id.getText();
String id = normalizeEscapedIdent(context.id);

if (context.opt != null && context.opt.getText().equals("?")) {
if (!options.enableOptionalSyntax()) {
Expand DownExpand Up@@ -535,7 +539,7 @@ public CelExpr visitCreateMessage(CreateMessageContext context) {
}

@Override
public CelExpr visitIdentOrGlobalCall(IdentOrGlobalCallContext context) {
public CelExpr visitIdent(IdentContext context) {
checkNotNull(context);
if (context.id == null) {
return exprFactory.newExprBuilder(context).build();
Expand All@@ -547,11 +551,25 @@ public CelExpr visitIdentOrGlobalCall(IdentOrGlobalCallContext context) {
if (context.leadingDot != null) {
id = "." + id;
}
if (context.op == null) {
return exprFactory
.newExprBuilder(context.id)
.setIdent(CelExpr.CelIdent.newBuilder().setName(id).build())
.build();

return exprFactory
.newExprBuilder(context.id)
.setIdent(CelExpr.CelIdent.newBuilder().setName(id).build())
.build();
}

@Override
public CelExpr visitGlobalCall(GlobalCallContext context) {
checkNotNull(context);
if (context.id == null) {
return exprFactory.newExprBuilder(context).build();
}
String id = context.id.getText();
if (options.enableReservedIds() && RESERVED_IDS.contains(id)) {
return exprFactory.reportError(context, "reserved identifier: %s", id);
}
if (context.leadingDot != null) {
id = "." + id;
}

return globalCallOrMacro(context, id);
Expand DownExpand Up@@ -671,6 +689,24 @@ private Optional<CelExpr> visitMacro(
return expandedMacro;
}

private String normalizeEscapedIdent(EscapeIdentContext context) {
if (context instanceof SimpleIdentifierContext) {
return ((SimpleIdentifierContext) context).getText();
} else if (context instanceof EscapedIdentifierContext) {
if (!options.enableQuotedIdentifierSyntax()) {
exprFactory.reportError(context, "unsupported syntax '`'");
return "";
}
String escaped = ((EscapedIdentifierContext) context).getText();
return escaped.substring(1, escaped.length() - 1);
}

// This is normally unreachable, but might happen if the parser is in an error state or if the
// grammar is updated and not handled here.
exprFactory.reportError(context, "unsupported identifier");
return "";
}

private CelExpr.CelStruct.Builder visitStructFields(FieldInitializerListContext context) {
if (context == null
|| context.cols == null
Expand All@@ -692,10 +728,10 @@ private CelExpr.CelStruct.Builder visitStructFields(FieldInitializerListContext
}

// The field may be empty due to a prior error.
if (fieldContext.IDENTIFIER() == null) {
if (fieldContext.escapeIdent() == null) {
return CelExpr.CelStruct.newBuilder();
}
String fieldName = fieldContext.IDENTIFIER().getText();
String fieldName = normalizeEscapedIdent(fieldContext.escapeIdent());

CelExpr.CelStruct.Entry.Builder exprBuilder =
CelExpr.CelStruct.Entry.newBuilder()
Expand DownExpand Up@@ -872,7 +908,7 @@ private CelExpr receiverCallOrMacro(MemberCallContext context, String id, CelExp
return macroOrCall(context.args, context.open, id, Optional.of(member), true);
}

private CelExpr globalCallOrMacro(IdentOrGlobalCallContext context, String id) {
private CelExpr globalCallOrMacro(GlobalCallContext context, String id) {
return macroOrCall(context.args, context.op, id, Optional.empty(), false);
}

Expand Down
36 changes: 22 additions & 14 deletions parser/src/main/java/dev/cel/parser/gen/CEL.g4
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
// 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.

grammar CEL;

// Grammar Rules
Expand DownExpand Up@@ -44,26 +45,27 @@ calc
;

unary
: member # MemberExpr
| (ops+='!')+ member # LogicalNot
| (ops+='-')+ member # Negate
: member # MemberExpr
| (ops+='!')+ member # LogicalNot
| (ops+='-')+ member # Negate
;

member
: primary # PrimaryExpr
| member op='.' (opt='?')? id=IDENTIFIER # Select
| member op='.' id=IDENTIFIER open='(' args=exprList? ')' # MemberCall
| member op='[' (opt='?')? index=expr ']' # Index
: primary # PrimaryExpr
| member op='.' (opt='?')? id=escapeIdent # Select
| member op='.' id=IDENTIFIER open='(' args=exprList? ')' # MemberCall
| member op='[' (opt='?')? index=expr ']' # Index
;

primary
: leadingDot='.'? id=IDENTIFIER (op='(' args=exprList? ')')? # IdentOrGlobalCall
| '(' e=expr ')' # Nested
| op='[' elems=listInit? ','? ']' # CreateList
| op='{' entries=mapInitializerList? ','? '}' # CreateMap
: leadingDot='.'? id=IDENTIFIER # Ident
| leadingDot='.'? id=IDENTIFIER (op='(' args=exprList? ')') # GlobalCall
| '(' e=expr ')' # Nested
| op='[' elems=listInit? ','? ']' # CreateList
| op='{' entries=mapInitializerList? ','? '}' # CreateMap
| leadingDot='.'? ids+=IDENTIFIER (ops+='.' ids+=IDENTIFIER)*
op='{' entries=fieldInitializerList? ','? '}' # CreateMessage
| literal # ConstantLiteral
op='{' entries=fieldInitializerList? ','? '}' # CreateMessage
| literal # ConstantLiteral
;

exprList
Expand All@@ -79,13 +81,18 @@ fieldInitializerList
;

optField
: (opt='?')? IDENTIFIER
: (opt='?')? escapeIdent
;

mapInitializerList
: keys+=optExpr cols+=':' values+=expr (',' keys+=optExpr cols+=':' values+=expr)*
;

escapeIdent
: id=IDENTIFIER # SimpleIdentifier
| id=ESC_IDENTIFIER # EscapedIdentifier
;

optExpr
: (opt='?')? e=expr
;
Expand DownExpand Up@@ -197,3 +204,4 @@ STRING
BYTES : ('b' | 'B') STRING;

IDENTIFIER : (LETTER | '_') ( LETTER | DIGIT | '_')*;
ESC_IDENTIFIER : '`' (LETTER | DIGIT | '_' | '.' | '-' | '/' | ' ')+ '`';
Original file line numberDiff line numberDiff line change
Expand Up@@ -205,6 +205,18 @@ public void parser() {
.setOptions(CelOptions.current().enableReservedIds(false).build())
.build(),
"while");
CelParser parserWithQuotedFields =
CelParserImpl.newBuilder()
.setOptions(CelOptions.current().enableQuotedIdentifierSyntax(true).build())
.build();
runTest(parserWithQuotedFields, "foo.`bar`");
runTest(parserWithQuotedFields, "foo.`bar-baz`");
runTest(parserWithQuotedFields, "foo.`bar baz`");
runTest(parserWithQuotedFields, "foo.`bar.baz`");
runTest(parserWithQuotedFields, "foo.`bar/baz`");
runTest(parserWithQuotedFields, "foo.`bar_baz`");
runTest(parserWithQuotedFields, "foo.`in`");
runTest(parserWithQuotedFields, "Struct{`in`: false}");
}

@Test
Expand DownExpand Up@@ -273,6 +285,21 @@ public void parser_errors() {
runTest(parserWithoutOptionalSupport, "a.?b && a[?b]");
runTest(parserWithoutOptionalSupport, "Msg{?field: value} && {?'key': value}");
runTest(parserWithoutOptionalSupport, "[?a, ?b]");

CelParser parserWithQuotedFields =
CelParserImpl.newBuilder()
.setOptions(CelOptions.current().enableQuotedIdentifierSyntax(true).build())
.build();
runTest(parserWithQuotedFields, "`bar`");
runTest(parserWithQuotedFields, "foo.``");
runTest(parserWithQuotedFields, "foo.`$bar`");

CelParser parserWithoutQuotedFields =
CelParserImpl.newBuilder()
.setOptions(CelOptions.current().enableQuotedIdentifierSyntax(false).build())
.build();
runTest(parserWithoutQuotedFields, "foo.`bar`");
runTest(parserWithoutQuotedFields, "Struct{`bar`: false}");
}

@Test
Expand Down
16 changes: 15 additions & 1 deletion parser/src/test/java/dev/cel/parser/CelUnparserImplTest.java
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,11 @@ public final class CelUnparserImplTest {

private final CelParser parser =
CelParserImpl.newBuilder()
.setOptions(CelOptions.newBuilder().populateMacroCalls(true).build())
.setOptions(
CelOptions.newBuilder()
.enableQuotedIdentifierSyntax(true)
.populateMacroCalls(true)
.build())
.addLibraries(CelOptionalLibrary.INSTANCE)
.setStandardMacros(CelStandardMacro.STANDARD_MACROS)
.build();
Expand DownExpand Up@@ -99,6 +103,15 @@ public List<String> provideValues(Context context) {
"a ? (b1 || b2) : (c1 && c2)",
"(a ? b : c).method(d)",
"a + b + c + d",
"foo.`a.b`",
"foo.`a/b`",
"foo.`a-b`",
"foo.`a b`",
"foo.`in`",
"Foo{`a.b`: foo}",
"Foo{`a/b`: foo}",
"Foo{`a-b`: foo}",
"Foo{`a b`: foo}",

// Constants
"true",
Expand DownExpand Up@@ -140,6 +153,7 @@ public List<String> provideValues(Context context) {

// Macros
"has(x[\"a\"].single_int32)",
"has(x.`foo-bar`.single_int32)",

// This is a filter expression but is decompiled back to
// map(x, filter_function, x) for which the evaluation is
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
13 changes: 13 additions & 0 deletions common/src/main/java/dev/cel/common/CelOptions.java
Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,8 @@ public enum ProtoUnsetFieldOptions {

public abstract boolean enableHiddenAccumulatorVar();

public abstract boolean enableQuotedIdentifierSyntax();

// Type-Checker related options

public abstract boolean enableCompileTimeOverloadResolution();
Expand DownExpand Up@@ -191,6 +193,7 @@ public static Builder newBuilder() {
.retainRepeatedUnaryOperators(false)
.retainUnbalancedLogicalExpressions(false)
.enableHiddenAccumulatorVar(false)
.enableQuotedIdentifierSyntax(false)
// Type-Checker options
.enableCompileTimeOverloadResolution(false)
.enableHomogeneousLiterals(false)
Expand DownExpand Up@@ -332,6 +335,16 @@ public abstract static class Builder {
*/
public abstract Builder enableHiddenAccumulatorVar(boolean value);

/**
* Enable quoted identifier syntax.
*
* <p>This enables the use of quoted identifier syntax when parsing CEL expressions. When
* enabled, the parser will accept identifiers that are surrounded by backticks (`) and will
* treat them as a single identifier. Currently, this is only supported for field specifiers
* over a limited character set.
*/
public abstract Builder enableQuotedIdentifierSyntax(boolean value);

// Type-Checker related options

/**
Expand Down
2 changes: 2 additions & 0 deletions parser/src/main/java/dev/cel/parser/BUILD.bazel
Original file line numberDiff line numberDiff line change
Expand Up@@ -127,6 +127,8 @@ java_library(
"//common",
"//common/ast",
"//common/ast:cel_expr_visitor",
"@maven//:com_google_guava_guava",
"@maven//:com_google_protobuf_protobuf_java",
"@maven//:com_google_re2j_re2j",
],
)
18 changes: 16 additions & 2 deletions parser/src/main/java/dev/cel/parser/CelUnparserVisitor.java
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,9 @@
// limitations under the License.
package dev.cel.parser;

import com.google.common.collect.ImmutableSet;
import com.google.protobuf.ByteString;
import com.google.re2j.Pattern;
import dev.cel.common.CelAbstractSyntaxTree;
import dev.cel.common.CelSource;
import dev.cel.common.ast.CelConstant;
Expand DownExpand Up@@ -43,6 +45,10 @@ public class CelUnparserVisitor extends CelExprVisitor {
protected static final String RIGHT_BRACE = "}";
protected static final String COLON = ":";
protected static final String QUESTION_MARK = "?";
protected static final String BACKTICK = "`";
private static final Pattern IDENTIFIER_SEGMENT_PATTERN =
Pattern.compile("[a-zA-Z_][a-zA-Z0-9_]*");
private static final ImmutableSet<String> RESTRICTED_FIELD_NAMES = ImmutableSet.of("in");

protected final CelAbstractSyntaxTree ast;
protected final CelSource sourceInfo;
Expand All@@ -60,6 +66,14 @@ public String unparse() {
return stringBuilder.toString();
}

private static String maybeQuoteField(String field) {
if (RESTRICTED_FIELD_NAMES.contains(field)
|| !IDENTIFIER_SEGMENT_PATTERN.matcher(field).matches()) {
return BACKTICK + field + BACKTICK;
}
return field;
}

@Override
public void visit(CelExpr expr) {
if (sourceInfo.getMacroCalls().containsKey(expr.id())) {
Expand DownExpand Up@@ -191,7 +205,7 @@ protected void visit(CelExpr expr, CelStruct struct) {
if (e.optionalEntry()) {
stringBuilder.append(QUESTION_MARK);
}
stringBuilder.append(e.fieldKey());
stringBuilder.append(maybeQuoteField(e.fieldKey()));
stringBuilder.append(COLON).append(SPACE);
visit(e.value());
}
Expand DownExpand Up@@ -263,7 +277,7 @@ private void visitSelect(CelExpr operand, boolean testOnly, String op, String fi
}
boolean nested = !testOnly && isBinaryOrTernaryOperator(operand);
visitMaybeNested(operand, nested);
stringBuilder.append(op).append(field);
stringBuilder.append(op).append(maybeQuoteField(field));
if (testOnly) {
stringBuilder.append(RIGHT_PAREN);
}
Expand Down
58 changes: 47 additions & 11 deletions parser/src/main/java/dev/cel/parser/Parser.java
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,10 +33,13 @@
import cel.parser.internal.CELParser.CreateMapContext;
import cel.parser.internal.CELParser.CreateMessageContext;
import cel.parser.internal.CELParser.DoubleContext;
import cel.parser.internal.CELParser.EscapeIdentContext;
import cel.parser.internal.CELParser.EscapedIdentifierContext;
import cel.parser.internal.CELParser.ExprContext;
import cel.parser.internal.CELParser.ExprListContext;
import cel.parser.internal.CELParser.FieldInitializerListContext;
import cel.parser.internal.CELParser.IdentOrGlobalCallContext;
import cel.parser.internal.CELParser.GlobalCallContext;
import cel.parser.internal.CELParser.IdentContext;
import cel.parser.internal.CELParser.IndexContext;
import cel.parser.internal.CELParser.IntContext;
import cel.parser.internal.CELParser.ListInitContext;
Expand All@@ -52,6 +55,7 @@
import cel.parser.internal.CELParser.PrimaryExprContext;
import cel.parser.internal.CELParser.RelationContext;
import cel.parser.internal.CELParser.SelectContext;
import cel.parser.internal.CELParser.SimpleIdentifierContext;
import cel.parser.internal.CELParser.StartContext;
import cel.parser.internal.CELParser.StringContext;
import cel.parser.internal.CELParser.UintContext;
Expand DownExpand Up@@ -438,7 +442,7 @@ public CelExpr visitSelect(SelectContext context) {
if (context.id == null) {
return exprFactory.newExprBuilder(context).build();
}
String id = context.id.getText();
String id = normalizeEscapedIdent(context.id);

if (context.opt != null && context.opt.getText().equals("?")) {
if (!options.enableOptionalSyntax()) {
Expand DownExpand Up@@ -535,7 +539,7 @@ public CelExpr visitCreateMessage(CreateMessageContext context) {
}

@Override
public CelExpr visitIdentOrGlobalCall(IdentOrGlobalCallContext context) {
public CelExpr visitIdent(IdentContext context) {
checkNotNull(context);
if (context.id == null) {
return exprFactory.newExprBuilder(context).build();
Expand All@@ -547,11 +551,25 @@ public CelExpr visitIdentOrGlobalCall(IdentOrGlobalCallContext context) {
if (context.leadingDot != null) {
id = "." + id;
}
if (context.op == null) {
return exprFactory
.newExprBuilder(context.id)
.setIdent(CelExpr.CelIdent.newBuilder().setName(id).build())
.build();

return exprFactory
.newExprBuilder(context.id)
.setIdent(CelExpr.CelIdent.newBuilder().setName(id).build())
.build();
}

@Override
public CelExpr visitGlobalCall(GlobalCallContext context) {
checkNotNull(context);
if (context.id == null) {
return exprFactory.newExprBuilder(context).build();
}
String id = context.id.getText();
if (options.enableReservedIds() && RESERVED_IDS.contains(id)) {
return exprFactory.reportError(context, "reserved identifier: %s", id);
}
if (context.leadingDot != null) {
id = "." + id;
}

return globalCallOrMacro(context, id);
Expand DownExpand Up@@ -671,6 +689,24 @@ private Optional<CelExpr> visitMacro(
return expandedMacro;
}

private String normalizeEscapedIdent(EscapeIdentContext context) {
if (context instanceof SimpleIdentifierContext) {
return ((SimpleIdentifierContext) context).getText();
} else if (context instanceof EscapedIdentifierContext) {
if (!options.enableQuotedIdentifierSyntax()) {
exprFactory.reportError(context, "unsupported syntax '`'");
return "";
}
String escaped = ((EscapedIdentifierContext) context).getText();
return escaped.substring(1, escaped.length() - 1);
}

// This is normally unreachable, but might happen if the parser is in an error state or if the
// grammar is updated and not handled here.
exprFactory.reportError(context, "unsupported identifier");
return "";
}

private CelExpr.CelStruct.Builder visitStructFields(FieldInitializerListContext context) {
if (context == null
|| context.cols == null
Expand All@@ -692,10 +728,10 @@ private CelExpr.CelStruct.Builder visitStructFields(FieldInitializerListContext
}

// The field may be empty due to a prior error.
if (fieldContext.IDENTIFIER() == null) {
if (fieldContext.escapeIdent() == null) {
return CelExpr.CelStruct.newBuilder();
}
String fieldName = fieldContext.IDENTIFIER().getText();
String fieldName = normalizeEscapedIdent(fieldContext.escapeIdent());

CelExpr.CelStruct.Entry.Builder exprBuilder =
CelExpr.CelStruct.Entry.newBuilder()
Expand DownExpand Up@@ -872,7 +908,7 @@ private CelExpr receiverCallOrMacro(MemberCallContext context, String id, CelExp
return macroOrCall(context.args, context.open, id, Optional.of(member), true);
}

private CelExpr globalCallOrMacro(IdentOrGlobalCallContext context, String id) {
private CelExpr globalCallOrMacro(GlobalCallContext context, String id) {
return macroOrCall(context.args, context.op, id, Optional.empty(), false);
}

Expand Down
36 changes: 22 additions & 14 deletions parser/src/main/java/dev/cel/parser/gen/CEL.g4
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
// 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.

grammar CEL;

// Grammar Rules
Expand DownExpand Up@@ -44,26 +45,27 @@ calc
;

unary
: member # MemberExpr
| (ops+='!')+ member # LogicalNot
| (ops+='-')+ member # Negate
: member # MemberExpr
| (ops+='!')+ member # LogicalNot
| (ops+='-')+ member # Negate
;

member
: primary # PrimaryExpr
| member op='.' (opt='?')? id=IDENTIFIER # Select
| member op='.' id=IDENTIFIER open='(' args=exprList? ')' # MemberCall
| member op='[' (opt='?')? index=expr ']' # Index
: primary # PrimaryExpr
| member op='.' (opt='?')? id=escapeIdent # Select
| member op='.' id=IDENTIFIER open='(' args=exprList? ')' # MemberCall
| member op='[' (opt='?')? index=expr ']' # Index
;

primary
: leadingDot='.'? id=IDENTIFIER (op='(' args=exprList? ')')? # IdentOrGlobalCall
| '(' e=expr ')' # Nested
| op='[' elems=listInit? ','? ']' # CreateList
| op='{' entries=mapInitializerList? ','? '}' # CreateMap
: leadingDot='.'? id=IDENTIFIER # Ident
| leadingDot='.'? id=IDENTIFIER (op='(' args=exprList? ')') # GlobalCall
| '(' e=expr ')' # Nested
| op='[' elems=listInit? ','? ']' # CreateList
| op='{' entries=mapInitializerList? ','? '}' # CreateMap
| leadingDot='.'? ids+=IDENTIFIER (ops+='.' ids+=IDENTIFIER)*
op='{' entries=fieldInitializerList? ','? '}' # CreateMessage
| literal # ConstantLiteral
op='{' entries=fieldInitializerList? ','? '}' # CreateMessage
| literal # ConstantLiteral
;

exprList
Expand All@@ -79,13 +81,18 @@ fieldInitializerList
;

optField
: (opt='?')? IDENTIFIER
: (opt='?')? escapeIdent
;

mapInitializerList
: keys+=optExpr cols+=':' values+=expr (',' keys+=optExpr cols+=':' values+=expr)*
;

escapeIdent
: id=IDENTIFIER # SimpleIdentifier
| id=ESC_IDENTIFIER # EscapedIdentifier
;

optExpr
: (opt='?')? e=expr
;
Expand DownExpand Up@@ -197,3 +204,4 @@ STRING
BYTES : ('b' | 'B') STRING;

IDENTIFIER : (LETTER | '_') ( LETTER | DIGIT | '_')*;
ESC_IDENTIFIER : '`' (LETTER | DIGIT | '_' | '.' | '-' | '/' | ' ')+ '`';
Original file line numberDiff line numberDiff line change
Expand Up@@ -205,6 +205,18 @@ public void parser() {
.setOptions(CelOptions.current().enableReservedIds(false).build())
.build(),
"while");
CelParser parserWithQuotedFields =
CelParserImpl.newBuilder()
.setOptions(CelOptions.current().enableQuotedIdentifierSyntax(true).build())
.build();
runTest(parserWithQuotedFields, "foo.`bar`");
runTest(parserWithQuotedFields, "foo.`bar-baz`");
runTest(parserWithQuotedFields, "foo.`bar baz`");
runTest(parserWithQuotedFields, "foo.`bar.baz`");
runTest(parserWithQuotedFields, "foo.`bar/baz`");
runTest(parserWithQuotedFields, "foo.`bar_baz`");
runTest(parserWithQuotedFields, "foo.`in`");
runTest(parserWithQuotedFields, "Struct{`in`: false}");
}

@Test
Expand DownExpand Up@@ -273,6 +285,21 @@ public void parser_errors() {
runTest(parserWithoutOptionalSupport, "a.?b && a[?b]");
runTest(parserWithoutOptionalSupport, "Msg{?field: value} && {?'key': value}");
runTest(parserWithoutOptionalSupport, "[?a, ?b]");

CelParser parserWithQuotedFields =
CelParserImpl.newBuilder()
.setOptions(CelOptions.current().enableQuotedIdentifierSyntax(true).build())
.build();
runTest(parserWithQuotedFields, "`bar`");
runTest(parserWithQuotedFields, "foo.``");
runTest(parserWithQuotedFields, "foo.`$bar`");

CelParser parserWithoutQuotedFields =
CelParserImpl.newBuilder()
.setOptions(CelOptions.current().enableQuotedIdentifierSyntax(false).build())
.build();
runTest(parserWithoutQuotedFields, "foo.`bar`");
runTest(parserWithoutQuotedFields, "Struct{`bar`: false}");
}

@Test
Expand Down
16 changes: 15 additions & 1 deletion parser/src/test/java/dev/cel/parser/CelUnparserImplTest.java
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,11 @@ public final class CelUnparserImplTest {

private final CelParser parser =
CelParserImpl.newBuilder()
.setOptions(CelOptions.newBuilder().populateMacroCalls(true).build())
.setOptions(
CelOptions.newBuilder()
.enableQuotedIdentifierSyntax(true)
.populateMacroCalls(true)
.build())
.addLibraries(CelOptionalLibrary.INSTANCE)
.setStandardMacros(CelStandardMacro.STANDARD_MACROS)
.build();
Expand DownExpand Up@@ -99,6 +103,15 @@ public List<String> provideValues(Context context) {
"a ? (b1 || b2) : (c1 && c2)",
"(a ? b : c).method(d)",
"a + b + c + d",
"foo.`a.b`",
"foo.`a/b`",
"foo.`a-b`",
"foo.`a b`",
"foo.`in`",
"Foo{`a.b`: foo}",
"Foo{`a/b`: foo}",
"Foo{`a-b`: foo}",
"Foo{`a b`: foo}",

// Constants
"true",
Expand DownExpand Up@@ -140,6 +153,7 @@ public List<String> provideValues(Context context) {

// Macros
"has(x[\"a\"].single_int32)",
"has(x.`foo-bar`.single_int32)",

// This is a filter expression but is decompiled back to
// map(x, filter_function, x) for which the evaluation is
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
13 changes: 13 additions & 0 deletions common/src/main/java/dev/cel/common/CelOptions.java
Original file line numberDiff line numberDiff line change
Expand Up@@ -69,6 +69,8 @@ public enum ProtoUnsetFieldOptions {

public abstract boolean enableHiddenAccumulatorVar();

public abstract boolean enableQuotedIdentifierSyntax();

// Type-Checker related options

public abstract boolean enableCompileTimeOverloadResolution();
Expand DownExpand Up@@ -191,6 +193,7 @@ public static Builder newBuilder() {
.retainRepeatedUnaryOperators(false)
.retainUnbalancedLogicalExpressions(false)
.enableHiddenAccumulatorVar(false)
.enableQuotedIdentifierSyntax(false)
// Type-Checker options
.enableCompileTimeOverloadResolution(false)
.enableHomogeneousLiterals(false)
Expand DownExpand Up@@ -332,6 +335,16 @@ public abstract static class Builder {
*/
public abstract Builder enableHiddenAccumulatorVar(boolean value);

/**
* Enable quoted identifier syntax.
*
* <p>This enables the use of quoted identifier syntax when parsing CEL expressions. When
* enabled, the parser will accept identifiers that are surrounded by backticks (`) and will
* treat them as a single identifier. Currently, this is only supported for field specifiers
* over a limited character set.
*/
public abstract Builder enableQuotedIdentifierSyntax(boolean value);

// Type-Checker related options

/**
Expand Down
2 changes: 2 additions & 0 deletions parser/src/main/java/dev/cel/parser/BUILD.bazel
Original file line numberDiff line numberDiff line change
Expand Up@@ -127,6 +127,8 @@ java_library(
"//common",
"//common/ast",
"//common/ast:cel_expr_visitor",
"@maven//:com_google_guava_guava",
"@maven//:com_google_protobuf_protobuf_java",
"@maven//:com_google_re2j_re2j",
],
)
18 changes: 16 additions & 2 deletions parser/src/main/java/dev/cel/parser/CelUnparserVisitor.java
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,9 @@
// limitations under the License.
package dev.cel.parser;

import com.google.common.collect.ImmutableSet;
import com.google.protobuf.ByteString;
import com.google.re2j.Pattern;
import dev.cel.common.CelAbstractSyntaxTree;
import dev.cel.common.CelSource;
import dev.cel.common.ast.CelConstant;
Expand DownExpand Up@@ -43,6 +45,10 @@ public class CelUnparserVisitor extends CelExprVisitor {
protected static final String RIGHT_BRACE = "}";
protected static final String COLON = ":";
protected static final String QUESTION_MARK = "?";
protected static final String BACKTICK = "`";
private static final Pattern IDENTIFIER_SEGMENT_PATTERN =
Pattern.compile("[a-zA-Z_][a-zA-Z0-9_]*");
private static final ImmutableSet<String> RESTRICTED_FIELD_NAMES = ImmutableSet.of("in");

protected final CelAbstractSyntaxTree ast;
protected final CelSource sourceInfo;
Expand All@@ -60,6 +66,14 @@ public String unparse() {
return stringBuilder.toString();
}

private static String maybeQuoteField(String field) {
if (RESTRICTED_FIELD_NAMES.contains(field)
|| !IDENTIFIER_SEGMENT_PATTERN.matcher(field).matches()) {
return BACKTICK + field + BACKTICK;
}
return field;
}

@Override
public void visit(CelExpr expr) {
if (sourceInfo.getMacroCalls().containsKey(expr.id())) {
Expand DownExpand Up@@ -191,7 +205,7 @@ protected void visit(CelExpr expr, CelStruct struct) {
if (e.optionalEntry()) {
stringBuilder.append(QUESTION_MARK);
}
stringBuilder.append(e.fieldKey());
stringBuilder.append(maybeQuoteField(e.fieldKey()));
stringBuilder.append(COLON).append(SPACE);
visit(e.value());
}
Expand DownExpand Up@@ -263,7 +277,7 @@ private void visitSelect(CelExpr operand, boolean testOnly, String op, String fi
}
boolean nested = !testOnly && isBinaryOrTernaryOperator(operand);
visitMaybeNested(operand, nested);
stringBuilder.append(op).append(field);
stringBuilder.append(op).append(maybeQuoteField(field));
if (testOnly) {
stringBuilder.append(RIGHT_PAREN);
}
Expand Down
58 changes: 47 additions & 11 deletions parser/src/main/java/dev/cel/parser/Parser.java
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,10 +33,13 @@
import cel.parser.internal.CELParser.CreateMapContext;
import cel.parser.internal.CELParser.CreateMessageContext;
import cel.parser.internal.CELParser.DoubleContext;
import cel.parser.internal.CELParser.EscapeIdentContext;
import cel.parser.internal.CELParser.EscapedIdentifierContext;
import cel.parser.internal.CELParser.ExprContext;
import cel.parser.internal.CELParser.ExprListContext;
import cel.parser.internal.CELParser.FieldInitializerListContext;
import cel.parser.internal.CELParser.IdentOrGlobalCallContext;
import cel.parser.internal.CELParser.GlobalCallContext;
import cel.parser.internal.CELParser.IdentContext;
import cel.parser.internal.CELParser.IndexContext;
import cel.parser.internal.CELParser.IntContext;
import cel.parser.internal.CELParser.ListInitContext;
Expand All@@ -52,6 +55,7 @@
import cel.parser.internal.CELParser.PrimaryExprContext;
import cel.parser.internal.CELParser.RelationContext;
import cel.parser.internal.CELParser.SelectContext;
import cel.parser.internal.CELParser.SimpleIdentifierContext;
import cel.parser.internal.CELParser.StartContext;
import cel.parser.internal.CELParser.StringContext;
import cel.parser.internal.CELParser.UintContext;
Expand DownExpand Up@@ -438,7 +442,7 @@ public CelExpr visitSelect(SelectContext context) {
if (context.id == null) {
return exprFactory.newExprBuilder(context).build();
}
String id = context.id.getText();
String id = normalizeEscapedIdent(context.id);

if (context.opt != null && context.opt.getText().equals("?")) {
if (!options.enableOptionalSyntax()) {
Expand DownExpand Up@@ -535,7 +539,7 @@ public CelExpr visitCreateMessage(CreateMessageContext context) {
}

@Override
public CelExpr visitIdentOrGlobalCall(IdentOrGlobalCallContext context) {
public CelExpr visitIdent(IdentContext context) {
checkNotNull(context);
if (context.id == null) {
return exprFactory.newExprBuilder(context).build();
Expand All@@ -547,11 +551,25 @@ public CelExpr visitIdentOrGlobalCall(IdentOrGlobalCallContext context) {
if (context.leadingDot != null) {
id = "." + id;
}
if (context.op == null) {
return exprFactory
.newExprBuilder(context.id)
.setIdent(CelExpr.CelIdent.newBuilder().setName(id).build())
.build();

return exprFactory
.newExprBuilder(context.id)
.setIdent(CelExpr.CelIdent.newBuilder().setName(id).build())
.build();
}

@Override
public CelExpr visitGlobalCall(GlobalCallContext context) {
checkNotNull(context);
if (context.id == null) {
return exprFactory.newExprBuilder(context).build();
}
String id = context.id.getText();
if (options.enableReservedIds() && RESERVED_IDS.contains(id)) {
return exprFactory.reportError(context, "reserved identifier: %s", id);
}
if (context.leadingDot != null) {
id = "." + id;
}

return globalCallOrMacro(context, id);
Expand DownExpand Up@@ -671,6 +689,24 @@ private Optional<CelExpr> visitMacro(
return expandedMacro;
}

private String normalizeEscapedIdent(EscapeIdentContext context) {
if (context instanceof SimpleIdentifierContext) {
return ((SimpleIdentifierContext) context).getText();
} else if (context instanceof EscapedIdentifierContext) {
if (!options.enableQuotedIdentifierSyntax()) {
exprFactory.reportError(context, "unsupported syntax '`'");
return "";
}
String escaped = ((EscapedIdentifierContext) context).getText();
return escaped.substring(1, escaped.length() - 1);
}

// This is normally unreachable, but might happen if the parser is in an error state or if the
// grammar is updated and not handled here.
exprFactory.reportError(context, "unsupported identifier");
return "";
}

private CelExpr.CelStruct.Builder visitStructFields(FieldInitializerListContext context) {
if (context == null
|| context.cols == null
Expand All@@ -692,10 +728,10 @@ private CelExpr.CelStruct.Builder visitStructFields(FieldInitializerListContext
}

// The field may be empty due to a prior error.
if (fieldContext.IDENTIFIER() == null) {
if (fieldContext.escapeIdent() == null) {
return CelExpr.CelStruct.newBuilder();
}
String fieldName = fieldContext.IDENTIFIER().getText();
String fieldName = normalizeEscapedIdent(fieldContext.escapeIdent());

CelExpr.CelStruct.Entry.Builder exprBuilder =
CelExpr.CelStruct.Entry.newBuilder()
Expand DownExpand Up@@ -872,7 +908,7 @@ private CelExpr receiverCallOrMacro(MemberCallContext context, String id, CelExp
return macroOrCall(context.args, context.open, id, Optional.of(member), true);
}

private CelExpr globalCallOrMacro(IdentOrGlobalCallContext context, String id) {
private CelExpr globalCallOrMacro(GlobalCallContext context, String id) {
return macroOrCall(context.args, context.op, id, Optional.empty(), false);
}

Expand Down
36 changes: 22 additions & 14 deletions parser/src/main/java/dev/cel/parser/gen/CEL.g4
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
// 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.

grammar CEL;

// Grammar Rules
Expand DownExpand Up@@ -44,26 +45,27 @@ calc
;

unary
: member # MemberExpr
| (ops+='!')+ member # LogicalNot
| (ops+='-')+ member # Negate
: member # MemberExpr
| (ops+='!')+ member # LogicalNot
| (ops+='-')+ member # Negate
;

member
: primary # PrimaryExpr
| member op='.' (opt='?')? id=IDENTIFIER # Select
| member op='.' id=IDENTIFIER open='(' args=exprList? ')' # MemberCall
| member op='[' (opt='?')? index=expr ']' # Index
: primary # PrimaryExpr
| member op='.' (opt='?')? id=escapeIdent # Select
| member op='.' id=IDENTIFIER open='(' args=exprList? ')' # MemberCall
| member op='[' (opt='?')? index=expr ']' # Index
;

primary
: leadingDot='.'? id=IDENTIFIER (op='(' args=exprList? ')')? # IdentOrGlobalCall
| '(' e=expr ')' # Nested
| op='[' elems=listInit? ','? ']' # CreateList
| op='{' entries=mapInitializerList? ','? '}' # CreateMap
: leadingDot='.'? id=IDENTIFIER # Ident
| leadingDot='.'? id=IDENTIFIER (op='(' args=exprList? ')') # GlobalCall
| '(' e=expr ')' # Nested
| op='[' elems=listInit? ','? ']' # CreateList
| op='{' entries=mapInitializerList? ','? '}' # CreateMap
| leadingDot='.'? ids+=IDENTIFIER (ops+='.' ids+=IDENTIFIER)*
op='{' entries=fieldInitializerList? ','? '}' # CreateMessage
| literal # ConstantLiteral
op='{' entries=fieldInitializerList? ','? '}' # CreateMessage
| literal # ConstantLiteral
;

exprList
Expand All@@ -79,13 +81,18 @@ fieldInitializerList
;

optField
: (opt='?')? IDENTIFIER
: (opt='?')? escapeIdent
;

mapInitializerList
: keys+=optExpr cols+=':' values+=expr (',' keys+=optExpr cols+=':' values+=expr)*
;

escapeIdent
: id=IDENTIFIER # SimpleIdentifier
| id=ESC_IDENTIFIER # EscapedIdentifier
;

optExpr
: (opt='?')? e=expr
;
Expand DownExpand Up@@ -197,3 +204,4 @@ STRING
BYTES : ('b' | 'B') STRING;

IDENTIFIER : (LETTER | '_') ( LETTER | DIGIT | '_')*;
ESC_IDENTIFIER : '`' (LETTER | DIGIT | '_' | '.' | '-' | '/' | ' ')+ '`';
Original file line numberDiff line numberDiff line change
Expand Up@@ -205,6 +205,18 @@ public void parser() {
.setOptions(CelOptions.current().enableReservedIds(false).build())
.build(),
"while");
CelParser parserWithQuotedFields =
CelParserImpl.newBuilder()
.setOptions(CelOptions.current().enableQuotedIdentifierSyntax(true).build())
.build();
runTest(parserWithQuotedFields, "foo.`bar`");
runTest(parserWithQuotedFields, "foo.`bar-baz`");
runTest(parserWithQuotedFields, "foo.`bar baz`");
runTest(parserWithQuotedFields, "foo.`bar.baz`");
runTest(parserWithQuotedFields, "foo.`bar/baz`");
runTest(parserWithQuotedFields, "foo.`bar_baz`");
runTest(parserWithQuotedFields, "foo.`in`");
runTest(parserWithQuotedFields, "Struct{`in`: false}");
}

@Test
Expand DownExpand Up@@ -273,6 +285,21 @@ public void parser_errors() {
runTest(parserWithoutOptionalSupport, "a.?b && a[?b]");
runTest(parserWithoutOptionalSupport, "Msg{?field: value} && {?'key': value}");
runTest(parserWithoutOptionalSupport, "[?a, ?b]");

CelParser parserWithQuotedFields =
CelParserImpl.newBuilder()
.setOptions(CelOptions.current().enableQuotedIdentifierSyntax(true).build())
.build();
runTest(parserWithQuotedFields, "`bar`");
runTest(parserWithQuotedFields, "foo.``");
runTest(parserWithQuotedFields, "foo.`$bar`");

CelParser parserWithoutQuotedFields =
CelParserImpl.newBuilder()
.setOptions(CelOptions.current().enableQuotedIdentifierSyntax(false).build())
.build();
runTest(parserWithoutQuotedFields, "foo.`bar`");
runTest(parserWithoutQuotedFields, "Struct{`bar`: false}");
}

@Test
Expand Down
16 changes: 15 additions & 1 deletion parser/src/test/java/dev/cel/parser/CelUnparserImplTest.java
Original file line numberDiff line numberDiff line change
Expand Up@@ -39,7 +39,11 @@ public final class CelUnparserImplTest {

private final CelParser parser =
CelParserImpl.newBuilder()
.setOptions(CelOptions.newBuilder().populateMacroCalls(true).build())
.setOptions(
CelOptions.newBuilder()
.enableQuotedIdentifierSyntax(true)
.populateMacroCalls(true)
.build())
.addLibraries(CelOptionalLibrary.INSTANCE)
.setStandardMacros(CelStandardMacro.STANDARD_MACROS)
.build();
Expand DownExpand Up@@ -99,6 +103,15 @@ public List<String> provideValues(Context context) {
"a ? (b1 || b2) : (c1 && c2)",
"(a ? b : c).method(d)",
"a + b + c + d",
"foo.`a.b`",
"foo.`a/b`",
"foo.`a-b`",
"foo.`a b`",
"foo.`in`",
"Foo{`a.b`: foo}",
"Foo{`a/b`: foo}",
"Foo{`a-b`: foo}",
"Foo{`a b`: foo}",

// Constants
"true",
Expand DownExpand Up@@ -140,6 +153,7 @@ public List<String> provideValues(Context context) {

// Macros
"has(x[\"a\"].single_int32)",
"has(x.`foo-bar`.single_int32)",

// This is a filter expression but is decompiled back to
// map(x, filter_function, x) for which the evaluation is
Expand Down
Loading