use std::collections::HashMap;
use std::fmt::Debug;
use std::fmt::Formatter;
use std::sync::Arc;
use http::StatusCode;
use log::debug;
use reqsign::AzureStorageConfig;
use reqsign::AzureStorageLoader;
use reqsign::AzureStorageSigner;
use serde::Deserialize;
use super::core::AzdlsCore;
use super::error::parse_error;
use super::lister::AzdlsLister;
use super::writer::AzdlsWriter;
use super::writer::AzdlsWriters;
use crate::raw::*;
use crate::services::azdls::reader::AzdlsReader;
use crate::*;
const KNOWN_AZDLS_ENDPOINT_SUFFIX: &[&str] = &[
"dfs.core.windows.net",
"dfs.core.usgovcloudapi.net",
"dfs.core.chinacloudapi.cn",
];
#[derive(Default, Deserialize, Clone)]
pub struct AzdlsConfig {
root: Option<String>,
filesystem: String,
endpoint: Option<String>,
account_name: Option<String>,
account_key: Option<String>,
}
impl Debug for AzdlsConfig {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
let mut ds = f.debug_struct("AzdlsConfig");
ds.field("root", &self.root);
ds.field("filesystem", &self.filesystem);
ds.field("endpoint", &self.endpoint);
if self.account_name.is_some() {
ds.field("account_name", &"<redacted>");
}
if self.account_key.is_some() {
ds.field("account_key", &"<redacted>");
}
ds.finish()
}
}
#[doc = include_str!("docs.md")]
#[derive(Default, Clone)]
pub struct AzdlsBuilder {
config: AzdlsConfig,
http_client: Option<HttpClient>,
}
impl Debug for AzdlsBuilder {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
let mut ds = f.debug_struct("AzdlsBuilder");
ds.field("config", &self.config);
ds.finish()
}
}
impl AzdlsBuilder {
pub fn root(&mut self, root: &str) -> &mut Self {
if !root.is_empty() {
self.config.root = Some(root.to_string())
}
self
}
pub fn filesystem(&mut self, filesystem: &str) -> &mut Self {
self.config.filesystem = filesystem.to_string();
self
}
pub fn endpoint(&mut self, endpoint: &str) -> &mut Self {
if !endpoint.is_empty() {
self.config.endpoint = Some(endpoint.trim_end_matches('/').to_string());
}
self
}
pub fn account_name(&mut self, account_name: &str) -> &mut Self {
if !account_name.is_empty() {
self.config.account_name = Some(account_name.to_string());
}
self
}
pub fn account_key(&mut self, account_key: &str) -> &mut Self {
if !account_key.is_empty() {
self.config.account_key = Some(account_key.to_string());
}
self
}
pub fn http_client(&mut self, client: HttpClient) -> &mut Self {
self.http_client = Some(client);
self
}
}
impl Builder for AzdlsBuilder {
type Accessor = AzdlsBackend;
const SCHEME: Scheme = Scheme::Azdls;
fn build(&mut self) -> Result<Self::Accessor> {
debug!("backend build started: {:?}", &self);
let root = normalize_root(&self.config.root.take().unwrap_or_default());
debug!("backend use root {}", root);
let filesystem = match self.config.filesystem.is_empty() {
false => Ok(&self.config.filesystem),
true => Err(Error::new(ErrorKind::ConfigInvalid, "filesystem is empty")
.with_operation("Builder::build")
.with_context("service", Scheme::Azdls)),
}?;
debug!("backend use filesystem {}", &filesystem);
let endpoint = match &self.config.endpoint {
Some(endpoint) => Ok(endpoint.clone()),
None => Err(Error::new(ErrorKind::ConfigInvalid, "endpoint is empty")
.with_operation("Builder::build")
.with_context("service", Scheme::Azdls)),
}?;
debug!("backend use endpoint {}", &endpoint);
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::Azdls)
})?
};
let config_loader = AzureStorageConfig {
account_name: self
.config
.account_name
.clone()
.or_else(|| infer_storage_name_from_endpoint(endpoint.as_str())),
account_key: self.config.account_key.clone(),
sas_token: None,
..Default::default()
};
let cred_loader = AzureStorageLoader::new(config_loader);
let signer = AzureStorageSigner::new();
debug!("backend build finished: {:?}", &self);
Ok(AzdlsBackend {
core: Arc::new(AzdlsCore {
filesystem: self.config.filesystem.clone(),
root,
endpoint,
client,
loader: cred_loader,
signer,
}),
})
}
fn from_map(map: HashMap<String, String>) -> Self {
let config = AzdlsConfig::deserialize(ConfigDeserializer::new(map))
.expect("config deserialize must succeed");
AzdlsBuilder {
config,
http_client: None,
}
}
}
#[derive(Debug, Clone)]
pub struct AzdlsBackend {
core: Arc<AzdlsCore>,
}
impl Access for AzdlsBackend {
type Reader = AzdlsReader;
type Writer = AzdlsWriters;
type Lister = oio::PageLister<AzdlsLister>;
type BlockingReader = ();
type BlockingWriter = ();
type BlockingLister = ();
fn info(&self) -> AccessorInfo {
let mut am = AccessorInfo::default();
am.set_scheme(Scheme::Azdls)
.set_root(&self.core.root)
.set_name(&self.core.filesystem)
.set_native_capability(Capability {
stat: true,
read: true,
write: true,
write_can_append: true,
create_dir: true,
delete: true,
rename: true,
list: true,
..Default::default()
});
am
}
async fn create_dir(&self, path: &str, _: OpCreateDir) -> Result<RpCreateDir> {
let mut req = self.core.azdls_create_request(
path,
"directory",
&OpWrite::default(),
Buffer::new(),
)?;
self.core.sign(&mut req).await?;
let resp = self.core.send(req).await?;
let status = resp.status();
match status {
StatusCode::CREATED | StatusCode::OK => Ok(RpCreateDir::default()),
_ => Err(parse_error(resp).await?),
}
}
async fn stat(&self, path: &str, _: OpStat) -> Result<RpStat> {
if path == "/" {
return Ok(RpStat::new(Metadata::new(EntryMode::DIR)));
}
let resp = self.core.azdls_get_properties(path).await?;
if resp.status() != StatusCode::OK {
return Err(parse_error(resp).await?);
}
let mut meta = parse_into_metadata(path, resp.headers())?;
let resource = resp
.headers()
.get("x-ms-resource-type")
.ok_or_else(|| {
Error::new(
ErrorKind::Unexpected,
"azdls should return x-ms-resource-type header, but it's missing",
)
})?
.to_str()
.map_err(|err| {
Error::new(
ErrorKind::Unexpected,
"azdls should return x-ms-resource-type header, but it's not a valid string",
)
.set_source(err)
})?;
meta = match resource {
"file" => meta.with_mode(EntryMode::FILE),
"directory" => meta.with_mode(EntryMode::DIR),
v => {
return Err(Error::new(
ErrorKind::Unexpected,
"azdls returns not supported x-ms-resource-type",
)
.with_context("resource", v))
}
};
Ok(RpStat::new(meta))
}
async fn read(&self, path: &str, args: OpRead) -> Result<(RpRead, Self::Reader)> {
Ok((
RpRead::default(),
AzdlsReader::new(self.core.clone(), path, args),
))
}
async fn write(&self, path: &str, args: OpWrite) -> Result<(RpWrite, Self::Writer)> {
let w = AzdlsWriter::new(self.core.clone(), args.clone(), path.to_string());
let w = if args.append() {
AzdlsWriters::Two(oio::AppendWriter::new(w))
} else {
AzdlsWriters::One(oio::OneShotWriter::new(w))
};
Ok((RpWrite::default(), w))
}
async fn delete(&self, path: &str, _: OpDelete) -> Result<RpDelete> {
let resp = self.core.azdls_delete(path).await?;
let status = resp.status();
match status {
StatusCode::OK | StatusCode::NOT_FOUND => Ok(RpDelete::default()),
_ => Err(parse_error(resp).await?),
}
}
async fn list(&self, path: &str, args: OpList) -> Result<(RpList, Self::Lister)> {
let l = AzdlsLister::new(self.core.clone(), path.to_string(), args.limit());
Ok((RpList::default(), oio::PageLister::new(l)))
}
async fn rename(&self, from: &str, to: &str, _args: OpRename) -> Result<RpRename> {
if let Some(resp) = self.core.azdls_ensure_parent_path(to).await? {
let status = resp.status();
match status {
StatusCode::CREATED | StatusCode::CONFLICT => {}
_ => return Err(parse_error(resp).await?),
}
}
let resp = self.core.azdls_rename(from, to).await?;
let status = resp.status();
match status {
StatusCode::CREATED => Ok(RpRename::default()),
_ => Err(parse_error(resp).await?),
}
}
}
fn infer_storage_name_from_endpoint(endpoint: &str) -> Option<String> {
let endpoint: &str = endpoint
.strip_prefix("http://")
.or_else(|| endpoint.strip_prefix("https://"))
.unwrap_or(endpoint);
let mut parts = endpoint.splitn(2, '.');
let storage_name = parts.next();
let endpoint_suffix = parts
.next()
.unwrap_or_default()
.trim_end_matches('/')
.to_lowercase();
if KNOWN_AZDLS_ENDPOINT_SUFFIX
.iter()
.any(|s| *s == endpoint_suffix.as_str())
{
storage_name.map(|s| s.to_string())
} else {
None
}
}
#[cfg(test)]
mod tests {
use super::AzdlsBuilder;
use crate::services::azdls::backend::infer_storage_name_from_endpoint;
use crate::Builder;
#[test]
fn test_infer_storage_name_from_endpoint() {
let endpoint = "https://account.dfs.core.windows.net";
let storage_name = infer_storage_name_from_endpoint(endpoint);
assert_eq!(storage_name, Some("account".to_string()));
}
#[test]
fn test_infer_storage_name_from_endpoint_with_trailing_slash() {
let endpoint = "https://account.dfs.core.windows.net/";
let storage_name = infer_storage_name_from_endpoint(endpoint);
assert_eq!(storage_name, Some("account".to_string()));
}
#[test]
fn test_builder_from_endpoint_and_key_infer_account_name() {
let mut azdls_builder = AzdlsBuilder::default();
azdls_builder.endpoint("https://storagesample.dfs.core.chinacloudapi.cn");
azdls_builder.account_key("account-key");
azdls_builder.filesystem("filesystem");
let azdls = azdls_builder
.build()
.expect("build Azdls should be succeeded.");
assert_eq!(
azdls.core.endpoint,
"https://storagesample.dfs.core.chinacloudapi.cn"
);
assert_eq!(azdls.core.filesystem, "filesystem".to_string());
assert_eq!(
azdls_builder.config.account_key.unwrap(),
"account-key".to_string()
);
}
#[test]
fn test_no_key_wont_infer_account_name() {
let mut azdls_builder = AzdlsBuilder::default();
azdls_builder.endpoint("https://storagesample.dfs.core.windows.net");
azdls_builder.filesystem("filesystem");
let azdls = azdls_builder
.build()
.expect("build Azdls should be succeeded.");
assert_eq!(
azdls.core.endpoint,
"https://storagesample.dfs.core.windows.net"
);
assert_eq!(azdls.core.filesystem, "filesystem".to_string());
assert_eq!(azdls_builder.config.account_key, None);
}
}