com.liferay.portal.servlet.filters.i18n.I18nFilter Maven / Gradle / Ivy
/**
* Copyright (c) 2000-present 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.servlet.filters.i18n;
import com.liferay.petra.string.StringPool;
import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.language.LanguageUtil;
import com.liferay.portal.kernel.log.Log;
import com.liferay.portal.kernel.log.LogFactoryUtil;
import com.liferay.portal.kernel.model.Group;
import com.liferay.portal.kernel.model.LayoutSet;
import com.liferay.portal.kernel.model.User;
import com.liferay.portal.kernel.service.GroupLocalServiceUtil;
import com.liferay.portal.kernel.servlet.HttpMethods;
import com.liferay.portal.kernel.util.CookieKeys;
import com.liferay.portal.kernel.util.JavaConstants;
import com.liferay.portal.kernel.util.LocaleUtil;
import com.liferay.portal.kernel.util.PortalUtil;
import com.liferay.portal.kernel.util.StringUtil;
import com.liferay.portal.kernel.util.Validator;
import com.liferay.portal.kernel.util.WebKeys;
import com.liferay.portal.servlet.filters.BasePortalFilter;
import com.liferay.portal.util.PropsValues;
import java.util.Collections;
import java.util.HashSet;
import java.util.Locale;
import java.util.Set;
import javax.servlet.FilterChain;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
import org.apache.struts.Globals;
/**
* @author Brian Wing Shun Chan
*/
public class I18nFilter extends BasePortalFilter {
public static final String SKIP_FILTER =
I18nFilter.class.getName() + "#SKIP_FILTER";
public static Set getLanguageIds() {
return _languageIds;
}
public static void setLanguageIds(Set languageIds) {
_languageIds = new HashSet<>();
for (String languageId : languageIds) {
languageId = languageId.substring(1);
_languageIds.add(languageId);
}
_languageIds = Collections.unmodifiableSet(_languageIds);
}
@Override
public boolean isFilterEnabled(
HttpServletRequest request, HttpServletResponse response) {
if (!isAlreadyFiltered(request) && !isForwardedByI18nServlet(request) &&
!isWidget(request)) {
return true;
}
return false;
}
protected String getDefaultLanguageId(HttpServletRequest request) {
String defaultLanguageId = getSiteDefaultLanguageId(request);
if (Validator.isNull(defaultLanguageId)) {
defaultLanguageId = LocaleUtil.toLanguageId(
LocaleUtil.getDefault());
}
return defaultLanguageId;
}
protected String getFriendlyURL(HttpServletRequest request) {
String friendlyURL = StringPool.BLANK;
String pathInfo = request.getPathInfo();
if (Validator.isNotNull(pathInfo)) {
String[] pathInfoElements = pathInfo.split("/");
if ((pathInfoElements != null) && (pathInfoElements.length > 1)) {
friendlyURL = StringPool.SLASH + pathInfoElements[1];
}
}
return friendlyURL;
}
protected String getRedirect(HttpServletRequest request) throws Exception {
if (PropsValues.LOCALE_PREPEND_FRIENDLY_URL_STYLE == 0) {
return null;
}
String method = request.getMethod();
if (method.equals(HttpMethods.POST)) {
return null;
}
String contextPath = PortalUtil.getPathContext();
String requestURI = request.getRequestURI();
if (Validator.isNotNull(contextPath) &&
requestURI.contains(contextPath)) {
requestURI = requestURI.substring(contextPath.length());
}
requestURI = StringUtil.replace(
requestURI, StringPool.DOUBLE_SLASH, StringPool.SLASH);
String i18nLanguageId = prependI18nLanguageId(
request, PropsValues.LOCALE_PREPEND_FRIENDLY_URL_STYLE);
if (i18nLanguageId == null) {
return null;
}
Locale locale = LocaleUtil.fromLanguageId(i18nLanguageId);
if (!LanguageUtil.isAvailableLocale(locale)) {
return null;
}
String i18nPathLanguageId = PortalUtil.getI18nPathLanguageId(
locale, i18nLanguageId);
String i18nPath = StringPool.SLASH.concat(i18nPathLanguageId);
if (requestURI.contains(i18nPath.concat(StringPool.SLASH))) {
return null;
}
String redirect = contextPath + i18nPath + requestURI;
int[] groupFriendlyURLIndex = PortalUtil.getGroupFriendlyURLIndex(
requestURI);
String groupFriendlyURL = StringPool.BLANK;
int friendlyURLEnd = 0;
if (groupFriendlyURLIndex != null) {
int friendlyURLStart = groupFriendlyURLIndex[0];
friendlyURLEnd = groupFriendlyURLIndex[1];
groupFriendlyURL = requestURI.substring(
friendlyURLStart, friendlyURLEnd);
}
long companyId = PortalUtil.getCompanyId(request);
Group friendlyURLGroup = GroupLocalServiceUtil.fetchFriendlyURLGroup(
companyId, groupFriendlyURL);
if ((friendlyURLGroup != null) &&
!LanguageUtil.isAvailableLocale(
friendlyURLGroup.getGroupId(), i18nLanguageId)) {
return null;
}
LayoutSet layoutSet = (LayoutSet)request.getAttribute(
WebKeys.VIRTUAL_HOST_LAYOUT_SET);
if ((layoutSet != null) && !layoutSet.isPrivateLayout() &&
requestURI.startsWith(
PropsValues.LAYOUT_FRIENDLY_URL_PUBLIC_SERVLET_MAPPING)) {
Group group = layoutSet.getGroup();
if (groupFriendlyURL.equals(group.getFriendlyURL())) {
redirect =
contextPath + i18nPath +
requestURI.substring(friendlyURLEnd);
}
}
String queryString = request.getQueryString();
if (Validator.isNull(queryString)) {
queryString = (String)request.getAttribute(
JavaConstants.JAVAX_SERVLET_FORWARD_QUERY_STRING);
}
if (Validator.isNotNull(queryString)) {
redirect += StringPool.QUESTION + queryString;
}
return redirect;
}
protected String getRequestedLanguageId(
HttpServletRequest request, String userLanguageId) {
HttpSession session = request.getSession();
Locale locale = (Locale)session.getAttribute(Globals.LOCALE_KEY);
String requestedLanguageId = null;
if (locale != null) {
requestedLanguageId = LocaleUtil.toLanguageId(locale);
}
if (Validator.isNull(requestedLanguageId)) {
requestedLanguageId = userLanguageId;
}
if (Validator.isNull(requestedLanguageId)) {
requestedLanguageId = CookieKeys.getCookie(
request, CookieKeys.GUEST_LANGUAGE_ID, false);
}
return requestedLanguageId;
}
protected String getSiteDefaultLanguageId(HttpServletRequest request) {
String friendlyURL = getFriendlyURL(request);
long companyId = PortalUtil.getCompanyId(request);
try {
Group group = GroupLocalServiceUtil.getFriendlyURLGroup(
companyId, friendlyURL);
Locale siteDefaultLocale = PortalUtil.getSiteDefaultLocale(
group.getGroupId());
return LocaleUtil.toLanguageId(siteDefaultLocale);
}
catch (PortalException pe) {
if (_log.isDebugEnabled()) {
pe.printStackTrace();
}
return StringPool.BLANK;
}
}
protected boolean isAlreadyFiltered(HttpServletRequest request) {
if (request.getAttribute(SKIP_FILTER) != null) {
return true;
}
return false;
}
protected boolean isForwardedByI18nServlet(HttpServletRequest request) {
if ((request.getAttribute(WebKeys.I18N_LANGUAGE_ID) != null) ||
(request.getAttribute(WebKeys.I18N_PATH) != null)) {
return true;
}
return false;
}
protected boolean isWidget(HttpServletRequest request) {
if (request.getAttribute(WebKeys.WIDGET) != null) {
return true;
}
return false;
}
protected String prependI18nLanguageId(
HttpServletRequest request, int prependFriendlyUrlStyle) {
User user = (User)request.getAttribute(WebKeys.USER);
String userLanguageId = null;
if (user != null) {
userLanguageId = user.getLanguageId();
}
String requestedLanguageId = getRequestedLanguageId(
request, userLanguageId);
String defaultLanguageId = getDefaultLanguageId(request);
if (Validator.isNull(requestedLanguageId)) {
requestedLanguageId = defaultLanguageId;
}
if (prependFriendlyUrlStyle == 1) {
return prependIfRequestedLocaleDiffersFromDefaultLocale(
defaultLanguageId, requestedLanguageId);
}
else if (prependFriendlyUrlStyle == 2) {
if (PropsValues.LOCALE_DEFAULT_REQUEST) {
return LocaleUtil.toLanguageId(PortalUtil.getLocale(request));
}
return requestedLanguageId;
}
else if (prependFriendlyUrlStyle == 3) {
if (user != null) {
if (userLanguageId.equals(requestedLanguageId)) {
return null;
}
return requestedLanguageId;
}
return prependIfRequestedLocaleDiffersFromDefaultLocale(
defaultLanguageId, requestedLanguageId);
}
return null;
}
protected String prependIfRequestedLocaleDiffersFromDefaultLocale(
String defaultLanguageId, String guestLanguageId) {
if (defaultLanguageId.equals(guestLanguageId)) {
return null;
}
return guestLanguageId;
}
@Override
protected void processFilter(
HttpServletRequest request, HttpServletResponse response,
FilterChain filterChain)
throws Exception {
request.setAttribute(SKIP_FILTER, Boolean.TRUE);
String redirect = getRedirect(request);
if (redirect == null) {
processFilter(
I18nFilter.class.getName(), request, response, filterChain);
return;
}
if (_log.isDebugEnabled()) {
_log.debug("Redirect " + redirect);
}
response.sendRedirect(redirect);
}
private static final Log _log = LogFactoryUtil.getLog(I18nFilter.class);
private static Set _languageIds;
}