ExceptionStackTracePanel.java

/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you 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.apache.isis.viewer.wicket.ui.errors;

import org.apache.wicket.MarkupContainer;
import org.apache.wicket.markup.head.IHeaderResponse;
import org.apache.wicket.markup.head.JavaScriptReferenceHeaderItem;
import org.apache.wicket.markup.html.WebMarkupContainer;
import org.apache.wicket.markup.html.basic.Label;
import org.apache.wicket.markup.html.basic.MultiLineLabel;
import org.apache.wicket.markup.html.panel.Panel;
import org.apache.wicket.model.Model;
import org.apache.wicket.request.resource.JavaScriptResourceReference;

import org.apache.isis.applib.services.error.Ticket;
import org.apache.isis.viewer.wicket.ui.util.Components;

public class ExceptionStackTracePanel extends Panel {

    private static final long serialVersionUID = 1L;

    private static final String ID_MAIN_MESSAGE = "mainMessage";

    private static final String ID_TICKET_DETAILS_DIV = "ticketDetailsDiv";
    private static final String ID_TICKET_DETAILS = "ticketDetails";

    private static final String ID_TICKET_REFERENCE_DIV = "ticketReferenceDiv";
    private static final String ID_TICKET_REFERENCE = "ticketReference";

    private static final String ID_EXCEPTION_DETAIL_DIV = "exceptionDetailDiv";

    private static final String ID_STACK_TRACE_ELEMENT = "stackTraceElement";
    private static final String ID_LINE = "stackTraceElementLine";

    private static final JavaScriptResourceReference DIV_TOGGLE_JS = new JavaScriptResourceReference(ExceptionStackTracePanel.class, "div-toggle.js");

    public ExceptionStackTracePanel(String id, ExceptionModel exceptionModel) {
        super(id, exceptionModel);

        final Ticket ticket = exceptionModel.getTicket();
        final String mainMessage =
                ticket != null && ticket.getUserMessage() != null
                        ? ticket.getUserMessage()
                        : exceptionModel.getMainMessage();

        final Label label = new Label(ID_MAIN_MESSAGE, mainMessage);

        // to avoid potential XSS attacks, no longer escape model strings
        // (risk is low but could just happen: error message being rendered might accidentally or deliberately contain rogue Javascript)
        // label.setEscapeModelStrings(false);
        add(label);

        final String ticketDetail = ticket != null ? ticket.getDetails(): null;
        if(ticketDetail == null) {
            Components.permanentlyHide(this, ID_TICKET_DETAILS_DIV);
        } else {
            final WebMarkupContainer panel = new WebMarkupContainer(ID_TICKET_DETAILS_DIV);
            final MultiLineLabel details = new MultiLineLabel(ID_TICKET_DETAILS, Model.of(ticketDetail));
            panel.add(details);
            add(panel);
        }

        final String ticketReference = ticket != null ? ticket.getReference(): null;
        if(ticketReference == null) {
            Components.permanentlyHide(this, ID_TICKET_REFERENCE_DIV);
        } else {
            final WebMarkupContainer panel = new WebMarkupContainer(ID_TICKET_REFERENCE_DIV);
            final Label reference = new Label(ID_TICKET_REFERENCE, Model.of(ticketReference));
            panel.add(reference);
            add(panel);
        }

        final boolean suppressExceptionDetail = exceptionModel.isAuthorizationException() || exceptionModel.isRecognized();
        if(suppressExceptionDetail) {
            Components.permanentlyHide(this, ID_EXCEPTION_DETAIL_DIV);
        } else {

                MarkupContainer container = new WebMarkupContainer(ID_EXCEPTION_DETAIL_DIV) {
                private static final long serialVersionUID = 1L;
                @Override
                public void renderHead(IHeaderResponse response) {
                    response.render(JavaScriptReferenceHeaderItem.forReference(DIV_TOGGLE_JS));
                }
            };
            container.add(new StackTraceListView(ID_STACK_TRACE_ELEMENT, ExceptionStackTracePanel.ID_LINE, exceptionModel.getStackTrace()));
            add(container);
        }
    }

}