hoslo commented on code in PR #3918: URL: https://github.com/apache/incubator-opendal/pull/3918#discussion_r1442546737
########## core/src/services/yandex_disk/backend.rs: ########## @@ -0,0 +1,328 @@ +// 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 async_trait::async_trait; +use http::Request; +use http::StatusCode; +use log::debug; +use serde::Deserialize; +use std::collections::HashMap; +use std::fmt::Debug; +use std::fmt::Formatter; +use std::sync::Arc; + +use super::core::*; +use super::error::parse_error; +use super::lister::YandexDiskLister; +use super::writer::YandexDiskWriter; +use super::writer::YandexDiskWriters; +use crate::raw::*; +use crate::*; + +/// Config for backblaze YandexDisk services support. +#[derive(Default, Deserialize)] +#[serde(default)] +#[non_exhaustive] +pub struct YandexDiskConfig { + /// root of this backend. + /// + /// All operations will happen under this root. + pub root: Option<String>, + /// yandex disk oauth access_token. + pub access_token: String, +} + +impl Debug for YandexDiskConfig { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + let mut ds = f.debug_struct("Config"); + + ds.field("root", &self.root); + + ds.finish() + } +} + +/// [YandexDisk](https://360.yandex.com/disk/) services support. +#[doc = include_str!("docs.md")] +#[derive(Default)] +pub struct YandexDiskBuilder { + config: YandexDiskConfig, + + http_client: Option<HttpClient>, +} + +impl Debug for YandexDiskBuilder { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + let mut d = f.debug_struct("YandexDiskBuilder"); + + d.field("config", &self.config); + d.finish_non_exhaustive() + } +} + +impl YandexDiskBuilder { + /// Set root of this backend. + /// + /// All operations will happen under this root. + pub fn root(&mut self, root: &str) -> &mut Self { + self.config.root = if root.is_empty() { + None + } else { + Some(root.to_string()) + }; + + self + } + + /// yandex disk oauth access_token. + /// visit https://yandex.com/dev/id/doc/en/ to get access_token + /// + /// It is required. e.g. `xxxx` + pub fn access_token(&mut self, access_token: &str) -> &mut Self { + self.config.access_token = access_token.to_string(); + + 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. + pub fn http_client(&mut self, client: HttpClient) -> &mut Self { + self.http_client = Some(client); + self + } +} + +impl Builder for YandexDiskBuilder { + const SCHEME: Scheme = Scheme::YandexDisk; + type Accessor = YandexDiskBackend; + + /// Converts a HashMap into an YandexDiskBuilder instance. + /// + /// # Arguments + /// + /// * `map` - A HashMap containing the configuration values. + /// + /// # Returns + /// + /// Returns an instance of YandexDiskBuilder. + fn from_map(map: HashMap<String, String>) -> Self { + // Deserialize the configuration from the HashMap. + let config = YandexDiskConfig::deserialize(ConfigDeserializer::new(map)) + .expect("config deserialize must succeed"); + + // Create an YandexDiskBuilder instance with the deserialized config. + YandexDiskBuilder { + config, + http_client: None, + } + } + + /// Builds the backend and returns the result of YandexDiskBackend. + fn build(&mut self) -> Result<Self::Accessor> { + debug!("backend build started: {:?}", &self); + + let root = normalize_root(&self.config.root.clone().unwrap_or_default()); + debug!("backend use root {}", &root); + + // Handle oauth access_token. + if self.config.access_token.is_empty() { + return Err( + Error::new(ErrorKind::ConfigInvalid, "access_token is empty") + .with_operation("Builder::build") + .with_context("service", Scheme::YandexDisk), + ); + } + + let client = if let Some(client) = self.http_client.take() { + client + } else { + HttpClient::new().map_err(|err| { + err.with_operation("Builder::build") + .with_context("service", Scheme::YandexDisk) + })? + }; + + Ok(YandexDiskBackend { + core: Arc::new(YandexDiskCore { + root, + access_token: self.config.access_token.clone(), + client, + }), + }) + } +} + +/// Backend for YandexDisk services. +#[derive(Debug, Clone)] +pub struct YandexDiskBackend { + core: Arc<YandexDiskCore>, +} + +#[async_trait] +impl Accessor for YandexDiskBackend { + type Reader = IncomingAsyncBody; + + type BlockingReader = (); + + type Writer = YandexDiskWriters; + + type BlockingWriter = (); + + type Lister = oio::PageLister<YandexDiskLister>; + + type BlockingLister = (); + + fn info(&self) -> AccessorInfo { + let mut am = AccessorInfo::default(); + am.set_scheme(Scheme::YandexDisk) + .set_root(&self.core.root) + .set_native_capability(Capability { + stat: true, + + create_dir: true, + + read: true, + + write: true, + write_can_empty: true, + + delete: true, + rename: true, + copy: true, + + list: true, + list_with_limit: true, + + ..Default::default() + }); + + am + } + + async fn create_dir(&self, path: &str, _: OpCreateDir) -> Result<RpCreateDir> { + self.core.ensure_dir_exists(path).await?; + + Ok(RpCreateDir::default()) + } + + async fn rename(&self, from: &str, to: &str, _args: OpRename) -> Result<RpRename> { + self.core.ensure_dir_exists(to).await?; + + let resp = self.core.move_object(from, to).await?; + + let status = resp.status(); + + match status { + StatusCode::OK | StatusCode::CREATED => { + resp.into_body().consume().await?; + + Ok(RpRename::default()) + } + _ => Err(parse_error(resp).await?), + } + } + + async fn copy(&self, from: &str, to: &str, _args: OpCopy) -> Result<RpCopy> { + self.core.ensure_dir_exists(to).await?; + + let resp = self.core.copy(from, to).await?; + + let status = resp.status(); + + match status { + StatusCode::OK | StatusCode::CREATED => { + resp.into_body().consume().await?; + + Ok(RpCopy::default()) + } + _ => Err(parse_error(resp).await?), + } + } + + async fn read(&self, path: &str, _args: OpRead) -> Result<(RpRead, Self::Reader)> { + let download_url = self.core.get_download_url(path).await?; + + let req = Request::get(download_url) + .body(AsyncBody::Empty) + .map_err(new_request_build_error)?; + let resp = self.core.send(req).await?; + + let status = resp.status(); + + match status { + StatusCode::OK => { + let size = parse_content_length(resp.headers())?; + let range = parse_content_range(resp.headers())?; + Ok(( + RpRead::new().with_size(size).with_range(range), + resp.into_body(), + )) + } + _ => Err(parse_error(resp).await?), + } + } + + async fn stat(&self, path: &str, _args: OpStat) -> Result<RpStat> { + let resp = self.core.metainformation(path, None, None).await?; + + let status = resp.status(); + + match status { + StatusCode::OK => { + let bs = resp.into_body().bytes().await?; + + let mf: MetainformationResponse = + serde_json::from_slice(&bs).map_err(new_json_deserialize_error)?; + + parse_info(mf).map(RpStat::new) + } + _ => Err(parse_error(resp).await?), + } + } + + async fn write(&self, path: &str, _args: OpWrite) -> Result<(RpWrite, Self::Writer)> { + let writer = YandexDiskWriter::new(self.core.clone(), path.to_string()); + + let w = oio::OneShotWriter::new(writer); + + Ok((RpWrite::default(), w)) + } + + async fn delete(&self, path: &str, _: OpDelete) -> Result<RpDelete> { + let resp = self.core.delete(path).await?; + + let status = resp.status(); + + match status { + StatusCode::OK => Ok(RpDelete::default()), + StatusCode::NO_CONTENT => Ok(RpDelete::default()), + StatusCode::ACCEPTED => Ok(RpDelete::default()), Review Comment: It is an asynchronous operation -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
