Раздельные исключения для charts / SmartArt / OLE #105
@@ -32,7 +32,7 @@
|
||||
|
||||
`POST /api/v1/convert`: multipart-поле `file` (`.docx`/`.doc`) + query/form-параметры `errorOnCharts`/`errorOnSmartArt`/`errorOnOle` (дефолт каждого — `false`), `maxMb`/`maxPages` (лимиты входа: переопределяют серверный дефолт в обе стороны; ≤ 0 → 400). Ответ — `application/pdf`, `Content-Disposition: attachment; filename*=UTF-8''…`; имя — `ConversionService.safeBaseName`. Тело ошибки — `{"error": …}`. Error-флаги на `.doc` **не срабатывают** (BLIP-плейсхолдеры → картинки). `ApiExceptionHandler` не видит ошибок фильтров — 401 пишет сам `ApiKeyFilter`.
|
||||
|
||||
- **Коды**: 400 — `ValidationException`/`BadRequestException`/битые параметры; 401 — `ApiKeyFilter`; 404/405/415 — путь/метод/content-type; 413 — multipart; **422** — `DrawingRejectedException` (core-`DrawingFoundException`, `Kind {CHARTS, SMARTART, OLE}`); 500/503/504 — `ConversionFailedException`/`ConversionRejectedException`/`ConversionTimeoutException`. 500 отвечает фиксированный текст («Внутренняя ошибка конвертации») — сообщение ядра логируется, наружу не попадает. Полная карта — `docs/agent/repo-map.md`.
|
||||
- **Коды**: 400 — `ValidationException`/`BadRequestException`/битые параметры; 401 — `ApiKeyFilter`; 404/405/415 — путь/метод/content-type; 413 — multipart; **422** — `DrawingRejectedException` (core: `ChartsFoundException`/`SmartArtFoundException`/`OleFoundException`); 500/503/504 — `ConversionFailedException`/`ConversionRejectedException`/`ConversionTimeoutException`. 500 отвечает фиксированный текст («Внутренняя ошибка конвертации») — сообщение ядра логируется, наружу не попадает. Полная карта — `docs/agent/repo-map.md`.
|
||||
- **Текст 422** — контракт с фронтом: «Конвертация отменена: в документе найдены диаграммы/найден SmartArt/найдены OLE-объекты».
|
||||
- **Ключ**: `X-API-Key` ↔ `wordpdf.api-key` (пустое = выключено); без ключа открыты только `OPEN_PREFIXES` (`/actuator/`, `/swagger-ui`, `/v3/api-docs`), пути с точечными сегментами — никогда.
|
||||
- **Очередь и лимиты**: конвертации сериализованы однопоточным `ThreadPoolExecutor` (`QUEUE_CAPACITY = 16`, переполнение → 503): ядро дополнительно сериализует конвертации монитором `WordPdfConverter.class` (`convert()` безопасен из нескольких потоков); головой очереди на старте стоит `warmup()`. До очереди — только дешёвый гейт размера (`WordPdfValidator.checkInput` на потоке Tomcat); полный `validate` (контейнер/страницы — бюджеты распаковки и прочие пороги выводятся из лимитов входа `maxMb`/`maxPages` методом `WordPdfValidator.max*`, крышек нет) выполняется внутри воркера ядром, `ValidationException` из `ExecutionException` пробрасывается как 400. Лимиты входа: `wordpdf.max-mb`/`max-pages` — дефолт эндпоинта (литералы 5/100 в `@Value`; значение свойства ≤ 0 → `IllegalStateException` на старте); параметры запроса `maxMb`/`maxPages` переопределяют дефолт в обе стороны (≤ 0 → 400), верхнего потолка нет.
|
||||
|
||||
@@ -38,7 +38,7 @@ java-word-pdf/
|
||||
|`ru.pjandro.wordpdf.WordPdfConverter`|публичный API: `convert(byte[], String, ConvertOptions)` — .docx/.doc по сигнатуре байтов, байты PDF на выходе; `warmup()` — прогрев ядра|
|
||||
|`ru.pjandro.wordpdf.WordPdfValidator`|валидация входа и lightweight-оценка страниц без рендера (`checkInput`/`validate`; подсчёт страниц — внутренний метод)|
|
||||
|`ru.pjandro.wordpdf.ConvertOptions`|опции конвертации (record `errorOnCharts, errorOnSmartArt, errorOnOle, maxMb, maxPages`); дефолтов в ядре нет — значения задаёт вызывающий|
|
||||
|`ru.pjandro.wordpdf.ConversionException`|ошибки конвертации; подтипы `ValidationException` (некорректный вход) и `DrawingFoundException` (`enum Kind {CHARTS, SMARTART, OLE}`)|
|
||||
|`ru.pjandro.wordpdf.ConversionException`|ошибки конвертации; подтипы `ValidationException` (некорректный вход) и `ChartsFoundException`/`SmartArtFoundException`/`OleFoundException` (по error-флагам)|
|
||||
|`ru.pjandro.wordpdf.fonts.BundledFonts`|выгрузка TTF из jar и регистрация в docx4j|
|
||||
|`ru.pjandro.wordpdf.fonts.BundledFontMapper`|маппинг имён шрифтов документа → TTF|
|
||||
|`ru.pjandro.wordpdf.internal.DocxRewritePipeline`|правила 1–10 нормализации XML-частей одним zip-проходом (+ `OleObjectNormalizer`, правило 11)|
|
||||
|
||||
@@ -40,6 +40,6 @@
|
||||
8. `NumberingSuffixNormalizer` — `w:suff w:val="space"` → дописанный обычный пробел в конце следующего `w:lvlText` того же уровня (порядок CT_Lvl suff→lvlText, wml.xsd; Part 1 §17.3.1.28): docx4j разделитель не эмитит вовсе (дамп n4.fo); уже пробельный lvlText не дублируется; suff=tab — отдельный Class C-остаток (нужна per-item ширина), nothing совпадает с docx4j. Регрессия — WordPdfConverterTest#suffSpace_labelGetsSpace.
|
||||
9. `HiddenTextNormalizer` — вырезание скрытых ранов (Part 1 §17.3.2.30): truthy `w:vanish` в собственном `w:rPr` ранa (обе OnOff-формы; вал опущен — default true) **или** `w:rStyle` ∈ vanish-стили из `word/styles.xml` (транзитивно по `w:basedOn`, капа цепочки 16, цикл — обрыв); ран с защищённым содержимым (`fldChar`/`instrText`/`footnoteReference`/`endnoteReference`/`drawing`/`pict`/`object`/`txbxContent`) не трогается — удаление спаренных `begin…separate…end` сломало бы поле. Word скрытое не печатает, стилист docx4j `vanish` не читает вовсе → без правила скрытое утекало в PDF. Индивидуальный `normalize()` — свой pass styles.xml. Регрессия — WordPdfConverterTest#hiddenText_notPrinted, юниты — HiddenTextNormalizerTest.
|
||||
10. `RubyNormalizer` — разбор руби-разметки (Part 1 §17.3.3.18/.19/.20/.21): `w:rubyBase`/`w:rubyBaseText` разворачиваются в обычные раны, `w:rt`/`w:rubyPr`/`w:rubyAlign` вырезаются с содержимым (надстрочница — принятая деградация, ruby-разметки в FOP нет; потеря текста хуже потери аннотации). Чинится **в байтах**, а не в XSLT: схема docx4j 17.3.2 не биндит `w:rubyBase`/`w:rt` в `w:r` — unmarshaller теряет их до стилиста (в отличие от `moveFrom`/`moveTo`/`bdo`/`dir`, которых схема знает — тех ловит AUDIT-FIX-2). Регрессия — WordPdfConverterTest#rubyBase_textPrinted, юниты — RubyNormalizerTest.
|
||||
11. `OleObjectNormalizer` — принимает флаг `errorOnOle`. Два этапа: дешёвый детект по центральному каталогу zip (`ZipFile`; читаются только `[Content_Types].xml` и `word/*.xml` до первого `<w:object`; не-zip/нет центрального каталога → входной массив — прежняя снисходительность), переупаковка — только при находке. Детект OLE-бинарников — по `[Content_Types].xml`: тип `…oleObject` **или** ложный `+xml`-тип у `.bin` (XML в bin не бывает; `printerSettings` не трогается). Удаляются вместе с rels-ссылками (по типу, включая `TargetMode=External`) и Override удалённых частей. Элементы `<w:object>` из `word/*.xml` не выбрасываются, а заменяются статичным представлением — картинкой-плейсхолдером (ECMA-376 §15.2.10): `w:drawing` переиспользуется дословно, `v:imagedata r:id` → inline-DrawingML на ту же image-часть (размер из `style` `v:shape`, иначе `w:dxaOrig`/`w:dyaOrig` ×635), блоки с `w:control` и без плейсхолдера удаляются. OLE-бинарники никогда не читаются. При `errorOnOle=true` вместо вычистки — `DrawingFoundException(OLE)`. Лечит оба механизма падения docx4j: JAXB-разбор бинарника под ложным XML-типом («Content is not allowed in prolog» → NPE) и NPE `chunkType is null` в VML-сериализации `w:object`. Многочастный: публичный член только `normalize(byte[], boolean)`, `rewrite`-хука нет.
|
||||
11. `OleObjectNormalizer` — принимает флаг `errorOnOle`. Два этапа: дешёвый детект по центральному каталогу zip (`ZipFile`; читаются только `[Content_Types].xml` и `word/*.xml` до первого `<w:object`; не-zip/нет центрального каталога → входной массив — прежняя снисходительность), переупаковка — только при находке. Детект OLE-бинарников — по `[Content_Types].xml`: тип `…oleObject` **или** ложный `+xml`-тип у `.bin` (XML в bin не бывает; `printerSettings` не трогается). Удаляются вместе с rels-ссылками (по типу, включая `TargetMode=External`) и Override удалённых частей. Элементы `<w:object>` из `word/*.xml` не выбрасываются, а заменяются статичным представлением — картинкой-плейсхолдером (ECMA-376 §15.2.10): `w:drawing` переиспользуется дословно, `v:imagedata r:id` → inline-DrawingML на ту же image-часть (размер из `style` `v:shape`, иначе `w:dxaOrig`/`w:dyaOrig` ×635), блоки с `w:control` и без плейсхолдера удаляются. OLE-бинарники никогда не читаются. При `errorOnOle=true` вместо вычистки — `OleFoundException`. Лечит оба механизма падения docx4j: JAXB-разбор бинарника под ложным XML-типом («Content is not allowed in prolog» → NPE) и NPE `chunkType is null` в VML-сериализации `w:object`. Многочастный: публичный член только `normalize(byte[], boolean)`, `rewrite`-хука нет.
|
||||
|
||||
`mc-preprocessor.xslt` docx4j (в jar `docx4j-core`) перебивает strict-namespace'ы в transitional и конвертит `pt` в twips/half-points, но ветку перевода процентов в тысячные для namespace'ных атрибутов содержит с закомментированным `<xsl:value-of select="$cleanValue * 1000"/>` (для атрибутов без namespace — она активна), а `w:start`/`w:end` в `w:left`/`w:right` не маппит вовсе. Поэтому собственный рерайт URI ломать нельзя — он сломал бы pt-конверсию preprocessor'а (FOP получил бы «10pt»).
|
||||
|
||||
@@ -4,9 +4,9 @@
|
||||
|
||||
| Путь | Назначение |
|
||||
|---|---|
|
||||
| `wordpdf-core/src/main/java/ru/pjandro/wordpdf/` | Публичный API: `WordPdfConverter` (`convert(byte[],String,ConvertOptions)`), `WordPdfValidator` (`checkInput`/`validate` наружу; `checkPageCount`/`checkPageCountDoc`/`isBinaryDoc` — package-private, всё без зависимости от docx4j), `ConversionException`, `ValidationException` (наследник — «вход некорректен»), `DrawingFoundException` (`enum Kind {CHARTS, SMARTART, OLE}`), `ConvertOptions` (record; дефолтов в ядре нет). Пороги защиты — производные от лимитов входа: `WordPdfValidator.maxDecompressedBytes`/`maxDecompressedXmlBytes` (`max(MIN_*×MiB, maxMb×10/4MiB + maxPages×64/32KiB)`, крышек нет), `maxZipEntries` (`max(2048, maxMb×512 + maxPages×32)`), `maxImagePixels` (`maxMb×5_000_000`); коэффициенты и полы — package-private литералы `WordPdfConverter` (`DECOMPRESS_*`, `MIN_DECOMPRESSED_*`, `IMAGE_PIXELS_PER_MAX_MB`, `ZIP_ENTRIES_*`, javac их инлайнит — валидатор не инициализирует конвертер) |
|
||||
| `wordpdf-core/src/main/java/ru/pjandro/wordpdf/` | Публичный API: `WordPdfConverter` (`convert(byte[],String,ConvertOptions)`), `WordPdfValidator` (`checkInput`/`validate` наружу; `checkPageCount`/`checkPageCountDoc`/`isBinaryDoc` — package-private, всё без зависимости от docx4j), `ConversionException`, `ValidationException` (наследник — «вход некорректен»), `ChartsFoundException`/`SmartArtFoundException`/`OleFoundException` (по error-флагам), `ConvertOptions` (record; дефолтов в ядре нет). Пороги защиты — производные от лимитов входа: `WordPdfValidator.maxDecompressedBytes`/`maxDecompressedXmlBytes` (`max(MIN_*×MiB, maxMb×10/4MiB + maxPages×64/32KiB)`, крышек нет), `maxZipEntries` (`max(2048, maxMb×512 + maxPages×32)`), `maxImagePixels` (`maxMb×5_000_000`); коэффициенты и полы — package-private литералы `WordPdfConverter` (`DECOMPRESS_*`, `MIN_DECOMPRESSED_*`, `IMAGE_PIXELS_PER_MAX_MB`, `ZIP_ENTRIES_*`, javac их инлайнит — валидатор не инициализирует конвертер) |
|
||||
| `…/wordpdf/fonts/` | `BundledFonts` (реестр/выгрузка TTF), `BundledFontMapper` (алиасы, self-map, `DISPLAY_NAMES`, `bundledFamily`), `GlyphFont` (глиф-движок fontbox) |
|
||||
| `…/wordpdf/internal/` | 11 нормализаторов + `DocxRewritePipeline` (один zip-проход правил 1–10, raw-копия неизменённых записей) + `LayoutPostRenderer` (кастомный `FORenderer`, post-FO padding-компенсация таблиц, шаг 4.25) + интерфейс `DocxNormalizer` + `FopFallbackFonts` + `DependencyGuard` (проверка commons-compress, шаг 0). Классы package-private; `public` — `DocxNormalizer`, `DocxRewritePipeline` (наружу только `STEP`, `normalize` package-private), `OleObjectNormalizer`, `FopFallbackFonts` (`declare`), `LayoutPostRenderer` (`register`), `DependencyGuard` (`check`), остальные нормализаторы полностью package-private; `OleObjectNormalizer` — многочастный, публичный `normalize(byte[], boolean)`, бросает `DrawingFoundException(OLE)` |
|
||||
| `…/wordpdf/internal/` | 11 нормализаторов + `DocxRewritePipeline` (один zip-проход правил 1–10, raw-копия неизменённых записей) + `LayoutPostRenderer` (кастомный `FORenderer`, post-FO padding-компенсация таблиц, шаг 4.25) + интерфейс `DocxNormalizer` + `FopFallbackFonts` + `DependencyGuard` (проверка commons-compress, шаг 0). Классы package-private; `public` — `DocxNormalizer`, `DocxRewritePipeline` (наружу только `STEP`, `normalize` package-private), `OleObjectNormalizer`, `FopFallbackFonts` (`declare`), `LayoutPostRenderer` (`register`), `DependencyGuard` (`check`), остальные нормализаторы полностью package-private; `OleObjectNormalizer` — многочастный, публичный `normalize(byte[], boolean)`, бросает `OleFoundException` |
|
||||
| `…/wordpdf/internal/doc/` | Мост `.doc` → `.docx`: 18 классов (детали — `docs/agent/doc-bridge.md`) — `CfbReader`, `FibHeader`, `PieceTable`, `Grpprl`, `ChpxIndex`, `PapxIndex`, `Styles`, `Tables`, `Lists`, `Sections`, `FontTable`, `SummaryInfo`, `Headers`, `OfficeArt`, `PrcData`, `DocFile`, `DocxWriter`, `DocToDocx` (публичные `convert`/`countPages`; вложенный `DocxBody` — рендер текста и табличного автомата в XML) |
|
||||
| `…/wordpdf/internal/chart/` |18 классов Java2D-рендера диаграмм/SmartArt в PNG (public: `DrawingPreRenderer.run` и `ChartImageHandler` — второй инстанцируется из `WordPdfConverter`)|
|
||||
| `wordpdf-core/src/main/resources/fonts/` | 30 TTF + 3 лицензии — бинарные фикстуры, часть jar |
|
||||
|
||||
@@ -3,9 +3,11 @@ package ru.pjandro.wordpdf.app;
|
||||
import jakarta.annotation.PreDestroy;
|
||||
import org.springframework.beans.factory.annotation.Value;
|
||||
import org.springframework.stereotype.Service;
|
||||
import ru.pjandro.wordpdf.ChartsFoundException;
|
||||
import ru.pjandro.wordpdf.ConvertOptions;
|
||||
import ru.pjandro.wordpdf.ConversionException;
|
||||
import ru.pjandro.wordpdf.DrawingFoundException;
|
||||
import ru.pjandro.wordpdf.OleFoundException;
|
||||
import ru.pjandro.wordpdf.SmartArtFoundException;
|
||||
import ru.pjandro.wordpdf.WordPdfConverter;
|
||||
import ru.pjandro.wordpdf.WordPdfValidator;
|
||||
import ru.pjandro.wordpdf.ValidationException;
|
||||
@@ -141,10 +143,14 @@ final class ConversionService {
|
||||
// отказ проверки страниц внутри конвейера ядра — некорректный
|
||||
// вход (400), а не ошибка рендера: без этого утонул бы в 500
|
||||
throw e;
|
||||
} catch (DrawingFoundException e) {
|
||||
} catch (ChartsFoundException e) {
|
||||
// отказ по настройке запроса (error-флаг) — не ошибка рендера: 422,
|
||||
// иначе утонет в общем catch ниже как 500
|
||||
throw new DrawingRejectedException(e.kind());
|
||||
throw new DrawingRejectedException(DrawingRejectedException.CHARTS);
|
||||
} catch (SmartArtFoundException e) {
|
||||
throw new DrawingRejectedException(DrawingRejectedException.SMART_ART);
|
||||
} catch (OleFoundException e) {
|
||||
throw new DrawingRejectedException(DrawingRejectedException.OLE);
|
||||
} catch (ConversionException e) {
|
||||
// всё, что упало на валидации/рендер-стадии ядра, — ошибка преобразования, 500
|
||||
throw new ConversionFailedException("Не удалось конвертировать документ: "
|
||||
|
||||
@@ -1,28 +1,25 @@
|
||||
package ru.pjandro.wordpdf.app;
|
||||
|
||||
import ru.pjandro.wordpdf.DrawingFoundException;
|
||||
import ru.pjandro.wordpdf.ChartsFoundException;
|
||||
import ru.pjandro.wordpdf.OleFoundException;
|
||||
import ru.pjandro.wordpdf.SmartArtFoundException;
|
||||
|
||||
/**
|
||||
* Документ содержит диаграммы/SmartArt/OLE-объекты при включённом error-флаге
|
||||
* ({@link DrawingFoundException} ядра).
|
||||
* ({@link ChartsFoundException}, {@link SmartArtFoundException} или
|
||||
* {@link OleFoundException} ядра).
|
||||
*
|
||||
* <p>Маппится в HTTP 422 ({@link ApiExceptionHandler}); клиенту осмысленно
|
||||
* повторить без error-флага. Текст сообщения —
|
||||
* пользовательский контракт: фронт показывает его дословно.</p>
|
||||
* повторить без error-флага.</p>
|
||||
*/
|
||||
class DrawingRejectedException extends RuntimeException {
|
||||
|
||||
DrawingRejectedException(DrawingFoundException.Kind kind) {
|
||||
super(message(kind));
|
||||
}
|
||||
/** Тексты — пользовательский контракт: фронт показывает их дословно. */
|
||||
static final String CHARTS = "Конвертация отменена: в документе найдены диаграммы";
|
||||
static final String SMART_ART = "Конвертация отменена: в документе найден SmartArt";
|
||||
static final String OLE = "Конвертация отменена: в документе найдены OLE-объекты";
|
||||
|
||||
// switch вынесен из super(): парсер PMD 7.17 (движок maven-pmd-plugin)
|
||||
// падает на switch-выражении в аргументе super (pmd/pmd#6234).
|
||||
private static String message(DrawingFoundException.Kind kind) {
|
||||
return switch (kind) {
|
||||
case CHARTS -> "Конвертация отменена: в документе найдены диаграммы";
|
||||
case SMARTART -> "Конвертация отменена: в документе найден SmartArt";
|
||||
case OLE -> "Конвертация отменена: в документе найдены OLE-объекты";
|
||||
};
|
||||
DrawingRejectedException(String message) {
|
||||
super(message);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -189,7 +189,8 @@ class ConvertControllerTest {
|
||||
|
||||
/**
|
||||
* errorOnSmartArt=true — HTTP 422 с текстом про SmartArt (диаграммы
|
||||
* конвертируются, их error-флаг выключен, поэтому бросается целевой Kind).
|
||||
* конвертируются, их error-флаг выключен, поэтому бросается
|
||||
* {@code SmartArtFoundException}).
|
||||
* Регрессия — WordPdfConverterTest#drawingErrors_errorFlagRejectsSmartArt,
|
||||
* фикстура samples/charts-smartart.docx.
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
package ru.pjandro.wordpdf;
|
||||
|
||||
/**
|
||||
* В документе найдены диаграммы, а их обработка запрещена включённым
|
||||
* {@link ConvertOptions#errorOnCharts()}. Исключение отвергает документ целиком.
|
||||
*
|
||||
* <p>Наследник {@link ConversionException} — наружу по-прежнему ловится и он.
|
||||
* Регрессия — WordPdfConverterTest#drawingErrors_errorFlagRejectsCharts,
|
||||
* фикстура samples/charts-smartart.docx.</p>
|
||||
*/
|
||||
public final class ChartsFoundException extends ConversionException {
|
||||
|
||||
public ChartsFoundException() {
|
||||
super("В документе найдены диаграммы, а их обработка запрещена (errorOnCharts)");
|
||||
}
|
||||
}
|
||||
@@ -6,9 +6,9 @@ package ru.pjandro.wordpdf;
|
||||
* сервера как дефолт REST-эндпоинта + параметры запроса). Диаграммы/SmartArt
|
||||
* конвертируются всегда.
|
||||
*
|
||||
* @param errorOnCharts бросать {@link DrawingFoundException} при находке диаграмм
|
||||
* @param errorOnSmartArt бросать {@link DrawingFoundException} при находке SmartArt
|
||||
* @param errorOnOle бросать {@link DrawingFoundException} при находке OLE-объектов
|
||||
* @param errorOnCharts бросать {@link ChartsFoundException} при находке диаграмм
|
||||
* @param errorOnSmartArt бросать {@link SmartArtFoundException} при находке SmartArt
|
||||
* @param errorOnOle бросать {@link OleFoundException} при находке OLE-объектов
|
||||
* (иначе — тихо удалить их из документа)
|
||||
* @param maxMb лимит размера входа в МБ (MiB) на этот вызов;
|
||||
* должен быть больше 0
|
||||
|
||||
@@ -1,45 +0,0 @@
|
||||
package ru.pjandro.wordpdf;
|
||||
|
||||
/**
|
||||
* Документ содержит объект, находку которого вызывающий запретил:
|
||||
* соответствующий error-флаг включён
|
||||
* ({@link ConvertOptions#errorOnCharts()}, {@link ConvertOptions#errorOnSmartArt()},
|
||||
* {@link ConvertOptions#errorOnOle()}).
|
||||
* Диаграммы/SmartArt конвертируются всегда; OLE-объекты при выключенном
|
||||
* {@code errorOnOle} теряют свои данные, но сохраняют картинку-плейсхолдер
|
||||
* (в отличие от них).
|
||||
* Исключение отвергает документ целиком.
|
||||
*
|
||||
* <p>Наследник {@link ConversionException} — наружу по-прежнему ловится
|
||||
* только он; {@code kind()} даёт вызывающему тип объекта без разбора текста.
|
||||
* Регрессия — WordPdfConverterTest#drawingErrors_errorFlagRejectsCharts,
|
||||
* фикстура samples/charts-smartart.docx; OLE —
|
||||
* WordPdfConverterTest#drawingErrors_errorFlagRejectsOle,
|
||||
* фикстура samples/ole-embedded.docx.</p>
|
||||
*/
|
||||
public class DrawingFoundException extends ConversionException {
|
||||
|
||||
/** Тип найденного объекта. */
|
||||
public enum Kind { CHARTS, SMARTART, OLE }
|
||||
|
||||
private final Kind kind;
|
||||
|
||||
public DrawingFoundException(Kind kind) {
|
||||
super(message(kind));
|
||||
this.kind = kind;
|
||||
}
|
||||
|
||||
// switch вынесен из super(): парсер PMD 7.17 (движок maven-pmd-plugin)
|
||||
// падает на switch-выражении в аргументе super (pmd/pmd#6234).
|
||||
private static String message(Kind kind) {
|
||||
return switch (kind) {
|
||||
case CHARTS -> "В документе найдены диаграммы, а их обработка запрещена (errorOnCharts)";
|
||||
case SMARTART -> "В документе найден SmartArt, а его обработка запрещена (errorOnSmartArt)";
|
||||
case OLE -> "В документе найдены OLE-объекты, а их обработка запрещена (errorOnOle)";
|
||||
};
|
||||
}
|
||||
|
||||
public Kind kind() {
|
||||
return kind;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,22 @@
|
||||
package ru.pjandro.wordpdf;
|
||||
|
||||
/**
|
||||
* В документе найдены OLE-объекты, а их обработка запрещена включённым
|
||||
* {@link ConvertOptions#errorOnOle()}. Исключение отвергает документ целиком.
|
||||
*
|
||||
* <p>При выключенном флаге OLE-объекты теряют свои данные, но сохраняют
|
||||
* картинку-плейсхолдер (в отличие от диаграмм/SmartArt, конвертируемых
|
||||
* всегда). Флаг действует только на {@code .docx}: в бинарном {@code .doc}
|
||||
* вложения OLE — форматирование U+0001, мост деградирует их до картинки,
|
||||
* поэтому находки OLE там не бывает.</p>
|
||||
*
|
||||
* <p>Наследник {@link ConversionException} — наружу по-прежнему ловится и он.
|
||||
* Регрессия — WordPdfConverterTest#drawingErrors_errorFlagRejectsOle,
|
||||
* фикстура samples/ole-embedded.docx; OleObjectNormalizerTest#errorOnOleThrowsOleFound.</p>
|
||||
*/
|
||||
public final class OleFoundException extends ConversionException {
|
||||
|
||||
public OleFoundException() {
|
||||
super("В документе найдены OLE-объекты, а их обработка запрещена (errorOnOle)");
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,16 @@
|
||||
package ru.pjandro.wordpdf;
|
||||
|
||||
/**
|
||||
* В документе найден SmartArt, а его обработка запрещена включённым
|
||||
* {@link ConvertOptions#errorOnSmartArt()}. Исключение отвергает документ целиком.
|
||||
*
|
||||
* <p>Наследник {@link ConversionException} — наружу по-прежнему ловится и он.
|
||||
* Регрессия — WordPdfConverterTest#drawingErrors_errorFlagRejectsSmartArt,
|
||||
* фикстура samples/charts-smartart.docx.</p>
|
||||
*/
|
||||
public final class SmartArtFoundException extends ConversionException {
|
||||
|
||||
public SmartArtFoundException() {
|
||||
super("В документе найден SmartArt, а его обработка запрещена (errorOnSmartArt)");
|
||||
}
|
||||
}
|
||||
@@ -469,7 +469,7 @@ public final class WordPdfConverter {
|
||||
// рерайтов внутри части фиксирован (DocxRewritePipeline)
|
||||
DocxRewritePipeline.STEP,
|
||||
// OLE-объекты: при выключенном errorOnOle тихо удаляем
|
||||
// (часть/rels/w:object), при включённом — DrawingFoundException
|
||||
// (часть/rels/w:object), при включённом — OleFoundException
|
||||
// (OleObjectNormalizer); второй проход, т.к. меняет части, а не XML
|
||||
bytes -> OleObjectNormalizer.normalize(bytes, options.errorOnOle()));
|
||||
}
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
package ru.pjandro.wordpdf.internal;
|
||||
|
||||
import ru.pjandro.wordpdf.DrawingFoundException;
|
||||
import ru.pjandro.wordpdf.OleFoundException;
|
||||
|
||||
import java.io.ByteArrayOutputStream;
|
||||
import java.io.IOException;
|
||||
@@ -48,7 +48,7 @@ import org.apache.commons.compress.utils.SeekableInMemoryByteChannel;
|
||||
* вывод не влияет.</p>
|
||||
*
|
||||
* <p>Отличие от остальных нормализаторов пакета: принимает флаг
|
||||
* {@code errorOnOle} и умеет бросать {@link DrawingFoundException}
|
||||
* {@code errorOnOle} и умеет бросать {@link OleFoundException}
|
||||
* (при включённом флаге документ отвергается вместо вычистки), и правит
|
||||
* не только {@code word/*.xml}, но и {@code [Content_Types].xml} с
|
||||
* {@code *.rels}. Хука {@code rewrite(String)} нет — нормализатор
|
||||
@@ -231,7 +231,7 @@ public final class OleObjectNormalizer {
|
||||
return docx;
|
||||
}
|
||||
if (errorOnOle) {
|
||||
throw new DrawingFoundException(DrawingFoundException.Kind.OLE);
|
||||
throw new OleFoundException();
|
||||
}
|
||||
for (String part : oleParts) {
|
||||
LOG.warning("Удалён OLE-объект: " + part);
|
||||
|
||||
+8
-5
@@ -35,9 +35,10 @@ import org.docx4j.openpackaging.parts.relationships.RelationshipsPart;
|
||||
import org.docx4j.wml.Drawing;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
import ru.pjandro.wordpdf.ChartsFoundException;
|
||||
import ru.pjandro.wordpdf.ConvertOptions;
|
||||
import ru.pjandro.wordpdf.ConversionException;
|
||||
import ru.pjandro.wordpdf.DrawingFoundException;
|
||||
import ru.pjandro.wordpdf.SmartArtFoundException;
|
||||
|
||||
import javax.imageio.ImageIO;
|
||||
import java.awt.image.BufferedImage;
|
||||
@@ -60,7 +61,8 @@ import java.util.Set;
|
||||
* и молча их выбросит (notImplemented в шаблоне).
|
||||
*
|
||||
* Error-флаги {@link ConvertOptions}: при выключенном render-флаге и
|
||||
* включённом error-флаге находка объекта — {@link DrawingFoundException}
|
||||
* включённом error-флаге находка объекта — {@link ChartsFoundException} или
|
||||
* {@link SmartArtFoundException}
|
||||
* (бросок здесь, на шаге 3.5, до XSLT/FOP). Регрессия —
|
||||
* WordPdfConverterTest#drawingErrors_errorFlagRejectsCharts, фикстура
|
||||
* samples/charts-smartart.docx.
|
||||
@@ -99,7 +101,8 @@ public final class DrawingPreRenderer {
|
||||
|
||||
/**
|
||||
* Рендерит диаграммы/SmartArt пакета в PNG и подменяет их картинками —
|
||||
* объекты конвертируются всегда. Бросается {@link DrawingFoundException},
|
||||
* объекты конвертируются всегда. Бросается {@link ChartsFoundException} или
|
||||
* {@link SmartArtFoundException},
|
||||
* когда для объектов включён error-флаг ({@link ConvertOptions}).
|
||||
*/
|
||||
public static void run(WordprocessingMLPackage pkg, ConvertOptions options) {
|
||||
@@ -225,10 +228,10 @@ public final class DrawingPreRenderer {
|
||||
boolean isChart = CHART_ELEMENT.equals(name);
|
||||
boolean isDiagram = DIAGRAM_ELEMENT.equals(name);
|
||||
if (isChart && options.errorOnCharts()) {
|
||||
throw new DrawingFoundException(DrawingFoundException.Kind.CHARTS);
|
||||
throw new ChartsFoundException();
|
||||
}
|
||||
if (isDiagram && options.errorOnSmartArt()) {
|
||||
throw new DrawingFoundException(DrawingFoundException.Kind.SMARTART);
|
||||
throw new SmartArtFoundException();
|
||||
}
|
||||
if (cx <= 0 || cy <= 0 || cx > MAX_EXTENT_EMU || cy > MAX_EXTENT_EMU) {
|
||||
LOG.warn("drawing вне допустимого wp:extent (cx={}, cy={}) — объект оставлен как есть",
|
||||
|
||||
@@ -277,38 +277,32 @@ class WordPdfConverterTest {
|
||||
}
|
||||
|
||||
/**
|
||||
* errorOnCharts=true: находка диаграмм — {@link DrawingFoundException}
|
||||
* с {@code Kind.CHARTS}, документ отвергается целиком. Error-флаг SmartArt
|
||||
* errorOnCharts=true: находка диаграмм — {@link ChartsFoundException},
|
||||
* документ отвергается целиком. Error-флаг SmartArt
|
||||
* выключен — он конвертируется как обычно, бросок происходит на графике.
|
||||
*/
|
||||
@Test
|
||||
void drawingErrors_errorFlagRejectsCharts() throws Exception {
|
||||
ConversionException ex = assertThrows(ConversionException.class, () ->
|
||||
ChartsFoundException ex = assertThrows(ChartsFoundException.class, () ->
|
||||
convertPdf(sampleBytes("charts-smartart.docx"), "charts-smartart",
|
||||
new ConvertOptions(true, false, false,
|
||||
5, 100)));
|
||||
|
||||
assertTrue(ex instanceof DrawingFoundException dfe
|
||||
&& dfe.kind() == DrawingFoundException.Kind.CHARTS,
|
||||
"ожидался DrawingFoundException(CHARTS), получено: " + ex);
|
||||
assertTrue(ex.getMessage().contains("диаграмм"),
|
||||
"сообщение должно упоминать диаграммы: " + ex.getMessage());
|
||||
}
|
||||
|
||||
/**
|
||||
* Зеркальный случай: errorOnSmartArt=true — {@code Kind.SMARTART};
|
||||
* Зеркальный случай: errorOnSmartArt=true — {@link SmartArtFoundException};
|
||||
* диаграммы конвертируются (их error-флаг выключен).
|
||||
*/
|
||||
@Test
|
||||
void drawingErrors_errorFlagRejectsSmartArt() throws Exception {
|
||||
ConversionException ex = assertThrows(ConversionException.class, () ->
|
||||
SmartArtFoundException ex = assertThrows(SmartArtFoundException.class, () ->
|
||||
convertPdf(sampleBytes("charts-smartart.docx"), "charts-smartart",
|
||||
new ConvertOptions(false, true, false,
|
||||
5, 100)));
|
||||
|
||||
assertTrue(ex instanceof DrawingFoundException dfe
|
||||
&& dfe.kind() == DrawingFoundException.Kind.SMARTART,
|
||||
"ожидался DrawingFoundException(SMARTART), получено: " + ex);
|
||||
assertTrue(ex.getMessage().contains("SmartArt"),
|
||||
"сообщение должно упоминать SmartArt: " + ex.getMessage());
|
||||
}
|
||||
@@ -349,7 +343,7 @@ class WordPdfConverterTest {
|
||||
}
|
||||
|
||||
/**
|
||||
* errorOnOle=true — {@link DrawingFoundException} с {@code Kind.OLE},
|
||||
* errorOnOle=true — {@link OleFoundException},
|
||||
* документ отвергается. Фикстура samples/ole-embedded.docx.
|
||||
*
|
||||
* <p>Флаг действует только на .docx: в бинарном .doc OLE-объект —
|
||||
@@ -358,14 +352,11 @@ class WordPdfConverterTest {
|
||||
*/
|
||||
@Test
|
||||
void drawingErrors_errorFlagRejectsOle() throws Exception {
|
||||
ConversionException ex = assertThrows(ConversionException.class, () ->
|
||||
OleFoundException ex = assertThrows(OleFoundException.class, () ->
|
||||
convertPdf(sampleBytes("ole-embedded.docx"), "ole-embedded",
|
||||
new ConvertOptions(false, false, true,
|
||||
5, 100)));
|
||||
|
||||
assertTrue(ex instanceof DrawingFoundException dfe
|
||||
&& dfe.kind() == DrawingFoundException.Kind.OLE,
|
||||
"ожидался DrawingFoundException(OLE), получено: " + ex);
|
||||
assertTrue(ex.getMessage().contains("OLE-объект"),
|
||||
"сообщение должно упоминать OLE-объекты: " + ex.getMessage());
|
||||
}
|
||||
@@ -1368,19 +1359,16 @@ class WordPdfConverterTest {
|
||||
|
||||
/**
|
||||
* Error-флаг обязан сработать и для drawing без wp:extent: детект payload
|
||||
* идёт до extent-guard'а (иначе обход — DrawingFoundException(CHARTS)).
|
||||
* идёт до extent-guard'а (иначе обход — ChartsFoundException).
|
||||
* Регрессия — DrawingPreRenderer#replaceDrawing.
|
||||
*/
|
||||
@Test
|
||||
void chartWithoutExtent_errorFlagRejects() throws Exception {
|
||||
byte[] docx = chartDocx(0, 0, PLAIN_VALAX);
|
||||
ConversionException ex = assertThrows(ConversionException.class, () ->
|
||||
assertThrows(ChartsFoundException.class, () ->
|
||||
convertPdf(docx, "no-extent",
|
||||
new ConvertOptions(true, false, false,
|
||||
5, 100)));
|
||||
assertTrue(ex instanceof DrawingFoundException dfe
|
||||
&& dfe.kind() == DrawingFoundException.Kind.CHARTS,
|
||||
"ожидался DrawingFoundException(CHARTS), получено: " + ex);
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
package ru.pjandro.wordpdf.internal;
|
||||
|
||||
import org.junit.jupiter.api.Test;
|
||||
import ru.pjandro.wordpdf.DrawingFoundException;
|
||||
import ru.pjandro.wordpdf.OleFoundException;
|
||||
|
||||
import java.io.ByteArrayInputStream;
|
||||
import java.io.ByteArrayOutputStream;
|
||||
@@ -197,10 +197,9 @@ class OleObjectNormalizerTest {
|
||||
}
|
||||
|
||||
@Test
|
||||
void errorOnOleThrowsDrawingFound() throws Exception {
|
||||
DrawingFoundException ex = assertThrows(DrawingFoundException.class,
|
||||
void errorOnOleThrowsOleFound() throws Exception {
|
||||
assertThrows(OleFoundException.class,
|
||||
() -> OleObjectNormalizer.normalize(referencedDocx(), true));
|
||||
assertEquals(DrawingFoundException.Kind.OLE, ex.kind());
|
||||
}
|
||||
|
||||
@Test
|
||||
@@ -668,9 +667,8 @@ class OleObjectNormalizerTest {
|
||||
m.put("word/document.xml",
|
||||
utf8("x".repeat(8188) + "<w:object>" + "</w:object>"));
|
||||
|
||||
DrawingFoundException ex = assertThrows(DrawingFoundException.class,
|
||||
assertThrows(OleFoundException.class,
|
||||
() -> OleObjectNormalizer.normalize(zip(m), true));
|
||||
assertEquals(DrawingFoundException.Kind.OLE, ex.kind());
|
||||
}
|
||||
|
||||
/** errorOnOle и только w:object-разметка (без bin-части) — документ отвергается. */
|
||||
@@ -683,9 +681,8 @@ class OleObjectNormalizerTest {
|
||||
m.put("word/_rels/document.xml.rels", utf8(DOCRELS_OLE_AND_IMAGE));
|
||||
m.put("word/media/fallback.png", PNG);
|
||||
|
||||
DrawingFoundException ex = assertThrows(DrawingFoundException.class,
|
||||
assertThrows(OleFoundException.class,
|
||||
() -> OleObjectNormalizer.normalize(zip(m), true));
|
||||
assertEquals(DrawingFoundException.Kind.OLE, ex.kind());
|
||||
}
|
||||
|
||||
/** doc из переданных блоков w:object (все ссылаются на rId1/rId2 из DOCRELS_OLE_AND_IMAGE). */
|
||||
|
||||
Reference in New Issue
Block a user