Skip to content

Commit

Permalink
Fixes #8858 - Jetty 12 Review MovedContextHandler. (#8859)
Browse files Browse the repository at this point in the history 
* Fixes #8858 - Jetty 12 Review MovedContextHandler.

Updated method names to avod references to Servlet concepts.
Added test cases.
Updated XML files.

Signed-off-by: Simone Bordet <[email protected]>
  • Loading branch information
@sbordet
sbordet authored Nov 3, 2022
1 parent e2b00bd commit 41e9842
Show file tree
Hide file tree
Showing 4 changed files with 339 additions and 71 deletions.
174 changes: 111 additions & 63 deletions ...core/jetty-server/src/main/java/org/eclipse/jetty/server/handler/MovedContextHandler.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,132 +13,180 @@

package org.eclipse.jetty.server.handler;

import org.eclipse.jetty.http.HttpField;
import org.eclipse.jetty.http.HttpHeader;
import org.eclipse.jetty.http.HttpStatus;
import org.eclipse.jetty.http.HttpURI;
import org.eclipse.jetty.http.PreEncodedHttpField;
import org.eclipse.jetty.server.Handler;
import org.eclipse.jetty.server.Request;
import org.eclipse.jetty.server.Response;
import org.eclipse.jetty.util.Callback;
import org.eclipse.jetty.util.URIUtil;

