+# 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.
"""
Helper functions for executing external programs.
"""
import urllib.request as urlrequest
from urllib.parse import urlencode
-from nominatim.version import NOMINATIM_VERSION
+from nominatim.version import version_str
from nominatim.db.connection import get_pg_env
LOG = logging.getLogger()
def run_api_script(endpoint, project_dir, extra_env=None, phpcgi_bin=None,
params=None):
- """ Execute a Nominiatim API function.
+ """ Execute a Nominatim API function.
The function needs a project directory that contains the website
directory with the scripts to be executed. The scripts will be run
query_string = urlencode(params or {})
env = dict(QUERY_STRING=query_string,
- SCRIPT_NAME='/{}.php'.format(endpoint),
- REQUEST_URI='/{}.php?{}'.format(endpoint, query_string),
+ SCRIPT_NAME=f'/{endpoint}.php',
+ REQUEST_URI=f'/{endpoint}.php?{query_string}',
CONTEXT_DOCUMENT_ROOT=webdir,
- SCRIPT_FILENAME='{}/{}.php'.format(webdir, endpoint),
+ SCRIPT_FILENAME=f'{webdir}/{endpoint}.php',
HTTP_HOST='localhost',
HTTP_USER_AGENT='nominatim-tool',
REMOTE_ADDR='0.0.0.0',
if 'import_data' in options:
cmd.extend(('-r', 'xml', '-'))
+ elif isinstance(options['import_file'], list):
+ for fname in options['import_file']:
+ cmd.append(str(fname))
else:
cmd.append(str(options['import_file']))
def get_url(url):
""" Get the contents from the given URL and return it as a UTF-8 string.
"""
- headers = {"User-Agent": "Nominatim/{0[0]}.{0[1]}.{0[2]}-{0[3]}".format(NOMINATIM_VERSION)}
+ headers = {"User-Agent": f"Nominatim/{version_str()}"}
try:
with urlrequest.urlopen(urlrequest.Request(url, headers=headers)) as response: