Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
org.sonarsource.dotnet.shared.sarif.SarifParser10 Maven / Gradle / Ivy
/*
* SonarSource :: .NET :: Shared library
* Copyright (C) 2014-2024 SonarSource SA
* mailto:info AT sonarsource DOT com
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
package org.sonarsource.dotnet.shared.sarif;
import com.google.gson.Gson;
import com.google.gson.JsonArray;
import com.google.gson.JsonElement;
import com.google.gson.JsonObject;
import com.google.gson.reflect.TypeToken;
import java.io.File;
import java.net.URI;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
import java.util.Map.Entry;
import java.util.function.UnaryOperator;
import javax.annotation.CheckForNull;
import javax.annotation.Nullable;
import org.sonar.api.scanner.fs.InputProject;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
class SarifParser10 implements SarifParser {
private static final Logger LOG = LoggerFactory.getLogger(SarifParser10.class);
private static final String PROPERTIES_PROP = "properties";
private static final String LEVEL_PROP = "level";
private final InputProject inputProject;
private final JsonObject root;
private final UnaryOperator toRealPath;
SarifParser10(InputProject inputProject, JsonObject root, UnaryOperator toRealPath) {
this.inputProject = inputProject;
this.root = root;
this.toRealPath = toRealPath;
}
@Override
public void accept(SarifParserCallback callback) {
if (!root.has("runs")) {
return;
}
for (JsonElement runElement : root.get("runs").getAsJsonArray()) {
JsonObject run = runElement.getAsJsonObject();
// Process rules first
if (run.has("rules")) {
handleRules(run.getAsJsonObject("rules"), callback);
}
if (run.has("results")) {
handleIssues(run.getAsJsonArray("results"), callback);
}
}
}
private static void handleRules(JsonObject rules, SarifParserCallback callback) {
for (Entry ruleEl : rules.entrySet()) {
JsonObject ruleObj = ruleEl.getValue().getAsJsonObject();
handleRule(ruleObj, callback);
}
}
private static void handleRule(JsonObject ruleObj, SarifParserCallback callback) {
String ruleId = ruleObj.get("id").getAsString();
String shortDescription = ruleObj.has("shortDescription") ? ruleObj.get("shortDescription").getAsString() : null;
String fullDescription = ruleObj.has("fullDescription") ? ruleObj.get("fullDescription").getAsString() : null;
String defaultLevel = ruleObj.has("defaultLevel") ? ruleObj.get("defaultLevel").getAsString() : "warning";
String category = null;
if (ruleObj.has(PROPERTIES_PROP)) {
JsonObject props = ruleObj.getAsJsonObject(PROPERTIES_PROP);
if (props.has("category")) {
category = props.get("category").getAsString();
}
}
callback.onRule(ruleId, shortDescription, fullDescription, defaultLevel, category);
}
private void handleIssues(JsonArray results, SarifParserCallback callback) {
for (JsonElement resultEl : results) {
JsonObject resultObj = resultEl.getAsJsonObject();
handleIssue(resultObj, callback);
}
}
private void handleIssue(JsonObject resultObj, SarifParserCallback callback) {
if (isSuppressed(resultObj)) {
return;
}
String ruleId = resultObj.get("ruleId").getAsString();
String message = resultObj.has("message") ? resultObj.get("message").getAsString() : null;
if (message == null){
LOG.warn("Issue raised without a message for rule {}. Content: {}.", ruleId, resultObj);
return;
}
String level = resultObj.has(LEVEL_PROP) ? resultObj.get(LEVEL_PROP).getAsString() : null;
if (!handleLocationsElement(resultObj, ruleId, message, callback)) {
callback.onProjectIssue(ruleId, level, inputProject, message);
}
}
private boolean handleLocationsElement(JsonObject resultObj, String ruleId, String message, SarifParserCallback callback) {
if (!resultObj.has("locations")) {
return false;
}
String level = resultObj.has(LEVEL_PROP) ? resultObj.get(LEVEL_PROP).getAsString() : null;
JsonArray locations = resultObj.getAsJsonArray("locations");
if (locations.size() != 1) {
return false;
}
JsonArray relatedLocations = new JsonArray();
if (resultObj.has("relatedLocations")) {
relatedLocations = resultObj.getAsJsonArray("relatedLocations");
}
Map messageMap = new HashMap<>();
if (resultObj.has(PROPERTIES_PROP)) {
JsonObject properties = resultObj.getAsJsonObject(PROPERTIES_PROP);
if (properties.has("customProperties")) {
messageMap = new Gson().fromJson(properties.get("customProperties"), new TypeToken>() {
}.getType());
}
}
JsonObject firstIssueLocation = locations.get(0).getAsJsonObject().getAsJsonObject("resultFile");
return handleResultFileElement(ruleId, level, message, firstIssueLocation, relatedLocations, messageMap, callback);
}
private boolean handleResultFileElement(String ruleId, @Nullable String level, String message, JsonObject resultFileObj, JsonArray relatedLocations,
Map messageMap, SarifParserCallback callback) {
if (!resultFileObj.has("uri") || !resultFileObj.has("region")) {
return false;
}
Collection secondaryLocations = new ArrayList<>();
for (JsonElement relatedLocationEl : relatedLocations) {
JsonObject relatedLocationObj = relatedLocationEl.getAsJsonObject().getAsJsonObject("physicalLocation");
if (!relatedLocationObj.has("uri")) {
return false;
}
String secondaryMessage = messageMap.getOrDefault(String.valueOf(secondaryLocations.size()), null);
Location secondaryLocation = handleLocation(relatedLocationObj, secondaryMessage);
if (secondaryLocation == null) {
return false;
}
secondaryLocations.add(secondaryLocation);
}
Location primaryLocation = handleLocation(resultFileObj, message);
if (primaryLocation == null) {
String uri = resultFileObj.get("uri").getAsString();
String path = toRealPath.apply(uriToPath(uri));
callback.onFileIssue(ruleId, level, path, secondaryLocations, message);
} else {
callback.onIssue(ruleId, level, primaryLocation, secondaryLocations);
}
return true;
}
@CheckForNull
private Location handleLocation(JsonObject locationObj, String message) {
String uri = locationObj.get("uri").getAsString();
String path = toRealPath.apply(uriToPath(uri));
JsonObject region = locationObj.get("region").getAsJsonObject();
int startLine = region.get("startLine").getAsInt();
JsonElement startColumnOrNull = region.get("startColumn");
int startColumn = startColumnOrNull != null ? startColumnOrNull.getAsInt() : 1;
int startLineOffset = startColumn - 1;
JsonElement lengthOrNull = region.get("length");
if (lengthOrNull != null) {
return new Location(path, message, startLine, startLineOffset, startLine, startLineOffset + lengthOrNull.getAsInt());
}
JsonElement endLineOrNull = region.get("endLine");
int endLine = endLineOrNull != null ? endLineOrNull.getAsInt() : startLine;
JsonElement endColumnOrNull = region.get("endColumn");
int endColumn;
if (endColumnOrNull != null) {
endColumn = endColumnOrNull.getAsInt();
} else if (endLineOrNull != null) {
endColumn = endLine == startLine ? startColumn : 1;
} else {
endColumn = startColumn;
}
int endLineOffset = endColumn - 1;
if (startColumn == endColumn && startLine == endLine) {
return null;
}
return new Location(path, message, startLine, startLineOffset, endLine, endLineOffset);
}
private static boolean isSuppressed(JsonObject resultObj) {
JsonArray suppressionStates = resultObj.getAsJsonArray("suppressionStates");
if (suppressionStates != null) {
for (JsonElement entry : suppressionStates) {
if ("suppressedInSource".equals(entry.getAsString())) {
return true;
}
}
}
return false;
}
private static String uriToPath(String uri) {
String uriEscaped = uri.replace("[", "%5B").replace("]", "%5D");
String uriPath = URI.create(uriEscaped).getPath();
File file = new File(uriPath);
return file.isAbsolute()
? file.getAbsolutePath()
: file.getPath();
}
}
