xlsxzero 0.1.0

Pure-Rust Excel parser and Markdown converter for RAG systems
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
//! Parser Module
//!
//! calamineを使用したExcelファイル解析の基礎実装。
//! ストリーミング処理により、メモリ効率的にセルデータを抽出します。

use calamine::{open_workbook_auto_from_rs, Data, Range, Reader, Sheets, Xlsx};
use std::io::{Cursor, Read, Seek};

use crate::api::SheetSelector;
use crate::builder::ConversionConfig;
use crate::error::XlsxToMdError;
use crate::parser::XlsxMetadataParser;
use crate::types::{CellCoord, CellRange, CellValue, MergedRegion, RawCellData, SheetMetadata};

/// ワークブックパーサー
///
/// calamineのラッパーとして、ワークブックレベルの操作を提供します。
/// Phase IIでは、XlsxMetadataParserを統合してXMLメタデータも取得します。
pub(crate) struct WorkbookParser<R: Read + Seek + Clone> {
    /// calamineのワークブック(XLSX形式のみサポート)
    workbook: Xlsx<R>,
    /// XMLメタデータパーサー(Phase II)
    metadata: Option<XlsxMetadataParser>,
}

impl WorkbookParser<std::io::Cursor<Vec<u8>>> {
    /// ワークブックを開き、XMLメタデータも解析する(Phase II)
    ///
    /// # 引数
    ///
    /// * `reader` - Excelファイルを読み込むためのリーダー(Read + Seekトレイトを実装)
    ///
    /// # 戻り値
    ///
    /// * `Ok(WorkbookParser)` - ワークブックとメタデータの読み込みに成功した場合
    /// * `Err(XlsxToMdError)` - エラーが発生した場合
    ///
    /// # 注意
    ///
    /// このメソッドは、ファイルを2回読み込む必要があるため、効率が悪い可能性があります。
    /// 将来的には、1回の読み込みで両方を処理する最適化を検討します。
    pub fn open_with_metadata<R: Read + Seek>(mut reader: R) -> Result<Self, XlsxToMdError> {
        use crate::security::SecurityConfig;

        // セキュリティチェック: 入力ファイルサイズの上限
        let security_config = SecurityConfig::default();

        // ファイル全体をメモリに読み込む(効率化のため)
        // セキュリティ: ファイルサイズ制限を適用
        let mut buffer = Vec::new();
        let bytes_read = reader.read_to_end(&mut buffer)?;

        if bytes_read as u64 > security_config.max_input_file_size {
            return Err(XlsxToMdError::SecurityViolation(format!(
                "Input file size exceeds maximum: {} bytes (max: {} bytes)",
                bytes_read, security_config.max_input_file_size
            )));
        }

        // calamineでワークブックを開く
        let sheets = open_workbook_auto_from_rs(Cursor::new(buffer.clone()))
            .map_err(XlsxToMdError::Parse)?;
        let workbook = match sheets {
            Sheets::Xlsx(workbook) => workbook,
            _ => {
                return Err(XlsxToMdError::Config(
                    "Only XLSX format is supported".to_string(),
                ))
            }
        };

        // XMLメタデータを解析
        let metadata = Some(XlsxMetadataParser::new(Cursor::new(buffer))?);

        Ok(WorkbookParser { workbook, metadata })
    }

    /// ワークブックを開き、既存のメタデータを再利用する
    ///
    /// # 引数
    ///
    /// * `reader` - Excelファイルを読み込むためのリーダー(Read + Seekトレイトを実装)
    /// * `metadata` - 再利用するメタデータ
    ///
    /// # 戻り値
    ///
    /// * `Ok(WorkbookParser)` - ワークブックの読み込みに成功した場合
    /// * `Err(XlsxToMdError)` - エラーが発生した場合
    pub fn open_with_existing_metadata<R: Read + Seek>(
        mut reader: R,
        metadata: XlsxMetadataParser,
    ) -> Result<Self, XlsxToMdError> {
        use crate::security::SecurityConfig;

        // セキュリティチェック: 入力ファイルサイズの上限
        let security_config = SecurityConfig::default();

        // ファイル全体をメモリに読み込む(効率化のため)
        // セキュリティ: ファイルサイズ制限を適用
        let mut buffer = Vec::new();
        let bytes_read = reader.read_to_end(&mut buffer)?;

        if bytes_read as u64 > security_config.max_input_file_size {
            return Err(XlsxToMdError::SecurityViolation(format!(
                "Input file size exceeds maximum: {} bytes (max: {} bytes)",
                bytes_read, security_config.max_input_file_size
            )));
        }

        // calamineでワークブックを開く
        let sheets = open_workbook_auto_from_rs(Cursor::new(buffer))
            .map_err(XlsxToMdError::Parse)?;
        let workbook = match sheets {
            Sheets::Xlsx(workbook) => workbook,
            _ => {
                return Err(XlsxToMdError::Config(
                    "Only XLSX format is supported".to_string(),
                ))
            }
        };

        // 既存のメタデータを再利用
        let metadata = Some(metadata);

        Ok(WorkbookParser { workbook, metadata })
    }
}

