core: ValidationException вместо ConversionException; удаление pkg-API и переименование checkPageCountLightweight в checkPageCount

This commit is contained in:
Pjandro
2026-10-19 21:30:45 +00:00
parent faf6d048a5
commit f09b629270
11 changed files with 153 additions and 402 deletions
@@ -10,14 +10,16 @@ import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.multipart.MaxUploadSizeExceededException;
import org.springframework.web.multipart.support.MissingServletRequestPartException;
import org.springframework.web.servlet.resource.NoResourceFoundException;
import ru.pjandro.wordpdf.ValidationException;
/**
* Единый перевод исключений в JSON {@code {"error": "..."}} с кодом по смыслу.
*
* <p>Голый {@code ru.pjandro.wordpdf.ConversionException} ядра сюда не доходит:
* контроллер и {@link ConversionService} превращают его на границе в
* {@link ValidationException}/{@link ConversionFailedException}; случайная
* утечка попадёт в обработчик {@link Exception} (500).</p>
* <p>{@link ValidationException} ядра доходит сюда напрямую — валидатор
* бросает его сам; в {@link ConversionFailedException} превращается только
* прочий {@code ru.pjandro.wordpdf.ConversionException} рендер-стадии.
* Случайная утечка прочего исключения попадёт в обработчик {@link Exception}
* (500).</p>
*/
@RestControllerAdvice
final class ApiExceptionHandler {
@@ -4,8 +4,9 @@ package ru.pjandro.wordpdf.app;
* Ошибка преобразования: контейнер .docx принят валидацией, но упал сам
* рендер (ядро, FOP, повреждённое содержимое внутри валидного zip).
*
* <p>Смысл отличается от {@link ValidationException}: вход формально корректен,
* отказал движок конвертации. Маппится в HTTP 500 ({@link ApiExceptionHandler}).</p>
* <p>Смысл отличается от {@code ru.pjandro.wordpdf.ValidationException}:
* вход формально корректен, отказал движок конвертации.
* Маппится в HTTP 500 ({@link ApiExceptionHandler}).</p>
*
* <p>Регрессия — ConvertControllerTest#junkInsideValidZip_conversionError.</p>
*/
@@ -8,6 +8,7 @@ import ru.pjandro.wordpdf.ConversionException;
import ru.pjandro.wordpdf.DrawingFoundException;
import ru.pjandro.wordpdf.WordPdfConverter;
import ru.pjandro.wordpdf.WordPdfValidator;
import ru.pjandro.wordpdf.ValidationException;
import java.time.Duration;
import java.util.Locale;
@@ -34,9 +35,10 @@ import java.util.concurrent.TimeoutException;
* {@link ValidationException} (400), ошибка рендер-стадии →
* {@link ConversionFailedException} (500). Граница: сломанный контейнер
* (не zip / битый zip / слишком большой / слишком длинный) — 400; валидный
* zip с мусором внутри (нет {@code word/document.xml}) — 500: lightweight-
* подсчёт страниц согласован с JAXB-путём ядра (может только завышать),
* поэтому уже принятый запрос внутренняя проверка ядра в ошибку не превратит.</p>
* zip с мусором внутри (нет {@code word/document.xml}) — 500: до очереди и
* в конвейере ядра страницы проверяются одним и тем же lightweight-путём
* ({@link WordPdfValidator#checkPageCount}), поэтому уже принятый
* запрос внутренняя проверка ядра в ошибку не превратит.</p>
*/
@Service
final class ConversionService {
@@ -111,7 +113,8 @@ final class ConversionService {
}
/**
* Валидация байтов переиспользует публичные byte-API ядра. Порядок значим:
* Валидация байтов переиспользует публичные byte-API ядра; ядро бросает
* {@link ValidationException} само — оборачивать нечего. Порядок значим:
* размер (дешёвая) → magic bytes → lightweight-разбор zip. Лимиты
* размера/страниц берутся из {@code options} (контроллер подставляет их
* из конфигурации сервера: свойства {@code wordpdf.max-bytes}/
@@ -119,25 +122,17 @@ final class ConversionService {
*
* <p>Проверка zip-подписи отдельным шагом обязательна:
* {@code ZipInputStream.getNextEntry()} на не-zip-потоке возвращает
* {@code null} молча, и {@link WordPdfValidator#checkPageCountLightweight(byte[])}
* {@code null} молча, и {@link WordPdfValidator#checkPageCount(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);
}
WordPdfValidator.checkInput(docxBytes, options.maxBytes());
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);
}
WordPdfValidator.checkPageCount(docxBytes, options.maxPages());
}
/**
@@ -149,6 +144,10 @@ final class ConversionService {
try {
// заголовок PDF — санитизированный base исходного имени
return WordPdfConverter.convert(docxBytes, safeBaseName(originalFilename), options);
} catch (ValidationException e) {
// отказ проверки страниц внутри конвейера ядра — некорректный
// вход (400), а не ошибка рендера: без этого утонул бы в 500
throw e;
} catch (DrawingFoundException e) {
// отказ по настройке запроса (error-флаг) — не ошибка рендера: 422,
// иначе утонет в общем catch ниже как 500
@@ -13,6 +13,7 @@ import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.multipart.MultipartFile;
import ru.pjandro.wordpdf.ConvertOptions;
import ru.pjandro.wordpdf.WordPdfSettings;
import ru.pjandro.wordpdf.ValidationException;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
@@ -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);
}
}
@@ -252,14 +252,14 @@ class ConvertControllerTest {
@Test
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)))
.andExpect(status().isBadRequest())
.andExpect(jsonPath("$.error",
org.hamcrest.Matchers.containsString("больше 20 МБ")));
org.hamcrest.Matchers.containsString("больше 5 МБ")));
}
/**
@@ -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);
}
}
@@ -59,14 +59,16 @@ public final class WordPdfConverter {
*
* <p>Вход проверяется валидатором до рендера: {@link WordPdfValidator#checkInput(byte[])}
* (null / больше {@link WordPdfSettings#MAX_INPUT_BYTES}), затем число страниц
* ({@link WordPdfSettings#MAX_PAGES}) — при отказе байтов результата нет.
* ({@link WordPdfValidator#checkPageCount(byte[])}, лимит
* {@link WordPdfSettings#MAX_PAGES}) — при отказе байтов результата нет.
*
* @param docxBytes байты .docx
* @param title заголовок PDF (метаданные); {@code null}/пустая — заголовок не задаётся
* @return байты готового PDF
* @throws ConversionException при ошибке (битый .docx, размер больше
* {@link WordPdfSettings#MAX_INPUT_BYTES}, результат длиннее
* {@link WordPdfSettings#MAX_PAGES} страниц и т.п.)
* @throws ValidationException некорректный вход: {@code null}, размер больше
* {@link WordPdfSettings#MAX_INPUT_BYTES}, документ длиннее
* {@link WordPdfSettings#MAX_PAGES} страниц
* @throws ConversionException прочие ошибки (битый .docx, ошибка рендера)
*/
public static byte[] convert(byte[] docxBytes, String title) throws ConversionException {
return convert(docxBytes, title, ConvertOptions.defaults());
@@ -78,16 +80,18 @@ public final class WordPdfConverter {
*
* <p>Вход проверяется валидатором до рендера: {@link WordPdfValidator#checkInput(byte[], long)}
* (null / больше {@code options.maxBytes()}), затем число страниц
* ({@code options.maxPages()}) — при отказе байтов результата нет.
* ({@link WordPdfValidator#checkPageCount(byte[], int)}, лимит
* {@code options.maxPages()}) — при отказе байтов результата нет.
*
* @param docxBytes байты .docx
* @param title заголовок PDF (метаданные); {@code null}/пустая — заголовок не задаётся
* @param options рисование и лимиты входа на этот вызов; {@code null} —
* дефолты (константы {@link WordPdfSettings})
* @return байты готового PDF
* @throws ConversionException при ошибке (битый .docx, размер больше
* {@code options.maxBytes()}, результат длиннее
* {@code options.maxPages()} страниц и т.п.)
* @throws ValidationException некорректный вход: {@code null}, размер больше
* {@code options.maxBytes()}, документ длиннее {@code options.maxPages()}
* страниц
* @throws ConversionException прочие ошибки (битый .docx, ошибка рендера)
*/
public static byte[] convert(byte[] docxBytes, String title, ConvertOptions options) throws ConversionException {
ConvertOptions opts = options == null ? ConvertOptions.defaults() : options;
@@ -96,6 +100,8 @@ public final class WordPdfConverter {
try {
convertToStream(docxBytes, title, opts, bos);
} catch (ConversionException e) {
// ValidationException (отказ валидации входа) — подтип, уходит
// вызывающему без обёртки
throw e;
} catch (Exception e) {
throw new ConversionException("Не удалось конвертировать документ", e);
@@ -139,12 +145,13 @@ public final class WordPdfConverter {
WordprocessingMLPackage pkg = WordprocessingMLPackage.load(
new ByteArrayInputStream(docxBytes));
try {
// 2.5 Проверка числа страниц по самому .docx: кэш Word
// (docProps/app.xml <Pages>) или нижняя оценка по явным
// разрывам. Делается до рендера, чтобы не тратить время на
// заведомо длинный документ; внутри try — чтобы и на отказе
// отработал finally с чисткой temp-файлов встроенных шрифтов.
WordPdfValidator.checkPageCount(pkg, options.maxPages());
// 2.5 Проверка числа страниц по самому .docx: lightweight-оценка
// по zip (кэш docProps/app.xml <Pages>, явные разрывы, маркеры
// w:lastRenderedPageBreak, включая колонтитулы) — без JAXB-модели.
// Делается до рендера, чтобы не тратить время на заведомо
// длинный документ; внутри try — чтобы и на отказе отработал
// finally с чисткой temp-файлов встроенных шрифтов.
WordPdfValidator.checkPageCount(docxBytes, options.maxPages());
// 3. Привязка маппера: docx4j сопоставляет шрифты документа
// с физическими TTF (учитывая и шрифты, встроенные в docx)
pkg.setFontMapper(mapper);
@@ -1,15 +1,5 @@
package ru.pjandro.wordpdf;
import org.docx4j.openpackaging.packages.WordprocessingMLPackage;
import org.docx4j.wml.Br;
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.XMLStreamException;
import javax.xml.stream.XMLStreamReader;
@@ -27,9 +17,8 @@ import java.util.zip.ZipInputStream;
* Валидатор ограничений на входной .docx:
* размер входа и число страниц.
*
* <p>Вход валидатора — только {@code byte[]} (или уже загруженный
* {@link WordprocessingMLPackage}): файловых проверок нет, работа с
* файлами — забота вызывающего (приложения).
* <p>Вход валидатора — только {@code byte[]}: файловых проверок нет,
* работа с файлами — забота вызывающего (приложения).
*
* <p>Конвертер {@link WordPdfConverter} вызывает валидатор автоматически,
* но им можно пользоваться и напрямую — например, проверить байты
@@ -55,7 +44,7 @@ import java.util.zip.ZipInputStream;
* <p>Проверка делается <b>до</b> рендера — это позволяет отсекать слишком
* длинные документы, не тратя время на конвертацию.
*
* <p>Все ошибки — {@link ConversionException}.
* <p>Все ошибки — {@link ValidationException} (наследник {@link ConversionException}).
*/
public final class WordPdfValidator {
@@ -65,9 +54,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);
}
@@ -75,18 +64,18 @@ public final class WordPdfValidator {
* Проверяет размер байтов входа против явного лимита (переопределение
* на вызов, см. {@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) {
throw new ConversionException("Не указаны байты входного файла");
throw new ValidationException("Не указаны байты входного файла");
}
if (docxBytes.length > maxBytes) {
// дефолтный лимит кратен MiB — сообщение остаётся «... 20 МБ ...»
// дефолтный лимит кратен MiB — сообщение остаётся «... 5 МБ ...»
String limit = maxBytes % (1024 * 1024) == 0
? (maxBytes / (1024 * 1024)) + " МБ"
: maxBytes + " байт";
throw new ConversionException("Файл больше " + limit
throw new ValidationException("Файл больше " + limit
+ ": " + docxBytes.length + " байт > " + maxBytes + " байт");
}
}
@@ -98,32 +87,41 @@ public final class WordPdfValidator {
* {@code docProps/app.xml}). Дешёвый путь для проверки байтов из
* сети/БД до любой работы с библиотекой.
*
* <p>Оценка согласована с {@link #checkPageCount(WordprocessingMLPackage)}
* по всем источникам; на границе лимита оба пути дают одинаковый ответ
* (регрессия — {@code checkPageCountLightweight_agreesWithJaxbPath},
* включая 99/100/101 разрывов). Lightweight-путь дополнительно считает
* разрывы в колонтитулах — он консервативнее, расхождение возможно
* <p>Оценка — максимум трёх нижних оценок: кэша Word в
* {@code docProps/app.xml} ({@code <Pages>}; сам по себе недостоверен —
* в регрессной фикстуре {@code stale-cache.docx} равен 1 при 110
* границах страниц), явных разрывов ({@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
* без единой записи — молча, оценка «1 страница». Корректность контейнера
* проверяет вызывающий по zip-подписи ({@code ConversionService.validate}
* в приложении; регрессия — {@code ConvertControllerTest#corruptNotAZip_rejected}).
* @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 {
checkPageCountLightweight(docxBytes, WordPdfSettings.MAX_PAGES);
public static void checkPageCount(byte[] docxBytes) throws ValidationException {
checkPageCount(docxBytes, WordPdfSettings.MAX_PAGES);
}
/**
* То же, что {@link #checkPageCountLightweight(byte[])}, с явным лимитом
* То же, что {@link #checkPageCount(byte[])}, с явным лимитом
* страниц (переопределение на вызов, см. {@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) {
throw new ConversionException("Не указаны байты входного .docx");
throw new ValidationException("Не указаны байты входного .docx");
}
int pages;
try (ZipInputStream zip = new ZipInputStream(new ByteArrayInputStream(docxBytes))) {
@@ -145,196 +143,14 @@ public final class WordPdfValidator {
return b == null ? null : new ByteArrayInputStream(b);
}, headerFooter);
} catch (IOException | RuntimeException e) {
throw new ConversionException("Не удалось разобрать байты .docx", e);
throw new ValidationException("Не удалось разобрать байты .docx", e);
}
if (pages > maxPages) {
throw new ConversionException("Документ длиннее " + maxPages
throw new ValidationException("Документ длиннее " + maxPages
+ " страниц: получено не менее " + pages);
}
}
/**
* Считает страницы .docx в байтах и проверяет лимит.
*
* @throws ConversionException при {@code null}, ошибке загрузки или превышении лимита
*/
public static void checkPageCount(byte[] docxBytes) throws ConversionException {
checkPageCount(docxBytes, WordPdfSettings.MAX_PAGES);
}
/**
* То же, что {@link #checkPageCount(byte[])}, с явным лимитом страниц
* (переопределение на вызов, см. {@link ConvertOptions#maxPages()}).
*
* @throws ConversionException при {@code null}, ошибке загрузки или
* превышении {@code maxPages}
*/
public static void checkPageCount(byte[] docxBytes, int maxPages) throws ConversionException {
if (docxBytes == null) {
throw new ConversionException("Не указаны байты входного .docx");
}
WordprocessingMLPackage pkg;
try {
pkg = WordprocessingMLPackage.load(new ByteArrayInputStream(docxBytes));
} catch (Exception e) {
throw new ConversionException("Не удалось разобрать байты .docx", e);
}
checkPageCount(pkg, maxPages);
}
/**
* Считает страницы уже загруженного .docx и проверяет лимит.
*
* <p>Число страниц — максимум трёх нижних оценок:
* <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 {
checkPageCount(pkg, WordPdfSettings.MAX_PAGES);
}
/**
* То же, что {@link #checkPageCount(WordprocessingMLPackage)}, с явным
* лимитом страниц (переопределение на вызов, см. {@link ConvertOptions#maxPages()}).
*
* @throws ConversionException при превышении {@code maxPages}
*/
public static void checkPageCount(WordprocessingMLPackage pkg, int maxPages) throws ConversionException {
if (pkg == null) {
throw new ConversionException("Не указан загруженный .docx");
}
int pages = pageCountOf(pkg);
if (pages > maxPages) {
throw new ConversionException("Документ длиннее " + maxPages
+ " страниц: получено не менее " + 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 — части нет. */
private interface PartStream {
InputStream open(String name) throws IOException;
@@ -348,8 +164,7 @@ public final class WordPdfValidator {
/**
* Лёгкий расчёт числа страниц прямо по zip-пакету .docx, без docx4j.
* Та же логика, что у {@link #pageCountOf(WordprocessingMLPackage)}:
* максимум кэша {@code docProps/app.xml <Pages>}, явных разрывов и
* Максимум кэша {@code docProps/app.xml <Pages>}, явных разрывов и
* {@code w:lastRenderedPageBreak}. Считаются все колонтитулы
* ({@code word/header*.xml}, {@code word/footer*.xml}) — там Word тоже
* держит {@code w:br type="page"}.
@@ -432,19 +432,19 @@ class WordPdfConverterTest {
@Test
void invalidInputRejected() {
assertThrows(ConversionException.class, () ->
assertThrows(ValidationException.class, () ->
WordPdfConverter.convert(null, "x"));
}
/**
* Лимит на размер входа: больше 20 MiB — отказ до рендера.
* Лимит на размер входа: больше 5 MiB — отказ до рендера.
*/
@Test
void inputTooLarge() {
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"));
assertTrue(ex.getMessage().contains("20 МБ"),
assertTrue(ex.getMessage().contains("5 МБ"),
"сообщение должно упоминать лимит: " + ex.getMessage());
}
@@ -455,7 +455,7 @@ class WordPdfConverterTest {
*/
@Test
void limitsOverriddenByOptions() throws Exception {
ConversionException ex = assertThrows(ConversionException.class, () ->
ValidationException ex = assertThrows(ValidationException.class, () ->
WordPdfConverter.convert(sampleBytes("ru-plain.docx"), "x",
new ConvertOptions(true, true, false, false, 1000, WordPdfSettings.MAX_PAGES)));
assertTrue(ex.getMessage().contains("1000 байт"),
@@ -469,7 +469,7 @@ class WordPdfConverterTest {
*/
@Test
void tooManyPages() {
ConversionException ex = assertThrows(ConversionException.class, () ->
ValidationException ex = assertThrows(ValidationException.class, () ->
WordPdfConverter.convert(
sampleBytes("too-many-pages.docx"), "too-many-pages",
new ConvertOptions(true, true, false, false, WordPdfSettings.MAX_INPUT_BYTES, 100)));
@@ -486,7 +486,7 @@ class WordPdfConverterTest {
*/
@Test
void staleCachePageCountRejectedBeforeRender() {
ConversionException ex = assertThrows(ConversionException.class, () ->
ValidationException ex = assertThrows(ValidationException.class, () ->
WordPdfConverter.convert(sampleBytes("stale-cache.docx"), "stale-cache",
new ConvertOptions(true, true, false, false, WordPdfSettings.MAX_INPUT_BYTES, 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.XWPFParagraph;
import org.apache.poi.xwpf.usermodel.XWPFTable;
import org.docx4j.openpackaging.packages.WordprocessingMLPackage;
import org.junit.jupiter.api.Test;
import java.io.ByteArrayOutputStream;
@@ -16,7 +15,7 @@ import static org.junit.jupiter.api.Assertions.*;
/**
* Юнит-тесты валидатора: размер и число страниц
* (byte[] и уже загруженный пакет).
* (byte[], lightweight-путь zip/StAX).
*/
class WordPdfValidatorTest {
@@ -42,15 +41,15 @@ class WordPdfValidatorTest {
@Test
void checkInput_bytesOverLimit() {
byte[] big = new byte[(int) WordPdfSettings.MAX_INPUT_BYTES + 1];
ConversionException ex = assertThrows(ConversionException.class,
ValidationException ex = assertThrows(ValidationException.class,
() -> WordPdfValidator.checkInput(big));
assertTrue(ex.getMessage().contains("20 МБ"),
assertTrue(ex.getMessage().contains("5 МБ"),
"сообщение должно упоминать лимит: " + ex.getMessage());
}
@Test
void checkInput_bytesNull() {
assertThrows(ConversionException.class,
assertThrows(ValidationException.class,
() -> WordPdfValidator.checkInput((byte[]) null));
}
@@ -61,119 +60,58 @@ class WordPdfValidatorTest {
@Test
void checkInput_customLimit() {
assertDoesNotThrow(() -> WordPdfValidator.checkInput(new byte[10], 100));
ConversionException ex = assertThrows(ConversionException.class,
ValidationException ex = assertThrows(ValidationException.class,
() -> WordPdfValidator.checkInput(new byte[11], 10));
assertTrue(ex.getMessage().contains("10 байт"),
"сообщение должно упоминать переданный лимит: " + ex.getMessage());
}
@Test
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));
}
// ---- lightweight (zip/StAX, без docx4j) ----
@Test
void checkPageCount_pkgOverLimit() throws Exception {
byte[] bytes = docxWithPageBreaks(120); // 1 + 120 = 121
WordprocessingMLPackage pkg = WordprocessingMLPackage.load(
new java.io.ByteArrayInputStream(bytes));
ConversionException ex = assertThrows(ConversionException.class,
() -> WordPdfValidator.checkPageCount(pkg, 100));
assertTrue(ex.getMessage().contains("100"),
"сообщение должно упоминать лимит: " + ex.getMessage());
void checkPageCount_bytesWithinLimit() throws Exception {
byte[] bytes = docxWithPageBreaks(5);
assertDoesNotThrow(() -> WordPdfValidator.checkPageCount(bytes));
}
@Test
void checkPageCount_bytesOverLimit() throws Exception {
byte[] bytes = docxWithPageBreaks(120);
ConversionException ex = assertThrows(ConversionException.class,
ValidationException ex = assertThrows(ValidationException.class,
() -> WordPdfValidator.checkPageCount(bytes, 100));
assertTrue(ex.getMessage().contains("100"),
"сообщение должно упоминать лимит: " + 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 страницы
* (2 разрыва) отсекаются maxPages=1 и проходят при maxPages=1000.
*/
@Test
void checkPageCountLightweight_customLimit() throws Exception {
void checkPageCount_customLimit() throws Exception {
byte[] bytes = docxWithPageBreaks(2);
ConversionException ex = assertThrows(ConversionException.class,
() -> WordPdfValidator.checkPageCountLightweight(bytes, 1));
ValidationException ex = assertThrows(ValidationException.class,
() -> WordPdfValidator.checkPageCount(bytes, 1));
assertTrue(ex.getMessage().contains("длиннее 1 страниц"),
"сообщение должно упоминать переданный лимит: " + ex.getMessage());
assertDoesNotThrow(() -> WordPdfValidator.checkPageCountLightweight(bytes, 1000));
assertDoesNotThrow(() -> WordPdfValidator.checkPageCount(bytes, 1000));
}
/**
* Точная граница лимита lightweight-пути: 99 разрывов = 100 страниц
* (проходит), 100/101 = 101/102 (отказ с оценкой «не менее 1+breaks»).
*/
@Test
void checkPageCountLightweight_agreesWithJaxbPath() throws Exception {
// на фикстурах без кэша Pages оба пути обязаны совпадать,
// включая границу лимита: 99 разрывов = 100 страниц (проходит),
// 100/101 = 101/102 (отказ)
void checkPageCount_limitBoundary() throws Exception {
for (int breaks : new int[]{0, 3, 99, 100, 101}) {
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) {
assertDoesNotThrow(() -> WordPdfValidator.checkPageCountLightweight(bytes, 100));
assertDoesNotThrow(() -> WordPdfValidator.checkPageCount(bytes, 100));
} else {
ConversionException ex = assertThrows(ConversionException.class,
() -> WordPdfValidator.checkPageCountLightweight(bytes, 100));
ValidationException ex = assertThrows(ValidationException.class,
() -> WordPdfValidator.checkPageCount(bytes, 100));
assertTrue(ex.getMessage().contains("не менее " + (1 + breaks)),
"оценка lightweight должна совпадать с JAXB: " + ex.getMessage());
"оценка = 1 + число разрывов: " + ex.getMessage());
}
}
}
@@ -186,10 +124,9 @@ class WordPdfValidatorTest {
* 101 страница, отказ (старый код считал «все минус одна» без
* учёта типа: 101−1=100 и пропускал). Случай B: 101
* {@code continuous} + финальная {@code nextPage} — 1 страница,
* проходит (старый код раздувал до 102 и отвергал). В JAXB-модели
* body-direct sectPr не видны (docx4j оставляет только финальную
* в {@code body.getSectPr()}, {@code getContent()} пуст), поэтому
* расхождение lightweight здесь — допустимое завышение.
* проходит (старый код раздувал до 102 и отвергал); разрывы в
* колонтитулах только усиливают нижнюю оценку — расхождение с
* точным числом страниц здесь — допустимое завышение.
* Регрессия — WordPdfValidator#scanDocument.
*/
@Test
@@ -200,8 +137,8 @@ class WordPdfValidatorTest {
}
typesA.add("continuous"); // финальная секция — непрерывная
byte[] overLimit = docxWithBodySections(typesA);
ConversionException exLwA = assertThrows(ConversionException.class,
() -> WordPdfValidator.checkPageCountLightweight(overLimit, 100));
ValidationException exLwA = assertThrows(ValidationException.class,
() -> WordPdfValidator.checkPageCount(overLimit, 100));
assertTrue(exLwA.getMessage().contains("не менее 101"),
"оценка = 1 + 100 межсекционных nextPage: " + exLwA.getMessage());
@@ -211,7 +148,7 @@ class WordPdfValidatorTest {
}
typesB.add("nextPage"); // финальная секция
byte[] ok = docxWithBodySections(typesB);
assertDoesNotThrow(() -> WordPdfValidator.checkPageCountLightweight(ok, 100),
assertDoesNotThrow(() -> WordPdfValidator.checkPageCount(ok, 100),
"continuous-границы не страницы");
}
@@ -280,16 +217,10 @@ class WordPdfValidatorTest {
@Test
void pageCount_staleCacheLosesToLastRenderedMarkers() throws Exception {
byte[] bytes = staleCacheFixture();
WordprocessingMLPackage pkg = WordprocessingMLPackage.load(
new java.io.ByteArrayInputStream(bytes));
assertEquals(111, WordPdfValidator.pageCountOf(pkg),
"оценка = max(кэш 1, разрывы 1, маркеры 110+1)");
ConversionException ex = assertThrows(ConversionException.class,
() -> WordPdfValidator.checkPageCount(pkg, 100));
assertTrue(ex.getMessage().contains("100"), ex.getMessage());
// lightweight-путь обязан согласовать тот же отказ
assertThrows(ConversionException.class,
() -> WordPdfValidator.checkPageCountLightweight(bytes, 100));
ValidationException ex = assertThrows(ValidationException.class,
() -> WordPdfValidator.checkPageCount(bytes, 100));
assertTrue(ex.getMessage().contains("не менее 111"),
"оценка = max(кэш 1, разрывы 1, маркеры 110+1): " + ex.getMessage());
}
/**
@@ -311,20 +242,16 @@ class WordPdfValidatorTest {
doc.write(bos);
bytes = bos.toByteArray();
}
WordprocessingMLPackage pkg = WordprocessingMLPackage.load(
new java.io.ByteArrayInputStream(bytes));
assertEquals(121, WordPdfValidator.pageCountOf(pkg),
"разрывы в ячейке таблицы должны считаться");
assertThrows(ConversionException.class,
ValidationException ex = assertThrows(ValidationException.class,
() -> WordPdfValidator.checkPageCount(bytes, 100));
assertThrows(ConversionException.class,
() -> WordPdfValidator.checkPageCountLightweight(bytes, 100));
assertTrue(ex.getMessage().contains("не менее 121"),
"120 разрывов в ячейке таблицы + первая страница: " + ex.getMessage());
}
@Test
void checkPageCountLightweight_bytesNull() {
assertThrows(ConversionException.class,
() -> WordPdfValidator.checkPageCountLightweight((byte[]) null));
void checkPageCount_bytesNull() {
assertThrows(ValidationException.class,
() -> WordPdfValidator.checkPageCount((byte[]) null));
}
/**
@@ -354,9 +281,9 @@ class WordPdfValidatorTest {
// 3 разрыва + первая страница = не менее 4; до фикса lightweight
// не видел разрывы в strict-namespace и возвращал 1
assertDoesNotThrow(() -> WordPdfValidator.checkPageCountLightweight(docx, 4));
ConversionException ex = assertThrows(ConversionException.class,
() -> WordPdfValidator.checkPageCountLightweight(docx, 3));
assertDoesNotThrow(() -> WordPdfValidator.checkPageCount(docx, 4));
ValidationException ex = assertThrows(ValidationException.class,
() -> WordPdfValidator.checkPageCount(docx, 3));
assertTrue(ex.getMessage().contains("не менее 4"), ex.getMessage());
}
}