office-rs 0.1.1

A Rust library for reading and writing XML Office files
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
//! Excel (XLSX) 文件读取器
//!
//! 提供读取 XLSX 文件的功能,包括解析工作簿结构、工作表数据和单元格内容。

use crate::common::xml_utils::{ XmlElement, XmlParser };
use crate::common::zip_utils::ZipReader;
use crate::context::ErrorContext;
use crate::error::{ OfficeError, Result };
use crate::xlsx::{
    Cell,
    CellReference,
    CellType,
    CellValue,
    Workbook,
    WorkbookProperties,
    Worksheet,
    WorksheetProperties,
};
use std::collections::HashMap;
use std::fs::File;
use std::io::BufReader;
use std::path::Path;

/// XLSX 文件读取器
pub struct XlsxReader {
    zip_reader: ZipReader<BufReader<File>>,
    shared_strings: Vec<String>,
    workbook_xml: Option<XmlElement>,
}

impl XlsxReader {
    /// 打开 XLSX 文件
    pub fn open<P: AsRef<Path>>(path: P) -> Result<Self> {
        let zip_reader = ZipReader::open_file(&path).map_err(|e| {
            e.with_context(ErrorContext {
                operation: Some("打开XLSX文件".to_string()),
                file_path: Some(path.as_ref().to_string_lossy().to_string()),
                ..Default::default()
            })
        })?;

        let mut reader = Self {
            zip_reader,
            shared_strings: Vec::new(),
            workbook_xml: None,
        };

        // 加载共享字符串
        reader.load_shared_strings()?;

        // 加载工作簿XML
        reader.load_workbook_xml()?;

        Ok(reader)
    }

    /// 读取工作簿
    pub fn read_workbook(&mut self) -> Result<Workbook> {
        let workbook_xml = self.workbook_xml.as_ref().ok_or_else(|| {
            OfficeError::Parse(crate::error::ParseError::MissingElement {
                element: "workbook XML".to_string(),
            })
        })?;

        // 解析工作簿属性
        let properties = self.parse_workbook_properties(workbook_xml)?;

        // 创建空工作簿(不包含默认工作表)
        let mut workbook = Workbook::new_empty();

        // 解析工作表列表
        let worksheet_names = self.parse_worksheet_list(workbook_xml)?;

        // 加载每个工作表
        for (sheet_name, sheet_id) in worksheet_names {
            let worksheet = self.read_worksheet(&sheet_name, sheet_id)?;
            // 直接添加工作表到工作簿
            workbook.add_worksheet_direct(sheet_name, worksheet);
        }

        Ok(workbook)
    }

    /// 读取指定工作表
    pub fn read_worksheet(&mut self, name: &str, sheet_id: u32) -> Result<Worksheet> {
        let sheet_path = format!("xl/worksheets/sheet{}.xml", sheet_id);

        if !self.zip_reader.contains_file(&sheet_path) {
            return Err(
                OfficeError::Parse(crate::error::ParseError::MissingElement {
                    element: format!("worksheet file: {}", sheet_path),
                })
            );
        }

        let xml_content = self.zip_reader.read_file_to_string(&sheet_path)?;
        let parser = XmlParser::new();
        let xml_element = parser.parse_string(&xml_content)?;

        self.parse_worksheet(&xml_element, name)
    }

    /// 加载共享字符串
    fn load_shared_strings(&mut self) -> Result<()> {
        const SHARED_STRINGS_PATH: &str = "xl/sharedStrings.xml";

        if !self.zip_reader.contains_file(SHARED_STRINGS_PATH) {
            // 没有共享字符串文件是正常的
            return Ok(());
        }

        let xml_content = self.zip_reader.read_file_to_string(SHARED_STRINGS_PATH)?;
        let parser = XmlParser::new();
        let xml_element = parser.parse_string(&xml_content)?;

        self.shared_strings = self.parse_shared_strings(&xml_element)?;

        Ok(())
    }

