hyperdav 0.2.0

WebDAV client
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

use std;
use std::error::Error;
use std::io::Read;
use xml::reader::{Error as XmlError, EventReader, XmlEvent};
use xml::ParserConfig;

/// Response used for listing files.
#[derive(Default, Debug)]
pub struct PropfindResponse {
    /// URL of the resource
    pub href: String,
}

#[derive(Eq, PartialEq, Debug)]
pub enum PropfindParseError {
    UnknownDocument,
    InvalidFieldValue,
    UnknownElement,
    UnknownField,
    ExpectedEndOfDocument,
    Xml(XmlError),
}

impl From<XmlError> for PropfindParseError {
    fn from(e: XmlError) -> Self {
        PropfindParseError::Xml(e)
    }
}

impl std::fmt::Display for PropfindParseError {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        write!(f, "{}", self.description())
    }
}

impl Error for PropfindParseError {
    fn description(&self) -> &str {
        use self::PropfindParseError::*;
        match *self {
            UnknownDocument => "not a propfind response",
            InvalidFieldValue => "field must only contain text",
            UnknownElement => "document must only contain responses",
            UnknownField => "unsupported field",
            ExpectedEndOfDocument => "expected end of document",
            Xml(ref e) => e.description(),
        }
    }

    fn cause(&self) -> Option<&Error> {
        use self::PropfindParseError::*;
        match *self {
            Xml(ref e) => Some(e as &Error),
            _ => None,
        }
    }
}

pub fn parse_propfind_response<R: Read>(
    read: R,
) -> Result<Vec<PropfindResponse>, PropfindParseError> {
    enum Field {
        Href,
        Ignored,
    }

    enum State {
        Items,
        Item {
            item: PropfindResponse,
            field: Option<Field>,
        },
        Start,
        End,
    }

    let parser = EventReader::new_with_config(
        read,
        ParserConfig {
            trim_whitespace: true,
            cdata_to_characters: true,
            ..Default::default()
        },
    );
    let mut items = Vec::new();
    let mut state = State::Start;

    for e in parser {
        let e = try!(e);
        state = match state {
            State::Start => match e {
                XmlEvent::StartDocument { .. } => State::Start,
                XmlEvent::StartElement { ref name, .. } if name.local_name == "multistatus" => {
                    State::Items
                }
                _ => return Err(PropfindParseError::UnknownDocument),
            },
            State::End => match e {
                XmlEvent::EndDocument => return Ok(items),
                _ => return Err(PropfindParseError::ExpectedEndOfDocument),
            },
            State::Items => match e {
                XmlEvent::EndElement { .. } => State::End,
                XmlEvent::StartElement { ref name, .. } if name.local_name == "response" => {
                    State::Item {
                        item: PropfindResponse::default(),
                        field: None,
                    }
                }
                _ => return Err(PropfindParseError::UnknownElement),
            },
            State::Item { field: None, item } => {
                match e {
                    XmlEvent::StartElement { name, .. } => match &*name.local_name {
                        "href" => State::Item {
                            field: Some(Field::Href),
                            item,
                        },
                        _ => State::Item {
                            field: Some(Field::Ignored),
                            item,
                        },
                    },
                    XmlEvent::EndElement { name } => {
                        match &*name.local_name {
                            "response" => {
                                items.push(item);
                                State::Items
                            }
                            // ignore nested elements for now
                            _ => State::Item { field: None, item },
                        }
                    }
                    _ => State::Item { field: None, item },
                }
            }
            State::Item {
                field: Some(field),
                mut item,
            } => {
                match e {
                    XmlEvent::Characters(s) => {
                        match field {
                            Field::Href => item.href = s,
                            Field::Ignored => {}
                        };
                        State::Item {
                            field: Some(field),
                            item,
                        }
                    }
                    XmlEvent::EndElement { .. } => State::Item { field: None, item },
                    // ignore nested element for now
                    XmlEvent::StartElement { .. } => State::Item {
                        field: Some(field),
                        item,
                    },
                    _ => return Err(PropfindParseError::InvalidFieldValue),
                }
            }
        }
    }

    Ok(items)
}