Refactor `QPDFJob` configuration: replace direct member access with `Doc::Config…

…` methods, update usage across codebase, and streamline related logic.

Refactor `QPDFJob` configuration: replace direct member access with `Doc::Config…
…` methods, update usage across codebase, and streamline related logic.
m-holger
1 parent b520c150
Showing 7 changed files with 21 additions and 39 deletions
include/qpdf/QPDFJob.hh
libqpdf/QPDFJob.cc
libqpdf/QPDFJob_config.cc
libqpdf/qpdf/QPDFJob_private.hh
libqpdf/qpdf/QPDF_private.hh
qpdf/qpdf.testcov
qpdf/qtest/qpdf/catalgg.out
@@ -460,7 +460,6 @@ class QPDFJob
         bool main_input);
  
     // Transformations
-    void setQPDFOptions(QPDF& pdf);
     void handlePageSpecs(QPDF& pdf);
     bool shouldRemoveUnreferencedResources(QPDF& pdf);
     void handleRotations(QPDF& pdf);
@@ -477,7 +477,7 @@ QPDFJob::writeQPDF(QPDF&amp; pdf)
     if (!pdf.getWarnings().empty()) {
         m->warnings = true;
     }
-    if (m->warnings && (!m->suppress_warnings)) {
+    if (m->warnings && !m->qcf.suppress_warnings()) {
         if (createsOutput()) {
             *m->log->getWarn()
                 << m->message_prefix
@@ -635,24 +635,6 @@ QPDFJob::getEncryptionStatus()
     return m->encryption_status;
 }
  
-void
-QPDFJob::setQPDFOptions(QPDF& pdf)
-{
-    pdf.setLogger(m->log);
-    if (m->ignore_xref_streams) {
-        pdf.setIgnoreXRefStreams(true);
-    }
-    if (m->suppress_recovery) {
-        pdf.setAttemptRecovery(false);
-    }
-    if (m->password_is_hex_key) {
-        pdf.setPasswordIsHexKey(true);
-    }
-    if (m->suppress_warnings) {
-        pdf.setSuppressWarnings(true);
-    }
-}
-
 static std::string
 show_bool(bool v)
 {
@@ -737,7 +719,6 @@ QPDFJob::doCheck(QPDF&amp; pdf)
     bool okay = true;
     auto& cout = *m->log->getInfo();
     cout << "checking " << m->infile_name() << "\n";
-    pdf.doc().config().check_mode(true);
     try {
         int extension_level = pdf.getExtensionLevel();
         cout << "PDF Version: " << pdf.getPDFVersion();
@@ -1728,7 +1709,7 @@ QPDFJob::doProcessOnce(
     bool main_input)
 {
     pdf = std::make_unique<QPDF>();
-    setQPDFOptions(*pdf);
+    pdf->doc().config(m->qcf.log(m->log));
     if (empty) {
         pdf->emptyPDF();
     } else if (main_input && m->json_input) {
@@ -1758,16 +1739,16 @@ QPDFJob::doProcess(
     // was incorrectly encoded, there's a good chance we'd succeed here.
  
     std::string ptemp;
-    if (password && (!m->password_is_hex_key)) {
+    if (password && !m->qcf.provided_password_is_hex_key()) {
         if (m->password_mode == QPDFJob::pm_hex_bytes) {
             // Special case: handle --password-mode=hex-bytes for input password as well as output
             // password
-            QTC::TC("qpdf", "QPDFJob input password hex-bytes");
             ptemp = QUtil::hex_decode(password);
             password = ptemp.c_str();
         }
     }
-    if ((password == nullptr) || empty || m->password_is_hex_key || m->suppress_password_recovery) {
+    if (!password || empty || m->qcf.provided_password_is_hex_key() ||
+        m->suppress_password_recovery) {
         // There is no password, or we're not doing recovery, so just do the normal processing with
         // the supplied password.
         doProcessOnce(pdf, fn, password, empty, used_for_input, main_input);
@@ -3034,12 +3015,10 @@ QPDFJob::doSplitPages(QPDF&amp; pdf)
             last = num_pages;
         }
         QPDF outpdf;
+        outpdf.doc().config(m->qcf);
         outpdf.emptyPDF();
         QPDFAcroFormDocumentHelper* out_afdh =
             afdh.hasAcroForm() ? &outpdf.doc().acroform() : nullptr;
-        if (m->suppress_warnings) {
-            outpdf.setSuppressWarnings(true);
-        }
         for (size_t pageno = first; pageno <= last; ++pageno) {
             QPDFObjectHandle page = pages.at(pageno - 1);
             outpdf.addPage(page, false);
@@ -68,6 +68,7 @@ QPDFJob::Config*
 QPDFJob::Config::check()
 {
     o.m->check = true;
+    o.m->qcf.check_mode(true);
     o.m->require_outfile = false;
     return this;
 }
@@ -233,7 +234,7 @@ QPDFJob::Config::generateAppearances()
 QPDFJob::Config*
 QPDFJob::Config::ignoreXrefStreams()
 {
-    o.m->ignore_xref_streams = true;
+    o.m->qcf.ignore_xref_streams(true);
     return this;
 }
  
@@ -415,7 +416,7 @@ QPDFJob::Config::noOriginalObjectIds()
 QPDFJob::Config*
 QPDFJob::Config::noWarn()
 {
-    o.m->suppress_warnings = true;
+    o.m->qcf.suppress_warnings(true);
     return this;
 }
  
@@ -465,7 +466,7 @@ QPDFJob::Config::password(std::string const&amp; parameter)
 QPDFJob::Config*
 QPDFJob::Config::passwordIsHexKey()
 {
-    o.m->password_is_hex_key = true;
+    o.m->qcf.provided_password_is_hex_key(true);
     return this;
 }
  
@@ -662,7 +663,7 @@ QPDFJob::Config::suppressPasswordRecovery()
 QPDFJob::Config*
 QPDFJob::Config::suppressRecovery()
 {
-    o.m->suppress_recovery = true;
+    o.m->qcf.attempt_recovery(false);
     return this;
 }
  
@@ -5,6 +5,7 @@
  
 #include <qpdf/ClosedFileInputSource.hh>
 #include <qpdf/QPDFLogger.hh>
+#include <qpdf/QPDF_private.hh>
  
 // A selection of pages from a single input PDF to be included in the output. This corresponds to a
 // single clause in the --pages option.
@@ -149,7 +150,7 @@ class QPDFJob::Members
  
   public:
     Members(QPDFJob& job) :
-        log(QPDFLogger::defaultLogger()),
+        log(qcf.log()),
         inputs(job)
     {
     }
@@ -167,6 +168,7 @@ class QPDFJob::Members
     static int constexpr DEFAULT_OI_MIN_AREA = 16384;
     static int constexpr DEFAULT_II_MIN_BYTES = 1024;
  
+    qpdf::Doc::Config qcf;
     std::shared_ptr<QPDFLogger> log;
     std::string message_prefix{"qpdf"};
     bool warnings{false};
@@ -179,11 +181,9 @@ class QPDFJob::Members
     int split_pages{0};
     bool progress{false};
     std::function<void(int)> progress_handler{nullptr};
-    bool suppress_warnings{false};
     bool warnings_exit_zero{false};
     bool copy_encryption{false};
     bool encrypt{false};
-    bool password_is_hex_key{false};
     bool suppress_password_recovery{false};
     password_mode_e password_mode{pm_auto};
     bool allow_insecure{false};
@@ -218,10 +218,8 @@ class QPDFJob::Members
     bool decode_level_set{false};
     bool normalize_set{false};
     bool normalize{false};
-    bool suppress_recovery{false};
     bool object_stream_set{false};
     qpdf_object_stream_e object_stream_mode{qpdf_o_preserve};
-    bool ignore_xref_streams{false};
     bool qdf_mode{false};
     bool preserve_unreferenced_objects{false};
     remove_unref_e remove_unreferenced_page_resources{re_auto};
@@ -504,6 +504,12 @@ class QPDF::Doc
         return cf;
     }
  
+    void
+    config(qpdf::Doc::Config val)
+    {
+        cf = val;
+    }
+
     inline Linearization& linearization();
  
     inline Objects& objects();
@@ -248,7 +248,6 @@ QPDFJob password not encodable 0
 QPDFJob auto-encode password 0
 QPDFJob bytes fallback warning 0
 QPDFJob invalid utf-8 in auto 0
-QPDFJob input password hex-bytes 0
 QPDFFormFieldObjectHelper replaced BMC at EOF 0
 QPDFFormFieldObjectHelper fallback Tf 0
 QPDFPageObjectHelper copy shared attribute 1
-checking catalgg.pdf
 WARNING: catalgg.pdf: catalog /Type entry missing or invalid
+checking catalgg.pdf
 PDF Version: 1.3
 File is not encrypted
 File is not linearized