Merge pull request #90 from microsoft/powershell-even-more-ast-classes

MathiasVP · web-flow · commit 5e4f52a52ba4 · 2024-09-09T17:51:56.000+01:00
PS: Add more AST classes
diff --git a/powershell/ql/lib/powershell.qll b/powershell/ql/lib/powershell.qll
@@ -45,12 +45,15 @@ import semmle.code.powershell.ContinueStmt
 import semmle.code.powershell.BreakStmt
 import semmle.code.powershell.ReturnStmt
 import semmle.code.powershell.UsingStmt
+import semmle.code.powershell.ThrowStmt
+import semmle.code.powershell.ErrorStmt
 import semmle.code.powershell.Type
 import semmle.code.powershell.Member
 import semmle.code.powershell.PropertyMember
 import semmle.code.powershell.Function
 import semmle.code.powershell.TryStmt
 import semmle.code.powershell.IfStmt
+import semmle.code.powershell.SwitchStmt
 import semmle.code.powershell.ExitStmt
 import semmle.code.powershell.LabeledStmt
 import semmle.code.powershell.DynamicStmt
@@ -66,5 +69,11 @@ import semmle.code.powershell.ParenExpression
 import semmle.code.powershell.Chainable
 import semmle.code.powershell.Pipeline
 import semmle.code.powershell.StringConstantExpression
+import semmle.code.powershell.MemberExpr
 import semmle.code.powershell.InvokeMemberExpression
+import semmle.code.powershell.SubExpression
+import semmle.code.powershell.ConvertExpr
+import semmle.code.powershell.IndexExpr
+import semmle.code.powershell.HashTable
+import semmle.code.powershell.SplitExpr
 import semmle.code.powershell.CommentEntity
diff --git a/powershell/ql/lib/semmle/code/powershell/BinaryExpression.qll b/powershell/ql/lib/semmle/code/powershell/BinaryExpression.qll
@@ -86,6 +86,10 @@ abstract private class AbstractCaseInsensitiveComparisonExpr extends AbstractCom
 
 final class CaseInsensitiveComparisonExpr = AbstractCaseInsensitiveComparisonExpr;
 
