feat: errorOnCharts/errorOnSmartArt — отказ конвертации при находке диаграмм/SmartArt
This commit is contained in:
@@ -9,16 +9,25 @@ package ru.pjandro.wordpdf;
|
||||
* @param renderSmartArt рендерить SmartArt (dgm:relIds → PNG);
|
||||
* {@code false} — объект остаётся в docx, docx2fo
|
||||
* выбрасывает его молча: в PDF пусто, текст сохраняется
|
||||
* @param errorOnCharts бросать {@link DrawingFoundException} при находке
|
||||
* диаграмм, **только если** {@code renderCharts}
|
||||
* выключен (рендер приоритетнее error-флага)
|
||||
* @param errorOnSmartArt бросать {@link DrawingFoundException} при находке
|
||||
* SmartArt, **только если** {@code renderSmartArt}
|
||||
* выключен (рендер приоритетнее error-флага)
|
||||
* @param maxBytes лимит размера входных байтов на этот вызов;
|
||||
* дефолт — {@link WordPdfSettings#MAX_INPUT_BYTES}
|
||||
* @param maxPages лимит числа страниц на этот вызов;
|
||||
* дефолт — {@link WordPdfSettings#MAX_PAGES}
|
||||
*/
|
||||
public record ConvertOptions(boolean renderCharts, boolean renderSmartArt, long maxBytes, int maxPages) {
|
||||
public record ConvertOptions(boolean renderCharts, boolean renderSmartArt,
|
||||
boolean errorOnCharts, boolean errorOnSmartArt,
|
||||
long maxBytes, int maxPages) {
|
||||
|
||||
/** Дефолты ядра из {@link WordPdfSettings}. */
|
||||
public static ConvertOptions defaults() {
|
||||
return new ConvertOptions(WordPdfSettings.RENDER_CHARTS, WordPdfSettings.RENDER_SMARTART,
|
||||
WordPdfSettings.ERROR_ON_CHARTS, WordPdfSettings.ERROR_ON_SMARTART,
|
||||
WordPdfSettings.MAX_INPUT_BYTES, WordPdfSettings.MAX_PAGES);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
package ru.pjandro.wordpdf;
|
||||
|
||||
/**
|
||||
* Документ содержит объект, обработку которого вызывающий запретил:
|
||||
* render-флаг выключен, а соответствующий error-флаг включён
|
||||
* ({@link ConvertOptions#errorOnCharts()}, {@link ConvertOptions#errorOnSmartArt()}).
|
||||
* render-флаг имеет приоритет: при включённом рендере исключение не бросается.
|
||||
*
|
||||
* <p>Наследник {@link ConversionException} — наружу по-прежнему ловится
|
||||
* только он; {@code kind()} даёт вызывающему тип объекта без разбора текста.
|
||||
* Регрессия — WordPdfConverterTest#drawingErrors_errorFlagRejectsCharts,
|
||||
* фикстура samples/charts-smartart.docx.</p>
|
||||
*/
|
||||
public class DrawingFoundException extends ConversionException {
|
||||
|
||||
/** Тип найденного объекта. */
|
||||
public enum Kind { CHARTS, SMARTART }
|
||||
|
||||
private final Kind kind;
|
||||
|
||||
public DrawingFoundException(Kind kind) {
|
||||
super(kind == Kind.CHARTS
|
||||
? "В документе найдены диаграммы, а их обработка запрещена (errorOnCharts)"
|
||||
: "В документе найден SmartArt, а его обработка запрещена (errorOnSmartArt)");
|
||||
this.kind = kind;
|
||||
}
|
||||
|
||||
public Kind kind() {
|
||||
return kind;
|
||||
}
|
||||
}
|
||||
@@ -25,6 +25,16 @@ public final class WordPdfSettings {
|
||||
/** Генерация SmartArt (dgm:relIds → PNG). {@code false} — как с {@link #RENDER_CHARTS}. */
|
||||
public static final boolean RENDER_SMARTART = true;
|
||||
|
||||
/**
|
||||
* Ошибка при находке диаграмм (c:chart), если {@link #RENDER_CHARTS}
|
||||
* выключен ({@link DrawingFoundException}). Дефолт {@code false} —
|
||||
* библиотечное поведение не меняется.
|
||||
*/
|
||||
public static final boolean ERROR_ON_CHARTS = false;
|
||||
|
||||
/** Ошибка при находке SmartArt (dgm:relIds), если {@link #RENDER_SMARTART} выключен. */
|
||||
public static final boolean ERROR_ON_SMARTART = false;
|
||||
|
||||
private WordPdfSettings() {
|
||||
}
|
||||
}
|
||||
|
||||
+16
-1
@@ -34,6 +34,7 @@ import org.docx4j.wml.Drawing;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
import ru.pjandro.wordpdf.ConvertOptions;
|
||||
import ru.pjandro.wordpdf.DrawingFoundException;
|
||||
|
||||
import javax.imageio.ImageIO;
|
||||
import java.awt.image.BufferedImage;
|
||||
@@ -53,6 +54,12 @@ import java.util.Set;
|
||||
* Порядок вызова важен: {@link #run} должен отработать после загрузки
|
||||
* пакета и до создания FOSettings, иначе FOP увидит исходные chart/diagram
|
||||
* и молча их выбросит (notImplemented в шаблоне).
|
||||
*
|
||||
* Error-флаги {@link ConvertOptions}: при выключенном render-флаге и
|
||||
* включённом error-флаге находка объекта — {@link DrawingFoundException}
|
||||
* (бросок здесь, на шаге 3.5, до XSLT/FOP). Регрессия —
|
||||
* WordPdfConverterTest#drawingErrors_errorFlagRejectsCharts, фикстура
|
||||
* samples/charts-smartart.docx.
|
||||
*/
|
||||
public final class DrawingPreRenderer {
|
||||
|
||||
@@ -73,7 +80,9 @@ public final class DrawingPreRenderer {
|
||||
/**
|
||||
* Рендерит диаграммы/SmartArt пакета в PNG и подменяет их картинками.
|
||||
* Объекты, выключенные в {@link ConvertOptions}, остаются в docx как есть
|
||||
* (docx2fo выбросит их молча — на их месте в PDF пусто).
|
||||
* (docx2fo выбросит их молча — на их месте в PDF пусто), кроме случая,
|
||||
* когда для них включён error-флаг: тогда {@link DrawingFoundException}.
|
||||
* render-флаг приоритетнее: при включённом рендере error-флаг игнорируется.
|
||||
*/
|
||||
public static void run(WordprocessingMLPackage pkg, ConvertOptions options) {
|
||||
ThemePart themePart = null;
|
||||
@@ -194,12 +203,18 @@ public final class DrawingPreRenderer {
|
||||
String name = el.getName() == null ? "" : el.getName().toString();
|
||||
if (CHART_ELEMENT.equals(name)) {
|
||||
if (!options.renderCharts()) {
|
||||
if (options.errorOnCharts()) {
|
||||
throw new DrawingFoundException(DrawingFoundException.Kind.CHARTS);
|
||||
}
|
||||
continue; // настройка выключена — drawing остаётся в docx как есть
|
||||
}
|
||||
img = renderChart(part, (CTRelId) el.getValue(), pkg, colors, cx, cy);
|
||||
label = "график";
|
||||
} else if (DIAGRAM_ELEMENT.equals(name)) {
|
||||
if (!options.renderSmartArt()) {
|
||||
if (options.errorOnSmartArt()) {
|
||||
throw new DrawingFoundException(DrawingFoundException.Kind.SMARTART);
|
||||
}
|
||||
continue;
|
||||
}
|
||||
img = renderDiagram(part, (CTRelIds) el.getValue(), pkg, colors, cx, cy);
|
||||
|
||||
@@ -155,7 +155,7 @@ class WordPdfConverterTest {
|
||||
@Test
|
||||
void drawingToggles_offRemovesRasters() throws Exception {
|
||||
Path pdf = convertPdf(sampleBytes("charts-smartart.docx"), "charts-smartart",
|
||||
new ConvertOptions(false, false,
|
||||
new ConvertOptions(false, false, false, false,
|
||||
WordPdfSettings.MAX_INPUT_BYTES, WordPdfSettings.MAX_PAGES));
|
||||
|
||||
String text = norm(pdfText(pdf));
|
||||
@@ -172,7 +172,7 @@ class WordPdfConverterTest {
|
||||
@Test
|
||||
void drawingToggles_chartsOffSmartArtOn() throws Exception {
|
||||
Path pdf = convertPdf(sampleBytes("charts-smartart.docx"), "charts-smartart",
|
||||
new ConvertOptions(false, true,
|
||||
new ConvertOptions(false, true, false, false,
|
||||
WordPdfSettings.MAX_INPUT_BYTES, WordPdfSettings.MAX_PAGES));
|
||||
|
||||
String text = norm(pdfText(pdf));
|
||||
@@ -181,6 +181,58 @@ class WordPdfConverterTest {
|
||||
"от SmartArt должны остаться только его растры");
|
||||
}
|
||||
|
||||
/**
|
||||
* Error-флаг при выключенном render-флаге: находка диаграмм —
|
||||
* {@link DrawingFoundException} с {@code Kind.CHARTS}; SmartArt в этом
|
||||
* вызове рендерится (render-флаг включён → error-флаг к нему не применяется),
|
||||
* поэтому бросается именно целевой Kind независимо от порядка обхода.
|
||||
*/
|
||||
@Test
|
||||
void drawingErrors_errorFlagRejectsCharts() throws Exception {
|
||||
ConversionException ex = assertThrows(ConversionException.class, () ->
|
||||
convertPdf(sampleBytes("charts-smartart.docx"), "charts-smartart",
|
||||
new ConvertOptions(false, true, true, false,
|
||||
WordPdfSettings.MAX_INPUT_BYTES, WordPdfSettings.MAX_PAGES)));
|
||||
|
||||
assertTrue(ex instanceof DrawingFoundException dfe
|
||||
&& dfe.kind() == DrawingFoundException.Kind.CHARTS,
|
||||
"ожидался DrawingFoundException(CHARTS), получено: " + ex);
|
||||
assertTrue(ex.getMessage().contains("диаграмм"),
|
||||
"сообщение должно упоминать диаграммы: " + ex.getMessage());
|
||||
}
|
||||
|
||||
/**
|
||||
* Зеркальный случай: error-флаг SmartArt при выключенном его рендере —
|
||||
* {@code Kind.SMARTART}; диаграммы рендерятся.
|
||||
*/
|
||||
@Test
|
||||
void drawingErrors_errorFlagRejectsSmartArt() throws Exception {
|
||||
ConversionException ex = assertThrows(ConversionException.class, () ->
|
||||
convertPdf(sampleBytes("charts-smartart.docx"), "charts-smartart",
|
||||
new ConvertOptions(true, false, false, true,
|
||||
WordPdfSettings.MAX_INPUT_BYTES, WordPdfSettings.MAX_PAGES)));
|
||||
|
||||
assertTrue(ex instanceof DrawingFoundException dfe
|
||||
&& dfe.kind() == DrawingFoundException.Kind.SMARTART,
|
||||
"ожидался DrawingFoundException(SMARTART), получено: " + ex);
|
||||
assertTrue(ex.getMessage().contains("SmartArt"),
|
||||
"сообщение должно упоминать SmartArt: " + ex.getMessage());
|
||||
}
|
||||
|
||||
/**
|
||||
* render-флаг приоритетнее error-флага: оба включены — конвертация
|
||||
* проходит, все 4 растра фикстуры на месте.
|
||||
*/
|
||||
@Test
|
||||
void drawingErrors_renderFlagWins() throws Exception {
|
||||
Path pdf = convertPdf(sampleBytes("charts-smartart.docx"), "charts-smartart",
|
||||
new ConvertOptions(true, true, true, true,
|
||||
WordPdfSettings.MAX_INPUT_BYTES, WordPdfSettings.MAX_PAGES));
|
||||
|
||||
assertTrue(imageCount(pdf) >= 4,
|
||||
"рендер должен победить error-флаг, найдено растров: " + imageCount(pdf));
|
||||
}
|
||||
|
||||
/**
|
||||
* Маркеры списков из символьных шрифтов (Symbol/Wingdings, коды из
|
||||
* PUA U+F0xx) экспорт в FO не понимает и рисует .notdef — решётку «#».
|
||||
@@ -405,7 +457,7 @@ class WordPdfConverterTest {
|
||||
void limitsOverriddenByOptions() throws Exception {
|
||||
ConversionException ex = assertThrows(ConversionException.class, () ->
|
||||
WordPdfConverter.convert(sampleBytes("ru-plain.docx"), "x",
|
||||
new ConvertOptions(true, true, 1000, WordPdfSettings.MAX_PAGES)));
|
||||
new ConvertOptions(true, true, false, false, 1000, WordPdfSettings.MAX_PAGES)));
|
||||
assertTrue(ex.getMessage().contains("1000 байт"),
|
||||
"сообщение должно упоминать переданный лимит: " + ex.getMessage());
|
||||
}
|
||||
@@ -420,7 +472,7 @@ class WordPdfConverterTest {
|
||||
ConversionException ex = assertThrows(ConversionException.class, () ->
|
||||
WordPdfConverter.convert(
|
||||
sampleBytes("too-many-pages.docx"), "too-many-pages",
|
||||
new ConvertOptions(true, true, WordPdfSettings.MAX_INPUT_BYTES, 100)));
|
||||
new ConvertOptions(true, true, false, false, WordPdfSettings.MAX_INPUT_BYTES, 100)));
|
||||
assertTrue(ex.getMessage().contains("100"),
|
||||
"сообщение должно упоминать лимит: " + ex.getMessage());
|
||||
}
|
||||
@@ -436,7 +488,7 @@ class WordPdfConverterTest {
|
||||
void staleCachePageCountRejectedBeforeRender() {
|
||||
ConversionException ex = assertThrows(ConversionException.class, () ->
|
||||
WordPdfConverter.convert(sampleBytes("stale-cache.docx"), "stale-cache",
|
||||
new ConvertOptions(true, true, WordPdfSettings.MAX_INPUT_BYTES, 100)));
|
||||
new ConvertOptions(true, true, false, false, WordPdfSettings.MAX_INPUT_BYTES, 100)));
|
||||
assertTrue(ex.getMessage().contains("100"),
|
||||
"сообщение должно упоминать лимит: " + ex.getMessage());
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user