From a6eced07615e87309c09c68a90e0e11cb40f8fda Mon Sep 17 00:00:00 2001 From: zhengwr Date: Thu, 25 Jun 2026 23:01:45 +0800 Subject: [PATCH 1/2] =?UTF-8?q?feat(report):=20pdf/xls=20=E5=AF=BC?= =?UTF-8?q?=E5=87=BA=E5=8A=A0=20Content-Disposition=20attachment=20+=20?= =?UTF-8?q?=E4=B8=AD=E6=96=87=E6=96=87=E4=BB=B6=E5=90=8D?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 报表查看器 iframe 用 format=html(inline 内嵌);导出按钮用 format=pdf|xls,端点须触发 下载而非内嵌渲染。render() 对 pdf/xls 设 Content-Disposition: attachment;文件名取报表名 (view_template.name,经 RFC5987 filename*=UTF-8'' 编码中文,ASCII 回退 filename="." 供老客户端);html 不设此头(查看器内嵌不变)。 - ReportTemplateRepository.loadReportName(templateId):取 view_template.name 作文件名,最佳努力 (找不到/异常返 null → 回退 templateId,绝不因取名失败影响渲染)。 - contentDisposition(fmt,name,templateId)/sanitizeFilename:纯函数。sanitizeFilename 剔除 CR/LF/引号/反斜杠/正斜杠/控制符,杜绝响应头注入(CRLF 拆头)与 filename 属性逃逸。 filename* 修正为 RFC5987 attr-char 口径(空格→%20、*→%2A)。 - ReportDownloadTest:5 单测(html 无头/pdf RFC5987 中文名/xls 扩展/注入中和/空名回退 templateId)。 真验(curl):pdf/xls 回 attachment + filename*=UTF-8''在建项目收付款信息表.{pdf,xls};html 无 Content-Disposition。 Co-Authored-By: Claude Opus 4.8 (1M context) --- .../platform/report/ReportController.java | 55 +++++++++++++++++- .../report/ReportTemplateRepository.java | 23 ++++++++ .../platform/report/ReportDownloadTest.java | 58 +++++++++++++++++++ 3 files changed, 133 insertions(+), 3 deletions(-) create mode 100644 platform-report/src/test/java/com/eip4/platform/report/ReportDownloadTest.java diff --git a/platform-report/src/main/java/com/eip4/platform/report/ReportController.java b/platform-report/src/main/java/com/eip4/platform/report/ReportController.java index c7cc2f2..8fcda6a 100644 --- a/platform-report/src/main/java/com/eip4/platform/report/ReportController.java +++ b/platform-report/src/main/java/com/eip4/platform/report/ReportController.java @@ -13,6 +13,7 @@ import java.util.Set; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.beans.factory.annotation.Value; +import org.springframework.http.HttpHeaders; import org.springframework.http.HttpStatus; import org.springframework.http.MediaType; import org.springframework.http.ResponseEntity; @@ -94,9 +95,17 @@ public class ReportController { "读取/渲染报表模板失败: " + e.getMessage(), e); } - return ResponseEntity.ok() - .contentType(MediaType.parseMediaType(fmt.contentType())) - .body(body); + ResponseEntity.BodyBuilder rb = ResponseEntity.ok() + .contentType(MediaType.parseMediaType(fmt.contentType())); + // pdf/xls(导出按钮)→ attachment 触发下载,文件名取报表名;html(查看器 iframe)→ inline 内嵌。 + if (fmt != ReportService.Format.HTML) { + String reportName = templateRepository.loadReportName(templateId); + String disposition = contentDisposition(fmt, reportName, templateId); + if (disposition != null) { + rb.header(HttpHeaders.CONTENT_DISPOSITION, disposition); + } + } + return rb.body(body); } /** @@ -176,6 +185,46 @@ public class ReportController { return env; } + /** + * 构造导出下载的 {@code Content-Disposition} 头值。 + *
    + *
  • {@code html} → {@code null}(查看器 iframe 内嵌,inline);
  • + *
  • {@code pdf}/{@code xls} → {@code attachment},中文报表名经 RFC5987 {@code filename*=UTF-8''} 编码, + * ASCII 回退 {@code filename="."}(UUID 安全,老客户端兜底)。
  • + *
