Use "save" logger when saving data to standard output

This includes the output PDF, streams from --show-object and attachments from --save-attachment. This also enables --verbose and --progress to work with saving to stdout.

Use "save" logger when saving data to standard output
This includes the output PDF, streams from --show-object and attachments from --save-attachment. This also enables --verbose and --progress to work with saving to stdout.
Jay Berkenbilt
1 parent 641e92c6
Showing 7 changed files with 60 additions and 23 deletions
ChangeLog
TODO
libqpdf/QPDFJob.cc
libqpdf/QPDFLogger.cc
manual/release-notes.rst
qpdf/qtest/progress-reporting.test
qpdf/qtest/qpdf/small-stdout-progress.out
+2022-06-18  Jay Berkenbilt  <ejb@ql.org>
+
+        * When --progress or --verbose is combined with writing to
+        standard output, progress reporting and verbose messages go to
+        standard error. Previously it was disabled in this case.
+
 2022-06-05  Jay Berkenbilt  <ejb@ql.org>
  
         * QPDFJob: API breaking change: QPDFJob::doIfVerbose passes a
@@ -79,9 +79,6 @@ Find all places in the library that write to stdout/stderr/cout/cerr.
 Also find places that raise exceptions if unable to warn. These should
 use the global output writer.
  
-Figure out a good way to use the save pipeline for QPDFWriter as well
-as saving attachments, showing stream data, etc.
-
  
 QPDFPagesTree
 =============
@@ -691,22 +691,21 @@ QPDFJob::checkConfiguration()
               " before the -- that follows --encrypt.");
     }
  
+    bool save_to_stdout = false;
     if (m->require_outfile && m->outfilename &&
         (strcmp(m->outfilename.get(), "-") == 0)) {
         if (m->split_pages) {
             usage("--split-pages may not be used when"
                   " writing to standard output");
         }
-        if (this->m->verbose) {
-            usage("--verbose may not be used when"
-                  " writing to standard output");
-        }
-        if (m->progress) {
-            usage("--progress may not be used when"
-                  " writing to standard output");
-        }
+        save_to_stdout = true;
+    }
+    if (!m->attachment_to_show.empty()) {
+        save_to_stdout = true;
+    }
+    if (save_to_stdout) {
+        this->m->log->saveToStandardOutput();
     }
-
     if ((!m->split_pages) &&
         QUtil::same_file(m->infilename.get(), m->outfilename.get())) {
         QTC::TC("qpdf", "QPDFJob same file error");
@@ -918,10 +917,11 @@ QPDFJob::doShowObj(QPDF&amp; pdf)
                 obj.warnIfPossible("unable to filter stream data");
                 error = true;
             } else {
-                QUtil::binary_stdout();
-                Pl_StdioFile out("stdout", stdout);
+                // If anything has been written to standard output,
+                // this will fail.
+                this->m->log->saveToStandardOutput();
                 obj.pipeStreamData(
-                    &out,
+                    this->m->log->getSave().get(),
                     (filter && m->normalize) ? qpdf_ef_normalize : 0,
                     filter ? qpdf_dl_all : qpdf_dl_none);
             }
@@ -1023,9 +1023,10 @@ QPDFJob::doShowAttachment(QPDF&amp; pdf)
             "attachment " + m->attachment_to_show + " not found");
     }
     auto efs = fs->getEmbeddedFileStream();
-    QUtil::binary_stdout();
-    Pl_StdioFile out("stdout", stdout);
-    efs.pipeStreamData(&out, 0, qpdf_dl_all);
+    // saveToStandardOutput has already been called, but it's harmless
+    // to call it again, so do as defensive coding.
+    this->m->log->saveToStandardOutput();
+    efs.pipeStreamData(this->m->log->getSave().get(), 0, qpdf_dl_all);
 }
  
 void
@@ -3138,14 +3139,17 @@ QPDFJob::setWriterOptions(QPDF&amp; pdf, QPDFWriter&amp; w)
         parse_version(m->force_version, version, extension_level);
         w.forcePDFVersion(version, extension_level);
     }
