org.zaproxy.zap.extension.jsonview.HttpPanelJsonView.java Source code

Introduction

Here is the source code for org.zaproxy.zap.extension.jsonview.HttpPanelJsonView.java

Source

/*
 * Zed Attack Proxy (ZAP) and its related class files.
 *
 * ZAP is an HTTP/HTTPS proxy for assessing web application security.
 *
 * Copyright 2018 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.jsonview;

import java.awt.BorderLayout;
import java.awt.Component;
import javax.swing.JComponent;
import javax.swing.JPanel;
import javax.swing.JPopupMenu;
import net.sf.json.*;
import org.apache.commons.configuration.FileConfiguration;
import org.fife.ui.rtextarea.RTextScrollPane;
import org.parosproxy.paros.network.HttpMessage;
import org.parosproxy.paros.view.View;
import org.zaproxy.zap.extension.httppanel.Message;
import org.zaproxy.zap.extension.httppanel.view.*;
import org.zaproxy.zap.extension.httppanel.view.impl.models.http.request.RequestBodyStringHttpPanelViewModel;
import org.zaproxy.zap.extension.httppanel.view.impl.models.http.response.ResponseBodyStringHttpPanelViewModel;

public class HttpPanelJsonView implements HttpPanelView, HttpPanelViewModelListener {

    /**
     * Default name used for {@code MessageContainer}.
     *
     * @see org.zaproxy.zap.view.messagecontainer.MessageContainer
     */
    public static final String NAME = "HttpPanelJsonView";

    private static final String CAPTION_NAME = "Json";

    private HttpPanelJsonArea httpPanelJsonArea;
    private JPanel mainPanel;

    private AbstractStringHttpPanelViewModel model;

    public HttpPanelJsonView(AbstractStringHttpPanelViewModel model) {
        httpPanelJsonArea = new HttpPanelJsonArea();
        RTextScrollPane scrollPane = new RTextScrollPane(httpPanelJsonArea);
        scrollPane.setLineNumbersEnabled(false);
        mainPanel = new JPanel(new BorderLayout());
        mainPanel.add(scrollPane, BorderLayout.CENTER);
        this.model = model;
        model.addHttpPanelViewModelListener(this);

        httpPanelJsonArea.setComponentPopupMenu(new JPopupMenu() {

            private static final long serialVersionUID = 1L;

            @Override
            public void show(Component invoker, int x, int y) {
                if (!httpPanelJsonArea.isFocusOwner()) {
                    httpPanelJsonArea.requestFocusInWindow();
                }
                View.getSingleton().getPopupMenu().show(httpPanelJsonArea, x, y);
            };
        });
    }

    @Override
    public void setSelected(boolean selected) {
        if (selected) {
            httpPanelJsonArea.requestFocusInWindow();
        }
    }

    @Override
    public String getName() {
        return NAME;
    }

    @Override
    public String getCaptionName() {
        return CAPTION_NAME;
    }

    @Override
    public String getTargetViewName() {
        return "";
    }

    @Override
    public int getPosition() {
        return 0;
    }

    @Override
    public boolean isEnabled(Message message) {
        String jsonString;
        if (message instanceof HttpMessage) {
            HttpMessage httpMessage = ((HttpMessage) message);
            if (this.model instanceof RequestBodyStringHttpPanelViewModel) {
                jsonString = httpMessage.getRequestBody().toString();
            } else if (this.model instanceof ResponseBodyStringHttpPanelViewModel) {
                jsonString = httpMessage.getResponseBody().toString();
            } else {
                return false;
            }
        } else {
            return false;
        }
        try {
            toJson(jsonString);
            return true;
        } catch (JSONException e) {
            return false;
        }
    }

    @Override
    public boolean hasChanged() {
        return true;
    }

    @Override
    public JComponent getPane() {
        return mainPanel;
    }

    @Override
    public boolean isEditable() {
        return httpPanelJsonArea.isEditable();
    }

    @Override
    public void setEditable(boolean editable) {
        httpPanelJsonArea.setEditable(editable);
    }

    @Override
    public HttpPanelViewModel getModel() {
        return model;
    }

    @Override
    public void save() {
        // we intentionally want to let the user give broken data
        this.model.setData(httpPanelJsonArea.getText());
    }

    @Override
    public void setParentConfigurationKey(String configurationKey) {
    }

    @Override
    public void loadConfiguration(FileConfiguration fileConfiguration) {
    }

    @Override
    public void saveConfiguration(FileConfiguration fileConfiguration) {
    }

    @Override
    public void dataChanged(HttpPanelViewModelEvent e) {
        String body = ((AbstractStringHttpPanelViewModel) e.getSource()).getData();
        try {
            JSON json = toJson(body);
            if (json instanceof JSONNull) {
                // avoid the string "null" for empty bodies
                httpPanelJsonArea.setText("");
            } else {
                httpPanelJsonArea.setText(json.toString(2));
            }
        } catch (JSONException ex) {
            httpPanelJsonArea.setText(body);
        }
        if (!isEditable()) {
            httpPanelJsonArea.discardAllEdits();
        }
        // TODO: scrolling to top when new message is opened
        // httpPanelJsonArea.setCaretPosition(0);
    }

    private static JSON toJson(String s) throws JSONException {
        JSON object;
        s = s.trim();

        if (s.isEmpty()) {
            object = JSONNull.getInstance();
        } else if (s.startsWith("{")) {
            object = JSONObject.fromObject(s);
        } else if (s.startsWith("[")) {
            object = JSONArray.fromObject(s);
        } else {
            throw new JSONException("Expected a '{', '[', or an empty message");
        }
        return object;
    }
}