View Javadoc

1   /**
2    * This file Copyright (c) 2003-2011 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.cms.filters;
35  
36  import info.magnolia.cms.beans.config.VirtualURIManager;
37  import info.magnolia.cms.core.AggregationState;
38  import info.magnolia.cms.util.RequestDispatchUtil;
39  import info.magnolia.context.MgnlContext;
40  
41  import java.io.IOException;
42  import javax.servlet.FilterChain;
43  import javax.servlet.ServletException;
44  import javax.servlet.http.HttpServletRequest;
45  import javax.servlet.http.HttpServletResponse;
46  
47  import org.apache.commons.lang.StringUtils;
48  import org.slf4j.Logger;
49  import org.slf4j.LoggerFactory;
50  
51  /**
52   * Handle redirects configured using VirtualURIMappings.
53   *
54   * @author Fabrizio Giustina
55   * @version $Id: VirtualUriFilter.java 52599 2011-12-13 09:27:09Z mdivilek $
56   * @see info.magnolia.cms.beans.config.VirtualURIMapping
57   */
58  public class VirtualUriFilter extends AbstractMgnlFilter {
59  
60      private static final Logger log = LoggerFactory.getLogger(VirtualUriFilter.class);
61  
62      public void doFilter(HttpServletRequest request, HttpServletResponse response, FilterChain chain)
63              throws IOException, ServletException {
64  
65          final AggregationState aggregationState = MgnlContext.getAggregationState();
66          String targetUri = getURIMapping(aggregationState.getCurrentURI(), aggregationState.getQueryString());
67  
68          if (StringUtils.isEmpty(targetUri)) {
69              chain.doFilter(request, response);
70              return;
71          }
72  
73          if (response.isCommitted()) {
74              log.warn(
75                      "Response is already committed, cannot apply virtual URI {} (original URI was {})",
76                      targetUri,
77                      request.getRequestURI());
78              chain.doFilter(request, response);
79              return;
80          }
81  
82          if (RequestDispatchUtil.dispatch(targetUri, request, response))
83              return;
84  
85          aggregationState.setCurrentURI(targetUri);
86          chain.doFilter(request, response);
87      }
88  
89      /**
90       * @return URI mapping as in ServerInfo
91       */
92      protected String getURIMapping(String currentURI) {
93          return VirtualURIManager.getInstance().getURIMapping(currentURI);
94      }
95      
96      /**
97       * @return URI mapping as in ServerInfo
98       */
99      protected String getURIMapping(String currentURI, String queryString) {
100         return VirtualURIManager.getInstance().getURIMapping(currentURI, queryString);
101     }
102 }