-    if (m->progress && m->outfilename) {
+    if (m->progress) {
+        char const* outfilename = this->m->outfilename
+            ? this->m->outfilename.get()
+            : "standard output";
         w.registerProgressReporter(
             std::shared_ptr<QPDFWriter::ProgressReporter>(
                 // line-break
                 new ProgressReporter(
                     *this->m->log->getInfo(),
                     this->m->message_prefix,
-                    m->outfilename.get())));
+                    outfilename)));
     }
 }
  
@@ -3273,7 +3277,15 @@ QPDFJob::writeOutfile(QPDF&amp; pdf)
     } else {
         // QPDFWriter must have block scope so the output file will be
         // closed after write() finishes.
-        QPDFWriter w(pdf, m->outfilename.get());
+        QPDFWriter w(pdf);
+        if (this->m->outfilename) {
+            w.setOutputFilename(m->outfilename.get());
+        } else {
+            // saveToStandardOutput has already been called, but
+            // calling it again is defensive and harmless.
+            this->m->log->saveToStandardOutput();
+            w.setOutputPipeline(this->m->log->getSave().get());
+        }
         setWriterOptions(pdf, w);
         w.write();
     }
@@ -2,6 +2,7 @@
  
 #include <qpdf/Pl_Discard.hh>
 #include <qpdf/Pl_OStream.hh>
+#include <qpdf/QUtil.hh>
 #include <iostream>
 #include <stdexcept>
  
@@ -182,6 +183,9 @@ QPDFLogger::setError(std::shared_ptr&lt;Pipeline&gt; p)
 void
 QPDFLogger::setSave(std::shared_ptr<Pipeline> p)
 {
+    if (this->m->p_save == p) {
+        return;
+    }
     if (p == this->m->p_stdout) {
         auto pt = dynamic_cast<Pl_Track*>(p.get());
         if (pt->getUsed()) {
@@ -192,6 +196,7 @@ QPDFLogger::setSave(std::shared_ptr&lt;Pipeline&gt; p)
         if (this->m->p_info == this->m->p_stdout) {
             this->m->p_info = this->m->p_stderr;
         }
+        QUtil::binary_stdout();
     }
     this->m->p_save = p;
 }
@@ -133,6 +133,10 @@ For a detailed list of changes, please see the file
       user password is not recoverable from the owner password when
       256-bit keys are in use.
  
+    - ``--verbose`` and ``--progress`` may be now used when writing
+      the output PDF to standard output. In that case, the verbose and
+      progress messages are written to standard error.
+
   - Library Enhancements
  
     - New methods ``insertItemAndGet``, ``appendItemAndGet``,
@@ -14,13 +14,23 @@ cleanup();
  
 my $td = new TestDriver('progress-reporting');
  
-my $n_tests = 1;
+my $n_tests = 3;
  
 $td->runtest("progress report on small file",
-             {$td->COMMAND => "qpdf --progress minimal.pdf a.pdf",
+             {$td->COMMAND =>
+                  "qpdf --progress --deterministic-id minimal.pdf a.pdf",
                   $td->FILTER => "perl filter-progress.pl"},
              {$td->FILE => "small-progress.out", $td->EXIT_STATUS => 0},
              $td->NORMALIZE_NEWLINES);
+$td->runtest("progress report to stdout",
+             {$td->COMMAND =>
+                  "qpdf --progress --deterministic-id minimal.pdf - > b.pdf",
+                  $td->FILTER => "perl filter-progress.pl"},
+             {$td->FILE => "small-stdout-progress.out", $td->EXIT_STATUS => 0},
+             $td->NORMALIZE_NEWLINES);
+$td->runtest("compare",
+             {$td->FILE => "a.pdf"},
+             {$td->FILE => "b.pdf"});
  
 cleanup();
 $td->report($n_tests);
+qpdf: standard output: write progress: 0%
+....other write progress....
+qpdf: standard output: write progress: 100%