Merge pull request #6508 from kingthorin/spider-fix

spider: Minor Naming and Title Caps corrections in options panel

Author: psiinon

addOns/spider/CHANGELOG.md

@@ -9,10 +9,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Include anti-csrf tokens as part of irrelevant parameters.
 - Ignore irrelevant parameters in request bodies (`x-www-form-urlencoded`) (Related to Issue 7771).
 - Skip all URIs with `javascript` schemes.
+- Changed to title caps on the Irrelevant Parameters table "title" in the Options dialog (Issue 2000).
 
 ### Added
 - Add an option to allow users to indicate the Spider should attempt to avoid logout related paths/functionality.
 
+### Fixed
+- An incorrect column name in the Irrelevant Parameters table used by the Options dialog (Domain should have been Name).
+
 ## [0.14.0] - 2025-03-25
 ### Changed
 - Maintenance changes.

addOns/spider/spider.gradle.kts

@@ -74,6 +74,7 @@ val japicmp by tasks.existing(JapicmpTask::class) {
             "org.zaproxy.addon.spider.SpiderParam#setRequestWaitTime(int)",
             "org.zaproxy.addon.spider.parser.ParseContext#ParseContext(org.zaproxy.addon.spider.SpiderParam," +
                 "org.zaproxy.zap.model.ValueGenerator,org.parosproxy.paros.network.HttpMessage,java.lang.String,int)",
+            "org.zaproxy.addon.spider.internal.IrrelevantParameter#getValue()",
         )
 }
 

addOns/spider/src/main/java/org/zaproxy/addon/spider/SpiderParam.java

