refactor: лимит размера входа во всех слоях — MAX_MB (МБ=MiB), байты вычисляются в checkInput
Ядро: WordPdfSettings.MAX_INPUT_MB=5, ConvertOptions.maxMb, WordPdfValidator.checkInput(byte[], long maxMb) — единственная точка пересчёта МБ→байты, сообщение «Файл больше N МБ: X байт > Y байт». Приложение: свойство wordpdf.max-mb (env WORDPDF_MAX_MB, relaxed binding). CI/конфиг/автотесты/доки: WORDPDF_MAX_BYTES → WORDPDF_MAX_MB (значение 5).
This commit is contained in:
@@ -15,19 +15,19 @@ package ru.pjandro.wordpdf;
|
||||
* @param errorOnSmartArt бросать {@link DrawingFoundException} при находке
|
||||
* SmartArt, **только если** {@code renderSmartArt}
|
||||
* выключен (рендер приоритетнее error-флага)
|
||||
* @param maxBytes лимит размера входных байтов на этот вызов;
|
||||
* дефолт — {@link WordPdfSettings#MAX_INPUT_BYTES}
|
||||
* @param maxMb лимит размера входа в МБ (MiB) на этот вызов;
|
||||
* дефолт — {@link WordPdfSettings#MAX_INPUT_MB}
|
||||
* @param maxPages лимит числа страниц на этот вызов;
|
||||
* дефолт — {@link WordPdfSettings#MAX_PAGES}
|
||||
*/
|
||||
public record ConvertOptions(boolean renderCharts, boolean renderSmartArt,
|
||||
boolean errorOnCharts, boolean errorOnSmartArt,
|
||||
long maxBytes, int maxPages) {
|
||||
long maxMb, int maxPages) {
|
||||
|
||||
/** Дефолты ядра из {@link WordPdfSettings}. */
|
||||
public static ConvertOptions defaults() {
|
||||
return new ConvertOptions(WordPdfSettings.RENDER_CHARTS, WordPdfSettings.RENDER_SMARTART,
|
||||
WordPdfSettings.ERROR_ON_CHARTS, WordPdfSettings.ERROR_ON_SMARTART,
|
||||
WordPdfSettings.MAX_INPUT_BYTES, WordPdfSettings.MAX_PAGES);
|
||||
WordPdfSettings.MAX_INPUT_MB, WordPdfSettings.MAX_PAGES);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -58,7 +58,7 @@ public final class WordPdfConverter {
|
||||
* (файловое API было здесь раньше; ядро пути не принимает).
|
||||
*
|
||||
* <p>Вход проверяется {@link WordPdfValidator#validate(byte[], ConvertOptions)} до рендера:
|
||||
* {@code null} / размер больше {@link WordPdfSettings#MAX_INPUT_BYTES} / zip-подпись /
|
||||
* {@code null} / размер больше {@link WordPdfSettings#MAX_INPUT_MB} (МБ) / zip-подпись /
|
||||
* число страниц больше {@link WordPdfSettings#MAX_PAGES} — при отказе байтов результата нет;
|
||||
* страницы дополнительно перепроверяются по нормализованным байтам (шаг 2.5).
|
||||
*
|
||||
@@ -66,7 +66,7 @@ public final class WordPdfConverter {
|
||||
* @param title заголовок PDF (метаданные); {@code null}/пустая — заголовок не задаётся
|
||||
* @return байты готового PDF
|
||||
* @throws ValidationException некорректный вход: {@code null}, размер больше
|
||||
* {@link WordPdfSettings#MAX_INPUT_BYTES}, не zip-архив, документ длиннее
|
||||
* {@link WordPdfSettings#MAX_INPUT_MB} (МБ), не zip-архив, документ длиннее
|
||||
* {@link WordPdfSettings#MAX_PAGES} страниц
|
||||
* @throws ConversionException прочие ошибки (битый .docx, ошибка рендера)
|
||||
*/
|
||||
@@ -79,7 +79,7 @@ public final class WordPdfConverter {
|
||||
* диаграмм/SmartArt и лимиты входа.
|
||||
*
|
||||
* <p>Вход проверяется {@link WordPdfValidator#validate(byte[], ConvertOptions)} до рендера:
|
||||
* {@code null} / размер больше {@code options.maxBytes()} / zip-подпись / число страниц
|
||||
* {@code null} / размер больше {@code options.maxMb()} (МБ) / zip-подпись / число страниц
|
||||
* больше {@code options.maxPages()} — при отказе байтов результата нет; страницы
|
||||
* дополнительно перепроверяются по нормализованным байтам (шаг 2.5).
|
||||
*
|
||||
@@ -89,7 +89,7 @@ public final class WordPdfConverter {
|
||||
* дефолты (константы {@link WordPdfSettings})
|
||||
* @return байты готового PDF
|
||||
* @throws ValidationException некорректный вход: {@code null}, размер больше
|
||||
* {@code options.maxBytes()}, не zip-архив, документ длиннее
|
||||
* {@code options.maxMb()} (МБ), не zip-архив, документ длиннее
|
||||
* {@code options.maxPages()} страниц
|
||||
* @throws ConversionException прочие ошибки (битый .docx, ошибка рендера)
|
||||
*/
|
||||
|
||||
@@ -3,14 +3,14 @@ package ru.pjandro.wordpdf;
|
||||
/**
|
||||
* Единая точка конфигурации ядра: все настройки-дефолты — константы здесь.
|
||||
* Рантайм-конфигурации нет: изменение значения = правка этого файла и пересборка.
|
||||
* Лимиты входа ({@link #MAX_INPUT_BYTES}, {@link #MAX_PAGES}) — дефолты:
|
||||
* Лимиты входа ({@link #MAX_INPUT_MB}, {@link #MAX_PAGES}) — дефолты:
|
||||
* вызывающий может переопределить их на конкретный вызов через
|
||||
* {@link ConvertOptions}.
|
||||
*/
|
||||
public final class WordPdfSettings {
|
||||
|
||||
/** Максимальный размер входного .docx (дефолт). 5 MiB = 5 × 1024 × 1024. */
|
||||
public static final long MAX_INPUT_BYTES = 5L * 1024 * 1024;
|
||||
/** Максимальный размер входного .docx в МБ (дефолт). МБ = MiB = 1024 × 1024 байт. */
|
||||
public static final long MAX_INPUT_MB = 5;
|
||||
|
||||
/** Документ длиннее — ошибка (дефолт). */
|
||||
public static final int MAX_PAGES = 100;
|
||||
|
||||
@@ -26,7 +26,7 @@ import java.util.zip.ZipInputStream;
|
||||
*
|
||||
* <p>Лимиты по умолчанию:
|
||||
* <ul>
|
||||
* <li>{@link WordPdfSettings#MAX_INPUT_BYTES} — максимальный размер входного .docx;</li>
|
||||
* <li>{@link WordPdfSettings#MAX_INPUT_MB} — максимальный размер входного .docx (МБ);</li>
|
||||
* <li>{@link WordPdfSettings#MAX_PAGES} — максимально допустимое число страниц.</li>
|
||||
* </ul>
|
||||
* Оба переопределяются на вызов: перегрузками с явным лимитом или
|
||||
@@ -54,29 +54,26 @@ public final class WordPdfValidator {
|
||||
/**
|
||||
* Проверяет размер байтов входа (для документа, полученного из сети/БД).
|
||||
*
|
||||
* @throws ValidationException при {@code null} или превышении лимита
|
||||
* @throws ValidationException при {@code null} или превышении лимита (МБ)
|
||||
*/
|
||||
public static void checkInput(byte[] docxBytes) throws ValidationException {
|
||||
checkInput(docxBytes, WordPdfSettings.MAX_INPUT_BYTES);
|
||||
checkInput(docxBytes, WordPdfSettings.MAX_INPUT_MB);
|
||||
}
|
||||
|
||||
/**
|
||||
* Проверяет размер байтов входа против явного лимита (переопределение
|
||||
* на вызов, см. {@link ConvertOptions#maxBytes()}).
|
||||
* Проверяет размер байтов входа против явного лимита в МБ (переопределение
|
||||
* на вызов, см. {@link ConvertOptions#maxMb()}). МБ = MiB = 1024 × 1024 байт.
|
||||
*
|
||||
* @throws ValidationException при {@code null} или превышении {@code maxBytes}
|
||||
* @throws ValidationException при {@code null} или превышении {@code maxMb} (МБ)
|
||||
*/
|
||||
public static void checkInput(byte[] docxBytes, long maxBytes) throws ValidationException {
|
||||
public static void checkInput(byte[] docxBytes, long maxMb) throws ValidationException {
|
||||
if (docxBytes == null) {
|
||||
throw new ValidationException("Не указаны байты входного файла");
|
||||
}
|
||||
long maxBytes = maxMb * 1024 * 1024;
|
||||
if (docxBytes.length > maxBytes) {
|
||||
// дефолтный лимит кратен MiB — сообщение остаётся «... 5 МБ ...»
|
||||
String limit = maxBytes % (1024 * 1024) == 0
|
||||
? (maxBytes / (1024 * 1024)) + " МБ"
|
||||
: maxBytes + " байт";
|
||||
throw new ValidationException("Файл больше " + limit
|
||||
+ ": " + docxBytes.length + " байт > " + maxBytes + " байт");
|
||||
throw new ValidationException("Файл больше " + maxMb + " МБ: "
|
||||
+ docxBytes.length + " байт > " + maxBytes + " байт");
|
||||
}
|
||||
}
|
||||
|
||||
@@ -155,7 +152,7 @@ public final class WordPdfValidator {
|
||||
* Полная проверка входа: размер → zip-подпись → число страниц. Порядок
|
||||
* значим: размер — дешёвая, разбор zip без подписи бессмысленен. Лимиты
|
||||
* берутся из {@link ConvertOptions} (переопределение на вызов, см.
|
||||
* {@link ConvertOptions#maxBytes()}, {@link ConvertOptions#maxPages()}).
|
||||
* {@link ConvertOptions#maxMb()}, {@link ConvertOptions#maxPages()}).
|
||||
*
|
||||
* <p>Проверка zip-подписи отдельным шагом обязательна:
|
||||
* {@code ZipInputStream.getNextEntry()} на не-zip-потоке возвращает
|
||||
@@ -164,11 +161,11 @@ public final class WordPdfValidator {
|
||||
* {@code WordPdfValidatorTest#validate_notAZip} (на HTTP-границе —
|
||||
* {@code ConvertControllerTest#corruptNotAZip_rejected}).</p>
|
||||
*
|
||||
* @throws ValidationException при {@code null}, превышении {@code options.maxBytes()},
|
||||
* @throws ValidationException при {@code null}, превышении {@code options.maxMb()},
|
||||
* отсутствии zip-подписи, ошибке разбора zip или превышении {@code options.maxPages()}
|
||||
*/
|
||||
public static void validate(byte[] docxBytes, ConvertOptions options) throws ValidationException {
|
||||
checkInput(docxBytes, options.maxBytes());
|
||||
checkInput(docxBytes, options.maxMb());
|
||||
if (docxBytes.length < 4 || docxBytes[0] != 'P' || docxBytes[1] != 'K'
|
||||
|| (docxBytes[2] & 0xFF) != 0x03 || (docxBytes[3] & 0xFF) != 0x04) {
|
||||
throw new ValidationException("Содержимое не похоже на .docx (не zip-архив)");
|
||||
|
||||
@@ -156,7 +156,7 @@ class WordPdfConverterTest {
|
||||
void drawingToggles_offRemovesRasters() throws Exception {
|
||||
Path pdf = convertPdf(sampleBytes("charts-smartart.docx"), "charts-smartart",
|
||||
new ConvertOptions(false, false, false, false,
|
||||
WordPdfSettings.MAX_INPUT_BYTES, WordPdfSettings.MAX_PAGES));
|
||||
WordPdfSettings.MAX_INPUT_MB, WordPdfSettings.MAX_PAGES));
|
||||
|
||||
String text = norm(pdfText(pdf));
|
||||
assertTrue(text.contains("Диаграммы"), "пропал текст вокруг диаграмм: " + text);
|
||||
@@ -173,7 +173,7 @@ class WordPdfConverterTest {
|
||||
void drawingToggles_chartsOffSmartArtOn() throws Exception {
|
||||
Path pdf = convertPdf(sampleBytes("charts-smartart.docx"), "charts-smartart",
|
||||
new ConvertOptions(false, true, false, false,
|
||||
WordPdfSettings.MAX_INPUT_BYTES, WordPdfSettings.MAX_PAGES));
|
||||
WordPdfSettings.MAX_INPUT_MB, WordPdfSettings.MAX_PAGES));
|
||||
|
||||
String text = norm(pdfText(pdf));
|
||||
assertTrue(text.contains("Диаграммы"), "пропал текст вокруг диаграмм: " + text);
|
||||
@@ -192,7 +192,7 @@ class WordPdfConverterTest {
|
||||
ConversionException ex = assertThrows(ConversionException.class, () ->
|
||||
convertPdf(sampleBytes("charts-smartart.docx"), "charts-smartart",
|
||||
new ConvertOptions(false, true, true, false,
|
||||
WordPdfSettings.MAX_INPUT_BYTES, WordPdfSettings.MAX_PAGES)));
|
||||
WordPdfSettings.MAX_INPUT_MB, WordPdfSettings.MAX_PAGES)));
|
||||
|
||||
assertTrue(ex instanceof DrawingFoundException dfe
|
||||
&& dfe.kind() == DrawingFoundException.Kind.CHARTS,
|
||||
@@ -210,7 +210,7 @@ class WordPdfConverterTest {
|
||||
ConversionException ex = assertThrows(ConversionException.class, () ->
|
||||
convertPdf(sampleBytes("charts-smartart.docx"), "charts-smartart",
|
||||
new ConvertOptions(true, false, false, true,
|
||||
WordPdfSettings.MAX_INPUT_BYTES, WordPdfSettings.MAX_PAGES)));
|
||||
WordPdfSettings.MAX_INPUT_MB, WordPdfSettings.MAX_PAGES)));
|
||||
|
||||
assertTrue(ex instanceof DrawingFoundException dfe
|
||||
&& dfe.kind() == DrawingFoundException.Kind.SMARTART,
|
||||
@@ -227,7 +227,7 @@ class WordPdfConverterTest {
|
||||
void drawingErrors_renderFlagWins() throws Exception {
|
||||
Path pdf = convertPdf(sampleBytes("charts-smartart.docx"), "charts-smartart",
|
||||
new ConvertOptions(true, true, true, true,
|
||||
WordPdfSettings.MAX_INPUT_BYTES, WordPdfSettings.MAX_PAGES));
|
||||
WordPdfSettings.MAX_INPUT_MB, WordPdfSettings.MAX_PAGES));
|
||||
|
||||
assertTrue(imageCount(pdf) >= 4,
|
||||
"рендер должен победить error-флаг, найдено растров: " + imageCount(pdf));
|
||||
@@ -441,7 +441,7 @@ class WordPdfConverterTest {
|
||||
*/
|
||||
@Test
|
||||
void inputTooLarge() {
|
||||
byte[] tooBig = new byte[(int) WordPdfSettings.MAX_INPUT_BYTES + 1];
|
||||
byte[] tooBig = new byte[(int) (WordPdfSettings.MAX_INPUT_MB * 1024 * 1024) + 1];
|
||||
ValidationException ex = assertThrows(ValidationException.class, () ->
|
||||
WordPdfConverter.convert(tooBig, "too-big"));
|
||||
assertTrue(ex.getMessage().contains("5 МБ"),
|
||||
@@ -465,16 +465,19 @@ class WordPdfConverterTest {
|
||||
|
||||
/**
|
||||
* Лимит размера переопределяется {@link ConvertOptions} на вызов:
|
||||
* maxBytes=1000 отсекает даже маленький документ до рендера, сообщение
|
||||
* содержит переданное значение в байтах.
|
||||
* maxMb=1 отсекает вход больше 1 MiB до рендера, сообщение содержит
|
||||
* переданное значение в МБ и байтах.
|
||||
*/
|
||||
@Test
|
||||
void limitsOverriddenByOptions() throws Exception {
|
||||
void limitsOverriddenByOptions() {
|
||||
byte[] big = new byte[1024 * 1024 + 1];
|
||||
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 байт"),
|
||||
WordPdfConverter.convert(big, "x",
|
||||
new ConvertOptions(true, true, false, false, 1, WordPdfSettings.MAX_PAGES)));
|
||||
assertTrue(ex.getMessage().contains("1 МБ"),
|
||||
"сообщение должно упоминать переданный лимит: " + ex.getMessage());
|
||||
assertTrue(ex.getMessage().contains("1048576 байт"),
|
||||
"сообщение должно упоминать лимит в байтах: " + ex.getMessage());
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -487,7 +490,7 @@ class WordPdfConverterTest {
|
||||
ValidationException ex = assertThrows(ValidationException.class, () ->
|
||||
WordPdfConverter.convert(
|
||||
sampleBytes("too-many-pages.docx"), "too-many-pages",
|
||||
new ConvertOptions(true, true, false, false, WordPdfSettings.MAX_INPUT_BYTES, 100)));
|
||||
new ConvertOptions(true, true, false, false, WordPdfSettings.MAX_INPUT_MB, 100)));
|
||||
assertTrue(ex.getMessage().contains("100"),
|
||||
"сообщение должно упоминать лимит: " + ex.getMessage());
|
||||
}
|
||||
@@ -503,7 +506,7 @@ class WordPdfConverterTest {
|
||||
void staleCachePageCountRejectedBeforeRender() {
|
||||
ValidationException ex = assertThrows(ValidationException.class, () ->
|
||||
WordPdfConverter.convert(sampleBytes("stale-cache.docx"), "stale-cache",
|
||||
new ConvertOptions(true, true, false, false, WordPdfSettings.MAX_INPUT_BYTES, 100)));
|
||||
new ConvertOptions(true, true, false, false, WordPdfSettings.MAX_INPUT_MB, 100)));
|
||||
assertTrue(ex.getMessage().contains("100"),
|
||||
"сообщение должно упоминать лимит: " + ex.getMessage());
|
||||
}
|
||||
|
||||
@@ -40,7 +40,7 @@ class WordPdfValidatorTest {
|
||||
|
||||
@Test
|
||||
void checkInput_bytesOverLimit() {
|
||||
byte[] big = new byte[(int) WordPdfSettings.MAX_INPUT_BYTES + 1];
|
||||
byte[] big = new byte[(int) (WordPdfSettings.MAX_INPUT_MB * 1024 * 1024) + 1];
|
||||
ValidationException ex = assertThrows(ValidationException.class,
|
||||
() -> WordPdfValidator.checkInput(big));
|
||||
assertTrue(ex.getMessage().contains("5 МБ"),
|
||||
@@ -54,15 +54,15 @@ class WordPdfValidatorTest {
|
||||
}
|
||||
|
||||
/**
|
||||
* Явный лимит размера (переопределение на вызов): меньше — проходит,
|
||||
* больше — отказ с не-МБ формулировкой «N байт».
|
||||
* Явный лимит размера в МБ (переопределение на вызов): меньше 1 MiB —
|
||||
* проходит, больше — отказ с лимитом в МБ и байтах.
|
||||
*/
|
||||
@Test
|
||||
void checkInput_customLimit() {
|
||||
assertDoesNotThrow(() -> WordPdfValidator.checkInput(new byte[10], 100));
|
||||
assertDoesNotThrow(() -> WordPdfValidator.checkInput(new byte[10], 1));
|
||||
ValidationException ex = assertThrows(ValidationException.class,
|
||||
() -> WordPdfValidator.checkInput(new byte[11], 10));
|
||||
assertTrue(ex.getMessage().contains("10 байт"),
|
||||
() -> WordPdfValidator.checkInput(new byte[1024 * 1024 + 1], 1));
|
||||
assertTrue(ex.getMessage().contains("1 МБ"),
|
||||
"сообщение должно упоминать переданный лимит: " + ex.getMessage());
|
||||
}
|
||||
|
||||
@@ -256,8 +256,8 @@ class WordPdfValidatorTest {
|
||||
|
||||
// ===== validate(byte[], ConvertOptions) =====
|
||||
|
||||
private static ConvertOptions options(long maxBytes, int maxPages) {
|
||||
return new ConvertOptions(true, true, false, false, maxBytes, maxPages);
|
||||
private static ConvertOptions options(long maxMb, int maxPages) {
|
||||
return new ConvertOptions(true, true, false, false, maxMb, maxPages);
|
||||
}
|
||||
|
||||
@Test
|
||||
@@ -268,7 +268,7 @@ class WordPdfValidatorTest {
|
||||
|
||||
@Test
|
||||
void validate_bytesOverLimit() {
|
||||
byte[] big = new byte[(int) WordPdfSettings.MAX_INPUT_BYTES + 1];
|
||||
byte[] big = new byte[(int) (WordPdfSettings.MAX_INPUT_MB * 1024 * 1024) + 1];
|
||||
ValidationException ex = assertThrows(ValidationException.class,
|
||||
() -> WordPdfValidator.validate(big, ConvertOptions.defaults()));
|
||||
assertTrue(ex.getMessage().contains("5 МБ"),
|
||||
@@ -289,7 +289,7 @@ class WordPdfValidatorTest {
|
||||
byte[] bytes = docxWithPageBreaks(120);
|
||||
ValidationException ex = assertThrows(ValidationException.class,
|
||||
() -> WordPdfValidator.validate(bytes,
|
||||
options(WordPdfSettings.MAX_INPUT_BYTES, 100)));
|
||||
options(WordPdfSettings.MAX_INPUT_MB, 100)));
|
||||
assertTrue(ex.getMessage().contains("не менее 121"),
|
||||
"оценка = 1 + 120 разрывов: " + ex.getMessage());
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user