RFC5: apply distance limiting

Author: tomkralidis

pygeoapi/api/__init__.py

@@ -1332,3 +1332,53 @@ def evaluate_limit(requested: Union[None, int], server_limits: dict,
     else:
         LOGGER.debug('limit requested')
         return min(requested2, max_)
+
+
+def evaluate_limit_distance(server_limits: dict, collection_limits: dict,
+                            request_bbox: list = []) -> bool:
+    """
+    Helper function to evaluate limit parameter
+
+    :param server_limits: `dict` of server limits
+    :param collection_limits: `dict` of collection limits
+    :param request_bbox: `list` bbox of request
+
+    :returns: `bool` successful distance check
+    """
+
+    exceed_msg = None
+
+    effective_limits = ChainMap(collection_limits, server_limits)
+
+    on_exceed = effective_limits.get('on_exceed', 'throttle')
+    max_distance_x = effective_limits.get('max_distance_x')
+    max_distance_y = effective_limits.get('max_distance_y')
+    max_distance_units = effective_limits.get('max_distance_units')
+
+    LOGGER.debug(f'On exceed: {on_exceed}')
+    LOGGER.debug(f'Maximum distance x: {max_distance_x}')
+    LOGGER.debug(f'Maximum distance y: {max_distance_y}')
+    LOGGER.debug(f'Maximum distance units: {max_distance_units}')
+
+    # TODO: assess distance units
+
+    if not request_bbox:
+        LOGGER.debug('no bbox requested')
+        return True
+
+    if max_distance_x is not None:
+        requested_distance_x = abs(request_bbox[2] - request_bbox[0])
+        if requested_distance_x > max_distance_x:
+            exceed_msg = 'Maximum distance x exceeded'
+
+    if max_distance_y is not None:
+        requested_distance_y = abs(request_bbox[3] - request_bbox[1])
+        if requested_distance_y > max_distance_y:
+            exceed_msg = 'Maximum distance y exceeded'
+
+    if exceed_msg is not None:
+        LOGGER.warning(exceed_msg)
+        if on_exceed == 'error':
+            raise ValueError(exceed_msg)
+
+    return True

pygeoapi/api/coverages.py

@@ -51,8 +51,8 @@
 from pygeoapi.util import filter_dict_by_key_value, to_json
 
 from . import (
-    APIRequest, API, SYSTEM_LOCALE, validate_bbox, validate_datetime,
-    validate_subset
+    APIRequest, API, SYSTEM_LOCALE, evaluate_limit_distance, validate_bbox,
+    validate_datetime, validate_subset
 )
 
 LOGGER = logging.getLogger(__name__)
@@ -112,6 +112,11 @@ def get_collection_coverage(
     else:
         try:
             bbox = validate_bbox(bbox)
+            server_limits = api.config['server'].get('limits', {})
+            collection_limits = api.config['resources'][dataset].get('limits', {})  # noqa
+
+            _ = evaluate_limit_distance(request.params.get('bbox', []),
+                                        server_limits, collection_limits)
         except ValueError as err:
             msg = str(err)
             return api.get_exception(

pygeoapi/api/environmental_data_retrieval.py

@@ -48,7 +48,7 @@
 from shapely.wkt import loads as shapely_loads
 
 from pygeoapi import l10n
-from pygeoapi.api import evaluate_limit
+from pygeoapi.api import evaluate_limit, evaluate_limit_distance
 from pygeoapi.formats import F_COVERAGEJSON, F_HTML, F_JSON, F_JSONLD
 from pygeoapi.formatter.base import FormatterSerializationError
 from pygeoapi.crs import (create_crs_transform_spec, set_content_crs_header)
@@ -345,6 +345,11 @@ def get_collection_edr_query(api: API, request: APIRequest,
         LOGGER.debug('Processing cube bbox')
         try:
             bbox = validate_bbox(request.params.get('bbox'))
+            server_limits = api.config['server'].get('limits', {})
+            collection_limits = api.config['resources'][dataset].get('limits', {})  # noqa
+
+            _ = evaluate_limit_distance(request.params.get('bbox', []),
+                                        server_limits, collection_limits)
             if not bbox and query_type == 'cube':
                 raise ValueError('bbox parameter required by cube queries')
         except ValueError as err:

pygeoapi/api/itemtypes.py

@@ -48,7 +48,7 @@
 from pyproj.exceptions import CRSError
 
 from pygeoapi import l10n
-from pygeoapi.api import evaluate_limit
+from pygeoapi.api import evaluate_limit, evaluate_limit_distance
 from pygeoapi.api.pubsub import publish_message
 from pygeoapi.crs import (DEFAULT_CRS, DEFAULT_STORAGE_CRS,
                           create_crs_transform_spec, get_supported_crs_list,
@@ -287,9 +287,13 @@ def get_collection_items(
                'level (RFC5)')
         LOGGER.warning(msg)
     try:
+        server_limits = api.config['server'].get('limits', {})
+        collection_limits = collections[dataset].get('limits', {})
+
         limit = evaluate_limit(request.params.get('limit'),
-                               api.config['server'].get('limits', {}),
-                               collections[dataset].get('limits', {}))
+                               server_limits, collection_limits)
+        _ = evaluate_limit_distance(request.params.get('bbox', []),
+                                    server_limits, collection_limits)
     except ValueError as err:
         return api.get_exception(
             HTTPStatus.BAD_REQUEST, headers, request.format,

tests/api/test_api.py

@@ -42,8 +42,9 @@
 
 from pygeoapi.api import (
     API, APIRequest, CONFORMANCE_CLASSES, __version__, validate_bbox,
-    validate_datetime, evaluate_limit, validate_subset, landing_page, openapi_,
-    conformance, describe_collections, get_collection_schema)
+    validate_datetime, evaluate_limit, evaluate_limit_distance,
+    validate_subset, landing_page, openapi_, conformance, describe_collections,
+    get_collection_schema)
 
 from pygeoapi.formats import FORMAT_TYPES, F_GZIP, F_JSON, F_JSONLD, F_HTML
 from pygeoapi.util import yaml_load, get_api_rules, get_base_url
@@ -1023,3 +1024,24 @@ def test_evaluate_limit():
 
     assert evaluate_limit(None, server, collection) == 10
     assert evaluate_limit('40', server, collection) == 3
+
+
+def test_evaluate_limit_distance():
+    collection = {
+        'on_exceed': 'error',
+        'max_distance_x': 10,
+        'max_distance_y': 10
+    }
+
+    with pytest.raises(ValueError):
+        assert evaluate_limit_distance(
+            {}, collection, request_bbox=[-180, -90, 180, 90])
+
+    assert evaluate_limit_distance({}, collection,
+                                   request_bbox=[-142, 42, -140, 44])
+
+    assert evaluate_limit_distance({}, {}, request_bbox=[-180, -90, 180, 90])
+
+    collection['on_exceed'] = 'throttle'
+    assert evaluate_limit_distance(
+        {}, collection, request_bbox=[-180, -90, 180, 90])