mirror of
https://github.com/osm-search/Nominatim.git
synced 2026-02-16 15:47:58 +00:00
f335e78d1e
Localisation was previously done as part of the formatting but might also be useful on its own when working with the results directly.
389 lines
14 KiB
Python
389 lines
14 KiB
Python
# SPDX-License-Identifier: GPL-2.0-only
|
|
#
|
|
# This file is part of Nominatim. (https://nominatim.org)
|
|
#
|
|
# Copyright (C) 2023 by the Nominatim developer community.
|
|
# For a full list of authors see the git log.
|
|
"""
|
|
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, Dict, cast
|
|
from functools import reduce
|
|
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.api.v1 import helpers
|
|
|
|
CONTENT_TYPE = {
|
|
'text': 'text/plain; charset=utf-8',
|
|
'xml': 'text/xml; charset=utf-8',
|
|
'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]:
|
|
""" Return an input parameter as a string. If the parameter was
|
|
not provided, return the 'default' value.
|
|
"""
|
|
|
|
@abc.abstractmethod
|
|
def get_header(self, name: str, default: Optional[str] = None) -> Optional[str]:
|
|
""" Return a HTTP header parameter as a string. If the parameter was
|
|
not provided, return the 'default' value.
|
|
"""
|
|
|
|
|
|
@abc.abstractmethod
|
|
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 error with the given status.
|
|
"""
|
|
|
|
|
|
@abc.abstractmethod
|
|
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
|
|
different means.
|
|
|
|
The response must return the HTTP given status code 'status', set
|
|
the HTTP content-type headers to the string provided and the
|
|
body of the response to 'output'.
|
|
"""
|
|
|
|
|
|
@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 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('.')):
|
|
self.raise_error('Invalid json_callback value')
|
|
output = f"{jsonp}({output})"
|
|
self.content_type = 'application/javascript'
|
|
|
|
return self.create_response(status, output)
|
|
|
|
|
|
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"""<?xml version="1.0" encoding="UTF-8" ?>
|
|
<error>
|
|
<code>{status}</code>
|
|
<message>{msg}</message>
|
|
</error>
|
|
"""
|
|
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:
|
|
""" 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
|
|
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:
|
|
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:
|
|
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:
|
|
""" Return an input parameter as bool. Only '0' is accepted as
|
|
an input for 'false' all other inputs will be interpreted as 'true'.
|
|
|
|
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.")
|
|
|
|
return value != '0'
|
|
|
|
|
|
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
|
|
|
|
|
|
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:
|
|
""" Server glue for /status endpoint. See API docs for details.
|
|
"""
|
|
result = await api.status()
|
|
|
|
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, {}),
|
|
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'))
|
|
locales = napi.Locales.from_accept_languages(params.get_accepted_languages())
|
|
|
|
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())
|
|
|
|
fmt_options = {'extratags': params.get_bool('extratags', False),
|
|
'namedetails': params.get_bool('namedetails', False),
|
|
'addressdetails': params.get_bool('addressdetails', True)}
|
|
|
|
if result:
|
|
result.localize(locales)
|
|
|
|
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()
|
|
locales = napi.Locales.from_accept_languages(params.get_accepted_languages())
|
|
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 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)}
|
|
|
|
for result in results:
|
|
result.localize(locales)
|
|
|
|
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),
|
|
('reverse', reverse_endpoint),
|
|
('lookup', lookup_endpoint)
|
|
]
|