001    /**
002     * Copyright (c) 2000-2013 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.kernel.servlet.filters.invoker;
016    
017    import com.liferay.portal.kernel.log.Log;
018    import com.liferay.portal.kernel.log.LogFactoryUtil;
019    import com.liferay.portal.kernel.servlet.DirectCallFilter;
020    import com.liferay.portal.kernel.servlet.LiferayFilter;
021    import com.liferay.portal.kernel.servlet.TryFilter;
022    import com.liferay.portal.kernel.servlet.TryFinallyFilter;
023    import com.liferay.portal.kernel.servlet.WrapHttpServletRequestFilter;
024    import com.liferay.portal.kernel.servlet.WrapHttpServletResponseFilter;
025    
026    import java.io.IOException;
027    
028    import java.util.ArrayList;
029    import java.util.List;
030    
031    import javax.servlet.Filter;
032    import javax.servlet.FilterChain;
033    import javax.servlet.ServletException;
034    import javax.servlet.ServletRequest;
035    import javax.servlet.ServletResponse;
036    import javax.servlet.http.HttpServletRequest;
037    import javax.servlet.http.HttpServletResponse;
038    
039    /**
040     * @author Mika Koivisto
041     * @author Brian Wing Shun Chan
042     * @author Shuyang Zhou
043     */
044    public class InvokerFilterChain implements FilterChain {
045    
046            public InvokerFilterChain(FilterChain filterChain) {
047                    _filterChain = filterChain;
048            }
049    
050            public void addFilter(Filter filter) {
051                    if (_filters == null) {
052                            _filters = new ArrayList<Filter>();
053                    }
054    
055                    _filters.add(filter);
056            }
057    
058            public InvokerFilterChain clone(FilterChain filterChain) {
059                    InvokerFilterChain invokerFilterChain = new InvokerFilterChain(
060                            filterChain);
061    
062                    invokerFilterChain._filters = _filters;
063    
064                    return invokerFilterChain;
065            }
066    
067            @Override
068            public void doFilter(
069                            ServletRequest servletRequest, ServletResponse servletResponse)
070                    throws IOException, ServletException {
071    
072                    if ((_filters == null) || (_index >= _filters.size())) {
073                            _filterChain.doFilter(servletRequest, servletResponse);
074                    }
075                    else {
076                            HttpServletRequest request = (HttpServletRequest)servletRequest;
077                            HttpServletResponse response = (HttpServletResponse)servletResponse;
078    
079                            Filter filter = _filters.get(_index++);
080    
081                            boolean filterEnabled = true;
082    
083                            if (filter instanceof LiferayFilter) {
084                                    LiferayFilter liferayFilter = (LiferayFilter)filter;
085    
086                                    if (!liferayFilter.isFilterEnabled() ||
087                                            !liferayFilter.isFilterEnabled(request, response)) {
088    
089                                            filterEnabled = false;
090                                    }
091                            }
092    
093                            if (filterEnabled) {
094                                    if (filter instanceof DirectCallFilter) {
095                                            try {
096                                                    processDirectCallFilter(filter, request, response);
097                                            }
098                                            catch (IOException ioe) {
099                                                    throw ioe;
100                                            }
101                                            catch (ServletException se) {
102                                                    throw se;
103                                            }
104                                            catch (Exception e) {
105                                                    throw new ServletException(e);
106                                            }
107                                    }
108                                    else {
109                                            processDoFilter(filter, request, response);
110                                    }
111                            }
112                            else {
113                                    if (_log.isDebugEnabled()) {
114                                            _log.debug("Skip disabled filter " + filter.getClass());
115                                    }
116    
117                                    doFilter(request, response);
118                            }
119                    }
120            }
121    
122            public void setContextClassLoader(ClassLoader contextClassLoader) {
123                    _contextClassLoader = contextClassLoader;
124            }
125    
126            protected void processDirectCallFilter(
127                            Filter filter, HttpServletRequest request,
128                            HttpServletResponse response)
129                    throws Exception {
130    
131                    if (filter instanceof WrapHttpServletRequestFilter) {
132                            if (_log.isDebugEnabled()) {
133                                    _log.debug("Wrap response with filter " + filter.getClass());
134                            }
135    
136                            WrapHttpServletRequestFilter wrapHttpServletRequestFilter =
137                                    (WrapHttpServletRequestFilter)filter;
138    
139                            request = wrapHttpServletRequestFilter.getWrappedHttpServletRequest(
140                                    request, response);
141                    }
142    
143                    if (filter instanceof WrapHttpServletResponseFilter) {
144                            if (_log.isDebugEnabled()) {
145                                    _log.debug("Wrap request with filter " + filter.getClass());
146                            }
147    
148                            WrapHttpServletResponseFilter wrapHttpServletResponseFilter =
149                                    (WrapHttpServletResponseFilter)filter;
150    
151                            response =
152                                    wrapHttpServletResponseFilter.getWrappedHttpServletResponse(
153                                            request, response);
154                    }
155    
156                    if (filter instanceof TryFinallyFilter) {
157                            TryFinallyFilter tryFinallyFilter = (TryFinallyFilter)filter;
158    
159                            Object object = null;
160    
161                            try {
162                                    if (_log.isDebugEnabled()) {
163                                            _log.debug("Invoke try for filter " + filter.getClass());
164                                    }
165    
166                                    object = tryFinallyFilter.doFilterTry(request, response);
167    
168                                    doFilter(request, response);
169                            }
170                            finally {
171                                    if (_log.isDebugEnabled()) {
172                                            _log.debug(
173                                                    "Invoke finally for filter " + filter.getClass());
174                                    }
175    
176                                    tryFinallyFilter.doFilterFinally(request, response, object);
177                            }
178                    }
179                    else if (filter instanceof TryFilter) {
180                            TryFilter tryFilter = (TryFilter)filter;
181    
182                            if (_log.isDebugEnabled()) {
183                                    _log.debug("Invoke try for filter " + filter.getClass());
184                            }
185    
186                            tryFilter.doFilterTry(request, response);
187    
188                            doFilter(request, response);
189                    }
190                    else {
191                            doFilter(request, response);
192                    }
193            }
194    
195            protected void processDoFilter(
196                            Filter filter, ServletRequest servletRequest,
197                            ServletResponse servletResponse)
198                    throws IOException, ServletException {
199    
200                    Thread currentThread = Thread.currentThread();
201    
202                    ClassLoader contextClassLoader = currentThread.getContextClassLoader();
203    
204                    currentThread.setContextClassLoader(_contextClassLoader);
205    
206                    try {
207                            filter.doFilter(servletRequest, servletResponse, this);
208                    }
209                    finally {
210                            currentThread.setContextClassLoader(contextClassLoader);
211                    }
212            }
213    
214            private static Log _log = LogFactoryUtil.getLog(InvokerFilterChain.class);
215    
216            private ClassLoader _contextClassLoader;
217            private FilterChain _filterChain;
218            private List<Filter> _filters;
219            private int _index;
220    
221    }