kreuzberg 4.0.0.rc1 → 4.0.0.rc2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (342) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +14 -8
  3. data/.rspec +3 -3
  4. data/.rubocop.yaml +1 -534
  5. data/.rubocop.yml +538 -0
  6. data/Gemfile +8 -9
  7. data/Gemfile.lock +9 -109
  8. data/README.md +426 -421
  9. data/Rakefile +25 -25
  10. data/Steepfile +47 -47
  11. data/examples/async_patterns.rb +341 -340
  12. data/ext/kreuzberg_rb/extconf.rb +45 -35
  13. data/ext/kreuzberg_rb/native/Cargo.lock +6535 -0
  14. data/ext/kreuzberg_rb/native/Cargo.toml +44 -36
  15. data/ext/kreuzberg_rb/native/README.md +425 -425
  16. data/ext/kreuzberg_rb/native/build.rs +15 -17
  17. data/ext/kreuzberg_rb/native/include/ieeefp.h +11 -11
  18. data/ext/kreuzberg_rb/native/include/msvc_compat/strings.h +14 -14
  19. data/ext/kreuzberg_rb/native/include/strings.h +20 -20
  20. data/ext/kreuzberg_rb/native/include/unistd.h +47 -47
  21. data/ext/kreuzberg_rb/native/src/lib.rs +2998 -2939
  22. data/extconf.rb +28 -28
  23. data/kreuzberg.gemspec +148 -105
  24. data/lib/kreuzberg/api_proxy.rb +142 -142
  25. data/lib/kreuzberg/cache_api.rb +46 -45
  26. data/lib/kreuzberg/cli.rb +55 -55
  27. data/lib/kreuzberg/cli_proxy.rb +127 -127
  28. data/lib/kreuzberg/config.rb +691 -684
  29. data/lib/kreuzberg/error_context.rb +32 -0
  30. data/lib/kreuzberg/errors.rb +118 -50
  31. data/lib/kreuzberg/extraction_api.rb +85 -84
  32. data/lib/kreuzberg/mcp_proxy.rb +186 -186
  33. data/lib/kreuzberg/ocr_backend_protocol.rb +113 -113
  34. data/lib/kreuzberg/post_processor_protocol.rb +86 -86
  35. data/lib/kreuzberg/result.rb +216 -216
  36. data/lib/kreuzberg/setup_lib_path.rb +80 -79
  37. data/lib/kreuzberg/validator_protocol.rb +89 -89
  38. data/lib/kreuzberg/version.rb +5 -5
  39. data/lib/kreuzberg.rb +103 -82
  40. data/sig/kreuzberg/internal.rbs +184 -184
  41. data/sig/kreuzberg.rbs +520 -468
  42. data/spec/binding/cache_spec.rb +227 -227
  43. data/spec/binding/cli_proxy_spec.rb +85 -87
  44. data/spec/binding/cli_spec.rb +55 -54
  45. data/spec/binding/config_spec.rb +345 -345
  46. data/spec/binding/config_validation_spec.rb +283 -283
  47. data/spec/binding/error_handling_spec.rb +213 -213
  48. data/spec/binding/errors_spec.rb +66 -66
  49. data/spec/binding/plugins/ocr_backend_spec.rb +307 -307
  50. data/spec/binding/plugins/postprocessor_spec.rb +269 -269
  51. data/spec/binding/plugins/validator_spec.rb +274 -274
  52. data/spec/fixtures/config.toml +39 -39
  53. data/spec/fixtures/config.yaml +41 -42
  54. data/spec/fixtures/invalid_config.toml +4 -4
  55. data/spec/smoke/package_spec.rb +178 -178
  56. data/spec/spec_helper.rb +42 -42
  57. data/vendor/kreuzberg/Cargo.toml +204 -134
  58. data/vendor/kreuzberg/README.md +175 -175
  59. data/vendor/kreuzberg/benches/otel_overhead.rs +48 -0
  60. data/vendor/kreuzberg/build.rs +474 -460
  61. data/vendor/kreuzberg/src/api/error.rs +81 -81
  62. data/vendor/kreuzberg/src/api/handlers.rs +199 -199
  63. data/vendor/kreuzberg/src/api/mod.rs +79 -79
  64. data/vendor/kreuzberg/src/api/server.rs +353 -353
  65. data/vendor/kreuzberg/src/api/types.rs +170 -170
  66. data/vendor/kreuzberg/src/cache/mod.rs +1167 -1143
  67. data/vendor/kreuzberg/src/chunking/mod.rs +677 -677
  68. data/vendor/kreuzberg/src/core/batch_mode.rs +95 -35
  69. data/vendor/kreuzberg/src/core/config.rs +1032 -1032
  70. data/vendor/kreuzberg/src/core/extractor.rs +1024 -903
  71. data/vendor/kreuzberg/src/core/io.rs +329 -327
  72. data/vendor/kreuzberg/src/core/mime.rs +605 -615
  73. data/vendor/kreuzberg/src/core/mod.rs +45 -42
  74. data/vendor/kreuzberg/src/core/pipeline.rs +984 -906
  75. data/vendor/kreuzberg/src/embeddings.rs +432 -323
  76. data/vendor/kreuzberg/src/error.rs +431 -431
  77. data/vendor/kreuzberg/src/extraction/archive.rs +954 -954
  78. data/vendor/kreuzberg/src/extraction/docx.rs +40 -40
  79. data/vendor/kreuzberg/src/extraction/email.rs +854 -854
  80. data/vendor/kreuzberg/src/extraction/excel.rs +688 -688
  81. data/vendor/kreuzberg/src/extraction/html.rs +553 -553
  82. data/vendor/kreuzberg/src/extraction/image.rs +368 -368
  83. data/vendor/kreuzberg/src/extraction/libreoffice.rs +563 -564
  84. data/vendor/kreuzberg/src/extraction/markdown.rs +213 -0
  85. data/vendor/kreuzberg/src/extraction/mod.rs +81 -77
  86. data/vendor/kreuzberg/src/extraction/office_metadata/app_properties.rs +398 -398
  87. data/vendor/kreuzberg/src/extraction/office_metadata/core_properties.rs +247 -247
  88. data/vendor/kreuzberg/src/extraction/office_metadata/custom_properties.rs +240 -240
  89. data/vendor/kreuzberg/src/extraction/office_metadata/mod.rs +130 -128
  90. data/vendor/kreuzberg/src/extraction/office_metadata/odt_properties.rs +287 -0
  91. data/vendor/kreuzberg/src/extraction/pptx.rs +3000 -3000
  92. data/vendor/kreuzberg/src/extraction/structured.rs +490 -490
  93. data/vendor/kreuzberg/src/extraction/table.rs +328 -328
  94. data/vendor/kreuzberg/src/extraction/text.rs +269 -269
  95. data/vendor/kreuzberg/src/extraction/xml.rs +333 -333
  96. data/vendor/kreuzberg/src/extractors/archive.rs +446 -425
  97. data/vendor/kreuzberg/src/extractors/bibtex.rs +469 -0
  98. data/vendor/kreuzberg/src/extractors/docbook.rs +502 -0
  99. data/vendor/kreuzberg/src/extractors/docx.rs +367 -479
  100. data/vendor/kreuzberg/src/extractors/email.rs +143 -129
  101. data/vendor/kreuzberg/src/extractors/epub.rs +707 -0
  102. data/vendor/kreuzberg/src/extractors/excel.rs +343 -344
  103. data/vendor/kreuzberg/src/extractors/fictionbook.rs +491 -0
  104. data/vendor/kreuzberg/src/extractors/fictionbook.rs.backup2 +738 -0
  105. data/vendor/kreuzberg/src/extractors/html.rs +393 -410
  106. data/vendor/kreuzberg/src/extractors/image.rs +198 -195
  107. data/vendor/kreuzberg/src/extractors/jats.rs +1051 -0
  108. data/vendor/kreuzberg/src/extractors/jupyter.rs +367 -0
  109. data/vendor/kreuzberg/src/extractors/latex.rs +652 -0
  110. data/vendor/kreuzberg/src/extractors/markdown.rs +700 -0
  111. data/vendor/kreuzberg/src/extractors/mod.rs +365 -268
  112. data/vendor/kreuzberg/src/extractors/odt.rs +628 -0
  113. data/vendor/kreuzberg/src/extractors/opml.rs +634 -0
  114. data/vendor/kreuzberg/src/extractors/orgmode.rs +528 -0
  115. data/vendor/kreuzberg/src/extractors/pdf.rs +493 -496
  116. data/vendor/kreuzberg/src/extractors/pptx.rs +248 -234
  117. data/vendor/kreuzberg/src/extractors/rst.rs +576 -0
  118. data/vendor/kreuzberg/src/extractors/rtf.rs +810 -0
  119. data/vendor/kreuzberg/src/extractors/security.rs +484 -0
  120. data/vendor/kreuzberg/src/extractors/security_tests.rs +367 -0
  121. data/vendor/kreuzberg/src/extractors/structured.rs +140 -126
  122. data/vendor/kreuzberg/src/extractors/text.rs +260 -242
  123. data/vendor/kreuzberg/src/extractors/typst.rs +650 -0
  124. data/vendor/kreuzberg/src/extractors/xml.rs +135 -128
  125. data/vendor/kreuzberg/src/image/dpi.rs +164 -164
  126. data/vendor/kreuzberg/src/image/mod.rs +6 -6
  127. data/vendor/kreuzberg/src/image/preprocessing.rs +417 -417
  128. data/vendor/kreuzberg/src/image/resize.rs +89 -89
  129. data/vendor/kreuzberg/src/keywords/config.rs +154 -154
  130. data/vendor/kreuzberg/src/keywords/mod.rs +237 -237
  131. data/vendor/kreuzberg/src/keywords/processor.rs +267 -267
  132. data/vendor/kreuzberg/src/keywords/rake.rs +293 -294
  133. data/vendor/kreuzberg/src/keywords/types.rs +68 -68
  134. data/vendor/kreuzberg/src/keywords/yake.rs +163 -163
  135. data/vendor/kreuzberg/src/language_detection/mod.rs +942 -942
  136. data/vendor/kreuzberg/src/lib.rs +105 -102
  137. data/vendor/kreuzberg/src/mcp/mod.rs +32 -32
  138. data/vendor/kreuzberg/src/mcp/server.rs +1968 -1966
  139. data/vendor/kreuzberg/src/ocr/cache.rs +469 -469
  140. data/vendor/kreuzberg/src/ocr/error.rs +37 -37
  141. data/vendor/kreuzberg/src/ocr/hocr.rs +216 -216
  142. data/vendor/kreuzberg/src/ocr/mod.rs +58 -58
  143. data/vendor/kreuzberg/src/ocr/processor.rs +863 -847
  144. data/vendor/kreuzberg/src/ocr/table/mod.rs +4 -4
  145. data/vendor/kreuzberg/src/ocr/table/tsv_parser.rs +144 -144
  146. data/vendor/kreuzberg/src/ocr/tesseract_backend.rs +450 -450
  147. data/vendor/kreuzberg/src/ocr/types.rs +393 -393
  148. data/vendor/kreuzberg/src/ocr/utils.rs +47 -47
  149. data/vendor/kreuzberg/src/ocr/validation.rs +206 -206
  150. data/vendor/kreuzberg/src/panic_context.rs +154 -0
  151. data/vendor/kreuzberg/src/pdf/error.rs +122 -122
  152. data/vendor/kreuzberg/src/pdf/images.rs +139 -139
  153. data/vendor/kreuzberg/src/pdf/metadata.rs +346 -346
  154. data/vendor/kreuzberg/src/pdf/mod.rs +50 -50
  155. data/vendor/kreuzberg/src/pdf/rendering.rs +369 -369
  156. data/vendor/kreuzberg/src/pdf/table.rs +393 -420
  157. data/vendor/kreuzberg/src/pdf/text.rs +158 -161
  158. data/vendor/kreuzberg/src/plugins/extractor.rs +1013 -1010
  159. data/vendor/kreuzberg/src/plugins/mod.rs +209 -209
  160. data/vendor/kreuzberg/src/plugins/ocr.rs +620 -629
  161. data/vendor/kreuzberg/src/plugins/processor.rs +642 -641
  162. data/vendor/kreuzberg/src/plugins/registry.rs +1337 -1324
  163. data/vendor/kreuzberg/src/plugins/traits.rs +258 -258
  164. data/vendor/kreuzberg/src/plugins/validator.rs +956 -955
  165. data/vendor/kreuzberg/src/stopwords/mod.rs +1470 -1470
  166. data/vendor/kreuzberg/src/text/mod.rs +19 -19
  167. data/vendor/kreuzberg/src/text/quality.rs +697 -697
  168. data/vendor/kreuzberg/src/text/string_utils.rs +217 -217
  169. data/vendor/kreuzberg/src/text/token_reduction/cjk_utils.rs +164 -164
  170. data/vendor/kreuzberg/src/text/token_reduction/config.rs +100 -100
  171. data/vendor/kreuzberg/src/text/token_reduction/core.rs +796 -796
  172. data/vendor/kreuzberg/src/text/token_reduction/filters.rs +902 -902
  173. data/vendor/kreuzberg/src/text/token_reduction/mod.rs +160 -160
  174. data/vendor/kreuzberg/src/text/token_reduction/semantic.rs +619 -619
  175. data/vendor/kreuzberg/src/text/token_reduction/simd_text.rs +147 -147
  176. data/vendor/kreuzberg/src/types.rs +903 -873
  177. data/vendor/kreuzberg/src/utils/mod.rs +17 -17
  178. data/vendor/kreuzberg/src/utils/quality.rs +959 -959
  179. data/vendor/kreuzberg/src/utils/string_utils.rs +381 -381
  180. data/vendor/kreuzberg/stopwords/af_stopwords.json +53 -53
  181. data/vendor/kreuzberg/stopwords/ar_stopwords.json +482 -482
  182. data/vendor/kreuzberg/stopwords/bg_stopwords.json +261 -261
  183. data/vendor/kreuzberg/stopwords/bn_stopwords.json +400 -400
  184. data/vendor/kreuzberg/stopwords/br_stopwords.json +1205 -1205
  185. data/vendor/kreuzberg/stopwords/ca_stopwords.json +280 -280
  186. data/vendor/kreuzberg/stopwords/cs_stopwords.json +425 -425
  187. data/vendor/kreuzberg/stopwords/da_stopwords.json +172 -172
  188. data/vendor/kreuzberg/stopwords/de_stopwords.json +622 -622
  189. data/vendor/kreuzberg/stopwords/el_stopwords.json +849 -849
  190. data/vendor/kreuzberg/stopwords/en_stopwords.json +1300 -1300
  191. data/vendor/kreuzberg/stopwords/eo_stopwords.json +175 -175
  192. data/vendor/kreuzberg/stopwords/es_stopwords.json +734 -734
  193. data/vendor/kreuzberg/stopwords/et_stopwords.json +37 -37
  194. data/vendor/kreuzberg/stopwords/eu_stopwords.json +100 -100
  195. data/vendor/kreuzberg/stopwords/fa_stopwords.json +801 -801
  196. data/vendor/kreuzberg/stopwords/fi_stopwords.json +849 -849
  197. data/vendor/kreuzberg/stopwords/fr_stopwords.json +693 -693
  198. data/vendor/kreuzberg/stopwords/ga_stopwords.json +111 -111
  199. data/vendor/kreuzberg/stopwords/gl_stopwords.json +162 -162
  200. data/vendor/kreuzberg/stopwords/gu_stopwords.json +226 -226
  201. data/vendor/kreuzberg/stopwords/ha_stopwords.json +41 -41
  202. data/vendor/kreuzberg/stopwords/he_stopwords.json +196 -196
  203. data/vendor/kreuzberg/stopwords/hi_stopwords.json +227 -227
  204. data/vendor/kreuzberg/stopwords/hr_stopwords.json +181 -181
  205. data/vendor/kreuzberg/stopwords/hu_stopwords.json +791 -791
  206. data/vendor/kreuzberg/stopwords/hy_stopwords.json +47 -47
  207. data/vendor/kreuzberg/stopwords/id_stopwords.json +760 -760
  208. data/vendor/kreuzberg/stopwords/it_stopwords.json +634 -634
  209. data/vendor/kreuzberg/stopwords/ja_stopwords.json +136 -136
  210. data/vendor/kreuzberg/stopwords/kn_stopwords.json +84 -84
  211. data/vendor/kreuzberg/stopwords/ko_stopwords.json +681 -681
  212. data/vendor/kreuzberg/stopwords/ku_stopwords.json +64 -64
  213. data/vendor/kreuzberg/stopwords/la_stopwords.json +51 -51
  214. data/vendor/kreuzberg/stopwords/lt_stopwords.json +476 -476
  215. data/vendor/kreuzberg/stopwords/lv_stopwords.json +163 -163
  216. data/vendor/kreuzberg/stopwords/ml_stopwords.json +1 -1
  217. data/vendor/kreuzberg/stopwords/mr_stopwords.json +101 -101
  218. data/vendor/kreuzberg/stopwords/ms_stopwords.json +477 -477
  219. data/vendor/kreuzberg/stopwords/ne_stopwords.json +490 -490
  220. data/vendor/kreuzberg/stopwords/nl_stopwords.json +415 -415
  221. data/vendor/kreuzberg/stopwords/no_stopwords.json +223 -223
  222. data/vendor/kreuzberg/stopwords/pl_stopwords.json +331 -331
  223. data/vendor/kreuzberg/stopwords/pt_stopwords.json +562 -562
  224. data/vendor/kreuzberg/stopwords/ro_stopwords.json +436 -436
  225. data/vendor/kreuzberg/stopwords/ru_stopwords.json +561 -561
  226. data/vendor/kreuzberg/stopwords/si_stopwords.json +193 -193
  227. data/vendor/kreuzberg/stopwords/sk_stopwords.json +420 -420
  228. data/vendor/kreuzberg/stopwords/sl_stopwords.json +448 -448
  229. data/vendor/kreuzberg/stopwords/so_stopwords.json +32 -32
  230. data/vendor/kreuzberg/stopwords/st_stopwords.json +33 -33
  231. data/vendor/kreuzberg/stopwords/sv_stopwords.json +420 -420
  232. data/vendor/kreuzberg/stopwords/sw_stopwords.json +76 -76
  233. data/vendor/kreuzberg/stopwords/ta_stopwords.json +129 -129
  234. data/vendor/kreuzberg/stopwords/te_stopwords.json +54 -54
  235. data/vendor/kreuzberg/stopwords/th_stopwords.json +118 -118
  236. data/vendor/kreuzberg/stopwords/tl_stopwords.json +149 -149
  237. data/vendor/kreuzberg/stopwords/tr_stopwords.json +506 -506
  238. data/vendor/kreuzberg/stopwords/uk_stopwords.json +75 -75
  239. data/vendor/kreuzberg/stopwords/ur_stopwords.json +519 -519
  240. data/vendor/kreuzberg/stopwords/vi_stopwords.json +647 -647
  241. data/vendor/kreuzberg/stopwords/yo_stopwords.json +62 -62
  242. data/vendor/kreuzberg/stopwords/zh_stopwords.json +796 -796
  243. data/vendor/kreuzberg/stopwords/zu_stopwords.json +31 -31
  244. data/vendor/kreuzberg/tests/api_extract_multipart.rs +52 -0
  245. data/vendor/kreuzberg/tests/api_tests.rs +966 -966
  246. data/vendor/kreuzberg/tests/archive_integration.rs +543 -543
  247. data/vendor/kreuzberg/tests/batch_orchestration.rs +556 -542
  248. data/vendor/kreuzberg/tests/batch_processing.rs +316 -304
  249. data/vendor/kreuzberg/tests/bibtex_parity_test.rs +421 -0
  250. data/vendor/kreuzberg/tests/concurrency_stress.rs +525 -509
  251. data/vendor/kreuzberg/tests/config_features.rs +598 -580
  252. data/vendor/kreuzberg/tests/config_loading_tests.rs +415 -439
  253. data/vendor/kreuzberg/tests/core_integration.rs +510 -493
  254. data/vendor/kreuzberg/tests/csv_integration.rs +414 -424
  255. data/vendor/kreuzberg/tests/docbook_extractor_tests.rs +498 -0
  256. data/vendor/kreuzberg/tests/docx_metadata_extraction_test.rs +122 -124
  257. data/vendor/kreuzberg/tests/docx_vs_pandoc_comparison.rs +370 -0
  258. data/vendor/kreuzberg/tests/email_integration.rs +325 -325
  259. data/vendor/kreuzberg/tests/epub_native_extractor_tests.rs +275 -0
  260. data/vendor/kreuzberg/tests/error_handling.rs +393 -393
  261. data/vendor/kreuzberg/tests/fictionbook_extractor_tests.rs +228 -0
  262. data/vendor/kreuzberg/tests/format_integration.rs +159 -159
  263. data/vendor/kreuzberg/tests/helpers/mod.rs +142 -142
  264. data/vendor/kreuzberg/tests/html_table_test.rs +551 -0
  265. data/vendor/kreuzberg/tests/image_integration.rs +253 -253
  266. data/vendor/kreuzberg/tests/instrumentation_test.rs +139 -0
  267. data/vendor/kreuzberg/tests/jats_extractor_tests.rs +639 -0
  268. data/vendor/kreuzberg/tests/jupyter_extractor_tests.rs +704 -0
  269. data/vendor/kreuzberg/tests/keywords_integration.rs +479 -479
  270. data/vendor/kreuzberg/tests/keywords_quality.rs +509 -509
  271. data/vendor/kreuzberg/tests/latex_extractor_tests.rs +496 -0
  272. data/vendor/kreuzberg/tests/markdown_extractor_tests.rs +490 -0
  273. data/vendor/kreuzberg/tests/mime_detection.rs +428 -428
  274. data/vendor/kreuzberg/tests/ocr_configuration.rs +510 -510
  275. data/vendor/kreuzberg/tests/ocr_errors.rs +676 -676
  276. data/vendor/kreuzberg/tests/ocr_quality.rs +627 -627
  277. data/vendor/kreuzberg/tests/ocr_stress.rs +469 -469
  278. data/vendor/kreuzberg/tests/odt_extractor_tests.rs +695 -0
  279. data/vendor/kreuzberg/tests/opml_extractor_tests.rs +616 -0
  280. data/vendor/kreuzberg/tests/orgmode_extractor_tests.rs +822 -0
  281. data/vendor/kreuzberg/tests/pdf_integration.rs +43 -43
  282. data/vendor/kreuzberg/tests/pipeline_integration.rs +1411 -1412
  283. data/vendor/kreuzberg/tests/plugin_ocr_backend_test.rs +771 -771
  284. data/vendor/kreuzberg/tests/plugin_postprocessor_test.rs +560 -561
  285. data/vendor/kreuzberg/tests/plugin_system.rs +921 -921
  286. data/vendor/kreuzberg/tests/plugin_validator_test.rs +783 -783
  287. data/vendor/kreuzberg/tests/registry_integration_tests.rs +586 -607
  288. data/vendor/kreuzberg/tests/rst_extractor_tests.rs +692 -0
  289. data/vendor/kreuzberg/tests/rtf_extractor_tests.rs +776 -0
  290. data/vendor/kreuzberg/tests/security_validation.rs +415 -404
  291. data/vendor/kreuzberg/tests/stopwords_integration_test.rs +888 -888
  292. data/vendor/kreuzberg/tests/test_fastembed.rs +609 -609
  293. data/vendor/kreuzberg/tests/typst_behavioral_tests.rs +1259 -0
  294. data/vendor/kreuzberg/tests/typst_extractor_tests.rs +647 -0
  295. data/vendor/kreuzberg/tests/xlsx_metadata_extraction_test.rs +87 -87
  296. data/vendor/rb-sys/.cargo-ok +1 -0
  297. data/vendor/rb-sys/.cargo_vcs_info.json +6 -0
  298. data/vendor/rb-sys/Cargo.lock +393 -0
  299. data/vendor/rb-sys/Cargo.toml +70 -0
  300. data/vendor/rb-sys/Cargo.toml.orig +57 -0
  301. data/vendor/rb-sys/LICENSE-APACHE +190 -0
  302. data/vendor/rb-sys/LICENSE-MIT +21 -0
  303. data/vendor/rb-sys/bin/release.sh +21 -0
  304. data/vendor/rb-sys/build/features.rs +108 -0
  305. data/vendor/rb-sys/build/main.rs +246 -0
  306. data/vendor/rb-sys/build/stable_api_config.rs +153 -0
  307. data/vendor/rb-sys/build/version.rs +48 -0
  308. data/vendor/rb-sys/readme.md +36 -0
  309. data/vendor/rb-sys/src/bindings.rs +21 -0
  310. data/vendor/rb-sys/src/hidden.rs +11 -0
  311. data/vendor/rb-sys/src/lib.rs +34 -0
  312. data/vendor/rb-sys/src/macros.rs +371 -0
  313. data/vendor/rb-sys/src/memory.rs +53 -0
  314. data/vendor/rb-sys/src/ruby_abi_version.rs +38 -0
  315. data/vendor/rb-sys/src/special_consts.rs +31 -0
  316. data/vendor/rb-sys/src/stable_api/compiled.c +179 -0
  317. data/vendor/rb-sys/src/stable_api/compiled.rs +257 -0
  318. data/vendor/rb-sys/src/stable_api/ruby_2_6.rs +316 -0
  319. data/vendor/rb-sys/src/stable_api/ruby_2_7.rs +316 -0
  320. data/vendor/rb-sys/src/stable_api/ruby_3_0.rs +324 -0
  321. data/vendor/rb-sys/src/stable_api/ruby_3_1.rs +317 -0
  322. data/vendor/rb-sys/src/stable_api/ruby_3_2.rs +315 -0
  323. data/vendor/rb-sys/src/stable_api/ruby_3_3.rs +326 -0
  324. data/vendor/rb-sys/src/stable_api/ruby_3_4.rs +327 -0
  325. data/vendor/rb-sys/src/stable_api.rs +261 -0
  326. data/vendor/rb-sys/src/symbol.rs +31 -0
  327. data/vendor/rb-sys/src/tracking_allocator.rs +332 -0
  328. data/vendor/rb-sys/src/utils.rs +89 -0
  329. data/vendor/rb-sys/src/value_type.rs +7 -0
  330. metadata +90 -95
  331. data/pkg/kreuzberg-4.0.0.rc1.gem +0 -0
  332. data/spec/examples.txt +0 -104
  333. data/vendor/kreuzberg/src/bin/profile_extract.rs +0 -455
  334. data/vendor/kreuzberg/src/extraction/pandoc/batch.rs +0 -275
  335. data/vendor/kreuzberg/src/extraction/pandoc/mime_types.rs +0 -178
  336. data/vendor/kreuzberg/src/extraction/pandoc/mod.rs +0 -491
  337. data/vendor/kreuzberg/src/extraction/pandoc/server.rs +0 -496
  338. data/vendor/kreuzberg/src/extraction/pandoc/subprocess.rs +0 -1188
  339. data/vendor/kreuzberg/src/extraction/pandoc/version.rs +0 -162
  340. data/vendor/kreuzberg/src/extractors/pandoc.rs +0 -201
  341. data/vendor/kreuzberg/tests/chunking_offset_demo.rs +0 -92
  342. data/vendor/kreuzberg/tests/pandoc_integration.rs +0 -503
