evolvedbinary / elemental / 982

Committed 29 Apr 2025 08:34PM UTC coverage: 56.409% (+0.007%) from 56.402%

Build # 982

Build Type

push

circleci

Committed by

adamretter

Commit Message

[feature] Improve README.md badges

Run Details

28451 of 55847 branches covered (50.94%)

Branch coverage included in aggregate %.

77468 of 131924 relevant lines covered (58.72%)

0.59 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

74.25

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

/*
 * Elemental
 * Copyright (C) 2024, Evolved Binary Ltd
 *
 * admin@evolvedbinary.com
 * https://www.evolvedbinary.com | https://www.elemental.xyz
 *
 * Use of this software is governed by the Business Source License 1.1
 * included in the LICENSE file and at www.mariadb.com/bsl11.
 *
 * Change Date: 2028-04-27
 *
 * On the date above, in accordance with the Business Source License, use
 * of this software will be governed by the Apache License, Version 2.0.
 *
 * Additional Use Grant: Production use of the Licensed Work for a permitted
 * purpose. A Permitted Purpose is any purpose other than a Competing Use.
 * A Competing Use means making the Software available to others in a commercial
 * product or service that: substitutes for the Software; substitutes for any
 * other product or service we offer using the Software that exists as of the
 * date we make the Software available; or offers the same or substantially
 * similar functionality as the Software.
 *
 * NOTE: Parts of this file contain code from 'The eXist-db Authors'.
 *       The original license header is included below.
 *
 * =====================================================================
 *
 * 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;

import java.io.IOException;
import java.io.Reader;
import java.lang.reflect.Constructor;
import java.lang.reflect.InvocationTargetException;
import java.net.MalformedURLException;
import java.net.URI;
import java.net.URISyntaxException;
import java.nio.charset.Charset;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.*;
import java.util.concurrent.CopyOnWriteArrayList;
import java.util.concurrent.ThreadPoolExecutor;
import java.util.concurrent.atomic.AtomicReference;
import java.util.function.BiFunction;
import java.util.function.Consumer;
import java.util.function.Predicate;

import javax.annotation.Nullable;
import javax.xml.datatype.DatatypeConfigurationException;
import javax.xml.datatype.DatatypeFactory;
import javax.xml.datatype.Duration;
import javax.xml.datatype.XMLGregorianCalendar;
import javax.xml.stream.XMLStreamException;

import antlr.RecognitionException;
import antlr.TokenStreamException;
import antlr.collections.AST;
import com.evolvedbinary.j8fu.Either;
import com.evolvedbinary.j8fu.function.TriFunctionE;
import com.evolvedbinary.j8fu.function.QuadFunctionE;
import com.evolvedbinary.j8fu.tuple.Tuple2;
import com.ibm.icu.text.Collator;
import it.unimi.dsi.fastutil.Hash;
import it.unimi.dsi.fastutil.objects.*;
import net.jcip.annotations.Immutable;
import net.jcip.annotations.ThreadSafe;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.exist.Database;
import org.exist.EXistException;
import org.exist.Namespaces;
import org.exist.collections.Collection;
import org.exist.debuggee.Debuggee;
import org.exist.debuggee.DebuggeeJoint;
import org.exist.dom.persistent.*;
import org.exist.dom.QName;
import org.exist.http.servlets.*;
import org.exist.dom.memtree.InMemoryXMLStreamReader;
import org.exist.dom.memtree.MemTreeBuilder;
import org.exist.dom.memtree.NodeImpl;
import org.exist.numbering.NodeId;
import org.exist.repo.ExistRepository;
import org.exist.security.AuthenticationException;
import org.exist.security.Permission;
import org.exist.security.PermissionDeniedException;
import org.exist.security.Subject;
import org.exist.source.*;
import org.exist.stax.ExtendedXMLStreamReader;
import org.exist.storage.BrokerPool;
import org.exist.storage.DBBroker;
import org.exist.storage.UpdateListener;
import org.exist.storage.lock.Lock.LockMode;
import org.exist.storage.lock.LockedDocumentMap;
import org.exist.storage.txn.Txn;
import org.exist.util.*;
import org.exist.util.hashtable.NamePool;
import org.exist.xmldb.XmldbURI;
import org.exist.xquery.parser.*;
import org.exist.xquery.pragmas.*;
import org.exist.xquery.update.Modification;
import org.exist.xquery.util.SerializerUtils;
import org.exist.xquery.value.*;
import org.jgrapht.Graph;
import org.jgrapht.alg.interfaces.ShortestPathAlgorithm;
import org.jgrapht.alg.shortestpath.TransitNodeRoutingShortestPath;
import org.jgrapht.graph.DefaultEdge;
import org.jgrapht.graph.DefaultGraphType;
import org.jgrapht.opt.graph.fastutil.FastutilMapGraph;
import org.jgrapht.util.ConcurrencyUtil;
import org.jgrapht.util.SupplierUtil;
import org.w3c.dom.Node;

import static com.evolvedbinary.j8fu.OptionalUtil.or;
import static com.evolvedbinary.j8fu.tuple.Tuple.Tuple;
import static javax.xml.XMLConstants.XMLNS_ATTRIBUTE;
import static javax.xml.XMLConstants.XML_NS_PREFIX;
import static org.exist.Namespaces.XML_NS;
import static org.exist.util.MapUtil.hashMap;

/**
 * The current XQuery execution context. Contains the static as well as the dynamic
 * XQuery context components.
 *
 * @author <a href="mailto:wolfgang@exist-db.org">Wolfgang Meier</a>
 */
public class XQueryContext implements BinaryValueManager, Context {

    private static final Logger LOG = LogManager.getLogger(XQueryContext.class);

    public static final String ENABLE_QUERY_REWRITING_ATTRIBUTE = "enable-query-rewriting";
    public static final String XQUERY_BACKWARD_COMPATIBLE_ATTRIBUTE = "backwardCompatible";
    public static final String XQUERY_RAISE_ERROR_ON_FAILED_RETRIEVAL_ATTRIBUTE = "raise-error-on-failed-retrieval";
    public static final String ENFORCE_INDEX_USE_ATTRIBUTE = "enforce-index-use";

    //TODO : move elsewhere ?
    public static final String BUILT_IN_MODULE_URI_ATTRIBUTE = "uri";
    public static final String BUILT_IN_MODULE_CLASS_ATTRIBUTE = "class";
    public static final String BUILT_IN_MODULE_SOURCE_ATTRIBUTE = "src";

    public static final String PROPERTY_XQUERY_BACKWARD_COMPATIBLE = "xquery.backwardCompatible";
    public static final String PROPERTY_ENABLE_QUERY_REWRITING = "xquery.enable-query-rewriting";
    public static final String PROPERTY_XQUERY_RAISE_ERROR_ON_FAILED_RETRIEVAL = "xquery.raise-error-on-failed-retrieval";
    public static final boolean XQUERY_RAISE_ERROR_ON_FAILED_RETRIEVAL_DEFAULT = false;
    public static final String PROPERTY_ENFORCE_INDEX_USE = "xquery.enforce-index-use";

    //TODO : move elsewhere ?
    public static final String PROPERTY_BUILT_IN_MODULES = "xquery.modules";
    public static final String PROPERTY_STATIC_MODULE_MAP = "xquery.modules.static";
    public static final String PROPERTY_MODULE_PARAMETERS = "xquery.modules.parameters";

    public static final String JAVA_URI_START = "java:";
    //private static final String XMLDB_URI_START = "xmldb:exist://";

    private static final String TEMP_STORE_ERROR = "Error occurred while storing temporary data";
    public static final String XQUERY_CONTEXTVAR_XQUERY_UPDATE_ERROR = "_eXist_xquery_update_error";
    public static final String HTTP_SESSIONVAR_XMLDB_USER = "_eXist_xmldb_user";

    public static final String HTTP_REQ_ATTR_USER = "xquery.user";
    public static final String HTTP_REQ_ATTR_PASS = "xquery.password";

    // Static namespace/prefix mappings
    protected Map<String, String> staticNamespaces = new HashMap<>();

    // Static prefix/namespace mappings
    protected Map<String, String> staticPrefixes = new HashMap<>();

    // Local in-scope namespace/prefix mappings in the current context
    Map<String, String> inScopeNamespaces = new HashMap<>();

    // Local prefix/namespace mappings in the current context
    private Map<String, String> inScopePrefixes = new HashMap<>();

    // Inherited in-scope namespace/prefix mappings in the current context
    private Map<String, String> inheritedInScopeNamespaces = new HashMap<>();

    // Inherited prefix/namespace mappings in the current context
    private Map<String, String> inheritedInScopePrefixes = new HashMap<>();

    private boolean preserveNamespaces = true;

    private boolean inheritNamespaces = true;

    // Local namespace stack
    private final Deque<Map<String, String>> namespaceStack = new ArrayDeque<>();

    // Known user defined functions in the local module
    private Map<FunctionId, UserDefinedFunction> declaredFunctions = new Object2ObjectAVLTreeMap<>();

    // Globally declared variables
    protected Map<QName, Variable> globalVariables = new Object2ObjectRBTreeMap<>();

    // The last element in the linked list of local in-scope variables
    private LocalVariable lastVar = null;

    private Deque<LocalVariable> contextStack = new ArrayDeque<>();

    private final Deque<FunctionSignature> callStack = new ArrayDeque<>();

    // The current size of the variable stack
    private int variableStackSize = 0;

    // Unresolved references to user defined functions
    private final Deque<FunctionCall> forwardReferences = new ArrayDeque<>();

    // Inline functions using closures need to be cleared after execution
    private final Deque<UserDefinedFunction> closures = new ArrayDeque<>();

    // List of options declared for this query at compile time - i.e. declare option
    private List<Option> staticOptions = null;

    // List of options declared for this query at run time - i.e. util:declare-option()
    private List<Option> dynamicOptions = null;

    //The Calendar for this context : may be changed by some options
    private XMLGregorianCalendar calendar = null;
    private TimeZone implicitTimeZone = null;

    private final Map<String, Sequence> cachedUriCollectionResults = new HashMap<>();

    /**
     * the watchdog object assigned to this query.
     */
    protected XQueryWatchDog watchdog;

    /**
     * Loaded modules within this module.
     * <p>
     * The format of the map is: <code>Map&lt;NamespaceURI, Modules&gt;</code>.
     */
    protected Object2ObjectMap<String, Module[]> modules = new Object2ObjectOpenHashMap<>(8, Hash.VERY_FAST_LOAD_FACTOR);

    /**
     * Loaded modules, including ones bubbled up from imported modules.
     * <p>
     * The format of the map is: <code>Map&lt;NamespaceURI, Modules&gt;</code>
     */
    private Object2ObjectMap<String, Module[]> allModules = new Object2ObjectOpenHashMap<>();

    /**
     * Describes a graph of all the modules and how they import each other.
     */
    private @Nullable Graph<ModuleVertex, DefaultEdge> modulesDependencyGraph;
    private @Nullable ThreadPoolExecutor modulesDependencyGraphSPExecutor;

    /**
     * Used to save current state when modules are imported dynamically
     */
    private final SavedState savedState = new SavedState();

    /**
     * Whether some modules were rebound to new instances since the last time this context's query was analyzed. (This assumes that each context is
     * attached to at most one query.)
     */
    @SuppressWarnings("unused")
    private boolean modulesChanged = true;

    /**
     * The set of statically known documents specified as an array of paths to documents and collections.
     */
    private XmldbURI[] staticDocumentPaths = null;

    /**
     * The actual set of statically known documents. This will be generated on demand from staticDocumentPaths.
     */
    private DocumentSet staticDocuments = null;

    /**
     * The available documents of the dynamic context.
     * <p>
     * {@see https://www.w3.org/TR/xpath-31/#dt-available-docs}.
     */
    private Map<String, TriFunctionE<DBBroker, Txn, String, Either<org.exist.dom.memtree.DocumentImpl, DocumentImpl>, XPathException>> dynamicDocuments = null;

    /**
     * The available test resources of the dynamic context.
     * <p>
     * {@see https://www.w3.org/TR/xpath-31/#dt-available-text-resources}.
     */
    private Map<Tuple2<String, Charset>, QuadFunctionE<DBBroker, Txn, String, Charset, Reader, XPathException>> dynamicTextResources = null;

    /**
     * The available collections of the dynamic context.
     * <p>
     * {@see https://www.w3.org/TR/xpath-31/#dt-available-collections}.
     */
    private Map<String, TriFunctionE<DBBroker, Txn, String, Sequence, XPathException>> dynamicCollections = null;

    /**
     * A set of documents which were modified during the query, usually through an XQuery update extension. The documents will be checked after the
     * query completed to see if a defragmentation run is needed.
     */
    protected MutableDocumentSet modifiedDocuments = null;

    /**
     * A general-purpose map to set attributes in the current query context.
     */
    protected Map<String, Object> attributes = new HashMap<>();

    protected AnyURIValue baseURI = AnyURIValue.EMPTY_URI;

    private boolean baseURISetInProlog = false;

    protected String moduleLoadPath = ".";

    private String defaultFunctionNamespace = Function.BUILTIN_FUNCTION_NS;
    private AnyURIValue defaultElementNamespace = AnyURIValue.EMPTY_URI;
    private AnyURIValue defaultElementNamespaceSchema = AnyURIValue.EMPTY_URI;

    /**
     * The default collation URI.
     */
    private String defaultCollation = Collations.UNICODE_CODEPOINT_COLLATION_URI;

    /**
     * The default language
     */
    private static final String DefaultLanguage = Locale.getDefault().getLanguage();

    /**
     * Default Collator. Will be null for the default unicode codepoint collation.
     */
    private Collator defaultCollator = null;

    /**
     * Set to true to enable XPath 1.0 backwards compatibility.
     */
    private boolean backwardsCompatible = false;

    /**
     * Should whitespace inside node constructors be stripped?
     */
    private boolean stripWhitespace = true;

    /**
     * Should empty order greatest or least?
     */
    private boolean orderEmptyGreatest = false;

    /**
     * XQuery 3.0 - declare context item :=
     */
    private ContextItemDeclaration contextItemDeclaration = null;

    /**
     * The context item set in the query prolog or externally
     */
    private Sequence contextItem = Sequence.EMPTY_SEQUENCE;

    /**
     * The position of the currently processed item in the context sequence. This field has to be set on demand, for example, before calling the
     * fn:position() function.
     */
    private int contextPosition = 0;
    private Sequence contextSequence = null;

    /**
     * Shared name pool used by all in-memory documents constructed in this query context.
     */
    private NamePool sharedNamePool = null;

    /**
     * Stack for temporary document fragments.
     */
    private Deque<MemTreeBuilder> fragmentStack = new ArrayDeque<>();

    /**
     * The root of the expression tree.
     */
    private Expression rootExpression;

    /**
     * An incremental counter to count the expressions in the current XQuery. Used during compilation to assign a unique ID to every expression.
     */
    private int expressionCounter = 0;

