/*
    * 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.apps;
  
  import jakarta.servlet.http.HttpServletRequest;
  import jakarta.servlet.http.HttpServletResponse;
  
  import org.apache.catalina.Context;
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  import org.springframework.web.servlet.ModelAndView;
  import org.springframework.web.servlet.view.InternalResourceView;
  import org.springframework.web.servlet.view.RedirectView;
  
  import psiprobe.controllers.AbstractContextHandlerController;
  
  /**
   * Base class preventing "destructive" actions to be executed on the Probe's context.
   */
  public abstract class AbstractNoSelfContextHandlerController
      extends AbstractContextHandlerController {
  
    /** The Constant logger. */
    private static final Logger logger =
        LoggerFactory.getLogger(AbstractNoSelfContextHandlerController.class);
  
    /** The pass query string. */
    private boolean passQueryString;
  
    /**
     * Checks if is pass query string.
     *
     * @return true, if is pass query string
     */
    public boolean isPassQueryString() {
      return passQueryString;
    }
  
    /**
     * Sets the pass query string.
     *
     * @param passQueryString the new pass query string
     */
    public void setPassQueryString(boolean passQueryString) {
      this.passQueryString = passQueryString;
    }
  
    @Override
    protected ModelAndView handleContext(String contextName, Context context,
        HttpServletRequest request, HttpServletResponse response) throws Exception {
  
      try {
        if (request.getContextPath().equals(contextName)) {
          throw new IllegalStateException(
              getMessageSourceAccessor().getMessage("probe.src.contextAction.cannotActOnSelf"));
        }
  
        executeAction(contextName);
      } catch (Exception e) {
        request.setAttribute("errorMessage", e.getMessage());
        logger.error("Error during invocation", e);
        return new ModelAndView(new InternalResourceView(getViewName()));
      }
      return new ModelAndView(new RedirectView(request.getContextPath() + getViewName()
          + (isPassQueryString() ? "?" + request.getQueryString() : "")));
    }
  
    /**
     * Execute action.
     *
     * @param contextName the context name
     *
     * @throws Exception the exception
     */
    protected abstract void executeAction(String contextName) throws Exception;
  
  }