org.zaproxy.zap.extension.callback.ui.CallbackPanel Maven / Gradle / Ivy

Go to download
/*
 * Zed Attack Proxy (ZAP) and its related class files.
 *
 * ZAP is an HTTP/HTTPS proxy for assessing web application security.
 *
 * Copyright 2017 The ZAP Development Team
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.zaproxy.zap.extension.callback.ui;

import java.awt.BorderLayout;
import java.awt.CardLayout;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import javax.swing.Box;
import javax.swing.ImageIcon;
import javax.swing.JButton;
import javax.swing.JPanel;
import javax.swing.JScrollPane;
import javax.swing.JToolBar;
import org.parosproxy.paros.Constant;
import org.parosproxy.paros.control.Control;
import org.parosproxy.paros.extension.AbstractPanel;
import org.zaproxy.zap.utils.DisplayUtils;
import org.zaproxy.zap.utils.FontUtils;

/**
 * @deprecated (2.11.0) Superseded by the OAST add-on.
 */
@Deprecated
@SuppressWarnings("serial")
public class CallbackPanel extends AbstractPanel {

    private static final long serialVersionUID = 1L;

    private JToolBar mainToolBar;
    private JPanel mainPanel = null;
    private JScrollPane scrollPane = null;
    private CallbackTable resultsTable = null;
    private CallbackTableModel model = null;
    private org.zaproxy.zap.extension.callback.ExtensionCallback extensionCallback;

    public CallbackPanel(org.zaproxy.zap.extension.callback.ExtensionCallback extensionCallback) {
        super();
        this.extensionCallback = extensionCallback;
        initialize();
    }

    private void initialize() {
        this.setLayout(new CardLayout());
        this.setName(Constant.messages.getString("callback.panel.name"));
        this.setIcon(
                new ImageIcon(CallbackPanel.class.getResource("/resource/icon/16/callbacks.png")));
        this.add(getMainPanel(), getMainPanel().getName());
    }

    private javax.swing.JPanel getMainPanel() {
        if (mainPanel == null) {
            mainPanel = new JPanel(new BorderLayout());
            mainPanel.setName("CallbackPanel");
            mainPanel.add(getToolBar(), BorderLayout.PAGE_START);
            mainPanel.add(getJScrollPane(), BorderLayout.CENTER);
        }

        return mainPanel;
    }

    private JToolBar getToolBar() {
        if (mainToolBar == null) {
            mainToolBar = new JToolBar();
            mainToolBar.setEnabled(true);
            mainToolBar.setFloatable(false);
            mainToolBar.setRollover(true);
            mainToolBar.setName("Callback Toolbar");

            mainToolBar.add(getClearButton());
            mainToolBar.add(Box.createHorizontalGlue());
            mainToolBar.add(getOptionsButton());
        }
        return mainToolBar;
    }

    private JButton getClearButton() {
        JButton clearButton =
                new JButton(Constant.messages.getString("callback.panel.clear.button.label"));
        clearButton.setToolTipText(
                Constant.messages.getString("callback.panel.clear.button.toolTip"));
        clearButton.setIcon(
                DisplayUtils.getScaledIcon(
                        new ImageIcon(
                                CallbackPanel.class.getResource(
                                        "/resource/icon/fugue/broom.png"))));
        clearButton.addActionListener(
                new java.awt.event.ActionListener() {
                    @Override
                    public void actionPerformed(java.awt.event.ActionEvent e) {
                        deleteAllCallbacks();
                    }
                });
        return clearButton;
    }

    private void deleteAllCallbacks() {
        extensionCallback.deleteCallbacks();
    }

    private JButton getOptionsButton() {
        JButton optionsButton = new JButton();
        optionsButton.setToolTipText(
                Constant.messages.getString("callback.panel.options.button.label"));
        optionsButton.setIcon(
                DisplayUtils.getScaledIcon(
                        new ImageIcon(
                                CallbackPanel.class.getResource("/resource/icon/16/041.png"))));
        optionsButton.addActionListener(
                new ActionListener() {
                    @Override
                    public void actionPerformed(ActionEvent e) {
                        Control.getSingleton()
                                .getMenuToolsControl()
                                .options(Constant.messages.getString("callback.options.title"));
                    }
                });
        return optionsButton;
    }

    private JScrollPane getJScrollPane() {
        if (scrollPane == null) {
            scrollPane = new JScrollPane();
            scrollPane.setFont(FontUtils.getFont("Dialog"));
            scrollPane.setHorizontalScrollBarPolicy(
                    javax.swing.JScrollPane.HORIZONTAL_SCROLLBAR_AS_NEEDED);
            scrollPane.setViewportView(getResultsTable());
        }

        return scrollPane;
    }

    private CallbackTable getResultsTable() {
        if (this.resultsTable == null) {
            this.model = new CallbackTableModel();
            this.resultsTable = new CallbackTable(model);
        }
        return this.resultsTable;
    }

    public void addCallbackRequest(CallbackRequest callbackRequest) {
        model.addEntry(callbackRequest);
    }

    public void clearCallbackRequests() {
        model.clear();
    }
}