Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Read XMP Metadata and add it to data returned by getDetails() #606

Merged
merged 19 commits into from
Jul 4, 2023
+162 −2
Merged

Read XMP Metadata and add it to data returned by getDetails() #606

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
320781d
Read XMP Metadata
GreyWyvern Jun 22, 2023
72fdc5b
Update Document.php
GreyWyvern Jun 22, 2023
aff2bb2
get => extract
GreyWyvern Jun 23, 2023
2af4b8c
Add XMP_Metadata.pdf sample file
GreyWyvern Jun 23, 2023
9f802d1
PHP-CS-Fixer edits
GreyWyvern Jun 23, 2023
f560110
Add testExtractXMPMetadata() unit test
GreyWyvern Jun 26, 2023
40e6cf4
Update testExtractXMPMetadata()
GreyWyvern Jun 26, 2023
cfb7d1f
Remove Exception class, not used.
GreyWyvern Jun 27, 2023
b2bd543
fixes coding style issue in EncodingTest.php
k00ni Jun 28, 2023
b80de6c
Update Document.php
k00ni Jun 28, 2023
fd137ef
Update DocumentTest.php
k00ni Jun 28, 2023
7a6b9d7
Add XMP values, don't overwrite
GreyWyvern Jun 30, 2023
2160bd7
Only save application/pdf XMP metadata
GreyWyvern Jun 30, 2023
5bf3d0a
Update Usage.md
GreyWyvern Jun 30, 2023
56f8224
Only apply list simplification for strings.
GreyWyvern Jun 30, 2023
f78fdf6
Update Document.php
GreyWyvern Jul 3, 2023
61abfdc
Document.php: added short description
k00ni Jul 4, 2023
5f604e7
fixed coding style issues
k00ni Jul 4, 2023
8ea4b65
Update Document.php
k00ni Jul 4, 2023
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
34 changes: 34 additions & 0 deletions doc/Usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,17 +132,51 @@ $width = $font->calculateTextWidth($text, $missing);

You can also extract metadata. The available data varies from PDF to PDF.

