X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/0ae8d7ac083983e1d7092fb5855c698acc5cb24c..95d4061b2aa67d7fd3d29099cc1cfd9f2b4022c8:/nominatim/tools/refresh.py diff --git a/nominatim/tools/refresh.py b/nominatim/tools/refresh.py index a6fe3d19..8c1e9d9b 100644 --- a/nominatim/tools/refresh.py +++ b/nominatim/tools/refresh.py @@ -1,19 +1,31 @@ +# 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. """ Functions for bringing auxiliary data in the database up-to-date. """ +from typing import MutableSequence, Tuple, Any, Type, Mapping, Sequence, List, cast import logging from textwrap import dedent +from pathlib import Path from psycopg2 import sql as pysql +from nominatim.config import Configuration +from nominatim.db.connection import Connection from nominatim.db.utils import execute_file from nominatim.db.sql_preprocessor import SQLPreprocessor -from nominatim.version import NOMINATIM_VERSION +from nominatim.version import version_str LOG = logging.getLogger() +OSM_TYPE = {'N': 'node', 'W': 'way', 'R': 'relation'} -def _add_address_level_rows_from_entry(rows, entry): +def _add_address_level_rows_from_entry(rows: MutableSequence[Tuple[Any, ...]], + entry: Mapping[str, Any]) -> None: """ Converts a single entry from the JSON format for address rank descriptions into a flat format suitable for inserting into a PostgreSQL table and adds these lines to `rows`. @@ -30,35 +42,39 @@ def _add_address_level_rows_from_entry(rows, entry): for country in countries: rows.append((country, key, value, rank_search, rank_address)) -def load_address_levels(conn, table, levels): + +def load_address_levels(conn: Connection, table: str, levels: Sequence[Mapping[str, Any]]) -> None: """ Replace the `address_levels` table with the contents of `levels'. A new table is created any previously existing table is dropped. The table has the following columns: country, class, type, rank_search, rank_address """ - rows = [] + rows: List[Tuple[Any, ...]] = [] for entry in levels: _add_address_level_rows_from_entry(rows, entry) with conn.cursor() as cur: cur.drop_table(table) - cur.execute("""CREATE TABLE {} (country_code varchar(2), + cur.execute(pysql.SQL("""CREATE TABLE {} ( + country_code varchar(2), class TEXT, type TEXT, rank_search SMALLINT, - rank_address SMALLINT)""".format(table)) + rank_address SMALLINT) + """).format(pysql.Identifier(table))) cur.execute_values(pysql.SQL("INSERT INTO {} VALUES %s") .format(pysql.Identifier(table)), rows) - cur.execute('CREATE UNIQUE INDEX ON {} (country_code, class, type)'.format(table)) + cur.execute(pysql.SQL('CREATE UNIQUE INDEX ON {} (country_code, class, type)') + .format(pysql.Identifier(table))) conn.commit() -def load_address_levels_from_config(conn, config): +def load_address_levels_from_config(conn: Connection, config: Configuration) -> None: """ Replace the `address_levels` table with the content as defined in the given configuration. Uses the parameter NOMINATIM_ADDRESS_LEVEL_CONFIG to determine the location of the @@ -68,7 +84,9 @@ def load_address_levels_from_config(conn, config): load_address_levels(conn, 'address_levels', cfg) -def create_functions(conn, config, enable_diff_updates=True, enable_debug=False): +def create_functions(conn: Connection, config: Configuration, + enable_diff_updates: bool = True, + enable_debug: bool = False) -> None: """ (Re)create the PL/pgSQL functions. """ sql = SQLPreprocessor(conn, config) @@ -94,7 +112,7 @@ PHP_CONST_DEFS = ( ('Database_DSN', 'DATABASE_DSN', str), ('Default_Language', 'DEFAULT_LANGUAGE', str), ('Log_DB', 'LOG_DB', bool), - ('Log_File', 'LOG_FILE', str), + ('Log_File', 'LOG_FILE', Path), ('NoAccessControl', 'CORS_NOACCESSCONTROL', bool), ('Places_Max_ID_count', 'LOOKUP_MAX_COUNT', int), ('PolygonOutput_MaximumTypes', 'POLYGON_OUTPUT_MAX_TYPES', int), @@ -105,10 +123,10 @@ PHP_CONST_DEFS = ( ) -def import_wikipedia_articles(dsn, data_path, ignore_errors=False): +def import_wikipedia_articles(dsn: str, data_path: Path, ignore_errors: bool = False) -> int: """ Replaces the wikipedia importance tables with new data. The import is run in a single transaction so that the new data - is replace seemlessly. + is replace seamlessly. Returns 0 if all was well and 1 if the importance file could not be found. Throws an exception if there was an error reading the file. @@ -129,7 +147,7 @@ def import_wikipedia_articles(dsn, data_path, ignore_errors=False): return 0 -def recompute_importance(conn): +def recompute_importance(conn: Connection) -> None: """ Recompute wikipedia links and importance for all entries in placex. This is a long-running operations that must not be executed in parallel with updates. @@ -152,37 +170,42 @@ def recompute_importance(conn): conn.commit() -def _quote_php_variable(var_type, config, conf_name): +def _quote_php_variable(var_type: Type[Any], config: Configuration, + conf_name: str) -> str: if var_type == bool: return 'true' if config.get_bool(conf_name) else 'false' if var_type == int: - return getattr(config, conf_name) + return cast(str, getattr(config, conf_name)) if not getattr(config, conf_name): return 'false' - quoted = getattr(config, conf_name).replace("'", "\\'") + if var_type == Path: + value = str(config.get_path(conf_name) or '') + else: + value = getattr(config, conf_name) + + quoted = value.replace("'", "\\'") return f"'{quoted}'" -def setup_website(basedir, config, conn): +def setup_website(basedir: Path, config: Configuration, conn: Connection) -> None: """ Create the website script stubs. """ if not basedir.exists(): LOG.info('Creating website directory.') basedir.mkdir() - template = dedent("""\ + template = dedent(f"""\ None: + """ Mark the given OSM object for reindexing. When 'recursive' is set + to True (the default), then all dependent objects are marked for + reindexing as well. + + 'osm_type' must be on of 'N' (node), 'W' (way) or 'R' (relation). + If the given object does not exist, then nothing happens. + """ + assert osm_type in ('N', 'R', 'W') + + LOG.warning("Invalidating OSM %s %s%s.", + OSM_TYPE[osm_type], osm_id, + ' and its dependent places' if recursive else '') + + with conn.cursor() as cur: + if recursive: + sql = """SELECT place_force_update(place_id) + FROM placex WHERE osm_type = %s and osm_id = %s""" + else: + sql = """UPDATE placex SET indexed_status = 2 + WHERE osm_type = %s and osm_id = %s""" + + cur.execute(sql, (osm_type, osm_id))