Merge remote-tracking branch 'upstream/master'

[nominatim.git] / nominatim / clicmd / api.py

diff --git a/nominatim/clicmd/api.py b/nominatim/clicmd/api.py
index 9bbdad1a45d6df68d42a3aead3b788772f0ed967..b899afad15f36e1bb4f7ea574427d8185aa4ff78 100644 (file)
--- a/nominatim/clicmd/api.py
+++ b/nominatim/clicmd/api.py
@@ -1,9 +1,19 @@
+# SPDX-License-Identifier: GPL-2.0-only
+#
+# This file is part of Nominatim. (https://nominatim.org)
+#
+# Copyright (C) 2022 by the Nominatim developer community.
+# For a full list of authors see the git log.

 """
 Subcommand definitions for API calls from the command line.
 """
 """
 Subcommand definitions for API calls from the command line.
 """

+from typing import Mapping, Dict
+import argparse

 import logging
 
 from nominatim.tools.exec_utils import run_api_script
 import logging
 
 from nominatim.tools.exec_utils import run_api_script

+from nominatim.errors import UsageError
+from nominatim.clicmd.args import NominatimArgs

 
 # Do not repeat documentation of subcommand classes.
 # pylint: disable=C0111
 
 # Do not repeat documentation of subcommand classes.
 # pylint: disable=C0111


@@ -35,7 +45,7 @@ DETAILS_SWITCHES = (
     ('polygon_geojson', 'Include geometry of result')
 )
 
     ('polygon_geojson', 'Include geometry of result')
 )
 

-def _add_api_output_arguments(parser):
+def _add_api_output_arguments(parser: argparse.ArgumentParser) -> None:

     group = parser.add_argument_group('Output arguments')
     group.add_argument('--format', default='jsonv2',
                        choices=['xml', 'json', 'jsonv2', 'geojson', 'geocodejson'],
     group = parser.add_argument_group('Output arguments')
     group.add_argument('--format', default='jsonv2',
                        choices=['xml', 'json', 'jsonv2', 'geojson', 'geocodejson'],


@@ -53,6 +63,18 @@ def _add_api_output_arguments(parser):
                              "Parameter is difference tolerance in degrees."))
 
 
                              "Parameter is difference tolerance in degrees."))
 
 

+def _run_api(endpoint: str, args: NominatimArgs, params: Mapping[str, object]) -> int:
+    script_file = args.project_dir / 'website' / (endpoint + '.php')
+
+    if not script_file.exists():
+        LOG.error("Cannot find API script file.\n\n"
+                  "Make sure to run 'nominatim' from the project directory \n"
+                  "or use the option --project-dir.")
+        raise UsageError("API script not found.")
+
+    return run_api_script(endpoint, args.project_dir,
+                          phpcgi_bin=args.phpcgi_path, params=params)
+

 class APISearch:
     """\
     Execute a search query.
 class APISearch:
     """\
     Execute a search query.


@@ -63,8 +85,7 @@ class APISearch:
     https://nominatim.org/release-docs/latest/api/Search/
     """
 
     https://nominatim.org/release-docs/latest/api/Search/
     """
 

-    @staticmethod
-    def add_args(parser):
+    def add_args(self, parser: argparse.ArgumentParser) -> None:

         group = parser.add_argument_group('Query arguments')
         group.add_argument('--query',
                            help='Free-form query string')
         group = parser.add_argument_group('Query arguments')
         group.add_argument('--query',
                            help='Free-form query string')


@@ -90,8 +111,8 @@ class APISearch:
                            help='Do not remove duplicates from the result list')
 
 
                            help='Do not remove duplicates from the result list')
 
 

-    @staticmethod
-    def run(args):
+    def run(self, args: NominatimArgs) -> int:
+        params: Dict[str, object]

         if args.query:
             params = dict(q=args.query)
         else:
         if args.query:
             params = dict(q=args.query)
         else:


@@ -114,8 +135,7 @@ class APISearch:
         if not args.dedupe:
             params['dedupe'] = '0'
 
         if not args.dedupe:
             params['dedupe'] = '0'
 

-        return run_api_script('search', args.project_dir,
-                              phpcgi_bin=args.phpcgi_path, params=params)
+        return _run_api('search', args, params)

 
 class APIReverse:
     """\
 
 class APIReverse:
     """\


@@ -127,8 +147,7 @@ class APIReverse:
     https://nominatim.org/release-docs/latest/api/Reverse/
     """
 
     https://nominatim.org/release-docs/latest/api/Reverse/
     """
 

-    @staticmethod
-    def add_args(parser):
+    def add_args(self, parser: argparse.ArgumentParser) -> None:

         group = parser.add_argument_group('Query arguments')
         group.add_argument('--lat', type=float, required=True,
                            help='Latitude of coordinate to look up (in WGS84)')
         group = parser.add_argument_group('Query arguments')
         group.add_argument('--lat', type=float, required=True,
                            help='Latitude of coordinate to look up (in WGS84)')


@@ -140,17 +159,14 @@ class APIReverse:
         _add_api_output_arguments(parser)
 
 
         _add_api_output_arguments(parser)
 
 

-    @staticmethod
-    def run(args):
-        params = dict(lat=args.lat, lon=args.lon)
+    def run(self, args: NominatimArgs) -> int:
+        params = dict(lat=args.lat, lon=args.lon, format=args.format)

         if args.zoom is not None:
             params['zoom'] = args.zoom
 
         for param, _ in EXTRADATA_PARAMS:
             if getattr(args, param):
                 params[param] = '1'
         if args.zoom is not None:
             params['zoom'] = args.zoom
 
         for param, _ in EXTRADATA_PARAMS:
             if getattr(args, param):
                 params[param] = '1'

