opendal/services/azfile/
backend.rs

1// Licensed to the Apache Software Foundation (ASF) under one
2// or more contributor license agreements.  See the NOTICE file
3// distributed with this work for additional information
4// regarding copyright ownership.  The ASF licenses this file
5// to you under the Apache License, Version 2.0 (the
6// "License"); you may not use this file except in compliance
7// with the License.  You may obtain a copy of the License at
8//
9//   http://www.apache.org/licenses/LICENSE-2.0
10//
11// Unless required by applicable law or agreed to in writing,
12// software distributed under the License is distributed on an
13// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14// KIND, either express or implied.  See the License for the
15// specific language governing permissions and limitations
16// under the License.
17
18use std::fmt::Debug;
19use std::fmt::Formatter;
20use std::sync::Arc;
21
22use http::Response;
23use http::StatusCode;
24use log::debug;
25use reqsign::AzureStorageConfig;
26use reqsign::AzureStorageLoader;
27use reqsign::AzureStorageSigner;
28
29use super::core::AzfileCore;
30use super::delete::AzfileDeleter;
31use super::error::parse_error;
32use super::lister::AzfileLister;
33use super::writer::AzfileWriter;
34use super::writer::AzfileWriters;
35use crate::raw::*;
36use crate::services::AzfileConfig;
37use crate::*;
38
39/// Default endpoint of Azure File services.
40const DEFAULT_AZFILE_ENDPOINT_SUFFIX: &str = "file.core.windows.net";
41
42impl Configurator for AzfileConfig {
43    type Builder = AzfileBuilder;
44
45    #[allow(deprecated)]
46    fn into_builder(self) -> Self::Builder {
47        AzfileBuilder {
48            config: self,
49            http_client: None,
50        }
51    }
52}
53
54/// Azure File services support.
55#[doc = include_str!("docs.md")]
56#[derive(Default, Clone)]
57pub struct AzfileBuilder {
58    config: AzfileConfig,
59
60    #[deprecated(since = "0.53.0", note = "Use `Operator::update_http_client` instead")]
61    http_client: Option<HttpClient>,
62}
63
64impl Debug for AzfileBuilder {
65    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
66        let mut ds = f.debug_struct("AzfileBuilder");
67
68        ds.field("config", &self.config);
69
70        ds.finish()
71    }
72}
73
74impl AzfileBuilder {
75    /// Set root of this backend.
76    ///
77    /// All operations will happen under this root.
78    pub fn root(mut self, root: &str) -> Self {
79        self.config.root = if root.is_empty() {
80            None
81        } else {
82            Some(root.to_string())
83        };
84
85        self
86    }
87
88    /// Set endpoint of this backend.
89    pub fn endpoint(mut self, endpoint: &str) -> Self {
90        if !endpoint.is_empty() {
91            // Trim trailing `/` so that we can accept `http://127.0.0.1:9000/`
92            self.config.endpoint = Some(endpoint.trim_end_matches('/').to_string());
93        }
94
95        self
96    }
97
98    /// Set account_name of this backend.
99    ///
100    /// - If account_name is set, we will take user's input first.
101    /// - If not, we will try to load it from environment.
102    pub fn account_name(mut self, account_name: &str) -> Self {
103        if !account_name.is_empty() {
104            self.config.account_name = Some(account_name.to_string());
105        }
106
107        self
108    }
109
110    /// Set account_key of this backend.
111    ///
112    /// - If account_key is set, we will take user's input first.
113    /// - If not, we will try to load it from environment.
114    pub fn account_key(mut self, account_key: &str) -> Self {
115        if !account_key.is_empty() {
116            self.config.account_key = Some(account_key.to_string());
117        }
118
119        self
120    }
121
122    /// Set file share name of this backend.
123    ///
124    /// # Notes
125    /// You can find more about from: <https://learn.microsoft.com/en-us/rest/api/storageservices/operations-on-shares--file-service>
126    pub fn share_name(mut self, share_name: &str) -> Self {
127        if !share_name.is_empty() {
128            self.config.share_name = share_name.to_string();
129        }
130
131        self
132    }
133
134    /// Specify the http client that used by this service.
135    ///
136    /// # Notes
137    ///
138    /// This API is part of OpenDAL's Raw API. `HttpClient` could be changed
139    /// during minor updates.
140    #[deprecated(since = "0.53.0", note = "Use `Operator::update_http_client` instead")]
141    #[allow(deprecated)]
142    pub fn http_client(mut self, client: HttpClient) -> Self {
143        self.http_client = Some(client);
144        self
145    }
146}
147
148impl Builder for AzfileBuilder {
149    const SCHEME: Scheme = Scheme::Azfile;
150    type Config = AzfileConfig;
151
152    fn build(self) -> Result<impl Access> {
153        debug!("backend build started: {:?}", &self);
154
155        let root = normalize_root(&self.config.root.unwrap_or_default());
156        debug!("backend use root {}", root);
157
158        let endpoint = match &self.config.endpoint {
159            Some(endpoint) => Ok(endpoint.clone()),
160            None => Err(Error::new(ErrorKind::ConfigInvalid, "endpoint is empty")
161                .with_operation("Builder::build")
162                .with_context("service", Scheme::Azfile)),
163        }?;
164        debug!("backend use endpoint {}", &endpoint);
165
166        let account_name_option = self
167            .config
168            .account_name
169            .clone()
170            .or_else(|| infer_account_name_from_endpoint(endpoint.as_str()));
171
172        let account_name = match account_name_option {
173            Some(account_name) => Ok(account_name),
174            None => Err(
175                Error::new(ErrorKind::ConfigInvalid, "account_name is empty")
176                    .with_operation("Builder::build")
177                    .with_context("service", Scheme::Azfile),
178            ),
179        }?;
180
181        let config_loader = AzureStorageConfig {
182            account_name: Some(account_name),
183            account_key: self.config.account_key.clone(),
184            sas_token: self.config.sas_token.clone(),
185            ..Default::default()
186        };
187
188        let cred_loader = AzureStorageLoader::new(config_loader);
189        let signer = AzureStorageSigner::new();
190        Ok(AzfileBackend {
191            core: Arc::new(AzfileCore {
192                info: {
193                    let am = AccessorInfo::default();
194                    am.set_scheme(Scheme::Azfile)
195                        .set_root(&root)
196                        .set_native_capability(Capability {
197                            stat: true,
198                            stat_has_cache_control: true,
199                            stat_has_content_length: true,
200                            stat_has_content_type: true,
201                            stat_has_content_encoding: true,
202                            stat_has_content_range: true,
203                            stat_has_etag: true,
204                            stat_has_content_md5: true,
205                            stat_has_last_modified: true,
206                            stat_has_content_disposition: true,
207
208                            read: true,
209
210                            write: true,
211                            create_dir: true,
212                            delete: true,
213                            rename: true,
214
215                            list: true,
216                            list_has_etag: true,
217                            list_has_last_modified: true,
218                            list_has_content_length: true,
219
220                            shared: true,
221
222                            ..Default::default()
223                        });
224
225                    // allow deprecated api here for compatibility
226                    #[allow(deprecated)]
227                    if let Some(client) = self.http_client {
228                        am.update_http_client(|_| client);
229                    }
230
231                    am.into()
232                },
233                root,
234                endpoint,
235                loader: cred_loader,
236                signer,
237                share_name: self.config.share_name.clone(),
238            }),
239        })
240    }
241}
242
243fn infer_account_name_from_endpoint(endpoint: &str) -> Option<String> {
244    let endpoint: &str = endpoint
245        .strip_prefix("http://")
246        .or_else(|| endpoint.strip_prefix("https://"))
247        .unwrap_or(endpoint);
248
249    let mut parts = endpoint.splitn(2, '.');
250    let account_name = parts.next();
251    let endpoint_suffix = parts
252        .next()
253        .unwrap_or_default()
254        .trim_end_matches('/')
255        .to_lowercase();
256
257    if endpoint_suffix == DEFAULT_AZFILE_ENDPOINT_SUFFIX {
258        account_name.map(|s| s.to_string())
259    } else {
260        None
261    }
262}
263
264/// Backend for azfile services.
265#[derive(Debug, Clone)]
266pub struct AzfileBackend {
267    core: Arc<AzfileCore>,
268}
269
270impl Access for AzfileBackend {
271    type Reader = HttpBody;
272    type Writer = AzfileWriters;
273    type Lister = oio::PageLister<AzfileLister>;
274    type Deleter = oio::OneShotDeleter<AzfileDeleter>;
275    type BlockingReader = ();
276    type BlockingWriter = ();
277    type BlockingLister = ();
278    type BlockingDeleter = ();
279
280    fn info(&self) -> Arc<AccessorInfo> {
281        self.core.info.clone()
282    }
283
284    async fn create_dir(&self, path: &str, _: OpCreateDir) -> Result<RpCreateDir> {
285        self.core.ensure_parent_dir_exists(path).await?;
286        let resp = self.core.azfile_create_dir(path).await?;
287        let status = resp.status();
288
289        match status {
290            StatusCode::CREATED => Ok(RpCreateDir::default()),
291            _ => {
292                // we cannot just check status code because 409 Conflict has two meaning:
293                // 1. If a directory by the same name is being deleted when Create Directory is called, the server returns status code 409 (Conflict)
294                // 2. If a directory or file with the same name already exists, the operation fails with status code 409 (Conflict).
295                // but we just need case 2 (already exists)
296                // ref: https://learn.microsoft.com/en-us/rest/api/storageservices/create-directory
297                if resp
298                    .headers()
299                    .get("x-ms-error-code")
300                    .map(|value| value.to_str().unwrap_or(""))
301                    .unwrap_or_else(|| "")
302                    == "ResourceAlreadyExists"
303                {
304                    Ok(RpCreateDir::default())
305                } else {
306                    Err(parse_error(resp))
307                }
308            }
309        }
310    }
311
312    async fn stat(&self, path: &str, _: OpStat) -> Result<RpStat> {
313        let resp = if path.ends_with('/') {
314            self.core.azfile_get_directory_properties(path).await?
315        } else {
316            self.core.azfile_get_file_properties(path).await?
317        };
318
319        let status = resp.status();
320        match status {
321            StatusCode::OK => {
322                let meta = parse_into_metadata(path, resp.headers())?;
323                Ok(RpStat::new(meta))
324            }
325            _ => Err(parse_error(resp)),
326        }
327    }
328
329    async fn read(&self, path: &str, args: OpRead) -> Result<(RpRead, Self::Reader)> {
330        let resp = self.core.azfile_read(path, args.range()).await?;
331
332        let status = resp.status();
333        match status {
334            StatusCode::OK | StatusCode::PARTIAL_CONTENT => Ok((RpRead::new(), resp.into_body())),
335            _ => {
336                let (part, mut body) = resp.into_parts();
337                let buf = body.to_buffer().await?;
338                Err(parse_error(Response::from_parts(part, buf)))
339            }
340        }
341    }
342
343    async fn write(&self, path: &str, args: OpWrite) -> Result<(RpWrite, Self::Writer)> {
344        self.core.ensure_parent_dir_exists(path).await?;
345        let w = AzfileWriter::new(self.core.clone(), args.clone(), path.to_string());
346        let w = if args.append() {
347            AzfileWriters::Two(oio::AppendWriter::new(w))
348        } else {
349            AzfileWriters::One(oio::OneShotWriter::new(w))
350        };
351        Ok((RpWrite::default(), w))
352    }
353
354    async fn delete(&self) -> Result<(RpDelete, Self::Deleter)> {
355        Ok((
356            RpDelete::default(),
357            oio::OneShotDeleter::new(AzfileDeleter::new(self.core.clone())),
358        ))
359    }
360
361    async fn list(&self, path: &str, args: OpList) -> Result<(RpList, Self::Lister)> {
362        let l = AzfileLister::new(self.core.clone(), path.to_string(), args.limit());
363
364        Ok((RpList::default(), oio::PageLister::new(l)))
365    }
366
367    async fn rename(&self, from: &str, to: &str, _: OpRename) -> Result<RpRename> {
368        self.core.ensure_parent_dir_exists(to).await?;
369        let resp = self.core.azfile_rename(from, to).await?;
370        let status = resp.status();
371        match status {
372            StatusCode::OK => Ok(RpRename::default()),
373            _ => Err(parse_error(resp)),
374        }
375    }
376}
377
378#[cfg(test)]
379mod tests {
380    use super::*;
381
382    #[test]
383    fn test_infer_storage_name_from_endpoint() {
384        let cases = vec![
385            (
386                "test infer account name from endpoint",
387                "https://account.file.core.windows.net",
388                "account",
389            ),
390            (
391                "test infer account name from endpoint with trailing slash",
392                "https://account.file.core.windows.net/",
393                "account",
394            ),
395        ];
396        for (desc, endpoint, expected) in cases {
397            let account_name = infer_account_name_from_endpoint(endpoint);
398            assert_eq!(account_name, Some(expected.to_string()), "{}", desc);
399        }
400    }
401}
opendal/services/azfile/backend.rs

opendal/services/azfile/
backend.rs