    private LockedDocumentMap protectedDocuments = null;

    /**
     * The profiler instance used by this context.
     */
    protected Profiler profiler;

    //For holding the environment variables
    private Map<String, String> envs;

    private ContextUpdateListener updateListener = null;

    private boolean enableOptimizer = true;

    private boolean raiseErrorOnFailedRetrieval = XQUERY_RAISE_ERROR_ON_FAILED_RETRIEVAL_DEFAULT;

    private boolean isShared = false;

    private Source source = null;

    private DebuggeeJoint debuggeeJoint = null;

    private int xqueryVersion = 31;

    protected Database db;

    protected Configuration configuration;

    private boolean analyzed = false;

    /**
     * The Subject of the User that requested the execution of the XQuery
     * attached by this Context. This is not the same as the Effective User
     * as we may be executed setUid or setGid. The Effective User can be retrieved
     * through broker.getCurrentSubject()
     */
    private Subject realUser;

    /**
     * Indicates whether a user from a http session
     * was pushed onto the current broker from {@link XQueryContext#prepareForExecution()},
     * if so then we must pop the user in {@link XQueryContext#reset(boolean)}
     */
    private boolean pushedUserFromHttpSession = false;

    /**
     * The HTTP context within which the XQuery
     * is executing, or null if there is no
     * HTTP context.
     */
    private @Nullable HttpContext httpContext = null;
    private static final QName UNNAMED_DECIMAL_FORMAT = new QName("__UNNAMED__", Function.BUILTIN_FUNCTION_NS);

    private final Map<QName, DecimalFormat> staticDecimalFormats = hashMap(Tuple(UNNAMED_DECIMAL_FORMAT, DecimalFormat.UNNAMED));

    // Only used for testing, e.g. {@link org.exist.test.runner.XQueryTestRunner}.
    private Optional<ExistRepository> testRepository = Optional.empty();

    /**
     * Holds a list of any new XQuery Contexts that
     * were created by the XQuery (owning this XQuery Context)
     * dynamically importing, compiling, and/or evaluating modules.
     * <p>
     * NOTE(AR) - This is needed to ensure that these "imported contexts" are
     * also correctly reset and cleaned up when this XQuery is finished.
     */
    private Set<XQueryContext> importedContexts = null;

    /**
     * Holds a list of the {@link #runCleanupTasks(Predicate)} functions
     * of the {@link #importedContexts}.
     * <p>
     * NOTE(AR) - This is needed to ensure that these the user call
     * {@link #reset()} or {@link #runCleanupTasks(Predicate)}
     * in any order.
     */
    private List<Consumer<Predicate<Object>>> importedContextsCleanupTasksFns = null;

    public XQueryContext() {
        this(null, null, null);
    }

    public XQueryContext(final Configuration configuration) {
        this(null, configuration, null);
    }

    public XQueryContext(final Database db) {
        this(db, null, null);
    }

    public XQueryContext(final Database db, final Profiler profiler) {
        this(db, null, profiler);
    }

    public XQueryContext(@Nullable final Database db, @Nullable final Configuration configuration, @Nullable final Profiler profiler) {
        this(db, configuration, profiler, true);
    }

    protected XQueryContext(@Nullable final Database db, @Nullable final Configuration configuration, @Nullable final Profiler profiler, final boolean loadDefaults) {
        this.db = db;

        // if needed, fallback to db.getConfiguration
        if (configuration != null) {
            this.configuration = configuration;
        } else if (db != null) {
            this.configuration = db.getConfiguration();
        } else {
            this.configuration = null;
        }

        // if needed, fallback to profiler for the db, or default profiler
        if (profiler != null) {
            this.profiler = profiler;
        } else if (db != null) {
            this.profiler = new Profiler(db);
        } else {
            this.profiler = new Profiler(null);
        }

        this.watchdog = new XQueryWatchDog(this);

        // load configuration defaults
        if (loadDefaults) {
            loadDefaults(this.configuration);
        }
    }

    public XQueryContext(final XQueryContext copyFrom) {
        this(copyFrom.db, copyFrom.configuration, copyFrom.profiler);

        for (final String prefix : copyFrom.staticNamespaces.keySet()) {
            if (XML_NS_PREFIX.equals(prefix) || XMLNS_ATTRIBUTE.equals(prefix)) {
                continue;
            }

            try {
                declareNamespace(prefix, copyFrom.staticNamespaces.get(prefix));
            } catch (final XPathException ex) {
                ex.printStackTrace();
            }
        }
    }


    /**
     * Get the HTTP context of the XQuery.
     *
     * @return the HTTP context, or null if the query
     * is not being executed within an HTTP context.
     */
    public @Nullable HttpContext getHttpContext() {
        return httpContext;
    }

    /**
     * Set the HTTP context of the XQuery.
     *
     * @param httpContext the HTTP context within which the XQuery
     *                    is being executed.
     */
    public void setHttpContext(@Nullable final HttpContext httpContext) {
        this.httpContext = httpContext;
    }

    /**
     * Set the EXPath repository used for testing,
     * only should be called from {@link org.exist.test.runner.XQueryTestRunner}.
     *
     * @param testRepository the EXPath repository to use for test execution.
     */
    public void setTestRepository(final Optional<ExistRepository> testRepository) {
        this.testRepository = testRepository;
    }

    /**
     * Get the EXPath repository configured for the BrokerPool, if present.
     *
     * @return the EXPath repository if present.
     */
    public Optional<ExistRepository> getRepository() {
        return or(
                testRepository,
                () -> Optional.ofNullable(getBroker()).map(DBBroker::getBrokerPool).flatMap(BrokerPool::getExpathRepo)
        );
    }

    /**
     * Resolve a Module from the EXPath Repository.
     *
     * @param namespace namespace URI
     * @param prefix namespace prefix
     *
     * @return the module or null
     *
     * @throws XPathException if the namespace URI is invalid (XQST0046),
     *     if the module could not be loaded (XQST0059) or compiled (XPST0003)
     */
    private @Nullable Module resolveInEXPathRepository(final String namespace, final String prefix)
            throws XPathException {
        // the repo and its eXist handler
        final Optional<ExistRepository> repo = getRepository();

        if (repo.isEmpty()) {
            return null;
        }

        // try an internal module
        final Module jMod = repo.get().resolveJavaModule(namespace, this);
        if (jMod != null) {
            return jMod;
        }

        // try an eXist-specific module
        final Path resolved = repo.get().resolveXQueryModule(namespace);
        if (resolved == null) {
            return null;
        }

        // use the resolved file or return null
        if (resolved != null) {

            String location = "";

            try {

                    // see if the src exists in the database and if so, use that instead
                    Source src = repo.get().resolveStoredXQueryModuleFromDb(getBroker(), resolved);
                    if (src != null) {
                        // NOTE(AR) set the location of the module to import relative to this module's load path - so that transient imports of the imported module will resolve correctly!
                        final Path srcCollectionPath = Paths.get(((DBSource)src).getDocumentPath().getCollectionPath());
                        if (srcCollectionPath.isAbsolute()) {
                            location = srcCollectionPath.toString();
                        } else {
                            final Path moduleLoadPathCollectionPath = Paths.get(XmldbURI.create(moduleLoadPath).getCollectionPath());
                            location = moduleLoadPathCollectionPath.relativize(srcCollectionPath).toString();
                        }
                    } else {
                        // else, fallback to the one from the filesystem
                        src = new FileSource(resolved, false);
                    }

                // build a module object from the source
                final ExternalModule module = compileOrBorrowModule(namespace, prefix, location, src);
                return module;

            } catch (final PermissionDeniedException e) {
                throw new XPathException(e.getMessage(), e);
            }
        }

        return null;
    }

    /**
     * Prepares the XQuery Context for use.
     * <p>
     * Should be called before compilation to prepare the query context,
     * or before re-execution if the query was cached.
     *
     * @throws XPathException in case of static error
     */
    public void prepareForReuse() throws XPathException {
        // prepare the variables of the internal modules (which were previously reset)
        for (final Module[] modules : allModules.values()) {
            for (final Module module : modules) {
                if (module instanceof InternalModule) {
                    ((InternalModule) module).prepare(this);
                }
            }
        }
    }

    @Override
    public boolean hasParent() {
        return false;
    }

    @Override
    public XQueryContext getRootContext() {
        return this;
    }

    @Override
    public XQueryContext copyContext() {
        final XQueryContext ctx = new XQueryContext(this);
        copyFields(ctx);
        return ctx;
    }

    @Override
    public void updateContext(final XQueryContext from) {
        this.watchdog = from.watchdog;
        this.lastVar = from.lastVar;
        this.contextStack = from.contextStack;
        this.inScopeNamespaces = from.inScopeNamespaces;
        this.inScopePrefixes = from.inScopePrefixes;
        this.inheritedInScopeNamespaces = from.inheritedInScopeNamespaces;
        this.inheritedInScopePrefixes = from.inheritedInScopePrefixes;
        this.variableStackSize = from.variableStackSize;
        this.attributes = from.attributes;
        this.updateListener = from.updateListener;
        this.modules = from.modules;
        this.allModules = from.allModules;
        this.dynamicOptions = from.dynamicOptions;
        this.staticOptions = from.staticOptions;
        this.db = from.db;
        this.configuration = from.configuration;
        this.httpContext = from.httpContext;
    }

    protected void copyFields(final XQueryContext ctx) {
        ctx.calendar = this.calendar;
        ctx.implicitTimeZone = this.implicitTimeZone;
        ctx.baseURI = this.baseURI;
        ctx.baseURISetInProlog = this.baseURISetInProlog;
        ctx.staticDocumentPaths = this.staticDocumentPaths;
        ctx.staticDocuments = this.staticDocuments;
        ctx.dynamicDocuments = this.dynamicDocuments;
        ctx.dynamicTextResources = this.dynamicTextResources;
        ctx.dynamicCollections = this.dynamicCollections;
        ctx.moduleLoadPath = this.moduleLoadPath;
        ctx.defaultFunctionNamespace = this.defaultFunctionNamespace;
        ctx.defaultElementNamespace = this.defaultElementNamespace;
        ctx.defaultCollation = this.defaultCollation;
        ctx.defaultCollator = this.defaultCollator;
        ctx.backwardsCompatible = this.backwardsCompatible;
        ctx.enableOptimizer = this.enableOptimizer;
        ctx.stripWhitespace = this.stripWhitespace;
        ctx.preserveNamespaces = this.preserveNamespaces;
        ctx.inheritNamespaces = this.inheritNamespaces;
        ctx.orderEmptyGreatest = this.orderEmptyGreatest;

        ctx.declaredFunctions = new Object2ObjectAVLTreeMap<>(this.declaredFunctions);
        ctx.globalVariables = new Object2ObjectRBTreeMap<>(this.globalVariables);
        ctx.attributes = new HashMap<>(this.attributes);

        // make imported modules available in the new context
        ctx.modules = new Object2ObjectOpenHashMap<>(this.modules.size(), Hash.VERY_FAST_LOAD_FACTOR);
        for (final Object2ObjectMap.Entry<String, Module[]> entry : Object2ObjectMaps.fastIterable(this.modules)) {
            final String namespaceURI = entry.getKey();
            final Module[] modules = entry.getValue();

            ctx.modules.put(namespaceURI, Arrays.copyOf(modules, modules.length));

            final String prefix = this.staticPrefixes.get(namespaceURI);
            try {
                ctx.declareNamespace(prefix, namespaceURI);
            } catch (final XPathException e) {
                // ignore
                LOG.warn(e);
            }
        }

        ctx.allModules = new Object2ObjectOpenHashMap<>(this.allModules.size());
        for (final Object2ObjectMap.Entry<String, Module[]> allModulesEntry : Object2ObjectMaps.fastIterable(this.allModules)) {
            final Module[] modules = allModulesEntry.getValue();
            ctx.allModules.put(allModulesEntry.getKey(), Arrays.copyOf(modules, modules.length));
        }

        ctx.watchdog = this.watchdog;
        ctx.profiler = getProfiler();
        ctx.lastVar = this.lastVar;
        ctx.variableStackSize = getCurrentStackSize();
        ctx.contextStack = this.contextStack;
        ctx.staticNamespaces = new HashMap<>(this.staticNamespaces);
        ctx.staticPrefixes = new HashMap<>(this.staticPrefixes);

        if (this.dynamicOptions != null) {
            ctx.dynamicOptions = new ArrayList<>(this.dynamicOptions);
        }

        if (this.staticOptions != null) {
            ctx.staticOptions = new ArrayList<>(this.staticOptions);
        }

        ctx.source = this.source;
        ctx.httpContext = this.httpContext;
    }

    @Override
    public void prepareForExecution() {
        //if there is an existing user in the current http session
        //then set the DBBroker user
        final Subject user = getUserFromHttpSession();
        if (user != null) {
            getBroker().pushSubject(user);      //this will be popped in {@link XQueryContext#reset(boolean)}
            this.pushedUserFromHttpSession = true;
        }

        setRealUser(getBroker().getCurrentSubject());   //this will be unset in {@link XQueryContext#reset(boolean)}

        //Reset current context position
        setContextSequencePosition(0, null);
        //Note that, for some reasons, an XQueryContext might be used without calling this method
    }

    public void setContextItem(final Sequence contextItem) {
        this.contextItem = contextItem;
    }

    public void setContextItemDeclaration(final ContextItemDeclaration contextItemDeclaration) {
        this.contextItemDeclaration = contextItemDeclaration;
    }

    public ContextItemDeclaration getContextItemDeclartion() {
        return contextItemDeclaration;
    }

    public Sequence getContextItem() {
        return contextItem;
    }

    @Override
    public boolean isProfilingEnabled() {
        return profiler.isEnabled();
    }

    @Override
    public boolean isProfilingEnabled(final int verbosity) {
        return profiler.isEnabled() && profiler.verbosity() >= verbosity;
    }

    @Override
    public Profiler getProfiler() {
        return profiler;
    }

    @Override
    public void setRootExpression(final Expression expr) {
        this.rootExpression = expr;
    }

    @Override
    public Expression getRootExpression() {
        return rootExpression;
    }

    /**
     * Returns the next unique expression id. Every expression in the XQuery is identified by a unique id. During compilation, expressions are
     * assigned their id by calling this method.
     *
     * @return The next unique expression id.
     */
    int nextExpressionId() {
        return expressionCounter++;
    }

    @Override
    public int getExpressionCount() {
        return expressionCounter;
    }

