docx_handlebars/
utils.rs

1//! 实用工具函数
2use quick_xml::{Reader, Writer, events::Event};
3use std::io::{Cursor, Write};
4use crate::errors::DocxError;
5
6/// 验证 DOCX 文件格式
7/// 检查文件是否为有效的 ZIP 格式，并包含必需的 DOCX 文件结构
8pub(crate) fn validate_docx_format(file_data: &[u8]) -> Result<(), DocxError> {
9    // 检查文件大小
10    if file_data.len() < 22 {
11        return Err(DocxError::InvalidZipFormat);
12    }
13    
14    // 检查 ZIP 文件签名
15    // ZIP 文件的签名通常是 0x504B0304 (PK..) 或 0x504B0506 (PK.. 空文件)
16    // 或者 0x504B0708 (PK.. 分割压缩包)
17    let signature = u32::from_le_bytes([
18        file_data[0], file_data[1], file_data[2], file_data[3]
19    ]);
20    
21    match signature {
22        0x04034b50 | 0x06054b50 | 0x08074b50 => {
23            // 有效的 ZIP 签名
24        },
25        _ => return Err(DocxError::InvalidZipFormat),
26    }
27    
28    Ok(())
29}
30
31// /// XML 转义符转换成正常字符
32// pub fn xml_escape_to_normal(xml_content: String) -> String {
33//     xml_content
34//         .replace("&lt;", "<")
35//         .replace("&gt;", ">")
36//         .replace("&amp;", "&")
37//         .replace("&quot;", "\"")
38//         .replace("&apos;", "'")
39// }
40
41/// 合并被XML标签分割的Handlebars语法
42/// 
43/// 这个函数会识别被XML标签分割的 Handlebars 表达式并将其合并。
44/// 例如: `<w:t>{</w:t><w:t>{name</w:t><w:t>}</w:t><w:t>}</w:t>` 
45/// 会被合并为: `{{name}}`
46/// 
47/// 使用 quick_xml 进行更可靠的XML解析，能正确处理各种XML结构
48pub(crate) fn merge_handlebars_in_xml(xml_content: String) -> Result<String, Box<dyn std::error::Error>> {
49    // 快速检查：如果内容中没有大括号，直接返回原内容
50    if !xml_content.contains('{') {
51        return Ok(xml_content);
52    }
53    
54    // 创建XML阅读器和写入器
55    let mut reader = Reader::from_str(&xml_content);
56    let mut writer = Writer::new(Cursor::new(Vec::new()));
57    let mut buf = Vec::new();
58    
59    // 用于累积文本内容的缓冲区
60    let mut text_buffer = String::new();
61    
62    // 跟踪大括号状态
63    let mut brace_count = 0;        // 当前大括号的数量
64    let mut in_handlebars = false;  // 是否在完整的 handlebars 表达式中 (如 {{...}})
65    
66    loop {
67        match reader.read_event_into(&mut buf) {
68            // 处理文本节点
69            Ok(Event::Text(ref e)) => {
70                let text = std::str::from_utf8(e)?;
71                
72                // 逐字符分析文本，统计大括号
73                for ch in text.chars() {
74                    if ch == '{' {
75                        brace_count += 1;
76                        // 当遇到连续的两个 { 时，标记进入 handlebars 表达式
77                        if brace_count >= 2 {
78                            in_handlebars = true;
79                        }
80                    } else if ch == '}' {
81                        if brace_count > 0 {
82                            brace_count -= 1;
83                        }
84                        // 当大括号数量归零时，标记退出 handlebars 表达式
85                        if brace_count == 0 {
86                            in_handlebars = false;
87                        }
88                    }
89                }
90                
91                // 将当前文本添加到缓冲区
92                text_buffer.push_str(text);
93                
94                // 如果不在 handlebars 表达式中且大括号已平衡，输出缓冲的文本
95                if !in_handlebars && brace_count == 0
96                    && !text_buffer.is_empty() {
97                        // writer.write_event(Event::Text(quick_xml::events::BytesText::new(&text_buffer)))?;
98                        writer.write_event(Event::Text(quick_xml::events::BytesText::from_escaped(&text_buffer)))?;
99                        text_buffer.clear();
100                    }
101                // 否则继续累积文本，等待 handlebars 表达式完整
102            }
103            
104            // 处理开始标签 (如 <w:t>)
105            Ok(Event::Start(ref e)) => {
106                // 如果在 handlebars 表达式中，跳过XML标签，只保留文本内容
107                if !in_handlebars && brace_count == 0 {
108                    // 先输出之前缓冲的文本
109                    if !text_buffer.is_empty() {
110                        // writer.write_event(Event::Text(quick_xml::events::BytesText::new(&text_buffer)))?;
111                        writer.write_event(Event::Text(quick_xml::events::BytesText::from_escaped(&text_buffer)))?;
112                        text_buffer.clear();
113                    }
114                    // 输出开始标签
115                    writer.write_event(Event::Start(e.clone()))?;
116                }
117                // 在 handlebars 表达式中时，忽略XML标签，这样就实现了"合并"效果
118            }
119            
120            // 处理结束标签 (如 </w:t>)
121            Ok(Event::End(ref e)) => {
122                // 如果在 handlebars 表达式中，跳过XML标签
123                if !in_handlebars && brace_count == 0 {
124                    // 先输出之前缓冲的文本
125                    if !text_buffer.is_empty() {
126                        // writer.write_event(Event::Text(quick_xml::events::BytesText::new(&text_buffer)))?;
127                        writer.write_event(Event::Text(quick_xml::events::BytesText::from_escaped(&text_buffer)))?;
128                        text_buffer.clear();
129                    }
130                    // 输出结束标签
131                    writer.write_event(Event::End(e.clone()))?;
132                }
133            }
134            
135            // 处理自闭合标签 (如 <w:br/>)
136            Ok(Event::Empty(ref e)) => {
137                if !in_handlebars && brace_count == 0 {
138                    if !text_buffer.is_empty() {
139                        // writer.write_event(Event::Text(quick_xml::events::BytesText::new(&text_buffer)))?;
140                        writer.write_event(Event::Text(quick_xml::events::BytesText::from_escaped(&text_buffer)))?;
141                        text_buffer.clear();
142                    }
143                    writer.write_event(Event::Empty(e.clone()))?;
144                }
145            }
146            
147            // 处理其他XML事件（注释、CDATA、处理指令等）
148            Ok(Event::Eof) => break,
149            Ok(event) => {
150                if !in_handlebars && brace_count == 0 {
151                    if !text_buffer.is_empty() {
152                        // writer.write_event(Event::Text(quick_xml::events::BytesText::new(&text_buffer)))?;
153                        writer.write_event(Event::Text(quick_xml::events::BytesText::from_escaped(&text_buffer)))?;
154                        text_buffer.clear();
155                    }
156                    writer.write_event(event)?;
157                }
158            }
159            
160            // XML解析错误
161            Err(e) => return Err(format!("XML解析错误 at position {}: {:?}", reader.buffer_position(), e).into()),
162        }
163        buf.clear();
164    }
165    
166    // 输出剩余的文本缓冲（如果有的话）
167    if !text_buffer.is_empty() {
168        // writer.write_event(Event::Text(quick_xml::events::BytesText::new(&text_buffer)))?;
169        writer.write_event(Event::Text(quick_xml::events::BytesText::from_escaped(&text_buffer)))?;
170    }
171    
172    // 将结果转换为字符串返回
173    let result = writer.into_inner().into_inner();
174    Ok(String::from_utf8(result)?)
175}
176
177/// 注册基础的 Handlebars helper 函数
178pub(crate) fn register_basic_helpers(handlebars: &mut handlebars::Handlebars) -> Result<(), Box<dyn std::error::Error>> {
179    use handlebars::handlebars_helper;
180    use serde_json::Value;
181    
182    // 注册 eq helper (相等比较)
183    handlebars_helper!(eq: |x: Value, y: Value| x == y);
184    handlebars.register_helper("eq", Box::new(eq));
185    
186    // 注册 ne helper (不等比较)  
187    handlebars_helper!(ne: |x: Value, y: Value| x != y);
188    handlebars.register_helper("ne", Box::new(ne));
189    
190    // 注册 gt helper (大于)
191    handlebars_helper!(gt: |x: i64, y: i64| x > y);
192    handlebars.register_helper("gt", Box::new(gt));
193    
194    // 注册 lt helper (小于)
195    handlebars_helper!(lt: |x: i64, y: i64| x < y);
196    handlebars.register_helper("lt", Box::new(lt));
197    
198    // 注册 upper helper (转大写)
199    handlebars_helper!(upper: |s: String| s.to_uppercase());
200    handlebars.register_helper("upper", Box::new(upper));
201    
202    // 注册 lower helper (转小写)
203    handlebars_helper!(lower: |s: String| s.to_lowercase());
204    handlebars.register_helper("lower", Box::new(lower));
205    
206    // 注册 len helper (数组/字符串长度)
207    handlebars_helper!(len: |x: Value| {
208        match x {
209            Value::Array(arr) => arr.len(),
210            Value::String(s) => s.chars().count(),
211            Value::Object(obj) => obj.len(),
212            _ => 0
213        }
214    });
215    handlebars.register_helper("len", Box::new(len));
216    
217    // 注意：handlebars-rust 不支持像 handlebars.js 那样的 (object "key" value) 语法
218    // 建议在渲染数据中预先构建对象，而不是在模板中动态创建
219    // 例如在 JavaScript/JSON 数据中这样准备：
220    // {
221    //   "image": {
222    //     "image_anchor": "...",
223    //     "options": { "anchor": true, "behind_doc": false }
224    //   }
225    // }
226    // 然后在模板中使用: {{img image.image_anchor "" 50 image.options}}
227    
228    Ok(())
229}
230
231// 更简化的实现方案
232pub(crate) fn remove_table_row_simple(xml_content: &str, target_uuid: &str) -> Result<String, Box<dyn std::error::Error>> {
233    let mut reader = Reader::from_str(xml_content);
234    
235    let mut writer = Writer::new(Cursor::new(Vec::new()));
236    let mut buf = Vec::new();
237    
238    let mut current_row_content = String::new();
239    let mut in_table_row = false;
240    let mut row_depth = 0;
241    
242    loop {
243        match reader.read_event_into(&mut buf) {
244            Ok(Event::Start(ref e)) => {
245                if e.name().as_ref() == b"w:tr" {
246                    in_table_row = true;
247                    row_depth += 1;
248                    current_row_content.clear();
249                    current_row_content.push_str(&format!("<{}", String::from_utf8_lossy(e.name().as_ref())));
250                    // 添加属性
251                    for attr in e.attributes().flatten() {
252                        current_row_content.push_str(&format!(" {}=\"{}\"", 
253                            String::from_utf8_lossy(attr.key.as_ref()),
254                            String::from_utf8_lossy(&attr.value)));
255                    }
256                    current_row_content.push('>');
257                } else if in_table_row {
258                    current_row_content.push_str(&format!("<{}", String::from_utf8_lossy(e.name().as_ref())));
259                    // 添加属性
260                    for attr in e.attributes().flatten() {
261                        current_row_content.push_str(&format!(" {}=\"{}\"", 
262                            String::from_utf8_lossy(attr.key.as_ref()),
263                            String::from_utf8_lossy(&attr.value)));
264                    }
265                    current_row_content.push('>');
266                } else {
267                    writer.write_event(Event::Start(e.clone()))?;
268                }
269            }
270            Ok(Event::End(ref e)) => {
271                if e.name().as_ref() == b"w:tr" && in_table_row {
272                    row_depth -= 1;
273                    if row_depth == 0 {
274                        current_row_content.push_str(&format!("</{}>", String::from_utf8_lossy(e.name().as_ref())));
275                        
276                        // 检查当前行是否包含目标 UUID
277                        if !current_row_content.contains(target_uuid) {
278                            // 如果不包含目标 UUID，则写入这一行
279                            writer.get_mut().write_all(current_row_content.as_bytes())?;
280                        }
281                        // 如果包含目标 UUID，则跳过整行
282                        
283                        in_table_row = false;
284                        current_row_content.clear();
285                    } else {
286                        current_row_content.push_str(&format!("</{}>", String::from_utf8_lossy(e.name().as_ref())));
287                    }
288                } else if in_table_row {
289                    current_row_content.push_str(&format!("</{}>", String::from_utf8_lossy(e.name().as_ref())));
290                } else {
291                    writer.write_event(Event::End(e.clone()))?;
292                }
293            }
294            Ok(Event::Text(ref e)) => {
295                if in_table_row {
296                    let text = std::str::from_utf8(e)?;
297                    // let text = unescape(text)?;
298                    // current_row_content.push_str(&html_escape::encode_text(&text));
299                    current_row_content.push_str(text);
300                } else {
301                    writer.write_event(Event::Text(e.clone()))?;
302                }
303            }
304            Ok(Event::Empty(ref e)) => {
305                if in_table_row {
306                    current_row_content.push_str(&format!("<{}", String::from_utf8_lossy(e.name().as_ref())));
307                    for attr in e.attributes().flatten() {
308                        current_row_content.push_str(&format!(" {}=\"{}\"", 
309                            String::from_utf8_lossy(attr.key.as_ref()),
310                            String::from_utf8_lossy(&attr.value)));
311                    }
312                    current_row_content.push_str("/>");
313                } else {
314                    writer.write_event(Event::Empty(e.clone()))?;
315                }
316            }
317            Ok(Event::Comment(ref e)) => {
318                if !in_table_row {
319                    writer.write_event(Event::Comment(e.clone()))?;
320                }
321            }
322            Ok(Event::CData(ref e)) => {
323                if in_table_row {
324                    current_row_content.push_str(&format!("<![CDATA[{}]]>", String::from_utf8_lossy(e)));
325                } else {
326                    writer.write_event(Event::CData(e.clone()))?;
327                }
328            }
329            Ok(Event::Decl(ref e)) => {
330                writer.write_event(Event::Decl(e.clone()))?;
331            }
332            Ok(Event::PI(ref e)) => {
333                if !in_table_row {
334                    writer.write_event(Event::PI(e.clone()))?;
335                }
336            }
337            Ok(Event::DocType(ref e)) => {
338                writer.write_event(Event::DocType(e.clone()))?;
339            }
340            Ok(Event::GeneralRef(ref e)) => {
341                if !in_table_row {
342                    writer.write_event(Event::GeneralRef(e.clone()))?;
343                }
344            }
345            Ok(Event::Eof) => break,
346            Err(e) => return Err(format!("Error at position {}: {:?}", reader.buffer_position(), e).into()),
347        }
348        buf.clear();
349    }
350    
351    let result = writer.into_inner().into_inner();
352    Ok(String::from_utf8(result)?)
353}
docx_handlebars/utils.rs

docx_handlebars/
utils.rs
