/**
    * 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.UserForm;
  import org.figure8.join.businessobjects.security.User;
  import org.figure8.join.businessfacades.security.UserManager;
  import org.figure8.join.businessfacades.artifact.ArtifactManager;
  import org.figure8.join.businessfacades.artifact.AssemblyManager;
  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;
  
  import java.util.List;
  /**
   * Struts action used for managing Users within Join application
   * @author <a href="mailto:laurent.broudoux@free.fr">Laurent Broudoux</a>
   * @version $Revision: 1.2 $
   *
   * @struts.action path="/user" name="userForm"
   *                scope="request" parameter="op" validate="true"
   *                input="/pages/mainpage.jsp?body=/jsp/user/useraccount.jsp"
   * @struts.action-forward name="Users" path="/jsp/user/users.jsp"
   * @struts.action-forward name="Account" path="/jsp/user/useraccount.jsp"
   * @struts.action-forward name="Details" path="/jsp/user/userdetails.jsp"
   */
  public class UserActions extends JoinAction{
  
     // Static -------------------------------------------------------------------
  
     /** Get a commons logger. */
     private static final Log log = LogUtil.getLog(UserActions.class);
  
     /** Operation code for loading a specific User */
     public static final String LOAD_OP = "load";
     /** Operation code for saving a specific User */
     public static final String SAVE_OP = "save";
     /** Operation code for searching users using lastname */
     public static final String SEARCH_OP = "search";
     /** Operation code for getting details on a specific User */
     public static final String DETAILS_OP = "details";
  
     /**
      * The session scope attribute under which the User object currently
      * selected or created by our logged-in User is stored.
      */
     public static final String USER_KEY = "user";
     /**
      * The request scope attribute under which the retrieved Users
      * list is stored.
      */
     public static final String USERS_KEY = "users";
  
  
     // Attributes ---------------------------------------------------------------
  
     /** A Join User manager instance */
     protected UserManager userManager = null;
     /** The artifact manager implementation to use. */
     protected ArtifactManager artifactManager = null;
     /** The assembly manager implementation to use. */
     protected AssemblyManager assemblyManager = null;
  
  
     // Constructors -------------------------------------------------------------
  
     /** Creates a new instance of UserActions. */
     public UserActions(){
     }
  
  
     // Public -------------------------------------------------------------------
  
     /** @param manager <code>UserManager</code> implementation instance */
     public void setUserManager(UserManager manager){
        this.userManager = manager;
     }
     /** @param manager The ArtifactManager implementation to use */
    public void setArtifactManager(ArtifactManager manager){
       this.artifactManager = manager;
    }
    /** @param manager The AssemblyManager implementation to use */
    public void setAssemblyManager(AssemblyManager manager){
       this.assemblyManager = 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 loadUser(mapping, form, request, response);
       }
       else if (SAVE_OP.equals(operation)){
          return saveUser(mapping, form, request, response);
       }
       else if (SEARCH_OP.equals(operation)){
          return searchUsers(mapping, form, request, response);
       }
       else if (DETAILS_OP.equals(operation)){
          return getUserDetails(mapping, form, request, response);
       }
       else{
          // Default : empty user management page.
          request.getSession().removeAttribute(USER_KEY);
          return mapping.findForward("Users");
       }
    }
 
 
    // Protected ----------------------------------------------------------------
 
    /**
     * Load a specified user from datastore and fill form with it.
     * @return A forward to the next view to render and display
     */
    protected ActionForward loadUser(ActionMapping mapping, ActionForm form,
                                     HttpServletRequest request, HttpServletResponse response) throws Exception{
       if (form instanceof UserForm){
          // Get the request user from manager or session.
          User user = null;
          UserForm uForm = (UserForm)form;
 
          if (uForm.getLogin() == null && isLoggedIn(request))
             user = getUserContainer(request).getView().getUser();
          else
             user = userManager.getUser(uForm.getLogin());
 
          // Store user within session.
          HttpSession session = request.getSession();
          session.setAttribute(USER_KEY, user);
          // Copy form into the user properties.
          PropertyUtils.copyProperties(uForm, user);
 
          // Forward.
          return mapping.findForward("Account");
       }
       // This should not happen...
       return null;
    }
 
    /**
     * Save an updated and existing user from datastore. User should have been loaded
     * before and the present into the {@link USER_KEY} session attribute.
     * @return A forward to the next view to render and display
     */
    protected ActionForward saveUser(ActionMapping mapping, ActionForm form,
                                     HttpServletRequest request, HttpServletResponse response) throws Exception{
       if (form instanceof UserForm){
          // Get the user form.
          UserForm uForm = (UserForm)form;
 
          // Retrieve also User from session.
          HttpSession session = request.getSession();
          User user = (User)session.getAttribute(USER_KEY);
 
          // Populate user with modified form before saving.
          if (user != null){
             log.info("Update of existing User having login: " + uForm.getLogin());
             // We have to backup id to not lose it when copying properties.
             // This is due to the public setId(long) of User object...
             long backupId = user.getId();
             PropertyUtils.copyProperties(user, uForm);
             user.setId(backupId);
             // Save it.
             userManager.saveUser(user);
          }
 
          // Forward.
          return mapping.findForward("Account");
       }
       // This should not happen...
       return null;
    }
 
    /**
     * Retrieve a list of Users using the lastname criterion. This lastname information
     * is retrieved : from User present in session under {@link USER_KEY} attribute if
     * present of from the UserForm supplied with request. The research is done using
     * the <code>getUsers()</code> method of {@link UserManager}.
     * @return A forward to the next view to render and display
     */
    protected ActionForward searchUsers(ActionMapping mapping, ActionForm form,
                                        HttpServletRequest request, HttpServletResponse response) throws Exception{
       if (form instanceof UserForm){
          String criterion = null;
 
          // Look if User is defined in session.
          HttpSession session = request.getSession();
          User user = (User)session.getAttribute(USER_KEY);
 
          if (user != null)
             criterion = user.getLastname();
          else
             criterion = ((UserForm)form).getLastname();
 
          // Retrieve list and put into request attribute.
          List users = userManager.getUsers(criterion);
          request.setAttribute(USERS_KEY, users);
 
          // Forward after having cleaned the session.
          request.getSession().removeAttribute(USER_KEY);
          return mapping.findForward("Users");
       }
       // This should not happen...
       return null;
    }
 
    /**
     * Get a user details such has its informations and artifacts it has delivered, build, etc...
     * @return A forward to the next view to render and display
     */
    protected ActionForward getUserDetails(ActionMapping mapping, ActionForm form,
                                           HttpServletRequest request, HttpServletResponse response) throws Exception{
       if (form instanceof UserForm){
          // Get the user form.
          UserForm uForm = (UserForm)form;
 
          request.setAttribute(USER_KEY, userManager.getUser(uForm.getLogin()));
          // TODO : complete interfaces of manager for having following methods.
          // request.setAttribute(DeliverableActions.DELIVERABLES_KEY, artifactManager.getDeliverablesSuppliedByUser(uForm.getLogin())));
          // request.setAttribute(AssemblyActions.ASSEMBLIES_KEY, assemblyManager.getAssembliesComposedByUser(uForm.getLogin())));
          // request.setAttribute(BuildActions.BUILDS_KEY, assemblyManager.getBuildsComposedByUser(uForm.getLogin()));
 
          return mapping.findForward("Details");
       }
       // This should not happen...
       return null;
    }
 }