JS: Add DataFlow::Node.getLocation

Author: hvitved

config/identical-files.json

@@ -255,7 +255,6 @@
     "cpp/ql/lib/semmle/code/cpp/XML.qll",
     "csharp/ql/lib/semmle/code/csharp/XML.qll",
     "java/ql/lib/semmle/code/xml/XML.qll",
-    "javascript/ql/lib/semmle/javascript/XML.qll",
     "python/ql/lib/semmle/python/xml/XML.qll"
   ],
   "DuplicationProblems.inc.qhelp": [
@@ -372,4 +371,4 @@
     "python/ql/test/experimental/dataflow/model-summaries/InlineTaintTest.ext.yml",
     "python/ql/test/experimental/dataflow/model-summaries/NormalDataflowTest.ext.yml"
   ]
-}
+}

javascript/ql/lib/semmle/javascript/AST.qll

@@ -5,6 +5,7 @@
 import javascript
 private import internal.StmtContainers
 private import semmle.javascript.internal.CachedStages
+private import semmle.javascript.internal.Locations
 
 /**
  * A program element corresponding to JavaScript code, such as an expression
@@ -23,15 +24,20 @@ private import semmle.javascript.internal.CachedStages
  * ```
  */
 class AstNode extends @ast_node, NodeInStmtContainer {
-  override Location getLocation() { hasLocation(this, result) }
+  override DbLocation getLocation() {
+    exists(@location loc |
+      hasLocation(this, loc) and
+      result = TDbLocation(loc)
+    )
+  }
 
   override File getFile() {
     result = this.getLocation().getFile() // Specialized for performance reasons
   }
 
   /** Gets the first token belonging to this element. */
   Token getFirstToken() {
-    exists(Location l1, Location l2 |
+    exists(DbLocation l1, DbLocation l2 |
       l1 = this.getLocation() and
       l2 = result.getLocation() and
       l1.getFile() = l2.getFile() and
@@ -42,7 +48,7 @@ class AstNode extends @ast_node, NodeInStmtContainer {
 
   /** Gets the last token belonging to this element. */
   Token getLastToken() {
-    exists(Location l1, Location l2 |
+    exists(DbLocation l1, DbLocation l2 |
       l1 = this.getLocation() and
       l2 = result.getLocation() and
       l1.getFile() = l2.getFile() and

javascript/ql/lib/semmle/javascript/CFG.qll

@@ -275,6 +275,7 @@
 
 import javascript
 private import internal.StmtContainers
+private import semmle.javascript.internal.Locations
 
 /**
  * A node in the control flow graph, which is an expression, a statement,
@@ -357,7 +358,12 @@ class ControlFlowNode extends @cfg_node, Locatable, NodeInStmtContainer {
  * examples include guard nodes and entry/exit nodes.
  */
 class SyntheticControlFlowNode extends @synthetic_cfg_node, ControlFlowNode {
-  override Location getLocation() { hasLocation(this, result) }
+  override DbLocation getLocation() {
+    exists(@location loc |
+      hasLocation(this, loc) and
+      result = TDbLocation(loc)
+    )
+  }
 }
 
 /** A synthetic CFG node marking the entry point of a function or toplevel script. */

javascript/ql/lib/semmle/javascript/Comments.qll

@@ -1,6 +1,7 @@
 /** Provides classes for working with JavaScript comments. */
 
 import javascript
+private import semmle.javascript.internal.Locations
 
 /**
  * A JavaScript source-code comment.
@@ -15,7 +16,12 @@ import javascript
  * </pre>
  */
 class Comment extends @comment, Locatable {
-  override Location getLocation() { hasLocation(this, result) }
+  override DbLocation getLocation() {
+    exists(@location loc |
+      hasLocation(this, loc) and
+      result = TDbLocation(loc)
+    )
+  }
 
   /** Gets the toplevel element this comment belongs to. */
   TopLevel getTopLevel() { comments(this, _, result, _, _) }

javascript/ql/lib/semmle/javascript/Errors.qll

@@ -1,10 +1,16 @@
 /** Provides classes for working with syntax errors. */
 
 import javascript
+private import semmle.javascript.internal.Locations
 
 /** An error encountered during extraction. */
 abstract class Error extends Locatable {
-  override Location getLocation() { hasLocation(this, result) }
+  override DbLocation getLocation() {
+    exists(@location loc |
+      hasLocation(this, loc) and
+      result = TDbLocation(loc)
+    )
+  }
 
   /** Gets the message associated with this error. */
   abstract string getMessage();

javascript/ql/lib/semmle/javascript/Files.qll

@@ -3,6 +3,7 @@
 import javascript
 private import NodeModuleResolutionImpl
 private import codeql.util.FileSystem
+private import internal.Locations
 
 private module FsInput implements InputSig {
   abstract class ContainerBase extends @container {
@@ -83,7 +84,12 @@ class File extends Container, Impl::File {
    *
    * Note that files have special locations starting and ending at line zero, column zero.
    */
-  Location getLocation() { hasLocation(this, result) }
+  DbLocation getLocation() {
+    exists(@location loc |
+      hasLocation(this, loc) and
+      result = TDbLocation(loc)
+    )
+  }
 
   /** Gets the number of lines in this file. */
   int getNumberOfLines() { result = sum(int loc | numlines(this, loc, _, _) | loc) }

javascript/ql/lib/semmle/javascript/HTML.qll

@@ -1,6 +1,7 @@
 /** Provides classes for working with HTML documents. */
 
 import javascript
+private import internal.Locations
 
 module HTML {
   /**
@@ -43,7 +44,12 @@ module HTML {
   class Element extends Locatable, @xmlelement {
     Element() { exists(FileContainingHtml f | xmlElements(this, _, _, _, f)) }
 
-    override Location getLocation() { xmllocations(this, result) }
+    override DbLocation getLocation() {
+      exists(@location loc |
+        xmllocations(this, loc) and
+        result = TDbLocation(loc)
+      )
+    }
 
     /**
      * Gets the name of this HTML element.
@@ -122,7 +128,12 @@ module HTML {
   class Attribute extends Locatable, @xmlattribute {
     Attribute() { exists(FileContainingHtml f | xmlAttrs(this, _, _, _, _, f)) }
 
-    override Location getLocation() { xmllocations(this, result) }
+    override DbLocation getLocation() {
+      exists(@location loc |
+        xmllocations(this, loc) and
+        result = TDbLocation(loc)
+      )
+    }
 
     /**
      * Gets the inline script of this attribute, if any.
@@ -327,7 +338,12 @@ module HTML {
      */
     predicate isCData() { xmlChars(this, _, _, _, 1, _) }
 
-    override Location getLocation() { xmllocations(this, result) }
+    override DbLocation getLocation() {
+      exists(@location loc |
+        xmllocations(this, loc) and
+        result = TDbLocation(loc)
+      )
+    }
   }
 
   /**
@@ -350,6 +366,11 @@ module HTML {
 
     override string toString() { xmlComments(this, result, _, _) }
 
-    override Location getLocation() { xmllocations(this, result) }
+    override DbLocation getLocation() {
+      exists(@location loc |
+        xmllocations(this, loc) and
+        result = TDbLocation(loc)
+      )
+    }
   }
 }

javascript/ql/lib/semmle/javascript/JSDoc.qll

@@ -2,6 +2,7 @@
 
 import javascript
 private import semmle.javascript.internal.CachedStages
+private import semmle.javascript.internal.Locations
 
 /**
  * A JSDoc comment.
@@ -18,7 +19,12 @@ private import semmle.javascript.internal.CachedStages
  * </pre>
  */
 class JSDoc extends @jsdoc, Locatable {
-  override Location getLocation() { hasLocation(this, result) }
+  override DbLocation getLocation() {
+    exists(@location loc |
+      hasLocation(this, loc) and
+      result = TDbLocation(loc)
+    )
+  }
 
   /** Gets the description text of this JSDoc comment. */
   string getDescription() { jsdoc(this, result, _) }
@@ -75,7 +81,12 @@ abstract class Documentable extends AstNode {
  * ```
  */
 class JSDocTypeExprParent extends @jsdoc_type_expr_parent, Locatable {
-  override Location getLocation() { hasLocation(this, result) }
+  override DbLocation getLocation() {
+    exists(@location loc |
+      hasLocation(this, loc) and
+      result = TDbLocation(loc)
+    )
+  }
 
   /** Gets the JSDoc comment to which this element belongs. */
   JSDoc getJSDocComment() { none() }

javascript/ql/lib/semmle/javascript/JSON.qll

@@ -3,6 +3,7 @@
  */
 
 import javascript
+private import semmle.javascript.internal.Locations
 
 /**
  * A JSON-encoded value, which may be a primitive value, an array or an object.
@@ -20,7 +21,12 @@ import javascript
  * ```
  */
 class JsonValue extends @json_value, Locatable {
-  override Location getLocation() { json_locations(this, result) }
+  override DbLocation getLocation() {
+    exists(@location loc |
+      json_locations(this, loc) and
+      result = TDbLocation(loc)
+    )
+  }
 
   /** Gets the parent value to which this value belongs, if any. */
   JsonValue getParent() { json(this, _, result, _, _) }
@@ -35,9 +41,9 @@ class JsonValue extends @json_value, Locatable {
 
   /** Gets the JSON file containing this value. */
   File getJsonFile() {
-    exists(Location loc |
+    exists(@location loc |
       json_locations(this, loc) and
-      result = loc.getFile()
+      result = TDbLocation(loc).(DbLocation).getFile()
     )
   }
 
@@ -172,7 +178,12 @@ class JsonObject extends @json_object, JsonValue {
  * An error reported by the JSON parser.
  */
 class JsonParseError extends @json_parse_error, Error {
-  override Location getLocation() { json_locations(this, result) }
+  override DbLocation getLocation() {
+    exists(@location loc |
+      json_locations(this, loc) and
+      result = TDbLocation(loc)
+    )
+  }
 
   override string getMessage() { json_errors(this, result) }
 }

javascript/ql/lib/semmle/javascript/Lines.qll

@@ -6,6 +6,7 @@
  */
 
 import javascript
+private import semmle.javascript.internal.Locations
 
 /**
  * A line of text (code, comment, or whitespace) in a source file.
@@ -14,7 +15,12 @@ import javascript
  * extracted with the `--extract-program-text` flag.
  */
 class Line extends @line, Locatable {
-  override Location getLocation() { hasLocation(this, result) }
+  override DbLocation getLocation() {
+    exists(@location loc |
+      hasLocation(this, loc) and
+      result = TDbLocation(loc)
+    )
+  }
 
   /** Gets the toplevel element this line belongs to. */
   TopLevel getTopLevel() { lines(this, result, _, _) }