View Javadoc
1   /**
2    * This file Copyright (c) 2003-2017 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.virtualuri;
35  
36  import info.magnolia.cms.core.AggregationState;
37  import info.magnolia.cms.filters.AbstractMgnlFilter;
38  import info.magnolia.cms.util.RequestDispatchUtil;
39  
40  import java.io.IOException;
41  import java.net.URI;
42  import java.net.URISyntaxException;
43  import java.util.Optional;
44  
45  import javax.inject.Inject;
46  import javax.inject.Provider;
47  import javax.servlet.FilterChain;
48  import javax.servlet.ServletException;
49  import javax.servlet.http.HttpServletRequest;
50  import javax.servlet.http.HttpServletResponse;
51  
52  import org.slf4j.Logger;
53  import org.slf4j.LoggerFactory;
54  
55  /**
56   * Handle redirects configured using {@link VirtualUriMapping VirtualUriMappings}.
57   *
58   * @see VirtualUriMapping
59   */
60  public class VirtualUriFilter extends AbstractMgnlFilter {
61  
62      private static final Logger log = LoggerFactory.getLogger(VirtualUriFilter.class);
63  
64      private VirtualUriRegistry registry;
65      private Provider<AggregationState> aggregationStateProvider;
66  
67      @Inject
68      public VirtualUriFilter(VirtualUriRegistry registry, Provider<AggregationState> aggregationStateProvider) {
69          this.registry = registry;
70          this.aggregationStateProvider = aggregationStateProvider;
71      }
72  
73      @Override
74      public void doFilter(HttpServletRequest request, HttpServletResponse response, FilterChain chain)
75              throws IOException, ServletException {
76  
77          final AggregationState aggregationState = aggregationStateProvider.get();
78          String currentUri = aggregationState.getCurrentURI();
79          String queryString = aggregationState.getQueryString();
80  
81          // Encapsulate pre-decoded handle/path-info (that is without context path) + query string into a relative URI
82          final URI uri;
83          try {
84              uri = new URI(null, null, currentUri, queryString, null);
85          } catch (URISyntaxException e) {
86              log.warn("Cannot reconstruct a valid URI from the aggregation state data", e);
87              chain.doFilter(request, response);
88              return;
89          }
90  
91          Optional<VirtualUriMapping.Result> mappingBestMatch = registry.getAllDefinitions().stream()
92                  .map(uriMapping -> uriMapping.mapUri(uri))
93                  .filter(Optional::isPresent)
94                  .map(Optional::get)
95                  .max(VirtualUriMapping.Result::compareTo);
96  
97          if (!mappingBestMatch.isPresent()) {
98              chain.doFilter(request, response);
99              return;
100         }
101 
102         VirtualUriMapping.Result result = mappingBestMatch.get();
103         String targetUri = result.getToUri();
104 
105         if (response.isCommitted()) {
106             log.warn(
107                     "Response is already committed, cannot apply virtual URI {} (original URI was {})",
108                     targetUri,
109                     request.getRequestURI());
110             chain.doFilter(request, response);
111             return;
112         }
113 
114         if (RequestDispatchUtil.dispatch(targetUri, request, response)) {
115             return;
116         }
117 
118         aggregationState.setCurrentURI(targetUri);
119         chain.doFilter(request, response);
120     }
121 }