stac-fastapi.eodag 0.1.0__py3-none-any.whl

stac_fastapi/eodag/__init__.py

@@ -0,0 +1,18 @@
+# -*- coding: utf-8 -*-
+# Copyright 2023, CS GROUP - France, https://www.cs-soprasteria.com
+#
+# This file is part of stac-fastapi-eodag project
+#     https://www.github.com/CS-SI/stac-fastapi-eodag
+#
+# 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.
+"""stac_fastapi.eodag module."""

stac_fastapi/eodag/api.py

@@ -0,0 +1,58 @@
+# -*- coding: utf-8 -*-
+# Copyright 2024, CS GROUP - France, https://www.cs-soprasteria.com
+#
+# This file is part of stac-fastapi-eodag project
+#     https://www.github.com/CS-SI/stac-fastapi-eodag
+#
+# 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.
+"""override stac api for download handlers."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+import attr
+from stac_fastapi.api.app import StacApi
+
+from stac_fastapi.eodag.models.stac_metadata import CommonStacMetadata
+
+if TYPE_CHECKING:
+    from pydantic import BaseModel
+
+
+@attr.s
+class EodagStacApi(StacApi):
+    """Override default API to include download endpoints handlers."""
+
+    item_properties_model: type[BaseModel] = attr.ib(default=CommonStacMetadata)
+
+    # def register_download_item(self) -> None:
+    #     """Register download item endpoint (GET /collections/{collection_id}/items/{item_id}/download).
+
+    #     Returns:
+    #         None
+    #     """
+    #     self.router.add_api_route(
+    #         name="Download Item",
+    #         path="/collections/{collection_id}/items/{item_id}/download",
+    #         response_class=StreamingResponse,
+    #         methods=["GET"],
+    #         endpoint=create_async_endpoint(
+    #             self.client.download_item, ItemUri, StreamingResponse
+    #         ),
+    #     )
+
+    # def register_core(self) -> None:
+    #     """Register endpoints."""
+    #     super().register_core()
+    #     self.register_download_item()

stac_fastapi/eodag/app.py