impl<R: Read + Seek + Clone> WorkbookParser<R> {
    /// ワークブックを開く(Phase I互換)
    ///
    /// # 引数
    ///
    /// * `reader` - Excelファイルを読み込むためのリーダー(Read + Seek + Cloneトレイトを実装)
    ///
    /// # 戻り値
    ///
    /// * `Ok(WorkbookParser)` - ワークブックの読み込みに成功した場合(XLSX形式のみサポート)
    /// * `Err(XlsxToMdError::Parse)` - ワークブックの読み込みに失敗した場合、またはXLSX形式でない場合
    #[allow(dead_code)]
    pub fn open(reader: R) -> Result<Self, XlsxToMdError> {
        let sheets = open_workbook_auto_from_rs(reader).map_err(XlsxToMdError::Parse)?;
        match sheets {
            Sheets::Xlsx(workbook) => Ok(Self {
                workbook,
                metadata: None, // Phase I: メタデータなし
            }),
            _ => Err(XlsxToMdError::Config(
                "Only XLSX format is supported".to_string(),
            )),
        }
    }

    /// すべてのシート名を取得
    ///
    /// # 戻り値
    ///
    /// シート名のベクター
    pub fn get_sheet_names(&self) -> Vec<String> {
        self.workbook.sheet_names().to_vec()
    }

    /// メタデータを取得(並列処理での再利用用)
    ///
    /// # 戻り値
    ///
    /// * `Some(&XlsxMetadataParser)` - メタデータが存在する場合
    /// * `None` - メタデータが存在しない場合
    pub fn metadata(&self) -> Option<&XlsxMetadataParser> {
        self.metadata.as_ref()
    }

    /// シート選択方式に基づいてシートを選択
    ///
    /// # 引数
    ///
    /// * `selector` - シート選択方式
    /// * `include_hidden` - 非表示シートを含めるかどうか(Phase Iでは常にfalseとして扱う)
    ///
    /// # 戻り値
    ///
    /// * `Ok(Vec<String>)` - 選択されたシート名のリスト
    /// * `Err(XlsxToMdError::Config)` - シートが見つからない、またはインデックスが範囲外の場合
    pub fn select_sheets(
        &self,
        selector: &SheetSelector,
        _include_hidden: bool,
    ) -> Result<Vec<String>, XlsxToMdError> {
        let all_sheet_names = self.get_sheet_names();

        match selector {
            SheetSelector::All => {
                // Phase I: 非表示シートの判定は未実装のため、すべてのシートを返す
                Ok(all_sheet_names)
            }

            SheetSelector::Index(index) => {
                if *index >= all_sheet_names.len() {
                    return Err(XlsxToMdError::Config(format!(
                        "Sheet index {} is out of range (total: {})",
                        index,
                        all_sheet_names.len()
                    )));
                }
                Ok(vec![all_sheet_names[*index].clone()])
            }

            SheetSelector::Name(name) => {
                if !all_sheet_names.contains(name) {
                    return Err(XlsxToMdError::Config(format!("Sheet '{}' not found", name)));
                }
                Ok(vec![name.clone()])
            }

            SheetSelector::Indices(indices) => {
                let mut result = Vec::new();
                for &index in indices {
                    if index >= all_sheet_names.len() {
                        return Err(XlsxToMdError::Config(format!(
                            "Sheet index {} is out of range (total: {})",
                            index,
                            all_sheet_names.len()
                        )));
                    }
                    result.push(all_sheet_names[index].clone());
                }
                Ok(result)
            }

            SheetSelector::Names(names) => {
                for name in names {
                    if !all_sheet_names.contains(name) {
                        return Err(XlsxToMdError::Config(format!("Sheet '{}' not found", name)));
                    }
                }
                Ok(names.clone())
            }
        }
    }

