Preserve input PDF version on pages/split-pages (fixes qpdf#610)

ntheaker · Feb 8, 2022 · f91b21c · f91b21c
1 parent cfd5147
commit f91b21c
Show file tree

Hide file tree

Showing 71 changed files with 52 additions and 19 deletions.
diff --git a/ChangeLog b/ChangeLog
@@ -1,11 +1,22 @@
 2022-02-08  Jay Berkenbilt  <[email protected]>
 
+	* Bug fix: when splitting pages with --split-pages or selecting
+	pages with --pages, set the output PDF version to the maximum of
+	all the input PDF versions. This is a fix to QPDFJob. If you are
+	creating output PDF files yourself from multiple inputs, you will
+	need to code the same thing. The new PDFVersion object, its
+	updateIfGreater() method, and the new QPDF and QPDFWriter methods
+	described below make this very easy to do. Fixes #610.
+
 	* Add new class PDFVersion for more convenient comparison of PDF
 	version numbers from the %!PDF header.
 
 	* Add QPDF::getVersionAsPDFVersion() to return the PDF version and
 	extension together as a PDFVersion object instead of a string.
 
+	* Add a QPDFWriter::setMinimumPDFVersion() that takes a PDFVersion
+	object.
+
 2022-02-06  Jay Berkenbilt  <[email protected]>
 
 	* Pl_Buffer and QPDFWriter: add getBufferSharedPointer(), which

diff --git a/TODO b/TODO
@@ -1,8 +1,3 @@
-10.6
-====
-
-* https://github.com/qpdf/qpdf/issues/610
-
 Next
 ====
 

diff --git a/include/qpdf/QPDFJob.hh b/include/qpdf/QPDFJob.hh
@@ -26,6 +26,7 @@
 #include <qpdf/Constants.h>
 #include <qpdf/QPDF.hh>
 #include <qpdf/QPDFPageObjectHelper.hh>
+#include <qpdf/PDFVersion.hh>
 
 #include <memory>
 #include <string>
@@ -587,6 +588,7 @@ class QPDFJob
         int flatten_annotations_required;
         int flatten_annotations_forbidden;
         bool generate_appearances;
+        PDFVersion max_input_version;
         std::string min_version;
         std::string force_version;
         bool show_npages;

diff --git a/include/qpdf/QPDFWriter.hh b/include/qpdf/QPDFWriter.hh
@@ -42,11 +42,11 @@
 #include <qpdf/QPDFObjectHandle.hh>
 #include <qpdf/QPDFObjGen.hh>
 #include <qpdf/QPDFXRefEntry.hh>
-
 #include <qpdf/Pl_Buffer.hh>
 #include <qpdf/PointerHolder.hh>
 #include <qpdf/Pipeline.hh>
 #include <qpdf/Buffer.hh>
+#include <qpdf/PDFVersion.hh>
 
 class QPDF;
 class Pl_Count;
@@ -265,6 +265,8 @@ class QPDFWriter
     // streams are used.
     QPDF_DLL
     void setMinimumPDFVersion(std::string const&, int extension_level = 0);
+    QPDF_DLL
+    void setMinimumPDFVersion(PDFVersion const&);
 
     // Force the PDF version of the output file to be a given version.
     // Use of this function may create PDF files that will not work

diff --git a/libqpdf/QPDFJob.cc b/libqpdf/QPDFJob.cc
@@ -2047,6 +2047,7 @@ QPDFJob::doProcessOnce(
     {
         fn(pdf.get(), password);
     }
+    this->m->max_input_version.updateIfGreater(pdf->getVersionAsPDFVersion());
     return pdf;
 }
 
@@ -3472,6 +3473,7 @@ QPDFJob::setWriterOptions(QPDF& pdf, QPDFWriter& w)
     {
         w.setObjectStreamMode(m->object_stream_mode);
     }
+    w.setMinimumPDFVersion(this->m->max_input_version);
     if (! m->min_version.empty())
     {
         std::string version;

diff --git a/libqpdf/QPDFWriter.cc b/libqpdf/QPDFWriter.cc
@@ -296,6 +296,15 @@ QPDFWriter::setMinimumPDFVersion(std::string const& version,
     }
 }
 
+void
+QPDFWriter::setMinimumPDFVersion(PDFVersion const& v)
+{
+    std::string version;
+    int extension_level;
+    v.getVersion(version, extension_level);
+    setMinimumPDFVersion(version, extension_level);
+}
+
 void
 QPDFWriter::forcePDFVersion(std::string const& version,
                             int extension_level)

diff --git a/manual/release-notes.rst b/manual/release-notes.rst
@@ -148,6 +148,14 @@ For a detailed list of changes, please see the file
       embedded NUL characters. Thanks to M. Holger for the
       contribution.
 
+    - New ``PDFVersion`` class for representing a PDF version number
+      with the ability to compare and order PDF versions. Methods
+      ``QPDF::getVersionAsPDFVersion`` and a new version of
+      ``QPDFWriter::setMinimumPDFVersion`` use it. This makes it
+      easier to create an output file whose PDF version is the maximum
+      of the versions across all the input files that contributed to
+      it.
+
     - The ``JSON`` object in the qpdf library has been enhanced to
       include a parser and the ability to get values out of the
       ``JSON`` object. Previously it was a write-only interface. Even
@@ -181,6 +189,10 @@ For a detailed list of changes, please see the file
     - Some characters were not correctly translated from PDF doc
       encoding to Unicode.
 
+    - When splitting or combining pages, ensure that all output files
+      have a PDF version greater than or equal to the maximum version
+      of all the input files.
+
 10.5.0: December 21, 2021
   - Packaging changes
 

diff --git a/qpdf/qtest/qpdf/01_split-exp.zdf b/qpdf/qtest/qpdf/01_split-exp.zdf
diff --git a/qpdf/qtest/qpdf/02_split-exp.zdf b/qpdf/qtest/qpdf/02_split-exp.zdf
diff --git a/qpdf/qtest/qpdf/03_split-exp.zdf b/qpdf/qtest/qpdf/03_split-exp.zdf
diff --git a/qpdf/qtest/qpdf/04_split-exp.zdf b/qpdf/qtest/qpdf/04_split-exp.zdf
diff --git a/qpdf/qtest/qpdf/05_split-exp.zdf b/qpdf/qtest/qpdf/05_split-exp.zdf
diff --git a/qpdf/qtest/qpdf/06_split-exp.zdf b/qpdf/qtest/qpdf/06_split-exp.zdf
diff --git a/qpdf/qtest/qpdf/07_split-exp.zdf b/qpdf/qtest/qpdf/07_split-exp.zdf
diff --git a/qpdf/qtest/qpdf/08_split-exp.zdf b/qpdf/qtest/qpdf/08_split-exp.zdf
diff --git a/qpdf/qtest/qpdf/09_split-exp.zdf b/qpdf/qtest/qpdf/09_split-exp.zdf
diff --git a/qpdf/qtest/qpdf/10_split-exp.zdf b/qpdf/qtest/qpdf/10_split-exp.zdf
diff --git a/qpdf/qtest/qpdf/11_split-exp.zdf b/qpdf/qtest/qpdf/11_split-exp.zdf
diff --git a/qpdf/qtest/qpdf/direct-dr-out.pdf b/qpdf/qtest/qpdf/direct-dr-out.pdf
diff --git a/qpdf/qtest/qpdf/dr-with-indirect-item-out.pdf b/qpdf/qtest/qpdf/dr-with-indirect-item-out.pdf
diff --git a/qpdf/qtest/qpdf/fields-pages-out.pdf b/qpdf/qtest/qpdf/fields-pages-out.pdf
diff --git a/qpdf/qtest/qpdf/fields-split-1.pdf b/qpdf/qtest/qpdf/fields-split-1.pdf
diff --git a/qpdf/qtest/qpdf/fields-split-2.pdf b/qpdf/qtest/qpdf/fields-split-2.pdf
diff --git a/qpdf/qtest/qpdf/indirect-r-arg.out b/qpdf/qtest/qpdf/indirect-r-arg.out
@@ -1,7 +1,7 @@
-checking indirect-r-arg.pdf
 WARNING: indirect-r-arg.pdf (object 1 0, offset 76): unknown token while reading object; treating as string
 WARNING: indirect-r-arg.pdf (object 1 0, offset 62): expected dictionary key but found non-name object; inserting key /QPDFFake1
 WARNING: indirect-r-arg.pdf (object 1 0, offset 62): expected dictionary key but found non-name object; inserting key /QPDFFake2
+checking indirect-r-arg.pdf
 PDF Version: 1.3
 File is not encrypted
 File is not linearized

diff --git a/qpdf/qtest/qpdf/job-json-copy-attachments.pdf b/qpdf/qtest/qpdf/job-json-copy-attachments.pdf
diff --git a/qpdf/qtest/qpdf/job-json-empty-input.pdf b/qpdf/qtest/qpdf/job-json-empty-input.pdf
diff --git a/qpdf/qtest/qpdf/job-json-underlay-overlay-password.pdf b/qpdf/qtest/qpdf/job-json-underlay-overlay-password.pdf
diff --git a/qpdf/qtest/qpdf/labels-split-01-06.pdf b/qpdf/qtest/qpdf/labels-split-01-06.pdf
diff --git a/qpdf/qtest/qpdf/labels-split-07-11.pdf b/qpdf/qtest/qpdf/labels-split-07-11.pdf
diff --git a/qpdf/qtest/qpdf/merge-implicit-ranges.pdf b/qpdf/qtest/qpdf/merge-implicit-ranges.pdf
diff --git a/qpdf/qtest/qpdf/merge-multiple-labels.pdf b/qpdf/qtest/qpdf/merge-multiple-labels.pdf
diff --git a/qpdf/qtest/qpdf/merge-three-files-1.pdf b/qpdf/qtest/qpdf/merge-three-files-1.pdf
diff --git a/qpdf/qtest/qpdf/merge-three-files-2.pdf b/qpdf/qtest/qpdf/merge-three-files-2.pdf
diff --git a/qpdf/qtest/qpdf/obj0-check.out b/qpdf/qtest/qpdf/obj0-check.out
@@ -1,7 +1,7 @@
-checking obj0.pdf
 WARNING: obj0.pdf: file is damaged
 WARNING: obj0.pdf (object 1 0, offset 77): expected n n obj
 WARNING: obj0.pdf: Attempting to reconstruct cross-reference table
+checking obj0.pdf
 PDF Version: 1.3
 File is not encrypted
 File is not linearized

diff --git a/qpdf/qtest/qpdf/overlay-copy-annotations-p1.pdf b/qpdf/qtest/qpdf/overlay-copy-annotations-p1.pdf
diff --git a/qpdf/qtest/qpdf/overlay-copy-annotations-p2.pdf b/qpdf/qtest/qpdf/overlay-copy-annotations-p2.pdf
diff --git a/qpdf/qtest/qpdf/overlay-copy-annotations-p5.pdf b/qpdf/qtest/qpdf/overlay-copy-annotations-p5.pdf
diff --git a/qpdf/qtest/qpdf/overlay-copy-annotations-p6.pdf b/qpdf/qtest/qpdf/overlay-copy-annotations-p6.pdf
diff --git a/qpdf/qtest/qpdf/overlay-copy-annotations.pdf b/qpdf/qtest/qpdf/overlay-copy-annotations.pdf
diff --git a/qpdf/qtest/qpdf/remove-labels.pdf b/qpdf/qtest/qpdf/remove-labels.pdf
diff --git a/qpdf/qtest/qpdf/split-exp-01.Pdf b/qpdf/qtest/qpdf/split-exp-01.Pdf
diff --git a/qpdf/qtest/qpdf/split-exp-02.Pdf b/qpdf/qtest/qpdf/split-exp-02.Pdf
diff --git a/qpdf/qtest/qpdf/split-exp-03.Pdf b/qpdf/qtest/qpdf/split-exp-03.Pdf
diff --git a/qpdf/qtest/qpdf/split-exp-04.Pdf b/qpdf/qtest/qpdf/split-exp-04.Pdf
diff --git a/qpdf/qtest/qpdf/split-exp-05.Pdf b/qpdf/qtest/qpdf/split-exp-05.Pdf
diff --git a/qpdf/qtest/qpdf/split-exp-06.Pdf b/qpdf/qtest/qpdf/split-exp-06.Pdf
diff --git a/qpdf/qtest/qpdf/split-exp-07.Pdf b/qpdf/qtest/qpdf/split-exp-07.Pdf
diff --git a/qpdf/qtest/qpdf/split-exp-08.Pdf b/qpdf/qtest/qpdf/split-exp-08.Pdf
diff --git a/qpdf/qtest/qpdf/split-exp-09.Pdf b/qpdf/qtest/qpdf/split-exp-09.Pdf
diff --git a/qpdf/qtest/qpdf/split-exp-1 b/qpdf/qtest/qpdf/split-exp-1
diff --git a/qpdf/qtest/qpdf/split-exp-1.pdf b/qpdf/qtest/qpdf/split-exp-1.pdf
diff --git a/qpdf/qtest/qpdf/split-exp-10.Pdf b/qpdf/qtest/qpdf/split-exp-10.Pdf
diff --git a/qpdf/qtest/qpdf/split-exp-11.Pdf b/qpdf/qtest/qpdf/split-exp-11.Pdf
diff --git a/qpdf/qtest/qpdf/split-exp-2 b/qpdf/qtest/qpdf/split-exp-2
diff --git a/qpdf/qtest/qpdf/split-exp-3 b/qpdf/qtest/qpdf/split-exp-3
diff --git a/qpdf/qtest/qpdf/split-exp-4 b/qpdf/qtest/qpdf/split-exp-4
diff --git a/qpdf/qtest/qpdf/split-exp-group-01-05.pdf b/qpdf/qtest/qpdf/split-exp-group-01-05.pdf
diff --git a/qpdf/qtest/qpdf/split-exp-group-06-10.pdf b/qpdf/qtest/qpdf/split-exp-group-06-10.pdf
diff --git a/qpdf/qtest/qpdf/split-exp-group-11-11.pdf b/qpdf/qtest/qpdf/split-exp-group-11-11.pdf
diff --git a/qpdf/qtest/qpdf/split-exp.zdf_01 b/qpdf/qtest/qpdf/split-exp.zdf_01
@@ -1,4 +1,4 @@
-%PDF-1.3
+%PDF-1.4
 %����
 %QDF-1.0
 

diff --git a/qpdf/qtest/qpdf/split-exp.zdf_02 b/qpdf/qtest/qpdf/split-exp.zdf_02
@@ -1,4 +1,4 @@
-%PDF-1.3
+%PDF-1.4
 %����
 %QDF-1.0
 

diff --git a/qpdf/qtest/qpdf/split-exp.zdf_03 b/qpdf/qtest/qpdf/split-exp.zdf_03
@@ -1,4 +1,4 @@
-%PDF-1.3
+%PDF-1.4
 %����
 %QDF-1.0
 

diff --git a/qpdf/qtest/qpdf/split-exp.zdf_04 b/qpdf/qtest/qpdf/split-exp.zdf_04
@@ -1,4 +1,4 @@
-%PDF-1.3
+%PDF-1.4
 %����
 %QDF-1.0
 

diff --git a/qpdf/qtest/qpdf/split-exp.zdf_05 b/qpdf/qtest/qpdf/split-exp.zdf_05
@@ -1,4 +1,4 @@
-%PDF-1.3
+%PDF-1.4
 %����
 %QDF-1.0
 

diff --git a/qpdf/qtest/qpdf/split-exp.zdf_06 b/qpdf/qtest/qpdf/split-exp.zdf_06
@@ -1,4 +1,4 @@
-%PDF-1.3
+%PDF-1.4
 %����
 %QDF-1.0
 

diff --git a/qpdf/qtest/qpdf/split-exp.zdf_07 b/qpdf/qtest/qpdf/split-exp.zdf_07
@@ -1,4 +1,4 @@
-%PDF-1.3
+%PDF-1.4
 %����
 %QDF-1.0
 

diff --git a/qpdf/qtest/qpdf/split-exp.zdf_08 b/qpdf/qtest/qpdf/split-exp.zdf_08
@@ -1,4 +1,4 @@
-%PDF-1.3
+%PDF-1.4
 %����
 %QDF-1.0
 

diff --git a/qpdf/qtest/qpdf/split-exp.zdf_09 b/qpdf/qtest/qpdf/split-exp.zdf_09
@@ -1,4 +1,4 @@
-%PDF-1.3
+%PDF-1.4
 %����
 %QDF-1.0
 

diff --git a/qpdf/qtest/qpdf/split-exp.zdf_10 b/qpdf/qtest/qpdf/split-exp.zdf_10
@@ -1,4 +1,4 @@
-%PDF-1.3
+%PDF-1.4
 %����
 %QDF-1.0
 

diff --git a/qpdf/qtest/qpdf/split-exp.zdf_11 b/qpdf/qtest/qpdf/split-exp.zdf_11
@@ -1,4 +1,4 @@
-%PDF-1.3
+%PDF-1.4
 %����
 %QDF-1.0
 

diff --git a/qpdf/qtest/qpdf/uo-7.pdf b/qpdf/qtest/qpdf/uo-7.pdf
-Original file line number
+Diff line change
@@ -1,8 +1,3 @@
-.6
-    ====
-    * https://github.com/qpdf/qpdf/issues/610
     Next
     ====
@@ Expand Down @@