fix: handle DOCX files with inconsistent ZIP filename casing (#1812)#2016
Open
lyydsheep wants to merge 1 commit into
Open
fix: handle DOCX files with inconsistent ZIP filename casing (#1812)#2016lyydsheep wants to merge 1 commit into
lyydsheep wants to merge 1 commit into
Conversation
…ft#1812) Some document generators (e.g. certain Microsoft Word versions, legal document systems) produce .docx files where the central directory records one casing (e.g. 'customXml/item2.xml') but the local file headers record another (e.g. 'customXML/item2.xml'). Python's zipfile module raises BadZipFile when reading such files. Add _fix_zip_filename_casing() to patch local file header filenames to match the central directory before any ZIP processing occurs.
Author
|
@microsoft-github-policy-service agree |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #1812 — DOCX files with inconsistent ZIP filename casing between central directory and local file headers cause
BadZipFileexceptions.Some document generators (e.g. certain Microsoft Word versions, legal document systems) produce
.docxfiles where the central directory records one casing (e.g.customXml/item2.xml) but the local file headers record another (e.g.customXML/item2.xml). Python'szipfilemodule raisesBadZipFilewhen reading such files.Root Cause
In
pre_process_docx(), line 140 callszip_input.read(name)for each file in the ZIP. Python'szipfilevalidates that the local file header filename matches the central directory entry at read time — a casing mismatch triggers:Fix
Add
_fix_zip_filename_casing()inpre_process.pythat:Called at the top of
pre_process_docx(), so the fix applies to all downstream consumers (DocxConverter, DocxConverterWithOCR).Test Plan
test_docx_zip_filename_casing_mismatch— corrupts a valid.docxby uppercasing local header names, verifieszipfile.BadZipFileis raised without the fix, and confirms MarkItDown produces identical output with the fixtest_docx_comments,test_docx_equations) still pass