    @Override
    public void declareNamespace(final String prefix, final String uri) throws XPathException {
        if (XML_NS_PREFIX.equals(prefix) || XMLNS_ATTRIBUTE.equals(prefix)) {
            throw new XPathException(rootExpression, ErrorCodes.XQST0070,
                    "Namespace predefined prefix '" + prefix + "' can not be bound");
        }

        if (XML_NS.equals(uri)) {
            throw new XPathException(rootExpression, ErrorCodes.XQST0070,
                    "Namespace URI '" + uri + "' must be bound to the 'xml' prefix");
        }

        final String nonNullPrefix = prefix == null ?  "" : prefix;
        final String nonNullUri = uri == null ? "" : uri;

        //This prefix was not bound
        if (!staticNamespaces.containsKey(nonNullPrefix)) {
            if (nonNullUri.isEmpty()) {
                //Nothing to bind
                //TODO : check the specs : unbinding an NS which is not already bound may be disallowed.
                // FIXME (JL): despite the log message nothing happens in this execution branch
                LOG.warn("Unbinding unbound prefix '{}'", prefix);
            } else {
                //Bind it
                staticNamespaces.put(nonNullPrefix, nonNullUri);
                staticPrefixes.put(nonNullUri, nonNullPrefix);
            }
            return;
        }

        //This prefix was bound
        final String prevURI = staticNamespaces.get(nonNullPrefix);
        //Unbind it
        if (nonNullUri.isEmpty()) {
            // if an empty namespace is specified,
            // remove any existing mapping for this namespace
            // FIXME (JL): this allows to rebind namespaces to a different URI
            staticPrefixes.remove(nonNullUri);
            staticNamespaces.remove(nonNullPrefix);
            return;
        }

        //those prefixes can be rebound to different URIs
        if (("xs".equals(nonNullPrefix) && Namespaces.SCHEMA_NS.equals(prevURI))
                || ("xsi".equals(nonNullPrefix) && Namespaces.SCHEMA_INSTANCE_NS.equals(prevURI))
                || ("xdt".equals(nonNullPrefix) && Namespaces.XPATH_DATATYPES_NS.equals(prevURI))
                || ("fn".equals(nonNullPrefix) && Namespaces.XPATH_FUNCTIONS_NS.equals(prevURI))
                || ("math".equals(nonNullPrefix)) && Namespaces.XPATH_FUNCTIONS_MATH_NS.equals(prevURI)
                || ("local".equals(nonNullPrefix) && Namespaces.XQUERY_LOCAL_NS.equals(prevURI))) {

            staticPrefixes.remove(prevURI);
            staticNamespaces.remove(nonNullPrefix);

            staticNamespaces.put(nonNullPrefix, nonNullUri);
            staticPrefixes.put(nonNullUri, nonNullPrefix);
            return;
        }
        //Forbids rebinding the *same* prefix in a *different* namespace in this *same* context
        if (!nonNullUri.equals(prevURI)) {
            throw new XPathException(rootExpression, ErrorCodes.XQST0033,
                    "Cannot bind prefix '" + prefix + "' to '" + nonNullUri + "' it is already bound to '" + prevURI + "'");
        }

        // FIXME (JL): function call can end up in unhandled case
        // e.g. declareNamespace(null,null)
    }

    @Override
    public void declareNamespaces(final Map<String, String> namespaceMap) {
        for (final Map.Entry<String, String> entry : namespaceMap.entrySet()) {
            String prefix = entry.getKey();
            String uri = entry.getValue();

            if (prefix == null) {
                prefix = "";
            }

            if (uri == null) {
                uri = "";
            }
            staticNamespaces.put(prefix, uri);
            staticPrefixes.put(uri, prefix);
        }
    }

    @Override
    public void removeNamespace(final String uri) {
        staticPrefixes.remove(uri);

        for (final Iterator<String> i = staticNamespaces.values().iterator(); i.hasNext(); ) {
            if (i.next().equals(uri)) {
                i.remove();
                return;
            }
        }
        inScopePrefixes.remove(uri);

        if (inScopeNamespaces != null) {
            for (final Iterator<String> i = inScopeNamespaces.values().iterator(); i.hasNext(); ) {
                if (i.next().equals(uri)) {
                    i.remove();
                    return;
                }
            }
        }
        inheritedInScopePrefixes.remove(uri);

        if (inheritedInScopeNamespaces != null) {
            for (final Iterator<String> i = inheritedInScopeNamespaces.values().iterator(); i.hasNext(); ) {
                if (i.next().equals(uri)) {
                    i.remove();
                    return;
                }
            }
        }
    }

    @Override
    public void declareInScopeNamespace(final String prefix, final String uri) {
        if (prefix == null || uri == null) {
            throw new IllegalArgumentException("null argument passed to declareNamespace");
        }

        //Activate the namespace by removing it from the inherited namespaces
        if (inheritedInScopePrefixes.containsKey(getURIForPrefix(prefix))) {
            inheritedInScopePrefixes.remove(uri);
        }

        inheritedInScopeNamespaces.remove(prefix);

        inScopePrefixes.put(uri, prefix);
        inScopeNamespaces.put(prefix, uri);
    }

    @Override
    public String getInScopeNamespace(final String prefix) {
        return inScopeNamespaces == null ? null : inScopeNamespaces.get(prefix);
    }

    @Override
    public String getInScopePrefix(final String uri) {
        return inScopePrefixes == null ? null : inScopePrefixes.get(uri);
    }

    public Map<String, String> getInScopePrefixes() {
        return inScopePrefixes;
    }

    @Override
    public String getInheritedNamespace(final String prefix) {
        return inheritedInScopeNamespaces == null ? null : inheritedInScopeNamespaces.get(prefix);
    }

    @Override
    public String getInheritedPrefix(final String uri) {
        return inheritedInScopePrefixes == null ? null : inheritedInScopePrefixes.get(uri);
    }

    @Override
    public String getURIForPrefix(final String prefix) {
        // try in-scope namespace declarations
        String uri = (inScopeNamespaces == null) ? null : inScopeNamespaces.get(prefix);

        if (uri != null) {
            return uri;
        }

        if (inheritNamespaces) {
            uri = (inheritedInScopeNamespaces == null) ? null : inheritedInScopeNamespaces.get(prefix);

            if (uri != null) {
                return uri;
            }
        }
        return staticNamespaces.get(prefix);
    }

    @Override
    public String getPrefixForURI(final String uri) {
        String prefix = (inScopePrefixes == null) ? null : inScopePrefixes.get(uri);

        if (prefix != null) {
            return prefix;
        }

        if (inheritNamespaces) {
            prefix = (inheritedInScopePrefixes == null) ? null : inheritedInScopePrefixes.get(uri);

            if (prefix != null) {
                return prefix;
            }
        }
        return staticPrefixes.get(uri);
    }

    @Override
    public String getDefaultFunctionNamespace() {
        return defaultFunctionNamespace;
    }

    @Override
    public void setDefaultFunctionNamespace(final String uri) throws XPathException {
        //Not sure for the 2nd clause : eXist-db forces the function NS as default.
        if (defaultFunctionNamespace != null
                && !defaultFunctionNamespace.equals(Function.BUILTIN_FUNCTION_NS)
                && !defaultFunctionNamespace.equals(uri)) {
            throw new XPathException(rootExpression, ErrorCodes.XQST0066,
                    "Default function namespace is already set to: '" + defaultFunctionNamespace + "'");
        }
        defaultFunctionNamespace = uri;
    }

    @Override
    public String getDefaultElementNamespaceSchema() {
        return defaultElementNamespaceSchema.getStringValue();
    }

    @Override
    public void setDefaultElementNamespaceSchema(final String uri) throws XPathException {
        // eXist forces the empty element NS as default.
        if (!defaultElementNamespaceSchema.equals(AnyURIValue.EMPTY_URI)) {
            throw new XPathException(rootExpression, ErrorCodes.XQST0066, "Default function namespace schema is already set to: '" + defaultElementNamespaceSchema.getStringValue() + "'");
        }
        defaultElementNamespaceSchema = new AnyURIValue(uri);
    }

    @Override
    public String getDefaultElementNamespace() {
        return defaultElementNamespace.getStringValue();
    }

    @Override
    public void setDefaultElementNamespace(final String uri, @Nullable final String schema) throws XPathException {
        // eXist forces the empty element NS as default.
        if (!defaultElementNamespace.equals(AnyURIValue.EMPTY_URI)) {
            throw new XPathException(rootExpression, ErrorCodes.XQST0066,
                    "Default element namespace is already set to: '" + defaultElementNamespace.getStringValue() + "'");
        }
        defaultElementNamespace = new AnyURIValue(uri);

        if (schema != null) {
            defaultElementNamespaceSchema = new AnyURIValue(schema);
        }
    }

    @Override
    public void setDefaultCollation(final String uri) throws XPathException {
        if (uri.equals(Collations.UNICODE_CODEPOINT_COLLATION_URI) || uri.equals(Collations.CODEPOINT_SHORT)) {
            defaultCollation = Collations.UNICODE_CODEPOINT_COLLATION_URI;
            defaultCollator = null;
        }

        final URI uriTest;
        try {
            uriTest = new URI(uri);
        } catch (final URISyntaxException e) {
            throw new XPathException(rootExpression, ErrorCodes.XQST0038, "Unknown collation : '" + uri + "'");
        }

        if (uri.startsWith(Collations.EXIST_COLLATION_URI) || uri.charAt(0) == '?' || uriTest.isAbsolute()) {
            defaultCollator = Collations.getCollationFromURI(uri, rootExpression);
            defaultCollation = uri;
        } else {
            String absUri = getBaseURI().getStringValue() + uri;
            defaultCollator = Collations.getCollationFromURI(absUri, rootExpression);
            defaultCollation = absUri;
        }
    }

    @Override
    public String getDefaultCollation() {
        return defaultCollation;
    }

    @Override
    public Collator getCollator(String uri) throws XPathException {
        return getCollator(uri, ErrorCodes.XQST0076);
    }

    @Override
    public Collator getCollator(String uri, final ErrorCodes.ErrorCode errorCode) throws XPathException {
        if (uri == null) {
            return defaultCollator;
        }

        // if the uri is relative, resolve it against the base uri
        try {
            final URI u = new AnyURIValue(uri).toURI();
            if (!u.isAbsolute()) {
                final URI uu = getBaseURI().toURI().resolve(u);
                if (uu.isAbsolute()) {
                    uri = uu.toString();
                }
            }
        } catch (final XPathException e) {
            // no-op
        }

        return Collations.getCollationFromURI(uri, rootExpression, errorCode);
    }

    @Override
    public Collator getDefaultCollator() {
        return defaultCollator;
    }

    @Override
    public void setStaticallyKnownDocuments(final XmldbURI[] docs) {
        staticDocumentPaths = docs;
    }

    @Override
    public void setStaticallyKnownDocuments(final DocumentSet set) {
        staticDocuments = set;
    }

    public void addDynamicallyAvailableDocument(final String uri,
                                                final TriFunctionE<DBBroker, Txn, String, Either<org.exist.dom.memtree.DocumentImpl, DocumentImpl>, XPathException> supplier) {
        if (dynamicDocuments == null) {
            dynamicDocuments = new HashMap<>();
        }
        dynamicDocuments.put(uri, supplier);
    }

    public void addDynamicallyAvailableTextResource(final String uri, final Charset encoding,
                                                    final QuadFunctionE<DBBroker, Txn, String, Charset, Reader, XPathException> supplier) {
        if (dynamicTextResources == null) {
            dynamicTextResources = new HashMap<>();
        }
        dynamicTextResources.put(Tuple(uri, encoding), supplier);
    }

    public void addDynamicallyAvailableCollection(final String uri,
                                                  final TriFunctionE<DBBroker, Txn, String, Sequence, XPathException> supplier) {
        if (dynamicCollections == null) {
            dynamicCollections = new HashMap<>();
        }
        dynamicCollections.put(uri, supplier);
    }

    @Override
    public void setCalendar(final XMLGregorianCalendar newCalendar) {
        this.calendar = (XMLGregorianCalendar) newCalendar.clone();
    }

    @Override
    public void setTimeZone(final TimeZone newTimeZone) {
        this.implicitTimeZone = newTimeZone;
    }

    @Override
    public XMLGregorianCalendar getCalendar() {
        //TODO : we might prefer to return null
        if (calendar == null) {
            try {
                //Initialize to current dateTime
                calendar = DatatypeFactory.newInstance().newXMLGregorianCalendar(new GregorianCalendar());
            } catch (final DatatypeConfigurationException e) {
                LOG.error(e.getMessage(), e);
            }
        }

        //That's how we ensure stability of that static context function
        return calendar;
    }

    @Override
    public TimeZone getImplicitTimeZone() {
        if (implicitTimeZone == null) {
            implicitTimeZone = TimeZone.getDefault();

            if (implicitTimeZone.inDaylightTime(new Date())) {
                implicitTimeZone.setRawOffset(implicitTimeZone.getRawOffset() + implicitTimeZone.getDSTSavings());
            }
        }

        //That's how we ensure stability of that static context function
        return this.implicitTimeZone;
    }

    @Override
    public DocumentSet getStaticallyKnownDocuments() throws XPathException {
        if (staticDocuments != null) {

            // the document set has already been built, return it
            return staticDocuments;
        }

        if (protectedDocuments != null) {
            staticDocuments = protectedDocuments.toDocumentSet();
            return staticDocuments;
        }
        final MutableDocumentSet ndocs = new DefaultDocumentSet(40);

        if (staticDocumentPaths == null) {

            // no path defined: return all documents in the db
            try {
                getBroker().getAllXMLResources(ndocs);
            } catch (final PermissionDeniedException | LockException e) {
                LOG.warn(e);
                throw new XPathException(rootExpression, "Permission denied to read resource all resources: " + e.getMessage(), e);
            }
        } else {
            for (final XmldbURI staticDocumentPath : staticDocumentPaths) {

                try {
                    final Collection collection = getBroker().getCollection(staticDocumentPath);

                    if (collection != null) {
                        collection.allDocs(getBroker(), ndocs, true);
                    } else {
                        try (final LockedDocument lockedDocument = getBroker().getXMLResource(staticDocumentPath, LockMode.READ_LOCK)) {

                            final DocumentImpl doc = lockedDocument == null ? null : lockedDocument.getDocument();
                            if (doc != null) {

                                if (doc.getPermissions().validate(
                                        getBroker().getCurrentSubject(), Permission.READ)) {

                                    ndocs.add(doc);
                                }
                            }
                        }
                    }
                } catch (final PermissionDeniedException | LockException e) {
                    LOG.warn("Permission denied to read resource {}. Skipping it.", staticDocumentPath);
                }
            }
        }
        staticDocuments = ndocs;
        return staticDocuments;
    }

    public DocumentSet getStaticDocs() {
        return staticDocuments;
    }

    /**
     * Gets a document from the "Available documents" of the
     * dynamic context.
     *
     * @param uri the URI by which the document was registered
     * @return sequence of available documents matching the URI
     * @throws XPathException in case of dynamic error
     */
    public @Nullable Sequence getDynamicallyAvailableDocument(final String uri) throws XPathException {
        if (dynamicDocuments == null) {
            return null;
        }

        final TriFunctionE<DBBroker, Txn, String, Either<org.exist.dom.memtree.DocumentImpl, DocumentImpl>, XPathException> docSupplier
                = dynamicDocuments.get(uri);
        if (docSupplier == null) {
            return null;
        }

        return docSupplier.apply(getBroker(), getBroker().getCurrentTransaction(), uri).fold(md -> md, pd -> (Sequence) pd);
    }

