org.codehaus.mojo.license.AbstractLicenseReportRenderer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of license-maven-plugin Show documentation
Maven plugin to download and collect license files from project dependencies.
The newest version!
package org.codehaus.mojo.license;

/*
 * #%L
 * License Maven Plugin
 * %%
 * Copyright (C) 2012 CodeLutin, Codehaus, Tony Chemit
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Lesser Public License for more details.
 *
 * You should have received a copy of the GNU General Lesser Public
 * License along with this program.  If not, see
 * .
 * #L%
 */

import java.util.Collection;
import java.util.Locale;

import org.apache.maven.artifact.ArtifactUtils;
import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.doxia.sink.SinkEventAttributes;
import org.apache.maven.doxia.sink.impl.SinkEventAttributeSet;
import org.apache.maven.reporting.AbstractMavenReportRenderer;
import org.codehaus.mojo.license.api.ThirdPartyDetails;
import org.codehaus.plexus.i18n.I18N;

/**
 * Base class for report renderers.
 *
 * @author tchemit [email protected]
 * @since 1.1
 */
public abstract class AbstractLicenseReportRenderer extends AbstractMavenReportRenderer {
    /**
     * Internationalization component.
     *
     * @since 1.1
     */
    protected final I18N i18n;

    /**
     * The locale we are rendering for.
     *
     * @since 1.1
     */
    protected final Locale locale;

    /**
     * The name of the bundle containing our I18n resources.
     *
     * @since 1.1
     */
    protected final String bundleName;

    public AbstractLicenseReportRenderer(Sink sink, String bundleName, I18N i18n, Locale locale) {
        super(sink);
        this.bundleName = bundleName;
        this.i18n = i18n;
        this.locale = locale;
    }

    /**
     * {@inheritDoc}
     */
    public String getTitle() {
        return getText("report.title");
    }

    /**
     * Gets the localized message for this report.
     *
     * @param key the message key.
     * @return the message.
     */
    public String getText(String key) {
        return i18n.getString(bundleName, locale, key);
    }

    protected void renderWarningIcon() {
        sink.figure();
        sink.figureGraphics("images/icon_warning_sml.gif");
        sink.figure_();
    }

    protected void renderErrorIcon() {
        sink.figure();
        sink.figureGraphics("images/icon_error_sml.gif");
        sink.figure_();
    }

    protected void renderSuccessIcon() {
        sink.figure();
        sink.figureGraphics("images/icon_success_sml.gif");
        sink.figure_();
    }

    protected void renderInfoIcon() {
        sink.figure();
        sink.figureGraphics("images/icon_info_sml.gif");
        sink.figure_();
    }

    protected String getGAV(ThirdPartyDetails details) {
        return ArtifactUtils.versionlessKey(details.getGroupId(), details.getArtifactId()) + ":" + details.getVersion();
    }

    protected void sinkHeaderCellText(String width, String text) {

        SinkEventAttributes attrs = new SinkEventAttributeSet();
        attrs.addAttribute(SinkEventAttributes.WIDTH, width);

        sink.tableHeaderCell(attrs);
        sink.text(text);
        sink.tableHeaderCell_();
    }

    protected void sinkCellText(String width, String text) {
        SinkEventAttributes attrs = new SinkEventAttributeSet();
        attrs.addAttribute(SinkEventAttributes.WIDTH, width);
        sink.tableCell(attrs);
        sink.text(text);
        sink.tableCell_();
    }

