Merge pull request #6004 from psiinon/client/refactor

Client: code refactor

addOns/client/src/main/java/org/zaproxy/addon/client/ClientHistoryTableModel.java

@@ -24,6 +24,9 @@
 import java.util.List;
 import javax.swing.table.AbstractTableModel;
 import org.parosproxy.paros.Constant;
+import org.zaproxy.addon.client.internal.ReportedElement;
+import org.zaproxy.addon.client.internal.ReportedEvent;
+import org.zaproxy.addon.client.internal.ReportedObject;
 
 public class ClientHistoryTableModel extends AbstractTableModel {
 

addOns/client/src/main/java/org/zaproxy/addon/client/ClientIntegrationAPI.java

@@ -28,6 +28,10 @@
 import org.parosproxy.paros.network.HttpHeader;
 import org.parosproxy.paros.network.HttpMessage;
 import org.parosproxy.paros.network.HttpRequestHeader;
+import org.zaproxy.addon.client.internal.ClientNode;
+import org.zaproxy.addon.client.internal.ClientSideComponent;
+import org.zaproxy.addon.client.internal.ReportedElement;
+import org.zaproxy.addon.client.internal.ReportedEvent;
 import org.zaproxy.zap.extension.api.API;
 import org.zaproxy.zap.extension.api.ApiAction;
 import org.zaproxy.zap.extension.api.ApiException;
@@ -92,22 +96,13 @@ private void handleReportObject(JSONObject json) {
                         () -> {
                             ClientNode node =
                                     this.extension.getOrAddClientNode(urlStr, false, false);
-                            ClientSideDetails details = node.getUserObject();
-                            boolean wasVisited = details.isVisited();
                             ClientSideComponent component = new ClientSideComponent(json);
-                            boolean componentAdded = details.addComponent(component);
-                            if (!wasVisited || componentAdded) {
-                                details.setVisited(true);
-                                this.extension.clientNodeChanged(node);
-                            }
+                            extension.addComponentToNode(node, component);
                             if (component.isStorageEvent()) {
                                 String storageUrl = node.getSite() + component.getTypeForDisplay();
-                                ClientNode storageNode =
-                                        this.extension.getOrAddClientNode(storageUrl, false, true);
-                                ClientSideDetails storageDetails = storageNode.getUserObject();
-                                storageDetails.setStorage(true);
-                                storageDetails.addComponent(component);
-                                this.extension.clientNodeChanged(storageNode);
+                                extension.addComponentToNode(
+                                        this.extension.getOrAddClientNode(storageUrl, false, true),
+                                        component);
                             }
                         });
             }

addOns/client/src/main/java/org/zaproxy/addon/client/ComponentTableModel.java

@@ -23,6 +23,7 @@
 import java.util.List;
 import javax.swing.table.AbstractTableModel;
 import org.parosproxy.paros.Constant;
