Merge pull request #5853 from kingthorin/custom-payloads-promo

custompayloads: SAST Fixes (SonarLint), Options panel help, & drop ID

addOns/custompayloads/CHANGELOG.md

@@ -7,6 +7,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 ### Changed
 - Update minimum ZAP version to 2.16.0.
 - Maintenance changes.
+- The superfluous/unused ID element of the custom payloads has been removed from the GUI and config.
+
+### Added
+- Add help button to Options panel and add further detailed Help content.
 
 ## [0.13.0] - 2023-11-10
 ### Changed

addOns/custompayloads/src/main/java/org/zaproxy/zap/extension/custompayloads/AbstractColumnDialog.java

@@ -21,7 +21,6 @@
 
 import java.awt.Dimension;
 import java.awt.Window;
-import java.util.ArrayList;
 import java.util.List;
 import org.zaproxy.zap.utils.DisplayUtils;
 import org.zaproxy.zap.view.StandardFieldsDialog;
@@ -95,7 +94,7 @@ private void createStringTextFieldForColumn(Column<T> column) {
     private void createStringComboFieldForColumn(Column<T> column) {
         EditableSelectColumn<T> selectColumn = (EditableSelectColumn<T>) column;
         String value = column.getTypedValue(model);
-        ArrayList<String> selectableValues = selectColumn.getTypedSelectableValues(model);
+        List<String> selectableValues = selectColumn.getTypedSelectableValues(model);
         this.addComboField(column.getNameKey(), selectableValues, value);
     }
 

addOns/custompayloads/src/main/java/org/zaproxy/zap/extension/custompayloads/Column.java

@@ -19,11 +19,11 @@
  */
 package org.zaproxy.zap.extension.custompayloads;
 
-public abstract class Column<T> {
+abstract class Column<T> {
     Class<?> columnClass;
     String nameKey;
 
-    public Column(Class<?> columnClass, String nameKey) {
+    Column(Class<?> columnClass, String nameKey) {
         this.columnClass = columnClass;
         this.nameKey = nameKey;
     }

addOns/custompayloads/src/main/java/org/zaproxy/zap/extension/custompayloads/CustomPayload.java

@@ -23,7 +23,6 @@
 
 public class CustomPayload implements EnableableInterface {
 
-    private int id;
     private boolean enabled;
     private String category;
     private String payload;
@@ -33,20 +32,11 @@ public CustomPayload(String category, String payload) {
     }
 
     public CustomPayload(boolean enabled, String category, String payload) {
-        this(-1, enabled, category, payload);
-    }
-
-    public CustomPayload(int id, boolean enabled, String category, String payload) {
-        this.id = id;
         this.enabled = enabled;
         this.category = category;
         this.payload = payload;
     }
 
-    public void setId(int id) {
-        this.id = id;
-    }
-
     public void setCategory(String category) {
         this.category = category;
     }
@@ -73,11 +63,7 @@ public String getPayload() {
         return payload;
     }
 
-    public int getId() {
-        return id;
-    }
-
     public CustomPayload copy() {
-        return new CustomPayload(id, enabled, category, payload);
+        return new CustomPayload(enabled, category, payload);
     }
 }

addOns/custompayloads/src/main/java/org/zaproxy/zap/extension/custompayloads/CustomPayloadCategoryColumn.java

@@ -61,7 +61,7 @@ public ArrayList<Object> getSelectableValues(CustomPayload payload) {
         return categoryObjects;
     }
 
-    private ExtensionCustomPayloads getExtension() {
+    private static ExtensionCustomPayloads getExtension() {
         return Control.getSingleton()
                 .getExtensionLoader()
                 .getExtension(ExtensionCustomPayloads.class);

addOns/custompayloads/src/main/java/org/zaproxy/zap/extension/custompayloads/CustomPayloadColumns.java

@@ -25,10 +25,13 @@
 
 public final class CustomPayloadColumns {
 
+    private CustomPayloadColumns() {
+        // Nothing to do
+    }
+
     public static List<Column<CustomPayload>> createColumns() {
         ArrayList<Column<CustomPayload>> columns = new ArrayList<>();
         columns.add(createEnabledColumn());
-        columns.add(createIdColumn());
         columns.add(createCategoryColumn());
         columns.add(createPayloadColumn());
         return columns;
@@ -37,9 +40,8 @@ public static List<Column<CustomPayload>> createColumns() {
     public static List<Column<CustomPayload>> createColumnsForOptionsTable() {
         ArrayList<Column<CustomPayload>> columns = new ArrayList<>();
         columns.add(createEnabledColumn());
-        columns.add(createIdColumn());
-        columns.add(createCategoryColumn().AsReadonly());
-        columns.add(createPayloadColumn().AsReadonly());
+        columns.add(createCategoryColumn().asReadonly());
+        columns.add(createPayloadColumn().asReadonly());
         return columns;
     }
 
@@ -62,16 +64,6 @@ public Object getValue(CustomPayload payload) {
         };
     }
 
-    private static Column<CustomPayload> createIdColumn() {
-        return new Column<CustomPayload>(Integer.class, "custompayloads.options.dialog.id") {
-
-            @Override
-            public Object getValue(CustomPayload payload) {
-                return payload.getId();
-            }
-        };
-    }
-
     private static EditableColumn<CustomPayload> createPayloadColumn() {
         return new EditableColumn<CustomPayload>(
                 String.class, "custompayloads.options.dialog.payload") {

addOns/custompayloads/src/main/java/org/zaproxy/zap/extension/custompayloads/CustomPayloadMultipleOptionsTableModel.java

@@ -19,7 +19,6 @@
  */
 package org.zaproxy.zap.extension.custompayloads;
 
-import java.util.ArrayList;
 import java.util.List;
 import java.util.Set;
 
@@ -29,7 +28,6 @@ public class CustomPayloadMultipleOptionsTableModel
 
     private static final long serialVersionUID = 1L;
     private List<CustomPayload> defaultPayloads;
-    private int nextPayloadId;
 
     public CustomPayloadMultipleOptionsTableModel() {
         super(CustomPayloadColumns.createColumnsForOptionsTable());
@@ -39,36 +37,16 @@ public void setDefaultPayloads(List<CustomPayload> defaultPayloads) {
         this.defaultPayloads = defaultPayloads;
     }
 
-    public void setNextPayloadId(int nextPayloadId) {
-        this.nextPayloadId = nextPayloadId;
-    }
-
-    public int getNextPayloadId() {
-        return nextPayloadId;
-    }
-
-    public void resetPayloadIds() {
-        nextPayloadId = 1;
-        for (CustomPayload payload : getElements()) {
-            setNextIdToPayload(payload);
-        }
-        if (this.getRowCount() > 0) {
-            fireTableRowsUpdated(0, getElements().size() - 1);
-        }
-    }
-
     public void resetToDefaults() {
         clear();
         for (CustomPayload defaultPayload : defaultPayloads) {
             CustomPayload newPayload = defaultPayload.copy();
-            setNextIdToPayload(newPayload);
             addModel(newPayload);
         }
     }
 
-    public void addToTable(ArrayList<CustomPayload> payloads) {
+    public void addToTable(List<CustomPayload> payloads) {
         for (CustomPayload payload : payloads) {
-            payload.setId(nextPayloadId++);
             addModel(payload);
         }
     }
@@ -81,10 +59,6 @@ public void getPayloadsOfACategory(Set<String> payloads, String category) {
         }
     }
 
-    public void setNextIdToPayload(CustomPayload payload) {
-        payload.setId(nextPayloadId++);
-    }
-
     public void addMissingDefaultPayloads() {
         for (CustomPayload defaultPayload : defaultPayloads) {
             boolean alreadyExisting = false;
@@ -98,7 +72,6 @@ public void addMissingDefaultPayloads() {
 
             if (!alreadyExisting) {
                 CustomPayload newPayload = defaultPayload.copy();
-                setNextIdToPayload(newPayload);
                 addModel(newPayload);
             }
         }

addOns/custompayloads/src/main/java/org/zaproxy/zap/extension/custompayloads/CustomPayloadsMultipleOptionsTablePanel.java

@@ -46,8 +46,6 @@ public class CustomPayloadsMultipleOptionsTablePanel
 
     private static final String RESET_BUTTON =
             Constant.messages.getString("custompayloads.options.button.reset");
-    private static final String RESET_ID_BUTTON =
-            Constant.messages.getString("custompayloads.options.button.resetIds");
     private static final String ADD_MISSING_DEFAULTS_BUTTON =
             Constant.messages.getString("custompayloads.options.button.addMissingDefaults");
 
@@ -67,7 +65,6 @@ public class CustomPayloadsMultipleOptionsTablePanel
             LogManager.getLogger(CustomPayloadsMultipleOptionsTablePanel.class);
 
     private JButton resetButton;
-    private JButton resetButtonId;
     private JButton addMissingDefaultsButton;
     private JButton fileButton;
     private CustomPayloadMultipleOptionsTableModel tableModel;
@@ -79,7 +76,6 @@ public CustomPayloadsMultipleOptionsTablePanel(
         addButtonSpacer();
         addMissingDefaultsButton();
         addResetButton();
-        addResetIdButton();
         addButtonSpacer();
         addPayloadFileButton();
         getTable().setHorizontalScrollEnabled(true);
@@ -91,12 +87,6 @@ private void addMissingDefaultsButton() {
         addButton(addMissingDefaultsButton);
     }
 
-    private void addResetIdButton() {
-        resetButtonId = new JButton(RESET_ID_BUTTON);
-        resetButtonId.addActionListener(e -> tableModel.resetPayloadIds());
-        addButton(resetButtonId);
-    }
-
     private void addResetButton() {
         resetButton = new JButton(RESET_BUTTON);
         resetButton.addActionListener(e -> tableModel.resetToDefaults());
@@ -107,7 +97,7 @@ private void addPayloadFileButton() {
         fileButton = new JButton(ADD_MULTIPLE_PAYLOADS_BUTTON);
         fileButton.addActionListener(
                 e -> {
-                    CustomPayload multiplePayloads = new CustomPayload(-1, true, "", "");
+                    CustomPayload multiplePayloads = new CustomPayload(true, "", "");
                     CustomMultiplePayloadDialog dialog =
                             new CustomMultiplePayloadDialog(
                                     View.getSingleton().getOptionsDialog(null), multiplePayloads);
@@ -161,15 +151,14 @@ private void addPayloadFileButton() {
 
     @Override
     public CustomPayload showAddDialogue() {
-        CustomPayload payload = new CustomPayload(-1, true, "", "");
+        CustomPayload payload = new CustomPayload(true, "", "");
         if (showDialog(payload)) {
-            tableModel.setNextIdToPayload(payload);
             return payload;
         }
         return null;
     }
 
-    private boolean showDialog(CustomPayload payload) {
+    private static boolean showDialog(CustomPayload payload) {
         CustomPayloadDialog dialog =
                 new CustomPayloadDialog(
                         View.getSingleton().getOptionsDialog(null),

addOns/custompayloads/src/main/java/org/zaproxy/zap/extension/custompayloads/CustomPayloadsOptionsPanel.java

@@ -58,7 +58,6 @@ public void initParam(Object obj) {
         tableModel.clear();
         tableModel.addModels(param.getPayloads());
         tableModel.setDefaultPayloads(param.getDefaultPayloads());
-        tableModel.setNextPayloadId(param.getNextPayloadId());
         tablePanel.setRemoveWithoutConfirmation(param.isConfirmRemoveToken());
     }
 
@@ -67,7 +66,11 @@ public void saveParam(Object obj) throws Exception {
         OptionsParam optionsParam = (OptionsParam) obj;
         CustomPayloadsParam param = optionsParam.getParamSet(CustomPayloadsParam.class);
         param.setPayloads(tableModel.getElements());
-        param.setNextPayloadId(tableModel.getNextPayloadId());
         param.setConfirmRemoveToken(tablePanel.isRemoveWithoutConfirmation());
     }
+
+    @Override
+    public String getHelpIndex() {
+        return "custompayloads.options";
+    }
 }