/**
    * 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.DeliverableTypeForm;
  import org.figure8.join.businessobjects.artifact.DeliverableType;
  import org.figure8.join.businessfacades.artifact.ArtifactManager;
  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.HttpSession;
  import javax.servlet.http.HttpServletRequest;
  import javax.servlet.http.HttpServletResponse;
  /**
   * Struts action used for managing Deliverable categories (types) within Join application
   * @author <a href="mailto:laurent.broudoux@free.fr">Laurent Broudoux</a>
   * @version $Revision: 1.1 $
   *
   * @struts.action path="/deliverableType" name="deliverableTypeForm"
   *                scope="request" parameter="op" validate="true"
   *                input="/pages/mainpage.jsp?body=/jsp/deliverabletypes.jsp"
   * @struts.action-forward name="DeliverableTypes" path="/jsp/deliverabletypes.jsp"
   */
  public class DeliverableTypeActions extends JoinAction{
  
     // Static -------------------------------------------------------------------
  
     /** Get a commons logger. */
     private static final Log log = LogUtil.getLog(DeliverableTypeActions.class);
  
     /** Operation code for loading a specific DeliverableType */
     public static final String LOAD_OP = "load";
     /** Operation code for saving a DeliverableType (create or update) */
     public static final String SAVE_OP = "save";
  
     /**
      * The session scope attribute under which the DeliverableType object currently
      * selected by our logged-in User is stored.
      */
     public static final String DELIVERABLE_TYPE_KEY = "deliverableType";
  
  
     // Attributes ---------------------------------------------------------------
  
     /** Join artifact manager instance. */
     protected ArtifactManager artifactManager;
  
  
     // Constructors -------------------------------------------------------------
  
     /** Creates a new instance of DeliverableTypeActions. */
     public DeliverableTypeActions(){
     }
  
  
     // Public -------------------------------------------------------------------
  
     /** @param manager <code>ArtifactManager</code> implementation instance */
     public void setArtifactManager(ArtifactManager manager){
        this.artifactManager = 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
      */
     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 loadDeliverableType(mapping, form, request, response);
        }
       else if (SAVE_OP.equals(operation)){
          return saveDeliverableType(mapping, form, request, response);
       }
       else{
          // Default : empty step management page.
          request.getSession().removeAttribute(DELIVERABLE_TYPE_KEY);
          return mapping.findForward("DeliverableTypes");
       }
    }
 
 
    // Protected ----------------------------------------------------------------
 
    /**
     * Load a specified deliverable type from datastore and fill form with it.
     * @return A forward to the next view to render and display
     */
    protected ActionForward loadDeliverableType(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response)
          throws Exception{
 
       if (form instanceof DeliverableTypeForm){
          // Get the requested deliverable type from manager.
          DeliverableTypeForm tForm = (DeliverableTypeForm)form;
          DeliverableType type = artifactManager.getDeliverableType(tForm.getKey());
 
          // Store type within session.
          HttpSession session = request.getSession();
          session.setAttribute(DELIVERABLE_TYPE_KEY, type);
          // Copy into form the step properties.
          PropertyUtils.copyProperties(tForm, type);
 
          // Forward.
          return mapping.findForward("DeliverableTypes");
       }
       // This should not happen...
       return null;
    }
 
    /**
     * Save a deliverable type into datastore. The type may be an already existing one or a
     * new one (this is indeed a create or update method).
     * @return A forward to the next view to render and display
     */
    protected ActionForward saveDeliverableType(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response)
          throws Exception{
 
       if (form instanceof DeliverableTypeForm){
          // Get the step form.
          DeliverableTypeForm tForm = (DeliverableTypeForm)form;
 
          // Is there's a type to update in session ?
          HttpSession session = request.getSession();
          DeliverableType type = (DeliverableType)session.getAttribute(DELIVERABLE_TYPE_KEY);
 
          // Create a new deliverable type or populate existing with form.
          if (type == null){
             log.info("Creation of a new DeliverableType with key: " + tForm.getKey());
             type = new DeliverableType(tForm.getKey(), tForm.getLabel(),
                     tForm.getKeyTemplate(), tForm.isVersionable(), tForm.isMandatory());
             // Set the VCS properties if required.
             if (tForm.isVcsDeliverable()){
                type.setVcsDeliverable(true);
                type.setVcsUser(tForm.getVcsUser());
                type.setVcsPassword(tForm.getVcsPassword());
                type.setVcsRoot(tForm.getVcsRoot());
                type.setVcsModule(tForm.getVcsModule());
                type.setVcsAccessorClass(tForm.getVcsAccessorClass());
             }
          }
          else{
             log.info("Update of existing DeliverableType having key: " + type.getKey());
             PropertyUtils.copyProperties(type, tForm);
          }
          // Save type using manager.
          artifactManager.saveDeliverableType(type);
 
          // Remove form and session attribute if present.
          session.removeAttribute(DELIVERABLE_TYPE_KEY);
          removeObsoleteForm(mapping, request);
 
          // Forward.
          return mapping.findForward("DeliverableTypes");
       }
       // This should not happen...
       return null;
    }
 }