/*
    * Copyright (2005-2009) Schibsted ASA
    * This file is part of SESAT.
    *
    *   SESAT is free software: you can redistribute it and/or modify
    *   it under the terms of the GNU Affero General Public License as published by
    *   the Free Software Foundation, either version 3 of the License, or
    *   (at your option) any later version.
    *
   *   SESAT 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 Affero General Public License for more details.
   *
   *   You should have received a copy of the GNU Affero General Public License
   *   along with SESAT.  If not, see <http://www.gnu.org/licenses/>.
   */
  package no.sesat.search.user.service;
  
  import no.sesat.search.user.UserCookie;
  import org.apache.log4j.Logger;
  
  import javax.servlet.http.Cookie;
  import javax.servlet.http.HttpServletRequest;
  import javax.servlet.http.HttpServletResponse;
  import java.text.DateFormat;
  import java.text.ParseException;
  import java.util.Date;
  
  /**
   * Utility class for user cookie handling.
   *
   * @version $Id: UserCookieUtil.java 23 2009-06-23 16:17:24Z ssmiweve $
   */
  public final class UserCookieUtil {
  
      // Constants -----------------------------------------------------
  
      private static final Logger LOG = Logger.getLogger(UserCookie.class);
  
      public static final String USER_COOKIE_PATH = "/";
  
      public static final String USER_LOGIN_COOKIE_KEY = "SesamUser";
  
      public static final String USER_UPDATE_COOKIE_KEY = "SesamUserUpdate";
  
      private static final String LOGIN_KEY_DEFAULT_VALUE = "0";
  
      public static final DateFormat TIMESTAMP_FORMATTER = DateFormat.getDateTimeInstance();
  
      // Attributes ----------------------------------------------------
  
      // Static --------------------------------------------------------
  
      // Constructors --------------------------------------------------
  
      /**
       * Utility class should not be instantiated.
       */
      private UserCookieUtil() {
          super();
      }
  
      // Public --------------------------------------------------------
  
      /**
       * Look for and return the user login cookie value. Can return null.
       *
       * @param request the http servlet request
       * @return the cookie value that is found, null if no cookie
       */
      public static String getUserLoginCookie(final HttpServletRequest request) {
          return getCookieValue(request, USER_LOGIN_COOKIE_KEY);
      }
  
      /**
       * Set the user login cookie value.
       *
       * @param response the http servlet response
       * @param content the content of the user cookie
       */
      public static void setUserLoginCookie(final HttpServletResponse response, final String content) {
          if (null != response) {
              response.addCookie(createUserLoginCookie(content));
          } else {
              LOG.warn("No response when trying to set the user login cookie.");
          }
      }
  
      /**
       * Set the default user login cookie, signals no login.
       *
       * @param response the http servlet response
       */
      public static void setUserLoginCookieDefault(final HttpServletResponse response) {
          if (null != response) {
              response.addCookie(createUserLoginCookie(LOGIN_KEY_DEFAULT_VALUE));
          } else {
              LOG.warn("No response when trying to set the user login cookie.");
         }
     }
 
     /**
      * Look for and return the user update cookie timestamp. Can return null.
      *
      * @param request the http servlet request
      * @return the timestamp that is found, null if no cookie
      */
     public static Date getUserUpdateCookie(final HttpServletRequest request) {
         final String cookieValue = getCookieValue(request, USER_UPDATE_COOKIE_KEY);
 
         try {
             return (cookieValue != null ? TIMESTAMP_FORMATTER.parse(cookieValue) : null);
         } catch (final ParseException e) {
             LOG.warn("Illegal user update cookie value: " + cookieValue);
             return null;
         }
     }
 
     /**
      * Set the user update cookie value.
      *
      * @param response the http servlet response
      * @param timestamp the update timestamp
      */
     public static void setUserUpdateCookie(final HttpServletResponse response, final Date timestamp) {
         if (null != response) {
             response.addCookie(createUserUpdateCookie(timestamp));
         } else {
             LOG.warn("No response when trying to set the user update cookie.");
         }
     }
 
     /**
      * Return the default value for login key, meaning that the user is not logged in.
      *
      * @return the default value for login key
      */
     public static String getLoginKeyDefaultValue() {
         return LOGIN_KEY_DEFAULT_VALUE;
     }
 
     public static String getCookieValue(final HttpServletRequest request, final String cookieName) {
         if (null != request) {
             if (null != request.getCookies()) {
                 for (final Cookie c : request.getCookies()) {
                     if (c.getName().equals(cookieName)) {
                         return c.getValue();
                     }
                 }
             }
         } else {
             LOG.warn("No request when trying to get the user login cookie.");
         }
 
         return null;
     }
 
     // Package protected ---------------------------------------------
 
     // Protected -----------------------------------------------------
 
     // Private -------------------------------------------------------
 
     private static Cookie createUserLoginCookie(final String content) {
         final Cookie cookie = new Cookie(USER_LOGIN_COOKIE_KEY, content);
         cookie.setPath(USER_COOKIE_PATH);
         cookie.setMaxAge(Integer.MAX_VALUE);
         return cookie;
     }
 
     private static Cookie createUserUpdateCookie(final Date timestamp) {
         final Cookie cookie = new Cookie(USER_UPDATE_COOKIE_KEY, TIMESTAMP_FORMATTER.format(timestamp));
         cookie.setPath(USER_COOKIE_PATH);
         cookie.setMaxAge(Integer.MAX_VALUE);
         return cookie;
     }
 
     // Inner classes -------------------------------------------------
 
 }