Ruby: make resolveConstant overlay[global]

Author: nickrolfe

ruby/ql/lib/codeql/ruby/ast/Call.qll

@@ -4,6 +4,7 @@ module;
 private import codeql.ruby.AST
 private import internal.AST
 private import internal.Call
+private import internal.Literal
 private import internal.TreeSitter
 private import codeql.ruby.dataflow.internal.DataFlowDispatch
 private import codeql.ruby.dataflow.internal.DataFlowImplCommon
@@ -44,7 +45,7 @@ class Call extends Expr instanceof CallImpl {
   final Expr getKeywordArgument(string keyword) {
     exists(Pair p |
       p = this.getAnArgument() and
-      p.getKey().getConstantValue().isSymbol(keyword) and
+      keyword = p.getKey().(SymbolLiteral).(StringlikeLiteralImpl).getStringValue() and
       result = p.getValue()
     )
   }

ruby/ql/lib/codeql/ruby/ast/Constant.qll

@@ -9,6 +9,7 @@ private import internal.Variable
 private import internal.TreeSitter
 
 /** A constant value. */
+overlay[global]
 class ConstantValue extends TConstantValue {
   /** Gets a textual representation of this constant value. */
   final string toString() { this.hasValueWithType(result, _) }
@@ -137,6 +138,7 @@ class ConstantValue extends TConstantValue {
 }
 
 /** Provides different sub classes of `ConstantValue`. */
+overlay[global]
 module ConstantValue {
   /** A constant integer value. */
   class ConstantIntegerValue extends ConstantValue, TInt { }
@@ -271,15 +273,18 @@ class ConstantReadAccess extends ConstantAccess {
    *
    * the value being read at `M::CONST` is `"const"`.
    */
+  overlay[global]
   Expr getValue() { result = getConstantReadAccessValue(this) }
 
   /**
    * Gets a fully qualified name for this constant read, based on the context in
    * which it occurs.
    */
+  overlay[global]
   string getAQualifiedName() { result = resolveConstant(this) }
 
   /** Gets the module that this read access resolves to, if any. */
+  overlay[global]
   Module getModule() { result = resolveConstantReadAccess(this) }
 
   final override string getAPrimaryQlClass() { result = "ConstantReadAccess" }
@@ -345,6 +350,7 @@ class ConstantWriteAccess extends ConstantAccess {
    * constants up the namespace chain, the fully qualified name of a nested
    * constant can be ambiguous from just statically looking at the AST.
    */
+  overlay[global]
   string getAQualifiedName() { result = resolveConstantWrite(this) }
 }
 

ruby/ql/lib/codeql/ruby/ast/Expr.qll

@@ -6,6 +6,7 @@ private import codeql.ruby.CFG
 private import internal.AST
 private import internal.Constant
 private import internal.Expr
+private import internal.Literal
 private import internal.TreeSitter
 
 /**
@@ -15,6 +16,7 @@ private import internal.TreeSitter
  */
 class Expr extends Stmt, TExpr {
   /** Gets the constant value of this expression, if any. */
+  overlay[global]
   ConstantValue getConstantValue() { result = getConstantValueExpr(this) }
 }
 
@@ -430,11 +432,11 @@ class StringConcatenation extends Expr, TStringConcatenation {
    */
   final string getConcatenatedValueText() {
     forall(StringLiteral c | c = this.getString(_) |
-      exists(c.getConstantValue().getStringlikeValue())
+      exists(c.(StringlikeLiteralImpl).getStringValue())
     ) and
     result =
       concat(string valueText, int i |
-        valueText = this.getString(i).getConstantValue().getStringlikeValue()
+        valueText = this.getString(i).(StringlikeLiteralImpl).getStringValue()
       |
         valueText order by i
       )

ruby/ql/lib/codeql/ruby/ast/Literal.qll

@@ -44,6 +44,7 @@ class IntegerLiteral extends NumericLiteral instanceof IntegerLiteralImpl {
   /** Gets the numerical value of this integer literal. */
   final int getValue() { result = super.getValue() }
 
+  overlay[global]
   final override ConstantValue::ConstantIntegerValue getConstantValue() {
     result = NumericLiteral.super.getConstantValue()
   }
@@ -60,6 +61,7 @@ class IntegerLiteral extends NumericLiteral instanceof IntegerLiteralImpl {
  * ```
  */
 class FloatLiteral extends NumericLiteral instanceof FloatLiteralImpl {
+  overlay[global]
   final override ConstantValue::ConstantFloatValue getConstantValue() {
     result = NumericLiteral.super.getConstantValue()
   }
@@ -75,6 +77,7 @@ class FloatLiteral extends NumericLiteral instanceof FloatLiteralImpl {
  * ```
  */
 class RationalLiteral extends NumericLiteral instanceof RationalLiteralImpl {
+  overlay[global]
   final override ConstantValue::ConstantRationalValue getConstantValue() {
     result = NumericLiteral.super.getConstantValue()
   }
@@ -90,6 +93,7 @@ class RationalLiteral extends NumericLiteral instanceof RationalLiteralImpl {
  * ```
  */
 class ComplexLiteral extends NumericLiteral instanceof ComplexLiteralImpl {
+  overlay[global]
   final override ConstantValue::ConstantComplexValue getConstantValue() {
     result = NumericLiteral.super.getConstantValue()
   }
@@ -99,6 +103,7 @@ class ComplexLiteral extends NumericLiteral instanceof ComplexLiteralImpl {
 
 /** A `nil` literal. */
 class NilLiteral extends Literal instanceof NilLiteralImpl {
+  overlay[global]
   final override ConstantValue::ConstantNilValue getConstantValue() { result = TNil() }
 
   final override string getAPrimaryQlClass() { result = "NilLiteral" }
@@ -125,6 +130,7 @@ class BooleanLiteral extends Literal instanceof BooleanLiteralImpl {
   /** Gets the value of this Boolean literal. */
   boolean getValue() { result = super.getValue() }
 
+  overlay[global]
   final override ConstantValue::ConstantBooleanValue getConstantValue() {
     result = Literal.super.getConstantValue()
   }
@@ -136,6 +142,7 @@ class BooleanLiteral extends Literal instanceof BooleanLiteralImpl {
 class EncodingLiteral extends Literal instanceof EncodingLiteralImpl {
   final override string getAPrimaryQlClass() { result = "EncodingLiteral" }
 
+  overlay[global]
   final override ConstantValue::ConstantStringValue getConstantValue() {
     result = Literal.super.getConstantValue()
   }
@@ -147,6 +154,7 @@ class EncodingLiteral extends Literal instanceof EncodingLiteralImpl {
 class LineLiteral extends Literal instanceof LineLiteralImpl {
   final override string getAPrimaryQlClass() { result = "LineLiteral" }
 
+  overlay[global]
   final override ConstantValue::ConstantIntegerValue getConstantValue() {
     result = Literal.super.getConstantValue()
   }
@@ -158,6 +166,7 @@ class LineLiteral extends Literal instanceof LineLiteralImpl {
 class FileLiteral extends Literal instanceof FileLiteralImpl {
   final override string getAPrimaryQlClass() { result = "FileLiteral" }
 
+  overlay[global]
   final override ConstantValue::ConstantStringValue getConstantValue() {
     result = Literal.super.getConstantValue()
   }
@@ -169,6 +178,7 @@ class FileLiteral extends Literal instanceof FileLiteralImpl {
  */
 class StringComponent extends AstNode instanceof StringComponentImpl {
   /** Gets the constant value of this string component, if any. */
+  overlay[global]
   ConstantValue::ConstantStringValue getConstantValue() { result = TString(super.getValue()) }
 }
 
@@ -213,6 +223,7 @@ class StringInterpolationComponent extends StringComponent, StmtSequence instanc
 
   final override Stmt getStmt(int n) { toGenerated(result) = g.getChild(n) }
 
+  overlay[global]
   final override ConstantValue::ConstantStringValue getConstantValue() {
     result = StmtSequence.super.getConstantValue()
   }
@@ -260,6 +271,7 @@ class RegExpInterpolationComponent extends RegExpComponent, StmtSequence instanc
 
   final override Stmt getStmt(int n) { toGenerated(result) = g.getChild(n) }
 
+  overlay[global]
   final override ConstantValue::ConstantStringValue getConstantValue() {
     result = StmtSequence.super.getConstantValue()
   }
@@ -408,6 +420,7 @@ class SymbolLiteral extends StringlikeLiteral instanceof SymbolLiteralImpl {
     not this instanceof MethodName and result = "SymbolLiteral"
   }
 
+  overlay[global]
   final override ConstantValue::ConstantSymbolValue getConstantValue() {
     result = StringlikeLiteral.super.getConstantValue()
   }
@@ -440,6 +453,7 @@ class SubshellLiteral extends StringlikeLiteral instanceof SubshellLiteralImpl {
 class CharacterLiteral extends Literal instanceof CharacterLiteralImpl {
   final override string getAPrimaryQlClass() { result = "CharacterLiteral" }
 
+  overlay[global]
   final override ConstantValue::ConstantStringValue getConstantValue() {
     result = Literal.super.getConstantValue()
   }

ruby/ql/lib/codeql/ruby/ast/Method.qll

@@ -43,18 +43,22 @@ class MethodBase extends Callable, BodyStmt, Scope, TMethodBase {
    * Holds if this method is public.
    * Methods are public by default.
    */
+  overlay[global]
   predicate isPublic() { this.getVisibility() = "public" }
 
   /** Holds if this method is private. */
+  overlay[global]
   predicate isPrivate() { this.getVisibility() = "private" }
 
   /** Holds if this method is protected. */
+  overlay[global]
   predicate isProtected() { this.getVisibility() = "protected" }
 
   /**
    * Gets a string describing the visibility of this method.
    * This is either 'public', 'private' or 'protected'.
    */
+  overlay[global]
   string getVisibility() {
     result = getVisibilityModifier(this).getVisibility()
     or
@@ -76,6 +80,7 @@ class MethodBase extends Callable, BodyStmt, Scope, TMethodBase {
  * end
  * ```
  */
+overlay[global]
 private VisibilityModifier getExplicitVisibilityModifier(Method m) {
   result.getMethodArgument() = m
   or
@@ -89,6 +94,7 @@ private VisibilityModifier getExplicitVisibilityModifier(Method m) {
  * Gets the visibility modifier that defines the visibility of method `m`, if
  * any.
  */
+overlay[global]
 private VisibilityModifier getVisibilityModifier(MethodBase mb) {
   mb =
     any(Method m |
@@ -205,6 +211,7 @@ class Method extends MethodBase, TMethod {
    * end
    * ```
    */
+  overlay[global]
   override predicate isPrivate() { super.isPrivate() }
 
   final override Parameter getParameter(int n) {
@@ -213,6 +220,7 @@ class Method extends MethodBase, TMethod {
 
   final override string toString() { result = this.getName() }
 
+  overlay[global]
   override string getVisibility() {
     result = getVisibilityModifier(this).getVisibility()
     or
@@ -226,6 +234,7 @@ class Method extends MethodBase, TMethod {
   }
 }
 
+overlay[global]
 pragma[nomagic]
 private predicate modifiesIn(VisibilityModifier vm, ModuleBase n, string name) {
   n = vm.getEnclosingModule() and
@@ -302,6 +311,7 @@ class SingletonMethod extends MethodBase, TSingletonMethod {
    * end
    * ```
    */
+  overlay[global]
   override predicate isPrivate() { super.isPrivate() }
 }
 

ruby/ql/lib/codeql/ruby/ast/Module.qll

@@ -11,6 +11,7 @@ private import internal.Scope
 /**
  * A representation of a run-time `module` or `class` value.
  */
+overlay[global]
 class Module extends TModule {
   /** Gets a declaration of this module, if any. */
   ModuleBase getADeclaration() { result.getModule() = this }
@@ -258,6 +259,7 @@ class ModuleBase extends BodyStmt, Scope, TModuleBase {
   }
 
   /** Gets the representation of the run-time value of this module or class. */
+  overlay[global]
   Module getModule() { none() }
 
   /**
@@ -336,6 +338,7 @@ class Toplevel extends ModuleBase, TToplevel {
     pred = "getBeginBlock" and result = this.getBeginBlock(_)
   }
 
+  overlay[global]
   final override Module getModule() { result = TResolved("Object") }
 
   final override string toString() { result = g.getLocation().getFile().getBaseName() }
@@ -408,6 +411,7 @@ class Namespace extends ModuleBase, ConstantWriteAccess, TNamespace {
    */
   override predicate hasGlobalScope() { none() }
 
+  overlay[global]
   final override Module getModule() {
     result = any(string qName | qName = namespaceDeclaration(this) | TResolved(qName))
     or

ruby/ql/lib/codeql/ruby/ast/Pattern.qll

@@ -3,6 +3,7 @@ module;
 
 private import codeql.ruby.AST
 private import internal.AST
+private import internal.Literal
 private import internal.Pattern
 private import internal.TreeSitter
 private import internal.Variable
@@ -208,7 +209,7 @@ class HashPattern extends CasePattern, THashPattern {
   /** Gets the value for a given key name. */
   CasePattern getValueByKey(string key) {
     exists(int i |
-      this.getKey(i).getConstantValue().isStringlikeValue(key) and result = this.getValue(i)
+      key = this.getKey(i).(StringlikeLiteralImpl).getStringValue() and result = this.getValue(i)
     )
   }