diff --git a/wordpdf-app/src/main/java/ru/pjandro/wordpdf/app/ApiExceptionHandler.java b/wordpdf-app/src/main/java/ru/pjandro/wordpdf/app/ApiExceptionHandler.java index 5f490cb..9e035bf 100644 --- a/wordpdf-app/src/main/java/ru/pjandro/wordpdf/app/ApiExceptionHandler.java +++ b/wordpdf-app/src/main/java/ru/pjandro/wordpdf/app/ApiExceptionHandler.java @@ -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": "..."}} с кодом по смыслу. * - *
Голый {@code ru.pjandro.wordpdf.ConversionException} ядра сюда не доходит: - * контроллер и {@link ConversionService} превращают его на границе в - * {@link ValidationException}/{@link ConversionFailedException}; случайная - * утечка попадёт в обработчик {@link Exception} (500).
+ *{@link ValidationException} ядра доходит сюда напрямую — валидатор + * бросает его сам; в {@link ConversionFailedException} превращается только + * прочий {@code ru.pjandro.wordpdf.ConversionException} рендер-стадии. + * Случайная утечка прочего исключения попадёт в обработчик {@link Exception} + * (500).
*/ @RestControllerAdvice final class ApiExceptionHandler { diff --git a/wordpdf-app/src/main/java/ru/pjandro/wordpdf/app/ConversionFailedException.java b/wordpdf-app/src/main/java/ru/pjandro/wordpdf/app/ConversionFailedException.java index 63db834..e044e6c 100644 --- a/wordpdf-app/src/main/java/ru/pjandro/wordpdf/app/ConversionFailedException.java +++ b/wordpdf-app/src/main/java/ru/pjandro/wordpdf/app/ConversionFailedException.java @@ -4,8 +4,9 @@ package ru.pjandro.wordpdf.app; * Ошибка преобразования: контейнер .docx принят валидацией, но упал сам * рендер (ядро, FOP, повреждённое содержимое внутри валидного zip). * - *Смысл отличается от {@link ValidationException}: вход формально корректен, - * отказал движок конвертации. Маппится в HTTP 500 ({@link ApiExceptionHandler}).
+ *Смысл отличается от {@code ru.pjandro.wordpdf.ValidationException}: + * вход формально корректен, отказал движок конвертации. + * Маппится в HTTP 500 ({@link ApiExceptionHandler}).
* *Регрессия — ConvertControllerTest#junkInsideValidZip_conversionError.
*/ diff --git a/wordpdf-app/src/main/java/ru/pjandro/wordpdf/app/ConversionService.java b/wordpdf-app/src/main/java/ru/pjandro/wordpdf/app/ConversionService.java index 34e1cd2..f5de6c2 100644 --- a/wordpdf-app/src/main/java/ru/pjandro/wordpdf/app/ConversionService.java +++ b/wordpdf-app/src/main/java/ru/pjandro/wordpdf/app/ConversionService.java @@ -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-путём ядра (может только завышать), - * поэтому уже принятый запрос внутренняя проверка ядра в ошибку не превратит. + * zip с мусором внутри (нет {@code word/document.xml}) — 500: до очереди и + * в конвейере ядра страницы проверяются одним и тем же lightweight-путём + * ({@link WordPdfValidator#checkPageCount}), поэтому уже принятый + * запрос внутренняя проверка ядра в ошибку не превратит. */ @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 { * *Проверка zip-подписи отдельным шагом обязательна: * {@code ZipInputStream.getNextEntry()} на не-zip-потоке возвращает - * {@code null} молча, и {@link WordPdfValidator#checkPageCountLightweight(byte[])} + * {@code null} молча, и {@link WordPdfValidator#checkPageCount(byte[])} * такой вход не отверг бы (0 страниц). Регрессия — * ConvertControllerTest#corruptNotAZip_rejected.
*/ 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 diff --git a/wordpdf-app/src/main/java/ru/pjandro/wordpdf/app/ConvertController.java b/wordpdf-app/src/main/java/ru/pjandro/wordpdf/app/ConvertController.java index 63b5dba..b8197fd 100644 --- a/wordpdf-app/src/main/java/ru/pjandro/wordpdf/app/ConvertController.java +++ b/wordpdf-app/src/main/java/ru/pjandro/wordpdf/app/ConvertController.java @@ -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; diff --git a/wordpdf-app/src/main/java/ru/pjandro/wordpdf/app/ValidationException.java b/wordpdf-app/src/main/java/ru/pjandro/wordpdf/app/ValidationException.java deleted file mode 100644 index 03b3c9a..0000000 --- a/wordpdf-app/src/main/java/ru/pjandro/wordpdf/app/ValidationException.java +++ /dev/null @@ -1,23 +0,0 @@ -package ru.pjandro.wordpdf.app; - -/** - * Некорректный вход: пустой файл, не .docx, не zip-архив, размер или число - * страниц сверх переданных в запросе (или дефолтных) лимитов. - * - *Отличается от {@link ConversionFailedException} смыслом: запрос - * некорректен сам по себе, повтор его же ничего не изменит. Маппится в HTTP 400 - * ({@link ApiExceptionHandler}).
- * - *Регрессия — ConvertControllerTest#nonDocxFilename_rejected, - * #oversizedOverCoreLimit_rejected, #corruptNotAZip_rejected.
- */ -class ValidationException extends RuntimeException { - - ValidationException(String message) { - super(message); - } - - ValidationException(String message, Throwable cause) { - super(message, cause); - } -} diff --git a/wordpdf-app/src/test/java/ru/pjandro/wordpdf/app/ConvertControllerTest.java b/wordpdf-app/src/test/java/ru/pjandro/wordpdf/app/ConvertControllerTest.java index 664ac0a..535337d 100644 --- a/wordpdf-app/src/test/java/ru/pjandro/wordpdf/app/ConvertControllerTest.java +++ b/wordpdf-app/src/test/java/ru/pjandro/wordpdf/app/ConvertControllerTest.java @@ -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 МБ"))); } /** diff --git a/wordpdf-core/src/main/java/ru/pjandro/wordpdf/ValidationException.java b/wordpdf-core/src/main/java/ru/pjandro/wordpdf/ValidationException.java new file mode 100644 index 0000000..cdc466a --- /dev/null +++ b/wordpdf-core/src/main/java/ru/pjandro/wordpdf/ValidationException.java @@ -0,0 +1,22 @@ +package ru.pjandro.wordpdf; + +/** + * Некорректный вход: {@code null}-байты, размер или число страниц сверх + * лимитов, неразбираемый .docx-контейнер (не zip / битый XML). + * + *Отличается от прочего {@link ConversionException} смыслом: вход плох сам + * по себе, повтор с теми же байтами ничего не изменит. Наследник + * {@code ConversionException} — наружу по-прежнему ловится только он + * (в т.ч. из {@link WordPdfConverter}, который вызывает валидатор сам). + * Регрессия — WordPdfValidatorTest, ConvertControllerTest#corruptNotAZip_rejected.
+ */ +public class ValidationException extends ConversionException { + + public ValidationException(String message) { + super(message); + } + + public ValidationException(String message, Throwable cause) { + super(message, cause); + } +} diff --git a/wordpdf-core/src/main/java/ru/pjandro/wordpdf/WordPdfConverter.java b/wordpdf-core/src/main/java/ru/pjandro/wordpdf/WordPdfConverter.java index e811631..a0c5398 100644 --- a/wordpdf-core/src/main/java/ru/pjandro/wordpdf/WordPdfConverter.java +++ b/wordpdf-core/src/main/java/ru/pjandro/wordpdf/WordPdfConverter.java @@ -59,14 +59,16 @@ public final class WordPdfConverter { * *Вход проверяется валидатором до рендера: {@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 { * *
Вход проверяется валидатором до рендера: {@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 Вход валидатора — только {@code byte[]} (или уже загруженный
- * {@link WordprocessingMLPackage}): файловых проверок нет, работа с
- * файлами — забота вызывающего (приложения).
+ * Вход валидатора — только {@code byte[]}: файловых проверок нет,
+ * работа с файлами — забота вызывающего (приложения).
*
* Конвертер {@link WordPdfConverter} вызывает валидатор автоматически,
* но им можно пользоваться и напрямую — например, проверить байты
@@ -55,7 +44,7 @@ import java.util.zip.ZipInputStream;
* Проверка делается до рендера — это позволяет отсекать слишком
* длинные документы, не тратя время на конвертацию.
*
- * Все ошибки — {@link ConversionException}.
+ * Все ошибки — {@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}). Дешёвый путь для проверки байтов из
* сети/БД до любой работы с библиотекой.
*
- * Оценка согласована с {@link #checkPageCount(WordprocessingMLPackage)}
- * по всем источникам; на границе лимита оба пути дают одинаковый ответ
- * (регрессия — {@code checkPageCountLightweight_agreesWithJaxbPath},
- * включая 99/100/101 разрывов). Lightweight-путь дополнительно считает
- * разрывы в колонтитулах — он консервативнее, расхождение возможно
+ * Оценка — максимум трёх нижних оценок: кэша Word в
+ * {@code docProps/app.xml} ({@code Не-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 и проверяет лимит.
- *
- * Число страниц — максимум трёх нижних оценок:
- * Оценка остаётся нижней: документ без явных разрывов и без
- * маркеров (никогда не открывался в 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
- *
- *
- *