PS: Add more AST classes.

MathiasVP · MathiasVP · commit 71349afae777 · 2024-08-26T19:21:28.000+01:00
diff --git a/powershell/ql/lib/powershell.qll b/powershell/ql/lib/powershell.qll
@@ -12,6 +12,7 @@ import semmle.code.powershell.ConstantExpression
 import semmle.code.powershell.MemberExpressionBase
 import semmle.code.powershell.Attribute
 import semmle.code.powershell.NamedAttributeArgument
+import semmle.code.powershell.TypeConstraint
 import semmle.code.powershell.VariableExpression
 import semmle.code.powershell.Parameter
 import semmle.code.powershell.ModuleSpecification
@@ -21,13 +22,40 @@ import semmle.code.powershell.ScriptBlock
 import semmle.code.powershell.StringLiteral
 import semmle.code.powershell.AssignmentStatement
 import semmle.code.powershell.BinaryExpression
+import semmle.code.powershell.ScriptBlockExpr
 import semmle.code.powershell.TernaryExpression
+import semmle.code.powershell.UsingExpression
 import semmle.code.powershell.TrapStatement
 import semmle.code.powershell.StatementBlock
 import semmle.code.powershell.ArrayExpression
 import semmle.code.powershell.ArrayLiteral
 import semmle.code.powershell.CommandElement
 import semmle.code.powershell.Redirection
+import semmle.code.powershell.FileRedirection
+import semmle.code.powershell.MergingRedirection
+import semmle.code.powershell.LoopStmt
+import semmle.code.powershell.DoWhileStmt
+import semmle.code.powershell.DoUntilStmt
+import semmle.code.powershell.WhileStmt
+import semmle.code.powershell.ForStmt
+import semmle.code.powershell.ForEachStmt
+import semmle.code.powershell.GotoStmt
+import semmle.code.powershell.ContinueStmt
+import semmle.code.powershell.BreakStmt
+import semmle.code.powershell.ReturnStmt
+import semmle.code.powershell.UsingStmt
+import semmle.code.powershell.Type
+import semmle.code.powershell.Member
+import semmle.code.powershell.PropertyMember
+import semmle.code.powershell.FunctionMember
+import semmle.code.powershell.TryStmt
+import semmle.code.powershell.IfStmt
+import semmle.code.powershell.ExitStmt
+import semmle.code.powershell.LabeledStmt
+import semmle.code.powershell.DynamicStmt
+import semmle.code.powershell.DataStmt
+import semmle.code.powershell.Configuration
+import semmle.code.powershell.CatchClause
 import semmle.code.powershell.Command
 import semmle.code.powershell.CommandExpression
 import semmle.code.powershell.CommandParameter
