Skip to content

Commit

Permalink
#79 - XMP metadata for PDF/UA compilance.
Browse files Browse the repository at this point in the history
  • Loading branch information
@danfickle
danfickle committed Jan 12, 2019
1 parent 44b7fee commit 34cb500
Show file tree
Hide file tree
Showing 4 changed files with 85 additions and 3 deletions.
7 changes: 5 additions & 2 deletions openhtmltopdf-pdfbox/src/main/java/com/openhtmltopdf/pdfboxout/PdfBoxFontResolver.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,12 +66,14 @@ public class PdfBoxFontResolver implements FontResolver {
private final List<TrueTypeCollection> _collectionsToClose = new ArrayList<TrueTypeCollection>();
private final FSCacheEx<String, FSCacheValue> _fontMetricsCache;
private final PdfAConformance _pdfAConformance;
private final boolean _pdfUaConform;

public PdfBoxFontResolver(SharedContext sharedContext, PDDocument doc, FSCacheEx<String, FSCacheValue> pdfMetricsCache, PdfAConformance pdfAConformance) {
public PdfBoxFontResolver(SharedContext sharedContext, PDDocument doc, FSCacheEx<String, FSCacheValue> pdfMetricsCache, PdfAConformance pdfAConformance, boolean pdfUaConform) {
_sharedContext = sharedContext;
_doc = doc;
_fontMetricsCache = pdfMetricsCache;
_pdfAConformance = pdfAConformance;
_pdfUaConform = pdfUaConform;

// All fonts are required to be embedded in PDF/A documents, so we don't add the built-in fonts, if conformance is required.
_fontFamilies = (_pdfAConformance == PdfAConformance.NONE) ? createInitialFontMap() : new HashMap<String, FontFamily<FontDescription>>();
Expand Down Expand Up @@ -402,7 +404,8 @@ private FSFont resolveFont(SharedContext ctx, String[] families, float size, Ide
}
}

if (_pdfAConformance == PdfAConformance.NONE) {
if (_pdfAConformance == PdfAConformance.NONE &&
!_pdfUaConform) {
// We don't have a final fallback font for PDF/A documents as serif may not be available
// unless the user has explicitly embedded it.

Expand Down
70 changes: 69 additions & 1 deletion openhtmltopdf-pdfbox/src/main/java/com/openhtmltopdf/pdfboxout/PdfBoxRenderer.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@
import com.openhtmltopdf.util.Configuration;
import com.openhtmltopdf.util.ThreadCtx;
import com.openhtmltopdf.util.XRLog;

import org.apache.pdfbox.cos.COSDictionary;
import org.apache.pdfbox.pdmodel.*;
import org.apache.pdfbox.pdmodel.PDPageContentStream.AppendMode;
import org.apache.pdfbox.pdmodel.common.PDMetadata;
Expand All @@ -59,10 +61,12 @@
import org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureTreeRoot;
import org.apache.pdfbox.pdmodel.encryption.PDEncryption;
import org.apache.pdfbox.pdmodel.graphics.color.PDOutputIntent;
import org.apache.pdfbox.pdmodel.interactive.viewerpreferences.PDViewerPreferences;
import org.apache.xmpbox.XMPMetadata;
import org.apache.xmpbox.schema.AdobePDFSchema;
import org.apache.xmpbox.schema.PDFAIdentificationSchema;
import org.apache.xmpbox.schema.XMPBasicSchema;
import org.apache.xmpbox.schema.XMPSchema;
import org.apache.xmpbox.type.BadFieldValueException;
import org.apache.xmpbox.xml.XmpSerializer;
import org.w3c.dom.Document;
Expand Down Expand Up @@ -107,6 +111,7 @@ public class PdfBoxRenderer implements Closeable {
private float _pdfVersion;

private PdfAConformance _pdfAConformance;
private boolean _pdfUaConformance;

private byte[] _colorProfile;

Expand Down Expand Up @@ -139,6 +144,7 @@ public class PdfBoxRenderer implements Closeable {
_mathmlImpl = state._mathmlImpl;

_pdfAConformance = state._pdfAConformance;
_pdfUaConformance = state._pdfUaConform;
_colorProfile = state._colorProfile;

_dotsPerPoint = DEFAULT_DOTS_PER_POINT;
Expand Down Expand Up @@ -167,7 +173,7 @@ public class PdfBoxRenderer implements Closeable {
userAgent.setSharedContext(_sharedContext);
_outputDevice.setSharedContext(_sharedContext);

PdfBoxFontResolver fontResolver = new PdfBoxFontResolver(_sharedContext, _pdfDoc, state._caches.get(CacheStore.PDF_FONT_METRICS), state._pdfAConformance);
PdfBoxFontResolver fontResolver = new PdfBoxFontResolver(_sharedContext, _pdfDoc, state._caches.get(CacheStore.PDF_FONT_METRICS), state._pdfAConformance, state._pdfUaConform);
_sharedContext.setFontResolver(fontResolver);

PdfBoxReplacedElementFactory replacedElementFactory = new PdfBoxReplacedElementFactory(_outputDevice, state._svgImpl, state._objectDrawerFactory, state._mathmlImpl);
Expand Down Expand Up @@ -587,6 +593,12 @@ private void writePDFFast(List<PageBox> pages, RenderingContext c, Rectangle2D f
firePreWrite(pageCount); // opportunity to adjust meta data
setDidValues(doc); // set PDF header fields from meta data

if (_pdfUaConformance) {
addPdfUaXMPSchema(doc);
} else if (_pdfAConformance != PdfAConformance.NONE) {
addPdfASchema(doc, _pdfAConformance.getPart(), _pdfAConformance.getConformanceValue());
}

DisplayListCollector dlCollector = new DisplayListCollector(_root.getLayer().getPages());
DisplayListContainer dlPages = dlCollector.collectRoot(c, _root.getLayer());

Expand Down Expand Up @@ -678,6 +690,62 @@ private void writePDF(List<PageBox> pages, RenderingContext c, Rectangle2D first
_outputDevice.finish(c, _root);
}

// Kindly provided by GurpusMaximus at:
// https://stackoverflow.com/questions/49682339/how-can-i-create-an-accessible-pdf-with-java-pdfbox-2-0-8-library-that-is-also-v
private void addPdfUaXMPSchema(PDDocument doc) {
try
{
PDDocumentCatalog catalog = doc.getDocumentCatalog();
String lang = _doc.getDocumentElement().getAttribute("lang");
catalog.setLanguage(lang != null ? lang : "English");
catalog.setViewerPreferences(new PDViewerPreferences(new COSDictionary()));
catalog.getViewerPreferences().setDisplayDocTitle(true);
PDMarkInfo markInfo = new PDMarkInfo();
markInfo.setMarked(true);
catalog.setMarkInfo(markInfo);

PDDocumentInformation info = doc.getDocumentInformation();
XMPMetadata xmp = XMPMetadata.createXMPMetadata();
xmp.createAndAddDublinCoreSchema();
xmp.getDublinCoreSchema().setTitle(info.getTitle());
String metaDescription = _outputDevice.getMetadataByName("description");
xmp.getDublinCoreSchema().setDescription(metaDescription != null ? metaDescription : info.getTitle());
xmp.createAndAddPDFAExtensionSchemaWithDefaultNS();
xmp.getPDFExtensionSchema().addNamespace(
"http://www.aiim.org/pdfa/ns/schema#", "pdfaSchema");
xmp.getPDFExtensionSchema().addNamespace(
"http://www.aiim.org/pdfa/ns/property#", "pdfaProperty");
xmp.getPDFExtensionSchema().addNamespace(
"http://www.aiim.org/pdfua/ns/id/", "pdfuaid");
XMPSchema uaSchema = new XMPSchema(XMPMetadata.createXMPMetadata(),
"pdfaSchema", "pdfaSchema", "pdfaSchema");
uaSchema.setTextPropertyValue("schema",
"PDF/UA Universal Accessibility Schema");
uaSchema.setTextPropertyValue("namespaceURI",
"http://www.aiim.org/pdfua/ns/id/");
uaSchema.setTextPropertyValue("prefix", "pdfuaid");
XMPSchema uaProp = new XMPSchema(XMPMetadata.createXMPMetadata(),
"pdfaProperty", "pdfaProperty", "pdfaProperty");
uaProp.setTextPropertyValue("name", "part");
uaProp.setTextPropertyValue("valueType", "Integer");
uaProp.setTextPropertyValue("category", "internal");
uaProp.setTextPropertyValue("description",
"Indicates, which part of ISO 14289 standard is followed");
uaSchema.addUnqualifiedSequenceValue("property", uaProp);
xmp.getPDFExtensionSchema().addBagValue("schemas", uaSchema);
xmp.getPDFExtensionSchema().setPrefix("pdfuaid");
xmp.getPDFExtensionSchema().setTextPropertyValue("part", "1");
XmpSerializer serializer = new XmpSerializer();
ByteArrayOutputStream baos = new ByteArrayOutputStream();
serializer.serialize(xmp, baos, true);
PDMetadata metadata = new PDMetadata(doc);
metadata.importXMPMetadata(baos.toByteArray());
doc.getDocumentCatalog().setMetadata(metadata);
} catch (IOException|TransformerException e) {
throw new RuntimeException(e);
}
}

private void addPdfASchema(PDDocument document, int part, String conformance) {
PDDocumentInformation information = document.getDocumentInformation();
XMPMetadata metadata = XMPMetadata.createXMPMetadata();
Expand Down
10 changes: 10 additions & 0 deletions openhtmltopdf-pdfbox/src/main/java/com/openhtmltopdf/pdfboxout/PdfRendererBuilder.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,16 @@ public PdfRendererBuilder usePdfAConformance(PdfAConformance pdfAConformance) {
this.state._pdfAConformance = pdfAConformance;
return this;
}

/**
* Whether to conform to PDF/UA or Accessible PDF. False by default.
* @param pdfUaAccessibility
* @return this for method chaining
*/
public PdfRendererBuilder usePdfUaAccessbility(boolean pdfUaAccessibility) {
this.state._pdfUaConform = pdfUaAccessibility;
return this;
}

/**
* Sets the color profile, needed for PDF/A conformance.
Expand Down
1 change: 1 addition & 0 deletions openhtmltopdf-pdfbox/src/main/java/com/openhtmltopdf/pdfboxout/PdfRendererBuilderState.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,6 @@ public class PdfRendererBuilderState extends BaseRendererBuilder.BaseRendererBui
public PDDocument pddocument;
public final Map<CacheStore, FSCacheEx<String, FSCacheValue>> _caches = new EnumMap<CacheStore, FSCacheEx<String, FSCacheValue>>(CacheStore.class);
public PdfAConformance _pdfAConformance = PdfAConformance.NONE;
public boolean _pdfUaConform = false;
public byte[] _colorProfile;
}

0 comments on commit 34cb500

Please sign in to comment.