opendal 0.1.6.pre.rc.1

data/core/src/services/compfs/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 compfs service.
+#[cfg(feature = "services-compfs")]
+pub(super) const DEFAULT_SCHEME: &str = "compfs";
+#[cfg(feature = "services-compfs")]
+mod core;
+#[cfg(feature = "services-compfs")]
+mod delete;
+#[cfg(feature = "services-compfs")]
+mod lister;
+#[cfg(feature = "services-compfs")]
+mod reader;
+#[cfg(feature = "services-compfs")]
+mod writer;
+
+#[cfg(feature = "services-compfs")]
+mod backend;
+#[cfg(feature = "services-compfs")]
+pub use backend::CompfsBuilder as Compfs;
+
+mod config;
+pub use config::CompfsConfig;

data/core/src/services/compfs/reader.rs

@@ -0,0 +1,79 @@
+// 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 compio::buf::buf_try;
+use compio::buf::IntoInner;
+use compio::buf::IoBuf;
+use compio::io::AsyncReadAt;
+
+use super::core::CompfsCore;
+use crate::raw::*;
+use crate::*;
+
+#[derive(Debug)]
+pub struct CompfsReader {
+    core: Arc<CompfsCore>,
+    file: compio::fs::File,
+    offset: u64,
+    end: Option<u64>,
+}
+
+impl CompfsReader {
+    pub(super) fn new(core: Arc<CompfsCore>, file: compio::fs::File, range: BytesRange) -> Self {
+        Self {
+            core,
+            file,
+            offset: range.offset(),
+            end: range.size().map(|v| v + range.offset()),
+        }
+    }
+}
+
+impl oio::Read for CompfsReader {
+    async fn read(&mut self) -> Result<Buffer> {
+        let pos = self.offset;
+        if let Some(end) = self.end {
+            if end <= pos {
+                return Ok(Buffer::new());
+            }
+        }
+
+        let mut bs = self.core.buf_pool.get();
+        // reserve 64KB buffer by default, we should allow user to configure this or make it adaptive.
+        let max_len = if let Some(end) = self.end {
+            (end - pos) as usize
+        } else {
+            64 * 1024
+        };
+        bs.reserve(max_len);
+        let f = self.file.clone();
+        let (n, mut bs) = self
+            .core
+            .exec(move || async move {
+                // reserve doesn't guarantee the exact size
+                let (n, bs) = buf_try!(@try f.read_at(bs.slice(..max_len), pos).await);
+                Ok((n, bs.into_inner()))
+            })
+            .await?;
+        let frozen = bs.split_to(n).freeze();
+        self.offset += frozen.len() as u64;
+        self.core.buf_pool.put(bs);
+        Ok(Buffer::from(frozen))
+    }
+}

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

@@ -0,0 +1,90 @@
+// 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::io::Cursor;
+use std::sync::Arc;
+
+use compio::buf::buf_try;
+use compio::fs::File;
+use compio::io::AsyncWriteExt;
+
+use super::core::CompfsCore;
+use crate::raw::*;
+use crate::*;
+
+#[derive(Debug)]
+pub struct CompfsWriter {
+    core: Arc<CompfsCore>,
+    file: Option<Cursor<File>>,
+}
+
+impl CompfsWriter {
+    pub(super) fn new(core: Arc<CompfsCore>, file: Cursor<File>) -> Self {
+        Self {
+            core,
+            file: Some(file),
+        }
+    }
+}
+
+impl oio::Write for CompfsWriter {
+    /// FIXME
+    ///
+    /// the write_all doesn't work correctly if `bs` is non-contiguous.
+    ///
+    /// The IoBuf::buf_len() only returns the length of the current buffer.
+    async fn write(&mut self, bs: Buffer) -> Result<()> {
+        let Some(mut file) = self.file.clone() else {
+            return Err(Error::new(ErrorKind::Unexpected, "file has closed"));
+        };
+
+        let pos = self
+            .core
+            .exec(move || async move {
+                for b in bs {
+                    buf_try!(@try file.write_all(b).await);
+                }
+                Ok(file.position())
+            })
+            .await?;
+        self.file.as_mut().unwrap().set_position(pos);
+
+        Ok(())
+    }
+
+    async fn close(&mut self) -> Result<Metadata> {
+        let Some(f) = self.file.take() else {
+            return Err(Error::new(ErrorKind::Unexpected, "file has closed"));
+        };
+
+        self.core
+            .exec(move || async move {
+                f.get_ref().sync_all().await?;
+                f.into_inner().close().await
+            })
+            .await?;
+
+        Ok(Metadata::default())
+    }
+
+    async fn abort(&mut self) -> Result<()> {
+        Err(Error::new(
+            ErrorKind::Unsupported,
+            "cannot abort completion-based operations",
+        ))
+    }
+}

