Close only streams created by IText in PdfReader constructor

Add tests

DEVSIX-5705

Author: Egor Martsynkovsky

kernel/src/main/java/com/itextpdf/kernel/pdf/PdfReader.java

@@ -130,8 +130,12 @@ public class PdfReader implements Closeable, Serializable {
      * @throws IOException if an I/O error occurs
      */
     public PdfReader(IRandomAccessSource byteSource, ReaderProperties properties) throws IOException {
+        this(byteSource, properties, false);
+    }
+
+    PdfReader(IRandomAccessSource byteSource, ReaderProperties properties, boolean closeStream) throws IOException {
         this.properties = properties;
-        this.tokens = getOffsetTokeniser(byteSource);
+        this.tokens = getOffsetTokeniser(byteSource, closeStream);
     }
 
     /**
@@ -143,7 +147,7 @@ public PdfReader(IRandomAccessSource byteSource, ReaderProperties properties) th
      * @throws IOException on error
      */
     public PdfReader(InputStream is, ReaderProperties properties) throws IOException {
-        this(new RandomAccessSourceFactory().createSource(is), properties);
+        this(new RandomAccessSourceFactory().createSource(is), properties, true);
     }
 
     /**
@@ -180,7 +184,8 @@ public PdfReader(String filename, ReaderProperties properties) throws IOExceptio
                 new RandomAccessSourceFactory()
                         .setForceRead(false)
                         .createBestSource(filename),
-                properties
+                properties,
+                true
         );
         this.sourcePath = filename;
     }
@@ -1303,6 +1308,10 @@ private void readDecryptObj() {
         }
     }
 
+    private static PdfTokenizer getOffsetTokeniser(IRandomAccessSource byteSource) throws IOException {
+        return getOffsetTokeniser(byteSource, true);
+    }
+
     /**
      * Utility method that checks the provided byte source to see if it has junk bytes at the beginning.  If junk bytes
      * are found, construct a tokeniser that ignores the junk.  Otherwise, construct a tokeniser for the byte source as it is
@@ -1311,7 +1320,8 @@ private void readDecryptObj() {
      * @return a tokeniser that is guaranteed to start at the PDF header
      * @throws IOException if there is a problem reading the byte source
      */
-    private static PdfTokenizer getOffsetTokeniser(IRandomAccessSource byteSource) throws IOException {
+    private static PdfTokenizer getOffsetTokeniser(IRandomAccessSource byteSource, boolean closeStream)
+            throws IOException {
         com.itextpdf.io.IOException possibleException = null;
         PdfTokenizer tok = new PdfTokenizer(new RandomAccessFileOrArray(byteSource));
         int offset;
@@ -1321,7 +1331,7 @@ private static PdfTokenizer getOffsetTokeniser(IRandomAccessSource byteSource) t
             possibleException = ex;
             throw possibleException;
         } finally {
-            if (possibleException != null) {
+            if (possibleException != null && closeStream) {
                 tok.close();
             }
         }

kernel/src/test/java/com/itextpdf/kernel/pdf/PdfReaderTest.java

@@ -45,6 +45,8 @@ This file is part of the iText (R) project.
 import com.itextpdf.io.LogMessageConstant;
 import com.itextpdf.io.source.ByteArrayOutputStream;
 import com.itextpdf.io.source.ByteUtils;
+import com.itextpdf.io.source.IRandomAccessSource;
+import com.itextpdf.io.source.RandomAccessSourceFactory;
 import com.itextpdf.io.util.FileUtil;
 import com.itextpdf.io.util.MessageFormatUtil;
 import com.itextpdf.kernel.PdfException;
@@ -53,6 +55,11 @@ This file is part of the iText (R) project.
 import com.itextpdf.test.annotations.LogMessage;
 import com.itextpdf.test.annotations.LogMessages;
 import com.itextpdf.test.annotations.type.IntegrationTest;
+
+import java.io.FileInputStream;
+import java.io.InputStream;
+import java.nio.file.Files;
+import java.nio.file.Paths;
 import org.junit.Assert;
 import org.junit.BeforeClass;
 import org.junit.Ignore;
@@ -2012,6 +2019,38 @@ public void pdf11VersionValidTest() throws IOException {
         new PdfDocument(new PdfReader(fileName));
     }
 
+    @Test
+    public void closeStreamCreatedByITextTest() throws IOException {
+        String fileName = sourceFolder + "emptyPdf.pdf";
+        String copiedFileName = destinationFolder + "emptyPdf.pdf";
+        //Later in the test we will need to delete a file. Since we do not want to delete it from sources, we will
+        // copy it to destination folder.
+        File copiedFile = copyFileForTest(fileName, copiedFileName);
+        Exception e = Assert.assertThrows(com.itextpdf.io.IOException.class, () -> new PdfReader(fileName));
+        Assert.assertEquals(com.itextpdf.io.IOException.PdfHeaderNotFound, e.getMessage());
+        //This check is meaningfull only on Windows, since on other OS the fact of a stream being open doesn't
+        // prevent the stream from being deleted.
+        Assert.assertTrue(FileUtil.deleteFile(copiedFile));
+    }
+
+    @Test
+    public void notCloseUserStreamTest() throws IOException {
+        String fileName = sourceFolder + "emptyPdf.pdf";
+        try (InputStream pdfStream = new FileInputStream(fileName)) {
+                IRandomAccessSource randomAccessSource = new RandomAccessSourceFactory()
+                        .createSource(pdfStream);
+                Exception e = Assert.assertThrows(com.itextpdf.io.IOException.class,
+                        () -> new PdfReader(randomAccessSource, new ReaderProperties()));
+            //An exception would be thrown, if stream is closed.
+            Assert.assertEquals(-1, pdfStream.read());
+        }
+    }
+    private File copyFileForTest(String fileName, String copiedFileName) throws IOException {
+        File copiedFile = new File(copiedFileName);
+        Files.copy(Paths.get(fileName), Paths.get(copiedFileName));
+        return copiedFile;
+    }
+
     private PdfReader pdfDocumentNotReadTestInit() throws IOException {
         String filename = sourceFolder + "XrefWithNullOffsets.pdf";