@@ -117,7 +117,7 @@ public class SpiderParam extends VersionedAbstractParam {
     private static final String IRRELEVANT_PARAMETERS_KEY = "spider.irrelevantParameters";
     private static final String ALL_IRRELEVANT_PARAMETERS_KEY =
             IRRELEVANT_PARAMETERS_KEY + ".irrelevantParameter";
-    private static final String IRRELEVANT_PARAMETER_VALUE_KEY = "name";
+    private static final String IRRELEVANT_PARAMETER_NAME_KEY = "name";
     private static final String IRRELEVANT_PARAMETER_REGEX_KEY = "regex";
     private static final String IRRELEVANT_PARAMETER_ENABLED_KEY = "enabled";
     private static final String CONFIRM_REMOVE_IRRELEVANT_PARAMETER =
@@ -1102,7 +1102,7 @@ public void setIrrelevantParameters(List<IrrelevantParameter> irrelevantParamete
 
             getConfig()
                     .setProperty(
-                            elementBaseKey + IRRELEVANT_PARAMETER_VALUE_KEY, parameter.getValue());
+                            elementBaseKey + IRRELEVANT_PARAMETER_NAME_KEY, parameter.getName());
             getConfig()
                     .setProperty(
                             elementBaseKey + IRRELEVANT_PARAMETER_REGEX_KEY, parameter.isRegex());
@@ -1127,7 +1127,7 @@ private void loadIrrelevantParameters() {
         this.irrelevantParameters = new ArrayList<>(fields.size());
         ArrayList<IrrelevantParameter> parametersEnabled = new ArrayList<>(fields.size());
         for (HierarchicalConfiguration sub : fields) {
-            String value = sub.getString(IRRELEVANT_PARAMETER_VALUE_KEY, "");
+            String value = sub.getString(IRRELEVANT_PARAMETER_NAME_KEY, "");
             if ("".equals(value)) {
                 LOGGER.warn(
                         "Failed to read an irrelevant parameter entry, required value is empty.");

addOns/spider/src/main/java/org/zaproxy/addon/spider/internal/IrrelevantParameter.java

@@ -60,7 +60,7 @@ public IrrelevantParameter(IrrelevantParameter other) {
         this.pattern = other.pattern;
     }
 
-    public String getValue() {
+    public String getName() {
         if (isRegex()) {
             return pattern.pattern();
         }

addOns/spider/src/main/java/org/zaproxy/addon/spider/internal/ui/DialogAddIrrelevantParameter.java

@@ -152,12 +152,12 @@ protected boolean validateFields() {
 
     @Override
     protected void performAction() {
-        String value = getNameTextField().getText();
+        String name = getNameTextField().getText();
         if (getRegexCheckBox().isSelected()) {
-            Pattern pattern = IrrelevantParameter.createPattern(value);
+            Pattern pattern = IrrelevantParameter.createPattern(name);
             irrelevantParameter = new IrrelevantParameter(pattern);
         } else {
-            irrelevantParameter = new IrrelevantParameter(value);
+            irrelevantParameter = new IrrelevantParameter(name);
         }
 
         irrelevantParameter.setEnabled(getEnabledCheckBox().isSelected());

addOns/spider/src/main/java/org/zaproxy/addon/spider/internal/ui/DialogModifyIrrelevantParameter.java

@@ -48,7 +48,7 @@ public void setIrrelevantParameter(IrrelevantParameter irrelevantParameter) {
 
     @Override
     protected void init() {
-        getNameTextField().setText(irrelevantParameter.getValue());
+        getNameTextField().setText(irrelevantParameter.getName());
         getNameTextField().discardAllEdits();
 
         getRegexCheckBox().setSelected(irrelevantParameter.isRegex());

addOns/spider/src/main/java/org/zaproxy/addon/spider/internal/ui/IrrelevantParametersTableModel.java

@@ -35,7 +35,7 @@ class IrrelevantParametersTableModel
     private static final String[] COLUMN_NAMES = {
         Constant.messages.getString("spider.options.irrelevantparameter.table.header.enabled"),
         Constant.messages.getString("spider.options.irrelevantparameter.table.header.regex"),
-        Constant.messages.getString("spider.options.irrelevantparameter.table.header.value")
+        Constant.messages.getString("spider.options.irrelevantparameter.table.header.name")
     };
 
     private static final int COLUMN_COUNT = COLUMN_NAMES.length;
@@ -74,7 +74,7 @@ public Object getValueAt(int rowIndex, int columnIndex) {
             case 1:
                 return getElement(rowIndex).isRegex();
             case 2:
-                return getElement(rowIndex).getValue();
+                return getElement(rowIndex).getName();
             default:
                 return null;
         }

addOns/spider/src/main/resources/org/zaproxy/addon/spider/resources/Messages.properties

@@ -235,8 +235,8 @@ spider.options.irrelevantparameter.field.label.regex = Regex:
 spider.options.irrelevantparameter.modify.button.confirm = Modify
 spider.options.irrelevantparameter.modify.title = Modify Irrelevant Parameter
 spider.options.irrelevantparameter.table.header.enabled = Enabled
+spider.options.irrelevantparameter.table.header.name = Name
 spider.options.irrelevantparameter.table.header.regex = Regex
-spider.options.irrelevantparameter.table.header.value = Domain
 spider.options.irrelevantparameter.warning.invalid.regex.text = The regular expression is invalid.
 spider.options.irrelevantparameter.warning.invalid.regex.title = Irrelevant Parameter Regex Invalid
 spider.options.label.acceptcookies = Accept Cookies
@@ -248,7 +248,7 @@ spider.options.label.duration = Maximum Duration (minutes; 0 is unlimited):
 spider.options.label.git = Parse Git metadata files for new URIs
 spider.options.label.handlehodataparameters = Handle OData-specific parameters
 spider.options.label.handleparameters = Query parameters handling for checking visited URIs:
-spider.options.label.irrelevantparameters = Irrelevant parameters:
+spider.options.label.irrelevantparameters = Irrelevant Parameters:
 spider.options.label.logoutavoidance = Logout Avoidance
 spider.options.label.maxChildren = Maximum Children to Crawl (0 is unlimited):
 spider.options.label.maxParseSizeBytes = Maximum Parse Size (bytes; 0 is unlimited):