opendal 0.1.6.pre.rc.1

data/core/src/services/webdav/delete.rs

@@ -0,0 +1,47 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+use std::sync::Arc;
+
+use http::StatusCode;
+
+use super::core::*;
+use super::error::parse_error;
+use crate::raw::*;
+use crate::*;
+
+pub struct WebdavDeleter {
+    core: Arc<WebdavCore>,
+}
+
+impl WebdavDeleter {
+    pub fn new(core: Arc<WebdavCore>) -> Self {
+        Self { core }
+    }
+}
+
+impl oio::OneShotDelete for WebdavDeleter {
+    async fn delete_once(&self, path: String, _: OpDelete) -> Result<()> {
+        let resp = self.core.webdav_delete(&path).await?;
+
+        let status = resp.status();
+        match status {
+            StatusCode::NO_CONTENT | StatusCode::NOT_FOUND => Ok(()),
+            _ => Err(parse_error(resp)),
+        }
+    }
+}

data/core/src/services/webdav/docs.md

@@ -0,0 +1,49 @@
+## Capabilities
+
+This service can be used to:
+
+- [x] stat
+- [x] read
+- [x] write
+- [x] create_dir
+- [x] delete
+- [x] copy
+- [x] rename
+- [x] list
+- [ ] ~~presign~~
+- [ ] blocking
+
+## Notes
+
+Bazel Remote Caching and Ccache HTTP Storage is also part of this service.
+Users can use `webdav` to connect those services.
+
+## Configuration
+
+- `endpoint`: set the endpoint for webdav
+- `root`: Set the work directory for backend
+
+You can refer to [`WebdavBuilder`]'s docs for more information
+
+## Example
+
+### Via Builder
+
+```rust,no_run
+use anyhow::Result;
+use opendal::services::Webdav;
+use opendal::Operator;
+
+#[tokio::main]
+async fn main() -> Result<()> {
+    // create backend builder
+    let mut builder = Webdav::default()
+        .endpoint("127.0.0.1")
+        .username("xxx")
+        .password("xxx");
+
+    let op: Operator = Operator::new(builder)?.finish();
+
+    Ok(())
+}
+```

data/core/src/services/webdav/error.rs

@@ -0,0 +1,53 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+use http::Response;
+use http::StatusCode;
+
+use crate::raw::*;
+use crate::*;
+
+/// Parse error response into Error.
+pub(super) fn parse_error(resp: Response<Buffer>) -> Error {
+    let (parts, body) = resp.into_parts();
+    let bs = body.to_bytes();
+
+    let (kind, retryable) = match parts.status {
+        StatusCode::NOT_FOUND => (ErrorKind::NotFound, false),
+        // Some services (like owncloud) return 403 while file locked.
+        StatusCode::FORBIDDEN => (ErrorKind::PermissionDenied, true),
+        // Allowing retry for resource locked.
+        StatusCode::LOCKED => (ErrorKind::Unexpected, true),
+        StatusCode::INTERNAL_SERVER_ERROR
+        | StatusCode::BAD_GATEWAY
+        | StatusCode::SERVICE_UNAVAILABLE
+        | StatusCode::GATEWAY_TIMEOUT => (ErrorKind::Unexpected, true),
+        _ => (ErrorKind::Unexpected, false),
+    };
+
+    let message = String::from_utf8_lossy(&bs);
+
+    let mut err = Error::new(kind, message);
+
+    err = with_error_response_context(err, parts);
+
+    if retryable {
+        err = err.set_temporary();
+    }
+
+    err
+}

data/core/src/services/webdav/lister.rs

