Use generated field names for dynamic tables

Keep dynamic table labels as display text while using stable internal field keys. Add a regression test to verify generated field access with custom column names.

Author: sbrunner

core/src/main/java/org/mapfish/print/processor/jasper/TableProcessor.java

@@ -38,6 +38,7 @@
 import net.sf.jasperreports.engine.type.ScaleImageEnum;
 import net.sf.jasperreports.engine.type.StretchTypeEnum;
 import net.sf.jasperreports.engine.type.TextAdjustEnum;
+import net.sf.jasperreports.engine.util.JRStringUtil;
 import net.sf.jasperreports.engine.xml.JRXmlLoader;
 import net.sf.jasperreports.engine.xml.JRXmlWriter;
 import org.apache.commons.io.IOUtils;
@@ -254,15 +255,18 @@ public Output execute(final Input values, final ExecutionContext context) throws
     final Collection<Map<String, ?>> table = new ArrayList<>();
 
     final String[] columnNames = jsonTable.columns;
+    final String[] fieldNames = toFieldNames(columnNames);
 
     // this map needs to be linked so it keeps order
     Map<String, Class<?>> columns = new LinkedHashMap<>();
+    Map<String, String> columnLabels = new LinkedHashMap<>();
     final PArray[] jsonData = jsonTable.data;
     for (final PArray jsonRow : jsonData) {
       context.stopIfCanceled();
       final Map<String, Object> row = new HashMap<>();
       for (int j = 0; j < jsonRow.size(); j++) {
         final String columnName = columnNames[j];
+        final String fieldName = fieldNames[j];
         Object rowValue = jsonRow.get(j);
         if (rowValue == JSONObject.NULL) {
           rowValue = null;
@@ -275,16 +279,17 @@ public Output execute(final Input values, final ExecutionContext context) throws
           rowValue = tryConvert(values.clientHttpRequestFactoryProvider.get(), rowValue);
         }
         if (columns.size() < this.maxColumns && !this.excludeColumns.contains(columnName)) {
-          Class<?> columnDef = columns.get(columnName);
+          Class<?> columnDef = columns.get(fieldName);
           if (columnDef == null) {
             Class<?> rowValueClass = null;
             if (rowValue != null) {
               rowValueClass = rowValue.getClass();
             }
-            columns.put(columnName, rowValueClass);
+            columns.put(fieldName, rowValueClass);
+            columnLabels.put(fieldName, columnName);
           }
         }
-        row.put(columnName, rowValue);
+        row.put(fieldName, rowValue);
       }
       table.add(row);
     }
@@ -313,7 +318,7 @@ public Output execute(final Input values, final ExecutionContext context) throws
 
     String subreport = null;
     if (this.dynamic) {
-      subreport = generateSubReport(values, columns);
+      subreport = generateSubReport(values, columns, columnLabels);
     }
     final JRMapCollectionDataSource dataSource = new JRMapCollectionDataSource(table);
     return new Output(dataSource, table.size(), subreport);
