opendal/services/onedrive/
config.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;
19
20use serde::Deserialize;
21use serde::Serialize;
22
23use super::builder::OnedriveBuilder;
24
25/// Config for [OneDrive](https://onedrive.com) backend support.
26#[derive(Default, Serialize, Deserialize, Clone, PartialEq, Eq)]
27#[serde(default)]
28#[non_exhaustive]
29pub struct OnedriveConfig {
30    /// The root path for the OneDrive service for the file access
31    pub root: Option<String>,
32    /// Microsoft Graph API (also OneDrive API) access token
33    pub access_token: Option<String>,
34    ///  Microsoft Graph API (also OneDrive API) refresh token
35    pub refresh_token: Option<String>,
36    /// Microsoft Graph API Application (client) ID that is in the Azure's app registration portal
37    pub client_id: Option<String>,
38    /// Microsoft Graph API Application client secret that is in the Azure's app registration portal
39    pub client_secret: Option<String>,
40    /// Enabling version support
41    pub enable_versioning: bool,
42}
43
44impl Debug for OnedriveConfig {
45    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
46        f.debug_struct("OnedriveConfig")
47            .field("root", &self.root)
48            .field("enable_versioning", &self.enable_versioning)
49            .finish_non_exhaustive()
50    }
51}
52
53impl crate::Configurator for OnedriveConfig {
54    type Builder = OnedriveBuilder;
55
56    fn from_uri(uri: &crate::types::OperatorUri) -> crate::Result<Self> {
57        let mut map = uri.options().clone();
58
59        if let Some(root) = uri.root() {
60            if !root.is_empty() {
61                let normalized = match root.split_once('/') {
62                    Some((_, rest)) if !rest.is_empty() => rest.to_string(),
63                    _ => root.to_string(),
64                };
65                if !normalized.is_empty() {
66                    map.insert("root".to_string(), normalized);
67                }
68            }
69        }
70
71        Self::from_iter(map)
72    }
73
74    #[allow(deprecated)]
75    fn into_builder(self) -> Self::Builder {
76        OnedriveBuilder {
77            config: self,
78            http_client: None,
79        }
80    }
81}
82
83#[cfg(test)]
84mod tests {
85    use super::*;
86    use crate::Configurator;
87    use crate::types::OperatorUri;
88
89    #[test]
90    fn from_uri_sets_root() {
91        let uri = OperatorUri::new(
92            "onedrive://drive/root/documents",
93            Vec::<(String, String)>::new(),
94        )
95        .unwrap();
96
97        let cfg = OnedriveConfig::from_uri(&uri).unwrap();
98        assert_eq!(cfg.root.as_deref(), Some("documents"));
99    }
100}
opendal/services/onedrive/config.rs

opendal/services/onedrive/
config.rs