    /**
     * Gets a text resource from the "Available text resources" of the
     * dynamic context.
     *
     * @param uri the URI by which the document was registered
     * @param charset the charset to use for retrieving the resource
     * @return a reader to read the resource content from
     * @throws XPathException in case of a dynamic error
     */
    public @Nullable Reader getDynamicallyAvailableTextResource(final String uri, final Charset charset)
            throws XPathException {
        if (dynamicTextResources == null) {
            return null;
        }

        final QuadFunctionE<DBBroker, Txn, String, Charset, Reader, XPathException> textResourceSupplier
                = dynamicTextResources.get(Tuple(uri, charset));
        if (textResourceSupplier == null) {
            return null;
        }

        return textResourceSupplier.apply(getBroker(), getBroker().getCurrentTransaction(), uri, charset);
    }

    /**
     * Gets a collection from the "Available collections" of the
     * dynamic context.
     *
     * @param uri the URI of the collection to retrieve
     * @return a sequence of document nodes
     * @throws XPathException in case of dynamic error
     */
    public @Nullable Sequence getDynamicallyAvailableCollection(final String uri) throws XPathException {
        if (dynamicCollections == null) {
            return null;
        }

        final TriFunctionE<DBBroker, Txn, String, Sequence, XPathException> collectionSupplier
                = dynamicCollections.get(uri);
        if (collectionSupplier == null) {
            return null;
        }

        return collectionSupplier.apply(getBroker(), getBroker().getCurrentTransaction(), uri);
    }

    @Override
    public ExtendedXMLStreamReader getXMLStreamReader(final NodeValue nv) throws XMLStreamException, IOException {
        final ExtendedXMLStreamReader reader;
        if (nv.getImplementationType() == NodeValue.IN_MEMORY_NODE) {
            final NodeImpl node = (NodeImpl) nv;
            final org.exist.dom.memtree.DocumentImpl ownerDoc = node.getNodeType() == Node.DOCUMENT_NODE ? (org.exist.dom.memtree.DocumentImpl) node : node.getOwnerDocument();
            reader = new InMemoryXMLStreamReader(ownerDoc, ownerDoc);
        } else {
            final NodeProxy proxy = (NodeProxy) nv;
            reader = getBroker().newXMLStreamReader(new NodeProxy(rootExpression, proxy.getOwnerDocument(), NodeId.DOCUMENT_NODE, proxy.getOwnerDocument().getFirstChildAddress()), false);
        }
        return reader;
    }

    @Override
    public void setProtectedDocs(final LockedDocumentMap map) {
        this.protectedDocuments = map;
    }

    @Override
    public LockedDocumentMap getProtectedDocs() {
        return this.protectedDocuments;
    }

    @Override
    public boolean inProtectedMode() {
        return protectedDocuments != null;
    }

    @Override
    public boolean lockDocumentsOnLoad() {
        return false;
    }

    @Override
    public void setShared(final boolean shared) {
        isShared = shared;
    }

    @Override
    public boolean isShared() {
        return isShared;
    }

    @Override
    public void addModifiedDoc(final DocumentImpl document) {
        if (modifiedDocuments == null) {
            modifiedDocuments = new DefaultDocumentSet();
        }
        modifiedDocuments.add(document);
    }

    @Override
    public void reset() {
        reset(false);
    }

    @Override
    public void reset(final boolean keepGlobals) {
        if (importedContexts != null) {
            for (final XQueryContext importedContext : importedContexts) {
                importedContext.reset(keepGlobals);
            }
            importedContexts = null;
        }

        setRealUser(null);

        if (this.pushedUserFromHttpSession) {
            try {
                getBroker().popSubject();
            } finally {
                this.pushedUserFromHttpSession = false;
            }
        }

        if (modifiedDocuments != null) {
            try {
                Modification.checkFragmentation(this, modifiedDocuments);
            } catch (final LockException | EXistException e) {
                LOG.warn("Error while checking modified documents: {}", e.getMessage(), e);
            }
            modifiedDocuments = null;
        }

        calendar = null;
        implicitTimeZone = null;

        resetDocumentBuilder();

        contextSequence = null;
        contextItem = Sequence.EMPTY_SEQUENCE;

        if (!keepGlobals) {
            // do not reset the statically known documents
            staticDocumentPaths = null;
            staticDocuments = null;
            dynamicDocuments = null;
            dynamicTextResources = null;
            dynamicCollections = null;
        }

        if (!isShared) {
            lastVar = null;
        }

        // clear inline functions using closures
        closures.forEach(func -> func.setClosureVariables(null));
        closures.clear();

        fragmentStack = new ArrayDeque<>();
        callStack.clear();
        protectedDocuments = null;

        cachedUriCollectionResults.clear();

        if (!keepGlobals) {
            globalVariables.clear();
        }

        if (dynamicOptions != null) {
            dynamicOptions.clear(); //clear any dynamic options
        }

        if (!isShared) {
            watchdog.reset();
        }

        /*
            NOTE: we use `modules` (and not `allModules`) here so as to only reset
            the modules of this module.
            The inner call to `module.reset` will be called on sub-modules
            which in-turn will reset their modules, and so on.
         */
        for (final Module[] modules : modules.values()) {
            for (final Module module : modules) {
                module.reset(this, keepGlobals);
            }
        }

        savedState.restore();

        attributes.clear();

        clearUpdateListeners();

        profiler.reset();

        if (!keepGlobals) {
            httpContext = null;
        }

        if (modulesDependencyGraphSPExecutor != null) {
            try {
                ConcurrencyUtil.shutdownExecutionService(modulesDependencyGraphSPExecutor);
            } catch (final InterruptedException e) {
                Thread.currentThread().interrupt();
            }
            modulesDependencyGraphSPExecutor = null;
        }

        analyzed = false;
    }

    @Override
    public boolean stripWhitespace() {
        return stripWhitespace;
    }

    @Override
    public void setStripWhitespace(final boolean strip) {
        this.stripWhitespace = strip;
    }

    @Override
    public boolean preserveNamespaces() {
        return preserveNamespaces;
    }

    @Override
    public void setPreserveNamespaces(final boolean preserve) {
        this.preserveNamespaces = preserve;
    }

    @Override
    public boolean inheritNamespaces() {
        return inheritNamespaces;
    }

    @Override
    public void setInheritNamespaces(final boolean inherit) {
        this.inheritNamespaces = inherit;
    }

    @Override
    public boolean orderEmptyGreatest() {
        return orderEmptyGreatest;
    }

    @Override
    public void setOrderEmptyGreatest(final boolean order) {
        this.orderEmptyGreatest = order;
    }

    @Override
    public Iterator<Module> getModules() {
        return new CollectionOfArrayIterator<>(modules.values());
    }

    @Override
    public Iterator<Module> getRootModules() {
        return getAllModules();
    }

    @Override
    public Iterator<Module> getAllModules() {
        return new CollectionOfArrayIterator<>(allModules.values());
    }

    @Override
    @Nullable
    public Module[] getModules(final String namespaceURI) {
        return modules.get(namespaceURI);
    }

    @Override
    public Module[] getRootModules(final String namespaceURI) {
        return allModules.get(namespaceURI);
    }

    @Override
    public void setModules(final String namespaceURI, @Nullable final Module[] modules) {
        if (modules == null) {
            this.modules.remove(namespaceURI); // unbind the module
        } else {
            this.modules.put(namespaceURI, modules);
        }
        setRootModules(namespaceURI, modules);
    }

    @Override
    public void addModule(final String namespaceURI, final Module module) {
        if (module == null) {
            throw new IllegalArgumentException();
        } else {
            this.modules.compute(namespaceURI, addToMapValueArray(module));
        }
        addRootModule(namespaceURI, module);
    }

    private Graph<ModuleVertex, DefaultEdge> getModulesDependencyGraph() {
        // NOTE(AR) intentionally lazily initialised!
        if (modulesDependencyGraph == null) {
            this.modulesDependencyGraph = new FastutilMapGraph<>(null, SupplierUtil.createDefaultEdgeSupplier(), DefaultGraphType.directedPseudograph().asUnweighted());
        }
        return modulesDependencyGraph;
    }

    /**
     * Add a vertex to the Modules Dependency Graph.
     *
     * @param moduleVertex the module vertex
     */
    protected void addModuleVertex(final ModuleVertex moduleVertex) {
        getModulesDependencyGraph().addVertex(moduleVertex);
    }

    /**
     * Check if a vertex exists in the Modules Dependency Graph.
     *
     * @param moduleVertex the module vertex to look for
     *
     * @return true if the module vertex exists, false otherwise
     */
    protected boolean hasModuleVertex(final ModuleVertex moduleVertex) {
        return getModulesDependencyGraph().containsVertex(moduleVertex);
    }

    /**
     * Add an edge between two Modules in the Dependency Graph.
     *
     * @param source the importing module
     * @param sink the imported module
     */
    protected void addModuleEdge(final ModuleVertex source, final ModuleVertex sink) {
        getModulesDependencyGraph().addEdge(source, sink);
    }

    /**
     * Look for a path between two Modules in the Dependency Graph.
     *
     * @param source the module to start searching from
     * @param sink the destination module to attempt to reach
     *
     * @return true, if there is a path between the mdoules, false otherwise
     */
    protected boolean hasModulePath(final ModuleVertex source, final ModuleVertex sink) {
        if (modulesDependencyGraph == null) {
            return false;
        }

        // NOTE(AR) intentionally lazily initialised!
        if (modulesDependencyGraphSPExecutor == null) {
            modulesDependencyGraphSPExecutor = ConcurrencyUtil.createThreadPoolExecutor(2);
        }

        final ShortestPathAlgorithm<ModuleVertex, DefaultEdge> spa = new TransitNodeRoutingShortestPath<>(getModulesDependencyGraph(), modulesDependencyGraphSPExecutor);
        return spa.getPath(source, sink) != null;
    }

    protected void setRootModules(final String namespaceURI, @Nullable final Module[] modules) {
        if (modules == null) {
            allModules.remove(namespaceURI); // unbind the module
            return;
        }

        if (allModules.get(namespaceURI) != modules) {
            setModulesChanged();
        }
        allModules.put(namespaceURI, modules);
    }

    protected void addRootModule(final String namespaceURI, final Module module) {
        if (module == null) {
            throw new IllegalArgumentException();
        } else {
            final Module[] current = this.allModules.get(namespaceURI);
            final Module[] updated = this.allModules.compute(namespaceURI, addToMapValueArray(module));
            if (current != updated) {
                setModulesChanged();  // NOTE: intentional object identity comparison
            }
        }
    }

    protected void setModulesChanged() {
        this.modulesChanged = true;
    }

    @Override
    public boolean checkModulesValid() {
        for (final Module[] modules : allModules.values()) {
            for (final Module module : modules) {
                if (!module.isInternalModule()) {
                    if (!((ExternalModule) module).moduleIsValid()) {
                        if (LOG.isDebugEnabled()) {
                            LOG.debug("Module with URI {} has changed and needs to be reloaded", module.getNamespaceURI());
                        }
                        return false;
                    }
                }
            }
        }
        return true;
    }

    @Override
    public void analyzeAndOptimizeIfModulesChanged(final Expression expr) throws XPathException {
        if (analyzed) {
            return;
        }
        analyzed = true;
        for (final Module[] modules : expr.getContext().modules.values()) {
            for (final Module module : modules) {
                if (!module.isInternalModule()) {
                    final Expression root = ((ExternalModule) module).getRootExpression();
                    ((ExternalModule) module).getContext().analyzeAndOptimizeIfModulesChanged(root);
                }
            }
        }
        expr.analyze(new AnalyzeContextInfo());

        if (optimizationsEnabled()) {
            final Optimizer optimizer = new Optimizer(this);
            expr.accept(optimizer);

            if (optimizer.hasOptimized()) {
                reset(true);
                expr.resetState(true);
                expr.analyze(new AnalyzeContextInfo());
            }
        }
        modulesChanged = false;
    }

    @Override
    public @Nullable Module loadBuiltInModule(final String namespaceURI, final String moduleClass) {
        Module[] modules = null;
        if (namespaceURI != null) {
            modules = getModules(namespaceURI);
        }

        if (modules != null) {
            for (final Module module : modules) {
                if (moduleClass.equals(module.getClass().getName())) {
                    if (LOG.isDebugEnabled()) {
                        LOG.debug("module {} is already present", namespaceURI);
                    }
                    return module;
                }
            }
        }

        return initBuiltInModule(namespaceURI, moduleClass);
    }

    @SuppressWarnings("unchecked")
    Module initBuiltInModule(final String namespaceURI, final String moduleClassName) {
        try {
            // lookup the class
                        final ClassLoader existClassLoader;
            if (getBroker() != null) {
                existClassLoader = getBroker().getBrokerPool().getClassLoader();
            } else {
                existClassLoader = Thread.currentThread().getContextClassLoader();
            }

            final Class<?> mClass = Class.forName(moduleClassName, false, existClassLoader);

            if (!(Module.class.isAssignableFrom(mClass))) {
                LOG.info("failed to load module. {} is not an instance of org.exist.xquery.Module.", moduleClassName);
                return null;
            }
            // INOTE: expathrepo
            final Module module = instantiateModule(namespaceURI, (Class<Module>) mClass,
                    getConfiguration() != null ? (Map<String, Map<String, List<? extends Object>>>) getConfiguration().getProperty(PROPERTY_MODULE_PARAMETERS) : Collections.emptyMap());

            if (LOG.isDebugEnabled()) {
                LOG.debug("module {} loaded successfully.", module.getNamespaceURI());
            }
            return module;
        } catch (final ClassNotFoundException e) {
            LOG.warn("module class {} not found. Skipping...", moduleClassName);
            return null;
        }
    }

    private @Nullable Module instantiateModule(final String namespaceURI, final Class<Module> moduleClass,
                                               final Map<String, Map<String, List<? extends Object>>> moduleParameters) {
        try {
            final Constructor<Module> constructor = XQueryContext.getModuleConstructor(moduleClass);

            if (constructor == null) {
                LOG.warn("Module {} has no matching public constructor!", moduleClass.getName());
                return null;
            }

            final Module module;
            if (constructor.getParameterCount() == 1) {
                module = constructor.newInstance(moduleParameters.get(namespaceURI));
            } else {
                // attempt for a constructor that takes 0 arguments
                module = constructor.newInstance();
            }

            if (namespaceURI != null && !module.getNamespaceURI().equals(namespaceURI)) {
                LOG.warn("the module declares a different namespace URI. Expected: {} found: {}", namespaceURI, module.getNamespaceURI());
                return null;
            }

            if (getPrefixForURI(module.getNamespaceURI()) == null && !module.getDefaultPrefix().isEmpty()) {
                declareNamespace(module.getDefaultPrefix(), module.getNamespaceURI());
            }

            modules.compute(module.getNamespaceURI(), addToMapValueArray(module));
            allModules.compute(module.getNamespaceURI(), addToMapValueArray(module));

            if (module instanceof InternalModule) {
                ((InternalModule) module).prepare(this);
            }
            return module;
        } catch (final InstantiationException | IllegalAccessException | InvocationTargetException | XPathException e) {
            LOG.warn("error while instantiating module class {}", moduleClass.getName(), e);
            return null;
        }
    }