    /// シートをパースして、メタデータとセルデータを抽出
    ///
    /// # 引数
    ///
    /// * `sheet_name` - パースするシート名
    /// * `config` - 変換設定
    ///
    /// # 戻り値
    ///
    /// * `Ok((SheetMetadata, Vec<RawCellData>))` - メタデータとセルデータのペア
    /// * `Err(XlsxToMdError)` - パースエラーが発生した場合
    pub fn parse_sheet(
        &mut self,
        sheet_name: &str,
        config: &ConversionConfig,
    ) -> Result<(SheetMetadata, Vec<RawCellData>), XlsxToMdError> {
        // 1. シートの取得
        let range = self
            .workbook
            .worksheet_range(sheet_name)
            .map_err(|e| XlsxToMdError::Parse(e.into()))?;

        // 2. メタデータの収集
        let metadata = self.collect_metadata(sheet_name)?;

        // 3. 数式情報を事前に取得(全セルで再利用するため)
        // 注意: 各セルごとにworksheet_formula()を呼び出すと非常に遅いため、
        // 1回だけ呼び出して結果を全セルで再利用する
        let formula_range = self.workbook.worksheet_formula(sheet_name).ok();

        // 4. セルデータの抽出(ストリーミング処理)
        let mut cells = Vec::new();

        for (row_idx, row) in range.rows().enumerate() {
            let row_idx = row_idx as u32;

            // 非表示行のスキップ(Phase I: hidden_rowsは常に空リスト)
            if !config.include_hidden && metadata.hidden_rows.contains(&row_idx) {
                continue;
            }

            for (col_idx, cell) in row.iter().enumerate() {
                let col_idx = col_idx as u32;

                // 非表示列のスキップ(Phase I: hidden_colsは常に空リスト)
                if !config.include_hidden && metadata.hidden_cols.contains(&col_idx) {
                    continue;
                }

                let coord = CellCoord::new(row_idx, col_idx);

                // 範囲制限のチェック
                if let Some(range) = &config.range {
                    if !range.contains(coord) {
                        continue;
                    }
                }

                // RawCellDataの生成
                let raw_cell = self.extract_cell_data_with_formula(coord, cell, sheet_name, &formula_range)?;
                cells.push(raw_cell);
            }
        }

        Ok((metadata, cells))
    }

    /// セルデータを抽出(内部ヘルパーメソッド)
    ///
    /// # 引数
    ///
    /// * `coord` - セル座標
    /// * `cell` - calamineのセルデータ
    /// * `sheet_name` - シート名(数式取得用)
    ///
    /// # 戻り値
    ///
    /// * `Ok(RawCellData)` - 抽出されたセルデータ
    #[allow(dead_code)]
    fn extract_cell_data(
        &mut self,
        coord: CellCoord,
        cell: &Data,
        sheet_name: &str,
    ) -> Result<RawCellData, XlsxToMdError> {
        self.extract_cell_data_with_formula(coord, cell, sheet_name, &None)
    }

    /// セルデータを抽出(数式範囲を事前に取得したバージョン)
    ///
    /// # 引数
    ///
    /// * `coord` - セル座標
    /// * `cell` - calamineのセルデータ
    /// * `sheet_name` - シート名(数式取得用)
    /// * `formula_range` - 事前に取得した数式範囲(Noneの場合は取得を試みる)
    ///
    /// # 戻り値
    ///
    /// * `Ok(RawCellData)` - 抽出されたセルデータ
    fn extract_cell_data_with_formula(
        &mut self,
        coord: CellCoord,
        cell: &Data,
        sheet_name: &str,
        formula_range: &Option<Range<String>>,
    ) -> Result<RawCellData, XlsxToMdError> {
        // 1. 値の変換
        let value = match cell {
            Data::Int(i) => CellValue::Number(*i as f64),
            Data::Float(f) => CellValue::Number(*f),
            Data::String(s) => CellValue::String(s.clone()),
            Data::Bool(b) => CellValue::Bool(*b),
            Data::Error(e) => CellValue::Error(format!("{:?}", e)),
            Data::Empty => CellValue::Empty,
            _ => CellValue::Empty,
        };

        // 2. 書式情報の取得
        // Phase II: XlsxMetadataParserでxl/styles.xmlから取得
        let (format_id, format_string) = if let Some(ref metadata) = self.metadata {
            // calamineからstyle_idを取得(現在は未対応のため、None)
            // 将来的には、calamineのAPI拡張を待つか、XMLから直接取得する必要がある
            let style_id = None; // TODO: calamineからstyle_idを取得
            if let Some(style_id) = style_id {
                let fmt_str = metadata.get_format_string(style_id);
                (Some(style_id as u16), fmt_str.map(|s| s.to_string()))
            } else {
                (None, None)
            }
        } else {
            (None, None) // Phase I: メタデータなし
        };

        // 3. 数式情報の取得
        // Phase I: calamine 0.26以降のworksheet_formula() APIで取得可能
        // 事前に取得した数式範囲を使用(各セルごとに呼び出すと非常に遅い)
        let formula = if let Some(ref formula_range) = formula_range {
            // 座標をcalamineの形式に変換((row, col))
            let calamine_coord = (coord.row as usize, coord.col as usize);
            formula_range.get(calamine_coord).and_then(|f| {
                if f.is_empty() {
                    None
                } else {
                    Some(f.clone())
                }
            })
        } else {
            None
        };

        // 4. ハイパーリンク情報の取得
        // Phase II: XlsxMetadataParserでxl/worksheets/*.xmlと_rels/*.xml.relsから取得
        let hyperlink = if let Some(ref metadata) = self.metadata {
            metadata.hyperlinks.get(sheet_name).and_then(|sheet_links| {
                sheet_links
                    .get(&(coord.row, coord.col))
                    .map(|h| h.url.clone())
            })
        } else {
            None
        };

        // 5. リッチテキスト情報の取得
        // Phase II: XlsxMetadataParserでxl/sharedStrings.xmlとxl/worksheets/*.xmlから取得
        let rich_text = if let Some(ref metadata) = self.metadata {
            metadata
                .cell_string_indices
                .get(sheet_name)
                .and_then(|sheet_indices| {
                    sheet_indices
                        .get(&(coord.row, coord.col))
                        .and_then(|index| metadata.shared_strings.get(index).cloned())
                })
        } else {
            None
        };

        Ok(RawCellData {
            coord,
            value,
            format_id,
            format_string,
            formula,
            hyperlink,
            rich_text,
        })
    }