-        if args.format:
-            params['format'] = args.format

         if args.lang:
             params['accept-language'] = args.lang
         if args.polygon_output:
         if args.lang:
             params['accept-language'] = args.lang
         if args.polygon_output:


@@ -158,8 +174,7 @@ class APIReverse:
         if args.polygon_threshold:
             params['polygon_threshold'] = args.polygon_threshold
 
         if args.polygon_threshold:
             params['polygon_threshold'] = args.polygon_threshold
 

-        return run_api_script('reverse', args.project_dir,
-                              phpcgi_bin=args.phpcgi_path, params=params)
+        return _run_api('reverse', args, params)

 
 
 class APILookup:
 
 
 class APILookup:


@@ -172,8 +187,7 @@ class APILookup:
     https://nominatim.org/release-docs/latest/api/Lookup/
     """
 
     https://nominatim.org/release-docs/latest/api/Lookup/
     """
 

-    @staticmethod
-    def add_args(parser):
+    def add_args(self, parser: argparse.ArgumentParser) -> None:

         group = parser.add_argument_group('Query arguments')
         group.add_argument('--id', metavar='OSMID',
                            action='append', required=True, dest='ids',
         group = parser.add_argument_group('Query arguments')
         group.add_argument('--id', metavar='OSMID',
                            action='append', required=True, dest='ids',


@@ -182,15 +196,12 @@ class APILookup:
         _add_api_output_arguments(parser)
 
 
         _add_api_output_arguments(parser)
 
 

-    @staticmethod
-    def run(args):
-        params = dict(osm_ids=','.join(args.ids))
+    def run(self, args: NominatimArgs) -> int:
+        params: Dict[str, object] = dict(osm_ids=','.join(args.ids), format=args.format)

 
         for param, _ in EXTRADATA_PARAMS:
             if getattr(args, param):
                 params[param] = '1'
 
         for param, _ in EXTRADATA_PARAMS:
             if getattr(args, param):
                 params[param] = '1'

-        if args.format:
-            params['format'] = args.format

         if args.lang:
             params['accept-language'] = args.lang
         if args.polygon_output:
         if args.lang:
             params['accept-language'] = args.lang
         if args.polygon_output:


@@ -198,8 +209,7 @@ class APILookup:
         if args.polygon_threshold:
             params['polygon_threshold'] = args.polygon_threshold
 
         if args.polygon_threshold:
             params['polygon_threshold'] = args.polygon_threshold
 

-        return run_api_script('lookup', args.project_dir,
-                              phpcgi_bin=args.phpcgi_path, params=params)
+        return _run_api('lookup', args, params)

 
 
 class APIDetails:
 
 
 class APIDetails:


@@ -212,8 +222,7 @@ class APIDetails:
     https://nominatim.org/release-docs/latest/api/Details/
     """
 
     https://nominatim.org/release-docs/latest/api/Details/
     """
 

-    @staticmethod
-    def add_args(parser):
+    def add_args(self, parser: argparse.ArgumentParser) -> None:

         group = parser.add_argument_group('Query arguments')
         objs = group.add_mutually_exclusive_group(required=True)
         objs.add_argument('--node', '-n', type=int,
         group = parser.add_argument_group('Query arguments')
         objs = group.add_mutually_exclusive_group(required=True)
         objs.add_argument('--node', '-n', type=int,


@@ -234,8 +243,8 @@ class APIDetails:
         group.add_argument('--lang', '--accept-language', metavar='LANGS',
                            help='Preferred language order for presenting search results')
 
         group.add_argument('--lang', '--accept-language', metavar='LANGS',
                            help='Preferred language order for presenting search results')
 

-    @staticmethod
-    def run(args):
+
+    def run(self, args: NominatimArgs) -> int:

         if args.node:
             params = dict(osmtype='N', osmid=args.node)
         elif args.way:
         if args.node:
             params = dict(osmtype='N', osmid=args.node)
         elif args.way:


@@ -248,9 +257,10 @@ class APIDetails:
             params['class'] = args.object_class
         for name, _ in DETAILS_SWITCHES:
             params[name] = '1' if getattr(args, name) else '0'
             params['class'] = args.object_class
         for name, _ in DETAILS_SWITCHES:
             params[name] = '1' if getattr(args, name) else '0'

+        if args.lang:
+            params['accept-language'] = args.lang

 
 

-        return run_api_script('details', args.project_dir,
-                              phpcgi_bin=args.phpcgi_path, params=params)
+        return _run_api('details', args, params)

 
 
 class APIStatus:
 
 
 class APIStatus:


@@ -263,14 +273,11 @@ class APIStatus:
     https://nominatim.org/release-docs/latest/api/Status/
     """
 
     https://nominatim.org/release-docs/latest/api/Status/
     """
 

-    @staticmethod
-    def add_args(parser):
+    def add_args(self, parser: argparse.ArgumentParser) -> None:

         group = parser.add_argument_group('API parameters')
         group.add_argument('--format', default='text', choices=['text', 'json'],
                            help='Format of result')
 
         group = parser.add_argument_group('API parameters')
         group.add_argument('--format', default='text', choices=['text', 'json'],
                            help='Format of result')
 

-    @staticmethod
-    def run(args):
-        return run_api_script('status', args.project_dir,
-                              phpcgi_bin=args.phpcgi_path,
-                              params=dict(format=args.format))
+
+    def run(self, args: NominatimArgs) -> int:
+        return _run_api('status', args, dict(format=args.format))