sbraconnier
commented
6 years ago Hi there,
I have been inspired by the XWiki fork for the filters feature of jodconverter, but I didn't want to apply them by default. So you could just keep your own ImageEmbedderFilter and add it to the filter chain when creating your converter.
I took a look at the commits you have done so far in the XWIKI project so here is what I would do:
Put the following class somewhere in your project. It is a copy of the XWIKI ImageEmbedderFilter modified so it can be used with my fork of jodconverter:
import org.jodconverter.filter.Filter;
import org.jodconverter.filter.FilterChain;
import org.jodconverter.office.LocalOfficeContext;
import org.jodconverter.office.OfficeContext;
import com.sun.star.awt.Size;
import com.sun.star.beans.PropertyValue;
import com.sun.star.beans.XPropertySet;
import com.sun.star.container.XIndexAccess;
import com.sun.star.graphic.XGraphicProvider;
import com.sun.star.lang.XComponent;
import com.sun.star.lang.XServiceInfo;
import com.sun.star.text.XTextGraphicObjectsSupplier;
import com.sun.star.uno.UnoRuntime;
/** This filter is used to embed external images into a document. */
public class ImageEmbedderFilter implements Filter {
@Override
public void doFilter(
final OfficeContext context, final XComponent document, final FilterChain chain)
throws Exception {
if (UnoRuntime.queryInterface(XServiceInfo.class, document)
.supportsService("com.sun.star.text.GenericTextDocument")) {
embedWriterImages(document, context);
}
// Invoke the next filter in the chain
chain.doFilter(context, document);
}
private void embedWriterImages(final XComponent document, final OfficeContext context)
throws Exception {
final LocalOfficeContext localContext = (LocalOfficeContext) context;
final XIndexAccess indexAccess =
UnoRuntime.queryInterface(
XIndexAccess.class,
UnoRuntime.queryInterface(XTextGraphicObjectsSupplier.class, document)
.getGraphicObjects());
final XGraphicProvider graphicProvider =
UnoRuntime.queryInterface(
XGraphicProvider.class,
localContext
.getComponentContext()
.getServiceManager()
.createInstanceWithContext(
"com.sun.star.graphic.GraphicProvider", localContext.getComponentContext()));
final PropertyValue[] queryProperties = new PropertyValue[] {new PropertyValue()};
queryProperties[0].Name = "URL";
for (int i = 0; i < indexAccess.getCount(); i++) {
try {
final XPropertySet graphicProperties =
UnoRuntime.queryInterface(XPropertySet.class, indexAccess.getByIndex(i));
final String graphicURL = (String) graphicProperties.getPropertyValue("GraphicURL");
if (!graphicURL.contains("vnd.sun.star.GraphicObject")) {
queryProperties[0].Value = graphicURL;
// Before embedding the image, the "ActualSize" property holds the image
// size specified in the document content. If the width or height are not
// specified then their actual values will be 0.
final Size specifiedSize =
UnoRuntime.queryInterface(
Size.class, graphicProperties.getPropertyValue("ActualSize"));
graphicProperties.setPropertyValue(
"Graphic", graphicProvider.queryGraphic(queryProperties));
// Images are embedded as characters (see TextContentAnchorType.AS_CHARACTER)
// and their size is messed up if it's not explicitly specified (e.g. if the
// image height is not specified then it takes the line height).
adjustImageSize(graphicProperties, specifiedSize);
}
} catch (Exception e) {
// Skip this graphic.
}
}
}
private void adjustImageSize(final XPropertySet graphicProperties, final Size specifiedSize) {
try {
// After embedding the image, the "ActualSize" property holds the actual image size.
final Size size =
UnoRuntime.queryInterface(Size.class, graphicProperties.getPropertyValue("ActualSize"));
// Compute the width and height if not specified, preserving aspect ratio.
if (specifiedSize.Width == 0 && specifiedSize.Height == 0) {
specifiedSize.Width = size.Width;
specifiedSize.Height = size.Height;
} else if (specifiedSize.Width == 0) {
specifiedSize.Width = specifiedSize.Height * size.Width / size.Height;
} else if (specifiedSize.Height == 0) {
specifiedSize.Height = specifiedSize.Width * size.Height / size.Width;
}
graphicProperties.setPropertyValue("Size", specifiedSize);
} catch (Exception e) {
// Ignore this image.
}
}
}then in your DefaultOfficeServer class, create the converter this way:
...
// Try to use the JSON document format registry to configure the office document conversion.
InputStream input = getClass().getResourceAsStream(DOCUMENT_FORMATS_PATH);
if (input != null) {
try {
this.jodConverter =
LocalConverter.builder()
.officeManager(this.jodManager)
.formatRegistry(JsonDocumentFormatRegistry.create(input))
.filterChain(new ImageEmbedderFilter())
.build();
} catch (Exception e) {
this.logger.warn(
"Failed to parse {} . The default document format registry will be used instead.",
DOCUMENT_FORMATS_PATH,
e);
}
} else {
this.logger.debug(
"{} is missing. The default document format registry will be used instead.",
DOCUMENT_FORMATS_PATH);
}
if (this.jodConverter == null) {
// Use the default document format registry.
this.jodConverter =
LocalConverter.builder()
.officeManager(this.jodManager)
.filterChain(new ImageEmbedderFilter())
.build();
}
...It should then work just fine.
I'll let you know if I find another way to do this.
surli
Hi,
I'm trying to create an ODT document from an HTML containing pictures. The link of the pictures are local, so I'd like to embed the pictures directly in ODT. We were before using the ImageEmbeddedFilter provided by XWiki fork, so I wonder if the same kind of feature exists in your own fork?
I noticed there is a GraphicInserterFilter but from what I understood it needs to specify explicitely the path of the images to embed. Here I want to process all images of the document. Any hint?