/**
    * Copyright 2005-2006 the original author or authors.
    *
    * Licensed under the Gnu General Pubic 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.opensource.org/licenses/gpl-license.php
    *
   * 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 Public License for more details.
   */
  package org.figure8.join.control.action;
  
  import org.figure8.join.control.JoinAction;
  import org.figure8.join.control.form.DeploymentForm;
  import org.figure8.join.businessobjects.artifact.Assembly;
  import org.figure8.join.businessobjects.commons.Target;
  import org.figure8.join.businessobjects.commons.Status;
  import org.figure8.join.businessobjects.environment.Deployment;
  import org.figure8.join.businessobjects.environment.LogicalEnvironment;
  import org.figure8.join.businessfacades.artifact.AssemblyManager;
  import org.figure8.join.businessfacades.commons.IntegrationProcessManager;
  import org.figure8.join.businessfacades.environment.EnvironmentManager;
  import org.figure8.join.services.workflow.OperationNotAllowedException;
  import org.figure8.join.util.LogUtil;
  
  import org.apache.commons.logging.Log;
  import org.apache.struts.action.ActionForm;
  import org.apache.struts.action.ActionForward;
  import org.apache.struts.action.ActionMapping;
  
  import javax.servlet.http.HttpServletRequest;
  import javax.servlet.http.HttpServletResponse;
  
  import java.util.List;
  import java.util.ArrayList;
  /**
   * This is a Struts action controller for managind Deployment related operations.
   * @author <a href="mailto:laurent.broudoux@free.fr">Laurent Broudoux</a>
   * @version $Revision: 1.2 $
   *
   * @struts.action path="/deployment" name="deploymentForm"
   *                scope="request" parameter="op" validate="true"
   *                input="/pages/mainpage.jsp?body=/jsp/environment/deployment.jsp"
   * @struts.action-forward name="Form" path="/jsp/environment/deploymentform.jsp"
   * @struts.action-forward name="Status" path="/jsp/forcestatus.jsp"
   * @struts.action-forward name="Deployment" path="/jsp/environment/deployment.jsp"
   * @struts.action-forward name="Deployments" path="/jsp/environment/deployments.jsp"
   * @struts.action-forward name="Environments" path="/action/logicalEnvironment?op=view"
   */
  public class DeploymentActions extends JoinAction{
  
     // Static -------------------------------------------------------------------
  
     /** Get a commons logger. */
     private static final Log log = LogUtil.getLog(DeploymentActions.class);
  
     /** Operation code for showing a deployment creation form */
     public static final String FORM_OP = "form";
     /** Operation code for loading a specific Deployment */
     public static final String LOAD_OP = "load";
     /** Operation code for creating a new Deployment */
     public static final String CREATE_OP = "create";
     /** Operation code for preparing a specified Deployment */
     public static final String PREPARE_OP = "prepare";
     /** Operation code for getting deployments being prepared at that time */
     public static final String PREPARING_OP = "getPreparing";
     /** Operation code for realizing a specified Deployment */
     public static final String REALIZE_OP = "realize";
     /** Operation code for getting deployments being realized at that time */
     public static final String REALIZING_OP = "getRealizing";
     /** Operation code for cancelling a specified Deployment */
     public static final String CANCEL_OP = "cancel";
     /** Operation code for ending a specified Deployment */
     public static final String END_OP = "end";
     /** Operation code for forcing status of a specified Deployment */
     public static final String STATUS_OP = "forceStatus";
  
     /** The request scope for specifying the title of the screen (used by view) */
     public static final String TITLE_KEY = "title";
     /** The request scope for specifying on which screen we are (used by view) */
     public static final String SCREEN_KEY = "screen";
     /**
      * The request scope attribute under which the Deployment object currently
      * selected by our logged-in User is stored.
      */
     public static final String DEPLOYMENT_KEY = "deployment";
     /**
      * The request scope attribute under which the retrivied deployments
      * list is stored.
      */
     public static final String DEPLOYMENTS_KEY = "deployments";
     /**
      * The request scope attribute under which is stored the code of operation that
      * has raised a NotAllowedOperationException during workflow.
      */
    public static final String NOT_ALLOWED_OPERATION_KEY = "notAllowed";
    /**
     * The request scope attribute under which is stored the message of
     * raised NotAllowedOperationException during workflow.
     */
    public static final String NOT_ALLOWED_OPERATION_MSG = "notAllowedMsg";
 
 
    // Attributes ---------------------------------------------------------------
 
    /** The AssemblyManager implementation to use */
    protected AssemblyManager assemblyManager = null;
    /** The EnvironmentManager implementation to use */
    protected EnvironmentManager environmentManager = null;
    /** The IntegrationProcessManager implementation to use */
    protected IntegrationProcessManager processManager = null;
 
 
    // Constructors -------------------------------------------------------------
 
    /** Creates a new instance of DeploymentActions */
    public DeploymentActions(){
    }
 
 
    // Public -------------------------------------------------------------------
 
    /** @param assemblyManager The AssemblyManager implementation to use */
    public void setAssemblyManager(AssemblyManager assemblyManager){
       this.assemblyManager = assemblyManager;
    }
    /** @param environmentManager The EnvironmentManager implementation to use */
    public void setEnvironmentManager(EnvironmentManager environmentManager){
       this.environmentManager = environmentManager;
    }
    /** @param processManager The IntegrationProcessManager implementation to use */
    public void setIntegrationProcessManager(IntegrationProcessManager processManager){
       this.processManager = processManager;
    }
 
 
    // Implementation of JoinAction ---------------------------------------------
 
    /**
     *
     * @param operation String representing the operation to invoke on Action
     * @param mapping Mapping between forwards name and path for this action
     * @param form The form object containing request parameters
     * @param request The servlet container request wrapper
     * @param response The servlet container response wrapper
     * @return A forward to the next view to render and display
     * @throws Exception such as InfraStructureExceptions ...
     */
    public ActionForward doExecute(String operation, ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response)
            throws Exception{
       // Trace operation to execute.
       log.debug("doExecute() called for '" + operation + "' operation");
 
       if (form instanceof DeploymentForm){
          // Get deployment form for operations.
          DeploymentForm dForm = (DeploymentForm)form;
 
          if (FORM_OP.equals(operation)){
             return showDeploymentForm(mapping, dForm, request, response);
          }
          else if (LOAD_OP.equals(operation)){
             return loadDeployment(mapping, dForm, request, response);
          }
          else if (CREATE_OP.equals(operation)){
             return createDeployment(mapping, dForm, request, response);
          }
          else if (PREPARE_OP.equals(operation)){
             return prepareDeployment(mapping, dForm, request, response);
          }
          else if (PREPARING_OP.equals(operation)){
             return getPreparingDeployments(mapping, dForm, request, response);
          }
          else if (REALIZE_OP.equals(operation)){
             return realizeDeployment(mapping, dForm, request, response);
          }
          else if (REALIZING_OP.equals(operation)){
             return getRealizingDeployments(mapping, dForm, request, response);
          }
          else if (CANCEL_OP.equals(operation)){
             return cancelDeployment(mapping, dForm, request, response);
          }
          else if (END_OP.equals(operation)){
             return endDeployment(mapping, dForm, request, response);
          }
          else if (STATUS_OP.equals(operation)){
             return forceStatus(mapping, dForm, request, response);
          }
       }
       // This should not happen...
       return null;
    }
 
 
    // Protected ----------------------------------------------------------------
 
    /**
     * Prepare all we need for displaying a deployment creation form
     * @return A forward to the next view ti render and display
     */
    protected ActionForward showDeploymentForm(ActionMapping mapping, DeploymentForm form, HttpServletRequest request, HttpServletResponse response)
          throws Exception{
       // Deployment request can specify an environment or an assembly.
       if (form.getLogicalEnvKey() != null){
          // Retrieve environment and list of candidate assemblies.
          LogicalEnvironment environment = environmentManager.getLogicalEnvironment(form.getLogicalEnvKey());
          List assemblies = assemblyManager.getAssemblies(environment.getRelease());
          // Store informations into request attributes.
          request.setAttribute(AssemblyActions.ASSEMBLIES_KEY, assemblies);
          request.setAttribute(LogicalEnvironmentActions.ENVIRONMENT_KEY, environment);
       }
       else if (form.getAssemblyKey() != null){
          // Retrieve assembly and candidate environments.
          List candidates = new ArrayList();
          Assembly assembly = assemblyManager.getAssembly(form.getAssemblyKey());
          List environments = environmentManager.getLogicalEnvironments();
          // Environments should be active and dedicated to release.
          for (int i=0; i<environments.size(); i++){
             LogicalEnvironment environment = (LogicalEnvironment)environments.get(i);
             if (environment.isActive() && environment.getRelease().equals(assembly.getRelease()))
                candidates.add(environment);
          }
          // Store informations into request attributes.
          request.setAttribute(AssemblyActions.ASSEMBLY_KEY, assembly);
          request.setAttribute(LogicalEnvironmentActions.ENVIRONMENTS_KEY, candidates);
       }
       // Forward after adding targets (we always need them).
       request.setAttribute(TargetActions.TARGETS_KEY, processManager.getTargets());
       return mapping.findForward("Form");
    }
 
    /**
     * Load a specified deployment into request attribute.
     * @return A forward to the next view to render and display
     */
    protected ActionForward loadDeployment(ActionMapping mapping, DeploymentForm form,
                                           HttpServletRequest request, HttpServletResponse response)
            throws Exception{
       // Get the requested deployment from manager.
       Deployment deployment = environmentManager.getDeployment(form.getId());
 
       // Store deployment within request before forwarding.
       request.setAttribute(DEPLOYMENT_KEY, deployment);
       return mapping.findForward("Deployment");
    }
 
    /**
     * Create a new deployment into environment manager.
     * @return A forward to the next view to render and display
     */
    protected ActionForward createDeployment(ActionMapping mapping, DeploymentForm form,
                                             HttpServletRequest request, HttpServletResponse response)
            throws Exception{
       // Retrieve related objects we need.
       Target target = processManager.getTarget(form.getTargetName());
       Assembly assembly = assemblyManager.getAssembly(form.getAssemblyKey());
       LogicalEnvironment environment = environmentManager.getLogicalEnvironment(form.getLogicalEnvKey());
 
       // Retrieve applicant identifier.
       String applicantId = getUserContainer(request).getView().getUser().getLogin();
 
       // Create a new deployment from form.
       Deployment deployment = new Deployment(applicantId, form.getApplicantComments(),
               environment.getActiveEnvironmentMapping(), assembly, target);
       if (form.getWishedDate() != null)
          deployment.setWishedDate(form.getWishedDate());
       log.info("Creation of a new deployment request for assembly '" + form.getAssemblyKey() + "' on "
               + "environment '" + form.getLogicalEnvKey() + "'");
 
       try {environmentManager.createDeployment(deployment);}
       catch (OperationNotAllowedException e){
          // Store exception within request.
          request.setAttribute(NOT_ALLOWED_OPERATION_KEY, CREATE_OP);
          request.setAttribute(NOT_ALLOWED_OPERATION_MSG, e.getMessage());
          return showDeploymentForm(mapping, form, request, response);
       }
 
       return getPreparingDeployments(mapping, form, request, response);
    }
 
    /**
     * Launch preparation of specified deployment
     * @return A forward to the next view to render and display
     */
    protected ActionForward prepareDeployment(ActionMapping mapping, DeploymentForm form,
                                              HttpServletRequest request, HttpServletResponse response)
            throws Exception{
       // Retrieve specified deployment and prepare it.
       Deployment deployment = environmentManager.getDeployment(form.getId());
       environmentManager.prepareDeployment(deployment);
       // Forward to preparing deployments.
       return getPreparingDeployments(mapping, form, request, response);
    }
 
    /**
     * Retrieve deployments being prepared at that time.
     * @return A forward to the next view to render and display
     */
    protected ActionForward getPreparingDeployments(ActionMapping mapping, DeploymentForm form,
                                                    HttpServletRequest request, HttpServletResponse response)
            throws Exception{
       // Retrieve deployments from manager.
       List deployments = environmentManager.getPreparingDeployments();
       // Store into request attribute before forwarding.
       request.setAttribute(DEPLOYMENTS_KEY, deployments);
       request.setAttribute(TITLE_KEY, "title.deployments.preparation");
       request.setAttribute(SCREEN_KEY, "preparation");
 
       return mapping.findForward("Deployments");
    }
 
    /**
     * Launch realization of specified deployment.
     * @return A forward to the next view to render and display
     */
    protected ActionForward realizeDeployment(ActionMapping mapping, DeploymentForm form,
                                              HttpServletRequest request, HttpServletResponse response)
            throws Exception{
       // Retrieve assignee id and specified deployment.
       String assigneeId = getUserContainer(request).getView().getUser().getLogin();
       Deployment deployment = environmentManager.getDeployment(form.getId());
       // Start realizing deployment if allowed.
       deployment.setAssigneeId(assigneeId);
       try {environmentManager.realizeDeployment(deployment);}
       catch (OperationNotAllowedException e){
          // Store exception within request.
          request.setAttribute(NOT_ALLOWED_OPERATION_KEY, CREATE_OP);
          request.setAttribute(NOT_ALLOWED_OPERATION_MSG, e.getMessage());
       }
       // Forward to realizing deployments.
       return getRealizingDeployments(mapping, form, request, response);
    }
 
    /**
     * Retrieve deployments being realized at that time.
     * @return A forward to the next view to render and display
     */
    protected ActionForward getRealizingDeployments(ActionMapping mapping, DeploymentForm form,
                                                    HttpServletRequest request, HttpServletResponse response)
            throws Exception{
       // Retrieve deployments from manager.
       List deployments = environmentManager.getRealizingDeployments();
       // Store into request attribute before forwarding.
       request.setAttribute(DEPLOYMENTS_KEY, deployments);
       request.setAttribute(TITLE_KEY, "title.deployments.realization");
       request.setAttribute(SCREEN_KEY, "realization");
 
       return mapping.findForward("Deployments");
    }
 
    /**
     * Cancel a specified deployment.
     * @return A forward to the next view to render and display
     */
    protected ActionForward cancelDeployment(ActionMapping mapping, DeploymentForm form,
                                             HttpServletRequest request, HttpServletResponse response)
            throws Exception{
       // First submission, get deployment and rediret to form.
       if (form.getAssigneeComments() == null || form.getAssigneeComments().length() == 0){
          request.setAttribute(DEPLOYMENT_KEY, environmentManager.getDeployment(form.getId()));
          return mapping.findForward("Form");
       }
       // Retrieve specified deployment.
       Deployment deployment = environmentManager.getDeployment(form.getId());
       environmentManager.cancelDeployment(deployment, form.getAssigneeComments());
 
       return getPreparingDeployments(mapping, form, request, response);
    }
 
    /**
     * End a specified deployment.
     * @return A forward to the next view to render and display
     */
    protected ActionForward endDeployment(ActionMapping mapping, DeploymentForm form,
                                          HttpServletRequest request, HttpServletResponse response)
            throws Exception{
       // First submission, get deployment and rediret to form.
       if (form.getAssigneeComments() == null || form.getAssigneeComments().length() == 0){
          request.setAttribute(DEPLOYMENT_KEY, environmentManager.getDeployment(form.getId()));
          return mapping.findForward("Form");
       }
       // Retrieve specified deployment.
       Deployment deployment = environmentManager.getDeployment(form.getId());
       environmentManager.endDeployment(deployment, form.getAssigneeComments());
 
       // Store logicalEnv into request, asking to refresh its view, before forwarding...
       request.setAttribute(LogicalEnvironmentActions.ENVIRONMENT_KEY,
               deployment.getEnvironmentMapping().getLogicalEnvironment());
       return mapping.findForward("Environments");
    }
 
    /**
     * Force the status of a given deployment. This is a 2 step operation : retrieve possible
     * status first and display a form ; then set the choosen status for deployment.
     * @return A forward to the next view to render and display
     */
    protected ActionForward forceStatus(ActionMapping mapping, DeploymentForm form,
                                             HttpServletRequest request, HttpServletResponse response)
            throws Exception{
       // If no status, forward to page.
       if (form.getStatusKey() == null){
          request.setAttribute("statusType", "deployment");
          request.setAttribute(DEPLOYMENT_KEY, environmentManager.getDeployment(form.getId()));
          // Build a list of possible status.
          ArrayList statusList = new ArrayList();
          statusList.addAll(processManager.getStatusForType(Status.DEPLOYMENT_PREPARATION_TYPE));
          statusList.addAll(processManager.getStatusForType(Status.DEPLOYMENT_REALIZATION_TYPE));
          request.setAttribute(StatusActions.STATUS_LIST_KEY, statusList);
          return mapping.findForward("Status");
       }
       // Find and set status to deployment.
       Status status = processManager.getStatus(form.getStatusKey());
       Deployment deployment = environmentManager.getDeployment(form.getId());
       deployment.setStatus(status);
       environmentManager.saveDeployment(deployment);
       // Forward to preparing deployments.
       return getPreparingDeployments(mapping, form, request, response);
    }
 }