Implement fn:transform

exist-core/src/main/java/org/exist/storage/DBBroker.java

@@ -179,7 +179,12 @@ public void pushSubject(final Subject subject) {
         if(LOG.isTraceEnabled()) {
             subjectChangeTrace.add(TraceableSubjectChange.push(subject, getId()));
         }
-        this.subject.addFirst(subject);
+        if (subject == null) {
+            //TODO (AP) this is a workaround - what is the root cause ?
+            LOG.warn("Attempt to push null subject ignored.");
+        } else {
+            this.subject.addFirst(subject);
+        }
     }
 
     /**

exist-core/src/main/java/org/exist/xquery/ErrorCodes.java

@@ -227,6 +227,13 @@ public class ErrorCodes {
     public static final ErrorCode FOQM0005 = new W3CErrorCode("FOQM0005", "Parameter for dynamically-loaded XQuery " +
             "module has incorrect type");
     public static final ErrorCode FOQM0006 = new W3CErrorCode("FOQM0006", "No suitable XQuery processor available.");
+    public static final ErrorCode FOXT0001 = new W3CErrorCode("FOXT0001", "No suitable XSLT processor available.");
+    public static final ErrorCode FOXT0002 = new W3CErrorCode("FOXT0002", "Invalid parameters to XSLT transformation");
+    public static final ErrorCode FOXT0003 = new W3CErrorCode("FOXT0003", "XSLT transformation failed");
+    public static final ErrorCode FOXT0004 = new W3CErrorCode("FOXT0004", "XSLT transformation has been disabled");
+    public static final ErrorCode FOXT0006 = new W3CErrorCode("FOXT0006", "XSLT output contains non-accepted characters");
+
+    public static final ErrorCode XTSE0165 = new W3CErrorCode("XTSE0165","It is a static error if the processor is not able to retrieve the resource identified by the URI reference [ in the href attribute of xsl:include or xsl:import] , or if the resource that is retrieved does not contain a stylesheet module conforming to this specification.");
 
     /* eXist specific XQuery and XPath errors
      *

exist-core/src/main/java/org/exist/xquery/XQueryContext.java

@@ -3445,4 +3445,109 @@ public HttpContext setSession(final SessionWrapper newSession) {
             return new HttpContext(request, response, newSession);
         }
     }
+
+    @Override public String toString() {
+        return getStringValue();
+    }
+
+    public String getStringValue() {
+        final StringBuilder sb = new StringBuilder();
+        sb.append('{');
+
+        sb.append("dynamicDocuments: {");
+        if (dynamicDocuments != null) {
+            for (final String key : dynamicDocuments.keySet()) {
+                sb.append(key).append("-> ");
+                sb.append(dynamicDocuments.get(key));
+            }
+        }
+        sb.append('}');
+        sb.append('\n');
+
+        sb.append("dynamicTextResources: {");
+        if (dynamicTextResources != null) {
+            for (final Map.Entry<Tuple2<String, Charset>,  QuadFunctionE<DBBroker, Txn, String, Charset, Reader, XPathException>> entry : dynamicTextResources.entrySet()) {
+                sb.append(entry.getKey()).append("-> ").append(entry.getValue());
+            }
+        }
+        sb.append('}');
+        sb.append('\n');
+
+        sb.append("dynamicCollections: {");
+        if (dynamicCollections != null) {
+            for (final Map.Entry<String,
+                    TriFunctionE<DBBroker, Txn, String, Sequence, XPathException>> entry : dynamicCollections.entrySet()) {
+                sb.append(entry.getKey()).append("-> ").append(entry.getValue());
+            }
+        }
+        sb.append('}');
+        sb.append('\n');
+
+        sb.append("baseURI: ");
+        try {
+            sb.append(getBaseURI()).append('\n');
+        } catch (final XPathException e) {
+            sb.append("?");
+        }
+
+        sb.append("inScopePrefixes: {");
+        if (inScopePrefixes != null) {
+            for (final Map.Entry<String, String> entry : inScopePrefixes.entrySet()) {
+                sb.append(entry.getKey()).append("-> ").append(entry.getValue());
+            }
+        }
+        sb.append('}');
+        sb.append('\n');
+
+        sb.append("inScopeNamespaces: {");
+        if (inScopeNamespaces != null) {
+            for (final Map.Entry<String, String> entry : inScopeNamespaces.entrySet()) {
+                sb.append(entry.getKey()).append("-> ").append(entry.getValue());
+            }
+        }
+        sb.append('}');
+        sb.append('\n');
+
+        sb.append("modules: {");
+        if (modules != null) {
+            for (final Map.Entry<String, Module[]> entry : modules.entrySet()) {
+                sb.append(entry.getKey()).append("-> ");
+                for (final Module module : modules.get(entry.getKey())) {
+                    sb.append("namespaceURI: ").append(module.getNamespaceURI()).append('\n');
+                    sb.append("defaultPrefix: ").append(module.getDefaultPrefix()).append('\n');
+                    sb.append("description: ").append(module.getDescription()).append('\n');
+                    for (final Iterator<QName> it = module.getGlobalVariables(); it.hasNext(); ) {
+                        final QName qName = it.next();
+                        sb.append(qName).append(';');
+                    }
+                }
+            }
+        }
+        sb.append('}');
+        sb.append('\n');
+
+        sb.append("allModules: {");
+        if (allModules != null) {
+            for (final Map.Entry<String, Module[]> entry : allModules.entrySet()) {
+                sb.append(entry.getKey()).append("-> ");
+                for (final Module module : allModules.get(entry.getKey())) {
+                    sb.append("namespaceURI: ").append(module.getNamespaceURI()).append('\n');
+                    sb.append("defaultPrefix: ").append(module.getDefaultPrefix()).append('\n');
+                    sb.append("description: ").append(module.getDescription()).append('\n');
+                    for (final Iterator<QName> it = module.getGlobalVariables(); it.hasNext(); ) {
+                        final QName qName = it.next();
+                        sb.append(qName).append(';');
+                    }
+                }
+            }
+        }
+        sb.append('}');
+        sb.append('\n');
+
+        sb.append('}');
+
+        return sb.toString();
+    }
+
+
 }

exist-core/src/main/java/org/exist/xquery/functions/fn/FnModule.java

@@ -215,6 +215,7 @@ public class FnModule extends AbstractInternalModule {
         new FunctionDef(FunTokenize.FS_TOKENIZE[2], FunTokenize.class),
         new FunctionDef(FunTrace.FS_TRACE1, FunTrace.class),
         new FunctionDef(FunTrace.FS_TRACE2, FunTrace.class),
+        new FunctionDef(FnTransform.FS_TRANSFORM, FnTransform.class),
         new FunctionDef(FunTranslate.signature, FunTranslate.class),
         new FunctionDef(FunTrueOrFalse.fnTrue, FunTrueOrFalse.class),
         new FunctionDef(FunTrueOrFalse.fnFalse, FunTrueOrFalse.class),
@@ -280,37 +281,35 @@ public FnModule(Map<String, List<?>> parameters) {
         super(functions, parameters, true);
     }
 
-    /* (non-Javadoc)
-     * @see org.exist.xquery.Module#getDescription()
-     */
+    @Override
     public String getDescription() {
         return "A module with the XQuery/XPath Core Library Functions";
     }
 
-    /* (non-Javadoc)
-     * @see org.exist.xquery.Module#getNamespaceURI()
-     */
+    @Override
     public String getNamespaceURI() {
         return Function.BUILTIN_FUNCTION_NS;
     }
 
-    /* (non-Javadoc)
-     * @see org.exist.xquery.Module#getDefaultPrefix()
-     */
+    @Override
     public String getDefaultPrefix() {
         return PREFIX;
     }
 
+    @Override
     public String getReleaseVersion() {
         return RELEASED_IN_VERSION;
     }
 
-    static FunctionSignature functionSignature(final String name, final String description, final FunctionReturnSequenceType returnType, final FunctionParameterSequenceType... paramTypes) {
-        return FunctionDSL.functionSignature(new QName(name, Function.BUILTIN_FUNCTION_NS), description, returnType, paramTypes);
+    static FunctionSignature functionSignature(final String name, final String description,
+            final FunctionReturnSequenceType returnType, final FunctionParameterSequenceType... paramTypes) {
+        return FunctionDSL.functionSignature(new QName(name, Function.BUILTIN_FUNCTION_NS), description,
+                returnType, paramTypes);
     }
 
-    static FunctionSignature[] functionSignatures(final String name, final String description, final FunctionReturnSequenceType returnType, final FunctionParameterSequenceType[][] variableParamTypes) {
-        return FunctionDSL.functionSignatures(new QName(name, Function.BUILTIN_FUNCTION_NS), description, returnType, variableParamTypes);
+    static FunctionSignature[] functionSignatures(final String name, final String description,
+            final FunctionReturnSequenceType returnType, final FunctionParameterSequenceType[][] variableParamTypes) {
+        return FunctionDSL.functionSignatures(new QName(name, Function.BUILTIN_FUNCTION_NS), description,
+                returnType, variableParamTypes);
     }
-
 }

exist-core/src/main/java/org/exist/xquery/functions/fn/FnTransform.java

@@ -0,0 +1,70 @@
+/*
+ * eXist-db Open Source Native XML Database
+ * Copyright (C) 2001 The eXist-db Authors
+ *
+ * info@exist-db.org
+ * http://www.exist-db.org
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ */
+
+package org.exist.xquery.functions.fn;
+
+import org.exist.xquery.BasicFunction;
+import org.exist.xquery.FunctionSignature;
+import org.exist.xquery.XPathException;
+import org.exist.xquery.XQueryContext;
+import org.exist.xquery.functions.fn.transform.Transform;
+import org.exist.xquery.value.Sequence;
+import org.exist.xquery.value.Type;
+
+import static org.exist.xquery.FunctionDSL.param;
+import static org.exist.xquery.FunctionDSL.returnsOptMany;
+import static org.exist.xquery.functions.fn.FnModule.functionSignature;
+
+/**
+ * Implementation of fn:transform.
+ *
+ * @author <a href="mailto:adam@evolvedbinary.com">Adam Retter</a>
+ * @author <a href="mailto:alan@evolvedbinary.com">Alan Paxton</a>
+ */
+public class FnTransform extends BasicFunction {
+
+    private static final String FS_TRANSFORM_NAME = "transform";
+    static final FunctionSignature FS_TRANSFORM = functionSignature(
+            FnTransform.FS_TRANSFORM_NAME,
+            "Invokes a transformation using a dynamically-loaded XSLT stylesheet.",
+            returnsOptMany(Type.MAP, "The result of the transformation is returned as a map. " +
+                    "There is one entry in the map for the principal result document, and one for each " +
+                    "secondary result document. The key is a URI in the form of an xs:string value. " +
+                    "The key for the principal result document is the base output URI if specified, or " +
+                    "the string \"output\" otherwise. The key for secondary result documents is the URI of the " +
+                    "document, as an absolute URI. The associated value in each entry depends on the requested " +
+                    "delivery format. If the delivery format is document, the value is a document node. If the " +
+                    "delivery format is serialized, the value is a string containing the serialized result."),
+            param("options", Type.MAP, "The inputs to the transformation are supplied in the form of a map")
+    );
+
+    private Transform transform = new Transform(context, this);
+
+    public FnTransform(final XQueryContext context, final FunctionSignature signature) {
+        super(context, signature);
+    }
+
+    @Override
+    public Sequence eval(Sequence[] args, Sequence contextSequence) throws XPathException {
+        return transform.eval(args, contextSequence);
+    }
+}