]> git.openstreetmap.org Git - nominatim.git/blob - nominatim/tools/refresh.py
Merge pull request #2305 from lonvia/tokenizer
[nominatim.git] / nominatim / tools / refresh.py
1 """
2 Functions for bringing auxiliary data in the database up-to-date.
3 """
4 import json
5 import logging
6 from textwrap import dedent
7
8 from psycopg2.extras import execute_values
9
10 from nominatim.db.utils import execute_file
11 from nominatim.db.sql_preprocessor import SQLPreprocessor
12 from nominatim.version import NOMINATIM_VERSION
13
14 LOG = logging.getLogger()
15
16 def update_postcodes(dsn, sql_dir):
17     """ Recalculate postcode centroids and add, remove and update entries in the
18         location_postcode table. `conn` is an opne connection to the database.
19     """
20     execute_file(dsn, sql_dir / 'update-postcodes.sql')
21
22
23 def recompute_word_counts(dsn, sql_dir):
24     """ Compute the frequency of full-word search terms.
25     """
26     execute_file(dsn, sql_dir / 'words_from_search_name.sql')
27
28
29 def _add_address_level_rows_from_entry(rows, entry):
30     """ Converts a single entry from the JSON format for address rank
31         descriptions into a flat format suitable for inserting into a
32         PostgreSQL table and adds these lines to `rows`.
33     """
34     countries = entry.get('countries') or (None, )
35     for key, values in entry['tags'].items():
36         for value, ranks in values.items():
37             if isinstance(ranks, list):
38                 rank_search, rank_address = ranks
39             else:
40                 rank_search = rank_address = ranks
41             if not value:
42                 value = None
43             for country in countries:
44                 rows.append((country, key, value, rank_search, rank_address))
45
46 def load_address_levels(conn, table, levels):
47     """ Replace the `address_levels` table with the contents of `levels'.
48
49         A new table is created any previously existing table is dropped.
50         The table has the following columns:
51             country, class, type, rank_search, rank_address
52     """
53     rows = []
54     for entry in levels:
55         _add_address_level_rows_from_entry(rows, entry)
56
57     with conn.cursor() as cur:
58         cur.execute('DROP TABLE IF EXISTS {}'.format(table))
59
60         cur.execute("""CREATE TABLE {} (country_code varchar(2),
61                                         class TEXT,
62                                         type TEXT,
63                                         rank_search SMALLINT,
64                                         rank_address SMALLINT)""".format(table))
65
66         execute_values(cur, "INSERT INTO {} VALUES %s".format(table), rows)
67
68         cur.execute('CREATE UNIQUE INDEX ON {} (country_code, class, type)'.format(table))
69
70     conn.commit()
71
72 def load_address_levels_from_file(conn, config_file):
73     """ Replace the `address_levels` table with the contents of the config
74         file.
75     """
76     with config_file.open('r') as fdesc:
77         load_address_levels(conn, 'address_levels', json.load(fdesc))
78
79
80 def create_functions(conn, config, enable_diff_updates=True, enable_debug=False):
81     """ (Re)create the PL/pgSQL functions.
82     """
83     sql = SQLPreprocessor(conn, config)
84
85     sql.run_sql_file(conn, 'functions.sql',
86                      disable_diff_updates=not enable_diff_updates,
87                      debug=enable_debug)
88
89
90
91 WEBSITE_SCRIPTS = (
92     'deletable.php',
93     'details.php',
94     'lookup.php',
95     'polygons.php',
96     'reverse.php',
97     'search.php',
98     'status.php'
99 )
100
101 # constants needed by PHP scripts: PHP name, config name, type
102 PHP_CONST_DEFS = (
103     ('Database_DSN', 'DATABASE_DSN', str),
104     ('Default_Language', 'DEFAULT_LANGUAGE', str),
105     ('Log_DB', 'LOG_DB', bool),
106     ('Log_File', 'LOG_FILE', str),
107     ('NoAccessControl', 'CORS_NOACCESSCONTROL', bool),
108     ('Places_Max_ID_count', 'LOOKUP_MAX_COUNT', int),
109     ('PolygonOutput_MaximumTypes', 'POLYGON_OUTPUT_MAX_TYPES', int),
110     ('Search_BatchMode', 'SEARCH_BATCH_MODE', bool),
111     ('Search_NameOnlySearchFrequencyThreshold', 'SEARCH_NAME_ONLY_THRESHOLD', str),
112     ('Use_US_Tiger_Data', 'USE_US_TIGER_DATA', bool),
113     ('MapIcon_URL', 'MAPICON_URL', str),
114 )
115
116
117 def import_wikipedia_articles(dsn, data_path, ignore_errors=False):
118     """ Replaces the wikipedia importance tables with new data.
119         The import is run in a single transaction so that the new data
120         is replace seemlessly.
121
122         Returns 0 if all was well and 1 if the importance file could not
123         be found. Throws an exception if there was an error reading the file.
124     """
125     datafile = data_path / 'wikimedia-importance.sql.gz'
126
127     if not datafile.exists():
128         return 1
129
130     pre_code = """BEGIN;
131                   DROP TABLE IF EXISTS "wikipedia_article";
132                   DROP TABLE IF EXISTS "wikipedia_redirect"
133                """
134     post_code = "COMMIT"
135     execute_file(dsn, datafile, ignore_errors=ignore_errors,
136                  pre_code=pre_code, post_code=post_code)
137
138     return 0
139
140
141 def recompute_importance(conn):
142     """ Recompute wikipedia links and importance for all entries in placex.
143         This is a long-running operations that must not be executed in
144         parallel with updates.
145     """
146     with conn.cursor() as cur:
147         cur.execute('ALTER TABLE placex DISABLE TRIGGER ALL')
148         cur.execute("""
149             UPDATE placex SET (wikipedia, importance) =
150                (SELECT wikipedia, importance
151                 FROM compute_importance(extratags, country_code, osm_type, osm_id))
152             """)
153         cur.execute("""
154             UPDATE placex s SET wikipedia = d.wikipedia, importance = d.importance
155              FROM placex d
156              WHERE s.place_id = d.linked_place_id and d.wikipedia is not null
157                    and (s.wikipedia is null or s.importance < d.importance);
158             """)
159
160         cur.execute('ALTER TABLE placex ENABLE TRIGGER ALL')
161     conn.commit()
162
163
164 def setup_website(basedir, config):
165     """ Create the website script stubs.
166     """
167     if not basedir.exists():
168         LOG.info('Creating website directory.')
169         basedir.mkdir()
170
171     template = dedent("""\
172                       <?php
173
174                       @define('CONST_Debug', $_GET['debug'] ?? false);
175                       @define('CONST_LibDir', '{0}');
176                       @define('CONST_TokenizerDir', '{2}');
177                       @define('CONST_NominatimVersion', '{1[0]}.{1[1]}.{1[2]}-{1[3]}');
178
179                       """.format(config.lib_dir.php, NOMINATIM_VERSION,
180                                  config.project_dir / 'tokenizer'))
181
182     for php_name, conf_name, var_type in PHP_CONST_DEFS:
183         if var_type == bool:
184             varout = 'true' if config.get_bool(conf_name) else 'false'
185         elif var_type == int:
186             varout = getattr(config, conf_name)
187         elif not getattr(config, conf_name):
188             varout = 'false'
189         else:
190             varout = "'{}'".format(getattr(config, conf_name).replace("'", "\\'"))
191
192         template += "@define('CONST_{}', {});\n".format(php_name, varout)
193
194     template += "\nrequire_once('{}/website/{{}}');\n".format(config.lib_dir.php)
195
196     for script in WEBSITE_SCRIPTS:
197         (basedir / script).write_text(template.format(script), 'utf-8')