forked from hans/Nominatim
654b652530
Most of the server implementation of V1 API now resides in api.v1.server_glue. The webframeworks only supply some glue code which is independent to changes in the API code.
154 lines
5.3 KiB
Python
154 lines
5.3 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
|
|
import abc
|
|
|
|
import nominatim.api as napi
|
|
from nominatim.api.v1.format import dispatch as formatting
|
|
|
|
CONTENT_TYPE = {
|
|
'text': 'text/plain; charset=utf-8',
|
|
'xml': 'text/xml; charset=utf-8',
|
|
'jsonp': 'application/javascript'
|
|
}
|
|
|
|
|
|
class ASGIAdaptor(abc.ABC):
|
|
""" Adapter class for the different ASGI frameworks.
|
|
Wraps functionality over concrete requests and responses.
|
|
"""
|
|
|
|
@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) -> Exception:
|
|
""" Construct an appropriate exception from the given error message.
|
|
The exception must result in a HTTP 400 error.
|
|
"""
|
|
|
|
|
|
@abc.abstractmethod
|
|
def create_response(self, status: int, output: str, content_type: 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'.
|
|
"""
|
|
|
|
|
|
def build_response(self, output: str, media_type: 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:
|
|
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')
|
|
output = f"{jsonp}({output})"
|
|
media_type = 'jsonp'
|
|
|
|
return self.create_response(status, output,
|
|
CONTENT_TYPE.get(media_type, 'application/json'))
|
|
|
|
|
|
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
|
|
|
|
raise self.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
|
|
|
|
|
|
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
|
|
|
|
raise self.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
|
|
|
|
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
|
|
|
|
|
|
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 = parse_format(params, 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,
|
|
status=status_code)
|
|
|
|
EndpointFunc = Callable[[napi.NominatimAPIAsync, ASGIAdaptor], Any]
|
|
|
|
ROUTES = [
|
|
('status', status_endpoint)
|
|
]
|