    /// 加载工作簿XML
    fn load_workbook_xml(&mut self) -> Result<()> {
        const WORKBOOK_PATH: &str = "xl/workbook.xml";

        if !self.zip_reader.contains_file(WORKBOOK_PATH) {
            return Err(
                OfficeError::Parse(crate::error::ParseError::MissingElement {
                    element: "workbook file".to_string(),
                })
            );
        }

        let xml_content = self.zip_reader.read_file_to_string(WORKBOOK_PATH)?;
        let parser = XmlParser::new();
        let xml_element = parser.parse_string(&xml_content)?;

        self.workbook_xml = Some(xml_element);

        Ok(())
    }

    /// 解析工作簿属性
    fn parse_workbook_properties(&self, workbook_xml: &XmlElement) -> Result<WorkbookProperties> {
        let mut properties = WorkbookProperties::default();

        // 查找文档属性
        if let Some(props_element) = workbook_xml.find_child("fileVersion") {
            if let Some(app_name) = props_element.get_attribute("appName") {
                properties.title = Some(app_name.clone());
            }
        }

        Ok(properties)
    }

    /// 解析工作表列表
    fn parse_worksheet_list(&self, workbook_xml: &XmlElement) -> Result<Vec<(String, u32)>> {
        let mut worksheets = Vec::new();

        if let Some(sheets_element) = workbook_xml.find_child("sheets") {
            for sheet_element in &sheets_element.children {
                if sheet_element.name == "sheet" {
                    let name = sheet_element.get_attribute("name").ok_or_else(|| {
                        OfficeError::Parse(crate::error::ParseError::MissingElement {
                            element: "worksheet name attribute".to_string(),
                        })
                    })?;

                    let sheet_id_str = sheet_element.get_attribute("sheetId").ok_or_else(|| {
                        OfficeError::Parse(crate::error::ParseError::MissingElement {
                            element: "worksheet sheetId attribute".to_string(),
                        })
                    })?;

                    let sheet_id: u32 = sheet_id_str.parse().map_err(|_| {
                        OfficeError::Parse(crate::error::ParseError::InvalidAttribute {
                            attribute: "sheetId".to_string(),
                            value: sheet_id_str.to_string(),
                        })
                    })?;

                    worksheets.push((name.clone(), sheet_id));
                }
            }
        }

        Ok(worksheets)
    }

    /// 解析工作表
    fn parse_worksheet(&self, xml_element: &XmlElement, name: &str) -> Result<Worksheet> {
        let mut worksheet = Worksheet::new(name.to_string());

        // 查找工作表数据
        if let Some(sheet_data) = xml_element.find_child("sheetData") {
            self.parse_sheet_data(sheet_data, &mut worksheet)?;
        }

        Ok(worksheet)
    }

    /// 解析工作表数据
    fn parse_sheet_data(&self, sheet_data: &XmlElement, worksheet: &mut Worksheet) -> Result<()> {
        for row_element in &sheet_data.children {
            if row_element.name == "row" {
                self.parse_row(row_element, worksheet)?;
            }
        }

        Ok(())
    }

    /// 解析行数据
    fn parse_row(&self, row_element: &XmlElement, worksheet: &mut Worksheet) -> Result<()> {
        for cell_element in &row_element.children {
            if cell_element.name == "c" {
                self.parse_cell(cell_element, worksheet)?;
            }
        }

        Ok(())
    }

    /// 解析单元格
    fn parse_cell(&self, cell_element: &XmlElement, worksheet: &mut Worksheet) -> Result<()> {
        // 获取单元格引用
        let cell_ref = cell_element.get_attribute("r").ok_or_else(|| {
            OfficeError::Parse(crate::error::ParseError::MissingElement {
                element: "cell reference attribute".to_string(),
            })
        })?;

        // 解析单元格引用
        let (row, col) = self.parse_cell_reference(&cell_ref)?;

        // 获取单元格类型
        let cell_type = cell_element.get_attribute("t").map_or("n", |v| v.as_str());

        // 解析单元格值
        let cell_value = if let Some(value_element) = cell_element.find_child("v") {
            let value_text = value_element.text_content.as_deref().unwrap_or("");
            self.parse_cell_value(value_text, cell_type)?
        } else {
            CellValue::Empty
        };

        // 创建单元格引用和单元格
        let cell_reference = CellReference::new(col - 1, row - 1); // 转换为0开始的索引
        let cell = Cell::new(cell_reference, cell_value);
        worksheet.set_cell(cell);

        Ok(())
    }

