/**
    * 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.DeliverableForm;
  import org.figure8.join.core.DuplicateEntityException;
  import org.figure8.join.businessobjects.commons.Release;
  import org.figure8.join.businessobjects.artifact.Deliverable;
  import org.figure8.join.businessobjects.artifact.DeliverableType;
  import org.figure8.join.businessfacades.artifact.ArtifactManager;
  import org.figure8.join.businessfacades.commons.IntegrationProcessManager;
  import org.figure8.join.util.LogUtil;
  
  import org.apache.commons.logging.Log;
  import org.apache.commons.beanutils.PropertyUtils;
  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 javax.servlet.http.HttpSession;
  import java.util.List;
  /**
   * This is a Struts action for managing all the deliverables within Join.
   * @author <a href="mailto:laurent.broudoux@free.fr">Laurent Broudoux</a>
   * @version $Revision: 1.2 $
   *
   * @struts.action path="/deliverable" name="deliverableForm"
   *                scope="request" parameter="op" validate="true"
   *                input="/pages/mainpage.jsp?body=/jsp/artifact/delivery.jsp"
   * @struts.action-forward name="Delivery" path="/jsp/artifact/delivery.jsp"
   * @struts.action-forward name="Deliverable" path="/jsp/artifact/deliverable.jsp"
   * @struts.action-forward name="Deliverables" path="/jsp/artifact/deliverables.jsp"
   */
  public class DeliverableActions extends JoinAction{
  
     // Static -------------------------------------------------------------------
  
     /** Get a commons logger. */
     private static final Log log = LogUtil.getLog(DeliverableActions.class);
  
     /** Operation code for loading a specific Deliverable */
     public static final String LOAD_OP = "load";
     /** Operation code fo showing the delivery form */
     public static final String FORM_OP = "form";
     /** Operation code for saving a Deliverable */
     public static final String SAVE_OP = "save";
     /** Operation code for creating a new Deliverable */
     public static final String CREATE_OP = "create";
     /** Operation code for searching deliverables using type and release */
     public static final String SEARCH_OP = "search";
     /** Operation code for getting details on a specific Deliverable */
     public static final String DETAILS_OP = "details";
  
     /**
      * The session scope attribute under which the Deliverable object currently
      * selected by our logged-in User is stored.
      */
     public static final String DELIVERABLE_KEY = "deliverable";
     /**
      * The request scope attribute under which the retrivied deliverables
      * list is stored.
      */
     public static final String DELIVERABLES_KEY = "deliverables";
  
     /**
      * The request scope attribute under which is stored the Deliverable that
      * has raised a DuplicateEntityException during save of another one.
      */
     public static final String DUPLICATE_DELIVERABLE_KEY = "duplicate";
  
  
     // Attributes ---------------------------------------------------------------
  
     /** The artifact manager implementation to use. */
     protected ArtifactManager artifactManager = null;
     /** The integration process manager implementation to use. */
     protected IntegrationProcessManager processManager = null;
  
  
     // Constructors -------------------------------------------------------------
  
     /** Creates a new instance of DeliverableActions. */
     public DeliverableActions(){
     }
 
 
    // Public -------------------------------------------------------------------
 
    /** @param manager The ArtifactManager implementation to use */
    public void setArtifactManager(ArtifactManager manager){
       this.artifactManager = manager;
    }
    /** @param manager The integration process manager implementation to use */
    public void setIntegrationProcessManager(IntegrationProcessManager manager){
       this.processManager = manager;
    }
 
 
    // 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 (LOAD_OP.equals(operation)){
          return loadDeliverable(mapping, form, request, response);
       }
       else if (FORM_OP.equals(operation)){
          return showDeliverableForm(mapping, form, request, response);
       }
       else if (SAVE_OP.equals(operation)){
          return saveDeliverable(mapping, form, request, response);
       }
       else if (CREATE_OP.equals(operation)){
          return createDeliverable(mapping, form, request, response);
       }
       else if (SEARCH_OP.equals(operation)){
          return searchDeliverables(mapping, form, request, response);
       }
       else if (DETAILS_OP.equals(operation)){
          return getDeliverableDetails(mapping, form, request, response);
       }
       else{
          // Default : deliverables browsing page.
          request.getSession().removeAttribute(DELIVERABLE_KEY);
          return mapping.findForward("Deliverables");
       }
    }
 
 
    // Protected ----------------------------------------------------------------
 
    /**
     * Load a specified deliverable from datastore and fill form with it.
     * @return A forward to the next view to render and display
     */
    protected ActionForward loadDeliverable(ActionMapping mapping, ActionForm form,
                                            HttpServletRequest request, HttpServletResponse response) throws Exception{
       if (form instanceof DeliverableForm){
          // Get the requested deliverable from manager
          DeliverableForm dForm = (DeliverableForm)form;
          Deliverable deliverable = artifactManager.getDeliverable(dForm.getKey());
 
          // Store deliverable within session.
          HttpSession session = request.getSession();
          session.setAttribute(DELIVERABLE_KEY, deliverable);
          // Copy deliverable into the form properties.
          PropertyUtils.copyProperties(dForm, deliverable);
          // Add the release name and type as form properties.
          dForm.setReleaseName(deliverable.getRelease().getName());
          dForm.setTypeKey(deliverable.getDeliverableType().getKey());
 
          return mapping.findForward("Delivery");
       }
       // This should not happen...
       return null;
    }
 
    /**
     * Prepare all we need for displaying a delivery form
     * @return A forward to the next view to render and display
     */
    protected ActionForward showDeliverableForm(ActionMapping mapping, ActionForm form,
                                                HttpServletRequest request, HttpServletResponse response)
            throws Exception{
       if (form instanceof DeliverableForm){
          DeliverableForm dForm = (DeliverableForm)form;
 
          // Retrieve the type for delivery and the latest deliverables ...
          DeliverableType type = artifactManager.getDeliverableType(dForm.getTypeKey());
          List deliverables = artifactManager.getLastDeliverables(type, 10);
          // Put them into request attributes.
          request.setAttribute(DELIVERABLES_KEY, deliverables);
          request.setAttribute(DeliverableTypeActions.DELIVERABLE_TYPE_KEY, type);
 
          return mapping.findForward("Delivery");
       }
       // This should not happen...
       return null;
    }
 
    /**
     * Update a deliverable informations into datastore.
     * @return A forward to the next view to render and display
     */
    protected ActionForward saveDeliverable(ActionMapping mapping, ActionForm form,
                                            HttpServletRequest request, HttpServletResponse response) throws Exception{
       if (form instanceof DeliverableForm){
          DeliverableForm dForm = (DeliverableForm)form;
 
          // Is there a deliverable to update in session ?
          HttpSession session = request.getSession();
          Deliverable deliverable = (Deliverable)session.getAttribute(DELIVERABLE_KEY);
 
          if (deliverable != null){
             log.info("Update of existing Deliverable having key: " + deliverable.getKey());
             PropertyUtils.copyProperties(deliverable, dForm);
             // Save deliverable using manager and display details.
             artifactManager.saveDeliverable(deliverable);
             return getDeliverableDetails(mapping, form, request, response);
          }
 
          // Forward to deliverables page.
          return searchDeliverables(mapping, form, request, response);
       }
       // This should not happen...
       return null;
    }
 
    /**
     * Create and register a new Deliverable within Join application. No deliverable
     * of this type, for this release and having this version info should aready exists.
     * @return A forward to the next view to render and display
     */
    protected ActionForward createDeliverable(ActionMapping mapping, ActionForm form,
                                              HttpServletRequest request, HttpServletResponse response) throws Exception{
       if (form instanceof DeliverableForm){
          DeliverableForm dForm = (DeliverableForm)form;
 
          // Retrieve the release and type of deliverable to create.
          Release release = processManager.getRelease(dForm.getReleaseName());
          DeliverableType type = artifactManager.getDeliverableType(dForm.getTypeKey());
          String supplierId = getUserContainer(request).getView().getUser().getLogin();
 
          // Create deliverable and register it using manager.
          Deliverable deliverable = new Deliverable(dForm.getVersionInfo(), dForm.getComments(),
                                                       supplierId, release, type);
          log.info("Creation of a new Deliverable with key: " + deliverable.getKey());
 
          try {artifactManager.registerDeliverable(deliverable, dForm.getDeliverableFile().getInputStream());}
          catch (DuplicateEntityException dee){
             // Store exception within request.
             request.setAttribute(DUPLICATE_DELIVERABLE_KEY, dee.getOriginalEntity());
             return mapping.findForward("Delivery");
          }
 
          // Forward to list of deliverables.
          return searchDeliverables(mapping, form, request, response);
       }
       // This should not happen...
       return null;
    }
 
    /**
     * Serch all the deliverables using the type and the bound release criteria.
     * @return A forward to the next view to render and display
     */
    protected ActionForward searchDeliverables(ActionMapping mapping, ActionForm form,
                                               HttpServletRequest request, HttpServletResponse response)
            throws Exception{
       if (form instanceof DeliverableForm){
          // Get the deliverable form.
          DeliverableForm dForm = (DeliverableForm)form;
 
          // Retrieve the release and type of deliverables to search for.
          Release release = processManager.getRelease(dForm.getReleaseName());
          DeliverableType type = artifactManager.getDeliverableType(dForm.getTypeKey());
 
          // Retrieve the list and put it into request attribute.
          List deliverables = artifactManager.getDeliverables(type, release);
          request.setAttribute(DELIVERABLES_KEY, deliverables);
          request.setAttribute(ReleaseActions.RELEASE_KEY, release);
          request.setAttribute(DeliverableTypeActions.DELIVERABLE_TYPE_KEY, type);
 
          return mapping.findForward("Deliverables");
       }
       // This should not happen...
       return null;
    }
 
    /**
     * Get all the details onto an existing Deliverable.
     * @return A forward to the next view to render and display
     */
    protected ActionForward getDeliverableDetails(ActionMapping mapping, ActionForm form,
                                                  HttpServletRequest request, HttpServletResponse response)
            throws Exception{
       if (form instanceof DeliverableForm){
          // Get the requested deliverable from manager
          DeliverableForm dForm = (DeliverableForm)form;
          Deliverable deliverable = artifactManager.getDeliverable(dForm.getKey());
 
          // Store deliverable within request.
          request.setAttribute(DELIVERABLE_KEY, deliverable);
          // Copy deliverable into the form properties.
          PropertyUtils.copyProperties(dForm, deliverable);
          // Add the release name and type as form properties.
          dForm.setReleaseName(deliverable.getRelease().getName());
          dForm.setTypeKey(deliverable.getDeliverableType().getKey());
 
          return mapping.findForward("Deliverable");
       }
       // This should not happen...
       return null;
    }
 }