    /// シートのメタデータを収集
    ///
    /// # 引数
    ///
    /// * `sheet_name` - シート名
    ///
    /// # 戻り値
    ///
    /// * `Ok(SheetMetadata)` - シートのメタデータ
    /// * `Err(XlsxToMdError)` - エラーが発生した場合
    fn collect_metadata(&mut self, sheet_name: &str) -> Result<SheetMetadata, XlsxToMdError> {
        // 1. シートインデックスの取得
        let index = self
            .workbook
            .sheet_names()
            .iter()
            .position(|name| name == sheet_name)
            .ok_or_else(|| XlsxToMdError::Config(format!("Sheet '{}' not found", sheet_name)))?;

        // 2. 非表示フラグの取得
        // Phase I: calamine APIで非表示シート情報は未サポート
        // Phase II: XlsxMetadataParserで取得予定
        let hidden = false; // Phase I: false固定

        // 3. 結合セル範囲の取得
        // Phase I: calamine 0.26以降で完全対応
        self.workbook
            .load_merged_regions()
            .map_err(|e| XlsxToMdError::Parse(e.into()))?;
        let merged_regions = match self.workbook.worksheet_merge_cells(sheet_name) {
            Some(Ok(regions)) => regions
                .iter()
                .map(|dims| {
                    let start = CellCoord::new(dims.start.0, dims.start.1);
                    let end = CellCoord::new(dims.end.0, dims.end.1);
                    let range = CellRange::new(start, end);
                    MergedRegion::new(range)
                })
                .collect(),
            Some(Err(_)) | None => Vec::new(),
        };

        // 4. 非表示行・列のリスト
        // Phase II: XlsxMetadataParserでxl/worksheets/*.xmlから取得
        let (hidden_rows, hidden_cols) = if let Some(ref metadata) = self.metadata {
            let rows: Vec<u32> = metadata
                .hidden_rows
                .get(sheet_name)
                .map(|set| set.iter().copied().collect())
                .unwrap_or_default();
            let cols: Vec<u32> = metadata
                .hidden_cols
                .get(sheet_name)
                .map(|set| set.iter().copied().collect())
                .unwrap_or_default();
            (rows, cols)
        } else {
            (Vec::new(), Vec::new()) // Phase I: 空リスト
        };

        // 5. 1904年エポックフラグ
        // Phase II: XlsxMetadataParserでxl/workbook.xmlから取得
        let is_1904 = self.metadata.as_ref().map(|m| m.is_1904()).unwrap_or(false); // Phase I: デフォルトはfalse

        Ok(SheetMetadata {
            name: sheet_name.to_string(),
            index,
            hidden,
            merged_regions,
            hidden_rows,
            hidden_cols,
            is_1904,
        })
    }
}

// テストは統合テスト(tests/)で実装します。
// 実際のXLSXファイルが必要なため、単体テストではなく統合テストとして実装します。