+ * 文件名经 {@link #sanitizeFilename} 净化(剔除 CRLF/引号/斜杠/控制符),杜绝响应头注入与属性逃逸。纯函数,便于单测。 + */ + static String contentDisposition(ReportService.Format fmt, String reportName, String templateId) { + if (fmt == ReportService.Format.HTML) { + return null; + } + String ext = fmt == ReportService.Format.PDF ? "pdf" : "xls"; + String base = sanitizeFilename(reportName); + if (base.isEmpty()) { + base = sanitizeFilename(templateId); + } + if (base.isEmpty()) { + base = "report"; + } + // RFC5987 ext-value:URLEncoder 是 x-www-form-urlencoded(空格→+,且保留 * 不编码), + // 修正成 RFC5987 attr-char 口径——空格→%20、* →%2A(. - _ 本就是合法 attr-char)。 + String encoded = URLEncoder.encode(base + "." + ext, StandardCharsets.UTF_8) + .replace("+", "%20").replace("*", "%2A"); + String ascii = sanitizeFilename(templateId == null ? "" : templateId.replaceAll("[^\\x20-\\x7E]", "_")); + if (ascii.isEmpty()) { + ascii = "report"; + } + return "attachment; filename=\"" + ascii + "." + ext + "\"; filename*=UTF-8''" + encoded; + } + + /** 文件名净化:剔除 CR/LF/引号/反斜杠/正斜杠/控制字符,杜绝响应头注入(CRLF 拆头)与路径/属性逃逸。 */ + private static String sanitizeFilename(String s) { + if (s == null) { + return ""; + } + return s.replaceAll("[\\r\\n\"\\\\/\\x00-\\x1F\\x7F]", "").trim(); + } + /** templateId / ?tpl 解析为模板文件路径。 */ private Path resolveTemplate(String templateId, String tplPath) { Path xml; diff --git a/platform-report/src/main/java/com/eip4/platform/report/ReportTemplateRepository.java b/platform-report/src/main/java/com/eip4/platform/report/ReportTemplateRepository.java index 2fb62c1..446c38a 100644 --- a/platform-report/src/main/java/com/eip4/platform/report/ReportTemplateRepository.java +++ b/platform-report/src/main/java/com/eip4/platform/report/ReportTemplateRepository.java @@ -30,6 +30,10 @@ public class ReportTemplateRepository { private static final String LOAD_SQL = "SELECT xml::text FROM eip3.view_template WHERE trim(view_template_id) = ? AND type = 200"; + /** 报表名(view_template.name),供导出文件名;限定 type=200。 */ + private static final String NAME_SQL = + "SELECT name FROM eip3.view_template WHERE trim(view_template_id) = ? AND type = 200"; + private final JdbcTemplate jdbcTemplate; public ReportTemplateRepository(JdbcTemplate jdbcTemplate) { @@ -61,6 +65,25 @@ public class ReportTemplateRepository { return jor; } + /** + * 报表名(view_template.name),供导出 PDF/XLS 的文件名。最佳努力:找不到/异常返回 {@code null} + * (导出端点回退用 templateId 作文件名,绝不因取名失败影响渲染)。 + */ + public String loadReportName(String templateId) { + String id = templateId == null ? "" : templateId.trim(); + try { + List rows = jdbcTemplate.queryForList(NAME_SQL, String.class, id); + if (rows.isEmpty()) { + return null; + } + String name = rows.get(0); + return name == null || name.isBlank() ? null : name.trim(); + } catch (RuntimeException e) { + log.debug("取报表名失败 templateId={} : {}", id, e.getMessage()); + return null; + } + } + /** * 从 {@code } 外壳里抽出 {@code } 内层 JOR 文档。 * diff --git a/platform-report/src/test/java/com/eip4/platform/report/ReportDownloadTest.java b/platform-report/src/test/java/com/eip4/platform/report/ReportDownloadTest.java new file mode 100644 index 0000000..0a49ea0 --- /dev/null +++ b/platform-report/src/test/java/com/eip4/platform/report/ReportDownloadTest.java @@ -0,0 +1,58 @@ +package com.eip4.platform.report; + +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertNull; +import static org.junit.jupiter.api.Assertions.assertTrue; + +import org.junit.jupiter.api.Test; + +/** + * 报表导出下载头(Content-Disposition)的纯逻辑单测。 + * + *

查看器 iframe 用 {@code format=html}(inline,内嵌渲染);导出按钮用 {@code format=pdf|xls} + * → 端点须回 {@code Content-Disposition: attachment} 触发下载,文件名取报表名(中文经 RFC5987 + * {@code filename*=UTF-8''} 编码),ASCII 回退用 templateId(UUID,老客户端兜底)。html 不设此头。 + */ +class ReportDownloadTest { + + @Test + void html_inline_no_disposition() { + assertNull(ReportController.contentDisposition(ReportService.Format.HTML, "在建项目收付款信息表", "tid-1")); + } + + @Test + void pdf_attachment_with_rfc5987_cjk_filename() { + String cd = ReportController.contentDisposition(ReportService.Format.PDF, "在建项目收付款信息表", "5558497f-id"); + assertTrue(cd.startsWith("attachment;"), cd); + // RFC5987 UTF-8 编码的中文名 + .pdf + assertTrue(cd.contains("filename*=UTF-8''"), cd); + assertTrue(cd.contains("%E5%9C%A8%E5%BB%BA"), cd); // 「在建」UTF-8 %xx + assertTrue(cd.contains(".pdf"), cd); + // ASCII 回退用 templateId(UUID 安全) + assertTrue(cd.contains("filename=\"5558497f-id.pdf\""), cd); + } + + @Test + void xls_uses_xls_extension() { + String cd = ReportController.contentDisposition(ReportService.Format.XLS, "报表", "tid"); + assertTrue(cd.contains(".xls"), cd); + assertFalse(cd.contains(".pdf"), cd); + } + + @Test + void header_injection_neutralized() { + // 报表名含 CRLF/引号/路径分隔 → 必须剔除,杜绝响应头注入(CRLF 拆头)与 filename 属性逃逸 + String evil = "a\r\nSet-Cookie: x=1\"/../b"; + String cd = ReportController.contentDisposition(ReportService.Format.PDF, evil, "tid"); + assertFalse(cd.contains("\r"), "不得含 CR: " + cd); + assertFalse(cd.contains("\n"), "不得含 LF: " + cd); + // ASCII filename 用 templateId(UUID),不被恶意报表名污染、无逃逸引号 + assertTrue(cd.contains("filename=\"tid.pdf\""), cd); + } + + @Test + void blank_name_falls_back_to_templateId() { + String cd = ReportController.contentDisposition(ReportService.Format.PDF, " ", "tid-xyz"); + assertTrue(cd.contains("tid-xyz.pdf"), cd); + } +} From 1b4dab9701f9e1781b8d1176ec9f5a9904dea285 Mon Sep 17 00:00:00 2001 From: zhengwr Date: Thu, 25 Jun 2026 23:01:45 +0800 Subject: [PATCH 2/2] =?UTF-8?q?feat(converter):=20=E6=8A=A5=E8=A1=A8?= =?UTF-8?q?=E6=9F=A5=E7=9C=8B=E5=99=A8=E5=8A=A0=E5=AF=BC=E5=87=BA=20PDF/Ex?= =?UTF-8?q?cel=20=E6=8C=89=E9=92=AE?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit convertReportViewer 产导出按钮(actionType:url,blank,指向 /api/report/render 端点 + format=pdf|xls)。 有查询条件 → 落 crud.filter.actions(与 查询[submit]/重置[reset] 同排,读 filter 实时值, URL 带各字段 ${name} 占位,amis 点击时插值为当前选择);无查询条件 → 落 headerToolbar(无参,导全量)。 field name 为校验过的元数据标识符(UiTypeMapper IDENT),裸拼安全;${name} 须保字面量供 amis 插值。 - buildReportExportParams(filter):filter 各字段 → &NAME=${NAME}。 - reportExportButton(label,url):url 动作按钮。 - 2 单测:filter.actions 含 查询/重置/导出PDF/导出Excel + URL 带 ${字段};无 filter → headerToolbar 无参。 真验(浏览器):选工程→查询(重载 iframe,不触发下载);导出PDF→下载「在建项目收付款信息表.pdf」(有效 PDF/中文正确); 导出Excel→下载 .xls。339 报表页已重转重导 eip3.sys_page_schema(329 更新)。 Co-Authored-By: Claude Opus 4.8 (1M context) --- .../converter/TemplateToAmisConverter.java | 59 ++++++++++++++++++- .../TemplateToAmisConverterTest.java | 51 ++++++++++++++++ 2 files changed, 108 insertions(+), 2 deletions(-) diff --git a/platform-converter/src/main/java/com/eip4/platform/converter/TemplateToAmisConverter.java b/platform-converter/src/main/java/com/eip4/platform/converter/TemplateToAmisConverter.java index 41f4736..413adcc 100644 --- a/platform-converter/src/main/java/com/eip4/platform/converter/TemplateToAmisConverter.java +++ b/platform-converter/src/main/java/com/eip4/platform/converter/TemplateToAmisConverter.java @@ -3867,12 +3867,35 @@ public class TemplateToAmisConverter { crud.put("type", "crud"); crud.put("api", "/api/report/frame/" + tid); crud.put("syncLocation", false); - crud.put("headerToolbar", new ArrayList<>()); // 报表查看器无新增/批量按钮 + List headerToolbar = new ArrayList<>(); // 报表查看器无新增/批量按钮(导出按钮见下) + crud.put("headerToolbar", headerToolbar); crud.put("footerToolbar", new ArrayList<>()); // 单行信封,无分页条 crud.put("affixHeader", false); + + // 导出 PDF/Excel:URL 指向 /api/report/render(端点对 pdf/xls 回 attachment 触发下载),带查询参 ${字段}。 + // 有查询条件 → 落 crud.filter.actions(与提交/重置同排,读 filter 实时值,已实测可用); + // 无查询条件 → 落 headerToolbar(无参,导出全量报表)。 + String exportParams = buildReportExportParams(filter); + List> exportBtns = List.of( + reportExportButton("导出PDF", "/api/report/render/" + tid + "?format=pdf" + exportParams), + reportExportButton("导出Excel", "/api/report/render/" + tid + "?format=xls" + exportParams)); if (filter != null) { crud.put("filter", filter); crud.put("initFetch", false); // 有查询条件 → 等用户「查询」再加载 + List> actions = new ArrayList<>(); + Map submit = new LinkedHashMap<>(); + submit.put("type", "submit"); + submit.put("label", "查询"); + submit.put("level", "primary"); + Map reset = new LinkedHashMap<>(); + reset.put("type", "reset"); + reset.put("label", "重置"); + actions.add(submit); + actions.add(reset); + actions.addAll(exportBtns); + filter.put("actions", actions); + } else { + headerToolbar.addAll(exportBtns); } // 唯一的 html 列:把回显的 __url 渲成 iframe(JOR HTML 文档独立加载,CSS 隔离保真) Map col = new LinkedHashMap<>(); @@ -3885,11 +3908,43 @@ public class TemplateToAmisConverter { crud.put("columns", cols); result.note("report 含 JOR 套打版式(" + jorLen + " 字符) → 报表查看器:crud.filter 查询条件 + html 列 iframe 加载 " - + "/api/report/render/" + tid + "(jatools 引擎渲染保真版式;图表 ischart 亦由引擎 jfreechart 出图)"); + + "/api/report/render/" + tid + "(jatools 引擎渲染保真版式;图表 ischart 亦由引擎 jfreechart 出图)" + + ";导出 PDF/Excel 按钮指向 render 端点(attachment 下载)"); noteScripts(report, result); return page(title, crud); } + /** + * 报表导出 URL 的查询参串:filter 各字段 → {@code &NAME=${NAME}}(amis 运行时插值为当前 filter 值, + * 与查看器 iframe 同一份查询条件)。无 filter / 无字段 → 空串(导全量报表)。 + */ + @SuppressWarnings("unchecked") + private static String buildReportExportParams(Map filter) { + if (filter == null || !(filter.get("body") instanceof List items)) { + return ""; + } + StringBuilder sb = new StringBuilder(); + for (Object it : items) { + // name 为元数据字段名(UiTypeMapper IDENT,形如 [A-Za-z_]\w*,无 URL 特殊字符),裸拼安全; + // ${name} 须保持字面量(amis 点击时插值为当前 filter 值,值由 amis 自行编码),故此处不可 URL 编码。 + if (it instanceof Map m && m.get("name") instanceof String n && !n.isBlank()) { + sb.append('&').append(n).append("=${").append(n).append('}'); + } + } + return sb.toString(); + } + + /** 报表导出按钮:{@code url} 动作 + {@code blank}(新标签打开;render 端点对 pdf/xls 回 attachment 触发下载)。 */ + private static Map reportExportButton(String label, String url) { + Map btn = new LinkedHashMap<>(); + btn.put("type", "button"); + btn.put("label", label); + btn.put("actionType", "url"); + btn.put("url", url); + btn.put("blank", true); + return btn; + } + // ────────────────────────────────────────────────────────────────────── // group(分组容器)—— 子模板跨引用 // ────────────────────────────────────────────────────────────────────── diff --git a/platform-converter/src/test/java/com/eip4/platform/converter/TemplateToAmisConverterTest.java b/platform-converter/src/test/java/com/eip4/platform/converter/TemplateToAmisConverterTest.java index 95d419c..bebddb4 100644 --- a/platform-converter/src/test/java/com/eip4/platform/converter/TemplateToAmisConverterTest.java +++ b/platform-converter/src/test/java/com/eip4/platform/converter/TemplateToAmisConverterTest.java @@ -2771,6 +2771,57 @@ class TemplateToAmisConverterTest { assertTrue(((String) crud.get("api")).startsWith("/api/flow/PM_X_SEARCH"), "api=" + crud.get("api")); } + @Test + @SuppressWarnings("unchecked") + void report_viewer_导出按钮落filter_actions带查询参数() { + // 导出 PDF/Excel 落 crud.filter.actions(与查询/重置同排,读 filter 实时值);URL 指向 render 端点 + format + ${字段} + String xml = "" + + "" + + "" + + "" + + "" + + "版式占位非空版式占位]]>"; + ConversionResult r = converter.convertGraded(xml, "TID-1", "收付款", new ArrayList<>(), noPage); + Map crud = body(r.getSchema()); + Map filter = (Map) crud.get("filter"); + List> actions = (List>) filter.get("actions"); + List labels = actions.stream().map(a -> (String) a.get("label")).toList(); + assertTrue(labels.contains("查询") && labels.contains("导出PDF") && labels.contains("导出Excel"), + "actions 应含 查询/导出PDF/导出Excel: " + labels); + // 查询 = submit(触发 crud 重载报表) + assertTrue(actions.stream().anyMatch(a -> "submit".equals(a.get("type")) && "查询".equals(a.get("label")))); + // 导出 PDF:url 动作,指向 render 端点 + format=pdf + 带 filter 字段占位 + Map pdf = actions.stream() + .filter(a -> "导出PDF".equals(a.get("label"))).findFirst().orElseThrow(); + assertEquals("url", pdf.get("actionType")); + assertEquals(Boolean.TRUE, pdf.get("blank")); + String url = (String) pdf.get("url"); + assertTrue(url.startsWith("/api/report/render/TID-1?format=pdf"), url); + assertTrue(url.contains("PROJECTID=${PROJECTID}"), url); + // 导出 Excel:format=xls + Map xls = actions.stream() + .filter(a -> "导出Excel".equals(a.get("label"))).findFirst().orElseThrow(); + assertTrue(((String) xls.get("url")).contains("format=xls"), (String) xls.get("url")); + } + + @Test + @SuppressWarnings("unchecked") + void report_viewer_无查询条件导出按钮落headerToolbar无参() { + // 无 → filter=null → 导出按钮落 headerToolbar,URL 无查询参(导全量报表) + String xml = "" + + "" + + "版式占位非空版式占位]]>"; + ConversionResult r = converter.convertGraded(xml, "TID-2", "全量报表", new ArrayList<>(), noPage); + Map crud = body(r.getSchema()); + assertNull(crud.get("filter"), "无查询条件 filter 应为 null"); + List> tb = (List>) crud.get("headerToolbar"); + List labels = tb.stream().map(a -> (String) a.get("label")).toList(); + assertTrue(labels.contains("导出PDF") && labels.contains("导出Excel"), "headerToolbar 应含导出按钮: " + labels); + Map pdf = tb.stream() + .filter(a -> "导出PDF".equals(a.get("label"))).findFirst().orElseThrow(); + assertEquals("/api/report/render/TID-2?format=pdf", pdf.get("url"), "无查询条件 URL 应无查询参"); + } + @Test void report_图表降级() { String xml = ""