com.liferay.portal.util.CookieKeys.java Source code

Introduction

Here is the source code for com.liferay.portal.util.CookieKeys.java

Source

/**
 * Copyright (c) 2000-2012 Liferay, Inc. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This library 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 Lesser General Public License for more
 * details.
 */

package com.liferay.portal.util;

import com.liferay.portal.CookieNotSupportedException;
import com.liferay.portal.kernel.log.Log;
import com.liferay.portal.kernel.log.LogFactoryUtil;
import com.liferay.portal.kernel.util.CharPool;
import com.liferay.portal.kernel.util.StringPool;
import com.liferay.portal.kernel.util.Validator;
import com.liferay.util.CookieUtil;

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

import org.apache.commons.codec.binary.Hex;

/**
 * @author Brian Wing Shun Chan
 * @author Minhchau Dang
 */
public class CookieKeys implements com.liferay.portal.kernel.util.CookieKeys {

    public static void addCookie(HttpServletRequest request, HttpServletResponse response, Cookie cookie) {

        addCookie(request, response, cookie, request.isSecure());
    }

    public static void addCookie(HttpServletRequest request, HttpServletResponse response, Cookie cookie,
            boolean secure) {

        if (!PropsValues.SESSION_ENABLE_PERSISTENT_COOKIES || PropsValues.TCK_URL) {

            return;
        }

        // LEP-5175

        String name = cookie.getName();

        String originalValue = cookie.getValue();
        String encodedValue = originalValue;

        if (isEncodedCookie(name)) {
            encodedValue = new String(Hex.encodeHex(originalValue.getBytes()));

            if (_log.isDebugEnabled()) {
                _log.debug("Add encoded cookie " + name);
                _log.debug("Original value " + originalValue);
                _log.debug("Hex encoded value " + encodedValue);
            }
        }

        cookie.setSecure(secure);
        cookie.setValue(encodedValue);
        cookie.setVersion(VERSION);

        // Setting a cookie will cause the TCK to lose its ability to track
        // sessions

        response.addCookie(cookie);
    }

    public static void addSupportCookie(HttpServletRequest request, HttpServletResponse response) {

        Cookie cookieSupportCookie = new Cookie(COOKIE_SUPPORT, "true");

        cookieSupportCookie.setPath(StringPool.SLASH);
        cookieSupportCookie.setMaxAge(MAX_AGE);

        addCookie(request, response, cookieSupportCookie);
    }

    public static String getCookie(HttpServletRequest request, String name) {
        return getCookie(request, name, true);
    }

    public static String getCookie(HttpServletRequest request, String name, boolean toUpperCase) {

        String value = CookieUtil.get(request, name, toUpperCase);

        if ((value != null) && isEncodedCookie(name)) {
            try {
                String encodedValue = value;
                String originalValue = new String(Hex.decodeHex(encodedValue.toCharArray()));

                if (_log.isDebugEnabled()) {
                    _log.debug("Get encoded cookie " + name);
                    _log.debug("Hex encoded value " + encodedValue);
                    _log.debug("Original value " + originalValue);
                }

                return originalValue;
            } catch (Exception e) {
                if (_log.isWarnEnabled()) {
                    _log.warn(e.getMessage());
                }

                return value;
            }
        }

        return value;
    }

    public static String getDomain(HttpServletRequest request) {

        // See LEP-4602 and   LEP-4618.

        if (Validator.isNotNull(PropsValues.SESSION_COOKIE_DOMAIN)) {
            return PropsValues.SESSION_COOKIE_DOMAIN;
        }

        String host = request.getServerName();

        return getDomain(host);
    }

    public static String getDomain(String host) {

        // See LEP-4602 and LEP-4645.

        if (host == null) {
            return null;
        }

        // See LEP-5595.

        if (Validator.isIPAddress(host)) {
            return host;
        }

        int x = host.lastIndexOf(CharPool.PERIOD);

        if (x <= 0) {
            return null;
        }

        int y = host.lastIndexOf(CharPool.PERIOD, x - 1);

        if (y <= 0) {
            return StringPool.PERIOD + host;
        }

        int z = host.lastIndexOf(CharPool.PERIOD, y - 1);

        String domain = null;

        if (z <= 0) {
            domain = host.substring(y);
        } else {
            domain = host.substring(z);
        }

        return domain;
    }

    public static boolean hasSessionId(HttpServletRequest request) {
        String jsessionid = getCookie(request, JSESSIONID, false);

        if (jsessionid != null) {
            return true;
        } else {
            return false;
        }
    }

    public static boolean isEncodedCookie(String name) {
        if (name.equals(ID) || name.equals(LOGIN) || name.equals(PASSWORD) || name.equals(SCREEN_NAME)) {

            return true;
        } else {
            return false;
        }
    }

    public static void validateSupportCookie(HttpServletRequest request) throws CookieNotSupportedException {

        if (PropsValues.SESSION_ENABLE_PERSISTENT_COOKIES && PropsValues.SESSION_TEST_COOKIE_SUPPORT) {

            String cookieSupport = getCookie(request, COOKIE_SUPPORT, false);

            if (Validator.isNull(cookieSupport)) {
                throw new CookieNotSupportedException();
            }
        }
    }

    public static final int MAX_AGE = 31536000;

    public static final int VERSION = 0;

    private static Log _log = LogFactoryUtil.getLog(CookieKeys.class);

}