data/core/src/services/cos/backend.rs

@@ -0,0 +1,442 @@
+// 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::fmt::Debug;
+use std::sync::Arc;
+
+use http::Response;
+use http::StatusCode;
+use http::Uri;
+use log::debug;
+use reqsign::TencentCosConfig;
+use reqsign::TencentCosCredentialLoader;
+use reqsign::TencentCosSigner;
+
+use super::core::*;
+use super::delete::CosDeleter;
+use super::error::parse_error;
+use super::lister::CosLister;
+use super::lister::CosListers;
+use super::lister::CosObjectVersionsLister;
+use super::writer::CosWriter;
+use super::writer::CosWriters;
+use super::DEFAULT_SCHEME;
+use crate::raw::oio::PageLister;
+use crate::raw::*;
+use crate::services::CosConfig;
+use crate::*;
+impl Configurator for CosConfig {
+    type Builder = CosBuilder;
+
+    #[allow(deprecated)]
+    fn into_builder(self) -> Self::Builder {
+        CosBuilder {
+            config: self,
+
+            http_client: None,
+        }
+    }
+}
+
+/// Tencent-Cloud COS services support.
+#[doc = include_str!("docs.md")]
+#[derive(Default, Clone)]
+pub struct CosBuilder {
+    config: CosConfig,
+
+    #[deprecated(since = "0.53.0", note = "Use `Operator::update_http_client` instead")]
+    http_client: Option<HttpClient>,
+}
+
+impl Debug for CosBuilder {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        f.debug_struct("CosBuilder")
+            .field("config", &self.config)
+            .finish()
+    }
+}
+
+impl CosBuilder {
+    /// Set root of this backend.
+    ///
+    /// All operations will happen under this root.
+    pub fn root(mut self, root: &str) -> Self {
+        self.config.root = if root.is_empty() {
+            None
+        } else {
+            Some(root.to_string())
+        };
+
+        self
+    }
+
+    /// Set endpoint of this backend.
+    ///
+    /// NOTE: no bucket or account id in endpoint, we will trim them if exists.
+    ///
+    /// # Examples
+    ///
+    /// - `https://cos.ap-singapore.myqcloud.com`
+    pub fn endpoint(mut self, endpoint: &str) -> Self {
+        if !endpoint.is_empty() {
+            self.config.endpoint = Some(endpoint.trim_end_matches('/').to_string());
+        }
+
+        self
+    }
+
+    /// Set secret_id of this backend.
+    /// - If it is set, we will take user's input first.
+    /// - If not, we will try to load it from environment.
+    pub fn secret_id(mut self, secret_id: &str) -> Self {
+        if !secret_id.is_empty() {
+            self.config.secret_id = Some(secret_id.to_string());
+        }
+
+        self
+    }
+
+    /// Set secret_key of this backend.
+    /// - If it is set, we will take user's input first.
+    /// - If not, we will try to load it from environment.
+    pub fn secret_key(mut self, secret_key: &str) -> Self {
+        if !secret_key.is_empty() {
+            self.config.secret_key = Some(secret_key.to_string());
+        }
+
+        self
+    }
+
+    /// Set bucket of this backend.
+    /// The param is required.
+    pub fn bucket(mut self, bucket: &str) -> Self {
+        if !bucket.is_empty() {
+            self.config.bucket = Some(bucket.to_string());
+        }
+
+        self
+    }
+
+    /// Set bucket versioning status for this backend
+    pub fn enable_versioning(mut self, enabled: bool) -> Self {
+        self.config.enable_versioning = enabled;
+
+        self
+    }
+
+    /// Disable config load so that opendal will not load config from
+    /// environment.
+    ///
+    /// For examples:
+    ///
+    /// - envs like `TENCENTCLOUD_SECRET_ID`
+    pub fn disable_config_load(mut self) -> Self {
+        self.config.disable_config_load = true;
+        self
+    }
+
+    /// Specify the http client that used by this service.
+    ///
+    /// # Notes
+    ///
+    /// This API is part of OpenDAL's Raw API. `HttpClient` could be changed
+    /// during minor updates.
+    #[deprecated(since = "0.53.0", note = "Use `Operator::update_http_client` instead")]
+    #[allow(deprecated)]
+    pub fn http_client(mut self, client: HttpClient) -> Self {
+        self.http_client = Some(client);
+        self
+    }
+}
+
+impl Builder for CosBuilder {
+    type Config = CosConfig;
+
+    fn build(self) -> Result<impl Access> {
+        debug!("backend build started: {:?}", &self);
+
+        let root = normalize_root(&self.config.root.unwrap_or_default());
+        debug!("backend use root {root}");
+
+        let bucket = match &self.config.bucket {
+            Some(bucket) => Ok(bucket.to_string()),
+            None => Err(
+                Error::new(ErrorKind::ConfigInvalid, "The bucket is misconfigured")
+                    .with_context("service", Scheme::Cos),
+            ),
+        }?;
+        debug!("backend use bucket {}", &bucket);
+
+        let uri = match &self.config.endpoint {
+            Some(endpoint) => endpoint.parse::<Uri>().map_err(|err| {
+                Error::new(ErrorKind::ConfigInvalid, "endpoint is invalid")
+                    .with_context("service", Scheme::Cos)
+                    .with_context("endpoint", endpoint)
+                    .set_source(err)
+            }),
+            None => Err(Error::new(ErrorKind::ConfigInvalid, "endpoint is empty")
+                .with_context("service", Scheme::Cos)),
+        }?;
+
+        let scheme = match uri.scheme_str() {
+            Some(scheme) => scheme.to_string(),
+            None => "https".to_string(),
+        };
+
+        // If endpoint contains bucket name, we should trim them.
+        let endpoint = uri.host().unwrap().replace(&format!("//{bucket}."), "//");
+        debug!("backend use endpoint {}", &endpoint);
+
+        let mut cfg = TencentCosConfig::default();
+        if !self.config.disable_config_load {
+            cfg = cfg.from_env();
+        }
+
+        if let Some(v) = self.config.secret_id {
+            cfg.secret_id = Some(v);
+        }
+        if let Some(v) = self.config.secret_key {
+            cfg.secret_key = Some(v);
+        }
+
+        let cred_loader = TencentCosCredentialLoader::new(GLOBAL_REQWEST_CLIENT.clone(), cfg);
+
+        let signer = TencentCosSigner::new();
+
+        Ok(CosBackend {
+            core: Arc::new(CosCore {
+                info: {
+                    let am = AccessorInfo::default();
+                    am.set_scheme(DEFAULT_SCHEME)
+                        .set_root(&root)
+                        .set_name(&bucket)
+                        .set_native_capability(Capability {
+                            stat: true,
+                            stat_with_if_match: true,
+                            stat_with_if_none_match: true,
+                            stat_with_version: self.config.enable_versioning,
+
+                            read: true,
+
+                            read_with_if_match: true,
+                            read_with_if_none_match: true,
+                            read_with_if_modified_since: true,
+                            read_with_if_unmodified_since: true,
+                            read_with_version: self.config.enable_versioning,
+
+                            write: true,
+                            write_can_empty: true,
+                            write_can_append: true,
+                            write_can_multi: true,
+                            write_with_content_type: true,
+                            write_with_cache_control: true,
+                            write_with_content_disposition: true,
+                            // Cos doesn't support forbid overwrite while version has been enabled.
+                            write_with_if_not_exists: !self.config.enable_versioning,
+                            // The min multipart size of COS is 1 MiB.
+                            //
+                            // ref: <https://www.tencentcloud.com/document/product/436/14112>
+                            write_multi_min_size: Some(1024 * 1024),
+                            // The max multipart size of COS is 5 GiB.
+                            //
+                            // ref: <https://www.tencentcloud.com/document/product/436/14112>
+                            write_multi_max_size: if cfg!(target_pointer_width = "64") {
+                                Some(5 * 1024 * 1024 * 1024)
+                            } else {
+                                Some(usize::MAX)
+                            },
+                            write_with_user_metadata: true,
+
+                            delete: true,
+                            delete_with_version: self.config.enable_versioning,
+                            copy: true,
+
+                            list: true,
+                            list_with_recursive: true,
+                            list_with_versions: self.config.enable_versioning,
+                            list_with_deleted: self.config.enable_versioning,
+
+                            presign: true,
+                            presign_stat: true,
+                            presign_read: true,
+                            presign_write: true,
+
+                            shared: true,
+
+                            ..Default::default()
+                        });
+
+                    // allow deprecated api here for compatibility
+                    #[allow(deprecated)]
+                    if let Some(client) = self.http_client {
+                        am.update_http_client(|_| client);
+                    }
+
+                    am.into()
+                },
+                bucket: bucket.clone(),
+                root,
+                endpoint: format!("{}://{}.{}", &scheme, &bucket, &endpoint),
+                signer,
+                loader: cred_loader,
+            }),
+        })
+    }
+}
+
+/// Backend for Tencent-Cloud COS services.
+#[derive(Debug, Clone)]
+pub struct CosBackend {
+    core: Arc<CosCore>,
+}
+
+impl Access for CosBackend {
+    type Reader = HttpBody;
+    type Writer = CosWriters;
+    type Lister = CosListers;
+    type Deleter = oio::OneShotDeleter<CosDeleter>;
+
+    fn info(&self) -> Arc<AccessorInfo> {
+        self.core.info.clone()
+    }
+
+    async fn stat(&self, path: &str, args: OpStat) -> Result<RpStat> {
+        let resp = self.core.cos_head_object(path, &args).await?;
+
+        let status = resp.status();
+
+        match status {
+            StatusCode::OK => {
+                let headers = resp.headers();
+                let mut meta = parse_into_metadata(path, headers)?;
+
+                let user_meta = parse_prefixed_headers(headers, "x-cos-meta-");
+                if !user_meta.is_empty() {
+                    meta = meta.with_user_metadata(user_meta);
+                }
+
+                if let Some(v) = parse_header_to_str(headers, constants::X_COS_VERSION_ID)? {
+                    if v != "null" {
+                        meta.set_version(v);
+                    }
+                }
+
+                Ok(RpStat::new(meta))
+            }
+            _ => Err(parse_error(resp)),
+        }
+    }
+
+    async fn read(&self, path: &str, args: OpRead) -> Result<(RpRead, Self::Reader)> {
+        let resp = self.core.cos_get_object(path, args.range(), &args).await?;
+
+        let status = resp.status();
+
+        match status {
+            StatusCode::OK | StatusCode::PARTIAL_CONTENT => {
+                Ok((RpRead::default(), resp.into_body()))
+            }
+            _ => {
+                let (part, mut body) = resp.into_parts();
+                let buf = body.to_buffer().await?;
+                Err(parse_error(Response::from_parts(part, buf)))
+            }
+        }
+    }
+
+    async fn write(&self, path: &str, args: OpWrite) -> Result<(RpWrite, Self::Writer)> {
+        let writer = CosWriter::new(self.core.clone(), path, args.clone());
+
+        let w = if args.append() {
+            CosWriters::Two(oio::AppendWriter::new(writer))
+        } else {
+            CosWriters::One(oio::MultipartWriter::new(
+                self.core.info.clone(),
+                writer,
+                args.concurrent(),
+            ))
+        };
+
+        Ok((RpWrite::default(), w))
+    }
+
+    async fn delete(&self) -> Result<(RpDelete, Self::Deleter)> {
+        Ok((
+            RpDelete::default(),
+            oio::OneShotDeleter::new(CosDeleter::new(self.core.clone())),
+        ))
+    }
+
+    async fn list(&self, path: &str, args: OpList) -> Result<(RpList, Self::Lister)> {
+        let l = if args.versions() || args.deleted() {
+            TwoWays::Two(PageLister::new(CosObjectVersionsLister::new(
+                self.core.clone(),
+                path,
+                args,
+            )))
+        } else {
+            TwoWays::One(PageLister::new(CosLister::new(
+                self.core.clone(),
+                path,
+                args.recursive(),
+                args.limit(),
+            )))
+        };
+
+        Ok((RpList::default(), l))
+    }
+
+    async fn copy(&self, from: &str, to: &str, _args: OpCopy) -> Result<RpCopy> {
+        let resp = self.core.cos_copy_object(from, to).await?;
+
+        let status = resp.status();
+
+        match status {
+            StatusCode::OK => Ok(RpCopy::default()),
+            _ => Err(parse_error(resp)),
+        }
+    }
+
+    async fn presign(&self, path: &str, args: OpPresign) -> Result<RpPresign> {
+        let req = match args.operation() {
+            PresignOperation::Stat(v) => self.core.cos_head_object_request(path, v),
+            PresignOperation::Read(v) => {
+                self.core
+                    .cos_get_object_request(path, BytesRange::default(), v)
+            }
+            PresignOperation::Write(v) => {
+                self.core
+                    .cos_put_object_request(path, None, v, Buffer::new())
+            }
+            PresignOperation::Delete(_) => Err(Error::new(
+                ErrorKind::Unsupported,
+                "operation is not supported",
+            )),
+        };
+        let mut req = req?;
+        self.core.sign_query(&mut req, args.expire()).await?;
+
+        // We don't need this request anymore, consume it directly.
+        let (parts, _) = req.into_parts();
+
+        Ok(RpPresign::new(PresignedRequest::new(
+            parts.method,
+            parts.uri,
+            parts.headers,
+        )))
+    }
+}

