Introduce separate files for predicate definitions

Author: koesie10

extensions/ql-vscode/src/model-editor/languages/models-as-data.ts

@@ -0,0 +1,19 @@
+import { ModeledMethod, ModeledMethodType } from "../modeled-method";
+import { DataTuple } from "../model-extension-file";
+
+type GenerateMethodDefinition = (method: ModeledMethod) => DataTuple[];
+type ReadModeledMethod = (row: DataTuple[]) => ModeledMethod;
+
+export type ModelsAsDataLanguageModelType = Exclude<ModeledMethodType, "none">;
+
+export type ModelsAsDataLanguageModel = {
+  extensiblePredicate: string;
+  supportedKinds: string[];
+  generateMethodDefinition: GenerateMethodDefinition;
+  readModeledMethod: ReadModeledMethod;
+};
+
+export type ModelsAsDataLanguage = Record<
+  ModelsAsDataLanguageModelType,
+  ModelsAsDataLanguageModel
+>;

extensions/ql-vscode/src/model-editor/languages/shared.ts

@@ -0,0 +1,25 @@
+export const sharedExtensiblePredicates = {
+  source: "sourceModel",
+  sink: "sinkModel",
+  summary: "summaryModel",
+  neutral: "neutralModel",
+};
+
+export const sharedKinds = {
+  source: ["local", "remote"],
+  sink: [
+    "code-injection",
+    "command-injection",
+    "file-content-store",
+    "html-injection",
+    "js-injection",
+    "ldap-injection",
+    "log-injection",
+    "path-injection",
+    "request-forgery",
+    "sql-injection",
+    "url-redirection",
+  ],
+  summary: ["taint", "value"],
+  neutral: ["summary", "source", "sink"],
+};

extensions/ql-vscode/src/model-editor/languages/static.ts

@@ -0,0 +1,132 @@
+import { ModelsAsDataLanguage } from "./models-as-data";
+import { ModeledMethodType, Provenance } from "../modeled-method";
+import { DataTuple } from "../model-extension-file";
+import { sharedExtensiblePredicates, sharedKinds } from "./shared";
+
+function readRowToMethod(row: DataTuple[]): string {
+  return `${row[0]}.${row[1]}#${row[3]}${row[4]}`;
+}
+
+export const staticLanguage: ModelsAsDataLanguage = {
+  source: {
+    extensiblePredicate: sharedExtensiblePredicates.source,
+    supportedKinds: sharedKinds.source,
+    // extensible predicate sourceModel(
+    //   string package, string type, boolean subtypes, string name, string signature, string ext,
+    //   string output, string kind, string provenance
+    // );
+    generateMethodDefinition: (method) => [
+      method.packageName,
+      method.typeName,
+      true,
+      method.methodName,
+      method.methodParameters,
+      "",
+      method.output,
+      method.kind,
+      method.provenance,
+    ],
+    readModeledMethod: (row) => ({
+      type: "source" as ModeledMethodType,
+      input: "",
+      output: row[6] as string,
+      kind: row[7] as string,
+      provenance: row[8] as Provenance,
+      signature: readRowToMethod(row),
+      packageName: row[0] as string,
+      typeName: row[1] as string,
+      methodName: row[3] as string,
+      methodParameters: row[4] as string,
+    }),
+  },
+  sink: {
+    extensiblePredicate: sharedExtensiblePredicates.sink,
+    supportedKinds: sharedKinds.sink,
+    // extensible predicate sinkModel(
+    //   string package, string type, boolean subtypes, string name, string signature, string ext,
+    //   string input, string kind, string provenance
+    // );
+    generateMethodDefinition: (method) => [
+      method.packageName,
+      method.typeName,
+      true,
+      method.methodName,
+      method.methodParameters,
+      "",
+      method.input,
+      method.kind,
+      method.provenance,
+    ],
+    readModeledMethod: (row) => ({
+      type: "sink",
+      input: row[6] as string,
+      output: "",
+      kind: row[7] as string,
+      provenance: row[8] as Provenance,
+      signature: readRowToMethod(row),
+      packageName: row[0] as string,
+      typeName: row[1] as string,
+      methodName: row[3] as string,
+      methodParameters: row[4] as string,
+    }),
+  },
+  summary: {
+    extensiblePredicate: sharedExtensiblePredicates.summary,
+    supportedKinds: sharedKinds.summary,
+    // extensible predicate summaryModel(
+    //   string package, string type, boolean subtypes, string name, string signature, string ext,
+    //   string input, string output, string kind, string provenance
+    // );
+    generateMethodDefinition: (method) => [
+      method.packageName,
+      method.typeName,
+      true,
+      method.methodName,
+      method.methodParameters,
+      "",
+      method.input,
+      method.output,
+      method.kind,
+      method.provenance,
+    ],
+    readModeledMethod: (row) => ({
+      type: "summary",
+      input: row[6] as string,
+      output: row[7] as string,
+      kind: row[8] as string,
+      provenance: row[9] as Provenance,
+      signature: readRowToMethod(row),
+      packageName: row[0] as string,
+      typeName: row[1] as string,
+      methodName: row[3] as string,
+      methodParameters: row[4] as string,
+    }),
+  },
+  neutral: {
+    extensiblePredicate: sharedExtensiblePredicates.neutral,
+    supportedKinds: sharedKinds.neutral,
+    // extensible predicate neutralModel(
+    //   string package, string type, string name, string signature, string kind, string provenance
+    // );
+    generateMethodDefinition: (method) => [
+      method.packageName,
+      method.typeName,
+      method.methodName,
+      method.methodParameters,
+      method.kind,
+      method.provenance,
+    ],
+    readModeledMethod: (row) => ({
+      type: "neutral",
+      input: "",
+      output: "",
+      kind: row[4] as string,
+      provenance: row[5] as Provenance,
+      signature: `${row[0]}.${row[1]}#${row[2]}${row[3]}`,
+      packageName: row[0] as string,
+      typeName: row[1] as string,
+      methodName: row[2] as string,
+      methodParameters: row[3] as string,
+    }),
+  },
+};