    /// 解析单元格引用 (如 "A1" -> (1, 1))
    fn parse_cell_reference(&self, cell_ref: &str) -> Result<(u32, u32)> {
        let mut col = 0u32;
        let mut row_start = 0;

        // 解析列部分 (字母)
        for (i, ch) in cell_ref.chars().enumerate() {
            if ch.is_ascii_alphabetic() {
                col = col * 26 + ((ch.to_ascii_uppercase() as u32) - (b'A' as u32) + 1);
            } else {
                row_start = i;
                break;
            }
        }

        // 解析行部分 (数字)
        let row_str = &cell_ref[row_start..];
        let row: u32 = row_str.parse().map_err(|_| {
            OfficeError::Parse(crate::error::ParseError::InvalidAttribute {
                attribute: "cell reference".to_string(),
                value: cell_ref.to_string(),
            })
        })?;

        Ok((row, col))
    }

    /// 解析单元格值
    fn parse_cell_value(&self, value_text: &str, cell_type: &str) -> Result<CellValue> {
        match cell_type {
            "s" => {
                // 共享字符串
                let index: usize = value_text.parse().map_err(|_| {
                    OfficeError::Parse(crate::error::ParseError::InvalidAttribute {
                        attribute: "shared string index".to_string(),
                        value: value_text.to_string(),
                    })
                })?;

                if index < self.shared_strings.len() {
                    Ok(CellValue::Text(self.shared_strings[index].clone()))
                } else {
                    Err(
                        OfficeError::Xlsx(crate::error::XlsxError::SharedStringIndexOutOfRange {
                            index,
                        })
                    )
                }
            }
            "b" => {
                // 布尔值
                match value_text {
                    "1" | "true" => Ok(CellValue::Boolean(true)),
                    "0" | "false" => Ok(CellValue::Boolean(false)),
                    _ =>
                        Err(
                            OfficeError::Parse(crate::error::ParseError::InvalidAttribute {
                                attribute: "boolean value".to_string(),
                                value: value_text.to_string(),
                            })
                        ),
                }
            }
            "n" | _ => {
                // 数字 (默认类型)
                if value_text.is_empty() {
                    Ok(CellValue::Empty)
                } else {
                    value_text
                        .parse::<f64>()
                        .map(CellValue::Number)
                        .map_err(|_| {
                            OfficeError::Parse(crate::error::ParseError::InvalidAttribute {
                                attribute: "number value".to_string(),
                                value: value_text.to_string(),
                            })
                        })
                }
            }
        }
    }

