//# 0 errors, 36 messages
//#
/*
    //#cookieutils.java:1:1: class: net.sourceforge.pebble.util.CookieUtils
    //#cookieutils.java:1:1: method: net.sourceforge.pebble.util.CookieUtils.net.sourceforge.pebble.util.CookieUtils__static_init
 * Copyright (c) 2003-2006, Simon Brown
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   - Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *
 *   - Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in
 *     the documentation and/or other materials provided with the
 *     distribution.
 *
 *   - Neither the name of Pebble nor the names of its contributors may
 *     be used to endorse or promote products derived from this software
 *     without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package net.sourceforge.pebble.util;

import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletResponse;

/**
 * Utilities for finding and manipulating cookies.
 *
 * @author    Simon Brown
 */
public class CookieUtils {
    //#cookieutils.java:42: method: void net.sourceforge.pebble.util.CookieUtils.net.sourceforge.pebble.util.CookieUtils()
    //#cookieutils.java:42: end of method: void net.sourceforge.pebble.util.CookieUtils.net.sourceforge.pebble.util.CookieUtils()

  /** represents 4 weeks in seconds */
  public static final int ONE_MONTH = 60 * 60 * 24 * 28;

  /**
   * Gets a reference to a named cookie from an array of cookies.
   *
   * @param cookies   an array of cookies
   * @param name      the name of the cookie to find
   * @return    a reference to a Cookie, or null if the cookie couldn't be found
   */
  public static Cookie getCookie(Cookie cookies[], String name) {

    if (cookies != null) {
    //#cookieutils.java:56: method: Cookie net.sourceforge.pebble.util.CookieUtils.getCookie(Cookie[], String)
    //#input(Cookie getCookie(Cookie[], String)): cookies
    //#input(Cookie getCookie(Cookie[], String)): cookies.length
    //#input(Cookie getCookie(Cookie[], String)): cookies[0..4_294_967_294]
    //#input(Cookie getCookie(Cookie[], String)): name
    //#output(Cookie getCookie(Cookie[], String)): return_value
    //#pre[2] (Cookie getCookie(Cookie[], String)): (soft) cookies.length <= 4_294_967_295
    //#pre[3] (Cookie getCookie(Cookie[], String)): (soft) cookies[0..4_294_967_294] != null
    //#presumption(Cookie getCookie(Cookie[], String)): javax.servlet.http.Cookie:getName(...)@58 != null
    //#post(Cookie getCookie(Cookie[], String)): init'ed(return_value)
    //#test_vector(Cookie getCookie(Cookie[], String)): cookies: Addr_Set{null}, Inverse{null}
    //#test_vector(Cookie getCookie(Cookie[], String)): java.lang.String:equals(...)@58: {0}, {1}
      for (Cookie cookie : cookies) {
        if (cookie.getName().equals(name)) {
          return cookie;
        }
      }
    }

    // we've got this far so the specified cookie wasn't found
    return null;
    //#cookieutils.java:65: end of method: Cookie net.sourceforge.pebble.util.CookieUtils.getCookie(Cookie[], String)
  }

  /**
   * Adds a cookie with the specified name, value and expiry.
   *
   * @param response    the HttpServletResponse to add the cookie to
   * @param name        the name of the cookie
   * @param value       the value of the cookie
   * @param maxAge      the maxAge of the cookie (in seconds)
   */
  public static void addCookie(HttpServletResponse response, String name, String value, int maxAge) {
    Cookie cookie = new Cookie(name, value);
    //#cookieutils.java:77: method: void net.sourceforge.pebble.util.CookieUtils.addCookie(HttpServletResponse, String, String, int)
    //#input(void addCookie(HttpServletResponse, String, String, int)): maxAge
    //#input(void addCookie(HttpServletResponse, String, String, int)): name
    //#input(void addCookie(HttpServletResponse, String, String, int)): response
    //#input(void addCookie(HttpServletResponse, String, String, int)): value
    //#pre[3] (void addCookie(HttpServletResponse, String, String, int)): response != null
    cookie.setMaxAge(maxAge);
    response.addCookie(cookie);
  }
    //#cookieutils.java:80: end of method: void net.sourceforge.pebble.util.CookieUtils.addCookie(HttpServletResponse, String, String, int)

  /**
   * Removes a cookie with the specified name.
   *
   * @param response    the HttpServletResponse to remove the cookie from
   * @param name        the name of the cookie
   */
  public static void removeCookie(HttpServletResponse response, String name) {
    addCookie(response, name, "", 0);
    //#cookieutils.java:89: method: void net.sourceforge.pebble.util.CookieUtils.removeCookie(HttpServletResponse, String)
    //#input(void removeCookie(HttpServletResponse, String)): name
    //#input(void removeCookie(HttpServletResponse, String)): response
    //#pre[2] (void removeCookie(HttpServletResponse, String)): response != null
    //#unanalyzed(void removeCookie(HttpServletResponse, String)): Effects-of-calling:javax.servlet.http.Cookie
    //#unanalyzed(void removeCookie(HttpServletResponse, String)): Effects-of-calling:javax.servlet.http.Cookie:setMaxAge
    //#unanalyzed(void removeCookie(HttpServletResponse, String)): Effects-of-calling:javax.servlet.http.HttpServletResponse:addCookie
  }
    //#cookieutils.java:90: end of method: void net.sourceforge.pebble.util.CookieUtils.removeCookie(HttpServletResponse, String)

}
    //#output(net.sourceforge.pebble.util.CookieUtils__static_init): __Descendant_Table[net/sourceforge/pebble/util/CookieUtils]
    //#post(net.sourceforge.pebble.util.CookieUtils__static_init): __Descendant_Table[net/sourceforge/pebble/util/CookieUtils] == &__Dispatch_Table
    //#cookieutils.java:: end of method: net.sourceforge.pebble.util.CookieUtils.net.sourceforge.pebble.util.CookieUtils__static_init
    //#cookieutils.java:: end of class: net.sourceforge.pebble.util.CookieUtils