    private static @Nullable Constructor<Module> getModuleConstructor(Class<Module> moduleClazz) {
        try {
            // prefer constructor that takes one Map argument
            return moduleClazz.getConstructor(Map.class);
        } catch (final NoSuchMethodException noPreferredConstructor) {
            // attempt for a constructor that takes 0 arguments
            try {
                return moduleClazz.getConstructor();
            } catch (final NoSuchMethodException noUsableConstructor) {
                return null;
            }
        }
    }

    private static BiFunction<String, Module[], Module[]> addToMapValueArray(final Module module) {
        return (namespaceURI, modules) -> {
            if (modules == null) {
                return new Module[]{ module };
            }

            // check if the module is already present
            for (final Module existingModule : modules) {
                if (existingModule == module) {  // NOTE: intentional object identity comparison
                    return modules;  // already present, no further action needed
                }
            }

            // add the module to the end of current array of modules
            final Module[] newModules = Arrays.copyOf(modules, modules.length + 1);
            newModules[newModules.length - 1] = module;
            return newModules;
        };
    }

    @Override
    public void declareFunction(final UserDefinedFunction function) throws XPathException {
        // TODO: redeclaring functions should be forbidden. however, throwing an
        // exception will currently break util:eval.

        final QName name = function.getSignature().getName();
        final String uri = name.getNamespaceURI();

        if (uri.isEmpty()) {
            throw new XPathException(function, ErrorCodes.XQST0060,
                    "Every declared function name must have a non-null namespace URI, " +
                            "but function '" + name + "' does not meet this requirement.");
        }

        if (Namespaces.PROTECTED_NS.contains(uri)) {
            throw new XPathException(function, ErrorCodes.XQST0045,
                    "Function '" + name + "' is in the forbidden namespace '" + uri + "'");
        }

        final FunctionSignature signature = function.getSignature();
        final FunctionId functionKey = signature.getFunctionId();
        if (declaredFunctions.containsKey(functionKey)) {
            throw new XPathException(function, ErrorCodes.XQST0034,
                    "Function " +  signature.getName().toURIQualifiedName() + '#' + signature.getArgumentCount()
                            + " is already defined.");
        }

        declaredFunctions.put(functionKey, function);
    }

    @Override
    public @Nullable UserDefinedFunction resolveFunction(final QName name, final int argCount) {
        final FunctionId id = new FunctionId(name, argCount);
        return declaredFunctions.get(id);
    }

    @Override
    public Iterator<FunctionSignature> getSignaturesForFunction(final QName name) {
        final List<FunctionSignature> signatures = new ArrayList<>(2);
        for (final UserDefinedFunction func : declaredFunctions.values()) {
            if (func.getName().equals(name)) {
                signatures.add(func.getSignature());
            }
        }
        return signatures.iterator();
    }

    @Override
    public Iterator<UserDefinedFunction> localFunctions() {
        return declaredFunctions.values().iterator();
    }

    @Override
    public LocalVariable declareVariableBinding(final LocalVariable var) throws XPathException {
        if (lastVar != null) {
            lastVar.addAfter(var);
        }
        lastVar = var;
        var.setStackPosition(getCurrentStackSize());
        return var;
    }

    @Override
    public Variable declareGlobalVariable(final Variable var) {
        globalVariables.put(var.getQName(), var);
        var.setStackPosition(getCurrentStackSize());
        return var;
    }

    @Override
    public void undeclareGlobalVariable(final QName name) {
        globalVariables.remove(name);
    }

    @Override
    public Variable declareVariable(final String qname, final Object value) throws XPathException {
        try {
            return declareVariable(QName.parse(this, qname, null), value);
        } catch (final QName.IllegalQNameException e) {
            throw new XPathException(rootExpression, ErrorCodes.XPST0081, "No namespace defined for prefix: " + qname);
        }
    }

    @Override
    public Variable declareVariable(final QName qn, final Object value) throws XPathException {
        @Nullable final Module[] modules = getModules(qn.getNamespaceURI());

        if (modules != null && modules.length > 0) {
            if (modules.length > 1) {
                // TODO(AR) is seems that we will never enter this state...
                throw new IllegalStateException("There is more than one module, but the variable can only be declared in one!");
            }

            return modules[0].declareVariable(qn, value);
        }

        final Sequence val = XPathUtil.javaObjectToXPath(value, this, rootExpression);

        final Variable var;
        if (globalVariables.containsKey(qn)) {
            var = globalVariables.get(qn);
        } else {
            var = new VariableImpl(qn);
            globalVariables.put(qn, var);
        }

        // deliberate duplication of code to return early
        if (var.getSequenceType() == null) {
            var.setValue(val);
            return var;
        }

        final Cardinality actualCardinality;

        if (val.isEmpty()) {
            actualCardinality = Cardinality.EMPTY_SEQUENCE;
        } else if (val.hasMany()) {
            actualCardinality = Cardinality._MANY;
        } else {
            actualCardinality = Cardinality.EXACTLY_ONE;
        }

        //Type.EMPTY is *not* a subtype of other types ; checking cardinality first
        if (!var.getSequenceType().getCardinality().isSuperCardinalityOrEqualOf(actualCardinality)) {
            throw new XPathException(rootExpression, ErrorCodes.XPTY0004,
                    "XPTY0004: Invalid cardinality for variable $" + var.getQName() + ". " +
                            "Expected " + var.getSequenceType().getCardinality().getHumanDescription() + ", " +
                            "got " + actualCardinality.getHumanDescription());
        }

        //TODO : ignore nodes right now ; they are returned as xs:untypedAtomicType
        if (!val.isEmpty() && !Type.subTypeOf(val.getItemType(), var.getSequenceType().getPrimaryType())) {
            throw new XPathException(rootExpression, ErrorCodes.XPTY0004,
                    "XPTY0004: Invalid type for variable $" + var.getQName() + ". " +
                            "Expected " + Type.getTypeName(var.getSequenceType().getPrimaryType()) + ", " +
                            "got " + Type.getTypeName(val.getItemType()));
        }

        //TODO : should we allow global variable *re*declaration ?
        var.setValue(val);
        return var;
    }

    @Override
    public Variable resolveVariable(final String name) throws XPathException {
        try {
            final QName qn = QName.parse(this, name, null);
            return resolveVariable(qn);
        } catch (final QName.IllegalQNameException e) {
            throw new XPathException(rootExpression, ErrorCodes.XPST0081, "No namespace defined for prefix " + name);
        }
    }

    @Override
    public Variable resolveVariable(final QName qname) throws XPathException {
        return resolveVariable(null, qname);
    }

    @Override
    public Variable resolveVariable(@Nullable final AnalyzeContextInfo contextInfo, final QName qname) throws XPathException {
        // check if the variable is declared local
        Variable var = resolveLocalVariable(qname);

        // check if the variable is declared in a module
        if (var == null) {
            final Module[] modules = getModules(qname.getNamespaceURI());

            if (modules != null) {
                for (final Module module : modules) {
                    var = module.resolveVariable(contextInfo, qname);
                    if (var != null) {
                        break;
                    }
                }
            }
        }

        // check if the variable is declared global
        if (var == null) {
            var = globalVariables.get(qname);
        }

        //if (var == null)
        //  throw new XPathException(rootExpression, "variable $" + qname + " is not bound");
        return var;
    }

    Variable resolveGlobalVariable(final QName qname) {
        return globalVariables.get(qname);
    }

    protected Variable resolveLocalVariable(final QName qname) throws XPathException {
        final LocalVariable end = contextStack.peek();
        for (LocalVariable var = lastVar; var != null; var = var.before) {
            if (var == end) {
                return null;
            }
            if (qname.equals(var.getQName())) {
                return var;
            }
        }
        return null;
    }

    @Override
    public boolean isVarDeclared(final QName qname) {
        final Module[] modules = getModules(qname.getNamespaceURI());
        if (modules != null) {
            for (final Module module : modules) {
                if (module.isVarDeclared(qname)) {
                    return true;
                }
            }
        }
        return globalVariables.containsKey(qname);
    }

    @Override
    public Map<QName, Variable> getVariables() {
        final Map<QName, Variable> variables = new Object2ObjectRBTreeMap<>(globalVariables);
        LocalVariable end = contextStack.peek();
        for (LocalVariable var = lastVar; var != null; var = var.before) {
            if (var == end) {
                break;
            }
            variables.put(var.getQName(), var);
        }
        return variables;
    }

    @Override
    public Map<QName, Variable> getLocalVariables() {
        final Map<QName, Variable> variables = new HashMap<>();
        LocalVariable end = contextStack.peek();
        for (LocalVariable var = lastVar; var != null; var = var.before) {
            if (var == end) {
                break;
            }
            variables.put(var.getQName(), var);
        }
        return variables;
    }

    /**
     * Return a copy of all currently visible local variables.
     * Used by {@link InlineFunction} to implement closures.
     *
     * @return currently visible local variables as a stack
     */
    public List<ClosureVariable> getLocalStack() {
        List<ClosureVariable> closure = null;
        final LocalVariable end = contextStack.peek();
        for (LocalVariable var = lastVar; var != null; var = var.before) {

            if (var == end) {
                break;
            }

            if (closure == null) {
                closure = new ArrayList<>(6);
            }
            closure.add(new ClosureVariable(var));
        }

        return closure;
    }

    @Override
    public Map<QName, Variable> getGlobalVariables() {
        return new Object2ObjectRBTreeMap<>(globalVariables);
    }

    /**
     * Restore a saved stack of local variables. Used to implement closures.
     *
     * @param stack the stack of local variables
     * @throws XPathException if the stack cannot be restored
     */
    public void restoreStack(final List<ClosureVariable> stack) throws XPathException {
        for (int i = stack.size() - 1; i > -1; i--) {
            declareVariableBinding(new ClosureVariable(stack.get(i)));
        }
    }

    @Override
    public void setBackwardsCompatibility(boolean backwardsCompatible) {
        this.backwardsCompatible = backwardsCompatible;
    }

    @Override
    public boolean isBackwardsCompatible() {
        return this.backwardsCompatible;
    }

    @Override
    public boolean isRaiseErrorOnFailedRetrieval() {
        return raiseErrorOnFailedRetrieval;
    }

    public Database getDatabase() {
        return db;
    }

    @Override
    public DBBroker getBroker() {
        if (db != null) {
            return db.getActiveBroker();
        }
        return null;
    }

    public Configuration getConfiguration() {
        return configuration;
    }

    @Override
    public Subject getSubject() {
        return getBroker().getCurrentSubject();
    }

    /**
     * If there is a HTTP Session, and a User has been stored in the session then this will return the user object from the session.
     *
     * @return The user or null if there is no session or no user
     */
    Subject getUserFromHttpSession() {
        final Optional<RequestWrapper> maybeRequest = Optional.ofNullable(getHttpContext())
                .map(HttpContext::getRequest);

        if (maybeRequest.isPresent()) {
            final RequestWrapper request = maybeRequest.get();
            final Object user = request.getAttribute(HTTP_REQ_ATTR_USER);
            final Object passAttr = request.getAttribute(HTTP_REQ_ATTR_PASS);
            if (user != null) {
                final String password = passAttr == null ? null : passAttr.toString();
                try {
                    return getBroker().getBrokerPool().getSecurityManager().authenticate(user.toString(), password);
                } catch (final AuthenticationException e) {
                    LOG.error("User can not be authenticated: {}", user.toString());
                }
            } else {
                final Optional<SessionWrapper> maybeSession = Optional.ofNullable(getHttpContext())
                        .map(HttpContext::getSession);
                if (maybeSession.isPresent()) {
                    try {
                        return (Subject) maybeSession.get().getAttribute(HTTP_SESSIONVAR_XMLDB_USER);
                    } catch (final IllegalStateException e) {
                        // this is thrown if HttpSession#getAttribute is called on an invalid session
                        return null;
                    }
                }
            }
        }

        return null;
    }

    /**
     * The builder used for creating in-memory document fragments.
     */
    private MemTreeBuilder documentBuilder = null;

    @Override
    public MemTreeBuilder getDocumentBuilder() {
        if (documentBuilder == null) {
            documentBuilder = new MemTreeBuilder(rootExpression, this);
            documentBuilder.startDocument();
        }
        return documentBuilder;
    }

    @Override
    public MemTreeBuilder getDocumentBuilder(final boolean explicitCreation) {
        if (documentBuilder == null) {
            documentBuilder = new MemTreeBuilder(rootExpression, this);
            documentBuilder.startDocument(explicitCreation);
        }
        return documentBuilder;
    }

    private void resetDocumentBuilder() {
        this.documentBuilder = null;
    }

    private void setDocumentBuilder(final MemTreeBuilder documentBuilder) {
        this.documentBuilder = documentBuilder;
    }

    @Override
    public NamePool getSharedNamePool() {
        if (sharedNamePool == null) {
            sharedNamePool = new NamePool();
        }
        return sharedNamePool;
    }

    @Override
    public XQueryContext getContext() {
        return null;
    }

    @Override
    public void prologEnter(final Expression expr) {
        if (debuggeeJoint != null) {
            debuggeeJoint.prologEnter(expr);
        }
    }

    @Override
    public void expressionStart(final Expression expr) throws TerminatedException {
        if (debuggeeJoint != null) {
            debuggeeJoint.expressionStart(expr);
        }
    }

    @Override
    public void expressionEnd(final Expression expr) {
        if (debuggeeJoint != null) {
            debuggeeJoint.expressionEnd(expr);
        }
    }

    @Override
    public void stackEnter(final Expression expr) throws TerminatedException {
        if (debuggeeJoint != null) {
            debuggeeJoint.stackEnter(expr);
        }
    }

    @Override
    public void stackLeave(final Expression expr) {
        if (debuggeeJoint != null) {
            debuggeeJoint.stackLeave(expr);
        }
    }

    @Override
    public void proceed() throws TerminatedException {
        getWatchDog().proceed(null);
    }

    @Override
    public void proceed(final Expression expr) throws TerminatedException {
        getWatchDog().proceed(expr);
    }

    @Override
    public void proceed(final Expression expr, final MemTreeBuilder builder) throws TerminatedException {
        getWatchDog().proceed(expr, builder);
    }

    @Override
    public void setWatchDog(final XQueryWatchDog watchdog) {
        this.watchdog = watchdog;
    }