@@ -0,0 +1,248 @@
+# -*- coding: utf-8 -*-
+# Copyright 2024, CS GROUP - France, https://www.cs-soprasteria.com
+#
+# This file is part of stac-fastapi-eodag project
+#     https://www.github.com/CS-SI/stac-fastapi-eodag
+#
+# 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.
+"""FastAPI application using EODAG."""
+
+from __future__ import annotations
+
+import os
+from typing import TYPE_CHECKING
+
+import stac_fastapi.api.errors
+from brotli_asgi import BrotliMiddleware  # type: ignore[import-untyped]
+from fastapi import FastAPI
+from fastapi.concurrency import asynccontextmanager
+from fastapi.middleware import Middleware
+from fastapi.responses import ORJSONResponse
+from stac_fastapi.api.app import StacApi
+from stac_fastapi.api.middleware import CORSMiddleware
+from stac_fastapi.api.models import (
+    EmptyRequest,
+    ItemCollectionUri,
+    create_get_request_model,
+    create_post_request_model,
+    create_request_model,
+)
+from stac_fastapi.extensions.core import (
+    CollectionSearchExtension,
+    FilterExtension,
+    FreeTextExtension,
+    QueryExtension,
+    SortExtension,
+)
+from stac_fastapi.extensions.core.free_text import FreeTextConformanceClasses
+from stac_fastapi.extensions.core.query import QueryConformanceClasses
+from stac_fastapi.extensions.core.sort import SortConformanceClasses
+
+from stac_fastapi.eodag.config import get_settings
+from stac_fastapi.eodag.core import EodagCoreClient
+from stac_fastapi.eodag.dag import init_dag
+from stac_fastapi.eodag.errors import add_exception_handlers, exception_handler_factory
+from stac_fastapi.eodag.extensions.collection_order import (
+    BaseCollectionOrderClient,
+    CollectionOrderExtension,
+)
+from stac_fastapi.eodag.extensions.data_download import DataDownload
+from stac_fastapi.eodag.extensions.ecmwf import EcmwfExtension
+from stac_fastapi.eodag.extensions.filter import FiltersClient
+from stac_fastapi.eodag.extensions.offset_pagination import OffsetPaginationExtension
+from stac_fastapi.eodag.extensions.pagination import PaginationExtension
+from stac_fastapi.eodag.extensions.stac import (
+    ElectroOpticalExtension,
+    FederationExtension,
+    OrderExtension,
+    ProcessingExtension,
+    ProductExtension,
+    SarExtension,
+    SatelliteExtension,
+    ScientificCitationExtension,
+    StorageExtension,
+    TimestampExtension,
+    ViewGeometryExtension,
+)
+from stac_fastapi.eodag.logs import RequestIDMiddleware, init_logging
+from stac_fastapi.eodag.middlewares import ProxyHeaderMiddleware
+from stac_fastapi.eodag.models.stac_metadata import create_stac_metadata_model
+
+if TYPE_CHECKING:
+    from typing import AsyncGenerator
+
+init_logging()
+
+settings = get_settings()
+
+stac_metadata_model = create_stac_metadata_model(
+    extensions=[
+        SarExtension(),
+        SatelliteExtension(),
+        TimestampExtension(),
+        ProcessingExtension(),
+        ViewGeometryExtension(),
+        ElectroOpticalExtension(),
+        FederationExtension(),
+        ScientificCitationExtension(),
+        ProductExtension(),
+        StorageExtension(),
+        OrderExtension(),
+        EcmwfExtension(),
+    ]
+)
+
+# search extensions
+search_extensions_map = {
+    "query": QueryExtension(),
+    "sort": SortExtension(),
+    "filter": FilterExtension(client=FiltersClient(stac_metadata_model=stac_metadata_model)),
+    "pagination": PaginationExtension(),
+}
+
+# collection_search extensions
+cs_extensions_map = {
+    "query": QueryExtension(conformance_classes=[QueryConformanceClasses.COLLECTIONS]),
+    "offset-pagination": OffsetPaginationExtension(),
+    "collection-search": CollectionSearchExtension(),
+    "free-text": FreeTextExtension(conformance_classes=[FreeTextConformanceClasses.COLLECTIONS]),
+}
+
+# item_collection extensions
+itm_col_extensions_map = {
+    "pagination": PaginationExtension(),
+    "sort": SortExtension(conformance_classes=[SortConformanceClasses.ITEMS]),
+}
+
+all_extensions = {
+    **search_extensions_map,
+    **cs_extensions_map,
+    **itm_col_extensions_map,
+    **{
+        "data-download": DataDownload(),
+        "collection-order": CollectionOrderExtension(
+            client=BaseCollectionOrderClient(stac_metadata_model=stac_metadata_model)
+        ),
+    },
+}
+
+
+def get_enabled_extensions(specif_extensions: dict):
+    """
+    Retrieve the list of enabled extensions based on the environment variable `ENABLED_EXTENSIONS`.
+
+    :param specif_extensions: A dictionary mapping extension names to their corresponding objects.
+    :returns: A list of enabled extension objects. If `ENABLED_EXTENSIONS` is not set, all extensions
+              from `specif_extensions` are returned.
+    """
+    if enabled := os.getenv("ENABLED_EXTENSIONS"):
+        return [specif_extensions[name] for name in enabled.split(",") if name in specif_extensions]
+    return list(specif_extensions.values())
+
+
+extensions = get_enabled_extensions(all_extensions)
+
+for e in extensions:
+    if isinstance(e, CollectionOrderExtension):
+        e.client.extensions = extensions
+
+
+@asynccontextmanager
+async def lifespan(app: FastAPI) -> AsyncGenerator[None, None]:
+    """API init and tear-down"""
+    init_dag(app)
+    if os.getenv("OTEL_EXPORTER_OTLP_ENDPOINT", ""):
+        from stac_fastapi.eodag.telemetry import instrument_eodag
+
+        instrument_eodag(app.state.dag)
+    # init_cache(app)
+    app.state.stac_metadata_model = stac_metadata_model
+    yield
+
+
+app = FastAPI(
+    openapi_url=settings.openapi_url,
+    docs_url=settings.docs_url,
+    redoc_url=None,
+    lifespan=lifespan,
+)
+
+if os.getenv("OTEL_EXPORTER_OTLP_ENDPOINT", ""):
+    from stac_fastapi.eodag.telemetry import instrument_fastapi
+
+    instrument_fastapi(app)
+
+add_exception_handlers(app)
+app.add_middleware(RequestIDMiddleware)
+
+search_extensions = get_enabled_extensions(search_extensions_map)
+
+search_post_model = create_post_request_model(search_extensions)
+search_get_model = create_get_request_model(search_extensions)
+
+collections_model = create_request_model(
+    "CollectionsRequest",
+    base_model=EmptyRequest,
+    extensions=get_enabled_extensions(cs_extensions_map),
+    request_type="GET",
+)
+
+item_collection_model = create_request_model(
+    "ItemsRequest",
+    base_model=ItemCollectionUri,
+    extensions=get_enabled_extensions(itm_col_extensions_map),
+    request_type="GET",
+)
+
+
+client = EodagCoreClient(post_request_model=search_post_model, stac_metadata_model=stac_metadata_model)
+
+stac_fastapi.api.errors.exception_handler_factory = exception_handler_factory
+
+api = StacApi(
+    app=app,
+    settings=settings,
+    extensions=extensions,
+    client=client,
+    response_class=ORJSONResponse,
+    search_get_request_model=search_get_model,
+    search_post_request_model=search_post_model,
+    collections_get_request_model=collections_model,
+    items_get_request_model=item_collection_model,
+    middlewares=[
+        Middleware(BrotliMiddleware),
+        Middleware(CORSMiddleware),
+        Middleware(ProxyHeaderMiddleware),
+    ],
+)
+
+
+def run():
+    """Run app from command line using uvicorn if available."""
+    try:
+        import uvicorn
+
+        uvicorn.run(
+            "stac_fastapi.eodag.app:app",
+            host=settings.app_host,
+            port=settings.app_port,
+            log_level="info",
+            reload=settings.reload,
+            root_path=os.getenv("UVICORN_ROOT_PATH", ""),
+        )
+    except ImportError as e:
+        raise RuntimeError("Uvicorn must be installed in order to use command") from e
+
+
+if __name__ == "__main__":
+    run()

