decode streams on check, always exit abnormally when warnings are detected

git-svn-id: svn+q:///qpdf/trunk@660 71b93d88-0707-0410-a8cf-f5a4172ac649

decode streams on check, always exit abnormally when warnings are detected
git-svn-id: svn+q:///qpdf/trunk@660 71b93d88-0707-0410-a8cf-f5a4172ac649
Jay Berkenbilt
1 parent 9210dd46
Showing 7 changed files with 118 additions and 32 deletions
ChangeLog
include/qpdf/QPDF.hh
libqpdf/QPDF.cc
manual/qpdf-manual.xml
qpdf/qpdf.cc
qpdf/qpdf.testcov
qpdf/qtest/qpdf.test
+2009-03-08  Jay Berkenbilt  <ejb@ql.org>
+
+	* qpdf/fix-qdf (write_ostream): Adjust offsets while writing
+	object streams to account for changes in the length of the
+	dictionary and offset tables.
+
+	* qpdf/qpdf.cc (main): In check mode, in addition to checking
+	structure of file, attempt to decode all stream data.
+
+	* libqpdf/QPDFWriter.cc (QPDFWriter::writeObject): In QDF mode,
+	write a comment to the QDF file that indicates the object ID from
+	the original file.
+
+	* libqpdf/QPDF.cc (QPDF::pipeStreamData): Issue a warning instead
+	of failing if there is a problem found while decoding stream.
+
+	* qpdf/qpdf.cc: Exit with a status of 3 if warnings were found
+	regardless of what mode we're in.
+
 2009-02-21  Jay Berkenbilt  <ejb@ql.org>
 	* 2.0.4: release
@@ -160,6 +160,10 @@ class QPDF
     // dictionaries) with direct objects.
     void flattenScalarReferences();
+    // Decode all streams, discarding the output.  Used to check
+    // correctness of stream encoding.
+    void decodeStreams();
+
     // For QPDFWriter:
     // Remove /ID, /Encrypt, and /Prev keys from the trailer
@@ -10,6 +10,7 @@
 #include <qpdf/QUtil.hh>
 #include <qpdf/PCRE.hh>
 #include <qpdf/Pipeline.hh>
+#include <qpdf/Pl_Discard.hh>
 #include <qpdf/QPDFExc.hh>
 #include <qpdf/QPDF_Null.hh>
@@ -1810,23 +1811,51 @@ QPDF::pipeStreamData(int objid, int generation,
 	}
     }
-    this->file.seek(offset, SEEK_SET);
-    char buf[10240];
-    while (length > 0)
+    try
     {
-	size_t to_read = (sizeof(buf) < length ? sizeof(buf) : length);
-	size_t len = this->file.read(buf, to_read);
-	if (len == 0)
+	this->file.seek(offset, SEEK_SET);
+	char buf[10240];
+	while (length > 0)
 	{
-	    throw QPDFExc(this->file.getName(), this->file.getLastOffset(),
-			  "unexpected EOF reading stream data");
+	    size_t to_read = (sizeof(buf) < length ? sizeof(buf) : length);
+	    size_t len = this->file.read(buf, to_read);
+	    if (len == 0)
+	    {
+		throw QPDFExc(this->file.getName(), this->file.getLastOffset(),
+			      "unexpected EOF reading stream data");
+	    }
+	    length -= len;
+	    pipeline->write((unsigned char*)buf, len);
 	}
-	length -= len;
-	pipeline->write((unsigned char*)buf, len);
+    }
+    catch (QEXC::General& e)
+    {
+	QTC::TC("qpdf", "QPDF decoding error warning");
+	warn(QPDFExc(this->file.getName(), this->file.getLastOffset(),
+		     "error decoding stream data for object " +
+		     QUtil::int_to_string(objid) + " " +
+		     QUtil::int_to_string(generation) + ": " + e.unparse()));
     }
     pipeline->finish();
 }