    /// 解析共享字符串
    fn parse_shared_strings(&self, xml_element: &XmlElement) -> Result<Vec<String>> {
        let mut strings = Vec::new();

        for si_element in &xml_element.children {
            if si_element.name == "si" {
                // 查找文本元素
                if let Some(t_element) = si_element.find_child("t") {
                    let text = t_element.text_content.as_deref().unwrap_or("").to_string();
                    strings.push(text);
                } else {
                    // 处理富文本格式
                    let mut rich_text = String::new();
                    for r_element in &si_element.children {
                        if r_element.name == "r" {
                            if let Some(t_element) = r_element.find_child("t") {
                                rich_text.push_str(t_element.text_content.as_deref().unwrap_or(""));
                            }
                        }
                    }
                    strings.push(rich_text);
                }
            }
        }

        Ok(strings)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    // 创建一个测试用的XlsxReader,不包含zip_reader字段的测试
    struct TestXlsxReader {
        shared_strings: Vec<String>,
    }

    impl TestXlsxReader {
        fn new() -> Self {
            Self {
                shared_strings: Vec::new(),
            }
        }

        fn with_shared_strings(shared_strings: Vec<String>) -> Self {
            Self { shared_strings }
        }

        fn parse_cell_reference(&self, cell_ref: &str) -> Result<(u32, u32)> {
            let mut col = 0u32;
            let mut row_start = 0;

            // 解析列部分 (字母)
            for (i, ch) in cell_ref.chars().enumerate() {
                if ch.is_ascii_alphabetic() {
                    col = col * 26 + ((ch.to_ascii_uppercase() as u32) - (b'A' as u32) + 1);
                } else {
                    row_start = i;
                    break;
                }
            }

            // 解析行部分 (数字)
            let row_str = &cell_ref[row_start..];
            let row: u32 = row_str.parse().map_err(|_| {
                OfficeError::Parse(crate::error::ParseError::InvalidAttribute {
                    attribute: "cell reference".to_string(),
                    value: cell_ref.to_string(),
                })
            })?;

            Ok((row, col))
        }

        fn parse_cell_value(&self, value_text: &str, cell_type: &str) -> Result<CellValue> {
            match cell_type {
                "s" => {
                    // 共享字符串
                    let index: usize = value_text.parse().map_err(|_| {
                        OfficeError::Parse(crate::error::ParseError::InvalidAttribute {
                            attribute: "shared string index".to_string(),
                            value: value_text.to_string(),
                        })
                    })?;

                    if index < self.shared_strings.len() {
                        Ok(CellValue::Text(self.shared_strings[index].clone()))
                    } else {
                        Err(
                            OfficeError::Xlsx(crate::error::XlsxError::SharedStringIndexOutOfRange {
                                index,
                            })
                        )
                    }
                }
                "b" => {
                    // 布尔值
                    match value_text {
                        "1" | "true" => Ok(CellValue::Boolean(true)),
                        "0" | "false" => Ok(CellValue::Boolean(false)),
                        _ =>
                            Err(
                                OfficeError::Parse(crate::error::ParseError::InvalidAttribute {
                                    attribute: "boolean value".to_string(),
                                    value: value_text.to_string(),
                                })
                            ),
                    }
                }
                "n" | _ => {
                    // 数字 (默认类型)
                    if value_text.is_empty() {
                        Ok(CellValue::Empty)
                    } else {
                        value_text
                            .parse::<f64>()
                            .map(CellValue::Number)
                            .map_err(|_| {
                                OfficeError::Parse(crate::error::ParseError::InvalidAttribute {
                                    attribute: "number value".to_string(),
                                    value: value_text.to_string(),
                                })
                            })
                    }
                }
            }
        }
    }

    #[test]
    fn test_parse_cell_reference() {
        let reader = TestXlsxReader::new();

        assert_eq!(reader.parse_cell_reference("A1").unwrap(), (1, 1));
        assert_eq!(reader.parse_cell_reference("B2").unwrap(), (2, 2));
        assert_eq!(reader.parse_cell_reference("Z26").unwrap(), (26, 26));
        assert_eq!(reader.parse_cell_reference("AA27").unwrap(), (27, 27));
    }

    #[test]
    fn test_parse_cell_value() {
        let reader = TestXlsxReader::with_shared_strings(
            vec!["Hello".to_string(), "World".to_string()]
        );

        // 测试数字
        assert_eq!(reader.parse_cell_value("123.45", "n").unwrap(), CellValue::Number(123.45));

        // 测试布尔值
        assert_eq!(reader.parse_cell_value("1", "b").unwrap(), CellValue::Boolean(true));
        assert_eq!(reader.parse_cell_value("0", "b").unwrap(), CellValue::Boolean(false));

        // 测试共享字符串
        assert_eq!(
            reader.parse_cell_value("0", "s").unwrap(),
            CellValue::Text("Hello".to_string())
        );
        assert_eq!(
            reader.parse_cell_value("1", "s").unwrap(),
            CellValue::Text("World".to_string())
        );
    }
}