nominatim/admin/exec_utils.py

   1 """
   2 Helper functions for executing external programs.
   3 """
   4 from pathlib import Path
   5 import subprocess
   6
   7 def run_legacy_script(script, *args, nominatim_env=None, throw_on_fail=False):
   8         """ Run a Nominatim PHP script with the given arguments.
   9
  10             Returns the exit code of the script. If `throw_on_fail` is True
  11             then throw a `CalledProcessError` on a non-zero exit.
  12         """
  13         cmd = ['/usr/bin/env', 'php', '-Cq',
  14                nominatim_env.phplib_dir / 'admin' / script]
  15         cmd.extend([str(a) for a in args])
  16
  17         env = nominatim_env.config.get_os_env()
  18         env['NOMINATIM_DATADIR'] = str(nominatim_env.data_dir)
  19         env['NOMINATIM_BINDIR'] = str(nominatim_env.data_dir / 'utils')
  20         if not env['NOMINATIM_DATABASE_MODULE_PATH']:
  21             env['NOMINATIM_DATABASE_MODULE_PATH'] = nominatim_env.module_dir
  22         if not env['NOMINATIM_OSM2PGSQL_BINARY']:
  23             env['NOMINATIM_OSM2PGSQL_BINARY'] = nominatim_env.osm2pgsql_path
  24
  25         proc = subprocess.run(cmd, cwd=str(nominatim_env.project_dir), env=env)
  26
  27         if throw_on_fail:
  28             proc.check_returncode()
  29
  30         return proc.returncode
  31