database administration and querying.
"""
import sys
+import os
import argparse
import logging
+from pathlib import Path
+
+from .config import Configuration
+from .admin.exec_utils import run_legacy_script
class CommandlineParser:
""" Wraps some of the common functions for parsing the command line
help='Print only error messages')
group.add_argument('-v', '--verbose', action='count', default=1,
help='Increase verboseness of output')
- group.add_argument('--project-dir', metavar='DIR',
+ group.add_argument('--project-dir', metavar='DIR', default='.',
help='Base directory of the Nominatim installation (default:.)')
group.add_argument('-j', '--threads', metavar='NUM', type=int,
help='Number of parallel threads to use')
parser.set_defaults(command=cmd)
cmd.add_args(parser)
- def run(self):
+ def run(self, **kwargs):
""" Parse the command line arguments of the program and execute the
appropriate subcommand.
"""
args = self.parser.parse_args()
if args.subcommand is None:
- self.parser.print_help()
- else:
- logging.basicConfig(stream=sys.stderr,
- format='%(asctime)s %(levelname)s: %(message)s',
- datefmt='%Y-%m-%d %H:%M:%S',
- level=max(4 - args.verbose, 1) * 10)
- args.command.run(args)
+ return self.parser.print_help()
+
+ for arg in ('module_dir', 'osm2pgsql_path', 'phplib_dir', 'data_dir'):
+ setattr(args, arg, Path(kwargs[arg]))
+ args.project_dir = Path(args.project_dir)
+
+ logging.basicConfig(stream=sys.stderr,
+ format='%(asctime)s %(levelname)s: %(message)s',
+ datefmt='%Y-%m-%d %H:%M:%S',
+ level=max(4 - args.verbose, 1) * 10)
+
+ args.config = Configuration(args.project_dir, args.data_dir / 'settings')
+
+ return args.command.run(args)
+
+##### Subcommand classes
+#
+# Each class needs to implement two functions: add_args() adds the CLI parameters
+# for the subfunction, run() executes the subcommand.
+#
+# The class documentation doubles as the help text for the command. The
+# first line is also used in the summary when calling the program without
+# a subcommand.
+#
+# No need to document the functions each time.
+# pylint: disable=C0111
class SetupAll:
group = group_name.add_mutually_exclusive_group(required=True)
group.add_argument('--osm-file',
help='OSM file to be imported.')
- group.add_argument('--continue', nargs=1,
+ group.add_argument('--continue', dest='continue_at',
choices=['load-data', 'indexing', 'db-postprocess'],
help='Continue an import that was interrupted')
group = parser.add_argument_group('Optional arguments')
group = parser.add_argument_group('Expert options')
group.add_argument('--ignore-errors', action='store_true',
help='Continue import even when errors in SQL are present')
- group.add_argument('--disable-token-precalc', action='store_true',
- help='Disable name precalculation')
group.add_argument('--index-noanalyse', action='store_true',
help='Do not perform analyse operations during index')
@staticmethod
def run(args):
- print("TODO: ./utils/setup.php", args)
+ params = ['setup.php']
+ if args.osm_file:
+ params.extend(('--all', '--osm-file', args.osm_file))
+ else:
+ if args.continue_at == 'load-data':
+ params.append('--load-data')
+ if args.continue_at in ('load-data', 'indexing'):
+ params.append('--index')
+ params.extend(('--create-search-indices', '--create-country-names',
+ '--setup-website'))
+ if args.osm2pgsql_cache:
+ params.extend(('--osm2pgsql-cache', args.osm2pgsql_cache))
+ if args.reverse_only:
+ params.append('--reverse-only')
+ if args.enable_debug_statements:
+ params.append('--enable-debug-statements')
+ if args.no_partitions:
+ params.append('--no-partitions')
+ if args.no_updates:
+ params.append('--drop')
+ if args.ignore_errors:
+ params.append('--ignore-errors')
+ if args.index_noanalyse:
+ params.append('--index-noanalyse')
+
+ return run_legacy_script(*params, nominatim_env=args)
class SetupFreeze:
@staticmethod
def run(args):
- print("TODO: setup drop", args)
+ return run_legacy_script('setup.php', '--drop', nominatim_env=args)
class SetupSpecialPhrases:
@staticmethod
def run(args):
- print("./utils/specialphrases.php --from-wiki", args)
+ if args.output.name != '<stdout>':
+ raise NotImplementedError('Only output to stdout is currently implemented.')
+ return run_legacy_script('specialphrases.php', '--wiki-import', nominatim_env=args)
class UpdateReplication:
@staticmethod
def run(args):
+ params = ['update.php']
if args.init:
- print('./utils/update.php --init-updates', args)
+ params.append('--init-updates')
+ if not args.update_functions:
+ params.append('--no-update-functions')
+ elif args.check_for_updates:
+ params.append('--check-for-updates')
else:
- print('./utils/update.php --import-osmosis(-all)', args)
+ if args.once:
+ params.append('--import-osmosis')
+ else:
+ params.append('--import-osmosis-all')
+ if not args.do_index:
+ params.append('--no-index')
+
+ return run_legacy_script(*params, nominatim_env=args)
class UpdateAddData:
@staticmethod
def run(args):
- print('./utils/update.php --import-*', args)
+ if args.tiger_data:
+ os.environ['NOMINATIM_TIGER_DATA_PATH'] = args.tiger_data
+ return run_legacy_script('setup.php', '--import-tiger-data', nominatim_env=args)
+
+ params = ['update.php']
+ if args.file:
+ params.extend(('--import-file', args.file))
+ elif args.diff:
+ params.extend(('--import-diff', args.diff))
+ elif args.node:
+ params.extend(('--import-node', args.node))
+ elif args.way:
+ params.extend(('--import-way', args.way))
+ elif args.relation:
+ params.extend(('--import-relation', args.relation))
+ if args.use_main_api:
+ params.append('--use-main-api')
+ return run_legacy_script(*params, nominatim_env=args)
class UpdateIndex:
@staticmethod
def run(args):
- print('./utils/update.php --index', args)
+ return run_legacy_script('update.php', '--index', nominatim_env=args)
class UpdateRefresh:
help='Compute frequency of full-word search terms')
group.add_argument('--address-levels', action='store_true',
help='Reimport address level configuration')
- group.add_argument('--importance', action='store_true',
- help='Recompute place importances')
group.add_argument('--functions', action='store_true',
help='Update the PL/pgSQL functions in the database')
- group.add_argument('--wiki-data',
+ group.add_argument('--wiki-data', action='store_true',
help='Update Wikipedia/data importance numbers.')
+ group.add_argument('--importance', action='store_true',
+ help='Recompute place importances (expensive!)')
group.add_argument('--website', action='store_true',
help='Refresh the directory that serves the scripts for the web API')
group = parser.add_argument_group('Arguments for function refresh')
group.add_argument('--no-diff-updates', action='store_false', dest='diffs',
help='Do not enable code for propagating updates')
+ group.add_argument('--enable-debug-statements', action='store_true',
+ help='Enable debug warning statements in functions')
@staticmethod
def run(args):
- print('./utils/update.php', args)
+ if args.postcodes:
+ run_legacy_script('update.php', '--calculate-postcodes',
+ nominatim_env=args, throw_on_fail=True)
+ if args.word_counts:
+ run_legacy_script('update.php', '--recompute-word-counts',
+ nominatim_env=args, throw_on_fail=True)
+ if args.address_levels:
+ run_legacy_script('update.php', '--update-address-levels',
+ nominatim_env=args, throw_on_fail=True)
+ if args.functions:
+ params = ['setup.php', '--create-functions', '--create-partition-functions']
+ if args.diffs:
+ params.append('--enable-diff-updates')
+ if args.enable_debug_statements:
+ params.append('--enable-debug-statements')
+ run_legacy_script(*params, nominatim_env=args, throw_on_fail=True)
+ if args.wiki_data:
+ run_legacy_script('setup.php', '--import-wikipedia-articles',
+ nominatim_env=args, throw_on_fail=True)
+ # Attention: importance MUST come after wiki data import.
+ if args.importance:
+ run_legacy_script('update.php', '--recompute-importance',
+ nominatim_env=args, throw_on_fail=True)
+ if args.website:
+ run_legacy_script('setup.php', '--setup-website',
+ nominatim_env=args, throw_on_fail=True)
class AdminCheckDatabase:
@staticmethod
def run(args):
- print("TODO: ./utils/check_import_finished.php", args)
+ return run_legacy_script('check_import_finished.php', nominatim_env=args)
class AdminWarm:
@staticmethod
def run(args):
- print("TODO: ./utils/warm.php", args)
+ params = ['warm.php']
+ if args.target == 'reverse':
+ params.append('--reverse-only')
+ if args.target == 'search':
+ params.append('--search-only')
+ return run_legacy_script(*params, nominatim_env=args)
class QueryExport:
@staticmethod
def run(args):
- print("TODO: ./utils/export.php", args)
-
+ params = ['export.php',
+ '--output-type', args.output_type,
+ '--output-format', args.output_format]
+ if args.output_all_postcodes:
+ params.append('--output-all-postcodes')
+ if args.language:
+ params.extend(('--language', args.language))
+ if args.restrict_to_country:
+ params.extend(('--restrict-to-country', args.restrict_to_country))
+ if args.restrict_to_osm_node:
+ params.extend(('--restrict-to-osm-node', args.restrict_to_osm_node))
+ if args.restrict_to_osm_way:
+ params.extend(('--restrict-to-osm-way', args.restrict_to_osm_way))
+ if args.restrict_to_osm_relation:
+ params.extend(('--restrict-to-osm-relation', args.restrict_to_osm_relation))
+
+ return run_legacy_script(*params, nominatim_env=args)
class QueryTodo:
"""\
def add_args(parser):
pass
- def run(args):
+ @staticmethod
+ def run(args): # pylint: disable=W0613
print("TODO: searching")
parser.add_subcommand('details', QueryTodo)
parser.add_subcommand('status', QueryTodo)
- parser.run()
+ return parser.run(**kwargs)
projects / nominatim.git / blobdiff