stac_fastapi/eodag/client.py

@@ -0,0 +1,58 @@
+# -*- coding: utf-8 -*-
+# Copyright 2024, CS GROUP - France, https://www.cs-soprasteria.com
+#
+# This file is part of stac-fastapi-eodag project
+#     https://www.github.com/CS-SI/stac-fastapi-eodag
+#
+# 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.
+"""Initialize landing page"""
+
+from urllib.parse import urljoin
+
+from stac_fastapi.types import stac
+from stac_fastapi.types.core import AsyncBaseCoreClient
+from stac_fastapi.types.requests import get_base_url
+
+from stac_fastapi.eodag.config import get_settings
+from stac_fastapi.eodag.models.stac_metadata import get_federation_backend_dict
+
+
+class CustomCoreClient(AsyncBaseCoreClient):
+    """Override the base method to generate a STAC landing page (GET /)."""
+
+    async def landing_page(self, **kwargs) -> stac.LandingPage:
+        """Generate a STAC landing page (GET /)."""
+        landing_page = await super().landing_page(**kwargs)
+
+        request = kwargs["request"]
+        base_url = get_base_url(request)
+
+        # Modify each link to add a title if absent
+        stac_fastapi_title = get_settings().stac_fastapi_title
+        if "links" in landing_page and isinstance(landing_page["links"], list):
+            collections_url = urljoin(base_url, "collections")
+            for link in landing_page["links"]:
+                href = link.get("href", "")
+                if href == base_url:
+                    link["title"] = f"{stac_fastapi_title}"
+                if href == collections_url:
+                    link["title"] = "Collections"
+
+        # add federation backends infos
+        federation_backends = request.app.state.dag.available_providers()
+        federation_dict = {fb: get_federation_backend_dict(request, fb) for fb in federation_backends}
+        landing_page["federation"] = federation_dict
+
+        landing_page["stac_extensions"].append(self.stac_metadata_model._conformance_classes["FederationExtension"])
+
+        return landing_page

