[FIX INFRA-1028] Add support for warnings to plugin info

jenkins-infra · Mar 17, 2017 · 7d20054 · 7d20054
1 parent 6beb785
commit 7d20054
Showing 1 changed file with 86 additions and 1 deletion.
diff --git a/src/main/java/org/jenkinsci/confluence/plugins/JenkinsPluginInfoMacro.java b/src/main/java/org/jenkinsci/confluence/plugins/JenkinsPluginInfoMacro.java
@@ -3,9 +3,12 @@
 import java.io.IOException;
 import java.text.SimpleDateFormat;
 import java.util.Date;
+import java.util.HashSet;
 import java.util.Map;
+import java.util.Set;
 import java.util.SortedMap;
 import java.util.Map.Entry;
+import java.util.regex.Pattern;
 
 import com.atlassian.renderer.RenderContext;
 import com.atlassian.confluence.renderer.PageContext;
@@ -100,6 +103,42 @@ public String execute(Map parameters, String body, RenderContext renderContext)
 
             WikiWriter toBeRendered = null;
 
+            // warnings applicable to this plugin no matter what the release is
+            Set<JSONObject> pluginWarnings = new HashSet<JSONObject>();
+
+            // warnings applicable to the current version, which include warnings for all versions even if unpublished
+            Set<JSONObject> currentWarnings = new HashSet<JSONObject>();
+
+            JSONArray warnings = (JSONArray) updateCenter.get("warnings");
+            if (warnings != null) {
+                for (Object w : warnings) {
+                    JSONObject warning = (JSONObject) w;
+                    try {
+                        if (!"plugin".equals(warning.get("type"))) {
+                            // not a plugin warning
+                            continue;
+                        }
+                        if (!pluginId.equals(warning.get("name"))) {
+                            // not about this plugin
+                            continue;
+                        }
+
+                        pluginWarnings.add(warning);
+
+                        JSONArray warningVersions = (JSONArray) warning.get("versions");
+                        if (warningVersions == null) {
+                            warningVersions = new JSONArray();
+                        }
+                        if (isWarningRelevantForAnyVersion(warningVersions)) {
+                            currentWarnings.add(warning);
+                        }
+                    } catch (RuntimeException ex) {
+                        // ignore -- something wrong on the update site, better to not break the wiki page
+                    }
+                }
+            }
+
+
             if (plugins.containsKey(pluginId)) {
                 JSONObject pluginJSON = (JSONObject) plugins.get(pluginId);
                 final StatsInfoParser statsParser = getStatsParser(renderContext, pluginId);
@@ -127,6 +166,18 @@ public String execute(Map parameters, String body, RenderContext renderContext)
                 String githubBaseUrl = "https://github.com/jenkinsci/" + sourceDir + "/compare/" + name + "-";
                 String version = getString(pluginJSON, "version");
 
+                // filter warnings by whether they apply to the distributed version
+
+                for (JSONObject warning : pluginWarnings) {
+                    JSONArray warningVersions = (JSONArray) warning.get("versions");
+                    if (warningVersions == null) {
+                        warningVersions = new JSONArray();
+                    }
+                    if (isWarningRelevantForSpecificVersion(version, warningVersions)) {
+                        pluginWarnings.add(warning);
+                    }
+                }
+
                 toBeRendered = new WikiWriter().h4("Plugin Information");
 
                 {// first row
@@ -224,7 +275,16 @@ public String execute(Map parameters, String body, RenderContext renderContext)
             if (toBeRendered==null) {
                 toBeRendered = new WikiWriter().h4("Plugin Information");
                 toBeRendered.append("|| No Information For This Plugin ||\n");
-            } 
+            }
+
+            if (!currentWarnings.isEmpty()) {
+                // there are warnings
+                toBeRendered.append("{warning}This plugin may not be safe to use. Please review the following warnings before use:");
+                for (JSONObject warning : currentWarnings) {
+                    toBeRendered.append(String.format("* [%s|%s]", warning.get("message"), warning.get("url")));
+                }
+                toBeRendered.append("{warning}");
+            }
 
             if (renderContext instanceof PageContext) {
                 PageContext pc = (PageContext) renderContext;
@@ -265,6 +325,31 @@ public String execute(Map parameters, String body, RenderContext renderContext)
         }
     }
 
+    private boolean isWarningRelevantForAnyVersion(JSONArray versions) {
+        return versions == null || versions.size() == 0;
+    }
+
+    private boolean isWarningRelevantForSpecificVersion(String pluginVersion, JSONArray versions) {
+
+        if (isWarningRelevantForAnyVersion(versions)) {
+            return false;
+        }
+
+        for (Object v : versions) {
+            try {
+                JSONObject versionEntry = (JSONObject) v;
+                String patt = versionEntry.get("pattern").toString();
+                Pattern pattern = Pattern.compile(patt);
+                if (pattern.matcher(pluginVersion).matches()) {
+                    return true;
+                }
+            } catch (Exception e) {
+                // ignore
+            }
+        }
+        return false;
+    }
+
     private String getDependencies(JSONObject updateCenter, JSONObject pluginJSON) {
         WikiWriter depString = new WikiWriter();
         final JSONArray depArray = (JSONArray) pluginJSON.get("dependencies");