X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/8f4426fbc8038c159eae999e74d5a4f1fb992530..5184a8aff9686c4035e236be65c3615fe97859a0:/nominatim/server/falcon/server.py diff --git a/nominatim/server/falcon/server.py b/nominatim/server/falcon/server.py index 62b56770..a536318a 100644 --- a/nominatim/server/falcon/server.py +++ b/nominatim/server/falcon/server.py @@ -7,70 +7,83 @@ """ Server implementation using the falcon webserver framework. """ -from typing import Type, Any, Optional, Mapping +from typing import Optional, Mapping, cast from pathlib import Path import falcon -import falcon.asgi +from falcon.asgi import App, Request, Response -from nominatim.api import NominatimAPIAsync, StatusResult +from nominatim.api import NominatimAPIAsync import nominatim.api.v1 as api_impl +from nominatim.config import Configuration -CONTENT_TYPE = { - 'text': falcon.MEDIA_TEXT, - 'xml': falcon.MEDIA_XML -} -class NominatimV1: - """ Implementation of V1 version of the Nominatim API. +class ParamWrapper(api_impl.ASGIAdaptor): + """ Adaptor class for server glue to Falcon framework. """ - def __init__(self, project_dir: Path, environ: Optional[Mapping[str, str]]) -> None: - self.api = NominatimAPIAsync(project_dir, environ) + def __init__(self, req: Request, resp: Response, + config: Configuration) -> None: + self.request = req + self.response = resp + self._config = config - def parse_format(self, req: falcon.asgi.Request, rtype: Type[Any], default: str) -> None: - """ Get and check the 'format' parameter and prepare the formatter. - `rtype` describes the expected return type and `default` the - format value to assume when no parameter is present. - """ - req.context.format = req.get_param('format', default=default) + def get(self, name: str, default: Optional[str] = None) -> Optional[str]: + return cast(Optional[str], self.request.get_param(name, default=default)) - if not api_impl.supports_format(rtype, req.context.format): - raise falcon.HTTPBadRequest( - description="Parameter 'format' must be one of: " + - ', '.join(api_impl.list_formats(rtype))) + def get_header(self, name: str, default: Optional[str] = None) -> Optional[str]: + return cast(Optional[str], self.request.get_header(name, default=default)) - def format_response(self, req: falcon.asgi.Request, resp: falcon.asgi.Response, - result: Any) -> None: - """ Render response into a string according to the formatter - set in `parse_format()`. - """ - resp.text = api_impl.format_result(result, req.context.format) - resp.content_type = CONTENT_TYPE.get(req.context.format, falcon.MEDIA_JSON) + def error(self, msg: str, status: int = 400) -> falcon.HTTPError: + if status == 400: + return falcon.HTTPBadRequest(description=msg) + if status == 404: + return falcon.HTTPNotFound(description=msg) + + return falcon.HTTPError(status, description=msg) + + + def create_response(self, status: int, output: str, content_type: str) -> None: + self.response.status = status + self.response.text = output + self.response.content_type = content_type - async def on_get_status(self, req: falcon.asgi.Request, resp: falcon.asgi.Response) -> None: - """ Implementation of status endpoint. - """ - self.parse_format(req, StatusResult, 'text') - result = await self.api.status() + def config(self) -> Configuration: + return self._config - self.format_response(req, resp, result) - if result.status and req.context.format == 'text': - resp.status = 500 + +class EndpointWrapper: + """ Converter for server glue endpoint functions to Falcon request handlers. + """ + + def __init__(self, func: api_impl.EndpointFunc, api: NominatimAPIAsync) -> None: + self.func = func + self.api = api + + + async def on_get(self, req: Request, resp: Response) -> None: + """ Implementation of the endpoint. + """ + await self.func(self.api, ParamWrapper(req, resp, self.api.config)) def get_application(project_dir: Path, - environ: Optional[Mapping[str, str]] = None) -> falcon.asgi.App: - """ Create a Nominatim falcon ASGI application. + environ: Optional[Mapping[str, str]] = None) -> App: + """ Create a Nominatim Falcon ASGI application. """ - app = falcon.asgi.App() + api = NominatimAPIAsync(project_dir, environ) - api = NominatimV1(project_dir, environ) + app = App(cors_enable=api.config.get_bool('CORS_NOACCESSCONTROL')) - app.add_route('/status', api, suffix='status') + legacy_urls = api.config.get_bool('SERVE_LEGACY_URLS') + for name, func in api_impl.ROUTES: + endpoint = EndpointWrapper(func, api) + app.add_route(f"/{name}", endpoint) + if legacy_urls: + app.add_route(f"/{name}.php", endpoint) return app