iterate on the implementation, and use shared Locations implementation in JavaScript

Author: erik-krogh

javascript/ql/lib/qlpack.yml

@@ -5,3 +5,5 @@ dbscheme: semmlecode.javascript.dbscheme
 extractor: javascript
 library: true
 upgrades: upgrades
+dependencies:
+  codeql/utils: 0.0.1

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

@@ -2,179 +2,35 @@
 
 import javascript
 private import NodeModuleResolutionImpl
+private import codeql.utils.FileSystem as FS
 
-/** A file or folder. */
-abstract class Container extends @container {
-  /**
-   * Gets the absolute, canonical path of this container, using forward slashes
-   * as path separator.
-   *
-   * The path starts with a _root prefix_ followed by zero or more _path
-   * segments_ separated by forward slashes.
-   *
-   * The root prefix is of one of the following forms:
-   *
-   *   1. A single forward slash `/` (Unix-style)
-   *   2. An upper-case drive letter followed by a colon and a forward slash,
-   *      such as `C:/` (Windows-style)
-   *   3. Two forward slashes, a computer name, and then another forward slash,
-   *      such as `//FileServer/` (UNC-style)
-   *
-   * Path segments are never empty (that is, absolute paths never contain two
-   * contiguous slashes, except as part of a UNC-style root prefix). Also, path
-   * segments never contain forward slashes, and no path segment is of the
-   * form `.` (one dot) or `..` (two dots).
-   *
-   * Note that an absolute path never ends with a forward slash, except if it is
-   * a bare root prefix, that is, the path has no path segments. A container
-   * whose absolute path has no segments is always a `Folder`, not a `File`.
-   */
-  abstract string getAbsolutePath();
+module FSImpl implements FS::FilesSig {
+  // TODO: Move to internal/ folder?
+  abstract class AtContainer extends @container {
+    abstract string getAbsolutePath();
 
-  /**
-   * Gets a URL representing the location of this container.
-   *
-   * For more information see [Providing URLs](https://codeql.github.com/docs/writing-codeql-queries/providing-locations-in-codeql-queries/#providing-urls).
-   */
-  abstract string getURL();
+    string toString() { result = this.getAbsolutePath() }
 
-  /**
-   * Gets the relative path of this file or folder from the root folder of the
-   * analyzed source location. The relative path of the root folder itself is
-   * the empty string.
-   *
-   * This has no result if the container is outside the source root, that is,
-   * if the root folder is not a reflexive, transitive parent of this container.
-   */
-  string getRelativePath() {
-    exists(string absPath, string pref |
-      absPath = this.getAbsolutePath() and sourceLocationPrefix(pref)
-    |
-      absPath = pref and result = ""
-      or
-      absPath = pref.regexpReplaceAll("/$", "") + "/" + result and
-      not result.matches("/%")
-    )
+    AtContainer getParentContainer() { containerparent(result, this) }
   }
 
-  /**
-   * Gets the base name of this container including extension, that is, the last
-   * segment of its absolute path, or the empty string if it has no segments.
-   *
-   * Here are some examples of absolute paths and the corresponding base names
-   * (surrounded with quotes to avoid ambiguity):
-   *
-   * <table border="1">
-   * <tr><th>Absolute path</th><th>Base name</th></tr>
-   * <tr><td>"/tmp/tst.js"</td><td>"tst.js"</td></tr>
-   * <tr><td>"C:/Program Files (x86)"</td><td>"Program Files (x86)"</td></tr>
-   * <tr><td>"/"</td><td>""</td></tr>
-   * <tr><td>"C:/"</td><td>""</td></tr>
-   * <tr><td>"D:/"</td><td>""</td></tr>
-   * <tr><td>"//FileServer/"</td><td>""</td></tr>
-   * </table>
-   */
-  string getBaseName() {
-    result = this.getAbsolutePath().regexpCapture(".*/(([^/]*?)(\\.([^.]*))?)", 1)
+  class AtFile extends @file, AtContainer {
+    override string getAbsolutePath() { files(this, result) }
   }
 
-  /**
-   * Gets the extension of this container, that is, the suffix of its base name
-   * after the last dot character, if any.
-   *
-   * In particular,
-   *
-   *  - if the name does not include a dot, there is no extension, so this
-   *    predicate has no result;
-   *  - if the name ends in a dot, the extension is the empty string;
-   *  - if the name contains multiple dots, the extension follows the last dot.
-   *
-   * Here are some examples of absolute paths and the corresponding extensions
-   * (surrounded with quotes to avoid ambiguity):
-   *
-   * <table border="1">
-   * <tr><th>Absolute path</th><th>Extension</th></tr>
-   * <tr><td>"/tmp/tst.js"</td><td>"js"</td></tr>
-   * <tr><td>"/tmp/.classpath"</td><td>"classpath"</td></tr>
-   * <tr><td>"/bin/bash"</td><td>not defined</td></tr>
-   * <tr><td>"/tmp/tst2."</td><td>""</td></tr>
-   * <tr><td>"/tmp/x.tar.gz"</td><td>"gz"</td></tr>
-   * </table>
-   */
-  string getExtension() {
-    result = this.getAbsolutePath().regexpCapture(".*/(([^/]*?)(\\.([^.]*))?)", 4)
+  class AtFolder extends @folder, AtContainer {
+    override string getAbsolutePath() { folders(this, result) }
   }
 
-  /**
-   * Gets the stem of this container, that is, the prefix of its base name up to
-   * (but not including) the last dot character if there is one, or the entire
-   * base name if there is not.
-   *
-   * Here are some examples of absolute paths and the corresponding stems
-   * (surrounded with quotes to avoid ambiguity):
-   *
-   * <table border="1">
-   * <tr><th>Absolute path</th><th>Stem</th></tr>
-   * <tr><td>"/tmp/tst.js"</td><td>"tst"</td></tr>
-   * <tr><td>"/tmp/.classpath"</td><td>""</td></tr>
-   * <tr><td>"/bin/bash"</td><td>"bash"</td></tr>
-   * <tr><td>"/tmp/tst2."</td><td>"tst2"</td></tr>
-   * <tr><td>"/tmp/x.tar.gz"</td><td>"x.tar"</td></tr>
-   * </table>
-   */
-  string getStem() {
-    result = this.getAbsolutePath().regexpCapture(".*/(([^/]*?)(\\.([^.]*))?)", 2)
-  }
-
-  /** Gets the parent container of this file or folder, if any. */
-  Container getParentContainer() { containerparent(result, this) }
-
-  /** Gets a file or sub-folder in this container. */
-  Container getAChildContainer() { this = result.getParentContainer() }
-
-  /** Gets a file in this container. */
-  File getAFile() { result = this.getAChildContainer() }
-
-  /** Gets the file in this container that has the given `baseName`, if any. */
-  File getFile(string baseName) {
-    result = this.getAFile() and
-    result.getBaseName() = baseName
-  }
-
-  /** Gets a sub-folder in this container. */
-  Folder getAFolder() { result = this.getAChildContainer() }
-
-  /** Gets the sub-folder in this container that has the given `baseName`, if any. */
-  Folder getFolder(string baseName) {
-    result = this.getAFolder() and
-    result.getBaseName() = baseName
-  }
-
-  /**
-   * Gets a textual representation of the path of this container.
-   *
-   * This is the absolute path of the container.
-   */
-  string toString() { result = this.getAbsolutePath() }
+  string getSourceLocationPrefix() { sourceLocationPrefix(result) }
 }
 
-/** A folder. */
-class Folder extends Container, @folder {
-  override string getAbsolutePath() { folders(this, result) }
-
-  /** Gets the file or subfolder in this folder that has the given `name`, if any. */
-  Container getChildContainer(string name) {
-    result = this.getAChildContainer() and
-    result.getBaseName() = name
-  }
+private module FSInst = FS::Make<FSImpl>;
 
-  /** Gets the file in this folder that has the given `stem` and `extension`, if any. */
-  File getFile(string stem, string extension) {
-    result = this.getAChildContainer() and
-    result.getStem() = stem and
-    result.getExtension() = extension
-  }
+class Container = FSInst::Container;
 
+/** A folder. */
+class Folder extends FSInst::Folder {
   /** Like `getFile` except `d.ts` is treated as a single extension. */
   private File getFileLongExtension(string stem, string extension) {
     not (stem.matches("%.d") and extension = "ts") and
@@ -203,25 +59,17 @@ class Folder extends Container, @folder {
         this.getFileLongExtension(stem, ext) order by p
       )
   }
-
-  /** Gets a subfolder contained in this folder. */
-  Folder getASubFolder() { result = this.getAChildContainer() }
-
-  /** Gets the URL of this folder. */
-  override string getURL() { result = "folder://" + this.getAbsolutePath() }
 }
 
 /** A file. */
-class File extends Container, @file {
+class File extends FSInst::File {
   /**
    * Gets the location of this file.
    *
    * Note that files have special locations starting and ending at line zero, column zero.
    */
   Location getLocation() { hasLocation(this, result) }
 
-  override string getAbsolutePath() { files(this, result) }
-
   /** Gets the number of lines in this file. */
   int getNumberOfLines() { result = sum(int loc | numlines(this, loc, _, _) | loc) }
 
@@ -234,9 +82,6 @@ class File extends Container, @file {
   /** Gets a toplevel piece of JavaScript code in this file. */
   TopLevel getATopLevel() { result.getFile() = this }
 
-  /** Gets the URL of this file. */
-  override string getURL() { result = "file://" + this.getAbsolutePath() + ":0:0:0:0" }
-
   /**
    * Holds if line number `lineno` of this file is indented to depth `d`
    * using character `c`.

javascript/ql/lib/semmle/javascript/Locations.qll

@@ -1,85 +1,32 @@
 /** Provides classes for working with locations and program elements that have locations. */
 
 import javascript
+private import codeql.utils.Locations as Loc
+private import codeql.utils.FileSystem as FS
+
+private module LocationsImpl implements Loc::LocationsSig<FSImpl> {
+  class AtLocation = @location;
+
+  predicate locations(
+    AtLocation loc, FSImpl::AtFile file, int startLine, int startColum, int endLine, int endColumn
+  ) {
+    locations_default(loc, file, startLine, startColum, endLine, endColumn)
+  }
+}
 
 /**
  * A location as given by a file, a start line, a start column,
  * an end line, and an end column.
  *
  * For more information about locations see [Locations](https://codeql.github.com/docs/writing-codeql-queries/providing-locations-in-codeql-queries/).
  */
-class Location extends @location {
-  /** Gets the file for this location. */
-  File getFile() { locations_default(this, result, _, _, _, _) }
-
-  /** Gets the 1-based line number (inclusive) where this location starts. */
-  int getStartLine() { locations_default(this, _, result, _, _, _) }
-
-  /** Gets the 1-based column number (inclusive) where this location starts. */
-  int getStartColumn() { locations_default(this, _, _, result, _, _) }
-
-  /** Gets the 1-based line number (inclusive) where this location ends. */
-  int getEndLine() { locations_default(this, _, _, _, result, _) }
-
-  /** Gets the 1-based column number (inclusive) where this location ends. */
-  int getEndColumn() { locations_default(this, _, _, _, _, result) }
-
-  /** Gets the number of lines covered by this location. */
-  int getNumLines() { result = this.getEndLine() - this.getStartLine() + 1 }
-
-  /** Holds if this location starts before location `that`. */
-  pragma[inline]
-  predicate startsBefore(Location that) {
-    exists(File f, int sl1, int sc1, int sl2, int sc2 |
-      locations_default(this, f, sl1, sc1, _, _) and
-      locations_default(that, f, sl2, sc2, _, _)
-    |
-      sl1 < sl2
-      or
-      sl1 = sl2 and sc1 < sc2
-    )
-  }
-
-  /** Holds if this location ends after location `that`. */
-  pragma[inline]
-  predicate endsAfter(Location that) {
-    exists(File f, int el1, int ec1, int el2, int ec2 |
-      locations_default(this, f, _, _, el1, ec1) and
-      locations_default(that, f, _, _, el2, ec2)
-    |
-      el1 > el2
-      or
-      el1 = el2 and ec1 > ec2
-    )
-  }
-
-  /**
-   * Holds if this location contains location `that`, meaning that it starts
-   * before and ends after it.
-   */
-  predicate contains(Location that) { this.startsBefore(that) and this.endsAfter(that) }
-
-  /** Holds if this location is empty. */
-  predicate isEmpty() { exists(int l, int c | locations_default(this, _, l, c, l, c - 1)) }
-
-  /** Gets a textual representation of this element. */
-  string toString() { result = this.getFile().getBaseName() + ":" + this.getStartLine().toString() }
-
+class Location extends Loc::Make<FSImpl, LocationsImpl>::Location {
   /**
-   * Holds if this element is at the specified location.
-   * The location spans column `startcolumn` of line `startline` to
-   * column `endcolumn` of line `endline` in file `filepath`.
-   * For more information, see
-   * [Locations](https://codeql.github.com/docs/writing-codeql-queries/providing-locations-in-codeql-queries/).
+   * Holds if this location starts strictly before the specified location.
+   * Alias for `strictlyBefore`.
    */
-  predicate hasLocationInfo(
-    string filepath, int startline, int startcolumn, int endline, int endcolumn
-  ) {
-    exists(File f |
-      locations_default(this, f, startline, startcolumn, endline, endcolumn) and
-      filepath = f.getAbsolutePath()
-    )
-  }
+  pragma[inline]
+  predicate startsBefore(Location other) { this.strictlyBefore(other) }
 }
 
 /** A program element with a location. */

ruby/ql/lib/codeql/Locations.qll

@@ -1,18 +1,4 @@
-private import codeql.utils.Locations as L
-import codeql.files.FileSystem
-
-private module LocationsImpl implements L::LocationsSig {
-  class File_ = File;
-
-  class AtLocation = @location_default;
-
-  predicate locations(
-    AtLocation loc, File file, int startLine, int startColum, int endLine, int endColumn
-  ) {
-    locations_default(loc, file, startLine, startColum, endLine, endColumn)
-  }
-
-  string getAbsolutePath(File f) { result = f.getAbsolutePath() }
-}
-
-import L::Make<LocationsImpl>
+private import codeql.utils.Locations as Locs
+private import codeql.files.FilesImpl::FilesImpl as FSImpl
+private import codeql.LocationsImpl::LocationsImpl as LImpl
+import Locs::Make<FSImpl, LImpl>

ruby/ql/lib/codeql/LocationsImpl.qll

@@ -0,0 +1,12 @@
+private import codeql.utils.Locations as Locs
+private import codeql.files.FilesImpl::FilesImpl as FSImpl
+
+module LocationsImpl implements Locs::LocationsSig<FSImpl> {
+  class AtLocation = @location_default;
+
+  predicate locations(
+    AtLocation loc, FSImpl::AtFile file, int startLine, int startColum, int endLine, int endColumn
+  ) {
+    locations_default(loc, file, startLine, startColum, endLine, endColumn)
+  }
+}