com.appslandia.plum.base.PrefCookieHandler Maven / Gradle / Ivy

Go to download
// The MIT License (MIT)
// Copyright © 2015 AppsLandia. All rights reserved.

// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:

// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.

// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package com.appslandia.plum.base;

import java.io.StringReader;
import java.nio.charset.StandardCharsets;
import java.util.Map;
import java.util.concurrent.TimeUnit;
import java.util.function.Consumer;

import javax.enterprise.context.ApplicationScoped;
import javax.inject.Inject;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import com.appslandia.common.base.BaseEncoder;
import com.appslandia.common.cdi.Json;
import com.appslandia.common.cdi.Json.Profile;
import com.appslandia.common.json.JsonProcessor;
import com.appslandia.common.utils.AssertUtils;
import com.appslandia.plum.utils.ServletUtils;

/**
 *
 * @author Loc Ha
 *
 */
@ApplicationScoped
public class PrefCookieHandler {

	public static final String DEFAULT_COOKIE_NAME = "pref";
	public static final int DEFAULT_COOKIE_AGE = (int) TimeUnit.SECONDS.convert(90, TimeUnit.DAYS);

	public static final String CONFIG_COOKIE_NAME = PrefCookieHandler.class.getName() + ".cookie_name";
	public static final String CONFIG_COOKIE_AGE = PrefCookieHandler.class.getName() + ".cookie_age";

	@Inject
	protected AppConfig appConfig;

	@Inject
	protected CookieHandler cookieHandler;

	@Inject
	@Json(Profile.COMPACT)
	protected JsonProcessor jsonProcessor;

	protected String getCookieName() {
		return this.appConfig.getString(CONFIG_COOKIE_NAME, DEFAULT_COOKIE_NAME);
	}

	protected int getCookieAge() {
		return this.appConfig.getInt(CONFIG_COOKIE_AGE, DEFAULT_COOKIE_AGE);
	}

	protected String encode(PrefCookie prefCookie) {
		return BaseEncoder.BASE64_URL_NP.encode(prefCookie.mapAsJson(this.jsonProcessor).getBytes(StandardCharsets.UTF_8));
	}

	protected PrefCookie decode(String prefCookie) {
		try {
			Map map = this.jsonProcessor.readAsMap(new StringReader(new String(BaseEncoder.BASE64_URL_NP.decode(prefCookie), StandardCharsets.UTF_8)));
			return new PrefCookie(map);
		} catch (Exception ex) {
			return null;
		}
	}

	public void savePrefCookie(HttpServletResponse response, PrefCookie prefCookie) {
		AssertUtils.assertNotNull(prefCookie);

		String cookieValue = encode(prefCookie);
		if (cookieValue.isEmpty()) {
			return;
		}
		if (cookieValue.length() > 4093) {
			throw new IllegalArgumentException("PrefCookie is too big.");
		}
		this.cookieHandler.saveCookie(response, getCookieName(), cookieValue, getCookieAge(), c -> c.setHttpOnly(false));
	}

	public PrefCookie loadPrefCookie(HttpServletRequest request, HttpServletResponse response) {
		String cookieValue = ServletUtils.getCookieValue(request, getCookieName());
		if (cookieValue == null) {
			return null;
		}
		PrefCookie prefCookie = decode(cookieValue);
		if (prefCookie == null) {
			removePrefCookie(response);
			return null;
		}
		request.setAttribute(PrefCookie.REQUEST_ATTRIBUTE_ID, prefCookie);
		return prefCookie;
	}

	public void removePrefCookie(HttpServletResponse response) {
		this.cookieHandler.removeCookie(response, getCookieName());
	}

	public void savePrefCookie(HttpServletRequest request, HttpServletResponse response, Consumer consumer) {
		PrefCookie prefCookie = (PrefCookie) request.getAttribute(PrefCookie.REQUEST_ATTRIBUTE_ID);
		prefCookie = (prefCookie != null) ? prefCookie : new PrefCookie();
		consumer.accept(prefCookie);

		request.setAttribute(PrefCookie.REQUEST_ATTRIBUTE_ID, prefCookie);
		savePrefCookie(response, prefCookie);
	}
}