OLE-объекты: переключатель errorOnOle + тихое удаление из docx
PR checks / java (pull_request) Successful in 47s
PR checks / web (pull_request) Successful in 1m6s

docx4j падает на внедрённых OLE-объектах двумя путями: JAXB-парсинг
бинарника под ложным XML-типом в [Content_Types] («Content is not
allowed in prolog» → NPE) и NPE chunkType is null в VML-сериализации
w:object. Новый OleObjectNormalizer (шестой в цепочке, после
GlyphCoverageNormalizer) удаляет OLE-bin-части, rels-ссылки, элементы
w:object и Override удалённых частей; при errorOnOle=true вместо
удаления — DrawingFoundException(OLE) → 422 «Конвертация отменена: в
документе найдены OLE-объекты».

- ядро: Kind.OLE, ConvertOptions.errorOnOle, WordPdfSettings.ERROR_ON_OLE,
  фикстура samples/ole-embedded.docx (ручная, оба механизма)
- app: параметр errorOnOle, 422-контракт, тесты errorFlagOle_rejected /
  oleObjects_removedByDefault
- SPA: третий переключатель «OLE-объекты»
- прод-автотесты: +2 проверки (21)
- регрессии: OleObjectNormalizerTest ↔ oleObjects_removedAndConverted /
  drawingErrors_errorFlagRejectsOle; E2E: notConverted.docx 500 → 200
