package com.panogenesis.webapp.action;
   
   import java.text.NumberFormat;
   
   import java.util.ArrayList;
   import java.util.HashMap;
   import java.util.List;
   import java.util.Locale;
   import java.util.Map;
  
  import javax.servlet.http.HttpServletRequest;
  import javax.servlet.http.HttpServletResponse;
  
  import org.apache.commons.logging.Log;
  import org.apache.commons.logging.LogFactory;
  
  import com.panogenesis.Constants;
  import com.panogenesis.model.User;
  import com.panogenesis.service.MailEngine;
  import com.panogenesis.service.UserManager;
  
  import org.springframework.beans.propertyeditors.CustomNumberEditor;
  import org.springframework.mail.SimpleMailMessage;
  import org.springframework.validation.BindException;
  import org.springframework.web.bind.ServletRequestDataBinder;
  import org.springframework.web.multipart.support.ByteArrayMultipartFileEditor;
  import org.springframework.web.servlet.ModelAndView;
  import org.springframework.web.servlet.mvc.SimpleFormController;
  import org.springframework.web.servlet.view.RedirectView;
  
  /***
   * Implementation of <strong>SimpleFormController</strong> that contains
   * convenience methods for subclasses.  For example, getting the current
   * user and saving messages/errors. This class is intended to
   * be a base class for all Form controllers.
   *
   * <p><a href="BaseFormController.java.html"><i>View Source</i></a></p>
   *
   * @author <a href="mailto:matt@raibledesigns.com">Matt Raible</a>
   */
  public class BaseFormController extends SimpleFormController {
      protected final transient Log log = LogFactory.getLog(getClass());
      protected UserManager mgr = null;
      protected MailEngine mailEngine = null;
      protected SimpleMailMessage message = null;
      protected String templateName = null;
  
      public void setUserManager(UserManager userManager) {
          this.mgr = userManager;
      }
  
      public UserManager getUserManager() {
          return this.mgr;
      }
  
      public void saveMessage(HttpServletRequest request, String msg) {
          List messages = (List) request.getSession().getAttribute("messages");
  
          if (messages == null) {
              messages = new ArrayList();
          }
  
          messages.add(msg);
          request.getSession().setAttribute("messages", messages);
      }
  
      /***
       * Convenience method for getting a i18n key's value.  Calling
       * getMessageSourceAccessor() is used because the RequestContext variable
       * is not set in unit tests b/c there's no DispatchServlet Request.
       *
       * @param msgKey
       * @param locale the current locale
       * @return
       */
      public String getText(String msgKey, Locale locale) {
          return getMessageSourceAccessor().getMessage(msgKey, locale);
      }
  
      /***
       * Convenient method for getting a i18n key's value with a single
       * string argument.
       *
       * @param msgKey
       * @param arg
       * @param locale the current locale
       * @return
       */
      public String getText(String msgKey, String arg, Locale locale) {
          return getText(msgKey, new Object[] { arg }, locale);
      }
  
      /***
       * Convenience method for getting a i18n key's value with arguments.
       *
       * @param msgKey
       * @param args
       * @param locale the current locale
       * @return
      */
     public String getText(String msgKey, Object[] args, Locale locale) {
         return getMessageSourceAccessor().getMessage(msgKey, args, locale);
     }
 
     /***
      * Convenience method to get the user object from the session
      *
      * @param request the current request
      * @return the user's populated object from the session
      */
     protected User getUser(HttpServletRequest request) {
         return (User) request.getSession().getAttribute(Constants.USER_KEY);
     }
 
     /***
      * Convenience method to get the Configuration HashMap
      * from the servlet context.
      *
      * @return the user's populated form from the session
      */
     public Map getConfiguration() {
         Map config =
             (HashMap) getServletContext().getAttribute(Constants.CONFIG);
 
         // so unit tests don't puke when nothing's been set
         if (config == null) {
             return new HashMap();
         }
 
         return config;
     }
 
     /***
      * Default behavior for FormControllers - redirect to the successView
      * when the cancel button has been pressed.
      */
     public ModelAndView processFormSubmission(HttpServletRequest request,
                                               HttpServletResponse response,
                                               Object command,
                                               BindException errors)
     throws Exception {
         if (request.getParameter("cancel") != null) {
             return new ModelAndView(new RedirectView(getSuccessView()));
         }
 
         return super.processFormSubmission(request, response, command, errors);
     }
     
     /***
      * Set up a custom property editor for converting form inputs to real objects
      */
     protected void initBinder(HttpServletRequest request,
                               ServletRequestDataBinder binder) {
         NumberFormat nf = NumberFormat.getNumberInstance();
         binder.registerCustomEditor(Integer.class, null,
                                     new CustomNumberEditor(Integer.class, nf, true));
         binder.registerCustomEditor(Long.class, null,
                                     new CustomNumberEditor(Long.class, nf, true));
         binder.registerCustomEditor(byte[].class,
                                     new ByteArrayMultipartFileEditor());
     }
 
     /***
      * Convenience message to send messages to users, includes app URL as footer.
      * @param user
      * @param msg
      * @param url
      */
     protected void sendUserMessage(User user, String msg, String url) {
         if (log.isDebugEnabled()) {
             log.debug("sending e-mail to user [" + user.getEmail() + "]...");
         }
 
         message.setTo(user.getFullName() + "<" + user.getEmail() + ">");
 
         Map model = new HashMap();
         model.put("user", user);
 
         // TODO: once you figure out how to get the global resource bundle in
         // WebWork, then figure it out here too.  In the meantime, the Username
         // and Password labels are hard-coded into the template. 
         // model.put("bundle", getTexts());
         model.put("message", msg);
         model.put("applicationURL", url);
         mailEngine.sendMessage(message, templateName, model);
     }
 
     public void setMailEngine(MailEngine mailEngine) {
         this.mailEngine = mailEngine;
     }
 
     public void setMessage(SimpleMailMessage message) {
         this.message = message;
     }
 
     public void setTemplateName(String templateName) {
         this.templateName = templateName;
     }
 }