changeset 52944:cb009cf888c6

8213734: SAXParser.parse(File, ..) does not close resources when Exception occurs. Reviewed-by: lancea
author joehw
date Fri, 30 Nov 2018 12:41:00 -0800
parents 447236ceaf28
children 241b8151b6b6
files src/java.xml/share/classes/com/sun/org/apache/xerces/internal/impl/XMLEntityManager.java test/jaxp/javax/xml/jaxp/unittest/sax/SAXParserTest.java
diffstat 2 files changed, 107 insertions(+), 8 deletions(-) [+]
line wrap: on
line diff
--- a/src/java.xml/share/classes/com/sun/org/apache/xerces/internal/impl/XMLEntityManager.java	Fri Nov 30 12:24:23 2018 -0800
+++ b/src/java.xml/share/classes/com/sun/org/apache/xerces/internal/impl/XMLEntityManager.java	Fri Nov 30 12:41:00 2018 -0800
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009, 2017, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2009, 2018, Oracle and/or its affiliates. All rights reserved.
  */
 /*
  * Licensed to the Apache Software Foundation (ASF) under one or more
@@ -89,7 +89,7 @@
  * @author K.Venugopal SUN Microsystems
  * @author Neeraj Bajaj SUN Microsystems
  * @author Sunitha Reddy SUN Microsystems
- * @LastModified: Oct 2017
+ * @LastModified: Nov 2018
  */
 public class XMLEntityManager implements XMLComponent, XMLEntityResolver {
 
@@ -855,7 +855,7 @@
 
         // We've seen a new Reader.
         // Push it on the stack so we can close it later.
-        //fOwnReaders.add(reader);
+        fReaderStack.push(reader);
 
         // push entity on stack
         if (fCurrentEntity != null) {
@@ -1444,16 +1444,21 @@
             (fEntityStack.empty() ? null : fEntityStack.get(0));
     }
 
+    // A stack containing all the open readers
+    protected Stack<Reader> fReaderStack = new Stack<>();
 
     /**
      * Close all opened InputStreams and Readers opened by this parser.
      */
     public void closeReaders() {
-        /** this call actually does nothing, readers are closed in the endEntity method
-         * through the current entity.
-         * The change seems to have happened during the jdk6 development with the
-         * addition of StAX
-        **/
+        // close all readers
+        while (!fReaderStack.isEmpty()) {
+            try {
+                (fReaderStack.pop()).close();
+            } catch (IOException e) {
+                // ignore
+            }
+        }
     }
 
     public void endEntity() throws IOException, XNIException {
@@ -1487,6 +1492,13 @@
             }
         }
 
+        // REVISIT: We should never encounter underflow if the calls
+        // to startEntity and endEntity are balanced, but guard
+        // against the EmptyStackException for now. -- mrglavas
+        if (!fReaderStack.isEmpty()) {
+            fReaderStack.pop();
+        }
+
         if (fEntityHandler != null) {
             //so this is the last opened entity, signal it to current fEntityHandler using Augmentation
             if(entity == null){
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/test/jaxp/javax/xml/jaxp/unittest/sax/SAXParserTest.java	Fri Nov 30 12:41:00 2018 -0800
@@ -0,0 +1,87 @@
+/*
+ * Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code 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 General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+package sax;
+
+import static jaxp.library.JAXPTestUtilities.getSystemProperty;
+import java.io.IOException;
+import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import javax.xml.parsers.SAXParser;
+import javax.xml.parsers.SAXParserFactory;
+import org.testng.annotations.Listeners;
+import org.testng.annotations.Test;
+import org.xml.sax.Attributes;
+import org.xml.sax.SAXException;
+import org.xml.sax.helpers.DefaultHandler;
+
+/*
+ * @test
+ * @bug 8213734
+ * @library /javax/xml/jaxp/libs /javax/xml/jaxp/unittest
+ * @run testng sax.SAXParserTest
+ * @summary Tests functionalities for SAXParser.
+ */
+@Listeners({ jaxp.library.BasePolicy.class })
+public class SAXParserTest {
+
+    /*
+     * @bug 8213734
+     * Verifies that files opened by the SAXParser is closed when Exception
+     * occurs.
+     */
+    @Test
+    public void testCloseReaders() throws Exception {
+        if (!getSystemProperty("os.name").contains("Windows")) {
+            System.out.println("This test only needs to be run on Windows.");
+            return;
+        }
+        Path testFile = createTestFile(null, "Test");
+        System.out.println("Test file: " + testFile.toString());
+        SAXParserFactory factory = SAXParserFactory.newDefaultInstance();
+        SAXParser parser = factory.newSAXParser();
+        try {
+            parser.parse(testFile.toFile(), new DefaultHandler() {
+                @Override
+                public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException {
+                    throw new SAXException("Stop the parser.");
+                }
+            });
+        } catch (SAXException e) {
+            // Do nothing
+        }
+
+        // deletion failes on Windows when the file is not closed
+        Files.deleteIfExists(testFile);
+    }
+
+    private static Path createTestFile(Path dir, String name) throws IOException {
+        Path path = Files.createTempFile(name, ".xml");
+            byte[] bytes = "<?xml version=\"1.0\"?><test a1=\"x\" a2=\"y\"/>"
+        .getBytes(StandardCharsets.UTF_8);
+
+        Files.write(path, bytes);
+        return path;
+    }
+}