[feature] Change XPathException construct calls so that they do not pass null expressions, and re-add expressionless constructors (so as not to break existing code that expects expressionless constructors)

Author: chris-evolvedbinary

exist-core/src/main/antlr/org/exist/xquery/parser/DeclScanner.g

@@ -22,7 +22,6 @@
 header {
 	package org.exist.xquery.parser;
 
-	import org.exist.xquery.Expression;
 	import org.exist.xquery.XPathException;
 }
 

exist-core/src/main/java/org/exist/Indexer.java

@@ -49,6 +49,7 @@
 import org.exist.util.XMLString;
 import org.exist.util.pool.NodePool;
 import org.exist.xquery.Constants;
+import org.exist.xquery.Expression;
 import org.exist.xquery.value.StringValue;
 import org.w3c.dom.DOMException;
 import org.w3c.dom.Element;
@@ -136,7 +137,7 @@ private enum ProcessTextParent { COMMENT, PI, CDATA_START, ELEMENT_START, ELEMEN
     private int nodeFactoryInstanceCnt = 0;
 
     // reusable fields
-    private final TextImpl text = new TextImpl();
+    private final TextImpl text = new TextImpl((Expression) null);
     private final Deque<ElementImpl> usedElements = new ArrayDeque<>();
 
     // when storing the document data, validation will be switched off, so
@@ -255,7 +256,7 @@ public void comment(final char[] ch, final int start, final int length) {
         if (insideDTD) {
             return;
         }
-        final CommentImpl comment = new CommentImpl(ch, start, length);
+        final CommentImpl comment = new CommentImpl(null, ch, start, length);
         comment.setOwnerDocument(document);
         if (stack.isEmpty()) {
             comment.setNodeId(broker.getBrokerPool().getNodeFactory()
@@ -280,7 +281,7 @@ public void endCDATA() {
         if (!stack.isEmpty()) {
             final ElementImpl last = stack.peek();
             if (charBuf != null && charBuf.length() > 0) {
-                final CDATASectionImpl cdata = new CDATASectionImpl(charBuf);
+                final CDATASectionImpl cdata = new CDATASectionImpl((last != null) ? last.getExpression() : null, charBuf);
                 cdata.setOwnerDocument(document);
                 last.appendChildInternal(prevNode, cdata);
                 if (!validate) {
@@ -479,7 +480,7 @@ public void ignorableWhitespace(final char[] ch, final int start, final int leng
 
     @Override
     public void processingInstruction(final String target, final String data) {
-        final ProcessingInstructionImpl pi = new ProcessingInstructionImpl(target, data);
+        final ProcessingInstructionImpl pi = new ProcessingInstructionImpl((Expression) null, target, data);
         pi.setOwnerDocument(document);
         if (stack.isEmpty()) {
             pi.setNodeId(broker.getBrokerPool().getNodeFactory().createInstance(nodeFactoryInstanceCnt++));
@@ -515,7 +516,7 @@ public void startCDATA() {
 
     @Override
     public void startDTD(final String name, final String publicId, final String systemId) {
-        final DocumentTypeImpl docType = new DocumentTypeImpl(name, publicId, systemId);
+        final DocumentTypeImpl docType = new DocumentTypeImpl(null, name, publicId, systemId);
         document.setDocumentType(docType);
         insideDTD = true;
     }
@@ -577,7 +578,7 @@ public void startElement(final String namespace, final String name, final String
                     node = usedElements.pop();
                     node.setNodeName(qn, broker.getBrokerPool().getSymbols());
                 } else {
-                    node = new ElementImpl(qn, broker.getBrokerPool().getSymbols());
+                    node = new ElementImpl((last != null) ? last.getExpression() : null, qn, broker.getBrokerPool().getSymbols());
                 }
             } catch (final DOMException e) {
                 throw new SAXException(e.getMessage(), e);
@@ -605,7 +606,7 @@ public void startElement(final String namespace, final String name, final String
             }
         } else {
             try {
-                node = new ElementImpl(qn, broker.getBrokerPool().getSymbols());
+                node = new ElementImpl(null, qn, broker.getBrokerPool().getSymbols());
             } catch (final DOMException e) {
                 throw new SAXException(e.getMessage(), e);
             }

exist-core/src/main/java/org/exist/backup/restore/AbstractRestoreHandler.java

@@ -369,7 +369,7 @@ private DeferredPermission restoreResourceEntry(final Attributes attributes) thr
 
         final DocumentType docType;
         if (publicId != null || systemId != null) {
-            docType = new DocumentTypeImpl(nameDocType, publicId, systemId);
+            docType = new DocumentTypeImpl(null, nameDocType, publicId, systemId);
         } else {
             docType = null;
         }

exist-core/src/main/java/org/exist/backup/xquery/ListBackups.java

@@ -63,7 +63,7 @@ public ListBackups(final XQueryContext context )
     public Sequence eval(final Sequence[] args, final Sequence contextSequence ) throws XPathException
     {
         if(!context.getEffectiveUser().hasDbaRole()) {
-            throw new XPathException("You must be a DBA to list available backups");
+            throw new XPathException(this, "You must be a DBA to list available backups");
         }
 
         final String exportDir = args[0].getStringValue();

exist-core/src/main/java/org/exist/backup/xquery/RetrieveBackup.java

@@ -56,7 +56,7 @@ public RetrieveBackup(final XQueryContext context )
     public Sequence eval(final Sequence[] args, final Sequence contextSequence ) throws XPathException
     {
         if(!context.getEffectiveUser().hasDbaRole()) {
-            throw new XPathException("You must be a DBA to retrieve a backup");
+            throw new XPathException(this, "You must be a DBA to retrieve a backup");
         }
 
         final String exportDir = args[0].getStringValue();
@@ -73,7 +73,7 @@ public Sequence eval(final Sequence[] args, final Sequence contextSequence ) thr
         }
 
         if( !name.endsWith( ".zip" ) ) {
-            throw( new XPathException( this, "for security reasons, the function only allows " + "reading zipped backup archives" ) );
+            throw( new XPathException(this, "for security reasons, the function only allows " + "reading zipped backup archives" ) );
         }
 
         try {

exist-core/src/main/java/org/exist/collections/CollectionConfigurationManager.java

@@ -41,6 +41,7 @@
 import org.exist.util.XMLReaderPool;
 import org.exist.util.sanity.SanityCheck;
 import org.exist.xmldb.XmldbURI;
+import org.exist.xquery.Expression;
 import org.w3c.dom.Document;
 import org.xml.sax.InputSource;
 import org.xml.sax.XMLReader;
@@ -152,7 +153,7 @@ public void addConfiguration(final Txn txn, final DBBroker broker, final Collect
      */
     public void testConfiguration(DBBroker broker, String config) throws CollectionConfigurationException {
         try {
-            final SAXAdapter adapter = new SAXAdapter();
+            final SAXAdapter adapter = new SAXAdapter((Expression) null);
             final InputSource src = new InputSource(new StringReader(config));
             final XMLReaderPool parserPool = broker.getBrokerPool().getParserPool();
             XMLReader reader = null;

exist-core/src/main/java/org/exist/collections/MutableCollection.java

@@ -1543,7 +1543,7 @@ private IndexInfo validateXMLResourceInternal(final Txn transaction, final DBBro
 
                 // NOTE: the new `document` object actually gets discarded in favour of the `oldDoc` below if there is an oldDoc and it is XML (so we can use -1 as the docId because it will never be used)
                 final int docId = (oldDoc != null && oldDoc.getResourceType() == DocumentImpl.XML_FILE) ? - 1 : broker.getNextResourceId(transaction);
-                DocumentImpl document = new DocumentImpl((BrokerPool) db, this, docId, name);
+                DocumentImpl document = new DocumentImpl(null, (BrokerPool) db, this, docId, name);
 
                 checkCollectionConflict(name);
                 manageDocumentInformation(oldDoc, document);
@@ -1772,9 +1772,9 @@ public BinaryDocument addBinaryResource(final Txn transaction, final DBBroker br
             final int docId = broker.getNextResourceId(transaction);
             final BinaryDocument blob;
             if (oldDoc != null) {
-                blob = new BinaryDocument(docId, oldDoc);
+                blob = new BinaryDocument(null, docId, oldDoc);
             } else {
-                blob = new BinaryDocument(broker.getBrokerPool(), this, docId, name);
+                blob = new BinaryDocument(null, broker.getBrokerPool(), this, docId, name);
             }
 
             return addBinaryResource(db, transaction, broker, blob, is, mimeType, size, created, modified, permission,
@@ -1787,7 +1787,7 @@ public BinaryDocument addBinaryResource(final Txn transaction, final DBBroker br
     public BinaryDocument validateBinaryResource(final Txn transaction, final DBBroker broker, final XmldbURI name) throws PermissionDeniedException, LockException, TriggerException, IOException {
         try {
             final int docId = broker.getNextResourceId(transaction);
-            return new BinaryDocument(broker.getBrokerPool(), this, docId, name);
+            return new BinaryDocument(null, broker.getBrokerPool(), this, docId, name);
         } catch (final EXistException e) {
             throw new IOException(e.getMessage(), e);
         }

exist-core/src/main/java/org/exist/config/Configurator.java

@@ -75,6 +75,7 @@
 import org.exist.util.serializer.SAXSerializer;
 import org.exist.xmldb.FullXmldbURI;
 import org.exist.xmldb.XmldbURI;
+import org.exist.xquery.Expression;
 import org.w3c.dom.Element;
 import org.xml.sax.InputSource;
 import org.xml.sax.SAXException;
@@ -755,7 +756,7 @@ public static Configuration parse(final InputStream is) throws ConfigurationExce
             reader.setFeature("http://xml.org/sax/features/external-parameter-entities", false);
             reader.setFeature(FEATURE_SECURE_PROCESSING, true);
 
-            final SAXAdapter adapter = new SAXAdapter();
+            final SAXAdapter adapter = new SAXAdapter((Expression) null);
             reader.setContentHandler(adapter);
             reader.setProperty(Namespaces.SAX_LEXICAL_HANDLER, adapter);
             reader.parse(src);

exist-core/src/main/java/org/exist/dom/INode.java

@@ -21,6 +21,8 @@
  */
 package org.exist.dom;
 
+import org.exist.xquery.Expression;
+
 /**
  * Interface for Nodes in eXist
  * used for both persistent and
@@ -48,4 +50,11 @@ public interface INode<D extends org.w3c.dom.Document, T extends INode> extends
 
     //TODO try and get rid of this after decoupling nameTyping from QName class (AR)?
     void setQName(QName qname);
+
+    /**
+     * Get the expression from which this node derives.
+     *
+     * @return The expression from which this node derives
+     */
+    Expression getExpression();
 }

exist-core/src/main/java/org/exist/dom/memtree/AbstractCharacterData.java

@@ -21,6 +21,7 @@
  */
 package org.exist.dom.memtree;
 
+import org.exist.xquery.Expression;
 import org.exist.xquery.NodeTest;
 import org.exist.xquery.XPathException;
 import org.exist.xquery.value.Sequence;
@@ -32,7 +33,11 @@
 public abstract class AbstractCharacterData extends NodeImpl implements CharacterData {
 
     public AbstractCharacterData(final DocumentImpl doc, final int nodeNumber) {
-        super(doc, nodeNumber);
+        this(null, doc, nodeNumber);
+    }
+
+    public AbstractCharacterData(final Expression expression, final DocumentImpl doc, final int nodeNumber) {
+        super(expression, doc, nodeNumber);
     }
 
     @Override