Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WW-5379 Implement alternative mechanism for Velocity directives to obtain ValueStack #822

Merged
merged 4 commits into from
Jan 3, 2024
Merged

WW-5379 Implement alternative mechanism for Velocity directives to obtain ValueStack #822

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3dbc5c2
WW-5379 Implement alternative mechanism for Velocity directives to ob…
kusalk Dec 27, 2023
3eddd56
WW-5379 Add support for internal and chained contexts
kusalk Dec 27, 2023
450ee91
WW-5379 Fix not looking in chained contexts' chained contexts
kusalk Dec 27, 2023
ee600f9
WW-5379 Use ValueStackProvider marker interface for Velocity context …
kusalk Jan 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions plugins/velocity/src/main/java/org/apache/struts2/views/velocity/StrutsVelocityContext.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,10 +77,10 @@ public Object internalGet(String key) {
}

protected List<Function<String, Object>> contextGetterList() {
return Arrays.asList(this::superGet, this::chainedContextGet, this::stackGet);
return Arrays.asList(this::superInternalGet, this::chainedContextGet, this::stackGet);
}

protected Object superGet(String key) {
protected Object superInternalGet(String key) {
return super.internalGet(key);
}

Expand All @@ -96,11 +96,15 @@ protected Object chainedContextGet(String key) {
return null;
}
for (VelocityContext chainedContext : chainedContexts) {
Object val = chainedContext.internalGet(key);
Object val = chainedContext.get(key);
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was technically a bug as we were failing to look at chained contexts within our chained contexts

if (val != null) {
return val;
}
}
return null;
}

public ValueStack getValueStack() {
return stack;
}
Comment on lines +109 to +111
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to have this public? Also this requires to cast to StrutsVelocityContext, wouldn't be better to have a marking interface ValueStackAware or ValueStackProvider to expose the ValueStack?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it has to be but I wonder if Directives can simply obtain the ValueStack from the ActionContext? It's not clear to me if the ValueStack on the ActionContext changes between the time of Velocity context creation and directive rendering. I recall this was how the ValueStack was obtained in WebWork 2.1 but I presume it was changed for a reason?

But also, there's no change in terms of security as the stack was already exposed on the StrutsVelocityContext instance using internalGet("stack") or get("stack").

And yep I can definitely use a marker interface to allow more flexibility in the Velocity context implementation used by applications.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It shouldn't change as far I understand, yet I'm not sure if this is true :) Let's leave it as is, at some point I will solve this puzzle ;-)

}
52 changes: 39 additions & 13 deletions ...elocity/src/main/java/org/apache/struts2/views/velocity/components/AbstractDirective.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,26 +18,28 @@
*/
package org.apache.struts2.views.velocity.components;

import java.io.IOException;
import java.io.Writer;
import java.util.HashMap;
import java.util.Map;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import com.opensymphony.xwork2.inject.Container;
import com.opensymphony.xwork2.util.ValueStack;
import org.apache.struts2.ServletActionContext;
import org.apache.struts2.components.Component;
import org.apache.struts2.views.util.ContextUtil;
import org.apache.struts2.views.velocity.StrutsVelocityContext;
import org.apache.velocity.context.AbstractContext;
import org.apache.velocity.context.Context;
import org.apache.velocity.context.InternalContextAdapter;
import org.apache.velocity.context.InternalWrapperContext;
import org.apache.velocity.exception.MethodInvocationException;
import org.apache.velocity.exception.ParseErrorException;
import org.apache.velocity.exception.ResourceNotFoundException;
import org.apache.velocity.runtime.directive.Directive;
import org.apache.velocity.runtime.parser.node.Node;

import com.opensymphony.xwork2.ActionContext;
import com.opensymphony.xwork2.inject.Container;
import com.opensymphony.xwork2.util.ValueStack;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.Writer;
import java.util.HashMap;
import java.util.Map;

public abstract class AbstractDirective extends Directive {
public String getName() {
Expand All @@ -57,8 +59,11 @@ public int getType() {
protected abstract Component getBean(ValueStack stack, HttpServletRequest req, HttpServletResponse res);

public boolean render(InternalContextAdapter ctx, Writer writer, Node node) throws IOException, ResourceNotFoundException, ParseErrorException, MethodInvocationException {
// get the bean
ValueStack stack = (ValueStack) ctx.get("stack");
ValueStack stack = extractValueStack(ctx);
if (stack == null) {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This shouldn't occur but left it for backwards compatibility in case there is a scenario I didn't foresee

// Fallback to assuming the ValueStack was put into the Velocity context (as is by default)
stack = (ValueStack) ctx.get(ContextUtil.STACK);
}
HttpServletRequest req = (HttpServletRequest) stack.getContext().get(ServletActionContext.HTTP_REQUEST);
HttpServletResponse res = (HttpServletResponse) stack.getContext().get(ServletActionContext.HTTP_RESPONSE);
Component bean = getBean(stack, req, res);
Expand All @@ -79,6 +84,27 @@ public boolean render(InternalContextAdapter ctx, Writer writer, Node node) thro
return true;
}

private ValueStack extractValueStack(Context context) {
do {
if (context instanceof StrutsVelocityContext) {
return ((StrutsVelocityContext) context).getValueStack();
}
context = extractContext(context);
} while (context != null);

return null;
}

private Context extractContext(Context context) {
if (context instanceof InternalWrapperContext) {
return ((InternalWrapperContext) context).getInternalUserContext();
}
if (context instanceof AbstractContext) {
return ((AbstractContext) context).getChainedContext();
}
return null;
}

/**
* <p>
* Create a Map of properties that the user has passed in. For example:
Expand Down
4 changes: 2 additions & 2 deletions ...s/velocity/src/test/java/org/apache/struts2/views/velocity/StrutsVelocityContextTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ public void setUp() throws Exception {

@Test
public void getChainedValue() {
when(chainedContext.internalGet("foo")).thenReturn("bar");
when(chainedContext.get("foo")).thenReturn("bar");
assertEquals("bar", strutsVelocityContext.internalGet("foo"));
}

Expand All @@ -75,7 +75,7 @@ public void getValuePrecedence() {
when(stack.findValue("foo")).thenReturn("qux");
assertEquals("qux", strutsVelocityContext.internalGet("foo"));

when(chainedContext.internalGet("foo")).thenReturn("baz");
when(chainedContext.get("foo")).thenReturn("baz");
assertEquals("baz", strutsVelocityContext.internalGet("foo"));

strutsVelocityContext.put("foo", "bar");
Expand Down