001    /**
002     * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
013     */
014    
015    package com.liferay.portal.servlet.filters.virtualhost;
016    
017    import com.liferay.portal.LayoutFriendlyURLException;
018    import com.liferay.portal.NoSuchLayoutException;
019    import com.liferay.portal.kernel.exception.PortalException;
020    import com.liferay.portal.kernel.exception.SystemException;
021    import com.liferay.portal.kernel.log.Log;
022    import com.liferay.portal.kernel.log.LogFactoryUtil;
023    import com.liferay.portal.kernel.struts.LastPath;
024    import com.liferay.portal.kernel.util.CharPool;
025    import com.liferay.portal.kernel.util.HttpUtil;
026    import com.liferay.portal.kernel.util.StringBundler;
027    import com.liferay.portal.kernel.util.StringPool;
028    import com.liferay.portal.kernel.util.StringUtil;
029    import com.liferay.portal.kernel.util.Validator;
030    import com.liferay.portal.model.Group;
031    import com.liferay.portal.model.LayoutSet;
032    import com.liferay.portal.model.impl.LayoutImpl;
033    import com.liferay.portal.service.LayoutLocalServiceUtil;
034    import com.liferay.portal.servlet.I18nServlet;
035    import com.liferay.portal.servlet.filters.BasePortalFilter;
036    import com.liferay.portal.util.Portal;
037    import com.liferay.portal.util.PortalInstances;
038    import com.liferay.portal.util.PortalUtil;
039    import com.liferay.portal.util.PropsValues;
040    import com.liferay.portal.util.WebKeys;
041    import com.liferay.portal.webserver.WebServerServlet;
042    
043    import java.util.Map;
044    
045    import javax.servlet.FilterChain;
046    import javax.servlet.FilterConfig;
047    import javax.servlet.RequestDispatcher;
048    import javax.servlet.ServletContext;
049    import javax.servlet.http.HttpServletRequest;
050    import javax.servlet.http.HttpServletResponse;
051    
052    /**
053     * <p>
054     * This filter is used to provide virtual host functionality.
055     * </p>
056     *
057     * @author Joel Kozikowski
058     * @author Brian Wing Shun Chan
059     * @author Raymond Aug??
060     * @author Eduardo Lundgren
061     */
062    public class VirtualHostFilter extends BasePortalFilter {
063    
064            @Override
065            public void init(FilterConfig filterConfig) {
066                    super.init(filterConfig);
067    
068                    _servletContext = filterConfig.getServletContext();
069    
070                    String contextPath = PortalUtil.getPathContext();
071    
072                    String proxyPath = PortalUtil.getPathProxy();
073    
074                    if (!contextPath.isEmpty() && !proxyPath.isEmpty() &&
075                            contextPath.startsWith(proxyPath)) {
076    
077                            contextPath = contextPath.substring(proxyPath.length());
078                    }
079    
080                    _contextPath = contextPath;
081            }
082    
083            @Override
084            public boolean isFilterEnabled(
085                    HttpServletRequest request, HttpServletResponse response) {
086    
087                    String uri = request.getRequestURI();
088    
089                    for (String extension : PropsValues.VIRTUAL_HOSTS_IGNORE_EXTENSIONS) {
090                            if (uri.endsWith(extension)) {
091                                    return false;
092                            }
093                    }
094    
095                    return true;
096            }
097    
098            protected boolean isDocumentFriendlyURL(
099                            HttpServletRequest request, long groupId, String friendlyURL)
100                    throws PortalException, SystemException {
101    
102                    if (friendlyURL.startsWith(_PATH_DOCUMENTS) &&
103                            WebServerServlet.hasFiles(request)) {
104    
105                            String path = HttpUtil.fixPath(request.getPathInfo());
106    
107                            String[] pathArray = StringUtil.split(path, CharPool.SLASH);
108    
109                            if (pathArray.length == 2) {
110                                    try {
111                                            LayoutLocalServiceUtil.getFriendlyURLLayout(
112                                                    groupId, false, friendlyURL);
113                                    }
114                                    catch (NoSuchLayoutException nsle) {
115                                            return true;
116                                    }
117                            }
118                            else {
119                                    return true;
120                            }
121                    }
122    
123                    return false;
124            }
125    
126            protected boolean isValidFriendlyURL(String friendlyURL) {
127                    friendlyURL = StringUtil.toLowerCase(friendlyURL);
128    
129                    if (PortalInstances.isVirtualHostsIgnorePath(friendlyURL) ||
130                            friendlyURL.startsWith(_PATH_MODULE_SLASH) ||
131                            friendlyURL.startsWith(_PRIVATE_GROUP_SERVLET_MAPPING_SLASH) ||
132                            friendlyURL.startsWith(_PRIVATE_USER_SERVLET_MAPPING_SLASH) ||
133                            friendlyURL.startsWith(_PUBLIC_GROUP_SERVLET_MAPPING_SLASH)) {
134    
135                            return false;
136                    }
137    
138                    if (LayoutImpl.hasFriendlyURLKeyword(friendlyURL)) {
139                            return false;
140                    }
141    
142                    int code = LayoutImpl.validateFriendlyURL(friendlyURL, false);
143    
144                    if ((code > -1) &&
145                            (code != LayoutFriendlyURLException.ENDS_WITH_SLASH)) {
146    
147                            return false;
148                    }
149    
150                    return true;
151            }
152    
153            /**
154             * @deprecated As of 7.0.0, with no direct replacement
155             */
156            @Deprecated
157            protected boolean isValidRequestURL(StringBuffer requestURL) {
158                    if (requestURL == null) {
159                            return false;
160                    }
161    
162                    String url = requestURL.toString();
163    
164                    for (String extension : PropsValues.VIRTUAL_HOSTS_IGNORE_EXTENSIONS) {
165                            if (url.endsWith(extension)) {
166                                    return false;
167                            }
168                    }
169    
170                    return true;
171            }
172    
173            @Override
174            protected void processFilter(
175                            HttpServletRequest request, HttpServletResponse response,
176                            FilterChain filterChain)
177                    throws Exception {
178    
179                    long companyId = PortalInstances.getCompanyId(request);
180    
181                    String originalFriendlyURL = request.getRequestURI();
182    
183                    String friendlyURL = originalFriendlyURL;
184    
185                    friendlyURL = StringUtil.replace(
186                            friendlyURL, StringPool.DOUBLE_SLASH, StringPool.SLASH);
187    
188                    if (!friendlyURL.equals(StringPool.SLASH) && !_contextPath.isEmpty() &&
189                            (friendlyURL.length() > _contextPath.length()) &&
190                            friendlyURL.startsWith(_contextPath) &&
191                            friendlyURL.charAt(_contextPath.length()) == CharPool.SLASH) {
192    
193                            friendlyURL = friendlyURL.substring(_contextPath.length());
194                    }
195    
196                    int pos = friendlyURL.indexOf(CharPool.SEMICOLON);
197    
198                    if (pos != -1) {
199                            friendlyURL = friendlyURL.substring(0, pos);
200                    }
201    
202                    String i18nLanguageId = _findLanguageId(friendlyURL);
203    
204                    if (i18nLanguageId != null) {
205                            friendlyURL = friendlyURL.substring(i18nLanguageId.length());
206                    }
207    
208                    friendlyURL = StringUtil.replace(
209                            friendlyURL, PropsValues.WIDGET_SERVLET_MAPPING, StringPool.BLANK);
210    
211                    if (_log.isDebugEnabled()) {
212                            _log.debug("Friendly URL " + friendlyURL);
213                    }
214    
215                    if (!friendlyURL.equals(StringPool.SLASH) &&
216                            !isValidFriendlyURL(friendlyURL)) {
217    
218                            _log.debug("Friendly URL is not valid");
219    
220                            if (i18nLanguageId != null) {
221                                    int offset =
222                                            originalFriendlyURL.length() - friendlyURL.length() -
223                                                    i18nLanguageId.length();
224    
225                                    if (!originalFriendlyURL.regionMatches(
226                                                    offset, i18nLanguageId, 0, i18nLanguageId.length())) {
227    
228                                            String forwardURL = originalFriendlyURL;
229    
230                                            if (offset > 0) {
231                                                    String prefix = originalFriendlyURL.substring(
232                                                            0, offset);
233    
234                                                    forwardURL = prefix.concat(i18nLanguageId);
235                                            }
236                                            else {
237                                                    forwardURL = i18nLanguageId;
238                                            }
239    
240                                            forwardURL = forwardURL.concat(friendlyURL);
241    
242                                            RequestDispatcher requestDispatcher =
243                                                    _servletContext.getRequestDispatcher(forwardURL);
244    
245                                            requestDispatcher.forward(request, response);
246    
247                                            return;
248                                    }
249                            }
250    
251                            processFilter(
252                                    VirtualHostFilter.class, request, response, filterChain);
253    
254                            return;
255                    }
256    
257                    LayoutSet layoutSet = (LayoutSet)request.getAttribute(
258                            WebKeys.VIRTUAL_HOST_LAYOUT_SET);
259    
260                    if (_log.isDebugEnabled()) {
261                            _log.debug("Layout set " + layoutSet);
262                    }
263    
264                    if (layoutSet == null) {
265                            processFilter(
266                                    VirtualHostFilter.class, request, response, filterChain);
267    
268                            return;
269                    }
270    
271                    try {
272                            LastPath lastPath = new LastPath(
273                                    _contextPath, friendlyURL, request.getParameterMap());
274    
275                            request.setAttribute(WebKeys.LAST_PATH, lastPath);
276    
277                            StringBundler forwardURL = new StringBundler(5);
278    
279                            if (i18nLanguageId != null) {
280                                    forwardURL.append(i18nLanguageId);
281                            }
282    
283                            if (originalFriendlyURL.startsWith(
284                                            PropsValues.WIDGET_SERVLET_MAPPING)) {
285    
286                                    forwardURL.append(PropsValues.WIDGET_SERVLET_MAPPING);
287    
288                                    friendlyURL = StringUtil.replaceFirst(
289                                            friendlyURL, PropsValues.WIDGET_SERVLET_MAPPING,
290                                            StringPool.BLANK);
291                            }
292    
293                            if (friendlyURL.equals(StringPool.SLASH) ||
294                                    (PortalUtil.getPlidFromFriendlyURL(companyId, friendlyURL) <=
295                                            0)) {
296    
297                                    Group group = layoutSet.getGroup();
298    
299                                    if (isDocumentFriendlyURL(
300                                                    request, group.getGroupId(), friendlyURL)) {
301    
302                                            processFilter(
303                                                    VirtualHostFilter.class, request, response,
304                                                    filterChain);
305    
306                                            return;
307                                    }
308    
309                                    if (group.isGuest() && friendlyURL.equals(StringPool.SLASH) &&
310                                            !layoutSet.isPrivateLayout()) {
311    
312                                            String homeURL = PortalUtil.getRelativeHomeURL(request);
313    
314                                            if (Validator.isNotNull(homeURL)) {
315                                                    friendlyURL = homeURL;
316                                            }
317                                    }
318                                    else {
319                                            if (layoutSet.isPrivateLayout()) {
320                                                    if (group.isUser()) {
321                                                            forwardURL.append(_PRIVATE_USER_SERVLET_MAPPING);
322                                                    }
323                                                    else {
324                                                            forwardURL.append(_PRIVATE_GROUP_SERVLET_MAPPING);
325                                                    }
326                                            }
327                                            else {
328                                                    forwardURL.append(_PUBLIC_GROUP_SERVLET_MAPPING);
329                                            }
330    
331                                            forwardURL.append(group.getFriendlyURL());
332                                    }
333                            }
334    
335                            String forwardURLString = friendlyURL;
336    
337                            if (forwardURL.index() > 0) {
338                                    forwardURL.append(friendlyURL);
339    
340                                    forwardURLString = forwardURL.toString();
341                            }
342    
343                            if (_log.isDebugEnabled()) {
344                                    _log.debug("Forward to " + forwardURLString);
345                            }
346    
347                            RequestDispatcher requestDispatcher =
348                                    _servletContext.getRequestDispatcher(forwardURLString);
349    
350                            requestDispatcher.forward(request, response);
351                    }
352                    catch (Exception e) {
353                            _log.error(e, e);
354    
355                            processFilter(
356                                    VirtualHostFilter.class, request, response, filterChain);
357                    }
358            }
359    
360            private String _findLanguageId(String friendlyURL) {
361                    if (friendlyURL.isEmpty() ||
362                            (friendlyURL.charAt(0) != CharPool.SLASH)) {
363    
364                            return null;
365                    }
366    
367                    String lowerCaseLanguageId = friendlyURL;
368    
369                    int index = friendlyURL.indexOf(CharPool.SLASH, 1);
370    
371                    if (index != -1) {
372                            lowerCaseLanguageId = friendlyURL.substring(0, index);
373                    }
374    
375                    lowerCaseLanguageId = StringUtil.toLowerCase(lowerCaseLanguageId);
376    
377                    Map<String, String> languageIds = I18nServlet.getLanguageIdsMap();
378    
379                    String languageId = languageIds.get(lowerCaseLanguageId);
380    
381                    if (languageId == null) {
382                            return null;
383                    }
384    
385                    return languageId;
386            }
387    
388            private static final String _PATH_DOCUMENTS = "/documents/";
389    
390            private static final String _PATH_MODULE_SLASH =
391                    Portal.PATH_MODULE + StringPool.SLASH;
392    
393            private static final String _PRIVATE_GROUP_SERVLET_MAPPING =
394                    PropsValues.LAYOUT_FRIENDLY_URL_PRIVATE_GROUP_SERVLET_MAPPING;
395    
396            private static final String _PRIVATE_GROUP_SERVLET_MAPPING_SLASH =
397                    _PRIVATE_GROUP_SERVLET_MAPPING + StringPool.SLASH;
398    
399            private static final String _PRIVATE_USER_SERVLET_MAPPING =
400                    PropsValues.LAYOUT_FRIENDLY_URL_PRIVATE_USER_SERVLET_MAPPING;
401    
402            private static final String _PRIVATE_USER_SERVLET_MAPPING_SLASH =
403                    _PRIVATE_USER_SERVLET_MAPPING + StringPool.SLASH;
404    
405            private static final String _PUBLIC_GROUP_SERVLET_MAPPING =
406                    PropsValues.LAYOUT_FRIENDLY_URL_PUBLIC_SERVLET_MAPPING;
407    
408            private static final String _PUBLIC_GROUP_SERVLET_MAPPING_SLASH =
409                    _PUBLIC_GROUP_SERVLET_MAPPING + StringPool.SLASH;
410    
411            private static Log _log = LogFactoryUtil.getLog(VirtualHostFilter.class);
412    
413            private String _contextPath;
414            private ServletContext _servletContext;
415    
416    }