X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/654b652530bb7274ec5dc033375e175f81cb42b1..317cc5c5443ef0a46b70be589fba2737d0685948:/nominatim/api/v1/server_glue.py diff --git a/nominatim/api/v1/server_glue.py b/nominatim/api/v1/server_glue.py index 7444b7aa..43cc6e56 100644 --- a/nominatim/api/v1/server_glue.py +++ b/nominatim/api/v1/server_glue.py @@ -8,23 +8,31 @@ 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 +from typing import Optional, Any, Type, Callable, NoReturn, Dict, cast +from functools import reduce import abc +import dataclasses +import math +from urllib.parse import urlencode +from nominatim.errors import UsageError +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', 'xml': 'text/xml; charset=utf-8', - 'jsonp': 'application/javascript' + 'debug': 'text/html; charset=utf-8' } - class ASGIAdaptor(abc.ABC): """ Adapter class for the different ASGI frameworks. Wraps functionality over concrete requests and responses. """ + content_type: str = 'text/plain; charset=utf-8' @abc.abstractmethod def get(self, name: str, default: Optional[str] = None) -> Optional[str]: @@ -40,14 +48,14 @@ class ASGIAdaptor(abc.ABC): @abc.abstractmethod - def error(self, msg: str) -> Exception: + def error(self, msg: str, status: int = 400) -> Exception: """ Construct an appropriate exception from the given error message. - The exception must result in a HTTP 400 error. + The exception must result in a HTTP error with the given status. """ @abc.abstractmethod - def create_response(self, status: int, output: str, content_type: str) -> Any: + def create_response(self, status: int, output: str) -> Any: """ Create a response from the given parameters. The result will be returned by the endpoint functions. The adaptor may also return None when the response is created internally with some @@ -59,20 +67,48 @@ class ASGIAdaptor(abc.ABC): """ - def build_response(self, output: str, media_type: str, status: int = 200) -> Any: + @abc.abstractmethod + def config(self) -> Configuration: + """ Return the current configuration object. + """ + + + def build_response(self, output: str, status: int = 200) -> Any: """ Create a response from the given output. Wraps a JSONP function around the response, if necessary. """ - if media_type == 'json' and status == 200: + if self.content_type == 'application/json' and status == 200: jsonp = self.get('json_callback') if jsonp is not None: if any(not part.isidentifier() for part in jsonp.split('.')): - raise self.error('Invalid json_callback value') + self.raise_error('Invalid json_callback value') output = f"{jsonp}({output})" - media_type = 'jsonp' + self.content_type = 'application/javascript' + + return self.create_response(status, output) - return self.create_response(status, output, - CONTENT_TYPE.get(media_type, 'application/json')) + + def raise_error(self, msg: str, status: int = 400) -> NoReturn: + """ Raise an exception resulting in the given HTTP status and + message. The message will be formatted according to the + output format chosen by the request. + """ + if self.content_type == 'text/xml; charset=utf-8': + msg = f""" + + {status} + {msg} + + """ + elif self.content_type == 'application/json': + msg = f"""{{"error":{{"code":{status},"message":"{msg}"}}}}""" + elif self.content_type == 'text/html; charset=utf-8': + loglib.log().section('Execution error') + loglib.log().var_dump('Status', status) + loglib.log().var_dump('Message', msg) + msg = loglib.get_and_disable() + + raise self.error(msg, status) def get_int(self, name: str, default: Optional[int] = None) -> int: @@ -89,12 +125,41 @@ class ASGIAdaptor(abc.ABC): if default is not None: return default - raise self.error(f"Parameter '{name}' missing.") + self.raise_error(f"Parameter '{name}' missing.") + + try: + intval = int(value) + except ValueError: + self.raise_error(f"Parameter '{name}' must be a number.") + + return intval + + + 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. + """ + value = self.get(name) + + if value is None: + if default is not None: + return default + + self.raise_error(f"Parameter '{name}' missing.") try: - return int(value) - except ValueError as exc: - raise self.error(f"Parameter '{name}' must be a number.") from exc + fval = float(value) + except ValueError: + self.raise_error(f"Parameter '{name}' must be a number.") + + 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: @@ -111,24 +176,86 @@ class ASGIAdaptor(abc.ABC): if default is not None: return default - raise self.error(f"Parameter '{name}' missing.") + self.raise_error(f"Parameter '{name}' missing.") return value != '0' -def parse_format(params: ASGIAdaptor, result_type: Type[Any], default: str) -> str: - """ Get and check the 'format' parameter and prepare the formatter. - `fmtter` is a formatter and `default` the - format value to assume when no parameter is present. - """ - fmt = params.get('format', default=default) - assert fmt is not None + def get_accepted_languages(self) -> str: + """ Return the accepted languages. + """ + return self.get('accept-language')\ + or self.get_header('http_accept_language')\ + or self.config().DEFAULT_LANGUAGE + + + def setup_debugging(self) -> bool: + """ Set up collection of debug information if requested. + + Return True when debugging was requested. + """ + if self.get_bool('debug', False): + loglib.set_log_output('html') + self.content_type = 'text/html; charset=utf-8' + return True + + return False - if not formatting.supports_format(result_type, fmt): - raise params.error("Parameter 'format' must be one of: " + - ', '.join(formatting.list_formats(result_type))) - return fmt + 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 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: + """ Get and check the 'format' parameter and prepare the formatter. + `result_type` is the type of result to be returned by the function + and `default` the format value to assume when no parameter is present. + """ + fmt = self.get('format', default=default) + assert fmt is not None + + if not formatting.supports_format(result_type, fmt): + self.raise_error("Parameter 'format' must be one of: " + + ', '.join(formatting.list_formats(result_type))) + + self.content_type = CONTENT_TYPE.get(fmt, 'application/json') + 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: @@ -136,18 +263,243 @@ async def status_endpoint(api: napi.NominatimAPIAsync, params: ASGIAdaptor) -> A """ result = await api.status() - fmt = parse_format(params, napi.StatusResult, 'text') + fmt = params.parse_format(napi.StatusResult, 'text') if fmt == 'text' and result.status: status_code = 500 else: status_code = 200 - return params.build_response(formatting.format_result(result, fmt), fmt, + return params.build_response(formatting.format_result(result, fmt, {}), status=status_code) + +async def details_endpoint(api: napi.NominatimAPIAsync, params: ASGIAdaptor) -> Any: + """ Server glue for /details endpoint. See API docs for details. + """ + fmt = params.parse_format(napi.DetailedResult, 'json') + place_id = params.get_int('place_id', 0) + place: napi.PlaceRef + if place_id: + place = napi.PlaceID(place_id) + else: + osmtype = params.get('osmtype') + if osmtype is None: + params.raise_error("Missing ID parameter 'place_id' or 'osmtype'.") + place = napi.OsmID(osmtype, params.get_int('osmid'), params.get('class')) + + debug = params.setup_debugging() + + locales = napi.Locales.from_accept_languages(params.get_accepted_languages()) + + 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 result is None: + params.raise_error('No place with that OSM ID found.', status=404) + + result.localize(locales) + + output = formatting.format_result(result, fmt, + {'locales': locales, + 'group_hierarchy': params.get_bool('group_hierarchy', False), + 'icon_base_url': params.config().MAPICON_URL}) + + return params.build_response(output) + + +async def reverse_endpoint(api: napi.NominatimAPIAsync, params: ASGIAdaptor) -> Any: + """ Server glue for /reverse endpoint. See API docs for details. + """ + fmt = params.parse_format(napi.ReverseResults, 'xml') + debug = params.setup_debugging() + coord = napi.Point(params.get_float('lon'), params.get_float('lat')) + + details = params.parse_geometry_details(fmt) + details['max_rank'] = helpers.zoom_to_rank(params.get_int('zoom', 18)) + details['layers'] = params.get_layers() + + result = await api.reverse(coord, **details) + + if debug: + return params.build_response(loglib.get_and_disable()) + + if fmt == 'xml': + queryparts = {'lat': str(coord.lat), 'lon': str(coord.lon), 'format': 'xml'} + zoom = params.get('zoom', None) + if zoom: + queryparts['zoom'] = zoom + query = urlencode(queryparts) + else: + query = '' + + fmt_options = {'query': query, + 'extratags': params.get_bool('extratags', False), + 'namedetails': params.get_bool('namedetails', False), + 'addressdetails': params.get_bool('addressdetails', True)} + + if result: + result.localize(napi.Locales.from_accept_languages(params.get_accepted_languages())) + + output = formatting.format_result(napi.ReverseResults([result] if result else []), + fmt, fmt_options) + + return params.build_response(output) + + +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() + details = params.parse_geometry_details(fmt) + + 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 len(places) > params.config().get_int('LOOKUP_MAX_COUNT'): + params.raise_error('Too many object IDs.') + + if places: + results = await api.lookup(places, **details) + else: + results = napi.SearchResults() + + if debug: + return params.build_response(loglib.get_and_disable()) + + fmt_options = {'extratags': params.get_bool('extratags', False), + 'namedetails': params.get_bool('namedetails', False), + 'addressdetails': params.get_bool('addressdetails', True)} + + results.localize(napi.Locales.from_accept_languages(params.get_accepted_languages())) + + output = formatting.format_result(results, fmt, fmt_options) + + return params.build_response(output) + + +async def _unstructured_search(query: str, api: napi.NominatimAPIAsync, + details: Dict[str, Any]) -> napi.SearchResults: + if not query: + return napi.SearchResults() + + # Extract special format for coordinates from query. + query, x, y = helpers.extract_coords_from_query(query) + if x is not None: + assert y is not None + details['near'] = napi.Point(x, y) + details['near_radius'] = 0.1 + + # If no query is left, revert to reverse search. + if x is not None and not query: + result = await api.reverse(details['near'], **details) + if not result: + return napi.SearchResults() + + return napi.SearchResults( + [napi.SearchResult(**{f.name: getattr(result, f.name) + for f in dataclasses.fields(napi.SearchResult) + if hasattr(result, f.name)})]) + + query, cls, typ = helpers.extract_category_from_query(query) + if cls is not None: + assert typ is not None + return await api.search_category([(cls, typ)], near_query=query, **details) + + return await api.search(query, **details) + + +async def search_endpoint(api: napi.NominatimAPIAsync, params: ASGIAdaptor) -> Any: + """ Server glue for /search endpoint. See API docs for details. + """ + fmt = params.parse_format(napi.SearchResults, 'jsonv2') + debug = params.setup_debugging() + details = params.parse_geometry_details(fmt) + + details['countries'] = params.get('countrycodes', None) + details['excluded'] = params.get('exclude_place_ids', None) + details['viewbox'] = params.get('viewbox', None) or params.get('viewboxlbrt', None) + details['bounded_viewbox'] = params.get_bool('bounded', False) + details['dedupe'] = params.get_bool('dedupe', True) + + max_results = max(1, min(50, params.get_int('limit', 10))) + details['max_results'] = max_results + min(10, max_results) \ + if details['dedupe'] else max_results + + details['min_rank'], details['max_rank'] = \ + helpers.feature_type_to_rank(params.get('featureType', '')) + if params.get('featureType', None) is not None: + details['layers'] = napi.DataLayer.ADDRESS + + query = params.get('q', None) + queryparts = {} + try: + if query is not None: + queryparts['q'] = query + results = await _unstructured_search(query, api, details) + else: + for key in ('amenity', 'street', 'city', 'county', 'state', 'postalcode', 'country'): + details[key] = params.get(key, None) + if details[key]: + queryparts[key] = details[key] + query = ', '.join(queryparts.values()) + + results = await api.search_address(**details) + except UsageError as err: + params.raise_error(str(err)) + + results.localize(napi.Locales.from_accept_languages(params.get_accepted_languages())) + + if details['dedupe'] and len(results) > 1: + results = helpers.deduplicate_results(results, max_results) + + if debug: + return params.build_response(loglib.get_and_disable()) + + if fmt == 'xml': + helpers.extend_query_parts(queryparts, details, + params.get('featureType', ''), + params.get_bool('namedetails', False), + params.get_bool('extratags', False), + (str(r.place_id) for r in results if r.place_id)) + queryparts['format'] = fmt + + moreurl = urlencode(queryparts) + else: + moreurl = '' + + fmt_options = {'query': query, 'more_url': moreurl, + 'exclude_place_ids': queryparts.get('exclude_place_ids'), + 'viewbox': queryparts.get('viewbox'), + 'extratags': params.get_bool('extratags', False), + 'namedetails': params.get_bool('namedetails', False), + 'addressdetails': params.get_bool('addressdetails', False)} + + output = formatting.format_result(results, fmt, fmt_options) + + return params.build_response(output) + + EndpointFunc = Callable[[napi.NominatimAPIAsync, ASGIAdaptor], Any] ROUTES = [ - ('status', status_endpoint) + ('status', status_endpoint), + ('details', details_endpoint), + ('reverse', reverse_endpoint), + ('lookup', lookup_endpoint), + ('search', search_endpoint) ]