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 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228
// 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::collections::HashMap;
use std::fmt::Debug;
use std::fmt::Formatter;
use std::sync::Arc;
use chrono::DateTime;
use chrono::Utc;
use log::debug;
use serde::Deserialize;
use tokio::sync::Mutex;
use super::backend::GdriveBackend;
use crate::raw::normalize_root;
use crate::raw::ConfigDeserializer;
use crate::raw::HttpClient;
use crate::raw::PathCacher;
use crate::services::gdrive::core::GdriveCore;
use crate::services::gdrive::core::GdrivePathQuery;
use crate::services::gdrive::core::GdriveSigner;
use crate::Scheme;
use crate::*;
/// [GoogleDrive](https://drive.google.com/) configuration.
#[derive(Default, Deserialize)]
#[serde(default)]
#[non_exhaustive]
pub struct GdriveConfig {
/// The root for gdrive
pub root: Option<String>,
/// Access token for gdrive.
pub access_token: Option<String>,
/// Refresh token for gdrive.
pub refresh_token: Option<String>,
/// Client id for gdrive.
pub client_id: Option<String>,
/// Client secret for gdrive.
pub client_secret: Option<String>,
}
impl Debug for GdriveConfig {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
f.debug_struct("GdriveConfig")
.field("root", &self.root)
.finish_non_exhaustive()
}
}
/// [GoogleDrive](https://drive.google.com/) backend support.
#[derive(Default)]
#[doc = include_str!("docs.md")]
pub struct GdriveBuilder {
config: GdriveConfig,
http_client: Option<HttpClient>,
}
impl Debug for GdriveBuilder {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
f.debug_struct("Backend")
.field("config", &self.config)
.finish()
}
}
impl GdriveBuilder {
/// Set root path of GoogleDrive folder.
pub fn root(&mut self, root: &str) -> &mut Self {
self.config.root = Some(root.to_string());
self
}
/// Access token is used for temporary access to the GoogleDrive API.
///
/// You can get the access token from [GoogleDrive App Console](https://console.cloud.google.com/apis/credentials)
/// or [GoogleDrive OAuth2 Playground](https://developers.google.com/oauthplayground/)
///
/// # Note
///
/// - An access token is valid for 1 hour.
/// - If you want to use the access token for a long time,
/// you can use the refresh token to get a new access token.
pub fn access_token(&mut self, access_token: &str) -> &mut Self {
self.config.access_token = Some(access_token.to_string());
self
}
/// Refresh token is used for long term access to the GoogleDrive API.
///
/// You can get the refresh token via OAuth 2.0 Flow of GoogleDrive API.
///
/// 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) -> &mut Self {
self.config.refresh_token = Some(refresh_token.to_string());
self
}
/// Set the client id for GoogleDrive.
///
/// This is required for OAuth 2.0 Flow to refresh the access token.
pub fn client_id(&mut self, client_id: &str) -> &mut Self {
self.config.client_id = Some(client_id.to_string());
self
}
/// Set the client secret for GoogleDrive.
///
/// This is required for OAuth 2.0 Flow with refresh the access token.
pub fn client_secret(&mut self, client_secret: &str) -> &mut 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) -> &mut Self {
self.http_client = Some(http_client);
self
}
}
impl Builder for GdriveBuilder {
const SCHEME: Scheme = Scheme::Gdrive;
type Accessor = GdriveBackend;
fn from_map(map: HashMap<String, String>) -> Self {
let config = GdriveConfig::deserialize(ConfigDeserializer::new(map))
.expect("config deserialize must succeed");
Self {
config,
http_client: None,
}
}
fn build(&mut self) -> Result<Self::Accessor> {
let root = normalize_root(&self.config.root.take().unwrap_or_default());
debug!("backend use root {}", root);
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::Gdrive)
})?
};
let mut signer = GdriveSigner::new(client.clone());
match (
self.config.access_token.take(),
self.config.refresh_token.take(),
) {
(Some(access_token), None) => {
signer.access_token = access_token;
// We will never expire user specified access token.
signer.expires_in = DateTime::<Utc>::MAX_UTC;
}
(None, Some(refresh_token)) => {
let client_id = self.config.client_id.take().ok_or_else(|| {
Error::new(
ErrorKind::ConfigInvalid,
"client_id must be set when refresh_token is set",
)
.with_context("service", Scheme::Gdrive)
})?;
let client_secret = self.config.client_secret.take().ok_or_else(|| {
Error::new(
ErrorKind::ConfigInvalid,
"client_secret must be set when refresh_token is set",
)
.with_context("service", Scheme::Gdrive)
})?;
signer.refresh_token = refresh_token;
signer.client = client.clone();
signer.client_id = client_id;
signer.client_secret = client_secret;
}
(Some(_), Some(_)) => {
return Err(Error::new(
ErrorKind::ConfigInvalid,
"access_token and refresh_token cannot be set at the same time",
)
.with_context("service", Scheme::Gdrive))
}
(None, None) => {
return Err(Error::new(
ErrorKind::ConfigInvalid,
"access_token or refresh_token must be set",
)
.with_context("service", Scheme::Gdrive))
}
};
let signer = Arc::new(Mutex::new(signer));
Ok(GdriveBackend {
core: Arc::new(GdriveCore {
root,
signer: signer.clone(),
client: client.clone(),
path_cache: PathCacher::new(GdrivePathQuery::new(client, signer)).with_lock(),
}),
})
}
}