move zoom_to_rank computation to extra file

[nominatim.git] / nominatim / api / v1 / server_glue.py

diff --git a/nominatim/api/v1/server_glue.py b/nominatim/api/v1/server_glue.py
index 3c0c58b01e4ba31e98465545fc4266c30c32a586..ccf8f7d104b33b7672d2e9241ddc563c3f003401 100644 (file)
--- a/nominatim/api/v1/server_glue.py
+++ b/nominatim/api/v1/server_glue.py
@@ -8,13 +8,16 @@
 Generic part of the server implementation of the v1 API.
 Combine with the scaffolding provided for the various Python ASGI frameworks.
 """
 Generic part of the server implementation of the v1 API.
 Combine with the scaffolding provided for the various Python ASGI frameworks.
 """

-from typing import Optional, Any, Type, Callable, NoReturn, TypeVar
+from typing import Optional, Any, Type, Callable, NoReturn, Dict, cast
+from functools import reduce

 import abc
 import abc

+import math

 
 from nominatim.config import Configuration
 import nominatim.api as napi
 import nominatim.api.logging as loglib
 from nominatim.api.v1.format import dispatch as formatting
 
 from nominatim.config import Configuration
 import nominatim.api as napi
 import nominatim.api.logging as loglib
 from nominatim.api.v1.format import dispatch as formatting

