Shared: Put the content of CaptureSummaryFlowQuery into the shared library code.

michaelnebel · michaelnebel · commit e6085759ae2a · 2024-09-24T15:46:44.000+02:00
diff --git a/csharp/ql/src/utils/modelgenerator/CaptureNeutralModels.ql b/csharp/ql/src/utils/modelgenerator/CaptureNeutralModels.ql
@@ -6,9 +6,7 @@
  * @tags modelgenerator
  */
 
-import semmle.code.csharp.dataflow.internal.FlowSummaryImpl as FlowSummaryImpl
 import internal.CaptureModels
-import internal.CaptureSummaryFlowQuery
 
 from DataFlowSummaryTargetApi api, string noflow
 where noflow = captureNoFlow(api)
diff --git a/csharp/ql/src/utils/modelgenerator/CaptureSummaryModels.ql b/csharp/ql/src/utils/modelgenerator/CaptureSummaryModels.ql
@@ -6,9 +6,7 @@
  * @tags modelgenerator
  */
 
-import semmle.code.csharp.dataflow.internal.FlowSummaryImpl as FlowSummaryImpl
 import internal.CaptureModels
-import internal.CaptureSummaryFlowQuery
 
 from DataFlowSummaryTargetApi api, string flow
 where flow = captureFlow(api)
diff --git a/csharp/ql/src/utils/modelgenerator/internal/CaptureSummaryFlowQuery.qll b/csharp/ql/src/utils/modelgenerator/internal/CaptureSummaryFlowQuery.qll
diff --git a/csharp/ql/test/utils/modelgenerator/dataflow/CaptureNeutralModels.ql b/csharp/ql/test/utils/modelgenerator/dataflow/CaptureNeutralModels.ql
@@ -1,5 +1,5 @@
 import csharp
-import utils.modelgenerator.internal.CaptureSummaryFlowQuery
+import utils.modelgenerator.internal.CaptureModels
 import TestUtilities.InlineMadTest
 
 module InlineMadTestConfig implements InlineMadTestConfigSig {
diff --git a/csharp/ql/test/utils/modelgenerator/dataflow/CaptureSummaryModels.ql b/csharp/ql/test/utils/modelgenerator/dataflow/CaptureSummaryModels.ql
@@ -1,5 +1,5 @@
 import csharp
-import utils.modelgenerator.internal.CaptureSummaryFlowQuery
+import utils.modelgenerator.internal.CaptureModels
 import TestUtilities.InlineMadTest
 
 module InlineMadTestConfig implements InlineMadTestConfigSig {
diff --git a/java/ql/src/utils/modelgenerator/CaptureNeutralModels.ql b/java/ql/src/utils/modelgenerator/CaptureNeutralModels.ql
@@ -7,7 +7,6 @@
  */
 
 import internal.CaptureModels
-import internal.CaptureSummaryFlowQuery
 
 from DataFlowSummaryTargetApi api, string noflow
 where noflow = captureNoFlow(api)
diff --git a/java/ql/src/utils/modelgenerator/CaptureSummaryModels.ql b/java/ql/src/utils/modelgenerator/CaptureSummaryModels.ql
@@ -7,7 +7,6 @@
  */
 
 import internal.CaptureModels
-import internal.CaptureSummaryFlowQuery
 
 from DataFlowSummaryTargetApi api, string flow
 where flow = captureFlow(api)
diff --git a/java/ql/src/utils/modelgenerator/internal/CaptureSummaryFlowQuery.qll b/java/ql/src/utils/modelgenerator/internal/CaptureSummaryFlowQuery.qll
diff --git a/java/ql/test/utils/modelgenerator/dataflow/CaptureNeutralModels.ql b/java/ql/test/utils/modelgenerator/dataflow/CaptureNeutralModels.ql
@@ -1,5 +1,5 @@
 import java
-import utils.modelgenerator.internal.CaptureSummaryFlowQuery
+import utils.modelgenerator.internal.CaptureModels
 import TestUtilities.InlineMadTest
 
 module InlineMadTestConfig implements InlineMadTestConfigSig {
diff --git a/java/ql/test/utils/modelgenerator/dataflow/CaptureSummaryModels.ql b/java/ql/test/utils/modelgenerator/dataflow/CaptureSummaryModels.ql
@@ -1,5 +1,5 @@
 import java
-import utils.modelgenerator.internal.CaptureSummaryFlowQuery
+import utils.modelgenerator.internal.CaptureModels
 import TestUtilities.InlineMadTest
 
 module InlineMadTestConfig implements InlineMadTestConfigSig {
diff --git a/shared/mad/codeql/mad/modelgenerator/internal/ModelGeneratorImpl.qll b/shared/mad/codeql/mad/modelgenerator/internal/ModelGeneratorImpl.qll
@@ -376,7 +376,7 @@ module MakeModelGenerator<
   /**
    * Gets the summary model of `api`, if it follows the `fluent` programming pattern (returns `this`).
    */
-  string captureQualifierFlow(DataFlowSummaryTargetApi api) {
+  private string captureQualifierFlow(DataFlowSummaryTargetApi api) {
     exists(ReturnNodeExt ret |
       api = returnNodeEnclosingCallable(ret) and
       isOwnInstanceAccessNode(ret)
@@ -498,13 +498,35 @@ module MakeModelGenerator<
   /**
    * Gets the summary model(s) of `api`, if there is flow from parameters to return value or parameter.
    */
-  string captureThroughFlow(DataFlowSummaryTargetApi api) {
+  private string captureThroughFlow(DataFlowSummaryTargetApi api) {
     exists(DataFlow::ParameterNode p, ReturnNodeExt returnNodeExt |
       PropagateFlow::flow(p, returnNodeExt) and
       result = captureThroughFlow0(api, p, returnNodeExt)
     )
   }
 
+  /**
+   * Gets the summary model(s) of `api`, if there is flow from parameters to the
+   * return value or parameter or if `api` is a fluent API.
+   */
+  string captureFlow(DataFlowSummaryTargetApi api) {
+    result = captureQualifierFlow(api) or
+    result = captureThroughFlow(api)
+  }
+
+  /**
+   * Gets the neutral summary model for `api`, if any.
+   * A neutral summary model is generated, if we are not generating
+   * a summary model that applies to `api`.
+   */
+  string captureNoFlow(DataFlowSummaryTargetApi api) {
+    not exists(DataFlowSummaryTargetApi api0 |
+      exists(captureFlow(api0)) and api0.lift() = api.lift()
+    ) and
+    api.isRelevant() and
+    result = ModelPrinting::asNeutralSummaryModel(api)
+  }
+
   /**
    * Provides classes and predicates related to capturing summary models
    * based on content data flow.