+import org.zaproxy.addon.client.internal.ClientSideComponent;
 
 public class ComponentTableModel extends AbstractTableModel {
 

addOns/client/src/main/java/org/zaproxy/addon/client/ExtensionClientIntegration.java

@@ -23,6 +23,7 @@
 import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
+import java.net.URL;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
 import java.nio.file.Path;
@@ -44,16 +45,34 @@
 import org.parosproxy.paros.extension.ExtensionHook;
 import org.parosproxy.paros.extension.SessionChangedListener;
 import org.parosproxy.paros.extension.history.ExtensionHistory;
+import org.parosproxy.paros.model.Model;
 import org.parosproxy.paros.model.Session;
 import org.parosproxy.paros.model.SiteNode;
 import org.parosproxy.paros.view.View;
 import org.zaproxy.addon.client.impl.ClientZestRecorder;
+import org.zaproxy.addon.client.internal.ClientMap;
+import org.zaproxy.addon.client.internal.ClientNode;
+import org.zaproxy.addon.client.internal.ClientSideComponent;
+import org.zaproxy.addon.client.internal.ClientSideDetails;
+import org.zaproxy.addon.client.internal.ReportedElement;
+import org.zaproxy.addon.client.internal.ReportedEvent;
+import org.zaproxy.addon.client.internal.ReportedObject;
 import org.zaproxy.addon.client.pscan.ClientPassiveScanController;
 import org.zaproxy.addon.client.pscan.ClientPassiveScanHelper;
 import org.zaproxy.addon.client.pscan.OptionsPassiveScan;
 import org.zaproxy.addon.client.spider.ClientSpider;
 import org.zaproxy.addon.client.spider.ClientSpiderDialog;
 import org.zaproxy.addon.client.spider.PopupMenuSpider;
+import org.zaproxy.addon.client.ui.ClientDetailsPanel;
+import org.zaproxy.addon.client.ui.ClientHistoryPanel;
+import org.zaproxy.addon.client.ui.ClientMapPanel;
+import org.zaproxy.addon.client.ui.PopupMenuClientAttack;
+import org.zaproxy.addon.client.ui.PopupMenuClientCopyUrls;
+import org.zaproxy.addon.client.ui.PopupMenuClientDelete;
+import org.zaproxy.addon.client.ui.PopupMenuClientDetailsCopy;
+import org.zaproxy.addon.client.ui.PopupMenuClientHistoryCopy;
+import org.zaproxy.addon.client.ui.PopupMenuClientOpenInBrowser;
+import org.zaproxy.addon.client.ui.PopupMenuClientShowInSites;
 import org.zaproxy.addon.network.ExtensionNetwork;
 import org.zaproxy.zap.ZAP;
 import org.zaproxy.zap.eventBus.Event;
@@ -75,7 +94,7 @@ public class ExtensionClientIntegration extends ExtensionAdaptor {
 
     private static final String FIREFOX_PROFILES_INI = "profiles.ini";
 
-    protected static final String PREFIX = "client";
+    public static final String PREFIX = "client";
 
     protected static final String RESOURCES = "resources";
 
@@ -112,7 +131,8 @@ public ExtensionClientIntegration() {
     }
 
     @Override
-    public void init() {
+    public void initModel(Model model) {
+        super.initModel(model);
         clientHistoryTableModel = new ClientHistoryTableModel();
         clientTree =
                 new ClientMap(
@@ -417,6 +437,14 @@ public void clientNodeChanged(ClientNode node) {
         this.clientTree.nodeChanged(node);
     }
 
+    public boolean addComponentToNode(ClientNode node, ClientSideComponent component) {
+        if (this.clientTree.addComponentToNode(node, component)) {
+            this.clientNodeChanged(node);
+            return true;
+        }
+        return false;
+    }
+
     public void deleteNodes(List<ClientNode> nodes) {
         this.clientTree.deleteNodes(nodes);
         if (View.isInitialised()) {
@@ -623,11 +651,18 @@ private ZapMenuItem getMenuItemCustomScan() {
 
     public ImageIcon getIcon() {
         if (icon == null) {
-            icon =
-                    DisplayUtils.getScaledIcon(
-                            ExtensionClientIntegration.class.getResource(
-                                    ExtensionClientIntegration.RESOURCES + "/spiderClient.png"));
+            icon = getIcon("spiderClient.png");
         }
         return icon;
     }
+
+    public static ImageIcon getIcon(String name) {
+        String resourceName = RESOURCES + "/" + name;
+        URL url = ExtensionClientIntegration.class.getResource(resourceName);
+        if (url == null) {
+            LOGGER.error("No icon with name {}", resourceName);
+            return null;
+        }
+        return DisplayUtils.getScaledIcon(url);
+    }
 }

addOns/client/src/main/java/org/zaproxy/addon/client/MissingUrlsThread.java

@@ -31,6 +31,8 @@
 import org.parosproxy.paros.network.HttpRequestHeader;
 import org.parosproxy.paros.network.HttpSender;
 import org.parosproxy.paros.view.View;
+import org.zaproxy.addon.client.internal.ClientNode;
+import org.zaproxy.addon.client.internal.ClientSideDetails;
 import org.zaproxy.zap.eventBus.Event;
 import org.zaproxy.zap.model.SessionStructure;
 import org.zaproxy.zap.model.StructuralNode;

addOns/client/src/main/java/org/zaproxy/addon/client/ClientMap.java → addOns/client/src/main/java/org/zaproxy/addon/client/internal/ClientMap.java

@@ -17,7 +17,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.zaproxy.addon.client;
+package org.zaproxy.addon.client.internal;
 
 import java.util.Comparator;
 import java.util.HashMap;
@@ -27,6 +27,7 @@
 import javax.swing.tree.TreeNode;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
+import org.zaproxy.addon.client.ClientUtils;
 import org.zaproxy.zap.ZAP;
 import org.zaproxy.zap.eventBus.Event;
 import org.zaproxy.zap.eventBus.EventPublisher;
@@ -156,6 +157,16 @@ public void clear() {
     public String getPublisherName() {
         return this.getClass().getCanonicalName();
     }
+
+    public boolean addComponentToNode(ClientNode node, ClientSideComponent component) {
+        ClientSideDetails details = node.getUserObject();
+        boolean wasVisited = details.isVisited();
+        boolean componentAdded = details.addComponent(component);
+        if (!wasVisited || componentAdded) {
+            details.setVisited(true);
+        }
+        return componentAdded;
+    }
 }
 
 /**

addOns/client/src/main/java/org/zaproxy/addon/client/ClientNode.java → addOns/client/src/main/java/org/zaproxy/addon/client/internal/ClientNode.java

@@ -17,7 +17,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.zaproxy.addon.client;
+package org.zaproxy.addon.client.internal;
 
 import java.util.ArrayList;
 import java.util.List;

addOns/client/src/main/java/org/zaproxy/addon/client/ClientSideComponent.java → addOns/client/src/main/java/org/zaproxy/addon/client/internal/ClientSideComponent.java

@@ -17,11 +17,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.zaproxy.addon.client;
+package org.zaproxy.addon.client.internal;
 
 import java.util.Objects;
 import net.sf.json.JSONObject;
 import org.parosproxy.paros.Constant;
+import org.zaproxy.addon.client.ExtensionClientIntegration;
 
 public class ClientSideComponent {
 

addOns/client/src/main/java/org/zaproxy/addon/client/ClientSideDetails.java → addOns/client/src/main/java/org/zaproxy/addon/client/internal/ClientSideDetails.java

@@ -17,7 +17,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.zaproxy.addon.client;
+package org.zaproxy.addon.client.internal;
 
 import java.util.HashSet;
 import java.util.Set;
@@ -57,19 +57,19 @@ public Set<ClientSideComponent> getComponents() {
         return components;
     }
 
-    public void setVisited(boolean visited) {
+    protected void setVisited(boolean visited) {
         this.visited = visited;
     }
 
-    public boolean addComponent(ClientSideComponent component) {
+    protected boolean addComponent(ClientSideComponent component) {
         return this.components.add(component);
     }
 
     public boolean isStorage() {
         return storage;
     }
 
-    public void setStorage(boolean storage) {
+    protected void setStorage(boolean storage) {
         this.storage = storage;
     }
 }

addOns/client/src/main/java/org/zaproxy/addon/client/ReportedElement.java → addOns/client/src/main/java/org/zaproxy/addon/client/internal/ReportedElement.java

@@ -17,7 +17,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.zaproxy.addon.client;
+package org.zaproxy.addon.client.internal;
 
 import net.sf.json.JSONObject;
 

addOns/client/src/main/java/org/zaproxy/addon/client/ReportedEvent.java → addOns/client/src/main/java/org/zaproxy/addon/client/internal/ReportedEvent.java

@@ -17,7 +17,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.zaproxy.addon.client;
+package org.zaproxy.addon.client.internal;
 
 import net.sf.json.JSONObject;
 

addOns/client/src/main/java/org/zaproxy/addon/client/ReportedObject.java → addOns/client/src/main/java/org/zaproxy/addon/client/internal/ReportedObject.java

@@ -17,7 +17,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.zaproxy.addon.client;
+package org.zaproxy.addon.client.internal;
 
 import java.util.Date;
 import net.sf.json.JSONObject;

addOns/client/src/main/java/org/zaproxy/addon/client/pscan/ClientPassiveAbstractScanRule.java

@@ -21,7 +21,7 @@
 
 import org.parosproxy.paros.core.scanner.Alert;
 import org.parosproxy.paros.core.scanner.Alert.Source;
-import org.zaproxy.addon.client.ReportedObject;
+import org.zaproxy.addon.client.internal.ReportedObject;
 
 public abstract class ClientPassiveAbstractScanRule implements ClientPassiveScanRule {
 

addOns/client/src/main/java/org/zaproxy/addon/client/pscan/ClientPassiveScanRule.java

@@ -19,7 +19,7 @@
  */
 package org.zaproxy.addon.client.pscan;
 
-import org.zaproxy.addon.client.ReportedObject;
+import org.zaproxy.addon.client.internal.ReportedObject;
 import org.zaproxy.zap.extension.alert.ExampleAlertProvider;
 
 public interface ClientPassiveScanRule extends ExampleAlertProvider {

addOns/client/src/main/java/org/zaproxy/addon/client/pscan/InformationInStorageScanRule.java

@@ -25,8 +25,8 @@
 import org.parosproxy.paros.Constant;
 import org.parosproxy.paros.core.scanner.Alert;
 import org.zaproxy.addon.client.ClientUtils;
-import org.zaproxy.addon.client.ReportedElement;
-import org.zaproxy.addon.client.ReportedObject;
+import org.zaproxy.addon.client.internal.ReportedElement;
+import org.zaproxy.addon.client.internal.ReportedObject;
 
 public class InformationInStorageScanRule extends ClientPassiveAbstractScanRule {
 

addOns/client/src/main/java/org/zaproxy/addon/client/pscan/JwtInStorageScanRule.java

@@ -28,8 +28,8 @@
 import org.parosproxy.paros.Constant;
 import org.parosproxy.paros.core.scanner.Alert;
 import org.zaproxy.addon.client.ClientUtils;
-import org.zaproxy.addon.client.ReportedElement;
-import org.zaproxy.addon.client.ReportedObject;
+import org.zaproxy.addon.client.internal.ReportedElement;
+import org.zaproxy.addon.client.internal.ReportedObject;
 
 public class JwtInStorageScanRule extends ClientPassiveAbstractScanRule {
 

addOns/client/src/main/java/org/zaproxy/addon/client/pscan/SensitiveInfoInStorageScanRule.java

@@ -28,8 +28,8 @@
 import org.parosproxy.paros.core.scanner.Alert;
 import org.parosproxy.paros.model.HistoryReference;
 import org.zaproxy.addon.client.ClientUtils;
-import org.zaproxy.addon.client.ReportedElement;
-import org.zaproxy.addon.client.ReportedObject;
+import org.zaproxy.addon.client.internal.ReportedElement;
+import org.zaproxy.addon.client.internal.ReportedObject;
 
 public class SensitiveInfoInStorageScanRule extends ClientPassiveAbstractScanRule {
 

addOns/client/src/main/java/org/zaproxy/addon/client/spider/ClientSpider.java

@@ -35,10 +35,10 @@
 import org.openqa.selenium.WebDriver;
 import org.parosproxy.paros.control.Control;
 import org.parosproxy.paros.view.View;
-import org.zaproxy.addon.client.ClientMap;
-import org.zaproxy.addon.client.ClientNode;
 import org.zaproxy.addon.client.ClientOptions;
 import org.zaproxy.addon.client.ExtensionClientIntegration;
+import org.zaproxy.addon.client.internal.ClientMap;
+import org.zaproxy.addon.client.internal.ClientNode;
 import org.zaproxy.zap.ZAP;
 import org.zaproxy.zap.eventBus.Event;
 import org.zaproxy.zap.eventBus.EventConsumer;

addOns/client/src/main/java/org/zaproxy/addon/client/ClientDetailsPanel.java → addOns/client/src/main/java/org/zaproxy/addon/client/ui/ClientDetailsPanel.java

@@ -17,18 +17,20 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.zaproxy.addon.client;
+package org.zaproxy.addon.client.ui;
 
 import java.awt.GridBagConstraints;
 import java.awt.GridBagLayout;
 import java.awt.Insets;
 import java.util.List;
-import javax.swing.ImageIcon;
 import javax.swing.JLabel;
 import javax.swing.JPanel;
 import javax.swing.JScrollPane;
 import org.parosproxy.paros.Constant;
 import org.parosproxy.paros.extension.AbstractPanel;
+import org.zaproxy.addon.client.ExtensionClientIntegration;
+import org.zaproxy.addon.client.internal.ClientNode;
+import org.zaproxy.addon.client.internal.ClientSideComponent;
 import org.zaproxy.zap.view.LayoutHelper;
 
 public class ClientDetailsPanel extends AbstractPanel {
@@ -44,11 +46,7 @@ public ClientDetailsPanel() {
 
         this.setLayout(new GridBagLayout());
         setName(Constant.messages.getString(ExtensionClientIntegration.PREFIX + ".details.title"));
-        setIcon(
-                new ImageIcon(
-                        ExtensionClientIntegration.class.getResource(
-                                ExtensionClientIntegration.RESOURCES
-                                        + "/application-browser.png")));
+        setIcon(ExtensionClientIntegration.getIcon("application-browser.png"));
 
         introPanel = new JPanel();
         introPanel.setLayout(new GridBagLayout());