1   /**
2    * Copyright (c) 2000-2007 Liferay, Inc. All rights reserved.
3    *
4    * Permission is hereby granted, free of charge, to any person obtaining a copy
5    * of this software and associated documentation files (the "Software"), to deal
6    * in the Software without restriction, including without limitation the rights
7    * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8    * copies of the Software, and to permit persons to whom the Software is
9    * furnished to do so, subject to the following conditions:
10   *
11   * The above copyright notice and this permission notice shall be included in
12   * all copies or substantial portions of the Software.
13   *
14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20   * SOFTWARE.
21   */
22  
23  package com.liferay.portal.util;
24  
25  import com.liferay.portal.CookieNotSupportedException;
26  import com.liferay.portal.kernel.util.GetterUtil;
27  import com.liferay.portal.kernel.util.Validator;
28  import com.liferay.util.CookieUtil;
29  
30  import javax.servlet.http.Cookie;
31  import javax.servlet.http.HttpServletRequest;
32  import javax.servlet.http.HttpServletResponse;
33  
34  /**
35   * <a href="CookieKeys.java.html"><b><i>View Source</i></b></a>
36   *
37   * @author Brian Wing Shun Chan
38   *
39   */
40  public class CookieKeys {
41  
42      public static final String COOKIE_SUPPORT = "COOKIE_SUPPORT";
43  
44      public static final String GUEST_LANGUAGE_ID = "GUEST_LANGUAGE_ID";
45  
46      public static final String ID = "ID";
47  
48      public static final String LOGIN = "LOGIN";
49  
50      public static final String PASSWORD = "PASSWORD";
51  
52      public static final String SCREEN_NAME = "SCREEN_NAME";
53  
54      public static final int MAX_AGE = 31536000;
55  
56      public static void addCookie(HttpServletResponse res, Cookie cookie) {
57          if (GetterUtil.getBoolean(PropsUtil.get(
58                  PropsUtil.SESSION_ENABLE_PERSISTENT_COOKIES))) {
59  
60              if (!GetterUtil.getBoolean(PropsUtil.get(PropsUtil.TCK_URL))) {
61  
62                  // Setting a cookie will cause the TCK to lose its ability
63                  // to track sessions
64  
65                  res.addCookie(cookie);
66              }
67          }
68      }
69  
70      public static void addSupportCookie(HttpServletResponse res) {
71          Cookie cookieSupportCookie =
72              new Cookie(CookieKeys.COOKIE_SUPPORT, "true");
73  
74          cookieSupportCookie.setPath("/");
75          cookieSupportCookie.setMaxAge(CookieKeys.MAX_AGE);
76  
77          addCookie(res, cookieSupportCookie);
78      }
79  
80      public static void validateSupportCookie(HttpServletRequest req)
81          throws CookieNotSupportedException {
82  
83          if (GetterUtil.getBoolean(PropsUtil.get(
84                  PropsUtil.SESSION_ENABLE_PERSISTENT_COOKIES)) &&
85              GetterUtil.getBoolean(PropsUtil.get(
86                  PropsUtil.SESSION_TEST_COOKIE_SUPPORT))) {
87  
88              String cookieSupport = CookieUtil.get(
89                  req.getCookies(), CookieKeys.COOKIE_SUPPORT);
90  
91              if (Validator.isNull(cookieSupport)) {
92                  throw new CookieNotSupportedException();
93              }
94          }
95      }
96  
97  }