From 425a07eb390a20324f9887361413d6dd876f4834 Mon Sep 17 00:00:00 2001 From: Pirmin Kalberer Date: Tue, 5 Nov 2024 16:32:06 +0100 Subject: [PATCH 1/5] Add support for URL prefix --- bbox-core/src/config.rs | 8 ++++- bbox-core/src/service.rs | 2 +- bbox-core/templates/base.html | 9 +++--- bbox-core/templates/collections.html | 2 +- bbox-feature-server/src/datasource/gpkg.rs | 23 +++++++++---- bbox-feature-server/src/datasource/mod.rs | 15 ++++++--- bbox-feature-server/src/datasource/postgis.rs | 26 +++++++++------ bbox-feature-server/src/endpoints.rs | 15 +++++---- bbox-feature-server/src/inventory.rs | 32 +++++++++++++------ bbox-feature-server/src/service.rs | 11 ++++--- bbox-feature-server/templates/collection.html | 2 +- bbox-feature-server/templates/feature.html | 2 +- bbox-feature-server/templates/features.html | 4 +-- bbox-feature-server/templates/queryables.html | 2 +- bbox-frontend/src/endpoints.rs | 10 +++--- bbox-frontend/templates/index.html | 10 +++--- bbox-frontend/templates/redoc.html | 2 +- bbox-frontend/templates/swaggerui.html | 4 +-- bbox-map-server/src/inventory.rs | 7 ++++ bbox-map-server/src/service.rs | 4 ++- bbox-map-server/src/wms_fcgi_backend.rs | 2 ++ 21 files changed, 124 insertions(+), 68 deletions(-) diff --git a/bbox-core/src/config.rs b/bbox-core/src/config.rs index 1b3c840d..039143bb 100644 --- a/bbox-core/src/config.rs +++ b/bbox-core/src/config.rs @@ -129,7 +129,8 @@ pub struct WebserverCfg { pub server_addr: String, /// Number of parallel web server threads. Defaults to number of available logical CPUs worker_threads: Option, - public_server_url: Option, + /// Public base URL of the server (e.g. `https://bbox.example.com/`) + pub public_server_url: Option, /// Log level (Default: info) pub loglevel: Option, pub tls_cert: Option, @@ -172,6 +173,11 @@ impl CoreServiceCfg { pub fn loglevel(&self) -> Option { self.webserver.as_ref().and_then(|cfg| cfg.loglevel.clone()) } + pub fn public_server_url(&self) -> Option { + self.webserver + .as_ref() + .and_then(|cfg| cfg.public_server_url.clone()) + } } impl Default for WebserverCfg { diff --git a/bbox-core/src/service.rs b/bbox-core/src/service.rs index 5ccf432e..19b7f0d7 100644 --- a/bbox-core/src/service.rs +++ b/bbox-core/src/service.rs @@ -103,7 +103,7 @@ pub struct CoreService { impl CoreService { pub fn add_service(&mut self, svc: &T) { - let api_base = ""; + let api_base = self.web_config.public_server_url.as_deref().unwrap_or(""); self.ogcapi .landing_page_links diff --git a/bbox-core/templates/base.html b/bbox-core/templates/base.html index ce9eaaba..5c516c46 100644 --- a/bbox-core/templates/base.html +++ b/bbox-core/templates/base.html @@ -4,7 +4,8 @@ BBOX - {% block title %}Home{% endblock %} - + + {% block head %} {% endblock %} @@ -29,12 +30,12 @@

{% block content_title %}{% endblock %}

  • - + Home
  • - + Collections
    • @@ -44,7 +45,7 @@

    {% block content_title %}{% endblock %}

  • - + API
    • diff --git a/bbox-core/templates/collections.html b/bbox-core/templates/collections.html index 4b8c84f8..9c4ec6cd 100644 --- a/bbox-core/templates/collections.html +++ b/bbox-core/templates/collections.html @@ -15,7 +15,7 @@ {% for collection in collections.collections %} - {{ collection.title }} + {{ collection.title }} {{ collection.description }} {% endfor %} diff --git a/bbox-feature-server/src/datasource/gpkg.rs b/bbox-feature-server/src/datasource/gpkg.rs index a57423f7..2e04d7e2 100644 --- a/bbox-feature-server/src/datasource/gpkg.rs +++ b/bbox-feature-server/src/datasource/gpkg.rs @@ -47,6 +47,7 @@ impl CollectionDatasource for SqliteDatasource { async fn setup_collection( &mut self, cfg: &ConfiguredCollectionCfg, + base_url: &str, extent: Option, ) -> Result { info!("Setup Gpkg Collection `{}`", &cfg.name); @@ -101,7 +102,7 @@ impl CollectionDatasource for SqliteDatasource { item_type: None, crs: vec![], links: vec![ApiLink { - href: format!("/collections/{id}/items"), + href: format!("{base_url}/collections/{id}/items"), rel: Some("items".to_string()), type_: Some("application/geo+json".to_string()), title: cfg.title.clone(), @@ -119,7 +120,7 @@ impl CollectionDatasource for SqliteDatasource { #[async_trait] impl AutoscanCollectionDatasource for SqliteDatasource { - async fn collections(&mut self) -> Result> { + async fn collections(&mut self, base_url: &str) -> Result> { let mut collections = Vec::new(); let sql = r#" SELECT contents.* @@ -154,7 +155,10 @@ impl AutoscanCollectionDatasource for SqliteDatasource { title: Some(title), description: row.try_get("description")?, }; - if let Ok(fc) = self.setup_collection(&coll_cfg, Some(extent)).await { + if let Ok(fc) = self + .setup_collection(&coll_cfg, base_url, Some(extent)) + .await + { collections.push(fc); } } @@ -210,7 +214,12 @@ impl CollectionSource for GpkgCollectionSource { Ok(result) } - async fn item(&self, collection_id: &str, feature_id: &str) -> Result> { + async fn item( + &self, + base_url: &str, + collection_id: &str, + feature_id: &str, + ) -> Result> { let Some(pk) = &self.pk_column else { warn!("Ignoring error getting item for {collection_id} without single primary key"); return Ok(None); @@ -229,7 +238,7 @@ impl CollectionSource for GpkgCollectionSource { let mut item = row_to_feature(&row, self)?; item.links = vec![ ApiLink { - href: format!("/collections/{collection_id}/items/{feature_id}"), + href: format!("{base_url}/collections/{collection_id}/items/{feature_id}"), rel: Some("self".to_string()), type_: Some("application/geo+json".to_string()), title: Some("this document".to_string()), @@ -237,7 +246,7 @@ impl CollectionSource for GpkgCollectionSource { length: None, }, ApiLink { - href: format!("/collections/{collection_id}"), + href: format!("{base_url}/collections/{collection_id}"), rel: Some("collection".to_string()), type_: Some("application/geo+json".to_string()), title: Some("the collection document".to_string()), @@ -351,7 +360,7 @@ mod tests { let mut pool = SqliteDatasource::new_pool("../assets/ne_extracts.gpkg") .await .unwrap(); - let collections = pool.collections().await.unwrap(); + let collections = pool.collections("").await.unwrap(); assert_eq!(collections.len(), 3); assert_eq!( collections diff --git a/bbox-feature-server/src/datasource/mod.rs b/bbox-feature-server/src/datasource/mod.rs index b5d2a772..32daf5f0 100644 --- a/bbox-feature-server/src/datasource/mod.rs +++ b/bbox-feature-server/src/datasource/mod.rs @@ -19,19 +19,25 @@ pub trait CollectionDatasource { async fn setup_collection( &mut self, cfg: &ConfiguredCollectionCfg, + base_url: &str, extent: Option, ) -> Result; } #[async_trait] pub trait AutoscanCollectionDatasource { - async fn collections(&mut self) -> Result>; + async fn collections(&mut self, base_url: &str) -> Result>; } #[async_trait] pub trait CollectionSource: DynClone + Sync + Send { async fn items(&self, filter: &FilterParams) -> Result; - async fn item(&self, collection_id: &str, feature_id: &str) -> Result>; + async fn item( + &self, + base_url: &str, + collection_id: &str, + feature_id: &str, + ) -> Result>; async fn queryables(&self, collection_id: &str) -> Result>; } @@ -71,6 +77,7 @@ impl Datasources { pub async fn setup_collection( &mut self, collection: &ConfiguredCollectionCfg, + base_url: &str, ) -> Result { match &collection.source { CollectionSourceCfg::Postgis(cfg) => { @@ -83,7 +90,7 @@ impl Datasources { .unwrap_or(&"(default)".to_string()) .clone(), ))?; - source.setup_collection(collection, None).await + source.setup_collection(collection, base_url, None).await } CollectionSourceCfg::Gpkg(ref cfg) => { let source = self @@ -95,7 +102,7 @@ impl Datasources { .unwrap_or(&"(default)".to_string()) .clone(), ))?; - source.setup_collection(collection, None).await + source.setup_collection(collection, base_url, None).await } } } diff --git a/bbox-feature-server/src/datasource/postgis.rs b/bbox-feature-server/src/datasource/postgis.rs index fcf0411f..65f19040 100644 --- a/bbox-feature-server/src/datasource/postgis.rs +++ b/bbox-feature-server/src/datasource/postgis.rs @@ -25,6 +25,7 @@ impl CollectionDatasource for PgDatasource { async fn setup_collection( &mut self, cfg: &ConfiguredCollectionCfg, + base_url: &str, _extent: Option, ) -> Result { info!("Setup Postgis Collection `{}`", &cfg.name); @@ -126,7 +127,7 @@ impl CollectionDatasource for PgDatasource { item_type: None, crs: vec![], links: vec![ApiLink { - href: format!("/collections/{id}/items"), + href: format!("{base_url}/collections/{id}/items"), rel: Some("items".to_string()), type_: Some("application/geo+json".to_string()), title: Some(id.clone()), @@ -137,7 +138,7 @@ impl CollectionDatasource for PgDatasource { if !queryable_fields.is_empty() { collection.links.push(ApiLink { - href: format!("/collections/{id}/queryables"), + href: format!("{base_url}/collections/{id}/queryables"), rel: Some("http://www.opengis.net/def/rel/ogc/1.0/queryables".to_string()), type_: Some("application/schema+json".to_string()), title: Some(id.clone()), @@ -156,7 +157,7 @@ impl CollectionDatasource for PgDatasource { #[async_trait] impl AutoscanCollectionDatasource for PgDatasource { - async fn collections(&mut self) -> Result> { + async fn collections(&mut self, base_url: &str) -> Result> { let mut collections = Vec::new(); let sql = r#" SELECT contents.* @@ -178,7 +179,7 @@ impl AutoscanCollectionDatasource for PgDatasource { title: Some(table_name), description: None, }; - if let Ok(fc) = self.setup_collection(&coll_cfg, None).await { + if let Ok(fc) = self.setup_collection(&coll_cfg, base_url, None).await { collections.push(fc); } } @@ -210,7 +211,7 @@ impl CollectionSource for PgCollectionSource { format!( r#"SELECT to_jsonb(t.*)-'{geometry_column}'-'{pk}' AS properties, ST_AsGeoJSON({geometry_column})::jsonb AS geometry, "{pk}"::varchar AS pk, - count(*) OVER () AS __total_cnt + count(*) OVER () AS __total_cnt FROM query t"#, ) } else { @@ -218,7 +219,7 @@ impl CollectionSource for PgCollectionSource { r#"SELECT to_jsonb(t.*)-'{geometry_column}' AS properties, ST_AsGeoJSON({geometry_column})::jsonb AS geometry, NULL AS pk, --row_number() OVER () ::varchar AS pk, - count(*) OVER () AS __total_cnt + count(*) OVER () AS __total_cnt FROM query t"#, ) }; @@ -378,7 +379,12 @@ impl CollectionSource for PgCollectionSource { Ok(result) } - async fn item(&self, collection_id: &str, feature_id: &str) -> Result> { + async fn item( + &self, + base_url: &str, + collection_id: &str, + feature_id: &str, + ) -> Result> { let Some(pk) = &self.pk_column else { warn!("Ignoring error getting item for {collection_id} without single primary key"); return Ok(None); @@ -401,7 +407,7 @@ impl CollectionSource for PgCollectionSource { let mut item = row_to_feature(&row, self)?; item.links = vec![ ApiLink { - href: format!("/collections/{collection_id}/items/{feature_id}"), + href: format!("{base_url}/collections/{collection_id}/items/{feature_id}",), rel: Some("self".to_string()), type_: Some("application/geo+json".to_string()), title: Some("this document".to_string()), @@ -409,7 +415,7 @@ impl CollectionSource for PgCollectionSource { length: None, }, ApiLink { - href: format!("/collections/{collection_id}"), + href: format!("{base_url}/collections/{collection_id}"), rel: Some("collection".to_string()), type_: Some("application/geo+json".to_string()), title: Some("the collection document".to_string()), @@ -597,7 +603,7 @@ mod tests { PgDatasource::new_pool("postgresql://mvtbench:mvtbench@127.0.0.1:5439/mvtbench") .await .unwrap(); - let collections = pool.collections().await.unwrap(); + let collections = pool.collections("").await.unwrap(); assert!(collections.len() >= 3); assert!(collections .iter() diff --git a/bbox-feature-server/src/endpoints.rs b/bbox-feature-server/src/endpoints.rs index e8e70e32..0c326e20 100644 --- a/bbox-feature-server/src/endpoints.rs +++ b/bbox-feature-server/src/endpoints.rs @@ -33,7 +33,7 @@ async fn collections( render_endpoint( &TEMPLATES, "collections.html", - context!(cur_menu=>"Collections", collections => &collections), + context!(cur_menu=>"Collections", base_url => inventory.base_url(), collections => &collections), ) .await } else { @@ -52,7 +52,7 @@ async fn collection( render_endpoint( &TEMPLATES, "collection.html", - context!(cur_menu=>"Collections", collection => &collection), + context!(cur_menu=>"Collections", base_url => inventory.base_url(), collection => &collection), ) .await } else { @@ -74,7 +74,7 @@ async fn queryables( render_endpoint( &TEMPLATES, "queryables.html", - context!(cur_menu=>"Collections", queryables => &queryables), + context!(cur_menu=>"Collections", base_url => inventory.base_url(), queryables => &queryables), ) .await } else { @@ -142,7 +142,7 @@ async fn features( render_endpoint( &TEMPLATES, "features.html", - context!(cur_menu=>"Collections", collection => &collection, features => &features), + context!(cur_menu=>"Collections", base_url => inventory.base_url(), collection => &collection, features => &features), ).await } else { Ok(HttpResponse::Ok() @@ -165,12 +165,15 @@ async fn feature( ) -> Result { let (collection_id, feature_id) = path.into_inner(); if let Some(collection) = inventory.core_collection(&collection_id) { - if let Some(feature) = inventory.collection_item(&collection_id, &feature_id).await { + if let Some(feature) = inventory + .collection_item(inventory.href_prefix(), &collection_id, &feature_id) + .await + { if html_accepted(&req).await { render_endpoint( &TEMPLATES, "feature.html", - context!(cur_menu=>"Collections", collection => &collection, feature => &feature), + context!(cur_menu=>"Collections", base_url => inventory.base_url(), collection => &collection, feature => &feature), ).await } else { Ok(HttpResponse::Ok() diff --git a/bbox-feature-server/src/inventory.rs b/bbox-feature-server/src/inventory.rs index f902a169..9a2aff04 100644 --- a/bbox-feature-server/src/inventory.rs +++ b/bbox-feature-server/src/inventory.rs @@ -25,6 +25,7 @@ use std::collections::HashMap; pub struct Inventory { // Key: collection_id feat_collections: HashMap, + public_server_url: Option, } #[derive(Clone)] @@ -35,14 +36,23 @@ pub struct FeatureCollection { } impl Inventory { - pub fn new() -> Self { + pub fn new(public_server_url: Option) -> Self { Inventory { feat_collections: HashMap::new(), + public_server_url, } } - pub async fn scan(config: &CollectionsCfg) -> Inventory { - let mut inventory = Inventory::new(); + pub fn base_url(&self) -> &str { + self.public_server_url.as_deref().unwrap_or("/") + } + + pub fn href_prefix(&self) -> &str { + self.public_server_url.as_deref().unwrap_or("") + } + + pub async fn scan(config: &CollectionsCfg, public_server_url: Option) -> Inventory { + let mut inventory = Inventory::new(public_server_url); for dir_ds in &config.directory { let base_dir = &dir_ds.dir; info!("Scanning '{base_dir}' for feature collections"); @@ -53,7 +63,7 @@ impl Inventory { match SqliteDatasource::new_pool(&pathstr).await { Ok(mut ds) => { info!("Scanning '{pathstr}' for feature collections"); - match ds.collections().await { + match ds.collections(inventory.href_prefix()).await { Ok(collections) => inventory.add_collections(collections), Err(e) => { warn!("Failed to scan feature collections for '{pathstr}': {e}") @@ -71,7 +81,7 @@ impl Inventory { match PgDatasource::from_config(cfg, None).await { Ok(mut ds) => { info!("Scanning '{}' for feature collections", cfg.url); - match ds.collections().await { + match ds.collections(inventory.href_prefix()).await { Ok(collections) => inventory.add_collections(collections), Err(e) => { warn!("Failed to scan feature collections for '{}': {e}", &cfg.url) @@ -135,11 +145,12 @@ impl Inventory { return None; } }; + let base_url = self.href_prefix(); let mut features = CoreFeatures { type_: "FeatureCollection".to_string(), links: vec![ ApiLink { - href: format!("/collections/{collection_id}/items"), + href: format!("{base_url}/collections/{collection_id}/items"), rel: Some("self".to_string()), type_: Some("text/html".to_string()), title: Some("this document".to_string()), @@ -147,7 +158,7 @@ impl Inventory { length: None, }, ApiLink { - href: format!("/collections/{collection_id}/items.json"), + href: format!("{base_url}/collections/{collection_id}/items.json"), rel: Some("self".to_string()), type_: Some("application/geo+json".to_string()), title: Some("this document".to_string()), @@ -164,7 +175,7 @@ impl Inventory { let mut add_link = |link: FilterParams, rel: &str| { let params = link.as_args(); features.links.push(ApiLink { - href: format!("/collections/{collection_id}/items{params}"), + href: format!("{base_url}/collections/{collection_id}/items{params}"), rel: Some(rel.to_string()), type_: Some("text/html".to_string()), title: Some(rel.to_string()), @@ -185,6 +196,7 @@ impl Inventory { pub async fn collection_item( &self, + base_url: &str, collection_id: &str, feature_id: &str, ) -> Option { @@ -192,7 +204,7 @@ impl Inventory { warn!("Ignoring error getting collection {collection_id}"); return None; }; - match fc.source.item(collection_id, feature_id).await { + match fc.source.item(base_url, collection_id, feature_id).await { Ok(item) => item, Err(e) => { warn!("Ignoring error getting collection item for {collection_id}: {e}"); @@ -222,7 +234,7 @@ mod tests { #[tokio::test] async fn inventory_scan() { - let inventory = Inventory::scan(&CollectionsCfg::from_path("../assets")).await; + let inventory = Inventory::scan(&CollectionsCfg::from_path("../assets"), None).await; // assert_eq!(inventory.collections().len(), 3); assert!(inventory.collections().len() >= 3); assert_eq!( diff --git a/bbox-feature-server/src/service.rs b/bbox-feature-server/src/service.rs index d1507b2a..eaa8fec4 100644 --- a/bbox-feature-server/src/service.rs +++ b/bbox-feature-server/src/service.rs @@ -19,15 +19,16 @@ impl OgcApiService for FeatureService { type CliArgs = NoArgs; type Metrics = NoMetrics; - async fn create(config: &Self::Config, _core_cfg: &CoreServiceCfg) -> Self { + async fn create(config: &Self::Config, core_cfg: &CoreServiceCfg) -> Self { let mut sources = Datasources::create(&config.datasources) .await .unwrap_or_else(error_exit); - let mut inventory = Inventory::scan(&config.auto_collections).await; + let mut inventory = + Inventory::scan(&config.auto_collections, core_cfg.public_server_url()).await; for cfg in &config.collections { let collection = sources - .setup_collection(cfg) + .setup_collection(cfg, inventory.href_prefix()) .await .unwrap_or_else(error_exit); inventory.add_collection(collection); @@ -49,9 +50,9 @@ impl OgcApiService for FeatureService { } classes } - fn landing_page_links(&self, _api_base: &str) -> Vec { + fn landing_page_links(&self, api_base: &str) -> Vec { vec![ApiLink { - href: "/collections".to_string(), + href: format!("{api_base}/collections"), rel: Some("data".to_string()), type_: Some("application/json".to_string()), title: Some("Information about the feature collections".to_string()), diff --git a/bbox-feature-server/templates/collection.html b/bbox-feature-server/templates/collection.html index b22bb778..f15dc2a1 100644 --- a/bbox-feature-server/templates/collection.html +++ b/bbox-feature-server/templates/collection.html @@ -5,7 +5,7 @@ {% block content %}
    -JSON
    +JSON
    {{ collection.description }} diff --git a/bbox-feature-server/templates/feature.html b/bbox-feature-server/templates/feature.html index d877bd4e..811970a1 100644 --- a/bbox-feature-server/templates/feature.html +++ b/bbox-feature-server/templates/feature.html @@ -5,7 +5,7 @@ {% block content %} diff --git a/bbox-feature-server/templates/features.html b/bbox-feature-server/templates/features.html index 4ee9f7e6..e3c27679 100644 --- a/bbox-feature-server/templates/features.html +++ b/bbox-feature-server/templates/features.html @@ -5,7 +5,7 @@ {% block content %}
    @@ -23,7 +23,7 @@ {% for feature in features.features %} - + {% for prop in first_feature.properties %} {% endfor %} diff --git a/bbox-feature-server/templates/queryables.html b/bbox-feature-server/templates/queryables.html index c087355f..0a51d98d 100644 --- a/bbox-feature-server/templates/queryables.html +++ b/bbox-feature-server/templates/queryables.html @@ -5,7 +5,7 @@ {% block content %}

    Queryables

    diff --git a/bbox-frontend/src/endpoints.rs b/bbox-frontend/src/endpoints.rs index f9ddc6e5..a8e26794 100644 --- a/bbox-frontend/src/endpoints.rs +++ b/bbox-frontend/src/endpoints.rs @@ -27,16 +27,16 @@ async fn index(inventory: web::Data) -> Result::new(); let index = template .render( - context!(cur_menu => "Home", wms_services => &inventory.wms_services, links => links), + context!(cur_menu => "Home", base_url => inventory.base_url(), wms_services => &inventory.wms_services, links => links), ) .expect("index.hmtl render failed"); Ok(HttpResponse::Ok().content_type("text/html").body(index)) diff --git a/bbox-frontend/templates/index.html b/bbox-frontend/templates/index.html index 5c75e9f1..98055c3a 100644 --- a/bbox-frontend/templates/index.html +++ b/bbox-frontend/templates/index.html @@ -11,7 +11,7 @@

    Map catalog

      {% for entry in wms_services %}
    • {{ entry.wms_path }}: Capabilities - +
      • {% endfor %}
    @@ -31,9 +31,9 @@

    Map request examples

    OGC API endpoints

    @@ -41,7 +41,7 @@

    OGC API endpoints

    Links

    diff --git a/bbox-frontend/templates/redoc.html b/bbox-frontend/templates/redoc.html index c7730832..e60bcc72 100644 --- a/bbox-frontend/templates/redoc.html +++ b/bbox-frontend/templates/redoc.html @@ -4,5 +4,5 @@ {% block content %} - + {% endblock %} diff --git a/bbox-frontend/templates/swaggerui.html b/bbox-frontend/templates/swaggerui.html index 48699668..8490ff65 100644 --- a/bbox-frontend/templates/swaggerui.html +++ b/bbox-frontend/templates/swaggerui.html @@ -3,8 +3,8 @@ {% block title %}OpenAPI Swagger UI{% endblock %} {% block head %} - - + +
    {{ feature.id }}{{ feature.id }}{{feature.properties[prop]}}