    protected void renderThirdPartySummaryTableRow(ThirdPartyDetails details) {
        sink.tableRow();
        sink.tableCell();
        if (details.hasPomLicenses()) {
            renderSuccessIcon();
        } else if (details.hasThirdPartyLicenses()) {
            renderWarningIcon();
        } else {
            renderErrorIcon();
        }
        sink.tableCell_();

        sink.tableCell();
        String gav = getGAV(details);
        sink.link("#" + gav);
        sink.text(gav);
        sink.link_();
        sink.tableCell_();

        tableCell(details.getScope());
        tableCell(details.getClassifier());
        tableCell(details.getType());

        sink.tableCell();
        if (details.hasLicenses()) {
            String[] licenses = details.getLicenses();
            for (int i = 0; i < licenses.length; i++) {
                if (i > 0) {
                    sink.lineBreak();
                }
                sink.text(licenses[i]);
            }
        } else {
            sink.text("-");
        }
        sink.tableCell_();

        sink.tableRow_();
    }

    protected void renderThirdPartyDetailTable(ThirdPartyDetails details) {
        final String cellWidth = "80%";
        final String headerWidth = "20%";
        startTable(new int[] {Sink.JUSTIFY_RIGHT, Sink.JUSTIFY_LEFT}, false);

        sink.tableRow();
        sinkHeaderCellText(headerWidth, getText("report.status"));
        SinkEventAttributes attrs = new SinkEventAttributeSet();
        attrs.addAttribute(SinkEventAttributes.WIDTH, cellWidth);
        sink.tableCell(attrs);
        if (details.hasPomLicenses()) {
            renderSuccessIcon();
            sink.nonBreakingSpace();
            sink.text(getText("report.status.licenseFromPom"));
        } else if (details.hasThirdPartyLicenses()) {
            renderWarningIcon();
            sink.nonBreakingSpace();
            sink.text(getText("report.status.licenseFromThirdParty"));
        } else {
            renderErrorIcon();
            sink.nonBreakingSpace();
            sink.text(getText("report.status.noLicense"));
        }
        sink.tableCell_();
        sink.tableRow_();

        sink.tableRow();
        sinkHeaderCellText(headerWidth, getText("report.gav"));
        sinkCellText(cellWidth, getGAV(details));
        sink.tableRow_();

        sink.tableRow();
        sinkHeaderCellText(headerWidth, getText("report.scope"));
        sinkCellText(cellWidth, details.getScope());
        sink.tableRow_();

        sink.tableRow();
        sinkHeaderCellText(headerWidth, getText("report.classifier"));
        sinkCellText(cellWidth, details.getClassifier());
        sink.tableRow_();

        sink.tableRow();
        sinkHeaderCellText(headerWidth, getText("report.type"));
        sinkCellText(cellWidth, details.getType());
        sink.tableRow_();

        String[] licenses = details.getLicenses();

        if (details.hasPomLicenses()) {
            sink.tableRow();
            sinkHeaderCellText(headerWidth, getText("report.licenses"));

            sink.tableCell(attrs);
            for (int i = 0; i < licenses.length; i++) {
                if (i > 0) {
                    sink.lineBreak();
                }
                sink.text(licenses[i]);
            }
            sink.tableCell_();
            sink.tableRow_();
        } else if (details.hasThirdPartyLicenses()) {
            sink.tableRow();
            sinkHeaderCellText(headerWidth, getText("report.licenses"));
            sink.tableCell(attrs);
            for (int i = 0; i < licenses.length; i++) {
                if (i > 0) {
                    sink.lineBreak();
                }
                sink.text(licenses[i]);
            }
            sink.tableCell_();
            sink.tableRow_();
        } else {
            sink.tableRow();
            sinkHeaderCellText(headerWidth, getText("report.licenses"));
            sinkCellText(cellWidth, getText("report.no.license"));
            sink.tableRow_();
        }
        endTable();
    }

    protected void renderThirdPartySummaryTable(Collection collection) {
        startTable();
        tableHeader(new String[] {
            getText("report.status"),
            getText("report.gav"),
            getText("report.scope"),
            getText("report.classifier"),
            getText("report.type"),
            getText("report.licenses")
        });
        for (ThirdPartyDetails details : collection) {
            renderThirdPartySummaryTableRow(details);
        }
        endTable();
    }
}