data/core/src/services/cos/config.rs

@@ -0,0 +1,54 @@
+// 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::fmt::Debug;
+use std::fmt::Formatter;
+
+use serde::Deserialize;
+use serde::Serialize;
+
+/// Tencent-Cloud COS services support.
+#[derive(Default, Serialize, Deserialize, Clone, PartialEq, Eq)]
+#[serde(default)]
+pub struct CosConfig {
+    /// Root of this backend.
+    pub root: Option<String>,
+    /// Endpoint of this backend.
+    pub endpoint: Option<String>,
+    /// Secret ID of this backend.
+    pub secret_id: Option<String>,
+    /// Secret key of this backend.
+    pub secret_key: Option<String>,
+    /// Bucket of this backend.
+    pub bucket: Option<String>,
+    /// is bucket versioning enabled for this bucket
+    pub enable_versioning: bool,
+    /// Disable config load so that opendal will not load config from
+    pub disable_config_load: bool,
+}
+
+impl Debug for CosConfig {
+    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
+        f.debug_struct("CosConfig")
+            .field("root", &self.root)
+            .field("endpoint", &self.endpoint)
+            .field("secret_id", &"<redacted>")
+            .field("secret_key", &"<redacted>")
+            .field("bucket", &self.bucket)
+            .finish_non_exhaustive()
+    }
+}