+from nominatim.api.v1 import helpers

 
 CONTENT_TYPE = {
   'text': 'text/plain; charset=utf-8',
 
 CONTENT_TYPE = {
   'text': 'text/plain; charset=utf-8',


@@ -22,8 +25,6 @@ CONTENT_TYPE = {
   'debug': 'text/html; charset=utf-8'
 }
 
   'debug': 'text/html; charset=utf-8'
 }
 

-ConvT = TypeVar('ConvT', int, float)
-

 class ASGIAdaptor(abc.ABC):
     """ Adapter class for the different ASGI frameworks.
         Wraps functionality over concrete requests and responses.
 class ASGIAdaptor(abc.ABC):
     """ Adapter class for the different ASGI frameworks.
         Wraps functionality over concrete requests and responses.


@@ -107,10 +108,9 @@ class ASGIAdaptor(abc.ABC):
         raise self.error(msg, status)
 
 
         raise self.error(msg, status)
 
 

-    def _get_typed(self, name: str, dest_type: Type[ConvT], type_name: str,
-                   default: Optional[ConvT] = None) -> ConvT:
-        """ Return an input parameter as the type 'dest_type'. Raises an
-            exception if the parameter is given but not in the given format.
+    def get_int(self, name: str, default: Optional[int] = None) -> int:
+        """ Return an input parameter as an int. Raises an exception if
+            the parameter is given but not in an integer format.

 
             If 'default' is given, then it will be returned when the parameter
             is missing completely. When 'default' is None, an error will be
 
             If 'default' is given, then it will be returned when the parameter
             is missing completely. When 'default' is None, an error will be


@@ -125,33 +125,38 @@ class ASGIAdaptor(abc.ABC):
             self.raise_error(f"Parameter '{name}' missing.")
 
         try:
             self.raise_error(f"Parameter '{name}' missing.")
 
         try:

-            intval = dest_type(value)
+            intval = int(value)

         except ValueError:
         except ValueError:

-            self.raise_error(f"Parameter '{name}' must be a {type_name}.")
+            self.raise_error(f"Parameter '{name}' must be a number.")

 
         return intval
 
 
 
         return intval
 
 

-    def get_int(self, name: str, default: Optional[int] = None) -> int:
-        """ Return an input parameter as an int. Raises an exception if
-            the parameter is given but not in an integer format.
+    def get_float(self, name: str, default: Optional[float] = None) -> float:
+        """ Return an input parameter as a flaoting-point number. Raises an
+            exception if the parameter is given but not in an float format.

 
             If 'default' is given, then it will be returned when the parameter
             is missing completely. When 'default' is None, an error will be
             raised on a missing parameter.
         """
 
             If 'default' is given, then it will be returned when the parameter
             is missing completely. When 'default' is None, an error will be
             raised on a missing parameter.
         """

-        return self._get_typed(name, int, 'number', default)
+        value = self.get(name)
+
+        if value is None:
+            if default is not None:
+                return default

 
 

+            self.raise_error(f"Parameter '{name}' missing.")

 
 

-    def get_float(self, name: str, default: Optional[float] = None) -> int:
-        """ Return an input parameter as a flaoting-point number. Raises an
-            exception if the parameter is given but not in an float format.
+        try:
+            fval = float(value)
+        except ValueError:
+            self.raise_error(f"Parameter '{name}' must be a number.")

 
 

-            If 'default' is given, then it will be returned when the parameter
-            is missing completely. When 'default' is None, an error will be
-            raised on a missing parameter.
-        """
-        return self._get_typed(name, float, 'number', default)
+        if math.isnan(fval) or math.isinf(fval):
+            self.raise_error(f"Parameter '{name}' must be a number.")
+
+        return fval

 
 
     def get_bool(self, name: str, default: Optional[bool] = None) -> bool:
 
 
     def get_bool(self, name: str, default: Optional[bool] = None) -> bool:


@@ -194,15 +199,16 @@ class ASGIAdaptor(abc.ABC):
         return False
 
 
         return False
 
 

-    def get_layers(self) -> napi.DataLayer:
+    def get_layers(self) -> Optional[napi.DataLayer]:

         """ Return a parsed version of the layer parameter.
         """
         param = self.get('layer', None)
         if param is None:
             return None
 
         """ Return a parsed version of the layer parameter.
         """
         param = self.get('layer', None)
         if param is None:
             return None
 

-        return reduce(napi.DataLayer.__or__,
-                      (getattr(napi.DataLayer, s.upper()) for s in param.split(',')))
+        return cast(napi.DataLayer,
+                    reduce(napi.DataLayer.__or__,
+                           (getattr(napi.DataLayer, s.upper()) for s in param.split(','))))

 
 
     def parse_format(self, result_type: Type[Any], default: str) -> str:
 
 
     def parse_format(self, result_type: Type[Any], default: str) -> str:


@@ -221,6 +227,34 @@ class ASGIAdaptor(abc.ABC):
         return fmt
 
 
         return fmt
 
 

+    def parse_geometry_details(self, fmt: str) -> Dict[str, Any]:
+        """ Create details strucutre from the supplied geometry parameters.
+        """
+        numgeoms = 0
+        output = napi.GeometryFormat.NONE
+        if self.get_bool('polygon_geojson', False):
+            output |= napi.GeometryFormat.GEOJSON
+            numgeoms += 1
+        if fmt not in ('geojson', 'geocodejson'):
+            if self.get_bool('polygon_text', False):
+                output |= napi.GeometryFormat.TEXT
+                numgeoms += 1
+            if self.get_bool('polygon_kml', False):
+                output |= napi.GeometryFormat.KML
+                numgeoms += 1
+            if self.get_bool('polygon_svg', False):
+                output |= napi.GeometryFormat.SVG
+                numgeoms += 1
+
+        if numgeoms > self.config().get_int('POLYGON_OUTPUT_MAX_TYPES'):
+            self.raise_error('Too many polgyon output options selected.')
+
+        return {'address_details': True,
+                'geometry_simplification': self.get_float('polygon_threshold', 0.0),
+                'geometry_output': output
+               }
+
+

 async def status_endpoint(api: napi.NominatimAPIAsync, params: ASGIAdaptor) -> Any:
     """ Server glue for /status endpoint. See API docs for details.
     """
 async def status_endpoint(api: napi.NominatimAPIAsync, params: ASGIAdaptor) -> Any:
     """ Server glue for /status endpoint. See API docs for details.
     """


@@ -253,17 +287,17 @@ async def details_endpoint(api: napi.NominatimAPIAsync, params: ASGIAdaptor) ->
 
     debug = params.setup_debugging()
 
 
     debug = params.setup_debugging()
 

-    details = napi.LookupDetails(address_details=params.get_bool('addressdetails', False),
-                                 linked_places=params.get_bool('linkedplaces', False),
-                                 parented_places=params.get_bool('hierarchy', False),
-                                 keywords=params.get_bool('keywords', False))
-
-    if params.get_bool('polygon_geojson', False):
-        details.geometry_output = napi.GeometryFormat.GEOJSON
-

     locales = napi.Locales.from_accept_languages(params.get_accepted_languages())
 
     locales = napi.Locales.from_accept_languages(params.get_accepted_languages())
 

-    result = await api.lookup(place, details)
+    result = await api.details(place,
+                               address_details=params.get_bool('addressdetails', False),
+                               linked_places=params.get_bool('linkedplaces', False),
+                               parented_places=params.get_bool('hierarchy', False),
+                               keywords=params.get_bool('keywords', False),
+                               geometry_output = napi.GeometryFormat.GEOJSON
+                                                 if params.get_bool('polygon_geojson', False)
+                                                 else napi.GeometryFormat.NONE
+                              )

 
     if debug:
         return params.build_response(loglib.get_and_disable())
 
     if debug:
         return params.build_response(loglib.get_and_disable())


@@ -287,36 +321,11 @@ async def reverse_endpoint(api: napi.NominatimAPIAsync, params: ASGIAdaptor) ->
     coord = napi.Point(params.get_float('lon'), params.get_float('lat'))
     locales = napi.Locales.from_accept_languages(params.get_accepted_languages())
 
     coord = napi.Point(params.get_float('lon'), params.get_float('lat'))
     locales = napi.Locales.from_accept_languages(params.get_accepted_languages())
 

-    zoom = max(0, min(18, params.get_int('zoom', 18)))
-
-    # Negation makes sure that NaN is handled. Don't change.
-    if not abs(coord[0]) <= 180 or not abs(coord[1]) <= 90:
-        params.raise_error('Invalid coordinates.')
-
-    details = napi.LookupDetails(address_details=True,
-                                 geometry_simplification=params.get_float('polygon_threshold', 0.0))
-    numgeoms = 0
-    if params.get_bool('polygon_geojson', False):
-        details.geometry_output |= napi.GeometryFormat.GEOJSON
-        numgeoms += 1
-    if fmt not in ('geojson', 'geocodejson'):
-        if params.get_bool('polygon_text', False):
-            details.geometry_output |= napi.GeometryFormat.TEXT
-            numgeoms += 1
-        if params.get_bool('polygon_kml', False):
-            details.geometry_output |= napi.GeometryFormat.KML
-            numgeoms += 1
-        if params.get_bool('polygon_svg', False):
-            details.geometry_output |= napi.GeometryFormat.SVG
-            numgeoms += 1
+    details = params.parse_geometry_details(fmt)
+    details['max_rank'] = helpers.zoom_to_rank(params.get_int('zoom', 18))
+    details['layers'] = params.get_layers()

 
 

-    if numgeoms > params.config().get_int('POLYGON_OUTPUT_MAX_TYPES'):
-        params.raise_error(f'Too many polgyon output options selected.')
-
-    result = await api.reverse(coord, REVERSE_MAX_RANKS[zoom],
-                               params.get_layers() or
-                                 napi.DataLayer.ADDRESS | napi.DataLayer.POI,
-                               details)
+    result = await api.reverse(coord, **details)

 
     if debug:
         return params.build_response(loglib.get_and_disable())
 
     if debug:
         return params.build_response(loglib.get_and_disable())


@@ -324,11 +333,7 @@ async def reverse_endpoint(api: napi.NominatimAPIAsync, params: ASGIAdaptor) ->
     fmt_options = {'locales': locales,
                    'extratags': params.get_bool('extratags', False),
                    'namedetails': params.get_bool('namedetails', False),
     fmt_options = {'locales': locales,
                    'extratags': params.get_bool('extratags', False),
                    'namedetails': params.get_bool('namedetails', False),

-                   'addressdetails': params.get_bool('addressdetails', True),
-                   'single_result': True}
-    if fmt == 'xml':
-        fmt_options['xml_roottag'] = 'reversegeocode'
-        fmt_options['xml_extra_info'] = {'querystring': 'TODO'}
+                   'addressdetails': params.get_bool('addressdetails', True)}

 
     output = formatting.format_result(napi.ReverseResults([result] if result else []),
                                       fmt, fmt_options)
 
     output = formatting.format_result(napi.ReverseResults([result] if result else []),
                                       fmt, fmt_options)


@@ -336,26 +341,42 @@ async def reverse_endpoint(api: napi.NominatimAPIAsync, params: ASGIAdaptor) ->
     return params.build_response(output)
 
 
     return params.build_response(output)
 
 

-EndpointFunc = Callable[[napi.NominatimAPIAsync, ASGIAdaptor], Any]
+async def lookup_endpoint(api: napi.NominatimAPIAsync, params: ASGIAdaptor) -> Any:
+    """ Server glue for /lookup endpoint. See API docs for details.
+    """
+    fmt = params.parse_format(napi.SearchResults, 'xml')
+    debug = params.setup_debugging()
+    locales = napi.Locales.from_accept_languages(params.get_accepted_languages())
+    details = params.parse_geometry_details(fmt)

 
 

-REVERSE_MAX_RANKS = [2, 2, 2,   # 0-2   Continent/Sea
-                     4, 4,      # 3-4   Country
-                     8,         # 5     State
-                     10, 10,    # 6-7   Region
-                     12, 12,    # 8-9   County
-                     16, 17,    # 10-11 City
-                     18,        # 12    Town
-                     19,        # 13    Village/Suburb
-                     22,        # 14    Hamlet/Neighbourhood
-                     25,        # 15    Localities
-                     26,        # 16    Major Streets
-                     27,        # 17    Minor Streets
-                     30         # 18    Building
-                    ]
+    places = []
+    for oid in (params.get('osm_ids') or '').split(','):
+        oid = oid.strip()
+        if len(oid) > 1 and oid[0] in 'RNWrnw' and oid[1:].isdigit():
+            places.append(napi.OsmID(oid[0], int(oid[1:])))

 
 

+    if places:
+        results = await api.lookup(places, **details)
+    else:
+        results = napi.SearchResults()
+
+    if debug:
+        return params.build_response(loglib.get_and_disable())
+
+    fmt_options = {'locales': locales,
+                   'extratags': params.get_bool('extratags', False),
+                   'namedetails': params.get_bool('namedetails', False),
+                   'addressdetails': params.get_bool('addressdetails', True)}
+
+    output = formatting.format_result(results, fmt, fmt_options)
+
+    return params.build_response(output)
+
+EndpointFunc = Callable[[napi.NominatimAPIAsync, ASGIAdaptor], Any]

 
 ROUTES = [
     ('status', status_endpoint),
     ('details', details_endpoint),
 
 ROUTES = [
     ('status', status_endpoint),
     ('details', details_endpoint),

-    ('reverse', reverse_endpoint)
+    ('reverse', reverse_endpoint),
+    ('lookup', lookup_endpoint)

 ]
 ]