opendal/services/webdav/
lister.rs

1// Licensed to the Apache Software Foundation (ASF) under one
2// or more contributor license agreements.  See the NOTICE file
3// distributed with this work for additional information
4// regarding copyright ownership.  The ASF licenses this file
5// to you under the Apache License, Version 2.0 (the
6// "License"); you may not use this file except in compliance
7// with the License.  You may obtain a copy of the License at
8//
9//   http://www.apache.org/licenses/LICENSE-2.0
10//
11// Unless required by applicable law or agreed to in writing,
12// software distributed under the License is distributed on an
13// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14// KIND, either express or implied.  See the License for the
15// specific language governing permissions and limitations
16// under the License.
17
18use std::sync::Arc;
19
20use http::StatusCode;
21
22use super::core::*;
23use super::error::*;
24use crate::raw::*;
25use crate::*;
26
27pub struct WebdavLister {
28    core: Arc<WebdavCore>,
29
30    path: String,
31    args: OpList,
32}
33
34impl WebdavLister {
35    pub fn new(core: Arc<WebdavCore>, path: &str, args: OpList) -> Self {
36        Self {
37            core,
38            path: path.to_string(),
39            args,
40        }
41    }
42}
43
44impl oio::PageList for WebdavLister {
45    async fn next_page(&self, ctx: &mut oio::PageContext) -> Result<()> {
46        let resp = self.core.webdav_list(&self.path, &self.args).await?;
47
48        // jfrog artifactory's webdav services have some strange behavior.
49        // We add this flag to check if the server is jfrog artifactory.
50        //
51        // Example: `"x-jfrog-version": "Artifactory/7.77.5 77705900"`
52        let is_jfrog_artifactory = if let Some(v) = resp.headers().get("x-jfrog-version") {
53            v.to_str().unwrap_or_default().starts_with("Artifactory")
54        } else {
55            false
56        };
57
58        let bs = if resp.status().is_success() {
59            resp.into_body()
60        } else if resp.status() == StatusCode::NOT_FOUND && self.path.ends_with('/') {
61            ctx.done = true;
62            return Ok(());
63        } else {
64            return Err(parse_error(resp));
65        };
66
67        let result: Multistatus = deserialize_multistatus(&bs.to_bytes())?;
68
69        for res in result.response {
70            let mut path = res
71                .href
72                .strip_prefix(&self.core.server_path)
73                .unwrap_or(&res.href)
74                .to_string();
75
76            let meta = parse_propstat(&res.propstat)?;
77
78            // Append `/` to path if it's a dir
79            if !path.ends_with('/') && meta.is_dir() {
80                path += "/"
81            }
82
83            let decoded_path = percent_decode_path(&path);
84            let normalized_path = if self.core.root != decoded_path {
85                build_rel_path(&self.core.root, &decoded_path)
86            } else {
87                "/".to_owned()
88            };
89
90            // HACKS! HACKS! HACKS!
91            //
92            // jfrog artifactory will generate a virtual checksum file for each file.
93            // The checksum file can't be stated, but can be listed and read.
94            // We ignore the checksum files to avoid listing unexpected files.
95            if is_jfrog_artifactory && meta.content_type() == Some("application/x-checksum") {
96                continue;
97            }
98
99            ctx.entries
100                .push_back(oio::Entry::new(&normalized_path, meta))
101        }
102        ctx.done = true;
103
104        Ok(())
105    }
106}
opendal/services/webdav/lister.rs

opendal/services/webdav/
lister.rs
