/**
    * 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.MachineForm;
  import org.figure8.join.core.DuplicateEntityException;
  import org.figure8.join.businessobjects.environment.Machine;
  import org.figure8.join.businessfacades.environment.ResourceManager;
  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 the physical machines used by software
   * project integration team.
   * @author <a href="mailto:laurent.broudoux@free.fr">Laurent Broudoux</a>
   * @version $Revision: 1.1 $
   *
   * @struts.action path="/machine" name="machineForm"
   *                scope="request" parameter="op" validate="true"
   *                input="/pages/mainpage.jsp?body=/jsp/environment/machines.jsp"
   * @struts.action-forward name="Machine" path="/jsp/environment/machine.jsp"
   * @struts.action-forward name="Machines" path="/jsp/environment/machines.jsp"
   */
  public class MachineActions extends JoinAction{
  
     // Static -------------------------------------------------------------------
  
     /** Get a commons logger. */
     protected static Log log = LogUtil.getLog(MachineActions.class);
  
     /** Operation code for loading a specific Machine */
     public static final String LOAD_OP = "load";
     /** Operation code for saving a Machine (create or update) */
     public static final String SAVE_OP = "save";
     /** Operation code for getting details on a Machine */
     public static final String DETAILS_OP = "details";
  
     /**
      * The session scope attribute under which the Machine object currently
      * selected by our logged-in User is stored.
      */
     public static final String MACHINE_KEY = "machine";
     /**
      * The request scope attribute under which the retrieved Machines
      * list is stored.
      */
     public static final String MACHINES_KEY = "machines";
     /**
      * The request scope attribute under which is stored the Machine that
      * has raised a DuplicateEntityException during save of another one.
      */
     public static final String DUPLICATE_MACHINE_KEY = "duplicate";
  
  
     // Attributes ---------------------------------------------------------------
  
     /** The ResourceManager to use */
     private ResourceManager resourceManager = null;
  
  
     // Constructors -------------------------------------------------------------
  
     /** Creates a new instance of MachineActions. */
     public MachineActions(){
     }
  
  
     // Public -------------------------------------------------------------------
  
     /** @param manager The ResourceManager to use */
     public void setResourceManager(ResourceManager manager){
        this.resourceManager = manager;
     }
  
  
     // Override 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 loadMachine(mapping, form, request, response);
       }
       else if (SAVE_OP.equals(operation)){
          return saveMachine(mapping, form, request, response);
       }
       else if (DETAILS_OP.equals(operation)){
          return getMachineDetails(mapping, form, request, response);
       }
       else{
          // Default : empty step management page.
          request.getSession().removeAttribute(MACHINE_KEY);
          request.setAttribute(MACHINES_KEY, resourceManager.getMachines());
          return mapping.findForward("Machines");
       }
    }
 
 
    // Protected ----------------------------------------------------------------
 
    /**
     * Load a specified machine from datastore and fill form with it.
     * @return A forward to the next view to render and display
     */
    protected ActionForward loadMachine(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response)
       throws Exception{
 
       if (form instanceof MachineForm){
          // Get the request machine from manager.
          MachineForm mForm = (MachineForm)form;
          Machine machine = resourceManager.getMachine(mForm.getId());
 
          // Store machine within session.
          HttpSession session = request.getSession();
          session.setAttribute(MACHINE_KEY, machine);
          // Copy machine into the form properties.
          PropertyUtils.copyProperties(mForm, machine);
 
          // Add machines list to request before forwarding.
          request.setAttribute(MACHINES_KEY, resourceManager.getMachines());
          return mapping.findForward("Machines");
       }
       // This should not happen...
       return null;
    }
 
    /**
     * Save a machine into datastore. The Machine 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 saveMachine(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response)
       throws Exception{
 
       if (form instanceof MachineForm){
          MachineForm mForm = (MachineForm)form;
 
          // Is there a machine to update in session ?
          HttpSession session = request.getSession();
          Machine machine = (Machine)session.getAttribute(MACHINE_KEY);
 
          if (machine == null){
             log.info("Creation of a new Machine with name: " + mForm.getName());
             machine = new Machine(mForm.getName(), mForm.getIpAddress());
             if (mForm.getOsInfo() != null) machine.setOsInfo(mForm.getOsInfo());
             if (mForm.getCpuInfo() != null) machine.setCpuInfo(mForm.getCpuInfo());
             if (mForm.getRamAmount() != -1) machine.setRamAmount(mForm.getRamAmount());
             if (mForm.getRomAmount() != -1) machine.setRomAmount(mForm.getRomAmount());
          }
          else{
             log.info("Update of existing Machine having name: " + machine.getName());
             PropertyUtils.copyProperties(machine, mForm);
          }
          // Save machine using manager.
          try {resourceManager.saveMachine(machine);}
          catch (DuplicateEntityException dee){
 
             return mapping.findForward("Machines");
          }
 
          // Remove form and session attribute if present.
          session.removeAttribute(MACHINE_KEY);
          removeObsoleteForm(mapping, request);
 
          // Add machines list to request before forwarding.
          request.setAttribute(MACHINES_KEY, resourceManager.getMachines());
          return mapping.findForward("Machines");
       }
       // This should not happen...
       return null;
    }
 
    /**
     * Retrieve the details onto a specified machine.
     * @return A forward to the next view to render and display
     */
    protected ActionForward getMachineDetails(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response)
       throws Exception{
 
       if (form instanceof MachineForm){
          // Get the requested machine.
          MachineForm mForm = (MachineForm)form;
          Machine machine = resourceManager.getMachine(mForm.getId());
 
          // Add machine to request before forwarding.
          request.setAttribute(MACHINE_KEY, machine);
          return mapping.findForward("Machine");
       }
       // This should not happen...
       return null;
    }
 }