This is an automated email from the ASF dual-hosted git repository.
mridulpathak pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/ofbiz-framework.git
The following commit(s) were added to refs/heads/trunk by this push:
new 70b9901e45 Fixed: HashMaps are not properly rendered in FTL with
current FTL integration (OFBIZ-13164) (#1615)
70b9901e45 is described below
commit 70b9901e4559d45eef186963b974b3f01fb3a142
Author: toaditi <[email protected]>
AuthorDate: Mon Aug 10 19:03:13 2026 +0530
Fixed: HashMaps are not properly rendered in FTL with current FTL
integration (OFBIZ-13164) (#1615)
Jira: https://issues.apache.org/jira/browse/OFBIZ-13164
Thanks to Carsten Schinzer for reporting this one, and for naming the
`BeansWrapper` versus `DefaultObjectWrapper` distinction in the report. That
turned out to be exactly the right thread to pull, and the note that a simple
fix did not work saved me from taking the wrong turn.
### What happens today
`FreeMarkerWorker` builds a plain `BeansWrapper`, so every `java.util.Map`
reaches templates as `freemarker.ext.beans.MapModel`. `MapModel.keySet()`
returns the union of the map's own keys and the bean property names of the map
object. On a two entry `LinkedHashMap` holding only `alpha` and `beta`:
| expression | result on trunk |
| --- | --- |
| `${aMap?size}` | `30` |
| `${aMap?keys?join(",")}` |
`getClass,getOrDefault,values,computeIfAbsent,replace,...,alpha,class,keySet,beta,entrySet,...`
|
| `<#list aMap as key, value>` | fails, because the values behind those
synthetic keys are methods rather than strings |
### Why I did not take either of the usual fixes
`GenericEntity` implements `Map`, so every `GenericValue` in a template is
a map as far as the wrapper is concerned. That makes both of the obvious
options quite wide:
- `DefaultObjectWrapper` also swaps `List` for `DefaultListAdapter` and
stops method calls generally, giving `NonHashException` on `${aList.size()}`
and `${aBean.getSomething()}`.
- `BeansWrapperBuilder.setSimpleMapWrapper(true)` is narrower, but still
ends `${aMap.get(...)}` and `${aMap.entrySet()}`, along with every
`${anEntity.getRelatedOne(...)}` and `${anEntity.getString(...)}`.
Framework templates alone use `.get(` in 161 files, `keySet()` in 14 and
`.size()` in 40, before counting plugins, so I was wary of changing the wrapper
wholesale.
### The change
`OfbizBeansWrapper` substitutes a `MapModel` whose key set is the map's
own, and overrides nothing else. `get()` is untouched, so member lookup still
falls back to the bean model and templates keep calling methods on maps,
including on `GenericValue`. `HtmlWidget.ExtendedWrapper` now extends it so
that screen rendering picks up the same behaviour.
Three files, 82 insertions, 3 deletions.
### Two secondary effects
- `?keys` now follows the map's iteration order rather than being arbitrary.
- An empty map now reports `?size` of `0`. On trunk it reports `28` while
`?has_content` already reports `false`, so this brings the two into agreement.
### Verification
- Full unit suite on this branch: 78 classes, 589 tests, 0 failures, 0
errors, 0 skipped.
- `checkstyleMain`, `codenarcMain`, `codenarcTest` and `javadoc` all pass,
and the new class compiles clean under `javac -Xlint:all`.
- Each expression in the tables above was checked against freemarker
2.3.34, the version the build pins, before and after the change, including the
`GenericValue` shaped case of a map that also exposes business methods.
These checks are all unit level; I have not yet exercised the change in a
running instance, so a second pair of eyes on the screen rendering path would
be very welcome.
I kept this patch to the production change alone. If reviewers would prefer
regression tests alongside it, I have them ready and would be glad to push them
to this branch. They cover the three built ins above, plus guards that method
access still works both on plain maps and on map backed entity values.
---
.../ofbiz/base/util/template/FreeMarkerWorker.java | 3 +-
.../base/util/template/OfbizBeansWrapper.java | 79 ++++++++++++++++++++++
.../org/apache/ofbiz/widget/model/HtmlWidget.java | 3 +-
3 files changed, 82 insertions(+), 3 deletions(-)
diff --git
a/framework/base/src/main/java/org/apache/ofbiz/base/util/template/FreeMarkerWorker.java
b/framework/base/src/main/java/org/apache/ofbiz/base/util/template/FreeMarkerWorker.java
index 35d540e279..57cb01b9b1 100644
---
a/framework/base/src/main/java/org/apache/ofbiz/base/util/template/FreeMarkerWorker.java
+++
b/framework/base/src/main/java/org/apache/ofbiz/base/util/template/FreeMarkerWorker.java
@@ -54,7 +54,6 @@ import freemarker.core.Environment;
import freemarker.core.TemplateClassResolver;
import freemarker.ext.beans.BeanModel;
import freemarker.ext.beans.BeansWrapper;
-import freemarker.ext.beans.BeansWrapperBuilder;
import freemarker.template.Configuration;
import freemarker.template.SimpleHash;
import freemarker.template.SimpleScalar;
@@ -80,7 +79,7 @@ public final class FreeMarkerWorker {
// or maybe not for performance reasons... hmmm, leave to config file...
private static final UtilCache<String, Template> CACHED_TEMPLATES =
UtilCache.createUtilCache("template.ftl.general", 0, 0, false);
- private static final BeansWrapper DEFAULT_OFBIZ_WRAPPER = new
BeansWrapperBuilder(VERSION).build();
+ private static final BeansWrapper DEFAULT_OFBIZ_WRAPPER = new
OfbizBeansWrapper(VERSION);
private static final TemplateHashModel DEFAULT_STATIC_MODELS =
getConfiguredStaticModel(getDefaultOfbizWrapper());
private static final Configuration DEFAULT_OFBIZ_CONFIG =
makeConfiguration(DEFAULT_OFBIZ_WRAPPER);
diff --git
a/framework/base/src/main/java/org/apache/ofbiz/base/util/template/OfbizBeansWrapper.java
b/framework/base/src/main/java/org/apache/ofbiz/base/util/template/OfbizBeansWrapper.java
new file mode 100644
index 0000000000..a440721e74
--- /dev/null
+++
b/framework/base/src/main/java/org/apache/ofbiz/base/util/template/OfbizBeansWrapper.java
@@ -0,0 +1,79 @@
+/*******************************************************************************
+ * 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.ofbiz.base.util.template;
+
+import java.util.LinkedHashSet;
+import java.util.Map;
+import java.util.Set;
+
+import freemarker.ext.beans.BeansWrapper;
+import freemarker.ext.beans.MapModel;
+import freemarker.template.TemplateModel;
+import freemarker.template.TemplateModelException;
+import freemarker.template.Version;
+
+/**
+ * The {@link BeansWrapper} that exposes Java objects to OFBiz FreeMarker
templates.
+ *
+ * <p>It behaves like {@code BeansWrapper} in every respect but one: for
{@link Map} values it
+ * enumerates only the map's own keys. FreeMarker's stock {@link MapModel}
reports the union of the
+ * map's keys and the bean property names of the map object, so {@code ?keys},
{@code ?values},
+ * {@code ?size} and {@code <#list aMap as key, value>} all see accessors such
as {@code getClass} or
+ * {@code entrySet} mixed in with the real entries (OFBIZ-13164).
+ *
+ * <p>Only key enumeration changes. Member lookup still falls back to the bean
model, so templates
+ * can keep calling methods on maps — including on {@code GenericValue}, which
implements {@code Map}.
+ */
+public class OfbizBeansWrapper extends BeansWrapper {
+
+ public OfbizBeansWrapper(Version version) {
+ super(version);
+ }
+
+ @Override
+ public TemplateModel wrap(Object object) throws TemplateModelException {
+ // A TemplateModel is left to the superclass, which passes it through
untouched even when it
+ // also happens to be a Map.
+ if (object instanceof Map && !(object instanceof TemplateModel)) {
+ return new MapEntryKeysModel((Map<?, ?>) object, this);
+ }
+ return super.wrap(object);
+ }
+
+ /**
+ * A {@link MapModel} that enumerates the map's own keys rather than the
union of those keys and
+ * the bean property names of the map object.
+ */
+ private static final class MapEntryKeysModel extends MapModel {
+ private final Map<?, ?> map;
+
+ MapEntryKeysModel(Map<?, ?> map, BeansWrapper wrapper) {
+ super(map, wrapper);
+ this.map = map;
+ }
+
+ @Override
+ protected Set<Object> keySet() {
+ // A modifiable copy: MapModel's own implementation adds to the
set it gets from BeanModel,
+ // while maps such as GenericEntity and MapContext return an
unmodifiable key set. Copying
+ // also preserves the map's iteration order.
+ return new LinkedHashSet<>(map.keySet());
+ }
+ }
+}
diff --git
a/framework/widget/src/main/java/org/apache/ofbiz/widget/model/HtmlWidget.java
b/framework/widget/src/main/java/org/apache/ofbiz/widget/model/HtmlWidget.java
index adb6a917a6..0a2fa1005b 100644
---
a/framework/widget/src/main/java/org/apache/ofbiz/widget/model/HtmlWidget.java
+++
b/framework/widget/src/main/java/org/apache/ofbiz/widget/model/HtmlWidget.java
@@ -42,6 +42,7 @@ import org.apache.ofbiz.base.util.cache.UtilCache;
import org.apache.ofbiz.base.util.collections.MapStack;
import org.apache.ofbiz.base.util.string.FlexibleStringExpander;
import org.apache.ofbiz.base.util.template.FreeMarkerWorker;
+import org.apache.ofbiz.base.util.template.OfbizBeansWrapper;
import org.apache.ofbiz.widget.renderer.ScreenRenderer;
import org.apache.ofbiz.widget.renderer.ScreenStringRenderer;
import org.apache.ofbiz.widget.renderer.html.HtmlWidgetRenderer;
@@ -77,7 +78,7 @@ public class HtmlWidget extends ModelScreenWidget {
SPECIAL_CONFIG_SQUARE_INTERPOLATION.setInterpolationSyntax(Configuration.SQUARE_BRACKET_INTERPOLATION_SYNTAX);
}
// not sure if this is the best way to get FTL to use my fancy MapModel
derivative, but should work at least...
- public static class ExtendedWrapper extends BeansWrapper {
+ public static class ExtendedWrapper extends OfbizBeansWrapper {
public ExtendedWrapper(Version version) {
super(version);
}
