Fix the issue that browser url does not change after redirection.

This commit is contained in:
robin shine 2013-10-08 14:08:33 +08:00
parent 1edc128e69
commit de678ce7c6
8 changed files with 426 additions and 28 deletions

View File

@ -1,7 +1,5 @@
package com.pmease.commons.wicket;
import javax.servlet.http.HttpServletRequest;
import org.apache.wicket.DefaultPageManagerProvider;
import org.apache.wicket.MetaDataKey;
import org.apache.wicket.RuntimeConfigurationType;
@ -11,7 +9,6 @@ import org.apache.wicket.pageStore.DefaultPageStore;
import org.apache.wicket.pageStore.IDataStore;
import org.apache.wicket.pageStore.IPageStore;
import org.apache.wicket.protocol.http.WebApplication;
import org.apache.wicket.protocol.http.servlet.ServletWebRequest;
import org.apache.wicket.request.IRequestHandler;
import org.apache.wicket.request.Request;
import org.apache.wicket.request.Url;
@ -42,27 +39,6 @@ public abstract class AbstractWicketConfig extends WebApplication {
return RuntimeConfigurationType.DEPLOYMENT;
}
@Override
public WebRequest newWebRequest(HttpServletRequest servletRequest, String filterPath) {
return new ServletWebRequest(servletRequest, filterPath) {
@Override
public boolean shouldPreserveClientUrl() {
boolean preserve = super.shouldPreserveClientUrl();
if (preserve) {
return true;
} else {
/*
* This snippet code tells Wicket not to append page instance number after the url
* for bookmarkable pages.
*/
return RequestCycle.get().getMetaData(PAGE_RENDERING_RESOLVED);
}
}
};
}
@Override
protected void init() {
super.init();

View File

@ -43,6 +43,7 @@ import com.pmease.gitop.web.page.home.HomePage;
import com.pmease.gitop.web.page.init.ServerInitPage;
import com.pmease.gitop.web.page.project.ProjectHomePage;
import com.pmease.gitop.web.page.test.TestPage;
import com.pmease.gitop.web.page.test.TestPage2;
import com.pmease.gitop.web.shiro.LoginPage;
import com.pmease.gitop.web.shiro.LogoutPage;
import com.pmease.gitop.web.shiro.ShiroWicketPlugin;
@ -169,6 +170,7 @@ public class GitopWebApp extends AbstractWicketConfig {
mountPage("settings/repos", AccountReposPage.class);
mountPage("/test", TestPage.class);
mountPage("test2", TestPage2.class);
// repository pages
// --------------------------------------------------------

View File

@ -109,17 +109,17 @@ public abstract class BasePage extends WebPage {
}
}
public final void redirectWithIntercept(final Class<? extends Page> clazz) {
public final void redirectWithInterception(final Class<? extends Page> clazz) {
shouldInitialize = true;
throw new RestartResponseAtInterceptPageException(clazz);
}
public final void redirectWithIntercept(final Class<? extends Page> clazz, final PageParameters pageParams) {
public final void redirectWithInterception(final Class<? extends Page> clazz, final PageParameters pageParams) {
shouldInitialize = true;
throw new RestartResponseAtInterceptPageException(clazz, pageParams);
}
public final void redirectWithIntercept(final Page page) {
public final void redirectWithInterception(final Page page) {
shouldInitialize = true;
throw new RestartResponseAtInterceptPageException(page);
}
@ -148,6 +148,7 @@ public abstract class BasePage extends WebPage {
public final void redirectToOriginal() {
shouldInitialize = false;
continueToOriginalDestination();
shouldInitialize = true;
}
protected String getPageCssClass() {

View File

@ -4,5 +4,6 @@
<div wicket:id="editor"></div>
<input type="submit" value="Save" class="btn btn-primary"></input>
</form>
<a wicket:id="reset">reset</a>
</div>
</wicket:extend>

View File

@ -1,6 +1,8 @@
package com.pmease.gitop.web.page.test;
import org.apache.wicket.Component;
import org.apache.wicket.ajax.AjaxRequestTarget;
import org.apache.wicket.ajax.markup.html.AjaxLink;
import org.apache.wicket.markup.html.form.Form;
import com.pmease.commons.editable.EditContext;
@ -14,10 +16,17 @@ import com.pmease.gitop.web.page.BasePage;
@SuppressWarnings("serial")
public class TestPage extends BasePage {
public static boolean ready = false;
public TestPage() {
if (!ready)
redirectWithInterception(TestPage2.class);
}
@Override
protected void onPageInitialize() {
super.onPageInitialize();
final EditContext editContext = EditableUtils.getContext(new Project());
Form<?> form = new Form<Void>("form") {
@ -38,6 +47,16 @@ public class TestPage extends BasePage {
form.add((Component) editContext.renderForEdit("editor"));
add(form);
add(new AjaxLink<Void>("reset") {
@Override
public void onClick(AjaxRequestTarget target) {
ready = false;
setResponsePage(TestPage.class);
}
});
}
@Override

View File

@ -0,0 +1,7 @@
<wicket:extend>
<div style="margin: 100px 200px;">
The second test page.
<a wicket:id="test">test</a>
<a wicket:id="complete">complete</a>
</div>
</wicket:extend>

View File

@ -0,0 +1,43 @@
package com.pmease.gitop.web.page.test;
import org.apache.wicket.markup.html.link.Link;
import com.pmease.gitop.web.page.BasePage;
@SuppressWarnings("serial")
public class TestPage2 extends BasePage {
public TestPage2() {
if (TestPage.ready)
redirectToOriginal();
}
@Override
protected void onPageInitialize() {
super.onPageInitialize();
add(new Link<Void>("test") {
@Override
public void onClick() {
}
});
add(new Link<Void>("complete") {
@Override
public void onClick() {
TestPage.ready = true;
setResponsePage(TestPage2.class);
}
});
}
@Override
protected String getPageTitle() {
return "Test page used by Robin";
}
}

View File

@ -0,0 +1,349 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.wicket.request.handler.render;
import java.util.List;
import org.apache.wicket.Application;
import org.apache.wicket.Session;
import org.apache.wicket.core.request.handler.RenderPageRequestHandler;
import org.apache.wicket.core.request.handler.RenderPageRequestHandler.RedirectPolicy;
import org.apache.wicket.feedback.FeedbackCollector;
import org.apache.wicket.feedback.FeedbackMessage;
import org.apache.wicket.protocol.http.BufferedWebResponse;
import org.apache.wicket.protocol.http.WebApplication;
import org.apache.wicket.request.IRequestHandler;
import org.apache.wicket.request.Request;
import org.apache.wicket.request.Url;
import org.apache.wicket.request.Url.QueryParameter;
import org.apache.wicket.request.component.IRequestablePage;
import org.apache.wicket.request.cycle.RequestCycle;
import org.apache.wicket.request.http.WebRequest;
import org.apache.wicket.request.http.WebResponse;
import org.apache.wicket.request.mapper.info.PageComponentInfo;
import org.apache.wicket.request.mapper.info.PageInfo;
import org.apache.wicket.util.string.Strings;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* {@link PageRenderer} for web applications.
*
* @author Matej Knopp
*/
public class WebPageRenderer extends PageRenderer
{
private static final Logger logger = LoggerFactory.getLogger(WebPageRenderer.class);
/**
* Construct.
*
* @param renderPageRequestHandler
*/
public WebPageRenderer(RenderPageRequestHandler renderPageRequestHandler)
{
super(renderPageRequestHandler);
}
private boolean isAjax(RequestCycle requestCycle)
{
boolean isAjax = false;
Request request = requestCycle.getRequest();
if (request instanceof WebRequest)
{
WebRequest webRequest = (WebRequest)request;
isAjax = webRequest.isAjax();
}
return isAjax;
}
/**
*
* @param url
* @param response
*/
protected void storeBufferedResponse(Url url, BufferedWebResponse response)
{
WebApplication.get().storeBufferedResponse(getSessionId(), url, response);
}
protected BufferedWebResponse getAndRemoveBufferedResponse(Url url)
{
return WebApplication.get().getAndRemoveBufferedResponse(getSessionId(), url);
}
/**
* Renders page to a {@link BufferedWebResponse}. All URLs in page will be rendered relative to
* <code>targetUrl</code>
*
* @param targetUrl
* @param requestCycle
* @return BufferedWebResponse containing page body
*/
protected BufferedWebResponse renderPage(Url targetUrl, RequestCycle requestCycle)
{
// get the page before checking for a scheduled request handler because
// the page may call setResponsePage in its constructor
IRequestablePage requestablePage = getPage();
IRequestHandler scheduled = requestCycle.getRequestHandlerScheduledAfterCurrent();
if (scheduled != null)
{
// no need to render
return null;
}
// keep the original response
final WebResponse originalResponse = (WebResponse)requestCycle.getResponse();
// buffered web response for page
BufferedWebResponse response = new BufferedWebResponse(originalResponse);
// keep the original base URL
Url originalBaseUrl = requestCycle.getUrlRenderer().setBaseUrl(targetUrl);
try
{
requestCycle.setResponse(response);
requestablePage.renderPage();
if (scheduled == null && requestCycle.getRequestHandlerScheduledAfterCurrent() != null)
{
// This is a special case.
// During page render another request handler got scheduled and will want to
// overwrite the response, so we need to let it.
// Just preserve the meta data headers. Clear the initial actions because they are
// already copied into the new response's actions
originalResponse.reset();
response.writeMetaData(originalResponse);
return null;
}
else
{
return response;
}
}
finally
{
// restore original response and base URL
requestCycle.setResponse(originalResponse);
requestCycle.getUrlRenderer().setBaseUrl(originalBaseUrl);
}
}
/**
*
* @param url
* @param requestCycle
*/
protected void redirectTo(Url url, RequestCycle requestCycle)
{
bindSessionIfNeeded();
WebResponse response = (WebResponse)requestCycle.getResponse();
String relativeUrl = requestCycle.getUrlRenderer().renderUrl(url);
response.sendRedirect(relativeUrl);
}
/**
* Bind the session if there are feedback messages pending.
* https://issues.apache.org/jira/browse/WICKET-5165
*/
private void bindSessionIfNeeded()
{
// check for session feedback messages only
FeedbackCollector collector = new FeedbackCollector();
List<FeedbackMessage> feedbackMessages = collector.collect();
if (feedbackMessages.size() > 0)
{
Session.get().bind();
}
}
/*
* TODO: simplify the code below. See WICKET-3347
*/
@Override
public void respond(RequestCycle requestCycle)
{
Url currentUrl = requestCycle.getUrlRenderer().getBaseUrl();
Url targetUrl = requestCycle.mapUrlFor(getRenderPageRequestHandler());
//
// the code below is little hairy but we have to handle 3 redirect policies,
// 3 rendering strategies and two kind of requests (ajax and normal)
//
// try to get an already rendered buffered response for current URL
BufferedWebResponse bufferedResponse = getAndRemoveBufferedResponse(currentUrl);
boolean isAjax = isAjax(requestCycle);
boolean shouldPreserveClientUrl = ((WebRequest)requestCycle.getRequest()).shouldPreserveClientUrl();
if (bufferedResponse != null)
{
logger.warn("The Buffered response should be handled by BufferedResponseRequestHandler");
// if there is saved response for this URL render it
bufferedResponse.writeTo((WebResponse)requestCycle.getResponse());
}
else if (getRedirectPolicy() == RedirectPolicy.NEVER_REDIRECT ||
(isOnePassRender() && isAjax == false && getRedirectPolicy() != RedirectPolicy.ALWAYS_REDIRECT) //
||
(!isAjax //
&&
(targetUrl.equals(currentUrl) && !getPageProvider().isNewPageInstance() && !getPage().isPageStateless()) //
|| (targetUrl.equals(currentUrl) && isRedirectToRender()) //
) //
|| shouldPreserveClientUrl) //
{
// if the policy is never to redirect
// or one pass render mode is on
// or the targetUrl matches current url and the page is not stateless
// or the targetUrl matches current url, page is stateless but it's redirect-to-render
// or the request determines that the current url should be preserved
// just render the page
BufferedWebResponse response = renderPage(currentUrl, requestCycle);
if (response != null)
{
response.writeTo((WebResponse)requestCycle.getResponse());
}
}
else if (getRedirectPolicy() == RedirectPolicy.ALWAYS_REDIRECT //
||
isRedirectToRender() //
|| (isAjax && targetUrl.equals(currentUrl)))
{
// if target URL is different
// and render policy is always-redirect or it's redirect-to-render
redirectTo(targetUrl, requestCycle);
}
else if (!targetUrl.equals(currentUrl) //
&&
(getPageProvider().isNewPageInstance() || (isSessionTemporary() && getPage().isPageStateless())))
{
// if target URL is different and session is temporary and page is stateless
// this is special case when page is stateless but there is no session so we can't
// render it to buffer
// alternatively if URLs are different and we have a page class and not an instance we
// can redirect to the url which will instantiate the instance of us
// note: if we had session here we would render the page to buffer and then redirect to
// URL generated *after* page has been rendered (the statelessness may change during
// render). this would save one redirect because now we have to render to URL generated
// *before* page is rendered, render the page, get URL after render and if the URL is
// different (meaning page is not stateless), save the buffer and redirect again (which
// is pretty much what the next step does)
redirectTo(targetUrl, requestCycle);
}
else
{
if (isRedirectToBuffer() == false && logger.isDebugEnabled())
{
String details = String.format(
"redirect strategy: '%s', isAjax: '%s', redirect policy: '%s', "
+ "current url: '%s', target url: '%s', is new: '%s', is stateless: '%s', is temporary: '%s'",
Application.get().getRequestCycleSettings().getRenderStrategy(), isAjax,
getRedirectPolicy(), currentUrl, targetUrl,
getPageProvider().isNewPageInstance(), getPage().isPageStateless(),
isSessionTemporary());
logger.debug("Falling back to Redirect_To_Buffer render strategy because none of the conditions " +
"matched. Details: " + details);
}
// force creation of possible stateful page to get the final target url
getPage();
Url beforeRenderUrl = requestCycle.mapUrlFor(getRenderPageRequestHandler());
// redirect to buffer
BufferedWebResponse response = renderPage(beforeRenderUrl, requestCycle);
if (response == null)
{
return;
}
// the url might have changed after page has been rendered (e.g. the
// stateless flag might have changed because stateful components
// were added)
final Url afterRenderUrl = requestCycle.mapUrlFor(getRenderPageRequestHandler());
if (beforeRenderUrl.getSegments().equals(afterRenderUrl.getSegments()) == false)
{
// the amount of segments is different - generated relative URLs
// will not work, we need to rerender the page. This can happen
// with IRequestHandlers that produce different URLs with
// different amount of segments for stateless and stateful pages
response = renderPage(afterRenderUrl, requestCycle);
}
if (currentUrl.equals(afterRenderUrl))
{
// no need to redirect when both urls are exactly the same
response.writeTo((WebResponse)requestCycle.getResponse());
}
// if page is still stateless after render
else if (getPage().isPageStateless() && !enableRedirectForStatelessPage())
{
// we don't want the redirect to happen for stateless page
// example:
// when a normal mounted stateful page is hit at /mount/point
// wicket renders the page to buffer and redirects to /mount/point?12
// but for stateless page the redirect is not necessary
// also for listener interface on stateful page we want to redirect
// after the listener is invoked, but on stateless page the user
// must ask for redirect explicitly
response.writeTo((WebResponse)requestCycle.getResponse());
}
else
{
Integer currentPageId = parsePageId(currentUrl);
Integer afterRenderPageId = parsePageId(afterRenderUrl);
if (currentPageId == null && afterRenderPageId != null) {
response.writeTo((WebResponse)requestCycle.getResponse());
} else {
storeBufferedResponse(afterRenderUrl, response);
redirectTo(afterRenderUrl, requestCycle);
}
}
}
}
private Integer parsePageId(Url url) {
for (QueryParameter queryParameter : url.getQueryParameters()) {
if (Strings.isEmpty(queryParameter.getValue())) {
PageComponentInfo pageComponentInfo = PageComponentInfo.parse(queryParameter.getName());
if (pageComponentInfo != null) {
PageInfo pageInfo = pageComponentInfo.getPageInfo();
if (pageInfo != null)
return pageInfo.getPageId();
else
return null;
}
}
}
return null;
}
}