diff --git a/powershell/ql/lib/semmle/code/powershell/BreakStmt.qll b/powershell/ql/lib/semmle/code/powershell/BreakStmt.qll
@@ -0,0 +1,7 @@
+import powershell
+
+class BreakStmt extends GotoStmt, Stmt {
+  override SourceLocation getLocation() { break_statement_location(this, result) }
+
+  override string toString() { result = "continue" }
+}
diff --git a/powershell/ql/lib/semmle/code/powershell/CatchClause.qll b/powershell/ql/lib/semmle/code/powershell/CatchClause.qll
@@ -0,0 +1,17 @@
+import powershell
+
+class CatchClause extends @catch_clause, Ast {
+  override SourceLocation getLocation() { catch_clause_location(this, result) }
+
+  override string toString() { result = "catch {...}" }
+
+  StmtBlock getBody() { catch_clause(this, result, _) } // TODO: Change @ast to @stmt_block in dbscheme
+
+  TypeConstraint getCatchType(int i) { catch_clause_catch_type(this, i, result) } // TODO: Change @ast to @type_constraint in dbscheme
+
+  TypeConstraint getACatchType() { result = this.getCatchType(_) }
+
+  predicate isCatchAll() { catch_clause(this, _, true) } // TODO: Should be equivalent to not exists(this.getACatchType())
+
+  TryStmt getTryStmt() { result.getACatchClause() = this }
+}
diff --git a/powershell/ql/lib/semmle/code/powershell/Configuration.qll b/powershell/ql/lib/semmle/code/powershell/Configuration.qll
@@ -0,0 +1,15 @@
+import powershell
+
+class Configuration extends @configuration_definition, Stmt {
+  override SourceLocation getLocation() { configuration_definition_location(this, result) }
+
+  override string toString() { result = "Configuration" }
+
+  Expr getName() { configuration_definition(this, _, _, result) } // TODO: Change @ast to @expression in dbscheme
+
+  ScriptBlockExpr getBody() { configuration_definition(this, result, _, _) } // TODO: Change @ast to @script_block in dbscheme
+
+  predicate isMeta() { configuration_definition(this, _, 1, _) }
+
+  predicate isResource() { configuration_definition(this, _, 0, _) }
+}
diff --git a/powershell/ql/lib/semmle/code/powershell/ContinueStmt.qll b/powershell/ql/lib/semmle/code/powershell/ContinueStmt.qll
@@ -0,0 +1,7 @@
+import powershell
+
+class ContinueStmt extends GotoStmt, Stmt {
+  override SourceLocation getLocation() { continue_statement_location(this, result) }
+
+  override string toString() { result = "continue" }
+}
diff --git a/powershell/ql/lib/semmle/code/powershell/DataStmt.qll b/powershell/ql/lib/semmle/code/powershell/DataStmt.qll
@@ -0,0 +1,15 @@
+import powershell
+
+class DataStmt extends @data_statement, Stmt {
+  override SourceLocation getLocation() { data_statement_location(this, result) }
+
+  override string toString() { result = "data {...}" }
+
+  string getVariableName() { data_statement_variable(this, result) }
+
+  Expr getCmdAllowed(int i) { data_statement_commands_allowed(this, i, result) }
+
+  Expr getACmdAllowed() { result = this.getCmdAllowed(_) }
+
+  StmtBlock getBody() { data_statement(this, result) } // TODO: Change @ast to @stmt_block in dbscheme
+}
diff --git a/powershell/ql/lib/semmle/code/powershell/DoUntilStmt.qll b/powershell/ql/lib/semmle/code/powershell/DoUntilStmt.qll
@@ -0,0 +1,11 @@
+import powershell
+
+class DoUntilStmt extends @do_until_statement, LoopStmt {
+  override SourceLocation getLocation() { do_until_statement_location(this, result) }
+
+  override string toString() { result = "DoUntil" }
+
+  PipelineBase getCondition() { do_until_statement_condition(this, result) } // TODO: Change @ast to @pipeline_base in dbscheme
+
+  StmtBlock getBody() { do_until_statement(this, result) } // TODO: Change @ast to @stmt_block in dbscheme
+}
diff --git a/powershell/ql/lib/semmle/code/powershell/DoWhileStmt.qll b/powershell/ql/lib/semmle/code/powershell/DoWhileStmt.qll
@@ -0,0 +1,11 @@
+import powershell
+
+class DoWhileStmt extends @do_while_statement, LoopStmt {
+  override SourceLocation getLocation() { do_while_statement_location(this, result) }
+
+  override string toString() { result = "DoWhile" }
+
+  PipelineBase getCondition() { do_while_statement_condition(this, result) } // TODO: Change @ast to @pipeline_base in dbscheme
+
+  StmtBlock getBody() { do_while_statement(this, result) } // TODO: Change @ast to @stmt_block in dbscheme
+}
diff --git a/powershell/ql/lib/semmle/code/powershell/DynamicStmt.qll b/powershell/ql/lib/semmle/code/powershell/DynamicStmt.qll
@@ -0,0 +1,11 @@
+import powershell
+
+class DynamicStmt extends @dynamic_keyword_statement, Stmt {
+  override SourceLocation getLocation() { dynamic_keyword_statement_location(this, result) }
+
+  override string toString() { result = "&..." }
+
+  CmdElement getCmd(int i) { dynamic_keyword_statement_command_elements(this, i, result) }
+
+  CmdElement getACmd() { result = this.getCmd(_) }
+}
diff --git a/powershell/ql/lib/semmle/code/powershell/ExitStmt.qll b/powershell/ql/lib/semmle/code/powershell/ExitStmt.qll
@@ -0,0 +1,12 @@
+import powershell
+
+class ExitStmt extends @exit_statement, Stmt {
+  override SourceLocation getLocation() { exit_statement_location(this, result) }
+
+  override string toString() { if this.hasPipeline() then result = "exit ..." else result = "exit" }
+
+  /** ..., if any. */
+  PipelineBase getPipeline() { exit_statement_pipeline(this, result) } // TODO: Change @ast to @pipeline_base in dbscheme
+
+  predicate hasPipeline() { exists(this.getPipeline()) }
+}
diff --git a/powershell/ql/lib/semmle/code/powershell/ForEachStmt.qll b/powershell/ql/lib/semmle/code/powershell/ForEachStmt.qll
@@ -0,0 +1,16 @@
+import powershell
+
+class ForEachStmt extends @foreach_statement, LoopStmt {
+  override SourceLocation getLocation() { foreach_statement_location(this, result) }
+
+  override string toString() { result = "forach(... in ...)" }
+
+  StmtBlock getBody() { foreach_statement(this, _, _, result, _) } // TODO: Change @ast to @stmt_block in dbscheme
+
+  VarAccess getVariable() { foreach_statement(this, result, _, _, _) } // TODO: Change @ast to @variable_expression in dbscheme
+
+  /** ..., if any. */
+  PipelineBase getCondition() { foreach_statement(this, _, result, _, _) } // TODO: Change @ast to @pipeline_base in dbscheme
+
+  predicate isParallel() { foreach_statement(this, _, _, _, 1) }
+}
diff --git a/powershell/ql/lib/semmle/code/powershell/ForStmt.qll b/powershell/ql/lib/semmle/code/powershell/ForStmt.qll
@@ -0,0 +1,15 @@
+import powershell
+
+class ForStmt extends @for_statement, LoopStmt {
+  override SourceLocation getLocation() { for_statement_location(this, result) }
+
+  override string toString() { result = "for(...;...;...)" }
+
+  PipelineBase getInitializer() { for_statement_initializer(this, result) } // TODO: Change @ast to @pipeline_base in dbscheme
+
+  PipelineBase getCondition() { for_statement_condition(this, result) } // TODO: Change @ast to @pipeline_base in dbscheme
+
+  PipelineBase getIterator() { for_statement_iterator(this, result) } // TODO: Change @ast to @pipeline_base in dbscheme
+
+  StmtBlock getBody() { for_statement(this, result) } // TODO: Change @ast to @stmt_block in dbscheme
+}
diff --git a/powershell/ql/lib/semmle/code/powershell/FunctionDefinition.qll b/powershell/ql/lib/semmle/code/powershell/FunctionDefinition.qll
@@ -12,4 +12,8 @@ class Function extends @function_definition, Stmt {
   predicate isFilter() { function_definition(this, _, _, true, _) }
 
   predicate isWorkflow() { function_definition(this, _, _, _, true) }
+
+  Parameter getParameter(int i) { function_definition_parameter(this, i, result) }
+
+  Parameter getAParameter() { result = this.getParameter(_) }
 }