    @Override
    public XQueryWatchDog getWatchDog() {
        return watchdog;
    }

    private static final MemTreeBuilder NULL_DOCUMENT_BUILDER = new MemTreeBuilder((Expression) null);

    @Override
    public void pushDocumentContext() {
        if (documentBuilder == null) {
            fragmentStack.push(NULL_DOCUMENT_BUILDER);
        } else {
            fragmentStack.push(documentBuilder);
            resetDocumentBuilder();
        }
    }

    @Override
    public void popDocumentContext() {
        if (!fragmentStack.isEmpty()) {
            final MemTreeBuilder prevBuilder = fragmentStack.pop();
            if (prevBuilder == NULL_DOCUMENT_BUILDER) {
                setDocumentBuilder(null);
            } else {
                setDocumentBuilder(prevBuilder);
            }
        }
    }

    @Override
    public void setBaseURI(final AnyURIValue uri) {
        setBaseURI(uri, false);
    }

    @Override
    public void setBaseURI(final AnyURIValue uri, final boolean setInProlog) {
        if (baseURISetInProlog) {
            return;
        }

        // TODO(JL): the previous code hinted that null _should_ be treated differently
        // baseURI = (uri == null) ? AnyURIValue.EMPTY_URI : uri;
        baseURI = uri;
        baseURISetInProlog = setInProlog;
    }

    @Override
    public void setModuleLoadPath(final String path) {
        this.moduleLoadPath = path;
    }

    @Override
    public String getModuleLoadPath() {
        return moduleLoadPath;
    }

    @Override
    public boolean isBaseURIDeclared() {
        return baseURI != null && !baseURI.equals(AnyURIValue.EMPTY_URI);
    }

    @Override
    public AnyURIValue getBaseURI() throws XPathException {
        // the base URI in the static context is established according to the
        // principles outlined in [RFC3986] Section 5.1—that is, it defaults
        // first to the base URI of the encapsulating entity, then to the URI
        // used to retrieve the entity, and finally to an implementation-defined
        // default. If the URILiteral in the base URI declaration is a relative
        // URI, then it is made absolute by resolving it with respect to this
        // same hierarchy.

        // It is not intrinsically an error if this process fails to establish
        // an absolute base URI; however, the base URI in the static context
        // is then undefined, and any attempt to use its value may result in
        // an error [err:XPST0001].
//        if ((baseURI == null) || baseURI.equals(AnyURIValue.EMPTY_URI)) {
//            //throw new XPathException(rootExpression, ErrorCodes.XPST0001, "Base URI of the static context  has not been assigned a value.");
//            // We catch and resolve this to the XmlDbURI.ROOT_COLLECTION_URI
//            // at least in DocumentImpl so maybe we should do it here./ljo
//        }
        return baseURI;
    }

    @Override
    public void setContextSequencePosition(final int pos, final Sequence sequence) {
        contextPosition = pos;
        contextSequence = sequence;
    }

    @Override
    public int getContextPosition() {
        return contextPosition;
    }

    @Override
    public Sequence getContextSequence() {
        return contextSequence;
    }

    @Override
    public void pushInScopeNamespaces() {
        pushInScopeNamespaces(true);
    }

    @Override
    public void pushInScopeNamespaces(final boolean inherit) {
        //TODO : push into an inheritedInScopeNamespaces HashMap... and return an empty HashMap
        namespaceStack.push(inheritedInScopeNamespaces);
        namespaceStack.push(inheritedInScopePrefixes);
        namespaceStack.push(inScopeNamespaces);
        namespaceStack.push(inScopePrefixes);

        //Current namespaces now become inherited just like the previous inherited ones
        if (inherit) {
            inheritedInScopeNamespaces = new HashMap<>(inheritedInScopeNamespaces);
            inheritedInScopeNamespaces.putAll(inScopeNamespaces);
            inheritedInScopePrefixes = new HashMap<>(inheritedInScopePrefixes);
            inheritedInScopePrefixes.putAll(inScopePrefixes);
        } else {
            inheritedInScopeNamespaces = new HashMap<>();
            inheritedInScopePrefixes = new HashMap<>();
        }

        //TODO : consider dynamic instanciation
        inScopeNamespaces = new HashMap<>();
        inScopePrefixes = new HashMap<>();
    }

    @Override
    public void popInScopeNamespaces() {
        inScopePrefixes = namespaceStack.pop();
        inScopeNamespaces = namespaceStack.pop();
        inheritedInScopePrefixes = namespaceStack.pop();
        inheritedInScopeNamespaces = namespaceStack.pop();
    }

    @Override
    public void pushNamespaceContext() {
        final Map<String, String> m = new HashMap<>(staticNamespaces);
        final Map<String, String> p = new HashMap<>(staticPrefixes);
        namespaceStack.push(staticNamespaces);
        namespaceStack.push(staticPrefixes);
        staticNamespaces = m;
        staticPrefixes = p;
    }

    @Override
    public void popNamespaceContext() {
        staticPrefixes = namespaceStack.pop();
        staticNamespaces = namespaceStack.pop();
    }

    @Override
    public LocalVariable markLocalVariables(final boolean newContext) {
        if (newContext) {
            if (lastVar == null) {
                lastVar = new LocalVariable(QName.EMPTY_QNAME);
            }
            contextStack.push(lastVar);
        }
        variableStackSize++;
        return lastVar;
    }

    @Override
    public void popLocalVariables(@Nullable final LocalVariable var) {
        popLocalVariables(var, null);
    }

    /**
     * Restore the local variable stack to the position marked by variable var.
     *
     * @param var       only clear variables after this variable, or null
     * @param resultSeq the result sequence
     */
    public void popLocalVariables(@Nullable final LocalVariable var, @Nullable final Sequence resultSeq) {
        if (var != null) {
            // clear all variables registered after var. they should be out of scope.
            LocalVariable outOfScope = var.after;
            while (outOfScope != null) {
                if (outOfScope != var && !outOfScope.isClosureVar()) {
                    outOfScope.destroy(this, resultSeq);
                }
                outOfScope = outOfScope.after;
            }
            // reset the stack
            var.after = null;

            if (!contextStack.isEmpty() && (var == contextStack.peek())) {
                contextStack.pop();
            }
        }
        lastVar = var;
        variableStackSize--;
    }

    /**
     * Register a inline function using closure variables so it can be cleared
     * after query execution.
     *
     * @param func an inline function definition using closure variables
     */
    void pushClosure(final UserDefinedFunction func) {
        closures.add(func);
    }

    @Override
    public int getCurrentStackSize() {
        return variableStackSize;
    }

    @Override
    public void functionStart(final FunctionSignature signature) {
        callStack.push(signature);
    }

    @Override
    public void functionEnd() {
        if (callStack.isEmpty()) {
            LOG.warn("Function call stack is empty, but XQueryContext.functionEnd() was called. This "
                    + "could indicate a concurrency issue (shared XQueryContext?)");
        } else {
            callStack.pop();
        }
    }

    @Override
    public boolean tailRecursiveCall(final FunctionSignature signature) {
        // NOTE(AR) this should be improved further... eXist-db lacked any sort of proper escape analysis!
        for (final FunctionSignature existingFunctionSignature : callStack) {
            if (existingFunctionSignature == signature) {
                return true;
            }
        }
        return false;
    }

    @Override
    public @Nullable Module[] importModule(@Nullable String namespaceURI, @Nullable String prefix, @Nullable AnyURIValue[] locationHints) throws XPathException {

        if (XML_NS_PREFIX.equals(prefix) || XMLNS_ATTRIBUTE.equals(prefix)) {
            throw new XPathException(rootExpression, ErrorCodes.XQST0070,
                    "The prefix declared for a module import must not be 'xml' or 'xmlns'.");
        }

        if (namespaceURI != null && namespaceURI.isEmpty()) {
            throw new XPathException(rootExpression, ErrorCodes.XQST0088,
                    "The first URILiteral in a module import must be of nonzero length.");
        }

        @Nullable Module[] modules = null;

        if (namespaceURI != null) {
            modules = getRootModules(namespaceURI);
        }

        if (modules != null && modules.length > 0) {
            if (LOG.isDebugEnabled()) {
                LOG.debug("Module {} already present.", namespaceURI);
            }
            // Set locally to remember the dependency in case it was inherited.
            setModules(namespaceURI, modules);

        } else {
            // if location is not specified, try to resolve in expath repo
            if ((locationHints == null || locationHints.length == 0) && namespaceURI != null) {
                final Module module = resolveInEXPathRepository(namespaceURI, prefix);
                if (module != null) {
                    modules = new Module[]{ module };
                }
            }

            if (modules == null || modules.length == 0) {

                if ((locationHints == null || locationHints.length == 0) && namespaceURI != null) {
                    // check if there's a static mapping in the configuration
                    final String moduleLocation = getModuleLocation(namespaceURI);
                    if (moduleLocation != null) {
                        locationHints = new AnyURIValue[]{ new AnyURIValue(moduleLocation) };
                    }

                    if (locationHints == null || locationHints.length == 0) {
                        locationHints = new AnyURIValue[] { new AnyURIValue(namespaceURI) };
                    }
                }

                for (int i = 0; i < locationHints.length; i++) {
                    final Module module = importModuleFromLocation(namespaceURI, prefix, locationHints[i]);
                    if (module != null) {
                        if (modules == null) {
                            modules = new Module[1];
                        } else if (i >= modules.length) {
                            modules = Arrays.copyOf(modules, modules.length + 1);
                        }
                        modules[modules.length - 1] = module;
                    }
                }

            } // NOTE: expathrepo related, closes the EXPath else (if module != null)
        }

        if (modules != null && modules.length > 0) {
            if (namespaceURI == null) {
                namespaceURI = modules[0].getNamespaceURI();
            }
            if (prefix == null) {
                prefix = modules[0].getDefaultPrefix();
            }
            declareNamespace(prefix, namespaceURI);
        }

        return modules;
    }

    protected @Nullable Module importModuleFromLocation(final String namespaceURI, @Nullable final String prefix, final AnyURIValue locationHint) throws XPathException {
        String location = locationHint.toString();

        // is it a Java module?
        if (location.startsWith(JAVA_URI_START)) {
            location = location.substring(JAVA_URI_START.length());
            return loadBuiltInModule(namespaceURI, location);
        }

        // Is the module source stored in the database?
        if (location.startsWith(XmldbURI.XMLDB_URI_PREFIX)
                || ((location.indexOf(':') == -1) && moduleLoadPath.startsWith(XmldbURI.XMLDB_URI_PREFIX))) {

            try {
                XmldbURI locationUri = XmldbURI.xmldbUriFor(location);

                if (moduleLoadPath.startsWith(XmldbURI.XMLDB_URI_PREFIX)) {
                    final XmldbURI moduleLoadPathUri = XmldbURI.xmldbUriFor(moduleLoadPath);
                    locationUri = moduleLoadPathUri.resolveCollectionPath(locationUri);
                }

                try (final LockedDocument lockedSourceDoc = getBroker().getXMLResource(locationUri.toCollectionPathURI(), LockMode.READ_LOCK)) {

                    final DocumentImpl sourceDoc = lockedSourceDoc == null ? null : lockedSourceDoc.getDocument();
                    if (sourceDoc == null) {
                        throw moduleLoadException("Module location hint URI '"
                                + location + "' does not refer to anything.", location);
                    }

                    if (sourceDoc.getResourceType() != DocumentImpl.BINARY_FILE
                            || !"application/xquery".equals(sourceDoc.getMimeType())) {
                        throw moduleLoadException("Module location hint URI '"
                                + location + "' does not refer to an XQuery.", location);
                    }

                    final Source moduleSource = new DBSource(getBroker().getBrokerPool(), (BinaryDocument) sourceDoc, true);
                    return compileOrBorrowModule(namespaceURI, prefix, location, moduleSource);

                } catch (final PermissionDeniedException e) {
                    throw moduleLoadException("Permission denied to read module source from location hint URI '" + location + ".", location, e);
                }
            } catch (final URISyntaxException e) {
                throw moduleLoadException("Invalid module location hint URI '" + location + "'.", location, e);
            }

        }

        // No. Load from file or URL
        final Source moduleSource;
        try {
            //TODO: use URIs to ensure proper resolution of relative locations
            final String contextPath;
            if (source instanceof FileSource) {
                final Path sourcePath = ((FileSource) source).getPath();
                contextPath = sourcePath.resolveSibling(moduleLoadPath).normalize().toString();
            } else {
                contextPath = moduleLoadPath;
            }

            moduleSource = SourceFactory.getSource(getBroker(), contextPath, location, true);
            if (moduleSource == null) {
                throw moduleLoadException("Source for module '" + namespaceURI + "' " +
                        "not found module location hint URI '" + location + "'.", location);
            }
        } catch (final MalformedURLException e) {
            throw moduleLoadException("Invalid module location hint URI '" + location + "'.", location, e);
        } catch (final IOException e) {
            throw moduleLoadException("Source for module '" + namespaceURI + "' could not be read, " +
                    "module location hint URI '" + location + "'.", location, e);
        } catch (final PermissionDeniedException e) {
            throw moduleLoadException("Permission denied to read module source from location hint URI '" + location + ".", location, e);
        }

        return compileOrBorrowModule(namespaceURI, prefix, location, moduleSource);
    }

    protected XPathException moduleLoadException(final String message, final String moduleLocation)
            throws XPathException {
        return new XPathException(rootExpression, ErrorCodes.XQST0059, message, new ValueSequence(new StringValue(moduleLocation)));
    }

    protected XPathException moduleLoadException(final String message, final String moduleLocation, final Exception e)
            throws XPathException {
        return new XPathException(rootExpression, ErrorCodes.XQST0059, message, new ValueSequence(new StringValue(moduleLocation)), e);
    }

    @SuppressWarnings("unchecked")
    @Override
    public String getModuleLocation(final String namespaceURI) {
        final Map<String, String> moduleMap =
                (Map<String, String>) getConfiguration().getProperty(PROPERTY_STATIC_MODULE_MAP);
        return moduleMap.get(namespaceURI);
    }

    @SuppressWarnings("unchecked")
    @Override
    public Iterator<String> getMappedModuleURIs() {
        final Map<String, String> moduleMap =
                (Map<String, String>) getConfiguration().getProperty(PROPERTY_STATIC_MODULE_MAP);
        return moduleMap.keySet().iterator();
    }

    /**
     * Compile of borrow an already compile module from the cache.
     *
     * @param namespaceURI the module namespace URI
     * @param prefix the module namespace prefix
     * @param location the location hint
     * @param source the source for the module
     *
     * @return the module or null
     *
     * @throws XPathException if the module could not be loaded (XQST0059) or compiled (XPST0003)
     */
    private ExternalModule compileOrBorrowModule(final String namespaceURI, final String prefix, final String location,
                                                 final Source source) throws XPathException {
        final ExternalModule module = compileModule(namespaceURI, prefix, location, source);
        if (module != null) {
            addModule(module.getNamespaceURI(), module);
            declareModuleVars(module);
        }
        return module;
    }

