Refactor `QPDF::getRoot`: improve error handling for invalid trailer `/Root` and…

… simplify logic. Update related test outputs and release notes.

Refactor `QPDF::getRoot`: improve error handling for invalid trailer `/Root` and…
… simplify logic. Update related test outputs and release notes.
m-holger
1 parent 1831a2fe
Showing 4 changed files with 17 additions and 13 deletions
libqpdf/QPDF.cc
manual/release-notes.rst
qpdf/qtest/qpdf/c-oh-errors.out
qpdf/qtest/qpdf/test73.out
@@ -651,17 +651,17 @@ QPDF::getTrailer()
 QPDFObjectHandle
 QPDF::getRoot()
 {
-    QPDFObjectHandle root = m->trailer.getKey("/Root");
-    if (!root.isDictionary()) {
+    Dictionary Root = m->trailer["/Root"];
+    if (!Root) {
         throw m->c.damagedPDF("", -1, "unable to find /Root dictionary");
-    } else if (
-        // Check_mode is an interim solution to request #810 pending a more comprehensive review of
-        // the approach to more extensive checks and warning levels.
-        m->cf.check_mode() && !root.getKey("/Type").isNameAndEquals("/Catalog")) {
+    }
+    // Check_mode is an interim solution to request #810 pending a more comprehensive review of the
+    // approach to more extensive checks and warning levels.
+    if (m->cf.check_mode() && Name(Root["/Type"]) != "/Catalog") {
         warn(m->c.damagedPDF("", -1, "catalog /Type entry missing or invalid"));
-        root.replaceKey("/Type", "/Catalog"_qpdf);
+        Root.replaceKey("/Type", Name("/Catalog"));
     }
-    return root;
+    return Root.oh();
 }
 std::map<QPDFObjGen, QPDFXRefEntry>
@@ -65,6 +65,10 @@ more detail.
   - Other changes
+    - Calling ``QPDF::getRoot`` on a file with invalid trailer now throws a
+      ``damaged_pdf`` error with message "unable to find /Root dictionary"
+      rather than an internal error.
+
 .. _r12-3-0-deprecate:
     - The following are believed to be not in use and have been deprecated.
-get root: attempted to dereference an uninitialized QPDFObjectHandle
-  code: 1
-  file: 
+get root: closed input source: unable to find /Root dictionary
+  code: 5
+  file: closed input source
   pos: 0
-  text: attempted to dereference an uninitialized QPDFObjectHandle
+  text: unable to find /Root dictionary
 bad parse: parsed object (offset 1): unknown token while reading object; treating as string
   code: 5
   file: parsed object
-getRoot: attempted to dereference an uninitialized QPDFObjectHandle
+getRoot: closed input source: unable to find /Root dictionary
 WARNING: closed input source: object 4/0: error reading object: QPDF operation attempted on a QPDF object with no input source. QPDF operations are invalid before processFile (or another process method) or after closeInputSource
 test 73 done