psiprobe.controllers.deploy.UploadWarController Maven / Gradle / Ivy

Go to download
/*
 * Licensed under the GPL License. You may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 *
 * THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
 * WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE.
 */
package psiprobe.controllers.deploy;

import java.io.File;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.util.List;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.apache.catalina.Context;
import org.apache.commons.io.FileUtils;
import org.apache.commons.io.FilenameUtils;
import org.apache.tomcat.util.http.fileupload.FileItem;
import org.apache.tomcat.util.http.fileupload.FileItemFactory;
import org.apache.tomcat.util.http.fileupload.FileUpload;
import org.apache.tomcat.util.http.fileupload.disk.DiskFileItemFactory;
import org.apache.tomcat.util.http.fileupload.servlet.ServletRequestContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.security.core.Authentication;
import org.springframework.security.core.context.SecurityContextHolder;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.view.InternalResourceView;

import psiprobe.controllers.AbstractTomcatContainerController;
import psiprobe.controllers.jsp.DisplayJspController;
import psiprobe.model.jsp.Summary;

/**
 * Uploads and installs web application from a .WAR.
 */
@Controller
public class UploadWarController extends AbstractTomcatContainerController {

  /** The Constant logger. */
  private static final Logger logger = LoggerFactory.getLogger(UploadWarController.class);
  private static final int MAXSECONDS_WAITFOR_CONTEXT = 10;

  @RequestMapping(path = "/adm/war.htm")
  @Override
  public ModelAndView handleRequest(HttpServletRequest request, HttpServletResponse response)
      throws Exception {
    return super.handleRequest(request, response);
  }

  @Override
  protected ModelAndView handleRequestInternal(HttpServletRequest request,
      HttpServletResponse response) throws Exception {

    // If not multi-part content, exit
    if (!this.isMultipartContent(request)) {
      return new ModelAndView(new InternalResourceView(getViewName()));
    }

    File tmpWar = null;
    String contextName = null;
    boolean update = false;
    boolean compile = false;
    boolean discard = false;

    // parse multipart request and extract the file
    FileItemFactory factory =
        new DiskFileItemFactory(1048000, new File(System.getProperty("java.io.tmpdir")));
    FileUpload upload = new FileUpload();
    upload.setFileItemFactory(factory);
    upload.setSizeMax(-1);
    upload.setHeaderEncoding(StandardCharsets.UTF_8.name());
    try {
      List fileItems = upload.parseRequest(new ServletRequestContext(request));
      for (FileItem fi : fileItems) {
        if (!fi.isFormField()) {
          if (fi.getName() != null && fi.getName().length() > 0) {
            tmpWar =
                new File(System.getProperty("java.io.tmpdir"), FilenameUtils.getName(fi.getName()));
            fi.write(tmpWar);
          }
        } else if ("context".equals(fi.getFieldName())) {
          contextName = fi.getString();
        } else if ("update".equals(fi.getFieldName()) && "yes".equals(fi.getString())) {
          update = true;
        } else if ("compile".equals(fi.getFieldName()) && "yes".equals(fi.getString())) {
          compile = true;
        } else if ("discard".equals(fi.getFieldName()) && "yes".equals(fi.getString())) {
          discard = true;
        }
      }
    } catch (Exception e) {
      logger.error("Could not process file upload", e);
      request.setAttribute("errorMessage", getMessageSourceAccessor()
          .getMessage("probe.src.deploy.war.uploadfailure", new Object[] {e.getMessage()}));
      if (tmpWar != null) {
        Files.delete(tmpWar.toPath());
        tmpWar = null;
      }
    }

    String errMsg = null;

    if (tmpWar == null) {
      return new ModelAndView(new InternalResourceView(getViewName()));
    }

    try {
      if (tmpWar.getName().endsWith(".war")) {

        if (contextName == null || contextName.length() == 0) {
          String warFileName = tmpWar.getName().replaceAll("\\.war$", "");
          contextName = "/" + warFileName;
        }

        contextName = getContainerWrapper().getTomcatContainer().formatContextName(contextName);

        /*
         * pass the name of the newly deployed context to the presentation layer using this name the
         * presentation layer can render a url to view compilation details
         */
        String visibleContextName = contextName.isEmpty() ? "/" : contextName;
        request.setAttribute("contextName", visibleContextName);

        if (update && getContainerWrapper().getTomcatContainer().findContext(contextName) != null) {
          logger.debug("updating {}: removing the old copy", contextName);
          getContainerWrapper().getTomcatContainer().remove(contextName);
        }

        if (getContainerWrapper().getTomcatContainer().findContext(contextName) == null) {
          // move the .war to tomcat application base dir
          String destWarFilename =
              getContainerWrapper().getTomcatContainer().formatContextFilename(contextName);
          File destWar = new File(getContainerWrapper().getTomcatContainer().getAppBase(),
              destWarFilename + ".war");

          FileUtils.moveFile(tmpWar, destWar);

          // let Tomcat know that the file is there
          getContainerWrapper().getTomcatContainer().installWar(contextName);

          File destContext =
              new File(getContainerWrapper().getTomcatContainer().getAppBase(), destWarFilename);
          // Wait few seconds for creating context dir to avoid empty context
          FileUtils.waitFor(destContext, MAXSECONDS_WAITFOR_CONTEXT);

          Context ctx = getContainerWrapper().getTomcatContainer().findContext(contextName);
          if (ctx == null) {
            errMsg = getMessageSourceAccessor().getMessage("probe.src.deploy.war.notinstalled",
                new Object[] {visibleContextName});
          } else {
            request.setAttribute("success", Boolean.TRUE);
            // Logging action
            Authentication auth = SecurityContextHolder.getContext().getAuthentication();
            // get username logger
            String name = auth.getName();
            logger.info(getMessageSourceAccessor().getMessage("probe.src.log.deploywar"), name,
                contextName);
            if (discard) {
              getContainerWrapper().getTomcatContainer().discardWorkDir(ctx);
              logger.info(getMessageSourceAccessor().getMessage("probe.src.log.discardwork"), name,
                  contextName);
            }
            if (compile) {
              Summary summary = new Summary();
              summary.setName(ctx.getName());
              getContainerWrapper().getTomcatContainer().listContextJsps(ctx, summary, true);
              request.getSession(false).setAttribute(DisplayJspController.SUMMARY_ATTRIBUTE,
                  summary);
              request.setAttribute("compileSuccess", Boolean.TRUE);
            }
          }
        } else {
          errMsg = getMessageSourceAccessor().getMessage("probe.src.deploy.war.alreadyExists",
              new Object[] {visibleContextName});
        }
      } else {
        errMsg = getMessageSourceAccessor().getMessage("probe.src.deploy.war.notWar.failure");
      }
    } catch (IOException e) {
      errMsg = getMessageSourceAccessor().getMessage("probe.src.deploy.war.failure",
          new Object[] {e.getMessage()});
      logger.error("Tomcat threw an exception when trying to deploy", e);
    } finally {
      if (errMsg != null) {
        request.setAttribute("errorMessage", errMsg);
      }
      // If war was not moved, delete it
      if (tmpWar.exists()) {
        Files.delete(tmpWar.toPath());
      }
    }
    return new ModelAndView(new InternalResourceView(getViewName()));
  }

  @Value("/adm/deploy.htm")
  @Override
  public void setViewName(String viewName) {
    super.setViewName(viewName);
  }

}