From 6b2715f1c2ba55e1246464dc3f1d9f58a727df73 Mon Sep 17 00:00:00 2001 From: Pjandro Date: Thu, 22 Oct 2026 17:50:17 +0000 Subject: [PATCH] =?UTF-8?q?=D0=A3=D0=B1=D1=80=D0=B0=D1=82=D1=8C=20render-?= =?UTF-8?q?=D1=84=D0=BB=D0=B0=D0=B3=D0=B8=20=D0=B4=D0=B8=D0=B0=D0=B3=D1=80?= =?UTF-8?q?=D0=B0=D0=BC=D0=BC/SmartArt;=20=D0=B0=D0=B2=D1=82=D0=BE=D0=B7?= =?UTF-8?q?=D0=B0=D0=B3=D0=BE=D0=BB=D0=BE=D0=B2=D0=BE=D0=BA=20=E2=80=94=20?= =?UTF-8?q?=C2=AB=D0=9D=D0=B0=D0=B7=D0=B2=D0=B0=D0=BD=D0=B8=D0=B5=20=D0=B4?= =?UTF-8?q?=D0=B8=D0=B0=D0=B3=D1=80=D0=B0=D0=BC=D0=BC=D1=8B=C2=BB?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ConvertOptions: renderCharts/renderSmartArt удалены (ядро, REST, SPA, прод-автотесты) — диаграммы/SmartArt конвертируются всегда, отказ только по error-флагам (DrawingFoundException → 422). Дефолт SPA-галок — false. ChartSpec.AUTO_TITLE русифицирован: «Название диаграммы». AGENTS.md приведён в соответствие. --- AGENTS.md | 18 ++--- prod-autotests/test_prod_api.py | 18 +---- .../wordpdf/app/ConvertController.java | 9 +-- .../wordpdf/app/DrawingRejectedException.java | 6 +- .../wordpdf/app/ConvertControllerTest.java | 58 ++++----------- .../ru/pjandro/wordpdf/ConvertOptions.java | 23 ++---- .../wordpdf/DrawingFoundException.java | 6 +- .../ru/pjandro/wordpdf/WordPdfConverter.java | 4 +- .../ru/pjandro/wordpdf/WordPdfSettings.java | 17 +---- .../wordpdf/internal/chart/ChartSpec.java | 10 +-- .../internal/chart/DrawingPreRenderer.java | 22 ++---- .../pjandro/wordpdf/WordPdfConverterTest.java | 72 +++---------------- .../pjandro/wordpdf/WordPdfValidatorTest.java | 2 +- .../wordpdf/internal/chart/ChartSpecTest.java | 2 +- wordpdf-web/src/api.ts | 8 +-- wordpdf-web/src/components/App.tsx | 54 ++------------ 16 files changed, 78 insertions(+), 251 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index cf23257..4bcf9a7 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -13,13 +13,13 @@ 1. `new BundledFontMapper()` → `BundledFonts.init()` → `BundledFonts.restrictToBundled()`. Конструктор маппера каждый раз добавляет системные шрифты в реестр `PhysicalFonts`; ключ реестра — имя из name-таблицы TTF, `addPhysicalFont(URI)` не перезаписывает занятый → `init()` вызывает `dropNonBundled()` **до** регистрации и `load()` (иначе системный Calibri ломает em-dash-fallback). 2. Нормализация байтов docx до JAXB-загрузки (цепочка `byte[] → byte[]`, порядок значим): `StrictOoxmlNormalizer` (strict-OOXML → transitional-байт: `a:`-проценты и `w14:fillToRect` → тысячные ×1000, текст `wp14:pctWidth`/`pctHeight`, элементы и атрибуты `w:start`/`w:end` → `w:left`/`w:right` (кроме `w:lvl/w:start` в numbering.xml), значения `start`/`end` у `w:jc`/`w:tab`; в `mc-preprocessor.xslt` docx4j ветка `%` закомментирована, start/end не маппятся; namespaces и `pt`-значения правит сам mc-preprocessor — собственный рерайт URI ломает его pt-конверсию) → `DocxOnOffNormalizer` (`w:val="off"/"on"` → `false`/`true`) → `SymbolFontNormalizer` (PUA U+F0xx Symbol/Wingdings/Webdings → Unicode + DejaVu Sans, переписывает и элементы ``; 5 карт по 256 слотов, таблица `SymbolMapper` сгенерирована из docx4j 17.x) → `FieldNormalizer` (`fldChar` PAGE/NUMPAGES/SECTIONPAGES → `w:fldSimple`, вложенные/битые поля пропускает) → `GlyphCoverageNormalizer` (режет ран по покрытию глифов, пишет семейство в `w:rFonts`, иначе FOP рисует «#»; покрытие — `GlyphFont` (fontbox, cmap) + BitSet-кэш, НЕ docx4j `GlyphCheck` — тот плодит INFO-лог, `java.awt.Font` требовал fontconfig на хосте; для serif-ран fallback ищется сначала в `SERIF_FAMILIES` (DejaVu Serif/Tinos/Caladea), затем в sans) → `WordprocessingMLPackage.load`. 3. `WordPdfValidator.checkPageCount(docxBytes, maxPages)` — **до** рендера, lightweight (zip/StAX) по нормализованным байтам — тот же путь, что у приложения до очереди. -4. `pkg.setFontMapper(mapper)` → `DrawingPreRenderer.run(pkg, options)` (шаг 3.5: `c:chart`/`dgm:relIds` docx2fo.xslt не умеет — свой Java2D-движок `internal/chart/*` рендерит в PNG 300 dpi и подменяет на `pic:pic`; объект, выключенный в `ConvertOptions`, пропускается до рендера и остаётся в docx; упавший рендер — объект **удаляется** из docx (`gd.getAny().clear()`) + warn, деградация не падение). +4. `pkg.setFontMapper(mapper)` → `DrawingPreRenderer.run(pkg, options)` (шаг 3.5: `c:chart`/`dgm:relIds` docx2fo.xslt не умеет — свой Java2D-движок `internal/chart/*` рендерит в PNG 300 dpi и подменяет на `pic:pic`; объекты конвертируются всегда, отказ только по error-флагу `ConvertOptions` — `DrawingFoundException`; упавший рендер — объект **удаляется** из docx (`gd.getAny().clear()`) + warn, деградация не падение). 5. `new FOSettings(pkg)` + `FopFallbackFonts.declare` (декларирует **все** бандл-семейства — FOP встраивает только задекларированные) → `FORendererApacheFOP`/`FOUserAgent` (непустой `title` → заголовок PDF) → `Docx4J.toFO(..., FLAG_EXPORT_PREFER_XSL)`. 6. `finally`: `deleteEmbeddedFontTempFiles()` (в 17.x `OpcPackage.close()` нет). ### REST API (`wordpdf-app`, всё package-private кроме `WordPdfApplication`) -- Единственный эндпоинт `POST /api/v1/convert` (multipart-поле `file`, факультативные query/form-параметры `renderCharts`/`renderSmartArt`/`errorOnCharts`/`errorOnSmartArt`) → `application/pdf`, `Content-Disposition: attachment; filename*=UTF-8''…`. Проверка `.docx`-расширения — в `ConvertController`; `safeBaseName` в `ConversionService` — единый источник имени для файла, заголовка ответа и PDF-title (разрешены `[\p{L}\p{N} ._-]`, пустое → `document`). +- Единственный эндпоинт `POST /api/v1/convert` (multipart-поле `file`, факультативные query/form-параметры `errorOnCharts`/`errorOnSmartArt`; диаграммы/SmartArt конвертируются всегда) → `application/pdf`, `Content-Disposition: attachment; filename*=UTF-8''…`. Проверка `.docx`-расширения — в `ConvertController`; `safeBaseName` в `ConversionService` — единый источник имени для файла, заголовка ответа и PDF-title (разрешены `[\p{L}\p{N} ._-]`, пустое → `document`). - Конвертации **сериализованы** однопоточным `ThreadPoolExecutor` (`ConversionService.QUEUE_CAPACITY = 16`, переполнение → 503): ядро мутирует глобальный реестр `PhysicalFonts`. `future.cancel(true)` при таймауте не останавливает FOP мгновенно — осознанный компромисс. - Ошибки (`ApiExceptionHandler`, тело `{"error": …}`): `ValidationException` → 400; `DrawingRejectedException` (core-`DrawingFoundException` от error-флагов, конвертируется в `ConversionService.doConvert`) → **422** (текст — контракт с фронтом, показывается дословно); `ConversionFailedException` → 500; `ConversionRejectedException` → 503; `ConversionTimeoutException` (`wordpdf.convert-timeout`, 2m) → 504; `MaxUploadSizeExceededException` → 413; `MissingServletRequestPartException`/`MissingServletRequestParameterException` → 400; `NoResourceFoundException` (неизвестный путь) → 404; catch-all → 500 (подробности только в лог). `ValidationException` — тип ядра `ru.pjandro.wordpdf.ValidationException extends ConversionException` (публичный), валидатор бросает его сам, app-дубликата нет; четыре app-исключения (`ConversionFailed/Rejected/Timeout/DrawingRejected`) — package-private, несут семантику 500/503/504/422. Граница: сломанный контейнер (не zip / голый zip без манифеста wordprocessingml / zip-бомба / размер / страницы) → 400, валидный .docx-контейнер с мусором внутри → 500. Валидация до очереди: `WordPdfValidator.validate(docxBytes, options)` (внутри порядок значим: `checkInput` → zip-магик `PK\x03\x04` → `checkDocxContainer` — потоковый проход: декларация `wordprocessingml.document` в `[Content_Types].xml` + лимиты zip-бомбы `WordPdfSettings.MAX_DECOMPRESSED_MB`/`MAX_ZIP_ENTRIES`, не переопределяются `ConvertOptions` — → `checkPageCount`); тот же метод — вход ядра. - **Ключ доступа**: `ApiKeyFilter` сверяет заголовок `X-API-Key` (`ApiKeyFilter.HEADER`) со свойством `wordpdf.api-key` (env `WORDPDF_API_KEY`, сравнение `MessageDigest.isEqual`). Пустое свойство = аутентификация выключена (dev `java -jar`, тесты). Без ключа открыты `/actuator/**` (HEALTHCHECK), `/swagger-ui*`, `/v3/api-docs*` — матч по пути **без forwarded-contextPath** (`getRequestURI()` минус `getContextPath()`; иначе под `X-Forwarded-Prefix` HEALTHCHECK получил бы 401). 401 пишет сам фильтр (`ApiExceptionHandler` ошибок фильтров не видит). Springdoc в repo `compose.yml` **выключён** (`SPRINGDOC_API_DOCS_ENABLED`/`SPRINGDOC_SWAGGER_UI_ENABLED=false`); на живом проде (compose вне репо) включён и документация открыта без ключа под `https://pjandro.ru/pdf-converter/swagger-ui.html` — это безусловно проверяют prod-автотесты; server-URL спека собирается из `X-Forwarded-*` (`server.forward-headers-strategy=framework` — `native`-клапан Tomcat `X-Forwarded-Prefix` не понимает). Регрессии — `ApiKeyFilterTest#forwardedPrefix_healthStaysOpen`, `ApiKeyFilterTest#docsOpenWithoutKey`. @@ -28,7 +28,7 @@ ### Chart-движок (`internal/chart`, package-private кроме `DrawingPreRenderer.run`) -Java2D → PNG 300 dpi (`ChartRenderer.DPI = 300`, `PADDING = 4.0`, растр × `DPI/72`, размеры — в пунктах, EMU→pt `cx/12700.0`). `ChartSpec.parse` (`enum Type`: PIE/PIE3D/DOUGHNUT/BAR/BAR_HORIZONTAL/LINE/AREA/SURFACE3D/UNSUPPORTED; пустой `c:title` + `autoTitleDeleted="0"` → у **круговых** имя первого ряда, у прочих — `AUTO_TITLE = "Chart Title"`; палитра `accent1..6` темы, легенда по умолчанию снизу, позиция `t` поддержана, `overlay` → место не резервируется) → `ChartRenderer` (осевые «круглые» шаги `niceUnit` 1/2/5·10ⁿ как Word) → пейнтеры `CartesianPainter`/`PiePainter` (`DEPTH_RATIO=0.22`, `TILT_CORRECTION=0.95`, `FIT_MARGIN=0.865`)/`Surface3dPainter` (калибровка по эталону Word 300 dpi: `CAMERA_DISTANCE=2.36`, `DEPTH_RATIO=0.705`, `HEIGHT_RATIO=0.664`, `GUTTER_LEFT/RIGHT=0.1485`, `GUTTER_TOP=0.116`, `GUTTER_BOTTOM=0.146`, свет `LIGHT_X/Y/Z=0.83/0.48/0.28`); `SmartArtRenderer` рисует кэш разложенной схемы (relationship `…/office/2007/relationships/diagramDrawing`, фактически `word/diagrams/drawing1.xml`; fit-scale ×0.80); палитра темы — `DrawMlColor` (instance; без ThemePart — дефолтная Office-палитра `accent1=4472C4`…); текст — `DrawMlText`; утилиты `RgbHsl`, `PrstGeomShapes`. Калибровочные константы менять только вместе с `Surface3dPainterTest`/`PiePainterTest`. Обход `pkg.getParts()` — только по **снимку** списка (`createImagePart` мутирует реестр → CME); rels частей — `part.getRelationshipsPart()`, НЕ `getOwningRelationshipPart()` (это rels ссылающегося); обход XML обязан раскрывать `JAXBElement`. +Java2D → PNG 300 dpi (`ChartRenderer.DPI = 300`, `PADDING = 4.0`, растр × `DPI/72`, размеры — в пунктах, EMU→pt `cx/12700.0`). `ChartSpec.parse` (`enum Type`: PIE/PIE3D/DOUGHNUT/BAR/BAR_HORIZONTAL/LINE/AREA/SURFACE3D/UNSUPPORTED; пустой `c:title` + `autoTitleDeleted="0"` → у **круговых** имя первого ряда, у прочих — `AUTO_TITLE = "Название диаграммы"` (русская замена англ. плейсхолдеру Word); палитра `accent1..6` темы, легенда по умолчанию снизу, позиция `t` поддержана, `overlay` → место не резервируется) → `ChartRenderer` (осевые «круглые» шаги `niceUnit` 1/2/5·10ⁿ как Word) → пейнтеры `CartesianPainter`/`PiePainter` (`DEPTH_RATIO=0.22`, `TILT_CORRECTION=0.95`, `FIT_MARGIN=0.865`)/`Surface3dPainter` (калибровка по эталону Word 300 dpi: `CAMERA_DISTANCE=2.36`, `DEPTH_RATIO=0.705`, `HEIGHT_RATIO=0.664`, `GUTTER_LEFT/RIGHT=0.1485`, `GUTTER_TOP=0.116`, `GUTTER_BOTTOM=0.146`, свет `LIGHT_X/Y/Z=0.83/0.48/0.28`); `SmartArtRenderer` рисует кэш разложенной схемы (relationship `…/office/2007/relationships/diagramDrawing`, фактически `word/diagrams/drawing1.xml`; fit-scale ×0.80); палитра темы — `DrawMlColor` (instance; без ThemePart — дефолтная Office-палитра `accent1=4472C4`…); текст — `DrawMlText`; утилиты `RgbHsl`, `PrstGeomShapes`. Калибровочные константы менять только вместе с `Surface3dPainterTest`/`PiePainterTest`. Обход `pkg.getParts()` — только по **снимку** списка (`createImagePart` мутирует реестр → CME); rels частей — `part.getRelationshipsPart()`, НЕ `getOwningRelationshipPart()` (это rels ссылающегося); обход XML обязан раскрывать `JAXBElement`. ### Критические инварианты (нарушение = битый вывод) @@ -47,7 +47,7 @@ Java2D → PNG 300 dpi (`ChartRenderer.DPI = 300`, `PADDING = 4.0`, растр |Путь|Назначение| |---|---| -|`wordpdf-core/src/main/java/ru/pjandro/wordpdf/`|публичный API: `WordPdfConverter`, `WordPdfValidator` (перегрузки `checkInput`/`checkPageCount` и `validate(byte[], ConvertOptions)` — полная цепочка; без зависимости от docx4j), `ConversionException`, `ValidationException` (наследник — «вход некорректен»), `DrawingFoundException` (`enum Kind {CHARTS, SMARTART}` — отказ по error-флагу), `WordPdfSettings` (константы-дефолты: `MAX_INPUT_MB=5`, `MAX_PAGES=100`, защитные `MAX_DECOMPRESSED_MB=200`/`MAX_ZIP_ENTRIES=8192`, `RENDER_*=true`, `ERROR_*=false`), `ConvertOptions` (record: renderCharts, renderSmartArt, errorOnCharts, errorOnSmartArt, maxMb, maxPages)| +|`wordpdf-core/src/main/java/ru/pjandro/wordpdf/`|публичный API: `WordPdfConverter`, `WordPdfValidator` (перегрузки `checkInput`/`checkPageCount` и `validate(byte[], ConvertOptions)` — полная цепочка; без зависимости от docx4j), `ConversionException`, `ValidationException` (наследник — «вход некорректен»), `DrawingFoundException` (`enum Kind {CHARTS, SMARTART}` — отказ по error-флагу), `WordPdfSettings` (константы-дефолты: `MAX_INPUT_MB=5`, `MAX_PAGES=100`, защитные `MAX_DECOMPRESSED_MB=200`/`MAX_ZIP_ENTRIES=8192`, `ERROR_*=false`), `ConvertOptions` (record: errorOnCharts, errorOnSmartArt, maxMb, maxPages)| |`…/wordpdf/fonts/`|`BundledFonts` (реестр/выгрузка TTF, `families()`, `FALLBACK_FAMILY`), `BundledFontMapper` (алиасы MS→open-source, self-map, DISPLAY_NAMES, public-хук `bundledFamily`), `GlyphFont` (глиф-движок fontbox: метрики/глифы без java.awt.Font)| |`…/wordpdf/internal/`|5 байтовых нормализатора + `FopFallbackFonts` (классы `public` — вызываются из родительского пакета; публичные члены только `normalize`/`declare`)| |`…/wordpdf/internal/chart/`|11 классов Java2D-рендера диаграмм/SmartArt в PNG (public только `DrawingPreRenderer`)| @@ -59,7 +59,7 @@ Java2D → PNG 300 dpi (`ChartRenderer.DPI = 300`, `PADDING = 4.0`, растр |корневой `.env.example`|шаблон env для локальных/compose-стендов: `WORDPDF_API_KEY` (`openssl rand -hex 32`), закомментированные `WORDPDF_MAX_MB`/`WORDPDF_MAX_PAGES` (пустое значение ломает старт — binding long/int); проду `.env` **не нужен**: ключ и лимиты подаёт job `deploy` из Gitea Secrets/Variables, legacy-`.env` на проде удаляется деплоем| |`.gitea/workflows/`|Gitea Actions: `pr.yml` (PR checks), `main.yml` (тесты → `images` (build+push в Nexus) → deploy (рендер прод-конфигов + pull) → autotests → rollback)| |корневой `GITEA-vars.md`|инструкция владельца: Secrets/Variables, защита ветки, перезапуск — только имена переменных, без значений| -|корневой `prod-autotests/`|прод-автотесты API (pytest + requests, 20 проверок): конфигурация стенда **только env** (`WORDPDF_BASE_URL` обязателен, `WORDPDF_API_KEY`/`WORDPDF_MAX_PAGES`/`WORDPDF_MAX_MB`/`WORDPDF_SAMPLES_DIR` факультативны) — прод-хостов/ключей в коде нет; окружение — mise (`mise.toml`: python 3.15 + автосоздаваемый `.venv`); прод-раннер вне git — `/home/pjandro/prod/java-word-pdf/run-prod-tests.sh`| +|корневой `prod-autotests/`|прод-автотесты API (pytest + requests, 19 проверок): конфигурация стенда **только env** (`WORDPDF_BASE_URL` обязателен, `WORDPDF_API_KEY`/`WORDPDF_MAX_PAGES`/`WORDPDF_MAX_MB`/`WORDPDF_SAMPLES_DIR` факультативны) — прод-хостов/ключей в коде нет; окружение — mise (`mise.toml`: python 3.15 + автосоздаваемый `.venv`); прод-раннер вне git — `/home/pjandro/prod/java-word-pdf/run-prod-tests.sh`| |`develop/` (вне git)|рабочие материалы и эталоны Word (`testDoc.doc/.pdf`, `testDoc.convert.pdf`, `openxml.docx/.pdf`) — **ручное сравнение, не фикстуры**, в тесты/jar не подключать| ## Development Commands @@ -130,7 +130,7 @@ SSH-пользователи/логины, ни хосты, ни директо ## Important Files - `wordpdf-core/src/main/java/ru/pjandro/wordpdf/WordPdfConverter.java` — точка входа библиотеки + static-блок `gsubFeatures`. -- `wordpdf-core/src/main/java/ru/pjandro/wordpdf/WordPdfSettings.java` — все дефолты ядра (`MAX_INPUT_MB` 5, `MAX_PAGES` 100, `RENDER_CHARTS/SMARTART`); рантайм-конфигурации в ядре нет. +- `wordpdf-core/src/main/java/ru/pjandro/wordpdf/WordPdfSettings.java` — все дефолты ядра (`MAX_INPUT_MB` 5, `MAX_PAGES` 100, `ERROR_*=false`); рантайм-конфигурации в ядре нет. - `wordpdf-app/src/main/resources/application.properties` — multipart 100MB (`max-file-size`/`max-request-size` + `file-size-threshold=100MB`, держит файл в памяти; в тон gateway `client_max_body_size 100m`), `wordpdf.convert-timeout=2m`, пустой `wordpdf.api-key`, `server.forward-headers-strategy=framework` (префикс прод-прокси для springdoc) + `springdoc.swagger-ui.persist-authorization=true`; `wordpdf.max-mb`/`max-pages` здесь намеренно нет. - `wordpdf-app/pom.xml` — `spring-boot-maven-plugin` с **явной** execution `repackage` (в 4.1.1 сам не связывается, jar останется тонким); `slf4j-simple` исключён; `spring-boot-starter-webmvc` (Boot 4: переименован из starter-web) + `spring-boot-starter-actuator` (нужен HEALTHCHECK контейнера `/actuator/health`); тест-зависимости: `spring-boot-webmvc-test` (в Boot 4 автоконфиг MockMvc вынесен из starter-test), test-jar core. - `wordpdf-core/pom.xml` — `maven-jar-plugin` execution `test-jar` (публикует фикстуры для app). @@ -154,12 +154,12 @@ SSH-пользователи/логины, ни хосты, ни директо ## Testing & QA - Гейт `maven-pmd-plugin` 3.28.0 (PMD 7.17) на `verify` для обоих модулей, ruleset `pmd-ruleset.xml` (codestyle без opinionated-правил + unused-правила + XPath `LiteralFirstInEquals` — строковый литерал слева в `equals`/`equalsIgnoreCase`; `junit5TestPattern` разрешает underscore-имена регрессий; `includeTests=true` — тесты сканируются; `failurePriority` не задан — дефолт 2, т.е. нарушения priority ≤ 2 валят build, priority 3 — только WARNING в отчёт). Литералы в условиях `if` — только именованными константами (`AvoidLiteralsInIfCondition`), `null` вместо пустой коллекции запрещён (`ReturnEmptyCollectionRatherThanNull` — `GlyphCoverageNormalizer.split` возвращает пустой список). -- 15 тестовых классов / 144 `@Test` (core 12/118, app 3/26). JUnit 6 (`org.junit.jupiter:junit-jupiter`), surefire 3.6.0 с `-Djava.awt.headless=true` в argLine; только `Assertions` (Mockito/AssertJ не использовать, несмотря на test-classpath Boot; в app-тестах допустим inline-Hamcrest `org.hamcrest.Matchers.containsString` в `andExpect`); тестовые классы package-private, зеркалят main-пакеты; только `@Test` (+ единственный `@BeforeAll` — warm-up шрифтов в `GlyphCoverageNormalizerTest`). +- 16 тестовых классов / 149 `@Test` (core 13/124, app 3/25). JUnit 6 (`org.junit.jupiter:junit-jupiter`), surefire 3.6.0 с `-Djava.awt.headless=true` в argLine; только `Assertions` (Mockito/AssertJ не использовать, несмотря на test-classpath Boot; в app-тестах допустим inline-Hamcrest `org.hamcrest.Matchers.containsString` в `andExpect`); тестовые классы package-private, зеркалят main-пакеты; только `@Test` (+ единственный `@BeforeAll` — warm-up шрифтов в `GlyphCoverageNormalizerTest`). - **PDF сравнивается текстом, не растеризацией**: PDFBox 3 (`Loader.loadPDF`) — `PDFTextStripper` для текста (пер-странично `setStartPage/setEndPage`), override `processTextPosition` для шрифта конкретного символа (`fontNameOf`), обход ресурсов страниц для встроенных шрифтов (`EAAAAA+Carlito-Bold`) и счётчика картинок (`imageCount`). Негативные маркеры — регрессии: `assertFalse(text.contains("#"))` (.notdef), `assertFalse(font.startsWith("Helvetica"))`. Текст нормализуется по пробелам (`norm`); в `tableImage_tableAndImage` — полное удаление пробелов (docx4j переносит слова в auto-fit таблицах). - Пиксели (BufferedImage) — только в unit-тестах chart-пейнтеров: безразмерные отношения к эталону Word, допуски `assertRatio` <0.06 (`PiePainterTest` аспект h/w=0.585) / <0.10 (`Surface3dPainterTest`, + `assertRange` ±6 pt для центров силуэта); пороги залитых px и перцентильные коридоры яркости. Эталонные замеры — по Word-экспорту 300 dpi (`develop/`, вне git). - `GlyphFont` (fontbox): метрики пиксельно-метрически эквивалентны AWT (ascent/descent/leading/advance совпадают до 4-го знака, кернинг-дрейф 0.0000 — DejaVu Sans, Carlito). Приёмочный стенд без-fontconfig: контейнер без `libfontconfig.so.1*` и `/etc/fonts`, `mvn verify` + `java -jar` (до перехода на GlyphFont там падали `GlyphCoverageNormalizerTest` 12 / `CartesianPainterTest` 3 / `PiePainterTest` 2 / chart-тесты `WordPdfConverterTest` 4, chart-рендер молча деградировал). `GlyphFontTest` написан без единого `java.awt.Font` — обязан проходить на хосте без fontconfig. - Фикстуры — закоммиченные `samples/*.docx` (11; в тестах не генерировать): core грузит classpath-ресурсом → `byte[]`, PDF для PDFBox — временный файл; app читает `/samples/…` из **test-jar core** (classifier `tests`) → `mvn -pl wordpdf-app` без `-am` не соберётся. In-memory docx — `ZipOutputStream` из литеральных XML или POI в `byte[]`. Ключевые: `too-many-pages` (150 явных разрывов → 151), `stale-cache` (кэш `1` + 110 `lastRenderedPageBreak`), `charts-smartart` (4 растра; SmartArt-одиночка = ровно 2 Image XObject). - Юниты нормализаторов работают строками (`rewrite`) + zip'ами из `ZipOutputStream`; обязательные контракты: «нечего менять → тот же массив» (`assertSame` покрыт тестами только у zip-нормализаторов `DocxOnOff`/`SymbolFont`/`StrictOoxml`; у `Field`/`GlyphCoverage` — `rewrite`→`null`) и неприкосновенность частей вне `word/*.xml` (`[Content_Types].xml`). Тесты бьют и в package-private API (`GlyphCoverageNormalizer.split(text, family)`, `ChartSpec.readTitle`). - App-тесты: `@SpringBootTest` + `@AutoConfigureMockMvc` (Boot 4: `org.springframework.boot.webmvc.test.autoconfigure`); три контекста — `ConvertControllerTest` (пустой ключ), `ApiKeyFilterTest` (`properties = "wordpdf.api-key=…"`), `ConvertLimitsTest` (`@TestPropertySource` с лимитами — отдельный класс, не `@Nested`). -- Регрессивные пары (фикс = нормализатор/pre-renderer + юнит + конвертер-тест с фикстурой): `StrictOoxmlNormalizerTest`↔`strictOoxml_convertsNotRejected` (+`pageCount_strictBreaksCountedLightweight` — lightweight против strict), `DocxOnOffNormalizerTest`↔`ruPlain_regularRunsUseRegularFont`, `SymbolFontNormalizerTest`↔`symbolFonts_bulletsAreNotHash`, `FieldNormalizerTest`↔`pageNumbers_recomputedNotCached`, `GlyphCoverageNormalizerTest`↔`exoticGlyphs_drawnNotHash`, `WordPdfValidatorTest`↔`staleCachePageCountRejectedBeforeRender` (+`checkPageCount_limitBoundary` 99/100/101, `pageCount_breaksInsideTablesAreCounted`, `pageCount_continuousSectionsNotCountedLightweight`, `validate_notAZip`↔`inputNotAZip_rejectedBeforeRender`, `validate_plainZipRejected`/`validate_xlsxRenamedRejected`/`validate_zipBombRejected`/`validate_tooManyEntriesRejected`↔`plainZipNotDocx_rejected`/`inputNotDocx_rejectedBeforeRender` — контейнер и zip-бомба), `BundledFontsTest`↔`ruPlain_emDashEmbeddedNotHelvetica`, `ChartSpecTest`↔автозаголовки, chart-пейнтеры↔`chartsSmartArt_drawingsBecomeImages` (+`drawingToggles_offRemovesRasters`/`drawingToggles_chartsOffSmartArtOn`, `drawingErrors_*`↔app `errorFlagCharts_rejected`/`errorFlagSmartArt_rejected`/`errorFlags_renderWins`); `noLoggingWarningInPdf` — регрессия `slf4j-simple`, `pdfTitle_comesFromParameter` — регрессия PDF-title (юнит-партнёра нет). App-регрессии: `requestLimitParams_areIgnored`, `nonPositiveLimits_failStartup`, `unknownPath_notFound`, `concurrentRequests_bothSucceed` (гонка реестра `PhysicalFonts`), `corruptNotAZip_rejected`, `plainZipNotDocx_rejected` (голый zip без манифеста → 400), `junkInsideValidZip_conversionError` (500 на валидном .docx-контейнере с мусором), `nonDocxFilename_rejected`, `oversizedOverCoreLimit_rejected`, `renderFlagsOff_convertsWithoutDrawings`, `cyrillicAndPathInFilename_sanitizedResponseName` (RFC 5987 + path-traversal), `docsOpenWithoutKey`/`forwardedPrefix_healthStaysOpen`/`forwardedPrefix_docsOpenWithoutKey` (открытая документация + матч фильтра без forwarded-contextPath). -- UI-тестов нет; гейт SPA — `npm run build` (tsc -b) + `npm run lint` (oxlint, `.oxlintrc.json`: rules-of-hooks error, only-export-components warn). Прод-автотесты (pytest 9 + requests, 20 проверок, env-конфиг, `mise exec -- python -m pytest -q .` из `prod-autotests/`) гоняются CI после deploy против живого прода; `WORDPDF_API_KEY` пуст → честный SKIP `@needs_key`-проверок. +- Регрессивные пары (фикс = нормализатор/pre-renderer + юнит + конвертер-тест с фикстурой): `StrictOoxmlNormalizerTest`↔`strictOoxml_convertsNotRejected` (+`pageCount_strictBreaksCountedLightweight` — lightweight против strict), `DocxOnOffNormalizerTest`↔`ruPlain_regularRunsUseRegularFont`, `SymbolFontNormalizerTest`↔`symbolFonts_bulletsAreNotHash`, `FieldNormalizerTest`↔`pageNumbers_recomputedNotCached`, `GlyphCoverageNormalizerTest`↔`exoticGlyphs_drawnNotHash`, `WordPdfValidatorTest`↔`staleCachePageCountRejectedBeforeRender` (+`checkPageCount_limitBoundary` 99/100/101, `pageCount_breaksInsideTablesAreCounted`, `pageCount_continuousSectionsNotCountedLightweight`, `validate_notAZip`↔`inputNotAZip_rejectedBeforeRender`, `validate_plainZipRejected`/`validate_xlsxRenamedRejected`/`validate_zipBombRejected`/`validate_tooManyEntriesRejected`↔`plainZipNotDocx_rejected`/`inputNotDocx_rejectedBeforeRender` — контейнер и zip-бомба), `BundledFontsTest`↔`ruPlain_emDashEmbeddedNotHelvetica`, `ChartSpecTest`↔автозаголовки, chart-пейнтеры↔`chartsSmartArt_drawingsBecomeImages` (+`drawingErrors_*`↔app `errorFlagCharts_rejected`/`errorFlagSmartArt_rejected`); `noLoggingWarningInPdf` — регрессия `slf4j-simple`, `pdfTitle_comesFromParameter` — регрессия PDF-title (юнит-партнёра нет). App-регрессии: `requestLimitParams_areIgnored`, `nonPositiveLimits_failStartup`, `unknownPath_notFound`, `concurrentRequests_bothSucceed` (гонка реестра `PhysicalFonts`), `corruptNotAZip_rejected`, `plainZipNotDocx_rejected` (голый zip без манифеста → 400), `junkInsideValidZip_conversionError` (500 на валидном .docx-контейнере с мусором), `nonDocxFilename_rejected`, `oversizedOverCoreLimit_rejected`, `drawingsAlwaysRendered`, `cyrillicAndPathInFilename_sanitizedResponseName` (RFC 5987 + path-traversal), `docsOpenWithoutKey`/`forwardedPrefix_healthStaysOpen`/`forwardedPrefix_docsOpenWithoutKey` (открытая документация + матч фильтра без forwarded-contextPath). +- UI-тестов нет; гейт SPA — `npm run build` (tsc -b) + `npm run lint` (oxlint, `.oxlintrc.json`: rules-of-hooks error, only-export-components warn). Прод-автотесты (pytest 9 + requests, 19 проверок, env-конфиг, `mise exec -- python -m pytest -q .` из `prod-autotests/`) гоняются CI после deploy против живого прода; `WORDPDF_API_KEY` пуст → честный SKIP `@needs_key`-проверок. diff --git a/prod-autotests/test_prod_api.py b/prod-autotests/test_prod_api.py index 3e9e4ff..4d3db52 100644 --- a/prod-autotests/test_prod_api.py +++ b/prod-autotests/test_prod_api.py @@ -260,9 +260,10 @@ def test_unknown_path_not_found(url, key_header): @needs_key def test_error_on_charts_rejected(url, samples, key_header): - """errorOnCharts при выключенном renderCharts — 422 (DrawingRejectedException); render-флаг приоритетнее.""" + """errorOnCharts=true — 422 (DrawingRejectedException); конвертация всегда, + отказ только по error-флагу.""" r = requests.post( - url(CONVERT) + "?errorOnCharts=true&renderCharts=false", + url(CONVERT) + "?errorOnCharts=true", headers=key_header, files={"file": ("charts-smartart.docx", (samples / "charts-smartart.docx").read_bytes())}, timeout=TIMEOUT, @@ -271,19 +272,6 @@ def test_error_on_charts_rejected(url, samples, key_header): assert "error" in r.json() -@needs_key -def test_render_flags_off_converts(url, samples, key_header): - """Оба render-флага выключены — диаграммы/SmartArt пропускаются до рендера, PDF без них.""" - r = requests.post( - url(CONVERT) + "?renderCharts=false&renderSmartArt=false", - headers=key_header, - files={"file": ("charts-smartart.docx", (samples / "charts-smartart.docx").read_bytes())}, - timeout=TIMEOUT, - ) - assert r.status_code == 200 - assert r.content[:4] == b"%PDF" - - @needs_key def test_charts_full_render(url, samples, key_header): """Дефолтные флаги — полный Java2D-путь диаграмм/SmartArt в PNG — фикстура charts-smartart.docx.""" diff --git a/wordpdf-app/src/main/java/ru/pjandro/wordpdf/app/ConvertController.java b/wordpdf-app/src/main/java/ru/pjandro/wordpdf/app/ConvertController.java index 5d9c213..4419e26 100644 --- a/wordpdf-app/src/main/java/ru/pjandro/wordpdf/app/ConvertController.java +++ b/wordpdf-app/src/main/java/ru/pjandro/wordpdf/app/ConvertController.java @@ -59,8 +59,9 @@ final class ConvertController { } @Operation(summary = "Конвертировать .docx в PDF", - description = "renderCharts/renderSmartArt/errorOnCharts/errorOnSmartArt — факультативно, " - + "по умолчанию настройки ядра; render-флаг приоритетнее error-флага. " + description = "errorOnCharts/errorOnSmartArt — факультативно, по умолчанию " + + "настройки ядра (ошибка не выбрасывается); диаграммы/SmartArt " + + "конвертируются всегда. " + "Лимиты входа (размер/страницы) задаёт только конфигурация сервера " + "(свойства wordpdf.max-mb/wordpdf.max-pages), параметрами запроса не переопределяются") @SecurityRequirement(name = OpenApiConfig.SCHEME) @@ -70,8 +71,6 @@ final class ConvertController { produces = MediaType.APPLICATION_PDF_VALUE) ResponseEntity convert( @RequestParam("file") MultipartFile file, - @RequestParam(name = "renderCharts", required = false) Boolean renderCharts, - @RequestParam(name = "renderSmartArt", required = false) Boolean renderSmartArt, @RequestParam(name = "errorOnCharts", required = false) Boolean errorOnCharts, @RequestParam(name = "errorOnSmartArt", required = false) Boolean errorOnSmartArt) { if (file == null || file.isEmpty()) { @@ -89,8 +88,6 @@ final class ConvertController { throw new ValidationException("Не удалось прочитать загруженный файл", e); } ConvertOptions options = new ConvertOptions( - renderCharts != null ? renderCharts : WordPdfSettings.RENDER_CHARTS, - renderSmartArt != null ? renderSmartArt : WordPdfSettings.RENDER_SMARTART, errorOnCharts != null ? errorOnCharts : WordPdfSettings.ERROR_ON_CHARTS, errorOnSmartArt != null ? errorOnSmartArt : WordPdfSettings.ERROR_ON_SMARTART, maxMb, maxPages); diff --git a/wordpdf-app/src/main/java/ru/pjandro/wordpdf/app/DrawingRejectedException.java b/wordpdf-app/src/main/java/ru/pjandro/wordpdf/app/DrawingRejectedException.java index 977069b..a1f6cba 100644 --- a/wordpdf-app/src/main/java/ru/pjandro/wordpdf/app/DrawingRejectedException.java +++ b/wordpdf-app/src/main/java/ru/pjandro/wordpdf/app/DrawingRejectedException.java @@ -3,11 +3,11 @@ package ru.pjandro.wordpdf.app; import ru.pjandro.wordpdf.DrawingFoundException; /** - * Документ содержит диаграммы/SmartArt при включённом error-флаге и - * выключенном render-флаге ({@link DrawingFoundException} ядра). + * Документ содержит диаграммы/SmartArt при включённом error-флаге + * ({@link DrawingFoundException} ядра). * *

Маппится в HTTP 422 ({@link ApiExceptionHandler}); клиенту осмысленно - * повторить с render-флагом или без error-флага. Текст сообщения — + * повторить без error-флага. Текст сообщения — * пользовательский контракт: фронт показывает его дословно.

*/ class DrawingRejectedException extends RuntimeException { diff --git a/wordpdf-app/src/test/java/ru/pjandro/wordpdf/app/ConvertControllerTest.java b/wordpdf-app/src/test/java/ru/pjandro/wordpdf/app/ConvertControllerTest.java index 7d9810f..38d203d 100644 --- a/wordpdf-app/src/test/java/ru/pjandro/wordpdf/app/ConvertControllerTest.java +++ b/wordpdf-app/src/test/java/ru/pjandro/wordpdf/app/ConvertControllerTest.java @@ -29,7 +29,6 @@ import java.util.zip.ZipEntry; import java.util.zip.ZipOutputStream; import static org.junit.jupiter.api.Assertions.assertThrows; -import static org.junit.jupiter.api.Assertions.assertEquals; import static org.junit.jupiter.api.Assertions.assertNotNull; import static org.junit.jupiter.api.Assertions.assertTrue; import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get; @@ -154,34 +153,24 @@ class ConvertControllerTest { } /** - * Выключенные renderCharts/renderSmartArt: 200, PDF без единого растра, - * текст вокруг рисунков сохраняется. Тот же запрос без параметров — - * дефолты ядра пробиваются сквозь HTTP: картинки на месте. + * Диаграммы/SmartArt конвертируются всегда без каких-либо параметров + * запроса: 200, PDF с 4 растрами фикстуры. */ @Test - void renderFlagsOff_convertsWithoutDrawings() throws Exception { - byte[] sample = bytes("/samples/charts-smartart.docx"); - byte[] off = mockMvc.perform(multipart("/api/v1/convert") - .file(docx("charts-smartart.docx", sample)) - .param("renderCharts", "false") - .param("renderSmartArt", "false")) + void drawingsAlwaysRendered() throws Exception { + byte[] pdf = mockMvc.perform(multipart("/api/v1/convert") + .file(docx("charts-smartart.docx", bytes("/samples/charts-smartart.docx")))) .andExpect(status().isOk()) .andExpect(content().contentType(MediaType.APPLICATION_PDF)) .andReturn().getResponse().getContentAsByteArray(); - String offText = norm(pdfText(off)); - assertTrue(offText.contains("Диаграммы"), "пропал текст вокруг диаграмм: " + offText); - assertEquals(0, imageCount(off), "выключенные drawing'и дали растры"); - - byte[] on = mockMvc.perform(multipart("/api/v1/convert") - .file(docx("charts-smartart.docx", sample))) - .andExpect(status().isOk()) - .andReturn().getResponse().getContentAsByteArray(); - assertTrue(imageCount(on) >= 4, - "дефолты ядра не пробиты сквозь HTTP: найдено растров " + imageCount(on)); + String text = norm(pdfText(pdf)); + assertTrue(text.contains("Диаграммы"), "пропал текст вокруг диаграмм: " + text); + assertTrue(imageCount(pdf) >= 4, + "объекты должны конвертироваться всегда, найдено растров " + imageCount(pdf)); } /** - * errorOnCharts при renderCharts=false — HTTP 422 с текстом отказа + * errorOnCharts=true — HTTP 422 с текстом отказа * (документ валиден, отвергнут по настройке запроса). * Регрессия — WordPdfConverterTest#drawingErrors_errorFlagRejectsCharts, * фикстура samples/charts-smartart.docx. @@ -190,7 +179,6 @@ class ConvertControllerTest { void errorFlagCharts_rejected() throws Exception { mockMvc.perform(multipart("/api/v1/convert") .file(docx("charts-smartart.docx", bytes("/samples/charts-smartart.docx"))) - .param("renderCharts", "false") .param("errorOnCharts", "true")) .andExpect(status().isUnprocessableEntity()) .andExpect(jsonPath("$.error", @@ -198,8 +186,8 @@ class ConvertControllerTest { } /** - * errorOnSmartArt при renderSmartArt=false — 422 с текстом про SmartArt - * (диаграммы в этом вызове рендерятся, поэтому бросается целевой Kind). + * errorOnSmartArt=true — HTTP 422 с текстом про SmartArt (диаграммы + * конвертируются, их error-флаг выключен, поэтому бросается целевой Kind). * Регрессия — WordPdfConverterTest#drawingErrors_errorFlagRejectsSmartArt, * фикстура samples/charts-smartart.docx. */ @@ -207,34 +195,12 @@ class ConvertControllerTest { void errorFlagSmartArt_rejected() throws Exception { mockMvc.perform(multipart("/api/v1/convert") .file(docx("charts-smartart.docx", bytes("/samples/charts-smartart.docx"))) - .param("renderSmartArt", "false") .param("errorOnSmartArt", "true")) .andExpect(status().isUnprocessableEntity()) .andExpect(jsonPath("$.error", org.hamcrest.Matchers.containsString("SmartArt"))); } - /** - * render-флаги приоритетнее error-флагов: все четыре включены — 200 и - * полный PDF с растрами. - * Регрессия — WordPdfConverterTest#drawingErrors_renderFlagWins, - * фикстура samples/charts-smartart.docx. - */ - @Test - void errorFlags_renderWins() throws Exception { - byte[] pdf = mockMvc.perform(multipart("/api/v1/convert") - .file(docx("charts-smartart.docx", bytes("/samples/charts-smartart.docx"))) - .param("renderCharts", "true") - .param("renderSmartArt", "true") - .param("errorOnCharts", "true") - .param("errorOnSmartArt", "true")) - .andExpect(status().isOk()) - .andReturn().getResponse().getContentAsByteArray(); - - assertTrue(imageCount(pdf) >= 4, - "рендер должен победить error-флаги, найдено растров " + imageCount(pdf)); - } - @Test void cyrillicAndPathInFilename_sanitizedResponseName() throws Exception { byte[] sample = bytes("/samples/ru-plain.docx"); diff --git a/wordpdf-core/src/main/java/ru/pjandro/wordpdf/ConvertOptions.java b/wordpdf-core/src/main/java/ru/pjandro/wordpdf/ConvertOptions.java index 2009243..1a28873 100644 --- a/wordpdf-core/src/main/java/ru/pjandro/wordpdf/ConvertOptions.java +++ b/wordpdf-core/src/main/java/ru/pjandro/wordpdf/ConvertOptions.java @@ -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); } } diff --git a/wordpdf-core/src/main/java/ru/pjandro/wordpdf/DrawingFoundException.java b/wordpdf-core/src/main/java/ru/pjandro/wordpdf/DrawingFoundException.java index 133b66f..2d71cc3 100644 --- a/wordpdf-core/src/main/java/ru/pjandro/wordpdf/DrawingFoundException.java +++ b/wordpdf-core/src/main/java/ru/pjandro/wordpdf/DrawingFoundException.java @@ -1,10 +1,10 @@ package ru.pjandro.wordpdf; /** - * Документ содержит объект, обработку которого вызывающий запретил: - * render-флаг выключен, а соответствующий error-флаг включён + * Документ содержит объект, находку которого вызывающий запретил: + * соответствующий error-флаг включён * ({@link ConvertOptions#errorOnCharts()}, {@link ConvertOptions#errorOnSmartArt()}). - * render-флаг имеет приоритет: при включённом рендере исключение не бросается. + * Диаграммы/SmartArt конвертируются всегда; исключение отвергает документ целиком. * *

Наследник {@link ConversionException} — наружу по-прежнему ловится * только он; {@code kind()} даёт вызывающему тип объекта без разбора текста. diff --git a/wordpdf-core/src/main/java/ru/pjandro/wordpdf/WordPdfConverter.java b/wordpdf-core/src/main/java/ru/pjandro/wordpdf/WordPdfConverter.java index 5136e2f..93e3cdf 100644 --- a/wordpdf-core/src/main/java/ru/pjandro/wordpdf/WordPdfConverter.java +++ b/wordpdf-core/src/main/java/ru/pjandro/wordpdf/WordPdfConverter.java @@ -75,7 +75,7 @@ public final class WordPdfConverter { } /** - * Конвертирует байты .docx в PDF с настройками на вызов: рисование + * Конвертирует байты .docx в PDF с настройками на вызов: error-флаги * диаграмм/SmartArt и лимиты входа. * *

Вход проверяется {@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}, размер больше diff --git a/wordpdf-core/src/main/java/ru/pjandro/wordpdf/WordPdfSettings.java b/wordpdf-core/src/main/java/ru/pjandro/wordpdf/WordPdfSettings.java index 1f84cc6..1f24875 100644 --- a/wordpdf-core/src/main/java/ru/pjandro/wordpdf/WordPdfSettings.java +++ b/wordpdf-core/src/main/java/ru/pjandro/wordpdf/WordPdfSettings.java @@ -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() { diff --git a/wordpdf-core/src/main/java/ru/pjandro/wordpdf/internal/chart/ChartSpec.java b/wordpdf-core/src/main/java/ru/pjandro/wordpdf/internal/chart/ChartSpec.java index 9c0c5ad..f8ed8cc 100644 --- a/wordpdf-core/src/main/java/ru/pjandro/wordpdf/internal/chart/ChartSpec.java +++ b/wordpdf-core/src/main/java/ru/pjandro/wordpdf/internal/chart/ChartSpec.java @@ -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) { diff --git a/wordpdf-core/src/main/java/ru/pjandro/wordpdf/internal/chart/DrawingPreRenderer.java b/wordpdf-core/src/main/java/ru/pjandro/wordpdf/internal/chart/DrawingPreRenderer.java index 7546d90..8000a4d 100644 --- a/wordpdf-core/src/main/java/ru/pjandro/wordpdf/internal/chart/DrawingPreRenderer.java +++ b/wordpdf-core/src/main/java/ru/pjandro/wordpdf/internal/chart/DrawingPreRenderer.java @@ -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"; diff --git a/wordpdf-core/src/test/java/ru/pjandro/wordpdf/WordPdfConverterTest.java b/wordpdf-core/src/test/java/ru/pjandro/wordpdf/WordPdfConverterTest.java index 19565c0..fadb480 100644 --- a/wordpdf-core/src/test/java/ru/pjandro/wordpdf/WordPdfConverterTest.java +++ b/wordpdf-core/src/test/java/ru/pjandro/wordpdf/WordPdfConverterTest.java @@ -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()); } diff --git a/wordpdf-core/src/test/java/ru/pjandro/wordpdf/WordPdfValidatorTest.java b/wordpdf-core/src/test/java/ru/pjandro/wordpdf/WordPdfValidatorTest.java index 91c2db4..c3c58e4 100644 --- a/wordpdf-core/src/test/java/ru/pjandro/wordpdf/WordPdfValidatorTest.java +++ b/wordpdf-core/src/test/java/ru/pjandro/wordpdf/WordPdfValidatorTest.java @@ -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 diff --git a/wordpdf-core/src/test/java/ru/pjandro/wordpdf/internal/chart/ChartSpecTest.java b/wordpdf-core/src/test/java/ru/pjandro/wordpdf/internal/chart/ChartSpecTest.java index b4e0923..066529f 100644 --- a/wordpdf-core/src/test/java/ru/pjandro/wordpdf/internal/chart/ChartSpecTest.java +++ b/wordpdf-core/src/test/java/ru/pjandro/wordpdf/internal/chart/ChartSpecTest.java @@ -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"); } diff --git a/wordpdf-web/src/api.ts b/wordpdf-web/src/api.ts index 710e932..4b66f86 100644 --- a/wordpdf-web/src/api.ts +++ b/wordpdf-web/src/api.ts @@ -23,16 +23,14 @@ export interface ConvertResult { /** Настройки на один вызов: поля соответствуют параметрам API. Лимиты * входа (размер/страницы) задаёт только сервер, параметрами не шлются. */ export interface ConvertOptions { - renderCharts: boolean - renderSmartArt: boolean errorOnCharts: boolean errorOnSmartArt: boolean } /** * Единственная сетевая точка приложения: POST /api/v1/convert (multipart, - * поля `file`, `renderCharts`, `renderSmartArt`, `errorOnCharts`, - * `errorOnSmartArt`) → PDF-blob + имя файла из Content-Disposition. + * поля `file`, `errorOnCharts`, `errorOnSmartArt`) → PDF-blob + имя файла + * из Content-Disposition. * Таймаут на фронте не ставим: конвертация долгая — это ожидаемо. */ export async function convertDocx( @@ -42,8 +40,6 @@ export async function convertDocx( ): Promise { const fd = new FormData() fd.append('file', file, file.name) - fd.append('renderCharts', String(options.renderCharts)) - fd.append('renderSmartArt', String(options.renderSmartArt)) fd.append('errorOnCharts', String(options.errorOnCharts)) fd.append('errorOnSmartArt', String(options.errorOnSmartArt)) const key = getApiKey() diff --git a/wordpdf-web/src/components/App.tsx b/wordpdf-web/src/components/App.tsx index d24e284..0901fff 100644 --- a/wordpdf-web/src/components/App.tsx +++ b/wordpdf-web/src/components/App.tsx @@ -19,34 +19,12 @@ export default function App() { const [status, setStatus] = useState('idle') const [result, setResult] = useState(null) const [error, setError] = useState(null) - // дефолты фронта: ошибка при находке включена, рендер выключен - // (галки одной сущности взаимоисключающие — вместе они несовместимы) - const [renderCharts, setRenderCharts] = useState(false) - const [errorOnCharts, setErrorOnCharts] = useState(true) - const [renderSmartArt, setRenderSmartArt] = useState(false) - const [errorOnSmartArt, setErrorOnSmartArt] = useState(true) + // дефолты фронта: ошибка при находке выключена — конвертация проходит молча + const [errorOnCharts, setErrorOnCharts] = useState(false) + const [errorOnSmartArt, setErrorOnSmartArt] = useState(false) const abortRef = useRef(null) const urlRef = useRef(null) - // включение одной галки сущности снимает другую; снятие — ни на что не - // влияет: все сняты → сущность молча выбрасывается (поведение ядра) - const toggleRenderCharts = (on: boolean) => { - setRenderCharts(on) - if (on) setErrorOnCharts(false) - } - const toggleErrorOnCharts = (on: boolean) => { - setErrorOnCharts(on) - if (on) setRenderCharts(false) - } - const toggleRenderSmartArt = (on: boolean) => { - setRenderSmartArt(on) - if (on) setErrorOnSmartArt(false) - } - const toggleErrorOnSmartArt = (on: boolean) => { - setErrorOnSmartArt(on) - if (on) setRenderSmartArt(false) - } - // экран ключа показываем только когда сервер реально требует ключ: зонд // probeApiKey (GET /api/v1/convert → 401) решает до загрузки файла; в dev // без ключа форма открывается сразу. Ключ лежит в localStorage (публичная @@ -77,8 +55,6 @@ export default function App() { const ac = new AbortController() abortRef.current = ac convertDocx(file, ac.signal, { - renderCharts, - renderSmartArt, errorOnCharts, errorOnSmartArt, }) @@ -164,46 +140,26 @@ export default function App() {

Диаграммы -
SmartArt - -- 2.56.1