Ядро: раздельные исключения ChartsFoundException/SmartArtFoundException/OleFoundException
PR checks / web (pull_request) Successful in 42s
PR checks / java (pull_request) Successful in 2m41s
Main: tests, deploy, autotests / web (push) Successful in 41s
Main: tests, deploy, autotests / images-web (push) Failing after 23s
Main: tests, deploy, autotests / java (push) Successful in 1m22s
Main: tests, deploy, autotests / images-app (push) Failing after 2m32s
Main: tests, deploy, autotests / deploy (push) Has been skipped
Main: tests, deploy, autotests / autotests (push) Has been skipped
Main: tests, deploy, autotests / rollback (push) Has been skipped
PR checks / web (pull_request) Successful in 42s
PR checks / java (pull_request) Successful in 2m41s
Main: tests, deploy, autotests / web (push) Successful in 41s
Main: tests, deploy, autotests / images-web (push) Failing after 23s
Main: tests, deploy, autotests / java (push) Successful in 1m22s
Main: tests, deploy, autotests / images-app (push) Failing after 2m32s
Main: tests, deploy, autotests / deploy (push) Has been skipped
Main: tests, deploy, autotests / autotests (push) Has been skipped
Main: tests, deploy, autotests / rollback (push) Has been skipped
DrawingFoundException с enum Kind удалён: каждый error-флаг бросает свой тип-наследник ConversionException с фиксированным сообщением. App-слой сохраняет один DrawingRejectedException (422) — маппинг по типу в ConversionService.doConvert, тексты ответа не изменились (контракт с фронтом). Обновлены тесты и документация.
This commit was merged in pull request #105.
This commit is contained in:
@@ -0,0 +1,16 @@
|
||||
package ru.pjandro.wordpdf;
|
||||
|
||||
/**
|
||||
* В документе найдены диаграммы, а их обработка запрещена включённым
|
||||
* {@link ConvertOptions#errorOnCharts()}. Исключение отвергает документ целиком.
|
||||
*
|
||||
* <p>Наследник {@link ConversionException} — наружу по-прежнему ловится и он.
|
||||
* Регрессия — WordPdfConverterTest#drawingErrors_errorFlagRejectsCharts,
|
||||
* фикстура samples/charts-smartart.docx.</p>
|
||||
*/
|
||||
public final class ChartsFoundException extends ConversionException {
|
||||
|
||||
public ChartsFoundException() {
|
||||
super("В документе найдены диаграммы, а их обработка запрещена (errorOnCharts)");
|
||||
}
|
||||
}
|
||||
@@ -6,9 +6,9 @@ package ru.pjandro.wordpdf;
|
||||
* сервера как дефолт REST-эндпоинта + параметры запроса). Диаграммы/SmartArt
|
||||
* конвертируются всегда.
|
||||
*
|
||||
* @param errorOnCharts бросать {@link DrawingFoundException} при находке диаграмм
|
||||
* @param errorOnSmartArt бросать {@link DrawingFoundException} при находке SmartArt
|
||||
* @param errorOnOle бросать {@link DrawingFoundException} при находке OLE-объектов
|
||||
* @param errorOnCharts бросать {@link ChartsFoundException} при находке диаграмм
|
||||
* @param errorOnSmartArt бросать {@link SmartArtFoundException} при находке SmartArt
|
||||
* @param errorOnOle бросать {@link OleFoundException} при находке OLE-объектов
|
||||
* (иначе — тихо удалить их из документа)
|
||||
* @param maxMb лимит размера входа в МБ (MiB) на этот вызов;
|
||||
* должен быть больше 0
|
||||
|
||||
@@ -1,45 +0,0 @@
|
||||
package ru.pjandro.wordpdf;
|
||||
|
||||
/**
|
||||
* Документ содержит объект, находку которого вызывающий запретил:
|
||||
* соответствующий error-флаг включён
|
||||
* ({@link ConvertOptions#errorOnCharts()}, {@link ConvertOptions#errorOnSmartArt()},
|
||||
* {@link ConvertOptions#errorOnOle()}).
|
||||
* Диаграммы/SmartArt конвертируются всегда; OLE-объекты при выключенном
|
||||
* {@code errorOnOle} теряют свои данные, но сохраняют картинку-плейсхолдер
|
||||
* (в отличие от них).
|
||||
* Исключение отвергает документ целиком.
|
||||
*
|
||||
* <p>Наследник {@link ConversionException} — наружу по-прежнему ловится
|
||||
* только он; {@code kind()} даёт вызывающему тип объекта без разбора текста.
|
||||
* Регрессия — WordPdfConverterTest#drawingErrors_errorFlagRejectsCharts,
|
||||
* фикстура samples/charts-smartart.docx; OLE —
|
||||
* WordPdfConverterTest#drawingErrors_errorFlagRejectsOle,
|
||||
* фикстура samples/ole-embedded.docx.</p>
|
||||
*/
|
||||
public class DrawingFoundException extends ConversionException {
|
||||
|
||||
/** Тип найденного объекта. */
|
||||
public enum Kind { CHARTS, SMARTART, OLE }
|
||||
|
||||
private final Kind kind;
|
||||
|
||||
public DrawingFoundException(Kind kind) {
|
||||
super(message(kind));
|
||||
this.kind = kind;
|
||||
}
|
||||
|
||||
// switch вынесен из super(): парсер PMD 7.17 (движок maven-pmd-plugin)
|
||||
// падает на switch-выражении в аргументе super (pmd/pmd#6234).
|
||||
private static String message(Kind kind) {
|
||||
return switch (kind) {
|
||||
case CHARTS -> "В документе найдены диаграммы, а их обработка запрещена (errorOnCharts)";
|
||||
case SMARTART -> "В документе найден SmartArt, а его обработка запрещена (errorOnSmartArt)";
|
||||
case OLE -> "В документе найдены OLE-объекты, а их обработка запрещена (errorOnOle)";
|
||||
};
|
||||
}
|
||||
|
||||
public Kind kind() {
|
||||
return kind;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,22 @@
|
||||
package ru.pjandro.wordpdf;
|
||||
|
||||
/**
|
||||
* В документе найдены OLE-объекты, а их обработка запрещена включённым
|
||||
* {@link ConvertOptions#errorOnOle()}. Исключение отвергает документ целиком.
|
||||
*
|
||||
* <p>При выключенном флаге OLE-объекты теряют свои данные, но сохраняют
|
||||
* картинку-плейсхолдер (в отличие от диаграмм/SmartArt, конвертируемых
|
||||
* всегда). Флаг действует только на {@code .docx}: в бинарном {@code .doc}
|
||||
* вложения OLE — форматирование U+0001, мост деградирует их до картинки,
|
||||
* поэтому находки OLE там не бывает.</p>
|
||||
*
|
||||
* <p>Наследник {@link ConversionException} — наружу по-прежнему ловится и он.
|
||||
* Регрессия — WordPdfConverterTest#drawingErrors_errorFlagRejectsOle,
|
||||
* фикстура samples/ole-embedded.docx; OleObjectNormalizerTest#errorOnOleThrowsOleFound.</p>
|
||||
*/
|
||||
public final class OleFoundException extends ConversionException {
|
||||
|
||||
public OleFoundException() {
|
||||
super("В документе найдены OLE-объекты, а их обработка запрещена (errorOnOle)");
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,16 @@
|
||||
package ru.pjandro.wordpdf;
|
||||
|
||||
/**
|
||||
* В документе найден SmartArt, а его обработка запрещена включённым
|
||||
* {@link ConvertOptions#errorOnSmartArt()}. Исключение отвергает документ целиком.
|
||||
*
|
||||
* <p>Наследник {@link ConversionException} — наружу по-прежнему ловится и он.
|
||||
* Регрессия — WordPdfConverterTest#drawingErrors_errorFlagRejectsSmartArt,
|
||||
* фикстура samples/charts-smartart.docx.</p>
|
||||
*/
|
||||
public final class SmartArtFoundException extends ConversionException {
|
||||
|
||||
public SmartArtFoundException() {
|
||||
super("В документе найден SmartArt, а его обработка запрещена (errorOnSmartArt)");
|
||||
}
|
||||
}
|
||||
@@ -469,7 +469,7 @@ public final class WordPdfConverter {
|
||||
// рерайтов внутри части фиксирован (DocxRewritePipeline)
|
||||
DocxRewritePipeline.STEP,
|
||||
// OLE-объекты: при выключенном errorOnOle тихо удаляем
|
||||
// (часть/rels/w:object), при включённом — DrawingFoundException
|
||||
// (часть/rels/w:object), при включённом — OleFoundException
|
||||
// (OleObjectNormalizer); второй проход, т.к. меняет части, а не XML
|
||||
bytes -> OleObjectNormalizer.normalize(bytes, options.errorOnOle()));
|
||||
}
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
package ru.pjandro.wordpdf.internal;
|
||||
|
||||
import ru.pjandro.wordpdf.DrawingFoundException;
|
||||
import ru.pjandro.wordpdf.OleFoundException;
|
||||
|
||||
import java.io.ByteArrayOutputStream;
|
||||
import java.io.IOException;
|
||||
@@ -48,7 +48,7 @@ import org.apache.commons.compress.utils.SeekableInMemoryByteChannel;
|
||||
* вывод не влияет.</p>
|
||||
*
|
||||
* <p>Отличие от остальных нормализаторов пакета: принимает флаг
|
||||
* {@code errorOnOle} и умеет бросать {@link DrawingFoundException}
|
||||
* {@code errorOnOle} и умеет бросать {@link OleFoundException}
|
||||
* (при включённом флаге документ отвергается вместо вычистки), и правит
|
||||
* не только {@code word/*.xml}, но и {@code [Content_Types].xml} с
|
||||
* {@code *.rels}. Хука {@code rewrite(String)} нет — нормализатор
|
||||
@@ -231,7 +231,7 @@ public final class OleObjectNormalizer {
|
||||
return docx;
|
||||
}
|
||||
if (errorOnOle) {
|
||||
throw new DrawingFoundException(DrawingFoundException.Kind.OLE);
|
||||
throw new OleFoundException();
|
||||
}
|
||||
for (String part : oleParts) {
|
||||
LOG.warning("Удалён OLE-объект: " + part);
|
||||
|
||||
+8
-5
@@ -35,9 +35,10 @@ import org.docx4j.openpackaging.parts.relationships.RelationshipsPart;
|
||||
import org.docx4j.wml.Drawing;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
import ru.pjandro.wordpdf.ChartsFoundException;
|
||||
import ru.pjandro.wordpdf.ConvertOptions;
|
||||
import ru.pjandro.wordpdf.ConversionException;
|
||||
import ru.pjandro.wordpdf.DrawingFoundException;
|
||||
import ru.pjandro.wordpdf.SmartArtFoundException;
|
||||
|
||||
import javax.imageio.ImageIO;
|
||||
import java.awt.image.BufferedImage;
|
||||
@@ -60,7 +61,8 @@ import java.util.Set;
|
||||
* и молча их выбросит (notImplemented в шаблоне).
|
||||
*
|
||||
* Error-флаги {@link ConvertOptions}: при выключенном render-флаге и
|
||||
* включённом error-флаге находка объекта — {@link DrawingFoundException}
|
||||
* включённом error-флаге находка объекта — {@link ChartsFoundException} или
|
||||
* {@link SmartArtFoundException}
|
||||
* (бросок здесь, на шаге 3.5, до XSLT/FOP). Регрессия —
|
||||
* WordPdfConverterTest#drawingErrors_errorFlagRejectsCharts, фикстура
|
||||
* samples/charts-smartart.docx.
|
||||
@@ -99,7 +101,8 @@ public final class DrawingPreRenderer {
|
||||
|
||||
/**
|
||||
* Рендерит диаграммы/SmartArt пакета в PNG и подменяет их картинками —
|
||||
* объекты конвертируются всегда. Бросается {@link DrawingFoundException},
|
||||
* объекты конвертируются всегда. Бросается {@link ChartsFoundException} или
|
||||
* {@link SmartArtFoundException},
|
||||
* когда для объектов включён error-флаг ({@link ConvertOptions}).
|
||||
*/
|
||||
public static void run(WordprocessingMLPackage pkg, ConvertOptions options) {
|
||||
@@ -225,10 +228,10 @@ public final class DrawingPreRenderer {
|
||||
boolean isChart = CHART_ELEMENT.equals(name);
|
||||
boolean isDiagram = DIAGRAM_ELEMENT.equals(name);
|
||||
if (isChart && options.errorOnCharts()) {
|
||||
throw new DrawingFoundException(DrawingFoundException.Kind.CHARTS);
|
||||
throw new ChartsFoundException();
|
||||
}
|
||||
if (isDiagram && options.errorOnSmartArt()) {
|
||||
throw new DrawingFoundException(DrawingFoundException.Kind.SMARTART);
|
||||
throw new SmartArtFoundException();
|
||||
}
|
||||
if (cx <= 0 || cy <= 0 || cx > MAX_EXTENT_EMU || cy > MAX_EXTENT_EMU) {
|
||||
LOG.warn("drawing вне допустимого wp:extent (cx={}, cy={}) — объект оставлен как есть",
|
||||
|
||||
@@ -277,38 +277,32 @@ class WordPdfConverterTest {
|
||||
}
|
||||
|
||||
/**
|
||||
* errorOnCharts=true: находка диаграмм — {@link DrawingFoundException}
|
||||
* с {@code Kind.CHARTS}, документ отвергается целиком. Error-флаг SmartArt
|
||||
* errorOnCharts=true: находка диаграмм — {@link ChartsFoundException},
|
||||
* документ отвергается целиком. Error-флаг SmartArt
|
||||
* выключен — он конвертируется как обычно, бросок происходит на графике.
|
||||
*/
|
||||
@Test
|
||||
void drawingErrors_errorFlagRejectsCharts() throws Exception {
|
||||
ConversionException ex = assertThrows(ConversionException.class, () ->
|
||||
ChartsFoundException ex = assertThrows(ChartsFoundException.class, () ->
|
||||
convertPdf(sampleBytes("charts-smartart.docx"), "charts-smartart",
|
||||
new ConvertOptions(true, false, false,
|
||||
5, 100)));
|
||||
|
||||
assertTrue(ex instanceof DrawingFoundException dfe
|
||||
&& dfe.kind() == DrawingFoundException.Kind.CHARTS,
|
||||
"ожидался DrawingFoundException(CHARTS), получено: " + ex);
|
||||
assertTrue(ex.getMessage().contains("диаграмм"),
|
||||
"сообщение должно упоминать диаграммы: " + ex.getMessage());
|
||||
}
|
||||
|
||||
/**
|
||||
* Зеркальный случай: errorOnSmartArt=true — {@code Kind.SMARTART};
|
||||
* Зеркальный случай: errorOnSmartArt=true — {@link SmartArtFoundException};
|
||||
* диаграммы конвертируются (их error-флаг выключен).
|
||||
*/
|
||||
@Test
|
||||
void drawingErrors_errorFlagRejectsSmartArt() throws Exception {
|
||||
ConversionException ex = assertThrows(ConversionException.class, () ->
|
||||
SmartArtFoundException ex = assertThrows(SmartArtFoundException.class, () ->
|
||||
convertPdf(sampleBytes("charts-smartart.docx"), "charts-smartart",
|
||||
new ConvertOptions(false, true, false,
|
||||
5, 100)));
|
||||
|
||||
assertTrue(ex instanceof DrawingFoundException dfe
|
||||
&& dfe.kind() == DrawingFoundException.Kind.SMARTART,
|
||||
"ожидался DrawingFoundException(SMARTART), получено: " + ex);
|
||||
assertTrue(ex.getMessage().contains("SmartArt"),
|
||||
"сообщение должно упоминать SmartArt: " + ex.getMessage());
|
||||
}
|
||||
@@ -349,7 +343,7 @@ class WordPdfConverterTest {
|
||||
}
|
||||
|
||||
/**
|
||||
* errorOnOle=true — {@link DrawingFoundException} с {@code Kind.OLE},
|
||||
* errorOnOle=true — {@link OleFoundException},
|
||||
* документ отвергается. Фикстура samples/ole-embedded.docx.
|
||||
*
|
||||
* <p>Флаг действует только на .docx: в бинарном .doc OLE-объект —
|
||||
@@ -358,14 +352,11 @@ class WordPdfConverterTest {
|
||||
*/
|
||||
@Test
|
||||
void drawingErrors_errorFlagRejectsOle() throws Exception {
|
||||
ConversionException ex = assertThrows(ConversionException.class, () ->
|
||||
OleFoundException ex = assertThrows(OleFoundException.class, () ->
|
||||
convertPdf(sampleBytes("ole-embedded.docx"), "ole-embedded",
|
||||
new ConvertOptions(false, false, true,
|
||||
5, 100)));
|
||||
|
||||
assertTrue(ex instanceof DrawingFoundException dfe
|
||||
&& dfe.kind() == DrawingFoundException.Kind.OLE,
|
||||
"ожидался DrawingFoundException(OLE), получено: " + ex);
|
||||
assertTrue(ex.getMessage().contains("OLE-объект"),
|
||||
"сообщение должно упоминать OLE-объекты: " + ex.getMessage());
|
||||
}
|
||||
@@ -1368,19 +1359,16 @@ class WordPdfConverterTest {
|
||||
|
||||
/**
|
||||
* Error-флаг обязан сработать и для drawing без wp:extent: детект payload
|
||||
* идёт до extent-guard'а (иначе обход — DrawingFoundException(CHARTS)).
|
||||
* идёт до extent-guard'а (иначе обход — ChartsFoundException).
|
||||
* Регрессия — DrawingPreRenderer#replaceDrawing.
|
||||
*/
|
||||
@Test
|
||||
void chartWithoutExtent_errorFlagRejects() throws Exception {
|
||||
byte[] docx = chartDocx(0, 0, PLAIN_VALAX);
|
||||
ConversionException ex = assertThrows(ConversionException.class, () ->
|
||||
assertThrows(ChartsFoundException.class, () ->
|
||||
convertPdf(docx, "no-extent",
|
||||
new ConvertOptions(true, false, false,
|
||||
5, 100)));
|
||||
assertTrue(ex instanceof DrawingFoundException dfe
|
||||
&& dfe.kind() == DrawingFoundException.Kind.CHARTS,
|
||||
"ожидался DrawingFoundException(CHARTS), получено: " + ex);
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
package ru.pjandro.wordpdf.internal;
|
||||
|
||||
import org.junit.jupiter.api.Test;
|
||||
import ru.pjandro.wordpdf.DrawingFoundException;
|
||||
import ru.pjandro.wordpdf.OleFoundException;
|
||||
|
||||
import java.io.ByteArrayInputStream;
|
||||
import java.io.ByteArrayOutputStream;
|
||||
@@ -197,10 +197,9 @@ class OleObjectNormalizerTest {
|
||||
}
|
||||
|
||||
@Test
|
||||
void errorOnOleThrowsDrawingFound() throws Exception {
|
||||
DrawingFoundException ex = assertThrows(DrawingFoundException.class,
|
||||
void errorOnOleThrowsOleFound() throws Exception {
|
||||
assertThrows(OleFoundException.class,
|
||||
() -> OleObjectNormalizer.normalize(referencedDocx(), true));
|
||||
assertEquals(DrawingFoundException.Kind.OLE, ex.kind());
|
||||
}
|
||||
|
||||
@Test
|
||||
@@ -668,9 +667,8 @@ class OleObjectNormalizerTest {
|
||||
m.put("word/document.xml",
|
||||
utf8("x".repeat(8188) + "<w:object>" + "</w:object>"));
|
||||
|
||||
DrawingFoundException ex = assertThrows(DrawingFoundException.class,
|
||||
assertThrows(OleFoundException.class,
|
||||
() -> OleObjectNormalizer.normalize(zip(m), true));
|
||||
assertEquals(DrawingFoundException.Kind.OLE, ex.kind());
|
||||
}
|
||||
|
||||
/** errorOnOle и только w:object-разметка (без bin-части) — документ отвергается. */
|
||||
@@ -683,9 +681,8 @@ class OleObjectNormalizerTest {
|
||||
m.put("word/_rels/document.xml.rels", utf8(DOCRELS_OLE_AND_IMAGE));
|
||||
m.put("word/media/fallback.png", PNG);
|
||||
|
||||
DrawingFoundException ex = assertThrows(DrawingFoundException.class,
|
||||
assertThrows(OleFoundException.class,
|
||||
() -> OleObjectNormalizer.normalize(zip(m), true));
|
||||
assertEquals(DrawingFoundException.Kind.OLE, ex.kind());
|
||||
}
|
||||
|
||||
/** doc из переданных блоков w:object (все ссылаются на rId1/rId2 из DOCRELS_OLE_AND_IMAGE). */
|
||||
|
||||
Reference in New Issue
Block a user