src/nominatim_db/tools/exec_utils.py

   1 # SPDX-License-Identifier: GPL-3.0-or-later
   2 #
   3 # This file is part of Nominatim. (https://nominatim.org)
   4 #
   5 # Copyright (C) 2024 by the Nominatim developer community.
   6 # For a full list of authors see the git log.
   7 """
   8 Helper functions for executing external programs.
   9 """
  10 from typing import Any, Mapping
  11 import logging
  12 import os
  13 import subprocess
  14 import shutil
  15
  16 from nominatim_core.typing import StrPath
  17 from nominatim_core.db.connection import get_pg_env
  18
  19 LOG = logging.getLogger()
  20
  21 def run_php_server(server_address: str, base_dir: StrPath) -> None:
  22     """ Run the built-in server from the given directory.
  23     """
  24     subprocess.run(['/usr/bin/env', 'php', '-S', server_address],
  25                    cwd=str(base_dir), check=True)
  26
  27
  28 def run_osm2pgsql(options: Mapping[str, Any]) -> None:
  29     """ Run osm2pgsql with the given options.
  30     """
  31     env = get_pg_env(options['dsn'])
  32
  33     osm2pgsql_cmd = options['osm2pgsql']
  34     if osm2pgsql_cmd is None:
  35         osm2pgsql_cmd = shutil.which('osm2pgsql')
  36         if osm2pgsql_cmd is None:
  37             raise RuntimeError('osm2pgsql executable not found. Please install osm2pgsql first.')
  38
  39     cmd = [str(osm2pgsql_cmd),
  40            '--slim',
  41            '--log-progress', 'true',
  42            '--number-processes', '1' if options['append'] else str(options['threads']),
  43            '--cache', str(options['osm2pgsql_cache']),
  44            '--style', str(options['osm2pgsql_style'])
  45           ]
  46
  47     if str(options['osm2pgsql_style']).endswith('.lua'):
  48         env['LUA_PATH'] = ';'.join((str(options['osm2pgsql_style_path'] / '?.lua'),
  49                                     os.environ.get('LUAPATH', ';')))
  50         cmd.extend(('--output', 'flex'))
  51     else:
  52         cmd.extend(('--output', 'gazetteer', '--hstore', '--latlon'))
  53
  54     cmd.append('--append' if options['append'] else '--create')
  55
  56     if options['flatnode_file']:
  57         cmd.extend(('--flat-nodes', options['flatnode_file']))
  58
  59     for key, param in (('slim_data', '--tablespace-slim-data'),
  60                        ('slim_index', '--tablespace-slim-index'),
  61                        ('main_data', '--tablespace-main-data'),
  62                        ('main_index', '--tablespace-main-index')):
  63         if options['tablespaces'][key]:
  64             cmd.extend((param, options['tablespaces'][key]))
  65
  66     if options['tablespaces']['main_data']:
  67         env['NOMINATIM_TABLESPACE_PLACE_DATA'] = options['tablespaces']['main_data']
  68     if options['tablespaces']['main_index']:
  69         env['NOMINATIM_TABLESPACE_PLACE_INDEX'] = options['tablespaces']['main_index']
  70
  71     if options.get('disable_jit', False):
  72         env['PGOPTIONS'] = '-c jit=off -c max_parallel_workers_per_gather=0'
  73
  74     if 'import_data' in options:
  75         cmd.extend(('-r', 'xml', '-'))
  76     elif isinstance(options['import_file'], list):
  77         for fname in options['import_file']:
  78             cmd.append(str(fname))
  79     else:
  80         cmd.append(str(options['import_file']))
  81
  82     subprocess.run(cmd, cwd=options.get('cwd', '.'),
  83                    input=options.get('import_data'),
  84                    env=env, check=True)