Code cleanup from code review

github · smowton · Mar 18, 2022 · Feb 14, 2022 · Feb 14, 2022 · Feb 15, 2022
commit 50ff2c2c68aea31f70a4d7019ffcc2788d9c2632
@@ -1,3 +1,7 @@
+/**
+ * Provides classes and predicates for working with java system properties.
+ */
+
 import java
 private import semmle.code.java.dataflow.DataFlow
 private import semmle.code.java.frameworks.Properties

@@ -2,10 +2,14 @@
 import semmle.code.java.Type
 private import semmle.code.java.dataflow.FlowSteps
 
+/**
+ * The `java.util.Properties` class.
+ */
 class TypeProperty extends Class {
   TypeProperty() { hasQualifiedName("java.util", "Properties") }
 }
 
+/** The `getProperty` method of the class `java.util.Properties`. */
 class PropertiesGetPropertyMethod extends ValuePreservingMethod {
   PropertiesGetPropertyMethod() {
     getDeclaringType() instanceof TypeProperty and
@@ -15,20 +19,25 @@ class PropertiesGetPropertyMethod extends ValuePreservingMethod {
   override predicate returnsValue(int arg) { arg = 1 }
 }
 
+/** The `get` method of the class `java.util.Properties`. */
 class PropertiesGetMethod extends Method {
   PropertiesGetMethod() {
     getDeclaringType() instanceof TypeProperty and
     hasName("get")
   }
 }
 
+/** The `setProperty` method of the class `java.util.Properties`. */
 class PropertiesSetPropertyMethod extends Method {
   PropertiesSetPropertyMethod() {
     getDeclaringType() instanceof TypeProperty and
     hasName("setProperty")
   }
 }
 
+/**
+ * The methods of the class `java.util.Properties` that write the contents to an output.
+ */
 class PropertiesStoreMethod extends Method {
   PropertiesStoreMethod() {
     getDeclaringType() instanceof TypeProperty and

@@ -177,9 +177,7 @@ private class TempDirSystemGetPropertyDirectlyToMkdirConfig extends TaintTrackin
   }
 
   override predicate isSource(DataFlow::Node node) {
-    exists(
-      ExprSystemGetPropertyTempDirTainted propertyGetExpr, DataFlow::Node callSite
-    |
+    exists(ExprSystemGetPropertyTempDirTainted propertyGetExpr, DataFlow::Node callSite |
       DataFlow::localFlow(DataFlow::exprNode(propertyGetExpr), callSite)
     |
       isFileConstructorArgument(callSite.asExpr(), node.asExpr(), 1)

@@ -2,4 +2,4 @@ import default
 import semmle.code.java.os.OSCheck
 
 from IsSpecificUnixVariant isAnyUnix
-select isAnyUnix
+select isAnyUnix
@@ -2,4 +2,4 @@ import default
 import semmle.code.java.os.OSCheck
 
 from IsSpecificWindowsVariant isAnyWindows
-select isAnyWindows
+select isAnyWindows
@@ -2,4 +2,4 @@ import default
 import semmle.code.java.os.OSCheck
 
 from IsUnixGuard isUnix
-select isUnix
+select isUnix
@@ -2,4 +2,4 @@ import default
 import semmle.code.java.os.OSCheck
 
 from IsWindowsGuard isWindows
-select isWindows
+select isWindows