/***
    Copyright (C) 2005 The Java Community
   
    This program is free software; you can redistribute it and/or modify  it under
    the terms of the GNU General Public License as published by  the Free Software
    Foundation; either version 2 of the License, or  (at your option) any later
    version.
   
    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.
  
   You should have received a copy of the GNU General Public License  along with
   this program; if not, write to the Free Software  Foundation, Inc., 59 Temple
   Place, Suite 330, Boston, MA 02111-1307 USA.
  
   */
  
  package org.bejug.javacareers.jobs.view.jsf.action;
  
  import java.text.SimpleDateFormat;
  import java.util.Date;
  
  import javax.servlet.http.HttpServletRequest;
  import javax.servlet.http.HttpSession;
  
  import org.apache.commons.logging.Log;
  import org.apache.commons.logging.LogFactory;
  import org.apache.xerces.impl.dv.util.Base64;
  import org.bejug.javacareers.common.search.SearchCriteriaFactory;
  import org.bejug.javacareers.common.search.SearchCriteriaService;
  import org.bejug.javacareers.jobs.view.jsf.util.Utils;
  
  
  /***
   * @author Peter Symoens (last modified by $Author: shally $)
   * @version $Revision: 1.16 $ - $Date: 2005/12/20 15:36:47 $
   */
  public class BaseAction {
  
      /***
       * The Job CommentAction logger.
       */
      private static final Log LOG = LogFactory.getLog(BaseAction.class);
  
  
      /***
       * Variable that holds the transaction token to be set on the HttpSession
       */
      public static final String TRANSACTION_TOKEN_KEY = "TRANSACTION_TOKEN_KEY";
  
      /***
       * Variable that holds the transaction token to be set on the HttpServletRequest
       */
      public static final String TOKEN_KEY = "TOKEN_KEY";
  
  
      /***
       * The navigation rule
       */
      protected String outcome;
  
      /***
       * The transaction token
       */
      protected String token;
  
  
      /***
       * the factory for the searchCriteria.
       */
      protected SearchCriteriaFactory searchCriteriaFactory;
  
      /***
       * search service to use.
       */
      protected SearchCriteriaService searchCriteriaService;
  
      /***
       * Save the transaction token on the HttpSession
       */
      protected void saveToken() {
          //LOG.info("Debug: saveToken called");
          HttpSession httpSession = Utils.getSession();
          token = generateToken();
          httpSession.setAttribute(TRANSACTION_TOKEN_KEY, token);
      }
  
  
      /***
       * @return the generated token based on the HttpSession id and current time.
       */
      public String generateToken() {
          String generatedtoken = Utils.getSession().getId();
          SimpleDateFormat dateFormat = new SimpleDateFormat("yyMMddHHmmssS");
          generatedtoken = generatedtoken.concat(dateFormat.format(new Date()));
          generatedtoken = Base64.encode(generatedtoken.getBytes());
          int index = generatedtoken.indexOf("\n");
          if(index != -1){
         //delete the carriage return generated by the encoder at the end of the string ?!.
         generatedtoken = generatedtoken.substring(0, index);
         }
         HttpServletRequest request = (HttpServletRequest) Utils.getExternalContext().getRequest();
         request.setAttribute(BaseAction.TOKEN_KEY, generatedtoken);
         return generatedtoken;
     }
 
     /***
      *
      * @return  true if the transaction token key equals the token key.
      */
     public boolean isTokenValid() {
         HttpSession session = Utils.getSession();
         if (session == null) {
             return false;
         }
         String savedToken = (String) session.getAttribute(BaseAction.TRANSACTION_TOKEN_KEY);
         if (savedToken == null) {
             return false;
         }
         HttpServletRequest request = (HttpServletRequest) Utils.getExternalContext().getRequest();
         String transactionToken = request.getParameter(BaseAction.TOKEN_KEY);
         //LOG.info("Debug: savedToken= " + savedToken);
         //LOG.info("Debug: transactionToken= " + transactionToken);
         if (transactionToken == null) {
             return false;
         }
         return (savedToken.equals(transactionToken));
     }
 
 
     /***
      * @return outcome String
      */
     public String doOutcome() {
         LOG.info("Debug: FORWARDING to " + outcome);
         return outcome;
     }
 
     /***
      *
      * @return searchCriteriaFactory
      */
 	public SearchCriteriaFactory getSearchCriteriaFactory() {
 		return searchCriteriaFactory;
 	}
 
 	/***
 	 *
 	 * @param searchCriteriaFactory .
 	 */
 	public void setSearchCriteriaFactory(SearchCriteriaFactory searchCriteriaFactory) {
 		this.searchCriteriaFactory = searchCriteriaFactory;
 	}
 
     /***
      *
      * @return searchCriteriaService
      */
     public SearchCriteriaService getSearchCriteriaService() {
         return searchCriteriaService;
     }
 
 	/***
 	 *
 	 * @param searchCriteriaService .
 	 */
     public void setSearchCriteriaService(SearchCriteriaService searchCriteriaService) {
         this.searchCriteriaService = searchCriteriaService;
     }
     
     /***
     *
     * @return token
     */
    public String getToken() {
 	   HttpServletRequest request = (HttpServletRequest) Utils.getExternalContext().getRequest();
 	   String keytoken = (String)request.getAttribute(TOKEN_KEY);
        return keytoken;
    }
 
 }
 
 /***
  * $Log: BaseAction.java,v $
  * Revision 1.16  2005/12/20 15:36:47  shally
  * CheckStyle and PMD changes.
  *
  * Revision 1.15  2005/12/08 14:53:46  shally
  * Opkuis voor checkstyle.
  *
  * Revision 1.14  2005/09/30 14:38:07  bavo_jcs
  * Fixed URL
  *
  * Revision 1.13  2005/09/20 15:09:29  schauwvliege
  * Admin approved content V1
  *
  * Revision 1.12  2005/08/30 13:07:47  psong09
  * renamed author: psong09
  *
  * Revision 1.11  2005/08/24 12:32:12  psong09
  * Added spinner component and renamed commentAction
  *
  * Revision 1.10  2005/08/23 10:18:47  bme_jcs
  * resolved checkstyle and pmd errors
  *
  * Revision 1.9  2005/08/23 08:50:38  ge0ffrey
  * JAVACAREERS-284 part 3: resolver
  *
  * Revision 1.8  2005/08/22 15:25:05  ge0ffrey
  * JAVACAREERS-284
  *
  * Revision 1.7  2005/08/22 13:38:34  psong09
  * Added error page for synchronisation error
  *
  * Revision 1.6  2005/08/19 13:13:53  psong09
  * introduced synchroniser token
  *
  * Revision 1.5  2005/08/10 09:04:49  bavo_jcs
  * Optimized imports according to checkstyle
  *
  * Revision 1.4  2005/08/09 12:59:56  bavo_jcs
  * Optimized imports
  *
  * Revision 1.3  2005/06/14 12:05:53  schauwvliege
  * CheckStyle and fixing tests
  *
  * Revision 1.2  2005/06/09 08:18:52  bejug_cc
  * Fix initial import
  *
  * Revision 1.8  2005/06/07 15:16:46  PSONG09
  * added todo
  *
  * Revision 1.7  2005/06/03 15:40:10  PSONG09
  * removed import
  *
  * Revision 1.6  2005/06/02 15:48:36  PSONG09
  * added searchcriteria
  *
  * Revision 1.5  2005/05/19 13:55:24  PSONG09
  * update resume component + refactoring cv to resume
  *
  * Revision 1.4  2005/05/17 15:39:05  PSONG09
  * update jobsearch functionality
  *
  * Revision 1.3  2005/05/09 14:54:45  ssc
  * checkstyle
  *
  * Revision 1.2  2005/04/29 18:17:34  sja
  * General cleanup (naming conv., javadoc and CVS tags)
  *
  */