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
// 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 dav_server::davpath::DavPath;
use dav_server::fs::DavMetaData;
use dav_server::fs::FsError;
use dav_server::fs::{DavDirEntry, FsFuture};
use dav_server::fs::{DavFile, FsStream};
use dav_server::fs::{DavFileSystem, ReadDirMeta};
use futures::FutureExt;
use futures::StreamExt;
use opendal::Operator;
use std::path::Path;
use super::dir::OpendalStream;
use super::file::OpendalFile;
use super::metadata::OpendalMetaData;
use super::utils::convert_error;
/// OpendalFs is a `DavFileSystem` implementation for opendal.
///
/// ```
/// use anyhow::Result;
/// use dav_server::davpath::DavPath;
/// use dav_server::fs::DavFileSystem;
/// use dav_server_opendalfs::OpendalFs;
/// use opendal::services::Memory;
/// use opendal::Operator;
///
/// #[tokio::test]
/// async fn test() -> Result<()> {
/// let op = Operator::new(Memory::default())?.finish();
///
/// let webdavfs = OpendalFs::new(op);
///
/// let metadata = webdavfs
/// .metadata(&DavPath::new("/").unwrap())
/// .await
/// .unwrap();
/// println!("{}", metadata.is_dir());
///
/// Ok(())
/// }
/// ```
#[derive(Clone)]
pub struct OpendalFs {
pub op: Operator,
}
impl OpendalFs {
/// Create a new `OpendalFs` instance.
pub fn new(op: Operator) -> Box<OpendalFs> {
Box::new(OpendalFs { op })
}
}
impl DavFileSystem for OpendalFs {
fn open<'a>(
&'a self,
path: &'a DavPath,
options: dav_server::fs::OpenOptions,
) -> FsFuture<'a, Box<dyn DavFile>> {
async move {
let file = OpendalFile::open(self.op.clone(), path.clone(), options).await?;
Ok(Box::new(file) as Box<dyn DavFile>)
}
.boxed()
}
fn read_dir<'a>(
&'a self,
path: &'a DavPath,
_meta: ReadDirMeta,
) -> FsFuture<'a, FsStream<Box<dyn DavDirEntry>>> {
async move {
let path = path.as_url_string();
self.op
.lister(path.as_str())
.await
.map(|lister| OpendalStream::new(self.op.clone(), lister, path.as_str()).boxed())
.map_err(convert_error)
}
.boxed()
}
fn metadata<'a>(&'a self, path: &'a DavPath) -> FsFuture<'a, Box<dyn DavMetaData>> {
async move {
let opendal_metadata = self.op.stat(path.as_url_string().as_str()).await;
match opendal_metadata {
Ok(metadata) => {
let webdav_metadata = OpendalMetaData::new(metadata);
Ok(Box::new(webdav_metadata) as Box<dyn DavMetaData>)
}
Err(e) => Err(convert_error(e)),
}
}
.boxed()
}
fn create_dir<'a>(&'a self, path: &'a DavPath) -> FsFuture<'a, ()> {
async move {
let path = path.as_url_string();
// check if the parent path is exist.
// During MKCOL processing, a server MUST make the Request-URI a member of its parent collection, unless the Request-URI is "/". If no such ancestor exists, the method MUST fail.
// refer to https://datatracker.ietf.org/doc/html/rfc2518#section-8.3.1
let parent = Path::new(&path).parent().unwrap();
match self.op.exists(parent.to_str().unwrap()).await {
Ok(exist) => {
if !exist && parent != Path::new("/") {
return Err(FsError::NotFound);
}
}
Err(e) => {
return Err(convert_error(e));
}
}
let path = path.as_str();
// check if the given path is exist (MKCOL on existing collection should fail (RFC2518:8.3.1))
let exist = self.op.exists(path).await;
match exist {
Ok(exist) => match exist {
true => Err(FsError::Exists),
false => {
let res = self.op.create_dir(path).await;
match res {
Ok(_) => Ok(()),
Err(e) => Err(convert_error(e)),
}
}
},
Err(e) => Err(convert_error(e)),
}
}
.boxed()
}
fn remove_dir<'a>(&'a self, path: &'a DavPath) -> FsFuture<'a, ()> {
self.remove_file(path)
}
fn remove_file<'a>(&'a self, path: &'a DavPath) -> FsFuture<'a, ()> {
async move {
self.op
.delete(path.as_url_string().as_str())
.await
.map_err(convert_error)
}
.boxed()
}
fn rename<'a>(&'a self, from: &'a DavPath, to: &'a DavPath) -> FsFuture<'a, ()> {
async move {
let from_path = from
.as_rel_ospath()
.to_str()
.ok_or(FsError::GeneralFailure)?;
let to_path = to.as_rel_ospath().to_str().ok_or(FsError::GeneralFailure)?;
if from.is_collection() {
let _ = self.remove_file(to).await;
}
self.op
.rename(from_path, to_path)
.await
.map_err(convert_error)
}
.boxed()
}
fn copy<'a>(&'a self, from: &'a DavPath, to: &'a DavPath) -> FsFuture<'a, ()> {
async move {
let from_path = from
.as_rel_ospath()
.to_str()
.ok_or(FsError::GeneralFailure)?;
let to_path = to.as_rel_ospath().to_str().ok_or(FsError::GeneralFailure)?;
self.op
.copy(from_path, to_path)
.await
.map_err(convert_error)
}
.boxed()
}
}