diff --git a/powershell/ql/lib/semmle/code/powershell/FunctionMember.qll b/powershell/ql/lib/semmle/code/powershell/FunctionMember.qll
@@ -0,0 +1,31 @@
+import powershell
+
+class FunctionMember extends @function_member, Member {
+  override string getName() { function_member(this, _, _, _, _, _, _, result, _) }
+
+  override SourceLocation getLocation() { function_member_location(this, result) }
+
+  override string toString() { result = this.getName() }
+
+  ScriptBlock getBody() { function_member(this, result, _, _, _, _, _, _, _) }
+
+  override predicate isHidden() { function_member(this, _, _, true, _, _, _, _, _) }
+
+  override predicate isPrivate() { function_member(this, _, _, _, true, _, _, _, _) }
+
+  override predicate isPublic() { function_member(this, _, _, _, _, true, _, _, _) }
+
+  override predicate isStatic() { function_member(this, _, _, _, _, _, true, _, _) }
+
+  predicate isConstructor() { function_member(this, _, true, _, _, _, _, _, _) }
+
+  Parameter getParameter(int i) { function_member_parameter(this, i, result) }
+
+  Parameter getAParameter() { result = this.getParameter(_) }
+
+  TypeConstraint getTypeConstraint() { function_member_return_type(this, result) }
+}
+
+class Constructor extends FunctionMember {
+  Constructor() { this.isConstructor() }
+}
diff --git a/powershell/ql/lib/semmle/code/powershell/GotoStmt.qll b/powershell/ql/lib/semmle/code/powershell/GotoStmt.qll
@@ -0,0 +1,8 @@
+import powershell
+
+/** A `break` or `continue` statement. */
+class GotoStmt extends @labelled_statement, Stmt { // TODO: Rename @labelled_statement to @goto_statement
+
+  /** ..., if any. */
+  Expr getLabel() { statement_label(this, result) } // TODO: Replace @ast with @expression
+}
diff --git a/powershell/ql/lib/semmle/code/powershell/IfStmt.qll b/powershell/ql/lib/semmle/code/powershell/IfStmt.qll
@@ -0,0 +1,18 @@
+import powershell
+
+class IfStmt extends @if_statement, Stmt {
+  override SourceLocation getLocation() { if_statement_location(this, result) }
+
+  override string toString() {
+    if this.hasElse() then result = "if (...) {...} else {...}" else result = "if (...) {...}"
+  }
+
+  PipelineBase getCondition(int i) { if_statement_clause(this, i, result, _) } // TODO: Change @ast to @pipeline_base in dbscheme
+
+  StmtBlock getThen(int i) { if_statement_clause(this, i, _, result) } // TODO: Change @ast to @statement_block in dbscheme
+
+  /** ..., if any. */
+  StmtBlock getElse() { if_statement_else(this, result) } // TODO: Change @ast to @stmt_block in dbscheme
+
+  predicate hasElse() { exists(this.getElse()) }
+}
diff --git a/powershell/ql/lib/semmle/code/powershell/LabeledStmt.qll b/powershell/ql/lib/semmle/code/powershell/LabeledStmt.qll
@@ -0,0 +1,5 @@
+import powershell
+
+class LabeledStmt extends @labeled_statement, Stmt {
+  string getLabel() { label(this, result) }
+}
diff --git a/powershell/ql/lib/semmle/code/powershell/LoopStmt.qll b/powershell/ql/lib/semmle/code/powershell/LoopStmt.qll
@@ -0,0 +1,3 @@
+import powershell
+
+class LoopStmt extends @loop_statement, LabeledStmt { }
diff --git a/powershell/ql/lib/semmle/code/powershell/Member.qll b/powershell/ql/lib/semmle/code/powershell/Member.qll
@@ -0,0 +1,17 @@
+import powershell
+
+class Member extends @member, Ast {
+  Type getDeclaringType() { result.getAMember() = this }
+
+  string getName() { none() }
+
+  override string toString() { result = this.getName() }
+
+  predicate isHidden() { none() }
+
+  predicate isPrivate() { none() }
+
+  predicate isPublic() { none() }
+
+  predicate isStatic() { none() }
+}
diff --git a/powershell/ql/lib/semmle/code/powershell/PropertyMember.qll b/powershell/ql/lib/semmle/code/powershell/PropertyMember.qll
@@ -0,0 +1,17 @@
+import powershell
+
+class PropertyMember extends @property_member, Member {
+  override string getName() { property_member(this, _, _, _, _, result, _) }
+
+  override SourceLocation getLocation() { property_member_location(this, result) }
+
+  override string toString() { result = this.getName() }
+
+  override predicate isHidden() { property_member(this, true, _, _, _, _, _) }
+
+  override predicate isPrivate() { property_member(this, _, true, _, _, _, _) }
+
+  override predicate isPublic() { property_member(this, _, _, true, _, _, _) }
+
+  override predicate isStatic() { property_member(this, _, _, _, true, _, _) }
+}
diff --git a/powershell/ql/lib/semmle/code/powershell/ReturnStmt.qll b/powershell/ql/lib/semmle/code/powershell/ReturnStmt.qll
@@ -0,0 +1,13 @@
+import powershell
+
+class ReturnStmt extends @return_statement, Stmt {
+  override SourceLocation getLocation() { return_statement_location(this, result) }
+
+  override string toString() {
+    if this.hasPipeline() then result = "return ..." else result = "return"
+  }
+
+  PipelineBase getPipeline() { return_statement_pipeline(this, result) } // TODO: Change @ast to @pipeline_base in dbscheme
+
+  predicate hasPipeline() { exists(this.getPipeline()) }
+}
diff --git a/powershell/ql/lib/semmle/code/powershell/ScriptBlockExpr.qll b/powershell/ql/lib/semmle/code/powershell/ScriptBlockExpr.qll
@@ -0,0 +1,9 @@
+import powershell
+
+class ScriptBlockExpr extends @script_block_expression, Expr {
+  override SourceLocation getLocation() { script_block_expression_location(this, result) }
+
+  override string toString() { result = "{...}" }
+
+  ScriptBlock getBody() { script_block_expression(this, result) }
+}
diff --git a/powershell/ql/lib/semmle/code/powershell/TryStmt.qll b/powershell/ql/lib/semmle/code/powershell/TryStmt.qll
@@ -0,0 +1,17 @@
+import powershell
+
+class TryStmt extends @try_statement, Stmt {
+  override SourceLocation getLocation() { try_statement_location(this, result) }
+
+  override string toString() { result = "try {...}" }
+
+  CatchClause getCatchClause(int i) { try_statement_catch_clause(this, i, result) }
+
+  CatchClause getACatchClause() { result = this.getCatchClause(_) }
+
+  /** ..., if any. */
+  StmtBlock getFinally() { try_statement_finally(this, result) }
+
+  StmtBlock getBody() { try_statement(this, result) } // TODO: Change @ast to @stmt_block in dbscheme
+
+}
diff --git a/powershell/ql/lib/semmle/code/powershell/Type.qll b/powershell/ql/lib/semmle/code/powershell/Type.qll
@@ -0,0 +1,13 @@
+import powershell
+
+class Type extends @type_definition, Stmt {
+  override SourceLocation getLocation() { type_definition_location(this, result) }
+
+  override string toString() { result = this.getName() }
+
+  string getName() { type_definition(this, result, _, _, _, _) }
+
+  Member getMember(int i) { type_definition_members(this, i, result) }
+
+  Member getAMember() { result = this.getMember(_) }
+}
diff --git a/powershell/ql/lib/semmle/code/powershell/TypeConstraint.qll b/powershell/ql/lib/semmle/code/powershell/TypeConstraint.qll
@@ -0,0 +1,13 @@
+import powershell
+
+class TypeConstraint extends @type_constraint, AttributeBase {
+  override SourceLocation getLocation() { type_constraint_location(this, result) }
+
+  /** Gets the assembly name. */
+  string getName() { type_constraint(this, result, _) }
+
+  /** Gets the full name of this type constraint including namespaces. */
+  string getFullName() { type_constraint(this, _, result) }
+
+  override string toString() { result = this.getName() }
+}
diff --git a/powershell/ql/lib/semmle/code/powershell/UsingExpression.qll b/powershell/ql/lib/semmle/code/powershell/UsingExpression.qll
@@ -0,0 +1,7 @@
+import powershell
+
+class UsingExpr extends @using_expression, Expr {
+  override string toString() { result = "$using..." }
+
+  override SourceLocation getLocation() { using_expression_location(this, result) }
+}
diff --git a/powershell/ql/lib/semmle/code/powershell/UsingStmt.qll b/powershell/ql/lib/semmle/code/powershell/UsingStmt.qll
@@ -0,0 +1,7 @@
+import powershell
+
+class UsingStmt extends @using_statement, Stmt {
+  override SourceLocation getLocation() { using_statement_location(this, result) }
+
+  override string toString() { result = "using ..." }
+}
diff --git a/powershell/ql/lib/semmle/code/powershell/WhileStmt.qll b/powershell/ql/lib/semmle/code/powershell/WhileStmt.qll
