/*
* XSLT.java
*
* Copyright 2008 Mark Logic Corporation.
* Portions Copyright 2007 Sun Microsystems, Inc.
* All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common
* Development and Distribution License("CDDL") (collectively, the
* "License"). You may not use this file except in compliance with the
* License. You can obtain a copy of the License at
* https://xproc.dev.java.net/public/CDDL+GPL.html or
* docs/CDDL+GPL.txt in the distribution. See the License for the
* specific language governing permissions and limitations under the
* License. When distributing the software, include this License Header
* Notice in each file and include the License file at docs/CDDL+GPL.txt.
*/
package com.xmlcalabash.library;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.Hashtable;
import java.util.Vector;
import javax.xml.transform.Result;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.dom.DOMResult;
import javax.xml.transform.dom.DOMSource;
import javax.xml.transform.sax.SAXSource;
import com.xmlcalabash.core.XProcException;
import com.xmlcalabash.core.XProcRuntime;
import com.xmlcalabash.core.XProcConstants;
import com.xmlcalabash.io.ReadablePipe;
import com.xmlcalabash.io.WritablePipe;
import com.xmlcalabash.model.RuntimeValue;
import com.xmlcalabash.util.MessageFormatter;
import com.xmlcalabash.util.TreeWriter;
import com.xmlcalabash.util.CollectionResolver;
import com.xmlcalabash.util.S9apiUtils;
import net.sf.saxon.Configuration;
import net.sf.saxon.lib.CollectionURIResolver;
import net.sf.saxon.lib.OutputURIResolver;
import net.sf.saxon.lib.UnparsedTextURIResolver;
import net.sf.saxon.s9api.DocumentBuilder;
import net.sf.saxon.s9api.QName;
import net.sf.saxon.s9api.XdmDestination;
import net.sf.saxon.s9api.SaxonApiException;
import net.sf.saxon.s9api.XdmNode;
import net.sf.saxon.s9api.XsltCompiler;
import net.sf.saxon.s9api.XsltExecutable;
import net.sf.saxon.s9api.XsltTransformer;
import net.sf.saxon.s9api.XdmAtomicValue;
import net.sf.saxon.s9api.MessageListener;
import net.sf.saxon.s9api.ValidationMode;
import net.sf.saxon.s9api.Processor;
import net.sf.saxon.event.Receiver;
import com.xmlcalabash.runtime.XAtomicStep;
import org.xml.sax.InputSource;
/**
*
* @author ndw
*/
public class XSLT extends DefaultStep {
private static final QName _initial_mode = new QName("", "initial-mode");
private static final QName _template_name = new QName("", "template-name");
private static final QName _output_base_uri = new QName("", "output-base-uri");
private static final QName _version = new QName("", "version");
private ReadablePipe sourcePipe = null;
private ReadablePipe stylesheetPipe = null;
private WritablePipe resultPipe = null;
private WritablePipe secondaryPipe = null;
private Hashtable<QName,RuntimeValue> params = new Hashtable<QName,RuntimeValue> ();
private Hashtable<String, XdmDestination> secondaryResults = new Hashtable<String, XdmDestination> ();
/**
* Creates a new instance of XSLT
*/
public XSLT(XProcRuntime runtime, XAtomicStep step) {
super(runtime,step);
}
public void setInput(String port, ReadablePipe pipe) {
if ("source".equals(port)) {
sourcePipe = pipe;
} else {
stylesheetPipe = pipe;
}
}
public void setOutput(String port, WritablePipe pipe) {
if ("result".equals(port)) {
resultPipe = pipe;
} else {
secondaryPipe = pipe;
}
}
public void setParameter(QName name, RuntimeValue value) {
params.put(name, value);
}
public void reset() {
sourcePipe.resetReader();
stylesheetPipe.resetReader();
resultPipe.resetWriter();
secondaryPipe.resetWriter();
}
public void run() throws SaxonApiException {
super.run();
XdmNode stylesheet = stylesheetPipe.read();
if (stylesheet == null) {
throw XProcException.dynamicError(6, step.getNode(), "No stylesheet provided.");
}
Vector<XdmNode> defaultCollection = new Vector<XdmNode> ();
while (sourcePipe.moreDocuments()) {
defaultCollection.add(sourcePipe.read());
}
XdmNode document = null;
if (defaultCollection.size() > 0) {
document = defaultCollection.firstElement();
}
String version = null;
if (getOption(_version) == null) {
XdmNode ssroot = S9apiUtils.getDocumentElement(stylesheet);
version = ssroot.getAttributeValue(new QName("","version"));
if (version == null) {
version = ssroot.getAttributeValue(new QName("http://www.w3.org/1999/XSL/Transform","version"));
}
if (version == null) {
version = "2.0"; // WTF?
}
} else {
version = getOption(_version).getString();
}
if ("3.0".equals(version) && Configuration.softwareEdition.toLowerCase().equals("he")) {
throw XProcException.stepError(38, "XSLT version '" + version + "' is not supported (Saxon PE or EE processor required).");
}
// We used to check if the XSLT version was supported, but I've removed that check.
// If it's not supported by Saxon, we'll get an error from Saxon. Otherwise, we'll
// get the results we get.
if ("1.0".equals(version) && defaultCollection.size() > 1) {
throw XProcException.stepError(39);
}
if ("1.0".equals(version) && runtime.getUseXslt10Processor()) {
run10(stylesheet, document);
return;
}
QName initialMode = null;
QName templateName = null;
String outputBaseURI = null;
RuntimeValue opt = getOption(_initial_mode);
if (opt != null) {
initialMode = opt.getQName();
}
opt = getOption(_template_name);
if (opt != null) {
templateName = opt.getQName();
}
opt = getOption(_output_base_uri);
if (opt != null) {
outputBaseURI = opt.getString();
}
Processor processor = runtime.getProcessor();
Configuration config = processor.getUnderlyingConfiguration();
runtime.getConfigurer().getSaxonConfigurer().configXSLT(config);
OutputURIResolver uriResolver = config.getOutputURIResolver();
CollectionURIResolver collectionResolver = config.getCollectionURIResolver();
UnparsedTextURIResolver unparsedTextURIResolver = runtime.getResolver();
config.setOutputURIResolver(new OutputResolver());
config.setCollectionURIResolver(new CollectionResolver(runtime, defaultCollection, collectionResolver));
XdmDestination result = null;
try {
XsltCompiler compiler = runtime.getProcessor().newXsltCompiler();
compiler.setSchemaAware(processor.isSchemaAware());
XsltExecutable exec = compiler.compile(stylesheet.asSource());
XsltTransformer transformer = exec.load();
for (QName name : params.keySet()) {
RuntimeValue v = params.get(name);
if (runtime.getAllowGeneralExpressions()) {
transformer.setParameter(name, v.getValue());
} else {
transformer.setParameter(name, new XdmAtomicValue(v.getString()));
}
}
if (document != null) {
transformer.setInitialContextNode(document);
}
transformer.setMessageListener(new CatchMessages());
result = new XdmDestination();
transformer.setDestination(result);
if (initialMode != null) {
transformer.setInitialMode(initialMode);
}
if (templateName != null) {
transformer.setInitialTemplate(templateName);
}
if (outputBaseURI != null) {
transformer.setBaseOutputURI(outputBaseURI);
// The following hack works around https://saxonica.plan.io/issues/1724
try {
result.setBaseURI(new URI(outputBaseURI));
} catch (URISyntaxException use) {
// whatever
}
}
transformer.setSchemaValidationMode(ValidationMode.DEFAULT);
transformer.getUnderlyingController().setUnparsedTextURIResolver(unparsedTextURIResolver);
transformer.transform();
} finally {
config.setOutputURIResolver(uriResolver);
config.setCollectionURIResolver(collectionResolver);
}
XdmNode xformed = result.getXdmNode();
// Can be null when nothing is written to the principle result tree...
if (xformed != null) {
if (document != null
&& (xformed.getBaseURI() == null
|| "".equals(xformed.getBaseURI().toASCIIString()))) {
String sysId = document.getBaseURI().toASCIIString();
xformed.getUnderlyingNode().setSystemId(sysId);
}
resultPipe.write(xformed);
}
}
public void run10(XdmNode stylesheet, XdmNode document) {
try {
InputSource is = S9apiUtils.xdmToInputSource(runtime, stylesheet);
TransformerFactory tfactory = TransformerFactory.newInstance();
Transformer transformer = tfactory.newTransformer(new SAXSource(is));
transformer.setURIResolver(runtime.getResolver());
for (QName name : params.keySet()) {
RuntimeValue v = params.get(name);
transformer.setParameter(name.getClarkName(), v.getString());
}
DOMResult result = new DOMResult();
is = S9apiUtils.xdmToInputSource(runtime, document);
transformer.transform(new SAXSource(is), result);
DocumentBuilder xdmBuilder = runtime.getConfiguration().getProcessor().newDocumentBuilder();
XdmNode xformed = xdmBuilder.build(new DOMSource(result.getNode()));
// Can be null when nothing is written to the principle result tree...
if (xformed != null) {
if (document != null
&& (xformed.getBaseURI() == null
|| "".equals(xformed.getBaseURI().toASCIIString()))) {
String sysId = document.getBaseURI().toASCIIString();
xformed.getUnderlyingNode().setSystemId(sysId);
}
resultPipe.write(xformed);
}
} catch (SaxonApiException sae) {
throw new XProcException(sae);
} catch (TransformerConfigurationException tce) {
throw new XProcException(tce);
} catch (TransformerException te) {
throw new XProcException(te);
}
}
class OutputResolver implements OutputURIResolver {
public OutputResolver() {
}
@Override
public OutputURIResolver newInstance() {
return new OutputResolver();
}
public Result resolve(String href, String base) throws TransformerException {
URI baseURI = null;
try {
baseURI = new URI(base);
baseURI = baseURI.resolve(href);
} catch (URISyntaxException use) {
throw new XProcException(use);
}
logger.trace(MessageFormatter.nodeMessage(step.getNode(), "XSLT secondary result document: " + baseURI));
try {
XdmDestination xdmResult = new XdmDestination();
secondaryResults.put(baseURI.toASCIIString(), xdmResult);
Receiver receiver = xdmResult.getReceiver(runtime.getProcessor().getUnderlyingConfiguration());
receiver.setSystemId(baseURI.toASCIIString());
return receiver;
} catch (SaxonApiException sae) {
throw new XProcException(sae);
}
}
public void close(Result result) throws TransformerException {
String href = result.getSystemId();
XdmDestination xdmResult = secondaryResults.get(href);
XdmNode doc = xdmResult.getXdmNode();
secondaryPipe.write(doc);
}
}
class CatchMessages implements MessageListener {
public CatchMessages() {
}
public void message(XdmNode content, boolean terminate, javax.xml.transform.SourceLocator locator) {
TreeWriter treeWriter = new TreeWriter(runtime);
treeWriter.startDocument(content.getBaseURI());
treeWriter.addStartElement(XProcConstants.c_error);
treeWriter.startContent();
treeWriter.addSubtree(content);
treeWriter.addEndElement();
treeWriter.endDocument();
step.reportError(treeWriter.getResult());
step.info(step.getNode(), content.toString());
}
}
}