/**
* Moved ContextHandler.
* This context can be used to replace a context that has changed
* location. Requests are redirected (either to a fixed URL or to a
* new context base).
* <p>A {@code ContextHandler} with a child {@code Handler}
* that redirects to a configurable URI.</p>
*/
public class MovedContextHandler extends ContextHandler
{
final Redirector _redirector;
String _newContextURL;
boolean _discardPathInfo;
boolean _discardQuery;
boolean _permanent;
String _expires;
private int _statusCode = HttpStatus.SEE_OTHER_303;
private String _redirectURI;
private boolean _discardPathInContext = true;
private boolean _discardQuery = true;
private HttpField _cacheControl;

public MovedContextHandler()
{
_redirector = new Redirector();
setHandler(_redirector);
setHandler(new Redirector());
setAllowNullPathInContext(true);
}

public MovedContextHandler(Handler.Collection parent, String contextPath, String newContextURL)
public MovedContextHandler(Handler.Collection parent, String contextPath, String redirectURI)
{
super(contextPath);
parent.addHandler(this);
_newContextURL = newContextURL;
_redirector = new Redirector();
setHandler(_redirector);
setContextPath(contextPath);
setRedirectURI(redirectURI);
}

public boolean isDiscardPathInfo()
/**
* @return the redirect status code, by default 303
*/
public int getStatusCode()
{
return _discardPathInfo;
return _statusCode;
}

public void setDiscardPathInfo(boolean discardPathInfo)
/**
* @param statusCode the redirect status code
* @throws IllegalArgumentException if the status code is not of type redirect (3xx)
*/
public void setStatusCode(int statusCode)
{
_discardPathInfo = discardPathInfo;
if (!HttpStatus.isRedirection(statusCode))
throw new IllegalArgumentException("Invalid HTTP redirection status code: " + statusCode);
_statusCode = statusCode;
}

public String getNewContextURL()
/**
* @return the URI to redirect to
*/
public String getRedirectURI()
{
return _newContextURL;
return _redirectURI;
}

public void setNewContextURL(String newContextURL)
/**
* <p>Sets the URI to redirect to.</p>
* <p>If the redirect URI is not absolute, the original request scheme
* and authority will be used to build the redirect URI.</p>
* <p>The original request {@link Request#getPathInContext(Request) pathInContext}
* will be appended to the redirect URI path, unless {@link #isDiscardPathInContext()}.</p>
* <p>The original request query will be preserved in the redirect URI, unless
* {@link #isDiscardQuery()}.</p>
*
* @param redirectURI the URI to redirect to
*/
public void setRedirectURI(String redirectURI)
{
_newContextURL = newContextURL;
_redirectURI = redirectURI;
}

public boolean isPermanent()
/**
* @return whether the original request {@code pathInContext} is discarded
*/
public boolean isDiscardPathInContext()
{
return _permanent;
return _discardPathInContext;
}

public void setPermanent(boolean permanent)
/**
* <p>Whether to discard the original request {@link Request#getPathInContext(Request) pathInContext}
* when building the redirect URI.</p>
*
* @param discardPathInContext whether the original request {@code pathInContext} is discarded
* @see #setRedirectURI(String)
*/
public void setDiscardPathInContext(boolean discardPathInContext)
{
_permanent = permanent;
_discardPathInContext = discardPathInContext;
}

/**
* @return whether the original request query is discarded
*/
public boolean isDiscardQuery()
{
return _discardQuery;
}

/**
* <p>Whether to discard the original request query
* when building the redirect URI.</p>
*
* @param discardQuery whether the original request query is discarded
*/
public void setDiscardQuery(boolean discardQuery)
{
_discardQuery = discardQuery;
}

/**
* @return the {@code Cache-Control} header value or {@code null}
*/
public String getCacheControl()
{
return _cacheControl == null ? null : _cacheControl.getValue();
}

/**
* @param cacheControl the {@code Cache-Control} header value or {@code null}
*/
public void setCacheControl(String cacheControl)
{
_cacheControl = cacheControl == null ? null : new PreEncodedHttpField(HttpHeader.CACHE_CONTROL, cacheControl);
}

private class Redirector extends Handler.Processor
{
@Override
public void process(Request request, Response response, Callback callback) throws Exception
{
if (_newContextURL == null)
return;
String redirectURI = getRedirectURI();
if (redirectURI == null)
redirectURI = "/";

String path = _newContextURL;
String pathInContext = Request.getPathInContext(request);
if (!_discardPathInfo && pathInContext != null)
path = URIUtil.addPaths(path, pathInContext);
HttpURI.Mutable redirectHttpURI = HttpURI.build(redirectURI);
if (redirectHttpURI.getScheme() == null)
{
HttpURI httpURI = request.getHttpURI();
redirectHttpURI = redirectHttpURI.scheme(httpURI.getScheme())
.authority(httpURI.getAuthority());
}

HttpURI uri = request.getHttpURI();
StringBuilder location = new StringBuilder();
location.append(uri.getScheme()).append("://").append(uri.getAuthority()).append(path);
if (!isDiscardPathInContext())
{
String pathInContext = Request.getPathInContext(request);
String newPath = redirectHttpURI.getPath();
redirectHttpURI.path(URIUtil.addPaths(newPath, pathInContext));
}

if (!_discardQuery && uri.getQuery() != null)
if (!isDiscardQuery())
{
location.append('?');
String q = uri.getQuery();
q = q.replaceAll("\r\n?&=", "!");
location.append(q);
String query = request.getHttpURI().getQuery();
String newQuery = redirectHttpURI.getQuery();
redirectHttpURI.query(URIUtil.addQueries(query, newQuery));
}

response.getHeaders().put(HttpHeader.LOCATION, location.toString());
if (_expires != null)
response.getHeaders().put(HttpHeader.EXPIRES, _expires);
response.setStatus(_permanent ? HttpStatus.MOVED_PERMANENTLY_301 : HttpStatus.FOUND_302);
callback.succeeded();
}
}
response.setStatus(getStatusCode());

/**
* @return the expires header value or null if no expires header
*/
public String getExpires()
{
return _expires;
}
response.getHeaders().put(HttpHeader.LOCATION, redirectHttpURI.asString());

/**
* @param expires the expires header value or null if no expires header
*/
public void setExpires(String expires)
{
_expires = expires;
HttpField cacheControl = _cacheControl;
if (cacheControl != null)
response.getHeaders().put(cacheControl);

callback.succeeded();
}
}
}
Loading

0 comments on commit 41e9842

Please sign in to comment.