1"""Unpack Office files (DOCX, PPTX, XLSX) for editing.
2 
3Extracts the ZIP archive, pretty-prints XML files, and optionally:
4- Merges adjacent runs with identical formatting (DOCX only)
5- Simplifies adjacent tracked changes from same author (DOCX only)
6 
7Usage:
8    python unpack.py <office_file> <output_dir> [options]
9 
10Examples:
11    python unpack.py document.docx unpacked/
12    python unpack.py presentation.pptx unpacked/
13    python unpack.py document.docx unpacked/ --merge-runs false
14"""
15 
16import argparse
17import sys
18import zipfile
19from pathlib import Path
20 
21import defusedxml.minidom
22 
23from helpers.merge_runs import merge_runs as do_merge_runs
24from helpers.simplify_redlines import simplify_redlines as do_simplify_redlines
25 
26SMART_QUOTE_REPLACEMENTS = {
27    "\u201c": "&#x201C;",  
28    "\u201d": "&#x201D;",  
29    "\u2018": "&#x2018;",  
30    "\u2019": "&#x2019;",  
31}
32 
33 
34def unpack(
35    input_file: str,
36    output_directory: str,
37    merge_runs: bool = True,
38    simplify_redlines: bool = True,
39) -> tuple[None, str]:
40    input_path = Path(input_file)
41    output_path = Path(output_directory)
42    suffix = input_path.suffix.lower()
43 
44    if not input_path.exists():
45        return None, f"Error: {input_file} does not exist"
46 
47    if suffix not in {".docx", ".pptx", ".xlsx"}:
48        return None, f"Error: {input_file} must be a .docx, .pptx, or .xlsx file"
49 
50    try:
51        output_path.mkdir(parents=True, exist_ok=True)
52 
53        with zipfile.ZipFile(input_path, "r") as zf:
54            zf.extractall(output_path)
55 
56        xml_files = list(output_path.rglob("*.xml")) + list(output_path.rglob("*.rels"))
57        for xml_file in xml_files:
58            _pretty_print_xml(xml_file)
59 
60        message = f"Unpacked {input_file} ({len(xml_files)} XML files)"
61 
62        if suffix == ".docx":
63            if simplify_redlines:
64                simplify_count, _ = do_simplify_redlines(str(output_path))
65                message += f", simplified {simplify_count} tracked changes"
66 
67            if merge_runs:
68                merge_count, _ = do_merge_runs(str(output_path))
69                message += f", merged {merge_count} runs"
70 
71        for xml_file in xml_files:
72            _escape_smart_quotes(xml_file)
73 
74        return None, message
75 
76    except zipfile.BadZipFile:
77        return None, f"Error: {input_file} is not a valid Office file"
78    except Exception as e:
79        return None, f"Error unpacking: {e}"
80 
81 
82def _pretty_print_xml(xml_file: Path) -> None:
83    try:
84        content = xml_file.read_text(encoding="utf-8")
85        dom = defusedxml.minidom.parseString(content)
86        xml_file.write_bytes(dom.toprettyxml(indent="  ", encoding="utf-8"))
87    except Exception:
88        pass  
89 
90 
91def _escape_smart_quotes(xml_file: Path) -> None:
92    try:
93        content = xml_file.read_text(encoding="utf-8")
94        for char, entity in SMART_QUOTE_REPLACEMENTS.items():
95            content = content.replace(char, entity)
96        xml_file.write_text(content, encoding="utf-8")
97    except Exception:
98        pass
99 
100 
101if __name__ == "__main__":
102    parser = argparse.ArgumentParser(
103        description="Unpack an Office file (DOCX, PPTX, XLSX) for editing"
104    )
105    parser.add_argument("input_file", help="Office file to unpack")
106    parser.add_argument("output_directory", help="Output directory")
107    parser.add_argument(
108        "--merge-runs",
109        type=lambda x: x.lower() == "true",
110        default=True,
111        metavar="true|false",
112        help="Merge adjacent runs with identical formatting (DOCX only, default: true)",
113    )
114    parser.add_argument(
115        "--simplify-redlines",
116        type=lambda x: x.lower() == "true",
117        default=True,
118        metavar="true|false",
119        help="Merge adjacent tracked changes from same author (DOCX only, default: true)",
120    )
121    args = parser.parse_args()
122 
123    _, message = unpack(
124        args.input_file,
125        args.output_directory,
126        merge_runs=args.merge_runs,
127        simplify_redlines=args.simplify_redlines,
128    )
129    print(message)
130 
131    if "Error" in message:
132        sys.exit(1)
133