api2/admin/datastore/pxar_file_download: download directory as zip

by using the new ZipEncoder and recursively add files to it
the zip only contains directories, normal files and hardlinks (by simply
copying the content), no symlinks, etc.

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
This commit is contained in:
Dominik Csapak 2020-10-21 09:29:08 +02:00 committed by Wolfgang Bumiller
parent 943479f5f6
commit 804f61432d
2 changed files with 125 additions and 16 deletions

View File

@ -2,6 +2,8 @@ use std::collections::{HashSet, HashMap};
use std::ffi::OsStr; use std::ffi::OsStr;
use std::os::unix::ffi::OsStrExt; use std::os::unix::ffi::OsStrExt;
use std::sync::{Arc, Mutex}; use std::sync::{Arc, Mutex};
use std::path::PathBuf;
use std::pin::Pin;
use anyhow::{bail, format_err, Error}; use anyhow::{bail, format_err, Error};
use futures::*; use futures::*;
@ -18,7 +20,7 @@ use proxmox::api::schema::*;
use proxmox::tools::fs::{replace_file, CreateOptions}; use proxmox::tools::fs::{replace_file, CreateOptions};
use proxmox::{http_err, identity, list_subdirs_api_method, sortable}; use proxmox::{http_err, identity, list_subdirs_api_method, sortable};
use pxar::accessor::aio::Accessor; use pxar::accessor::aio::{Accessor, FileContents, FileEntry};
use pxar::EntryKind; use pxar::EntryKind;
use crate::api2::types::*; use crate::api2::types::*;
@ -28,7 +30,12 @@ use crate::config::datastore;
use crate::config::cached_user_info::CachedUserInfo; use crate::config::cached_user_info::CachedUserInfo;
use crate::server::WorkerTask; use crate::server::WorkerTask;
use crate::tools::{self, AsyncReaderStream, WrappedReaderStream}; use crate::tools::{
self,
zip::{ZipEncoder, ZipEntry},
AsyncChannelWriter, AsyncReaderStream, WrappedReaderStream,
};
use crate::config::acl::{ use crate::config::acl::{
PRIV_DATASTORE_AUDIT, PRIV_DATASTORE_AUDIT,
PRIV_DATASTORE_MODIFY, PRIV_DATASTORE_MODIFY,
@ -1241,6 +1248,69 @@ fn catalog(
Ok(res.into()) Ok(res.into())
} }
fn recurse_files<T, W>(
mut zip: ZipEncoder<W>,
mut decoder: Accessor<T>,
prefix: PathBuf,
file: FileEntry<T>,
) -> Pin<Box<dyn Future<Output = Result<(ZipEncoder<W>, Accessor<T>), Error>> + Send + 'static>>
where
T: Clone + pxar::accessor::ReadAt + Unpin + Send + Sync + 'static,
W: tokio::io::AsyncWrite + Unpin + Send + 'static,
{
Box::pin(async move {
let metadata = file.entry().metadata();
let path = file.entry().path().strip_prefix(&prefix)?.to_path_buf();
match file.kind() {
EntryKind::File { .. } => {
let entry = ZipEntry::new(
path,
metadata.stat.mtime.secs,
metadata.stat.mode as u16,
true,
);
zip.add_entry(entry, Some(file.contents().await?))
.await
.map_err(|err| format_err!("could not send file entry: {}", err))?;
}
EntryKind::Hardlink(_) => {
let realfile = decoder.follow_hardlink(&file).await?;
let entry = ZipEntry::new(
path,
metadata.stat.mtime.secs,
metadata.stat.mode as u16,
true,
);
zip.add_entry(entry, Some(realfile.contents().await?))
.await
.map_err(|err| format_err!("could not send file entry: {}", err))?;
}
EntryKind::Directory => {
let dir = file.enter_directory().await?;
let mut readdir = dir.read_dir();
let entry = ZipEntry::new(
path,
metadata.stat.mtime.secs,
metadata.stat.mode as u16,
false,
);
zip.add_entry::<FileContents<T>>(entry, None).await?;
while let Some(entry) = readdir.next().await {
let entry = entry?.decode_entry().await?;
let (zip_tmp, decoder_tmp) =
recurse_files(zip, decoder, prefix.clone(), entry).await?;
zip = zip_tmp;
decoder = decoder_tmp;
}
}
_ => {} // ignore all else
};
Ok((zip, decoder))
})
}
#[sortable] #[sortable]
pub const API_METHOD_PXAR_FILE_DOWNLOAD: ApiMethod = ApiMethod::new( pub const API_METHOD_PXAR_FILE_DOWNLOAD: ApiMethod = ApiMethod::new(
&ApiHandler::AsyncHttp(&pxar_file_download), &ApiHandler::AsyncHttp(&pxar_file_download),
@ -1323,23 +1393,54 @@ fn pxar_file_download(
.lookup(OsStr::from_bytes(file_path)).await? .lookup(OsStr::from_bytes(file_path)).await?
.ok_or(format_err!("error opening '{:?}'", file_path))?; .ok_or(format_err!("error opening '{:?}'", file_path))?;
let file = match file.kind() { let body = match file.kind() {
EntryKind::File { .. } => file, EntryKind::File { .. } => Body::wrap_stream(
EntryKind::Hardlink(_) => { AsyncReaderStream::new(file.contents().await?).map_err(move |err| {
decoder.follow_hardlink(&file).await? eprintln!("error during streaming of file '{:?}' - {}", filepath, err);
}, err
// TODO symlink }),
),
EntryKind::Hardlink(_) => Body::wrap_stream(
AsyncReaderStream::new(decoder.follow_hardlink(&file).await?.contents().await?)
.map_err(move |err| {
eprintln!(
"error during streaming of hardlink '{:?}' - {}",
filepath, err
);
err
}),
),
EntryKind::Directory => {
let (sender, receiver) = tokio::sync::mpsc::channel(100);
let mut prefix = PathBuf::new();
let mut components = file.entry().path().components();
components.next_back(); // discar last
for comp in components {
prefix.push(comp);
}
let channelwriter = AsyncChannelWriter::new(sender, 1024 * 1024);
let zipencoder = ZipEncoder::new(channelwriter);
crate::server::spawn_internal_task(async move {
let (mut zipencoder, _) = recurse_files(zipencoder, decoder, prefix, file)
.await
.map_err(|err| eprintln!("error during creating of zip: {}", err))?;
zipencoder
.finish()
.await
.map_err(|err| eprintln!("error during finishing of zip: {}", err))
});
Body::wrap_stream(receiver.map_err(move |err| {
eprintln!("error during streaming of zip '{:?}' - {}", filepath, err);
err
}))
}
other => bail!("cannot download file of type {:?}", other), other => bail!("cannot download file of type {:?}", other),
}; };
let body = Body::wrap_stream(
AsyncReaderStream::new(file.contents().await?)
.map_err(move |err| {
eprintln!("error during streaming of '{:?}' - {}", filepath, err);
err
})
);
// fixme: set other headers ? // fixme: set other headers ?
Ok(Response::builder() Ok(Response::builder()
.status(StatusCode::OK) .status(StatusCode::OK)

View File

@ -87,6 +87,9 @@ Ext.define("PBS.window.FileBrowser", {
}; };
params.filepath = data.filepath; params.filepath = data.filepath;
atag.download = data.text; atag.download = data.text;
if (data.type === 'd') {
atag.download += ".zip";
}
atag.href = me atag.href = me
.buildUrl(`/api2/json/admin/datastore/${view.datastore}/pxar-file-download`, params); .buildUrl(`/api2/json/admin/datastore/${view.datastore}/pxar-file-download`, params);
atag.click(); atag.click();
@ -106,6 +109,11 @@ Ext.define("PBS.window.FileBrowser", {
case 'f': case 'f':
canDownload = true; canDownload = true;
break; break;
case 'd':
if (data.depth > 1) {
canDownload = true;
}
break;
default: break; default: break;
} }