kreuzberg 4.0.0.pre.rc.6
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.
- checksums.yaml +7 -0
- data/.gitignore +14 -0
- data/.rspec +3 -0
- data/.rubocop.yaml +1 -0
- data/.rubocop.yml +538 -0
- data/Gemfile +8 -0
- data/Gemfile.lock +157 -0
- data/README.md +426 -0
- data/Rakefile +25 -0
- data/Steepfile +47 -0
- data/examples/async_patterns.rb +341 -0
- data/ext/kreuzberg_rb/extconf.rb +45 -0
- data/ext/kreuzberg_rb/native/Cargo.lock +6535 -0
- data/ext/kreuzberg_rb/native/Cargo.toml +44 -0
- data/ext/kreuzberg_rb/native/README.md +425 -0
- data/ext/kreuzberg_rb/native/build.rs +15 -0
- data/ext/kreuzberg_rb/native/include/ieeefp.h +11 -0
- data/ext/kreuzberg_rb/native/include/msvc_compat/strings.h +14 -0
- data/ext/kreuzberg_rb/native/include/strings.h +20 -0
- data/ext/kreuzberg_rb/native/include/unistd.h +47 -0
- data/ext/kreuzberg_rb/native/src/lib.rs +2998 -0
- data/extconf.rb +28 -0
- data/kreuzberg.gemspec +148 -0
- data/lib/kreuzberg/api_proxy.rb +142 -0
- data/lib/kreuzberg/cache_api.rb +46 -0
- data/lib/kreuzberg/cli.rb +55 -0
- data/lib/kreuzberg/cli_proxy.rb +127 -0
- data/lib/kreuzberg/config.rb +691 -0
- data/lib/kreuzberg/error_context.rb +32 -0
- data/lib/kreuzberg/errors.rb +118 -0
- data/lib/kreuzberg/extraction_api.rb +85 -0
- data/lib/kreuzberg/mcp_proxy.rb +186 -0
- data/lib/kreuzberg/ocr_backend_protocol.rb +113 -0
- data/lib/kreuzberg/post_processor_protocol.rb +86 -0
- data/lib/kreuzberg/result.rb +216 -0
- data/lib/kreuzberg/setup_lib_path.rb +80 -0
- data/lib/kreuzberg/validator_protocol.rb +89 -0
- data/lib/kreuzberg/version.rb +5 -0
- data/lib/kreuzberg.rb +103 -0
- data/sig/kreuzberg/internal.rbs +184 -0
- data/sig/kreuzberg.rbs +520 -0
- data/spec/binding/cache_spec.rb +227 -0
- data/spec/binding/cli_proxy_spec.rb +85 -0
- data/spec/binding/cli_spec.rb +55 -0
- data/spec/binding/config_spec.rb +345 -0
- data/spec/binding/config_validation_spec.rb +283 -0
- data/spec/binding/error_handling_spec.rb +213 -0
- data/spec/binding/errors_spec.rb +66 -0
- data/spec/binding/plugins/ocr_backend_spec.rb +307 -0
- data/spec/binding/plugins/postprocessor_spec.rb +269 -0
- data/spec/binding/plugins/validator_spec.rb +274 -0
- data/spec/fixtures/config.toml +39 -0
- data/spec/fixtures/config.yaml +41 -0
- data/spec/fixtures/invalid_config.toml +4 -0
- data/spec/smoke/package_spec.rb +178 -0
- data/spec/spec_helper.rb +42 -0
- data/vendor/kreuzberg/Cargo.toml +204 -0
- data/vendor/kreuzberg/README.md +175 -0
- data/vendor/kreuzberg/benches/otel_overhead.rs +48 -0
- data/vendor/kreuzberg/build.rs +474 -0
- data/vendor/kreuzberg/src/api/error.rs +81 -0
- data/vendor/kreuzberg/src/api/handlers.rs +199 -0
- data/vendor/kreuzberg/src/api/mod.rs +79 -0
- data/vendor/kreuzberg/src/api/server.rs +353 -0
- data/vendor/kreuzberg/src/api/types.rs +170 -0
- data/vendor/kreuzberg/src/cache/mod.rs +1167 -0
- data/vendor/kreuzberg/src/chunking/mod.rs +677 -0
- data/vendor/kreuzberg/src/core/batch_mode.rs +95 -0
- data/vendor/kreuzberg/src/core/config.rs +1032 -0
- data/vendor/kreuzberg/src/core/extractor.rs +1024 -0
- data/vendor/kreuzberg/src/core/io.rs +329 -0
- data/vendor/kreuzberg/src/core/mime.rs +605 -0
- data/vendor/kreuzberg/src/core/mod.rs +45 -0
- data/vendor/kreuzberg/src/core/pipeline.rs +984 -0
- data/vendor/kreuzberg/src/embeddings.rs +432 -0
- data/vendor/kreuzberg/src/error.rs +431 -0
- data/vendor/kreuzberg/src/extraction/archive.rs +954 -0
- data/vendor/kreuzberg/src/extraction/docx.rs +40 -0
- data/vendor/kreuzberg/src/extraction/email.rs +854 -0
- data/vendor/kreuzberg/src/extraction/excel.rs +688 -0
- data/vendor/kreuzberg/src/extraction/html.rs +553 -0
- data/vendor/kreuzberg/src/extraction/image.rs +368 -0
- data/vendor/kreuzberg/src/extraction/libreoffice.rs +563 -0
- data/vendor/kreuzberg/src/extraction/markdown.rs +213 -0
- data/vendor/kreuzberg/src/extraction/mod.rs +81 -0
- data/vendor/kreuzberg/src/extraction/office_metadata/app_properties.rs +398 -0
- data/vendor/kreuzberg/src/extraction/office_metadata/core_properties.rs +247 -0
- data/vendor/kreuzberg/src/extraction/office_metadata/custom_properties.rs +240 -0
- data/vendor/kreuzberg/src/extraction/office_metadata/mod.rs +130 -0
- data/vendor/kreuzberg/src/extraction/office_metadata/odt_properties.rs +287 -0
- data/vendor/kreuzberg/src/extraction/pptx.rs +3000 -0
- data/vendor/kreuzberg/src/extraction/structured.rs +490 -0
- data/vendor/kreuzberg/src/extraction/table.rs +328 -0
- data/vendor/kreuzberg/src/extraction/text.rs +269 -0
- data/vendor/kreuzberg/src/extraction/xml.rs +333 -0
- data/vendor/kreuzberg/src/extractors/archive.rs +446 -0
- data/vendor/kreuzberg/src/extractors/bibtex.rs +469 -0
- data/vendor/kreuzberg/src/extractors/docbook.rs +502 -0
- data/vendor/kreuzberg/src/extractors/docx.rs +367 -0
- data/vendor/kreuzberg/src/extractors/email.rs +143 -0
- data/vendor/kreuzberg/src/extractors/epub.rs +707 -0
- data/vendor/kreuzberg/src/extractors/excel.rs +343 -0
- data/vendor/kreuzberg/src/extractors/fictionbook.rs +491 -0
- data/vendor/kreuzberg/src/extractors/fictionbook.rs.backup2 +738 -0
- data/vendor/kreuzberg/src/extractors/html.rs +393 -0
- data/vendor/kreuzberg/src/extractors/image.rs +198 -0
- data/vendor/kreuzberg/src/extractors/jats.rs +1051 -0
- data/vendor/kreuzberg/src/extractors/jupyter.rs +367 -0
- data/vendor/kreuzberg/src/extractors/latex.rs +652 -0
- data/vendor/kreuzberg/src/extractors/markdown.rs +700 -0
- data/vendor/kreuzberg/src/extractors/mod.rs +365 -0
- data/vendor/kreuzberg/src/extractors/odt.rs +628 -0
- data/vendor/kreuzberg/src/extractors/opml.rs +634 -0
- data/vendor/kreuzberg/src/extractors/orgmode.rs +528 -0
- data/vendor/kreuzberg/src/extractors/pdf.rs +493 -0
- data/vendor/kreuzberg/src/extractors/pptx.rs +248 -0
- data/vendor/kreuzberg/src/extractors/rst.rs +576 -0
- data/vendor/kreuzberg/src/extractors/rtf.rs +810 -0
- data/vendor/kreuzberg/src/extractors/security.rs +484 -0
- data/vendor/kreuzberg/src/extractors/security_tests.rs +367 -0
- data/vendor/kreuzberg/src/extractors/structured.rs +140 -0
- data/vendor/kreuzberg/src/extractors/text.rs +260 -0
- data/vendor/kreuzberg/src/extractors/typst.rs +650 -0
- data/vendor/kreuzberg/src/extractors/xml.rs +135 -0
- data/vendor/kreuzberg/src/image/dpi.rs +164 -0
- data/vendor/kreuzberg/src/image/mod.rs +6 -0
- data/vendor/kreuzberg/src/image/preprocessing.rs +417 -0
- data/vendor/kreuzberg/src/image/resize.rs +89 -0
- data/vendor/kreuzberg/src/keywords/config.rs +154 -0
- data/vendor/kreuzberg/src/keywords/mod.rs +237 -0
- data/vendor/kreuzberg/src/keywords/processor.rs +267 -0
- data/vendor/kreuzberg/src/keywords/rake.rs +293 -0
- data/vendor/kreuzberg/src/keywords/types.rs +68 -0
- data/vendor/kreuzberg/src/keywords/yake.rs +163 -0
- data/vendor/kreuzberg/src/language_detection/mod.rs +942 -0
- data/vendor/kreuzberg/src/lib.rs +105 -0
- data/vendor/kreuzberg/src/mcp/mod.rs +32 -0
- data/vendor/kreuzberg/src/mcp/server.rs +1968 -0
- data/vendor/kreuzberg/src/ocr/cache.rs +469 -0
- data/vendor/kreuzberg/src/ocr/error.rs +37 -0
- data/vendor/kreuzberg/src/ocr/hocr.rs +216 -0
- data/vendor/kreuzberg/src/ocr/mod.rs +58 -0
- data/vendor/kreuzberg/src/ocr/processor.rs +863 -0
- data/vendor/kreuzberg/src/ocr/table/mod.rs +4 -0
- data/vendor/kreuzberg/src/ocr/table/tsv_parser.rs +144 -0
- data/vendor/kreuzberg/src/ocr/tesseract_backend.rs +450 -0
- data/vendor/kreuzberg/src/ocr/types.rs +393 -0
- data/vendor/kreuzberg/src/ocr/utils.rs +47 -0
- data/vendor/kreuzberg/src/ocr/validation.rs +206 -0
- data/vendor/kreuzberg/src/panic_context.rs +154 -0
- data/vendor/kreuzberg/src/pdf/error.rs +122 -0
- data/vendor/kreuzberg/src/pdf/images.rs +139 -0
- data/vendor/kreuzberg/src/pdf/metadata.rs +346 -0
- data/vendor/kreuzberg/src/pdf/mod.rs +50 -0
- data/vendor/kreuzberg/src/pdf/rendering.rs +369 -0
- data/vendor/kreuzberg/src/pdf/table.rs +393 -0
- data/vendor/kreuzberg/src/pdf/text.rs +158 -0
- data/vendor/kreuzberg/src/plugins/extractor.rs +1013 -0
- data/vendor/kreuzberg/src/plugins/mod.rs +209 -0
- data/vendor/kreuzberg/src/plugins/ocr.rs +620 -0
- data/vendor/kreuzberg/src/plugins/processor.rs +642 -0
- data/vendor/kreuzberg/src/plugins/registry.rs +1337 -0
- data/vendor/kreuzberg/src/plugins/traits.rs +258 -0
- data/vendor/kreuzberg/src/plugins/validator.rs +956 -0
- data/vendor/kreuzberg/src/stopwords/mod.rs +1470 -0
- data/vendor/kreuzberg/src/text/mod.rs +19 -0
- data/vendor/kreuzberg/src/text/quality.rs +697 -0
- data/vendor/kreuzberg/src/text/string_utils.rs +217 -0
- data/vendor/kreuzberg/src/text/token_reduction/cjk_utils.rs +164 -0
- data/vendor/kreuzberg/src/text/token_reduction/config.rs +100 -0
- data/vendor/kreuzberg/src/text/token_reduction/core.rs +796 -0
- data/vendor/kreuzberg/src/text/token_reduction/filters.rs +902 -0
- data/vendor/kreuzberg/src/text/token_reduction/mod.rs +160 -0
- data/vendor/kreuzberg/src/text/token_reduction/semantic.rs +619 -0
- data/vendor/kreuzberg/src/text/token_reduction/simd_text.rs +147 -0
- data/vendor/kreuzberg/src/types.rs +903 -0
- data/vendor/kreuzberg/src/utils/mod.rs +17 -0
- data/vendor/kreuzberg/src/utils/quality.rs +959 -0
- data/vendor/kreuzberg/src/utils/string_utils.rs +381 -0
- data/vendor/kreuzberg/stopwords/af_stopwords.json +53 -0
- data/vendor/kreuzberg/stopwords/ar_stopwords.json +482 -0
- data/vendor/kreuzberg/stopwords/bg_stopwords.json +261 -0
- data/vendor/kreuzberg/stopwords/bn_stopwords.json +400 -0
- data/vendor/kreuzberg/stopwords/br_stopwords.json +1205 -0
- data/vendor/kreuzberg/stopwords/ca_stopwords.json +280 -0
- data/vendor/kreuzberg/stopwords/cs_stopwords.json +425 -0
- data/vendor/kreuzberg/stopwords/da_stopwords.json +172 -0
- data/vendor/kreuzberg/stopwords/de_stopwords.json +622 -0
- data/vendor/kreuzberg/stopwords/el_stopwords.json +849 -0
- data/vendor/kreuzberg/stopwords/en_stopwords.json +1300 -0
- data/vendor/kreuzberg/stopwords/eo_stopwords.json +175 -0
- data/vendor/kreuzberg/stopwords/es_stopwords.json +734 -0
- data/vendor/kreuzberg/stopwords/et_stopwords.json +37 -0
- data/vendor/kreuzberg/stopwords/eu_stopwords.json +100 -0
- data/vendor/kreuzberg/stopwords/fa_stopwords.json +801 -0
- data/vendor/kreuzberg/stopwords/fi_stopwords.json +849 -0
- data/vendor/kreuzberg/stopwords/fr_stopwords.json +693 -0
- data/vendor/kreuzberg/stopwords/ga_stopwords.json +111 -0
- data/vendor/kreuzberg/stopwords/gl_stopwords.json +162 -0
- data/vendor/kreuzberg/stopwords/gu_stopwords.json +226 -0
- data/vendor/kreuzberg/stopwords/ha_stopwords.json +41 -0
- data/vendor/kreuzberg/stopwords/he_stopwords.json +196 -0
- data/vendor/kreuzberg/stopwords/hi_stopwords.json +227 -0
- data/vendor/kreuzberg/stopwords/hr_stopwords.json +181 -0
- data/vendor/kreuzberg/stopwords/hu_stopwords.json +791 -0
- data/vendor/kreuzberg/stopwords/hy_stopwords.json +47 -0
- data/vendor/kreuzberg/stopwords/id_stopwords.json +760 -0
- data/vendor/kreuzberg/stopwords/it_stopwords.json +634 -0
- data/vendor/kreuzberg/stopwords/ja_stopwords.json +136 -0
- data/vendor/kreuzberg/stopwords/kn_stopwords.json +84 -0
- data/vendor/kreuzberg/stopwords/ko_stopwords.json +681 -0
- data/vendor/kreuzberg/stopwords/ku_stopwords.json +64 -0
- data/vendor/kreuzberg/stopwords/la_stopwords.json +51 -0
- data/vendor/kreuzberg/stopwords/lt_stopwords.json +476 -0
- data/vendor/kreuzberg/stopwords/lv_stopwords.json +163 -0
- data/vendor/kreuzberg/stopwords/ml_stopwords.json +1 -0
- data/vendor/kreuzberg/stopwords/mr_stopwords.json +101 -0
- data/vendor/kreuzberg/stopwords/ms_stopwords.json +477 -0
- data/vendor/kreuzberg/stopwords/ne_stopwords.json +490 -0
- data/vendor/kreuzberg/stopwords/nl_stopwords.json +415 -0
- data/vendor/kreuzberg/stopwords/no_stopwords.json +223 -0
- data/vendor/kreuzberg/stopwords/pl_stopwords.json +331 -0
- data/vendor/kreuzberg/stopwords/pt_stopwords.json +562 -0
- data/vendor/kreuzberg/stopwords/ro_stopwords.json +436 -0
- data/vendor/kreuzberg/stopwords/ru_stopwords.json +561 -0
- data/vendor/kreuzberg/stopwords/si_stopwords.json +193 -0
- data/vendor/kreuzberg/stopwords/sk_stopwords.json +420 -0
- data/vendor/kreuzberg/stopwords/sl_stopwords.json +448 -0
- data/vendor/kreuzberg/stopwords/so_stopwords.json +32 -0
- data/vendor/kreuzberg/stopwords/st_stopwords.json +33 -0
- data/vendor/kreuzberg/stopwords/sv_stopwords.json +420 -0
- data/vendor/kreuzberg/stopwords/sw_stopwords.json +76 -0
- data/vendor/kreuzberg/stopwords/ta_stopwords.json +129 -0
- data/vendor/kreuzberg/stopwords/te_stopwords.json +54 -0
- data/vendor/kreuzberg/stopwords/th_stopwords.json +118 -0
- data/vendor/kreuzberg/stopwords/tl_stopwords.json +149 -0
- data/vendor/kreuzberg/stopwords/tr_stopwords.json +506 -0
- data/vendor/kreuzberg/stopwords/uk_stopwords.json +75 -0
- data/vendor/kreuzberg/stopwords/ur_stopwords.json +519 -0
- data/vendor/kreuzberg/stopwords/vi_stopwords.json +647 -0
- data/vendor/kreuzberg/stopwords/yo_stopwords.json +62 -0
- data/vendor/kreuzberg/stopwords/zh_stopwords.json +796 -0
- data/vendor/kreuzberg/stopwords/zu_stopwords.json +31 -0
- data/vendor/kreuzberg/tests/api_extract_multipart.rs +52 -0
- data/vendor/kreuzberg/tests/api_tests.rs +966 -0
- data/vendor/kreuzberg/tests/archive_integration.rs +543 -0
- data/vendor/kreuzberg/tests/batch_orchestration.rs +556 -0
- data/vendor/kreuzberg/tests/batch_processing.rs +316 -0
- data/vendor/kreuzberg/tests/bibtex_parity_test.rs +421 -0
- data/vendor/kreuzberg/tests/concurrency_stress.rs +525 -0
- data/vendor/kreuzberg/tests/config_features.rs +598 -0
- data/vendor/kreuzberg/tests/config_loading_tests.rs +415 -0
- data/vendor/kreuzberg/tests/core_integration.rs +510 -0
- data/vendor/kreuzberg/tests/csv_integration.rs +414 -0
- data/vendor/kreuzberg/tests/docbook_extractor_tests.rs +498 -0
- data/vendor/kreuzberg/tests/docx_metadata_extraction_test.rs +122 -0
- data/vendor/kreuzberg/tests/docx_vs_pandoc_comparison.rs +370 -0
- data/vendor/kreuzberg/tests/email_integration.rs +325 -0
- data/vendor/kreuzberg/tests/epub_native_extractor_tests.rs +275 -0
- data/vendor/kreuzberg/tests/error_handling.rs +393 -0
- data/vendor/kreuzberg/tests/fictionbook_extractor_tests.rs +228 -0
- data/vendor/kreuzberg/tests/format_integration.rs +159 -0
- data/vendor/kreuzberg/tests/helpers/mod.rs +142 -0
- data/vendor/kreuzberg/tests/html_table_test.rs +551 -0
- data/vendor/kreuzberg/tests/image_integration.rs +253 -0
- data/vendor/kreuzberg/tests/instrumentation_test.rs +139 -0
- data/vendor/kreuzberg/tests/jats_extractor_tests.rs +639 -0
- data/vendor/kreuzberg/tests/jupyter_extractor_tests.rs +704 -0
- data/vendor/kreuzberg/tests/keywords_integration.rs +479 -0
- data/vendor/kreuzberg/tests/keywords_quality.rs +509 -0
- data/vendor/kreuzberg/tests/latex_extractor_tests.rs +496 -0
- data/vendor/kreuzberg/tests/markdown_extractor_tests.rs +490 -0
- data/vendor/kreuzberg/tests/mime_detection.rs +428 -0
- data/vendor/kreuzberg/tests/ocr_configuration.rs +510 -0
- data/vendor/kreuzberg/tests/ocr_errors.rs +676 -0
- data/vendor/kreuzberg/tests/ocr_quality.rs +627 -0
- data/vendor/kreuzberg/tests/ocr_stress.rs +469 -0
- data/vendor/kreuzberg/tests/odt_extractor_tests.rs +695 -0
- data/vendor/kreuzberg/tests/opml_extractor_tests.rs +616 -0
- data/vendor/kreuzberg/tests/orgmode_extractor_tests.rs +822 -0
- data/vendor/kreuzberg/tests/pdf_integration.rs +43 -0
- data/vendor/kreuzberg/tests/pipeline_integration.rs +1411 -0
- data/vendor/kreuzberg/tests/plugin_ocr_backend_test.rs +771 -0
- data/vendor/kreuzberg/tests/plugin_postprocessor_test.rs +560 -0
- data/vendor/kreuzberg/tests/plugin_system.rs +921 -0
- data/vendor/kreuzberg/tests/plugin_validator_test.rs +783 -0
- data/vendor/kreuzberg/tests/registry_integration_tests.rs +586 -0
- data/vendor/kreuzberg/tests/rst_extractor_tests.rs +692 -0
- data/vendor/kreuzberg/tests/rtf_extractor_tests.rs +776 -0
- data/vendor/kreuzberg/tests/security_validation.rs +415 -0
- data/vendor/kreuzberg/tests/stopwords_integration_test.rs +888 -0
- data/vendor/kreuzberg/tests/test_fastembed.rs +609 -0
- data/vendor/kreuzberg/tests/typst_behavioral_tests.rs +1259 -0
- data/vendor/kreuzberg/tests/typst_extractor_tests.rs +647 -0
- data/vendor/kreuzberg/tests/xlsx_metadata_extraction_test.rs +87 -0
- data/vendor/rb-sys/.cargo-ok +1 -0
- data/vendor/rb-sys/.cargo_vcs_info.json +6 -0
- data/vendor/rb-sys/Cargo.lock +393 -0
- data/vendor/rb-sys/Cargo.toml +70 -0
- data/vendor/rb-sys/Cargo.toml.orig +57 -0
- data/vendor/rb-sys/LICENSE-APACHE +190 -0
- data/vendor/rb-sys/LICENSE-MIT +21 -0
- data/vendor/rb-sys/bin/release.sh +21 -0
- data/vendor/rb-sys/build/features.rs +108 -0
- data/vendor/rb-sys/build/main.rs +246 -0
- data/vendor/rb-sys/build/stable_api_config.rs +153 -0
- data/vendor/rb-sys/build/version.rs +48 -0
- data/vendor/rb-sys/readme.md +36 -0
- data/vendor/rb-sys/src/bindings.rs +21 -0
- data/vendor/rb-sys/src/hidden.rs +11 -0
- data/vendor/rb-sys/src/lib.rs +34 -0
- data/vendor/rb-sys/src/macros.rs +371 -0
- data/vendor/rb-sys/src/memory.rs +53 -0
- data/vendor/rb-sys/src/ruby_abi_version.rs +38 -0
- data/vendor/rb-sys/src/special_consts.rs +31 -0
- data/vendor/rb-sys/src/stable_api/compiled.c +179 -0
- data/vendor/rb-sys/src/stable_api/compiled.rs +257 -0
- data/vendor/rb-sys/src/stable_api/ruby_2_6.rs +316 -0
- data/vendor/rb-sys/src/stable_api/ruby_2_7.rs +316 -0
- data/vendor/rb-sys/src/stable_api/ruby_3_0.rs +324 -0
- data/vendor/rb-sys/src/stable_api/ruby_3_1.rs +317 -0
- data/vendor/rb-sys/src/stable_api/ruby_3_2.rs +315 -0
- data/vendor/rb-sys/src/stable_api/ruby_3_3.rs +326 -0
- data/vendor/rb-sys/src/stable_api/ruby_3_4.rs +327 -0
- data/vendor/rb-sys/src/stable_api.rs +261 -0
- data/vendor/rb-sys/src/symbol.rs +31 -0
- data/vendor/rb-sys/src/tracking_allocator.rs +332 -0
- data/vendor/rb-sys/src/utils.rs +89 -0
- data/vendor/rb-sys/src/value_type.rs +7 -0
- metadata +536 -0
|
@@ -0,0 +1,247 @@
|
|
|
1
|
+
//! Core properties extraction from docProps/core.xml
|
|
2
|
+
//!
|
|
3
|
+
//! Extracts Dublin Core metadata from Office Open XML documents.
|
|
4
|
+
|
|
5
|
+
use crate::error::{KreuzbergError, Result};
|
|
6
|
+
use std::io::Read;
|
|
7
|
+
use zip::ZipArchive;
|
|
8
|
+
|
|
9
|
+
/// Dublin Core metadata from docProps/core.xml
|
|
10
|
+
///
|
|
11
|
+
/// Contains standard metadata fields defined by the Dublin Core standard
|
|
12
|
+
/// and Office-specific extensions.
|
|
13
|
+
#[derive(Debug, Clone, Default, PartialEq)]
|
|
14
|
+
pub struct CoreProperties {
|
|
15
|
+
/// Document title
|
|
16
|
+
pub title: Option<String>,
|
|
17
|
+
/// Document subject/topic
|
|
18
|
+
pub subject: Option<String>,
|
|
19
|
+
/// Document creator/author
|
|
20
|
+
pub creator: Option<String>,
|
|
21
|
+
/// Keywords or tags
|
|
22
|
+
pub keywords: Option<String>,
|
|
23
|
+
/// Document description/abstract
|
|
24
|
+
pub description: Option<String>,
|
|
25
|
+
/// User who last modified the document
|
|
26
|
+
pub last_modified_by: Option<String>,
|
|
27
|
+
/// Revision number
|
|
28
|
+
pub revision: Option<String>,
|
|
29
|
+
/// Creation timestamp (ISO 8601)
|
|
30
|
+
pub created: Option<String>,
|
|
31
|
+
/// Last modification timestamp (ISO 8601)
|
|
32
|
+
pub modified: Option<String>,
|
|
33
|
+
/// Document category
|
|
34
|
+
pub category: Option<String>,
|
|
35
|
+
/// Content status (Draft, Final, etc.)
|
|
36
|
+
pub content_status: Option<String>,
|
|
37
|
+
/// Document language
|
|
38
|
+
pub language: Option<String>,
|
|
39
|
+
/// Unique identifier
|
|
40
|
+
pub identifier: Option<String>,
|
|
41
|
+
/// Document version
|
|
42
|
+
pub version: Option<String>,
|
|
43
|
+
/// Last print timestamp (ISO 8601)
|
|
44
|
+
pub last_printed: Option<String>,
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
/// Extract core properties from an Office Open XML document
|
|
48
|
+
///
|
|
49
|
+
/// Parses `docProps/core.xml` from the ZIP archive and extracts Dublin Core metadata.
|
|
50
|
+
///
|
|
51
|
+
/// # Arguments
|
|
52
|
+
///
|
|
53
|
+
/// * `archive` - ZIP archive containing the Office document
|
|
54
|
+
///
|
|
55
|
+
/// # Returns
|
|
56
|
+
///
|
|
57
|
+
/// Returns `CoreProperties` with extracted metadata. Fields that are not present
|
|
58
|
+
/// in the document will be `None`.
|
|
59
|
+
///
|
|
60
|
+
/// # Errors
|
|
61
|
+
///
|
|
62
|
+
/// Returns an error if:
|
|
63
|
+
/// - The ZIP archive cannot be read
|
|
64
|
+
/// - The core.xml file is malformed
|
|
65
|
+
/// - XML parsing fails
|
|
66
|
+
///
|
|
67
|
+
/// # Example
|
|
68
|
+
///
|
|
69
|
+
/// ```no_run
|
|
70
|
+
/// use kreuzberg::extraction::office_metadata::extract_core_properties;
|
|
71
|
+
/// use std::fs::File;
|
|
72
|
+
/// use zip::ZipArchive;
|
|
73
|
+
///
|
|
74
|
+
/// let file = File::open("document.docx")?;
|
|
75
|
+
/// let mut archive = ZipArchive::new(file)?;
|
|
76
|
+
/// let core = extract_core_properties(&mut archive)?;
|
|
77
|
+
///
|
|
78
|
+
/// println!("Title: {:?}", core.title);
|
|
79
|
+
/// println!("Creator: {:?}", core.creator);
|
|
80
|
+
/// println!("Created: {:?}", core.created);
|
|
81
|
+
/// # Ok::<(), Box<dyn std::error::Error>>(())
|
|
82
|
+
/// ```
|
|
83
|
+
pub fn extract_core_properties<R: Read + std::io::Seek>(archive: &mut ZipArchive<R>) -> Result<CoreProperties> {
|
|
84
|
+
let mut xml_content = String::new();
|
|
85
|
+
|
|
86
|
+
match archive.by_name("docProps/core.xml") {
|
|
87
|
+
Ok(mut file) => {
|
|
88
|
+
file.read_to_string(&mut xml_content)
|
|
89
|
+
.map_err(|e| KreuzbergError::parsing(format!("Failed to read core.xml: {}", e)))?;
|
|
90
|
+
}
|
|
91
|
+
Err(_) => {
|
|
92
|
+
return Ok(CoreProperties::default());
|
|
93
|
+
}
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
let doc = roxmltree::Document::parse(&xml_content)
|
|
97
|
+
.map_err(|e| KreuzbergError::parsing(format!("Failed to parse core.xml: {}", e)))?;
|
|
98
|
+
|
|
99
|
+
let root = doc.root_element();
|
|
100
|
+
|
|
101
|
+
let title = super::parse_xml_text(root, "title");
|
|
102
|
+
let subject = super::parse_xml_text(root, "subject");
|
|
103
|
+
let creator = super::parse_xml_text(root, "creator");
|
|
104
|
+
let description = super::parse_xml_text(root, "description");
|
|
105
|
+
let language = super::parse_xml_text(root, "language");
|
|
106
|
+
let identifier = super::parse_xml_text(root, "identifier");
|
|
107
|
+
|
|
108
|
+
let keywords = super::parse_xml_text(root, "keywords");
|
|
109
|
+
let last_modified_by = super::parse_xml_text(root, "lastModifiedBy");
|
|
110
|
+
let revision = super::parse_xml_text(root, "revision");
|
|
111
|
+
let category = super::parse_xml_text(root, "category");
|
|
112
|
+
let content_status = super::parse_xml_text(root, "contentStatus");
|
|
113
|
+
let version = super::parse_xml_text(root, "version");
|
|
114
|
+
|
|
115
|
+
let created = super::parse_xml_text(root, "created");
|
|
116
|
+
let modified = super::parse_xml_text(root, "modified");
|
|
117
|
+
let last_printed = super::parse_xml_text(root, "lastPrinted");
|
|
118
|
+
|
|
119
|
+
Ok(CoreProperties {
|
|
120
|
+
title,
|
|
121
|
+
subject,
|
|
122
|
+
creator,
|
|
123
|
+
keywords,
|
|
124
|
+
description,
|
|
125
|
+
last_modified_by,
|
|
126
|
+
revision,
|
|
127
|
+
created,
|
|
128
|
+
modified,
|
|
129
|
+
category,
|
|
130
|
+
content_status,
|
|
131
|
+
language,
|
|
132
|
+
identifier,
|
|
133
|
+
version,
|
|
134
|
+
last_printed,
|
|
135
|
+
})
|
|
136
|
+
}
|
|
137
|
+
|
|
138
|
+
#[cfg(test)]
|
|
139
|
+
mod tests {
|
|
140
|
+
use super::*;
|
|
141
|
+
use std::io::{Cursor, Write};
|
|
142
|
+
|
|
143
|
+
fn create_test_zip_with_core_xml(core_xml: &str) -> ZipArchive<Cursor<Vec<u8>>> {
|
|
144
|
+
let buffer = Vec::new();
|
|
145
|
+
let cursor = Cursor::new(buffer);
|
|
146
|
+
let mut zip = zip::ZipWriter::new(cursor);
|
|
147
|
+
|
|
148
|
+
let options = zip::write::FileOptions::<()>::default().compression_method(zip::CompressionMethod::Stored);
|
|
149
|
+
|
|
150
|
+
zip.start_file("docProps/core.xml", options).unwrap();
|
|
151
|
+
zip.write_all(core_xml.as_bytes()).unwrap();
|
|
152
|
+
|
|
153
|
+
let cursor = zip.finish().unwrap();
|
|
154
|
+
ZipArchive::new(cursor).unwrap()
|
|
155
|
+
}
|
|
156
|
+
|
|
157
|
+
#[test]
|
|
158
|
+
fn test_extract_core_properties_full() {
|
|
159
|
+
let core_xml = r#"<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
|
|
160
|
+
<cp:coreProperties xmlns:cp="http://schemas.openxmlformats.org/package/2006/metadata/core-properties"
|
|
161
|
+
xmlns:dc="http://purl.org/dc/elements/1.1/"
|
|
162
|
+
xmlns:dcterms="http://purl.org/dc/terms/"
|
|
163
|
+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
|
|
164
|
+
<dc:title>Test Document</dc:title>
|
|
165
|
+
<dc:subject>Testing</dc:subject>
|
|
166
|
+
<dc:creator>John Doe</dc:creator>
|
|
167
|
+
<cp:keywords>test, metadata</cp:keywords>
|
|
168
|
+
<dc:description>A test document</dc:description>
|
|
169
|
+
<cp:lastModifiedBy>Jane Doe</cp:lastModifiedBy>
|
|
170
|
+
<cp:revision>5</cp:revision>
|
|
171
|
+
<dcterms:created xsi:type="dcterms:W3CDTF">2024-01-01T10:00:00Z</dcterms:created>
|
|
172
|
+
<dcterms:modified xsi:type="dcterms:W3CDTF">2024-01-02T15:30:00Z</dcterms:modified>
|
|
173
|
+
<cp:category>Documents</cp:category>
|
|
174
|
+
<cp:contentStatus>Final</cp:contentStatus>
|
|
175
|
+
<dc:language>en-US</dc:language>
|
|
176
|
+
</cp:coreProperties>"#;
|
|
177
|
+
|
|
178
|
+
let mut archive = create_test_zip_with_core_xml(core_xml);
|
|
179
|
+
let props = extract_core_properties(&mut archive).unwrap();
|
|
180
|
+
|
|
181
|
+
assert_eq!(props.title, Some("Test Document".to_string()));
|
|
182
|
+
assert_eq!(props.subject, Some("Testing".to_string()));
|
|
183
|
+
assert_eq!(props.creator, Some("John Doe".to_string()));
|
|
184
|
+
assert_eq!(props.keywords, Some("test, metadata".to_string()));
|
|
185
|
+
assert_eq!(props.description, Some("A test document".to_string()));
|
|
186
|
+
assert_eq!(props.last_modified_by, Some("Jane Doe".to_string()));
|
|
187
|
+
assert_eq!(props.revision, Some("5".to_string()));
|
|
188
|
+
assert_eq!(props.created, Some("2024-01-01T10:00:00Z".to_string()));
|
|
189
|
+
assert_eq!(props.modified, Some("2024-01-02T15:30:00Z".to_string()));
|
|
190
|
+
assert_eq!(props.category, Some("Documents".to_string()));
|
|
191
|
+
assert_eq!(props.content_status, Some("Final".to_string()));
|
|
192
|
+
assert_eq!(props.language, Some("en-US".to_string()));
|
|
193
|
+
}
|
|
194
|
+
|
|
195
|
+
#[test]
|
|
196
|
+
fn test_extract_core_properties_minimal() {
|
|
197
|
+
let core_xml = r#"<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
|
|
198
|
+
<cp:coreProperties xmlns:cp="http://schemas.openxmlformats.org/package/2006/metadata/core-properties"
|
|
199
|
+
xmlns:dc="http://purl.org/dc/elements/1.1/">
|
|
200
|
+
<dc:creator>Alice</dc:creator>
|
|
201
|
+
</cp:coreProperties>"#;
|
|
202
|
+
|
|
203
|
+
let mut archive = create_test_zip_with_core_xml(core_xml);
|
|
204
|
+
let props = extract_core_properties(&mut archive).unwrap();
|
|
205
|
+
|
|
206
|
+
assert_eq!(props.creator, Some("Alice".to_string()));
|
|
207
|
+
assert_eq!(props.title, None);
|
|
208
|
+
assert_eq!(props.keywords, None);
|
|
209
|
+
}
|
|
210
|
+
|
|
211
|
+
#[test]
|
|
212
|
+
fn test_extract_core_properties_empty_elements() {
|
|
213
|
+
let core_xml = r#"<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
|
|
214
|
+
<cp:coreProperties xmlns:cp="http://schemas.openxmlformats.org/package/2006/metadata/core-properties"
|
|
215
|
+
xmlns:dc="http://purl.org/dc/elements/1.1/">
|
|
216
|
+
<dc:title></dc:title>
|
|
217
|
+
<dc:creator>Bob</dc:creator>
|
|
218
|
+
</cp:coreProperties>"#;
|
|
219
|
+
|
|
220
|
+
let mut archive = create_test_zip_with_core_xml(core_xml);
|
|
221
|
+
let props = extract_core_properties(&mut archive).unwrap();
|
|
222
|
+
|
|
223
|
+
assert_eq!(props.title, None);
|
|
224
|
+
assert_eq!(props.creator, Some("Bob".to_string()));
|
|
225
|
+
}
|
|
226
|
+
|
|
227
|
+
#[test]
|
|
228
|
+
fn test_extract_core_properties_missing_file() {
|
|
229
|
+
let buffer = Vec::new();
|
|
230
|
+
let cursor = Cursor::new(buffer);
|
|
231
|
+
let zip = zip::ZipWriter::new(cursor);
|
|
232
|
+
let cursor = zip.finish().unwrap();
|
|
233
|
+
let mut archive = ZipArchive::new(cursor).unwrap();
|
|
234
|
+
|
|
235
|
+
let props = extract_core_properties(&mut archive).unwrap();
|
|
236
|
+
assert_eq!(props, CoreProperties::default());
|
|
237
|
+
}
|
|
238
|
+
|
|
239
|
+
#[test]
|
|
240
|
+
fn test_extract_core_properties_malformed_xml() {
|
|
241
|
+
let core_xml = "not valid xml <";
|
|
242
|
+
let mut archive = create_test_zip_with_core_xml(core_xml);
|
|
243
|
+
|
|
244
|
+
let result = extract_core_properties(&mut archive);
|
|
245
|
+
assert!(result.is_err());
|
|
246
|
+
}
|
|
247
|
+
}
|
|
@@ -0,0 +1,240 @@
|
|
|
1
|
+
//! Custom properties extraction from docProps/custom.xml
|
|
2
|
+
//!
|
|
3
|
+
//! Extracts user-defined custom metadata from Office Open XML documents.
|
|
4
|
+
|
|
5
|
+
use crate::error::{KreuzbergError, Result};
|
|
6
|
+
use serde_json::Value;
|
|
7
|
+
use std::collections::HashMap;
|
|
8
|
+
use std::io::Read;
|
|
9
|
+
use zip::ZipArchive;
|
|
10
|
+
|
|
11
|
+
/// Custom properties from docProps/custom.xml
|
|
12
|
+
///
|
|
13
|
+
/// Maps property names to their values. Values are converted to JSON types
|
|
14
|
+
/// based on the VT (Variant Type) specified in the XML.
|
|
15
|
+
pub type CustomProperties = HashMap<String, Value>;
|
|
16
|
+
|
|
17
|
+
/// Extract custom properties from an Office Open XML document
|
|
18
|
+
///
|
|
19
|
+
/// Parses `docProps/custom.xml` and extracts user-defined or application-defined
|
|
20
|
+
/// custom metadata.
|
|
21
|
+
///
|
|
22
|
+
/// # Arguments
|
|
23
|
+
///
|
|
24
|
+
/// * `archive` - ZIP archive containing the Office document
|
|
25
|
+
///
|
|
26
|
+
/// # Returns
|
|
27
|
+
///
|
|
28
|
+
/// Returns a `HashMap` of property names to JSON values. Supported VT types:
|
|
29
|
+
/// - `vt:lpwstr` / `vt:lpstr` → String
|
|
30
|
+
/// - `vt:i4` → Number (integer)
|
|
31
|
+
/// - `vt:r8` → Number (float)
|
|
32
|
+
/// - `vt:bool` → Boolean
|
|
33
|
+
/// - `vt:filetime` → String (ISO 8601 timestamp)
|
|
34
|
+
///
|
|
35
|
+
/// # Example
|
|
36
|
+
///
|
|
37
|
+
/// ```no_run
|
|
38
|
+
/// use kreuzberg::extraction::office_metadata::extract_custom_properties;
|
|
39
|
+
/// use std::fs::File;
|
|
40
|
+
/// use zip::ZipArchive;
|
|
41
|
+
///
|
|
42
|
+
/// let file = File::open("document.docx")?;
|
|
43
|
+
/// let mut archive = ZipArchive::new(file)?;
|
|
44
|
+
/// let custom = extract_custom_properties(&mut archive)?;
|
|
45
|
+
///
|
|
46
|
+
/// for (name, value) in custom {
|
|
47
|
+
/// println!("{}: {:?}", name, value);
|
|
48
|
+
/// }
|
|
49
|
+
/// # Ok::<(), Box<dyn std::error::Error>>(())
|
|
50
|
+
/// ```
|
|
51
|
+
pub fn extract_custom_properties<R: Read + std::io::Seek>(archive: &mut ZipArchive<R>) -> Result<CustomProperties> {
|
|
52
|
+
let mut xml_content = String::new();
|
|
53
|
+
|
|
54
|
+
match archive.by_name("docProps/custom.xml") {
|
|
55
|
+
Ok(mut file) => {
|
|
56
|
+
file.read_to_string(&mut xml_content)
|
|
57
|
+
.map_err(|e| KreuzbergError::parsing(format!("Failed to read custom.xml: {}", e)))?;
|
|
58
|
+
}
|
|
59
|
+
Err(_) => {
|
|
60
|
+
return Ok(HashMap::new());
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
let doc = roxmltree::Document::parse(&xml_content)
|
|
65
|
+
.map_err(|e| KreuzbergError::parsing(format!("Failed to parse custom.xml: {}", e)))?;
|
|
66
|
+
|
|
67
|
+
let root = doc.root_element();
|
|
68
|
+
let mut properties = HashMap::new();
|
|
69
|
+
|
|
70
|
+
for property_node in root.descendants().filter(|n| n.has_tag_name("property")) {
|
|
71
|
+
if let Some(name) = property_node.attribute("name")
|
|
72
|
+
&& let Some(value) = extract_vt_value(property_node)
|
|
73
|
+
{
|
|
74
|
+
properties.insert(name.to_string(), value);
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
Ok(properties)
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
/// Extract value from a VT (Variant Type) element
|
|
82
|
+
///
|
|
83
|
+
/// Handles various VT types and converts them to appropriate JSON values.
|
|
84
|
+
fn extract_vt_value(node: roxmltree::Node) -> Option<Value> {
|
|
85
|
+
for child in node.children().filter(|n| n.is_element()) {
|
|
86
|
+
let tag = child.tag_name().name();
|
|
87
|
+
|
|
88
|
+
match tag {
|
|
89
|
+
"lpwstr" | "lpstr" => {
|
|
90
|
+
return child.text().map(|s| Value::String(s.to_string()));
|
|
91
|
+
}
|
|
92
|
+
"i4" => {
|
|
93
|
+
return child
|
|
94
|
+
.text()
|
|
95
|
+
.and_then(|s| s.trim().parse::<i64>().ok().map(|n| Value::Number(n.into())));
|
|
96
|
+
}
|
|
97
|
+
"r8" => {
|
|
98
|
+
return child.text().and_then(|s| {
|
|
99
|
+
s.trim()
|
|
100
|
+
.parse::<f64>()
|
|
101
|
+
.ok()
|
|
102
|
+
.and_then(|f| serde_json::Number::from_f64(f).map(Value::Number))
|
|
103
|
+
});
|
|
104
|
+
}
|
|
105
|
+
"bool" => {
|
|
106
|
+
return child.text().and_then(|s| match s.trim().to_lowercase().as_str() {
|
|
107
|
+
"true" | "1" => Some(Value::Bool(true)),
|
|
108
|
+
"false" | "0" => Some(Value::Bool(false)),
|
|
109
|
+
_ => None,
|
|
110
|
+
});
|
|
111
|
+
}
|
|
112
|
+
"filetime" => {
|
|
113
|
+
return child.text().map(|s| Value::String(s.to_string()));
|
|
114
|
+
}
|
|
115
|
+
_ => {
|
|
116
|
+
continue;
|
|
117
|
+
}
|
|
118
|
+
}
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
None
|
|
122
|
+
}
|
|
123
|
+
|
|
124
|
+
#[cfg(test)]
|
|
125
|
+
mod tests {
|
|
126
|
+
use super::*;
|
|
127
|
+
use std::io::{Cursor, Write};
|
|
128
|
+
|
|
129
|
+
fn create_test_zip_with_custom_xml(custom_xml: &str) -> ZipArchive<Cursor<Vec<u8>>> {
|
|
130
|
+
let buffer = Vec::new();
|
|
131
|
+
let cursor = Cursor::new(buffer);
|
|
132
|
+
let mut zip = zip::ZipWriter::new(cursor);
|
|
133
|
+
|
|
134
|
+
let options = zip::write::FileOptions::<()>::default().compression_method(zip::CompressionMethod::Stored);
|
|
135
|
+
|
|
136
|
+
zip.start_file("docProps/custom.xml", options).unwrap();
|
|
137
|
+
zip.write_all(custom_xml.as_bytes()).unwrap();
|
|
138
|
+
|
|
139
|
+
let cursor = zip.finish().unwrap();
|
|
140
|
+
ZipArchive::new(cursor).unwrap()
|
|
141
|
+
}
|
|
142
|
+
|
|
143
|
+
#[test]
|
|
144
|
+
fn test_extract_custom_properties_string() {
|
|
145
|
+
let custom_xml = r#"<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
|
|
146
|
+
<Properties xmlns="http://schemas.openxmlformats.org/officeDocument/2006/custom-properties"
|
|
147
|
+
xmlns:vt="http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes">
|
|
148
|
+
<property fmtid="{D5CDD505-2E9C-101B-9397-08002B2CF9AE}" pid="2" name="ProjectName">
|
|
149
|
+
<vt:lpwstr>Alpha Project</vt:lpwstr>
|
|
150
|
+
</property>
|
|
151
|
+
</Properties>"#;
|
|
152
|
+
|
|
153
|
+
let mut archive = create_test_zip_with_custom_xml(custom_xml);
|
|
154
|
+
let props = extract_custom_properties(&mut archive).unwrap();
|
|
155
|
+
|
|
156
|
+
assert_eq!(
|
|
157
|
+
props.get("ProjectName"),
|
|
158
|
+
Some(&Value::String("Alpha Project".to_string()))
|
|
159
|
+
);
|
|
160
|
+
}
|
|
161
|
+
|
|
162
|
+
#[test]
|
|
163
|
+
fn test_extract_custom_properties_multiple_types() {
|
|
164
|
+
let custom_xml = r#"<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
|
|
165
|
+
<Properties xmlns="http://schemas.openxmlformats.org/officeDocument/2006/custom-properties"
|
|
166
|
+
xmlns:vt="http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes">
|
|
167
|
+
<property fmtid="{D5CDD505-2E9C-101B-9397-08002B2CF9AE}" pid="2" name="StringProp">
|
|
168
|
+
<vt:lpwstr>Test String</vt:lpwstr>
|
|
169
|
+
</property>
|
|
170
|
+
<property fmtid="{D5CDD505-2E9C-101B-9397-08002B2CF9AE}" pid="3" name="IntProp">
|
|
171
|
+
<vt:i4>42</vt:i4>
|
|
172
|
+
</property>
|
|
173
|
+
<property fmtid="{D5CDD505-2E9C-101B-9397-08002B2CF9AE}" pid="4" name="BoolProp">
|
|
174
|
+
<vt:bool>true</vt:bool>
|
|
175
|
+
</property>
|
|
176
|
+
<property fmtid="{D5CDD505-2E9C-101B-9397-08002B2CF9AE}" pid="5" name="FloatProp">
|
|
177
|
+
<vt:r8>3.14159</vt:r8>
|
|
178
|
+
</property>
|
|
179
|
+
</Properties>"#;
|
|
180
|
+
|
|
181
|
+
let mut archive = create_test_zip_with_custom_xml(custom_xml);
|
|
182
|
+
let props = extract_custom_properties(&mut archive).unwrap();
|
|
183
|
+
|
|
184
|
+
assert_eq!(props.get("StringProp"), Some(&Value::String("Test String".to_string())));
|
|
185
|
+
assert_eq!(props.get("IntProp"), Some(&Value::Number(42.into())));
|
|
186
|
+
assert_eq!(props.get("BoolProp"), Some(&Value::Bool(true)));
|
|
187
|
+
assert!(matches!(props.get("FloatProp"), Some(Value::Number(_))));
|
|
188
|
+
}
|
|
189
|
+
|
|
190
|
+
#[test]
|
|
191
|
+
fn test_extract_custom_properties_missing_file() {
|
|
192
|
+
let buffer = Vec::new();
|
|
193
|
+
let cursor = Cursor::new(buffer);
|
|
194
|
+
let zip = zip::ZipWriter::new(cursor);
|
|
195
|
+
let cursor = zip.finish().unwrap();
|
|
196
|
+
let mut archive = ZipArchive::new(cursor).unwrap();
|
|
197
|
+
|
|
198
|
+
let props = extract_custom_properties(&mut archive).unwrap();
|
|
199
|
+
assert_eq!(props, HashMap::new());
|
|
200
|
+
}
|
|
201
|
+
|
|
202
|
+
#[test]
|
|
203
|
+
fn test_extract_vt_value_lpstr() {
|
|
204
|
+
let xml = r#"<property xmlns:vt="http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes">
|
|
205
|
+
<vt:lpstr>Test</vt:lpstr>
|
|
206
|
+
</property>"#;
|
|
207
|
+
|
|
208
|
+
let doc = roxmltree::Document::parse(xml).unwrap();
|
|
209
|
+
let value = extract_vt_value(doc.root_element()).unwrap();
|
|
210
|
+
assert_eq!(value, Value::String("Test".to_string()));
|
|
211
|
+
}
|
|
212
|
+
|
|
213
|
+
#[test]
|
|
214
|
+
fn test_extract_vt_value_bool_variants() {
|
|
215
|
+
let xml_true1 = r#"<property xmlns:vt="http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes">
|
|
216
|
+
<vt:bool>true</vt:bool>
|
|
217
|
+
</property>"#;
|
|
218
|
+
let xml_true2 = r#"<property xmlns:vt="http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes">
|
|
219
|
+
<vt:bool>1</vt:bool>
|
|
220
|
+
</property>"#;
|
|
221
|
+
let xml_false1 = r#"<property xmlns:vt="http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes">
|
|
222
|
+
<vt:bool>false</vt:bool>
|
|
223
|
+
</property>"#;
|
|
224
|
+
let xml_false2 = r#"<property xmlns:vt="http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes">
|
|
225
|
+
<vt:bool>0</vt:bool>
|
|
226
|
+
</property>"#;
|
|
227
|
+
|
|
228
|
+
let doc1 = roxmltree::Document::parse(xml_true1).unwrap();
|
|
229
|
+
assert_eq!(extract_vt_value(doc1.root_element()), Some(Value::Bool(true)));
|
|
230
|
+
|
|
231
|
+
let doc2 = roxmltree::Document::parse(xml_true2).unwrap();
|
|
232
|
+
assert_eq!(extract_vt_value(doc2.root_element()), Some(Value::Bool(true)));
|
|
233
|
+
|
|
234
|
+
let doc3 = roxmltree::Document::parse(xml_false1).unwrap();
|
|
235
|
+
assert_eq!(extract_vt_value(doc3.root_element()), Some(Value::Bool(false)));
|
|
236
|
+
|
|
237
|
+
let doc4 = roxmltree::Document::parse(xml_false2).unwrap();
|
|
238
|
+
assert_eq!(extract_vt_value(doc4.root_element()), Some(Value::Bool(false)));
|
|
239
|
+
}
|
|
240
|
+
}
|
|
@@ -0,0 +1,130 @@
|
|
|
1
|
+
//! Office Open XML metadata extraction
|
|
2
|
+
//!
|
|
3
|
+
//! This module provides functionality to extract comprehensive metadata from Office Open XML
|
|
4
|
+
//! documents (DOCX, XLSX, PPTX) by parsing the `docProps/core.xml`, `docProps/app.xml`,
|
|
5
|
+
//! and `docProps/custom.xml` files within the ZIP container.
|
|
6
|
+
//!
|
|
7
|
+
//! # Overview
|
|
8
|
+
//!
|
|
9
|
+
//! Office documents store metadata in three XML files:
|
|
10
|
+
//! - `docProps/core.xml` - Dublin Core metadata (title, creator, dates, keywords, etc.)
|
|
11
|
+
//! - `docProps/app.xml` - Application-specific properties (page count, word count, etc.)
|
|
12
|
+
//! - `docProps/custom.xml` - Custom properties defined by users or applications
|
|
13
|
+
//!
|
|
14
|
+
//! # Example
|
|
15
|
+
//!
|
|
16
|
+
//! ```no_run
|
|
17
|
+
//! use kreuzberg::extraction::office_metadata::{extract_core_properties, extract_docx_app_properties};
|
|
18
|
+
//! use std::fs::File;
|
|
19
|
+
//! use zip::ZipArchive;
|
|
20
|
+
//!
|
|
21
|
+
//! let file = File::open("document.docx")?;
|
|
22
|
+
//! let mut archive = ZipArchive::new(file)?;
|
|
23
|
+
//!
|
|
24
|
+
//! // Extract core properties
|
|
25
|
+
//! let core = extract_core_properties(&mut archive)?;
|
|
26
|
+
//! println!("Title: {:?}", core.title);
|
|
27
|
+
//! println!("Created: {:?}", core.created);
|
|
28
|
+
//!
|
|
29
|
+
//! // Extract DOCX app properties
|
|
30
|
+
//! let app = extract_docx_app_properties(&mut archive)?;
|
|
31
|
+
//! println!("Word count: {:?}", app.words);
|
|
32
|
+
//! # Ok::<(), Box<dyn std::error::Error>>(())
|
|
33
|
+
//! ```
|
|
34
|
+
|
|
35
|
+
pub mod app_properties;
|
|
36
|
+
pub mod core_properties;
|
|
37
|
+
pub mod custom_properties;
|
|
38
|
+
pub mod odt_properties;
|
|
39
|
+
|
|
40
|
+
pub use app_properties::{
|
|
41
|
+
DocxAppProperties, PptxAppProperties, XlsxAppProperties, extract_docx_app_properties, extract_pptx_app_properties,
|
|
42
|
+
extract_xlsx_app_properties,
|
|
43
|
+
};
|
|
44
|
+
pub use core_properties::{CoreProperties, extract_core_properties};
|
|
45
|
+
pub use custom_properties::{CustomProperties, extract_custom_properties};
|
|
46
|
+
pub use odt_properties::{OdtProperties, extract_odt_properties};
|
|
47
|
+
|
|
48
|
+
use roxmltree::Node;
|
|
49
|
+
|
|
50
|
+
/// Parse text content from an XML element by tag name
|
|
51
|
+
///
|
|
52
|
+
/// Returns the text content if the element exists and has non-empty text.
|
|
53
|
+
pub(crate) fn parse_xml_text(node: Node, name: &str) -> Option<String> {
|
|
54
|
+
node.descendants()
|
|
55
|
+
.find(|n| n.has_tag_name(name))
|
|
56
|
+
.and_then(|n| n.text())
|
|
57
|
+
.map(|s| s.trim())
|
|
58
|
+
.filter(|s| !s.is_empty())
|
|
59
|
+
.map(String::from)
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
/// Parse integer content from an XML element by tag name
|
|
63
|
+
///
|
|
64
|
+
/// Returns the parsed integer if the element exists and contains valid integer text.
|
|
65
|
+
pub(crate) fn parse_xml_int(node: Node, name: &str) -> Option<i32> {
|
|
66
|
+
node.descendants()
|
|
67
|
+
.find(|n| n.has_tag_name(name))
|
|
68
|
+
.and_then(|n| n.text())
|
|
69
|
+
.and_then(|s| s.trim().parse::<i32>().ok())
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
/// Parse boolean content from an XML element by tag name
|
|
73
|
+
///
|
|
74
|
+
/// Handles "true"/"false" string values and converts to boolean.
|
|
75
|
+
pub(crate) fn parse_xml_bool(node: Node, name: &str) -> Option<bool> {
|
|
76
|
+
node.descendants()
|
|
77
|
+
.find(|n| n.has_tag_name(name))
|
|
78
|
+
.and_then(|n| n.text())
|
|
79
|
+
.map(|s| s.trim())
|
|
80
|
+
.and_then(|s| match s.to_lowercase().as_str() {
|
|
81
|
+
"true" => Some(true),
|
|
82
|
+
"false" => Some(false),
|
|
83
|
+
_ => None,
|
|
84
|
+
})
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
#[cfg(test)]
|
|
88
|
+
mod tests {
|
|
89
|
+
use super::*;
|
|
90
|
+
|
|
91
|
+
#[test]
|
|
92
|
+
fn test_parse_xml_text() {
|
|
93
|
+
let xml = r#"<root><title>Test Document</title></root>"#;
|
|
94
|
+
let doc = roxmltree::Document::parse(xml).unwrap();
|
|
95
|
+
let root = doc.root_element();
|
|
96
|
+
|
|
97
|
+
assert_eq!(parse_xml_text(root, "title"), Some("Test Document".to_string()));
|
|
98
|
+
assert_eq!(parse_xml_text(root, "missing"), None);
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
#[test]
|
|
102
|
+
fn test_parse_xml_text_empty() {
|
|
103
|
+
let xml = r#"<root><title></title></root>"#;
|
|
104
|
+
let doc = roxmltree::Document::parse(xml).unwrap();
|
|
105
|
+
let root = doc.root_element();
|
|
106
|
+
|
|
107
|
+
assert_eq!(parse_xml_text(root, "title"), None);
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
#[test]
|
|
111
|
+
fn test_parse_xml_int() {
|
|
112
|
+
let xml = r#"<root><count>42</count></root>"#;
|
|
113
|
+
let doc = roxmltree::Document::parse(xml).unwrap();
|
|
114
|
+
let root = doc.root_element();
|
|
115
|
+
|
|
116
|
+
assert_eq!(parse_xml_int(root, "count"), Some(42));
|
|
117
|
+
assert_eq!(parse_xml_int(root, "missing"), None);
|
|
118
|
+
}
|
|
119
|
+
|
|
120
|
+
#[test]
|
|
121
|
+
fn test_parse_xml_bool() {
|
|
122
|
+
let xml = r#"<root><flag>true</flag><other>false</other></root>"#;
|
|
123
|
+
let doc = roxmltree::Document::parse(xml).unwrap();
|
|
124
|
+
let root = doc.root_element();
|
|
125
|
+
|
|
126
|
+
assert_eq!(parse_xml_bool(root, "flag"), Some(true));
|
|
127
|
+
assert_eq!(parse_xml_bool(root, "other"), Some(false));
|
|
128
|
+
assert_eq!(parse_xml_bool(root, "missing"), None);
|
|
129
|
+
}
|
|
130
|
+
}
|