stac_fastapi/eodag/config.py

@@ -0,0 +1,72 @@
+# -*- coding: utf-8 -*-
+# Copyright 2024, CS GROUP - France, https://www.cs-soprasteria.com
+#
+# This file is part of stac-fastapi-eodag project
+#     https://www.github.com/CS-SI/stac-fastapi-eodag
+#
+# 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.
+"""EODAG STAC API configuration"""
+
+from __future__ import annotations
+
+from functools import lru_cache
+from typing import Annotated, Union
+
+from pydantic import Field
+from pydantic.functional_validators import BeforeValidator
+from stac_fastapi.types.config import ApiSettings
+
+from stac_fastapi.eodag.utils import str2liststr
+
+
+class Settings(ApiSettings):
+    """EODAG Server config"""
+
+    debug: bool = False
+
+    keep_origin_url: bool = Field(
+        default=False,
+        description=("Keep origin as alternate URL when data-download extension is enabled."),
+    )
+
+    origin_url_blacklist: Annotated[Union[str, list[str]], BeforeValidator(str2liststr)] = Field(
+        default=[],
+        description=("Hide from clients items assets' origin URLs starting with URLs from the list."),
+    )
+
+    auto_order_whitelist: Annotated[Union[str, list[str]], BeforeValidator(str2liststr)] = Field(
+        default=[
+            "wekeo_main",
+        ],
+        description=("List of providers for which the order should be done at the same time as the download."),
+    )
+
+    fetch_providers: bool = Field(default=False, description="Fetch additional collections from all providers.")
+
+    count: bool = Field(
+        default=False,
+        description=("Whether to run a query with a count request or not"),
+    )
+
+    download_base_url: str = Field(
+        default="",
+        description="base url to be used for download link",
+        pattern=r"(http|https):\/\/[\w:.-]+\/",
+        validate_default=False,
+    )
+
+
+@lru_cache(maxsize=1)
+def get_settings() -> Settings:
+    """Get settings"""
+    return Settings()

stac_fastapi/eodag/constants.py

@@ -0,0 +1,43 @@
+# -*- coding: utf-8 -*-
+# Copyright 2024, CS GROUP - France, https://www.cs-soprasteria.com
+#
+# This file is part of stac-fastapi-eodag project
+#     https://www.github.com/CS-SI/stac-fastapi-eodag
+#
+# 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.
+"""Constants"""
+
+ITEM_PROPERTIES_EXCLUDE = {
+    "_id": True,
+    "productType": True,
+    "downloadLink": True,
+    "orderLink": True,
+    "orderStatus": True,
+    "orderStatusLink": True,
+    "searchLink": True,
+    "missionStartDate": True,
+    "missionEndDate": True,
+    "keywords": True,
+    "_date": True,
+    "_dc_qs": True,
+    "qs": True,
+    "defaultGeometry": True,
+}
+
+CACHE_KEY_COLLECTIONS = "collections"
+CACHE_KEY_COLLECTION = "collection"
+CACHE_KEY_SEARCH = "search"
+CACHE_KEY_QUERYABLES = "queryables"
+
+#: default number of items per page from stac-fastapi
+DEFAULT_ITEMS_PER_PAGE = 10