WW-3037 Anchor tag should be able to build URLs like the URL tag does

git-svn-id: https://svn.apache.org/repos/asf/struts/struts2/trunk@753015 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Musachy Barroso
2009-03-12 21:00:23 +00:00
parent 148e3a3b39
commit 649ce30681
18 changed files with 1613 additions and 343 deletions
@@ -26,23 +26,30 @@ import org.apache.struts2.views.java.TagGenerator;
import java.io.IOException;
import java.util.Map;
import com.opensymphony.xwork2.util.TextUtils;
public class AnchorHandler extends AbstractTagHandler implements TagGenerator {
public void generate() throws IOException {
Map<String, Object> params = context.getParameters();
Attributes attrs = new Attributes();
attrs.addIfExists("name", params.get("name"))
.addIfExists("id", params.get("id"))
.addIfExists("class", params.get("cssClass"))
.addIfExists("style", params.get("cssStyle"))
.addIfExists("href", params.get("href"), false)
.addIfExists("title", params.get("title"))
.addIfExists("tabindex", params.get("tabindex"));
start("a", attrs);
//all rendering must happend at the end of the tag, so we can support nested params
}
public static class CloseHandler extends AbstractTagHandler implements TagGenerator {
public void generate() throws IOException {
Map<String, Object> params = context.getParameters();
Attributes attrs = new Attributes();
attrs.addIfExists("name", params.get("name"))
.addIfExists("id", params.get("id"))
.addIfExists("class", params.get("cssClass"))
.addIfExists("style", params.get("cssStyle"))
.addIfExists("href", params.get("href"), false)
.addIfExists("title", params.get("title"))
.addIfExists("tabindex", params.get("tabindex"));
start("a", attrs);
String body = (String) params.get("body");
if (TextUtils.stringSet(body))
characters(body, false);
end("a");
}
}
@@ -22,8 +22,9 @@ package org.apache.struts2.views.java.simple;
import org.apache.struts2.components.Anchor;
import org.apache.struts2.components.UIBean;
import org.apache.struts2.components.ServletUrlRenderer;
public class AnchorTest extends AbstractCommonAttributesTest {
public class AnchorTest extends AbstractTest {
private Anchor tag;
public void testRenderAnchor() {
@@ -49,6 +50,7 @@ public class AnchorTest extends AbstractCommonAttributesTest {
protected void setUp() throws Exception {
super.setUp();
this.tag = new Anchor(stack, request, response);
this.tag.setUrlRenderer(new ServletUrlRenderer());
}
@Override
@@ -52,33 +52,35 @@ public class PortletUrlRenderer implements UrlRenderer {
/**
* {@inheritDoc}
*/
public void renderUrl(Writer writer, URL urlComponent) {
if(PortletActionContext.getPortletContext() == null || "none".equalsIgnoreCase(urlComponent.portletUrlType)) {
public void renderUrl(Writer writer, UrlProvider urlComponent) {
if(PortletActionContext.getPortletContext() == null || "none".equalsIgnoreCase(urlComponent.getPortletUrlType())) {
servletRenderer.renderUrl(writer, urlComponent);
}
else {
String action = null;
if(urlComponent.action != null) {
action = urlComponent.findString(urlComponent.action);
if(urlComponent.getAction() != null) {
action = urlComponent.findString(urlComponent.getAction());
}
String scheme = urlComponent.req.getScheme();
String scheme = urlComponent.getHttpServletRequest().getScheme();
if (urlComponent.scheme != null) {
scheme = urlComponent.scheme;
if (urlComponent.getScheme() != null) {
scheme = urlComponent.getScheme();
}
String result;
urlComponent.namespace = urlComponent.determineNamespace(urlComponent.namespace, urlComponent.stack, urlComponent.req);
urlComponent.setNamespace(urlComponent.determineNamespace(urlComponent.getNamespace(), urlComponent.getStack(), urlComponent.getHttpServletRequest()));
if (onlyActionSpecified(urlComponent)) {
result = PortletUrlHelper.buildUrl(action, urlComponent.namespace, urlComponent.method, urlComponent.parameters, urlComponent.portletUrlType, urlComponent.portletMode, urlComponent.windowState);
result = PortletUrlHelper.buildUrl(action, urlComponent.getNamespace(), urlComponent.getMethod(), urlComponent.getParameters(), urlComponent.getPortletUrlType(),
urlComponent.getPortletMode(), urlComponent.getWindowState());
} else if(onlyValueSpecified(urlComponent)){
result = PortletUrlHelper.buildResourceUrl(urlComponent.value, urlComponent.parameters);
result = PortletUrlHelper.buildResourceUrl(urlComponent.getValue(), urlComponent.getParameters());
}
else {
result = createDefaultUrl(urlComponent);
}
if ( urlComponent.anchor != null && urlComponent.anchor.length() > 0 ) {
result += '#' + urlComponent.findString(urlComponent.anchor);
String anchor = urlComponent.getAnchor();
if (TextUtils.stringSet(anchor)) {
result += '#' + urlComponent.findString(anchor);
}
String var = urlComponent.getVar();
@@ -87,7 +89,7 @@ public class PortletUrlRenderer implements UrlRenderer {
urlComponent.putInContext(result);
// add to the request and page scopes as well
urlComponent.req.setAttribute(var, result);
urlComponent.getHttpServletRequest().setAttribute(var, result);
} else {
try {
writer.write(result);
@@ -98,21 +100,22 @@ public class PortletUrlRenderer implements UrlRenderer {
}
}
private String createDefaultUrl(URL urlComponent) {
private String createDefaultUrl(UrlProvider urlComponent) {
String result;
ActionInvocation ai = (ActionInvocation)urlComponent.getStack().getContext().get(
ActionContext.ACTION_INVOCATION);
String action = ai.getProxy().getActionName();
result = PortletUrlHelper.buildUrl(action, urlComponent.namespace, urlComponent.method, urlComponent.parameters, urlComponent.portletUrlType, urlComponent.portletMode, urlComponent.windowState);
result = PortletUrlHelper.buildUrl(action, urlComponent.getNamespace(), urlComponent.getMethod(), urlComponent.getParameters(),
urlComponent.getPortletUrlType(), urlComponent.getPortletMode(), urlComponent.getWindowState());
return result;
}
private boolean onlyValueSpecified(URL urlComponent) {
return urlComponent.value != null && urlComponent.action == null;
private boolean onlyValueSpecified(UrlProvider urlComponent) {
return urlComponent.getValue() != null && urlComponent.getAction() == null;
}
private boolean onlyActionSpecified(URL urlComponent) {
return urlComponent.value == null && urlComponent.action != null;
private boolean onlyActionSpecified(UrlProvider urlComponent) {
return urlComponent.getValue() == null && urlComponent.getAction() != null;
}
/**
@@ -163,7 +166,7 @@ public class PortletUrlRenderer implements UrlRenderer {
}
public void beforeRenderUrl(URL urlComponent) {
public void beforeRenderUrl(UrlProvider urlComponent) {
if(PortletActionContext.getPortletContext() == null) {
servletRenderer.beforeRenderUrl(urlComponent);
}
@@ -1,44 +1,44 @@
/*
* $Id$
*
* 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.
*/
/*
* $Id$
*
* 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.struts2.components;
import java.io.IOException;
import java.io.IOException;
import java.io.StringWriter;
import java.io.Writer;
import java.io.Writer;
import java.util.HashMap;
import java.util.Map;
import javax.portlet.PortletMode;
import javax.portlet.PortletURL;
import org.apache.struts2.StrutsStatics;
import org.apache.struts2.StrutsStatics;
import org.apache.struts2.StrutsTestCase;
import org.apache.struts2.portlet.PortletActionConstants;
import org.apache.struts2.portlet.context.PortletActionContext;
import org.apache.struts2.portlet.context.PortletActionContext;
import org.apache.struts2.portlet.servlet.PortletServletRequest;
import org.apache.struts2.portlet.servlet.PortletServletResponse;
import org.easymock.EasyMock;
import org.easymock.EasyMock;
import org.springframework.mock.web.portlet.MockPortalContext;
import org.springframework.mock.web.portlet.MockPortletContext;
import org.springframework.mock.web.portlet.MockPortletContext;
import org.springframework.mock.web.portlet.MockPortletURL;
import org.springframework.mock.web.portlet.MockRenderRequest;
import org.springframework.mock.web.portlet.MockRenderResponse;
@@ -50,45 +50,45 @@ import com.opensymphony.xwork2.util.ValueStack;
public class PortletUrlRendererTest extends StrutsTestCase {
PortletUrlRenderer renderer;
MockPortletURL renderUrl;
MockPortletURL actionUrl;
MockRenderRequest request;
MockRenderResponse response;
MockPortletContext context;
ActionContext ctx;
PortletUrlRenderer renderer;
MockPortletURL renderUrl;
MockPortletURL actionUrl;
MockRenderRequest request;
MockRenderResponse response;
MockPortletContext context;
ActionContext ctx;
ValueStack stack;
public void setUp() throws Exception {
super.setUp();
renderer = new PortletUrlRenderer();
context = new MockPortletContext();
renderUrl = new MockPortletURL(
new MockPortalContext(), "render");
actionUrl = new MockPortletURL(
new MockPortalContext(), "action");
request = new MockRenderRequest();
response = new MockRenderResponse() {
@Override
public PortletURL createActionURL() {
return actionUrl;
}
@Override
public PortletURL createRenderURL() {
return renderUrl;
}
};
ctx = ActionContext.getContext();
ctx.put(PortletActionConstants.PHASE,
PortletActionConstants.RENDER_PHASE);
ctx.put(PortletActionConstants.REQUEST, request);
ctx.put(PortletActionConstants.RESPONSE, response);
ctx.put(StrutsStatics.STRUTS_PORTLET_CONTEXT, context);
Map<PortletMode, String> modeMap = new HashMap<PortletMode, String>();
modeMap.put(PortletMode.VIEW, "/view");
ctx.put(PortletActionConstants.MODE_NAMESPACE_MAP, modeMap);
renderer = new PortletUrlRenderer();
context = new MockPortletContext();
renderUrl = new MockPortletURL(
new MockPortalContext(), "render");
actionUrl = new MockPortletURL(
new MockPortalContext(), "action");
request = new MockRenderRequest();
response = new MockRenderResponse() {
@Override
public PortletURL createActionURL() {
return actionUrl;
}
@Override
public PortletURL createRenderURL() {
return renderUrl;
}
};
ctx = ActionContext.getContext();
ctx.put(PortletActionConstants.PHASE,
PortletActionConstants.RENDER_PHASE);
ctx.put(PortletActionConstants.REQUEST, request);
ctx.put(PortletActionConstants.RESPONSE, response);
ctx.put(StrutsStatics.STRUTS_PORTLET_CONTEXT, context);
Map<PortletMode, String> modeMap = new HashMap<PortletMode, String>();
modeMap.put(PortletMode.VIEW, "/view");
ctx.put(PortletActionConstants.MODE_NAMESPACE_MAP, modeMap);
stack = ctx.getValueStack();
}
@@ -112,7 +112,7 @@ public class PortletUrlRendererTest extends StrutsTestCase {
ctx.setActionInvocation(ai);
StringWriter renderOutput = new StringWriter();
renderer.renderUrl(renderOutput, url);
renderer.renderUrl(renderOutput, url.getUrlProvider());
String action = renderUrl
.getParameter(PortletActionConstants.ACTION_PARAM);
@@ -143,95 +143,95 @@ public class PortletUrlRendererTest extends StrutsTestCase {
String action = actionUrl
.getParameter(PortletActionConstants.ACTION_PARAM);
assertEquals("/view/current_namespace/testAction", action);
}
public void testShouldEvaluateActionAsOGNLExpression() throws Exception {
TestObject obj = new TestObject();
obj.someProperty = "EvaluatedProperty";
stack.push(obj);
MockActionInvocation ai = new MockActionInvocation();
MockActionProxy ap = new MockActionProxy();
ap.setActionName("testAction");
ap.setNamespace("");
ai.setProxy(ap);
ai.setStack(stack);
ctx.setActionInvocation(ai);
URL url = new URL(stack, new PortletServletRequest(request, null),
new PortletServletResponse(response));
url.setAction("%{someProperty}");
StringWriter renderOutput = new StringWriter();
renderer.renderUrl(renderOutput, url);
String action = renderUrl
.getParameter(PortletActionConstants.ACTION_PARAM);
assertEquals("/view/EvaluatedProperty", action);
}
public void testShouldEvaluateAnchorAsOGNLExpression() throws Exception {
TestObject obj = new TestObject();
obj.someProperty = "EvaluatedProperty";
stack.push(obj);
MockActionInvocation ai = new MockActionInvocation();
MockActionProxy ap = new MockActionProxy();
ap.setActionName("testAction");
ap.setNamespace("");
ai.setProxy(ap);
ai.setStack(stack);
ctx.setActionInvocation(ai);
URL url = new URL(stack, new PortletServletRequest(request, null),
new PortletServletResponse(response));
url.setAnchor("%{someProperty}");
StringWriter renderOutput = new StringWriter();
renderer.renderUrl(renderOutput, url);
assertTrue(renderOutput.toString().indexOf("#EvaluatedProperty") != -1);
}
public void testShouldPassThroughRenderUrlToServletUrlRendererIfNotPortletRequest() throws Exception {
UrlRenderer mockRenderer = EasyMock.createMock(UrlRenderer.class);
ActionContext.getContext().put(StrutsStatics.STRUTS_PORTLET_CONTEXT, null);
renderer.setServletRenderer(mockRenderer);
URL url = new URL(stack, new PortletServletRequest(request, null), new PortletServletResponse(response));
StringWriter renderOutput = new StringWriter();
mockRenderer.renderUrl(renderOutput, url);
EasyMock.replay(mockRenderer);
renderer.renderUrl(renderOutput, url);
EasyMock.verify(mockRenderer);
}
public void testShouldPassThroughRenderFormUrlToServletUrlRendererIfNotPortletRequest() throws Exception {
UrlRenderer mockRenderer = EasyMock.createMock(UrlRenderer.class);
ActionContext.getContext().put(StrutsStatics.STRUTS_PORTLET_CONTEXT, null);
renderer.setServletRenderer(mockRenderer);
Form form = new Form(stack, new PortletServletRequest(request, null), new PortletServletResponse(response));
mockRenderer.renderFormUrl(form);
EasyMock.replay(mockRenderer);
renderer.renderFormUrl(form);
EasyMock.verify(mockRenderer);
}
public void testShouldPassThroughRenderUrlToServletUrlRendererWhenPortletUrlTypeIsNone() throws Exception {
UrlRenderer mockRenderer = EasyMock.createMock(UrlRenderer.class);
renderer.setServletRenderer(mockRenderer);
URL url = new URL(stack, new PortletServletRequest(request, null), new PortletServletResponse(response));
url.setPortletUrlType("none");
StringWriter renderOutput = new StringWriter();
mockRenderer.renderUrl(renderOutput, url);
EasyMock.replay(mockRenderer);
renderer.renderUrl(renderOutput, url);
EasyMock.verify(mockRenderer);
}
private final static class TestObject {
public String someProperty;
}
}
public void testShouldEvaluateActionAsOGNLExpression() throws Exception {
TestObject obj = new TestObject();
obj.someProperty = "EvaluatedProperty";
stack.push(obj);
MockActionInvocation ai = new MockActionInvocation();
MockActionProxy ap = new MockActionProxy();
ap.setActionName("testAction");
ap.setNamespace("");
ai.setProxy(ap);
ai.setStack(stack);
ctx.setActionInvocation(ai);
URL url = new URL(stack, new PortletServletRequest(request, null),
new PortletServletResponse(response));
url.setAction("%{someProperty}");
StringWriter renderOutput = new StringWriter();
renderer.renderUrl(renderOutput, url.getUrlProvider());
String action = renderUrl
.getParameter(PortletActionConstants.ACTION_PARAM);
assertEquals("/view/EvaluatedProperty", action);
}
public void testShouldEvaluateAnchorAsOGNLExpression() throws Exception {
TestObject obj = new TestObject();
obj.someProperty = "EvaluatedProperty";
stack.push(obj);
MockActionInvocation ai = new MockActionInvocation();
MockActionProxy ap = new MockActionProxy();
ap.setActionName("testAction");
ap.setNamespace("");
ai.setProxy(ap);
ai.setStack(stack);
ctx.setActionInvocation(ai);
URL url = new URL(stack, new PortletServletRequest(request, null),
new PortletServletResponse(response));
url.setAnchor("%{someProperty}");
StringWriter renderOutput = new StringWriter();
renderer.renderUrl(renderOutput, url.getUrlProvider());
assertTrue(renderOutput.toString().indexOf("#EvaluatedProperty") != -1);
}
public void testShouldPassThroughRenderUrlToServletUrlRendererIfNotPortletRequest() throws Exception {
UrlRenderer mockRenderer = EasyMock.createMock(UrlRenderer.class);
ActionContext.getContext().put(StrutsStatics.STRUTS_PORTLET_CONTEXT, null);
renderer.setServletRenderer(mockRenderer);
URL url = new URL(stack, new PortletServletRequest(request, null), new PortletServletResponse(response));
StringWriter renderOutput = new StringWriter();
mockRenderer.renderUrl(renderOutput, url.getUrlProvider());
EasyMock.replay(mockRenderer);
renderer.renderUrl(renderOutput, url.getUrlProvider());
EasyMock.verify(mockRenderer);
}
public void testShouldPassThroughRenderFormUrlToServletUrlRendererIfNotPortletRequest() throws Exception {
UrlRenderer mockRenderer = EasyMock.createMock(UrlRenderer.class);
ActionContext.getContext().put(StrutsStatics.STRUTS_PORTLET_CONTEXT, null);
renderer.setServletRenderer(mockRenderer);
Form form = new Form(stack, new PortletServletRequest(request, null), new PortletServletResponse(response));
mockRenderer.renderFormUrl(form);
EasyMock.replay(mockRenderer);
renderer.renderFormUrl(form);
EasyMock.verify(mockRenderer);
}
public void testShouldPassThroughRenderUrlToServletUrlRendererWhenPortletUrlTypeIsNone() throws Exception {
UrlRenderer mockRenderer = EasyMock.createMock(UrlRenderer.class);
renderer.setServletRenderer(mockRenderer);
URL url = new URL(stack, new PortletServletRequest(request, null), new PortletServletResponse(response));
url.setPortletUrlType("none");
StringWriter renderOutput = new StringWriter();
mockRenderer.renderUrl(renderOutput, url.getUrlProvider());
EasyMock.replay(mockRenderer);
renderer.renderUrl(renderOutput, url.getUrlProvider());
EasyMock.verify(mockRenderer);
}
private final static class TestObject {
public String someProperty;
}
}