Merge remote-tracking branch 'upstream/master'

[nominatim.git] / nominatim / server / falcon / server.py

diff --git a/nominatim/server/falcon/server.py b/nominatim/server/falcon/server.py
index a1ae9c6df985ae57481b71287d2887d807c1d6ab..c11cf4a845de734f1f68319990ebb6b179ca40d1 100644 (file)
--- a/nominatim/server/falcon/server.py
+++ b/nominatim/server/falcon/server.py
@@ -2,61 +2,110 @@
 #
 # This file is part of Nominatim. (https://nominatim.org)
 #
-# Copyright (C) 2022 by the Nominatim developer community.
+# Copyright (C) 2023 by the Nominatim developer community.
 # For a full list of authors see the git log.
 """
 Server implementation using the falcon webserver framework.
 """
+from typing import Optional, Mapping, cast, Any
 from pathlib import Path
 
-import falcon.asgi
+from falcon.asgi import App, Request, Response
 
 from nominatim.api import NominatimAPIAsync
-from nominatim.apicmd.status import StatusResult
-import nominatim.result_formatter.v1 as formatting
+import nominatim.api.v1 as api_impl
+from nominatim.config import Configuration
 
-CONTENT_TYPE = {
-  'text': falcon.MEDIA_TEXT,
-  'xml': falcon.MEDIA_XML
-}
+class HTTPNominatimError(Exception):
+    """ A special exception class for errors raised during processing.
+    """
+    def __init__(self, msg: str, status: int, content_type: str) -> None:
+        self.msg = msg
+        self.status = status
+        self.content_type = content_type
 
-class NominatimV1:
 
-    def __init__(self, project_dir: Path):
-        self.api = NominatimAPIAsync(project_dir)
-        self.formatters = {}
+async def nominatim_error_handler(req: Request, resp: Response, #pylint: disable=unused-argument
+                                  exception: HTTPNominatimError,
+                                  _: Any) -> None:
+    """ Special error handler that passes message and content type as
+        per exception info.
+    """
+    resp.status = exception.status
+    resp.text = exception.msg
+    resp.content_type = exception.content_type
 
-        for rtype in (StatusResult, ):
-            self.formatters[rtype] = formatting.create(rtype)
 
-    def parse_format(self, req, rtype, default):
-        req.context.format = req.get_param('format', default=default)
-        req.context.formatter = self.formatters[rtype]
+class ParamWrapper(api_impl.ASGIAdaptor):
+    """ Adaptor class for server glue to Falcon framework.
+    """
 
-        if not req.context.formatter.supports_format(req.context.format):
-            raise falcon.HTTPBadRequest(
-                description="Parameter 'format' must be one of: " +
-                            ', '.join(req.context.formatter.list_formats()))
+    def __init__(self, req: Request, resp: Response,
+                 config: Configuration) -> None:
+        self.request = req
+        self.response = resp
+        self._config = config
 
 
-    def format_response(self, req, resp, result):
-        resp.text = req.context.formatter.format(result, req.context.format)
-        resp.content_type = CONTENT_TYPE.get(req.context.format, falcon.MEDIA_JSON)
+    def get(self, name: str, default: Optional[str] = None) -> Optional[str]:
+        return cast(Optional[str], self.request.get_param(name, default=default))
 
 
-    async def on_get_status(self, req, resp):
-        self.parse_format(req, StatusResult, 'text')
+    def get_header(self, name: str, default: Optional[str] = None) -> Optional[str]:
+        return cast(Optional[str], self.request.get_header(name, default=default))
 
-        result = await self.api.status()
 
-        self.format_response(req, resp, result)
+    def error(self, msg: str, status: int = 400) -> HTTPNominatimError:
+        return HTTPNominatimError(msg, status, self.content_type)
 
 
-def get_application(project_dir: Path) -> falcon.asgi.App:
-    app = falcon.asgi.App()
+    def create_response(self, status: int, output: str) -> None:
+        self.response.status = status
+        self.response.text = output
+        self.response.content_type = self.content_type
 
-    api = NominatimV1(project_dir)
 
-    app.add_route('/status', api, suffix='status')
+    def config(self) -> Configuration:
+        return self._config
+
+
+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) -> App:
+    """ Create a Nominatim Falcon ASGI application.
+    """
+    api = NominatimAPIAsync(project_dir, environ)
+
+    app = App(cors_enable=api.config.get_bool('CORS_NOACCESSCONTROL'))
+    app.add_error_handler(HTTPNominatimError, nominatim_error_handler)
+
+    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
+
+
+def run_wsgi() -> App:
+    """ Entry point for uvicorn.
+
+        Make sure uvicorn is run from the project directory.
+    """
+    return get_application(Path('.'))