1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
// 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 std::fmt::Debug;
use std::fmt::Formatter;
use std::sync::Arc;
use chrono::DateTime;
use chrono::Utc;
use tokio::sync::Mutex;
use super::backend::DropboxBackend;
use super::core::DropboxCore;
use super::core::DropboxSigner;
use crate::raw::*;
use crate::services::DropboxConfig;
use crate::*;
impl Configurator for DropboxConfig {
type Builder = DropboxBuilder;
fn into_builder(self) -> Self::Builder {
DropboxBuilder {
config: self,
http_client: None,
}
}
}
/// [Dropbox](https://www.dropbox.com/) backend support.
#[doc = include_str!("docs.md")]
#[derive(Default)]
pub struct DropboxBuilder {
config: DropboxConfig,
http_client: Option<HttpClient>,
}
impl Debug for DropboxBuilder {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
f.debug_struct("Builder")
.field("root", &self.config.root)
.finish()
}
}
impl DropboxBuilder {
/// Set the root directory for dropbox.
///
/// Default to `/` if not set.
pub fn root(mut self, root: &str) -> Self {
self.config.root = if root.is_empty() {
None
} else {
Some(root.to_string())
};
self
}
/// Access token is used for temporary access to the Dropbox API.
///
/// You can get the access token from [Dropbox App Console](https://www.dropbox.com/developers/apps)
///
/// NOTE: this token will be expired in 4 hours.
/// If you are trying to use the Dropbox service in a long time, please set a refresh_token instead.
pub fn access_token(mut self, access_token: &str) -> Self {
self.config.access_token = Some(access_token.to_string());
self
}
/// Refresh token is used for long term access to the Dropbox API.
///
/// You can get the refresh token via OAuth 2.0 Flow of Dropbox.
///
/// OpenDAL will use this refresh token to get a new access token when the old one is expired.
pub fn refresh_token(mut self, refresh_token: &str) -> Self {
self.config.refresh_token = Some(refresh_token.to_string());
self
}
/// Set the client id for Dropbox.
///
/// This is required for OAuth 2.0 Flow to refresh the access token.
pub fn client_id(mut self, client_id: &str) -> Self {
self.config.client_id = Some(client_id.to_string());
self
}
/// Set the client secret for Dropbox.
///
/// This is required for OAuth 2.0 Flow with refresh the access token.
pub fn client_secret(mut self, client_secret: &str) -> Self {
self.config.client_secret = Some(client_secret.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, http_client: HttpClient) -> Self {
self.http_client = Some(http_client);
self
}
}
impl Builder for DropboxBuilder {
const SCHEME: Scheme = Scheme::Dropbox;
type Config = DropboxConfig;
fn build(self) -> Result<impl Access> {
let root = normalize_root(&self.config.root.unwrap_or_default());
let client = if let Some(client) = self.http_client {
client
} else {
HttpClient::new().map_err(|err| {
err.with_operation("Builder::build")
.with_context("service", Scheme::Dropbox)
})?
};
let signer = match (self.config.access_token, self.config.refresh_token) {
(Some(access_token), None) => DropboxSigner {
access_token,
// We will never expire user specified token.
expires_in: DateTime::<Utc>::MAX_UTC,
..Default::default()
},
(None, Some(refresh_token)) => {
let client_id = self.config.client_id.ok_or_else(|| {
Error::new(
ErrorKind::ConfigInvalid,
"client_id must be set when refresh_token is set",
)
.with_context("service", Scheme::Dropbox)
})?;
let client_secret = self.config.client_secret.ok_or_else(|| {
Error::new(
ErrorKind::ConfigInvalid,
"client_secret must be set when refresh_token is set",
)
.with_context("service", Scheme::Dropbox)
})?;
DropboxSigner {
refresh_token,
client_id,
client_secret,
..Default::default()
}
}
(Some(_), Some(_)) => {
return Err(Error::new(
ErrorKind::ConfigInvalid,
"access_token and refresh_token can not be set at the same time",
)
.with_context("service", Scheme::Dropbox))
}
(None, None) => {
return Err(Error::new(
ErrorKind::ConfigInvalid,
"access_token or refresh_token must be set",
)
.with_context("service", Scheme::Dropbox))
}
};
Ok(DropboxBackend {
core: Arc::new(DropboxCore {
root,
signer: Arc::new(Mutex::new(signer)),
client,
}),
})
}
}