+abstract private class AbstractCaseSensitiveComparisonExpr extends AbstractComparisonExpr { }
+
+final class CaseSensitiveComparisonExpr = AbstractCaseSensitiveComparisonExpr;
+
 class EqExpr extends AbstractCaseInsensitiveComparisonExpr {
   EqExpr() { this.getKind() = 60 }
 
@@ -98,12 +102,30 @@ class NeExpr extends AbstractCaseInsensitiveComparisonExpr {
   final override string toString() { result = "... -ne ..." }
 }
 
+class CEqExpr extends AbstractCaseSensitiveComparisonExpr {
+  CEqExpr() { this.getKind() = 76 }
+
+  final override string toString() { result = "... -ceq ..." }
+}
+
+class CNeExpr extends AbstractCaseSensitiveComparisonExpr {
+  CNeExpr() { this.getKind() = 77 }
+
+  final override string toString() { result = "... -cne ..." }
+}
+
 abstract private class AbstractRelationalExpr extends AbstractComparisonExpr { }
 
 final class RelationalExpr = AbstractRelationalExpr;
 
 abstract private class AbstractCaseInsensitiveRelationalExpr extends AbstractRelationalExpr { }
 
+final class CaseInsensitiveRelationalExpr = AbstractCaseInsensitiveRelationalExpr;
+
+abstract private class AbstractCaseSensitiveRelationalExpr extends AbstractRelationalExpr { }
+
+final class CaseSensitiveRelationalExpr = AbstractCaseSensitiveRelationalExpr;
+
 class GeExpr extends AbstractCaseInsensitiveRelationalExpr {
   GeExpr() { this.getKind() = 62 }
 
@@ -128,6 +150,30 @@ class LeExpr extends AbstractCaseInsensitiveRelationalExpr {
   final override string toString() { result = "... -le ..." }
 }
 
+class CGeExpr extends AbstractCaseSensitiveRelationalExpr {
+  CGeExpr() { this.getKind() = 78 }
+
+  final override string toString() { result = "... -cge ..." }
+}
+
+class CGtExpr extends AbstractCaseSensitiveRelationalExpr {
+  CGtExpr() { this.getKind() = 79 }
+
+  final override string toString() { result = "... -cgt ..." }
+}
+
+class CLtExpr extends AbstractCaseSensitiveRelationalExpr {
+  CLtExpr() { this.getKind() = 80 }
+
+  final override string toString() { result = "... -clt ..." }
+}
+
+class CLeExpr extends AbstractCaseSensitiveRelationalExpr {
+  CLeExpr() { this.getKind() = 81 }
+
+  final override string toString() { result = "... -cle ..." }
+}
+
 class LikeExpr extends AbstractCaseInsensitiveComparisonExpr {
   LikeExpr() { this.getKind() = 66 }
 
@@ -238,18 +284,20 @@ class LogicalXorExpr extends AbstractLogicalBinaryExpr {
   final override string toString() { result = "... -xor ..." }
 }
 
-abstract private class AbstractStringExpr extends BinaryExpr { }
-
-final class StringExpr = AbstractStringExpr;
-
-class JoinExpr extends AbstractStringExpr {
+class JoinExpr extends BinaryExpr {
   JoinExpr() { this.getKind() = 59 }
 
   final override string toString() { result = "... -join ..." }
 }
 
-class SplitExpr extends AbstractStringExpr {
-  SplitExpr() { this.getKind() = 75 }
+class SequenceExpr extends BinaryExpr {
+  SequenceExpr() { this.getKind() = 33 }
+
+  final override string toString() { result = "[..]" }
+}
+
+class FormatExpr extends BinaryExpr {
+  FormatExpr() { this.getKind() = 50 }
 
-  final override string toString() { result = "... -split ..." }
+  final override string toString() { result = "... -f ..." }
 }
diff --git a/powershell/ql/lib/semmle/code/powershell/ConvertExpr.qll b/powershell/ql/lib/semmle/code/powershell/ConvertExpr.qll
@@ -0,0 +1,13 @@
+import powershell
+
+class ConvertExpr extends @convert_expression, Expr {
+  override string toString() { result = "[...]..." }
+
+  override SourceLocation getLocation() { convert_expression_location(this, result) }
+
+  Expr getExpr() { convert_expression(this, _, result, _, _) }
+
+  TypeConstraint getType() { convert_expression(this, _, _, result, _) }
+
+  AttributeBase getAttribute() { convert_expression(this, result, _, _, _) }
+}
diff --git a/powershell/ql/lib/semmle/code/powershell/ErrorStmt.qll b/powershell/ql/lib/semmle/code/powershell/ErrorStmt.qll
@@ -0,0 +1,7 @@
+import powershell
+
+class ErrorStmt extends @error_statement, PipelineBase {
+  final override SourceLocation getLocation() { error_statement_location(this, result) }
+
+  final override string toString() { result = "error" }
+}
diff --git a/powershell/ql/lib/semmle/code/powershell/ExpandableStringExpression.qll b/powershell/ql/lib/semmle/code/powershell/ExpandableStringExpression.qll
@@ -1,15 +1,15 @@
 import powershell
 
-class ExpandableStringExpression extends @expandable_string_expression, Expr {
+class ExpandableStringExpr extends @expandable_string_expression, Expr {
   override SourceLocation getLocation() { expandable_string_expression_location(this, result) }
 
-  override string toString() {
-    result = "ExpandableStringExpression at: " + this.getLocation().toString()
-  }
+  override string toString() { result = this.getUnexpandedValue().toString() }
+
+  StringLiteral getUnexpandedValue() { expandable_string_expression(this, result, _, _) }
 
   private int getKind() { expandable_string_expression(this, _, result, _) }
 
-  int getNumExprs() { expandable_string_expression(this, _, _, result) }
+  int getNumExprs() { result = count(this.getAnExpr()) }
 
   Expr getExpr(int i) { expandable_string_expression_nested_expression(this, i, result) }
 
diff --git a/powershell/ql/lib/semmle/code/powershell/HashTable.qll b/powershell/ql/lib/semmle/code/powershell/HashTable.qll
@@ -0,0 +1,17 @@
+import powershell
+
+class HashTableExpr extends @hash_table, Expr {
+  final override Location getLocation() { hash_table_location(this, result) }
+
+  final override string toString() { result = "${...}" }
+
+  Stmt getExprWithKey(Expr key) { hash_table_key_value_pairs(this, _, key, result) } // TODO: Change @ast to @expr in db scheme
+
+  predicate hasKey(Expr key) { exists(this.getExprWithKey(key)) }
+
+  Stmt getAnExpr() { result = this.getExprWithKey(_) }
+
+  predicate hasEntry(int index, Expr key, Stmt value) {
+    hash_table_key_value_pairs(this, index, key, value)
+  }
+}
diff --git a/powershell/ql/lib/semmle/code/powershell/IndexExpr.qll b/powershell/ql/lib/semmle/code/powershell/IndexExpr.qll
@@ -0,0 +1,13 @@
+import powershell
+
+class IndexExpr extends @index_expression, Expr {
+  override string toString() { result = "...[...]" }
+
+  override SourceLocation getLocation() { index_expression_location(this, result) }
+
+  Expr getIndex() { index_expression(this, result, _, _) } // TODO: Change @ast to @expr in the dbscheme
+
+  Expr getBase() { index_expression(this, _, result, _) } // TODO: Change @ast to @expr in the dbscheme
+
+  predicate isNullConditional() { index_expression(this, _, _, true) }
+}
diff --git a/powershell/ql/lib/semmle/code/powershell/MemberExpr.qll b/powershell/ql/lib/semmle/code/powershell/MemberExpr.qll
@@ -0,0 +1,15 @@
+import powershell
+
+class MemberExpr extends @member_expression, MemberExprBase {
+  final override Location getLocation() { member_expression_location(this, result) }
+
+  Expr getExpr() { member_expression(this, result, _, _, _) }
+
+  CmdElement getMember() { member_expression(this, _, result, _, _) }
+
+  predicate isNullConditional() { member_expression(this, _, _, true, _) }
+
+  predicate isStatic() { member_expression(this, _, _, _, true) }
+
+  final override string toString() { result = this.getMember().toString() }
+}
diff --git a/powershell/ql/lib/semmle/code/powershell/ParenExpression.qll b/powershell/ql/lib/semmle/code/powershell/ParenExpression.qll
@@ -1,7 +1,7 @@
 import powershell
 
-class ParenExpression extends @paren_expression, Expr {
-  PipelineBase getExpression() { paren_expression(this, result) }
+class ParenExpr extends @paren_expression, Expr {
+  PipelineBase getExpr() { paren_expression(this, result) }
 
   override SourceLocation getLocation() { paren_expression_location(this, result) }
 
diff --git a/powershell/ql/lib/semmle/code/powershell/PipelineChain.qll b/powershell/ql/lib/semmle/code/powershell/PipelineChain.qll
@@ -0,0 +1,11 @@
+import powershell
+
+class PipelineChain extends @pipeline_chain, Chainable {
+  final override SourceLocation getLocation() { pipeline_chain_location(this, result) }
+
+  predicate isBackground() { pipeline_chain(this, true, _, _, _) }
+
+  Chainable getLeft() { pipeline_chain(this, _, _, result, _) }
+
+  Pipeline getRight() { pipeline_chain(this, _, _, _, result) }
+}
diff --git a/powershell/ql/lib/semmle/code/powershell/SplitExpr.qll b/powershell/ql/lib/semmle/code/powershell/SplitExpr.qll
@@ -0,0 +1,28 @@
+import powershell
+
+abstract private class AbstractSplitExpr extends Expr {
+  abstract Expr getExpr();
+
+  /** ..., if any. */
+  Expr getSeparator() { none() }
+}
+
+final class SplitExpr = AbstractSplitExpr;
+
+class UnarySplitExpr extends AbstractSplitExpr, UnaryExpr {
+  UnarySplitExpr() { this.getKind() = 75 }
+
+  final override string toString() { result = "-split ..." }
+
+  final override Expr getExpr() { result = this.getOperand() }
+}
+
+class BinarySplitExpr extends AbstractSplitExpr, BinaryExpr {
+  BinarySplitExpr() { this.getKind() = 75 }
+
+  final override string toString() { result = "... -split ..." }
+
+  final override Expr getExpr() { result = this.getLeft() }
+
+  final override Expr getSeparator() { result = this.getRight() }
+}
diff --git a/powershell/ql/lib/semmle/code/powershell/SubExpression.qll b/powershell/ql/lib/semmle/code/powershell/SubExpression.qll
@@ -0,0 +1,10 @@
+import powershell
+
+// TODO: Should we remove this from the dbscheme?
+class ExpandableSubExpr extends @sub_expression, Expr {
+  final override Location getLocation() { sub_expression_location(this, result) }
+
+  StmtBlock getExpr() { sub_expression(this, result) }
+
+  final override string toString() { result = "$(...)" }
+}
diff --git a/powershell/ql/lib/semmle/code/powershell/SwitchStmt.qll b/powershell/ql/lib/semmle/code/powershell/SwitchStmt.qll
@@ -0,0 +1,25 @@
+import powershell
+
+class SwitchStmt extends LabeledStmt, @switch_statement {
+  final override Location getLocation() { switch_statement_location(this, result) }
+
+  PipelineBase getCondition() { switch_statement(this, result, _) }
+
+  StmtBlock getDefault() { switch_statement_default(this, result) }
+
+  StmtBlock getCase(int i, Expr e) { switch_statement_clauses(this, i, e, result) }
+
+  StmtBlock getCase(int i) { result = this.getCase(i, _) }
+
+  StmtBlock getACase() { result = this.getCase(_) }
+
+  StmtBlock getCaseForExpr(Expr e) { result = this.getCase(_, e) }
+
+  Expr getPattern(int i) { exists(this.getCase(i, result)) }
+
+  Expr getAPattern() { result = this.getPattern(_) }
+
+  int getNumberOfCases() { result = count(this.getACase()) }
+
+  final override string toString() { result = "switch(...) {...}" }
+}
diff --git a/powershell/ql/lib/semmle/code/powershell/ThrowStmt.qll b/powershell/ql/lib/semmle/code/powershell/ThrowStmt.qll
@@ -0,0 +1,13 @@
+import powershell
+
+class ThrowStmt extends @throw_statement, Stmt {
+  override SourceLocation getLocation() { throw_statement_location(this, result) }
+
+  override string toString() {
+    if this.hasPipeline() then result = "throw ..." else result = "throw"
+  }
+
+  Pipeline getPipeline() { throw_statement_pipeline(this, result) }
+
+  predicate hasPipeline() { exists(this.getPipeline()) }
+}
diff --git a/powershell/ql/lib/semmle/code/powershell/TypeExpression.qll b/powershell/ql/lib/semmle/code/powershell/TypeExpression.qll
@@ -1,6 +1,6 @@
 import powershell
 
-class TypeExpression extends @type_expression, Expr {
+class TypeNameExpr extends @type_expression, Expr {
   string getName() { type_expression(this, result, _) }
 
   string getFullyQualifiedName() { type_expression(this, _, result) }
diff --git a/powershell/ql/lib/semmle/code/powershell/UnaryExpression.qll b/powershell/ql/lib/semmle/code/powershell/UnaryExpression.qll
@@ -9,7 +9,65 @@ class UnaryExpr extends @unary_expression, Expr {
 }
 
 class NotExpr extends UnaryExpr {
-  NotExpr() { this.getKind() = 36 }
+  NotExpr() { this.getKind() = [36, 51] }
 
-  final override string toString() { result = "!..." }
+  predicate isExclamationMark() { this.getKind() = 36 }
+
+  predicate isNot() { this.getKind() = 51 }
+
+  final override string toString() {
+    this.isExclamationMark() and result = "!..."
+    or
+    this.isNot() and result = "-not ..."
+  }
+}
+
+abstract private class AbstractUnaryArithmeticExpr extends UnaryExpr { }
+
+final class UnaryArithmeticExpr = AbstractUnaryArithmeticExpr;
+
+abstract private class AbstractPostfixExpr extends AbstractUnaryArithmeticExpr, UnaryExpr { }
+
+abstract private class AbstractPrefixExpr extends AbstractUnaryArithmeticExpr, UnaryExpr { }
+
+abstract private class AbstractIncrExpr extends AbstractUnaryArithmeticExpr, UnaryExpr { }
+
+abstract private class AbstractDecrExpr extends AbstractUnaryArithmeticExpr, UnaryExpr { }
+
+final class PostfixExpr = AbstractPostfixExpr;
+
+final class PrefixExpr = AbstractPrefixExpr;
+
+final class IncrExpr = AbstractIncrExpr;
+
+final class DecrExpr = AbstractDecrExpr;
+
+class PostfixIncrExpr extends AbstractPostfixExpr, AbstractIncrExpr {
+  PostfixIncrExpr() { this.getKind() = 95 }
+
+  final override string toString() { result = "...++" }
+}
+
+class PostfixDecrExpr extends AbstractPostfixExpr, AbstractIncrExpr {
+  PostfixDecrExpr() { this.getKind() = 96 }
+
+  final override string toString() { result = "...--" }
+}
+
+class PrefixDecrExpr extends AbstractPostfixExpr, AbstractIncrExpr {
+  PrefixDecrExpr() { this.getKind() = 31 }
+
+  final override string toString() { result = "--..." }
+}
+
+class PrefixIncrExpr extends AbstractPostfixExpr, AbstractIncrExpr {
+  PrefixIncrExpr() { this.getKind() = 32 }
+
+  final override string toString() { result = "++..." }
+}
+
+class NegateExpr extends AbstractUnaryArithmeticExpr {
+  NegateExpr() { this.getKind() = 41 }
+
+  final override string toString() { result = "-..." }
 }