+void
+QPDF::decodeStreams()
+{
+    for (std::map<ObjGen, QPDFXRefEntry>::iterator iter =
+	     this->xref_table.begin();
+	 iter != this->xref_table.end(); ++iter)
+    {
+	ObjGen const& og = (*iter).first;
+	QPDFObjectHandle obj = getObjectByID(og.obj, og.gen);
+	if (obj.isStream())
+	{
+	    Pl_Discard pl;
+	    obj.pipeStreamData(&pl, true, false, false);
+	}
+    }
+}
+
 std::vector<QPDFObjectHandle> const&
 QPDF::getAllPages()
 {
@@ -738,15 +738,15 @@ make
       <term><option>-check</option></term>
       <listitem>
        <para>
-        Checks file structure and well as encryption and
-        linearization.  A file for which <option>--check</option>
-        reports no errors may still have errors in stream data but
-        should otherwise be otherwise structurally sound.  If
-        <option>--check</option> any errors, qpdf will exit with a
-        status of 2.  There are some recoverable conditions that
-        <option>--check</option> detects.  These are issued as
-        warnings instead of errors.  If qpdf finds no errors but finds
-        warnings, it will exit with a status of 3 (as of
+        Checks file structure and well as encryption, linearization,
+        and encoding of stream data.  A file for which
+        <option>--check</option> reports no errors may still have
+        errors in stream data content but should otherwise be
+        structurally sound.  If <option>--check</option> any errors,
+        qpdf will exit with a status of 2.  There are some recoverable
+        conditions that <option>--check</option> detects.  These are
+        issued as warnings instead of errors.  If qpdf finds no errors
+        but finds warnings, it will exit with a status of 3 (as of
         version&nbsp;2.0.4).
        </para>
       </listitem>
@@ -861,6 +861,12 @@ make
       special comments that make them easy to find.
      </para>
     </listitem>
+    <listitem>
+     <para>
+      Comments precede each object indicating the object number of the
+      corresponding object in the original file.
+     </para>
+    </listitem>
    </itemizedlist>
   </para>
   <para>
@@ -12,6 +12,9 @@
 #include <qpdf/QPDFWriter.hh>
+static int const EXIT_ERROR = 2;
+static int const EXIT_WARNING = 3;
+
 static char const* whoami = 0;
 // Note: let's not be too noisy about documenting the fact that this
@@ -158,7 +161,7 @@ void usage(std::string const&amp; msg)
 	<< "Usage: " << whoami << " [options] infile outfile" << std::endl
 	<< "For detailed help, run " << whoami << " --help" << std::endl
 	<< std::endl;
-    exit(2);
+    exit(EXIT_ERROR);
 }
 static void show_encryption(QPDF& pdf)
@@ -752,7 +755,7 @@ int main(int argc, char* argv[])
 		}
 		else
 		{
-		    exit(2);
+		    exit(EXIT_ERROR);
 		}
 	    }
 	    if (show_linearization)
@@ -777,7 +780,7 @@ int main(int argc, char* argv[])
 			    QTC::TC("qpdf", "unable to filter");
 			    std::cerr << "Unable to filter stream data."
 				      << std::endl;
-			    exit(2);
+			    exit(EXIT_ERROR);
 			}
 			else
 			{
@@ -869,6 +872,8 @@ int main(int argc, char* argv[])
 			// traversal of file, so any structural errors
 			// would be exposed.
 			pdf.flattenScalarReferences();
+			// Also explicitly decode all streams.
+			pdf.decodeStreams();
 			okay = true;
 		    }
 		}
@@ -880,8 +885,7 @@ int main(int argc, char* argv[])
 		{
 		    if (! pdf.getWarnings().empty())
 		    {
-			// special exit status for warnings without errors
-			exit(3);
+			exit(EXIT_WARNING);
 		    }
 		    else
 		    {
@@ -946,11 +950,15 @@ int main(int argc, char* argv[])
 	    }
 	    w.write();
 	}
+	if (! pdf.getWarnings().empty())
+	{
+	    exit(EXIT_WARNING);
+	}
     }
     catch (std::exception& e)
     {
 	std::cerr << e.what() << std::endl;
-	exit(2);
+	exit(EXIT_ERROR);
     }
     return 0;
@@ -117,3 +117,4 @@ QPDF piping xref stream from encrypted file 0
 unable to filter 0
 QPDF_String non-trivial UTF-16 0
 QPDF xref overwrite object 0
