Убрать render-флаги диаграмм/SmartArt; автозаголовок — «Название диаграммы»
PR checks / java (pull_request) Successful in 45s
PR checks / web (pull_request) Successful in 1m20s

ConvertOptions: renderCharts/renderSmartArt удалены (ядро, REST, SPA,
прод-автотесты) — диаграммы/SmartArt конвертируются всегда, отказ только
по error-флагам (DrawingFoundException → 422). Дефолт SPA-галок — false.
ChartSpec.AUTO_TITLE русифицирован: «Название диаграммы».
AGENTS.md приведён в соответствие.
This commit is contained in:
Pjandro
2026-10-22 17:50:17 +00:00
parent dff143d92e
commit 6b2715f1c2
16 changed files with 78 additions and 251 deletions
@@ -1,33 +1,24 @@
package ru.pjandro.wordpdf;
/**
* на один вызов: генерация рисунков и лимиты входа (размер/страницы).
* на один вызов: error-флаги рисунков и лимиты входа (размер/страницы).
* Дефолты — константы {@link WordPdfSettings}; вызывающий (например, REST API)
* может переопределить их на конкретный вызов.
* может переопределить их на конкретный вызов. Диаграммы/SmartArt
* конвертируются всегда.
*
* @param renderCharts рендерить диаграммы (c:chart → PNG)
* @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 errorOnCharts бросать {@link DrawingFoundException} при находке диаграмм
* @param errorOnSmartArt бросать {@link DrawingFoundException} при находке SmartArt
* @param maxMb лимит размера входа в МБ (MiB) на этот вызов;
* дефолт — {@link WordPdfSettings#MAX_INPUT_MB}
* @param maxPages лимит числа страниц на этот вызов;
* дефолт — {@link WordPdfSettings#MAX_PAGES}
*/
public record ConvertOptions(boolean renderCharts, boolean renderSmartArt,
boolean errorOnCharts, boolean errorOnSmartArt,
public record ConvertOptions(boolean errorOnCharts, boolean errorOnSmartArt,
long maxMb, 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,
return new ConvertOptions(WordPdfSettings.ERROR_ON_CHARTS, WordPdfSettings.ERROR_ON_SMARTART,
WordPdfSettings.MAX_INPUT_MB, WordPdfSettings.MAX_PAGES);
}
}
@@ -1,10 +1,10 @@
package ru.pjandro.wordpdf;
/**
* Документ содержит объект, обработку которого вызывающий запретил:
* render-флаг выключен, а соответствующий error-флаг включён
* Документ содержит объект, находку которого вызывающий запретил:
* соответствующий error-флаг включён
* ({@link ConvertOptions#errorOnCharts()}, {@link ConvertOptions#errorOnSmartArt()}).
* render-флаг имеет приоритет: при включённом рендере исключение не бросается.
* Диаграммы/SmartArt конвертируются всегда; исключение отвергает документ целиком.
*
* <p>Наследник {@link ConversionException} — наружу по-прежнему ловится
* только он; {@code kind()} даёт вызывающему тип объекта без разбора текста.
@@ -75,7 +75,7 @@ public final class WordPdfConverter {
}
/**
* Конвертирует байты .docx в PDF с настройками на вызов: рисование
* Конвертирует байты .docx в PDF с настройками на вызов: error-флаги
* диаграмм/SmartArt и лимиты входа.
*
* <p>Вход проверяется {@link WordPdfValidator#validate(byte[], ConvertOptions)} до рендера:
@@ -85,7 +85,7 @@ public final class WordPdfConverter {
*
* @param docxBytes байты .docx
* @param title заголовок PDF (метаданные); {@code null}/пустая — заголовок не задаётся
* @param options рисование и лимиты входа на этот вызов; {@code null} —
* @param options error-флаги и лимиты входа на этот вызов; {@code null} —
* дефолты (константы {@link WordPdfSettings})
* @return байты готового PDF
* @throws ValidationException некорректный вход: {@code null}, размер больше
@@ -22,23 +22,12 @@ public final class WordPdfSettings {
public static final int MAX_ZIP_ENTRIES = 8192;
/**
* Генерация диаграмм (c:chart → PNG, chart-движок). {@code false} — диаграммы
* не рендерятся и остаются в docx, откуда docx2fo выбрасывает их молча,
* как без движка: в PDF на их месте пусто, текст вокруг сохраняется.
*/
public static final boolean RENDER_CHARTS = true;
/** Генерация 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} —
* библиотечное поведение не меняется.
* Ошибка при находке диаграмм ({@code c:chart}) — {@link DrawingFoundException}.
* Дефолт {@code false} — конвертация проходит.
*/
public static final boolean ERROR_ON_CHARTS = false;
/** Ошибка при находке SmartArt (dgm:relIds), если {@link #RENDER_SMARTART} выключен. */
/** Ошибка при находке SmartArt ({@code dgm:relIds}) — {@link DrawingFoundException}. */
public static final boolean ERROR_ON_SMARTART = false;
private WordPdfSettings() {
@@ -54,8 +54,9 @@ import java.util.Map;
*/
final class ChartSpec {
/** Встроенный заголовок Word для графика с пустым c:title. */
static final String AUTO_TITLE = "Chart Title";
/** Плейсхолдер автозаголовка для графика с пустым c:title (Word подставляет
* строку своего UI-языка — у нас русская). */
static final String AUTO_TITLE = "Название диаграммы";
enum Type {
PIE, PIE3D, DOUGHNUT, BAR, BAR_HORIZONTAL, LINE, AREA, SURFACE3D, UNSUPPORTED
@@ -442,8 +443,9 @@ final class ChartSpec {
}
// Пустой c:title при autoTitleDeleted=0 — это автозаголовок Word:
// для круговых диаграмм он берётся из имени ряда, для остальных
// типов рисуется встроенный плейсхолдер (в эталоне — "Chart Title",
// в XML его нет, Word подставляет строку из своего UI-языка).
// типов рисуется встроенный плейсхолдер (в англ. эталоне Word —
// "Chart Title", у нас плейсхолдер русифицирован; в XML его нет,
// Word подставляет строку из своего UI-языка).
boolean deleted = chart.getAutoTitleDeleted() != null
&& chart.getAutoTitleDeleted().isVal();
if ((text == null || text.isBlank()) && !deleted) {
@@ -78,11 +78,9 @@ public final class DrawingPreRenderer {
}
/**
* Рендерит диаграммы/SmartArt пакета в PNG и подменяет их картинками.
* Объекты, выключенные в {@link ConvertOptions}, остаются в docx как есть
* (docx2fo выбросит их молча — на их месте в PDF пусто), кроме случая,
* когда для них включён error-флаг: тогда {@link DrawingFoundException}.
* render-флаг приоритетнее: при включённом рендере error-флаг игнорируется.
* Рендерит диаграммы/SmartArt пакета в PNG и подменяет их картинками —
* объекты конвертируются всегда. Бросается {@link DrawingFoundException},
* когда для объектов включён error-флаг ({@link ConvertOptions}).
*/
public static void run(WordprocessingMLPackage pkg, ConvertOptions options) {
ThemePart themePart = null;
@@ -202,20 +200,14 @@ public final class DrawingPreRenderer {
if (payload instanceof JAXBElement<?> el) {
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 как есть
if (options.errorOnCharts()) {
throw new DrawingFoundException(DrawingFoundException.Kind.CHARTS);
}
img = renderChart(part, (CTRelId) el.getValue(), colors, cx, cy);
label = "график";
} else if (DIAGRAM_ELEMENT.equals(name)) {
if (!options.renderSmartArt()) {
if (options.errorOnSmartArt()) {
throw new DrawingFoundException(DrawingFoundException.Kind.SMARTART);
}
continue;
if (options.errorOnSmartArt()) {
throw new DrawingFoundException(DrawingFoundException.Kind.SMARTART);
}
img = renderDiagram(part, (CTRelIds) el.getValue(), colors, cx, cy);
label = "SmartArt";
@@ -85,7 +85,7 @@ class WordPdfConverterTest {
return out;
}
/** Конвертирует с настройками рисования; PDF — во временный файл. */
/** Конвертирует с настройками на вызов; PDF — во временный файл. */
private static Path convertPdf(byte[] docxBytes, String title, ConvertOptions options)
throws IOException {
Path out = Files.createTempFile("converted-", ".pdf");
@@ -147,51 +147,15 @@ class WordPdfConverterTest {
}
/**
* Выключенные в {@link ConvertOptions} диаграммы и SmartArt не
* рендерятся и остаются в docx, откуда docx2fo выбрасывает их молча:
* в PDF нет ни одного растра (все 4 растра фикстуры — из drawing'ов),
* текст вокруг сохраняется.
*/
@Test
void drawingToggles_offRemovesRasters() throws Exception {
Path pdf = convertPdf(sampleBytes("charts-smartart.docx"), "charts-smartart",
new ConvertOptions(false, false, false, false,
WordPdfSettings.MAX_INPUT_MB, WordPdfSettings.MAX_PAGES));
String text = norm(pdfText(pdf));
assertTrue(text.contains("Диаграммы"), "пропал текст вокруг диаграмм: " + text);
assertEquals(0, imageCount(pdf),
"выключенные drawing'и не должны давать растров");
}
/**
* Частичное выключение: диаграммы выключены, SmartArt включён —
* от рисования остаются только SmartArt-растры (замер по фикстуре —
* 2 Image XObject, считаемых по страницам), текст сохраняется.
*/
@Test
void drawingToggles_chartsOffSmartArtOn() throws Exception {
Path pdf = convertPdf(sampleBytes("charts-smartart.docx"), "charts-smartart",
new ConvertOptions(false, true, false, false,
WordPdfSettings.MAX_INPUT_MB, WordPdfSettings.MAX_PAGES));
String text = norm(pdfText(pdf));
assertTrue(text.contains("Диаграммы"), "пропал текст вокруг диаграмм: " + text);
assertEquals(2, imageCount(pdf),
"от SmartArt должны остаться только его растры");
}
/**
* Error-флаг при выключенном render-флаге: находка диаграмм —
* {@link DrawingFoundException} с {@code Kind.CHARTS}; SmartArt в этом
* вызове рендерится (render-флаг включён → error-флаг к нему не применяется),
* поэтому бросается именно целевой Kind независимо от порядка обхода.
* errorOnCharts=true: находка диаграмм — {@link DrawingFoundException}
* с {@code Kind.CHARTS}, документ отвергается целиком. Error-флаг SmartArt
* выключен — он конвертируется как обычно, бросок происходит на графике.
*/
@Test
void drawingErrors_errorFlagRejectsCharts() throws Exception {
ConversionException ex = assertThrows(ConversionException.class, () ->
convertPdf(sampleBytes("charts-smartart.docx"), "charts-smartart",
new ConvertOptions(false, true, true, false,
new ConvertOptions(true, false,
WordPdfSettings.MAX_INPUT_MB, WordPdfSettings.MAX_PAGES)));
assertTrue(ex instanceof DrawingFoundException dfe
@@ -202,14 +166,14 @@ class WordPdfConverterTest {
}
/**
* Зеркальный случай: error-флаг SmartArt при выключенном его рендере —
* {@code Kind.SMARTART}; диаграммы рендерятся.
* Зеркальный случай: errorOnSmartArt=true — {@code Kind.SMARTART};
* диаграммы конвертируются (их error-флаг выключен).
*/
@Test
void drawingErrors_errorFlagRejectsSmartArt() throws Exception {
ConversionException ex = assertThrows(ConversionException.class, () ->
convertPdf(sampleBytes("charts-smartart.docx"), "charts-smartart",
new ConvertOptions(true, false, false, true,
new ConvertOptions(false, true,
WordPdfSettings.MAX_INPUT_MB, WordPdfSettings.MAX_PAGES)));
assertTrue(ex instanceof DrawingFoundException dfe
@@ -219,20 +183,6 @@ class WordPdfConverterTest {
"сообщение должно упоминать 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_MB, WordPdfSettings.MAX_PAGES));
assertTrue(imageCount(pdf) >= 4,
"рендер должен победить error-флаг, найдено растров: " + imageCount(pdf));
}
/**
* Маркеры списков из символьных шрифтов (Symbol/Wingdings, коды из
* PUA U+F0xx) экспорт в FO не понимает и рисует .notdef — решётку «#».
@@ -492,7 +442,7 @@ class WordPdfConverterTest {
byte[] big = new byte[1024 * 1024 + 1];
ValidationException ex = assertThrows(ValidationException.class, () ->
WordPdfConverter.convert(big, "x",
new ConvertOptions(true, true, false, false, 1, WordPdfSettings.MAX_PAGES)));
new ConvertOptions(false, false, 1, WordPdfSettings.MAX_PAGES)));
assertTrue(ex.getMessage().contains("1 МБ"),
"сообщение должно упоминать переданный лимит: " + ex.getMessage());
assertTrue(ex.getMessage().contains("1048576 байт"),
@@ -509,7 +459,7 @@ class WordPdfConverterTest {
ValidationException ex = assertThrows(ValidationException.class, () ->
WordPdfConverter.convert(
sampleBytes("too-many-pages.docx"), "too-many-pages",
new ConvertOptions(true, true, false, false, WordPdfSettings.MAX_INPUT_MB, 100)));
new ConvertOptions(false, false, WordPdfSettings.MAX_INPUT_MB, 100)));
assertTrue(ex.getMessage().contains("100"),
"сообщение должно упоминать лимит: " + ex.getMessage());
}
@@ -525,7 +475,7 @@ class WordPdfConverterTest {
void staleCachePageCountRejectedBeforeRender() {
ValidationException ex = assertThrows(ValidationException.class, () ->
WordPdfConverter.convert(sampleBytes("stale-cache.docx"), "stale-cache",
new ConvertOptions(true, true, false, false, WordPdfSettings.MAX_INPUT_MB, 100)));
new ConvertOptions(false, false, WordPdfSettings.MAX_INPUT_MB, 100)));
assertTrue(ex.getMessage().contains("100"),
"сообщение должно упоминать лимит: " + ex.getMessage());
}
@@ -263,7 +263,7 @@ class WordPdfValidatorTest {
// ===== validate(byte[], ConvertOptions) =====
private static ConvertOptions options(long maxMb, int maxPages) {
return new ConvertOptions(true, true, false, false, maxMb, maxPages);
return new ConvertOptions(false, false, maxMb, maxPages);
}
@Test
@@ -28,7 +28,7 @@ class ChartSpecTest {
ChartSpec spec = new ChartSpec();
spec.type = ChartSpec.Type.SURFACE3D;
ChartSpec.readTitle(emptyTitleChart(), spec, new DrawMlColor(null));
assertEquals(ChartSpec.AUTO_TITLE, spec.title);
assertEquals("Название диаграммы", spec.title);
assertNotNull(spec.titleStyle, "у автозаголовка должно быть начертание из c:txPr");
}