@@ -0,0 +1,106 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+use std::sync::Arc;
+
+use http::StatusCode;
+
+use super::core::*;
+use super::error::*;
+use crate::raw::*;
+use crate::*;
+
+pub struct WebdavLister {
+    core: Arc<WebdavCore>,
+
+    path: String,
+    args: OpList,
+}
+
+impl WebdavLister {
+    pub fn new(core: Arc<WebdavCore>, path: &str, args: OpList) -> Self {
+        Self {
+            core,
+            path: path.to_string(),
+            args,
+        }
+    }
+}
+
+impl oio::PageList for WebdavLister {
+    async fn next_page(&self, ctx: &mut oio::PageContext) -> Result<()> {
+        let resp = self.core.webdav_list(&self.path, &self.args).await?;
+
+        // jfrog artifactory's webdav services have some strange behavior.
+        // We add this flag to check if the server is jfrog artifactory.
+        //
+        // Example: `"x-jfrog-version": "Artifactory/7.77.5 77705900"`
+        let is_jfrog_artifactory = if let Some(v) = resp.headers().get("x-jfrog-version") {
+            v.to_str().unwrap_or_default().starts_with("Artifactory")
+        } else {
+            false
+        };
+
+        let bs = if resp.status().is_success() {
+            resp.into_body()
+        } else if resp.status() == StatusCode::NOT_FOUND && self.path.ends_with('/') {
+            ctx.done = true;
+            return Ok(());
+        } else {
+            return Err(parse_error(resp));
+        };
+
+        let result: Multistatus = deserialize_multistatus(&bs.to_bytes())?;
+
+        for res in result.response {
+            let mut path = res
+                .href
+                .strip_prefix(&self.core.server_path)
+                .unwrap_or(&res.href)
+                .to_string();
+
+            let meta = parse_propstat(&res.propstat)?;
+
+            // Append `/` to path if it's a dir
+            if !path.ends_with('/') && meta.is_dir() {
+                path += "/"
+            }
+
+            let decoded_path = percent_decode_path(&path);
+            let normalized_path = if self.core.root != decoded_path {
+                build_rel_path(&self.core.root, &decoded_path)
+            } else {
+                "/".to_owned()
+            };
+
+            // HACKS! HACKS! HACKS!
+            //
+            // jfrog artifactory will generate a virtual checksum file for each file.
+            // The checksum file can't be stated, but can be listed and read.
+            // We ignore the checksum files to avoid listing unexpected files.
+            if is_jfrog_artifactory && meta.content_type() == Some("application/x-checksum") {
+                continue;
+            }
+
+            ctx.entries
+                .push_back(oio::Entry::new(&normalized_path, meta))
+        }
+        ctx.done = true;
+
+        Ok(())
+    }
+}

data/core/src/services/webdav/mod.rs

@@ -0,0 +1,38 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+/// Default scheme for webdav service.
+#[cfg(feature = "services-webdav")]
+pub(super) const DEFAULT_SCHEME: &str = "webdav";
+#[cfg(feature = "services-webdav")]
+mod core;
+#[cfg(feature = "services-webdav")]
+mod delete;
+#[cfg(feature = "services-webdav")]
+mod error;
+#[cfg(feature = "services-webdav")]
+mod lister;
+#[cfg(feature = "services-webdav")]
+mod writer;
+
+#[cfg(feature = "services-webdav")]
+mod backend;
+#[cfg(feature = "services-webdav")]
+pub use backend::WebdavBuilder as Webdav;
+
+mod config;
+pub use config::WebdavConfig;

data/core/src/services/webdav/writer.rs

@@ -0,0 +1,56 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+use std::sync::Arc;
+
+use http::StatusCode;
+
+use super::core::*;
+use super::error::parse_error;
+use crate::raw::*;
+use crate::*;
+
+pub struct WebdavWriter {
+    core: Arc<WebdavCore>,
+
+    op: OpWrite,
+    path: String,
+}
+
+impl WebdavWriter {
+    pub fn new(core: Arc<WebdavCore>, op: OpWrite, path: String) -> Self {
+        WebdavWriter { core, op, path }
+    }
+}
+
+impl oio::OneShotWrite for WebdavWriter {
+    async fn write_once(&self, bs: Buffer) -> Result<Metadata> {
+        let resp = self
+            .core
+            .webdav_put(&self.path, Some(bs.len() as u64), &self.op, bs)
+            .await?;
+
+        let status = resp.status();
+
+        match status {
+            StatusCode::CREATED | StatusCode::OK | StatusCode::NO_CONTENT => {
+                Ok(Metadata::default())
+            }
+            _ => Err(parse_error(resp)),
+        }
+    }
+}