@@ -1,564 +1,563 @@
1
- //! LibreOffice document conversion utilities.
2
- //!
3
- //! This module provides functions for converting legacy Microsoft Office formats
4
- //! (.doc, .ppt) to modern formats using LibreOffice's headless conversion mode.
5
- //!
6
- //! # Features
7
- //!
8
- //! - **Headless conversion**: Uses `soffice --headless` for server-side conversions
9
- //! - **Timeout protection**: Configurable timeout to prevent hanging conversions
10
- //! - **Format detection**: Automatic output format based on input file type
11
- //! - **Error handling**: Distinguishes between missing dependencies and conversion failures
12
- //!
13
- //! # Supported Conversions
14
- //!
15
- //! - `.doc` → `.docx` (Word documents)
16
- //! - `.ppt` → `.pptx` (PowerPoint presentations)
17
- //! - `.xls` → `.xlsx` (Excel spreadsheets) - future support
18
- //!
19
- //! # System Requirement
20
- //!
21
- //! LibreOffice must be installed and `soffice` must be in PATH:
22
- //! - **macOS**: `brew install --cask libreoffice`
23
- //! - **Linux**: `apt install libreoffice` or `dnf install libreoffice`
24
- //! - **Windows**: `winget install LibreOffice.LibreOffice`
25
- //!
26
- //! # Example
27
- //!
28
- //! ```rust,no_run
29
- //! use kreuzberg::extraction::libreoffice::{convert_office_doc, check_libreoffice_available};
30
- //! use std::path::Path;
31
- //!
32
- //! # async fn example() -> kreuzberg::Result<()> {
33
- //! // Check if LibreOffice is available
34
- //! let _soffice_path = check_libreoffice_available().await?;
35
- //!
36
- //! // Convert .doc to .docx
37
- //! let input = Path::new("legacy.doc");
38
- //! let output_dir = Path::new("/tmp");
39
- //! let converted = convert_office_doc(input, output_dir, "docx", 300).await?;
40
- //!
41
- //! println!("Converted {} bytes", converted.len());
42
- //! # Ok(())
43
- //! # }
44
- //! ```
45
-
46
- use crate::error::{KreuzbergError, Result};
47
- use crate::types::LibreOfficeConversionResult;
48
- use std::collections::HashSet;
49
- use std::env;
50
- use std::fs as std_fs;
51
- use std::path::{Path, PathBuf};
52
- use tokio::fs;
53
- use tokio::process::Command;
54
- use tokio::time::{Duration, timeout};
55
-
56
- /// RAII guard for automatic temporary directory cleanup
57
- struct TempDir {
58
- path: PathBuf,
59
- }
60
-
61
- impl TempDir {
62
- async fn new(path: PathBuf) -> Result<Self> {
63
- fs::create_dir_all(&path).await?;
64
- Ok(Self { path })
65
- }
66
- }
67
-
68
- impl Drop for TempDir {
69
- fn drop(&mut self) {
70
- let path = self.path.clone();
71
- tokio::spawn(async move {
72
- let _ = fs::remove_dir_all(&path).await;
73
- });
74
- }
75
- }
76
-
77
- /// Default timeout for LibreOffice conversion (300 seconds)
78
- pub const DEFAULT_CONVERSION_TIMEOUT: u64 = 300;
79
-
80
- fn libreoffice_install_message() -> String {
81
- "LibreOffice (soffice/libreoffice) is required for legacy MS Office format support (.doc, .ppt). \
82
- Install: macOS: 'brew install --cask libreoffice', \
83
- Linux: 'apt install libreoffice', \
84
- Windows: 'winget install LibreOffice.LibreOffice'. \
85
- If LibreOffice is installed in a custom location, set the KREUZBERG_LIBREOFFICE_PATH environment variable to the soffice executable."
86
- .to_string()
87
- }
88
-
89
- fn path_to_file_uri(path: &Path) -> String {
90
- let canonical = std_fs::canonicalize(path).unwrap_or_else(|_| path.to_path_buf());
91
-
92
- #[cfg(windows)]
93
- {
94
- let mut normalized = canonical.to_string_lossy().replace('\\', "/");
95
- if !normalized.starts_with('/') {
96
- normalized = format!("/{}", normalized);
97
- }
98
- format!("file://{}", normalized)
99
- }
100
-
101
- #[cfg(not(windows))]
102
- {
103
- format!("file://{}", canonical.to_string_lossy())
104
- }
105
- }
106
-
107
- fn soffice_candidates() -> Vec<PathBuf> {
108
- let mut seen = HashSet::new();
109
- let mut candidates = Vec::new();
110
-
111
- let mut push_candidate = |path: PathBuf| {
112
- if seen.insert(path.clone()) {
113
- candidates.push(path);
114
- }
115
- };
116
-
117
- for var in ["KREUZBERG_LIBREOFFICE_PATH", "SOFFICE_PATH", "LIBREOFFICE_PATH"] {
118
- if let Some(value) = env::var_os(var).filter(|v| !v.is_empty()) {
119
- push_candidate(PathBuf::from(value));
120
- }
121
- }
122
-
123
- if cfg!(target_os = "macos") {
124
- push_candidate(PathBuf::from("/Applications/LibreOffice.app/Contents/MacOS/soffice"));
125
- push_candidate(PathBuf::from(
126
- "/Applications/LibreOffice.app/Contents/MacOS/libreoffice",
127
- ));
128
- push_candidate(PathBuf::from(
129
- "/Applications/LibreOffice.app/Contents/MacOS/soffice.bin",
130
- ));
131
- }
132
-
133
- if cfg!(target_os = "windows") {
134
- push_candidate(PathBuf::from("C:\\Program Files\\LibreOffice\\program\\soffice.exe"));
135
- push_candidate(PathBuf::from(
136
- "C:\\Program Files\\LibreOffice\\program\\libreoffice.exe",
137
- ));
138
- }
139
-
140
- if let Some(prefix) = env::var_os("HOMEBREW_PREFIX") {
141
- let prefix_path = PathBuf::from(prefix);
142
- push_candidate(prefix_path.join("bin/soffice"));
143
- push_candidate(prefix_path.join("bin/libreoffice"));
144
- push_candidate(prefix_path.join("bin/soffice.exe"));
145
- push_candidate(prefix_path.join("bin/libreoffice.exe"));
146
- }
147
-
148
- if let Some(path_env) = env::var_os("PATH") {
149
- for dir in env::split_paths(&path_env) {
150
- push_candidate(dir.join("soffice"));
151
- push_candidate(dir.join("libreoffice"));
152
- push_candidate(dir.join("soffice.exe"));
153
- push_candidate(dir.join("libreoffice.exe"));
154
- }
155
- }
156
-
157
- candidates
158
- }
159
-
160
- fn locate_soffice_binary() -> Result<PathBuf> {
161
- for candidate in soffice_candidates() {
162
- if candidate.exists()
163
- && let Ok(metadata) = std_fs::metadata(&candidate)
164
- && metadata.is_file()
165
- {
166
- return Ok(candidate);
167
- }
168
- }
169
-
170
- Err(KreuzbergError::MissingDependency(libreoffice_install_message()))
171
- }
172
-
173
- /// Check if LibreOffice (soffice/libreoffice) is available and working
174
- pub async fn check_libreoffice_available() -> Result<PathBuf> {
175
- let soffice_path = locate_soffice_binary()?;
176
-
177
- let result = Command::new(&soffice_path).arg("--version").output().await;
178
-
179
- match result {
180
- Ok(output) if output.status.success() => Ok(soffice_path),
181
- Ok(_) => Err(KreuzbergError::MissingDependency(format!(
182
- "LibreOffice executable '{}' responded with a failure when checking '--version'. \
183
- Please reinstall LibreOffice.",
184
- soffice_path.display()
185
- ))),
186
- Err(err) => Err(KreuzbergError::MissingDependency(format!(
187
- "LibreOffice executable '{}' could not be executed: {}. {help}",
188
- soffice_path.display(),
189
- err,
190
- help = libreoffice_install_message()
191
- ))),
192
- }
193
- }
194
-
195
- /// Convert an Office document to a target format using LibreOffice
196
- pub async fn convert_office_doc(
197
- input_path: &Path,
198
- output_dir: &Path,
199
- target_format: &str,
200
- timeout_seconds: u64,
201
- ) -> Result<Vec<u8>> {
202
- let soffice_path = check_libreoffice_available().await?;
203
-
204
- let profile_dir = std::env::temp_dir().join(format!("kreuzberg_lo_profile_{}", uuid::Uuid::new_v4()));
205
- let _profile_guard = TempDir::new(profile_dir.clone()).await?;
206
- let user_install_arg = format!("-env:UserInstallation={}", path_to_file_uri(&profile_dir));
207
-
208
- fs::create_dir_all(output_dir).await?;
209
-
210
- let mut command = Command::new(&soffice_path);
211
- command
212
- .arg("--headless")
213
- .arg("--nologo")
214
- .arg("--norestore")
215
- .arg("--nolockcheck")
216
- .arg(user_install_arg)
217
- .arg("--convert-to")
218
- .arg(target_format)
219
- .arg("--outdir")
220
- .arg(output_dir)
221
- .arg(input_path);
222
-
223
- let child = command
224
- .stdout(std::process::Stdio::piped())
225
- .stderr(std::process::Stdio::piped())
226
- .spawn()
227
- .map_err(|e| {
228
- KreuzbergError::parsing(format!(
229
- "Failed to execute LibreOffice at '{}': {}",
230
- soffice_path.display(),
231
- e
232
- ))
233
- })?;
234
-
235
- let child_id = child.id();
236
-
237
- let output = match timeout(Duration::from_secs(timeout_seconds), child.wait_with_output()).await {
238
- Ok(Ok(output)) => output,
239
- Ok(Err(e)) => {
240
- return Err(KreuzbergError::parsing(format!(
241
- "Failed to wait for LibreOffice: {}",
242
- e
243
- )));
244
- }
245
- Err(_) => {
246
- // Timeout occurred - wait_with_output was cancelled, child is dropped and killed automatically ~keep
247
- return Err(KreuzbergError::parsing(format!(
248
- "LibreOffice conversion timed out after {} seconds (PID: {:?})",
249
- timeout_seconds, child_id
250
- )));
251
- }
252
- };
253
-
254
- if !output.status.success() {
255
- let stderr = String::from_utf8_lossy(&output.stderr);
256
- let stdout = String::from_utf8_lossy(&output.stdout);
257
-
258
- // Build detailed error message with both stdout and stderr
259
- let mut error_details = format!(
260
- "LibreOffice process failed with return code {}",
261
- output.status.code().unwrap_or(-1)
262
- );
263
-
264
- if !stderr.is_empty() {
265
- error_details.push_str(&format!("\nSTDERR: {}", stderr.trim()));
266
- }
267
- if !stdout.is_empty() {
268
- error_details.push_str(&format!("\nSTDOUT: {}", stdout.trim()));
269
- }
270
- if stderr.is_empty() && stdout.is_empty() {
271
- error_details.push_str("\n(no output from LibreOffice process)");
272
- }
273
-
274
- // Subprocess error analysis - wrap only if format/parsing error detected ~keep
275
- let stderr_lower = stderr.to_lowercase();
276
- let stdout_lower = stdout.to_lowercase();
277
- let keywords = ["format", "unsupported", "error:", "failed"];
278
-
279
- if keywords
280
- .iter()
281
- .any(|k| stderr_lower.contains(k) || stdout_lower.contains(k))
282
- {
283
- return Err(KreuzbergError::parsing(error_details));
284
- }
285
-
286
- // True system error - bubble up for user reporting ~keep
287
- return Err(KreuzbergError::Io(std::io::Error::other(error_details)));
288
- }
289
-
290
- let input_stem = input_path
291
- .file_stem()
292
- .ok_or_else(|| KreuzbergError::parsing("Invalid input file name".to_string()))?;
293
-
294
- let expected_output = output_dir.join(format!("{}.{}", input_stem.to_string_lossy(), target_format));
295
-
296
- let converted_bytes = fs::read(&expected_output).await.map_err(|e| {
297
- KreuzbergError::parsing(format!(
298
- "LibreOffice conversion completed but output file not found: {}",
299
- e
300
- ))
301
- })?;
302
-
303
- if converted_bytes.is_empty() {
304
- return Err(KreuzbergError::parsing(
305
- "LibreOffice conversion produced empty file".to_string(),
306
- ));
307
- }
308
-
309
- Ok(converted_bytes)
310
- }
311
-
312
- /// Convert .doc to .docx using LibreOffice
313
- pub async fn convert_doc_to_docx(doc_bytes: &[u8]) -> Result<LibreOfficeConversionResult> {
314
- let temp_dir = std::env::temp_dir();
315
- let unique_id = uuid::Uuid::new_v4();
316
- let input_dir_path = temp_dir.join(format!("kreuzberg_doc_{}", unique_id));
317
- let output_dir_path = temp_dir.join(format!("kreuzberg_doc_{}_out", unique_id));
318
-
319
- // RAII guards ensure cleanup on all paths including panic ~keep
320
- let _input_guard = TempDir::new(input_dir_path.clone()).await?;
321
- let _output_guard = TempDir::new(output_dir_path.clone()).await?;
322
-
323
- let input_path = input_dir_path.join("input.doc");
324
- fs::write(&input_path, doc_bytes).await?;
325
-
326
- let converted_bytes = convert_office_doc(&input_path, &output_dir_path, "docx", DEFAULT_CONVERSION_TIMEOUT).await?;
327
-
328
- Ok(LibreOfficeConversionResult {
329
- converted_bytes,
330
- original_format: "doc".to_string(),
331
- target_format: "docx".to_string(),
332
- target_mime: crate::core::mime::DOCX_MIME_TYPE.to_string(),
333
- })
334
- }
335
-
336
- /// Convert .ppt to .pptx using LibreOffice
337
- pub async fn convert_ppt_to_pptx(ppt_bytes: &[u8]) -> Result<LibreOfficeConversionResult> {
338
- let temp_dir = std::env::temp_dir();
339
- let unique_id = uuid::Uuid::new_v4();
340
- let input_dir_path = temp_dir.join(format!("kreuzberg_ppt_{}", unique_id));
341
- let output_dir_path = temp_dir.join(format!("kreuzberg_ppt_{}_out", unique_id));
342
-
343
- // RAII guards ensure cleanup on all paths including panic ~keep
344
- let _input_guard = TempDir::new(input_dir_path.clone()).await?;
345
- let _output_guard = TempDir::new(output_dir_path.clone()).await?;
346
-
347
- let input_path = input_dir_path.join("input.ppt");
348
- fs::write(&input_path, ppt_bytes).await?;
349
-
350
- let converted_bytes = convert_office_doc(&input_path, &output_dir_path, "pptx", DEFAULT_CONVERSION_TIMEOUT).await?;
351
-
352
- Ok(LibreOfficeConversionResult {
353
- converted_bytes,
354
- original_format: "ppt".to_string(),
355
- target_format: "pptx".to_string(),
356
- target_mime: crate::core::mime::POWER_POINT_MIME_TYPE.to_string(),
357
- })
358
- }
359
-
360
- #[cfg(test)]
361
- mod tests {
362
- use super::*;
363
-
364
- #[tokio::test]
365
- async fn test_check_libreoffice_available() {
366
- let result = check_libreoffice_available().await;
367
- if result.is_err() {
368
- return;
369
- }
370
- assert!(result.is_ok());
371
- }
372
-
373
- #[tokio::test]
374
- async fn test_convert_office_doc_missing_file() {
375
- if check_libreoffice_available().await.is_err() {
376
- return;
377
- }
378
-
379
- let temp_dir = std::env::temp_dir();
380
- let output_dir = temp_dir.join("test_convert_office_doc_missing_file");
381
- let non_existent = Path::new("/tmp/nonexistent.doc");
382
-
383
- let result = convert_office_doc(non_existent, &output_dir, "docx", 10).await;
384
-
385
- assert!(result.is_err());
386
- let _ = fs::remove_dir_all(&output_dir).await;
387
- }
388
-
389
- #[test]
390
- fn test_default_conversion_timeout_value() {
391
- assert_eq!(DEFAULT_CONVERSION_TIMEOUT, 300);
392
- }
393
-
394
- #[tokio::test]
395
- async fn test_convert_doc_to_docx_empty_bytes() {
396
- if check_libreoffice_available().await.is_err() {
397
- return;
398
- }
399
-
400
- let empty_bytes = b"";
401
- let result = convert_doc_to_docx(empty_bytes).await;
402
-
403
- let _ = result;
404
- }
405
-
406
- #[tokio::test]
407
- async fn test_convert_ppt_to_pptx_empty_bytes() {
408
- if check_libreoffice_available().await.is_err() {
409
- return;
410
- }
411
-
412
- let empty_bytes = b"";
413
- let result = convert_ppt_to_pptx(empty_bytes).await;
414
-
415
- let _ = result;
416
- }
417
-
418
- #[tokio::test]
419
- async fn test_convert_doc_to_docx_invalid_doc() {
420
- if check_libreoffice_available().await.is_err() {
421
- return;
422
- }
423
-
424
- let invalid_doc = b"This is not a valid .doc file";
425
- let result = convert_doc_to_docx(invalid_doc).await;
426
-
427
- let _ = result;
428
- }
429
-
430
- #[tokio::test]
431
- async fn test_convert_ppt_to_pptx_invalid_ppt() {
432
- if check_libreoffice_available().await.is_err() {
433
- return;
434
- }
435
-
436
- let invalid_ppt = b"This is not a valid .ppt file";
437
- let result = convert_ppt_to_pptx(invalid_ppt).await;
438
-
439
- assert!(result.is_err());
440
- }
441
-
442
- #[tokio::test]
443
- async fn test_convert_office_doc_invalid_target_format() {
444
- if check_libreoffice_available().await.is_err() {
445
- return;
446
- }
447
-
448
- let temp_dir = std::env::temp_dir();
449
- let input_path = temp_dir.join("test_input.txt");
450
- let output_dir = temp_dir.join("test_output_invalid_format");
451
-
452
- fs::write(&input_path, b"test content").await.unwrap();
453
-
454
- let result = convert_office_doc(&input_path, &output_dir, "invalid_format", 10).await;
455
-
456
- let _ = fs::remove_file(&input_path).await;
457
- let _ = fs::remove_dir_all(&output_dir).await;
458
-
459
- let _ = result;
460
- }
461
-
462
- #[tokio::test]
463
- async fn test_check_libreoffice_missing_dependency_error() {
464
- let result = check_libreoffice_available().await;
465
-
466
- if result.is_err() {
467
- let err = result.unwrap_err();
468
- match err {
469
- KreuzbergError::MissingDependency(msg) => {
470
- assert!(msg.contains("LibreOffice") || msg.contains("soffice"));
471
- }
472
- _ => panic!("Expected MissingDependency error"),
473
- }
474
- }
475
- }
476
-
477
- #[tokio::test]
478
- async fn test_convert_office_doc_creates_output_dir() {
479
- if check_libreoffice_available().await.is_err() {
480
- return;
481
- }
482
-
483
- let temp_dir = std::env::temp_dir();
484
- let output_dir = temp_dir.join(format!("test_create_output_{}", uuid::Uuid::new_v4()));
485
-
486
- assert!(!output_dir.exists());
487
-
488
- let input_path = temp_dir.join("test_create_output.txt");
489
- fs::write(&input_path, b"test").await.unwrap();
490
-
491
- let _ = convert_office_doc(&input_path, &output_dir, "pdf", 10).await;
492
-
493
- let _ = fs::remove_file(&input_path).await;
494
- let _ = fs::remove_dir_all(&output_dir).await;
495
- }
496
-
497
- #[tokio::test]
498
- async fn test_conversion_result_structure() {
499
- let result = LibreOfficeConversionResult {
500
- converted_bytes: vec![1, 2, 3],
501
- original_format: "doc".to_string(),
502
- target_format: "docx".to_string(),
503
- target_mime: crate::core::mime::DOCX_MIME_TYPE.to_string(),
504
- };
505
-
506
- assert_eq!(result.original_format, "doc");
507
- assert_eq!(result.target_format, "docx");
508
- assert_eq!(result.converted_bytes.len(), 3);
509
- }
510
-
511
- #[tokio::test]
512
- async fn test_convert_doc_to_docx_temp_cleanup() {
513
- if check_libreoffice_available().await.is_err() {
514
- return;
515
- }
516
-
517
- let invalid_doc = b"invalid doc content";
518
- let _result = convert_doc_to_docx(invalid_doc).await;
519
- }
520
-
521
- #[tokio::test]
522
- async fn test_convert_ppt_to_pptx_temp_cleanup() {
523
- if check_libreoffice_available().await.is_err() {
524
- return;
525
- }
526
-
527
- let invalid_ppt = b"invalid ppt content";
528
- let _result = convert_ppt_to_pptx(invalid_ppt).await;
529
- }
530
-
531
- #[tokio::test]
532
- async fn test_convert_office_doc_timeout_kills_process() {
533
- if check_libreoffice_available().await.is_err() {
534
- return;
535
- }
536
-
537
- let temp_dir = std::env::temp_dir();
538
- let input_path = temp_dir.join("test_timeout_input.txt");
539
- let output_dir = temp_dir.join("test_timeout_output");
540
-
541
- fs::write(&input_path, b"test content").await.unwrap();
542
-
543
- let result = convert_office_doc(&input_path, &output_dir, "pdf", 0).await;
544
-
545
- assert!(result.is_err());
546
-
547
- let _ = fs::remove_file(&input_path).await;
548
- let _ = fs::remove_dir_all(&output_dir).await;
549
- }
550
-
551
- #[tokio::test]
552
- async fn test_tempdir_raii_cleanup_on_error() {
553
- let temp_path = std::env::temp_dir().join(format!("test_raii_{}", uuid::Uuid::new_v4()));
554
-
555
- {
556
- let _guard = TempDir::new(temp_path.clone()).await.unwrap();
557
- assert!(temp_path.exists());
558
- }
559
-
560
- tokio::time::sleep(tokio::time::Duration::from_millis(100)).await;
561
-
562
- assert!(!temp_path.exists() || fs::read_dir(&temp_path).await.is_err());
563
- }
564
- }
1
+ //! LibreOffice document conversion utilities.
2
+ //!
3
+ //! This module provides functions for converting legacy Microsoft Office formats
4
+ //! (.doc, .ppt) to modern formats using LibreOffice's headless conversion mode.
5
+ //!
6
+ //! # Features
7
+ //!
8
+ //! - **Headless conversion**: Uses `soffice --headless` for server-side conversions
9
+ //! - **Timeout protection**: Configurable timeout to prevent hanging conversions
10
+ //! - **Format detection**: Automatic output format based on input file type
11
+ //! - **Error handling**: Distinguishes between missing dependencies and conversion failures
12
+ //!
13
+ //! # Supported Conversions
14
+ //!
15
+ //! - `.doc` → `.docx` (Word documents)
16
+ //! - `.ppt` → `.pptx` (PowerPoint presentations)
17
+ //! - `.xls` → `.xlsx` (Excel spreadsheets) - future support
18
+ //!
19
+ //! # System Requirement
20
+ //!
21
+ //! LibreOffice must be installed and `soffice` must be in PATH:
22
+ //! - **macOS**: `brew install --cask libreoffice`
23
+ //! - **Linux**: `apt install libreoffice` or `dnf install libreoffice`
24
+ //! - **Windows**: `winget install LibreOffice.LibreOffice`
25
+ //!
26
+ //! # Example
27
+ //!
28
+ //! ```rust,no_run
29
+ //! use kreuzberg::extraction::libreoffice::{convert_office_doc, check_libreoffice_available};
30
+ //! use std::path::Path;
31
+ //!
32
+ //! # async fn example() -> kreuzberg::Result<()> {
33
+ //! // Check if LibreOffice is available
34
+ //! let _soffice_path = check_libreoffice_available().await?;
35
+ //!
36
+ //! // Convert .doc to .docx
37
+ //! let input = Path::new("legacy.doc");
38
+ //! let output_dir = Path::new("/tmp");
39
+ //! let converted = convert_office_doc(input, output_dir, "docx", 300).await?;
40
+ //!
41
+ //! println!("Converted {} bytes", converted.len());
42
+ //! # Ok(())
43
+ //! # }
44
+ //! ```
45
+
46
+ use crate::error::{KreuzbergError, Result};
47
+ use crate::types::LibreOfficeConversionResult;
48
+ use std::collections::HashSet;
49
+ use std::env;
50
+ use std::fs as std_fs;
51
+ use std::path::{Path, PathBuf};
52
+ use tokio::fs;
53
+ use tokio::process::Command;
54
+ use tokio::time::{Duration, timeout};
55
+
56
+ /// RAII guard for automatic temporary directory cleanup
57
+ struct TempDir {
58
+ path: PathBuf,
59
+ }
60
+
61
+ impl TempDir {
62
+ async fn new(path: PathBuf) -> Result<Self> {
63
+ fs::create_dir_all(&path).await?;
64
+ Ok(Self { path })
65
+ }
66
+ }
67
+
68
+ impl Drop for TempDir {
69
+ fn drop(&mut self) {
70
+ let path = self.path.clone();
71
+ tokio::spawn(async move {
72
+ let _ = fs::remove_dir_all(&path).await;
73
+ });
74
+ }
75
+ }
76
+
77
+ /// Default timeout for LibreOffice conversion (300 seconds)
78
+ pub const DEFAULT_CONVERSION_TIMEOUT: u64 = 300;
79
+
80
+ fn libreoffice_install_message() -> String {
81
+ "LibreOffice (soffice/libreoffice) is required for legacy MS Office format support (.doc, .ppt). \
82
+ Install: macOS: 'brew install --cask libreoffice', \
83
+ Linux: 'apt install libreoffice', \
84
+ Windows: 'winget install LibreOffice.LibreOffice'. \
85
+ If LibreOffice is installed in a custom location, set the KREUZBERG_LIBREOFFICE_PATH environment variable to the soffice executable."
86
+ .to_string()
87
+ }
88
+
89
+ fn path_to_file_uri(path: &Path) -> String {
90
+ let canonical = std_fs::canonicalize(path).unwrap_or_else(|_| path.to_path_buf());
91
+
92
+ #[cfg(windows)]
93
+ {
94
+ let mut normalized = canonical.to_string_lossy().replace('\\', "/");
95
+ if !normalized.starts_with('/') {
96
+ normalized = format!("/{}", normalized);
97
+ }
98
+ format!("file://{}", normalized)
99
+ }
100
+
101
+ #[cfg(not(windows))]
102
+ {
103
+ format!("file://{}", canonical.to_string_lossy())
104
+ }
105
+ }
106
+
107
+ fn soffice_candidates() -> Vec<PathBuf> {
108
+ let mut seen = HashSet::new();
109
+ let mut candidates = Vec::new();
110
+
111
+ let mut push_candidate = |path: PathBuf| {
112
+ if seen.insert(path.clone()) {
113
+ candidates.push(path);
114
+ }
115
+ };
116
+
117
+ for var in ["KREUZBERG_LIBREOFFICE_PATH", "SOFFICE_PATH", "LIBREOFFICE_PATH"] {
118
+ if let Some(value) = env::var_os(var).filter(|v| !v.is_empty()) {
119
+ push_candidate(PathBuf::from(value));
120
+ }
121
+ }
122
+
123
+ if cfg!(target_os = "macos") {
124
+ push_candidate(PathBuf::from("/Applications/LibreOffice.app/Contents/MacOS/soffice"));
125
+ push_candidate(PathBuf::from(
126
+ "/Applications/LibreOffice.app/Contents/MacOS/libreoffice",
127
+ ));
128
+ push_candidate(PathBuf::from(
129
+ "/Applications/LibreOffice.app/Contents/MacOS/soffice.bin",
130
+ ));
131
+ }
132
+
133
+ if cfg!(target_os = "windows") {
134
+ push_candidate(PathBuf::from("C:\\Program Files\\LibreOffice\\program\\soffice.exe"));
135
+ push_candidate(PathBuf::from(
136
+ "C:\\Program Files\\LibreOffice\\program\\libreoffice.exe",
137
+ ));
138
+ }
139
+
140
+ if let Some(prefix) = env::var_os("HOMEBREW_PREFIX") {
141
+ let prefix_path = PathBuf::from(prefix);
142
+ push_candidate(prefix_path.join("bin/soffice"));
143
+ push_candidate(prefix_path.join("bin/libreoffice"));
144
+ push_candidate(prefix_path.join("bin/soffice.exe"));
145
+ push_candidate(prefix_path.join("bin/libreoffice.exe"));
146
+ }
147
+
148
+ if let Some(path_env) = env::var_os("PATH") {
149
+ for dir in env::split_paths(&path_env) {
150
+ push_candidate(dir.join("soffice"));
151
+ push_candidate(dir.join("libreoffice"));
152
+ push_candidate(dir.join("soffice.exe"));
153
+ push_candidate(dir.join("libreoffice.exe"));
154
+ }
155
+ }
156
+
157
+ candidates
158
+ }
159
+
160
+ fn locate_soffice_binary() -> Result<PathBuf> {
161
+ for candidate in soffice_candidates() {
162
+ if candidate.exists()
163
+ && let Ok(metadata) = std_fs::metadata(&candidate)
164
+ && metadata.is_file()
165
+ {
166
+ return Ok(candidate);
167
+ }
168
+ }
169
+
170
+ Err(KreuzbergError::MissingDependency(libreoffice_install_message()))
171
+ }
172
+
173
+ /// Check if LibreOffice (soffice/libreoffice) is available and working
174
+ pub async fn check_libreoffice_available() -> Result<PathBuf> {
175
+ let soffice_path = locate_soffice_binary()?;
176
+
177
+ let result = Command::new(&soffice_path).arg("--version").output().await;
178
+
179
+ match result {
180
+ Ok(output) if output.status.success() => Ok(soffice_path),
181
+ Ok(_) => Err(KreuzbergError::MissingDependency(format!(
182
+ "LibreOffice executable '{}' responded with a failure when checking '--version'. \
183
+ Please reinstall LibreOffice.",
184
+ soffice_path.display()
185
+ ))),
186
+ Err(err) => Err(KreuzbergError::MissingDependency(format!(
187
+ "LibreOffice executable '{}' could not be executed: {}. {help}",
188
+ soffice_path.display(),
189
+ err,
190
+ help = libreoffice_install_message()
191
+ ))),
192
+ }
193
+ }
194
+
195
+ /// Convert an Office document to a target format using LibreOffice
196
+ pub async fn convert_office_doc(
197
+ input_path: &Path,
198
+ output_dir: &Path,
199
+ target_format: &str,
200
+ timeout_seconds: u64,
201
+ ) -> Result<Vec<u8>> {
202
+ let soffice_path = check_libreoffice_available().await?;
203
+
204
+ let profile_dir = std::env::temp_dir().join(format!("kreuzberg_lo_profile_{}", uuid::Uuid::new_v4()));
205
+ let _profile_guard = TempDir::new(profile_dir.clone()).await?;
206
+ let user_install_arg = format!("-env:UserInstallation={}", path_to_file_uri(&profile_dir));
207
+
208
+ fs::create_dir_all(output_dir).await?;
209
+
210
+ let mut command = Command::new(&soffice_path);
211
+ command
212
+ .arg("--headless")
213
+ .arg("--nologo")
214
+ .arg("--norestore")
215
+ .arg("--nolockcheck")
216
+ .arg(user_install_arg)
217
+ .arg("--convert-to")
218
+ .arg(target_format)
219
+ .arg("--outdir")
220
+ .arg(output_dir)
221
+ .arg(input_path);
222
+
223
+ let child = command
224
+ .stdout(std::process::Stdio::piped())
225
+ .stderr(std::process::Stdio::piped())
226
+ .spawn()
227
+ .map_err(|e| {
228
+ KreuzbergError::parsing(format!(
229
+ "Failed to execute LibreOffice at '{}': {}",
230
+ soffice_path.display(),
231
+ e
232
+ ))
233
+ })?;
234
+
235
+ let child_id = child.id();
236
+
237
+ let output = match timeout(Duration::from_secs(timeout_seconds), child.wait_with_output()).await {
238
+ Ok(Ok(output)) => output,
239
+ Ok(Err(e)) => {
240
+ return Err(KreuzbergError::parsing(format!(
241
+ "Failed to wait for LibreOffice: {}",
242
+ e
243
+ )));
244
+ }
245
+ Err(_) => {
246
+ // Timeout occurred - wait_with_output was cancelled, child is dropped and killed automatically ~keep
247
+ return Err(KreuzbergError::parsing(format!(
248
+ "LibreOffice conversion timed out after {} seconds (PID: {:?})",
249
+ timeout_seconds, child_id
250
+ )));
251
+ }
252
+ };
253
+
254
+ if !output.status.success() {
255
+ let stderr = String::from_utf8_lossy(&output.stderr);
256
+ let stdout = String::from_utf8_lossy(&output.stdout);
257
+
258
+ let mut error_details = format!(
259
+ "LibreOffice process failed with return code {}",
260
+ output.status.code().unwrap_or(-1)
261
+ );
262
+
263
+ if !stderr.is_empty() {
264
+ error_details.push_str(&format!("\nSTDERR: {}", stderr.trim()));
265
+ }
266
+ if !stdout.is_empty() {
267
+ error_details.push_str(&format!("\nSTDOUT: {}", stdout.trim()));
268
+ }
269
+ if stderr.is_empty() && stdout.is_empty() {
270
+ error_details.push_str("\n(no output from LibreOffice process)");
271
+ }
272
+
273
+ // Subprocess error analysis - wrap only if format/parsing error detected ~keep
274
+ let stderr_lower = stderr.to_lowercase();
275
+ let stdout_lower = stdout.to_lowercase();
276
+ let keywords = ["format", "unsupported", "error:", "failed"];
277
+
278
+ if keywords
279
+ .iter()
280
+ .any(|k| stderr_lower.contains(k) || stdout_lower.contains(k))
281
+ {
282
+ return Err(KreuzbergError::parsing(error_details));
283
+ }
284
+
285
+ // True system error - bubble up for user reporting ~keep
286
+ return Err(KreuzbergError::Io(std::io::Error::other(error_details)));
287
+ }
288
+
289
+ let input_stem = input_path
290
+ .file_stem()
291
+ .ok_or_else(|| KreuzbergError::parsing("Invalid input file name".to_string()))?;
292
+
293
+ let expected_output = output_dir.join(format!("{}.{}", input_stem.to_string_lossy(), target_format));
294
+
295
+ let converted_bytes = fs::read(&expected_output).await.map_err(|e| {
296
+ KreuzbergError::parsing(format!(
297
+ "LibreOffice conversion completed but output file not found: {}",
298
+ e
299
+ ))
300
+ })?;
301
+
302
+ if converted_bytes.is_empty() {
303
+ return Err(KreuzbergError::parsing(
304
+ "LibreOffice conversion produced empty file".to_string(),
305
+ ));
306
+ }
307
+
308
+ Ok(converted_bytes)
309
+ }
310
+
311
+ /// Convert .doc to .docx using LibreOffice
312
+ pub async fn convert_doc_to_docx(doc_bytes: &[u8]) -> Result<LibreOfficeConversionResult> {
313
+ let temp_dir = std::env::temp_dir();
314
+ let unique_id = uuid::Uuid::new_v4();
315
+ let input_dir_path = temp_dir.join(format!("kreuzberg_doc_{}", unique_id));
316
+ let output_dir_path = temp_dir.join(format!("kreuzberg_doc_{}_out", unique_id));
317
+
318
+ // RAII guards ensure cleanup on all paths including panic ~keep
319
+ let _input_guard = TempDir::new(input_dir_path.clone()).await?;
320
+ let _output_guard = TempDir::new(output_dir_path.clone()).await?;
321
+
322
+ let input_path = input_dir_path.join("input.doc");
323
+ fs::write(&input_path, doc_bytes).await?;
324
+
325
+ let converted_bytes = convert_office_doc(&input_path, &output_dir_path, "docx", DEFAULT_CONVERSION_TIMEOUT).await?;
326
+
327
+ Ok(LibreOfficeConversionResult {
328
+ converted_bytes,
329
+ original_format: "doc".to_string(),
330
+ target_format: "docx".to_string(),
331
+ target_mime: crate::core::mime::DOCX_MIME_TYPE.to_string(),
332
+ })
333
+ }
334
+
335
+ /// Convert .ppt to .pptx using LibreOffice
336
+ pub async fn convert_ppt_to_pptx(ppt_bytes: &[u8]) -> Result<LibreOfficeConversionResult> {
337
+ let temp_dir = std::env::temp_dir();
338
+ let unique_id = uuid::Uuid::new_v4();
339
+ let input_dir_path = temp_dir.join(format!("kreuzberg_ppt_{}", unique_id));
340
+ let output_dir_path = temp_dir.join(format!("kreuzberg_ppt_{}_out", unique_id));
341
+
342
+ // RAII guards ensure cleanup on all paths including panic ~keep
343
+ let _input_guard = TempDir::new(input_dir_path.clone()).await?;
344
+ let _output_guard = TempDir::new(output_dir_path.clone()).await?;
345
+
346
+ let input_path = input_dir_path.join("input.ppt");
347
+ fs::write(&input_path, ppt_bytes).await?;
348
+
349
+ let converted_bytes = convert_office_doc(&input_path, &output_dir_path, "pptx", DEFAULT_CONVERSION_TIMEOUT).await?;
350
+
351
+ Ok(LibreOfficeConversionResult {
352
+ converted_bytes,
353
+ original_format: "ppt".to_string(),
354
+ target_format: "pptx".to_string(),
355
+ target_mime: crate::core::mime::POWER_POINT_MIME_TYPE.to_string(),
356
+ })
357
+ }
358
+
359
+ #[cfg(test)]
360
+ mod tests {
361
+ use super::*;
362
+
363
+ #[tokio::test]
364
+ async fn test_check_libreoffice_available() {
365
+ let result = check_libreoffice_available().await;
366
+ if result.is_err() {
367
+ return;
368
+ }
369
+ assert!(result.is_ok());
370
+ }
371
+
372
+ #[tokio::test]
373
+ async fn test_convert_office_doc_missing_file() {
374
+ if check_libreoffice_available().await.is_err() {
375
+ return;
376
+ }
377
+
378
+ let temp_dir = std::env::temp_dir();
379
+ let output_dir = temp_dir.join("test_convert_office_doc_missing_file");
380
+ let non_existent = Path::new("/tmp/nonexistent.doc");
381
+
382
+ let result = convert_office_doc(non_existent, &output_dir, "docx", 10).await;
383
+
384
+ assert!(result.is_err());
385
+ let _ = fs::remove_dir_all(&output_dir).await;
386
+ }
387
+
388
+ #[test]
389
+ fn test_default_conversion_timeout_value() {
390
+ assert_eq!(DEFAULT_CONVERSION_TIMEOUT, 300);
391
+ }
392
+
393
+ #[tokio::test]
394
+ async fn test_convert_doc_to_docx_empty_bytes() {
395
+ if check_libreoffice_available().await.is_err() {
396
+ return;
397
+ }
398
+
399
+ let empty_bytes = b"";
400
+ let result = convert_doc_to_docx(empty_bytes).await;
401
+
402
+ let _ = result;
403
+ }
404
+
405
+ #[tokio::test]
406
+ async fn test_convert_ppt_to_pptx_empty_bytes() {
407
+ if check_libreoffice_available().await.is_err() {
408
+ return;
409
+ }
410
+
411
+ let empty_bytes = b"";
412
+ let result = convert_ppt_to_pptx(empty_bytes).await;
413
+
414
+ let _ = result;
415
+ }
416
+
417
+ #[tokio::test]
418
+ async fn test_convert_doc_to_docx_invalid_doc() {
419
+ if check_libreoffice_available().await.is_err() {
420
+ return;
421
+ }
422
+
423
+ let invalid_doc = b"This is not a valid .doc file";
424
+ let result = convert_doc_to_docx(invalid_doc).await;
425
+
426
+ let _ = result;
427
+ }
428
+
429
+ #[tokio::test]
430
+ async fn test_convert_ppt_to_pptx_invalid_ppt() {
431
+ if check_libreoffice_available().await.is_err() {
432
+ return;
433
+ }
434
+
435
+ let invalid_ppt = b"This is not a valid .ppt file";
436
+ let result = convert_ppt_to_pptx(invalid_ppt).await;
437
+
438
+ assert!(result.is_err());
439
+ }
440
+
441
+ #[tokio::test]
442
+ async fn test_convert_office_doc_invalid_target_format() {
443
+ if check_libreoffice_available().await.is_err() {
444
+ return;
445
+ }
446
+
447
+ let temp_dir = std::env::temp_dir();
448
+ let input_path = temp_dir.join("test_input.txt");
449
+ let output_dir = temp_dir.join("test_output_invalid_format");
450
+
451
+ fs::write(&input_path, b"test content").await.unwrap();
452
+
453
+ let result = convert_office_doc(&input_path, &output_dir, "invalid_format", 10).await;
454
+
455
+ let _ = fs::remove_file(&input_path).await;
456
+ let _ = fs::remove_dir_all(&output_dir).await;
457
+
458
+ let _ = result;
459
+ }
460
+
461
+ #[tokio::test]
462
+ async fn test_check_libreoffice_missing_dependency_error() {
463
+ let result = check_libreoffice_available().await;
464
+
465
+ if result.is_err() {
466
+ let err = result.unwrap_err();
467
+ match err {
468
+ KreuzbergError::MissingDependency(msg) => {
469
+ assert!(msg.contains("LibreOffice") || msg.contains("soffice"));
470
+ }
471
+ _ => panic!("Expected MissingDependency error"),
472
+ }
473
+ }
474
+ }
475
+
476
+ #[tokio::test]
477
+ async fn test_convert_office_doc_creates_output_dir() {
478
+ if check_libreoffice_available().await.is_err() {
479
+ return;
480
+ }
481
+
482
+ let temp_dir = std::env::temp_dir();
483
+ let output_dir = temp_dir.join(format!("test_create_output_{}", uuid::Uuid::new_v4()));
484
+
485
+ assert!(!output_dir.exists());
486
+
487
+ let input_path = temp_dir.join("test_create_output.txt");
488
+ fs::write(&input_path, b"test").await.unwrap();
489
+
490
+ let _ = convert_office_doc(&input_path, &output_dir, "pdf", 10).await;
491
+
492
+ let _ = fs::remove_file(&input_path).await;
493
+ let _ = fs::remove_dir_all(&output_dir).await;
494
+ }
495
+
496
+ #[tokio::test]
497
+ async fn test_conversion_result_structure() {
498
+ let result = LibreOfficeConversionResult {
499
+ converted_bytes: vec![1, 2, 3],
500
+ original_format: "doc".to_string(),
501
+ target_format: "docx".to_string(),
502
+ target_mime: crate::core::mime::DOCX_MIME_TYPE.to_string(),
503
+ };
504
+
505
+ assert_eq!(result.original_format, "doc");
506
+ assert_eq!(result.target_format, "docx");
507
+ assert_eq!(result.converted_bytes.len(), 3);
508
+ }
509
+
510
+ #[tokio::test]
511
+ async fn test_convert_doc_to_docx_temp_cleanup() {
512
+ if check_libreoffice_available().await.is_err() {
513
+ return;
514
+ }
515
+
516
+ let invalid_doc = b"invalid doc content";
517
+ let _result = convert_doc_to_docx(invalid_doc).await;
518
+ }
519
+
520
+ #[tokio::test]
521
+ async fn test_convert_ppt_to_pptx_temp_cleanup() {
522
+ if check_libreoffice_available().await.is_err() {
523
+ return;
524
+ }
525
+
526
+ let invalid_ppt = b"invalid ppt content";
527
+ let _result = convert_ppt_to_pptx(invalid_ppt).await;
528
+ }
529
+
530
+ #[tokio::test]
531
+ async fn test_convert_office_doc_timeout_kills_process() {
532
+ if check_libreoffice_available().await.is_err() {
533
+ return;
534
+ }
535
+
536
+ let temp_dir = std::env::temp_dir();
537
+ let input_path = temp_dir.join("test_timeout_input.txt");
538
+ let output_dir = temp_dir.join("test_timeout_output");
539
+
540
+ fs::write(&input_path, b"test content").await.unwrap();
541
+
542
+ let result = convert_office_doc(&input_path, &output_dir, "pdf", 0).await;
543
+
544
+ assert!(result.is_err());
545
+
546
+ let _ = fs::remove_file(&input_path).await;
547
+ let _ = fs::remove_dir_all(&output_dir).await;
548
+ }
549
+
550
+ #[tokio::test]
551
+ async fn test_tempdir_raii_cleanup_on_error() {
552
+ let temp_path = std::env::temp_dir().join(format!("test_raii_{}", uuid::Uuid::new_v4()));
553
+
554
+ {
555
+ let _guard = TempDir::new(temp_path.clone()).await.unwrap();
556
+ assert!(temp_path.exists());
557
+ }
558
+
559
+ tokio::time::sleep(tokio::time::Duration::from_millis(100)).await;
560
+
561
+ assert!(!temp_path.exists() || fs::read_dir(&temp_path).await.is_err());
562
+ }
563
+ }