@@ -341,6 +346,14 @@ private Object tryConvert(
 
   private String generateSubReport(final Input input, final Map<String, Class<?>> columns)
       throws JRException, IOException {
+    return generateSubReport(input, columns, new HashMap<>());
+  }
+
+  private String generateSubReport(
+      final Input input,
+      final Map<String, Class<?>> columns,
+      final Map<String, String> columnLabels)
+      throws JRException, IOException {
     byte[] bytes = loadJasperTemplate(input.template.getConfiguration());
     final JasperDesign templateDesign = JRXmlLoader.load(new ByteArrayInputStream(bytes));
 
@@ -352,7 +365,8 @@ private String generateSubReport(final Input input, final Map<String, Class<?>>
     final JRDesignSection detailSection = (JRDesignSection) templateDesign.getDetailSection();
     int detailHeight = detailSection.getBands()[0].getHeight();
 
-    populateTemplateDesign(columns, templateDesign, detailSection, headerHeight, detailHeight);
+    populateTemplateDesign(
+        columns, columnLabels, templateDesign, detailSection, headerHeight, detailHeight);
 
     final File jrxmlFile =
         File.createTempFile("table-", JASPER_REPORT_XML_FILE_EXT, input.tempTaskDirectory);
@@ -369,6 +383,7 @@ private String generateSubReport(final Input input, final Map<String, Class<?>>
 
   private void populateTemplateDesign(
       final Map<String, Class<?>> columns,
+      final Map<String, String> columnLabels,
       final JasperDesign templateDesign,
       final JRDesignSection detailSection,
       final int headerHeight,
@@ -416,6 +431,7 @@ private void populateTemplateDesign(
         columnHeaderStyle = templateDesign.getStylesMap().get(this.headerStyle);
       }
       String columnName = entry.getKey();
+      String columnLabel = columnLabels.getOrDefault(columnName, columnName);
       Class<?> valueClass = String.class;
       if (entry.getValue() != null) {
         valueClass = entry.getValue();
@@ -439,7 +455,7 @@ private void populateTemplateDesign(
           columnWidth,
           headerHeight,
           columnHeaderStyle,
-          columnName,
+          columnLabel,
           headerBand);
 
       // Add fields to the detailBand
@@ -518,7 +534,7 @@ private static void addHeaderFieldToHeaderBand(
       final int columnWidth,
       final int headerHeight,
       final JRStyle columnHeaderStyle,
-      final String columnName,
+      final String columnLabel,
       final JRDesignBand headerBand) {
     JRDesignTextField colHeaderField = new JRDesignTextField();
     colHeaderField.setX(headerPosX);
@@ -531,11 +547,23 @@ private static void addHeaderFieldToHeaderBand(
     colHeaderField.setStretchType(StretchTypeEnum.ELEMENT_GROUP_HEIGHT);
 
     JRDesignExpression headerExpression = new JRDesignExpression();
-    headerExpression.setText('"' + columnName + '"');
+    headerExpression.setText('"' + JRStringUtil.escapeJavaStringLiteral(columnLabel) + '"');
     colHeaderField.setExpression(headerExpression);
     headerBand.addElement(colHeaderField);
   }
 
+  private String[] toFieldNames(final String[] columnNames) {
+    if (!this.dynamic) {
+      return columnNames;
+    }
+
+    final String[] result = new String[columnNames.length];
+    for (int i = 0; i < columnNames.length; i++) {
+      result[i] = "col_" + i;
+    }
+    return result;
+  }
+
   private void addTextField(
       final String columnName,
       final JRDesignBand detailBand,

core/src/test/java/org/mapfish/print/processor/jasper/TableProcessorTest.java

@@ -1,6 +1,8 @@
 package org.mapfish.print.processor.jasper;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNull;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 
 import java.io.File;
 import java.io.IOException;
@@ -10,6 +12,7 @@
 import java.util.concurrent.atomic.AtomicBoolean;
 import net.sf.jasperreports.engine.JasperPrint;
 import net.sf.jasperreports.engine.data.JRMapCollectionDataSource;
+import net.sf.jasperreports.engine.design.JRDesignField;
 import org.junit.jupiter.api.Test;
 import org.mapfish.print.AbstractMapfishSpringTest;
 import org.mapfish.print.TestHttpClientFactory;
@@ -20,6 +23,7 @@
 import org.mapfish.print.output.OutputFormat;
 import org.mapfish.print.output.Values;
 import org.mapfish.print.test.util.ImageSimilarity;
+import org.mapfish.print.wrapper.json.PJsonArray;
 import org.mapfish.print.wrapper.json.PJsonObject;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.test.annotation.DirtiesContext;
@@ -196,4 +200,61 @@ public void testTableConvertersDynamic() throws Exception {
     // otherwise small differences are not detected!
     new ImageSimilarity(getFile(baseDir + "expectedImage.png")).assertSimilarity(print, 0, 0);
   }
+
+  @Test
+  public void testDynamicTableUsesGeneratedFieldNames() throws Exception {
+    final String baseDir = DYNAMIC_BASE_DIR;
+    final Configuration config = configurationFactory.getConfig(getFile(baseDir + "config.yaml"));
+    final Template template = config.getTemplate("main");
+    PJsonObject requestData = loadJsonRequestData(baseDir);
+
+    final PJsonObject table = requestData.getJSONObject("attributes").getJSONObject("table");
+    final PJsonArray columns = table.getJSONArray("columns");
+    final String customColumnName = "id \"value\" {v2}";
+    columns.getInternalArray().put(1, customColumnName);
+
+    Values values =
+        new Values(
+            new HashMap<>(),
+            requestData,
+            template,
+            getTaskDirectory(),
+            this.httpRequestFactory,
+            new File("."),
+            HTTP_REQUEST_MAX_NUMBER_FETCH_RETRY,
+            HTTP_REQUEST_FETCH_RETRY_INTERVAL_MILLIS,
+            new AtomicBoolean(false));
+    forkJoinPool.invoke(template.getProcessorGraph().createTask(values));
+
+    final JRMapCollectionDataSource tableDataSource =
+        values.getObject("tableDataSource", JRMapCollectionDataSource.class);
+    assertTrue(tableDataSource.next());
+
+    final JRDesignField safeField = new JRDesignField();
+    safeField.setName("col_1");
+    assertEquals(1, tableDataSource.getFieldValue(safeField));
+
+    final JRDesignField injectedField = new JRDesignField();
+    injectedField.setName(customColumnName);
+    assertNull(tableDataSource.getFieldValue(injectedField));
+  }
+
+  @Test
+  public void testDefaultDynamicTablePrintWithQuotedHeader() throws Exception {
+    final String baseDir = DEFAULT_DYNAMIC_BASE_DIR;
+    final Configuration config = configurationFactory.getConfig(getFile(baseDir + "config.yaml"));
+    PJsonObject requestData =
+        parseJSONObjectFromFile(TableProcessorTest.class, baseDir + "requestData-quoted.json");
+
+    final AbstractJasperReportOutputFormat format =
+        (AbstractJasperReportOutputFormat) this.outputFormat.get("pngOutputFormat");
+    final File file = getFile(TableProcessorTest.class, baseDir);
+    JasperPrint print =
+        format
+            .getJasperPrint(new HashMap<>(), requestData, config, file, getTaskDirectory())
+            .print();
+
+    new ImageSimilarity(getFile(baseDir + "expectedImage-quoted.png"))
+        .assertSimilarity(print, 0, 0);
+  }
 }

core/src/test/resources/org/mapfish/print/processor/jasper/table-dynamic-defaults/expectedImage-quoted.png

@@ -0,0 +1,14 @@
+{
+  "layout": "main",
+  "attributes": {
+    "table": {
+      "columns": ["exclude", "id", "icon", "name", "last ' \""],
+      "data": [
+        ["excluded", 1, "file://logo.png", "name1", "last1 ' \""],
+        ["excluded", 2, "file://logo.png", "name2", "last2 ' \""],
+        ["excluded", 3, "file://logo.png", "name3", "last3 ' \""],
+        ["excluded", 4, "file://logo.png", "name4", "last4 ' \""]
+      ]
+    }
+  }
+}