2021-02-19 15:44:06 +00:00
|
|
|
use std::collections::{BTreeMap, BTreeSet, HashMap};
|
2020-04-24 18:47:11 +00:00
|
|
|
use std::sync::Arc;
|
|
|
|
|
|
2020-07-07 15:15:53 +00:00
|
|
|
use hyper::{Body, Response};
|
2020-04-24 18:47:11 +00:00
|
|
|
|
2021-02-19 15:44:06 +00:00
|
|
|
use garage_util::error::Error as GarageError;
|
2021-03-15 15:21:41 +00:00
|
|
|
use garage_util::time::*;
|
2020-04-24 18:47:11 +00:00
|
|
|
|
2020-07-07 11:59:22 +00:00
|
|
|
use garage_model::garage::Garage;
|
2020-07-08 15:33:24 +00:00
|
|
|
use garage_model::object_table::*;
|
2020-04-24 18:47:11 +00:00
|
|
|
|
2020-11-20 19:11:04 +00:00
|
|
|
use garage_table::DeletedFilter;
|
|
|
|
|
|
2020-04-28 10:18:14 +00:00
|
|
|
use crate::encoding::*;
|
2021-02-19 15:44:06 +00:00
|
|
|
use crate::error::*;
|
2021-05-03 20:45:42 +00:00
|
|
|
use crate::s3_xml;
|
2021-02-19 15:44:06 +00:00
|
|
|
|
|
|
|
|
#[derive(Debug)]
|
|
|
|
|
pub struct ListObjectsQuery {
|
|
|
|
|
pub is_v2: bool,
|
|
|
|
|
pub bucket: String,
|
|
|
|
|
pub delimiter: Option<String>,
|
|
|
|
|
pub max_keys: usize,
|
|
|
|
|
pub prefix: String,
|
|
|
|
|
pub marker: Option<String>,
|
|
|
|
|
pub continuation_token: Option<String>,
|
|
|
|
|
pub start_after: Option<String>,
|
|
|
|
|
pub urlencode_resp: bool,
|
|
|
|
|
}
|
2020-04-24 18:47:11 +00:00
|
|
|
|
|
|
|
|
#[derive(Debug)]
|
|
|
|
|
struct ListResultInfo {
|
|
|
|
|
last_modified: u64,
|
|
|
|
|
size: u64,
|
2020-12-06 14:39:03 +00:00
|
|
|
etag: String,
|
2020-04-24 18:47:11 +00:00
|
|
|
}
|
|
|
|
|
|
2021-02-19 15:44:06 +00:00
|
|
|
pub fn parse_list_objects_query(
|
|
|
|
|
bucket: &str,
|
|
|
|
|
params: &HashMap<String, String>,
|
|
|
|
|
) -> Result<ListObjectsQuery, Error> {
|
|
|
|
|
Ok(ListObjectsQuery {
|
|
|
|
|
is_v2: params.get("list-type").map(|x| x == "2").unwrap_or(false),
|
|
|
|
|
bucket: bucket.to_string(),
|
2021-03-15 13:46:37 +00:00
|
|
|
delimiter: params.get("delimiter").filter(|x| !x.is_empty()).cloned(),
|
2021-02-19 15:44:06 +00:00
|
|
|
max_keys: params
|
|
|
|
|
.get("max-keys")
|
|
|
|
|
.map(|x| {
|
|
|
|
|
x.parse::<usize>()
|
|
|
|
|
.ok_or_bad_request("Invalid value for max-keys")
|
|
|
|
|
})
|
|
|
|
|
.unwrap_or(Ok(1000))?,
|
2021-04-23 20:18:00 +00:00
|
|
|
prefix: params.get("prefix").cloned().unwrap_or_default(),
|
2021-02-19 15:44:06 +00:00
|
|
|
marker: params.get("marker").cloned(),
|
|
|
|
|
continuation_token: params.get("continuation-token").cloned(),
|
|
|
|
|
start_after: params.get("start-after").cloned(),
|
|
|
|
|
urlencode_resp: params
|
|
|
|
|
.get("encoding-type")
|
|
|
|
|
.map(|x| x == "url")
|
|
|
|
|
.unwrap_or(false),
|
|
|
|
|
})
|
|
|
|
|
}
|
|
|
|
|
|
2020-04-24 18:47:11 +00:00
|
|
|
pub async fn handle_list(
|
|
|
|
|
garage: Arc<Garage>,
|
2021-02-19 15:44:06 +00:00
|
|
|
query: &ListObjectsQuery,
|
2020-07-07 15:15:53 +00:00
|
|
|
) -> Result<Response<Body>, Error> {
|
2020-04-26 16:22:33 +00:00
|
|
|
let mut result_keys = BTreeMap::<String, ListResultInfo>::new();
|
|
|
|
|
let mut result_common_prefixes = BTreeSet::<String>::new();
|
2020-05-01 14:30:50 +00:00
|
|
|
|
2021-02-19 15:44:06 +00:00
|
|
|
let mut next_chunk_start = if query.is_v2 {
|
|
|
|
|
if let Some(ct) = &query.continuation_token {
|
|
|
|
|
String::from_utf8(base64::decode(ct.as_bytes())?)?
|
|
|
|
|
} else {
|
2021-04-23 20:18:00 +00:00
|
|
|
query
|
|
|
|
|
.start_after
|
|
|
|
|
.clone()
|
|
|
|
|
.unwrap_or_else(|| query.prefix.clone())
|
2021-02-19 15:44:06 +00:00
|
|
|
}
|
|
|
|
|
} else {
|
2021-04-23 20:18:00 +00:00
|
|
|
query.marker.clone().unwrap_or_else(|| query.prefix.clone())
|
2021-02-19 15:44:06 +00:00
|
|
|
};
|
2020-04-24 18:47:11 +00:00
|
|
|
|
2021-02-19 15:44:06 +00:00
|
|
|
debug!(
|
|
|
|
|
"List request: `{:?}` {} `{}`",
|
|
|
|
|
query.delimiter, query.max_keys, query.prefix
|
|
|
|
|
);
|
2020-04-24 18:47:11 +00:00
|
|
|
|
2020-05-01 15:52:35 +00:00
|
|
|
let truncated;
|
|
|
|
|
'query_loop: loop {
|
2020-04-24 18:47:11 +00:00
|
|
|
let objects = garage
|
|
|
|
|
.object_table
|
|
|
|
|
.get_range(
|
2021-02-19 15:44:06 +00:00
|
|
|
&query.bucket,
|
2020-04-24 18:47:11 +00:00
|
|
|
Some(next_chunk_start.clone()),
|
2020-11-20 19:11:04 +00:00
|
|
|
Some(DeletedFilter::NotDeleted),
|
2021-02-19 15:44:06 +00:00
|
|
|
query.max_keys + 1,
|
2020-04-24 18:47:11 +00:00
|
|
|
)
|
|
|
|
|
.await?;
|
2020-05-01 14:30:50 +00:00
|
|
|
debug!(
|
|
|
|
|
"List: get range {} (max {}), results: {}",
|
|
|
|
|
next_chunk_start,
|
2021-02-19 15:44:06 +00:00
|
|
|
query.max_keys + 1,
|
2020-05-01 14:30:50 +00:00
|
|
|
objects.len()
|
|
|
|
|
);
|
|
|
|
|
|
2020-04-24 18:47:11 +00:00
|
|
|
for object in objects.iter() {
|
2021-02-19 15:44:06 +00:00
|
|
|
if !object.key.starts_with(&query.prefix) {
|
2020-12-06 14:39:03 +00:00
|
|
|
truncated = None;
|
2020-05-01 15:52:35 +00:00
|
|
|
break 'query_loop;
|
2020-05-01 14:30:50 +00:00
|
|
|
}
|
2021-02-19 15:44:06 +00:00
|
|
|
|
|
|
|
|
if query.is_v2 && query.start_after.as_ref() == Some(&object.key) {
|
|
|
|
|
continue;
|
|
|
|
|
}
|
|
|
|
|
|
2020-04-26 18:55:13 +00:00
|
|
|
if let Some(version) = object.versions().iter().find(|x| x.is_data()) {
|
2021-02-19 15:44:06 +00:00
|
|
|
if result_keys.len() + result_common_prefixes.len() >= query.max_keys {
|
2020-12-06 14:39:03 +00:00
|
|
|
truncated = Some(object.key.to_string());
|
2020-05-04 13:09:23 +00:00
|
|
|
break 'query_loop;
|
|
|
|
|
}
|
2021-02-19 15:44:06 +00:00
|
|
|
let common_prefix = if let Some(delimiter) = &query.delimiter {
|
|
|
|
|
let relative_key = &object.key[query.prefix.len()..];
|
2020-11-11 15:12:42 +00:00
|
|
|
relative_key
|
|
|
|
|
.find(delimiter)
|
2021-02-19 15:44:06 +00:00
|
|
|
.map(|i| &object.key[..query.prefix.len() + i + delimiter.len()])
|
2020-04-24 20:28:15 +00:00
|
|
|
} else {
|
2020-04-26 16:22:33 +00:00
|
|
|
None
|
2020-04-24 18:47:11 +00:00
|
|
|
};
|
2020-04-26 16:22:33 +00:00
|
|
|
if let Some(pfx) = common_prefix {
|
|
|
|
|
result_common_prefixes.insert(pfx.to_string());
|
|
|
|
|
} else {
|
2020-12-06 14:39:03 +00:00
|
|
|
let meta = match &version.state {
|
|
|
|
|
ObjectVersionState::Complete(ObjectVersionData::Inline(meta, _)) => meta,
|
2020-07-08 15:34:37 +00:00
|
|
|
ObjectVersionState::Complete(ObjectVersionData::FirstBlock(meta, _)) => {
|
2020-12-06 14:39:03 +00:00
|
|
|
meta
|
2020-07-08 15:34:37 +00:00
|
|
|
}
|
|
|
|
|
_ => unreachable!(),
|
|
|
|
|
};
|
2020-04-26 16:22:33 +00:00
|
|
|
let info = match result_keys.get(&object.key) {
|
|
|
|
|
None => ListResultInfo {
|
|
|
|
|
last_modified: version.timestamp,
|
2020-12-06 14:39:03 +00:00
|
|
|
size: meta.size,
|
|
|
|
|
etag: meta.etag.to_string(),
|
2020-04-26 16:22:33 +00:00
|
|
|
},
|
2020-04-26 18:55:13 +00:00
|
|
|
Some(_lri) => {
|
2021-02-19 15:44:06 +00:00
|
|
|
return Err(Error::InternalError(GarageError::Message(format!(
|
|
|
|
|
"Duplicate key?? {}",
|
|
|
|
|
object.key
|
|
|
|
|
))))
|
2020-04-26 18:55:13 +00:00
|
|
|
}
|
2020-04-26 16:22:33 +00:00
|
|
|
};
|
|
|
|
|
result_keys.insert(object.key.clone(), info);
|
2020-04-24 18:47:11 +00:00
|
|
|
};
|
|
|
|
|
}
|
|
|
|
|
}
|
2021-02-19 15:44:06 +00:00
|
|
|
if objects.len() < query.max_keys + 1 {
|
2020-12-06 14:39:03 +00:00
|
|
|
truncated = None;
|
2020-05-04 13:09:23 +00:00
|
|
|
break 'query_loop;
|
2020-04-24 18:47:11 +00:00
|
|
|
}
|
2021-04-23 20:18:00 +00:00
|
|
|
if !objects.is_empty() {
|
2020-04-24 18:47:11 +00:00
|
|
|
next_chunk_start = objects[objects.len() - 1].key.clone();
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2021-05-03 20:45:42 +00:00
|
|
|
let mut result = s3_xml::ListBucketResult {
|
|
|
|
|
xmlns: (),
|
|
|
|
|
name: s3_xml::Value(query.bucket.to_string()),
|
|
|
|
|
prefix: uriencode_maybe(&query.prefix, query.urlencode_resp),
|
|
|
|
|
marker: None,
|
|
|
|
|
next_marker: None,
|
|
|
|
|
start_after: None,
|
|
|
|
|
continuation_token: None,
|
|
|
|
|
next_continuation_token: None,
|
|
|
|
|
max_keys: s3_xml::IntValue(query.max_keys as i64),
|
|
|
|
|
delimiter: query
|
|
|
|
|
.delimiter
|
|
|
|
|
.as_ref()
|
|
|
|
|
.map(|x| uriencode_maybe(x, query.urlencode_resp)),
|
|
|
|
|
encoding_type: match query.urlencode_resp {
|
|
|
|
|
true => Some(s3_xml::Value("url".to_string())),
|
|
|
|
|
false => None,
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
key_count: Some(s3_xml::IntValue(
|
|
|
|
|
result_keys.len() as i64 + result_common_prefixes.len() as i64,
|
|
|
|
|
)),
|
|
|
|
|
is_truncated: s3_xml::Value(format!("{}", truncated.is_some())),
|
|
|
|
|
contents: vec![],
|
|
|
|
|
common_prefixes: vec![],
|
|
|
|
|
};
|
2021-02-19 15:44:06 +00:00
|
|
|
|
|
|
|
|
if query.is_v2 {
|
|
|
|
|
if let Some(ct) = &query.continuation_token {
|
2021-05-03 20:45:42 +00:00
|
|
|
result.continuation_token = Some(s3_xml::Value(ct.to_string()));
|
2021-02-19 15:44:06 +00:00
|
|
|
}
|
|
|
|
|
if let Some(sa) = &query.start_after {
|
2021-05-03 20:45:42 +00:00
|
|
|
result.start_after = Some(uriencode_maybe(sa, query.urlencode_resp));
|
2021-02-19 15:44:06 +00:00
|
|
|
}
|
|
|
|
|
if let Some(nct) = truncated {
|
2021-05-03 20:45:42 +00:00
|
|
|
result.next_continuation_token = Some(s3_xml::Value(base64::encode(nct.as_bytes())));
|
2021-02-19 15:44:06 +00:00
|
|
|
}
|
|
|
|
|
} else {
|
|
|
|
|
// TODO: are these supposed to be urlencoded when encoding-type is URL??
|
|
|
|
|
if let Some(mkr) = &query.marker {
|
2021-05-03 20:45:42 +00:00
|
|
|
result.marker = Some(uriencode_maybe(mkr, query.urlencode_resp));
|
2021-02-19 15:44:06 +00:00
|
|
|
}
|
|
|
|
|
if let Some(next_marker) = truncated {
|
2021-05-03 20:45:42 +00:00
|
|
|
result.next_marker = Some(uriencode_maybe(&next_marker, query.urlencode_resp));
|
2021-02-19 15:44:06 +00:00
|
|
|
}
|
2020-12-06 14:39:03 +00:00
|
|
|
}
|
2021-02-19 15:44:06 +00:00
|
|
|
|
2020-04-26 16:22:33 +00:00
|
|
|
for (key, info) in result_keys.iter() {
|
2021-05-03 20:45:42 +00:00
|
|
|
result.contents.push(s3_xml::ListBucketItem {
|
|
|
|
|
key: uriencode_maybe(key, query.urlencode_resp),
|
|
|
|
|
last_modified: s3_xml::Value(msec_to_rfc3339(info.last_modified)),
|
|
|
|
|
size: s3_xml::IntValue(info.size as i64),
|
|
|
|
|
etag: s3_xml::Value(info.etag.to_string()),
|
|
|
|
|
storage_class: s3_xml::Value("STANDARD".to_string()),
|
|
|
|
|
});
|
2020-04-24 18:47:11 +00:00
|
|
|
}
|
2021-02-19 15:44:06 +00:00
|
|
|
|
|
|
|
|
for pfx in result_common_prefixes.iter() {
|
|
|
|
|
//TODO: in V1, are these urlencoded when urlencode_resp is true ?? (proably)
|
2021-05-03 20:45:42 +00:00
|
|
|
result.common_prefixes.push(s3_xml::CommonPrefix {
|
|
|
|
|
prefix: uriencode_maybe(pfx, query.urlencode_resp),
|
|
|
|
|
});
|
2020-04-26 16:22:33 +00:00
|
|
|
}
|
2021-02-19 15:44:06 +00:00
|
|
|
|
2021-05-03 20:45:42 +00:00
|
|
|
let xml = s3_xml::to_xml_with_header(&result)?;
|
2020-04-24 18:47:11 +00:00
|
|
|
|
2021-02-19 22:40:18 +00:00
|
|
|
Ok(Response::builder()
|
2021-02-23 17:46:25 +00:00
|
|
|
.header("Content-Type", "application/xml")
|
|
|
|
|
.body(Body::from(xml.into_bytes()))?)
|
2020-04-26 18:55:13 +00:00
|
|
|
}
|
2021-05-03 20:45:42 +00:00
|
|
|
|
|
|
|
|
fn uriencode_maybe(s: &str, yes: bool) -> s3_xml::Value {
|
|
|
|
|
if yes {
|
|
|
|
|
s3_xml::Value(uri_encode(s, true))
|
|
|
|
|
} else {
|
|
|
|
|
s3_xml::Value(s.to_string())
|
|
|
|
|
}
|
|
|
|
|
}
|