    /**
     * Compile an XQuery Module
     *
     * @param namespaceURI the namespace URI of the module.
     * @param prefix       the namespace prefix of the module.
     * @param location     the location of the module
     * @param source       the source of the module.
     * @return The compiled module, or null if the source is not a module
     * @throws XPathException if the module could not be loaded (XQST0059) or compiled (XPST0003)
     */
    private @Nullable ExternalModule compileModule(String namespaceURI, final String prefix, final String location,
                                                   final Source source) throws XPathException {
        if (LOG.isDebugEnabled()) {
            LOG.debug("Loading module from {}", location);
        }

        try (final Reader reader = source.getReader()) {
            if (reader == null) {
                throw moduleLoadException("failed to load module: '" + namespaceURI + "' from: " +
                        "'" + source + "', location: '" + location + "'. Source not found. ", location);
            }

            if (namespaceURI == null) {
                final QName qname = source.isModule();
                if (qname == null) {
                    return null;
                }
                namespaceURI = qname.getNamespaceURI();
            }

            final ExternalModuleImpl modExternal = new ExternalModuleImpl(namespaceURI, prefix);

            // NOTE(AR) this is needed to support cyclic imports in XQuery 3.1, see: https://github.com/eXist-db/exist/pull/4996
            addModule(namespaceURI, modExternal);
            addModuleVertex(new ModuleVertex(namespaceURI, location));

            final XQueryContext modContext = new ModuleContext(this, namespaceURI, prefix, location);
            modExternal.setContext(modContext);
            final XQueryLexer lexer = new XQueryLexer(modContext, reader);
            final XQueryParser parser = new XQueryParser(lexer);
            final XQueryTreeParser astParser = new XQueryTreeParser(modContext, modExternal);

            try {
                parser.xpath();

                if (parser.foundErrors()) {
                    if (LOG.isDebugEnabled()) {
                        LOG.debug(parser.getErrorMessage());
                    }
                    throw new XPathException(rootExpression, ErrorCodes.XPST0003, "error found while loading module from " + location + ": " + parser.getErrorMessage());
                }

                final AST ast = parser.getAST();

                final PathExpr path = new PathExpr(modContext);
                astParser.xpath(ast, path);

                if (astParser.foundErrors()) {
                    throw new XPathException(rootExpression, ErrorCodes.XPST0003, "error found while loading module from " + location + ": " + astParser.getErrorMessage(), astParser.getLastException());
                }

                modExternal.setRootExpression(path);

                if (namespaceURI != null && !modExternal.getNamespaceURI().equals(namespaceURI)) {
                    throw new XPathException(rootExpression, ErrorCodes.XQST0059, "namespace URI declared by module (" + modExternal.getNamespaceURI() + ") does not match namespace URI in import statement, which was: " + namespaceURI);
                }

                // Set source information on module context
//            String sourceClassName = source.getClass().getName();
//            modContext.setSourceKey(source.getKey().toString());
                // Extract the source type from the classname by removing the package prefix and the "Source" suffix
//            modContext.setSourceType( sourceClassName.substring( 17, sourceClassName.length() - 6 ) );

                modExternal.setSource(source);
                modContext.setSource(source);
                modExternal.setIsReady(true);
                return modExternal;
            } catch (final RecognitionException e) {
                throw new XPathException(e.getLine(), e.getColumn(), ErrorCodes.XPST0003, "error found while loading module from " + location + ": " + e.getMessage());
            } catch (final TokenStreamException e) {
                throw new XPathException(rootExpression, ErrorCodes.XPST0003, "error found while loading module from " + location + ": " + e.getMessage(), e);
            } catch (final XPathException e) {
                e.prependMessage("Error while loading module " + location + ": ");
                throw e;
            }
        } catch (final IOException e) {
            throw moduleLoadException("IO exception while loading module '" + namespaceURI + "'" + " from '" + source + "'", location, e);
        }
    }

    private void declareModuleVars(final Module module) {
        final String moduleNS = module.getNamespaceURI();

        for (final Iterator<Variable> i = globalVariables.values().iterator(); i.hasNext(); ) {
            final Variable var = i.next();

            if (moduleNS.equals(var.getQName().getNamespaceURI())) {
                module.declareVariable(var);
                i.remove();
            }
        }
    }

    @Override
    public void addForwardReference(final FunctionCall call) {
        forwardReferences.add(call);
    }

    @Override
    public void resolveForwardReferences() throws XPathException {
        while (!forwardReferences.isEmpty()) {
            final FunctionCall call = forwardReferences.pop();
            final UserDefinedFunction func = call.getContext().resolveFunction(call.getQName(), call.getArgumentCount());

            if (func == null) {
                throw new XPathException(call, ErrorCodes.XPST0017, "Call to undeclared function: " + call.getQName().getStringValue());
            }
            call.resolveForwardReference(func);
        }
    }

    /**
     * Get environment variables. The variables shall not change
     * during execution of query.
     *
     * @return Map of environment variables
     */
    public Map<String, String> getEnvironmentVariables() {
        if (envs == null) {
            envs = System.getenv();
        }
        return envs;
    }

    /**
     * Gets the Effective user
     * i.e. the user that the query is executing as
     *
     * @return The Effective User
     */
    public Subject getEffectiveUser() {
        return getBroker().getCurrentSubject();
    }

    /**
     * Gets the Real User
     * i.e. the user that initiated execution of the query
     * Note this is not necessarily the same as the user that the
     * query is executing as
     *
     * @return The Real User
     * @see org.exist.xquery.XQueryContext#getEffectiveUser()
     */
    public Subject getRealUser() {
        return realUser;
    }

    private void setRealUser(final Subject realUser) {
        this.realUser = realUser;
    }

    /**
     * Get a static decimal format.
     *
     * @param qnDecimalFormat the name of the decimal format, or null for the UNNAMED format.
     * @return the decimal format, or null if there is no format matching the name
     */
    public @Nullable DecimalFormat getStaticDecimalFormat(@Nullable final QName qnDecimalFormat) {
        final QName format = qnDecimalFormat == null ? UNNAMED_DECIMAL_FORMAT : qnDecimalFormat;
        return staticDecimalFormats.get(format);
    }

    /**
     * Set a static decimal format.
     *
     * @param qnDecimalFormat the name of the decimal format
     * @param decimalFormat the decimal format
     */
    public void setStaticDecimalFormat(final QName qnDecimalFormat, final DecimalFormat decimalFormat) {
        staticDecimalFormats.put(qnDecimalFormat, decimalFormat);
    }

    public Map<String, Sequence> getCachedUriCollectionResults() {
        return cachedUriCollectionResults;
    }

    /**
     * Add a reference to an additional XQuery Context that
     * was created by the XQuery (owning this XQuery Context)
     * dynamically importing, compiling, and/or evaluating modules.
     *
     * NOTE(AR) - This is needed to ensure that these "imported contexts" are
     * also correctly reset and cleaned up when this XQuery is finished.
     *
     * @param importedContext the dynamically created content for importing a module.
     */
    public void addImportedContext(final XQueryContext importedContext) {
        if (importedContexts == null) {
            importedContexts = new HashSet<>();
            importedContextsCleanupTasksFns = new ArrayList<>();
        }
        importedContexts.add(importedContext);
        importedContextsCleanupTasksFns.add(importedContext::runCleanupTasks);
    }

    /**
     * Save state
     */
    private class SavedState {
        private Object2ObjectOpenHashMap<String, Module[]> modulesSaved = null;
        private Object2ObjectOpenHashMap<String, Module[]> allModulesSaved = null;
        private Map<String, String> staticNamespacesSaved = null;
        private Map<String, String> staticPrefixesSaved = null;

        void save() {
            if (modulesSaved != null) {
                return;
            }

            modulesSaved = new Object2ObjectOpenHashMap<>(modules.size(), Hash.VERY_FAST_LOAD_FACTOR);
            for (final Object2ObjectMap.Entry<String, Module[]> entry : Object2ObjectMaps.fastIterable(modules)) {
                final Module[] mods = entry.getValue();
                modulesSaved.put(entry.getKey(), Arrays.copyOf(mods, mods.length));
            }

            allModulesSaved = new Object2ObjectOpenHashMap<>(allModules.size());
            for (final Object2ObjectMap.Entry<String, Module[]> entry : Object2ObjectMaps.fastIterable(allModules)) {
                final Module[] mods = entry.getValue();
                allModulesSaved.put(entry.getKey(), Arrays.copyOf(mods, mods.length));
            }

            staticNamespacesSaved = new HashMap<>(staticNamespaces);
            staticPrefixesSaved = new HashMap<>(staticPrefixes);
        }

        void restore() {
            if (modulesSaved == null) {
                return;
            }

            modules = modulesSaved;
            modulesSaved = null;
            allModules = allModulesSaved;
            allModulesSaved = null;
            staticNamespaces = staticNamespacesSaved;
            staticNamespacesSaved = null;
            staticPrefixes = staticPrefixesSaved;
            staticPrefixesSaved = null;
        }
    }

    /**
     * Before a dynamic import, make sure relevant parts of the current context a saved
     * to the stack. This is important for util:import-module. The context will be restored
     * during {@link #reset()}.
     */
    public void saveState() {
        savedState.save();
    }

    @Override
    public boolean optimizationsEnabled() {
        return enableOptimizer;
    }

    @Override
    public void addOption(final String name, final String value) throws XPathException {
        if (staticOptions == null) {
            staticOptions = new ArrayList<>();
        }
        addOption(staticOptions, name, value);
    }

    @Override
    public void addDynamicOption(final String name, final String value) throws XPathException {
        if (dynamicOptions == null) {
            dynamicOptions = new ArrayList<>();
        }
        addOption(dynamicOptions, name, value);
    }

    private void addOption(final List<Option> options, final String name, final String value) throws XPathException {
        final QName qn;
        try {
            qn = QName.parse(this, name, defaultFunctionNamespace);
        } catch (final QName.IllegalQNameException e) {
            throw new XPathException(rootExpression, ErrorCodes.XPST0081, "No namespace defined for prefix " + name);
        }

        final Option option = new Option(rootExpression, qn, value);
        // if the option exists, remove it first
        options.remove(option);
        //add option
        options.add(option);

        // check predefined options
        if (Option.PROFILE_QNAME.compareTo(qn) == 0) {
            // configure profiling
            profiler.configure(option);

        } else if (Option.TIMEOUT_QNAME.compareTo(qn) == 0) {
            watchdog.setTimeoutFromOption(option);

        } else if (Option.OUTPUT_SIZE_QNAME.compareTo(qn) == 0) {
            watchdog.setMaxNodesFromOption(option);

        } else if (Option.OPTIMIZE_QNAME.compareTo(qn) == 0) {
            final String[] params = option.tokenizeContents();
            if (params.length > 0) {
                final String[] param = Option.parseKeyValuePair(params[0]);
                if (param != null && "enable".equals(param[0])) {
                    enableOptimizer = "yes".equals(param[1]);
                }
            }
        }
        //TODO : not sure how these 2 options might/have to be related
        else if (Option.OPTIMIZE_IMPLICIT_TIMEZONE.compareTo(qn) == 0) {
            //TODO : error check
            final Duration duration = TimeUtils.getInstance().newDuration(option.getContents());
            implicitTimeZone = new SimpleTimeZone((int) duration.getTimeInMillis(new Date()), "XQuery context");

        } else if (Option.CURRENT_DATETIME.compareTo(qn) == 0) {
            //TODO : error check
            final DateTimeValue dtv = new DateTimeValue(option.getContents());
            calendar = (XMLGregorianCalendar) dtv.calendar.clone();
        }
    }

    @Override
    public Option getOption(final QName qname) {
        if (dynamicOptions != null) {
            for (final Option option : dynamicOptions) {
                if (qname.equals(option.getQName())) {
                    return option;
                }
            }
        }

        if (staticOptions != null) {
            for (final Option option : staticOptions) {
                if (qname.equals(option.getQName())) {
                    return option;
                }
            }
        }

        return null;
    }

    @Override
    public Pragma getPragma(final String name, final String contents) throws XPathException {
        final QName qname;
        try {
            qname = QName.parse(this, name);
        } catch (final QName.IllegalQNameException e) {
            throw new XPathException(rootExpression, ErrorCodes.XPST0081, "No namespace defined for prefix " + name);
        }

        final String ns = qname.getNamespaceURI();
        if (ns.isEmpty()) {
            throw new XPathException(rootExpression, ErrorCodes.XPST0081,
                    "The namespace URI for Pragma ('" + name + "') is empty");
        }

        if (!Namespaces.EXIST_NS.equals(ns)) {
            // TODO(JL): should we throw or a least warn here?
            return null;
        }

        final String sanitizedContents = StringValue.trimWhitespace(contents);

        return switch(qname.getLocalPart()) {
            case Optimize.OPTIMIZE_PRAGMA_LOCAL_NAME -> new Optimize(rootExpression, this, qname, sanitizedContents, true);
            case TimePragma.TIME_PRAGMA_LOCAL_NAME, TimePragma.DEPRECATED_TIMER_PRAGMA_LOCAL_NAME -> new TimePragma(rootExpression, qname, sanitizedContents);
            case ProfilePragma.PROFILING_PRAGMA_LOCAL_NAME -> new ProfilePragma(rootExpression, qname, sanitizedContents);
            case ForceIndexUse.FORCE_INDEX_USE_PRAGMA_LOCAL_NAME -> new ForceIndexUse(rootExpression, qname, sanitizedContents);
            case NoIndexPragma.NO_INDEX_PRAGMA_LOCAL_NAME -> new NoIndexPragma(rootExpression, qname, sanitizedContents);
            default -> null;
        };
    }

    @Override
    public DocumentImpl storeTemporaryDoc(final org.exist.dom.memtree.DocumentImpl doc) throws XPathException {
        try {
            final DocumentImpl targetDoc = getBroker().storeTempResource(doc);

            if (targetDoc == null) {
                throw new XPathException(rootExpression, "Internal error: failed to store temporary doc fragment");
            }
            LOG.warn("Stored: {}: {}", targetDoc.getDocId(), targetDoc.getURI(), new Throwable());
            return targetDoc;
        } catch (final EXistException | LockException | PermissionDeniedException e) {
            throw new XPathException(rootExpression, TEMP_STORE_ERROR, e);
        }
    }

    @Override
    public void setAttribute(final String attribute, final Object value) {
        attributes.put(attribute, value);
    }

    @Override
    public Object getAttribute(final String attribute) {
        return attributes.get(attribute);
    }

