001    /**
002     * Copyright (c) 2000-2012 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.servlet.filters.virtualhost;
016    
017    import com.liferay.portal.LayoutFriendlyURLException;
018    import com.liferay.portal.kernel.log.Log;
019    import com.liferay.portal.kernel.log.LogFactoryUtil;
020    import com.liferay.portal.kernel.struts.LastPath;
021    import com.liferay.portal.kernel.util.CharPool;
022    import com.liferay.portal.kernel.util.StringBundler;
023    import com.liferay.portal.kernel.util.StringPool;
024    import com.liferay.portal.kernel.util.StringUtil;
025    import com.liferay.portal.kernel.util.Validator;
026    import com.liferay.portal.model.Group;
027    import com.liferay.portal.model.LayoutSet;
028    import com.liferay.portal.model.impl.LayoutImpl;
029    import com.liferay.portal.service.GroupLocalServiceUtil;
030    import com.liferay.portal.servlet.I18nServlet;
031    import com.liferay.portal.servlet.filters.BasePortalFilter;
032    import com.liferay.portal.util.PortalInstances;
033    import com.liferay.portal.util.PortalUtil;
034    import com.liferay.portal.util.PropsValues;
035    import com.liferay.portal.util.WebKeys;
036    import com.liferay.portal.webserver.WebServerServlet;
037    
038    import java.util.Set;
039    
040    import javax.servlet.FilterChain;
041    import javax.servlet.FilterConfig;
042    import javax.servlet.RequestDispatcher;
043    import javax.servlet.ServletContext;
044    import javax.servlet.http.HttpServletRequest;
045    import javax.servlet.http.HttpServletResponse;
046    
047    /**
048     * <p>
049     * This filter is used to provide virtual host functionality.
050     * </p>
051     *
052     * @author Joel Kozikowski
053     * @author Brian Wing Shun Chan
054     * @author Raymond Augé
055     * @author Eduardo Lundgren
056     */
057    public class VirtualHostFilter extends BasePortalFilter {
058    
059            @Override
060            public void init(FilterConfig filterConfig) {
061                    super.init(filterConfig);
062    
063                    _servletContext = filterConfig.getServletContext();
064    
065                    _slashedKeywords =
066                            new String[PropsValues.LAYOUT_FRIENDLY_URL_KEYWORDS.length];
067    
068                    for (int i = 0; i < PropsValues.LAYOUT_FRIENDLY_URL_KEYWORDS.length;
069                                    i++) {
070    
071                            String keyword = PropsValues.LAYOUT_FRIENDLY_URL_KEYWORDS[i];
072    
073                            if (keyword.contains(StringPool.PERIOD) ||
074                                    keyword.equals("_vti_") || keyword.equals("display_chart") ||
075                                    keyword.equals("software_catalog")) {
076    
077                                    keyword = StringPool.SLASH + keyword;
078                            }
079                            else {
080                                    keyword = StringPool.SLASH + keyword + StringPool.SLASH;
081                            }
082    
083                            _slashedKeywords[i] = keyword.toLowerCase();
084                    }
085            }
086    
087            @Override
088            public boolean isFilterEnabled(
089                    HttpServletRequest request, HttpServletResponse response) {
090    
091                    StringBuffer requestURL = request.getRequestURL();
092    
093                    if (isValidRequestURL(requestURL)) {
094                            return true;
095                    }
096                    else {
097                            return false;
098                    }
099            }
100    
101            protected boolean isValidFriendlyURL(String friendlyURL) {
102                    friendlyURL = friendlyURL.toLowerCase();
103    
104                    if (PortalInstances.isVirtualHostsIgnorePath(friendlyURL) ||
105                            friendlyURL.startsWith(_PRIVATE_GROUP_SERVLET_MAPPING_SLASH) ||
106                            friendlyURL.startsWith(_PRIVATE_USER_SERVLET_MAPPING_SLASH) ||
107                            friendlyURL.startsWith(_PUBLIC_GROUP_SERVLET_MAPPING_SLASH)) {
108    
109                            return false;
110                    }
111    
112                    for (String keyword : _slashedKeywords) {
113                            if (friendlyURL.startsWith(keyword)) {
114                                    return false;
115                            }
116                    }
117    
118                    int code = LayoutImpl.validateFriendlyURL(friendlyURL);
119    
120                    if ((code > -1) &&
121                            (code != LayoutFriendlyURLException.ENDS_WITH_SLASH)) {
122    
123                            return false;
124                    }
125    
126                    return true;
127            }
128    
129            protected boolean isValidRequestURL(StringBuffer requestURL) {
130                    if (requestURL == null) {
131                            return false;
132                    }
133    
134                    String url = requestURL.toString();
135    
136                    for (String extension : PropsValues.VIRTUAL_HOSTS_IGNORE_EXTENSIONS) {
137                            if (url.endsWith(extension)) {
138                                    return false;
139                            }
140                    }
141    
142                    return true;
143            }
144    
145            @Override
146            protected void processFilter(
147                            HttpServletRequest request, HttpServletResponse response,
148                            FilterChain filterChain)
149                    throws Exception {
150    
151                    long companyId = PortalInstances.getCompanyId(request);
152    
153                    String contextPath = PortalUtil.getPathContext();
154    
155                    String originalFriendlyURL = request.getRequestURI();
156    
157                    String friendlyURL = originalFriendlyURL;
158    
159                    if ((Validator.isNotNull(contextPath)) &&
160                            (friendlyURL.indexOf(contextPath) != -1)) {
161    
162                            friendlyURL = friendlyURL.substring(contextPath.length());
163                    }
164    
165                    friendlyURL = StringUtil.replace(
166                            friendlyURL, StringPool.DOUBLE_SLASH, StringPool.SLASH);
167    
168                    String i18nLanguageId = null;
169    
170                    Set<String> languageIds = I18nServlet.getLanguageIds();
171    
172                    for (String languageId : languageIds) {
173                            if (StringUtil.startsWith(friendlyURL, languageId)) {
174                                    int pos = friendlyURL.indexOf(CharPool.SLASH, 1);
175    
176                                    if (((pos != -1) && (pos != languageId.length())) ||
177                                            ((pos == -1) &&
178                                             !friendlyURL.equalsIgnoreCase(languageId))) {
179    
180                                            continue;
181                                    }
182    
183                                    if (pos == -1) {
184                                            i18nLanguageId = languageId;
185                                            friendlyURL = StringPool.SLASH;
186                                    }
187                                    else {
188                                            i18nLanguageId = languageId.substring(0, pos);
189                                            friendlyURL = friendlyURL.substring(pos);
190                                    }
191    
192                                    break;
193                            }
194                    }
195    
196                    friendlyURL = StringUtil.replace(
197                            friendlyURL, PropsValues.WIDGET_SERVLET_MAPPING, StringPool.BLANK);
198    
199                    if (_log.isDebugEnabled()) {
200                            _log.debug("Friendly URL " + friendlyURL);
201                    }
202    
203                    if (!friendlyURL.equals(StringPool.SLASH) &&
204                            !isValidFriendlyURL(friendlyURL)) {
205    
206                            _log.debug("Friendly URL is not valid");
207    
208                            processFilter(
209                                    VirtualHostFilter.class, request, response, filterChain);
210    
211                            return;
212                    }
213                    else if (friendlyURL.startsWith(_PATH_DOCUMENTS)) {
214                            if (WebServerServlet.hasFiles(request)) {
215                                    processFilter(
216                                            VirtualHostFilter.class, request, response, filterChain);
217    
218                                    return;
219                            }
220                    }
221    
222                    LayoutSet layoutSet = (LayoutSet)request.getAttribute(
223                            WebKeys.VIRTUAL_HOST_LAYOUT_SET);
224    
225                    if (_log.isDebugEnabled()) {
226                            _log.debug("Layout set " + layoutSet);
227                    }
228    
229                    if (layoutSet == null) {
230                            processFilter(
231                                    VirtualHostFilter.class, request, response, filterChain);
232    
233                            return;
234                    }
235    
236                    try {
237                            LastPath lastPath = new LastPath(
238                                    contextPath, friendlyURL, request.getParameterMap());
239    
240                            request.setAttribute(WebKeys.LAST_PATH, lastPath);
241    
242                            StringBundler forwardURL = new StringBundler(5);
243    
244                            if (i18nLanguageId != null) {
245                                    forwardURL.append(i18nLanguageId);
246                            }
247    
248                            if (originalFriendlyURL.startsWith(
249                                            PropsValues.WIDGET_SERVLET_MAPPING)) {
250    
251                                    forwardURL.append(PropsValues.WIDGET_SERVLET_MAPPING);
252    
253                                    friendlyURL = StringUtil.replaceFirst(
254                                            friendlyURL, PropsValues.WIDGET_SERVLET_MAPPING,
255                                            StringPool.BLANK);
256                            }
257    
258                            long plid = PortalUtil.getPlidFromFriendlyURL(
259                                    companyId, friendlyURL);
260    
261                            if (plid <= 0) {
262                                    Group group = GroupLocalServiceUtil.getGroup(
263                                            layoutSet.getGroupId());
264    
265                                    if (group.isGuest() && friendlyURL.equals(StringPool.SLASH)) {
266                                            String homeURL = PortalUtil.getRelativeHomeURL(request);
267    
268                                            if (Validator.isNotNull(homeURL)) {
269                                                    friendlyURL = homeURL;
270                                            }
271                                    }
272                                    else {
273                                            if (layoutSet.isPrivateLayout()) {
274                                                    if (group.isUser()) {
275                                                            forwardURL.append(_PRIVATE_USER_SERVLET_MAPPING);
276                                                    }
277                                                    else {
278                                                            forwardURL.append(_PRIVATE_GROUP_SERVLET_MAPPING);
279                                                    }
280                                            }
281                                            else {
282                                                    forwardURL.append(_PUBLIC_GROUP_SERVLET_MAPPING);
283                                            }
284    
285                                            forwardURL.append(group.getFriendlyURL());
286                                    }
287                            }
288    
289                            forwardURL.append(friendlyURL);
290    
291                            if (_log.isDebugEnabled()) {
292                                    _log.debug("Forward to " + forwardURL);
293                            }
294    
295                            RequestDispatcher requestDispatcher =
296                                    _servletContext.getRequestDispatcher(forwardURL.toString());
297    
298                            requestDispatcher.forward(request, response);
299                    }
300                    catch (Exception e) {
301                            _log.error(e, e);
302    
303                            processFilter(
304                                    VirtualHostFilter.class, request, response, filterChain);
305                    }
306            }
307    
308            private static final String _PATH_DOCUMENTS = "/documents/";
309    
310            private static final String _PRIVATE_GROUP_SERVLET_MAPPING =
311                    PropsValues.LAYOUT_FRIENDLY_URL_PRIVATE_GROUP_SERVLET_MAPPING;
312    
313            private static final String _PRIVATE_GROUP_SERVLET_MAPPING_SLASH =
314                    _PRIVATE_GROUP_SERVLET_MAPPING + StringPool.SLASH;
315    
316            private static final String _PRIVATE_USER_SERVLET_MAPPING =
317                    PropsValues.LAYOUT_FRIENDLY_URL_PRIVATE_USER_SERVLET_MAPPING;
318    
319            private static final String _PRIVATE_USER_SERVLET_MAPPING_SLASH =
320                    _PRIVATE_USER_SERVLET_MAPPING + StringPool.SLASH;
321    
322            private static final String _PUBLIC_GROUP_SERVLET_MAPPING =
323                    PropsValues.LAYOUT_FRIENDLY_URL_PUBLIC_SERVLET_MAPPING;
324    
325            private static final String _PUBLIC_GROUP_SERVLET_MAPPING_SLASH =
326                    _PUBLIC_GROUP_SERVLET_MAPPING + StringPool.SLASH;
327    
328            private static Log _log = LogFactoryUtil.getLog(VirtualHostFilter.class);
329    
330            private ServletContext _servletContext;
331            private String[] _slashedKeywords;
332    
333    }