View Javadoc

1   //
2   //  ========================================================================
3   //  Copyright (c) 1995-2016 Mort Bay Consulting Pty. Ltd.
4   //  ------------------------------------------------------------------------
5   //  All rights reserved. This program and the accompanying materials
6   //  are made available under the terms of the Eclipse Public License v1.0
7   //  and Apache License v2.0 which accompanies this distribution.
8   //
9   //      The Eclipse Public License is available at
10  //      http://www.eclipse.org/legal/epl-v10.html
11  //
12  //      The Apache License v2.0 is available at
13  //      http://www.opensource.org/licenses/apache2.0.php
14  //
15  //  You may elect to redistribute this code under either of these licenses.
16  //  ========================================================================
17  //
18  
19  package org.eclipse.jetty.rewrite.handler;
20  
21  import java.io.IOException;
22  
23  import javax.servlet.http.HttpServletRequest;
24  import javax.servlet.http.HttpServletResponse;
25  
26  import org.eclipse.jetty.http.PathMap;
27  import org.eclipse.jetty.server.Request;
28  import org.eclipse.jetty.util.URIUtil;
29  import org.eclipse.jetty.util.annotation.Name;
30  
31  /**
32   * Rewrite the URI by replacing the matched {@link PathMap} path with a fixed string.
33   */
34  public class RewritePatternRule extends PatternRule implements Rule.ApplyURI
35  {
36      private String _replacement;
37      private String _query;
38  
39      /* ------------------------------------------------------------ */
40      public RewritePatternRule()
41      {
42          this(null,null);
43      }
44      
45      /* ------------------------------------------------------------ */
46      public RewritePatternRule(@Name("pattern") String pattern, @Name("replacement") String replacement)
47      {
48          _handling = false;
49          _terminating = false;
50          setReplacement(replacement);
51      }
52      
53      
54      /* ------------------------------------------------------------ */
55      /**
56       * Whenever a match is found, it replaces with this value.
57       *
58       * @param replacement the replacement string.
59       */
60      public void setReplacement(String replacement)
61      {
62          if (replacement==null)
63          {
64              _replacement=null;
65              _query=null;
66          }
67          else
68          {
69              String[] split = replacement.split("\\?", 2);
70              _replacement = split[0];
71              _query = split.length == 2 ? split[1] : null;
72          }
73      }
74  
75      /* ------------------------------------------------------------ */
76      @Override
77      public String apply(String target, HttpServletRequest request, HttpServletResponse response) throws IOException
78      {
79          target = URIUtil.addPaths(_replacement, PathMap.pathInfo(_pattern, target));
80          return target;
81      }
82  
83      /* ------------------------------------------------------------ */
84      /**
85       * This method will add _query to the requests's queryString and also combine it with existing queryStrings in
86       * the request. However it won't take care for duplicate. E.g. if request.getQueryString contains a parameter
87       * <code>param1 = true</code> and _query will contain <code>param1=false</code> the result will be <code>param1=true&amp;param1=false</code>.
88       * To cover this use case some more complex pattern matching is necessary. We can implement this if there's use
89       * cases.
90       *
91       * @param request the request
92       * @param oldURI the old URI
93       * @param newURI the new URI
94       * @throws IOException if unable to apply the URI
95       */
96      @Override
97      public void applyURI(Request request, String oldURI, String newURI) throws IOException
98      {
99          if (_query == null)
100         {
101             request.setURIPathQuery(newURI);
102         }
103         else
104         {
105             String queryString = request.getQueryString();
106             if (queryString != null)
107                 queryString = queryString + "&" + _query;
108             else
109                 queryString = _query;
110             request.setURIPathQuery(newURI);
111             request.setQueryString(queryString);
112         }
113     }
114 
115     /* ------------------------------------------------------------ */
116     /**
117      * Returns the replacement string.
118      */
119     @Override
120     public String toString()
121     {
122         return super.toString()+"["+_replacement+"]";
123     }
124 }