    /**
     * Load the default prefix/namespace mappings table and set up internal functions.
     *
     * @param config the configuration if available
     */
    @SuppressWarnings("unchecked")
    void loadDefaults(@Nullable final Configuration config) {
        loadDefaultNS();

        if (config == null) {
            return;
        }

        // Switch: enable optimizer
        final String queryRewritingOption = config.getProperty(PROPERTY_ENABLE_QUERY_REWRITING, "no");
        this.enableOptimizer = "yes".equals(queryRewritingOption);

        // Switch: Backward compatibility
        final String backwardsCompatOption = config.getProperty(PROPERTY_XQUERY_BACKWARD_COMPATIBLE, "yes");
        this.backwardsCompatible = "yes".equals(backwardsCompatOption);

        // Switch: raiseErrorOnFailedRetrieval
        this.raiseErrorOnFailedRetrieval =
                config.getProperty(PROPERTY_XQUERY_RAISE_ERROR_ON_FAILED_RETRIEVAL, Boolean.FALSE);

        // Get map of built-in modules
        final Map<String, Class<Module>> builtInModules =
                (Map<String, Class<Module>>) config.getProperty(PROPERTY_BUILT_IN_MODULES);

        if (builtInModules == null) {
            return;
        }

        // Iterate on all map entries
        for (final Map.Entry<String, Class<Module>> entry : builtInModules.entrySet()) {
            addBuiltInModuleOrDeclareNamespace(config, entry);
        }
    }

    @SuppressWarnings("unchecked")
    private void addBuiltInModuleOrDeclareNamespace(final Configuration config, final Map.Entry<String, Class<Module>> entry) {
        final String namespaceURI = entry.getKey();
        // first check if the module has already been loaded in the parent context
        final Module[] modules = getModules(namespaceURI);

        // we have to instantiate the module class
        final Class<Module> moduleClass = entry.getValue();
        Module foundModule = null;
        if (modules != null) {
            for (final Module module : modules) {
                if (moduleClass.equals(module.getClass())) {
                    foundModule = module;
                    break;
                }
            }
        }

        if (foundModule == null) {
            // Module does not exist yet, instantiate
            instantiateModule(namespaceURI, moduleClass,
                    (Map<String, Map<String, List<? extends Object>>>) config.getProperty(PROPERTY_MODULE_PARAMETERS));
            return;
        }

        if (getPrefixForURI(namespaceURI) == null && !foundModule.getDefaultPrefix().isEmpty()) {
            // make sure the namespaces of default modules are known,
            // even if they were imported in a parent context
            try {
                declareNamespace(foundModule.getDefaultPrefix(), foundModule.getNamespaceURI());

            } catch (final XPathException e) {
                LOG.warn("Internal error while loading default modules: {}", e.getMessage(), e);
            }
        }
    }

    /**
     * Load default namespaces, e.g. xml, xsi, xdt, fn, local, exist and dbgp.
     */
    private void loadDefaultNS() {
        try {
            // default namespaces
            staticNamespaces.put(XML_NS_PREFIX, XML_NS);
            staticPrefixes.put(XML_NS, XML_NS_PREFIX);
            declareNamespace("xs", Namespaces.SCHEMA_NS);
            declareNamespace("xsi", Namespaces.SCHEMA_INSTANCE_NS);

            //required for backward compatibility
            declareNamespace("xdt", Namespaces.XPATH_DATATYPES_NS);
            declareNamespace("fn", Namespaces.XPATH_FUNCTIONS_NS);
            declareNamespace("local", Namespaces.XQUERY_LOCAL_NS);
            declareNamespace(Namespaces.W3C_XQUERY_XPATH_ERROR_PREFIX, Namespaces.W3C_XQUERY_XPATH_ERROR_NS);

            //*not* as standard NS
            declareNamespace(Namespaces.EXIST_NS_PREFIX, Namespaces.EXIST_NS);
            declareNamespace(Namespaces.EXIST_JAVA_BINDING_NS_PREFIX, Namespaces.EXIST_JAVA_BINDING_NS);
            declareNamespace(Namespaces.EXIST_XQUERY_XPATH_ERROR_PREFIX, Namespaces.EXIST_XQUERY_XPATH_ERROR_NS);

            //TODO : include "err" namespace ?
            declareNamespace("dbgp", Debuggee.NAMESPACE_URI);

        } catch (final XPathException e) {
            //ignored because it should never happen
            if (LOG.isDebugEnabled()) {
                LOG.debug(e);
            }
        }
    }

    @Override
    public void registerUpdateListener(final UpdateListener listener) {
        if (updateListener == null) {
            updateListener = new ContextUpdateListener();
            final DBBroker broker = getBroker();
            broker.getBrokerPool().getNotificationService().subscribe(updateListener);
        }
        updateListener.addListener(listener);
    }

    protected void clearUpdateListeners() {
        if (updateListener != null) {
            final DBBroker broker = getBroker();
            broker.getBrokerPool().getNotificationService().unsubscribe(updateListener);
            updateListener = null;
        }
    }

    @Override
    public void checkOptions(final Properties properties) throws XPathException {
        checkLegacyOptions(properties);
        if (dynamicOptions != null) {
            for (final Option option : dynamicOptions) {
                if (Namespaces.XSLT_XQUERY_SERIALIZATION_NS.equals(option.getQName().getNamespaceURI())) {
                    SerializerUtils.setProperty(option.getQName().getLocalPart(), option.getContents(), properties,
                            inScopeNamespaces::get);
                }
            }
        }

        if (staticOptions != null) {
            for (final Option option : staticOptions) {
                if (Namespaces.XSLT_XQUERY_SERIALIZATION_NS.equals(option.getQName().getNamespaceURI())
                        && !properties.containsKey(option.getQName().getLocalPart())) {
                    SerializerUtils.setProperty(option.getQName().getLocalPart(), option.getContents(), properties,
                            inScopeNamespaces::get);
                }
            }
        }
    }

    /**
     * Legacy method to check serialization properties set via option exist:serialize.
     *
     * @param properties the serialization properties
     * @throws XPathException if there is an unknown serialization property
     */
    private void checkLegacyOptions(final Properties properties) throws XPathException {
        final Option pragma = getOption(Option.SERIALIZE_QNAME);
        if (pragma == null) {
            return;
        }

        final String[] contents = pragma.tokenizeContents();

        for (final String content : contents) {
            final String[] pair = Option.parseKeyValuePair(content);

            if (pair == null) {
                throw new XPathException(rootExpression, "Unknown parameter found in " + pragma.getQName().getStringValue()
                        + ": '" + content + "'");
            }

            if (LOG.isDebugEnabled()) {
                LOG.debug("Setting serialization property from pragma: {} = {}", pair[0], pair[1]);
            }

            properties.setProperty(pair[0], pair[1]);
        }
    }

    @Override
    public void setDebuggeeJoint(final DebuggeeJoint joint) {
        //XXX: if (debuggeeJoint != null) ???
        debuggeeJoint = joint;
    }

    @Override
    public DebuggeeJoint getDebuggeeJoint() {
        return debuggeeJoint;
    }

    @Override
    public boolean isDebugMode() {
        return debuggeeJoint != null && isVarDeclared(Debuggee.SESSION);
    }

    @Override
    public boolean requireDebugMode() {
        return isVarDeclared(Debuggee.SESSION);
    }

    private Deque<BinaryValue> binaryValueInstances;

    void enterEnclosedExpr() {
        if (binaryValueInstances == null) {
            return;
        }
        final Iterator<BinaryValue> it = binaryValueInstances.descendingIterator();
        while (it.hasNext()) {
            it.next().incrementSharedReferences();
        }
    }

    void exitEnclosedExpr() {
        if (binaryValueInstances == null) {
            return;
        }
        final Iterator<BinaryValue> it = binaryValueInstances.iterator();
        final List<BinaryValue> destroyable = new ArrayList<>();
        while (it.hasNext()) {
            try {
                final BinaryValue bv = it.next();
                bv.close(); // really just decrements a reference
                if (bv.isClosed()) {
                    destroyable.add(bv);
                }
            } catch (final IOException e) {
                LOG.warn("Unable to close binary reference on exiting enclosed expression: {}", e.getMessage(), e);
            }
        }

        // eagerly cleanup those BinaryValues that are not used outside the EnclosedExpr (to release memory)
        for (final BinaryValue bvd : destroyable) {
            binaryValueInstances.remove(bvd);
        }
    }

    @Override
    public void registerBinaryValueInstance(final BinaryValue binaryValue) {
        if (binaryValueInstances == null) {
            binaryValueInstances = new ArrayDeque<>();
        }

        if (cleanupTasks.isEmpty() || cleanupTasks.stream().noneMatch(ct -> ct instanceof BinaryValueCleanupTask)) {
            cleanupTasks.add(new BinaryValueCleanupTask());
        }

        binaryValueInstances.push(binaryValue);
    }

    /**
     * Cleanup Task which is responsible for relasing the streams
     * of any {@link BinaryValue} which have been used during
     * query execution
     */
    public static class BinaryValueCleanupTask implements CleanupTask {
        @Override
        public void cleanup(final XQueryContext context, final Predicate<Object> predicate) {
            if (context.binaryValueInstances == null) {
                return;
            }
            final List<BinaryValue> removable = new ArrayList<>();
            for (final BinaryValue bv : context.binaryValueInstances) {
                try {
                    if (predicate.test(bv)) {
                        bv.close();
                        removable.add(bv);
                    }
                } catch (final IOException e) {
                    LOG.error("Unable to close binary value: {}", e.getMessage(), e);
                }
            }

            for (final BinaryValue bv : removable) {
                context.binaryValueInstances.remove(bv);
            }
        }
    }

    @Override
    public String getCacheClass() {
        return (String) getConfiguration().getProperty(Configuration.BINARY_CACHE_CLASS_PROPERTY);
    }

    public void destroyBinaryValue(final BinaryValue value) {
        if (binaryValueInstances != null) {
            binaryValueInstances.remove(value);
        }
    }

    public void setXQueryVersion(int version) {
        xqueryVersion = version;
    }

    public int getXQueryVersion() {
        return xqueryVersion;
    }

    @Override
    public Source getSource() {
        return source;
    }

    @Override
    public void setSource(final Source source) {
        this.source = source;
    }

    @Override
    public String getDefaultLanguage() {
        return DefaultLanguage;
    }

    /**
     * NOTE: the {@link #unsubscribe()} method can be called
     * from {@link org.exist.storage.NotificationService#unsubscribe(UpdateListener)}
     * by another thread, so this class needs to be thread-safe.
     */
    @ThreadSafe
    private static class ContextUpdateListener implements UpdateListener {
        /*
         * We use Concurrent safe data structures here, so that we don't have
         * to block any calling threads.
         *
         * The AtomicReference enables us to quickly clear the listeners
         * in #unsubscribe() and maintain happens-before integrity whilst
         * unsubscribing them. The CopyOnWriteArrayList allows
         * us to add listeners whilst iterating over a snapshot
         * of existing iterators in other methods.
         */
        private final AtomicReference<List<UpdateListener>> listeners = new AtomicReference<>(new CopyOnWriteArrayList<>());

        private void addListener(final UpdateListener listener) {
            listeners.get().add(listener);
        }

        @Override
        public void documentUpdated(final DocumentImpl document, final int event) {
            listeners.get().forEach(listener -> listener.documentUpdated(document, event));
        }

        @Override
        public void unsubscribe() {
            List<UpdateListener> prev = listeners.get();
            final List<UpdateListener> next = new CopyOnWriteArrayList<>();
            while (!listeners.compareAndSet(prev, next)) {
                prev = listeners.get();
            }

            prev.forEach(UpdateListener::unsubscribe);
        }

        @Override
        public void nodeMoved(final NodeId oldNodeId, final NodeHandle newNode) {
            listeners.get().forEach(listener -> listener.nodeMoved(oldNodeId, newNode));
        }

        @Override
        public void debug() {
            if (LOG.isDebugEnabled()) {
                LOG.debug("XQueryContext: {} document update listeners", listeners.get().size());
            }

            listeners.get().forEach(UpdateListener::debug);
        }
    }

    private final List<CleanupTask> cleanupTasks = new ArrayList<>();

    public void registerCleanupTask(final CleanupTask cleanupTask) {
        cleanupTasks.add(cleanupTask);
    }

    public interface CleanupTask {
        void cleanup(final XQueryContext context, final Predicate<Object> predicate);
    }

    @Override
    public void runCleanupTasks(final Predicate<Object> predicate) {
        if (importedContextsCleanupTasksFns != null) {
            for (final Consumer<Predicate<Object>> importedContextsCleanupTasksFn : importedContextsCleanupTasksFns) {
                importedContextsCleanupTasksFn.accept(predicate);
            }
            importedContextsCleanupTasksFns = null;
        }

        for (final CleanupTask cleanupTask : cleanupTasks) {
            try {
                cleanupTask.cleanup(this, predicate);
            } catch (final Throwable t) {
                LOG.error("Cleaning up XQueryContext: Ignoring: {}", t.getMessage(), t);
            }
        }
        // now it is safe to clear the cleanup tasks list as we know they have run
        // do not move this anywhere else
        cleanupTasks.clear();
    }

    @Immutable
    public static class HttpContext {
        private final RequestWrapper request;
        private final ResponseWrapper response;
        private final SessionWrapper session;

        public HttpContext(final RequestWrapper request, final ResponseWrapper response, final SessionWrapper session) {
            this.request = request;
            this.response = response;
            this.session = session;
        }

        public HttpContext(final RequestWrapper request, final ResponseWrapper response) {
            this.request = request;
            this.response = response;
            this.session = request.getSession(false);
        }

        public RequestWrapper getRequest() {
            return request;
        }

        public ResponseWrapper getResponse() {
            return response;
        }

        public SessionWrapper getSession() {
            return session;
        }

        /**
         * Returns a new HttpContext with the new session set.
         * <p>
         * The request and response are referenced from this object.
         *
         * @param newSession the new session to set.
         * @return the new HttpContext.
         */
        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: {");
        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: {");
        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: {");
        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: {");
        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();
    }

    @Immutable
    public static class ModuleVertex {
        private final String namespaceURI;
        private final String location;

        public ModuleVertex(final String namespaceURI) {
            this.namespaceURI = namespaceURI;
            this.location = null;
        }

        public ModuleVertex(final String namespaceURI, final String location) {
            this.namespaceURI = namespaceURI;
            this.location = location;
        }

        @Override
        public boolean equals(final Object o) {
            if (this == o) {
                return true;
            }

            if (o == null || getClass() != o.getClass()) {
                return false;
            }

            final ModuleVertex that = (ModuleVertex) o;
            if (!namespaceURI.equals(that.namespaceURI)) {
                return false;
            }
            return location.equals(that.location);
        }

        @Override
        public int hashCode() {
            int result = namespaceURI.hashCode();
            result = 31 * result + location.hashCode();
            return result;
        }

        @Override
        public String toString() {
            return "Module{" +
                    "namespaceURI='" + namespaceURI + '\'' +
                    "location='" + location + '\'' +
                    '}';
        }
    }
}

evolvedbinary / elemental / 982

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous