// Copyright 2024 RustFS Team // // Licensed 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; use time::OffsetDateTime; use uuid::Uuid; const NULL_VERSION_MARKER: &str = "null"; #[derive(Debug, Default, Clone)] pub struct HTTPPreconditions { pub if_match: Option, pub if_none_match: Option, pub if_modified_since: Option, pub if_unmodified_since: Option, } impl HTTPPreconditions { pub fn if_match_value(&self) -> Option<&str> { non_empty_condition_value(self.if_match.as_deref()) } pub fn if_none_match_value(&self) -> Option<&str> { non_empty_condition_value(self.if_none_match.as_deref()) } } #[derive(Debug, Default, Clone)] pub struct ObjectLockRetentionOptions { pub mode: Option, pub retain_until: Option, pub bypass_governance: bool, } #[derive(Debug, Clone, Copy, PartialEq, Eq)] pub struct ObjectPreconditionPart { pub number: usize, pub exists: bool, } #[derive(Debug, Default, Clone, Copy, PartialEq, Eq)] pub struct ObjectPreconditionState<'a> { pub etag: Option<&'a str>, pub mod_time: Option, pub requested_part: Option, } impl ObjectPreconditionState<'_> { pub fn check(self, preconditions: Option<&HTTPPreconditions>) -> Result<(), ObjectPreconditionError> { if let Some(part) = self.requested_part && part.number > 1 && !part.exists { return Err(ObjectPreconditionError::InvalidPartNumber(part.number)); } let Some(preconditions) = preconditions else { return Ok(()); }; let has_valid_mod_time = self.mod_time.is_some_and(|t| t != OffsetDateTime::UNIX_EPOCH); let if_none_match = preconditions.if_none_match_value(); let if_match = preconditions.if_match_value(); if let Some(if_none_match) = if_none_match && let Some(etag) = self.etag && etag_matches(etag, if_none_match) { return Err(ObjectPreconditionError::NotModified); } if has_valid_mod_time && let Some(if_modified_since) = &preconditions.if_modified_since && let Some(mod_time) = &self.mod_time && !is_modified_since(mod_time, if_modified_since) { return Err(ObjectPreconditionError::NotModified); } if let Some(if_match) = if_match { if let Some(etag) = self.etag { if !etag_matches(etag, if_match) { return Err(ObjectPreconditionError::PreconditionFailed); } } else { return Err(ObjectPreconditionError::PreconditionFailed); } } if has_valid_mod_time && if_match.is_none() && let Some(if_unmodified_since) = &preconditions.if_unmodified_since && let Some(mod_time) = &self.mod_time && is_modified_since(mod_time, if_unmodified_since) { return Err(ObjectPreconditionError::PreconditionFailed); } Ok(()) } } #[derive(Debug, Clone, Copy, PartialEq, Eq)] pub enum ObjectPreconditionError { InvalidPartNumber(usize), NotModified, PreconditionFailed, } impl fmt::Display for ObjectPreconditionError { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { match self { Self::InvalidPartNumber(part_number) => write!(f, "invalid part number {part_number}"), Self::NotModified => f.write_str("object not modified"), Self::PreconditionFailed => f.write_str("object precondition failed"), } } } impl std::error::Error for ObjectPreconditionError {} #[derive(Debug, Clone, Copy, PartialEq, Eq)] pub enum VersionMarker { Null, Version(Uuid), } impl VersionMarker { pub fn parse(marker: impl AsRef) -> Result { let marker = marker.as_ref(); if marker == NULL_VERSION_MARKER { Ok(Self::Null) } else { Ok(Self::Version(Uuid::parse_str(marker)?)) } } } #[derive(Clone, Default, PartialEq, Eq)] pub enum WalkVersionsSortOrder { #[default] Ascending, Descending, } #[derive(Debug, Default)] pub struct ListObjectsInfo { pub is_truncated: bool, pub next_marker: Option, pub objects: Vec, pub prefixes: Vec, } #[derive(Debug, Default)] pub struct ListObjectsV2Info { pub is_truncated: bool, pub continuation_token: Option, pub next_continuation_token: Option, pub objects: Vec, pub prefixes: Vec, } #[derive(Debug, Default, Clone)] pub struct ListObjectVersionsInfo { pub is_truncated: bool, pub next_marker: Option, pub next_version_idmarker: Option, pub objects: Vec, pub prefixes: Vec, } #[derive(Debug)] pub struct ObjectInfoOrErr { pub item: Option, pub err: Option, } #[derive(Debug, Clone, PartialEq, Eq)] pub enum HTTPRangeError { InvalidRangeSpec(String), } impl fmt::Display for HTTPRangeError { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { match self { Self::InvalidRangeSpec(message) => f.write_str(message), } } } impl std::error::Error for HTTPRangeError {} #[derive(Debug, Clone)] pub struct HTTPRangeSpec { pub is_suffix_length: bool, pub start: i64, pub end: i64, } impl HTTPRangeSpec { pub fn from_part_sizes(object_size: i64, part_number: usize, part_sizes: impl IntoIterator) -> Option { if object_size == 0 || part_number == 0 { return None; } let mut start = 0_i64; let mut end = -1_i64; let mut parts = part_sizes.into_iter(); for _ in 0..part_number { let part_size = parts.next()?; start = end.checked_add(1)?; end = start.checked_add(part_size)?.checked_sub(1)?; } Some(Self { is_suffix_length: false, start, end, }) } pub fn get_offset_length(&self, res_size: i64) -> Result<(usize, i64), HTTPRangeError> { let len = self.get_length(res_size)?; let mut start = self.start; if self.is_suffix_length { let suffix_len = if self.start < 0 { self.start .checked_neg() .ok_or_else(|| HTTPRangeError::InvalidRangeSpec("range value invalid: suffix length overflow".to_string()))? } else { self.start }; start = res_size - suffix_len; if start < 0 { start = 0; } } let offset = usize::try_from(start) .map_err(|_| HTTPRangeError::InvalidRangeSpec("range value invalid: start offset overflow".to_string()))?; Ok((offset, len)) } pub fn get_length(&self, res_size: i64) -> Result { if res_size < 0 { return Err(HTTPRangeError::InvalidRangeSpec("The requested range is not satisfiable".to_string())); } if self.is_suffix_length { let specified_len = if self.start < 0 { self.start .checked_neg() .ok_or_else(|| HTTPRangeError::InvalidRangeSpec("range value invalid: suffix length overflow".to_string()))? } else { self.start }; let mut range_length = specified_len; if specified_len > res_size { range_length = res_size; } return Ok(range_length); } if self.start >= res_size { return Err(HTTPRangeError::InvalidRangeSpec("The requested range is not satisfiable".to_string())); } if self.end > -1 { let mut end = self.end; if res_size <= end { end = res_size - 1; } let range_length = end - self.start + 1; return Ok(range_length); } if self.end == -1 { let range_length = res_size - self.start; return Ok(range_length); } Err(HTTPRangeError::InvalidRangeSpec(format!( "range value invalid: start={}, end={}, expected start <= end and end >= -1", self.start, self.end ))) } } fn non_empty_condition_value(value: Option<&str>) -> Option<&str> { value.map(str::trim).filter(|value| !value.is_empty()) } fn etag_matches(object_etag: &str, condition_etag: &str) -> bool { let object_etag = object_etag.trim_matches('"'); let condition_etag = condition_etag.trim_matches('"'); condition_etag == "*" || object_etag == condition_etag } fn is_modified_since(mod_time: &OffsetDateTime, given_time: &OffsetDateTime) -> bool { mod_time.unix_timestamp() > given_time.unix_timestamp() } #[cfg(test)] mod tests { use super::*; #[test] fn http_preconditions_ignore_empty_etag_headers() { let opts = HTTPPreconditions { if_match: Some(" ".to_owned()), if_none_match: Some(" * ".to_owned()), ..Default::default() }; assert_eq!(opts.if_match_value(), None); assert_eq!(opts.if_none_match_value(), Some("*")); } #[test] fn object_lock_retention_defaults_preserve_false_bypass() { let opts = ObjectLockRetentionOptions::default(); assert!(opts.mode.is_none()); assert!(opts.retain_until.is_none()); assert!(!opts.bypass_governance); } #[test] fn object_precondition_state_rejects_missing_requested_part() { let state = ObjectPreconditionState { requested_part: Some(ObjectPreconditionPart { number: 3, exists: false, }), ..Default::default() }; assert_eq!(state.check(None), Err(ObjectPreconditionError::InvalidPartNumber(3))); } #[test] fn object_precondition_state_keeps_existing_etag_priority() { let preconditions = HTTPPreconditions { if_match: Some("\"other\"".to_owned()), if_none_match: Some("\"abc\"".to_owned()), ..Default::default() }; let state = ObjectPreconditionState { etag: Some("\"abc\""), ..Default::default() }; assert_eq!(state.check(Some(&preconditions)), Err(ObjectPreconditionError::NotModified)); } #[test] fn object_precondition_state_requires_etag_for_if_match() { let preconditions = HTTPPreconditions { if_match: Some("\"abc\"".to_owned()), ..Default::default() }; assert_eq!( ObjectPreconditionState::default().check(Some(&preconditions)), Err(ObjectPreconditionError::PreconditionFailed) ); } #[test] fn object_precondition_state_checks_modification_dates() { let mod_time = OffsetDateTime::UNIX_EPOCH + time::Duration::seconds(100); let preconditions = HTTPPreconditions { if_modified_since: Some(OffsetDateTime::UNIX_EPOCH + time::Duration::seconds(100)), ..Default::default() }; let state = ObjectPreconditionState { mod_time: Some(mod_time), ..Default::default() }; assert_eq!(state.check(Some(&preconditions)), Err(ObjectPreconditionError::NotModified)); let preconditions = HTTPPreconditions { if_unmodified_since: Some(OffsetDateTime::UNIX_EPOCH + time::Duration::seconds(99)), ..Default::default() }; assert_eq!(state.check(Some(&preconditions)), Err(ObjectPreconditionError::PreconditionFailed)); } #[test] fn version_marker_parses_null_and_uuid_markers() { assert_eq!(VersionMarker::parse("null").expect("null marker should parse"), VersionMarker::Null); let marker = "550e8400-e29b-41d4-a716-446655440000"; assert_eq!( VersionMarker::parse(marker).expect("uuid marker should parse"), VersionMarker::Version(Uuid::parse_str(marker).expect("test uuid should parse")) ); } #[test] fn walk_versions_sort_order_defaults_to_ascending() { assert!(matches!(WalkVersionsSortOrder::default(), WalkVersionsSortOrder::Ascending)); } #[test] fn object_list_response_contracts_default_to_empty_collections() { let v1 = ListObjectsInfo::<()>::default(); assert!(!v1.is_truncated); assert!(v1.next_marker.is_none()); assert!(v1.objects.is_empty()); assert!(v1.prefixes.is_empty()); let v2 = ListObjectsV2Info::<()>::default(); assert!(!v2.is_truncated); assert!(v2.continuation_token.is_none()); assert!(v2.next_continuation_token.is_none()); assert!(v2.objects.is_empty()); assert!(v2.prefixes.is_empty()); let versions = ListObjectVersionsInfo::<()>::default(); assert!(!versions.is_truncated); assert!(versions.next_marker.is_none()); assert!(versions.next_version_idmarker.is_none()); assert!(versions.objects.is_empty()); assert!(versions.prefixes.is_empty()); } #[test] fn object_info_or_err_keeps_optional_item_and_error_slots() { let item = ObjectInfoOrErr:: { item: Some(7), err: None, }; assert_eq!(item.item, Some(7)); assert!(item.err.is_none()); } #[test] fn http_range_spec_offset_length_handles_suffix_and_bounds() { let range = HTTPRangeSpec { is_suffix_length: false, start: 5, end: 10, }; assert_eq!(range.get_offset_length(20).expect("range should fit"), (5, 6)); let suffix = HTTPRangeSpec { is_suffix_length: true, start: -5, end: -1, }; assert_eq!(suffix.get_offset_length(20).expect("suffix range should fit"), (15, 5)); } #[test] fn http_range_spec_from_part_sizes_keeps_part_boundaries() { let spec = HTTPRangeSpec::from_part_sizes(100, 3, [10, 15, 20]).expect("third part should exist"); assert_eq!(spec.start, 25); assert_eq!(spec.end, 44); assert!(HTTPRangeSpec::from_part_sizes(100, 0, [10]).is_none()); assert!(HTTPRangeSpec::from_part_sizes(100, 2, [10]).is_none()); } }