org.apache.maven.plugins.site.run.SiteRunMojo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of maven-site-plugin Show documentation
The Maven Site Plugin is a plugin that generates a site for the current project.
There is a newer version: 4.0.0-M16
/*
 * 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.maven.plugins.site.run;

import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.InetSocketAddress;
import java.util.HashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;

import org.apache.maven.doxia.siterenderer.DocumentRenderer;
import org.apache.maven.doxia.siterenderer.SiteRenderingContext;
import org.apache.maven.doxia.tools.SiteTool;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.annotations.ResolutionScope;
import org.apache.maven.plugins.site.render.AbstractSiteRenderingMojo;
import org.apache.maven.reporting.exec.MavenReportExecution;
import org.codehaus.plexus.util.IOUtil;
import org.eclipse.jetty.server.Server;
import org.eclipse.jetty.webapp.WebAppContext;

import static org.apache.maven.shared.utils.logging.MessageUtils.buffer;

/**
 * Starts the site up, rendering documents as requested for faster editing.
 * It uses Jetty as the web server.
 *
 * @author Brett Porter
 *
 */
@Mojo(name = "run", requiresDependencyResolution = ResolutionScope.TEST, requiresReports = true)
public class SiteRunMojo extends AbstractSiteRenderingMojo {
    /**
     * Where to create the dummy web application.
     */
    @Parameter(defaultValue = "${project.build.directory}/site-webapp")
    private File tempWebappDirectory;

    /**
     * The host to execute the HTTP server on.
     */
    @Parameter(property = "host", defaultValue = "localhost")
    private String host;

    /**
     * The port to execute the HTTP server on.
     */
    @Parameter(property = "port", defaultValue = "8080")
    private int port;

    /**
     * @see org.apache.maven.plugin.AbstractMojo#execute()
     */
    @Override
    public void execute() throws MojoExecutionException, MojoFailureException {
        checkInputEncoding();

        Server server = new Server(InetSocketAddress.createUnresolved(host, port));
        server.setStopAtShutdown(true);

        WebAppContext webapp = createWebApplication();
        webapp.setServer(server);

        server.setHandler(webapp);

        try {
            server.start();
        } catch (Exception e) {
            throw new MojoExecutionException("Error executing Jetty", e);
        }

        getLog().info(buffer().a("Started Jetty on ").strong(server.getURI()).build());

        // Watch it
        try {
            server.getThreadPool().join();
        } catch (InterruptedException e) {
            getLog().warn("Jetty was interrupted", e);
        }
    }

    private WebAppContext createWebApplication() throws MojoExecutionException {
        File webXml = new File(tempWebappDirectory, "WEB-INF/web.xml");
        webXml.getParentFile().mkdirs();

        try (InputStream inStream = getClass().getResourceAsStream("/run/web.xml"); //
                FileOutputStream outStream = new FileOutputStream(webXml)) {
            IOUtil.copy(inStream, outStream);
        } catch (IOException e) {
            throw new MojoExecutionException("Unable to construct temporary webapp for running site", e);
        }

        WebAppContext webapp = new WebAppContext();
        webapp.setContextPath("/");
        webapp.setResourceBase(tempWebappDirectory.getAbsolutePath());
        webapp.setAttribute(DoxiaFilter.OUTPUT_DIRECTORY_KEY, tempWebappDirectory);
        webapp.setAttribute(DoxiaFilter.SITE_RENDERER_KEY, siteRenderer);
        webapp.getInitParams().put("org.mortbay.jetty.servlet.Default.useFileMappedBuffer", "false");

        // For external reports
        project.getReporting().setOutputDirectory(tempWebappDirectory.getAbsolutePath());

        List localesList = getLocales();
        webapp.setAttribute(DoxiaFilter.LOCALES_LIST_KEY, localesList);

        try {
            Map i18nDoxiaContexts = new HashMap<>();

            for (Locale locale : localesList) {
                SiteRenderingContext i18nContext = createSiteRenderingContext(locale);
                i18nContext.setInputEncoding(getInputEncoding());
                i18nContext.setOutputEncoding(getOutputEncoding());

                File outputDirectory = getOutputDirectory(locale);
                List reports = getReports(outputDirectory);

                Map i18nDocuments = locateDocuments(i18nContext, reports, locale);
                DoxiaBean doxiaBean = new DoxiaBean(i18nContext, i18nDocuments);

                if (!locale.equals(SiteTool.DEFAULT_LOCALE)) {
                    i18nDoxiaContexts.put(locale.toString(), doxiaBean);
                } else {
                    i18nDoxiaContexts.put("default", doxiaBean);
                }

                if (!locale.equals(SiteTool.DEFAULT_LOCALE)) {
                    siteRenderer.copyResources(i18nContext, new File(tempWebappDirectory, locale.toString()));
                } else {
                    siteRenderer.copyResources(i18nContext, tempWebappDirectory);
                }
            }

            webapp.setAttribute(DoxiaFilter.I18N_DOXIA_CONTEXTS_KEY, i18nDoxiaContexts);
        } catch (Exception e) {
            throw new MojoExecutionException("Unable to set up webapp", e);
        }
        return webapp;
    }

    private File getOutputDirectory(Locale locale) {
        File file;
        if (!locale.equals(SiteTool.DEFAULT_LOCALE)) {
            file = new File(tempWebappDirectory, locale.toString());
        } else {
            file = tempWebappDirectory;
        }

        // Safety
        if (!file.exists()) {
            file.mkdirs();
        }

        return file;
    }

    public void setTempWebappDirectory(File tempWebappDirectory) {
        this.tempWebappDirectory = tempWebappDirectory;
    }

    public void setPort(int port) {
        this.port = port;
    }
}