Compare commits

...

15 Commits

Author SHA1 Message Date
Pjandro bd43d0d80d fix(doc): отключить кэш шрифтов FOP — .doc падал 500 в контейнере (кэш .fop в текущем каталоге) 2026-10-19 23:05:27 +00:00
Pjandro 96865daef4 feat: конвертация бинарного .doc (Word 97-2003) в PDF (POI HWPF + FOP) 2026-10-19 23:05:27 +00:00
pjandro 4d6cc2a795 Merge pull request 'PMD codestyle на verify + исправление всех предупреждений' (#13) from chore/pmd-codestyle into main
Reviewed-on: #13
2026-10-20 01:56:22 +03:00
Pjandro bcfabfb0e9 chore: подключить PMD codestyle на verify
maven-pmd-plugin 3.28.0 (PMD 7.17) на фазе verify для обоих модулей,
includeTests=true, ruleset pmd-ruleset.xml: codestyle без opinionated-правил,
MethodNamingConventions с junit5TestPattern под underscore-имена регрессий,
TooManyStaticImports до 12, XPath LiteralFirstInEquals (PMD 7 удалил
EqualsAvoidsNull), unused-правила bestpractices.
2026-10-19 22:55:16 +00:00
Pjandro 5f0cabd8e2 fix: устранить все предупреждения PMD (codestyle/unused/LiteralFirstInEquals)
Литерал слева в equals/equalsIgnoreCase (NPE-safe), удаление неиспользуемых
параметров/локальных/импортов/полей, логгеры log→LOG (конвенция UPPER_SNAKE),
UselessParentheses/UnnecessaryCast/UseShortArrayInitializer, record без явного
static, пустой конструктор ChartSpec удалён. Семантика не меняется.
2026-10-19 22:55:16 +00:00
pjandro a07e739682 Merge pull request 'prod-autotests: pytest-набор автотестов API прода (env-конфигурация, mise)' (#12) from test/prod-autotests into main
Reviewed-on: #12
2026-10-20 01:33:05 +03:00
Pjandro ee49993aff tests: prod-autotests — pytest-набор автотестов API прода (env-конфигурация, mise-окружение)
18 проверок gateway → Spring Boot + SPA: открытые пути (actuator, SPA,
springdoc), граница X-API-Key (401), конвертация (PDF, RFC 5987 filename*),
отказы входа (400/422), лимит страниц — limit-aware через WORDPDF_MAX_PAGES.
Стенд задаётся только env; прод-раннер живёт вне git.
2026-10-19 22:31:44 +00:00
pjandro e7db0c6b06 Merge pull request 'ValidationException в ядре, checkPageCount, дефолты лимитов 5 MiB / 100 страниц' (#11) from feat/validation-exception-and-default-limits into main
Reviewed-on: #11
2026-10-20 00:51:29 +03:00
Pjandro 5482bfac60 core: перенос валидации входа из ConversionService в WordPdfValidator.validate 2026-10-19 21:49:34 +00:00
Pjandro 45b78f7fc9 core,app,web: дефолты лимитов входа 5 MiB / 100 страниц 2026-10-19 21:30:45 +00:00
Pjandro f09b629270 core: ValidationException вместо ConversionException; удаление pkg-API и переименование checkPageCountLightweight в checkPageCount 2026-10-19 21:30:45 +00:00
pjandro faf6d048a5 Merge pull request 'Миграция репо с docker на podman' (#10) from podman-migration into main
Reviewed-on: #10
2026-10-19 03:14:24 +03:00
Pjandro 65746db9d2 Migrate repo from docker to podman
- git mv docker-compose*.yml -> compose*.yml, Dockerfile -> Containerfile
  (podman-compose picks compose.yml; buildah finds Containerfile first)
- compose/compose.dev: x-podman.name_separator_compat (dash container
  names), explicit app/web healthchecks (OCI export drops image
  HEALTHCHECK, depends_on service_healthy would hang forever), fixed
  subnet 10.113.0.0/24 gw 10.113.0.1 for the aardvark-dns resolver
- gateway/nginx.conf: resolver + proxy_pass via variables (static
  proxy_pass resolves once at start; podman-restart.service brings
  gateway up before app -> dead upstream, 502 until manual restart)
- Containerfiles: pin base images to docker.io/library/* (no
  unqualified-search-registries on hosts), truthful buildah proxy comments
- comments/docs: Docker HEALTHCHECK -> container HEALTHCHECK; READMEs,
  AGENTS.md updated for podman/podman-compose

Verified on dev (podman 5.7.0, podman-compose 1.5.0): stack up with
dash names, app/web healthy, conversion through gateway returns PDF,
gateway survives app container restart without restart (resolver).
2026-10-19 00:13:52 +00:00
pjandro ab1b25c352 Merge pull request 'Dev-стенд: 0.0.0.0:9011, гейт ключа только по 401-зонду' (#9) from dev-open-bind-no-key into main
Reviewed-on: #9
2026-10-17 01:12:36 +03:00
Pjandro 2750486c91 dev-стенд: 0.0.0.0:9011, vite host:true, гейт ключа только по 401-зонду
- docker-compose.dev.yml: ports 127.0.0.1:9011:80 → 9011:80 (вход по LAN-IP хоста)
- vite.config.ts: server.host=true — dev-сервер тоже на все интерфейсы
- api.ts: probeApiKey() — GET /api/v1/convert (POST-only эндпоинт): 401 от
  ApiKeyFilter ⟺ сервер требует ключ; при выключенной аутентификации не 401
- App.tsx: экран ApiKeyGate показывается только когда зонд вернул 'required';
  401 на конвертации возвращает к гейту (setGate('required'))
- AGENTS.md: обновлены поведенческие строки (dev-вход, контракт гейта)
2026-10-16 22:11:53 +00:00
61 changed files with 2228 additions and 666 deletions
+4 -4
View File
@@ -5,7 +5,7 @@ WORDPDF_API_KEY=
# Лимиты входа (задаёт только сервер; параметрами запроса не переопределяются). # Лимиты входа (задаёт только сервер; параметрами запроса не переопределяются).
# Либо закомментировано (тогда дефолт), либо конкретное число — пустое # Либо закомментировано (тогда дефолт), либо конкретное число — пустое
# значение ломает старт приложения. # значение ломает старт приложения.
# Максимальный размер .docx в байтах (дефолт 20971520 = 20 МБ) # Максимальный размер .docx в байтах (дефолт 5242880 = 5 МБ)
#WORDPDF_MAX_BYTES=20971520 #WORDPDF_MAX_BYTES=5242880
# Максимальное число страниц (дефолт 1000) # Максимальное число страниц (дефолт 100)
#WORDPDF_MAX_PAGES=1000 #WORDPDF_MAX_PAGES=100
+5
View File
@@ -6,6 +6,11 @@ dependency-reduced-pom.xml
node_modules/ node_modules/
wordpdf-web/dist/ wordpdf-web/dist/
# Python (prod-autotests)
.venv/
__pycache__/
.pytest_cache/
# IDE # IDE
.idea/ .idea/
*.iml *.iml
+37 -26
View File
@@ -2,29 +2,35 @@
## Project Overview ## Project Overview
Конвертер `.docx` → `.pdf` на чистом Java (docx4j 17.3.2 + форк Apache FOP, без LibreOffice/Aspose). Java 21, только Maven. Модули: `wordpdf-core` (библиотека), `wordpdf-app` (Spring Boot 4.1.1 REST API); `wordpdf-web` — React SPA в nginx-контейнере (отдельный деп, вне Maven). Единственный гейт перед `git push` — `mvn clean verify` (CI нет; SPA гейтуется `npm run build` + `npm run lint`). Вход стека — контейнер `gateway` (nginx), НЕ 8080. README устарел шире Docker-секции: лимиты (пишет 5 МБ/100 стр./6 МБ multipart — фактически 20 MiB/1000/100 MB), порты («всё на :8080» — фактически gateway :9010/:9011), API-ключ вообще не упомянут; плюс «фикстуры генерируются POI» (они закоммичены, POI только в генераторе) и Swagger UI без оговорки, что в проде она открыта без ключа, — авторитет этот файл. Конвертер `.docx`/`.doc` → `.pdf` на чистом Java (docx4j 17.3.2 + форк Apache FOP; бинарный `.doc` Word 97-2003 — через POI HWPF, без LibreOffice/Aspose). Java 21, только Maven. Модули: `wordpdf-core` (библиотека), `wordpdf-app` (Spring Boot 4.1.1 REST API); `wordpdf-web` — React SPA в nginx-контейнере (отдельный деп, вне Maven). Единственный гейт перед `git push` — `mvn clean verify` (CI нет; SPA гейтуется `npm run build` + `npm run lint`). Вход стека — контейнер `gateway` (nginx), НЕ 8080. README устарел шире секции про контейнеры: лимиты (пишет 5 МБ/100 стр. — совпадает с кодом; 6 МБ multipart — фактически 100 MB), порты («всё на :8080» — фактически gateway :9010/:9011), API-ключ вообще не упомянут; плюс «фикстуры генерируются POI» (они закоммичены, POI только в генераторе) и Swagger UI без оговорки, что в проде она открыта без ключа, — авторитет этот файл.
## Architecture & Data Flow ## Architecture & Data Flow
### Пайплайн `WordPdfConverter.convert(byte[], String[, ConvertOptions])` (порядок фиксирован, менять местами нельзя) ### Пайплайн `WordPdfConverter.convert(byte[], String[, ConvertOptions])` (порядок фиксирован, менять местами нельзя)
Наружу `checkInput(bytes, maxBytes)` вызывается **до** приватного `convertToStream`; внутри `convertToStream`: Наружу `WordPdfValidator.validate(docxBytes, options)` (размер → zip-подпись `PK\x03\x04` → страницы) вызывается **до** приватного `convertToStream`; внутри `convertToStream`:
**Шаг 0**: вход с OLE2-магиком `D0 CF 11 E0 A1 B1 1A E1` (бинарный `.doc`) уходит в `internal.DocToPdfRenderer.render` **до** создания `BundledFontMapper` — docx4j-машинерия и все нормализаторы (zip-путь) для него бессмысленны; см. «Ветка .doc» ниже.
1. `new BundledFontMapper()` → `BundledFonts.init()` → `BundledFonts.restrictToBundled()`. Конструктор маппера каждый раз добавляет системные шрифты в реестр `PhysicalFonts`; ключ реестра — имя из name-таблицы TTF, `addPhysicalFont(URI)` не перезаписывает занятый → `init()` вызывает `dropNonBundled()` **до** регистрации и `load()` (иначе системный Calibri ломает em-dash-fallback). 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, переписывает и элементы `<w:sym>`; 5 карт по 256 слотов, таблица `SymbolMapper` сгенерирована из docx4j 17.x) → `FieldNormalizer` (`fldChar` PAGE/NUMPAGES/SECTIONPAGES → `w:fldSimple`, вложенные/битые поля пропускает) → `GlyphCoverageNormalizer` (режет ран по покрытию глифов, пишет семейство в `w:rFonts`, иначе FOP рисует «#»; покрытие — `java.awt.Font.canDisplay` + BitSet-кэш, НЕ docx4j `GlyphCheck` — тот плодит INFO-лог; для serif-ран fallback ищется сначала в `SERIF_FAMILIES` (DejaVu Serif/Tinos/Caladea), затем в sans) → `WordprocessingMLPackage.load`. 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, переписывает и элементы `<w:sym>`; 5 карт по 256 слотов, таблица `SymbolMapper` сгенерирована из docx4j 17.x) → `FieldNormalizer` (`fldChar` PAGE/NUMPAGES/SECTIONPAGES → `w:fldSimple`, вложенные/битые поля пропускает) → `GlyphCoverageNormalizer` (режет ран по покрытию глифов, пишет семейство в `w:rFonts`, иначе FOP рисует «#»; покрытие — `java.awt.Font.canDisplay` + BitSet-кэш, НЕ docx4j `GlyphCheck` — тот плодит INFO-лог; для serif-ран fallback ищется сначала в `SERIF_FAMILIES` (DejaVu Serif/Tinos/Caladea), затем в sans) → `WordprocessingMLPackage.load`.
3. `WordPdfValidator.checkPageCount(pkg, maxPages)` — **до** рендера. 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`; объект, выключенный в `ConvertOptions`, пропускается до рендера и остаётся в docx; упавший рендер — объект **удаляется** из docx (`gd.getAny().clear()`) + warn, деградация не падение).
5. `new FOSettings(pkg)` + `FopFallbackFonts.declare` (декларирует **все** бандл-семейства — FOP встраивает только задекларированные) → `FORendererApacheFOP`/`FOUserAgent` (непустой `title` → заголовок PDF) → `Docx4J.toFO(..., FLAG_EXPORT_PREFER_XSL)`. 5. `new FOSettings(pkg)` + `FopFallbackFonts.declare` (декларирует **все** бандл-семейства — FOP встраивает только задекларированные) → `FORendererApacheFOP`/`FOUserAgent` (непустой `title` → заголовок PDF) → `Docx4J.toFO(..., FLAG_EXPORT_PREFER_XSL)`.
6. `finally`: `deleteEmbeddedFontTempFiles()` (в 17.x `OpcPackage.close()` нет). 6. `finally`: `deleteEmbeddedFontTempFiles()` (в 17.x `OpcPackage.close()` нет).
### Ветка `.doc` (`internal/DocToPdfRenderer`, public только `render`)
POI `WordToFoConverter` (HWPF→XSL-FO) → тот же FOP-форк. Порядок: `BundledFonts.init()` (без `restrictToBundled` — FOP-конфиг строится строкой с `auto-detect="false"`, системные шрифты в рендер не попадают) → `POIFSFileSystem`/`HWPFDocument` → `FontReplacer` (имя = name-таблица TTF через `BundledFontMapper.bundledFamily`) → `PicturesManager` во временный каталог (без него POI **молча пропускает** картинки; пустые картинки — `null`, иначе FOP падает EOFException) → `processDocument` → пост-обработка FO-DOM: `applyDefaultFont` (инлайны POI без `font-family` — иначе базовый Helvetica) и `injectHeadersAndFooters` (POI колонтитулы не пишет): `HeaderStories` odd/even/first × header/footer, чанки по `\u000c`; в мастер — `region-before`/`region-after` (`extent` = top/bottom margin из `margin`-шортхэнда `region-body`, **margin'ы `region-body` сохраняются** — форк FOP не вычитает extent'ы регионов из body-области, единственная защита от наезда текста на колонтитулы — собственные margin'ы body; порядок детей body→before→after — требование валидации форка; зазор — маргинами блоков, padding регионов FOP валит), в `page-sequence` — `fo:static-content` перед `fo:flow`; first/even — эвристика «непустая история ⇒ вариант» (флаги titlePg/evenAndOdd POI не отдаёт) через `fo:page-sequence-master` + `conditional-page-master-reference` first/even/rest. Поля в текстах историй — управляющие символы `\u0013/\u0014/\u0015`: `PAGE` → `fo:page-number`, `NUMPAGES`/`SECTIONPAGES` → `fo:page-number-citation-last` по последнему мастеру; `fo:page-number` без `font-family` блока рисуется Helvetica — блок получает семейство первого рана. Свойство `tabs` FOP-форк не знает — табы = пробелы до дефолтной остановки 1,25 см. Принятая деградация против Word: дрейф вёрстки (18 стр. против 12 на фикстуре), экзотические глифы остаются `.notdef` (аналога `GlyphCoverageNormalizer` нет), first/even-варианты эвристикой. Флаги `renderCharts`/`renderSmartArt`/`errorOn*` — no-op.
### REST API (`wordpdf-app`, всё package-private кроме `WordPdfApplication`) ### REST API (`wordpdf-app`, всё package-private кроме `WordPdfApplication`)
- Единственный эндпоинт `POST /api/v1/convert` (multipart-поле `file`, факультативные `renderCharts`/`renderSmartArt` — query или form) → `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`, факультативные `renderCharts`/`renderSmartArt` — query или form) → `application/pdf`, `Content-Disposition: attachment; filename*=UTF-8''…`. Проверка расширений `.docx`/`.doc` — в `ConvertController`; `safeBaseName` в `ConversionService` — единый источник имени для файла, заголовка ответа и PDF-title (разрешены `[\p{L}\p{N} ._-]`, пустое → `document`). Для `.doc` ответ несёт `X-Wordpdf-Degraded: headers-footers-exotic-glyphs` (деградация вёрстки/колонтитулов/экзотических глифов).
- Конвертации **сериализованы** однопоточным `ThreadPoolExecutor` (`ConversionService.QUEUE_CAPACITY = 16`, переполнение → 503): ядро мутирует глобальный реестр `PhysicalFonts`. `future.cancel(true)` при таймауте не останавливает FOP мгновенно — осознанный компромисс. - Конвертации **сериализованы** однопоточным `ThreadPoolExecutor` (`ConversionService.QUEUE_CAPACITY = 16`, переполнение → 503): ядро мутирует глобальный реестр `PhysicalFonts`. `future.cancel(true)` при таймауте не останавливает FOP мгновенно — осознанный компромисс.
- Ошибки (`ApiExceptionHandler`, тело `{"error": …}`): `ValidationException` → 400; `ConversionFailedException` → 500; `ConversionRejectedException` → 503; `ConversionTimeoutException` (`wordpdf.convert-timeout`, 2m) → 504; `MaxUploadSizeExceededException` → 413; `MissingServletRequestPartException`/`MissingServletRequestParameterException` → 400; `NoResourceFoundException` (неизвестный путь) → 404; catch-all → 500 (подробности только в лог). Четыре app-исключения (`ValidationException`, `ConversionFailedException`, `ConversionRejectedException`, `ConversionTimeoutException`) — package-private, несут семантику 400/500/503/504. Граница: сломанный контейнер (не zip / размер / страницы) → 400, валидный zip с мусором внутри → 500. Валидация до очереди: `checkInput` → zip-магик `PK\x03\x04` → `checkPageCountLightweight` (порядок значим). - Ошибки (`ApiExceptionHandler`, тело `{"error": …}`): `ValidationException` → 400; `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-исключения (`ConversionFailedException`, `ConversionRejectedException`, `ConversionTimeoutException`) — package-private, несут семантику 500/503/504. `doConvert` перехватывает `ValidationException` раньше `ConversionException` — отказ страницы-лимита из конвейера ядра даёт 400, а не 500. Граница: сломанный контейнер (не zip / не OLE2 / размер / страницы) → 400, валидный контейнер с мусором внутри → 500. Валидация до очереди: `WordPdfValidator.validate(docxBytes, options)` (внутри порядок значим: `checkInput` → подпись контейнера (zip `PK\x03\x04` **или** OLE2 `D0 CF 11 E0`) → страницы); тот же метод — вход ядра.
- **Ключ доступа**: `ApiKeyFilter` сверяет заголовок `X-API-Key` (`ApiKeyFilter.HEADER`) со свойством `wordpdf.api-key` (env `WORDPDF_API_KEY`, сравнение `MessageDigest.isEqual`). Пустое свойство = аутентификация выключена (dev `java -jar`, тесты). Без ключа открыты `/actuator/**` (HEALTHCHECK) и документация springdoc (`/swagger-ui*`, `/v3/api-docs*`) — матч по пути **без forwarded-contextPath** (`getRequestURI()` минус `getContextPath()`; иначе под `X-Forwarded-Prefix` HEALTHCHECK получил бы 401). 401 пишет сам фильтр (`ApiExceptionHandler` ошибок фильтров не видит). Springdoc в проде **включён**, документация открыта без ключа под `https://pjandro.ru/pdf-converter/swagger-ui.html` (server-URL/swagger-config собираются из `X-Forwarded-*`, `server.forward-headers-strategy=framework` — `native`-клапан Tomcat `X-Forwarded-Prefix` не понимает). Регрессии — `ApiKeyFilterTest#forwardedPrefix_healthStaysOpen`, `ApiKeyFilterTest#docsOpenWithoutKey`. - **Ключ доступа**: `ApiKeyFilter` сверяет заголовок `X-API-Key` (`ApiKeyFilter.HEADER`) со свойством `wordpdf.api-key` (env `WORDPDF_API_KEY`, сравнение `MessageDigest.isEqual`). Пустое свойство = аутентификация выключена (dev `java -jar`, тесты). Без ключа открыты `/actuator/**` (HEALTHCHECK) и документация springdoc (`/swagger-ui*`, `/v3/api-docs*`) — матч по пути **без forwarded-contextPath** (`getRequestURI()` минус `getContextPath()`; иначе под `X-Forwarded-Prefix` HEALTHCHECK получил бы 401). 401 пишет сам фильтр (`ApiExceptionHandler` ошибок фильтров не видит). Springdoc в проде **включён**, документация открыта без ключа под `https://pjandro.ru/pdf-converter/swagger-ui.html` (server-URL/swagger-config собираются из `X-Forwarded-*`, `server.forward-headers-strategy=framework` — `native`-клапан Tomcat `X-Forwarded-Prefix` не понимает). Регрессии — `ApiKeyFilterTest#forwardedPrefix_healthStaysOpen`, `ApiKeyFilterTest#docsOpenWithoutKey`.
- Лимиты входа задаёт **только конфигурация сервера**: `wordpdf.max-bytes`/`wordpdf.max-pages` (env `WORDPDF_MAX_BYTES`/`WORDPDF_MAX_PAGES`), `@Value` в `ConvertController` с дефолтом-SpEL из `WordPdfSettings` (20 MiB / 1000); значение ≤ 0 → `IllegalStateException` на старте; параметрами запроса не переопределяются. Ключи в `application.properties` **не объявлены** — пустое значение затенит SpEL-дефолт. - Лимиты входа задаёт **только конфигурация сервера**: `wordpdf.max-bytes`/`wordpdf.max-pages` (env `WORDPDF_MAX_BYTES`/`WORDPDF_MAX_PAGES`), `@Value` в `ConvertController` с дефолтом-SpEL из `WordPdfSettings` (5 MiB / 100); значение ≤ 0 → `IllegalStateException` на старте; параметрами запроса не переопределяются. Ключи в `application.properties` **не объявлены** — пустое значение затенит SpEL-дефолт.
- SPA: вся сеть в `src/api.ts` (компоненты `fetch` не вызывают); ключ в `localStorage` (`wordpdf.api.key`), при 401 очищается, экран `ApiKeyGate` (`UnauthorizedError` — наследник `ApiError`, проверяется раньше); запросы на `${import.meta.env.BASE_URL}api/...` (vite `base` из `VITE_BASE`, дефолт `/`) — CORS не нужен (dev: vite-proxy → :8080; prod: nginx с префиксом `/pdf-converter/`). - SPA: вся сеть в `src/api.ts` (компоненты `fetch` не вызывают); ключ в `localStorage` (`wordpdf.api.key`), при 401 очищается, экран `ApiKeyGate` (`UnauthorizedError` — наследник `ApiError`, проверяется раньше); гейт показывается только когда `probeApiKey()` (GET /api/v1/convert → 401 от `ApiKeyFilter`) подтвердил требование ключа — в dev без ключа форма открывается сразу; запросы на `${import.meta.env.BASE_URL}api/...` (vite `base` из `VITE_BASE`, дефолт `/`) — CORS не нужен (dev: vite-proxy → :8080; prod: nginx с префиксом `/pdf-converter/`).
### Chart-движок (`internal/chart`, package-private кроме `DrawingPreRenderer.run`) ### Chart-движок (`internal/chart`, package-private кроме `DrawingPreRenderer.run`)
@@ -35,7 +41,9 @@ Java2D → PNG 300 dpi (`ChartRenderer.DPI = 300`, `PADDING = 4.0`, растр
- `docx4j.convert.out.fo.gsubFeatures=false` — static-блок `WordPdfConverter`. Иначе FO невалиден → `WordLayoutFixups` молча отказывает всем фиксам (без них нет колонок) → FOP падает на `docx4j-baseline`. - `docx4j.convert.out.fo.gsubFeatures=false` — static-блок `WordPdfConverter`. Иначе FO невалиден → `WordLayoutFixups` молча отказывает всем фиксам (без них нет колонок) → FOP падает на `docx4j-baseline`.
- `slf4j-simple` обязателен в ядре: без SLF4J-провайдера docx4j пишет «TO HIDE THESE MESSAGES» прямо в PDF (регрессия `noLoggingWarningInPdf`). Приложение исключает его из зависимости ядра — логи ведёт logback. - `slf4j-simple` обязателен в ядре: без SLF4J-провайдера docx4j пишет «TO HIDE THESE MESSAGES» прямо в PDF (регрессия `noLoggingWarningInPdf`). Приложение исключает его из зависимости ядра — логи ведёт logback.
- FOP — форк `org.docx4j:docx4j-fo-renderer*` 2.11-docx4j.2 (пакеты `org.apache.fop.*`); `Fop.Renderers.getRenderer()` возвращает **список** (рендер выбирается по mime `application/pdf`). `docx2fo.xslt` в репозитории нет — он в jar `docx4j-export-fo`. - FOP — форк `org.docx4j:docx4j-fo-renderer*` 2.11-docx4j.2 (пакеты `org.apache.fop.*`); `Fop.Renderers.getRenderer()` возвращает **список** (рендер выбирается по mime `application/pdf`). `docx2fo.xslt` в репозитории нет — он в jar `docx4j-export-fo`.
- Страницы в валидаторе = `max(кэш docProps/app.xml, явные разрывы, lastRenderedPageBreak+1)`; explicit = межсекционные `sectPr` в body + `w:br type="page"` + `pageBreakBefore` (рекурсивно, включая таблицы и `w:sdt`). Lightweight-путь (StAX по zip, secure-ридер без DTD/external entities): атрибуты — по локальному имени (`attrLocal`, не по transitional-URI: иначе в strict-документе `w:br type="page"` не засчитываются); `sectPr` внутри `pPr` не считает, последнюю body-direct секцию не считает, `continuous`-секции не считает, в колонтитулах — только `w:br type="page"`, `pageBreakBefore` — только внутри `pPr` вне `sectPr` (truthy-значения `val`: `null|true|1|on`); на не-zip молчит — подпись проверяет вызывающий. Расхождение lightweight↔JAXB допустимо только в завышение. `pageCountOf` package-private намеренно (тесты); при провале JAXB-разбора (`getJaxbElement()` → null) бросает `ConversionException`, а не NPE. - Форк FOP вырезал `PageMaster.setupRegions` (в jar нет `layoutmgr/PageMaster*`/`RegionXY`): `area.Page` строит viewport `region-body` как page-area минус **собственные** margin'ы body, `extent` у `region-before`/`region-after` body-регион не уменьшает — в `.doc`-ветке разводка body и колонтитулов только margin'ами `region-body` (регрессия `DocToPdfTest#legacyDoc_bodyClearsHeaderFooterRegions`). Docx-ветку не касается: docx4j сам закладывает высоты колонтитулов в margin'ы мастера.
- Страницы в валидаторе = `max(кэш docProps/app.xml, явные разрывы, lastRenderedPageBreak+1)`; explicit = межсекционные `sectPr` в body + `w:br type="page"` + `pageBreakBefore` (включая таблицы и `w:sdt`). Единственный путь — lightweight (StAX по zip, secure-ридер без DTD/external entities; JAXB-обход удалён — `WordPdfValidator` не зависит от docx4j): атрибуты — по локальному имени (`attrLocal`, не по transitional-URI: иначе в strict-документе `w:br type="page"` не засчитываются); `sectPr` внутри `pPr` не считает, последнюю body-direct секцию не считает, `continuous`-секции не считает, в колонтитулах — только `w:br type="page"`, `pageBreakBefore` — только внутри `pPr` вне `sectPr` (truthy-значения `val`: `null|true|1|on`); на не-zip молчит — подпись проверяет вызывающий. Все отказы — `ValidationException`.
- `.doc`: `checkDocPageCountLightweight` = кэш `SummaryInformation.getPacket().getPageCount()` (Word 97-2003 писал число страниц в OLE2-метаданные; явных разрывов из FIB не извлечь) — тот же stale-cache риск, что и `docProps/app.xml`; `0`/отсутствие пакета → молча. FOP-конфиг `.doc`-ветки — строка с `auto-detect="false"` + `resource://fonts/...` (классы `FOPFontProvider`/`FopConfParser` package-private, JAXB-обход `rendererFonts` к ним не применим). Кэш шрифтов отключён (`FOUserAgent.getFontManager().disableFontCache()` в `renderFo`): дефолт форка — `<user.home>/.fop/fop-fonts.cache`, а при непригодном `user.home` (null/несуществующий каталог — non-root контейнер без HOME) файл `.fop` в текущем каталоге, `/app` в образе не пишется → 500 на `.doc` (регрессия `DocToPdfTest#legacyDoc_fontCacheNotWrittenToWorkingDir`).
- Известный остаток эталона: U+2188/U+218A — глифов нет в OFL-шрифтах бандла, остаются `.notdef` (GNU FreeSerif GPL — не добавляем намеренно). - Известный остаток эталона: U+2188/U+218A — глифов нет в OFL-шрифтах бандла, остаются `.notdef` (GNU FreeSerif GPL — не добавляем намеренно).
- Внимательно: комментарии в `WordPdfConverter`/`DocxOnOffNormalizer` говорят «docx4j 11.x» — устаревшее число, фактически 17.3.2 (описанное поведение верно). - Внимательно: комментарии в `WordPdfConverter`/`DocxOnOffNormalizer` говорят «docx4j 11.x» — устаревшее число, фактически 17.3.2 (описанное поведение верно).
@@ -47,22 +55,23 @@ Java2D → PNG 300 dpi (`ChartRenderer.DPI = 300`, `PADDING = 4.0`, растр
|Путь|Назначение| |Путь|Назначение|
|---|---| |---|---|
|`wordpdf-core/src/main/java/ru/pjandro/wordpdf/`|публичный API: `WordPdfConverter`, `WordPdfValidator` (перегрузки `checkInput`/`checkPageCountLightweight`/`checkPageCount` — `byte[]` или pkg, с лимитом/без), `ConversionException`, `WordPdfSettings` (константы-дефолты), `ConvertOptions` (record: renderCharts, renderSmartArt, maxBytes, maxPages)| |`wordpdf-core/src/main/java/ru/pjandro/wordpdf/`|публичный API: `WordPdfConverter`, `WordPdfValidator` (перегрузки `checkInput`/`checkPageCount` — `byte[]`, с лимитом/без, `checkDocPageCountLightweight` — OLE2-`.doc`, и `validate(byte[], ConvertOptions)` — полная цепочка размер → подпись контейнера (zip/OLE2) → страницы; без зависимости от docx4j — только POI для `.doc`), `ConversionException`, `ValidationException` (наследник — «вход некорректен»), `WordPdfSettings` (константы-дефолты), `ConvertOptions` (record: renderCharts, renderSmartArt, maxBytes, maxPages)|
|`…/wordpdf/fonts/`|`BundledFonts` (реестр/выгрузка TTF, `families()`, `FALLBACK_FAMILY`), `BundledFontMapper` (алиасы MS→open-source, self-map, DISPLAY_NAMES, public-хук `bundledFamily`)| |`…/wordpdf/fonts/`|`BundledFonts` (реестр/выгрузка TTF, `families()`, `FALLBACK_FAMILY`), `BundledFontMapper` (алиасы MS→open-source, self-map, DISPLAY_NAMES, public-хук `bundledFamily`)|
|`…/wordpdf/internal/`|5 байтовых нормализатора + `FopFallbackFonts` (классы `public` — вызываются из родительского пакета; публичные члены только `normalize`/`declare`)| |`…/wordpdf/internal/`|5 байтовых нормализатора + `FopFallbackFonts` + `DocToPdfRenderer` (ветка `.doc`; классы `public` — вызываются из родительского пакета; публичные члены только `normalize`/`declare`/`render`)|
|`…/wordpdf/internal/chart/`|11 классов Java2D-рендера диаграмм/SmartArt в PNG (public только `DrawingPreRenderer`)| |`…/wordpdf/internal/chart/`|11 классов Java2D-рендера диаграмм/SmartArt в PNG (public только `DrawingPreRenderer`)|
|`wordpdf-core/src/main/resources/fonts/`|30 TTF + 3 лицензии — бинарные фикстуры, часть jar| |`wordpdf-core/src/main/resources/fonts/`|30 TTF + 3 лицензии — бинарные фикстуры, часть jar|
|`wordpdf-core/src/test/resources/samples/`|11 закоммиченных `.docx`-фикстур (единственные фикстуры)| |`wordpdf-core/src/test/resources/samples/`|12 закоммиченных фикстур: 11 `.docx` + `legacy-doc.doc` (OLE2, ветка `.doc`)|
|`wordpdf-app/src/main/java/ru/pjandro/wordpdf/app/`|REST API (10 классов): `WordPdfApplication` (единственный public), `ConvertController`, `ConversionService` (очередь), `ApiExceptionHandler`, `ApiKeyFilter`, `OpenApiConfig` (`@SecurityScheme` X-API-Key для springdoc) + 4 класса исключений| |`wordpdf-app/src/main/java/ru/pjandro/wordpdf/app/`|REST API (10 классов): `WordPdfApplication` (единственный public), `ConvertController`, `ConversionService` (очередь), `ApiExceptionHandler`, `ApiKeyFilter`, `OpenApiConfig` (`@SecurityScheme` X-API-Key для springdoc) + 4 класса исключений|
|`wordpdf-web/src/`|SPA (React 19 + TS + Vite + Tailwind): `api.ts` (вся сеть), `components/` (App, ApiKeyGate, PdfPreview, StatusMessage, DropZone, Logo)| |`wordpdf-web/src/`|SPA (React 19 + TS + Vite + Tailwind): `api.ts` (вся сеть), `components/` (App, ApiKeyGate, PdfPreview, StatusMessage, DropZone, Logo)|
|корневые `Dockerfile`, `docker-compose.yml`, `docker-compose.dev.yml`, `gateway/nginx.conf`|образ бэкенда (multi-stage maven:3.9-temurin-21 → temurin-21-jre, non-root, HEALTHCHECK actuator); compose app+web+gateway: web-образ со своим HEALTHCHECK (`wget /`), в обоих compose `depends_on web: condition: service_healthy` (без health web gateway не стартует); прод-compose интерполирует `WORDPDF_MAX_BYTES:-20971520`/`WORDPDF_MAX_PAGES:-1000`| |корневые `Containerfile`, `compose.yml`, `compose.dev.yml`, `gateway/nginx.conf`|образ бэкенда (multi-stage maven:3.9-temurin-21 → temurin-21-jre, non-root, HEALTHCHECK actuator); compose app+web+gateway: web-образ со своим HEALTHCHECK (`wget /`), в обоих compose `depends_on web: condition: service_healthy` (без health web gateway не стартует); прод-compose интерполирует `WORDPDF_MAX_BYTES:-5242880`/`WORDPDF_MAX_PAGES:-100`; podman-специфика обоих compose: `x-podman.name_separator_compat` (docker-style имена контейнеров), явные `healthcheck` app/web (дубли Containerfile-HEALTHCHECK — OCI-выгрузка его теряет), зафиксированная подсеть `10.113.0.0/24` gw `10.113.0.1` под резолвер aardvark-dns; два repo-стенда одновременно не поднять (общая подсеть)|
|корневой `.env.example`|шаблон env: `WORDPDF_API_KEY` (`openssl rand -hex 32`), закомментированные `WORDPDF_MAX_BYTES`/`WORDPDF_MAX_PAGES`; реальный прод `.env` — на прод-сервере (координаты: `/home/pjandro/prod/java-word-pdf/DEPLOY.md`, вне репо)| |корневой `.env.example`|шаблон env: `WORDPDF_API_KEY` (`openssl rand -hex 32`), закомментированные `WORDPDF_MAX_BYTES`/`WORDPDF_MAX_PAGES`; реальный прод `.env` — на прод-сервере (координаты: `/home/pjandro/prod/java-word-pdf/DEPLOY.md`, вне репо)|
|корневой `prod-autotests/`|прод-автотесты API (pytest + requests, 18 проверок): конфигурация стенда **только env** (`WORDPDF_BASE_URL` обязателен, `WORDPDF_API_KEY`/`WORDPDF_MAX_PAGES`/`WORDPDF_SAMPLES_DIR` факультативны) — прод-хостов/ключей в коде нет; окружение — mise (`mise.toml`: python 3.15 + автосоздаваемый `.venv`, в venv от uv pip досеивается `ensurepip`); прод-раннер вне git — `/home/pjandro/prod/java-word-pdf/run-prod-tests.sh` (знает прод-настройки: base URL, лимит 1000 стр., ключ из соседнего `.env`)|
|`develop/` (вне git)|рабочие материалы и эталоны Word 365 (`word.docx`+`word.pdf`, `word-export.*`, `convert.pdf`, `1212.pdf`, `diff/`) — **ручное сравнение, не фикстуры**, в тесты/jar не подключать| |`develop/` (вне git)|рабочие материалы и эталоны Word 365 (`word.docx`+`word.pdf`, `word-export.*`, `convert.pdf`, `1212.pdf`, `diff/`) — **ручное сравнение, не фикстуры**, в тесты/jar не подключать|
## Development Commands ## Development Commands
```bash ```bash
mvn clean verify # все модули + тесты — обязательный гейт перед push mvn clean verify # все модули + тесты + PMD (pmd-ruleset.xml) — обязательный гейт перед push
mvn -pl wordpdf-app -am package # исполняемый jar бэкенда mvn -pl wordpdf-app -am package # исполняемый jar бэкенда
java -jar wordpdf-app/target/wordpdf-app-1.0.0.jar # :8080, ключ выключен java -jar wordpdf-app/target/wordpdf-app-1.0.0.jar # :8080, ключ выключен
curl -F "file=@doc.docx" http://localhost:8080/api/v1/convert -o doc.pdf curl -F "file=@doc.docx" http://localhost:8080/api/v1/convert -o doc.pdf
@@ -70,10 +79,10 @@ mvn -pl wordpdf-core test -Dtest=WordPdfConverterTest#pageNumbers_recomputedNotC
mvn -pl wordpdf-app -am test -Dtest=ConvertControllerTest#convertSample_returnsPdf # -am обязателен (test-jar core) mvn -pl wordpdf-app -am test -Dtest=ConvertControllerTest#convertSample_returnsPdf # -am обязателен (test-jar core)
npm run dev # (wordpdf-web/) SPA :5173, vite-proxy /api → :8080 npm run dev # (wordpdf-web/) SPA :5173, vite-proxy /api → :8080
npm run build # (wordpdf-web/) tsc -b && vite build — гейт SPA; lint: npm run lint (oxlint) npm run build # (wordpdf-web/) tsc -b && vite build — гейт SPA; lint: npm run lint (oxlint)
docker compose -f docker-compose.dev.yml up -d --build # dev-стенд: http://127.0.0.1:9011, без ключа, springdoc вкл podman-compose -f compose.dev.yml up -d --build # dev-стенд: http://<LAN-IP хоста>:9011 (0.0.0.0), без ключа, springdoc вкл
``` ```
Пересоздать 10 фикстур (POI, test scope; `charts-smartart.docx` НЕ генерируется — создана вручную, не перезаписывать): Пересоздать 10 фикстур (POI, test scope; `charts-smartart.docx` и `legacy-doc.doc` НЕ генерируются — созданы вручную, не перезаписывать):
```bash ```bash
mvn -pl wordpdf-core test-compile -Dmdep.outputFile=/tmp/cp.txt dependency:build-classpath -q mvn -pl wordpdf-core test-compile -Dmdep.outputFile=/tmp/cp.txt dependency:build-classpath -q
@@ -81,7 +90,7 @@ java -cp wordpdf-core/target/test-classes:$(cat /tmp/cp.txt) \
ru.pjandro.wordpdf.SampleDocxGenerator wordpdf-core/src/test/resources/samples ru.pjandro.wordpdf.SampleDocxGenerator wordpdf-core/src/test/resources/samples
``` ```
Деплой. **Прод** — на пользовательском LAN-сервере; координаты сервера, каталог, restart-секвенция, ключ и гейты успешности — вне репо: `/home/pjandro/prod/java-word-pdf/DEPLOY.md` (обязательно прочитать перед любым деплоем/перезапуском; в том каталоге лежат архивные файлы старого стека 88.14 — `restart.sh.old-88.14`, старый compose/nginx — **не поднимать**). Единая точка входа с dev-машины — `/home/pjandro/prod/java-word-pdf/restart.sh` (пробрасывает флаги удалённому скрипту: `--build` — пересборка образов из `origin/main` + перезапуск; без флага — restart контейнеров; предупреждает о не запушенном в `main`). В прод попадает только запушенное в `main` — рабочее дерево на сборку не влияет. Наружный вход `https://pjandro.ru/pdf-converter/` (префикс срезает наружный nginx прод-хоста, не репозиторный gateway-конф; прод-копия gateway-конфа дополнительно содержит `proxy_read_timeout 300s` — в репо её нет, дефолтные 60s рвут 2-минутные конвертации). Тот же наружный nginx в `location /pdf-converter/` добавляет `X-Forwarded-Host: $host` и `X-Forwarded-Prefix: /pdf-converter` — из них springdoc собирает server-URL спека и swagger-config под префиксом (без `X-Forwarded-Host` server = `https://app:8080`, gateway шлёт приложению `Host: app:8080`); канонический URL документации `https://pjandro.ru/pdf-converter/swagger-ui.html` — открыт без ключа. **Dev-стенд** — из репо `docker-compose.dev.yml` (проект `wordpdf-dev`, `127.0.0.1:9011:80`, без env → ключ пуст, springdoc вкл). Репозиторный `docker-compose.yml` — третий вариант (проект `wordpdf`, `9010:80` на все интерфейсы, `WORDPDF_API_KEY` fail-closed без `.env` — `up` упадёт, `VITE_BASE` — build-arg `wordpdf-web/Dockerfile` — репо-compose НЕ передаёт: `compose build` без arg даёт base `/` и битые ассеты под префиксом, прод передаёт arg по DEPLOY.md). Запуск по просьбе пользователя = прод-стек; dev/`java -jar`/`npm run dev` — внутренняя отладка. Деплой. **Прод** — на пользовательском LAN-сервере (podman 5.8.2 + podman-compose 1.6.0, бинарников `docker`/`docker-compose` на сервере нет); координаты сервера, каталог, restart-секвенция, ключ и гейты успешности — вне репо: `/home/pjandro/prod/java-word-pdf/DEPLOY.md` (обязательно прочитать перед любым деплоем/перезапуском; в том каталоге лежат архивные файлы старого стека 88.14 — `restart.sh.old-88.14`, старый compose/nginx — **не поднимать**). Единая точка входа с dev-машины — `/home/pjandro/prod/java-word-pdf/restart.sh` (пробрасывает флаги удалённому скрипту: `--build` — пересборка образов из `origin/main` + перезапуск; без флага — restart контейнеров; предупреждает о не запушенном в `main`). В прод попадает только запушенное в `main` — рабочее дерево на сборку не влияет. Прод-compose `/opt/wordpdf/docker-compose.yml` (вне git) содержит podman-специфику: `x-podman.name_separator_compat` (имена `wordpdf-prod-app-1`, от них зависит `restart.sh`), явные healthcheck app/web и фиксированную подсеть `10.112.0.0/24` gw `10.112.0.1`. Наружный вход `https://pjandro.ru/pdf-converter/` (префикс срезает наружный nginx прод-хоста, не репозиторный gateway-конф; прод-копия gateway-конфа отличается от репо только резолвером `10.112.0.1` — под свою подсеть — и `proxy_read_timeout 300s` — в репо его нет, дефолтные 60s рвут 2-минутные конвертации; resolver + `proxy_pass` через переменную есть и там и там). Тот же наружный nginx в `location /pdf-converter/` добавляет `X-Forwarded-Host: $host` и `X-Forwarded-Prefix: /pdf-converter` — из них springdoc собирает server-URL спека и swagger-config под префиксом (без `X-Forwarded-Host` server = `https://app:8080`, gateway шлёт приложению `Host: app:8080`); канонический URL документации `https://pjandro.ru/pdf-converter/swagger-ui.html` — открыт без ключа. **Dev-стенд** — из репо `compose.dev.yml` (проект `wordpdf-dev`, `9011:80` на все интерфейсы — вход по LAN-IP хоста, без env → ключ пуст, springdoc вкл). Репозиторный `compose.yml` — третий вариант (проект `wordpdf`, `9010:80` на все интерфейсы, `WORDPDF_API_KEY` fail-closed без `.env` — `up` упадёт, `VITE_BASE` — build-arg `wordpdf-web/Containerfile` — репо-compose НЕ передаёт: `compose build` без arg даёт base `/` и битые ассеты под префиксом, прод передаёт arg по DEPLOY.md). Запуск по просьбе пользователя = прод-стек; dev/`java -jar`/`npm run dev` — внутренняя отладка.
## Code Conventions & Common Patterns ## Code Conventions & Common Patterns
@@ -96,11 +105,12 @@ java -cp wordpdf-core/target/test-classes:$(cat /tmp/cp.txt) \
## Important Files ## Important Files
- `wordpdf-core/src/main/java/ru/pjandro/wordpdf/WordPdfConverter.java` — точка входа библиотеки + static-блок `gsubFeatures`. - `wordpdf-core/src/main/java/ru/pjandro/wordpdf/WordPdfConverter.java` — точка входа библиотеки + static-блок `gsubFeatures`.
- `wordpdf-core/src/main/java/ru/pjandro/wordpdf/WordPdfSettings.java` — все дефолты ядра (`MAX_INPUT_BYTES` 20 MiB, `MAX_PAGES` 1000, `RENDER_CHARTS/SMARTART`); рантайм-конфигурации в ядре нет. - `wordpdf-core/src/main/java/ru/pjandro/wordpdf/WordPdfSettings.java` — все дефолты ядра (`MAX_INPUT_BYTES` 5 MiB, `MAX_PAGES` 100, `RENDER_CHARTS/SMARTART`); рантайм-конфигурации в ядре нет.
- `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-bytes`/`max-pages` здесь намеренно нет. - `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-bytes`/`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` (нужен Docker HEALTHCHECK `/actuator/health`); тест-зависимости: `spring-boot-webmvc-test` (в Boot 4 автоконфиг MockMvc вынесен из starter-test), test-jar core. - `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). - `wordpdf-core/pom.xml` — `maven-jar-plugin` execution `test-jar` (публикует фикстуры для app).
- Корневой `pom.xml` — все версии зависимостей (в модулях версии не объявлять): docx4j `17.3.2`, slf4j `2.0.20`, JUnit `6.1.3`, PDFBox `3.0.8` (test), POI `5.5.1` (test, только генератор фикстур), Spring Boot `4.1.1` (BOM-import), springdoc `3.1.1`; pluginManagement: compiler `3.16.0`, surefire `3.6.0` с `-Djava.awt.headless=true`, jar `3.5.1`. - Корневой `pom.xml` — все версии зависимостей (в модулях версии не объявлять): docx4j `17.3.2`, slf4j `2.0.20`, JUnit `6.1.3`, PDFBox `3.0.8` (test), POI `5.5.1` (compile в core — `poi-scratchpad`, ветка `.doc`; test — `poi-ooxml`, генератор фикстур), Spring Boot `4.1.1` (BOM-import), springdoc `3.1.1`; pluginManagement: compiler `3.16.0`, surefire `3.6.0` с `-Djava.awt.headless=true`, jar `3.5.1`.
- Корневой `pmd-ruleset.xml` — ruleset PMD (см. Testing & QA): `category/java/codestyle.xml` минус opinionated-правила, `MethodNamingConventions` с `junit5TestPattern` под underscore-имена регрессий, `TooManyStaticImports` до 12, XPath-правило `LiteralFirstInEquals`, unused-правила из `bestpractices.xml`.
- `wordpdf-core/src/main/resources/slf4j-simple.properties` — без него предупреждение лезет в PDF. - `wordpdf-core/src/main/resources/slf4j-simple.properties` — без него предупреждение лезет в PDF.
- `gateway/nginx.conf` — единственный вход: `/api/`, `/swagger-ui`, `/v3/api-docs`, `/actuator` → `app:8080`, остальное → `web:80`; `client_max_body_size 100m` (без директивы upload режется HTML-413 шлюза вместо JSON-ошибки API). `wordpdf-web/nginx.conf` — чистая статика с SPA-fallback, `/api` НЕ проксирует. - `gateway/nginx.conf` — единственный вход: `/api/`, `/swagger-ui`, `/v3/api-docs`, `/actuator` → `app:8080`, остальное → `web:80`; `client_max_body_size 100m` (без директивы upload режется HTML-413 шлюза вместо JSON-ошибки API). `wordpdf-web/nginx.conf` — чистая статика с SPA-fallback, `/api` НЕ проксирует.
- `wordpdf-core/src/test/java/ru/pjandro/wordpdf/SampleDocxGenerator.java` — main()-утилита пересоздания фикстур. - `wordpdf-core/src/test/java/ru/pjandro/wordpdf/SampleDocxGenerator.java` — main()-утилита пересоздания фикстур.
@@ -110,18 +120,19 @@ java -cp wordpdf-core/target/test-classes:$(cat /tmp/cp.txt) \
- Java 21 + Maven (обязательны; wrapper `mvnw` нет); UTF-8. Только Maven — никакого Gradle/Ant. - Java 21 + Maven (обязательны; wrapper `mvnw` нет); UTF-8. Только Maven — никакого Gradle/Ant.
- Версии зависимостей — только в корневом `pom.xml` (properties + dependencyManagement); новые зависимости — latest stable. - Версии зависимостей — только в корневом `pom.xml` (properties + dependencyManagement); новые зависимости — latest stable.
- Фронт: Node `^20.19.0 || >=22.12.0` (engines vite/oxlint из lockfile), npm с закоммиченным `package-lock.json` (`npm ci`); vite `^8.3.0`, React `^19.2`, TS `~6.0` (**`strict` нигде не включён** — `npm run build` не является strict-гейтом), Tailwind `^4.3`, oxlint `^1.81`; docker-сборка web на `node:24-alpine`. - Фронт: Node `^20.19.0 || >=22.12.0` (engines vite/oxlint из lockfile), npm с закоммиченным `package-lock.json` (`npm ci`); vite `^8.3.0`, React `^19.2`, TS `~6.0` (**`strict` нигде не включён** — `npm run build` не является strict-гейтом), Tailwind `^4.3`, oxlint `^1.81`; podman-сборка web на `node:24-alpine`.
- CI, линтеров, форматтеров, checkstyle для Java — нет; проверка одна: `mvn clean verify`. - CI, форматтеров, checkstyle для Java — нет; статический линтер — PMD на `verify` (см. Testing & QA); проверка одна: `mvn clean verify`.
- Исполняемый jar бэкенда проверять только `java -jar` (тесты идут по classpath и repackage-специфику не видят; `BundledFontsTest#listedFilesCoverAllTtfInResources` требует `file:`-протокол classpath — только surefire, не fat-jar). - Исполняемый jar бэкенда проверять только `java -jar` (тесты идут по classpath и repackage-специфику не видят; `BundledFontsTest#listedFilesCoverAllTtfInResources` требует `file:`-протокол classpath — только surefire, не fat-jar).
- Git: origin `git.pjandro.ru:pjandro/java-word-pdf`, `main`/`dev` защищены (правила глобального AGENTS.md; локально только `main`, `dev` нет; на origin висит остаточная смерженная `docs/regenerate-agents-md`). - Git: origin `git.pjandro.ru:pjandro/java-word-pdf`, `main`/`dev` защищены (правила глобального AGENTS.md; локально только `main`, `dev` нет; на origin висит остаточная смерженная `docs/regenerate-agents-md`).
## Testing & QA ## Testing & QA
- 14 тестовых классов / 126 `@Test` (core 11/104, app 3/22). 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`). - Гейт `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` — тесты сканируются).
- **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 таблицах). - 15 тестовых классов / 145 `@Test` (core 12/116, app 3/29). 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 таблицах). В `DocToPdfTest` маркер `#` НЕ проверяется: в `.doc`-ветке нет `GlyphCoverageNormalizer`, экзотические глифы легально остаются `.notdef`, а PDFBox «ремонтирует» подмножества установленных в системе шрифтов и извлекает `#` — текст/assertions только по Tinos/Carlito-ранам.
- Пиксели (BufferedImage) — только в unit-тестах chart-пейнтеров, допуски 6–10% против эталона Word (`PiePainterTest` аспект h/w=0.585, `assertRatio` отклонение <0.06; `Surface3dPainterTest` `assertRange` ±6 pt для центров силуэта + `assertRatio` допуск 0.10 для геометрических отношений; shading — не допуск, а перцентильные коридоры яркости p5∈[0.74,0.90], median∈[0.90,1.10], p95∈[1.02,1.20]). - Пиксели (BufferedImage) — только в unit-тестах chart-пейнтеров, допуски 6–10% против эталона Word (`PiePainterTest` аспект h/w=0.585, `assertRatio` отклонение <0.06; `Surface3dPainterTest` `assertRange` ±6 pt для центров силуэта + `assertRatio` допуск 0.10 для геометрических отношений; shading — не допуск, а перцентильные коридоры яркости p5∈[0.74,0.90], median∈[0.90,1.10], p95∈[1.02,1.20]).
- Фикстуры — закоммиченные `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` (кэш `<Pages>1</Pages>` + 110 `lastRenderedPageBreak`), `charts-smartart` (4 растра; SmartArt-одиночка = ровно 2 Image XObject). - Фикстуры — закоммиченные `samples/*` (12: 11 `.docx` + `legacy-doc.doc`; в тестах не генерировать): 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` (кэш `<Pages>1</Pages>` + 110 `lastRenderedPageBreak`), `charts-smartart` (4 растра; SmartArt-одиночка = ровно 2 Image XObject), `legacy-doc.doc` (реальный Word 97-2003: 43 картинки, колонтитулы с PAGE-полем, кэш `Pages=12`).
- Юниты нормализаторов работают строками (`rewrite`) + zip'ами из `ZipOutputStream`; обязательные контракты: «нечего менять → тот же массив» (`assertSame` покрыт тестами только у zip-нормализаторов `DocxOnOff`/`SymbolFont`/`StrictOoxml`; у `Field`/`GlyphCoverage` — `rewrite`→`null`) и неприкосновенность частей вне `word/*.xml` (`[Content_Types].xml`). Тесты бьют и в package-private API (`GlyphCoverageNormalizer.split(text, family)`, `pageCountOf`, `ChartSpec.readTitle`). - Юниты нормализаторов работают строками (`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`). - 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` (+`checkPageCountLightweight_agreesWithJaxbPath` 99/100/101, `pageCount_breaksInsideTablesAreCounted`, `pageCount_continuousSectionsNotCountedLightweight`), `BundledFontsTest`↔`ruPlain_emDashEmbeddedNotHelvetica`, `ChartSpecTest`↔автозаголовки, chart-пейнтеры↔`chartsSmartArt_drawingsBecomeImages` (+`drawingToggles_offRemovesRasters`/`drawingToggles_chartsOffSmartArtOn`); `noLoggingWarningInPdf` — регрессия `slf4j-simple`, `pdfTitle_comesFromParameter` — регрессия PDF-title (юнит-партнёра нет). App-регрессии: `requestLimitParams_areIgnored`, `nonPositiveLimits_failStartup`, `unknownPath_notFound`, `concurrentRequests_bothSucceed` (гонка реестра `PhysicalFonts`), `corruptNotAZip_rejected`, `junkInsideValidZip_conversionError`, `nonDocxFilename_rejected`, `oversizedOverCoreLimit_rejected`, `renderFlagsOff_convertsWithoutDrawings`, `cyrillicAndPathInFilename_sanitizedResponseName` (RFC 5987 + path-traversal), `docsOpenWithoutKey`/`forwardedPrefix_healthStaysOpen`/`forwardedPrefix_docsOpenWithoutKey` (открытая документация + матч фильтра без forwarded-contextPath). - Регрессивные пары (фикс = нормализатор/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_neitherDocxNorDoc`↔`inputNotAZip_rejectedBeforeRender`), `BundledFontsTest`↔`ruPlain_emDashEmbeddedNotHelvetica`, `ChartSpecTest`↔автозаголовки, chart-пейнтеры↔`chartsSmartArt_drawingsBecomeImages` (+`drawingToggles_offRemovesRasters`/`drawingToggles_chartsOffSmartArtOn`), `DocToPdfTest`↔`DocToPdfRenderer` (`legacyDoc_convertsToPdf` — Tinos/Carlito без Helvetica + 43 картинки; `legacyDoc_footersCarryPageNumbers` — инъекция колонтитулов + PAGE; `ole2Junk_rejected`; `legacyDoc_fontCacheNotWrittenToWorkingDir` — кэш шрифтов не в CWD (контейнер: /app не пишется)); `noLoggingWarningInPdf` — регрессия `slf4j-simple`, `pdfTitle_comesFromParameter` — регрессия PDF-title (юнит-партнёра нет). App-регрессии: `requestLimitParams_areIgnored`, `nonPositiveLimits_failStartup`, `unknownPath_notFound`, `concurrentRequests_bothSucceed` (гонка реестра `PhysicalFonts`), `corruptNotAZip_rejected`, `junkInsideValidZip_conversionError`, `nonDocxFilename_rejected`, `oversizedOverCoreLimit_rejected`, `renderFlagsOff_convertsWithoutDrawings`, `cyrillicAndPathInFilename_sanitizedResponseName` (RFC 5987 + path-traversal), `docsOpenWithoutKey`/`forwardedPrefix_healthStaysOpen`/`forwardedPrefix_docsOpenWithoutKey` (открытая документация + матч фильтра без forwarded-contextPath), `legacyDoc_convertsToPdf` (OLE2-развилка валидации ядра + заголовок `X-Wordpdf-Degraded`).
- UI-тестов нет; гейт SPA — `npm run build` (tsc -b) + `npm run lint` (oxlint, `.oxlintrc.json`: rules-of-hooks error, only-export-components warn). - UI-тестов нет; гейт SPA — `npm run build` (tsc -b) + `npm run lint` (oxlint, `.oxlintrc.json`: rules-of-hooks error, only-export-components warn).
+6 -3
View File
@@ -1,4 +1,6 @@
FROM maven:3.9-eclipse-temurin-21 AS build # FROM с полным именем реестра: podman не резолвит short-name без
# unqualified-search-registries в /etc/containers/registries.conf.
FROM docker.io/library/maven:3.9-eclipse-temurin-21 AS build
WORKDIR /build WORKDIR /build
COPY pom.xml . COPY pom.xml .
COPY wordpdf-core/pom.xml wordpdf-core/ COPY wordpdf-core/pom.xml wordpdf-core/
@@ -7,11 +9,12 @@ RUN mvn -B -q dependency:go-offline
COPY . . COPY . .
RUN mvn -B -q -DskipTests package RUN mvn -B -q -DskipTests package
FROM eclipse-temurin:21-jre FROM docker.io/library/eclipse-temurin:21-jre
# curl — только для HEALTHCHECK; runtime полный jre (не alpine-slim): Java2D # curl — только для HEALTHCHECK; runtime полный jre (не alpine-slim): Java2D
# chart-движка нужны AWT и fontconfig-нативки; бандл-шрифты лежат в jar, # chart-движка нужны AWT и fontconfig-нативки; бандл-шрифты лежат в jar,
# системные шрифты не нужны. Тесты в образе не гоняем — гейт mvn clean verify. # системные шрифты не нужны. Тесты в образе не гоняем — гейт mvn clean verify.
# Прокси из docker-config подмешивается в HEALTHCHECK-шелл и ломает curl # Прокси-переменные хоста (HTTP_PROXY/HTTPS_PROXY/http_proxy/https_proxy)
# podman/buildah подмешивает в шелл RUN/HEALTHCHECK и ломает curl
# (127.0.0.1:proxy внутри контейнера недоступен) — обнуляем на команде. # (127.0.0.1:proxy внутри контейнера недоступен) — обнуляем на команде.
RUN apt-get update \ RUN apt-get update \
&& apt-get install -y --no-install-recommends curl \ && apt-get install -y --no-install-recommends curl \
+3 -3
View File
@@ -86,17 +86,17 @@ Files.write(Path.of("out.pdf"), pdf);
больше ста) бросают `ConversionException`. Работа с файлами — забота больше ста) бросают `ConversionException`. Работа с файлами — забота
вызывающего: ядро пути не принимает. вызывающего: ядро пути не принимает.
### Веб-интерфейс и Docker ### Веб-интерфейс и контейнеры (podman)
```bash ```bash
docker compose up -d --build podman-compose up -d --build
``` ```
Всё на `http://localhost:8080/`: nginx-контейнер `web` раздаёт SPA и проксирует Всё на `http://localhost:8080/`: nginx-контейнер `web` раздаёт SPA и проксирует
`/api`, `/swagger-ui`, `/v3/api-docs` на бэкенд (контейнер `app` наружу не `/api`, `/swagger-ui`, `/v3/api-docs` на бэкенд (контейнер `app` наружу не
публикуется). публикуется).
Dev-режим без Docker: бэкенд `java -jar wordpdf-app/target/wordpdf-app-1.0.0.jar` Dev-режим без контейнеров: бэкенд `java -jar wordpdf-app/target/wordpdf-app-1.0.0.jar`
(порт 8080) + `npm run dev` в `wordpdf-web/` → `http://localhost:5173` (порт 8080) + `npm run dev` в `wordpdf-web/` → `http://localhost:5173`
(Vite проксирует `/api` на 8080, CORS не нужен). (Vite проксирует `/api` на 8080, CORS не нужен).
+54
View File
@@ -0,0 +1,54 @@
# Dev-стенд без ключа доступа: WORDPDF_API_KEY не задан → wordpdf.api-key пуст
# → ApiKeyFilter прозрачен, springdoc включён. Проект wordpdf-dev — собственные
# образы/контейнеры, с прод-запуском (wordpdf-prod, :9010) не конфликтует.
# Запуск: podman-compose -f compose.dev.yml up -d --build
# Вход: http://<LAN-IP хоста>:9011 (доступен из локальной сети; hostname -I на хосте)
name: wordpdf-dev
# podman-compose по умолчанию разделяет имя проекта/сервиса/номера подчёркиванием
# (wordpdf-dev_app_1). Compat-флаг возвращает docker-style имена (wordpdf-dev-app-1).
x-podman:
name_separator_compat: true
services:
app:
build: .
restart: unless-stopped
# Дублирует HEALTHCHECK из Containerfile: podman выгружает образы в OCI,
# где поля healthcheck нет — без явного healthcheck depends_on
# service_healthy ждал бы healthy вечно. Прокси обнуляем на команде.
healthcheck:
test: ["CMD-SHELL", "HTTP_PROXY= http_proxy= HTTPS_PROXY= https_proxy= curl -fsS http://127.0.0.1:8080/actuator/health >/dev/null || exit 1"]
interval: 10s
timeout: 3s
start_period: 45s
retries: 5
web:
build: ./wordpdf-web
restart: unless-stopped
# См. комментарий у app: дубль HEALTHCHECK из wordpdf-web/Containerfile
healthcheck:
test: ["CMD-SHELL", "http_proxy= https_proxy= wget -qO /dev/null http://127.0.0.1/ || exit 1"]
interval: 10s
timeout: 3s
start_period: 10s
gateway:
image: docker.io/library/nginx:alpine
volumes:
- ./gateway/nginx.conf:/etc/nginx/conf.d/default.conf:ro
ports: ["9011:80"]
depends_on:
app:
condition: service_healthy
web:
condition: service_healthy
restart: unless-stopped
networks:
# Подсеть зафиксирована намеренно: nginx в gateway/nginx.conf резолвит app/web
# через aardvark-dns на шлюзе сети (10.113.0.1), адрес обязан быть
# предсказуемым. Оба repo-стенда делят её осознанно: они взаимоисключающие
# варианты отладки, одновременно не поднимаются.
default:
ipam:
config:
- subnet: 10.113.0.0/24
gateway: 10.113.0.1
+59
View File
@@ -0,0 +1,59 @@
name: wordpdf
# podman-compose по умолчанию разделяет имя проекта/сервиса/номера подчёркиванием
# (wordpdf_app_1). Compat-флаг возвращает docker-style имена (wordpdf-app-1).
x-podman:
name_separator_compat: true
services:
app:
build: .
restart: unless-stopped
# Дублирует HEALTHCHECK из Containerfile: podman выгружает образы в OCI,
# где поля healthcheck нет — без явного healthcheck depends_on
# service_healthy ждал бы healthy вечно. Прокси обнуляем на команде.
healthcheck:
test: ["CMD-SHELL", "HTTP_PROXY= http_proxy= HTTPS_PROXY= https_proxy= curl -fsS http://127.0.0.1:8080/actuator/health >/dev/null || exit 1"]
interval: 10s
timeout: 3s
start_period: 45s
retries: 5
environment:
# без ключа стек не поднимется (:? на пустое/unset) — прод fail-closed
WORDPDF_API_KEY: "${WORDPDF_API_KEY:?WORDPDF_API_KEY not set: put it in .env (openssl rand -hex 32)}"
# документация в прод-интернете не нужна (в dev/java -jar остаётся включена)
SPRINGDOC_API_DOCS_ENABLED: "false"
SPRINGDOC_SWAGGER_UI_ENABLED: "false"
# лимиты входа (байты/страницы); значение из .env, иначе дефолты ядра;
# интерполяция :- подставляет и на unset, и на пустое — пустая строка
# сломала бы binding long/int
WORDPDF_MAX_BYTES: "${WORDPDF_MAX_BYTES:-5242880}"
WORDPDF_MAX_PAGES: "${WORDPDF_MAX_PAGES:-100}"
web:
build: ./wordpdf-web
restart: unless-stopped
# См. комментарий у app: дубль HEALTHCHECK из wordpdf-web/Containerfile
healthcheck:
test: ["CMD-SHELL", "http_proxy= https_proxy= wget -qO /dev/null http://127.0.0.1/ || exit 1"]
interval: 10s
timeout: 3s
start_period: 10s
gateway:
image: docker.io/library/nginx:alpine
volumes:
- ./gateway/nginx.conf:/etc/nginx/conf.d/default.conf:ro
ports: ["9010:80"]
depends_on:
app:
condition: service_healthy
web:
condition: service_healthy
restart: unless-stopped
networks:
# Подсеть зафиксирована намеренно: nginx в gateway/nginx.conf резолвит app/web
# через aardvark-dns на шлюзе сети (10.113.0.1), адрес обязан быть
# предсказуемым. Отличается от прод-10.112.0.0/24, чтобы стенды не конфликтовали.
default:
ipam:
config:
- subnet: 10.113.0.0/24
gateway: 10.113.0.1
-24
View File
@@ -1,24 +0,0 @@
# Dev-стенд без ключа доступа: WORDPDF_API_KEY не задан → wordpdf.api-key пуст
# → ApiKeyFilter прозрачен, springdoc включён. Проект wordpdf-dev — собственные
# образы/контейнеры, с прод-запуском (wordpdf-prod, :9010) не конфликтует.
# Запуск: docker compose -f docker-compose.dev.yml up --build
# Вход: http://127.0.0.1:9011
name: wordpdf-dev
services:
app:
build: .
restart: unless-stopped
web:
build: ./wordpdf-web
restart: unless-stopped
gateway:
image: nginx:alpine
volumes:
- ./gateway/nginx.conf:/etc/nginx/conf.d/default.conf:ro
ports: ["127.0.0.1:9011:80"]
depends_on:
app:
condition: service_healthy
web:
condition: service_healthy
restart: unless-stopped
-30
View File
@@ -1,30 +0,0 @@
name: wordpdf
services:
app:
build: .
restart: unless-stopped
environment:
# без ключа стек не поднимется (:? на пустое/unset) — прод fail-closed
WORDPDF_API_KEY: "${WORDPDF_API_KEY:?WORDPDF_API_KEY not set: put it in .env (openssl rand -hex 32)}"
# документация в прод-интернете не нужна (в dev/java -jar остаётся включена)
SPRINGDOC_API_DOCS_ENABLED: "false"
SPRINGDOC_SWAGGER_UI_ENABLED: "false"
# лимиты входа (байты/страницы); значение из .env, иначе дефолты ядра;
# интерполяция :- подставляет и на unset, и на пустое — пустая строка
# сломала бы binding long/int
WORDPDF_MAX_BYTES: "${WORDPDF_MAX_BYTES:-20971520}"
WORDPDF_MAX_PAGES: "${WORDPDF_MAX_PAGES:-1000}"
web:
build: ./wordpdf-web
restart: unless-stopped
gateway:
image: nginx:alpine
volumes:
- ./gateway/nginx.conf:/etc/nginx/conf.d/default.conf:ro
ports: ["9010:80"]
depends_on:
app:
condition: service_healthy
web:
condition: service_healthy
restart: unless-stopped
+16 -6
View File
@@ -4,12 +4,22 @@ server {
listen 80; listen 80;
# потолок загрузки стека: больше не пропустит ни шлюз, ни Spring multipart; # потолок загрузки стека: больше не пропустит ни шлюз, ни Spring multipart;
# авторитетный лимит — свойство wordpdf.max-bytes (env WORDPDF_MAX_BYTES, # авторитетный лимит — свойство wordpdf.max-bytes (env WORDPDF_MAX_BYTES,
# дефолт 20 MiB). Без директивы upload режется HTML-413 от шлюза до бэкенда. # дефолт 5 MiB). Без директивы upload режется HTML-413 от шлюза до бэкенда.
client_max_body_size 100m; client_max_body_size 100m;
location /api/ { proxy_pass http://app:8080; } # app/web резолвятся aardvark-dns, который сидит на шлюзе сети стека
location /swagger-ui { proxy_pass http://app:8080; } # (подсеть зафиксирована в compose.yml / compose.dev.yml, адрес стабилен).
location /v3/api-docs { proxy_pass http://app:8080; } # Статический proxy_pass резолвит имя ровно один раз при старте nginx:
# если gateway поднялся раньше app (так стартует podman-restart.service при
# загрузке хоста), апстрим навсегда оставался мёртвым — 502 до перезапуска
# gateway. resolver + переменная заставляют резолвить на каждый запрос.
resolver 10.113.0.1 valid=10s ipv6=off;
set $upstream_app http://app:8080;
set $upstream_web http://web:80;
location /api/ { proxy_pass $upstream_app; }
location /swagger-ui { proxy_pass $upstream_app; }
location /v3/api-docs { proxy_pass $upstream_app; }
# открыт фильтром приложения (wordpdf.api-key его не проверяет) — мониторинг/HEALTHCHECK снаружи # открыт фильтром приложения (wordpdf.api-key его не проверяет) — мониторинг/HEALTHCHECK снаружи
location /actuator { proxy_pass http://app:8080; } location /actuator { proxy_pass $upstream_app; }
location / { proxy_pass http://web:80; } location / { proxy_pass $upstream_web; }
} }
+66
View File
@@ -0,0 +1,66 @@
<?xml version="1.0"?>
<ruleset name="WordPDF code style" xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
<description>Код-стиль java-word-pdf: codestyle без opinionated-правил + unused-правила + NPE-safe equals</description>
<rule ref="category/java/codestyle.xml">
<!-- opinionated/шумные, намеренно выключены -->
<exclude name="AtLeastOneConstructor"/>
<exclude name="CallSuperInConstructor"/>
<exclude name="CommentDefaultAccessModifier"/>
<exclude name="ConfusingTernary"/>
<exclude name="FieldDeclarationsShouldBeAtStartOfClass"/>
<exclude name="LocalVariableCouldBeFinal"/>
<exclude name="LongVariable"/>
<exclude name="MethodArgumentCouldBeFinal"/>
<exclude name="OnlyOneReturn"/>
<exclude name="PrematureDeclaration"/>
<exclude name="ShortMethodName"/>
<exclude name="ShortVariable"/>
<exclude name="UseExplicitTypes"/>
<exclude name="UseUnderscoresInNumericLiterals"/>
<!-- переопределены ниже -->
<exclude name="MethodNamingConventions"/>
<exclude name="TooManyStaticImports"/>
</rule>
<!-- регрессионные тесты репо именуются объект_условие (AGENTS.md) -->
<rule ref="category/java/codestyle.xml/MethodNamingConventions">
<properties>
<property name="junit5TestPattern" value="^[a-z][a-zA-Z0-9]*(_[a-zA-Z0-9]+)*$"/>
</properties>
</rule>
<!-- MockMvc-тесты: >4 статических импортов — норма -->
<rule ref="category/java/codestyle.xml/TooManyStaticImports">
<properties>
<property name="maximumStaticImports" value="12"/>
</properties>
</rule>
<!-- PMD 7 удалил EqualsAvoidsNull; NPE-safe порядок операндов: литерал слева -->
<rule name="LiteralFirstInEquals" language="java"
message="NPE-safe сравнение строк: строковый литерал должен стоять слева: &quot;lit&quot;.equals(x)"
class="net.sourceforge.pmd.lang.rule.xpath.XPathRule">
<priority>3</priority>
<properties>
<property name="xpath">
<value><![CDATA[
//MethodCall[
(@MethodName = 'equals' or @MethodName = 'equalsIgnoreCase')
and ArgumentList/StringLiteral
and not(*[1][self::StringLiteral
or (self::VariableAccess and @CompileTimeConstant = true())])
]
]]></value>
</property>
</properties>
</rule>
<rule ref="category/java/bestpractices.xml/UnusedAssignment"/>
<rule ref="category/java/bestpractices.xml/UnusedFormalParameter"/>
<rule ref="category/java/bestpractices.xml/UnusedLocalVariable"/>
<rule ref="category/java/bestpractices.xml/UnusedPrivateField"/>
<rule ref="category/java/bestpractices.xml/UnusedPrivateMethod"/>
</ruleset>
+35
View File
@@ -85,6 +85,12 @@
<artifactId>pdfbox</artifactId> <artifactId>pdfbox</artifactId>
<version>${pdfbox.version}</version> <version>${pdfbox.version}</version>
</dependency> </dependency>
<!-- Чтение бинарных .doc (HWPF) и экспорт HWPF->XSL-FO (WordToFoConverter) -->
<dependency>
<groupId>org.apache.poi</groupId>
<artifactId>poi-scratchpad</artifactId>
<version>${poi.version}</version>
</dependency>
<!-- Только для генерации тестовых .docx (одноразово), в рантайм не используется --> <!-- Только для генерации тестовых .docx (одноразово), в рантайм не используется -->
<dependency> <dependency>
<groupId>org.apache.poi</groupId> <groupId>org.apache.poi</groupId>
@@ -116,6 +122,28 @@
<artifactId>maven-jar-plugin</artifactId> <artifactId>maven-jar-plugin</artifactId>
<version>3.5.1</version> <version>3.5.1</version>
</plugin> </plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-pmd-plugin</artifactId>
<version>3.28.0</version>
<configuration>
<rulesets>
<ruleset>${maven.multiModuleProjectDirectory}/pmd-ruleset.xml</ruleset>
</rulesets>
<includeTests>true</includeTests>
<printFailingErrors>true</printFailingErrors>
<linkXRef>false</linkXRef>
</configuration>
<executions>
<execution>
<id>pmd-check</id>
<phase>verify</phase>
<goals>
<goal>check</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin> <plugin>
<groupId>org.springframework.boot</groupId> <groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId> <artifactId>spring-boot-maven-plugin</artifactId>
@@ -123,5 +151,12 @@
</plugin> </plugin>
</plugins> </plugins>
</pluginManagement> </pluginManagement>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-pmd-plugin</artifactId>
</plugin>
</plugins>
</build> </build>
</project> </project>
+86
View File
@@ -0,0 +1,86 @@
"""Автотесты прода wordpdf: стенд задаётся исключительно переменными окружения.
Запуск из этого каталога (подхватывается mise.toml — python + venv + зависимости):
WORDPDF_BASE_URL=<стенд> [WORDPDF_API_KEY=<ключ>] mise exec -- python -m pytest -q .
WORDPDF_BASE_URL обязателен: без него все проверки падают — набор принципиально
не знает ни одного хоста. WORDPDF_API_KEY факультативен: без него проверки,
где есть заголовок ключа или ожидается 401, пропускаются (без локального ключа
нельзя знать, включена ли аутентификация на стенде). WORDPDF_MAX_PAGES — ожидаемый
лимит страниц стенда (конфигурация сервера, не константа набора; дефолт 100 =
дефолт ядра). .docx-фикстуры — из wordpdf-core/src/test/resources/samples,
либо из WORDPDF_SAMPLES_DIR.
"""
import os
from pathlib import Path
import pytest
# (connect, read): read 180 с — с запасом над серверным wordpdf.convert-timeout=2m
# (504 по таймауту — тоже ответ сервера, но до него не доходим).
TIMEOUT = (10, 180)
# Навешивается на все проверки с заголовком ключа или ожиданием 401: на стенде
# без аутентификации (dev) они дали бы ложный FAIL, а не честный SKIP.
needs_key = pytest.mark.skipif(
not os.environ.get("WORDPDF_API_KEY", "").strip(),
reason="WORDPDF_API_KEY не задан — стенд без аутентификации или ключ не передан",
)
@pytest.fixture(scope="session")
def base_url():
"""Корень стенда только из env; пустой — провал, а не дефолт-хост."""
url = os.environ.get("WORDPDF_BASE_URL", "").strip().rstrip("/")
if not url:
pytest.fail("WORDPDF_BASE_URL не задан — набор привязан к стенду только этой переменной")
return url
@pytest.fixture(scope="session")
def url(base_url):
"""Единая склейка base + путь — все запросы тестов идут через неё."""
def join(path):
return base_url + path
return join
@pytest.fixture(scope="session")
def max_pages():
"""Ожидаемый лимит страниц стенда: серверная конфигурация, не константа набора."""
return int(os.environ.get("WORDPDF_MAX_PAGES", "100"))
@pytest.fixture(scope="session")
def api_key():
return os.environ.get("WORDPDF_API_KEY", "").strip()
@pytest.fixture(scope="session")
def key_header(api_key):
return {"X-API-Key": api_key} if api_key else {}
@pytest.fixture(scope="session")
def samples():
"""Каталог закоммиченных .docx-фикстур ядра (только чтение)."""
env = os.environ.get("WORDPDF_SAMPLES_DIR", "").strip()
d = Path(env) if env else (
Path(__file__).resolve().parents[1]
/ "wordpdf-core" / "src" / "test" / "resources" / "samples"
)
if not (d / "en-plain.docx").is_file():
pytest.fail("фикстуры не найдены: укажите WORDPDF_SAMPLES_DIR")
return d
@pytest.fixture
def notzip_docx(tmp_path):
"""Файл с валидным .docx-суффиксом и случайным содержимым — граница «не zip → 400, а не 500»."""
p = tmp_path / "notzip.docx"
p.write_bytes(os.urandom(2048))
return p
+5
View File
@@ -0,0 +1,5 @@
[tools]
python = "3.15"
[env]
_.python.venv = { path = ".venv", create = true }
+2
View File
@@ -0,0 +1,2 @@
pytest==9.1.1
requests==2.34.2
+250
View File
@@ -0,0 +1,250 @@
"""Проверки прода-API wordpdf: gateway → Spring Boot (`POST /api/v1/convert` за X-API-Key) + SPA.
Коды и тела ответов соответствуют ApiExceptionHandler / ApiKeyFilter /
ConvertController на main. Флаги конвертации передаются только в query-строке
(контроллер принимает и form, но query детерминированнее).
"""
import requests
from conftest import TIMEOUT, needs_key
CONVERT = "/api/v1/convert"
# --- открытые пути (ключ не нужен ни при каком стенде) -----------------------
def test_health(url):
"""Живость: actuator health открыт без ключа (HEALTHCHECK контейнера)."""
r = requests.get(url("/actuator/health"), timeout=TIMEOUT)
assert r.status_code == 200
assert r.json()["status"] == "UP"
def test_spa_root(url):
"""SPA отдаётся гейтваем: корень — HTML приложения с монтажным узлом."""
r = requests.get(url("/"), timeout=TIMEOUT)
assert r.status_code == 200
assert "text/html" in r.headers["content-type"]
assert 'id="root"' in r.text
def test_swagger_ui_open_without_key(url):
"""Документация открыта без ключа — регрессия docsOpenWithoutKey."""
r = requests.get(url("/swagger-ui.html"), timeout=TIMEOUT)
assert r.status_code == 200
def test_api_docs_spec(url):
"""Спек OpenAPI открыт без ключа и описывает единственный эндпоинт."""
r = requests.get(url("/v3/api-docs"), timeout=TIMEOUT)
assert r.status_code == 200
assert "/api/v1/convert" in r.text
# --- дальше все проверки требуют переданный ключ ----------------------------
@needs_key
def test_no_key_rejected(url, samples):
"""Граница доступа: запрос без заголовка X-API-Key — 401 от ApiKeyFilter."""
r = requests.post(
url(CONVERT),
files={"file": ("en-plain.docx", (samples / "en-plain.docx").read_bytes())},
timeout=TIMEOUT,
)
assert r.status_code == 401
assert "X-API-Key" in r.json()["error"]
@needs_key
def test_wrong_key_rejected(url, samples):
"""Граница доступа: неверный ключ — тот же 401, без различения «нет/неверен»."""
r = requests.post(
url(CONVERT),
headers={"X-API-Key": "wrong-key-000"},
files={"file": ("en-plain.docx", (samples / "en-plain.docx").read_bytes())},
timeout=TIMEOUT,
)
assert r.status_code == 401
@needs_key
def test_convert_returns_pdf(url, samples, key_header):
"""Основной путь: .docx → PDF-аттачмент с ASCII-именем в filename*."""
r = requests.post(
url(CONVERT),
headers=key_header,
files={"file": ("en-plain.docx", (samples / "en-plain.docx").read_bytes())},
timeout=TIMEOUT,
)
assert r.status_code == 200
assert "application/pdf" in r.headers["content-type"]
assert r.content[:4] == b"%PDF"
disp = r.headers["content-disposition"]
assert "attachment" in disp
assert "filename*=UTF-8''en-plain.pdf" in disp
@needs_key
def test_convert_cyrillic_filename_rfc5987(url, samples, key_header):
"""Кириллическое имя части → RFC 5987 filename* (safeBaseName), заголовок не режется наружным nginx.
Если стенд вернёт filename*=UTF-8''document.pdf — Tomcat не раскодировал
UTF-8 имя части (имя теряется на стенде); тогда ассерт фиксирует фактическое значение.
"""
r = requests.post(
url(CONVERT),
headers=key_header,
files={"file": ("тест документ.docx", (samples / "en-plain.docx").read_bytes())},
timeout=TIMEOUT,
)
assert r.status_code == 200
assert (
"filename*=UTF-8''%D1%82%D0%B5%D1%81%D1%82%20"
"%D0%B4%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82.pdf"
in r.headers["content-disposition"]
)
@needs_key
def test_too_many_pages_vs_limit(url, samples, key_header, max_pages):
"""too-many-pages.docx (151 стр.): сверх лимита стенда — 400 до рендера; ниже лимита — конвертится.
Лимит страниц — конфигурация сервера (env WORDPDF_MAX_PAGES), не константа
набора: прод идёт со 1000, там фикстура — валидный вход; 400-ветка покрыта
Java-регрессией WordPdfConverterTest#staleCachePageCountRejectedBeforeRender.
"""
r = requests.post(
url(CONVERT),
headers=key_header,
files={"file": ("too-many-pages.docx", (samples / "too-many-pages.docx").read_bytes())},
timeout=TIMEOUT,
)
if max_pages < 151:
assert r.status_code == 400
assert "error" in r.json()
else:
assert r.status_code == 200
assert r.content[:4] == b"%PDF"
@needs_key
def test_stale_cache_vs_limit(url, samples, key_header, max_pages):
"""stale-cache.docx (кэш <Pages>1 + 110 lastRenderedPageBreak = 111 стр.): валидатор считает разрывы, не кэш.
Сверх лимита — 400 (заниженный кэш не спасает), ниже лимита — 200;
ветки те же, что у test_too_many_pages_vs_limit.
"""
r = requests.post(
url(CONVERT),
headers=key_header,
files={"file": ("stale-cache.docx", (samples / "stale-cache.docx").read_bytes())},
timeout=TIMEOUT,
)
if max_pages < 111:
assert r.status_code == 400
assert "error" in r.json()
else:
assert r.status_code == 200
assert r.content[:4] == b"%PDF"
@needs_key
def test_not_a_zip_rejected(url, notzip_docx, key_header):
"""Граница «сломанный контейнер → 400, а не 500»: .docx-суффикс, содержимое — мусор."""
r = requests.post(
url(CONVERT),
headers=key_header,
files={"file": (notzip_docx.name, notzip_docx.read_bytes())},
timeout=TIMEOUT,
)
assert r.status_code == 400
assert "error" in r.json()
@needs_key
def test_wrong_extension_rejected(url, samples, key_header):
"""Расширение проверяет контроллер (ядро байтов его не видит) — регрессия nonDocxFilename_rejected."""
r = requests.post(
url(CONVERT),
headers=key_header,
files={"file": ("file.txt", (samples / "en-plain.docx").read_bytes())},
timeout=TIMEOUT,
)
assert r.status_code == 400
assert ".docx" in r.json()["error"]
@needs_key
def test_empty_file_rejected(url, key_header):
"""Пустая часть — некорректный вход (400), а не ошибка рендера."""
r = requests.post(
url(CONVERT),
headers=key_header,
files={"file": ("empty.docx", b"")},
timeout=TIMEOUT,
)
assert r.status_code == 400
assert "error" in r.json()
@needs_key
def test_missing_part_rejected(url, key_header):
"""Партиты `file` нет в multipart — 400 от MissingServletRequestPartException."""
r = requests.post(
url(CONVERT),
headers=key_header,
files={"junk": ("x", b"1")},
timeout=TIMEOUT,
)
assert r.status_code == 400
assert "file" in r.json()["error"]
@needs_key
def test_unknown_path_not_found(url, key_header):
"""Неизвестный путь под ключом — 404 JSON, а не 500 (regression unknownPath_notFound)."""
r = requests.get(url("/api/v1/nope"), headers=key_header, timeout=TIMEOUT)
assert r.status_code == 404
assert "error" in r.json()
@needs_key
def test_error_on_charts_rejected(url, samples, key_header):
"""errorOnCharts при выключенном renderCharts — 422 (DrawingRejectedException); render-флаг приоритетнее."""
r = requests.post(
url(CONVERT) + "?errorOnCharts=true&renderCharts=false",
headers=key_header,
files={"file": ("charts-smartart.docx", (samples / "charts-smartart.docx").read_bytes())},
timeout=TIMEOUT,
)
assert r.status_code == 422
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."""
r = requests.post(
url(CONVERT),
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"
+1 -1
View File
@@ -41,7 +41,7 @@
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId> <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
</dependency> </dependency>
<!-- /actuator/health — open-эндпоинт для Docker HEALTHCHECK --> <!-- /actuator/health — open-эндпоинт для HEALTHCHECK контейнера -->
<dependency> <dependency>
<groupId>org.springframework.boot</groupId> <groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId> <artifactId>spring-boot-starter-actuator</artifactId>
@@ -10,19 +10,21 @@ import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.multipart.MaxUploadSizeExceededException; import org.springframework.web.multipart.MaxUploadSizeExceededException;
import org.springframework.web.multipart.support.MissingServletRequestPartException; import org.springframework.web.multipart.support.MissingServletRequestPartException;
import org.springframework.web.servlet.resource.NoResourceFoundException; import org.springframework.web.servlet.resource.NoResourceFoundException;
import ru.pjandro.wordpdf.ValidationException;
/** /**
* Единый перевод исключений в JSON {@code {"error": "..."}} с кодом по смыслу. * Единый перевод исключений в JSON {@code {"error": "..."}} с кодом по смыслу.
* *
* <p>Голый {@code ru.pjandro.wordpdf.ConversionException} ядра сюда не доходит: * <p>{@link ValidationException} ядра доходит сюда напрямую — валидатор
* контроллер и {@link ConversionService} превращают его на границе в * бросает его сам; в {@link ConversionFailedException} превращается только
* {@link ValidationException}/{@link ConversionFailedException}; случайная * прочий {@code ru.pjandro.wordpdf.ConversionException} рендер-стадии.
* утечка попадёт в обработчик {@link Exception} (500).</p> * Случайная утечка прочего исключения попадёт в обработчик {@link Exception}
* (500).</p>
*/ */
@RestControllerAdvice @RestControllerAdvice
final class ApiExceptionHandler { final class ApiExceptionHandler {
private static final Logger log = LoggerFactory.getLogger(ApiExceptionHandler.class); private static final Logger LOG = LoggerFactory.getLogger(ApiExceptionHandler.class);
/** Тело ответа ошибки; Jackson сериализует record как есть. */ /** Тело ответа ошибки; Jackson сериализует record как есть. */
record ApiError(String error) { record ApiError(String error) {
@@ -97,7 +99,7 @@ final class ApiExceptionHandler {
/** Прочее — внутренняя ошибка; подробность только в лог, не в ответ. */ /** Прочее — внутренняя ошибка; подробность только в лог, не в ответ. */
@ExceptionHandler(Exception.class) @ExceptionHandler(Exception.class)
ResponseEntity<ApiError> unexpected(Exception e) { ResponseEntity<ApiError> unexpected(Exception e) {
log.error("Необработанное исключение в API", e); LOG.error("Необработанное исключение в API", e);
return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR) return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR)
.body(new ApiError("Внутренняя ошибка конвертации")); .body(new ApiError("Внутренняя ошибка конвертации"));
} }
@@ -15,7 +15,7 @@ import java.security.MessageDigest;
/** /**
* Единственная граница доступа: заголовок {@value #HEADER} обязан совпадать с * Единственная граница доступа: заголовок {@value #HEADER} обязан совпадать с
* {@code wordpdf.api-key}. Пустое свойство = фильтрация выключена (dev/тесты). * {@code wordpdf.api-key}. Пустое свойство = фильтрация выключена (dev/тесты).
* Наружу без ключа открыты {@code /actuator/**} (им дышит Docker HEALTHCHECK) * Наружу без ключа открыты {@code /actuator/**} (им дышит HEALTHCHECK контейнера)
* и документация springdoc ({@code /swagger-ui*}, {@code /v3/api-docs*}) — * и документация springdoc ({@code /swagger-ui*}, {@code /v3/api-docs*}) —
* браузер не может положить ключ в заголовок при загрузке UI; ключ обязателен * браузер не может положить ключ в заголовок при загрузке UI; ключ обязателен
* для всего остального (фактически {@code /api/**}). Ответ 401 пишется здесь же, * для всего остального (фактически {@code /api/**}). Ответ 401 пишется здесь же,
@@ -30,7 +30,7 @@ final class ApiKeyFilter extends OncePerRequestFilter {
static final String HEADER = "X-API-Key"; static final String HEADER = "X-API-Key";
/** Открытые пути без ключа: actuator (Docker HEALTHCHECK) и springdoc-документация. */ /** Открытые пути без ключа: actuator (HEALTHCHECK контейнера) и springdoc-документация. */
private static final String[] OPEN_PREFIXES = {"/actuator/", "/swagger-ui", "/v3/api-docs"}; private static final String[] OPEN_PREFIXES = {"/actuator/", "/swagger-ui", "/v3/api-docs"};
/** null — аутентификация выключена. */ /** null — аутентификация выключена. */
@@ -66,7 +66,7 @@ final class ApiKeyFilter extends OncePerRequestFilter {
* Путь приложения без forwarded-префикса: при * Путь приложения без forwarded-префикса: при
* server.forward-headers-strategy=framework заголовок X-Forwarded-Prefix * server.forward-headers-strategy=framework заголовок X-Forwarded-Prefix
* становится contextPath, и getRequestURI() возвращает URI уже с ним — * становится contextPath, и getRequestURI() возвращает URI уже с ним —
* матч по сырому URI теряет /actuator/ (Docker HEALTHCHECK получил бы 401). * матч по сырому URI теряет /actuator/ (HEALTHCHECK контейнера получил бы 401).
*/ */
private static String path(HttpServletRequest request) { private static String path(HttpServletRequest request) {
return request.getRequestURI().substring(request.getContextPath().length()); return request.getRequestURI().substring(request.getContextPath().length());
@@ -4,8 +4,9 @@ package ru.pjandro.wordpdf.app;
* Ошибка преобразования: контейнер .docx принят валидацией, но упал сам * Ошибка преобразования: контейнер .docx принят валидацией, но упал сам
* рендер (ядро, FOP, повреждённое содержимое внутри валидного zip). * рендер (ядро, FOP, повреждённое содержимое внутри валидного zip).
* *
* <p>Смысл отличается от {@link ValidationException}: вход формально корректен, * <p>Смысл отличается от {@code ru.pjandro.wordpdf.ValidationException}:
* отказал движок конвертации. Маппится в HTTP 500 ({@link ApiExceptionHandler}).</p> * вход формально корректен, отказал движок конвертации.
* Маппится в HTTP 500 ({@link ApiExceptionHandler}).</p>
* *
* <p>Регрессия — ConvertControllerTest#junkInsideValidZip_conversionError.</p> * <p>Регрессия — ConvertControllerTest#junkInsideValidZip_conversionError.</p>
*/ */
@@ -8,6 +8,7 @@ import ru.pjandro.wordpdf.ConversionException;
import ru.pjandro.wordpdf.DrawingFoundException; import ru.pjandro.wordpdf.DrawingFoundException;
import ru.pjandro.wordpdf.WordPdfConverter; import ru.pjandro.wordpdf.WordPdfConverter;
import ru.pjandro.wordpdf.WordPdfValidator; import ru.pjandro.wordpdf.WordPdfValidator;
import ru.pjandro.wordpdf.ValidationException;
import java.time.Duration; import java.time.Duration;
import java.util.Locale; import java.util.Locale;
@@ -34,9 +35,10 @@ import java.util.concurrent.TimeoutException;
* {@link ValidationException} (400), ошибка рендер-стадии → * {@link ValidationException} (400), ошибка рендер-стадии →
* {@link ConversionFailedException} (500). Граница: сломанный контейнер * {@link ConversionFailedException} (500). Граница: сломанный контейнер
* (не zip / битый zip / слишком большой / слишком длинный) — 400; валидный * (не zip / битый zip / слишком большой / слишком длинный) — 400; валидный
* zip с мусором внутри (нет {@code word/document.xml}) — 500: lightweight- * zip с мусором внутри (нет {@code word/document.xml}) — 500: до очереди и
* подсчёт страниц согласован с JAXB-путём ядра (может только завышать), * в конвейере ядра вход проверяется тем же
* поэтому уже принятый запрос внутренняя проверка ядра в ошибку не превратит.</p> * {@link WordPdfValidator#validate(byte[], ConvertOptions)}, поэтому уже
* принятый запрос внутренняя проверка ядра в ошибку не превратит.</p>
*/ */
@Service @Service
final class ConversionService { final class ConversionService {
@@ -68,7 +70,7 @@ final class ConversionService {
* {@code null} не допускается (контроллер строит всегда).</p> * {@code null} не допускается (контроллер строит всегда).</p>
*/ */
byte[] convert(byte[] docxBytes, String originalFilename, ConvertOptions options) { byte[] convert(byte[] docxBytes, String originalFilename, ConvertOptions options) {
validate(docxBytes, options); WordPdfValidator.validate(docxBytes, options);
Future<byte[]> future; Future<byte[]> future;
try { try {
future = workers.submit(() -> doConvert(docxBytes, originalFilename, options)); future = workers.submit(() -> doConvert(docxBytes, originalFilename, options));
@@ -111,36 +113,7 @@ final class ConversionService {
} }
/** /**
* Валидация байтов переиспользует публичные byte-API ядра. Порядок значим:
* размер (дешёвая) → magic bytes → lightweight-разбор zip. Лимиты
* размера/страниц берутся из {@code options} (контроллер подставляет их
* из конфигурации сервера: свойства {@code wordpdf.max-bytes}/
* {@code wordpdf.max-pages}, дефолт — константы ядра).
*
* <p>Проверка zip-подписи отдельным шагом обязательна:
* {@code ZipInputStream.getNextEntry()} на не-zip-потоке возвращает
* {@code null} молча, и {@link WordPdfValidator#checkPageCountLightweight(byte[])}
* такой вход не отверг бы (0 страниц). Регрессия —
* ConvertControllerTest#corruptNotAZip_rejected.</p>
*/
void validate(byte[] docxBytes, ConvertOptions options) {
try {
WordPdfValidator.checkInput(docxBytes, options.maxBytes());
} catch (ConversionException e) {
throw new ValidationException(e.getMessage(), e);
}
if (docxBytes.length < 4 || docxBytes[0] != 'P' || docxBytes[1] != 'K'
|| (docxBytes[2] & 0xFF) != 0x03 || (docxBytes[3] & 0xFF) != 0x04) {
throw new ValidationException("Содержимое не похоже на .docx (не zip-архив)");
}
try {
WordPdfValidator.checkPageCountLightweight(docxBytes, options.maxPages());
} catch (ConversionException e) {
throw new ValidationException(e.getMessage(), e);
}
}
/**
* Тело задачи воркера. Ядро принимает байты — временные файлы не нужны; * Тело задачи воркера. Ядро принимает байты — временные файлы не нужны;
* имя влияет только на заголовок PDF (параметр {@code title}), потому * имя влияет только на заголовок PDF (параметр {@code title}), потому
* санитизировано. * санитизировано.
@@ -149,6 +122,10 @@ final class ConversionService {
try { try {
// заголовок PDF — санитизированный base исходного имени // заголовок PDF — санитизированный base исходного имени
return WordPdfConverter.convert(docxBytes, safeBaseName(originalFilename), options); return WordPdfConverter.convert(docxBytes, safeBaseName(originalFilename), options);
} catch (ValidationException e) {
// отказ проверки страниц внутри конвейера ядра — некорректный
// вход (400), а не ошибка рендера: без этого утонул бы в 500
throw e;
} catch (DrawingFoundException e) { } catch (DrawingFoundException e) {
// отказ по настройке запроса (error-флаг) — не ошибка рендера: 422, // отказ по настройке запроса (error-флаг) — не ошибка рендера: 422,
// иначе утонет в общем catch ниже как 500 // иначе утонет в общем catch ниже как 500
@@ -163,7 +140,7 @@ final class ConversionService {
/** /**
* Санитизация имени (единый источник для имени файла и Content-Disposition): * Санитизация имени (единый источник для имени файла и Content-Disposition):
* без каталога, только буквы/цифры/пробел/ {@code . _ -}, без суффикса * без каталога, только буквы/цифры/пробел/ {@code . _ -}, без суффикса
* .docx; пустое после очистки → {@code document}. Кириллица разрешена — * .docx/.doc; пустое после очистки → {@code document}. Кириллица разрешена —
* на Linux это валидное имя файла, и заголовок PDF остаётся читаемым. * на Linux это валидное имя файла, и заголовок PDF остаётся читаемым.
*/ */
static String safeBaseName(String original) { static String safeBaseName(String original) {
@@ -171,8 +148,11 @@ final class ConversionService {
: original.substring(Math.max(original.lastIndexOf('/'), : original.substring(Math.max(original.lastIndexOf('/'),
original.lastIndexOf('\\')) + 1); original.lastIndexOf('\\')) + 1);
base = base.replaceAll("[^\\p{L}\\p{N} ._-]", ""); base = base.replaceAll("[^\\p{L}\\p{N} ._-]", "");
if (base.toLowerCase(Locale.ROOT).endsWith(".docx")) { String lower = base.toLowerCase(Locale.ROOT);
base = base.substring(0, base.length() - ".docx".length()); String suffix = lower.endsWith(".docx") ? ".docx"
: lower.endsWith(".doc") ? ".doc" : null;
if (suffix != null) {
base = base.substring(0, base.length() - suffix.length());
} }
if (base.isBlank()) { if (base.isBlank()) {
base = "document"; base = "document";
@@ -12,7 +12,9 @@ import org.springframework.web.bind.annotation.RestController;
import org.springframework.beans.factory.annotation.Value; import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.multipart.MultipartFile; import org.springframework.web.multipart.MultipartFile;
import ru.pjandro.wordpdf.ConvertOptions; import ru.pjandro.wordpdf.ConvertOptions;
import ru.pjandro.wordpdf.WordPdfValidator;
import ru.pjandro.wordpdf.WordPdfSettings; import ru.pjandro.wordpdf.WordPdfSettings;
import ru.pjandro.wordpdf.ValidationException;
import java.io.IOException; import java.io.IOException;
import java.nio.charset.StandardCharsets; import java.nio.charset.StandardCharsets;
@@ -20,11 +22,12 @@ import java.util.Locale;
/** /**
* Единственный эндпоинт API: {@code POST /api/v1/convert} — multipart-поле * Единственный эндпоинт API: {@code POST /api/v1/convert} — multipart-поле
* {@code file} (.docx) → синхронный ответ байтами PDF. * {@code file} (.docx или бинарный .doc) → синхронный ответ байтами PDF.
* *
* <p>Здесь только HTTP-слой: проверка presence/расширения и формирование * <p>Здесь только HTTP-слой: проверка presence/расширения и формирование
* {@code Content-Disposition}; проверка содержимого (zip, размер, страницы) — * {@code Content-Disposition}; проверка содержимого (подпись контейнера
* зона {@link ConversionService#validate}. Ошибки в JSON-ответ переводит * zip/OLE2, размер, страницы) — зона {@link WordPdfValidator#validate(byte[], ConvertOptions)}.
* Ошибки в JSON-ответ переводит
* {@link ApiExceptionHandler}. Лимиты входа — только конфигурация сервера * {@link ApiExceptionHandler}. Лимиты входа — только конфигурация сервера
* (свойства {@code wordpdf.max-bytes}/{@code wordpdf.max-pages}, env * (свойства {@code wordpdf.max-bytes}/{@code wordpdf.max-pages}, env
* {@code WORDPDF_MAX_BYTES}/{@code WORDPDF_MAX_PAGES}); параметрами запроса * {@code WORDPDF_MAX_BYTES}/{@code WORDPDF_MAX_PAGES}); параметрами запроса
@@ -57,11 +60,14 @@ final class ConvertController {
this.maxPages = maxPages; this.maxPages = maxPages;
} }
@Operation(summary = "Конвертировать .docx в PDF", @Operation(summary = "Конвертировать .docx или .doc в PDF",
description = "renderCharts/renderSmartArt/errorOnCharts/errorOnSmartArt — факультативно, " description = "renderCharts/renderSmartArt/errorOnCharts/errorOnSmartArt — факультативно, "
+ "по умолчанию настройки ядра; render-флаг приоритетнее error-флага. " + "по умолчанию настройки ядра; render-флаг приоритетнее error-флага. "
+ "Лимиты входа (размер/страницы) задаёт только конфигурация сервера " + "Лимиты входа (размер/страницы) задаёт только конфигурация сервера "
+ "(свойства wordpdf.max-bytes/wordpdf.max-pages), параметрами запроса не переопределяются") + "(свойства wordpdf.max-bytes/wordpdf.max-pages), параметрами запроса не переопределяются. "
+ ".doc (Word 97-2003) конвертируется с деградацией вёрстки: шрифты — аналоги из бандла, "
+ "колонтитулы переносятся, диаграммы — как встроенные превью-изображения; "
+ "renderCharts/renderSmartArt/errorOn* на .doc не влияют")
@SecurityRequirement(name = OpenApiConfig.SCHEME) @SecurityRequirement(name = OpenApiConfig.SCHEME)
@PostMapping( @PostMapping(
path = "/api/v1/convert", path = "/api/v1/convert",
@@ -77,9 +83,10 @@ final class ConvertController {
throw new ValidationException("Файл не передан (multipart-поле «file» обязательно)"); throw new ValidationException("Файл не передан (multipart-поле «file» обязательно)");
} }
String name = file.getOriginalFilename(); String name = file.getOriginalFilename();
if (name == null || !name.toLowerCase(Locale.ROOT).endsWith(".docx")) { if (name == null || !(name.toLowerCase(Locale.ROOT).endsWith(".docx")
|| name.toLowerCase(Locale.ROOT).endsWith(".doc"))) {
// расширение проверяется здесь: ядро с байтов его не видит // расширение проверяется здесь: ядро с байтов его не видит
throw new ValidationException("Поддерживается только .docx (без .doc): " + name); throw new ValidationException("Поддерживаются только .docx и .doc: " + name);
} }
byte[] docxBytes; byte[] docxBytes;
try { try {
@@ -97,9 +104,15 @@ final class ConvertController {
ContentDisposition disposition = ContentDisposition.attachment() ContentDisposition disposition = ContentDisposition.attachment()
.filename(ConversionService.safeBaseName(name) + ".pdf", StandardCharsets.UTF_8) .filename(ConversionService.safeBaseName(name) + ".pdf", StandardCharsets.UTF_8)
.build(); .build();
return ResponseEntity.ok() ResponseEntity.BodyBuilder response = ResponseEntity.ok()
.contentType(MediaType.APPLICATION_PDF) .contentType(MediaType.APPLICATION_PDF)
.header(HttpHeaders.CONTENT_DISPOSITION, disposition.toString()) .header(HttpHeaders.CONTENT_DISPOSITION, disposition.toString());
.body(pdf); if (name.toLowerCase(Locale.ROOT).endsWith(".doc")) {
// .doc (не .docx): POI HWPF даёт дрейф вёрстки, колонтитулы —
// инъекция в FO-DOM, экзотические глифы остаются .notdef —
// клиент обязан знать о деградации (см. internal.DocToPdfRenderer).
response = response.header("X-Wordpdf-Degraded", "headers-footers-exotic-glyphs");
}
return response.body(pdf);
} }
} }
@@ -1,23 +0,0 @@
package ru.pjandro.wordpdf.app;
/**
* Некорректный вход: пустой файл, не .docx, не zip-архив, размер или число
* страниц сверх переданных в запросе (или дефолтных) лимитов.
*
* <p>Отличается от {@link ConversionFailedException} смыслом: запрос
* некорректен сам по себе, повтор его же ничего не изменит. Маппится в HTTP 400
* ({@link ApiExceptionHandler}).</p>
*
* <p>Регрессия — ConvertControllerTest#nonDocxFilename_rejected,
* #oversizedOverCoreLimit_rejected, #corruptNotAZip_rejected.</p>
*/
class ValidationException extends RuntimeException {
ValidationException(String message) {
super(message);
}
ValidationException(String message, Throwable cause) {
super(message, cause);
}
}
@@ -2,9 +2,9 @@ spring.application.name=wordpdf-app
# Потолок инфраструктуры — 100 МБ (совпадает с client_max_body_size в # Потолок инфраструктуры — 100 МБ (совпадает с client_max_body_size в
# nginx-шлюзах): больше не пропустит ни шлюз, ни контейнер. Авторитетный # nginx-шлюзах): больше не пропустит ни шлюз, ни контейнер. Авторитетный
# лимит — свойство wordpdf.max-bytes (env WORDPDF_MAX_BYTES), по умолчанию # лимит — свойство wordpdf.max-bytes (env WORDPDF_MAX_BYTES), по умолчанию
# WordPdfSettings.MAX_INPUT_BYTES = 20 MiB; здесь только потолок загрузки. # WordPdfSettings.MAX_INPUT_BYTES = 5 MiB; здесь только потолок загрузки.
# Лимиты входа: env WORDPDF_MAX_BYTES (байты) / WORDPDF_MAX_PAGES (страницы), # Лимиты входа: env WORDPDF_MAX_BYTES (байты) / WORDPDF_MAX_PAGES (страницы),
# дефолты — константы ядра (20 MiB / 1000), задаются ConvertController. # дефолты — константы ядра (5 MiB / 100), задаются ConvertController.
# Значение <= 0 — падение на старте. Сами ключи здесь не объявлены: # Значение <= 0 — падение на старте. Сами ключи здесь не объявлены:
# пустое значение затенит SpEL-дефолт @Value. # пустое значение затенит SpEL-дефолт @Value.
# file-size-threshold=100MB держит файл в памяти (ядро и так читает всё в RAM). # file-size-threshold=100MB держит файл в памяти (ядро и так читает всё в RAM).
@@ -15,7 +15,7 @@ spring.servlet.multipart.file-size-threshold=100MB
wordpdf.convert-timeout=2m wordpdf.convert-timeout=2m
# Ключ доступа (заголовок X-API-Key). Пусто = аутентификация выключена # Ключ доступа (заголовок X-API-Key). Пусто = аутентификация выключена
# (dev: java -jar / тесты). В docker-compose задан ${WORDPDF_API_KEY:?} — fail-closed. # (dev: java -jar / тесты). В compose.yml задан ${WORDPDF_API_KEY:?} — fail-closed.
wordpdf.api-key= wordpdf.api-key=
# Работа за префикс-срезающим прокси (прод: наружный nginx срезает # Работа за префикс-срезающим прокси (прод: наружный nginx срезает
@@ -75,13 +75,13 @@ class ApiKeyFilterTest {
.andExpect(status().isOk()) .andExpect(status().isOk())
.andReturn(); .andReturn();
byte[] pdf = result.getResponse().getContentAsByteArray(); byte[] pdf = result.getResponse().getContentAsByteArray();
assertTrue(new String(pdf, 0, 4, StandardCharsets.US_ASCII).equals("%PDF"), assertTrue("%PDF".equals(new String(pdf, 0, 4, StandardCharsets.US_ASCII)),
"ответ не PDF"); "ответ не PDF");
} }
@Test @Test
void healthOpenWithoutKey() throws Exception { void healthOpenWithoutKey() throws Exception {
// Docker HEALTHCHECK дышит /actuator/** без ключа — иначе контейнер // HEALTHCHECK контейнера дышит /actuator/** без ключа — иначе контейнер
// никогда не станет healthy // никогда не станет healthy
mockMvc.perform(get("/actuator/health")) mockMvc.perform(get("/actuator/health"))
.andExpect(status().isOk()); .andExpect(status().isOk());
@@ -113,9 +113,10 @@ class ConvertControllerTest {
.andExpect(content().contentType(MediaType.APPLICATION_PDF)) .andExpect(content().contentType(MediaType.APPLICATION_PDF))
.andExpect(header().string(HttpHeaders.CONTENT_DISPOSITION, .andExpect(header().string(HttpHeaders.CONTENT_DISPOSITION,
org.hamcrest.Matchers.containsString("filename*=UTF-8''ru-plain.pdf"))) org.hamcrest.Matchers.containsString("filename*=UTF-8''ru-plain.pdf")))
.andExpect(header().doesNotExist("X-Wordpdf-Degraded"))
.andReturn(); .andReturn();
byte[] pdf = result.getResponse().getContentAsByteArray(); byte[] pdf = result.getResponse().getContentAsByteArray();
assertTrue(new String(pdf, 0, 4, StandardCharsets.US_ASCII).equals("%PDF"), assertTrue("%PDF".equals(new String(pdf, 0, 4, StandardCharsets.US_ASCII)),
"тело не начинается с %PDF"); "тело не начинается с %PDF");
String text = norm(pdfText(pdf)); String text = norm(pdfText(pdf));
assertTrue(text.contains("Привет, мир!"), "нет «Привет, мир!»: " + text); assertTrue(text.contains("Привет, мир!"), "нет «Привет, мир!»: " + text);
@@ -252,14 +253,14 @@ class ConvertControllerTest {
@Test @Test
void oversizedOverCoreLimit_rejected() throws Exception { void oversizedOverCoreLimit_rejected() throws Exception {
// 20 MiB + 1 байт: проходит контейнерный multipart-лимит (100 МБ) // 5 MiB + 1 байт: проходит контейнерный multipart-лимит (100 МБ)
// и отсекается валидацией ядра до очереди (дефолт ядра цел — // и отсекается валидацией ядра до очереди (дефолт ядра цел —
// лимит задаёт только конфигурация сервера) // лимит задаёт только конфигурация сервера)
byte[] big = new byte[20 * 1024 * 1024 + 1]; byte[] big = new byte[5 * 1024 * 1024 + 1];
mockMvc.perform(multipart("/api/v1/convert").file(docx("big.docx", big))) mockMvc.perform(multipart("/api/v1/convert").file(docx("big.docx", big)))
.andExpect(status().isBadRequest()) .andExpect(status().isBadRequest())
.andExpect(jsonPath("$.error", .andExpect(jsonPath("$.error",
org.hamcrest.Matchers.containsString("больше 20 МБ"))); org.hamcrest.Matchers.containsString("больше 5 МБ")));
} }
/** /**
@@ -308,7 +309,7 @@ class ConvertControllerTest {
.andExpect(status().isOk()) .andExpect(status().isOk())
.andReturn(); .andReturn();
byte[] pdf = r.getResponse().getContentAsByteArray(); byte[] pdf = r.getResponse().getContentAsByteArray();
assertTrue(new String(pdf, 0, 4, StandardCharsets.US_ASCII).equals("%PDF"), assertTrue("%PDF".equals(new String(pdf, 0, 4, StandardCharsets.US_ASCII)),
"ответ не PDF"); "ответ не PDF");
} catch (Exception e) { } catch (Exception e) {
throw new IllegalStateException(e); throw new IllegalStateException(e);
@@ -326,14 +327,40 @@ class ConvertControllerTest {
@Test @Test
void corruptNotAZip_rejected() throws Exception { void corruptNotAZip_rejected() throws Exception {
// без zip-подписи ZipInputStream молча даёт 0 записей — отсекает // без подписи контейнера (zip для .docx, OLE2 для .doc) лёгкий
// отдельная проверка magic bytes // счётчик страниц молчит — отсекает отдельная проверка magic bytes
mockMvc.perform(multipart("/api/v1/convert") mockMvc.perform(multipart("/api/v1/convert")
.file(docx("broken.docx", "это просто текст, не архив" .file(docx("broken.docx", "это просто текст, не архив"
.getBytes(StandardCharsets.UTF_8)))) .getBytes(StandardCharsets.UTF_8))))
.andExpect(status().isBadRequest()) .andExpect(status().isBadRequest())
.andExpect(jsonPath("$.error", .andExpect(jsonPath("$.error",
org.hamcrest.Matchers.containsString("не zip-архив"))); org.hamcrest.Matchers.containsString("не похоже на .docx или .doc")));
}
/**
* Бинарный .doc проходит тот же эндпоинт: расширение принято, ядро
* выбирает POI-ветку по OLE2-магику, ответ несёт заголовок деградации
* X-Wordpdf-Degraded (контракт AGENTS.md); у .docx его нет.
* Регрессия — ConvertController (расширения + заголовок) +
* ConversionService#validate (магик), фикстура /samples/legacy-doc.doc
* (test-jar core).
*/
@Test
void legacyDoc_convertsToPdf() throws Exception {
MvcResult result = mockMvc.perform(multipart("/api/v1/convert")
.file(docx("testDoc.doc", bytes("/samples/legacy-doc.doc"))))
.andExpect(status().isOk())
.andExpect(content().contentType(MediaType.APPLICATION_PDF))
.andExpect(header().string(HttpHeaders.CONTENT_DISPOSITION,
org.hamcrest.Matchers.containsString("filename*=UTF-8''testDoc.pdf")))
.andExpect(header().string("X-Wordpdf-Degraded",
"headers-footers-exotic-glyphs"))
.andReturn();
byte[] pdf = result.getResponse().getContentAsByteArray();
assertTrue("%PDF".equals(new String(pdf, 0, 4, StandardCharsets.US_ASCII)),
"тело не начинается с %PDF");
String text = norm(pdfText(pdf));
assertTrue(text.contains("Нижний колонтитул"), "нет колонтитула: " + text);
} }
@Test @Test
@@ -12,7 +12,6 @@ import org.springframework.test.web.servlet.MockMvc;
import java.io.ByteArrayOutputStream; import java.io.ByteArrayOutputStream;
import java.io.IOException; import java.io.IOException;
import java.io.InputStream; import java.io.InputStream;
import java.nio.charset.StandardCharsets;
import java.util.Random; import java.util.Random;
import java.util.zip.ZipEntry; import java.util.zip.ZipEntry;
import java.util.zip.ZipOutputStream; import java.util.zip.ZipOutputStream;
+7
View File
@@ -37,6 +37,13 @@
<artifactId>slf4j-simple</artifactId> <artifactId>slf4j-simple</artifactId>
</dependency> </dependency>
<!-- Apache POI HWPF: чтение бинарных .doc (Word 97-2003) и экспорт
HWPF->XSL-FO (WordToFoConverter) для ветки .doc. -->
<dependency>
<groupId>org.apache.poi</groupId>
<artifactId>poi-scratchpad</artifactId>
</dependency>
<!-- ============ Тесты ============ --> <!-- ============ Тесты ============ -->
<dependency> <dependency>
<groupId>org.junit.jupiter</groupId> <groupId>org.junit.jupiter</groupId>
@@ -0,0 +1,22 @@
package ru.pjandro.wordpdf;
/**
* Некорректный вход: {@code null}-байты, размер или число страниц сверх
* лимитов, неразбираемый .docx-контейнер (не zip / битый XML).
*
* <p>Отличается от прочего {@link ConversionException} смыслом: вход плох сам
* по себе, повтор с теми же байтами ничего не изменит. Наследник
* {@code ConversionException} — наружу по-прежнему ловится только он
* (в т.ч. из {@link WordPdfConverter}, который вызывает валидатор сам).
* Регрессия — WordPdfValidatorTest, ConvertControllerTest#corruptNotAZip_rejected.</p>
*/
public class ValidationException extends ConversionException {
public ValidationException(String message) {
super(message);
}
public ValidationException(String message, Throwable cause) {
super(message, cause);
}
}
@@ -16,6 +16,7 @@ import ru.pjandro.wordpdf.internal.FieldNormalizer;
import ru.pjandro.wordpdf.internal.GlyphCoverageNormalizer; import ru.pjandro.wordpdf.internal.GlyphCoverageNormalizer;
import ru.pjandro.wordpdf.internal.FopFallbackFonts; import ru.pjandro.wordpdf.internal.FopFallbackFonts;
import ru.pjandro.wordpdf.internal.StrictOoxmlNormalizer; import ru.pjandro.wordpdf.internal.StrictOoxmlNormalizer;
import ru.pjandro.wordpdf.internal.DocToPdfRenderer;
import ru.pjandro.wordpdf.internal.SymbolFontNormalizer; import ru.pjandro.wordpdf.internal.SymbolFontNormalizer;
import java.io.ByteArrayInputStream; import java.io.ByteArrayInputStream;
@@ -54,19 +55,22 @@ public final class WordPdfConverter {
} }
/** /**
* Конвертирует байты .docx в PDF. Работа с файлами — забота вызывающего * Конвертирует байты .docx (или бинарного .doc Word 97-2003 — ветка
* (файловое API было здесь раньше; ядро пути не принимает). * выбирается по магическому байту контейнера) в PDF. Работа с файлами — забота
* вызывающего (файловое API было здесь раньше; ядро пути не принимает).
* *
* <p>Вход проверяется валидатором до рендера: {@link WordPdfValidator#checkInput(byte[])} * <p>Вход проверяется {@link WordPdfValidator#validate(byte[], ConvertOptions)} до рендера:
* (null / больше {@link WordPdfSettings#MAX_INPUT_BYTES}), затем число страниц * {@code null} / размер больше {@link WordPdfSettings#MAX_INPUT_BYTES} / zip-подпись /
* ({@link WordPdfSettings#MAX_PAGES}) — при отказе байтов результата нет. * число страниц больше {@link WordPdfSettings#MAX_PAGES} — при отказе байтов результата нет;
* страницы дополнительно перепроверяются по нормализованным байтам (шаг 2.5).
* *
* @param docxBytes байты .docx * @param docxBytes байты .docx
* @param title заголовок PDF (метаданные); {@code null}/пустая — заголовок не задаётся * @param title заголовок PDF (метаданные); {@code null}/пустая — заголовок не задаётся
* @return байты готового PDF * @return байты готового PDF
* @throws ConversionException при ошибке (битый .docx, размер больше * @throws ValidationException некорректный вход: {@code null}, размер больше
* {@link WordPdfSettings#MAX_INPUT_BYTES}, результат длиннее * {@link WordPdfSettings#MAX_INPUT_BYTES}, не zip-архив, документ длиннее
* {@link WordPdfSettings#MAX_PAGES} страниц и т.п.) * {@link WordPdfSettings#MAX_PAGES} страниц
* @throws ConversionException прочие ошибки (битый .docx, ошибка рендера)
*/ */
public static byte[] convert(byte[] docxBytes, String title) throws ConversionException { public static byte[] convert(byte[] docxBytes, String title) throws ConversionException {
return convert(docxBytes, title, ConvertOptions.defaults()); return convert(docxBytes, title, ConvertOptions.defaults());
@@ -76,26 +80,30 @@ public final class WordPdfConverter {
* Конвертирует байты .docx в PDF с настройками на вызов: рисование * Конвертирует байты .docx в PDF с настройками на вызов: рисование
* диаграмм/SmartArt и лимиты входа. * диаграмм/SmartArt и лимиты входа.
* *
* <p>Вход проверяется валидатором до рендера: {@link WordPdfValidator#checkInput(byte[], long)} * <p>Вход проверяется {@link WordPdfValidator#validate(byte[], ConvertOptions)} до рендера:
* (null / больше {@code options.maxBytes()}), затем число страниц * {@code null} / размер больше {@code options.maxBytes()} / zip-подпись / число страниц
* ({@code options.maxPages()}) — при отказе байтов результата нет. * больше {@code options.maxPages()} — при отказе байтов результата нет; страницы
* дополнительно перепроверяются по нормализованным байтам (шаг 2.5).
* *
* @param docxBytes байты .docx * @param docxBytes байты .docx
* @param title заголовок PDF (метаданные); {@code null}/пустая — заголовок не задаётся * @param title заголовок PDF (метаданные); {@code null}/пустая — заголовок не задаётся
* @param options рисование и лимиты входа на этот вызов; {@code null} — * @param options рисование и лимиты входа на этот вызов; {@code null} —
* дефолты (константы {@link WordPdfSettings}) * дефолты (константы {@link WordPdfSettings})
* @return байты готового PDF * @return байты готового PDF
* @throws ConversionException при ошибке (битый .docx, размер больше * @throws ValidationException некорректный вход: {@code null}, размер больше
* {@code options.maxBytes()}, результат длиннее * {@code options.maxBytes()}, не zip-архив, документ длиннее
* {@code options.maxPages()} страниц и т.п.) * {@code options.maxPages()} страниц
* @throws ConversionException прочие ошибки (битый .docx, ошибка рендера)
*/ */
public static byte[] convert(byte[] docxBytes, String title, ConvertOptions options) throws ConversionException { public static byte[] convert(byte[] docxBytes, String title, ConvertOptions options) throws ConversionException {
ConvertOptions opts = options == null ? ConvertOptions.defaults() : options; ConvertOptions opts = options == null ? ConvertOptions.defaults() : options;
WordPdfValidator.checkInput(docxBytes, opts.maxBytes()); WordPdfValidator.validate(docxBytes, opts);
ByteArrayOutputStream bos = new ByteArrayOutputStream(); ByteArrayOutputStream bos = new ByteArrayOutputStream();
try { try {
convertToStream(docxBytes, title, opts, bos); convertToStream(docxBytes, title, opts, bos);
} catch (ConversionException e) { } catch (ConversionException e) {
// ValidationException (отказ валидации входа) — подтип, уходит
// вызывающему без обёртки
throw e; throw e;
} catch (Exception e) { } catch (Exception e) {
throw new ConversionException("Не удалось конвертировать документ", e); throw new ConversionException("Не удалось конвертировать документ", e);
@@ -108,6 +116,16 @@ public final class WordPdfConverter {
*/ */
private static void convertToStream(byte[] rawDocxBytes, String title, ConvertOptions options, private static void convertToStream(byte[] rawDocxBytes, String title, ConvertOptions options,
OutputStream os) throws Exception { OutputStream os) throws Exception {
// 0. Бинарный .doc (Word 97-2003, OLE2-контейнер) — отдельная
// ветка: docx4j его не читает, нормализаторы (все — по zip-частям
// docx) тут бессмысленны. Флаги renderCharts/renderSmartArt/
// errorOn* для .doc — no-op: диаграмм как c:chart в .doc нет,
// превью встраиваемых объектов приходят картинками через
// PicturesManager (см. internal/DocToPdfRenderer).
if (isOle2(rawDocxBytes)) {
DocToPdfRenderer.render(rawDocxBytes, title, options, os);
return;
}
// 1. Маппер шрифтов. Порядок важен: конструктор запускает // 1. Маппер шрифтов. Порядок важен: конструктор запускает
// обнаружение системных шрифтов, затем бандл-шрифты из jar // обнаружение системных шрифтов, затем бандл-шрифты из jar
// регистрируются поверх них (имеют приоритет). // регистрируются поверх них (имеют приоритет).
@@ -139,12 +157,13 @@ public final class WordPdfConverter {
WordprocessingMLPackage pkg = WordprocessingMLPackage.load( WordprocessingMLPackage pkg = WordprocessingMLPackage.load(
new ByteArrayInputStream(docxBytes)); new ByteArrayInputStream(docxBytes));
try { try {
// 2.5 Проверка числа страниц по самому .docx: кэш Word // 2.5 Проверка числа страниц по самому .docx: lightweight-оценка
// (docProps/app.xml <Pages>) или нижняя оценка по явным // по zip (кэш docProps/app.xml <Pages>, явные разрывы, маркеры
// разрывам. Делается до рендера, чтобы не тратить время на // w:lastRenderedPageBreak, включая колонтитулы) — без JAXB-модели.
// заведомо длинный документ; внутри try — чтобы и на отказе // Делается до рендера, чтобы не тратить время на заведомо
// отработал finally с чисткой temp-файлов встроенных шрифтов. // длинный документ; внутри try — чтобы и на отказе отработал
WordPdfValidator.checkPageCount(pkg, options.maxPages()); // finally с чисткой temp-файлов встроенных шрифтов.
WordPdfValidator.checkPageCount(docxBytes, options.maxPages());
// 3. Привязка маппера: docx4j сопоставляет шрифты документа // 3. Привязка маппера: docx4j сопоставляет шрифты документа
// с физическими TTF (учитывая и шрифты, встроенные в docx) // с физическими TTF (учитывая и шрифты, встроенные в docx)
pkg.setFontMapper(mapper); pkg.setFontMapper(mapper);
@@ -181,4 +200,13 @@ public final class WordPdfConverter {
// пакет загружается в память и ничего не закрывает. // пакет загружается в память и ничего не закрывает.
} }
} }
/** Магик OLE2 (CFB): {@code D0 CF 11 E0 A1 B1 1A E1} — контейнер .doc. */
private static boolean isOle2(byte[] bytes) {
return bytes != null && bytes.length >= 8
&& (bytes[0] & 0xFF) == 0xD0 && (bytes[1] & 0xFF) == 0xCF
&& (bytes[2] & 0xFF) == 0x11 && (bytes[3] & 0xFF) == 0xE0
&& (bytes[4] & 0xFF) == 0xA1 && (bytes[5] & 0xFF) == 0xB1
&& (bytes[6] & 0xFF) == 0x1A && (bytes[7] & 0xFF) == 0xE1;
}
} }
@@ -9,11 +9,11 @@ package ru.pjandro.wordpdf;
*/ */
public final class WordPdfSettings { public final class WordPdfSettings {
/** Максимальный размер входного .docx (дефолт). 20 MiB = 20 × 1024 × 1024. */ /** Максимальный размер входного .docx (дефолт). 5 MiB = 5 × 1024 × 1024. */
public static final long MAX_INPUT_BYTES = 20L * 1024 * 1024; public static final long MAX_INPUT_BYTES = 5L * 1024 * 1024;
/** Документ длиннее — ошибка (дефолт). */ /** Документ длиннее — ошибка (дефолт). */
public static final int MAX_PAGES = 1000; public static final int MAX_PAGES = 100;
/** /**
* Генерация диаграмм (c:chart → PNG, chart-движок). {@code false} — диаграммы * Генерация диаграмм (c:chart → PNG, chart-движок). {@code false} — диаграммы
@@ -1,15 +1,7 @@
package ru.pjandro.wordpdf; package ru.pjandro.wordpdf;
import org.docx4j.openpackaging.packages.WordprocessingMLPackage; import org.apache.poi.hwpf.HWPFDocument;
import org.docx4j.wml.Br; import org.apache.poi.poifs.filesystem.POIFSFileSystem;
import org.docx4j.wml.ContentAccessor;
import org.docx4j.wml.P;
import org.docx4j.wml.R;
import org.docx4j.wml.SectPr;
import org.docx4j.wml.STBrType;
import jakarta.xml.bind.JAXBElement;
import javax.xml.stream.XMLInputFactory; import javax.xml.stream.XMLInputFactory;
import javax.xml.stream.XMLStreamException; import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamReader; import javax.xml.stream.XMLStreamReader;
@@ -27,9 +19,8 @@ import java.util.zip.ZipInputStream;
* Валидатор ограничений на входной .docx: * Валидатор ограничений на входной .docx:
* размер входа и число страниц. * размер входа и число страниц.
* *
* <p>Вход валидатора — только {@code byte[]} (или уже загруженный * <p>Вход валидатора — только {@code byte[]}: файловых проверок нет,
* {@link WordprocessingMLPackage}): файловых проверок нет, работа с * работа с файлами — забота вызывающего (приложения).
* файлами — забота вызывающего (приложения).
* *
* <p>Конвертер {@link WordPdfConverter} вызывает валидатор автоматически, * <p>Конвертер {@link WordPdfConverter} вызывает валидатор автоматически,
* но им можно пользоваться и напрямую — например, проверить байты * но им можно пользоваться и напрямую — например, проверить байты
@@ -55,7 +46,7 @@ import java.util.zip.ZipInputStream;
* <p>Проверка делается <b>до</b> рендера — это позволяет отсекать слишком * <p>Проверка делается <b>до</b> рендера — это позволяет отсекать слишком
* длинные документы, не тратя время на конвертацию. * длинные документы, не тратя время на конвертацию.
* *
* <p>Все ошибки — {@link ConversionException}. * <p>Все ошибки — {@link ValidationException} (наследник {@link ConversionException}).
*/ */
public final class WordPdfValidator { public final class WordPdfValidator {
@@ -65,9 +56,9 @@ public final class WordPdfValidator {
/** /**
* Проверяет размер байтов входа (для документа, полученного из сети/БД). * Проверяет размер байтов входа (для документа, полученного из сети/БД).
* *
* @throws ConversionException при {@code null} или превышении лимита * @throws ValidationException при {@code null} или превышении лимита
*/ */
public static void checkInput(byte[] docxBytes) throws ConversionException { public static void checkInput(byte[] docxBytes) throws ValidationException {
checkInput(docxBytes, WordPdfSettings.MAX_INPUT_BYTES); checkInput(docxBytes, WordPdfSettings.MAX_INPUT_BYTES);
} }
@@ -75,18 +66,18 @@ public final class WordPdfValidator {
* Проверяет размер байтов входа против явного лимита (переопределение * Проверяет размер байтов входа против явного лимита (переопределение
* на вызов, см. {@link ConvertOptions#maxBytes()}). * на вызов, см. {@link ConvertOptions#maxBytes()}).
* *
* @throws ConversionException при {@code null} или превышении {@code maxBytes} * @throws ValidationException при {@code null} или превышении {@code maxBytes}
*/ */
public static void checkInput(byte[] docxBytes, long maxBytes) throws ConversionException { public static void checkInput(byte[] docxBytes, long maxBytes) throws ValidationException {
if (docxBytes == null) { if (docxBytes == null) {
throw new ConversionException("Не указаны байты входного файла"); throw new ValidationException("Не указаны байты входного файла");
} }
if (docxBytes.length > maxBytes) { if (docxBytes.length > maxBytes) {
// дефолтный лимит кратен MiB — сообщение остаётся «... 20 МБ ...» // дефолтный лимит кратен MiB — сообщение остаётся «... 5 МБ ...»
String limit = maxBytes % (1024 * 1024) == 0 String limit = maxBytes % (1024 * 1024) == 0
? (maxBytes / (1024 * 1024)) + " МБ" ? (maxBytes / (1024 * 1024)) + " МБ"
: maxBytes + " байт"; : maxBytes + " байт";
throw new ConversionException("Файл больше " + limit throw new ValidationException("Файл больше " + limit
+ ": " + docxBytes.length + " байт > " + maxBytes + " байт"); + ": " + docxBytes.length + " байт > " + maxBytes + " байт");
} }
} }
@@ -98,32 +89,41 @@ public final class WordPdfValidator {
* {@code docProps/app.xml}). Дешёвый путь для проверки байтов из * {@code docProps/app.xml}). Дешёвый путь для проверки байтов из
* сети/БД до любой работы с библиотекой. * сети/БД до любой работы с библиотекой.
* *
* <p>Оценка согласована с {@link #checkPageCount(WordprocessingMLPackage)} * <p>Оценка — максимум трёх нижних оценок: кэша Word в
* по всем источникам; на границе лимита оба пути дают одинаковый ответ * {@code docProps/app.xml} ({@code <Pages>}; сам по себе недостоверен —
* (регрессия — {@code checkPageCountLightweight_agreesWithJaxbPath}, * в регрессной фикстуре {@code stale-cache.docx} равен 1 при 110
* включая 99/100/101 разрывов). Lightweight-путь дополнительно считает * границах страниц), явных разрывов ({@code w:br type="page"},
* разрывы в колонтитулах — он консервативнее, расхождение возможно * {@code w:pageBreakBefore}, межсекционные {@code w:sectPr} — абзацы
* ищутся рекурсивно, включая ячейки таблиц и контентные контролы
* {@code w:sdt}) и маркеров {@code w:lastRenderedPageBreak} — границ
* страниц, которые Word записал при последнем рендере. Оценка нижняя:
* документ без явных разрывов и без маркеров (никогда не открывался в
* Word) оценивается в 1 страницу независимо от фактической длины —
* такие документы лимит не отсекают. На границе лимита оценка точна
* (регрессия — {@code checkPageCount_limitBoundary},
* включая 99/100/101 разрывов); путь дополнительно считает разрывы в
* колонтитулах — консервативная нижняя оценка, расхождение возможно
* только в сторону завышения. * только в сторону завышения.
* *
* <p>Не-zip байты не отвергаются: {@code ZipInputStream} доходит до EOF * <p>Не-zip байты не отвергаются: {@code ZipInputStream} доходит до EOF
* без единой записи — молча, оценка «1 страница». Корректность контейнера * без единой записи — молча, оценка «1 страница». Корректность контейнера
* проверяет вызывающий по zip-подписи ({@code ConversionService.validate} * по zip-подписи проверяет {@link #validate(byte[], ConvertOptions)}
* в приложении; регрессия — {@code ConvertControllerTest#corruptNotAZip_rejected}). * (регрессия — {@code WordPdfValidatorTest#validate_notAZip}).
* @throws ConversionException при {@code null}, ошибке разбора zip или превышении {@link WordPdfSettings#MAX_PAGES} * @throws ValidationException при {@code null}, ошибке разбора zip или превышении {@link WordPdfSettings#MAX_PAGES}
*/ */
public static void checkPageCountLightweight(byte[] docxBytes) throws ConversionException { public static void checkPageCount(byte[] docxBytes) throws ValidationException {
checkPageCountLightweight(docxBytes, WordPdfSettings.MAX_PAGES); checkPageCount(docxBytes, WordPdfSettings.MAX_PAGES);
} }
/** /**
* То же, что {@link #checkPageCountLightweight(byte[])}, с явным лимитом * То же, что {@link #checkPageCount(byte[])}, с явным лимитом
* страниц (переопределение на вызов, см. {@link ConvertOptions#maxPages()}). * страниц (переопределение на вызов, см. {@link ConvertOptions#maxPages()}).
* *
* @throws ConversionException при {@code null}, ошибке разбора zip или превышении {@code maxPages} * @throws ValidationException при {@code null}, ошибке разбора zip или превышении {@code maxPages}
*/ */
public static void checkPageCountLightweight(byte[] docxBytes, int maxPages) throws ConversionException { public static void checkPageCount(byte[] docxBytes, int maxPages) throws ValidationException {
if (docxBytes == null) { if (docxBytes == null) {
throw new ConversionException("Не указаны байты входного .docx"); throw new ValidationException("Не указаны байты входного .docx");
} }
int pages; int pages;
try (ZipInputStream zip = new ZipInputStream(new ByteArrayInputStream(docxBytes))) { try (ZipInputStream zip = new ZipInputStream(new ByteArrayInputStream(docxBytes))) {
@@ -132,7 +132,7 @@ public final class WordPdfValidator {
ZipEntry entry; ZipEntry entry;
while ((entry = zip.getNextEntry()) != null) { while ((entry = zip.getNextEntry()) != null) {
String n = entry.getName(); String n = entry.getName();
if (n.equals("docProps/app.xml") || n.equals("word/document.xml") if ("docProps/app.xml".equals(n) || "word/document.xml".equals(n)
|| isHeaderFooterPart(n)) { || isHeaderFooterPart(n)) {
parts.put(n, zip.readAllBytes()); parts.put(n, zip.readAllBytes());
if (isHeaderFooterPart(n)) { if (isHeaderFooterPart(n)) {
@@ -145,196 +145,96 @@ public final class WordPdfValidator {
return b == null ? null : new ByteArrayInputStream(b); return b == null ? null : new ByteArrayInputStream(b);
}, headerFooter); }, headerFooter);
} catch (IOException | RuntimeException e) { } catch (IOException | RuntimeException e) {
throw new ConversionException("Не удалось разобрать байты .docx", e); throw new ValidationException("Не удалось разобрать байты .docx", e);
} }
if (pages > maxPages) { if (pages > maxPages) {
throw new ConversionException("Документ длиннее " + maxPages throw new ValidationException("Документ длиннее " + maxPages
+ " страниц: получено не менее " + pages); + " страниц: получено не менее " + pages);
} }
} }
/** /**
* Считает страницы .docx в байтах и проверяет лимит. * Полная проверка входа: размер → подпись контейнера (zip или OLE2) →
* число страниц. Порядок значим: размер — дешёвая, разбор контейнера без
* подписи бессмысленен. Лимиты берутся из {@link ConvertOptions}
* (переопределение на вызов, см. {@link ConvertOptions#maxBytes()},
* {@link ConvertOptions#maxPages()}).
* *
* @throws ConversionException при {@code null}, ошибке загрузки или превышении лимита * <p>Проверка подписи отдельным шагом обязательна:
*/ * {@code ZipInputStream.getNextEntry()} на не-zip-потоке возвращает
public static void checkPageCount(byte[] docxBytes) throws ConversionException { * {@code null} молча, и {@link #checkPageCount(byte[], int)} такой вход
checkPageCount(docxBytes, WordPdfSettings.MAX_PAGES); * не отверг бы (оценка «1 страница»). Бинарный .doc — не zip, а OLE2
} * (CFB): для него свой магик и свой счётчик страниц
* ({@link #checkDocPageCountLightweight(byte[], int)}). Регрессия —
/** * {@code WordPdfValidatorTest#validate_neitherDocxNorDoc} (на HTTP-границе —
* То же, что {@link #checkPageCount(byte[])}, с явным лимитом страниц * {@code ConvertControllerTest#corruptNotAZip_rejected}).</p>
* (переопределение на вызов, см. {@link ConvertOptions#maxPages()}).
* *
* @throws ConversionException при {@code null}, ошибке загрузки или * @throws ValidationException при {@code null}, превышении {@code options.maxBytes()},
* превышении {@code maxPages} * отсутствии подписи контейнера (ни zip, ни OLE2), ошибке разбора
* контейнера или превышении {@code options.maxPages()}
*/ */
public static void checkPageCount(byte[] docxBytes, int maxPages) throws ConversionException { public static void validate(byte[] docxBytes, ConvertOptions options) throws ValidationException {
if (docxBytes == null) { checkInput(docxBytes, options.maxBytes());
throw new ConversionException("Не указаны байты входного .docx"); boolean zip = docxBytes.length >= 4 && docxBytes[0] == 'P' && docxBytes[1] == 'K'
&& (docxBytes[2] & 0xFF) == 0x03 && (docxBytes[3] & 0xFF) == 0x04;
boolean ole2 = docxBytes.length >= 8
&& (docxBytes[0] & 0xFF) == 0xD0 && (docxBytes[1] & 0xFF) == 0xCF
&& (docxBytes[2] & 0xFF) == 0x11 && (docxBytes[3] & 0xFF) == 0xE0
&& (docxBytes[4] & 0xFF) == 0xA1 && (docxBytes[5] & 0xFF) == 0xB1
&& (docxBytes[6] & 0xFF) == 0x1A && (docxBytes[7] & 0xFF) == 0xE1;
if (!zip && !ole2) {
throw new ValidationException("Содержимое не похоже на .docx или .doc (ни zip, ни OLE2)");
} }
WordprocessingMLPackage pkg;
try { try {
pkg = WordprocessingMLPackage.load(new ByteArrayInputStream(docxBytes)); if (zip) {
} catch (Exception e) { checkPageCount(docxBytes, options.maxPages());
throw new ConversionException("Не удалось разобрать байты .docx", e); } else {
checkDocPageCountLightweight(docxBytes, options.maxPages());
}
} catch (ConversionException e) {
// сломанный OLE2-контейнер — некорректный вход (400), как не-zip в zip-ветке
throw new ValidationException(e.getMessage(), e);
} }
checkPageCount(pkg, maxPages);
} }
/** /**
* Считает страницы уже загруженного .docx и проверяет лимит. * Проверяет число страниц бинарного .doc (Word 97-2003) по кэшу
* {@code SummaryInformation.PageCount} — аналогу {@code docProps/app.xml}
* в docx-пути: Word переписывает его при сохранении, пост-рендерной
* проверки нет осознанно (как в docx-ветке — доверяем кэшу до рендера).
* Кэш пуст или ноль — проверка пропускается (посчитать дёшево нельзя,
* отвергать валидный документ по отсутствию кэша неправильно).
* *
* <p>Число страниц — максимум трёх нижних оценок: * @throws ConversionException при {@code null}, ошибке разбора OLE2 или превышении {@link WordPdfSettings#MAX_PAGES}
* <ol>
* <li>Кэш Word в {@code docProps/app.xml} ({@code <Pages>}).
* Сам по себе недостоверен: Word может сохранить устаревшее
* значение (в регрессной фикстуре {@code stale-cache.docx}
* кэш равен 1 при 110 границах страниц).</li>
* <li>Явные разрывы: {@code w:br[@w:type='page']},
* {@code w:pageBreakBefore} и {@code w:sectPr} прямо в
* {@code w:body}. Абзацы ищутся не только прямо в {@code w:body},
* но и внутри таблиц, контентных контролов {@code w:sdt}
* (Word держит нумерацию именно в контентном контроле) и
* прочего содержимого, реализующего {@link ContentAccessor}.</li>
* <li>Маркеры {@code w:lastRenderedPageBreak} — границы страниц,
* которые Word записал при последнем рендере. Единственный
* источник оценки для документов без явных разрывов, порванных
* по заполнению.</li>
* </ol>
*
* <p>Оценка остаётся нижней: документ без явных разрывов и без
* маркеров (никогда не открывался в Word) оценивается в 1 страницу
* независимо от фактической длины — такие документы лимит не отсекают.
* @throws ConversionException при превышении {@link WordPdfSettings#MAX_PAGES}
*/ */
public static void checkPageCount(WordprocessingMLPackage pkg) throws ConversionException { public static void checkDocPageCountLightweight(byte[] docBytes) throws ConversionException {
checkPageCount(pkg, WordPdfSettings.MAX_PAGES); checkDocPageCountLightweight(docBytes, WordPdfSettings.MAX_PAGES);
} }
/** /**
* То же, что {@link #checkPageCount(WordprocessingMLPackage)}, с явным * То же, что {@link #checkDocPageCountLightweight(byte[])}, с явным
* лимитом страниц (переопределение на вызов, см. {@link ConvertOptions#maxPages()}). * лимитом страниц (переопределение на вызов, см. {@link ConvertOptions#maxPages()}).
* *
* @throws ConversionException при превышении {@code maxPages} * @throws ConversionException при {@code null}, ошибке разбора OLE2 или превышении {@code maxPages}
*/ */
public static void checkPageCount(WordprocessingMLPackage pkg, int maxPages) throws ConversionException { public static void checkDocPageCountLightweight(byte[] docBytes, int maxPages) throws ConversionException {
if (pkg == null) { if (docBytes == null) {
throw new ConversionException("Не указан загруженный .docx"); throw new ConversionException("Не указаны байты входного .doc");
}
int pages;
try (POIFSFileSystem fs = new POIFSFileSystem(new ByteArrayInputStream(docBytes));
HWPFDocument hwpf = new HWPFDocument(fs)) {
org.apache.poi.hpsf.SummaryInformation si = hwpf.getSummaryInformation();
pages = si == null ? 0 : si.getPageCount();
} catch (IOException | RuntimeException e) {
throw new ConversionException("Не удалось разобрать байты .doc", e);
} }
int pages = pageCountOf(pkg);
if (pages > maxPages) { if (pages > maxPages) {
throw new ConversionException("Документ длиннее " + maxPages throw new ConversionException("Документ длиннее " + maxPages
+ " страниц: получено не менее " + pages); + " страниц: получено не менее " + pages);
} }
} }
/**
* Возвращает число страниц: максимум кэша {@code <Pages>}, оценки по
* явным разрывам и оценки по {@code w:lastRenderedPageBreak}.
* Виден только из тестов и пакета.
*/
static int pageCountOf(WordprocessingMLPackage pkg) {
int cached = 0;
try {
if (pkg.getDocPropsExtendedPart() != null) {
org.docx4j.docProps.extended.Properties ext =
pkg.getDocPropsExtendedPart().getContents();
if (ext != null && ext.getPages() != null && ext.getPages() > 0) {
cached = ext.getPages();
}
}
} catch (Exception ignored) {
// docPropsExtended может быть не полностью инициализирован —
// тогда остаётся оценка по разрывам.
}
// getJaxbElement() возвращает null, когда JAXB-разбор части провалился
// (docx4j пишет в лог «Problem with part» и «gives up») — без проверки
// здесь была бы NPE вместо внятной ошибки.
var document = pkg.getMainDocumentPart() == null
? null : pkg.getMainDocumentPart().getJaxbElement();
if (document == null || document.getBody() == null) {
throw new ConversionException("Не удалось разобрать word/document.xml");
}
var body = document.getBody();
var content = body.getContent();
int explicit = 1; // сам документ — минимум одна страница
for (Object child : content) {
// В JAXB-модели в body.getContent() лежат только межсекционные
// sectPr; финальная секция — в body.getSectPr(), её здесь нет.
if (child instanceof SectPr sect && startsNewPage(sect)) {
explicit++;
}
}
explicit += walkForPageBreaks(content);
int lastRendered = countLastRendered(content);
return Math.max(Math.max(cached, explicit), lastRendered + 1);
}
/**
* Обход содержимого на явные разрывы: абзацы ищутся рекурсивно —
* прямо в {@code w:body}, в ячейках таблиц, в контентных контролах
* {@code w:sdt} и прочем содержимом, реализующем {@link ContentAccessor}.
* Элементы модели приходят и напрямую, и обёрнутыми в
* {@link JAXBElement} (например {@code w:tbl} в {@code w:body}) —
* обёртка раскрывается через {@link #unwrap}.
* Считаются {@code w:br type="page"} и {@code pageBreakBefore}
* (по одному на абзац), как и в lightweight-пути.
*/
private static int walkForPageBreaks(List<?> content) {
int count = 0;
for (Object raw : content) {
Object item = unwrap(raw);
if (item instanceof P p) {
if (p.getPPr() != null
&& p.getPPr().getPageBreakBefore() != null
&& p.getPPr().getPageBreakBefore().isVal()) {
count++;
}
for (Object runChild : p.getContent()) {
if (unwrap(runChild) instanceof org.docx4j.wml.R r) {
for (Object innerRaw : r.getContent()) {
if (unwrap(innerRaw) instanceof Br br
&& br.getType() == STBrType.PAGE) {
count++;
}
}
}
}
} else if (item instanceof ContentAccessor ca) {
// w:tbl / w:tr / w:tc / w:sdt / w:sdtContent и т.п.
count += walkForPageBreaks(ca.getContent());
}
}
return count;
}
/** Подсчёт маркеров {@code w:lastRenderedPageBreak} в содержимом. */
private static int countLastRendered(List<?> content) {
int count = 0;
for (Object raw : content) {
Object item = unwrap(raw);
if (item instanceof R.LastRenderedPageBreak) {
count++;
} else if (item instanceof ContentAccessor ca) {
count += countLastRendered(ca.getContent());
}
}
return count;
}
/** Раскрывает обёртку {@link JAXBElement} (docx4j так отдаёт tbl и часть содержимого). */
private static Object unwrap(Object item) {
return item instanceof JAXBElement<?> je ? je.getValue() : item;
}
/** Секция, начинающая новую страницу (continuous — нет). */
private static boolean startsNewPage(SectPr sect) {
return sect.getType() == null
|| sect.getType().getVal() == null
|| !sect.getType().getVal().equals("continuous");
}
/** Поставщик потока по имени части zip; null — части нет. */ /** Поставщик потока по имени части zip; null — части нет. */
private interface PartStream { private interface PartStream {
InputStream open(String name) throws IOException; InputStream open(String name) throws IOException;
@@ -348,8 +248,7 @@ public final class WordPdfValidator {
/** /**
* Лёгкий расчёт числа страниц прямо по zip-пакету .docx, без docx4j. * Лёгкий расчёт числа страниц прямо по zip-пакету .docx, без docx4j.
* Та же логика, что у {@link #pageCountOf(WordprocessingMLPackage)}: * Максимум кэша {@code docProps/app.xml <Pages>}, явных разрывов и
* максимум кэша {@code docProps/app.xml <Pages>}, явных разрывов и
* {@code w:lastRenderedPageBreak}. Считаются все колонтитулы * {@code w:lastRenderedPageBreak}. Считаются все колонтитулы
* ({@code word/header*.xml}, {@code word/footer*.xml}) — там Word тоже * ({@code word/header*.xml}, {@code word/footer*.xml}) — там Word тоже
* держит {@code w:br type="page"}. * держит {@code w:br type="page"}.
@@ -378,7 +277,7 @@ public final class WordPdfValidator {
XMLStreamReader xr = newSecureReader().createXMLStreamReader(in); XMLStreamReader xr = newSecureReader().createXMLStreamReader(in);
while (xr.hasNext()) { while (xr.hasNext()) {
if (xr.next() == XMLStreamReader.START_ELEMENT if (xr.next() == XMLStreamReader.START_ELEMENT
&& xr.getLocalName().equals("Pages")) { && "Pages".equals(xr.getLocalName())) {
String text = xr.getElementText().trim(); String text = xr.getElementText().trim();
return Math.max(0, Integer.parseInt(text)); return Math.max(0, Integer.parseInt(text));
} }
@@ -504,7 +403,7 @@ public final class WordPdfValidator {
XMLStreamReader xr = newSecureReader().createXMLStreamReader(in); XMLStreamReader xr = newSecureReader().createXMLStreamReader(in);
while (xr.hasNext()) { while (xr.hasNext()) {
if (xr.next() == XMLStreamReader.START_ELEMENT if (xr.next() == XMLStreamReader.START_ELEMENT
&& xr.getLocalName().equals("br") && isPageBreak(xr)) { && "br".equals(xr.getLocalName()) && isPageBreak(xr)) {
count++; count++;
} }
} }
@@ -544,7 +443,7 @@ public final class WordPdfValidator {
private static boolean truthy(XMLStreamReader xr) { private static boolean truthy(XMLStreamReader xr) {
String v = attrLocal(xr, "val"); String v = attrLocal(xr, "val");
return v == null || v.equals("true") || v.equals("1") || v.equals("on"); return v == null || "true".equals(v) || "1".equals(v) || "on".equals(v);
} }
private static boolean inside(Deque<String> path, String ancestor) { private static boolean inside(Deque<String> path, String ancestor) {
@@ -54,7 +54,7 @@ public final class BundledFonts {
/** Описание одного файла: имя в jar, ключ семейства, начертание. /** Описание одного файла: имя в jar, ключ семейства, начертание.
* Package-private: доступ для теста. */ * Package-private: доступ для теста. */
static record Entry(String file, String family, String variant) { record Entry(String file, String family, String variant) {
} }
/** /**
@@ -222,7 +222,7 @@ public final class BundledFonts {
* FO может запросить любой из них (фолбэк docx4j по покрытию глифов), * FO может запросить любой из них (фолбэк docx4j по покрытию глифов),
* а FOP знает только задекларированные. * а FOP знает только задекларированные.
*/ */
public static java.util.List<String> families() { public static List<String> families() {
return ENTRIES.stream().map(Entry::family).distinct().toList(); return ENTRIES.stream().map(Entry::family).distinct().toList();
} }
@@ -0,0 +1,764 @@
package ru.pjandro.wordpdf.internal;
import org.apache.fop.apps.FOUserAgent;
import org.apache.fop.apps.Fop;
import org.apache.fop.apps.FopFactory;
import org.apache.fop.apps.MimeConstants;
import org.apache.poi.hwpf.HWPFDocument;
import org.apache.poi.hwpf.converter.FontReplacer;
import org.apache.poi.hwpf.converter.PicturesManager;
import org.apache.poi.hwpf.converter.WordToFoConverter;
import org.apache.poi.hwpf.usermodel.CharacterRun;
import org.apache.poi.hwpf.usermodel.HeaderStories;
import org.apache.poi.hwpf.usermodel.Paragraph;
import org.apache.poi.hwpf.usermodel.PictureType;
import org.apache.poi.hwpf.usermodel.Range;
import org.apache.poi.poifs.filesystem.POIFSFileSystem;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;
import ru.pjandro.wordpdf.ConversionException;
import ru.pjandro.wordpdf.ConvertOptions;
import ru.pjandro.wordpdf.fonts.BundledFontMapper;
import ru.pjandro.wordpdf.fonts.BundledFonts;
import javax.xml.parsers.DocumentBuilderFactory;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.sax.SAXResult;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.Comparator;
import java.util.List;
import java.util.Locale;
import java.util.stream.Stream;
/**
* Рендер бинарного .doc (Word 97-2003, OLE2) в PDF: POI HWPF -> XSL-FO ->
* Apache FOP (тот же форк, что в docx-ветке).
*
* <p>docx4j бинарный формат не читает, HWPF->XWPF конвертера в POI нет —
* поэтому для .doc отдельная ветка: {@link WordToFoConverter} строит FO
* из HWPF-модели напрямую, а колонтитулы (которые POI в FO не пишет)
* дописываются в FO-DOM по {@link HeaderStories}.
*
* <p>Известная деградация против Word (принята): дрейф вёрстки (FO POI
* беднее docx4j-экспорта), шрифты — бандл-аналоги, колонтитулы — по
* одной (odd) истории на секцию, first/even-варианты — эвристикой
* «непустая история => вариант» (флаги titlePg/evenAndOdd POI не отдаёт).
* Флаги {@code renderCharts}/{@code renderSmartArt} для .doc — no-op:
* диаграмм как {@code c:chart} в .doc нет, превью встраиваемых объектов
* приходят картинками через {@link PicturesManager}.
*/
public final class DocToPdfRenderer {
private DocToPdfRenderer() {
}
private static final String FO_NS = "http://www.w3.org/1999/XSL/Format";
/** Маркеры полей Word в тексте HWPF-ранов. */
private static final char FIELD_BEGIN = '\u0013';
private static final char FIELD_SEPARATOR = '\u0014';
private static final char FIELD_END = '\u0015';
/** Маркер конца секции в историях колонтитулов. */
private static final char SECTION_END = '\u000c';
/** Конец абзаца / конец ячейки таблицы в тексте HWPF. */
private static final char PARA_END = '\r';
private static final char CELL_END = '\u0007';
/** Зазор между текстом колонтитула и областью контента. */
private static final double REGION_GAP_IN = 0.15;
/**
* Полный путь .doc -> PDF в поток. Все ошибки — {@link ConversionException}.
*
* @param docBytes байты OLE2 (.doc)
* @param title заголовок PDF (метаданные); {@code null}/пустая — не задаётся
* @param options настройки вызова (для .doc флаги рисования — no-op)
* @param out приёмник байтов PDF
*/
public static void render(byte[] docBytes, String title, ConvertOptions options,
OutputStream out) throws ConversionException {
Path workDir = null;
try {
// init() идемпотентен; restrictToBundled() не нужен — FOP-конфиг
// строится явно (auto-detect="false"), системные шрифты в него не попадают.
BundledFonts.init();
workDir = Files.createTempDirectory("wordpdf-doc-");
Path picsDir = Files.createDirectory(workDir.resolve("pics"));
Document foDoc;
try (POIFSFileSystem fs = new POIFSFileSystem(new ByteArrayInputStream(docBytes));
HWPFDocument hwpf = new HWPFDocument(fs)) {
DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
dbf.setNamespaceAware(true);
Document dom = dbf.newDocumentBuilder().newDocument();
WordToFoConverter converter = new WordToFoConverter(dom);
converter.setFontReplacer(DocToPdfRenderer::replaceFont);
converter.setPicturesManager(new TempPictures(picsDir));
converter.processDocument(hwpf);
foDoc = converter.getDocument();
applyDefaultFont(foDoc);
injectHeadersAndFooters(foDoc, hwpf);
}
renderFo(foDoc, title, workDir, out);
} catch (ConversionException e) {
throw e;
} catch (Exception e) {
throw new ConversionException("Не удалось конвертировать документ .doc", e);
} finally {
if (workDir != null) {
deleteRecursively(workDir);
}
}
}
// ==================== Шрифты ====================
/**
* Замена шрифта ранa на бандл-аналог: имя из name-таблицы TTF
* regular-варианта (тот же механизм triplet-имён, что в
* {@link FopFallbackFonts}) — FO запрашивает именно его.
*/
private static FontReplacer.Triplet replaceFont(FontReplacer.Triplet t) {
String family = BundledFontMapper.bundledFamily(
t.fontName == null ? "" : t.fontName);
var regular = BundledFonts.regular(family);
if (regular != null) {
t.fontName = regular.getName();
}
return t;
}
/** Картинки во временный каталог; FO ссылается на них file:-URI. */
private static final class TempPictures implements PicturesManager {
private final Path dir;
TempPictures(Path dir) {
this.dir = dir;
}
@Override
public String savePicture(byte[] content, PictureType pictureType,
String suggestedName, float widthInches, float heightInches) {
try {
if (content == null || content.length == 0) {
// пустой объект (напр. превью удалённого рисунка) — FOP
// падает на нём с EOFException, ссылка не нужна
return null;
}
String name = suggestedName == null ? "" :
suggestedName.replaceAll("[^A-Za-z0-9._-]", "_");
if (name.isEmpty()) {
String ext = pictureType == null
? PictureType.UNKNOWN.getExtension()
: pictureType.getExtension();
name = "pic-" + java.util.Arrays.hashCode(content) + "." + ext;
}
Path file = dir.resolve(name);
Files.write(file, content);
return file.toUri().toString();
} catch (IOException e) {
// деградация вместо падения: картинка без ссылки просто исчезнет
return null;
}
}
}
// ==================== Колонтитулы ====================
/**
* POI не пишет колонтитулы в FO. Достаём их из {@link HeaderStories},
* разбиваем на чанки по секциям (маркер конца секции {@code \u000c}) и
* вставляем в FO-DOM: {@code fo:region-before}/{@code fo:region-after}
* в мастер + {@code fo:static-content} в page-sequence.
*/
private static void injectHeadersAndFooters(Document foDoc, HWPFDocument hwpf) {
NodeList sequences = foDoc.getElementsByTagNameNS(FO_NS, "page-sequence");
if (sequences.getLength() == 0) {
return;
}
HeaderStories hs = new HeaderStories(hwpf);
// Императивный список: javac 21 не выводит T для List.of/Arrays.asList
// из вложенных дженерик-аргументов (varargs inference).
List<List<List<Paragraph>>> stories = new ArrayList<>();
stories.add(chunkBySection(hs.getOddHeaderSubrange(), sequences.getLength()));
stories.add(chunkBySection(hs.getEvenHeaderSubrange(), sequences.getLength()));
stories.add(chunkBySection(hs.getFirstHeaderSubrange(), sequences.getLength()));
stories.add(chunkBySection(hs.getOddFooterSubrange(), sequences.getLength()));
stories.add(chunkBySection(hs.getEvenFooterSubrange(), sequences.getLength()));
stories.add(chunkBySection(hs.getFirstFooterSubrange(), sequences.getLength()));
// NUMPAGES/SECTIONPAGES -> citation-last по ПОСЛЕДНЕМУ мастеру
// документа: нумерация FOP между page-sequence непрерывна.
String lastMaster = ((Element) sequences.item(sequences.getLength() - 1))
.getAttribute("master-reference");
for (int i = 0; i < sequences.getLength(); i++) {
Element seq = (Element) sequences.item(i);
String masterName = seq.getAttribute("master-reference");
Element master = findMaster(foDoc, masterName);
if (master == null) {
continue;
}
String[] margins = parseMarginShorthand(master);
if (margins == null) {
continue;
}
// Форк FOP (docx4j-fo-renderer) вырезал PageMaster.setupRegions:
// viewport region-body = page-area минус СОБСТВЕННЫЕ margin'ы
// body, extent'ы region-before/after body не вычитаются. Поэтому
// margin'ы region-body (шортхэнд POI = Word-поля) сохраняются —
// единственная защита от наезда текста на колонтитулы; extent'ы
// регионов только размещают сами колонтитулы.
// Порядок детей simple-page-master: body -> before -> after
// (требование валидации форка).
if (hasText(stories.get(0).get(i))) {
appendRegion(master, "region-before", margins[0], "after");
insertStaticContent(seq, "xsl-region-before",
blocks(foDoc, stories.get(0).get(i), lastMaster), "margin-bottom");
}
if (hasText(stories.get(3).get(i))) {
appendRegion(master, "region-after", margins[2], "before");
insertStaticContent(seq, "xsl-region-after",
blocks(foDoc, stories.get(3).get(i), lastMaster), "margin-top");
}
// first/even — эвристика: непустая история => вариант существует.
boolean hasFirst = hasText(stories.get(2).get(i)) || hasText(stories.get(5).get(i));
boolean hasEven = hasText(stories.get(1).get(i)) || hasText(stories.get(4).get(i));
if (!hasFirst && !hasEven) {
continue;
}
List<Element> variants = new ArrayList<>();
if (hasFirst) {
Element clone = (Element) master.cloneNode(true);
String name = masterName + "-first";
clone.setAttribute("master-name", name);
renameRegionFlows(clone, "-first");
foDoc.getDocumentElement().insertBefore(clone, master.getNextSibling());
if (hasText(stories.get(2).get(i))) {
insertStaticContent(seq, "xsl-region-before-first",
blocks(foDoc, stories.get(2).get(i), lastMaster), "margin-bottom");
}
if (hasText(stories.get(5).get(i))) {
insertStaticContent(seq, "xsl-region-after-first",
blocks(foDoc, stories.get(5).get(i), lastMaster), "margin-top");
}
variants.add(clone);
}
if (hasEven) {
Element clone = (Element) master.cloneNode(true);
String name = masterName + "-even";
clone.setAttribute("master-name", name);
renameRegionFlows(clone, "-even");
foDoc.getDocumentElement().insertBefore(clone, master.getNextSibling());
if (hasText(stories.get(1).get(i))) {
insertStaticContent(seq, "xsl-region-before-even",
blocks(foDoc, stories.get(1).get(i), lastMaster), "margin-bottom");
}
if (hasText(stories.get(4).get(i))) {
insertStaticContent(seq, "xsl-region-after-even",
blocks(foDoc, stories.get(4).get(i), lastMaster), "margin-top");
}
variants.add(clone);
}
wrapInPageSequenceMaster(foDoc, master, variants);
}
}
/**
* История колонтитулов — конкатенация одноимённых историй всех секций;
* конец секции помечен {@code \u000c} в последнем параграфе. Чанков не
* столько, сколько секций — деградация: один чанк раздаётся всем.
*/
private static List<List<Paragraph>> chunkBySection(Range story, int sectionCount) {
List<List<Paragraph>> chunks = new ArrayList<>();
if (story != null && story.numParagraphs() > 0) {
List<Paragraph> current = new ArrayList<>();
for (int i = 0; i < story.numParagraphs(); i++) {
Paragraph p;
String text;
try {
p = story.getParagraph(i);
text = p.text();
} catch (RuntimeException e) {
continue;
}
current.add(p);
if (text != null && text.indexOf(SECTION_END) >= 0) {
chunks.add(current);
current = new ArrayList<>();
}
}
if (!current.isEmpty()) {
chunks.add(current);
}
}
if (chunks.isEmpty()) {
for (int i = 0; i < sectionCount; i++) {
chunks.add(null);
}
} else if (chunks.size() != sectionCount) {
List<Paragraph> first = chunks.get(0);
chunks = new ArrayList<>();
for (int i = 0; i < sectionCount; i++) {
chunks.add(first);
}
}
return chunks;
}
private static Element findMaster(Document foDoc, String masterName) {
NodeList masters = foDoc.getElementsByTagNameNS(FO_NS, "simple-page-master");
for (int i = 0; i < masters.getLength(); i++) {
Element m = (Element) masters.item(i);
if (masterName.equals(m.getAttribute("master-name"))) {
return m;
}
}
return null;
}
/** {@code margin="T R B L"} region-body мастера (шортхэнд POI). */
private static String[] parseMarginShorthand(Element master) {
Element body = child(master, "region-body");
if (body == null) {
return null;
}
String margin = body.getAttribute("margin");
if (margin == null) {
return null;
}
String[] parts = margin.trim().split("\\s+");
return parts.length == 4 ? parts : null;
}
/**
* Регион колонтитула: extent = поле страницы, текст прижат к body
* (низ заголовка / верх футера); зазор — маргинами блоков.
*/
private static Element appendRegion(Element master, String kind, String extent,
String displayAlign) {
Element region = master.getOwnerDocument().createElementNS(FO_NS, "fo:" + kind);
region.setAttribute("extent", extent);
region.setAttribute("display-align", displayAlign);
master.appendChild(region);
return region;
}
/** В master-клоне варианта колонтитулы берутся из своего потока. */
private static void renameRegionFlows(Element clone, String suffix) {
for (String kind : new String[]{"region-before", "region-after"}) {
Element region = child(clone, kind);
if (region != null) {
region.setAttribute("flow-name", "xsl-" + kind + suffix);
}
}
}
/**
* Мастер с first/even-вариантами оборачивается в
* {@code fo:page-sequence-master} (на месте); {@code master-reference}
* page-sequence не меняется — он указывает на имя обёртки.
*/
private static void wrapInPageSequenceMaster(Document foDoc, Element master,
List<Element> variants) {
String masterName = master.getAttribute("master-name");
Element psm = foDoc.createElementNS(FO_NS, "fo:page-sequence-master");
psm.setAttribute("master-name", masterName);
Element alternatives = foDoc.createElementNS(FO_NS,
"fo:repeatable-page-master-alternatives");
psm.appendChild(alternatives);
for (Element variant : variants) {
String position = variant.getAttribute("master-name").endsWith("-first")
? "first" : "even";
alternatives.appendChild(conditionalRef(foDoc, position,
variant.getAttribute("master-name")));
}
alternatives.appendChild(conditionalRef(foDoc, "rest", masterName));
master.getParentNode().replaceChild(psm, master);
}
private static Element conditionalRef(Document foDoc, String position, String masterRef) {
Element ref = foDoc.createElementNS(FO_NS, "fo:conditional-page-master-reference");
ref.setAttribute("master-reference", masterRef);
ref.setAttribute("page-position", position);
return ref;
}
/**
* static-content вставляется в page-sequence перед fo:flow; каждый блок
* получает зазор {@code gapAttribute} к области контента (в самих
* регионах padding запрещён XSL 1.1 — FOP валидирует).
*/
private static void insertStaticContent(Element sequence, String flowName,
List<Element> content, String gapAttribute) {
if (content.isEmpty()) {
return;
}
Document doc = sequence.getOwnerDocument();
Element staticContent = doc.createElementNS(FO_NS, "fo:static-content");
staticContent.setAttribute("flow-name", flowName);
for (Element block : content) {
block.setAttribute(gapAttribute, REGION_GAP_IN + "in");
staticContent.appendChild(block);
}
Element flow = child(sequence, "flow");
if (flow == null) {
sequence.appendChild(staticContent);
} else {
sequence.insertBefore(staticContent, flow);
}
}
// ==================== История -> блоки FO ====================
/** Параграфы чанка истории как {@code fo:block}-и; пустой чанк — пустой список. */
private static List<Element> blocks(Document foDoc, List<Paragraph> chunk,
String lastMasterName) {
List<Element> result = new ArrayList<>();
if (chunk == null) {
return result;
}
for (Paragraph p : chunk) {
Element block = paragraphBlock(foDoc, p, lastMasterName);
if (block != null && blockHasVisibleContent(block)) {
result.add(block);
}
}
return result;
}
/**
* Параграф истории как {@code fo:block}: выравнивание, табуляции, раны с
* форматированием и поля (PAGE/NUMPAGES/SECTIONPAGES) из управляющих
* символов текста ранов ({@code \u0013}\u2026{@code \u0014}\u2026{@code \u0015}).
*/
private static Element paragraphBlock(Document doc, Paragraph p,
String lastMasterName) {
Element block = doc.createElementNS(FO_NS, "fo:block");
block.setAttribute("text-align", switch (p.getJustification()) {
case 1 -> "center";
case 2 -> "end";
case 3 -> "justify";
default -> "start";
});
// Наследуемый шрифт блока: fo:page-number — пустой элемент, без
// font-family блока FOP рисует его базовым Helvetica.
var blockFont = firstRunFont(p);
block.setAttribute("font-family", blockFont != null
? blockFont.getName()
: BundledFonts.regular(BundledFonts.FALLBACK_FAMILY).getName());
// state-machine полей: 0 — обычный текст, 1 — инструкция, 2 — кэш-результат
StringBuilder instr = new StringBuilder();
StringBuilder cached = new StringBuilder();
StringBuilder plain = new StringBuilder();
int column = 0;
int mode = 0;
for (int j = 0; j < p.numCharacterRuns(); j++) {
CharacterRun cr;
String text;
try {
cr = p.getCharacterRun(j);
text = cr.text();
} catch (RuntimeException e) {
continue;
}
if (text == null) {
continue;
}
for (int k = 0; k < text.length(); k++) {
char c = text.charAt(k);
if (c == FIELD_BEGIN) {
mode = 1;
instr.setLength(0);
cached.setLength(0);
} else if (c == FIELD_SEPARATOR && mode == 1) {
mode = 2;
} else if (c == FIELD_END && (mode == 1 || mode == 2)) {
emitField(doc, block, instr.toString(), cached.toString(), lastMasterName);
mode = 0;
} else if (mode == 1) {
instr.append(c);
} else if (mode == 2) {
cached.append(c);
} else if (c == '\t') {
column = appendTab(doc, block, plain, column, cr);
} else {
plain.append(c);
}
}
}
if (mode != 0) {
// незакрытое поле: выводим накопленное как обычный текст
plain.append(instr).append(cached);
}
flushText(doc, block, plain.toString(), null);
return block;
}
/** Распознанные поля — живые FO-элементы; прочие — кэш-текст как есть. */
private static void emitField(Document doc, Element block, String instruction,
String cachedResult, String lastMasterName) {
String code = instruction.trim().toUpperCase(Locale.ROOT);
if (code.startsWith("PAGE")) {
Element pn = doc.createElementNS(FO_NS, "fo:page-number");
block.appendChild(pn);
} else if ((code.startsWith("NUMPAGES") || code.startsWith("SECTIONPAGES"))
&& lastMasterName != null) {
// нумерация FOP между page-sequence непрерывна — citation-last
// по последнему мастеру = общее число страниц
Element pn = doc.createElementNS(FO_NS, "fo:page-number-citation-last");
pn.setAttribute("ref-name", lastMasterName);
block.appendChild(pn);
} else {
flushText(doc, block, cachedResult, null);
}
}
/**
* {@code \t}: FOP-форк не поддерживает свойство {@code tabs}, поэтому
* таб — пробелы до следующей дефолтной Word-остановки (1,25 см).
* Возвращает новую «колонку» (символы до курсора).
*/
private static int appendTab(Document doc, Element block, StringBuilder plain,
int column, CharacterRun cr) {
flushText(doc, block, plain.toString(), null);
plain.setLength(0);
double charIn = charWidthIn(cr);
double step = 1.25 / 2.54;
double x = (column + 1) * charIn;
double target = (Math.floor(x / step) + 1) * step;
int spaces = (int) Math.max(1, Math.ceil((target - x) / charIn));
flushText(doc, block, " ".repeat(spaces), cr);
return column + 1 + spaces;
}
/** Приблизительная ширина символа (полширины кегля) в дюймах. */
private static double charWidthIn(CharacterRun cr) {
double pt = 10.0;
try {
if (cr != null && cr.getFontSize() > 0) {
pt = cr.getFontSize() / 2.0;
}
} catch (RuntimeException e) {
// наследование из стиля — остаётся дефолт
}
return Math.max(0.03, pt * 0.5 / 72.0);
}
private static void flushText(Document doc, Element block, String text,
CharacterRun cr) {
String cleaned = cleanText(text);
if (cleaned.isEmpty()) {
return;
}
if (cr == null) {
block.appendChild(doc.createTextNode(cleaned));
return;
}
Element inline = doc.createElementNS(FO_NS, "fo:inline");
var font = runFont(cr);
if (font != null) {
inline.setAttribute("font-family", font.getName());
}
int halfPoints = cr.getFontSize();
inline.setAttribute("font-size", (halfPoints > 0 ? halfPoints / 2.0 : 10.0) + "pt");
if (cr.isBold()) {
inline.setAttribute("font-weight", "bold");
}
if (cr.isItalic()) {
inline.setAttribute("font-style", "italic");
}
if (cr.getUnderlineCode() != 0) {
inline.setAttribute("text-decoration", "underline");
}
inline.appendChild(doc.createTextNode(cleaned));
block.appendChild(inline);
}
/** Шрифт рана -> бандл-аналог (тот же маппинг, что у основного текста). */
private static org.docx4j.fonts.PhysicalFont runFont(CharacterRun cr) {
String name;
try {
name = cr.getFontName();
} catch (RuntimeException e) {
return null;
}
String family = BundledFontMapper.bundledFamily(name == null ? "" : name);
return BundledFonts.regular(family);
}
/** Шрифт первого читаемого рана параграфа (для наследуемого font-family блока). */
private static org.docx4j.fonts.PhysicalFont firstRunFont(Paragraph p) {
try {
for (int j = 0; j < p.numCharacterRuns(); j++) {
var font = runFont(p.getCharacterRun(j));
if (font != null) {
return font;
}
}
} catch (RuntimeException e) {
// повреждённый параграф — на fallback вызывающего
}
return null;
}
/**
* POI пишет маркеры списков {@code fo:inline} без font-family — FOP
* рисует их базовым Helvetica. Проставляем фолбэк-семейство всем
* инлайнам без семейства.
*/
private static void applyDefaultFont(Document foDoc) {
String fallback = BundledFonts.regular(BundledFonts.FALLBACK_FAMILY).getName();
NodeList inlines = foDoc.getElementsByTagNameNS(FO_NS, "inline");
for (int i = 0; i < inlines.getLength(); i++) {
Element inline = (Element) inlines.item(i);
if (inline.getAttribute("font-family").isEmpty()) {
inline.setAttribute("font-family", fallback);
}
}
}
// ==================== FOP ====================
private static void renderFo(Document foDoc, String title, Path baseDir,
OutputStream out) throws Exception {
byte[] config = fopConfig().getBytes(StandardCharsets.UTF_8);
FopFactory fopFactory = FopFactory.newInstance(baseDir.toUri(),
new ByteArrayInputStream(config));
FOUserAgent ua = fopFactory.newFOUserAgent();
// Дефолт кэша шрифтов форка — <user.home>/.fop/fop-fonts.cache, а при
// непригодном user.home (контейнер без HOME) — файл ".fop" в текущем
// каталоге; в образе /app не пишется non-root'ом -> 500 на каждом .doc.
// Кэш бесполезен: auto-detect="false", шрифты объявлены из classpath.
ua.getFontManager().disableFontCache();
if (title != null && !title.isBlank()) {
ua.setTitle(title);
}
Fop fop = fopFactory.newFop(MimeConstants.MIME_PDF, ua, out);
javax.xml.transform.Transformer transformer =
javax.xml.transform.TransformerFactory.newInstance().newTransformer();
transformer.transform(new DOMSource(foDoc), new SAXResult(fop.getDefaultHandler()));
}
/**
* FOP-конфиг: только шрифты бандла (auto-detect="false" — системные в
* рендер не попадают). Triplet-имена — из name-таблиц regular-вариантов,
* как в {@link FopFallbackFonts}; {@code simulate-style="false"} — стили
* настоящие TTF, а не синтез FOP.
*/
private static String fopConfig() {
StringBuilder sb = new StringBuilder(
"<fop version=\"1.0\"><renderers>"
+ "<renderer mime=\"application/pdf\"><fonts auto-detect=\"false\">");
for (String family : BundledFonts.families()) {
var regular = BundledFonts.regular(family);
if (regular == null) {
continue;
}
String tripletName = regular.getName();
appendFont(sb, regular, "regular", tripletName, "normal", "normal");
appendFont(sb, BundledFonts.bold(family), "bold", tripletName, "normal", "bold");
appendFont(sb, BundledFonts.italic(family), "italic", tripletName, "italic", "normal");
appendFont(sb, BundledFonts.boldItalic(family), "boldItalic",
tripletName, "italic", "bold");
}
sb.append("</fonts></renderer></renderers></fop>");
return sb.toString();
}
private static void appendFont(StringBuilder sb, org.docx4j.fonts.PhysicalFont pf,
String embedMode, String tripletName,
String style, String weight) {
if (pf == null) {
return;
}
sb.append("<font embed-url=\"").append(pf.getEmbeddedURI())
.append("\" embed-mode=\"").append(embedMode)
.append("\" simulate-style=\"false\"><font-triplet name=\"")
.append(tripletName).append("\" style=\"").append(style)
.append("\" weight=\"").append(weight)
.append("\"/></font>");
}
// ==================== Утилиты DOM ====================
private static Element child(Element parent, String localName) {
NodeList children = parent.getChildNodes();
for (int i = 0; i < children.getLength(); i++) {
Node n = children.item(i);
if (n instanceof Element e && FO_NS.equals(e.getNamespaceURI())
&& localName.equals(e.getLocalName())) {
return e;
}
}
return null;
}
private static boolean blockHasVisibleContent(Element block) {
if (block.getTextContent() != null && !block.getTextContent().isBlank()) {
return true;
}
return block.getElementsByTagNameNS(FO_NS, "page-number").getLength() > 0
|| block.getElementsByTagNameNS(FO_NS, "page-number-citation-last").getLength() > 0
|| block.getElementsByTagNameNS(FO_NS, "leader").getLength() > 0;
}
/** Есть ли в чанке хоть один параграф с видимым содержимым. */
private static boolean hasText(List<Paragraph> chunk) {
if (chunk == null) {
return false;
}
for (Paragraph p : chunk) {
try {
for (int j = 0; j < p.numCharacterRuns(); j++) {
String t = p.getCharacterRun(j).text();
if (t != null && !cleanText(t).isEmpty()) {
return true;
}
}
} catch (RuntimeException e) {
// повреждённый ран — не содержимое
}
}
return false;
}
private static String cleanText(String t) {
StringBuilder sb = new StringBuilder(t.length());
for (int i = 0; i < t.length(); i++) {
char c = t.charAt(i);
if (c != PARA_END && c != CELL_END && c != SECTION_END) {
sb.append(c);
}
}
return sb.toString();
}
private static void deleteRecursively(Path dir) {
try (Stream<Path> walk = Files.walk(dir)) {
walk.sorted(Comparator.reverseOrder()).forEach(p -> {
try {
Files.deleteIfExists(p);
} catch (IOException ignored) {
// temp-файлы: нечего делать при отказе удаления
}
});
} catch (IOException ignored) {
}
}
}
@@ -79,7 +79,7 @@ public final class DocxOnOffNormalizer {
m.reset(); m.reset();
StringBuilder sb = new StringBuilder(xml.length()); StringBuilder sb = new StringBuilder(xml.length());
while (m.find()) { while (m.find()) {
String value = m.group(2).equalsIgnoreCase("on") ? "true" : "false"; String value = "on".equalsIgnoreCase(m.group(2)) ? "true" : "false";
m.appendReplacement(sb, Matcher.quoteReplacement( m.appendReplacement(sb, Matcher.quoteReplacement(
"w:val=" + m.group(1) + value + m.group(1))); "w:val=" + m.group(1) + value + m.group(1)));
} }
@@ -98,7 +98,7 @@ public final class StrictOoxmlNormalizer {
// в numbering.xml w:start — элемент стартового значения // в numbering.xml w:start — элемент стартового значения
// счётчика, его не переименовываем // счётчика, его не переименовываем
String fixed = rewrite(new String(data, StandardCharsets.UTF_8), String fixed = rewrite(new String(data, StandardCharsets.UTF_8),
!name.equals("word/numbering.xml")); !"word/numbering.xml".equals(name));
if (fixed != null) { if (fixed != null) {
changed = true; changed = true;
data = fixed.getBytes(StandardCharsets.UTF_8); data = fixed.getBytes(StandardCharsets.UTF_8);
@@ -225,7 +225,7 @@ public final class StrictOoxmlNormalizer {
m.reset(); m.reset();
StringBuilder sb = new StringBuilder(xml.length()); StringBuilder sb = new StringBuilder(xml.length());
while (m.find()) { while (m.find()) {
String value = m.group(2).equals("start") ? "left" : "right"; String value = "start".equals(m.group(2)) ? "left" : "right";
m.appendReplacement(sb, m.appendReplacement(sb,
Matcher.quoteReplacement(m.group(1) + value + "\"")); Matcher.quoteReplacement(m.group(1) + value + "\""));
} }
@@ -43,8 +43,8 @@ final class CartesianPainter {
// 1. Поля под подписи осей // 1. Поля под подписи осей
double catGutter = 0; double catGutter = 0;
for (String c : cats) { if (!cats.isEmpty()) {
catGutter = Math.max(catGutter, DrawMlText.textHeight(catStyle, g.getFontRenderContext())); catGutter = DrawMlText.textHeight(catStyle, g.getFontRenderContext());
} }
catGutter += 6; catGutter += 6;
@@ -86,8 +86,7 @@ final class CartesianPainter {
if (valAxis.gridlines && !valAxis.deleted) { if (valAxis.gridlines && !valAxis.deleted) {
g.setColor(valAxis.gridColor); g.setColor(valAxis.gridColor);
g.setStroke(new BasicStroke(0.6f)); g.setStroke(new BasicStroke(0.6f));
int i = 0; for (double v = lo; v <= hi + unit / 2; v += unit) {
for (double v = lo; v <= hi + unit / 2; v += unit, i++) {
double t = (v - lo) / (hi - lo); double t = (v - lo) / (hi - lo);
if (horizontal) { if (horizontal) {
double x = plot.getX() + t * plot.getWidth(); double x = plot.getX() + t * plot.getWidth();
@@ -259,7 +258,6 @@ final class CartesianPainter {
private static void drawAreas(Graphics2D g, ChartSpec spec, Rectangle2D plot, private static void drawAreas(Graphics2D g, ChartSpec spec, Rectangle2D plot,
List<Color> palette, double lo, double hi, int nCat, List<Color> palette, double lo, double hi, int nCat,
boolean horizontal) { boolean horizontal) {
double baseline = horizontal ? plot.getX() : plot.getY() + plot.getHeight();
for (int si = 0; si < spec.series.size(); si++) { for (int si = 0; si < spec.series.size(); si++) {
ChartSpec.Series s = spec.series.get(si); ChartSpec.Series s = spec.series.get(si);
Color c = s.fill != null ? s.fill : s.fillAt(si, palette); Color c = s.fill != null ? s.fill : s.fillAt(si, palette);
@@ -277,18 +275,16 @@ final class CartesianPainter {
continue; continue;
} }
Path2D p = new Path2D.Double(); Path2D p = new Path2D.Double();
p.moveTo(toX(along.get(0), cross.get(0), baseline, horizontal), p.moveTo(toX(along.get(0), cross.get(0), horizontal),
toY(along.get(0), cross.get(0), baseline, horizontal)); toY(along.get(0), cross.get(0), horizontal));
for (int i = 0; i < along.size(); i++) { for (int i = 0; i < along.size(); i++) {
p.lineTo(toX(along.get(i), cross.get(i), baseline, horizontal), p.lineTo(toX(along.get(i), cross.get(i), horizontal),
toY(along.get(i), cross.get(i), baseline, horizontal)); toY(along.get(i), cross.get(i), horizontal));
} }
p.lineTo(toX(along.get(along.size() - 1), cross.get(cross.size() - 1), p.lineTo(toX(along.get(along.size() - 1), cross.get(cross.size() - 1), horizontal),
baseline, horizontal), toY(along.get(along.size() - 1), cross.get(cross.size() - 1), horizontal));
toY(along.get(along.size() - 1), cross.get(cross.size() - 1), p.lineTo(toX(along.get(0), cross.get(0), horizontal),
baseline, horizontal)); toY(along.get(0), cross.get(0), horizontal));
p.lineTo(toX(along.get(0), cross.get(0), baseline, horizontal),
toY(along.get(0), cross.get(0), baseline, horizontal));
p.closePath(); p.closePath();
g.setColor(DrawMlColor.withAlpha(c, 0.55)); g.setColor(DrawMlColor.withAlpha(c, 0.55));
g.fill(p); g.fill(p);
@@ -299,11 +295,11 @@ final class CartesianPainter {
} }
/** (вдоль категории, вдоль значения) -> экранные координаты. */ /** (вдоль категории, вдоль значения) -> экранные координаты. */
private static double toX(double along, double cross, double baseline, boolean horizontal) { private static double toX(double along, double cross, boolean horizontal) {
return horizontal ? cross : along; return horizontal ? cross : along;
} }
private static double toY(double along, double cross, double baseline, boolean horizontal) { private static double toY(double along, double cross, boolean horizontal) {
return horizontal ? along : cross; return horizontal ? along : cross;
} }
@@ -179,8 +179,6 @@ final class ChartRenderer {
} }
} }
case SURFACE3D -> { case SURFACE3D -> {
List<Double> vals = spec.series.isEmpty()
? List.of() : spec.series.get(0).values;
double min = Double.MAX_VALUE; double min = Double.MAX_VALUE;
double max = -Double.MAX_VALUE; double max = -Double.MAX_VALUE;
for (ChartSpec.Series s : spec.series) { for (ChartSpec.Series s : spec.series) {
@@ -330,7 +328,7 @@ final class ChartRenderer {
// (так делает Word) — иначе surface3D теряет нижнюю полосу и легенда // (так делает Word) — иначе surface3D теряет нижнюю полосу и легенда
// съезжает с «0-1 … 4-5» на «1-2 … 4-5». // съезжает с «0-1 … 4-5» на «1-2 … 4-5».
double lo = axis != null && axis.min != null ? axis.min double lo = axis != null && axis.min != null ? axis.min
: (dataMin >= 0 ? 0 : Math.floor(dataMin / unit) * unit); : dataMin >= 0 ? 0 : Math.floor(dataMin / unit) * unit;
double hi; double hi;
if (axis != null && axis.max != null) { if (axis != null && axis.max != null) {
hi = axis.max; hi = axis.max;
@@ -346,7 +344,7 @@ final class ChartRenderer {
/** Формат числа для подписей оси ("General" -> без лишних нулей). */ /** Формат числа для подписей оси ("General" -> без лишних нулей). */
static String formatValue(double v, String fmt) { static String formatValue(double v, String fmt) {
if (fmt != null && !fmt.equalsIgnoreCase("General")) { if (fmt != null && !"General".equalsIgnoreCase(fmt)) {
if (fmt.contains("0.00")) { if (fmt.contains("0.00")) {
return String.format(java.util.Locale.ROOT, "%.2f", v); return String.format(java.util.Locale.ROOT, "%.2f", v);
} }
@@ -122,10 +122,6 @@ final class ChartSpec {
Color chartBorder = new Color(0xBF, 0xBF, 0xBF); Color chartBorder = new Color(0xBF, 0xBF, 0xBF);
double chartBorderWidth = 0.75; double chartBorderWidth = 0.75;
/** package-private: тестам нужен пустой spec без CTChartSpace. */
ChartSpec() {
}
/** Цвета акцента темы — базовая палитра рядов (как в Word). */ /** Цвета акцента темы — базовая палитра рядов (как в Word). */
static List<Color> palette(DrawMlColor colors) { static List<Color> palette(DrawMlColor colors) {
List<Color> p = new ArrayList<>(); List<Color> p = new ArrayList<>();
@@ -228,25 +224,24 @@ final class ChartSpec {
if (group instanceof CTPie3DChart g) { if (group instanceof CTPie3DChart g) {
spec.type = Type.PIE3D; spec.type = Type.PIE3D;
for (CTPieSer s : g.getSer()) { for (CTPieSer s : g.getSer()) {
spec.series.add(readPieSer(s, colors, palette)); spec.series.add(readPieSer(s, colors));
} }
} else if (group instanceof CTPieChart g) { } else if (group instanceof CTPieChart g) {
spec.type = Type.PIE; spec.type = Type.PIE;
for (CTPieSer s : g.getSer()) { for (CTPieSer s : g.getSer()) {
spec.series.add(readPieSer(s, colors, palette)); spec.series.add(readPieSer(s, colors));
} }
} else if (group instanceof CTDoughnutChart g) { } else if (group instanceof CTDoughnutChart g) {
spec.type = Type.DOUGHNUT; spec.type = Type.DOUGHNUT;
for (CTPieSer s : g.getSer()) { for (CTPieSer s : g.getSer()) {
spec.series.add(readPieSer(s, colors, palette)); spec.series.add(readPieSer(s, colors));
} }
} else if (group instanceof CTLineChart g) { } else if (group instanceof CTLineChart g) {
spec.type = Type.LINE; spec.type = Type.LINE;
for (CTLineSer s : g.getSer()) { for (CTLineSer s : g.getSer()) {
Series ser = new Series(); Series ser = new Series();
readCommon(s.getTx(), s.getCat(), s.getVal(), s.getDPt(), ser, colors, palette); readCommon(s.getTx(), s.getCat(), s.getVal(), s.getDPt(), ser, colors);
readLineProps(s.getSpPr(), ser, colors, palette, readLineProps(s.getSpPr(), ser, colors);
spec.series.size());
CTMarker m = s.getMarker(); CTMarker m = s.getMarker();
if (m != null) { if (m != null) {
ser.marker = m.getSymbol() == null ser.marker = m.getSymbol() == null
@@ -260,11 +255,11 @@ final class ChartSpec {
} else if (group instanceof CTBarChart g) { } else if (group instanceof CTBarChart g) {
boolean horizontal = g.getBarDir() != null boolean horizontal = g.getBarDir() != null
&& g.getBarDir().getVal() != null && g.getBarDir().getVal() != null
&& g.getBarDir().getVal().value().equalsIgnoreCase("bar"); && "bar".equalsIgnoreCase(g.getBarDir().getVal().value());
spec.type = horizontal ? Type.BAR_HORIZONTAL : Type.BAR; spec.type = horizontal ? Type.BAR_HORIZONTAL : Type.BAR;
for (CTBarSer s : g.getSer()) { for (CTBarSer s : g.getSer()) {
Series ser = new Series(); Series ser = new Series();
readCommon(s.getTx(), s.getCat(), s.getVal(), s.getDPt(), ser, colors, palette); readCommon(s.getTx(), s.getCat(), s.getVal(), s.getDPt(), ser, colors);
if (s.getSpPr() != null && s.getSpPr().getSolidFill() != null) { if (s.getSpPr() != null && s.getSpPr().getSolidFill() != null) {
ser.fill = colors.resolveFill(s.getSpPr().getSolidFill()); ser.fill = colors.resolveFill(s.getSpPr().getSolidFill());
} }
@@ -274,11 +269,11 @@ final class ChartSpec {
spec.type = Type.AREA; spec.type = Type.AREA;
for (org.docx4j.dml.chart.CTAreaSer s : g.getSer()) { for (org.docx4j.dml.chart.CTAreaSer s : g.getSer()) {
Series ser = new Series(); Series ser = new Series();
readCommon(s.getTx(), s.getCat(), s.getVal(), s.getDPt(), ser, colors, palette); readCommon(s.getTx(), s.getCat(), s.getVal(), s.getDPt(), ser, colors);
if (s.getSpPr() != null && s.getSpPr().getSolidFill() != null) { if (s.getSpPr() != null && s.getSpPr().getSolidFill() != null) {
ser.fill = colors.resolveFill(s.getSpPr().getSolidFill()); ser.fill = colors.resolveFill(s.getSpPr().getSolidFill());
} }
readLineProps(s.getSpPr(), ser, colors, palette, spec.series.size()); readLineProps(s.getSpPr(), ser, colors);
spec.series.add(ser); spec.series.add(ser);
} }
} else if (group instanceof CTSurface3DChart g) { } else if (group instanceof CTSurface3DChart g) {
@@ -286,7 +281,7 @@ final class ChartSpec {
spec.wireframe = isTrue(g.getWireframe()); spec.wireframe = isTrue(g.getWireframe());
for (CTSurfaceSer s : g.getSer()) { for (CTSurfaceSer s : g.getSer()) {
Series ser = new Series(); Series ser = new Series();
readCommon(s.getTx(), s.getCat(), s.getVal(), List.of(), ser, colors, palette); readCommon(s.getTx(), s.getCat(), s.getVal(), List.of(), ser, colors);
if (s.getSpPr() != null && s.getSpPr().getSolidFill() != null) { if (s.getSpPr() != null && s.getSpPr().getSolidFill() != null) {
ser.fill = colors.resolveFill(s.getSpPr().getSolidFill()); ser.fill = colors.resolveFill(s.getSpPr().getSolidFill());
} }
@@ -305,9 +300,9 @@ final class ChartSpec {
} }
} }
private static Series readPieSer(CTPieSer s, DrawMlColor colors, List<Color> palette) { private static Series readPieSer(CTPieSer s, DrawMlColor colors) {
Series ser = new Series(); Series ser = new Series();
readCommon(s.getTx(), s.getCat(), s.getVal(), s.getDPt(), ser, colors, palette); readCommon(s.getTx(), s.getCat(), s.getVal(), s.getDPt(), ser, colors);
if (s.getSpPr() != null) { if (s.getSpPr() != null) {
if (s.getSpPr().getSolidFill() != null) { if (s.getSpPr().getSolidFill() != null) {
ser.fill = colors.resolveFill(s.getSpPr().getSolidFill()); ser.fill = colors.resolveFill(s.getSpPr().getSolidFill());
@@ -328,8 +323,7 @@ final class ChartSpec {
/** Общее для всех типов: имя, категории, значения, переопределения точек. */ /** Общее для всех типов: имя, категории, значения, переопределения точек. */
private static void readCommon(CTSerTx tx, CTAxDataSource cat, CTNumDataSource val, private static void readCommon(CTSerTx tx, CTAxDataSource cat, CTNumDataSource val,
List<CTDPt> dPts, Series ser, DrawMlColor colors, List<CTDPt> dPts, Series ser, DrawMlColor colors) {
List<Color> palette) {
ser.name = seriesName(tx); ser.name = seriesName(tx);
ser.categories.addAll(categoryNames(cat)); ser.categories.addAll(categoryNames(cat));
if (val != null) { if (val != null) {
@@ -362,8 +356,7 @@ final class ChartSpec {
} }
/** a:ln ряда (цвет и толщина линии графика). */ /** a:ln ряда (цвет и толщина линии графика). */
private static void readLineProps(CTShapeProperties sp, Series ser, DrawMlColor colors, private static void readLineProps(CTShapeProperties sp, Series ser, DrawMlColor colors) {
List<Color> palette, int seriesIndex) {
if (sp == null) { if (sp == null) {
return; return;
} }
@@ -112,9 +112,9 @@ final class DrawMlColor {
} }
String n = name.toLowerCase(Locale.ROOT); String n = name.toLowerCase(Locale.ROOT);
// Word: bg1/tx1 — псевдонимы lt1/dk1 // Word: bg1/tx1 — псевдонимы lt1/dk1
if (n.equals("bg1")) { if ("bg1".equals(n)) {
n = "lt1"; n = "lt1";
} else if (n.equals("tx1")) { } else if ("tx1".equals(n)) {
n = "dk1"; n = "dk1";
} }
Color c = scheme.get(n); Color c = scheme.get(n);
@@ -171,7 +171,7 @@ final class DrawMlColor {
} }
case "hueMod" -> { case "hueMod" -> {
hsl = RgbHsl.toHsl(toRgb(hsl)); hsl = RgbHsl.toHsl(toRgb(hsl));
hsl[0] = (hsl[0] * p) % 360.0; hsl[0] = hsl[0] * p % 360.0;
hslDirty = true; hslDirty = true;
} }
case "hueOff" -> { case "hueOff" -> {
@@ -260,9 +260,9 @@ final class DrawMlColor {
if (c.getScrgbClr() != null) { if (c.getScrgbClr() != null) {
CTScRgbColor s = c.getScrgbClr(); CTScRgbColor s = c.getScrgbClr();
return new Color( return new Color(
clamp255((int) Math.round(s.getR() * 255)), clamp255(Math.round(s.getR() * 255)),
clamp255((int) Math.round(s.getG() * 255)), clamp255(Math.round(s.getG() * 255)),
clamp255((int) Math.round(s.getB() * 255))); clamp255(Math.round(s.getB() * 255)));
} }
if (c.getHslClr() != null) { if (c.getHslClr() != null) {
CTHslColor h = c.getHslClr(); CTHslColor h = c.getHslClr();
@@ -12,7 +12,6 @@ import ru.pjandro.wordpdf.fonts.BundledFonts;
import java.awt.Color; import java.awt.Color;
import java.awt.Font; import java.awt.Font;
import java.awt.Graphics2D; import java.awt.Graphics2D;
import java.awt.Font;
import java.awt.font.FontRenderContext; import java.awt.font.FontRenderContext;
import java.awt.font.TextLayout; import java.awt.font.TextLayout;
import java.awt.geom.Rectangle2D; import java.awt.geom.Rectangle2D;
@@ -214,7 +213,7 @@ final class DrawMlText {
continue; continue;
} }
StringBuilder cur = new StringBuilder(); StringBuilder cur = new StringBuilder();
double curWidth = 0; double curWidth;
for (String word : hard.split(" ")) { for (String word : hard.split(" ")) {
if (word.isEmpty()) { if (word.isEmpty()) {
continue; continue;
@@ -224,7 +223,6 @@ final class DrawMlText {
if (w <= limit || cur.length() == 0) { if (w <= limit || cur.length() == 0) {
cur.setLength(0); cur.setLength(0);
cur.append(candidate); cur.append(candidate);
curWidth = w;
continue; continue;
} }
out.add(cur.toString()); out.add(cur.toString());
@@ -251,13 +249,13 @@ final class DrawMlText {
/** Ширина строки в тех же единицах, что и размер шрифта. */ /** Ширина строки в тех же единицах, что и размер шрифта. */
static double textWidth(String text, Style style, FontRenderContext frc) { static double textWidth(String text, Style style, FontRenderContext frc) {
return new java.awt.font.TextLayout(text, fontFor(style), frc).getAdvance(); return new TextLayout(text, fontFor(style), frc).getAdvance();
} }
/** Высота строки (ascent+descent+leading) для стиля. */ /** Высота строки (ascent+descent+leading) для стиля. */
static double textHeight(Style style, FontRenderContext frc) { static double textHeight(Style style, FontRenderContext frc) {
Font f = fontFor(style); Font f = fontFor(style);
java.awt.font.TextLayout tl = new java.awt.font.TextLayout("Xpg", f, frc); TextLayout tl = new TextLayout("Xpg", f, frc);
return tl.getAscent() + tl.getDescent() + tl.getLeading(); return tl.getAscent() + tl.getDescent() + tl.getLeading();
} }
} }
@@ -63,7 +63,7 @@ import java.util.Set;
*/ */
public final class DrawingPreRenderer { public final class DrawingPreRenderer {
private static final Logger log = LoggerFactory.getLogger(DrawingPreRenderer.class); private static final Logger LOG = LoggerFactory.getLogger(DrawingPreRenderer.class);
private static final String CHART_ELEMENT = private static final String CHART_ELEMENT =
"{http://schemas.openxmlformats.org/drawingml/2006/chart}chart"; "{http://schemas.openxmlformats.org/drawingml/2006/chart}chart";
@@ -185,7 +185,7 @@ public final class DrawingPreRenderer {
continue; continue;
} }
if (cx <= 0 || cy <= 0) { if (cx <= 0 || cy <= 0) {
log.warn("drawing без wp:extent — оставлен как есть"); LOG.warn("drawing без wp:extent — оставлен как есть");
continue; continue;
} }
GraphicData gd = graphic.getGraphicData(); GraphicData gd = graphic.getGraphicData();
@@ -208,7 +208,7 @@ public final class DrawingPreRenderer {
} }
continue; // настройка выключена — drawing остаётся в docx как есть continue; // настройка выключена — drawing остаётся в docx как есть
} }
img = renderChart(part, (CTRelId) el.getValue(), pkg, colors, cx, cy); img = renderChart(part, (CTRelId) el.getValue(), colors, cx, cy);
label = "график"; label = "график";
} else if (DIAGRAM_ELEMENT.equals(name)) { } else if (DIAGRAM_ELEMENT.equals(name)) {
if (!options.renderSmartArt()) { if (!options.renderSmartArt()) {
@@ -217,13 +217,13 @@ public final class DrawingPreRenderer {
} }
continue; continue;
} }
img = renderDiagram(part, (CTRelIds) el.getValue(), pkg, colors, cx, cy); img = renderDiagram(part, (CTRelIds) el.getValue(), colors, cx, cy);
label = "SmartArt"; label = "SmartArt";
} }
} }
if (img == null) { if (img == null) {
if (label != null) { if (label != null) {
log.warn("не удалось отрендерить {} — объект удалён из документа", label); LOG.warn("не удалось отрендерить {} — объект удалён из документа", label);
gd.getAny().clear(); gd.getAny().clear();
} }
continue; continue;
@@ -232,28 +232,28 @@ public final class DrawingPreRenderer {
} }
} }
private static BufferedImage renderChart(Part part, CTRelId ref, WordprocessingMLPackage pkg, private static BufferedImage renderChart(Part part, CTRelId ref,
DrawMlColor colors, long cx, long cy) { DrawMlColor colors, long cx, long cy) {
Part target = resolve(part, ref.getId()); Part target = resolve(part, ref.getId());
if (!(target instanceof JaxbXmlPart<?> jp) || !(jp.getJaxbElement() instanceof CTChartSpace space)) { if (!(target instanceof JaxbXmlPart<?> jp) || !(jp.getJaxbElement() instanceof CTChartSpace space)) {
log.warn("chart-часть не найдена по r:id={}", ref.getId()); LOG.warn("chart-часть не найдена по r:id={}", ref.getId());
return null; return null;
} }
try { try {
ChartSpec spec = ChartSpec.parse(space, colors); ChartSpec spec = ChartSpec.parse(space, colors);
return ChartRenderer.render(spec, cx / 12700.0, cy / 12700.0, colors); return ChartRenderer.render(spec, cx / 12700.0, cy / 12700.0, colors);
} catch (RuntimeException e) { } catch (RuntimeException e) {
log.warn("рендер графика r:id={} упал: {}", ref.getId(), e.toString()); LOG.warn("рендер графика r:id={} упал: {}", ref.getId(), e.toString());
return null; return null;
} }
} }
private static BufferedImage renderDiagram(Part part, CTRelIds refs, WordprocessingMLPackage pkg, private static BufferedImage renderDiagram(Part part, CTRelIds refs,
DrawMlColor colors, long cx, long cy) { DrawMlColor colors, long cx, long cy) {
Part drawingPart = diagramDrawingPart(part); Part drawingPart = diagramDrawingPart(part);
if (!(drawingPart instanceof JaxbXmlPart<?> jp) if (!(drawingPart instanceof JaxbXmlPart<?> jp)
|| !(jp.getJaxbElement() instanceof CTDrawing drawing)) { || !(jp.getJaxbElement() instanceof CTDrawing drawing)) {
log.warn("dsp:drawing (SmartArt) не найден — схема пропущена"); LOG.warn("dsp:drawing (SmartArt) не найден — схема пропущена");
return null; return null;
} }
CTDataModel data = null; CTDataModel data = null;
@@ -264,7 +264,7 @@ public final class DrawingPreRenderer {
try { try {
return SmartArtRenderer.render(drawing, data, colors, cx / 12700.0, cy / 12700.0); return SmartArtRenderer.render(drawing, data, colors, cx / 12700.0, cy / 12700.0);
} catch (RuntimeException e) { } catch (RuntimeException e) {
log.warn("рендер SmartArt упал: {}", e.toString()); LOG.warn("рендер SmartArt упал: {}", e.toString());
return null; return null;
} }
} }
@@ -306,19 +306,19 @@ public final class DrawingPreRenderer {
ImageIO.write(img, "png", bos); ImageIO.write(img, "png", bos);
png = bos.toByteArray(); png = bos.toByteArray();
} catch (Exception e) { } catch (Exception e) {
log.warn("PNG не собран: {}", e.toString()); LOG.warn("PNG не собран: {}", e.toString());
return; return;
} }
BinaryPartAbstractImage imagePart; BinaryPartAbstractImage imagePart;
try { try {
imagePart = BinaryPartAbstractImage.createImagePart(pkg, part, png); imagePart = BinaryPartAbstractImage.createImagePart(pkg, part, png);
} catch (Exception e) { } catch (Exception e) {
log.warn("ImagePart не создан: {}", e.toString()); LOG.warn("ImagePart не создан: {}", e.toString());
return; return;
} }
String relId = relIdFor(part, imagePart); String relId = relIdFor(part, imagePart);
if (relId == null) { if (relId == null) {
log.warn("r:id для ImagePart {} не найден", imagePart.getPartName()); LOG.warn("r:id для ImagePart {} не найден", imagePart.getPartName());
return; return;
} }
@@ -84,7 +84,7 @@ final class PiePainter {
double sweep = 360.0 * v / total; double sweep = 360.0 * v / total;
Color fill = s.fillAt(i, palette); Color fill = s.fillAt(i, palette);
Color outline = s.outlineNoFill ? null Color outline = s.outlineNoFill ? null
: (s.outlineColor != null ? s.outlineColor : Color.WHITE); : s.outlineColor != null ? s.outlineColor : Color.WHITE;
double ow = s.outlineWidth > 0 ? s.outlineWidth : 1.0; double ow = s.outlineWidth > 0 ? s.outlineWidth : 1.0;
slices.add(new Slice(angle, sweep, fill, outline, ow)); slices.add(new Slice(angle, sweep, fill, outline, ow));
angle += sweep; angle += sweep;
@@ -48,13 +48,13 @@ final class PrstGeomShapes {
return new Shape(new Area(new Ellipse2D.Double(x, y, w, h)), null); return new Shape(new Area(new Ellipse2D.Double(x, y, w, h)), null);
} }
case "gear6", "gear9" -> { case "gear6", "gear9" -> {
int teeth = p.equals("gear6") ? 6 : 9; int teeth = "gear6".equals(p) ? 6 : 9;
return gear(x, y, w, h, teeth); return gear(x, y, w, h, teeth);
} }
case "circularArrow", "leftCircularArrow", "rightCircularArrow", case "circularArrow", "leftCircularArrow", "rightCircularArrow",
"curvedRightArrow", "curvedLeftArrow" -> { "curvedRightArrow", "curvedLeftArrow" -> {
return circularArrow(x, y, w, h, adj, return circularArrow(x, y, w, h, adj,
p.equals("leftCircularArrow") || p.equals("curvedLeftArrow")); "leftCircularArrow".equals(p) || "curvedLeftArrow".equals(p));
} }
default -> { default -> {
return new Shape(new Area(new Rectangle2D.Double(x, y, w, h)), null); return new Shape(new Area(new Rectangle2D.Double(x, y, w, h)), null);
@@ -126,8 +126,8 @@ final class PrstGeomShapes {
a1 += 2 * Math.PI; a1 += 2 * Math.PI;
} }
Path2D path = new Path2D.Double(); Path2D path = new Path2D.Double();
arcSegment(path, cx, cy, rOuter, a0, a1, true); arcSegment(path, cx, cy, rOuter, a0, a1);
arcSegment(path, cx, cy, rInner, a1, a0, false); arcSegment(path, cx, cy, rInner, a1, a0);
path.closePath(); path.closePath();
Area area = new Area(path); Area area = new Area(path);
@@ -152,7 +152,7 @@ final class PrstGeomShapes {
} }
private static void arcSegment(Path2D path, double cx, double cy, double r, private static void arcSegment(Path2D path, double cx, double cy, double r,
double a0, double a1, boolean forward) { double a0, double a1) {
int steps = Math.max(2, (int) (Math.abs(a1 - a0) / Math.toRadians(4))); int steps = Math.max(2, (int) (Math.abs(a1 - a0) / Math.toRadians(4)));
for (int i = 0; i <= steps; i++) { for (int i = 0; i <= steps; i++) {
double t = a0 + (a1 - a0) * i / steps; double t = a0 + (a1 - a0) * i / steps;
@@ -38,7 +38,7 @@ final class RgbHsl {
} }
static Color fromHsl(double h, double s, double l) { static Color fromHsl(double h, double s, double l) {
double hh = (((h % 360) + 360) % 360) / 360.0; double hh = (h % 360 + 360) % 360 / 360.0;
double ss = Math.max(0, Math.min(1, s)); double ss = Math.max(0, Math.min(1, s));
double ll = Math.max(0, Math.min(1, l)); double ll = Math.max(0, Math.min(1, l));
double r, g, b; double r, g, b;
@@ -8,12 +8,10 @@ import org.docx4j.dml.CTPositiveSize2D;
import org.docx4j.dml.CTPresetGeometry2D; import org.docx4j.dml.CTPresetGeometry2D;
import org.docx4j.dml.CTShapeProperties; import org.docx4j.dml.CTShapeProperties;
import org.docx4j.dml.CTShapeStyle; import org.docx4j.dml.CTShapeStyle;
import org.docx4j.dml.CTTextBody;
import org.docx4j.dml.CTTransform2D; import org.docx4j.dml.CTTransform2D;
import org.docx4j.dml.diagram.CTCxn; import org.docx4j.dml.diagram.CTCxn;
import org.docx4j.dml.diagram.CTDataModel; import org.docx4j.dml.diagram.CTDataModel;
import org.docx4j.dml.diagram.STCxnType; import org.docx4j.dml.diagram.STCxnType;
import org.docx4j.dml.diagram.CTElemPropSet;
import org.docx4j.dml.diagram.CTPt; import org.docx4j.dml.diagram.CTPt;
import org.docx4j.dml.diagram2008.CTDrawing; import org.docx4j.dml.diagram2008.CTDrawing;
import org.docx4j.dml.diagram2008.CTShape; import org.docx4j.dml.diagram2008.CTShape;
@@ -187,7 +187,7 @@ final class Surface3dPainter {
Fit fit = new Fit(scale, scale, offX, offY); Fit fit = new Fit(scale, scale, offX, offY);
// 3. Пол, дальняя стенка и их сетки — под поверхностью // 3. Пол, дальняя стенка и их сетки — под поверхностью
drawFloor(g, spec, floor, valueAnchors, nCat, nSer, lo, hi, unit, span, drawFloor(g, spec, floor, nCat, nSer, lo, hi, unit, span,
rotX, rotY, depthScale, heightScale, persp, fit); rotX, rotY, depthScale, heightScale, persp, fit);
// 4. Грани: два треугольника на ячейку, каждый разрезан по // 4. Грани: два треугольника на ячейку, каждый разрезан по
@@ -379,7 +379,7 @@ final class Surface3dPainter {
/** Сетка пола и дальней стенки; рисуется до поверхности. */ /** Сетка пола и дальней стенки; рисуется до поверхности. */
private static void drawFloor(Graphics2D g, ChartSpec spec, Node[] floor, private static void drawFloor(Graphics2D g, ChartSpec spec, Node[] floor,
List<Node> valueAnchors, int nCat, int nSer, int nCat, int nSer,
double lo, double hi, double unit, double span, double lo, double hi, double unit, double span,
double rotX, double rotY, double depthScale, double rotX, double rotY, double depthScale,
double heightScale, double persp, double heightScale, double persp,
@@ -0,0 +1,259 @@
package ru.pjandro.wordpdf;
import org.apache.pdfbox.Loader;
import org.apache.pdfbox.cos.COSName;
import org.apache.pdfbox.pdmodel.PDDocument;
import org.apache.pdfbox.pdmodel.PDPage;
import org.apache.pdfbox.pdmodel.PDResources;
import org.apache.pdfbox.pdmodel.font.PDFont;
import org.apache.pdfbox.pdmodel.graphics.PDXObject;
import org.apache.pdfbox.pdmodel.graphics.image.PDImageXObject;
import org.apache.pdfbox.text.PDFTextStripper;
import org.apache.pdfbox.text.TextPosition;
import org.junit.jupiter.api.Test;
import java.io.IOException;
import java.io.InputStream;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.ArrayList;
import java.util.IdentityHashMap;
import java.util.List;
import java.util.Set;
import java.util.TreeSet;
import static org.junit.jupiter.api.Assertions.*;
/**
* Конвертация бинарного .doc (Word 97-2003, OLE2) через ветку
* {@code internal.DocToPdfRenderer} (POI HWPF -> XSL-FO -> FOP).
* Фикстура — закоммиченный samples/legacy-doc.doc (создан Word'ом,
* POI .doc не пишет — не перезагенерировать).
*
* <p>Ассерты только на фактическое содержимое фикстуры и на раны,
* ушедшие в Tinos (аналог Times New Roman): текст ран, ушедших в
* DejaVu-fallback, PDFBox на машинах с установленным DejaVu «чинит»
* по системному шрифту и извлекает «#» — такие строки не ассертятся
* (экзотические глифы фикстуры — принятая деградация .doc-ветки:
* аналога GlyphCoverageNormalizer здесь нет).
*/
class DocToPdfTest {
private static byte[] sampleBytes(String name) throws IOException {
try (InputStream in = DocToPdfTest.class.getClassLoader()
.getResourceAsStream("samples/" + name)) {
assertNotNull(in, "Нет тестового документа: samples/" + name);
return in.readAllBytes();
}
}
private static Path convertPdf(byte[] docBytes, String title) throws IOException {
Path out = Files.createTempFile("converted-doc-", ".pdf");
Files.write(out, WordPdfConverter.convert(docBytes, title));
return out;
}
private static String norm(String s) {
return s.replaceAll("\\s+", "");
}
private static String pdfPageText(Path pdf, int page) throws IOException {
try (PDDocument doc = Loader.loadPDF(pdf.toFile())) {
PDFTextStripper stripper = new PDFTextStripper();
stripper.setStartPage(page);
stripper.setEndPage(page);
return stripper.getText(doc);
}
}
/** Строка страницы: базовая линия y (от верха страницы, PDFBox YDirAdj) и текст. */
private record Line(float y, String text) {
}
/** Непустые строки страницы с базовыми линиями (порядок по позиции). */
private static List<Line> pageLines(Path pdf, int page) throws IOException {
List<Line> lines = new ArrayList<>();
try (PDDocument doc = Loader.loadPDF(pdf.toFile())) {
PDFTextStripper stripper = new PDFTextStripper() {
@Override
protected void writeString(String text, List<TextPosition> textPositions)
throws IOException {
super.writeString(text, textPositions);
if (!textPositions.isEmpty() && !norm(text).isEmpty()) {
lines.add(new Line(textPositions.get(0).getYDirAdj(), text));
}
}
};
stripper.setStartPage(page);
stripper.setEndPage(page);
stripper.setSortByPosition(true);
stripper.getText(doc);
}
return lines;
}
/** y базовой линии первой строки, содержащей needle (после norm); null если нет. */
private static Float lineY(Path pdf, int page, String needle) throws IOException {
String n = norm(needle);
for (Line l : pageLines(pdf, page)) {
if (norm(l.text()).contains(n)) {
return l.y();
}
}
return null;
}
/** Максимум y по всем непустым строкам страницы (самая нижняя базовая линия). */
private static float maxLineY(Path pdf, int page) throws IOException {
float max = Float.MIN_VALUE;
for (Line l : pageLines(pdf, page)) {
max = Math.max(max, l.y());
}
return max;
}
/** BaseFont-имена вшитых шрифтов PDF (например "EAAAAA+Tinos-Bold"). */
private static Set<String> embeddedFontNames(Path pdf) throws IOException {
Set<String> names = new TreeSet<>();
try (PDDocument doc = Loader.loadPDF(pdf.toFile())) {
for (PDPage page : doc.getPages()) {
PDResources res = page.getResources();
for (COSName name : res.getFontNames()) {
PDFont font = res.getFont(name);
if (font != null) {
names.add(font.getName());
}
}
}
}
return names;
}
/** Число уникальных Image XObject в PDF (наследованные ресурсы — один объект). */
private static int imageCount(Path pdf) throws IOException {
Set<PDXObject> seen = java.util.Collections.newSetFromMap(new IdentityHashMap<>());
try (PDDocument doc = Loader.loadPDF(pdf.toFile())) {
for (PDPage page : doc.getPages()) {
PDResources res = page.getResources();
for (COSName name : res.getXObjectNames()) {
PDXObject xo = res.getXObject(name);
if (xo instanceof PDImageXObject) {
seen.add(xo);
}
}
}
}
return seen.size();
}
/**
* .doc конвертируется в PDF: текст кириллический, таблицы и картинки
* на месте, шрифт — встроенный Tinos (аналог Times New Roman),
* базовый Helvetica не используется.
* Регрессия — WordPdfConverter#isOle2 + internal.DocToPdfRenderer,
* фикстура samples/legacy-doc.doc.
*/
@Test
void legacyDoc_convertsToPdf() throws Exception {
Path pdf = convertPdf(sampleBytes("legacy-doc.doc"), "testDoc");
String text;
int pages;
try (PDDocument doc = Loader.loadPDF(pdf.toFile())) {
pages = doc.getNumberOfPages();
text = norm(new PDFTextStripper().getText(doc));
}
assertTrue(pages >= 10, "страниц меньше ожидаемого: " + pages);
assertTrue(text.contains("Предметдоговора"), "нет заголовка раздела");
assertTrue(text.contains("Договорарендыпомещения"), "нет заголовка");
for (String font : embeddedFontNames(pdf)) {
assertFalse(font.contains("Helvetica"), "базовый шрифт в PDF: " + font);
}
assertTrue(embeddedFontNames(pdf).stream().anyMatch(n -> n.contains("Tinos")),
"нет Tinos (аналога Times New Roman): " + embeddedFontNames(pdf));
assertTrue(imageCount(pdf) >= 1, "картинок нет");
}
/**
* Колонтитулы, которых POI в FO не пишет, дописываются в FO-DOM:
* текст odd-footer («Нижний колонтитул») и номер страницы из PAGE-поля
* на каждой странице.
* Регрессия — DocToPdfRenderer#injectHeadersAndFooters,
* фикстура samples/legacy-doc.doc.
*/
@Test
void legacyDoc_footersCarryPageNumbers() throws Exception {
Path pdf = convertPdf(sampleBytes("legacy-doc.doc"), "testDoc");
String page1 = norm(pdfPageText(pdf, 1));
String page5 = norm(pdfPageText(pdf, 5));
assertTrue(page5.contains("Нижнийколонтитул"), "нет текста футера на стр. 5");
assertTrue(page1.startsWith("1"), "нет номера страницы на стр. 1: "
+ page1.substring(0, Math.min(20, page1.length())));
assertTrue(page5.contains("5"), "нет номера страницы на стр. 5");
}
/**
* Текст body не наезжает на области колонтитулов: заголовок первой
* строки лежит ниже header-региона (extent = верхнее поле 0.7875in =
* 56.7pt), под строкой футера ничего нет. Форк FOP не вычитает
* extent'ы регионов из body-области (area.Page = page-area минус
* собственные margin'ы region-body), поэтому разводка body и
* колонтитулов — только margin'ами region-body; их обнуление
* растягивает body на всю страницу, и текст лезет в колонтитулы.
* Регрессия — DocToPdfRenderer#injectHeadersAndFooters,
* фикстура samples/legacy-doc.doc.
*/
@Test
void legacyDoc_bodyClearsHeaderFooterRegions() throws Exception {
Path pdf = convertPdf(sampleBytes("legacy-doc.doc"), "testDoc");
Float titleY = lineY(pdf, 1, "Договор аренды");
assertNotNull(titleY, "нет заголовка на стр. 1");
assertTrue(titleY > 50f, "заголовок внутри header-региона: y=" + titleY);
Float footerY = lineY(pdf, 1, "Нижний колонтитул");
assertNotNull(footerY, "нет футера на стр. 1");
float lowest = maxLineY(pdf, 1);
assertTrue(lowest <= footerY + 1f,
"строка ниже футера: y=" + lowest + " > y футера " + footerY);
}
/**
* Кэш шрифтов FOP не пишется в текущий каталог: при непригодном user.home
* (контейнер без HOME) дефолт форка — файл ".fop" в CWD, а в образе /app
* не пишется non-root'ом => 500 на каждом .doc. Кэш отключён в renderFo.
* Регрессия — DocToPdfRenderer#renderFo, фикстура samples/legacy-doc.doc.
*/
@Test
void legacyDoc_fontCacheNotWrittenToWorkingDir() throws Exception {
String savedHome = System.getProperty("user.home");
Path stray = Path.of(".fop");
Files.deleteIfExists(stray);
System.setProperty("user.home", "/no-such-home-" + System.nanoTime());
try {
convertPdf(sampleBytes("legacy-doc.doc"), "testDoc");
assertFalse(Files.exists(stray), "FOP записал кэш шрифтов .fop в рабочий каталог");
} finally {
if (savedHome == null) {
System.clearProperty("user.home");
} else {
System.setProperty("user.home", savedHome);
}
Files.deleteIfExists(stray);
}
}
/**
* OLE2-магик + мусор: и валидатор, и конвертер обязаны отвергнуть
* документ (не молча отдать пустой PDF).
* Регрессия — DocToPdfRenderer#render, WordPdfValidator#checkDocPageCountLightweight.
*/
@Test
void ole2Junk_rejected() {
byte[] junk = new byte[1024];
byte[] magic = {(byte) 0xD0, (byte) 0xCF, 0x11, (byte) 0xE0,
(byte) 0xA1, (byte) 0xB1, 0x1A, (byte) 0xE1};
System.arraycopy(magic, 0, junk, 0, magic.length);
assertThrows(ConversionException.class,
() -> WordPdfValidator.checkDocPageCountLightweight(junk));
assertThrows(ConversionException.class,
() -> WordPdfConverter.convert(junk, "junk"));
}
}
@@ -193,7 +193,7 @@ public final class SampleDocxGenerator {
// Размеры в EMU (1 px @ 96 dpi = 9525 EMU) // Размеры в EMU (1 px @ 96 dpi = 9525 EMU)
XWPFParagraph imgPara = doc.createParagraph(); XWPFParagraph imgPara = doc.createParagraph();
XWPFRun imgRun = imgPara.createRun(); XWPFRun imgRun = imgPara.createRun();
imgRun.addPicture(new java.io.ByteArrayInputStream(bos.toByteArray()), imgRun.addPicture(new ByteArrayInputStream(bos.toByteArray()),
PictureType.PNG, "test-image.png", PictureType.PNG, "test-image.png",
120 * 9525, 60 * 9525); 120 * 9525, 60 * 9525);
@@ -392,7 +392,7 @@ public final class SampleDocxGenerator {
java.util.zip.ZipEntry e; java.util.zip.ZipEntry e;
while ((e = zin.getNextEntry()) != null) { while ((e = zin.getNextEntry()) != null) {
byte[] data = zin.readAllBytes(); byte[] data = zin.readAllBytes();
if (e.getName().equals("word/document.xml")) { if ("word/document.xml".equals(e.getName())) {
String xml = new String(data, java.nio.charset.StandardCharsets.UTF_8); String xml = new String(data, java.nio.charset.StandardCharsets.UTF_8);
StringBuilder sb = new StringBuilder(xml.length() + 4096); StringBuilder sb = new StringBuilder(xml.length() + 4096);
int i = 0; int i = 0;
@@ -432,22 +432,38 @@ class WordPdfConverterTest {
@Test @Test
void invalidInputRejected() { void invalidInputRejected() {
assertThrows(ConversionException.class, () -> assertThrows(ValidationException.class, () ->
WordPdfConverter.convert(null, "x")); WordPdfConverter.convert(null, "x"));
} }
/** /**
* Лимит на размер входа: больше 20 MiB — отказ до рендера. * Лимит на размер входа: больше 5 MiB — отказ до рендера.
*/ */
@Test @Test
void inputTooLarge() { void inputTooLarge() {
byte[] tooBig = new byte[(int) WordPdfSettings.MAX_INPUT_BYTES + 1]; byte[] tooBig = new byte[(int) WordPdfSettings.MAX_INPUT_BYTES + 1];
ConversionException ex = assertThrows(ConversionException.class, () -> ValidationException ex = assertThrows(ValidationException.class, () ->
WordPdfConverter.convert(tooBig, "too-big")); WordPdfConverter.convert(tooBig, "too-big"));
assertTrue(ex.getMessage().contains("20 МБ"), assertTrue(ex.getMessage().contains("5 МБ"),
"сообщение должно упоминать лимит: " + ex.getMessage()); "сообщение должно упоминать лимит: " + ex.getMessage());
} }
/**
* Вход без подписи контейнера (ни zip, ни OLE2) — отказ как некорректный
* вход (ValidationException), а не ошибка рендера: вход конвертера
* прогоняет тот же {@link WordPdfValidator#validate(byte[], ConvertOptions)},
* что и приложение до очереди. Регрессия —
* WordPdfValidatorTest#validate_neitherDocxNorDoc.
*/
@Test
void inputNotAZip_rejectedBeforeRender() {
byte[] junk = {1, 2, 3, 4, 5, 6, 7, 8};
ValidationException ex = assertThrows(ValidationException.class, () ->
WordPdfConverter.convert(junk, "junk"));
assertTrue(ex.getMessage().contains("не похоже на .docx или .doc"),
"сообщение должно упоминать подписи контейнера: " + ex.getMessage());
}
/** /**
* Лимит размера переопределяется {@link ConvertOptions} на вызов: * Лимит размера переопределяется {@link ConvertOptions} на вызов:
* maxBytes=1000 отсекает даже маленький документ до рендера, сообщение * maxBytes=1000 отсекает даже маленький документ до рендера, сообщение
@@ -455,7 +471,7 @@ class WordPdfConverterTest {
*/ */
@Test @Test
void limitsOverriddenByOptions() throws Exception { void limitsOverriddenByOptions() throws Exception {
ConversionException ex = assertThrows(ConversionException.class, () -> ValidationException ex = assertThrows(ValidationException.class, () ->
WordPdfConverter.convert(sampleBytes("ru-plain.docx"), "x", WordPdfConverter.convert(sampleBytes("ru-plain.docx"), "x",
new ConvertOptions(true, true, false, false, 1000, WordPdfSettings.MAX_PAGES))); new ConvertOptions(true, true, false, false, 1000, WordPdfSettings.MAX_PAGES)));
assertTrue(ex.getMessage().contains("1000 байт"), assertTrue(ex.getMessage().contains("1000 байт"),
@@ -469,7 +485,7 @@ class WordPdfConverterTest {
*/ */
@Test @Test
void tooManyPages() { void tooManyPages() {
ConversionException ex = assertThrows(ConversionException.class, () -> ValidationException ex = assertThrows(ValidationException.class, () ->
WordPdfConverter.convert( WordPdfConverter.convert(
sampleBytes("too-many-pages.docx"), "too-many-pages", sampleBytes("too-many-pages.docx"), "too-many-pages",
new ConvertOptions(true, true, false, false, WordPdfSettings.MAX_INPUT_BYTES, 100))); new ConvertOptions(true, true, false, false, WordPdfSettings.MAX_INPUT_BYTES, 100)));
@@ -486,7 +502,7 @@ class WordPdfConverterTest {
*/ */
@Test @Test
void staleCachePageCountRejectedBeforeRender() { void staleCachePageCountRejectedBeforeRender() {
ConversionException ex = assertThrows(ConversionException.class, () -> ValidationException ex = assertThrows(ValidationException.class, () ->
WordPdfConverter.convert(sampleBytes("stale-cache.docx"), "stale-cache", WordPdfConverter.convert(sampleBytes("stale-cache.docx"), "stale-cache",
new ConvertOptions(true, true, false, false, WordPdfSettings.MAX_INPUT_BYTES, 100))); new ConvertOptions(true, true, false, false, WordPdfSettings.MAX_INPUT_BYTES, 100)));
assertTrue(ex.getMessage().contains("100"), assertTrue(ex.getMessage().contains("100"),
@@ -4,7 +4,6 @@ import org.apache.poi.xwpf.usermodel.BreakType;
import org.apache.poi.xwpf.usermodel.XWPFDocument; import org.apache.poi.xwpf.usermodel.XWPFDocument;
import org.apache.poi.xwpf.usermodel.XWPFParagraph; import org.apache.poi.xwpf.usermodel.XWPFParagraph;
import org.apache.poi.xwpf.usermodel.XWPFTable; import org.apache.poi.xwpf.usermodel.XWPFTable;
import org.docx4j.openpackaging.packages.WordprocessingMLPackage;
import org.junit.jupiter.api.Test; import org.junit.jupiter.api.Test;
import java.io.ByteArrayOutputStream; import java.io.ByteArrayOutputStream;
@@ -16,7 +15,7 @@ import static org.junit.jupiter.api.Assertions.*;
/** /**
* Юнит-тесты валидатора: размер и число страниц * Юнит-тесты валидатора: размер и число страниц
* (byte[] и уже загруженный пакет). * (byte[], lightweight-путь zip/StAX).
*/ */
class WordPdfValidatorTest { class WordPdfValidatorTest {
@@ -42,15 +41,15 @@ class WordPdfValidatorTest {
@Test @Test
void checkInput_bytesOverLimit() { void checkInput_bytesOverLimit() {
byte[] big = new byte[(int) WordPdfSettings.MAX_INPUT_BYTES + 1]; byte[] big = new byte[(int) WordPdfSettings.MAX_INPUT_BYTES + 1];
ConversionException ex = assertThrows(ConversionException.class, ValidationException ex = assertThrows(ValidationException.class,
() -> WordPdfValidator.checkInput(big)); () -> WordPdfValidator.checkInput(big));
assertTrue(ex.getMessage().contains("20 МБ"), assertTrue(ex.getMessage().contains("5 МБ"),
"сообщение должно упоминать лимит: " + ex.getMessage()); "сообщение должно упоминать лимит: " + ex.getMessage());
} }
@Test @Test
void checkInput_bytesNull() { void checkInput_bytesNull() {
assertThrows(ConversionException.class, assertThrows(ValidationException.class,
() -> WordPdfValidator.checkInput((byte[]) null)); () -> WordPdfValidator.checkInput((byte[]) null));
} }
@@ -61,119 +60,58 @@ class WordPdfValidatorTest {
@Test @Test
void checkInput_customLimit() { void checkInput_customLimit() {
assertDoesNotThrow(() -> WordPdfValidator.checkInput(new byte[10], 100)); assertDoesNotThrow(() -> WordPdfValidator.checkInput(new byte[10], 100));
ConversionException ex = assertThrows(ConversionException.class, ValidationException ex = assertThrows(ValidationException.class,
() -> WordPdfValidator.checkInput(new byte[11], 10)); () -> WordPdfValidator.checkInput(new byte[11], 10));
assertTrue(ex.getMessage().contains("10 байт"), assertTrue(ex.getMessage().contains("10 байт"),
"сообщение должно упоминать переданный лимит: " + ex.getMessage()); "сообщение должно упоминать переданный лимит: " + ex.getMessage());
} }
@Test // ---- lightweight (zip/StAX, без docx4j) ----
void checkPageCount_pkgWithinLimit() throws Exception {
byte[] bytes = docxWithPageBreaks(5); // 1 + 5 = 6 страниц по оценке
WordprocessingMLPackage pkg = WordprocessingMLPackage.load(
new java.io.ByteArrayInputStream(bytes));
assertDoesNotThrow(() -> WordPdfValidator.checkPageCount(pkg));
}
@Test @Test
void checkPageCount_pkgOverLimit() throws Exception { void checkPageCount_bytesWithinLimit() throws Exception {
byte[] bytes = docxWithPageBreaks(120); // 1 + 120 = 121 byte[] bytes = docxWithPageBreaks(5);
WordprocessingMLPackage pkg = WordprocessingMLPackage.load( assertDoesNotThrow(() -> WordPdfValidator.checkPageCount(bytes));
new java.io.ByteArrayInputStream(bytes));
ConversionException ex = assertThrows(ConversionException.class,
() -> WordPdfValidator.checkPageCount(pkg, 100));
assertTrue(ex.getMessage().contains("100"),
"сообщение должно упоминать лимит: " + ex.getMessage());
} }
@Test @Test
void checkPageCount_bytesOverLimit() throws Exception { void checkPageCount_bytesOverLimit() throws Exception {
byte[] bytes = docxWithPageBreaks(120); byte[] bytes = docxWithPageBreaks(120);
ConversionException ex = assertThrows(ConversionException.class, ValidationException ex = assertThrows(ValidationException.class,
() -> WordPdfValidator.checkPageCount(bytes, 100)); () -> WordPdfValidator.checkPageCount(bytes, 100));
assertTrue(ex.getMessage().contains("100"), assertTrue(ex.getMessage().contains("100"),
"сообщение должно упоминать лимит: " + ex.getMessage()); "сообщение должно упоминать лимит: " + ex.getMessage());
} }
/**
* Явный лимит страниц для загруженного пакета: docx с 2 разрывами
* (оценка 3) отсекается maxPages=1 и проходит при maxPages=1000.
*/
@Test
void checkPageCount_pkg_customLimit() throws Exception {
byte[] bytes = docxWithPageBreaks(2);
WordprocessingMLPackage pkg = WordprocessingMLPackage.load(
new java.io.ByteArrayInputStream(bytes));
ConversionException ex = assertThrows(ConversionException.class,
() -> WordPdfValidator.checkPageCount(pkg, 1));
assertTrue(ex.getMessage().contains("длиннее 1 страниц"),
"сообщение должно упоминать переданный лимит: " + ex.getMessage());
assertDoesNotThrow(() -> WordPdfValidator.checkPageCount(pkg, 1000));
}
@Test
void checkPageCount_bytesNull() {
assertThrows(ConversionException.class,
() -> WordPdfValidator.checkPageCount((byte[]) null));
}
@Test
void checkPageCount_pkgNull() {
assertThrows(ConversionException.class,
() -> WordPdfValidator.checkPageCount((WordprocessingMLPackage) null));
}
// ---- lightweight (zip/StAX, без docx4j) ----
@Test
void checkPageCountLightweight_bytesWithinLimit() throws Exception {
byte[] bytes = docxWithPageBreaks(5);
assertDoesNotThrow(() -> WordPdfValidator.checkPageCountLightweight(bytes));
}
@Test
void checkPageCountLightweight_bytesOverLimit() throws Exception {
byte[] bytes = docxWithPageBreaks(120);
ConversionException ex = assertThrows(ConversionException.class,
() -> WordPdfValidator.checkPageCountLightweight(bytes, 100));
assertTrue(ex.getMessage().contains("100"),
"сообщение должно упоминать лимит: " + ex.getMessage());
}
/** /**
* Явный лимит страниц lightweight-пути: те же 3 страницы * Явный лимит страниц lightweight-пути: те же 3 страницы
* (2 разрыва) отсекаются maxPages=1 и проходят при maxPages=1000. * (2 разрыва) отсекаются maxPages=1 и проходят при maxPages=1000.
*/ */
@Test @Test
void checkPageCountLightweight_customLimit() throws Exception { void checkPageCount_customLimit() throws Exception {
byte[] bytes = docxWithPageBreaks(2); byte[] bytes = docxWithPageBreaks(2);
ConversionException ex = assertThrows(ConversionException.class, ValidationException ex = assertThrows(ValidationException.class,
() -> WordPdfValidator.checkPageCountLightweight(bytes, 1)); () -> WordPdfValidator.checkPageCount(bytes, 1));
assertTrue(ex.getMessage().contains("длиннее 1 страниц"), assertTrue(ex.getMessage().contains("длиннее 1 страниц"),
"сообщение должно упоминать переданный лимит: " + ex.getMessage()); "сообщение должно упоминать переданный лимит: " + ex.getMessage());
assertDoesNotThrow(() -> WordPdfValidator.checkPageCountLightweight(bytes, 1000)); assertDoesNotThrow(() -> WordPdfValidator.checkPageCount(bytes, 1000));
} }
/**
* Точная граница лимита lightweight-пути: 99 разрывов = 100 страниц
* (проходит), 100/101 = 101/102 (отказ с оценкой «не менее 1+breaks»).
*/
@Test @Test
void checkPageCountLightweight_agreesWithJaxbPath() throws Exception { void checkPageCount_limitBoundary() throws Exception {
// на фикстурах без кэша Pages оба пути обязаны совпадать,
// включая границу лимита: 99 разрывов = 100 страниц (проходит),
// 100/101 = 101/102 (отказ)
for (int breaks : new int[]{0, 3, 99, 100, 101}) { for (int breaks : new int[]{0, 3, 99, 100, 101}) {
byte[] bytes = docxWithPageBreaks(breaks); byte[] bytes = docxWithPageBreaks(breaks);
WordprocessingMLPackage pkg = WordprocessingMLPackage.load(
new java.io.ByteArrayInputStream(bytes));
int jaxb = WordPdfValidator.pageCountOf(pkg);
// lightweight-путь приватный; проверяем через границу лимита:
// 1+breaks совпадает с оценкой JAXB
assertEquals(1 + breaks, jaxb, "JAXB-оценка для " + breaks + " разрывов");
if (breaks < 100) { if (breaks < 100) {
assertDoesNotThrow(() -> WordPdfValidator.checkPageCountLightweight(bytes, 100)); assertDoesNotThrow(() -> WordPdfValidator.checkPageCount(bytes, 100));
} else { } else {
ConversionException ex = assertThrows(ConversionException.class, ValidationException ex = assertThrows(ValidationException.class,
() -> WordPdfValidator.checkPageCountLightweight(bytes, 100)); () -> WordPdfValidator.checkPageCount(bytes, 100));
assertTrue(ex.getMessage().contains("не менее " + (1 + breaks)), assertTrue(ex.getMessage().contains("не менее " + (1 + breaks)),
"оценка lightweight должна совпадать с JAXB: " + ex.getMessage()); "оценка = 1 + число разрывов: " + ex.getMessage());
} }
} }
} }
@@ -186,10 +124,9 @@ class WordPdfValidatorTest {
* 101 страница, отказ (старый код считал «все минус одна» без * 101 страница, отказ (старый код считал «все минус одна» без
* учёта типа: 101−1=100 и пропускал). Случай B: 101 * учёта типа: 101−1=100 и пропускал). Случай B: 101
* {@code continuous} + финальная {@code nextPage} — 1 страница, * {@code continuous} + финальная {@code nextPage} — 1 страница,
* проходит (старый код раздувал до 102 и отвергал). В JAXB-модели * проходит (старый код раздувал до 102 и отвергал); разрывы в
* body-direct sectPr не видны (docx4j оставляет только финальную * колонтитулах только усиливают нижнюю оценку — расхождение с
* в {@code body.getSectPr()}, {@code getContent()} пуст), поэтому * точным числом страниц здесь — допустимое завышение.
* расхождение lightweight здесь — допустимое завышение.
* Регрессия — WordPdfValidator#scanDocument. * Регрессия — WordPdfValidator#scanDocument.
*/ */
@Test @Test
@@ -200,8 +137,8 @@ class WordPdfValidatorTest {
} }
typesA.add("continuous"); // финальная секция — непрерывная typesA.add("continuous"); // финальная секция — непрерывная
byte[] overLimit = docxWithBodySections(typesA); byte[] overLimit = docxWithBodySections(typesA);
ConversionException exLwA = assertThrows(ConversionException.class, ValidationException exLwA = assertThrows(ValidationException.class,
() -> WordPdfValidator.checkPageCountLightweight(overLimit, 100)); () -> WordPdfValidator.checkPageCount(overLimit, 100));
assertTrue(exLwA.getMessage().contains("не менее 101"), assertTrue(exLwA.getMessage().contains("не менее 101"),
"оценка = 1 + 100 межсекционных nextPage: " + exLwA.getMessage()); "оценка = 1 + 100 межсекционных nextPage: " + exLwA.getMessage());
@@ -211,7 +148,7 @@ class WordPdfValidatorTest {
} }
typesB.add("nextPage"); // финальная секция typesB.add("nextPage"); // финальная секция
byte[] ok = docxWithBodySections(typesB); byte[] ok = docxWithBodySections(typesB);
assertDoesNotThrow(() -> WordPdfValidator.checkPageCountLightweight(ok, 100), assertDoesNotThrow(() -> WordPdfValidator.checkPageCount(ok, 100),
"continuous-границы не страницы"); "continuous-границы не страницы");
} }
@@ -227,12 +164,12 @@ class WordPdfValidatorTest {
ByteArrayOutputStream out = new ByteArrayOutputStream(); ByteArrayOutputStream out = new ByteArrayOutputStream();
try (java.util.zip.ZipInputStream zin = new java.util.zip.ZipInputStream( try (java.util.zip.ZipInputStream zin = new java.util.zip.ZipInputStream(
new java.io.ByteArrayInputStream(base)); new java.io.ByteArrayInputStream(base));
java.util.zip.ZipOutputStream zout = new java.util.zip.ZipOutputStream(out)) { ZipOutputStream zout = new ZipOutputStream(out)) {
java.util.zip.ZipEntry e; ZipEntry e;
while ((e = zin.getNextEntry()) != null) { while ((e = zin.getNextEntry()) != null) {
byte[] data = zin.readAllBytes(); byte[] data = zin.readAllBytes();
if (e.getName().equals("word/document.xml")) { if ("word/document.xml".equals(e.getName())) {
String xml = new String(data, java.nio.charset.StandardCharsets.UTF_8); String xml = new String(data, StandardCharsets.UTF_8);
StringBuilder sb = new StringBuilder(); StringBuilder sb = new StringBuilder();
for (String t : types) { for (String t : types) {
sb.append("<w:sectPr><w:type w:val=\"").append(t) sb.append("<w:sectPr><w:type w:val=\"").append(t)
@@ -250,9 +187,9 @@ class WordPdfValidatorTest {
xml = xml.substring(0, at) + "<w:body>" + sb + "</w:body>" xml = xml.substring(0, at) + "<w:body>" + sb + "</w:body>"
+ xml.substring(at + "<w:body/>".length()); + xml.substring(at + "<w:body/>".length());
} }
data = xml.getBytes(java.nio.charset.StandardCharsets.UTF_8); data = xml.getBytes(StandardCharsets.UTF_8);
} }
zout.putNextEntry(new java.util.zip.ZipEntry(e.getName())); zout.putNextEntry(new ZipEntry(e.getName()));
zout.write(data); zout.write(data);
zout.closeEntry(); zout.closeEntry();
} }
@@ -280,16 +217,10 @@ class WordPdfValidatorTest {
@Test @Test
void pageCount_staleCacheLosesToLastRenderedMarkers() throws Exception { void pageCount_staleCacheLosesToLastRenderedMarkers() throws Exception {
byte[] bytes = staleCacheFixture(); byte[] bytes = staleCacheFixture();
WordprocessingMLPackage pkg = WordprocessingMLPackage.load( ValidationException ex = assertThrows(ValidationException.class,
new java.io.ByteArrayInputStream(bytes)); () -> WordPdfValidator.checkPageCount(bytes, 100));
assertEquals(111, WordPdfValidator.pageCountOf(pkg), assertTrue(ex.getMessage().contains("не менее 111"),
"оценка = max(кэш 1, разрывы 1, маркеры 110+1)"); "оценка = max(кэш 1, разрывы 1, маркеры 110+1): " + ex.getMessage());
ConversionException ex = assertThrows(ConversionException.class,
() -> WordPdfValidator.checkPageCount(pkg, 100));
assertTrue(ex.getMessage().contains("100"), ex.getMessage());
// lightweight-путь обязан согласовать тот же отказ
assertThrows(ConversionException.class,
() -> WordPdfValidator.checkPageCountLightweight(bytes, 100));
} }
/** /**
@@ -307,24 +238,66 @@ class WordPdfValidatorTest {
p.createRun().setText("t" + i); p.createRun().setText("t" + i);
p.createRun().addBreak(BreakType.PAGE); p.createRun().addBreak(BreakType.PAGE);
} }
java.io.ByteArrayOutputStream bos = new java.io.ByteArrayOutputStream(); ByteArrayOutputStream bos = new ByteArrayOutputStream();
doc.write(bos); doc.write(bos);
bytes = bos.toByteArray(); bytes = bos.toByteArray();
} }
WordprocessingMLPackage pkg = WordprocessingMLPackage.load( ValidationException ex = assertThrows(ValidationException.class,
new java.io.ByteArrayInputStream(bytes));
assertEquals(121, WordPdfValidator.pageCountOf(pkg),
"разрывы в ячейке таблицы должны считаться");
assertThrows(ConversionException.class,
() -> WordPdfValidator.checkPageCount(bytes, 100)); () -> WordPdfValidator.checkPageCount(bytes, 100));
assertThrows(ConversionException.class, assertTrue(ex.getMessage().contains("не менее 121"),
() -> WordPdfValidator.checkPageCountLightweight(bytes, 100)); "120 разрывов в ячейке таблицы + первая страница: " + ex.getMessage());
} }
@Test @Test
void checkPageCountLightweight_bytesNull() { void checkPageCount_bytesNull() {
assertThrows(ConversionException.class, assertThrows(ValidationException.class,
() -> WordPdfValidator.checkPageCountLightweight((byte[]) null)); () -> WordPdfValidator.checkPageCount((byte[]) null));
}
// ===== validate(byte[], ConvertOptions) =====
private static ConvertOptions options(long maxBytes, int maxPages) {
return new ConvertOptions(true, true, false, false, maxBytes, maxPages);
}
@Test
void validate_withinLimits() throws Exception {
assertDoesNotThrow(() -> WordPdfValidator.validate(
docxWithPageBreaks(5), ConvertOptions.defaults()));
}
@Test
void validate_bytesOverLimit() {
byte[] big = new byte[(int) WordPdfSettings.MAX_INPUT_BYTES + 1];
ValidationException ex = assertThrows(ValidationException.class,
() -> WordPdfValidator.validate(big, ConvertOptions.defaults()));
assertTrue(ex.getMessage().contains("5 МБ"),
"размер проверяется первым: " + ex.getMessage());
}
@Test
void validate_neitherDocxNorDoc() {
byte[] junk = {1, 2, 3, 4, 5};
ValidationException ex = assertThrows(ValidationException.class,
() -> WordPdfValidator.validate(junk, ConvertOptions.defaults()));
assertTrue(ex.getMessage().contains("не похоже на .docx или .doc"),
"сообщение должно упоминать обе подписи контейнера: " + ex.getMessage());
}
@Test
void validate_tooManyPages() throws Exception {
byte[] bytes = docxWithPageBreaks(120);
ValidationException ex = assertThrows(ValidationException.class,
() -> WordPdfValidator.validate(bytes,
options(WordPdfSettings.MAX_INPUT_BYTES, 100)));
assertTrue(ex.getMessage().contains("не менее 121"),
"оценка = 1 + 120 разрывов: " + ex.getMessage());
}
@Test
void validate_nullBytes() {
assertThrows(ValidationException.class,
() -> WordPdfValidator.validate(null, ConvertOptions.defaults()));
} }
/** /**
@@ -354,9 +327,54 @@ class WordPdfValidatorTest {
// 3 разрыва + первая страница = не менее 4; до фикса lightweight // 3 разрыва + первая страница = не менее 4; до фикса lightweight
// не видел разрывы в strict-namespace и возвращал 1 // не видел разрывы в strict-namespace и возвращал 1
assertDoesNotThrow(() -> WordPdfValidator.checkPageCountLightweight(docx, 4)); assertDoesNotThrow(() -> WordPdfValidator.checkPageCount(docx, 4));
ConversionException ex = assertThrows(ConversionException.class, ValidationException ex = assertThrows(ValidationException.class,
() -> WordPdfValidator.checkPageCountLightweight(docx, 3)); () -> WordPdfValidator.checkPageCount(docx, 3));
assertTrue(ex.getMessage().contains("не менее 4"), ex.getMessage()); assertTrue(ex.getMessage().contains("не менее 4"), ex.getMessage());
} }
/** Фикстура бинарного .doc (закоммичена, создана Word'ом — POI .doc не пишет). */
private static byte[] legacyDocBytes() throws Exception {
try (var in = WordPdfValidatorTest.class.getClassLoader()
.getResourceAsStream("samples/legacy-doc.doc")) {
assertNotNull(in, "Нет тестового документа: samples/legacy-doc.doc");
return in.readAllBytes();
}
}
/**
* Число страниц .doc — кэш SummaryInformation (для фикстуры 11):
* лимит 10 должен отвергать, 20 — пропускать.
* Регрессия — WordPdfValidator#checkDocPageCountLightweight,
* фикстура samples/legacy-doc.doc.
*/
@Test
void checkDocPageCountLightweight_overLimitRejected() throws Exception {
ConversionException ex = assertThrows(ConversionException.class,
() -> WordPdfValidator.checkDocPageCountLightweight(legacyDocBytes(), 10));
assertTrue(ex.getMessage().contains("не менее 11"), ex.getMessage());
}
@Test
void checkDocPageCountLightweight_underLimitPasses() throws Exception {
byte[] doc = legacyDocBytes();
assertDoesNotThrow(() -> WordPdfValidator.checkDocPageCountLightweight(doc, 20));
assertDoesNotThrow(() -> WordPdfValidator.checkDocPageCountLightweight(doc));
}
@Test
void checkDocPageCountLightweight_junkRejected() {
byte[] junk = new byte[1024];
byte[] magic = {(byte) 0xD0, (byte) 0xCF, 0x11, (byte) 0xE0,
(byte) 0xA1, (byte) 0xB1, 0x1A, (byte) 0xE1};
System.arraycopy(magic, 0, junk, 0, magic.length);
assertThrows(ConversionException.class,
() -> WordPdfValidator.checkDocPageCountLightweight(junk));
}
@Test
void checkDocPageCountLightweight_bytesNull() {
assertThrows(ConversionException.class,
() -> WordPdfValidator.checkDocPageCountLightweight((byte[]) null));
}
} }
@@ -92,7 +92,7 @@ class BundledFontsTest {
// populateFontMappings вызывается при setFontMapper; проверяем // populateFontMappings вызывается при setFontMapper; проверяем
// итоговое состояние через публичный get() // итоговое состояние через публичный get()
java.util.Set<String> names = new java.util.HashSet<>(List.of( Set<String> names = new java.util.HashSet<>(List.of(
"Calibri", "Times New Roman", "Arial", "Cousine", "UnknownExoticFont")); "Calibri", "Times New Roman", "Arial", "Cousine", "UnknownExoticFont"));
// wmlFonts не может быть null (super обращается к getFont()), // wmlFonts не может быть null (super обращается к getFont()),
// поэтому — пустой объект (как у документа без fontTable) // поэтому — пустой объект (как у документа без fontTable)
@@ -24,8 +24,6 @@ class GlyphCoverageNormalizerTest {
private static final String ROMAN = "\u2181"; private static final String ROMAN = "\u2181";
/** Знак, которого нет ни в одном бандл-шрифте. */ /** Знак, которого нет ни в одном бандл-шрифте. */
private static final String NOWHERE = "\u2188"; private static final String NOWHERE = "\u2188";
/** Обычная кириллица — есть в Tinos. */
private static final String CYRILLIC = "ы";
@BeforeAll @BeforeAll
static void initFonts() { static void initFonts() {
+22
View File
@@ -0,0 +1,22 @@
# FROM с полным именем реестра: podman не резолвит short-name без
# unqualified-search-registries в /etc/containers/registries.conf.
FROM docker.io/library/node:24-alpine AS build
# buildah подмешивает прокси-переменные хоста в каждый RUN (ENV не перебивает),
# а 127.0.0.1 внутри контейнера недостижим — npm ci падает с ECONNREFUSED на
# 127.0.0.1:proxy. Контейнер в сеть ходит напрямую, потому обнуляем прокси
# на самой команде.
WORKDIR /build
COPY package.json package-lock.json ./
RUN HTTP_PROXY= http_proxy= HTTPS_PROXY= https_proxy= ALL_PROXY= all_proxy= npm ci
COPY . .
# base для сборки SPA под префиксом: прод pjandro.ru — /pdf-converter/
# (compose прод-запуска передаёт arg); дефолт '/' — standalone
ARG VITE_BASE=/
ENV VITE_BASE=${VITE_BASE}
RUN npm run build
FROM docker.io/library/nginx:alpine
COPY --from=build /build/dist /usr/share/nginx/html
# прокси-переменные хоста подмешиваются в HEALTHCHECK-шелл — обнуляем на команде
HEALTHCHECK --interval=10s --timeout=3s --start-period=10s \
CMD http_proxy= https_proxy= wget -qO /dev/null http://127.0.0.1/ || exit 1
-21
View File
@@ -1,21 +0,0 @@
FROM node:24-alpine AS build
# docker-прокси из ~/.docker/config.json BuildKit подмешивает в каждый RUN
# (ENV не перебивает), а 127.0.0.1 внутри контейнера недостижим — npm ci падает
# с ECONNREFUSED. Контейнер в сеть ходит напрямую, потому обнуляем прокси
# на самой команде.
WORKDIR /build
COPY package.json package-lock.json ./
RUN HTTP_PROXY= http_proxy= HTTPS_PROXY= https_proxy= ALL_PROXY= all_proxy= npm ci
COPY . .
# base для сборки SPA под префиксом: прод pjandro.ru — /pdf-converter/
# (compose прод-запуска передаёт arg); дефолт '/' — standalone
ARG VITE_BASE=/
ENV VITE_BASE=${VITE_BASE}
RUN npm run build
FROM nginx:alpine
COPY nginx.conf /etc/nginx/conf.d/default.conf
COPY --from=build /build/dist /usr/share/nginx/html
# прокси из docker-config подмешивается в HEALTHCHECK-шелл — обнуляем на команде
HEALTHCHECK --interval=10s --timeout=3s --start-period=10s \
CMD http_proxy= https_proxy= wget -qO /dev/null http://127.0.0.1/ || exit 1
+1 -1
View File
@@ -2,7 +2,7 @@
SPA-фронт конвертера Word → PDF: React 19 + TypeScript + Vite + Tailwind CSS v4. SPA-фронт конвертера Word → PDF: React 19 + TypeScript + Vite + Tailwind CSS v4.
В Maven-сборку не входит; деплоится отдельным nginx-контейнером (см. В Maven-сборку не входит; деплоится отдельным nginx-контейнером (см.
`Dockerfile`/`nginx.conf` и корневой `docker-compose.yml`). `Containerfile`/`nginx.conf` и корневой `compose.yml`).
## Dev ## Dev
+23 -1
View File
@@ -66,7 +66,29 @@ export async function convertDocx(
// флаг i обязателен; фолбэк — имя исходника с заменой расширения // флаг i обязателен; фолбэк — имя исходника с заменой расширения
const cd = resp.headers.get('Content-Disposition') ?? '' const cd = resp.headers.get('Content-Disposition') ?? ''
const m = /filename\*=utf-8''([^;]+)/i.exec(cd) const m = /filename\*=utf-8''([^;]+)/i.exec(cd)
const filename = m ? decodeURIComponent(m[1]) : file.name.replace(/\.docx$/i, '') + '.pdf' const filename = m ? decodeURIComponent(m[1]) : file.name.replace(/\.docx?$/i, '') + '.pdf'
const blob = await resp.blob() const blob = await resp.blob()
return { blob, filename } return { blob, filename }
} }
/**
* Требует ли сервер ключ: GET /api/v1/convert (эндпоинт POST-only) —
* 401 пишет ApiKeyFilter при требуемом и непринятом ключе; при выключенной
* аутентификации (dev) до фильтра дело не доходит — 405 от Spring.
* Сетевая ошибка — 'open': не блокировать UI, конвертация сама покажет ошибку.
*/
export async function probeApiKey(): Promise<'open' | 'required'> {
const key = getApiKey()
try {
const resp = await fetch(`${import.meta.env.BASE_URL}api/v1/convert`, {
headers: key ? { 'X-API-Key': key } : undefined,
})
if (resp.status === 401) {
clearApiKey() // ключ устарел/отозван — форма откроется пустой
return 'required'
}
return 'open'
} catch {
return 'open'
}
}
+20 -8
View File
@@ -1,5 +1,5 @@
import { useEffect, useRef, useState } from 'react' import { useEffect, useRef, useState } from 'react'
import { ApiError, convertDocx, getApiKey, setApiKey, UnauthorizedError } from '../api' import { ApiError, convertDocx, probeApiKey, setApiKey, UnauthorizedError } from '../api'
import ApiKeyGate from './ApiKeyGate' import ApiKeyGate from './ApiKeyGate'
import DropZone from './DropZone' import DropZone from './DropZone'
import Logo from './Logo' import Logo from './Logo'
@@ -47,8 +47,11 @@ export default function App() {
if (on) setRenderSmartArt(false) if (on) setRenderSmartArt(false)
} }
// ключ в localStorage: публичная статика, в бандл зашивать нельзя // экран ключа показываем только когда сервер реально требует ключ: зонд
const [apiKey, setApiKeyValue] = useState<string | null>(() => getApiKey()) // probeApiKey (GET /api/v1/convert → 401) решает до загрузки файла; в dev
// без ключа форма открывается сразу. Ключ лежит в localStorage (публичная
// статика, в бандл зашивать нельзя), читает его api.ts сам.
const [gate, setGate] = useState<'checking' | 'open' | 'required'>('checking')
const [keyError, setKeyError] = useState<string | null>(null) const [keyError, setKeyError] = useState<string | null>(null)
// снимаем blob-URL предыдущего результата — иначе он течёт до закрытия вкладки // снимаем blob-URL предыдущего результата — иначе он течёт до закрытия вкладки
@@ -90,7 +93,7 @@ export default function App() {
// UnauthorizedError раньше ApiError: он её наследник; ключ уже // UnauthorizedError раньше ApiError: он её наследник; ключ уже
// очищен в api.ts — форма откроется пустой // очищен в api.ts — форма откроется пустой
if (e instanceof UnauthorizedError) { if (e instanceof UnauthorizedError) {
setApiKeyValue(null) setGate('required')
setKeyError('Ключ доступа не принят — введите заново') setKeyError('Ключ доступа не принят — введите заново')
setStatus('idle') setStatus('idle')
return return
@@ -112,13 +115,22 @@ export default function App() {
[], [],
) )
if (!apiKey) useEffect(() => {
probeApiKey().then(setGate)
}, [])
// зонд — один быстрый same-origin запрос, спиннер не вводим
if (gate === 'checking') return null
if (gate === 'required')
return ( return (
<ApiKeyGate <ApiKeyGate
error={keyError} error={keyError}
onSubmit={(k) => { onSubmit={(k) => {
setApiKey(k) setApiKey(k)
setApiKeyValue(k) // повторный зонд не шлём: неверный ключ всплывёт 401 на первой
// конвертации (текущий контракт гейта)
setGate('open')
setKeyError(null) setKeyError(null)
// возврат после отзыва ключа не должен показать «Конвертация…»/старый результат // возврат после отзыва ключа не должен показать «Конвертация…»/старый результат
setStatus('idle') setStatus('idle')
@@ -140,8 +152,8 @@ export default function App() {
<div> <div>
<h1 className="text-2xl font-semibold">Word → PDF</h1> <h1 className="text-2xl font-semibold">Word → PDF</h1>
<p className="mt-1 text-sm text-muted"> <p className="mt-1 text-sm text-muted">
docx → PDF на docx4j + Apache FOP. Лимиты (файл ≤ 20 МБ, docx/doc → PDF на docx4j + Apache FOP. Лимиты (файл ≤ 5 МБ,
≤ 1000 страниц) задаёт сервер; переопределение из формы убрано. ≤ 100 страниц) задаёт сервер; переопределение из формы убрано.
</p> </p>
</div> </div>
</header> </header>
+3 -3
View File
@@ -8,7 +8,7 @@ interface Props {
} }
/** /**
* Зона drag&drop + клик для выбора .docx. Скрытый input[type=file] — * Зона drag&drop + клик для выбора .docx/.doc. Скрытый input[type=file] —
* единственный источник выбора; drop берёт первый файл. * единственный источник выбора; drop берёт первый файл.
*/ */
export default function DropZone({ file, disabled, onSelect }: Props) { export default function DropZone({ file, disabled, onSelect }: Props) {
@@ -53,7 +53,7 @@ export default function DropZone({ file, disabled, onSelect }: Props) {
<path d="M12 16V4m0 0-4 4m4-4 4 4" /> <path d="M12 16V4m0 0-4 4m4-4 4 4" />
<path d="M4 16v3a1 1 0 0 0 1 1h14a1 1 0 0 0 1-1v-3" /> <path d="M4 16v3a1 1 0 0 0 1 1h14a1 1 0 0 0 1-1v-3" />
</svg> </svg>
<span>Перетащите .docx сюда или нажмите для выбора</span> <span>Перетащите .docx или .doc сюда или нажмите для выбора</span>
{file && ( {file && (
<span className="text-sm text-muted"> <span className="text-sm text-muted">
{file.name} · {(file.size / 1024).toFixed(0)} КБ {file.name} · {(file.size / 1024).toFixed(0)} КБ
@@ -62,7 +62,7 @@ export default function DropZone({ file, disabled, onSelect }: Props) {
<input <input
ref={inputRef} ref={inputRef}
type="file" type="file"
accept=".docx" accept=".docx,.doc"
className="sr-only" className="sr-only"
disabled={disabled} disabled={disabled}
onChange={(e) => { onChange={(e) => {
+2
View File
@@ -9,6 +9,8 @@ export default defineConfig({
base: process.env.VITE_BASE ?? '/', base: process.env.VITE_BASE ?? '/',
plugins: [react(), tailwindcss()], plugins: [react(), tailwindcss()],
server: { server: {
// dev-сервер наружу: слушает все интерфейсы (LAN-доступ к стенду с других машин)
host: true,
// dev без CORS: запросы /api и документация (/swagger-ui*, /v3/api-docs*) идут на бэкенд через прокси // dev без CORS: запросы /api и документация (/swagger-ui*, /v3/api-docs*) идут на бэкенд через прокси
proxy: { proxy: {
'/api': 'http://localhost:8080', '/api': 'http://localhost:8080',