docx_rs/reader/
rels.rs

1use super::*;
2use crate::reader::{FromXML, ReaderError};
3use std::str::FromStr;
4use std::{
5    collections::{BTreeMap, BTreeSet},
6    io::Read,
7    path::{Path, PathBuf},
8};
9pub type ReadRels = BTreeMap<String, BTreeSet<(RId, PathBuf, Option<String>)>>;
10
11impl FromXML for Rels {
12    fn from_xml<R: Read>(reader: R) -> Result<Self, ReaderError> {
13        let parser = EventReader::new(reader);
14        let mut s = Self::default();
15        let mut depth = 0;
16        for e in parser {
17            match e {
18                Ok(XmlEvent::StartElement { attributes, .. }) => {
19                    if depth == 1 {
20                        let mut rel_type = "".to_owned();
21                        let mut target = "".to_owned();
22                        let mut id = "".to_owned();
23                        for attr in attributes {
24                            let name: &str = &attr.name.local_name;
25                            if name == "Type" {
26                                rel_type = attr.value.clone();
27                            } else if name == "Target" {
28                                target = attr.value.clone();
29                            } else if name == "Id" {
30                                id = attr.value.clone();
31                            }
32                        }
33                        // Preserve original relationship ID
34                        s.rels.push((rel_type, id, target));
35                    }
36                    depth += 1;
37                }
38                Ok(XmlEvent::EndElement { .. }) => {
39                    depth -= 1;
40                }
41                Err(_) => return Err(ReaderError::XMLReadError),
42                _ => {}
43            }
44        }
45        Ok(s)
46    }
47}
48
49pub fn find_rels_filename(main_path: impl AsRef<Path>) -> Result<PathBuf, ReaderError> {
50    let path = main_path.as_ref();
51    let dir = path
52        .parent()
53        .ok_or(ReaderError::DocumentRelsNotFoundError)?;
54    let base = path
55        .file_stem()
56        .ok_or(ReaderError::DocumentRelsNotFoundError)?;
57    Ok(Path::new(dir)
58        .join("_rels")
59        .join(base)
60        .with_extension("xml.rels"))
61}
62
63pub fn read_rels_xml<R: Read>(reader: R, dir: impl AsRef<Path>) -> Result<ReadRels, ReaderError> {
64    let mut parser = EventReader::new(reader);
65    let mut rels: BTreeMap<String, BTreeSet<(RId, PathBuf, Option<String>)>> = BTreeMap::new();
66
67    loop {
68        let e = parser.next_event();
69        match e {
70            Ok(XmlEvent::StartElement {
71                attributes, name, ..
72            }) => {
73                let e = XMLElement::from_str(&name.local_name).unwrap();
74                if let XMLElement::Relationship = e {
75                    let mut rel_type = "".to_owned();
76                    let mut rid = "".to_owned();
77                    let mut target_mode = None;
78                    let mut target_string = "".to_owned();
79                    for a in attributes {
80                        let local_name = &a.name.local_name;
81                        if local_name == "Type" {
82                            rel_type = a.value.to_owned();
83                        } else if local_name == "Target" {
84                            // target_str = Path::new(dir.as_ref()).join(a.value);
85                            target_string = a.value.to_owned();
86                        } else if local_name == "Id" {
87                            rid = a.value.to_owned();
88                        } else if local_name == "TargetMode" {
89                            target_mode = Some(a.value.to_owned());
90                        }
91                    }
92
93                    let target = if !rel_type.ends_with("hyperlink") {
94                        Path::new(dir.as_ref()).join(target_string)
95                    } else {
96                        Path::new("").join(target_string)
97                    };
98
99                    rels.entry(rel_type)
100                        .or_default()
101                        .insert((rid, target, target_mode));
102                    continue;
103                }
104            }
105            Ok(XmlEvent::EndElement { name, .. }) => {
106                let e = XMLElement::from_str(&name.local_name).unwrap();
107                if let XMLElement::Relationships = e {
108                    break;
109                }
110            }
111            Err(_) => return Err(ReaderError::XMLReadError),
112            _ => {}
113        }
114    }
115    Ok(rels)
116}
117
118#[cfg(test)]
119mod tests {
120
121    use super::*;
122    #[cfg(test)]
123    use pretty_assertions::assert_eq;
124
125    #[test]
126    fn test_from_xml() {
127        let xml = r#"<?xml version="1.0" encoding="UTF-8"?>
128<Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships">
129  <Relationship Id="rId1" Type="http://schemas.openxmlformats.org/package/2006/relationships/metadata/core-properties" Target="docProps/core.xml" />
130</Relationships>"#;
131        let c = Rels::from_xml(xml.as_bytes()).unwrap();
132        let rels =
133            vec![
134        (
135            "http://schemas.openxmlformats.org/package/2006/relationships/metadata/core-properties"
136                .to_owned(),
137            "rId1".to_owned(),
138            "docProps/core.xml".to_owned(),
139        )];
140        assert_eq!(Rels { rels }, c);
141    }
142}
docx_rs/reader/rels.rs

docx_rs/reader/
rels.rs
