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 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488
use crate::{Error, Fields, Filter, Result, Search, Sortby};
use chrono::{DateTime, FixedOffset};
use serde::{Deserialize, Serialize};
use serde_json::{Map, Value};
use stac::{Bbox, Item};
use std::collections::HashMap;
/// Parameters for the items endpoint from STAC API - Features.
#[derive(Clone, Default, Debug, Serialize, Deserialize)]
pub struct Items {
/// The maximum number of results to return (page size).
#[serde(skip_serializing_if = "Option::is_none")]
pub limit: Option<u64>,
/// Requested bounding box.
#[serde(skip_serializing_if = "Option::is_none")]
pub bbox: Option<Bbox>,
/// Single date+time, or a range ('/' separator), formatted to [RFC 3339,
/// section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6).
///
/// Use double dots `..` for open date ranges.
#[serde(skip_serializing_if = "Option::is_none")]
pub datetime: Option<String>,
/// Include/exclude fields from item collections.
#[serde(skip_serializing_if = "Option::is_none")]
pub fields: Option<Fields>,
/// Fields by which to sort results.
#[serde(skip_serializing_if = "Option::is_none")]
pub sortby: Option<Vec<Sortby>>,
/// Recommended to not be passed, but server must only accept
/// <http://www.opengis.net/def/crs/OGC/1.3/CRS84> as a valid value, may
/// reject any others
#[serde(skip_serializing_if = "Option::is_none", rename = "filter-crs")]
pub filter_crs: Option<String>,
/// CQL2 filter expression.
#[serde(skip_serializing_if = "Option::is_none")]
pub filter: Option<Filter>,
/// Additional filtering based on properties.
///
/// It is recommended to use the filter extension instead.
#[serde(skip_serializing_if = "Option::is_none")]
pub query: Option<Map<String, Value>>,
/// Additional fields.
#[serde(flatten)]
pub additional_fields: Map<String, Value>,
}
/// GET parameters for the items endpoint from STAC API - Features.
///
/// This is a lot like [Search](crate::Search), but without intersects, ids, and
/// collections.
#[derive(Clone, Default, Debug, Serialize, Deserialize)]
pub struct GetItems {
/// The maximum number of results to return (page size).
#[serde(skip_serializing_if = "Option::is_none")]
pub limit: Option<String>,
/// Requested bounding box.
#[serde(skip_serializing_if = "Option::is_none")]
pub bbox: Option<String>,
/// Single date+time, or a range ('/' separator), formatted to [RFC 3339,
/// section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6).
///
/// Use double dots `..` for open date ranges.
#[serde(skip_serializing_if = "Option::is_none")]
pub datetime: Option<String>,
/// Include/exclude fields from item collections.
#[serde(skip_serializing_if = "Option::is_none")]
pub fields: Option<String>,
/// Fields by which to sort results.
#[serde(skip_serializing_if = "Option::is_none")]
pub sortby: Option<String>,
/// Recommended to not be passed, but server must only accept
/// <http://www.opengis.net/def/crs/OGC/1.3/CRS84> as a valid value, may
/// reject any others
#[serde(skip_serializing_if = "Option::is_none", rename = "filter-crs")]
pub filter_crs: Option<String>,
/// CQL2 filter expression.
#[serde(skip_serializing_if = "Option::is_none")]
pub filter_lang: Option<String>,
/// CQL2 filter expression.
#[serde(skip_serializing_if = "Option::is_none")]
pub filter: Option<String>,
/// Additional fields.
#[serde(flatten)]
pub additional_fields: HashMap<String, String>,
}
impl Items {
/// Runs a set of validity checks on this query and returns an error if it is invalid.
///
/// Returns the items, unchanged, if it is valid.
///
/// # Examples
///
/// ```
/// use stac_api::Items;
///
/// let items = Items::default().valid().unwrap();
/// ```
pub fn valid(self) -> Result<Items> {
if let Some(bbox) = self.bbox.as_ref() {
if !bbox.is_valid() {
return Err(Error::from(stac::Error::InvalidBbox((*bbox).into())));
}
}
if let Some(datetime) = self.datetime.as_deref() {
if let Some((start, end)) = datetime.split_once('/') {
let (start, end) = (
maybe_parse_from_rfc3339(start)?,
maybe_parse_from_rfc3339(end)?,
);
if let Some(start) = start {
if let Some(end) = end {
if end < start {
return Err(Error::StartIsAfterEnd(start, end));
}
}
} else if end.is_none() {
return Err(Error::EmptyDatetimeInterval);
}
} else {
let _ = maybe_parse_from_rfc3339(datetime)?;
}
}
Ok(self)
}
/// Returns true if this items structure matches the given item.
///
/// # Examples
///
/// ```
/// use stac_api::Items;
/// use stac::Item;
///
/// assert!(Items::default().matches(&Item::new("an-id")).unwrap());
/// ```
pub fn matches(&self, item: &Item) -> Result<bool> {
Ok(self.bbox_matches(item)?
& self.datetime_matches(item)?
& self.query_matches(item)?
& self.filter_matches(item)?)
}
/// Returns true if this item's geometry matches this search's bbox.
///
/// If **stac-api** is not built with the `geo` feature, this will return an error.
///
/// # Examples
///
/// ```
/// # #[cfg(feature = "geo")]
/// # {
/// use stac_api::Search;
/// use stac::Item;
/// use geojson::{Geometry, Value};
///
/// let mut search = Search::new();
/// let mut item = Item::new("item-id");
/// assert!(search.bbox_matches(&item).unwrap());
/// search.bbox = Some(vec![-110.0, 40.0, -100.0, 50.0].try_into().unwrap());
/// assert!(!search.bbox_matches(&item).unwrap());
/// item.set_geometry(Geometry::new(Value::Point(vec![-105.1, 41.1])));
/// assert!(search.bbox_matches(&item).unwrap());
/// # }
/// ```
#[allow(unused_variables)]
pub fn bbox_matches(&self, item: &Item) -> Result<bool> {
if let Some(bbox) = self.bbox.as_ref() {
#[cfg(feature = "geo")]
{
let bbox: geo::Rect = (*bbox).into();
item.intersects(&bbox).map_err(Error::from)
}
#[cfg(not(feature = "geo"))]
{
Err(Error::FeatureNotEnabled("geo"))
}
} else {
Ok(true)
}
}
/// Returns true if this item's datetime matches this items structure.
///
/// # Examples
///
/// ```
/// use stac_api::Search;
/// use stac::Item;
///
/// let mut search = Search::new();
/// let mut item = Item::new("item-id"); // default datetime is now
/// assert!(search.datetime_matches(&item).unwrap());
/// search.datetime = Some("../2023-10-09T00:00:00Z".to_string());
/// assert!(!search.datetime_matches(&item).unwrap());
/// item.properties.datetime = Some("2023-10-08T00:00:00Z".parse().unwrap());
/// assert!(search.datetime_matches(&item).unwrap());
/// ```
pub fn datetime_matches(&self, item: &Item) -> Result<bool> {
if let Some(datetime) = self.datetime.as_ref() {
item.intersects_datetime_str(datetime).map_err(Error::from)
} else {
Ok(true)
}
}
/// Returns true if this item's matches this search query.
///
/// Currently unsupported, always raises an error if query is set.
///
/// # Examples
///
/// ```
/// use stac_api::Search;
/// use stac::Item;
///
/// let mut search = Search::new();
/// let mut item = Item::new("item-id");
/// assert!(search.query_matches(&item).unwrap());
/// search.query = Some(Default::default());
/// assert!(search.query_matches(&item).is_err());
/// ```
pub fn query_matches(&self, _: &Item) -> Result<bool> {
if self.query.as_ref().is_some() {
// TODO implement
Err(Error::Unimplemented("query"))
} else {
Ok(true)
}
}
/// Returns true if this item matches this search's filter.
///
/// Currently unsupported, always raises an error if filter is set.
///
/// # Examples
///
/// ```
/// use stac_api::Search;
/// use stac::Item;
///
/// let mut search = Search::new();
/// let mut item = Item::new("item-id");
/// assert!(search.filter_matches(&item).unwrap());
/// search.filter = Some(Default::default());
/// assert!(search.filter_matches(&item).is_err());
/// ```
pub fn filter_matches(&self, _: &Item) -> Result<bool> {
if self.filter.as_ref().is_some() {
// TODO implement
Err(Error::Unimplemented("filter"))
} else {
Ok(true)
}
}
/// Converts this items object to a search in the given collection.
///
/// # Examples
///
/// ```
/// use stac_api::Items;
/// let items = Items {
/// datetime: Some("2023".to_string()),
/// ..Default::default()
/// };
/// let search = items.search_collection("collection-id");
/// assert_eq!(search.collections.unwrap(), vec!["collection-id"]);
/// ```
pub fn search_collection(self, collection_id: impl ToString) -> Search {
Search {
items: self,
intersects: None,
ids: None,
collections: Some(vec![collection_id.to_string()]),
}
}
}
impl TryFrom<Items> for GetItems {
type Error = Error;
fn try_from(items: Items) -> Result<GetItems> {
if let Some(query) = items.query {
return Err(Error::CannotConvertQueryToString(query));
}
let filter = if let Some(filter) = items.filter {
match filter {
Filter::Cql2Json(json) => return Err(Error::CannotConvertCql2JsonToString(json)),
Filter::Cql2Text(text) => Some(text),
}
} else {
None
};
Ok(GetItems {
limit: items.limit.map(|n| n.to_string()),
bbox: items.bbox.map(|bbox| {
Vec::from(bbox)
.into_iter()
.map(|n| n.to_string())
.collect::<Vec<_>>()
.join(",")
}),
datetime: items.datetime,
fields: items.fields.map(|fields| fields.to_string()),
sortby: items.sortby.map(|sortby| {
sortby
.into_iter()
.map(|s| s.to_string())
.collect::<Vec<_>>()
.join(",")
}),
filter_crs: items.filter_crs,
filter_lang: filter.as_ref().map(|_| "cql2-text".to_string()),
filter,
additional_fields: items
.additional_fields
.into_iter()
.map(|(key, value)| (key, value.to_string()))
.collect(),
})
}
}
impl TryFrom<GetItems> for Items {
type Error = Error;
fn try_from(get_items: GetItems) -> Result<Items> {
let bbox = if let Some(value) = get_items.bbox {
let mut bbox = Vec::new();
for s in value.split(',') {
bbox.push(s.parse()?)
}
Some(bbox.try_into()?)
} else {
None
};
let sortby = if let Some(value) = get_items.sortby {
let mut sortby = Vec::new();
for s in value.split(',') {
sortby.push(s.parse().expect("infallible"));
}
Some(sortby)
} else {
None
};
Ok(Items {
limit: get_items.limit.map(|limit| limit.parse()).transpose()?,
bbox,
datetime: get_items.datetime,
fields: get_items
.fields
.map(|fields| fields.parse().expect("infallible")),
sortby,
filter_crs: get_items.filter_crs,
filter: get_items.filter.map(Filter::Cql2Text),
query: None,
additional_fields: get_items
.additional_fields
.into_iter()
.map(|(key, value)| (key, Value::String(value)))
.collect(),
})
}
}
impl stac::Fields for Items {
fn fields(&self) -> &Map<String, Value> {
&self.additional_fields
}
fn fields_mut(&mut self) -> &mut Map<String, Value> {
&mut self.additional_fields
}
}
fn maybe_parse_from_rfc3339(s: &str) -> Result<Option<DateTime<FixedOffset>>> {
if s.is_empty() || s == ".." {
Ok(None)
} else {
DateTime::parse_from_rfc3339(s)
.map(Some)
.map_err(Error::from)
}
}
#[cfg(test)]
mod tests {
use super::{GetItems, Items};
use crate::{sort::Direction, Fields, Filter, Sortby};
use serde_json::{Map, Value};
use std::collections::HashMap;
#[test]
fn get_items_try_from_items() {
let mut additional_fields = HashMap::new();
let _ = additional_fields.insert("token".to_string(), "foobar".to_string());
let get_items = GetItems {
limit: Some("42".to_string()),
bbox: Some("-1,-2,1,2".to_string()),
datetime: Some("2023".to_string()),
fields: Some("+foo,-bar".to_string()),
sortby: Some("-foo".to_string()),
filter_crs: None,
filter_lang: Some("cql2-text".to_string()),
filter: Some("dummy text".to_string()),
additional_fields,
};
let items: Items = get_items.try_into().unwrap();
assert_eq!(items.limit.unwrap(), 42);
assert_eq!(
items.bbox.unwrap(),
vec![-1.0, -2.0, 1.0, 2.0].try_into().unwrap()
);
assert_eq!(items.datetime.unwrap(), "2023");
assert_eq!(
items.fields.unwrap(),
Fields {
include: vec!["foo".to_string()],
exclude: vec!["bar".to_string()],
}
);
assert_eq!(
items.sortby.unwrap(),
vec![Sortby {
field: "foo".to_string(),
direction: Direction::Descending,
}]
);
assert_eq!(
items.filter.unwrap(),
Filter::Cql2Text("dummy text".to_string())
);
assert_eq!(items.additional_fields["token"], "foobar");
}
#[test]
fn items_try_from_get_items() {
let mut additional_fields = Map::new();
let _ = additional_fields.insert("token".to_string(), Value::String("foobar".to_string()));
let items = Items {
limit: Some(42),
bbox: Some(vec![-1.0, -2.0, 1.0, 2.0].try_into().unwrap()),
datetime: Some("2023".to_string()),
fields: Some(Fields {
include: vec!["foo".to_string()],
exclude: vec!["bar".to_string()],
}),
sortby: Some(vec![Sortby {
field: "foo".to_string(),
direction: Direction::Descending,
}]),
filter_crs: None,
filter: Some(Filter::Cql2Text("dummy text".to_string())),
query: None,
additional_fields,
};
let get_items: GetItems = items.try_into().unwrap();
assert_eq!(get_items.limit.unwrap(), "42");
assert_eq!(get_items.bbox.unwrap(), "-1,-2,1,2");
assert_eq!(get_items.datetime.unwrap(), "2023");
assert_eq!(get_items.fields.unwrap(), "foo,-bar");
assert_eq!(get_items.sortby.unwrap(), "-foo");
assert_eq!(get_items.filter.unwrap(), "dummy text");
assert_eq!(get_items.additional_fields["token"], "\"foobar\"");
}
}