Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added samples/bugs/PullRequest797-pdf.js.pdf
Binary file not shown.
Binary file added samples/bugs/PullRequest797-vera.pdf
Binary file not shown.
Binary file added samples/bugs/PullRequest815-xref-command-missing.pdf
Binary file not shown.
Binary file not shown.
164 changes: 148 additions & 16 deletions src/Smalot/PdfParser/RawData/RawDataParser.php
Original file line number Diff line number Diff line change
Expand Up @@ -198,16 +198,16 @@ protected function decodeXref(string $pdfData, int $startxref, array $xref = [],
// get only the last updated version
$xref['trailer'] = [];
// parse trailer_data
if (preg_match('/Size[\s]+([0-9]+)/i', $trailer_data, $matches) > 0) {
if (preg_match('/\/Size[\s]+([0-9]+)/i', $trailer_data, $matches) > 0) {
$xref['trailer']['size'] = (int) $matches[1];
}
if (preg_match('/Root[\s]+([0-9]+)[\s]+([0-9]+)[\s]+R/i', $trailer_data, $matches) > 0) {
if (preg_match('/\/Root[\s]+([0-9]+)[\s]+([0-9]+)[\s]+R/i', $trailer_data, $matches) > 0) {
$xref['trailer']['root'] = (int) $matches[1].'_'.(int) $matches[2];
}
if (preg_match('/Encrypt[\s]+([0-9]+)[\s]+([0-9]+)[\s]+R/i', $trailer_data, $matches) > 0) {
if (preg_match('/\/Encrypt[\s]+([0-9]+)[\s]+([0-9]+)[\s]+R/i', $trailer_data, $matches) > 0) {
$xref['trailer']['encrypt'] = (int) $matches[1].'_'.(int) $matches[2];
}
if (preg_match('/Info[\s]+([0-9]+)[\s]+([0-9]+)[\s]+R/i', $trailer_data, $matches) > 0) {
if (preg_match('/\/Info[\s]+([0-9]+)[\s]+([0-9]+)[\s]+R/i', $trailer_data, $matches) > 0) {
$xref['trailer']['info'] = (int) $matches[1].'_'.(int) $matches[2];
}
if (preg_match('/ID[\s]*[\[][\s]*[<]([^>]*)[>][\s]*[<]([^>]*)[>]/i', $trailer_data, $matches) > 0) {
Expand All @@ -216,7 +216,7 @@ protected function decodeXref(string $pdfData, int $startxref, array $xref = [],
$xref['trailer']['id'][1] = $matches[2];
}
}
if (preg_match('/Prev[\s]+([0-9]+)/i', $trailer_data, $matches) > 0) {
if (preg_match('/\/Prev[\s]+([0-9]+)/i', $trailer_data, $matches) > 0) {
$offset = (int) $matches[1];
if (0 != $offset) {
// get previous xref
Expand Down Expand Up @@ -246,7 +246,28 @@ protected function decodeXrefStream(string $pdfData, int $startxref, array $xref
{
// try to read Cross-Reference Stream
$xrefobj = $this->getRawObject($pdfData, $startxref);
$xrefcrs = $this->getIndirectObject($pdfData, $xref, $xrefobj[1], $startxref, true);
$xrefObjRef = isset($xrefobj[1]) && \is_string($xrefobj[1]) ? $xrefobj[1] : '';
$xrefObjOffset = $startxref;

// Some malformed files have a startxref that points near the xref stream object.
// Try to recover a nearby valid object header instead of failing hard.
if (0 === preg_match('/^[0-9]+_[0-9]+$/', $xrefObjRef)) {
if (
preg_match('/([0-9]+)[\x20]+([0-9]+)[\x20]+obj/i', $pdfData, $matches, \PREG_OFFSET_CAPTURE, $startxref) > 0
&& ($matches[0][1] - $startxref) <= 64
) {
$xrefObjRef = (int) $matches[1][0].'_'.(int) $matches[2][0];
$xrefObjOffset = $matches[0][1];
}
}

if (0 === preg_match('/^[0-9]+_[0-9]+$/', $xrefObjRef)) {
// Could not resolve a valid xref stream object reference at this offset.
// Keep already collected xref data instead of aborting parsing.
return $xref;
}

$xrefcrs = $this->getIndirectObject($pdfData, $xref, $xrefObjRef, $xrefObjOffset, true);
if (!isset($xref['trailer']) || empty($xref['trailer'])) {
// get only the last updated version
$xref['trailer'] = [];
Expand Down Expand Up @@ -607,11 +628,15 @@ protected function getObjectVal(string $pdfData, $xref, array $obj): array
if (isset($this->objects[$obj[1]])) {
// this object has been already parsed
return $this->objects[$obj[1]];
} elseif (isset($xref[$obj[1]])) {
} elseif (isset($xref[$obj[1]]) && $xref[$obj[1]] > 0) {
// parse new object
$this->objects[$obj[1]] = $this->getIndirectObject($pdfData, $xref, $obj[1], $xref[$obj[1]], false);

return $this->objects[$obj[1]];
} elseif (isset($xref[$obj[1]]) && $xref[$obj[1]] <= 0) {
// Compressed object references are resolved later from object streams in Parser::parseObject().
// At raw parsing stage, treat unresolved references as null instead of throwing.
return ['null', 'null', 0];
}
}

Expand Down Expand Up @@ -902,15 +927,34 @@ protected function getXrefData(string $pdfData, int $offset = 0, array $xref = [
);

if (0 == $startxrefPreg) {
// No startxref tables were found
throw new \Exception('Unable to find startxref');
$xrefSubsectionAtOffset = preg_match(
'/[0-9]+[\x20]+[0-9]+[\x20]*[\r\n]/A',
substr($pdfData, $bumpOffset, 48)
) > 0;

if (strpos($pdfData, 'xref', $bumpOffset) === $bumpOffset || $xrefSubsectionAtOffset) {
// No startxref stanza, but caller already points to an xref table/subsection.
$startxref = $bumpOffset;
} elseif (preg_match('/^[0-9]+[\s]+[0-9]+[\s]+obj/i', substr($pdfData, $bumpOffset, 32)) > 0) {
// No startxref stanza, but caller points to an xref stream object.
$startxref = $bumpOffset;
} else {
// No valid startxref table was found. Try to recover from nearby xref data
// or reconstruct a minimal xref from object headers plus trailer metadata.
$recoveredXref = $this->recoverXrefWithoutStartxref($pdfData);
if (!empty($recoveredXref)) {
return $recoveredXref;
}

throw new \Exception('Unable to find startxref');
}
} elseif (0 == $offset) {
// Use the last startxref in the document
$startxref = (int) $startxrefMatches[\count($startxrefMatches) - 1][1];
} elseif (strpos($pdfData, 'xref', $bumpOffset) == $bumpOffset) {
} elseif (strpos($pdfData, 'xref', $bumpOffset) === $bumpOffset) {
// Already pointing at the xref table
$startxref = $bumpOffset;
} elseif (preg_match('/([0-9]+[\s][0-9]+[\s]obj)/i', $pdfData, $matches, 0, $bumpOffset)) {
} elseif (preg_match('/^[0-9]+[\s]+[0-9]+[\s]+obj/i', substr($pdfData, $bumpOffset, 32)) > 0) {
// Cross-Reference Stream object
$startxref = $bumpOffset;
} else {
Expand All @@ -922,14 +966,18 @@ protected function getXrefData(string $pdfData, int $offset = 0, array $xref = [
throw new \Exception('Unable to find xref (PDF corrupted?)');
}

// Some files point startxref to the whitespace right before the xref keyword.
$startxrefOffset = $startxref + strspn($pdfData, $this->config->getPdfWhitespaces(), $startxref);

// check xref position
if (strpos($pdfData, 'xref', $startxref) == $startxref) {
if (strpos($pdfData, 'xref', $startxrefOffset) == $startxrefOffset) {
// Cross-Reference
$xref = $this->decodeXref($pdfData, $startxref, $xref, $visitedOffsets);
$xref = $this->decodeXref($pdfData, $startxrefOffset, $xref, $visitedOffsets);
} else {
// Check if the $pdfData might have the wrong line-endings
$pdfDataUnix = str_replace("\r\n", "\n", $pdfData);
if ($startxref < \strlen($pdfDataUnix) && strpos($pdfDataUnix, 'xref', $startxref) == $startxref) {
$startxrefUnixOffset = $startxref + strspn($pdfDataUnix, $this->config->getPdfWhitespaces(), $startxref);
if ($startxrefUnixOffset < \strlen($pdfDataUnix) && strpos($pdfDataUnix, 'xref', $startxrefUnixOffset) == $startxrefUnixOffset) {
// Return Unix-line-ending flag
$xref = ['Unix' => true];
} else {
Expand All @@ -938,12 +986,95 @@ protected function getXrefData(string $pdfData, int $offset = 0, array $xref = [
}
}
if (empty($xref)) {
$recoveredXref = $this->recoverXrefWithoutStartxref($pdfData);
if (!empty($recoveredXref)) {
return $recoveredXref;
}

throw new \Exception('Unable to find xref');
}

return $xref;
}

/**
* Attempt to recover xref/trailer data when no valid startxref stanza exists.
*/
private function recoverXrefWithoutStartxref(string $pdfData): array
{
$trailerPos = strrpos($pdfData, 'trailer');
$recoveredOffset = null;

if (false !== $trailerPos) {
$searchStart = max(0, $trailerPos - 8192);
$searchChunk = substr($pdfData, $searchStart, $trailerPos - $searchStart);
$lastXrefPos = strrpos($searchChunk, 'xref');
if (false !== $lastXrefPos) {
$candidateOffset = $searchStart + $lastXrefPos;
if (
preg_match('/xref[\x09\x0a\x0c\x0d\x20]/', substr($pdfData, $candidateOffset, 5)) > 0
&& preg_match('/xref[\s]*[\r\n]+[0-9]+[\x20]+[0-9]+[\x20]*[\r\n]/A', substr($pdfData, $candidateOffset, 96)) > 0
) {
$recoveredOffset = $candidateOffset;
}
}
}

if (null !== $recoveredOffset) {
return $this->getXrefData($pdfData, $recoveredOffset);
}

$xref = ['xref' => [], 'trailer' => []];
if (
preg_match_all('/([0-9]+)[\x20]+([0-9]+)[\x20]+obj\b/i', $pdfData, $objMatches, \PREG_OFFSET_CAPTURE) > 0
) {
foreach ($objMatches[0] as $i => $fullMatch) {
$objNum = (int) $objMatches[1][$i][0];
$genNum = (int) $objMatches[2][$i][0];
$xref['xref'][$objNum.'_'.$genNum] = $fullMatch[1];
}

if (false !== $trailerPos) {
$trailerEnd = strpos($pdfData, '%%EOF', $trailerPos);
if (false === $trailerEnd) {
$trailerEnd = min(
\strlen($pdfData),
$trailerPos + 4096
);
}
$trailerData = substr($pdfData, $trailerPos, $trailerEnd - $trailerPos);

if (preg_match('/\/?Size[\s]+([0-9]+)/i', $trailerData, $matches) > 0) {
$xref['trailer']['size'] = (int) $matches[1];
}
if (preg_match('/\/?Root[\s]+([0-9]+)[\s]+([0-9]+)[\s]+R/i', $trailerData, $matches) > 0) {
$xref['trailer']['root'] = (int) $matches[1].'_'.(int) $matches[2];
}
if (preg_match('/\/?Encrypt[\s]+([0-9]+)[\s]+([0-9]+)[\s]+R/i', $trailerData, $matches) > 0) {
$xref['trailer']['encrypt'] = (int) $matches[1].'_'.(int) $matches[2];
}
if (preg_match('/\/?Info[\s]+([0-9]+)[\s]+([0-9]+)[\s]+R/i', $trailerData, $matches) > 0) {
$xref['trailer']['info'] = (int) $matches[1].'_'.(int) $matches[2];
}
if (preg_match('/ID[\s]*[\[]\s*[<]([^>]*)[>][\s]*[<]([^>]*)[>]/i', $trailerData, $matches) > 0) {
$xref['trailer']['id'] = [];
$xref['trailer']['id'][0] = $matches[1];
$xref['trailer']['id'][1] = $matches[2];
}
}
}

if (empty($xref['xref'])) {
return [];
}

if (!isset($xref['trailer']['size'])) {
$xref['trailer']['size'] = \count($xref['xref']) + 1;
}

return $xref;
}

/**
* Parses PDF data and returns extracted data as array.
*
Expand All @@ -964,8 +1095,9 @@ public function parseData(string $data): array
throw new MissingPdfHeaderException('Invalid PDF data: Missing `%PDF-` header.');
}

// get PDF content string
$pdfData = $trimpos > 0 ? substr($data, $trimpos) : $data;
// Keep the original byte layout to preserve absolute xref offsets.
// Some PDFs contain bytes before %PDF- and xref offsets still target the full file.
$pdfData = $data;

// get xref and trailer data
$xref = $this->getXrefData($pdfData);
Expand Down
45 changes: 45 additions & 0 deletions tests/PHPUnit/Integration/RawData/RawDataParserTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@

use PHPUnitTests\TestCase;
use Smalot\PdfParser\Config;
use Smalot\PdfParser\Parser;
use Smalot\PdfParser\RawData\RawDataParser;

class RawDataParserHelper extends RawDataParser
Expand Down Expand Up @@ -315,4 +316,48 @@ public function testGetXrefDataTracksVisitedOffsets(): void
$this->assertIsArray($result);
$this->assertEmpty($result);
}

/**
* Ensure parser resolves compressed object references from xref streams.
*
* @see https://github.com/smalot/pdfparser/pull/796
* @see https://github.com/veraPDF/veraPDF-corpus/blob/staging/PDF_A-1b/6.1%20File%20structure/6.1.2%20File%20header/veraPDF%20test%20suite%206-1-2-t01-fail-a.pdf
*/
public function testParseFileWithCompressedObjRefInXrefStream(): void
{
$document = (new Parser())->parseFile($this->rootDir.'/samples/bugs/PullRequestInvalidObjectReference.pdf');

self::assertCount(1, $document->getPages());
}

/**
* @see https://github.com/veraPDF/veraPDF-corpus/blob/staging/PDF_A-1b/6.1%20File%20structure/6.1.2%20File%20header/veraPDF%20test%20suite%206-1-2-t01-fail-a.pdf
*/
public function testParseFileWhenStartxrefPointsToLeadingWhitespaceInVeraPdfFixture(): void
{
$document = (new Parser())->parseFile($this->rootDir.'/samples/bugs/PullRequest797-vera.pdf');

self::assertCount(1, $document->getPages());
}

/**
* @see https://github.com/smalot/pdfparser/pull/797
* @see https://github.com/mozilla/pdf.js/blob/master/test/pdfs/issue9252.pdf
*/
public function testParseFileWithCompressedXrefObjectFromPdfJsCorpus(): void
{
$document = (new Parser())->parseFile($this->rootDir.'/samples/bugs/PullRequest797-pdf.js.pdf');

self::assertCount(1, $document->getPages());
}

/**
* @see https://github.com/mozilla/pdf.js/blob/master/test/pdfs/xref_command_missing.pdf
*/
public function testParseFileWhenXrefCommandIsMissingInPdfJsFixture(): void
{
$document = (new Parser())->parseFile($this->rootDir.'/samples/bugs/PullRequest815-xref-command-missing.pdf');

self::assertCount(1, $document->getPages());
}
}
Loading