Merge pull request #12 from kingthorin/prevent-dupes

improve: Prevent programmattic duplicates

Author: kingthorin

CHANGELOG.md

@@ -8,6 +8,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 ### Changed
 - Add red/green icon to Enable/Disable toggle button.
 - Maintenance changes.
+- Now targeting ZAP 2.10.
+- Ensure added color mappings are unique (Issue 11). Only applies when mappings are added programmatically, a user can still define the same mapping multiple times via the GUI (hopefully they'll recognize the inefficiency of doing so).
 
 ## [1.3.0] - 2020-09-29
 

build.gradle.kts

@@ -57,7 +57,7 @@ description = "Colors history table items based on tags"
 zapAddOn {
     addOnName.set("Neonmarker")
     addOnStatus.set(AddOnStatus.ALPHA)
-    zapVersion.set("2.8.0")
+    zapVersion.set("2.10.0")
 
     releaseLink.set("https://github.com/kingthorin/neonmarker/compare/v@PREVIOUS_VERSION@...v@CURRENT_VERSION@")
     unreleasedLink.set("https://github.com/kingthorin/neonmarker/compare/v@CURRENT_VERSION@...HEAD")

src/main/java/org/zaproxy/zap/extension/neonmarker/ExtensionNeonmarker.java

@@ -26,8 +26,10 @@
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.List;
+import java.util.Objects;
 import org.apache.commons.lang3.Range;
-import org.apache.log4j.Logger;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 import org.jdesktop.swingx.decorator.AbstractHighlighter;
 import org.jdesktop.swingx.decorator.ComponentAdapter;
 import org.jdesktop.swingx.decorator.HighlightPredicate;
@@ -45,7 +47,7 @@
 import org.zaproxy.zap.view.table.HistoryReferencesTableModel;
 
 public class ExtensionNeonmarker extends ExtensionAdaptor {
-    private static final Logger LOGGER = Logger.getLogger(ExtensionNeonmarker.class);
+    private static final Logger LOGGER = LogManager.getLogger(ExtensionNeonmarker.class);
     private static final Range<Integer> INT_RANGE =
             Range.between(Integer.MIN_VALUE, Integer.MAX_VALUE);
     public static final String RESOURCE = "/org/zaproxy/zap/extension/neonmarker/resources";
@@ -179,17 +181,17 @@ protected void toggleHighlighter(boolean on) {
     public boolean addColorMapping(String tag, int color) {
         if (isValidTag(tag) && isValidColor(color)) {
             Color newColor = new Color(color);
-            getColorMap().add(new ColorMapping(tag, newColor));
+            ColorMapping newMapping = new ColorMapping(tag, newColor);
+            if (!getColorMap().contains(newMapping)) {
+                getColorMap().add(newMapping);
+            }
             if (!palette.contains(newColor)) {
                 addToPalette(newColor);
             }
             getNeonmarkerPanel().refreshDisplay();
             return true;
         }
-        if (LOGGER.isDebugEnabled()) {
-            LOGGER.debug(
-                    "Either the tag: \"" + tag + "\" or the color: \"" + color + " was invalid.");
-        }
+        LOGGER.debug("Either the tag: \"{}\" or the color: \"{}\" was invalid.", tag, color);
         return false;
     }
 
@@ -297,6 +299,26 @@ public Color getColor() {
         public void setColor(Color color) {
             this.color = color;
         }
+
+        @Override
+        public int hashCode() {
+            return Objects.hash(color, tag);
+        }
+
+        @Override
+        public boolean equals(Object obj) {
+            if (this == obj) {
+                return true;
+            }
+            if (obj == null) {
+                return false;
+            }
+            if (getClass() != obj.getClass()) {
+                return false;
+            }
+            ColorMapping other = (ColorMapping) obj;
+            return Objects.equals(color, other.color) && Objects.equals(tag, other.tag);
+        }
     }
 
     @Override