Data taken from an Extensible Metadata Platform (XMP) XML block will have their key values prefixed with an XML tag namespace. You can read more about what values are available in the [XMP Specifications](https://github.com/adobe/XMP-Toolkit-SDK/tree/main/docs).

```php
$metaData = $pdf->getDetails();

Array
(
[Creator] => Adobe Acrobat
[Producer] => Adobe Acrobat
[CreatedOn] => 2022-01-28T16:36:11+00:00
[Pages] => 35
[dc:creator] => My Name
[pdf:producer] => Adobe Acrobat
[dc:title] => My Document Title
...
)
```

Some XMP metadata values may have multiple values, or even named children with their own values. In these cases, the value will be an array. The XMP metadata will follow the structure of the XML so it is possible to have multiple levels of nested values.

```php
$metaData = $pdf->getDetails();

Array
(
...
[dc:title] => My Document Title
[xmptpg:maxpagesize] => Array
(
[stdim:w] => 21.500000
[stdim:h] => 6.222222
[stdim:unit] => Inches
)
[xmptpg:platenames] => Array
(
[0] => Cyan
[1] => Magenta
[2] => Yellow
[3] => Black
)
...
)
```


## Read Base64 encoded PDFs

If working with [Base64](https://en.wikipedia.org/wiki/Base64) encoded PDFs, you might want to parse the PDF without saving the file to disk.
Expand Down
129 changes: 53 additions & 76 deletions src/Smalot/PdfParser/Document.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,100 +163,77 @@ public function extractXMPMetadata(string $content): void
xml_parser_set_option($xml, \XML_OPTION_SKIP_WHITE, 1);

if (xml_parse_into_struct($xml, $content, $values, $index)) {
GreyWyvern marked this conversation as resolved.
Show resolved Hide resolved
$detail = '';

$metadata = [];
$stack = [];
foreach ($values as $val) {
switch ($val['tag']) {
case 'DC:CREATOR':
$detail = ('open' == $val['type']) ? 'Author' : '';
break;

case 'DC:DESCRIPTION':
$detail = ('open' == $val['type']) ? 'Description' : '';
break;

case 'DC:TITLE':
$detail = ('open' == $val['type']) ? 'Title' : '';
break;

case 'DC:SUBJECT':
$detail = ('open' == $val['type']) ? 'Subject' : '';
break;

case 'RDF:LI':
if ('' !== $detail && 'complete' == $val['type'] && isset($val['value'])) {
$this->metadata[$detail] = $val['value'];
}
break;

case 'DC:FORMAT':
if ('complete' == $val['type'] && isset($val['value'])) {
$this->metadata['Format'] = $val['value'];
// Standardize to lowercase
$val['tag'] = strtolower($val['tag']);

// Ignore structural x: and rdf: XML elements
if (strpos($val['tag'], 'x:') === 0) continue;
if (strpos($val['tag'], 'rdf:') === 0 && 'rdf:li' != $val['tag']) continue;
GreyWyvern marked this conversation as resolved.
Show resolved Hide resolved

switch ($val['type']) {
case 'open':
// Create an array of list items
if ('rdf:li' == $val['tag']) {
$metadata[] = [];

// Move up one level in the stack
$stack[count($stack)] = &$metadata;
$metadata = &$metadata[count($metadata) - 1];
k00ni marked this conversation as resolved.
Show resolved Hide resolved

// Else create an array of named values
} else {
$metadata[$val['tag']] = [];

// Move up one level in the stack
$stack[count($stack)] = &$metadata;
$metadata = &$metadata[$val['tag']];
}
break;

case 'PDF:KEYWORDS':
if ('complete' == $val['type'] && isset($val['value'])) {
$this->metadata['Keywords'] = $val['value'];
}
break;
case 'complete':
if (isset($val['value'])) {

case 'PDF:PRODUCER':
if ('complete' == $val['type'] && isset($val['value'])) {
$this->metadata['Producer'] = $val['value'];
}
break;
// Assign a value to this list item
if ('rdf:li' == $val['tag']) {
$metadata[] = $val['value'];

case 'PDFX:SOURCEMODIFIED':
if ('complete' == $val['type'] && isset($val['value'])) {
$this->metadata['SourceModified'] = $val['value'];
// Else assign a value to this property
} else {
$metadata[$val['tag']] = $val['value'];
}
}
break;

case 'PDFX:COMPANY':
if ('complete' == $val['type'] && isset($val['value'])) {
$this->metadata['Company'] = $val['value'];
case 'close':
// If the value of this item is a single element
// array of just one list item, use the value of
// the first list item as the value for this
// property
if (is_array($metadata) && isset($metadata[0]) && count($metadata) == 1) {
$metadata = $metadata[0];
}
break;

case 'XMP:CREATEDATE':
if ('complete' == $val['type'] && isset($val['value'])) {
$this->metadata['CreationDate'] = $val['value'];
}
// Move down one level in the stack
$metadata = &$stack[count($stack) - 1];
unset($stack[count($stack) - 1]);
break;

case 'XMP:CREATORTOOL':
if ('complete' == $val['type'] && isset($val['value'])) {
$this->metadata['Creator'] = $val['value'];
}
break;

case 'XMP:MODIFYDATE':
if ('complete' == $val['type'] && isset($val['value'])) {
$this->metadata['ModDate'] = $val['value'];
}
break;

case 'XMP:METADATADATE':
if ('complete' == $val['type'] && isset($val['value'])) {
$this->metadata['MetadataDate'] = $val['value'];
}
break;

case 'XMPMM:DOCUMENTID':
if ('complete' == $val['type'] && isset($val['value'])) {
$this->metadata['DocumentUUID'] = $val['value'];
}
break;

case 'XMPMM:INSTANCEID':
if ('complete' == $val['type'] && isset($val['value'])) {
$this->metadata['InstanceUUID'] = $val['value'];
}
break;
}
}

// According to the XMP specifications: 'Conflict resolution
// for separate packets that describe the same resource is
// beyond the scope of this document.' - Section 6.1
GreyWyvern marked this conversation as resolved.
Show resolved Hide resolved
// So if there are multiple XMP blocks, just merge the values
// of each found block over top of the existing values
$this->metadata = array_merge($this->metadata, $metadata);
}
xml_parser_free($xml);
}

public function getDictionary(): array
Expand Down
34 changes: 5 additions & 29 deletions tests/PHPUnit/Integration/DocumentTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -265,34 +265,10 @@ public function testExtractXMPMetadata(): void
{
$document = (new Parser())->parseFile($this->rootDir.'/samples/XMP_Metadata.pdf');

// Get the original parsed details from getHeader().
$ref = new \ReflectionClass('\Smalot\PdfParser\Document');
$prop = $ref->getProperty('trailer');
$prop->setAccessible(true);
$trailer = $prop->getValue($document);
$details = [];

if ($trailer->has('Info')) {
$info = $trailer->get('Info');
if (null !== $info && method_exists($info, 'getHeader')) {
$details = $info->getHeader()->getDetails();
}
}

// Check that the Title does not contain a Right Single
// Quotation Mark, a high UTF-8 glyph that cannot be encoded in
// ISO-8859-1 and is replaced by an uninterpretable UTF-8
// control character.
self::assertStringNotContainsString("\u{2019}", $details['Title']);

$detailsXMP = $document->getDetails();

// Test that the correct Right Single Quotation Mark glyph was
// extracted from the XMP Metadata.
self::assertStringContainsString("Enhance PdfParser\u{2019}s Metadata Capabilities", $detailsXMP['Title']);

// Test that getDetails() data NOT contained in the XMP Metadata
// is still accessible and not discarded/overwritten.
self::assertEquals(1, $detailsXMP['Pages']);
$details = $document->getDetails();

// Test that the dc:title data was extracted from the XMP
// Metadata.
self::assertStringContainsString("Enhance PdfParser\u{2019}s Metadata Capabilities", $details['dc:title']);
}
}