+QPDF decoding error warning 0
@@ -183,7 +183,7 @@ for (my $i = 1; $i &lt;= scalar(@badfiles); ++$i)
 $td->runtest("recover heifer file",
 	     {$td->COMMAND => "qpdf --static-id -qdf heifer.pdf a.pdf"},
 	     {$td->FILE => "heifer.out",
-	      $td->EXIT_STATUS => 0},
+	      $td->EXIT_STATUS => 3},
 	     $td->NORMALIZE_NEWLINES);
 $td->runtest("check output",
 	     {$td->FILE => "a.pdf"},
@@ -206,7 +206,7 @@ $td-&gt;runtest(&quot;damaged replaced page contents&quot;,
 	     {$td->COMMAND => "qpdf --static-id -qdf" .
 		  " append-page-content-damaged.pdf a.pdf"},
 	     {$td->FILE => "append-page-content-damaged.out",
-	      $td->EXIT_STATUS => 0},
+	      $td->EXIT_STATUS => 3},
 	     $td->NORMALIZE_NEWLINES);
 $td->runtest("check output",
 	     {$td->FILE => "a.pdf"},
@@ -282,7 +282,7 @@ check_pdf(&quot;no recompression&quot;,
 show_ntests();
 # ----------
 $td->notify("--- Object Stream Tests ---");
-$n_tests += 36 * 4;
+$n_tests += 36 * 6;
 $n_compare_pdfs += 36;
 for (my $n = 16; $n <= 19; ++$n)
@@ -294,7 +294,7 @@ for (my $n = 16; $n &lt;= 19; ++$n)
     {
 	foreach my $qdf ('-qdf', '', '-encrypt "" x 128 --')
 	{
-	    # 4 tests + 1 compare_pdfs
+	    # 6 tests + 1 compare_pdfs
 	    $td->runtest("object stream mode",
 			 {$td->COMMAND =>
 			      "qpdf --static-id $flags $qdf $in a.pdf"},
@@ -316,6 +316,12 @@ for (my $n = 16; $n &lt;= 19; ++$n)
 	    $td->runtest("compare files",
 			 {$td->FILE => "a.qdf"},
 			 {$td->FILE => "b.qdf"});
+	    $td->runtest("fix-qdf identity check",
+			 {$td->COMMAND => "fix-qdf a.qdf >| b.pdf"},
+			 {$td->STRING => "", $td->EXIT_STATUS => 0});
+	    $td->runtest("compare files",
+			 {$td->FILE => "a.qdf"},
+			 {$td->FILE => "b.qdf"});
 	}
     }
     flush_tiff_cache();
@@ -324,12 +330,14 @@ for (my $n = 16; $n &lt;= 19; ++$n)
 show_ntests();
 # ----------
 $td->notify("--- Specific File Tests ---");
-$n_tests += 1;
+$n_tests += 2;
+$n_compare_pdfs += 1;
 # Special PDF files that caused problems at some point
 # This file is a PDF 1.1 file with /# as a name and with
-# inconsistencies in its free table.
+# inconsistencies in its free table.  It also has LZW streams that
+# happen to test boundary conditions in the LZW decoder.
 $td->runtest("old and complex",
 	     {$td->COMMAND => "qpdf --check old-and-complex.pdf"},
 	     {$td->STRING => +("checking old-and-complex.pdf\n" .
@@ -339,6 +347,12 @@ $td-&gt;runtest(&quot;old and complex&quot;,
 			       $td->EXIT_STATUS => 0},
 	     $td->NORMALIZE_NEWLINES);
+$td->runtest("convert to qdf",
+	     {$td->COMMAND => "qpdf --qdf old-and-complex.pdf a.qdf"},
+	     {$td->STRING => "", $td->EXIT_STATUS => 0});
+
+compare_pdfs("old-and-complex.pdf", "a.qdf");
+
 show_ntests();
 # ----------
 $td->notify("--- Mutability Tests ---");
@@ -823,7 +837,7 @@ foreach my $file (@files)
 show_ntests();
 # ----------
 $td->notify("--- fix-qdf Tests ---");
-$n_tests += 2;
+$n_tests += 4;
 for (my $n = 1; $n <= 2; ++$n)
 {
@@ -831,6 +845,11 @@ for (my $n = 1; $n &lt;= 2; ++$n)
 		 {$td->COMMAND => "fix-qdf fix$n.qdf"},
 		 {$td->FILE => "fix$n.qdf.out",
 		  $td->EXIT_STATUS => 0});
+
+    $td->runtest("identity fix-qdf $n",
+		 {$td->COMMAND => "fix-qdf fix$n.qdf.out"},
+		 {$td->FILE => "fix$n.qdf.out",
+		  $td->EXIT_STATUS => 0});
 }
 show_ntests();