This commit is contained in:
Pjandro
2026-10-22 21:08:18 +00:00
parent 62ae5ee164
commit 93ec325aa6
17 changed files with 718 additions and 39 deletions
@@ -8,17 +8,19 @@ package ru.pjandro.wordpdf;
*
* @param errorOnCharts бросать {@link DrawingFoundException} при находке диаграмм
* @param errorOnSmartArt бросать {@link DrawingFoundException} при находке SmartArt
* @param errorOnOle бросать {@link DrawingFoundException} при находке OLE-объектов
* (иначе — тихо удалить их из документа)
* @param maxMb лимит размера входа в МБ (MiB) на этот вызов;
* дефолт — {@link WordPdfSettings#MAX_INPUT_MB}
* @param maxPages лимит числа страниц на этот вызов;
* дефолт — {@link WordPdfSettings#MAX_PAGES}
*/
public record ConvertOptions(boolean errorOnCharts, boolean errorOnSmartArt,
public record ConvertOptions(boolean errorOnCharts, boolean errorOnSmartArt, boolean errorOnOle,
long maxMb, int maxPages) {
/** Дефолты ядра из {@link WordPdfSettings}. */
public static ConvertOptions defaults() {
return new ConvertOptions(WordPdfSettings.ERROR_ON_CHARTS, WordPdfSettings.ERROR_ON_SMARTART,
WordPdfSettings.MAX_INPUT_MB, WordPdfSettings.MAX_PAGES);
WordPdfSettings.ERROR_ON_OLE, WordPdfSettings.MAX_INPUT_MB, WordPdfSettings.MAX_PAGES);
}
}
@@ -3,25 +3,32 @@ package ru.pjandro.wordpdf;
/**
* Документ содержит объект, находку которого вызывающий запретил:
* соответствующий error-флаг включён
* ({@link ConvertOptions#errorOnCharts()}, {@link ConvertOptions#errorOnSmartArt()}).
* Диаграммы/SmartArt конвертируются всегда; исключение отвергает документ целиком.
* ({@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.</p>
* фикстура samples/charts-smartart.docx; OLE —
* WordPdfConverterTest#drawingErrors_errorFlagRejectsOle,
* фикстура samples/ole-embedded.docx.</p>
*/
public class DrawingFoundException extends ConversionException {
/** Тип найденного объекта. */
public enum Kind { CHARTS, SMARTART }
public enum Kind { CHARTS, SMARTART, OLE }
private final Kind kind;
public DrawingFoundException(Kind kind) {
super(kind == Kind.CHARTS
? "В документе найдены диаграммы, а их обработка запрещена (errorOnCharts)"
: "В документе найден SmartArt, а его обработка запрещена (errorOnSmartArt)");
super(switch (kind) {
case CHARTS -> "В документе найдены диаграммы, а их обработка запрещена (errorOnCharts)";
case SMARTART -> "В документе найден SmartArt, а его обработка запрещена (errorOnSmartArt)";
case OLE -> "В документе найдены OLE-объекты, а их обработка запрещена (errorOnOle)";
});
this.kind = kind;
}
@@ -14,6 +14,7 @@ import ru.pjandro.wordpdf.internal.chart.DrawingPreRenderer;
import ru.pjandro.wordpdf.internal.DocxOnOffNormalizer;
import ru.pjandro.wordpdf.internal.FieldNormalizer;
import ru.pjandro.wordpdf.internal.GlyphCoverageNormalizer;
import ru.pjandro.wordpdf.internal.OleObjectNormalizer;
import ru.pjandro.wordpdf.internal.FopFallbackFonts;
import ru.pjandro.wordpdf.internal.StrictOoxmlNormalizer;
import ru.pjandro.wordpdf.internal.SymbolFontNormalizer;
@@ -142,6 +143,11 @@ public final class WordPdfConverter {
// FOP рисует «#» (docx4j проверяет покрытие не для всех знаков
// и кэширует фолбэк на группу Юникода, см. GlyphCoverageNormalizer).
docxBytes = GlyphCoverageNormalizer.normalize(docxBytes);
// ...и OLE-объекты (внедрённые бинарные .bin-части): docx4j падает и на
// ложном XML-типе bin-части в [Content_Types], и на сериализации VML
// w:object. При выключенном errorOnOle объекты тихо удаляются (часть,
// rels, w:object), при включённом — отказ (см. OleObjectNormalizer).
docxBytes = OleObjectNormalizer.normalize(docxBytes, options.errorOnOle());
WordprocessingMLPackage pkg = WordprocessingMLPackage.load(
new ByteArrayInputStream(docxBytes));
try {
@@ -30,6 +30,13 @@ public final class WordPdfSettings {
/** Ошибка при находке SmartArt ({@code dgm:relIds}) — {@link DrawingFoundException}. */
public static final boolean ERROR_ON_SMARTART = false;
/**
* Ошибка при находке OLE-объектов (бинарные {@code .bin}-части) —
* {@link DrawingFoundException}. Дефолт {@code false} — объекты тихо
* удаляются из документа (см. OleObjectNormalizer), конвертация проходит.
*/
public static final boolean ERROR_ON_OLE = false;
private WordPdfSettings() {
}
}
@@ -0,0 +1,321 @@
package ru.pjandro.wordpdf.internal;
import ru.pjandro.wordpdf.DrawingFoundException;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.Locale;
import java.util.logging.Logger;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.zip.ZipEntry;
import java.util.zip.ZipInputStream;
import java.util.zip.ZipOutputStream;
/**
* Удаление OLE-объектов из docx перед загрузкой docx4j.
*
* <p>docx4j падает на документах с внедрёнными OLE-объектами двумя путями:
* (1) продюсер файла пишет ложный content type для бинарной части
* {@code word/_embedded/*.bin} (например {@code …wordprocessingml.footer+xml}) —
* docx4j инстанцирует JAXB-часть, на экспорте парсер натыкается на бинарник
* («Content is not allowed in prolog») и экспорт тонет в NPE; (2) настоящий
* {@code w:object} — VML-сериализация docx4j падает NPE
* {@code chunkType is null} даже при честном типе
* {@code application/vnd.openxmlformats-officedocument.oleObject}.
* Лечится одинаково: OLE-части, ссылки на них и элементы {@code w:object}
* удаляются из контейнера — документ конвертируется без объектов.</p>
*
* <p>Отличие от остальных нормализаторов пакета: принимает флаг
* {@code errorOnOle} и умеет бросать {@link DrawingFoundException}
* (при включённом флаге документ отвергается вместо удаления), и правит
* не только {@code word/*.xml}, но и {@code [Content_Types].xml} с
* {@code *.rels}. Хука {@code rewrite(String)} нет — нормализатор
* многочастный (решение об удалении зависит от связки content type + rels),
* тесты работают через {@link #normalize} на in-memory zip.</p>
*
* <p>Если OLE-объектов нет, возвращает исходный массив без переупаковки zip.
* Регрессия — WordPdfConverterTest#oleObjects_removedAndConverted,
* WordPdfConverterTest#drawingErrors_errorFlagRejectsOle,
* фикстура samples/ole-embedded.docx.</p>
*/
public final class OleObjectNormalizer {
/** Честный content type внедрённого OLE-объекта. */
private static final String OLE_OBJECT_TYPE =
"application/vnd.openxmlformats-officedocument.oleObject";
/** XML-окончание типа; в `.bin`-части XML не бывает никогда — ложь продюсера. */
private static final String XML_TYPE_SUFFIX = "+xml";
private static final String BIN_SUFFIX = ".bin";
private static final String CONTENT_TYPES_ENTRY = "[Content_Types].xml";
/** Сегмент «наверх» в относительном Target rels. */
private static final String PARENT_DIR = "..";
private static final Pattern DEFAULT_TYPE = Pattern.compile(
"<Default\\b[^>]*\\bExtension=\"([^\"]*)\"[^>]*\\bContentType=\"([^\"]*)\"[^>]*/>"
+ "|<Default\\b[^>]*\\bContentType=\"([^\"]*)\"[^>]*\\bExtension=\"([^\"]*)\"[^>]*/>");
private static final Pattern OVERRIDE_TYPE = Pattern.compile(
"<Override\\b[^>]*\\bPartName=\"([^\"]*)\"[^>]*\\bContentType=\"([^\"]*)\"[^>]*/>"
+ "|<Override\\b[^>]*\\bContentType=\"([^\"]*)\"[^>]*\\bPartName=\"([^\"]*)\"[^>]*/>");
private static final Pattern RELATIONSHIP = Pattern.compile(
"<Relationship\\b[^>]*/>");
private static final Pattern TARGET_ATTR = Pattern.compile("\\bTarget=\"([^\"]*)\"");
private static final Pattern TARGET_MODE_EXTERNAL = Pattern.compile(
"\\bTargetMode=\"External\"");
/** Парный w:object (внутри VML-обёртка, роняющая экспорт) и самозакрытый. */
private static final Pattern W_OBJECT = Pattern.compile(
"<w:object\\b[^>]*>.*?</w:object>|<w:object\\b[^>]*/>", Pattern.DOTALL);
private static final Pattern PART_NAME_ATTR = Pattern.compile("\\bPartName=\"([^\"]*)\"");
private static final Logger LOG = Logger.getLogger(OleObjectNormalizer.class.getName());
private OleObjectNormalizer() {
}
/**
* Удаляет из docx OLE-объекты: бинарные `.bin`-части с OLE-типом (или
* ложным XML-типом), ссылки на них в `*.rels`, элементы `w:object` в
* `word/*.xml` и `Override` удалённых частей в `[Content_Types].xml`.
*
* @param docx байты .docx (zip)
* @param errorOnOle true — не удалять, а отвергнуть документ
* @return те же байты, если OLE-объектов нет; иначе переупакованный zip без OLE
* @throws DrawingFoundException при {@code errorOnOle} и найденном OLE-объекте
*/
public static byte[] normalize(byte[] docx, boolean errorOnOle) throws IOException {
Map<String, byte[]> entries = new LinkedHashMap<>();
try (ZipInputStream zis = new ZipInputStream(new ByteArrayInputStream(docx))) {
ZipEntry entry;
while ((entry = zis.getNextEntry()) != null) {
entries.put(entry.getName(), zis.readAllBytes());
}
}
byte[] contentTypes = entries.get(CONTENT_TYPES_ENTRY);
if (contentTypes == null) {
return docx;
}
String ctXml = new String(contentTypes, StandardCharsets.UTF_8);
Map<String, String> defaults = defaultTypes(ctXml);
Map<String, String> overrides = overrideTypes(ctXml);
Set<String> oleParts = new HashSet<>();
for (Map.Entry<String, byte[]> e : entries.entrySet()) {
String name = e.getKey();
if (!name.endsWith(BIN_SUFFIX)) {
continue;
}
String type = effectiveType(name, overrides, defaults);
if (type != null && (OLE_OBJECT_TYPE.equalsIgnoreCase(type)
|| type.endsWith(XML_TYPE_SUFFIX))) {
oleParts.add(name);
}
}
if (oleParts.isEmpty()) {
return docx;
}
if (errorOnOle) {
throw new DrawingFoundException(DrawingFoundException.Kind.OLE);
}
for (String part : oleParts) {
LOG.warning("Удалён OLE-объект: " + part);
}
ByteArrayOutputStream out = new ByteArrayOutputStream(docx.length);
try (ZipOutputStream zos = new ZipOutputStream(out)) {
for (Map.Entry<String, byte[]> e : entries.entrySet()) {
String name = e.getKey();
byte[] data = e.getValue();
if (oleParts.contains(name)) {
continue;
}
if (name.endsWith(".rels")) {
String fixed = stripRels(
new String(data, StandardCharsets.UTF_8), name, oleParts);
if (fixed != null) {
data = fixed.getBytes(StandardCharsets.UTF_8);
}
} else if (name.startsWith("word/") && name.endsWith(".xml")) {
String fixed = stripObjects(
new String(data, StandardCharsets.UTF_8));
if (fixed != null) {
data = fixed.getBytes(StandardCharsets.UTF_8);
}
} else if (name.equals(CONTENT_TYPES_ENTRY)) {
String fixed = stripOverrides(
new String(data, StandardCharsets.UTF_8), oleParts);
if (fixed != null) {
data = fixed.getBytes(StandardCharsets.UTF_8);
}
}
zos.putNextEntry(new ZipEntry(name));
zos.write(data);
zos.closeEntry();
}
}
return out.toByteArray();
}
/** Extension (lowercase) -> ContentType из элементов Default. */
private static Map<String, String> defaultTypes(String ctXml) {
Map<String, String> map = new HashMap<>();
Matcher m = DEFAULT_TYPE.matcher(ctXml);
while (m.find()) {
String ext = m.group(1) != null ? m.group(1) : m.group(4);
String type = m.group(2) != null ? m.group(2) : m.group(3);
map.put(ext.toLowerCase(Locale.ROOT), type);
}
return map;
}
/** PartName (как в атрибуте, с ведущим «/») -> ContentType из Override. */
private static Map<String, String> overrideTypes(String ctXml) {
Map<String, String> map = new HashMap<>();
Matcher m = OVERRIDE_TYPE.matcher(ctXml);
while (m.find()) {
String part = m.group(1) != null ? m.group(1) : m.group(4);
String type = m.group(2) != null ? m.group(2) : m.group(3);
map.put(part, type);
}
return map;
}
/** Override имеет приоритет над Default по расширению. */
private static String effectiveType(String partName, Map<String, String> overrides,
Map<String, String> defaults) {
String type = overrides.get("/" + partName);
if (type != null) {
return type;
}
int dot = partName.lastIndexOf('.');
return dot < 0 ? null : defaults.get(partName.substring(dot + 1).toLowerCase(Locale.ROOT));
}
/**
* Удаляет из `.rels` элементы Relationship, чей Target резолвится в
* удалённую часть. Внешние ссылки (TargetMode="External") не трогаем.
*
* @return новая строка либо null, если удалять нечего
*/
private static String stripRels(String relsXml, String relsName, Set<String> oleParts) {
if (relsXml.indexOf("<Relationship") < 0) {
return null;
}
// rels вида "X/_rels/Y.rels" лежат рядом с базой X/; "_rels/.rels" — база ""
int relsIdx = relsName.lastIndexOf("_rels/");
String base = relsIdx < 0 ? "" : relsName.substring(0, relsIdx);
Matcher m = RELATIONSHIP.matcher(relsXml);
StringBuilder sb = new StringBuilder(relsXml.length());
int last = 0;
boolean changed = false;
while (m.find()) {
String rel = m.group();
Matcher mode = TARGET_MODE_EXTERNAL.matcher(rel);
if (mode.find()) {
continue;
}
Matcher target = TARGET_ATTR.matcher(rel);
if (!target.find()) {
continue;
}
String resolved = resolveTarget(base, target.group(1));
if (oleParts.contains(resolved)) {
sb.append(relsXml, last, m.start());
last = m.end();
changed = true;
}
}
if (!changed) {
return null;
}
sb.append(relsXml, last, relsXml.length());
return sb.toString();
}
/** Разрешает относительный Target rels против базы каталога части. */
private static String resolveTarget(String base, String target) {
if (target.startsWith("/")) {
return target.substring(1);
}
List<String> segments = new ArrayList<>();
if (!base.isEmpty()) {
for (String s : base.split("/")) {
if (!s.isEmpty()) {
segments.add(s);
}
}
}
for (String s : target.split("/")) {
if (s.isEmpty() || ".".equals(s)) {
continue;
}
if (PARENT_DIR.equals(s)) {
if (!segments.isEmpty()) {
segments.remove(segments.size() - 1);
}
} else {
segments.add(s);
}
}
return String.join("/", segments);
}
/**
* Вырезает из word/*.xml элементы w:object (внутри — VML-обёртка,
* которая сама по себе роняет экспорт docx4j).
*
* @return новая строка либо null, если совпадений не было
*/
private static String stripObjects(String xml) {
if (xml.indexOf("<w:object") < 0) {
return null;
}
Matcher m = W_OBJECT.matcher(xml);
if (!m.find()) {
return null;
}
return m.reset().replaceAll("");
}
/**
* Удаляет из [Content_Types].xml Override-элементы удалённых частей.
* Default без частей безвреден — не трогаем.
*
* @return новая строка либо null, если удалять нечего
*/
private static String stripOverrides(String ctXml, Set<String> removedParts) {
StringBuilder sb = new StringBuilder(ctXml.length());
int last = 0;
int pos = 0;
boolean changed = false;
while ((pos = ctXml.indexOf("<Override", pos)) >= 0) {
int end = ctXml.indexOf("/>", pos);
if (end < 0) {
break;
}
end += 2;
String el = ctXml.substring(pos, end);
Matcher pn = PART_NAME_ATTR.matcher(el);
if (pn.find() && removedParts.contains(
pn.group(1).startsWith("/") ? pn.group(1).substring(1) : pn.group(1))) {
sb.append(ctXml, last, pos);
last = end;
changed = true;
}
pos = end;
}
if (!changed) {
return null;
}
sb.append(ctXml, last, ctXml.length());
return sb.toString();
}
}