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::AzfileCore;
use super::error::parse_error;
use super::writer::AzfileWriter;
use super::writer::AzfileWriters;
use crate::raw::*;
use crate::services::azfile::lister::AzfileLister;
use crate::services::azfile::reader::AzfileReader;
use crate::*;
const DEFAULT_AZFILE_ENDPOINT_SUFFIX: &str = "file.core.windows.net";
#[derive(Default, Deserialize, Clone)]
pub struct AzfileConfig {
root: Option<String>,
endpoint: Option<String>,
share_name: String,
account_name: Option<String>,
account_key: Option<String>,
sas_token: Option<String>,
}
impl Debug for AzfileConfig {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
let mut ds = f.debug_struct("AzfileConfig");
ds.field("root", &self.root);
ds.field("share_name", &self.share_name);
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>");
}
if self.sas_token.is_some() {
ds.field("sas_token", &"<redacted>");
}
ds.finish()
}
}
#[doc = include_str!("docs.md")]
#[derive(Default, Clone)]
pub struct AzfileBuilder {
config: AzfileConfig,
http_client: Option<HttpClient>,
}
impl Debug for AzfileBuilder {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
let mut ds = f.debug_struct("AzfileBuilder");
ds.field("config", &self.config);
ds.finish()
}
}
impl AzfileBuilder {
pub fn root(&mut self, root: &str) -> &mut Self {
if !root.is_empty() {
self.config.root = Some(root.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 share_name(&mut self, share_name: &str) -> &mut Self {
if !share_name.is_empty() {
self.config.share_name = share_name.to_string();
}
self
}
pub fn http_client(&mut self, client: HttpClient) -> &mut Self {
self.http_client = Some(client);
self
}
}
impl Builder for AzfileBuilder {
const SCHEME: Scheme = Scheme::Azfile;
type Accessor = AzfileBackend;
fn from_map(map: HashMap<String, String>) -> Self {
let config = AzfileConfig::deserialize(ConfigDeserializer::new(map))
.expect("config deserialize must succeed");
AzfileBuilder {
config,
http_client: None,
}
}
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 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::Azfile)),
}?;
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::Azfile)
})?
};
let account_name_option = self
.config
.account_name
.clone()
.or_else(|| infer_account_name_from_endpoint(endpoint.as_str()));
let account_name = match account_name_option {
Some(account_name) => Ok(account_name),
None => Err(
Error::new(ErrorKind::ConfigInvalid, "account_name is empty")
.with_operation("Builder::build")
.with_context("service", Scheme::Azfile),
),
}?;
let config_loader = AzureStorageConfig {
account_name: Some(account_name),
account_key: self.config.account_key.clone(),
sas_token: self.config.sas_token.clone(),
..Default::default()
};
let cred_loader = AzureStorageLoader::new(config_loader);
let signer = AzureStorageSigner::new();
debug!("backend build finished: {:?}", &self);
Ok(AzfileBackend {
core: Arc::new(AzfileCore {
root,
endpoint,
loader: cred_loader,
client,
signer,
share_name: self.config.share_name.clone(),
}),
})
}
}
fn infer_account_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 account_name = parts.next();
let endpoint_suffix = parts
.next()
.unwrap_or_default()
.trim_end_matches('/')
.to_lowercase();
if endpoint_suffix == DEFAULT_AZFILE_ENDPOINT_SUFFIX {
account_name.map(|s| s.to_string())
} else {
None
}
}
#[derive(Debug, Clone)]
pub struct AzfileBackend {
core: Arc<AzfileCore>,
}
impl Access for AzfileBackend {
type Reader = AzfileReader;
type Writer = AzfileWriters;
type Lister = oio::PageLister<AzfileLister>;
type BlockingReader = ();
type BlockingWriter = ();
type BlockingLister = ();
fn info(&self) -> AccessorInfo {
let mut am = AccessorInfo::default();
am.set_scheme(Scheme::Azfile)
.set_root(&self.core.root)
.set_native_capability(Capability {
stat: true,
read: true,
write: true,
create_dir: true,
delete: true,
rename: true,
list: true,
..Default::default()
});
am
}
async fn create_dir(&self, path: &str, _: OpCreateDir) -> Result<RpCreateDir> {
self.core.ensure_parent_dir_exists(path).await?;
let resp = self.core.azfile_create_dir(path).await?;
let status = resp.status();
match status {
StatusCode::CREATED => Ok(RpCreateDir::default()),
_ => {
if resp
.headers()
.get("x-ms-error-code")
.map(|value| value.to_str().unwrap_or(""))
.unwrap_or_else(|| "")
== "ResourceAlreadyExists"
{
Ok(RpCreateDir::default())
} else {
Err(parse_error(resp).await?)
}
}
}
}
async fn stat(&self, path: &str, _: OpStat) -> Result<RpStat> {
let resp = if path.ends_with('/') {
self.core.azfile_get_directory_properties(path).await?
} else {
self.core.azfile_get_file_properties(path).await?
};
let status = resp.status();
match status {
StatusCode::OK => {
let meta = parse_into_metadata(path, resp.headers())?;
Ok(RpStat::new(meta))
}
_ => Err(parse_error(resp).await?),
}
}
async fn read(&self, path: &str, args: OpRead) -> Result<(RpRead, Self::Reader)> {
Ok((
RpRead::default(),
AzfileReader::new(self.core.clone(), path, args),
))
}
async fn write(&self, path: &str, args: OpWrite) -> Result<(RpWrite, Self::Writer)> {
self.core.ensure_parent_dir_exists(path).await?;
let w = AzfileWriter::new(self.core.clone(), args.clone(), path.to_string());
let w = if args.append() {
AzfileWriters::Two(oio::AppendWriter::new(w))
} else {
AzfileWriters::One(oio::OneShotWriter::new(w))
};
Ok((RpWrite::default(), w))
}
async fn delete(&self, path: &str, _: OpDelete) -> Result<RpDelete> {
let resp = if path.ends_with('/') {
self.core.azfile_delete_dir(path).await?
} else {
self.core.azfile_delete_file(path).await?
};
let status = resp.status();
match status {
StatusCode::ACCEPTED | 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 = AzfileLister::new(self.core.clone(), path.to_string(), args.limit());
Ok((RpList::default(), oio::PageLister::new(l)))
}
async fn rename(&self, from: &str, to: &str, _: OpRename) -> Result<RpRename> {
self.core.ensure_parent_dir_exists(to).await?;
let resp = self.core.azfile_rename(from, to).await?;
let status = resp.status();
match status {
StatusCode::OK => Ok(RpRename::default()),
_ => Err(parse_error(resp).await?),
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::Builder;
#[test]
fn test_infer_storage_name_from_endpoint() {
let cases = vec![
(
"test infer account name from endpoint",
"https://account.file.core.windows.net",
"account",
),
(
"test infer account name from endpoint with trailing slash",
"https://account.file.core.windows.net/",
"account",
),
];
for (desc, endpoint, expected) in cases {
let account_name = infer_account_name_from_endpoint(endpoint);
assert_eq!(account_name, Some(expected.to_string()), "{}", desc);
}
}
#[test]
fn test_builder_from_endpoint_and_key_infer_account_name() {
let mut azfile_builder = AzfileBuilder::default();
azfile_builder.endpoint("https://account.file.core.windows.net/");
azfile_builder.account_key("account-key");
let azfile = azfile_builder
.build()
.expect("build Azdls should be succeeded.");
assert_eq!(
azfile.core.endpoint,
"https://account.file.core.windows.net"
);
assert_eq!(
azfile_builder.config.account_key.unwrap(),
"account-key".to_string()
);
}
}