v3.0.0 Encrypted document support, major text extraction updates

[PrinsFrank]

New Features

• Added support for encrypted PDFs
• New Text grouping algorithm: text with majority vertical overlap is considered part of the same line. Fixes subscript-superscript extraction issues.
• Several transformation matrix issues solved, fixing text extraction/ordering issues

💖 Sponsorship

If you depend on this package and want to support its maintenance, please consider sponsoring me. I'll continue maintaining and releasing updates regardless, but sponsorships help cover the time it takes to review changes and keep everything accurate.

Other changes

• Fix scale operand doesn't accept trailing 0 by @szepeviktor in Fix scale operand doesn't accept trailing 0 #303
• Dictionary entry for key Order can be of type ReferenceValueArray by @PrinsFrank in Dictionary entry for key Order can be of type ReferenceValueArray #316
• Value for dictionaryKey AP can be a single dictionary by @PrinsFrank in Value for dictionaryKey AP can be a single dictionary #319
• Automatically resolve values from subdictionaries when expected value type is not a dictionary by @PrinsFrank in Automatically resolve values from subdictionaries when expected value type is not a dictionary #321
• Simplify type checks XObject by @PrinsFrank in Simplify type checks XObject #322
• Implement value retrieval from ancestor nodes in page tree for inheritable properties by @PrinsFrank in Implement value retrieval from ancestor nodes in page tree for inheritable properties #323
• Automatically resolve references in dictionary entries when retrieving values by @PrinsFrank in Automatically resolve references in dictionary entries when retrieving values #325
• feat(rectangle): add width and height helpers by @vitormattos in feat(rectangle): add width and height helpers #317
• Fix invalid section reference for file encryption key calculation by @PrinsFrank in Fix invalid section reference for file encryption key calculation #327
• User password entry length should always be 32 regardless of security handler revision by @PrinsFrank in User password entry length should always be 32 regardless of security handler revision #328
• Add file encryption key to metadata for samples by @PrinsFrank in Add file encryption key to metadata for samples #329
• Enable support for encrypted documents by @PrinsFrank in Enable support for encrypted documents #282
• Add sample with user/owner password by @PrinsFrank in Add sample with user/owner password #332
• Add information about debugging file encryption to CONTRIBUTING.md by @PrinsFrank in Add information about debugging file encryption to CONTRIBUTING.md #333
• Add support for all escape sequences in literal strings by @PrinsFrank in Add support for all escape sequences in literal strings #334
• Support octals with one or two digits (next to support for three) in string literals by @PrinsFrank in Support octals with one or two digits (next to support for three) in string literals #335
• Clean up decoding of string literals and hex strings in EncryptDictionary and use getText instead by @PrinsFrank in Clean up decoding of string literals and hex strings in EncryptDictionary and use getText instead #336
• Fix improper handling of hex encoded binary strings in password entries by @PrinsFrank in Fix improper handling of hex encoded binary strings in password entries #337
• Update minimum required PHP version to 8.2 by @PrinsFrank in Update minimum required PHP version to 8.2 #338
• Switch from readonly properties to readonly classes wherever possible by @PrinsFrank in Switch from readonly properties to readonly classes wherever possible #339
• Check file encryption key for samples by @PrinsFrank in Check file encryption key for samples #330
• Add upgrade guide for v3 by @PrinsFrank in Add upgrade guide for v3 #340
• Document argument for getValueForKey on dictionary is now required by @PrinsFrank in Document argument for getValueForKey on dictionary is now required #341
• Recover userPassword from ownerPassword to also add support for ownerPasswords by @PrinsFrank in Recover userPassword from ownerPassword to also add support for ownerPasswords #343
• Cache calculated file encryption key on document by @PrinsFrank in Cache calculated file encryption key on document #344
• Fix newly discovered PHPStan issue by @PrinsFrank in Fix newly discovered PHPStan issue #346
• Update sponsorship section in README by @PrinsFrank in Update sponsorship section in README #345
• Properly parse hex strings by @PrinsFrank in Properly parse hex strings #348
• Decrypt dictionary entries while parsing dictionaries in encrypted documents by @PrinsFrank in Decrypt dictionary entries while parsing dictionaries in encrypted documents #347
• Decrypt content of compressed objects before parsing by @PrinsFrank in Decrypt content of compressed objects before parsing #349
• Replace escaped characters in encrypted strings before running decryption by @PrinsFrank in Replace escaped characters in encrypted strings before running decryption #350
• Check dictionary and page content for encrypted documents by @PrinsFrank in Check dictionary and page content for encrypted documents #342
• Add missing PNG predictor algorithms by @PrinsFrank in Add missing PNG predictor algorithms #351
• Flate decode columns should be multiplied by colors if present by @PrinsFrank in Flate decode columns should be multiplied by colors if present #352
• Ignore "endobj" markers in streams and search after length of stream dictionarymarker for it to allow for proper embedded PDF support by @PrinsFrank in Ignore "endobj" markers in streams and search after length of stream dictionarymarker for it to allow for proper embedded PDF support #296
• The resource dictionary is now inherited by @PrinsFrank in The resource dictionary is now inherited #353
• Add sample with different font sizes by @PrinsFrank in Add sample with different font sizes #354
• Abstract line grouping strategy to make it replaceable by @PrinsFrank in Abstract line grouping strategy to make it replaceable #355
• Fix incorrect matrix multiplication in Move and MoveOffsetLeading operators causing scrambled text by @PrinsFrank in Fix incorrect matrix multiplication in Move and MoveOffsetLeading operators causing scrambled text #356
• Apply transformation for NEXT_LINE Text positioning operator by @PrinsFrank in Apply transformation for NEXT_LINE Text positioning operator #358
• Add new overlap grouping strategy for text by @PrinsFrank in Add new overlap grouping strategy for text #357
• Fix initial text state not being set and appended/restored from stack resulting in lost textObjects by @PrinsFrank in Fix initial text state not being set and appended/restored from stack resulting in lost textObjects #359
• Added sample file for [Bug]: Text looks "cut up" (e.g. letters are missing) #272 by @k00ni in Added sample file for #272 #273
• Fix issues with operators that interact with both text state and transformation matrix by @PrinsFrank in Fix issues with operators that interact with both text state and transformation matrix #360
• Fix incorrect inverse matrix multiplication in graphicsStateOperator by @PrinsFrank in Fix incorrect inverse matrix multiplication in graphicsStateOperator #361
• Handle text extraction with inverted Y-axis by @PrinsFrank in Handle text extraction with inverted Y-axis #362
• Use LineFeed as default page separator when extracting text for multiple pages by @PrinsFrank in Use LineFeed as default page separator when extracting text for multiple pages #363
• Add sample from issue [Bug]: Text parts misplaced and mixed up #290 by @PrinsFrank in Add sample from issue #290 #364
• Properly support encrypted documents in sample generation by @PrinsFrank in Properly support encrypted documents in sample generation #365
• Move CONTRIBUTING.md to root of project by @PrinsFrank in Move CONTRIBUTING.md to root of project #366
• FontReference can be any non-whitespace character by @PrinsFrank in FontReference can be any non-whitespace character #368
• Add benchmark comparison image to README.md by @PrinsFrank in Add benchmark comparison image to README.md #369
• Don't traverse loop nodes in page trees by @PrinsFrank in Don't traverse loop nodes in page trees #370
• Support PAGE objects without CONTENTS by @PrinsFrank in Support PAGE objects without CONTENTS #372
• Support NameValues in toUnicodeCMap dictionary entries for font objects by @PrinsFrank in Support NameValues in toUnicodeCMap dictionary entries for font objects #373
• Fix reference value array parsing when nr of items is divisible by 3 but items are not references by @PrinsFrank in Fix reference value array parsing when nr of items is divisible by 3 but items are not references #374
• Gracefully handle empty streams by @PrinsFrank in Gracefully handle empty streams #375
• Gracefully handle only newlines between stream markers by @PrinsFrank in Gracefully handle only newlines between stream markers #376
• Universal reference value support now that auto resolving of references is implemented by @PrinsFrank in Universal reference value support now that auto resolving of references is implemented #377
• Handle empty crossReference types by @PrinsFrank in Handle empty crossReference types #378
• Add support for ASCIIHexDecode by @PrinsFrank in Add support for ASCIIHexDecode #380
• Properly handle object content that is not surrounded by newlines by @PrinsFrank in Properly handle object content that is not surrounded by newlines #379
• Encoding can be name values by @PrinsFrank in Encoding can be name values #381
• Gracefully handle multiple end operators for text objects by @PrinsFrank in Gracefully handle multiple end operators for text objects #382
• Extend auto resolving of reference value to nameValues and dictionaries by @PrinsFrank in Extend auto resolving of reference value to nameValues and dictionaries #383
• Update description in composer.json by @PrinsFrank in Update description in composer.json #384
• Fix parsing of comments in content streams by @PrinsFrank in Fix parsing of comments in content streams #385
• Parsing ReferenceArrayValues in ArrayValues should preserve outside brackets by @PrinsFrank in Parsing ReferenceArrayValues in ArrayValues should preserve outside brackets #386
• Fix issues in retrieval of object content for uncompressed objects with content on the same line as start of object marker by @PrinsFrank in Fix issues in retrieval of object content for uncompressed objects with content on the same line as start of object marker #387
• Ignore comments before text objects by @PrinsFrank in Ignore comments before text objects #388
• Auto resolve Reference value arrays by @PrinsFrank in Auto resolve Reference value arrays #389
• Add sample from issue [Bug]: Extracted text is not readable #215 by @PrinsFrank in Add sample from issue #215 #390
• CIDFontWidths can be empty by @PrinsFrank in CIDFontWidths can be empty #391

New Contributors

• @vitormattos made their first contribution in feat(rectangle): add width and height helpers #317

Full Changelog: v2.8.0...v3.0.0

---

This discussion was created from the release v3.0.0 Encrypted document support, major text extraction updates.

[k00ni]

Congrats and thank you for this release. 🚀